2014-06-23 00:11:24 +00:00
#!/usr/bin/python3
#
2014-06-22 15:34:36 +00:00
# Checks that the upstream DNS has been set correctly and that
2014-06-23 00:11:24 +00:00
# SSL certificates have been signed, etc., and if not tells the user
2014-06-22 15:34:36 +00:00
# what to do next.
2014-06-23 10:53:09 +00:00
__ALL__ = [ ' check_certificate ' ]
2014-08-21 11:09:51 +00:00
import os , os . path , re , subprocess , datetime
2014-06-22 15:34:36 +00:00
import dns . reversename , dns . resolver
2014-09-21 12:51:27 +00:00
import dateutil . parser , dateutil . tz
2014-06-22 15:34:36 +00:00
2014-08-13 19:42:49 +00:00
from dns_update import get_dns_zones , build_tlsa_record
2014-06-22 15:34:36 +00:00
from web_update import get_web_domains , get_domain_ssl_files
2014-06-22 16:28:55 +00:00
from mailconfig import get_mail_domains , get_mail_aliases
2014-06-22 15:34:36 +00:00
2014-08-01 12:15:02 +00:00
from utils import shell , sort_domains , load_env_vars_from_file
2014-06-22 15:34:36 +00:00
2014-08-17 22:43:57 +00:00
def run_checks ( env , output ) :
env [ " out " ] = output
2014-06-23 19:39:20 +00:00
run_system_checks ( env )
2014-08-19 11:16:49 +00:00
run_network_checks ( env )
2014-06-23 19:39:20 +00:00
run_domain_checks ( env )
def run_system_checks ( env ) :
2014-08-17 22:43:57 +00:00
env [ " out " ] . add_heading ( " System " )
2014-06-23 19:39:20 +00:00
# Check that SSH login with password is disabled.
sshd = open ( " /etc/ssh/sshd_config " ) . read ( )
if re . search ( " \n PasswordAuthentication \ s+yes " , sshd ) \
or not re . search ( " \n PasswordAuthentication \ s+no " , sshd ) :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_error ( """ The SSH server on this machine permits password-based login. A more secure
2014-06-23 19:39:20 +00:00
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
/ etc / ssh / sshd_config , and then restart the openssh via ' sudo service ssh restart ' . """ )
else :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_ok ( " SSH disallows password-based login. " )
2014-06-23 19:39:20 +00:00
2014-08-21 11:09:51 +00:00
# Check for any software package updates.
2014-09-21 12:43:47 +00:00
pkgs = list_apt_updates ( apt_update = False )
2014-08-21 11:09:51 +00:00
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. " )
elif len ( pkgs ) == 0 :
env [ ' out ' ] . print_ok ( " System software is up to date. " )
else :
env [ ' out ' ] . print_error ( " There are %d software packages that can be updated. " % len ( pkgs ) )
for p in pkgs :
env [ ' out ' ] . print_line ( " %s ( %s ) " % ( p [ " package " ] , p [ " version " ] ) )
2014-07-16 13:19:32 +00:00
# Check that the administrator alias exists since that's where all
# admin email is automatically directed.
check_alias_exists ( " administrator@ " + env [ ' PRIMARY_HOSTNAME ' ] , env )
2014-08-19 11:16:49 +00:00
def run_network_checks ( env ) :
# Also see setup/network-checks.sh.
env [ " out " ] . add_heading ( " Network " )
# 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.
# 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 )
if ret == 0 :
env [ ' out ' ] . print_ok ( " Outbound mail (SMTP port 25) is not blocked. " )
else :
env [ ' out ' ] . 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
machines from being able to send spam . A quick connection test to Google ' s mail server on port 25
failed . """ )
2014-09-10 01:39:04 +00:00
# Stop if the IPv4 address is listed in the ZEN Spamhaus Block List.
2014-08-19 11:16:49 +00:00
# The user might have ended up on an IP address that was previously in use
# by a spammer, or the user may be deploying on a residential network. We
# will not be able to reliably send mail in these cases.
rev_ip4 = " . " . join ( reversed ( env [ ' PUBLIC_IP ' ] . split ( ' . ' ) ) )
2014-09-08 20:27:26 +00:00
zen = query_dns ( rev_ip4 + ' .zen.spamhaus.org ' , ' A ' , nxdomain = None )
if zen is None :
2014-08-19 11:16:49 +00:00
env [ ' out ' ] . print_ok ( " IP address is not blacklisted by zen.spamhaus.org. " )
else :
2014-09-08 20:27:26 +00:00
env [ ' out ' ] . print_error ( """ The IP address of this machine %s is listed in the Spamhaus Block List (code %s ),
2014-08-19 11:16:49 +00:00
which may prevent recipients from receiving your email . See http : / / www . spamhaus . org / query / ip / % s . """
2014-09-08 20:27:26 +00:00
% ( env [ ' PUBLIC_IP ' ] , zen , env [ ' PUBLIC_IP ' ] ) )
2014-08-19 11:16:49 +00:00
2014-06-23 19:39:20 +00:00
def run_domain_checks ( env ) :
2014-06-22 16:28:55 +00:00
# Get the list of domains we handle mail for.
mail_domains = get_mail_domains ( env )
2014-06-22 15:34:36 +00:00
# Get the list of domains we serve DNS zones for (i.e. does not include subdomains).
dns_zonefiles = dict ( get_dns_zones ( env ) )
dns_domains = set ( dns_zonefiles )
# Get the list of domains we serve HTTPS for.
web_domains = set ( get_web_domains ( env ) )
# Check the domains.
2014-06-22 16:28:55 +00:00
for domain in sort_domains ( mail_domains | dns_domains | web_domains , env ) :
2014-08-17 22:43:57 +00:00
env [ " out " ] . add_heading ( domain )
2014-06-22 16:28:55 +00:00
2014-06-30 13:15:36 +00:00
if domain == env [ " PRIMARY_HOSTNAME " ] :
2014-10-01 12:09:43 +00:00
check_primary_hostname_dns ( domain , env , dns_domains , dns_zonefiles )
2014-06-22 16:28:55 +00:00
if domain in dns_domains :
check_dns_zone ( domain , env , dns_zonefiles )
if domain in mail_domains :
check_mail_domain ( domain , env )
2014-07-20 15:15:33 +00:00
if domain in web_domains :
check_web_domain ( domain , env )
2014-06-22 16:28:55 +00:00
2014-10-01 12:09:43 +00:00
if domain in dns_domains :
check_dns_zone_suggestions ( domain , env , dns_zonefiles )
def check_primary_hostname_dns ( domain , env , dns_domains , dns_zonefiles ) :
# If a DS record is set on the zone containing this domain, check DNSSEC now.
for zone in dns_domains :
if zone == domain or domain . endswith ( " . " + zone ) :
if query_dns ( zone , " DS " , nxdomain = None ) is not None :
check_dnssec ( zone , env , dns_zonefiles , is_checking_primary = True )
2014-06-22 15:34:36 +00:00
# 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.
ip = query_dns ( " ns1. " + domain , " A " ) + ' / ' + query_dns ( " ns2. " + domain , " A " )
if ip == env [ ' PUBLIC_IP ' ] + ' / ' + env [ ' PUBLIC_IP ' ] :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_ok ( " Nameserver glue records are correct at registrar. [ns1/ns2. %s => %s ] " % ( env [ ' PRIMARY_HOSTNAME ' ] , env [ ' PUBLIC_IP ' ] ) )
2014-06-22 15:34:36 +00:00
else :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_error ( """ Nameserver glue records are incorrect. The ns1. %s and ns2. %s nameservers must be configured at your domain name
2014-06-22 15:34:36 +00:00
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 . """
2014-06-30 13:15:36 +00:00
% ( env [ ' PRIMARY_HOSTNAME ' ] , env [ ' PRIMARY_HOSTNAME ' ] , env [ ' PUBLIC_IP ' ] , ip ) )
2014-06-22 15:34:36 +00:00
2014-06-30 13:15:36 +00:00
# Check that PRIMARY_HOSTNAME resolves to PUBLIC_IP in public DNS.
2014-06-22 15:34:36 +00:00
ip = query_dns ( domain , " A " )
if ip == env [ ' PUBLIC_IP ' ] :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_ok ( " Domain resolves to box ' s IP address. [ %s => %s ] " % ( env [ ' PRIMARY_HOSTNAME ' ] , env [ ' PUBLIC_IP ' ] ) )
2014-06-22 15:34:36 +00:00
else :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_error ( """ This domain must resolve to your box ' s IP address ( %s ) in public DNS but it currently resolves
2014-06-22 15:34:36 +00:00
to % s . 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 ) )
2014-06-30 13:15:36 +00:00
# Check reverse DNS on the PRIMARY_HOSTNAME. Note that it might not be
2014-06-22 15:34:36 +00:00
# a DNS zone if it is a subdomain of another domain we have a zone for.
ipaddr_rev = dns . reversename . from_address ( env [ ' PUBLIC_IP ' ] )
existing_rdns = query_dns ( ipaddr_rev , " PTR " )
if existing_rdns == domain :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_ok ( " Reverse DNS is set correctly at ISP. [ %s => %s ] " % ( env [ ' PUBLIC_IP ' ] , env [ ' PRIMARY_HOSTNAME ' ] ) )
2014-06-22 15:34:36 +00:00
else :
2014-08-17 22:43:57 +00:00
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
2014-06-22 15:34:36 +00:00
on setting up reverse DNS for your box at % s . """ % (existing_rdns, domain, env[ ' PUBLIC_IP ' ]) )
2014-08-13 19:42:49 +00:00
# Check the TLSA record.
tlsa_qname = " _25._tcp. " + domain
tlsa25 = query_dns ( tlsa_qname , " TLSA " , nxdomain = None )
tlsa25_expected = build_tlsa_record ( env )
if tlsa25 == tlsa25_expected :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_ok ( """ The DANE TLSA record for incoming mail is correct ( %s ). """ % tlsa_qname , )
2014-08-13 19:42:49 +00:00
elif tlsa25 is None :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_error ( """ The DANE TLSA record for incoming mail is not set. This is optional. """ )
2014-08-13 19:42:49 +00:00
else :
2014-08-17 22:43:57 +00:00
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
2014-08-13 19:42:49 +00:00
regenerate the record . It may take several hours for
public DNS to update after a change . """
% ( tlsa_qname , tlsa25 , tlsa25_expected ) )
2014-06-22 16:28:55 +00:00
# Check that the hostmaster@ email address exists.
check_alias_exists ( " hostmaster@ " + domain , env )
def check_alias_exists ( alias , env ) :
mail_alises = dict ( get_mail_aliases ( env ) )
if alias in mail_alises :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_ok ( " %s exists as a mail alias [=> %s ] " % ( alias , mail_alises [ alias ] ) )
2014-06-22 16:28:55 +00:00
else :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_error ( """ You must add a mail alias for %s and direct email to you or another administrator. """ % alias )
2014-06-22 16:28:55 +00:00
2014-06-22 15:34:36 +00:00
def check_dns_zone ( domain , env , dns_zonefiles ) :
2014-10-01 12:09:43 +00:00
# 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 query_dns ( domain , " DS " , nxdomain = None ) is not None :
check_dnssec ( domain , env , dns_zonefiles )
2014-06-22 15:34:36 +00:00
# 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.
existing_ns = query_dns ( domain , " NS " )
2014-06-30 13:15:36 +00:00
correct_ns = " ns1.BOX; ns2.BOX " . replace ( " BOX " , env [ ' PRIMARY_HOSTNAME ' ] )
2014-08-18 22:41:27 +00:00
if existing_ns . lower ( ) == correct_ns . lower ( ) :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_ok ( " Nameservers are set correctly at registrar. [ %s ] " % correct_ns )
2014-06-22 15:34:36 +00:00
else :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_error ( """ The nameservers set on this domain are incorrect. They are currently %s . Use your domain name registar ' s
2014-06-22 15:34:36 +00:00
control panel to set the nameservers to % s . """
% ( existing_ns , correct_ns ) )
2014-10-01 12:09:43 +00:00
def check_dns_zone_suggestions ( domain , env , dns_zonefiles ) :
# 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 query_dns ( domain , " DS " , nxdomain = None ) is None :
check_dnssec ( domain , env , dns_zonefiles )
def check_dnssec ( domain , env , dns_zonefiles , is_checking_primary = False ) :
2014-08-01 12:15:02 +00:00
# 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
# pre-generated all of the valid digests --- read them in.
ds_correct = open ( ' /etc/nsd/zones/ ' + dns_zonefiles [ domain ] + ' .ds ' ) . read ( ) . strip ( ) . split ( " \n " )
digests = { }
for rr_ds in ds_correct :
ds_keytag , ds_alg , ds_digalg , ds_digest = rr_ds . split ( " \t " ) [ 4 ] . split ( " " )
digests [ ds_digalg ] = ds_digest
# Some registrars may want the public key so they can compute the digest. The DS
# record that we suggest using is for the KSK (and that's how the DS records were generated).
2014-10-04 17:29:42 +00:00
alg_name_map = { ' 7 ' : ' RSASHA1-NSEC3-SHA1 ' , ' 8 ' : ' RSASHA256 ' }
dnssec_keys = load_env_vars_from_file ( os . path . join ( env [ ' STORAGE_ROOT ' ] , ' dns/dnssec/ %s .conf ' % alg_name_map [ ds_alg ] ) )
2014-08-01 12:15:02 +00:00
dnsssec_pubkey = open ( os . path . join ( env [ ' STORAGE_ROOT ' ] , ' dns/dnssec/ ' + dnssec_keys [ ' KSK ' ] + ' .key ' ) ) . read ( ) . split ( " \t " ) [ 3 ] . split ( " " ) [ 3 ]
# Query public DNS for the DS record at the registrar.
2014-06-22 15:34:36 +00:00
ds = query_dns ( domain , " DS " , nxdomain = None )
2014-08-01 12:15:02 +00:00
ds_looks_valid = ds and len ( ds . split ( " " ) ) == 4
if ds_looks_valid : ds = ds . split ( " " )
2014-10-04 17:29:42 +00:00
if ds_looks_valid and ds [ 0 ] == ds_keytag and ds [ 1 ] == ds_alg and ds [ 3 ] == digests . get ( ds [ 2 ] ) :
2014-10-01 12:09:43 +00:00
if is_checking_primary : return
env [ ' out ' ] . print_ok ( " DNSSEC ' DS ' record is set correctly at registrar. " )
2014-06-22 15:34:36 +00:00
else :
2014-08-01 12:15:02 +00:00
if ds == None :
2014-10-01 12:09:43 +00:00
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.
2014-08-01 12:15:02 +00:00
To set a DS record , you must follow the instructions provided by your domain name registrar and provide to them this information : """ )
else :
2014-10-01 12:09:43 +00:00
if is_checking_primary :
env [ ' out ' ] . print_error ( """ The DNSSEC ' DS ' record for %s is incorrect. See further details below. """ % domain )
return
env [ ' out ' ] . print_error ( """ This domain ' s DNSSEC DS record is incorrect. The chain of trust is broken between the public DNS system
2014-08-01 12:15:02 +00:00
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
provide to them this information : """ )
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . 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 ] ) )
env [ ' out ' ] . print_line ( " Key Flags: KSK " )
2014-10-04 17:29:42 +00:00
env [ ' out ' ] . print_line (
( " 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 ] ) )
2014-09-07 14:59:14 +00:00
# see http://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_line ( " Digest Type: 2 / SHA-256 " )
2014-09-07 14:59:14 +00:00
# http://www.ietf.org/assignments/ds-rr-types/ds-rr-types.xml
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_line ( " Digest: " + digests [ ' 2 ' ] )
2014-08-01 12:15:02 +00:00
if ds_looks_valid and ds [ 3 ] != digests . get ( ds [ 2 ] ) :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_line ( " (Got digest type %s and digest %s which do not match.) " % ( ds [ 2 ] , ds [ 3 ] ) )
env [ ' out ' ] . print_line ( " Public Key: " )
env [ ' out ' ] . print_line ( dnsssec_pubkey , monospace = True )
env [ ' out ' ] . print_line ( " " )
env [ ' out ' ] . print_line ( " Bulk/Record Format: " )
env [ ' out ' ] . print_line ( " " + ds_correct [ 0 ] )
env [ ' out ' ] . print_line ( " " )
2014-06-22 15:34:36 +00:00
2014-06-22 16:28:55 +00:00
def check_mail_domain ( domain , env ) :
2014-07-07 02:33:35 +00:00
# Check the MX record.
2014-07-07 02:17:04 +00:00
mx = query_dns ( domain , " MX " , nxdomain = None )
2014-06-30 13:15:36 +00:00
expected_mx = " 10 " + env [ ' PRIMARY_HOSTNAME ' ]
2014-07-07 02:33:35 +00:00
2014-06-22 15:34:36 +00:00
if mx == expected_mx :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_ok ( " Domain ' s email is directed to this domain. [ %s => %s ] " % ( domain , mx ) )
2014-07-07 02:33:35 +00:00
elif mx == None :
# A missing MX record is okay on the primary hostname because
# the primary hostname's A record (the MX fallback) is... itself,
# which is what we want the MX to be.
if domain == env [ ' PRIMARY_HOSTNAME ' ] :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_ok ( " Domain ' s email is directed to this domain. [ %s has no MX record, which is ok] " % ( domain , ) )
2014-07-07 02:33:35 +00:00
# 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
# probably confuse DANE TLSA, but we'll let that slide for now.
else :
domain_a = query_dns ( domain , " A " , nxdomain = None )
primary_a = query_dns ( env [ ' PRIMARY_HOSTNAME ' ] , " A " , nxdomain = None )
if domain_a != None and domain_a == primary_a :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_ok ( " Domain ' s email is directed to this domain. [ %s has no MX record but its A record is OK] " % ( domain , ) )
2014-07-07 02:33:35 +00:00
else :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_error ( """ This domain ' s DNS MX record is not set. It should be ' %s ' . Mail will not
2014-07-07 02:33:35 +00:00
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,))
2014-06-22 15:34:36 +00:00
else :
2014-08-17 22:43:57 +00:00
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
2014-06-22 15:34:36 +00:00
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))
2014-06-22 16:28:55 +00:00
# Check that the postmaster@ email address exists.
check_alias_exists ( " postmaster@ " + domain , env )
2014-08-19 11:16:49 +00:00
# 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
# and will not be able to reliably send mail.
2014-09-08 20:27:26 +00:00
dbl = query_dns ( domain + ' .dbl.spamhaus.org ' , " A " , nxdomain = None )
if dbl is None :
2014-08-19 11:16:49 +00:00
env [ ' out ' ] . print_ok ( " Domain is not blacklisted by dbl.spamhaus.org. " )
else :
2014-09-08 20:27:26 +00:00
env [ ' out ' ] . print_error ( """ This domain is listed in the Spamhaus Domain Block List (code %s ),
which may prevent recipients from receiving your mail .
See http : / / www . spamhaus . org / dbl / and http : / / www . spamhaus . org / query / domain / % s . """ % (dbl, domain))
2014-08-19 11:16:49 +00:00
2014-07-20 15:15:33 +00:00
def check_web_domain ( domain , env ) :
# 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
# other domains, it is required to access its website.
if domain != env [ ' PRIMARY_HOSTNAME ' ] :
ip = query_dns ( domain , " A " )
if ip == env [ ' PUBLIC_IP ' ] :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_ok ( " Domain resolves to this box ' s IP address. [ %s => %s ] " % ( domain , env [ ' PUBLIC_IP ' ] ) )
2014-07-20 15:15:33 +00:00
else :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_error ( """ This domain should resolve to your box ' s IP address ( %s ) if you would like the box to serve
2014-07-20 15:15:33 +00:00
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))
# 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
# website for also needs a signed certificate.
check_ssl_cert ( domain , env )
2014-06-22 15:34:36 +00:00
def query_dns ( qname , rtype , nxdomain = ' [Not Set] ' ) :
resolver = dns . resolver . get_default_resolver ( )
try :
response = dns . resolver . query ( qname , rtype )
2014-06-22 16:28:55 +00:00
except ( dns . resolver . NoNameservers , dns . resolver . NXDOMAIN , dns . resolver . NoAnswer ) :
2014-06-22 15:34:36 +00:00
# Host did not have an answer for this query; not sure what the
# difference is between the two exceptions.
return nxdomain
# There may be multiple answers; concatenate the response. Remove trailing
# periods from responses since that's how qnames are encoded in DNS but is
2014-08-17 19:55:03 +00:00
# confusing for us. The order of the answers doesn't matter, so sort so we
# can compare to a well known order.
return " ; " . join ( sorted ( str ( r ) . rstrip ( ' . ' ) for r in response ) )
2014-06-22 15:34:36 +00:00
def check_ssl_cert ( domain , env ) :
# Check that SSL certificate is signed.
2014-06-22 16:28:55 +00:00
# Skip the check if the A record is not pointed here.
2014-08-17 22:43:57 +00:00
if query_dns ( domain , " A " , None ) not in ( env [ ' PUBLIC_IP ' ] , None ) : return
2014-06-22 16:28:55 +00:00
# Where is the SSL stored?
2014-06-22 15:34:36 +00:00
ssl_key , ssl_certificate , ssl_csr_path = get_domain_ssl_files ( domain , env )
if not os . path . exists ( ssl_certificate ) :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_error ( " The SSL certificate file for this domain is missing. " )
2014-06-22 15:34:36 +00:00
return
2014-06-23 10:53:09 +00:00
# Check that the certificate is good.
2014-06-22 15:34:36 +00:00
2014-07-08 15:47:54 +00:00
cert_status = check_certificate ( domain , ssl_certificate , ssl_key )
2014-06-22 15:34:36 +00:00
2014-06-23 10:53:09 +00:00
if cert_status == " SELF-SIGNED " :
2014-06-22 15:34:36 +00:00
fingerprint = shell ( ' check_output ' , [
" openssl " ,
" x509 " ,
" -in " , ssl_certificate ,
" -noout " ,
" -fingerprint "
] )
fingerprint = re . sub ( " .*Fingerprint= " , " " , fingerprint ) . strip ( )
2014-07-07 01:54:54 +00:00
if domain == env [ ' PRIMARY_HOSTNAME ' ] :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_error ( """ The SSL certificate for this domain is currently self-signed. You will get a security
2014-07-07 01:54:54 +00:00
warning when you check or send email and when visiting this domain in a web browser ( for webmail or
static site hosting ) . You may choose to confirm the security exception , but check that the certificate
fingerprint matches the following : """ )
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_line ( " " )
env [ ' out ' ] . print_line ( " " + fingerprint , monospace = True )
2014-07-07 01:54:54 +00:00
else :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_error ( """ The SSL certificate for this domain is currently self-signed. Visitors to a website on
2014-07-07 01:54:54 +00:00
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 . """ )
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_line ( " " )
env [ ' out ' ] . print_line ( """ You can purchase a signed certificate from many places. You will need to provide this Certificate Signing Request (CSR)
2014-06-22 15:34:36 +00:00
to whoever you purchase the SSL certificate from : """ )
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_line ( " " )
env [ ' out ' ] . print_line ( open ( ssl_csr_path ) . read ( ) . strip ( ) , monospace = True )
env [ ' out ' ] . print_line ( " " )
env [ ' out ' ] . print_line ( """ When you purchase an SSL certificate you will receive a certificate in PEM format and possibly a file containing intermediate certificates in PEM format.
2014-06-22 15:34:36 +00:00
If you receive intermediate certificates , use a text editor and paste your certificate on top and then the intermediate certificates
2014-07-09 14:05:59 +00:00
below it . Save the file and place it onto this machine at % s . Then run " service nginx restart " . """ % s sl_certificate)
2014-06-22 15:34:36 +00:00
2014-06-23 10:53:09 +00:00
elif cert_status == " OK " :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_ok ( " SSL certificate is signed & valid. " )
2014-06-23 10:53:09 +00:00
2014-06-22 15:34:36 +00:00
else :
2014-08-17 22:43:57 +00:00
env [ ' out ' ] . print_error ( " The SSL certificate has a problem: " )
env [ ' out ' ] . print_line ( " " )
env [ ' out ' ] . print_line ( cert_status )
env [ ' out ' ] . print_line ( " " )
2014-06-22 15:34:36 +00:00
2014-07-08 15:47:54 +00:00
def check_certificate ( domain , ssl_certificate , ssl_private_key ) :
2014-06-23 10:53:09 +00:00
# Use openssl verify to check the status of a certificate.
2014-07-07 12:06:11 +00:00
# First check that the certificate is for the right domain. The domain
# must be found in the Subject Common Name (CN) or be one of the
2014-09-03 17:31:11 +00:00
# Subject Alternative Names. A wildcard might also appear as the CN
# or in the SAN list, so check for that tool.
2014-07-07 12:06:11 +00:00
cert_dump = shell ( ' check_output ' , [
" openssl " , " x509 " ,
" -in " , ssl_certificate ,
" -noout " , " -text " , " -nameopt " , " rfc2253 " ,
] )
cert_dump = cert_dump . split ( " \n " )
certificate_names = set ( )
2014-09-21 12:51:27 +00:00
cert_expiration_date = None
2014-07-07 12:06:11 +00:00
while len ( cert_dump ) > 0 :
line = cert_dump . pop ( 0 )
# Grab from the Subject Common Name. We include the indentation
# at the start of the line in case maybe the cert includes the
# common name of some other referenced entity (which would be
# indented, I hope).
m = re . match ( " Subject: CN=([^,]+) " , line )
if m :
certificate_names . add ( m . group ( 1 ) )
# Grab from the Subject Alternative Name, which is a comma-delim
# list of names, like DNS:mydomain.com, DNS:otherdomain.com.
m = re . match ( " X509v3 Subject Alternative Name: " , line )
if m :
names = re . split ( " , \ s* " , cert_dump . pop ( 0 ) . strip ( ) )
for n in names :
m = re . match ( " DNS:(.*) " , n )
if m :
certificate_names . add ( m . group ( 1 ) )
2014-09-21 12:51:27 +00:00
m = re . match ( " Not After : (.*) " , line )
if m :
cert_expiration_date = dateutil . parser . parse ( m . group ( 1 ) )
2014-09-03 17:31:11 +00:00
wildcard_domain = re . sub ( " ^[^ \ .]+ " , " * " , domain )
if domain is not None and domain not in certificate_names and wildcard_domain not in certificate_names :
2014-07-07 12:06:11 +00:00
return " This certificate is for the wrong domain names. It is for %s . " % \
" , " . join ( sorted ( certificate_names ) )
2014-07-08 15:47:54 +00:00
# Second, check that the certificate matches the private key. Get the modulus of the
# private key and of the public key in the certificate. They should match. The output
# of each command looks like "Modulus=XXXXX".
if ssl_private_key is not None :
private_key_modulus = shell ( ' check_output ' , [
" openssl " , " rsa " ,
" -inform " , " PEM " ,
" -noout " , " -modulus " ,
" -in " , ssl_private_key ] )
cert_key_modulus = shell ( ' check_output ' , [
" openssl " , " x509 " ,
" -in " , ssl_certificate ,
" -noout " , " -modulus " ] )
if private_key_modulus != cert_key_modulus :
return " The certificate installed at %s does not correspond to the private key at %s . " % ( ssl_certificate , ssl_private_key )
# Next validate that the certificate is valid. This checks whether the certificate
# is self-signed, that the chain of trust makes sense, that it is signed by a CA
# that Ubuntu has installed on this machine's list of CAs, and I think that it hasn't
# expired.
2014-06-23 10:53:09 +00:00
# In order to verify with openssl, we need to split out any
# intermediary certificates in the chain (if any) from our
# certificate (at the top). They need to be passed separately.
cert = open ( ssl_certificate ) . read ( )
m = re . match ( r ' (-*BEGIN CERTIFICATE-*.*?-*END CERTIFICATE-*)(.*) ' , cert , re . S )
if m == None :
return " The certificate file is an invalid PEM certificate. "
mycert , chaincerts = m . groups ( )
# This command returns a non-zero exit status in most cases, so trap errors.
retcode , verifyoutput = shell ( ' check_output ' , [
" openssl " ,
" verify " , " -verbose " ,
" -purpose " , " sslserver " , " -policy_check " , ]
+ ( [ ] if chaincerts . strip ( ) == " " else [ " -untrusted " , " /dev/stdin " ] )
+ [ ssl_certificate ] ,
input = chaincerts . encode ( ' ascii ' ) ,
trap = True )
if " self signed " in verifyoutput :
# Certificate is self-signed.
return " SELF-SIGNED "
2014-09-21 12:51:27 +00:00
elif retcode != 0 :
# There is some unknown problem. Return the `openssl verify` raw output.
2014-06-23 10:53:09 +00:00
return verifyoutput . strip ( )
2014-09-21 12:51:27 +00:00
else :
# `openssl verify` returned a zero exit status so the cert is currently
# good.
# But is it expiring soon?
now = datetime . datetime . now ( dateutil . tz . tzlocal ( ) )
ndays = ( cert_expiration_date - now ) . days
if ndays < = 31 :
return " This certificate expires in %d days on %s . " % ( ndays , cert_expiration_date . strftime ( " %x " ) )
# Return the special OK code.
return " OK "
2014-06-23 10:53:09 +00:00
2014-08-21 11:09:51 +00:00
_apt_updates = None
2014-09-21 12:43:47 +00:00
def list_apt_updates ( apt_update = True ) :
2014-08-21 11:09:51 +00:00
# See if we have this information cached recently.
# Keep the information for 8 hours.
global _apt_updates
if _apt_updates is not None and _apt_updates [ 0 ] > datetime . datetime . now ( ) - datetime . timedelta ( hours = 8 ) :
return _apt_updates [ 1 ]
2014-09-21 12:43:47 +00:00
# Run apt-get update to refresh package list. This should be running daily
# anyway, so on the status checks page don't do this because it is slow.
if apt_update :
shell ( " check_call " , [ " /usr/bin/apt-get " , " -qq " , " update " ] )
2014-08-21 11:09:51 +00:00
# Run apt-get upgrade in simulate mode to get a list of what
# it would do.
simulated_install = shell ( " check_output " , [ " /usr/bin/apt-get " , " -qq " , " -s " , " upgrade " ] )
pkgs = [ ]
for line in simulated_install . split ( ' \n ' ) :
if line . strip ( ) == " " :
continue
if re . match ( r ' ^Conf .* ' , line ) :
# remove these lines, not informative
continue
m = re . match ( r ' ^Inst (.*) \ [(.*) \ ] \ (( \ S*) ' , line )
if m :
pkgs . append ( { " package " : m . group ( 1 ) , " version " : m . group ( 3 ) , " current_version " : m . group ( 2 ) } )
else :
pkgs . append ( { " package " : " [ " + line + " ] " , " version " : " " , " current_version " : " " } )
# Cache for future requests.
_apt_updates = ( datetime . datetime . now ( ) , pkgs )
return pkgs
2014-07-07 02:03:01 +00:00
try :
terminal_columns = int ( shell ( ' check_output ' , [ ' stty ' , ' size ' ] ) . split ( ) [ 1 ] )
except :
terminal_columns = 76
2014-08-17 22:43:57 +00:00
class ConsoleOutput :
def add_heading ( self , heading ) :
print ( )
print ( heading )
print ( " = " * len ( heading ) )
def print_ok ( self , message ) :
self . print_block ( message , first_line = " ✓ " )
def print_error ( self , message ) :
self . print_block ( message , first_line = " ✖ " )
def print_block ( self , message , first_line = " " ) :
print ( first_line , end = ' ' )
message = re . sub ( " \n \ s* " , " " , message )
words = re . split ( " ( \ s+) " , message )
linelen = 0
for w in words :
if linelen + len ( w ) > terminal_columns - 1 - len ( first_line ) :
print ( )
print ( " " , end = " " )
linelen = 0
if linelen == 0 and w . strip ( ) == " " : continue
print ( w , end = " " )
linelen + = len ( w )
2014-06-22 15:34:36 +00:00
print ( )
2014-08-17 22:43:57 +00:00
def print_line ( self , message , monospace = False ) :
for line in message . split ( " \n " ) :
self . print_block ( line )
2014-06-22 15:34:36 +00:00
if __name__ == " __main__ " :
2014-08-17 22:43:57 +00:00
import sys
2014-06-22 15:34:36 +00:00
from utils import load_environment
2014-08-17 22:43:57 +00:00
env = load_environment ( )
if len ( sys . argv ) == 1 :
run_checks ( env , ConsoleOutput ( ) )
elif sys . argv [ 1 ] == " --check-primary-hostname " :
# See if the primary hostname appears resolvable and has a signed certificate.
domain = env [ ' PRIMARY_HOSTNAME ' ]
if query_dns ( domain , " A " ) != env [ ' PUBLIC_IP ' ] :
sys . exit ( 1 )
ssl_key , ssl_certificate , ssl_csr_path = get_domain_ssl_files ( domain , env )
if not os . path . exists ( ssl_certificate ) :
sys . exit ( 1 )
cert_status = check_certificate ( domain , ssl_certificate , ssl_key )
if cert_status != " OK " :
sys . exit ( 1 )
sys . exit ( 0 )