Struct Signature 

pub struct Signature {
    pub i: u32,
    pub m: u32,
    pub t: u64,
    pub d: String,
    pub s: Vec<SignatureValue>,
    pub chain: ChainBinding,
    pub n: Option<String>,
    pub flags: Vec<Flag>,
}

A parsed DKIM2-Signature header field (§10).

Produced by Signature::parse when a message is parsed into an AuthenticatedMessage, and by the Dkim2Signer signing methods in Dkim2Signed::signature. Verified signatures are exposed through ChainLink::signature.

Fields

i: u32

i=: sequence number of this signature in the chain, starting at 1 for the originator (§10.1).

m: u32

m=: highest Message-Instance revision number (m=) present when this signature was created (§10.2).

t: u64

t=: signature creation time, in seconds since the UNIX epoch (§10.4).

d: String

d=: signing domain, used to look up the public key (§10.8).

s: Vec<SignatureValue>

s=: one signature value per selector, ordered by group (§10.9).

chain: ChainBinding

mf= and rt= (the SMTP envelope of the hop), or nd= (the domain of the next signer) (§10.5 to §10.7).

n: Option<String>

n=: opaque nonce meaningful only to the signer, at most 64 printable ASCII characters (§10.3).

flags: Vec<Flag>

f=: flags reporting what the signer did or requesting behaviour from later hops (§10.10).

Implementations

impl Signature

pub fn write(&self, writer: &mut impl Writer)

Writes the complete DKIM2-Signature header field on one line, terminated by CRLF.

impl Signature

pub fn parse(header: &[u8]) -> Result<Signature>

Parses a single DKIM2-Signature header field value (without the field name).

The value is a Tag=Value list (§8): tag names are case-sensitive, unrecognized tags (including upper-case variants of known ones) are ignored, and a repeated tag name invalidates the field. An empty value is accepted only where the tag’s ABNF allows it (n= and unrecognized tags). s= entries are split into |-separated groups of ,-separated entries; entries with an algorithm this crate does not implement are kept as AlgorithmName::Unknown. mf= and rt= are base64-decoded.

Errors

Returns Dkim2Error::SignatureSyntax for a malformed tag list or value, a repeated tag or a nonce that is not up to 64 printable ASCII characters; Dkim2Error::DuplicateSelector when s= repeats a selector; Dkim2Error::TooManySelectors when s= has more than eight entries, a local limit on the public key lookups a signature can cause; Dkim2Error::SignatureTagMissing if i=, m=, t=, d= or s= is missing, or if neither nd= nor both mf= and rt= are present; and Dkim2Error::SignatureTagUnexpected if nd= appears together with mf= or rt=.

impl Signature

pub fn domain(&self) -> &str

Returns the signing domain (d=).

Trait Implementations

impl Clone for Signature

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Signature

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

Formats the value using the given formatter.

impl Default for Signature

fn default() -> Self

Returns the “default value” for a type.

impl Display for Signature

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

Formats the value using the given formatter.

impl Eq for Signature

impl HeaderWriter for Signature

fn write_header(&self, writer: &mut impl Writer)

Writes the complete header field, including the field name and the trailing CRLF, to writer.

fn to_header(&self) -> String

Returns the complete header field as a string, including the field name and the trailing CRLF. Invalid UTF-8 is replaced with U+FFFD.

impl PartialEq for Signature

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Signature