Struct http_signature_normalization_reqwest::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<DefaultSpawner>

pub fn new() -> Self

Create a new config with the default spawner

impl<Spawner> Config<Spawner>

pub fn new_with_spawner(spawner: Spawner) -> Self

Create a new config with the provided spawner

pub fn set_host_header(self) -> Self

This method can be used to include the Host header in the HTTP Signature without interfering with Reqwest’s built-in Host mechanisms

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, expiries_after: Duration) -> Self

Set the expiration to a custom duration

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

Require a header on signed requests

pub fn set_spawner<NewSpawner: Spawn>( self, spawner: NewSpawner ) -> Config<NewSpawner>

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.