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

82 by Scott Kitterman
--- 0.700 UNRELEASED
1
This module (authres) is designed to provide support for RFC 5451/7001,
98 by Scott Kitterman
* Updated README and docstring reference to refer to RFC 7601
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.
7 by Scott Kitterman
* Add support files from 0.1 and update for 0.2: setup.py, COPYING, MANIFEST.in, README.
5
37 by Scott Kitterman
Back version down to 0.399 from 0.4 since docs still need work.
6
It also supports Authentication Results extensions:
7
8
RFC 5617 DKIM/ADSP
9
RFC 6008 DKIM signature identification (header.b)
10
RFC 6212 Vouch By Reference (VBR)
95 by Scott Kitterman
README updates.
11
RFC 6577 Sender Policy Framework (SPF)
82 by Scott Kitterman
--- 0.700 UNRELEASED
12
RFC 7281 Authentication-Results Registration for S/MIME
95 by Scott Kitterman
README updates.
13
RFC 7293, The Require-Recipient-Valid-Since Header Field
14
    and SMTP Service Extension, header field types
109 by Scott Kitterman
Update documentation in README
15
RFC 7489 Domain-based Message Authentication, Reporting, and Conformance
16
    (DMARC)
17
draft-ietf-dmarc-arc-protocol-08 (experimental)
111 by Scott Kitterman
+ Added DKIM 'a' property so signature algorithm can be reported as proposed
18
draft-ietf-dmarc-rfc7601bis (experimental)
19
20
Support marked experimental may change or be removed without consideration for
21
backward compatibility.
98 by Scott Kitterman
* Updated README and docstring reference to refer to RFC 7601
22
23
RFC 7410, A Property Types Registry for the Authentication-Results Header
24
Field, added the possibility for new ptypes to be created, but so far none
25
have been registered.
26
27
import authres only provides the RFC 5451/7001/7601 types. Individual
28
additions can be imported by name, import authres.dkim_b, authres.dkim_adsp,
29
authres.vbr, authres.dmarc, and authres.smime. To use all the features, the
30
feature context authres.all_features() is provided.
37 by Scott Kitterman
Back version down to 0.399 from 0.4 since docs still need work.
31
7 by Scott Kitterman
* Add support files from 0.1 and update for 0.2: setup.py, COPYING, MANIFEST.in, README.
32
Header folding and unfolding is the responsibility of the calling application.
33
98 by Scott Kitterman
* Updated README and docstring reference to refer to RFC 7601
34
Between docstrings and RFC 5451/7001/7601 the API should be reasonably clear,
35
but the docstrings are still a work in progress.  Additional examples are
36
available in the file authres/tests.
7 by Scott Kitterman
* Add support files from 0.1 and update for 0.2: setup.py, COPYING, MANIFEST.in, README.
37
87 by Scott Kitterman
Add README info on SPF related results.
38
SPF authentication results can relate to either the HELO identity or the Mail
39
From.  When creating header fields with SPF results, only set the identity
40
used to evaluate the SPF result that's reported.  You can use multiple objects
41
to report both in a single header field.  See the example in the tests file.
42
65 by Scott Kitterman
Update authres/__init__.py and README for new class.
43
This package requires python2.6 or later (including python3). It has been
98 by Scott Kitterman
* Updated README and docstring reference to refer to RFC 7601
44
tested with python2.6, python2.7, python3.2, python3.3, python3.4, and
45
python3.5.
7 by Scott Kitterman
* Add support files from 0.1 and update for 0.2: setup.py, COPYING, MANIFEST.in, README.
46
83 by Scott Kitterman
* Updated README and docstrings to refer to RFC 7001 in addition to RFC 5451
47
To execute doctests, run the module as main: python -m authres
53 by Scott Kitterman
! Moved doctest initiation from __init__.py to __main__.py so tests only run
48
7 by Scott Kitterman
* Add support files from 0.1 and update for 0.2: setup.py, COPYING, MANIFEST.in, README.
49
This is completely untested on Windows, but in theory should work.