Struct http_signature_normalization_actix::Config

pub struct Config<Spawner = DefaultSpawner> { /* 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 fn new() -> Self

Create a new Config with a default expiration of 10 seconds

impl<Spawner> Config<Spawner>

pub fn set_host_header(self) -> Self

Since manually setting the Host header doesn’t work so well in AWC, you can use this method to enable setting the Host header for signing requests without breaking client functionality

pub fn spawner<S>(self, spawner: S) -> Config<S>

where S: Spawn,

Set the spawner for spawning blocking tasks

http-signature-normalization-actix offloads signing messages and generating hashes to a blocking threadpool, which can be configured by providing a custom spawner.

pub fn mastodon_compat(self) -> Self

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) -> Self

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) -> Self

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

Note that by enabling this, the Date header becomes required on requests. This is to prevent replay attacks

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

Set the expiration to a custom duration

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

Require a header on signed and verified requests

pub fn begin_sign( &self, method: &Method, path_and_query: Option<&PathAndQuery>, headers: HeaderMap ) -> Result<Unsigned, PrepareSignError>

Begin the process of singing a request

pub fn begin_verify( &self, method: &Method, path_and_query: Option<&PathAndQuery>, headers: HeaderMap ) -> Result<Unverified, PrepareVerifyError>

Begin the proess of verifying a request

Trait Implementations

impl<Spawner: Clone> Clone for Config<Spawner>

fn clone(&self) -> Config<Spawner>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Spawner: Debug> Debug for Config<Spawner>

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

Formats the value using the given formatter.

impl<Spawner: Default> Default for Config<Spawner>

fn default() -> Config<Spawner>

Returns the “default value” for a type.