Struct SignedUrls 

pub struct SignedUrls { /* private fields */ }

Signed URLs for this application’s named routes.

Bound at boot from the same key ring everything else uses, and composed with the UrlGenerator so a signed link is built from a route name rather than a path somebody typed twice.

Implementations

impl SignedUrls

pub fn new(urls: Arc<UrlGenerator>, signer: Arc<UrlSigner>) -> Self

Sign links to the routes urls knows about.

pub fn route(&self, name: &str, params: &[(&str, &str)]) -> Result<String>

A signed link to a named route.

signed.route("unsubscribe", &[("user", "42")])?
// /unsubscribe/42?signature=…

Route parameters are substituted into the path as usual; anything the route does not name becomes a query parameter, and is signed with the rest.

pub fn temporary_route( &self, name: &str, expires_at: i64, params: &[(&str, &str)], ) -> Result<String>

A signed link that stops working after expires_at.

expires_at is seconds since the epoch. It is part of the query and so part of the signature: moving it invalidates the link.

This is the one to reach for. An unsigned expiry is a promise; a signed one is a fact, and a link with no expiry at all lives in a mailbox for years.

pub fn absolute_route( &self, name: &str, params: &[(&str, &str)], ) -> Result<String>

A signed absolute URL — with the scheme and host in front.

What goes in an email. Note the host is not covered by the signature; see UrlSigner.

pub fn temporary_absolute_route( &self, name: &str, expires_at: i64, params: &[(&str, &str)], ) -> Result<String>

absolute_route, expiring.

pub fn sign(&self, url: &str) -> Result<String>

Sign a path directly, for a link no named route describes.

pub fn signer(&self) -> &Arc<UrlSigner>

The signer underneath.

Trait Implementations

impl Debug for SignedUrls

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

Formats the value using the given formatter.