Struct Key 

pub struct Key {
    pub kty: KeyType,
    pub kid: Option<String>,
    pub key_use: Option<KeyUse>,
    pub key_ops: Option<Vec<KeyOperation>>,
    pub alg: Option<Algorithm>,
    pub params: KeyParams,
    pub x5c: Option<Vec<String>>,
    pub x5t: Option<String>,
    pub x5t_s256: Option<String>,
    pub x5u: Option<String>,
}

A JSON Web Key (RFC 7517).

Represents a single cryptographic key with its parameters and metadata.

Examples

use jwk_simple::jwk::{Key, KeyType};

// Parse from JSON
let json = r#"{"kty":"RSA","n":"AQAB","e":"AQAB"}"#;
let jwk: Key = serde_json::from_str(json).unwrap();

// Check key properties
assert_eq!(jwk.kty, KeyType::Rsa);
assert!(jwk.is_public_key_only());

Fields

kty: KeyType

The key type.

kid: Option<String>

The key ID.

key_use: Option<KeyUse>

The intended use of the key.

key_ops: Option<Vec<KeyOperation>>

The permitted operations for the key.

alg: Option<Algorithm>

The algorithm intended for use with the key.

params: KeyParams

The key-type-specific parameters.

x5c: Option<Vec<String>>

X.509 certificate chain (base64-encoded DER).

x5t: Option<String>

X.509 certificate SHA-1 thumbprint (base64url-encoded).

x5t_s256: Option<String>

X.509 certificate SHA-256 thumbprint (base64url-encoded).

x5u: Option<String>

X.509 URL.

Implementations

impl Key

pub fn is_public_key_only(&self) -> bool

Returns true if this contains only public key parameters.

pub fn has_private_key(&self) -> bool

Returns true if this contains private key parameters.

pub fn validate(&self) -> Result<()>

Validates the JWK.

Errors

Returns an error if:

• The key parameters are invalid
• The key type doesn’t match the parameters
• The algorithm doesn’t match the key type
• Both use and key_ops are specified (RFC 7517 Section 4.3 SHOULD NOT)

pub fn thumbprint(&self) -> String

Calculates the JWK thumbprint (RFC 7638).

The thumbprint is a base64url-encoded SHA-256 hash of the key’s required members.

pub fn as_rsa(&self) -> Option<&RsaParams>

Returns the key as RSA parameters, if applicable.

pub fn as_ec(&self) -> Option<&EcParams>

Returns the key as EC parameters, if applicable.

pub fn as_symmetric(&self) -> Option<&SymmetricParams>

Returns the key as symmetric parameters, if applicable.

pub fn as_okp(&self) -> Option<&OkpParams>

Returns the key as OKP parameters, if applicable.

pub fn to_public(&self) -> Option<Key>

Extracts only the public key components, removing any private key material.

For symmetric keys, this returns None since symmetric keys don’t have a separate public component.

Returns

A new Key containing only the public key parameters, or None for symmetric keys.

Examples

use jwk_simple::KeySet;

let json = r#"{"keys": [{
    "kty": "RSA",
    "n": "0vx7agoebGcQSuuPiLJXZptN9nndrQmbXEps2aiAFbWhM78LhWx4cbbfAAtVT86zwu1RK7aPFFxuhDR1L6tSoc_BJECPebWKRXjBZCiFV4n3oknjhMstn64tZ_2W-5JsGY4Hc5n9yBXArwl93lqt7_RN5w6Cf0h4QyQ5v-65YGjQR0_FDW2QvzqY368QQMicAtaSqzs8KJZgnYb9c7d0zgdAZHzu6qMQvRL5hajrn1n91CbOpbISD08qNLyrdkt-bFTWhAI4vMQFh6WeZu0fM4lFd2NcRwr3XPksINHaQ-G_xBniIqbw0Ls1jF44-csFCur-kEgU8awapJzKnqDKgw",
    "e": "AQAB",
    "d": "X4cTteJY_gn4FYPsXB8rdXix5vwsg1FLN5E3EaG6RJoVH-HLLKD9M7dx5oo7GURknchnrRweUkC7hT5fJLM0WbFAKNLWY2vv7B6NqXSzUvxT0_YSfqijwp3RTzlBaCxWp4doFk5N2o8Gy_nHNKroADIkJ46pRUohsXywbReAdYaMwFs9tv8d_cPVY3i07a3t8MN6TNwm0dSawm9v47UiCl3Sk5ZiG7xojPLu4sbg1U2jx4IBTNBznbJSzFHK66jT8bgkuqsk0GjskDJk19Z4qwjwbsnn4j2WBii3RL-Us2lGVkY8fkFzme1z0HbIkfz0Y6mqnOYtqc0X4jfcKoAC8Q"
}]}"#;
let jwks: KeySet = serde_json::from_str(json).unwrap();
let private_key = jwks.first().unwrap();

// Extract public key
let public_key = private_key.to_public().expect("RSA keys have public components");
assert!(public_key.is_public_key_only());

impl Key

pub fn to_rs256_public_key(&self) -> Result<RS256PublicKey>

