~ar-python-hackers/authentication-results-python/trunk

« back to all changes in this revision

Viewing changes to README

  • Committer: Scott Kitterman
  • Date: 2016-12-11 05:52:42 UTC
  • Revision ID: scott@kitterman.com-20161211055242-molq08jlvoa07tj0
  + Add support for RFC 7601 use of SMTP auth with the mailfrom property

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
This module (authres) is designed to provide support for RFC 5451/7001,
2
 
originally http://tools.ietf.org/html/rfc5451 (and then
3
 
http://tools.ietf.org/html/rfc7001) and currently
4
 
http://tools.ietf.org/html/rfc7601, processing in Python.
 
2
originally http://tools.ietf.org/html/rfc5451 and currently
 
3
http://tools.ietf.org/html/rfc7001, processing in Python.
5
4
 
6
5
It also supports Authentication Results extensions:
7
6
 
9
8
RFC 6008 DKIM signature identification (header.b)
10
9
RFC 6212 Vouch By Reference (VBR)
11
10
RFC 6577 Sender Policy Framework (SPF)
 
11
draft-kucherawy-dmarc-base DMARC
12
12
RFC 7281 Authentication-Results Registration for S/MIME
13
13
RFC 7293, The Require-Recipient-Valid-Since Header Field
14
14
    and SMTP Service Extension, header field types
15
 
RFC 7489 Domain-based Message Authentication, Reporting, and Conformance
16
 
    (DMARC)
17
 
draft-ietf-dmarc-arc-protocol-08 (experimental)
18
 
 
19
 
RFC 7410, A Property Types Registry for the Authentication-Results Header
20
 
Field, added the possibility for new ptypes to be created, but so far none
21
 
have been registered.
22
 
 
23
 
import authres only provides the RFC 5451/7001/7601 types. Individual
24
 
additions can be imported by name, import authres.dkim_b, authres.dkim_adsp,
25
 
authres.vbr, authres.dmarc, and authres.smime. To use all the features, the
26
 
feature context authres.all_features() is provided.
 
15
 
 
16
import authres only provides the RFC 5451/7001 types. Individual additions can be
 
17
imported by name, import authres.dkim_b, authres.dkim_adsp, authres.vbr,
 
18
authres.dmarc, and authres.smime. To use all the features, the feature context
 
19
authres.all_features() is provided.
27
20
 
28
21
Header folding and unfolding is the responsibility of the calling application.
29
22
 
30
 
Between docstrings and RFC 5451/7001/7601 the API should be reasonably clear,
31
 
but the docstrings are still a work in progress.  Additional examples are
32
 
available in the file authres/tests.
 
23
Between docstrings and RFC 5451/7001 the API should be reasonably clear, but the
 
24
docstrings are still a work in progress.  Additional examples are available in
 
25
the file authres/tests.  The API is completely reworked from version 0.1.
33
26
 
34
27
SPF authentication results can relate to either the HELO identity or the Mail
35
28
From.  When creating header fields with SPF results, only set the identity
37
30
to report both in a single header field.  See the example in the tests file.
38
31
 
39
32
This package requires python2.6 or later (including python3). It has been
40
 
tested with python2.6, python2.7, python3.2, python3.3, python3.4, and
41
 
python3.5.
 
33
tested with python2.6, python2.7, python3.2, python3.3, and python3.4.
42
34
 
43
35
To execute doctests, run the module as main: python -m authres
44
36