Skip to main content

Authenticate incoming emails with SPF, DKIM, DMARC, and ARC.

Project description

emailsec

builds.sr.ht status PyPI version

emailsec authenticates incoming emails with SPF, DKIM, DMARC, and ARC.

This project is still in early development.

Authentication Protocols

  • SPF (Sender Policy Framework) - RFC 7208
    Verifies the sending IP address is authorized to send email for a domain

  • DKIM (DomainKeys Identified Mail) - RFC 6376
    Validates email authenticity using cryptographic signatures

  • DMARC (Domain-based Message Authentication, Reporting, and Conformance) - RFC 7489
    Combines SPF and DKIM results with policy enforcement

  • ARC (Authenticated Received Chain) - RFC 8617
    Preserves authentication results across email forwarding

Message Authentication

>>> import asyncio
>>> from emailsec import authenticate_message, SMTPContext
>>>
>>> smtp_ctx = SMTPContext(
...     client_ip="203.0.113.42",
...     mail_from="alice@example.com",
... )
>>> raw_email = b"""Received: from mail.example.com (mail.example.com [203.0.113.42])
...     by mx.company.com (Postfix) with ESMTPS id 4A8B2C0FFEE
...     for <recipient@company.com>; Mon, 27 Jan 2025 10:30:45 +0000 (UTC)
... DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=example.com;
...     s=selector1; t=1756656697;
...     h=from:to:subject:date:message-id;
...     bh=eKhvPb2btxd7/zv/sYlR5Z4ws09I2c1WJzPa=;
...     b=C70Bf8rWjJZJt/RcOnoFJquifA1XNB/yiKVP==
... Received-SPF: pass (mx.company.com: domain of example.com designates
...     203.0.113.42 as permitted sender) client-ip=203.0.113.42
... From: Alice <alice@example.com>
... To: Bob <bob@company.com>
... Subject: Hello
... Date: Mon, 27 Jan 2025 10:30:45 +0000
... Message-ID: <20250127103045.4A8B2C0FFEE@mail.example.com>
... MIME-Version: 1.0
... Content-Type: text/plain; charset=UTF-8
...
... Hi Bob,
...
... Cheers,
... Alice
... """
>>>
>>> asyncio.run(authenticate_message(smtp_ctx, raw_email))
AuthenticationResult(
    delivery_action=<DeliveryAction.ACCEPT: 'accept'>,
    spf_result=SPFResult(
        result=<SPFResult.PASS: 'pass'>,
        domain="example.com",
        sender_ip="203.0.113.42",
        exp=""
    ),
    dkim_result=DKIMResult(
        result=<DKIMResult.SUCCESS: 'SUCCESS'>,
        domain="example.com",
        selector="selector1",
        signature={
            'v': '1',
            'a': 'rsa-sha256',
            'c': 'relaxed/relaxed',
            'd': 'example.com',
            'h': 'from:to:subject:date:message-id',
            's': 'selector1',
            't': 1756656697,
            'bh': 'eKhvPb2btxd7/zv/sYlR5Z4ws09I2c1WJzPa...',
            'b': 'C70Bf8rWjJZJt/RcOnoFJquifA1XNB/yiKVP...'
        }
    ),
    dmarc_result=DMARCResult(
        result="pass",
        policy=policy=<DMARCPolicy.QUARANTINE: 'quarantine'>,
        spf_aligned=True,
        dkim_aligned=True,
        arc_override_applied=False
    ),
    arc_result=ARCResult(
        result=<ARCChainStatus.NONE: 'none'>,
        reason="No ARC Sets",
        signer=None,
        aar_header=None
    )
)

Sender Policy Framework

RFC 7208-compliant parser and checker.

Parser

>>> from emailsec.spf.parser import parse_record
>>> parse_record("v=spf1 +a mx/30 mx:example.org/30 -all")
[A(qualifier=<Qualifier.PASS: '+'>, domain_spec=None, cidr=None),
 MX(qualifier=<Qualifier.PASS: '+'>, domain_spec=None, cidr='/30'),
 MX(qualifier=<Qualifier.PASS: '+'>, domain_spec='example.org', cidr='/30'),
 All(qualifier=<Qualifier.FAIL: '-'>)]

Checker

>>> import asyncio
>>> from emailsec.spf import check_spf
>>> asyncio.run(check_spf(sender_ip="192.0.2.10", sender="hello@example.com"))
SPFCheck(result=<SPFResult.PASS: 'pass'>, domain='example.com', explanation='')

Documentation

Project documentation is available at https://emailsec.hexa.ninja/.

Contribution

Contributions are welcome but please open an issue to start a discussion before starting something consequent.

License

Copyright (c) 2025 Thomas Sileo and contributors. Released under the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

emailsec-0.3.0.tar.gz (632.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

emailsec-0.3.0-py3-none-any.whl (25.5 kB view details)

Uploaded Python 3

File details

Details for the file emailsec-0.3.0.tar.gz.

File metadata

  • Download URL: emailsec-0.3.0.tar.gz
  • Upload date:
  • Size: 632.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.3

File hashes

Hashes for emailsec-0.3.0.tar.gz
Algorithm Hash digest
SHA256 fb105dea7bc5d8666fd63823932c980f6ae94ea11bb9aeaf2ed855de30b768a2
MD5 99d5cb82f822e2f822799ea56aba050e
BLAKE2b-256 d6bd32f27b47b8743cd53faf6e25fd8808988669c14ae021b7d905942dbd1cc6

See more details on using hashes here.

File details

Details for the file emailsec-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: emailsec-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 25.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.3

File hashes

Hashes for emailsec-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cf14677a01fdaa63d829f47b866148f34c8919485ee8ac365fd73b5a8ec64fc4
MD5 be5661ac9be25169331500316b59da1c
BLAKE2b-256 2ef001c241acd4cb78789b24a1a8154add9769cabaa7a104d9cde631f843ddf5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page