Repository navigation
[Bitbucket Cloud] Implement credential chunking for the wincredman credentialStore to ensure seamless upgrade path for Bitbucket Cloud OAuth changes - #2440
Conversation
… Bitbuckets new OAuth tokens / refresh tokens can be stored without requiring users to change their configured credentialStore for gcm
|
@mjcheetham - Out of question - what would the next version of GCM (if this PR gets merged and released?) |
mjcheetham
left a comment
There was a problem hiding this comment.
Thanks for the contribution and support! Overall this looks like a reasonable solution to a sad limitation of Windows 😢
I agree that chunking should probably not live in the core implementation of the credential stores - this will keep things scoped and safer (as you said, "=" is not a valid Bitbucket account name so you can rely on the chunks=N pattern, whereas in general this is not true).
I've left a few comments for some minor tweaks.
73887d4 to
99e4b57
Compare
99e4b57 to
e0baf57
Compare
mjcheetham
left a comment
There was a problem hiding this comment.
Thanks for addressing my feedback!
|
@mjcheetham thanks for the feedback and review What's the release process look like for GCM? |
We aim to make releases approximately in line with the Git project, which is every 12 weeks. Git 2.56.0 is currently at RC0, so we're right around the point where a new GCM release is pending to be cut and go out. However we are currently in a transition point to release GCM 3.0, which means the next GCM may be a little offset. I hope in the next week or two we can get a release out. |
…nager to v3 (#981) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github:git-ecosystem/git-credential-manager](https://redirect.github.com/git-ecosystem/git-credential-manager) | tools | major | `v2.9.1` → `v3.0.1` | --- ### Release Notes <details> <summary>git-ecosystem/git-credential-manager (github:git-ecosystem/git-credential-manager)</summary> ### [`v3.0.1`](https://redirect.github.com/git-ecosystem/git-credential-manager/releases/tag/v3.0.1): GCM 3.0.1 [Compare Source](https://redirect.github.com/git-ecosystem/git-credential-manager/compare/v3.0.0...v3.0.1) Git Credential Manager 3.0 brings native ahead-of-time compilation, Microsoft authentication broker support across Windows, macOS, and Linux, and a refreshed terminal experience. ### Changes since 3.0.0 - **(Bug fix)** Prompt for default OS account on Microsoft DevBox ([#​2459](https://redirect.github.com/git-ecosystem/git-credential-manager/issues/2459)) - **(Bug fix)** Restore Entra broker parent window handling ([#​2464](https://redirect.github.com/git-ecosystem/git-credential-manager/issues/2464)) - **(Feature)** Support `authtype` Git capability ([#​2457](https://redirect.github.com/git-ecosystem/git-credential-manager/issues/2457)) - **(Feature)** Add console parent window parenting for non-Entra UI ([#​2465](https://redirect.github.com/git-ecosystem/git-credential-manager/issues/2465)) - Drop Windows x86 release binaries ([#​2456](https://redirect.github.com/git-ecosystem/git-credential-manager/issues/2456)) **Changelog:** [v3.0.0...v3.0.1][point1-changelog] ### Changes since 2.9.1 > \[!IMPORTANT] > This release changes supported operating systems and the default Azure Repos authentication experience. Review the breaking changes before upgrading. #### Breaking changes and upgrade notes ##### Updated platform and .NET requirements GCM now targets **.NET 10 on all platforms**. Windows builds no longer use .NET Framework. | Platform or installation method | Requirement | | ------------------------------- | --------------------------------------------------------- | | Windows | Windows 10 or later; Windows Server 2016 or later | | macOS | macOS 14 or later | | Linux | A distribution supported by .NET 10 | | .NET tool | Install the .NET 10 SDK before installing or updating GCM | See the [supported environments][supported-environments] and [.NET 10 support matrix][dotnet-support] for details. Standalone platform packages do **not** require a separate .NET installation. **Windows 7 and Windows 8.x are no longer supported by GCM 3.x.** GCM 2.9.x will receive minimal, security-only maintenance for those systems, but no new features. Upgrading Windows is recommended. ([git-ecosystem/git-credential-manager#2365][pr-2365], [git-ecosystem/git-credential-manager#2367][pr-2367]) ##### Azure Repos uses OAuth tokens by default GCM now returns Microsoft identity **OAuth tokens**, rather than creating personal access tokens (PATs), by default for Azure Repos. OAuth tokens are automatically refreshed as needed. Explicit credential-type settings are still respected. If you need the previous PAT behavior, set: ```shell git config --global credential.azreposCredentialType pat ``` The equivalent environment variable is `GCM_AZREPOS_CREDENTIALTYPE=pat`. See [Azure Repos users and tokens][azrepos-tokens]. ([git-ecosystem/git-credential-manager#2449][pr-2449]) ##### Microsoft authentication uses the OS broker by default Broker integration is now enabled by default wherever supported, rather than requiring an opt-in. This applies to Microsoft authentication, such as Azure Repos; it does not change authentication for GitHub, Bitbucket, or GitLab. On macOS, broker authentication requires Company Portal and device enrollment. On Linux, it requires the supported Intune setup, a GNOME desktop, and Microsoft Edge; headless and WSL environments do not support the Linux broker. > \[!WARNING] > Depending on your organization's policies, broker sign-in can prompt you to join or enroll your device. On Windows, signing in with a personal Microsoft account can also affect the account linked to your local Windows user. Review the [broker documentation][broker] before proceeding, especially on personal devices. To opt out: ```shell git config --global credential.msauthUseBroker false ``` The equivalent environment variable is `GCM_MSAUTH_USEBROKER=false`. When the broker is in use, it takes precedence over `credential.msauthFlow`. ([git-ecosystem/git-credential-manager#2449][pr-2449]) ##### Azure Repos uses a dedicated GCM Entra application GCM now signs in using its own first-party Microsoft Entra application instead of the Visual Studio application. This enables broker support on macOS and Linux, in addition to Windows. If you encounter a client-application configuration error, GCM provides guidance for retrying with the legacy application; it does **not** silently switch back. For a one-command compatibility retry: ```shell git -c credential.azreposUseLegacyClientId=true fetch ``` Please report the original failure if this workaround succeeds. The legacy application does not support broker authentication on macOS or Linux. Managed identity, service-principal, and workload-identity federation flows are unaffected by the application change. The undocumented developer overrides `credential.azreposDevClientId` and `credential.azreposDevAuthorityBaseUri`, and their environment-variable equivalents `GCM_DEV_AZREPOS_CLIENTID` and `GCM_DEV_AZREPOS_AUTHORITYBASEURI`, have been removed. The [legacy-client setting][legacy-client] is a focused compatibility option, not an arbitrary client-ID or authority override. ([git-ecosystem/git-credential-manager#2416][pr-2416]) ##### The embedded Microsoft sign-in web view has been removed The Windows-only embedded web view depended on .NET Framework and is no longer available. Use the broker, system browser, or device-code flow instead. If you previously forced `credential.msauthFlow=embedded` or `GCM_MSAUTH_FLOW=embedded`, change it to `auto`, `system`, or `devicecode`. Disable broker integration as described above if you specifically need to force a non-broker flow. ([git-ecosystem/git-credential-manager#2365][pr-2365]) ##### Terminal and diagnostic output has changed Terminal selection prompts now use arrow-key navigation instead of numbered input, and `diagnose` has a new output format. Automation that drives interactive menus or parses diagnostic text may need updating. Git's credential-protocol input and output remain separate from interactive prompts. ([git-ecosystem/git-credential-manager#2377][pr-2377], [git-ecosystem/git-credential-manager#2425][pr-2425]) #### Features and improvements - **Native ahead-of-time builds.** Published platform packages compile GCM to native code to reduce startup overhead. The .NET tool remains a framework-dependent distribution. ([git-ecosystem/git-credential-manager#2366][pr-2366], [git-ecosystem/git-credential-manager#2367][pr-2367]) - **Cross-platform Microsoft single sign-on.** The authentication broker can reuse OS accounts on supported Windows, macOS, and Linux installations. When a default OS account can be used, GCM asks for confirmation unless automatic use is explicitly enabled, or enabled by default in environments such as Microsoft Dev Box. Set `credential.msauthUseDefaultAccount=false` to skip the default-account attempt. See the [broker documentation][broker]. ([git-ecosystem/git-credential-manager#2379][pr-2379], [git-ecosystem/git-credential-manager#2416][pr-2416]) - **Optional isolated Azure Repos token cache.** Set `credential.azreposUseMicrosoftSharedCache=false`, or `GCM_AZREPOS_USE_MSFT_CACHE=false`, to use a GCM-specific cache. Sharing with other Microsoft developer tools remains the default. ([git-ecosystem/git-credential-manager#2415][pr-2415]) - **Support for Bitbucket Cloud's updated OAuth tokens.** Rotating refresh tokens are now consistently saved against the resolved Bitbucket username, avoiding repeated sign-ins caused by reusing an old refresh token. Large access and refresh tokens are split across credential entries when needed, so Windows users can keep the default `wincredman` store without switching to another credential store. ([git-ecosystem/git-credential-manager#2433][pr-2433], [git-ecosystem/git-credential-manager#2440][pr-2440]) - **Generic OAuth beyond HTTP(S).** Generic OAuth configuration now works for non-HTTP credential requests, such as SMTP authentication for `git send-email`. Windows Integrated Authentication remains HTTP(S)-only. ([git-ecosystem/git-credential-manager#2445][pr-2445]) - **Refreshed terminal prompts and diagnostics.** Interactive prompts use Spectre.Console, and Ctrl+C during a prompt restores the terminal and exits cleanly with status 130. `git-credential-manager diagnose` distinguishes passed, warning, failed, and skipped checks, reports the actual credential store, and summarizes generated logs. Add `--strict` to return a non-zero exit code for warnings as well as errors; without it, only errors fail. ([git-ecosystem/git-credential-manager#2377][pr-2377], [git-ecosystem/git-credential-manager#2423][pr-2423], [git-ecosystem/git-credential-manager#2425][pr-2425]) - **More complete Trace2 diagnostics.** Expanded instrumentation covers command execution, configuration, credential storage, UI startup, and authentication. Entra tracing now records broker, cache, and interaction-mode decisions alongside timings, using the existing Git Trace2 settings. ([git-ecosystem/git-credential-manager#2408][pr-2408], [git-ecosystem/git-credential-manager#2450][pr-2450]) - **Newer Git credential-protocol support.** GCM supports capability negotiation and the `state[]` and `continue` fields introduced in Git 2.46, providing infrastructure for multi-stage authentication. Existing authentication flows and compatibility with older Git versions are preserved. ([git-ecosystem/git-credential-manager#2357][pr-2357]) #### Fixes - Improve dispatcher failure and shutdown handling without starting the UI framework for operations that do not need it. ([git-ecosystem/git-credential-manager#2451][pr-2451]) - Respect Git configuration `include` and `includeIf` files in scoped queries, avoiding duplicate configuration entries when settings already exist in an included file. ([git-ecosystem/git-credential-manager#2345][pr-2345]) #### Installation and contributor changes - The install-from-source helper now supports both macOS and Linux at `build/install-from-source.sh`. It defaults to a trimmed, self-contained build; use `--aot` to opt into native compilation and its additional toolchain requirements. See the [installation instructions][install-from-source]. - Source builds now use `git-credential-manager.slnx`, with libraries and tests directly under `src/` and packaging scripts under `build/`. A solution build no longer runs packaging; use the per-platform distribution projects for that. See the [development guide][development]. ([git-ecosystem/git-credential-manager#2367][pr-2367]) - Windows x64 and ARM64 packages use the 64-bit Inno Setup installer; x86 packages retain a 32-bit installer. ([git-ecosystem/git-credential-manager#2380][pr-2380]) - Internal credential-helper actions (`get`, `store`, `erase`, and `capability`) are hidden from `--help`, but remain available for Git to invoke. ([git-ecosystem/git-credential-manager#2357][pr-2357]) **Changelog:** [v2.9.1...v3.0.0][full-changelog] [point1-changelog]: https://redirect.github.com/git-ecosystem/git-credential-manager/compare/v3.0.0...v3.0.1 [azrepos-tokens]: https://redirect.github.com/git-ecosystem/git-credential-manager/blob/v3.0.1/docs/azrepos-users-and-tokens.md [broker]: https://redirect.github.com/git-ecosystem/git-credential-manager/blob/v3.0.1/docs/msauth-broker.md [development]: https://redirect.github.com/git-ecosystem/git-credential-manager/blob/v3.0.1/docs/development.md [dotnet-support]: https://redirect.github.com/dotnet/core/blob/main/release-notes/10.0/supported-os.md [full-changelog]: https://redirect.github.com/git-ecosystem/git-credential-manager/compare/v2.9.1...v3.0.0 [install-from-source]: https://redirect.github.com/git-ecosystem/git-credential-manager/blob/v3.0.1/docs/install.md#install-from-source-helper-script [legacy-client]: https://redirect.github.com/git-ecosystem/git-credential-manager/blob/v3.0.1/docs/configuration.md#credentialazreposuselegacyclientid [supported-environments]: https://redirect.github.com/git-ecosystem/git-credential-manager/blob/v3.0.1/README.md#supported-environments [pr-2345]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2345 [pr-2357]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2357 [pr-2365]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2365 [pr-2366]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2366 [pr-2367]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2367 [pr-2377]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2377 [pr-2379]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2379 [pr-2380]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2380 [pr-2408]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2408 [pr-2415]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2415 [pr-2416]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2416 [pr-2423]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2423 [pr-2425]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2425 [pr-2433]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2433 [pr-2440]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2440 [pr-2445]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2445 [pr-2449]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2449 [pr-2450]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2450 [pr-2451]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2451 ### [`v3.0.0`](https://redirect.github.com/git-ecosystem/git-credential-manager/releases/tag/v3.0.0): GCM 3.0.0 [Compare Source](https://redirect.github.com/git-ecosystem/git-credential-manager/compare/v2.9.1...v3.0.0) Git Credential Manager 3.0 brings native ahead-of-time compilation, Microsoft authentication broker support across Windows, macOS, and Linux, and a refreshed terminal experience. These notes cover changes since **GCM 2.9.1**. > \[!IMPORTANT] > This release changes supported operating systems and the default Azure Repos authentication experience. Review the breaking changes before upgrading. #### Breaking changes and upgrade notes ##### Updated platform and .NET requirements GCM now targets **.NET 10 on all platforms**. Windows builds no longer use .NET Framework. | Platform or installation method | Requirement | | ------------------------------- | --------------------------------------------------------- | | Windows | Windows 10 or later; Windows Server 2016 or later | | macOS | macOS 14 or later | | Linux | A distribution supported by .NET 10 | | .NET tool | Install the .NET 10 SDK before installing or updating GCM | See the [supported environments][supported-environments] and [.NET 10 support matrix][dotnet-support] for details. Standalone platform packages do **not** require a separate .NET installation. **Windows 7 and Windows 8.x are no longer supported by GCM 3.x.** GCM 2.9.x will receive minimal, security-only maintenance for those systems, but no new features. Upgrading Windows is recommended. ([git-ecosystem/git-credential-manager#2365][pr-2365], [git-ecosystem/git-credential-manager#2367][pr-2367]) ##### Azure Repos uses OAuth tokens by default GCM now returns Microsoft identity **OAuth tokens**, rather than creating personal access tokens (PATs), by default for Azure Repos. OAuth tokens are automatically refreshed as needed. Explicit credential-type settings are still respected. If you need the previous PAT behavior, set: ```shell git config --global credential.azreposCredentialType pat ``` The equivalent environment variable is `GCM_AZREPOS_CREDENTIALTYPE=pat`. See [Azure Repos users and tokens][azrepos-tokens]. ([git-ecosystem/git-credential-manager#2449][pr-2449]) ##### Microsoft authentication uses the OS broker by default Broker integration is now enabled by default wherever supported, rather than requiring an opt-in. This applies to Microsoft authentication, such as Azure Repos; it does not change authentication for GitHub, Bitbucket, or GitLab. On macOS, broker authentication requires Company Portal and device enrollment. On Linux, it requires the supported Intune setup, a GNOME desktop, and Microsoft Edge; headless and WSL environments do not support the Linux broker. > \[!WARNING] > Depending on your organization's policies, broker sign-in can prompt you to join or enroll your device. On Windows, signing in with a personal Microsoft account can also affect the account linked to your local Windows user. Review the [broker documentation][broker] before proceeding, especially on personal devices. To opt out: ```shell git config --global credential.msauthUseBroker false ``` The equivalent environment variable is `GCM_MSAUTH_USEBROKER=false`. When the broker is in use, it takes precedence over `credential.msauthFlow`. ([git-ecosystem/git-credential-manager#2449][pr-2449]) ##### Azure Repos uses a dedicated GCM Entra application GCM now signs in using its own first-party Microsoft Entra application instead of the Visual Studio application. This enables broker support on macOS and Linux, in addition to Windows. If you encounter a client-application configuration error, GCM provides guidance for retrying with the legacy application; it does **not** silently switch back. For a one-command compatibility retry: ```shell git -c credential.azreposUseLegacyClientId=true fetch ``` Please report the original failure if this workaround succeeds. The legacy application does not support broker authentication on macOS or Linux. Managed identity, service-principal, and workload-identity federation flows are unaffected by the application change. The undocumented developer overrides `credential.azreposDevClientId` and `credential.azreposDevAuthorityBaseUri`, and their environment-variable equivalents `GCM_DEV_AZREPOS_CLIENTID` and `GCM_DEV_AZREPOS_AUTHORITYBASEURI`, have been removed. The [legacy-client setting][legacy-client] is a focused compatibility option, not an arbitrary client-ID or authority override. ([git-ecosystem/git-credential-manager#2416][pr-2416]) ##### The embedded Microsoft sign-in web view has been removed The Windows-only embedded web view depended on .NET Framework and is no longer available. Use the broker, system browser, or device-code flow instead. If you previously forced `credential.msauthFlow=embedded` or `GCM_MSAUTH_FLOW=embedded`, change it to `auto`, `system`, or `devicecode`. Disable broker integration as described above if you specifically need to force a non-broker flow. ([git-ecosystem/git-credential-manager#2365][pr-2365]) ##### Terminal and diagnostic output has changed Terminal selection prompts now use arrow-key navigation instead of numbered input, and `diagnose` has a new output format. Automation that drives interactive menus or parses diagnostic text may need updating. Git's credential-protocol input and output remain separate from interactive prompts. ([git-ecosystem/git-credential-manager#2377][pr-2377], [git-ecosystem/git-credential-manager#2425][pr-2425]) #### Features and improvements - **Native ahead-of-time builds.** Published platform packages compile GCM to native code to reduce startup overhead. The .NET tool remains a framework-dependent distribution. ([git-ecosystem/git-credential-manager#2366][pr-2366], [git-ecosystem/git-credential-manager#2367][pr-2367]) - **Cross-platform Microsoft single sign-on.** The authentication broker can reuse OS accounts on supported Windows, macOS, and Linux installations. When a default OS account can be used, GCM asks for confirmation unless automatic use is explicitly enabled, or enabled by default in environments such as Microsoft Dev Box. Set `credential.msauthUseDefaultAccount=false` to skip the default-account attempt. See the [broker documentation][broker]. ([git-ecosystem/git-credential-manager#2379][pr-2379], [git-ecosystem/git-credential-manager#2416][pr-2416]) - **Optional isolated Azure Repos token cache.** Set `credential.azreposUseMicrosoftSharedCache=false`, or `GCM_AZREPOS_USE_MSFT_CACHE=false`, to use a GCM-specific cache. Sharing with other Microsoft developer tools remains the default. ([git-ecosystem/git-credential-manager#2415][pr-2415]) - **Support for Bitbucket Cloud's updated OAuth tokens.** Rotating refresh tokens are now consistently saved against the resolved Bitbucket username, avoiding repeated sign-ins caused by reusing an old refresh token. Large access and refresh tokens are split across credential entries when needed, so Windows users can keep the default `wincredman` store without switching to another credential store. ([git-ecosystem/git-credential-manager#2433][pr-2433], [git-ecosystem/git-credential-manager#2440][pr-2440]) - **Generic OAuth beyond HTTP(S).** Generic OAuth configuration now works for non-HTTP credential requests, such as SMTP authentication for `git send-email`. Windows Integrated Authentication remains HTTP(S)-only. ([git-ecosystem/git-credential-manager#2445][pr-2445]) - **Refreshed terminal prompts and diagnostics.** Interactive prompts use Spectre.Console, and Ctrl+C during a prompt restores the terminal and exits cleanly with status 130. `git-credential-manager diagnose` distinguishes passed, warning, failed, and skipped checks, reports the actual credential store, and summarizes generated logs. Add `--strict` to return a non-zero exit code for warnings as well as errors; without it, only errors fail. ([git-ecosystem/git-credential-manager#2377][pr-2377], [git-ecosystem/git-credential-manager#2423][pr-2423], [git-ecosystem/git-credential-manager#2425][pr-2425]) - **More complete Trace2 diagnostics.** Expanded instrumentation covers command execution, configuration, credential storage, UI startup, and authentication. Entra tracing now records broker, cache, and interaction-mode decisions alongside timings, using the existing Git Trace2 settings. ([git-ecosystem/git-credential-manager#2408][pr-2408], [git-ecosystem/git-credential-manager#2450][pr-2450]) - **Newer Git credential-protocol support.** GCM supports capability negotiation and the `state[]` and `continue` fields introduced in Git 2.46, providing infrastructure for multi-stage authentication. Existing authentication flows and compatibility with older Git versions are preserved. ([git-ecosystem/git-credential-manager#2357][pr-2357]) #### Fixes - Improve dispatcher failure and shutdown handling without starting the UI framework for operations that do not need it. ([git-ecosystem/git-credential-manager#2451][pr-2451]) - Respect Git configuration `include` and `includeIf` files in scoped queries, avoiding duplicate configuration entries when settings already exist in an included file. ([git-ecosystem/git-credential-manager#2345][pr-2345]) #### Installation and contributor changes - The install-from-source helper now supports both macOS and Linux at `build/install-from-source.sh`. It defaults to a trimmed, self-contained build; use `--aot` to opt into native compilation and its additional toolchain requirements. See the [installation instructions][install-from-source]. - Source builds now use `git-credential-manager.slnx`, with libraries and tests directly under `src/` and packaging scripts under `build/`. A solution build no longer runs packaging; use the per-platform distribution projects for that. See the [development guide][development]. ([git-ecosystem/git-credential-manager#2367][pr-2367]) - Windows x64 and ARM64 packages use the 64-bit Inno Setup installer; x86 packages retain a 32-bit installer. ([git-ecosystem/git-credential-manager#2380][pr-2380]) - Internal credential-helper actions (`get`, `store`, `erase`, and `capability`) are hidden from `--help`, but remain available for Git to invoke. ([git-ecosystem/git-credential-manager#2357][pr-2357]) **Full changelog:** [v2.9.1...v3.0.0][full-changelog] [azrepos-tokens]: https://redirect.github.com/git-ecosystem/git-credential-manager/blob/v3.0.0/docs/azrepos-users-and-tokens.md [broker]: https://redirect.github.com/git-ecosystem/git-credential-manager/blob/v3.0.0/docs/msauth-broker.md [development]: https://redirect.github.com/git-ecosystem/git-credential-manager/blob/v3.0.0/docs/development.md [dotnet-support]: https://redirect.github.com/dotnet/core/blob/main/release-notes/10.0/supported-os.md [full-changelog]: https://redirect.github.com/git-ecosystem/git-credential-manager/compare/v2.9.1...v3.0.0 [install-from-source]: https://redirect.github.com/git-ecosystem/git-credential-manager/blob/v3.0.0/docs/install.md#install-from-source-helper-script [legacy-client]: https://redirect.github.com/git-ecosystem/git-credential-manager/blob/v3.0.0/docs/configuration.md#credentialazreposuselegacyclientid [supported-environments]: https://redirect.github.com/git-ecosystem/git-credential-manager/blob/v3.0.0/README.md#supported-environments [pr-2345]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2345 [pr-2357]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2357 [pr-2365]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2365 [pr-2366]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2366 [pr-2367]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2367 [pr-2377]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2377 [pr-2379]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2379 [pr-2380]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2380 [pr-2408]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2408 [pr-2415]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2415 [pr-2416]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2416 [pr-2423]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2423 [pr-2425]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2425 [pr-2433]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2433 [pr-2440]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2440 [pr-2445]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2445 [pr-2449]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2449 [pr-2450]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2450 [pr-2451]: https://redirect.github.com/git-ecosystem/git-credential-manager/pull/2451 </details> --- ### Configuration 📅 **Schedule**: (UTC) - Branch creation - At any time (no schedule defined) - Automerge - At any time (no schedule defined) 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/tak848/dotfiles). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0NC4xMzQuMSIsInVwZGF0ZWRJblZlciI6IjQ0LjEzNC4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJyZW5vdmF0ZSIsInVwZGF0ZV9tYWpvciJdfQ==--> --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: tak-automation[bot] <221638520+tak-automation[bot]@users.noreply.github.com>
Problem
As stated here: #2428
Bitbucket Cloud will start generating tokens which are in excess of 2,000 character wide strings. This causes problems for our Windows users which have the
wincredmanCredentialStore configured (the default for GCM on windows). Windows underlying credential manager is only able to store 2,560 bytes per secret.See: https://learn.microsoft.com/en-us/windows/win32/api/wincred/ns-wincred-credentiala
This is a 1280 character long unicode string (Validated on my windows 10 laptop).
Solutions to this Problem
After some back and forth, I decided there was was two options:
Force windows users to change their configured
credentialStoretodpapi, so that there isn't a limitation on the size of tokens. This required user action, and meant that any other stored credentials would be lost, and would require re-entry / re-authorization (I know that it's possible to configure different credential stores for different hosts but still)Implement some form of chunking algorithm that allows Windows users to continue to use the same default
CredentialStorebut would get around the size constraints on the Windows Credential Manager. This solution is massively preferable as it means the only action we'd need users to take for us to migrate the OAuth token format would will be to upgrade to the GCM version containing the changes.This PR
This PR implements the second option above. This implements the changes isolated within the
BitbucketHostProvider. It will chunk bothaccess_tokensandrefresh_tokenswhich are larger than the available space in the underlyingCredentialStoreinto the appropriate number of chunks.The implementation defines a new overridable property on the
ICredentialStorewhich defines theCredentialStoresmaximum credential (when stored as a string) size. The default value for this is0which means that theCredentialStoredoes not impose any restrictions. The onlyCredentialStoreimplementation which sets a max size is theWindowsCredentialManager.The chunking implementation
The actual chunking implementation is relatively trivial and maintains backwards compatibility for existing stored credentials. This allows backwards compatibility with existing stored secrets.
Consider the following credential to store (length 13)
Normally this would be stored like this:
But let's say we wish to store it in a
CredentialStorewith a limit of 5 characters per credential. We'd have to break it into 3 chunks (2 complete and 1 partial) which would be stored like this:We store a chunk descriptor (for lack of better name) against the
accountin theservice. This means that when we read an existing secret for a givenaccount, we would either a chunk descriptor or a regular secret (which is not chunked).We can then use regex to detect if the credential is "chunked" or a regular secret. The format of the chunk descriptor:
chunks=<NUMBER_OF_CHUNKS>is impossible to collide with a real Bitbucket issued PAT or OAuth token -=is not an allowed character in our token set, and the width is smaller than we'd ever mint.If we encounter a chunked descriptor (on Get) we then use the stored credential's
Account, coupled with the extractedchunk countto retrieve thenchunks and stitch the full secret together.Note: If we encounter a missing chunk, we return
nullwhich would treat it the same as if there was no credential (or an expired credential) and the auth behaviour would continue on.Why this solution is good?
What could be better?
WindowsCredentialManagerimplementation. This would mean allHostProviderscould use the behaviour. This seemed like a fair chunk more effort than I can realistically spend. If there is a long term desire that this could be the direction we need to go - we should ensure that we're happy with the "shape" of the implementation so that a future change could be rolled out without impacting the Bitbucket stored secrets.Testing