Skip to content

Commit 5b4d86e

Browse files
committed
docs: update WAM doc about elevated users
Since GCM 2.1, we are using a newer version of MSAL that uses the new MSAL runtime that solves the COM security issues that presented with elevated processes. Update our documentation to recommend people update to fix this problem.
1 parent 02ba62f commit 5b4d86e

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

docs/windows-broker.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,14 @@ As far as we can tell, there are no workarounds for either of these behaviors
154154

155155
## Running as administrator
156156

157+
### GCM 2.1 and later
158+
159+
From version 2.1 onwards, GCM uses a version of the [Microsoft Authentication
160+
Library (MSAL)][msal-dotnet] that supports use of the Windows
161+
broker from an elevated process.
162+
163+
### Previous versions
164+
157165
The Windows broker ("WAM") makes heavy use of [COM][ms-com], a remote procedure
158166
call (RPC) technology built into Windows. In order to integrate with WAM, Git
159167
Credential Manager and the underlying
@@ -181,8 +189,10 @@ See https://aka.ms/gcm/wamadmin for more information.
181189

182190
In order to fix the problem, there are a few options:
183191

184-
1. Run Git or Git Credential Manager from non-elevated processes.
185-
2. Disable the broker by setting the
192+
1. Update to the [latest Git for Windows][git-for-windows-latest]
193+
**(recommended)**.
194+
2. Run Git or Git Credential Manager from non-elevated processes.
195+
3. Disable the broker by setting the
186196
[`GCM_MSAUTH_USEBROKER`][GCM_MSAUTH_USEBROKER]
187197
environment variable or the
188198
[`credential.msauthUseBroker`][credential.msauthUseBroker]
@@ -206,3 +216,4 @@ In order to fix the problem, there are a few options:
206216
[ms-com]: https://docs.microsoft.com/en-us/windows/win32/com/the-component-object-model
207217
[msal-dotnet]: https://aka.ms/msal-net
208218
[devbox]: https://azure.microsoft.com/en-us/products/dev-box
219+
[git-for-windows-latest]: https://git-scm.com/download/win

0 commit comments

Comments
 (0)