Enum SymmetricKey 

#[non_exhaustive]
pub enum SymmetricKey {
    Hs256(Hmac<Sha256>),
    Hs384(Hmac<Sha384>),
    Hs512(Hmac<Sha512>),
}

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

Hs384(Hmac<Sha384>)

Hs512(Hmac<Sha512>)

Implementations

impl SymmetricKey

pub fn new_for_alg( key: Vec<u8>, alg: &JsonWebSignatureAlg, ) -> Result<SymmetricKey, InvalidAlgorithm>

Create a new symmetric key for the given algorithm with the given key.

Errors

Returns an error if the algorithm is not supported.

pub const fn hs256(key: Vec<u8>) -> SymmetricKey

Create a new symmetric key using the HS256 algorithm with the given key.

pub const fn hs384(key: Vec<u8>) -> SymmetricKey

Create a new symmetric key using the HS384 algorithm with the given key.

pub const fn hs512(key: Vec<u8>) -> SymmetricKey

Create a new symmetric key using the HS512 algorithm with the given key.

Trait Implementations

impl From<Hmac<Sha256>> for SymmetricKey

fn from(key: Hmac<Sha256>) -> SymmetricKey

Converts to this type from the input type.

impl From<Hmac<Sha384>> for SymmetricKey

fn from(key: Hmac<Sha384>) -> SymmetricKey

Converts to this type from the input type.

impl From<Hmac<Sha512>> for SymmetricKey

fn from(key: Hmac<Sha512>) -> SymmetricKey

Converts to this type from the input type.

impl RandomizedSigner<Signature> for SymmetricKey

fn try_sign_with_rng<R>( &self, _rng: &mut R, msg: &[u8], ) -> Result<Signature, Error>

where R: TryCryptoRng + ?Sized,

Attempt to sign the given message, returning a digital signature on success, or an error if something went wrong.

fn sign_with_rng<R>(&self, rng: &mut R, msg: &[u8]) -> S

where R: CryptoRng + ?Sized,

Sign the given message and return a digital signature

impl Signer<Signature> for SymmetricKey

fn try_sign(&self, msg: &[u8]) -> Result<Signature, Error>

Attempt to sign the given message, returning a digital signature on success, or an error if something went wrong.

fn sign(&self, msg: &[u8]) -> S

Sign the given message and return a digital signature.

impl Verifier<Signature> for SymmetricKey

fn verify(&self, msg: &[u8], signature: &Signature) -> Result<(), Error>

Use Self (e.g. a verifying key) to verify that the provided signature is authentic for a given message bytestring.