Skip to main content

Crate use_dkim

Crate use_dkim 

Source
Expand description

§use-dkim

DKIM signature metadata primitives for RustUse.

§Experimental

use-dkim is experimental while use-email remains below 0.3.0.

§Example

use use_dkim::{DkimAlgorithm, DkimBodyHash, DkimSelector, DkimSignature, DkimSignedHeaders};

let signature = DkimSignature::new(DkimSelector::new("mail")?, "example.com")?
    .with_algorithm(DkimAlgorithm::RsaSha256)
    .with_signed_headers(DkimSignedHeaders::from_names(["from", "subject"])? )
    .with_body_hash(DkimBodyHash::new("abc123")?);

assert!(signature.to_string().contains("a=rsa-sha256"));

§Scope

  • DKIM selectors, domains, header tags, algorithms, canonicalization labels, signed headers, body hash, and signature metadata.

§Non-goals

  • Cryptographic signing.
  • Cryptographic verification.
  • DNS key lookup.

§License

Licensed under either Apache-2.0 or MIT.

Structs§

DkimBodyHash
DKIM body hash metadata.
DkimDomain
DKIM signing domain metadata.
DkimHeaderTag
DKIM signed header tag metadata.
DkimSelector
DKIM selector metadata.
DkimSignature
DKIM signature metadata. This type does not sign or verify data.
DkimSignedHeaders
Ordered list of DKIM signed header names.

Enums§

DkimAlgorithm
DKIM signature algorithm label.
DkimCanonicalization
DKIM canonicalization mode.
DkimError
Error returned when DKIM metadata is invalid.