Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify documentation of KeyType #37

Closed
wants to merge 1 commit into from
Closed

Clarify documentation of KeyType #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions crates/crypto/src/key/key.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's actually OKP 😉

/// many KeyType enums.
pub enum KeyType {
Secp256k1,
Secp256r1,
Expand Down