Fix a confusing type parameter for generating signatures. #32
Conversation
This file contains hidden or 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
The `generate_signature_headers_content` method's `signing_key` argument references `PublicKey` as its type. That's semantically wrong - a signing key must be a private key. In this case, `PublicKey` is a type alias for `Vec<u8>`, which is why it works - but there's no reason for us to confuse the public. I have removed the `PublicKey` and replaced it directly with `Vec<u8>`, and bumped Cargo accordingly per semver.
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.
The
generate_signature_headers_contentmethod'ssigning_keyargument references
PublicKeyas its type. That's semantically wrong -a signing key must be a private key. In this case,
PublicKeyis a typealias for
Vec<u8>, which is why it works - but there's no reason forus to confuse the public. I have removed the
PublicKeyand replaced itdirectly with
Vec<u8>, and bumped Cargo accordingly per semver.