mirror of
https://github.com/foxcpp/maddy.git
synced 2025-04-05 22:17:39 +03:00
cf9e81d8a1
Previous error reporting code was inconsistent in terms of what is
logged, when and by whom. This caused several problems such as: logs
missing important error context, duplicated error messages, too verbose
messages, etc.
Instead of logging all generated errors, module should log
only errors it 'handles' somehow and does not simply pass it to the
caller. This removes duplication, however, also it removes context
information. To fix this, exterrors package was extended to provide
utilities for error wrapping. These utilities provide ability to
'attach' arbitrary key-value ('fields') pairs to any error object while
preserving the original value (using to Go 1.13 error handling
primitives).
In additional to solving problems described above this commit makes logs
machine-readable, creating the possibility for automated analysis.
Three new functions were added to the Logger object, providing
loosely-typed structured logging. However, they do not completely
replace plain logging and are used only where they are useful (to allow
automated analysis of message processing logs).
So, basically, instead of being logged god knows where and when,
all context information is attached to the error object and then it is
passed up until it is handled somewhere, at this point it is logged
together with all context information and then discarded.
67 lines
2.2 KiB
Go
67 lines
2.2 KiB
Go
package module
|
|
|
|
import (
|
|
"github.com/emersion/go-message/textproto"
|
|
"github.com/emersion/go-msgauth/authres"
|
|
"github.com/foxcpp/maddy/buffer"
|
|
)
|
|
|
|
// Check is the module interface that is meant for read-only (with the
|
|
// exception of the message header modifications) (meta-)data checking.
|
|
type Check interface {
|
|
// CheckStateForMsg initializes the "internal" check state required for
|
|
// processing of the new message.
|
|
CheckStateForMsg(msgMeta *MsgMetadata) (CheckState, error)
|
|
}
|
|
|
|
type CheckState interface {
|
|
// CheckConnection is executed once when client sends a new message.
|
|
//
|
|
// Result may be cached for the whole client connection so this function
|
|
// may not be called sometimes.
|
|
CheckConnection() CheckResult
|
|
|
|
// CheckSender is executed once when client sends the message sender
|
|
// information (e.g. on the MAIL FROM command).
|
|
CheckSender(mailFrom string) CheckResult
|
|
|
|
// CheckRcpt is executed for each recipient when its address is received
|
|
// from the client (e.g. on the RCPT TO command).
|
|
CheckRcpt(rcptTo string) CheckResult
|
|
|
|
// CheckBody is executed once after the message body is received and
|
|
// buffered in memory or on disk.
|
|
//
|
|
// Check code should use passed mutex when working with the message header.
|
|
// Body can be read without locking it since it is read-only.
|
|
CheckBody(header textproto.Header, body buffer.Buffer) CheckResult
|
|
|
|
// Close is called after the message processing ends, even if any of the
|
|
// Check* functions return an error.
|
|
Close() error
|
|
}
|
|
|
|
type CheckResult struct {
|
|
// Reason is the error that is reported to the message source
|
|
// if check decided that the message should be rejected.
|
|
Reason error
|
|
|
|
// Reject is the flag that specifies that the message
|
|
// should be rejected.
|
|
Reject bool
|
|
|
|
// Quarantine is the flag that specifies that the message
|
|
// is considered "possibly malicious" and should be
|
|
// put into Junk mailbox.
|
|
//
|
|
// This value is copied into MsgMetadata by the msgpipeline.
|
|
Quarantine bool
|
|
|
|
// AuthResult is the information that is supposed to
|
|
// be included in Authentication-Results header.
|
|
AuthResult []authres.Result
|
|
|
|
// Header is the header fields that should be
|
|
// added to the header after all checks.
|
|
Header textproto.Header
|
|
}
|