Update setup/bootstrap.sh

Ensure that folks on windows Workspace still get Unix line-endings.
Might prevent cases where setup scripts will refuse to run.

.editorconfig

@@ -4,27 +4,23 @@
 
 root = true
 
-[*]
+[Vagrantfile]
 indent_style = space
-indent_size = 4
+indent_size = 2
+
+[*.rb]
+indent_style = space
+indent_size = 2
+
+[**.html]
+indent_style = tab
+
+[**.py]
+indent_style = tab
+
+[**]
+indent_style = tab
 end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
-
-[Makefile]
-indent_style = tabs
-indent_size = 4
-
-[Vagrantfile]
-indent_size = 2
-
-[*.rb]
-indent_size = 2
-
-[*.py]
-indent_style = tabs
-
-[*.js]
-indent_size = 2
-

.gitattributes

@@ -0,0 +1,5 @@
+# All text should use Unix-style Line-endings
+* text eol=lf
+
+# Except mta-sts.txt (RFC 8461)
+mta-sts.txt text eol=crlf

.github/FUNDING.yml

@@ -0,0 +1 @@
+ko_fi: davness

.gitignore

@@ -5,3 +5,5 @@ tools/__pycache__/
 externals/
 .env
 .vagrant
+api/docs/api-docs.html
+mailinabox-ca.crt

.style.yapf

@@ -0,0 +1,3 @@
+[style]
+based_on_style = pep8
+use_tabs = True

CHANGELOG.md

@@ -1,6 +1,553 @@
 CHANGELOG
 =========
 
+Version 60.1 (October 30, 2022)
+-------------------------------
+
+* A setup issue where the DNS server nsd isn't running at the end of setup is (hopefully) fixed.
+* Nextcloud is updated to 23.0.10 (contacts to 4.2.2, calendar to 3.5.1).
+
+Version 60 (October 11, 2022)
+-----------------------------
+
+This is the first release for Ubuntu 22.04.
+
+**Before upgrading**, you must **first upgrade your existing Ubuntu 18.04 box to Mail-in-a-Box v0.51 or later**, if you haven't already done so. That may not be possible after Ubuntu 18.04 reaches its end of life in April 2023, so please complete the upgrade well before then. (If you are not using Nextcloud's contacts or calendar, you can migrate to the latest version of Mail-in-a-Box from any previous version.)
+
+For complete upgrade instructions, see:
+
+https://discourse.mailinabox.email/t/version-60-for-ubuntu-22-04-is-about-to-be-released/9558
+
+No major features of Mail-in-a-Box have changed in this release, although some minor fixes were made.
+
+With the newer version of Ubuntu the following software packages we use are updated:
+
+* dovecot is upgraded to 2.3.16, postfix to 3.6.4, opendmark to 1.4 (which adds ARC-Authentication-Results headers), and spampd to 2.53 (alleviating a mail delivery rate limiting bug).
+* Nextcloud is upgraded to 23.0.4 (contacts to 4.2.0, calendar to 3.5.0).
+* Roundcube is upgraded to 1.6.0.
+* certbot is upgraded to 1.21 (via the Ubuntu repository instead of a PPA).
+* fail2ban is upgraded to 0.11.2.
+* nginx is upgraded to 1.18.
+* PHP is upgraded from 7.2 to 8.0.
+
+Also:
+
+* Roundcube's login session cookie was tightened. Existing sessions may require a manual logout.
+* Moved Postgrey's database under $STORAGE_ROOT.
+
+Version 57a (June 19, 2022)
+---------------------------
+
+* The Backblaze backups fix posted in Version 57 was incomplete. It's now fixed.
+
+Version 57 (June 12, 2022)
+--------------------------
+
+Setup:
+
+* Fixed issue upgrading from Mail-in-a-Box v0.40-v0.50 because of a changed URL that Nextcloud is downloaded from.
+
+Backups:
+
+* Fixed S3 backups which broke with duplicity 0.8.23.
+* Fixed Backblaze backups which broke with latest b2sdk package by rolling back its version.
+
+Control panel:
+
+* Fixed spurious changes in system status checks messages by sorting DNSSEC DS records.
+* Fixed fail2ban lockout over IPv6 from excessive loads of the system status checks.
+* Fixed an incorrect IPv6 system status check message.
+
+Version 56 (January 19, 2022)
+-----------------------------
+
+Software updates:
+
+* Roundcube updated to 1.5.2 (from 1.5.0), and the persistent_login and CardDAV (to 4.3.0 from 3.0.3) plugins are updated.
+* Nextcloud updated to 20.0.14 (from 20.0.8), contacts to 4.0.7 (from 3.5.1), and calendar to 3.0.4 (from 2.2.0).
+
+Setup:
+
+* Fixed failed setup if a previous attempt failed while updating Nextcloud.
+
+Control panel:
+
+* Fixed a crash if a custom DNS entry is not under a zone managed by the box.
+* Fix DNSSEC instructions typo.
+
+Other:
+
+* Set systemd journald log retention to 10 days (from no limit) to reduce disk usage.
+* Fixed log processing for submission lines that have a sasl_sender or other extra information.
+* Fix DNS secondary nameserver refesh failure retry period.
+
+Version 55 (October 18, 2021)
+-----------------------------
+
+Mail:
+
+* "SMTPUTF8" is now disabled in Postfix. Because Dovecot still does not support SMTPUTF8, incoming mail to internationalized addresses was bouncing. This fixes incoming mail to internationalized domains (which was probably working prior to v0.40), but it will prevent sending outbound mail to addresses with internationalized local-parts.
+* Upgraded to Roundcube 1.5.
+
+Control panel:
+
+* The control panel menus are now hidden before login, but now non-admins can log in to access the mail and contacts/calendar instruction pages.
+* The login form now disables browser autocomplete in the two-factor authentication code field.
+* After logging in, the default page is now a fast-loading welcome page rather than the slow-loading system status checks page.
+* The backup retention period option now displays for B2 backup targets.
+* The DNSSEC DS record recommendations are cleaned up and now recommend changing records that use SHA1.
+* The Munin monitoring pages no longer require a separate HTTP basic authentication login and can be used if two-factor authentication is turned on.
+* Control panel logins are now tied to a session backend that allows true logouts (rather than an encrypted cookie).
+* Failed logins no longer directly reveal whether the email address corresponds to a user account.
+* Browser dark mode now inverts the color scheme.
+
+Other:
+
+* Fail2ban's IPv6 support is enabled.
+* The mail log tool now doesn't crash if there are email addresess in log messages with invalid UTF-8 characters.
+* Additional nsd.conf files can be placed in /etc/nsd.conf.d.
+
+v0.54 (June 20, 2021)
+---------------------
+
+Mail:
+
+* Forwarded mail using mail filter rules (in Roundcube; "sieve" rules) stopped re-writing the envelope address at some point, causing forwarded mail to often be marked as spam by the final recipient. These forwards will now re-write the envelope as the Mail-in-a-Box user receiving the mail to comply with SPF/DMARC rules.
+* Sending mail is now possible on port 465 with the "SSL" or "TLS" option in mail clients, and this is now the recommended setting. Port 587 with STARTTLS remains available but should be avoided when configuring new mail clients.
+* Roundcube's login cookie is updated to use a new encryption algorithm (AES-256-CBC instead of DES-EDE-CBC).
+
+DNS:
+
+* The ECDSAP256SHA256 DNSSEC algorithm is now available. If a DS record is set for any of your domain names that have DNS hosted on your box, you will be prompted by status checks to update the DS record at your convenience.
+* Null MX records are added for domains that do not serve mail.
+
+Contacts/calendar:
+
+* Updated Nextcloud to 20.0.8, contacts to 3.5.1, calendar to 2.2.0 (#1960).
+
+Control panel:
+
+* Fixed a crash in the status checks.
+* Small wording improvements.
+
+Setup:
+
+* Minor improvements to the setup scripts.
+
+v0.53a (May 8, 2021)
+--------------------
+
+The download URL for Z-Push has been revised becaue the old URL stopped working.
+
+v0.53 (April 12, 2021)
+----------------------
+
+Software updates:
+
+* Upgraded Roundcube to version 1.4.11 addressing a security issue, and its desktop notifications plugin.
+* Upgraded Z-Push (for Exchange/ActiveSync) to version 2.6.2.
+
+Control panel:
+
+* Backblaze B2 is now a supported backup protocol.
+* Fixed an issue in the daily mail reports.
+* Sort the Custom DNS by zone and qname, and add an option to go back to the old sort order (creation order).
+
+Mail:
+
+* Enable sending DMARC failure reports to senders that request them.
+
+Setup:
+
+* Fixed error when upgrading from Nextcloud 13.
+
+v0.52 (January 31, 2021)
+------------------------
+
+Software updates:
+
+* Upgraded Roundcube to version 1.4.10.
+* Upgraded Z-Push to 2.6.1.
+
+Mail:
+
+* Incoming emails with SPF/DKIM/DMARC failures now get a higher spam score, and these messages are more likely to appear in the junk folder, since they are often spam/phishing.
+* Fixed the MTA-STS policy file's line endings.
+
+Control panel:
+
+* A new Download button in the control panel's External DNS page can be used to download the required DNS records in zonefile format.
+* Fixed the problem when the control panel would report DNS entries as Not Set by increasing a bind query limit.
+* Fixed a control panel startup bug on some systems.
+* Improved an error message on a DNS lookup timeout.
+* A typo was fixed.
+
+DNS:
+
+* The TTL for NS records has been increased to 1 day to comply with some registrar requirements.
+
+System:
+
+* Nextcloud's photos, dashboard, and activity apps are disabled since we only support contacts and calendar.
+
+v0.51 (November 14, 2020)
+-------------------------
+
+Software updates:
+
+* Upgraded Nextcloud from 17.0.6 to 20.0.1 (with Contacts from 3.3.0 to 3.4.1 and Calendar from 2.0.3 to 2.1.2)
+* Upgraded Roundcube to version 1.4.9.
+
+Mail:
+
+* The MTA-STA max_age value was increased to the normal one week.
+
+Control panel:
+
+* Two-factor authentication can now be enabled for logins to the control panel. However, keep in mind that many online services (including domain name registrars, cloud server providers, and TLS certificate providers) may allow an attacker to take over your account or issue a fraudulent TLS certificate with only access to your email address, and this new two-factor authentication does not protect access to your inbox. It therefore remains very important that user accounts with administrative email addresses have strong passwords.
+* TLS certificate expiry dates are now shown in ISO8601 format for clarity.
+
+v0.50 (September 25, 2020)
+--------------------------
+
+Setup:
+
+* When upgrading from versions before v0.40, setup will now warn that ownCloud/Nextcloud data cannot be migrated rather than failing the installation.
+
+Mail:
+
+* An MTA-STS policy for incoming mail is now published (in DNS and over HTTPS) when the primary hostname and email address domain both have a signed TLS certificate installed, allowing senders to know that an encrypted connection should be enforced.
+* The per-IP connection limit to the IMAP server has been doubled to allow more devices to connect at once, especially with multiple users behind a NAT.
+
+DNS:
+
+* autoconfig and autodiscover subdomains and CalDAV/CardDAV SRV records are no longer generated for domains that don't have user accounts since they are unnecessary.
+* IPv6 addresses can now be specified for secondary DNS nameservers in the control panel.
+
+TLS:
+
+* TLS certificates are now provisioned in groups by parent domain to limit easy domain enumeration and make provisioning more resilient to errors for particular domains.
+
+Control panel:
+
+* The control panel API is now fully documented at https://mailinabox.email/api-docs.html.
+* User passwords can now have spaces.
+* Status checks for automatic subdomains have been moved into the section for the parent domain.
+* Typo fixed.
+
+Web:
+
+* The default web page served on fresh installations now adds the `noindex` meta tag.
+* The HSTS header is revised to also be sent on non-success responses.
+
+v0.48 (August 26, 2020)
+-----------------------
+
+Security fixes:
+
+* Roundcube is updated to version 1.4.8 fixing additional cross-site scripting (XSS) vulnerabilities.
+
+v0.47 (July 29, 2020)
+---------------------
+
+Security fixes:
+
+* Roundcube is updated to version 1.4.7 fixing a cross-site scripting (XSS) vulnerability with HTML messages with malicious svg/namespace (CVE-2020-15562) (https://roundcube.net/news/2020/07/05/security-updates-1.4.7-1.3.14-and-1.2.11).
+* SSH connections are now rate-limited at the firewall level (in addition to fail2ban).
+
+v0.46 (June 11, 2020)
+---------------------
+
+Security fixes:
+
+* Roundcube is updated to version 1.4.6 (https://roundcube.net/news/2020/06/02/security-updates-1.4.5-and-1.3.12).
+
+v0.45 (May 16, 2020)
+--------------------
+
+Security fixes:
+
+* Fix missing brute force login protection for Roundcube logins.
+
+Software updates:
+
+* Upgraded Roundcube from 1.4.2 to 1.4.4.
+* Upgraded Nextcloud from 17.0.2 to 17.0.6 (with Contacts from 3.1.6 to 3.3.0 and Calendar from 1.7.1 to v2.0.3)
+* Upgraded Z-Push to 2.5.2.
+
+System:
+
+* Nightly backups now occur on a random minute in the 3am hour (in the system time zone). The minute is chosen during Mail-in-a-Box installation/upgrade and remains the same until the next upgrade.
+* Fix for mail log statistics report on leap days.
+* Fix Mozilla autoconfig useGlobalPreferredServer setting.
+
+Web:
+
+* Add a new hidden feature to set nginx alias in www/custom.yaml.
+
+Setup:
+
+* Improved error handling.
+
+v0.44 (February 15, 2020)
+-------------------------
+
+System:
+
+* TLS settings have been upgraded following Mozilla's recommendations for servers. TLS1.2 and 1.3 are now the only supported protocols for web, IMAP, and SMTP (submission).
+* Fixed an issue starting services when Mail-in-a-Box isn't on the root filesystem.
+* Changed some performance options affecting Roundcube and Nextcloud.
+
+Software updates:
+
+* Upgraded Nextcloud from 15.0.8 to 17.0.2 (with Contacts from 3.1.1 to 3.1.6 and Calendar from 1.6.5 to 1.7.1)
+* Upgraded Z-Push to 2.5.1.
+* Upgraded Roundcube from 1.3.10 to 1.4.2 and changed the default skin (theme) to Elastic.
+
+Control panel:
+
+* The Custom DNS list of records is now sorted.
+* The emails that report TLS provisioning results now has a less scary subject line.
+
+Mail:
+
+* Fetching of updated whitelist for greylisting was fetching each day instead of every month.
+* OpenDKIM signing has been changed to 'relaxed' mode so that some old mail lists that forward mail can do so.
+
+DNS:
+
+* Automatic autoconfig.* subdomains can now be suppressed with custom DNS records.
+* DNS zone transfer now works with IPv6 addresses.
+
+Setup:
+
+* An Ubuntu package source was missing on systems where it defaults off.
+
+v0.43 (September 1, 2019)
+-------------------------
+
+Security fixes:
+
+* A security issue was discovered in rsync backups. If you have enabled rsync backups, the file `id_rsa_miab` may have been copied to your backup destination. This file can be used to access your backup destination. If the file was copied to your backup destination, we recommend that you delete the file on your backup destination, delete `/root/.ssh/id_rsa_miab` on your Mail-in-a-Box, then re-run Mail-in-a-Box setup, and re-configure your SSH public key at your backup destination according to the instructions in the Mail-in-a-Box control panel.
+* Brute force attack prevention was missing for the managesieve service.
+
+Setup:
+
+* Nextcloud was not upgraded properly after restoring Mail-in-a-Box from a backup from v0.40 or earlier.
+
+Mail:
+
+* Upgraded Roundcube to 1.3.10.
+* Fetch an updated whitelist for greylisting on a monthly basis to reduce the number of delayed incoming emails.
+
+Control panel:
+
+* When using secondary DNS, it is now possible to specify a subnet range with the `xfr:` option.
+* Fixed an issue when the secondary DNS option is used and the secondary DNS hostname resolves to multiple IP addresses.
+* Fix a bug in how a backup configuration error is shown.
+
+v0.42b (August 3, 2019)
+-----------------------
+
+Changes:
+
+* Decreased the minimum supported RAM to 502 Mb.
+* Improved mail client autoconfiguration.
+* Added support for S3-compatible backup services besides Amazon S3.
+* Fixed the control panel login page to let LastPass save passwords.
+* Fixed an error in the user privileges API.
+* Silenced some spurrious messages.
+
+Software updates:
+
+* Upgraded Roundcube from 1.3.8 to 1.3.9.
+* Upgraded Nextcloud from 14.0.6 to 15.0.8 (with Contacts from 2.1.8 to 3.1.1 and Calendar from 1.6.4 to 1.6.5).
+* Upgraded Z-Push from 2.4.4 to 2.5.0.
+
+Note that v0.42 (July 4, 2019) was pulled shortly after it was released to fix a Nextcloud upgrade issue.
+
+v0.41 (February 26, 2019)
+-------------------------
+
+System:
+
+* Missing brute force login attack prevention (fail2ban) filters which stopped working on Ubuntu 18.04 were added back.
+* Upgrades would fail if Mail-in-a-Box moved to a different directory in `systemctl link`.
+
+Mail:
+
+* Incoming messages addressed to more than one local user were rejected because of a bug in spampd packaged by Ubuntu 18.04. A workaround was added.
+
+Contacts/Calendar:
+
+* Upgraded Nextcloud from 13.0.6 to 14.0.6.
+* Upgraded Contacts from 2.1.5 to 2.1.8.
+* Upgraded Calendar from 1.6.1 to 1.6.4.
+
+v0.40 (January 12, 2019)
+------------------------
+
+This is the first release for Ubuntu 18.04. This version and versions going forward can **only** be installed on Ubuntu 18.04; however, upgrades of existing Ubuntu 14.04 boxes to the latest version supporting Ubuntu 14.04 (v0.30) continue to work as normal.
+
+When **upgrading**, you **must first upgrade your existing Ubuntu 14.04 Mail-in-a-Box box** to the latest release supporting Ubuntu 14.04 --- that's v0.30 --- before you migrate to Ubuntu 18.04. If you are running an older version of Mail-in-a-Box which has an old version of ownCloud or Nextcloud, you will *not* be able to upgrade your data because older versions of ownCloud and Nextcloud that are required to perform the upgrade *cannot* be run on Ubuntu 18.04. To upgrade from Ubuntu 14.04 to Ubuntu 18.04, you **must create a fresh Ubuntu 18.04 machine** before installing this version. In-place upgrades of servers are not supported. Since Ubuntu's support for Ubuntu 14.04 has almost ended, everyone is encouraged to create a new Ubuntu 18.04 machine and migrate to it.
+
+For complete upgrade instructions, see:
+
+https://discourse.mailinabox.email/t/mail-in-a-box-version-v0-40-and-moving-to-ubuntu-18-04/4289
+
+The changelog for this release follows.
+
+Setup:
+
+* Mail-in-a-Box now targets Ubuntu 18.04 LTS, which will have support from Ubuntu through 2022.
+* Some of the system packages updated in virtue of using Ubuntu 18.04 include postfix (2.11=>3.3) nsd (4.0=>4.1), nginx (1.4=>1.14), PHP (7.0=>7.2), Python (3.4=>3.6), fail2ban (0.8=>0.10), Duplicity (0.6=>0.7).
+* [Unofficial Bash Strict Mode](http://redsymbol.net/articles/unofficial-bash-strict-mode/) is turned on for setup, which might catch previously uncaught issues during setup.
+
+Mail:
+
+* IMAP server-side full text search is no longer supported because we were using a custom-built `dovecot-lucene` package that we are no longer maintaining.
+* Sending email is now disabled on port 25 --- you must log in to port 587 to send email, per the long-standing mail instructions.
+* Greylisting may delay more emails from new senders. We were using a custom-built postgrey package previously that whitelisted sending domains in dnswl.org, but we are no longer maintaining that package.
+
+v0.30 (January 9, 2019)
+-----------------------
+
+Setup:
+
+* Update to Roundcube 1.3.8 and the CardDAV plugin to 3.0.3.
+* Add missing rsyslog package to install line since some OS images don't have it installed by default.
+* A log file for nsd was added.
+
+Control Panel:
+
+* The users page now documents that passwords should only have ASCII characters to prevent character encoding mismaches between clients and the server.
+* The users page no longer shows user mailbox sizes because this was extremely slow for very large mailboxes.
+* The Mail-in-a-Box version is now shown in the system status checks even when the new-version check is disabled.
+* The alises page now warns that alises should not be used to forward mail off of the box. Mail filters within Roundcube are better for that.
+* The explanation of greylisting has been improved.
+
+v0.29 (October 25, 2018)
+------------------------
+
+* Starting with v0.28, TLS certificate provisioning wouldn't work on new boxes until the mailinabox setup command was run a second time because of a problem with the non-interactive setup.
+* Update to Nextcloud 13.0.6.
+* Update to Roundcube 1.3.7.
+* Update to Z-Push 2.4.4.
+* Backup dates listed in the control panel now use an internationalized format.
+
+v0.28 (July 30, 2018)
+---------------------
+
+System:
+
+* We now use EFF's `certbot` to provision TLS certificates (from Let's Encrypt) instead of our home-grown ACME library.
+
+Contacts/Calendar:
+
+* Fix for Mac OS X autoconfig of the calendar.
+
+Setup:
+
+* Installing Z-Push broke because of what looks like a change or problem in their git server HTTPS certificate. That's fixed.
+
+v0.27 (June 14, 2018)
+---------------------
+
+Mail:
+
+* A report of box activity, including sent/received mail totals and logins by user, is now emailed to the box's administrator user each week.
+* Update Roundcube to version 1.3.6 and Z-Push to version 2.3.9.
+
+Control Panel:
+
+* The undocumented feature for proxying web requests to another server now sets X-Forwarded-For.
+
+v0.26c (February 13, 2018)
+--------------------------
+
+Setup:
+
+* Upgrades from v0.21c (February 1, 2017) or earlier were broken because the intermediate versions of ownCloud used in setup were no longer available from ownCloud.
+* Some download errors had no output --- there is more output on error now.
+
+Control Panel:
+
+* The background service for the control panel was not restarting on updates, leaving the old version running. This was broken in v0.26 and is now fixed.
+* Installing your own TLS/SSL certificate had been broken since v0.24 because the new version of openssl became stricter about CSR generation parameters.
+* Fixed password length help text.
+
+Contacts/Calendar:
+
+* Upgraded Nextcloud from 12.0.3 to 12.0.5.
+
+v0.26b (January 25, 2018)
+-------------------------
+
+* Fix new installations which broke at the step of asking for the user's desired email address, which was broken by v0.26's changes related to the control panel.
+* Fix the provisioning of TLS certificates by pinning a Python package we rely on (acme) to an earlier version because our code isn't yet compatible with its current version.
+* Reduce munin's log_level from debug to warning to prevent massive log files.
+
+v0.26 (January 18, 2018)
+------------------------
+
+Security:
+
+* HTTPS, IMAP, and POP's TLS settings have been updated to Mozilla's intermediate cipher list recommendation. Some extremely old devices that use less secure TLS ciphers may no longer be able to connect to IMAP/POP.
+* Updated web HSTS header to use longer six month duration.
+
+Mail:
+
+* Adding attachments in Roundcube broke after the last update for some users after rebooting because a temporary directory was deleted on reboot. The temporary directory is now moved from /tmp to /var so that it is persistent.
+* `X-Spam-Score` header is added to incoming mail.
+
+Control panel:
+
+* RSASHA256 is now used for DNSSEC for .lv domains.
+* Some documentation/links improvements.
+
+Installer:
+
+* We now run `apt-get autoremove` at the start of setup to clear out old packages, especially old kernels that take up a lot of space. On the first run, this step may take a long time.
+* We now fetch Z-Push from its tagged git repository, fixing an installation problem.
+* Some old PHP5 packages are removed from setup, fixing an installation bug where Apache would get installed.
+* Python 3 packages for the control panel are now installed using a virtualenv to prevent installation errors due to conflicts in the cryptography/openssl packages between OS-installed packages and pip-installed packages.
+
+v0.25 (November 15, 2017)
+-------------------------
+
+This update is a security update addressing [CVE-2017-16651, a vulnerability in Roundcube webmail that allows logged-in users to access files on the local filesystem](https://roundcube.net/news/2017/11/08/security-updates-1.3.3-1.2.7-and-1.1.10).
+
+Mail:
+
+* Update to Roundcube 1.3.3.
+
+Control Panel:
+
+* Allow custom DNS records to be set for DNS wildcard subdomains (i.e. `*`).
+
+v0.24 (October 3, 2017)
+-----------------------
+
+System:
+
+* Install PHP7 via a PPA. Switch to the on-demand process manager.
+
+Mail:
+
+* Updated to [Roundcube 1.3.1](https://roundcube.net/news/2017/06/26/roundcube-webmail-1.3.0-released), but unfortunately dropping the Vacation plugin because it has not been supported by its author and is not compatible with Roundcube 1.3, and updated the persistent login plugin.
+* Updated to [Z-Push 2.3.8](http://download.z-push.org/final/2.3/z-push-2.3.8.txt).
+* Dovecot now uses stronger 2048 bit DH params for better forward secrecy.
+
+Nextcloud:
+
+* Nextcloud updated to 12.0.3, using PHP7.
+
+Control Panel:
+
+* Nameserver (NS) records can now be set on custom domains.
+* Fix an erroneous status check error due to IPv6 address formatting.
+* Aliases for administrative addresses can now be set to send mail to +tag administrative addresses.
+
 v0.23a (May 31, 2017)
 ---------------------
 

CONTRIBUTING.md

@@ -1,3 +1,50 @@
+# Contributing
+
+Mail-in-a-Box is an open source project. Your contributions and pull requests are welcome.
+
+## Development
+
+To start developing Mail-in-a-Box, [clone the repository](https://github.com/mail-in-a-box/mailinabox) and familiarize yourself with the code.
+
+    $ git clone https://github.com/mail-in-a-box/mailinabox
+
+### Vagrant and VirtualBox
+
+We recommend you use [Vagrant](https://www.vagrantup.com/intro/getting-started/install.html) and [VirtualBox](https://www.virtualbox.org/wiki/Downloads) for development. Please install them first.
+
+With Vagrant set up, the following should boot up Mail-in-a-Box inside a virtual machine:
+
+    $ vagrant up --provision
+
+_If you're seeing an error message about your *IP address being listed in the Spamhaus Block List*, simply uncomment the `export SKIP_NETWORK_CHECKS=1` line in `Vagrantfile`. It's normal, you're probably using a dynamic IP address assigned by your Internet provider–they're almost all listed._
+
+### Modifying your `hosts` file
+
+After a while, Mail-in-a-Box will be available at `192.168.56.4` (unless you changed that in your `Vagrantfile`). To be able to use the web-based bits, we recommend to add a hostname to your `hosts` file:
+
+    $ echo "192.168.56.4 mailinabox.lan" | sudo tee -a /etc/hosts
+
+You should now be able to navigate to https://mailinabox.lan/admin using your browser. There should be an initial admin user with the name `me@mailinabox.lan` and the password `12345678`.
+
+### Making changes
+
+Your working copy of Mail-in-a-Box will be mounted inside your VM at `/vagrant`. Any change you make locally will appear inside your VM automatically.
+
+Running `vagrant up --provision` again will repeat the installation with your modifications.
+
+Alternatively, you can also ssh into the VM using:
+
+    $ vagrant ssh
+
+Once inside the VM, you can re-run individual parts of the setup like in this example:
+
+    vm$ cd /vagrant
+    vm$ sudo setup/owncloud.sh # replace with script you'd like to re-run
+
+### Tests
+
+Mail-in-a-Box needs more tests. If you're still looking for a way to help out, writing and contributing tests would be a great start!
+
 ## Public domain
 
 This project is in the public domain. Copyright and related rights in the work worldwide are waived through the [CC0 1.0 Universal public domain dedication][CC0]. See the LICENSE file in this directory.

README.md

@@ -1,99 +1,101 @@
-Mail-in-a-Box
-=============
+# Power Mail-in-a-Box
+## **[Installation](#installation)** (current version: v60.5)
+## **[Upgrading Quick Start](#upgrading)**
 
-By [@JoshData](https://github.com/JoshData) and [contributors](https://github.com/mail-in-a-box/mailinabox/graphs/contributors).
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/davness)
 
-Mail-in-a-Box helps individuals take back control of their email by defining a one-click, easy-to-deploy SMTP+everything else server: a mail server in a box.
+Power Mail-in-a-Box (a fork of [Mail-in-a-Box](https://mailinabox.email/)) is a complete pre-configured mail appliance, quickly deployable in a matter of minutes.
 
-**Please see [https://mailinabox.email](https://mailinabox.email) for the project's website and setup guide!**
+It's main difference to the main project is focused on ad-hoc, advanced features. While Mail-in-a-Box caters to beginners by providing sane configurations, Power Mail-in-a-Box also attempts to cater to advanced users that want deeper levels of customization.
 
-* * *
+## Features
+- Configure Power Mail-in-a-Box to use an external SMTP relay;
+- Brand new admin panel (with up-to-date libraries);
+- Perform backups right away from the admin panel;
+- Account quotas support (thanks to **@[jrsupplee](https://github.com/jrsupplee/mailinabox)**!)
+- Customize TTL's for custom DNS records;
+- Publish OpenPGP keys authoritatively via a WKD server;
+- - **In the future:** Allow usage of OpenPGP keys to encrypt backups;
+- Per-domain nginx configuration;
 
-Our goals are to:
+## Goals
+- **Easy of use** - deployment shouldn't take too many technical details to understand. Power Mail-in-a-Box already comes with default configurations which should be good for most users.
+- **Privacy, security and independence** - keeping your mail and data safe from advertisers and prying eyes.
+- **Accessible customizability** - bring the features closer to the people instead of tucking them away in configuration files.
+- **Customizability potential** - allow for deep customization by power users.
+- **Concentration** - all the services you need in just one box.
+- **Support** - support a wide range of operating systems when possible, without compromising the codebase as a whole.
+- **Lightweight** - should be able to run even with very limited resources.
 
-* Make deploying a good mail server easy.
-* Promote [decentralization](http://redecentralize.org/), innovation, and privacy on the web.
-* Have automated, auditable, and [idempotent](https://sharknet.us/2014/02/01/automated-configuration-management-challenges-with-idempotency/) configuration.
-* **Not** make a totally unhackable, NSA-proof server.
-* **Not** make something customizable by power users.
+## Non-goals
+- **Scalability** - this appliance is geared towards individuals and small/mid-sized organizations. If your use case is mission-critical it probably is a better idea to shop for a product that provides support.
+- **Portability** - I didn't figure out yet a way to easily transition from Mail-in-a-Box to Power Mail-in-a-Box.
 
-Additionally, this project has a [Code of Conduct](CODE_OF_CONDUCT.md), which supersedes the goals above. Please review it when joining our community.
+# Minimum Pre-requisites
+The machine this appliance will be installed on needs to have the following specs (or better). Most cloud providers are able to provide VM's that satisfy these specs at relatively low cost.
 
-The Box
--------
+<small>_These specs depend on the number of users being served and/or amount of traffic_</small>
+- 1 CPU core;
+- 512MB of RAM (**at least 1GB** is recommended);
+- 10GB of disk;
+- **One of the following operating systems:**
+- - Debian GNU/Linux 11 (Bullseye)
+- - Ubuntu LTS 20.04 (Focal Fossa)
+- - Ubuntu LTS 22.04 (Jammy Jellyfish)
 
-Mail-in-a-Box turns a fresh Ubuntu 14.04 LTS 64-bit machine into a working mail server by installing and configuring various components.
+## Legacy Support
+The following distributions are no longer supported for the latest version, but they used to be supported at a earlier time:
+- **Debian 10 (Buster)** <= **v56.5**
 
-It is a one-click email appliance. There are no user-configurable setup options. It "just works".
+<small>_These network requirements are usually not provided by residential ISP's. They are not **strictly required** for Power Mail-in-a-Box to install, but it will take more work to get it running as intended._</small>
+- Static, public IPv4 (most residential connections **do not** provide static addresses);
+- - If the machine is behind a NAT, manual configuration might be required.
+- Reverse DNS for that IPv4 address (**Caution:** some cloud providers do not provide this);
+- You should be able to edit the firewall for that address. **In particular, outbound port 25 should not be blocked.**
 
-The components installed are:
+# Firewall
+If the machine is behind an external firewall or NAT, the following **inbound ports SHOULD** be open to external traffic:
 
-* SMTP ([postfix](http://www.postfix.org/)), IMAP ([dovecot](http://dovecot.org/)), CardDAV/CalDAV ([Nextcloud](https://nextcloud.com/)), Exchange ActiveSync ([z-push](http://z-push.org/))
-* Webmail ([Roundcube](http://roundcube.net/)), static website hosting ([nginx](http://nginx.org/))
-* Spam filtering ([spamassassin](https://spamassassin.apache.org/)), greylisting ([postgrey](http://postgrey.schweikert.ch/))
-* DNS ([nsd4](https://www.nlnetlabs.nl/projects/nsd/)) with [SPF](https://en.wikipedia.org/wiki/Sender_Policy_Framework), DKIM ([OpenDKIM](http://www.opendkim.org/)), [DMARC](https://en.wikipedia.org/wiki/DMARC), [DNSSEC](https://en.wikipedia.org/wiki/DNSSEC), [DANE TLSA](https://en.wikipedia.org/wiki/DNS-based_Authentication_of_Named_Entities), and [SSHFP](https://tools.ietf.org/html/rfc4255) records automatically set
-* Backups ([duplicity](http://duplicity.nongnu.org/)), firewall ([ufw](https://launchpad.net/ufw)), intrusion protection ([fail2ban](http://www.fail2ban.org/wiki/index.php/Main_Page)), system monitoring ([munin](http://munin-monitoring.org/))
+- `25/tcp`
+- `53/tcp`
+- `53/udp`
+- `80/tcp`
+- `443/tcp`
+- `465/tcp`
+- `587/tcp`
+- `993/tcp`
+- `995/tcp`
+- `4190/tcp`
 
-It also includes:
+# Installation
 
-* A control panel and API for adding/removing mail users, aliases, custom DNS records, etc. and detailed system monitoring.
-* Our own builds of postgrey (adding better whitelisting) and dovecot-lucene (faster search for mail) distributed via the [Mail-in-a-Box PPA](https://launchpad.net/~mail-in-a-box/+archive/ubuntu/ppa) on Launchpad.
+1. Power Mail-in-a-Box uses `ufw` to configure it's internal firewall. If your cloud provider requires you to use another tool (usually it does not, but <small>\*cough\* _Oracle Cloud_ \*cough\*</small>), you can follow [these instructions](https://github.com/ddavness/power-mailinabox/discussions/21).
 
-For more information on how Mail-in-a-Box handles your privacy, see the [security details page](security.md).
+2. Make sure `curl` is installed and locales are configured correctly - you'll want to make sure the primary locale is set to `en_US.UTF-8`:
+```
+sudo apt install curl locales
+sudo dpkg-reconfigure locales
+```
 
-Installation
-------------
+3. Run the following command, and then follow the instructions that appear on the screen:
+```
+curl -L https://power-mailinabox.net/setup.sh | sudo bash
+```
 
-See the [setup guide](https://mailinabox.email/guide.html) for detailed, user-friendly instructions.
+# Upgrading
 
-For experts, start with a completely fresh (really, I mean it) Ubuntu 14.04 LTS 64-bit machine. On the machine...
+To upgrade an existing box to the latest version, run the same command as you do to perform a new installation:
 
-Clone this repository:
+```
+curl -L https://power-mailinabox.net/setup.sh | sudo bash
+```
 
-	$ git clone https://github.com/mail-in-a-box/mailinabox
-	$ cd mailinabox
+## Installing or upgrading to a different version
+If for some reason you wish to install a different version (for example, an older version for a workaround, or a beta/release candidate version for testing), you can use the following command.
 
-_Optional:_ Download my PGP key and then verify that the sources were signed
-by me:
+```
+curl -L https://power-mailinabox.net/<VERSION>/setup.sh | sudo bash
+```
+Where `<VERSION>` is the version you want to install. (**Example:** `v60.0`).
 
-	$ curl -s https://keybase.io/joshdata/key.asc | gpg --import
-	gpg: key C10BDD81: public key "Joshua Tauberer <jt@occams.info>" imported
-
-	$ git verify-tag v0.23a
-	gpg: Signature made ..... using RSA key ID C10BDD81
-	gpg: Good signature from "Joshua Tauberer <jt@occams.info>"
-	gpg: WARNING: This key is not certified with a trusted signature!
-	gpg:          There is no indication that the signature belongs to the owner.
-	Primary key fingerprint: 5F4C 0E73 13CC D744 693B  2AEA B920 41F4 C10B DD81
-
-You'll get a lot of warnings, but that's OK. Check that the primary key fingerprint matches the
-fingerprint in the key details at [https://keybase.io/joshdata](https://keybase.io/joshdata)
-and on my [personal homepage](https://razor.occams.info/). (Of course, if this repository has been compromised you can't trust these instructions.)
-
-Checkout the tag corresponding to the most recent release:
-
-	$ git checkout v0.23a
-
-Begin the installation.
-
-	$ sudo setup/start.sh
-
-For help, DO NOT contact me directly --- I don't do tech support by email or tweet (no exceptions).
-
-Post your question on the [discussion forum](https://discourse.mailinabox.email/) instead, where me and other Mail-in-a-Box users may be able to help you.
-
-The Acknowledgements
---------------------
-
-This project was inspired in part by the ["NSA-proof your email in 2 hours"](http://sealedabstract.com/code/nsa-proof-your-e-mail-in-2-hours/) blog post by Drew Crawford, [Sovereign](https://github.com/sovereign/sovereign) by Alex Payne, and conversations with <a href="https://twitter.com/shevski" target="_blank">@shevski</a>, <a href="https://github.com/konklone" target="_blank">@konklone</a>, and <a href="https://github.com/gregelin" target="_blank">@GregElin</a>.
-
-Mail-in-a-Box is similar to [iRedMail](http://www.iredmail.org/) and [Modoboa](https://github.com/tonioo/modoboa).
-
-The History
------------
-
-* In 2007 I wrote a relatively popular Mozilla Thunderbird extension that added client-side SPF and DKIM checks to mail to warn users about possible phishing: [add-on page](https://addons.mozilla.org/en-us/thunderbird/addon/sender-verification-anti-phish/), [source](https://github.com/JoshData/thunderbird-spf).
-* In August 2013 I began Mail-in-a-Box by combining my own mail server configuration with the setup in ["NSA-proof your email in 2 hours"](http://sealedabstract.com/code/nsa-proof-your-e-mail-in-2-hours/) and making the setup steps reproducible with bash scripts.
-* Mail-in-a-Box was a semifinalist in the 2014 [Knight News Challenge](https://www.newschallenge.org/challenge/2014/submissions/mail-in-a-box), but it was not selected as a winner.
-* Mail-in-a-Box hit the front page of Hacker News in [April](https://news.ycombinator.com/item?id=7634514) 2014, [September](https://news.ycombinator.com/item?id=8276171) 2014, [May](https://news.ycombinator.com/item?id=9624267) 2015, and [November](https://news.ycombinator.com/item?id=13050500) 2016.
-* FastCompany mentioned Mail-in-a-Box a [roundup of privacy projects](http://www.fastcompany.com/3047645/your-own-private-cloud) on June 26, 2015.
+> ⚠️ **Downgrading might not always be possible and is not supported!** Make sure you know what you're doing before doing so.

Vagrantfile

@@ -1,35 +1,75 @@
+
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 
-Vagrant.configure("2") do |config|
-  config.vm.box = "ubuntu14.04"
-  config.vm.box_url = "http://cloud-images.ubuntu.com/vagrant/trusty/current/trusty-server-cloudimg-amd64-vagrant-disk1.box"
+ip = 2
+machines = [
+  {
+    'iso' => "debian/buster64",
+    'host' => "buster"
+  },
+  {
+    'iso' => "generic/ubuntu2004",
+    'host' => "focal"
+  },
+  {
+    'iso' => "debian/bullseye64",
+    'host' => "bullseye"
+  },
+	{
+    'iso' => "generic/ubuntu2204",
+    'host' => "jammy"
+  },
+]
 
-  if Vagrant.has_plugin?("vagrant-cachier")
-    # Configure cached packages to be shared between instances of the same base box.
-    # More info on http://fgrehm.viewdocs.io/vagrant-cachier/usage
-    config.cache.scope = :box
+Vagrant.configure("2") do |config|
+  config.vm.provider :virtualbox do |vb|
+    vb.customize ["modifyvm", :id, "--cpus", 1, "--memory", 768]
+  end
+  config.vm.provider :libvirt do |v|
+    v.memory = 768
+    v.cpus = 1
+    v.nested = true
+  end
+  config.vm.provider :kvm do |kvm|
+    kvm.memory_size = '768m'
   end
 
   # Network config: Since it's a mail server, the machine must be connected
   # to the public web. However, we currently don't want to expose SSH since
   # the machine's box will let anyone log into it. So instead we'll put the
   # machine on a private network.
-  config.vm.hostname = "mailinabox.lan"
-  config.vm.network "private_network", ip: "192.168.50.4"
+  config.vm.synced_folder ".", "/vagrant", nfs_version: "4"
 
-  config.vm.provision :shell, :inline => <<-SH
-	# Set environment variables so that the setup script does
-	# not ask any questions during provisioning. We'll let the
-	# machine figure out its own public IP.
-    export NONINTERACTIVE=1
-    export PUBLIC_IP=auto
-    export PUBLIC_IPV6=auto
-    export PRIMARY_HOSTNAME=auto
-    #export SKIP_NETWORK_CHECKS=1
+  (0..(machines.size - 1)).each do |n|
+    node = machines[n]
+    config.vm.define node['host'] do |m|
+      m.vm.box = node['iso']
+      m.vm.hostname = "#{node['host']}.mailinabox.lan"
+      m.vm.network "private_network", ip: "192.168.168.#{ip+n}"
 
-    # Start the setup script.
-    cd /vagrant
-    setup/start.sh
-SH
+      m.vm.provision "shell", :inline => <<-SH
+				git config --global --add safe.directory /vagrant
+
+        # Set environment variables so that the setup script does
+        # not ask any questions during provisioning. We'll let the
+        # machine figure out its own public IP.
+        export NONINTERACTIVE=1
+        export PUBLIC_IP=192.168.168.#{ip+n}
+        export PUBLIC_IPV6=auto
+        export PRIVATE_IP=192.168.168.#{ip+n}
+        export PRIMARY_HOSTNAME=\"#{node['host']}.mailinabox.lan\"
+        export SKIP_NETWORK_CHECKS=1
+        # Start the setup script.
+        cd /vagrant
+        setup/start.sh
+        # After setup is done, fully open the ssh ports again
+        ufw allow ssh
+  SH
+
+        m.vm.provision "shell", run: "always", :inline => <<-SH
+          service mailinabox restart
+  SH
+    end
+  end
 end

api/docs/generate-docs.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env sh
+
+# Requirements:
+# - Node.js
+# - redoc-cli (`npm install redoc-cli -g`)
+
+redoc-cli bundle ../mailinabox.yml \
+  -t template.hbs \
+  -o api-docs.html \
+  --templateOptions.metaDescription="Mail-in-a-Box HTTP API" \
+  --title="Mail-in-a-Box HTTP API" \
+  --options.expandSingleSchemaField \
+  --options.hideSingleRequestSampleTab \
+  --options.jsonSampleExpandLevel=10 \
+  --options.hideDownloadButton \
+  --options.theme.logo.maxHeight=180px \
+  --options.theme.logo.maxWidth=180px \
+  --options.theme.colors.primary.main="#C52" \
+  --options.theme.typography.fontSize=16px \
+  --options.theme.typography.fontFamily="Raleway, sans-serif" \
+  --options.theme.typography.headings.fontFamily="Ubuntu, Arial, sans-serif" \
+  --options.theme.typography.code.fontSize=15px \
+  --options.theme.typography.code.fontFamily='"Source Code Pro", monospace'

api/docs/template.hbs

@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+  <meta charset="utf8" />
+  <title>{{title}}</title>
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <meta name="description" content="{{templateOptions.metaDescription}}" />
+  <link rel="icon" type="image/png" href="https://mailinabox.email/static/logo_small.png">
+  <link rel="apple-touch-icon" type="image/png" href="https://mailinabox.email/static/logo_small.png">
+  <link href="https://fonts.googleapis.com/css?family=Raleway:400,700" rel="stylesheet" />
+  <link href="https://fonts.googleapis.com/css?family=Ubuntu:300" rel="stylesheet" />
+  <link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:500" rel="stylesheet" />
+  <style>
+    body {
+      margin: 0;
+      padding: 0;
+    }
+
+    h1 {
+      color: #000 !important;
+    }
+  </style>
+  {{{redocHead}}}
+</head>
+
+<body>
+  {{{redocHTML}}}
+</body>
+
+</html>

conf/dovecot/conf.d/20-imap.conf

@@ -0,0 +1,94 @@
+##
+## IMAP specific settings
+##
+
+# If nothing happens for this long while client is IDLEing, move the connection
+# to imap-hibernate process and close the old imap process. This saves memory,
+# because connections use very little memory in imap-hibernate process. The
+# downside is that recreating the imap process back uses some resources.
+#imap_hibernate_timeout = 0
+
+# Maximum IMAP command line length. Some clients generate very long command
+# lines with huge mailboxes, so you may need to raise this if you get
+# "Too long argument" or "IMAP command line too large" errors often.
+#imap_max_line_length = 64k
+
+# IMAP logout format string:
+#  %i - total number of bytes read from client
+#  %o - total number of bytes sent to client
+#  %{fetch_hdr_count} - Number of mails with mail header data sent to client
+#  %{fetch_hdr_bytes} - Number of bytes with mail header data sent to client
+#  %{fetch_body_count} - Number of mails with mail body data sent to client
+#  %{fetch_body_bytes} - Number of bytes with mail body data sent to client
+#  %{deleted} - Number of mails where client added \Deleted flag
+#  %{expunged} - Number of mails that client expunged, which does not
+#                include automatically expunged mails
+#  %{autoexpunged} - Number of mails that were automatically expunged after
+#                    client disconnected
+#  %{trashed} - Number of mails that client copied/moved to the
+#               special_use=\Trash mailbox.
+#  %{appended} - Number of mails saved during the session
+#imap_logout_format = in=%i out=%o
+
+# Override the IMAP CAPABILITY response. If the value begins with '+',
+# add the given capabilities on top of the defaults (e.g. +XFOO XBAR).
+#imap_capability = 
+
+# How long to wait between "OK Still here" notifications when client is
+# IDLEing.
+#imap_idle_notify_interval = 2 mins
+imap_idle_notify_interval=4 mins
+
+# ID field names and values to send to clients. Using * as the value makes
+# Dovecot use the default value. The following fields have default values
+# currently: name, version, os, os-version, support-url, support-email.
+#imap_id_send = 
+
+# ID fields sent by client to log. * means everything.
+#imap_id_log =
+
+# Workarounds for various client bugs:
+#   delay-newmail:
+#     Send EXISTS/RECENT new mail notifications only when replying to NOOP
+#     and CHECK commands. Some clients ignore them otherwise, for example OSX
+#     Mail (<v2.1). Outlook Express breaks more badly though, without this it
+#     may show user "Message no longer in server" errors. Note that OE6 still
+#     breaks even with this workaround if synchronization is set to
+#     "Headers Only".
+#   tb-extra-mailbox-sep:
+#     Thunderbird gets somehow confused with LAYOUT=fs (mbox and dbox) and
+#     adds extra '/' suffixes to mailbox names. This option causes Dovecot to
+#     ignore the extra '/' instead of treating it as invalid mailbox name.
+#   tb-lsub-flags:
+#     Show \Noselect flags for LSUB replies with LAYOUT=fs (e.g. mbox).
+#     This makes Thunderbird realize they aren't selectable and show them
+#     greyed out, instead of only later giving "not selectable" popup error.
+#
+# The list is space-separated.
+#imap_client_workarounds = 
+
+# Host allowed in URLAUTH URLs sent by client. "*" allows all.
+#imap_urlauth_host =
+
+# What happens when FETCH fails due to some internal error:
+#   disconnect-immediately:
+#     The FETCH is aborted immediately and the IMAP client is disconnected.
+#   disconnect-after:
+#     The FETCH runs for all the requested mails returning as much data as
+#     possible. The client is finally disconnected without a tagged reply.
+#   no-after:
+#     Same as disconnect-after, but tagged NO reply is sent instead of
+#     disconnecting the client. If the client attempts to FETCH the same failed
+#     mail more than once, the client is disconnected. This is to avoid clients
+#     from going into infinite loops trying to FETCH a broken mail.
+#imap_fetch_failure = disconnect-immediately
+
+mail_plugins = $mail_plugins quota
+protocol imap {
+  # Space separated list of plugins to load (default is global mail_plugins).
+  mail_plugins = $mail_plugins antispam imap_quota
+
+  # Maximum number of IMAP connections allowed for a user from each IP address.
+  # NOTE: The username is compared case-sensitively.
+  #mail_max_userip_connections = 10
+}

conf/dovecot/conf.d/90-quota.conf

@@ -0,0 +1,98 @@
+##
+## Quota configuration.
+##
+
+# Note that you also have to enable quota plugin in mail_plugins setting.
+# <doc/wiki/Quota.txt>
+
+##
+## Quota limits
+##
+
+# Quota limits are set using "quota_rule" parameters. To get per-user quota
+# limits, you can set/override them by returning "quota_rule" extra field
+# from userdb. It's also possible to give mailbox-specific limits, for example
+# to give additional 100 MB when saving to Trash:
+
+plugin {
+  #quota_rule = *:storage=1G
+  #quota_rule2 = Trash:storage=+100M
+
+  # LDA/LMTP allows saving the last mail to bring user from under quota to
+  # over quota, if the quota doesn't grow too high. Default is to allow as
+  # long as quota will stay under 10% above the limit. Also allowed e.g. 10M.
+  #quota_grace = 10%%
+
+  # Quota plugin can also limit the maximum accepted mail size.
+  #quota_max_mail_size = 100M
+}
+
+##
+## Quota warnings
+##
+
+# You can execute a given command when user exceeds a specified quota limit.
+# Each quota root has separate limits. Only the command for the first
+# exceeded limit is excecuted, so put the highest limit first.
+# The commands are executed via script service by connecting to the named
+# UNIX socket (quota-warning below).
+# Note that % needs to be escaped as %%, otherwise "% " expands to empty.
+
+plugin {
+  #quota_warning = storage=95%% quota-warning 95 %u
+  #quota_warning2 = storage=80%% quota-warning 80 %u
+}
+
+# Example quota-warning service. The unix listener's permissions should be
+# set in a way that mail processes can connect to it. Below example assumes
+# that mail processes run as vmail user. If you use mode=0666, all system users
+# can generate quota warnings to anyone.
+#service quota-warning {
+#  executable = script /usr/local/bin/quota-warning.sh
+#  user = dovecot
+#  unix_listener quota-warning {
+#    user = vmail
+#  }
+#}
+
+##
+## Quota backends
+##
+
+# Multiple backends are supported:
+#   dirsize: Find and sum all the files found from mail directory.
+#            Extremely SLOW with Maildir. It'll eat your CPU and disk I/O.
+#   dict: Keep quota stored in dictionary (eg. SQL)
+#   maildir: Maildir++ quota
+#   fs: Read-only support for filesystem quota
+
+plugin {
+  quota = maildir
+
+  quota_grace = 10%
+
+  quota_status_success = DUNNO
+  quota_status_nouser = DUNNO
+  quota_status_overquota = "522 5.2.2 Mailbox is full"
+
+  #quota = dirsize:User quota
+  #quota = maildir:User quota
+  #quota = dict:User quota::proxy::quota
+  #quota = fs:User quota
+}
+
+service quota-status {
+    executable = quota-status -p postfix
+    inet_listener {
+        port = 12340
+    }
+}
+
+# Multiple quota roots are also possible, for example this gives each user
+# their own 100MB quota and one shared 1GB quota within the domain:
+plugin {
+  #quota = dict:user::proxy::quota
+  #quota2 = dict:domain:%d:proxy::quota_domain
+  #quota_rule = *:storage=102400
+  #quota2_rule = *:storage=1048576
+}

conf/fail2ban/filter.d/dovecotimap.conf

@@ -1,4 +1,4 @@
-# Fail2Ban filter Dovecot authentication and pop3/imap server
+# Fail2Ban filter Dovecot authentication and pop3/imap/managesieve server
 # For Mail-in-a-Box
 
 [INCLUDES]
@@ -9,7 +9,7 @@ before = common.conf
 
 _daemon = (auth|dovecot(-auth)?|auth-worker)
 
-failregex = ^%(__prefix_line)s(pop3|imap)-login: (Info: )?(Aborted login|Disconnected)(: Inactivity)? \(((no auth attempts|auth failed, \d+ attempts)( in \d+ secs)?|tried to use (disabled|disallowed) \S+ auth)\):( user=<\S*>,)?( method=\S+,)? rip=<HOST>, lip=(\d{1,3}\.){3}\d{1,3}(, TLS( handshaking)?(: Disconnected)?)?(, session=<\S+>)?\s*$
+failregex = ^%(__prefix_line)s(pop3|imap|managesieve)-login: (Info: )?(Aborted login|Disconnected)(: Inactivity)? \(((no auth attempts|auth failed, \d+ attempts)( in \d+ secs)?|tried to use (disabled|disallowed) \S+ auth)\):( user=<\S*>,)?( method=\S+,)? rip=<HOST>, lip=(\d{1,3}\.){3}\d{1,3}(, TLS( handshaking)?(: Disconnected)?)?(, session=<\S+>)?\s*$
 
 ignoreregex =
 

conf/fail2ban/filter.d/miab-owncloud.conf

@@ -3,5 +3,6 @@
 before = common.conf
 
 [Definition]
+datepattern = %%Y-%%m-%%d %%H:%%M:%%S
 failregex=Login failed: .*Remote IP: '<HOST>[\)']
 ignoreregex =

conf/fail2ban/jails.conf

@@ -5,7 +5,7 @@
 # Whitelist our own IP addresses. 127.0.0.1/8 is the default. But our status checks
 # ping services over the public interface so we should whitelist that address of
 # ours too. The string is substituted during installation.
-ignoreip = 127.0.0.1/8 PUBLIC_IP
+ignoreip = 127.0.0.1/8 PUBLIC_IP ::1 PUBLIC_IPV6
 
 [dovecot]
 enabled = true
@@ -38,6 +38,14 @@ logpath  = STORAGE_ROOT/owncloud/nextcloud.log
 maxretry = 20
 findtime = 120
 
+[miab-postfix465]
+enabled  = true
+port     = 465
+filter   = miab-postfix-submission
+logpath  = /var/log/mail.log
+maxretry = 20
+findtime = 30
+
 [miab-postfix587]
 enabled  = true
 port     = 587
@@ -50,7 +58,7 @@ findtime = 30
 enabled  = true
 port     = http,https
 filter   = miab-roundcube
-logpath  = /var/log/roundcubemail/errors
+logpath  = /var/log/roundcubemail/errors.log
 maxretry = 20
 findtime = 30
 
@@ -69,13 +77,10 @@ action   = iptables-allports[name=recidive]
 # So the notification is ommited. This will prevent message appearing in the mail.log that mail
 # can't be delivered to fail2ban@$HOSTNAME.
 
-[sasl]
+[postfix-sasl]
 enabled  = true
 
-[ssh]
+[sshd]
 enabled = true
 maxretry = 7
 bantime = 3600
-
-[ssh-ddos]
-enabled  = true

conf/ios-profile.xml

@@ -18,8 +18,6 @@
       <string>PRIMARY_HOSTNAME</string>
       <key>CalDAVPort</key>
       <real>443</real>
-      <key>CalDAVPrincipalURL</key>
-      <string>/cloud/remote.php/caldav/calendars/</string>
       <key>CalDAVUseSSL</key>
       <true/>
       <key>PayloadDescription</key>
@@ -55,7 +53,7 @@
       <key>OutgoingMailServerHostName</key>
       <string>PRIMARY_HOSTNAME</string>
       <key>OutgoingMailServerPortNumber</key>
-      <integer>587</integer>
+      <integer>465</integer>
       <key>OutgoingMailServerUseSSL</key>
       <true/>
       <key>OutgoingPasswordSameAsIncomingPassword</key>

conf/mailinabox.service

@@ -0,0 +1,11 @@
+[Unit]
+Description=Mail-in-a-Box System Management Service
+After=multi-user.target
+
+[Service]
+Type=idle
+IgnoreSIGPIPE=False
+ExecStart=/usr/local/lib/mailinabox/start
+
+[Install]
+WantedBy=multi-user.target

conf/management-initscript

@@ -1,135 +0,0 @@
-#! /bin/sh
-### BEGIN INIT INFO
-# Provides:          mailinabox
-# Required-Start:    $all
-# Required-Stop:     $all
-# Default-Start:     2 3 4 5
-# Default-Stop:      0 1 6
-# Short-Description: Start and stop the Mail-in-a-Box management daemon.
-# Description:       Start and stop the Mail-in-a-Box management daemon.
-### END INIT INFO
-
-# Adapted from http://blog.codefront.net/2007/06/11/nginx-php-and-a-php-fastcgi-daemon-init-script/
-
-PATH=/sbin:/usr/sbin:/bin:/usr/bin
-DESC="Mail-in-a-Box Management Daemon"
-NAME=mailinabox
-DAEMON=/usr/local/bin/mailinabox-daemon
-PIDFILE=/var/run/$NAME.pid
-SCRIPTNAME=/etc/init.d/$NAME
-
-# Exit if the package is not installed
-[ -x "$DAEMON" ] || exit 0
-
-# Set defaults.
-START=yes
-EXEC_AS_USER=root
-
-# Ensure Python reads/writes files in UTF-8. If the machine
-# triggers some other locale in Python, like ASCII encoding,
-# Python may not be able to read/write files. Set also
-# setup/start.sh (where the locale is also installed if not
-# already present) and management/daily_tasks.sh.
-export LANGUAGE=en_US.UTF-8
-export LC_ALL=en_US.UTF-8
-export LANG=en_US.UTF-8
-export LC_TYPE=en_US.UTF-8
-
-# Read configuration variable file if it is present
-[ -r /etc/default/$NAME ] && . /etc/default/$NAME
-
-# Load the VERBOSE setting and other rcS variables
-. /lib/init/vars.sh
-
-# Define LSB log_* functions.
-# Depend on lsb-base (>= 3.0-6) to ensure that this file is present.
-. /lib/lsb/init-functions
-
-# If the daemon is not enabled, give the user a warning and then exit,
-# unless we are stopping the daemon
-if [ "$START" != "yes" -a "$1" != "stop" ]; then
-        log_warning_msg "To enable $NAME, edit /etc/default/$NAME and set START=yes"
-        exit 0
-fi
-
-# Process configuration
-#export ...
-DAEMON_ARGS=""
-
-
-do_start()
-{
-        # Return
-        #   0 if daemon has been started
-        #   1 if daemon was already running
-        #   2 if daemon could not be started
-        start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
-                || return 1
-        start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON \
-                --background --make-pidfile --chuid $EXEC_AS_USER --startas $DAEMON -- \
-                $DAEMON_ARGS \
-                || return 2
-}
-
-do_stop()
-{
-        # Return
-        #   0 if daemon has been stopped
-        #   1 if daemon was already stopped
-        #   2 if daemon could not be stopped
-        #   other if a failure occurred
-        start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE > /dev/null # --name $DAEMON
-        RETVAL="$?"
-        [ "$RETVAL" = 2 ] && return 2
-        # Wait for children to finish too if this is a daemon that forks
-        # and if the daemon is only ever run from this initscript.
-        # If the above conditions are not satisfied then add some other code
-        # that waits for the process to drop all resources that could be
-        # needed by services started subsequently.  A last resort is to
-        # sleep for some time.
-        start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
-        [ "$?" = 2 ] && return 2
-        # Many daemons don't delete their pidfiles when they exit.
-        rm -f $PIDFILE
-        return "$RETVAL"
-}
-case "$1" in
-  start)
-        [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
-        do_start
-        case "$?" in
-                0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
-                2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
-        esac
-        ;;
-  stop)
-        [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
-        do_stop
-        case "$?" in
-                0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
-                2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
-        esac
-        ;;
-  restart|force-reload)
-        log_daemon_msg "Restarting $DESC" "$NAME"
-        do_stop
-        case "$?" in
-          0|1)
-                do_start
-                case "$?" in
-                        0) log_end_msg 0 ;;
-                        1) log_end_msg 1 ;; # Old process is still running
-                        *) log_end_msg 1 ;; # Failed to start
-                esac
-                ;;
-          *)
-                # Failed to stop
-                log_end_msg 1
-                ;;
-        esac
-        ;;
-  *)
-        echo "Usage: $SCRIPTNAME {start|stop|restart|force-reload}" >&2
-        exit 3
-        ;;
-esac

conf/mozilla-autoconfig.xml

@@ -16,12 +16,12 @@
 
       <outgoingServer type="smtp">
          <hostname>PRIMARY_HOSTNAME</hostname>
-         <port>587</port>
-         <socketType>STARTTLS</socketType>
+         <port>465</port>
+         <socketType>SSL</socketType>
          <username>%EMAILADDRESS%</username>
          <authentication>password-cleartext</authentication>
          <addThisServer>true</addThisServer>
-         <useGlobalPreferredServer>true</useGlobalPreferredServer>
+         <useGlobalPreferredServer>false</useGlobalPreferredServer>
       </outgoingServer>
 
       <documentation url="https://PRIMARY_HOSTNAME/">

conf/mta-sts.txt

@@ -0,0 +1,4 @@
+version: STSv1
+mode: MODE
+mx: PRIMARY_HOSTNAME
+max_age: 604800

conf/munin.service

@@ -0,0 +1,10 @@
+[Unit]
+Description=Munin System Monitoring Startup Script
+After=multi-user.target
+
+[Service]
+Type=idle
+ExecStart=/usr/local/lib/mailinabox/munin_start.sh
+
+[Install]
+WantedBy=multi-user.target

conf/nginx-alldomains.conf

@@ -1,6 +1,6 @@
-	# Expose this directory as static files.
 	root $ROOT;
-	index index.html index.htm;
+
+	# ADDITIONAL DIRECTIVES HERE
 
 	location = /robots.txt {
 		log_not_found off;
@@ -18,29 +18,11 @@
 	location = /.well-known/autoconfig/mail/config-v1.1.xml {
 		alias /var/lib/mailinabox/mozilla-autoconfig.xml;
 	}
-
-	# Roundcube Webmail configuration.
-	rewrite ^/mail$ /mail/ redirect;
-	rewrite ^/mail/$ /mail/index.php;
-	location /mail/ {
-		index index.php;
-		alias /usr/local/lib/roundcubemail/;
+	location = /mail/config-v1.1.xml {
+		alias /var/lib/mailinabox/mozilla-autoconfig.xml;
 	}
-	location ~ /mail/config/.* {
-		# A ~-style location is needed to give this precedence over the next block.
-		return 403;
-	}
-	location ~ /mail/.*\.php {
-		# note: ~ has precendence over a regular location block
-		include fastcgi_params;
-		fastcgi_split_path_info ^/mail(/.*)()$;
-		fastcgi_index index.php;
-		fastcgi_param SCRIPT_FILENAME /usr/local/lib/roundcubemail/$fastcgi_script_name;
-		fastcgi_pass php-fpm;
-
-		# Outgoing mail also goes through this endpoint, so increase the maximum
-		# file upload limit to match the corresponding Postfix limit.
-		client_max_body_size 128M;
+	location = /.well-known/mta-sts.txt {
+		alias /var/lib/mailinabox/mta-sts.txt;
 	}
 
 	# Z-Push (Microsoft Exchange ActiveSync)
@@ -49,7 +31,7 @@
 		fastcgi_param SCRIPT_FILENAME /usr/local/lib/z-push/index.php;
 		fastcgi_param PHP_VALUE "include_path=.:/usr/share/php:/usr/share/pear:/usr/share/awl/inc";
 		fastcgi_read_timeout 630;
-		fastcgi_pass php-fpm;
+		fastcgi_pass php-default;
 
 		# Outgoing mail also goes through this endpoint, so increase the maximum
 		# file upload limit to match the corresponding Postfix limit.
@@ -59,12 +41,9 @@
 		include fastcgi_params;
 		fastcgi_param SCRIPT_FILENAME /usr/local/lib/z-push/autodiscover/autodiscover.php;
 		fastcgi_param PHP_VALUE "include_path=.:/usr/share/php:/usr/share/pear:/usr/share/awl/inc";
-		fastcgi_pass php-fpm;
+		fastcgi_pass php-default;
 	}
 
-
-	# ADDITIONAL DIRECTIVES HERE
-
 	# Disable viewing dotfiles (.htaccess, .svn, .git, etc.)
 	# This block is placed at the end. Nginx's precedence rules means this block
 	# takes precedence over all non-regex matches and only regex matches that

conf/nginx-openpgpkey.conf

@@ -0,0 +1,15 @@
+	# ADDITIONAL DIRECTIVES HERE
+
+	# WKD Locations
+	location ~ ^/.well-known/openpgpkey/(?<domain>.+)/policy$ {
+		add_header Access-Control-Allow-origin * always;
+		if (-d /var/lib/mailinabox/wkd/$domain/) {
+			return 204;
+		}
+		return 404;
+	}
+
+	location ~ ^/.well-known/openpgpkey/(?<domain>.+)/hu/(?<keyid>[ybndrfg8ejkmcpqxot1uwisza345h769]+)$ {
+		add_header Access-Control-Allow-Origin * always;
+		alias /var/lib/mailinabox/wkd/$domain/$keyid;
+	}

conf/nginx-primaryonly.conf

@@ -1,3 +1,5 @@
+	# ADDITIONAL DIRECTIVES HERE
+
 	# Control Panel
 	# Proxy /admin to our Python based control panel daemon. It is
 	# listening on IPv4 only so use an IP address and not 'localhost'.
@@ -12,7 +14,30 @@
 		add_header X-Frame-Options "DENY";
 		add_header X-Content-Type-Options nosniff;
 		add_header Content-Security-Policy "frame-ancestors 'none';";
-		add_header Strict-Transport-Security max-age=31536000;
+	}
+
+	# Roundcube Webmail configuration.
+	rewrite ^/mail$ /mail/ redirect;
+	rewrite ^/mail/$ /mail/index.php;
+	location /mail/ {
+		index index.php;
+		alias /usr/local/lib/roundcubemail/;
+	}
+	location ~ /mail/config/.* {
+		# A ~-style location is needed to give this precedence over the next block.
+		return 403;
+	}
+	location ~ /mail/.*\.php {
+		# note: ~ has precendence over a regular location block
+		include fastcgi_params;
+		fastcgi_split_path_info ^/mail(/.*)()$;
+		fastcgi_index index.php;
+		fastcgi_param SCRIPT_FILENAME /usr/local/lib/roundcubemail/$fastcgi_script_name;
+		fastcgi_pass php-default;
+
+		# Outgoing mail also goes through this endpoint, so increase the maximum
+		# file upload limit to match the corresponding Postfix limit.
+		client_max_body_size 128M;
 	}
 
 	# Nextcloud configuration.
@@ -20,14 +45,23 @@
 	rewrite ^/cloud/$ /cloud/index.php;
 	rewrite ^/cloud/(contacts|calendar|files)$ /cloud/index.php/apps/$1/ redirect;
 	rewrite ^(/cloud/core/doc/[^\/]+/)$ $1/index.html;
+	rewrite ^(/cloud/oc[sm]-provider)/$ $1/index.php redirect;
 	location /cloud/ {
 		alias /usr/local/lib/owncloud/;
-	 	location ~ ^/cloud/(build|tests|config|lib|3rdparty|templates|data|README)/ {
-	 		deny all;
-	 	}
-	 	location ~ ^/cloud/(?:\.|autotest|occ|issue|indie|db_|console) {
-	 		deny all;
-	 	}
+		location ~ ^/cloud/(build|tests|config|lib|3rdparty|templates|data|README)/ {
+			deny all;
+		}
+		location ~ ^/cloud/(?:\.|autotest|occ|issue|indie|db_|console) {
+			deny all;
+		}
+		# Enable paths for service and cloud federation discovery
+		# Resolves warning in Nextcloud Settings panel
+		location ~ ^/cloud/(oc[sm]-provider)?/([^/]+\.php)$ {
+			index index.php;
+			include fastcgi_params;
+			fastcgi_param SCRIPT_FILENAME /usr/local/lib/owncloud/$1/$2;
+			fastcgi_pass php-default;
+		}
 	}
 	location ~ ^(/cloud)((?:/ocs)?/[^/]+\.php)(/.*)?$ {
 		# note: ~ has precendence over a regular location block
@@ -43,7 +77,7 @@
 		fastcgi_param MOD_X_ACCEL_REDIRECT_ENABLED on;
 		fastcgi_param MOD_X_ACCEL_REDIRECT_PREFIX /owncloud-xaccel;
 		fastcgi_read_timeout 630;
-		fastcgi_pass php-fpm;
+		fastcgi_pass php-default;
 		client_max_body_size 1G;
 		fastcgi_buffers 64 4K;
 	}
@@ -64,5 +98,3 @@
 	rewrite ^/.well-known/host-meta.json /cloud/public.php?service=host-meta-json last;
 	rewrite ^/.well-known/carddav /cloud/remote.php/carddav/ redirect;
 	rewrite ^/.well-known/caldav /cloud/remote.php/caldav/ redirect;
-
-	# ADDITIONAL DIRECTIVES HERE

conf/nginx-ssl.conf

@@ -1,76 +1,20 @@
-# from: https://gist.github.com/konklone/6532544
-###################################################################################
+# We track the Mozilla "intermediate" compatibility TLS recommendations.
+# Note that these settings are repeated in the SMTP and IMAP configuration.
+# ssl_protocols has moved to nginx.conf in bionic, check there for enabled protocols.
+ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384;
+ssl_dhparam STORAGE_ROOT/ssl/dh2048.pem;
 
-# Basically the nginx configuration I use at konklone.com. 
-# I check it using https://www.ssllabs.com/ssltest/analyze.html?d=konklone.com
-#
-# To provide feedback, please tweet at @konklone or email eric@konklone.com.
-# Comments on gists don't notify the author. 
-# 
-# Thanks to WubTheCaptain (https://wubthecaptain.eu) for his help and ciphersuites.
-# Thanks to Ilya Grigorik (https://www.igvita.com) for constant inspiration.
-
-# Path to certificate and private key.
-# The .crt may omit the root CA cert, if it's a standard CA that ships with clients.
-#ssl_certificate /path/to/unified.crt;
-#ssl_certificate_key /path/to/my-private-decrypted.key;
-
-# Tell browsers to require SSL (warning: difficult to change your mind)
-# Handled by the management daemon because we can toggle this version or a
-# preload version.
-#add_header Strict-Transport-Security max-age=31536000;
-
-# Prefer certain ciphersuites, to enforce Forward Secrecy and avoid known vulnerabilities.
-# 
-# Forces forward secrecy in all browsers and clients that can use TLS,
-# but with a small exception (DES-CBC3-SHA) for IE8/XP users.
-# 
-# Reference client: https://www.ssllabs.com/ssltest/analyze.html
-ssl_prefer_server_ciphers on;
-ssl_ciphers 'kEECDH+ECDSA+AES128 kEECDH+ECDSA+AES256 kEECDH+AES128 kEECDH+AES256 kEDH+AES128 kEDH+AES256 DES-CBC3-SHA +SHA !aNULL !eNULL !LOW !MD5 !EXP !DSS !PSK !SRP !kECDH !CAMELLIA !RC4 !SEED';
-
-# Cut out (the old, broken) SSLv3 entirely. 
-# This **excludes IE6 users** and (apparently) Yandexbot.
-# Just comment out if you need to support IE6, bless your soul.
-ssl_protocols TLSv1.2 TLSv1.1 TLSv1;
-
-# Turn on session resumption, using a 10 min cache shared across nginx processes,
 # as recommended by http://nginx.org/en/docs/http/configuring_https_servers.html
-ssl_session_cache   shared:SSL:10m;
-ssl_session_timeout 10m;
-#keepalive_timeout   70; # in Ubuntu 14.04/nginx 1.4.6 the default is 65, so plenty good
+ssl_session_cache shared:SSL:50m;
+ssl_session_timeout 1d;
 
 # Buffer size of 1400 bytes fits in one MTU.
 # nginx 1.5.9+ ONLY
-#ssl_buffer_size 1400; 
+ssl_buffer_size 1400; 
 
-# SPDY header compression (0 for none, 9 for slow/heavy compression). Preferred is 6. 
-# 
-# BUT: header compression is flawed and vulnerable in SPDY versions 1 - 3.
-# Disable with 0, until using a version of nginx with SPDY 4.
-spdy_headers_comp 0;
-
-# Now let's really get fancy, and pre-generate a 2048 bit random parameter
-# for DH elliptic curves. If not created and specified, default is only 1024 bits. 
-#
-# Generated by OpenSSL with the following command:
-#   openssl dhparam -outform pem -out dhparam2048.pem 2048
-# 
-# Note: raising the bits to 2048 excludes Java 6 clients. Comment out if a problem.
-ssl_dhparam STORAGE_ROOT/ssl/dh2048.pem;
-
-
-# OCSP stapling - means nginx will poll the CA for signed OCSP responses, 
-# and send them to clients so clients don't make their own OCSP calls.
-# http://en.wikipedia.org/wiki/OCSP_stapling
-# 
-# while the ssl_certificate above may omit the root cert if the CA is trusted,
-# ssl_trusted_certificate below must point to a chain of **all** certs
-# in the trust path - (your cert, intermediary certs, root cert)
-#
-# 8.8.8.8 and 8.8.4.4 below are Google's public IPv4 DNS servers. 
-# nginx will use them to talk to the CA.
 ssl_stapling on;
 ssl_stapling_verify on;
 resolver 127.0.0.1 valid=86400;
 resolver_timeout 10;
+
+# h/t https://gist.github.com/konklone/6532544

conf/nginx-top.conf

@@ -6,7 +6,11 @@
 ##       If you modify any system configuration you are on
 ##       your own --- please do not ask for help from us.
 
-upstream php-fpm {
-	server unix:/var/run/php5-fpm.sock;
+# This socket is reserved for Mail-in-a-Box-specific services
+upstream php-default {
+	server unix:/var/run/php/php-default.sock;
 }
 
+upstream php-fpm {
+	server unix:/var/run/php/php{{phpver}}-fpm.sock;
+}

conf/nginx.conf

@@ -25,14 +25,14 @@ server {
 		# This path must be served over HTTP for ACME domain validation.
 		# We map this to a special path where our TLS cert provisioning
 		# tool knows to store challenge response files.
-		alias $STORAGE_ROOT/ssl/lets_encrypt/acme_challenges/;
+		alias $STORAGE_ROOT/ssl/lets_encrypt/webroot/.well-known/acme-challenge/;
 	}
 }
 
 # The secure HTTPS server.
 server {
-	listen 443 ssl;
-	listen [::]:443 ssl;
+	listen 443 ssl http2;
+	listen [::]:443 ssl http2;
 
 	server_name $HOSTNAME;
 

conf/www_default.html

@@ -1,9 +1,106 @@
 <html>
-	<head>
-		<title>this is a mail-in-a-box</title>
-	</head>
-	<body>
-		<h1>this is a mail-in-a-box</h1>
-		<p>take control of your email at <a href="https://mailinabox.email/">https://mailinabox.email/</a></p>
-	</body>
+
+<head>
+	<title>Power Mail-in-a-Box</title>
+	<meta charset="utf-8" name="robots" content="noindex">
+	<style>
+		body {
+			font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
+			position: relative;
+			min-height: 100%;
+		}
+
+		#content {
+			padding-bottom: 3.5rem;
+		}
+
+		p,
+		ul,
+		li {
+			font-size: 15pt
+		}
+
+		th,
+		td {
+			font-size: 20pt;
+			width: 30%;
+		}
+
+		#small td {
+			font-size: 12.5pt;
+		}
+
+		footer {
+			position: absolute;
+			bottom: 0;
+			width: 100%;
+			height: 3.5rem;
+			background-color: #ddd;
+		}
+
+		footer p {
+			font-size: 10pt;
+		}
+	</style>
+</head>
+
+<body>
+	<div id=content>
+		<h1 align=center>It's working! 🎉🎉🎉</h1>
+		<p align=center>It is running! Now you can begin your <b>very</b> awesome thing!
+		<p>
+
+		<h2 align=center>What is this Power Mail-in-a-Box able to do for you?</h2>
+		<ul>
+			<li>Send and receive mail (duh);</li>
+			<li>Be your <a href="https://wiki.gnupg.org/WKD">Web Key Directory</a> server, if you're into GnuPG and all
+				that jazz. No need to rely on public keyservers!</li>
+			<li>Also be your web server - if you want:</li>
+			<ul>
+				<li>Static sites? No problem!</li>
+				<li>Front-end + back-end? No problem!</li>
+				<li>PHP? <b>Did I stutter?</b> We got you!</li>
+				<li>How many sites can I host at the same time? How many you want (provided your server can handle all
+					of them, of course)</li>
+			</ul>
+		</ul>
+
+		<h2 align=center>Let's begin, then?</h2>
+		<p align=center>This Power Mail-in-a-Box was configured with the name <code>{{PRIMARY_HOSTNAME}}</code>.</p>
+		<table align=center>
+			<thead>
+				<th>To access the admin panel...</th>
+				<th>To access the webmail...</th>
+				<th>To access NextCloud...</th>
+			</thead>
+			<tbody>
+				<tr>
+					<td align=center><b><a href="https://{{PRIMARY_HOSTNAME}}/admin">Go here</a></b></td>
+					<td align=center><b><a href="https://{{PRIMARY_HOSTNAME}}/mail">Go here</a></b></td>
+					<td align=center><b><a href="https://{{PRIMARY_HOSTNAME}}/cloud">Go here</a></b></td>
+				</tr>
+				<tr id=small>
+					<td align=center><code>{{PRIMARY_HOSTNAME}}/admin</code></td>
+					<td align=center><code>{{PRIMARY_HOSTNAME}}/mail</code></td>
+					<td align=center><code>{{PRIMARY_HOSTNAME}}/cloud</code></td>
+				</tr>
+			</tbody>
+		</table>
+
+		<br><br>
+
+		<h2 align=center>Oh and by the way: thank you for sticking by!</h2>
+		<p align=center>This project is maintained <a href="https://power-mailinabox.net">on GitHub</a>.
+			Feel free to take a peek and maybe leave a star. It is very much appreciated! ❤</p>
+		<p align=center>Also feel free report any issues you may find, or leave your ideas.</p>
+	</div>
+	<footer>
+		<p align=center>
+			Unless you moved the folder elsewhere, or you manually added this file, it is located at
+			<code>{{STORAGE_ROOT}}/www/default/index.html</code> on the server - feel free to remove it whenever you
+			want.
+		</p>
+	</footer>
+</body>
+
 </html>

conf/zpush/backend_imap.php

@@ -49,7 +49,7 @@ define('IMAP_FROM_LDAP_FULLNAME', '#givenname #sn');
 define('IMAP_SMTP_METHOD', 'sendmail');
 
 global $imap_smtp_params;
-$imap_smtp_params = array('host' => 'ssl://127.0.0.1', 'port' => 587, 'auth' => true, 'username' => 'imap_username', 'password' => 'imap_password');
+$imap_smtp_params = array('host' => 'ssl://127.0.0.1', 'port' => 465, 'auth' => true, 'username' => 'imap_username', 'password' => 'imap_password');
 
 define('MAIL_MIMEPART_CRLF', "\r\n");
 define('IMAP_MEETING_USE_CALDAV', true);

management/auth.py

@@ -1,138 +1,180 @@
-import base64, os, os.path, hmac
+import base64
+import os
+import os.path
+import hmac
+import json
+import secrets
+from datetime import timedelta
 
-from flask import make_response
+from expiringdict import ExpiringDict
 
 import utils
 from mailconfig import get_mail_password, get_mail_user_privileges
+from mfa import get_hash_mfa_state, validate_auth_mfa
 
-DEFAULT_KEY_PATH   = '/var/lib/mailinabox/api.key'
+DEFAULT_KEY_PATH = '/var/lib/mailinabox/api.key'
 DEFAULT_AUTH_REALM = 'Mail-in-a-Box Management Server'
 
-class KeyAuthService:
-	"""Generate an API key for authenticating clients
 
-	Clients must read the key from the key file and send the key with all HTTP
-	requests. The key is passed as the username field in the standard HTTP
-	Basic Auth header.
-	"""
+class AuthService:
+
 	def __init__(self):
 		self.auth_realm = DEFAULT_AUTH_REALM
-		self.key = self._generate_key()
 		self.key_path = DEFAULT_KEY_PATH
+		self.max_session_duration = timedelta(days=2)
 
-	def write_key(self):
-		"""Write key to file so authorized clients can get the key
+		self.init_system_api_key()
+		self.sessions = ExpiringDict(
+			max_len=64,
+			max_age_seconds=self.max_session_duration.total_seconds())
 
-		The key file is created with mode 0640 so that additional users can be
-		authorized to access the API by granting group/ACL read permissions on
-		the key file.
-		"""
-		def create_file_with_mode(path, mode):
-			# Based on answer by A-B-B: http://stackoverflow.com/a/15015748
-			old_umask = os.umask(0)
-			try:
-				return os.fdopen(os.open(path, os.O_WRONLY | os.O_CREAT, mode), 'w')
-			finally:
-				os.umask(old_umask)
+	def init_system_api_key(self):
+		"""Write an API key to a local file so local processes can use the API"""
 
-		os.makedirs(os.path.dirname(self.key_path), exist_ok=True)
+		with open(self.key_path, 'r') as file:
+			self.key = file.read()
 
-		with create_file_with_mode(self.key_path, 0o640) as key_file:
-			key_file.write(self.key + '\n')
-
-	def authenticate(self, request, env):
-		"""Test if the client key passed in HTTP Authorization header matches the service key
-		or if the or username/password passed in the header matches an administrator user.
+	def authenticate(self, request, env, login_only=False, logout=False):
+		"""Test if the HTTP Authorization header's username matches the system key, a session key,
+		or if the username/password passed in the header matches a local user.
 		Returns a tuple of the user's email address and list of user privileges (e.g.
 		('my@email', []) or ('my@email', ['admin']); raises a ValueError on login failure.
-		If the user used an API key, the user's email is returned as None."""
+		If the user used the system API key, the user's email is returned as None since
+		this key is not associated with a user."""
 
-		def decode(s):
-			return base64.b64decode(s.encode('ascii')).decode('ascii')
+		def parse_http_authorization_basic(header):
+
+			def decode(s):
+				return base64.b64decode(s.encode('ascii')).decode('ascii')
 
-		def parse_basic_auth(header):
 			if " " not in header:
 				return None, None
 			scheme, credentials = header.split(maxsplit=1)
 			if scheme != 'Basic':
 				return None, None
-
 			credentials = decode(credentials)
 			if ":" not in credentials:
 				return None, None
 			username, password = credentials.split(':', maxsplit=1)
 			return username, password
 
-		header = request.headers.get('Authorization')
-		if not header:
-			raise ValueError("No authorization header provided.")
-
-		username, password = parse_basic_auth(header)
-
+		username, password = parse_http_authorization_basic(
+			request.headers.get('Authorization', ''))
 		if username in (None, ""):
 			raise ValueError("Authorization header invalid.")
-		elif username == self.key:
-			# The user passed the API key which grants administrative privs.
+
+		if username.strip() == "" and password.strip() == "":
+			raise ValueError(
+				"No email address, password, session key, or API key provided."
+			)
+
+		# If user passed the system API key, grant administrative privs. This key
+		# is not associated with a user.
+		if username == self.key and not login_only:
 			return (None, ["admin"])
+
+		# If the password corresponds with a session token for the user, grant access for that user.
+		if self.get_session(username, password, "login",
+							env) and not login_only:
+			sessionid = password
+			session = self.sessions[sessionid]
+			if logout:
+				# Clear the session.
+				del self.sessions[sessionid]
+			else:
+				# Re-up the session so that it does not expire.
+				self.sessions[sessionid] = session
+
+		# If no password was given, but a username was given, we're missing some information.
+		elif password.strip() == "":
+			raise ValueError("Enter a password.")
+
 		else:
-			# The user is trying to log in with a username and user-specific
-			# API key or password. Raises or returns privs.
-			return (username, self.get_user_credentials(username, password, env))
-
-	def get_user_credentials(self, email, pw, env):
-		# Validate a user's credentials. On success returns a list of
-		# privileges (e.g. [] or ['admin']). On failure raises a ValueError
-		# with a login error message. 
-
-		# Sanity check.
-		if email == "" or pw == "":
-			raise ValueError("Enter an email address and password.")
-
-		# The password might be a user-specific API key. create_user_key raises
-		# a ValueError if the user does not exist.
-		if hmac.compare_digest(self.create_user_key(email, env), pw):
-			# OK.
-			pass
-		else:
-			# Get the hashed password of the user. Raise a ValueError if the
-			# email address does not correspond to a user.
-			pw_hash = get_mail_password(email, env)
-
-			# Authenticate.
-			try:
-				# Use 'doveadm pw' to check credentials. doveadm will return
-				# a non-zero exit status if the credentials are no good,
-				# and check_call will raise an exception in that case.
-				utils.shell('check_call', [
-					"/usr/bin/doveadm", "pw",
-					"-p", pw,
-					"-t", pw_hash,
-					])
-			except:
-				# Login failed.
-				raise ValueError("Invalid password.")
+			# The user is trying to log in with a username and a password
+			# (and possibly a MFA token). On failure, an exception is raised.
+			self.check_user_auth(username, password, request, env)
 
 		# Get privileges for authorization. This call should never fail because by this
-		# point we know the email address is a valid user. But on error the call will
-		# return a tuple of an error message and an HTTP status code.
-		privs = get_mail_user_privileges(email, env)
-		if isinstance(privs, tuple): raise ValueError(privs[0])
+		# point we know the email address is a valid user --- unless the user has been
+		# deleted after the session was granted. On error the call will return a tuple
+		# of an error message and an HTTP status code.
+		privs = get_mail_user_privileges(username, env)
+		if isinstance(privs, tuple):
+			raise ValueError(privs[0])
 
-		# Return a list of privileges.
-		return privs
+		# Return the authorization information.
+		return (username, privs)
 
-	def create_user_key(self, email, env):
-		# Store an HMAC with the client. The hashed message of the HMAC will be the user's
-		# email address & hashed password and the key will be the master API key. The user of
-		# course has their own email address and password. We assume they do not have the master
-		# API key (unless they are trusted anyway). The HMAC proves that they authenticated
-		# with us in some other way to get the HMAC. Including the password means that when
-		# a user's password is reset, the HMAC changes and they will correctly need to log
-		# in to the control panel again. This method raises a ValueError if the user does
-		# not exist, due to get_mail_password.
-		msg = b"AUTH:" + email.encode("utf8") + b" " + get_mail_password(email, env).encode("utf8")
-		return hmac.new(self.key.encode('ascii'), msg, digestmod="sha256").hexdigest()
+	def check_user_auth(self, email, pw, request, env):
+		# Validate a user's login email address and password. If MFA is enabled,
+		# check the MFA token in the X-Auth-Token header.
+		#
+		# On login failure, raises a ValueError with a login error message. On
+		# success, nothing is returned.
 
-	def _generate_key(self):
-		raw_key = os.urandom(32)
-		return base64.b64encode(raw_key).decode('ascii')
+		# Authenticate.
+		try:
+			# Get the hashed password of the user. Raise a ValueError if the
+			# email address does not correspond to a user. But wrap it in the
+			# same exception as if a password fails so we don't easily reveal
+			# if an email address is valid.
+			pw_hash = get_mail_password(email, env)
+
+			# Use 'doveadm pw' to check credentials. doveadm will return
+			# a non-zero exit status if the credentials are no good,
+			# and check_call will raise an exception in that case.
+			utils.shell('check_call', [
+				"/usr/bin/doveadm",
+				"pw",
+				"-p",
+				pw,
+				"-t",
+				pw_hash,
+			])
+		except:
+			# Login failed.
+			raise ValueError("Incorrect email address or password.")
+
+		# If MFA is enabled, check that MFA passes.
+		status, hints = validate_auth_mfa(email, request, env)
+		if not status:
+			# Login valid. Hints may have more info.
+			raise ValueError(",".join(hints))
+
+	def create_user_password_state_token(self, email, env):
+		# Create a token that changes if the user's password or MFA options change
+		# so that sessions become invalid if any of that information changes.
+		msg = get_mail_password(email, env).encode("utf8")
+
+		# Add to the message the current MFA state, which is a list of MFA information.
+		# Turn it into a string stably.
+		msg += b" " + json.dumps(get_hash_mfa_state(email, env),
+								sort_keys=True).encode("utf8")
+
+		# Make a HMAC using the system API key as a hash key.
+		hash_key = self.key.encode('ascii')
+		return hmac.new(hash_key, msg, digestmod="sha256").hexdigest()
+
+	def create_session_key(self, username, env, type=None):
+		# Create a new session.
+		token = secrets.token_hex(32)
+		self.sessions[token] = {
+			"email": username,
+			"password_token":
+			self.create_user_password_state_token(username, env),
+			"type": type,
+		}
+		return token
+
+	def get_session(self, user_email, session_key, session_type, env):
+		if session_key not in self.sessions:
+			return None
+		session = self.sessions[session_key]
+		if session_type == "login" and session["email"] != user_email:
+			return None
+		if session["type"] != session_type:
+			return None
+		if session["password_token"] != self.create_user_password_state_token(
+			session["email"], env):
+			return None
+		return session

management/backup.py

@@ -1,4 +1,4 @@
-#!/usr/bin/python3
+#!/usr/local/lib/mailinabox/env/bin/python
 
 # This script performs a backup of all user data:
 # 1) System services are stopped.
@@ -7,45 +7,53 @@
 # 4) The stopped services are restarted.
 # 5) STORAGE_ROOT/backup/after-backup is executed if it exists.
 
-import os, os.path, shutil, glob, re, datetime, sys
-import dateutil.parser, dateutil.relativedelta, dateutil.tz
+import os
+import os.path
+import shutil
+import glob
+import re
+import datetime
+import sys
+import dateutil.parser
+import dateutil.relativedelta
+import dateutil.tz
 import rtyaml
-from exclusiveprocess import Lock
+from exclusiveprocess import Lock, CannotAcquireLock
 
-from utils import load_environment, shell, wait_for_service, fix_boto
-
-rsync_ssh_options = [
-	"--ssh-options='-i /root/.ssh/id_rsa_miab'",
-	"--rsync-options=-e \"/usr/bin/ssh -oStrictHostKeyChecking=no -oBatchMode=yes -p 22 -i /root/.ssh/id_rsa_miab\"",
-]
+from utils import load_environment, shell, wait_for_service, get_php_version
 
 def backup_status(env):
-	# Root folder
-	backup_root = os.path.join(env["STORAGE_ROOT"], 'backup')
-
-	# What is the current status of backups?
-	# Query duplicity to get a list of all backups.
-	# Use the number of volumes to estimate the size.
+	# If backups are disabled, return no status.
 	config = get_backup_config(env)
-	now = datetime.datetime.now(dateutil.tz.tzlocal())
-
-	# Are backups dissbled?
 	if config["target"] == "off":
-		return { }
+		return {}
 
-	backups = { }
+	# Query duplicity to get a list of all full and incremental
+	# backups available.
+
+	backups = {}
+	now = datetime.datetime.now(dateutil.tz.tzlocal())
+	backup_root = os.path.join(env["STORAGE_ROOT"], 'backup')
 	backup_cache_dir = os.path.join(backup_root, 'cache')
 
 	def reldate(date, ref, clip):
-		if ref < date: return clip
+		if ref < date:
+			return clip
 		rd = dateutil.relativedelta.relativedelta(ref, date)
-		if rd.years > 1: return "%d years, %d months" % (rd.years, rd.months)
-		if rd.years == 1: return "%d year, %d months" % (rd.years, rd.months)
-		if rd.months > 1: return "%d months, %d days" % (rd.months, rd.days)
-		if rd.months == 1: return "%d month, %d days" % (rd.months, rd.days)
-		if rd.days >= 7: return "%d days" % rd.days
-		if rd.days > 1: return "%d days, %d hours" % (rd.days, rd.hours)
-		if rd.days == 1: return "%d day, %d hours" % (rd.days, rd.hours)
+		if rd.years > 1:
+			return "%d years, %d months" % (rd.years, rd.months)
+		if rd.years == 1:
+			return "%d year, %d months" % (rd.years, rd.months)
+		if rd.months > 1:
+			return "%d months, %d days" % (rd.months, rd.days)
+		if rd.months == 1:
+			return "%d month, %d days" % (rd.months, rd.days)
+		if rd.days >= 7:
+			return "%d days" % rd.days
+		if rd.days > 1:
+			return "%d days, %d hours" % (rd.days, rd.hours)
+		if rd.days == 1:
+			return "%d day, %d hours" % (rd.days, rd.hours)
 		return "%d hours, %d minutes" % (rd.hours, rd.minutes)
 
 	# Get duplicity collection status and parse for a list of backups.
@@ -54,42 +62,55 @@ def backup_status(env):
 		date = dateutil.parser.parse(keys[1]).astimezone(dateutil.tz.tzlocal())
 		return {
 			"date": keys[1],
-			"date_str": date.strftime("%x %X") + " " + now.tzname(),
+			"date_str": date.strftime("%Y-%m-%d %X") + " " + now.tzname(),
 			"date_delta": reldate(date, now, "the future?"),
 			"full": keys[0] == "full",
-			"size": 0, # collection-status doesn't give us the size
-			"volumes": keys[2], # number of archive volumes for this backup (not really helpful)
+			"size": 0,  # collection-status doesn't give us the size
+			# number of archive volumes for this backup (not really helpful)
+			"volumes": int(keys[2]),
 		}
 
 	code, collection_status = shell('check_output', [
-		"/usr/bin/duplicity",
+		"/usr/local/bin/duplicity",
 		"collection-status",
 		"--archive-dir", backup_cache_dir,
 		"--gpg-options", "--cipher-algo=AES256",
 		"--log-fd", "1",
-		config["target"],
-		] + rsync_ssh_options,
-		get_env(env),
+		get_duplicity_target_url(config),
+		] + get_duplicity_additional_args(env),
+		get_duplicity_env_vars(env),
 		trap=True)
 	if code != 0:
 		# Command failed. This is likely due to an improperly configured remote
 		# destination for the backups or the last backup job terminated unexpectedly.
-		raise Exception("Something is wrong with the backup: " + collection_status)
+		raise Exception("Something is wrong with the backup: " +
+						collection_status)
 	for line in collection_status.split('\n'):
 		if line.startswith(" full") or line.startswith(" inc"):
 			backup = parse_line(line)
 			backups[backup["date"]] = backup
 
-	# Look at the target to get the sizes of each of the backups. There is more than one file per backup.
+	# Look at the target directly to get the sizes of each of the backups. There is more than one file per backup.
+	# Starting with duplicity in Ubuntu 18.04, "signatures" files have dates in their
+	# filenames that are a few seconds off the backup date and so don't line up
+	# with the list of backups we have. Track unmatched files so we know how much other
+	# space is used for those.
+	unmatched_file_size = 0
 	for fn, size in list_target_files(config):
-		m = re.match(r"duplicity-(full|full-signatures|(inc|new-signatures)\.(?P<incbase>\d+T\d+Z)\.to)\.(?P<date>\d+T\d+Z)\.", fn)
-		if not m: continue # not a part of a current backup chain
+		m = re.match(
+			r"duplicity-(full|full-signatures|(inc|new-signatures)\.(?P<incbase>\d+T\d+Z)\.to)\.(?P<date>\d+T\d+Z)\.",
+			fn)
+		if not m:
+			continue  # not a part of a current backup chain
 		key = m.group("date")
-		backups[key]["size"] += size
+		if key in backups:
+			backups[key]["size"] += size
+		else:
+			unmatched_file_size += size
 
 	# Ensure the rows are sorted reverse chronologically.
 	# This is relied on by should_force_full() and the next step.
-	backups = sorted(backups.values(), key = lambda b : b["date"], reverse=True)
+	backups = sorted(backups.values(), key=lambda b: b["date"], reverse=True)
 
 	# Get the average size of incremental backups, the size of the
 	# most recent full backup, and the date of the most recent
@@ -118,16 +139,23 @@ def backup_status(env):
 	if incremental_count > 0 and incremental_size > 0 and first_full_size is not None:
 		# How many days until the next incremental backup? First, the part of
 		# the algorithm based on increment sizes:
-		est_days_to_next_full = (.5 * first_full_size - incremental_size) / (incremental_size/incremental_count)
-		est_time_of_next_full = first_date + datetime.timedelta(days=est_days_to_next_full)
+		est_days_to_next_full = (.5 * first_full_size - incremental_size) / (
+			incremental_size / incremental_count)
+		est_time_of_next_full = first_date + \
+						datetime.timedelta(days=est_days_to_next_full)
 
 		# ...And then the part of the algorithm based on full backup age:
-		est_time_of_next_full = min(est_time_of_next_full, first_full_date + datetime.timedelta(days=config["min_age_in_days"]*10+1))
+		est_time_of_next_full = min(
+			est_time_of_next_full, first_full_date +
+			datetime.timedelta(days=config["min_age_in_days"] * 10 + 1))
 
 		# It still can't be deleted until it's old enough.
-		est_deleted_on = max(est_time_of_next_full, first_date + datetime.timedelta(days=config["min_age_in_days"]))
+		est_deleted_on = max(
+			est_time_of_next_full,
+			first_date + datetime.timedelta(days=config["min_age_in_days"]))
 
-		deleted_in = "approx. %d days" % round((est_deleted_on-now).total_seconds()/60/60/24 + .5)
+		deleted_in = "approx. %d days" % round(
+			(est_deleted_on - now).total_seconds() / 60 / 60 / 24 + .5)
 
 	# When will a backup be deleted? Set the deleted_in field of each backup.
 	saw_full = False
@@ -143,13 +171,19 @@ def backup_status(env):
 		elif saw_full and not deleted_in:
 			# We're now on backups prior to the most recent full backup. These are
 			# free to be deleted as soon as they are min_age_in_days old.
-			deleted_in = reldate(now, dateutil.parser.parse(bak["date"]) + datetime.timedelta(days=config["min_age_in_days"]), "on next daily backup")
+			deleted_in = reldate(
+				now,
+				dateutil.parser.parse(bak["date"]) +
+				datetime.timedelta(days=config["min_age_in_days"]),
+				"on next daily backup")
 			bak["deleted_in"] = deleted_in
 
 	return {
 		"backups": backups,
+		"unmatched_file_size": unmatched_file_size,
 	}
 
+
 def should_force_full(config, env):
 	# Force a full backup when the total size of the increments
 	# since the last full backup is greater than half the size
@@ -165,9 +199,11 @@ def should_force_full(config, env):
 			# Return if we should to a full backup, which is based
 			# on the size of the increments relative to the full
 			# backup, as well as the age of the full backup.
-			if inc_size > .5*bak["size"]:
+			if inc_size > .5 * bak["size"]:
 				return True
-			if dateutil.parser.parse(bak["date"]) + datetime.timedelta(days=config["min_age_in_days"]*10+1) < datetime.datetime.now(dateutil.tz.tzlocal()):
+			if dateutil.parser.parse(bak["date"]) + datetime.timedelta(
+				days=config["min_age_in_days"] * 10 +
+				1) < datetime.datetime.now(dateutil.tz.tzlocal()):
 				return True
 			return False
 	else:
@@ -175,6 +211,7 @@ def should_force_full(config, env):
 		# (I love for/else blocks. Here it's just to show off.)
 		return True
 
+
 def get_passphrase(env):
 	# Get the encryption passphrase. secret_key.txt is 2048 random
 	# bits base64-encoded and with line breaks every 65 characters.
@@ -185,14 +222,59 @@ def get_passphrase(env):
 	backup_root = os.path.join(env["STORAGE_ROOT"], 'backup')
 	with open(os.path.join(backup_root, 'secret_key.txt')) as f:
 		passphrase = f.readline().strip()
-	if len(passphrase) < 43: raise Exception("secret_key.txt's first line is too short!")
+	if len(passphrase) < 43:
+		raise Exception("secret_key.txt's first line is too short!")
 
 	return passphrase
 
-def get_env(env):
+def get_duplicity_target_url(config):
+	target = config["target"]
+
+	if get_target_type(config) == "s3":
+		from urllib.parse import urlsplit, urlunsplit
+		target = list(urlsplit(target))
+
+		# Although we store the S3 hostname in the target URL,
+		# duplicity no longer accepts it in the target URL. The hostname in
+		# the target URL must be the bucket name. The hostname is passed
+		# via get_duplicity_additional_args. Move the first part of the
+		# path (the bucket name) into the hostname URL component, and leave
+		# the rest for the path.
+		target_bucket = target[2].lstrip('/').split('/', 1)
+		target[1] = target_bucket[0]
+		target[2] = target_bucket[1] if len(target_bucket) > 1 else ''
+
+		target = urlunsplit(target)
+
+	return target
+
+def get_duplicity_additional_args(env):
+	config = get_backup_config(env)
+	port = 0
+
+	try:
+		port = int(config["target_rsync_port"])
+	except Exception:
+		port = 22
+
+	if get_target_type(config) == 'rsync':
+		return [
+			f"--ssh-options= -i /root/.ssh/id_rsa_miab -p {port}",
+			f"--rsync-options= -e \"/usr/bin/ssh -oStrictHostKeyChecking=no -oBatchMode=yes -p {port} -i /root/.ssh/id_rsa_miab\"",
+		]
+	elif get_target_type(config) == 's3':
+		# See note about hostname in get_duplicity_target_url.
+		from urllib.parse import urlsplit, urlunsplit
+		target = urlsplit(config["target"])
+		endpoint_url = urlunsplit(("https", target.netloc, '', '', ''))
+		return ["--s3-endpoint-url",  endpoint_url]
+
+	return []
+
+def get_duplicity_env_vars(env):
 	config = get_backup_config(env)
 
-	env = { "PASSPHRASE" : get_passphrase(env) }
+	env = {"PASSPHRASE": get_passphrase(env)}
 
 	if get_target_type(config) == 's3':
 		env["AWS_ACCESS_KEY_ID"] = config["target_user"]
@@ -200,16 +282,27 @@ def get_env(env):
 
 	return env
 
+
 def get_target_type(config):
 	protocol = config["target"].split(":")[0]
 	return protocol
 
-def perform_backup(full_backup):
+
+def perform_backup(full_backup, user_initiated=False):
 	env = load_environment()
+	php_fpm = f"php{get_php_version()}-fpm"
 
 	# Create an global exclusive lock so that the backup script
 	# cannot be run more than one.
-	Lock(die=True).forever()
+	lock = Lock(name="mailinabox_backup_daemon", die=(not user_initiated))
+	if user_initiated:
+		# God forgive me for what I'm about to do
+		try:
+			lock._acquire()
+		except CannotAcquireLock:
+			return "Another backup is already being done!"
+	else:
+		lock.forever()
 
 	config = get_backup_config(env)
 	backup_root = os.path.join(env["STORAGE_ROOT"], 'backup')
@@ -220,32 +313,6 @@ def perform_backup(full_backup):
 	if config["target"] == "off":
 		return
 
-	# In an older version of this script, duplicity was called
-	# such that it did not encrypt the backups it created (in
-	# backup/duplicity), and instead openssl was called separately
-	# after each backup run, creating AES256 encrypted copies of
-	# each file created by duplicity in backup/encrypted.
-	#
-	# We detect the transition by the presence of backup/duplicity
-	# and handle it by 'dupliception': we move all the old *un*encrypted
-	# duplicity files up out of the backup/duplicity directory (as
-	# backup/ is excluded from duplicity runs) in order that it is
-	# included in the next run, and we delete backup/encrypted (which
-	# duplicity will output files directly to, post-transition).
-	old_backup_dir = os.path.join(backup_root, 'duplicity')
-	migrated_unencrypted_backup_dir = os.path.join(env["STORAGE_ROOT"], "migrated_unencrypted_backup")
-	if os.path.isdir(old_backup_dir):
-		# Move the old unencrypted files to a new location outside of
-		# the backup root so they get included in the next (new) backup.
-		# Then we'll delete them. Also so that they do not get in the
-		# way of duplicity doing a full backup on the first run after
-		# we take care of this.
-		shutil.move(old_backup_dir, migrated_unencrypted_backup_dir)
-
-		# The backup_dir (backup/encrypted) now has a new purpose.
-		# Clear it out.
-		shutil.rmtree(backup_dir)
-
 	# On the first run, always do a full backup. Incremental
 	# will fail. Otherwise do a full backup when the size of
 	# the increments since the most recent full backup are
@@ -261,15 +328,19 @@ def perform_backup(full_backup):
 	# Stop services.
 	def service_command(service, command, quit=None):
 		# Execute silently, but if there is an error then display the output & exit.
-		code, ret = shell('check_output', ["/usr/sbin/service", service, command], capture_stderr=True, trap=True)
+		code, ret = shell('check_output',
+						["/usr/sbin/service", service, command],
+						capture_stderr=True,
+						trap=True)
 		if code != 0:
 			print(ret)
 			if quit:
 				sys.exit(code)
 
-	service_command("php5-fpm", "stop", quit=True)
+	service_command(php_fpm, "stop", quit=True)
 	service_command("postfix", "stop", quit=True)
 	service_command("dovecot", "stop", quit=True)
+	service_command("postgrey", "stop", quit=True)
 
 	# Execute a pre-backup script that copies files outside the homedir.
 	# Run as the STORAGE_USER user, not as root. Pass our settings in
@@ -285,7 +356,7 @@ def perform_backup(full_backup):
 	# after the first backup. See #396.
 	try:
 		shell('check_call', [
-			"/usr/bin/duplicity",
+			"/usr/local/bin/duplicity",
 			"full" if full_backup else "incr",
 			"--verbosity", "warning", "--no-print-statistics",
 			"--archive-dir", backup_cache_dir,
@@ -293,32 +364,29 @@ def perform_backup(full_backup):
 			"--volsize", "250",
 			"--gpg-options", "--cipher-algo=AES256",
 			env["STORAGE_ROOT"],
-			config["target"],
+			get_duplicity_target_url(config),
 			"--allow-source-mismatch"
-			] + rsync_ssh_options,
-			get_env(env))
+			] + get_duplicity_additional_args(env),
+			get_duplicity_env_vars(env))
 	finally:
 		# Start services again.
+		service_command("postgrey", "start", quit=False)
 		service_command("dovecot", "start", quit=False)
 		service_command("postfix", "start", quit=False)
-		service_command("php5-fpm", "start", quit=False)
-
-	# Once the migrated backup is included in a new backup, it can be deleted.
-	if os.path.isdir(migrated_unencrypted_backup_dir):
-		shutil.rmtree(migrated_unencrypted_backup_dir)
+		service_command(php_fpm, "start", quit=False)
 
 	# Remove old backups. This deletes all backup data no longer needed
 	# from more than 3 days ago.
 	shell('check_call', [
-		"/usr/bin/duplicity",
+		"/usr/local/bin/duplicity",
 		"remove-older-than",
 		"%dD" % config["min_age_in_days"],
 		"--verbosity", "error",
 		"--archive-dir", backup_cache_dir,
 		"--force",
-		config["target"]
-		] + rsync_ssh_options,
-		get_env(env))
+		get_duplicity_target_url(config)
+		] + get_duplicity_additional_args(env),
+		get_duplicity_env_vars(env))
 
 	# From duplicity's manual:
 	# "This should only be necessary after a duplicity session fails or is
@@ -326,19 +394,20 @@ def perform_backup(full_backup):
 	# That may be unlikely here but we may as well ensure we tidy up if
 	# that does happen - it might just have been a poorly timed reboot.
 	shell('check_call', [
-		"/usr/bin/duplicity",
+		"/usr/local/bin/duplicity",
 		"cleanup",
 		"--verbosity", "error",
 		"--archive-dir", backup_cache_dir,
 		"--force",
-		config["target"]
-		] + rsync_ssh_options,
-		get_env(env))
+		get_duplicity_target_url(config)
+		] + get_duplicity_additional_args(env),
+		get_duplicity_env_vars(env))
 
 	# Change ownership of backups to the user-data user, so that the after-bcakup
 	# script can access them.
 	if get_target_type(config) == 'file':
-		shell('check_call', ["/bin/chown", "-R", env["STORAGE_USER"], backup_dir])
+		shell('check_call',
+			["/bin/chown", "-R", env["STORAGE_USER"], backup_dir])
 
 	# Execute a post-backup script that does the copying to a remote server.
 	# Run as the STORAGE_USER user, not as root. Pass our settings in
@@ -353,8 +422,14 @@ def perform_backup(full_backup):
 	# backup. Since it checks that dovecot and postfix are running, block for a
 	# bit (maximum of 10 seconds each) to give each a chance to finish restarting
 	# before the status checks might catch them down. See #381.
-	wait_for_service(25, True, env, 10)
-	wait_for_service(993, True, env, 10)
+	if user_initiated:
+		# God forgive me for what I'm about to do
+		lock._release()
+		# We don't need to wait for the services to be up in this case
+	else:
+		wait_for_service(25, True, env, 10)
+		wait_for_service(993, True, env, 10)
+
 
 def run_duplicity_verification():
 	env = load_environment()
@@ -363,27 +438,28 @@ def run_duplicity_verification():
 	backup_cache_dir = os.path.join(backup_root, 'cache')
 
 	shell('check_call', [
-		"/usr/bin/duplicity",
-		"--verbosity", "info",
+		"/usr/local/bin/duplicity",
+		"--verbosity",
+		"info",
 		"verify",
 		"--compare-data",
 		"--archive-dir", backup_cache_dir,
 		"--exclude", backup_root,
-		config["target"],
+		get_duplicity_target_url(config),
 		env["STORAGE_ROOT"],
-	] + rsync_ssh_options, get_env(env))
+	] + get_duplicity_additional_args(env), get_duplicity_env_vars(env))
 
 def run_duplicity_restore(args):
 	env = load_environment()
 	config = get_backup_config(env)
 	backup_cache_dir = os.path.join(env["STORAGE_ROOT"], 'backup', 'cache')
 	shell('check_call', [
-		"/usr/bin/duplicity",
+		"/usr/local/bin/duplicity",
 		"restore",
 		"--archive-dir", backup_cache_dir,
-		config["target"],
-		] + rsync_ssh_options + args,
-	get_env(env))
+		get_duplicity_target_url(config),
+		] + get_duplicity_additional_args(env) + args,
+	get_duplicity_env_vars(env))
 
 def list_target_files(config):
 	import urllib.parse
@@ -393,7 +469,8 @@ def list_target_files(config):
 		return "invalid target"
 
 	if target.scheme == "file":
-		return [(fn, os.path.getsize(os.path.join(target.path, fn))) for fn in os.listdir(target.path)]
+		return [(fn, os.path.getsize(os.path.join(target.path, fn)))
+				for fn in os.listdir(target.path)]
 
 	elif target.scheme == "rsync":
 		rsync_fn_size_re = re.compile(r'.*    ([^ ]*) [^ ]* [^ ]* (.*)')
@@ -405,23 +482,24 @@ def list_target_files(config):
 		if target_path.startswith('/'):
 			target_path = target_path[1:]
 
-		rsync_command = [ 'rsync',
-					'-e',
-					'/usr/bin/ssh -i /root/.ssh/id_rsa_miab -oStrictHostKeyChecking=no -oBatchMode=yes',
-					'--list-only',
-					'-r',
-					rsync_target.format(
-						host=target.netloc,
-						path=target_path)
-				]
+		rsync_command = [
+			'rsync', '-e',
+			f"/usr/bin/ssh -oStrictHostKeyChecking=no -oBatchMode=yes -p {int(config.get('target_rsync_port', 22))} -i /root/.ssh/id_rsa_miab",
+			'--list-only', '-r',
+			rsync_target.format(host=target.netloc, path=target_path)
+		]
 
-		code, listing = shell('check_output', rsync_command, trap=True, capture_stderr=True)
+		code, listing = shell('check_output',
+							rsync_command,
+							trap=True,
+							capture_stderr=True)
 		if code == 0:
 			ret = []
 			for l in listing.split('\n'):
 				match = rsync_fn_size_re.match(l)
 				if match:
-					ret.append( (match.groups()[1], int(match.groups()[0].replace(',',''))) )
+					ret.append((match.groups()[1],
+								int(match.groups()[0].replace(',', ''))))
 			return ret
 		else:
 			if 'Permission denied (publickey).' in listing:
@@ -429,26 +507,23 @@ def list_target_files(config):
 			elif 'No such file or directory' in listing:
 				reason = "Provided path {} is invalid.".format(target_path)
 			elif 'Network is unreachable' in listing:
-				reason = "The IP address {} is unreachable.".format(target.hostname)
-			elif 'Could not resolve hostname':
-				reason = "The hostname {} cannot be resolved.".format(target.hostname)
+				reason = "The IP address {} is unreachable.".format(
+					target.hostname)
+			elif 'Could not resolve hostname' in listing:
+				reason = "The hostname {} cannot be resolved.".format(
+					target.hostname)
 			else:
-				reason = "Unknown error." \
-						"Please check running 'python management/backup.py --verify'" \
-						"from mailinabox sources to debug the issue."
-			raise ValueError("Connection to rsync host failed: {}".format(reason))
+				reason = "Unknown error. " \
+											"Please check running 'management/backup.py --verify' " \
+											"from mailinabox sources to debug the issue."
+			raise ValueError(
+				"Connection to rsync host failed: {}".format(reason))
 
 	elif target.scheme == "s3":
-		# match to a Region
-		fix_boto() # must call prior to importing boto
-		import boto.s3
-		from boto.exception import BotoServerError
-		for region in boto.s3.regions():
-			if region.endpoint == target.hostname:
-				break
-		else:
-			raise ValueError("Invalid S3 region/host.")
+		import boto3.s3
+		from botocore.exceptions import ClientError
 
+		# separate bucket from path in target
 		bucket = target.path[1:].split('/')[0]
 		path = '/'.join(target.path[1:].split('/')[1:]) + '/'
 
@@ -461,33 +536,63 @@ def list_target_files(config):
 
 		# connect to the region & bucket
 		try:
-			conn = region.connect(aws_access_key_id=config["target_user"], aws_secret_access_key=config["target_pass"])
-			bucket = conn.get_bucket(bucket)
-		except BotoServerError as e:
-			if e.status == 403:
-				raise ValueError("Invalid S3 access key or secret access key.")
-			elif e.status == 404:
-				raise ValueError("Invalid S3 bucket name.")
-			elif e.status == 301:
-				raise ValueError("Incorrect region for this bucket.")
-			raise ValueError(e.reason)
+			s3 = boto3.client('s3', \
+				endpoint_url=f'https://{target.hostname}', \
+				aws_access_key_id=config['target_user'], \
+				aws_secret_access_key=config['target_pass'])
+			bucket_objects = s3.list_objects_v2(Bucket=bucket, Prefix=path).get("Contents", [])
+			backup_list = [(key['Key'][len(path):], key['Size']) for key in bucket_objects]
+		except ClientError as e:
+			raise ValueError(e)
+		return backup_list
+	elif target.scheme == 'b2':
+		InMemoryAccountInfo = None
+		B2Api = None
+		NonExistentBucket = None
 
-		return [(key.name[len(path):], key.size) for key in bucket.list(prefix=path)]
+		from b2sdk.v1 import InMemoryAccountInfo, B2Api
+		from b2sdk.v1.exception import NonExistentBucket
+
+		info = InMemoryAccountInfo()
+		b2_api = B2Api(info)
+
+		# Extract information from target
+		b2_application_keyid = target.netloc[:target.netloc.index(':')]
+		b2_application_key = target.netloc[target.netloc.index(':') +
+										1:target.netloc.index('@')]
+		b2_bucket = target.netloc[target.netloc.index('@') + 1:]
+
+		try:
+			b2_api.authorize_account("production", b2_application_keyid,
+									b2_application_key)
+			bucket = b2_api.get_bucket_by_name(b2_bucket)
+		except NonExistentBucket as e:
+			raise ValueError(
+				"B2 Bucket does not exist. Please double check your information!"
+			)
+		return [(key.file_name, key.size) for key, _ in bucket.ls()]
 
 	else:
 		raise ValueError(config["target"])
 
 
-def backup_set_custom(env, target, target_user, target_pass, min_age):
+def backup_set_custom(env, target, target_user, target_pass, target_rsync_port, min_age):
 	config = get_backup_config(env, for_save=True)
 
 	# min_age must be an int
 	if isinstance(min_age, str):
 		min_age = int(min_age)
 
+	if isinstance(target_rsync_port, str):
+		try:
+			target_rsync_port = int(target_rsync_port)
+		except:
+			target_rsync_port = 22
+
 	config["target"] = target
 	config["target_user"] = target_user
 	config["target_pass"] = target_pass
+	config["target_rsync_port"] = target_rsync_port
 	config["min_age_in_days"] = min_age
 
 	# Validate.
@@ -503,19 +608,19 @@ def backup_set_custom(env, target, target_user, target_pass, min_age):
 
 	return "OK"
 
+
 def get_backup_config(env, for_save=False, for_ui=False):
 	backup_root = os.path.join(env["STORAGE_ROOT"], 'backup')
 
 	# Defaults.
-	config = {
-		"min_age_in_days": 3,
-		"target": "local",
-	}
+	config = {"min_age_in_days": 3, "target": "local", "target_rsync_port": 22}
 
 	# Merge in anything written to custom.yaml.
 	try:
-		custom_config = rtyaml.load(open(os.path.join(backup_root, 'custom.yaml')))
-		if not isinstance(custom_config, dict): raise ValueError() # caught below
+		custom_config = rtyaml.load(
+			open(os.path.join(backup_root, 'custom.yaml')))
+		if not isinstance(custom_config, dict):
+			raise ValueError()  # caught below
 		config.update(custom_config)
 	except:
 		pass
@@ -543,11 +648,13 @@ def get_backup_config(env, for_save=False, for_ui=False):
 
 	return config
 
+
 def write_backup_config(env, newconfig):
 	backup_root = os.path.join(env["STORAGE_ROOT"], 'backup')
 	with open(os.path.join(backup_root, 'custom.yaml'), "w") as f:
 		f.write(rtyaml.dump(newconfig))
 
+
 if __name__ == "__main__":
 	import sys
 	if sys.argv[-1] == "--verify":
@@ -556,15 +663,16 @@ if __name__ == "__main__":
 		run_duplicity_verification()
 
 	elif sys.argv[-1] == "--list":
-		# Run duplicity's verification command to check a) the backup files
-		# are readable, and b) report if they are up to date.
-		for fn, size in list_target_files(get_backup_config(load_environment())):
+		# List the saved backup files.
+		for fn, size in list_target_files(get_backup_config(
+			load_environment())):
 			print("{}\t{}".format(fn, size))
 
 	elif sys.argv[-1] == "--status":
 		# Show backup status.
 		ret = backup_status(load_environment())
 		print(rtyaml.dump(ret["backups"]))
+		print("Storage for unmatched files:", ret["unmatched_file_size"])
 
 	elif len(sys.argv) >= 2 and sys.argv[1] == "--restore":
 		# Run duplicity restore. Rest of command line passed as arguments

management/cli.py

@@ -0,0 +1,204 @@
+#!/usr/bin/python3
+#
+# This is a command-line script for calling management APIs
+# on the Mail-in-a-Box control panel backend. The script
+# reads /var/lib/mailinabox/api.key for the backend's
+# root API key. This file is readable only by root, so this
+# tool can only be used as root.
+
+import sys
+import getpass
+import urllib.request
+import urllib.error
+import json
+import re
+import csv
+
+
+def mgmt(cmd, data=None, is_json=False):
+	# The base URL for the management daemon. (Listens on IPv4 only.)
+	mgmt_uri = 'http://127.0.0.1:10222'
+
+	setup_key_auth(mgmt_uri)
+
+	req = urllib.request.Request(
+		mgmt_uri + cmd,
+		urllib.parse.urlencode(data).encode("utf8") if data else None)
+	try:
+		response = urllib.request.urlopen(req)
+	except urllib.error.HTTPError as e:
+		if e.code == 401:
+			try:
+				print(e.read().decode("utf8"))
+			except:
+				pass
+			print(
+				"The management daemon refused access. The API key file may be out of sync. Try 'service mailinabox restart'.",
+				file=sys.stderr)
+		elif hasattr(e, 'read'):
+			print(e.read().decode('utf8'), file=sys.stderr)
+		else:
+			print(e, file=sys.stderr)
+		sys.exit(1)
+	resp = response.read().decode('utf8')
+	if is_json:
+		resp = json.loads(resp)
+	return resp
+
+
+def read_password():
+	while True:
+		first = getpass.getpass('password: ')
+		if len(first) < 8:
+			print("Passwords must be at least eight characters.")
+			continue
+		second = getpass.getpass(' (again): ')
+		if first != second:
+			print("Passwords not the same. Try again.")
+			continue
+		break
+	return first
+
+
+def setup_key_auth(mgmt_uri):
+	key = open('/var/lib/mailinabox/api.key').read().strip()
+
+	auth_handler = urllib.request.HTTPBasicAuthHandler()
+	auth_handler.add_password(realm='Mail-in-a-Box Management Server',
+							uri=mgmt_uri,
+							user=key,
+							passwd='')
+	opener = urllib.request.build_opener(auth_handler)
+	urllib.request.install_opener(opener)
+
+
+if len(sys.argv) < 2:
+	print("""Usage:
+{cli} system default-quota [new default]       (set default quota for system)
+{cli} user                                     (lists users)
+{cli} user add user@domain.com [password]
+{cli} user password user@domain.com [password]
+{cli} user remove user@domain.com
+{cli} user make-admin user@domain.com
+{cli} user quota user@domain [new-quota]
+{cli} user remove-admin user@domain.com
+{cli} user admins                              (lists admins)
+{cli} user mfa show user@domain.com            (shows MFA devices for user, if any)
+{cli} user mfa disable user@domain.com [id]    (disables MFA for user)
+{cli} alias                                    (lists aliases)
+{cli} alias add incoming.name@domain.com sent.to@other.domain.com
+{cli} alias add incoming.name@domain.com 'sent.to@other.domain.com, multiple.people@other.domain.com'
+{cli} alias remove incoming.name@domain.com
+
+Removing a mail user does not delete their mail folders on disk. It only prevents IMAP/SMTP login.
+""".format(cli="management/cli.py"))
+
+elif sys.argv[1] == "user" and len(sys.argv) == 2:
+	# Dump a list of users, one per line. Mark admins with an asterisk.
+	users = mgmt("/mail/users?format=json", is_json=True)
+	for domain in users:
+		for user in domain["users"]:
+			if user['status'] == 'inactive':
+				continue
+			print(user['email'], end='')
+			if "admin" in user['privileges']:
+				print("*", end='')
+			if user['quota'] == '0':
+				print(" unlimited", end='')
+			else:
+				print(" " + user['quota'], end='')
+			print()
+
+elif sys.argv[1] == "user" and sys.argv[2] in ("add", "password"):
+	if len(sys.argv) < 5:
+		if len(sys.argv) < 4:
+			email = input("email: ")
+		else:
+			email = sys.argv[3]
+		pw = read_password()
+	else:
+		email, pw = sys.argv[3:5]
+
+	if sys.argv[2] == "add":
+		print(mgmt("/mail/users/add", {"email": email, "password": pw}))
+	elif sys.argv[2] == "password":
+		print(mgmt("/mail/users/password", {"email": email, "password": pw}))
+
+elif sys.argv[1] == "user" and sys.argv[2] == "remove" and len(sys.argv) == 4:
+	print(mgmt("/mail/users/remove", {"email": sys.argv[3]}))
+
+elif sys.argv[1] == "user" and sys.argv[2] in ("make-admin",
+											"remove-admin") and len(
+												sys.argv) == 4:
+	if sys.argv[2] == "make-admin":
+		action = "add"
+	else:
+		action = "remove"
+	print(
+		mgmt("/mail/users/privileges/" + action, {
+			"email": sys.argv[3],
+			"privilege": "admin"
+		}))
+
+elif sys.argv[1] == "user" and sys.argv[2] == "admins":
+	# Dump a list of admin users.
+	users = mgmt("/mail/users?format=json", is_json=True)
+	for domain in users:
+		for user in domain["users"]:
+			if "admin" in user['privileges']:
+				print(user['email'])
+
+elif sys.argv[1] == "user" and sys.argv[2] == "quota" and len(sys.argv) == 4:
+	# Set a user's quota
+	print(mgmt("/mail/users/quota?text=1&email=%s" % sys.argv[3]))
+
+elif sys.argv[1] == "user" and sys.argv[2] == "quota" and len(sys.argv) == 5:
+	# Set a user's quota
+	users = mgmt("/mail/users/quota", {
+		"email": sys.argv[3],
+		"quota": sys.argv[4]
+	})
+
+elif sys.argv[1] == "user" and len(
+		sys.argv) == 5 and sys.argv[2:4] == ["mfa", "show"]:
+	# Show MFA status for a user.
+	status = mgmt("/mfa/status", {"user": sys.argv[4]}, is_json=True)
+	W = csv.writer(sys.stdout)
+	W.writerow(["id", "type", "label"])
+	for mfa in status["enabled_mfa"]:
+		W.writerow([mfa["id"], mfa["type"], mfa["label"]])
+
+elif sys.argv[1] == "user" and len(
+		sys.argv) in (5, 6) and sys.argv[2:4] == ["mfa", "disable"]:
+	# Disable MFA (all or a particular device) for a user.
+	print(
+		mgmt(
+			"/mfa/disable", {
+				"user": sys.argv[4],
+				"mfa-id": sys.argv[5] if len(sys.argv) == 6 else None
+			}))
+
+elif sys.argv[1] == "alias" and len(sys.argv) == 2:
+	print(mgmt("/mail/aliases"))
+
+elif sys.argv[1] == "alias" and sys.argv[2] == "add" and len(sys.argv) == 5:
+	print(
+		mgmt("/mail/aliases/add", {
+			"address": sys.argv[3],
+			"forwards_to": sys.argv[4]
+		}))
+
+elif sys.argv[1] == "alias" and sys.argv[2] == "remove" and len(sys.argv) == 4:
+	print(mgmt("/mail/aliases/remove", {"address": sys.argv[3]}))
+
+elif sys.argv[1] == "system" and sys.argv[2] == "default-quota" and len(
+		sys.argv) == 3:
+	print(mgmt("/system/default-quota?text=1"))
+
+elif sys.argv[1] == "system" and sys.argv[2] == "default-quota" and len(
+		sys.argv) == 4:
+	print(mgmt("/system/default-quota", {"default_quota": sys.argv[3]}))
+
+else:
+	print("Invalid command-line arguments.")
+	sys.exit(1)

management/daily_tasks.sh

@@ -9,11 +9,20 @@ export LC_ALL=en_US.UTF-8
 export LANG=en_US.UTF-8
 export LC_TYPE=en_US.UTF-8
 
+# On Mondays, i.e. once a week, send the administrator a report of total emails
+# sent and received so the admin might notice server abuse.
+if [ `date "+%u"` -eq 1 ]; then
+	management/mail_log.py -t week | management/email_administrator.py "Mail-in-a-Box Usage Report"
+fi
+
 # Take a backup.
-management/backup.py | management/email_administrator.py "Backup Status"
+management/backup.py 2>&1 | management/email_administrator.py "Backup Status"
 
 # Provision any new certificates for new domains or domains with expiring certificates.
-management/ssl_certificates.py -q --headless | management/email_administrator.py "Error Provisioning TLS Certificate"
+management/ssl_certificates.py -q 2>&1 | management/email_administrator.py "TLS Certificate Provisioning Result"
+
+# Renew the daemon's PGP key if about to expire
+management/pgp.py 2>&1 | management/email_administrator.py "PGP Key Renewal Result"
 
 # Run status checks and email the administrator if anything changed.
-management/status_checks.py --show-changes | management/email_administrator.py "Status Checks Change Notice"
+management/status_checks.py --show-changes 2>&1 | management/email_administrator.py "Status Checks Change Notice"

management/editconf.py

@@ -0,0 +1,165 @@
+#!/usr/bin/python3
+#
+# This is a helper tool for editing configuration files during the setup
+# process. The tool is given new values for settings as command-line
+# arguments. It comments-out existing setting values in the configuration
+# file and adds new values either after their former location or at the
+# end.
+#
+# The configuration file has settings that look like:
+#
+# NAME=VALUE
+#
+# If the -s option is given, then space becomes the delimiter, i.e.:
+#
+# NAME VALUE
+#
+# If the -c option is given, then the supplied character becomes the comment character
+#
+# If the -w option is given, then setting lines continue onto following
+# lines while the lines start with whitespace, e.g.:
+#
+# NAME VAL
+#   UE
+
+# create the new config file in memory
+
+import sys
+import re
+
+
+def edit_conf(filename,
+			settings,
+			delimiter_re,
+			delimiter,
+			comment_char,
+			folded_lines=False,
+			testing=False,
+			erase_setting=False):
+	found = set()
+	buf = ""
+	input_lines = list(open(filename, "r+"))
+
+	while len(input_lines) > 0:
+		line = input_lines.pop(0)
+
+		# If this configuration file uses folded lines, append any folded lines
+		# into our input buffer.
+		if folded_lines and line[0] not in (comment_char, " ", ""):
+			while len(input_lines) > 0 and input_lines[0][0] in " \t":
+				line += input_lines.pop(0)
+
+		# See if this line is for any settings passed on the command line.
+		for i in range(len(settings)):
+			# Check whether this line contain this setting from the command-line arguments.
+			name, val = settings[i].split("=", 1)
+			m = re.match(
+				"(\s*)" + "(" + re.escape(comment_char) + "\s*)?" +
+				re.escape(name) + delimiter_re + "(.*?)\s*$", line, re.S)
+			if not m:
+				continue
+			indent, is_comment, existing_val = m.groups()
+
+			# If this is already the setting, keep it in the file, except:
+			# * If we've already seen it before, then remove this duplicate line.
+			# * If val is empty and erase_setting is on, then comment it out.
+			if is_comment is None and existing_val == val and not (not val and erase_setting):
+				# It may be that we've already inserted this setting higher
+				# in the file so check for that first.
+				if i in found:
+					break
+				buf += line
+				found.add(i)
+				break
+
+			# comment-out the existing line (also comment any folded lines)
+			if is_comment is None:
+				buf += comment_char + line.rstrip().replace(
+					"\n", "\n" + comment_char) + "\n"
+			else:
+				# the line is already commented, pass it through
+				buf += line
+
+			# if this option oddly appears more than once, don't add the setting again
+			# Or if we're clearing it, don't add it
+			if (i in found) or (not val and erase_setting):
+				break
+
+			# add the new setting
+			buf += indent + name + delimiter + val + "\n"
+
+			# note that we've applied this option
+			found.add(i)
+
+			break
+		else:
+			# If did not match any setting names, pass this line through.
+			buf += line
+
+	# Put any settings we didn't see at the end of the file, except those being erased.
+	for i in range(len(settings)):
+		if i not in found:
+			name, val = settings[i].split("=", 1)
+			if not (not val and erase_setting):
+				buf += name + delimiter + val + "\n"
+
+	if not testing:
+		# Write out the new file.
+		with open(filename, "w") as f:
+			f.write(buf)
+	else:
+		# Just print the new file to stdout.
+		print(buf)
+
+
+# Run standalone
+if __name__ == "__main__":
+	# sanity check
+	if len(sys.argv) < 3:
+		print(
+			"usage: python3 editconf.py /etc/file.conf [-s] [-w] [-c <CHARACTER>] [-t] NAME=VAL [NAME=VAL ...]"
+		)
+		sys.exit(1)
+
+	# parse command line arguments
+	filename = sys.argv[1]
+	settings = sys.argv[2:]
+
+	delimiter = "="
+	delimiter_re = r"\s*=\s*"
+	comment_char = "#"
+	folded_lines = False
+	testing = False
+	erase_setting = False
+	while settings[0][0] == "-" and settings[0] != "--":
+		opt = settings.pop(0)
+		if opt == "-s":
+			# Space is the delimiter
+			delimiter = " "
+			delimiter_re = r"\s+"
+		elif opt == "-e":
+			# Erase settings that have empty values.
+			erase_setting = True
+		elif opt == "-w":
+			# Line folding is possible in this file.
+			folded_lines = True
+		elif opt == "-c":
+			# Specifies a different comment character.
+			comment_char = settings.pop(0)
+		elif opt == "-t":
+			testing = True
+		else:
+			print("Invalid option.")
+			sys.exit(1)
+
+	# sanity check command line
+	for setting in settings:
+		try:
+			name, value = setting.split("=", 1)
+		except:
+			import subprocess
+			print("Invalid command line: ", subprocess.list2cmdline(sys.argv))
+			sys.exit(1)
+
+	edit_conf(filename, settings, delimiter_re, delimiter, comment_char,
+			folded_lines, testing, erase_setting)

management/email_administrator.py

@@ -1,11 +1,19 @@
-#!/usr/bin/python3
+#!/usr/local/lib/mailinabox/env/bin/python
 
 # Reads in STDIN. If the stream is not empty, mail it to the system administrator.
 
 import sys
 
+import html
 import smtplib
-from email.message import Message
+
+from email.mime.multipart import MIMEMultipart
+from email.mime.text import MIMEText
+
+from pgp import create_signature
+
+# In Python 3.6:
+#from email.message import Message
 
 from utils import load_environment
 
@@ -15,9 +23,6 @@ env = load_environment()
 # Process command line args.
 subject = sys.argv[1]
 
-# Administrator's email address.
-admin_addr = "administrator@" + env['PRIMARY_HOSTNAME']
-
 # Read in STDIN.
 content = sys.stdin.read().strip()
 
@@ -26,17 +31,34 @@ if content == "":
 	sys.exit(0)
 
 # create MIME message
-msg = Message()
-msg['From'] = "\"%s\" <%s>" % (env['PRIMARY_HOSTNAME'], admin_addr)
-msg['To'] = admin_addr
+msg = MIMEMultipart('alternative')
+
+# In Python 3.6:
+#msg = Message()
+
+noreply = "noreply-daemon@" + env['PRIMARY_HOSTNAME']
+admin_addr = "administrator@" + env['PRIMARY_HOSTNAME']
+
+msg['From'] = "\"%s\" <%s>" % ("System Management Daemon",
+							"noreply-daemon@" + env['PRIMARY_HOSTNAME'])
+msg['To'] = "administrator@" + env['PRIMARY_HOSTNAME']
 msg['Subject'] = "[%s] %s" % (env['PRIMARY_HOSTNAME'], subject)
-msg.set_payload(content, "UTF-8")
+
+content_html = "<html><body><pre>{}</pre></body></html>".format(
+	html.escape(content))
+
+msg.attach(MIMEText(create_signature(content.encode()).decode(), 'plain'))
+msg.attach(MIMEText(content_html, 'html'))
+
+# In Python 3.6:
+# msg.set_content(content)
+#msg.add_alternative(content_html, "html")
 
 # send
 smtpclient = smtplib.SMTP('127.0.0.1', 25)
 smtpclient.ehlo()
 smtpclient.sendmail(
-        admin_addr, # MAIL FROM
-        admin_addr, # RCPT TO
-        msg.as_string())
+	noreply,  # MAIL FROM
+	admin_addr,  # RCPT TO
+	msg.as_string())
 smtpclient.quit()

management/mailconfig.py

@@ -1,14 +1,28 @@
-#!/usr/bin/python3
+#!/usr/local/lib/mailinabox/env/bin/python
 
-import subprocess, shutil, os, sqlite3, re
+# NOTE:
+# This script is run both using the system-wide Python 3
+# interpreter (/usr/bin/python3) as well as through the
+# virtualenv (/usr/local/lib/mailinabox/env). So only
+# import packages at the top level of this script that
+# are installed in *both* contexts. We use the system-wide
+# Python 3 in setup/questions.sh to validate the email
+# address entered by the user.
+
+import subprocess
+import shutil
+import os
+import sqlite3
+import re
 import utils
 from email_validator import validate_email as validate_email_, EmailNotValidError
 import idna
 
+
 def validate_email(email, mode=None):
 	# Checks that an email address is syntactically valid. Returns True/False.
-	# Until Postfix supports SMTPUTF8, an email address may contain ASCII
-	# characters only; IDNs must be IDNA-encoded.
+	# An email address may contain ASCII characters only because Dovecot's
+	# authentication mechanism gets confused with other character encodings.
 	#
 	# When mode=="user", we're checking that this can be a user account name.
 	# Dovecot has tighter restrictions - letters, numbers, underscore, and
@@ -20,10 +34,9 @@ def validate_email(email, mode=None):
 	# Check the syntax of the address.
 	try:
 		validate_email_(email,
-			allow_smtputf8=False,
-			check_deliverability=False,
-			allow_empty_local=(mode=="alias")
-			)
+						allow_smtputf8=False,
+						check_deliverability=False,
+						allow_empty_local=(mode == "alias"))
 	except EmailNotValidError:
 		return False
 
@@ -36,13 +49,15 @@ def validate_email(email, mode=None):
 		# Our database is case sensitive (oops), which affects mail delivery
 		# (Postfix always queries in lowercase?), so also only permit lowercase
 		# letters.
-		if len(email) > 255: return False
+		if len(email) > 255:
+			return False
 		if re.search(r'[^\@\.a-z0-9_\-]+', email):
 			return False
 
 	# Everything looks good.
 	return True
 
+
 def sanitize_idn_email_address(email):
 	# The user may enter Unicode in an email address. Convert the domain part
 	# to IDNA before going into our database. Leave the local part alone ---
@@ -63,6 +78,7 @@ def sanitize_idn_email_address(email):
 		# validate_email.
 		return email
 
+
 def prettify_idn_email_address(email):
 	# This is the opposite of sanitize_idn_email_address. We store domain
 	# names in IDNA in the database, but we want to show Unicode to the user.
@@ -75,13 +91,17 @@ def prettify_idn_email_address(email):
 		# single @-sign. Should never happen.
 		return email
 
+
 def is_dcv_address(email):
 	email = email.lower()
-	for localpart in ("admin", "administrator", "postmaster", "hostmaster", "webmaster", "abuse"):
-		if email.startswith(localpart+"@") or email.startswith(localpart+"+"):
+	for localpart in ("admin", "administrator", "postmaster", "hostmaster",
+					"webmaster", "abuse"):
+		if email.startswith(localpart + "@") or email.startswith(localpart +
+																"+"):
 			return True
 	return False
 
+
 def open_database(env, with_connection=False):
 	conn = sqlite3.connect(env["STORAGE_ROOT"] + "/mail/users.sqlite")
 	if not with_connection:
@@ -89,14 +109,29 @@ def open_database(env, with_connection=False):
 	else:
 		return conn, conn.cursor()
 
+
 def get_mail_users(env):
 	# Returns a flat, sorted list of all user accounts.
 	c = open_database(env)
 	c.execute('SELECT email FROM users')
-	users = [ row[0] for row in c.fetchall() ]
+	users = [row[0] for row in c.fetchall()]
 	return utils.sort_email_addresses(users, env)
 
-def get_mail_users_ex(env, with_archived=False, with_slow_info=False):
+
+def sizeof_fmt(num):
+	for unit in ['', 'K', 'M', 'G', 'T']:
+		if abs(num) < 1024.0:
+			if abs(num) > 99:
+				return "%3.0f%s" % (num, unit)
+			else:
+				return "%2.1f%s" % (num, unit)
+
+		num /= 1024.0
+
+	return str(num)
+
+
+def get_mail_users_ex(env, with_archived=False):
 	# Returns a complex data structure of all user accounts, optionally
 	# including archived (status="inactive") accounts.
 	#
@@ -119,20 +154,53 @@ def get_mail_users_ex(env, with_archived=False, with_slow_info=False):
 	users = []
 	active_accounts = set()
 	c = open_database(env)
-	c.execute('SELECT email, privileges FROM users')
-	for email, privileges in c.fetchall():
+	c.execute('SELECT email, privileges, quota FROM users')
+	for email, privileges, quota in c.fetchall():
 		active_accounts.add(email)
 
+		(user, domain) = email.split('@')
+		box_size = 0
+		box_count = 0
+		box_quota = 0
+		percent = ''
+		try:
+			dirsize_file = os.path.join(
+				env['STORAGE_ROOT'],
+				'mail/mailboxes/%s/%s/maildirsize' % (domain, user))
+			with open(dirsize_file, 'r') as f:
+				box_quota = int(f.readline().split('S')[0])
+				for line in f.readlines():
+					(size, count) = line.split(' ')
+					box_size += int(size)
+					box_count += int(count)
+
+			try:
+				percent = (box_size / box_quota) * 100
+			except:
+				percent = 'Error'
+
+		except:
+			box_size = '?'
+			box_count = '?'
+			box_quota = '?'
+			percent = '?'
+
+		if quota == '0':
+			percent = ''
+
 		user = {
 			"email": email,
 			"privileges": parse_privs(privileges),
+			"quota": quota,
+			"box_quota": box_quota,
+			"box_size": sizeof_fmt(box_size) if box_size != '?' else box_size,
+			"percent":
+			'%3.0f%%' % percent if type(percent) != str else percent,
+			"box_count": box_count,
 			"status": "active",
 		}
 		users.append(user)
 
-		if with_slow_info:
-			user["mailbox_size"] = utils.du(os.path.join(env['STORAGE_ROOT'], 'mail/mailboxes', *reversed(email.split("@"))))
-
 	# Add in archived accounts.
 	if with_archived:
 		root = os.path.join(env['STORAGE_ROOT'], 'mail/mailboxes')
@@ -141,37 +209,41 @@ def get_mail_users_ex(env, with_archived=False, with_slow_info=False):
 				for user in os.listdir(os.path.join(root, domain)):
 					email = user + "@" + domain
 					mbox = os.path.join(root, domain, user)
-					if email in active_accounts: continue
+					if email in active_accounts:
+						continue
 					user = {
 						"email": email,
-						"privileges": "",
+						"privileges": [],
 						"status": "inactive",
 						"mailbox": mbox,
+						"box_count": '?',
+						"box_size": '?',
+						"box_quota": '?',
+						"percent": '?',
 					}
 					users.append(user)
-					if with_slow_info:
-						user["mailbox_size"] = utils.du(mbox)
 
 	# Group by domain.
-	domains = { }
+	domains = {}
 	for user in users:
 		domain = get_domain(user["email"])
 		if domain not in domains:
-			domains[domain] = {
-				"domain": domain,
-				"users": []
-				}
+			domains[domain] = {"domain": domain, "users": []}
 		domains[domain]["users"].append(user)
 
 	# Sort domains.
-	domains = [domains[domain] for domain in utils.sort_domains(domains.keys(), env)]
+	domains = [
+		domains[domain] for domain in utils.sort_domains(domains.keys(), env)
+	]
 
 	# Sort users within each domain first by status then lexicographically by email address.
 	for domain in domains:
-		domain["users"].sort(key = lambda user : (user["status"] != "active", user["email"]))
+		domain["users"].sort(
+			key=lambda user: (user["status"] != "active", user["email"]))
 
 	return domains
 
+
 def get_admins(env):
 	# Returns a set of users with admin privileges.
 	users = set()
@@ -181,16 +253,23 @@ def get_admins(env):
 				users.add(user["email"])
 	return users
 
+
 def get_mail_aliases(env):
-	# Returns a sorted list of tuples of (address, forward-tos, permitted-senders).
+	# Returns a sorted list of tuples of (address, forward-tos, permitted-senders, auto).
 	c = open_database(env)
-	c.execute('SELECT source, destination, permitted_senders FROM aliases')
-	aliases = { row[0]: row for row in c.fetchall() } # make dict
+	c.execute(
+		'SELECT source, destination, permitted_senders, 0 as auto FROM aliases UNION SELECT source, destination, permitted_senders, 1 as auto FROM auto_aliases'
+	)
+	aliases = {row[0]: row for row in c.fetchall()}  # make dict
 
 	# put in a canonical order: sort by domain, then by email address lexicographically
-	aliases = [ aliases[address] for address in utils.sort_email_addresses(aliases.keys(), env) ]
+	aliases = [
+		aliases[address]
+		for address in utils.sort_email_addresses(aliases.keys(), env)
+	]
 	return aliases
 
+
 def get_mail_aliases_ex(env):
 	# Returns a complex data structure of all mail aliases, similar
 	# to get_mail_users_ex.
@@ -204,7 +283,7 @@ def get_mail_aliases_ex(env):
 	#         address_display: "name@domain.tld", # full Unicode
 	#         forwards_to: ["user1@domain.com", "receiver-only1@domain.com", ...],
 	#         permitted_senders: ["user1@domain.com", "sender-only1@domain.com", ...] OR null,
-	#         required: True|False
+	#         auto: True|False
 	#       },
 	#       ...
 	#     ]
@@ -212,12 +291,14 @@ def get_mail_aliases_ex(env):
 	#   ...
 	# ]
 
-	required_aliases = get_required_aliases(env)
 	domains = {}
-	for address, forwards_to, permitted_senders in get_mail_aliases(env):
+	for address, forwards_to, permitted_senders, auto in get_mail_aliases(env):
+		# skip auto domain maps since these are not informative in the control panel's aliases list
+		if auto and address.startswith("@"):
+			continue
+
 		# get alias info
 		domain = get_domain(address)
-		required = (address in required_aliases)
 
 		# add to list
 		if not domain in domains:
@@ -226,21 +307,43 @@ def get_mail_aliases_ex(env):
 				"aliases": [],
 			}
 		domains[domain]["aliases"].append({
-			"address": address,
-			"address_display": prettify_idn_email_address(address),
-			"forwards_to": [prettify_idn_email_address(r.strip()) for r in forwards_to.split(",")],
-			"permitted_senders": [prettify_idn_email_address(s.strip()) for s in permitted_senders.split(",")] if permitted_senders is not None else None,
-			"required": required,
+			"address":
+			address,
+			"address_display":
+			prettify_idn_email_address(address),
+			"forwards_to": [
+				prettify_idn_email_address(r.strip())
+				for r in forwards_to.split(",")
+			],
+			"permitted_senders": [
+				prettify_idn_email_address(s.strip())
+				for s in permitted_senders.split(",")
+			] if permitted_senders is not None else None,
+			"auto":
+			bool(auto),
 		})
 
 	# Sort domains.
-	domains = [domains[domain] for domain in utils.sort_domains(domains.keys(), env)]
+	domains = [
+		domains[domain] for domain in utils.sort_domains(domains.keys(), env)
+	]
 
 	# Sort aliases within each domain first by required-ness then lexicographically by address.
 	for domain in domains:
-		domain["aliases"].sort(key = lambda alias : (alias["required"], alias["address"]))
+		domain["aliases"].sort(
+			key=lambda alias: (alias["auto"], alias["address"]))
 	return domains
 
+
+def get_noreply_addresses(env):
+	# Returns a set of noreply addresses:
+	# Noreply addresses are a special type of addresses that are send-only.
+	# Mail sent to these addresses is automatically bounced with a customized message..
+	c = open_database(env)
+	c.execute('SELECT email FROM noreply')
+	return set(row[0] for row in c.fetchall())
+
+
 def get_domain(emailaddr, as_unicode=True):
 	# Gets the domain part of an email address. Turns IDNA
 	# back to Unicode for display.
@@ -254,27 +357,58 @@ def get_domain(emailaddr, as_unicode=True):
 			pass
 	return ret
 
-def get_mail_domains(env, filter_aliases=lambda alias : True):
-	# Returns the domain names (IDNA-encoded) of all of the email addresses
-	# configured on the system.
-	return set(
-		   [get_domain(login, as_unicode=False) for login in get_mail_users(env)]
-		 + [get_domain(address, as_unicode=False) for address, *_ in get_mail_aliases(env) if filter_aliases(address) ]
-		 )
 
-def add_mail_user(email, pw, privs, env):
+def get_all_mail_addresses(env, no_catchalls=True):
+	# Gets the email addresses on literally all tables (users, aliases and noreplies)
+	emails = get_mail_users(env)
+	emails.extend([a[0] for a in get_mail_aliases(env)])
+	emails.extend(get_noreply_addresses(env))
+
+	# Filter out catch-alls
+	if no_catchalls:
+		return set(filter(lambda e: e.split("@")[0].strip != "", emails))
+
+	return set(emails)
+
+
+def get_mail_domains(env, filter_aliases=lambda alias: True, users_only=False):
+	# Returns the domain names (IDNA-encoded) of all of the email addresses
+	# configured on the system. If users_only is True, only return domains
+	# with email addresses that correspond to user accounts. Exclude Unicode
+	# forms of domain names listed in the automatic aliases table.
+	domains = []
+	domains.extend(
+		[get_domain(login, as_unicode=False) for login in get_mail_users(env)])
+	if not users_only:
+		domains.extend([
+			get_domain(address, as_unicode=False)
+			for address, _, _, auto in get_mail_aliases(env)
+			if filter_aliases(address) and not auto
+		])
+		domains.extend([
+			get_domain(address, as_unicode=False)
+			for address in get_noreply_addresses(env)
+		])
+	return set(domains)
+
+
+def add_mail_user(email, pw, privs, quota, env):
 	# validate email
 	if email.strip() == "":
 		return ("No email address provided.", 400)
 	elif not validate_email(email):
 		return ("Invalid email address.", 400)
 	elif not validate_email(email, mode='user'):
-		return ("User account email addresses may only use the lowercase ASCII letters a-z, the digits 0-9, underscore (_), hyphen (-), and period (.).", 400)
+		return (
+			"User account email addresses may only use the lowercase ASCII letters a-z, the digits 0-9, underscore (_), hyphen (-), and period (.).",
+			400)
 	elif is_dcv_address(email) and len(get_mail_users(env)) > 0:
 		# Make domain control validation hijacking a little harder to mess up by preventing the usual
 		# addresses used for DCV from being user accounts. Except let it be the first account because
 		# during box setup the user won't know the rules.
-		return ("You may not make a user account for that address because it is frequently used for domain control validation. Use an alias instead if necessary.", 400)
+		return (
+			"You may not make a user account for that address because it is frequently used for domain control validation. Use an alias instead if necessary.",
+			400)
 
 	# validate password
 	validate_password(pw)
@@ -286,7 +420,16 @@ def add_mail_user(email, pw, privs, env):
 		privs = privs.split("\n")
 		for p in privs:
 			validation = validate_privilege(p)
-			if validation: return validation
+			if validation:
+				return validation
+
+	if quota is None:
+		quota = get_default_quota()
+
+	try:
+		quota = validate_quota(quota)
+	except ValueError as e:
+		return (str(e), 400)
 
 	# get the database
 	conn, c = open_database(env, with_connection=True)
@@ -296,17 +439,21 @@ def add_mail_user(email, pw, privs, env):
 
 	# add the user to the database
 	try:
-		c.execute("INSERT INTO users (email, password, privileges) VALUES (?, ?, ?)",
-			(email, pw, "\n".join(privs)))
+		c.execute(
+			"INSERT INTO users (email, password, privileges, quota) VALUES (?, ?, ?, ?)",
+			(email, pw, "\n".join(privs), quota))
 	except sqlite3.IntegrityError:
 		return ("User already exists.", 400)
 
 	# write databasebefore next step
 	conn.commit()
 
+	dovecot_quota_recalc(email)
+
 	# Update things in case any new domains are added.
 	return kick(env, "mail user added")
 
+
 def set_mail_password(email, pw, env):
 	# validate that password is acceptable
 	validate_password(pw)
@@ -322,11 +469,72 @@ def set_mail_password(email, pw, env):
 	conn.commit()
 	return "OK"
 
+
 def hash_password(pw):
 	# Turn the plain password into a Dovecot-format hashed password, meaning
 	# something like "{SCHEME}hashedpassworddata".
 	# http://wiki2.dovecot.org/Authentication/PasswordSchemes
-	return utils.shell('check_output', ["/usr/bin/doveadm", "pw", "-s", "SHA512-CRYPT", "-p", pw]).strip()
+	return utils.shell(
+		'check_output',
+		["/usr/bin/doveadm", "pw", "-s", "SHA512-CRYPT", "-p", pw]).strip()
+
+
+def get_mail_quota(email, env):
+	conn, c = open_database(env, with_connection=True)
+	c.execute("SELECT quota FROM users WHERE email=?", (email, ))
+	rows = c.fetchall()
+	if len(rows) != 1:
+		return ("That's not a user (%s)." % email, 400)
+
+	return rows[0][0]
+
+
+def set_mail_quota(email, quota, env):
+	# validate that password is acceptable
+	quota = validate_quota(quota)
+
+	# update the database
+	conn, c = open_database(env, with_connection=True)
+	c.execute("UPDATE users SET quota=? WHERE email=?", (quota, email))
+	if c.rowcount != 1:
+		return ("That's not a user (%s)." % email, 400)
+	conn.commit()
+
+	dovecot_quota_recalc(email)
+
+	return "OK"
+
+
+def dovecot_quota_recalc(email):
+	# dovecot processes running for the user will not recognize the new quota setting
+	# a reload is necessary to reread the quota setting, but it will also shut down
+	# running dovecot processes.  Email clients generally log back in when they lose
+	# a connection.
+	# subprocess.call(['doveadm', 'reload'])
+
+	# force dovecot to recalculate the quota info for the user.
+	subprocess.call(["doveadm", "quota", "recalc", "-u", email])
+
+
+def get_default_quota(env):
+	config = utils.load_settings(env)
+	return config.get("default-quota", '0')
+
+
+def validate_quota(quota):
+	# validate quota
+	quota = quota.strip().upper()
+
+	if quota == "":
+		raise ValueError("No quota provided.")
+	if re.search(r"[\s,.]", quota):
+		raise ValueError(
+			"Quotas cannot contain spaces, commas, or decimal points.")
+	if not re.match(r'^[\d]+[GM]?$', quota):
+		raise ValueError("Invalid quota.")
+
+	return quota
+
 
 def get_mail_password(email, env):
 	# Gets the hashed password for a user. Passwords are stored in Dovecot's
@@ -334,16 +542,17 @@ def get_mail_password(email, env):
 	# http://wiki2.dovecot.org/Authentication/PasswordSchemes
 	# update the database
 	c = open_database(env)
-	c.execute('SELECT password FROM users WHERE email=?', (email,))
+	c.execute('SELECT password FROM users WHERE email=?', (email, ))
 	rows = c.fetchall()
 	if len(rows) != 1:
 		raise ValueError("That's not a user (%s)." % email)
 	return rows[0][0]
 
+
 def remove_mail_user(email, env):
 	# remove
 	conn, c = open_database(env, with_connection=True)
-	c.execute("DELETE FROM users WHERE email=?", (email,))
+	c.execute("DELETE FROM users WHERE email=?", (email, ))
 	if c.rowcount != 1:
 		return ("That's not a user (%s)." % email, 400)
 	conn.commit()
@@ -351,32 +560,39 @@ def remove_mail_user(email, env):
 	# Update things in case any domains are removed.
 	return kick(env, "mail user removed")
 
+
 def parse_privs(value):
 	return [p for p in value.split("\n") if p.strip() != ""]
 
+
 def get_mail_user_privileges(email, env, empty_on_error=False):
 	# get privs
 	c = open_database(env)
-	c.execute('SELECT privileges FROM users WHERE email=?', (email,))
+	c.execute('SELECT privileges FROM users WHERE email=?', (email, ))
 	rows = c.fetchall()
 	if len(rows) != 1:
-		if empty_on_error: return []
+		if empty_on_error:
+			return []
 		return ("That's not a user (%s)." % email, 400)
 	return parse_privs(rows[0][0])
 
+
 def validate_privilege(priv):
 	if "\n" in priv or priv.strip() == "":
 		return ("That's not a valid privilege (%s)." % priv, 400)
 	return None
 
+
 def add_remove_mail_user_privilege(email, priv, action, env):
 	# validate
 	validation = validate_privilege(priv)
-	if validation: return validation
+	if validation:
+		return validation
 
 	# get existing privs, but may fail
 	privs = get_mail_user_privileges(email, env)
-	if isinstance(privs, tuple): return privs # error
+	if isinstance(privs, tuple):
+		return privs  # error
 
 	# update privs set
 	if action == "add":
@@ -389,14 +605,21 @@ def add_remove_mail_user_privilege(email, priv, action, env):
 
 	# commit to database
 	conn, c = open_database(env, with_connection=True)
-	c.execute("UPDATE users SET privileges=? WHERE email=?", ("\n".join(privs), email))
+	c.execute("UPDATE users SET privileges=? WHERE email=?",
+			("\n".join(privs), email))
 	if c.rowcount != 1:
 		return ("Something went wrong.", 400)
 	conn.commit()
 
 	return "OK"
 
-def add_mail_alias(address, forwards_to, permitted_senders, env, update_if_exists=False, do_kick=True):
+
+def add_mail_alias(address,
+				forwards_to,
+				permitted_senders,
+				env,
+				update_if_exists=False,
+				do_kick=True):
 	# convert Unicode domain to IDNA
 	address = sanitize_idn_email_address(address)
 
@@ -433,15 +656,23 @@ def add_mail_alias(address, forwards_to, permitted_senders, env, update_if_exist
 		for line in forwards_to.split("\n"):
 			for email in line.split(","):
 				email = email.strip()
-				if email == "": continue
-				email = sanitize_idn_email_address(email) # Unicode => IDNA
+				if email == "":
+					continue
+				email = sanitize_idn_email_address(email)  # Unicode => IDNA
+				# Strip any +tag from email alias and check privileges
+				privileged_email = re.sub(r"(?=\+)[^@]*(?=@)", '', email)
 				if not validate_email(email):
-					return ("Invalid receiver email address (%s)." % email, 400)
-				if is_dcv_source and not is_dcv_address(email) and "admin" not in get_mail_user_privileges(email, env, empty_on_error=True):
+					return ("Invalid receiver email address (%s)." % email,
+							400)
+				if is_dcv_source and not is_dcv_address(
+					email) and "admin" not in get_mail_user_privileges(
+						privileged_email, env, empty_on_error=True):
 					# Make domain control validation hijacking a little harder to mess up by
 					# requiring aliases for email addresses typically used in DCV to forward
 					# only to accounts that are administrators on this system.
-					return ("This alias can only have administrators of this system as destinations because the address is frequently used for domain control validation.", 400)
+					return (
+						"This alias can only have administrators of this system as destinations because the address is frequently used for domain control validation.",
+						400)
 				validated_forwards_to.append(email)
 
 	# validate permitted_senders
@@ -454,14 +685,19 @@ def add_mail_alias(address, forwards_to, permitted_senders, env, update_if_exist
 	for line in permitted_senders.split("\n"):
 		for login in line.split(","):
 			login = login.strip()
-			if login == "": continue
+			if login == "":
+				continue
 			if login not in valid_logins:
-				return ("Invalid permitted sender: %s is not a user on this system." % login, 400)
+				return (
+					"Invalid permitted sender: %s is not a user on this system."
+					% login, 400)
 			validated_permitted_senders.append(login)
 
 	# Make sure the alias has either a forwards_to or a permitted_sender.
 	if len(validated_forwards_to) + len(validated_permitted_senders) == 0:
-		return ("The alias must either forward to an address or have a permitted sender.", 400)
+		return (
+			"The alias must either forward to an address or have a permitted sender.",
+			400)
 
 	# save to db
 
@@ -474,13 +710,17 @@ def add_mail_alias(address, forwards_to, permitted_senders, env, update_if_exist
 
 	conn, c = open_database(env, with_connection=True)
 	try:
-		c.execute("INSERT INTO aliases (source, destination, permitted_senders) VALUES (?, ?, ?)", (address, forwards_to, permitted_senders))
+		c.execute(
+			"INSERT INTO aliases (source, destination, permitted_senders) VALUES (?, ?, ?)",
+			(address, forwards_to, permitted_senders))
 		return_status = "alias added"
 	except sqlite3.IntegrityError:
 		if not update_if_exists:
 			return ("Alias already exists (%s)." % address, 400)
 		else:
-			c.execute("UPDATE aliases SET destination = ?, permitted_senders = ? WHERE source = ?", (forwards_to, permitted_senders, address))
+			c.execute(
+				"UPDATE aliases SET destination = ?, permitted_senders = ? WHERE source = ?",
+				(forwards_to, permitted_senders, address))
 			return_status = "alias updated"
 
 	conn.commit()
@@ -489,13 +729,14 @@ def add_mail_alias(address, forwards_to, permitted_senders, env, update_if_exist
 		# Update things in case any new domains are added.
 		return kick(env, return_status)
 
+
 def remove_mail_alias(address, env, do_kick=True):
 	# convert Unicode domain to IDNA
 	address = sanitize_idn_email_address(address)
 
 	# remove
 	conn, c = open_database(env, with_connection=True)
-	c.execute("DELETE FROM aliases WHERE source=?", (address,))
+	c.execute("DELETE FROM aliases WHERE source=?", (address, ))
 	if c.rowcount != 1:
 		return ("That's not an alias (%s)." % address, 400)
 	conn.commit()
@@ -504,9 +745,21 @@ def remove_mail_alias(address, env, do_kick=True):
 		# Update things in case any domains are removed.
 		return kick(env, "alias removed")
 
+
+def add_auto_aliases(aliases, env):
+	conn, c = open_database(env, with_connection=True)
+	c.execute("DELETE FROM auto_aliases")
+	for source, destination in aliases.items():
+		c.execute(
+			"INSERT INTO auto_aliases (source, destination) VALUES (?, ?)",
+			(source, destination))
+	conn.commit()
+
+
 def get_system_administrator(env):
 	return "administrator@" + env['PRIMARY_HOSTNAME']
 
+
 def get_required_aliases(env):
 	# These are the aliases that must exist.
 	aliases = set()
@@ -519,13 +772,11 @@ def get_required_aliases(env):
 
 	# Get a list of domains we serve mail for, except ones for which the only
 	# email on that domain are the required aliases or a catch-all/domain-forwarder.
-	real_mail_domains = get_mail_domains(env,
-		filter_aliases = lambda alias :
-			not alias.startswith("postmaster@")
-			and not alias.startswith("admin@")
-			and not alias.startswith("abuse@")
-			and not alias.startswith("@")
-			)
+	real_mail_domains = get_mail_domains(
+		env,
+		filter_aliases=lambda alias: not alias.startswith("postmaster@") and
+		not alias.startswith("admin@") and not alias.startswith(
+			"abuse@") and not alias.startswith("@"))
 
 	# Create postmaster@, admin@ and abuse@ for all domains we serve
 	# mail on. postmaster@ is assumed to exist by our Postfix configuration.
@@ -539,6 +790,57 @@ def get_required_aliases(env):
 
 	return aliases
 
+
+def add_noreply_address(env, address, do_kick=True):
+	email = sanitize_idn_email_address(address)
+	# validate email
+	if email.strip() == "":
+		return ("No email address provided.", 400)
+	elif not validate_email(email):
+		return ("Invalid email address.", 400)
+
+	# Make sure it's not an user/alias already
+	if email in get_mail_users(env):
+		return ("This address is already an user.", 400)
+	elif email in get_mail_aliases(env):
+		return ("This address is already an alias.", 400)
+
+	ret = ""
+
+	# Add the address
+	conn, c = open_database(env, with_connection=True)
+	try:
+		c.execute("INSERT INTO noreply (email) VALUES (?)", (email, ))
+		if do_kick:
+			ret = kick(env, "No-reply address (%s) added" % address)
+		else:
+			ret = "No-reply address (%s) added" % address
+	except sqlite3.IntegrityError:
+		return ("This noreply (%s) already exists." % address, 400)
+
+	conn.commit()
+	return ret
+
+
+def remove_noreply_address(env, address, do_kick=True):
+	email = sanitize_idn_email_address(address)
+
+	# yeet yeet deleet
+	conn, c = open_database(env, with_connection=True)
+	c.execute("DELETE FROM noreply WHERE email=?", (email, ))
+	if c.rowcount != 1:
+		return ("That's not a noreply (%s)." % address, 400)
+	conn.commit()
+
+	if do_kick:
+		# Update things in case any domains are removed.
+		return kick(env, "No-reply address removed")
+
+
+def get_required_noreply_addresses(env):
+	return {"noreply-daemon@" + env['PRIMARY_HOSTNAME']}
+
+
 def kick(env, mail_result=None):
 	results = []
 
@@ -547,58 +849,61 @@ def kick(env, mail_result=None):
 	if mail_result is not None:
 		results.append(mail_result + "\n")
 
-	# Ensure every required alias exists.
+	auto_aliases = {}
 
-	existing_users = get_mail_users(env)
-	existing_alias_records = get_mail_aliases(env)
-	existing_aliases = set(a for a, *_ in existing_alias_records) # just first entry in tuple
+	# Mape required aliases to the administrator alias (which should be created manually).
+	administrator = get_system_administrator(env)
 	required_aliases = get_required_aliases(env)
+	required_noreply = get_required_noreply_addresses(env)
+	existing_noreply = get_noreply_addresses(env)
+	for alias in required_aliases:
+		if alias == administrator:
+			continue  # don't make an alias from the administrator to itself --- this alias must be created manually
+		auto_aliases[alias] = administrator
 
-	def ensure_admin_alias_exists(address):
-		# If a user account exists with that address, we're good.
-		if address in existing_users:
-			return
+	# Add domain maps from Unicode forms of IDNA domains to the ASCII forms stored in the alias table.
+	for domain in get_mail_domains(env):
+		try:
+			domain_unicode = idna.decode(domain.encode("ascii"))
+			if domain == domain_unicode:
+				continue  # not an IDNA/Unicode domain
+			auto_aliases["@" + domain_unicode] = "@" + domain
+		except (ValueError, UnicodeError, idna.IDNAError):
+			continue
 
-		# If the alias already exists, we're good.
-		if address in existing_aliases:
-			return
+	add_auto_aliases(auto_aliases, env)
+	for address in required_noreply - existing_noreply:
+		add_noreply_address(env, address, do_kick=False)
+		results.append("added noreply address \"%s\"\n" % address)
 
-		# Doesn't exist.
-		administrator = get_system_administrator(env)
-		if address == administrator: return # don't make an alias from the administrator to itself --- this alias must be created manually
-		add_mail_alias(address, administrator, "", env, do_kick=False)
-		if administrator not in existing_aliases: return # don't report the alias in output if the administrator alias isn't in yet -- this is a hack to supress confusing output on initial setup
-		results.append("added alias %s (=> %s)\n" % (address, administrator))
-
-	for address in required_aliases:
-		ensure_admin_alias_exists(address)
-
-	# Remove auto-generated postmaster/admin on domains we no
-	# longer have any other email addresses for.
-	for address, forwards_to, *_ in existing_alias_records:
+	# Remove auto-generated postmaster/admin/abuse alises from the main aliases table.
+	# They are now stored in the auto_aliases table.
+	for address, forwards_to, permitted_senders, auto in get_mail_aliases(env):
 		user, domain = address.split("@")
 		if user in ("postmaster", "admin", "abuse") \
-			and address not in required_aliases \
-			and forwards_to == get_system_administrator(env):
+							and address not in required_aliases \
+							and forwards_to == get_system_administrator(env) \
+							and not auto:
 			remove_mail_alias(address, env, do_kick=False)
-			results.append("removed alias %s (was to %s; domain no longer used for email)\n" % (address, forwards_to))
+			results.append(
+				"removed alias %s (was to %s; domain no longer used for email)\n"
+				% (address, forwards_to))
 
 	# Update DNS and nginx in case any domains are added/removed.
 
 	from dns_update import do_dns_update
-	results.append( do_dns_update(env) )
+	results.append(do_dns_update(env))
 
 	from web_update import do_web_update
-	results.append( do_web_update(env) )
+	results.append(do_web_update(env))
 
 	return "".join(s for s in results if s != "")
 
+
 def validate_password(pw):
 	# validate password
 	if pw.strip() == "":
 		raise ValueError("No password provided.")
-	if re.search(r"[\s]", pw):
-		raise ValueError("Passwords cannot contain spaces.")
 	if len(pw) < 8:
 		raise ValueError("Passwords must be at least eight characters.")
 

management/mfa.py

@@ -0,0 +1,158 @@
+import base64
+import hmac
+import io
+import os
+import pyotp
+import qrcode
+
+from mailconfig import open_database
+
+
+def get_user_id(email, c):
+	c.execute('SELECT id FROM users WHERE email=?', (email, ))
+	r = c.fetchone()
+	if not r:
+		raise ValueError("User does not exist.")
+	return r[0]
+
+
+def get_mfa_state(email, env):
+	c = open_database(env)
+	c.execute(
+		'SELECT id, type, secret, mru_token, label FROM mfa WHERE user_id=?',
+		(get_user_id(email, c), ))
+	return [{
+		"id": r[0],
+		"type": r[1],
+		"secret": r[2],
+		"mru_token": r[3],
+		"label": r[4]
+	} for r in c.fetchall()]
+
+
+def get_public_mfa_state(email, env):
+	mfa_state = get_mfa_state(email, env)
+	return [{
+		"id": s["id"],
+		"type": s["type"],
+		"label": s["label"]
+	} for s in mfa_state]
+
+
+def get_hash_mfa_state(email, env):
+	mfa_state = get_mfa_state(email, env)
+	return [{
+		"id": s["id"],
+		"type": s["type"],
+		"secret": s["secret"]
+	} for s in mfa_state]
+
+
+def enable_mfa(email, type, secret, token, label, env):
+	if type == "totp":
+		validate_totp_secret(secret)
+		# Sanity check with the provide current token.
+		totp = pyotp.TOTP(secret)
+		if not totp.verify(token, valid_window=1):
+			raise ValueError("Invalid token.")
+	else:
+		raise ValueError("Invalid MFA type.")
+
+	conn, c = open_database(env, with_connection=True)
+	c.execute(
+		'INSERT INTO mfa (user_id, type, secret, label) VALUES (?, ?, ?, ?)',
+		(get_user_id(email, c), type, secret, label))
+	conn.commit()
+
+
+def set_mru_token(email, mfa_id, token, env):
+	conn, c = open_database(env, with_connection=True)
+	c.execute('UPDATE mfa SET mru_token=? WHERE user_id=? AND id=?',
+			(token, get_user_id(email, c), mfa_id))
+	conn.commit()
+
+
+def disable_mfa(email, mfa_id, env):
+	conn, c = open_database(env, with_connection=True)
+	if mfa_id is None:
+		# Disable all MFA for a user.
+		c.execute('DELETE FROM mfa WHERE user_id=?', (get_user_id(email, c), ))
+	else:
+		# Disable a particular MFA mode for a user.
+		c.execute('DELETE FROM mfa WHERE user_id=? AND id=?',
+				(get_user_id(email, c), mfa_id))
+	conn.commit()
+	return c.rowcount > 0
+
+
+def validate_totp_secret(secret):
+	if type(secret) != str or secret.strip() == "":
+		raise ValueError("No secret provided.")
+	if len(secret) != 32:
+		raise ValueError("Secret should be a 32 characters base32 string")
+
+
+def provision_totp(email, env):
+	# Make a new secret.
+	secret = base64.b32encode(os.urandom(20)).decode('utf-8')
+	validate_totp_secret(secret)  # sanity check
+
+	# Make a URI that we encode within a QR code.
+	uri = pyotp.TOTP(secret).provisioning_uri(
+		name=email,
+		issuer_name=env["PRIMARY_HOSTNAME"] + " Mail-in-a-Box Control Panel")
+
+	# Generate a QR code as a base64-encode PNG image.
+	qr = qrcode.make(uri)
+	byte_arr = io.BytesIO()
+	qr.save(byte_arr, format='PNG')
+	png_b64 = base64.b64encode(byte_arr.getvalue()).decode('utf-8')
+
+	return {"type": "totp", "secret": secret, "qr_code_base64": png_b64}
+
+
+def validate_auth_mfa(email, request, env):
+	# Validates that a login request satisfies any MFA modes
+	# that have been enabled for the user's account. Returns
+	# a tuple (status, [hints]). status is True for a successful
+	# MFA login, False for a missing token. If status is False,
+	# hints is an array of codes that indicate what the user
+	# can try. Possible codes are:
+	# "missing-totp-token"
+	# "invalid-totp-token"
+
+	mfa_state = get_mfa_state(email, env)
+
+	# If no MFA modes are added, return True.
+	if len(mfa_state) == 0:
+		return (True, [])
+
+	# Try the enabled MFA modes.
+	hints = set()
+	for mfa_mode in mfa_state:
+		if mfa_mode["type"] == "totp":
+			# Check that a token is present in the X-Auth-Token header.
+			# If not, give a hint that one can be supplied.
+			token = request.headers.get('x-auth-token')
+			if not token:
+				hints.add("missing-totp-token")
+				continue
+
+			# Check for a replay attack.
+			if hmac.compare_digest(token, mfa_mode['mru_token'] or ""):
+				# If the token fails, skip this MFA mode.
+				hints.add("invalid-totp-token")
+				continue
+
+			# Check the token.
+			totp = pyotp.TOTP(mfa_mode["secret"])
+			if not totp.verify(token, valid_window=1):
+				hints.add("invalid-totp-token")
+				continue
+
+			# On success, record the token to prevent a replay attack.
+			set_mru_token(email, mfa_mode['id'], token, env)
+			return (True, [])
+
+	# On a failed login, indicate failure and any hints for what the user can do instead.
+	return (False, list(hints))

management/munin_start.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+mkdir -p /var/run/munin && chown munin /var/run/munin

management/pgp.py

@@ -0,0 +1,178 @@
+#!/usr/local/lib/mailinabox/env/bin/python
+# Tools to manipulate PGP keys
+
+import gpg
+import utils
+import datetime
+import shutil
+import tempfile
+
+env = utils.load_environment()
+
+# Import daemon's keyring - usually in /home/user-data/.gnupg/
+gpghome = env['GNUPGHOME']
+daemon_key_fpr = env['PGPKEY']
+default_context = gpg.Context(armor=True, home_dir=gpghome)
+
+# Auxiliary function to process the key in order to be read more conveniently
+
+
+def key_representation(key):
+	if key is None:
+		return None
+	key_rep = {
+		"master_fpr": key.fpr,
+		"revoked": key.revoked != 0,
+		"ids": [],
+		"ids_emails": {},
+		"subkeys": []
+	}
+
+	now = datetime.datetime.utcnow()
+	key_rep["ids"] = [id.uid for id in key.uids]
+	# No duplicate email addresses in this list
+	key_rep["ids_emails"] = list({id.email for id in key.uids})
+	key_rep["subkeys"] = [{
+		"master":
+		skey.fpr == key.fpr,
+		"sign":
+		skey.can_sign == 1,
+		"cert":
+		skey.can_certify == 1,
+		"encr":
+		skey.can_encrypt == 1,
+		"auth":
+		skey.can_authenticate == 1,
+		"fpr":
+		skey.fpr,
+		"expires":
+		skey.expires if skey.expires != 0 else None,
+		"expires_date":
+		datetime.datetime.utcfromtimestamp(skey.expires).date().isoformat()
+		if skey.expires != 0 else None,
+		"expires_days": (datetime.datetime.utcfromtimestamp(skey.expires) -
+						now).days if skey.expires != 0 else None,
+		"expired":
+		skey.expired == 1,
+		"algorithm":
+		gpg.core.pubkey_algo_name(skey.pubkey_algo),
+		"bits":
+		skey.length
+	} for skey in key.subkeys]
+
+	return key_rep
+
+
+# Tests an import as for whether we have any sort of private key material in our import
+
+
+def contains_private_keys(imports):
+	with tempfile.TemporaryDirectory() as tmpdir:
+		with gpg.Context(home_dir=tmpdir, armor=True) as tmp:
+			result = tmp.key_import(imports)
+			try:
+				return result.secret_read != 0
+			except AttributeError:
+				raise ValueError("Import is not a valid PGP key block!")
+
+
+# Decorator: Copies the homedir of a context onto a temporary directory and returns a context operating over that tmpdir
+
+
+def fork_context(f, context=default_context):
+	from os.path import isdir, isfile
+
+	def dirs_files_only(current_dir, files):
+		ignore = []
+		for f in files:
+			path = f"{current_dir}{f}"
+			if not isdir(path) and not isfile(path):
+				ignore.append(f)
+		return ignore
+
+	def wrapped(*args, **kwargs):
+		with tempfile.TemporaryDirectory() as tmpdir:
+			shutil.copytree(context.home_dir,
+							f"{tmpdir}/gnupg",
+							ignore=dirs_files_only)
+			kwargs["context"] = gpg.Context(armor=context.armor,
+											home_dir=f"{tmpdir}/gnupg")
+			kwargs["buffer"] = gpg.Data()
+			return f(*args, **kwargs)
+
+	return wrapped
+
+
+def get_key(fingerprint, context=default_context):
+	try:
+		return context.get_key(fingerprint, secret=False)
+	except KeyError:
+		return None
+	except gpg.errors.GPGMEError:
+		return None
+
+
+def get_daemon_key(context=default_context):
+	if daemon_key_fpr is None or daemon_key_fpr == "":
+		return None
+	return context.get_key(daemon_key_fpr, secret=True)
+
+
+def get_imported_keys(context=default_context):
+	# All the keys in the keyring, except for the daemon's key
+	return list(
+		filter(lambda k: k.fpr != daemon_key_fpr,
+			context.keylist(secret=False)))
+
+
+def import_key(key, context=default_context):
+	data = str.encode(key)
+	if contains_private_keys(data):
+		raise ValueError("Import cannot contain private keys!")
+	return context.key_import(data)
+
+
+def export_key(fingerprint, context=default_context):
+	if get_key(fingerprint) is None:
+		return None
+	# Key does exist, export it!
+	return context.key_export(pattern=fingerprint)
+
+
+def delete_key(fingerprint, context=default_context):
+	key = get_key(fingerprint)
+	if fingerprint == daemon_key_fpr:
+		raise ValueError("You cannot delete the daemon's key!")
+	elif key is None:
+		return None
+	context.op_delete_ext(
+		key, gpg.constants.DELETE_ALLOW_SECRET | gpg.constants.DELETE_FORCE)
+	return True
+
+
+# Key usage
+
+# Uses the daemon key to sign the provided message. If 'detached' is True, only the signature will be returned
+
+
+def create_signature(data, detached=False, context=default_context):
+	signed_data, _ = context.sign(data,
+								mode=gpg.constants.sig.mode.DETACH if
+								detached else gpg.constants.sig.mode.CLEAR)
+	return signed_data
+
+
+if __name__ == "__main__":
+	import sys
+	import utils
+	# Check if we should renew the key
+
+	daemon_key = get_daemon_key()
+
+	exp = daemon_key.subkeys[0].expires
+	now = datetime.datetime.utcnow()
+	days_left = (datetime.datetime.utcfromtimestamp(exp) - now).days
+	if days_left > 14:
+		sys.exit(0)
+	else:
+		utils.shell("check_output", ["management/pgp_renew.sh"])

management/pgp_renew.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+# Renews the daemon's PGP key, if needed.
+
+source /etc/mailinabox.conf # load global vars
+export GNUPGHOME # Dump into the environment so that gpg uses it as homedir
+
+gpg --batch --command-fd=0 --edit-key "${PGPKEY-}" << EOF;
+key 0
+expire
+180d
+save
+EOF

management/templates/aliases.html

@@ -1,114 +1,149 @@
 <style>
-#alias_table .actions > * { padding-right: 3px; }
-#alias_table .alias-required .remove { display: none }
+	#alias_table .alias-auto .actions>* {
+		display: none
+	}
+
+	#addalias-form .hidden {
+		display: none;
+	}
+
+	.btn.btn-xs {
+		padding: .1rem .3rem;
+		font-size: .75rem;
+		border-radius: .2rem;
+	}
 </style>
 
 <h2>Aliases</h2>
 
 <h3>Add a mail alias</h3>
 
-<p>Aliases are email forwarders. An alias can forward email to a <a href="#" onclick="return show_panel('users')">mail user</a> or to any email address.</p>
+<p>Aliases are email forwarders. An alias can forward email to a <a href="#" onclick="return show_panel('users')">mail
+		user</a> or to any email address.</p>
 
-<p>To use an alias or any address besides your own login username in outbound mail, the sending user must be included as a permitted sender for the alias.</p>
+<p>To use an alias or any address besides your own login username in outbound mail, the sending user must be included as
+	a permitted sender for the alias.</p>
 
 <form id="addalias-form" class="form-horizontal" role="form" onsubmit="do_add_alias(); return false;">
-  <div class="form-group">
-    <div class="col-sm-offset-1 col-sm-11">
-      <div id="alias_type_buttons" class="btn-group btn-group-xs">
-        <button type="button" class="btn btn-default" data-mode="regular">Regular</button>
-        <button type="button" class="btn btn-default" data-mode="catchall">Catch-All</button>
-        <button type="button" class="btn btn-default" data-mode="domainalias">Domain Alias</button>
-      </div>
-      <div id="alias_mode_info" class="text-info small" style="display: none; margin: .5em 0 0 0;">
-        <span class="catchall hidden">A catch-all alias captures all otherwise unmatched email to a domain.</span>
-        <span class="domainalias hidden">A domain alias forwards all otherwise unmatched email from one domain to another domain, preserving the part before the @-sign.</span>
-      </div>
-    </div>
-  </div>
-  <div class="form-group">
-    <label for="addaliasAddress" class="col-sm-1 control-label">Alias</label>
-    <div class="col-sm-10">
-      <input type="email" class="form-control" id="addaliasAddress">
-      <div style="margin-top: 3px; padding-left: 3px; font-size: 90%" class="text-muted">
-        <span class="catchall domainalias">Enter just the part of an email address starting with the @-sign.</span>
-        You may use international (non-ASCII) characters for the domain part of the email address only.
-      </div>
-    </div>
-  </div>
-  <div class="form-group">
-    <label for="addaliasForwardsTo" class="col-sm-1 control-label">Forwards To</label>
-    <div class="col-sm-10">
-      <textarea class="form-control" rows="3" id="addaliasForwardsTo"></textarea>
-      <div style="margin-top: 3px; padding-left: 3px; font-size: 90%" class="text-muted">
-        <span class="domainalias">Enter just the part of an email address starting with the @-sign.</span>
-      </div>
-    </div>
-  </div>
-  <div class="form-group">
-    <label for="addaliasSenders" class="col-sm-1 control-label">Permitted Senders</label>
-    <div class="col-sm-10">
-      <div class="radio">
-        <label>
-          <input id="addaliasForwardsToNotAdvanced" name="addaliasForwardsToDivToggle" type="radio" checked onclick="$('#addaliasForwardsToDiv').toggle(false)">
-          Any mail user listed in the Fowards To box can send mail claiming to be from <span class="regularalias">the alias address</span><span class="catchall domainalias">any address on the alias domain</span>.
-        </label>
-      </div>
-      <div class="radio">
-        <label>
-          <input id="addaliasForwardsToAdvanced" name="addaliasForwardsToDivToggle" type="radio" id="addaliasForwardsToDivShower" onclick="$('#addaliasForwardsToDiv').toggle(true)">
-          I&rsquo;ll enter the mail users that can send mail claiming to be from <span class="regularalias">the alias address</span><span class="catchall domainalias">any address on the alias domain</span>.
-        </label>
-      </div>
-      <div id="addaliasForwardsToDiv" style="margin-top: .5em; margin-left: 1.4em; display: none;">
-        <textarea class="form-control" rows="3" id="addaliasSenders" placeholder="one user per line or separated by commas"></textarea>
-      </div>
-    </div>
-  </div>
-  <div class="form-group">
-    <div class="col-sm-offset-1 col-sm-11">
-      <button id="add-alias-button" type="submit" class="btn btn-primary">Add Alias</button>
-      <button id="alias-cancel" class="btn btn-default hidden" onclick="aliases_reset_form(); return false;">Cancel</button>
-    </div>
-  </div>
+
+	<div class="mb-3">
+		<div id="alias_type_buttons" class="btn-group btn-group-xs">
+			<button type="button" class="btn btn-secondary" data-mode="regular">Regular</button>
+			<button type="button" class="btn btn-secondary" data-mode="catchall">Catch-All</button>
+			<button type="button" class="btn btn-secondary" data-mode="domainalias">Domain Alias</button>
+		</div>
+		<div id="alias_mode_info" class="text-info small" style="display: none; margin: .5em 0 0 0;">
+			<span class="catchall hidden">A catch-all alias captures all otherwise unmatched email to a domain.</span>
+			<span class="domainalias hidden">A domain alias forwards all otherwise unmatched email from one domain to
+				another domain, preserving the part before the @-sign.</span>
+		</div>
+	</div>
+
+	<div class="col-lg-9 mb-3">
+		<div class="input-group">
+			<label for="addaliasAddress" class="input-group-text">Alias</label>
+			<input type="email" class="form-control" id="addaliasAddress">
+		</div>
+		<div style="margin-top: 3px; padding-left: 3px; font-size: 90%" class="text-muted ">
+			<span class="catchall domainalias">Enter just the part of an email address starting with the @-sign.</span>
+			You may use international (non-ASCII) characters for the domain part of the email address only.
+		</div>
+	</div>
+
+	<div class="col-lg-9 mb-3">
+		<div class="form-floating">
+			<textarea class="form-control" style="min-height: 8em;" id="addaliasForwardsTo"></textarea>
+			<label for="addaliasForwardsTo">Forwards To</label>
+		</div>
+		<div style="margin-top: 3px; padding-left: 3px; font-size: 90%">
+			<span class="domainalias text-muted">Enter just the part of an email address starting with the
+				@-sign.</span>
+			<span class="text-danger">Only forward mail to addresses handled by this Mail-in-a-Box, since mail forwarded
+				by aliases to other domains may be rejected or filtered by the receiver. To forward mail to other
+				domains, create a mail user and then log into webmail for the user and create a filter rule to forward
+				mail.</span>
+		</div>
+	</div>
+
+	<h4>Permitted Senders</h4>
+
+	<div class="col-lg-9 mb-3">
+		<div class="mb-3">
+			<div class="mb-3">
+				<div class="radio">
+					<label>
+						<input id="addaliasForwardsToNotAdvanced" name="addaliasForwardsToDivToggle" type="radio"
+							checked onclick="$('#addaliasForwardsToDiv').toggle(false)">
+						Any mail user listed in the Forwards To box can send mail claiming to be from <span
+							class="regularalias">the alias address</span><span class="catchall domainalias">any address
+							on the alias domain</span>.
+					</label>
+				</div>
+				<div class="radio">
+					<label>
+						<input id="addaliasForwardsToAdvanced" name="addaliasForwardsToDivToggle" type="radio"
+							id="addaliasForwardsToDivShower" onclick="$('#addaliasForwardsToDiv').toggle(true)">
+						I&rsquo;ll enter the mail users that can send mail claiming to be from <span
+							class="regularalias">the alias address</span><span class="catchall domainalias">any address
+							on the alias domain</span>.
+					</label>
+				</div>
+			</div>
+			<div id="addaliasForwardsToDiv" style="display: none;">
+				<div class="form-floating">
+					<textarea class="form-control" style="min-height: 8em;" id="addaliasSenders"
+						placeholder="one user per line or separated by commas"></textarea>
+					<label for="addaliasSenders">Permitted Senders</label>
+				</div>
+				<small>One user per line or separated by commas</small>
+			</div>
+		</div>
+	</div>
+	<button id="add-alias-button" type="submit" class="btn btn-primary">Add Alias</button>
 </form>
 
 <h3>Existing mail aliases</h3>
-<table id="alias_table" class="table" style="width: auto">
-  <thead>
-    <tr>
-      <th></th>
-      <th>Alias<br></th>
-      <th>Forwards To</th>
-      <th>Permitted Senders</th>
-    </tr>
-  </thead>
-  <tbody>
-  </tbody>
+<table id="alias_table" class="table">
+	<caption></caption>
+	<thead>
+		<tr>
+			<th></th>
+			<th>Alias<br></th>
+			<th>Forwards To</th>
+			<th>Permitted Senders</th>
+		</tr>
+	</thead>
+	<tbody>
+	</tbody>
 </table>
 
-<p style="margin-top: 1.5em"><small>hostmaster@, postmaster@, admin@ and abuse@ email addresses are required on some domains.</small></p>
+<p style="margin-top: 1.5em"><small>hostmaster@, postmaster@, admin@ and abuse@ email addresses are required on some
+		domains.</small></p>
 
 <div style="display: none">
-  <table>
-  <tr id="alias-template">
-    <td class='actions'>
-        <a href="#" onclick="aliases_edit(this); scroll_top(); return false;" class='edit' title="Edit Alias">
-          <span class="glyphicon glyphicon-pencil"></span>
-        </a>
-        <a href="#" onclick="aliases_remove(this); return false;" class='remove' title="Remove Alias">
-          <span class="glyphicon glyphicon-trash"></span>
-        </a>
-    </td>
-    <td class='address'> </td>
-    <td class='forwardsTo'> </td>
-    <td class='senders'> </td>
-  </tr>
-  </table>
+	<table>
+		<tr id="alias-template">
+			<td class='actions row justify-content-evenly' style="min-width: 4em; border: none;">
+				<button class="col-5 btn btn-xs btn-default" onclick="aliases_edit(this); scroll_top(); return false;"
+					class='edit' title="Edit Alias">
+					<span class="text-center text-primary fas fa-pen"></span>
+				</button>
+				<button class="col-5 btn btn-xs btn-default" onclick="aliases_remove(this); return false;"
+					class='remove' title="Remove Alias">
+					<span class="text-center text-danger fas fa-trash"></span>
+				</button>
+			</td>
+			<td class='address'> </td>
+			<td class='forwardsTo'> </td>
+			<td class='senders'> </td>
+		</tr>
+	</table>
 </div>
 
 <h3>Mail aliases API (advanced)</h3>
 
-<p>Use your box&rsquo;s mail aliases API to add and remove mail aliases from the command-line or custom services you build.</p>
+<p>Use your box&rsquo;s mail aliases API to add and remove mail aliases from the command-line or custom services you
+	build.</p>
 
 <p>Usage:</p>
 
@@ -121,15 +156,35 @@
 <h4 style="margin-bottom: 0">Verbs</h4>
 
 <table class="table" style="margin-top: .5em">
-<thead><th>Verb</th> <th>Action</th><th></th></thead>
-<tr><td>GET</td><td><i>(none)</i></td> <td>Returns a list of existing mail aliases. Adding <code>?format=json</code> to the URL will give JSON-encoded results.</td></tr>
-<tr><td>POST</td><td>/add</td> <td>Adds a new mail alias. Required POST-body parameters are <code>address</code> and <code>forwards_to</code>.</td></tr>
-<tr><td>POST</td><td>/remove</td> <td>Removes a mail alias. Required POST-body parameter is <code>address</code>.</td></tr>
+	<caption></caption>
+	<thead>
+		<th>Verb</th>
+		<th>Action</th>
+		<th></th>
+	</thead>
+	<tr>
+		<td><b>GET</b></td>
+		<td><i>(none)</i></td>
+		<td>Returns a list of existing mail aliases. Adding <code>?format=json</code> to the URL will give JSON-encoded
+			results.</td>
+	</tr>
+	<tr>
+		<td><b>POST</b></td>
+		<td class="font-monospace">/add</td>
+		<td>Adds a new mail alias. Required POST-body parameters are <code>address</code> and <code>forwards_to</code>.
+		</td>
+	</tr>
+	<tr>
+		<td><b>POST</b></td>
+		<td class="font-monospace">/remove</td>
+		<td>Removes a mail alias. Required POST-body parameter is <code>address</code>.</td>
+	</tr>
 </table>
 
 <h4>Examples:</h4>
 
-<p>Try these examples. For simplicity the examples omit the <code>--user me@mydomain.com:yourpassword</code> command line argument which you must fill in with your email address and password.</p>
+<p>Try these examples. For simplicity the examples omit the <code>--user me@mydomain.com:yourpassword</code> command
+	line argument which you must fill in with your email address and password.</p>
 
 <pre># Gives a JSON-encoded list of all mail aliases
 curl -X GET https://{{hostname}}/admin/mail/aliases?format=json
@@ -143,159 +198,157 @@ curl -X POST -d "address=new_alias@mydomail.com" https://{{hostname}}/admin/mail
 
 
 <script>
-function show_aliases() {
-  $('#alias_table tbody').html("<tr><td colspan='2' class='text-muted'>Loading...</td></tr>")
-  api(
-    "/mail/aliases",
-    "GET",
-    { format: 'json' },
-    function(r) {
-      $('#alias_table tbody').html("");
-      for (var i = 0; i < r.length; i++) {
-        var hdr = $("<tr><td colspan='3'><h4/></td></tr>");
-        hdr.find('h4').text(r[i].domain);
-        $('#alias_table tbody').append(hdr);
+	function show_aliases() {
+		$('#alias_table tbody').html("<tr><td colspan='2' class='text-muted'>Loading...</td></tr>")
+		api(
+			"/mail/aliases",
+			"GET",
+			{ format: 'json' },
+			function (r) {
+				$('#alias_table tbody').html("");
+				for (var i = 0; i < r.length; i++) {
+					var hdr = $("<tr><th colspan='4' class='bg-light'></th></tr>");
+					hdr.find('th').text(r[i].domain);
+					$('#alias_table tbody').append(hdr);
 
-        for (var k = 0; k < r[i].aliases.length; k++) {
-          var alias = r[i].aliases[k];
+					for (var k = 0; k < r[i].aliases.length; k++) {
+						var alias = r[i].aliases[k];
 
-          var n = $("#alias-template").clone();
-          n.attr('id', '');
+						var n = $("#alias-template").clone();
+						n.attr('id', '');
 
-          if (alias.required) n.addClass('alias-required');
-          n.attr('data-address', alias.address_display); // this is decoded from IDNA, but will get re-coded to IDNA on the backend
-          n.find('td.address').text(alias.address_display)
-          for (var j = 0; j < alias.forwards_to.length; j++)
-            n.find('td.forwardsTo').append($("<div></div>").text(alias.forwards_to[j]))
-          for (var j = 0; j < (alias.permitted_senders ? alias.permitted_senders.length : 0); j++)
-            n.find('td.senders').append($("<div></div>").text(alias.permitted_senders[j]))
-          $('#alias_table tbody').append(n);
-        }
-      }
-    })
+						if (alias.auto) n.addClass('alias-auto');
+						n.attr('data-address', alias.address_display); // this is decoded from IDNA, but will get re-coded to IDNA on the backend
+						n.find('td.address').text(alias.address_display)
+						for (var j = 0; j < alias.forwards_to.length; j++)
+							n.find('td.forwardsTo').append($("<div></div>").text(alias.forwards_to[j]))
+						for (var j = 0; j < (alias.permitted_senders ? alias.permitted_senders.length : 0); j++)
+							n.find('td.senders').append($("<div></div>").text(alias.permitted_senders[j]))
+						$('#alias_table tbody').append(n);
+					}
+				}
+			})
 
-  $(function() {
-    $('#alias_type_buttons button').off('click').click(function() {
-      $('#alias_type_buttons button').removeClass('active');
-      $(this).addClass('active');
-      $('#addalias-form .regularalias, #addalias-form .catchall, #addalias-form .domainalias').addClass('hidden');
-      if ($(this).attr('data-mode') == "regular") {
-        $('#addaliasAddress').attr('type', 'email');
-        $('#addaliasAddress').attr('placeholder', 'you@yourdomain.com (incoming email address)');
-        $('#addaliasForwardsTo').attr('placeholder', 'one address per line or separated by commas');
-        $('#alias_mode_info').slideUp();
-        $('#addalias-form .regularalias').removeClass('hidden');
-      } else if ($(this).attr('data-mode') == "catchall") {
-        $('#addaliasAddress').attr('type', 'text');
-        $('#addaliasAddress').attr('placeholder', '@yourdomain.com (incoming catch-all domain)');
-        $('#addaliasForwardsTo').attr('placeholder', 'one address per line or separated by commas');
-        $('#alias_mode_info').slideDown();
-        $('#addalias-form .catchall').removeClass('hidden');
-      } else if ($(this).attr('data-mode') == "domainalias") {
-        $('#addaliasAddress').attr('type', 'text');
-        $('#addaliasAddress').attr('placeholder', '@yourdomain.com (incoming catch-all domain)');
-        $('#addaliasForwardsTo').attr('placeholder', '@otherdomain.com (forward to other domain)');
-        $('#alias_mode_info').slideDown();
-        $('#addalias-form .domainalias').removeClass('hidden');
-      }
-    })
-    $('#alias_type_buttons button[data-mode="regular"]').click(); // init
-  })
-}
+		$('#alias_type_buttons button').off('click').click(function () {
+			$('#alias_type_buttons button').removeClass('active');
+			$(this).addClass('active');
+			$('#addalias-form .regularalias, #addalias-form .catchall, #addalias-form .domainalias').addClass('hidden');
+			if ($(this).attr('data-mode') == "regular") {
+				$('#addaliasAddress').attr('type', 'email');
+				$('#addaliasAddress').attr('placeholder', 'you@example.com (incoming email address)');
+				$('#addaliasForwardsTo').attr('placeholder', 'one address per line or separated by commas');
+				$('#alias_mode_info').slideUp();
+				$('#addalias-form .regularalias').removeClass('hidden');
+			} else if ($(this).attr('data-mode') == "catchall") {
+				$('#addaliasAddress').attr('type', 'text');
+				$('#addaliasAddress').attr('placeholder', '@example.com (incoming catch-all domain)');
+				$('#addaliasForwardsTo').attr('placeholder', 'one address per line or separated by commas');
+				$('#alias_mode_info').slideDown();
+				$('#addalias-form .catchall').removeClass('hidden');
+			} else if ($(this).attr('data-mode') == "domainalias") {
+				$('#addaliasAddress').attr('type', 'text');
+				$('#addaliasAddress').attr('placeholder', '@example.com (incoming catch-all domain)');
+				$('#addaliasForwardsTo').attr('placeholder', '@example.net (forward to other domain)');
+				$('#alias_mode_info').slideDown();
+				$('#addalias-form .domainalias').removeClass('hidden');
+			}
+		})
+		$('#alias_type_buttons button[data-mode="regular"]').click(); // init
+	}
 
-var is_alias_add_update = false;
-function do_add_alias() {
-  var title = (!is_alias_add_update) ? "Add Alias" : "Update Alias";
-  var form_address = $("#addaliasAddress").val();
-  var form_forwardsto = $("#addaliasForwardsTo").val();
-  var form_senders = ($('#addaliasForwardsToAdvanced').prop('checked') ? $("#addaliasSenders").val() : '');
-  if ($('#addaliasForwardsToAdvanced').prop('checked') && !/\S/.exec($("#addaliasSenders").val())) {
-    show_modal_error(title, "You did not enter any permitted senders.");
-    return false;
-  }
-  api(
-    "/mail/aliases/add",
-    "POST",
-    {
-      update_if_exists: is_alias_add_update ? '1' : '0',
-      address: form_address,
-      forwards_to: form_forwardsto,
-      permitted_senders: form_senders
-    },
-    function(r) {
-      // Responses are multiple lines of pre-formatted text.
-      show_modal_error(title, $("<pre/>").text(r));
-      show_aliases()
-      aliases_reset_form();
-    },
-    function(r) {
-      show_modal_error(title, r);
-    });
-  return false;
-}
+	var is_alias_add_update = false;
+	function do_add_alias() {
+		var title = (!is_alias_add_update) ? "Add Alias" : "Update Alias";
+		var form_address = $("#addaliasAddress").val();
+		var form_forwardsto = $("#addaliasForwardsTo").val();
+		var form_senders = ($('#addaliasForwardsToAdvanced').prop('checked') ? $("#addaliasSenders").val() : '');
+		if ($('#addaliasForwardsToAdvanced').prop('checked') && !/\S/.exec($("#addaliasSenders").val())) {
+			show_modal_error(title, "You did not enter any permitted senders.");
+			return false;
+		}
+		api(
+			"/mail/aliases/add",
+			"POST",
+			{
+				update_if_exists: is_alias_add_update ? '1' : '0',
+				address: form_address,
+				forwards_to: form_forwardsto,
+				permitted_senders: form_senders
+			},
+			function (r) {
+				// Responses are multiple lines of pre-formatted text.
+				show_modal_error(title, $("<pre/>").text(r));
+				show_aliases()
+				aliases_reset_form();
+			},
+			function (r) {
+				show_modal_error(title, r);
+			});
+		return false;
+	}
 
-function aliases_reset_form() {
-  $("#addaliasAddress").prop('disabled', false);
-  $("#addaliasAddress").val('')
-  $("#addaliasForwardsTo").val('')
-  $("#addaliasSenders").val('')
-  $('#alias-cancel').addClass('hidden');
-  $('#add-alias-button').text('Add Alias');
-  is_alias_add_update = false;
-}
+	function aliases_reset_form() {
+		$("#addaliasAddress").prop('disabled', false);
+		$("#addaliasAddress").val('')
+		$("#addaliasForwardsTo").val('')
+		$("#addaliasSenders").val('')
+		$('#alias-cancel').addClass('hidden');
+		$('#add-alias-button').text('Add Alias');
+		is_alias_add_update = false;
+	}
 
-function aliases_edit(elem) {
-  var address = $(elem).parents('tr').attr('data-address');
-  var receiverdivs = $(elem).parents('tr').find('.forwardsTo div');
-  var senderdivs = $(elem).parents('tr').find('.senders div');
-  var forwardsTo = "";
-  for (var i = 0; i < receiverdivs.length; i++)
-    forwardsTo += $(receiverdivs[i]).text() + "\n";
-  var senders = "";
-  for (var i = 0; i < senderdivs.length; i++)
-    senders += $(senderdivs[i]).text() + "\n";
-  if (address.charAt(0) == '@' && forwardsTo.charAt(0) == '@')
-    $('#alias_type_buttons button[data-mode="domainalias"]').click();
-  else if (address.charAt(0) == '@')
-    $('#alias_type_buttons button[data-mode="catchall"]').click();
-  else
-    $('#alias_type_buttons button[data-mode="regular"]').click();
-  $('#alias-cancel').removeClass('hidden');
-  $("#addaliasAddress").prop('disabled', true);
-  $("#addaliasAddress").val(address);
-  $("#addaliasForwardsTo").val(forwardsTo);
-  $('#addaliasForwardsToAdvanced').prop('checked', senders != "");
-  $('#addaliasForwardsToNotAdvanced').prop('checked', senders == "");
-  $("#addaliasSenders").val(senders);
-  $('#add-alias-button').text('Update');
-  $('body').animate({ scrollTop: 0 })
-  is_alias_add_update = true;
-}
+	function aliases_edit(elem) {
+		var address = $(elem).parents('tr').attr('data-address');
+		var receiverdivs = $(elem).parents('tr').find('.forwardsTo div');
+		var senderdivs = $(elem).parents('tr').find('.senders div');
+		var forwardsTo = "";
+		for (var i = 0; i < receiverdivs.length; i++)
+			forwardsTo += $(receiverdivs[i]).text() + "\n";
+		var senders = "";
+		for (var i = 0; i < senderdivs.length; i++)
+			senders += $(senderdivs[i]).text() + "\n";
+		if (address.charAt(0) == '@' && forwardsTo.charAt(0) == '@')
+			$('#alias_type_buttons button[data-mode="domainalias"]').click();
+		else if (address.charAt(0) == '@')
+			$('#alias_type_buttons button[data-mode="catchall"]').click();
+		else
+			$('#alias_type_buttons button[data-mode="regular"]').click();
+		$('#alias-cancel').removeClass('hidden');
+		$("#addaliasAddress").prop('disabled', true);
+		$("#addaliasAddress").val(address);
+		$("#addaliasForwardsTo").val(forwardsTo);
+		$('#addaliasForwardsToAdvanced').prop('checked', senders != "");
+		$('#addaliasForwardsToNotAdvanced').prop('checked', senders == "");
+		$("#addaliasSenders").val(senders);
+		$('#add-alias-button').text('Update');
+		$('body').animate({ scrollTop: 0 })
+		is_alias_add_update = true;
+	}
 
-function aliases_remove(elem) {
-  var row_address = $(elem).parents('tr').attr('data-address');
-  show_modal_confirm(
-    "Remove Alias",
-    "Remove " + row_address + "?",
-    "Remove",
-    function() {
-      api(
-        "/mail/aliases/remove",
-        "POST",
-        {
-          address: row_address
-        },
-        function(r) {
-          // Responses are multiple lines of pre-formatted text.
-          show_modal_error("Remove User", $("<pre/>").text(r));
-          show_aliases();
-        });
-    });
-}
+	function aliases_remove(elem) {
+		var row_address = $(elem).parents('tr').attr('data-address');
+		show_modal_confirm(
+			"Remove Alias",
+			"Remove " + row_address + "?",
+			"Remove",
+			function () {
+				api(
+					"/mail/aliases/remove",
+					"POST",
+					{
+						address: row_address
+					},
+					function (r) {
+						// Responses are multiple lines of pre-formatted text.
+						show_modal_error("Remove Alias", $("<pre/>").text(r));
+						show_aliases();
+					});
+			});
+	}
 
-function scroll_top() {
-        $('html, body').animate({
-            scrollTop: $("#panel_aliases").offset().top
-        }, 1000);
-}
+	function scroll_top() {
+		$('html, body').animate({
+			scrollTop: $("#panel_aliases").offset().top
+		}, 1000);
+	}
 </script>

management/templates/custom-dns.html

@@ -1,7 +1,7 @@
 <style>
-#custom-dns-current td.long {
-  word-break: break-all;
-}
+	#custom-dns-current td.long {
+		word-break: break-all;
+	}
 </style>
 
 <h2>Custom DNS</h2>
@@ -12,96 +12,123 @@
 
 <h3>Set custom DNS records</h3>
 
-<p>You can set additional DNS records, such as if you have a website running on another server, to add DKIM records for external mail providers, or for various confirmation-of-ownership tests.</p>
+<p>You can set additional DNS records, such as if you have a website running on another server, to add DKIM records for
+	external mail providers, or for various confirmation-of-ownership tests.</p>
 
 <form class="form-horizontal" role="form" onsubmit="do_set_custom_dns(); return false;">
-  <div class="form-group">
-    <label for="customdnsQname" class="col-sm-1 control-label">Name</label>
-    <div class="col-sm-10">
-      <table style="max-width: 400px">
-      <tr><td>
-        <input type="text" class="form-control" id="customdnsQname" placeholder="subdomain">
-      </td><td style="padding: 0 1em; font-weight: bold;">.</td><td>
-        <select id="customdnsZone" class="form-control"> </select>
-      </td></tr></table>
-      <div class="text-info" style="margin-top: .5em">Leave the left field blank to set a record on the chosen domain name, or enter a subdomain.</div>
-    </div>
-  </div>
-  <div class="form-group">
-    <label for="customdnsType" class="col-sm-1 control-label">Type</label>
-    <div class="col-sm-10">
-      <select id="customdnsType" class="form-control" style="max-width: 400px" onchange="show_customdns_rtype_hint()">
-        <option value="A" data-hint="Enter an IPv4 address (i.e. a dotted quad, such as 123.456.789.012).">A (IPv4 address)</option>
-        <option value="AAAA" data-hint="Enter an IPv6 address.">AAAA (IPv6 address)</option>
-        <option value="CAA" data-hint="Enter a CA that can issue certificates for this domain in the form of FLAG TAG VALUE. (0 issuewild &quot;letsencrypt.org&quot;)">CAA (Certificate Authority Authorization)</option>
-        <option value="CNAME" data-hint="Enter another domain name followed by a period at the end (e.g. mypage.github.io.).">CNAME (DNS forwarding)</option>
-        <option value="TXT" data-hint="Enter arbitrary text.">TXT (text record)</option>
-        <option value="MX" data-hint="Enter record in the form of PRIORITY DOMAIN., including trailing period (e.g. 20 mx.example.com.).">MX (mail exchanger)</option>
-        <option value="SRV" data-hint="Enter record in the form of PRIORITY WEIGHT PORT TARGET., including trailing period (e.g. 10 10 5060 sip.example.com.).">SRV (service record)</option>
-        <option value="SSHFP" data-hint="Enter record in the form of ALGORITHM TYPE FINGERPRINT.">SSHFP (SSH fingerprint record)</option>
-      </select>
-    </div>
-  </div>
-  <div class="form-group">
-    <label for="customdnsValue" class="col-sm-1 control-label">Value</label>
-    <div class="col-sm-10">
-      <input type="text" class="form-control" id="customdnsValue" placeholder="">
-      <div id="customdnsTypeHint" class="text-info" style="margin-top: .5em"></div>
-    </div>
-  </div>
-  <div class="form-group">
-    <div class="col-sm-offset-1 col-sm-11">
-      <button type="submit" class="btn btn-primary">Set Record</button>
-    </div>
-  </div>
+	<div class="col-lg-10 col-xl-7 mb-3">
+		<div class="input-group">
+			<label class="input-group-text">Name</label>
+			<input type="text" class="form-control" id="customdnsQname" placeholder="subdomain">
+			<label class="input-group-text">.</label>
+			<select id="customdnsZone" class="form-select"></select>
+		</div>
+		<small>Leave the left field blank to set a record on the chosen domain name, or enter a subdomain.</small>
+	</div>
+	<div class="col-lg-10 col-xl-7 mb-3">
+		<div class="input-group">
+			<label for="customdnsType" class="input-group-text">Type</label>
+			<select id="customdnsType" class="form-select" onchange="show_customdns_rtype_hint()">
+				<option value="A"
+					data-hint="Enter an IPv4 address (i.e. a dotted quad, such as 123.456.789.012).  The 'local' alias sets the record to this box's public IPv4 address.">
+					A (IPv4 address)</option>
+				<option value="AAAA"
+					data-hint="Enter an IPv6 address.  The 'local' alias sets the record to this box's public IPv6 address.">
+					AAAA (IPv6 address)</option>
+				<option value="CAA"
+					data-hint="Enter a CA that can issue certificates for this domain in the form of FLAG TAG VALUE. (0 issuewild &quot;letsencrypt.org&quot;)">
+					CAA (Certificate Authority Authorization)</option>
+				<option value="CNAME"
+					data-hint="Enter another domain name followed by a period at the end (e.g. mypage.github.io.).">
+					CNAME (DNS forwarding)</option>
+				<option value="TXT" data-hint="Enter arbitrary text.">TXT (text record)</option>
+				<option value="MX"
+					data-hint="Enter record in the form of PRIORITY DOMAIN., including trailing period (e.g. 20 mx.example.com.).">
+					MX (mail exchanger)</option>
+				<option value="SRV"
+					data-hint="Enter record in the form of PRIORITY WEIGHT PORT TARGET., including trailing period (e.g. 10 10 5060 sip.example.com.).">
+					SRV (service record)</option>
+				<option value="SSHFP" data-hint="Enter record in the form of ALGORITHM TYPE FINGERPRINT.">SSHFP (SSH
+					fingerprint record)</option>
+				<option value="NS" data-hint="Enter a hostname to which this subdomain should be delegated to">NS (DNS
+					subdomain delegation)</option>
+			</select>
+		</div>
+	</div>
+	<div class="col-lg-10 col-xl-7 mb-3">
+		<div class="input-group">
+			<label for="customdnsValue" class="input-group-text">Value</label>
+			<input type="text" class="form-control" id="customdnsValue" placeholder="">
+			<label for="customdnsTtl" class="input-group-text">TTL</label>
+			<input type="number" class="form-control" id="customdnsTtl" placeholder="default">
+		</div>
+		<small id="customdnsTypeHint" class="text-info" style="margin-top: .5em"></small>
+	</div>
+	<button type="submit" class="btn btn-primary mb-3">Set Record</button>
 </form>
 
-<table id="custom-dns-current" class="table" style="width: auto; display: none">
-  <thead>
-    <th>Domain Name</th>
-    <th>Record Type</th>
-    <th>Value</th>
-    <th></th>
-  </thead>
-  <tbody>
-    <tr><td colspan="4">Loading...</td></tr>
-  </tbody>
+<div style="font-size: 90%;">
+	<b>Sort by:</b>
+	<a href="#"
+		onclick="window.miab_custom_dns_data_sort_order='qname'; show_current_custom_dns_update_after_sort(); return false;">Domain
+		name</a>
+	<b>|</b>
+	<a href="#"
+		onclick="window.miab_custom_dns_data_sort_order='created'; show_current_custom_dns_update_after_sort(); return false;">Created</a>
+</div>
+<table id="custom-dns-current" class="table col-12" style="display: none; margin-top: 0;">
+	<caption></caption>
+	<thead>
+		<th>Domain Name</th>
+		<th>Record Type</th>
+		<th>Value</th>
+		<th>TTL</th>
+		<th></th>
+	</thead>
+	<tbody>
+		<tr>
+			<td colspan="5">Loading...</td>
+		</tr>
+	</tbody>
 </table>
 
 <h3>Using a secondary nameserver</h3>
 
-<p>If your TLD requires you to have two separate nameservers, you can either set up <a href="#" onclick="return show_panel('external_dns')">external DNS</a> and ignore the DNS server on this box entirely, or use the DNS server on this box but add a secondary (aka &ldquo;slave&rdquo;) nameserver.</p>
-<p>If you choose to use a secondary nameserver, you must find a secondary nameserver service provider. Your domain name registrar or virtual cloud provider may provide this service for you. Once you set up the secondary nameserver service, enter the hostname (not the IP address) of <em>their</em> secondary nameserver in the box below.</p>
+<p>If your TLD requires you to have two separate nameservers, you can either set up <a href="#"
+		onclick="return show_panel('external_dns')">external DNS</a> and ignore the DNS server on this box entirely, or
+	use the DNS server on this box but add a secondary (aka &ldquo;slave&rdquo;) nameserver.</p>
+<p>If you choose to use a secondary nameserver, you must find a secondary nameserver service provider. Your domain name
+	registrar or virtual cloud provider may provide this service for you. Once you set up the secondary nameserver
+	service, enter the hostname (not the IP address) of <em>their</em> secondary nameserver in the box below.</p>
 
 <form class="form-horizontal" role="form" onsubmit="do_set_secondary_dns(); return false;">
-  <div class="form-group">
-    <label for="secondarydnsHostname" class="col-sm-1 control-label">Hostname</label>
-    <div class="col-sm-10">
-      <input type="text" class="form-control" id="secondarydnsHostname" placeholder="ns1.cloudprovider.com">
-    </div>
-  </div>
-  <div class="form-group">
-    <div class="col-sm-offset-1 col-sm-11">
-      <button type="submit" class="btn btn-primary">Update</button>
-    </div>
-  </div>
-  <div class="form-group">
-    <div class="col-sm-offset-1 col-sm-11">
-      <p class="small">
-        Multiple secondary servers can be separated with commas or spaces (i.e., <code>ns2.hostingcompany.com ns3.hostingcompany.com</code>). 
-        To enable zone transfers to additional servers without listing them as secondary nameservers, add <code>xfr:IPADDRESS</code>.
-      </p>
-      <p id="secondarydns-clear-instructions" style="display: none" class="small">
-        Clear the input field above and click Update to use this machine itself as secondary DNS, which is the default/normal setup.
-      </p>
-    </div>
-  </div>
+	<div class="col-12 form-floating mb-3">
+		<textarea type="text" class="form-control font-monospace" id="secondarydnsHostname"
+			placeholder="ns1.example.com"></textarea>
+		<label for="secondarydnsHostname">Secondary Nameservers</label>
+		<div>
+			<p class="small">
+				Multiple secondary servers can be separated with commas or spaces (i.e., <span
+					class="font-monospace">ns2.hostingcompany.com ns3.hostingcompany.com</span>).
+				To enable zone transfers to additional servers without listing them as secondary nameservers, add an IP
+				address or subnet using <span class="font-monospace">xfr:10.20.30.40</span> or <span
+					class="font-monospace">xfr:10.0.0.0/8</span>.
+			</p>
+			<p id="secondarydns-clear-instructions" style="display: none" class="small">
+				Clear the input field above and click Update to use this machine itself as secondary DNS, which is the
+				default/normal setup.
+			</p>
+		</div>
+	</div>
+
+	<button type="submit" class="btn btn-primary">Update</button>
 </form>
 
 
 <h3>Custom DNS API</h3>
 
-<p>Use your box&rsquo;s DNS API to set custom DNS records on domains hosted here. For instance, you can create your own dynamic DNS service.</p>
+<p>Use your box&rsquo;s DNS API to set custom DNS records on domains hosted here. For instance, you can create your own
+	dynamic DNS service.</p>
 
 <p>Usage:</p>
 
@@ -112,29 +139,83 @@
 <h4>Verbs</h4>
 
 <table class="table">
-<thead><th>Verb</th> <th>Usage</th></thead>
-<tr><td>GET</td> <td>Returns matching custom DNS records as a JSON array of objects. Each object has the keys <code>qname</code>, <code>rtype</code>, and <code>value</code>. The optional <code>qname</code> and <code>rtype</code> parameters in the request URL filter the records returned in the response. The request body (<code>-d "..."</code>) must be omitted.</td></tr>
-<tr><td>PUT</td> <td>Sets a custom DNS record replacing any existing records with the same <code>qname</code> and <code>rtype</code>. Use PUT (instead of POST) when you only have one value for a <code>qname</code> and <code>rtype</code>, such as typical <code>A</code> records (without round-robin).</td></tr>
-<tr><td>POST</td> <td>Adds a new custom DNS record. Use POST when you have multiple <code>TXT</code> records or round-robin <code>A</code> records. (PUT would delete previously added records.)</td></tr>
-<tr><td>DELETE</td> <td>Deletes custom DNS records. If the request body (<code>-d "..."</code>) is empty or omitted, deletes all records matching the <code>qname</code> and <code>rtype</code>. If the request body is present, deletes only the record matching the <code>qname</code>, <code>rtype</code> and value.</td></tr>
+	<caption></caption>
+	<thead>
+		<th>Verb</th>
+		<th>Usage</th>
+	</thead>
+	<tr>
+		<td class="font-monospace"><b>GET</b></td>
+		<td>Returns matching custom DNS records as a JSON array of objects. Each object has the keys <code>qname</code>,
+			<code>rtype</code>, and <code>value</code>. The optional <code>qname</code> and <code>rtype</code>
+			parameters in the request URL filter the records returned in the response. The request body
+			(<code>-d "..."</code>) must be omitted.</td>
+	</tr>
+	<tr>
+		<td class="font-monospace"><b>PUT</b></td>
+		<td>Sets a custom DNS record replacing any existing records with the same <code>qname</code> and
+			<code>rtype</code>. Use PUT (instead of POST) when you only have one value for a <code>qname</code> and
+			<code>rtype</code>, such as typical <code>A</code> records (without round-robin).</td>
+	</tr>
+	<tr>
+		<td class="font-monospace"><b>POST</b></td>
+		<td>Adds a new custom DNS record. Use POST when you have multiple <code>TXT</code> records or round-robin
+			<code>A</code> records. (PUT would delete previously added records.)</td>
+	</tr>
+	<tr>
+		<td class="font-monospace"><b>DELETE</b></td>
+		<td>Deletes custom DNS records. If the request body (<code>-d "..."</code>) is empty or omitted, deletes all
+			records matching the <code>qname</code> and <code>rtype</code>. If the request body is present, deletes only
+			the record matching the <code>qname</code>, <code>rtype</code> and value.</td>
+	</tr>
 </table>
 
 <h4>Parameters</h4>
 
 <table class="table">
-<thead><th>Parameter</th> <th>Value</th></thead>
-<tr><td>email</td> <td>The email address of any administrative user here.</td></tr>
-<tr><td>password</td> <td>That user&rsquo;s password.</td></tr>
-<tr><td>qname</td> <td>The fully qualified domain name for the record you are trying to set. It must be one of the domain names or a subdomain of one of the domain names hosted on this box. (Add mail users or aliases to add new domains.)</td></tr>
-<tr><td>rtype</td> <td>The resource type. Defaults to <code>A</code> if omitted. Possible values: <code>A</code> (an IPv4 address), <code>AAAA</code> (an IPv6 address), <code>TXT</code> (a text string), <code>CNAME</code> (an alias, which is a fully qualified domain name &mdash; don&rsquo;t forget the final period), <code>MX</code>, <code>SRV</code>, <code>SSHFP</code> or <code>CAA</code>.</td></tr>
-<tr><td>value</td> <td>For PUT, POST, and DELETE, the record&rsquo;s value. If the <code>rtype</code> is <code>A</code> or <code>AAAA</code> and <code>value</code> is empty or omitted, the IPv4 or IPv6 address of the remote host is used (be sure to use the <code>-4</code> or <code>-6</code> options to curl). This is handy for dynamic DNS!</td></tr>
+	<caption></caption>
+	<thead>
+		<th>Parameter</th>
+		<th>Value</th>
+	</thead>
+	<tr>
+		<td class="font-monospace"><b>email</b></td>
+		<td>The email address of any administrative user here.</td>
+	</tr>
+	<tr>
+		<td class="font-monospace"><b>password</b></td>
+		<td>That user&rsquo;s password.</td>
+	</tr>
+	<tr>
+		<td class="font-monospace"><b>qname</b></td>
+		<td>The fully qualified domain name for the record you are trying to set. It must be one of the domain names or
+			a subdomain of one of the domain names hosted on this box. (Add mail users or aliases to add new domains.)
+		</td>
+	</tr>
+	<tr>
+		<td class="font-monospace"><b>rtype</b></td>
+		<td>The resource type. Defaults to <code>A</code> if omitted. Possible values: <code>A</code> (an IPv4 address),
+			<code>AAAA</code> (an IPv6 address), <code>TXT</code> (a text string), <code>CNAME</code> (an alias, which
+			is a fully qualified domain name &mdash; don&rsquo;t forget the final period), <code>MX</code>,
+			<code>SRV</code>, <code>SSHFP</code>, <code>CAA</code> or <code>NS</code>.</td>
+	</tr>
+	<tr>
+		<td class="font-monospace"><b>value</b></td>
+		<td>For PUT, POST, and DELETE, the record&rsquo;s value. If the <code>rtype</code> is <code>A</code> or
+			<code>AAAA</code> and <code>value</code> is empty or omitted, the IPv4 or IPv6 address of the remote host is
+			used (be sure to use the <code>-4</code> or <code>-6</code> options to curl). This is handy for dynamic DNS!
+		</td>
+	</tr>
 </table>
 
-<p>Strict <a href="http://tools.ietf.org/html/rfc4408">SPF</a> and <a href="https://datatracker.ietf.org/doc/draft-kucherawy-dmarc-base/?include_text=1">DMARC</a> records will be added to all custom domains unless you override them.</p>
+<p>Strict <a href="http://tools.ietf.org/html/rfc4408">SPF</a> and <a
+		href="https://datatracker.ietf.org/doc/draft-kucherawy-dmarc-base/?include_text=1">DMARC</a> records will be
+	added to all custom domains unless you override them.</p>
 
 <h4>Examples:</h4>
 
-<p>Try these examples. For simplicity the examples omit the <code>--user me@mydomain.com:yourpassword</code> command line argument which you must fill in with your email address and password.</p>
+<p>Try these examples. For simplicity the examples omit the <code>--user me@mydomain.com:yourpassword</code> command
+	line argument which you must fill in with your email address and password.</p>
 
 <pre># sets laptop.mydomain.com to point to the IP address of the machine you are executing curl on
 curl -X PUT https://{{hostname}}/admin/dns/custom/laptop.mydomain.com
@@ -156,108 +237,138 @@ curl -X DELETE -d "some text here" https://{{hostname}}/admin/dns/custom/foo.myd
 </pre>
 
 <script>
-function show_custom_dns() {
-  api(
-    "/dns/secondary-nameserver",
-    "GET",
-    { },
-    function(data) {
-      $('#secondarydnsHostname').val(data.hostnames.join(' '));
-      $('#secondarydns-clear-instructions').toggle(data.hostnames.length > 0);
-    });
+	function show_custom_dns() {
+		api(
+			"/dns/secondary-nameserver",
+			"GET",
+			{},
+			function (data) {
+				$('#secondarydnsHostname').val(data.hostnames.join(' '));
+				$('#secondarydns-clear-instructions').toggle(data.hostnames.length > 0);
+			});
 
-  api(
-    "/dns/zones",
-    "GET",
-    { },
-    function(data) {
-      $('#customdnsZone').text('');
-      for (var i = 0; i < data.length; i++) {
-        $('#customdnsZone').append($('<option/>').text(data[i]));
-      }
-    });
+		api(
+			"/dns/zones",
+			"GET",
+			{},
+			function (data) {
+				$('#customdnsZone').text('');
+				for (var i = 0; i < data.length; i++) {
+					$('#customdnsZone').append($('<option/>').text(data[i]));
+				}
+			});
 
-  show_current_custom_dns();
-  show_customdns_rtype_hint();
-}
+		show_current_custom_dns();
+		show_customdns_rtype_hint();
+	}
 
-function show_current_custom_dns() {
-  api(
-    "/dns/custom",
-    "GET",
-    { },
-    function(data) {
-      if (data.length > 0)
-        $('#custom-dns-current').fadeIn();
-      else
-        $('#custom-dns-current').fadeOut();
+	function show_current_custom_dns() {
+		api(
+			"/dns/custom",
+			"GET",
+			{},
+			function (data) {
+				if (data.length > 0)
+					$('#custom-dns-current').fadeIn();
+				else
+					$('#custom-dns-current').fadeOut();
+				window.miab_custom_dns_data = data;
+				show_current_custom_dns_update_after_sort();
+			});
+	}
 
-      $('#custom-dns-current').find("tbody").text('');
-      for (var i = 0; i < data.length; i++) {
-        var tr = $("<tr/>");
-        $('#custom-dns-current').find("tbody").append(tr);
-        tr.attr('data-qname', data[i].qname);
-        tr.attr('data-rtype', data[i].rtype);
-        tr.attr('data-value', data[i].value);
-        tr.append($('<td class="long"/>').text(data[i].qname));
-        tr.append($('<td/>').text(data[i].rtype));
-        tr.append($('<td class="long"/>').text(data[i].value));
-        tr.append($('<td>[<a href="#" onclick="return delete_custom_dns_record(this)">delete</a>]</td>'));
-      }
-    });
-}
+	function show_current_custom_dns_update_after_sort() {
+		var data = window.miab_custom_dns_data;
+		var sort_key = window.miab_custom_dns_data_sort_order || "qname";
 
-function delete_custom_dns_record(elem) {
-  var qname = $(elem).parents('tr').attr('data-qname');
-  var rtype = $(elem).parents('tr').attr('data-rtype');
-  var value = $(elem).parents('tr').attr('data-value');
-  do_set_custom_dns(qname, rtype, value, "DELETE");
-  return false;
-}
+		data.sort(function (a, b) { return a["sort-order"][sort_key] - b["sort-order"][sort_key] });
 
-function do_set_secondary_dns() {
- api(
-    "/dns/secondary-nameserver",
-    "POST",
-    {
-      hostnames: $('#secondarydnsHostname').val()
-    },
-    function(data) {
-      if (data == "") return; // nothing updated
-      show_modal_error("Secondary DNS", $("<pre/>").text(data));
-      $('#secondarydns-clear-instructions').slideDown();
-    },
-    function(err) {
-      show_modal_error("Secondary DNS", $("<pre/>").text(err));
-    });
-}
+		var tbody = $('#custom-dns-current').find("tbody");
+		tbody.text('');
+		var last_zone = null;
+		for (var i = 0; i < data.length; i++) {
+			if (sort_key == "qname" && data[i].zone != last_zone) {
+				var r = $("<tr><th colspan=5 class='bg-light'></th></tr>");
+				r.find("th").text(data[i].zone);
+				tbody.append(r);
+				last_zone = data[i].zone;
+			}
 
-function do_set_custom_dns(qname, rtype, value, method) {
-  if (!qname) {
-    if ($('#customdnsQname').val() != '')
-      qname = $('#customdnsQname').val() + '.' + $('#customdnsZone').val();
-    else
-      qname = $('#customdnsZone').val();
-    rtype = $('#customdnsType').val();
-    value = $('#customdnsValue').val();
-    method = 'POST';
-  }
+			var tr = $("<tr/>");
+			tbody.append(tr);
+			tr.attr('data-qname', data[i].qname);
+			tr.attr('data-rtype', data[i].rtype);
+			tr.attr('data-value', data[i].value);
+			tr.append($('<td class="long"/>').text(data[i].qname));
+			tr.append($('<td/>').text(data[i].rtype));
+			tr.append($('<td class="long font-monospace" style="max-width: 40em"/>').text(data[i].value));
+			if (data[i].ttl) {
+				tr.append($('<td/>').text(data[i].ttl));
+			} else {
+				tr.append($('<td/>').html('<i class="">default</i>'));
+			}
+			tr.append($('<td class="col-1">[<a href="#" onclick="return delete_custom_dns_record(this)">delete</a>]</td>'));
+		}
+	}
 
-  api(
-    "/dns/custom/" + qname + "/" + rtype,
-    method,
-    value,
-    function(data) {
-      if (data == "") return; // nothing updated
-      show_modal_error("Custom DNS", $("<pre/>").text(data));
-      show_current_custom_dns();
-    },
-    function(err) {
-      show_modal_error("Custom DNS (Error)", $("<pre/>").text(err));
-    });
-}
+	function delete_custom_dns_record(elem) {
+		var qname = $(elem).parents('tr').attr('data-qname');
+		var rtype = $(elem).parents('tr').attr('data-rtype');
+		var value = $(elem).parents('tr').attr('data-value');
+		do_set_custom_dns(qname, rtype, value, "DELETE");
+		return false;
+	}
 
-function show_customdns_rtype_hint() {
-  $('#customdnsTypeHint').text($("#customdnsType").find('option:selected').attr('data-hint'));
-}
+	function do_set_secondary_dns() {
+		api(
+			"/dns/secondary-nameserver",
+			"POST",
+			{
+				hostnames: $('#secondarydnsHostname').val()
+			},
+			function (data) {
+				if (data == "") return; // nothing updated
+				show_modal_error("Secondary DNS", $("<pre/>").text(data));
+				$('#secondarydns-clear-instructions').slideDown();
+			},
+			function (err) {
+				show_modal_error("Secondary DNS", $("<pre/>").text(err));
+			});
+	}
+
+	function do_set_custom_dns(qname, rtype, value, method) {
+		if (!qname) {
+			if ($('#customdnsQname').val() != '')
+				qname = $('#customdnsQname').val() + '.' + $('#customdnsZone').val();
+			else
+				qname = $('#customdnsZone').val();
+			rtype = $('#customdnsType').val();
+			value = {
+				value: $('#customdnsValue').val(),
+				ttl: $('#customdnsTtl').val()
+			};
+			method = 'POST';
+		} else {
+			value = {
+				value: value
+			}
+		}
+
+		api(
+			"/dns/custom/" + qname + "/" + rtype,
+			method,
+			value,
+			function (data) {
+				if (data == "") return; // nothing updated
+				show_modal_error("Custom DNS", $("<pre/>").text(data));
+				show_current_custom_dns();
+			},
+			function (err) {
+				show_modal_error("Custom DNS (Error)", $("<pre/>").text(err));
+			});
+	}
+
+	function show_customdns_rtype_hint() {
+		$('#customdnsTypeHint').text($("#customdnsType").find('option:selected').attr('data-hint'));
+	}
 </script>

management/templates/external-dns.html

@@ -1,49 +1,66 @@
 <style>
-#external_dns_settings .heading td {
-  font-weight: bold;
-  font-size: 120%;
-  padding-top: 1.5em;
-}
-#external_dns_settings .heading.first td {
-  border-top: none;
-  padding-top: 0;
-}
-#external_dns_settings .values td {
-  border: 0;
-	padding-top: .75em;
-	padding-bottom: 0;
-}
-#external_dns_settings .value {
-	word-break: break-all;
-}
-#external_dns_settings .explanation td {
-	border: 0;
-	padding-top: .5em;
-	padding-bottom: .75em;
-	font-style: italic;
-  font-size: 95%;
-	color: #777;
-}
+	#external_dns_settings .domain-header {
+		margin-top: 0.5em;
+		margin-bottom: 0.5em;
+	}
+
+	#external_dns_settings .values td {
+		border: 0;
+		padding-top: .75em;
+		padding-bottom: 0;
+	}
+
+	#external_dns_settings .value {
+		word-break: break-all;
+	}
+
+	#external_dns_settings .explanation td {
+		padding-top: .5em;
+		padding-bottom: .75em;
+		font-style: italic;
+		color: #777;
+	}
 </style>
 
 <h2>External DNS</h2>
 
 <p class="text-warning">This is an advanced configuration page.</p>
 
-<p>Although your box is configured to serve its own DNS, it is possible to host your DNS elsewhere &mdash; such as in the DNS control panel provided by your domain name registrar or virtual cloud provider &mdash; by copying the DNS zone information shown in the table below into your external DNS server&rsquo;s control panel.</p>
+<p>Although your box is configured to serve its own DNS, it is possible to host your DNS elsewhere &mdash; such as in
+	the DNS control panel provided by your domain name registrar or virtual cloud provider &mdash; by copying the DNS
+	zone information shown in the table below into your external DNS server&rsquo;s control panel.</p>
 
-<p>If you do so, you are responsible for keeping your DNS entries up to date! If you previously enabled DNSSEC on your domain name by setting a DS record at your registrar, you will likely have to turn it off before changing nameservers.</p>
+<p>If you do so, you are responsible for keeping your DNS entries up to date! If you previously enabled DNSSEC on your
+	domain name by setting a DS record at your registrar, you will likely have to turn it off before changing
+	nameservers.</p>
 
 
 <p class="alert" role="alert">
-	<span class="glyphicon glyphicon-info-sign"></span>
+	<span class="fas fa-info-circle"></span>
 	You may encounter zone file errors when attempting to create a TXT record with a long string.
-	<a href="http://tools.ietf.org/html/rfc4408#section-3.1.3">RFC 4408</a> states a TXT record is allowed to contain multiple strings, and this technique can be used to construct records that would exceed the 255-byte maximum length.
-	You may need to adopt this technique when adding DomainKeys. Use a tool like <code>named-checkzone</code> to validate your zone file.
+	<a href="https://tools.ietf.org/html/rfc4408#section-3.1.3">RFC 4408</a> states a TXT record is allowed to contain
+	multiple strings, and this technique can be used to construct records that would exceed the 255-byte maximum length.
+	You may need to adopt this technique when adding DomainKeys. Use a tool like <code>named-checkzone</code> to
+	validate your zone file.
 </p>
 
+<h3>Download zonefile</h3>
+<p>You can download your zonefiles here or use the table of records below.</p>
+<form class="form-inline" role="form" onsubmit="do_download_zonefile(); return false;">
+	<div class="col-md-10 col-xl-6 mb-3">
+		<div class="input-group">
+			<label for="downloadZonefile" class="input-group-text">Zone</label>
+			<select id="downloadZonefile" class="form-select"></select>
+		</div>
+	</div>
+
+	<button type="submit" class="btn btn-primary">Download</button>
+</form>
+
+<h3>Records</h3>
 
 <table id="external_dns_settings" class="table">
+	<caption></caption>
 	<thead>
 		<tr>
 			<th>QName</th>
@@ -56,32 +73,59 @@
 </table>
 
 <script>
-function show_external_dns() {
-  $('#external_dns_settings tbody').html("<tr><td colspan='2' class='text-muted'>Loading...</td></tr>")
-  api(
-    "/dns/dump",
-    "GET",
-    { },
-    function(zones) {
-      $('#external_dns_settings tbody').html("");
-      for (var j = 0; j < zones.length; j++) {
-        var h = $("<tr class='heading'><td colspan='3'></td></tr>");
-        h.find("td").text(zones[j][0]);
-        $('#external_dns_settings tbody').append(h);
+	function show_external_dns() {
+		api(
+			"/dns/zones",
+			"GET",
+			{},
+			function (data) {
+				var zones = $('#downloadZonefile');
+				zones.text('');
+				for (var j = 0; j < data.length; j++) {
+					zones.append($('<option/>').text(data[j]));
+				}
+			});
 
-        var r = zones[j][1];
-        for (var i = 0; i < r.length; i++) {
-          var n = $("<tr class='values'><td class='qname'/><td class='rtype'/><td class='value'/></tr>");
-          n.find('.qname').text(r[i].qname);
-          n.find('.rtype').text(r[i].rtype);
-          n.find('.value').text(r[i].value);
-          $('#external_dns_settings tbody').append(n);
+		$('#external_dns_settings tbody').html("<tr><td colspan='2' class='text-muted'>Loading...</td></tr>")
+		api(
+			"/dns/dump",
+			"GET",
+			{},
+			function (zones) {
+				$('#external_dns_settings tbody').html("");
+				for (var j = 0; j < zones.length; j++) {
+					var h = $("<tr><td colspan='3' class='bg-light'><h4 class='domain-header'/></td></tr>");
+					h.find("td h4").text(zones[j][0]);
+					$('#external_dns_settings tbody').append(h);
 
-          var n = $("<tr class='explanation'><td colspan='3'/></tr>");
-          n.find('td').text(r[i].explanation);
-          $('#external_dns_settings tbody').append(n);
-        }
-      }
-    })
-}
+					var r = zones[j][1];
+					for (var i = 0; i < r.length; i++) {
+						var n = $("<tr class='values'><td class='qname'/><td class='rtype'/><td class='value font-monospace'/></tr>");
+						n.find('.qname').text(r[i].qname);
+						n.find('.rtype').text(r[i].rtype);
+						n.find('.value').text(r[i].value);
+						$('#external_dns_settings tbody').append(n);
+
+						var n = $("<tr class='explanation'><td colspan='3'/><small/></tr>");
+						n.find('td small').text(r[i].explanation);
+						$('#external_dns_settings tbody').append(n);
+					}
+				}
+			})
+	}
+
+	function do_download_zonefile() {
+		var zone = $('#downloadZonefile').val();
+
+		api(
+			"/dns/zonefile/" + zone,
+			"GET",
+			{},
+			function (data) {
+				show_modal_error("Download Zonefile", $("<pre/>").text(data));
+			},
+			function (err) {
+				show_modal_error("Download Zonefile (Error)", $("<pre/>").text(err));
+			});
+	}
 </script>

management/templates/index.html

@@ -1,396 +1,630 @@
 <!DOCTYPE html>
 <html lang="en">
-    <head>
-        <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
-        <meta charset="utf-8">
-        <meta name="viewport" content="width=device-width, initial-scale=1">
 
-        <title>{{hostname}} - Mail-in-a-Box Control Panel</title>
+	<head>
+		<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+		<meta charset="utf-8">
+		<meta name="viewport" content="width=device-width, initial-scale=1">
 
-        <meta name="robots" content="noindex, nofollow">
+		<title>{{hostname}} - Mail-in-a-Box Control Panel</title>
 
-        <link rel="stylesheet" href="/admin/assets/bootstrap/css/bootstrap.min.css">
-        <style>
-	    body {
-		overflow-y: scroll;
-                padding-bottom: 20px;
-            }
+		<meta name="robots" content="noindex, nofollow">
 
-            p {
-              margin-bottom: 1.25em;
-            }
+		<link rel="stylesheet" href="/admin/assets/bootstrap/css/bootstrap.min.css">
+		<link rel="stylesheet" href="/admin/assets/fontawesome/css/fontawesome.min.css">
+		<link rel="stylesheet" href="/admin/assets/fontawesome/css/solid.min.css">
 
-            h1, h2, h3, h4 {
-              font-family: sans-serif;
-              font-weight: bold;
-            }
+		<style>
+			body {
+				overflow-y: scroll;
+				padding-bottom: 20px;
+			}
 
-            h2 {
-              margin: 1em 0;
-            }
+			p {
+				margin-bottom: 1.25em;
+			}
 
-            h3 {
-              font-size: 130%;
-              border-bottom: 1px solid black;
-              padding-bottom: 3px;
-              margin-bottom: 13px;
-              margin-top: 30px;
-            }
-              .panel-heading h3 {
-                border: none;
-                padding: 0;
-                margin: 0;
-              }
+			h1,
+			h2,
+			h3,
+			h4 {
+				font-family: sans-serif;
+				font-weight: bold;
+			}
 
-            h4 {
-              font-size: 110%;
-              margin-bottom: 13px;
-              margin-top: 18px;
-            }
-              h4:first-child {
-                margin-top: 6px;
-              }
+			h2 {
+				margin: 1em 0;
+			}
 
-            .admin_panel {
-              display: none;
-            }
+			h3 {
+				font-size: 130%;
+				border-bottom: 1px solid black;
+				padding-bottom: 3px;
+				margin-bottom: 13px;
+				margin-top: 30px;
+			}
 
-            table.table {
-              margin: 1.5em 0;
-            }
+			.panel-heading h3 {
+				border: none;
+				padding: 0;
+				margin: 0;
+			}
 
-	    ol li {
-	       margin-bottom: 1em;
-	    }
-        </style>
-        <link rel="stylesheet" href="/admin/assets/bootstrap/css/bootstrap-theme.min.css">
-    </head>
-    <body>
+			h4 {
+				font-size: 110%;
+				margin-bottom: 13px;
+				margin-top: 18px;
+			}
 
-    <!--[if lt IE 8]><p>Internet Explorer version 8 or any modern web browser is required to use this website, sorry.<![endif]-->
-    <!--[if gt IE 7]><!-->
+			h4:first-child {
+				margin-top: 6px;
+			}
 
-    <div class="navbar navbar-inverse navbar-static-top" role="navigation">
-      <div class="container">
-        <div class="navbar-header">
-          <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target=".navbar-collapse">
-            <span class="sr-only">Toggle navigation</span>
-            <span class="icon-bar"></span>
-            <span class="icon-bar"></span>
-            <span class="icon-bar"></span>
-          </button>
-          <a class="navbar-brand" href="#">{{hostname}}</a>
-        </div>
-        <div class="navbar-collapse collapse">
-          <ul class="nav navbar-nav">
-            <li class="dropdown">
-              <a href="#" class="dropdown-toggle" data-toggle="dropdown">System <b class="caret"></b></a>
-              <ul class="dropdown-menu">
-                <li><a href="#system_status" onclick="return show_panel(this);">Status Checks</a></li>
-                <li><a href="#tls" onclick="return show_panel(this);">TLS (SSL) Certificates</a></li>
-                <li><a href="#system_backup" onclick="return show_panel(this);">Backup Status</a></li>
-                <li class="divider"></li>
-                <li class="dropdown-header">Advanced Pages</li>
-                <li><a href="#custom_dns" onclick="return show_panel(this);">Custom DNS</a></li>
-                <li><a href="#external_dns" onclick="return show_panel(this);">External DNS</a></li>
-                <li><a href="/admin/munin" target="_blank">Munin Monitoring</a></li>
-              </ul>
-            </li>
-            <li class="dropdown">
-              <a href="#" class="dropdown-toggle" data-toggle="dropdown">Mail <b class="caret"></b></a>
-              <ul class="dropdown-menu">
-                <li><a href="#mail-guide" onclick="return show_panel(this);">Instructions</a></li>
-                <li><a href="#users" onclick="return show_panel(this);">Users</a></li>
-                <li><a href="#aliases" onclick="return show_panel(this);">Aliases</a></li>
-              </ul>
-            </li>
-            <li><a href="#sync_guide" onclick="return show_panel(this);">Contacts/Calendar</a></li>
-            <li><a href="#web" onclick="return show_panel(this);">Web</a></li>
-          </ul>
-          <ul class="nav navbar-nav navbar-right">
-            <li><a href="#" onclick="do_logout(); return false;" style="color: white">Log out?</a></li>
-          </ul>
-        </div><!--/.navbar-collapse -->
-      </div>
-    </div>
+			.admin_panel {
+				display: none;
+			}
 
-    <div class="container">
-      <div id="panel_system_status" class="admin_panel">
-      {% include "system-status.html" %}
-      </div>
+			table.table {
+				margin: 1.5em 0;
+			}
 
-      <div id="panel_system_backup" class="admin_panel">
-      {% include "system-backup.html" %}
-      </div>
+			ol li {
+				margin-bottom: 1em;
+			}
 
-      <div id="panel_external_dns" class="admin_panel">
-      {% include "external-dns.html" %}
-      </div>
+			.if-logged-in {
+				display: none;
+			}
 
-      <div id="panel_custom_dns" class="admin_panel">
-      {% include "custom-dns.html" %}
-      </div>
+			.if-logged-in-admin {
+				display: none;
+			}
+		</style>
+	</head>
 
-      <div id="panel_login" class="admin_panel">
-      {% include "login.html" %}
-      </div>
+	<body class="">
 
-      <div id="panel_mail-guide" class="admin_panel">
-      {% include "mail-guide.html" %}
-      </div>
+		<div class="navbar navbar-expand-lg navbar-light" role="navigation">
+			<div class="container bg-light pt-2 pb-2">
+				<div class="if-logged-in">
+					<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarContent"
+						aria-controls="#navbarContent" aria-expanded="false" aria-label="Toggle navigation">
+						<span class="navbar-toggler-icon"></span>
+					</button>
+				</div>
+				<div class="navbar-brand ms-2">
+					<span class="fas fa-envelope"></span>
+					<b>{{hostname}}</b>
+				</div>
+				<div class="ms-2">
+					<span class="me-1 fas fa-sun"></span>
+					<span class="form-switch">
+						<input class="form-check-input" type="checkbox" role="switch" id="toggle-theme">
+						<label class="ms-1 fas fa-moon"></label>
+					</span>
+				</div>
+				<div class="collapse navbar-collapse" id="navbarContent">
+					<ul class="navbar-nav ms-auto">
+						<li class="nav-item me-1 me-xl-4 dropdown if-logged-in-admin">
+							<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown"
+								aria-expanded="false">System</button>
+							<ul class="dropdown-menu">
+								<li><a class="dropdown-item" href="#system_status" onclick="return show_panel(this);">Status
+										Checks</a></li>
+								<li><a class="dropdown-item" href="#tls" onclick="return show_panel(this);">TLS (SSL)
+										Certificates</a></li>
+								<li><a class="dropdown-item" href="#system_backup" onclick="return show_panel(this);">Backup
+										Status</a></li>
+								<li><a class="dropdown-item" href="#smtp_relays" onclick="return show_panel(this);">SMTP
+										Relays</a></li>
+							</ul>
+						</li>
+						<li class="nav-item me-1 me-xl-4 dropdown if-logged-in-admin">
+							<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown"
+								aria-expanded="false">Advanced</button>
+							<ul class="dropdown-menu">
+								<li><a class="dropdown-item" href="#custom_dns" onclick="return show_panel(this);">Custom
+										DNS</a></li>
+								<li><a class="dropdown-item" href="#external_dns"
+										onclick="return show_panel(this);">External DNS</a></li>
+								<li><a class="dropdown-item" href="#pgp_keyring" onclick="return show_panel(this);">PGP
+										Keyring Management</a></li>
+								<li><a class="dropdown-item" href="#wkd" onclick="return show_panel(this);">WKD
+										Management</a></li>
+								<li><a class="dropdown-item" href="#munin" onclick="return show_panel(this);">Munin
+										Monitoring</a></li>
+							</ul>
+						</li>
+						<li class="nav-item me-1 me-xl-4 dropdown if-logged-in-not-admin">
+							<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">Your Account</button>
+							<ul class="dropdown-menu">
+								<li><a class="dropdown-item" href="#manage-password" onclick="return show_panel(this);">Manage Password</a></li>
+								<li><a class="dropdown-item" href="#mfa" onclick="return show_panel(this);">Two-Factor Authentication</a></li>
+							</ul>
+						</li>
+						<li class="nav-item me-1 me-xl-4 btn if-logged-in-not-admin" type="button" href="#mail-guide"
+							onclick="return show_panel(this);">
+							Mail Guide
+						</li>
+						<li class="nav-item me-1 me-xl-4 dropdown if-logged-in-admin">
+							<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown"
+								aria-expanded="false">Mail</button>
+							<ul class="dropdown-menu">
+								<li><a class="dropdown-item" href="#mail-guide" onclick="return show_panel(this);">Mail
+										Guide</a></li>
+								<li><a class="dropdown-item" href="#users" onclick="return show_panel(this);">Users</a></li>
+								<li><a class="dropdown-item" href="#aliases" onclick="return show_panel(this);">Aliases</a>
+								</li>
+								<li class="divider"></li>
+								<li class="dropdown-header">Your Account</li>
+								<li><a class="dropdown-item" href="#mfa" onclick="return show_panel(this);">Two-Factor
+										Authentication</a></li>
+							</ul>
+						</li>
+						<li><button class="nav-item me-1 me-xl-4 btn if-logged-in" type="button" href="#sync_guide"
+								onclick="return show_panel(this);">Contacts/Calendar</button></li>
+						<li><button class="nav-item me-1 me-xl-4 btn if-logged-in-admin" type="button" href="#web"
+								onclick="return show_panel(this);">Web</button></li>
+						<li><button class="nav-item btn btn-secondary if-logged-in" type="button"
+								onclick="do_logout(); return false;"><b>Logout</b></button></li>
+					</ul>
+				</div>
+			</div>
+		</div>
 
-      <div id="panel_users" class="admin_panel">
-      {% include "users.html" %}
-      </div>
+		<div class="container">
+			<div id="panel_smtp_relays" class="admin_panel">
+				{% include "smtp-relays.html" %}
+			</div>
 
-      <div id="panel_aliases" class="admin_panel">
-      {% include "aliases.html" %}
-      </div>
+			<div id="panel_welcome" class="admin_panel">
+				{% include "welcome.html" %}
+			</div>
 
-      <div id="panel_sync_guide" class="admin_panel">
-      {% include "sync-guide.html" %}
-      </div>
+			<div id="panel_system_status" class="admin_panel">
+				{% include "system-status.html" %}
+			</div>
 
-      <div id="panel_web" class="admin_panel">
-      {% include "web.html" %}
-      </div>
+			<div id="panel_system_backup" class="admin_panel">
+				{% include "system-backup.html" %}
+			</div>
 
-      <div id="panel_tls" class="admin_panel">
-      {% include "ssl.html" %}
-      </div>
+			<div id="panel_external_dns" class="admin_panel">
+				{% include "external-dns.html" %}
+			</div>
 
-      <hr>
+			<div id="panel_custom_dns" class="admin_panel">
+				{% include "custom-dns.html" %}
+			</div>
 
-      <footer>
-        <p>This is a <a href="https://mailinabox.email">Mail-in-a-Box</a>.</p>
-      </footer>
-    </div> <!-- /container -->
+			<div id="panel_pgp_keyring" class="admin_panel">
+				{% include "pgp-keyring.html" %}
+			</div>
 
-        <div id="ajax_loading_indicator" style="display: none; position: fixed; left: 0; top: 0; width: 100%; height: 100%; z-index: 100000; text-align: center; background-color: rgba(255,255,255,.75)">
-          <div style="margin: 20% auto">
-            <div><span class="fa fa-spinner fa-pulse"></span></div>
-            <div>Loading...</div>
-          </div>
-        </div>
+			<div id="panel_wkd" class="admin_panel">
+				{% include "wkd.html" %}
+			</div>
 
-        <div id="global_modal" class="modal fade" tabindex="-1" role="dialog" aria-labelledby="errorModalTitle" aria-hidden="true">
-          <div class="modal-dialog modal-sm">
-            <div class="modal-content">
-              <div class="modal-header">
-                <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
-                <h4 class="modal-title" id="errorModalTitle"> </h4>
-              </div>
-              <div class="modal-body">
-                <p> </p>
-              </div>
-              <div class="modal-footer">
-                <button type="button" class="btn btn-default" data-dismiss="modal">OK</button>
-                <button type="button" class="btn btn-danger" data-dismiss="modal">Yes</button>
-              </div>
-            </div>
-          </div>
-        </div>
+			<div id="panel_manage-password" class="admin_panel">
+				{% include "manage-password.html" %}
+			</div>
 
-        <script src="/admin/assets/jquery.min.js"></script>
-        <script src="/admin/assets/bootstrap/js/bootstrap.min.js"></script>
+			<div id="panel_mfa" class="admin_panel">
+				{% include "mfa.html" %}
+			</div>
 
-        <script>
-var global_modal_state = null;
-var global_modal_funcs = null;
+			<div id="panel_login" class="admin_panel">
+				{% include "login.html" %}
+			</div>
 
-$(function() {
-  $('#global_modal').on('shown.bs.modal', function (e) {
-    // set focus to first input in the global modal's body
-    var input = $('#global_modal .modal-body input');
-    if (input.length > 0) $(input[0]).focus();
-  })
-  $('#global_modal .btn-danger').click(function() {
-    // Don't take action now. Wait for the modal to be totally hidden
-    // so that we don't attempt to show another modal while this one
-    // is closing.
-    global_modal_state = 0; // OK
-  })
-  $('#global_modal .btn-default').click(function() {
-    global_modal_state = 1; // Cancel
-  })
-  $('#global_modal').on('hidden.bs.modal', function (e) {
-    // do the cancel function
-    if (global_modal_state == null) global_modal_state = 1; // cancel if the user hit ESC or clicked outside of the modal
-    if (global_modal_funcs && global_modal_funcs[global_modal_state])
-      global_modal_funcs[global_modal_state]();
-  })
-})
+			<div id="panel_mail-guide" class="admin_panel">
+				{% include "mail-guide.html" %}
+			</div>
 
-function show_modal_error(title, message, callback) {
-  $('#global_modal h4').text(title);
-  $('#global_modal .modal-body').html("<p/>");
-  if (typeof question == 'string') {
-    $('#global_modal p').text(message);
-    $('#global_modal .modal-dialog').addClass("modal-sm");
-  } else {
-    $('#global_modal p').html("").append(message);
-    $('#global_modal .modal-dialog').removeClass("modal-sm");
-  }
-  $('#global_modal .btn-default').show().text("OK");
-  $('#global_modal .btn-danger').hide();
-  global_modal_funcs = [callback, callback];
-  global_modal_state = null;
-  $('#global_modal').modal({});
-  return false; // handy when called from onclick
-}
+			<div id="panel_users" class="admin_panel">
+				{% include "users.html" %}
+			</div>
 
-function show_modal_confirm(title, question, verb, yes_callback, cancel_callback) {
-  $('#global_modal h4').text(title);
-  if (typeof question == 'string') {
-    $('#global_modal .modal-dialog').addClass("modal-sm");
-    $('#global_modal .modal-body').html("<p/>");
-    $('#global_modal p').text(question);
-  } else {
-    $('#global_modal .modal-dialog').removeClass("modal-sm");
-    $('#global_modal .modal-body').html("").append(question);
-  }
-  if (typeof verb == 'string') {
-    $('#global_modal .btn-default').show().text("Cancel");
-    $('#global_modal .btn-danger').show().text(verb);
-  } else {
-    $('#global_modal .btn-default').show().text(verb[1]);
-    $('#global_modal .btn-danger').show().text(verb[0]);
-  }
-  global_modal_funcs = [yes_callback, cancel_callback];
-  global_modal_state = null;
-  $('#global_modal').modal({});
-  return false; // handy when called from onclick
-}
+			<div id="panel_aliases" class="admin_panel">
+				{% include "aliases.html" %}
+			</div>
 
-var ajax_num_executing_requests = 0;
-function ajax_with_indicator(options) {
-  setTimeout("if (ajax_num_executing_requests > 0) $('#ajax_loading_indicator').fadeIn()", 100);
-  function hide_loading_indicator() {
-    ajax_num_executing_requests--;
-    if (ajax_num_executing_requests == 0)
-      $('#ajax_loading_indicator').stop(true).hide(); // stop() prevents an ongoing fade from causing the thing to be shown again after this call
-  }
-  var old_success = options.success;
-  var old_error = options.error;
-  options.success = function(data) {
-    hide_loading_indicator();
-    if (data.status == "error")
-      show_modal_error("Error", data.message);
-    else if (old_success)
-      old_success(data);
-  };
-  options.error = function(jqxhr) {
-    hide_loading_indicator();
-    if (!old_error)
-      show_modal_error("Error", "Something went wrong, sorry.")
-    else
-      old_error(jqxhr.responseText, jqxhr);
-  };
-  ajax_num_executing_requests++;
-  $.ajax(options);
-  return false; // handy when called from onclick
-}
+			<div id="panel_sync_guide" class="admin_panel">
+				{% include "sync-guide.html" %}
+			</div>
 
-var api_credentials = ["", ""];
-function api(url, method, data, callback, callback_error) {
-  // from http://www.webtoolkit.info/javascript-base64.html
-  function base64encode(input) {
-    _keyStr = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=";
-    var output = "";
-    var chr1, chr2, chr3, enc1, enc2, enc3, enc4;
-    var i = 0;
-    while (i < input.length) {
-        chr1 = input.charCodeAt(i++);
-        chr2 = input.charCodeAt(i++);
-        chr3 = input.charCodeAt(i++);
-        enc1 = chr1 >> 2;
-        enc2 = ((chr1 & 3) << 4) | (chr2 >> 4);
-        enc3 = ((chr2 & 15) << 2) | (chr3 >> 6);
-        enc4 = chr3 & 63;
-        if (isNaN(chr2)) {
-            enc3 = enc4 = 64;
-        } else if (isNaN(chr3)) {
-            enc4 = 64;
-        }
-        output = output +
-        _keyStr.charAt(enc1) + _keyStr.charAt(enc2) +
-        _keyStr.charAt(enc3) + _keyStr.charAt(enc4);
-    }
+			<div id="panel_web" class="admin_panel">
+				{% include "web.html" %}
+			</div>
 
-    return output;
-  }
+			<div id="panel_tls" class="admin_panel">
+				{% include "ssl.html" %}
+			</div>
 
-  function default_error(text, xhr) {
-    if (xhr.status != 403) // else handled below
-      show_modal_error("Error", "Something went wrong, sorry.")
-  }
+			<div id="panel_munin" class="admin_panel">
+				{% include "munin.html" %}
+			</div>
 
-  ajax_with_indicator({
-    url: "/admin" + url,
-    method: method,
-    cache: false,
-    data: data,
+			<hr>
 
-    // the custom DNS api sends raw POST/PUT bodies --- prevent URL-encoding
-    processData: typeof data != "string",
-    mimeType: typeof data == "string" ? "text/plain; charset=ascii" : null,
+			<footer>
+				<p>This is a <a href="https://power-mailinabox.net">Power Mail-in-a-Box</a>.</p>
+			</footer>
+		</div> <!-- /container -->
 
-    beforeSend: function(xhr) {
-      // We don't store user credentials in a cookie to avoid the hassle of CSRF
-      // attacks. The Authorization header only gets set in our AJAX calls triggered
-      // by user actions.
-      xhr.setRequestHeader(
-        'Authorization',
-        'Basic ' + base64encode(api_credentials[0] + ':' + api_credentials[1]));
-    },
-    success: callback,
-    error: callback_error || default_error,
-    statusCode: {
-      403: function(xhr) {
-        // Credentials are no longer valid. Try to login again.
-        var p = current_panel;
-        show_panel('login');
-        switch_back_to_panel = p;
-      }
-    }
-  })
-}
+		<div id="ajax_loading_indicator"
+			style="display: none; position: fixed; left: 0; top: 0; width: 100%; height: 100%; z-index: 100000; text-align: center; background-color: rgba(0,0,0,.8)">
+			<div class="justify-content-center" style="margin: 20%;">
+				<div class="spinner-border text-light" role="status" style="width: 4rem; height: 4rem;"></div>
+				<div class="text-light display-5">Loading... please wait!</div>
+			</div>
+		</div>
 
-var current_panel = null;
-var switch_back_to_panel = null;
-function show_panel(panelid) {
-  if (panelid.getAttribute)
-    // we might be passed an HTMLElement <a>.
-    panelid = panelid.getAttribute('href').substring(1);
+		<div id="global_modal" class="modal fade" tabindex="-1" role="dialog" aria-labelledby="errorModalTitle"
+			aria-hidden="true">
+			<div class="modal-dialog modal-lg">
+				<div class="modal-content">
+					<div class="modal-header">
+						<h4 class="modal-title" id="errorModalTitle"> </h4>
+						<button type="button" class="btn-close" data-bs-dismiss="modal" aria-hidden="true"></button>
+					</div>
+					<div class="modal-body">
+						<p> </p>
+					</div>
+					<div class="modal-footer">
+						<button type="button" class="btn btn-default" data-bs-dismiss="modal">OK</button>
+						<button type="button" class="btn btn-danger" data-bs-dismiss="modal">Yes</button>
+					</div>
+				</div>
+			</div>
+		</div>
 
-  $('.admin_panel').hide();
-  $('#panel_' + panelid).show();
-  if (typeof localStorage != 'undefined')
-    localStorage.setItem("miab-cp-lastpanel", panelid);
-  if (window["show_" + panelid])
-    window["show_" + panelid]();
+		<style>
+			.darkmode,
+			.darkmode .form-control,
+			.darkmode .form-select {
+				background-color: rgb(20, 20, 20) !important;
+			}
 
-  current_panel = panelid;
-  switch_back_to_panel = null;
+			.darkmode .btn-light,
+			.darkmode .bg-light,
+			.darkmode .dropdown-menu,
+			.darkmode .input-group-text,
+			.darkmode .modal-content,
+			.darkmode .form-control:disabled,
+			.darkmode .form-select:disabled {
+				background-color: rgb(36, 36, 36) !important;
+			}
 
-  return false; // when called from onclick, cancel navigation
-}
+			.darkmode .form-control,
+			.darkmode .form-select,
+			.darkmode .btn-light,
+			.darkmode .input-group-text,
+			.darkmode .table,
+			.darkmode .tr,
+			.darkmode .thead,
+			.darkmode .card,
+			.darkmode .modal-header,
+			.darkmode .modal-footer {
+				border-color: rgb(56, 56, 56) !important;
+			}
 
-$(function() {
-  // Recall saved user credentials.
-  if (typeof sessionStorage != 'undefined' && sessionStorage.getItem("miab-cp-credentials"))
-    api_credentials = sessionStorage.getItem("miab-cp-credentials").split(":");
-  else if (typeof localStorage != 'undefined' && localStorage.getItem("miab-cp-credentials"))
-    api_credentials = localStorage.getItem("miab-cp-credentials").split(":");
+			.darkmode h3 {
+				border-color: rgb(206, 212, 218) !important;
+			}
 
-  // Recall what the user was last looking at.
-  if (typeof localStorage != 'undefined' && localStorage.getItem("miab-cp-lastpanel")) {
-    show_panel(localStorage.getItem("miab-cp-lastpanel"));
-  } else {
-    show_panel('login');
-  }
-})
+			.darkmode .table>:not(:first-child) {
+				border-top: 2px solid rgb(206, 212, 218) !important;
+			}
 
-        </script>
-    </body>
+			.darkmode a,
+			.darkmode b,
+			.darkmode p,
+			.darkmode label,
+			.darkmode span,
+			.darkmode small,
+			.darkmode div,
+			.darkmode td,
+			.darkmode hr,
+			.darkmode .form-control,
+			.darkmode .form-select {
+				color: rgb(206, 212, 218);
+			}
+
+			.darkmode .btn,
+			.darkmode h1,
+			.darkmode h2,
+			.darkmode h3,
+			.darkmode h4,
+			.darkmode h5,
+			.darkmode .navbar-brand,
+			.darkmode .dropdown-menu,
+			.darkmode th,
+			.darkmode .navbar-brand>span,
+			.darkmode .navbar-brand>b,
+			.darkmode .nav-item>*,
+			.darkmode .input-group-text,
+			.darkmode .input-group-text>* {
+				color: rgb(255, 255, 255) !important;
+			}
+
+			.darkmode .btn-close,
+			.darkmode .navbar-toggler {
+				filter: invert(97%) sepia(2%) saturate(1242%) hue-rotate(180deg) brightness(93%) contrast(82%);
+			}
+
+			.darkmode .status-error .status-text {
+				color: rgb(255, 191, 191);
+			}
+
+			.darkmode .status-warning .status-text {
+				color: rgb(255, 241, 191);
+			}
+
+			.darkmode .status-ok .status-text {
+				color: rgb(191, 255, 191);
+			}
+
+			.darkmode .status-na .status-text {
+				color: rgb(155, 155, 155);
+			}
+		</style>
+
+		<script src="/admin/assets/jquery.min.js"></script>
+		<script src="/admin/assets/bootstrap/js/bootstrap.bundle.min.js"></script>
+
+		<script>
+			var global_modal_state = null;
+			var global_modal_funcs = null;
+
+			const toggle = document.getElementById("toggle-theme")
+			function set_dark_mode(isdark) {
+				if (isdark) {
+					$("body").addClass("darkmode")
+				} else {
+					$("body").removeClass("darkmode")
+				}
+			}
+
+			if (typeof localStorage != 'undefined' && localStorage.getItem("miab-theme-preference")) {
+				let themepref = localStorage.getItem("miab-theme-preference")
+				if (themepref === "dark") {
+					toggle.checked = true
+					set_dark_mode(true)
+				} else if (themepref === "light") {
+					set_dark_mode(false)
+				}
+			} else if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
+				// Toggle dark mode right now
+				toggle.checked = true
+				set_dark_mode(true)
+			}
+
+			$("#toggle-theme").change(() => {
+				if (typeof localStorage != 'undefined') {
+					localStorage.setItem("miab-theme-preference", toggle.checked ? "dark" : "light")
+				}
+				set_dark_mode(toggle.checked)
+			})
+
+			$(function () {
+				$('#global_modal').on('shown.bs.modal', function (e) {
+					// set focus to first input in the global modal's body
+					var input = $('#global_modal .modal-body input');
+					if (input.length > 0) $(input[0]).focus();
+				})
+				$('#global_modal .btn-danger').click(function () {
+					// Don't take action now. Wait for the modal to be totally hidden
+					// so that we don't attempt to show another modal while this one
+					// is closing.
+					global_modal_state = 0; // OK
+				})
+				$('#global_modal .btn-default').click(function () {
+					global_modal_state = 1; // Cancel
+				})
+				$('#global_modal').on('hidden.bs.modal', function (e) {
+					// do the cancel function
+					if (global_modal_state == null) global_modal_state = 1; // cancel if the user hit ESC or clicked outside of the modal
+					if (global_modal_funcs && global_modal_funcs[global_modal_state])
+						global_modal_funcs[global_modal_state]();
+				})
+			})
+
+			const global_modal = new bootstrap.Modal($("#global_modal"))
+
+			function show_modal_error(title, message, callback) {
+				$('#global_modal h4').text(title);
+				$('#global_modal .modal-body').html("<p/>");
+				if (typeof question == 'string') {
+					$('#global_modal p').text(message);
+				} else {
+					$('#global_modal p').html("").append(message);
+				}
+				$('#global_modal .btn-default').show().text("OK");
+				$('#global_modal .btn-danger').hide();
+				global_modal_funcs = [callback, callback];
+				global_modal_state = null;
+				global_modal.show();
+				return false; // handy when called from onclick
+			}
+
+			function show_modal_confirm(title, question, verb, yes_callback, cancel_callback) {
+				$('#global_modal h4').text(title);
+				if (typeof question == 'string') {
+					$('#global_modal .modal-body').html("<p/>");
+					$('#global_modal p').text(question);
+				} else {
+					$('#global_modal .modal-body').html("").append(question);
+				}
+				if (typeof verb == 'string') {
+					$('#global_modal .btn-default').show().text("Cancel");
+					$('#global_modal .btn-danger').show().text(verb);
+				} else {
+					$('#global_modal .btn-default').show().text(verb[1]);
+					$('#global_modal .btn-danger').show().text(verb[0]);
+				}
+				global_modal_funcs = [yes_callback, cancel_callback];
+				global_modal_state = null;
+				global_modal.show();
+				return false; // handy when called from onclick
+			}
+
+			var ajax_num_executing_requests = 0;
+			function ajax_with_indicator(options) {
+				setTimeout("if (ajax_num_executing_requests > 0) $('#ajax_loading_indicator').fadeIn()", 100);
+				function hide_loading_indicator() {
+					ajax_num_executing_requests--;
+					if (ajax_num_executing_requests == 0)
+						$('#ajax_loading_indicator').stop(true).hide(); // stop() prevents an ongoing fade from causing the thing to be shown again after this call
+				}
+				var old_success = options.success;
+				var old_error = options.error;
+				options.success = function (data) {
+					hide_loading_indicator();
+					if (data.status == "error")
+						show_modal_error("Error", data.message);
+					else if (old_success)
+						old_success(data);
+				};
+				options.error = function (jqxhr) {
+					hide_loading_indicator();
+					if (!old_error)
+						show_modal_error("Error", "Something went wrong, sorry.")
+					else
+						old_error(jqxhr.responseText, jqxhr);
+				};
+				ajax_num_executing_requests++;
+				$.ajax(options);
+				return false; // handy when called from onclick
+			}
+
+			var api_credentials = null;
+			function api(url, method, data, callback, callback_error, headers) {
+				// from http://www.webtoolkit.info/javascript-base64.html
+				function base64encode(input) {
+					_keyStr = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=";
+					var output = "";
+					var chr1, chr2, chr3, enc1, enc2, enc3, enc4;
+					var i = 0;
+					while (i < input.length) {
+						chr1 = input.charCodeAt(i++);
+						chr2 = input.charCodeAt(i++);
+						chr3 = input.charCodeAt(i++);
+						enc1 = chr1 >> 2;
+						enc2 = ((chr1 & 3) << 4) | (chr2 >> 4);
+						enc3 = ((chr2 & 15) << 2) | (chr3 >> 6);
+						enc4 = chr3 & 63;
+						if (isNaN(chr2)) {
+							enc3 = enc4 = 64;
+						} else if (isNaN(chr3)) {
+							enc4 = 64;
+						}
+						output = output +
+							_keyStr.charAt(enc1) + _keyStr.charAt(enc2) +
+							_keyStr.charAt(enc3) + _keyStr.charAt(enc4);
+					}
+
+					return output;
+				}
+
+				function default_error(text, xhr) {
+					if (xhr.status != 403) // else handled below
+						show_modal_error("Error", "Something went wrong, sorry.")
+				}
+
+				ajax_with_indicator({
+					url: "/admin" + url,
+					method: method,
+					cache: false,
+					data: data,
+					headers: headers,
+					// the custom DNS api sends raw POST/PUT bodies --- prevent URL-encoding
+					processData: typeof data != "string",
+					mimeType: typeof data == "string" ? "text/plain; charset=ascii" : null,
+
+					beforeSend: function (xhr) {
+						// We don't store user credentials in a cookie to avoid the hassle of CSRF
+						// attacks. The Authorization header only gets set in our AJAX calls triggered
+						// by user actions.
+						if (api_credentials)
+							xhr.setRequestHeader(
+								'Authorization',
+								'Basic ' + base64encode(api_credentials.username + ':' + api_credentials.session_key));
+					},
+					success: callback,
+					error: callback_error || default_error,
+					statusCode: {
+						403: function (xhr) {
+							// Credentials are no longer valid. Try to login again.
+							do_logout();
+							switch_back_to_panel = null;
+						}
+					}
+				})
+			}
+
+			var current_panel = null;
+			var switch_back_to_panel = null;
+
+			function do_logout() {
+				// Clear the session from the backend.
+				api("/logout", "POST");
+
+				// Forget the token.
+				api_credentials = null;
+				if (typeof localStorage != 'undefined')
+					localStorage.removeItem("miab-cp-credentials");
+				if (typeof sessionStorage != 'undefined')
+					sessionStorage.removeItem("miab-cp-credentials");
+
+				// Return to the start.
+				show_panel('login');
+
+				// Reset menus.
+				show_hide_menus();
+			}
+
+			function show_panel(panelid) {
+				if (panelid.getAttribute)
+					// we might be passed an HTMLElement <a>.
+					panelid = panelid.getAttribute('href').substring(1);
+
+				$('.admin_panel').hide();
+				$('#panel_' + panelid).show();
+				if (typeof localStorage != 'undefined')
+					localStorage.setItem("miab-cp-lastpanel", panelid);
+				if (window["show_" + panelid])
+					window["show_" + panelid]();
+
+				current_panel = panelid;
+				switch_back_to_panel = null;
+
+				return false; // when called from onclick, cancel navigation
+			}
+
+			$(function () {
+				// Recall saved user credentials.
+				try {
+					if (typeof sessionStorage != 'undefined' && sessionStorage.getItem("miab-cp-credentials"))
+						api_credentials = JSON.parse(sessionStorage.getItem("miab-cp-credentials"));
+					else if (typeof localStorage != 'undefined' && localStorage.getItem("miab-cp-credentials"))
+						api_credentials = JSON.parse(localStorage.getItem("miab-cp-credentials"));
+				} catch (_) {
+				}
+
+				// Toggle menu state.
+				show_hide_menus();
+
+				// Recall what the user was last looking at.
+				if (api_credentials != null && typeof localStorage != 'undefined' && localStorage.getItem("miab-cp-lastpanel")) {
+					show_panel(localStorage.getItem("miab-cp-lastpanel"));
+				} else if (api_credentials != null) {
+					show_panel('welcome');
+				} else {
+					show_panel('login');
+				}
+			})
+
+		</script>
+	</body>
 </html>

management/templates/login.html

@@ -1,143 +1,201 @@
-<h1 style="margin: 1em; text-align: center">{{hostname}}</h1>
+<style>
+	.title {
+		margin: 0.5em;
+		text-align: center;
+	}
+
+	.subtitle {
+		margin: 1em;
+		text-align: center;
+	}
+
+	.login {
+		margin: 0 auto;
+		max-width: 32em;
+	}
+
+	.login #loginOtp {
+		display: none;
+	}
+
+	#loginForm.is-twofactor #loginOtp {
+		display: block
+	}
+</style>
+
+<h1 class="title">{{hostname}}</h1>
 
 {% if no_users_exist or no_admins_exist %}
 <div class="row">
-<div class="col-md-offset-2 col-md-8">
-  {% if no_users_exist %}
-  <p class="text-danger">There are no users on this system! To make an administrative user,
-  log into this machine using SSH (like when you first set it up) and run:</p>
-  <pre>cd mailinabox
-sudo tools/mail.py user add me@{{hostname}}
-sudo tools/mail.py user make-admin me@{{hostname}}</pre>
-  {% else %}
-  <p class="text-danger">There are no administrative users on this system! To make an administrative user,
-  log into this machine using SSH (like when you first set it up) and run:</p>
-  <pre>cd mailinabox
-sudo tools/mail.py user make-admin me@{{hostname}}</pre>
-  {% endif %}
-  <hr>
+	<div class="col-12">
+		<hr>
+		{% if no_users_exist %}
+		<p class="text-danger">There are no users on this system! To make an administrative user,
+			log into this machine using SSH (like when you first set it up) and run:</p>
+		<pre>cd mailinabox
+sudo management/cli.py user add me@{{hostname}}
+sudo management/cli.py user make-admin me@{{hostname}}</pre>
+		{% else %}
+		<p class="text-danger">There are no administrative users on this system! To make an administrative user,
+			log into this machine using SSH (like when you first set it up) and run:</p>
+		<pre>cd mailinabox
+sudo management/cli.py user make-admin me@{{hostname}}</pre>
+		{% endif %}
+		<hr>
+	</div>
 </div>
-</div>  
 {% endif %}
 
-<p style="margin: 2em; text-align: center;">Log in here for your Mail-in-a-Box control panel.</p>
+<p class="subtitle">Log in here for your Mail-in-a-Box control panel.</p>
 
-<div style="margin: 0 auto; max-width: 32em;">
-  <form class="form-horizontal" role="form" onsubmit="do_login(); return false;">
-    <div class="form-group">
-      <label for="inputEmail3" class="col-sm-3 control-label">Email</label>
-      <div class="col-sm-9">
-        <input name="email" type="email" class="form-control" id="loginEmail" placeholder="Email">
-      </div>
-    </div>
-    <div class="form-group">
-      <label for="inputPassword3" class="col-sm-3 control-label">Password</label>
-      <div class="col-sm-9">
-        <input name="password" type="password" class="form-control" id="loginPassword" placeholder="Password">
-      </div>
-    </div>
-    <div class="form-group">
-      <div class="col-sm-offset-3 col-sm-9">
-        <div class="checkbox">
-          <label>
-            <input name='remember' type="checkbox" id="loginRemember"> Remember me
-          </label>
-        </div>
-      </div>
-    </div>
-    <div class="form-group">
-      <div class="col-sm-offset-3 col-sm-9">
-        <button type="submit" class="btn btn-default">Sign in</button>
-      </div>
-    </div>
-  </form>
+<div class="login">
+	<form id="loginForm" class="form-horizontal" role="form" onsubmit="do_login(); return false;" method="get">
+		<div class="form-floating mb-3">
+			<input type="email" class="form-control col-sm-12" id="loginEmail" placeholder="user@example.com">
+			<label for="loginEmail">Email</label>
+		</div>
+		<div class="form-floating mb-3">
+			<input type="password" class="form-control col-sm-12" id="loginPassword" placeholder="password">
+			<label for="loginPassword">Password</label>
+		</div>
+		<div class="form-floating mb-3" id="loginOtp">
+			<input type="text" class="form-control" id="loginOtpInput" placeholder="000000" autocomplete="off">
+			<label for="loginOtpInput">TOTP Code</label>
+			<div class="help-block" style="margin-top: 5px; font-size: 90%">Enter the six-digit code generated by your two
+				factor authentication app.</div>
+		</div>
+		<div class="form-group mb-3">
+			<div class="ms-auto">
+				<input type="checkbox" class="form-check-input" id="loginRemember">
+				<label class="form-check-label" for="loginRemember">Remember Me</label>
+			</div>
+		</div>
+		<div class="form-group">
+			<div class="container-fluid">
+				<button type="submit" class="btn btn-primary col-12">Sign in</button>
+			</div>
+		</div>
+	</form>
 </div>
 
-
 <script>
-function do_login() {
-  if ($('#loginEmail').val() == "") {
-    show_modal_error("Login Failed", "Enter your email address.", function() {
-	$('#loginEmail').focus();
-    });
-    return false;
-  }
-  if ($('#loginPassword').val() == "") {
-    show_modal_error("Login Failed", "Enter your email password.", function() {
-        $('#loginPassword').focus();
-    });
-    return false;
-  }
+	function do_login() {
+		if ($('#loginEmail').val() == "") {
+			show_modal_error("Login Failed", "Enter your email address.", function () {
+				$('#loginEmail').focus();
+			});
+			return false;
+		}
 
-  // Exchange the email address & password for an API key.
-  api_credentials = [$('#loginEmail').val(), $('#loginPassword').val()]
+		if ($('#loginPassword').val() == "") {
+			show_modal_error("Login Failed", "Enter your email password.", function () {
+				$('#loginPassword').focus();
+			});
+			return false;
+		}
 
-  api(
-  "/me",
-  "GET",
-  { },
-  function(response){ 
-    // This API call always succeeds. It returns a JSON object indicating
-    // whether the request was authenticated or not.
-    if (response.status != "ok") {
-      // Show why the login failed.
-      show_modal_error("Login Failed", response.reason)
+		// Exchange the email address & password for an API key.
+		api_credentials = { username: $('#loginEmail').val(), session_key: $('#loginPassword').val() }
 
-      // Reset any saved credentials.
-      do_logout();
+		api(
+			"/login",
+			"POST",
+			{},
+			function (response) {
+				// This API call always succeeds. It returns a JSON object indicating
+				// whether the request was authenticated or not.
+				if (response.status != 'ok') {
+					if (response.status === 'missing-totp-token' || (response.status === 'invalid' && response.reason == 'invalid-totp-token')) {
+						$('#loginForm').addClass('is-twofactor');
+						if (response.reason === "invalid-totp-token") {
+							show_modal_error("Login Failed", "Incorrect two factor authentication token.");
+						} else {
+							setTimeout(() => {
+								$('#loginOtpInput').focus();
+							});
+						}
+					} else {
+						$('#loginForm').removeClass('is-twofactor');
 
-    } else if (!("api_key" in response)) {
-      // Login succeeded but user might not be authorized!
-      show_modal_error("Login Failed", "You are not an administrator on this system.")
+						// Show why the login failed.
+						show_modal_error("Login Failed", response.reason)
 
-      // Reset any saved credentials.
-      do_logout();
+						// Reset any saved credentials.
+						do_logout();
+					}
+				} else if (!("api_key" in response)) {
+					// Login succeeded but user might not be authorized!
+					show_modal_error("Login Failed", "You are not an administrator on this system.")
 
-    } else {
-      // Login succeeded.
+					// Reset any saved credentials.
+					do_logout();
 
-      // Save the new credentials.
-      api_credentials = [response.email, response.api_key];
+				} else {
+					// Login succeeded.
 
-      // Try to wipe the username/password information.
-      $('#loginEmail').val('');
-      $('#loginPassword').val('');
+					// Save the new credentials.
+					api_credentials = {
+						username: response.email,
+						session_key: response.api_key,
+						privileges: response.privileges
+					};
 
-      // Remember the credentials.
-      if (typeof localStorage != 'undefined' && typeof sessionStorage != 'undefined') {
-        if ($('#loginRemember').val()) {
-          localStorage.setItem("miab-cp-credentials", api_credentials.join(":"));
-          sessionStorage.removeItem("miab-cp-credentials");
-        } else {
-          localStorage.removeItem("miab-cp-credentials");
-          sessionStorage.setItem("miab-cp-credentials", api_credentials.join(":"));
-        }
-      }
+					// Try to wipe the username/password information.
+					$('#loginEmail').val('');
+					$('#loginPassword').val('');
+					$('#loginOtpInput').val('');
+					$('#loginForm').removeClass('is-twofactor');
 
-      // Open the next panel the user wants to go to. Do this after the XHR response
-      // is over so that we don't start a new XHR request while this one is finishing,
-      // which confuses the loading indicator.
-      setTimeout(function() { show_panel(!switch_back_to_panel || switch_back_to_panel == "login" ? 'system_status' : switch_back_to_panel) }, 300);
-    }
-  })
-}
+					// Remember the credentials.
+					if (typeof localStorage != 'undefined' && typeof sessionStorage != 'undefined') {
+						if ($('#loginRemember').val()) {
+							localStorage.setItem("miab-cp-credentials", JSON.stringify(api_credentials));
+							sessionStorage.removeItem("miab-cp-credentials");
+						} else {
+							localStorage.removeItem("miab-cp-credentials");
+							sessionStorage.setItem("miab-cp-credentials", JSON.stringify(api_credentials));
+						}
+					}
 
-function do_logout() {
-  api_credentials = ["", ""];
-  if (typeof localStorage != 'undefined')
-    localStorage.removeItem("miab-cp-credentials");
-  if (typeof sessionStorage != 'undefined')
-    sessionStorage.removeItem("miab-cp-credentials");
-  show_panel('login');
-}
+					// Toggle menus.
+					show_hide_menus();
 
-function show_login() {
-  $('#loginEmail,#loginPassword').each(function() {
-    var input = $(this);
-    if (!$.trim(input.val())) {
-      input.focus();
-      return false;
-    }
-  });
-}
+					// Open the next panel the user wants to go to. Do this after the XHR response
+					// is over so that we don't start a new XHR request while this one is finishing,
+					// which confuses the loading indicator.
+					setTimeout(function () { show_panel(!switch_back_to_panel || switch_back_to_panel == "login" ? 'welcome' : switch_back_to_panel) }, 300);
+				}
+			},
+			undefined,
+			{
+				'x-auth-token': $('#loginOtpInput').val()
+			});
+	}
+
+	function show_login() {
+		$('#loginForm').removeClass('is-twofactor');
+		$('#loginOtpInput').val('');
+		$('#loginEmail,#loginPassword').each(function () {
+			var input = $(this);
+			if (!$.trim(input.val())) {
+				input.focus();
+				return false;
+			}
+		});
+	}
+
+	function show_hide_menus() {
+		var is_logged_in = (api_credentials != null);
+		var privs = api_credentials ? api_credentials.privileges : [];
+		$('.if-logged-in').toggle(is_logged_in);
+		$('.if-logged-in-admin, .if-logged-in-not-admin').toggle(false);
+		if (is_logged_in) {
+			$('.if-logged-in-not-admin').toggle(true);
+			privs.forEach(function (priv) {
+				$('.if-logged-in-' + priv).toggle(true);
+				$('.if-logged-in-not-' + priv).toggle(false);
+			});
+		}
+		$('.if-not-logged-in').toggle(!is_logged_in);
+	}
 </script>

management/templates/mail-guide.html

@@ -1,4 +1,9 @@
-<style>#panel_mail-guide table.table { width: auto; margin-left: .5em; }</style>
+<style>
+	#panel_mail-guide table.table {
+		width: auto;
+		margin-left: .5em;
+	}
+</style>
 
 <div>
 	<h2 style="margin-bottom: 0">Checking and Sending Mail</h2>
@@ -8,66 +13,121 @@
 			<h3>Webmail</h3>
 
 			<p>Webmail lets you check your email from any web browser. Your webmail site is:</p>
-			<p style="margin-left: 2em"><strong><a href="https://{{hostname}}/mail">https://{{hostname}}/mail</a></strong></p>
+			<p style="margin-left: 2em"><strong><a
+						href="https://{{hostname}}/mail">https://{{hostname}}/mail</a></strong></p>
 			<p>Your username is your whole email address.</p>
 
 
 			<h3>Mobile/desktop apps</h3>
 
-				<h4>Automatic configuration</h4>
+			<h4>Automatic configuration</h4>
 
-					<p>iOS and OS X only: Open <a style="font-weight: bold" href="https://{{hostname}}/mailinabox.mobileconfig">this configuration link</a> on your iOS device or on your Mac desktop to easily set up mail (IMAP/SMTP), Contacts, and Calendar. Your username is your whole email address.</p>
-	
-				<h4>Manual configuration</h4>
+			<p>iOS and OS X only: Open <a style="font-weight: bold"
+					href="https://{{hostname}}/mailinabox.mobileconfig">this configuration link</a> on your iOS device
+				or on your Mac desktop to easily set up mail (IMAP/SMTP), Contacts, and Calendar. Your username is your
+				whole email address.</p>
 
-					<p>Use the following settings when you set up your email on your phone, desktop, or other device:</p>
+			<h4>Manual configuration</h4>
 
-					<table class="table">
-					<thead>
-						<tr><th>Option</th> <th>Value</th></tr>
-					</thead>
-					<tr><th>Protocol/Method</th> <td>IMAP</td></tr>
-					<tr><th>Mail server</th> <td>{{hostname}}</td>
-					<tr><th>IMAP Port</th> <td>993</td></tr>
-					<tr><th>IMAP Security</th> <td>SSL or TLS</td></tr>
-					<tr><th>SMTP Port</th> <td>587</td></tr>
-					<tr><th>SMTP Security</td> <td>STARTTLS <small>(&ldquo;always&rdquo; or &ldquo;required&rdquo;, if prompted)</small></td></tr>
-					<tr><th>Username:</th> <td>Your whole email address.</td></tr>
-					<tr><th>Password:</th> <td>Your mail password.</td></tr>
-					</table>
+			<p>Use the following settings when you set up your email on your phone, desktop, or other device:</p>
 
-					<p>In addition to setting up your email, you&rsquo;ll also need to set up <a href="#sync_guide" onclick="return show_panel(this);">contacts and calendar synchronization</a> separately.</p>
+			<table class="table">
+				<caption></caption>
+				<thead>
+					<tr>
+						<th>Option</th>
+						<th>Value</th>
+					</tr>
+				</thead>
+				<tr>
+					<th>Protocol/Method</th>
+					<td>IMAP</td>
+				</tr>
+				<tr>
+					<th>Mail server</th>
+					<td>{{hostname}}</td>
+				<tr>
+					<th>IMAP Port</th>
+					<td>993</td>
+				</tr>
+				<tr>
+					<th>IMAP Security</th>
+					<td>SSL or TLS</td>
+				</tr>
+				<tr>
+					<th>SMTP Port</th>
+					<td>465</td>
+				</tr>
+				<tr>
+					<th>SMTP Security</td>
+					<td>SSL or TLS</td>
+				</tr>
+				<tr>
+					<th>Username:</th>
+					<td>Your whole email address.</td>
+				</tr>
+				<tr>
+					<th>Password:</th>
+					<td>Your mail password.</td>
+				</tr>
+			</table>
 
-					<p>As an alternative to IMAP you can also use the POP protocol: choose POP as the protocol, port 995, and SSL or TLS security in your mail client. The SMTP settings and usernames and passwords remain the same. However, we recommend you use IMAP instead.</p>
+			<p>In addition to setting up your email, you&rsquo;ll also need to set up <a href="#sync_guide"
+					onclick="return show_panel(this);">contacts and calendar synchronization</a> separately.</p>
 
-				<h4>Exchange/ActiveSync settings</h4>
+			<p>As an alternative to IMAP you can also use the POP protocol: choose POP as the protocol, port 995, and
+				SSL or TLS security in your mail client. The SMTP settings and usernames and passwords remain the same.
+				However, we recommend you use IMAP instead.</p>
 
-					<p>On iOS devices, devices on this <a href="https://wiki.z-hub.io/display/ZP/Compatibility">compatibility list</a>, or using Outlook 2007 or later on Windows 7 and later, you may set up your mail as an Exchange or ActiveSync server. However, we&rsquo;ve found this to be more buggy than using IMAP as described above. If you encounter any problems, please use the manual settings above.</p>
+			<h4>Exchange/ActiveSync settings</h4>
 
-					<table class="table">
-					<tr><th>Server</th> <td>{{hostname}}</td></tr>
-					<tr><th>Options</th> <td>Secure Connection</td></tr>
-					</table>
+			<p>On iOS devices, devices on this <a href="https://wiki.z-hub.io/display/ZP/Compatibility">compatibility
+					list</a>, or using Outlook 2007 or later on Windows 7 and later, you may set up your mail as an
+				Exchange or ActiveSync server. However, we&rsquo;ve found this to be more buggy than using IMAP as
+				described above. If you encounter any problems, please use the manual settings above.</p>
 
-					<p>Your device should also provide a contacts list and calendar that syncs to this box when you use this method.</p>
+			<table class="table">
+				<tr>
+					<th>Server</th>
+					<td>{{hostname}}</td>
+				</tr>
+				<tr>
+					<th>Options</th>
+					<td>Secure Connection</td>
+				</tr>
+			</table>
+
+			<p>Your device should also provide a contacts list and calendar that syncs to this box when you use this
+				method.</p>
 		</div>
 
 		<div class="col-sm-5">
-		<div class="panel panel-default">
-		<div class="panel-heading">
-			<h3>Other information about mail on your box</h3>
-		</div>
-		<div class="panel-body">
-			<h4>Greylisting</h4>
-			<p>Your box using a technique called greylisting to cut down on spam. Greylisting works by delaying mail from people you haven&rsquo;t received mail from before for up to about 10 minutes. The vast majority of spam gets tricked by this. If you are waiting for an email from someone new, such as if you are registering on a new website and are waiting for an email confirmation, please give it up to 10-15 minutes to arrive.</p>
+			<div class="panel panel-default">
+				<div class="panel-heading">
+					<h3>Other information about mail on your box</h3>
+				</div>
+				<div class="panel-body">
+					<h4>Greylisting</h4>
+					<p>Your box uses a technique called greylisting to cut down on spam. Greylisting works by initially
+						rejecting mail from people you haven&rsquo;t received mail from before. Legitimate mail servers
+						will attempt redelivery shortly afterwards, but the vast majority of spam gets tricked by this.
+						If you are waiting for an email from someone new, such as if you are registering on a new
+						website and are waiting for an email confirmation, please be aware there will be a minimum of 3
+						minutes delay, depending how soon the remote server attempts redelivery.</p>
 
-			<h4>+tag addresses</h4>
-			<p>Every incoming email address also receives mail for <code>+tag</code> addresses. If your email address is <code>you@yourdomain.com</code>, you&rsquo;ll also automatically get mail sent to <code>you+anythinghere@yourdomain.com</code>. Use this as a fast way to segment incoming mail for your own filtering rules without having to create aliases in this control panel.</p>
+					<h4>+tag addresses</h4>
+					<p>Every incoming email address also receives mail for <code>+tag</code> addresses. If your email
+						address is <code>you@yourdomain.com</code>, you&rsquo;ll also automatically get mail sent to
+						<code>you+anythinghere@yourdomain.com</code>. Use this as a fast way to segment incoming mail
+						for your own filtering rules without having to create aliases in this control panel.</p>
 
-			<h4>Use only this box to send as you</h4>
-			<p>Your box sets strict email sending policies for your domain names to make it harder for spam and other fraudulent mail to claim to be you. Only this machine is authorized to send email on behalf of your domain names. If you use any other service to send email as you, it will likely get spam filtered by recipients.</p>
-		</div>
-		</div>
+					<h4>Use only this box to send as you</h4>
+					<p>Your box sets strict email sending policies for your domain names to make it harder for spam and
+						other fraudulent mail to claim to be you. Only this machine is authorized to send email on
+						behalf of your domain names. If you use any other service to send email as you, it will likely
+						get spam filtered by recipients.</p>
+				</div>
+			</div>
 		</div>
 	</div>
 </div>

management/templates/manage-password.html

@@ -0,0 +1,57 @@
+<div>
+	<h2>Manage Password</h2>
+	<p>Here you can change your account password. The new password is then valid for both this panel and your email.</p>
+	<p>If you have client emails configured, you'll then need to update the configuration with the new password. See the <a href="#mail-guide" onclick="return show_panel(this);">Mail Guide</a> for more information about this.</p>
+
+	<form class="form-horizontal" role="form" onsubmit="set_password_self(); return false;">
+		<div class="col-lg-10 col-xl-8 mb-3">
+			<div class="input-group">
+				<label for="manage-password-new" class="input-group-text col-3">New Password</label>
+				<input type="password" placeholder="password" class="form-control" id="manage-password-new">
+			</div>
+		</div>
+
+		<div class="col-lg-10 col-xl-8 mb-3">
+			<div class="input-group">
+				<label for="manage-password-confirm" class="input-group-text col-3">Confirm Password</label>
+				<input type="password" placeholder="password" class="form-control" id="manage-password-confirm">
+			</div>
+		</div>
+
+		<div class="mt-3">
+			<button id="manage-password-submit" type="submit" class="btn btn-primary">Save</button>
+		</div>
+		<small>After changing your password, you'll be logged out from the account and will need to log in again.</small>
+	</form>
+</div>
+
+<script>
+	function set_password_self() {
+		if ($('#manage-password-new').val() !== $('#manage-password-confirm').val()) {
+			show_modal_error("Set Password", 'Passwords do not match!');
+			return;
+		}
+
+		let password = $('#manage-password-new').val()
+
+		api(
+			"/mail/users/password",
+			"POST",
+			{
+				email: api_credentials.username,
+				password: password
+			},
+			function (r) {
+				// Responses are multiple lines of pre-formatted text.
+				show_modal_error("Set Password", $("<pre/>").text(r), () => {
+					do_logout()
+					$('#manage-password-new').val("")
+					$('#manage-password-confirm').val("")
+				});
+			},
+			function (r) {
+				show_modal_error("Set Password", r);
+			}
+		);
+	}
+</script>

management/templates/mfa.html

@@ -0,0 +1,240 @@
+<style>
+	.twofactor #totp-setup,
+	.twofactor #disable-2fa,
+	.twofactor #output-2fa {
+		display: none;
+	}
+
+	.twofactor.loaded .loading-indicator {
+		display: none;
+	}
+
+	.twofactor.disabled #disable-2fa,
+	.twofactor.enabled #totp-setup {
+		display: none;
+	}
+
+	.twofactor.disabled #totp-setup,
+	.twofactor.enabled #disable-2fa {
+		display: block;
+	}
+
+	.twofactor #totp-setup-qr img {
+		display: block;
+		width: 256px;
+		max-width: 100%;
+		height: auto;
+	}
+
+	.twofactor #output-2fa.visible {
+		display: block;
+	}
+</style>
+
+<h2>Two-Factor Authentication</h2>
+
+<p>When two-factor authentication is enabled, you will be prompted to enter a six digit code from an
+	authenticator app (usually on your phone) when you log into this control panel.</p>
+
+<div class="card mb-4">
+	<div class="card-header text-white bg-danger">
+		Enabling two-factor authentication does not protect access to your email
+	</div>
+	<div class="card-body bg-light">
+		Enabling two-factor authentication on this page only limits access to this control panel. Remember that most
+		websites allow you to
+		reset your password by checking your email, so anyone with access to your email can typically take over
+		your other accounts. Additionally, if your email address or any alias that forwards to your email
+		address is a typical domain control validation address (e.g admin@, administrator@, postmaster@, hostmaster@,
+		webmaster@, abuse@), extra care should be taken to protect the account. <strong>Always use a strong password,
+			and ensure every administrator account for this control panel does the same.</strong>
+	</div>
+</div>
+
+<div class="twofactor">
+	<div class="loading-indicator">Loading...</div>
+
+	<form id="totp-setup">
+		<h3>Setup Instructions</h3>
+
+		<div class="row gx-5">
+			<div class="col-12 col-lg-6">
+				<p><b>1.</b> Install <a href="https://freeotp.github.io/">FreeOTP</a> or <a
+						href="https://www.pcworld.com/article/3225913/what-is-two-factor-authentication-and-which-2fa-apps-are-best.html">any
+						other two-factor authentication app</a> that supports TOTP.</p>
+
+				<div class="mb-3">
+					<p style="margin-bottom: 0"><b>2.</b> Scan the QR code in the app or directly enter the secret into
+						the app:</p>
+					<div id="totp-setup-qr">
+						<img class="mt-3 mb-3 ms-auto me-auto" id="twofactor-qrimg">
+						<div class="input-group">
+							<label class="input-group-text" for="totp-setup-secret"><b>Secret</b></label>
+							<input type="text" class="form-control font-monospace" id="totp-setup-secret" disabled />
+						</div>
+					</div>
+				</div>
+			</div>
+
+			<div class="col-12 col-lg-6">
+				<div class="mb-3">
+					<label for="otp-label" style="font-weight: normal"><b>3.</b> Optionally, give your device a label so
+						that you can remember what device you set it up on:</label>
+					<input type="text" id="totp-setup-label" class="form-control" placeholder="my phone" />
+				</div>
+
+				<div class="mb-3">
+					<label for="otp" style="font-weight: normal"><b>4.</b> Use the app to generate your first six-digit
+						code and enter it here:</label>
+					<input type="text" id="totp-setup-token" class="form-control" placeholder="6-digit code" />
+				</div>
+			</div>
+		</div>
+
+		<div class="form-group">
+			<div>
+				<button id="totp-setup-submit" disabled type="submit" class="btn btn-primary">Enable Two-Factor
+					Authentication</button>
+			</div>
+			<small>When you click Enable Two-Factor Authentication, you will be logged out of the control panel and will
+				have to log in
+				again, now using your two-factor authentication app.</small>
+		</div>
+	</form>
+
+	<form id="disable-2fa">
+		<div>
+			<p>Two-factor authentication is active for your account<span id="mfa-device-label"> on device <span
+						class="font-monospace"></span></span>.</p>
+			<button type="submit" class="btn btn-danger">Disable Two-Factor Authentication</button>
+		</div>
+		<small>You will have to log into the admin panel again after disabling two-factor authentication.</small>
+	</form>
+</div>
+
+<script>
+	var el = {
+		disableForm: document.getElementById('disable-2fa'),
+		totpSetupForm: document.getElementById('totp-setup'),
+		totpSetupToken: document.getElementById('totp-setup-token'),
+		totpSetupSecret: document.getElementById('totp-setup-secret'),
+		totpSetupLabel: document.getElementById('totp-setup-label'),
+		totpQr: document.getElementById('totp-setup-qr'),
+		totpSetupSubmit: document.querySelector('#totp-setup-submit'),
+		wrapper: document.querySelector('.twofactor')
+	}
+
+	function update_setup_disabled(evt) {
+		var val = evt.target.value.trim();
+
+		if (
+			typeof val !== 'string' ||
+			typeof el.totpSetupSecret.value !== 'string' ||
+			val.length !== 6 ||
+			el.totpSetupSecret.value.length !== 32 ||
+			!(/^\+?\d+$/.test(val))
+		) {
+			el.totpSetupSubmit.setAttribute('disabled', '');
+		} else {
+			el.totpSetupSubmit.removeAttribute('disabled');
+		}
+	}
+
+	function render_totp_setup(provisioned_totp) {
+		$('#twofactor-qrimg').attr("src", "data:image/png;base64," + provisioned_totp.qr_code_base64);
+
+		el.totpSetupSecret.val = provisioned_totp.secret;
+
+		el.totpSetupToken.addEventListener('input', update_setup_disabled);
+		el.totpSetupForm.addEventListener('submit', do_enable_totp);
+
+		el.totpSetupSecret.setAttribute('value', provisioned_totp.secret);
+
+		el.wrapper.classList.add('disabled');
+	}
+
+	function render_disable(mfa) {
+		el.disableForm.addEventListener('submit', do_disable);
+		el.wrapper.classList.add('enabled');
+		if (mfa.label) {
+			$("#mfa-device-label").show()
+			$("#mfa-device-label .font-monospace").text(mfa.label);
+		} else {
+			$("#mfa-device-label").hide()
+		}
+	}
+
+	function reset_view() {
+		el.wrapper.classList.remove('loaded', 'disabled', 'enabled');
+
+		el.disableForm.removeEventListener('submit', do_disable);
+
+		el.totpSetupForm.reset();
+		el.totpSetupForm.removeEventListener('submit', do_enable_totp);
+
+		el.totpSetupSecret.setAttribute('value', '');
+		el.totpSetupToken.removeEventListener('input', update_setup_disabled);
+
+		el.totpSetupSubmit.setAttribute('disabled', '');
+
+		$('#twofactor-qrimg').attr("src", "");
+		$('#totp-setup-secret').attr("value", "");
+	}
+
+	function show_mfa() {
+		reset_view();
+
+		api(
+			'/mfa/status',
+			'POST',
+			{},
+			function (res) {
+				el.wrapper.classList.add('loaded');
+
+				var has_mfa = false;
+				res.enabled_mfa.forEach(function (mfa) {
+					if (mfa.type == "totp") {
+						render_disable(mfa);
+						has_mfa = true;
+					}
+				});
+
+				if (!has_mfa)
+					render_totp_setup(res.new_mfa.totp);
+			}
+		);
+	}
+
+	function do_disable(evt) {
+		evt.preventDefault();
+
+		api(
+			'/mfa/disable',
+			'POST',
+			{ type: 'totp' },
+			function () {
+				do_logout();
+			}
+		);
+
+		return false;
+	}
+
+	function do_enable_totp(evt) {
+		evt.preventDefault();
+
+		api(
+			'/mfa/totp/enable',
+			'POST',
+			{
+				token: $(el.totpSetupToken).val(),
+				secret: $(el.totpSetupSecret).val(),
+				label: $(el.totpSetupLabel).val()
+			},
+			function (res) { do_logout(); },
+			function (res) { show_modal_error("Two-Factor Authentication Setup", res); }
+		);
+
+		return false;
+	}
+</script>

management/templates/munin.html

@@ -0,0 +1,20 @@
+<h2>Munin Monitoring</h2>
+
+<style>
+</style>
+
+<p>Opening munin in a new tab... You may need to allow pop-ups for this site.</p>
+
+<script>
+	function show_munin() {
+		// Set the cookie.
+		api(
+			"/munin",
+			"GET",
+			{},
+			function (r) {
+				// Redirect.
+				window.open("/admin/munin/index.html", "_blank");
+			});
+	}
+</script>

management/templates/pgp-keyring.html

@@ -0,0 +1,298 @@
+<style>
+	#pgp_keyring_config .icon {
+		min-width: 2em;
+	}
+
+	.inline {
+		display: inline;
+	}
+</style>
+
+<h2>PGP Keyring Management</h2>
+
+<template id="pgpkey-template">
+	<tr>
+		<td class="row p-3">
+			<div class="col-lg-10 col-12">
+				<b id="isrevoked" class="fs-4"></b>
+				<div id="uids" class="mb-3 font-monospace">
+					<div id="uid-template">
+						<span class="icon fas"></span><span id="id" class="status-text"></span>
+					</div>
+				</div>
+				<b class="fs-5">Subkeys</b>
+				<div id="subkeys" class="align-middle col-12">
+					<div class="row" id="subkey-template">
+						<div style="width: 2em;" id="ismaster" data-bs-toggle="tooltip" title="Master Key"></div>
+						<div style="width: 5em;">
+							<b>
+								<span class="sym" id="sign">S</span>
+								<span class="sym" id="cert">C</span>
+								<span class="sym" id="encr">E</span>
+								<span class="sym" id="auth">A</span>
+							</b>
+						</div>
+						<div class="col-md-2 col-4" id="algo">
+							<b class="status-text"></b>
+						</div>
+						<div class="col" id="expiration">
+							<span class="status-text"></span>
+						</div>
+						<div class="col-md-6 col-12" id="fpr">
+							<span class="status-text font-monospace"></span>
+						</div>
+					</div>
+				</div>
+			</div>
+			<div id="options" class="col-lg-2 col-12">
+			</div>
+		</td>
+	</tr>
+</template>
+
+<div id="pgp_keyring_config">
+	<h3>Daemon's Private Key</h3>
+	<table id="privatekey" class="container">
+	</table>
+
+	<h3>Imported Public Keys</h3>
+	<table id="pubkeys" class="container">
+	</table>
+
+	<h3>Import Key</h3>
+	<p>
+		You can upload your <b>public</b> key/keychain here. Keys <b>must</b> be submitted in ASCII-armored format.
+		<br>
+		If you're using <code>gpg</code>, you can export your public key by following this example:
+	<pre>
+# Get all the keys in the ring
+$ <b>gpg --list-keys</b>
+/home/you/.gnupg/pubring.kbx
+----------------------------
+pub   rsa4096 1970-01-01 [SC]
+    247C3553B4B36107BA0490C3CAFCCF3B4965761A
+uid           [  full  ] Someone That I Used to Know &lt;someone@example.com&gt;
+sub   rsa2048 2020-01-01 [E] [expires: 2069-12-31]
+
+pub   rsa4096 1970-01-01 [SC] [expires: 2069-12-31]
+    52661092E5CD9EEFD7796B19E85F540C9318B69F
+uid           [ultimate] Me, Myself and I &lt;me@example.net&gt;
+sub   rsa2048 2020-05-24 [E] [expires: 2069-12-31]
+
+# Let's export the key "Me, Myself and I"
+$ <b>gpg --export --armor 52661092E5CD9EEFD7796B19E85F540C9318B69F</b>
+<b>-----BEGIN PGP PUBLIC KEY BLOCK-----
+
+copy and paste this block in the area below
+-----END PGP PUBLIC KEY BLOCK-----</b>
+        </pre>
+	</p>
+	<div class="form-floating col-12 col-xl-6 mb-3">
+		<textarea id="pgp_paste_key" class="form-control" style="font-size:80%; font-family: monospace; height: 20em"
+			placeholder="-----BEGIN PGP PUBLIC KEY BLOCK-----&#xA;stuff here&#xA;-----END PGP PUBLIC KEY BLOCK-----"></textarea>
+		<label for="pgp_paste_key">Paste your PGP public key here</label>
+	</div>
+	<button class="btn btn-primary" onclick="importkey()">Import Key</button>
+</div>
+
+<script>
+	function pretty_fpr(fpr) {
+		let pfpr = ""
+		for (let n = 0; n < 2; ++n) {
+			for (let i = 0; i < 5; ++i) {
+				pfpr += `${fpr.substring(n * 20 + i * 4, n * 20 + (i + 1) * 4)} `
+			}
+			pfpr += " "
+		}
+
+		return pfpr.substring(0, pfpr.length - 2)
+	}
+
+	function key_html(key, darken_bg, daemon) {
+		let keyrep = $("#pgpkey-template").html()
+		console.log(keyrep)
+		keyrep = $(keyrep)
+		keyrep.attr("id", key.master_fpr)
+
+		// Main key config
+		if (darken_bg) {
+			keyrep.addClass("bg-light")
+		}
+
+		let rev = keyrep.find("#isrevoked")
+
+		if (key.revoked) {
+			rev.text("This key was revoked by it's owner.")
+			rev.addClass(".status-error")
+		} else {
+			rev.text("Key is not revoked.")
+		}
+
+		let uids = keyrep.find("#uids")
+		let uidtemplate = $(uids.html())
+		uids.find("#uid-template").remove()
+		if (daemon) {
+			uidtemplate.find(".icon").addClass("fa-robot")
+		} else {
+			uidtemplate.find(".icon").addClass("fa-user")
+		}
+
+		key.ids.forEach(id => {
+			let thisuid = uidtemplate.clone()
+			thisuid.attr("id", "")
+			thisuid.find("#id").text(id)
+			thisuid.appendTo(uids)
+		});
+
+		// Subkeys
+		const keyflags = ["sign", "cert", "encr", "auth"]
+		let subkeys = keyrep.find("#subkeys")
+		let subkeytemplate = subkeys.html()
+		keyrep.find("#subkey-template").remove()
+		key.subkeys.forEach(skey => {
+			let skeyrep = $(subkeytemplate)
+			skeyrep.attr("id", `sub${skey.fpr}`)
+
+			let statusclass
+			let expiration = skeyrep.find("#expiration")
+			let exptxt = expiration.find(".status-text")
+
+			if (key.revoked) {
+				statusclass = "status-error"
+				exptxt.text("Revoked")
+			} else if (skey.expired) {
+				statusclass = "status-error"
+				exptxt.text(`${skey.expires_date} (expired)`)
+			} else if (skey.expires && skey.expires_days <= 14) {
+				statusclass = "status-warning"
+				exptxt.text(`${skey.expires_date} (${skey.expires_days} days)`)
+			} else if (skey.expires) {
+				statusclass = "status-ok"
+				exptxt.text(`${skey.expires_date} (${skey.expires_days} days)`)
+			} else {
+				statusclass = "status-ok"
+				exptxt.text("Does not expire")
+			}
+
+			expiration.addClass(statusclass)
+
+			// Master key?
+			if (skey.master) {
+				skeyrep.find("#ismaster").addClass("fas fa-key")
+			}
+
+			// Usage flags
+			keyflags.forEach(flag => {
+				skeyrep.find(`#${flag}`).addClass(skey[flag] ? statusclass : "status-na")
+			});
+
+			// Algorithm and fingerprint
+			let algo = skeyrep.find("#algo")
+			algo.addClass(statusclass)
+			algo.find(".status-text").html(`${skey.algorithm}, ${skey.bits} bits`)
+
+			let fpr = skeyrep.find("#fpr")
+			fpr.addClass(statusclass)
+			fpr.find(".status-text").html(pretty_fpr(skey.fpr))
+
+			skeyrep.appendTo(subkeys)
+		});
+
+		// Options
+		if (daemon) {
+			keyrep.find("#options").html(`<button class="btn btn-primary col-12" onclick="exportkey('${key.master_fpr}')">Export Public Key</button>`)
+		} else {
+			keyrep.find("#options").html(`<button class="btn btn-secondary col-12 mb-3" onclick="exportkey('${key.master_fpr}')">Export Public Key</button><button class="btn btn-danger col-12" onclick="rmkey('${key.master_fpr}')">Remove Key</button>`)
+		}
+
+		return keyrep
+	}
+
+	function show_pgp_keyring() {
+		$('#privatekey').html("<tr><td class='text-muted'>Loading...</td></tr>")
+		$('#pubkeys').html("<tr><td class='text-muted'>Loading...</td></tr>")
+		api(
+			"/system/pgp/",
+			"GET",
+			{},
+			function (r) {
+				$('#privatekey').html("")
+				$('#pubkeys').html("")
+				key_html(r.daemon, true, true).appendTo("#privatekey")
+				let pendulum = 1
+				r.imported.forEach(k => {
+					key_html(k, pendulum > 0, false).appendTo("#pubkeys")
+					pendulum *= -1
+				});
+			}
+		)
+	}
+
+	function exportkey(fpr) {
+		api(
+			`/system/pgp/${fpr}/export`,
+			"GET",
+			{},
+			function (r) {
+				show_modal_error("PGP Key", `Key export for <b>${fpr}</b>:<br><br><pre>${r}</pre>`)
+			},
+			function (_, xhr) {
+				if (xhr.status == 404) {
+					show_modal_error("Error", `The key you asked for (<b>${fpr}</b>) does not exist!`)
+				} else {
+					// Fallback to the default error modal
+					show_modal_error("Error", "Something went wrong, sorry.")
+				}
+			}
+		)
+	}
+
+	function rmkey(fpr) {
+		show_modal_confirm("Delete key", `Are you sure you wish to remove the key with the fingerprint ${pretty_fpr(fpr)}?`, "Yes, remove it", () => {
+			api(
+				`/system/pgp/${fpr}`,
+				"DELETE",
+				{},
+				function (r) {
+					if (r.length == 0) {
+						show_modal_error("Delete key", "OK", show_pgp_keyring)
+					} else {
+						wkd_info = "OK. <b>The following entries were removed from WKD:</b><ul>"
+						r.forEach(email => {
+							wkd_info += `<li>${email}</li>`
+						});
+						wkd_info += "</ul>"
+
+						show_modal_error("Delete key", wkd_info, show_pgp_keyring)
+					}
+				},
+				function (r) {
+					show_modal_error("Key deletion error", r)
+				}
+			)
+		}, () => { })
+	}
+
+	function importkey() {
+		api(
+			"/system/pgp/import",
+			"POST",
+			{
+				key: $("#pgp_paste_key").val()
+			},
+			function (r) {
+				show_modal_error("Import Results", `<ul>
+                    <li><b>Keys read:</b> ${r.keys_read}</li>
+                    <li><b>Keys added:</b> ${r.keys_added}</li>
+                    <li><b>Keys not changed:</b> ${r.keys_unchanged}</li>
+                    <li><b>User id's added:</b> ${r.uids_added}</li>
+                    <li><b>Signatures added:</b> ${r.sigs_added}</li>
+                    <li><b>Revocations added:</b> ${r.revs_added}</li>
+                </ul>`, show_pgp_keyring)
+			},
+			function (r) {
+				show_modal_error("Import Error", r)
+			}
+		)
+	}
+</script>

management/templates/smtp-relays.html

@@ -0,0 +1,322 @@
+<style>
+</style>
+
+<h2>SMTP Relays</h2>
+
+<p>SMTP Relays are third-party services that can deliver email on your behalf. They
+	can be useful when, for example, port 25 is blocked, the cloud provider/ISP doesn't provide Reverse DNS, or the IP
+	address
+	has a low reputation, among other situations where deliverablity isn't great.</p>
+
+<p>These services are governed by their own terms and as such limits can be imposed in the usage of those services.</p>
+
+<p>Here, you can configure an authenticated SMTP relay and authorize it's associated servers to send mail for you.</p>
+
+<div id="smtp_relay_config">
+	<form class="form-horizontal" role="form" onsubmit="set_smtp_relay_config(); return false;">
+		<h3>SMTP Relay Configuration</h3>
+		<div id="smtp-relays" class="col-12">
+
+			<div class="input-group mb-3">
+				<label for="use_relay" class="input-group-text"><b>Use Relay?</b></label>
+				<div class="input-group-text">
+					<div class="form-switch">
+						<input type="checkbox" role="switch" id="use_relay" class="form-check-input" value=false
+							onclick="checkfields();">
+					</div>
+				</div>
+			</div>
+
+			<div class="input-group mb-3">
+				<label class="input-group-text">Where to?</label>
+				<input type="text" class="form-control" id="relay_host" placeholder="relay.example.com">
+				<label class="input-group-text">:</label>
+				<div style="width: 20%">
+					<input type="number" class="form-control" id="relay_port" placeholder="Port (465)">
+				</div>
+			</div>
+
+			<div class="input-group mb-3">
+				<label class="input-group-text">Username</label>
+				<input type="text" class="form-control" id="relay_auth_user" placeholder="">
+			</div>
+
+			<div>
+				<div class="input-group">
+					<label class="input-group-text">Password/Key</label>
+					<input type="password" class="form-control" id="relay_auth_pass" placeholder="">
+				</div>
+				<p class="small">If you've already set up a relay before on this box, you can leave this field blank if
+					you don't want to change it's password.</p>
+			</div>
+		</div>
+
+		<h3>Authorized Servers</h3>
+		<p>The relay service should specify the servers where the email will be sent from, please add them below. These
+			will probably be published in the form of a SPF record. <b>Failure to do so will potentially have your email
+				sent to spam or even rejected altogether by recipients.</b>
+		</p>
+
+		<p>You can use the button below to attempt to localize the SPF record associated with the service you're using.
+		</p>
+
+		<button id="smtp_relay_autospf_btn" type="button" class="btn btn-secondary" onclick="autodetect_spf()">Detect
+			SPF
+			Records</button>
+
+		<div id="smtp_relay_autospf"></div>
+		<br>
+		<div class="form-group">
+			<h4>Add your SPF configuration/authorized servers here</h4>
+			<input type="text" class="form-control" id="relay_authorized_servers"
+				placeholder="mail1.example.net mail2.example.net">
+			<p class="small">You can separate multiple servers with commas or spaces. You can also add IP addresses or
+				subnets using <code>10.20.30.40</code> or <code>10.0.0.0/8</code>. You can "import" SPF records using
+				<code>spf:example.com</code>. If your provider gave you an SPF record to add to your DNS, you can also paste it here.
+			</p>
+		</div>
+
+		<h3>DKIM Configuration</h3>
+		<p>DKIM allows receivers to verify that the email was sent by the relay you configured (this is, somebody you
+			trust). <b>If your relay provider does not provide you with this information, it's probably safe to skip this step.</b></p>
+
+		<div class="col-lg-6 col-md-8 col-12">
+			<div class="input-group">
+				<input type="text" class="form-control" id="relay_dkim_selector" placeholder="selector"></td>
+				<label class="input-group-text" for="relay_dkim_selector">._domainkey.{{hostname}}</label>
+			</div>
+		</div>
+
+		<h4>Paste the DKIM key here:</h4>
+		<p><textarea id="relay_dkim_key" class="form-control" style="width: 100%; height: 8em"
+				placeholder="k=algo;p=K3y/C0N7ent5/dGhpcyBpcyBub3QgYSByZWFsIGtleSwgc28gYmV3YXJlIDrigb4"></textarea>
+		</p>
+
+		<div>
+			<button type="submit" class="btn btn-primary">Update</button>
+		</div>
+
+		<h3>After configuration</h3>
+		<p>By that time you should be good to go. If your relay provider provides their own custom DNS verification
+			methods (<b>including custom DMARC configurations</b>), feel free to publish them on DNS.</p>
+	</form>
+</div>
+
+<script>
+	const use_relay = document.getElementById("use_relay")
+	const relay_host = document.getElementById("relay_host")
+	const relay_port = document.getElementById("relay_port")
+	const relay_auth_user = document.getElementById("relay_auth_user")
+	const relay_auth_pass = document.getElementById("relay_auth_pass")
+
+	const relay_authorized_servers = document.getElementById("relay_authorized_servers")
+	const relay_spf_discover = document.getElementById("smtp_relay_autospf_btn")
+	const relay_spf_discover_results = document.getElementById("smtp_relay_autospf")
+
+	const relay_dkim_sel = document.getElementById("relay_dkim_selector")
+	const relay_dkim_key = document.getElementById("relay_dkim_key")
+
+	function checkfields() {
+		let relay_enabled = use_relay.checked
+
+		relay_host.disabled = !relay_enabled
+		relay_port.disabled = !relay_enabled
+		relay_auth_user.disabled = !relay_enabled
+		relay_auth_pass.disabled = !relay_enabled
+		relay_authorized_servers.disabled = !relay_enabled
+
+		relay_spf_discover.disabled = !relay_enabled
+		relay_spf_discover_results.innerHTML = ""
+
+		relay_dkim_sel.disabled = !relay_enabled
+		relay_dkim_key.disabled = !relay_enabled
+	}
+
+	function show_smtp_relays() {
+		api(
+			"/system/smtp/relay",
+			"GET",
+			{},
+			data => {
+				use_relay.checked = data.enabled
+				relay_host.value = data.host
+				relay_port.value = data.port
+				relay_auth_user.value = data.user
+				relay_auth_pass.value = ""
+				relay_authorized_servers.value = ""
+
+				if (data.spf_record) {
+					relay_authorized_servers.value = data.spf_record
+				}else if (data.authorized_servers) {
+					data.authorized_servers.forEach(element => {
+						relay_authorized_servers.value += `${element} `
+					});
+				}
+
+				if (data.dkim_selector) {
+					relay_dkim_sel.value = data.dkim_selector
+					relay_dkim_key.value = data.dkim_rr
+				}
+
+				checkfields()
+			}
+		)
+	}
+
+	function set_smtp_relay_config() {
+		let relay_configuration = {
+			enabled: use_relay.checked,
+			host: relay_host.value,
+			port: relay_port.value,
+			user: relay_auth_user.value,
+			key: relay_auth_pass.value,
+			dkim_selector: relay_dkim_sel.value,
+			dkim_rr: relay_dkim_key.value
+		}
+		if (relay_authorized_servers.value.substr(0, 7) === "v=spf1 ") {
+			relay_configuration.spf_record = relay_authorized_servers.value
+		} else {
+			relay_configuration.authorized_servers = relay_authorized_servers.value
+		}
+
+		api(
+			"/system/smtp/relay",
+			"POST",
+			relay_configuration,
+			() => {
+				show_modal_error("Done!", "The configuration has been updated and Postfix was restarted successfully. Please make sure everything is functioning as intended.", () => {
+					return false
+				})
+			},
+			(e) => {
+				show_modal_error("Error!", e, () => { return false })
+			}
+		)
+	}
+
+	function add_spf(domain) {
+		document.getElementById(`smtp_relay_spfinclude_${domain}`).disabled = true
+
+		let impl = false
+		relay_authorized_servers.value.split(/[\s,]+/).forEach(s => {
+			if (s === `spf:${domain}`) {
+				impl = true
+			}
+		});
+
+		if (!impl) {
+			relay_authorized_servers.value += ` spf:${domain}`
+		}
+	}
+
+	async function autodetect_spf() {
+		let btn = $("#smtp_relay_autospf_btn")
+		let results = $("#smtp_relay_autospf")
+
+		let host = relay_host.value
+		if (host.trim() == "") {
+			results.html("<b>Error:</b> No hostname specified.")
+			return
+		}
+
+		let hmatches = host.match(/([^\s.\\\/]+\.)+([^\s.\\\/]+)/)
+		if (!hmatches || hmatches[0] != host) {
+			results.html(`<b>Error: <code>${host}</code></b> is not a valid hostname.`)
+			return
+		}
+
+		btn.html("Working...")
+		btn.prop("disabled", true)
+
+		results.html("")
+
+		let base_host = hmatches[hmatches.length - 2] + hmatches[hmatches.length - 1]
+
+		function record_html(name, rec) {
+			if (rec.error) {
+				return `<b>${name}</b> - ${rec.error} Error (${rec.msg})`
+			} else {
+				return `<button id="smtp_relay_spfinclude_${name}" type="button" class="btn btn-secondary" onclick="add_spf('${name}')">Include</button> <b>${name}</b> <code>${rec.msg}</code>`
+			}
+		}
+
+		let records = []
+
+		await Promise.all([
+			query_spf(base_host).then(rr => { records[0] = record_html(base_host, rr) }),
+			query_spf(`spf.${base_host}`).then(rr => { records[1] = record_html(`spf.${base_host}`, rr) }),
+			query_spf(`_spf.${base_host}`).then(rr => { records[2] = record_html(`_spf.${base_host}`, rr) })
+		])
+
+		let txt = "<h4>Here's what I've found:</h4><ul>"
+		records.forEach((r) => {
+			txt += `<li>${r}</li>`
+		})
+
+		txt += "</ul><small>Only some common subdomains are tested here, so it's possible I've missed some. You <b>SHOULD NOT</b> include records you do not recognize, else there will be servers that can send mail as you, but that you will not use.</small>"
+
+		results.html(txt)
+
+		btn.html("Detect SPF Records")
+		btn.prop("disabled", false)
+	}
+
+	function query_spf(hostname) {
+		// We use Cloudflare's DNS servers for this (DNS over HTTPS)
+		return new Promise((resolve, _) => {
+			$.ajax({
+				url: "https://cloudflare-dns.com/dns-query",
+				headers: {
+					accept: "application/dns-json"
+				},
+				method: "GET",
+				data: {
+					name: hostname,
+					type: "TXT",
+					do: false,
+					cd: false
+				},
+				success: (data) => {
+					const RRTXT = 16
+					const status_description = [
+						// From https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-6
+						// (last checked: 3rd June 2021)
+						"Success",
+						"Format Error",
+						"Server Failure",
+						"Non-Existent Domain",
+						"Not Implemented",
+						"Query Refused",
+						"Name exists when it should not",
+						"RR set exists when it should not",
+						"RR set that should exist does not",
+						"Server is not authoritative for zone",
+						"Not Authorized",
+						"Name not contained in zone",
+						"DSO-TYPE Not Implemented"
+					]
+					if (data.Status != 0) {
+						if (data.Status > 11) {
+							return resolve({ error: "DNS", msg: "Unknown Error" })
+						} else {
+							return resolve({ error: "DNS", msg: status_description[data.Status] })
+						}
+					}
+
+					if (data.Answer) {
+						data.Answer.forEach(ans => {
+							if (ans.type == 16 && ans.name == hostname && ans.data.substring(1, 7) == "v=spf1") {
+								return resolve({ msg: ans.data.substring(1, ans.data.length - 1) })
+							}
+						})
+					}
+
+					return resolve({ error: "DNS", msg: "No SPF record found" })
+				},
+				error: (_, __, err) => {
+					resolve({ error: "HTTP", msg: err })
+				}
+			})
+		})
+	}
+</script>

management/templates/ssl.html

@@ -1,284 +1,307 @@
 <style>
+	.code-white>code {
+		color: #ffffff
+	}
+
+	#ssl_provision_result>div>div {
+		white-space: pre;
+	}
+
+	#ssl_domains .icon {
+		min-width: 1.6em;
+	}
 </style>
 
 <h2>TLS (SSL) Certificates</h2>
 
-<p>A TLS (formerly called SSL) certificate is a cryptographic file that proves to anyone connecting to a web address that the connection is secure between you and the owner of that address.</p>
+<p>A TLS (formerly called SSL) certificate is a cryptographic file that proves to anyone connecting to a web address
+	that the connection is secure between you and the owner of that address.</p>
 
-<p>You need a TLS certificate for this box&rsquo;s hostname ({{hostname}}) and every other domain name and subdomain that this box is hosting a website for (see the list below).</p>
+<p>You need a TLS certificate for this box&rsquo;s hostname ({{hostname}}) and every other domain name and subdomain
+	that this box is hosting a website for (see the list below).</p>
 
 <div id="ssl_provision">
-<h3>Provision a certificate</h3>
+	<h3>Provision certificates</h3>
 
-<div id="ssl_provision_p" style="display: none; margin-top: 1.5em">
-  <button onclick='return provision_tls_cert();' class='btn btn-primary' style="float: left; margin: 0 1.5em 1em 0;">Provision</button>
-  <p>A TLS certificate can be automatically provisioned from <a href="https://letsencrypt.org/" target="_blank">Let&rsquo;s Encrypt</a>, a free TLS certificate provider, for:<br>
-  <span class="text-primary"></span></p>
+	<div id="ssl_provision_p" style="display: none; margin-top: 1.5em">
+		<p>A TLS certificate can be automatically provisioned from <a href="https://letsencrypt.org/"
+				target="_blank">Let&rsquo;s Encrypt</a>, a free TLS certificate provider, for:</p>
+		<ul class="text-primary"></ul>
+
+		<div class="container input-group mt-3" style="overflow-x: auto;">
+			<button id="ssl_provision_button" class="btn btn-primary"
+				onclick="return provision_tls_cert();">Provision</button>
+			<label class="input-group-text" for=""><b>By provisioning the certificates, you&rsquo;re agreeing to the <a
+						href="https://letsencrypt.org/repository">Let&rsquo;s Encrypt Subscriber Agreement</a>.</b></label>
+		</div>
+	</div>
 </div>
 
-<div class="clearfix"> </div>
-
-<div id="ssl_provision_result"></div>
-
-<div id="ssl_provision_problems_div" style="display: none;">
-<p style="margin-bottom: .5em;">Certificates cannot be automatically provisioned for:</p>
-<table id="ssl_provision_problems" style="margin-top: 0;" class="table">
-  <thead>
-    <tr>
-      <th>Domain</th>
-      <th>Problem</th>
-    </tr>
-  </thead>
-  <tbody>
-  </tbody>
-</table>
-<p>Use the <em>Install Certificate</em> button below for these domains.</p>
-</div>
-</div>
+<div id="ssl_provision_result" class="mt-4"></div>
 
 <h3>Certificate status</h3>
 
-<p style="margin-top: 1.5em">Certificates expire after a period of time. All certificates will be automatically renewed through <a href="https://letsencrypt.org/" target="_blank">Let&rsquo;s Encrypt</a> 14 days prior to expiration.</p>
+<p style="margin-top: 1.5em">Certificates expire after a period of time. All certificates will be automatically renewed
+	through <a href="https://letsencrypt.org/" target="_blank">Let&rsquo;s Encrypt</a> 14 days prior to expiration.</p>
 
-<table id="ssl_domains" class="table" style="margin-bottom: 2em; width: auto; display: none">
-  <thead>
-    <tr>
-      <th>Domain</th>
-      <th>Certificate Status</th>
-      <th>Actions</th>
-    </tr>
-  </thead>
-  <tbody>
-  </tbody>
+<table id="ssl_domains" class="table align-middle col-12" style="margin-bottom: 2em; display: none">
+	<caption></caption>
+	<thead>
+		<tr>
+			<th>Domain</th>
+			<th>Certificate Status</th>
+			<th></th>
+		</tr>
+	</thead>
+	<tbody>
+	</tbody>
 </table>
 
 
 <h3 id="ssl_install_header">Install certificate</h3>
 
-<p>If you don't want to use our automatic Let's Encrypt integration, you can give any other certificate provider a try. You can generate the needed CSR below.</p>
+<p>If you don't want to use our automatic Let's Encrypt integration, you can give any other certificate provider a try.
+	You can generate the needed CSR below.</p>
 
-<p>Which domain are you getting a certificate for?</p>
+<div class="col-lg-10 col-xl-8">
+	<div class="input-group">
+		<label class="input-group-text" for="ssldomain">Which domain are you getting a certificate for?</label>
+		<select id="ssldomain" onchange="show_csr()" class="form-select"></select>
+	</div>
+</div>
+<p><small>A multi-domain or wildcard certificate will be automatically applied to any domains it is valid for besides
+		the one you choose above.</small></p>
 
-<p><select id="ssldomain" onchange="show_csr()" class="form-control" style="width: auto"></select></p>
+<div class="col-lg-10 col-xl-8">
+	<div class="input-group">
+		<label class="input-group-text" for="sslcc">What country are you in?</label>
+		<select id="sslcc" onchange="show_csr()" class="form-select">
+			<option value="">(Select)</option>
+			{% for code, name in csr_country_codes %}
+			<option value="{{code}}">{{name}}</option>
+			{% endfor %}
+		</select>
+	</div>
+</div>
+<p><small>This is required by some TLS certificate providers. You may just pick any if you know your TLS certificate
+		provider doesn't require it.</small></p>
 
-<p>(A multi-domain or wildcard certificate will be automatically applied to any domains it is valid for besides the one you choose above.)</p>
+<div id="csr_info" style="display: none;">
+	<p>You will need to provide the certificate provider this Certificate Signing Request (CSR):</p>
 
-<p>What country are you in? This is required by some TLS certificate providers. You may leave this blank if you know your TLS certificate provider doesn't require it.</p>
+	<div class="col-lg-10 col-xl-8 mb-3">
+		<textarea class="form-control font-monospace" id="ssl_csr" style="min-height: 26.5em;" readonly></textarea>
+	</div>
 
-<p><select id="sslcc" onchange="show_csr()" class="form-control" style="width: auto">
-	<option value="">(Select)</option>
-	{% for code, name in csr_country_codes %}
-		<option value="{{code}}">{{name}}</option>
-	{% endfor %}
-</select></p>
+	<small>The CSR is safe to share. It can only be used in combination with a secret key stored on this machine.</small>
 
-<div id="csr_info" style="display: none">
-  <p>You will need to provide the certificate provider this Certificate Signing Request (CSR):</p>
+	<p>The certificate provider will then provide you with a TLS/SSL certificate. They may also provide you with an
+		intermediate chain. Paste each separately into the boxes below:</p>
 
-  <pre id="ssl_csr"></pre>
+	<div class="row g-4">
+		<div class="form-floating col-12 col-xl-6">
+			<textarea id="ssl_paste_cert" class="form-control" style="font-size:80%; font-family: monospace; height: 20em"
+				placeholder="-----BEGIN CERTIFICATE-----&#xA;stuff here&#xA;-----END CERTIFICATE-----"></textarea>
+			<label for="ssl_paste_cert" class="ms-3">TLS/SSL Certificate</label>
+		</div>
 
-  <p><small>The CSR is safe to share. It can only be used in combination with a secret key stored on this machine.</small></p>
+		<div class="form-floating col-12 col-xl-6">
+			<textarea id="ssl_paste_chain" class="form-control" style="font-size:80%; font-family: monospace; height: 20em"
+				placeholder="-----BEGIN CERTIFICATE-----&#xA;stuff here&#xA;-----END CERTIFICATE-----&#xA;-----BEGIN CERTIFICATE-----&#xA;more stuff here&#xA;-----END CERTIFICATE-----"></textarea>
+			<label for="ssl_paste_chain" class="ms-3">TLS/SSL intermediate Chain (if provided)</label>
+		</div>
+	</div>
 
-  <p>The certificate provider will then provide you with a TLS/SSL certificate. They may also provide you with an intermediate chain. Paste each separately into the boxes below:</p>
+	<br>
 
-  <p style="margin-bottom: .5em">TLS/SSL certificate:</p>
-  <p><textarea id="ssl_paste_cert" class="form-control" style="max-width: 40em; height: 8em" placeholder="-----BEGIN CERTIFICATE-----&#xA;stuff here&#xA;-----END CERTIFICATE-----"></textarea></p>
-
-  <p style="margin-bottom: .5em">TLS/SSL intermediate chain (if provided):</p>
-  <p><textarea id="ssl_paste_chain" class="form-control" style="max-width: 40em; height: 8em" placeholder="-----BEGIN CERTIFICATE-----&#xA;stuff here&#xA;-----END CERTIFICATE-----&#xA;-----BEGIN CERTIFICATE-----&#xA;more stuff here&#xA;-----END CERTIFICATE-----"></textarea></p>
-
-  <p>After you paste in the information, click the install button.</p>
-
-  <button class="btn-primary" onclick="install_cert()">Install</button>
+	<button class="btn btn-primary" onclick="install_cert()">Install</button>
 </div>
 
 <script>
-function show_tls(keep_provisioning_shown) {
- api(
-    "/ssl/status",
-    "GET",
-    {
-    },
-    function(res) {
-      // provisioning status
+	function show_tls(keep_provisioning_shown) {
+		api(
+			"/ssl/status",
+			"GET",
+			{
+			},
+			function (res) {
+				// provisioning status
 
-      if (!keep_provisioning_shown)
-        $('#ssl_provision').toggle(res.can_provision.length + res.cant_provision.length > 0)
+				$("#ssl_provision_p ul").html("")
+				if (!keep_provisioning_shown)
+					$('#ssl_provision').toggle(res.can_provision.length > 0)
 
-      $('#ssl_provision_p').toggle(res.can_provision.length > 0);
-      if (res.can_provision.length > 0)
-          $('#ssl_provision_p span').text(res.can_provision.join(", "));
+				$('#ssl_provision_p').toggle(res.can_provision.length > 0);
+				if (res.can_provision.length > 0) {
+					let hostlist = $("#ssl_provision_p ul")
+					res.can_provision.forEach(domain => {
+						$("#ssl_provision_p ul").append($("<li></li>").text(domain))
+					});
+				}
 
-      $('#ssl_provision_problems_div').toggle(res.cant_provision.length > 0);
-      $('#ssl_provision_problems tbody').text("");
-      for (var i = 0; i < res.cant_provision.length; i++) {
-        var domain = res.cant_provision[i];
-        var row = $("<tr><th class='domain'><a href=''></a></th><td class='status'></td></tr>");
-        $('#ssl_provision_problems tbody').append(row);
-        row.attr('data-domain', domain.domain);
-        row.find('.domain a').text(domain.domain);
-        row.find('.domain a').attr('href', 'https://' + domain.domain);
-        row.find('.status').text(domain.problem);
-      }
+				// certificate status
+				var domains = res.status;
+				var tb = $('#ssl_domains tbody');
+				tb.text('');
+				$('#ssldomain').html('<option value="">(select)</option>');
+				$('#ssl_domains').show();
+				for (var i = 0; i < domains.length; i++) {
+					var row = $("<tr><th class='text-wrap'></th><td class='status'><div class='icon fas'></div><span class='status-text'></span></td> <td class='actions'><a href='#' onclick='return ssl_install(this);' class='btn btn-xs'>Install Certificate</a></td></tr>");
+					tb.append(row);
+					row.attr('data-domain', domains[i].domain);
+					row.find('th').text(domains[i].domain);
+					if (domains[i].status == "not-applicable") {
+						row.find('.actions a').remove(); // no actions applicable
+					}
+					let statusclass
+					let faclass
+					switch (domains[i].status) {
+						case "success":
+							statusclass = "status-ok"
+							faclass = "fa-check"
+							row.find('.actions a').addClass('btn-default').text('Replace Certificate');
+							break;
+						case "warning":
+							statusclass = "status-warning"
+							faclass = "fa-exclamation-triangle"
+							row.find('.actions a').addClass('btn-secondary').text('Install Certificate');
+							break;
+						case "danger":
+							statusclass = "status-error"
+							faclass = "fa-times"
+							row.find('.actions a').addClass('btn-secondary').text('Install Certificate');
+							break;
+						default:
+							statusclass = "status-na"
+							row.find('.actions a').remove()
+							break;
+					}
+					let txt = row.find(".status")
+					txt.addClass(statusclass);
+					txt.find(".fas").addClass(faclass)
+					txt.find("span").text(domains[i].text);
 
-      // certificate status
-      var domains = res.status;
-      var tb = $('#ssl_domains tbody');
-      tb.text('');
-      $('#ssldomain').html('<option value="">(select)</option>');
-      $('#ssl_domains').show();
-      for (var i = 0; i < domains.length; i++) {
-        var row = $("<tr><th class='domain'><a href=''></a></th><td class='status'></td> <td class='actions'><a href='#' onclick='return ssl_install(this);' class='btn btn-xs'>Install Certificate</a></td></tr>");
-        tb.append(row);
-        row.attr('data-domain', domains[i].domain);
-        row.find('.domain a').text(domains[i].domain);
-        row.find('.domain a').attr('href', 'https://' + domains[i].domain);
-        if (domains[i].status == "not-applicable") {
-          domains[i].status = "muted"; // text-muted css class
-          row.find('.actions a').remove(); // no actions applicable
-        }
-        row.addClass("text-" + domains[i].status);
-        row.find('.status').text(domains[i].text);
-        if (domains[i].status == "success") {
-          row.find('.actions a').addClass('btn-default').text('Replace Certificate');
-        } else {
-          row.find('.actions a').addClass('btn-primary').text('Install Certificate');
-        }
+					$('#ssldomain').append($('<option>').text(domains[i].domain));
+				}
+			});
+	}
 
-        $('#ssldomain').append($('<option>').text(domains[i].domain));
-      }
-    });
-}
+	function ssl_install(elem) {
+		var domain = $(elem).parents('tr').attr('data-domain');
+		$('#ssldomain').val(domain);
+		show_csr();
+		$('html, body').animate({ scrollTop: $('#ssl_install_header').offset().top - $('.navbar-fixed-top').height() - 20 })
+		return false;
+	}
 
-function ssl_install(elem) {
-  var domain = $(elem).parents('tr').attr('data-domain');
-  $('#ssldomain').val(domain);
-  show_csr();
-  $('html, body').animate({ scrollTop: $('#ssl_install_header').offset().top - $('.navbar-fixed-top').height() - 20 })
-  return false;
-}
+	function show_csr() {
+		// Can't show a CSR until both inputs are entered.
+		if ($('#ssldomain').val() == "") return;
+		if ($('#sslcc').val() == "") return;
 
-function show_csr() {
- if ($('#ssldomain').val() == "") return;
- $('#csr_info').slideDown();
- $('#ssl_csr').text('Loading...');
- api(
-    "/ssl/csr/" + $('#ssldomain').val(),
-    "POST",
-    {
-        countrycode: $('#sslcc').val()
-    },
-    function(data) {
-      $('#ssl_csr').text(data);
-    });
-}
+		// Scroll to it and fetch.
+		$('#csr_info').slideDown();
+		$('#ssl_csr').text('Loading...');
+		api(
+			"/ssl/csr/" + $('#ssldomain').val(),
+			"POST",
+			{
+				countrycode: $('#sslcc').val()
+			},
+			function (data) {
+				$('#ssl_csr').text(data);
+			});
+	}
 
-function install_cert() {
- api(
-    "/ssl/install",
-    "POST",
-    {
-      domain: $('#ssldomain').val(),
-      cert: $('#ssl_paste_cert').val(),
-      chain: $('#ssl_paste_chain').val()
-    },
-    function(status) {
-      if (/^OK($|\n)/.test(status)) {
-        console.log(status)
-        show_modal_error("TLS Certificate Installation", "Certificate has been installed. Check that you have no connection problems to the domain.", function() { show_ssl(); $('#csr_info').slideUp(); });
-      } else {
-        show_modal_error("TLS Certificate Installation", status);
-      }
-    });
-}
+	function install_cert() {
+		api(
+			"/ssl/install",
+			"POST",
+			{
+				domain: $('#ssldomain').val(),
+				cert: $('#ssl_paste_cert').val(),
+				chain: $('#ssl_paste_chain').val()
+			},
+			function (status) {
+				if (/^OK($|\n)/.test(status)) {
+					console.log(status)
+					show_modal_error("TLS Certificate Installation", "Certificate has been installed. Check that you have no connection problems to the domain.", function () { show_ssl(); $('#csr_info').slideUp(); });
+				} else {
+					show_modal_error("TLS Certificate Installation", status);
+				}
+			});
+	}
 
-var agree_to_tos_url_prompt = null;
-var agree_to_tos_url = null;
-function provision_tls_cert() {
-  // Automatically provision any certs.
-  $('#ssl_provision_p .btn').attr('disabled', '1'); // prevent double-clicks
-  api(
-    "/ssl/provision",
-    "POST",
-    {
-      agree_to_tos_url: agree_to_tos_url
-    },
-    function(status) {
-      // Clear last attempt.
-      agree_to_tos_url = null;
-      $('#ssl_provision_result').text("");
-      may_reenable_provision_button = true;
+	function provision_tls_cert() {
+		// Automatically provision any certs.
+		$('#ssl_provision_p .btn').attr('disabled', '1'); // prevent double-clicks
+		api(
+			"/ssl/provision",
+			"POST",
+			{},
+			function (status) {
+				// Clear last attempt.
+				$('#ssl_provision_result').html("");
+				may_reenable_provision_button = true;
 
-      // Nothing was done. There might also be problem domains, but we've already displayed those.
-      if (status.requests.length == 0) {
-        show_modal_error("TLS Certificate Provisioning", "There were no domain names to provision certificates for.");
-        // don't return - haven't re-enabled the provision button
-      }
+				// Nothing was done. There might also be problem domains, but we've already displayed those.
+				if (status.requests.length == 0) {
+					show_modal_error("TLS Certificate Provisioning", "There were no domain names to provision certificates for.");
+					// don't return - haven't re-enabled the provision button
+				}
 
-      // Each provisioning API call returns zero or more "requests" which represent
-      // a request to Let's Encrypt for a single certificate. Normally there is just
-      // one request (for a single multi-domain certificate).
-      for (var i = 0; i < status.requests.length; i++) {
-        var r = status.requests[i];
+				// Each provisioning API call returns zero or more "requests" which represent
+				// a request to Let's Encrypt for a single certificate. Normally there is just
+				// one request (for a single multi-domain certificate).
+				let global_logs = []
+				for (var i = 0; i < status.requests.length; i++) {
+					var r = status.requests[i];
 
-        // create an HTML block to display the results of this request
-        var n = $("<div><h4/><p/></div>");
-        $('#ssl_provision_result').append(n);
+					if (r.result == "skipped") {
+						// not interested --- this domain wasn't in the table
+						// to begin with
+						continue;
+					}
 
-        // show a header only to disambiguate request blocks
-        if (status.requests.length > 0)
-          n.find("h4").text(r.domains.join(", "));
+					// plain log line
+					if (typeof r === "string") {
+						if (r !== "") {
+							global_logs.append(r)
+						}
+						continue;
+					}
 
-        if (r.result == "agree-to-tos") {
-          // user needs to agree to Let's Encrypt's TOS
-          agree_to_tos_url_prompt = r.url;
-          $('#ssl_provision_p .btn').attr('disabled', '1');
-          n.find("p").html("Please open and review <a href='" + r.url + "' target='_blank'>Let's Encrypt's terms of service agreement</a>. You must agree to their terms for a certificate to be automatically provisioned from them.");
-          n.append($('<button onclick="agree_to_tos_url = agree_to_tos_url_prompt; return provision_tls_cert();" class="btn btn-success" style="margin-left: 2em">Agree &amp; Try Again</button>'));
+					let n = $("<div class=\"card mb-3\"><h5 class=\"card-header text-white code-white\"></h5><div class=\"card-body bg-light small\"></div></div>");
+					$('#ssl_provision_result').append(n);
 
-          // don't re-enable the Provision button -- user must use the Agree button
-          may_reenable_provision_button = false;
+					if (status.requests.length > 0) {
+						n.find(".card-header").html(`Logs for ${r.domains.map((h) => { return `<code>${h}</code>` }).join(", ")}`);
+					}
 
-        } else if (r.result == "error") {
-          n.find("p").addClass("text-danger").text(r.message);
+					if (r.result == "error") {
+						n.find(".card-header").addClass("bg-danger")
+					} else if (r.result == "installed") {
+						n.find(".card-header").addClass("bg-success")
+						setTimeout("show_tls(true)", 1);
+					}
 
-        } else if (r.result == "wait") {
-          // Show a button that counts down to zero, at which point it becomes enabled.
-          n.find("p").text("A certificate is now in the process of being provisioned, but it takes some time. Please wait until the Finish button is enabled, and then click it to acquire the certificate.");
-          var b = $('<button onclick="return provision_tls_cert();" class="btn btn-success" style="margin-left: 2em">Finish</button>');
-          b.attr("disabled", "1");
-          var now = new Date();
-          n.append(b);
-          function ready_to_finish() {
-            var remaining = Math.round(r.seconds - (new Date() - now)/1000);
-            if (remaining > 0) {
-              setTimeout(ready_to_finish, 1000);
-              b.text("Finish (" + remaining + "...)")
-            } else {
-              b.text("Finish (ready)")
-              b.removeAttr("disabled");
-            }
-          }
-          ready_to_finish();
+					// display the detailed log info in case of problems
+					let logs = r.log.join("\n")
+					if (logs === "" || logs === null || logs === undefined) {
+						logs = "Something wrong happened, sorry!"
+					}
+					n.find("div").text(logs);
+				}
 
-          // don't re-enable the Provision button -- user must use the Retry button when it becomes enabled
-          may_reenable_provision_button = false;
+				if (global_logs.length !== 0) {
+					let card = $("<div class=\"card mb-3\"><div class=\"card-body small\"></div></div>")
+					$('#ssl_provision_result').append(card);
+					n.find(".card-body").text(global_logs.join("\n"))
+				}
 
-        } else if (r.result == "installed") {
-          n.find("p").addClass("text-success").text("The TLS certificate was provisioned and installed.");
-          setTimeout("show_tls(true)", 1); // update main table of certificate statuses, call with arg keep_provisioning_shown true so that we don't clear what we just outputted
-        }
-
-        // display the detailed log info in case of problems
-        var trace = $("<div class='small text-muted' style='margin-top: 1.5em'>Log:</div>");
-        n.append(trace);
-        for (var j = 0; j < r.log.length; j++)
-          trace.append($("<div/>").text(r.log[j]));
-
-      }
-
-      if (may_reenable_provision_button)
-        $('#ssl_provision_p .btn').removeAttr("disabled");
-    });
-}
+				if (may_reenable_provision_button) {
+					$('#ssl_provision_p .btn').removeAttr("disabled");
+				}
+			});
+	}
 </script>

management/templates/sync-guide.html

@@ -5,44 +5,91 @@
 
 	<hr>
 
-	<div class="row">
-		<div class="col-sm-6">
+	<div class="row d-flex">
+		<div class="col-lg-6">
 			<h4>In your browser</h4>
 
 			<p>You can edit your contacts and calendar from your web browser.</p>
 
 			<table class="table">
-			<thead><tr><th>For...</th> <th>Visit this URL</th></tr></thead>
-			<tr><th>Contacts</td> <td><a href="https://{{hostname}}/cloud/contacts">https://{{hostname}}/cloud/contacts</a></td></tr>
-			<tr><th>Calendar</td> <td><a href="https://{{hostname}}/cloud/calendar">https://{{hostname}}/cloud/calendar</a></td></tr>
+				<caption></caption>
+				<thead>
+					<tr>
+						<th>For...</th>
+						<th>Visit this URL</th>
+					</tr>
+				</thead>
+				<tr>
+					<th>Contacts</td>
+					<td><a href="https://{{hostname}}/cloud/contacts">https://{{hostname}}/cloud/contacts</a></td>
+				</tr>
+				<tr>
+					<th>Calendar</td>
+					<td><a href="https://{{hostname}}/cloud/calendar">https://{{hostname}}/cloud/calendar</a></td>
+				</tr>
 			</table>
 
-			<p>Log in settings are the same as with <a href="#mail-guide" onclick="return show_panel(this);">mail</a>: your
-			complete email address and your mail password.</p>
+			<p>Log in settings are the same as with <a href="#mail-guide" onclick="return show_panel(this);">mail</a>:
+				your
+				complete email address and your mail password.</p>
 		</div>
 
-		<div class="col-sm-6">
+		<div class="col-lg-6">
 			<h4>On your mobile device</h4>
 
-			<p>If you set up your <a href="#mail-guide" onclick="return show_panel(this);">mail</a> using Exchange/ActiveSync,
-			your contacts and calendar may already appear on your device.</p>
+			<p>If you set up your <a href="#mail-guide" onclick="return show_panel(this);">mail</a> using
+				Exchange/ActiveSync,
+				your contacts and calendar may already appear on your device.</p>
 			<p>Otherwise, here are some apps that can synchronize your contacts and calendar to your Android phone.</p>
 
 			<table class="table">
-			<thead><tr><th>For...</th> <th>Use...</th></tr></thead>
-			<tr><td>Contacts and Calendar</td> <td><a href="https://play.google.com/store/apps/details?id=at.bitfire.davdroid">DAVdroid</a> ($3.69; free <a href="https://f-droid.org/repository/browse/?fdfilter=dav&fdid=at.bitfire.davdroid">here</a>)</td></tr>
-			<tr><td>Only Contacts</td> <td><a href="https://play.google.com/store/apps/details?id=org.dmfs.carddav.sync">CardDAV-Sync free beta</a> (free)</td></tr>
-			<tr><td>Only Calendar</td> <td><a href="https://play.google.com/store/apps/details?id=org.dmfs.caldav.lib">CalDAV-Sync</a> ($2.89)</td></tr>
+				<caption></caption>
+				<thead>
+					<tr>
+						<th>For...</th>
+						<th>Use...</th>
+					</tr>
+				</thead>
+				<tr>
+					<td>Contacts and Calendar</td>
+					<td><a href="https://play.google.com/store/apps/details?id=at.bitfire.davdroid">DAVx⁵</a> ($5.99;
+						free <a href="https://f-droid.org/packages/at.bitfire.davdroid/">here</a>)</td>
+				</tr>
+				<tr>
+					<td>Only Contacts</td>
+					<td><a href="https://play.google.com/store/apps/details?id=org.dmfs.carddav.sync">CardDAV-Sync
+							free</a> (free)</td>
+				</tr>
+				<tr>
+					<td>Only Calendar</td>
+					<td><a href="https://play.google.com/store/apps/details?id=org.dmfs.caldav.lib">CalDAV-Sync</a>
+						($2.99)</td>
+				</tr>
 			</table>
 
 			<p>Use the following settings:</p>
 
 			<table class="table">
-			<tr><td>Account Type</td> <td>CardDAV or CalDAV</td></tr>
-			<tr><td>Server Name</td> <td>{{hostname}}</td></tr>
-			<tr><td>Use SSL</td> <td>Yes</td></tr>
-			<tr><td>Username</td> <td>Your complete email address.</td></tr>
-			<tr><td>Password</td> <td>Your mail password.</td></tr>
+				<tr>
+					<td>Account Type</td>
+					<td>CardDAV or CalDAV</td>
+				</tr>
+				<tr>
+					<td>Server Name</td>
+					<td>{{hostname}}</td>
+				</tr>
+				<tr>
+					<td>Use SSL</td>
+					<td>Yes</td>
+				</tr>
+				<tr>
+					<td>Username</td>
+					<td>Your complete email address.</td>
+				</tr>
+				<tr>
+					<td>Password</td>
+					<td>Your mail password.</td>
+				</tr>
 			</table>
 		</div>
 	</div>

management/templates/system-backup.html

@@ -1,280 +1,416 @@
 <style>
-#backup-status th { text-align: center; }
-#backup-status tr.full-backup td { font-weight: bold; }
+	#backup-status tr.full-backup td {
+		font-weight: bold;
+	}
 </style>
 
 <h2>Backup Status</h2>
 
-<p>The box makes an incremental backup each night. By default the backup is stored on the machine itself, but you can also have it stored on Amazon S3.</p>
+<p>The box makes an incremental backup each night. By default the backup is stored on the machine itself, but you can
+	also store it on S3-compatible services like Amazon Web Services (AWS).</p>
 
 <h3>Configuration</h3>
 
 <form class="form-horizontal" role="form" onsubmit="set_custom_backup(); return false;">
-  <div class="form-group">
-    <label for="backup-target-type" class="col-sm-2 control-label">Backup to:</label>
-    <div class="col-sm-2">
-      <select class="form-control" rows="1" id="backup-target-type" onchange="toggle_form()">
-        <option value="off">Nowhere (Disable Backups)</option>
-        <option value="local">{{hostname}}</option>
-        <option value="rsync">rsync</option>
-        <option value="s3">Amazon S3</option>
-      </select>
-    </div>
-  </div>
-  <!-- LOCAL BACKUP -->
-  <div class="form-group backup-target-local">
-    <div class="col-sm-10 col-sm-offset-2">
-      <p>Backups are stored on this machine&rsquo;s own hard disk. You are responsible for periodically using SFTP (FTP over SSH) to copy the backup files from <tt class="backup-location"></tt> to a safe location. These files are encrypted, so they are safe to store anywhere.</p>
-      <p>Separately copy the encryption password from <tt class="backup-encpassword-file"></tt> to a safe and secure location. You will need this file to decrypt backup files.</p>
-    </div>
-  </div>
-  <!-- RSYNC BACKUP -->
-  <div class="form-group backup-target-rsync">
-    <div class="col-sm-10 col-sm-offset-2">
+	<div class="col-lg-10 col-xl-8">
+		<div class="input-group">
+			<label class="input-group-text" for="backup-target-type">Backup to</label>
+			<select class="form-select" rows="1" id="backup-target-type" onchange="toggle_form()">
+				<option value="off">Nowhere (Disable Backups)</option>
+				<option value="local">{{hostname}}</option>
+				<option value="rsync">rsync</option>
+				<option value="s3">S3 (Amazon or compatible) </option>
+				<option value="b2">Backblaze B2</option>
+			</select>
+		</div>
+	</div>
 
-      <p>Backups synced to a remote machine using rsync over SSH, with local
-      copies in <tt class="backup-location"></tt>. These files are encrypted, so
-      they are safe to store anywhere.</p> <p>Separately copy the encryption
-      password from <tt class="backup-encpassword-file"></tt> to a safe and
-      secure location. You will need this file to decrypt backup files.</p>
+	<!-- LOCAL BACKUP -->
+	<div class="form-group backup-target-local">
+		<div class="col-lg-10 col-xl-8 mb-3">
+			<p>Backups are stored on this machine&rsquo;s own hard disk. You are responsible for periodically using SFTP (FTP
+				over SSH) to copy the backup files from <tt class="backup-location"></tt> to a safe location. These files are
+				encrypted, so they are safe to store anywhere.</p>
+			<p>Separately copy the encryption password from <tt class="backup-encpassword-file"></tt> to a safe and secure
+				location. You will need this file to decrypt backup files.</p>
+		</div>
+	</div>
+	<!-- RSYNC BACKUP -->
+	<div class="form-group backup-target-rsync">
+		<div class="col-lg-10 col-xl-8 mb-3">
 
-    </div>
-  </div>
-  <div class="form-group backup-target-rsync">
-    <label for="backup-target-rsync-host" class="col-sm-2 control-label">Hostname</label>
-    <div class="col-sm-8">
-      <input type="text" placeholder="hostname.local" class="form-control" rows="1" id="backup-target-rsync-host">
-    </div>
-  </div>
-  <div class="form-group backup-target-rsync">
-    <label for="backup-target-rsync-path" class="col-sm-2 control-label">Path</label>
-    <div class="col-sm-8">
-        <input type="text" placeholder="/backups/{{hostname}}" class="form-control" rows="1" id="backup-target-rsync-path">
-    </div>
-  </div>
-  <div class="form-group backup-target-rsync">
-    <label for="backup-target-rsync-user" class="col-sm-2 control-label">Username</label>
-    <div class="col-sm-8">
-      <input type="text" class="form-control" rows="1" id="backup-target-rsync-user">
-    </div>
-  </div>
-  <div class="form-group backup-target-rsync">
-    <label for="ssh-pub-key" class="col-sm-2 control-label">Public SSH Key</label>
-    <div class="col-sm-8">
-      <input type="text" class="form-control" rows="1" id="ssh-pub-key" readonly>
-      <div class="small" style="margin-top: 2px">
-        Copy the Public SSH Key above, and paste it within the <tt>~/.ssh/authorized_keys</tt>
-        of target user on the backup server specified above. That way you'll enable secure and
-        passwordless authentication from your mail-in-a-box server and your backup server.
-      </div>
-    </div>
-  </div>
-  <!-- S3 BACKUP -->
-  <div class="form-group backup-target-s3">
-    <div class="col-sm-10 col-sm-offset-2">
-      <p>Backups are stored in an Amazon Web Services S3 bucket. You must have an AWS account already.</p>
-      <p>You MUST manually copy the encryption password from <tt class="backup-encpassword-file"></tt> to a safe and secure location. You will need this file to decrypt backup files. It is NOT stored in your Amazon S3 bucket.</p>
-    </div>
-  </div>
-  <div class="form-group backup-target-s3">
-    <label for="backup-target-s3-host" class="col-sm-2 control-label">S3 Region</label>
-    <div class="col-sm-8">
-      <select class="form-control" rows="1" id="backup-target-s3-host">
-        {% for name, host in backup_s3_hosts %}
-          <option value="{{host}}">{{name}}</option>
-        {% endfor %}
-      </select>
-    </div>
-  </div>
-  <div class="form-group backup-target-s3">
-    <label for="backup-target-s3-path" class="col-sm-2 control-label">S3 Path</label>
-    <div class="col-sm-8">
-      <input type="text" placeholder="your-bucket-name/backup-directory" class="form-control" rows="1" id="backup-target-s3-path">
-    </div>
-  </div>
-  <div class="form-group backup-target-s3">
-    <label for="backup-target-user" class="col-sm-2 control-label">S3 Access Key</label>
-    <div class="col-sm-8">
-      <input type="text" class="form-control" rows="1" id="backup-target-user">
-    </div>
-  </div>
-  <div class="form-group backup-target-s3">
-    <label for="backup-target-pass" class="col-sm-2 control-label">S3 Secret Access Key</label>
-    <div class="col-sm-8">
-      <input type="text" class="form-control" rows="1" id="backup-target-pass">
-    </div>
-  </div>
-  <!-- Common -->
-  <div class="form-group backup-target-local backup-target-rsync backup-target-s3">
-    <label for="min-age" class="col-sm-2 control-label">Days:</label>
-    <div class="col-sm-8">
-      <input type="number" class="form-control" rows="1" id="min-age">
-      <div class="small" style="margin-top: 2px">This is the <i>minimum</i> number of days backup data is kept for. The box makes an incremental backup, so backup data is often kept much longer. An incremental backup file that is less than this number of days old requires that all previous increments back to the most recent full backup, plus that full backup, remain available.</div>
-    </div>
-  </div>
-  <div class="form-group">
-    <div class="col-sm-offset-2 col-sm-10">
-      <button id="set-s3-backup-button" type="submit" class="btn btn-primary">Save</button>
-    </div>
-  </div>
+			<p>Backups synced to a remote machine using rsync over SSH, with local
+				copies in <tt class="backup-location"></tt>. These files are encrypted, so
+				they are safe to store anywhere.</p>
+			<p>Separately copy the encryption
+				password from <tt class="backup-encpassword-file"></tt> to a safe and
+				secure location. You will need this file to decrypt backup files.</p>
+
+		</div>
+	</div>
+	<div class="col-lg-10 col-xl-8 mb-3 backup-target-rsync">
+		<div class="input-group">
+			<label class="input-group-text">Where to?</label>
+			<input type="text" class="form-control" id="backup-target-rsync-host" placeholder="hostname.local">
+			<label class="input-group-text">:</label>
+			<div style="width: 20%">
+				<input type="number" class="form-control" id="backup-target-rsync-port" placeholder="Port (22)">
+			</div>
+		</div>
+	</div>
+	<div class="col-lg-10 col-xl-8 mb-3 backup-target-rsync">
+		<div class="input-group">
+			<label for="backup-target-rsync-path" class="input-group-text">Path</label>
+			<input type="text" placeholder="/backups/{{hostname}}" class="form-control" id="backup-target-rsync-path">
+		</div>
+	</div>
+	<div class="col-lg-10 col-xl-8 mb-3 backup-target-rsync">
+		<div class="input-group">
+			<label for="backup-target-rsync-path" class="input-group-text">Username</label>
+			<input type="text" class="form-control" id="backup-target-rsync-user">
+		</div>
+	</div>
+	<div class="col-lg-10 col-xl-8 mb-3 backup-target-rsync">
+		<label for="ssh-pub-key" class="col-sm-2 control-label">
+			<h4>Public SSH Key</h4>
+		</label>
+		<textarea class="form-control font-monospace" id="ssh-pub-key" style="min-height: 12em;" readonly></textarea>
+		<div class="small" style="margin-top: 2px">
+			Copy the Public SSH Key above, and paste it within the <tt>~/.ssh/authorized_keys</tt>
+			of target user on the backup server specified above. That way you'll enable secure and
+			passwordless authentication from your mail-in-a-box server and your backup server.
+		</div>
+	</div>
+	<!-- S3 BACKUP -->
+	<div class="col-lg-10 col-xl-8 mb-3 backup-target-s3">
+		<p>Backups are stored in an S3-compatible bucket. You must have an AWS or other S3 service account already.</p>
+		<p>You MUST manually copy the encryption password from <tt class="backup-encpassword-file"></tt> to a safe and
+			secure location. You will need this file to decrypt backup files. It is <b>NOT</b> stored in your S3 bucket.</p>
+	</div>
+	<div class="col-lg-10 col-xl-8 mb-3 backup-target-s3">
+		<div class="input-group">
+			<label for="backup-target-s3-host-select" class="input-group-text">S3 Region</label>
+			<select class="form-select" id="backup-target-s3-host-select">
+				{% for name, host in backup_s3_hosts %}
+				<option value="{{host}}">{{name}}</option>
+				{% endfor %}
+				<option value="other">Other (non AWS)</option>
+			</select>
+		</div>
+	</div>
+	<div class="col-lg-10 col-xl-8 mb-3 backup-target-s3">
+		<div class="input-group">
+			<label for="backup-target-s3-host" class="input-group-text">S3 Host / Endpoint</label>
+			<input type="text" placeholder="Endpoint" class="form-control" id="backup-target-s3-host">
+		</div>
+	</div>
+	<div class="col-lg-10 col-xl-8 mb-3 backup-target-s3">
+		<div class="input-group">
+			<label for="backup-target-s3-path" class="input-group-text">S3 Path</label>
+			<input type="text" placeholder="your-bucket-name/backup-directory" class="form-control"
+				id="backup-target-s3-path">
+		</div>
+	</div>
+	<div class="col-lg-10 col-xl-8 mb-3 backup-target-s3">
+		<div class="input-group">
+			<label for="backup-target-user" class="input-group-text">S3 Access Key</label>
+			<input type="text" class="form-control" id="backup-target-user">
+		</div>
+	</div>
+	<div class="col-lg-10 col-xl-8 mb-3 backup-target-s3">
+		<div class="input-group">
+			<label for="backup-target-pass" class="input-group-text">S3 Secret Access Key</label>
+			<input type="text" class="form-control" id="backup-target-pass">
+		</div>
+	</div>
+	<!-- Backblaze -->
+	<div class="col-lg-10 col-xl-8 mb-3 backup-target-b2">
+		<p>Backups are stored in a <a href="https://www.backblaze.com/" target="_blank" rel="noreferrer">Backblaze</a> B2
+			bucket. You must have a Backblaze account already.</p>
+		<p>You MUST manually copy the encryption password from <tt class="backup-encpassword-file"></tt> to a safe and
+			secure location. You will need this file to decrypt backup files. It is NOT stored in your Backblaze B2 bucket.
+		</p>
+	</div>
+	<div class="col-lg-10 col-xl-8 mb-3 backup-target-b2">
+		<div class="input-group">
+			<label for="backup-target-b2-user" class="input-group-text">B2 Application KeyID</label>
+			<input type="text" class="form-control" id="backup-target-b2-user">
+		</div>
+	</div>
+	<div class="col-lg-10 col-xl-8 mb-3 backup-target-b2">
+		<div class="input-group">
+			<label for="backup-target-b2-pass" class="input-group-text">B2 Application Key</label>
+			<input type="text" class="form-control" id="backup-target-b2-pass">
+		</div>
+	</div>
+	<div class="col-lg-10 col-xl-8 mb-3 backup-target-b2">
+		<div class="input-group">
+			<label for="backup-target-b2-bucket" class="input-group-text">B2 Bucket</label>
+			<input type="text" class="form-control" id="backup-target-b2-bucket">
+		</div>
+	</div>
+	<!-- Common -->
+	<div class="backup-target-local backup-target-rsync backup-target-s3 backup-target-b2">
+		<hr>
+		<div class="col-lg-10 col-xl-8">
+			<div class="input-group">
+				<label class="input-group-text" for="backup-min-age">Retention Days</label>
+				<input type="number" class="form-control" id="backup-min-age">
+			</div>
+			<div class="small" style="margin-top: 2px">This is the minimum time backup data is kept for. The box makes an
+				incremental backup most nights, which requires that previous backups back to the most recent full backup be
+				preserved, so backup data is often kept much longer than this setting. Full backups are made periodically when
+				the incremental backup data size exceeds a limit.</div>
+		</div>
+	</div>
+	<div class="mt-3">
+		<button id="set-s3-backup-button" type="submit" class="btn btn-primary">Save</button>
+	</div>
 </form>
 
 <h3>Available backups</h3>
 
-<p>The backup location currently contains the backups listed below. The total size of the backups is currently <span id="backup-total-size"></span>.</p>
+<p>The backup location currently contains the backups listed below. The total size of the backups is currently <span
+		id="backup-total-size"></span>.</p>
 
-<table id="backup-status" class="table" style="width: auto">
-  <thead>
-    <th colspan="2">When</th>
-    <th>Type</th>
-    <th>Size</th>
-    <th>Deleted in...</th>
-  </thead>
-  <tbody>
-  </tbody>
+<table id="backup-status" class="table align-middle col-12">
+	<caption></caption>
+	<thead>
+		<th colspan="2">When</th>
+		<th>Type</th>
+		<th>Size</th>
+		<th>Deleted in...</th>
+	</thead>
+	<tbody>
+	</tbody>
 </table>
+
+<!-- Hide these buttons until we're sure we can use them :) -->
+<div class="row justify-content-evenly">
+	<button id="create-full-backup-button" class="btn btn-primary col-3" onclick="do_backup(true)"
+		style="display: none;">Create Full Backup Now</button>
+	<button id="create-incremental-backup-button" class="btn btn-primary col-3" onclick="do_backup(false)"
+		style="display: none;">Create Incremental Backup Now</button>
+</div>
+
 <script>
 
-function toggle_form() {
-  var target_type = $("#backup-target-type").val();
-  $(".backup-target-local, .backup-target-rsync, .backup-target-s3").hide();
-  $(".backup-target-" + target_type).show();
-}
+	function toggle_form() {
+		var target_type = $("#backup-target-type").val();
+		$(".backup-target-local, .backup-target-rsync, .backup-target-s3, .backup-target-b2").hide();
+		$(".backup-target-" + target_type).show();
 
-function nice_size(bytes) {
-  var powers = ['bytes', 'KB', 'MB', 'GB', 'TB'];
-  while (true) {
-    if (powers.length == 1) break;
-    if (bytes < 1000) break;
-    bytes /= 1024;
-    powers.shift();
-  }
-  // round to have three significant figures but at most one decimal place
-  if (bytes >= 100)
-    bytes = Math.round(bytes)
-  else
-    bytes = Math.round(bytes*10)/10;
-  return bytes + " " + powers[0];
-}
+		init_inputs(target_type);
+	}
 
-function show_system_backup() {
-  show_custom_backup()
+	function nice_size(bytes) {
+		var powers = ['bytes', 'KB', 'MB', 'GB', 'TB'];
+		while (true) {
+			if (powers.length == 1) break;
+			if (bytes < 1000) break;
+			bytes /= 1024;
+			powers.shift();
+		}
+		// round to have three significant figures but at most one decimal place
+		if (bytes >= 100)
+			bytes = Math.round(bytes)
+		else
+			bytes = Math.round(bytes * 10) / 10;
+		return bytes + " " + powers[0];
+	}
 
-  $('#backup-status tbody').html("<tr><td colspan='2' class='text-muted'>Loading...</td></tr>")
-  api(
-    "/system/backup/status",
-    "GET",
-    { },
-    function(r) {
-      if (r.error) {
-          show_modal_error("Backup Error", $("<pre/>").text(r.error));
-          return;
-      }
+	function show_system_backup() {
+		show_custom_backup()
 
-      $('#backup-status tbody').html("");
-      var total_disk_size = 0;
+		$('#backup-status tbody').html("<tr><td colspan='5' class='text-muted'>Loading...</td></tr>")
+		api(
+			"/system/backup/status",
+			"GET",
+			{},
+			function (r) {
+				if (r.error) {
+					show_modal_error("Backup Error", $("<pre/>").text(r.error));
+					return;
+				}
 
-      if (typeof r.backups == "undefined") {
-        var tr = $('<tr><td colspan="3">Backups are turned off.</td></tr>');
-        $('#backup-status tbody').append(tr);
-        return;
-      } else if (r.backups.length == 0) {
-        var tr = $('<tr><td colspan="3">No backups have been made yet.</td></tr>');
-        $('#backup-status tbody').append(tr);
-      }
+				$('#backup-status tbody').html("");
+				var total_disk_size = 0;
 
-      for (var i = 0; i < r.backups.length; i++) {
-        var b = r.backups[i];
-        var tr = $('<tr/>');
-        if (b.full) tr.addClass("full-backup");
-        tr.append( $('<td/>').text(b.date_str) );
-        tr.append( $('<td/>').text(b.date_delta + " ago") );
-        tr.append( $('<td/>').text(b.full ? "full" : "increment") );
-        tr.append( $('<td style="text-align: right"/>').text( nice_size(b.size)) );
-        if (b.deleted_in)
-          tr.append( $('<td/>').text(b.deleted_in) );
-        else
-          tr.append( $('<td class="text-muted">unknown</td>') );
-        $('#backup-status tbody').append(tr);
+				if (typeof r.backups == "undefined") {
+					var tr = $('<tr><td colspan="5">Backups are turned off.</td></tr>');
+					$('#backup-status tbody').append(tr);
+					$('#create-full-backup-button').css("display", "none")
+					$('#create-incremental-backup-button').css("display", "none")
+					return;
+				} else if (r.backups.length == 0) {
+					var tr = $('<tr><td colspan="5">No backups have been made yet.</td></tr>');
+					$('#backup-status tbody').append(tr);
+				}
 
-        total_disk_size += b.size;
-      }
+				// Backups ARE enabled.
+				$('#create-full-backup-button').css("display", "unset")
+				$('#create-incremental-backup-button').css("display", "unset")
+				for (var i = 0; i < r.backups.length; i++) {
+					var b = r.backups[i];
+					var tr = $('<tr/>');
+					if (b.full) tr.addClass("full-backup");
+					tr.append($('<td/>').text(b.date_str));
+					tr.append($('<td/>').text(b.date_delta + " ago"));
+					tr.append($('<td/>').text(b.full ? "full" : "increment"));
+					tr.append($('<td/>').text(nice_size(b.size)));
+					if (b.deleted_in)
+						tr.append($('<td/>').text(b.deleted_in));
+					else
+						tr.append($('<td class="text-muted">unknown</td>'));
+					$('#backup-status tbody').append(tr);
 
-      $('#backup-total-size').text(nice_size(total_disk_size));
-    })
-}
+					total_disk_size += b.size;
+				}
 
-function show_custom_backup() {
-    $(".backup-target-local, .backup-target-rsync, .backup-target-s3").hide();
-    api(
-      "/system/backup/config",
-      "GET",
-      { },
-      function(r) {
-        $("#backup-target-user").val(r.target_user);
-        $("#backup-target-pass").val(r.target_pass);
-        $("#min-age").val(r.min_age_in_days);
-        $(".backup-location").text(r.file_target_directory);
-        $(".backup-encpassword-file").text(r.enc_pw_file);
-        $("#ssh-pub-key").val(r.ssh_pub_key);
+				total_disk_size += r.unmatched_file_size;
+				$('#backup-total-size').text(nice_size(total_disk_size));
+			})
+	}
 
-        if (r.target == "file://" + r.file_target_directory) {
-          $("#backup-target-type").val("local");
-        } else if (r.target == "off") {
-          $("#backup-target-type").val("off");
-        } else if (r.target.substring(0, 8) == "rsync://") {
-          $("#backup-target-type").val("rsync");
-          var path = r.target.substring(8).split('//');
-          var host_parts = path.shift().split('@');
-          $("#backup-target-rsync-user").val(host_parts[0]);
-          $("#backup-target-rsync-host").val(host_parts[1]);
-          $("#backup-target-rsync-path").val('/'+path[0]);
-        } else if (r.target.substring(0, 5) == "s3://") {
-          $("#backup-target-type").val("s3");
-          var hostpath = r.target.substring(5).split('/');
-          var host = hostpath.shift();
-          $("#backup-target-s3-host").val(host);
-          $("#backup-target-s3-path").val(hostpath.join('/'));
-        }
-        toggle_form()
-      })
-}
+	function show_custom_backup() {
+		$(".backup-target-local, .backup-target-rsync, .backup-target-s3, .backup-target-b2").hide();
+		api(
+			"/system/backup/config",
+			"GET",
+			{},
+			function (r) {
+				$("#backup-target-user").val(r.target_user);
+				$("#backup-target-pass").val(r.target_pass);
+				$("#backup-min-age").val(r.min_age_in_days);
+				$(".backup-location").text(r.file_target_directory);
+				$(".backup-encpassword-file").text(r.enc_pw_file);
+				$("#ssh-pub-key").val(r.ssh_pub_key);
 
-function set_custom_backup() {
-  var target_type = $("#backup-target-type").val();
-  var target_user = $("#backup-target-user").val();
-  var target_pass = $("#backup-target-pass").val();
+				if (r.target == "file://" + r.file_target_directory) {
+					$("#backup-target-type").val("local");
+				} else if (r.target == "off") {
+					$("#backup-target-type").val("off");
+				} else if (r.target.substring(0, 8) == "rsync://") {
+					$("#backup-target-type").val("rsync");
+					let uri = r.target.substring(8)
+					let i = uri.indexOf("/")
+					let path = [uri.slice(0, i), uri.slice(i + 1)];
+					let host_parts = path.shift().split('@');
+					$("#backup-target-rsync-user").val(host_parts[0]);
+					$("#backup-target-rsync-host").val(host_parts[1]);
+					$("#backup-target-rsync-path").val(path[0]);
+					$("#backup-target-rsync-port").val(r.target_rsync_port)
+				} else if (r.target.substring(0, 5) == "s3://") {
+					$("#backup-target-type").val("s3");
+					var hostpath = r.target.substring(5).split('/');
+					var host = hostpath.shift();
+					let s3_options = $("#backup-target-s3-host-select option").map(function() {return this.value}).get()
+					$("#backup-target-s3-host-select").val("other")
+					for (let h of s3_options) {
+						console.log(h)
+						if (h == host) {
+							$("#backup-target-s3-host-select").val(host)
+							break
+						}
+					}
+					$("#backup-target-s3-host").val(host);
+					$("#backup-target-s3-path").val(hostpath.join('/'));
+				} else if (r.target.substring(0, 5) == "b2://") {
+					$("#backup-target-type").val("b2");
+					var targetPath = r.target.substring(5);
+					var b2_application_keyid = targetPath.split(':')[0];
+					var b2_applicationkey = targetPath.split(':')[1].split('@')[0];
+					var b2_bucket = targetPath.split('@')[1];
+					$("#backup-target-b2-user").val(b2_application_keyid);
+					$("#backup-target-b2-pass").val(b2_applicationkey);
+					$("#backup-target-b2-bucket").val(b2_bucket);
+				}
+				toggle_form()
+			})
+	}
 
-  var target;
-  if (target_type == "local" || target_type == "off")
-    target = target_type;
-  else if (target_type == "s3")
-    target = "s3://" + $("#backup-target-s3-host").val() + "/" + $("#backup-target-s3-path").val();
-  else if (target_type == "rsync") {
-    target = "rsync://" + $("#backup-target-rsync-user").val() + "@" + $("#backup-target-rsync-host").val()
-                                                                + "/" + $("#backup-target-rsync-path").val();
-    target_user = '';
-  }
+	function set_custom_backup() {
+		var target_type = $("#backup-target-type").val();
+		var target_user = $("#backup-target-user").val();
+		var target_pass = $("#backup-target-pass").val();
+		let target_port = $("#backup-target-rsync-port").val();
 
+		var target;
+		if (target_type == "local" || target_type == "off")
+			target = target_type;
+		else if (target_type == "s3")
+			target = "s3://" + $("#backup-target-s3-host").val() + "/" + $("#backup-target-s3-path").val();
+		else if (target_type == "rsync") {
+			target = "rsync://" + $("#backup-target-rsync-user").val() + "@" + $("#backup-target-rsync-host").val()
+				+ "/" + $("#backup-target-rsync-path").val();
+			target_user = '';
+		} else if (target_type == "b2") {
+			target = 'b2://' + $('#backup-target-b2-user').val() + ':' + $('#backup-target-b2-pass').val()
+				+ '@' + $('#backup-target-b2-bucket').val()
+			target_user = '';
+			target_pass = '';
+		}
+
+		var min_age = $("#backup-min-age").val();
+		api(
+			"/system/backup/config",
+			"POST",
+			{
+				target: target,
+				target_user: target_user,
+				target_pass: target_pass,
+				target_rsync_port: target_port,
+				min_age: min_age
+			},
+			function (r) {
+				// use .text() --- it's a text response, not html
+				show_modal_error("Backup configuration", $("<p/>").text(r), function () { if (r == "OK") show_system_backup(); }); // refresh after modal on success
+			},
+			function (r) {
+				// use .text() --- it's a text response, not html
+				show_modal_error("Backup configuration", $("<p/>").text(r));
+			});
+		return false;
+	}
+
+	function init_inputs(target_type) {
+		function set_host(host, overwrite_other) {
+			if (host !== 'other') {
+				$("#backup-target-s3-host").val(host);
+			} else if (overwrite_other) {
+				$("#backup-target-s3-host").val('');
+			}
+		}
+		if (target_type == "s3") {
+			$('#backup-target-s3-host-select').off('change').on('change', function () {
+				set_host($('#backup-target-s3-host-select').val(), true);
+			});
+			set_host($('#backup-target-s3-host-select').val(), false);
+		}
+	}
+
+	function do_backup(is_full) {
+		let disclaimer = "The backup process will pause some services (such as PHP, Postfix and Dovecot). Depending on the size of the data this can take a while."
+		if (!is_full) {
+			disclaimer += "\nDepending on the amount of incremental backups done after the last full backup, the box may decide to do a full backup instead."
+		}
+		show_modal_confirm("Warning!", disclaimer, "Start Backup", () => {
+			api(
+				"/system/backup/new",
+				"POST",
+				{
+					full: is_full
+				},
+				function (r) {
+					// use .text() --- it's a text response, not html
+					show_modal_error("Backup configuration", $("<p/>").text(r), function () { if (r == "OK") show_system_backup(); }); // refresh after modal on success
+				},
+				function (r) {
+					// use .text() --- it's a text response, not html
+					show_modal_error("Backup configuration", $("<p/>").text(r));
+				});
+			return false;
+		})
+	}
 
-  var min_age = $("#min-age").val();
-  api(
-    "/system/backup/config",
-    "POST",
-    {
-      target: target,
-      target_user: target_user,
-      target_pass: target_pass,
-      min_age: min_age
-    },
-    function(r) {
-      // use .text() --- it's a text response, not html
-      show_modal_error("Backup configuration", $("<p/>").text(r), function() { if (r == "OK") show_system_backup(); }); // refresh after modal on success
-    },
-    function(r) {
-      // use .text() --- it's a text response, not html
-      show_modal_error("Backup configuration", $("<p/>").text(r));
-    });
-  return false;
-}
 </script>

management/templates/system-status.html

@@ -1,43 +1,90 @@
 <h2>System Status Checks</h2>
 
 <style>
-#system-checks .heading td {
-  font-weight: bold;
-  font-size: 120%;
-  padding-top: 1.5em;
-}
-#system-checks .heading.first td {
-  border-top: none;
-  padding-top: 0;
-}
-#system-checks .status-error td {
-  color: #733;
-}
-#system-checks .status-warning td {
-  color: #770;
-}
-#system-checks .status-ok td {
-  color: #040;
-}
-#system-checks div.extra {
-  display: none;
-  margin-top: 1em;
-  max-width: 50em;
-  word-wrap: break-word;
-}
-#system-checks a.showhide {
-  display: none;
-  font-size: 85%;
-}
-#system-checks .pre {
-  margin: 1em;
-  font-family: monospace;
-  white-space: pre-wrap;
-}
-</style>
+	#system-checks .message {
+		display: inline;
+	}
 
-<div class="row">
-	<div class="col-md-push-9 col-md-3">
+	#system-checks .icon {
+		min-width: 2em;
+	}
+
+	#system-checks .heading {
+		font-weight: bold;
+		font-size: 180%;
+		padding-top: 1.75em;
+	}
+
+	#system-checks .heading.first {
+		border-top: none;
+		padding-top: 0;
+	}
+
+	.status-error .fas {
+		color: rgb(190, 0, 0);
+	}
+
+	.status-error.sym {
+		color: rgb(190, 0, 0);
+	}
+
+	.status-error .status-text {
+		color: rgb(70, 0, 0);
+	}
+
+	.status-warning .fas {
+		color: rgb(191, 150, 0);
+	}
+
+	.status-warning.sym {
+		color: rgb(191, 150, 0);
+	}
+
+	.status-warning .status-text {
+		color: rgb(69, 54, 0);
+	}
+
+	.status-ok .fas {
+		color: rgb(0, 190, 0);
+	}
+
+	.status-ok.sym {
+		color: rgb(0, 190, 0);
+	}
+
+	.status-ok .status-text {
+		color: rgb(0, 70, 0);
+	}
+
+	.status-na .fas {
+		color: rgb(100, 100, 100);
+	}
+
+	.status-na.sym {
+		color: rgb(100, 100, 100);
+	}
+
+	.status-na .status-text {
+		color: rgb(100, 100, 100);
+	}
+
+	div.extra {
+		display: none;
+		margin-top: 1em;
+		word-wrap: break-word;
+	}
+
+	#system-checks .showhide {
+		display: block;
+		font-size: 85%;
+	}
+
+	#system-checks .pre {
+		margin: 1em;
+		font-family: monospace;
+		white-space: pre-wrap;
+	}
+</style>
 
 <div id="system-reboot-required" style="display: none; margin-bottom: 1em;">
 	<button type="button" class="btn btn-danger" onclick="confirm_reboot(); return false;">Reboot Box</button>
@@ -45,116 +92,127 @@
 </div>
 
 <div id="system-privacy-setting" style="display: none">
-	<div><a onclick="return enable_privacy(!current_privacy_setting)" href="#"><span>Enable/Disable</span> New-Version Check</a></div>
-	<p style="line-height: 125%"><small>(When enabled, status checks phone-home to check for a new release of Mail-in-a-Box.)</small></p>
+	<div><a onclick="return enable_privacy(!current_privacy_setting)" href="#"><span>Enable/Disable</span>
+			New-Version Check</a></div>
+	<p style="line-height: 125%"><small>(When enabled, status checks phone-home to check for a new release of
+			Mail-in-a-Box.)</small></p>
 </div>
 
-	</div> <!-- /col -->
-	<div class="col-md-pull-3 col-md-8">
-
-<table id="system-checks" class="table" style="max-width: 60em">
-  <thead>
-  </thead>
-  <tbody>
-  </tbody>
-</table>
-
-	</div> <!-- /col -->
-</div> <!-- /row -->
+<div id="system-checks">
+</div>
 
 <script>
-function show_system_status() {
-  $('#system-checks tbody').html("<tr><td colspan='2' class='text-muted'>Loading...</td></tr>")
+	function show_system_status() {
+		$('#system-checks').html("")
 
-  api(
-    "/system/privacy",
-    "GET",
-    { },
-    function(r) {
-      current_privacy_setting = r;
-      $('#system-privacy-setting').show();
-      $('#system-privacy-setting a span').text(r ? "Enable" : "Disable");
-      $('#system-privacy-setting p').toggle(r);
-    });
+		api(
+			"/system/privacy",
+			"GET",
+			{},
+			function (r) {
+				current_privacy_setting = r;
+				$('#system-privacy-setting').show();
+				$('#system-privacy-setting a span').text(r ? "Enable" : "Disable");
+				$('#system-privacy-setting p').toggle(r);
+			});
 
-  api(
-    "/system/reboot",
-    "GET",
-    { },
-    function(r) {
-      $('#system-reboot-required').show(); // show when r becomes available
-      $('#system-reboot-required').find('button').toggle(r);
-      $('#system-reboot-required').find('div').toggle(!r);
-    });
+		api(
+			"/system/reboot",
+			"GET",
+			{},
+			function (r) {
+				$('#system-reboot-required').show(); // show when r becomes available
+				$('#system-reboot-required').find('button').toggle(r);
+				$('#system-reboot-required').find('div').toggle(!r);
+			});
 
-  api(
-    "/system/status",
-    "POST",
-    { },
-    function(r) {
-      $('#system-checks tbody').html("");
-      for (var i = 0; i < r.length; i++) {
-        var n = $("<tr><td class='status'/><td class='message'><p style='margin: 0'/><div class='extra'/><a class='showhide' href='#'/></tr>");
-        if (i == 0) n.addClass('first')
-        if (r[i].type == "heading")
-                n.addClass(r[i].type)
-        else
-                n.addClass("status-" + r[i].type)
-        if (r[i].type == "ok") n.find('td.status').text("✓")
-        if (r[i].type == "error") n.find('td.status').text("✖")
-        if (r[i].type == "warning") n.find('td.status').text("?")
-        n.find('td.message p').text(r[i].text)
-        $('#system-checks tbody').append(n);
+		api(
+			"/system/status",
+			"POST",
+			{},
+			function (r) {
+				for (let i = 0; i < r.length; i++) {
+					let n = $("<div class='col-12'><div class='icon'></div><p class='message status-text' style='margin: 0'/>");
+					if (i == 0) n.addClass('first')
 
-        if (r[i].extra.length > 0) {
-          n.find('a.showhide').show().text("show more").click(function() {
-            $(this).hide();
-            $(this).parent().find('.extra').fadeIn();
-            return false;
-          });
-        }
+					if (r[i].type == "heading") {
+						n.addClass(r[i].type)
+					} else {
+						n.addClass("status-" + r[i].type)
+						n.find(".icon").addClass("fas")
+					}
 
-        for (var j = 0; j < r[i].extra.length; j++) {
+					if (r[i].type == "ok") n.find(".icon").addClass("fa-check")
+					if (r[i].type == "error") n.find(".icon").addClass("fa-times")
+					if (r[i].type == "warning") n.find(".icon").addClass("fa-exclamation-triangle")
 
-          var m = $("<div/>").text(r[i].extra[j].text)
-          if (r[i].extra[j].monospace)
-            m.addClass("pre");
-          n.find('> td.message > div').append(m);
-        }
-      }
-    })
+					n.find('p.status-text').text(r[i].text)
 
-}
+					if (r[i].extra.length > 0) {
+						let open = false
+						n.append("<p class='showhide btn btn-light mt-3' href='#'>Show More</p><div class='extra ps-4 col-12'></div>")
+						n.find('.showhide').click(function () {
+							let extra = $(this).parent().find('.extra')
 
-var current_privacy_setting = null;
-function enable_privacy(status) {
-  api(
-    "/system/privacy",
-    "POST",
-    {
-      value: (status ? "private" : "off")
-    },
-    function(res) {
-      show_system_status();
-    });
-  return false; // disable link
-}
+							if (open) {
+								$(this).html("Show More");
+								extra.fadeOut();
+							} else {
+								$(this).html("Show Less");
+								extra.fadeIn();
+							}
 
-function confirm_reboot() {
-  show_modal_confirm(
-    "Reboot",
-    $("<p>This will reboot your Mail-in-a-Box <code>{{hostname}}</code>.</p> <p>Until the machine is fully restarted, your users will not be able to send and receive email, and you will not be able to connect to this control panel or with SSH. The reboot cannot be cancelled.</p>"),
-    "Reboot Now",
-    function() {
-      api(
-        "/system/reboot",
-        "POST",
-        { },
-        function(r) {
-          var msg = "<p>Please reload this page after a minute or so.</p>";
-          if (r) msg = "<p>The reboot command said:</p> <pre>" + $("<pre/>").text(r).html() + "</pre>"; // successful reboots don't produce any output; the output must be HTML-escaped
-          show_modal_error("Reboot", msg);
-        });
-    });
-}
+							open = !open
+							return false;
+						});
+					}
+
+					for (var j = 0; j < r[i].extra.length; j++) {
+
+						var m = $("<div/>").text(r[i].extra[j].text)
+						if (r[i].extra[j].monospace)
+							m.addClass("pre");
+						n.find('.extra').append(m);
+					}
+
+					$('#system-checks').append(n);
+					if (i < r.length - 1) {
+						$('#system-checks').append($("<hr>"));
+					}
+				}
+			})
+
+	}
+
+	var current_privacy_setting = null;
+	function enable_privacy(status) {
+		api(
+			"/system/privacy",
+			"POST",
+			{
+				value: (status ? "private" : "off")
+			},
+			function (res) {
+				show_system_status();
+			});
+		return false; // disable link
+	}
+
+	function confirm_reboot() {
+		show_modal_confirm(
+			"Reboot",
+			$("<p>This will reboot your Mail-in-a-Box <code>{{hostname}}</code>.</p> <p>Until the machine is fully restarted, your users will not be able to send and receive email, and you will not be able to connect to this control panel or with SSH. The reboot cannot be cancelled.</p>"),
+			"Reboot Now",
+			function () {
+				api(
+					"/system/reboot",
+					"POST",
+					{},
+					function (r) {
+						var msg = "<p>Please reload this page after a minute or so.</p>";
+						if (r) msg = "<p>The reboot command said:</p> <pre>" + $("<pre/>").text(r).html() + "</pre>"; // successful reboots don't produce any output; the output must be HTML-escaped
+						show_modal_error("Reboot", msg);
+					});
+			});
+	}
 </script>

management/templates/users.html

@@ -1,87 +1,145 @@
 <h2>Users</h2>
 
 <style>
-#user_table h4 { margin: 1em 0 0 0; }
-#user_table tr.account_inactive td.address { color: #888; text-decoration: line-through; }
-#user_table .actions { margin-top: .33em; font-size: 95%; }
-#user_table .account_inactive .if_active { display: none; }
-#user_table .account_active .if_inactive { display: none; }
-#user_table .account_active.if_inactive { display: none; }
+	#user_table tr.account_inactive td.address {
+		color: #888;
+		text-decoration: line-through;
+	}
+
+	#user_table .actions {
+		margin-top: .33em;
+		font-size: 95%;
+	}
+
+	#user_table .account_inactive .if_active {
+		display: none;
+	}
+
+	#user_table .account_active .if_inactive {
+		display: none;
+	}
+
+	#user_table .account_active.if_inactive {
+		display: none;
+	}
 </style>
 
 <h3>Add a mail user</h3>
 
 <p>Add an email address to this system. This will create a new login username/password.</p>
 
-<form class="form-inline" role="form" onsubmit="return do_add_user(); return false;">
-  <div class="form-group">
-    <label class="sr-only" for="adduserEmail">Email address</label>
-    <input type="email" class="form-control" id="adduserEmail" placeholder="Email Address">
-  </div>
-  <div class="form-group">
-    <label class="sr-only" for="adduserPassword">Password</label>
-    <input type="password" class="form-control" id="adduserPassword" placeholder="Password">
-  </div>
-  <div class="form-group">
-    <select class="form-control" id="adduserPrivs">
-      <option value="">Normal User</option>
-      <option value="admin">Administrator</option>
-    </select>
-  </div>
-  <button type="submit" class="btn btn-primary">Add User</button>
+<form role="form" onsubmit="return do_add_user(); return false;">
+	<div class="mb-3">
+		<div class="row g-3">
+			<div class="col-12 col-lg-6">
+				<div class="input-group">
+					<label class="input-group-text" for="adduserEmail">Email address</label>
+					<input type="email" class="form-control" style="min-width: 15em;" id="adduserEmail"
+						placeholder="me@example.com">
+				</div>
+			</div>
+			<div class="col-12 col-lg-6">
+				<div class="input-group">
+					<label class="input-group-text" for="adduserPassword">Password</label>
+					<input type="password" class="form-control" style="min-width: 10em;" id="adduserPassword"
+						placeholder="Password">
+				</div>
+			</div>
+		</div>
+	</div>
+
+	<div class="col-md-8 col-lg-6 mb-3">
+		<div class="input-group">
+			<label class="input-group-text" for="adduserPrivs">User Type</label>
+			<select class="form-select" id="adduserPrivs">
+				<option value="">Normal User</option>
+				<option value="admin">Administrator</option>
+			</select>
+		</div>
+	</div>
+
+	<div class="col-md-8 col-lg-6 mb-3">
+		<div class="input-group">
+			<label class="input-group-text" for="adduserQuota">Storage Quota</label>
+			<input type="text" class="form-control" id="adduserQuota" placeholder="0">
+		</div>
+	</div>
+
+	<ul style="margin-top: 1em; padding-left: 1.5em; font-size: 90%;">
+		<li>Passwords must be at least eight characters. If you're out of ideas, you can <a href="#"
+				onclick="return generate_random_password()">generate a random password</a>.</li>
+		<li>Use <a href="#" onclick="return show_panel('aliases')">aliases</a> to create email addresses that forward to
+			existing accounts.</li>
+		<li>Administrators get access to this control panel.</li>
+		<li>User accounts cannot contain any international (non-ASCII) characters, but <a href="#"
+				onclick="return show_panel('aliases');">aliases</a> can.</li>
+		<li>Quotas may not contain any spaces, commas or decimal points. Suffixes of G (gigabytes) and M (megabytes) are
+			allowed. For unlimited storage enter 0 (zero)</li>
+	</ul>
+
+	<button type="submit" class="btn btn-primary">Add User</button>
 </form>
-<ul style="margin-top: 1em; padding-left: 1.5em; font-size: 90%;">
-  <li>Passwords must be at least eight characters and may not contain spaces. For best results, <a href="#" onclick="return generate_random_password()">generate a random password</a>.</li>
-  <li>Use <a href="#" onclick="return show_panel('aliases')">aliases</a> to create email addresses that forward to existing accounts.</li>
-  <li>Administrators get access to this control panel.</li>
-  <li>User accounts cannot contain any international (non-ASCII) characters, but <a href="#" onclick="return show_panel('aliases');">aliases</a> can.</li>
-</ul>
 
 <h3>Existing mail users</h3>
-<table id="user_table" class="table" style="width: auto">
-  <thead>
-    <tr>
-      <th width="50%">Email Address</th>
-      <th>Actions</th>
-      <th>Mailbox Size</th>
-    </tr>
-  </thead>
-  <tbody>
-  </tbody>
+<table id="user_table" class="table col-12">
+	<caption></caption>
+	<thead>
+		<tr>
+			<th width="35%">Email Address</th>
+			<th class="">Messages</th>
+			<th class="">Size</th>
+			<th class="">Used</th>
+			<th class="">Quota</th>
+			<th>Actions</th>
+		</tr>
+	</thead>
+	<tbody>
+	</tbody>
 </table>
 
 <div style="display: none">
-  <table>
-  <tr id="user-template">
-    <td class='address'>
-    </td>
-    <td class='actions'>
-        <span class='privs'>
-        </span>
+	<table>
+		<tr id="user-template">
+			<td class='address'>
+			</td>
+			<td class="box-count"></td>
+			<td class="box-size"></td>
+			<td class="percent"></td>
+			<td class="quota">
+			</td>
+			<td class='actions'>
+				<span class='privs'>
+				</span>
 
-        <span class="if_active">
-          <a href="#" onclick="users_set_password(this); return false;" class='setpw' title="Set Password">
-            set password
-          </a>
-          |
-        </span>
+				<span class="if_active">
+					<a href="#" onclick="users_set_quota(this); return false;" class='setquota' title="Set Quota">
+						set quota
+					</a>
+					|
+				</span>
 
-        <span class='add-privs'>
-        </span>
+				<span class="if_active">
+					<a href="#" onclick="users_set_password(this); return false;" class='setpw' title="Set Password">
+						set password
+					</a>
+					|
+				</span>
 
-        <a href="#" onclick="users_remove(this); return false;" class='if_active' title="Archive Account">
-          archive account
-        </a>
-    </td>
-    <td class='mailboxsize'>
-    </td>
-  </tr>
-  <tr id="user-extra-template" class="if_inactive">
-    <td colspan="3" style="border: 0; padding-top: 0">
-      <div class='restore_info' style='color: #888; font-size: 90%'>To restore account, create a new account with this email address. Or to permanently delete the mailbox, delete the directory <tt></tt> on the machine.</div>
-    </td>
-  </tr>
-  </table>
+				<span class='add-privs'>
+				</span>
+
+				<a href="#" onclick="users_remove(this); return false;" class='if_active' title="Archive Account">
+					archive account
+				</a>
+			</td>
+		</tr>
+		<tr id="user-extra-template" class="if_inactive">
+			<td colspan="3" style="border: 0; padding-top: 0">
+				<div class='restore_info' style='color: #888; font-size: 90%'>To restore account, create a new account with this
+					email address. Or to permanently delete the mailbox, delete the directory <tt></tt> on the machine.</div>
+			</td>
+		</tr>
+	</table>
 </div>
 
 <h3>Mail user API (advanced)</h3>
@@ -99,17 +157,57 @@
 <h4 style="margin-bottom: 0">Verbs</h4>
 
 <table class="table" style="margin-top: .5em">
-<thead><th>Verb</th> <th>Action</th><th></th></thead>
-<tr><td>GET</td><td><i>(none)</i></td> <td>Returns a list of existing mail users. Adding <code>?format=json</code> to the URL will give JSON-encoded results.</td></tr>
-<tr><td>POST</td><td>/add</td> <td>Adds a new mail user. Required POST-body parameters are <code>email</code> and <code>password</code>.</td></tr>
-<tr><td>POST</td><td>/remove</td> <td>Removes a mail user. Required POST-by parameter is <code>email</code>.</td></tr>
-<tr><td>POST</td><td>/privileges/add</td> <td>Used to make a mail user an admin. Required POST-body parameters are <code>email</code> and <code>privilege=admin</code>.</td></tr>
-<tr><td>POST</td><td>/privileges/remove</td> <td>Used to remove the admin privilege from a mail user. Required POST-body parameter is <code>email</code>.</td></tr>
+	<caption></caption>
+	<thead>
+		<th>Verb</th>
+		<th>Action</th>
+		<th></th>
+	</thead>
+	<tr>
+		<td><b>GET</b< /td>
+		<td><i>(none)</i></td>
+		<td>Returns a list of existing mail users. Adding <code>?format=json</code> to the URL will give JSON-encoded
+			results.</td>
+	</tr>
+	<tr>
+		<td><b>POST</b< /td>
+		<td class="font-monospace">/add</td>
+		<td>Adds a new mail user. Required POST-body parameters are <code>email</code> and <code>password</code>. Optional
+			parameters: <code>privilege=admin</code> and <code>quota</code></td>
+	</tr>
+	<tr>
+		<td><b>POST</b></td>
+		<td class="font-monospace">/remove</td>
+		<td>Removes a mail user. Required POST-by parameter is <code>email</code>.</td>
+	</tr>
+	<tr>
+		<td><b>POST</b></td>
+		<td class="font-monospace">/privileges/add</td>
+		<td>Used to make a mail user an admin. Required POST-body parameters are <code>email</code> and
+			<code>privilege=admin</code>.</td>
+	</tr>
+	<tr>
+		<td><b>POST</b></td>
+		<td class="font-monospace">/privileges/remove</td>
+		<td>Used to remove the admin privilege from a mail user. Required POST-body parameter is <code>email</code>.</td>
+	</tr>
+	<tr>
+		<td><b>GET</b></td>
+		<td class="font-monospace">/quota</td>
+		<td>Get the quota for a mail user. Required POST-body parameters are <code>email</code> and will return JSON result
+		</td>
+	</tr>
+	<tr>
+		<td><b>POST</b></td>
+		<td class="font-monospace">/quota</td>
+		<td>Set the quota for a mail user. Required POST-body parameters are <code>email</code> and <code>quota</code>.</td>
+	</tr>
 </table>
 
 <h4>Examples:</h4>
 
-<p>Try these examples. For simplicity the examples omit the <code>--user me@mydomain.com:yourpassword</code> command line argument which you must fill in with your administrative email address and password.</p>
+<p>Try these examples. For simplicity the examples omit the <code>--user me@mydomain.com:yourpassword</code> command
+	line argument which you must fill in with your administrative email address and password.</p>
 
 <pre># Gives a JSON-encoded list of all mail users
 curl -X GET https://{{hostname}}/admin/mail/users?format=json
@@ -128,177 +226,228 @@ curl -X POST -d "email=new_user@mydomail.com" https://{{hostname}}/admin/mail/us
 </pre>
 
 <script>
-function show_users() {
-  $('#user_table tbody').html("<tr><td colspan='2' class='text-muted'>Loading...</td></tr>")
-  api(
-    "/mail/users",
-    "GET",
-    { format: 'json' },
-    function(r) {
-      $('#user_table tbody').html("");
-      for (var i = 0; i < r.length; i++) {
-        var hdr = $("<tr><td colspan='3'><h4/></td></tr>");
-        hdr.find('h4').text(r[i].domain);
-        $('#user_table tbody').append(hdr);
+	function show_users() {
+		api(
+			"/system/default-quota",
+			"GET",
+			{},
+			function (r) {
+				$('#adduserQuota').val(r['default-quota']);
+			}
+		);
 
-        for (var k = 0; k < r[i].users.length; k++) {
-          var user = r[i].users[k];
+		$('#user_table tbody').html("<tr><td colspan='6' class='text-muted'>Loading...</td></tr>")
+		api(
+			"/mail/users",
+			"GET",
+			{ format: 'json' },
+			function (r) {
+				$('#user_table tbody').html("");
+				for (var i = 0; i < r.length; i++) {
+					var hdr = $("<tr><th colspan='6' class='bg-light'></th></tr>");
+					hdr.find('th').text(r[i].domain);
+					$('#user_table tbody').append(hdr);
 
-          var n = $("#user-template").clone();
-          var n2 = $("#user-extra-template").clone();
-          n.attr('id', '');
-          n2.attr('id', '');
-          $('#user_table tbody').append(n);
-          $('#user_table tbody').append(n2);
+					for (var k = 0; k < r[i].users.length; k++) {
+						var user = r[i].users[k];
 
-          n.addClass("account_" + user.status);
-          n2.addClass("account_" + user.status);
+						var n = $("#user-template").clone();
+						var n2 = $("#user-extra-template").clone();
+						n.attr('id', '');
+						n2.attr('id', '');
+						$('#user_table tbody').append(n);
+						$('#user_table tbody').append(n2);
 
-          n.attr('data-email', user.email);
-          n.find('.address').text(user.email)
-          n.find('.mailboxsize').text(nice_size(user.mailbox_size))
-          n2.find('.restore_info tt').text(user.mailbox);
+						n.addClass("account_" + user.status);
+						n2.addClass("account_" + user.status);
 
-          if (user.status == 'inactive') continue;
+						n.attr('data-email', user.email);
+						n.attr('data-quota', user.quota);
+						n.find('.address').text(user.email);
+						n.find('.box-count').text((user.box_count).toLocaleString('en'));
+						if (user.box_count == '?') {
+							n.find('.box-count').attr('title', 'Message count is unkown')
+						}
+						n.find('.box-size').text(user.box_size);
+						if (user.box_size == '?') {
+							n.find('.box-size').attr('title', 'Mailbox size is unkown')
+						}
+						n.find('.percent').text(user.percent);
+						n.find('.quota').text((user.quota == '0') ? 'unlimited' : user.quota);
+						n2.find('.restore_info tt').text(user.mailbox);
 
-          var add_privs = ["admin"];
+						if (user.status == 'inactive') continue;
 
-          for (var j = 0; j < user.privileges.length; j++) {
-            var p = $("<span><b><span class='name'></span></b> (<a href='#' onclick='mod_priv(this, \"remove\"); return false;' title='Remove Privilege'>remove privilege</a>) |</span>");
-            p.find('span.name').text(user.privileges[j]);
-            n.find('.privs').append(p);
-            if (add_privs.indexOf(user.privileges[j]) >= 0)
-              add_privs.splice(add_privs.indexOf(user.privileges[j]), 1);
-          }
+						var add_privs = ["admin"];
 
-          for (var j = 0; j < add_privs.length; j++) {
-            var p = $("<span><a href='#' onclick='mod_priv(this, \"add\"); return false;' title='Add Privilege'>make <span class='name'></span></a> | </span>");
-            p.find('span.name').text(add_privs[j]);
-            n.find('.add-privs').append(p);
-          }
-        }
-      }
-    })
-}
+						for (var j = 0; j < user.privileges.length; j++) {
+							var p = $("<span><b><span class='name'></span></b> (<a href='#' onclick='mod_priv(this, \"remove\"); return false;' title='Remove Privilege'>remove privilege</a>) |</span>");
+							p.find('span.name').text(user.privileges[j]);
+							n.find('.privs').append(p);
+							if (add_privs.indexOf(user.privileges[j]) >= 0)
+								add_privs.splice(add_privs.indexOf(user.privileges[j]), 1);
+						}
 
-function do_add_user() {
-  var email = $("#adduserEmail").val();
-  var pw = $("#adduserPassword").val();
-  var privs = $("#adduserPrivs").val();
-  api(
-    "/mail/users/add",
-    "POST",
-    {
-      email: email,
-      password: pw,
-      privileges: privs
-    },
-    function(r) {
-      // Responses are multiple lines of pre-formatted text.
-      show_modal_error("Add User", $("<pre/>").text(r));
-      show_users()
-    },
-    function(r) {
-      show_modal_error("Add User", r);
-    });
-  return false;
-}
+						for (var j = 0; j < add_privs.length; j++) {
+							var p = $("<span><a href='#' onclick='mod_priv(this, \"add\"); return false;' title='Add Privilege'>make <span class='name'></span></a> | </span>");
+							p.find('span.name').text(add_privs[j]);
+							n.find('.add-privs').append(p);
+						}
+					}
+				}
+			})
+	}
 
-function users_set_password(elem) {
-  var email = $(elem).parents('tr').attr('data-email');
+	function do_add_user() {
+		var email = $("#adduserEmail").val();
+		var pw = $("#adduserPassword").val();
+		var privs = $("#adduserPrivs").val();
+		var quota = $("#adduserQuota").val();
+		api(
+			"/mail/users/add",
+			"POST",
+			{
+				email: email,
+				password: pw,
+				privileges: privs,
+				quota: quota
+			},
+			function (r) {
+				// Responses are multiple lines of pre-formatted text.
+				show_modal_error("Add User", $("<pre/>").text(r));
+				show_users()
+			},
+			function (r) {
+				show_modal_error("Add User", r);
+			});
+		return false;
+	}
 
-  var yourpw = "";
-  if (api_credentials != null && email == api_credentials[0])
-    yourpw = "<p class='text-danger'>If you change your own password, you will be logged out of this control panel and will need to log in again.</p>";
+	function users_set_password(elem) {
+		var email = $(elem).parents('tr').attr('data-email');
 
-  show_modal_confirm(
-    "Set Password",
-    $("<p>Set a new password for <b>" + email + "</b>?</p> <p><label for='users_set_password_pw' style='display: block; font-weight: normal'>New Password:</label><input type='password' id='users_set_password_pw'></p><p><small>Passwords must be at least four characters and may not contain spaces.</small>" + yourpw + "</p>"),
-    "Set Password",
-    function() {
-      api(
-        "/mail/users/password",
-        "POST",
-        {
-          email: email,
-          password: $('#users_set_password_pw').val()
-        },
-        function(r) {
-          // Responses are multiple lines of pre-formatted text.
-          show_modal_error("Set Password", $("<pre/>").text(r));
-        },
-        function(r) {
-          show_modal_error("Set Password", r);
-        });
-    });
-}
+		var yourpw = "";
+		if (api_credentials != null && email == api_credentials.username)
+			yourpw = "<p class='text-danger'>If you change your own password, you will be logged out of this control panel and will need to log in again.</p>";
 
-function users_remove(elem) {
-  var email = $(elem).parents('tr').attr('data-email');
+		show_modal_confirm(
+			"Set Password",
+			$("<p>Set a new password for <b>" + email + "</b>?</p> <p><label for='users_set_password_pw' style='display: block; font-weight: normal'>New Password:</label><input type='password' id='users_set_password_pw'></p><p><small>Passwords must be at least eight characters.</small>" + yourpw + "</p>"),
+			"Set Password",
+			function () {
+				api(
+					"/mail/users/password",
+					"POST",
+					{
+						email: email,
+						password: $('#users_set_password_pw').val()
+					},
+					function (r) {
+						// Responses are multiple lines of pre-formatted text.
+						show_modal_error("Set Password", $("<pre/>").text(r));
+					},
+					function (r) {
+						show_modal_error("Set Password", r);
+					});
+			});
+	}
 
-  // can't remove yourself
-  if (api_credentials != null && email == api_credentials[0]) {
-    show_modal_error("Archive User", "You cannot archive your own account.");
-    return;
-  }
+	function users_set_quota(elem) {
+		var email = $(elem).parents('tr').attr('data-email');
+		var quota = $(elem).parents('tr').attr('data-quota');
 
-  show_modal_confirm(
-    "Archive User",
-    $("<p>Are you sure you want to archive <b>" + email + "</b>?</p> <p>The user's mailboxes will not be deleted (you can do that later), but the user will no longer be able to log into any services on this machine.</p>"),
-    "Archive",
-    function() {
-      api(
-        "/mail/users/remove",
-        "POST",
-        {
-          email: email
-        },
-        function(r) {
-          // Responses are multiple lines of pre-formatted text.
-          show_modal_error("Remove User", $("<pre/>").text(r));
-          show_users();
-        },
-        function(r) {
-          show_modal_error("Remove User", r);
-        });
-    });
-}
+		show_modal_confirm(
+			"Set Quota",
+			$("<p>Set quota for <b>" + email + "</b>?</p>" +
+				"<p>" +
+				"<label for='users_set_quota' style='display: block; font-weight: normal'>Quota:</label>" +
+				"<input type='text' id='users_set_quota' value='" + quota + "'></p>" +
+				"<p><small>Quotas may not contain any spaces or commas.  Suffixes of G (gigabytes) and M (megabytes) are allowed.</small></p>" +
+				"<p><small>For unlimited storage enter 0 (zero)</small></p>"),
+			"Set Quota",
+			function () {
+				api(
+					"/mail/users/quota",
+					"POST",
+					{
+						email: email,
+						quota: $('#users_set_quota').val()
+					},
+					function (r) {
+						show_users();
+					},
+					function (r) {
+						show_modal_error("Set Quota", r);
+					});
+			});
+	}
 
-function mod_priv(elem, add_remove) {
-  var email = $(elem).parents('tr').attr('data-email');
-  var priv = $(elem).parents('td').find('.name').text();
+	function users_remove(elem) {
+		var email = $(elem).parents('tr').attr('data-email');
 
-  // can't remove your own admin access
-  if (priv == "admin" && add_remove == "remove" && api_credentials != null && email == api_credentials[0]) {
-    show_modal_error("Modify Privileges", "You cannot remove the admin privilege from yourself.");
-    return;
-  }
+		// can't remove yourself
+		if (api_credentials != null && email == api_credentials.username) {
+			show_modal_error("Archive User", "You cannot archive your own account.");
+			return;
+		}
 
-  var add_remove1 = add_remove.charAt(0).toUpperCase() + add_remove.substring(1);
-  show_modal_confirm(
-    "Modify Privileges",
-    $("<p>Are you sure you want to " + add_remove + " the " + priv + " privilege for <b>" + email + "</b>?</p>"),
-    add_remove1,
-    function() {
-      api(
-        "/mail/users/privileges/" + add_remove,
-        "POST",
-        {
-          email: email,
-          privilege: priv
-        },
-        function(r) {
-          show_users();
-        });
-    });
-}
+		show_modal_confirm(
+			"Archive User",
+			$("<p>Are you sure you want to archive <b>" + email + "</b>?</p> <p>The user's mailboxes will not be deleted (you can do that later), but the user will no longer be able to log into any services on this machine.</p>"),
+			"Archive",
+			function () {
+				api(
+					"/mail/users/remove",
+					"POST",
+					{
+						email: email
+					},
+					function (r) {
+						// Responses are multiple lines of pre-formatted text.
+						show_modal_error("Remove User", $("<pre/>").text(r));
+						show_users();
+					},
+					function (r) {
+						show_modal_error("Remove User", r);
+					});
+			});
+	}
 
-function generate_random_password() {
-  var pw = "";
-  var charset = "ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz23456789"; // confusable characters skipped
-  for (var i = 0; i < 12; i++)
-    pw += charset.charAt(Math.floor(Math.random() * charset.length));
-  show_modal_error("Random Password", "<p>Here, try this:</p> <p><code style='font-size: 110%'>" + pw + "</code></pr");
-  return false; // cancel click
-}
+	function mod_priv(elem, add_remove) {
+		var email = $(elem).parents('tr').attr('data-email');
+		var priv = $(elem).parents('td').find('.name').text();
+
+		// can't remove your own admin access
+		if (priv == "admin" && add_remove == "remove" && api_credentials != null && email == api_credentials.username) {
+			show_modal_error("Modify Privileges", "You cannot remove the admin privilege from yourself.");
+			return;
+		}
+
+		var add_remove1 = add_remove.charAt(0).toUpperCase() + add_remove.substring(1);
+		show_modal_confirm(
+			"Modify Privileges",
+			$("<p>Are you sure you want to " + add_remove + " the " + priv + " privilege for <b>" + email + "</b>?</p>"),
+			add_remove1,
+			function () {
+				api(
+					"/mail/users/privileges/" + add_remove,
+					"POST",
+					{
+						email: email,
+						privilege: priv
+					},
+					function (r) {
+						show_users();
+					});
+			});
+	}
+
+	function generate_random_password() {
+		var pw = "";
+		var charset = "ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz23456789"; // confusable characters skipped
+		for (var i = 0; i < 12; i++)
+			pw += charset.charAt(Math.floor(Math.random() * charset.length));
+		show_modal_error("Random Password", "<p>Here, try this:</p> <p><code style='font-size: 110%'>" + pw + "</code></p>");
+		return false; // cancel click
+	}
 </script>

management/templates/web.html

@@ -3,87 +3,101 @@
 
 <h2>Static Web Hosting</h2>
 
-<p>This machine is serving a simple, static website at <a href="https://{{hostname}}">https://{{hostname}}</a> and at all domain names that you set up an email user or alias for.</p>
+<p>This machine is serving a simple, static website at <a href="https://{{hostname}}">https://{{hostname}}</a> and at
+	all domain names that you set up an email user or alias for.</p>
 
 <h3>Uploading web files</h3>
 
-<p>You can replace the default website with your own HTML pages and other static files. This control panel won&rsquo;t help you design a website, but once you have <tt>.html</tt> files you can upload them following these instructions:</p>
+<p>You can replace the default website with your own HTML pages and other static files. This control panel won&rsquo;t
+	help you design a website, but once you have <tt>.html</tt> files you can upload them following these instructions:
+</p>
 
 <ol>
-<li>Ensure that any domains you are publishing a website for have no problems on the <a href="#system_status" onclick="return show_panel(this);">Status Checks</a> page.</li>
+	<li>Ensure that any domains you are publishing a website for have no problems on the <a href="#system_status"
+			onclick="return show_panel(this);">Status Checks</a> page.</li>
 
-<li>On your personal computer, install an SSH file transfer program such as <a href="https://filezilla-project.org/">FileZilla</a> or <a href="http://linuxcommand.org/man_pages/scp1.html">scp</a>.</li>
+	<li>On your personal computer, install an SSH file transfer program such as <a
+			href="https://filezilla-project.org/">FileZilla</a> or <a
+			href="http://linuxcommand.org/man_pages/scp1.html">scp</a>.</li>
 
-<li>Log in to this machine with the file transfer program. The server is <strong>{{hostname}}</strong>, the protocol is SSH or SFTP, and use the <strong>SSH login credentials</strong> that you used when you originally created this machine at your cloud host provider. This is <strong>not</strong> what you use to log in either for email or this control panel. Your SSH credentials probably involves a private key file.</li>
+	<li>Log in to this machine with the file transfer program. The server is <strong>{{hostname}}</strong>, the protocol
+		is SSH or SFTP, and use the <strong>SSH login credentials</strong> that you used when you originally created this
+		machine at your cloud host provider. This is <strong>not</strong> what you use to log in either for email or this
+		control panel. Your SSH credentials probably involves a private key file.</li>
 
-<li>Upload your <tt>.html</tt> or other files to the directory <tt>{{storage_root}}/www/default</tt> on this machine. They will appear directly and immediately on the web.</li>
+	<li>Upload your <tt>.html</tt> or other files to the directory <tt>{{storage_root}}/www/default</tt> on this machine.
+		They will appear directly and immediately on the web.</li>
 
-<li>The websites set up on this machine are listed in the table below with where to put the files for each website.</li>
+	<li>The websites set up on this machine are listed in the table below with where to put the files for each website.
+	</li>
 
-<table id="web_domains_existing" class="table" style="margin-bottom: 1em; width: auto;">
-        <thead>
-                <tr>
-                        <th>Site</th>
-                        <th>Directory for Files</th>
-			<th/>
-                </tr>
-        </thead>
-        <tbody>
-        </tbody>
-</table>
+	<table id="web_domains_existing" class="table col-12" style="margin-bottom: 1em;">
+		<caption></caption>
+		<thead>
+			<tr>
+				<th>Site</th>
+				<th>Directory for Files</th>
+			</tr>
+		</thead>
+		<tbody>
+		</tbody>
+	</table>
 
-<p>To add a domain to this table, create a dummy <a href="#users" onclick="return show_panel(this);">mail user</a> or <a href="#aliases" onclick="return show_panel(this);">alias</a> on the domain first and see the <a href="https://mailinabox.email/guide.html#domain-name-configuration">setup guide</a> for adding nameserver records to the new domain at your registrar (but <i>not</i> glue records).</p>
+	<p>To add a domain to this table, create a dummy <a href="#users" onclick="return show_panel(this);">mail user</a> or
+		<a href="#aliases" onclick="return show_panel(this);">alias</a> on the domain first and see the <a
+			href="https://mailinabox.email/guide.html#domain-name-configuration">setup guide</a> for adding nameserver records
+		to the new domain at your registrar (but <i>not</i> glue records).</p>
 
 </ol>
 
 <script>
-function show_web() {
- api(
-    "/web/domains",
-    "GET",
-    {
-    },
-    function(domains) {
-	var tb = $('#web_domains_existing tbody');
-	tb.text('');
-	for (var i = 0; i < domains.length; i++) {
-		if (!domains[i].static_enabled) continue;
-		var row = $("<tr><th class='domain'><a href=''></a></th><td class='directory'><tt/></td> <td class='change-root hidden'><button class='btn btn-default btn-xs' onclick='show_change_web_root(this)'>Change</button></td></tr>");
-		tb.append(row);
-		row.attr('data-domain', domains[i].domain);
-		row.attr('data-custom-web-root', domains[i].custom_root);
-		row.find('.domain a').text('https://' + domains[i].domain);
-		row.find('.domain a').attr('href', 'https://' + domains[i].domain);
-		row.find('.directory tt').text(domains[i].root);
-		if (domains[i].root != domains[i].custom_root)
-			row.find('.change-root').removeClass('hidden');
+	function show_web() {
+		api(
+			"/web/domains",
+			"GET",
+			{
+			},
+			function (domains) {
+				var tb = $('#web_domains_existing tbody');
+				tb.text('');
+				for (var i = 0; i < domains.length; i++) {
+					if (!domains[i].static_enabled) continue;
+					var row = $("<tr><th class='domain'><a href=''></a></th><td class='directory'><tt/></td> <td class='change-root hidden'><button class='btn btn-default btn-xs' onclick='show_change_web_root(this)'>Change</button></td></tr>");
+					tb.append(row);
+					row.attr('data-domain', domains[i].domain);
+					row.attr('data-custom-web-root', domains[i].custom_root);
+					row.find('.domain a').text('https://' + domains[i].domain);
+					row.find('.domain a').attr('href', 'https://' + domains[i].domain);
+					row.find('.directory tt').text(domains[i].root);
+					if (domains[i].root != domains[i].custom_root)
+						row.find('.change-root').removeClass('hidden');
+				}
+
+			});
 	}
 
-    });
-}
+	function do_web_update() {
+		api(
+			"/web/update",
+			"POST",
+			{
+			},
+			function (data) {
+				if (data == "")
+					data = "Nothing changed.";
+				else
+					data = $("<pre/>").text(data);
+				show_modal_error("Web Update", data, function () { show_web() });
+			});
+	}
 
-function do_web_update() {
- api(
-    "/web/update",
-    "POST",
-    {
-    },
-    function(data) {
-      if (data == "")
-        data = "Nothing changed.";
-      else
-        data = $("<pre/>").text(data);
-      show_modal_error("Web Update", data, function() { show_web() });
-    });
-}
-
-function show_change_web_root(elem) {
-  var domain = $(elem).parents('tr').attr('data-domain');
-  var root = $(elem).parents('tr').attr('data-custom-web-root');
-  show_modal_confirm(
-    'Change Root Directory for ' + domain,
-    $('<p>You can change the static directory for <tt>' + domain + '</tt> to:</p> <p><tt>' + root + '</tt></p> <p>First create this directory on the server. Then click Update to scan for the directory and update web settings.</p>'),
-    'Update',
-    function() { do_web_update(); });
-}
+	function show_change_web_root(elem) {
+		var domain = $(elem).parents('tr').attr('data-domain');
+		var root = $(elem).parents('tr').attr('data-custom-web-root');
+		show_modal_confirm(
+			'Change Root Directory for ' + domain,
+			$('<p>You can change the static directory for <tt>' + domain + '</tt> to:</p> <p><tt>' + root + '</tt></p> <p>First create this directory on the server. Then click Update to scan for the directory and update web settings.</p>'),
+			'Update',
+			function () { do_web_update(); });
+	}
 </script>

management/templates/welcome.html

@@ -0,0 +1,3 @@
+<h1 class="title">{{hostname}}</h1>
+
+<p class="subtitle">Welcome to your Power Mail-in-a-Box control panel.</p>

management/templates/wkd.html

@@ -0,0 +1,306 @@
+<style>
+	#wkd_table #uids {
+		white-space: pre-line;
+	}
+
+	#wkd_table .domain-header {
+		margin-top: 0.5em;
+		margin-bottom: 0.5em;
+	}
+</style>
+
+<template id="wkd-entry-template">
+	<tr>
+		<td style="vertical-align: middle; white-space: nowrap;" id="email">email@example.com</td>
+		<td id="key-dropdown" class="dropdown show" style="width: 100%;">
+			<button class="btn bg-light" style="width: 100%;" data-bs-toggle="dropdown" id="current-key">
+			</button>
+			<div class="dropdown-menu" style="width: 100%;" id="menu">
+				<button class="btn bg-light" style="width:100%;" id="key-none">
+					<b>None</b>
+					<br>
+					<a>Do not serve a key in WKD.</a>
+				</button>
+				<button class="btn bg-light" style="width:100%" id="key-sample">
+					<div class="row">
+						<div class="col-6" id="fingerprint">
+							<b class="font-monospace status-text" id="fpr"></b><span id="subkeys"></span>
+						</div>
+						<div class="col-6">
+							<b>
+								<span class="sym" id="sign">S</span>
+								<span class="sym" id="cert">C</span>
+								<span class="sym" id="encr">E</span>
+								<span class="sym" id="auth">A</span>
+							</b>,
+							<span id="expire"><span class="status-text"></span></span>
+						</div>
+					</div>
+					<div id="key-emails">
+					</div>
+				</button>
+			</div>
+		</td>
+	</tr>
+</template>
+
+<template id="wkd-nokeys-template">
+	<tr>
+		<td style="vertical-align: middle; white-space: nowrap;" id="email">email@example.com</td>
+		<td style="width: 100%; text-align: center;" class="text-muted">
+			<b>None</b>
+			<br>
+			<a>There are no keys in the keyring that contain this email.</a>
+		</td>
+	</tr>
+</template>
+
+<h2>WKD Management</h2>
+
+<p>WKD (<b>W</b>eb <b>K</b>ey <b>D</b>irectory) is an
+	<b><a href="https://tools.ietf.org/id/draft-koch-openpgp-webkey-service-11.html">experimental feature</a></b>
+	that allows users to authoratively publish their public PGP keys on the web, via HTTPS.
+</p>
+<p>Unlike other solutions (like public keyservers), WKD has the advantage that the owner
+	of the domain has some degree of control over what keys are published and as such there
+	is more certainity that the key actually belongs to it's owner.</p>
+<p>As of this version, there is no support for WKS - This may or may not change in the future.</p>
+
+<h3>Hosting somewhere else</h3>
+<a>
+	If you have a separate server to host WKD, you can still use it instead of this box on a per-domain basis.
+	<br>
+	This box uses the Advanced Method to serve the keys. For example, to host your <code>@some.example.com</code> keys,
+	you can add a A, AAAA or CNAME record for <code>openpgpkey.some.example.com</code>. It will override the box's
+	records.
+	<br><br>
+	There's not a way to "disable" WKD at the moment - but if you don't want to publish keys, or if you want to use the
+	Direct method somewhere else, you can always set the records to an unreachable destination
+	(for example, an A record to <code>0.0.0.0</code>)
+</a>
+
+<h3>Emails hosted by this box</h3>
+<a>
+	This box can serve keys to any email address hosted by this box, be it an user or an alias,
+	granted that the key has one or more user id's with matching emails.
+	<br>
+	You can add keys on the PGP Keyring Management menu.
+</a>
+
+<div class="input-group mt-3 mb-3">
+	<label for="wkd-show-all-entries" class="input-group-text"><b>Show all email addresses</b></label>
+	<div class="input-group-text">
+		<div class="form-switch">
+			<input type="checkbox" role="switch" id="wkd-show-all-entries" class="form-check-input" value=false
+				onclick="toggle_emails_with_no_pgp_key();">
+		</div>
+	</div>
+</div>
+
+<table id="wkd_table" class="table" style="width: 100%">
+	<caption></caption>
+	<thead>
+		<tr>
+			<th>Email Address</th>
+			<th></th>
+		</tr>
+	</thead>
+	<tbody id="wkd_tbody">
+	</tbody>
+</table>
+
+<button id="wkd_submit" class="btn btn-primary" disabled onclick="update_wkd()">Apply</button>
+
+<script>
+	let dirty_config = {}
+	let toggleable_lines = []
+	let show_toggleable_lines = document.getElementById("wkd-show-all-entries").checked
+	function pretty_long_id(fpr) {
+		let plid = ""
+		for (let i = 6; i < 10; ++i) {
+			plid += `${fpr.substring(i * 4, (i + 1) * 4)} `
+		}
+
+		return plid.substring(0, plid.length - 1)
+	}
+	function generate_wkd_menu(email, wkd_config, keys) {
+		if (wkd_config.options.length == 0) {
+			// No possible options
+			let menurep = $("#wkd-nokeys-template").html()
+			menurep = $(menurep)
+			menurep.attr("id", `wkd-${email}`)
+			menurep.find("#email").html(email)
+
+			return menurep
+		}
+
+		// else
+		let menurep = $("#wkd-entry-template").html()
+		menurep = $(menurep)
+		menurep.attr("id", `wkd-${email}`)
+
+		menurep.find("#email").html(email)
+
+		let template = menurep.find("#key-sample")
+		wkd_config.options.forEach(key => {
+			let option = template.prop("outerHTML")
+			option = $(option)
+			option.attr("id", `key-${key}`)
+
+			// Basic information
+			let keyinfo = keys[key]
+			let skey = keyinfo.subkeys[0] // Master subkey
+
+			let fpr = option.find("#fingerprint")
+			fpr.find("#fpr").text(pretty_long_id(key))
+			fpr.find("#subkeys").text(` (${keyinfo.subkeys.length} subkey${keyinfo.subkeys.length == 1 ? "" : "s"})`)
+			option.click(() => {
+				$("#wkd_submit").attr("disabled", false)
+				dirty_config[email] = key
+				menurep.find("#current-key").html(option.html())
+			})
+			option.appendTo(menurep.find("#menu"))
+
+			let classType = ""
+			let expire = option.find("#expire")
+			let exp = expire.find(".status-text")
+
+			// Purpose and expiration
+			// For evaluation we're only going to use the master subkey
+			if (keyinfo.revoked) {
+				classType = "status-error"
+				exp.text(`revoked`)
+			} else if (skey.expired) {
+				classType = "status-error"
+				exp.text(`expired on ${skey.expires_date}`)
+			} else if (skey.expires && skey.expires_days <= 14) {
+				classType = "status-warning"
+				exp.text(`expires in ${skey.expires_days} days (${skey.expires_date})`)
+			} else if (skey.expires) {
+				classType = "status-ok"
+				exp.text(`expires in ${skey.expires_days} days (${skey.expires_date})`)
+			} else {
+				classType = "status-ok"
+				exp.text("does not expire")
+			}
+			expire.addClass(classType)
+			fpr.addClass(classType)
+
+			let s = option.find("#sign")
+			let c = option.find("#cert")
+			let e = option.find("#encr")
+			let a = option.find("#auth")
+
+			s.addClass(skey.sign ? classType : "status-na")
+			c.addClass(skey.cert ? classType : "status-na")
+			e.addClass(skey.encr ? classType : "status-na")
+			a.addClass(skey.auth ? classType : "status-na")
+
+			let txt = ""
+			let n_emails = keyinfo.ids_emails.length
+			if (n_emails == 1) {
+				txt = `<b class="font-monospace">${email}</b>`
+			} else if (email.length >= 70) {
+				// Absurd situation, but can happen!
+				// We'll only
+				txt = `<b class="font-monospace">${email}</b> and ${n_emails - 1} other${n_emails == 2 ? "" : "s"}`
+			} else {
+				let buf = 70 - email.length
+				let others = n_emails - 1
+				let sorted_emails = keyinfo.ids_emails.filter((v) => {
+					return v != email
+				})
+				sorted_emails.sort((x, y) => {
+					// Longer emails come first. If there's a tie, use alphabetic order
+					return x.length == y.length ? x.localeCompare(y) : x.length > y.length ? -1 : 1
+				})
+
+				txt = `<b class="font-monospace">${email}</b>`
+
+				// From the remaining emails, pick the longest ones within the buffer constraints
+				// If none, append the "and x others text"
+				sorted_emails.forEach(e => {
+					if (e.length <= buf) {
+						others--
+						buf -= e.length
+						txt += `, <span class="font-monospace">${e}</span>`
+					}
+				});
+
+				if (others > 0) {
+					txt += ` and ${others} other${others == 1 ? "" : "s"}`
+				}
+			}
+			option.find("#key-emails").html(txt)
+		});
+		template.remove()
+
+		let nokeyopt = menurep.find("#key-none")
+		nokeyopt.click(() => {
+			$("#wkd_submit").attr("disabled", false)
+			dirty_config[email] = null
+			menurep.find("#current-key").html(nokeyopt.html())
+		})
+
+		menurep.find("#current-key").html(menurep.find(`#key-${wkd_config.selected ? wkd_config.selected : "none"}`).html())
+
+		return menurep
+	}
+	function generate_wkd_dropdowns(wkd_info) {
+		$("#wkd_tbody").html("")
+		Object.keys(wkd_info.wkd).forEach(domain => {
+			$(`<tr><td colspan="2" class="bg-light"><h4 class="domain-header">${domain}</h4></td></tr>`).appendTo("#wkd_tbody")
+			Object.keys(wkd_info.wkd[domain]).forEach(email => {
+				let menu = generate_wkd_menu(email, wkd_info.wkd[domain][email], wkd_info.keys)
+				menu.appendTo("#wkd_tbody")
+
+				// No possible keys, we can hide this line to save space
+				if (wkd_info.wkd[domain][email].options.length === 0) {
+					toggleable_lines.push(menu)
+				}
+			})
+		});
+
+		toggle_emails_with_no_pgp_key()
+	}
+	function show_wkd() {
+		toggleable_lines = []
+		$("#wkd_tbody").html("<tr><td colspan='2' class='text-muted'>Loading...</td></tr>")
+		api(
+			"/system/pgp/wkd",
+			"GET",
+			{},
+			(info) => {
+				$("#wkd_submit").attr("disabled", true)
+				dirty_config = {}
+				Object.keys(info.wkd).forEach(domain => {
+					Object.keys(info.wkd[domain]).forEach(email => {
+						dirty_config[email] = info.wkd[domain][email].selected
+					})
+				})
+				generate_wkd_dropdowns(info)
+			}
+		)
+	}
+	function update_wkd() {
+		api(
+			"/system/pgp/wkd",
+			"POST",
+			dirty_config,
+			(r) => {
+				show_modal_error("WKD Management", $("<p/>").text(r), () => { if (r == "OK") show_wkd() })
+			},
+			(r) => {
+				show_modal_error("WKD Management", $("<p/>").text(r))
+			}
+		)
+	}
+
+	function toggle_emails_with_no_pgp_key() {
+		let show_toggleable_lines = document.getElementById("wkd-show-all-entries").checked
+
+		toggleable_lines.forEach(line => {
+			line.toggle(show_toggleable_lines)
+		});
+	}
+</script>

management/utils.py

@@ -6,182 +6,225 @@ import os.path
 
 # THE ENVIRONMENT FILE AT /etc/mailinabox.conf
 
+
 def load_environment():
-    # Load settings from /etc/mailinabox.conf.
-    return load_env_vars_from_file("/etc/mailinabox.conf")
+	# Load settings from /etc/mailinabox.conf.
+	return load_env_vars_from_file("/etc/mailinabox.conf")
+
 
 def load_env_vars_from_file(fn):
-    # Load settings from a KEY=VALUE file.
-    import collections
-    env = collections.OrderedDict()
-    for line in open(fn): env.setdefault(*line.strip().split("=", 1))
-    return env
+	# Load settings from a KEY=VALUE file.
+	import collections
+	env = collections.OrderedDict()
+	for line in open(fn):
+		env.setdefault(*line.strip().split("=", 1))
+	return env
+
 
 def save_environment(env):
-    with open("/etc/mailinabox.conf", "w") as f:
-        for k, v in env.items():
-            f.write("%s=%s\n" % (k, v))
+	with open("/etc/mailinabox.conf", "w") as f:
+		for k, v in env.items():
+			f.write("%s=%s\n" % (k, v))
+
 
 # THE SETTINGS FILE AT STORAGE_ROOT/settings.yaml.
 
+
 def write_settings(config, env):
-    import rtyaml
-    fn = os.path.join(env['STORAGE_ROOT'], 'settings.yaml')
-    with open(fn, "w") as f:
-        f.write(rtyaml.dump(config))
+	import rtyaml
+	fn = os.path.join(env['STORAGE_ROOT'], 'settings.yaml')
+	with open(fn, "w") as f:
+		f.write(rtyaml.dump(config))
+
 
 def load_settings(env):
-    import rtyaml
-    fn = os.path.join(env['STORAGE_ROOT'], 'settings.yaml')
-    try:
-        config = rtyaml.load(open(fn, "r"))
-        if not isinstance(config, dict): raise ValueError() # caught below
-        return config
-    except:
-        return { }
+	import rtyaml
+	fn = os.path.join(env['STORAGE_ROOT'], 'settings.yaml')
+	try:
+		config = rtyaml.load(open(fn, "r"))
+		if not isinstance(config, dict):
+			raise ValueError()  # caught below
+		return config
+	except:
+		return {}
+
 
 # UTILITIES
 
+
 def safe_domain_name(name):
-    # Sanitize a domain name so it is safe to use as a file name on disk.
-    import urllib.parse
-    return urllib.parse.quote(name, safe='')
+	# Sanitize a domain name so it is safe to use as a file name on disk.
+	import urllib.parse
+	return urllib.parse.quote(name, safe='')
+
 
 def sort_domains(domain_names, env):
-    # Put domain names in a nice sorted order.
+	# Put domain names in a nice sorted order.
 
-    # The nice order will group domain names by DNS zone, i.e. the top-most
-    # domain name that we serve that ecompasses a set of subdomains. Map
-    # each of the domain names to the zone that contains them. Walk the domains
-    # from shortest to longest since zones are always shorter than their
-    # subdomains.
-    zones = { }
-    for domain in sorted(domain_names, key=lambda d : len(d)):
-        for z in zones.values():
-            if domain.endswith("." + z):
-                # We found a parent domain already in the list.
-                zones[domain] = z
-                break
-        else:
-            # 'break' did not occur: there is no parent domain, so it is its
-            # own zone.
-            zones[domain] = domain
+	# The nice order will group domain names by DNS zone, i.e. the top-most
+	# domain name that we serve that ecompasses a set of subdomains. Map
+	# each of the domain names to the zone that contains them. Walk the domains
+	# from shortest to longest since zones are always shorter than their
+	# subdomains.
+	zones = {}
+	for domain in sorted(domain_names, key=lambda d: len(d)):
+		for z in zones.values():
+			if domain.endswith("." + z):
+				# We found a parent domain already in the list.
+				zones[domain] = z
+				break
+		else:
+			# 'break' did not occur: there is no parent domain, so it is its
+			# own zone.
+			zones[domain] = domain
 
-    # Sort the zones.
-    zone_domains = sorted(zones.values(),
-      key = lambda d : (
-        # PRIMARY_HOSTNAME or the zone that contains it is always first.
-        not (d == env['PRIMARY_HOSTNAME'] or env['PRIMARY_HOSTNAME'].endswith("." + d)),
+	# Sort the zones.
+	zone_domains = sorted(
+		zones.values(),
+		key=lambda d: (
+			# PRIMARY_HOSTNAME or the zone that contains it is always first.
+			not (d == env['PRIMARY_HOSTNAME'] or env['PRIMARY_HOSTNAME'].
+				endswith("." + d)),
 
-        # Then just dumb lexicographically.
-        d,
-      ))
+			# Then just dumb lexicographically.
+			d,
+		))
 
-    # Now sort the domain names that fall within each zone.
-    domain_names = sorted(domain_names,
-      key = lambda d : (
-        # First by zone.
-        zone_domains.index(zones[d]),
+	# Now sort the domain names that fall within each zone.
+	domain_names = sorted(
+		domain_names,
+		key=lambda d: (
+			# First by zone.
+			zone_domains.index(zones[d]),
 
-        # PRIMARY_HOSTNAME is always first within the zone that contains it.
-        d != env['PRIMARY_HOSTNAME'],
+			# PRIMARY_HOSTNAME is always first within the zone that contains it.
+			d != env['PRIMARY_HOSTNAME'],
 
-        # Followed by any of its subdomains.
-        not d.endswith("." + env['PRIMARY_HOSTNAME']),
+			# Followed by any of its subdomains.
+			not d.endswith("." + env['PRIMARY_HOSTNAME']),
+
+			# Then in right-to-left lexicographic order of the .-separated parts of the name.
+			list(reversed(d.split("."))),
+		))
+
+	return domain_names
 
-        # Then in right-to-left lexicographic order of the .-separated parts of the name.
-        list(reversed(d.split("."))),
-      ))
-    
-    return domain_names
 
 def sort_email_addresses(email_addresses, env):
-    email_addresses = set(email_addresses)
-    domains = set(email.split("@", 1)[1] for email in email_addresses if "@" in email)
-    ret = []
-    for domain in sort_domains(domains, env):
-        domain_emails = set(email for email in email_addresses if email.endswith("@" + domain))
-        ret.extend(sorted(domain_emails))
-        email_addresses -= domain_emails
-    ret.extend(sorted(email_addresses)) # whatever is left
-    return ret
+	email_addresses = set(email_addresses)
+	domains = set(
+		email.split("@", 1)[1] for email in email_addresses if "@" in email)
+	ret = []
+	for domain in sort_domains(domains, env):
+		domain_emails = set(email for email in email_addresses
+							if email.endswith("@" + domain))
+		ret.extend(sorted(domain_emails))
+		email_addresses -= domain_emails
+	ret.extend(sorted(email_addresses))  # whatever is left
+	return ret
 
-def shell(method, cmd_args, env={}, capture_stderr=False, return_bytes=False, trap=False, input=None):
-    # A safe way to execute processes.
-    # Some processes like apt-get require being given a sane PATH.
-    import subprocess
 
-    env.update({ "PATH": "/sbin:/bin:/usr/sbin:/usr/bin" })
-    kwargs = {
-        'env': env,
-        'stderr': None if not capture_stderr else subprocess.STDOUT,
-    }
-    if method == "check_output" and input is not None:
-        kwargs['input'] = input
+def shell(method,
+		cmd_args,
+		env={},
+		capture_stderr=False,
+		return_bytes=False,
+		trap=False,
+		input=None):
+	# A safe way to execute processes.
+	# Some processes like apt-get require being given a sane PATH.
+	import subprocess
+
+	env.update({"PATH": "/sbin:/bin:/usr/sbin:/usr/bin"})
+	kwargs = {
+		'env': env,
+		'stderr': None if not capture_stderr else subprocess.STDOUT,
+	}
+	if method == "check_output" and input is not None:
+		kwargs['input'] = input
+
+	if not trap:
+		ret = getattr(subprocess, method)(cmd_args, **kwargs)
+	else:
+		try:
+			ret = getattr(subprocess, method)(cmd_args, **kwargs)
+			code = 0
+		except subprocess.CalledProcessError as e:
+			ret = e.output
+			code = e.returncode
+	if not return_bytes and isinstance(ret, bytes):
+		ret = ret.decode("utf8")
+	if not trap:
+		return ret
+	else:
+		return code, ret
 
-    if not trap:
-        ret = getattr(subprocess, method)(cmd_args, **kwargs)
-    else:
-        try:
-            ret = getattr(subprocess, method)(cmd_args, **kwargs)
-            code = 0
-        except subprocess.CalledProcessError as e:
-            ret = e.output
-            code = e.returncode
-    if not return_bytes and isinstance(ret, bytes): ret = ret.decode("utf8")
-    if not trap:
-        return ret
-    else:
-        return code, ret
 
 def create_syslog_handler():
-    import logging.handlers
-    handler = logging.handlers.SysLogHandler(address='/dev/log')
-    handler.setLevel(logging.WARNING)
-    return handler
+	import logging.handlers
+	handler = logging.handlers.SysLogHandler(address='/dev/log')
+	handler.setLevel(logging.WARNING)
+	return handler
+
 
 def du(path):
-    # Computes the size of all files in the path, like the `du` command.
-    # Based on http://stackoverflow.com/a/17936789. Takes into account
-    # soft and hard links.
-    total_size = 0
-    seen = set()
-    for dirpath, dirnames, filenames in os.walk(path):
-        for f in filenames:
-            fp = os.path.join(dirpath, f)
-            try:
-                stat = os.lstat(fp)
-            except OSError:
-                continue
-            if stat.st_ino in seen:
-                continue
-            seen.add(stat.st_ino)
-            total_size += stat.st_size
-    return total_size
+	# Computes the size of all files in the path, like the `du` command.
+	# Based on http://stackoverflow.com/a/17936789. Takes into account
+	# soft and hard links.
+	total_size = 0
+	seen = set()
+	for dirpath, dirnames, filenames in os.walk(path):
+		for f in filenames:
+			fp = os.path.join(dirpath, f)
+			try:
+				stat = os.lstat(fp)
+			except OSError:
+				continue
+			if stat.st_ino in seen:
+				continue
+			seen.add(stat.st_ino)
+			total_size += stat.st_size
+	return total_size
+
 
 def wait_for_service(port, public, env, timeout):
 	# Block until a service on a given port (bound privately or publicly)
 	# is taking connections, with a maximum timeout.
-	import socket, time
+	import socket
+	import time
 	start = time.perf_counter()
 	while True:
 		s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
-		s.settimeout(timeout/3)
+		s.settimeout(timeout / 3)
 		try:
 			s.connect(("127.0.0.1" if not public else env['PUBLIC_IP'], port))
 			return True
 		except OSError:
-			if time.perf_counter() > start+timeout:
+			if time.perf_counter() > start + timeout:
 				return False
-		time.sleep(min(timeout/4, 1))
+		time.sleep(min(timeout / 4, 1))
 
-def fix_boto():
-	# Google Compute Engine instances install some Python-2-only boto plugins that
-	# conflict with boto running under Python 3. Disable boto's default configuration
-	# file prior to importing boto so that GCE's plugin is not loaded:
-	import os
-	os.environ["BOTO_CONFIG"] = "/etc/boto3.cfg"
+def get_php_version():
+	# Gets the version of PHP installed in the system.
+	return shell("check_output", ["/usr/bin/php", "-v"])[4:7]
 
+def get_os_code():
+	# Massive mess incoming
+	dist = shell("check_output", ["/usr/bin/lsb_release", "-is"]).strip()
+	version = shell("check_output", ["/usr/bin/lsb_release", "-rs"]).strip()
+
+	if dist == "Debian":
+		if version == "10":
+			return "Debian10"
+		elif version == "11":
+			return "Debian11"
+	elif dist == "Ubuntu":
+		if version == "20.04":
+			return "Ubuntu2004"
+		elif version == "22.04":
+			return "Ubuntu2204"
+
+	return None
 
 if __name__ == "__main__":
 	from web_update import get_web_domains

management/web_update.py

@@ -2,14 +2,20 @@
 # domains for which a mail account has been set up.
 ########################################################################
 
-import os.path, re, rtyaml
+import os.path
+import re
+import rtyaml
 
 from mailconfig import get_mail_domains
 from dns_update import get_custom_dns_config, get_dns_zones
 from ssl_certificates import get_ssl_certificates, get_domain_ssl_files, check_certificate
-from utils import shell, safe_domain_name, sort_domains
+from utils import shell, safe_domain_name, sort_domains, get_php_version
 
-def get_web_domains(env, include_www_redirects=True, exclude_dns_elsewhere=True):
+
+def get_web_domains(env,
+					include_www_redirects=True,
+					include_auto=True,
+					exclude_dns_elsewhere=True):
 	# What domains should we serve HTTP(S) for?
 	domains = set()
 
@@ -18,12 +24,31 @@ def get_web_domains(env, include_www_redirects=True, exclude_dns_elsewhere=True)
 	# if the user wants to make one.
 	domains |= get_mail_domains(env)
 
-	if include_www_redirects:
+	if include_www_redirects and include_auto:
 		# Add 'www.' subdomains that we want to provide default redirects
 		# to the main domain for. We'll add 'www.' to any DNS zones, i.e.
 		# the topmost of each domain we serve.
 		domains |= set('www.' + zone for zone, zonefile in get_dns_zones(env))
-	 
+
+	if include_auto:
+		# Add Autoconfiguration domains for domains that there are user accounts at:
+		# 'autoconfig.' for Mozilla Thunderbird auto setup.
+		# 'autodiscover.' for ActiveSync autodiscovery (Z-Push).
+		domains |= set(
+			'autoconfig.' + maildomain
+			for maildomain in get_mail_domains(env, users_only=True))
+		domains |= set(
+			'autodiscover.' + maildomain
+			for maildomain in get_mail_domains(env, users_only=True))
+
+		# 'mta-sts.' for MTA-STS support for all domains that have email addresses.
+		domains |= set('mta-sts.' + maildomain
+					for maildomain in get_mail_domains(env))
+
+	# 'openpgpkey.' for WKD support
+	domains |= set('openpgpkey.' + maildomain
+				for maildomain in get_mail_domains(env))
+
 	if exclude_dns_elsewhere:
 		# ...Unless the domain has an A/AAAA record that maps it to a different
 		# IP address than this box. Remove those domains from our list.
@@ -39,60 +64,143 @@ def get_web_domains(env, include_www_redirects=True, exclude_dns_elsewhere=True)
 
 	return domains
 
+
 def get_domains_with_a_records(env):
 	domains = set()
 	dns = get_custom_dns_config(env)
-	for domain, rtype, value in dns:
-		if rtype == "CNAME" or (rtype in ("A", "AAAA") and value not in ("local", env['PUBLIC_IP'])):
+	for domain, rtype, value, ttl in dns:
+		if rtype == "CNAME" or (rtype in ("A", "AAAA")
+								and value not in ("local", env['PUBLIC_IP'])):
 			domains.add(domain)
 	return domains
 
+
 def get_web_domains_with_root_overrides(env):
 	# Load custom settings so we can tell what domains have a redirect or proxy set up on '/',
 	# which means static hosting is not happening.
-	root_overrides = { }
+	root_overrides = {}
 	nginx_conf_custom_fn = os.path.join(env["STORAGE_ROOT"], "www/custom.yaml")
 	if os.path.exists(nginx_conf_custom_fn):
 		custom_settings = rtyaml.load(open(nginx_conf_custom_fn))
 		for domain, settings in custom_settings.items():
-			for type, value in [('redirect', settings.get('redirects', {}).get('/')),
-				('proxy', settings.get('proxies', {}).get('/'))]:
+			for type, value in [('redirect', settings.get('redirects',
+														{}).get('/')),
+								('proxy', settings.get('proxies',
+													{}).get('/'))]:
 				if value:
 					root_overrides[domain] = (type, value)
 	return root_overrides
 
+
+DOMAIN_EXTERNAL = -1
+DOMAIN_PRIMARY = 1
+DOMAIN_WWW = 2
+DOMAIN_REDIRECT = 4
+DOMAIN_WKD = 8
+
+
+def get_web_domain_flags(env):
+	flags = dict()
+	zones = get_dns_zones(env)
+	email_domains = get_mail_domains(env)
+	user_domains = get_mail_domains(env, users_only=True)
+	external = get_domains_with_a_records(env)
+	redirects = get_web_domains_with_root_overrides(env)
+
+	for d in email_domains:
+		flags[d] = flags.get(d, 0)
+		flags[f"mta-sts.{d}"] = flags.get(d, 0)
+		flags[f"openpgpkey.{d}"] = flags.get(d, 0) | DOMAIN_WKD
+
+	for d in user_domains:
+		flags[f"autoconfig.{d}"] = flags.get(d, 0)
+		flags[f"autodiscover.{d}"] = flags.get(d, 0)
+
+	for d, _ in zones:
+		flags[f"www.{d}"] = flags.get(d, 0) | DOMAIN_WWW
+
+	for d in redirects:
+		flags[d] = flags.get(d, 0) | DOMAIN_REDIRECT
+
+	flags[env["PRIMARY_HOSTNAME"]] |= DOMAIN_PRIMARY
+
+	# Last check for websites hosted elsewhere
+	for d in flags.keys():
+		if d in external:
+			# -1 = All bits set to 1, assuming twos-complement
+			flags[d] = DOMAIN_EXTERNAL
+	return flags
+
+
 def do_web_update(env):
 	# Pre-load what SSL certificates we will use for each domain.
 	ssl_certificates = get_ssl_certificates(env)
 
 	# Build an nginx configuration file.
-	nginx_conf = open(os.path.join(os.path.dirname(__file__), "../conf/nginx-top.conf")).read()
+	nginx_conf = open(
+		os.path.join(os.path.dirname(__file__),
+					"../conf/nginx-top.conf")).read()
+	nginx_conf = re.sub("{{phpver}}", get_php_version(), nginx_conf)
+
+	# Add upstream additions
+	nginx_upstream_include = os.path.join(env["STORAGE_ROOT"], "www",
+										".upstream.conf")
+	if not os.path.exists(nginx_upstream_include):
+		with open(nginx_upstream_include, "a+") as f:
+			f.writelines([
+				f"# Add your nginx-wide configurations here.\n",
+				"# The following names are already defined:\n\n",
+				"# # php-default: The php socket used for apps managed by the box. (Roundcube, Z-Push, Nextcloud, etc.) - DO NOT USE!\n",
+				"# # php-fpm: A php socket not managed by the box. Feel free to use it for your PHP applications\n"
+			])
+
+	nginx_conf += "\ninclude %s;\n" % (nginx_upstream_include)
 
 	# Load the templates.
-	template0 = open(os.path.join(os.path.dirname(__file__), "../conf/nginx.conf")).read()
-	template1 = open(os.path.join(os.path.dirname(__file__), "../conf/nginx-alldomains.conf")).read()
-	template2 = open(os.path.join(os.path.dirname(__file__), "../conf/nginx-primaryonly.conf")).read()
+	template0 = open(
+		os.path.join(os.path.dirname(__file__), "../conf/nginx.conf")).read()
+	template1 = open(
+		os.path.join(os.path.dirname(__file__),
+					"../conf/nginx-alldomains.conf")).read()
+	template2 = open(
+		os.path.join(os.path.dirname(__file__),
+					"../conf/nginx-primaryonly.conf")).read()
 	template3 = "\trewrite ^(.*) https://$REDIRECT_DOMAIN$1 permanent;\n"
+	template4 = open(
+		os.path.join(os.path.dirname(__file__),
+					"../conf/nginx-openpgpkey.conf")).read()
 
 	# Add the PRIMARY_HOST configuration first so it becomes nginx's default server.
-	nginx_conf += make_domain_config(env['PRIMARY_HOSTNAME'], [template0, template1, template2], ssl_certificates, env)
+	nginx_conf += make_domain_config(env['PRIMARY_HOSTNAME'],
+									[template0, template1, template2],
+									ssl_certificates, env)
 
 	# Add configuration all other web domains.
-	has_root_proxy_or_redirect = get_web_domains_with_root_overrides(env)
-	web_domains_not_redirect = get_web_domains(env, include_www_redirects=False)
-	for domain in get_web_domains(env):
-		if domain == env['PRIMARY_HOSTNAME']:
+	pairs = list(get_web_domain_flags(env).items())
+
+	# Sort the domains in some way to keep ordering consistency. Keep domains and subdomains together.
+	pairs.sort(reverse=False, key=lambda x: x[0][::-1])
+	for domain, flags in pairs:
+		if flags & DOMAIN_PRIMARY == DOMAIN_PRIMARY or flags == DOMAIN_EXTERNAL:
 			# PRIMARY_HOSTNAME is handled above.
 			continue
-		if domain in web_domains_not_redirect:
+		if flags & DOMAIN_WWW == 0:
 			# This is a regular domain.
-			if domain not in has_root_proxy_or_redirect:
-				nginx_conf += make_domain_config(domain, [template0, template1], ssl_certificates, env)
+			if flags & DOMAIN_WKD == DOMAIN_WKD:
+				nginx_conf += make_domain_config(
+					domain, [template0, template1, template4],
+					ssl_certificates, env)
+			elif flags & DOMAIN_REDIRECT == 0:
+				nginx_conf += make_domain_config(domain,
+												[template0, template1],
+												ssl_certificates, env)
 			else:
-				nginx_conf += make_domain_config(domain, [template0], ssl_certificates, env)
+				nginx_conf += make_domain_config(domain, [template0],
+												ssl_certificates, env)
 		else:
 			# Add default 'www.' redirect.
-			nginx_conf += make_domain_config(domain, [template0, template3], ssl_certificates, env)
+			nginx_conf += make_domain_config(domain, [template0, template3],
+											ssl_certificates, env)
 
 	# Did the file change? If not, don't bother writing & restarting nginx.
 	nginx_conf_fn = "/etc/nginx/conf.d/local.conf"
@@ -113,6 +221,7 @@ def do_web_update(env):
 
 	return "web updated\n"
 
+
 def make_domain_config(domain, templates, ssl_certificates, env):
 	# GET SOME VARIABLES
 
@@ -137,7 +246,9 @@ def make_domain_config(domain, templates, ssl_certificates, env):
 		finally:
 			f.close()
 		return sha1.hexdigest()
-	nginx_conf_extra += "# ssl files sha1: %s / %s\n" % (hashfile(tls_cert["private-key"]), hashfile(tls_cert["certificate"]))
+
+	nginx_conf_extra += "\t# ssl files sha1: %s / %s\n" % (hashfile(
+		tls_cert["private-key"]), hashfile(tls_cert["certificate"]))
 
 	# Add in any user customizations in YAML format.
 	hsts = "yes"
@@ -149,72 +260,140 @@ def make_domain_config(domain, templates, ssl_certificates, env):
 
 			# any proxy or redirect here?
 			for path, url in yaml.get("proxies", {}).items():
-				nginx_conf_extra += "\tlocation %s {\n\t\tproxy_pass %s;\n\t}\n" % (path, url)
+				# Parse some flags in the fragment of the URL.
+				pass_http_host_header = False
+				proxy_redirect_off = False
+				frame_options_header_sameorigin = False
+				m = re.search("#(.*)$", url)
+				if m:
+					for flag in m.group(1).split(","):
+						if flag == "pass-http-host":
+							pass_http_host_header = True
+						elif flag == "no-proxy-redirect":
+							proxy_redirect_off = True
+						elif flag == "frame-options-sameorigin":
+							frame_options_header_sameorigin = True
+					url = re.sub("#(.*)$", "", url)
+
+				nginx_conf_extra += "\tlocation %s {" % path
+				nginx_conf_extra += "\n\t\tproxy_pass %s;" % url
+				if proxy_redirect_off:
+					nginx_conf_extra += "\n\t\tproxy_redirect off;"
+				if pass_http_host_header:
+					nginx_conf_extra += "\n\t\tproxy_set_header Host $http_host;"
+				if frame_options_header_sameorigin:
+					nginx_conf_extra += "\n\t\tproxy_set_header X-Frame-Options SAMEORIGIN;"
+				nginx_conf_extra += "\n\t\tproxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;"
+				nginx_conf_extra += "\n\t\tproxy_set_header X-Forwarded-Host $http_host;"
+				nginx_conf_extra += "\n\t\tproxy_set_header X-Forwarded-Proto $scheme;"
+				nginx_conf_extra += "\n\t\tproxy_set_header X-Real-IP $remote_addr;"
+				nginx_conf_extra += "\n\t}\n"
+			for path, alias in yaml.get("aliases", {}).items():
+				nginx_conf_extra += "\tlocation %s {" % path
+				nginx_conf_extra += "\n\t\talias %s;" % alias
+				nginx_conf_extra += "\n\t}\n"
 			for path, url in yaml.get("redirects", {}).items():
-				nginx_conf_extra += "\trewrite %s %s permanent;\n" % (path, url)
+				nginx_conf_extra += "\trewrite %s %s permanent;\n" % (path,
+																	url)
 
 			# override the HSTS directive type
 			hsts = yaml.get("hsts", hsts)
 
 	# Add the HSTS header.
 	if hsts == "yes":
-		nginx_conf_extra += "add_header Strict-Transport-Security max-age=31536000;\n"
+		nginx_conf_extra += "\tadd_header Strict-Transport-Security \"max-age=15768000\" always;\n"
 	elif hsts == "preload":
-		nginx_conf_extra += "add_header Strict-Transport-Security \"max-age=10886400; includeSubDomains; preload\";\n"
+		nginx_conf_extra += "\tadd_header Strict-Transport-Security \"max-age=15768000; includeSubDomains; preload\" always;\n"
 
 	# Add in any user customizations in the includes/ folder.
-	nginx_conf_custom_include = os.path.join(env["STORAGE_ROOT"], "www", safe_domain_name(domain) + ".conf")
-	if os.path.exists(nginx_conf_custom_include):
-		nginx_conf_extra += "\tinclude %s;\n" % (nginx_conf_custom_include)
+	nginx_conf_custom_include = os.path.join(
+		env["STORAGE_ROOT"], "www",
+		safe_domain_name(domain) + ".conf")
+	if not os.path.exists(nginx_conf_custom_include):
+		with open(nginx_conf_custom_include, "a+") as f:
+			f.writelines([
+				f"# Custom configurations for {domain} go here\n",
+				"# To use php: use the \"php-fpm\" alias\n\n",
+				"index index.html index.htm;\n"
+			])
+
+	nginx_conf_extra += "\tinclude %s;\n" % (nginx_conf_custom_include)
+
 	# PUT IT ALL TOGETHER
 
 	# Combine the pieces. Iteratively place each template into the "# ADDITIONAL DIRECTIVES HERE" placeholder
 	# of the previous template.
 	nginx_conf = "# ADDITIONAL DIRECTIVES HERE\n"
 	for t in templates + [nginx_conf_extra]:
-		nginx_conf = re.sub("[ \t]*# ADDITIONAL DIRECTIVES HERE *\n", t, nginx_conf)
+		nginx_conf = re.sub("[ \t]*# ADDITIONAL DIRECTIVES HERE *\n", t,
+							nginx_conf)
 
 	# Replace substitution strings in the template & return.
 	nginx_conf = nginx_conf.replace("$STORAGE_ROOT", env['STORAGE_ROOT'])
 	nginx_conf = nginx_conf.replace("$HOSTNAME", domain)
 	nginx_conf = nginx_conf.replace("$ROOT", root)
 	nginx_conf = nginx_conf.replace("$SSL_KEY", tls_cert["private-key"])
-	nginx_conf = nginx_conf.replace("$SSL_CERTIFICATE", tls_cert["certificate"])
-	nginx_conf = nginx_conf.replace("$REDIRECT_DOMAIN", re.sub(r"^www\.", "", domain)) # for default www redirects to parent domain
+	nginx_conf = nginx_conf.replace("$SSL_CERTIFICATE",
+									tls_cert["certificate"])
+	nginx_conf = nginx_conf.replace(
+		"$REDIRECT_DOMAIN",
+		re.sub(r"^www\.", "",
+			domain))  # for default www redirects to parent domain
 
 	return nginx_conf
 
+
 def get_web_root(domain, env, test_exists=True):
 	# Try STORAGE_ROOT/web/domain_name if it exists, but fall back to STORAGE_ROOT/web/default.
 	for test_domain in (domain, 'default'):
-		root = os.path.join(env["STORAGE_ROOT"], "www", safe_domain_name(test_domain))
-		if os.path.exists(root) or not test_exists: break
+		root = os.path.join(env["STORAGE_ROOT"], "www",
+							safe_domain_name(test_domain))
+		if os.path.exists(root) or not test_exists:
+			break
 	return root
 
+
+def is_default_web_root(domain, env):
+	root = os.path.join(env["STORAGE_ROOT"], "www", safe_domain_name(domain))
+	return not os.path.exists(root)
+
+
 def get_web_domains_info(env):
-	www_redirects = set(get_web_domains(env)) - set(get_web_domains(env, include_www_redirects=False))
+	www_redirects = set(get_web_domains(env)) - \
+			set(get_web_domains(env, include_www_redirects=False))
 	has_root_proxy_or_redirect = set(get_web_domains_with_root_overrides(env))
 	ssl_certificates = get_ssl_certificates(env)
 
 	# for the SSL config panel, get cert status
 	def check_cert(domain):
-		tls_cert = get_domain_ssl_files(domain, ssl_certificates, env, allow_missing_cert=True)
-		if tls_cert is None: return ("danger", "No Certificate Installed")
-		cert_status, cert_status_details = check_certificate(domain, tls_cert["certificate"], tls_cert["private-key"])
+		try:
+			tls_cert = get_domain_ssl_files(domain,
+											ssl_certificates,
+											env,
+											allow_missing_cert=True)
+		except OSError:  # PRIMARY_HOSTNAME cert is missing
+			tls_cert = None
+		if tls_cert is None:
+			return ("danger", "No certificate installed.")
+		cert_status, cert_status_details = check_certificate(
+			domain, tls_cert["certificate"], tls_cert["private-key"])
 		if cert_status == "OK":
 			return ("success", "Signed & valid. " + cert_status_details)
 		elif cert_status == "SELF-SIGNED":
-			return ("warning", "Self-signed. Get a signed certificate to stop warnings.")
+			return ("warning",
+					"Self-signed. Get a signed certificate to stop warnings.")
 		else:
 			return ("danger", "Certificate has a problem: " + cert_status)
 
-	return [
-		{
-			"domain": domain,
-			"root": get_web_root(domain, env),
-			"custom_root": get_web_root(domain, env, test_exists=False),
-			"ssl_certificate": check_cert(domain),
-			"static_enabled": domain not in (www_redirects | has_root_proxy_or_redirect),
-		}
-		for domain in get_web_domains(env)
-	]
+	return [{
+		"domain":
+		domain,
+		"root":
+		get_web_root(domain, env),
+		"custom_root":
+		get_web_root(domain, env, test_exists=False),
+		"ssl_certificate":
+		check_cert(domain),
+		"static_enabled":
+		domain not in (www_redirects | has_root_proxy_or_redirect),
+	} for domain in get_web_domains(env)]

management/wkd.py

@@ -0,0 +1,254 @@
+#!/usr/local/lib/mailinabox/env/bin/python
+# WDK (Web Key Directory) Manager: Facilitates discovery of keys by third-parties
+# Current relevant documents: https://tools.ietf.org/id/draft-koch-openpgp-webkey-service-11.html
+
+import pgp
+import utils
+import rtyaml
+import mailconfig
+import copy
+import shutil
+import os
+import re
+from cryptography.hazmat.primitives import hashes
+from cryptography.hazmat.backends import default_backend
+
+env = utils.load_environment()
+
+wkdpath = f"{env['GNUPGHOME']}/.wkdlist.yml"
+
+
+class WKDError(Exception):
+	"""
+	Errors specifically related to WKD.
+	"""
+
+	def __init__(self, msg):
+		self.message = msg
+
+	def __str__(self):
+		return self.message
+
+
+def sha1(message):
+	h = hashes.Hash(hashes.SHA1(), default_backend())
+	h.update(message)
+	return h.finalize()
+
+
+def zbase32(digest):
+	# Crudely check if all quintets are complete
+	if len(digest) % 5 != 0:
+		raise ValueError("Digest cannot have incomplete chunks of 40 bits!")
+	base = "ybndrfg8ejkmcpqxot1uwisza345h769"
+	encoded = ""
+	for i in range(0, len(digest), 5):
+		chunk = int.from_bytes(digest[i:i + 5], byteorder="big")
+		for j in range(35, -5, -5):
+			encoded += base[(chunk >> j) & 31]
+	return encoded
+
+
+# Strips and exports a key so that only the UID's with the provided email remain.
+# This is to comply with the following requirement, set forth in section 5 of the draft:
+#
+# The mail provider MUST make sure to publish a key in a way
+# that only the mail address belonging to the requested user
+# is part of the User ID packets included in the returned key.
+# Other User ID packets and their associated binding signatures
+# MUST be removed before publication.
+#
+# The arguments "buffer" and "context" are automatically added
+# by the pgp.fork_context() decorator.
+@pgp.fork_context
+def strip_and_export(fpr, target_email, buffer=None, context=None):
+	context.armor = False  # We need to disable armor output for this key
+	k = pgp.get_key(fpr, context)
+	if k is None:
+		return None
+
+	# Horrible hack: Because it's a reference (aka pointer), we can pass these around the functions
+	statusref = {"seq_read": False, "sequence": [], "seq_number": -1}
+
+	def parse_key_dump(dump):
+		UID_REGEX = r".*:.* <(.*)>:.*:([0-9]),.*"
+		at_least_one_not_deleted = False
+		lines = dump.decode().split("\n")
+
+		for line in lines:
+			if line[0:3] != "uid":
+				continue
+			# It's a uid, find the email and the "tag"
+			m = re.search(UID_REGEX, line)
+
+			if m.group(1) != target_email:
+				statusref["sequence"].append(f"uid {m.group(2)}")
+			else:
+				at_least_one_not_deleted = True
+
+		if not at_least_one_not_deleted:
+			raise WKDError("All UID's in this key would have been deleted!")
+
+		statusref["sequence"] += ["deluid", "save"]
+		statusref["seq_read"] = True
+
+	def interaction(request, prompt):
+		if request in ["GOT_IT", "KEY_CONSIDERED", "KEYEXPIRED", ""]:
+			return 0
+		elif request == "GET_BOOL":
+			# No way to confirm interactively, so we just say yes
+			return "y"  # Yeah, I'd also rather just return True but that doesn't work
+		elif request == "GET_LINE" and prompt == "keyedit.prompt":
+			if not statusref["seq_read"]:
+				buffer.seek(0, os.SEEK_SET)
+				parse_key_dump(buffer.read())
+
+			statusref["seq_number"] += 1
+			seqnum = statusref["seq_number"]
+			return statusref["sequence"][seqnum]
+		else:
+			raise Exception("No idea of what to do!")
+
+	buffer.seek(0, os.SEEK_SET)
+	buffer.write(b'')
+	context.interact(k, interaction, sink=buffer)
+	return pgp.export_key(fpr, context)
+
+
+def email_compatible_with_key(email, fingerprint):
+	# 1. Does the user exist?
+	if not email in mailconfig.get_all_mail_addresses(env):
+		raise ValueError(f"User or alias {email} not found!")
+
+	if fingerprint is not None:
+		key = pgp.get_key(fingerprint)
+		# 2. Does the key exist?
+		if key is None:
+			raise ValueError(f"The key \"{fingerprint}\" does not exist!")
+
+		# 3. Does the key have a user id with the email of the user?
+		if email not in [u.email for u in key.uids]:
+			raise WKDError(
+				f"The key \"{fingerprint}\" has no such UID with the email \"{email}\"!"
+			)
+
+		return key
+
+	return None
+
+
+# Gets a table with all the keys that can be served for each user and/or alias
+
+
+def get_user_fpr_maps():
+	uk_maps = {}
+	for email in mailconfig.get_all_mail_addresses(env):
+		uk_maps[email] = set()
+	for key in pgp.get_imported_keys() + [pgp.get_daemon_key()]:
+		for userid in key.uids:
+			try:
+				uk_maps[userid.email].add(key.fpr)
+			except:
+				# We don't host this email address, so ignore
+				pass
+	return uk_maps
+
+
+# Gets the current WKD configuration
+
+
+def get_wkd_config():
+	# Test
+	try:
+		with open(wkdpath, "x"):
+			pass
+	except:
+		pass
+
+	with open(wkdpath, "r") as wkdfile:
+		try:
+			config = rtyaml.load(wkdfile)
+			if (type(config) != dict):
+				return {}
+			return config
+		except:
+			return {}
+
+
+# Sets the WKD configuration. Takes a dictionary {email: fingerprint}.
+# email: An user or alias on this box. e.g. "administrator@example.com"
+# fingerprint: The fingerprint of the key we want to bind it to. e.g "0123456789ABCDEF0123456789ABCDEF01234567"
+
+
+def update_wkd_config(config_sample):
+	config = dict(config_sample)
+	for email, fingerprint in config_sample.items():
+		try:
+			if fingerprint is None or fingerprint == "":
+				config.pop(email)
+			else:
+				email_compatible_with_key(email, fingerprint)
+		except Exception as err:
+			raise err
+
+	# All conditions met, do the necessary modifications
+	with open(wkdpath, "w") as wkdfile:
+		wkdfile.write(rtyaml.dump(config))
+
+
+# Looks for incompatible email/key pairs on the WKD configuration file
+# and returns the uid indexes for compatible email/key pairs
+
+
+def parse_wkd_list():
+	removed = []
+	uidlist = []
+	with open(wkdpath, "a+") as wkdfile:
+		wkdfile.seek(0)
+		config = {}
+		try:
+			config = rtyaml.load(wkdfile)
+			if (type(config) != dict):
+				config = {}
+		except:
+			config = {}
+
+		writeable = copy.deepcopy(config)
+		for u, k in config.items():
+			try:
+				key = email_compatible_with_key(u, k)
+				# Key is compatible
+
+				# Swap with the full-length fingerprint (if somehow this was changed by hand)
+				writeable[u] = key.fpr
+				uidlist.append((u, key.fpr))
+			except:
+				writeable.pop(u)
+				removed.append((u, k))
+		# Shove the updated configuration back in the file
+		wkdfile.truncate(0)
+		wkdfile.write(rtyaml.dump(writeable))
+	return (removed, uidlist)
+
+
+WKD_LOCATION = "/var/lib/mailinabox/wkd/"
+
+
+def build_wkd():
+	# Clean everything
+	try:
+		shutil.rmtree(WKD_LOCATION)
+	except FileNotFoundError:
+		pass
+
+	os.mkdir(WKD_LOCATION, mode=0o755)
+
+	# We serve WKD for all our emails and aliases (even if there are no keys)
+	for domain in mailconfig.get_mail_domains(env, users_only=False):
+		os.mkdir(f"{WKD_LOCATION}/{domain}/", mode=0o755)
+
+	for email, fpr in parse_wkd_list()[1]:
+		local, domain = email.split("@", 1)
+		localhash = zbase32(sha1(local.lower().encode()))
+		with open(f"{WKD_LOCATION}/{domain}/{localhash}", "wb") as k:
+			k.write(strip_and_export(fpr, email))

management/wsgi.py

@@ -0,0 +1,7 @@
+from daemon import app
+import auth, utils
+
+app.logger.addHandler(utils.create_syslog_handler())
+
+if __name__ == "__main__":
+    app.run(port=10222)

ppa/Makefile

@@ -1,62 +0,0 @@
-POSTGREY_VERSION=1.35-1+miab1
-DOVECOT_VERSION=2.2.9-1ubuntu2.1+miab1
-
-all: clean build_postgrey build_dovecot_lucene
-
-clean:
-	# Clean.
-	rm -rf /tmp/build
-	mkdir -p /tmp/build
-
-build_postgrey: clean
-	# Download the latest Debian postgrey package. It is ahead of Ubuntu,
-	# and we might as well jump ahead.
-	git clone git://git.debian.org/git/collab-maint/postgrey.git /tmp/build/postgrey
-
-	# Download the corresponding upstream package.
-	wget -O /tmp/build/postgrey_1.35.orig.tar.gz http://postgrey.schweikert.ch/pub/postgrey-1.35.tar.gz
-
-	# Add our source patch to the debian packaging listing.
-	cp postgrey_sources.diff /tmp/build/postgrey/debian/patches/mailinabox
-
-	# Patch the packaging to give it a new version.
-	patch -p1 -d /tmp/build/postgrey < postgrey.diff
-
-	# Build the source package.
-	(cd /tmp/build/postgrey; dpkg-buildpackage -S -us -uc -nc)
-
-	# Sign the packages.
-	debsign /tmp/build/postgrey_$(POSTGREY_VERSION)_source.changes
-
-	# Upload to PPA.
-	dput ppa:mail-in-a-box/ppa /tmp/build/postgrey_$(POSTGREY_VERSION)_source.changes
-
-	# Clear the intermediate files.
-	rm -rf /tmp/build/postgrey
-
-	# TESTING BINARY PACKAGE
-	#sudo apt-get build-dep -y postgrey
-	#(cd /tmp/build/postgrey; dpkg-buildpackage -us -uc -nc)
-
-build_dovecot_lucene: clean
-	# Get the upstream source.
-	(cd /tmp/build; apt-get source dovecot)
-
-	# Patch it so that we build dovecot-lucene (and nothing else).
-	patch -p1 -d /tmp/build/dovecot-2.2.9 < dovecot_lucene.diff
-
-	# Build the source package.
-	(cd /tmp/build/dovecot-2.2.9; dpkg-buildpackage -S -us -uc -nc)
-
-	# Sign the packages.
-	debsign /tmp/build/dovecot_$(DOVECOT_VERSION)_source.changes
-
-	# Upload it.
-	dput ppa:mail-in-a-box/ppa /tmp/build/dovecot_$(DOVECOT_VERSION)_source.changes
-
-	# TESTING BINARY PACKAGE
-	# Install build dependencies and build dependencies we've added in our patch,
-	# and then build the binary package.
-	#sudo apt-get build-dep -y dovecot
-	#sudo apt-get install libclucene-dev liblzma-dev libexttextcat-dev libstemmer-dev
-	#(cd /tmp/build/dovecot-2.2.9; dpkg-buildpackage -us -uc -nc)

ppa/README.md

@@ -1,40 +0,0 @@
-ppa instructions
-================
-
-Mail-in-a-Box maintains a Launchpad.net PPA ([Mail-in-a-Box PPA](https://launchpad.net/~mail-in-a-box/+archive/ubuntu/ppa)) for additional deb's that we want to have installed on systems.
-
-Packages
---------
-
-* postgrey, a fork of [postgrey](http://postgrey.schweikert.ch/) based on the [latest Debian package](http://git.debian.org/?p=collab-maint/postgrey.git), with a modification to whitelist senders that are whitelisted by [dnswl.org](https://www.dnswl.org/) (i.e. don't greylist mail from known good senders).
-
-* dovecot-lucene, [dovecot's lucene full text search plugin](http://wiki2.dovecot.org/Plugins/FTS/Lucene), which isn't built by Ubuntu's dovecot package maintainer unfortunately.
-
-Building
---------
-
-To rebuild the packages in the PPA, you'll need to be @JoshData.
-
-First:
-
-* You should have an account on Launchpad.net.
-* Your account should have your GPG key set (to the fingerprint of a GPG key on your system matching the identity at the top of the debian/changelog files).
-* You should have write permission to the PPA.
-
-To build:
-
-	# Start a clean VM.
-	vagrant up
-
-	# Put your signing keys (on the host machine) into the VM (so it can sign the debs).
-	gpg --export-secret-keys | vagrant ssh -- gpg --import
-
-	# Build & upload to launchpad.
-	vagrant ssh -- "cd /vagrant && make"
-
-Mail-in-a-Box adds our PPA during setup, but if you need to do that yourself for testing:
-
-	apt-add-repository ppa:mail-in-a-box/ppa
-	apt-get update
-	apt-get install postgrey dovecot-lucene
-

ppa/Vagrantfile

@@ -1,12 +0,0 @@
-# -*- mode: ruby -*-
-# vi: set ft=ruby :
-
-Vagrant.configure("2") do |config|
-  config.vm.box = "ubuntu14.04"
-  config.vm.box_url = "http://cloud-images.ubuntu.com/vagrant/trusty/current/trusty-server-cloudimg-amd64-vagrant-disk1.box"
-
-  config.vm.provision :shell, :inline => <<-SH
-    sudo apt-get update
-    sudo apt-get install -y git dpkg-dev devscripts dput
-SH
-end

ppa/dovecot_lucene.diff

@@ -1,319 +0,0 @@
---- a/debian/control
-+++ b/debian/control
-@@ -1,210 +1,23 @@
- Source: dovecot
- Section: mail
- Priority: optional
--Maintainer: Ubuntu Developers <ubuntu-devel-discuss@lists.ubuntu.com>
--XSBC-Original-Maintainer: Dovecot Maintainers <jaldhar-dovecot@debian.org>
--Uploaders: Jaldhar H. Vyas <jaldhar@debian.org>, Fabio Tranchitella <kobold@debian.org>, Joel Johnson <mrjoel@lixil.net>, Marco Nenciarini <mnencia@debian.org>
--Build-Depends: debhelper (>= 7.2.3~), dpkg-dev (>= 1.16.1), pkg-config, libssl-dev, libpam0g-dev, libldap2-dev, libpq-dev, libmysqlclient-dev, libsqlite3-dev, libsasl2-dev, zlib1g-dev, libkrb5-dev, drac-dev (>= 1.12-5), libbz2-dev, libdb-dev, libcurl4-gnutls-dev, libexpat-dev, libwrap0-dev, dh-systemd, po-debconf, lsb-release, hardening-wrapper, dh-autoreconf, autotools-dev
-+Maintainer: Joshua Tauberer <jt@occams.info>
-+XSBC-Original-Maintainer: Ubuntu Developers <ubuntu-devel-discuss@lists.ubuntu.com>
-+Build-Depends: debhelper (>= 7.2.3~), dpkg-dev (>= 1.16.1), pkg-config, libssl-dev, libpam0g-dev, libldap2-dev, libpq-dev, libmysqlclient-dev, libsqlite3-dev, libsasl2-dev, zlib1g-dev, libkrb5-dev, drac-dev (>= 1.12-5), libbz2-dev, libdb-dev, libcurl4-gnutls-dev, libexpat-dev, libwrap0-dev, dh-systemd, po-debconf, lsb-release, libclucene-dev (>= 2.3), liblzma-dev, libexttextcat-dev, libstemmer-dev, hardening-wrapper, dh-autoreconf, autotools-dev
- Standards-Version: 3.9.4
- Homepage: http://dovecot.org/
--Vcs-Git: git://git.debian.org/git/collab-maint/dovecot.git
--Vcs-Browser: http://git.debian.org/?p=collab-maint/dovecot.git
-+Vcs-Git: https://github.com/mail-in-a-box/mailinabox
-+Vcs-Browser: https://github.com/mail-in-a-box/mailinabox
- 
--Package: dovecot-core
-+Package: dovecot-lucene
- Architecture: any
--Depends: ${shlibs:Depends}, ${misc:Depends}, libpam-runtime (>= 0.76-13.1), openssl, adduser, ucf (>= 2.0020), ssl-cert (>= 1.0-11ubuntu1), lsb-base (>= 3.2-12ubuntu3)
--Suggests: ntp, dovecot-gssapi, dovecot-sieve, dovecot-pgsql, dovecot-mysql, dovecot-sqlite, dovecot-ldap, dovecot-imapd, dovecot-pop3d, dovecot-lmtpd, dovecot-managesieved, dovecot-solr, ufw
--Recommends: ntpdate
--Provides: dovecot-common
--Replaces: dovecot-common (<< 1:2.0.14-2~), mailavenger (<< 0.8.1-4)
--Breaks: dovecot-common (<< 1:2.0.14-2~), mailavenger (<< 0.8.1-4)
--Description: secure POP3/IMAP server - core files
-+Depends: ${shlibs:Depends}, ${misc:Depends}, dovecot-core (>= 1:2.2.9-1ubuntu2.1)
-+Description: secure POP3/IMAP server - Lucene support
-  Dovecot is a mail server whose major goals are security and extreme
-  reliability. It tries very hard to handle all error conditions and verify
-  that all data is valid, making it nearly impossible to crash. It supports
-  mbox/Maildir and its own dbox/mdbox formats, and should also be pretty
-  fast, extensible, and portable.
-  .
-- This package contains the Dovecot main server and its command line utility.
--
--Package: dovecot-dev
--Architecture: any
--Depends: ${shlibs:Depends}, ${misc:Depends}, dovecot-core (= ${binary:Version})
--Replaces: dovecot-common (<< 1:2.0.14-2~)
--Breaks: dovecot-common (<< 1:2.0.14-2~)
--Description: secure POP3/IMAP server - header files
-- Dovecot is a mail server whose major goals are security and extreme
-- reliability. It tries very hard to handle all error conditions and verify
-- that all data is valid, making it nearly impossible to crash. It supports
-- mbox/Maildir and its own dbox/mdbox formats, and should also be pretty
-- fast, extensible, and portable.
-- .
-- This package contains header files needed to compile plugins for the Dovecot
-- mail server.
--
--Package: dovecot-imapd
--Architecture: any
--Depends: ${shlibs:Depends}, ${misc:Depends}, dovecot-core (= ${binary:Version}), ucf (>= 2.0020)
--Provides: imap-server
--Description: secure POP3/IMAP server - IMAP daemon
-- Dovecot is a mail server whose major goals are security and extreme
-- reliability. It tries very hard to handle all error conditions and verify
-- that all data is valid, making it nearly impossible to crash. It supports
-- mbox/Maildir and its own dbox/mdbox formats, and should also be pretty
-- fast, extensible, and portable.
-- .
-- This package contains the Dovecot IMAP server.
--
--Package: dovecot-pop3d
--Architecture: any
--Depends: ${shlibs:Depends}, ${misc:Depends}, dovecot-core (= ${binary:Version}), ucf (>= 2.0020)
--Provides: pop3-server
--Description: secure POP3/IMAP server - POP3 daemon
-- Dovecot is a mail server whose major goals are security and extreme
-- reliability. It tries very hard to handle all error conditions and verify
-- that all data is valid, making it nearly impossible to crash. It supports
-- mbox/Maildir and its own dbox/mdbox formats, and should also be pretty
-- fast, extensible, and portable.
-- .
-- This package contains the Dovecot POP3 server.
--
--Package: dovecot-lmtpd
--Architecture: any
--Depends: ${shlibs:Depends}, ${misc:Depends}, dovecot-core (= ${binary:Version}), ucf (>= 2.0020)
--Replaces: dovecot-common (<< 1:2.0.14-2~)
--Breaks: dovecot-common (<< 1:2.0.14-2~)
--Description: secure POP3/IMAP server - LMTP server
-- Dovecot is a mail server whose major goals are security and extreme
-- reliability. It tries very hard to handle all error conditions and verify
-- that all data is valid, making it nearly impossible to crash. It supports
-- mbox/Maildir and its own dbox/mdbox formats, and should also be pretty
-- fast, extensible, and portable.
-- .
-- This package contains the Dovecot LMTP server.
--
--Package: dovecot-managesieved
--Architecture: any
--Depends: ${shlibs:Depends}, ${misc:Depends}, dovecot-core (= ${binary:Version}), dovecot-sieve (= ${binary:Version}), ucf (>= 2.0020)
--Replaces: dovecot-common (<< 1:2.0.14-2~)
--Breaks: dovecot-common (<< 1:2.0.14-2~)
--Description: secure POP3/IMAP server - ManageSieve server
-- Dovecot is a mail server whose major goals are security and extreme
-- reliability. It tries very hard to handle all error conditions and verify
-- that all data is valid, making it nearly impossible to crash. It supports
-- mbox/Maildir and its own dbox/mdbox formats, and should also be pretty
-- fast, extensible, and portable.
-- .
-- This package contains the Dovecot ManageSieve server.
--
--Package: dovecot-pgsql
--Architecture: any
--Depends: ${shlibs:Depends}, ${misc:Depends}, dovecot-core (= ${binary:Version})
--Description: secure POP3/IMAP server - PostgreSQL support
-- Dovecot is a mail server whose major goals are security and extreme
-- reliability. It tries very hard to handle all error conditions and verify
-- that all data is valid, making it nearly impossible to crash. It supports
-- mbox/Maildir and its own dbox/mdbox formats, and should also be pretty
-- fast, extensible, and portable.
-- .
-- This package provides PostgreSQL support for Dovecot.
--
--Package: dovecot-mysql
--Architecture: any
--Depends: ${shlibs:Depends}, ${misc:Depends}, dovecot-core (= ${binary:Version})
--Description: secure POP3/IMAP server - MySQL support
-- Dovecot is a mail server whose major goals are security and extreme
-- reliability. It tries very hard to handle all error conditions and verify
-- that all data is valid, making it nearly impossible to crash. It supports
-- mbox/Maildir and its own dbox/mdbox formats, and should also be pretty
-- fast, extensible, and portable.
-- .
-- This package provides MySQL support for Dovecot.
--
--Package: dovecot-sqlite
--Architecture: any
--Depends: ${shlibs:Depends}, ${misc:Depends}, dovecot-core (= ${binary:Version})
--Description: secure POP3/IMAP server - SQLite support
-- Dovecot is a mail server whose major goals are security and extreme
-- reliability. It tries very hard to handle all error conditions and verify
-- that all data is valid, making it nearly impossible to crash. It supports
-- mbox/Maildir and its own dbox/mdbox formats, and should also be pretty
-- fast, extensible, and portable.
-- .
-- This package provides SQLite support for Dovecot.
--
--Package: dovecot-ldap
--Architecture: any
--Depends: ${shlibs:Depends}, ${misc:Depends}, dovecot-core (= ${binary:Version}), ucf (>= 2.0020)
--Description: secure POP3/IMAP server - LDAP support
-- Dovecot is a mail server whose major goals are security and extreme
-- reliability. It tries very hard to handle all error conditions and verify
-- that all data is valid, making it nearly impossible to crash. It supports
-- mbox/Maildir and its own dbox/mdbox formats, and should also be pretty
-- fast, extensible, and portable.
-- .
-- This package provides LDAP support for Dovecot.
--
--Package: dovecot-gssapi
--Architecture: any
--Depends: ${shlibs:Depends}, ${misc:Depends}, dovecot-core (= ${binary:Version})
--Description: secure POP3/IMAP server - GSSAPI support
-- Dovecot is a mail server whose major goals are security and extreme
-- reliability. It tries very hard to handle all error conditions and verify
-- that all data is valid, making it nearly impossible to crash. It supports
-- mbox/Maildir and its own dbox/mdbox formats, and should also be pretty
-- fast, extensible, and portable.
-- .
-- This package provides GSSAPI authentication support for Dovecot.
--
--Package: dovecot-sieve
--Architecture: any
--Depends: ${shlibs:Depends}, ${misc:Depends}, dovecot-core (= ${binary:Version}), ucf (>= 2.0020)
--Description: secure POP3/IMAP server - Sieve filters support
-- Dovecot is a mail server whose major goals are security and extreme
-- reliability. It tries very hard to handle all error conditions and verify
-- that all data is valid, making it nearly impossible to crash. It supports
-- mbox/Maildir and its own dbox/mdbox formats, and should also be pretty
-- fast, extensible, and portable.
-- .
-- This package provides Sieve filters support for Dovecot.
--
--Package: dovecot-solr
--Architecture: any
--Depends: ${shlibs:Depends}, ${misc:Depends}, dovecot-core (= ${binary:Version})
--Description: secure POP3/IMAP server - Solr support
-- Dovecot is a mail server whose major goals are security and extreme
-- reliability. It tries very hard to handle all error conditions and verify
-- that all data is valid, making it nearly impossible to crash. It supports
-- mbox/Maildir and its own dbox/mdbox formats, and should also be pretty
-- fast, extensible, and portable.
-- .
-- This package provides Solr full text search support for Dovecot.
--
--Package: dovecot-dbg
--Section: debug
--Priority: extra
--Architecture: any
--Depends: ${misc:Depends}, dovecot-core (= ${binary:Version})
--Description: secure POP3/IMAP server - debug symbols
-- Dovecot is a mail server whose major goals are security and extreme
-- reliability. It tries very hard to handle all error conditions and verify
-- that all data is valid, making it nearly impossible to crash. It supports
-- mbox/Maildir and its own dbox/mdbox formats, and should also be pretty
-- fast, extensible, and portable.
-- .
-- This package contains debug symbols for Dovecot.
--
--Package: mail-stack-delivery
--Architecture: all
--Depends: dovecot-core, dovecot-imapd, dovecot-pop3d, dovecot-managesieved,
-- postfix, ${misc:Depends}
--Replaces: dovecot-postfix (<< 1:1.2.12-0ubuntu1~)
--Description: mail server delivery agent stack provided by Ubuntu server team
-- Ubuntu's mail stack provides fully operational delivery with
-- safe defaults and additional options. Out of the box it supports IMAP,
-- POP3 and SMTP services with SASL authentication and Maildir as default
-- storage engine.
-- .
-- This package contains configuration files for dovecot.
-- .
-- This package modifies postfix's configuration to integrate with dovecot
-+ This package provides Lucene full text search support for Dovecot. It has been modified by Mail-in-a-Box
-+ to supply a dovecot-lucene package compatible with the official ubuntu trusty dovecot-core.
-
-diff --git a/debian/dovecot-lucene.links b/debian/dovecot-lucene.links
-new file mode 100644
-index 0000000..6ffcbeb
---- /dev/null
-+++ b/debian/dovecot-lucene.links
-@@ -0,0 +1 @@
-+/usr/share/bug/dovecot-core /usr/share/bug/dovecot-lucene
-diff --git a/debian/dovecot-lucene.lintian-overrides b/debian/dovecot-lucene.lintian-overrides
-new file mode 100644
-index 0000000..60d90fd
---- /dev/null
-+++ b/debian/dovecot-lucene.lintian-overrides
-@@ -0,0 +1,2 @@
-+dovecot-lucene: hardening-no-fortify-functions usr/lib/dovecot/modules/lib21_fts_lucene_plugin.so
-+
-diff --git a/debian/dovecot-lucene.substvars b/debian/dovecot-lucene.substvars
-new file mode 100644
-index 0000000..ed54f36
---- /dev/null
-+++ b/debian/dovecot-lucene.substvars
-@@ -0,0 +1,2 @@
-+shlibs:Depends=libc6 (>= 2.4), libclucene-core1 (>= 2.3.3.4), libgcc1 (>= 1:4.1.1), libstdc++6 (>= 4.1.1), libstemmer0d (>= 0+svn527)
-+misc:Depends=
-diff --git a/debian/dovecot-lucene.triggers b/debian/dovecot-lucene.triggers
-new file mode 100644
-index 0000000..3d933a5
---- /dev/null
-+++ b/debian/dovecot-lucene.triggers
-@@ -0,0 +1 @@
-+activate register-dovecot-plugin
---- a/debian/rules
-+++ b/debian/rules
-@@ -40,6 +40,7 @@
- 		        --with-solr \
- 	            --with-ioloop=best \
- 	            --with-libwrap \
-+	            --with-lucene \
- 	            --host=$(DEB_HOST_GNU_TYPE) \
- 	            --build=$(DEB_BUILD_GNU_TYPE) \
- 	            --prefix=/usr \
-@@ -95,6 +96,10 @@
- 	dh_testroot
- 	dh_clean -k
- 	dh_installdirs
-+	mkdir -p $(CURDIR)/debian/dovecot-lucene/usr/lib/dovecot/modules
-+	mv $(CURDIR)/src/plugins/fts-lucene/.libs/* $(CURDIR)/debian/dovecot-lucene/usr/lib/dovecot/modules/
-+
-+rest_disabled_by_miab:
- 	$(MAKE) install DESTDIR=$(CURDIR)/debian/dovecot-core
- 	$(MAKE) -C $(PIGEONHOLE_DIR) install DESTDIR=$(CURDIR)/debian/dovecot-core
- 	rm `find $(CURDIR)/debian -name '*.la'`
-@@ -209,7 +214,7 @@
- 	dh_installdocs -a
- 	dh_installexamples -a
- 	dh_installpam -a
--	mv $(CURDIR)/debian/dovecot-core/etc/pam.d/dovecot-core $(CURDIR)/debian/dovecot-core/etc/pam.d/dovecot
-+	#	mv $(CURDIR)/debian/dovecot-core/etc/pam.d/dovecot-core $(CURDIR)/debian/dovecot-core/etc/pam.d/dovecot
- 	dh_systemd_enable
- 	dh_installinit -pdovecot-core --name=dovecot
- 	dh_systemd_start
-@@ -220,10 +225,10 @@
- 	dh_lintian -a
- 	dh_installchangelogs -a ChangeLog
- 	dh_link -a
--	dh_strip -a --dbg-package=dovecot-dbg
-+	#dh_strip -a --dbg-package=dovecot-dbg
- 	dh_compress -a
- 	dh_fixperms -a
--	chmod 0700 debian/dovecot-core/etc/dovecot/private
-+	#chmod 0700 debian/dovecot-core/etc/dovecot/private
- 	dh_makeshlibs -a -n
- 	dh_installdeb -a
- 	dh_shlibdeps -a
---- a/debian/changelog
-+++ a/debian/changelog
-@@ -1,3 +1,9 @@
-+dovecot (1:2.2.9-1ubuntu2.1+miab1) trusty; urgency=low
-+
-+  * Changed to just build dovecot-lucene for Mail-in-a-box PPA
-+
-+ -- Joshua Tauberer <jt@occams.info>  Sat, 14 May 2015 16:13:00 -0400
-+
- dovecot (1:2.2.9-1ubuntu2.1) trusty-security; urgency=medium
- 
-   * SECURITY UPDATE: denial of service via SSL connection exhaustion
---- a/debian/copyright	2014-03-07 07:26:37.000000000 -0500
-+++ b/debian/copyright	2015-05-23 18:17:42.668005535 -0400
-@@ -1,3 +1,7 @@
-+This package is a fork by Mail-in-a-box (https://mailinabox.email). Original 
-+copyright statement follows:
-+----------------------------------------------------------------------------
-+
- This package was debianized by Jaldhar H. Vyas <jaldhar@debian.org> on
- Tue,  3 Dec 2002 01:10:07 -0500.
- 

ppa/postgrey.diff

@@ -1,80 +0,0 @@
-diff --git a/debian/NEWS b/debian/NEWS
-index dd09744..de7b640 100644
---- a/debian/NEWS
-+++ b/debian/NEWS
-@@ -1,3 +1,9 @@
-+postgrey (1.35-1+miab1)
-+
-+  Added DNSWL.org whitelisting.
-+
-+ -- Joshua Tauberer <jt@occams.info>  Mon May 18 18:58:40 EDT 2015
-+
- postgrey (1.32-1) unstable; urgency=low
- 
-   Postgrey is now listening to port 10023 and not 60000.  The latter was an
-diff --git a/debian/changelog b/debian/changelog
-index 1058e15..e5e3557 100644
---- a/debian/changelog
-+++ b/debian/changelog
-@@ -1,3 +1,9 @@
-+postgrey (1.35-1+miab1) trusty; urgency=low
-+
-+  * Added DNSWL.org whitelisting.
-+
-+ -- Joshua Tauberer <jt@occams.info>  Mon, 18 May 2015 21:58:40 +0000
-+
- postgrey (1.35-1) unstable; urgency=low
- 
-   * New upstream release (Closes: 756486)
-diff --git a/debian/control b/debian/control
-index ce12ba6..0a82855 100644
---- a/debian/control
-+++ b/debian/control
-@@ -1,14 +1,11 @@
- Source: postgrey
- Section: mail
- Priority: optional
--Maintainer: Antonio Radici <antonio@debian.org>
--Uploaders: Jon Daley <jondaley-guest@alioth.debian.org>
-+Maintainer: Joshua Tauberer <jt@occams.info>
- Build-Depends: debhelper (>= 7), quilt
- Build-Depends-Indep: po-debconf
- Standards-Version: 3.9.6
- Homepage: http://postgrey.schweikert.ch/
--Vcs-Browser: http://git.debian.org/?p=collab-maint/postgrey.git
--Vcs-Git: git://git.debian.org/git/collab-maint/postgrey.git
- 
- Package: postgrey
- Architecture: all
-@@ -25,3 +22,6 @@ Description: greylisting implementation for Postfix
-  .
-  While Postgrey is designed for use with Postfix, it can also be used
-  with Exim.
-+ .
-+ This version has been modified by Mail-in-a-Box to whitelist senders
-+ in the DNSWL.org list. See https://mailinabox.email.
-diff --git a/debian/copyright b/debian/copyright
-index 3cbe377..bf09b89 100644
---- a/debian/copyright
-+++ b/debian/copyright
-@@ -1,6 +1,10 @@
-+This package is a fork by Mail-in-a-Box (https://mailinabox.email). Original
-+copyright statement follows:
-+----------------------------------------------------------------------------
-+
- This Debian package was prepared by Adrian von Bidder <cmot@debian.org> in
- July 2004, then the package was adopted by Antonio Radici <antonio@dyne.org>
--in Sept 2009
-+in Sept 2009.
- 
- It was downloaded from http://postgrey.schweikert.ch/
- 
-diff --git a/debian/patches/series b/debian/patches/series
-index f4c5e31..3cd62b8 100644
---- a/debian/patches/series
-+++ b/debian/patches/series
-@@ -1,3 +1,3 @@
- imported-upstream-diff
- disable-transaction-logic
--
-+mailinabox

ppa/postgrey_sources.diff

@@ -1,100 +0,0 @@
-Description: whitelist whatever dnswl.org whitelists
- .
- postgrey (1.35-1+miab1) unstable; urgency=low
- .
-   * Added DNSWL.org whitelisting.
-Author: Joshua Tauberer <jt@occams.info>
-
---- postgrey-1.35.orig/README
-+++ postgrey-1.35/README
-@@ -13,7 +13,7 @@ Requirements
- - BerkeleyDB (Perl Module)
- - Berkeley DB >= 4.1 (Library)
- - Digest::SHA (Perl Module, only for --privacy option)
--
-+- Net::DNS (Perl Module)
- 
- Documentation
- -------------
---- postgrey-1.35.orig/postgrey
-+++ postgrey-1.35/postgrey
-@@ -18,6 +18,7 @@ use Fcntl ':flock'; # import LOCK_* cons
- use Sys::Hostname;
- use Sys::Syslog; # used only to find out which version we use
- use POSIX qw(strftime setlocale LC_ALL);
-+use Net::DNS; # for DNSWL.org whitelisting
- 
- use vars qw(@ISA);
- @ISA = qw(Net::Server::Multiplex);
-@@ -26,6 +27,8 @@ my $VERSION = '1.35';
- my $DEFAULT_DBDIR = '/var/lib/postgrey';
- my $CONFIG_DIR = '/etc/postgrey';
- 
-+my $dns_resolver = Net::DNS::Resolver->new;
-+
- sub cidr_parse($)
- {
-     defined $_[0] or return undef;
-@@ -48,6 +51,36 @@ sub cidr_match($$$)
-     return ($addr & $mask) == $net;
- }
- 
-+sub reverseDottedQuad {
-+    # This is the sub _chkValidPublicIP from Net::DNSBL by PJ Goodwin
-+    # at http://www.the42.net/net-dnsbl.
-+    my ($quad) = @_;
-+    if ($quad =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)$/) {
-+        my ($ip1,$ip2,$ip3,$ip4) = ($1, $2, $3, $4);
-+        if (
-+           $ip1 == 10 ||                               #10.0.0.0/8 (10/8)
-+          ($ip1 == 172 && $ip2 >= 16 && $ip2 <= 31) || #172.16.0.0/12 (172.16/12)
-+          ($ip1 == 192 && $ip2 == 168) ||              #192.168.0.0/16 (192.168/16)
-+           $quad eq '127.0.0.1'                        # localhost
-+           ) {
-+            # toss the RFC1918 specified privates
-+            return undef;
-+        } elsif (
-+          ($ip1 <= 1 || $ip1 > 254) ||
-+          ($ip2 < 0  || $ip2 > 255) ||
-+          ($ip3 < 0  || $ip3 > 255) ||
-+          ($ip4 < 0  || $ip4 > 255)
-+           ) {
-+            #invalid oct, toss it;
-+            return undef;
-+        }
-+        my $revquad = $ip4 . "." . $ip3 . "." . $ip2 . "." . $ip1;
-+        return $revquad;
-+    } else { # invalid quad
-+        return undef;
-+    }
-+}
-+
- sub read_clients_whitelists($)
- {
-     my ($self) = @_;
-@@ -361,6 +394,25 @@ sub smtpd_access_policy($$)
-         }
-     }
- 
-+    # whitelist clients in dnswl.org
-+    my $revip = reverseDottedQuad($attr->{client_address});
-+    if ($revip) { # valid IP / plausibly in DNSWL
-+        my $answer = $dns_resolver->send($revip . '.list.dnswl.org');
-+        if ($answer && scalar($answer->answer) > 0) {
-+            my @rrs = $answer->answer;
-+            if ($rrs[0]->type eq 'A' && $rrs[0]->address ne '127.0.0.255') {
-+                # Address appears in DNSWL. (127.0.0.255 means we were rate-limited.)
-+                my $code = $rrs[0]->address;
-+		if ($code =~ /^127.0.(\d+)\.([0-3])$/) {
-+                    my %dnswltrust = (0 => 'legitimate', 1 => 'occasional spam', 2 => 'rare spam', 3 => 'highly unlikely to send spam');
-+                    $code = $2 . '/' . $dnswltrust{$2};
-+                }
-+                $self->mylog_action($attr, 'pass', 'client whitelisted by dnswl.org (' . $code . ')');
-+                return 'DUNNO';
-+            }
-+        }
-+    }
-+
-     # auto whitelist clients (see below for explanation)
-     my ($cawl_db, $cawl_key, $cawl_count, $cawl_last);
-     if($self->{postgrey}{awl_clients}) {

security.md

@@ -1,9 +1,14 @@
 Mail-in-a-Box Security Guide
 ============================
 
-Mail-in-a-Box turns a fresh Ubuntu 14.04 LTS 64-bit machine into a mail server appliance by installing and configuring various components.
+Mail-in-a-Box turns a fresh Ubuntu 18.04 LTS 64-bit machine into a mail server appliance by installing and configuring various components.
 
-This page documents the security features of Mail-in-a-Box. The term “box” is used below to mean a configured Mail-in-a-Box.
+This page documents the security posture of Mail-in-a-Box. The term “box” is used below to mean a configured Mail-in-a-Box.
+
+Reporting Security Vulnerabilities
+----------------------------------
+
+Security vulnerabilities should be reported to the [project's maintainer](https://joshdata.me) via email.
 
 Threat Model
 ------------
@@ -32,34 +37,24 @@ The box's administrator and its (non-administrative) mail users must sometimes c
 
 These services are protected by [TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security):
 
-* SMTP Submission (port 587). Mail users submit outbound mail through SMTP with STARTTLS on port 587.
+* SMTP Submission (ports 465/587). Mail users submit outbound mail through SMTP with TLS (port 465) or STARTTLS (port 587).
 * IMAP/POP (ports 993, 995). Mail users check for incoming mail through IMAP or POP over TLS.
 * HTTPS (port 443). Webmail, the Exchange/ActiveSync protocol, the administrative control panel, and any static hosted websites are accessed over HTTPS.
 
 The services all follow these rules:
 
 * TLS certificates are generated with 2048-bit RSA keys and SHA-256 fingerprints. The box provides a self-signed certificate by default. The [setup guide](https://mailinabox.email/guide.html) explains how to verify the certificate fingerprint on first login. Users are encouraged to replace the certificate with a proper CA-signed one. ([source](setup/ssl.sh))
-* Only TLSv1, TLSv1.1 and TLSv1.2 are offered (the older SSL protocols are not offered).
-* Export-grade ciphers, the anonymous DH/ECDH algorithms (aNULL), and clear-text ciphers (eNULL) are not offered.
-* The minimum cipher key length offered is 112 bits. The maximum is 256 bits. Diffie-Hellman ciphers use a 2048-bit key for forward secrecy.
+* Only TLSv1.2+ are offered (the older SSL protocols are not offered).
+* We track the [Mozilla Intermediate Ciphers Recommendation](https://wiki.mozilla.org/Security/Server_Side_TLS), balancing security with supporting a wide range of mail clients. Diffie-Hellman ciphers use a 2048-bit key for forward secrecy. For more details, see the [output of SSLyze for these ports](tests/tls_results.txt).
 
 Additionally:
 
-* SMTP Submission (port 587) will not accept user credentials without STARTTLS (true also of SMTP on port 25 in case of client misconfiguration), and the submission port won't accept mail without encryption. The minimum cipher key length is 128 bits. (The box is of course configured not to be an open relay. User credentials are required to send outbound mail.) ([source](setup/mail-postfix.sh))
+* SMTP Submission on port 587 will not accept user credentials without STARTTLS (true also of SMTP on port 25 in case of client misconfiguration), and the submission port won't accept mail without encryption. The minimum cipher key length is 128 bits. (The box is of course configured not to be an open relay. User credentials are required to send outbound mail.) ([source](setup/mail-postfix.sh))
 * HTTPS (port 443): The HTTPS Strict Transport Security header is set. A redirect from HTTP to HTTPS is offered. The [Qualys SSL Labs test](https://www.ssllabs.com/ssltest) should report an A+ grade. ([source 1](conf/nginx-ssl.conf), [source 2](conf/nginx.conf))
 
-For more details, see the [output of SSLyze for these ports](tests/tls_results.txt).
-
-The cipher and protocol selection are chosen to support the following clients:
-
-* For HTTPS: Firefox 1, Chrome 1, IE 7, Opera 5, Safari 1, Windows XP IE8, Android 2.3, Java 7.
-* For other protocols: TBD.
-
 ### Password Storage
 
-The passwords for mail users are stored on disk using the [SHA512-CRYPT](http://man7.org/linux/man-pages/man3/crypt.3.html) hashing scheme. ([source](management/mailconfig.py))
-
-When using the web-based administrative control panel, after logging in an API key is placed in the browser's local storage (rather than, say, the user's actual password). The API key is an HMAC based on the user's email address and current password, and it is keyed by a secret known only to the control panel service. By resetting an administrator's password, any HMACs previously generated for that user will expire.
+The passwords for mail users are stored on disk using the [SHA512-CRYPT](http://man7.org/linux/man-pages/man3/crypt.3.html) hashing scheme. ([source](management/mailconfig.py)) Password changes (as well as changes to control panel two-factor authentication settings) expire any control panel login sessions.
 
 ### Console access
 
@@ -73,12 +68,10 @@ If DNSSEC is enabled at the box's domain name's registrar, the SSHFP record that
 
 `fail2ban` provides some protection from brute-force login attacks (repeated logins that guess account passwords) by blocking offending IP addresses at the network level.
 
-The following services are protected: SSH, IMAP (dovecot), SMTP submission (postfix), webmail (roundcube), Nextcloud/CalDAV/CardDAV (over HTTP), and the Mail-in-a-Box control panel & munin (over HTTP).
+The following services are protected: SSH, IMAP (dovecot), SMTP submission (postfix), webmail (roundcube), Nextcloud/CalDAV/CardDAV (over HTTP), and the Mail-in-a-Box control panel (over HTTP).
 
 Some other services running on the box may be missing fail2ban filters.
 
-`fail2ban` only blocks IPv4 addresses, however. If the box has a public IPv6 address, it is not protected from these attacks.
-
 Outbound Mail
 -------------
 
@@ -102,16 +95,20 @@ Domain policy records allow recipient MTAs to detect when the _domain_ part of o
 
 ### User Policy
 
-While domain policy records prevent other servers from sending mail with a "From:" header that matches a domain hosted on the box (see above), those policy records do not guarnatee that the user portion of the sender email address matches the actual sender. In enterprise environments where the box may host the mail of untrusted users, it is important to guard against users impersonating other users.
+While domain policy records prevent other servers from sending mail with a "From:" header that matches a domain hosted on the box (see above), those policy records do not guarantee that the user portion of the sender email address matches the actual sender. In enterprise environments where the box may host the mail of untrusted users, it is important to guard against users impersonating other users.
 
 The box restricts the envelope sender address (also called the return path or MAIL FROM address --- this is different from the "From:" header) that users may put into outbound mail. The envelope sender address must be either their own email address (their SMTP login username) or any alias that they are listed as a permitted sender of. (There is currently no restriction on the contents of the "From:" header.)
 
 Incoming Mail
 -------------
 
-### Encryption
+### Encryption Settings
 
-As discussed above, there is no way to require on-the-wire encryption of mail. When the box receives an incoming email (SMTP on port 25), it offers encryption (STARTTLS) but cannot require that senders use it because some senders may not support STARTTLS at all and other senders may support STARTTLS but not with the latest protocols/ciphers. To give senders the best chance at making use of encryption, the box offers protocols back to TLSv1 and ciphers with key lengths as low as 112 bits. Modern clients (senders) will make use of the 256-bit ciphers and Diffie-Hellman ciphers with a 2048-bit key for perfect forward secrecy, however. ([source](setup/mail-postfix.sh))
+As with outbound email, there is no way to require on-the-wire encryption of incoming mail from all senders. When the box receives an incoming email (SMTP on port 25), it offers encryption (STARTTLS) but cannot require that senders use it because some senders may not support STARTTLS at all and other senders may support STARTTLS but not with the latest protocols/ciphers. To give senders the best chance at making use of encryption, the box offers protocols back to TLSv1 and ciphers with key lengths as low as 112 bits. Modern clients (senders) will make use of the 256-bit ciphers and Diffie-Hellman ciphers with a 2048-bit key for perfect forward secrecy, however. ([source](setup/mail-postfix.sh))
+
+### MTA-STS
+
+The box publishes a SMTP MTA Strict Transport Security ([SMTP MTA-STS](https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol#SMTP_MTA_Strict_Transport_Security)) policy (via DNS and HTTPS) in "enforce" mode. Senders that support MTA-STS will use a secure SMTP connection. (MTA-STS tells senders to connect and expect a signed TLS certificate for the "MX" domain without permitting a fallback to an unencrypted connection.)
 
 ### DANE
 

setup/bootstrap.sh

@@ -2,18 +2,76 @@
 #########################################################
 # This script is intended to be run like this:
 #
-#   curl https://mailinabox.email/setup.sh | sudo bash
+#   curl -L https://power-mailinabox.net/setup.sh | sudo bash
 #
 #########################################################
 
-if [ -z "$TAG" ]; then
-	TAG=v0.23a
-fi
-
 # Are we running as root?
 if [[ $EUID -ne 0 ]]; then
 	echo "This script must be run as root. Did you leave out sudo?"
-	exit
+	exit 1
+fi
+
+if [ ! -f /usr/bin/lsb_release ]; then
+	# Try installing it (apt install lsb-release)
+	if [ ! -f /usr/bin/apt-get ]; then
+		echo "This operating system does not have apt-get! This means it is unsupported!"
+		echo "This script must be run on a system running one of the following OS-es:"
+		echo "* Debian 10 (buster)"
+		echo "* Debian 11 (bullseye)"
+		echo "* Ubuntu 20.04 LTS (Focal Fossa)"
+		echo "* Ubuntu 22.04 LTS (Jammy Jellyfish)"
+		exit 1
+	fi
+
+	echo "Installing lsb-release to understand which operating system we're running..."
+	apt-get -q -q update
+	DEBIAN_FRONTEND=noninteractive apt-get -q -q install -y lsb-release < /dev/null
+fi
+
+if [ -z "$TAG" ]; then
+	# Make sure we're running on the correct operating system
+	OS=$(lsb_release -d | sed 's/.*:\s*//')
+	if  [ "$OS" == "Debian GNU/Linux 11 (bullseye)" ] ||
+		[ "$(echo $OS | grep -o 'Ubuntu 20.04')" == "Ubuntu 20.04" ] ||
+		[ "$(echo $OS | grep -o 'Ubuntu 22.04')" == "Ubuntu 22.04" ]
+	then
+		TAG=v60.5
+	elif [ "$OS" == "Debian GNU/Linux 10 (buster)" ]; then
+		echo "We are going to install the last version of Power Mail-in-a-Box supporting Debian 10 (buster)."
+		echo "IF THIS IS A NEW INSTALLATION, STOP NOW, AND USE A SUPPORTED DISTRIBUTION INSTEAD (ONE OF THESE):"
+		echo "* Debian 11 (bullseye)"
+		echo "* Ubuntu 20.04 LTS (Focal Fossa)"
+		echo "* Ubuntu 22.04 LTS (Jammy Jellyfish)"
+		echo
+		echo "IF YOU'RE UPGRADING THE BOX TO THE LATEST VERSION, PLEASE VISIT THIS PAGE FOR NOTES ON HOW TO"
+		echo "UPGRADE YOUR SISTEM TO DEBIAN 11 (bullseye)"
+		echo "https://power-mailinabox.net/buster-eol"
+
+		while true; do
+			read -p "Do you want to proceed? ([Y]es/[N]o) " yn
+
+			case $yn in
+				Yes | Y | yes | y )
+					break
+					;;
+				No | N | no | n )
+					echo "Installation cancelled."
+					exit 1
+					;;
+				* )
+					;;
+			esac
+		done
+
+		TAG=v56.5
+	else
+		echo "This script must be run on a system running one of the following OS-es:"
+		echo "* Debian 11 (bullseye)"
+		echo "* Ubuntu 20.04 LTS (Focal Fossa)"
+		echo "* Ubuntu 22.04 LTS (Jammy Jellyfish)"
+		exit 1
+	fi
 fi
 
 # Clone the Mail-in-a-Box repository if it doesn't exist.
@@ -28,7 +86,7 @@ if [ ! -d $HOME/mailinabox ]; then
 	echo Downloading Mail-in-a-Box $TAG. . .
 	git clone \
 		-b $TAG --depth 1 \
-		https://github.com/mail-in-a-box/mailinabox \
+		https://git.nibbletools.com/beenull/power-mailinabox \
 		$HOME/mailinabox \
 		< /dev/null 2> /dev/null
 
@@ -39,12 +97,12 @@ fi
 cd $HOME/mailinabox
 
 # Update it.
-if [ "$TAG" != `git describe` ]; then
+if [ "$TAG" != "$(git describe --tags)" ]; then
 	echo Updating Mail-in-a-Box to $TAG . . .
 	git fetch --depth 1 --force --prune origin tag $TAG
 	if ! git checkout -q $TAG; then
-		echo "Update failed. Did you modify something in `pwd`?"
-		exit
+		echo "Update failed. Did you modify something in $(pwd)?"
+		exit 1
 	fi
 	echo
 fi

setup/dkim.sh

@@ -21,11 +21,17 @@ mkdir -p $STORAGE_ROOT/mail/dkim
 # Not quite sure why.
 echo "127.0.0.1" > /etc/opendkim/TrustedHosts
 
+# We need to at least create these files, since we reference them later.
+# Otherwise, opendkim startup will fail
+touch /etc/opendkim/KeyTable
+touch /etc/opendkim/SigningTable
+
 if grep -q "ExternalIgnoreList" /etc/opendkim.conf; then
 	true # already done #NODOC
 else
 	# Add various configuration options to the end of `opendkim.conf`.
 	cat >> /etc/opendkim.conf << EOF;
+Canonicalization		relaxed/simple
 MinimumKeyBits          1024
 ExternalIgnoreList      refile:/etc/opendkim/TrustedHosts
 InternalHosts           refile:/etc/opendkim/TrustedHosts
@@ -54,9 +60,42 @@ fi
 chown -R opendkim:opendkim $STORAGE_ROOT/mail/dkim
 chmod go-rwx $STORAGE_ROOT/mail/dkim
 
-tools/editconf.py /etc/opendmarc.conf -s \
+management/editconf.py /etc/opendmarc.conf -s \
 	"Syslog=true" \
-	"Socket=inet:8893@[127.0.0.1]"
+	"Socket=inet:8893@[127.0.0.1]" \
+	"FailureReports=true"
+
+# SPFIgnoreResults causes the filter to ignore any SPF results in the header
+# of the message. This is useful if you want the filter to perfrom SPF checks
+# itself, or because you don't trust the arriving header. This added header is
+# used by spamassassin to evaluate the mail for spamminess.
+
+management/editconf.py /etc/opendmarc.conf -s \
+        "SPFIgnoreResults=true"
+
+# SPFSelfValidate causes the filter to perform a fallback SPF check itself
+# when it can find no SPF results in the message header. If SPFIgnoreResults
+# is also set, it never looks for SPF results in headers and always performs
+# the SPF check itself when this is set. This added header is used by
+# spamassassin to evaluate the mail for spamminess.
+
+management/editconf.py /etc/opendmarc.conf -s \
+        "SPFSelfValidate=true"
+
+# Enables generation of failure reports for sending domains that publish a
+# "none" policy.
+
+management/editconf.py /etc/opendmarc.conf -s \
+        "FailureReportsOnNone=true"
+
+# AlwaysAddARHeader Adds an "Authentication-Results:" header field even to
+# unsigned messages from domains with no "signs all" policy. The reported DKIM
+# result will be  "none" in such cases. Normally unsigned mail from non-strict
+# domains does not cause the results header field to be added. This added header
+# is used by spamassassin to evaluate the mail for spamminess.
+
+management/editconf.py /etc/opendkim.conf -s \
+        "AlwaysAddARHeader=true"
 
 # Add OpenDKIM and OpenDMARC as milters to postfix, which is how OpenDKIM
 # intercepts outgoing mail to perform the signing (by adding a mail header)
@@ -70,11 +109,14 @@ tools/editconf.py /etc/opendmarc.conf -s \
 # The OpenDMARC milter is skipped in the SMTP submission listener by
 # configuring smtpd_milters there to only list the OpenDKIM milter
 # (see mail-postfix.sh).
-tools/editconf.py /etc/postfix/main.cf \
+management/editconf.py /etc/postfix/main.cf \
 	"smtpd_milters=inet:127.0.0.1:8891 inet:127.0.0.1:8893"\
 	non_smtpd_milters=\$smtpd_milters \
 	milter_default_action=accept
 
+# We need to explicitly enable the opendmarc service, or it will not start
+hide_output systemctl enable opendmarc
+
 # Restart services.
 restart_service opendkim
 restart_service opendmarc

setup/dns.sh

@@ -10,22 +10,20 @@
 source setup/functions.sh # load our functions
 source /etc/mailinabox.conf # load global vars
 
-# Install the packages.
-#
-# * nsd: The non-recursive nameserver that publishes our DNS records.
-# * ldnsutils: Helper utilities for signing DNSSEC zones.
-# * openssh-client: Provides ssh-keyscan which we use to create SSHFP records.
-echo "Installing nsd (DNS server)..."
-apt_install nsd ldnsutils openssh-client
-
 # Prepare nsd's configuration.
-
+# We configure nsd before installation as we only want it to bind to some addresses
+# and it otherwise will have port / bind conflicts with bind9 used as the local resolver
 mkdir -p /var/run/nsd
+mkdir -p /etc/nsd
+mkdir -p /etc/nsd/zones
+touch /etc/nsd/zones.conf
+touch /etc/nsd/nsd.conf
 
 cat > /etc/nsd/nsd.conf << EOF;
 # Do not edit. Overwritten by Mail-in-a-Box setup.
 server:
   hide-version: yes
+  logfile: "/var/log/nsd.log"
 
   # identify the server (CH TXT ID.SERVER entry).
   identity: ""
@@ -49,33 +47,47 @@ for ip in $PRIVATE_IP $PRIVATE_IPV6; do
 	echo "  ip-address: $ip" >> /etc/nsd/nsd.conf;
 done
 
-echo "include: /etc/nsd/zones.conf" >> /etc/nsd/nsd.conf;
+# Create a directory for additional configuration directives, including
+# the zones.conf file written out by our management daemon.
+echo "include: /etc/nsd/nsd.conf.d/*.conf" >> /etc/nsd/nsd.conf;
+
+# Remove the old location of zones.conf that we generate. It will
+# now be stored in /etc/nsd/nsd.conf.d.
+rm -f /etc/nsd/zones.conf
+
+# Add log rotation
+cat > /etc/logrotate.d/nsd <<EOF;
+/var/log/nsd.log {
+  weekly
+  missingok
+  rotate 12
+  compress
+  delaycompress
+  notifempty
+}
+EOF
+
+# Install the packages.
+#
+# * nsd: The non-recursive nameserver that publishes our DNS records.
+# * ldnsutils: Helper utilities for signing DNSSEC zones.
+# * openssh-client: Provides ssh-keyscan which we use to create SSHFP records.
+echo "Installing nsd (DNS server)..."
+apt_install nsd ldnsutils openssh-client
 
 # Create DNSSEC signing keys.
 
 mkdir -p "$STORAGE_ROOT/dns/dnssec";
 
-# TLDs don't all support the same algorithms, so we'll generate keys using a few
-# different algorithms. RSASHA1-NSEC3-SHA1 was possibly the first widely used
-# algorithm that supported NSEC3, which is a security best practice. However TLDs
-# will probably be moving away from it to a a SHA256-based algorithm.
-#
-# Supports `RSASHA1-NSEC3-SHA1` (didn't test with `RSASHA256`):
-#
-#  * .info
-#  * .me
-#
-# Requires `RSASHA256`
-#
-#  * .email
-#  * .guide
-#
-# Supports `RSASHA256` (and defaulting to this)
-#
-#  * .fund
-
+# TLDs, registrars, and validating nameservers don't all support the same algorithms,
+# so we'll generate keys using a few different algorithms so that dns_update.py can
+# choose which algorithm to use when generating the zonefiles. See #1953 for recent
+# discussion. File for previously used algorithms (i.e. RSASHA1-NSEC3-SHA1) may still
+# be in the output directory, and we'll continue to support signing zones with them
+# so that trust isn't broken with deployed DS records, but we won't generate those
+# keys on new systems.
 FIRST=1 #NODOC
-for algo in RSASHA1-NSEC3-SHA1 RSASHA256; do
+for algo in RSASHA256 ECDSAP256SHA256; do
 if [ ! -f "$STORAGE_ROOT/dns/dnssec/$algo.conf" ]; then
 	if [ $FIRST == 1 ]; then
 		echo "Generating DNSSEC signing keys..."
@@ -84,7 +96,7 @@ if [ ! -f "$STORAGE_ROOT/dns/dnssec/$algo.conf" ]; then
 
 	# Create the Key-Signing Key (KSK) (with `-k`) which is the so-called
 	# Secure Entry Point. The domain name we provide ("_domain_") doesn't
-	#  matter -- we'll use the same keys for all our domains.
+	# matter -- we'll use the same keys for all our domains.
 	#
 	# `ldns-keygen` outputs the new key's filename to stdout, which
 	# we're capturing into the `KSK` variable.
@@ -92,17 +104,22 @@ if [ ! -f "$STORAGE_ROOT/dns/dnssec/$algo.conf" ]; then
 	# ldns-keygen uses /dev/random for generating random numbers by default.
 	# This is slow and unecessary if we ensure /dev/urandom is seeded properly,
 	# so we use /dev/urandom. See system.sh for an explanation. See #596, #115.
-	KSK=$(umask 077; cd $STORAGE_ROOT/dns/dnssec; ldns-keygen -r /dev/urandom -a $algo -b 2048 -k _domain_);
+	# (This previously used -b 2048 but it's unclear if this setting makes sense
+	# for non-RSA keys, so it's removed. The RSA-based keys are not recommended
+	# anymore anyway.)
+	KSK=$(umask 077; cd $STORAGE_ROOT/dns/dnssec; ldns-keygen -r /dev/urandom -a $algo -k _domain_);
 
 	# Now create a Zone-Signing Key (ZSK) which is expected to be
 	# rotated more often than a KSK, although we have no plans to
 	# rotate it (and doing so would be difficult to do without
-	# disturbing DNS availability.) Omit `-k` and use a shorter key length.
-	ZSK=$(umask 077; cd $STORAGE_ROOT/dns/dnssec; ldns-keygen -r /dev/urandom -a $algo -b 1024 _domain_);
+	# disturbing DNS availability.) Omit `-k`.
+	# (This previously used -b 1024 but it's unclear if this setting makes sense
+	# for non-RSA keys, so it's removed.)
+	ZSK=$(umask 077; cd $STORAGE_ROOT/dns/dnssec; ldns-keygen -r /dev/urandom -a $algo _domain_);
 
 	# These generate two sets of files like:
 	#
-	# * `K_domain_.+007+08882.ds`: DS record normally provided to domain name registrar (but it's actually invalid with `_domain_`)
+	# * `K_domain_.+007+08882.ds`: DS record normally provided to domain name registrar (but it's actually invalid with `_domain_` so we don't use this file)
 	# * `K_domain_.+007+08882.key`: public key
 	# * `K_domain_.+007+08882.private`: private key (secret!)
 
@@ -126,7 +143,7 @@ cat > /etc/cron.daily/mailinabox-dnssec << EOF;
 #!/bin/bash
 # Mail-in-a-Box
 # Re-sign any DNS zones with DNSSEC because the signatures expire periodically.
-`pwd`/tools/dns_update
+$(pwd)/tools/dns_update
 EOF
 chmod +x /etc/cron.daily/mailinabox-dnssec
 

setup/firstuser.sh

@@ -1,16 +1,16 @@
 # If there aren't any mail users yet, create one.
-if [ -z "`tools/mail.py user`" ]; then
-	# The outut of "tools/mail.py user" is a list of mail users. If there
+if [ -z "$(management/cli.py user)" ]; then
+	# The outut of "management/cli.py user" is a list of mail users. If there
 	# aren't any yet, it'll be empty.
 
 	# If we didn't ask for an email address at the start, do so now.
-	if [ -z "$EMAIL_ADDR" ]; then
+	if [ -z "${EMAIL_ADDR:-}" ]; then
 		# In an interactive shell, ask the user for an email address.
-		if [ -z "$NONINTERACTIVE" ]; then
+		if [ -z "${NONINTERACTIVE:-}" ]; then
 			input_box "Mail Account" \
 				"Let's create your first mail account.
 				\n\nWhat email address do you want?" \
-				me@`get_default_hostname` \
+				me@$(get_default_hostname) \
 				EMAIL_ADDR
 
 			if [ -z "$EMAIL_ADDR" ]; then
@@ -47,11 +47,14 @@ if [ -z "`tools/mail.py user`" ]; then
 	fi
 
 	# Create the user's mail account. This will ask for a password if none was given above.
-	tools/mail.py user add $EMAIL_ADDR $EMAIL_PW
+	management/cli.py user add $EMAIL_ADDR ${EMAIL_PW:-}
 
 	# Make it an admin.
-	hide_output tools/mail.py user make-admin $EMAIL_ADDR
+	hide_output management/cli.py user make-admin $EMAIL_ADDR
 
 	# Create an alias to which we'll direct all automatically-created administrative aliases.
-	tools/mail.py alias add administrator@$PRIMARY_HOSTNAME $EMAIL_ADDR > /dev/null
+	management/cli.py alias add administrator@$PRIMARY_HOSTNAME $EMAIL_ADDR > /dev/null
 fi
+
+# Kick everything that may have been missed
+management/mailconfig.py update

setup/functions.sh

@@ -1,21 +1,30 @@
+# Turn on "strict mode." See http://redsymbol.net/articles/unofficial-bash-strict-mode/.
+# -e: exit if any command unexpectedly fails.
+# -u: exit if we have a variable typo.
+# -o pipefail: don't ignore errors in the non-last command in a pipeline
+set -euo pipefail
+
 function hide_output {
 	# This function hides the output of a command unless the command fails
 	# and returns a non-zero exit code.
 
 	# Get a temporary file.
-	OUTPUT=$(tempfile)
+	OUTPUT=$(mktemp)
 
-	# Execute command, redirecting stderr/stdout to the temporary file.
-	$@ &> $OUTPUT
+	# Execute command, redirecting stderr/stdout to the temporary file. Since we
+	# check the return code ourselves, disable 'set -e' temporarily.
+	set +e
+	"$@" &> "$OUTPUT"
+	E=$?
+	set -e
 
 	# If the command failed, show the output that was captured in the temporary file.
-	E=$?
 	if [ $E != 0 ]; then
 		# Something failed.
 		echo
-		echo FAILED: $@
+		echo FAILED: "$@"
 		echo -----------------------------------------
-		cat $OUTPUT
+		cat "$OUTPUT"
 		echo -----------------------------------------
 		exit $E
 	fi
@@ -44,8 +53,7 @@ function apt_install {
 	# install' for all of the packages.  Calling `dpkg` on each package is slow,
 	# and doesn't affect what we actually do, except in the messages, so let's
 	# not do that anymore.
-	PACKAGES=$@
-	apt_get_quiet install $PACKAGES
+	apt_get_quiet install "$@"
 }
 
 function get_default_hostname {
@@ -66,7 +74,7 @@ function get_publicip_from_web_service {
 	#
 	# Pass '4' or '6' as an argument to this function to specify
 	# what type of address to get (IPv4, IPv6).
-	curl -$1 --fail --silent --max-time 15 icanhazip.com 2>/dev/null
+	curl -$1 --fail --silent --max-time 15 icanhazip.com 2>/dev/null || /bin/true
 }
 
 function get_default_privateip {
@@ -109,7 +117,7 @@ function get_default_privateip {
 	if [ "$1" == "6" ]; then target=2001:4860:4860::8888; fi
 
 	# Get the route information.
-	route=$(ip -$1 -o route get $target | grep -v unreachable)
+	route=$(ip -$1 -o route get $target 2>/dev/null | grep -v unreachable)
 
 	# Parse the address out of the route information.
 	address=$(echo $route | sed "s/.* src \([^ ]*\).*/\1/")
@@ -122,13 +130,19 @@ function get_default_privateip {
 	fi
 
 	echo $address
-		
 }
 
 function ufw_allow {
-	if [ -z "$DISABLE_FIREWALL" ]; then
+	if [ -z "${DISABLE_FIREWALL:-}" ]; then
 		# ufw has completely unhelpful output
-		ufw allow $1 > /dev/null;
+		ufw allow "$1" > /dev/null;
+	fi
+}
+
+function ufw_limit {
+	if [ -z "${DISABLE_FIREWALL:-}" ]; then
+		# ufw has completely unhelpful output
+		ufw limit "$1" > /dev/null;
 	fi
 }
 
@@ -145,10 +159,13 @@ function input_box {
 	# input_box "title" "prompt" "defaultvalue" VARIABLE
 	# The user's input will be stored in the variable VARIABLE.
 	# The exit code from dialog will be stored in VARIABLE_EXITCODE.
+	# Temporarily turn off 'set -e' because we need the dialog return code.
 	declare -n result=$4
 	declare -n result_code=$4_EXITCODE
+	set +e
 	result=$(dialog --stdout --title "$1" --inputbox "$2" 0 0 "$3")
 	result_code=$?
+	set -e
 }
 
 function input_menu {
@@ -158,8 +175,10 @@ function input_menu {
 	declare -n result=$4
 	declare -n result_code=$4_EXITCODE
 	local IFS=^$'\n'
+	set +e
 	result=$(dialog --stdout --title "$1" --menu "$2" 0 0 0 $3)
 	result_code=$?
+	set -e
 }
 
 function wget_verify {
@@ -170,7 +189,7 @@ function wget_verify {
 	DEST=$3
 	CHECKSUM="$HASH  $DEST"
 	rm -f $DEST
-	wget -q -O $DEST $URL || exit 1
+	hide_output wget -O $DEST $URL
 	if ! echo "$CHECKSUM" | sha1sum --check --strict > /dev/null; then
 		echo "------------------------------------------------------------"
 		echo "Download of $URL did not match expected checksum."
@@ -201,3 +220,43 @@ function git_clone {
 	mv $TMPPATH/$SUBDIR $TARGETPATH
 	rm -rf $TMPPATH
 }
+
+function php_version {
+	php --version | head -n 1 | cut -d " " -f 2 | cut -d "." -f 1,2
+}
+
+function python_version {
+	python3 --version | cut -d " " -f 2 | cut -d "." -f 1,2
+}
+
+export OS_UNSUPPORTED=0
+export OS_DEBIAN_10=1
+export OS_UBUNTU_2004=2
+export OS_DEBIAN_11=3
+export OS_UBUNTU_2204=4
+
+function get_os_code {
+	# A lot of if-statements here - dirty code looking tasting today
+	ID=$(lsb_release -is)
+	VER=$(lsb_release -rs)
+
+	if [[ $ID == "Debian" ]]; then
+		if [[ $VER == "10" ]]; then
+			echo $OS_DEBIAN_10
+			return 0
+		elif [[ $VER == "11" ]]; then
+			echo $OS_DEBIAN_11
+			return 0
+		fi
+	elif [[ $ID == "Ubuntu" ]]; then
+		if [[ $VER == "20.04" ]]; then
+			echo $OS_UBUNTU_2004
+			return 0
+		elif [[ $VER == "22.04" ]]; then
+			echo $OS_UBUNTU_2204
+			return 0
+		fi
+	fi
+
+	echo $OS_UNSUPPORTED
+}

setup/mail-dovecot.sh

@@ -26,7 +26,7 @@ source /etc/mailinabox.conf # load global vars
 echo "Installing Dovecot (IMAP server)..."
 apt_install \
 	dovecot-core dovecot-imapd dovecot-pop3d dovecot-lmtpd dovecot-sqlite sqlite3 \
-	dovecot-sieve dovecot-managesieved dovecot-lucene
+	dovecot-sieve dovecot-managesieved
 
 # The `dovecot-imapd`, `dovecot-pop3d`, and `dovecot-lmtpd` packages automatically
 # enable IMAP, POP and LMTP protocols.
@@ -44,9 +44,9 @@ apt_install \
 # See here for discussion:
 # - https://www.dovecot.org/list/dovecot/2012-August/137569.html
 # - https://www.dovecot.org/list/dovecot/2011-December/132455.html
-tools/editconf.py /etc/dovecot/conf.d/10-master.conf \
-	default_process_limit=$(echo "`nproc` * 250" | bc) \
-	default_vsz_limit=$(echo "`free -tom  | tail -1 | awk '{print $2}'` / 3" | bc)M \
+management/editconf.py /etc/dovecot/conf.d/10-master.conf \
+	default_process_limit=$(echo "$(nproc) * 250" | bc) \
+	default_vsz_limit=$(echo "$(free -tm  | tail -1 | awk '{print $2}') / 3" | bc)M \
 	log_path=/var/log/mail.log
 
 # The inotify `max_user_instances` default is 128, which constrains
@@ -54,37 +54,43 @@ tools/editconf.py /etc/dovecot/conf.d/10-master.conf \
 # See http://www.dovecot.org/pipermail/dovecot/2013-March/088834.html.
 # A reboot is required for this to take effect (which we don't do as
 # as a part of setup). Test with `cat /proc/sys/fs/inotify/max_user_instances`.
-tools/editconf.py /etc/sysctl.conf \
+management/editconf.py /etc/sysctl.conf \
 	fs.inotify.max_user_instances=1024
 
 # Set the location where we'll store user mailboxes. '%d' is the domain name and '%n' is the
 # username part of the user's email address. We'll ensure that no bad domains or email addresses
 # are created within the management daemon.
-tools/editconf.py /etc/dovecot/conf.d/10-mail.conf \
+management/editconf.py /etc/dovecot/conf.d/10-mail.conf \
 	mail_location=maildir:$STORAGE_ROOT/mail/mailboxes/%d/%n \
 	mail_privileged_group=mail \
 	first_valid_uid=0
 
 # Create, subscribe, and mark as special folders: INBOX, Drafts, Sent, Trash, Spam and Archive.
-cp conf/dovecot-mailboxes.conf /etc/dovecot/conf.d/15-mailboxes.conf
+cp conf/dovecot/conf.d/15-mailboxes.conf /etc/dovecot/conf.d/
+cp conf/dovecot/conf.d/20-imap.conf /etc/dovecot/conf.d/
+cp conf/dovecot/conf.d/90-quota.conf /etc/dovecot/conf.d/
 
 # ### IMAP/POP
 
 # Require that passwords are sent over SSL only, and allow the usual IMAP authentication mechanisms.
 # The LOGIN mechanism is supposedly for Microsoft products like Outlook to do SMTP login (I guess
 # since we're using Dovecot to handle SMTP authentication?).
-tools/editconf.py /etc/dovecot/conf.d/10-auth.conf \
+management/editconf.py /etc/dovecot/conf.d/10-auth.conf \
 	disable_plaintext_auth=yes \
 	"auth_mechanisms=plain login"
 
 # Enable SSL, specify the location of the SSL certificate and private key files.
-# Disable obsolete SSL protocols and allow only good ciphers per http://baldric.net/2013/12/07/tls-ciphers-in-postfix-and-dovecot/.
-tools/editconf.py /etc/dovecot/conf.d/10-ssl.conf \
+# Use Mozilla's "Intermediate" recommendations at https://ssl-config.mozilla.org/#server=dovecot&server-version=2.2.33&config=intermediate&openssl-version=1.1.1,
+# except that the current version of Dovecot does not have a TLSv1.3 setting, so we only use TLSv1.2.
+management/editconf.py /etc/dovecot/conf.d/10-ssl.conf \
 	ssl=required \
 	"ssl_cert=<$STORAGE_ROOT/ssl/ssl_certificate.pem" \
 	"ssl_key=<$STORAGE_ROOT/ssl/ssl_private_key.pem" \
-	"ssl_protocols=!SSLv3 !SSLv2" \
-	"ssl_cipher_list=TLSv1+HIGH !SSLv2 !RC4 !aNULL !eNULL !3DES @STRENGTH"
+	"ssl_min_protocol=TLSv1.2" \
+	"ssl_cipher_list=ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384" \
+	"ssl_prefer_server_ciphers=no" \
+	"ssl_dh_parameters_length=2048" \
+	"ssl_dh=<$STORAGE_ROOT/ssl/dh2048.pem"
 
 # Disable in-the-clear IMAP/POP because there is no reason for a user to transmit
 # login credentials outside of an encrypted connection. Only the over-TLS versions
@@ -99,27 +105,16 @@ sed -i "s/#port = 110/port = 0/" /etc/dovecot/conf.d/10-master.conf
 # The risk is that if the connection is silent for too long it might be reset
 # by a peer. See [#129](https://github.com/mail-in-a-box/mailinabox/issues/129)
 # and [How bad is IMAP IDLE](http://razor.occams.info/blog/2014/08/09/how-bad-is-imap-idle/).
-tools/editconf.py /etc/dovecot/conf.d/20-imap.conf \
+management/editconf.py /etc/dovecot/conf.d/20-imap.conf \
 	imap_idle_notify_interval="4 mins"
 
 # Set POP3 UIDL.
 # UIDLs are used by POP3 clients to keep track of what messages they've downloaded.
 # For new POP3 servers, the easiest way to set up UIDLs is to use IMAP's UIDVALIDITY
 # and UID values, the default in Dovecot.
-tools/editconf.py /etc/dovecot/conf.d/20-pop3.conf \
+management/editconf.py /etc/dovecot/conf.d/20-pop3.conf \
 	pop3_uidl_format="%08Xu%08Xv"
 
-# Full Text Search - Enable full text search of mail using dovecot's lucene plugin,
-# which *we* package and distribute (dovecot-lucene package).
-tools/editconf.py /etc/dovecot/conf.d/10-mail.conf \
-	mail_plugins="\$mail_plugins fts fts_lucene"
-cat > /etc/dovecot/conf.d/90-plugin-fts.conf << EOF;
-plugin {
-  fts = lucene
-  fts_lucene = whitespace_chars=@.
-}
-EOF
-
 # ### LDA (LMTP)
 
 # Enable Dovecot's LDA service with the LMTP protocol. It will listen
@@ -143,14 +138,22 @@ service lmtp {
   }
 }
 
+# Enable imap-login on localhost to allow the user_external plugin
+# for Nextcloud to do imap authentication. (See #1577)
+service imap-login {
+  inet_listener imap {
+    address = 127.0.0.1
+    port = 143
+  }
+}
 protocol imap {
-  mail_max_userip_connections = 20
+  mail_max_userip_connections = 40
 }
 EOF
 
 # Setting a `postmaster_address` is required or LMTP won't start. An alias
 # will be created automatically by our management daemon.
-tools/editconf.py /etc/dovecot/conf.d/15-lda.conf \
+management/editconf.py /etc/dovecot/conf.d/15-lda.conf \
 	postmaster_address=postmaster@$PRIMARY_HOSTNAME
 
 # ### Sieve
@@ -183,6 +186,8 @@ plugin {
   sieve_after = $STORAGE_ROOT/mail/sieve/global_after
   sieve = $STORAGE_ROOT/mail/sieve/%d/%n.sieve
   sieve_dir = $STORAGE_ROOT/mail/sieve/%d/%n
+  sieve_redirect_envelope_from = recipient
+  sieve_vacation_send_from_recipient = yes
 }
 EOF
 

setup/mail-postfix.sh

@@ -13,11 +13,11 @@
 # destinations according to aliases, and passses email on to
 # another service for local mail delivery.
 #
-# The first hop in local mail delivery is to Spamassassin via
-# LMTP. Spamassassin then passes mail over to Dovecot for
+# The first hop in local mail delivery is to spampd via
+# LMTP. spampd then passes mail over to Dovecot for
 # storage in the user's mailbox.
 #
-# Postfix also listens on port 587 (SMTP+STARTLS) for
+# Postfix also listens on ports 465/587 (SMTPS, SMTP+STARTLS) for
 # connections from users who can authenticate and then sends
 # their email out to the outside world. Postfix queries Dovecot
 # to authenticate users.
@@ -41,16 +41,8 @@ source /etc/mailinabox.conf # load global vars
 #   always will.
 # * `ca-certificates`: A trust store used to squelch postfix warnings about
 #   untrusted opportunistically-encrypted connections.
-#
-# postgrey is going to come in via the Mail-in-a-Box PPA, which publishes
-# a modified version of postgrey that lets senders whitelisted by dnswl.org
-# pass through without being greylisted. So please note [dnswl's license terms](https://www.dnswl.org/?page_id=9):
-# > Every user with more than 100’000 queries per day on the public nameserver
-# > infrastructure and every commercial vendor of dnswl.org data (eg through
-# > anti-spam solutions) must register with dnswl.org and purchase a subscription.
-
 echo "Installing Postfix (SMTP server)..."
-apt_install postfix postfix-pcre postgrey ca-certificates
+apt_install postfix postfix-sqlite postfix-pcre postgrey ca-certificates libsasl2-modules
 
 # ### Basic Settings
 
@@ -61,44 +53,51 @@ apt_install postfix postfix-pcre postgrey ca-certificates
 # * Set our name (the Debian default seems to be "localhost" but make it our hostname).
 # * Set the name of the local machine to localhost, which means xxx@localhost is delivered locally, although we don't use it.
 # * Set the SMTP banner (which must have the hostname first, then anything).
-tools/editconf.py /etc/postfix/main.cf \
+management/editconf.py /etc/postfix/main.cf \
 	inet_interfaces=all \
 	smtp_bind_address=$PRIVATE_IP \
 	smtp_bind_address6=$PRIVATE_IPV6 \
 	myhostname=$PRIMARY_HOSTNAME\
-	smtpd_banner="\$myhostname ESMTP Hi, I'm a Mail-in-a-Box (Ubuntu/Postfix; see https://mailinabox.email/)" \
+	smtpd_banner="\$myhostname ESMTP Power Mail-in-a-Box (Postfix)" \
 	mydestination=localhost
 
 # Tweak some queue settings:
 # * Inform users when their e-mail delivery is delayed more than 3 hours (default is not to warn).
 # * Stop trying to send an undeliverable e-mail after 2 days (instead of 5), and for bounce messages just try for 1 day.
-tools/editconf.py /etc/postfix/main.cf \
+management/editconf.py /etc/postfix/main.cf \
 	delay_warning_time=3h \
 	maximal_queue_lifetime=2d \
 	bounce_queue_lifetime=1d
 
 # ### Outgoing Mail
 
-# Enable the 'submission' port 587 smtpd server and tweak its settings.
+# Enable the 'submission' ports 465 and 587 and tweak their settings.
 #
+# * Enable authentication. It's disabled globally so that it is disabled on port 25,
+#   so we need to explicitly enable it here.
 # * Do not add the OpenDMAC Authentication-Results header. That should only be added
 #   on incoming mail. Omit the OpenDMARC milter by re-setting smtpd_milters to the
 #   OpenDKIM milter only. See dkim.sh.
 # * Even though we dont allow auth over non-TLS connections (smtpd_tls_auth_only below, and without auth the client cant
 #   send outbound mail), don't allow non-TLS mail submission on this port anyway to prevent accidental misconfiguration.
-# * Require the best ciphers for incoming connections per http://baldric.net/2013/12/07/tls-ciphers-in-postfix-and-dovecot/.
-#   By putting this setting here we leave opportunistic TLS on incoming mail at default cipher settings (any cipher is better than none).
+#   Setting smtpd_tls_security_level=encrypt also triggers the use of the 'mandatory' settings below (but this is ignored with smtpd_tls_wrappermode=yes.)
 # * Give it a different name in syslog to distinguish it from the port 25 smtpd server.
 # * Add a new cleanup service specific to the submission service ('authclean')
 #   that filters out privacy-sensitive headers on mail being sent out by
 #   authenticated users.  By default Postfix also applies this to attached
 #   emails but we turn this off by setting nested_header_checks empty.
-tools/editconf.py /etc/postfix/master.cf -s -w \
+management/editconf.py /etc/postfix/master.cf -s -w \
+	"smtps=inet n       -       -       -       -       smtpd
+	  -o smtpd_tls_wrappermode=yes
+	  -o smtpd_sasl_auth_enable=yes
+	  -o syslog_name=postfix/submission
+	  -o smtpd_milters=inet:127.0.0.1:8891
+	  -o cleanup_service_name=authclean" \
 	"submission=inet n       -       -       -       -       smtpd
+	  -o smtpd_sasl_auth_enable=yes
 	  -o syslog_name=postfix/submission
 	  -o smtpd_milters=inet:127.0.0.1:8891
 	  -o smtpd_tls_security_level=encrypt
-	  -o smtpd_tls_ciphers=high -o smtpd_tls_exclude_ciphers=aNULL,DES,3DES,MD5,DES+MD5,RC4 -o smtpd_tls_mandatory_protocols=!SSLv2,!SSLv3
 	  -o cleanup_service_name=authclean" \
 	"authclean=unix  n       -       -       -       0       cleanup
 	  -o header_checks=pcre:/etc/postfix/outgoing_mail_header_filters
@@ -107,36 +106,53 @@ tools/editconf.py /etc/postfix/master.cf -s -w \
 # Install the `outgoing_mail_header_filters` file required by the new 'authclean' service.
 cp conf/postfix_outgoing_mail_header_filters /etc/postfix/outgoing_mail_header_filters
 
-# Modify the `outgoing_mail_header_filters` file to use the local machine name and ip 
+# Modify the `outgoing_mail_header_filters` file to use the local machine name and ip
 # on the first received header line.  This may help reduce the spam score of email by
 # removing the 127.0.0.1 reference.
 sed -i "s/PRIMARY_HOSTNAME/$PRIMARY_HOSTNAME/" /etc/postfix/outgoing_mail_header_filters
 sed -i "s/PUBLIC_IP/$PUBLIC_IP/" /etc/postfix/outgoing_mail_header_filters
 
-# Enable TLS on these and all other connections (i.e. ports 25 *and* 587) and
-# require TLS before a user is allowed to authenticate. This also makes
-# opportunistic TLS available on *incoming* mail.
-# Set stronger DH parameters, which via openssl tend to default to 1024 bits
-# (see ssl.sh).
-tools/editconf.py /etc/postfix/main.cf \
+# Enable TLS on incoming connections. It is not required on port 25, allowing for opportunistic
+# encryption. On ports 465 and 587 it is mandatory (see above). Shared and non-shared settings are
+# given here. Shared settings include:
+# * Require TLS before a user is allowed to authenticate.
+# * Set the path to the server TLS certificate and 2048-bit DH parameters for old DH ciphers.
+# For port 25 only:
+# * Disable extremely old versions of TLS and extremely unsafe ciphers, but some mail servers out in
+#   the world are very far behind and if we disable too much, they may not be able to use TLS and
+#   won't fall back to cleartext. So we don't disable too much. smtpd_tls_exclude_ciphers applies to
+#   both port 25 and port 587, but because we override the cipher list for both, it probably isn't used.
+#   Use Mozilla's "Old" recommendations at https://ssl-config.mozilla.org/#server=postfix&version=3.4.8&config=old&openssl=1.1.1&guideline=5.6
+management/editconf.py /etc/postfix/main.cf \
 	smtpd_tls_security_level=may\
 	smtpd_tls_auth_only=yes \
 	smtpd_tls_cert_file=$STORAGE_ROOT/ssl/ssl_certificate.pem \
 	smtpd_tls_key_file=$STORAGE_ROOT/ssl/ssl_private_key.pem \
 	smtpd_tls_dh1024_param_file=$STORAGE_ROOT/ssl/dh2048.pem \
-	smtpd_tls_protocols=\!SSLv2,\!SSLv3 \
+	smtpd_tls_protocols="!SSLv2,!SSLv3" \
 	smtpd_tls_ciphers=medium \
-	smtpd_tls_exclude_ciphers=aNULL,RC4 \
+	tls_medium_cipherlist=ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:DHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES256-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:DES-CBC3-SHA \
+	smtpd_tls_exclude_ciphers=aNULL,DES,3DES,MD5,DES+MD5,RC4 \
+	tls_preempt_cipherlist=yes \
 	smtpd_tls_received_header=yes
 
+# For ports 465/587 (via the 'mandatory' settings):
+# * Use Mozilla's "Intermediate" TLS recommendations from https://ssl-config.mozilla.org/#server=postfix&server-version=3.3.0&config=intermediate&openssl-version=1.1.1
+#   using and overriding the "high" cipher list so we don't conflict with the more permissive settings for port 25.
+management/editconf.py /etc/postfix/main.cf \
+	smtpd_tls_mandatory_protocols="!SSLv2,!SSLv3,!TLSv1,!TLSv1.1" \
+	smtpd_tls_mandatory_ciphers=high \
+	tls_high_cipherlist=ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384 \
+	smtpd_tls_mandatory_exclude_ciphers=aNULL,DES,3DES,MD5,DES+MD5,RC4
+
 # Prevent non-authenticated users from sending mail that requires being
 # relayed elsewhere. We don't want to be an "open relay". On outbound
 # mail, require one of:
 #
-# * `permit_sasl_authenticated`: Authenticated users (i.e. on port 587).
+# * `permit_sasl_authenticated`: Authenticated users (i.e. on port 465/587).
 # * `permit_mynetworks`: Mail that originates locally.
 # * `reject_unauth_destination`: No one else. (Permits mail whose destination is local and rejects other mail.)
-tools/editconf.py /etc/postfix/main.cf \
+management/editconf.py /etc/postfix/main.cf \
 	smtpd_relay_restrictions=permit_sasl_authenticated,permit_mynetworks,reject_unauth_destination
 
 
@@ -148,38 +164,46 @@ tools/editconf.py /etc/postfix/main.cf \
 # offers it, otherwise it will transmit the message in the clear. Postfix will
 # accept whatever SSL certificate the remote end provides. Opportunistic TLS
 # protects against passive easvesdropping (but not man-in-the-middle attacks).
+# Since we'd rather have poor encryption than none at all, we use Mozilla's
+# "Old" recommendations at https://ssl-config.mozilla.org/#server=postfix&server-version=3.3.0&config=old&openssl-version=1.1.1
+# for opportunistic encryption but "Intermediate" recommendations when DANE
+# is used (see next and above). The cipher lists are set above.
+
 # DANE takes this a step further:
-#
 # Postfix queries DNS for the TLSA record on the destination MX host. If no TLSA records are found,
 # then opportunistic TLS is used. Otherwise the server certificate must match the TLSA records
 # or else the mail bounces. TLSA also requires DNSSEC on the MX host. Postfix doesn't do DNSSEC
 # itself but assumes the system's nameserver does and reports DNSSEC status. Thus this also
-# relies on our local bind9 server being present and `smtp_dns_support_level=dnssec`.
+# relies on our local DNS server (see system.sh) and `smtp_dns_support_level=dnssec`.
 #
 # The `smtp_tls_CAfile` is superflous, but it eliminates warnings in the logs about untrusted certs,
 # which we don't care about seeing because Postfix is doing opportunistic TLS anyway. Better to encrypt,
 # even if we don't know if it's to the right party, than to not encrypt at all. Instead we'll
 # now see notices about trusted certs. The CA file is provided by the package `ca-certificates`.
-tools/editconf.py /etc/postfix/main.cf \
+management/editconf.py /etc/postfix/main.cf \
 	smtp_tls_protocols=\!SSLv2,\!SSLv3 \
-	smtp_tls_mandatory_protocols=\!SSLv2,\!SSLv3 \
 	smtp_tls_ciphers=medium \
 	smtp_tls_exclude_ciphers=aNULL,RC4 \
 	smtp_tls_security_level=dane \
 	smtp_dns_support_level=dnssec \
+	smtp_tls_mandatory_protocols="!SSLv2,!SSLv3,!TLSv1,!TLSv1.1" \
+	smtp_tls_mandatory_ciphers=high \
 	smtp_tls_CAfile=/etc/ssl/certs/ca-certificates.crt \
 	smtp_tls_loglevel=2
 
 # ### Incoming Mail
 
-# Pass any incoming mail over to a local delivery agent. Spamassassin
-# will act as the LDA agent at first. It is listening on port 10025
-# with LMTP. Spamassassin will pass the mail over to Dovecot after.
+# Pass mail to spampd, which acts as the local delivery agent (LDA),
+# which then passes the mail over to the Dovecot LMTP server after.
+# spampd runs on port 10025 by default.
 #
 # In a basic setup we would pass mail directly to Dovecot by setting
 # virtual_transport to `lmtp:unix:private/dovecot-lmtp`.
-#
-tools/editconf.py /etc/postfix/main.cf virtual_transport=lmtp:[127.0.0.1]:10025
+management/editconf.py /etc/postfix/main.cf "virtual_transport=lmtp:[127.0.0.1]:10025"
+# Clear the lmtp_destination_recipient_limit setting which in previous
+# versions of Mail-in-a-Box was set to 1 because of a spampd bug.
+# See https://github.com/mail-in-a-box/mailinabox/issues/1523.
+management/editconf.py /etc/postfix/main.cf  -e lmtp_destination_recipient_limit=
 
 # Who can send mail to us? Some basic filters.
 #
@@ -198,9 +222,9 @@ tools/editconf.py /etc/postfix/main.cf virtual_transport=lmtp:[127.0.0.1]:10025
 # so these IPs get mail delivered quickly. But when an IP is not listed in the permit_dnswl_client list (i.e. it is not #NODOC
 # whitelisted) then postfix does a DEFER_IF_REJECT, which results in all "unknown user" sorts of messages turning into #NODOC
 # "450 4.7.1 Client host rejected: Service unavailable". This is a retry code, so the mail doesn't properly bounce. #NODOC
-tools/editconf.py /etc/postfix/main.cf \
+management/editconf.py /etc/postfix/main.cf \
 	smtpd_sender_restrictions="reject_non_fqdn_sender,reject_unknown_sender_domain,reject_authenticated_sender_login_mismatch,reject_rhsbl_sender dbl.spamhaus.org" \
-	smtpd_recipient_restrictions=permit_sasl_authenticated,permit_mynetworks,"reject_rbl_client zen.spamhaus.org",reject_unlisted_recipient,"check_policy_service inet:127.0.0.1:10023"
+	smtpd_recipient_restrictions="check_recipient_access sqlite:/etc/postfix/noreply-addresses.cf",permit_sasl_authenticated,permit_mynetworks,"reject_rbl_client zen.spamhaus.org",reject_unlisted_recipient,"check_policy_service inet:127.0.0.1:10023","check_policy_service inet:127.0.0.1:12340"
 
 # Postfix connects to Postgrey on the 127.0.0.1 interface specifically. Ensure that
 # Postgrey listens on the same interface (and not IPv6, for instance).
@@ -208,18 +232,80 @@ tools/editconf.py /etc/postfix/main.cf \
 # As a matter of fact RFC is not strict about retry timer so postfix and
 # other MTA have their own intervals. To fix the problem of receiving
 # e-mails really latter, delay of greylisting has been set to
-# 180 seconds (default is 300 seconds).
-tools/editconf.py /etc/default/postgrey \
-	POSTGREY_OPTS=\"'--inet=127.0.0.1:10023 --delay=180'\"
+# 180 seconds (default is 300 seconds). We will move the postgrey database
+# under $STORAGE_ROOT. This prevents a "warming up" that would have occured
+# previously with a migrated or reinstalled OS.  We will specify this new path
+# with the --dbdir=... option. Arguments within POSTGREY_OPTS can not have spaces,
+# including dbdir. This is due to the way the init script sources the
+# /etc/default/postgrey file. --dbdir=... either needs to be a path without spaces
+# (luckily $STORAGE_ROOT does not currently work with spaces), or it needs to be a
+# symlink without spaces that can point to a folder with spaces).  We'll just assume
+# $STORAGE_ROOT won't have spaces to simplify things.
+management/editconf.py /etc/default/postgrey \
+	POSTGREY_OPTS=\""--inet=127.0.0.1:10023 --delay=180 --dbdir=$STORAGE_ROOT/mail/postgrey/db"\"
+
+
+# If the $STORAGE_ROOT/mail/postgrey is empty, copy the postgrey database over from the old location
+if [ ! -d $STORAGE_ROOT/mail/postgrey/db ]; then
+	# Stop the service
+	service postgrey stop
+	# Ensure the new paths for postgrey db exists
+	mkdir -p $STORAGE_ROOT/mail/postgrey/db
+	# Move over database files
+	mv /var/lib/postgrey/* $STORAGE_ROOT/mail/postgrey/db/ || true
+fi
+# Ensure permissions are set
+chown -R postgrey:postgrey $STORAGE_ROOT/mail/postgrey/
+chmod 700 $STORAGE_ROOT/mail/postgrey/{,db}
+
+# We are going to setup a newer whitelist for postgrey, the version included in the distribution is old
+cat > /etc/cron.daily/mailinabox-postgrey-whitelist << EOF;
+#!/bin/bash
+
+# Mail-in-a-Box
+
+# check we have a postgrey_whitelist_clients file and that it is not older than 28 days
+if [ ! -f /etc/postgrey/whitelist_clients ] || find /etc/postgrey/whitelist_clients -mtime +28 | grep -q '.' ; then
+    # ok we need to update the file, so lets try to fetch it
+    if curl https://postgrey.schweikert.ch/pub/postgrey_whitelist_clients --output /tmp/postgrey_whitelist_clients -sS --fail > /dev/null 2>&1 ; then
+        # if fetching hasn't failed yet then check it is a plain text file
+        # curl manual states that --fail sometimes still produces output
+        # this final check will at least check the output is not html
+        # before moving it into place
+        if [ "\$(file -b --mime-type /tmp/postgrey_whitelist_clients)" == "text/plain" ]; then
+            mv /tmp/postgrey_whitelist_clients /etc/postgrey/whitelist_clients
+            service postgrey restart
+	else
+            rm /tmp/postgrey_whitelist_clients
+        fi
+    fi
+fi
+EOF
+chmod +x /etc/cron.daily/mailinabox-postgrey-whitelist
+/etc/cron.daily/mailinabox-postgrey-whitelist
 
 # Increase the message size limit from 10MB to 128MB.
 # The same limit is specified in nginx.conf for mail submitted via webmail and Z-Push.
-tools/editconf.py /etc/postfix/main.cf \
+management/editconf.py /etc/postfix/main.cf \
 	message_size_limit=134217728
 
+# Store default configurations for SMTP relays:
+management/editconf.py /etc/postfix/main.cf \
+	smtp_sasl_auth_enable=yes \
+	smtp_sasl_password_maps="hash:/etc/postfix/sasl_passwd" \
+	smtp_sasl_security_options=noanonymous \
+	smtp_sasl_tls_security_options=noanonymous \
+	smtp_tls_security_level=encrypt \
+	header_size_limit=4096000
+
+touch /etc/postfix/sasl_passwd
+chmod 600 /etc/postfix/sasl_passwd
+postmap /etc/postfix/sasl_passwd
+
 # Allow the two SMTP ports in the firewall.
 
 ufw_allow smtp
+ufw_allow smtps
 ufw_allow submission
 
 # Restart services

setup/mail-users.sh

@@ -20,10 +20,25 @@ db_path=$STORAGE_ROOT/mail/users.sqlite
 # Create an empty database if it doesn't yet exist.
 if [ ! -f $db_path ]; then
 	echo Creating new user database: $db_path;
-	echo "CREATE TABLE users (id INTEGER PRIMARY KEY AUTOINCREMENT, email TEXT NOT NULL UNIQUE, password TEXT NOT NULL, extra, privileges TEXT NOT NULL DEFAULT '');" | sqlite3 $db_path;
+	echo "CREATE TABLE users (id INTEGER PRIMARY KEY AUTOINCREMENT, email TEXT NOT NULL UNIQUE, password TEXT NOT NULL, extra, privileges TEXT NOT NULL DEFAULT '', quota TEXT NOT NULL DEFAULT '0');" | sqlite3 $db_path;
 	echo "CREATE TABLE aliases (id INTEGER PRIMARY KEY AUTOINCREMENT, source TEXT NOT NULL UNIQUE, destination TEXT NOT NULL, permitted_senders TEXT);" | sqlite3 $db_path;
+    echo "CREATE TABLE noreply (id INTEGER PRIMARY KEY AUTOINCREMENT, email TEXT NOT NULL UNIQUE);" | sqlite3 $db_path
+	echo "CREATE TABLE mfa (id INTEGER PRIMARY KEY AUTOINCREMENT, user_id INTEGER NOT NULL, type TEXT NOT NULL, secret TEXT NOT NULL, mru_token TEXT, label TEXT, FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE);" | sqlite3 $db_path;
+	echo "CREATE TABLE auto_aliases (id INTEGER PRIMARY KEY AUTOINCREMENT, source TEXT NOT NULL UNIQUE, destination TEXT NOT NULL, permitted_senders TEXT);" | sqlite3 $db_path;
+else
+    sql=$(sqlite3 $db_path "SELECT sql FROM sqlite_master WHERE name = 'users'");
+    if echo $sql | grep --invert-match quota; then
+        echo "ALTER TABLE users ADD COLUMN quota TEXT NOT NULL DEFAULT '0';" | sqlite3 $db_path;
+    fi
 fi
 
+# Recover the database if it was hit by the Roundcube password changer "bug" (#85)
+# If the journal_mode is set to wal, postfix cannot read it and we wouldn't
+# be able to send or receive mail.
+#
+# This operation is idempotent so it's safe to run even in healthy databases, too.
+echo "PRAGMA journal_mode=delete;" | sqlite3 $db_path > /dev/null
+
 # ### User Authentication
 
 # Have Dovecot query our database, and not system users, for authentication.
@@ -49,7 +64,7 @@ driver = sqlite
 connect = $db_path
 default_pass_scheme = SHA512-CRYPT
 password_query = SELECT email as user, password FROM users WHERE email='%u';
-user_query = SELECT email AS user, "mail" as uid, "mail" as gid, "$STORAGE_ROOT/mail/mailboxes/%d/%n" as home FROM users WHERE email='%u';
+user_query = SELECT email AS user, "mail" as uid, "mail" as gid, "$STORAGE_ROOT/mail/mailboxes/%d/%n" as home, '*:bytes=' || quota AS quota_rule FROM users WHERE email='%u';
 iterate_query = SELECT email AS user FROM users;
 EOF
 chmod 0600 /etc/dovecot/dovecot-sql.conf.ext # per Dovecot instructions
@@ -65,11 +80,15 @@ service auth {
 }
 EOF
 
-# And have Postfix use that service.
-tools/editconf.py /etc/postfix/main.cf \
+# And have Postfix use that service. We *disable* it here
+# so that authentication is not permitted on port 25 (which
+# does not run DKIM on relayed mail, so outbound mail isn't
+# correct, see #830), but we enable it specifically for the
+# submission port.
+management/editconf.py /etc/postfix/main.cf \
 	smtpd_sasl_type=dovecot \
 	smtpd_sasl_path=private/auth \
-	smtpd_sasl_auth_enable=yes
+	smtpd_sasl_auth_enable=no
 
 # ### Sender Validation
 
@@ -79,7 +98,7 @@ tools/editconf.py /etc/postfix/main.cf \
 # address (aka envelope or return path address) must be "owned" by the user
 # who authenticated. An SQL query will find who are the owners of any given
 # address.
-tools/editconf.py /etc/postfix/main.cf \
+management/editconf.py /etc/postfix/main.cf \
 	smtpd_sender_login_maps=sqlite:/etc/postfix/sender-login-maps.cf
 
 # Postfix will query the exact address first, where the priority will be alias
@@ -95,8 +114,12 @@ EOF
 # ### Destination Validation
 
 # Use a Sqlite3 database to check whether a destination email address exists,
-# and to perform any email alias rewrites in Postfix.
-tools/editconf.py /etc/postfix/main.cf \
+# and to perform any email alias rewrites in Postfix. Additionally, we disable
+# SMTPUTF8 because Dovecot's LMTP server that delivers mail to inboxes does
+# not support it, and if a message is received with the SMTPUTF8 flag it will
+# bounce.
+management/editconf.py /etc/postfix/main.cf \
+	smtputf8_enable=no \
 	virtual_mailbox_domains=sqlite:/etc/postfix/virtual-mailbox-domains.cf \
 	virtual_mailbox_maps=sqlite:/etc/postfix/virtual-mailbox-maps.cf \
 	virtual_alias_maps=sqlite:/etc/postfix/virtual-alias-maps.cf \
@@ -105,7 +128,7 @@ tools/editconf.py /etc/postfix/main.cf \
 # SQL statement to check if we handle incoming mail for a domain, either for users or aliases.
 cat > /etc/postfix/virtual-mailbox-domains.cf << EOF;
 dbpath=$db_path
-query = SELECT 1 FROM users WHERE email LIKE '%%@%s' UNION SELECT 1 FROM aliases WHERE source LIKE '%%@%s'
+query = SELECT 1 FROM users WHERE email LIKE '%%@%s' UNION SELECT 1 FROM aliases WHERE source LIKE '%%@%s' UNION SELECT 1 FROM auto_aliases WHERE source LIKE '%%@%s'
 EOF
 
 # SQL statement to check if we handle incoming mail for a user.
@@ -140,7 +163,13 @@ EOF
 # empty destination here so that other lower priority rules might match.
 cat > /etc/postfix/virtual-alias-maps.cf << EOF;
 dbpath=$db_path
-query = SELECT destination from (SELECT destination, 0 as priority FROM aliases WHERE source='%s' AND destination<>'' UNION SELECT email as destination, 1 as priority FROM users WHERE email='%s') ORDER BY priority LIMIT 1;
+query = SELECT destination from (SELECT destination, 0 as priority FROM aliases WHERE source='%s' AND destination<>'' UNION SELECT email as destination, 1 as priority FROM users WHERE email='%s' UNION SELECT destination, 2 as priority FROM auto_aliases WHERE source='%s' AND destination<>'') ORDER BY priority LIMIT 1;
+EOF
+
+# SQL statement to check if we're sending to a noreply address.
+cat > /etc/postfix/noreply-addresses.cf << EOF;
+dbpath=$db_path
+query = SELECT 'REJECT This address is not ready to receive email.' FROM noreply WHERE email='%s'
 EOF
 
 # Restart Services
@@ -149,4 +178,5 @@ EOF
 restart_service postfix
 restart_service dovecot
 
-
+# force a recalculation of all user quotas
+doveadm quota recalc -A

setup/management.sh

@@ -1,57 +1,67 @@
 #!/bin/bash
 
 source setup/functions.sh
+source /etc/mailinabox.conf # load global vars
 
 echo "Installing Mail-in-a-Box system management daemon..."
 
 # DEPENDENCIES
 
-# Install Python packages that are available from the Ubuntu
-# apt repository:
-# flask, yaml, dnspython, and dateutil are all for our Python 3 management daemon itself.
-# duplicity does backups. python-pip is so we can 'pip install boto' for Python 2, for duplicity, so it can do backups to AWS S3.
-apt_install python3-flask links duplicity libyaml-dev python3-dnspython python3-dateutil python-pip
-
-# These are required to pip install cryptography.
-apt_install build-essential libssl-dev libffi-dev python3-dev
-
-# pip<6.1 + setuptools>=34 have a problem with packages that
-# try to update setuptools during installation, like cryptography.
-# See https://github.com/pypa/pip/issues/4253. The Ubuntu 14.04
-# package versions are pip 1.5.4 and setuptools 3.3. When we
-# install cryptography under those versions, it tries to update
-# setuptools to version 34, which now creates the conflict, and
-# then pip gets permanently broken with errors like
-# "ImportError: No module named 'packaging'".
+# virtualenv is used to isolate the Python 3 packages we
+# install via pip from the system-installed packages.
 #
-# Let's test for the error:
-if ! python3 -c "from pkg_resources import load_entry_point" 2&> /dev/null; then
-	# This system seems to be broken already.
-	echo "Fixing broken pip and setuptools..."
-	rm -rf /usr/local/lib/python3.4/dist-packages/{pkg_resources,setuptools}*
-	apt-get install --reinstall python3-setuptools python3-pip python3-pkg-resources
+# certbot installs EFF's certbot which we use to
+# provision free TLS certificates.
+#
+# gcc and build tools are required to install the latest version
+# of duplicity
+apt_install python3-pip python3-gpg virtualenv certbot rsync librsync2 python3-fasteners python3-future python3-lockfile \
+			gcc python3-dev librsync-dev gettext
+
+apt_get_quiet remove --autoremove --purge duplicity || /bin/true
+
+# Duplicity does the actual backups.
+# b2sdk is used for backblaze backups.
+# boto3 is used for amazon aws backups.
+# Both are installed outside the pipenv, so they can be used by duplicity
+hide_output pip3 install --upgrade b2sdk boto3 duplicity
+
+# Create a virtualenv for the installation of Python 3 packages
+# used by the management daemon.
+inst_dir=/usr/local/lib/mailinabox
+mkdir -p $inst_dir
+venv=$inst_dir/env
+if [ ! -d $venv ]; then
+	hide_output virtualenv -ppython3 $venv
+elif [ ! -f $venv/.oscode ]; then
+	echo "Re-creating Python environment..."
+	rm -rf $venv
+	hide_output virtualenv -ppython3 $venv
+elif [ "$(cat $venv/.oscode)" != $(get_os_code) ]; then
+	echo "Existing management environment is from an earlier version of the OS you're running."
+	echo "Re-creating Python environment..."
+	rm -rf $venv
+	hide_output virtualenv -ppython3 $venv
 fi
-#
-# The easiest work-around on systems that aren't already broken is
-# to upgrade pip (to >=9.0.1) and setuptools (to >=34.1) individually
-# before we install any package that tries to update setuptools.
-hide_output pip3 install --upgrade pip
-hide_output pip3 install --upgrade setuptools
+
+# Upgrade pip because the Ubuntu-packaged version is out of date.
+hide_output $venv/bin/pip install --upgrade pip
 
 # Install other Python 3 packages used by the management daemon.
 # The first line is the packages that Josh maintains himself!
 # NOTE: email_validator is repeated in setup/questions.sh, so please keep the versions synced.
-# Force acme to be updated because it seems to need it after the
-# pip/setuptools breakage (see above) and the ACME protocol may
-# have changed (I got an error on one of my systems).
-hide_output pip3 install --upgrade \
-	rtyaml "email_validator>=1.0.0" "free_tls_certificates>=0.1.3" "exclusiveprocess" \
-	"idna>=2.0.0" "cryptography>=1.0.2" acme boto psutil
+hide_output $venv/bin/pip install --upgrade \
+	rtyaml "email_validator>=1.0.0" "exclusiveprocess" \
+	flask dnspython python-dateutil expiringdict gunicorn \
+	qrcode[pil] pyotp \
+	"idna>=2.0.0" "cryptography==2.2.2" boto psutil postfix-mta-sts-resolver boto3 b2sdk
 
-# duplicity uses python 2 so we need to get the python 2 package of boto to have backups to S3.
-# boto from the Ubuntu package manager is too out-of-date -- it doesn't support the newer
-# S3 api used in some regions, which breaks backups to those regions.  See #627, #653.
-hide_output pip2 install --upgrade boto
+# Make the venv use the packaged gpgme bindings (the ones pip provides are severely out-of-date)
+if [ ! -d $venv/lib/python$(python_version)/site-packages/gpg/ ]; then
+	ln -s /usr/lib/python3/dist-packages/gpg/ $venv/lib/python$(python_version)/site-packages/
+fi
+
+echo $(get_os_code) > $venv/.oscode
 
 # CONFIGURATION
 
@@ -65,49 +75,86 @@ fi
 # Download jQuery and Bootstrap local files
 
 # Make sure we have the directory to save to.
-assets_dir=/usr/local/lib/mailinabox/vendor/assets
+assets_dir=$inst_dir/vendor/assets
 rm -rf $assets_dir
 mkdir -p $assets_dir
 
 # jQuery CDN URL
-jquery_version=2.1.4
-jquery_url=https://code.jquery.com
+jquery_version=3.6.1
+jquery_url=https://code.jquery.com # Check this link for new versions
 
 # Get jQuery
-wget_verify $jquery_url/jquery-$jquery_version.min.js 43dc554608df885a59ddeece1598c6ace434d747 $assets_dir/jquery.min.js
+wget_verify $jquery_url/jquery-$jquery_version.min.js ea61688671d0c3044f2c5b2f2c4af0a6620ac6c2 $assets_dir/jquery.min.js
 
 # Bootstrap CDN URL
-bootstrap_version=3.3.7
+# See https://github.com/twbs/bootstrap/releases to check for new versions
+bootstrap_version=5.2.2
 bootstrap_url=https://github.com/twbs/bootstrap/releases/download/v$bootstrap_version/bootstrap-$bootstrap_version-dist.zip
 
 # Get Bootstrap
-wget_verify $bootstrap_url e6b1000b94e835ffd37f4c6dcbdad43f4b48a02a /tmp/bootstrap.zip
-unzip -q /tmp/bootstrap.zip -d /usr/local/lib/mailinabox/vendor/assets
-mv /usr/local/lib/mailinabox/vendor/assets/bootstrap-$bootstrap_version-dist /usr/local/lib/mailinabox/vendor/assets/bootstrap
+wget_verify $bootstrap_url 740b34c22cef5c2f12a34f084b813ea308fedf74 /tmp/bootstrap.zip
+unzip -q /tmp/bootstrap.zip -d $assets_dir
+mv $assets_dir/bootstrap-$bootstrap_version-dist $assets_dir/bootstrap
 rm -f /tmp/bootstrap.zip
 
-# Link the management server daemon into a well known location.
-rm -f /usr/local/bin/mailinabox-daemon
-ln -s `pwd`/management/daemon.py /usr/local/bin/mailinabox-daemon
+# FontAwesome CDN URL
+# See https://github.com/FortAwesome/Font-Awesome/releases to check for new versions
+fontawesome_version=6.2.1
+fontawesome_url=https://github.com/FortAwesome/Font-Awesome/releases/download/$fontawesome_version/fontawesome-free-$fontawesome_version-web.zip
+
+# Get FontAwesome
+wget_verify $fontawesome_url cd0f2bcc9653b56e3e2dd82d6598aa6bbca8d796 /tmp/fontawesome.zip
+unzip -q /tmp/fontawesome.zip -d $assets_dir
+mv $assets_dir/fontawesome-free-$fontawesome_version-web $assets_dir/fontawesome
+rm -f /tmp/fontawesome.zip
 
 # Create an init script to start the management daemon and keep it
 # running after a reboot.
-rm -f /etc/init.d/mailinabox
-ln -s $(pwd)/conf/management-initscript /etc/init.d/mailinabox
-hide_output update-rc.d mailinabox defaults
+# Set a long timeout since some commands take a while to run, matching
+# the timeout we set for PHP (fastcgi_read_timeout in the nginx confs).
+# Note: Authentication currently breaks with more than 1 gunicorn worker.
+cat > $inst_dir/start <<EOF;
+#!/bin/bash
+# Set character encoding flags to ensure that any non-ASCII don't cause problems.
+export LANGUAGE=en_US.UTF-8
+export LC_ALL=en_US.UTF-8
+export LANG=en_US.UTF-8
+export LC_TYPE=en_US.UTF-8
 
-# Remove old files we no longer use.
-rm -f /etc/cron.daily/mailinabox-backup
-rm -f /etc/cron.daily/mailinabox-statuschecks
+mkdir -p /var/lib/mailinabox
+tr -cd '[:xdigit:]' < /dev/urandom | head -c 32 > /var/lib/mailinabox/api.key
+chmod 640 /var/lib/mailinabox/api.key
+
+source $venv/bin/activate
+export PYTHONPATH=$(pwd)/management
+exec gunicorn -b localhost:10222 -w 1 --timeout 630 wsgi:app
+EOF
+chmod +x $inst_dir/start
+cp --remove-destination conf/mailinabox.service /lib/systemd/system/mailinabox.service # target was previously a symlink so remove it first
+hide_output systemctl link -f /lib/systemd/system/mailinabox.service
+hide_output systemctl daemon-reload
+hide_output systemctl enable mailinabox.service
 
 # Perform nightly tasks at 3am in system time: take a backup, run
 # status checks and email the administrator any changes.
 
+minute=$((RANDOM % 60))  # avoid overloading mailinabox.email
 cat > /etc/cron.d/mailinabox-nightly << EOF;
 # Mail-in-a-Box --- Do not edit / will be overwritten on update.
 # Run nightly tasks: backup, status checks.
-0 3 * * *	root	(cd `pwd` && management/daily_tasks.sh)
+$minute 3 * * *	root	(cd $(pwd) && management/daily_tasks.sh)
 EOF
 
 # Start the management server.
 restart_service mailinabox
+
+# FOR DEVELOPMENT PURPOSES ONLY:
+# If there is a CA certificate in the folder, install it.
+# MIAB will only accept a manual certificate installation
+# if it is signed by a CA trusted by it.
+if [[ -f mailinabox-ca.crt ]]; then
+    echo "Custom CA certificate detected. Installing..."
+    rm -f /usr/local/share/ca-certificates/mailinabox-ca.crt
+    cp mailinabox-ca.crt /usr/local/share/ca-certificates/
+    hide_output update-ca-certificates --fresh
+fi

setup/migrate.py

@@ -137,6 +137,67 @@ def migration_10(env):
 				shutil.move(sslcert, newname)
 				os.rmdir(d)
 
+def migration_11(env):
+	# Archive the old Let's Encrypt account directory managed by free_tls_certificates
+	# because we'll use that path now for the directory managed by certbot.
+	try:
+		old_path = os.path.join(env["STORAGE_ROOT"], 'ssl', 'lets_encrypt')
+		new_path = os.path.join(env["STORAGE_ROOT"], 'ssl', 'lets_encrypt-old')
+		shutil.move(old_path, new_path)
+	except:
+		# meh
+		pass
+
+def migration_12(env):
+	# Upgrading to Carddav Roundcube plugin to version 3+, it requires the carddav_*
+        # tables to be dropped.
+        # Checking that the roundcube database already exists.
+        if os.path.exists(os.path.join(env["STORAGE_ROOT"], "mail/roundcube/roundcube.sqlite")):
+            import sqlite3
+            conn = sqlite3.connect(os.path.join(env["STORAGE_ROOT"], "mail/roundcube/roundcube.sqlite"))
+            c = conn.cursor()
+            # Get a list of all the tables that begin with 'carddav_'
+            c.execute("SELECT name FROM sqlite_master WHERE type = ? AND name LIKE ?", ('table', 'carddav_%'))
+            carddav_tables = c.fetchall()
+            # If there were tables that begin with 'carddav_', drop them
+            if carddav_tables:
+                for table in carddav_tables:
+                    try:
+                        table = table[0]
+                        c = conn.cursor()
+                        dropcmd = "DROP TABLE %s" % table
+                        c.execute(dropcmd)
+                    except:
+                        print("Failed to drop table", table, e)
+            # Save.
+            conn.commit()
+            conn.close()
+
+            # Delete all sessions, requring users to login again to recreate carddav_*
+            # databases
+            conn = sqlite3.connect(os.path.join(env["STORAGE_ROOT"], "mail/roundcube/roundcube.sqlite"))
+            c = conn.cursor()
+            c.execute("delete from session;")
+            conn.commit()
+            conn.close()
+
+def migration_13(env):
+	# Add the "mfa" table for configuring MFA for login to the control panel.
+	db = os.path.join(env["STORAGE_ROOT"], 'mail/users.sqlite')
+	shell("check_call", ["sqlite3", db, "CREATE TABLE mfa (id INTEGER PRIMARY KEY AUTOINCREMENT, user_id INTEGER NOT NULL, type TEXT NOT NULL, secret TEXT NOT NULL, mru_token TEXT, label TEXT, FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE);"])
+
+def migration_14(env):
+	# Add the "noreply" table for noreply addresses.
+	db = os.path.join(env["STORAGE_ROOT"], 'mail/users.sqlite')
+	shell("check_call", ["sqlite3", db, "CREATE TABLE noreply (id INTEGER PRIMARY KEY AUTOINCREMENT, email TEXT NOT NULL UNIQUE);"])
+
+def migration_15(env):
+	# Add the "auto_aliases" table.
+	db = os.path.join(env["STORAGE_ROOT"], 'mail/users.sqlite')
+	shell("check_call", ["sqlite3", db, "CREATE TABLE auto_aliases (id INTEGER PRIMARY KEY AUTOINCREMENT, source TEXT NOT NULL UNIQUE, destination TEXT NOT NULL, permitted_senders TEXT);"])
+
+###########################################################
+
 def get_current_migration():
 	ver = 0
 	while True:

setup/munin.sh

@@ -29,7 +29,7 @@ address 127.0.0.1
 
 # send alerts to the following address
 contacts admin
-contact.admin.command mail -s "Munin notification ${var:host}" administrator@$PRIMARY_HOSTNAME
+contact.admin.command mail -s "Munin notification \${var:host}" administrator@$PRIMARY_HOSTNAME
 contact.admin.always_send warning critical
 EOF
 
@@ -38,11 +38,13 @@ chown munin. /var/log/munin/munin-cgi-html.log
 chown munin. /var/log/munin/munin-cgi-graph.log
 
 # ensure munin-node knows the name of this machine
-tools/editconf.py /etc/munin/munin-node.conf -s \
-	host_name=$PRIMARY_HOSTNAME
+# and reduce logging level to warning
+management/editconf.py /etc/munin/munin-node.conf -s \
+	host_name=$PRIMARY_HOSTNAME \
+	log_level=1
 
 # Update the activated plugins through munin's autoconfiguration.
-munin-node-configure --shell --remove-also 2>/dev/null | sh
+munin-node-configure --shell --remove-also 2>/dev/null | sh || /bin/true
 
 # Deactivate monitoring of NTP peers. Not sure why anyone would want to monitor a NTP peer. The addresses seem to change
 # (which is taken care of my munin-node-configure, but only when we re-run it.)
@@ -51,7 +53,7 @@ find /etc/munin/plugins/ -lname /usr/share/munin/plugins/ntp_ -print0 | xargs -0
 # Deactivate monitoring of network interfaces that are not up. Otherwise we can get a lot of empty charts.
 for f in $(find /etc/munin/plugins/ \( -lname /usr/share/munin/plugins/if_ -o -lname /usr/share/munin/plugins/if_err_ -o -lname /usr/share/munin/plugins/bonding_err_ \)); do
 	IF=$(echo $f | sed s/.*_//);
-	if ! ifquery $IF >/dev/null 2>/dev/null; then
+	if ! grep -qFx up /sys/class/net/$IF/operstate 2>/dev/null; then
 		rm $f;
 	fi;
 done
@@ -59,6 +61,15 @@ done
 # Create a 'state' directory. Not sure why we need to do this manually.
 mkdir -p /var/lib/munin-node/plugin-state/
 
+# Create a systemd service for munin.
+ln -sf $(pwd)/management/munin_start.sh /usr/local/lib/mailinabox/munin_start.sh
+chmod 0744 /usr/local/lib/mailinabox/munin_start.sh
+cp --remove-destination conf/munin.service /lib/systemd/system/munin.service # target was previously a symlink so remove first
+hide_output systemctl link -f /lib/systemd/system/munin.service
+hide_output systemctl daemon-reload
+hide_output systemctl unmask munin.service
+hide_output systemctl enable munin.service
+
 # Restart services.
 restart_service munin
 restart_service munin-node
@@ -66,4 +77,8 @@ restart_service munin-node
 # generate initial statistics so the directory isn't empty
 # (We get "Pango-WARNING **: error opening config file '/root/.config/pango/pangorc': Permission denied"
 # if we don't explicitly set the HOME directory when sudo'ing.)
-sudo -H -u munin munin-cron
+# We check to see if munin-cron is already running, if it is, there is no need to run it simultaneously
+# generating an error.
+if [ ! -f /var/run/munin/munin-update.lock ]; then
+	sudo -H -u munin munin-cron
+fi

setup/nextcloud.sh

@@ -0,0 +1,464 @@
+#!/bin/bash
+# Nextcloud
+##########################
+
+source setup/functions.sh # load our functions
+source /etc/mailinabox.conf # load global vars
+
+# ### Installing Nextcloud
+
+echo "Installing Nextcloud (contacts/calendar)..."
+
+# Nextcloud core and app (plugin) versions to install.
+# With each version we store a hash to ensure we install what we expect.
+
+# Nextcloud core
+# --------------
+# * See https://nextcloud.com/changelog for the latest version.
+# * Check https://docs.nextcloud.com/server/latest/admin_manual/installation/system_requirements.html
+#   for whether it supports the version of PHP available on this machine.
+# * Since Nextcloud only supports upgrades from consecutive major versions,
+#   we automatically install intermediate versions as needed.
+# * The hash is the SHA1 hash of the ZIP package, which you can find by just running this script and
+#   copying it from the error message when it doesn't match what is below.
+nextcloud_ver=24.0.7
+nextcloud_hash=7fb1afeb3c212bf5530c3d234b23bf314b47655a
+
+# Nextcloud apps
+# --------------
+# * Find the most recent tag that is compatible with the Nextcloud version above by
+#   consulting the <dependencies>...<nextcloud> node at:
+#   https://github.com/nextcloud-releases/contacts/blob/master/appinfo/info.xml
+#   https://github.com/nextcloud-releases/calendar/blob/master/appinfo/info.xml
+#   https://github.com/nextcloud-releases/user_external
+# * The hash is the SHA1 hash of the ZIP package, which you can find by just running this script and
+#   copying it from the error message when it doesn't match what is below.
+contacts_ver=4.2.2
+contacts_hash=cbab9a7acdc11a9e2779c20b850bb21faec1c80f
+calendar_ver=3.5.2
+calendar_hash=dcf2cba6933dc8805ca4b4d04ed7b993ff4652a1
+user_external_ver=3.0.0
+user_external_hash=0df781b261f55bbde73d8c92da3f99397000972f
+
+# Clear prior packages and install dependencies from apt.
+
+# Just in case someone tries to cross over from the upstream version.
+apt-get purge -qq -y owncloud* 2> /dev/null || /bin/true
+
+apt_install php php-fpm \
+	php-cli php-sqlite3 php-gd php-imap php-curl php-pear curl \
+	php-dev php-xml php-mbstring php-zip php-apcu php-json \
+	php-intl php-imagick php-gmp php-bcmath
+
+phpenmod apcu
+
+management/editconf.py /etc/php/$(php_version)/mods-available/apcu.ini -c ';' \
+	apc.enabled=1 \
+	apc.enable_cli=1
+
+management/editconf.py /etc/php/$(php_version)/cli/php.ini -c ';' \
+	apc.enable_cli=1
+
+InstallNextcloud() {
+
+	version=$1
+	hash=$2
+	version_contacts=$3
+	hash_contacts=$4
+	version_calendar=$5
+	hash_calendar=$6
+	version_user_external=${7:-}
+	hash_user_external=${8:-}
+
+	echo
+	echo "Upgrading to Nextcloud version $version"
+	echo
+
+	# Download and verify
+	wget_verify https://download.nextcloud.com/server/releases/nextcloud-$version.zip $hash /tmp/nextcloud.zip
+
+	# Remove the current owncloud/Nextcloud
+	rm -rf /usr/local/lib/owncloud
+
+	# Extract ownCloud/Nextcloud
+	unzip -q /tmp/nextcloud.zip -d /usr/local/lib
+	mv /usr/local/lib/nextcloud /usr/local/lib/owncloud
+	rm -f /tmp/nextcloud.zip
+
+	# The two apps we actually want are not in Nextcloud core. Download the releases from
+	# their github repositories.
+	mkdir -p /usr/local/lib/owncloud/apps
+
+	IFS='.'
+	read -a checkVer <<< "$version_contacts"
+	unset IFS
+	if [ "${checkVer[0]}" -gt 4 ] || [ "${checkVer[0]}" -eq 4 -a "${checkVer[1]}" -gt 0 ] || [ "${checkVer[0]}" -eq 4 -a "${checkVer[2]}" -gt 0 ]; then
+		# Contacts 4.0.1 and later are downloaded from here
+		wget_verify https://github.com/nextcloud-releases/contacts/releases/download/v$version_contacts/contacts-v$version_contacts.tar.gz $hash_contacts /tmp/contacts.tgz
+	else
+		# 4.0.0 and earlier are downloaded from here
+		wget_verify https://github.com/Nextcloud/contacts/releases/download/v$version_contacts/contacts.tar.gz $hash_contacts /tmp/contacts.tgz
+	fi
+	tar xf /tmp/contacts.tgz -C /usr/local/lib/owncloud/apps/
+	rm /tmp/contacts.tgz
+
+	IFS='.'
+	read -a checkVer <<< "$version_calendar"
+	unset IFS
+	if [ "${checkVer[0]}" -eq 2 -a "${checkVer[1]}" -gt 2 ] || [ "${checkVer[0]}" -gt 2 ]; then
+		# Calendar 2.3.0 and later are downloaded from here
+		wget_verify https://github.com/nextcloud-releases/calendar/releases/download/v$version_calendar/calendar-v$version_calendar.tar.gz $hash_calendar /tmp/calendar.tgz
+	else
+		wget_verify https://github.com/nextcloud/calendar/releases/download/v$version_calendar/calendar.tar.gz $hash_calendar /tmp/calendar.tgz
+	fi
+	tar xf /tmp/calendar.tgz -C /usr/local/lib/owncloud/apps/
+	rm /tmp/calendar.tgz
+
+	# Starting with Nextcloud 15, the app user_external is no longer included in Nextcloud core,
+	# we will install from their github repository.
+	if [ -n "$version_user_external" ]; then
+		IFS='.'
+		read -a checkVer <<< "$version_user_external"
+		unset IFS
+		if [ "${checkVer[0]}" -gt 2 ]; then
+			wget_verify https://github.com/nextcloud-releases/user_external/releases/download/v$version_user_external/user_external-v$version_user_external.tar.gz $hash_user_external /tmp/user_external.tgz
+		else
+			wget_verify https://github.com/nextcloud/user_external/releases/download/v$version_user_external/user_external-$version_user_external.tar.gz $hash_user_external /tmp/user_external.tgz
+		fi
+		tar -xf /tmp/user_external.tgz -C /usr/local/lib/owncloud/apps/
+		rm /tmp/user_external.tgz
+	fi
+
+	# Fix weird permissions.
+	chmod 750 /usr/local/lib/owncloud/{apps,config}
+
+	# Create a symlink to the config.php in STORAGE_ROOT (for upgrades we're restoring the symlink we previously
+	# put in, and in new installs we're creating a symlink and will create the actual config later).
+	ln -sf $STORAGE_ROOT/owncloud/config.php /usr/local/lib/owncloud/config/config.php
+
+	# Make sure permissions are correct or the upgrade step won't run.
+	# $STORAGE_ROOT/owncloud may not yet exist, so use -f to suppress
+	# that error.
+	chown -f -R www-data.www-data $STORAGE_ROOT/owncloud /usr/local/lib/owncloud || /bin/true
+
+	# If this isn't a new installation, immediately run the upgrade script.
+	# Then check for success (0=ok and 3=no upgrade needed, both are success).
+	if [ -e $STORAGE_ROOT/owncloud/owncloud.db ]; then
+		# ownCloud 8.1.1 broke upgrades. It may fail on the first attempt, but
+		# that can be OK.
+		sudo -u www-data php /usr/local/lib/owncloud/occ upgrade
+		if [ \( $? -ne 0 \) -a \( $? -ne 3 \) ]; then
+			echo "Trying ownCloud upgrade again to work around ownCloud upgrade bug..."
+			sudo -u www-data php /usr/local/lib/owncloud/occ upgrade
+			if [ \( $? -ne 0 \) -a \( $? -ne 3 \) ]; then exit 1; fi
+			sudo -u www-data php /usr/local/lib/owncloud/occ maintenance:mode --off
+			echo "...which seemed to work."
+		fi
+
+		# Add missing indices. NextCloud didn't include this in the normal upgrade because it might take some time.
+		sudo -u www-data php /usr/local/lib/owncloud/occ db:add-missing-indices
+
+		# Run conversion to BigInt identifiers, this process may take some time on large tables.
+		sudo -u www-data php /usr/local/lib/owncloud/occ db:convert-filecache-bigint --no-interaction
+	fi
+}
+
+# Current Nextcloud Version, #1623
+# Checking /usr/local/lib/owncloud/version.php shows version of the Nextcloud application, not the DB
+# $STORAGE_ROOT/owncloud is kept together even during a backup.  It is better to rely on config.php than
+# version.php since the restore procedure can leave the system in a state where you have a newer Nextcloud
+# application version than the database.
+# If config.php exists, get version number, otherwise CURRENT_NEXTCLOUD_VER is empty.
+#
+# Config unlocking, power-mailinabox#86
+# If a configuration file already exists, remove the "readonly" tag before starting the upgrade. This is
+# necessary (otherwise upgrades will fail).
+#
+# The lock will be re-applied further down the line when it's safe to do so.
+CONFIG_TEMP=$(/bin/mktemp)
+if [ -f "$STORAGE_ROOT/owncloud/config.php" ]; then
+	CURRENT_NEXTCLOUD_VER=$(php -r "include(\"$STORAGE_ROOT/owncloud/config.php\"); echo(\$CONFIG['version']);")
+	# Unlock configuration directory for upgrades
+	php <<EOF > $CONFIG_TEMP && mv $CONFIG_TEMP $STORAGE_ROOT/owncloud/config.php;
+<?php
+include("$STORAGE_ROOT/owncloud/config.php");
+
+\$CONFIG['config_is_read_only'] = false;
+
+echo "<?php\n\\\$CONFIG = ";
+var_export(\$CONFIG);
+echo ";";
+?>
+EOF
+else
+	CURRENT_NEXTCLOUD_VER=""
+fi
+
+# If the Nextcloud directory is missing (never been installed before, or the nextcloud version to be installed is different
+# from the version currently installed, do the install/upgrade
+if [ ! -d /usr/local/lib/owncloud/ ] || [[ ! ${CURRENT_NEXTCLOUD_VER} =~ ^$nextcloud_ver ]]; then
+
+	# Stop php-fpm if running. If theyre not running (which happens on a previously failed install), dont bail.
+	service php$(php_version)-fpm stop &> /dev/null || /bin/true
+
+	# Backup the existing ownCloud/Nextcloud.
+	# Create a backup directory to store the current installation and database to
+	BACKUP_DIRECTORY=$STORAGE_ROOT/owncloud-backup/$(date +"%Y-%m-%d-%T")
+	mkdir -p "$BACKUP_DIRECTORY"
+	if [ -d /usr/local/lib/owncloud/ ]; then
+		echo "Upgrading Nextcloud --- backing up existing installation, configuration, and database to directory to $BACKUP_DIRECTORY..."
+		cp -r /usr/local/lib/owncloud "$BACKUP_DIRECTORY/owncloud-install"
+	fi
+	if [ -e $STORAGE_ROOT/owncloud/owncloud.db ]; then
+		cp $STORAGE_ROOT/owncloud/owncloud.db $BACKUP_DIRECTORY
+	fi
+	if [ -e $STORAGE_ROOT/owncloud/config.php ]; then
+		cp $STORAGE_ROOT/owncloud/config.php $BACKUP_DIRECTORY
+	fi
+
+	# If ownCloud or Nextcloud was previously installed....
+	if [ ! -z ${CURRENT_NEXTCLOUD_VER} ]; then
+		# Database migrations from ownCloud are no longer possible because ownCloud cannot be run under
+		# PHP 7.
+		if [[ ${CURRENT_NEXTCLOUD_VER} =~ ^[89] ]]; then
+			echo "Upgrades from Mail-in-a-Box prior to v0.28 (dated July 30, 2018) with Nextcloud < 13.0.6 (you have ownCloud 8 or 9) are not supported. Upgrade to Mail-in-a-Box version v0.30 first. Setup will continue, but skip the Nextcloud migration."
+			return 0
+		elif [[ ${CURRENT_NEXTCLOUD_VER} =~ ^1[012] ]]; then
+			echo "Upgrades from Mail-in-a-Box prior to v0.28 (dated July 30, 2018) with Nextcloud < 13.0.6 (you have ownCloud 10, 11 or 12) are not supported. Upgrade to Mail-in-a-Box version v0.30 first. Setup will continue, but skip the Nextcloud migration."
+			return 0
+		elif [[ ${CURRENT_NEXTCLOUD_VER} =~ ^13 ]]; then
+			# If we are running Nextcloud 13, upgrade to Nextcloud 14
+			InstallNextcloud 14.0.6 4e43a57340f04c2da306c8eea98e30040399ae5a 3.3.0 e55d0357c6785d3b1f3b5f21780cb6d41d32443a 2.0.3 9d9717b29337613b72c74e9914c69b74b346c466
+			CURRENT_NEXTCLOUD_VER="14.0.6"
+		fi
+		if [[ ${CURRENT_NEXTCLOUD_VER} =~ ^14 ]]; then
+			# During the upgrade from Nextcloud 14 to 15, user_external may cause the upgrade to fail.
+			# We will disable it here before the upgrade and install it again after the upgrade.
+			hide_output sudo -u www-data php /usr/local/lib/owncloud/console.php app:disable user_external
+			InstallNextcloud 15.0.8 4129d8d4021c435f2e86876225fb7f15adf764a3 3.3.0 e55d0357c6785d3b1f3b5f21780cb6d41d32443a 2.0.3 9d9717b29337613b72c74e9914c69b74b346c466 0.7.0 555a94811daaf5bdd336c5e48a78aa8567b86437
+			CURRENT_NEXTCLOUD_VER="15.0.8"
+		fi
+		if [[ ${CURRENT_NEXTCLOUD_VER} =~ ^15 ]]; then
+			InstallNextcloud 16.0.6 0bb3098455ec89f5af77a652aad553ad40a88819 3.3.0 e55d0357c6785d3b1f3b5f21780cb6d41d32443a 2.0.3 9d9717b29337613b72c74e9914c69b74b346c466 0.7.0 555a94811daaf5bdd336c5e48a78aa8567b86437
+			CURRENT_NEXTCLOUD_VER="16.0.6"
+		fi
+		if [[ ${CURRENT_NEXTCLOUD_VER} =~ ^16 ]]; then
+			InstallNextcloud 17.0.6 50b98d2c2f18510b9530e558ced9ab51eb4f11b0 3.3.0 e55d0357c6785d3b1f3b5f21780cb6d41d32443a 2.0.3 9d9717b29337613b72c74e9914c69b74b346c466 0.7.0 555a94811daaf5bdd336c5e48a78aa8567b86437
+			CURRENT_NEXTCLOUD_VER="17.0.6"
+		fi
+		if [[ ${CURRENT_NEXTCLOUD_VER} =~ ^17 ]]; then
+			# Don't exit the install if this column already exists (see #2076)
+			(echo "ALTER TABLE oc_flow_operations ADD COLUMN entity VARCHAR;" | sqlite3 $STORAGE_ROOT/owncloud/owncloud.db 2>/dev/null) || true
+			InstallNextcloud 18.0.10 39c0021a8b8477c3f1733fddefacfa5ebf921c68 3.4.1 aee680a75e95f26d9285efd3c1e25cf7f3bfd27e 2.0.3 9d9717b29337613b72c74e9914c69b74b346c466 1.0.0 3bf2609061d7214e7f0f69dd8883e55c4ec8f50a
+			CURRENT_NEXTCLOUD_VER="18.0.10"
+		fi
+		if [[ ${CURRENT_NEXTCLOUD_VER} =~ ^18 ]]; then
+			InstallNextcloud 19.0.4 01e98791ba12f4860d3d4047b9803f97a1b55c60 3.4.1 aee680a75e95f26d9285efd3c1e25cf7f3bfd27e 2.0.3 9d9717b29337613b72c74e9914c69b74b346c466 1.0.0 3bf2609061d7214e7f0f69dd8883e55c4ec8f50a
+			CURRENT_NEXTCLOUD_VER="19.0.4"
+		fi
+		if [[ ${CURRENT_NEXTCLOUD_VER} =~ ^19 ]]; then
+			InstallNextcloud 20.0.14 92cac708915f51ee2afc1787fd845476fd090c81 4.0.8 9f368bb2be98c5555b7118648f4cc9fa51e8cb30 3.0.6 ca49bb1ce23f20e10911e39055fd59d7f7a84c30 1.0.0 3bf2609061d7214e7f0f69dd8883e55c4ec8f50a
+			# Nextcloud 20 needs to have some optional columns added
+			sudo -u www-data php /usr/local/lib/owncloud/occ db:add-missing-columns
+
+			CURRENT_NEXTCLOUD_VER="20.0.14"
+		fi
+		if [[ ${CURRENT_NEXTCLOUD_VER} =~ ^20 ]]; then
+			InstallNextcloud 21.0.9 cf8785107c3c079a1f450743558f4f13c85f37a8 4.1.0 38653b507bd7d953816bbc5e8bea7855867eb1cd 3.2.2 54e9a836adc739be4a2a9301b8d6d2e9d88e02f4 2.1.0 6e5afe7f36f398f864bfdce9cad72200e70322aa
+			CURRENT_NEXTCLOUD_VER="21.0.9"
+		fi
+		if [[ ${CURRENT_NEXTCLOUD_VER} =~ ^21 ]]; then
+			InstallNextcloud 22.2.6 9d39741f051a8da42ff7df46ceef2653a1dc70d9 4.1.0 38653b507bd7d953816bbc5e8bea7855867eb1cd 3.2.2 54e9a836adc739be4a2a9301b8d6d2e9d88e02f4 3.0.0 0df781b261f55bbde73d8c92da3f99397000972f
+			CURRENT_NEXTCLOUD_VER="22.2.6"
+		fi
+		if [[ ${CURRENT_NEXTCLOUD_VER} =~ ^22 ]]; then
+			InstallNextcloud 23.0.4 87afec0bf90b3c66289e6fedd851867bc5a58f01 4.1.0 38653b507bd7d953816bbc5e8bea7855867eb1cd 3.2.2 54e9a836adc739be4a2a9301b8d6d2e9d88e02f4 3.0.0 0df781b261f55bbde73d8c92da3f99397000972f
+			CURRENT_NEXTCLOUD_VER="23.0.4"
+		fi
+	fi
+
+	InstallNextcloud $nextcloud_ver $nextcloud_hash $contacts_ver $contacts_hash $calendar_ver $calendar_hash $user_external_ver $user_external_hash
+fi
+
+# ### Configuring Nextcloud
+
+# Setup Nextcloud if the Nextcloud database does not yet exist. Running setup when
+# the database does exist wipes the database and user data.
+if [ ! -f $STORAGE_ROOT/owncloud/owncloud.db ]; then
+	# Create user data directory
+	mkdir -p $STORAGE_ROOT/owncloud
+
+	# Create an initial configuration file.
+	instanceid=oc$(echo $PRIMARY_HOSTNAME | sha1sum | fold -w 10 | head -n 1)
+	cat > $STORAGE_ROOT/owncloud/config.php <<EOF;
+<?php
+\$CONFIG = array (
+  'datadirectory' => '$STORAGE_ROOT/owncloud',
+
+  'instanceid' => '$instanceid',
+
+  'forcessl' => true, # if unset/false, Nextcloud sends a HSTS=0 header, which conflicts with nginx config
+
+  'overwritewebroot' => '/cloud',
+  'overwrite.cli.url' => '/cloud',
+  'user_backends' => array(
+    array(
+      'class' => '\OCA\UserExternal\IMAP',
+      'arguments' => array(
+        '127.0.0.1', 143, null, null, false, false
+       ),
+    ),
+  ),
+  'memcache.local' => '\OC\Memcache\APCu',
+  'mail_smtpmode' => 'sendmail',
+  'mail_smtpsecure' => '',
+  'mail_smtpauthtype' => 'LOGIN',
+  'mail_smtpauth' => false,
+  'mail_smtphost' => '',
+  'mail_smtpport' => '',
+  'mail_smtpname' => '',
+  'mail_smtppassword' => '',
+  'mail_from_address' => 'owncloud',
+);
+?>
+EOF
+
+	# Create an auto-configuration file to fill in database settings
+	# when the install script is run. Make an administrator account
+	# here or else the install can't finish.
+	adminpassword=$(dd if=/dev/urandom bs=1 count=40 2>/dev/null | sha1sum | fold -w 30 | head -n 1)
+	cat > /usr/local/lib/owncloud/config/autoconfig.php <<EOF;
+<?php
+\$AUTOCONFIG = array (
+  # storage/database
+  'directory' => '$STORAGE_ROOT/owncloud',
+  'dbtype' => 'sqlite3',
+  'dbname' => 'owncloud',
+
+  # create an administrator account with a random password so that
+  # the user does not have to enter anything on first load of Nextcloud
+  'adminlogin'    => 'root',
+  'adminpass'     => '$adminpassword',
+);
+?>
+EOF
+
+	# Set permissions
+	chown -R www-data.www-data $STORAGE_ROOT/owncloud /usr/local/lib/owncloud
+
+	# Execute Nextcloud's setup step, which creates the Nextcloud sqlite database.
+	# It also wipes it if it exists. And it updates config.php with database
+	# settings and deletes the autoconfig.php file.
+	(cd /usr/local/lib/owncloud; sudo -u www-data php /usr/local/lib/owncloud/index.php;)
+fi
+
+# Update config.php.
+# * trusted_domains is reset to localhost by autoconfig starting with ownCloud 8.1.1,
+#   so set it here. It also can change if the box's PRIMARY_HOSTNAME changes, so
+#   this will make sure it has the right value.
+# * Some settings weren't included in previous versions of Mail-in-a-Box.
+# * We need to set the timezone to the system timezone to allow fail2ban to ban
+#   users within the proper timeframe
+# * We need to set the logdateformat to something that will work correctly with fail2ban
+# * mail_domain' needs to be set every time we run the setup. Making sure we are setting
+#   the correct domain name if the domain is being change from the previous setup.
+# Use PHP to read the settings file, modify it, and write out the new settings array.
+TIMEZONE=$(cat /etc/timezone)
+php <<EOF > $CONFIG_TEMP && mv $CONFIG_TEMP $STORAGE_ROOT/owncloud/config.php;
+<?php
+include("$STORAGE_ROOT/owncloud/config.php");
+
+\$CONFIG['config_is_read_only'] = true;
+
+\$CONFIG['trusted_domains'] = array('$PRIMARY_HOSTNAME');
+
+\$CONFIG['memcache.local'] = '\OC\Memcache\APCu';
+\$CONFIG['overwrite.cli.url'] = '/cloud';
+\$CONFIG['mail_from_address'] = 'administrator'; # just the local part, matches our master administrator address
+
+\$CONFIG['logtimezone'] = '$TIMEZONE';
+\$CONFIG['logdateformat'] = 'Y-m-d H:i:s';
+
+\$CONFIG['mail_domain'] = '$PRIMARY_HOSTNAME';
+
+\$CONFIG['user_backends'] = array(
+  array(
+    'class' => '\OCA\UserExternal\IMAP',
+    'arguments' => array(
+      '127.0.0.1', 143, null, null, false, false
+    ),
+  ),
+);
+
+echo "<?php\n\\\$CONFIG = ";
+var_export(\$CONFIG);
+echo ";";
+?>
+EOF
+chown www-data.www-data $STORAGE_ROOT/owncloud/config.php
+
+# Enable/disable apps. Note that this must be done after the Nextcloud setup.
+# The firstrunwizard gave Josh all sorts of problems, so disabling that.
+# user_external is what allows Nextcloud to use IMAP for login. The contacts
+# and calendar apps are the extensions we really care about here.
+hide_output sudo -u www-data php /usr/local/lib/owncloud/console.php app:disable firstrunwizard
+hide_output sudo -u www-data php /usr/local/lib/owncloud/console.php app:enable user_external
+hide_output sudo -u www-data php /usr/local/lib/owncloud/console.php app:enable contacts
+hide_output sudo -u www-data php /usr/local/lib/owncloud/console.php app:enable calendar
+
+# When upgrading, run the upgrade script again now that apps are enabled. It seems like
+# the first upgrade at the top won't work because apps may be disabled during upgrade?
+# Check for success (0=ok, 3=no upgrade needed).
+sudo -u www-data php /usr/local/lib/owncloud/occ upgrade
+if [ \( $? -ne 0 \) -a \( $? -ne 3 \) ]; then exit 1; fi
+
+# Disable default apps that we don't support
+sudo -u www-data \
+	php /usr/local/lib/owncloud/occ app:disable photos dashboard activity \
+	| (grep -v "No such app enabled" || /bin/true)
+
+# Set PHP FPM values to support large file uploads
+# (semicolon is the comment character in this file, hashes produce deprecation warnings)
+management/editconf.py /etc/php/$(php_version)/fpm/php.ini -c ';' \
+	upload_max_filesize=16G \
+	post_max_size=16G \
+	output_buffering=16384 \
+	memory_limit=512M \
+	max_execution_time=600 \
+	short_open_tag=On
+
+# Set Nextcloud recommended opcache settings
+management/editconf.py /etc/php/$(php_version)/cli/conf.d/10-opcache.ini -c ';' \
+	opcache.enable=1 \
+	opcache.enable_cli=1 \
+	opcache.interned_strings_buffer=8 \
+	opcache.max_accelerated_files=10000 \
+	opcache.memory_consumption=128 \
+	opcache.save_comments=1 \
+	opcache.revalidate_freq=1
+
+# Migrate users_external data from <0.6.0 to version 3.0.0 (see https://github.com/nextcloud/user_external).
+# This version was probably in use in Mail-in-a-Box v0.41 (February 26, 2019) and earlier.
+# We moved to v0.6.3 in 193763f8. Ignore errors - maybe there are duplicated users with the
+# correct backend already.
+sqlite3 $STORAGE_ROOT/owncloud/owncloud.db "UPDATE oc_users_external SET backend='127.0.0.1';" || /bin/true
+
+# Set up a cron job for Nextcloud.
+cat > /etc/cron.d/mailinabox-nextcloud << EOF;
+#!/bin/bash
+# Mail-in-a-Box
+*/5 * * * *	root	sudo -u www-data php -f /usr/local/lib/owncloud/cron.php
+EOF
+chmod +x /etc/cron.d/mailinabox-nextcloud
+
+# There's nothing much of interest that a user could do as an admin for Nextcloud,
+# and there's a lot they could mess up, so we don't make any users admins of Nextcloud.
+# But if we wanted to, we would do this:
+# ```
+# for user in $(management/cli.py user admins); do
+#	 sqlite3 $STORAGE_ROOT/owncloud/owncloud.db "INSERT OR IGNORE INTO oc_group_user VALUES ('admin', '$user')"
+# done
+# ```
+
+# Enable PHP modules and restart PHP.
+restart_service php$(php_version)-fpm

setup/owncloud.sh

@@ -1,341 +0,0 @@
-#!/bin/bash
-# Nextcloud
-##########################
-
-source setup/functions.sh # load our functions
-source /etc/mailinabox.conf # load global vars
-
-# ### Installing Nextcloud
-
-echo "Installing Nextcloud (contacts/calendar)..."
-
-apt_install \
-	dbconfig-common \
-	php5-cli php5-sqlite php5-gd php5-imap php5-curl php-pear php-apc curl libapr1 libtool libcurl4-openssl-dev php-xml-parser \
-	php5 php5-dev php5-gd php5-fpm memcached php5-memcached
-
-apt-get purge -qq -y owncloud*
-
-# Migrate <= v0.10 setups that stored the ownCloud config.php in /usr/local rather than
-# in STORAGE_ROOT. Move the file to STORAGE_ROOT.
-if [ ! -f $STORAGE_ROOT/owncloud/config.php ] \
-	&& [ -f /usr/local/lib/owncloud/config/config.php ]; then
-
-	# Move config.php and symlink back into previous location.
-	echo "Migrating owncloud/config.php to new location."
-	mv /usr/local/lib/owncloud/config/config.php $STORAGE_ROOT/owncloud/config.php \
-		&& \
-	ln -sf $STORAGE_ROOT/owncloud/config.php /usr/local/lib/owncloud/config/config.php
-fi
-
-InstallOwncloud() {
-
-	version=$1
-	hash=$2
-	flavor=$3
-
-	echo
-	echo "Upgrading to $flavor version $version"
-	echo
-
-	# Remove the current owncloud/Nextcloud
-	rm -rf /usr/local/lib/owncloud
-
-	# Download and verify
-	if [ "$flavor" = "Nextcloud" ]; then
-		wget_verify https://download.nextcloud.com/server/releases/nextcloud-$version.zip $hash /tmp/owncloud.zip
-	else
-		wget_verify https://download.owncloud.org/community/owncloud-$version.zip $hash /tmp/owncloud.zip
-	fi
-
-	# Extract ownCloud/Nextcloud
-	unzip -q /tmp/owncloud.zip -d /usr/local/lib
-	if [ "$flavor" = "Nextcloud" ]; then
-		mv /usr/local/lib/nextcloud /usr/local/lib/owncloud
-	fi
-	rm -f /tmp/owncloud.zip
-
-	# The two apps we actually want are not in Nextcloud core. Download the releases from
-	# their github repositories.
-	mkdir -p /usr/local/lib/owncloud/apps
-
-	if [ "$flavor" = "Nextcloud" ]; then
-		wget_verify https://github.com/nextcloud/contacts/releases/download/v1.5.3/contacts.tar.gz 78c4d49e73f335084feecd4853bd8234cf32615e /tmp/contacts.tgz
-	else
-		wget_verify https://github.com/owncloud/contacts/releases/download/v1.4.0.0/contacts.tar.gz c1c22d29699456a45db447281682e8bc3f10e3e7 /tmp/contacts.tgz
-	fi
-
-	tar xf /tmp/contacts.tgz -C /usr/local/lib/owncloud/apps/
-	rm /tmp/contacts.tgz
-
-	if [ "$flavor" = "Nextcloud" ]; then
-		wget_verify https://github.com/nextcloud/calendar/releases/download/v1.5.2/calendar.tar.gz 7b8a94e01fe740c5c23017ed5bc211983c780fce /tmp/calendar.tgz
-	else
-    wget_verify https://github.com/nextcloud/calendar/releases/download/v1.4.0/calendar.tar.gz c84f3170efca2a99ea6254de34b0af3cb0b3a821 /tmp/calendar.tgz
-	fi
-
-	tar xf /tmp/calendar.tgz -C /usr/local/lib/owncloud/apps/
-	rm /tmp/calendar.tgz
-
-	# Fix weird permissions.
-	chmod 750 /usr/local/lib/owncloud/{apps,config}
-
-	# Create a symlink to the config.php in STORAGE_ROOT (for upgrades we're restoring the symlink we previously
-	# put in, and in new installs we're creating a symlink and will create the actual config later).
-	ln -sf $STORAGE_ROOT/owncloud/config.php /usr/local/lib/owncloud/config/config.php
-
-	# Make sure permissions are correct or the upgrade step won't run.
-	# $STORAGE_ROOT/owncloud may not yet exist, so use -f to suppress
-	# that error.
-	chown -f -R www-data.www-data $STORAGE_ROOT/owncloud /usr/local/lib/owncloud
-
-	# If this isn't a new installation, immediately run the upgrade script.
-	# Then check for success (0=ok and 3=no upgrade needed, both are success).
-	if [ -e $STORAGE_ROOT/owncloud/owncloud.db ]; then
-		# ownCloud 8.1.1 broke upgrades. It may fail on the first attempt, but
-		# that can be OK.
-		sudo -u www-data php /usr/local/lib/owncloud/occ upgrade
-		if [ \( $? -ne 0 \) -a \( $? -ne 3 \) ]; then
-			echo "Trying ownCloud upgrade again to work around ownCloud upgrade bug..."
-			sudo -u www-data php /usr/local/lib/owncloud/occ upgrade
-			if [ \( $? -ne 0 \) -a \( $? -ne 3 \) ]; then exit 1; fi
-			sudo -u www-data php /usr/local/lib/owncloud/occ maintenance:mode --off
-			echo "...which seemed to work."
-		fi
-	fi
-}
-
-owncloud_ver=10.0.5
-owncloud_hash=686f6a8e9d7867c32e3bf3ca63b3cc2020564bf6
-owncloud_flavor=Nextcloud
-
-# Check if Nextcloud dir exist, and check if version matches owncloud_ver (if either doesn't - install/upgrade)
-if [ ! -d /usr/local/lib/owncloud/ ] \
-        || ! grep -q $owncloud_ver /usr/local/lib/owncloud/version.php; then
-
-	# Stop php-fpm
-	hide_output service php5-fpm stop
-
-	# Backup the existing ownCloud/Nextcloud.
-	# Create a backup directory to store the current installation and database to
-	BACKUP_DIRECTORY=$STORAGE_ROOT/owncloud-backup/`date +"%Y-%m-%d-%T"`
-	mkdir -p "$BACKUP_DIRECTORY"
-	if [ -d /usr/local/lib/owncloud/ ]; then
-		echo "upgrading ownCloud/Nextcloud to $owncloud_flavor $owncloud_ver (backing up existing installation, configuration and database to directory to $BACKUP_DIRECTORY..."
-		cp -r /usr/local/lib/owncloud "$BACKUP_DIRECTORY/owncloud-install"
-	fi
-	if [ -e /home/user-data/owncloud/owncloud.db ]; then
-		cp /home/user-data/owncloud/owncloud.db $BACKUP_DIRECTORY
-        fi
-        if [ -e /home/user-data/owncloud/config.php ]; then
-                cp /home/user-data/owncloud/config.php $BACKUP_DIRECTORY
-        fi
-
-	# We only need to check if we do upgrades when owncloud/Nextcloud was previously installed
-	if [ -e /usr/local/lib/owncloud/version.php ]; then
-		if grep -q "8\.1\.[0-9]" /usr/local/lib/owncloud/version.php; then
-			echo "We are running 8.1.x, upgrading to 8.2.3 first"
-			InstallOwncloud 8.2.3 bfdf6166fbf6fc5438dc358600e7239d1c970613 ownCloud
-		fi
-
-		# If we are upgrading from 8.2.x we should go to 9.0 first. Owncloud doesn't support skipping minor versions
-		if grep -q "8\.2\.[0-9]" /usr/local/lib/owncloud/version.php; then
-			echo "We are running version 8.2.x, upgrading to 9.0.2 first"
-
-			# We need to disable memcached. The upgrade and install fails
-			# with memcached
-			CONFIG_TEMP=$(/bin/mktemp)
-			php <<EOF > $CONFIG_TEMP && mv $CONFIG_TEMP $STORAGE_ROOT/owncloud/config.php;
-			<?php
-				include("$STORAGE_ROOT/owncloud/config.php");
-
-				\$CONFIG['memcache.local'] = '\OC\Memcache\APC';
-
-				echo "<?php\n\\\$CONFIG = ";
-				var_export(\$CONFIG);
-				echo ";";
-			?>
-EOF
-			chown www-data.www-data $STORAGE_ROOT/owncloud/config.php
-
-			# We can now install owncloud 9.0.2
-			InstallOwncloud 9.0.2 72a3d15d09f58c06fa8bee48b9e60c9cd356f9c5 ownCloud
-
-			# The owncloud 9 migration doesn't migrate calendars and contacts
-			# The option to migrate these are removed in 9.1
-			# So the migrations should be done when we have 9.0 installed
-			sudo -u www-data php /usr/local/lib/owncloud/occ dav:migrate-addressbooks
-			# The following migration has to be done for each owncloud user
-			for directory in $STORAGE_ROOT/owncloud/*@*/ ; do
-				username=$(basename "${directory}")
-				sudo -u www-data php /usr/local/lib/owncloud/occ dav:migrate-calendar $username
-			done
-			sudo -u www-data php /usr/local/lib/owncloud/occ dav:sync-birthday-calendar
-		fi
-
-		# If we are upgrading from 9.0.x we should go to 9.1 first.
-		if grep -q "9\.0\.[0-9]" /usr/local/lib/owncloud/version.php; then
-			echo "We are running ownCloud 9.0.x, upgrading to ownCloud 9.1.4 first"
-			InstallOwncloud 9.1.4 e637cab7b2ca3346164f3506b1a0eb812b4e841a ownCloud
-		fi
-
-	fi
-
-	InstallOwncloud $owncloud_ver $owncloud_hash Nextcloud
-fi
-
-# ### Configuring Nextcloud
-
-# Setup Nextcloud if the Nextcloud database does not yet exist. Running setup when
-# the database does exist wipes the database and user data.
-if [ ! -f $STORAGE_ROOT/owncloud/owncloud.db ]; then
-	# Create user data directory
-	mkdir -p $STORAGE_ROOT/owncloud
-
-	# Create an initial configuration file.
-	instanceid=oc$(echo $PRIMARY_HOSTNAME | sha1sum | fold -w 10 | head -n 1)
-	cat > $STORAGE_ROOT/owncloud/config.php <<EOF;
-<?php
-\$CONFIG = array (
-  'datadirectory' => '$STORAGE_ROOT/owncloud',
-
-  'instanceid' => '$instanceid',
-
-  'forcessl' => true, # if unset/false, Nextcloud sends a HSTS=0 header, which conflicts with nginx config
-
-  'overwritewebroot' => '/cloud',
-  'overwrite.cli.url' => '/cloud',
-  'user_backends' => array(
-    array(
-      'class'=>'OC_User_IMAP',
-      'arguments'=>array('{127.0.0.1:993/imap/ssl/novalidate-cert}')
-    )
-  ),
-  'memcache.local' => '\OC\Memcache\APC',
-  'mail_smtpmode' => 'sendmail',
-  'mail_smtpsecure' => '',
-  'mail_smtpauthtype' => 'LOGIN',
-  'mail_smtpauth' => false,
-  'mail_smtphost' => '',
-  'mail_smtpport' => '',
-  'mail_smtpname' => '',
-  'mail_smtppassword' => '',
-  'mail_from_address' => 'owncloud',
-);
-?>
-EOF
-
-	# Create an auto-configuration file to fill in database settings
-	# when the install script is run. Make an administrator account
-	# here or else the install can't finish.
-	adminpassword=$(dd if=/dev/urandom bs=1 count=40 2>/dev/null | sha1sum | fold -w 30 | head -n 1)
-	cat > /usr/local/lib/owncloud/config/autoconfig.php <<EOF;
-<?php
-\$AUTOCONFIG = array (
-  # storage/database
-  'directory' => '$STORAGE_ROOT/owncloud',
-  'dbtype' => 'sqlite3',
-
-  # create an administrator account with a random password so that
-  # the user does not have to enter anything on first load of Nextcloud
-  'adminlogin'    => 'root',
-  'adminpass'     => '$adminpassword',
-);
-?>
-EOF
-
-	# Set permissions
-	chown -R www-data.www-data $STORAGE_ROOT/owncloud /usr/local/lib/owncloud
-
-	# Execute Nextcloud's setup step, which creates the Nextcloud sqlite database.
-	# It also wipes it if it exists. And it updates config.php with database
-	# settings and deletes the autoconfig.php file.
-	(cd /usr/local/lib/owncloud; sudo -u www-data php /usr/local/lib/owncloud/index.php;)
-fi
-
-# Update config.php.
-# * trusted_domains is reset to localhost by autoconfig starting with ownCloud 8.1.1,
-#   so set it here. It also can change if the box's PRIMARY_HOSTNAME changes, so
-#   this will make sure it has the right value.
-# * Some settings weren't included in previous versions of Mail-in-a-Box.
-# * We need to set the timezone to the system timezone to allow fail2ban to ban
-#   users within the proper timeframe
-# * We need to set the logdateformat to something that will work correctly with fail2ban
-# * mail_domain' needs to be set every time we run the setup. Making sure we are setting 
-#   the correct domain name if the domain is being change from the previous setup.
-# Use PHP to read the settings file, modify it, and write out the new settings array.
-TIMEZONE=$(cat /etc/timezone)
-CONFIG_TEMP=$(/bin/mktemp)
-php <<EOF > $CONFIG_TEMP && mv $CONFIG_TEMP $STORAGE_ROOT/owncloud/config.php;
-<?php
-include("$STORAGE_ROOT/owncloud/config.php");
-
-\$CONFIG['trusted_domains'] = array('$PRIMARY_HOSTNAME');
-
-\$CONFIG['memcache.local'] = '\OC\Memcache\APC';
-\$CONFIG['overwrite.cli.url'] = '/cloud';
-\$CONFIG['mail_from_address'] = 'administrator'; # just the local part, matches our master administrator address
-
-\$CONFIG['logtimezone'] = '$TIMEZONE';
-\$CONFIG['logdateformat'] = 'Y-m-d H:i:s';
-
-\$CONFIG['mail_domain'] = '$PRIMARY_HOSTNAME';
-
-echo "<?php\n\\\$CONFIG = ";
-var_export(\$CONFIG);
-echo ";";
-?>
-EOF
-chown www-data.www-data $STORAGE_ROOT/owncloud/config.php
-
-# Enable/disable apps. Note that this must be done after the Nextcloud setup.
-# The firstrunwizard gave Josh all sorts of problems, so disabling that.
-# user_external is what allows Nextcloud to use IMAP for login. The contacts
-# and calendar apps are the extensions we really care about here.
-hide_output sudo -u www-data php /usr/local/lib/owncloud/console.php app:disable firstrunwizard
-hide_output sudo -u www-data php /usr/local/lib/owncloud/console.php app:enable user_external
-hide_output sudo -u www-data php /usr/local/lib/owncloud/console.php app:enable contacts
-hide_output sudo -u www-data php /usr/local/lib/owncloud/console.php app:enable calendar
-
-# When upgrading, run the upgrade script again now that apps are enabled. It seems like
-# the first upgrade at the top won't work because apps may be disabled during upgrade?
-# Check for success (0=ok, 3=no upgrade needed).
-sudo -u www-data php /usr/local/lib/owncloud/occ upgrade
-if [ \( $? -ne 0 \) -a \( $? -ne 3 \) ]; then exit 1; fi
-
-# Set PHP FPM values to support large file uploads
-# (semicolon is the comment character in this file, hashes produce deprecation warnings)
-tools/editconf.py /etc/php5/fpm/php.ini -c ';' \
-	upload_max_filesize=16G \
-	post_max_size=16G \
-	output_buffering=16384 \
-	memory_limit=512M \
-	max_execution_time=600 \
-	short_open_tag=On
-
-# If apc is explicitly disabled we need to enable it
-if grep -q apc.enabled=0 /etc/php5/mods-available/apcu.ini; then
-	tools/editconf.py /etc/php5/mods-available/apcu.ini -c ';' \
-		apc.enabled=1
-fi
-
-# Set up a cron job for Nextcloud.
-cat > /etc/cron.hourly/mailinabox-owncloud << EOF;
-#!/bin/bash
-# Mail-in-a-Box
-sudo -u www-data php -f /usr/local/lib/owncloud/cron.php
-EOF
-chmod +x /etc/cron.hourly/mailinabox-owncloud
-
-# There's nothing much of interest that a user could do as an admin for Nextcloud,
-# and there's a lot they could mess up, so we don't make any users admins of Nextcloud.
-# But if we wanted to, we would do this:
-# ```
-# for user in $(tools/mail.py user admins); do
-#	 sqlite3 $STORAGE_ROOT/owncloud/owncloud.db "INSERT OR IGNORE INTO oc_group_user VALUES ('admin', '$user')"
-# done
-# ```
-
-# Enable PHP modules and restart PHP.
-php5enmod imap
-restart_service php5-fpm

setup/pgp.sh

@@ -0,0 +1,54 @@
+#!/bin/bash
+
+# Daemon PGP Keyring
+# ------------------
+#
+# Initializes the PGP keyring at /home/user-data/.gnupg
+# For this, we will generate a new PGP keypair (if one isn't already present)
+
+source setup/functions.sh # load our functions
+source /etc/mailinabox.conf # load global vars
+export GNUPGHOME # Dump into the environment so that gpg uses it as homedir
+
+# Install gnupg
+apt_install gnupg
+
+function gpg_keygen {
+    # Generates a private key.
+    gpg --generate-key --batch 2> /tmp/gpg_keygen_log << EOF;
+    %no-protection
+    Key-Type: RSA
+    Key-Length: 4096
+    Key-Usage: sign,encrypt,auth
+    Name-Real: System Management Daemon
+    Name-Email: noreply-daemon@${PRIMARY_HOSTNAME}
+    Expire-Date: 180d
+    %commit
+EOF
+}
+
+# Generate a new key if:
+# - There isn't a fingerprint on /etc/mailinabox.conf
+# - The configured fingerprint doesn't actually exist
+
+if [ -z "${PGPKEY:-}" -o "$(gpg --list-secret-keys 2> /dev/null | grep ${PGPKEY:-\r\n})" = "" ]; then
+    echo "No keypair found. Generating daemon's PGP keypair..."
+    gpg_keygen
+    if [ $? -ne 0 ]; then
+        echo ""
+        echo "Key generation failed!" 1>&2
+        echo "============================" 1>&2
+        cat /tmp/gpg_keygen_log 1>&2
+        echo "============================" 1>&2
+
+        exit 1
+    fi
+
+    FPR=$(cat /tmp/gpg_keygen_log | tr -d '\n' | sed -r 's/.*([0-9A-F]{40}).*/\1/g')
+    echo "Generated key with fingerprint $FPR"
+
+    chown -R root:root $GNUPGHOME
+    # Remove the old key fingerprint from the configuration if it exists, and add the new one
+    echo "$(cat /etc/mailinabox.conf | grep -v "PGPKEY")" > /etc/mailinabox.conf
+    echo "PGPKEY=$FPR" >> /etc/mailinabox.conf
+fi

setup/preflight.sh

@@ -1,21 +1,41 @@
+source setup/functions.sh
+
 # Are we running as root?
 if [[ $EUID -ne 0 ]]; then
 	echo "This script must be run as root. Please re-run like this:"
 	echo
 	echo "sudo $0"
 	echo
-	exit
+	exit 1
 fi
 
-# Check that we are running on Ubuntu 14.04 LTS (or 14.04.xx).
-if [ "`lsb_release -d | sed 's/.*:\s*//' | sed 's/14\.04\.[0-9]/14.04/' `" != "Ubuntu 14.04 LTS" ]; then
-	echo "Mail-in-a-Box only supports being installed on Ubuntu 14.04, sorry. You are running:"
-	echo
-	lsb_release -d | sed 's/.*:\s*//'
-	echo
-	echo "We can't write scripts that run on every possible setup, sorry."
-	exit
-fi
+# Check that we are running on Debian GNU/Linux, or Ubuntu 20.04/22.04
+case $(get_os_code) in
+	$OS_UNSUPPORTED)
+		echo "This version of Power Mail-in-a-Box only supports being installed on one of these operating systems:"
+		# echo "* Debian 10 (buster)"
+		echo "* Debian 11 (bullseye)"
+		echo "* Ubuntu 20.04 LTS (Focal Fossa)"
+		echo "* Ubuntu 22.04 LTS (Jammy Jellyfish)"
+		echo
+		echo "You're running:"
+		lsb_release -ds
+		echo
+		echo "We can't write scripts that run on every possible setup, sorry."
+		exit 1
+		;;
+
+	$OS_DEBIAN_10)
+		echo "You're trying to install Power Mail-in-a-Box on Debian 10 (buster), which is no longer supported."
+		echo "You can install the latest version of Power Mail-in-a-Box supporting Debian 10 by running the following command:"
+		echo
+		echo "curl -L https://power-mailinabox.net/setup.sh | sudo bash"
+		echo
+		echo "Then upgrade to Debian 11 (bullseye). A short guide on how to do so is available here:"
+		echo "https://power-mailinabox.net/buster-eol"
+		exit 1
+		;;
+esac
 
 # Check that we have enough memory.
 #
@@ -26,7 +46,7 @@ fi
 #
 # Skip the check if we appear to be running inside of Vagrant, because that's really just for testing.
 TOTAL_PHYSICAL_MEM=$(head -n 1 /proc/meminfo | awk '{print $2}')
-if [ $TOTAL_PHYSICAL_MEM -lt 500000 ]; then
+if [ $TOTAL_PHYSICAL_MEM -lt 490000 ]; then
 if [ ! -d /vagrant ]; then
 	TOTAL_PHYSICAL_MEM=$(expr \( \( $TOTAL_PHYSICAL_MEM \* 1024 \) / 1000 \) / 1000)
 	echo "Your Mail-in-a-Box needs more memory (RAM) to function properly."
@@ -41,7 +61,7 @@ if [ $TOTAL_PHYSICAL_MEM -lt 750000 ]; then
 fi
 
 # Check that tempfs is mounted with exec
-MOUNTED_TMP_AS_NO_EXEC=$(grep "/tmp.*noexec" /proc/mounts)
+MOUNTED_TMP_AS_NO_EXEC=$(grep "/tmp.*noexec" /proc/mounts || /bin/true)
 if [ -n "$MOUNTED_TMP_AS_NO_EXEC" ]; then
 	echo "Mail-in-a-Box has to have exec rights on /tmp, please mount /tmp with exec"
 	exit
@@ -53,16 +73,14 @@ if [ -e ~/.wgetrc ]; then
 	exit
 fi
 
-# Check that we are running on x86_64 or i686, any other architecture is unsupported and
-# will fail later in the setup when we try to install the custom build lucene packages.
-#
-# Set ARM=1 to ignore this check if you have built the packages yourself. If you do this
-# you are on your own!
+# Check that we are running on x86_64 or i686 architecture, which are the only
+# ones we support / test.
 ARCHITECTURE=$(uname -m)
 if [ "$ARCHITECTURE" != "x86_64" ] && [ "$ARCHITECTURE" != "i686" ]; then
-if [ -z "$ARM" ]; then
-	echo "Mail-in-a-Box only supports x86_64 or i686 and will not work on any other architecture, like ARM."
-	echo "Your architecture is $ARCHITECTURE"
-	exit
-fi
+	echo
+	echo "WARNING:"
+	echo "Mail-in-a-Box has only been tested on x86_64 and i686 platform"
+	echo "architectures. Your architecture, $ARCHITECTURE, may not work."
+	echo "You are on your own."
+	echo
 fi

setup/questions.sh

@@ -1,4 +1,4 @@
-if [ -z "$NONINTERACTIVE" ]; then
+if [ -z "${NONINTERACTIVE:-}" ]; then
 	# Install 'dialog' so we can ask the user questions. The original motivation for
 	# this was being able to ask the user for input even if stdin has been redirected,
 	# e.g. if we piped a bootstrapping install script to bash to get started. In that
@@ -9,22 +9,24 @@ if [ -z "$NONINTERACTIVE" ]; then
 	if [ ! -f /usr/bin/dialog ] || [ ! -f /usr/bin/python3 ] || [ ! -f /usr/bin/pip3 ]; then
 		echo Installing packages needed for setup...
 		apt-get -q -q update
-		apt_get_quiet install dialog python3 python3-pip  || exit 1
+		apt_get_quiet install dialog file python3 python3-pip  || exit 1
 	fi
 
-	# email_validator is repeated in setup/management.sh
+	# Installing email_validator is repeated in setup/management.sh, but in setup/management.sh
+	# we install it inside a virtualenv. In this script, we don't have the virtualenv yet
+	# so we install the python package globally.
 	hide_output pip3 install "email_validator>=1.0.0" || exit 1
 
 	message_box "Mail-in-a-Box Installation" \
-		"Hello and thanks for deploying a Mail-in-a-Box!
+		"Hello and thanks for deploying a (Power) Mail-in-a-Box!
 		\n\nI'm going to ask you a few questions.
 		\n\nTo change your answers later, just run 'sudo mailinabox' from the command line.
-		\n\nNOTE: You should only install this on a brand new Ubuntu installation 100% dedicated to Mail-in-a-Box. Mail-in-a-Box will, for example, remove apache2."
+		\n\nNOTE: You should only install this on a brand new Debian/Ubuntu installation 100% dedicated to Mail-in-a-Box. Mail-in-a-Box will, for example, remove apache2."
 fi
 
 # The box needs a name.
-if [ -z "$PRIMARY_HOSTNAME" ]; then
-	if [ -z "$DEFAULT_PRIMARY_HOSTNAME" ]; then
+if [ -z "${PRIMARY_HOSTNAME:-}" ]; then
+	if [ -z "${DEFAULT_PRIMARY_HOSTNAME:-}" ]; then
 		# We recommend to use box.example.com as this hosts name. The
 		# domain the user possibly wants to use is example.com then.
 		# We strip the string "box." from the hostname to get the mail
@@ -49,7 +51,7 @@ you really want.
 			# user hit ESC/cancel
 			exit
 		fi
-		while ! management/mailconfig.py validate-email "$EMAIL_ADDR"
+		while ! python3 management/mailconfig.py validate-email "$EMAIL_ADDR"
 		do
 			input_box "Your Email Address" \
 				"That's not a valid email address.\n\nWhat email address are you setting this box up to manage?" \
@@ -84,30 +86,30 @@ fi
 # If the machine is behind a NAT, inside a VM, etc., it may not know
 # its IP address on the public network / the Internet. Ask the Internet
 # and possibly confirm with user.
-if [ -z "$PUBLIC_IP" ]; then
+if [ -z "${PUBLIC_IP:-}" ]; then
 	# Ask the Internet.
 	GUESSED_IP=$(get_publicip_from_web_service 4)
 
 	# On the first run, if we got an answer from the Internet then don't
 	# ask the user.
-	if [[ -z "$DEFAULT_PUBLIC_IP" && ! -z "$GUESSED_IP" ]]; then
+	if [[ -z "${DEFAULT_PUBLIC_IP:-}" && ! -z "$GUESSED_IP" ]]; then
 		PUBLIC_IP=$GUESSED_IP
 
 	# Otherwise on the first run at least provide a default.
-	elif [[ -z "$DEFAULT_PUBLIC_IP" ]]; then
+	elif [[ -z "${DEFAULT_PUBLIC_IP:-}" ]]; then
 		DEFAULT_PUBLIC_IP=$(get_default_privateip 4)
 
 	# On later runs, if the previous value matches the guessed value then
 	# don't ask the user either.
-	elif [ "$DEFAULT_PUBLIC_IP" == "$GUESSED_IP" ]; then
+	elif [ "${DEFAULT_PUBLIC_IP:-}" == "$GUESSED_IP" ]; then
 		PUBLIC_IP=$GUESSED_IP
 	fi
 
-	if [ -z "$PUBLIC_IP" ]; then
+	if [ -z "${PUBLIC_IP:-}" ]; then
 		input_box "Public IP Address" \
 			"Enter the public IP address of this machine, as given to you by your ISP.
 			\n\nPublic IP address:" \
-			$DEFAULT_PUBLIC_IP \
+			${DEFAULT_PUBLIC_IP:-} \
 			PUBLIC_IP
 
 		if [ -z "$PUBLIC_IP" ]; then
@@ -119,27 +121,27 @@ fi
 
 # Same for IPv6. But it's optional. Also, if it looks like the system
 # doesn't have an IPv6, don't ask for one.
-if [ -z "$PUBLIC_IPV6" ]; then
+if [ -z "${PUBLIC_IPV6:-}" ]; then
 	# Ask the Internet.
 	GUESSED_IP=$(get_publicip_from_web_service 6)
 	MATCHED=0
-	if [[ -z "$DEFAULT_PUBLIC_IPV6" && ! -z "$GUESSED_IP" ]]; then
+	if [[ -z "${DEFAULT_PUBLIC_IPV6:-}" && ! -z "$GUESSED_IP" ]]; then
 		PUBLIC_IPV6=$GUESSED_IP
-	elif [[ "$DEFAULT_PUBLIC_IPV6" == "$GUESSED_IP" ]]; then
+	elif [[ "${DEFAULT_PUBLIC_IPV6:-}" == "$GUESSED_IP" ]]; then
 		# No IPv6 entered and machine seems to have none, or what
 		# the user entered matches what the Internet tells us.
 		PUBLIC_IPV6=$GUESSED_IP
 		MATCHED=1
-	elif [[ -z "$DEFAULT_PUBLIC_IPV6" ]]; then
+	elif [[ -z "${DEFAULT_PUBLIC_IPV6:-}" ]]; then
 		DEFAULT_PUBLIC_IP=$(get_default_privateip 6)
 	fi
 
-	if [[ -z "$PUBLIC_IPV6" && $MATCHED == 0 ]]; then
+	if [[ -z "${PUBLIC_IPV6:-}" && $MATCHED == 0 ]]; then
 		input_box "IPv6 Address (Optional)" \
 			"Enter the public IPv6 address of this machine, as given to you by your ISP.
 			\n\nLeave blank if the machine does not have an IPv6 address.
 			\n\nPublic IPv6 address:" \
-			$DEFAULT_PUBLIC_IPV6 \
+			${DEFAULT_PUBLIC_IPV6:-} \
 			PUBLIC_IPV6
 
 		if [ ! $PUBLIC_IPV6_EXITCODE ]; then
@@ -152,10 +154,10 @@ fi
 # Get the IP addresses of the local network interface(s) that are connected
 # to the Internet. We need these when we want to have services bind only to
 # the public network interfaces (not loopback, not tunnel interfaces).
-if [ -z "$PRIVATE_IP" ]; then
+if [ -z "${PRIVATE_IP:-}" ]; then
 	PRIVATE_IP=$(get_default_privateip 4)
 fi
-if [ -z "$PRIVATE_IPV6" ]; then
+if [ -z "${PRIVATE_IPV6:-}" ]; then
 	PRIVATE_IPV6=$(get_default_privateip 6)
 fi
 if [[ -z "$PRIVATE_IP" && -z "$PRIVATE_IPV6" ]]; then
@@ -184,11 +186,11 @@ fi
 
 # Set STORAGE_USER and STORAGE_ROOT to default values (user-data and /home/user-data), unless
 # we've already got those values from a previous run.
-if [ -z "$STORAGE_USER" ]; then
-	STORAGE_USER=$([[ -z "$DEFAULT_STORAGE_USER" ]] && echo "user-data" || echo "$DEFAULT_STORAGE_USER")
+if [ -z "${STORAGE_USER:-}" ]; then
+	STORAGE_USER=$([[ -z "${DEFAULT_STORAGE_USER:-}" ]] && echo "user-data" || echo "$DEFAULT_STORAGE_USER")
 fi
-if [ -z "$STORAGE_ROOT" ]; then
-	STORAGE_ROOT=$([[ -z "$DEFAULT_STORAGE_ROOT" ]] && echo "/home/$STORAGE_USER" || echo "$DEFAULT_STORAGE_ROOT")
+if [ -z "${STORAGE_ROOT:-}" ]; then
+	STORAGE_ROOT=$([[ -z "${DEFAULT_STORAGE_ROOT:-}" ]] && echo "/home/$STORAGE_USER" || echo "$DEFAULT_STORAGE_ROOT")
 fi
 
 # Show the configuration, since the user may have not entered it manually.
@@ -205,6 +207,6 @@ if [ "$PRIVATE_IPV6" != "$PUBLIC_IPV6" ]; then
 	echo "Private IPv6 Address: $PRIVATE_IPV6"
 fi
 if [ -f /usr/bin/git ] && [ -d .git ]; then
-	echo "Mail-in-a-Box Version: " $(git describe)
+	echo "Mail-in-a-Box Version: " $(git describe --tags)
 fi
 echo

setup/spamassassin.sh

@@ -23,7 +23,7 @@ echo "Installing SpamAssassin..."
 apt_install spampd razor pyzor dovecot-antispam libmail-dkim-perl
 
 # Allow spamassassin to download new rules.
-tools/editconf.py /etc/default/spamassassin \
+management/editconf.py /etc/default/spamassassin \
 	CRON=1
 
 # Configure pyzor, which is a client to a live database of hashes of
@@ -34,7 +34,7 @@ tools/editconf.py /etc/default/spamassassin \
 # we can skip 'pyzor discover', both of which are currently broken by
 # something happening on Sourceforge (#496).
 rm -rf ~/.pyzor
-tools/editconf.py /etc/spamassassin/local.cf -s \
+management/editconf.py /etc/spamassassin/local.cf -s \
 	pyzor_options="--homedir /etc/spamassassin/pyzor"
 mkdir -p /etc/spamassassin/pyzor
 echo "public.pyzor.org:24441" > /etc/spamassassin/pyzor/servers
@@ -46,7 +46,7 @@ echo "public.pyzor.org:24441" > /etc/spamassassin/pyzor/servers
 # * Increase the maximum message size of scanned messages from the default of 64KB to 500KB, which
 #   is Spamassassin (spamc)'s own default. Specified in KBytes.
 # * Disable localmode so Pyzor, DKIM and DNS checks can be used.
-tools/editconf.py /etc/default/spampd \
+management/editconf.py /etc/default/spampd \
 	DESTPORT=10026 \
 	ADDOPTS="\"--maxsize=2000\"" \
 	LOCALONLY=0
@@ -61,10 +61,61 @@ tools/editconf.py /etc/default/spampd \
 # content or execute scripts, and it is probably confusing to most users.
 #
 # Tell Spamassassin not to modify the original message except for adding
-# the X-Spam-Status mail header and related headers.
-tools/editconf.py /etc/spamassassin/local.cf -s \
+# the X-Spam-Status & X-Spam-Score mail headers and related headers.
+management/editconf.py /etc/spamassassin/local.cf -s \
 	report_safe=0 \
-	add_header="all Report _REPORT_"
+	"add_header all Report"=_REPORT_ \
+	"add_header all Score"=_SCORE_
+
+
+# Authentication-Results SPF/Dmarc checks
+# ---------------------------------------
+# OpenDKIM and OpenDMARC are configured to validate and add "Authentication-Results: ..."
+# headers by checking the sender's SPF & DMARC policies. Instead of blocking mail that fails
+# these checks, we can use these headers to evaluate the mail as spam.
+#
+# Our custom rules are added to their own file so that an update to the deb package config
+# does not remove our changes.
+#
+# We need to escape period's in $PRIMARY_HOSTNAME since spamassassin config uses regex.
+
+escapedprimaryhostname="${PRIMARY_HOSTNAME//./\\.}"
+
+cat > /etc/spamassassin/miab_spf_dmarc.cf << EOF
+# Evaluate DMARC Authentication-Results
+header DMARC_PASS Authentication-Results =~ /$escapedprimaryhostname; dmarc=pass/
+describe DMARC_PASS DMARC check passed
+score DMARC_PASS -0.1
+
+header DMARC_NONE Authentication-Results =~ /$escapedprimaryhostname; dmarc=none/
+describe DMARC_NONE DMARC record not found
+score DMARC_NONE 0.1
+
+header DMARC_FAIL_NONE Authentication-Results =~ /$escapedprimaryhostname; dmarc=fail \(p=none/
+describe DMARC_FAIL_NONE DMARC check failed (p=none)
+score DMARC_FAIL_NONE 2.0
+
+header DMARC_FAIL_QUARANTINE Authentication-Results =~ /$escapedprimaryhostname; dmarc=fail \(p=quarantine/
+describe DMARC_FAIL_QUARANTINE DMARC check failed (p=quarantine)
+score DMARC_FAIL_QUARANTINE 5.0
+
+header DMARC_FAIL_REJECT Authentication-Results =~ /$escapedprimaryhostname; dmarc=fail \(p=reject/
+describe DMARC_FAIL_REJECT DMARC check failed (p=reject)
+score DMARC_FAIL_REJECT 10.0
+
+# Evaluate SPF Authentication-Results
+header SPF_PASS Authentication-Results =~ /$escapedprimaryhostname; spf=pass/
+describe SPF_PASS SPF check passed
+score SPF_PASS -0.1
+
+header SPF_NONE Authentication-Results =~ /$escapedprimaryhostname; spf=none/
+describe SPF_NONE SPF record not found
+score SPF_NONE 2.0
+
+header SPF_FAIL Authentication-Results =~ /$escapedprimaryhostname; spf=fail/
+describe SPF_FAIL SPF check failed
+score SPF_FAIL 5.0
+EOF
 
 # Bayesean learning
 # -----------------
@@ -83,7 +134,7 @@ tools/editconf.py /etc/spamassassin/local.cf -s \
 # Spamassassin will change the access rights back to the defaults, so we must also configure
 # the filemode in the config file.
 
-tools/editconf.py /etc/spamassassin/local.cf -s \
+management/editconf.py /etc/spamassassin/local.cf -s \
 	bayes_path=$STORAGE_ROOT/mail/spamassassin/bayes \
 	bayes_file_mode=0666
 
@@ -115,7 +166,7 @@ EOF
 # Have Dovecot run its mail process with a supplementary group (the spampd group)
 # so that it can access the learning files.
 
-tools/editconf.py /etc/dovecot/conf.d/10-mail.conf \
+management/editconf.py /etc/dovecot/conf.d/10-mail.conf \
 	mail_access_groups=spampd
 
 # Here's the script that the antispam plugin executes. It spools the message into

setup/ssl.sh

@@ -10,7 +10,7 @@
 #
 #  * DNSSEC DANE TLSA records
 #  * IMAP
-#  * SMTP (opportunistic TLS for port 25 and submission on port 587)
+#  * SMTP (opportunistic TLS for port 25 and submission on ports 465/587)
 #  * HTTPS
 #
 # The certificate is created with its CN set to the PRIMARY_HOSTNAME. It is
@@ -19,7 +19,7 @@
 #
 # The Diffie-Hellman cipher bits are used for SMTP and HTTPS, when a
 # Diffie-Hellman cipher is selected during TLS negotiation. Diffie-Hellman
-# provides Perfect Forward Secrecy. 
+# provides Perfect Forward Secrecy.
 
 source setup/functions.sh # load our functions
 source /etc/mailinabox.conf # load global vars
@@ -74,7 +74,7 @@ if [ ! -f $STORAGE_ROOT/ssl/ssl_certificate.pem ]; then
 	CSR=/tmp/ssl_cert_sign_req-$$.csr
 	hide_output \
 	openssl req -new -key $STORAGE_ROOT/ssl/ssl_private_key.pem -out $CSR \
-	  -sha256 -subj "/C=/ST=/L=/O=/CN=$PRIMARY_HOSTNAME"
+	  -sha256 -subj "/CN=$PRIMARY_HOSTNAME"
 
 	# Generate the self-signed certificate.
 	CERT=$STORAGE_ROOT/ssl/$PRIMARY_HOSTNAME-selfsigned-$(date --rfc-3339=date | sed s/-//g).pem

setup/start.sh

@@ -4,7 +4,7 @@
 
 source setup/functions.sh # load our functions
 
-# Check system setup: Are we running as root on Ubuntu 14.04 on a
+# Check system setup: Are we running as root on Ubuntu 18.04 on a
 # machine with enough memory? Is /tmp mounted with exec.
 # If not, this shows an error and exits.
 source setup/preflight.sh
@@ -14,9 +14,14 @@ source setup/preflight.sh
 # Python may not be able to read/write files. This is also
 # in the management daemon startup script and the cron script.
 
-if [ -z `locale -a | grep en_US.utf8` ]; then
+# Make sure we have locales at all (some images are THAT minimal)
+apt_get_quiet install locales
+
+if ! locale -a | grep en_US.utf8 > /dev/null; then
+	echo "Generating locales..."
     # Generate locale if not exists
-    hide_output locale-gen en_US.UTF-8
+	echo "en_US.UTF-8 UTF-8" >> /etc/locale.gen
+    hide_output locale-gen
 fi
 
 export LANGUAGE=en_US.UTF-8
@@ -44,12 +49,12 @@ fi
 
 # Put a start script in a global location. We tell the user to run 'mailinabox'
 # in the first dialog prompt, so we should do this before that starts.
-cat > /usr/local/bin/mailinabox << EOF;
+cat > /usr/local/sbin/mailinabox << EOF;
 #!/bin/bash
-cd `pwd`
+cd $(pwd)
 source setup/start.sh
 EOF
-chmod +x /usr/local/bin/mailinabox
+chmod 744 /usr/local/sbin/mailinabox
 
 # Ask the user for the PRIMARY_HOSTNAME, PUBLIC_IP, and PUBLIC_IPV6,
 # if values have not already been set in environment variables. When running
@@ -60,13 +65,17 @@ source setup/questions.sh
 # Run some network checks to make sure setup on this machine makes sense.
 # Skip on existing installs since we don't want this to block the ability to
 # upgrade, and these checks are also in the control panel status checks.
-if [ -z "$DEFAULT_PRIMARY_HOSTNAME" ]; then
-if [ -z "$SKIP_NETWORK_CHECKS" ]; then
+if [ -z "${DEFAULT_PRIMARY_HOSTNAME:-}" ]; then
+if [ -z "${SKIP_NETWORK_CHECKS:-}" ]; then
 	source setup/network-checks.sh
 fi
 fi
 
 # Create the STORAGE_USER and STORAGE_ROOT directory if they don't already exist.
+#
+# Set the directory and all of its parent directories' permissions to world
+# readable since it holds files owned by different processes.
+#
 # If the STORAGE_ROOT is missing the mailinabox.version file that lists a
 # migration (schema) number for the files stored there, assume this is a fresh
 # installation to that directory and write the file to contain the current
@@ -77,14 +86,19 @@ fi
 if [ ! -d $STORAGE_ROOT ]; then
 	mkdir -p $STORAGE_ROOT
 fi
+f=$STORAGE_ROOT
+while [[ $f != / ]]; do chmod a+rx "$f"; f=$(dirname "$f"); done;
 if [ ! -f $STORAGE_ROOT/mailinabox.version ]; then
-	echo $(setup/migrate.py --current) > $STORAGE_ROOT/mailinabox.version
+	setup/migrate.py --current > $STORAGE_ROOT/mailinabox.version
 	chown $STORAGE_USER.$STORAGE_USER $STORAGE_ROOT/mailinabox.version
 fi
 
+chmod 751 $STORAGE_ROOT
 
 # Save the global options in /etc/mailinabox.conf so that standalone
-# tools know where to look for data.
+# tools know where to look for data. The default MTA_STS_MODE setting
+# is blank unless set by an environment variable, but see web.sh for
+# how that is interpreted.
 cat > /etc/mailinabox.conf << EOF;
 STORAGE_USER=$STORAGE_USER
 STORAGE_ROOT=$STORAGE_ROOT
@@ -93,12 +107,16 @@ PUBLIC_IP=$PUBLIC_IP
 PUBLIC_IPV6=$PUBLIC_IPV6
 PRIVATE_IP=$PRIVATE_IP
 PRIVATE_IPV6=$PRIVATE_IPV6
+GNUPGHOME=${STORAGE_ROOT}/.gnupg/
+PGPKEY=${DEFAULT_PGPKEY-}
+MTA_STS_MODE=${DEFAULT_MTA_STS_MODE:-enforce}
 EOF
 
 # Start service configuration.
 source setup/system.sh
 source setup/ssl.sh
 source setup/dns.sh
+source setup/pgp.sh
 source setup/mail-postfix.sh
 source setup/mail-dovecot.sh
 source setup/mail-users.sh
@@ -106,11 +124,19 @@ source setup/dkim.sh
 source setup/spamassassin.sh
 source setup/web.sh
 source setup/webmail.sh
-source setup/owncloud.sh
+source setup/nextcloud.sh
 source setup/zpush.sh
 source setup/management.sh
 source setup/munin.sh
 
+# Create a shorthand alias for the cli interface
+cat > /usr/local/sbin/miabadm << EOF;
+#!/bin/bash
+cd $(pwd)
+/usr/bin/env python3 management/cli.py \$@
+EOF
+chmod 744 /usr/local/sbin/miabadm
+
 # Wait for the management daemon to start...
 until nc -z -w 4 127.0.0.1 10222
 do
@@ -127,13 +153,23 @@ tools/web_update
 # fail2ban was first configured, but they should exist now.
 restart_service fail2ban
 
-# If DNS is already working, try to provision TLS certficates from Let's Encrypt.
-# Suppress extra reasons why domains aren't getting a new certificate.
-management/ssl_certificates.py -q
-
 # If there aren't any mail users yet, create one.
 source setup/firstuser.sh
 
+# Register with Let's Encrypt, including agreeing to the Terms of Service.
+# We'd let certbot ask the user interactively, but when this script is
+# run in the recommended curl-pipe-to-bash method there is no TTY and
+# certbot will fail if it tries to ask.
+if [ ! -d $STORAGE_ROOT/ssl/lets_encrypt/accounts/acme-v02.api.letsencrypt.org/ ]; then
+echo
+echo "-----------------------------------------------"
+echo "Mail-in-a-Box uses Let's Encrypt to provision free SSL/TLS certificates"
+echo "to enable HTTPS connections to your box. We're automatically"
+echo "agreeing you to their subscriber agreement. See https://letsencrypt.org."
+echo
+certbot register --register-unsafely-without-email --agree-tos --config-dir $STORAGE_ROOT/ssl/lets_encrypt
+fi
+
 # Done.
 echo
 echo "-----------------------------------------------"

setup/system.sh

@@ -14,6 +14,22 @@ source setup/functions.sh # load our functions
 echo $PRIMARY_HOSTNAME > /etc/hostname
 hostname $PRIMARY_HOSTNAME
 
+# ### Enable IPv6 at Kernel Level
+
+# This doesn't mean that the cloud provider must provide IPv6 connectivity. We just want
+# the loopback interface to also work on IPv6 (that is, we want :: to be available). This
+# is required because apparently nsd expects this to exist.
+
+management/editconf.py /etc/sysctl.conf "net.ipv6.conf.lo.disable_ipv6 = 0"
+hide_output sysctl --system
+
+# ### Fix permissions
+
+# The default Ubuntu Bionic image on Scaleway throws warnings during setup about incorrect
+# permissions (group writeable) set on the following directories.
+
+chmod g-w /etc /etc/default /usr
+
 # ### Add swap space to the system
 
 # If the physical memory of the system is below 2GB it is wise to create a
@@ -37,9 +53,9 @@ hostname $PRIMARY_HOSTNAME
 # for reference
 
 SWAP_MOUNTED=$(cat /proc/swaps | tail -n+2)
-SWAP_IN_FSTAB=$(grep "swap" /etc/fstab)
-ROOT_IS_BTRFS=$(grep "\/ .*btrfs" /proc/mounts)
-TOTAL_PHYSICAL_MEM=$(head -n 1 /proc/meminfo | awk '{print $2}')
+SWAP_IN_FSTAB=$(grep "swap" /etc/fstab || /bin/true)
+ROOT_IS_BTRFS=$(grep "\/ .*btrfs" /proc/mounts || /bin/true)
+TOTAL_PHYSICAL_MEM=$(head -n 1 /proc/meminfo | awk '{print $2}' || /bin/true)
 AVAILABLE_DISK_SPACE=$(df / --output=avail | tail -n 1)
 if
 	[ -z "$SWAP_MOUNTED" ] &&
@@ -68,41 +84,33 @@ then
 	fi
 fi
 
-# ### Add Mail-in-a-Box's PPA.
+# ### Set log retention policy.
 
-# We've built several .deb packages on our own that we want to include.
-# One is a replacement for Ubuntu's stock postgrey package that makes
-# some enhancements. The other is dovecot-lucene, a Lucene-based full
-# text search plugin for (and by) dovecot, which is not available in
-# Ubuntu currently.
-#
-# So, first ensure add-apt-repository is installed, then use it to install
-# the [mail-in-a-box ppa](https://launchpad.net/~mail-in-a-box/+archive/ubuntu/ppa).
-
-
-if [ ! -f /usr/bin/add-apt-repository ]; then
-	echo "Installing add-apt-repository..."
-	hide_output apt-get update
-	apt_install software-properties-common
-fi
-
-hide_output add-apt-repository -y ppa:mail-in-a-box/ppa
+# Set the systemd journal log retention from infinite to 10 days,
+# since over time the logs take up a large amount of space.
+# (See https://discourse.mailinabox.email/t/journalctl-reclaim-space-on-small-mailinabox/6728/11.)
+management/editconf.py /etc/systemd/journald.conf MaxRetentionSec=10day
 
 # ### Update Packages
 
-# Update system packages to make sure we have the latest upstream versions of things from Ubuntu.
+# Update system packages to make sure we have the latest upstream versions
+# of things from Ubuntu, as well as the directory of packages provide by the
+# PPAs so we can install those packages later.
 
 echo Updating system packages...
 hide_output apt-get update
 apt_get_quiet upgrade
 
+# Old kernels pile up over time and take up a lot of disk space, and because of Mail-in-a-Box
+# changes there may be other packages that are no longer needed. Clear out anything apt knows
+# is safe to delete.
+
+apt_get_quiet autoremove
+
 # ### Install System Packages
 
 # Install basic utilities.
 #
-# * haveged: Provides extra entropy to /dev/random so it doesn't stall
-#	         when generating random numbers for private keys (e.g. during
-#	         ldns-keygen).
 # * unattended-upgrades: Apt tool to install security updates automatically.
 # * cron: Runs background processes periodically.
 # * ntp: keeps the system time correct
@@ -112,18 +120,19 @@ apt_get_quiet upgrade
 # * sudo: allows privileged users to execute commands as root without being root
 # * coreutils: includes `nproc` tool to report number of processors, mktemp
 # * bc: allows us to do math to compute sane defaults
+# * openssh-client: provides ssh-keygen
 
 echo Installing system packages...
-apt_install python3 python3-dev python3-pip \
-	netcat-openbsd wget curl git sudo coreutils bc \
-	haveged pollinate unzip \
-	unattended-upgrades cron ntp fail2ban
+apt_install python3 python3-dev python3-pip python3-setuptools \
+	netcat-openbsd wget curl git sudo coreutils bc file \
+	pollinate openssh-client unzip \
+	unattended-upgrades cron ntp fail2ban rsyslog
 
 # ### Suppress Upgrade Prompts
-# Since Mail-in-a-Box might jump straight to 18.04 LTS, there's no need
-# to be reminded about 16.04 on every login.
+# When Ubuntu 20 comes out, we don't want users to be prompted to upgrade,
+# because we don't yet support it.
 if [ -f /etc/update-manager/release-upgrades ]; then
-	tools/editconf.py /etc/update-manager/release-upgrades Prompt=never
+	management/editconf.py /etc/update-manager/release-upgrades Prompt=never
 	rm -f /var/lib/ubuntu-release-upgrader/release-upgrade-available
 fi
 
@@ -141,8 +150,8 @@ fi
 # section) and syslog (see #328). There might be other issues, and it's
 # not likely the user will want to change this, so we only ask on first
 # setup.
-if [ -z "$NONINTERACTIVE" ]; then
-	if [ ! -f /etc/timezone ] || [ ! -z $FIRST_TIME_SETUP ]; then
+if [ -z "${NONINTERACTIVE:-}" ]; then
+	if [ ! -f /etc/timezone ] || [ ! -z ${FIRST_TIME_SETUP:-} ]; then
 		# If the file is missing or this is the user's first time running
 		# Mail-in-a-Box setup, run the interactive timezone configuration
 		# tool.
@@ -168,7 +177,6 @@ fi
 # * DNSSEC signing keys (see `dns.sh`)
 # * our management server's API key (via Python's os.urandom method)
 # * Roundcube's SECRET_KEY (`webmail.sh`)
-# * ownCloud's administrator account password (`owncloud.sh`)
 #
 # Why /dev/urandom? It's the same as /dev/random, except that it doesn't wait
 # for a constant new stream of entropy. In practice, we only need a little
@@ -212,7 +220,11 @@ dd if=/dev/random of=/dev/urandom bs=1 count=32 2> /dev/null
 # is really any good on virtualized systems, we'll also seed from Ubuntu's
 # pollinate servers:
 
-pollinate  -q -r
+if ! pollinate -q -r --strict 2> /dev/null; then
+	# In the case pollinate is ill-configured (e.g. server is example.com), try using a server we know that works
+	# Even if this fails - don't bail and carry on.
+	pollinate -q -r -s entropy.ubuntu.com 2> /dev/null
+fi
 
 # Between these two, we really ought to be all set.
 
@@ -230,7 +242,7 @@ cat > /etc/apt/apt.conf.d/02periodic <<EOF;
 APT::Periodic::MaxAge "7";
 APT::Periodic::Update-Package-Lists "1";
 APT::Periodic::Unattended-Upgrade "1";
-APT::Periodic::Verbose "1";
+APT::Periodic::Verbose "0";
 EOF
 
 # ### Firewall
@@ -238,24 +250,27 @@ EOF
 # Various virtualized environments like Docker and some VPSs don't provide #NODOC
 # a kernel that supports iptables. To avoid error-like output in these cases, #NODOC
 # we skip this if the user sets DISABLE_FIREWALL=1. #NODOC
-if [ -z "$DISABLE_FIREWALL" ]; then
+if [ -z "${DISABLE_FIREWALL:-}" ]; then
 	# Install `ufw` which provides a simple firewall configuration.
 	apt_install ufw
 
-	# Allow incoming connections to SSH.
-	ufw_allow ssh;
+	# Check if we have got an SSH server installed.
+	# It's not critical for us to have one, so if it isn't installed,
+	# no need to open the port
+	if [ -x "$(command -v sshd)" ]; then
+		# Allow incoming connections to SSH.
+		ufw_limit ssh;
 
-	# ssh might be running on an alternate port. Use sshd -T to dump sshd's #NODOC
-	# settings, find the port it is supposedly running on, and open that port #NODOC
-	# too. #NODOC
-	SSH_PORT=$(sshd -T 2>/dev/null | grep "^port " | sed "s/port //") #NODOC
-	if [ ! -z "$SSH_PORT" ]; then
-	if [ "$SSH_PORT" != "22" ]; then
-
-	echo Opening alternate SSH port $SSH_PORT. #NODOC
-	ufw_allow $SSH_PORT #NODOC
-
-	fi
+		# ssh might be running on an alternate port. Use sshd -T to dump sshd's #NODOC
+		# settings, find the port it is supposedly running on, and open that port #NODOC
+		# too. #NODOC
+		SSH_PORT=$(sshd -T 2>/dev/null | grep "^port " | sed "s/port //") #NODOC
+		if [ ! -z "$SSH_PORT" ]; then
+			if [ "$SSH_PORT" != "22" ]; then
+				echo Opening alternate SSH port $SSH_PORT. #NODOC
+				ufw_limit $SSH_PORT #NODOC
+			fi
+		fi
 	fi
 
 	ufw --force enable;
@@ -263,51 +278,89 @@ fi #NODOC
 
 # ### Local DNS Service
 
-# Install a local DNS server, rather than using the DNS server provided by the
-# ISP's network configuration.
+# Install a local recursive DNS server --- i.e. for DNS queries made by
+# local services running on this machine.
 #
-# We do this to ensure that DNS queries
-# that *we* make (i.e. looking up other external domains) perform DNSSEC checks.
-# We could use Google's Public DNS, but we don't want to create a dependency on
-# Google per our goals of decentralization. `bind9`, as packaged for Ubuntu, has
-# DNSSEC enabled by default via "dnssec-validation auto".
+# (This is unrelated to the box's public, non-recursive DNS server that
+# answers remote queries about domain names hosted on this box. For that
+# see dns.sh.)
 #
-# So we'll be running `bind9` bound to 127.0.0.1 for locally-issued DNS queries
-# and `nsd` bound to the public ethernet interface for remote DNS queries asking
-# about our domain names. `nsd` is configured later.
+# The default systemd-resolved service provides local DNS name resolution. By default it
+# is a recursive stub nameserver, which means it simply relays requests to an
+# external nameserver, usually provided by your ISP or configured in /etc/systemd/resolved.conf.
+#
+# This won't work for us for three reasons.
+#
+# 1) We have higher security goals --- we want DNSSEC to be enforced on all
+#    DNS queries (some upstream DNS servers do, some don't).
+# 2) We will configure postfix to use DANE, which uses DNSSEC to find TLS
+#    certificates for remote servers. DNSSEC validation *must* be performed
+#    locally because we can't trust an unencrypted connection to an external
+#    DNS server.
+# 3) DNS-based mail server blacklists (RBLs) typically block large ISP
+#    DNS servers because they only provide free data to small users. Since
+#    we use RBLs to block incoming mail from blacklisted IP addresses,
+#    we have to run our own DNS server. See #1424.
+#
+# systemd-resolved has a setting to perform local DNSSEC validation on all
+# requests (in /etc/systemd/resolved.conf, set DNSSEC=yes), but because it's
+# a stub server the main part of a request still goes through an upstream
+# DNS server, which won't work for RBLs. So we really need a local recursive
+# nameserver.
+#
+# We'll install `bind9`, which as packaged for Ubuntu, has DNSSEC enabled by default via "dnssec-validation auto".
+# We'll have it be bound to 127.0.0.1 so that it does not interfere with
+# the public, recursive nameserver `nsd` bound to the public ethernet interfaces.
 #
 # About the settings:
 #
-# * RESOLVCONF=yes will have `bind9` take over /etc/resolv.conf to tell
-#   local services that DNS queries are handled on localhost.
 # * Adding -4 to OPTIONS will have `bind9` not listen on IPv6 addresses
 #   so that we're sure there's no conflict with nsd, our public domain
 #   name server, on IPV6.
 # * The listen-on directive in named.conf.options restricts `bind9` to
 #   binding to the loopback interface instead of all interfaces.
-apt_install bind9 resolvconf
-tools/editconf.py /etc/default/bind9 \
-	RESOLVCONF=yes \
+# * The max-recursion-queries directive increases the maximum number of iterative queries.
+#  	If more queries than specified are sent, bind9 returns SERVFAIL. After flushing the cache during system checks,
+#	we ran into the limit thus we are increasing it from 75 (default value) to 100.
+apt_install bind9
+touch /etc/default/bind9
+touch /etc/default/named
+management/editconf.py /etc/default/bind9 \
 	"OPTIONS=\"-u bind -4\""
+management/editconf.py /etc/default/named \
+	"OPTIONS=\"-u bind -4\""
+
 if ! grep -q "listen-on " /etc/bind/named.conf.options; then
 	# Add a listen-on directive if it doesn't exist inside the options block.
 	sed -i "s/^}/\n\tlisten-on { 127.0.0.1; };\n}/" /etc/bind/named.conf.options
 fi
-if [ -f /etc/resolvconf/resolv.conf.d/original ]; then
-	echo "Archiving old resolv.conf (was /etc/resolvconf/resolv.conf.d/original, now /etc/resolvconf/resolv.conf.original)." #NODOC
-	mv /etc/resolvconf/resolv.conf.d/original /etc/resolvconf/resolv.conf.original #NODOC
+if ! grep -q "max-recursion-queries " /etc/bind/named.conf.options; then
+	# Add a max-recursion-queries directive if it doesn't exist inside the options block.
+	sed -i "s/^}/\n\tmax-recursion-queries 100;\n}/" /etc/bind/named.conf.options
 fi
 
+# First we'll disable systemd-resolved's management of resolv.conf and its stub server.
+# Breaking the symlink to /run/systemd/resolve/stub-resolv.conf means
+# systemd-resolved will read it for DNS servers to use. Put in 127.0.0.1,
+# which is where bind9 will be running. Obviously don't do this before
+# installing bind9 or else apt won't be able to resolve a server to
+# download bind9 from.
+rm -f /etc/resolv.conf
+management/editconf.py /etc/systemd/resolved.conf DNSStubListener=no
+echo "nameserver 127.0.0.1" > /etc/resolv.conf
+
 # Restart the DNS services.
 
 restart_service bind9
-restart_service resolvconf
+systemctl restart systemd-resolved
 
 # ### Fail2Ban Service
 
 # Configure the Fail2Ban installation to prevent dumb bruce-force attacks against dovecot, postfix, ssh, etc.
 rm -f /etc/fail2ban/jail.local # we used to use this file but don't anymore
+rm -f /etc/fail2ban/jail.d/defaults-debian.conf # removes default config so we can manage all of fail2ban rules in one config
 cat conf/fail2ban/jails.conf \
+    | sed "s/PUBLIC_IPV6/$PUBLIC_IPV6/g" \
 	| sed "s/PUBLIC_IP/$PUBLIC_IP/g" \
 	| sed "s#STORAGE_ROOT#$STORAGE_ROOT#" \
 	> /etc/fail2ban/jail.d/mailinabox.conf

setup/web.sh

@@ -18,7 +18,8 @@ fi
 # Turn off nginx's default website.
 
 echo "Installing Nginx (web server)..."
-apt_install nginx php5-fpm
+
+apt_install nginx php-cli php-fpm idn2
 
 rm -f /etc/nginx/sites-enabled/default
 
@@ -30,26 +31,77 @@ sed "s#STORAGE_ROOT#$STORAGE_ROOT#" \
 	conf/nginx-ssl.conf > /etc/nginx/conf.d/ssl.conf
 
 # Fix some nginx defaults.
+#
 # The server_names_hash_bucket_size seems to prevent long domain names!
 # The default, according to nginx's docs, depends on "the size of the
 # processor’s cache line." It could be as low as 32. We fixed it at
 # 64 in 2014 to accommodate a long domain name (20 characters?). But
 # even at 64, a 58-character domain name won't work (#93), so now
 # we're going up to 128.
-tools/editconf.py /etc/nginx/nginx.conf -s \
-	server_names_hash_bucket_size="128;"
+#
+# Drop TLSv1.0, TLSv1.1, following the Mozilla "Intermediate" recommendations
+# at https://ssl-config.mozilla.org/#server=nginx&server-version=1.17.0&config=intermediate&openssl-version=1.1.1.
+management/editconf.py /etc/nginx/nginx.conf -s \
+	server_names_hash_bucket_size="128;" \
+	ssl_protocols="TLSv1.2 TLSv1.3;"
 
 # Tell PHP not to expose its version number in the X-Powered-By header.
-tools/editconf.py /etc/php5/fpm/php.ini -c ';' \
+management/editconf.py /etc/php/$(php_version)/fpm/php.ini -c ';' \
 	expose_php=Off
 
 # Set PHPs default charset to UTF-8, since we use it. See #367.
-tools/editconf.py /etc/php5/fpm/php.ini -c ';' \
+management/editconf.py /etc/php/$(php_version)/fpm/php.ini -c ';' \
         default_charset="UTF-8"
 
-# Bump up PHP's max_children to support more concurrent connections
-tools/editconf.py /etc/php5/fpm/pool.d/www.conf -c ';' \
-	pm.max_children=8
+# Configure the path environment for php-fpm
+management/editconf.py /etc/php/$(php_version)/fpm/pool.d/www.conf -c ';' \
+	env[PATH]=/usr/local/bin:/usr/bin:/bin \
+
+# Configure php-fpm based on the amount of memory the machine has
+# This is based on the nextcloud manual for performance tuning: https://docs.nextcloud.com/server/17/admin_manual/installation/server_tuning.html
+# Some synchronisation issues can occur when many people access the site at once.
+# The pm=ondemand setting is used for memory constrained machines < 2GB, this is copied over from PR: 1216
+TOTAL_PHYSICAL_MEM=$(head -n 1 /proc/meminfo | awk '{print $2}' || /bin/true)
+if [ $TOTAL_PHYSICAL_MEM -lt 1000000 ]
+then
+        management/editconf.py /etc/php/$(php_version)/fpm/pool.d/www.conf -c ';' \
+                pm=ondemand \
+                pm.max_children=8 \
+                pm.start_servers=2 \
+                pm.min_spare_servers=1 \
+                pm.max_spare_servers=3
+elif [ $TOTAL_PHYSICAL_MEM -lt 2000000 ]
+then
+        management/editconf.py /etc/php/$(php_version)/fpm/pool.d/www.conf -c ';' \
+                pm=ondemand \
+                pm.max_children=16 \
+                pm.start_servers=4 \
+                pm.min_spare_servers=1 \
+                pm.max_spare_servers=6
+elif [ $TOTAL_PHYSICAL_MEM -lt 3000000 ]
+then
+        management/editconf.py /etc/php/$(php_version)/fpm/pool.d/www.conf -c ';' \
+                pm=dynamic \
+                pm.max_children=60 \
+                pm.start_servers=6 \
+                pm.min_spare_servers=3 \
+                pm.max_spare_servers=9
+else
+        management/editconf.py /etc/php/$(php_version)/fpm/pool.d/www.conf -c ';' \
+                pm=dynamic \
+                pm.max_children=120 \
+                pm.start_servers=12 \
+                pm.min_spare_servers=6 \
+                pm.max_spare_servers=18
+fi
+
+# Duplicate the socket to isolate MiaB apps from user apps that happen to run php
+cp /etc/php/$(php_version)/fpm/pool.d/www.conf /etc/php/$(php_version)/fpm/pool.d/miab.conf
+
+management/editconf.py /etc/php/$(php_version)/fpm/pool.d/miab.conf -c ';' \
+        listen=/run/php/php-default.sock
+
+sed -i 's/\[www\]/[miab]/' /etc/php/$(php_version)/fpm/pool.d/miab.conf
 
 # Other nginx settings will be configured by the management service
 # since it depends on what domains we're serving, which we don't know
@@ -78,34 +130,36 @@ cat conf/mozilla-autoconfig.xml \
 	 > /var/lib/mailinabox/mozilla-autoconfig.xml
 chmod a+r /var/lib/mailinabox/mozilla-autoconfig.xml
 
+# Create a generic mta-sts.txt file which is exposed via the
+# nginx configuration at /.well-known/mta-sts.txt
+# more documentation is available on:
+# https://www.uriports.com/blog/mta-sts-explained/
+# default mode is "enforce". In /etc/mailinabox.conf change
+# "MTA_STS_MODE=testing" which means "Messages will be delivered
+# as though there was no failure but a report will be sent if
+# TLS-RPT is configured" if you are not sure you want this yet. Or "none".
+PUNY_PRIMARY_HOSTNAME=$(echo "$PRIMARY_HOSTNAME" | idn2)
+cat conf/mta-sts.txt \
+        | sed "s/MODE/${MTA_STS_MODE}/" \
+        | sed "s/PRIMARY_HOSTNAME/$PUNY_PRIMARY_HOSTNAME/" \
+         > /var/lib/mailinabox/mta-sts.txt
+chmod a+r /var/lib/mailinabox/mta-sts.txt
+
 # make a default homepage
 if [ -d $STORAGE_ROOT/www/static ]; then mv $STORAGE_ROOT/www/static $STORAGE_ROOT/www/default; fi # migration #NODOC
 mkdir -p $STORAGE_ROOT/www/default
 if [ ! -f $STORAGE_ROOT/www/default/index.html ]; then
-	cp conf/www_default.html $STORAGE_ROOT/www/default/index.html
+	sed "s/{{PRIMARY_HOSTNAME}}/$PRIMARY_HOSTNAME/" conf/www_default.html | sed "s#{{STORAGE_ROOT}}#$STORAGE_ROOT#" > $STORAGE_ROOT/www/default/index.html
 fi
 chown -R $STORAGE_USER $STORAGE_ROOT/www
 
-# We previously installed a custom init script to start the PHP FastCGI daemon. #NODOC
-# Remove it now that we're using php5-fpm. #NODOC
-if [ -L /etc/init.d/php-fastcgi ]; then
-	echo "Removing /etc/init.d/php-fastcgi, php5-cgi..." #NODOC
-	rm -f /etc/init.d/php-fastcgi #NODOC
-	hide_output update-rc.d php-fastcgi remove #NODOC
-	apt-get -y purge php5-cgi #NODOC
-fi
-
-# Remove obsoleted scripts. #NODOC
-# exchange-autodiscover is now handled by Z-Push. #NODOC
-for f in webfinger exchange-autodiscover; do #NODOC
-	rm -f /usr/local/bin/mailinabox-$f.php #NODOC
-done #NODOC
-
 # Start services.
 restart_service nginx
-restart_service php5-fpm
+restart_service php$(php_version)-fpm
 
 # Open ports.
 ufw_allow http
 ufw_allow https
 
+# Allow the webserver to access directories group-owned by user-data
+usermod -a -G user-data www-data

setup/webmail.sh

@@ -22,27 +22,27 @@ source /etc/mailinabox.conf # load global vars
 echo "Installing Roundcube (webmail)..."
 apt_install \
 	dbconfig-common \
-	php5 php5-sqlite php5-mcrypt php5-intl php5-json php5-common php-auth php-net-smtp php-net-socket php-net-sieve php-mail-mime php-crypt-gpg php5-gd php5-pspell \
-	tinymce libjs-jquery libjs-jquery-mousewheel libmagic1
-apt_get_quiet remove php-mail-mimedecode # no longer needed since Roundcube 1.1.3
-
-# We used to install Roundcube from Ubuntu, without triggering the dependencies #NODOC
-# on Apache and MySQL, by downloading the debs and installing them manually. #NODOC
-# Now that we're beyond that, get rid of those debs before installing from source. #NODOC
-apt-get purge -qq -y roundcube* #NODOC
+	php-cli php-sqlite3 php-intl php-json php-common php-curl php-ldap \
+	php-gd php-pspell libjs-jquery libjs-jquery-mousewheel libmagic1 php-mbstring php-gnupg
 
 # Install Roundcube from source if it is not already present or if it is out of date.
-# Combine the Roundcube version number with the commit hash of vacation_sieve to track
-# whether we have the latest version.
-VERSION=1.2.4
-HASH=e2091ea775b80eda43ab225130d5a2e888c3789a
-VACATION_SIEVE_VERSION=91ea6f52216390073d1f5b70b5f6bea0bfaee7e5
-PERSISTENT_LOGIN_VERSION=c4516c4be37d12ef653de86497304e073a863c2a
-HTML5_NOTIFIER_VERSION=4b370e3cd60dabd2f428a26f45b677ad1b7118d5
-CARDDAV_VERSION=2.0.4
-CARDDAV_HASH=d93f3cfb3038a519e71c7c3212c1d16f5da609a4
+# Combine the Roundcube version number with the commit hash of plugins to track
+# whether we have the latest version of everything.
+# For the latest versions, see:
+#   https://github.com/roundcube/roundcubemail/releases
+#   https://github.com/mfreiholz/persistent_login/
+#   https://github.com/stremlau/html5_notifier/
+#   https://github.com/mstilkerich/rcmcarddav/releases
+# The easiest way to get the package hashes is to run this script and get the hash from
+# the error message.
+VERSION=1.6.0
+HASH=fd84b4fac74419bb73e7a3bcae1978d5589c52de
+PERSISTENT_LOGIN_VERSION=version-5.3.0
+HTML5_NOTIFIER_VERSION=68d9ca194212e15b3c7225eb6085dbcf02fd13d7 # version 0.6.4+
+CARDDAV_VERSION=4.4.4
+CARDDAV_HASH=743fd6925b775f821aa8860982d2bdeec05f5d7b
 
-UPDATE_KEY=$VERSION:$VACATION_SIEVE_VERSION:$PERSISTENT_LOGIN_VERSION:$HTML5_NOTIFIER_VERSION:$CARDDAV_VERSION:a
+UPDATE_KEY=$VERSION:$PERSISTENT_LOGIN_VERSION:$HTML5_NOTIFIER_VERSION:$CARDDAV_VERSION
 
 # paths that are often reused.
 RCM_DIR=/usr/local/lib/roundcubemail
@@ -53,14 +53,21 @@ needs_update=0 #NODOC
 if [ ! -f /usr/local/lib/roundcubemail/version ]; then
 	# not installed yet #NODOC
 	needs_update=1 #NODOC
-elif [[ "$UPDATE_KEY" != `cat /usr/local/lib/roundcubemail/version` ]]; then
+elif [[ "$UPDATE_KEY" != $(cat /usr/local/lib/roundcubemail/version) ]]; then
 	# checks if the version is what we want
 	needs_update=1 #NODOC
 fi
 if [ $needs_update == 1 ]; then
+  # if upgrading from 1.3.x, clear the temp_dir
+  if [ -f /usr/local/lib/roundcubemail/version ]; then
+    if [ "$(cat /usr/local/lib/roundcubemail/version | cut -c1-3)" == '1.3' ]; then
+      find /var/tmp/roundcubemail/ -type f ! -name 'RCMTEMP*' -delete
+    fi
+  fi
+
 	# install roundcube
 	wget_verify \
-		https://github.com/roundcube/roundcubemail/releases/download/$VERSION/roundcubemail-$VERSION.tar.gz \
+		https://github.com/roundcube/roundcubemail/releases/download/$VERSION/roundcubemail-$VERSION-complete.tar.gz \
 		$HASH \
 		/tmp/roundcube.tgz
 	tar -C /usr/local/lib --no-same-owner -zxf /tmp/roundcube.tgz
@@ -68,24 +75,21 @@ if [ $needs_update == 1 ]; then
 	mv /usr/local/lib/roundcubemail-$VERSION/ $RCM_DIR
 	rm -f /tmp/roundcube.tgz
 
-	# install roundcube autoreply/vacation plugin
-	git_clone https://github.com/arodier/Roundcube-Plugins.git $VACATION_SIEVE_VERSION plugins/vacation_sieve ${RCM_PLUGIN_DIR}/vacation_sieve
-
 	# install roundcube persistent_login plugin
-	git_clone https://github.com/mfreiholz/Roundcube-Persistent-Login-Plugin.git $PERSISTENT_LOGIN_VERSION '' ${RCM_PLUGIN_DIR}/persistent_login
+	git_clone https://github.com/mfreiholz/persistent_login.git $PERSISTENT_LOGIN_VERSION '' ${RCM_PLUGIN_DIR}/persistent_login
 
 	# install roundcube html5_notifier plugin
 	git_clone https://github.com/kitist/html5_notifier.git $HTML5_NOTIFIER_VERSION '' ${RCM_PLUGIN_DIR}/html5_notifier
 
 	# download and verify the full release of the carddav plugin
 	wget_verify \
-		https://github.com/blind-coder/rcmcarddav/releases/download/v${CARDDAV_VERSION}/carddav-${CARDDAV_VERSION}.zip \
+		https://github.com/mstilkerich/rcmcarddav/releases/download/v${CARDDAV_VERSION}/carddav-v${CARDDAV_VERSION}.tar.gz \
 		$CARDDAV_HASH \
-		/tmp/carddav.zip
+		/tmp/carddav.tar.gz
 
 	# unzip and cleanup
-	unzip -q /tmp/carddav.zip -d ${RCM_PLUGIN_DIR}
-	rm -f /tmp/carddav.zip
+	tar -C ${RCM_PLUGIN_DIR} -zxf /tmp/carddav.tar.gz
+	rm -f /tmp/carddav.tar.gz
 
 	# record the version we've installed
 	echo $UPDATE_KEY > ${RCM_DIR}/version
@@ -93,8 +97,9 @@ fi
 
 # ### Configuring Roundcube
 
-# Generate a safe 24-character secret key of safe characters.
-SECRET_KEY=$(dd if=/dev/urandom bs=1 count=18 2>/dev/null | base64 | fold -w 24 | head -n 1)
+# Generate a secret key of PHP-string-safe characters appropriate
+# for the cipher algorithm selected below.
+SECRET_KEY=$(dd if=/dev/urandom bs=1 count=32 2>/dev/null | base64 | sed s/=//g)
 
 # Create a configuration file.
 #
@@ -108,23 +113,67 @@ cat > $RCM_CONFIG <<EOF;
  */
 \$config = array();
 \$config['log_dir'] = '/var/log/roundcubemail/';
-\$config['temp_dir'] = '/tmp/roundcubemail/';
+\$config['temp_dir'] = '/var/tmp/roundcubemail/';
 \$config['db_dsnw'] = 'sqlite:///$STORAGE_ROOT/mail/roundcube/roundcube.sqlite?mode=0640';
-\$config['default_host'] = 'ssl://localhost';
-\$config['default_port'] = 993;
+\$config['imap_host'] = 'ssl://localhost:993';
+\$config['imap_conn_options'] = array(
+	'ssl'=> array(
+		'verify_peer'  => false,
+		'verify_peer_name'  => false,
+	),
+);
 \$config['imap_timeout'] = 15;
-\$config['smtp_server'] = 'tls://127.0.0.1';
-\$config['smtp_port'] = 587;
-\$config['smtp_user'] = '%u';
-\$config['smtp_pass'] = '%p';
-\$config['support_url'] = 'https://mailinabox.email/';
+\$config['smtp_host'] = 'tls://127.0.0.1:587';
+\$config['smtp_conn_options'] = array(
+	'ssl'=> array(
+		'verify_peer'  => false,
+		'verify_peer_name'  => false,
+	),
+);
+\$config['support_url'] = 'https://power-mailinabox.net/';
 \$config['product_name'] = '$PRIMARY_HOSTNAME Webmail';
-\$config['des_key'] = '$SECRET_KEY';
-\$config['plugins'] = array('html5_notifier', 'archive', 'zipdownload', 'password', 'managesieve', 'jqueryui', 'vacation_sieve', 'persistent_login', 'carddav');
-\$config['skin'] = 'larry';
+\$config['plugins'] = array('html5_notifier', 'archive', 'zipdownload', 'password', 'managesieve', 'jqueryui', 'persistent_login', 'carddav', 'enigma');
+\$config['cipher_method'] = 'AES-256-CBC'; # persistent login cookie and potentially other things
+\$config['des_key'] = '$SECRET_KEY'; # 37 characters -> ~256 bits for AES-256, see above
+\$config['skin'] = 'elastic';
 \$config['login_autocomplete'] = 2;
+\$config['login_username_filter'] = 'email';
 \$config['password_charset'] = 'UTF-8';
 \$config['junk_mbox'] = 'Spam';
+
+/* ensure roudcube session id's aren't leaked to other parts of the server */
+\$config['session_path'] = '/mail/';
+/* prevent CSRF, requires php 7.3+ */
+\$config['session_samesite'] = 'Strict';
+\$config['quota_zero_as_unlimited'] = true;
+EOF
+
+mkdir -p ${STORAGE_ROOT}/.enigma/
+chmod 700 ${STORAGE_ROOT}/.enigma/
+chown www-data:www-data ${STORAGE_ROOT}/.enigma/
+
+# Configure Enigma
+cat > ${RCM_PLUGIN_DIR}/enigma/config.inc.php <<EOF;
+<?php
+/* Do not edit. Written by Mail-in-a-Box. Regenerated on updates. */
+\$config['enigma_pgp_driver'] = 'gnupg';
+\$config['enigma_smime_driver'] = 'phpssl';
+\$config['enigma_debug'] = false;
+\$config['enigma_pgp_homedir'] = '${STORAGE_ROOT}/.enigma/';
+\$config['enigma_pgp_binary'] = '';
+\$config['enigma_pgp_agent'] = '';
+\$config['enigma_pgp_gpgconf'] = '';
+\$config['enigma_pgp_cipher_algo'] = null;
+\$config['enigma_pgp_digest_algo'] = null;
+\$config['enigma_multihost'] = false;
+\$config['enigma_signatures'] = true;
+\$config['enigma_decryption'] = true;
+\$config['enigma_encryption'] = true;
+\$config['enigma_sign_all'] = false;
+\$config['enigma_encrypt_all'] = false;
+\$config['enigma_attach_pubkey'] = false;
+\$config['enigma_password_time'] = 5;
+\$config['enigma_options_lock'] = array();
 ?>
 EOF
 
@@ -138,7 +187,7 @@ cat > ${RCM_PLUGIN_DIR}/carddav/config.inc.php <<EOF;
 	 'name'         =>  'ownCloud',
 	 'username'     =>  '%u', // login username
 	 'password'     =>  '%p', // login password
-	 'url'          =>  'https://${PRIMARY_HOSTNAME}/cloud/remote.php/carddav/addressbooks/%u/contacts',
+	 'url'          =>  'https://${PRIMARY_HOSTNAME}/cloud/remote.php/dav/addressbooks/users/%u/contacts/',
 	 'active'       =>  true,
 	 'readonly'     =>  false,
 	 'refresh_time' => '02:00:00',
@@ -146,34 +195,15 @@ cat > ${RCM_PLUGIN_DIR}/carddav/config.inc.php <<EOF;
 	 'preemptive_auth' => '1',
 	 'hide'        =>  false,
 );
-EOF
-
-# Configure vaction_sieve.
-cat > /usr/local/lib/roundcubemail/plugins/vacation_sieve/config.inc.php <<EOF;
-<?php
-/* Do not edit. Written by Mail-in-a-Box. Regenerated on updates. */
-\$rcmail_config['vacation_sieve'] = array(
-    'date_format' => 'd/m/Y',
-    'working_hours' => array(8,18),
-    'msg_format' => 'text',
-    'logon_transform' => array('#([a-z])[a-z]+(\.|\s)([a-z])#i', '\$1\$3'),
-    'transfer' => array(
-        'mode' =>  'managesieve',
-        'ms_activate_script' => true,
-        'host'   => '127.0.0.1',
-        'port'   => '4190',
-        'usetls' => false,
-        'path' => 'vacation',
-    )
-);
+?>
 EOF
 
 # Create writable directories.
-mkdir -p /var/log/roundcubemail /tmp/roundcubemail $STORAGE_ROOT/mail/roundcube
-chown -R www-data.www-data /var/log/roundcubemail /tmp/roundcubemail $STORAGE_ROOT/mail/roundcube
+mkdir -p /var/log/roundcubemail /var/tmp/roundcubemail $STORAGE_ROOT/mail/roundcube
+chown -R www-data.www-data /var/log/roundcubemail /var/tmp/roundcubemail $STORAGE_ROOT/mail/roundcube
 
 # Ensure the log file monitored by fail2ban exists, or else fail2ban can't start.
-sudo -u www-data touch /var/log/roundcubemail/errors
+sudo -u www-data touch /var/log/roundcubemail/errors.log
 
 # Password changing plugin settings
 # The config comes empty by default, so we need the settings
@@ -181,13 +211,12 @@ sudo -u www-data touch /var/log/roundcubemail/errors
 cp ${RCM_PLUGIN_DIR}/password/config.inc.php.dist \
 	${RCM_PLUGIN_DIR}/password/config.inc.php
 
-tools/editconf.py ${RCM_PLUGIN_DIR}/password/config.inc.php \
-	"\$config['password_minimum_length']=8;" \
-	"\$config['password_db_dsn']='sqlite:///$STORAGE_ROOT/mail/users.sqlite';" \
-	"\$config['password_query']='UPDATE users SET password=%D WHERE email=%u';" \
-	"\$config['password_dovecotpw']='/usr/bin/doveadm pw';" \
-	"\$config['password_dovecotpw_method']='SHA512-CRYPT';" \
-	"\$config['password_dovecotpw_with_method']=true;"
+management/editconf.py ${RCM_PLUGIN_DIR}/password/config.inc.php -c "//" \
+	"\$config['password_driver'] = 'miab';" \
+	"\$config['password_minimum_length'] = 8;" \
+	"\$config['password_miab_url'] = 'http://127.0.0.1:10222/';" \
+	"\$config['password_miab_user'] = '';" \
+	"\$config['password_miab_pass'] = '';"
 
 # so PHP can use doveadm, for the password changing plugin
 usermod -a -G dovecot www-data
@@ -205,10 +234,10 @@ chown -f -R root.www-data ${RCM_PLUGIN_DIR}/carddav
 chmod -R 774 ${RCM_PLUGIN_DIR}/carddav
 
 # Run Roundcube database migration script (database is created if it does not exist)
-${RCM_DIR}/bin/updatedb.sh --dir ${RCM_DIR}/SQL --package roundcube
+php ${RCM_DIR}/bin/updatedb.sh --dir ${RCM_DIR}/SQL --package roundcube
 chown www-data:www-data $STORAGE_ROOT/mail/roundcube/roundcube.sqlite
 chmod 664 $STORAGE_ROOT/mail/roundcube/roundcube.sqlite
 
 # Enable PHP modules.
-php5enmod mcrypt
-restart_service php5-fpm
+phpenmod -v php mcrypt imap
+restart_service php$(php_version)-fpm