Bug#1013928: ITP: golang-github-emersion-go-msgauth -- A Go library and tools for DKIM, DMARC and Authentication-Results
Package: wnpp
Severity: wishlist
Owner: Robin Jarry <robin@jarry.cc>
* Package name : golang-github-emersion-go-msgauth
Version : 0.6.6-1
Upstream Author : Simon Ser
* URL : https://github.com/emersion/go-msgauth
* License : Expat
Programming Lang: Go
Description : A Go library and tools for DKIM, DMARC and Authentication-Results
go-msgauth
.
godocs.io (https://godocs.io/github.com/emersion/go-msgauth) builds.sr.ht
status (https://builds.sr.ht/~emersion/go-msgauth/commits/master)
.
A Go library and tools to authenticate e-mails:
.
* Create and verify DKIM signatures
(https://tools.ietf.org/html/rfc6376)
* Create and parse Authentication-Results header fields
(https://tools.ietf.org/html/rfc7601)
* Fetch DMARC (http://tools.ietf.org/html/rfc7489) records
.
DKIM godocs.io (https://godocs.io/github.com/emersion/go-msgauth/dkim)
.
Sign
.
r := strings.NewReader(mailString)
.
options := &dkim.SignOptions{
Domain: "example.org",
Selector: "brisbane",
Signer: privateKey,
}
.
var b bytes.Buffer
if err := dkim.Sign(&b, r, options); err != nil {
log.Fatal(err)
}
.
Verify
.
r := strings.NewReader(mailString)
.
verifications, err := dkim.Verify(r)
if err != nil {
log.Fatal(err)
}
.
for _, v := range verifications {
if v.Err == nil {
log.Println("Valid signature for:", v.Domain)
} else {
log.Println("Invalid signature for:", v.Domain, v.Err)
}
}
.
FAQ
.
**Why can't I verify a mail.Message directly?** A mail.Message header is
already parsed, and whitespace characters (especially continuation
lines) are removed. Thus, the signature computed from the parsed header
is not the same as the one computed from the raw header.
.
**How can I publish my public key?** You have to add a TXT record to
your DNS zone. See RFC 6376 appendix C
(https://tools.ietf.org/html/rfc6376#appendix-C). You can use the dkim-
keygen tool included in go-msgauth to generate the key and the TXT
record.
.
Authentication-Results godocs.io
(https://godocs.io/github.com/emersion/go-msgauth/authres)
.
// Format
results := []authres.Result{
&authres.SPFResult{Value: authres.ResultPass, From: "example.net"},
&authres.AuthResult{Value: authres.ResultPass, Auth:
"sender@example.com"},
}
s := authres.Format("example.com", results)
log.Println(s)
.
// Parse
identifier, results, err := authres.Parse(s)
if err != nil {
log.Fatal(err)
}
.
log.Println(identifier, results)
.
DMARC godocs.io (https://godocs.io/github.com/emersion/go-msgauth/dmarc)
.
See the GoDoc page.
.
Tools
.
A few tools are included in go-msgauth:
.
* dkim-keygen: generate a DKIM key
* dkim-milter: a mail filter to sign and verify DKIM signatures
* dkim-verify: verify a DKIM-signed email
* dmarc-lookup: lookup the DMARC policy of a domain
.
License
.
MIT
This is a new build dependency for aerc.
Reply to: