Struct http_sig::SigningConfig

pub struct SigningConfig { /* fields omitted */ }

The configuration used for signing HTTP requests.

Methods

impl SigningConfig

pub fn new_default(key_id: &str, key: &[u8]) -> Self

Creates a new signing configuration using the default signature algorithm, and the specified key ID and key.

pub fn new<SigAlg: HttpSignature>(key_id: &str, signature: SigAlg) -> Self

Creates a new signing configuration using a custom signature algorithm, and the specified key ID.

pub fn key_id(&self) -> &str

Returns the key ID.

pub fn digest(&self) -> &dyn HttpDigest

Returns the HTTP digest algorithm.

pub fn with_digest<DigestAlg: HttpDigest>(self, digest: DigestAlg) -> Self

Sets the HTTP digest algorithm.

pub fn compute_digest(&self) -> bool

Returns whether the digest will be automatically computed when not already present.

This is set to true by default.

pub fn set_compute_digest(&mut self, compute_digest: bool) -> &mut Self

Controls whether the digest will be automatically computed when not already present (in-place).

This is set to true by default.

pub fn with_compute_digest(self, compute_digest: bool) -> Self

Controls whether the digest will be automatically computed when not already present.

This is set to true by default.

pub fn add_date(&self) -> bool

Returns whether the current date and time will be added to the request when not already present.

This is set to true by default.

pub fn set_add_date(&mut self, add_date: bool) -> &mut Self

Controls whether the current date and time will be added to the request when not already present (in-place).

This is set to true by default.

pub fn with_add_date(self, add_date: bool) -> Self

Controls whether the current date and time will be added to the request when not already present.

This is set to true by default.

pub fn add_host(&self) -> bool

Returns whether the host will be added to the request when not already present.

This is set to true by default.

pub fn set_add_host(&mut self, add_host: bool) -> &mut Self

Controls whether the host will be added to the request when not already present (in-place).

This is set to true by default.

pub fn with_add_host(self, add_host: bool) -> Self

Controls whether the host will be added to the request when not already present.

This is set to true by default.

pub fn headers(&self) -> impl IntoIterator<Item = &Header>

Returns the list of headers to include in the signature. Headers in this list which are not present in the request itself will be skipped when signing the request.

This list contains (request-target), host, date and digest by default.

pub fn set_headers(&mut self, headers: &[Header]) -> &mut Self

Controls the list of headers to include in the signature (in-place). Headers in this list which are not present in the request itself will be skipped when signing the request.

This list contains (request-target), host, date and digest by default.

pub fn with_headers(self, headers: &[Header]) -> Self

Controls the list of headers to include in the signature. Headers in this list which are not present in the request itself will be skipped when signing the request.

This list contains (request-target), host, date and digest by default.

Trait Implementations

impl Clone for SigningConfig

fn clone(&self) -> SigningConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SigningConfig

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

Formats the value using the given formatter.