Available on crate feature jwt-simple only.

Converts to an RS256 public key.

Errors

Returns an error if the key is not an RSA key.

pub fn to_rs256_key_pair(&self) -> Result<RS256KeyPair>

Available on crate feature jwt-simple only.

Converts to an RS256 key pair.

Errors

Returns an error if the key is not an RSA private key.

pub fn to_rs384_public_key(&self) -> Result<RS384PublicKey>

Available on crate feature jwt-simple only.

Converts to an RS384 public key.

pub fn to_rs384_key_pair(&self) -> Result<RS384KeyPair>

Available on crate feature jwt-simple only.

Converts to an RS384 key pair.

pub fn to_rs512_public_key(&self) -> Result<RS512PublicKey>

Available on crate feature jwt-simple only.

Converts to an RS512 public key.

pub fn to_rs512_key_pair(&self) -> Result<RS512KeyPair>

Available on crate feature jwt-simple only.

Converts to an RS512 key pair.

pub fn to_ps256_public_key(&self) -> Result<PS256PublicKey>

Available on crate feature jwt-simple only.

Converts to a PS256 public key.

pub fn to_ps256_key_pair(&self) -> Result<PS256KeyPair>

Available on crate feature jwt-simple only.

Converts to a PS256 key pair.

pub fn to_ps384_public_key(&self) -> Result<PS384PublicKey>

Available on crate feature jwt-simple only.

Converts to a PS384 public key.

pub fn to_ps384_key_pair(&self) -> Result<PS384KeyPair>

Available on crate feature jwt-simple only.

Converts to a PS384 key pair.

pub fn to_ps512_public_key(&self) -> Result<PS512PublicKey>

Available on crate feature jwt-simple only.

Converts to a PS512 public key.

pub fn to_ps512_key_pair(&self) -> Result<PS512KeyPair>

Available on crate feature jwt-simple only.

Converts to a PS512 key pair.

pub fn to_es256_public_key(&self) -> Result<ES256PublicKey>

Available on crate feature jwt-simple only.

Converts to an ES256 public key.

pub fn to_es256_key_pair(&self) -> Result<ES256KeyPair>

Available on crate feature jwt-simple only.

Converts to an ES256 key pair.

pub fn to_es384_public_key(&self) -> Result<ES384PublicKey>

Available on crate feature jwt-simple only.

Converts to an ES384 public key.

pub fn to_es384_key_pair(&self) -> Result<ES384KeyPair>

Available on crate feature jwt-simple only.

Converts to an ES384 key pair.

pub fn to_es256k_public_key(&self) -> Result<ES256kPublicKey>

Available on crate feature jwt-simple only.

Converts to an ES256k public key.

pub fn to_es256k_key_pair(&self) -> Result<ES256kKeyPair>

Available on crate feature jwt-simple only.

Converts to an ES256k key pair.

pub fn to_ed25519_public_key(&self) -> Result<Ed25519PublicKey>

Available on crate feature jwt-simple only.

Converts to an Ed25519 public key.

pub fn to_ed25519_key_pair(&self) -> Result<Ed25519KeyPair>

Available on crate feature jwt-simple only.

Converts to an Ed25519 key pair.

pub fn to_hs256_key(&self) -> Result<HS256Key>

Available on crate feature jwt-simple only.

Converts to an HS256 key.

pub fn to_hs384_key(&self) -> Result<HS384Key>

Available on crate feature jwt-simple only.

Converts to an HS384 key.

pub fn to_hs512_key(&self) -> Result<HS512Key>

Available on crate feature jwt-simple only.

Converts to an HS512 key.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Key

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Key

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for Key

fn drop(&mut self)

Executes the destructor for this type.

impl FromIterator<Key> for KeySet

fn from_iter<I: IntoIterator<Item = Key>>(iter: I) -> Self

Creates a value from an iterator.

impl PartialEq for Key

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Key

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Key> for ES256KeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for ES256PublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for ES256kKeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for ES256kPublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for ES384KeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for ES384PublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for Ed25519KeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for Ed25519PublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for HS256Key

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for HS384Key

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for HS512Key

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for PS256KeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for PS256PublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for PS384KeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for PS384PublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for PS512KeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for PS512PublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for RS256KeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for RS256PublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for RS384KeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for RS384PublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for RS512KeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<&Key> for RS512PublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for ES256KeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for ES256PublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for ES256kKeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for ES256kPublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for ES384KeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for ES384PublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for Ed25519KeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for Ed25519PublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for HS256Key

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for HS384Key

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for HS512Key

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for PS256KeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for PS256PublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for PS384KeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for PS384PublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for PS512KeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for PS512PublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for RS256KeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for RS256PublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for RS384KeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for RS384PublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for RS512KeyPair

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl TryFrom<Key> for RS512PublicKey

Available on crate feature jwt-simple only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: Key) -> Result<Self>

Performs the conversion.

impl Zeroize for Key

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Eq for Key