Clarify documentation of KeyType
#37
Closed
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
|
Reading these additional comments, in my opinion, make the purpose of it even more confusing 😅 I added a ticket in the backlog to refactor this into something that more resembles what we have in Kotlin: #38 If others agree that this helps clarify, I'm all for adding. But to me, it's bringing in a concept (JWK |
| @@ -2,6 +2,13 @@ use ssi_jwk::JWK; | |||
| use ssi_jws::Error as JWSError; | |||
|
|
|||
| /// Enum defining all supported cryptographic key types. | |||
| /// | |||
| /// Note that KeyType is NOT to be interpreted as the "kty" header defined in https://www.rfc-editor.org/rfc/rfc7517#section-4.1. | |||
There was a problem hiding this comment.
this note is not necessary since this enum is not defined in the context of JOSE
| /// Instead, "kty" (the JOSE header) should be thought of as the type for a Json Web Key (JWK) | ||
| /// object. This enum should be thought of as the type of a cryptographic key. | ||
| /// KeyType maps to a JWK type, but not the other way around. For example, the KeyType of "Ed25519" | ||
| /// maps to the JWK type (i.e. the "kty" header) of "EC". The converse is not true. "EC" maps to |
|
Closing this since it's covered in #38 |
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.
From #34 and a conversation with @decentralgabe , added documentation to clarify what I think may be confusing.
Feedback is more than welcome.