credentials: deprecate ProtocolInfo.SecurityVersion #3372
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
dfawley
changed the title
dfawley
added
Type: API Change
dfawley
reviewed
Feb 12, 2020
credentials/credentials.go
Outdated
| @@ -101,6 +101,8 @@ type ProtocolInfo struct { | |||
| // SecurityProtocol is the security protocol in use. | |||
| SecurityProtocol string | |||
| // SecurityVersion is the security protocol version. | |||
There was a problem hiding this comment.
Should we update this comment to explain that it's a static version string, not computed per-connection, and consequently has little value?
There was a problem hiding this comment.
Updated the comment.
credentials/alts/alts_test.go
Outdated
| @@ -128,9 +128,6 @@ func (s) TestInfo(t *testing.T) { | |||
| if got, want := info.SecurityProtocol, "alts"; got != want { | |||
| t.Errorf("info.SecurityProtocol=%v, want %v", got, want) | |||
| } | |||
| if got, want := info.SecurityVersion, "1.0"; got != want { | |||
There was a problem hiding this comment.
Is there any harm in leaving this here? If it's because of vet.sh, then:
- why isn't
vet.shfailing because of the place in the code that sets the value? - we can update
vet.shto ignore this deprecation warning instead.
There was a problem hiding this comment.
I left it in and added it to vet.sh.
dfawley
reviewed
Feb 13, 2020
credentials/credentials.go
Outdated
Comment on lines
103
to
105
| // SecurityVersion is the security protocol version. | ||
| // | ||
| // Deprecated: please use Peer.AuthInfo. |
There was a problem hiding this comment.
Let's go with:
// SecurityVersion is the security protocol version. It is a static version string from the
// credentials, not a value that reflects per-connection protocol negotiation. To retrieve
// details about the credentials used for a connection, use the Peer's AuthInfo field instead.
//
// Deprecated: please use Peer.AuthInfo.
dfawley
approved these changes
Feb 13, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Deprecating ProtocolInfo.SecurityVersion.
Updates #3352