1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
|
package authres
import (
"errors"
"strings"
"unicode"
)
// ResultValue is an authentication result value, as defined in RFC 5451 section
// 6.3.
type ResultValue string
const (
ResultNone ResultValue = "none"
ResultPass = "pass"
ResultFail = "fail"
ResultPolicy = "policy"
ResultNeutral = "neutral"
ResultTempError = "temperror"
ResultPermError = "permerror"
ResultHardFail = "hardfail"
ResultSoftFail = "softfail"
)
// Result is an authentication result.
type Result interface {
parse(value ResultValue, params map[string]string)
format() (value ResultValue, params map[string]string)
}
type AuthResult struct {
Value ResultValue
Reason string
Auth string
}
func (r *AuthResult) parse(value ResultValue, params map[string]string) {
r.Value = value
r.Reason = params["reason"]
r.Auth = params["smtp.auth"]
}
func (r *AuthResult) format() (ResultValue, map[string]string) {
return r.Value, map[string]string{"smtp.auth": r.Auth}
}
type DKIMResult struct {
Value ResultValue
Reason string
Domain string
Identifier string
}
func (r *DKIMResult) parse(value ResultValue, params map[string]string) {
r.Value = value
r.Reason = params["reason"]
r.Domain = params["header.d"]
r.Identifier = params["header.i"]
}
func (r *DKIMResult) format() (ResultValue, map[string]string) {
return r.Value, map[string]string{
"reason": r.Reason,
"header.d": r.Domain,
"header.i": r.Identifier,
}
}
type DomainKeysResult struct {
Value ResultValue
Reason string
Domain string
From string
Sender string
}
func (r *DomainKeysResult) parse(value ResultValue, params map[string]string) {
r.Value = value
r.Reason = params["reason"]
r.Domain = params["header.d"]
r.From = params["header.from"]
r.Sender = params["header.sender"]
}
func (r *DomainKeysResult) format() (ResultValue, map[string]string) {
return r.Value, map[string]string{
"reason": r.Reason,
"header.d": r.Domain,
"header.from": r.From,
"header.sender": r.Sender,
}
}
type IPRevResult struct {
Value ResultValue
Reason string
IP string
}
func (r *IPRevResult) parse(value ResultValue, params map[string]string) {
r.Value = value
r.Reason = params["reason"]
r.IP = params["policy.iprev"]
}
func (r *IPRevResult) format() (ResultValue, map[string]string) {
return r.Value, map[string]string{
"reason": r.Reason,
"policy.iprev": r.IP,
}
}
type SenderIDResult struct {
Value ResultValue
Reason string
HeaderKey string
HeaderValue string
}
func (r *SenderIDResult) parse(value ResultValue, params map[string]string) {
r.Value = value
r.Reason = params["reason"]
for k, v := range params {
if strings.HasPrefix(k, "header.") {
r.HeaderKey = strings.TrimPrefix(k, "header.")
r.HeaderValue = v
break
}
}
}
func (r *SenderIDResult) format() (value ResultValue, params map[string]string) {
return r.Value, map[string]string{
"reason": r.Reason,
"header." + strings.ToLower(r.HeaderKey): r.HeaderValue,
}
}
type SPFResult struct {
Value ResultValue
Reason string
From string
Helo string
}
func (r *SPFResult) parse(value ResultValue, params map[string]string) {
r.Value = value
r.Reason = params["reason"]
r.From = params["smtp.mailfrom"]
r.Helo = params["smtp.helo"]
}
func (r *SPFResult) format() (ResultValue, map[string]string) {
return r.Value, map[string]string{
"reason": r.Reason,
"smtp.mailfrom": r.From,
"smtp.helo": r.Helo,
}
}
type DMARCResult struct {
Value ResultValue
Reason string
From string
}
func (r *DMARCResult) parse(value ResultValue, params map[string]string) {
r.Value = value
r.Reason = params["reason"]
r.From = params["header.from"]
}
func (r *DMARCResult) format() (ResultValue, map[string]string) {
return r.Value, map[string]string{
"reason": r.Reason,
"header.from": r.From,
}
}
type GenericResult struct {
Method string
Value ResultValue
Params map[string]string
}
func (r *GenericResult) parse(value ResultValue, params map[string]string) {
r.Value = value
r.Params = params
}
func (r *GenericResult) format() (ResultValue, map[string]string) {
return r.Value, r.Params
}
type newResultFunc func() Result
var results = map[string]newResultFunc{
"auth": func() Result {
return new(AuthResult)
},
"dkim": func() Result {
return new(DKIMResult)
},
"domainkeys": func() Result {
return new(DomainKeysResult)
},
"iprev": func() Result {
return new(IPRevResult)
},
"sender-id": func() Result {
return new(SenderIDResult)
},
"spf": func() Result {
return new(SPFResult)
},
"dmarc": func() Result {
return new(DMARCResult)
},
}
// Parse parses the provided Authentication-Results header field. It returns the
// authentication service identifier and authentication results.
func Parse(v string) (identifier string, results []Result, err error) {
parts := strings.Split(v, ";")
identifier = strings.TrimSpace(parts[0])
i := strings.IndexFunc(identifier, unicode.IsSpace)
if i > 0 {
version := strings.TrimSpace(identifier[i:])
if version != "1" {
return "", nil, errors.New("msgauth: unsupported version")
}
identifier = identifier[:i]
}
for i := 1; i < len(parts); i++ {
s := strings.TrimSpace(parts[i])
if s == "" {
continue
}
result, err := parseResult(s)
if err != nil {
return identifier, results, err
}
if result != nil {
results = append(results, result)
}
}
return
}
func parseResult(s string) (Result, error) {
// TODO: ignore header comments in parenthesis
parts := strings.Fields(s)
if len(parts) == 0 || parts[0] == "none" {
return nil, nil
}
k, v, err := parseParam(parts[0])
if err != nil {
return nil, err
}
method, value := k, ResultValue(strings.ToLower(v))
params := make(map[string]string)
for i := 1; i < len(parts); i++ {
k, v, err := parseParam(parts[i])
if err != nil {
continue
}
params[k] = v
}
newResult, ok := results[method]
var r Result
if ok {
r = newResult()
} else {
r = &GenericResult{
Method: method,
Value: value,
Params: params,
}
}
r.parse(value, params)
return r, nil
}
func parseParam(s string) (k string, v string, err error) {
kv := strings.SplitN(s, "=", 2)
if len(kv) != 2 {
return "", "", errors.New("msgauth: malformed authentication method and value")
}
return strings.ToLower(strings.TrimSpace(kv[0])), strings.TrimSpace(kv[1]), nil
}
|