Enum KeyAlgorithm 

#[non_exhaustive]
pub enum KeyAlgorithm {
    Ed25519,
}

The signature algorithm a key pair uses.

There is exactly one variant, and is_allowed_alg still admits only it. The type exists so that the algorithm travels with the key rather than being assumed by every reader of it: a verifier can then bind the JWS alg header to what the key record says, instead of letting an attacker-supplied header select the verification path.

#[non_exhaustive] so that adding a second algorithm later is not a breaking change for downstream matches.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Ed25519

Ed25519 signatures, JOSE EdDSA (RFC 8037 §3.1).

Implementations

impl KeyAlgorithm

pub fn jose_alg(self) -> &'static str

The JOSE alg header value.

pub fn from_jose_alg(alg: &str) -> Option<Self>

Parse a JOSE alg header value. None for anything not allowed here, which includes none.

pub fn public_key_jwk(self, public_key: &[u8]) -> Value

The JWK members describing public_key, for a DID document’s publicKeyJwk.

Lives here rather than in the DID-document builder so the per-algorithm match stays exhaustive in the crate that defines the algorithm. A second algorithm needs a kty/parameter set that only this crate should have to know — P-256, for instance, is kty: "EC" with both x and y, where Ed25519 is kty: "OKP" with x alone.

Trait Implementations

impl Clone for KeyAlgorithm

fn clone(&self) -> KeyAlgorithm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KeyAlgorithm

impl Debug for KeyAlgorithm

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyAlgorithm

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for KeyAlgorithm

impl PartialEq for KeyAlgorithm

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for KeyAlgorithm

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KeyAlgorithm