Struct Hmac

pub struct Hmac<D> { /* private fields */ }

Available on crate feature hmac only.

The HMAC algorithm as used when signing a JWS.

This type exists to associate the original key value with the digest. This is required for verification, and for the jwk field in the JWS header, if that field is enabled.

Implementations

impl<D> Hmac<D>

pub fn new(key: HmacKey) -> Self

Create a new HMAC digest wrapper with a given signing key.

Signing keys are arbitrary bytes.

pub fn key(&self) -> &HmacKey

Reference to the HMAC key.

Trait Implementations

impl<D> Clone for Hmac<D>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Debug> Debug for Hmac<D>

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

Formats the value using the given formatter.

impl<D> DeserializeJWK for Hmac<D>

fn build(parameters: BTreeMap<String, Value>) -> Result<Self, JsonWebKeyError>

From a set of parameters, build a key.

fn from_jwk(jwk: &JsonWebKey) -> Result<Self, JsonWebKeyError>

Build a concrete key type from JsonWebKey.

fn from_value(value: Value) -> Result<Self, JsonWebKeyError>

Deserialize a concrete key type from a JSON value.

fn from_str(s: &str) -> Result<Self, JsonWebKeyError>

Deserialize a concrete key type from a JSON string.

impl<D> JWKeyType for Hmac<D>

const KEY_TYPE: &'static str = "oct"

The string used to identify the JWK type in the kty field.

impl JsonWebAlgorithm for Hmac<Sha256>

const IDENTIFIER: AlgorithmIdentifier = crate::algorithms::AlgorithmIdentifier::HS256

The identifier for this algorithm when used in a JWT registered header.

impl JsonWebAlgorithm for Hmac<Sha512>

const IDENTIFIER: AlgorithmIdentifier = crate::algorithms::AlgorithmIdentifier::HS512

The identifier for this algorithm when used in a JWT registered header.

impl JsonWebAlgorithm for Hmac<Sha384>

const IDENTIFIER: AlgorithmIdentifier = crate::algorithms::AlgorithmIdentifier::HS384

The identifier for this algorithm when used in a JWT registered header.

impl<D> Keypair for Hmac<D>

type VerifyingKey = Hmac<D>

Verifying key type for this keypair.

fn verifying_key(&self) -> Self::VerifyingKey

Get the verifying key which can verify signatures produced by the signing key portion of this keypair.

impl<D> SerializeJWK for Hmac<D>

fn parameters(&self) -> Vec<(String, Value)>

Return a list of parameters to be serialized in the JWK.

impl<D> TokenSigner<DigestSignature<D>> for Hmac<D>

where Hmac<D>: JsonWebAlgorithm, D: Digest + BlockSizeUser + Clone,

fn try_sign_token( &self, header: &str, payload: &str, ) -> Result<DigestSignature<D>, Error>

Sign the contents of the JWT, when provided with the base64url-encoded header and payload. The header and payload are already serialized to JSON and then base64url-encoded, so this function should not perform any additional encoding.

fn sign_token(&self, header: &str, payload: &str) -> S

Sign the contents of the JWT, when provided with the base64url-encoded header and payload. See TokenSigner::try_sign_token for more details.

impl<D> TokenSigner for Hmac<D>

where Hmac<D>: JsonWebAlgorithm, D: Digest + BlockSizeUser + Clone,

fn try_sign_token( &self, header: &str, payload: &str, ) -> Result<SignatureBytes, Error>

Sign the contents of the JWT, when provided with the base64url-encoded header and payload. The header and payload are already serialized to JSON and then base64url-encoded, so this function should not perform any additional encoding.

fn sign_token(&self, header: &str, payload: &str) -> S

Sign the contents of the JWT, when provided with the base64url-encoded header and payload. See TokenSigner::try_sign_token for more details.

impl<D> TokenVerifier<DigestSignature<D>> for Hmac<D>

where Hmac<D>: JsonWebAlgorithm, D: Digest + BlockSizeUser + Clone,

fn verify_token( &self, header: &[u8], payload: &[u8], signature: &[u8], ) -> Result<DigestSignature<D>, Error>

Verify the signature of the JWT, when provided with the base64url-encoded header and payload, along side the signature. The header and payload are already encoded, so this function should not perform any additional encoding.

impl<D> TokenVerifier for Hmac<D>

where Hmac<D>: JsonWebAlgorithm, D: Digest + BlockSizeUser + Clone,

fn verify_token( &self, header: &[u8], payload: &[u8], signature: &[u8], ) -> Result<SignatureBytes, Error>

Verify the signature of the JWT, when provided with the base64url-encoded header and payload, along side the signature. The header and payload are already encoded, so this function should not perform any additional encoding.