Enum JwsAlgorithm 

#[non_exhaustive]
pub enum JwsAlgorithm {
    EdDSA,
    ES256,
    ES256K,
    ES384,
    RS256,
    PS256,
}

A JWS digital signature algorithm (RFC 7518 §3.1, RFC 8037 §3.1, RFC 8812 §3.2).

Only asymmetric algorithms are listed: a DID controller signs with a private key and anyone resolves the public key, so HMAC and none have no place here. Conversions to and from jsonwebtoken::Algorithm are fallible in both directions because jsonwebtoken has HMAC variants this type lacks and lacks ES256K.

The Display and FromStr forms are the IANA “JSON Web Signature and Encryption Algorithms” names, and the type serializes as that string.

Examples

use identity_kit::jose::JwsAlgorithm;

let alg: JwsAlgorithm = "ES256".parse()?;
assert_eq!(alg, JwsAlgorithm::ES256);
assert_eq!(alg.to_string(), "ES256");
assert_eq!(serde_json::to_string(&alg)?, "\"ES256\"");

assert!("HS256".parse::<JwsAlgorithm>().is_err());
assert!("none".parse::<JwsAlgorithm>().is_err());

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.

EdDSA

EdDSA with Ed25519 (RFC 8037).

ES256

ECDSA with P-256 and SHA-256 (RFC 7518 §3.4). Verification accepts s and n - s alike, as JOSE allows, so a JWS’s bytes do not identify it; see DefaultVerifier.

ES256K

ECDSA with secp256k1 and SHA-256 (RFC 8812 §3.2). Verification accepts only the lower of s and n - s.

ES384

ECDSA with P-384 and SHA-384 (RFC 7518 §3.4).

RS256

RSASSA-PKCS1-v1_5 with SHA-256 (RFC 7518 §3.3), with a key of at least 2048 bits.

PS256

RSASSA-PSS with SHA-256 and MGF1 with SHA-256 (RFC 7518 §3.5), with a key of at least 2048 bits.

Implementations

impl JwsAlgorithm

pub const ALL: &'static [JwsAlgorithm]

Every algorithm this type knows, in declaration order.

pub const fn as_str(self) -> &'static str

The IANA name, for example ES256.

pub const fn is_ecdsa(self) -> bool

Whether this is an ECDSA algorithm, whose JWS signature is the raw r || s concatenation.

Trait Implementations

impl Clone for JwsAlgorithm

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for JwsAlgorithm

impl Debug for JwsAlgorithm

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JwsAlgorithm

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for JwsAlgorithm

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

Formats the value using the given formatter.

impl Eq for JwsAlgorithm

impl FromStr for JwsAlgorithm

type Err = UnknownAlgorithm

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for JwsAlgorithm

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for JwsAlgorithm

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for JwsAlgorithm

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for JwsAlgorithm

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialSchema for JwsAlgorithm

Available on crate feature utoipa only.

fn schema() -> RefOr<Schema>

Return ref or schema of implementing type that can then be used to construct combined schemas.

impl Serialize for JwsAlgorithm

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 JwsAlgorithm

impl ToSchema for JwsAlgorithm

Available on crate feature utoipa only.

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl TryFrom<Algorithm> for JwsAlgorithm

fn try_from(alg: Algorithm) -> Result<Self, Self::Error>

Fails for the HMAC algorithms and the SHA-384/SHA-512 RSA variants.

type Error = UnknownAlgorithm

The type returned in the event of a conversion error.

impl TryFrom<JwsAlgorithm> for Algorithm

fn try_from(alg: JwsAlgorithm) -> Result<Self, Self::Error>

Fails for JwsAlgorithm::ES256K, which jsonwebtoken does not implement.

type Error = UnknownAlgorithm

The type returned in the event of a conversion error.