Struct UrlSigner 

pub struct UrlSigner { /* private fields */ }

Signs and verifies URLs with a key derived from APP_KEY.

Implementations

impl UrlSigner

pub fn new(key: &AppKey) -> Self

pub fn from_config(config: &Config) -> Result<Self>

pub fn sign(&self, url: &str, expires_at: Option<u64>) -> String

Sign a URL, optionally giving it an expiry.

expires_at is a unix timestamp in seconds; None signs a link that never expires, which is right for an unsubscribe URL and wrong for a password reset. Any signature or expires already on the URL is dropped first, so re-signing a link is idempotent rather than accumulating parameters.

pub fn sign_temporary(&self, url: &str, ttl: Duration) -> String

Sign a URL that expires ttl from now — the common case.

pub fn verify(&self, url: &str) -> Result<(), SignatureError>

Check a URL, usually request.target().

The signature is verified before the expiry is read. expires is an attacker-supplied number until the MAC says otherwise, so trusting it first would let anybody extend their own link.

pub fn is_valid(&self, url: &str) -> bool

Whether a URL verifies, for callers that only want a yes or no.

Trait Implementations

impl Clone for UrlSigner

fn clone(&self) -> UrlSigner

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UrlSigner

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

Formats the value using the given formatter.