1package mox

3import (

4 "bytes"

5 "cmp"

6 "context"

7 "crypto"

8 "crypto/ecdsa"

9 "crypto/ed25519"

10 "crypto/elliptic"

11 cryptorand "crypto/rand"

12 "crypto/rsa"

13 "crypto/tls"

14 "crypto/x509"

15 "encoding/base64"

16 "encoding/pem"

17 "errors"

18 "fmt"

19 "io"

20 "log/slog"

21 "maps"

22 "net"

23 "net/http"

24 "net/url"

25 "os"

26 "os/user"

27 "path/filepath"

28 "regexp"

29 "slices"

30 "strconv"

31 "strings"

32 "sync"

33 "time"

35 "golang.org/x/text/unicode/norm"

37 "github.com/mjl-/autocert"

39 "github.com/mjl-/sconf"

41 "github.com/mjl-/mox/autotls"

42 "github.com/mjl-/mox/config"

43 "github.com/mjl-/mox/dkim"

44 "github.com/mjl-/mox/dns"

45 "github.com/mjl-/mox/message"

46 "github.com/mjl-/mox/mlog"

47 "github.com/mjl-/mox/moxio"

48 "github.com/mjl-/mox/mtasts"

49 "github.com/mjl-/mox/smtp"

50)

52var pkglog = mlog.New("mox", nil)

54// Pedantic enables stricter parsing.

55var Pedantic bool

57// Config paths are set early in program startup. They will point to files in

58// the same directory.

59var (

60 ConfigStaticPath string

61 ConfigDynamicPath string

62 Conf = Config{Log: map[string]slog.Level{"": slog.LevelError}}

63)

65var ErrConfig = errors.New("config error")

67// Set by packages webadmin, webaccount, webmail, webapisrv to prevent cyclic dependencies.

68var NewWebadminHandler = func(basePath string, isForwarded bool) http.Handler { return nopHandler }

69var NewWebaccountHandler = func(basePath string, isForwarded bool) http.Handler { return nopHandler }

70var NewWebmailHandler = func(maxMsgSize int64, basePath string, isForwarded bool, accountPath string) http.Handler {

71 return nopHandler

72}

73var NewWebapiHandler = func(maxMsgSize int64, basePath string, isForwarded bool) http.Handler { return nopHandler }

75var nopHandler = http.HandlerFunc(nil)

77// Config as used in the code, a processed version of what is in the config file.

78//

79// Use methods to lookup a domain/account/address in the dynamic configuration.

80type Config struct {

81 Static config.Static // Does not change during the lifetime of a running instance.

83 logMutex sync.Mutex // For accessing the log levels.

84 Log map[string]slog.Level

86 dynamicMutex sync.Mutex

87 Dynamic config.Dynamic // Can only be accessed directly by tests. Use methods on Config for locked access.

88 dynamicMtime time.Time

89 DynamicLastCheck time.Time // For use by quickstart only to skip checks.

91 // From canonical full address (localpart@domain, lower-cased when

92 // case-insensitive, stripped of catchall separator) to account and address.

93 // Domains are IDNA names in utf8. Dynamic config lock must be held when accessing.

94 AccountDestinationsLocked map[string]AccountDestination

96 // Like AccountDestinationsLocked, but for aliases.

97 aliases map[string]config.Alias

98}

100type AccountDestination struct {

101 Catchall bool // If catchall destination for its domain.

102 Localpart smtp.Localpart // In original casing as written in config file.

103 Account string

104 Destination config.Destination

105}

106

107// LogLevelSet sets a new log level for pkg. An empty pkg sets the default log

108// value that is used if no explicit log level is configured for a package.

109// This change is ephemeral, no config file is changed.

110func (c *Config) LogLevelSet(log mlog.Log, pkg string, level slog.Level) {

111 c.logMutex.Lock()

112 defer c.logMutex.Unlock()

113 l := c.copyLogLevels()

114 l[pkg] = level

115 c.Log = l

116 log.Print("log level changed", slog.String("pkg", pkg), slog.Any("level", mlog.LevelStrings[level]))

117 mlog.SetConfig(c.Log)

118}

119

120// LogLevelRemove removes a configured log level for a package.

121func (c *Config) LogLevelRemove(log mlog.Log, pkg string) {

122 c.logMutex.Lock()

123 defer c.logMutex.Unlock()

124 l := c.copyLogLevels()

125 delete(l, pkg)

126 c.Log = l

127 log.Print("log level cleared", slog.String("pkg", pkg))

128 mlog.SetConfig(c.Log)

129}

130

131// copyLogLevels returns a copy of c.Log, for modifications.

132// must be called with log lock held.

133func (c *Config) copyLogLevels() map[string]slog.Level {

134 m := map[string]slog.Level{}

135 maps.Copy(m, c.Log)

136 return m

137}

138

139// LogLevels returns a copy of the current log levels.

140func (c *Config) LogLevels() map[string]slog.Level {

141 c.logMutex.Lock()

142 defer c.logMutex.Unlock()

143 return c.copyLogLevels()

144}

145

146// DynamicLockUnlock locks the dynamic config, will try updating the latest state

147// from disk, and return an unlock function. Should be called as "defer

148// Conf.DynamicLockUnlock()()".

149func (c *Config) DynamicLockUnlock() func() {

150 c.dynamicMutex.Lock()

151 now := time.Now()

152 if now.Sub(c.DynamicLastCheck) > time.Second {

153 c.DynamicLastCheck = now

154 if fi, err := os.Stat(ConfigDynamicPath); err != nil {

155 pkglog.Errorx("stat domains config", err)

156 } else if !fi.ModTime().Equal(c.dynamicMtime) {

157 if errs := c.loadDynamic(); len(errs) > 0 {

158 pkglog.Errorx("loading domains config", errs[0], slog.Any("errors", errs))

159 } else {

160 pkglog.Info("domains config reloaded")

161 c.dynamicMtime = fi.ModTime()

162 }

163 }

164 }

165 return c.dynamicMutex.Unlock

166}

167

168func (c *Config) withDynamicLock(fn func()) {

169 defer c.DynamicLockUnlock()()

170 fn()

171}

172

173// must be called with dynamic lock held.

174func (c *Config) loadDynamic() []error {

175 d, mtime, accDests, aliases, err := ParseDynamicConfig(context.Background(), pkglog, ConfigDynamicPath, c.Static)

176 if err != nil {

177 return err

178 }

179 c.Dynamic = d

180 c.dynamicMtime = mtime

181 c.AccountDestinationsLocked = accDests

182 c.aliases = aliases

183 c.allowACMEHosts(pkglog, true)

184 return nil

185}

186

187// DynamicConfig returns a shallow copy of the dynamic config. Must not be modified.

188func (c *Config) DynamicConfig() (config config.Dynamic) {

189 c.withDynamicLock(func() {

190 config = c.Dynamic // Shallow copy.

191 })

192 return

193}

194

195func (c *Config) Domains() (l []string) {

196 c.withDynamicLock(func() {

197 for name := range c.Dynamic.Domains {

198 l = append(l, name)

199 }

200 })

201 slices.Sort(l)

202 return l

203}

204

205func (c *Config) Accounts() (l []string) {

206 c.withDynamicLock(func() {

207 for name := range c.Dynamic.Accounts {

208 l = append(l, name)

209 }

210 })

211 return

212}

213

214func (c *Config) AccountsDisabled() (all, disabled []string) {

215 c.withDynamicLock(func() {

216 for name, conf := range c.Dynamic.Accounts {

217 all = append(all, name)

218 if conf.LoginDisabled != "" {

219 disabled = append(disabled, name)

220 }

221 }

222 })

223 return

224}

225

226// DomainLocalparts returns a mapping of encoded localparts to account names for a

227// domain, and encoded localparts to aliases. An empty localpart is a catchall

228// destination for a domain.

229func (c *Config) DomainLocalparts(d dns.Domain) (map[string]string, map[string]config.Alias) {

230 suffix := "@" + d.Name()

231 m := map[string]string{}

232 aliases := map[string]config.Alias{}

233 c.withDynamicLock(func() {

234 for addr, ad := range c.AccountDestinationsLocked {

235 if strings.HasSuffix(addr, suffix) {

236 if ad.Catchall {

237 m[""] = ad.Account

238 } else {

239 m[ad.Localpart.String()] = ad.Account

240 }

241 }

242 }

243 for addr, a := range c.aliases {

244 if strings.HasSuffix(addr, suffix) {

245 aliases[a.LocalpartStr] = a

246 }

247 }

248 })

249 return m, aliases

250}

251

252func (c *Config) Domain(d dns.Domain) (dom config.Domain, ok bool) {

253 c.withDynamicLock(func() {

254 dom, ok = c.Dynamic.Domains[d.Name()]

255 })

256 return

257}

258

259func (c *Config) DomainConfigs() (doms []config.Domain) {

260 c.withDynamicLock(func() {

261 doms = make([]config.Domain, 0, len(c.Dynamic.Domains))

262 for _, d := range c.Dynamic.Domains {

263 doms = append(doms, d)

264 }

265 })

266 slices.SortFunc(doms, func(a, b config.Domain) int {

267 return cmp.Compare(a.Domain.Name(), b.Domain.Name())

268 })

269 return

270}

271

272func (c *Config) Account(name string) (acc config.Account, ok bool) {

273 c.withDynamicLock(func() {

274 acc, ok = c.Dynamic.Accounts[name]

275 })

276 return

277}

