Struct Token 

pub struct Token { /* private fields */ }

One issued token, as the store keeps it: metadata plus a digest.

The secret is not in here and never was. A store hands these back, the middleware attaches one to the request, and a handler reads it with req.api_token().

Implementations

impl Token

pub fn new( id: impl Into<String>, identity: Identity, name: impl Into<String>, digest: [u8; 32], scopes: Scopes, ) -> Self

Rebuild a token from a stored row.

This is the constructor an application’s own TokenStore uses when it reads a record back out of its table. Issuing a new token goes through NewToken, which is the only place a secret is generated.

pub fn with_id(self, id: impl Into<String>) -> Self

Give the token a different id.

For a store whose table allocates the key itself: create returns the token it actually stored, and the plain-text credential is assembled from that id.

pub fn with_created_at(self, at: u64) -> Self

pub fn with_expires_at(self, at: Option<u64>) -> Self

pub fn with_last_used_at(self, at: Option<u64>) -> Self

pub fn id(&self) -> &str

pub fn identity(&self) -> &Identity

Who the token speaks for.

pub fn name(&self) -> &str

What the person called it — “iPhone”, “CI deploy key”.

Purely so a revocation screen lists something a human recognises.

pub fn scopes(&self) -> &Scopes

pub fn digest(&self) -> &[u8; 32]

The stored SHA-256 of the secret, for a store to persist.

Safe to write to a database column; not safe to write to a log. It proves nothing on its own, but it is the only value that verifies a token, so anywhere it leaks is somewhere it can be replayed against.

pub fn created_at(&self) -> u64

pub fn expires_at(&self) -> Option<u64>

pub fn last_used_at(&self) -> Option<u64>

pub fn set_last_used_at(&mut self, at: u64)

pub fn can(&self, scope: &str) -> bool

Whether the token grants scope. See Scopes::can.

pub fn is_expired(&self) -> bool

A token with no expiry never expires — that is what None means.

pub fn is_expired_at(&self, now: u64) -> bool

pub fn matches_secret(&self, secret: &str) -> bool

Whether secret is the one this token was issued with.

Constant time: the digest is compared with constant_time_eq, so how long the check took says nothing about how many bytes were right.

Trait Implementations

impl Clone for Token

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Token

Redacted by hand rather than derived.

The digest is the one value that verifies a token. {:?} on a request’s extensions, or on a store, is exactly the sort of thing that ends up in a log file, and a log file is exactly where it must not be.

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

Formats the value using the given formatter.