mirror of
https://github.com/mjl-/mox.git
synced 2024-12-27 08:53:48 +03:00
daa908e9f4
the vendored dns resolver code is a copy of the go stdlib dns resolver, with awareness of the "authentic data" (i.e. dnssec secure) added, as well as support for enhanced dns errors, and looking up tlsa records (for dane). ideally it would be upstreamed, but the chances seem slim. dnssec-awareness is added to all packages, e.g. spf, dkim, dmarc, iprev. their dnssec status is added to the Received message headers for incoming email. but the main reason to add dnssec was for implementing dane. with dane, the verification of tls certificates can be done through certificates/public keys published in dns (in the tlsa records). this only makes sense (is trustworthy) if those dns records can be verified to be authentic. mox now applies dane to delivering messages over smtp. mox already implemented mta-sts for webpki/pkix-verification of certificates against the (large) pool of CA's, and still enforces those policies when present. but it now also checks for dane records, and will verify those if present. if dane and mta-sts are both absent, the regular opportunistic tls with starttls is still done. and the fallback to plaintext is also still done. mox also makes it easy to setup dane for incoming deliveries, so other servers can deliver with dane tls certificate verification. the quickstart now generates private keys that are used when requesting certificates with acme. the private keys are pre-generated because they must be static and known during setup, because their public keys must be published in tlsa records in dns. autocert would generate private keys on its own, so had to be forked to add the option to provide the private key when requesting a new certificate. hopefully upstream will accept the change and we can drop the fork. with this change, using the quickstart to setup a new mox instance, the checks at internet.nl result in a 100% score, provided the domain is dnssec-signed and the network doesn't have any issues.
87 lines
1.9 KiB
Bash
Executable file
87 lines
1.9 KiB
Bash
Executable file
#!/bin/sh
|
|
|
|
(
|
|
cat <<EOF
|
|
/*
|
|
Command mox is a modern, secure, full-featured, open source mail server for
|
|
low-maintenance self-hosted email.
|
|
|
|
# Commands
|
|
|
|
EOF
|
|
|
|
./mox 2>&1 | sed 's/^\( *\|usage: \)/\t/'
|
|
|
|
cat <<EOF
|
|
|
|
Many commands talk to a running mox instance, through the ctl file in the data
|
|
directory. Specify the configuration file (that holds the path to the data
|
|
directory) through the -config flag or MOXCONF environment variable.
|
|
|
|
EOF
|
|
|
|
# setting XDG_CONFIG_HOME ensures "mox localserve" has reasonable default
|
|
# values in its help output.
|
|
XDG_CONFIG_HOME='$userconfigdir' ./mox helpall 2>&1
|
|
|
|
cat <<EOF
|
|
*/
|
|
package main
|
|
|
|
// NOTE: DO NOT EDIT, this file is generated by gendoc.sh.
|
|
EOF
|
|
)>doc.go
|
|
gofmt -w doc.go
|
|
|
|
(
|
|
cat <<EOF
|
|
/*
|
|
Package config holds the configuration file definitions for mox.conf (Static)
|
|
and domains.conf (Dynamic).
|
|
|
|
These config files are in "sconf" format. Summarized: Indent with tabs, "#" as
|
|
first non-whitespace character makes the line a comment (you cannot have a line
|
|
with both a value and a comment), strings are not quoted/escaped and can never
|
|
span multiple lines. See https://pkg.go.dev/github.com/mjl-/sconf for details.
|
|
|
|
Annotated empty/default configuration files you could use as a starting point
|
|
for your mox.conf and domains.conf, as generated by "mox config
|
|
describe-static" and "mox config describe-domains":
|
|
|
|
# mox.conf
|
|
|
|
EOF
|
|
./mox config describe-static | sed 's/^/\t/'
|
|
|
|
cat <<EOF
|
|
|
|
# domains.conf
|
|
|
|
EOF
|
|
./mox config describe-domains | sed 's/^/\t/'
|
|
|
|
cat <<EOF
|
|
|
|
# Examples
|
|
|
|
Mox includes configuration files to illustrate common setups. You can see these
|
|
examples with "mox example", and print a specific example with "mox example
|
|
<name>". Below are all examples included in mox.
|
|
|
|
EOF
|
|
|
|
for ex in $(./mox example); do
|
|
echo '# Example '$ex
|
|
echo
|
|
./mox example $ex | sed 's/^/\t/'
|
|
echo
|
|
done
|
|
|
|
cat <<EOF
|
|
*/
|
|
package config
|
|
|
|
// NOTE: DO NOT EDIT, this file is generated by ../gendoc.sh.
|
|
EOF
|
|
)>config/doc.go
|
|
gofmt -w config/doc.go
|