-
Notifications
You must be signed in to change notification settings - Fork 60
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
WIP: smtpsrv: Strict CRLF enforcement in DATA contents
**WIP: THIS IS A WORK IN PROGRESS PATCH, AND IT MAY BE EDITED.** The RFCs are very clear that in DATA contents: > CR and LF MUST only occur together as CRLF; they MUST NOT appear > independently in the body. https://www.rfc-editor.org/rfc/rfc5322#section-2.3 https://www.rfc-editor.org/rfc/rfc5321#section-2.3.8 Allowing "independent" CR and LF can cause a number of problems. In particular, there is a new "SMTP smuggling attack" published recently that involves the server incorrectly parsing the end of DATA marker `\r\n.\r\n`, which an attacker can exploit to impersonate a server when email is transmitted server-to-server. https://www.postfix.org/smtp-smuggling.html https://sec-consult.com/blog/detail/smtp-smuggling-spoofing-e-mails-worldwide/ Currently, chasquid is vulnerable to this attack, because Go's standard libraries net/textproto and net/mail do not enforce CRLF strictly. This patch fixes the problem by introducing a new "dot reader" function that strictly enforces CRLF when reading dot-terminated data, used in the DATA input processing. See #47 for more details and discussion. **WIP: THIS IS A WORK IN PROGRESS PATCH, AND IT MAY BE EDITED.**
- Loading branch information
Showing
10 changed files
with
304 additions
and
85 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
package smtpsrv | ||
|
||
import ( | ||
"bufio" | ||
"bytes" | ||
"errors" | ||
"io" | ||
) | ||
|
||
var ( | ||
errMessageTooLarge = errors.New("message too large") | ||
errInvalidLineEnding = errors.New("invalid line ending") | ||
) | ||
|
||
// readUntilDot reads from r until it encounters a dot-terminated line, or we | ||
// read max bytes. | ||
func readUntilDot(r *bufio.Reader, max int) ([]byte, error) { | ||
buf := make([]byte, 0, 1024) | ||
n := 0 | ||
|
||
// Little state machine. | ||
const ( | ||
prevOther = iota | ||
prevCR | ||
prevCRLF | ||
) | ||
prev := prevOther | ||
last4 := make([]byte, 4) | ||
|
||
loop: | ||
for { | ||
b, err := r.ReadByte() | ||
if err == io.EOF { | ||
return buf, io.ErrUnexpectedEOF | ||
} else if err != nil { | ||
return buf, err | ||
} | ||
n++ | ||
|
||
switch b { | ||
case '\r': | ||
if prev != prevOther && prev != prevCRLF { | ||
return buf, errInvalidLineEnding | ||
} | ||
prev = prevCR | ||
case '\n': | ||
if prev != prevCR { | ||
return buf, errInvalidLineEnding | ||
} | ||
// If we come from a '\r\n.\r', then we're done. | ||
if bytes.Equal(last4, []byte("\r\n.\r")) { | ||
break loop | ||
} | ||
prev = prevCRLF | ||
default: | ||
if prev == prevCR { | ||
return buf, errInvalidLineEnding | ||
} | ||
prev = prevOther | ||
} | ||
|
||
// Keep the last 4 bytes separately, because they may not be in buf on | ||
// messages that are too large. | ||
copy(last4, last4[1:]) | ||
last4[3] = b | ||
|
||
if len(buf) < max { | ||
buf = append(buf, b) | ||
} | ||
} | ||
|
||
if n > max { | ||
return buf, errMessageTooLarge | ||
} | ||
|
||
// If we made it this far, buf ends in "\r\n.\r"; do not include the final | ||
// ".\r" in the returned buffer. | ||
return buf[:len(buf)-2], nil | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
package smtpsrv | ||
|
||
import ( | ||
"bufio" | ||
"bytes" | ||
"io" | ||
"strings" | ||
"testing" | ||
) | ||
|
||
func TestReadUntilDot(t *testing.T) { | ||
cases := []struct { | ||
input string | ||
max int | ||
want string | ||
wantErr error | ||
}{ | ||
// EOF before any input -> unexpected EOF. | ||
{"", 0, "", io.ErrUnexpectedEOF}, | ||
{"", 1, "", io.ErrUnexpectedEOF}, | ||
|
||
// EOF after exceeding max -> unexpected EOF. | ||
{"abcdef", 2, "ab", io.ErrUnexpectedEOF}, | ||
|
||
// \n at the beginning of the buffer are just as invalid, and the | ||
// error takes precedence over the unexpected EOF. | ||
{"\n", 0, "", errInvalidLineEnding}, | ||
{"\n", 1, "", errInvalidLineEnding}, | ||
{"\n", 2, "", errInvalidLineEnding}, | ||
{"\n\r\n.\r\n", 10, "", errInvalidLineEnding}, | ||
|
||
// \r and then EOF -> unexpected EOF, because we never had a chance to | ||
// assess if the line ending is valid or not. | ||
{"\r", 2, "\r", io.ErrUnexpectedEOF}, | ||
|
||
// Lonely \r -> invalid line ending. | ||
{"abc\rdef", 10, "abc\r", errInvalidLineEnding}, | ||
{"abc\r\rdef", 10, "abc\r", errInvalidLineEnding}, | ||
|
||
// Lonely \n -> invalid line ending. | ||
{"abc\ndef", 10, "abc", errInvalidLineEnding}, | ||
|
||
// Various valid cases. | ||
{"\r\n.\r\n", 10, "\r\n", nil}, | ||
{"abc\r\n.\r\n", 10, "abc\r\n", nil}, | ||
|
||
// Max bytes reached -> message too large. | ||
{"abc\r\n.\r\n", 5, "abc\r\n", errMessageTooLarge}, | ||
{"abcdefg\r\n.\r\n", 5, "abcde", errMessageTooLarge}, | ||
{"ab\r\ncdefg\r\n.\r\n", 5, "ab\r\nc", errMessageTooLarge}, | ||
} | ||
|
||
for i, c := range cases { | ||
r := bufio.NewReader(strings.NewReader(c.input)) | ||
got, err := readUntilDot(r, c.max) | ||
if err != c.wantErr { | ||
t.Errorf("case %d %q: got error %v, want %v", i, c.input, err, c.wantErr) | ||
} | ||
if !bytes.Equal(got, []byte(c.want)) { | ||
t.Errorf("case %d %q: got %q, want %q", i, c.input, got, c.want) | ||
} | ||
} | ||
} | ||
|
||
type badBuffer bytes.Buffer | ||
|
||
func (b *badBuffer) Read(p []byte) (int, error) { | ||
// Return an arbitrary non-EOF error for testing. | ||
return 0, io.ErrNoProgress | ||
} | ||
|
||
func TestReadUntilDotReadError(t *testing.T) { | ||
r := bufio.NewReader(&badBuffer{}) | ||
_, err := readUntilDot(r, 10) | ||
if err != io.ErrNoProgress { | ||
t.Errorf("got error %v, want %v", err, io.ErrNoProgress) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
|
||
c tcp_connect localhost:1025 | ||
|
||
c <~ 220 | ||
c -> EHLO localhost | ||
c <... 250 HELP | ||
c -> MAIL FROM: <> | ||
c <~ 250 | ||
c -> RCPT TO: user@testserver | ||
c <~ 250 | ||
c -> DATA | ||
c <~ 354 | ||
c -> From: Mailer daemon <[email protected]> | ||
c -> Subject: I've come to haunt you | ||
c -> | ||
c -> Muahahahaha | ||
c -> | ||
|
||
# This is NOT a proper terminator, because it doesn't end with \r\n. | ||
# Processing should continue. If the parser incorrectly accepts this as a | ||
# valid DATA terminator (which would expose us to an SMTP smuggling attack), | ||
# then the subsequent lines will result in the server returning an error | ||
# instead of a successful response to the QUIT. | ||
c ~> '.\n' | ||
|
||
c -> That was a bad line ending, this is a good one. | ||
c ~> 'xxx\r\n.\r\n' | ||
|
||
c <- 521 5.5.2 Error reading DATA: invalid line ending | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
|
||
c tcp_connect localhost:1025 | ||
|
||
c <~ 220 | ||
c -> EHLO localhost | ||
c <... 250 HELP | ||
c -> MAIL FROM: <> | ||
c <~ 250 | ||
c -> RCPT TO: user@testserver | ||
c <~ 250 | ||
c -> DATA | ||
c <~ 354 | ||
c -> From: Mailer daemon <[email protected]> | ||
c -> Subject: I've come to haunt you | ||
c -> | ||
c -> Muahahahaha | ||
c -> | ||
|
||
# This is NOT a proper terminator, because it doesn't end with \r\n. | ||
# Processing should continue. If the parser incorrectly accepts this as a | ||
# valid DATA terminator (which would expose us to an SMTP smuggling attack), | ||
# then the subsequent lines will result in the server returning an error | ||
# instead of a successful response to the QUIT. | ||
c ~> 'xxx\n.\n' | ||
|
||
c -> That was a bad line ending, this is a good one. | ||
c ~> '\r\n.\r\n' | ||
|
||
c <- 521 5.5.2 Error reading DATA: invalid line ending | ||
|
Oops, something went wrong.