Enum CoreJsonWebKeyUse

#[non_exhaustive]
pub enum CoreJsonWebKeyUse {
    Signature,
    Encryption,
    Other(String),
}

Usage restriction for a JSON Web key.

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.

Signature

Key may be used for digital signatures.

Encryption

Key may be used for encryption.

Other(String)

Fallback case for other key uses not understood by this library.

Trait Implementations

impl AsRef<str> for CoreJsonWebKeyUse

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for CoreJsonWebKeyUse

fn clone(&self) -> CoreJsonWebKeyUse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CoreJsonWebKeyUse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CoreJsonWebKeyUse

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 JsonWebKeyUse for CoreJsonWebKeyUse

fn allows_signature(&self) -> bool

Returns true if the associated key may be used for digital signatures, or false otherwise.

fn allows_encryption(&self) -> bool

Returns true if the associated key may be used for encryption, or false otherwise.

impl PartialEq for CoreJsonWebKeyUse

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 CoreJsonWebKeyUse

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 CoreJsonWebKeyUse