Struct Config

pub struct Config { /* private fields */ }

Configuration for signing and verifying signatures

By default, the config is set up to create and verify signatures that expire after 10 seconds, and use the (created) and (expires) fields that were introduced in draft 11

Implementations

impl Config

pub const fn new() -> Config

Create a new Config with a default expiration of 10 seconds

pub fn mastodon_compat(self) -> Config

Enable mastodon compatibility

This is the same as disabling the use of (created) and (expires) signature fields, requiring the Date header, and requiring the Host header

pub fn require_digest(self) -> Config

Require the Digest header be set

This is useful for POST, PUT, and PATCH requests, but doesn’t make sense for GET or DELETE.

pub fn dont_use_created_field(self) -> Config

Opt out of using the (created) and (expires) fields introduced in draft 11

Note that by not requiring the created field, the Date header becomes required. This is to prevent replay attacks.

pub const fn set_expiration(self, expires_after: Duration) -> Config

Set the expiration to a custom duration

pub fn require_header(self, header: &str) -> Config

Mark a header as required

pub fn begin_sign( &self, method: &str, path_and_query: &str, headers: BTreeMap<String, String>, ) -> Result<Unsigned, RequiredError>

Perform the neccessary operations to produce an Unsigned type, which can be used to sign the header

pub fn begin_verify( &self, method: &str, path_and_query: &str, headers: BTreeMap<String, String>, ) -> Result<Unverified, PrepareVerifyError>

Perform the neccessary operations to produce and Unverified type, which can be used to verify the header

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.