blob: 71fa08e416b136aa59558bd9d03250bb560fd181 [file] [log] [blame]
Jean-Paul Calderone8b63d452008-03-21 18:31:12 -04001# Copyright (C) Jean-Paul Calderone 2008, All rights reserved
2
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -05003"""
4Unit tests for L{OpenSSL.crypto}.
5"""
6
Rick Dean5b7b6372009-04-01 11:34:06 -05007from unittest import TestCase, main
Jean-Paul Calderone71919862009-04-01 13:01:19 -04008from subprocess import Popen, PIPE
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -05009
10from OpenSSL.crypto import TYPE_RSA, TYPE_DSA, Error, PKey, PKeyType
Jean-Paul Calderone78381d22008-03-06 23:35:22 -050011from OpenSSL.crypto import X509, X509Type, X509Name, X509NameType
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -050012from OpenSSL.crypto import X509Req, X509ReqType
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -050013from OpenSSL.crypto import X509Extension, X509ExtensionType
Rick Dean5b7b6372009-04-01 11:34:06 -050014from OpenSSL.crypto import load_certificate, load_privatekey
Jean-Paul Calderone71919862009-04-01 13:01:19 -040015from OpenSSL.crypto import FILETYPE_PEM, FILETYPE_ASN1, FILETYPE_TEXT
16from OpenSSL.crypto import dump_certificate, load_certificate_request
17from OpenSSL.crypto import dump_certificate_request, dump_privatekey
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -040018
19
Jean-Paul Calderone20131f52009-04-01 12:05:45 -040020cleartextCertificatePEM = """-----BEGIN CERTIFICATE-----
21MIIC7TCCAlagAwIBAgIIPQzE4MbeufQwDQYJKoZIhvcNAQEFBQAwWDELMAkGA1UE
22BhMCVVMxCzAJBgNVBAgTAklMMRAwDgYDVQQHEwdDaGljYWdvMRAwDgYDVQQKEwdU
23ZXN0aW5nMRgwFgYDVQQDEw9UZXN0aW5nIFJvb3QgQ0EwIhgPMjAwOTAzMjUxMjM2
24NThaGA8yMDE3MDYxMTEyMzY1OFowWDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAklM
25MRAwDgYDVQQHEwdDaGljYWdvMRAwDgYDVQQKEwdUZXN0aW5nMRgwFgYDVQQDEw9U
26ZXN0aW5nIFJvb3QgQ0EwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAPmaQumL
27urpE527uSEHdL1pqcDRmWzu+98Y6YHzT/J7KWEamyMCNZ6fRW1JCR782UQ8a07fy
282xXsKy4WdKaxyG8CcatwmXvpvRQ44dSANMihHELpANTdyVp6DCysED6wkQFurHlF
291dshEaJw8b/ypDhmbVIo6Ci1xvCJqivbLFnbAgMBAAGjgbswgbgwHQYDVR0OBBYE
30FINVdy1eIfFJDAkk51QJEo3IfgSuMIGIBgNVHSMEgYAwfoAUg1V3LV4h8UkMCSTn
31VAkSjch+BK6hXKRaMFgxCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJJTDEQMA4GA1UE
32BxMHQ2hpY2FnbzEQMA4GA1UEChMHVGVzdGluZzEYMBYGA1UEAxMPVGVzdGluZyBS
33b290IENBggg9DMTgxt659DAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4GB
34AGGCDazMJGoWNBpc03u6+smc95dEead2KlZXBATOdFT1VesY3+nUOqZhEhTGlDMi
35hkgaZnzoIq/Uamidegk4hirsCT/R+6vsKAAxNTcBjUeZjlykCJWy5ojShGftXIKY
36w/njVbKMXrvc83qmTdGl3TAM0fxQIpqgcglFLveEBgzn
37-----END CERTIFICATE-----
38"""
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -040039
Jean-Paul Calderone20131f52009-04-01 12:05:45 -040040cleartextPrivateKeyPEM = """-----BEGIN RSA PRIVATE KEY-----
41MIICXQIBAAKBgQD5mkLpi7q6ROdu7khB3S9aanA0Zls7vvfGOmB80/yeylhGpsjA
42jWen0VtSQke/NlEPGtO38tsV7CsuFnSmschvAnGrcJl76b0UOOHUgDTIoRxC6QDU
433claegwsrBA+sJEBbqx5RdXbIRGicPG/8qQ4Zm1SKOgotcbwiaor2yxZ2wIDAQAB
44AoGBAPCgMpmLxzwDaUmcFbTJUvlLW1hoxNNYSu2jIZm1k/hRAcE60JYwvBkgz3UB
45yMEh0AtLxYe0bFk6EHah11tMUPgscbCq73snJ++8koUw+csk22G65hOs51bVb7Aa
466JBe67oLzdtvgCUFAA2qfrKzWRZzAdhUirQUZgySZk+Xq1pBAkEA/kZG0A6roTSM
47BVnx7LnPfsycKUsTumorpXiylZJjTi9XtmzxhrYN6wgZlDOOwOLgSQhszGpxVoMD
48u3gByT1b2QJBAPtL3mSKdvwRu/+40zaZLwvSJRxaj0mcE4BJOS6Oqs/hS1xRlrNk
49PpQ7WJ4yM6ZOLnXzm2mKyxm50Mv64109FtMCQQDOqS2KkjHaLowTGVxwC0DijMfr
50I9Lf8sSQk32J5VWCySWf5gGTfEnpmUa41gKTMJIbqZZLucNuDcOtzUaeWZlZAkA8
51ttXigLnCqR486JDPTi9ZscoZkZ+w7y6e/hH8t6d5Vjt48JVyfjPIaJY+km58LcN3
526AWSeGAdtRFHVzR7oHjVAkB4hutvxiOeiIVQNBhM6RSI9aBPMI21DoX2JRoxvNW2
53cbvAhow217X9V0dVerEOKxnNYspXRrh36h7k4mQA+sDq
54-----END RSA PRIVATE KEY-----
55"""
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -040056
Rick Dean5b7b6372009-04-01 11:34:06 -050057cleartextCertificateRequestPEM = (
58 "-----BEGIN CERTIFICATE REQUEST-----\n"
59 "MIIBnjCCAQcCAQAwXjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAklMMRAwDgYDVQQH\n"
60 "EwdDaGljYWdvMRcwFQYDVQQKEw5NeSBDb21wYW55IEx0ZDEXMBUGA1UEAxMORnJl\n"
61 "ZGVyaWNrIERlYW4wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBANp6Y17WzKSw\n"
62 "BsUWkXdqg6tnXy8H8hA1msCMWpc+/2KJ4mbv5NyD6UD+/SqagQqulPbF/DFea9nA\n"
63 "E0zhmHJELcM8gUTIlXv/cgDWnmK4xj8YkjVUiCdqKRAKeuzLG1pGmwwF5lGeJpXN\n"
64 "xQn5ecR0UYSOWj6TTGXB9VyUMQzCClcBAgMBAAGgADANBgkqhkiG9w0BAQUFAAOB\n"
65 "gQAAJGuF/R/GGbeC7FbFW+aJgr9ee0Xbl6nlhu7pTe67k+iiKT2dsl2ti68MVTnu\n"
66 "Vrb3HUNqOkiwsJf6kCtq5oPn3QVYzTa76Dt2y3Rtzv6boRSlmlfrgS92GNma8JfR\n"
67 "oICQk3nAudi6zl1Dix3BCv1pUp5KMtGn3MeDEi6QFGy2rA==\n"
68 "-----END CERTIFICATE REQUEST-----\n")
69
Jean-Paul Calderone20131f52009-04-01 12:05:45 -040070encryptedPrivateKeyPEM = """-----BEGIN RSA PRIVATE KEY-----
71Proc-Type: 4,ENCRYPTED
72DEK-Info: DES-EDE3-CBC,9573604A18579E9E
Jean-Paul Calderone5ef86512008-04-26 19:06:28 -040073
Jean-Paul Calderone20131f52009-04-01 12:05:45 -040074SHOho56WxDkT0ht10UTeKc0F5u8cqIa01kzFAmETw0MAs8ezYtK15NPdCXUm3X/2
75a17G7LSF5bkxOgZ7vpXyMzun/owrj7CzvLxyncyEFZWvtvzaAhPhvTJtTIB3kf8B
768+qRcpTGK7NgXEgYBW5bj1y4qZkD4zCL9o9NQzsKI3Ie8i0239jsDOWR38AxjXBH
77mGwAQ4Z6ZN5dnmM4fhMIWsmFf19sNyAML4gHenQCHhmXbjXeVq47aC2ProInJbrm
78+00TcisbAQ40V9aehVbcDKtS4ZbMVDwncAjpXpcncC54G76N6j7F7wL7L/FuXa3A
79fvSVy9n2VfF/pJ3kYSflLHH2G/DFxjF7dl0GxhKPxJjp3IJi9VtuvmN9R2jZWLQF
80tfC8dXgy/P9CfFQhlinqBTEwgH0oZ/d4k4NVFDSdEMaSdmBAjlHpc+Vfdty3HVnV
81rKXj//wslsFNm9kIwJGIgKUa/n2jsOiydrsk1mgH7SmNCb3YHgZhbbnq0qLat/HC
82gHDt3FHpNQ31QzzL3yrenFB2L9osIsnRsDTPFNi4RX4SpDgNroxOQmyzCCV6H+d4
83o1mcnNiZSdxLZxVKccq0AfRpHqpPAFnJcQHP6xyT9MZp6fBa0XkxDnt9kNU8H3Qw
847SJWZ69VXjBUzMlQViLuaWMgTnL+ZVyFZf9hTF7U/ef4HMLMAVNdiaGG+G+AjCV/
85MbzjS007Oe4qqBnCWaFPSnJX6uLApeTbqAxAeyCql56ULW5x6vDMNC3dwjvS/CEh
8611n8RkgFIQA0AhuKSIg3CbuartRsJnWOLwgLTzsrKYL4yRog1RJrtw==
87-----END RSA PRIVATE KEY-----
88"""
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -040089encryptedPrivateKeyPEMPassphrase = "foobar"
90
91
Jean-Paul Calderoneac930e12008-03-06 18:50:51 -050092class _Python23TestCaseHelper:
Jean-Paul Calderone7da26a72008-03-06 00:35:20 -050093 # Python 2.3 compatibility.
94 def assertTrue(self, *a, **kw):
95 return self.failUnless(*a, **kw)
96
97
Jean-Paul Calderone7535dab2008-03-06 18:53:11 -050098 def assertFalse(self, *a, **kw):
99 return self.failIf(*a, **kw)
100
101
Jean-Paul Calderone391585f2008-12-31 14:36:31 -0500102
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500103class X509ExtTests(TestCase, _Python23TestCaseHelper):
104 def test_construction(self):
105 """
106 L{X509Extension} accepts an extension type name, a critical flag,
107 and an extension value and returns an L{X509ExtensionType} instance.
108 """
Jean-Paul Calderone2ee1e7c2008-12-31 14:58:38 -0500109 basic = X509Extension('basicConstraints', True, 'CA:true')
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500110 self.assertTrue(
111 isinstance(basic, X509ExtensionType),
112 "%r is of type %r, should be %r" % (
113 basic, type(basic), X509ExtensionType))
114
Jean-Paul Calderone2ee1e7c2008-12-31 14:58:38 -0500115 comment = X509Extension('nsComment', False, 'pyOpenSSL unit test')
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500116 self.assertTrue(
117 isinstance(comment, X509ExtensionType),
118 "%r is of type %r, should be %r" % (
119 comment, type(comment), X509ExtensionType))
120
121
Jean-Paul Calderone391585f2008-12-31 14:36:31 -0500122 def test_invalid_extension(self):
123 """
124 L{X509Extension} raises something if it is passed a bad extension
125 name or value.
126 """
127 self.assertRaises(
128 Error, X509Extension, 'thisIsMadeUp', False, 'hi')
129 self.assertRaises(
130 Error, X509Extension, 'basicConstraints', False, 'blah blah')
131
Jean-Paul Calderone2ee1e7c2008-12-31 14:58:38 -0500132 # Exercise a weird one (an extension which uses the r2i method). This
133 # exercises the codepath that requires a non-NULL ctx to be passed to
134 # X509V3_EXT_nconf. It can't work now because we provide no
135 # configuration database. It might be made to work in the future.
136 self.assertRaises(
137 Error, X509Extension, 'proxyCertInfo', True,
138 'language:id-ppl-anyLanguage,pathlen:1,policy:text:AB')
139
Jean-Paul Calderone391585f2008-12-31 14:36:31 -0500140
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500141 def test_get_critical(self):
142 """
143 L{X509ExtensionType.get_critical} returns the value of the
144 extension's critical flag.
145 """
Jean-Paul Calderone2ee1e7c2008-12-31 14:58:38 -0500146 ext = X509Extension('basicConstraints', True, 'CA:true')
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500147 self.assertTrue(ext.get_critical())
Jean-Paul Calderone2ee1e7c2008-12-31 14:58:38 -0500148 ext = X509Extension('basicConstraints', False, 'CA:true')
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500149 self.assertFalse(ext.get_critical())
150
Jean-Paul Calderone7535dab2008-03-06 18:53:11 -0500151
Jean-Paul Calderonef8c5fab2008-12-31 15:53:48 -0500152 def test_get_short_name(self):
153 """
154 L{X509ExtensionType.get_short_name} returns a string giving the short
155 type name of the extension.
156 """
157 ext = X509Extension('basicConstraints', True, 'CA:true')
158 self.assertEqual(ext.get_short_name(), 'basicConstraints')
159 ext = X509Extension('nsComment', True, 'foo bar')
160 self.assertEqual(ext.get_short_name(), 'nsComment')
161
162
Jean-Paul Calderone391585f2008-12-31 14:36:31 -0500163
Jean-Paul Calderoneac930e12008-03-06 18:50:51 -0500164class PKeyTests(TestCase, _Python23TestCaseHelper):
165 """
166 Unit tests for L{OpenSSL.crypto.PKey}.
167 """
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500168 def test_construction(self):
169 """
170 L{PKey} takes no arguments and returns a new L{PKeyType} instance.
171 """
172 self.assertRaises(TypeError, PKey, None)
173 key = PKey()
174 self.assertTrue(
175 isinstance(key, PKeyType),
176 "%r is of type %r, should be %r" % (key, type(key), PKeyType))
177
178
179 def test_pregeneration(self):
180 """
181 L{PKeyType.bits} and L{PKeyType.type} return C{0} before the key is
182 generated.
183 """
184 key = PKey()
185 self.assertEqual(key.type(), 0)
186 self.assertEqual(key.bits(), 0)
187
188
189 def test_failedGeneration(self):
190 """
Jean-Paul Calderoneab82db72008-03-06 00:09:31 -0500191 L{PKeyType.generate_key} takes two arguments, the first giving the key
192 type as one of L{TYPE_RSA} or L{TYPE_DSA} and the second giving the
193 number of bits to generate. If an invalid type is specified or
194 generation fails, L{Error} is raised. If an invalid number of bits is
195 specified, L{ValueError} or L{Error} is raised.
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500196 """
197 key = PKey()
198 self.assertRaises(TypeError, key.generate_key)
199 self.assertRaises(TypeError, key.generate_key, 1, 2, 3)
200 self.assertRaises(TypeError, key.generate_key, "foo", "bar")
201 self.assertRaises(Error, key.generate_key, -1, 0)
Jean-Paul Calderoneab82db72008-03-06 00:09:31 -0500202
Jean-Paul Calderoneab82db72008-03-06 00:09:31 -0500203 self.assertRaises(ValueError, key.generate_key, TYPE_RSA, -1)
204 self.assertRaises(ValueError, key.generate_key, TYPE_RSA, 0)
Jean-Paul Calderoned71fe982008-03-06 00:31:50 -0500205
206 # XXX RSA generation for small values of bits is fairly buggy in a wide
207 # range of OpenSSL versions. I need to figure out what the safe lower
208 # bound for a reasonable number of OpenSSL versions is and explicitly
209 # check for that in the wrapper. The failure behavior is typically an
210 # infinite loop inside OpenSSL.
211
212 # self.assertRaises(Error, key.generate_key, TYPE_RSA, 2)
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500213
214 # XXX DSA generation seems happy with any number of bits. The DSS
215 # says bits must be between 512 and 1024 inclusive. OpenSSL's DSA
216 # generator doesn't seem to care about the upper limit at all. For
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500217 # the lower limit, it uses 512 if anything smaller is specified.
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500218 # So, it doesn't seem possible to make generate_key fail for
219 # TYPE_DSA with a bits argument which is at least an int.
220
221 # self.assertRaises(Error, key.generate_key, TYPE_DSA, -7)
222
223
224 def test_rsaGeneration(self):
225 """
226 L{PKeyType.generate_key} generates an RSA key when passed
227 L{TYPE_RSA} as a type and a reasonable number of bits.
228 """
229 bits = 128
230 key = PKey()
231 key.generate_key(TYPE_RSA, bits)
232 self.assertEqual(key.type(), TYPE_RSA)
233 self.assertEqual(key.bits(), bits)
234
235
236 def test_dsaGeneration(self):
237 """
238 L{PKeyType.generate_key} generates a DSA key when passed
239 L{TYPE_DSA} as a type and a reasonable number of bits.
240 """
241 # 512 is a magic number. The DSS (Digital Signature Standard)
242 # allows a minimum of 512 bits for DSA. DSA_generate_parameters
243 # will silently promote any value below 512 to 512.
244 bits = 512
245 key = PKey()
246 key.generate_key(TYPE_DSA, bits)
247 self.assertEqual(key.type(), TYPE_DSA)
248 self.assertEqual(key.bits(), bits)
249
250
251 def test_regeneration(self):
252 """
253 L{PKeyType.generate_key} can be called multiple times on the same
254 key to generate new keys.
255 """
256 key = PKey()
257 for type, bits in [(TYPE_RSA, 512), (TYPE_DSA, 576)]:
258 key.generate_key(type, bits)
259 self.assertEqual(key.type(), type)
260 self.assertEqual(key.bits(), bits)
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500261
262
263
Jean-Paul Calderoneac930e12008-03-06 18:50:51 -0500264class X509NameTests(TestCase, _Python23TestCaseHelper):
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500265 """
266 Unit tests for L{OpenSSL.crypto.X509Name}.
267 """
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500268 def _x509name(self, **attrs):
269 # XXX There's no other way to get a new X509Name yet.
270 name = X509().get_subject()
271 attrs = attrs.items()
272 # Make the order stable - order matters!
273 attrs.sort(lambda (k1, v1), (k2, v2): cmp(v1, v2))
274 for k, v in attrs:
275 setattr(name, k, v)
276 return name
277
278
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500279 def test_attributes(self):
280 """
281 L{X509NameType} instances have attributes for each standard (?)
282 X509Name field.
283 """
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500284 name = self._x509name()
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500285 name.commonName = "foo"
286 self.assertEqual(name.commonName, "foo")
287 self.assertEqual(name.CN, "foo")
288 name.CN = "baz"
289 self.assertEqual(name.commonName, "baz")
290 self.assertEqual(name.CN, "baz")
291 name.commonName = "bar"
292 self.assertEqual(name.commonName, "bar")
293 self.assertEqual(name.CN, "bar")
294 name.CN = "quux"
295 self.assertEqual(name.commonName, "quux")
296 self.assertEqual(name.CN, "quux")
297
298
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500299 def test_copy(self):
300 """
301 L{X509Name} creates a new L{X509NameType} instance with all the same
302 attributes as an existing L{X509NameType} instance when called with
303 one.
304 """
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500305 name = self._x509name(commonName="foo", emailAddress="bar@example.com")
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500306
307 copy = X509Name(name)
308 self.assertEqual(copy.commonName, "foo")
309 self.assertEqual(copy.emailAddress, "bar@example.com")
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500310
311 # Mutate the copy and ensure the original is unmodified.
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500312 copy.commonName = "baz"
313 self.assertEqual(name.commonName, "foo")
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500314
315 # Mutate the original and ensure the copy is unmodified.
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500316 name.emailAddress = "quux@example.com"
317 self.assertEqual(copy.emailAddress, "bar@example.com")
318
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500319
320 def test_repr(self):
321 """
322 L{repr} passed an L{X509NameType} instance should return a string
323 containing a description of the type and the NIDs which have been set
324 on it.
325 """
326 name = self._x509name(commonName="foo", emailAddress="bar")
327 self.assertEqual(
328 repr(name),
329 "<X509Name object '/emailAddress=bar/CN=foo'>")
330
331
332 def test_comparison(self):
333 """
334 L{X509NameType} instances should compare based on their NIDs.
335 """
336 def _equality(a, b, assertTrue, assertFalse):
337 assertTrue(a == b, "(%r == %r) --> False" % (a, b))
338 assertFalse(a != b)
339 assertTrue(b == a)
340 assertFalse(b != a)
341
342 def assertEqual(a, b):
343 _equality(a, b, self.assertTrue, self.assertFalse)
344
345 # Instances compare equal to themselves.
346 name = self._x509name()
347 assertEqual(name, name)
348
349 # Empty instances should compare equal to each other.
350 assertEqual(self._x509name(), self._x509name())
351
352 # Instances with equal NIDs should compare equal to each other.
353 assertEqual(self._x509name(commonName="foo"),
354 self._x509name(commonName="foo"))
355
356 # Instance with equal NIDs set using different aliases should compare
357 # equal to each other.
358 assertEqual(self._x509name(commonName="foo"),
359 self._x509name(CN="foo"))
360
361 # Instances with more than one NID with the same values should compare
362 # equal to each other.
363 assertEqual(self._x509name(CN="foo", organizationalUnitName="bar"),
364 self._x509name(commonName="foo", OU="bar"))
365
366 def assertNotEqual(a, b):
367 _equality(a, b, self.assertFalse, self.assertTrue)
368
369 # Instances with different values for the same NID should not compare
370 # equal to each other.
371 assertNotEqual(self._x509name(CN="foo"),
372 self._x509name(CN="bar"))
373
374 # Instances with different NIDs should not compare equal to each other.
375 assertNotEqual(self._x509name(CN="foo"),
376 self._x509name(OU="foo"))
377
378 def _inequality(a, b, assertTrue, assertFalse):
379 assertTrue(a < b)
380 assertTrue(a <= b)
381 assertTrue(b > a)
382 assertTrue(b >= a)
383 assertFalse(a > b)
384 assertFalse(a >= b)
385 assertFalse(b < a)
386 assertFalse(b <= a)
387
388 def assertLessThan(a, b):
389 _inequality(a, b, self.assertTrue, self.assertFalse)
390
391 # An X509Name with a NID with a value which sorts less than the value
392 # of the same NID on another X509Name compares less than the other
393 # X509Name.
394 assertLessThan(self._x509name(CN="abc"),
395 self._x509name(CN="def"))
396
397 def assertGreaterThan(a, b):
398 _inequality(a, b, self.assertFalse, self.assertTrue)
399
400 # An X509Name with a NID with a value which sorts greater than the
401 # value of the same NID on another X509Name compares greater than the
402 # other X509Name.
403 assertGreaterThan(self._x509name(CN="def"),
404 self._x509name(CN="abc"))
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500405
406
Jean-Paul Calderone110cd092008-03-24 17:27:42 -0400407 def test_hash(self):
408 """
409 L{X509Name.hash} returns an integer hash based on the value of the
410 name.
411 """
412 a = self._x509name(CN="foo")
413 b = self._x509name(CN="foo")
414 self.assertEqual(a.hash(), b.hash())
415 a.CN = "bar"
416 self.assertNotEqual(a.hash(), b.hash())
417
418
Jean-Paul Calderonee957a002008-03-25 15:16:51 -0400419 def test_der(self):
420 """
421 L{X509Name.der} returns the DER encoded form of the name.
422 """
423 a = self._x509name(CN="foo", C="US")
424 self.assertEqual(
425 a.der(),
426 '0\x1b1\x0b0\t\x06\x03U\x04\x06\x13\x02US'
427 '1\x0c0\n\x06\x03U\x04\x03\x13\x03foo')
428
429
Jean-Paul Calderonec54cc182008-03-26 21:11:07 -0400430 def test_get_components(self):
431 """
432 L{X509Name.get_components} returns a C{list} of two-tuples of C{str}
433 giving the NIDs and associated values which make up the name.
434 """
435 a = self._x509name()
436 self.assertEqual(a.get_components(), [])
437 a.CN = "foo"
438 self.assertEqual(a.get_components(), [("CN", "foo")])
439 a.organizationalUnitName = "bar"
440 self.assertEqual(
441 a.get_components(),
442 [("CN", "foo"), ("OU", "bar")])
443
Jean-Paul Calderone110cd092008-03-24 17:27:42 -0400444
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -0400445class _PKeyInteractionTestsMixin:
446 """
447 Tests which involve another thing and a PKey.
448 """
449 def signable(self):
450 """
451 Return something with a C{set_pubkey}, C{set_pubkey}, and C{sign} method.
452 """
453 raise NotImplementedError()
454
455
456 def test_signWithUngenerated(self):
457 """
458 L{X509Req.sign} raises L{ValueError} when pass a L{PKey} with no parts.
459 """
460 request = self.signable()
461 key = PKey()
462 self.assertRaises(ValueError, request.sign, key, 'MD5')
463
464
465 def test_signWithPublicKey(self):
466 """
467 L{X509Req.sign} raises L{ValueError} when pass a L{PKey} with no
468 private part as the signing key.
469 """
470 request = self.signable()
471 key = PKey()
472 key.generate_key(TYPE_RSA, 512)
473 request.set_pubkey(key)
474 pub = request.get_pubkey()
475 self.assertRaises(ValueError, request.sign, pub, 'MD5')
476
477
478
479class X509ReqTests(TestCase, _PKeyInteractionTestsMixin, _Python23TestCaseHelper):
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500480 """
481 Tests for L{OpenSSL.crypto.X509Req}.
482 """
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -0400483 def signable(self):
484 """
485 Create and return a new L{X509Req}.
486 """
487 return X509Req()
488
489
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500490 def test_construction(self):
491 """
492 L{X509Req} takes no arguments and returns an L{X509ReqType} instance.
493 """
494 request = X509Req()
495 self.assertTrue(
496 isinstance(request, X509ReqType),
497 "%r is of type %r, should be %r" % (request, type(request), X509ReqType))
498
499
Jean-Paul Calderone8dd19b82008-12-28 20:41:16 -0500500 def test_version(self):
501 """
502 L{X509ReqType.set_version} sets the X.509 version of the certificate
503 request. L{X509ReqType.get_version} returns the X.509 version of
504 the certificate request. The initial value of the version is 0.
505 """
506 request = X509Req()
507 self.assertEqual(request.get_version(), 0)
508 request.set_version(1)
509 self.assertEqual(request.get_version(), 1)
510 request.set_version(3)
511 self.assertEqual(request.get_version(), 3)
512
513
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500514 def test_get_subject(self):
515 """
516 L{X509ReqType.get_subject} returns an L{X509Name} for the subject of
517 the request and which is valid even after the request object is
518 otherwise dead.
519 """
520 request = X509Req()
521 subject = request.get_subject()
522 self.assertTrue(
523 isinstance(subject, X509NameType),
524 "%r is of type %r, should be %r" % (subject, type(subject), X509NameType))
525 subject.commonName = "foo"
526 self.assertEqual(request.get_subject().commonName, "foo")
527 del request
528 subject.commonName = "bar"
529 self.assertEqual(subject.commonName, "bar")
Jean-Paul Calderone78381d22008-03-06 23:35:22 -0500530
531
532
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -0400533class X509Tests(TestCase, _PKeyInteractionTestsMixin, _Python23TestCaseHelper):
Jean-Paul Calderone78381d22008-03-06 23:35:22 -0500534 """
535 Tests for L{OpenSSL.crypto.X509}.
536 """
Jean-Paul Calderone5ef86512008-04-26 19:06:28 -0400537 pemData = cleartextCertificatePEM + cleartextPrivateKeyPEM
Jean-Paul Calderone8114b452008-03-25 15:27:59 -0400538
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -0400539 def signable(self):
540 """
541 Create and return a new L{X509}.
542 """
543 return X509()
544
545
Jean-Paul Calderone78381d22008-03-06 23:35:22 -0500546 def test_construction(self):
547 """
548 L{X509} takes no arguments and returns an instance of L{X509Type}.
549 """
550 certificate = X509()
551 self.assertTrue(
552 isinstance(certificate, X509Type),
553 "%r is of type %r, should be %r" % (certificate,
554 type(certificate),
555 X509Type))
556
557
558 def test_serial_number(self):
559 """
560 The serial number of an L{X509Type} can be retrieved and modified with
561 L{X509Type.get_serial_number} and L{X509Type.set_serial_number}.
562 """
563 certificate = X509()
564 self.assertRaises(TypeError, certificate.set_serial_number)
565 self.assertRaises(TypeError, certificate.set_serial_number, 1, 2)
566 self.assertRaises(TypeError, certificate.set_serial_number, "1")
567 self.assertRaises(TypeError, certificate.set_serial_number, 5.5)
568 self.assertEqual(certificate.get_serial_number(), 0)
569 certificate.set_serial_number(1)
570 self.assertEqual(certificate.get_serial_number(), 1)
571 certificate.set_serial_number(2 ** 32 + 1)
572 self.assertEqual(certificate.get_serial_number(), 2 ** 32 + 1)
573 certificate.set_serial_number(2 ** 64 + 1)
574 self.assertEqual(certificate.get_serial_number(), 2 ** 64 + 1)
Jean-Paul Calderone525ef802008-03-09 20:39:42 -0400575 certificate.set_serial_number(2 ** 128 + 1)
576 self.assertEqual(certificate.get_serial_number(), 2 ** 128 + 1)
577
578
579 def _setBoundTest(self, which):
580 """
581 L{X509Type.set_notBefore} takes a string in the format of an ASN1
582 GENERALIZEDTIME and sets the beginning of the certificate's validity
583 period to it.
584 """
585 certificate = X509()
586 set = getattr(certificate, 'set_not' + which)
587 get = getattr(certificate, 'get_not' + which)
588
Jean-Paul Calderonee0615b52008-03-09 21:44:46 -0400589 # Starts with no value.
590 self.assertEqual(get(), None)
591
Jean-Paul Calderone525ef802008-03-09 20:39:42 -0400592 # GMT (Or is it UTC?) -exarkun
593 when = "20040203040506Z"
594 set(when)
595 self.assertEqual(get(), when)
596
597 # A plus two hours and thirty minutes offset
598 when = "20040203040506+0530"
599 set(when)
600 self.assertEqual(get(), when)
601
602 # A minus one hour fifteen minutes offset
603 when = "20040203040506-0115"
604 set(when)
605 self.assertEqual(get(), when)
606
607 # An invalid string results in a ValueError
608 self.assertRaises(ValueError, set, "foo bar")
609
610
611 def test_set_notBefore(self):
612 """
613 L{X509Type.set_notBefore} takes a string in the format of an ASN1
614 GENERALIZEDTIME and sets the beginning of the certificate's validity
615 period to it.
616 """
617 self._setBoundTest("Before")
618
619
620 def test_set_notAfter(self):
621 """
622 L{X509Type.set_notAfter} takes a string in the format of an ASN1
623 GENERALIZEDTIME and sets the end of the certificate's validity period
624 to it.
625 """
626 self._setBoundTest("After")
Jean-Paul Calderone76576d52008-03-24 16:04:46 -0400627
628
Jean-Paul Calderone38a646d2008-03-25 15:16:18 -0400629 def test_get_notBefore(self):
630 """
631 L{X509Type.get_notBefore} returns a string in the format of an ASN1
632 GENERALIZEDTIME even for certificates which store it as UTCTIME
633 internally.
634 """
Jean-Paul Calderone8114b452008-03-25 15:27:59 -0400635 cert = load_certificate(FILETYPE_PEM, self.pemData)
Jean-Paul Calderone20131f52009-04-01 12:05:45 -0400636 self.assertEqual(cert.get_notBefore(), "20090325123658Z")
Jean-Paul Calderone38a646d2008-03-25 15:16:18 -0400637
638
639 def test_get_notAfter(self):
640 """
641 L{X509Type.get_notAfter} returns a string in the format of an ASN1
642 GENERALIZEDTIME even for certificates which store it as UTCTIME
643 internally.
644 """
Jean-Paul Calderone8114b452008-03-25 15:27:59 -0400645 cert = load_certificate(FILETYPE_PEM, self.pemData)
Jean-Paul Calderone20131f52009-04-01 12:05:45 -0400646 self.assertEqual(cert.get_notAfter(), "20170611123658Z")
Jean-Paul Calderone38a646d2008-03-25 15:16:18 -0400647
648
Jean-Paul Calderone76576d52008-03-24 16:04:46 -0400649 def test_digest(self):
650 """
651 L{X509.digest} returns a string giving ":"-separated hex-encoded words
652 of the digest of the certificate.
653 """
654 cert = X509()
655 self.assertEqual(
656 cert.digest("md5"),
657 "A8:EB:07:F8:53:25:0A:F2:56:05:C5:A5:C4:C4:C7:15")
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -0400658
659
660
Jean-Paul Calderone6fe60c22008-04-26 20:04:53 -0400661class FunctionTests(TestCase, _Python23TestCaseHelper):
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -0400662 """
663 Tests for free-functions in the L{OpenSSL.crypto} module.
664 """
665 def test_load_privatekey_wrongPassphrase(self):
666 """
667 L{load_privatekey} raises L{OpenSSL.crypto.Error} when it is passed an
668 encrypted PEM and an incorrect passphrase.
669 """
670 self.assertRaises(
671 Error,
672 load_privatekey, FILETYPE_PEM, encryptedPrivateKeyPEM, "quack")
673
674
675 def test_load_privatekey_passphrase(self):
676 """
677 L{load_privatekey} can create a L{PKey} object from an encrypted PEM
678 string if given the passphrase.
679 """
680 key = load_privatekey(
681 FILETYPE_PEM, encryptedPrivateKeyPEM,
682 encryptedPrivateKeyPEMPassphrase)
683 self.assertTrue(isinstance(key, PKeyType))
684
685
686 def test_load_privatekey_wrongPassphraseCallback(self):
687 """
688 L{load_privatekey} raises L{OpenSSL.crypto.Error} when it is passed an
689 encrypted PEM and a passphrase callback which returns an incorrect
690 passphrase.
691 """
692 called = []
693 def cb(*a):
694 called.append(None)
695 return "quack"
696 self.assertRaises(
697 Error,
698 load_privatekey, FILETYPE_PEM, encryptedPrivateKeyPEM, cb)
699 self.assertTrue(called)
700
701 def test_load_privatekey_passphraseCallback(self):
702 """
703 L{load_privatekey} can create a L{PKey} object from an encrypted PEM
704 string if given a passphrase callback which returns the correct
705 password.
706 """
707 called = []
708 def cb(writing):
709 called.append(writing)
710 return encryptedPrivateKeyPEMPassphrase
711 key = load_privatekey(FILETYPE_PEM, encryptedPrivateKeyPEM, cb)
712 self.assertTrue(isinstance(key, PKeyType))
713 self.assertEqual(called, [False])
714
715
716 def test_dump_privatekey_passphrase(self):
717 """
718 L{dump_privatekey} writes an encrypted PEM when given a passphrase.
719 """
720 passphrase = "foo"
721 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
722 pem = dump_privatekey(FILETYPE_PEM, key, "blowfish", passphrase)
723 self.assertTrue(isinstance(pem, str))
724 loadedKey = load_privatekey(FILETYPE_PEM, pem, passphrase)
725 self.assertTrue(isinstance(loadedKey, PKeyType))
726 self.assertEqual(loadedKey.type(), key.type())
727 self.assertEqual(loadedKey.bits(), key.bits())
728
Rick Dean5b7b6372009-04-01 11:34:06 -0500729 def test_dump_certificate(self):
730 """
731 L{dump_certificate} writes PEM, DER, and text.
732 """
733 pemData = cleartextCertificatePEM + cleartextPrivateKeyPEM
734 cert = load_certificate(FILETYPE_PEM, pemData)
735 dumped_pem = dump_certificate(FILETYPE_PEM, cert)
736 self.assertEqual(dumped_pem, cleartextCertificatePEM)
737 dumped_der = dump_certificate(FILETYPE_ASN1, cert)
738 good_der = Popen(["openssl", "x509", "-outform", "DER"], \
739 stdin=PIPE, stdout=PIPE).communicate(input=str(dumped_pem))[0]
740 self.assertEqual(dumped_der, good_der)
741 cert2 = load_certificate(FILETYPE_ASN1, dumped_der)
742 dumped_pem2 = dump_certificate(FILETYPE_PEM, cert2)
743 self.assertEqual(dumped_pem2, cleartextCertificatePEM)
744 dumped_text = dump_certificate(FILETYPE_TEXT, cert)
745 good_text = Popen(["openssl", "x509", "-noout", "-text"], \
746 stdin=PIPE, stdout=PIPE).communicate(input=str(dumped_pem))[0]
747 self.assertEqual(dumped_text, good_text)
748
749
750 def test_dump_privatekey(self):
751 """
752 L{dump_privatekey} writes a PEM, DER, and text.
753 """
754 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
755 dumped_pem = dump_privatekey(FILETYPE_PEM, key)
756 self.assertEqual(dumped_pem, cleartextPrivateKeyPEM)
757 dumped_der = dump_privatekey(FILETYPE_ASN1, key)
758 good_der = Popen(["openssl", "rsa", "-outform", "DER"], \
759 stdin=PIPE, stdout=PIPE).communicate(input=str(dumped_pem))[0]
760 self.assertEqual(dumped_der, good_der)
761 key2 = load_privatekey(FILETYPE_ASN1, dumped_der)
762 dumped_pem2 = dump_privatekey(FILETYPE_PEM, key2)
763 self.assertEqual(dumped_pem2, cleartextPrivateKeyPEM)
764 dumped_text = dump_privatekey(FILETYPE_TEXT, key)
765 good_text = Popen(["openssl", "rsa", "-noout", "-text"], \
766 stdin=PIPE, stdout=PIPE).communicate(input=str(dumped_pem))[0]
767 self.assertEqual(dumped_text, good_text)
768
769 def test_dump_certificate_request(self):
770 """
771 L{dump_certificate_request} writes a PEM, DER, and text.
772 """
773 req = load_certificate_request(FILETYPE_PEM, cleartextCertificateRequestPEM)
774 dumped_pem = dump_certificate_request(FILETYPE_PEM, req)
775 self.assertEqual(dumped_pem, cleartextCertificateRequestPEM)
776 dumped_der = dump_certificate_request(FILETYPE_ASN1, req)
777 good_der = Popen(["openssl", "req", "-outform", "DER"], \
778 stdin=PIPE, stdout=PIPE).communicate(input=str(dumped_pem))[0]
779 self.assertEqual(dumped_der, good_der)
780 req2 = load_certificate_request(FILETYPE_ASN1, dumped_der)
781 dumped_pem2 = dump_certificate_request(FILETYPE_PEM, req2)
782 self.assertEqual(dumped_pem2, cleartextCertificateRequestPEM)
783 dumped_text = dump_certificate_request(FILETYPE_TEXT, req)
784 good_text = Popen(["openssl", "req", "-noout", "-text"], \
785 stdin=PIPE, stdout=PIPE).communicate(input=str(dumped_pem))[0]
786 self.assertEqual(dumped_text, good_text)
787
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -0400788
789 def test_dump_privatekey_passphraseCallback(self):
790 """
791 L{dump_privatekey} writes an encrypted PEM when given a callback which
792 returns the correct passphrase.
793 """
794 passphrase = "foo"
795 called = []
796 def cb(writing):
797 called.append(writing)
798 return passphrase
799 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
800 pem = dump_privatekey(FILETYPE_PEM, key, "blowfish", cb)
801 self.assertTrue(isinstance(pem, str))
802 self.assertEqual(called, [True])
803 loadedKey = load_privatekey(FILETYPE_PEM, pem, passphrase)
804 self.assertTrue(isinstance(loadedKey, PKeyType))
805 self.assertEqual(loadedKey.type(), key.type())
806 self.assertEqual(loadedKey.bits(), key.bits())
Rick Dean5b7b6372009-04-01 11:34:06 -0500807
808
809if __name__ == '__main__':
810 main()
811