mirror of
https://github.com/ergochat/ergo.git
synced 2024-11-25 05:19:25 +01:00
57 lines
1.3 KiB
Markdown
57 lines
1.3 KiB
Markdown
# go-dkim
|
|
DKIM package for Golang
|
|
|
|
[](https://godoc.org/github.com/toorop/go-dkim)
|
|
|
|
## Getting started
|
|
|
|
### Install
|
|
```
|
|
go get github.com/toorop/go-dkim
|
|
```
|
|
Warning: you need to use Go 1.4.2-master or 1.4.3 (when it will be available)
|
|
see https://github.com/golang/go/issues/10482 fro more info.
|
|
|
|
### Sign email
|
|
|
|
```go
|
|
import (
|
|
dkim "github.com/toorop/go-dkim"
|
|
)
|
|
|
|
func main(){
|
|
// email is the email to sign (byte slice)
|
|
// privateKey the private key (pem encoded, byte slice )
|
|
options := dkim.NewSigOptions()
|
|
options.PrivateKey = privateKey
|
|
options.Domain = "mydomain.tld"
|
|
options.Selector = "myselector"
|
|
options.SignatureExpireIn = 3600
|
|
options.BodyLength = 50
|
|
options.Headers = []string{"from", "date", "mime-version", "received", "received"}
|
|
options.AddSignatureTimestamp = true
|
|
options.Canonicalization = "relaxed/relaxed"
|
|
err := dkim.Sign(&email, options)
|
|
// handle err..
|
|
|
|
// And... that's it, 'email' is signed ! Amazing© !!!
|
|
}
|
|
```
|
|
|
|
### Verify
|
|
```go
|
|
import (
|
|
dkim "github.com/toorop/go-dkim"
|
|
)
|
|
|
|
func main(){
|
|
// email is the email to verify (byte slice)
|
|
status, err := Verify(&email)
|
|
// handle status, err (see godoc for status)
|
|
}
|
|
```
|
|
|
|
## Todo
|
|
|
|
- [ ] handle z tag (copied header fields used for diagnostic use)
|