-
Notifications
You must be signed in to change notification settings - Fork 17
/
check_tls_certs.py
358 lines (319 loc) · 13 KB
/
check_tls_certs.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
import asyncio
import click
import datetime
import itertools
import select
import socket
import sys
import time
import traceback
import OpenSSL
default_expiry_warn = 14
class DomainParseError(Exception):
pass
class Domain(str):
def __new__(cls, domain):
if domain.startswith('!'):
name = domain[1:]
else:
name = domain
host = name
port = 443
if ':' in name:
host, port = name.split(':')
try:
port = int(port)
except ValueError:
raise DomainParseError("Couldn't parse '%s', port '%s' is not an integer" % (domain, port))
connection_host = host
if '|' in name:
host, connection_host = name.split('|')
name = "%s (%s)" % (host, connection_host)
result = str.__new__(cls, name)
if domain.startswith('!'):
result.no_fetch = True
else:
result.no_fetch = False
result.host = host
result.connection_host = connection_host
result.port = port
return result
class CertDomains(list):
def __init__(self, domain_definitions):
for d in domain_definitions.split('/'):
self.append(Domain(d))
def fatal(msg):
click.echo(click.style(msg, fg="red"), err=True)
sys.exit(5)
def _get_cert_from_domain(domain):
ctx = OpenSSL.SSL.Context(OpenSSL.SSL.SSLv23_METHOD)
sock = socket.socket()
sock.settimeout(5)
wrapped_sock = OpenSSL.SSL.Connection(ctx, sock)
wrapped_sock.set_tlsext_host_name(domain.host.encode('ascii'))
wrapped_sock.connect((domain.connection_host, domain.port))
while True:
try:
wrapped_sock.do_handshake()
break
except OpenSSL.SSL.WantReadError:
select.select([wrapped_sock], [], [])
return wrapped_sock.get_peer_cert_chain()
def get_cert_from_domain(domain):
if domain.no_fetch:
return (domain, None)
for i in range(2):
try:
data = _get_cert_from_domain(domain)
break
except Exception as e:
data = e
time.sleep(5)
return (domain, data)
def close_event_loop(loop):
# just a separate function, so this can be monkeypatched in tests
loop.close()
def get_domain_certs(domains):
loop = asyncio.get_event_loop()
(done, pending) = loop.run_until_complete(asyncio.wait([
loop.run_in_executor(None, get_cert_from_domain, x)
for x in itertools.chain(*domains)]))
close_event_loop(loop)
return dict(x.result() for x in done)
def domain_key(d):
return tuple(reversed(d.split('.')))
def format_components(components):
return '/'.join('='.join(x.decode('utf-8') for x in c) for c in components)
def validate_certificate_chain(cert_chain, msgs):
ctx = OpenSSL.SSL.Context(OpenSSL.SSL.SSLv23_METHOD)
ctx.set_default_verify_paths()
cert_store = ctx.get_cert_store()
pending_msgs = []
for index, cert in reversed(list(enumerate(cert_chain))):
sc = OpenSSL.crypto.X509StoreContext(cert_store, cert)
try:
sc.verify_certificate()
except OpenSSL.crypto.X509StoreContextError as e:
msg = (
'error',
"Validation error '%s' for subject '%s' issued by '%s'." % (
e,
format_components(cert.get_subject().get_components()),
format_components(cert.get_issuer().get_components())))
if 'certificate has expired' in str(e):
pending_msgs.append(msg)
elif 'unable to get local issuer certificate' in str(e):
pending_msgs.append(msg)
else:
msgs.extend(pending_msgs)
pending_msgs.clear()
msgs.append(msg)
else:
if index > 0:
cert_store.add_cert(cert)
def check(domainnames_certs, utcnow, expiry_warn=default_expiry_warn):
msgs = []
domainnames = set(dnc[0].host for dnc in domainnames_certs)
earliest_expiration = None
for domain, cert_chain in domainnames_certs:
if cert_chain is None:
continue
if isinstance(cert_chain, Exception):
cert_chain = "".join(traceback.format_exception_only(type(cert_chain), cert_chain)).strip()
if not any(isinstance(cert, OpenSSL.crypto.X509) for cert in cert_chain):
msgs.append(
('error', "Couldn't fetch certificate for %s.\n%s" % (domain, cert_chain)))
continue
validate_certificate_chain(cert_chain, msgs)
cert = cert_chain[0]
expires = datetime.datetime.strptime(cert.get_notAfter().decode('ascii'), '%Y%m%d%H%M%SZ')
if expires:
if earliest_expiration is None or expires < earliest_expiration:
earliest_expiration = expires
issued_level = "info"
issuer = cert.get_issuer().commonName
if issuer.lower() == "happy hacker fake ca":
issued_level = "error"
msgs.append(
(issued_level, "Issued by: %s" % issuer))
if len(cert_chain) > 1:
sign_cert = cert_chain[1]
subject = sign_cert.get_subject().commonName
if issuer != subject:
msgs.append(
('error', "The certificate sign chain subject '%s' doesn't match the issuer '%s'." % (subject, issuer)))
sig_alg = cert.get_signature_algorithm()
if sig_alg.startswith(b'sha1'):
msgs.append(
('error', "Unsecure signature algorithm %s" % sig_alg))
if expires < utcnow:
msgs.append(
('error', "The certificate has expired on %s." % expires))
elif expires < (utcnow + datetime.timedelta(days=expiry_warn)):
msgs.append(
('warning', "The certificate expires on %s (%s)." % (
expires, expires - utcnow)))
else:
# rounded delta
delta = ((expires - utcnow) // 60 // 10 ** 6) * 60 * 10 ** 6
msgs.append(
('info', "Valid until %s (%s)." % (expires, delta)))
alt_names = set()
for index in range(cert.get_extension_count()):
ext = cert.get_extension(index)
if ext.get_short_name() != b'subjectAltName':
continue
alt_names.update(
x.strip().replace('DNS:', '')
for x in str(ext).split(','))
alt_names.add(cert.get_subject().commonName)
wildcard_names = {x for x in alt_names if x.startswith('*.')}
alt_names = alt_names - wildcard_names
unmatched = domainnames.difference(alt_names)
if unmatched:
msgs.append(
('info', "Alternate names in certificate: %s" % ', '.join(
sorted(alt_names, key=domain_key))))
if wildcard_names:
msgs.append(
('info', "Wildcard names in certificate: %s" % ', '.join(
sorted(wildcard_names, key=domain_key))))
if len(domainnames) == 1:
for name in wildcard_names:
name_parts = name.split('.')[1:]
name_parts_len = len(name_parts)
domain_host_parts = domain.host.split('.')
if (len(domain_host_parts) - name_parts_len) == 1:
if domain_host_parts[-name_parts_len:] == name_parts:
break
else:
msgs.append(
('error', "The requested domain %s doesn't match any of the certificates wildcard domains %s." % (domain, ', '.join(sorted(wildcard_names, key=domain_key)))))
else:
msgs.append(
('warning', "Unmatched alternate names %s." % ', '.join(
sorted(unmatched, key=domain_key))))
elif domainnames == alt_names:
msgs.append(
('info', "Alternate names match specified domains."))
else:
unmatched = alt_names.difference(domainnames)
msgs.append(
('warning', "More alternate names than specified %s." % ', '.join(
sorted(unmatched, key=domain_key))))
return (msgs, earliest_expiration)
def check_domains(domains, domain_certs, utcnow, expiry_warn=default_expiry_warn):
result = []
for domainnames in domains:
domainnames_certs = [(dn, domain_certs[dn]) for dn in domainnames]
msgs = []
seen = set()
earliest_expiration = None
(dmsgs, expiration) = check(domainnames_certs, utcnow, expiry_warn=expiry_warn)
for level, msg in dmsgs:
if expiration:
if earliest_expiration is None or expiration < earliest_expiration:
earliest_expiration = expiration
if msg not in seen:
seen.add(msg)
msgs.append((level, msg))
result.append((domainnames, msgs, earliest_expiration))
return result
def domain_definitions_from_lines(lines):
result = []
current = []
current_start = 1
for index, line in enumerate(lines, start=1):
line = line.strip()
if not line or line.startswith('#'):
if not current:
current_start += 1
continue
if line.endswith('/'):
current.append(line)
continue
current.append(line)
try:
domain_definition = CertDomains("".join(current))
except DomainParseError as e:
fatal("Error in definition starting on line %s: %s" % (current_start, e))
result.append(domain_definition)
current = []
current_start = index + 1
return result
def domain_definitions_from_filename(filename):
if not filename:
return []
with open(filename, 'r', encoding='utf-8') as f:
return domain_definitions_from_lines(f)
def domain_definitions_from_cli(domains):
result = []
if not domains:
return result
for domain in domains:
try:
domain_definition = CertDomains(domain)
except DomainParseError as e:
fatal("Error in definition '%s': %s" % (domain, e))
result.append(domain_definition)
return result
@click.command()
@click.option('-f', '--file', metavar='FILE', help='File to read domains from. One per line.')
@click.option('-v', '--verbose', count=True, help='Increase verbosity. Can be used several times. Currently max verbosity is 2.')
@click.option('expiry_warn', '-e', '--expiry-warning', metavar='DAYS', help='Days before expiration warning.', default=default_expiry_warn, type=int)
@click.argument('domain', nargs=-1)
def main(file, domain, expiry_warn, verbose):
"""Checks the TLS certificate for each DOMAIN.
You can add checks for alternative names by separating them with a slash, like example.com/www.example.com.
Wildcard domains are supported.
Exits with return code 3 when there are warnings, code 4 when there are errors and code 5 when the domain definition contains errors.
"""
domains = list(itertools.chain(
domain_definitions_from_filename(file),
domain_definitions_from_cli(domain)))
domain_certs = get_domain_certs(domains)
exceptions = list(x for x in domain_certs.values() if isinstance(x, Exception))
total_warnings = 0
total_errors = 0
earliest_expiration = None
utcnow = datetime.datetime.utcnow()
checked_domains = check_domains(domains, domain_certs, utcnow, expiry_warn=expiry_warn)
for domainnames, msgs, expiration in checked_domains:
if expiration:
if earliest_expiration is None or expiration < earliest_expiration:
earliest_expiration = expiration
warnings = 0
errors = 0
domain_msgs = [', '.join(domainnames)]
for level, msg in msgs:
if level == 'error':
color = 'red'
errors = errors + 1
elif level == 'warning':
color = 'yellow'
warnings = warnings + 1
else:
color = None
if color:
msg = click.style(msg, fg=color)
msg = "\n".join(" " + m for m in msg.split('\n'))
domain_msgs.append(msg)
if (verbose > 1) or warnings or errors:
click.echo('\n'.join(domain_msgs))
total_errors = total_errors + errors
total_warnings = total_warnings + warnings
msg = "%s error(s), %s warning(s)" % (total_errors, total_warnings)
if earliest_expiration:
msg += "\nEarliest expiration on %s (%s)." % (
earliest_expiration, earliest_expiration - utcnow)
if len(exceptions) > (len(domain_certs.values()) / 2):
click.echo(click.style(msg, fg="red"))
sys.exit(6)
if total_errors:
click.echo(click.style(msg, fg="red"))
sys.exit(4)
elif total_warnings:
click.echo(click.style(msg, fg="yellow"))
sys.exit(3)
if verbose:
click.echo(click.style(msg, fg="green"))