Enum biscuit::jwk::AlgorithmParameters

pub enum AlgorithmParameters {
    EllipticCurve(EllipticCurveKeyParameters),
    RSA(RSAKeyParameters),
    OctetKey(OctetKeyParameters),
    OctetKeyPair(OctetKeyPairParameters),
}

Algorithm specific parameters

Variants

EllipticCurve(EllipticCurveKeyParameters)

Elliptic curve (EC) key

RSA(RSAKeyParameters)

RSA key

OctetKey(OctetKeyParameters)

Octet symmetric key

OctetKeyPair(OctetKeyPairParameters)

Octet key pair

Implementations

impl AlgorithmParameters

pub fn key_type(&self) -> KeyType

Returns the type of key represented by this set of algorithm parameters

pub fn octet_key(&self) -> Result<&[u8], Error>

Return the byte sequence of an octet key

pub fn thumbprint(&self, algorithm: &'static Algorithm) -> Result<String, Error>

JWK thumbprints are digests for identifying key material. Their computation is specified in RFC 7638.

This can be used to identify a public key; when the underlying digest algorithm is collision-resistant (currently, the SHA-2 family is provided), it is infeasible to build two keys sharing a thumbprint.

As mentioned in the RFC’s security considerations, it remains possible to build related keys with distinct parameters and thumbprints.

// Example from https://tools.ietf.org/html/rfc7638#section-3.1
let jwk: biscuit::jwk::JWK<biscuit::Empty> = serde_json::from_str(
r#"{
  "kty": "RSA",
  "n": "0vx7agoebGcQSuuPiLJXZptN9nndrQmbXEps2aiAFbWhM78LhWx4cbbfAAtVT86zwu1RK7aPFFxuhDR1L6tSoc_BJECPebWKRXjBZCiFV4n3oknjhMstn64tZ_2W-5JsGY4Hc5n9yBXArwl93lqt7_RN5w6Cf0h4QyQ5v-65YGjQR0_FDW2QvzqY368QQMicAtaSqzs8KJZgnYb9c7d0zgdAZHzu6qMQvRL5hajrn1n91CbOpbISD08qNLyrdkt-bFTWhAI4vMQFh6WeZu0fM4lFd2NcRwr3XPksINHaQ-G_xBniIqbw0Ls1jF44-csFCur-kEgU8awapJzKnqDKgw",
  "e": "AQAB",
  "alg": "RS256",
  "kid": "2011-04-29"
  }"#,
).unwrap();
assert_eq!(
  jwk.algorithm.thumbprint(&biscuit::digest::SHA256).unwrap(),
  "NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs"
);

Trait Implementations

impl Clone for AlgorithmParameters

fn clone(&self) -> AlgorithmParameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AlgorithmParameters

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AlgorithmParameters

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<AlgorithmParameters> for AlgorithmParameters

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for AlgorithmParameters

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 AlgorithmParameters

impl StructuralEq for AlgorithmParameters

impl StructuralPartialEq for AlgorithmParameters