butterrobot
7565618efd
Some checks failed
Three defects in the SMTP backend, all predating the FMG-2 dependency upgrade.
## Authentication bypass
The credential check joined its two comparisons with `&&`, so it only rejected a client that got *both* halves wrong — a correct username with any password authenticated, as did a correct password with any username. Both comparisons now have to pass, and both are evaluated before either is acted on so the timing does not distinguish a wrong username from a wrong password. They compare SHA-256 digests through `subtle.ConstantTimeCompare`, which keeps the length of the configured credential out of the timing as well.
Fixing the comparison alone does not close the hole. go-smtp advertises `AUTH` but leaves enforcement to the backend, so a client could skip `AUTH` entirely and still have its message forwarded. The session now tracks authentication and refuses `MAIL`, `RCPT` and `DATA` without it.
Nor does the gate mean anything while the credentials it checks can be guessed. `SetDefaults` invented `Username = "username"` and `Password = "password"` when the config omitted them, with only a `slog.Warn` — so a `config.toml` naming nothing but a port and its recipients relayed to anyone who tried the obvious pair, for exactly the deployments that had configured the least. `Validate` now rejects unset credentials the way it already rejects an unusable target, and the invented defaults are gone.
**Behavior change:** a client that used to send without issuing `AUTH` now has to be configured with the credentials from `config.toml`, and a deployment that never set them will not start until it does. Both documented in the README.
## Remote denial of service
A malformed `Content-Type` reached `log.Fatalf`, which calls `os.Exit(1)`. One message with an attacker-controlled header terminated the daemon and took every other in-flight message with it. `Body()` now returns the parse error like the rest of the function does.
## Silent notification loss
`Data` logged forwarding errors and returned `250`, so a client whose notification reached no target at all treated the message as delivered and never retried. The reply now reflects what happened:
- `250` — at least one target accepted it. A *partial* failure is logged but still accepted, since a retry redelivers to every target and would duplicate the notification on the ones that already have it. This keeps the existing `TestPartialTargetFailure` contract.
- `451` — no target accepted it. Worth retrying.
- `550 5.6.0` — the message cannot be parsed. No retry can fix the same bytes.
- `550 5.3.5` — the recipient has no notification targets configured. A configuration fault; no retry can add targets. `LoadConfig` blocks such a config, so this is only reachable from one built in code.
## Session transaction state
`Session.Reset` was empty while go-smtp calls it after every message, so recipients accumulated across a connection and the second message on it was also forwarded to the first one's targets.
Fixing that introduced a data race, caught in review: `Reset` runs on the connection goroutine, but go-smtp runs `Data` on its own goroutine for a `BDAT` transfer and does not block `RSET` during one. A mutex now guards the recipients and the authentication flag across `Rcpt`, `Data` and `Reset`, and `Data` snapshots the recipients up front instead of reading the slice while forwarding.
## Validation
`make format`, `make ci-lint` (0 issues), `make test` (`-race`, 94.2% coverage), `make check` and `make build` all pass locally.
Every regression test was confirmed to fail against the code it guards:
- the six original ones against `origin/main` — the malformed `Content-Type` one by killing the test binary outright, which is the reported DoS;
- `TestResetDuringChunkedTransferIsSynchronized` against `da8e8e4`, where `-race` reports `Session.Reset` racing `Session.Data` on all three runs attempted;
- `TestLoadConfigRejectsUnsetCredentials` against `da8e8e4`'s `config.go`.
## Known gaps, not addressed here
- `Body()` returns `("", nil)` for a `multipart/*` with an unusable boundary and for any media type that is neither `multipart/` nor `text/`, so an empty notification is pushed to every target and answered `250`.
- `forwardEmail` breaks after the first matching `[[Recipients]]` entry, so a message addressed to two matching entries notifies only the first and still answers `250`. Pre-existing.
- A message for an address matching no entry, with no `[CatchAll]`, is accepted with `250` and dropped. Rejecting at `RCPT` would be more honest.
- `smtp.ErrAuthRequired` is go-smtp's `502 5.7.0` where RFC 4954 §6 specifies `530 5.7.0`. Left on the library's own constant.
Closes FMG-3
Co-authored-by: Full-Stack Developer <me@fmartingr.com>
Reviewed-on: #9
Reviewed-by: Felipe M <me@fmartingr.com>
90 lines
2.3 KiB
Go
90 lines
2.3 KiB
Go
package smtp2shoutrrr
|
|
|
|
import (
|
|
"net/mail"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func readMessage(t *testing.T, raw string) *mail.Message {
|
|
t.Helper()
|
|
|
|
msg, err := mail.ReadMessage(strings.NewReader(raw))
|
|
require.NoError(t, err)
|
|
|
|
return msg
|
|
}
|
|
|
|
// Regression: this header reached log.Fatalf, which exits the process. The
|
|
// value is attacker-controlled and needs nothing but the ability to deliver a
|
|
// message.
|
|
func TestBodyRejectsMalformedContentType(t *testing.T) {
|
|
for name, contentType := range map[string]string{
|
|
"parameter without a value": "text/plain; charset",
|
|
"duplicate parameter": "text/plain; charset=utf-8; charset=ascii",
|
|
"no media type": ";",
|
|
"unterminated quoted value": `multipart/mixed; boundary="unterminated`,
|
|
} {
|
|
t.Run(name, func(t *testing.T) {
|
|
email := ReceivedEmail{
|
|
Msg: readMessage(t, "Subject: Test\r\nContent-Type: "+contentType+"\r\n\r\nbody\r\n"),
|
|
}
|
|
|
|
body, err := email.Body()
|
|
require.Error(t, err)
|
|
require.ErrorIs(t, err, errMalformedMessage,
|
|
"an unparseable header is permanent, so the sender must not be told to retry")
|
|
require.Empty(t, body)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestBodyReadsMessageWithoutContentType(t *testing.T) {
|
|
email := ReceivedEmail{Msg: readMessage(t, "Subject: Test\r\n\r\nplain body\r\n")}
|
|
|
|
body, err := email.Body()
|
|
require.NoError(t, err)
|
|
require.Equal(t, "plain body\r\n", body)
|
|
}
|
|
|
|
func TestBodyPrefersPlainTextPartOverHTML(t *testing.T) {
|
|
email := ReceivedEmail{Msg: readMessage(t, strings.Join([]string{
|
|
"Subject: Test",
|
|
`Content-Type: multipart/alternative; boundary="b"`,
|
|
"",
|
|
"--b",
|
|
"Content-Type: text/html; charset=utf-8",
|
|
"",
|
|
"<p>html body</p>",
|
|
"--b",
|
|
"Content-Type: text/plain; charset=utf-8",
|
|
"",
|
|
"plain body",
|
|
"--b--",
|
|
"",
|
|
}, "\r\n"))}
|
|
|
|
body, err := email.Body()
|
|
require.NoError(t, err)
|
|
require.Equal(t, "plain body", body)
|
|
}
|
|
|
|
func TestBodyFallsBackToHTMLPart(t *testing.T) {
|
|
email := ReceivedEmail{Msg: readMessage(t, strings.Join([]string{
|
|
"Subject: Test",
|
|
`Content-Type: multipart/alternative; boundary="b"`,
|
|
"",
|
|
"--b",
|
|
"Content-Type: text/html; charset=utf-8",
|
|
"",
|
|
"<p>html body</p>",
|
|
"--b--",
|
|
"",
|
|
}, "\r\n"))}
|
|
|
|
body, err := email.Body()
|
|
require.NoError(t, err)
|
|
require.Equal(t, "<p>html body</p>", body)
|
|
}
|