Enum openidconnect::core::CoreJwsSigningAlgorithm

#[non_exhaustive]
pub enum CoreJwsSigningAlgorithm {
    HmacSha256,
    HmacSha384,
    HmacSha512,
    RsaSsaPkcs1V15Sha256,
    RsaSsaPkcs1V15Sha384,
    RsaSsaPkcs1V15Sha512,
    EcdsaP256Sha256,
    EcdsaP384Sha384,
    EcdsaP521Sha512,
    RsaSsaPssSha256,
    RsaSsaPssSha384,
    RsaSsaPssSha512,
    None,
}

OpenID Connect Core JWS signing algorithms.

These algorithms represent the alg header parameter values for JSON Web Signature. They are used to digitally sign or create a MAC of the contents of the JWS Protected Header and the JWS Payload. The values are described in Section 3.1 of RFC 7518.

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.

HmacSha256

HMAC using SHA-256 (currently unsupported).

HmacSha384

HMAC using SHA-384 (currently unsupported).

HmacSha512

HMAC using SHA-512 (currently unsupported).

RsaSsaPkcs1V15Sha256

RSA SSA PKCS#1 v1.5 using SHA-256.

RsaSsaPkcs1V15Sha384

RSA SSA PKCS#1 v1.5 using SHA-384.

RsaSsaPkcs1V15Sha512

RSA SSA PKCS#1 v1.5 using SHA-512.

EcdsaP256Sha256

ECDSA using P-256 and SHA-256 (currently unsupported).

EcdsaP384Sha384

ECDSA using P-384 and SHA-384 (currently unsupported).

EcdsaP521Sha512

ECDSA using P-521 and SHA-512 (currently unsupported).

RsaSsaPssSha256

RSA SSA-PSS using SHA-256 and MGF1 with SHA-256.

RsaSsaPssSha384

RSA SSA-PSS using SHA-384 and MGF1 with SHA-384.

RsaSsaPssSha512

RSA SSA-PSS using SHA-512 and MGF1 with SHA-512.

None

No digital signature or MAC performed.

Security Warning

This algorithm provides no security over the integrity of the JSON Web Token. Clients should be careful not to rely on unsigned JWT’s for security purposes. See Critical vulnerabilities in JSON Web Token libraries for further discussion.

Trait Implementations

impl Clone for CoreJwsSigningAlgorithm

fn clone(&self) -> CoreJwsSigningAlgorithm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CoreJwsSigningAlgorithm

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CoreJwsSigningAlgorithm

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

Deserialize this value from the given Serde deserializer.

impl Hash for CoreJwsSigningAlgorithm

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, 

Feeds a slice of this type into the given Hasher.

impl JsonWebKey<CoreJwsSigningAlgorithm, CoreJsonWebKeyType, CoreJsonWebKeyUse> for CoreJsonWebKey

fn key_id(&self) -> Option<&JsonWebKeyId>

Returns the key ID, or None if no key ID is specified.

fn key_type(&self) -> &CoreJsonWebKeyType

Returns the key type (e.g., RSA).

fn key_use(&self) -> Option<&CoreJsonWebKeyUse>

Returns the allowed key usage (e.g., signing or encryption), or None if no usage is specified.

fn new_symmetric(key: Vec<u8>) -> Self

Initializes a new symmetric key or shared signing secret from the specified raw bytes.

fn verify_signature(
    &self,
    signature_alg: &CoreJwsSigningAlgorithm,
    message: &[u8],
    signature: &[u8]
) -> Result<(), SignatureVerificationError>

Verifies the given signature using the given signature algorithm (signature_alg) over the given message.

impl JwsSigningAlgorithm<CoreJsonWebKeyType> for CoreJwsSigningAlgorithm

fn key_type(&self) -> Option<CoreJsonWebKeyType>

Returns the type of key required to use this signature algorithm, or None if this algorithm does not require a key.

fn uses_shared_secret(&self) -> bool

Returns true if the signature algorithm uses a shared secret (symmetric key).

fn hash_bytes(&self, bytes: &[u8]) -> Result<Vec<u8>, String>

Hashes the given bytes using the hash algorithm associated with this signing algorithm, and returns the hashed bytes.

fn rsa_sha_256() -> Self

Returns the RS256 algorithm.

impl PartialEq<CoreJwsSigningAlgorithm> for CoreJwsSigningAlgorithm

fn eq(&self, other: &CoreJwsSigningAlgorithm) -> 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 !=.

impl PrivateSigningKey<CoreJwsSigningAlgorithm, CoreJsonWebKeyType, CoreJsonWebKeyUse, CoreJsonWebKey> for CoreHmacKey

fn sign(
    &self,
    signature_alg: &CoreJwsSigningAlgorithm,
    message: &[u8]
) -> Result<Vec<u8>, SigningError>

Signs the given message using the given signature algorithm.

fn as_verification_key(&self) -> CoreJsonWebKey

Converts this key to a JSON Web Key that can be used for verifying signatures.

impl PrivateSigningKey<CoreJwsSigningAlgorithm, CoreJsonWebKeyType, CoreJsonWebKeyUse, CoreJsonWebKey> for CoreRsaPrivateSigningKey

fn sign(
    &self,
    signature_alg: &CoreJwsSigningAlgorithm,
    msg: &[u8]
) -> Result<Vec<u8>, SigningError>

Signs the given message using the given signature algorithm.

fn as_verification_key(&self) -> CoreJsonWebKey

Converts this key to a JSON Web Key that can be used for verifying signatures.

impl Serialize for CoreJwsSigningAlgorithm

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 CoreJwsSigningAlgorithm

impl StructuralEq for CoreJwsSigningAlgorithm

impl StructuralPartialEq for CoreJwsSigningAlgorithm