Skip to main content

KeyHasher

Struct KeyHasher 

Source
pub struct KeyHasher { /* private fields */ }
Expand description

Derives opaque subject keys using HMAC-SHA-256.

Each derivation is domain-separated by the exact policy and scope identifiers. The same normalized subject therefore yields unrelated keys in different policy scopes.

Applications should keep one stable secret per deployment. Rotating it deliberately starts new counters because all derived subject keys change.

The raw secret is not retained after construction. Instead, the hasher caches key-equivalent, precomputed HMAC state. Cloning a hasher copies that state; each copy zeroizes its SHA-256 state and buffered input when dropped. Treat a live KeyHasher as secret material. Debug never exposes its state.

Implementations§

Source§

impl KeyHasher

Source

pub const MINIMUM_SECRET_LENGTH: usize = 32

Minimum accepted secret length in bytes.

Source

pub fn new(secret: impl AsRef<[u8]>) -> Result<Self, KeyHasherError>

Constructs a hasher by precomputing zeroizing keyed HMAC state.

The supplied raw secret is borrowed only for construction and is not retained by the returned hasher.

§Errors

Returns KeyHasherError::SecretTooShort unless the secret contains at least 32 bytes.

Source

pub fn hash( &self, policy_id: &PolicyId, scope_id: &ScopeId, subject: impl AsRef<[u8]>, ) -> SubjectKey

Hashes a normalized subject within an explicit policy and scope.

Normalization is application-owned: two byte strings are treated as distinct subjects even if an application considers them equivalent.

Source

pub fn hash_for<P: RateLimitPolicy + ?Sized>( &self, policy: &P, subject: impl AsRef<[u8]>, ) -> SubjectKey

Hashes a normalized subject in a rate-limit policy’s namespace.

Trait Implementations§

Source§

impl Clone for KeyHasher

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KeyHasher

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.