Enum Key

pub enum Key {
    EC {
        curve: Curve,
    },
    RSA {
        public: RsaPublic,
        private: Option<RsaPrivate>,
    },
    Symmetric {
        key: ByteVec,
    },
}

Variants

EC

An elliptic curve, as per RFC 7518 §6.2.

Fields

curve: Curve

RSA

An elliptic curve, as per RFC 7518 §6.3. See also: RFC 3447.

Fields

public: RsaPublic

private: Option<RsaPrivate>

Symmetric

A symmetric key, as per RFC 7518 §6.4.

Fields

key: ByteVec

Implementations

impl Key

pub fn thumbprint(&self) -> String

The JWK thumbprint, as per RFC 7638, using SHA-256 as the hash function.

pub fn try_thumbprint_using_hasher<H: Digest>(&self) -> Result<String, Error>

The JWK thumbprint, as per RFC 7638, using the provided hash function.

impl Key

pub fn is_private(&self) -> bool

Returns true iff this key only contains private components (i.e. a private asymmetric key or a symmetric key).

pub fn to_public(&self) -> Option<Cow<'_, Self>>

Returns the public part of this key (symmetric keys have no public parts).

pub fn try_to_der(&self) -> Result<Vec<u8>, ConversionError>

If this key is asymmetric, encodes it as PKCS#8.

pub fn to_der(&self) -> Vec<u8>

Unwrapping try_to_der. Panics if the key is not asymmetric or there are missing RSA components.

pub fn try_to_pem(&self) -> Result<String, ConversionError>

If this key is asymmetric, encodes it as PKCS#8 with PEM armoring.

pub fn to_pem(&self) -> String

Unwrapping try_to_pem. Panics if the key is not asymmetric or there are missing RSA components.

pub fn generate_symmetric(num_bits: usize) -> Self

Generates a new symmetric key with the specified number of bits. Best used with one of the HS algorithms (e.g., HS256).

pub fn generate_p256() -> Self

Generates a new EC keypair using the prime256 curve. Used with the ES256 algorithm.

impl Key

pub fn try_to_encoding_key(&self) -> Result<EncodingKey, ConversionError>

Returns an EncodingKey if the key is private.

pub fn to_encoding_key(&self) -> EncodingKey

Unwrapping try_to_encoding_key. Panics if the key is public.

pub fn to_decoding_key(&self) -> DecodingKey

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 PartialEq for Key

fn eq(&self, other: &Key) -> 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 Eq for Key

impl StructuralPartialEq for Key