278

279func (c *Config) AccountDestination(addr string) (accDest AccountDestination, alias *config.Alias, ok bool) {

280 c.withDynamicLock(func() {

281 accDest, ok = c.AccountDestinationsLocked[addr]

282 if !ok {

283 var a config.Alias

284 a, ok = c.aliases[addr]

285 if ok {

286 alias = &a

287 }

288 }

289 })

290 return

291}

292

293func (c *Config) Routes(accountName string, domain dns.Domain) (accountRoutes, domainRoutes, globalRoutes []config.Route) {

294 c.withDynamicLock(func() {

295 acc := c.Dynamic.Accounts[accountName]

296 accountRoutes = acc.Routes

297

298 dom := c.Dynamic.Domains[domain.Name()]

299 domainRoutes = dom.Routes

300

301 globalRoutes = c.Dynamic.Routes

302 })

303 return

304}

305

306func (c *Config) IsClientSettingsDomain(d dns.Domain) (is bool) {

307 c.withDynamicLock(func() {

308 _, is = c.Dynamic.ClientSettingDomains[d]

309 })

310 return

311}

312

313func (c *Config) allowACMEHosts(log mlog.Log, checkACMEHosts bool) {

314 for _, l := range c.Static.Listeners {

315 if l.TLS == nil || l.TLS.ACME == "" {

316 continue

317 }

318

319 m := c.Static.ACME[l.TLS.ACME].Manager

320 hostnames := map[dns.Domain]struct{}{}

321

322 hostnames[c.Static.HostnameDomain] = struct{}{}

323 if l.HostnameDomain.ASCII != "" {

324 hostnames[l.HostnameDomain] = struct{}{}

325 }

326

327 for _, dom := range c.Dynamic.Domains {

328 // Do not allow TLS certificates for domains for which we only accept DMARC/TLS

329 // reports as external party.

330 if dom.ReportsOnly {

331 continue

332 }

333

334 // Do not fetch TLS certs for disabled domains. The A/AAAA records may not be

335 // configured or still point to a previous machine before a migration.

336 if dom.Disabled {

337 continue

338 }

339

340 if l.AutoconfigHTTPS.Enabled && !l.AutoconfigHTTPS.NonTLS {

341 if d, err := dns.ParseDomain("autoconfig." + dom.Domain.ASCII); err != nil {

342 log.Errorx("parsing autoconfig domain", err, slog.Any("domain", dom.Domain))

343 } else {

344 hostnames[d] = struct{}{}

345 }

346 }

347

348 if l.MTASTSHTTPS.Enabled && dom.MTASTS != nil && !l.MTASTSHTTPS.NonTLS {

349 d, err := dns.ParseDomain("mta-sts." + dom.Domain.ASCII)

350 if err != nil {

351 log.Errorx("parsing mta-sts domain", err, slog.Any("domain", dom.Domain))

352 } else {

353 hostnames[d] = struct{}{}

354 }

355 }

356

357 if dom.ClientSettingsDomain != "" {

358 hostnames[dom.ClientSettingsDNSDomain] = struct{}{}

359 }

360 }

361

362 if l.WebserverHTTPS.Enabled {

363 for from := range c.Dynamic.WebDNSDomainRedirects {

364 hostnames[from] = struct{}{}

365 }

366 for _, wh := range c.Dynamic.WebHandlers {

367 hostnames[wh.DNSDomain] = struct{}{}

368 }

369 }

370

371 public := c.Static.Listeners["public"]

372 ips := public.IPs

373 if len(public.NATIPs) > 0 {

374 ips = public.NATIPs

375 }

376 if public.IPsNATed {

377 ips = nil

378 }

379 m.SetAllowedHostnames(log, dns.StrictResolver{Pkg: "autotls", Log: log.Logger}, hostnames, ips, checkACMEHosts)

380 }

381}

382

383// todo future: write config parsing & writing code that can read a config and remembers the exact tokens including newlines and comments, and can write back a modified file. the goal is to be able to write a config file automatically (after changing fields through the ui), but not loose comments and whitespace, to still get useful diffs for storing the config in a version control system.

384

385// WriteDynamicLocked prepares an updated internal state for the new dynamic

386// config, then writes it to disk and activates it.

387//

388// Returns ErrConfig if the configuration is not valid.

389//

390// Must be called with config lock held.

391func WriteDynamicLocked(ctx context.Context, log mlog.Log, c config.Dynamic) error {

392 accDests, aliases, errs := prepareDynamicConfig(ctx, log, ConfigDynamicPath, Conf.Static, &c)

393 if len(errs) > 0 {

394 errstrs := make([]string, len(errs))

395 for i, err := range errs {

396 errstrs[i] = err.Error()

397 }

398 return fmt.Errorf("%w: %s", ErrConfig, strings.Join(errstrs, "; "))

399 }

400

401 var b bytes.Buffer

402 err := sconf.Write(&b, c)

403 if err != nil {

404 return err

405 }

406 f, err := os.OpenFile(ConfigDynamicPath, os.O_WRONLY, 0660)

407 if err != nil {

408 return err

409 }

410 defer func() {

411 if f != nil {

412 err := f.Close()

413 log.Check(err, "closing file after error")

414 }

415 }()

416 buf := b.Bytes()

417 if _, err := f.Write(buf); err != nil {

418 return fmt.Errorf("write domains.conf: %v", err)

419 }

420 if err := f.Truncate(int64(len(buf))); err != nil {

421 return fmt.Errorf("truncate domains.conf after write: %v", err)

422 }

423 if err := f.Sync(); err != nil {

424 return fmt.Errorf("sync domains.conf after write: %v", err)

425 }

426 if err := moxio.SyncDir(log, filepath.Dir(ConfigDynamicPath)); err != nil {

427 return fmt.Errorf("sync dir of domains.conf after write: %v", err)

428 }

429

430 fi, err := f.Stat()

431 if err != nil {

432 return fmt.Errorf("stat after writing domains.conf: %v", err)

433 }

434

435 if err := f.Close(); err != nil {

436 return fmt.Errorf("close written domains.conf: %v", err)

437 }

438 f = nil

439

440 Conf.dynamicMtime = fi.ModTime()

441 Conf.DynamicLastCheck = time.Now()

442 Conf.Dynamic = c

443 Conf.AccountDestinationsLocked = accDests

444 Conf.aliases = aliases

445

446 Conf.allowACMEHosts(log, true)

447

448 return nil

449}

450

451// MustLoadConfig loads the config, quitting on errors.

452func MustLoadConfig(doLoadTLSKeyCerts, checkACMEHosts bool) {

453 errs := LoadConfig(context.Background(), pkglog, doLoadTLSKeyCerts, checkACMEHosts)

454 if len(errs) > 1 {

455 pkglog.Error("loading config file: multiple errors")

456 for _, err := range errs {

457 pkglog.Errorx("config error", err)

458 }

459 pkglog.Fatal("stopping after multiple config errors")

460 } else if len(errs) == 1 {

461 pkglog.Fatalx("loading config file", errs[0])

462 }

463}

464

465// LoadConfig attempts to parse and load a config, returning any errors

466// encountered.

467func LoadConfig(ctx context.Context, log mlog.Log, doLoadTLSKeyCerts, checkACMEHosts bool) []error {

468 Shutdown, ShutdownCancel = context.WithCancel(context.Background())

469 Context, ContextCancel = context.WithCancel(context.Background())

470

471 c, errs := ParseConfig(ctx, log, ConfigStaticPath, false, doLoadTLSKeyCerts, checkACMEHosts)

472 if len(errs) > 0 {

473 return errs

474 }

475

476 mlog.SetConfig(c.Log)

477 SetConfig(c)

478 return nil

479}

480

481// SetConfig sets a new config. Not to be used during normal operation.

482func SetConfig(c *Config) {

483 // Cannot just assign *c to Conf, it would copy the mutex.

484 Conf = Config{c.Static, sync.Mutex{}, c.Log, sync.Mutex{}, c.Dynamic, c.dynamicMtime, c.DynamicLastCheck, c.AccountDestinationsLocked, c.aliases}

485

486 // If we have non-standard CA roots, use them for all HTTPS requests.

487 if Conf.Static.TLS.CertPool != nil {

488 http.DefaultTransport.(*http.Transport).TLSClientConfig = &tls.Config{

489 RootCAs: Conf.Static.TLS.CertPool,

490 }

491 }

492

493 SetPedantic(c.Static.Pedantic)

494}

495

496// Set pedantic in all packages.

497func SetPedantic(p bool) {

498 dkim.Pedantic = p

499 dns.Pedantic = p

500 message.Pedantic = p

501 smtp.Pedantic = p

502 Pedantic = p

503}

504

505// ParseConfig parses the static config at path p. If checkOnly is true, no changes

506// are made, such as registering ACME identities. If doLoadTLSKeyCerts is true,

507// the TLS KeyCerts configuration is loaded and checked. This is used during the

508// quickstart in the case the user is going to provide their own certificates.

509// If checkACMEHosts is true, the hosts allowed for acme are compared with the

510// explicitly configured ips we are listening on.

511func ParseConfig(ctx context.Context, log mlog.Log, p string, checkOnly, doLoadTLSKeyCerts, checkACMEHosts bool) (c *Config, errs []error) {

512 c = &Config{

513 Static: config.Static{

514 DataDir: ".",

515 },

516 }

517

518 f, err := os.Open(p)

519 if err != nil {

520 if os.IsNotExist(err) && os.Getenv("MOXCONF") == "" {

521 return nil, []error{fmt.Errorf("open config file: %v (hint: use mox -config ... or set MOXCONF=...)", err)}

522 }

523 return nil, []error{fmt.Errorf("open config file: %v", err)}

524 }

525 defer f.Close()

526 if err := sconf.Parse(f, &c.Static); err != nil {

527 return nil, []error{fmt.Errorf("parsing %s%v", p, err)}

528 }

529

530 if xerrs := PrepareStaticConfig(ctx, log, p, c, checkOnly, doLoadTLSKeyCerts); len(xerrs) > 0 {

531 return nil, xerrs

532 }

533

534 pp := filepath.Join(filepath.Dir(p), "domains.conf")

535 c.Dynamic, c.dynamicMtime, c.AccountDestinationsLocked, c.aliases, errs = ParseDynamicConfig(ctx, log, pp, c.Static)

536

537 if !checkOnly {

538 c.allowACMEHosts(log, checkACMEHosts)

539 }

540

541 return c, errs

542}

543

544// PrepareStaticConfig parses the static config file and prepares data structures

545// for starting mox. If checkOnly is set no substantial changes are made, like

546// creating an ACME registration.

547func PrepareStaticConfig(ctx context.Context, log mlog.Log, configFile string, conf *Config, checkOnly, doLoadTLSKeyCerts bool) (errs []error) {

548 addErrorf := func(format string, args ...any) {

549 errs = append(errs, fmt.Errorf(format, args...))

550 }

551

552 c := &conf.Static

553

554 // check that mailbox is in unicode NFC normalized form.

555 checkMailboxNormf := func(mailbox string, format string, args ...any) {

556 s := norm.NFC.String(mailbox)

557 if mailbox != s {

558 msg := fmt.Sprintf(format, args...)

559 addErrorf("%s: mailbox %q is not in NFC normalized form, should be %q", msg, mailbox, s)

560 }

561 }

562

563 // Post-process logging config.

564 if logLevel, ok := mlog.Levels[c.LogLevel]; ok {

565 conf.Log = map[string]slog.Level{"": logLevel}

566 } else {

567 addErrorf("invalid log level %q", c.LogLevel)

568 }

569 for pkg, s := range c.PackageLogLevels {

570 if logLevel, ok := mlog.Levels[s]; ok {

571 conf.Log[pkg] = logLevel

572 } else {

573 addErrorf("invalid package log level %q", s)

574 }

575 }

576

577 if c.User == "" {

578 c.User = "mox"

579 }

580 u, err := user.Lookup(c.User)

581 if err != nil {

582 uid, err := strconv.ParseUint(c.User, 10, 32)

583 if err != nil {

584 addErrorf("parsing unknown user %s as uid: %v (hint: add user mox with \"useradd -d $PWD mox\" or specify a different username on the quickstart command-line)", c.User, err)

585 } else {

586 // We assume the same gid as uid.

587 c.UID = uint32(uid)

588 c.GID = uint32(uid)

589 }

590 } else {

591 if uid, err := strconv.ParseUint(u.Uid, 10, 32); err != nil {

592 addErrorf("parsing uid %s: %v", u.Uid, err)

593 } else {

594 c.UID = uint32(uid)

595 }

596 if gid, err := strconv.ParseUint(u.Gid, 10, 32); err != nil {

597 addErrorf("parsing gid %s: %v", u.Gid, err)

598 } else {

599 c.GID = uint32(gid)

600 }

601 }

602

603 hostname, err := dns.ParseDomain(c.Hostname)

604 if err != nil {

605 addErrorf("parsing hostname: %s", err)

606 } else if hostname.Name() != c.Hostname {

607 addErrorf("hostname must be in unicode form %q instead of %q", hostname.Name(), c.Hostname)

608 }

609 c.HostnameDomain = hostname

610

611 if c.HostTLSRPT.Account != "" {

612 tlsrptLocalpart, err := smtp.ParseLocalpart(c.HostTLSRPT.Localpart)

613 if err != nil {

614 addErrorf("invalid localpart %q for host tlsrpt: %v", c.HostTLSRPT.Localpart, err)

615 } else if tlsrptLocalpart.IsInternational() {

616 // Does not appear documented in ../rfc/8460, but similar to DMARC it makes sense

617 // to keep this ascii-only addresses.

618 addErrorf("host TLSRPT localpart %q is an internationalized address, only conventional ascii-only address allowed for interopability", tlsrptLocalpart)

619 }

620 c.HostTLSRPT.ParsedLocalpart = tlsrptLocalpart

621 }

622

623 // Return private key for host name for use with an ACME. Used to return the same

624 // private key as pre-generated for use with DANE, with its public key in DNS.

625 // We only use this key for Listener's that have this ACME configured, and for

626 // which the effective listener host name (either specific to the listener, or the

627 // global name) is requested. Other host names can get a fresh private key, they

628 // don't appear in DANE records.

629 //

630 // - run 0: only use listener with explicitly matching host name in listener

631 // (default quickstart config does not set it).

632 // - run 1: only look at public listener (and host matching mox host name)

633 // - run 2: all listeners (and host matching mox host name)

634 findACMEHostPrivateKey := func(acmeName, host string, keyType autocert.KeyType, run int) crypto.Signer {

635 for listenerName, l := range Conf.Static.Listeners {

636 if l.TLS == nil || l.TLS.ACME != acmeName {

637 continue

638 }

639 if run == 0 && host != l.HostnameDomain.ASCII {

640 continue

641 }

642 if run == 1 && listenerName != "public" || host != Conf.Static.HostnameDomain.ASCII {

643 continue

644 }

645 switch keyType {

646 case autocert.KeyRSA2048:

647 if len(l.TLS.HostPrivateRSA2048Keys) == 0 {

648 continue

649 }

650 return l.TLS.HostPrivateRSA2048Keys[0]

651 case autocert.KeyECDSAP256:

652 if len(l.TLS.HostPrivateECDSAP256Keys) == 0 {

653 continue

654 }

655 return l.TLS.HostPrivateECDSAP256Keys[0]

656 default:

657 return nil

658 }

659 }

660 return nil

661 }

662 // Make a function for an autocert.Manager.GetPrivateKey, using findACMEHostPrivateKey.

663 makeGetPrivateKey := func(acmeName string) func(host string, keyType autocert.KeyType) (crypto.Signer, error) {

664 return func(host string, keyType autocert.KeyType) (crypto.Signer, error) {

665 key := findACMEHostPrivateKey(acmeName, host, keyType, 0)

666 if key == nil {

667 key = findACMEHostPrivateKey(acmeName, host, keyType, 1)

668 }

669 if key == nil {

670 key = findACMEHostPrivateKey(acmeName, host, keyType, 2)

671 }

672 if key != nil {

673 log.Debug("found existing private key for certificate for host",

674 slog.String("acmename", acmeName),

675 slog.String("host", host),

676 slog.Any("keytype", keyType))

677 return key, nil

678 }

679 log.Debug("generating new private key for certificate for host",

680 slog.String("acmename", acmeName),

681 slog.String("host", host),

682 slog.Any("keytype", keyType))

683 switch keyType {

684 case autocert.KeyRSA2048:

685 return rsa.GenerateKey(cryptorand.Reader, 2048)

686 case autocert.KeyECDSAP256:

687 return ecdsa.GenerateKey(elliptic.P256(), cryptorand.Reader)

688 default:

689 return nil, fmt.Errorf("unrecognized requested key type %v", keyType)

690 }

691 }

692 }

693 for name, acme := range c.ACME {

694 addAcmeErrorf := func(format string, args ...any) {

695 addErrorf("acme provider %s: %s", name, fmt.Sprintf(format, args...))

696 }

697

698 var eabKeyID string

699 var eabKey []byte

700 if acme.ExternalAccountBinding != nil {

701 eabKeyID = acme.ExternalAccountBinding.KeyID

702 p := configDirPath(configFile, acme.ExternalAccountBinding.KeyFile)

703 buf, err := os.ReadFile(p)

704 if err != nil {

705 addAcmeErrorf("reading external account binding key: %s", err)

706 } else {

707 dec := make([]byte, base64.RawURLEncoding.DecodedLen(len(buf)))

708 n, err := base64.RawURLEncoding.Decode(dec, buf)

709 if err != nil {

710 addAcmeErrorf("parsing external account binding key as base64: %s", err)

711 } else {

712 eabKey = dec[:n]

713 }

714 }

715 }

716

717 if checkOnly {

718 continue

719 }

720

721 acmeDir := dataDirPath(configFile, c.DataDir, "acme")

722 os.MkdirAll(acmeDir, 0770)

723 manager, err := autotls.Load(log, name, acmeDir, acme.ContactEmail, acme.DirectoryURL, eabKeyID, eabKey, makeGetPrivateKey(name), Shutdown.Done())

724 if err != nil {

725 addAcmeErrorf("loading ACME identity: %s", err)

726 }

727 acme.Manager = manager

728

729 // Help configurations from older quickstarts.

730 if acme.IssuerDomainName == "" && acme.DirectoryURL == "https://acme-v02.api.letsencrypt.org/directory" {

731 acme.IssuerDomainName = "letsencrypt.org"

732 }

733

734 c.ACME[name] = acme

735 }

736

737 var haveUnspecifiedSMTPListener bool

738 for name, l := range c.Listeners {

739 addListenerErrorf := func(format string, args ...any) {

740 addErrorf("listener %s: %s", name, fmt.Sprintf(format, args...))

741 }

742

743 if l.Hostname != "" {

744 d, err := dns.ParseDomain(l.Hostname)

745 if err != nil {

746 addListenerErrorf("parsing hostname %q: %s", l.Hostname, err)

747 }

748 l.HostnameDomain = d

749 }

750 if l.TLS != nil {

751 if l.TLS.ACME != "" && len(l.TLS.KeyCerts) != 0 {

752 addListenerErrorf("cannot have ACME and static key/certificates")

753 } else if l.TLS.ACME != "" {

754 acme, ok := c.ACME[l.TLS.ACME]

755 if !ok {

756 addListenerErrorf("unknown ACME provider %q", l.TLS.ACME)

757 }

758

759 // If only checking or with missing ACME definition, we don't have an acme manager,

760 // so set an empty tls config to continue.

761 var tlsconfig, tlsconfigFallback *tls.Config

762 if checkOnly || acme.Manager == nil {

763 tlsconfig = &tls.Config{}

764 tlsconfigFallback = &tls.Config{}

765 } else {

766 hostname := c.HostnameDomain

767 if l.Hostname != "" {

768 hostname = l.HostnameDomain

769 }

770 // If SNI is absent, we will use the listener hostname, but reject connections with

771 // an SNI hostname that is not allowlisted.

772 // Incoming SMTP deliveries use tlsconfigFallback for interoperability. TLS

773 // connections for unknown SNI hostnames fall back to a certificate for the

774 // listener hostname instead of causing the TLS connection to fail.

775 tlsconfig = acme.Manager.TLSConfig(hostname, true, false)

776 tlsconfigFallback = acme.Manager.TLSConfig(hostname, true, true)

777 l.TLS.ACMEConfig = acme.Manager.ACMETLSConfig

778 }

779 l.TLS.Config = tlsconfig

780 l.TLS.ConfigFallback = tlsconfigFallback

781 } else if len(l.TLS.KeyCerts) != 0 {

782 if doLoadTLSKeyCerts {

783 if err := loadTLSKeyCerts(configFile, "listener "+name, l.TLS); err != nil {

784 addListenerErrorf("%w", err)

785 }

786 }

787 } else {

788 addListenerErrorf("cannot have TLS config without ACME and without static keys/certificates")

789 }

790 for _, privKeyFile := range l.TLS.HostPrivateKeyFiles {

791 keyPath := configDirPath(configFile, privKeyFile)

792 privKey, err := loadPrivateKeyFile(keyPath)

793 if err != nil {

794 addListenerErrorf("parsing host private key for DANE and ACME certificates: %v", err)

795 continue

796 }

797 switch k := privKey.(type) {

798 case *rsa.PrivateKey:

799 if k.N.BitLen() != 2048 {

800 log.Error("need rsa key with 2048 bits, for host private key for DANE/ACME certificates, ignoring",

801 slog.String("listener", name),

802 slog.String("file", keyPath),

803 slog.Int("bits", k.N.BitLen()))

804 continue

805 }

806 l.TLS.HostPrivateRSA2048Keys = append(l.TLS.HostPrivateRSA2048Keys, k)

807 case *ecdsa.PrivateKey:

808 if k.Curve != elliptic.P256() {

809 log.Error("unrecognized ecdsa curve for host private key for DANE/ACME certificates, ignoring", slog.String("listener", name), slog.String("file", keyPath))

810 continue

811 }

812 l.TLS.HostPrivateECDSAP256Keys = append(l.TLS.HostPrivateECDSAP256Keys, k)

813 default:

814 log.Error("unrecognized key type for host private key for DANE/ACME certificates, ignoring",

815 slog.String("listener", name),

816 slog.String("file", keyPath),

817 slog.String("keytype", fmt.Sprintf("%T", privKey)))

818 continue

819 }

820 }

821 if l.TLS.ACME != "" && (len(l.TLS.HostPrivateRSA2048Keys) == 0) != (len(l.TLS.HostPrivateECDSAP256Keys) == 0) {

822 log.Warn("uncommon configuration with either only an RSA 2048 or ECDSA P256 host private key for DANE/ACME certificates; this ACME implementation can retrieve certificates for both type of keys, it is recommended to set either both or none; continuing")

823 }

824

825 // TLS 1.2 was introduced in 2008. TLS <1.2 was deprecated by ../rfc/8996:31 and ../rfc/8997:66 in 2021.

826 var minVersion uint16 = tls.VersionTLS12

827 if l.TLS.MinVersion != "" {

828 versions := map[string]uint16{

829 "TLSv1.0": tls.VersionTLS10,

830 "TLSv1.1": tls.VersionTLS11,

831 "TLSv1.2": tls.VersionTLS12,

832 "TLSv1.3": tls.VersionTLS13,

833 }

834 v, ok := versions[l.TLS.MinVersion]

835 if !ok {

836 addListenerErrorf("unknown TLS mininum version %q", l.TLS.MinVersion)

837 }

838 minVersion = v

839 }

840 if l.TLS.Config != nil {

841 l.TLS.Config.MinVersion = minVersion

842 }

843 if l.TLS.ConfigFallback != nil {

844 l.TLS.ConfigFallback.MinVersion = minVersion

845 }

846 if l.TLS.ACMEConfig != nil {

847 l.TLS.ACMEConfig.MinVersion = minVersion

848 }

849 } else {

850 var needsTLS []string

851 needtls := func(s string, v bool) {

852 if v {

853 needsTLS = append(needsTLS, s)

854 }

855 }

856 needtls("IMAPS", l.IMAPS.Enabled)

857 needtls("SMTP", l.SMTP.Enabled && !l.SMTP.NoSTARTTLS)

858 needtls("Submissions", l.Submissions.Enabled)

859 needtls("Submission", l.Submission.Enabled && !l.Submission.NoRequireSTARTTLS)

860 needtls("AccountHTTPS", l.AccountHTTPS.Enabled)

861 needtls("AdminHTTPS", l.AdminHTTPS.Enabled)

862 needtls("AutoconfigHTTPS", l.AutoconfigHTTPS.Enabled && !l.AutoconfigHTTPS.NonTLS)

863 needtls("MTASTSHTTPS", l.MTASTSHTTPS.Enabled && !l.MTASTSHTTPS.NonTLS)

864 needtls("WebserverHTTPS", l.WebserverHTTPS.Enabled)

865 if len(needsTLS) > 0 {

866 addListenerErrorf("no tls config specified, but requires tls for %s", strings.Join(needsTLS, ", "))

867 }

868 }

869 if l.AutoconfigHTTPS.Enabled && l.MTASTSHTTPS.Enabled && l.AutoconfigHTTPS.Port == l.MTASTSHTTPS.Port && l.AutoconfigHTTPS.NonTLS != l.MTASTSHTTPS.NonTLS {

870 addListenerErrorf("autoconfig and mta-sts enabled on same port but with both http and https")

871 }

872 if l.SMTP.Enabled {

873 if len(l.IPs) == 0 {

874 haveUnspecifiedSMTPListener = true

875 }

876 for _, ipstr := range l.IPs {

877 ip := net.ParseIP(ipstr)

878 if ip == nil {

879 addListenerErrorf("invalid IP %q", ipstr)

880 continue

881 }

882 if ip.IsUnspecified() {

883 haveUnspecifiedSMTPListener = true

884 break

885 }

886 if len(c.SpecifiedSMTPListenIPs) >= 2 {

887 haveUnspecifiedSMTPListener = true

888 } else if len(c.SpecifiedSMTPListenIPs) > 0 && (c.SpecifiedSMTPListenIPs[0].To4() == nil) == (ip.To4() == nil) {

889 haveUnspecifiedSMTPListener = true

890 } else {

891 c.SpecifiedSMTPListenIPs = append(c.SpecifiedSMTPListenIPs, ip)

892 }

893 }

894 }

895 for _, s := range l.SMTP.DNSBLs {

896 d, err := dns.ParseDomain(s)

897 if err != nil {

898 addListenerErrorf("parsing DNSBL zone %q: %s", s, err)

899 continue

900 }

901 l.SMTP.DNSBLZones = append(l.SMTP.DNSBLZones, d)

902 }

903 if l.IPsNATed && len(l.NATIPs) > 0 {

904 addListenerErrorf("both IPsNATed and NATIPs configued (remove deprecated IPsNATed)")

905 }

906 for _, ipstr := range l.NATIPs {

907 ip := net.ParseIP(ipstr)

908 if ip == nil {

909 addListenerErrorf("invalid ip %q", ipstr)

910 } else if ip.IsUnspecified() || ip.IsLoopback() {

911 addListenerErrorf("NAT ip that is the unspecified or loopback address %s", ipstr)

912 }

913 }

914 cleanPath := func(kind string, enabled bool, path string) string {

915 if !enabled {

916 return path

917 }

918 if path != "" && !strings.HasPrefix(path, "/") {

919 addListenerErrorf("%s with path %q that must start with a slash", kind, path)

920 } else if path != "" && !strings.HasSuffix(path, "/") {

921 log.Warn("http service path should end with a slash, using effective path with slash", slog.String("kind", kind), slog.String("path", path), slog.String("effectivepath", path+"/"))

922 path += "/"

923 }

924 return path

925 }

926 l.AccountHTTP.Path = cleanPath("AccountHTTP", l.AccountHTTP.Enabled, l.AccountHTTP.Path)

927 l.AccountHTTPS.Path = cleanPath("AccountHTTPS", l.AccountHTTPS.Enabled, l.AccountHTTPS.Path)

928 l.AdminHTTP.Path = cleanPath("AdminHTTP", l.AdminHTTP.Enabled, l.AdminHTTP.Path)

929 l.AdminHTTPS.Path = cleanPath("AdminHTTPS", l.AdminHTTPS.Enabled, l.AdminHTTPS.Path)

930 l.WebmailHTTP.Path = cleanPath("WebmailHTTP", l.WebmailHTTP.Enabled, l.WebmailHTTP.Path)

931 l.WebmailHTTPS.Path = cleanPath("WebmailHTTPS", l.WebmailHTTPS.Enabled, l.WebmailHTTPS.Path)

932 l.WebAPIHTTP.Path = cleanPath("WebAPIHTTP", l.WebAPIHTTP.Enabled, l.WebAPIHTTP.Path)

933 l.WebAPIHTTPS.Path = cleanPath("WebAPIHTTPS", l.WebAPIHTTPS.Enabled, l.WebAPIHTTPS.Path)

934 c.Listeners[name] = l

935 }

936 if haveUnspecifiedSMTPListener {

937 c.SpecifiedSMTPListenIPs = nil

938 }

939

940 var zerouse config.SpecialUseMailboxes

941 if len(c.DefaultMailboxes) > 0 && (c.InitialMailboxes.SpecialUse != zerouse || len(c.InitialMailboxes.Regular) > 0) {

942 addErrorf("cannot have both DefaultMailboxes and InitialMailboxes")

943 }

944 // DefaultMailboxes is deprecated.

945 for _, mb := range c.DefaultMailboxes {

946 checkMailboxNormf(mb, "default mailbox")

947 // We don't create parent mailboxes for default mailboxes.

948 if ParentMailboxName(mb) != "" {

949 addErrorf("default mailbox cannot be a child mailbox")

950 }

951 }

952 checkSpecialUseMailbox := func(nameOpt string) {

953 if nameOpt != "" {

954 checkMailboxNormf(nameOpt, "special-use initial mailbox")

955 if strings.EqualFold(nameOpt, "inbox") {

956 addErrorf("initial mailbox cannot be set to Inbox (Inbox is always created)")

957 }

958 // We don't currently create parent mailboxes for initial mailboxes.

959 if ParentMailboxName(nameOpt) != "" {

960 addErrorf("initial mailboxes cannot be child mailboxes")

961 }

962 }

963 }

964 checkSpecialUseMailbox(c.InitialMailboxes.SpecialUse.Archive)

965 checkSpecialUseMailbox(c.InitialMailboxes.SpecialUse.Draft)

966 checkSpecialUseMailbox(c.InitialMailboxes.SpecialUse.Junk)

967 checkSpecialUseMailbox(c.InitialMailboxes.SpecialUse.Sent)

968 checkSpecialUseMailbox(c.InitialMailboxes.SpecialUse.Trash)

969 for _, name := range c.InitialMailboxes.Regular {

970 checkMailboxNormf(name, "regular initial mailbox")

971 if strings.EqualFold(name, "inbox") {

972 addErrorf("initial regular mailbox cannot be set to Inbox (Inbox is always created)")

973 }

974 if ParentMailboxName(name) != "" {

975 addErrorf("initial mailboxes cannot be child mailboxes")

976 }

977 }

978

979 checkTransportSMTP := func(name string, isTLS bool, t *config.TransportSMTP) {

980 addTransportErrorf := func(format string, args ...any) {

981 addErrorf("transport %s: %s", name, fmt.Sprintf(format, args...))

982 }

983

984 var err error

985 t.DNSHost, err = dns.ParseDomain(t.Host)

986 if err != nil {

987 addTransportErrorf("bad host %s: %v", t.Host, err)

988 }

989

990 if isTLS && t.STARTTLSInsecureSkipVerify {

991 addTransportErrorf("cannot have STARTTLSInsecureSkipVerify with immediate TLS")

992 }

993 if isTLS && t.NoSTARTTLS {

994 addTransportErrorf("cannot have NoSTARTTLS with immediate TLS")

995 }

996

997 if t.Auth == nil {

998 return

999 }

1000 seen := map[string]bool{}

1001 for _, m := range t.Auth.Mechanisms {

1002 if seen[m] {

1003 addTransportErrorf("duplicate authentication mechanism %s", m)

1004 }

1005 seen[m] = true

1006 switch m {

1007 case "SCRAM-SHA-256-PLUS":

1008 case "SCRAM-SHA-256":

1009 case "SCRAM-SHA-1-PLUS":

1010 case "SCRAM-SHA-1":

1011 case "CRAM-MD5":

1012 case "PLAIN":

1013 default:

1014 addTransportErrorf("unknown authentication mechanism %s", m)

1015 }

1016 }

1017

1018 t.Auth.EffectiveMechanisms = t.Auth.Mechanisms

1019 if len(t.Auth.EffectiveMechanisms) == 0 {

1020 t.Auth.EffectiveMechanisms = []string{"SCRAM-SHA-256-PLUS", "SCRAM-SHA-256", "SCRAM-SHA-1-PLUS", "SCRAM-SHA-1", "CRAM-MD5"}

1021 }

1022 }

1023

1024 checkTransportSocks := func(name string, t *config.TransportSocks) {

1025 addTransportErrorf := func(format string, args ...any) {

1026 addErrorf("transport %s: %s", name, fmt.Sprintf(format, args...))

1027 }

1028

1029 _, _, err := net.SplitHostPort(t.Address)

1030 if err != nil {

1031 addTransportErrorf("bad address %s: %v", t.Address, err)

1032 }

1033 for _, ipstr := range t.RemoteIPs {

1034 ip := net.ParseIP(ipstr)

1035 if ip == nil {

1036 addTransportErrorf("bad ip %s", ipstr)

1037 } else {

1038 t.IPs = append(t.IPs, ip)

1039 }

1040 }

1041 t.Hostname, err = dns.ParseDomain(t.RemoteHostname)

1042 if err != nil {

1043 addTransportErrorf("bad hostname %s: %v", t.RemoteHostname, err)

1044 }

1045 }

1046

1047 checkTransportDirect := func(name string, t *config.TransportDirect) {

1048 addTransportErrorf := func(format string, args ...any) {

1049 addErrorf("transport %s: %s", name, fmt.Sprintf(format, args...))

1050 }

1051

1052 if t.DisableIPv4 && t.DisableIPv6 {

1053 addTransportErrorf("both IPv4 and IPv6 are disabled, enable at least one")

1054 }

1055 t.IPFamily = "ip"

1056 if t.DisableIPv4 {

1057 t.IPFamily = "ip6"

1058 }

1059 if t.DisableIPv6 {

1060 t.IPFamily = "ip4"

1061 }

1062 }

1063

1064 checkTransportFail := func(name string, t *config.TransportFail) {

1065 addTransportErrorf := func(format string, args ...any) {

1066 addErrorf("transport %s: %s", name, fmt.Sprintf(format, args...))

1067 }

1068

1069 if t.SMTPCode == 0 {

1070 t.Code = smtp.C554TransactionFailed

1071 } else if t.SMTPCode/100 != 4 && t.SMTPCode/100 != 5 {

1072 addTransportErrorf("smtp code %d must be 4xx or 5xx", t.SMTPCode/100)

1073 } else {

1074 t.Code = t.SMTPCode

1075 }

1076

1077 if len(t.SMTPMessage) > 256 {

1078 addTransportErrorf("message must be <= 256 characters")

1079 }

1080 for _, c := range t.SMTPMessage {

1081 if c < ' ' || c >= 0x7f {

1082 addTransportErrorf("message cannot contain control characters including newlines, and must be ascii-only")

1083 }

1084 }

1085 t.Message = t.SMTPMessage

1086 if t.Message == "" {

1087 t.Message = "transport fail: explicit immediate delivery failure per configuration"

1088 }

1089 }

1090

1091 for name, t := range c.Transports {

1092 addTransportErrorf := func(format string, args ...any) {

1093 addErrorf("transport %s: %s", name, fmt.Sprintf(format, args...))

1094 }

1095

1096 n := 0

1097 if t.Submissions != nil {

1098 n++

1099 checkTransportSMTP(name, true, t.Submissions)

1100 }

1101 if t.Submission != nil {

1102 n++

1103 checkTransportSMTP(name, false, t.Submission)

1104 }

1105 if t.SMTP != nil {

1106 n++

1107 checkTransportSMTP(name, false, t.SMTP)

1108 }

1109 if t.Socks != nil {

1110 n++

1111 checkTransportSocks(name, t.Socks)

1112 }

1113 if t.Direct != nil {

1114 n++

1115 checkTransportDirect(name, t.Direct)

1116 }

1117 if t.Fail != nil {

1118 n++

1119 checkTransportFail(name, t.Fail)

1120 }

1121 if n > 1 {

1122 addTransportErrorf("cannot have multiple methods in a transport")

1123 }

1124 }

1125

1126 // Load CA certificate pool.

1127 if c.TLS.CA != nil {

1128 if c.TLS.CA.AdditionalToSystem {

1129 var err error

1130 c.TLS.CertPool, err = x509.SystemCertPool()

1131 if err != nil {

1132 addErrorf("fetching system CA cert pool: %v", err)

1133 }

1134 } else {

1135 c.TLS.CertPool = x509.NewCertPool()

1136 }

1137 for _, certfile := range c.TLS.CA.CertFiles {

1138 p := configDirPath(configFile, certfile)

1139 pemBuf, err := os.ReadFile(p)

1140 if err != nil {

1141 addErrorf("reading TLS CA cert file: %v", err)

1142 continue

1143 } else if !c.TLS.CertPool.AppendCertsFromPEM(pemBuf) {

1144 // todo: can we check more fully if we're getting some useful data back?

1145 addErrorf("no CA certs added from %q", p)

1146 }

1147 }

1148 }

1149 return

1150}

