Skip to main content

CoreJwsSigningAlgorithm

Enum CoreJwsSigningAlgorithm 

Source
#[non_exhaustive]
pub enum CoreJwsSigningAlgorithm {
Show 13 variants HmacSha256, HmacSha384, HmacSha512, RsaSsaPkcs1V15Sha256, RsaSsaPkcs1V15Sha384, RsaSsaPkcs1V15Sha512, EcdsaP256Sha256, EcdsaP384Sha384, EcdsaP521Sha512, RsaSsaPssSha256, RsaSsaPssSha384, RsaSsaPssSha512, None,
}
Expand description

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)§

This enum is marked as 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§

Source§

impl Clone for CoreJwsSigningAlgorithm

Source§

fn clone(&self) -> CoreJwsSigningAlgorithm

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CoreJwsSigningAlgorithm

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for CoreJwsSigningAlgorithm

Source§

impl Hash for CoreJwsSigningAlgorithm

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl JsonWebKey<CoreJwsSigningAlgorithm, CoreJsonWebKeyType, CoreJsonWebKeyUse> for CoreJsonWebKey

Source§

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

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

fn key_type(&self) -> &CoreJsonWebKeyType

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

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

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

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

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

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. Read more
Source§

impl JwsSigningAlgorithm<CoreJsonWebKeyType> for CoreJwsSigningAlgorithm

Source§

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.
Source§

fn uses_shared_secret(&self) -> bool

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

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. Read more
Source§

fn rsa_sha_256() -> Self

Returns the RS256 algorithm. Read more
Source§

impl PartialEq for CoreJwsSigningAlgorithm

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

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

Source§

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

Signs the given message using the given signature algorithm.
Source§

fn as_verification_key(&self) -> CoreJsonWebKey

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

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

Source§

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

Signs the given message using the given signature algorithm.
Source§

fn as_verification_key(&self) -> CoreJsonWebKey

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

impl Serialize for CoreJwsSigningAlgorithm

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for CoreJwsSigningAlgorithm

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more