Struct SessionToken 

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

A cryptographically random 32-byte session token.

The raw bytes are never transmitted; only the hex-encoded form is written to the signed cookie, and the SHA-256 hash is stored in the database so that a stolen database cannot be used to forge cookies.

Debug and Display both redact the value as "****" to prevent accidental logging.

Implementations

impl SessionToken

pub fn generate() -> Self

Generate a new random session token.

pub fn from_hex(s: &str) -> Result<Self, &'static str>

Decode a session token from a 64-character lowercase hex string.

Errors

Returns Err if the string is not exactly 64 characters or contains non-hexadecimal characters.

pub fn as_hex(&self) -> String

Encode the token as a 64-character lowercase hex string.

This is the value written into the session cookie.

pub fn hash(&self) -> String

Compute the SHA-256 hash of the token and return it as a 64-character lowercase hex string.

This hash is what is stored in sessions.token_hash. Storing only the hash ensures that a read of the database cannot be used to impersonate users.

Trait Implementations

impl Clone for SessionToken

fn clone(&self) -> SessionToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionToken

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

Formats the value using the given formatter.

impl Display for SessionToken

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

Formats the value using the given formatter.

impl Hash for SessionToken

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SessionToken

fn eq(&self, other: &SessionToken) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SessionToken

impl StructuralPartialEq for SessionToken