letsencrypt-tiny

   1 #!/usr/bin/env python3
   2 ## Call with "--help" for documentation.
   3
   4 import argparse, configparser, itertools, stat, os, os.path, sys, subprocess, datetime
   5
   6 ## Helper functions
   7 def readConfig(fname, defSection = 'DEFAULT'):
   8     config = configparser.ConfigParser()
   9     with open(fname) as file:
  10         stream = itertools.chain(("["+defSection+"]\n",), file)
  11         config.read_file(stream)
  12     return config
  13
  14 def certfile(name, suff = None):
  15     global config
  16     return os.path.join(config['dirs']['certs'], name + ".crt" + ('' if suff is None else '+'+suff) )
  17
  18 def keyfile(name):
  19     global config
  20     return os.path.join(config['dirs']['keys'], name + ".key")
  21
  22 def csrfile(name):
  23     global config
  24     return os.path.join(config['dirs']['csrs'], name + ".csr")
  25
  26 def make_backup(fname):
  27     if os.path.exists(fname):
  28         backupname = os.path.basename(fname) + "." + str(datetime.date.today())
  29         i = 0
  30         while True:
  31             backupfile = os.path.join(config['dirs']['backups'], backupname + "." + str(i))
  32             if not os.path.exists(backupfile):
  33                 os.rename(src = fname, dst = backupfile)
  34                 break
  35             elif i >= 100:
  36                 print("Somehow it's really hard to find a name for the backup file...")
  37             i += 1
  38     assert not os.path.exists(fname)
  39
  40 def trigger_hook(hook):
  41     global config
  42     exe = config['hooks'][hook]
  43     if exe is not None:
  44         subprocess.check_call([exe])
  45
  46 def key_mtime(name):
  47     return datetime.datetime.fromtimestamp(os.stat(keyfile(name)).st_mtime)
  48
  49 def cert_expiry(name):
  50     from certcheck import cert_expiry_date
  51     return cert_expiry_date(certfile(name))
  52
  53 ## The interesting work
  54 def acme(name, domains):
  55     global config
  56     # Generating the CSR is done by a shell script
  57     exe = os.path.join(os.path.dirname(__file__), 'gencsr')
  58     csr = subprocess.check_output([exe, keyfile(name)] + domains)
  59     with open(csrfile(name), 'wb') as file:
  60         file.write(csr)
  61     # call acme-tiny as a script
  62     acme_tiny = os.path.join(config['acme']['acme-tiny'], 'acme_tiny.py')
  63     signed_crt = subprocess.check_output([acme_tiny, "--quiet", "--account-key", config['acme']['account-key'], "--csr", csrfile(name), "--acme-dir", config['acme']['challenge-dir']])
  64     # save new certificate
  65     make_backup(certfile(name))
  66     with open(certfile(name), 'wb') as f:
  67         f.write(signed_crt)
  68     # append DH params
  69     dhfile = config['DEFAULT'].get('dh-params')
  70     if dhfile is not None:
  71         with open(dhfile, 'rb') as f:
  72             dh = f.read()
  73         with open(certfile(name, 'dh'), 'wb') as f:
  74             f.write(signed_crt)
  75             f.write(dh)
  76
  77 def request_cert(name):
  78     global config
  79     if not os.path.exists(keyfile(name)):
  80         raise Exception("No such key: {}".format(name))
  81     domains = config['DEFAULT']['domains'].split()
  82     print("Obtaining certificate '{}' for domains {}".format(name, ' '.join(domains)))
  83     acme(name, domains)
  84
  85 def generate_key(name):
  86     print("Generating new private key '{}'".format(name))
  87     with subprocess.Popen(["openssl", "genrsa", str(int(config['DEFAULT']['key-length']))], stdout=subprocess.PIPE, stderr=subprocess.PIPE) as f:
  88         (stdout, stderr) = f.communicate()
  89         if f.returncode:
  90             sys.stderr.write(stderr)
  91             raise Exception("Error while generating private key")
  92     # now we have a key, save it
  93     make_backup(keyfile(name))
  94     with open(keyfile(name), 'wb') as f:
  95         f.write(stdout)
  96
  97 def check_staging():
  98     '''Returns 0 if nothing was done, 1 if a stage key is present but has to be kept, 2 is a stage key was unstaged.'''
  99     live = config['files']['live']
 100     staging = config['files'].get('staging')
 101     if staging is None or not os.path.exists(keyfile(staging)):
 102         return 0
 103
 104     staging_time = datetime.timedelta(hours = int(config['timing']['staging-hours']))
 105     key_age = datetime.datetime.now() - key_mtime(staging)
 106     if key_age < staging_time:
 107         return 1
 108     print("Unstaging '{}' to '{}'".format(staging, live))
 109     # unstage the key!
 110     make_backup(keyfile(live))
 111     os.rename(src = keyfile(staging), dst = keyfile(live))
 112     make_backup(certfile(live))
 113     os.rename(src = certfile(staging), dst = certfile(live))
 114     try:
 115         os.rename(src = certfile(staging, 'dh'), dst = certfile(live, 'dh'))
 116     except FileNotFoundError:
 117         pass
 118     return 2
 119
 120 def auto_renewal():
 121     '''Returns 0 if nothing was done, 1 if only certs were changed, 2 if certs and keys were changed.'''
 122     live = config['files']['live']
 123     staging = config['files'].get('staging')
 124
 125     max_key_age = datetime.timedelta(days = int(config['timing']['max-key-age-days']))
 126     renew_cert_time = datetime.timedelta(days = int(config['timing']['renew-cert-before-expiry-days']))
 127
 128     # determine what to do
 129     now = datetime.datetime.now()
 130     key_age = now - key_mtime(live)
 131     cert_validity = cert_expiry(live) - now
 132     need_new_key = key_age >= max_key_age
 133     need_new_cert = cert_validity <= renew_cert_time
 134     if need_new_cert and key_age + renew_cert_time >= max_key_age:
 135         # We are about to request a new certificate, and within <renew_cert_time>, we need a new key: Get the new key now
 136         need_new_key = True
 137
 138     # Do it
 139     if need_new_key:
 140         new_key_name = (live if staging is None else staging)
 141         generate_key(new_key_name)
 142         request_cert(new_key_name)
 143         return 2
 144     elif need_new_cert:
 145         request_cert(live)
 146         return 1
 147     else:
 148         return 0
 149
 150 ## Main
 151 if __name__ == "__main__":
 152     # allow overwriting some values on the command-line
 153     parser = argparse.ArgumentParser(description='Generate and (automatically) renew certificates, optionally providing staging for new keys')
 154     parser.add_argument("-c", "--config",
 155                         dest="config",
 156                         help="The configuration file")
 157     parser.add_argument("-k", "--hooks",
 158                         dest="hooks", action="store_true",
 159                         help="Trigger hooks.")
 160     parser.add_argument("action", metavar='ACTION', nargs=1,
 161                         help="The action to perform. Possible values: init, renew, cron")
 162     args = parser.parse_args()
 163
 164     # read config
 165     if not os.path.isfile(args.config):
 166         raise Exception("The config file does not exist: "+args.config)
 167     global config
 168     config = readConfig(args.config)
 169
 170     if args.action[0] == 'renew':
 171         live = config['files']['live']
 172         staging = config['files'].get('staging')
 173
 174         request_cert(live)
 175         if staging is not None and os.path.exists(keyfile(staging)):
 176             request_cert(staging)
 177         # trigger the "new cert" hook
 178         if args.hooks:
 179             trigger_hook('post-certchange')
 180     elif args.action[0] == 'cron':
 181         # First, check if we need to unstage a staging key
 182         unstaged = check_staging()
 183         if unstaged >= 1:
 184             # A staging eky is present, do *not* check for renewal
 185             if unstaged >= 2 and args.hooks:
 186                 # trigger all the hooks
 187                 trigger_hook('post-certchange')
 188                 trigger_hook('post-keychange')
 189         else:
 190             # Check if we need to renew anything
 191             renewed = auto_renewal()
 192             if args.hooks:
 193                 if renewed >= 1:
 194                     trigger_hook('post-certchange')
 195                 if renewed >= 2:
 196                     trigger_hook('post-keychange')
 197     elif args.action[0] == 'init':
 198         # create directories with appropriate permissions
 199         try:
 200             os.makedirs(config['dirs']['certs'], mode = 0o755, exist_ok = True)
 201             os.makedirs(config['dirs']['keys'], mode = 0o710, exist_ok = True)
 202             os.makedirs(config['dirs']['csrs'], mode = 0o755, exist_ok = True)
 203             os.makedirs(config['dirs']['backups'], mode = 0o700, exist_ok = True)
 204         except OSError:
 205             pass
 206         # if necessary, generate key + certificate
 207         live = config['files']['live']
 208         if not os.path.exists(keyfile(live)):
 209             generate_key(live)
 210             request_cert(live)
 211             if args.hooks:
 212                 trigger_hook('post-certchange')
 213                 trigger_hook('post-keychange')
 214     else:
 215         raise Exception("Unknown action {}".format(args.action))