credentials: Add experimental credentials that don't enforce ALPN #7980
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #7980 +/- ##
==========================================
+ Coverage 82.05% 82.10% +0.05%
==========================================
Files 381 384 +3
Lines 38539 38692 +153
==========================================
+ Hits 31622 31768 +146
- Misses 5602 5605 +3
- Partials 1315 1319 +4
|
arjan-bal
force-pushed
the
experiments-tls
branch
from
4626aff to
1d71903
Compare
arjan-bal
force-pushed
the
experiments-tls
branch
from
1d71903 to
78c4cbf
Compare
dfawley
reviewed
Jan 9, 2025
| @@ -32,6 +32,8 @@ import ( | |||
| "google.golang.org/grpc/internal/envconfig" | |||
| ) | |||
|
|
|||
| const alpnFailureHelpMessage = "If you upgraded from a grpc-go version earlier than 1.67, your TLS connections may stopped working due to ALPN enforcement. For more details, see: https://github.com/grpc/grpc-go/issues/434. To disable ALPN enforcement, set the environment variable GRPC_ENFORCE_ALPN_ENABLED to false, or use the experimental credentials available under experimental/credentials. Note that these workarounds are intended for migration purposes and will be removed in future grpc-go versions." | |||
There was a problem hiding this comment.
Nit: "may have stopped working"
Also I think I'd remove everything after "see 434". The rest of the explanation can be in there.
| @@ -0,0 +1,252 @@ | |||
| /* | |||
| * | |||
| * Copyright 2016 gRPC authors. | |||
| * | ||
| */ | ||
|
|
||
| // Package credentials contains experimental TLS credentials. |
There was a problem hiding this comment.
This should have a big scary comment about how these credentials should only be used to maintain compatibility for people relying upon interoperability with clients violating the HTTP/2 specification, and that it will be deleted, so users should not use it directly. Instead they either need to vendor gRPC or copy these credentials.
| @@ -0,0 +1,393 @@ | |||
| /* | |||
| * | |||
| * Copyright 2023 gRPC authors. | |||
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.
Fixes: #7922
Related Issue: #434
This change copies the existing TLS credentials, removing the code for ALPN enforcement. These credentials will be removed in a couple of releases and users who still need to disable ALPN can copy the credentials as is. Changes made:
credentials/tls.gotoexperimental/credentials/tls.go. Add suffixWithALPNDisabledto constructors.internal/credentialstoexperimental/credentials/internal.RELEASE NOTES: