mirror of
https://github.com/mail-in-a-box/mailinabox.git
synced 2026-03-12 17:07:23 +01:00
Compare commits
152 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f3ad6b4acc | ||
|
|
ec039719de | ||
|
|
14b16b2f36 | ||
|
|
cbc7e280d6 | ||
|
|
f4fa9c93a0 | ||
|
|
6c64723d7c | ||
|
|
3d21f2223e | ||
|
|
710a69b812 | ||
|
|
dd6a8d9998 | ||
|
|
9f32e5af0a | ||
|
|
298e19598b | ||
|
|
680191d7cb | ||
|
|
81d6d69b85 | ||
|
|
6df72bf4ac | ||
|
|
01f2451349 | ||
|
|
dcd971d079 | ||
|
|
4d22fb9b2a | ||
|
|
c18d58b13f | ||
|
|
b539c2df70 | ||
|
|
64fdb4ddc1 | ||
|
|
a8669197dd | ||
|
|
2412c92772 | ||
|
|
7c0ca42145 | ||
|
|
c443524ee2 | ||
|
|
e2fa01e0cf | ||
|
|
6558f05d1d | ||
|
|
1be0f39be0 | ||
|
|
d01001f2a5 | ||
|
|
7c85694d60 | ||
|
|
b2fcd4c9e5 | ||
|
|
ba8123f08a | ||
|
|
e2879a8eb1 | ||
|
|
eab8652225 | ||
|
|
ead6f96513 | ||
|
|
7ec662c83f | ||
|
|
348d2b8701 | ||
|
|
12f0dcb23b | ||
|
|
449a538e6b | ||
|
|
3c50c9a18b | ||
|
|
3c10ec70a5 | ||
|
|
1a59f343c0 | ||
|
|
fba4d4702e | ||
|
|
143bbf37f4 | ||
|
|
fd3ad267ba | ||
|
|
330583f71d | ||
|
|
d775f90f0c | ||
|
|
e096144713 | ||
|
|
7ce30ba888 | ||
|
|
6a3ec1d874 | ||
|
|
575d3a66c6 | ||
|
|
cc333b3965 | ||
|
|
351758b3bd | ||
|
|
94053d8432 | ||
|
|
e14b2826e0 | ||
|
|
150611123a | ||
|
|
abfc17ee62 | ||
|
|
97be9c94b9 | ||
|
|
21b00e8fbb | ||
|
|
01636c2e4b | ||
|
|
005315cd29 | ||
|
|
20d20df829 | ||
|
|
f945a1bc6b | ||
|
|
3a09b04786 | ||
|
|
82e752395b | ||
|
|
e330abd587 | ||
|
|
16422b4055 | ||
|
|
b9ca74c915 | ||
|
|
7e05d7478f | ||
|
|
8fd98d7db3 | ||
|
|
1039a08be6 | ||
|
|
023b38df50 | ||
|
|
3187053b3a | ||
|
|
a3e526e818 | ||
|
|
f6d4621834 | ||
|
|
d075113c1a | ||
|
|
63f2abd923 | ||
|
|
624cc7876a | ||
|
|
d3059c810f | ||
|
|
85a40da83c | ||
|
|
1bf8f1991f | ||
|
|
d155aa8745 | ||
|
|
c0bfd6d15f | ||
|
|
24cc108147 | ||
|
|
b02d7d990e | ||
|
|
87f82addbc | ||
|
|
09713e8eab | ||
|
|
0aa3941832 | ||
|
|
fea77e41df | ||
|
|
74ef9ab7c5 | ||
|
|
6499c82d7f | ||
|
|
80e97feee2 | ||
|
|
fddab5d432 | ||
|
|
c4e4805160 | ||
|
|
c75950125d | ||
|
|
f141af4b61 | ||
|
|
3d8ea0e6ed | ||
|
|
6efeff6fce | ||
|
|
399f9d9bdf | ||
|
|
2b76fd299e | ||
|
|
90592bb157 | ||
|
|
5cf38b950a | ||
|
|
3bc5361491 | ||
|
|
c3a7e3413b | ||
|
|
d390bfb215 | ||
|
|
ceba53f1c4 | ||
|
|
be59bcd47d | ||
|
|
cfe0fa912a | ||
|
|
31d6128a2b | ||
|
|
82cf5b72e4 | ||
|
|
8ec8c42441 | ||
|
|
7e36e1fd90 | ||
|
|
a7710e9058 | ||
|
|
3133dcd5a3 | ||
|
|
057c1dd913 | ||
|
|
06f2477cfd | ||
|
|
1abc8ed469 | ||
|
|
cdaa2c847d | ||
|
|
b04addda9a | ||
|
|
7e7abf3b53 | ||
|
|
9b9f5abf8f | ||
|
|
7db80458dd | ||
|
|
5775cab175 | ||
|
|
c872e6a9f0 | ||
|
|
995b7c4d2b | ||
|
|
f797eecaca | ||
|
|
de0ccd0632 | ||
|
|
be9d97902f | ||
|
|
20c5471a89 | ||
|
|
ec73c171c7 | ||
|
|
f9acf0adec | ||
|
|
8b65c11cdf | ||
|
|
34fca29dd3 | ||
|
|
b75fbf22ca | ||
|
|
d790cae0e2 | ||
|
|
a68703dfb3 | ||
|
|
f35b2081a1 | ||
|
|
f0508d8cc9 | ||
|
|
47dd59c2a7 | ||
|
|
c2fe1bc2e3 | ||
|
|
cce1184090 | ||
|
|
1adb1d8307 | ||
|
|
c2174e10a6 | ||
|
|
18283c7df0 | ||
|
|
3ff74c8dc5 | ||
|
|
e997114d6e | ||
|
|
e9aecba4df | ||
|
|
6585384daa | ||
|
|
6bc821676c | ||
|
|
f38ef0223d | ||
|
|
8902e9d1fc | ||
|
|
86a5394f07 | ||
|
|
df5df18820 |
125
CHANGELOG.md
125
CHANGELOG.md
@@ -1,8 +1,128 @@
|
|||||||
CHANGELOG
|
CHANGELOG
|
||||||
=========
|
=========
|
||||||
|
|
||||||
To-be-released
|
v0.08 (April 1, 2015)
|
||||||
--------------
|
---------------------
|
||||||
|
|
||||||
|
Mail:
|
||||||
|
|
||||||
|
* The Roundcube vacation_sieve plugin by @arodier is now installed to make it easier to set vacation auto-reply messages from within Roundcube.
|
||||||
|
* Authentication-Results headers for DMARC, added in v0.07, were mistakenly added for outbound mail --- that's now removed.
|
||||||
|
* The Trash folder is now created automatically for new mail accounts, addressing a Roundcube error.
|
||||||
|
|
||||||
|
DNS:
|
||||||
|
|
||||||
|
* Custom DNS TXT records were not always working and they can now override the default SPF, DKIM, and DMARC records.
|
||||||
|
|
||||||
|
System:
|
||||||
|
|
||||||
|
* ownCloud updated to version 8.0.2.
|
||||||
|
* Brute-force SSH and IMAP login attempts are now prevented by properly configuring fail2ban.
|
||||||
|
* Status checks are run each night and any changes from night to night are emailed to the box administrator (the first user account).
|
||||||
|
|
||||||
|
Control panel:
|
||||||
|
|
||||||
|
* The new check that system services are running mistakenly checked that the Dovecot Managesieve service is publicly accessible. Although the service binds to the public network interface we don't open the port in ufw. On some machines it seems that ufw blocks the connection from the status checks (which seems correct) and on some machines (mine) it doesn't, which is why I didn't notice the problem.
|
||||||
|
* The current backup chain will now try to predict how many days until it is deleted (always at least 3 days after the next full backup).
|
||||||
|
* The list of aliases that forward to a user are removed from the Mail Users page because when there are many alises it is slow and times-out.
|
||||||
|
* Some status check errors are turned into warnings, especially those that might not apply if External DNS is used.
|
||||||
|
|
||||||
|
v0.07 (February 28, 2015)
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
Mail:
|
||||||
|
|
||||||
|
* If the box manages mail for a domain and a subdomain of that domain, outbound mail from the subdomain was not DKIM-signed and would therefore fail DMARC tests on the receiving end, possibly result in the mail heading into spam folders.
|
||||||
|
* Auto-configuration for Mozilla Thunderbird, Evolution, KMail, and Kontact is now available.
|
||||||
|
* Domains that only have a catch-all alias or domain alias no longer automatically create/require admin@ and postmaster@ addresses since they'll forward anyway.
|
||||||
|
* Roundcube is updated to version 1.1.0.
|
||||||
|
* Authentication-Results headers for DMARC are now added to incoming mail.
|
||||||
|
|
||||||
|
DNS:
|
||||||
|
|
||||||
|
* If a custom CNAME record is set on a 'www' subdomain, the default A/AAAA records were preventing the CNAME from working.
|
||||||
|
* If a custom DNS A record overrides one provided by the box, the a corresponding default IPv6 record by the box is removed since it will probably be incorrect.
|
||||||
|
* Internationalized domain names (IDNs) are now supported for DNS and web, but email is not yet tested.
|
||||||
|
|
||||||
|
Web:
|
||||||
|
|
||||||
|
* Static websites now deny access to certain dot (.) files and directories which typically have sensitive info: .ht*, .svn*, .git*, .hg*, .bzr*.
|
||||||
|
* The nginx server no longer reports its version and OS for better privacy.
|
||||||
|
* The HTTP->HTTPS redirect is now more efficient.
|
||||||
|
* When serving a 'www.' domain, reuse the SSL certificate for the parent domain if it covers the 'www' subdomain too
|
||||||
|
* If a custom DNS CNAME record is set on a domain, don't offer to put a website on that domain. (Same logic already applies to custom A/AAAA records.)
|
||||||
|
|
||||||
|
Control panel:
|
||||||
|
|
||||||
|
* Status checks now check that system services are actually running by pinging each port that should have something running on it.
|
||||||
|
* The status checks are now parallelized so they may be a little faster.
|
||||||
|
* The status check for MX records now allow any priority, in case an unusual setup is required.
|
||||||
|
* The interface for setting website domain-specific directories is simplified.
|
||||||
|
* The mail guide now says that to use Outlook, Outlook 2007 or later on Windows 7 and later is required.
|
||||||
|
* External DNS settings now skip the special "_secondary_nameserver" key which is used for storing secondary NS information.
|
||||||
|
|
||||||
|
Setup:
|
||||||
|
|
||||||
|
* Install cron if it isn't already installed.
|
||||||
|
* Fix a units problem in the minimum memory check.
|
||||||
|
* If you override the STORAGE_ROOT, your setting will now persist if you re-run setup.
|
||||||
|
* Hangs due to apt wanting the user to resolve a conflict should now be fixed (apt will just clobber the problematic file now).
|
||||||
|
|
||||||
|
v0.06 (January 4, 2015)
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
Mail:
|
||||||
|
|
||||||
|
* Set better default system limits to accommodate boxes handling mail for 20+ users.
|
||||||
|
|
||||||
|
Contacts/calendar:
|
||||||
|
|
||||||
|
* Update to ownCloud to 7.0.4.
|
||||||
|
* Contacts syncing via ActiveSync wasn't working.
|
||||||
|
|
||||||
|
Control panel:
|
||||||
|
|
||||||
|
* New control panel for setting custom DNS settings (without having to use the API).
|
||||||
|
* Status checks showed a false positive for Spamhause blacklists and for secondary DNS in some cases.
|
||||||
|
* Status checks would fail to load if openssh-sever was not pre-installed, but openssh-server is not required.
|
||||||
|
* The local DNS cache is cleared before running the status checks using 'rncd' now rather than restarting 'bind9', which should be faster and wont interrupt other services.
|
||||||
|
* Multi-domain and wildcard certificate can now be installed through the control panel.
|
||||||
|
* The DNS API now allows the setting of SRV records.
|
||||||
|
|
||||||
|
Misc:
|
||||||
|
|
||||||
|
* IPv6 configuration error in postgrey, nginx.
|
||||||
|
* Missing dependency on sudo.
|
||||||
|
|
||||||
|
v0.05 (November 18, 2014)
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
Mail:
|
||||||
|
|
||||||
|
* The maximum size of outbound mail sent via webmail and Exchange/ActiveSync has been increased to 128 MB, the same as when using SMTP.
|
||||||
|
* Spam is no longer wrapped as an attachment inside a scary Spamassassin explanation. The original message is simply moved straight to the Spam folder unchanged.
|
||||||
|
* There is a new iOS/Mac OS X Configuration Profile link in the control panel which makes it easier to configure IMAP/SMTP/CalDAV/CardDAV on iOS devices and Macs.
|
||||||
|
* "Domain aliases" can now be configured in the control panel.
|
||||||
|
* Updated to [Roundcube 1.0.3](http://trac.roundcube.net/wiki/Changelog).
|
||||||
|
* IMAP/SMTP is now recommended even on iOS devices as Exchange/ActiveSync is terribly buggy.
|
||||||
|
|
||||||
|
Control panel:
|
||||||
|
|
||||||
|
* Installing an SSL certificate for the primary hostname would cause problems until a restart (services needed to be restarted).
|
||||||
|
* Installing SSL certificates would fail if /tmp was on a different filesystem.
|
||||||
|
* Better error messages when installing a SSL certificate fails.
|
||||||
|
* The local DNS cache is now cleared each time the system status checks are run.
|
||||||
|
* Documented how to use +tag addressing.
|
||||||
|
* Minor UI tweaks.
|
||||||
|
|
||||||
|
Other:
|
||||||
|
|
||||||
|
* Updated to [ownCloud 7.0.3](http://owncloud.org/changelog/).
|
||||||
|
* The ownCloud API is now exposed properly.
|
||||||
|
* DNSSEC now works on `.guide` domains now too (RSASHA256).
|
||||||
|
|
||||||
|
v0.04 (October 15, 2014)
|
||||||
|
------------------------
|
||||||
|
|
||||||
Breaking changes:
|
Breaking changes:
|
||||||
|
|
||||||
@@ -31,6 +151,7 @@ Security:
|
|||||||
|
|
||||||
Other:
|
Other:
|
||||||
|
|
||||||
|
* Spam filter learning by dragging mail in and out of the Spam folder should hopefully be working now.
|
||||||
* Some things were broken if the machine had an IPv6 address.
|
* Some things were broken if the machine had an IPv6 address.
|
||||||
* Other things were broken if the machine was on a non-utf8 locale.
|
* Other things were broken if the machine was on a non-utf8 locale.
|
||||||
* No longer implementing webfinger.
|
* No longer implementing webfinger.
|
||||||
|
|||||||
22
conf/fail2ban/dovecotimap.conf
Normal file
22
conf/fail2ban/dovecotimap.conf
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
# Fail2Ban filter Dovecot authentication and pop3/imap server
|
||||||
|
# For Mail-in-a-Box
|
||||||
|
|
||||||
|
[INCLUDES]
|
||||||
|
|
||||||
|
before = common.conf
|
||||||
|
|
||||||
|
[Definition]
|
||||||
|
|
||||||
|
_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*$
|
||||||
|
|
||||||
|
ignoreregex =
|
||||||
|
|
||||||
|
# DEV Notes:
|
||||||
|
# * the first regex is essentially a copy of pam-generic.conf
|
||||||
|
# * Probably doesn't do dovecot sql/ldap backends properly
|
||||||
|
#
|
||||||
|
# Author: Martin Waschbuesch
|
||||||
|
# Daniel Black (rewrote with begin and end anchors)
|
||||||
|
# Mail-in-a-Box (swapped session=...)
|
||||||
34
conf/fail2ban/jail.local
Normal file
34
conf/fail2ban/jail.local
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
# Fail2Ban configuration file.
|
||||||
|
# For Mail-in-a-Box
|
||||||
|
[DEFAULT]
|
||||||
|
|
||||||
|
# bantime in seconds
|
||||||
|
bantime = 60
|
||||||
|
|
||||||
|
# This should ban dumb brute-force attacks, not oblivious users.
|
||||||
|
findtime = 30
|
||||||
|
maxretry = 20
|
||||||
|
|
||||||
|
#
|
||||||
|
# JAILS
|
||||||
|
#
|
||||||
|
|
||||||
|
[ssh]
|
||||||
|
|
||||||
|
enabled = true
|
||||||
|
logpath = /var/log/auth.log
|
||||||
|
maxretry = 20
|
||||||
|
|
||||||
|
[ssh-ddos]
|
||||||
|
|
||||||
|
enabled = true
|
||||||
|
maxretry = 20
|
||||||
|
|
||||||
|
[sasl]
|
||||||
|
|
||||||
|
enabled = true
|
||||||
|
|
||||||
|
[dovecot]
|
||||||
|
|
||||||
|
enabled = true
|
||||||
|
filter = dovecotimap
|
||||||
128
conf/ios-profile.xml
Normal file
128
conf/ios-profile.xml
Normal file
@@ -0,0 +1,128 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||||
|
<!--
|
||||||
|
iOS/OS X Configuration Profile
|
||||||
|
|
||||||
|
Mobileconfig for iOS/OS X users to setup IMAP, SMTP, Contacts & Calendar
|
||||||
|
|
||||||
|
https://developer.apple.com/library/ios/featuredarticles/iPhoneConfigurationProfileRef/Introduction/Introduction.html
|
||||||
|
-->
|
||||||
|
<plist version="1.0">
|
||||||
|
<dict>
|
||||||
|
<key>PayloadContent</key>
|
||||||
|
<array>
|
||||||
|
<dict>
|
||||||
|
<key>CalDAVAccountDescription</key>
|
||||||
|
<string>PRIMARY_HOSTNAME calendar</string>
|
||||||
|
<key>CalDAVHostName</key>
|
||||||
|
<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>
|
||||||
|
<string>PRIMARY_HOSTNAME (Mail-in-a-Box)</string>
|
||||||
|
<key>PayloadDisplayName</key>
|
||||||
|
<string>PRIMARY_HOSTNAME calendar</string>
|
||||||
|
<key>PayloadIdentifier</key>
|
||||||
|
<string>email.mailinabox.mobileconfig.PRIMARY_HOSTNAME.CalDAV</string>
|
||||||
|
<key>PayloadOrganization</key>
|
||||||
|
<string></string>
|
||||||
|
<key>PayloadType</key>
|
||||||
|
<string>com.apple.caldav.account</string>
|
||||||
|
<key>PayloadUUID</key>
|
||||||
|
<string>UUID1</string>
|
||||||
|
<key>PayloadVersion</key>
|
||||||
|
<integer>1</integer>
|
||||||
|
</dict>
|
||||||
|
<dict>
|
||||||
|
<key>EmailAccountDescription</key>
|
||||||
|
<string>PRIMARY_HOSTNAME mail</string>
|
||||||
|
<key>EmailAccountType</key>
|
||||||
|
<string>EmailTypeIMAP</string>
|
||||||
|
<key>IncomingMailServerAuthentication</key>
|
||||||
|
<string>EmailAuthPassword</string>
|
||||||
|
<key>IncomingMailServerHostName</key>
|
||||||
|
<string>PRIMARY_HOSTNAME</string>
|
||||||
|
<key>IncomingMailServerPortNumber</key>
|
||||||
|
<integer>993</integer>
|
||||||
|
<key>IncomingMailServerUseSSL</key>
|
||||||
|
<true/>
|
||||||
|
<key>OutgoingMailServerAuthentication</key>
|
||||||
|
<string>EmailAuthPassword</string>
|
||||||
|
<key>OutgoingMailServerHostName</key>
|
||||||
|
<string>PRIMARY_HOSTNAME</string>
|
||||||
|
<key>OutgoingMailServerPortNumber</key>
|
||||||
|
<integer>587</integer>
|
||||||
|
<key>OutgoingMailServerUseSSL</key>
|
||||||
|
<true/>
|
||||||
|
<key>OutgoingPasswordSameAsIncomingPassword</key>
|
||||||
|
<true/>
|
||||||
|
<key>PayloadDescription</key>
|
||||||
|
<string>PRIMARY_HOSTNAME (Mail-in-a-Box)</string>
|
||||||
|
<key>PayloadDisplayName</key>
|
||||||
|
<string>PRIMARY_HOSTNAME mail</string>
|
||||||
|
<key>PayloadIdentifier</key>
|
||||||
|
<string>email.mailinabox.mobileconfig.PRIMARY_HOSTNAME.E-Mail</string>
|
||||||
|
<key>PayloadOrganization</key>
|
||||||
|
<string></string>
|
||||||
|
<key>PayloadType</key>
|
||||||
|
<string>com.apple.mail.managed</string>
|
||||||
|
<key>PayloadUUID</key>
|
||||||
|
<string>UUID2</string>
|
||||||
|
<key>PayloadVersion</key>
|
||||||
|
<integer>1</integer>
|
||||||
|
<key>PreventAppSheet</key>
|
||||||
|
<false/>
|
||||||
|
<key>PreventMove</key>
|
||||||
|
<false/>
|
||||||
|
<key>SMIMEEnabled</key>
|
||||||
|
<false/>
|
||||||
|
</dict>
|
||||||
|
<dict>
|
||||||
|
<key>CardDAVAccountDescription</key>
|
||||||
|
<string>PRIMARY_HOSTNAME contacts</string>
|
||||||
|
<key>CardDAVHostName</key>
|
||||||
|
<string>PRIMARY_HOSTNAME</string>
|
||||||
|
<key>CardDAVPort</key>
|
||||||
|
<integer>443</integer>
|
||||||
|
<key>CardDAVPrincipalURL</key>
|
||||||
|
<string>/cloud/remote.php/carddav/addressbooks/</string>
|
||||||
|
<key>CardDAVUseSSL</key>
|
||||||
|
<true/>
|
||||||
|
<key>PayloadDescription</key>
|
||||||
|
<string>PRIMARY_HOSTNAME (Mail-in-a-Box)</string>
|
||||||
|
<key>PayloadDisplayName</key>
|
||||||
|
<string>PRIMARY_HOSTNAME contacts</string>
|
||||||
|
<key>PayloadIdentifier</key>
|
||||||
|
<string>email.mailinabox.mobileconfig.PRIMARY_HOSTNAME.carddav</string>
|
||||||
|
<key>PayloadOrganization</key>
|
||||||
|
<string></string>
|
||||||
|
<key>PayloadType</key>
|
||||||
|
<string>com.apple.carddav.account</string>
|
||||||
|
<key>PayloadUUID</key>
|
||||||
|
<string>UUID3</string>
|
||||||
|
<key>PayloadVersion</key>
|
||||||
|
<integer>1</integer>
|
||||||
|
</dict>
|
||||||
|
</array>
|
||||||
|
<key>PayloadDescription</key>
|
||||||
|
<string>PRIMARY_HOSTNAME (Mail-in-a-Box)</string>
|
||||||
|
<key>PayloadDisplayName</key>
|
||||||
|
<string>PRIMARY_HOSTNAME</string>
|
||||||
|
<key>PayloadIdentifier</key>
|
||||||
|
<string>email.mailinabox.mobileconfig.PRIMARY_HOSTNAME</string>
|
||||||
|
<key>PayloadOrganization</key>
|
||||||
|
<string></string>
|
||||||
|
<key>PayloadRemovalDisallowed</key>
|
||||||
|
<false/>
|
||||||
|
<key>PayloadType</key>
|
||||||
|
<string>Configuration</string>
|
||||||
|
<key>PayloadUUID</key>
|
||||||
|
<string>UUID4</string>
|
||||||
|
<key>PayloadVersion</key>
|
||||||
|
<integer>1</integer>
|
||||||
|
</dict>
|
||||||
|
</plist>
|
||||||
44
conf/mozilla-autoconfig.xml
Normal file
44
conf/mozilla-autoconfig.xml
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
<?xml version="1.0"?>
|
||||||
|
<clientConfig version="1.1">
|
||||||
|
<emailProvider id="PRIMARY_HOSTNAME">
|
||||||
|
<domain>PRIMARY_HOSTNAME</domain>
|
||||||
|
|
||||||
|
<displayName>PRIMARY_HOSTNAME (Mail-in-a-Box)</displayName>
|
||||||
|
<displayShortName>PRIMARY_HOSTNAME</displayShortName>
|
||||||
|
|
||||||
|
<incomingServer type="imap">
|
||||||
|
<hostname>PRIMARY_HOSTNAME</hostname>
|
||||||
|
<port>993</port>
|
||||||
|
<socketType>SSL</socketType>
|
||||||
|
<username>%EMAILADDRESS%</username>
|
||||||
|
<authentication>password-cleartext</authentication>
|
||||||
|
</incomingServer>
|
||||||
|
|
||||||
|
<outgoingServer type="smtp">
|
||||||
|
<hostname>PRIMARY_HOSTNAME</hostname>
|
||||||
|
<port>587</port>
|
||||||
|
<socketType>STARTTLS</socketType>
|
||||||
|
<username>%EMAILADDRESS%</username>
|
||||||
|
<authentication>password-cleartext</authentication>
|
||||||
|
<addThisServer>true</addThisServer>
|
||||||
|
<useGlobalPreferredServer>true</useGlobalPreferredServer>
|
||||||
|
</outgoingServer>
|
||||||
|
|
||||||
|
<documentation url="https://PRIMARY_HOSTNAME/">
|
||||||
|
<descr lang="en">PRIMARY_HOSTNAME website.</descr>
|
||||||
|
</documentation>
|
||||||
|
</emailProvider>
|
||||||
|
|
||||||
|
<webMail>
|
||||||
|
<loginPage url="https://PRIMARY_HOSTNAME/mail/" />
|
||||||
|
<loginPageInfo url="https://PRIMARY_HOSTNAME/mail/" >
|
||||||
|
<username>%EMAILADDRESS%</username>
|
||||||
|
<usernameField id="rcmloginuser" name="_user" />
|
||||||
|
<passwordField id="rcmloginpwd" name="_pass" />
|
||||||
|
<loginButton id="rcmloginsubmit" />
|
||||||
|
</loginPageInfo>
|
||||||
|
</webMail>
|
||||||
|
|
||||||
|
<clientConfigUpdate url="https://PRIMARY_HOSTNAME/.well-known/autoconfig/mail/config-v1.1.xml" />
|
||||||
|
|
||||||
|
</clientConfig>
|
||||||
@@ -18,8 +18,12 @@
|
|||||||
deny all;
|
deny all;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
location ~ ^(/cloud)(/[^/]+\.php)(/.*)?$ {
|
location ~ ^(/cloud)((?:/ocs)?/[^/]+\.php)(/.*)?$ {
|
||||||
# note: ~ has precendence over a regular location block
|
# note: ~ has precendence over a regular location block
|
||||||
|
# Accept URLs like:
|
||||||
|
# /cloud/index.php/apps/files/
|
||||||
|
# /cloud/index.php/apps/files/ajax/scan.php (it's really index.php; see 6fdef379adfdeac86cc2220209bdf4eb9562268d)
|
||||||
|
# /cloud/ocs/v1.php/apps/files_sharing/api/v1 (see #240)
|
||||||
include fastcgi_params;
|
include fastcgi_params;
|
||||||
fastcgi_param SCRIPT_FILENAME /usr/local/lib/owncloud/$2;
|
fastcgi_param SCRIPT_FILENAME /usr/local/lib/owncloud/$2;
|
||||||
fastcgi_param SCRIPT_NAME $1$2;
|
fastcgi_param SCRIPT_NAME $1$2;
|
||||||
|
|||||||
@@ -7,15 +7,28 @@ server {
|
|||||||
|
|
||||||
server_name $HOSTNAME;
|
server_name $HOSTNAME;
|
||||||
root /tmp/invalid-path-nothing-here;
|
root /tmp/invalid-path-nothing-here;
|
||||||
rewrite ^/(.*)$ https://$HOSTNAME/$1 permanent;
|
|
||||||
|
# Improve privacy: Hide version an OS information on
|
||||||
|
# error pages and in the "Server" HTTP-Header.
|
||||||
|
server_tokens off;
|
||||||
|
|
||||||
|
# Redirect using the 'return' directive and the built-in
|
||||||
|
# variable '$request_uri' to avoid any capturing, matching
|
||||||
|
# or evaluation of regular expressions.
|
||||||
|
return 301 https://$HOSTNAME$request_uri;
|
||||||
}
|
}
|
||||||
|
|
||||||
# The secure HTTPS server.
|
# The secure HTTPS server.
|
||||||
server {
|
server {
|
||||||
listen 443 ssl;
|
listen 443 ssl;
|
||||||
|
listen [::]:443 ssl;
|
||||||
|
|
||||||
server_name $HOSTNAME;
|
server_name $HOSTNAME;
|
||||||
|
|
||||||
|
# Improve privacy: Hide version an OS information on
|
||||||
|
# error pages and in the "Server" HTTP-Header.
|
||||||
|
server_tokens off;
|
||||||
|
|
||||||
ssl_certificate $SSL_CERTIFICATE;
|
ssl_certificate $SSL_CERTIFICATE;
|
||||||
ssl_certificate_key $SSL_KEY;
|
ssl_certificate_key $SSL_KEY;
|
||||||
include /etc/nginx/nginx-ssl.conf;
|
include /etc/nginx/nginx-ssl.conf;
|
||||||
@@ -34,6 +47,20 @@ server {
|
|||||||
access_log off;
|
access_log off;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
location = /mailinabox.mobileconfig {
|
||||||
|
alias /var/lib/mailinabox/mobileconfig.xml;
|
||||||
|
}
|
||||||
|
location = /.well-known/autoconfig/mail/config-v1.1.xml {
|
||||||
|
alias /var/lib/mailinabox/mozilla-autoconfig.xml;
|
||||||
|
}
|
||||||
|
|
||||||
|
# Disable viewing dotfiles (.htaccess, .svn, .git, etc.)
|
||||||
|
location ~ /\.(ht|svn|git|hg|bzr) {
|
||||||
|
log_not_found off;
|
||||||
|
access_log off;
|
||||||
|
deny all;
|
||||||
|
}
|
||||||
|
|
||||||
# Roundcube Webmail configuration.
|
# Roundcube Webmail configuration.
|
||||||
rewrite ^/mail$ /mail/ redirect;
|
rewrite ^/mail$ /mail/ redirect;
|
||||||
rewrite ^/mail/$ /mail/index.php;
|
rewrite ^/mail/$ /mail/index.php;
|
||||||
@@ -52,7 +79,10 @@ server {
|
|||||||
fastcgi_index index.php;
|
fastcgi_index index.php;
|
||||||
fastcgi_param SCRIPT_FILENAME /usr/local/lib/roundcubemail/$fastcgi_script_name;
|
fastcgi_param SCRIPT_FILENAME /usr/local/lib/roundcubemail/$fastcgi_script_name;
|
||||||
fastcgi_pass php-fpm;
|
fastcgi_pass php-fpm;
|
||||||
client_max_body_size 20M;
|
|
||||||
|
# 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;
|
||||||
}
|
}
|
||||||
|
|
||||||
# Z-Push (Microsoft Exchange ActiveSync)
|
# Z-Push (Microsoft Exchange ActiveSync)
|
||||||
@@ -62,6 +92,10 @@ server {
|
|||||||
fastcgi_param PHP_VALUE "include_path=.:/usr/share/php:/usr/share/pear:/usr/share/awl/inc";
|
fastcgi_param PHP_VALUE "include_path=.:/usr/share/php:/usr/share/pear:/usr/share/awl/inc";
|
||||||
fastcgi_read_timeout 630;
|
fastcgi_read_timeout 630;
|
||||||
fastcgi_pass php-fpm;
|
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 /autodiscover/autodiscover.xml {
|
location /autodiscover/autodiscover.xml {
|
||||||
include fastcgi_params;
|
include fastcgi_params;
|
||||||
@@ -73,4 +107,3 @@ server {
|
|||||||
|
|
||||||
# ADDITIONAL DIRECTIVES HERE
|
# ADDITIONAL DIRECTIVES HERE
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
require ["regex", "fileinto", "imap4flags"];
|
require ["regex", "fileinto", "imap4flags"];
|
||||||
|
|
||||||
if allof (header :regex "X-Spam-Status" "^Yes") {
|
if allof (header :regex "X-Spam-Status" "^Yes") {
|
||||||
setflag "\\Seen";
|
|
||||||
fileinto "Spam";
|
fileinto "Spam";
|
||||||
stop;
|
stop;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ define('CARDDAV_DEFAULT_PATH', '/carddav/addressbooks/%u/contacts/'); /* subdire
|
|||||||
define('CARDDAV_GAL_PATH', ''); /* readonly, searchable, not syncd */
|
define('CARDDAV_GAL_PATH', ''); /* readonly, searchable, not syncd */
|
||||||
define('CARDDAV_GAL_MIN_LENGTH', 5);
|
define('CARDDAV_GAL_MIN_LENGTH', 5);
|
||||||
define('CARDDAV_CONTACTS_FOLDER_NAME', '%u Addressbook');
|
define('CARDDAV_CONTACTS_FOLDER_NAME', '%u Addressbook');
|
||||||
define('CARDDAV_SUPPORTS_SYNC', true);
|
define('CARDDAV_SUPPORTS_SYNC', false);
|
||||||
|
|
||||||
// If the CardDAV server supports the FN attribute for searches
|
// If the CardDAV server supports the FN attribute for searches
|
||||||
// DAViCal supports it, but SabreDav, Owncloud and SOGo don't
|
// DAViCal supports it, but SabreDav, Owncloud and SOGo don't
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
import base64, os, os.path
|
import base64, os, os.path, hmac
|
||||||
|
|
||||||
from flask import make_response
|
from flask import make_response
|
||||||
|
|
||||||
import utils
|
import utils
|
||||||
from mailconfig import get_mail_user_privileges
|
from mailconfig import get_mail_password, get_mail_user_privileges
|
||||||
|
|
||||||
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'
|
DEFAULT_AUTH_REALM = 'Mail-in-a-Box Management Server'
|
||||||
@@ -40,10 +40,12 @@ class KeyAuthService:
|
|||||||
with create_file_with_mode(self.key_path, 0o640) as key_file:
|
with create_file_with_mode(self.key_path, 0o640) as key_file:
|
||||||
key_file.write(self.key + '\n')
|
key_file.write(self.key + '\n')
|
||||||
|
|
||||||
def is_authenticated(self, request, env):
|
def authenticate(self, request, env):
|
||||||
"""Test if the client key passed in HTTP Authorization header matches the service key
|
"""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.
|
or if the or username/password passed in the header matches an administrator user.
|
||||||
Returns 'OK' if the key is good or the user is an administrator, otherwise an error message."""
|
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."""
|
||||||
|
|
||||||
def decode(s):
|
def decode(s):
|
||||||
return base64.b64decode(s.encode('ascii')).decode('ascii')
|
return base64.b64decode(s.encode('ascii')).decode('ascii')
|
||||||
@@ -63,46 +65,64 @@ class KeyAuthService:
|
|||||||
|
|
||||||
header = request.headers.get('Authorization')
|
header = request.headers.get('Authorization')
|
||||||
if not header:
|
if not header:
|
||||||
return "No authorization header provided."
|
raise ValueError("No authorization header provided.")
|
||||||
|
|
||||||
username, password = parse_basic_auth(header)
|
username, password = parse_basic_auth(header)
|
||||||
|
|
||||||
if username in (None, ""):
|
if username in (None, ""):
|
||||||
return "Authorization header invalid."
|
raise ValueError("Authorization header invalid.")
|
||||||
elif username == self.key:
|
elif username == self.key:
|
||||||
return "OK"
|
# The user passed the API key which grants administrative privs.
|
||||||
|
return (None, ["admin"])
|
||||||
else:
|
else:
|
||||||
return self.check_imap_login( username, password, env)
|
# 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 check_imap_login(self, email, pw, env):
|
def get_user_credentials(self, email, pw, env):
|
||||||
# Validate a user's credentials.
|
# 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.
|
# Sanity check.
|
||||||
if email == "" or pw == "":
|
if email == "" or pw == "":
|
||||||
return "Enter an email address and password."
|
raise ValueError("Enter an email address and password.")
|
||||||
|
|
||||||
# Authenticate.
|
# The password might be a user-specific API key.
|
||||||
try:
|
if hmac.compare_digest(self.create_user_key(email), pw):
|
||||||
# Use doveadm to check credentials. doveadm will return
|
# OK.
|
||||||
# a non-zero exit status if the credentials are no good,
|
pass
|
||||||
# and check_call will raise an exception in that case.
|
else:
|
||||||
utils.shell('check_call', [
|
# Get the hashed password of the user. Raise a ValueError if the
|
||||||
"/usr/bin/doveadm",
|
# email address does not correspond to a user.
|
||||||
"auth", "test",
|
pw_hash = get_mail_password(email, env)
|
||||||
email, pw
|
|
||||||
])
|
|
||||||
except:
|
|
||||||
# Login failed.
|
|
||||||
return "Invalid email address or password."
|
|
||||||
|
|
||||||
# Authorize.
|
# Authenticate.
|
||||||
# (This call should never fail on a valid user.)
|
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.")
|
||||||
|
|
||||||
|
# Get privileges for authorization.
|
||||||
|
|
||||||
|
# (This call should never fail on a valid user. But if it did fail, it would
|
||||||
|
# return a tuple of an error message and an HTTP status code.)
|
||||||
privs = get_mail_user_privileges(email, env)
|
privs = get_mail_user_privileges(email, env)
|
||||||
if isinstance(privs, tuple): raise Exception("Error getting privileges.")
|
if isinstance(privs, tuple): raise Exception("Error getting privileges.")
|
||||||
if "admin" not in privs:
|
|
||||||
return "You are not an administrator for this system."
|
|
||||||
|
|
||||||
return "OK"
|
# Return a list of privileges.
|
||||||
|
return privs
|
||||||
|
|
||||||
|
def create_user_key(self, email):
|
||||||
|
return hmac.new(self.key.encode('ascii'), b"AUTH:" + email.encode("utf8"), digestmod="sha1").hexdigest()
|
||||||
|
|
||||||
def _generate_key(self):
|
def _generate_key(self):
|
||||||
raw_key = os.urandom(32)
|
raw_key = os.urandom(32)
|
||||||
|
|||||||
@@ -38,6 +38,7 @@ def backup_status(env):
|
|||||||
backups = { }
|
backups = { }
|
||||||
basedir = os.path.join(env['STORAGE_ROOT'], 'backup/duplicity/')
|
basedir = os.path.join(env['STORAGE_ROOT'], 'backup/duplicity/')
|
||||||
encdir = os.path.join(env['STORAGE_ROOT'], 'backup/encrypted/')
|
encdir = os.path.join(env['STORAGE_ROOT'], 'backup/encrypted/')
|
||||||
|
os.makedirs(basedir, exist_ok=True) # os.listdir fails if directory does not exist
|
||||||
for fn in os.listdir(basedir):
|
for fn in os.listdir(basedir):
|
||||||
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)
|
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: raise ValueError(fn)
|
if not m: raise ValueError(fn)
|
||||||
@@ -66,9 +67,29 @@ def backup_status(env):
|
|||||||
# This is relied on by should_force_full() and the next step.
|
# 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 and the size of the
|
||||||
|
# most recent full backup.
|
||||||
|
incremental_count = 0
|
||||||
|
incremental_size = 0
|
||||||
|
first_full_size = None
|
||||||
|
for bak in backups:
|
||||||
|
if bak["full"]:
|
||||||
|
first_full_size = bak["size"]
|
||||||
|
break
|
||||||
|
incremental_count += 1
|
||||||
|
incremental_size += bak["size"]
|
||||||
|
|
||||||
|
# Predict how many more increments until the next full backup,
|
||||||
|
# and add to that the time we hold onto backups, to predict
|
||||||
|
# how long the most recent full backup+increments will be held
|
||||||
|
# onto. Round up since the backup occurs on the night following
|
||||||
|
# when the threshold is met.
|
||||||
|
deleted_in = None
|
||||||
|
if incremental_count > 0 and first_full_size is not None:
|
||||||
|
deleted_in = "approx. %d days" % round(keep_backups_for_days + (.5 * first_full_size - incremental_size) / (incremental_size/incremental_count) + .5)
|
||||||
|
|
||||||
# When will a backup be deleted?
|
# When will a backup be deleted?
|
||||||
saw_full = False
|
saw_full = False
|
||||||
deleted_in = None
|
|
||||||
days_ago = now - datetime.timedelta(days=keep_backups_for_days)
|
days_ago = now - datetime.timedelta(days=keep_backups_for_days)
|
||||||
for bak in backups:
|
for bak in backups:
|
||||||
if deleted_in:
|
if deleted_in:
|
||||||
|
|||||||
@@ -1,155 +0,0 @@
|
|||||||
#!/usr/bin/python3
|
|
||||||
|
|
||||||
# Helps you purchase a SSL certificate from Gandi.net using
|
|
||||||
# their API.
|
|
||||||
#
|
|
||||||
# Before you begin:
|
|
||||||
# 1) Create an account on Gandi.net.
|
|
||||||
# 2) Pre-pay $16 into your account at https://www.gandi.net/prepaid/operations. Wait until the payment goes through.
|
|
||||||
# 3) Activate your API key first on the test platform (wait a while, refresh the page) and then activate the production API at https://www.gandi.net/admin/api_key.
|
|
||||||
|
|
||||||
import sys, re, os.path, urllib.request
|
|
||||||
import xmlrpc.client
|
|
||||||
import rtyaml
|
|
||||||
|
|
||||||
from utils import load_environment, shell
|
|
||||||
from web_update import get_web_domains, get_domain_ssl_files, get_web_root
|
|
||||||
from status_checks import check_certificate
|
|
||||||
|
|
||||||
def buy_ssl_certificate(api_key, domain, command, env):
|
|
||||||
if domain != env['PRIMARY_HOSTNAME'] \
|
|
||||||
and domain not in get_web_domains(env):
|
|
||||||
raise ValueError("Domain is not %s or a domain we're serving a website for." % env['PRIMARY_HOSTNAME'])
|
|
||||||
|
|
||||||
# Initialize.
|
|
||||||
|
|
||||||
gandi = xmlrpc.client.ServerProxy('https://rpc.gandi.net/xmlrpc/')
|
|
||||||
|
|
||||||
try:
|
|
||||||
existing_certs = gandi.cert.list(api_key)
|
|
||||||
except Exception as e:
|
|
||||||
if "Invalid API key" in str(e):
|
|
||||||
print("Invalid API key. Check that you copied the API Key correctly from https://www.gandi.net/admin/api_key.")
|
|
||||||
sys.exit(1)
|
|
||||||
else:
|
|
||||||
raise
|
|
||||||
|
|
||||||
# Where is the SSL cert stored?
|
|
||||||
|
|
||||||
ssl_key, ssl_certificate, ssl_csr_path = get_domain_ssl_files(domain, env)
|
|
||||||
|
|
||||||
# Have we already created a cert for this domain?
|
|
||||||
|
|
||||||
for cert in existing_certs:
|
|
||||||
if cert['cn'] == domain:
|
|
||||||
break
|
|
||||||
else:
|
|
||||||
# No existing cert found. Purchase one.
|
|
||||||
if command != 'purchase':
|
|
||||||
print("No certificate or order found yet. If you haven't yet purchased a certificate, run ths script again with the 'purchase' command. Otherwise wait a moment and try again.")
|
|
||||||
sys.exit(1)
|
|
||||||
else:
|
|
||||||
# Start an order for a single standard SSL certificate.
|
|
||||||
# Use DNS validation. Web-based validation won't work because they
|
|
||||||
# require a file on HTTP but not HTTPS w/o redirects and we don't
|
|
||||||
# serve anything plainly over HTTP. Email might be another way but
|
|
||||||
# DNS is easier to automate.
|
|
||||||
op = gandi.cert.create(api_key, {
|
|
||||||
"csr": open(ssl_csr_path).read(),
|
|
||||||
"dcv_method": "dns",
|
|
||||||
"duration": 1, # year?
|
|
||||||
"package": "cert_std_1_0_0",
|
|
||||||
})
|
|
||||||
print("An SSL certificate has been ordered.")
|
|
||||||
print()
|
|
||||||
print(op)
|
|
||||||
print()
|
|
||||||
print("In a moment please run this script again with the 'setup' command.")
|
|
||||||
|
|
||||||
if cert['status'] == 'pending':
|
|
||||||
# Get the information we need to update our DNS with a code so that
|
|
||||||
# Gandi can verify that we own the domain.
|
|
||||||
|
|
||||||
dcv = gandi.cert.get_dcv_params(api_key, {
|
|
||||||
"csr": open(ssl_csr_path).read(),
|
|
||||||
"cert_id": cert['id'],
|
|
||||||
"dcv_method": "dns",
|
|
||||||
"duration": 1, # year?
|
|
||||||
"package": "cert_std_1_0_0",
|
|
||||||
})
|
|
||||||
if dcv["dcv_method"] != "dns":
|
|
||||||
raise Exception("Certificate ordered with an unknown validation method.")
|
|
||||||
|
|
||||||
# Update our DNS data.
|
|
||||||
|
|
||||||
dns_config = env['STORAGE_ROOT'] + '/dns/custom.yaml'
|
|
||||||
if os.path.exists(dns_config):
|
|
||||||
dns_records = rtyaml.load(open(dns_config))
|
|
||||||
else:
|
|
||||||
dns_records = { }
|
|
||||||
|
|
||||||
qname = dcv['md5'] + '.' + domain
|
|
||||||
value = dcv['sha1'] + '.comodoca.com.'
|
|
||||||
dns_records[qname] = { "CNAME": value }
|
|
||||||
|
|
||||||
with open(dns_config, 'w') as f:
|
|
||||||
f.write(rtyaml.dump(dns_records))
|
|
||||||
|
|
||||||
shell('check_call', ['tools/dns_update'])
|
|
||||||
|
|
||||||
# Okay, done with this step.
|
|
||||||
|
|
||||||
print("DNS has been updated. Gandi will check within 60 minutes.")
|
|
||||||
print()
|
|
||||||
print("See https://www.gandi.net/admin/ssl/%d/details for the status of this order." % cert['id'])
|
|
||||||
|
|
||||||
elif cert['status'] == 'valid':
|
|
||||||
# The certificate is ready.
|
|
||||||
|
|
||||||
# Check before we overwrite something we shouldn't.
|
|
||||||
if os.path.exists(ssl_certificate):
|
|
||||||
cert_status, cert_status_details = check_certificate(None, ssl_certificate, None)
|
|
||||||
if cert_status != "SELF-SIGNED":
|
|
||||||
print("Please back up and delete the file %s so I can save your new certificate." % ssl_certificate)
|
|
||||||
sys.exit(1)
|
|
||||||
|
|
||||||
# Form the certificate.
|
|
||||||
|
|
||||||
# The certificate comes as a long base64-encoded string. Break in
|
|
||||||
# into lines in the usual way.
|
|
||||||
pem = "-----BEGIN CERTIFICATE-----\n"
|
|
||||||
pem += "\n".join(chunk for chunk in re.split(r"(.{64})", cert['cert']) if chunk != "")
|
|
||||||
pem += "\n-----END CERTIFICATE-----\n\n"
|
|
||||||
|
|
||||||
# Append intermediary certificates.
|
|
||||||
pem += urllib.request.urlopen("https://www.gandi.net/static/CAs/GandiStandardSSLCA.pem").read().decode("ascii")
|
|
||||||
|
|
||||||
# Write out.
|
|
||||||
|
|
||||||
with open(ssl_certificate, "w") as f:
|
|
||||||
f.write(pem)
|
|
||||||
|
|
||||||
print("The certificate has been installed in %s. Restarting services..." % ssl_certificate)
|
|
||||||
|
|
||||||
# Restart dovecot and if this is for PRIMARY_HOSTNAME.
|
|
||||||
|
|
||||||
if domain == env['PRIMARY_HOSTNAME']:
|
|
||||||
shell('check_call', ["/usr/sbin/service", "dovecot", "restart"])
|
|
||||||
shell('check_call', ["/usr/sbin/service", "postfix", "restart"])
|
|
||||||
|
|
||||||
# Restart nginx in all cases.
|
|
||||||
|
|
||||||
shell('check_call', ["/usr/sbin/service", "nginx", "restart"])
|
|
||||||
|
|
||||||
else:
|
|
||||||
print("The certificate has an unknown status. Please check https://www.gandi.net/admin/ssl/%d/details for the status of this order." % cert['id'])
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
if len(sys.argv) < 4:
|
|
||||||
print("Usage: python management/buy_certificate.py gandi_api_key domain_name {purchase, setup}")
|
|
||||||
sys.exit(1)
|
|
||||||
api_key = sys.argv[1]
|
|
||||||
domain_name = sys.argv[2]
|
|
||||||
cmd = sys.argv[3]
|
|
||||||
buy_ssl_certificate(api_key, domain_name, cmd, load_environment())
|
|
||||||
|
|
||||||
@@ -11,6 +11,12 @@ from mailconfig import get_mail_users, get_mail_users_ex, get_admins, add_mail_u
|
|||||||
from mailconfig import get_mail_user_privileges, add_remove_mail_user_privilege
|
from mailconfig import get_mail_user_privileges, add_remove_mail_user_privilege
|
||||||
from mailconfig import get_mail_aliases, get_mail_aliases_ex, get_mail_domains, add_mail_alias, remove_mail_alias
|
from mailconfig import get_mail_aliases, get_mail_aliases_ex, get_mail_domains, add_mail_alias, remove_mail_alias
|
||||||
|
|
||||||
|
# Create a worker pool for the status checks. The pool should
|
||||||
|
# live across http requests so we don't baloon the system with
|
||||||
|
# processes.
|
||||||
|
import multiprocessing.pool
|
||||||
|
pool = multiprocessing.pool.Pool(processes=10)
|
||||||
|
|
||||||
env = utils.load_environment()
|
env = utils.load_environment()
|
||||||
|
|
||||||
auth_service = auth.KeyAuthService()
|
auth_service = auth.KeyAuthService()
|
||||||
@@ -24,19 +30,32 @@ except OSError:
|
|||||||
|
|
||||||
app = Flask(__name__, template_folder=os.path.abspath(os.path.join(os.path.dirname(me), "templates")))
|
app = Flask(__name__, template_folder=os.path.abspath(os.path.join(os.path.dirname(me), "templates")))
|
||||||
|
|
||||||
# Decorator to protect views that require authentication.
|
# Decorator to protect views that require a user with 'admin' privileges.
|
||||||
def authorized_personnel_only(viewfunc):
|
def authorized_personnel_only(viewfunc):
|
||||||
@wraps(viewfunc)
|
@wraps(viewfunc)
|
||||||
def newview(*args, **kwargs):
|
def newview(*args, **kwargs):
|
||||||
# Check if the user is authorized.
|
# Authenticate the passed credentials, which is either the API key or a username:password pair.
|
||||||
authorized_status = auth_service.is_authenticated(request, env)
|
error = None
|
||||||
if authorized_status == "OK":
|
try:
|
||||||
# Authorized. Call view func.
|
email, privs = auth_service.authenticate(request, env)
|
||||||
|
except ValueError as e:
|
||||||
|
# Authentication failed.
|
||||||
|
privs = []
|
||||||
|
error = str(e)
|
||||||
|
|
||||||
|
# Authorized to access an API view?
|
||||||
|
if "admin" in privs:
|
||||||
|
# Call view func.
|
||||||
return viewfunc(*args, **kwargs)
|
return viewfunc(*args, **kwargs)
|
||||||
|
elif not error:
|
||||||
|
error = "You are not an administrator."
|
||||||
|
|
||||||
# Not authorized. Return a 401 (send auth) and a prompt to authorize by default.
|
# Not authorized. Return a 401 (send auth) and a prompt to authorize by default.
|
||||||
status = 401
|
status = 401
|
||||||
headers = { 'WWW-Authenticate': 'Basic realm="{0}"'.format(auth_service.auth_realm) }
|
headers = {
|
||||||
|
'WWW-Authenticate': 'Basic realm="{0}"'.format(auth_service.auth_realm),
|
||||||
|
'X-Reason': error,
|
||||||
|
}
|
||||||
|
|
||||||
if request.headers.get('X-Requested-With') == 'XMLHttpRequest':
|
if request.headers.get('X-Requested-With') == 'XMLHttpRequest':
|
||||||
# Don't issue a 401 to an AJAX request because the user will
|
# Don't issue a 401 to an AJAX request because the user will
|
||||||
@@ -46,13 +65,13 @@ def authorized_personnel_only(viewfunc):
|
|||||||
|
|
||||||
if request.headers.get('Accept') in (None, "", "*/*"):
|
if request.headers.get('Accept') in (None, "", "*/*"):
|
||||||
# Return plain text output.
|
# Return plain text output.
|
||||||
return Response(authorized_status+"\n", status=status, mimetype='text/plain', headers=headers)
|
return Response(error+"\n", status=status, mimetype='text/plain', headers=headers)
|
||||||
else:
|
else:
|
||||||
# Return JSON output.
|
# Return JSON output.
|
||||||
return Response(json.dumps({
|
return Response(json.dumps({
|
||||||
"status": "error",
|
"status": "error",
|
||||||
"reason": authorized_status
|
"reason": error,
|
||||||
}+"\n"), status=status, mimetype='application/json', headers=headers)
|
})+"\n", status=status, mimetype='application/json', headers=headers)
|
||||||
|
|
||||||
return newview
|
return newview
|
||||||
|
|
||||||
@@ -81,16 +100,26 @@ def index():
|
|||||||
@app.route('/me')
|
@app.route('/me')
|
||||||
def me():
|
def me():
|
||||||
# Is the caller authorized?
|
# Is the caller authorized?
|
||||||
authorized_status = auth_service.is_authenticated(request, env)
|
try:
|
||||||
if authorized_status != "OK":
|
email, privs = auth_service.authenticate(request, env)
|
||||||
|
except ValueError as e:
|
||||||
return json_response({
|
return json_response({
|
||||||
"status": "not-authorized",
|
"status": "invalid",
|
||||||
"reason": authorized_status,
|
"reason": str(e),
|
||||||
})
|
})
|
||||||
return json_response({
|
|
||||||
"status": "authorized",
|
resp = {
|
||||||
"api_key": auth_service.key,
|
"status": "ok",
|
||||||
})
|
"email": email,
|
||||||
|
"privileges": privs,
|
||||||
|
}
|
||||||
|
|
||||||
|
# Is authorized as admin? Return an API key for future use.
|
||||||
|
if "admin" in privs:
|
||||||
|
resp["api_key"] = auth_service.create_user_key(email)
|
||||||
|
|
||||||
|
# Return.
|
||||||
|
return json_response(resp)
|
||||||
|
|
||||||
# MAIL
|
# MAIL
|
||||||
|
|
||||||
@@ -172,6 +201,12 @@ def mail_domains():
|
|||||||
|
|
||||||
# DNS
|
# DNS
|
||||||
|
|
||||||
|
@app.route('/dns/zones')
|
||||||
|
@authorized_personnel_only
|
||||||
|
def dns_zones():
|
||||||
|
from dns_update import get_dns_zones
|
||||||
|
return json_response([z[0] for z in get_dns_zones(env)])
|
||||||
|
|
||||||
@app.route('/dns/update', methods=['POST'])
|
@app.route('/dns/update', methods=['POST'])
|
||||||
@authorized_personnel_only
|
@authorized_personnel_only
|
||||||
def dns_update():
|
def dns_update():
|
||||||
@@ -196,6 +231,17 @@ def dns_set_secondary_nameserver():
|
|||||||
except ValueError as e:
|
except ValueError as e:
|
||||||
return (str(e), 400)
|
return (str(e), 400)
|
||||||
|
|
||||||
|
@app.route('/dns/set')
|
||||||
|
@authorized_personnel_only
|
||||||
|
def dns_get_records():
|
||||||
|
from dns_update import get_custom_dns_config, get_custom_records
|
||||||
|
additional_records = get_custom_dns_config(env)
|
||||||
|
records = get_custom_records(None, additional_records, env)
|
||||||
|
return json_response([{
|
||||||
|
"qname": r[0],
|
||||||
|
"rtype": r[1],
|
||||||
|
"value": r[2],
|
||||||
|
} for r in records])
|
||||||
|
|
||||||
@app.route('/dns/set/<qname>', methods=['POST'])
|
@app.route('/dns/set/<qname>', methods=['POST'])
|
||||||
@app.route('/dns/set/<qname>/<rtype>', methods=['POST'])
|
@app.route('/dns/set/<qname>/<rtype>', methods=['POST'])
|
||||||
@@ -232,7 +278,7 @@ def dns_get_dump():
|
|||||||
@authorized_personnel_only
|
@authorized_personnel_only
|
||||||
def ssl_get_csr(domain):
|
def ssl_get_csr(domain):
|
||||||
from web_update import get_domain_ssl_files, create_csr
|
from web_update import get_domain_ssl_files, create_csr
|
||||||
ssl_key, ssl_certificate, csr_path = get_domain_ssl_files(domain, env)
|
ssl_key, ssl_certificate, ssl_via = get_domain_ssl_files(domain, env)
|
||||||
return create_csr(domain, ssl_key, env)
|
return create_csr(domain, ssl_key, env)
|
||||||
|
|
||||||
@app.route('/ssl/install', methods=['POST'])
|
@app.route('/ssl/install', methods=['POST'])
|
||||||
@@ -278,7 +324,7 @@ def system_status():
|
|||||||
def print_line(self, message, monospace=False):
|
def print_line(self, message, monospace=False):
|
||||||
self.items[-1]["extra"].append({ "text": message, "monospace": monospace })
|
self.items[-1]["extra"].append({ "text": message, "monospace": monospace })
|
||||||
output = WebOutput()
|
output = WebOutput()
|
||||||
run_checks(env, output)
|
run_checks(False, env, output, pool)
|
||||||
return json_response(output.items)
|
return json_response(output.items)
|
||||||
|
|
||||||
@app.route('/system/updates')
|
@app.route('/system/updates')
|
||||||
|
|||||||
@@ -122,7 +122,7 @@ def do_dns_update(env, force=False):
|
|||||||
shell('check_call', ["/usr/sbin/service", "nsd", "restart"])
|
shell('check_call', ["/usr/sbin/service", "nsd", "restart"])
|
||||||
|
|
||||||
# Write the OpenDKIM configuration tables.
|
# Write the OpenDKIM configuration tables.
|
||||||
if write_opendkim_tables(zonefiles, env):
|
if write_opendkim_tables(domains, env):
|
||||||
# Settings changed. Kick opendkim.
|
# Settings changed. Kick opendkim.
|
||||||
shell('check_call', ["/usr/sbin/service", "opendkim", "restart"])
|
shell('check_call', ["/usr/sbin/service", "opendkim", "restart"])
|
||||||
if len(updated_domains) == 0:
|
if len(updated_domains) == 0:
|
||||||
@@ -183,10 +183,6 @@ def build_zone(domain, all_domains, additional_records, env, is_zone=True):
|
|||||||
# The MX record says where email for the domain should be delivered: Here!
|
# The MX record says where email for the domain should be delivered: Here!
|
||||||
records.append((None, "MX", "10 %s." % env["PRIMARY_HOSTNAME"], "Required. Specifies the hostname (and priority) of the machine that handles @%s mail." % domain))
|
records.append((None, "MX", "10 %s." % env["PRIMARY_HOSTNAME"], "Required. Specifies the hostname (and priority) of the machine that handles @%s mail." % domain))
|
||||||
|
|
||||||
# SPF record: Permit the box ('mx', see above) to send mail on behalf of
|
|
||||||
# the domain, and no one else.
|
|
||||||
records.append((None, "TXT", 'v=spf1 mx -all', "Recommended. Specifies that only the box is permitted to send @%s mail." % domain))
|
|
||||||
|
|
||||||
# Add DNS records for any subdomains of this domain. We should not have a zone for
|
# Add DNS records for any subdomains of this domain. We should not have a zone for
|
||||||
# both a domain and one of its subdomains.
|
# both a domain and one of its subdomains.
|
||||||
subdomains = [d for d in all_domains if d.endswith("." + domain)]
|
subdomains = [d for d in all_domains if d.endswith("." + domain)]
|
||||||
@@ -207,11 +203,13 @@ def build_zone(domain, all_domains, additional_records, env, is_zone=True):
|
|||||||
return False
|
return False
|
||||||
|
|
||||||
# The user may set other records that don't conflict with our settings.
|
# The user may set other records that don't conflict with our settings.
|
||||||
|
# Don't put any TXT records above this line, or it'll prevent any custom TXT records.
|
||||||
for qname, rtype, value in get_custom_records(domain, additional_records, env):
|
for qname, rtype, value in get_custom_records(domain, additional_records, env):
|
||||||
if has_rec(qname, rtype): continue
|
if has_rec(qname, rtype): continue
|
||||||
records.append((qname, rtype, value, "(Set by user.)"))
|
records.append((qname, rtype, value, "(Set by user.)"))
|
||||||
|
|
||||||
# Add defaults if not overridden by the user's custom settings (and not otherwise configured).
|
# Add defaults if not overridden by the user's custom settings (and not otherwise configured).
|
||||||
|
# Any "CNAME" record on the qname overrides A and AAAA.
|
||||||
defaults = [
|
defaults = [
|
||||||
(None, "A", env["PUBLIC_IP"], "Required. May have a different value. Sets the IP address that %s resolves to for web hosting and other services besides mail. The A record must be present but its value does not affect mail delivery." % domain),
|
(None, "A", env["PUBLIC_IP"], "Required. May have a different value. Sets the IP address that %s resolves to for web hosting and other services besides mail. The A record must be present but its value does not affect mail delivery." % domain),
|
||||||
("www", "A", env["PUBLIC_IP"], "Optional. Sets the IP address that www.%s resolves to, e.g. for web hosting." % domain),
|
("www", "A", env["PUBLIC_IP"], "Optional. Sets the IP address that www.%s resolves to, e.g. for web hosting." % domain),
|
||||||
@@ -221,18 +219,32 @@ def build_zone(domain, all_domains, additional_records, env, is_zone=True):
|
|||||||
for qname, rtype, value, explanation in defaults:
|
for qname, rtype, value, explanation in defaults:
|
||||||
if value is None or value.strip() == "": continue # skip IPV6 if not set
|
if value is None or value.strip() == "": continue # skip IPV6 if not set
|
||||||
if not is_zone and qname == "www": continue # don't create any default 'www' subdomains on what are themselves subdomains
|
if not is_zone and qname == "www": continue # don't create any default 'www' subdomains on what are themselves subdomains
|
||||||
if not has_rec(qname, rtype):
|
# Set the default record, but not if:
|
||||||
|
# (1) there is not a user-set record of the same type already
|
||||||
|
# (2) there is not a CNAME record already, since you can't set both and who knows what takes precedence
|
||||||
|
# (2) there is not an A record already (if this is an A record this is a dup of (1), and if this is an AAAA record then don't set a default AAAA record if the user sets a custom A record, since the default wouldn't make sense and it should not resolve if the user doesn't provide a new AAAA record)
|
||||||
|
if not has_rec(qname, rtype) and not has_rec(qname, "CNAME") and not has_rec(qname, "A"):
|
||||||
records.append((qname, rtype, value, explanation))
|
records.append((qname, rtype, value, explanation))
|
||||||
|
|
||||||
|
# SPF record: Permit the box ('mx', see above) to send mail on behalf of
|
||||||
|
# the domain, and no one else.
|
||||||
|
# Skip if the user has set a custom SPF record.
|
||||||
|
if not has_rec(None, "TXT", prefix="v=spf1 "):
|
||||||
|
records.append((None, "TXT", 'v=spf1 mx -all', "Recommended. Specifies that only the box is permitted to send @%s mail." % domain))
|
||||||
|
|
||||||
# Append the DKIM TXT record to the zone as generated by OpenDKIM.
|
# Append the DKIM TXT record to the zone as generated by OpenDKIM.
|
||||||
|
# Skip if the user has set a DKIM record already.
|
||||||
opendkim_record_file = os.path.join(env['STORAGE_ROOT'], 'mail/dkim/mail.txt')
|
opendkim_record_file = os.path.join(env['STORAGE_ROOT'], 'mail/dkim/mail.txt')
|
||||||
with open(opendkim_record_file) as orf:
|
with open(opendkim_record_file) as orf:
|
||||||
m = re.match(r'(\S+)\s+IN\s+TXT\s+\( "([^"]+)"\s+"([^"]+)"\s*\)', orf.read(), re.S)
|
m = re.match(r'(\S+)\s+IN\s+TXT\s+\( "([^"]+)"\s+"([^"]+)"\s*\)', orf.read(), re.S)
|
||||||
val = m.group(2) + m.group(3)
|
val = m.group(2) + m.group(3)
|
||||||
records.append((m.group(1), "TXT", val, "Recommended. Provides a way for recipients to verify that this machine sent @%s mail." % domain))
|
if not has_rec(m.group(1), "TXT", prefix="v=DKIM1; "):
|
||||||
|
records.append((m.group(1), "TXT", val, "Recommended. Provides a way for recipients to verify that this machine sent @%s mail." % domain))
|
||||||
|
|
||||||
# Append a DMARC record.
|
# Append a DMARC record.
|
||||||
records.append(("_dmarc", "TXT", 'v=DMARC1; p=quarantine', "Optional. Specifies that mail that does not originate from the box but claims to be from @%s is suspect and should be quarantined by the recipient's mail system." % domain))
|
# Skip if the user has set a DMARC record already.
|
||||||
|
if not has_rec("_dmarc", "TXT", prefix="v=DMARC1; "):
|
||||||
|
records.append(("_dmarc", "TXT", 'v=DMARC1; p=quarantine', "Optional. Specifies that mail that does not originate from the box but claims to be from @%s is suspect and should be quarantined by the recipient's mail system." % domain))
|
||||||
|
|
||||||
# For any subdomain with an A record but no SPF or DMARC record, add strict policy records.
|
# For any subdomain with an A record but no SPF or DMARC record, add strict policy records.
|
||||||
all_resolvable_qnames = set(r[0] for r in records if r[1] in ("A", "AAAA"))
|
all_resolvable_qnames = set(r[0] for r in records if r[1] in ("A", "AAAA"))
|
||||||
@@ -253,15 +265,22 @@ def build_zone(domain, all_domains, additional_records, env, is_zone=True):
|
|||||||
|
|
||||||
def get_custom_records(domain, additional_records, env):
|
def get_custom_records(domain, additional_records, env):
|
||||||
for qname, value in additional_records.items():
|
for qname, value in additional_records.items():
|
||||||
|
# We don't count the secondary nameserver config (if present) as a record - that would just be
|
||||||
|
# confusing to users. Instead it is accessed/manipulated directly via (get/set)_custom_dns_config.
|
||||||
|
if qname == "_secondary_nameserver": continue
|
||||||
|
|
||||||
# Is this record for the domain or one of its subdomains?
|
# Is this record for the domain or one of its subdomains?
|
||||||
if qname != domain and not qname.endswith("." + domain): continue
|
# If `domain` is None, return records for all domains.
|
||||||
|
if domain is not None and qname != domain and not qname.endswith("." + domain): continue
|
||||||
|
|
||||||
# Turn the fully qualified domain name in the YAML file into
|
# Turn the fully qualified domain name in the YAML file into
|
||||||
# our short form (None => domain, or a relative QNAME).
|
# our short form (None => domain, or a relative QNAME) if
|
||||||
if qname == domain:
|
# domain is not None.
|
||||||
qname = None
|
if domain is not None:
|
||||||
else:
|
if qname == domain:
|
||||||
qname = qname[0:len(qname)-len("." + domain)]
|
qname = None
|
||||||
|
else:
|
||||||
|
qname = qname[0:len(qname)-len("." + domain)]
|
||||||
|
|
||||||
# Short form. Mapping a domain name to a string is short-hand
|
# Short form. Mapping a domain name to a string is short-hand
|
||||||
# for creating A records.
|
# for creating A records.
|
||||||
@@ -378,17 +397,26 @@ $TTL 1800 ; default time to live
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
# Replace replacement strings.
|
# Replace replacement strings.
|
||||||
zone = zone.format(domain=domain, primary_domain=env["PRIMARY_HOSTNAME"])
|
zone = zone.format(domain=domain.encode("idna").decode("ascii"), primary_domain=env["PRIMARY_HOSTNAME"].encode("idna").decode("ascii"))
|
||||||
|
|
||||||
# Add records.
|
# Add records.
|
||||||
for subdomain, querytype, value, explanation in records:
|
for subdomain, querytype, value, explanation in records:
|
||||||
if subdomain:
|
if subdomain:
|
||||||
zone += subdomain
|
zone += subdomain.encode("idna").decode("ascii")
|
||||||
zone += "\tIN\t" + querytype + "\t"
|
zone += "\tIN\t" + querytype + "\t"
|
||||||
if querytype == "TXT":
|
if querytype == "TXT":
|
||||||
|
# Quote and escape.
|
||||||
value = value.replace('\\', '\\\\') # escape backslashes
|
value = value.replace('\\', '\\\\') # escape backslashes
|
||||||
value = value.replace('"', '\\"') # escape quotes
|
value = value.replace('"', '\\"') # escape quotes
|
||||||
value = '"' + value + '"' # wrap in quotes
|
value = '"' + value + '"' # wrap in quotes
|
||||||
|
elif querytype in ("NS", "CNAME"):
|
||||||
|
# These records must be IDNA-encoded.
|
||||||
|
value = value.encode("idna").decode("ascii")
|
||||||
|
elif querytype == "MX":
|
||||||
|
# Also IDNA-encoded, but must parse first.
|
||||||
|
priority, host = value.split(" ", 1)
|
||||||
|
host = host.encode("idna").decode("ascii")
|
||||||
|
value = priority + " " + host
|
||||||
zone += value + "\n"
|
zone += value + "\n"
|
||||||
|
|
||||||
# DNSSEC requires re-signing a zone periodically. That requires
|
# DNSSEC requires re-signing a zone periodically. That requires
|
||||||
@@ -482,7 +510,7 @@ server:
|
|||||||
zone:
|
zone:
|
||||||
name: %s
|
name: %s
|
||||||
zonefile: %s
|
zonefile: %s
|
||||||
""" % (domain, zonefile)
|
""" % (domain.encode("idna").decode("ascii"), zonefile)
|
||||||
|
|
||||||
# If a custom secondary nameserver has been set, allow zone transfers
|
# If a custom secondary nameserver has been set, allow zone transfers
|
||||||
# and notifies to that nameserver.
|
# and notifies to that nameserver.
|
||||||
@@ -490,7 +518,7 @@ zone:
|
|||||||
# Get the IP address of the nameserver by resolving it.
|
# Get the IP address of the nameserver by resolving it.
|
||||||
hostname = additional_records.get("_secondary_nameserver")
|
hostname = additional_records.get("_secondary_nameserver")
|
||||||
resolver = dns.resolver.get_default_resolver()
|
resolver = dns.resolver.get_default_resolver()
|
||||||
response = dns.resolver.query(hostname, "A")
|
response = dns.resolver.query(hostname+'.', "A")
|
||||||
ipaddr = str(response[0])
|
ipaddr = str(response[0])
|
||||||
nsdconf += """\tnotify: %s NOKEY
|
nsdconf += """\tnotify: %s NOKEY
|
||||||
provide-xfr: %s NOKEY
|
provide-xfr: %s NOKEY
|
||||||
@@ -511,8 +539,12 @@ zone:
|
|||||||
########################################################################
|
########################################################################
|
||||||
|
|
||||||
def dnssec_choose_algo(domain, env):
|
def dnssec_choose_algo(domain, env):
|
||||||
if domain.endswith(".email"):
|
if '.' in domain and domain.rsplit('.')[-1] in \
|
||||||
# At least at GoDaddy, this is the only algorithm supported.
|
("email", "guide", "fund"):
|
||||||
|
# At GoDaddy, RSASHA256 is the only algorithm supported
|
||||||
|
# for .email and .guide.
|
||||||
|
# A variety of algorithms are supported for .fund. This
|
||||||
|
# is preferred.
|
||||||
return "RSASHA256"
|
return "RSASHA256"
|
||||||
|
|
||||||
# For any domain we were able to sign before, don't change the algorithm
|
# For any domain we were able to sign before, don't change the algorithm
|
||||||
@@ -523,6 +555,9 @@ def sign_zone(domain, zonefile, env):
|
|||||||
algo = dnssec_choose_algo(domain, env)
|
algo = dnssec_choose_algo(domain, env)
|
||||||
dnssec_keys = load_env_vars_from_file(os.path.join(env['STORAGE_ROOT'], 'dns/dnssec/%s.conf' % algo))
|
dnssec_keys = load_env_vars_from_file(os.path.join(env['STORAGE_ROOT'], 'dns/dnssec/%s.conf' % algo))
|
||||||
|
|
||||||
|
# From here, use the IDNA encoding of the domain name.
|
||||||
|
domain = domain.encode("idna").decode("ascii")
|
||||||
|
|
||||||
# In order to use the same keys for all domains, we have to generate
|
# In order to use the same keys for all domains, we have to generate
|
||||||
# a new .key file with a DNSSEC record for the specific domain. We
|
# a new .key file with a DNSSEC record for the specific domain. We
|
||||||
# can reuse the same key, but it won't validate without a DNSSEC
|
# can reuse the same key, but it won't validate without a DNSSEC
|
||||||
@@ -592,8 +627,9 @@ def sign_zone(domain, zonefile, env):
|
|||||||
|
|
||||||
########################################################################
|
########################################################################
|
||||||
|
|
||||||
def write_opendkim_tables(zonefiles, env):
|
def write_opendkim_tables(domains, env):
|
||||||
# Append a record to OpenDKIM's KeyTable and SigningTable for each domain.
|
# Append a record to OpenDKIM's KeyTable and SigningTable for each domain
|
||||||
|
# that we send mail from (zones and all subdomains).
|
||||||
|
|
||||||
opendkim_key_file = os.path.join(env['STORAGE_ROOT'], 'mail/dkim/mail.private')
|
opendkim_key_file = os.path.join(env['STORAGE_ROOT'], 'mail/dkim/mail.private')
|
||||||
|
|
||||||
@@ -612,7 +648,7 @@ def write_opendkim_tables(zonefiles, env):
|
|||||||
"SigningTable":
|
"SigningTable":
|
||||||
"".join(
|
"".join(
|
||||||
"*@{domain} {domain}\n".format(domain=domain)
|
"*@{domain} {domain}\n".format(domain=domain)
|
||||||
for domain, zonefile in zonefiles
|
for domain in domains
|
||||||
),
|
),
|
||||||
|
|
||||||
# The KeyTable specifies the signing domain, the DKIM selector, and the
|
# The KeyTable specifies the signing domain, the DKIM selector, and the
|
||||||
@@ -621,7 +657,7 @@ def write_opendkim_tables(zonefiles, env):
|
|||||||
"KeyTable":
|
"KeyTable":
|
||||||
"".join(
|
"".join(
|
||||||
"{domain} {domain}:mail:{key_file}\n".format(domain=domain, key_file=opendkim_key_file)
|
"{domain} {domain}:mail:{key_file}\n".format(domain=domain, key_file=opendkim_key_file)
|
||||||
for domain, zonefile in zonefiles
|
for domain in domains
|
||||||
),
|
),
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -662,7 +698,7 @@ def set_custom_dns_record(qname, rtype, value, env):
|
|||||||
v = ipaddress.ip_address(value)
|
v = ipaddress.ip_address(value)
|
||||||
if rtype == "A" and not isinstance(v, ipaddress.IPv4Address): raise ValueError("That's an IPv6 address.")
|
if rtype == "A" and not isinstance(v, ipaddress.IPv4Address): raise ValueError("That's an IPv6 address.")
|
||||||
if rtype == "AAAA" and not isinstance(v, ipaddress.IPv6Address): raise ValueError("That's an IPv4 address.")
|
if rtype == "AAAA" and not isinstance(v, ipaddress.IPv6Address): raise ValueError("That's an IPv4 address.")
|
||||||
elif rtype in ("CNAME", "TXT"):
|
elif rtype in ("CNAME", "TXT", "SRV", "MX"):
|
||||||
# anything goes
|
# anything goes
|
||||||
pass
|
pass
|
||||||
else:
|
else:
|
||||||
|
|||||||
@@ -18,8 +18,9 @@ def scan_mail_log(logger, env):
|
|||||||
|
|
||||||
for fn in ('/var/log/mail.log.1', '/var/log/mail.log'):
|
for fn in ('/var/log/mail.log.1', '/var/log/mail.log'):
|
||||||
if not os.path.exists(fn): continue
|
if not os.path.exists(fn): continue
|
||||||
with open(fn) as log:
|
with open(fn, 'rb') as log:
|
||||||
for line in log:
|
for line in log:
|
||||||
|
line = line.decode("utf8", errors='replace')
|
||||||
scan_mail_log_line(line.strip(), collector)
|
scan_mail_log_line(line.strip(), collector)
|
||||||
|
|
||||||
if collector["imap-logins"]:
|
if collector["imap-logins"]:
|
||||||
@@ -96,6 +97,21 @@ def scan_postfix_smtpd_line(date, log, collector):
|
|||||||
message, sender, recipient = m.groups()
|
message, sender, recipient = m.groups()
|
||||||
if recipient in collector["real_mail_addresses"]:
|
if recipient in collector["real_mail_addresses"]:
|
||||||
# only log mail to real recipients
|
# only log mail to real recipients
|
||||||
|
|
||||||
|
# skip this, is reported in the greylisting report
|
||||||
|
if "Recipient address rejected: Greylisted" in message:
|
||||||
|
return
|
||||||
|
|
||||||
|
# simplify this one
|
||||||
|
m = re.search(r"Client host \[(.*?)\] blocked using zen.spamhaus.org; (.*)", message)
|
||||||
|
if m:
|
||||||
|
message = "ip blocked: " + m.group(2)
|
||||||
|
|
||||||
|
# simplify this one too
|
||||||
|
m = re.search(r"Sender address \[.*@(.*)\] blocked using dbl.spamhaus.org; (.*)", message)
|
||||||
|
if m:
|
||||||
|
message = "domain blocked: " + m.group(2)
|
||||||
|
|
||||||
collector["rejected-mail"].setdefault(recipient, []).append( (date, sender, message) )
|
collector["rejected-mail"].setdefault(recipient, []).append( (date, sender, message) )
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -14,8 +14,8 @@ def validate_email(email, mode=None):
|
|||||||
|
|
||||||
if mode == 'user':
|
if mode == 'user':
|
||||||
# For Dovecot's benefit, only allow basic characters.
|
# For Dovecot's benefit, only allow basic characters.
|
||||||
ATEXT = r'[\w\-]'
|
ATEXT = r'[a-zA-Z0-9_\-]'
|
||||||
elif mode == 'alias':
|
elif mode in (None, 'alias'):
|
||||||
# For aliases, we can allow any valid email address.
|
# For aliases, we can allow any valid email address.
|
||||||
# Based on RFC 2822 and https://github.com/SyrusAkbary/validate_email/blob/master/validate_email.py,
|
# Based on RFC 2822 and https://github.com/SyrusAkbary/validate_email/blob/master/validate_email.py,
|
||||||
# these characters are permitted in email addresses.
|
# these characters are permitted in email addresses.
|
||||||
@@ -27,7 +27,8 @@ def validate_email(email, mode=None):
|
|||||||
DOT_ATOM_TEXT_LOCAL = ATEXT + r'+(?:\.' + ATEXT + r'+)*'
|
DOT_ATOM_TEXT_LOCAL = ATEXT + r'+(?:\.' + ATEXT + r'+)*'
|
||||||
if mode == 'alias':
|
if mode == 'alias':
|
||||||
# For aliases, Postfix accepts '@domain.tld' format for
|
# For aliases, Postfix accepts '@domain.tld' format for
|
||||||
# catch-all addresses. Make the local part optional.
|
# catch-all addresses on the source side and domain aliases
|
||||||
|
# on the destination side. Make the local part optional.
|
||||||
DOT_ATOM_TEXT_LOCAL = '(?:' + DOT_ATOM_TEXT_LOCAL + ')?'
|
DOT_ATOM_TEXT_LOCAL = '(?:' + DOT_ATOM_TEXT_LOCAL + ')?'
|
||||||
|
|
||||||
# as above, but we can require that the host part have at least
|
# as above, but we can require that the host part have at least
|
||||||
@@ -35,9 +36,34 @@ def validate_email(email, mode=None):
|
|||||||
DOT_ATOM_TEXT_HOST = ATEXT + r'+(?:\.' + ATEXT + r'+)+'
|
DOT_ATOM_TEXT_HOST = ATEXT + r'+(?:\.' + ATEXT + r'+)+'
|
||||||
|
|
||||||
# per RFC 2822 3.4.1
|
# per RFC 2822 3.4.1
|
||||||
ADDR_SPEC = '^%s@%s$' % (DOT_ATOM_TEXT_LOCAL, DOT_ATOM_TEXT_HOST)
|
ADDR_SPEC = '^(%s)@(%s)$' % (DOT_ATOM_TEXT_LOCAL, DOT_ATOM_TEXT_HOST)
|
||||||
|
|
||||||
return re.match(ADDR_SPEC, email)
|
# Check the regular expression.
|
||||||
|
m = re.match(ADDR_SPEC, email)
|
||||||
|
if not m: return False
|
||||||
|
|
||||||
|
# Check that the domain part is IDNA-encodable.
|
||||||
|
localpart, domainpart = m.groups()
|
||||||
|
try:
|
||||||
|
domainpart.encode("idna")
|
||||||
|
except:
|
||||||
|
return False
|
||||||
|
|
||||||
|
return True
|
||||||
|
|
||||||
|
def sanitize_idn_email_address(email):
|
||||||
|
# Convert an IDNA-encoded email address (domain part) into Unicode
|
||||||
|
# before storing in our database. Chrome may IDNA-ize <input type="email">
|
||||||
|
# values before POSTing, so we want to normalize before putting
|
||||||
|
# values into the database.
|
||||||
|
try:
|
||||||
|
localpart, domainpart = email.split("@")
|
||||||
|
domainpart = domainpart.encode("ascii").decode("idna")
|
||||||
|
return localpart + "@" + domainpart
|
||||||
|
except:
|
||||||
|
# Domain part is already Unicode or not IDNA-valid, so
|
||||||
|
# leave unchanged.
|
||||||
|
return email
|
||||||
|
|
||||||
def open_database(env, with_connection=False):
|
def open_database(env, with_connection=False):
|
||||||
conn = sqlite3.connect(env["STORAGE_ROOT"] + "/mail/users.sqlite")
|
conn = sqlite3.connect(env["STORAGE_ROOT"] + "/mail/users.sqlite")
|
||||||
@@ -65,10 +91,6 @@ def get_mail_users_ex(env, with_archived=False, with_slow_info=False):
|
|||||||
# email: "name@domain.tld",
|
# email: "name@domain.tld",
|
||||||
# privileges: [ "priv1", "priv2", ... ],
|
# privileges: [ "priv1", "priv2", ... ],
|
||||||
# status: "active",
|
# status: "active",
|
||||||
# aliases: [
|
|
||||||
# ("alias@domain.tld", ["indirect.alias@domain.tld", ...]),
|
|
||||||
# ...
|
|
||||||
# ]
|
|
||||||
# },
|
# },
|
||||||
# ...
|
# ...
|
||||||
# ]
|
# ]
|
||||||
@@ -76,9 +98,6 @@ def get_mail_users_ex(env, with_archived=False, with_slow_info=False):
|
|||||||
# ...
|
# ...
|
||||||
# ]
|
# ]
|
||||||
|
|
||||||
# Pre-load all aliases.
|
|
||||||
aliases = get_mail_alias_map(env)
|
|
||||||
|
|
||||||
# Get users and their privileges.
|
# Get users and their privileges.
|
||||||
users = []
|
users = []
|
||||||
active_accounts = set()
|
active_accounts = set()
|
||||||
@@ -95,10 +114,6 @@ def get_mail_users_ex(env, with_archived=False, with_slow_info=False):
|
|||||||
users.append(user)
|
users.append(user)
|
||||||
|
|
||||||
if with_slow_info:
|
if with_slow_info:
|
||||||
user["aliases"] = [
|
|
||||||
(alias, sorted(evaluate_mail_alias_map(alias, aliases, env)))
|
|
||||||
for alias in aliases.get(email.lower(), [])
|
|
||||||
]
|
|
||||||
user["mailbox_size"] = utils.du(os.path.join(env['STORAGE_ROOT'], 'mail/mailboxes', *reversed(email.split("@"))))
|
user["mailbox_size"] = utils.du(os.path.join(env['STORAGE_ROOT'], 'mail/mailboxes', *reversed(email.split("@"))))
|
||||||
|
|
||||||
# Add in archived accounts.
|
# Add in archived accounts.
|
||||||
@@ -204,21 +219,6 @@ def get_mail_aliases_ex(env):
|
|||||||
domain["aliases"].sort(key = lambda alias : (alias["required"], alias["source"]))
|
domain["aliases"].sort(key = lambda alias : (alias["required"], alias["source"]))
|
||||||
return domains
|
return domains
|
||||||
|
|
||||||
def get_mail_alias_map(env):
|
|
||||||
aliases = { }
|
|
||||||
for alias, targets in get_mail_aliases(env):
|
|
||||||
for em in targets.split(","):
|
|
||||||
em = em.strip().lower()
|
|
||||||
aliases.setdefault(em, []).append(alias)
|
|
||||||
return aliases
|
|
||||||
|
|
||||||
def evaluate_mail_alias_map(email, aliases, env):
|
|
||||||
ret = set()
|
|
||||||
for alias in aliases.get(email.lower(), []):
|
|
||||||
ret.add(alias)
|
|
||||||
ret |= evaluate_mail_alias_map(alias, aliases, env)
|
|
||||||
return ret
|
|
||||||
|
|
||||||
def get_domain(emailaddr):
|
def get_domain(emailaddr):
|
||||||
return emailaddr.split('@', 1)[1]
|
return emailaddr.split('@', 1)[1]
|
||||||
|
|
||||||
@@ -229,11 +229,16 @@ def get_mail_domains(env, filter_aliases=lambda alias : True):
|
|||||||
)
|
)
|
||||||
|
|
||||||
def add_mail_user(email, pw, privs, env):
|
def add_mail_user(email, pw, privs, env):
|
||||||
|
# accept IDNA domain names but normalize to Unicode before going into database
|
||||||
|
email = sanitize_idn_email_address(email)
|
||||||
|
|
||||||
# validate email
|
# validate email
|
||||||
if email.strip() == "":
|
if email.strip() == "":
|
||||||
return ("No email address provided.", 400)
|
return ("No email address provided.", 400)
|
||||||
if not validate_email(email, mode='user'):
|
elif not validate_email(email):
|
||||||
return ("Invalid email address.", 400)
|
return ("Invalid email address.", 400)
|
||||||
|
elif not validate_email(email, mode='user'):
|
||||||
|
return ("User account email addresses may only use the ASCII letters A-Z, the digits 0-9, underscore (_), hyphen (-), and period (.).", 400)
|
||||||
|
|
||||||
validate_password(pw)
|
validate_password(pw)
|
||||||
|
|
||||||
@@ -250,7 +255,7 @@ def add_mail_user(email, pw, privs, env):
|
|||||||
conn, c = open_database(env, with_connection=True)
|
conn, c = open_database(env, with_connection=True)
|
||||||
|
|
||||||
# hash the password
|
# hash the password
|
||||||
pw = utils.shell('check_output', ["/usr/bin/doveadm", "pw", "-s", "SHA512-CRYPT", "-p", pw]).strip()
|
pw = hash_password(pw)
|
||||||
|
|
||||||
# add the user to the database
|
# add the user to the database
|
||||||
try:
|
try:
|
||||||
@@ -262,9 +267,11 @@ def add_mail_user(email, pw, privs, env):
|
|||||||
# write databasebefore next step
|
# write databasebefore next step
|
||||||
conn.commit()
|
conn.commit()
|
||||||
|
|
||||||
# Create the user's INBOX, Spam, and Drafts folders, and subscribe them.
|
# Create & subscribe the user's INBOX, Trash, Spam, and Drafts folders.
|
||||||
# K-9 mail will poll every 90 seconds if a Drafts folder does not exist, so create it
|
# * Our sieve rule for spam expects that the Spam folder exists.
|
||||||
# to avoid unnecessary polling.
|
# * Roundcube will show an error if the user tries to delete a message before the Trash folder exists (#359).
|
||||||
|
# * K-9 mail will poll every 90 seconds if a Drafts folder does not exist, so create it
|
||||||
|
# to avoid unnecessary polling.
|
||||||
|
|
||||||
# Check if the mailboxes exist before creating them. When creating a user that had previously
|
# Check if the mailboxes exist before creating them. When creating a user that had previously
|
||||||
# been deleted, the mailboxes will still exist because they are still on disk.
|
# been deleted, the mailboxes will still exist because they are still on disk.
|
||||||
@@ -275,7 +282,7 @@ def add_mail_user(email, pw, privs, env):
|
|||||||
conn.commit()
|
conn.commit()
|
||||||
return ("Failed to initialize the user: " + e.output.decode("utf8"), 400)
|
return ("Failed to initialize the user: " + e.output.decode("utf8"), 400)
|
||||||
|
|
||||||
for folder in ("INBOX", "Spam", "Drafts"):
|
for folder in ("INBOX", "Trash", "Spam", "Drafts"):
|
||||||
if folder not in existing_mboxes:
|
if folder not in existing_mboxes:
|
||||||
utils.shell('check_call', ["doveadm", "mailbox", "create", "-u", email, "-s", folder])
|
utils.shell('check_call', ["doveadm", "mailbox", "create", "-u", email, "-s", folder])
|
||||||
|
|
||||||
@@ -283,10 +290,14 @@ def add_mail_user(email, pw, privs, env):
|
|||||||
return kick(env, "mail user added")
|
return kick(env, "mail user added")
|
||||||
|
|
||||||
def set_mail_password(email, pw, env):
|
def set_mail_password(email, pw, env):
|
||||||
|
# accept IDNA domain names but normalize to Unicode before going into database
|
||||||
|
email = sanitize_idn_email_address(email)
|
||||||
|
|
||||||
|
# validate that password is acceptable
|
||||||
validate_password(pw)
|
validate_password(pw)
|
||||||
|
|
||||||
# hash the password
|
# hash the password
|
||||||
pw = utils.shell('check_output', ["/usr/bin/doveadm", "pw", "-s", "SHA512-CRYPT", "-p", pw]).strip()
|
pw = hash_password(pw)
|
||||||
|
|
||||||
# update the database
|
# update the database
|
||||||
conn, c = open_database(env, with_connection=True)
|
conn, c = open_database(env, with_connection=True)
|
||||||
@@ -296,7 +307,29 @@ def set_mail_password(email, pw, env):
|
|||||||
conn.commit()
|
conn.commit()
|
||||||
return "OK"
|
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()
|
||||||
|
|
||||||
|
def get_mail_password(email, env):
|
||||||
|
# Gets the hashed password for a user. Passwords are stored in Dovecot's
|
||||||
|
# password format, with a prefixed scheme.
|
||||||
|
# http://wiki2.dovecot.org/Authentication/PasswordSchemes
|
||||||
|
# update the database
|
||||||
|
c = open_database(env)
|
||||||
|
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):
|
def remove_mail_user(email, env):
|
||||||
|
# accept IDNA domain names but normalize to Unicode before going into database
|
||||||
|
email = sanitize_idn_email_address(email)
|
||||||
|
|
||||||
|
# remove
|
||||||
conn, c = open_database(env, with_connection=True)
|
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:
|
if c.rowcount != 1:
|
||||||
@@ -310,6 +343,10 @@ def parse_privs(value):
|
|||||||
return [p for p in value.split("\n") if p.strip() != ""]
|
return [p for p in value.split("\n") if p.strip() != ""]
|
||||||
|
|
||||||
def get_mail_user_privileges(email, env):
|
def get_mail_user_privileges(email, env):
|
||||||
|
# accept IDNA domain names but normalize to Unicode before going into database
|
||||||
|
email = sanitize_idn_email_address(email)
|
||||||
|
|
||||||
|
# get privs
|
||||||
c = open_database(env)
|
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()
|
rows = c.fetchall()
|
||||||
@@ -323,6 +360,9 @@ def validate_privilege(priv):
|
|||||||
return None
|
return None
|
||||||
|
|
||||||
def add_remove_mail_user_privilege(email, priv, action, env):
|
def add_remove_mail_user_privilege(email, priv, action, env):
|
||||||
|
# accept IDNA domain names but normalize to Unicode before going into database
|
||||||
|
email = sanitize_idn_email_address(email)
|
||||||
|
|
||||||
# validate
|
# validate
|
||||||
validation = validate_privilege(priv)
|
validation = validate_privilege(priv)
|
||||||
if validation: return validation
|
if validation: return validation
|
||||||
@@ -350,25 +390,38 @@ def add_remove_mail_user_privilege(email, priv, action, env):
|
|||||||
return "OK"
|
return "OK"
|
||||||
|
|
||||||
def add_mail_alias(source, destination, env, update_if_exists=False, do_kick=True):
|
def add_mail_alias(source, destination, env, update_if_exists=False, do_kick=True):
|
||||||
|
# accept IDNA domain names but normalize to Unicode before going into database
|
||||||
|
source = sanitize_idn_email_address(source)
|
||||||
|
|
||||||
# validate source
|
# validate source
|
||||||
if source.strip() == "":
|
if source.strip() == "":
|
||||||
return ("No incoming email address provided.", 400)
|
return ("No incoming email address provided.", 400)
|
||||||
if not validate_email(source, mode='alias'):
|
if not validate_email(source, mode='alias'):
|
||||||
return ("Invalid incoming email address (%s)." % source, 400)
|
return ("Invalid incoming email address (%s)." % source, 400)
|
||||||
|
|
||||||
# parse comma and \n-separated destination emails & validate
|
# validate destination
|
||||||
dests = []
|
dests = []
|
||||||
for line in destination.split("\n"):
|
destination = destination.strip()
|
||||||
for email in line.split(","):
|
if validate_email(destination, mode='alias'):
|
||||||
email = email.strip()
|
# Oostfix allows a single @domain.tld as the destination, which means
|
||||||
if email == "": continue
|
# the local part on the address is preserved in the rewrite.
|
||||||
if not validate_email(email, mode='alias'):
|
dests.append(sanitize_idn_email_address(destination))
|
||||||
return ("Invalid destination email address (%s)." % email, 400)
|
else:
|
||||||
dests.append(email)
|
# Parse comma and \n-separated destination emails & validate. In this
|
||||||
|
# case, the recipients must be complete email addresses.
|
||||||
|
for line in destination.split("\n"):
|
||||||
|
for email in line.split(","):
|
||||||
|
email = email.strip()
|
||||||
|
email = sanitize_idn_email_address(email) # Unicode => IDNA
|
||||||
|
if email == "": continue
|
||||||
|
if not validate_email(email):
|
||||||
|
return ("Invalid destination email address (%s)." % email, 400)
|
||||||
|
dests.append(email)
|
||||||
if len(destination) == 0:
|
if len(destination) == 0:
|
||||||
return ("No destination email address(es) provided.", 400)
|
return ("No destination email address(es) provided.", 400)
|
||||||
destination = ",".join(dests)
|
destination = ",".join(dests)
|
||||||
|
|
||||||
|
# save to db
|
||||||
conn, c = open_database(env, with_connection=True)
|
conn, c = open_database(env, with_connection=True)
|
||||||
try:
|
try:
|
||||||
c.execute("INSERT INTO aliases (source, destination) VALUES (?, ?)", (source, destination))
|
c.execute("INSERT INTO aliases (source, destination) VALUES (?, ?)", (source, destination))
|
||||||
@@ -387,6 +440,10 @@ def add_mail_alias(source, destination, env, update_if_exists=False, do_kick=Tru
|
|||||||
return kick(env, return_status)
|
return kick(env, return_status)
|
||||||
|
|
||||||
def remove_mail_alias(source, env, do_kick=True):
|
def remove_mail_alias(source, env, do_kick=True):
|
||||||
|
# accept IDNA domain names but normalize to Unicode before going into database
|
||||||
|
source = sanitize_idn_email_address(source)
|
||||||
|
|
||||||
|
# remove
|
||||||
conn, c = open_database(env, with_connection=True)
|
conn, c = open_database(env, with_connection=True)
|
||||||
c.execute("DELETE FROM aliases WHERE source=?", (source,))
|
c.execute("DELETE FROM aliases WHERE source=?", (source,))
|
||||||
if c.rowcount != 1:
|
if c.rowcount != 1:
|
||||||
@@ -408,12 +465,12 @@ def get_required_aliases(env):
|
|||||||
aliases.add("hostmaster@" + env['PRIMARY_HOSTNAME'])
|
aliases.add("hostmaster@" + env['PRIMARY_HOSTNAME'])
|
||||||
|
|
||||||
# Get a list of domains we serve mail for, except ones for which the only
|
# Get a list of domains we serve mail for, except ones for which the only
|
||||||
# email on that domain is a postmaster/admin alias to the administrator.
|
# email on that domain is a postmaster/admin alias to the administrator
|
||||||
|
# or a wildcard alias (since it will forward postmaster/admin).
|
||||||
real_mail_domains = get_mail_domains(env,
|
real_mail_domains = get_mail_domains(env,
|
||||||
filter_aliases = lambda alias : \
|
filter_aliases = lambda alias :
|
||||||
(not alias[0].startswith("postmaster@") \
|
((not alias[0].startswith("postmaster@") and not alias[0].startswith("admin@")) or alias[1] != get_system_administrator(env))
|
||||||
and not alias[0].startswith("admin@")) \
|
and not alias[0].startswith("@")
|
||||||
or alias[1] != get_system_administrator(env) \
|
|
||||||
)
|
)
|
||||||
|
|
||||||
# Create postmaster@ and admin@ for all domains we serve mail on.
|
# Create postmaster@ and admin@ for all domains we serve mail on.
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
|
|
||||||
__ALL__ = ['check_certificate']
|
__ALL__ = ['check_certificate']
|
||||||
|
|
||||||
import os, os.path, re, subprocess, datetime
|
import sys, os, os.path, re, subprocess, datetime, multiprocessing.pool
|
||||||
|
|
||||||
import dns.reversename, dns.resolver
|
import dns.reversename, dns.resolver
|
||||||
import dateutil.parser, dateutil.tz
|
import dateutil.parser, dateutil.tz
|
||||||
@@ -17,67 +17,190 @@ from mailconfig import get_mail_domains, get_mail_aliases
|
|||||||
|
|
||||||
from utils import shell, sort_domains, load_env_vars_from_file
|
from utils import shell, sort_domains, load_env_vars_from_file
|
||||||
|
|
||||||
def run_checks(env, output):
|
def run_checks(rounded_values, env, output, pool):
|
||||||
env["out"] = output
|
# run systems checks
|
||||||
run_system_checks(env)
|
output.add_heading("System")
|
||||||
run_network_checks(env)
|
|
||||||
run_domain_checks(env)
|
|
||||||
|
|
||||||
def run_system_checks(env):
|
# check that services are running
|
||||||
env["out"].add_heading("System")
|
if not run_services_checks(env, output, pool):
|
||||||
|
# If critical services are not running, stop. If bind9 isn't running,
|
||||||
|
# all later DNS checks will timeout and that will take forever to
|
||||||
|
# go through, and if running over the web will cause a fastcgi timeout.
|
||||||
|
return
|
||||||
|
|
||||||
# Check that SSH login with password is disabled.
|
# clear bind9's DNS cache so our DNS checks are up to date
|
||||||
|
# (ignore errors; if bind9/rndc isn't running we'd already report
|
||||||
|
# that in run_services checks.)
|
||||||
|
shell('check_call', ["/usr/sbin/rndc", "flush"], trap=True)
|
||||||
|
|
||||||
|
run_system_checks(rounded_values, env, output)
|
||||||
|
|
||||||
|
# perform other checks asynchronously
|
||||||
|
|
||||||
|
run_network_checks(env, output)
|
||||||
|
run_domain_checks(rounded_values, env, output, pool)
|
||||||
|
|
||||||
|
def get_ssh_port():
|
||||||
|
# Returns ssh port
|
||||||
|
output = shell('check_output', ['sshd', '-T'])
|
||||||
|
returnNext = False
|
||||||
|
|
||||||
|
for e in output.split():
|
||||||
|
if returnNext:
|
||||||
|
return int(e)
|
||||||
|
if e == "port":
|
||||||
|
returnNext = True
|
||||||
|
|
||||||
|
def run_services_checks(env, output, pool):
|
||||||
|
# Check that system services are running.
|
||||||
|
|
||||||
|
services = [
|
||||||
|
{ "name": "Local DNS (bind9)", "port": 53, "public": False, },
|
||||||
|
#{ "name": "NSD Control", "port": 8952, "public": False, },
|
||||||
|
{ "name": "Local DNS Control (bind9/rndc)", "port": 953, "public": False, },
|
||||||
|
{ "name": "Dovecot LMTP LDA", "port": 10026, "public": False, },
|
||||||
|
{ "name": "Postgrey", "port": 10023, "public": False, },
|
||||||
|
{ "name": "Spamassassin", "port": 10025, "public": False, },
|
||||||
|
{ "name": "OpenDKIM", "port": 8891, "public": False, },
|
||||||
|
{ "name": "OpenDMARC", "port": 8893, "public": False, },
|
||||||
|
{ "name": "Memcached", "port": 11211, "public": False, },
|
||||||
|
{ "name": "Sieve (dovecot)", "port": 4190, "public": False, },
|
||||||
|
{ "name": "Mail-in-a-Box Management Daemon", "port": 10222, "public": False, },
|
||||||
|
|
||||||
|
{ "name": "SSH Login (ssh)", "port": get_ssh_port(), "public": True, },
|
||||||
|
{ "name": "Public DNS (nsd4)", "port": 53, "public": True, },
|
||||||
|
{ "name": "Incoming Mail (SMTP/postfix)", "port": 25, "public": True, },
|
||||||
|
{ "name": "Outgoing Mail (SMTP 587/postfix)", "port": 587, "public": True, },
|
||||||
|
#{ "name": "Postfix/master", "port": 10587, "public": True, },
|
||||||
|
{ "name": "IMAPS (dovecot)", "port": 993, "public": True, },
|
||||||
|
{ "name": "HTTP Web (nginx)", "port": 80, "public": True, },
|
||||||
|
{ "name": "HTTPS Web (nginx)", "port": 443, "public": True, },
|
||||||
|
]
|
||||||
|
|
||||||
|
all_running = True
|
||||||
|
fatal = False
|
||||||
|
ret = pool.starmap(check_service, ((i, service, env) for i, service in enumerate(services)), chunksize=1)
|
||||||
|
for i, running, fatal2, output2 in sorted(ret):
|
||||||
|
all_running = all_running and running
|
||||||
|
fatal = fatal or fatal2
|
||||||
|
output2.playback(output)
|
||||||
|
|
||||||
|
if all_running:
|
||||||
|
output.print_ok("All system services are running.")
|
||||||
|
|
||||||
|
return not fatal
|
||||||
|
|
||||||
|
def check_service(i, service, env):
|
||||||
|
import socket
|
||||||
|
output = BufferedOutput()
|
||||||
|
running = False
|
||||||
|
fatal = False
|
||||||
|
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
||||||
|
s.settimeout(1)
|
||||||
|
try:
|
||||||
|
try:
|
||||||
|
s.connect((
|
||||||
|
"127.0.0.1" if not service["public"] else env['PUBLIC_IP'],
|
||||||
|
service["port"]))
|
||||||
|
running = True
|
||||||
|
except OSError as e1:
|
||||||
|
if service["public"] and service["port"] != 53:
|
||||||
|
# For public services (except DNS), try the private IP as a fallback.
|
||||||
|
s1 = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
||||||
|
s1.settimeout(1)
|
||||||
|
try:
|
||||||
|
s1.connect(("127.0.0.1", service["port"]))
|
||||||
|
output.print_error("%s is running but is not publicly accessible at %s:%d (%s)." % (service['name'], env['PUBLIC_IP'], service['port'], str(e1)))
|
||||||
|
except:
|
||||||
|
raise e1
|
||||||
|
finally:
|
||||||
|
s1.close()
|
||||||
|
else:
|
||||||
|
raise
|
||||||
|
|
||||||
|
except OSError as e:
|
||||||
|
output.print_error("%s is not running (%s; port %d)." % (service['name'], str(e), service['port']))
|
||||||
|
|
||||||
|
# Why is nginx not running?
|
||||||
|
if service["port"] in (80, 443):
|
||||||
|
output.print_line(shell('check_output', ['nginx', '-t'], capture_stderr=True, trap=True)[1].strip())
|
||||||
|
|
||||||
|
# Flag if local DNS is not running.
|
||||||
|
if service["port"] == 53 and service["public"] == False:
|
||||||
|
fatal = True
|
||||||
|
finally:
|
||||||
|
s.close()
|
||||||
|
|
||||||
|
return (i, running, fatal, output)
|
||||||
|
|
||||||
|
def run_system_checks(rounded_values, env, output):
|
||||||
|
check_ssh_password(env, output)
|
||||||
|
check_software_updates(env, output)
|
||||||
|
check_system_aliases(env, output)
|
||||||
|
check_free_disk_space(rounded_values, env, output)
|
||||||
|
|
||||||
|
def check_ssh_password(env, output):
|
||||||
|
# Check that SSH login with password is disabled. The openssh-server
|
||||||
|
# package may not be installed so check that before trying to access
|
||||||
|
# the configuration file.
|
||||||
|
if not os.path.exists("/etc/ssh/sshd_config"):
|
||||||
|
return
|
||||||
sshd = open("/etc/ssh/sshd_config").read()
|
sshd = open("/etc/ssh/sshd_config").read()
|
||||||
if re.search("\nPasswordAuthentication\s+yes", sshd) \
|
if re.search("\nPasswordAuthentication\s+yes", sshd) \
|
||||||
or not re.search("\nPasswordAuthentication\s+no", sshd):
|
or not re.search("\nPasswordAuthentication\s+no", sshd):
|
||||||
env['out'].print_error("""The SSH server on this machine permits password-based login. A more secure
|
output.print_error("""The SSH server on this machine permits password-based login. A more secure
|
||||||
way to log in is using a public key. Add your SSH public key to $HOME/.ssh/authorized_keys, check
|
way to log in is using a public key. Add your SSH public key to $HOME/.ssh/authorized_keys, check
|
||||||
that you can log in without a password, set the option 'PasswordAuthentication no' in
|
that you can log in without a password, set the option 'PasswordAuthentication no' in
|
||||||
/etc/ssh/sshd_config, and then restart the openssh via 'sudo service ssh restart'.""")
|
/etc/ssh/sshd_config, and then restart the openssh via 'sudo service ssh restart'.""")
|
||||||
else:
|
else:
|
||||||
env['out'].print_ok("SSH disallows password-based login.")
|
output.print_ok("SSH disallows password-based login.")
|
||||||
|
|
||||||
|
def check_software_updates(env, output):
|
||||||
# Check for any software package updates.
|
# Check for any software package updates.
|
||||||
pkgs = list_apt_updates(apt_update=False)
|
pkgs = list_apt_updates(apt_update=False)
|
||||||
if os.path.exists("/var/run/reboot-required"):
|
if os.path.exists("/var/run/reboot-required"):
|
||||||
env['out'].print_error("System updates have been installed and a reboot of the machine is required.")
|
output.print_error("System updates have been installed and a reboot of the machine is required.")
|
||||||
elif len(pkgs) == 0:
|
elif len(pkgs) == 0:
|
||||||
env['out'].print_ok("System software is up to date.")
|
output.print_ok("System software is up to date.")
|
||||||
else:
|
else:
|
||||||
env['out'].print_error("There are %d software packages that can be updated." % len(pkgs))
|
output.print_error("There are %d software packages that can be updated." % len(pkgs))
|
||||||
for p in pkgs:
|
for p in pkgs:
|
||||||
env['out'].print_line("%s (%s)" % (p["package"], p["version"]))
|
output.print_line("%s (%s)" % (p["package"], p["version"]))
|
||||||
|
|
||||||
|
def check_system_aliases(env, output):
|
||||||
# Check that the administrator alias exists since that's where all
|
# Check that the administrator alias exists since that's where all
|
||||||
# admin email is automatically directed.
|
# admin email is automatically directed.
|
||||||
check_alias_exists("administrator@" + env['PRIMARY_HOSTNAME'], env)
|
check_alias_exists("administrator@" + env['PRIMARY_HOSTNAME'], env, output)
|
||||||
|
|
||||||
|
def check_free_disk_space(rounded_values, env, output):
|
||||||
# Check free disk space.
|
# Check free disk space.
|
||||||
st = os.statvfs(env['STORAGE_ROOT'])
|
st = os.statvfs(env['STORAGE_ROOT'])
|
||||||
bytes_total = st.f_blocks * st.f_frsize
|
bytes_total = st.f_blocks * st.f_frsize
|
||||||
bytes_free = st.f_bavail * st.f_frsize
|
bytes_free = st.f_bavail * st.f_frsize
|
||||||
disk_msg = "The disk has %s GB space remaining." % str(round(bytes_free/1024.0/1024.0/1024.0*10.0)/10.0)
|
if not rounded_values:
|
||||||
if bytes_free > .3 * bytes_total:
|
disk_msg = "The disk has %s GB space remaining." % str(round(bytes_free/1024.0/1024.0/1024.0*10.0)/10)
|
||||||
env['out'].print_ok(disk_msg)
|
|
||||||
elif bytes_free > .15 * bytes_total:
|
|
||||||
env['out'].print_warning(disk_msg)
|
|
||||||
else:
|
else:
|
||||||
env['out'].print_error(disk_msg)
|
disk_msg = "The disk has less than %s%% space left." % str(round(bytes_free/bytes_total/10 + .5)*10)
|
||||||
|
if bytes_free > .3 * bytes_total:
|
||||||
|
output.print_ok(disk_msg)
|
||||||
|
elif bytes_free > .15 * bytes_total:
|
||||||
|
output.print_warning(disk_msg)
|
||||||
|
else:
|
||||||
|
output.print_error(disk_msg)
|
||||||
|
|
||||||
|
def run_network_checks(env, output):
|
||||||
def run_network_checks(env):
|
|
||||||
# Also see setup/network-checks.sh.
|
# Also see setup/network-checks.sh.
|
||||||
|
|
||||||
env["out"].add_heading("Network")
|
output.add_heading("Network")
|
||||||
|
|
||||||
# Stop if we cannot make an outbound connection on port 25. Many residential
|
# Stop if we cannot make an outbound connection on port 25. Many residential
|
||||||
# networks block outbound port 25 to prevent their network from sending spam.
|
# networks block outbound port 25 to prevent their network from sending spam.
|
||||||
# See if we can reach one of Google's MTAs with a 5-second timeout.
|
# See if we can reach one of Google's MTAs with a 5-second timeout.
|
||||||
code, ret = shell("check_call", ["/bin/nc", "-z", "-w5", "aspmx.l.google.com", "25"], trap=True)
|
code, ret = shell("check_call", ["/bin/nc", "-z", "-w5", "aspmx.l.google.com", "25"], trap=True)
|
||||||
if ret == 0:
|
if ret == 0:
|
||||||
env['out'].print_ok("Outbound mail (SMTP port 25) is not blocked.")
|
output.print_ok("Outbound mail (SMTP port 25) is not blocked.")
|
||||||
else:
|
else:
|
||||||
env['out'].print_error("""Outbound mail (SMTP port 25) seems to be blocked by your network. You
|
output.print_error("""Outbound mail (SMTP port 25) seems to be blocked by your network. You
|
||||||
will not be able to send any mail. Many residential networks block port 25 to prevent hijacked
|
will not be able to send any mail. Many residential networks block port 25 to prevent hijacked
|
||||||
machines from being able to send spam. A quick connection test to Google's mail server on port 25
|
machines from being able to send spam. A quick connection test to Google's mail server on port 25
|
||||||
failed.""")
|
failed.""")
|
||||||
@@ -89,13 +212,13 @@ def run_network_checks(env):
|
|||||||
rev_ip4 = ".".join(reversed(env['PUBLIC_IP'].split('.')))
|
rev_ip4 = ".".join(reversed(env['PUBLIC_IP'].split('.')))
|
||||||
zen = query_dns(rev_ip4+'.zen.spamhaus.org', 'A', nxdomain=None)
|
zen = query_dns(rev_ip4+'.zen.spamhaus.org', 'A', nxdomain=None)
|
||||||
if zen is None:
|
if zen is None:
|
||||||
env['out'].print_ok("IP address is not blacklisted by zen.spamhaus.org.")
|
output.print_ok("IP address is not blacklisted by zen.spamhaus.org.")
|
||||||
else:
|
else:
|
||||||
env['out'].print_error("""The IP address of this machine %s is listed in the Spamhaus Block List (code %s),
|
output.print_error("""The IP address of this machine %s is listed in the Spamhaus Block List (code %s),
|
||||||
which may prevent recipients from receiving your email. See http://www.spamhaus.org/query/ip/%s."""
|
which may prevent recipients from receiving your email. See http://www.spamhaus.org/query/ip/%s."""
|
||||||
% (env['PUBLIC_IP'], zen, env['PUBLIC_IP']))
|
% (env['PUBLIC_IP'], zen, env['PUBLIC_IP']))
|
||||||
|
|
||||||
def run_domain_checks(env):
|
def run_domain_checks(rounded_time, env, output, pool):
|
||||||
# Get the list of domains we handle mail for.
|
# Get the list of domains we handle mail for.
|
||||||
mail_domains = get_mail_domains(env)
|
mail_domains = get_mail_domains(env)
|
||||||
|
|
||||||
@@ -106,52 +229,80 @@ def run_domain_checks(env):
|
|||||||
# Get the list of domains we serve HTTPS for.
|
# Get the list of domains we serve HTTPS for.
|
||||||
web_domains = set(get_web_domains(env))
|
web_domains = set(get_web_domains(env))
|
||||||
|
|
||||||
# Check the domains.
|
domains_to_check = mail_domains | dns_domains | web_domains
|
||||||
for domain in sort_domains(mail_domains | dns_domains | web_domains, env):
|
|
||||||
env["out"].add_heading(domain)
|
|
||||||
|
|
||||||
if domain == env["PRIMARY_HOSTNAME"]:
|
# Serial version:
|
||||||
check_primary_hostname_dns(domain, env, dns_domains, dns_zonefiles)
|
#for domain in sort_domains(domains_to_check, env):
|
||||||
|
# run_domain_checks_on_domain(domain, rounded_time, env, dns_domains, dns_zonefiles, mail_domains, web_domains)
|
||||||
|
|
||||||
|
# Parallelize the checks across a worker pool.
|
||||||
|
args = ((domain, rounded_time, env, dns_domains, dns_zonefiles, mail_domains, web_domains)
|
||||||
|
for domain in domains_to_check)
|
||||||
|
ret = pool.starmap(run_domain_checks_on_domain, args, chunksize=1)
|
||||||
|
ret = dict(ret) # (domain, output) => { domain: output }
|
||||||
|
for domain in sort_domains(ret, env):
|
||||||
|
ret[domain].playback(output)
|
||||||
|
|
||||||
|
def run_domain_checks_on_domain(domain, rounded_time, env, dns_domains, dns_zonefiles, mail_domains, web_domains):
|
||||||
|
output = BufferedOutput()
|
||||||
|
|
||||||
|
output.add_heading(domain)
|
||||||
|
|
||||||
|
if domain == env["PRIMARY_HOSTNAME"]:
|
||||||
|
check_primary_hostname_dns(domain, env, output, dns_domains, dns_zonefiles)
|
||||||
|
|
||||||
if domain in dns_domains:
|
if domain in dns_domains:
|
||||||
check_dns_zone(domain, env, dns_zonefiles)
|
check_dns_zone(domain, env, output, dns_zonefiles)
|
||||||
|
|
||||||
if domain in mail_domains:
|
if domain in mail_domains:
|
||||||
check_mail_domain(domain, env)
|
check_mail_domain(domain, env, output)
|
||||||
|
|
||||||
if domain in web_domains:
|
if domain in web_domains:
|
||||||
check_web_domain(domain, env)
|
check_web_domain(domain, rounded_time, env, output)
|
||||||
|
|
||||||
if domain in dns_domains:
|
if domain in dns_domains:
|
||||||
check_dns_zone_suggestions(domain, env, dns_zonefiles)
|
check_dns_zone_suggestions(domain, env, output, dns_zonefiles)
|
||||||
|
|
||||||
def check_primary_hostname_dns(domain, env, dns_domains, dns_zonefiles):
|
return (domain, output)
|
||||||
|
|
||||||
|
def check_primary_hostname_dns(domain, env, output, dns_domains, dns_zonefiles):
|
||||||
# If a DS record is set on the zone containing this domain, check DNSSEC now.
|
# If a DS record is set on the zone containing this domain, check DNSSEC now.
|
||||||
|
has_dnssec = False
|
||||||
for zone in dns_domains:
|
for zone in dns_domains:
|
||||||
if zone == domain or domain.endswith("." + zone):
|
if zone == domain or domain.endswith("." + zone):
|
||||||
if query_dns(zone, "DS", nxdomain=None) is not None:
|
if query_dns(zone, "DS", nxdomain=None) is not None:
|
||||||
check_dnssec(zone, env, dns_zonefiles, is_checking_primary=True)
|
has_dnssec = True
|
||||||
|
check_dnssec(zone, env, output, dns_zonefiles, is_checking_primary=True)
|
||||||
|
|
||||||
|
ip = query_dns(domain, "A")
|
||||||
|
ns_ips = query_dns("ns1." + domain, "A") + '/' + query_dns("ns2." + domain, "A")
|
||||||
|
|
||||||
# Check that the ns1/ns2 hostnames resolve to A records. This information probably
|
# Check that the ns1/ns2 hostnames resolve to A records. This information probably
|
||||||
# comes from the TLD since the information is set at the registrar as glue records.
|
# comes from the TLD since the information is set at the registrar as glue records.
|
||||||
# We're probably not actually checking that here but instead checking that we, as
|
# We're probably not actually checking that here but instead checking that we, as
|
||||||
# the nameserver, are reporting the right info --- but if the glue is incorrect this
|
# the nameserver, are reporting the right info --- but if the glue is incorrect this
|
||||||
# will probably fail.
|
# will probably fail.
|
||||||
ip = query_dns("ns1." + domain, "A") + '/' + query_dns("ns2." + domain, "A")
|
if ns_ips == env['PUBLIC_IP'] + '/' + env['PUBLIC_IP']:
|
||||||
if ip == env['PUBLIC_IP'] + '/' + env['PUBLIC_IP']:
|
output.print_ok("Nameserver glue records are correct at registrar. [ns1/ns2.%s => %s]" % (env['PRIMARY_HOSTNAME'], env['PUBLIC_IP']))
|
||||||
env['out'].print_ok("Nameserver glue records are correct at registrar. [ns1/ns2.%s => %s]" % (env['PRIMARY_HOSTNAME'], env['PUBLIC_IP']))
|
|
||||||
|
elif ip == env['PUBLIC_IP']:
|
||||||
|
# The NS records are not what we expect, but the domain resolves correctly, so
|
||||||
|
# the user may have set up external DNS. List this discrepancy as a warning.
|
||||||
|
output.print_warning("""Nameserver glue records (ns1.%s and ns2.%s) should be configured at your domain name
|
||||||
|
registrar as having the IP address of this box (%s). They currently report addresses of %s. If you have set up External DNS, this may be OK."""
|
||||||
|
% (env['PRIMARY_HOSTNAME'], env['PRIMARY_HOSTNAME'], env['PUBLIC_IP'], ns_ips))
|
||||||
|
|
||||||
else:
|
else:
|
||||||
env['out'].print_error("""Nameserver glue records are incorrect. The ns1.%s and ns2.%s nameservers must be configured at your domain name
|
output.print_error("""Nameserver glue records are incorrect. The ns1.%s and ns2.%s nameservers must be configured at your domain name
|
||||||
registrar as having the IP address %s. They currently report addresses of %s. It may take several hours for
|
registrar as having the IP address %s. They currently report addresses of %s. It may take several hours for
|
||||||
public DNS to update after a change."""
|
public DNS to update after a change."""
|
||||||
% (env['PRIMARY_HOSTNAME'], env['PRIMARY_HOSTNAME'], env['PUBLIC_IP'], ip))
|
% (env['PRIMARY_HOSTNAME'], env['PRIMARY_HOSTNAME'], env['PUBLIC_IP'], ns_ips))
|
||||||
|
|
||||||
# Check that PRIMARY_HOSTNAME resolves to PUBLIC_IP in public DNS.
|
# Check that PRIMARY_HOSTNAME resolves to PUBLIC_IP in public DNS.
|
||||||
ip = query_dns(domain, "A")
|
|
||||||
if ip == env['PUBLIC_IP']:
|
if ip == env['PUBLIC_IP']:
|
||||||
env['out'].print_ok("Domain resolves to box's IP address. [%s => %s]" % (env['PRIMARY_HOSTNAME'], env['PUBLIC_IP']))
|
output.print_ok("Domain resolves to box's IP address. [%s => %s]" % (env['PRIMARY_HOSTNAME'], env['PUBLIC_IP']))
|
||||||
else:
|
else:
|
||||||
env['out'].print_error("""This domain must resolve to your box's IP address (%s) in public DNS but it currently resolves
|
output.print_error("""This domain must resolve to your box's IP address (%s) in public DNS but it currently resolves
|
||||||
to %s. It may take several hours for public DNS to update after a change. This problem may result from other
|
to %s. It may take several hours for public DNS to update after a change. This problem may result from other
|
||||||
issues listed here."""
|
issues listed here."""
|
||||||
% (env['PUBLIC_IP'], ip))
|
% (env['PUBLIC_IP'], ip))
|
||||||
@@ -161,9 +312,9 @@ def check_primary_hostname_dns(domain, env, dns_domains, dns_zonefiles):
|
|||||||
ipaddr_rev = dns.reversename.from_address(env['PUBLIC_IP'])
|
ipaddr_rev = dns.reversename.from_address(env['PUBLIC_IP'])
|
||||||
existing_rdns = query_dns(ipaddr_rev, "PTR")
|
existing_rdns = query_dns(ipaddr_rev, "PTR")
|
||||||
if existing_rdns == domain:
|
if existing_rdns == domain:
|
||||||
env['out'].print_ok("Reverse DNS is set correctly at ISP. [%s => %s]" % (env['PUBLIC_IP'], env['PRIMARY_HOSTNAME']))
|
output.print_ok("Reverse DNS is set correctly at ISP. [%s => %s]" % (env['PUBLIC_IP'], env['PRIMARY_HOSTNAME']))
|
||||||
else:
|
else:
|
||||||
env['out'].print_error("""Your box's reverse DNS is currently %s, but it should be %s. Your ISP or cloud provider will have instructions
|
output.print_error("""Your box's reverse DNS is currently %s, but it should be %s. Your ISP or cloud provider will have instructions
|
||||||
on setting up reverse DNS for your box at %s.""" % (existing_rdns, domain, env['PUBLIC_IP']) )
|
on setting up reverse DNS for your box at %s.""" % (existing_rdns, domain, env['PUBLIC_IP']) )
|
||||||
|
|
||||||
# Check the TLSA record.
|
# Check the TLSA record.
|
||||||
@@ -171,30 +322,32 @@ def check_primary_hostname_dns(domain, env, dns_domains, dns_zonefiles):
|
|||||||
tlsa25 = query_dns(tlsa_qname, "TLSA", nxdomain=None)
|
tlsa25 = query_dns(tlsa_qname, "TLSA", nxdomain=None)
|
||||||
tlsa25_expected = build_tlsa_record(env)
|
tlsa25_expected = build_tlsa_record(env)
|
||||||
if tlsa25 == tlsa25_expected:
|
if tlsa25 == tlsa25_expected:
|
||||||
env['out'].print_ok("""The DANE TLSA record for incoming mail is correct (%s).""" % tlsa_qname,)
|
output.print_ok("""The DANE TLSA record for incoming mail is correct (%s).""" % tlsa_qname,)
|
||||||
elif tlsa25 is None:
|
elif tlsa25 is None:
|
||||||
env['out'].print_error("""The DANE TLSA record for incoming mail is not set. This is optional.""")
|
if has_dnssec:
|
||||||
|
# Omit a warning about it not being set if DNSSEC isn't enabled,
|
||||||
|
# since TLSA shouldn't be used without DNSSEC.
|
||||||
|
output.print_warning("""The DANE TLSA record for incoming mail is not set. This is optional.""")
|
||||||
else:
|
else:
|
||||||
env['out'].print_error("""The DANE TLSA record for incoming mail (%s) is not correct. It is '%s' but it should be '%s'. Try running tools/dns_update to
|
output.print_error("""The DANE TLSA record for incoming mail (%s) is not correct. It is '%s' but it should be '%s'.
|
||||||
regenerate the record. It may take several hours for
|
It may take several hours for public DNS to update after a change."""
|
||||||
public DNS to update after a change."""
|
|
||||||
% (tlsa_qname, tlsa25, tlsa25_expected))
|
% (tlsa_qname, tlsa25, tlsa25_expected))
|
||||||
|
|
||||||
# Check that the hostmaster@ email address exists.
|
# Check that the hostmaster@ email address exists.
|
||||||
check_alias_exists("hostmaster@" + domain, env)
|
check_alias_exists("hostmaster@" + domain, env, output)
|
||||||
|
|
||||||
def check_alias_exists(alias, env):
|
def check_alias_exists(alias, env, output):
|
||||||
mail_alises = dict(get_mail_aliases(env))
|
mail_alises = dict(get_mail_aliases(env))
|
||||||
if alias in mail_alises:
|
if alias in mail_alises:
|
||||||
env['out'].print_ok("%s exists as a mail alias [=> %s]" % (alias, mail_alises[alias]))
|
output.print_ok("%s exists as a mail alias [=> %s]" % (alias, mail_alises[alias]))
|
||||||
else:
|
else:
|
||||||
env['out'].print_error("""You must add a mail alias for %s and direct email to you or another administrator.""" % alias)
|
output.print_error("""You must add a mail alias for %s and direct email to you or another administrator.""" % alias)
|
||||||
|
|
||||||
def check_dns_zone(domain, env, dns_zonefiles):
|
def check_dns_zone(domain, env, output, dns_zonefiles):
|
||||||
# If a DS record is set at the registrar, check DNSSEC first because it will affect the NS query.
|
# If a DS record is set at the registrar, check DNSSEC first because it will affect the NS query.
|
||||||
# If it is not set, we suggest it last.
|
# If it is not set, we suggest it last.
|
||||||
if query_dns(domain, "DS", nxdomain=None) is not None:
|
if query_dns(domain, "DS", nxdomain=None) is not None:
|
||||||
check_dnssec(domain, env, dns_zonefiles)
|
check_dnssec(domain, env, output, dns_zonefiles)
|
||||||
|
|
||||||
# We provide a DNS zone for the domain. It should have NS records set up
|
# We provide a DNS zone for the domain. It should have NS records set up
|
||||||
# at the domain name's registrar pointing to this box. The secondary DNS
|
# at the domain name's registrar pointing to this box. The secondary DNS
|
||||||
@@ -202,27 +355,33 @@ def check_dns_zone(domain, env, dns_zonefiles):
|
|||||||
# whois information -- we may be getting the NS records from us rather than
|
# whois information -- we may be getting the NS records from us rather than
|
||||||
# the TLD, and so we're not actually checking the TLD. For that we'd need
|
# the TLD, and so we're not actually checking the TLD. For that we'd need
|
||||||
# to do a DNS trace.
|
# to do a DNS trace.
|
||||||
|
ip = query_dns(domain, "A")
|
||||||
custom_dns = get_custom_dns_config(env)
|
custom_dns = get_custom_dns_config(env)
|
||||||
existing_ns = query_dns(domain, "NS")
|
existing_ns = query_dns(domain, "NS")
|
||||||
correct_ns = "; ".join([
|
correct_ns = "; ".join(sorted([
|
||||||
"ns1." + env['PRIMARY_HOSTNAME'],
|
"ns1." + env['PRIMARY_HOSTNAME'],
|
||||||
custom_dns.get("_secondary_nameserver", "ns2." + env['PRIMARY_HOSTNAME']),
|
custom_dns.get("_secondary_nameserver", "ns2." + env['PRIMARY_HOSTNAME']),
|
||||||
])
|
]))
|
||||||
if existing_ns.lower() == correct_ns.lower():
|
if existing_ns.lower() == correct_ns.lower():
|
||||||
env['out'].print_ok("Nameservers are set correctly at registrar. [%s]" % correct_ns)
|
output.print_ok("Nameservers are set correctly at registrar. [%s]" % correct_ns)
|
||||||
|
elif ip == env['PUBLIC_IP']:
|
||||||
|
# The domain resolves correctly, so maybe the user is using External DNS.
|
||||||
|
output.print_warning("""The nameservers set on this domain at your domain name registrar should be %s. They are currently %s.
|
||||||
|
If you are using External DNS, this may be OK."""
|
||||||
|
% (correct_ns, existing_ns) )
|
||||||
else:
|
else:
|
||||||
env['out'].print_error("""The nameservers set on this domain are incorrect. They are currently %s. Use your domain name registrar's
|
output.print_error("""The nameservers set on this domain are incorrect. They are currently %s. Use your domain name registrar's
|
||||||
control panel to set the nameservers to %s."""
|
control panel to set the nameservers to %s."""
|
||||||
% (existing_ns, correct_ns) )
|
% (existing_ns, correct_ns) )
|
||||||
|
|
||||||
def check_dns_zone_suggestions(domain, env, dns_zonefiles):
|
def check_dns_zone_suggestions(domain, env, output, dns_zonefiles):
|
||||||
# Since DNSSEC is optional, if a DS record is NOT set at the registrar suggest it.
|
# Since DNSSEC is optional, if a DS record is NOT set at the registrar suggest it.
|
||||||
# (If it was set, we did the check earlier.)
|
# (If it was set, we did the check earlier.)
|
||||||
if query_dns(domain, "DS", nxdomain=None) is None:
|
if query_dns(domain, "DS", nxdomain=None) is None:
|
||||||
check_dnssec(domain, env, dns_zonefiles)
|
check_dnssec(domain, env, output, dns_zonefiles)
|
||||||
|
|
||||||
|
|
||||||
def check_dnssec(domain, env, dns_zonefiles, is_checking_primary=False):
|
def check_dnssec(domain, env, output, dns_zonefiles, is_checking_primary=False):
|
||||||
# See if the domain has a DS record set at the registrar. The DS record may have
|
# See if the domain has a DS record set at the registrar. The DS record may have
|
||||||
# several forms. We have to be prepared to check for any valid record. We've
|
# several forms. We have to be prepared to check for any valid record. We've
|
||||||
# pre-generated all of the valid digests --- read them in.
|
# pre-generated all of the valid digests --- read them in.
|
||||||
@@ -244,54 +403,58 @@ def check_dnssec(domain, env, dns_zonefiles, is_checking_primary=False):
|
|||||||
if ds_looks_valid: ds = ds.split(" ")
|
if ds_looks_valid: ds = ds.split(" ")
|
||||||
if ds_looks_valid and ds[0] == ds_keytag and ds[1] == ds_alg and ds[3] == digests.get(ds[2]):
|
if ds_looks_valid and ds[0] == ds_keytag and ds[1] == ds_alg and ds[3] == digests.get(ds[2]):
|
||||||
if is_checking_primary: return
|
if is_checking_primary: return
|
||||||
env['out'].print_ok("DNSSEC 'DS' record is set correctly at registrar.")
|
output.print_ok("DNSSEC 'DS' record is set correctly at registrar.")
|
||||||
else:
|
else:
|
||||||
if ds == None:
|
if ds == None:
|
||||||
if is_checking_primary: return
|
if is_checking_primary: return
|
||||||
env['out'].print_error("""This domain's DNSSEC DS record is not set. The DS record is optional. The DS record activates DNSSEC.
|
output.print_warning("""This domain's DNSSEC DS record is not set. The DS record is optional. The DS record activates DNSSEC.
|
||||||
To set a DS record, you must follow the instructions provided by your domain name registrar and provide to them this information:""")
|
To set a DS record, you must follow the instructions provided by your domain name registrar and provide to them this information:""")
|
||||||
else:
|
else:
|
||||||
if is_checking_primary:
|
if is_checking_primary:
|
||||||
env['out'].print_error("""The DNSSEC 'DS' record for %s is incorrect. See further details below.""" % domain)
|
output.print_error("""The DNSSEC 'DS' record for %s is incorrect. See further details below.""" % domain)
|
||||||
return
|
return
|
||||||
env['out'].print_error("""This domain's DNSSEC DS record is incorrect. The chain of trust is broken between the public DNS system
|
output.print_error("""This domain's DNSSEC DS record is incorrect. The chain of trust is broken between the public DNS system
|
||||||
and this machine's DNS server. It may take several hours for public DNS to update after a change. If you did not recently
|
and this machine's DNS server. It may take several hours for public DNS to update after a change. If you did not recently
|
||||||
make a change, you must resolve this immediately by following the instructions provided by your domain name registrar and
|
make a change, you must resolve this immediately by following the instructions provided by your domain name registrar and
|
||||||
provide to them this information:""")
|
provide to them this information:""")
|
||||||
env['out'].print_line("")
|
output.print_line("")
|
||||||
env['out'].print_line("Key Tag: " + ds_keytag + ("" if not ds_looks_valid or ds[0] == ds_keytag else " (Got '%s')" % ds[0]))
|
output.print_line("Key Tag: " + ds_keytag + ("" if not ds_looks_valid or ds[0] == ds_keytag else " (Got '%s')" % ds[0]))
|
||||||
env['out'].print_line("Key Flags: KSK")
|
output.print_line("Key Flags: KSK")
|
||||||
env['out'].print_line(
|
output.print_line(
|
||||||
("Algorithm: %s / %s" % (ds_alg, alg_name_map[ds_alg]))
|
("Algorithm: %s / %s" % (ds_alg, alg_name_map[ds_alg]))
|
||||||
+ ("" if not ds_looks_valid or ds[1] == ds_alg else " (Got '%s')" % ds[1]))
|
+ ("" if not ds_looks_valid or ds[1] == ds_alg else " (Got '%s')" % ds[1]))
|
||||||
# see http://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml
|
# see http://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml
|
||||||
env['out'].print_line("Digest Type: 2 / SHA-256")
|
output.print_line("Digest Type: 2 / SHA-256")
|
||||||
# http://www.ietf.org/assignments/ds-rr-types/ds-rr-types.xml
|
# http://www.ietf.org/assignments/ds-rr-types/ds-rr-types.xml
|
||||||
env['out'].print_line("Digest: " + digests['2'])
|
output.print_line("Digest: " + digests['2'])
|
||||||
if ds_looks_valid and ds[3] != digests.get(ds[2]):
|
if ds_looks_valid and ds[3] != digests.get(ds[2]):
|
||||||
env['out'].print_line("(Got digest type %s and digest %s which do not match.)" % (ds[2], ds[3]))
|
output.print_line("(Got digest type %s and digest %s which do not match.)" % (ds[2], ds[3]))
|
||||||
env['out'].print_line("Public Key: ")
|
output.print_line("Public Key: ")
|
||||||
env['out'].print_line(dnsssec_pubkey, monospace=True)
|
output.print_line(dnsssec_pubkey, monospace=True)
|
||||||
env['out'].print_line("")
|
output.print_line("")
|
||||||
env['out'].print_line("Bulk/Record Format:")
|
output.print_line("Bulk/Record Format:")
|
||||||
env['out'].print_line("" + ds_correct[0])
|
output.print_line("" + ds_correct[0])
|
||||||
env['out'].print_line("")
|
output.print_line("")
|
||||||
|
|
||||||
def check_mail_domain(domain, env):
|
def check_mail_domain(domain, env, output):
|
||||||
# Check the MX record.
|
# Check the MX record.
|
||||||
|
|
||||||
|
recommended_mx = "10 " + env['PRIMARY_HOSTNAME']
|
||||||
mx = query_dns(domain, "MX", nxdomain=None)
|
mx = query_dns(domain, "MX", nxdomain=None)
|
||||||
expected_mx = "10 " + env['PRIMARY_HOSTNAME']
|
|
||||||
|
|
||||||
if mx == expected_mx:
|
if mx is None:
|
||||||
env['out'].print_ok("Domain's email is directed to this domain. [%s => %s]" % (domain, mx))
|
mxhost = None
|
||||||
|
else:
|
||||||
|
# query_dns returns a semicolon-delimited list
|
||||||
|
# of priority-host pairs.
|
||||||
|
mxhost = mx.split('; ')[0].split(' ')[1]
|
||||||
|
|
||||||
elif mx == None:
|
if mxhost == None:
|
||||||
# A missing MX record is okay on the primary hostname because
|
# A missing MX record is okay on the primary hostname because
|
||||||
# the primary hostname's A record (the MX fallback) is... itself,
|
# the primary hostname's A record (the MX fallback) is... itself,
|
||||||
# which is what we want the MX to be.
|
# which is what we want the MX to be.
|
||||||
if domain == env['PRIMARY_HOSTNAME']:
|
if domain == env['PRIMARY_HOSTNAME']:
|
||||||
env['out'].print_ok("Domain's email is directed to this domain. [%s has no MX record, which is ok]" % (domain,))
|
output.print_ok("Domain's email is directed to this domain. [%s has no MX record, which is ok]" % (domain,))
|
||||||
|
|
||||||
# And a missing MX record is okay on other domains if the A record
|
# And a missing MX record is okay on other domains if the A record
|
||||||
# matches the A record of the PRIMARY_HOSTNAME. Actually this will
|
# matches the A record of the PRIMARY_HOSTNAME. Actually this will
|
||||||
@@ -300,57 +463,74 @@ def check_mail_domain(domain, env):
|
|||||||
domain_a = query_dns(domain, "A", nxdomain=None)
|
domain_a = query_dns(domain, "A", nxdomain=None)
|
||||||
primary_a = query_dns(env['PRIMARY_HOSTNAME'], "A", nxdomain=None)
|
primary_a = query_dns(env['PRIMARY_HOSTNAME'], "A", nxdomain=None)
|
||||||
if domain_a != None and domain_a == primary_a:
|
if domain_a != None and domain_a == primary_a:
|
||||||
env['out'].print_ok("Domain's email is directed to this domain. [%s has no MX record but its A record is OK]" % (domain,))
|
output.print_ok("Domain's email is directed to this domain. [%s has no MX record but its A record is OK]" % (domain,))
|
||||||
else:
|
else:
|
||||||
env['out'].print_error("""This domain's DNS MX record is not set. It should be '%s'. Mail will not
|
output.print_error("""This domain's DNS MX record is not set. It should be '%s'. Mail will not
|
||||||
be delivered to this box. It may take several hours for public DNS to update after a
|
be delivered to this box. It may take several hours for public DNS to update after a
|
||||||
change. This problem may result from other issues listed here.""" % (expected_mx,))
|
change. This problem may result from other issues listed here.""" % (recommended_mx,))
|
||||||
|
|
||||||
|
elif mxhost == env['PRIMARY_HOSTNAME']:
|
||||||
|
good_news = "Domain's email is directed to this domain. [%s => %s]" % (domain, mx)
|
||||||
|
if mx != recommended_mx:
|
||||||
|
good_news += " This configuration is non-standard. The recommended configuration is '%s'." % (recommended_mx,)
|
||||||
|
output.print_ok(good_news)
|
||||||
else:
|
else:
|
||||||
env['out'].print_error("""This domain's DNS MX record is incorrect. It is currently set to '%s' but should be '%s'. Mail will not
|
output.print_error("""This domain's DNS MX record is incorrect. It is currently set to '%s' but should be '%s'. Mail will not
|
||||||
be delivered to this box. It may take several hours for public DNS to update after a change. This problem may result from
|
be delivered to this box. It may take several hours for public DNS to update after a change. This problem may result from
|
||||||
other issues listed here.""" % (mx, expected_mx))
|
other issues listed here.""" % (mx, recommended_mx))
|
||||||
|
|
||||||
# Check that the postmaster@ email address exists.
|
# Check that the postmaster@ email address exists. Not required if the domain has a
|
||||||
check_alias_exists("postmaster@" + domain, env)
|
# catch-all address or domain alias.
|
||||||
|
if "@" + domain not in dict(get_mail_aliases(env)):
|
||||||
|
check_alias_exists("postmaster@" + domain, env, output)
|
||||||
|
|
||||||
# Stop if the domain is listed in the Spamhaus Domain Block List.
|
# Stop if the domain is listed in the Spamhaus Domain Block List.
|
||||||
# The user might have chosen a domain that was previously in use by a spammer
|
# The user might have chosen a domain that was previously in use by a spammer
|
||||||
# and will not be able to reliably send mail.
|
# and will not be able to reliably send mail.
|
||||||
dbl = query_dns(domain+'.dbl.spamhaus.org', "A", nxdomain=None)
|
dbl = query_dns(domain+'.dbl.spamhaus.org', "A", nxdomain=None)
|
||||||
if dbl is None:
|
if dbl is None:
|
||||||
env['out'].print_ok("Domain is not blacklisted by dbl.spamhaus.org.")
|
output.print_ok("Domain is not blacklisted by dbl.spamhaus.org.")
|
||||||
else:
|
else:
|
||||||
env['out'].print_error("""This domain is listed in the Spamhaus Domain Block List (code %s),
|
output.print_error("""This domain is listed in the Spamhaus Domain Block List (code %s),
|
||||||
which may prevent recipients from receiving your mail.
|
which may prevent recipients from receiving your mail.
|
||||||
See http://www.spamhaus.org/dbl/ and http://www.spamhaus.org/query/domain/%s.""" % (dbl, domain))
|
See http://www.spamhaus.org/dbl/ and http://www.spamhaus.org/query/domain/%s.""" % (dbl, domain))
|
||||||
|
|
||||||
def check_web_domain(domain, env):
|
def check_web_domain(domain, rounded_time, env, output):
|
||||||
# See if the domain's A record resolves to our PUBLIC_IP. This is already checked
|
# See if the domain's A record resolves to our PUBLIC_IP. This is already checked
|
||||||
# for PRIMARY_HOSTNAME, for which it is required for mail specifically. For it and
|
# for PRIMARY_HOSTNAME, for which it is required for mail specifically. For it and
|
||||||
# other domains, it is required to access its website.
|
# other domains, it is required to access its website.
|
||||||
if domain != env['PRIMARY_HOSTNAME']:
|
if domain != env['PRIMARY_HOSTNAME']:
|
||||||
ip = query_dns(domain, "A")
|
ip = query_dns(domain, "A")
|
||||||
if ip == env['PUBLIC_IP']:
|
if ip == env['PUBLIC_IP']:
|
||||||
env['out'].print_ok("Domain resolves to this box's IP address. [%s => %s]" % (domain, env['PUBLIC_IP']))
|
output.print_ok("Domain resolves to this box's IP address. [%s => %s]" % (domain, env['PUBLIC_IP']))
|
||||||
else:
|
else:
|
||||||
env['out'].print_error("""This domain should resolve to your box's IP address (%s) if you would like the box to serve
|
output.print_error("""This domain should resolve to your box's IP address (%s) if you would like the box to serve
|
||||||
webmail or a website on this domain. The domain currently resolves to %s in public DNS. It may take several hours for
|
webmail or a website on this domain. The domain currently resolves to %s in public DNS. It may take several hours for
|
||||||
public DNS to update after a change. This problem may result from other issues listed here.""" % (env['PUBLIC_IP'], ip))
|
public DNS to update after a change. This problem may result from other issues listed here.""" % (env['PUBLIC_IP'], ip))
|
||||||
|
|
||||||
# We need a SSL certificate for PRIMARY_HOSTNAME because that's where the
|
# We need a SSL certificate for PRIMARY_HOSTNAME because that's where the
|
||||||
# user will log in with IMAP or webmail. Any other domain we serve a
|
# user will log in with IMAP or webmail. Any other domain we serve a
|
||||||
# website for also needs a signed certificate.
|
# website for also needs a signed certificate.
|
||||||
check_ssl_cert(domain, env)
|
check_ssl_cert(domain, rounded_time, env, output)
|
||||||
|
|
||||||
def query_dns(qname, rtype, nxdomain='[Not Set]'):
|
def query_dns(qname, rtype, nxdomain='[Not Set]'):
|
||||||
resolver = dns.resolver.get_default_resolver()
|
# Make the qname absolute by appending a period. Without this, dns.resolver.query
|
||||||
|
# will fall back a failed lookup to a second query with this machine's hostname
|
||||||
|
# appended. This has been causing some false-positive Spamhaus reports. The
|
||||||
|
# reverse DNS lookup will pass a dns.name.Name instance which is already
|
||||||
|
# absolute so we should not modify that.
|
||||||
|
if isinstance(qname, str):
|
||||||
|
qname += "."
|
||||||
|
|
||||||
|
# Do the query.
|
||||||
try:
|
try:
|
||||||
response = dns.resolver.query(qname, rtype)
|
response = dns.resolver.query(qname, rtype)
|
||||||
except (dns.resolver.NoNameservers, dns.resolver.NXDOMAIN, dns.resolver.NoAnswer):
|
except (dns.resolver.NoNameservers, dns.resolver.NXDOMAIN, dns.resolver.NoAnswer):
|
||||||
# Host did not have an answer for this query; not sure what the
|
# Host did not have an answer for this query; not sure what the
|
||||||
# difference is between the two exceptions.
|
# difference is between the two exceptions.
|
||||||
return nxdomain
|
return nxdomain
|
||||||
|
except dns.exception.Timeout:
|
||||||
|
return "[timeout]"
|
||||||
|
|
||||||
# There may be multiple answers; concatenate the response. Remove trailing
|
# There may be multiple answers; concatenate the response. Remove trailing
|
||||||
# periods from responses since that's how qnames are encoded in DNS but is
|
# periods from responses since that's how qnames are encoded in DNS but is
|
||||||
@@ -358,26 +538,26 @@ def query_dns(qname, rtype, nxdomain='[Not Set]'):
|
|||||||
# can compare to a well known order.
|
# can compare to a well known order.
|
||||||
return "; ".join(sorted(str(r).rstrip('.') for r in response))
|
return "; ".join(sorted(str(r).rstrip('.') for r in response))
|
||||||
|
|
||||||
def check_ssl_cert(domain, env):
|
def check_ssl_cert(domain, rounded_time, env, output):
|
||||||
# Check that SSL certificate is signed.
|
# Check that SSL certificate is signed.
|
||||||
|
|
||||||
# Skip the check if the A record is not pointed here.
|
# Skip the check if the A record is not pointed here.
|
||||||
if query_dns(domain, "A", None) not in (env['PUBLIC_IP'], None): return
|
if query_dns(domain, "A", None) not in (env['PUBLIC_IP'], None): return
|
||||||
|
|
||||||
# Where is the SSL stored?
|
# Where is the SSL stored?
|
||||||
ssl_key, ssl_certificate, ssl_csr_path = get_domain_ssl_files(domain, env)
|
ssl_key, ssl_certificate, ssl_via = get_domain_ssl_files(domain, env)
|
||||||
|
|
||||||
if not os.path.exists(ssl_certificate):
|
if not os.path.exists(ssl_certificate):
|
||||||
env['out'].print_error("The SSL certificate file for this domain is missing.")
|
output.print_error("The SSL certificate file for this domain is missing.")
|
||||||
return
|
return
|
||||||
|
|
||||||
# Check that the certificate is good.
|
# Check that the certificate is good.
|
||||||
|
|
||||||
cert_status, cert_status_details = check_certificate(domain, ssl_certificate, ssl_key)
|
cert_status, cert_status_details = check_certificate(domain, ssl_certificate, ssl_key, rounded_time=rounded_time)
|
||||||
|
|
||||||
if cert_status == "OK":
|
if cert_status == "OK":
|
||||||
# The certificate is ok. The details has expiry info.
|
# The certificate is ok. The details has expiry info.
|
||||||
env['out'].print_ok("SSL certificate is signed & valid. " + cert_status_details)
|
output.print_ok("SSL certificate is signed & valid. %s %s" % (ssl_via if ssl_via else "", cert_status_details))
|
||||||
|
|
||||||
elif cert_status == "SELF-SIGNED":
|
elif cert_status == "SELF-SIGNED":
|
||||||
# Offer instructions for purchasing a signed certificate.
|
# Offer instructions for purchasing a signed certificate.
|
||||||
@@ -392,27 +572,27 @@ def check_ssl_cert(domain, env):
|
|||||||
fingerprint = re.sub(".*Fingerprint=", "", fingerprint).strip()
|
fingerprint = re.sub(".*Fingerprint=", "", fingerprint).strip()
|
||||||
|
|
||||||
if domain == env['PRIMARY_HOSTNAME']:
|
if domain == env['PRIMARY_HOSTNAME']:
|
||||||
env['out'].print_error("""The SSL certificate for this domain is currently self-signed. You will get a security
|
output.print_error("""The SSL certificate for this domain is currently self-signed. You will get a security
|
||||||
warning when you check or send email and when visiting this domain in a web browser (for webmail or
|
warning when you check or send email and when visiting this domain in a web browser (for webmail or
|
||||||
static site hosting). Use the SSL Certificates page in this control panel to install a signed SSL certificate.
|
static site hosting). Use the SSL Certificates page in this control panel to install a signed SSL certificate.
|
||||||
You may choose to leave the self-signed certificate in place and confirm the security exception, but check that
|
You may choose to leave the self-signed certificate in place and confirm the security exception, but check that
|
||||||
the certificate fingerprint matches the following:""")
|
the certificate fingerprint matches the following:""")
|
||||||
env['out'].print_line("")
|
output.print_line("")
|
||||||
env['out'].print_line(" " + fingerprint, monospace=True)
|
output.print_line(" " + fingerprint, monospace=True)
|
||||||
else:
|
else:
|
||||||
env['out'].print_warning("""The SSL certificate for this domain is currently self-signed. Visitors to a website on
|
output.print_warning("""The SSL certificate for this domain is currently self-signed. Visitors to a website on
|
||||||
this domain will get a security warning. If you are not serving a website on this domain, then it is
|
this domain will get a security warning. If you are not serving a website on this domain, then it is
|
||||||
safe to leave the self-signed certificate in place. Use the SSL Certificates page in this control panel to
|
safe to leave the self-signed certificate in place. Use the SSL Certificates page in this control panel to
|
||||||
install a signed SSL certificate.""")
|
install a signed SSL certificate.""")
|
||||||
|
|
||||||
else:
|
else:
|
||||||
env['out'].print_error("The SSL certificate has a problem: " + cert_status)
|
output.print_error("The SSL certificate has a problem: " + cert_status)
|
||||||
if cert_status_details:
|
if cert_status_details:
|
||||||
env['out'].print_line("")
|
output.print_line("")
|
||||||
env['out'].print_line(cert_status_details)
|
output.print_line(cert_status_details)
|
||||||
env['out'].print_line("")
|
output.print_line("")
|
||||||
|
|
||||||
def check_certificate(domain, ssl_certificate, ssl_private_key):
|
def check_certificate(domain, ssl_certificate, ssl_private_key, rounded_time=False):
|
||||||
# Use openssl verify to check the status of a certificate.
|
# Use openssl verify to check the status of a certificate.
|
||||||
|
|
||||||
# First check that the certificate is for the right domain. The domain
|
# First check that the certificate is for the right domain. The domain
|
||||||
@@ -459,6 +639,7 @@ def check_certificate(domain, ssl_certificate, ssl_private_key):
|
|||||||
if m:
|
if m:
|
||||||
cert_expiration_date = dateutil.parser.parse(m.group(1))
|
cert_expiration_date = dateutil.parser.parse(m.group(1))
|
||||||
|
|
||||||
|
domain = domain.encode("idna").decode("ascii")
|
||||||
wildcard_domain = re.sub("^[^\.]+", "*", domain)
|
wildcard_domain = re.sub("^[^\.]+", "*", domain)
|
||||||
if domain is not None and domain not in certificate_names and wildcard_domain not in certificate_names:
|
if domain is not None and domain not in certificate_names and wildcard_domain not in certificate_names:
|
||||||
return ("The certificate is for the wrong domain name. It is for %s."
|
return ("The certificate is for the wrong domain name. It is for %s."
|
||||||
@@ -510,6 +691,9 @@ def check_certificate(domain, ssl_certificate, ssl_private_key):
|
|||||||
# Certificate is self-signed.
|
# Certificate is self-signed.
|
||||||
return ("SELF-SIGNED", None)
|
return ("SELF-SIGNED", None)
|
||||||
elif retcode != 0:
|
elif retcode != 0:
|
||||||
|
if "unable to get local issuer certificate" in verifyoutput:
|
||||||
|
return ("The certificate is missing an intermediate chain or the intermediate chain is incorrect or incomplete. (%s)" % verifyoutput, None)
|
||||||
|
|
||||||
# There is some unknown problem. Return the `openssl verify` raw output.
|
# There is some unknown problem. Return the `openssl verify` raw output.
|
||||||
return ("There is a problem with the SSL certificate.", verifyoutput.strip())
|
return ("There is a problem with the SSL certificate.", verifyoutput.strip())
|
||||||
else:
|
else:
|
||||||
@@ -519,7 +703,15 @@ def check_certificate(domain, ssl_certificate, ssl_private_key):
|
|||||||
# But is it expiring soon?
|
# But is it expiring soon?
|
||||||
now = datetime.datetime.now(dateutil.tz.tzlocal())
|
now = datetime.datetime.now(dateutil.tz.tzlocal())
|
||||||
ndays = (cert_expiration_date-now).days
|
ndays = (cert_expiration_date-now).days
|
||||||
expiry_info = "The certificate expires in %d days on %s." % (ndays, cert_expiration_date.strftime("%x"))
|
if not rounded_time or ndays < 7:
|
||||||
|
expiry_info = "The certificate expires in %d days on %s." % (ndays, cert_expiration_date.strftime("%x"))
|
||||||
|
elif ndays <= 14:
|
||||||
|
expiry_info = "The certificate expires in less than two weeks, on %s." % cert_expiration_date.strftime("%x")
|
||||||
|
elif ndays <= 31:
|
||||||
|
expiry_info = "The certificate expires in less than a month, on %s." % cert_expiration_date.strftime("%x")
|
||||||
|
else:
|
||||||
|
expiry_info = "The certificate expires on %s." % cert_expiration_date.strftime("%x")
|
||||||
|
|
||||||
if ndays <= 31:
|
if ndays <= 31:
|
||||||
return ("The certificate is expiring soon: " + expiry_info, None)
|
return ("The certificate is expiring soon: " + expiry_info, None)
|
||||||
|
|
||||||
@@ -560,16 +752,109 @@ def list_apt_updates(apt_update=True):
|
|||||||
|
|
||||||
return pkgs
|
return pkgs
|
||||||
|
|
||||||
|
def run_and_output_changes(env, pool, send_via_email):
|
||||||
|
import json
|
||||||
|
from difflib import SequenceMatcher
|
||||||
|
|
||||||
|
if not send_via_email:
|
||||||
|
out = ConsoleOutput()
|
||||||
|
else:
|
||||||
|
import io
|
||||||
|
out = FileOutput(io.StringIO(""), 70)
|
||||||
|
|
||||||
|
# Run status checks.
|
||||||
|
cur = BufferedOutput()
|
||||||
|
run_checks(True, env, cur, pool)
|
||||||
|
|
||||||
|
# Load previously saved status checks.
|
||||||
|
cache_fn = "/var/cache/mailinabox/status_checks.json"
|
||||||
|
if os.path.exists(cache_fn):
|
||||||
|
prev = json.load(open(cache_fn))
|
||||||
|
|
||||||
|
# Group the serial output into categories by the headings.
|
||||||
|
def group_by_heading(lines):
|
||||||
|
from collections import OrderedDict
|
||||||
|
ret = OrderedDict()
|
||||||
|
k = []
|
||||||
|
ret["No Category"] = k
|
||||||
|
for line_type, line_args, line_kwargs in lines:
|
||||||
|
if line_type == "add_heading":
|
||||||
|
k = []
|
||||||
|
ret[line_args[0]] = k
|
||||||
|
else:
|
||||||
|
k.append((line_type, line_args, line_kwargs))
|
||||||
|
return ret
|
||||||
|
prev_status = group_by_heading(prev)
|
||||||
|
cur_status = group_by_heading(cur.buf)
|
||||||
|
|
||||||
|
# Compare the previous to the current status checks
|
||||||
|
# category by category.
|
||||||
|
for category, cur_lines in cur_status.items():
|
||||||
|
if category not in prev_status:
|
||||||
|
out.add_heading(category + " -- Added")
|
||||||
|
BufferedOutput(with_lines=cur_lines).playback(out)
|
||||||
|
else:
|
||||||
|
# Actual comparison starts here...
|
||||||
|
prev_lines = prev_status[category]
|
||||||
|
def stringify(lines):
|
||||||
|
return [json.dumps(line) for line in lines]
|
||||||
|
diff = SequenceMatcher(None, stringify(prev_lines), stringify(cur_lines)).get_opcodes()
|
||||||
|
for op, i1, i2, j1, j2 in diff:
|
||||||
|
if op == "replace":
|
||||||
|
out.add_heading(category + " -- Previously:")
|
||||||
|
elif op == "delete":
|
||||||
|
out.add_heading(category + " -- Removed")
|
||||||
|
if op in ("replace", "delete"):
|
||||||
|
BufferedOutput(with_lines=prev_lines[i1:i2]).playback(out)
|
||||||
|
|
||||||
|
if op == "replace":
|
||||||
|
out.add_heading(category + " -- Currently:")
|
||||||
|
elif op == "insert":
|
||||||
|
out.add_heading(category + " -- Added")
|
||||||
|
if op in ("replace", "insert"):
|
||||||
|
BufferedOutput(with_lines=cur_lines[j1:j2]).playback(out)
|
||||||
|
|
||||||
|
for category, prev_lines in prev_status.items():
|
||||||
|
if category not in cur_status:
|
||||||
|
out.add_heading(category)
|
||||||
|
out.print_warning("This section was removed.")
|
||||||
|
|
||||||
|
if send_via_email:
|
||||||
|
# If there were changes, send off an email.
|
||||||
|
buf = out.buf.getvalue()
|
||||||
|
if len(buf) > 0:
|
||||||
|
# create MIME message
|
||||||
|
from email.message import Message
|
||||||
|
msg = Message()
|
||||||
|
msg['From'] = "\"%s\" <administrator@%s>" % (env['PRIMARY_HOSTNAME'], env['PRIMARY_HOSTNAME'])
|
||||||
|
msg['To'] = "administrator@%s" % env['PRIMARY_HOSTNAME']
|
||||||
|
msg['Subject'] = "[%s] Status Checks Change Notice" % env['PRIMARY_HOSTNAME']
|
||||||
|
msg.set_payload(buf, "UTF-8")
|
||||||
|
|
||||||
|
# send to administrator@
|
||||||
|
import smtplib
|
||||||
|
mailserver = smtplib.SMTP('localhost', 25)
|
||||||
|
mailserver.ehlo()
|
||||||
|
mailserver.sendmail(
|
||||||
|
"administrator@%s" % env['PRIMARY_HOSTNAME'], # MAIL FROM
|
||||||
|
"administrator@%s" % env['PRIMARY_HOSTNAME'], # RCPT TO
|
||||||
|
msg.as_string())
|
||||||
|
mailserver.quit()
|
||||||
|
|
||||||
|
# Store the current status checks output for next time.
|
||||||
|
os.makedirs(os.path.dirname(cache_fn), exist_ok=True)
|
||||||
|
with open(cache_fn, "w") as f:
|
||||||
|
json.dump(cur.buf, f, indent=True)
|
||||||
|
|
||||||
|
class FileOutput:
|
||||||
|
def __init__(self, buf, width):
|
||||||
|
self.buf = buf
|
||||||
|
self.width = width
|
||||||
|
|
||||||
try:
|
|
||||||
terminal_columns = int(shell('check_output', ['stty', 'size']).split()[1])
|
|
||||||
except:
|
|
||||||
terminal_columns = 76
|
|
||||||
class ConsoleOutput:
|
|
||||||
def add_heading(self, heading):
|
def add_heading(self, heading):
|
||||||
print()
|
print(file=self.buf)
|
||||||
print(heading)
|
print(heading, file=self.buf)
|
||||||
print("=" * len(heading))
|
print("=" * len(heading), file=self.buf)
|
||||||
|
|
||||||
def print_ok(self, message):
|
def print_ok(self, message):
|
||||||
self.print_block(message, first_line="✓ ")
|
self.print_block(message, first_line="✓ ")
|
||||||
@@ -581,36 +866,66 @@ class ConsoleOutput:
|
|||||||
self.print_block(message, first_line="? ")
|
self.print_block(message, first_line="? ")
|
||||||
|
|
||||||
def print_block(self, message, first_line=" "):
|
def print_block(self, message, first_line=" "):
|
||||||
print(first_line, end='')
|
print(first_line, end='', file=self.buf)
|
||||||
message = re.sub("\n\s*", " ", message)
|
message = re.sub("\n\s*", " ", message)
|
||||||
words = re.split("(\s+)", message)
|
words = re.split("(\s+)", message)
|
||||||
linelen = 0
|
linelen = 0
|
||||||
for w in words:
|
for w in words:
|
||||||
if linelen + len(w) > terminal_columns-1-len(first_line):
|
if linelen + len(w) > self.width-1-len(first_line):
|
||||||
print()
|
print(file=self.buf)
|
||||||
print(" ", end="")
|
print(" ", end="", file=self.buf)
|
||||||
linelen = 0
|
linelen = 0
|
||||||
if linelen == 0 and w.strip() == "": continue
|
if linelen == 0 and w.strip() == "": continue
|
||||||
print(w, end="")
|
print(w, end="", file=self.buf)
|
||||||
linelen += len(w)
|
linelen += len(w)
|
||||||
print()
|
print(file=self.buf)
|
||||||
|
|
||||||
def print_line(self, message, monospace=False):
|
def print_line(self, message, monospace=False):
|
||||||
for line in message.split("\n"):
|
for line in message.split("\n"):
|
||||||
self.print_block(line)
|
self.print_block(line)
|
||||||
|
|
||||||
|
class ConsoleOutput(FileOutput):
|
||||||
|
def __init__(self):
|
||||||
|
self.buf = sys.stdout
|
||||||
|
try:
|
||||||
|
self.width = int(shell('check_output', ['stty', 'size']).split()[1])
|
||||||
|
except:
|
||||||
|
self.width = 76
|
||||||
|
|
||||||
|
class BufferedOutput:
|
||||||
|
# Record all of the instance method calls so we can play them back later.
|
||||||
|
def __init__(self, with_lines=None):
|
||||||
|
self.buf = [] if not with_lines else with_lines
|
||||||
|
def __getattr__(self, attr):
|
||||||
|
if attr not in ("add_heading", "print_ok", "print_error", "print_warning", "print_block", "print_line"):
|
||||||
|
raise AttributeError
|
||||||
|
# Return a function that just records the call & arguments to our buffer.
|
||||||
|
def w(*args, **kwargs):
|
||||||
|
self.buf.append((attr, args, kwargs))
|
||||||
|
return w
|
||||||
|
def playback(self, output):
|
||||||
|
for attr, args, kwargs in self.buf:
|
||||||
|
getattr(output, attr)(*args, **kwargs)
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
import sys
|
|
||||||
from utils import load_environment
|
from utils import load_environment
|
||||||
|
|
||||||
env = load_environment()
|
env = load_environment()
|
||||||
|
pool = multiprocessing.pool.Pool(processes=10)
|
||||||
|
|
||||||
if len(sys.argv) == 1:
|
if len(sys.argv) == 1:
|
||||||
run_checks(env, ConsoleOutput())
|
run_checks(False, env, ConsoleOutput(), pool)
|
||||||
|
|
||||||
|
elif sys.argv[1] == "--show-changes":
|
||||||
|
run_and_output_changes(env, pool, sys.argv[-1] == "--smtp")
|
||||||
|
|
||||||
elif sys.argv[1] == "--check-primary-hostname":
|
elif sys.argv[1] == "--check-primary-hostname":
|
||||||
# See if the primary hostname appears resolvable and has a signed certificate.
|
# See if the primary hostname appears resolvable and has a signed certificate.
|
||||||
domain = env['PRIMARY_HOSTNAME']
|
domain = env['PRIMARY_HOSTNAME']
|
||||||
if query_dns(domain, "A") != env['PUBLIC_IP']:
|
if query_dns(domain, "A") != env['PUBLIC_IP']:
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
ssl_key, ssl_certificate, ssl_csr_path = get_domain_ssl_files(domain, env)
|
ssl_key, ssl_certificate, ssl_via = get_domain_ssl_files(domain, env)
|
||||||
if not os.path.exists(ssl_certificate):
|
if not os.path.exists(ssl_certificate):
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
cert_status, cert_status_details = check_certificate(domain, ssl_certificate, ssl_key)
|
cert_status, cert_status_details = check_certificate(domain, ssl_certificate, ssl_key)
|
||||||
|
|||||||
@@ -13,22 +13,27 @@
|
|||||||
<div class="form-group">
|
<div class="form-group">
|
||||||
<div class="col-sm-offset-1 col-sm-11">
|
<div class="col-sm-offset-1 col-sm-11">
|
||||||
<div id="alias_type_buttons" class="btn-group btn-group-xs">
|
<div id="alias_type_buttons" class="btn-group btn-group-xs">
|
||||||
<button type="button" class="btn btn-default active">Regular</button>
|
<button type="button" class="btn btn-default active" data-mode="regular">Regular</button>
|
||||||
<button type="button" class="btn btn-default">Catch-All</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. Enter just a part of an email address starting with the @-sign.</span>
|
||||||
|
<span class="domainalias hidden">A domain alias forwards all otherwise unmatched mail from one domain to another domain, preserving the part before the @-sign.</span>
|
||||||
</div>
|
</div>
|
||||||
<div id="alias_catchall_info" class="text-info small" style="display: none; margin: .5em 0 0 0;">A catch-all alias captures all otherwise unmatched email to a domain. Enter just a part of an email address starting with the @-sign.</div>
|
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="form-group">
|
<div class="form-group">
|
||||||
<label for="addaliasEmail" class="col-sm-1 control-label">Alias</label>
|
<label for="addaliasEmail" class="col-sm-1 control-label">Alias</label>
|
||||||
<div class="col-sm-10">
|
<div class="col-sm-10">
|
||||||
<input type="email" class="form-control" id="addaliasEmail" placeholder="incoming email address (you@yourdomain.com)">
|
<input type="email" class="form-control" id="addaliasEmail">
|
||||||
|
<div style="margin-top: 3px; padding-left: 3px; font-size: 90%" class="text-muted">You may use international (non-ASCII) characters, but this has not yet been well tested.</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="form-group">
|
<div class="form-group">
|
||||||
<label for="addaliasTargets" class="col-sm-1 control-label">Forward To</label>
|
<label for="addaliasTargets" class="col-sm-1 control-label">Forward To</label>
|
||||||
<div class="col-sm-10">
|
<div class="col-sm-10">
|
||||||
<textarea class="form-control" rows="3" id="addaliasTargets" placeholder="forward to these email addresses (one per line or separated by commas)"></textarea>
|
<textarea class="form-control" rows="3" id="addaliasTargets"></textarea>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="form-group">
|
<div class="form-group">
|
||||||
@@ -106,16 +111,28 @@ function show_aliases() {
|
|||||||
$('#alias_type_buttons button').off('click').click(function() {
|
$('#alias_type_buttons button').off('click').click(function() {
|
||||||
$('#alias_type_buttons button').removeClass('active');
|
$('#alias_type_buttons button').removeClass('active');
|
||||||
$(this).addClass('active');
|
$(this).addClass('active');
|
||||||
if ($(this).text() == "Regular") {
|
if ($(this).attr('data-mode') == "regular") {
|
||||||
$('#addaliasEmail').attr('type', 'email');
|
$('#addaliasEmail').attr('type', 'email');
|
||||||
$('#addaliasEmail').attr('placeholder', 'incoming email address (you@yourdomain.com)');
|
$('#addaliasEmail').attr('placeholder', 'incoming email address (e.g. you@yourdomain.com)');
|
||||||
$('#alias_catchall_info').slideUp();
|
$('#addaliasTargets').attr('placeholder', 'forward to these email addresses (one per line or separated by commas)');
|
||||||
} else {
|
$('#alias_mode_info').slideUp();
|
||||||
|
} else if ($(this).attr('data-mode') == "catchall") {
|
||||||
$('#addaliasEmail').attr('type', 'text');
|
$('#addaliasEmail').attr('type', 'text');
|
||||||
$('#addaliasEmail').attr('placeholder', 'incoming catch-all address (@yourdomain.com)');
|
$('#addaliasEmail').attr('placeholder', 'incoming catch-all address (e.g. @yourdomain.com)');
|
||||||
$('#alias_catchall_info').slideDown();
|
$('#addaliasTargets').attr('placeholder', 'forward to these email addresses (one per line or separated by commas)');
|
||||||
|
$('#alias_mode_info').slideDown();
|
||||||
|
$('#alias_mode_info span').addClass('hidden');
|
||||||
|
$('#alias_mode_info span.catchall').removeClass('hidden');
|
||||||
|
} else if ($(this).attr('data-mode') == "domainalias") {
|
||||||
|
$('#addaliasEmail').attr('type', 'text');
|
||||||
|
$('#addaliasEmail').attr('placeholder', 'incoming domain (@yourdomain.com)');
|
||||||
|
$('#addaliasTargets').attr('placeholder', 'forward to domain (@yourdomain.com)');
|
||||||
|
$('#alias_mode_info').slideDown();
|
||||||
|
$('#alias_mode_info span').addClass('hidden');
|
||||||
|
$('#alias_mode_info span.domainalias').removeClass('hidden');
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
$('#alias_type_buttons button[data-mode="regular"]').click(); // init
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -166,6 +183,12 @@ function aliases_edit(elem) {
|
|||||||
$("#addaliasEmail").val(email);
|
$("#addaliasEmail").val(email);
|
||||||
$("#addaliasTargets").val(targets);
|
$("#addaliasTargets").val(targets);
|
||||||
$('#add-alias-button').text('Update');
|
$('#add-alias-button').text('Update');
|
||||||
|
if (email.charAt(0) == '@' && targets.charAt(0) == '@')
|
||||||
|
$('#alias_type_buttons button[data-mode="domainalias"]').click();
|
||||||
|
else if (email.charAt(0) == '@')
|
||||||
|
$('#alias_type_buttons button[data-mode="catchall"]').click();
|
||||||
|
else
|
||||||
|
$('#alias_type_buttons button[data-mode="regular"]').click();
|
||||||
$('body').animate({ scrollTop: 0 })
|
$('body').animate({ scrollTop: 0 })
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
<style>
|
<style>
|
||||||
|
#custom-dns-current td.long {
|
||||||
|
word-break: break-all;
|
||||||
|
}
|
||||||
</style>
|
</style>
|
||||||
|
|
||||||
<h2>Custom DNS</h2>
|
<h2>Custom DNS</h2>
|
||||||
@@ -7,6 +10,61 @@
|
|||||||
|
|
||||||
<p>It is possible to set custom DNS records on domains hosted here.</p>
|
<p>It is possible to set custom DNS records on domains hosted here.</p>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
<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="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 PRIORIY DOMAIN., including trailing period (e.g. 20 mx.example.com.).">MX (mail exchanger)</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>
|
||||||
|
</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>
|
||||||
|
</table>
|
||||||
|
|
||||||
<h3>Using a Secondary Nameserver</h3>
|
<h3>Using a Secondary Nameserver</h3>
|
||||||
|
|
||||||
<p>If your TLD requires you to have two separate nameservers, you can either set up a secondary (aka “slave”) nameserver or, alternatively, set up <a href="#" onclick="return show_panel('external_dns')">external DNS</a> and ignore the DNS server on this box. If you choose to use a seconday/slave nameserver, you must find a seconday/slave nameserver service provider. Your domain name registrar or virtual cloud provider may provide this service for you. Once you set up the seconday/slave nameserver service, enter the hostname of <em>their</em> secondary nameserver:</p>
|
<p>If your TLD requires you to have two separate nameservers, you can either set up a secondary (aka “slave”) nameserver or, alternatively, set up <a href="#" onclick="return show_panel('external_dns')">external DNS</a> and ignore the DNS server on this box. If you choose to use a seconday/slave nameserver, you must find a seconday/slave nameserver service provider. Your domain name registrar or virtual cloud provider may provide this service for you. Once you set up the seconday/slave nameserver service, enter the hostname of <em>their</em> secondary nameserver:</p>
|
||||||
@@ -30,6 +88,7 @@
|
|||||||
</div>
|
</div>
|
||||||
</form>
|
</form>
|
||||||
|
|
||||||
|
|
||||||
<h3>Custom DNS API</h3>
|
<h3>Custom DNS API</h3>
|
||||||
|
|
||||||
<p>Use your box’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’s DNS API to set custom DNS records on domains hosted here. For instance, you can create your own dynamic DNS service.</p>
|
||||||
@@ -66,11 +125,17 @@ curl -d "" --user me@mydomain.com:###### https://{{hostname}}/admin/dns/set/bar.
|
|||||||
|
|
||||||
# sets a TXT record using the alternate value syntax
|
# sets a TXT record using the alternate value syntax
|
||||||
curl -d "value=something%20here" --user me@mydomain.com:###### https://{{hostname}}/admin/dns/set/foo.mydomain.com/txt
|
curl -d "value=something%20here" --user me@mydomain.com:###### https://{{hostname}}/admin/dns/set/foo.mydomain.com/txt
|
||||||
|
|
||||||
|
# sets a <a href="http://en.wikipedia.org/wiki/SRV_record">SRV record</a> for the "service" and "protocol" hosted on "target" server
|
||||||
|
curl -d "" --user me@mydomain.com:###### https://{{hostname}}/admin/dns/set/_service._protocol.{{hostname}}/srv/"priority weight port target"
|
||||||
|
|
||||||
|
# sets a SRV record using the value syntax
|
||||||
|
curl -d "value=priority weight port target" --user me@mydomain.com:###### https://{{hostname}}/admin/dns/set/_service._protocol.host/srv
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
<script>
|
<script>
|
||||||
function show_custom_dns() {
|
function show_custom_dns() {
|
||||||
api(
|
api(
|
||||||
"/dns/secondary-nameserver",
|
"/dns/secondary-nameserver",
|
||||||
"GET",
|
"GET",
|
||||||
{ },
|
{ },
|
||||||
@@ -78,6 +143,52 @@ function show_custom_dns() {
|
|||||||
$('#secondarydnsHostname').val(data.hostname ? data.hostname : '');
|
$('#secondarydnsHostname').val(data.hostname ? data.hostname : '');
|
||||||
$('#secondarydns-clear-instructions').toggle(data.hostname != null);
|
$('#secondarydns-clear-instructions').toggle(data.hostname != null);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
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();
|
||||||
|
}
|
||||||
|
|
||||||
|
function show_current_custom_dns() {
|
||||||
|
api(
|
||||||
|
"/dns/set",
|
||||||
|
"GET",
|
||||||
|
{ },
|
||||||
|
function(data) {
|
||||||
|
if (data.length > 0)
|
||||||
|
$('#custom-dns-current').fadeIn();
|
||||||
|
else
|
||||||
|
$('#custom-dns-current').fadeOut();
|
||||||
|
|
||||||
|
$('#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.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 delete_custom_dns_record(elem) {
|
||||||
|
var qname = $(elem).parents('tr').attr('data-qname');
|
||||||
|
var rtype = $(elem).parents('tr').attr('data-rtype');
|
||||||
|
do_set_custom_dns(qname, rtype, "__delete__");
|
||||||
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
function do_set_secondary_dns() {
|
function do_set_secondary_dns() {
|
||||||
@@ -96,4 +207,34 @@ function do_set_secondary_dns() {
|
|||||||
show_modal_error("Secondary DNS", $("<pre/>").text(err));
|
show_modal_error("Secondary DNS", $("<pre/>").text(err));
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function do_set_custom_dns(qname, rtype, value) {
|
||||||
|
if (!qname) {
|
||||||
|
if ($('#customdnsQname').val() != '')
|
||||||
|
qname = $('#customdnsQname').val() + '.' + $('#customdnsZone').val();
|
||||||
|
else
|
||||||
|
qname = $('#customdnsZone').val();
|
||||||
|
rtype = $('#customdnsType').val();
|
||||||
|
value = $('#customdnsValue').val();
|
||||||
|
}
|
||||||
|
|
||||||
|
api(
|
||||||
|
"/dns/set/" + qname + "/" + rtype,
|
||||||
|
"POST",
|
||||||
|
{
|
||||||
|
value: 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", $("<pre/>").text(err));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function show_customdns_rtype_hint() {
|
||||||
|
$('#customdnsTypeHint').text($("#customdnsType").find('option:selected').attr('data-hint'));
|
||||||
|
}
|
||||||
</script>
|
</script>
|
||||||
|
|||||||
@@ -12,8 +12,9 @@
|
|||||||
border: 0;
|
border: 0;
|
||||||
padding-top: .75em;
|
padding-top: .75em;
|
||||||
padding-bottom: 0;
|
padding-bottom: 0;
|
||||||
max-width: 50vw;
|
}
|
||||||
word-wrap: break-word;
|
#external_dns_settings .value {
|
||||||
|
word-break: break-all;
|
||||||
}
|
}
|
||||||
#external_dns_settings .explanation td {
|
#external_dns_settings .explanation td {
|
||||||
border: 0;
|
border: 0;
|
||||||
|
|||||||
@@ -46,14 +46,22 @@
|
|||||||
margin-bottom: 13px;
|
margin-bottom: 13px;
|
||||||
margin-top: 30px;
|
margin-top: 30px;
|
||||||
}
|
}
|
||||||
|
.panel-heading h3 {
|
||||||
|
border: none;
|
||||||
|
padding: 0;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
h4 {
|
h4 {
|
||||||
font-size: 110%;
|
font-size: 110%;
|
||||||
margin-bottom: 13px;
|
margin-bottom: 13px;
|
||||||
margin-top: 18px;
|
margin-top: 18px;
|
||||||
}
|
}
|
||||||
|
h4:first-child {
|
||||||
|
margin-top: 6px;
|
||||||
|
}
|
||||||
|
|
||||||
.panel {
|
.admin_panel {
|
||||||
display: none;
|
display: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -92,7 +100,7 @@
|
|||||||
<li><a href="#ssl" onclick="return show_panel(this);">SSL Certificates</a></li>
|
<li><a href="#ssl" onclick="return show_panel(this);">SSL Certificates</a></li>
|
||||||
<li><a href="#system_backup" onclick="return show_panel(this);">Backup Status</a></li>
|
<li><a href="#system_backup" onclick="return show_panel(this);">Backup Status</a></li>
|
||||||
<li class="divider"></li>
|
<li class="divider"></li>
|
||||||
<li class="dropdown-header">Super Advanced Options</li>
|
<li class="dropdown-header">Advanced Options</li>
|
||||||
<li><a href="#custom_dns" onclick="return show_panel(this);">Custom DNS</a></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="#external_dns" onclick="return show_panel(this);">External DNS</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
@@ -115,48 +123,48 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="container-fluid">
|
<div class="container">
|
||||||
<div id="panel_system_status" class="container panel">
|
<div id="panel_system_status" class="admin_panel">
|
||||||
{% include "system-status.html" %}
|
{% include "system-status.html" %}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="panel_system_backup" class="container panel">
|
<div id="panel_system_backup" class="admin_panel">
|
||||||
{% include "system-backup.html" %}
|
{% include "system-backup.html" %}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="panel_external_dns" class="container panel">
|
<div id="panel_external_dns" class="admin_panel">
|
||||||
{% include "external-dns.html" %}
|
{% include "external-dns.html" %}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="panel_custom_dns" class="container panel">
|
<div id="panel_custom_dns" class="admin_panel">
|
||||||
{% include "custom-dns.html" %}
|
{% include "custom-dns.html" %}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="panel_login" class="panel">
|
<div id="panel_login" class="admin_panel">
|
||||||
{% include "login.html" %}
|
{% include "login.html" %}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="panel_mail-guide" class="container panel">
|
<div id="panel_mail-guide" class="admin_panel">
|
||||||
{% include "mail-guide.html" %}
|
{% include "mail-guide.html" %}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="panel_users" class="container panel">
|
<div id="panel_users" class="admin_panel">
|
||||||
{% include "users.html" %}
|
{% include "users.html" %}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="panel_aliases" class="container panel">
|
<div id="panel_aliases" class="admin_panel">
|
||||||
{% include "aliases.html" %}
|
{% include "aliases.html" %}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="panel_sync_guide" class="container panel">
|
<div id="panel_sync_guide" class="admin_panel">
|
||||||
{% include "sync-guide.html" %}
|
{% include "sync-guide.html" %}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="panel_web" class="container panel">
|
<div id="panel_web" class="admin_panel">
|
||||||
{% include "web.html" %}
|
{% include "web.html" %}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="panel_ssl" class="container panel">
|
<div id="panel_ssl" class="admin_panel">
|
||||||
{% include "ssl.html" %}
|
{% include "ssl.html" %}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@@ -256,12 +264,13 @@ function show_modal_confirm(title, question, verb, yes_callback, cancel_callback
|
|||||||
$('#global_modal').modal({});
|
$('#global_modal').modal({});
|
||||||
}
|
}
|
||||||
|
|
||||||
var is_ajax_loading = false;
|
var ajax_num_executing_requests = 0;
|
||||||
function ajax(options) {
|
function ajax(options) {
|
||||||
setTimeout("if (is_ajax_loading) $('#ajax_loading_indicator').fadeIn()", 100);
|
setTimeout("if (ajax_num_executing_requests > 0) $('#ajax_loading_indicator').fadeIn()", 100);
|
||||||
function hide_loading_indicator() {
|
function hide_loading_indicator() {
|
||||||
is_ajax_loading = false;
|
ajax_num_executing_requests--;
|
||||||
$('#ajax_loading_indicator').hide();
|
if (ajax_num_executing_requests == 0)
|
||||||
|
$('#ajax_loading_indicator').stop().hide(); // stop() prevents an ongoing fade from causing the thing to be shown again after this call
|
||||||
}
|
}
|
||||||
var old_success = options.success;
|
var old_success = options.success;
|
||||||
var old_error = options.error;
|
var old_error = options.error;
|
||||||
@@ -279,7 +288,7 @@ function ajax(options) {
|
|||||||
else
|
else
|
||||||
old_error(jqxhr.responseText, jqxhr);
|
old_error(jqxhr.responseText, jqxhr);
|
||||||
};
|
};
|
||||||
is_ajax_loading = true;
|
ajax_num_executing_requests++;
|
||||||
$.ajax(options);
|
$.ajax(options);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -320,6 +329,7 @@ function api(url, method, data, callback, callback_error) {
|
|||||||
ajax({
|
ajax({
|
||||||
url: "/admin" + url,
|
url: "/admin" + url,
|
||||||
method: method,
|
method: method,
|
||||||
|
cache: false,
|
||||||
data: data,
|
data: data,
|
||||||
beforeSend: function(xhr) {
|
beforeSend: function(xhr) {
|
||||||
// We don't store user credentials in a cookie to avoid the hassle of CSRF
|
// We don't store user credentials in a cookie to avoid the hassle of CSRF
|
||||||
@@ -349,7 +359,7 @@ function show_panel(panelid) {
|
|||||||
// we might be passed an HTMLElement <a>.
|
// we might be passed an HTMLElement <a>.
|
||||||
panelid = panelid.getAttribute('href').substring(1);
|
panelid = panelid.getAttribute('href').substring(1);
|
||||||
|
|
||||||
$('.panel').hide();
|
$('.admin_panel').hide();
|
||||||
$('#panel_' + panelid).show();
|
$('#panel_' + panelid).show();
|
||||||
if (typeof localStorage != 'undefined')
|
if (typeof localStorage != 'undefined')
|
||||||
localStorage.setItem("miab-cp-lastpanel", panelid);
|
localStorage.setItem("miab-cp-lastpanel", panelid);
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
<h1 style="margin: 1em; text-align: center">{{hostname}}</h1>
|
<h1 style="margin: 1em; text-align: center">{{hostname}}</h1>
|
||||||
|
|
||||||
{% if no_admins_exist %}
|
{% if no_admins_exist %}
|
||||||
<div class="container">
|
<div class="row">
|
||||||
<div class="col-md-offset-2 col-md-8">
|
<div class="col-md-offset-2 col-md-8">
|
||||||
<p class="text-danger">There are no administrative users on this system! To make an administrative user,
|
<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>
|
log into this machine using SSH (like when you first set it up) and run:</p>
|
||||||
@@ -12,27 +12,24 @@ sudo tools/mail.py user make-admin your@emailaddress.com</pre>
|
|||||||
</div>
|
</div>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
<div class="row">
|
<p style="margin: 2em; text-align: center;">Log in here for your Mail-in-a-Box control panel.</p>
|
||||||
<div class="col-sm-offset-2 col-sm-8 col-md-offset-3 col-md-6 col-lg-offset-4 col-lg-4">
|
|
||||||
<center>
|
|
||||||
<p style="margin: 2em">Log in here for your Mail-in-a-Box control panel.</p>
|
|
||||||
</center>
|
|
||||||
|
|
||||||
|
<div style="margin: 0 auto; max-width: 32em;">
|
||||||
<form class="form-horizontal" role="form" onsubmit="do_login(); return false;">
|
<form class="form-horizontal" role="form" onsubmit="do_login(); return false;">
|
||||||
<div class="form-group">
|
<div class="form-group">
|
||||||
<label for="inputEmail3" class="col-sm-2 control-label">Email</label>
|
<label for="inputEmail3" class="col-sm-3 control-label">Email</label>
|
||||||
<div class="col-sm-10">
|
<div class="col-sm-9">
|
||||||
<input name="email" type="email" class="form-control" id="loginEmail" placeholder="Email">
|
<input name="email" type="email" class="form-control" id="loginEmail" placeholder="Email">
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="form-group">
|
<div class="form-group">
|
||||||
<label for="inputPassword3" class="col-sm-2 control-label">Password</label>
|
<label for="inputPassword3" class="col-sm-3 control-label">Password</label>
|
||||||
<div class="col-sm-10">
|
<div class="col-sm-9">
|
||||||
<input name="password" type="password" class="form-control" id="loginPassword" placeholder="Password">
|
<input name="password" type="password" class="form-control" id="loginPassword" placeholder="Password">
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="form-group">
|
<div class="form-group">
|
||||||
<div class="col-sm-offset-2 col-sm-10">
|
<div class="col-sm-offset-3 col-sm-9">
|
||||||
<div class="checkbox">
|
<div class="checkbox">
|
||||||
<label>
|
<label>
|
||||||
<input name='remember' type="checkbox" id="loginRemember"> Remember me
|
<input name='remember' type="checkbox" id="loginRemember"> Remember me
|
||||||
@@ -41,12 +38,11 @@ sudo tools/mail.py user make-admin your@emailaddress.com</pre>
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="form-group">
|
<div class="form-group">
|
||||||
<div class="col-sm-offset-2 col-sm-10">
|
<div class="col-sm-offset-3 col-sm-9">
|
||||||
<button type="submit" class="btn btn-default">Sign in</button>
|
<button type="submit" class="btn btn-default">Sign in</button>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</form>
|
</form>
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@@ -71,18 +67,25 @@ function do_login() {
|
|||||||
function(response){
|
function(response){
|
||||||
// This API call always succeeds. It returns a JSON object indicating
|
// This API call always succeeds. It returns a JSON object indicating
|
||||||
// whether the request was authenticated or not.
|
// whether the request was authenticated or not.
|
||||||
if (response.status != "authorized") {
|
if (response.status != "ok") {
|
||||||
// Show why the login failed.
|
// Show why the login failed.
|
||||||
show_modal_error("Login Failed", response.reason)
|
show_modal_error("Login Failed", response.reason)
|
||||||
|
|
||||||
// Reset any saved credentials.
|
// Reset any saved credentials.
|
||||||
do_logout();
|
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.")
|
||||||
|
|
||||||
|
// Reset any saved credentials.
|
||||||
|
do_logout();
|
||||||
|
|
||||||
} else {
|
} else {
|
||||||
// Login succeeded.
|
// Login succeeded.
|
||||||
|
|
||||||
// Save the new credentials.
|
// Save the new credentials.
|
||||||
api_credentials = [response.api_key, ""];
|
api_credentials = [response.email, response.api_key];
|
||||||
|
|
||||||
// Try to wipe the username/password information.
|
// Try to wipe the username/password information.
|
||||||
$('#loginEmail').val('');
|
$('#loginEmail').val('');
|
||||||
|
|||||||
@@ -1,56 +1,46 @@
|
|||||||
<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 class="container">
|
<div>
|
||||||
<h2 style="margin-bottom: 0">Checking and Sending Mail</h2>
|
<h2 style="margin-bottom: 0">Checking and Sending Mail</h2>
|
||||||
|
|
||||||
<div class="row">
|
<div class="row">
|
||||||
<div class="col-sm-6">
|
<div class="col-sm-7">
|
||||||
<h3>How to log in</h3>
|
|
||||||
|
|
||||||
<p>Your username and password are the same no matter how you check your mail:</p>
|
|
||||||
|
|
||||||
<table class="table" style="max-width: 30em">
|
|
||||||
<tr><th>Username:</th> <td>Your whole email address.</td></tr>
|
|
||||||
<tr><th>Password:</th> <td>Your mail password.</td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<h3>Webmail</h3>
|
<h3>Webmail</h3>
|
||||||
|
|
||||||
<p>Webmail lets you check your email from any web browser. Your webmail site is:</p>
|
<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>
|
<h3>Mobile/desktop apps</h3>
|
||||||
|
|
||||||
<p>When you set up your email on your phone, desktop, or other device, you will be asked to choose a protocol.</p>
|
<h4>Automatic configuration</h4>
|
||||||
|
|
||||||
<ul>
|
<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>
|
||||||
<li>On Android devices, look for IMAP and SMTP.</li>
|
|
||||||
<li>On iOS devices, look for Exchange or ActiveSync.</li>
|
<h4>Manual configuration</h4>
|
||||||
</ul>
|
|
||||||
|
|
||||||
<div class="row">
|
<p>Use the following settings when you set up your email on your phone, desktop, or other device:</p>
|
||||||
<div class="col-lg-6">
|
|
||||||
<h4>IMAP/SMTP settings</h4>
|
|
||||||
|
|
||||||
<p>This method is preferred on Android devices but is not available on iOS devices.</p>
|
|
||||||
|
|
||||||
<p>Your mail server is <strong>{{hostname}}</strong>. Use the following settings when prompted:</p>
|
|
||||||
|
|
||||||
<table class="table">
|
<table class="table">
|
||||||
<thead>
|
<thead>
|
||||||
<tr><th>Protocol</th> <th>Port</th> <th>Options</th></tr>
|
<tr><th>Option</th> <th>Value</th></tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tr><th>IMAP</th> <td>993</td> <td>SSL</td></tr>
|
<tr><th>Protocol/Method</th> <td>IMAP</td></tr>
|
||||||
<tr><th>SMTP</th> <td>587</td> <td>STARTTLS <span>(“always” or “required”, if prompted)</span></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</td></tr>
|
||||||
|
<tr><th>SMTP Port</th> <td>587</td></tr>
|
||||||
|
<tr><th>SMTP Security</td> <td>STARTTLS <small>(“always” or “required”, 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>
|
</table>
|
||||||
|
|
||||||
<p>In addition to setting up your email, you’ll also need to set up <a href="#sync_guide" onclick="return show_panel(this);">contacts and calendar synchronization</a> separately.</p>
|
<p>In addition to setting up your email, you’ll also need to set up <a href="#sync_guide" onclick="return show_panel(this);">contacts and calendar synchronization</a> separately.</p>
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="col-lg-6">
|
<h4>Exchange/ActiveSync settings</h4>
|
||||||
<h4>Exchange/ActiveSync settings</h4>
|
|
||||||
|
|
||||||
<p>On iOS devices and devices on this <a href="http://z-push.org/compatibility/">compatibility list</a>, set up your mail as an Exchange or ActiveSync server. Use these settings when prompted:</p>
|
<p>On iOS devices, devices on this <a href="http://z-push.org/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’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>
|
||||||
|
|
||||||
<table class="table">
|
<table class="table">
|
||||||
<tr><th>Server</th> <td>{{hostname}}</td></tr>
|
<tr><th>Server</th> <td>{{hostname}}</td></tr>
|
||||||
@@ -58,18 +48,24 @@
|
|||||||
</table>
|
</table>
|
||||||
|
|
||||||
<p>Your device should also provide a contacts list and calendar that syncs to this box when you use this method.</p>
|
<p>Your device should also provide a contacts list and calendar that syncs to this box when you use this method.</p>
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="col-sm-6">
|
<div class="col-sm-5">
|
||||||
|
<div class="panel panel-default">
|
||||||
|
<div class="panel-heading">
|
||||||
<h3>Other information about mail on your box</h3>
|
<h3>Other information about mail on your box</h3>
|
||||||
|
</div>
|
||||||
|
<div class="panel-body">
|
||||||
<h4>Greylisting</h4>
|
<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’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>
|
<p>Your box using a technique called greylisting to cut down on spam. Greylisting works by delaying mail from people you haven’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>
|
||||||
|
|
||||||
<h4>Use this box to send as you</h4>
|
<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 can also accept mail at <code>you+anythinghere@yourdomain.com</code>. Use this as a fast way to create aliases or to segment incoming mail for your own filtering rules.</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>
|
<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>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@@ -18,9 +18,11 @@
|
|||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
<p>Advanced:<br>Install a multi-domain or wildcard certificate for the <code>{{hostname}}</code> domain to have it automatically applied to any domains it is valid for.</p>
|
||||||
|
|
||||||
<h3 id="ssl_install_header">Install SSL Certificate</h3>
|
<h3 id="ssl_install_header">Install SSL Certificate</h3>
|
||||||
|
|
||||||
<p>There are many places where you can get a free or cheap SSL certificate. We recommend <a href="https://www.namecheap.com/cart/remove.aspx?itemid=47016639&i=i2">Namecheap’s $9 certificate</a> or <a href="https://www.startssl.com/">StartSSL’s free express lane</a>.</p>
|
<p>There are many places where you can get a free or cheap SSL certificate. We recommend <a href="https://www.namecheap.com/security/ssl-certificates/domain-validation.aspx">Namecheap’s $9 certificate</a> or <a href="https://www.startssl.com/">StartSSL’s free express lane</a>.</p>
|
||||||
|
|
||||||
<p>Which domain are you getting an SSL certificate for?</p>
|
<p>Which domain are you getting an SSL certificate for?</p>
|
||||||
|
|
||||||
@@ -83,7 +85,7 @@ function ssl_install(elem) {
|
|||||||
$('#csr_info').slideDown();
|
$('#csr_info').slideDown();
|
||||||
$('#ssl_csr').text('Loading...');
|
$('#ssl_csr').text('Loading...');
|
||||||
show_csr();
|
show_csr();
|
||||||
$('html, body').animate({ scrollTop: $('#ssl_install_header').offset().top })
|
$('html, body').animate({ scrollTop: $('#ssl_install_header').offset().top - $('.navbar-fixed-top').height() - 20 })
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
<div class="container">
|
<div>
|
||||||
<h2>Contacts & Calendar Synchronization</h2>
|
<h2>Contacts & Calendar Synchronization</h2>
|
||||||
|
|
||||||
<p>This box can hold your contacts and calendar, just like it holds your email.</p>
|
<p>This box can hold your contacts and calendar, just like it holds your email.</p>
|
||||||
|
|||||||
@@ -15,7 +15,7 @@
|
|||||||
|
|
||||||
<h3>Current Backups</h3>
|
<h3>Current Backups</h3>
|
||||||
|
|
||||||
<p>The backup directory currently contains the backups listed below. The total size on disk of the backups is <span id="backup-total-size"></span>.</p>
|
<p>The backup directory currently contains the backups listed below. The total size on disk of the backups is currently <span id="backup-total-size"></span>.</p>
|
||||||
|
|
||||||
<table id="backup-status" class="table" style="width: auto">
|
<table id="backup-status" class="table" style="width: auto">
|
||||||
<thead>
|
<thead>
|
||||||
@@ -28,7 +28,7 @@
|
|||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
<p><small>The size column in the table indicates the size of the encrpyted backup, but the total size on disk shown above includes storage for unencrpyted intermediate files.</small></p>
|
<p style="margin-top: 2em"><small>The size column in the table indicates the size of the encrypted backup, but the total size on disk shown above includes storage for unencrypted intermediate files.</small></p>
|
||||||
|
|
||||||
<script>
|
<script>
|
||||||
function nice_size(bytes) {
|
function nice_size(bytes) {
|
||||||
@@ -59,6 +59,12 @@ function show_system_backup() {
|
|||||||
|
|
||||||
$('#backup-status tbody').html("");
|
$('#backup-status tbody').html("");
|
||||||
var total_disk_size = 0;
|
var total_disk_size = 0;
|
||||||
|
|
||||||
|
if (r.backups.length == 0) {
|
||||||
|
var tr = $('<tr><td colspan="3">No backups have been made yet.</td></tr>');
|
||||||
|
$('#backup-status tbody').append(tr);
|
||||||
|
}
|
||||||
|
|
||||||
for (var i = 0; i < r.backups.length; i++) {
|
for (var i = 0; i < r.backups.length; i++) {
|
||||||
var b = r.backups[i];
|
var b = r.backups[i];
|
||||||
var tr = $('<tr/>');
|
var tr = $('<tr/>');
|
||||||
@@ -70,7 +76,7 @@ function show_system_backup() {
|
|||||||
if (b.deleted_in)
|
if (b.deleted_in)
|
||||||
tr.append( $('<td/>').text(b.deleted_in) );
|
tr.append( $('<td/>').text(b.deleted_in) );
|
||||||
else
|
else
|
||||||
tr.append( $('<td class="text-muted">n/a</td>') );
|
tr.append( $('<td class="text-muted">unknown</td>') );
|
||||||
$('#backup-status tbody').append(tr);
|
$('#backup-status tbody').append(tr);
|
||||||
|
|
||||||
total_disk_size += b.size;
|
total_disk_size += b.size;
|
||||||
|
|||||||
@@ -1,18 +1,17 @@
|
|||||||
<h2>Users</h2>
|
<h2>Users</h2>
|
||||||
|
|
||||||
<style>
|
<style>
|
||||||
|
#user_table h4 { margin: 1em 0 0 0; }
|
||||||
#user_table tr.account_inactive td.address { color: #888; text-decoration: line-through; }
|
#user_table tr.account_inactive td.address { color: #888; text-decoration: line-through; }
|
||||||
#user_table .aliases { font-size: 90%; }
|
|
||||||
#user_table .aliases div:before { content: "⇖ "; }
|
|
||||||
#user_table .aliases div { }
|
|
||||||
#user_table .actions { margin-top: .33em; font-size: 95%; }
|
#user_table .actions { margin-top: .33em; font-size: 95%; }
|
||||||
#user_table .account_inactive .if_active { display: none; }
|
#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 .account_active.if_inactive { display: none; }
|
||||||
</style>
|
</style>
|
||||||
|
|
||||||
<h3>Add a mail user</h3>
|
<h3>Add a mail user</h3>
|
||||||
|
|
||||||
<p>Add an email address to this system. This will create a new login username/password. (Use <a href="javascript:show_panel('aliases')">aliases</a> to create email addresses that forward to existing accounts.)</p>
|
<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;">
|
<form class="form-inline" role="form" onsubmit="return do_add_user(); return false;">
|
||||||
<div class="form-group">
|
<div class="form-group">
|
||||||
@@ -31,10 +30,12 @@
|
|||||||
</div>
|
</div>
|
||||||
<button type="submit" class="btn btn-primary">Add User</button>
|
<button type="submit" class="btn btn-primary">Add User</button>
|
||||||
</form>
|
</form>
|
||||||
<p style="margin-top: .5em"><small>
|
<ul style="margin-top: 1em; padding-left: 1.5em; font-size: 90%;">
|
||||||
Passwords must be at least four characters and may not contain spaces.
|
<li>Passwords must be at least four characters and may not contain spaces.</li>
|
||||||
Administrators get access to this control panel.
|
<li>Use <a href="javascript:show_panel('aliases')">aliases</a> to create email addresses that forward to existing accounts.</li>
|
||||||
</small></p>
|
<li>Administrators get access to this control panel.</li>
|
||||||
|
<li>User accounts cannot contain any international (non-ASCII) characters, but <a href="javascript:show_panel('aliases')">aliases</a> can.</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
<h3>Existing mail users</h3>
|
<h3>Existing mail users</h3>
|
||||||
<table id="user_table" class="table" style="width: auto">
|
<table id="user_table" class="table" style="width: auto">
|
||||||
@@ -75,11 +76,9 @@
|
|||||||
<td class='mailboxsize'>
|
<td class='mailboxsize'>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="user-extra-template">
|
<tr id="user-extra-template" class="if_inactive">
|
||||||
<td colspan="3" style="border-top: 0; padding-top: 0">
|
<td colspan="3" style="border: 0; padding-top: 0">
|
||||||
<div class='if_inactive 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>
|
<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>
|
||||||
|
|
||||||
<div class='aliases' style='display: none'> </div>
|
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
@@ -96,7 +95,7 @@ function show_users() {
|
|||||||
function(r) {
|
function(r) {
|
||||||
$('#user_table tbody').html("");
|
$('#user_table tbody').html("");
|
||||||
for (var i = 0; i < r.length; i++) {
|
for (var i = 0; i < r.length; i++) {
|
||||||
var hdr = $("<tr><td><h4/></td></tr>");
|
var hdr = $("<tr><td colspan='3'><h4/></td></tr>");
|
||||||
hdr.find('h4').text(r[i].domain);
|
hdr.find('h4').text(r[i].domain);
|
||||||
$('#user_table tbody').append(hdr);
|
$('#user_table tbody').append(hdr);
|
||||||
|
|
||||||
@@ -135,16 +134,6 @@ function show_users() {
|
|||||||
p.find('span.name').text(add_privs[j]);
|
p.find('span.name').text(add_privs[j]);
|
||||||
n.find('.add-privs').append(p);
|
n.find('.add-privs').append(p);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (user.aliases && user.aliases.length > 0) {
|
|
||||||
n2.find('.aliases').show();
|
|
||||||
for (var j = 0; j < user.aliases.length; j++) {
|
|
||||||
n2.find('.aliases').append($("<div/>").text(
|
|
||||||
user.aliases[j][0]
|
|
||||||
+ (user.aliases[j][1].length > 0 ? " ⇐ " + user.aliases[j][1].join(", ") : "")
|
|
||||||
))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -7,7 +7,7 @@
|
|||||||
|
|
||||||
<h3>Uploading web files</h3>
|
<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’t help you design a website, but once you have <tt>.html</tt> files you can upload it following these instructions:</p>
|
<p>You can replace the default website with your own HTML pages and other static files. This control panel won’t help you design a website, but once you have <tt>.html</tt> files you can upload them following these instructions:</p>
|
||||||
|
|
||||||
<ol>
|
<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>
|
||||||
@@ -18,41 +18,24 @@
|
|||||||
|
|
||||||
<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 (if you have customized that, see next section).</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: 2em; width: auto;">
|
<table id="web_domains_existing" class="table" style="margin-bottom: 1em; width: auto;">
|
||||||
<thead>
|
<thead>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Site</th>
|
<th>Site</th>
|
||||||
<th>Directory for Files</th>
|
<th>Directory for Files</th>
|
||||||
|
<th/>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
<li>If you want to have this box host a static website on a domain that is not listed in the 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.</li>
|
<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>
|
</ol>
|
||||||
|
|
||||||
<h3>Different sites for different domains</h3>
|
|
||||||
|
|
||||||
<p>Create one of the directories shown in the table below to create a space for different files for one of the websites.</p>
|
|
||||||
|
|
||||||
<p>After you create one of these directories, click <button id="web_update" class="btn btn-primary" onclick="do_web_update()">Web Update</button> to restart the box’s web server so that it sees the new website file location.</p>
|
|
||||||
|
|
||||||
<table id="web_domains_custom" class="table" style="margin-bottom: 2em; width: auto;">
|
|
||||||
<thead>
|
|
||||||
<tr>
|
|
||||||
<th>Site</th>
|
|
||||||
<th>Create Directory</th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
|
|
||||||
<script>
|
<script>
|
||||||
function show_web() {
|
function show_web() {
|
||||||
api(
|
api(
|
||||||
@@ -64,24 +47,18 @@ function show_web() {
|
|||||||
var tb = $('#web_domains_existing tbody');
|
var tb = $('#web_domains_existing tbody');
|
||||||
tb.text('');
|
tb.text('');
|
||||||
for (var i = 0; i < domains.length; i++) {
|
for (var i = 0; i < domains.length; i++) {
|
||||||
var row = $("<tr><th class='domain'><a href=''></a></th><td class='directory'><tt/></td></tr>");
|
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);
|
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').text('https://' + domains[i].domain);
|
||||||
row.find('.domain a').attr('href', 'https://' + domains[i].domain);
|
row.find('.domain a').attr('href', 'https://' + domains[i].domain);
|
||||||
row.find('.directory tt').text(domains[i].root);
|
row.find('.directory tt').text(domains[i].root);
|
||||||
|
if (domains[i].root != domains[i].custom_root)
|
||||||
|
row.find('.change-root').removeClass('hidden');
|
||||||
}
|
}
|
||||||
|
|
||||||
tb = $('#web_domains_custom tbody');
|
|
||||||
tb.text('');
|
|
||||||
for (var i = 0; i < domains.length; i++) {
|
|
||||||
if (domains[i].root != domains[i].custom_root) {
|
|
||||||
var row = $("<tr><th class='domain'><a href=''></a></th><td class='directory'><tt></td></tr>");
|
|
||||||
tb.append(row);
|
|
||||||
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].custom_root);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -99,4 +76,14 @@ function do_web_update() {
|
|||||||
show_modal_error("Web Update", data, function() { show_web() });
|
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.',
|
||||||
|
'Update',
|
||||||
|
function() { do_web_update(); });
|
||||||
|
}
|
||||||
</script>
|
</script>
|
||||||
|
|||||||
@@ -2,10 +2,10 @@
|
|||||||
# domains for which a mail account has been set up.
|
# domains for which a mail account has been set up.
|
||||||
########################################################################
|
########################################################################
|
||||||
|
|
||||||
import os, os.path, re, rtyaml
|
import os, os.path, shutil, re, tempfile, rtyaml
|
||||||
|
|
||||||
from mailconfig import get_mail_domains
|
from mailconfig import get_mail_domains
|
||||||
from dns_update import get_custom_dns_config
|
from dns_update import get_custom_dns_config, do_dns_update
|
||||||
from utils import shell, safe_domain_name, sort_domains
|
from utils import shell, safe_domain_name, sort_domains
|
||||||
|
|
||||||
def get_web_domains(env):
|
def get_web_domains(env):
|
||||||
@@ -17,9 +17,8 @@ def get_web_domains(env):
|
|||||||
domains.add(env['PRIMARY_HOSTNAME'])
|
domains.add(env['PRIMARY_HOSTNAME'])
|
||||||
|
|
||||||
# Also serve web for all mail domains so that we might at least
|
# Also serve web for all mail domains so that we might at least
|
||||||
# provide Webfinger and ActiveSync auto-discover of email settings
|
# provide auto-discover of email settings, and also a static website
|
||||||
# (though the latter isn't really working). These will require that
|
# if the user wants to make one. These will require an SSL cert.
|
||||||
# an SSL cert be installed.
|
|
||||||
domains |= get_mail_domains(env)
|
domains |= get_mail_domains(env)
|
||||||
|
|
||||||
# ...Unless the domain has an A/AAAA record that maps it to a different
|
# ...Unless the domain has an A/AAAA record that maps it to a different
|
||||||
@@ -28,6 +27,7 @@ def get_web_domains(env):
|
|||||||
for domain, value in dns.items():
|
for domain, value in dns.items():
|
||||||
if domain not in domains: continue
|
if domain not in domains: continue
|
||||||
if (isinstance(value, str) and (value != "local")) \
|
if (isinstance(value, str) and (value != "local")) \
|
||||||
|
or (isinstance(value, dict) and ("CNAME" in value)) \
|
||||||
or (isinstance(value, dict) and ("A" in value) and (value["A"] != "local")) \
|
or (isinstance(value, dict) and ("A" in value) and (value["A"] != "local")) \
|
||||||
or (isinstance(value, dict) and ("AAAA" in value) and (value["AAAA"] != "local")):
|
or (isinstance(value, dict) and ("AAAA" in value) and (value["AAAA"] != "local")):
|
||||||
domains.remove(domain)
|
domains.remove(domain)
|
||||||
@@ -75,11 +75,11 @@ def make_domain_config(domain, template, template_for_primaryhost, env):
|
|||||||
root = get_web_root(domain, env)
|
root = get_web_root(domain, env)
|
||||||
|
|
||||||
# What private key and SSL certificate will we use for this domain?
|
# What private key and SSL certificate will we use for this domain?
|
||||||
ssl_key, ssl_certificate, csr_path = get_domain_ssl_files(domain, env)
|
ssl_key, ssl_certificate, ssl_via = get_domain_ssl_files(domain, env)
|
||||||
|
|
||||||
# For hostnames created after the initial setup, ensure we have an SSL certificate
|
# For hostnames created after the initial setup, ensure we have an SSL certificate
|
||||||
# available. Make a self-signed one now if one doesn't exist.
|
# available. Make a self-signed one now if one doesn't exist.
|
||||||
ensure_ssl_certificate_exists(domain, ssl_key, ssl_certificate, csr_path, env)
|
ensure_ssl_certificate_exists(domain, ssl_key, ssl_certificate, env)
|
||||||
|
|
||||||
# Put pieces together.
|
# Put pieces together.
|
||||||
nginx_conf_parts = re.split("\s*# ADDITIONAL DIRECTIVES HERE\s*", template)
|
nginx_conf_parts = re.split("\s*# ADDITIONAL DIRECTIVES HERE\s*", template)
|
||||||
@@ -89,7 +89,7 @@ def make_domain_config(domain, template, template_for_primaryhost, env):
|
|||||||
|
|
||||||
# Replace substitution strings in the template & return.
|
# Replace substitution strings in the template & return.
|
||||||
nginx_conf = nginx_conf.replace("$STORAGE_ROOT", env['STORAGE_ROOT'])
|
nginx_conf = nginx_conf.replace("$STORAGE_ROOT", env['STORAGE_ROOT'])
|
||||||
nginx_conf = nginx_conf.replace("$HOSTNAME", domain)
|
nginx_conf = nginx_conf.replace("$HOSTNAME", domain.encode("idna").decode("ascii"))
|
||||||
nginx_conf = nginx_conf.replace("$ROOT", root)
|
nginx_conf = nginx_conf.replace("$ROOT", root)
|
||||||
nginx_conf = nginx_conf.replace("$SSL_KEY", ssl_key)
|
nginx_conf = nginx_conf.replace("$SSL_KEY", ssl_key)
|
||||||
nginx_conf = nginx_conf.replace("$SSL_CERTIFICATE", ssl_certificate)
|
nginx_conf = nginx_conf.replace("$SSL_CERTIFICATE", ssl_certificate)
|
||||||
@@ -115,6 +115,8 @@ def make_domain_config(domain, template, template_for_primaryhost, env):
|
|||||||
yaml = yaml[domain]
|
yaml = yaml[domain]
|
||||||
for path, url in yaml.get("proxies", {}).items():
|
for path, url in yaml.get("proxies", {}).items():
|
||||||
nginx_conf += "\tlocation %s {\n\t\tproxy_pass %s;\n\t}\n" % (path, url)
|
nginx_conf += "\tlocation %s {\n\t\tproxy_pass %s;\n\t}\n" % (path, url)
|
||||||
|
for path, url in yaml.get("redirects", {}).items():
|
||||||
|
nginx_conf += "\trewrite %s %s permanent;\n" % (path, url)
|
||||||
|
|
||||||
# Add in any user customizations in the includes/ folder.
|
# 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")
|
nginx_conf_custom_include = os.path.join(env["STORAGE_ROOT"], "www", safe_domain_name(domain) + ".conf")
|
||||||
@@ -133,7 +135,7 @@ def get_web_root(domain, env, test_exists=True):
|
|||||||
if os.path.exists(root) or not test_exists: break
|
if os.path.exists(root) or not test_exists: break
|
||||||
return root
|
return root
|
||||||
|
|
||||||
def get_domain_ssl_files(domain, env):
|
def get_domain_ssl_files(domain, env, allow_shared_cert=True):
|
||||||
# What SSL private key will we use? Allow the user to override this, but
|
# What SSL private key will we use? Allow the user to override this, but
|
||||||
# in many cases using the same private key for all domains would be fine.
|
# in many cases using the same private key for all domains would be fine.
|
||||||
# Don't allow the user to override the key for PRIMARY_HOSTNAME because
|
# Don't allow the user to override the key for PRIMARY_HOSTNAME because
|
||||||
@@ -147,6 +149,7 @@ def get_domain_ssl_files(domain, env):
|
|||||||
|
|
||||||
# What SSL certificate will we use?
|
# What SSL certificate will we use?
|
||||||
ssl_certificate_primary = os.path.join(env["STORAGE_ROOT"], 'ssl/ssl_certificate.pem')
|
ssl_certificate_primary = os.path.join(env["STORAGE_ROOT"], 'ssl/ssl_certificate.pem')
|
||||||
|
ssl_via = None
|
||||||
if domain == env['PRIMARY_HOSTNAME']:
|
if domain == env['PRIMARY_HOSTNAME']:
|
||||||
# For PRIMARY_HOSTNAME, use the one we generated at set-up time.
|
# For PRIMARY_HOSTNAME, use the one we generated at set-up time.
|
||||||
ssl_certificate = ssl_certificate_primary
|
ssl_certificate = ssl_certificate_primary
|
||||||
@@ -157,21 +160,22 @@ def get_domain_ssl_files(domain, env):
|
|||||||
# But we can be smart and reuse the main SSL certificate if is has
|
# But we can be smart and reuse the main SSL certificate if is has
|
||||||
# a Subject Alternative Name matching this domain. Don't do this if
|
# a Subject Alternative Name matching this domain. Don't do this if
|
||||||
# the user has uploaded a different private key for this domain.
|
# the user has uploaded a different private key for this domain.
|
||||||
if not ssl_key_is_alt:
|
if not ssl_key_is_alt and allow_shared_cert:
|
||||||
from status_checks import check_certificate
|
from status_checks import check_certificate
|
||||||
if check_certificate(domain, ssl_certificate_primary, None)[0] == "OK":
|
if check_certificate(domain, ssl_certificate_primary, None)[0] == "OK":
|
||||||
ssl_certificate = ssl_certificate_primary
|
ssl_certificate = ssl_certificate_primary
|
||||||
|
ssl_via = "Using multi/wildcard certificate of %s." % env['PRIMARY_HOSTNAME']
|
||||||
|
|
||||||
# Where would the CSR go? As with the SSL cert itself, the CSR must be
|
# For a 'www.' domain, see if we can reuse the cert of the parent.
|
||||||
# different for each domain name.
|
elif domain.startswith('www.'):
|
||||||
if domain == env['PRIMARY_HOSTNAME']:
|
ssl_certificate_parent = os.path.join(env["STORAGE_ROOT"], 'ssl/%s/ssl_certificate.pem' % safe_domain_name(domain[4:]))
|
||||||
csr_path = os.path.join(env["STORAGE_ROOT"], 'ssl/ssl_cert_sign_req.csr')
|
if os.path.exists(ssl_certificate_parent) and check_certificate(domain, ssl_certificate_parent, None)[0] == "OK":
|
||||||
else:
|
ssl_certificate = ssl_certificate_parent
|
||||||
csr_path = os.path.join(env["STORAGE_ROOT"], 'ssl/%s/certificate_signing_request.csr' % safe_domain_name(domain))
|
ssl_via = "Using multi/wildcard certificate of %s." % domain[4:]
|
||||||
|
|
||||||
return ssl_key, ssl_certificate, csr_path
|
return ssl_key, ssl_certificate, ssl_via
|
||||||
|
|
||||||
def ensure_ssl_certificate_exists(domain, ssl_key, ssl_certificate, csr_path, env):
|
def ensure_ssl_certificate_exists(domain, ssl_key, ssl_certificate, env):
|
||||||
# For domains besides PRIMARY_HOSTNAME, generate a self-signed certificate if
|
# For domains besides PRIMARY_HOSTNAME, generate a self-signed certificate if
|
||||||
# a certificate doesn't already exist. See setup/mail.sh for documentation.
|
# a certificate doesn't already exist. See setup/mail.sh for documentation.
|
||||||
|
|
||||||
@@ -190,17 +194,18 @@ def ensure_ssl_certificate_exists(domain, ssl_key, ssl_certificate, csr_path, en
|
|||||||
|
|
||||||
# Generate a new self-signed certificate using the same private key that we already have.
|
# Generate a new self-signed certificate using the same private key that we already have.
|
||||||
|
|
||||||
# Start with a CSR.
|
# Start with a CSR written to a temporary file.
|
||||||
with open(csr_path, "w") as f:
|
with tempfile.NamedTemporaryFile(mode="w") as csr_fp:
|
||||||
f.write(create_csr(domain, ssl_key, env))
|
csr_fp.write(create_csr(domain, ssl_key, env))
|
||||||
|
csr_fp.flush() # since we won't close until after running 'openssl x509', since close triggers delete.
|
||||||
|
|
||||||
# And then make the certificate.
|
# And then make the certificate.
|
||||||
shell("check_call", [
|
shell("check_call", [
|
||||||
"openssl", "x509", "-req",
|
"openssl", "x509", "-req",
|
||||||
"-days", "365",
|
"-days", "365",
|
||||||
"-in", csr_path,
|
"-in", csr_fp.name,
|
||||||
"-signkey", ssl_key,
|
"-signkey", ssl_key,
|
||||||
"-out", ssl_certificate])
|
"-out", ssl_certificate])
|
||||||
|
|
||||||
def create_csr(domain, ssl_key, env):
|
def create_csr(domain, ssl_key, env):
|
||||||
return shell("check_output", [
|
return shell("check_output", [
|
||||||
@@ -208,7 +213,7 @@ def create_csr(domain, ssl_key, env):
|
|||||||
"-key", ssl_key,
|
"-key", ssl_key,
|
||||||
"-out", "/dev/stdout",
|
"-out", "/dev/stdout",
|
||||||
"-sha256",
|
"-sha256",
|
||||||
"-subj", "/C=%s/ST=/L=/O=/CN=%s" % (env["CSR_COUNTRY"], domain)])
|
"-subj", "/C=%s/ST=/L=/O=/CN=%s" % (env["CSR_COUNTRY"], domain.encode("idna").decode("ascii"))])
|
||||||
|
|
||||||
def install_cert(domain, ssl_cert, ssl_chain, env):
|
def install_cert(domain, ssl_cert, ssl_chain, env):
|
||||||
if domain not in get_web_domains(env):
|
if domain not in get_web_domains(env):
|
||||||
@@ -223,30 +228,59 @@ def install_cert(domain, ssl_cert, ssl_chain, env):
|
|||||||
|
|
||||||
# Do validation on the certificate before installing it.
|
# Do validation on the certificate before installing it.
|
||||||
from status_checks import check_certificate
|
from status_checks import check_certificate
|
||||||
ssl_key, ssl_certificate, ssl_csr_path = get_domain_ssl_files(domain, env)
|
ssl_key, ssl_certificate, ssl_via = get_domain_ssl_files(domain, env, allow_shared_cert=False)
|
||||||
cert_status, cert_status_details = check_certificate(domain, fn, ssl_key)
|
cert_status, cert_status_details = check_certificate(domain, fn, ssl_key)
|
||||||
if cert_status != "OK":
|
if cert_status != "OK":
|
||||||
if cert_status == "SELF-SIGNED":
|
if cert_status == "SELF-SIGNED":
|
||||||
cert_status = "This is a self-signed certificate. I can't install that."
|
cert_status = "This is a self-signed certificate. I can't install that."
|
||||||
os.unlink(fn)
|
os.unlink(fn)
|
||||||
|
if cert_status_details is not None:
|
||||||
|
cert_status += " " + cert_status_details
|
||||||
return cert_status
|
return cert_status
|
||||||
|
|
||||||
# Copy the certificate to its expected location.
|
# Copy the certificate to its expected location.
|
||||||
os.makedirs(os.path.dirname(ssl_certificate), exist_ok=True)
|
os.makedirs(os.path.dirname(ssl_certificate), exist_ok=True)
|
||||||
os.rename(fn, ssl_certificate)
|
shutil.move(fn, ssl_certificate)
|
||||||
|
|
||||||
|
ret = []
|
||||||
|
|
||||||
|
# When updating the cert for PRIMARY_HOSTNAME, also update DNS because it is
|
||||||
|
# used in the DANE TLSA record and restart postfix and dovecot which use
|
||||||
|
# that certificate.
|
||||||
|
if domain == env['PRIMARY_HOSTNAME']:
|
||||||
|
ret.append( do_dns_update(env) )
|
||||||
|
|
||||||
|
shell('check_call', ["/usr/sbin/service", "postfix", "restart"])
|
||||||
|
shell('check_call', ["/usr/sbin/service", "dovecot", "restart"])
|
||||||
|
ret.append("mail services restarted")
|
||||||
|
|
||||||
# Kick nginx so it sees the cert.
|
# Kick nginx so it sees the cert.
|
||||||
return do_web_update(env, ok_status="")
|
ret.append( do_web_update(env, ok_status="") )
|
||||||
|
return "\n".join(r for r in ret if r.strip() != "")
|
||||||
|
|
||||||
def get_web_domains_info(env):
|
def get_web_domains_info(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
|
||||||
|
custom_settings = { }
|
||||||
|
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))
|
||||||
|
def has_root_proxy_or_redirect(domain):
|
||||||
|
return custom_settings.get(domain, {}).get('redirects', {}).get('/') or custom_settings.get(domain, {}).get('proxies', {}).get('/')
|
||||||
|
|
||||||
|
# for the SSL config panel, get cert status
|
||||||
def check_cert(domain):
|
def check_cert(domain):
|
||||||
from status_checks import check_certificate
|
from status_checks import check_certificate
|
||||||
ssl_key, ssl_certificate, ssl_csr_path = get_domain_ssl_files(domain, env)
|
ssl_key, ssl_certificate, ssl_via = get_domain_ssl_files(domain, env)
|
||||||
if not os.path.exists(ssl_certificate):
|
if not os.path.exists(ssl_certificate):
|
||||||
return ("danger", "No Certificate Installed")
|
return ("danger", "No Certificate Installed")
|
||||||
cert_status, cert_status_details = check_certificate(domain, ssl_certificate, ssl_key)
|
cert_status, cert_status_details = check_certificate(domain, ssl_certificate, ssl_key)
|
||||||
if cert_status == "OK":
|
if cert_status == "OK":
|
||||||
return ("success", "Signed & valid. " + cert_status_details)
|
if not ssl_via:
|
||||||
|
return ("success", "Signed & valid. " + cert_status_details)
|
||||||
|
else:
|
||||||
|
# This is an alternate domain but using the same cert as the primary domain.
|
||||||
|
return ("success", "Signed & valid. " + ssl_via)
|
||||||
elif cert_status == "SELF-SIGNED":
|
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:
|
else:
|
||||||
@@ -258,6 +292,7 @@ def get_web_domains_info(env):
|
|||||||
"root": get_web_root(domain, env),
|
"root": get_web_root(domain, env),
|
||||||
"custom_root": get_web_root(domain, env, test_exists=False),
|
"custom_root": get_web_root(domain, env, test_exists=False),
|
||||||
"ssl_certificate": check_cert(domain),
|
"ssl_certificate": check_cert(domain),
|
||||||
|
"static_enabled": not has_root_proxy_or_redirect(domain),
|
||||||
}
|
}
|
||||||
for domain in get_web_domains(env)
|
for domain in get_web_domains(env)
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -7,7 +7,7 @@
|
|||||||
#########################################################
|
#########################################################
|
||||||
|
|
||||||
if [ -z "$TAG" ]; then
|
if [ -z "$TAG" ]; then
|
||||||
TAG=v0.03
|
TAG=v0.08
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Are we running as root?
|
# Are we running as root?
|
||||||
@@ -17,12 +17,12 @@ if [[ $EUID -ne 0 ]]; then
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
# Clone the Mail-in-a-Box repository if it doesn't exist.
|
# Clone the Mail-in-a-Box repository if it doesn't exist.
|
||||||
if [ ! -d mailinabox ]; then
|
if [ ! -d $HOME/mailinabox ]; then
|
||||||
echo Installing git . . .
|
echo Installing git . . .
|
||||||
DEBIAN_FRONTEND=noninteractive apt-get -q -q install -y git < /dev/null
|
DEBIAN_FRONTEND=noninteractive apt-get -q -q install -y git < /dev/null
|
||||||
echo
|
echo
|
||||||
|
|
||||||
echo Downloading Mail-in-a-Box . . .
|
echo Downloading Mail-in-a-Box $TAG. . .
|
||||||
git clone \
|
git clone \
|
||||||
-b $TAG --depth 1 \
|
-b $TAG --depth 1 \
|
||||||
https://github.com/mail-in-a-box/mailinabox \
|
https://github.com/mail-in-a-box/mailinabox \
|
||||||
@@ -38,7 +38,7 @@ cd $HOME/mailinabox
|
|||||||
# Update it.
|
# Update it.
|
||||||
if [ "$TAG" != `git describe` ]; then
|
if [ "$TAG" != `git describe` ]; then
|
||||||
echo Updating Mail-in-a-Box to $TAG . . .
|
echo Updating Mail-in-a-Box to $TAG . . .
|
||||||
git fetch
|
git fetch --depth 1 --force --prune origin tag $TAG
|
||||||
if ! git checkout -q $TAG; then
|
if ! git checkout -q $TAG; then
|
||||||
echo "Update failed. Did you modify something in `pwd`?"
|
echo "Update failed. Did you modify something in `pwd`?"
|
||||||
exit
|
exit
|
||||||
|
|||||||
26
setup/dkim.sh
Normal file → Executable file
26
setup/dkim.sh
Normal file → Executable file
@@ -1,3 +1,4 @@
|
|||||||
|
#!/bin/bash
|
||||||
# OpenDKIM
|
# OpenDKIM
|
||||||
# --------
|
# --------
|
||||||
#
|
#
|
||||||
@@ -6,9 +7,10 @@
|
|||||||
# The DNS configuration for DKIM is done in the management daemon.
|
# The DNS configuration for DKIM is done in the management daemon.
|
||||||
|
|
||||||
source setup/functions.sh # load our functions
|
source setup/functions.sh # load our functions
|
||||||
|
source /etc/mailinabox.conf # load global vars
|
||||||
|
|
||||||
# Install DKIM...
|
# Install DKIM...
|
||||||
apt_install opendkim opendkim-tools
|
apt_install opendkim opendkim-tools opendmarc
|
||||||
|
|
||||||
# Make sure configuration directories exist.
|
# Make sure configuration directories exist.
|
||||||
mkdir -p /etc/opendkim;
|
mkdir -p /etc/opendkim;
|
||||||
@@ -46,15 +48,29 @@ fi
|
|||||||
chown -R opendkim:opendkim $STORAGE_ROOT/mail/dkim
|
chown -R opendkim:opendkim $STORAGE_ROOT/mail/dkim
|
||||||
chmod go-rwx $STORAGE_ROOT/mail/dkim
|
chmod go-rwx $STORAGE_ROOT/mail/dkim
|
||||||
|
|
||||||
# Add OpenDKIM as a milter to postfix, which is how it intercepts outgoing
|
tools/editconf.py /etc/opendmarc.conf -s \
|
||||||
# mail to perform the signing (by adding a mail header).
|
"Syslog=true" \
|
||||||
# Be careful. If we add other milters later, it needs to be concatenated on the smtpd_milters line. #NODOC
|
"Socket=inet:8893@[127.0.0.1]"
|
||||||
|
|
||||||
|
# Add OpenDKIM and OpenDMARC as milters to postfix, which is how OpenDKIM
|
||||||
|
# intercepts outgoing mail to perform the signing (by adding a mail header)
|
||||||
|
# and how they both intercept incoming mail to add Authentication-Results
|
||||||
|
# headers. The order possibly/probably matters: OpenDMARC relies on the
|
||||||
|
# OpenDKIM Authentication-Results header already being present.
|
||||||
|
#
|
||||||
|
# Be careful. If we add other milters later, this needs to be concatenated
|
||||||
|
# on the smtpd_milters line.
|
||||||
|
#
|
||||||
|
# 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 \
|
tools/editconf.py /etc/postfix/main.cf \
|
||||||
smtpd_milters=inet:127.0.0.1:8891 \
|
"smtpd_milters=inet:127.0.0.1:8891 inet:127.0.0.1:8893"\
|
||||||
non_smtpd_milters=\$smtpd_milters \
|
non_smtpd_milters=\$smtpd_milters \
|
||||||
milter_default_action=accept
|
milter_default_action=accept
|
||||||
|
|
||||||
# Restart services.
|
# Restart services.
|
||||||
restart_service opendkim
|
restart_service opendkim
|
||||||
|
restart_service opendmarc
|
||||||
restart_service postfix
|
restart_service postfix
|
||||||
|
|
||||||
|
|||||||
@@ -51,6 +51,11 @@ mkdir -p "$STORAGE_ROOT/dns/dnssec";
|
|||||||
# Requires `RSASHA256`
|
# Requires `RSASHA256`
|
||||||
#
|
#
|
||||||
# * .email
|
# * .email
|
||||||
|
# * .guide
|
||||||
|
#
|
||||||
|
# Supports `RSASHA256` (and defaulting to this)
|
||||||
|
#
|
||||||
|
# * .fund
|
||||||
|
|
||||||
FIRST=1 #NODOC
|
FIRST=1 #NODOC
|
||||||
for algo in RSASHA1-NSEC3-SHA1 RSASHA256; do
|
for algo in RSASHA1-NSEC3-SHA1 RSASHA256; do
|
||||||
|
|||||||
@@ -22,6 +22,20 @@ function hide_output {
|
|||||||
rm -f $OUTPUT
|
rm -f $OUTPUT
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function apt_get_quiet {
|
||||||
|
# Run apt-get in a totally non-interactive mode.
|
||||||
|
#
|
||||||
|
# Somehow all of these options are needed to get it to not ask the user
|
||||||
|
# questions about a) whether to proceed (-y), b) package options (noninteractive),
|
||||||
|
# and c) what to do about files changed locally (we don't cause that to happen but
|
||||||
|
# some VM providers muck with their images; -o).
|
||||||
|
#
|
||||||
|
# Although we could pass -qq to apt-get to make output quieter, many packages write to stdout
|
||||||
|
# and stderr things that aren't really important. Use our hide_output function to capture
|
||||||
|
# all of that and only show it if there is a problem (i.e. if apt_get returns a failure exit status).
|
||||||
|
DEBIAN_FRONTEND=noninteractive hide_output apt-get -y -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confnew" "$@"
|
||||||
|
}
|
||||||
|
|
||||||
function apt_install {
|
function apt_install {
|
||||||
# Report any packages already installed.
|
# Report any packages already installed.
|
||||||
PACKAGES=$@
|
PACKAGES=$@
|
||||||
@@ -46,18 +60,10 @@ function apt_install {
|
|||||||
echo installing $TO_INSTALL...
|
echo installing $TO_INSTALL...
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# 'DEBIAN_FRONTEND=noninteractive' is to prevent dbconfig-common from asking you questions.
|
# We still include the whole original package list in the apt-get command in
|
||||||
#
|
|
||||||
# Although we could pass -qq to apt-get to make output quieter, many packages write to stdout
|
|
||||||
# and stderr things that aren't really important. Use our hide_output function to capture
|
|
||||||
# all of that and only show it if there is a problem (i.e. if apt_get returns a failure exit status).
|
|
||||||
#
|
|
||||||
# Also note that we still include the whole original package list in the apt-get command in
|
|
||||||
# case it wants to upgrade anything, I guess? Maybe we can remove it. Doesn't normally make
|
# case it wants to upgrade anything, I guess? Maybe we can remove it. Doesn't normally make
|
||||||
# a difference.
|
# a difference.
|
||||||
DEBIAN_FRONTEND=noninteractive \
|
apt_get_quiet install $PACKAGES
|
||||||
hide_output \
|
|
||||||
apt-get -y install $PACKAGES
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function get_default_hostname {
|
function get_default_hostname {
|
||||||
@@ -173,3 +179,21 @@ function input_menu {
|
|||||||
result=$(dialog --stdout --title "$1" --menu "$2" 0 0 0 $3)
|
result=$(dialog --stdout --title "$1" --menu "$2" 0 0 0 $3)
|
||||||
result_code=$?
|
result_code=$?
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function git_clone {
|
||||||
|
# Clones a git repository, checks out a particular commit or tag,
|
||||||
|
# and moves the repository (or a subdirectory in it) to some path.
|
||||||
|
# We use separate clone and checkout because -b only supports tags
|
||||||
|
# and branches, but we sometimes want to reference a commit hash
|
||||||
|
# directly when the repo doesn't provide a tag.
|
||||||
|
REPO=$1
|
||||||
|
TREEISH=$2
|
||||||
|
SUBDIR=$3
|
||||||
|
TARGETPATH=$4
|
||||||
|
TMPPATH=/tmp/git-clone-$$
|
||||||
|
rm -rf $TMPPATH $TARGETPATH
|
||||||
|
git clone -q $REPO $TMPPATH || exit 1
|
||||||
|
(cd $TMPPATH; git checkout -q $TREEISH;) || exit 1
|
||||||
|
mv $TMPPATH/$SUBDIR $TARGETPATH
|
||||||
|
rm -rf $TMPPATH
|
||||||
|
}
|
||||||
|
|||||||
@@ -26,6 +26,23 @@ apt_install \
|
|||||||
|
|
||||||
# The `dovecot-imapd` and `dovecot-lmtpd` packages automatically enable IMAP and LMTP protocols.
|
# The `dovecot-imapd` and `dovecot-lmtpd` packages automatically enable IMAP and LMTP protocols.
|
||||||
|
|
||||||
|
# Set basic daemon options.
|
||||||
|
|
||||||
|
# The `default_process_limit` is 100, which constrains the total number
|
||||||
|
# of active IMAP connections (at, say, 5 open connections per user that
|
||||||
|
# would be 20 users). Set it to 250 times the number of cores this
|
||||||
|
# machine has, so on a two-core machine that's 500 processes/100 users).
|
||||||
|
tools/editconf.py /etc/dovecot/conf.d/10-master.conf \
|
||||||
|
default_process_limit=$(echo "`nproc` * 250" | bc)
|
||||||
|
|
||||||
|
# The inotify `max_user_instances` default is 128, which constrains
|
||||||
|
# the total number of watched (IMAP IDLE push) folders by open connections.
|
||||||
|
# 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 \
|
||||||
|
fs.inotify.max_user_instances=1024
|
||||||
|
|
||||||
# Set the location where we'll store user mailboxes. '%d' is the domain name and '%n' is the
|
# 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
|
# username part of the user's email address. We'll ensure that no bad domains or email addresses
|
||||||
# are created within the management daemon.
|
# are created within the management daemon.
|
||||||
|
|||||||
@@ -62,6 +62,9 @@ tools/editconf.py /etc/postfix/main.cf \
|
|||||||
|
|
||||||
# Enable the 'submission' port 587 smtpd server and tweak its settings.
|
# Enable the 'submission' port 587 smtpd server and tweak its settings.
|
||||||
#
|
#
|
||||||
|
# * 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.
|
||||||
# * Require the best ciphers for incoming connections per http://baldric.net/2013/12/07/tls-ciphers-in-postfix-and-dovecot/.
|
# * 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).
|
# By putting this setting here we leave opportunistic TLS on incoming mail at default cipher settings (any cipher is better than none).
|
||||||
# * Give it a different name in syslog to distinguish it from the port 25 smtpd server.
|
# * Give it a different name in syslog to distinguish it from the port 25 smtpd server.
|
||||||
@@ -71,6 +74,7 @@ tools/editconf.py /etc/postfix/main.cf \
|
|||||||
tools/editconf.py /etc/postfix/master.cf -s -w \
|
tools/editconf.py /etc/postfix/master.cf -s -w \
|
||||||
"submission=inet n - - - - smtpd
|
"submission=inet n - - - - smtpd
|
||||||
-o syslog_name=postfix/submission
|
-o syslog_name=postfix/submission
|
||||||
|
-o smtpd_milters=inet:127.0.0.1:8891
|
||||||
-o smtpd_tls_ciphers=high -o smtpd_tls_protocols=!SSLv2,!SSLv3
|
-o smtpd_tls_ciphers=high -o smtpd_tls_protocols=!SSLv2,!SSLv3
|
||||||
-o cleanup_service_name=authclean" \
|
-o cleanup_service_name=authclean" \
|
||||||
"authclean=unix n - - - 0 cleanup
|
"authclean=unix n - - - 0 cleanup
|
||||||
@@ -160,7 +164,13 @@ tools/editconf.py /etc/postfix/main.cf \
|
|||||||
smtpd_sender_restrictions="reject_non_fqdn_sender,reject_unknown_sender_domain,reject_rhsbl_sender dbl.spamhaus.org" \
|
smtpd_sender_restrictions="reject_non_fqdn_sender,reject_unknown_sender_domain,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=permit_sasl_authenticated,permit_mynetworks,"reject_rbl_client zen.spamhaus.org",reject_unlisted_recipient,"check_policy_service inet:127.0.0.1:10023"
|
||||||
|
|
||||||
|
# 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).
|
||||||
|
tools/editconf.py /etc/default/postgrey \
|
||||||
|
POSTGREY_OPTS=\"--inet=127.0.0.1:10023\"
|
||||||
|
|
||||||
# Increase the message size limit from 10MB to 128MB.
|
# 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 \
|
tools/editconf.py /etc/postfix/main.cf \
|
||||||
message_size_limit=134217728
|
message_size_limit=134217728
|
||||||
|
|
||||||
|
|||||||
@@ -30,5 +30,19 @@ $(pwd)/management/backup.py
|
|||||||
EOF
|
EOF
|
||||||
chmod +x /etc/cron.daily/mailinabox-backup
|
chmod +x /etc/cron.daily/mailinabox-backup
|
||||||
|
|
||||||
# Start it.
|
# Perform daily status checks. Compare each day to the previous
|
||||||
|
# for changes and mail the changes to the administrator.
|
||||||
|
cat > /etc/cron.daily/mailinabox-statuschecks << EOF;
|
||||||
|
#!/bin/bash
|
||||||
|
# Mail-in-a-Box --- Do not edit / will be overwritten on update.
|
||||||
|
# Run status checks.
|
||||||
|
$(pwd)/management/status_checks.py --show-changes --smtp
|
||||||
|
EOF
|
||||||
|
chmod +x /etc/cron.daily/mailinabox-statuschecks
|
||||||
|
|
||||||
|
|
||||||
|
# Start it. Remove the api key file first so that start.sh
|
||||||
|
# can wait for it to be created to know that the management
|
||||||
|
# server is ready.
|
||||||
|
rm -f /var/lib/mailinabox/api.key
|
||||||
restart_service mailinabox
|
restart_service mailinabox
|
||||||
|
|||||||
@@ -84,13 +84,22 @@ def run_migrations():
|
|||||||
env = load_environment()
|
env = load_environment()
|
||||||
|
|
||||||
migration_id_file = os.path.join(env['STORAGE_ROOT'], 'mailinabox.version')
|
migration_id_file = os.path.join(env['STORAGE_ROOT'], 'mailinabox.version')
|
||||||
|
migration_id = None
|
||||||
if os.path.exists(migration_id_file):
|
if os.path.exists(migration_id_file):
|
||||||
with open(migration_id_file) as f:
|
with open(migration_id_file) as f:
|
||||||
ourver = int(f.read().strip())
|
migration_id = f.read().strip();
|
||||||
else:
|
|
||||||
|
if migration_id is None:
|
||||||
# Load the legacy location of the migration ID. We'll drop support
|
# Load the legacy location of the migration ID. We'll drop support
|
||||||
# for this eventually.
|
# for this eventually.
|
||||||
ourver = int(env.get("MIGRATIONID", "0"))
|
migration_id = env.get("MIGRATIONID")
|
||||||
|
|
||||||
|
if migration_id is None:
|
||||||
|
print()
|
||||||
|
print("%s file doesn't exists. Skipping migration..." % (migration_id_file,))
|
||||||
|
return
|
||||||
|
|
||||||
|
ourver = int(migration_id)
|
||||||
|
|
||||||
while True:
|
while True:
|
||||||
next_ver = (ourver + 1)
|
next_ver = (ourver + 1)
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Install the 'host', 'sed', and and 'nc' tools. This script is run before
|
# Install the 'host', 'sed', and and 'nc' tools. This script is run before
|
||||||
# the rest of the system setup so we may not yet have things installed.
|
# the rest of the system setup so we may not yet have things installed.
|
||||||
hide_output apt-get -y install bind9-host sed netcat-openbsd
|
apt_get_quiet install bind9-host sed netcat-openbsd
|
||||||
|
|
||||||
# Stop if the PRIMARY_HOSTNAME is listed in the Spamhaus Domain Block List.
|
# Stop if the PRIMARY_HOSTNAME is listed in the Spamhaus Domain Block List.
|
||||||
# The user might have chosen a name that was previously in use by a spammer
|
# The user might have chosen a name that was previously in use by a spammer
|
||||||
|
|||||||
@@ -15,18 +15,49 @@ apt_install \
|
|||||||
apt-get purge -qq -y owncloud*
|
apt-get purge -qq -y owncloud*
|
||||||
|
|
||||||
# Install ownCloud from source of this version:
|
# Install ownCloud from source of this version:
|
||||||
owncloud_ver=7.0.2
|
owncloud_ver=8.0.2
|
||||||
|
|
||||||
# Check if ownCloud dir exist, and check if version matches owncloud_ver (if either doesn't - install/upgrade)
|
# Check if ownCloud dir exist, and check if version matches owncloud_ver (if either doesn't - install/upgrade)
|
||||||
if [ ! -d /usr/local/lib/owncloud/ ] \
|
if [ ! -d /usr/local/lib/owncloud/ ] \
|
||||||
|| ! grep -q $owncloud_ver /usr/local/lib/owncloud/version.php; then
|
|| ! grep -q $owncloud_ver /usr/local/lib/owncloud/version.php; then
|
||||||
|
|
||||||
echo installing ownCloud...
|
# Clear out the existing ownCloud.
|
||||||
|
rm -f /tmp/owncloud-config.php
|
||||||
|
if [ ! -d /usr/local/lib/owncloud/ ]; then
|
||||||
|
echo installing ownCloud...
|
||||||
|
else
|
||||||
|
echo "upgrading ownCloud to $owncloud_ver (backing up existing ownCloud directory to /tmp/owncloud-backup-$$)..."
|
||||||
|
cp /usr/local/lib/owncloud/config/config.php /tmp/owncloud-config.php
|
||||||
|
mv /usr/local/lib/owncloud /tmp/owncloud-backup-$$
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Download and extract ownCloud.
|
||||||
rm -f /tmp/owncloud.zip
|
rm -f /tmp/owncloud.zip
|
||||||
wget -qO /tmp/owncloud.zip https://download.owncloud.org/community/owncloud-$owncloud_ver.zip
|
wget -qO /tmp/owncloud.zip https://download.owncloud.org/community/owncloud-$owncloud_ver.zip
|
||||||
unzip -u -o -q /tmp/owncloud.zip -d /usr/local/lib #either extracts new or replaces current files
|
unzip -u -o -q /tmp/owncloud.zip -d /usr/local/lib #either extracts new or replaces current files
|
||||||
hide_output php /usr/local/lib/owncloud/occ upgrade #if OC is up-to-date it wont matter
|
|
||||||
rm -f /tmp/owncloud.zip
|
rm -f /tmp/owncloud.zip
|
||||||
|
|
||||||
|
# The two apps we actually want are not in ownCloud core. Clone them from
|
||||||
|
# their github repositories.
|
||||||
|
mkdir -p /usr/local/lib/owncloud/apps
|
||||||
|
git_clone https://github.com/owncloud/contacts v$owncloud_ver '' /usr/local/lib/owncloud/apps/contacts
|
||||||
|
git_clone https://github.com/owncloud/calendar v$owncloud_ver '' /usr/local/lib/owncloud/apps/calendar
|
||||||
|
|
||||||
|
# Fix weird permissions.
|
||||||
|
chmod 750 /usr/local/lib/owncloud/{apps,config}
|
||||||
|
|
||||||
|
# Restore configuration file if we're doing an upgrade.
|
||||||
|
if [ -f /tmp/owncloud-config.php ]; then
|
||||||
|
mv /tmp/owncloud-config.php /usr/local/lib/owncloud/config/config.php
|
||||||
|
fi
|
||||||
|
|
||||||
|
# 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
|
||||||
|
|
||||||
|
# Run the upgrade script (if ownCloud is already up-to-date it wont matter).
|
||||||
|
hide_output sudo -u www-data php /usr/local/lib/owncloud/occ upgrade
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# ### Configuring ownCloud
|
# ### Configuring ownCloud
|
||||||
@@ -105,9 +136,12 @@ fi
|
|||||||
|
|
||||||
# Enable/disable apps. Note that this must be done after the ownCloud setup.
|
# Enable/disable apps. Note that this must be done after the ownCloud setup.
|
||||||
# The firstrunwizard gave Josh all sorts of problems, so disabling that.
|
# The firstrunwizard gave Josh all sorts of problems, so disabling that.
|
||||||
# user_external is what allows ownCloud to use IMAP for login.
|
# user_external is what allows ownCloud to use IMAP for login. The contacts
|
||||||
hide_output php /usr/local/lib/owncloud/console.php app:disable firstrunwizard
|
# and calendar apps are the extensions we really care about here.
|
||||||
hide_output 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: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
|
||||||
|
|
||||||
# Set PHP FPM values to support large file uploads
|
# Set PHP FPM values to support large file uploads
|
||||||
# (semicolon is the comment character in this file, hashes produce deprecation warnings)
|
# (semicolon is the comment character in this file, hashes produce deprecation warnings)
|
||||||
|
|||||||
@@ -17,13 +17,19 @@ if [ "`lsb_release -d | sed 's/.*:\s*//' | sed 's/14\.04\.[0-9]/14.04/' `" != "U
|
|||||||
exit
|
exit
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Check that we have enough memory. Skip the check if we appear to be
|
# Check that we have enough memory.
|
||||||
# running inside of Vagrant, because that's really just for testing.
|
#
|
||||||
|
# /proc/meminfo reports free memory in kibibytes. Our baseline will be 768 KB,
|
||||||
|
# which is 750000 kibibytes.
|
||||||
|
#
|
||||||
|
# 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}')
|
TOTAL_PHYSICAL_MEM=$(head -n 1 /proc/meminfo | awk '{print $2}')
|
||||||
if [ $TOTAL_PHYSICAL_MEM -lt 786432 ]; then
|
if [ $TOTAL_PHYSICAL_MEM -lt 750000 ]; then
|
||||||
if [ ! -d /vagrant ]; then
|
if [ ! -d /vagrant ]; then
|
||||||
echo "Your Mail-in-a-Box needs more than $TOTAL_PHYSICAL_MEM MB RAM."
|
TOTAL_PHYSICAL_MEM=$(expr \( \( $TOTAL_PHYSICAL_MEM \* 1024 \) / 1000 \) / 1000)
|
||||||
|
echo "Your Mail-in-a-Box needs more memory (RAM) to function properly."
|
||||||
echo "Please provision a machine with at least 768 MB, 1 GB recommended."
|
echo "Please provision a machine with at least 768 MB, 1 GB recommended."
|
||||||
|
echo "This machine has $TOTAL_PHYSICAL_MEM MB memory."
|
||||||
exit
|
exit
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ if [ -z "$NONINTERACTIVE" ]; then
|
|||||||
# e.g. if we piped a bootstrapping install script to bash to get started. In that
|
# e.g. if we piped a bootstrapping install script to bash to get started. In that
|
||||||
# case, the nifty '[ -t 0 ]' test won't work. But with Vagrant we must suppress so we
|
# case, the nifty '[ -t 0 ]' test won't work. But with Vagrant we must suppress so we
|
||||||
# use a shell flag instead. Really supress any output from installing dialog.
|
# use a shell flag instead. Really supress any output from installing dialog.
|
||||||
hide_output apt-get -y install dialog
|
apt_get_quiet install dialog
|
||||||
message_box "Mail-in-a-Box Installation" \
|
message_box "Mail-in-a-Box Installation" \
|
||||||
"Hello and thanks for deploying a Mail-in-a-Box!
|
"Hello and thanks for deploying a Mail-in-a-Box!
|
||||||
\n\nI'm going to ask you a few questions.
|
\n\nI'm going to ask you a few questions.
|
||||||
|
|||||||
@@ -30,6 +30,20 @@ hide_output pyzor discover
|
|||||||
# We've already configured Dovecot to listen on this port.
|
# We've already configured Dovecot to listen on this port.
|
||||||
tools/editconf.py /etc/default/spampd DESTPORT=10026
|
tools/editconf.py /etc/default/spampd DESTPORT=10026
|
||||||
|
|
||||||
|
# Spamassassin normally wraps spam as an attachment inside a fresh
|
||||||
|
# email with a report about the message. This also protects the user
|
||||||
|
# from accidentally openening a message with embedded malware.
|
||||||
|
#
|
||||||
|
# It's nice to see what rules caused the message to be marked as spam,
|
||||||
|
# but it's also annoying to get to the original message when it is an
|
||||||
|
# attachment, modern mail clients are safer now and don't load remote
|
||||||
|
# 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 \
|
||||||
|
report_safe=0
|
||||||
|
|
||||||
# Bayesean learning
|
# Bayesean learning
|
||||||
# -----------------
|
# -----------------
|
||||||
#
|
#
|
||||||
|
|||||||
@@ -45,7 +45,7 @@ fi
|
|||||||
|
|
||||||
# For nginx and postfix, pre-generate some Diffie-Hellman cipher bits which is
|
# For nginx and postfix, pre-generate some Diffie-Hellman cipher bits which is
|
||||||
# used when a Diffie-Hellman cipher is selected during TLS negotiation. Diffie-Hellman
|
# used when a Diffie-Hellman cipher is selected during TLS negotiation. Diffie-Hellman
|
||||||
# provides Perfect Forward Security. openssl's default is 1024 bits, but we'll
|
# provides Perfect Forward Secrecy. openssl's default is 1024 bits, but we'll
|
||||||
# create 2048.
|
# create 2048.
|
||||||
if [ ! -f $STORAGE_ROOT/ssl/dh2048.pem ]; then
|
if [ ! -f $STORAGE_ROOT/ssl/dh2048.pem ]; then
|
||||||
openssl dhparam -out $STORAGE_ROOT/ssl/dh2048.pem 2048
|
openssl dhparam -out $STORAGE_ROOT/ssl/dh2048.pem 2048
|
||||||
|
|||||||
@@ -77,7 +77,7 @@ fi
|
|||||||
if [ "$PRIVATE_IPV6" != "$PUBLIC_IPV6" ]; then
|
if [ "$PRIVATE_IPV6" != "$PUBLIC_IPV6" ]; then
|
||||||
echo "Private IPv6 Address: $PRIVATE_IPV6"
|
echo "Private IPv6 Address: $PRIVATE_IPV6"
|
||||||
fi
|
fi
|
||||||
if [ -f /usr/bin/git ]; then
|
if [ -f .git ]; then
|
||||||
echo "Mail-in-a-Box Version: " $(git describe)
|
echo "Mail-in-a-Box Version: " $(git describe)
|
||||||
fi
|
fi
|
||||||
echo
|
echo
|
||||||
@@ -87,17 +87,37 @@ if [ -z "$SKIP_NETWORK_CHECKS" ]; then
|
|||||||
. setup/network-checks.sh
|
. setup/network-checks.sh
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# For the first time (if the config file (/etc/mailinabox.conf) not exists):
|
||||||
# Create the user named "user-data" and store all persistent user
|
# Create the user named "user-data" and store all persistent user
|
||||||
# data (mailboxes, etc.) in that user's home directory.
|
# data (mailboxes, etc.) in that user's home directory.
|
||||||
|
#
|
||||||
|
# If the config file exists:
|
||||||
|
# Apply the existing configuration options for STORAGE_USER/ROOT
|
||||||
|
if [ -z "$STORAGE_USER" ]; then
|
||||||
|
STORAGE_USER=$([[ -z "$DEFAULT_STORAGE_USER" ]] && echo "user-data" || echo "$DEFAULT_STORAGE_USER")
|
||||||
|
fi
|
||||||
|
|
||||||
if [ -z "$STORAGE_ROOT" ]; then
|
if [ -z "$STORAGE_ROOT" ]; then
|
||||||
STORAGE_USER=user-data
|
STORAGE_ROOT=$([[ -z "$DEFAULT_STORAGE_ROOT" ]] && echo "/home/$STORAGE_USER" || echo "$DEFAULT_STORAGE_ROOT")
|
||||||
if [ ! -d /home/$STORAGE_USER ]; then useradd -m $STORAGE_USER; fi
|
fi
|
||||||
STORAGE_ROOT=/home/$STORAGE_USER
|
|
||||||
|
# Create the STORAGE_USER if it not exists
|
||||||
|
if ! id -u $STORAGE_USER >/dev/null 2>&1; then
|
||||||
|
useradd -m $STORAGE_USER
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Create the STORAGE_ROOT if it not exists
|
||||||
|
if [ ! -d $STORAGE_ROOT ]; then
|
||||||
mkdir -p $STORAGE_ROOT
|
mkdir -p $STORAGE_ROOT
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Create mailinabox.version file if not exists
|
||||||
|
if [ ! -f $STORAGE_ROOT/mailinabox.version ]; then
|
||||||
echo $(setup/migrate.py --current) > $STORAGE_ROOT/mailinabox.version
|
echo $(setup/migrate.py --current) > $STORAGE_ROOT/mailinabox.version
|
||||||
chown $STORAGE_USER.$STORAGE_USER $STORAGE_ROOT/mailinabox.version
|
chown $STORAGE_USER.$STORAGE_USER $STORAGE_ROOT/mailinabox.version
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
||||||
# Save the global options in /etc/mailinabox.conf so that standalone
|
# 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.
|
||||||
cat > /etc/mailinabox.conf << EOF;
|
cat > /etc/mailinabox.conf << EOF;
|
||||||
@@ -126,10 +146,13 @@ source setup/owncloud.sh
|
|||||||
source setup/zpush.sh
|
source setup/zpush.sh
|
||||||
source setup/management.sh
|
source setup/management.sh
|
||||||
|
|
||||||
# Write the DNS and nginx configuration files.
|
# Ping the management daemon to write the DNS and nginx configuration files.
|
||||||
sleep 5 # wait for the daemon to start
|
while [ ! -f /var/lib/mailinabox/api.key ]; do
|
||||||
curl -s -d POSTDATA --user $(</var/lib/mailinabox/api.key): http://127.0.0.1:10222/dns/update
|
echo Waiting for the Mail-in-a-Box management daemon to start...
|
||||||
curl -s -d POSTDATA --user $(</var/lib/mailinabox/api.key): http://127.0.0.1:10222/web/update
|
sleep 2
|
||||||
|
done
|
||||||
|
tools/dns_update
|
||||||
|
tools/web_update
|
||||||
|
|
||||||
# If there aren't any mail users yet, create one.
|
# If there aren't any mail users yet, create one.
|
||||||
source setup/firstuser.sh
|
source setup/firstuser.sh
|
||||||
@@ -160,4 +183,3 @@ openssl x509 -in $STORAGE_ROOT/ssl/ssl_certificate.pem -noout -fingerprint \
|
|||||||
echo
|
echo
|
||||||
echo Then you can confirm the security exception and continue.
|
echo Then you can confirm the security exception and continue.
|
||||||
echo
|
echo
|
||||||
|
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ source setup/functions.sh # load our functions
|
|||||||
|
|
||||||
echo Updating system packages...
|
echo Updating system packages...
|
||||||
hide_output apt-get update
|
hide_output apt-get update
|
||||||
hide_output apt-get -y upgrade
|
apt_get_quiet upgrade
|
||||||
|
|
||||||
# Install basic utilities.
|
# Install basic utilities.
|
||||||
#
|
#
|
||||||
@@ -17,12 +17,17 @@ hide_output apt-get -y upgrade
|
|||||||
# when generating random numbers for private keys (e.g. during
|
# when generating random numbers for private keys (e.g. during
|
||||||
# ldns-keygen).
|
# ldns-keygen).
|
||||||
# * unattended-upgrades: Apt tool to install security updates automatically.
|
# * unattended-upgrades: Apt tool to install security updates automatically.
|
||||||
|
# * cron: Runs background processes periodically.
|
||||||
# * ntp: keeps the system time correct
|
# * ntp: keeps the system time correct
|
||||||
# * fail2ban: scans log files for repeated failed login attempts and blocks the remote IP at the firewall
|
# * fail2ban: scans log files for repeated failed login attempts and blocks the remote IP at the firewall
|
||||||
|
# * git: we install some things directly from github
|
||||||
|
# * sudo: allows privileged users to execute commands as root without being root
|
||||||
|
# * coreutils: includes `nproc` tool to report number of processors
|
||||||
|
# * bc: allows us to do math to compute sane defaults
|
||||||
|
|
||||||
apt_install python3 python3-dev python3-pip \
|
apt_install python3 python3-dev python3-pip \
|
||||||
wget curl \
|
wget curl git sudo coreutils bc \
|
||||||
haveged unattended-upgrades ntp fail2ban
|
haveged unattended-upgrades cron ntp fail2ban
|
||||||
|
|
||||||
# Allow apt to install system updates automatically every day.
|
# Allow apt to install system updates automatically every day.
|
||||||
|
|
||||||
@@ -102,3 +107,11 @@ fi
|
|||||||
|
|
||||||
restart_service bind9
|
restart_service bind9
|
||||||
restart_service resolvconf
|
restart_service resolvconf
|
||||||
|
|
||||||
|
# ### Fail2Ban Service
|
||||||
|
|
||||||
|
# Configure the Fail2Ban installation to prevent dumb bruce-force attacks against dovecot, postfix and ssh
|
||||||
|
cp conf/fail2ban/jail.local /etc/fail2ban/jail.local
|
||||||
|
cp conf/fail2ban/dovecotimap.conf /etc/fail2ban/filter.d/dovecotimap.conf
|
||||||
|
|
||||||
|
restart_service fail2ban
|
||||||
|
|||||||
23
setup/web.sh
23
setup/web.sh
@@ -40,6 +40,29 @@ tools/editconf.py /etc/php5/fpm/pool.d/www.conf -c ';' \
|
|||||||
# since it depends on what domains we're serving, which we don't know
|
# since it depends on what domains we're serving, which we don't know
|
||||||
# until mail accounts have been created.
|
# until mail accounts have been created.
|
||||||
|
|
||||||
|
# Create the iOS/OS X Mobile Configuration file which is exposed via the
|
||||||
|
# nginx configuration at /mailinabox-mobileconfig.
|
||||||
|
mkdir -p /var/lib/mailinabox
|
||||||
|
chmod a+rx /var/lib/mailinabox
|
||||||
|
cat conf/ios-profile.xml \
|
||||||
|
| sed "s/PRIMARY_HOSTNAME/$PRIMARY_HOSTNAME/" \
|
||||||
|
| sed "s/UUID1/$(cat /proc/sys/kernel/random/uuid)/" \
|
||||||
|
| sed "s/UUID2/$(cat /proc/sys/kernel/random/uuid)/" \
|
||||||
|
| sed "s/UUID3/$(cat /proc/sys/kernel/random/uuid)/" \
|
||||||
|
| sed "s/UUID4/$(cat /proc/sys/kernel/random/uuid)/" \
|
||||||
|
> /var/lib/mailinabox/mobileconfig.xml
|
||||||
|
chmod a+r /var/lib/mailinabox/mobileconfig.xml
|
||||||
|
|
||||||
|
# Create the Mozilla Auto-configuration file which is exposed via the
|
||||||
|
# nginx configuration at /.well-known/autoconfig/mail/config-v1.1.xml.
|
||||||
|
# The format of the file is documented at:
|
||||||
|
# https://wiki.mozilla.org/Thunderbird:Autoconfiguration:ConfigFileFormat
|
||||||
|
# and https://developer.mozilla.org/en-US/docs/Mozilla/Thunderbird/Autoconfiguration/FileFormat/HowTo.
|
||||||
|
cat conf/mozilla-autoconfig.xml \
|
||||||
|
| sed "s/PRIMARY_HOSTNAME/$PRIMARY_HOSTNAME/" \
|
||||||
|
> /var/lib/mailinabox/mozilla-autoconfig.xml
|
||||||
|
chmod a+r /var/lib/mailinabox/mozilla-autoconfig.xml
|
||||||
|
|
||||||
# make a default homepage
|
# make a default homepage
|
||||||
if [ -d $STORAGE_ROOT/www/static ]; then mv $STORAGE_ROOT/www/static $STORAGE_ROOT/www/default; fi # migration #NODOC
|
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
|
mkdir -p $STORAGE_ROOT/www/default
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
#!/bin/bash
|
||||||
# Webmail with Roundcube
|
# Webmail with Roundcube
|
||||||
# ----------------------
|
# ----------------------
|
||||||
|
|
||||||
@@ -29,23 +30,33 @@ apt_install \
|
|||||||
apt-get purge -qq -y roundcube* #NODOC
|
apt-get purge -qq -y roundcube* #NODOC
|
||||||
|
|
||||||
# Install Roundcube from source if it is not already present or if it is out of date.
|
# Install Roundcube from source if it is not already present or if it is out of date.
|
||||||
VERSION=1.0.2
|
# Combine the Roundcube version number with the commit hash of vacation_sieve to track
|
||||||
|
# whether we have the latest version.
|
||||||
|
VERSION=1.1.0
|
||||||
|
VACATION_SIEVE_VERSION=06a20e9d44db62259ae41fd8451f3c937d3ab4f3
|
||||||
needs_update=0 #NODOC
|
needs_update=0 #NODOC
|
||||||
if [ ! -f /usr/local/lib/roundcubemail/version ]; then
|
if [ ! -f /usr/local/lib/roundcubemail/version ]; then
|
||||||
# not installed yet #NODOC
|
# not installed yet #NODOC
|
||||||
needs_update=1 #NODOC
|
needs_update=1 #NODOC
|
||||||
elif [[ $VERSION != `cat /usr/local/lib/roundcubemail/version` ]]; then
|
elif [[ "$VERSION:$VACATION_SIEVE_VERSION" != `cat /usr/local/lib/roundcubemail/version` ]]; then
|
||||||
# checks if the version is what we want
|
# checks if the version is what we want
|
||||||
needs_update=1 #NODOC
|
needs_update=1 #NODOC
|
||||||
fi
|
fi
|
||||||
if [ $needs_update == 1 ]; then
|
if [ $needs_update == 1 ]; then
|
||||||
echo installing roudcube webmail $VERSION...
|
# install roundcube
|
||||||
|
echo installing Roundcube webmail $VERSION...
|
||||||
rm -f /tmp/roundcube.tgz
|
rm -f /tmp/roundcube.tgz
|
||||||
wget -qO /tmp/roundcube.tgz http://downloads.sourceforge.net/project/roundcubemail/roundcubemail/$VERSION/roundcubemail-$VERSION.tar.gz
|
wget -qO /tmp/roundcube.tgz http://downloads.sourceforge.net/project/roundcubemail/roundcubemail/$VERSION/roundcubemail-$VERSION.tar.gz
|
||||||
tar -C /usr/local/lib -zxf /tmp/roundcube.tgz
|
tar -C /usr/local/lib -zxf /tmp/roundcube.tgz
|
||||||
|
rm -rf /usr/local/lib/roundcubemail
|
||||||
mv /usr/local/lib/roundcubemail-$VERSION/ /usr/local/lib/roundcubemail
|
mv /usr/local/lib/roundcubemail-$VERSION/ /usr/local/lib/roundcubemail
|
||||||
rm -f /tmp/roundcube.tgz
|
rm -f /tmp/roundcube.tgz
|
||||||
echo $VERSION > /usr/local/lib/roundcubemail/version
|
|
||||||
|
# install roundcube autoreply/vacation plugin
|
||||||
|
git_clone https://github.com/arodier/Roundcube-Plugins.git $VACATION_SIEVE_VERSION plugins/vacation_sieve /usr/local/lib/roundcubemail/plugins/vacation_sieve
|
||||||
|
|
||||||
|
# record the version we've installed
|
||||||
|
echo $VERSION:$VACATION_SIEVE_VERSION > /usr/local/lib/roundcubemail/version
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# ### Configuring Roundcube
|
# ### Configuring Roundcube
|
||||||
@@ -77,7 +88,7 @@ cat > /usr/local/lib/roundcubemail/config/config.inc.php <<EOF;
|
|||||||
\$config['support_url'] = 'https://mailinabox.email/';
|
\$config['support_url'] = 'https://mailinabox.email/';
|
||||||
\$config['product_name'] = 'Mail-in-a-Box/Roundcube Webmail';
|
\$config['product_name'] = 'Mail-in-a-Box/Roundcube Webmail';
|
||||||
\$config['des_key'] = '$SECRET_KEY';
|
\$config['des_key'] = '$SECRET_KEY';
|
||||||
\$config['plugins'] = array('archive', 'zipdownload', 'password', 'managesieve');
|
\$config['plugins'] = array('archive', 'zipdownload', 'password', 'managesieve', 'jqueryui', 'vacation_sieve');
|
||||||
\$config['skin'] = 'classic';
|
\$config['skin'] = 'classic';
|
||||||
\$config['login_autocomplete'] = 2;
|
\$config['login_autocomplete'] = 2;
|
||||||
\$config['password_charset'] = 'UTF-8';
|
\$config['password_charset'] = 'UTF-8';
|
||||||
@@ -85,6 +96,26 @@ cat > /usr/local/lib/roundcubemail/config/config.inc.php <<EOF;
|
|||||||
?>
|
?>
|
||||||
EOF
|
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' => 'localhost',
|
||||||
|
'port' => '4190',
|
||||||
|
'usetls' => false,
|
||||||
|
'path' => 'vacation',
|
||||||
|
)
|
||||||
|
);
|
||||||
|
EOF
|
||||||
|
|
||||||
# Create writable directories.
|
# Create writable directories.
|
||||||
mkdir -p /var/log/roundcubemail /tmp/roundcubemail $STORAGE_ROOT/mail/roundcube
|
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
|
chown -R www-data.www-data /var/log/roundcubemail /tmp/roundcubemail $STORAGE_ROOT/mail/roundcube
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
# Z-Push: The Microsoft Exchange protocol server
|
# Z-Push: The Microsoft Exchange protocol server
|
||||||
# ----------------------------------------------
|
# ----------------------------------------------
|
||||||
#
|
#
|
||||||
# Mostly for use on iOS which doesn't support IMAP.
|
# Mostly for use on iOS which doesn't support IMAP IDLE.
|
||||||
#
|
#
|
||||||
# Although Ubuntu ships Z-Push (as d-push) it has a dependency on Apache
|
# Although Ubuntu ships Z-Push (as d-push) it has a dependency on Apache
|
||||||
# so we won't install it that way.
|
# so we won't install it that way.
|
||||||
@@ -30,17 +30,11 @@ elif [[ $TARGETHASH != `cat /usr/local/lib/z-push/version` ]]; then
|
|||||||
needs_update=1 #NODOC
|
needs_update=1 #NODOC
|
||||||
fi
|
fi
|
||||||
if [ $needs_update == 1 ]; then
|
if [ $needs_update == 1 ]; then
|
||||||
rm -rf /usr/local/lib/z-push
|
|
||||||
rm -f /tmp/zpush-repo
|
|
||||||
echo installing z-push \(fmbiete fork\)...
|
echo installing z-push \(fmbiete fork\)...
|
||||||
git clone -q https://github.com/fmbiete/Z-Push-contrib /tmp/zpush-repo
|
git_clone https://github.com/fmbiete/Z-Push-contrib $TARGETHASH '' /usr/local/lib/z-push
|
||||||
(cd /tmp/zpush-repo/; git checkout -q $TARGETHASH;)
|
|
||||||
rm -rf /tmp/zpush-repo/.git
|
|
||||||
mv /tmp/zpush-repo /usr/local/lib/z-push
|
|
||||||
rm -f /usr/sbin/z-push-{admin,top}
|
rm -f /usr/sbin/z-push-{admin,top}
|
||||||
ln -s /usr/local/lib/z-push/z-push-admin.php /usr/sbin/z-push-admin
|
ln -s /usr/local/lib/z-push/z-push-admin.php /usr/sbin/z-push-admin
|
||||||
ln -s /usr/local/lib/z-push/z-push-top.php /usr/sbin/z-push-top
|
ln -s /usr/local/lib/z-push/z-push-top.php /usr/sbin/z-push-top
|
||||||
rm -f /tmp/zpush-repo
|
|
||||||
echo $TARGETHASH > /usr/local/lib/z-push/version
|
echo $TARGETHASH > /usr/local/lib/z-push/version
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|||||||
@@ -28,13 +28,17 @@ def mgmt(cmd, data=None, is_json=False):
|
|||||||
return resp
|
return resp
|
||||||
|
|
||||||
def read_password():
|
def read_password():
|
||||||
first = getpass.getpass('password: ')
|
while True:
|
||||||
second = getpass.getpass(' (again): ')
|
first = getpass.getpass('password: ')
|
||||||
while first != second:
|
if len(first) < 4:
|
||||||
print('Passwords not the same. Try again.')
|
print('Passwords must be at least four characters.')
|
||||||
first = getpass.getpass('password: ')
|
continue
|
||||||
second = getpass.getpass(' (again): ')
|
second = getpass.getpass(' (again): ')
|
||||||
return first
|
if first != second:
|
||||||
|
print('Passwords not the same. Try again.')
|
||||||
|
continue
|
||||||
|
break
|
||||||
|
return first
|
||||||
|
|
||||||
def setup_key_auth(mgmt_uri):
|
def setup_key_auth(mgmt_uri):
|
||||||
key = open('/var/lib/mailinabox/api.key').read().strip()
|
key = open('/var/lib/mailinabox/api.key').read().strip()
|
||||||
|
|||||||
56
tools/parse-nginx-log-bootstrap-accesses.py
Executable file
56
tools/parse-nginx-log-bootstrap-accesses.py
Executable file
@@ -0,0 +1,56 @@
|
|||||||
|
#!/usr/bin/python3
|
||||||
|
#
|
||||||
|
# This is a tool Josh uses on his box serving mailinabox.email to parse the nginx
|
||||||
|
# access log to see how many people are installing Mail-in-a-Box each day, by
|
||||||
|
# looking at accesses to the bootstrap.sh script.
|
||||||
|
|
||||||
|
import re, glob, gzip, os.path, json
|
||||||
|
import dateutil.parser
|
||||||
|
|
||||||
|
outfn = "/home/user-data/www/mailinabox.email/install-stats.json"
|
||||||
|
|
||||||
|
# Make a unique list of (date, ip address) pairs so we don't double-count
|
||||||
|
# accesses that are for the same install.
|
||||||
|
accesses = set()
|
||||||
|
|
||||||
|
# Scan the current and rotated access logs.
|
||||||
|
for fn in glob.glob("/var/log/nginx/access.log*"):
|
||||||
|
# Gunzip if necessary.
|
||||||
|
if fn.endswith(".gz"):
|
||||||
|
f = gzip.open(fn)
|
||||||
|
else:
|
||||||
|
f = open(fn, "rb")
|
||||||
|
|
||||||
|
# Loop through the lines in the access log.
|
||||||
|
with f:
|
||||||
|
for line in f:
|
||||||
|
# Find lines that are GETs on /bootstrap.sh by either curl or wget.
|
||||||
|
m = re.match(rb"(?P<ip>\S+) - - \[(?P<date>.*?)\] \"GET /bootstrap.sh HTTP/.*\" 200 \d+ .* \"(?:curl|wget)", line, re.I)
|
||||||
|
if m:
|
||||||
|
date, time = m.group("date").decode("ascii").split(":", 1)
|
||||||
|
date = dateutil.parser.parse(date).date().isoformat()
|
||||||
|
ip = m.group("ip").decode("ascii")
|
||||||
|
accesses.add( (date, ip) )
|
||||||
|
|
||||||
|
# Aggregate by date.
|
||||||
|
by_date = { }
|
||||||
|
for date, ip in accesses:
|
||||||
|
by_date[date] = by_date.get(date, 0) + 1
|
||||||
|
|
||||||
|
# Since logs are rotated, store the statistics permanently in a JSON file.
|
||||||
|
# Load in the stats from an existing file.
|
||||||
|
if os.path.exists(outfn):
|
||||||
|
existing_data = json.load(open(outfn))
|
||||||
|
for date, count in existing_data:
|
||||||
|
if date not in by_date:
|
||||||
|
by_date[date] = count
|
||||||
|
|
||||||
|
# Turn into a list rather than a dict structure to make it ordered.
|
||||||
|
by_date = sorted(by_date.items())
|
||||||
|
|
||||||
|
# Pop the last one because today's stats are incomplete.
|
||||||
|
by_date.pop(-1)
|
||||||
|
|
||||||
|
# Write out.
|
||||||
|
with open(outfn, "w") as f:
|
||||||
|
json.dump(by_date, f, sort_keys=True, indent=True)
|
||||||
Reference in New Issue
Block a user