https://github.com/cloudflare/dkim

DKIM (RFC6376) implementation
https://github.com/cloudflare/dkim

Last synced: about 2 months ago
JSON representation

DKIM (RFC6376) implementation

• Host: GitHub
• URL: https://github.com/cloudflare/dkim
• Owner: cloudflare
• License: mit
• Created: 2022-01-18T15:26:17.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-06T16:52:26.000Z (9 months ago)
• Last Synced: 2024-07-12T17:15:04.932Z (2 months ago)
• Language: Rust
• Homepage:
• Size: 117 KB
• Stars: 49
• Watchers: 12
• Forks: 12
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# cfdkim

> DKIM ([RFC6376]) implementation

## Features

### Verifying email signatures

Example:

```rust

let res: DKIMResult = cfdkim::verify_email(&logger, &from_domain, &parsed_email).await?;

if let Some(err) = &res.error() {

  error!(logger, "dkim verify fail: {}", err);

}

println!("dkim={}", res.with_detail());

```

The `verify_email` arguments are the following:

- `logger`: [slog]::Logger

- `from_domain`: &str ([RFC5322].From's domain)

- `parsed_email`: [mailparse]::ParsedMail

### Signing an email

Example:

```rust

let private_key =

    rsa::RsaPrivateKey::read_pkcs1_pem_file(Path::new("./test/keys/2022.private"))?;

let signer = SignerBuilder::new()

    .with_signed_headers(&["From", "Subject"])?

    .with_private_key(private_key)

    .with_selector("2020")

    .with_logger(&logger)

    .with_signing_domain("example.com")

    .build()?;

let signature = signer.sign(&email)?;

println!("{}", signature); // DKIM-Signature: ...

```

See the SignerBuilder object documentation for more information.

## Generate a test DKIM key

Using [OpenDKIM]:

```

opendkim-genkey \

    --testmode \

    --domain=example.com \

    --selector=2022 \

    --nosubdomains

```

[RFC5322]: https://datatracker.ietf.org/doc/html/rfc5322

[RFC6376]: https://datatracker.ietf.org/doc/html/rfc6376

[slog]: https://crates.io/crates/slog

[mailparse]: https://crates.io/crates/mailparse

[OpenDKIM]: http://www.opendkim.org/