eb9d17150f9ecc99650db4de46fc1f3918a4bd8c
[lets-encrypt-tiny.git] / 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']['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']['staging']
101     if staging is None or not os.path.exists(keyfile(staging)):
102         return 0
103     staging_time = datetime.timedelta(hours = int(config['timing']['staging-hours']))
104     key_age = datetime.datetime.now() - key_mtime(staging)
105     if key_age < staging_time:
106         return 1
107     print("Unstaging '{}' to '{}'".format(staging, live))
108     # unstage the key!
109     make_backup(keyfile(live))
110     os.rename(src = keyfile(staging), dst = keyfile(live))
111     make_backup(certfile(live))
112     os.rename(src = certfile(staging), dst = certfile(live))
113     try:
114         os.rename(src = certfile(staging, 'dh'), dst = certfile(live, 'dh'))
115     except FileNotFoundError:
116         pass
117     return 2
118
119 def auto_renewal():
120     '''Returns 0 if nothing was done, 1 if only certs were changed, 2 if certs and keys were changed.'''
121     live = config['files']['live']
122     staging = config['files']['staging']
123     
124     max_key_age = datetime.timedelta(days = int(config['timing']['max-key-age-days']))
125     renew_cert_time = datetime.timedelta(days = int(config['timing']['renew-cert-before-expiry-days']))
126     
127     # determine what to do
128     now = datetime.datetime.now()
129     key_age = now - key_mtime(live)
130     cert_validity = cert_expiry(live) - now
131     need_new_key = key_age >= max_key_age
132     need_new_cert = cert_validity <= renew_cert_time
133     if need_new_cert and key_age + renew_cert_time >= max_key_age:
134         # We are about to request a new certificate, and within <renew_cert_time>, we need a new key: Get the new key now
135         need_new_key = True
136     
137     # Do it
138     if need_new_key:
139         new_key_name = (live if staging is None else staging)
140         generate_key(new_key_name)
141         request_cert(new_key_name)
142         return 2
143     elif need_new_cert:
144         request_cert(live)
145         return 1
146     else:
147         return 0
148
149 ## Main
150 if __name__ == "__main__":
151     # allow overwriting some values on the command-line
152     parser = argparse.ArgumentParser(description='Generate and (automatically) renew certificates, optionally providing staging for new keys')
153     parser.add_argument("-c", "--config",
154                         dest="config",
155                         help="The configuration file")
156     parser.add_argument("-k", "--hooks",
157                         dest="hooks", action="store_true",
158                         help="Trigger hooks.")
159     parser.add_argument("action", metavar='ACTION', nargs=1,
160                         help="The action to perform. Possible values: init, renew, cron")
161     args = parser.parse_args()
162     
163     # read config
164     if not os.path.isfile(args.config):
165         raise Exception("The config file does not exist: "+args.config)
166     global config
167     config = readConfig(args.config)
168     
169     if args.action[0] == 'renew':
170         live = config['files']['live']
171         staging = config['files']['staging']
172         
173         request_cert(live)
174         if staging is not None and os.path.exists(keyfile(staging)):
175             request_cert(staging)
176         # trigger the "new cert" hook
177         if args.hooks:
178             trigger_hook('post-certchange')
179     elif args.action[0] == 'cron':
180         # First, check if we need to unstage a staging key
181         unstaged = check_staging()
182         if unstaged >= 1:
183             # A staging eky is present, do *not* check for renewal
184             if unstaged >= 2 and args.hooks:
185                 # trigger all the hooks
186                 trigger_hook('post-certchange')
187                 trigger_hook('post-keychange')
188         else:
189             # Check if we need to renew anything
190             renewed = auto_renewal()
191             if args.hooks:
192                 if renewed >= 1:
193                     trigger_hook('post-certchange')
194                 if renewed >= 2:
195                     trigger_hook('post-keychange')
196     elif args.action[0] == 'init':
197         # create directories with appropriate permissions
198         try:
199             os.makedirs(config['dirs']['certs'], mode = 0o755, exist_ok = True)
200             os.makedirs(config['dirs']['keys'], mode = 0o710, exist_ok = True)
201             os.makedirs(config['dirs']['csrs'], mode = 0o755, exist_ok = True)
202             os.makedirs(config['dirs']['backups'], mode = 0o700, exist_ok = True)
203         except OSError:
204             pass
205         # if necessary, generate key + certificate
206         live = config['files']['live']
207         if not os.path.exists(keyfile(live)):
208             generate_key(live)
209             request_cert(live)
210             if args.hooks:
211                 trigger_hook('post-certchange')
212                 trigger_hook('post-keychange')
213     else:
214         raise Exception("Unknown action {}".format(args.action))