1151

1152// PrepareDynamicConfig parses the dynamic config file given a static file.

1153func ParseDynamicConfig(ctx context.Context, log mlog.Log, dynamicPath string, static config.Static) (c config.Dynamic, mtime time.Time, accDests map[string]AccountDestination, aliases map[string]config.Alias, errs []error) {

1154 addErrorf := func(format string, args ...any) {

1155 errs = append(errs, fmt.Errorf(format, args...))

1156 }

1157

1158 f, err := os.Open(dynamicPath)

1159 if err != nil {

1160 addErrorf("parsing domains config: %v", err)

1161 return

1162 }

1163 defer f.Close()

1164 fi, err := f.Stat()

1165 if err != nil {

1166 addErrorf("stat domains config: %v", err)

1167 }

1168 if err := sconf.Parse(f, &c); err != nil {

1169 addErrorf("parsing dynamic config file: %v", err)

1170 return

1171 }

1172

1173 accDests, aliases, errs = prepareDynamicConfig(ctx, log, dynamicPath, static, &c)

1174 return c, fi.ModTime(), accDests, aliases, errs

1175}

1176

1177func prepareDynamicConfig(ctx context.Context, log mlog.Log, dynamicPath string, static config.Static, c *config.Dynamic) (accDests map[string]AccountDestination, aliases map[string]config.Alias, errs []error) {

1178 addErrorf := func(format string, args ...any) {

1179 errs = append(errs, fmt.Errorf(format, args...))

1180 }

1181

1182 // Check that mailbox is in unicode NFC normalized form.

1183 checkMailboxNormf := func(mailbox string, what string, errorf func(format string, args ...any)) {

1184 s := norm.NFC.String(mailbox)

1185 if mailbox != s {

1186 errorf("%s: mailbox %q is not in NFC normalized form, should be %q", what, mailbox, s)

1187 }

1188 }

1189

1190 // Validate postmaster account exists.

1191 if _, ok := c.Accounts[static.Postmaster.Account]; !ok {

1192 addErrorf("postmaster account %q does not exist", static.Postmaster.Account)

1193 }

1194 checkMailboxNormf(static.Postmaster.Mailbox, "postmaster mailbox", addErrorf)

1195

1196 accDests = map[string]AccountDestination{}

1197 aliases = map[string]config.Alias{}

1198

1199 // Validate host TLSRPT account/address.

1200 if static.HostTLSRPT.Account != "" {

1201 if _, ok := c.Accounts[static.HostTLSRPT.Account]; !ok {

1202 addErrorf("host tlsrpt account %q does not exist", static.HostTLSRPT.Account)

1203 }

1204 checkMailboxNormf(static.HostTLSRPT.Mailbox, "host tlsrpt mailbox", addErrorf)

1205

1206 // Localpart has been parsed already.

1207

1208 addrFull := smtp.NewAddress(static.HostTLSRPT.ParsedLocalpart, static.HostnameDomain).String()

1209 dest := config.Destination{

1210 Mailbox: static.HostTLSRPT.Mailbox,

1211 HostTLSReports: true,

1212 }

1213 accDests[addrFull] = AccountDestination{false, static.HostTLSRPT.ParsedLocalpart, static.HostTLSRPT.Account, dest}

1214 }

1215

1216 var haveSTSListener, haveWebserverListener bool

1217 for _, l := range static.Listeners {

1218 if l.MTASTSHTTPS.Enabled {

1219 haveSTSListener = true

1220 }

1221 if l.WebserverHTTP.Enabled || l.WebserverHTTPS.Enabled {

1222 haveWebserverListener = true

1223 }

1224 }

1225

1226 checkRoutes := func(descr string, routes []config.Route) {

1227 parseRouteDomains := func(l []string) []string {

1228 var r []string

1229 for _, e := range l {

1230 if e == "." {

1231 r = append(r, e)

1232 continue

1233 }

1234 prefix := ""

1235 if strings.HasPrefix(e, ".") {

1236 prefix = "."

1237 e = e[1:]

1238 }

1239 d, err := dns.ParseDomain(e)

1240 if err != nil {

1241 addErrorf("%s: invalid domain %s: %v", descr, e, err)

1242 }

1243 r = append(r, prefix+d.ASCII)

1244 }

1245 return r

1246 }

1247

1248 for i := range routes {

1249 routes[i].FromDomainASCII = parseRouteDomains(routes[i].FromDomain)

1250 routes[i].ToDomainASCII = parseRouteDomains(routes[i].ToDomain)

1251 var ok bool

1252 routes[i].ResolvedTransport, ok = static.Transports[routes[i].Transport]

1253 if !ok {

1254 addErrorf("%s: route references undefined transport %s", descr, routes[i].Transport)

1255 }

1256 }

1257 }

1258

1259 checkRoutes("global routes", c.Routes)

1260

1261 // Validate domains.

1262 c.ClientSettingDomains = map[dns.Domain]struct{}{}

1263 for d, domain := range c.Domains {

1264 addDomainErrorf := func(format string, args ...any) {

1265 addErrorf(fmt.Sprintf("domain %v: %s", d, fmt.Sprintf(format, args...)))

1266 }

1267

1268 dnsdomain, err := dns.ParseDomain(d)

1269 if err != nil {

1270 addDomainErrorf("parsing domain: %s", err)

1271 } else if dnsdomain.Name() != d {

1272 addDomainErrorf("must be specified in unicode form, %s", dnsdomain.Name())

1273 }

1274

1275 domain.Domain = dnsdomain

1276

1277 if domain.ClientSettingsDomain != "" {

1278 csd, err := dns.ParseDomain(domain.ClientSettingsDomain)

1279 if err != nil {

1280 addDomainErrorf("bad client settings domain %q: %s", domain.ClientSettingsDomain, err)

1281 }

1282 domain.ClientSettingsDNSDomain = csd

1283 c.ClientSettingDomains[csd] = struct{}{}

1284 }

1285

1286 if domain.LocalpartCatchallSeparator != "" && len(domain.LocalpartCatchallSeparators) != 0 {

1287 addDomainErrorf("cannot have both LocalpartCatchallSeparator and LocalpartCatchallSeparators")

1288 }

1289 domain.LocalpartCatchallSeparatorsEffective = domain.LocalpartCatchallSeparators

1290 if domain.LocalpartCatchallSeparator != "" {

1291 domain.LocalpartCatchallSeparatorsEffective = append(domain.LocalpartCatchallSeparatorsEffective, domain.LocalpartCatchallSeparator)

1292 }

1293 sepSeen := map[string]bool{}

1294 for _, sep := range domain.LocalpartCatchallSeparatorsEffective {

1295 if sepSeen[sep] {

1296 addDomainErrorf("duplicate localpart catchall separator %q", sep)

1297 }

1298 sepSeen[sep] = true

1299 }

1300

1301 for _, sign := range domain.DKIM.Sign {

1302 if _, ok := domain.DKIM.Selectors[sign]; !ok {

1303 addDomainErrorf("unknown selector %s for signing", sign)

1304 }

1305 }

1306 for name, sel := range domain.DKIM.Selectors {

1307 addSelectorErrorf := func(format string, args ...any) {

1308 addDomainErrorf("selector %s: %s", name, fmt.Sprintf(format, args...))

1309 }

1310

1311 seld, err := dns.ParseDomain(name)

1312 if err != nil {

1313 addSelectorErrorf("parsing selector: %s", err)

1314 } else if seld.Name() != name {

1315 addSelectorErrorf("must be specified in unicode form, %q", seld.Name())

1316 }

1317 sel.Domain = seld

1318

1319 if sel.Expiration != "" {

1320 exp, err := time.ParseDuration(sel.Expiration)

1321 if err != nil {

1322 addSelectorErrorf("invalid expiration %q: %v", sel.Expiration, err)

1323 } else {

1324 sel.ExpirationSeconds = int(exp / time.Second)

1325 }

1326 }

1327

1328 sel.HashEffective = sel.Hash

1329 switch sel.HashEffective {

1330 case "":

1331 sel.HashEffective = "sha256"

1332 case "sha1":

1333 log.Error("using sha1 with DKIM is deprecated as not secure enough, switch to sha256")

1334 case "sha256":

1335 default:

1336 addSelectorErrorf("unsupported hash %q", sel.HashEffective)

1337 }

1338

1339 pemBuf, err := os.ReadFile(configDirPath(dynamicPath, sel.PrivateKeyFile))

1340 if err != nil {

1341 addSelectorErrorf("reading private key: %s", err)

1342 continue

1343 }

1344 p, _ := pem.Decode(pemBuf)

1345 if p == nil {

1346 addSelectorErrorf("private key has no PEM block")

1347 continue

1348 }

1349 key, err := x509.ParsePKCS8PrivateKey(p.Bytes)

1350 if err != nil {

1351 addSelectorErrorf("parsing private key: %s", err)

1352 continue

1353 }

1354 switch k := key.(type) {

1355 case *rsa.PrivateKey:

1356 if k.N.BitLen() < 1024 {

1357 // ../rfc/6376:757

1358 // Let's help user do the right thing.

1359 addSelectorErrorf("rsa keys should be >= 1024 bits, is %d bits", k.N.BitLen())

1360 }

1361 sel.Key = k

1362 sel.Algorithm = fmt.Sprintf("rsa-%d", k.N.BitLen())

1363 case ed25519.PrivateKey:

1364 if sel.HashEffective != "sha256" {

1365 addSelectorErrorf("hash algorithm %q is not supported with ed25519, only sha256 is", sel.HashEffective)

1366 }

1367 sel.Key = k

1368 sel.Algorithm = "ed25519"

1369 default:

1370 addSelectorErrorf("private key type %T not yet supported", key)

1371 }

1372

1373 if len(sel.Headers) == 0 {

1374 // ../rfc/6376:2139

1375 // ../rfc/6376:2203

1376 // ../rfc/6376:2212

1377 // By default we seal signed headers, and we sign user-visible headers to

1378 // prevent/limit reuse of previously signed messages: All addressing fields, date

1379 // and subject, message-referencing fields, parsing instructions (content-type).

1380 sel.HeadersEffective = strings.Split("From,To,Cc,Bcc,Reply-To,References,In-Reply-To,Subject,Date,Message-Id,Content-Type", ",")

1381 } else {

1382 var from bool

1383 for _, h := range sel.Headers {

1384 from = from || strings.EqualFold(h, "From")

1385 // ../rfc/6376:2269

1386 if strings.EqualFold(h, "DKIM-Signature") || strings.EqualFold(h, "Received") || strings.EqualFold(h, "Return-Path") {

1387 log.Error("DKIM-signing header %q is recommended against as it may be modified in transit")

1388 }

1389 }

1390 if !from {

1391 addSelectorErrorf("From-field must always be DKIM-signed")

1392 }

1393 sel.HeadersEffective = sel.Headers

1394 }

1395

1396 domain.DKIM.Selectors[name] = sel

1397 }

1398

1399 if domain.MTASTS != nil {

1400 if !haveSTSListener {

1401 addDomainErrorf("MTA-STS enabled, but there is no listener for MTASTS", d)

1402 }

1403 sts := domain.MTASTS

1404 if sts.PolicyID == "" {

1405 addDomainErrorf("invalid empty MTA-STS PolicyID")

1406 }

1407 switch sts.Mode {

1408 case mtasts.ModeNone, mtasts.ModeTesting, mtasts.ModeEnforce:

1409 default:

1410 addDomainErrorf("invalid mtasts mode %q", sts.Mode)

1411 }

1412 }

1413

1414 checkRoutes("routes for domain", domain.Routes)

1415

1416 c.Domains[d] = domain

1417 }

1418

1419 // To determine ReportsOnly.

1420 domainHasAddress := map[string]bool{}

1421

1422 // Validate email addresses.

1423 for accName, acc := range c.Accounts {

1424 addAccountErrorf := func(format string, args ...any) {

1425 addErrorf("account %q: %s", accName, fmt.Sprintf(format, args...))

1426 }

1427

1428 var err error

1429 acc.DNSDomain, err = dns.ParseDomain(acc.Domain)

1430 if err != nil {

1431 addAccountErrorf("parsing domain %s: %s", acc.Domain, err)

1432 }

1433

1434 if strings.EqualFold(acc.RejectsMailbox, "Inbox") {

1435 addAccountErrorf("cannot set RejectsMailbox to inbox, messages will be removed automatically from the rejects mailbox")

1436 }

1437 checkMailboxNormf(acc.RejectsMailbox, "rejects mailbox", addErrorf)

1438

1439 if len(acc.LoginDisabled) > 256 {

1440 addAccountErrorf("message for disabled login must be <256 characters")

1441 }

1442 for _, c := range acc.LoginDisabled {

1443 // For IMAP and SMTP. IMAP only allows UTF8 after "ENABLE IMAPrev2".

1444 if c < ' ' || c >= 0x7f {

1445 addAccountErrorf("message cannot contain control characters including newlines, and must be ascii-only")

1446 }

1447 }

1448

1449 if acc.AutomaticJunkFlags.JunkMailboxRegexp != "" {

1450 r, err := regexp.Compile(acc.AutomaticJunkFlags.JunkMailboxRegexp)

1451 if err != nil {

1452 addAccountErrorf("invalid JunkMailboxRegexp regular expression: %v", err)

1453 }

1454 acc.JunkMailbox = r

1455 }

1456 if acc.AutomaticJunkFlags.NeutralMailboxRegexp != "" {

1457 r, err := regexp.Compile(acc.AutomaticJunkFlags.NeutralMailboxRegexp)

1458 if err != nil {

1459 addAccountErrorf("invalid NeutralMailboxRegexp regular expression: %v", err)

1460 }

1461 acc.NeutralMailbox = r

1462 }

1463 if acc.AutomaticJunkFlags.NotJunkMailboxRegexp != "" {

1464 r, err := regexp.Compile(acc.AutomaticJunkFlags.NotJunkMailboxRegexp)

1465 if err != nil {

1466 addAccountErrorf("invalid NotJunkMailboxRegexp regular expression: %v", err)

1467 }

1468 acc.NotJunkMailbox = r

1469 }

1470

1471 if acc.JunkFilter != nil {

1472 params := acc.JunkFilter.Params

1473 if params.MaxPower < 0 || params.MaxPower > 0.5 {

1474 addAccountErrorf("junk filter MaxPower must be >= 0 and < 0.5")

1475 }

1476 if params.TopWords < 0 {

1477 addAccountErrorf("junk filter TopWords must be >= 0")

1478 }

1479 if params.IgnoreWords < 0 || params.IgnoreWords > 0.5 {

1480 addAccountErrorf("junk filter IgnoreWords must be >= 0 and < 0.5")

1481 }

1482 if params.RareWords < 0 {

1483 addAccountErrorf("junk filter RareWords must be >= 0")

1484 }

1485 }

1486

1487 acc.ParsedFromIDLoginAddresses = make([]smtp.Address, len(acc.FromIDLoginAddresses))

1488 for i, s := range acc.FromIDLoginAddresses {

1489 a, err := smtp.ParseAddress(s)

1490 if err != nil {

1491 addAccountErrorf("invalid fromid login address %q: %v", s, err)

1492 }

1493 // We check later on if address belongs to account.

1494 dom, ok := c.Domains[a.Domain.Name()]

1495 if !ok {

1496 addAccountErrorf("unknown domain in fromid login address %q", s)

1497 } else if len(dom.LocalpartCatchallSeparatorsEffective) == 0 {

1498 addAccountErrorf("localpart catchall separator not configured for domain for fromid login address %q", s)

1499 }

1500 acc.ParsedFromIDLoginAddresses[i] = a

1501 }

1502

1503 // Clear any previously derived state.

1504 acc.Aliases = nil

1505

1506 c.Accounts[accName] = acc

1507

1508 if acc.OutgoingWebhook != nil {

1509 u, err := url.Parse(acc.OutgoingWebhook.URL)

1510 if err == nil && (u.Scheme != "http" && u.Scheme != "https") {

1511 err = errors.New("scheme must be http or https")

1512 }

1513 if err != nil {

1514 addAccountErrorf("parsing outgoing hook url %q: %v", acc.OutgoingWebhook.URL, err)

1515 }

1516

1517 // note: outgoing hook events are in ../queue/hooks.go, ../mox-/config.go, ../queue.go and ../webapi/gendoc.sh. keep in sync.

1518 outgoingHookEvents := []string{"delivered", "suppressed", "delayed", "failed", "relayed", "expanded", "canceled", "unrecognized"}

1519 for _, e := range acc.OutgoingWebhook.Events {

1520 if !slices.Contains(outgoingHookEvents, e) {

1521 addAccountErrorf("unknown outgoing hook event %q", e)

1522 }

1523 }

1524 }

1525 if acc.IncomingWebhook != nil {

1526 u, err := url.Parse(acc.IncomingWebhook.URL)

1527 if err == nil && (u.Scheme != "http" && u.Scheme != "https") {

1528 err = errors.New("scheme must be http or https")

1529 }

1530 if err != nil {

1531 addAccountErrorf("parsing incoming hook url %q: %v", acc.IncomingWebhook.URL, err)

1532 }

1533 }

1534

1535 // todo deprecated: only localpart as keys for Destinations, we are replacing them with full addresses. if domains.conf is written, we won't have to do this again.

1536 replaceLocalparts := map[string]string{}

1537

1538 for addrName, dest := range acc.Destinations {

1539 addDestErrorf := func(format string, args ...any) {

1540 addAccountErrorf("destination %q: %s", addrName, fmt.Sprintf(format, args...))

1541 }

1542

1543 checkMailboxNormf(dest.Mailbox, "destination mailbox", addDestErrorf)

1544

1545 if dest.SMTPError != "" {

1546 if len(dest.SMTPError) > 256 {

1547 addDestErrorf("smtp error must be smaller than 256 bytes")

1548 }

1549 for _, c := range dest.SMTPError {

1550 if c < ' ' || c >= 0x7f {

1551 addDestErrorf("smtp error cannot contain contain control characters (including newlines) or non-ascii")

1552 break

1553 }

1554 }

1555

1556 if dest.Mailbox != "" {

1557 addDestErrorf("cannot have both SMTPError and Mailbox")

1558 }

1559 if len(dest.Rulesets) != 0 {

1560 addDestErrorf("cannot have both SMTPError and Rulesets")

1561 }

1562

1563 t := strings.SplitN(dest.SMTPError, " ", 2)

1564 switch t[0] {

1565 default:

1566 addDestErrorf("smtp error must be 421 or 550 (with optional message), not %q", dest.SMTPError)

1567

1568 case "421":

1569 dest.SMTPErrorCode = smtp.C451LocalErr

1570 dest.SMTPErrorSecode = smtp.SeSys3Other0

1571 dest.SMTPErrorMsg = "error processing"

1572 case "550":

1573 dest.SMTPErrorCode = smtp.C550MailboxUnavail

1574 dest.SMTPErrorSecode = smtp.SeAddr1UnknownDestMailbox1

1575 dest.SMTPErrorMsg = "no such user(s)"

1576 }

1577 if len(t) > 1 {

1578 dest.SMTPErrorMsg = strings.TrimSpace(t[1])

1579 }

1580 acc.Destinations[addrName] = dest

1581 }

1582

1583 if dest.MessageAuthRequiredSMTPError != "" {

1584 if len(dest.MessageAuthRequiredSMTPError) > 256 {

1585 addDestErrorf("message authentication required smtp error must be smaller than 256 bytes")

1586 }

1587 for _, c := range dest.MessageAuthRequiredSMTPError {

1588 if c < ' ' || c >= 0x7f {

1589 addDestErrorf("message authentication required smtp error cannot contain contain control characters (including newlines) or non-ascii")

1590 break

1591 }

1592 }

1593 }

1594

1595 for i, rs := range dest.Rulesets {

1596 addRulesetErrorf := func(format string, args ...any) {

1597 addDestErrorf("ruleset %d: %s", i+1, fmt.Sprintf(format, args...))

1598 }

1599

1600 checkMailboxNormf(rs.Mailbox, "ruleset mailbox", addRulesetErrorf)

1601

1602 n := 0

1603

1604 if rs.SMTPMailFromRegexp != "" {

1605 n++

1606 r, err := regexp.Compile(rs.SMTPMailFromRegexp)

1607 if err != nil {

1608 addRulesetErrorf("invalid SMTPMailFrom regular expression: %v", err)

1609 }

1610 c.Accounts[accName].Destinations[addrName].Rulesets[i].SMTPMailFromRegexpCompiled = r

1611 }

1612 if rs.MsgFromRegexp != "" {

1613 n++

1614 r, err := regexp.Compile(rs.MsgFromRegexp)

1615 if err != nil {

1616 addRulesetErrorf("invalid MsgFrom regular expression: %v", err)

1617 }

1618 c.Accounts[accName].Destinations[addrName].Rulesets[i].MsgFromRegexpCompiled = r

1619 }

1620 if rs.VerifiedDomain != "" {

1621 n++

1622 d, err := dns.ParseDomain(rs.VerifiedDomain)

1623 if err != nil {

1624 addRulesetErrorf("invalid VerifiedDomain: %v", err)

1625 }

1626 c.Accounts[accName].Destinations[addrName].Rulesets[i].VerifiedDNSDomain = d

1627 }

1628

1629 var hdr [][2]*regexp.Regexp

1630 for k, v := range rs.HeadersRegexp {

1631 n++

1632 if strings.ToLower(k) != k {

1633 addRulesetErrorf("header field %q must only have lower case characters", k)

1634 }

1635 if strings.ToLower(v) != v {

1636 addRulesetErrorf("header value %q must only have lower case characters", v)

1637 }

1638 rk, err := regexp.Compile(k)

1639 if err != nil {

1640 addRulesetErrorf("invalid rule header regexp %q: %v", k, err)

1641 }

1642 rv, err := regexp.Compile(v)

1643 if err != nil {

1644 addRulesetErrorf("invalid rule header regexp %q: %v", v, err)

1645 }

1646 hdr = append(hdr, [...]*regexp.Regexp{rk, rv})

1647 }

1648 c.Accounts[accName].Destinations[addrName].Rulesets[i].HeadersRegexpCompiled = hdr

1649

1650 if n == 0 {

1651 addRulesetErrorf("ruleset must have at least one rule")

1652 }

1653

1654 if rs.IsForward && rs.ListAllowDomain != "" {

1655 addRulesetErrorf("ruleset cannot have both IsForward and ListAllowDomain")

1656 }

1657 if rs.IsForward {

1658 if rs.SMTPMailFromRegexp == "" || rs.VerifiedDomain == "" {

1659 addRulesetErrorf("ruleset with IsForward must have both SMTPMailFromRegexp and VerifiedDomain too")

1660 }

1661 }

1662 if rs.ListAllowDomain != "" {

1663 d, err := dns.ParseDomain(rs.ListAllowDomain)

1664 if err != nil {

1665 addRulesetErrorf("invalid ListAllowDomain %q: %v", rs.ListAllowDomain, err)

1666 }

1667 c.Accounts[accName].Destinations[addrName].Rulesets[i].ListAllowDNSDomain = d

1668 }

1669

1670 checkMailboxNormf(rs.AcceptRejectsToMailbox, "rejects mailbox", addRulesetErrorf)

1671 if strings.EqualFold(rs.AcceptRejectsToMailbox, "inbox") {

1672 addRulesetErrorf("AcceptRejectsToMailbox cannot be set to Inbox")

1673 }

1674 }

1675

1676 // Catchall destination for domain.

1677 if strings.HasPrefix(addrName, "@") {

1678 d, err := dns.ParseDomain(addrName[1:])

1679 if err != nil {

1680 addDestErrorf("parsing domain %q", addrName[1:])

1681 continue

1682 } else if _, ok := c.Domains[d.Name()]; !ok {

1683 addDestErrorf("unknown domain for address")

1684 continue

1685 }

1686 domainHasAddress[d.Name()] = true

1687 addrFull := "@" + d.Name()

1688 if _, ok := accDests[addrFull]; ok {

1689 addDestErrorf("duplicate canonicalized catchall destination address %s", addrFull)

1690 }

1691 accDests[addrFull] = AccountDestination{true, "", accName, dest}

1692 continue

1693 }

1694

1695 // todo deprecated: remove support for parsing destination as just a localpart instead full address.

1696 var address smtp.Address

1697 if localpart, err := smtp.ParseLocalpart(addrName); err != nil && errors.Is(err, smtp.ErrBadLocalpart) {

1698 address, err = smtp.ParseAddress(addrName)

1699 if err != nil {

1700 addDestErrorf("invalid email address")

1701 continue

1702 } else if _, ok := c.Domains[address.Domain.Name()]; !ok {

1703 addDestErrorf("unknown domain for address")

1704 continue

1705 }

1706 } else {

1707 if err != nil {

1708 addDestErrorf("invalid localpart %q", addrName)

1709 continue

1710 }

1711 address = smtp.NewAddress(localpart, acc.DNSDomain)

1712 if _, ok := c.Domains[acc.DNSDomain.Name()]; !ok {

1713 addDestErrorf("unknown domain %s", acc.DNSDomain.Name())

1714 continue

1715 }

1716 replaceLocalparts[addrName] = address.Pack(true)

1717 }

1718

1719 origLP := address.Localpart

1720 dc := c.Domains[address.Domain.Name()]

1721 domainHasAddress[address.Domain.Name()] = true

1722 lp := CanonicalLocalpart(address.Localpart, dc)

1723 var hasSep bool

1724 for _, sep := range dc.LocalpartCatchallSeparatorsEffective {

1725 if strings.Contains(string(address.Localpart), sep) {

1726 hasSep = true

1727 addDestErrorf("localpart of address %s includes domain catchall separator %s", address, sep)

1728 }

1729 }

1730 if !hasSep {

1731 address.Localpart = lp

1732 }

1733 addrFull := address.Pack(true)

1734 if _, ok := accDests[addrFull]; ok {

1735 addDestErrorf("duplicate canonicalized destination address %s", addrFull)

1736 }

1737 accDests[addrFull] = AccountDestination{false, origLP, accName, dest}

1738 }

1739

1740 for lp, addr := range replaceLocalparts {

1741 dest, ok := acc.Destinations[lp]

1742 if !ok {

1743 addAccountErrorf("could not find localpart %q to replace with address in destinations", lp)

1744 } else {

1745 log.Warn(`deprecation warning: support for account destination addresses specified as just localpart ("username") instead of full email address will be removed in the future; update domains.conf, for each Account, for each Destination, ensure each key is an email address by appending "@" and the default domain for the account`,

1746 slog.Any("localpart", lp),

1747 slog.Any("address", addr),

1748 slog.String("account", accName))

1749 acc.Destinations[addr] = dest

1750 delete(acc.Destinations, lp)

1751 }

1752 }

1753

1754 // Now that all addresses are parsed, check if all fromid login addresses match

1755 // configured addresses.

1756 for i, a := range acc.ParsedFromIDLoginAddresses {

1757 // For domain catchall.