diff --git a/internal/config/config.go b/internal/config/config.go index 92b60c4..d385904 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -5,6 +5,7 @@ import ( "bytes" "fmt" "os" + "strings" "gopkg.in/yaml.v3" ) @@ -23,12 +24,41 @@ type Config struct { Web struct { Listen string `yaml:"listen"` // public archive and unsubscribe pages; empty disables them } `yaml:"web"` + // DKIM lists the signing keys, one per domain. The private keys stay in files. + DKIM []DKIMKey `yaml:"dkim"` Relay struct { Addr string `yaml:"addr"` // host:port of the outgoing SMTP relay Concurrency int `yaml:"concurrency"` // simultaneous deliveries } `yaml:"relay"` } +// DKIMKey is the signing key of one domain. +type DKIMKey struct { + Domain string `yaml:"domain"` + Selector string `yaml:"selector"` + KeyFile string `yaml:"key_file"` // PEM private key +} + +func (c Config) validate() error { + seen := map[string]bool{} + for i, k := range c.DKIM { + switch { + case strings.TrimSpace(k.Domain) == "": + return fmt.Errorf("dkim[%d]: domain is required", i) + case strings.TrimSpace(k.Selector) == "": + return fmt.Errorf("dkim[%d] (%s): selector is required", i, k.Domain) + case strings.TrimSpace(k.KeyFile) == "": + return fmt.Errorf("dkim[%d] (%s): key_file is required", i, k.Domain) + } + d := strings.ToLower(k.Domain) + if seen[d] { + return fmt.Errorf("dkim[%d]: more than one key for %s", i, k.Domain) + } + seen[d] = true + } + return nil +} + // Load reads path and applies defaults. func Load(path string) (Config, error) { var c Config @@ -49,5 +79,8 @@ func Load(path string) (Config, error) { if err := dec.Decode(&c); err != nil { return c, fmt.Errorf("parse %s: %w", path, err) } + if err := c.validate(); err != nil { + return c, fmt.Errorf("%s: %w", path, err) + } return c, nil } diff --git a/internal/config/config_test.go b/internal/config/config_test.go index df78e2d..46919b6 100644 --- a/internal/config/config_test.go +++ b/internal/config/config_test.go @@ -3,6 +3,7 @@ package config import ( "os" "path/filepath" + "strings" "testing" ) @@ -56,3 +57,35 @@ func TestWebCanBeDisabled(t *testing.T) { t.Fatalf("an empty listen address disables the web: %q", c.Web.Listen) } } + +func TestLoadDKIMKeys(t *testing.T) { + c, err := Load(write(t, "dkim:\n - domain: lists.example.org\n selector: mail\n key_file: /run/secrets/dkim.pem\n - domain: news.example.org\n selector: s2\n key_file: keys/news.pem\n")) + if err != nil { + t.Fatal(err) + } + if len(c.DKIM) != 2 || c.DKIM[0].Domain != "lists.example.org" || c.DKIM[0].Selector != "mail" || c.DKIM[0].KeyFile != "/run/secrets/dkim.pem" || + c.DKIM[1].KeyFile != "keys/news.pem" { + t.Fatalf("dkim: %+v", c.DKIM) + } + if c, _ := Load(write(t, "{}\n")); len(c.DKIM) != 0 { + t.Fatalf("no keys by default: %+v", c.DKIM) + } +} + +func TestLoadRejectsIncompleteOrDuplicateDKIMKeys(t *testing.T) { + for name, y := range map[string]string{ + "missing domain": "dkim:\n - selector: mail\n key_file: k.pem\n", + "missing selector": "dkim:\n - domain: a.org\n key_file: k.pem\n", + "missing key file": "dkim:\n - domain: a.org\n selector: mail\n", + "duplicate domain": "dkim:\n - {domain: a.org, selector: x, key_file: k1.pem}\n - {domain: A.ORG, selector: y, key_file: k2.pem}\n", + "inline key": "dkim:\n - {domain: a.org, selector: x, key_file: k.pem, private_key: SECRET}\n", + } { + if _, err := Load(write(t, y)); err == nil { + t.Errorf("%s: want an error", name) + } + } + _, err := Load(write(t, "dkim:\n - selector: mail\n key_file: k.pem\n")) + if err == nil || !strings.Contains(err.Error(), "dkim[0]") { + t.Fatalf("the error names the entry: %v", err) + } +}