1// Package dkim (DomainKeys Identified Mail signatures, RFC 6376) signs and
2// verifies DKIM signatures.
4// Signatures are added to email messages in DKIM-Signature headers. By signing a
5// message, a domain takes responsibility for the message. A message can have
6// signatures for multiple domains, and the domain does not necessarily have to
7// match a domain in a From header. Receiving mail servers can build a spaminess
8// reputation based on domains that signed the message, along with other
18 cryptorand "crypto/rand"
28 "github.com/mjl-/mox/dns"
29 "github.com/mjl-/mox/mlog"
30 "github.com/mjl-/mox/moxio"
31 "github.com/mjl-/mox/publicsuffix"
32 "github.com/mjl-/mox/smtp"
33 "github.com/mjl-/mox/stub"
36// If set, signatures for top-level domain "localhost" are accepted.
40 MetricSign stub.CounterVec = stub.CounterVecIgnore{}
41 MetricVerify stub.HistogramVec = stub.HistogramVecIgnore{}
44var timeNow = time.Now // Replaced during tests.
46// Status is the result of verifying a DKIM-Signature as described by RFC 8601,
47// "Message Header Field for Indicating Message Authentication Status".
53 StatusNone Status = "none" // Message was not signed.
54 StatusPass Status = "pass" // Message was signed and signature was verified.
55 StatusFail Status = "fail" // Message was signed, but signature was invalid.
56 StatusPolicy Status = "policy" // Message was signed, but signature is not accepted by policy.
57 StatusNeutral Status = "neutral" // Message was signed, but the signature contains an error or could not be processed. This status is also used for errors not covered by other statuses.
58 StatusTemperror Status = "temperror" // Message could not be verified. E.g. because of DNS resolve error. A later attempt may succeed. A missing DNS record is treated as temporary error, a new key may not have propagated through DNS shortly after it was taken into use.
59 StatusPermerror Status = "permerror" // Message cannot be verified. E.g. when a required header field is absent or for invalid (combination of) parameters. Typically set if a DNS record does not allow the signature, e.g. due to algorithm mismatch or expiry.
64 ErrNoRecord = errors.New("dkim: no dkim dns record for selector and domain")
65 ErrMultipleRecords = errors.New("dkim: multiple dkim dns record for selector and domain")
66 ErrDNS = errors.New("dkim: lookup of dkim dns record")
67 ErrSyntax = errors.New("dkim: syntax error in dkim dns record")
70// Signature verification errors.
72 ErrSigAlgMismatch = errors.New("dkim: signature algorithm mismatch with dns record")
73 ErrHashAlgNotAllowed = errors.New("dkim: hash algorithm not allowed by dns record")
74 ErrKeyNotForEmail = errors.New("dkim: dns record not allowed for use with email")
75 ErrDomainIdentityMismatch = errors.New("dkim: dns record disallows mismatch of domain (d=) and identity (i=)")
76 ErrSigExpired = errors.New("dkim: signature has expired")
77 ErrHashAlgorithmUnknown = errors.New("dkim: unknown hash algorithm")
78 ErrBodyhashMismatch = errors.New("dkim: body hash does not match")
79 ErrSigVerify = errors.New("dkim: signature verification failed")
80 ErrSigAlgorithmUnknown = errors.New("dkim: unknown signature algorithm")
81 ErrCanonicalizationUnknown = errors.New("dkim: unknown canonicalization")
82 ErrHeaderMalformed = errors.New("dkim: mail message header is malformed")
83 ErrFrom = errors.New("dkim: bad from headers")
84 ErrQueryMethod = errors.New("dkim: no recognized query method")
85 ErrKeyRevoked = errors.New("dkim: key has been revoked")
86 ErrTLD = errors.New("dkim: signed domain is top-level domain, above organizational domain")
87 ErrPolicy = errors.New("dkim: signature rejected by policy")
88 ErrWeakKey = errors.New("dkim: key is too weak, need at least 1024 bits for rsa")
91// Result is the conclusion of verifying one DKIM-Signature header. An email can
92// have multiple signatures, each with different parameters.
94// To decide what to do with a message, both the signature parameters and the DNS
95// TXT record have to be consulted.
98 Sig *Sig // Parsed form of DKIM-Signature header. Can be nil for invalid DKIM-Signature header.
99 Record *Record // Parsed form of DKIM DNS record for selector and domain in Sig. Optional.
100 RecordAuthentic bool // Whether DKIM DNS record was DNSSEC-protected. Only valid if Sig is non-nil.
101 Err error // If Status is not StatusPass, this error holds the details and can be checked using errors.Is.
104// todo: use some io.Writer to hash the body and the header.
106// Selector holds selectors and key material to generate DKIM signatures.
107type Selector struct {
108 Hash string // "sha256" or the older "sha1".
109 HeaderRelaxed bool // If the header is canonicalized in relaxed instead of simple mode.
110 BodyRelaxed bool // If the body is canonicalized in relaxed instead of simple mode.
111 Headers []string // Headers to include in signature.
113 // Whether to "oversign" headers, ensuring additional/new values of existing
114 // headers cannot be added.
117 // If > 0, period a signature is valid after signing, as duration, e.g. 72h. The
118 // period should be enough for delivery at the final destination, potentially with
119 // several hops/relays. In the order of days at least.
120 Expiration time.Duration
122 PrivateKey crypto.Signer // Either an *rsa.PrivateKey or ed25519.PrivateKey.
123 Domain dns.Domain // Of selector only, not FQDN.
126// Sign returns line(s) with DKIM-Signature headers, generated according to the configuration.
127func Sign(ctx context.Context, elog *slog.Logger, localpart smtp.Localpart, domain dns.Domain, selectors []Selector, smtputf8 bool, msg io.ReaderAt) (headers string, rerr error) {
128 log := mlog.New("dkim", elog)
131 log.Debugx("dkim sign result", rerr,
132 slog.Any("localpart", localpart),
133 slog.Any("domain", domain),
134 slog.Bool("smtputf8", smtputf8),
135 slog.Duration("duration", time.Since(start)))
138 hdrs, bodyOffset, err := parseHeaders(bufio.NewReader(&moxio.AtReader{R: msg}))
140 return "", fmt.Errorf("%w: %s", ErrHeaderMalformed, err)
143 for _, h := range hdrs {
144 if h.lkey == "from" {
149 return "", fmt.Errorf("%w: message has %d from headers, need exactly 1", ErrFrom, nfrom)
152 type hashKey struct {
153 simple bool // Canonicalization.
154 hash string // lower-case hash.
157 var bodyHashes = map[hashKey][]byte{}
159 for _, sel := range selectors {
160 sig := newSigWithDefaults()
162 switch sel.PrivateKey.(type) {
163 case *rsa.PrivateKey:
164 sig.AlgorithmSign = "rsa"
165 MetricSign.IncLabels("rsa")
166 case ed25519.PrivateKey:
167 sig.AlgorithmSign = "ed25519"
168 MetricSign.IncLabels("ed25519")
170 return "", fmt.Errorf("internal error, unknown pivate key %T", sel.PrivateKey)
172 sig.AlgorithmHash = sel.Hash
174 sig.Selector = sel.Domain
175 sig.Identity = &Identity{&localpart, domain}
176 sig.SignedHeaders = append([]string{}, sel.Headers...)
179 // Each time a header name is added to the signature, the next unused value is
180 // signed (in reverse order as they occur in the message). So we can add each
181 // header name as often as it occurs. But now we'll add the header names one
182 // additional time, preventing someone from adding one more header later on.
183 counts := map[string]int{}
184 for _, h := range hdrs {
187 for _, h := range sel.Headers {
188 for j := counts[strings.ToLower(h)]; j > 0; j-- {
189 sig.SignedHeaders = append(sig.SignedHeaders, h)
193 sig.SignTime = timeNow().Unix()
194 if sel.Expiration > 0 {
195 sig.ExpireTime = sig.SignTime + int64(sel.Expiration/time.Second)
198 sig.Canonicalization = "simple"
199 if sel.HeaderRelaxed {
200 sig.Canonicalization = "relaxed"
202 sig.Canonicalization += "/"
204 sig.Canonicalization += "relaxed"
206 sig.Canonicalization += "simple"
209 h, hok := algHash(sig.AlgorithmHash)
211 return "", fmt.Errorf("unrecognized hash algorithm %q", sig.AlgorithmHash)
214 // We must now first calculate the hash over the body. Then include that hash in a
215 // new DKIM-Signature header. Then hash that and the signed headers into a data
216 // hash. Then that hash is finally signed and the signature included in the new
217 // DKIM-Signature header.
220 hk := hashKey{!sel.BodyRelaxed, strings.ToLower(sig.AlgorithmHash)}
221 if bh, ok := bodyHashes[hk]; ok {
224 br := bufio.NewReader(&moxio.AtReader{R: msg, Offset: int64(bodyOffset)})
225 bh, err = bodyHash(h.New(), !sel.BodyRelaxed, br)
233 sigh, err := sig.Header()
237 verifySig := []byte(strings.TrimSuffix(sigh, "\r\n"))
239 dh, err := dataHash(h.New(), !sel.HeaderRelaxed, sig, hdrs, verifySig)
244 switch key := sel.PrivateKey.(type) {
245 case *rsa.PrivateKey:
246 sig.Signature, err = key.Sign(cryptorand.Reader, dh, h)
248 return "", fmt.Errorf("signing data: %v", err)
250 case ed25519.PrivateKey:
251 // crypto.Hash(0) indicates data isn't prehashed (ed25519ph). We are using
253 sig.Signature, err = key.Sign(cryptorand.Reader, dh, crypto.Hash(0))
255 return "", fmt.Errorf("signing data: %v", err)
258 return "", fmt.Errorf("unsupported private key type: %s", err)
261 sigh, err = sig.Header()
271// Lookup looks up the DKIM TXT record and parses it.
273// A requested record is <selector>._domainkey.<domain>. Exactly one valid DKIM
274// record should be present.
276// authentic indicates if DNS results were DNSSEC-verified.
277func Lookup(ctx context.Context, elog *slog.Logger, resolver dns.Resolver, selector, domain dns.Domain) (rstatus Status, rrecord *Record, rtxt string, authentic bool, rerr error) {
278 log := mlog.New("dkim", elog)
281 log.Debugx("dkim lookup result", rerr,
282 slog.Any("selector", selector),
283 slog.Any("domain", domain),
284 slog.Any("status", rstatus),
285 slog.Any("record", rrecord),
286 slog.Duration("duration", time.Since(start)))
289 name := selector.ASCII + "._domainkey." + domain.ASCII + "."
290 records, lookupResult, err := dns.WithPackage(resolver, "dkim").LookupTXT(ctx, name)
291 if dns.IsNotFound(err) {
293 // We must return StatusPermerror. We may want to return StatusTemperror because in
294 // practice someone will start using a new key before DNS changes have propagated.
295 return StatusPermerror, nil, "", lookupResult.Authentic, fmt.Errorf("%w: dns name %q", ErrNoRecord, name)
296 } else if err != nil {
297 return StatusTemperror, nil, "", lookupResult.Authentic, fmt.Errorf("%w: dns name %q: %s", ErrDNS, name, err)
301 var status = StatusTemperror
305 for _, s := range records {
307 // but isn't actually valid, results in a StatusPermFail. But a record that isn't
308 // claiming to be DKIM1 is ignored.
311 r, isdkim, err = ParseRecord(s)
312 if err != nil && isdkim {
313 return StatusPermerror, nil, txt, lookupResult.Authentic, fmt.Errorf("%w: %s", ErrSyntax, err)
314 } else if err != nil {
315 // Hopefully the remote MTA admin discovers the configuration error and fix it for
316 // an upcoming delivery attempt, in case we rejected with temporary status.
317 status = StatusTemperror
318 err = fmt.Errorf("%w: not a dkim record: %s", ErrSyntax, err)
321 // If there are multiple valid records, return a temporary error. Perhaps the error is fixed soon.
325 return StatusTemperror, nil, "", lookupResult.Authentic, fmt.Errorf("%w: dns name %q", ErrMultipleRecords, name)
333 return status, nil, "", lookupResult.Authentic, err
335 return StatusNeutral, record, txt, lookupResult.Authentic, nil
338// Verify parses the DKIM-Signature headers in a message and verifies each of them.
340// If the headers of the message cannot be found, an error is returned.
341// Otherwise, each DKIM-Signature header is reflected in the returned results.
343// NOTE: Verify does not check if the domain (d=) that signed the message is
344// the domain of the sender. The caller, e.g. through DMARC, should do this.
346// If ignoreTestMode is true and the DKIM record is in test mode (t=y), a
347// verification failure is treated as actual failure. With ignoreTestMode
348// false, such verification failures are treated as if there is no signature by
349// returning StatusNone.
350func Verify(ctx context.Context, elog *slog.Logger, resolver dns.Resolver, smtputf8 bool, policy func(*Sig) error, r io.ReaderAt, ignoreTestMode bool) (results []Result, rerr error) {
351 log := mlog.New("dkim", elog)
354 duration := float64(time.Since(start)) / float64(time.Second)
355 for _, r := range results {
358 alg = r.Sig.Algorithm()
360 status := string(r.Status)
361 MetricVerify.ObserveLabels(duration, alg, status)
364 if len(results) == 0 {
365 log.Debugx("dkim verify result", rerr, slog.Bool("smtputf8", smtputf8), slog.Duration("duration", time.Since(start)))
367 for _, result := range results {
368 log.Debugx("dkim verify result", result.Err,
369 slog.Bool("smtputf8", smtputf8),
370 slog.Any("status", result.Status),
371 slog.Any("sig", result.Sig),
372 slog.Any("record", result.Record),
373 slog.Duration("duration", time.Since(start)))
377 hdrs, bodyOffset, err := parseHeaders(bufio.NewReader(&moxio.AtReader{R: r}))
379 return nil, fmt.Errorf("%w: %s", ErrHeaderMalformed, err)
382 // todo: reuse body hashes and possibly verify signatures in parallel. and start the dns lookup immediately.
../rfc/6376:2697
384 for _, h := range hdrs {
385 if h.lkey != "dkim-signature" {
389 sig, verifySig, err := parseSignature(h.raw, smtputf8)
392 err := fmt.Errorf("parsing DKIM-Signature header: %w", err)
393 results = append(results, Result{StatusPermerror, nil, nil, false, err})
397 h, canonHeaderSimple, canonDataSimple, err := checkSignatureParams(ctx, log, sig)
399 results = append(results, Result{StatusPermerror, sig, nil, false, err})
404 if err := policy(sig); err != nil {
405 err := fmt.Errorf("%w: %s", ErrPolicy, err)
406 results = append(results, Result{StatusPolicy, sig, nil, false, err})
410 br := bufio.NewReader(&moxio.AtReader{R: r, Offset: int64(bodyOffset)})
411 status, txt, authentic, err := verifySignature(ctx, log.Logger, resolver, sig, h, canonHeaderSimple, canonDataSimple, hdrs, verifySig, br, ignoreTestMode)
412 results = append(results, Result{status, sig, txt, authentic, err})
417// check if signature is acceptable.
418// Only looks at the signature parameters, not at the DNS record.
419func checkSignatureParams(ctx context.Context, log mlog.Log, sig *Sig) (hash crypto.Hash, canonHeaderSimple, canonBodySimple bool, rerr error) {
422 for _, h := range sig.SignedHeaders {
423 if strings.EqualFold(h, "from") {
429 return 0, false, false, fmt.Errorf(`%w: required "from" header not signed`, ErrFrom)
433 if sig.ExpireTime >= 0 && sig.ExpireTime < timeNow().Unix() {
434 return 0, false, false, fmt.Errorf("%w: expiration time %q", ErrSigExpired, time.Unix(sig.ExpireTime, 0).Format(time.RFC3339))
439 // Refuse signatures that reach beyond declared scope. We use the existing
440 // publicsuffix.Lookup to lookup a fake subdomain of the signing domain. If this
441 // supposed subdomain is actually an organizational domain, the signing domain
442 // shouldn't be signing for its organizational domain.
444 subdom.ASCII = "x." + subdom.ASCII
445 if subdom.Unicode != "" {
446 subdom.Unicode = "x." + subdom.Unicode
448 if orgDom := publicsuffix.Lookup(ctx, log.Logger, subdom); subdom.ASCII == orgDom.ASCII && !(Localserve && sig.Domain.ASCII == "localhost") {
449 return 0, false, false, fmt.Errorf("%w: %s", ErrTLD, sig.Domain)
452 h, hok := algHash(sig.AlgorithmHash)
454 return 0, false, false, fmt.Errorf("%w: %q", ErrHashAlgorithmUnknown, sig.AlgorithmHash)
457 t := strings.SplitN(sig.Canonicalization, "/", 2)
459 switch strings.ToLower(t[0]) {
461 canonHeaderSimple = true
464 return 0, false, false, fmt.Errorf("%w: header canonicalization %q", ErrCanonicalizationUnknown, sig.Canonicalization)
471 switch strings.ToLower(canon) {
473 canonBodySimple = true
476 return 0, false, false, fmt.Errorf("%w: body canonicalization %q", ErrCanonicalizationUnknown, sig.Canonicalization)
480 if len(sig.QueryMethods) > 0 {
482 for _, m := range sig.QueryMethods {
483 if strings.EqualFold(m, "dns/txt") {
489 return 0, false, false, fmt.Errorf("%w: need dns/txt", ErrQueryMethod)
493 return h, canonHeaderSimple, canonBodySimple, nil
496// lookup the public key in the DNS and verify the signature.
497func verifySignature(ctx context.Context, elog *slog.Logger, resolver dns.Resolver, sig *Sig, hash crypto.Hash, canonHeaderSimple, canonDataSimple bool, hdrs []header, verifySig []byte, body *bufio.Reader, ignoreTestMode bool) (Status, *Record, bool, error) {
499 status, record, _, authentic, err := Lookup(ctx, elog, resolver, sig.Selector, sig.Domain)
501 // todo: for temporary errors, we could pass on information so caller returns a 4.7.5 ecode,
../rfc/6376:2777
502 return status, nil, authentic, err
504 status, err = verifySignatureRecord(record, sig, hash, canonHeaderSimple, canonDataSimple, hdrs, verifySig, body, ignoreTestMode)
505 return status, record, authentic, err
508// verify a DKIM signature given the record from dns and signature from the email message.
509func verifySignatureRecord(r *Record, sig *Sig, hash crypto.Hash, canonHeaderSimple, canonDataSimple bool, hdrs []header, verifySig []byte, body *bufio.Reader, ignoreTestMode bool) (rstatus Status, rerr error) {
513 for _, f := range r.Flags {
514 if strings.EqualFold(f, "y") {
521 if rstatus != StatusPass {
529 if len(r.Hashes) > 0 {
531 for _, h := range r.Hashes {
532 if strings.EqualFold(h, sig.AlgorithmHash) {
538 return StatusPermerror, fmt.Errorf("%w: dkim dns record expects one of %q, message uses %q", ErrHashAlgNotAllowed, strings.Join(r.Hashes, ","), sig.AlgorithmHash)
543 if !strings.EqualFold(r.Key, sig.AlgorithmSign) {
544 return StatusPermerror, fmt.Errorf("%w: dkim dns record requires algorithm %q, message has %q", ErrSigAlgMismatch, r.Key, sig.AlgorithmSign)
548 if r.PublicKey == nil {
549 return StatusPermerror, ErrKeyRevoked
550 } else if rsaKey, ok := r.PublicKey.(*rsa.PublicKey); ok && rsaKey.N.BitLen() < 1024 {
551 // todo: find a reference that supports this.
552 return StatusPermerror, ErrWeakKey
556 if !r.ServiceAllowed("email") {
557 return StatusPermerror, ErrKeyNotForEmail
559 for _, t := range r.Flags {
562 if strings.EqualFold(t, "s") && sig.Identity != nil {
563 if sig.Identity.Domain.ASCII != sig.Domain.ASCII {
564 return StatusPermerror, fmt.Errorf("%w: i= identity domain %q must match d= domain %q", ErrDomainIdentityMismatch, sig.Domain.ASCII, sig.Identity.Domain.ASCII)
570 // todo future: implement l= parameter in signatures. we don't currently allow this through policy check.
571 return StatusPermerror, fmt.Errorf("l= (length) parameter in signature not yet implemented")
574 // We first check the signature is with the claimed body hash is valid. Then we
575 // verify the body hash. In case of invalid signatures, we won't read the entire
580 dh, err := dataHash(hash.New(), canonHeaderSimple, sig, hdrs, verifySig)
582 // Any error is likely an invalid header field in the message, hence permanent error.
583 return StatusPermerror, fmt.Errorf("calculating data hash: %w", err)
586 switch k := r.PublicKey.(type) {
588 if err := rsa.VerifyPKCS1v15(k, hash, dh, sig.Signature); err != nil {
589 return StatusFail, fmt.Errorf("%w: rsa verification: %s", ErrSigVerify, err)
591 case ed25519.PublicKey:
592 if ok := ed25519.Verify(k, dh, sig.Signature); !ok {
593 return StatusFail, fmt.Errorf("%w: ed25519 verification", ErrSigVerify)
596 return StatusPermerror, fmt.Errorf("%w: unrecognized signature algorithm %q", ErrSigAlgorithmUnknown, r.Key)
599 bh, err := bodyHash(hash.New(), canonDataSimple, body)
601 // Any error is likely some internal error, hence temporary error.
602 return StatusTemperror, fmt.Errorf("calculating body hash: %w", err)
604 if !bytes.Equal(sig.BodyHash, bh) {
605 return StatusFail, fmt.Errorf("%w: signature bodyhash %x != calculated bodyhash %x", ErrBodyhashMismatch, sig.BodyHash, bh)
608 return StatusPass, nil
611func algHash(s string) (crypto.Hash, bool) {
612 if strings.EqualFold(s, "sha1") {
613 return crypto.SHA1, true
614 } else if strings.EqualFold(s, "sha256") {
615 return crypto.SHA256, true
620// bodyHash calculates the hash over the body.
621func bodyHash(h hash.Hash, canonSimple bool, body *bufio.Reader) ([]byte, error) {
622 // todo: take l= into account. we don't currently allow it for policy reasons.
624 var crlf = []byte("\r\n")
630 buf, err := body.ReadBytes('\n')
631 if len(buf) == 0 && err == io.EOF {
634 if err != nil && err != io.EOF {
637 hascrlf := bytes.HasSuffix(buf, crlf)
639 buf = buf[:len(buf)-2]
642 for ; ncrlf > 0; ncrlf-- {
653 hb := bufio.NewWriter(h)
655 // We go through the body line by line, replacing WSP with a single space and removing whitespace at the end of lines.
656 // We stash "empty" lines. If they turn out to be at the end of the file, we must drop them.
657 stash := &bytes.Buffer{}
658 var line bool // Whether buffer read is for continuation of line.
659 var prev byte // Previous byte read for line.
660 linesEmpty := true // Whether stash contains only empty lines and may need to be dropped.
661 var bodynonempty bool // Whether body is non-empty, for adding missing crlf.
662 var hascrlf bool // Whether current/last line ends with crlf, for adding missing crlf.
664 // todo: should not read line at a time, count empty lines. reduces max memory usage. a message with lots of empty lines can cause high memory use.
665 buf, err := body.ReadBytes('\n')
666 if len(buf) == 0 && err == io.EOF {
669 if err != nil && err != io.EOF {
674 hascrlf = bytes.HasSuffix(buf, crlf)
676 buf = buf[:len(buf)-2]
679 // todo: what is "whitespace"? it isn't WSP (space and tab), the next line mentions WSP explicitly for another rule. should we drop trailing \r, \n, \v, more?
680 buf = bytes.TrimRight(buf, " \t")
683 // Replace one or more WSP to a single SP.
684 for i, c := range buf {
685 wsp := c == ' ' || c == '\t'
686 if (i >= 0 || line) && wsp {
705 hb.Write(stash.Bytes())
711 // Only for non-empty bodies without trailing crlf do we add the missing crlf.
712 if bodynonempty && !hascrlf {
718 return h.Sum(nil), nil
721func dataHash(h hash.Hash, canonSimple bool, sig *Sig, hdrs []header, verifySig []byte) ([]byte, error) {
723 revHdrs := map[string][]header{}
724 for _, h := range hdrs {
725 revHdrs[h.lkey] = append([]header{h}, revHdrs[h.lkey]...)
728 for _, key := range sig.SignedHeaders {
729 lkey := strings.ToLower(key)
734 revHdrs[lkey] = h[1:]
735 s := string(h[0].raw)
741 ch, err := relaxedCanonicalHeaderWithoutCRLF(s)
743 return nil, fmt.Errorf("canonicalizing header: %w", err)
745 headers += ch + "\r\n"
749 h.Write([]byte(headers))
752 ch, err := relaxedCanonicalHeaderWithoutCRLF(string(verifySig))
754 return nil, fmt.Errorf("canonicalizing DKIM-Signature header: %w", err)
759 return h.Sum(nil), nil
762// a single header, can be multiline.
763func relaxedCanonicalHeaderWithoutCRLF(s string) (string, error) {
765 t := strings.SplitN(s, ":", 2)
767 return "", fmt.Errorf("%w: invalid header %q", ErrHeaderMalformed, s)
770 // Unfold, we keep the leading WSP on continuation lines and fix it up below.
771 v := strings.ReplaceAll(t[1], "\r\n", "")
773 // Replace one or more WSP to a single SP.
776 for i, c := range []byte(v) {
777 if i >= 0 && c == ' ' || c == '\t' {
789 ch := strings.ToLower(strings.TrimRight(t[0], " \t")) + ":" + strings.Trim(string(nv), " \t")
794 key string // Key in original case.
795 lkey string // Key in lower-case, for canonical case.
796 value []byte // Literal header value, possibly spanning multiple lines, not modified in any way, including crlf, excluding leading key and colon.
797 raw []byte // Like value, but including original leading key and colon. Ready for use as simple header canonicalized use.
800func parseHeaders(br *bufio.Reader) ([]header, int, error) {
807 line, err := readline(br)
812 if bytes.Equal(line, []byte("\r\n")) {
815 if line[0] == ' ' || line[0] == '\t' {
816 if len(l) == 0 && key == "" {
817 return nil, 0, fmt.Errorf("malformed message, starts with space/tab")
819 value = append(value, line...)
820 raw = append(raw, line...)
824 l = append(l, header{key, lkey, value, raw})
826 t := bytes.SplitN(line, []byte(":"), 2)
828 return nil, 0, fmt.Errorf("malformed message, header without colon")
831 key = strings.TrimRight(string(t[0]), " \t") // todo: where is this specified?
833 for _, c := range key {
834 if c <= ' ' || c >= 0x7f {
835 return nil, 0, fmt.Errorf("invalid header field name")
839 return nil, 0, fmt.Errorf("empty header key")
841 lkey = strings.ToLower(key)
842 value = append([]byte{}, t[1]...)
843 raw = append([]byte{}, line...)
846 l = append(l, header{key, lkey, value, raw})
851func readline(r *bufio.Reader) ([]byte, error) {
854 line, err := r.ReadBytes('\n')
858 if bytes.HasSuffix(line, []byte("\r\n")) {
862 return append(buf, line...), nil
864 buf = append(buf, line...)