Add control over use of unsafe remotes #1721
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a new setting that allows users to express an explicit consent to using unsafe remote URLs (such as those using HTTP rather than HTTPS).
Note that we only emit a warning for the generic host provider rather than failing-fast like the other providers do. This is because we never blocked HTTP remotes previously in the generic provider (which is often used for localhost, custom hosts, etc) and don't want to break any existing scenarios or scripts. The new option can be used to dismiss this warning message.
mjcheetham
commented
Oct 7, 2024
| @@ -226,6 +228,7 @@ public static class HelpUrls | |||
| public const string GcmAutoDetect = "https://aka.ms/gcm/autodetect"; | |||
| public const string GcmDefaultAccount = "https://aka.ms/gcm/defaultaccount"; | |||
| public const string GcmMultipleUsers = "https://aka.ms/gcm/multipleusers"; | |||
| public const string GcmUnsafeRemotes = "https://aka.ms/gcm/unsaferemotes"; | |||
There was a problem hiding this comment.
This shortlink has been configured to point to
https://github.com/git-ecosystem/git-credential-manager/blob/release/docs/netconfig.md#unsafe-remote-urls
dscho
approved these changes
Oct 7, 2024
There was a problem hiding this comment.
This PR looks good to me!
There is a new error about a broken link:
✗ [404] https://specifications.freedesktop.org/secret-service/ | Failed: Network error: Not Found
This link is in GCM's documentation apparently 3 times. I think that this should be updated to https://specifications.freedesktop.org/secret-service-spec/.
I have opened #1722 to fix this; This successful doc linting run suggests that I've managed 😊 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Today, all the custom host providers (Azure Repos, Bitbucket, GitHub, GitLab) block the use of HTTP (unencrypted) remote URLs and error out. Only the generic host provider permits HTTP remotes.
From #1694, we learn that a common use case for self/corporate hosted Git servers is to use HTTP remotes. Even if this is not recommended, GCM should not outright block these.
Instead, we now add an option,
GCM_ALLOW_UNSAFE_REMOTESorcredential.allowUnsafeRemotes, for the user to explicitly set to allow the use of these unsafe remotes.For the generic host provider we only print a warning when using HTTP remotes to reduce the churn for existing users who rely on GCM for HTTP remotes.