Struct HttpSignatureParams 

pub struct HttpSignatureParams {
    pub created: Option<u64>,
    pub expires: Option<u64>,
    pub nonce: Option<String>,
    pub alg: Option<String>,
    pub keyid: Option<String>,
    pub tag: Option<String>,
    pub covered_components: Vec<HttpMessageComponentId>,
}

Struct defining Http message signature parameters https://datatracker.ietf.org/doc/html/rfc9421#name-signature-parameters

Fields

created: Option<u64>

created unix timestamp.

expires: Option<u64>

signature expires unix timestamp.

nonce: Option<String>

nonce

alg: Option<String>

algorithm name

keyid: Option<String>

key id.

tag: Option<String>

tag

covered_components: Vec<HttpMessageComponentId>

covered component vector string: ordered message components, i.e., string of http_fields and derived_components

Implementations

impl HttpSignatureParams

pub fn try_new( covered_components: &[HttpMessageComponentId], ) -> Result<HttpSignatureParams, HttpSigError>

Create new HttpSignatureParams object for the given covered components only with `created`` current timestamp.

pub fn set_created(&mut self, created: u64) -> &mut HttpSignatureParams

Set artificial created timestamp

pub fn set_expires(&mut self, expires: u64) -> &mut HttpSignatureParams

Set expires timestamp

pub fn set_nonce(&mut self, nonce: &str) -> &mut HttpSignatureParams

Set nonce

pub fn set_alg(&mut self, alg: &AlgorithmName) -> &mut HttpSignatureParams

Set alg

pub fn set_keyid(&mut self, keyid: &str) -> &mut HttpSignatureParams

Set keyid

pub fn set_tag(&mut self, tag: &str) -> &mut HttpSignatureParams

Set tag

pub fn set_key_info( &mut self, key: &impl SigningKey, ) -> &mut HttpSignatureParams

Set keyid and alg from the signing key

pub fn set_random_nonce(&mut self) -> &mut HttpSignatureParams

Set random nonce

pub fn set_expires_with_duration( &mut self, duration_secs: Option<u64>, ) -> &mut HttpSignatureParams

Set expires timestamp from the current timestamp

pub fn is_expired(&self) -> bool

Check if the signature params is expired if exp field is present. If exp field is not present, it always returns false.

Trait Implementations

impl Clone for HttpSignatureParams

fn clone(&self) -> HttpSignatureParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpSignatureParams

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

Formats the value using the given formatter.

impl Default for HttpSignatureParams

fn default() -> HttpSignatureParams

Returns the “default value” for a type.

impl Display for HttpSignatureParams

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

Formats the value using the given formatter.

impl TryFrom<&ListEntry> for HttpSignatureParams

fn try_from(value: &ListEntry) -> Result<HttpSignatureParams, HttpSigError>

Convert from ListEntry to HttpSignatureParams

type Error = HttpSigError

The type returned in the event of a conversion error.

impl TryFrom<&str> for HttpSignatureParams

fn try_from(value: &str) -> Result<HttpSignatureParams, HttpSigError>

Convert from string to HttpSignatureParams

type Error = HttpSigError

The type returned in the event of a conversion error.