mirror of
https://github.com/foxcpp/maddy.git
synced 2025-04-07 06:57:37 +03:00
Move most code from the repo root into subdirectories
The intention is to keep to repo root clean while the list of packages is slowly growing. Additionally, a bunch of small (~30 LoC) files in the repo root is merged into a single maddy.go file, for the same reason. Most of the internal code is moved into the internal/ directory. Go toolchain will make it impossible to import these packages from external applications. Some packages are renamed and moved into the pkg/ directory in the root. According to https://github.com/golang-standards/project-layout this is the de-facto standard to place "library code that's ok to use by external applications" in. To clearly define the purpose of top-level directories, README.md files are added to each.
This commit is contained in:
fox.cpp
parent
c4df3af4af
commit
bf188e454f
180 changed files with 722 additions and 684 deletions
204
internal/msgpipeline/dmarc_test.go
Normal file
204
internal/msgpipeline/dmarc_test.go
Normal file
|
|
@ -0,0 +1,204 @@
|
|||
package msgpipeline
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"crypto/sha1"
|
||||
"encoding/hex"
|
||||
"errors"
|
||||
"net"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/emersion/go-message/textproto"
|
||||
"github.com/emersion/go-msgauth/authres"
|
||||
"github.com/foxcpp/go-mockdns"
|
||||
"github.com/foxcpp/maddy/internal/buffer"
|
||||
"github.com/foxcpp/maddy/internal/exterrors"
|
||||
"github.com/foxcpp/maddy/internal/module"
|
||||
"github.com/foxcpp/maddy/internal/testutils"
|
||||
)
|
||||
|
||||
func doTestDelivery(t *testing.T, tgt module.DeliveryTarget, from string, to []string, hdr string) (string, error) {
|
||||
t.Helper()
|
||||
|
||||
IDRaw := sha1.Sum([]byte(t.Name()))
|
||||
encodedID := hex.EncodeToString(IDRaw[:])
|
||||
|
||||
body := buffer.MemoryBuffer{Slice: []byte("foobar")}
|
||||
ctx := module.MsgMetadata{
|
||||
DontTraceSender: true,
|
||||
ID: encodedID,
|
||||
}
|
||||
|
||||
hdrParsed, err := textproto.ReadHeader(bufio.NewReader(strings.NewReader(hdr)))
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
delivery, err := tgt.Start(&ctx, from)
|
||||
if err != nil {
|
||||
return encodedID, err
|
||||
}
|
||||
for _, rcpt := range to {
|
||||
if err := delivery.AddRcpt(rcpt); err != nil {
|
||||
if err := delivery.Abort(); err != nil {
|
||||
t.Log("delivery.Abort:", err)
|
||||
}
|
||||
return encodedID, err
|
||||
}
|
||||
}
|
||||
if err := delivery.Body(hdrParsed, body); err != nil {
|
||||
if err := delivery.Abort(); err != nil {
|
||||
t.Log("delivery.Abort:", err)
|
||||
}
|
||||
return encodedID, err
|
||||
}
|
||||
if err := delivery.Commit(); err != nil {
|
||||
return encodedID, err
|
||||
}
|
||||
|
||||
return encodedID, err
|
||||
}
|
||||
|
||||
func dmarcResult(t *testing.T, hdr textproto.Header) authres.ResultValue {
|
||||
field := hdr.Get("Authentication-Results")
|
||||
if field == "" {
|
||||
t.Fatalf("No results field")
|
||||
}
|
||||
|
||||
_, results, err := authres.Parse(field)
|
||||
if err != nil {
|
||||
t.Fatalf("Field parse err: %v", err)
|
||||
}
|
||||
|
||||
for _, res := range results {
|
||||
dmarcRes, ok := res.(*authres.DMARCResult)
|
||||
if ok {
|
||||
return dmarcRes.Value
|
||||
}
|
||||
}
|
||||
|
||||
t.Fatalf("No DMARC authres found")
|
||||
return ""
|
||||
}
|
||||
|
||||
func TestDMARC(t *testing.T) {
|
||||
test := func(zones map[string]mockdns.Zone, hdr string, authres []authres.Result, reject, quarantine bool, dmarcRes authres.ResultValue) {
|
||||
t.Helper()
|
||||
|
||||
tgt := testutils.Target{}
|
||||
p := MsgPipeline{
|
||||
msgpipelineCfg: msgpipelineCfg{
|
||||
globalChecks: []module.Check{
|
||||
&testutils.Check{
|
||||
BodyRes: module.CheckResult{
|
||||
AuthResult: authres,
|
||||
},
|
||||
},
|
||||
},
|
||||
perSource: map[string]sourceBlock{},
|
||||
defaultSource: sourceBlock{
|
||||
perRcpt: map[string]*rcptBlock{},
|
||||
defaultRcpt: &rcptBlock{
|
||||
targets: []module.DeliveryTarget{&tgt},
|
||||
},
|
||||
},
|
||||
doDMARC: true,
|
||||
},
|
||||
Log: testutils.Logger(t, "pipeline"),
|
||||
Resolver: &mockdns.Resolver{Zones: zones},
|
||||
}
|
||||
|
||||
_, err := doTestDelivery(t, &p, "test@example.org", []string{"test@example.com"}, hdr)
|
||||
if reject {
|
||||
if err == nil {
|
||||
t.Errorf("expected message to be rejected")
|
||||
return
|
||||
}
|
||||
t.Log(err, exterrors.Fields(err))
|
||||
return
|
||||
}
|
||||
if err != nil {
|
||||
t.Errorf("unexpected error: %v %+v", err, exterrors.Fields(err))
|
||||
return
|
||||
}
|
||||
|
||||
if len(tgt.Messages) != 1 {
|
||||
t.Errorf("got %d messages", len(tgt.Messages))
|
||||
return
|
||||
}
|
||||
msg := tgt.Messages[0]
|
||||
|
||||
if msg.MsgMeta.Quarantine != quarantine {
|
||||
t.Errorf("msg.MsgMeta.Quarantine (%v) != quarantine (%v)", msg.MsgMeta.Quarantine, quarantine)
|
||||
return
|
||||
}
|
||||
|
||||
res := dmarcResult(t, msg.Header)
|
||||
if res != dmarcRes {
|
||||
t.Errorf("expected DMARC result to be '%v', got '%v'", dmarcRes, res)
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// No policy => DMARC 'none'
|
||||
test(map[string]mockdns.Zone{}, "From: hello@example.org\r\n\r\n", []authres.Result{
|
||||
&authres.DKIMResult{Value: authres.ResultPass, Domain: "example.org"},
|
||||
&authres.SPFResult{Value: authres.ResultNone, From: "example.org", Helo: "mx.example.org"},
|
||||
}, false, false, authres.ResultNone)
|
||||
|
||||
// Policy present & identifiers align => DMARC 'pass'
|
||||
test(map[string]mockdns.Zone{
|
||||
"_dmarc.example.org.": mockdns.Zone{
|
||||
TXT: []string{"v=DMARC1; p=none"},
|
||||
},
|
||||
}, "From: hello@example.org\r\n\r\n", []authres.Result{
|
||||
&authres.DKIMResult{Value: authres.ResultPass, Domain: "example.org"},
|
||||
&authres.SPFResult{Value: authres.ResultNone, From: "example.org", Helo: "mx.example.org"},
|
||||
}, false, false, authres.ResultPass)
|
||||
|
||||
// Policy fetch error => DMARC 'permerror' but the message
|
||||
// is accepted.
|
||||
test(map[string]mockdns.Zone{
|
||||
"_dmarc.example.com.": mockdns.Zone{
|
||||
Err: errors.New("the dns server is going insane"),
|
||||
},
|
||||
}, "From: hello@example.com\r\n\r\n", []authres.Result{
|
||||
&authres.DKIMResult{Value: authres.ResultPass, Domain: "example.org"},
|
||||
&authres.SPFResult{Value: authres.ResultNone, From: "example.org", Helo: "mx.example.org"},
|
||||
}, false, false, authres.ResultPermError)
|
||||
|
||||
// Policy fetch error => DMARC 'temperror' but the message
|
||||
// is rejected ("fail closed")
|
||||
test(map[string]mockdns.Zone{
|
||||
"_dmarc.example.com.": mockdns.Zone{
|
||||
Err: &net.DNSError{
|
||||
Err: "the dns server is going insane, temporary",
|
||||
IsTemporary: true,
|
||||
},
|
||||
},
|
||||
}, "From: hello@example.com\r\n\r\n", []authres.Result{
|
||||
&authres.DKIMResult{Value: authres.ResultPass, Domain: "example.org"},
|
||||
&authres.SPFResult{Value: authres.ResultNone, From: "example.org", Helo: "mx.example.org"},
|
||||
}, true, false, authres.ResultTempError)
|
||||
|
||||
// Misaligned From vs DKIM => DMARC 'fail', policy says to reject
|
||||
test(map[string]mockdns.Zone{
|
||||
"_dmarc.example.com.": mockdns.Zone{
|
||||
TXT: []string{"v=DMARC1; p=reject"},
|
||||
},
|
||||
}, "From: hello@example.com\r\n\r\n", []authres.Result{
|
||||
&authres.DKIMResult{Value: authres.ResultPass, Domain: "example.org"},
|
||||
&authres.SPFResult{Value: authres.ResultNone, From: "example.org", Helo: "mx.example.org"},
|
||||
}, true, false, "")
|
||||
|
||||
// Misaligned From vs DKIM => DMARC 'fail', policy says to quarantine.
|
||||
test(map[string]mockdns.Zone{
|
||||
"_dmarc.example.com.": mockdns.Zone{
|
||||
TXT: []string{"v=DMARC1; p=quarantine"},
|
||||
},
|
||||
}, "From: hello@example.com\r\n\r\n", []authres.Result{
|
||||
&authres.DKIMResult{Value: authres.ResultPass, Domain: "example.org"},
|
||||
&authres.SPFResult{Value: authres.ResultNone, From: "example.org", Helo: "mx.example.org"},
|
||||
}, false, true, authres.ResultFail)
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue