Struct HmacSha2 

pub struct HmacSha2(/* private fields */);

Available on crate features crypto and std only.

A reusable SHA-256 or SHA-512 HMAC key for signing and verifying messages.

Uses ring when enabled, otherwise aws-lc when enabled, and RustCrypto when neither backend is enabled.

Implementations

impl HmacSha2

pub fn new_256(seed: &[u8; 32]) -> HmacSha2

Create an HMAC-SHA-256 key from a 32-byte secret.

pub fn try_rand_256() -> Result<HmacSha2, Box<dyn Error + Sync + Send>>

Generate an HMAC-SHA-256 key using the operating system’s randomness.

Errors

Returns an error if random key generation fails.

pub fn new_512(seed: &[u8; 64]) -> HmacSha2

Create an HMAC-SHA-512 key from a 64-byte secret.

pub fn try_rand_512() -> Result<HmacSha2, Box<dyn Error + Sync + Send>>

Generate an HMAC-SHA-512 key using the operating system’s randomness.

Errors

Returns an error if random key generation fails.

pub fn sign(&self, data: &[u8], out: &mut [u8])

Sign data, writing the full authentication tag into out.

Panics

Panics if out.len() does not equal Self::signature_len.

pub fn signature_len(&self) -> usize

Return the signature length in bytes: 32 for SHA-256 or 64 for SHA-512.

pub fn verify( &self, data: &[u8], signature: &[u8], ) -> Result<(), Box<dyn Error + Sync + Send>>

Verify the full signature of data using a constant-time comparison.

Errors

Returns an error if the signature does not match or has an incorrect length.

Trait Implementations

impl Clone for HmacSha2

fn clone(&self) -> HmacSha2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HmacSha2

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

Formats the value using the given formatter.