Struct picky::http::http_signature::HttpSignature

pub struct HttpSignature {
    pub key_id: String,
    pub headers: Vec<Header>,
    pub created: Option<u64>,
    pub expires: Option<u64>,
    pub signature: String,
    pub algorithm: Option<HttpSigAlgorithm>,
    // some fields omitted
}

Contains signature parameters.

Fields

key_id: String

An opaque string that the server can use to look up the component they need to validate the signature.

headers: Vec<Header>

In original string format, headers should be a lowercased, quoted list of HTTP header fields, separated by a single space character.

For instance : (request-target) (created) host date cache-control x-emptyheader x-example.

created: Option<u64>

The created field expresses when the signature was created. The value MUST be a Unix timestamp integer value. A signature with a created timestamp value that is in the future MUST NOT be processed.

expires: Option<u64>

The expires field expresses when the signature ceases to be valid. The value MUST be a Unix timestamp integer value. A signature with an expires timestamp value that is in the past MUST NOT be processed.

signature: String

Base 64 encoded digital signature, as described in RFC4648, Section 4. The client uses the algorithm and headers signature parameters to form a canonicalized signing string. This signing string is then signed with the key associated with key_id and the algorithm corresponding to algorithm. The signature parameter is then set to the base 64 encoding of the signature.

algorithm: Option<HttpSigAlgorithm>

Used to specify the signature string construction mechanism. Implementers SHOULD derive the digital signature algorithm used by an implementation from the key metadata identified by the keyId rather than from this field. If algorithm is provided and differs from the key metadata identified by the keyId, for example rsa-sha256 but an EdDSA key is identified via keyId, then an implementation MUST produce an error. Note: as of draft 12 there is only one signature string construction mechanism. As such this parameter is only used to hint the digital signature algorithm.

Implementations

impl HttpSignature

pub fn verifier(&self) -> HttpSignatureVerifier<'_>

Trait Implementations

impl Clone for HttpSignature

fn clone(&self) -> HttpSignature

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HttpSignature

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

Formats the value using the given formatter.

impl Eq for HttpSignature

impl FromStr for HttpSignature

type Err = HttpSignatureError

The associated error which can be returned from parsing.

fn from_str(http_authorization_header: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for HttpSignature

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<HttpSignature> for HttpSignature

fn eq(&self, other: &HttpSignature) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &HttpSignature) -> bool

This method tests for !=.

impl StructuralEq for HttpSignature

impl StructuralPartialEq for HttpSignature

impl ToString for HttpSignature

fn to_string(&self) -> String

Converts the given value to a String.