Enum JwsAlgorithm 

#[non_exhaustive]
pub enum JwsAlgorithm {
    HS256,
    HS384,
    HS512,
    ES256,
    ES384,
    RS256,
    RS384,
    RS512,
    PS256,
    PS384,
    PS512,
    EdDSA,
}

A JWS signing / verification algorithm (RFC 7518 Section 3.1)

The alg header value of a JWT, shared by everything in the framework that signs or verifies one: bearer authentication on the server side, and private_key_jwt client assertions on the client side. The mapping onto the underlying JWT implementation stays private to each crate, so no consumer has to name it. The variant names are the registered alg values verbatim, so the derived serde impls are the wire form (JwsAlgorithm::EdDSA <-> "EdDSA").

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.

HS256

HMAC using SHA-256

HS384

HMAC using SHA-384

HS512

HMAC using SHA-512

ES256

ECDSA using P-256 and SHA-256

ES384

ECDSA using P-384 and SHA-384

RS256

RSASSA-PKCS1-v1_5 using SHA-256

RS384

RSASSA-PKCS1-v1_5 using SHA-384

RS512

RSASSA-PKCS1-v1_5 using SHA-512

PS256

RSASSA-PSS using SHA-256

PS384

RSASSA-PSS using SHA-384

PS512

RSASSA-PSS using SHA-512

EdDSA

Edwards-curve Digital Signature Algorithm (EdDSA)

Implementations

impl JwsAlgorithm

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

Returns the registered alg header value of this algorithm

Use it to match against the algorithm lists a server advertises, such as token_endpoint_auth_signing_alg_values_supported.

pub const fn is_symmetric(&self) -> bool

Returns true for the HMAC algorithms, where signer and verifier hold the same secret

Anything built on proving possession of a private key - a private_key_jwt client assertion, a key published in a JWKS - must refuse these: a shared secret proves nothing about who signed.

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 Default for JwsAlgorithm

fn default() -> Self

Returns the “default value” for a type.

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

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

Equality operator ==.

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

Inequality operator !=.

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