Struct FingerprintKey 

pub struct FingerprintKey { /* private fields */ }

The process-local secret that keys HeaderFingerprints, with the public epoch that names it.

The key is random, lives in memory only and is zeroed on drop. There is no Clone, no serde and Debug prints the epoch only. The epoch is not a proof of anything: two keys may share one, and a fingerprint only verifies when the key itself reproduces its tag.

Implementations

impl FingerprintKey

pub fn generate() -> Result<Self, Error>

A fresh key and an independently drawn epoch from the OS generator.

pub fn from_parts(key: Zeroizing<[u8; 32]>, epoch: [u8; 16]) -> Self

Rebuild a key that has to survive a hot upgrade, or a known test key.

pub fn fingerprint(&self, name: &str, value: &SecretValue) -> HeaderFingerprint

The fingerprint of value as the header name (case-insensitive).

pub fn verify( &self, name: &str, value: &SecretValue, fingerprint: &HeaderFingerprint, ) -> bool

Whether fingerprint was issued by this very key for this header and value. A matching epoch is necessary, never sufficient: the full tag is checked in constant time.

Trait Implementations

impl Debug for FingerprintKey

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

Formats the value using the given formatter.