Skip to main content

TokenSecret

Struct TokenSecret 

Source
pub struct TokenSecret(/* private fields */);
Expand description

Zeroizing wrapper for HMAC token secrets.

§Security Properties

  • Memory is zeroed on drop via zeroize (through secrecy::SecretBox)
  • Explicitly does NOT implement: Debug, Display, Clone, PartialEq, Serialize, Deserialize – preventing accidental logging, serialization, or copying
  • Secret bytes accessed only via expose_secret() which returns &[u8]

§Threat Model

Protects against: accidental logging, memory dumps after drop, clone-and-forget patterns, comparison side channels, JSON serialization leakage. Does NOT protect against: active memory forensics while the secret is in use, side-channel attacks on the HMAC computation itself.

§Usage in Structs

When embedding TokenSecret in a struct that derives Serialize:

#[derive(serde::Serialize)]
struct MyServer {
    #[serde(skip)]  // REQUIRED -- TokenSecret does not implement Serialize
    token_secret: TokenSecret,
    // ... other fields
}

Implementations§

Source§

impl TokenSecret

Source

pub fn new(secret: impl Into<Vec<u8>>) -> Self

Create from raw bytes. The input Vec is consumed and its contents copied into a SecretBox. The original Vec is NOT zeroed – callers should use from_env() for maximum security.

Source

pub fn from_env(var: &str) -> Result<Self, VarError>

Read from an environment variable. The string value is converted to bytes and wrapped immediately.

Source

pub fn expose_secret(&self) -> &[u8]

Expose the secret bytes for cryptographic operations. Callers MUST NOT log or persist the returned slice.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

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

Source§

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