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
|
# Copyright (c) 2017-2020 by Ron Frederick <ronf@timeheart.net> and others.
#
# This program and the accompanying materials are made available under
# the terms of the Eclipse Public License v2.0 which accompanies this
# distribution and is available at:
#
# http://www.eclipse.org/legal/epl-2.0/
#
# This program may also be made available under the following secondary
# licenses when the conditions for such availability set forth in the
# Eclipse Public License v2.0 are satisfied:
#
# GNU General Public License, Version 2.0, or any later versions of
# that license
#
# SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
#
# Contributors:
# Ron Frederick - initial implementation, API, and documentation
"""Unit tests for X.509 certificate handling"""
import time
import unittest
from cryptography import x509
from .util import get_test_key, x509_available
if x509_available: # pragma: no branch
from asyncssh.crypto import X509Name, X509NamePattern
from asyncssh.crypto import generate_x509_certificate
from asyncssh.crypto import import_x509_certificate
_purpose_secureShellClient = x509.ObjectIdentifier('1.3.6.1.5.5.7.3.21')
@unittest.skipUnless(x509_available, 'X.509 not available')
class _TestX509(unittest.TestCase):
"""Unit tests for X.509 module"""
@classmethod
def setUpClass(cls):
cls._privkey = get_test_key('ssh-rsa')
cls._pubkey = cls._privkey.convert_to_public()
cls._pubdata = cls._pubkey.export_public_key('pkcs8-der')
def generate_certificate(self, subject='OU=name', issuer=None,
serial=None, valid_after=0,
valid_before=0xffffffffffffffff, ca=False,
ca_path_len=None, purposes=None,
user_principals=(), host_principals=(),
hash_alg='sha256', comment=None):
"""Generate and check an X.509 certificate"""
cert = generate_x509_certificate(self._privkey.pyca_key,
self._pubkey.pyca_key,
subject, issuer, serial,
valid_after, valid_before,
ca, ca_path_len, purposes,
user_principals, host_principals,
hash_alg, comment)
self.assertEqual(cert.data, import_x509_certificate(cert.data).data)
self.assertEqual(cert.subject, X509Name(subject))
self.assertEqual(cert.issuer, X509Name(issuer if issuer else subject))
self.assertEqual(cert.key_data, self._pubdata)
if isinstance(comment, str):
comment = comment.encode('utf-8')
self.assertEqual(cert.comment, comment)
return cert
def test_generate(self):
"""Test X.509 certificate generation"""
cert = self.generate_certificate(purposes='secureShellClient')
self.assertEqual(cert.purposes, {_purpose_secureShellClient})
def test_generate_ca(self):
"""Test X.509 CA certificate generation"""
self.generate_certificate(ca=True, ca_path_len=0)
def test_serial(self):
"""Test X.509 certificate generation with serial number"""
self.generate_certificate(serial=1)
def test_user_principals(self):
"""Test X.509 certificate generation with user principals"""
cert = self.generate_certificate(user_principals='user1,user2')
self.assertEqual(cert.user_principals, ['user1', 'user2'])
def test_host_principals(self):
"""Test X.509 certificate generation with host principals"""
cert = self.generate_certificate(host_principals='host1,host2')
self.assertEqual(cert.host_principals, ['host1', 'host2'])
def test_principal_in_common_name(self):
"""Test X.509 certificate generation with user principals"""
cert = self.generate_certificate(subject='CN=name')
self.assertEqual(cert.user_principals, ['name'])
self.assertEqual(cert.host_principals, ['name'])
def test_comment(self):
"""Test X.509 certificate generation with comment"""
self.generate_certificate(comment=b'comment')
self.generate_certificate(comment='comment')
def test_unknown_hash(self):
"""Test X.509 certificate generation with unknown hash"""
with self.assertRaises(ValueError):
self.generate_certificate(hash_alg='xxx')
def test_valid_self(self):
"""Test validation of X.509 self-signed certificate"""
cert = self.generate_certificate()
self.assertIsNone(cert.validate([cert], None, None, None))
def test_untrusted_self(self):
"""Test failed validation of untrusted X.509 self-signed certificate"""
cert1 = self.generate_certificate()
cert2 = self.generate_certificate()
with self.assertRaises(ValueError):
cert1.validate([cert2], None, None, None)
def test_valid_chain(self):
"""Test validation of X.509 certificate chain"""
root_ca = self.generate_certificate('OU=root', ca=True, ca_path_len=1)
int_ca = self.generate_certificate('OU=int', 'OU=root',
ca=True, ca_path_len=0)
cert = self.generate_certificate('OU=user', 'OU=int')
self.assertIsNone(cert.validate([int_ca, root_ca], None, None, None))
def test_incomplete_chain(self):
"""Test failed validation of incomplete X.509 certificate chain"""
root_ca = self.generate_certificate('OU=root', ca=True, ca_path_len=1)
int_ca = self.generate_certificate('OU=int', 'OU=root',
ca=True, ca_path_len=0)
cert = self.generate_certificate('OU=user', 'OU=int2')
with self.assertRaises(ValueError):
cert.validate([int_ca, root_ca], None, None, None)
def test_not_yet_valid_self(self):
"""Test failed validation of not-yet-valid X.509 certificate"""
cert = self.generate_certificate(valid_after=time.time() + 60)
with self.assertRaises(ValueError):
cert.validate([cert], None, None, None)
def test_expired_self(self):
"""Test failed validation of expired X.509 certificate"""
cert = self.generate_certificate(valid_before=time.time() - 60)
with self.assertRaises(ValueError):
cert.validate([cert], None, None, None)
def test_expired_intermediate(self):
"""Test failed validation of expired X.509 intermediate CA"""
root_ca = self.generate_certificate('OU=root', ca=True, ca_path_len=1)
int_ca = self.generate_certificate('OU=int', 'OU=root',
ca=True, ca_path_len=0,
valid_before=time.time() - 60)
cert = self.generate_certificate('OU=user', 'OU=int')
with self.assertRaises(ValueError):
cert.validate([int_ca, root_ca], None, None, None)
def test_purpose_mismatch(self):
"""Test failed validation due to purpose mismatch"""
cert = self.generate_certificate(purposes='secureShellClient')
with self.assertRaises(ValueError):
cert.validate([cert], 'secureShellServer', None, None)
def test_user_principal_match(self):
"""Test validation of user principal"""
cert = self.generate_certificate(user_principals='user')
self.assertIsNone(cert.validate([cert], None, 'user', None))
def test_user_principal_mismatch(self):
"""Test failed validation due to user principal mismatch"""
cert = self.generate_certificate(user_principals='user1,user2')
with self.assertRaises(ValueError):
cert.validate([cert], None, 'user3', None)
def test_host_principal_match(self):
"""Test validation of host principal"""
cert = self.generate_certificate(host_principals='host')
self.assertIsNone(cert.validate([cert], None, None, 'host'))
def test_host_principal_mismatch(self):
"""Test failed validation due to host principal mismatch"""
cert = self.generate_certificate(host_principals='host1,host2')
with self.assertRaises(ValueError):
cert.validate([cert], None, None, 'host3')
def test_name(self):
"""Test X.509 distinguished name generation"""
name = X509Name('O=Org,OU=Unit')
self.assertEqual(name, X509Name('O=Org, OU=Unit'))
self.assertEqual(name, X509Name(name))
self.assertEqual(name, X509Name(name.rdns))
self.assertEqual(len(name), 2)
self.assertEqual(len(name.rdns), 2)
self.assertEqual(str(name), 'O=Org,OU=Unit')
self.assertNotEqual(name, X509Name('OU=Unit,O=Org'))
def test_multiple_attrs_in_rdn(self):
"""Test multiple attributes in a relative distinguished name"""
name1 = X509Name('O=Org,OU=Unit1+OU=Unit2')
name2 = X509Name('O=Org,OU=Unit2+OU=Unit1')
self.assertEqual(name1, name2)
self.assertEqual(len(name1), 3)
self.assertEqual(len(name1.rdns), 2)
def test_invalid_attribute(self):
"""Test X.509 distinguished name with invalid attributes"""
with self.assertRaises(ValueError):
X509Name('xxx')
with self.assertRaises(ValueError):
X509Name('X=xxx')
def test_exact_name_pattern(self):
"""Test X.509 distinguished name exact match"""
pattern1 = X509NamePattern('O=Org,OU=Unit')
pattern2 = X509NamePattern('O=Org, OU=Unit')
self.assertEqual(pattern1, pattern2)
self.assertEqual(hash(pattern1), hash(pattern2))
self.assertTrue(pattern1.matches(X509Name('O=Org,OU=Unit')))
self.assertFalse(pattern1.matches(X509Name('O=Org,OU=Unit2')))
def test_prefix_pattern(self):
"""Test X.509 distinguished name prefix match"""
pattern = X509NamePattern('O=Org,*')
self.assertTrue(pattern.matches(X509Name('O=Org,OU=Unit')))
self.assertFalse(pattern.matches(X509Name('O=Org2,OU=Unit')))
|
