blob: a3fc79d964d72aedc0dcd66afb4f9bf071ff09af [file] [log] [blame]
Jean-Paul Calderone8671c852011-03-02 19:26:20 -05001# Copyright (c) Jean-Paul Calderone
2# See LICENSE file for details.
Jean-Paul Calderone8b63d452008-03-21 18:31:12 -04003
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -05004"""
Jonathan Ballet648875f2011-07-16 14:14:58 +09005Unit tests for :py:mod:`OpenSSL.crypto`.
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -05006"""
7
Jean-Paul Calderone0b88b6a2009-07-05 12:44:41 -04008from unittest import main
9
Ziga Seilnacht781295a2009-12-22 14:58:01 +010010import os, re, sys
Jean-Paul Calderone62ca8da2010-08-11 19:58:08 -040011from subprocess import PIPE, Popen
Rick Dean47262da2009-07-08 16:17:17 -050012from datetime import datetime, timedelta
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -050013
14from OpenSSL.crypto import TYPE_RSA, TYPE_DSA, Error, PKey, PKeyType
Jean-Paul Calderone78381d22008-03-06 23:35:22 -050015from OpenSSL.crypto import X509, X509Type, X509Name, X509NameType
Jean-Paul Calderonea63714c2013-03-05 17:02:26 -080016from OpenSSL.crypto import X509Store, X509StoreType, X509Req, X509ReqType
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -050017from OpenSSL.crypto import X509Extension, X509ExtensionType
Rick Dean5b7b6372009-04-01 11:34:06 -050018from OpenSSL.crypto import load_certificate, load_privatekey
Jean-Paul Calderonef17e4212009-04-01 14:21:40 -040019from OpenSSL.crypto import FILETYPE_PEM, FILETYPE_ASN1, FILETYPE_TEXT
Jean-Paul Calderone71919862009-04-01 13:01:19 -040020from OpenSSL.crypto import dump_certificate, load_certificate_request
21from OpenSSL.crypto import dump_certificate_request, dump_privatekey
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -040022from OpenSSL.crypto import PKCS7Type, load_pkcs7_data
Jean-Paul Calderone9178ee62010-01-25 17:55:30 -050023from OpenSSL.crypto import PKCS12, PKCS12Type, load_pkcs12
Rick Dean536ba022009-07-24 23:57:27 -050024from OpenSSL.crypto import CRL, Revoked, load_crl
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -040025from OpenSSL.crypto import NetscapeSPKI, NetscapeSPKIType
Jean-Paul Calderonef3cb9d82010-06-22 10:29:33 -040026from OpenSSL.crypto import sign, verify
Jean-Paul Calderone9e4eeae2010-08-22 21:32:52 -040027from OpenSSL.test.util import TestCase, bytes, b
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -040028
Jean-Paul Calderone9da338d2011-05-04 11:40:54 -040029def normalize_certificate_pem(pem):
30 return dump_certificate(FILETYPE_PEM, load_certificate(FILETYPE_PEM, pem))
31
32
33def normalize_privatekey_pem(pem):
34 return dump_privatekey(FILETYPE_PEM, load_privatekey(FILETYPE_PEM, pem))
35
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -040036
37root_cert_pem = b("""-----BEGIN CERTIFICATE-----
Rick Dean94e46fd2009-07-18 14:51:24 -050038MIIC7TCCAlagAwIBAgIIPQzE4MbeufQwDQYJKoZIhvcNAQEFBQAwWDELMAkGA1UE
39BhMCVVMxCzAJBgNVBAgTAklMMRAwDgYDVQQHEwdDaGljYWdvMRAwDgYDVQQKEwdU
40ZXN0aW5nMRgwFgYDVQQDEw9UZXN0aW5nIFJvb3QgQ0EwIhgPMjAwOTAzMjUxMjM2
41NThaGA8yMDE3MDYxMTEyMzY1OFowWDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAklM
42MRAwDgYDVQQHEwdDaGljYWdvMRAwDgYDVQQKEwdUZXN0aW5nMRgwFgYDVQQDEw9U
43ZXN0aW5nIFJvb3QgQ0EwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAPmaQumL
44urpE527uSEHdL1pqcDRmWzu+98Y6YHzT/J7KWEamyMCNZ6fRW1JCR782UQ8a07fy
452xXsKy4WdKaxyG8CcatwmXvpvRQ44dSANMihHELpANTdyVp6DCysED6wkQFurHlF
461dshEaJw8b/ypDhmbVIo6Ci1xvCJqivbLFnbAgMBAAGjgbswgbgwHQYDVR0OBBYE
47FINVdy1eIfFJDAkk51QJEo3IfgSuMIGIBgNVHSMEgYAwfoAUg1V3LV4h8UkMCSTn
48VAkSjch+BK6hXKRaMFgxCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJJTDEQMA4GA1UE
49BxMHQ2hpY2FnbzEQMA4GA1UEChMHVGVzdGluZzEYMBYGA1UEAxMPVGVzdGluZyBS
50b290IENBggg9DMTgxt659DAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4GB
51AGGCDazMJGoWNBpc03u6+smc95dEead2KlZXBATOdFT1VesY3+nUOqZhEhTGlDMi
52hkgaZnzoIq/Uamidegk4hirsCT/R+6vsKAAxNTcBjUeZjlykCJWy5ojShGftXIKY
53w/njVbKMXrvc83qmTdGl3TAM0fxQIpqgcglFLveEBgzn
54-----END CERTIFICATE-----
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -040055""")
Rick Dean94e46fd2009-07-18 14:51:24 -050056
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -040057root_key_pem = b("""-----BEGIN RSA PRIVATE KEY-----
Rick Dean94e46fd2009-07-18 14:51:24 -050058MIICXQIBAAKBgQD5mkLpi7q6ROdu7khB3S9aanA0Zls7vvfGOmB80/yeylhGpsjA
59jWen0VtSQke/NlEPGtO38tsV7CsuFnSmschvAnGrcJl76b0UOOHUgDTIoRxC6QDU
603claegwsrBA+sJEBbqx5RdXbIRGicPG/8qQ4Zm1SKOgotcbwiaor2yxZ2wIDAQAB
61AoGBAPCgMpmLxzwDaUmcFbTJUvlLW1hoxNNYSu2jIZm1k/hRAcE60JYwvBkgz3UB
62yMEh0AtLxYe0bFk6EHah11tMUPgscbCq73snJ++8koUw+csk22G65hOs51bVb7Aa
636JBe67oLzdtvgCUFAA2qfrKzWRZzAdhUirQUZgySZk+Xq1pBAkEA/kZG0A6roTSM
64BVnx7LnPfsycKUsTumorpXiylZJjTi9XtmzxhrYN6wgZlDOOwOLgSQhszGpxVoMD
65u3gByT1b2QJBAPtL3mSKdvwRu/+40zaZLwvSJRxaj0mcE4BJOS6Oqs/hS1xRlrNk
66PpQ7WJ4yM6ZOLnXzm2mKyxm50Mv64109FtMCQQDOqS2KkjHaLowTGVxwC0DijMfr
67I9Lf8sSQk32J5VWCySWf5gGTfEnpmUa41gKTMJIbqZZLucNuDcOtzUaeWZlZAkA8
68ttXigLnCqR486JDPTi9ZscoZkZ+w7y6e/hH8t6d5Vjt48JVyfjPIaJY+km58LcN3
696AWSeGAdtRFHVzR7oHjVAkB4hutvxiOeiIVQNBhM6RSI9aBPMI21DoX2JRoxvNW2
70cbvAhow217X9V0dVerEOKxnNYspXRrh36h7k4mQA+sDq
71-----END RSA PRIVATE KEY-----
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -040072""")
Rick Dean94e46fd2009-07-18 14:51:24 -050073
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -040074server_cert_pem = b("""-----BEGIN CERTIFICATE-----
Rick Dean94e46fd2009-07-18 14:51:24 -050075MIICKDCCAZGgAwIBAgIJAJn/HpR21r/8MA0GCSqGSIb3DQEBBQUAMFgxCzAJBgNV
76BAYTAlVTMQswCQYDVQQIEwJJTDEQMA4GA1UEBxMHQ2hpY2FnbzEQMA4GA1UEChMH
77VGVzdGluZzEYMBYGA1UEAxMPVGVzdGluZyBSb290IENBMCIYDzIwMDkwMzI1MTIz
78NzUzWhgPMjAxNzA2MTExMjM3NTNaMBgxFjAUBgNVBAMTDWxvdmVseSBzZXJ2ZXIw
79gZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAL6m+G653V0tpBC/OKl22VxOi2Cv
80lK4TYu9LHSDP9uDVTe7V5D5Tl6qzFoRRx5pfmnkqT5B+W9byp2NU3FC5hLm5zSAr
81b45meUhjEJ/ifkZgbNUjHdBIGP9MAQUHZa5WKdkGIJvGAvs8UzUqlr4TBWQIB24+
82lJ+Ukk/CRgasrYwdAgMBAAGjNjA0MB0GA1UdDgQWBBS4kC7Ij0W1TZXZqXQFAM2e
83gKEG2DATBgNVHSUEDDAKBggrBgEFBQcDATANBgkqhkiG9w0BAQUFAAOBgQBh30Li
84dJ+NlxIOx5343WqIBka3UbsOb2kxWrbkVCrvRapCMLCASO4FqiKWM+L0VDBprqIp
852mgpFQ6FHpoIENGvJhdEKpptQ5i7KaGhnDNTfdy3x1+h852G99f1iyj0RmbuFcM8
86uzujnS8YXWvM7DM1Ilozk4MzPug8jzFp5uhKCQ==
87-----END CERTIFICATE-----
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -040088""")
Rick Dean94e46fd2009-07-18 14:51:24 -050089
Jean-Paul Calderone9da338d2011-05-04 11:40:54 -040090server_key_pem = normalize_privatekey_pem(b("""-----BEGIN RSA PRIVATE KEY-----
Rick Dean94e46fd2009-07-18 14:51:24 -050091MIICWwIBAAKBgQC+pvhuud1dLaQQvzipdtlcTotgr5SuE2LvSx0gz/bg1U3u1eQ+
92U5eqsxaEUceaX5p5Kk+QflvW8qdjVNxQuYS5uc0gK2+OZnlIYxCf4n5GYGzVIx3Q
93SBj/TAEFB2WuVinZBiCbxgL7PFM1Kpa+EwVkCAduPpSflJJPwkYGrK2MHQIDAQAB
94AoGAbwuZ0AR6JveahBaczjfnSpiFHf+mve2UxoQdpyr6ROJ4zg/PLW5K/KXrC48G
95j6f3tXMrfKHcpEoZrQWUfYBRCUsGD5DCazEhD8zlxEHahIsqpwA0WWssJA2VOLEN
96j6DuV2pCFbw67rfTBkTSo32ahfXxEKev5KswZk0JIzH3ooECQQDgzS9AI89h0gs8
97Dt+1m11Rzqo3vZML7ZIyGApUzVan+a7hbc33nbGRkAXjHaUBJO31it/H6dTO+uwX
98msWwNG5ZAkEA2RyFKs5xR5USTFaKLWCgpH/ydV96KPOpBND7TKQx62snDenFNNbn
99FwwOhpahld+vqhYk+pfuWWUpQciE+Bu7ZQJASjfT4sQv4qbbKK/scePicnDdx9th
1004e1EeB9xwb+tXXXUo/6Bor/AcUNwfiQ6Zt9PZOK9sR3lMZSsP7rMi7kzuQJABie6
1011sXXjFH7nNJvRG4S39cIxq8YRYTy68II/dlB2QzGpKxV/POCxbJ/zu0CU79tuYK7
102NaeNCFfH3aeTrX0LyQJAMBWjWmeKM2G2sCExheeQK0ROnaBC8itCECD4Jsve4nqf
103r50+LF74iLXFwqysVCebPKMOpDWp/qQ1BbJQIPs7/A==
104-----END RSA PRIVATE KEY-----
Jean-Paul Calderone9da338d2011-05-04 11:40:54 -0400105"""))
Rick Dean94e46fd2009-07-18 14:51:24 -0500106
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -0400107client_cert_pem = b("""-----BEGIN CERTIFICATE-----
Rick Dean94e46fd2009-07-18 14:51:24 -0500108MIICJjCCAY+gAwIBAgIJAKxpFI5lODkjMA0GCSqGSIb3DQEBBQUAMFgxCzAJBgNV
109BAYTAlVTMQswCQYDVQQIEwJJTDEQMA4GA1UEBxMHQ2hpY2FnbzEQMA4GA1UEChMH
110VGVzdGluZzEYMBYGA1UEAxMPVGVzdGluZyBSb290IENBMCIYDzIwMDkwMzI1MTIz
111ODA1WhgPMjAxNzA2MTExMjM4MDVaMBYxFDASBgNVBAMTC3VnbHkgY2xpZW50MIGf
112MA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDAZh/SRtNm5ntMT4qb6YzEpTroMlq2
113rn+GrRHRiZ+xkCw/CGNhbtPir7/QxaUj26BSmQrHw1bGKEbPsWiW7bdXSespl+xK
114iku4G/KvnnmWdeJHqsiXeUZtqurMELcPQAw9xPHEuhqqUJvvEoMTsnCEqGM+7Dtb
115oCRajYyHfluARQIDAQABozYwNDAdBgNVHQ4EFgQUNQB+qkaOaEVecf1J3TTUtAff
1160fAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQEFBQADgYEAyv/Jh7gM
117Q3OHvmsFEEvRI+hsW8y66zK4K5de239Y44iZrFYkt7Q5nBPMEWDj4F2hLYWL/qtI
1189Zdr0U4UDCU9SmmGYh4o7R4TZ5pGFvBYvjhHbkSFYFQXZxKUi+WUxplP6I0wr2KJ
119PSTJCjJOn3xo2NTKRgV1gaoTf2EhL+RG8TQ=
120-----END CERTIFICATE-----
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -0400121""")
Rick Dean94e46fd2009-07-18 14:51:24 -0500122
Jean-Paul Calderone22cbe502011-05-04 17:01:43 -0400123client_key_pem = normalize_privatekey_pem(b("""-----BEGIN RSA PRIVATE KEY-----
Rick Dean94e46fd2009-07-18 14:51:24 -0500124MIICXgIBAAKBgQDAZh/SRtNm5ntMT4qb6YzEpTroMlq2rn+GrRHRiZ+xkCw/CGNh
125btPir7/QxaUj26BSmQrHw1bGKEbPsWiW7bdXSespl+xKiku4G/KvnnmWdeJHqsiX
126eUZtqurMELcPQAw9xPHEuhqqUJvvEoMTsnCEqGM+7DtboCRajYyHfluARQIDAQAB
127AoGATkZ+NceY5Glqyl4mD06SdcKfV65814vg2EL7V9t8+/mi9rYL8KztSXGlQWPX
128zuHgtRoMl78yQ4ZJYOBVo+nsx8KZNRCEBlE19bamSbQLCeQMenWnpeYyQUZ908gF
129h6L9qsFVJepgA9RDgAjyDoS5CaWCdCCPCH2lDkdcqC54SVUCQQDseuduc4wi8h4t
130V8AahUn9fn9gYfhoNuM0gdguTA0nPLVWz4hy1yJiWYQe0H7NLNNTmCKiLQaJpAbb
131TC6vE8C7AkEA0Ee8CMJUc20BnGEmxwgWcVuqFWaKCo8jTH1X38FlATUsyR3krjW2
132dL3yDD9NwHxsYP7nTKp/U8MV7U9IBn4y/wJBAJl7H0/BcLeRmuJk7IqJ7b635iYB
133D/9beFUw3MUXmQXZUfyYz39xf6CDZsu1GEdEC5haykeln3Of4M9d/4Kj+FcCQQCY
134si6xwT7GzMDkk/ko684AV3KPc/h6G0yGtFIrMg7J3uExpR/VdH2KgwMkZXisSMvw
135JJEQjOMCVsEJlRk54WWjAkEAzoZNH6UhDdBK5F38rVt/y4SEHgbSfJHIAmPS32Kq
136f6GGcfNpip0Uk7q7udTKuX7Q/buZi/C4YW7u3VKAquv9NA==
137-----END RSA PRIVATE KEY-----
Jean-Paul Calderone22cbe502011-05-04 17:01:43 -0400138"""))
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -0400139
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -0400140cleartextCertificatePEM = b("""-----BEGIN CERTIFICATE-----
Jean-Paul Calderone20131f52009-04-01 12:05:45 -0400141MIIC7TCCAlagAwIBAgIIPQzE4MbeufQwDQYJKoZIhvcNAQEFBQAwWDELMAkGA1UE
142BhMCVVMxCzAJBgNVBAgTAklMMRAwDgYDVQQHEwdDaGljYWdvMRAwDgYDVQQKEwdU
143ZXN0aW5nMRgwFgYDVQQDEw9UZXN0aW5nIFJvb3QgQ0EwIhgPMjAwOTAzMjUxMjM2
144NThaGA8yMDE3MDYxMTEyMzY1OFowWDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAklM
145MRAwDgYDVQQHEwdDaGljYWdvMRAwDgYDVQQKEwdUZXN0aW5nMRgwFgYDVQQDEw9U
146ZXN0aW5nIFJvb3QgQ0EwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAPmaQumL
147urpE527uSEHdL1pqcDRmWzu+98Y6YHzT/J7KWEamyMCNZ6fRW1JCR782UQ8a07fy
1482xXsKy4WdKaxyG8CcatwmXvpvRQ44dSANMihHELpANTdyVp6DCysED6wkQFurHlF
1491dshEaJw8b/ypDhmbVIo6Ci1xvCJqivbLFnbAgMBAAGjgbswgbgwHQYDVR0OBBYE
150FINVdy1eIfFJDAkk51QJEo3IfgSuMIGIBgNVHSMEgYAwfoAUg1V3LV4h8UkMCSTn
151VAkSjch+BK6hXKRaMFgxCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJJTDEQMA4GA1UE
152BxMHQ2hpY2FnbzEQMA4GA1UEChMHVGVzdGluZzEYMBYGA1UEAxMPVGVzdGluZyBS
153b290IENBggg9DMTgxt659DAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4GB
154AGGCDazMJGoWNBpc03u6+smc95dEead2KlZXBATOdFT1VesY3+nUOqZhEhTGlDMi
155hkgaZnzoIq/Uamidegk4hirsCT/R+6vsKAAxNTcBjUeZjlykCJWy5ojShGftXIKY
156w/njVbKMXrvc83qmTdGl3TAM0fxQIpqgcglFLveEBgzn
157-----END CERTIFICATE-----
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -0400158""")
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -0400159
Jean-Paul Calderoned50d2042011-05-04 17:00:49 -0400160cleartextPrivateKeyPEM = normalize_privatekey_pem(b("""\
161-----BEGIN RSA PRIVATE KEY-----
Jean-Paul Calderone20131f52009-04-01 12:05:45 -0400162MIICXQIBAAKBgQD5mkLpi7q6ROdu7khB3S9aanA0Zls7vvfGOmB80/yeylhGpsjA
163jWen0VtSQke/NlEPGtO38tsV7CsuFnSmschvAnGrcJl76b0UOOHUgDTIoRxC6QDU
1643claegwsrBA+sJEBbqx5RdXbIRGicPG/8qQ4Zm1SKOgotcbwiaor2yxZ2wIDAQAB
165AoGBAPCgMpmLxzwDaUmcFbTJUvlLW1hoxNNYSu2jIZm1k/hRAcE60JYwvBkgz3UB
166yMEh0AtLxYe0bFk6EHah11tMUPgscbCq73snJ++8koUw+csk22G65hOs51bVb7Aa
1676JBe67oLzdtvgCUFAA2qfrKzWRZzAdhUirQUZgySZk+Xq1pBAkEA/kZG0A6roTSM
168BVnx7LnPfsycKUsTumorpXiylZJjTi9XtmzxhrYN6wgZlDOOwOLgSQhszGpxVoMD
169u3gByT1b2QJBAPtL3mSKdvwRu/+40zaZLwvSJRxaj0mcE4BJOS6Oqs/hS1xRlrNk
170PpQ7WJ4yM6ZOLnXzm2mKyxm50Mv64109FtMCQQDOqS2KkjHaLowTGVxwC0DijMfr
171I9Lf8sSQk32J5VWCySWf5gGTfEnpmUa41gKTMJIbqZZLucNuDcOtzUaeWZlZAkA8
172ttXigLnCqR486JDPTi9ZscoZkZ+w7y6e/hH8t6d5Vjt48JVyfjPIaJY+km58LcN3
1736AWSeGAdtRFHVzR7oHjVAkB4hutvxiOeiIVQNBhM6RSI9aBPMI21DoX2JRoxvNW2
174cbvAhow217X9V0dVerEOKxnNYspXRrh36h7k4mQA+sDq
175-----END RSA PRIVATE KEY-----
Jean-Paul Calderoned50d2042011-05-04 17:00:49 -0400176"""))
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -0400177
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -0400178cleartextCertificateRequestPEM = b("""-----BEGIN CERTIFICATE REQUEST-----
179MIIBnjCCAQcCAQAwXjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAklMMRAwDgYDVQQH
180EwdDaGljYWdvMRcwFQYDVQQKEw5NeSBDb21wYW55IEx0ZDEXMBUGA1UEAxMORnJl
181ZGVyaWNrIERlYW4wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBANp6Y17WzKSw
182BsUWkXdqg6tnXy8H8hA1msCMWpc+/2KJ4mbv5NyD6UD+/SqagQqulPbF/DFea9nA
183E0zhmHJELcM8gUTIlXv/cgDWnmK4xj8YkjVUiCdqKRAKeuzLG1pGmwwF5lGeJpXN
184xQn5ecR0UYSOWj6TTGXB9VyUMQzCClcBAgMBAAGgADANBgkqhkiG9w0BAQUFAAOB
185gQAAJGuF/R/GGbeC7FbFW+aJgr9ee0Xbl6nlhu7pTe67k+iiKT2dsl2ti68MVTnu
186Vrb3HUNqOkiwsJf6kCtq5oPn3QVYzTa76Dt2y3Rtzv6boRSlmlfrgS92GNma8JfR
187oICQk3nAudi6zl1Dix3BCv1pUp5KMtGn3MeDEi6QFGy2rA==
188-----END CERTIFICATE REQUEST-----
189""")
Rick Dean5b7b6372009-04-01 11:34:06 -0500190
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -0400191encryptedPrivateKeyPEM = b("""-----BEGIN RSA PRIVATE KEY-----
Jean-Paul Calderone20131f52009-04-01 12:05:45 -0400192Proc-Type: 4,ENCRYPTED
193DEK-Info: DES-EDE3-CBC,9573604A18579E9E
Jean-Paul Calderone5ef86512008-04-26 19:06:28 -0400194
Jean-Paul Calderone20131f52009-04-01 12:05:45 -0400195SHOho56WxDkT0ht10UTeKc0F5u8cqIa01kzFAmETw0MAs8ezYtK15NPdCXUm3X/2
196a17G7LSF5bkxOgZ7vpXyMzun/owrj7CzvLxyncyEFZWvtvzaAhPhvTJtTIB3kf8B
1978+qRcpTGK7NgXEgYBW5bj1y4qZkD4zCL9o9NQzsKI3Ie8i0239jsDOWR38AxjXBH
198mGwAQ4Z6ZN5dnmM4fhMIWsmFf19sNyAML4gHenQCHhmXbjXeVq47aC2ProInJbrm
199+00TcisbAQ40V9aehVbcDKtS4ZbMVDwncAjpXpcncC54G76N6j7F7wL7L/FuXa3A
200fvSVy9n2VfF/pJ3kYSflLHH2G/DFxjF7dl0GxhKPxJjp3IJi9VtuvmN9R2jZWLQF
201tfC8dXgy/P9CfFQhlinqBTEwgH0oZ/d4k4NVFDSdEMaSdmBAjlHpc+Vfdty3HVnV
202rKXj//wslsFNm9kIwJGIgKUa/n2jsOiydrsk1mgH7SmNCb3YHgZhbbnq0qLat/HC
203gHDt3FHpNQ31QzzL3yrenFB2L9osIsnRsDTPFNi4RX4SpDgNroxOQmyzCCV6H+d4
204o1mcnNiZSdxLZxVKccq0AfRpHqpPAFnJcQHP6xyT9MZp6fBa0XkxDnt9kNU8H3Qw
2057SJWZ69VXjBUzMlQViLuaWMgTnL+ZVyFZf9hTF7U/ef4HMLMAVNdiaGG+G+AjCV/
206MbzjS007Oe4qqBnCWaFPSnJX6uLApeTbqAxAeyCql56ULW5x6vDMNC3dwjvS/CEh
20711n8RkgFIQA0AhuKSIg3CbuartRsJnWOLwgLTzsrKYL4yRog1RJrtw==
208-----END RSA PRIVATE KEY-----
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -0400209""")
Jean-Paul Calderone55ec1712009-05-13 14:14:30 -0400210
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -0400211encryptedPrivateKeyPEMPassphrase = b("foobar")
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -0400212
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -0400213# Some PKCS#7 stuff. Generated with the openssl command line:
214#
215# openssl crl2pkcs7 -inform pem -outform pem -certfile s.pem -nocrl
216#
217# with a certificate and key (but the key should be irrelevant) in s.pem
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -0400218pkcs7Data = b("""\
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -0400219-----BEGIN PKCS7-----
220MIIDNwYJKoZIhvcNAQcCoIIDKDCCAyQCAQExADALBgkqhkiG9w0BBwGgggMKMIID
221BjCCAm+gAwIBAgIBATANBgkqhkiG9w0BAQQFADB7MQswCQYDVQQGEwJTRzERMA8G
222A1UEChMITTJDcnlwdG8xFDASBgNVBAsTC00yQ3J5cHRvIENBMSQwIgYDVQQDExtN
223MkNyeXB0byBDZXJ0aWZpY2F0ZSBNYXN0ZXIxHTAbBgkqhkiG9w0BCQEWDm5ncHNA
224cG9zdDEuY29tMB4XDTAwMDkxMDA5NTEzMFoXDTAyMDkxMDA5NTEzMFowUzELMAkG
225A1UEBhMCU0cxETAPBgNVBAoTCE0yQ3J5cHRvMRIwEAYDVQQDEwlsb2NhbGhvc3Qx
226HTAbBgkqhkiG9w0BCQEWDm5ncHNAcG9zdDEuY29tMFwwDQYJKoZIhvcNAQEBBQAD
227SwAwSAJBAKy+e3dulvXzV7zoTZWc5TzgApr8DmeQHTYC8ydfzH7EECe4R1Xh5kwI
228zOuuFfn178FBiS84gngaNcrFi0Z5fAkCAwEAAaOCAQQwggEAMAkGA1UdEwQCMAAw
229LAYJYIZIAYb4QgENBB8WHU9wZW5TU0wgR2VuZXJhdGVkIENlcnRpZmljYXRlMB0G
230A1UdDgQWBBTPhIKSvnsmYsBVNWjj0m3M2z0qVTCBpQYDVR0jBIGdMIGagBT7hyNp
23165w6kxXlxb8pUU/+7Sg4AaF/pH0wezELMAkGA1UEBhMCU0cxETAPBgNVBAoTCE0y
232Q3J5cHRvMRQwEgYDVQQLEwtNMkNyeXB0byBDQTEkMCIGA1UEAxMbTTJDcnlwdG8g
233Q2VydGlmaWNhdGUgTWFzdGVyMR0wGwYJKoZIhvcNAQkBFg5uZ3BzQHBvc3QxLmNv
234bYIBADANBgkqhkiG9w0BAQQFAAOBgQA7/CqT6PoHycTdhEStWNZde7M/2Yc6BoJu
235VwnW8YxGO8Sn6UJ4FeffZNcYZddSDKosw8LtPOeWoK3JINjAk5jiPQ2cww++7QGG
236/g5NDjxFZNDJP1dGiLAxPW6JXwov4v0FmdzfLOZ01jDcgQQZqEpYlgpuI5JEWUQ9
237Ho4EzbYCOaEAMQA=
238-----END PKCS7-----
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -0400239""")
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -0400240
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -0400241crlData = b("""\
Jean-Paul Calderone3eb5cc72010-01-30 15:24:40 -0500242-----BEGIN X509 CRL-----
243MIIBWzCBxTANBgkqhkiG9w0BAQQFADBYMQswCQYDVQQGEwJVUzELMAkGA1UECBMC
244SUwxEDAOBgNVBAcTB0NoaWNhZ28xEDAOBgNVBAoTB1Rlc3RpbmcxGDAWBgNVBAMT
245D1Rlc3RpbmcgUm9vdCBDQRcNMDkwNzI2MDQzNDU2WhcNMTIwOTI3MDI0MTUyWjA8
246MBUCAgOrGA8yMDA5MDcyNTIzMzQ1NlowIwICAQAYDzIwMDkwNzI1MjMzNDU2WjAM
247MAoGA1UdFQQDCgEEMA0GCSqGSIb3DQEBBAUAA4GBAEBt7xTs2htdD3d4ErrcGAw1
2484dKcVnIWTutoI7xxen26Wwvh8VCsT7i/UeP+rBl9rC/kfjWjzQk3/zleaarGTpBT
2490yp4HXRFFoRhhSE/hP+eteaPXRgrsNRLHe9ZDd69wmh7J1wMDb0m81RG7kqcbsid
250vrzEeLDRiiPl92dyyWmu
251-----END X509 CRL-----
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -0400252""")
Jean-Paul Calderonee890db32010-08-22 16:55:15 -0400253
Jean-Paul Calderone55ec1712009-05-13 14:14:30 -0400254
255# A broken RSA private key which can be used to test the error path through
256# PKey.check.
257inconsistentPrivateKeyPEM = b("""-----BEGIN RSA PRIVATE KEY-----
258MIIBPAIBAAJBAKy+e3dulvXzV7zoTZWc5TzgApr8DmeQHTYC8ydfzH7EECe4R1Xh
2595kwIzOuuFfn178FBiS84gngaNcrFi0Z5fAkCAwEaAQJBAIqm/bz4NA1H++Vx5Ewx
260OcKp3w19QSaZAwlGRtsUxrP7436QjnREM3Bm8ygU11BjkPVmtrKm6AayQfCHqJoT
261zIECIQDW0BoMoL0HOYM/mrTLhaykYAVqgIeJsPjvkEhTFXWBuQIhAM3deFAvWNu4
262nklUQ37XsCT2c9tmNt1LAT+slG2JOTTRAiAuXDtC/m3NYVwyHfFm+zKHRzHkClk2
263HjubeEgjpj32AQIhAJqMGTaZVOwevTXvvHwNeH+vRWsAYU/gbx+OQB+7VOcBAiEA
264oolb6NMg/R3enNPvS1O4UU1H8wpaF77L4yiSWlE0p4w=
265-----END RSA PRIVATE KEY-----
266""")
267
268
Jean-Paul Calderone18808652009-07-05 12:54:05 -0400269class X509ExtTests(TestCase):
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400270 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900271 Tests for :py:class:`OpenSSL.crypto.X509Extension`.
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400272 """
273
274 def setUp(self):
275 """
276 Create a new private key and start a certificate request (for a test
277 method to finish in one way or another).
278 """
Jean-Paul Calderoneef9a3dc2013-03-02 16:33:32 -0800279 super(X509ExtTests, self).setUp()
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400280 # Basic setup stuff to generate a certificate
281 self.pkey = PKey()
282 self.pkey.generate_key(TYPE_RSA, 384)
283 self.req = X509Req()
284 self.req.set_pubkey(self.pkey)
285 # Authority good you have.
286 self.req.get_subject().commonName = "Yoda root CA"
287 self.x509 = X509()
288 self.subject = self.x509.get_subject()
289 self.subject.commonName = self.req.get_subject().commonName
290 self.x509.set_issuer(self.subject)
291 self.x509.set_pubkey(self.pkey)
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400292 now = b(datetime.now().strftime("%Y%m%d%H%M%SZ"))
293 expire = b((datetime.now() + timedelta(days=100)).strftime("%Y%m%d%H%M%SZ"))
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400294 self.x509.set_notBefore(now)
295 self.x509.set_notAfter(expire)
296
297
Jean-Paul Calderoneef9a3dc2013-03-02 16:33:32 -0800298 def tearDown(self):
299 """
300 Forget all of the pyOpenSSL objects so they can be garbage collected,
301 their memory released, and not interfere with the leak detection code.
302 """
303 self.pkey = self.req = self.x509 = self.subject = None
304 super(X509ExtTests, self).tearDown()
305
306
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -0400307 def test_str(self):
308 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900309 The string representation of :py:class:`X509Extension` instances as returned by
310 :py:data:`str` includes stuff.
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -0400311 """
312 # This isn't necessarily the best string representation. Perhaps it
313 # will be changed/improved in the future.
314 self.assertEquals(
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400315 str(X509Extension(b('basicConstraints'), True, b('CA:false'))),
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -0400316 'CA:FALSE')
317
318
Jean-Paul Calderone68649052009-07-17 21:14:27 -0400319 def test_type(self):
320 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900321 :py:class:`X509Extension` and :py:class:`X509ExtensionType` refer to the same type object
Jean-Paul Calderone68649052009-07-17 21:14:27 -0400322 and can be used to create instances of that type.
323 """
324 self.assertIdentical(X509Extension, X509ExtensionType)
325 self.assertConsistentType(
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400326 X509Extension,
327 'X509Extension', b('basicConstraints'), True, b('CA:true'))
Jean-Paul Calderone68649052009-07-17 21:14:27 -0400328
329
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500330 def test_construction(self):
331 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900332 :py:class:`X509Extension` accepts an extension type name, a critical flag,
333 and an extension value and returns an :py:class:`X509ExtensionType` instance.
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500334 """
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400335 basic = X509Extension(b('basicConstraints'), True, b('CA:true'))
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500336 self.assertTrue(
337 isinstance(basic, X509ExtensionType),
338 "%r is of type %r, should be %r" % (
339 basic, type(basic), X509ExtensionType))
340
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400341 comment = X509Extension(
342 b('nsComment'), False, b('pyOpenSSL unit test'))
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500343 self.assertTrue(
344 isinstance(comment, X509ExtensionType),
345 "%r is of type %r, should be %r" % (
346 comment, type(comment), X509ExtensionType))
347
348
Jean-Paul Calderone391585f2008-12-31 14:36:31 -0500349 def test_invalid_extension(self):
350 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900351 :py:class:`X509Extension` raises something if it is passed a bad extension
Jean-Paul Calderone391585f2008-12-31 14:36:31 -0500352 name or value.
353 """
354 self.assertRaises(
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400355 Error, X509Extension, b('thisIsMadeUp'), False, b('hi'))
Jean-Paul Calderone391585f2008-12-31 14:36:31 -0500356 self.assertRaises(
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400357 Error, X509Extension, b('basicConstraints'), False, b('blah blah'))
Jean-Paul Calderone391585f2008-12-31 14:36:31 -0500358
Jean-Paul Calderone2ee1e7c2008-12-31 14:58:38 -0500359 # Exercise a weird one (an extension which uses the r2i method). This
360 # exercises the codepath that requires a non-NULL ctx to be passed to
361 # X509V3_EXT_nconf. It can't work now because we provide no
362 # configuration database. It might be made to work in the future.
363 self.assertRaises(
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400364 Error, X509Extension, b('proxyCertInfo'), True,
365 b('language:id-ppl-anyLanguage,pathlen:1,policy:text:AB'))
Jean-Paul Calderone2ee1e7c2008-12-31 14:58:38 -0500366
Jean-Paul Calderone391585f2008-12-31 14:36:31 -0500367
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500368 def test_get_critical(self):
369 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900370 :py:meth:`X509ExtensionType.get_critical` returns the value of the
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500371 extension's critical flag.
372 """
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400373 ext = X509Extension(b('basicConstraints'), True, b('CA:true'))
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500374 self.assertTrue(ext.get_critical())
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400375 ext = X509Extension(b('basicConstraints'), False, b('CA:true'))
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500376 self.assertFalse(ext.get_critical())
377
Jean-Paul Calderone7535dab2008-03-06 18:53:11 -0500378
Jean-Paul Calderonef8c5fab2008-12-31 15:53:48 -0500379 def test_get_short_name(self):
380 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900381 :py:meth:`X509ExtensionType.get_short_name` returns a string giving the short
Jean-Paul Calderonef8c5fab2008-12-31 15:53:48 -0500382 type name of the extension.
383 """
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400384 ext = X509Extension(b('basicConstraints'), True, b('CA:true'))
385 self.assertEqual(ext.get_short_name(), b('basicConstraints'))
386 ext = X509Extension(b('nsComment'), True, b('foo bar'))
387 self.assertEqual(ext.get_short_name(), b('nsComment'))
Jean-Paul Calderonef8c5fab2008-12-31 15:53:48 -0500388
389
Jean-Paul Calderone5a9e4612011-04-01 18:27:45 -0400390 def test_get_data(self):
391 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900392 :py:meth:`X509Extension.get_data` returns a string giving the data of the
Jean-Paul Calderone5a9e4612011-04-01 18:27:45 -0400393 extension.
394 """
395 ext = X509Extension(b('basicConstraints'), True, b('CA:true'))
396 # Expect to get back the DER encoded form of CA:true.
397 self.assertEqual(ext.get_data(), b('0\x03\x01\x01\xff'))
398
399
400 def test_get_data_wrong_args(self):
401 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900402 :py:meth:`X509Extension.get_data` raises :py:exc:`TypeError` if passed any arguments.
Jean-Paul Calderone5a9e4612011-04-01 18:27:45 -0400403 """
404 ext = X509Extension(b('basicConstraints'), True, b('CA:true'))
405 self.assertRaises(TypeError, ext.get_data, None)
406 self.assertRaises(TypeError, ext.get_data, "foo")
407 self.assertRaises(TypeError, ext.get_data, 7)
408
409
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400410 def test_unused_subject(self):
Rick Dean47262da2009-07-08 16:17:17 -0500411 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900412 The :py:data:`subject` parameter to :py:class:`X509Extension` may be provided for an
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400413 extension which does not use it and is ignored in this case.
Rick Dean47262da2009-07-08 16:17:17 -0500414 """
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400415 ext1 = X509Extension(
416 b('basicConstraints'), False, b('CA:TRUE'), subject=self.x509)
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400417 self.x509.add_extensions([ext1])
418 self.x509.sign(self.pkey, 'sha1')
419 # This is a little lame. Can we think of a better way?
420 text = dump_certificate(FILETYPE_TEXT, self.x509)
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400421 self.assertTrue(b('X509v3 Basic Constraints:') in text)
422 self.assertTrue(b('CA:TRUE') in text)
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400423
424
425 def test_subject(self):
426 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900427 If an extension requires a subject, the :py:data:`subject` parameter to
428 :py:class:`X509Extension` provides its value.
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400429 """
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400430 ext3 = X509Extension(
431 b('subjectKeyIdentifier'), False, b('hash'), subject=self.x509)
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400432 self.x509.add_extensions([ext3])
433 self.x509.sign(self.pkey, 'sha1')
434 text = dump_certificate(FILETYPE_TEXT, self.x509)
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400435 self.assertTrue(b('X509v3 Subject Key Identifier:') in text)
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400436
437
438 def test_missing_subject(self):
439 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900440 If an extension requires a subject and the :py:data:`subject` parameter is
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400441 given no value, something happens.
442 """
443 self.assertRaises(
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400444 Error, X509Extension, b('subjectKeyIdentifier'), False, b('hash'))
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400445
446
447 def test_invalid_subject(self):
448 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900449 If the :py:data:`subject` parameter is given a value which is not an
450 :py:class:`X509` instance, :py:exc:`TypeError` is raised.
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400451 """
452 for badObj in [True, object(), "hello", [], self]:
453 self.assertRaises(
454 TypeError,
455 X509Extension,
456 'basicConstraints', False, 'CA:TRUE', subject=badObj)
457
458
459 def test_unused_issuer(self):
460 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900461 The :py:data:`issuer` parameter to :py:class:`X509Extension` may be provided for an
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400462 extension which does not use it and is ignored in this case.
463 """
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400464 ext1 = X509Extension(
465 b('basicConstraints'), False, b('CA:TRUE'), issuer=self.x509)
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400466 self.x509.add_extensions([ext1])
467 self.x509.sign(self.pkey, 'sha1')
468 text = dump_certificate(FILETYPE_TEXT, self.x509)
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400469 self.assertTrue(b('X509v3 Basic Constraints:') in text)
470 self.assertTrue(b('CA:TRUE') in text)
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400471
472
473 def test_issuer(self):
474 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900475 If an extension requires a issuer, the :py:data:`issuer` parameter to
476 :py:class:`X509Extension` provides its value.
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400477 """
478 ext2 = X509Extension(
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400479 b('authorityKeyIdentifier'), False, b('issuer:always'),
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400480 issuer=self.x509)
481 self.x509.add_extensions([ext2])
482 self.x509.sign(self.pkey, 'sha1')
483 text = dump_certificate(FILETYPE_TEXT, self.x509)
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400484 self.assertTrue(b('X509v3 Authority Key Identifier:') in text)
485 self.assertTrue(b('DirName:/CN=Yoda root CA') in text)
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400486
487
488 def test_missing_issuer(self):
489 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900490 If an extension requires an issue and the :py:data:`issuer` parameter is given
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400491 no value, something happens.
492 """
493 self.assertRaises(
494 Error,
495 X509Extension,
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400496 b('authorityKeyIdentifier'), False,
497 b('keyid:always,issuer:always'))
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400498
499
500 def test_invalid_issuer(self):
501 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900502 If the :py:data:`issuer` parameter is given a value which is not an
503 :py:class:`X509` instance, :py:exc:`TypeError` is raised.
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400504 """
505 for badObj in [True, object(), "hello", [], self]:
506 self.assertRaises(
507 TypeError,
508 X509Extension,
509 'authorityKeyIdentifier', False, 'keyid:always,issuer:always',
510 issuer=badObj)
Rick Dean47262da2009-07-08 16:17:17 -0500511
512
Jean-Paul Calderone391585f2008-12-31 14:36:31 -0500513
Jean-Paul Calderone18808652009-07-05 12:54:05 -0400514class PKeyTests(TestCase):
Jean-Paul Calderoneac930e12008-03-06 18:50:51 -0500515 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900516 Unit tests for :py:class:`OpenSSL.crypto.PKey`.
Jean-Paul Calderoneac930e12008-03-06 18:50:51 -0500517 """
Jean-Paul Calderone68649052009-07-17 21:14:27 -0400518 def test_type(self):
519 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900520 :py:class:`PKey` and :py:class:`PKeyType` refer to the same type object
521 and can be used to create instances of that type.
Jean-Paul Calderone68649052009-07-17 21:14:27 -0400522 """
523 self.assertIdentical(PKey, PKeyType)
524 self.assertConsistentType(PKey, 'PKey')
525
526
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500527 def test_construction(self):
528 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900529 :py:class:`PKey` takes no arguments and returns a new :py:class:`PKey` instance.
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500530 """
531 self.assertRaises(TypeError, PKey, None)
532 key = PKey()
533 self.assertTrue(
534 isinstance(key, PKeyType),
535 "%r is of type %r, should be %r" % (key, type(key), PKeyType))
536
537
538 def test_pregeneration(self):
539 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900540 :py:attr:`PKeyType.bits` and :py:attr:`PKeyType.type` return :py:data:`0` before the key is
541 generated. :py:attr:`PKeyType.check` raises :py:exc:`TypeError` before the key is
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500542 generated.
543 """
544 key = PKey()
545 self.assertEqual(key.type(), 0)
546 self.assertEqual(key.bits(), 0)
Jean-Paul Calderone55ec1712009-05-13 14:14:30 -0400547 self.assertRaises(TypeError, key.check)
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500548
549
550 def test_failedGeneration(self):
551 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900552 :py:meth:`PKeyType.generate_key` takes two arguments, the first giving the key
553 type as one of :py:data:`TYPE_RSA` or :py:data:`TYPE_DSA` and the second giving the
Jean-Paul Calderoneab82db72008-03-06 00:09:31 -0500554 number of bits to generate. If an invalid type is specified or
Jonathan Ballet648875f2011-07-16 14:14:58 +0900555 generation fails, :py:exc:`Error` is raised. If an invalid number of bits is
556 specified, :py:exc:`ValueError` or :py:exc:`Error` is raised.
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500557 """
558 key = PKey()
559 self.assertRaises(TypeError, key.generate_key)
560 self.assertRaises(TypeError, key.generate_key, 1, 2, 3)
561 self.assertRaises(TypeError, key.generate_key, "foo", "bar")
562 self.assertRaises(Error, key.generate_key, -1, 0)
Jean-Paul Calderoneab82db72008-03-06 00:09:31 -0500563
Jean-Paul Calderoneab82db72008-03-06 00:09:31 -0500564 self.assertRaises(ValueError, key.generate_key, TYPE_RSA, -1)
565 self.assertRaises(ValueError, key.generate_key, TYPE_RSA, 0)
Jean-Paul Calderoned71fe982008-03-06 00:31:50 -0500566
567 # XXX RSA generation for small values of bits is fairly buggy in a wide
568 # range of OpenSSL versions. I need to figure out what the safe lower
569 # bound for a reasonable number of OpenSSL versions is and explicitly
570 # check for that in the wrapper. The failure behavior is typically an
571 # infinite loop inside OpenSSL.
572
573 # self.assertRaises(Error, key.generate_key, TYPE_RSA, 2)
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500574
575 # XXX DSA generation seems happy with any number of bits. The DSS
576 # says bits must be between 512 and 1024 inclusive. OpenSSL's DSA
577 # generator doesn't seem to care about the upper limit at all. For
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500578 # the lower limit, it uses 512 if anything smaller is specified.
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500579 # So, it doesn't seem possible to make generate_key fail for
580 # TYPE_DSA with a bits argument which is at least an int.
581
582 # self.assertRaises(Error, key.generate_key, TYPE_DSA, -7)
583
584
585 def test_rsaGeneration(self):
586 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900587 :py:meth:`PKeyType.generate_key` generates an RSA key when passed
588 :py:data:`TYPE_RSA` as a type and a reasonable number of bits.
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500589 """
590 bits = 128
591 key = PKey()
592 key.generate_key(TYPE_RSA, bits)
593 self.assertEqual(key.type(), TYPE_RSA)
594 self.assertEqual(key.bits(), bits)
Jean-Paul Calderone8e6ce972009-05-13 12:32:49 -0400595 self.assertTrue(key.check())
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500596
597
598 def test_dsaGeneration(self):
599 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900600 :py:meth:`PKeyType.generate_key` generates a DSA key when passed
601 :py:data:`TYPE_DSA` as a type and a reasonable number of bits.
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500602 """
603 # 512 is a magic number. The DSS (Digital Signature Standard)
604 # allows a minimum of 512 bits for DSA. DSA_generate_parameters
605 # will silently promote any value below 512 to 512.
606 bits = 512
607 key = PKey()
608 key.generate_key(TYPE_DSA, bits)
Jean-Paul Calderonef6745b32013-03-01 15:08:46 -0800609 # self.assertEqual(key.type(), TYPE_DSA)
610 # self.assertEqual(key.bits(), bits)
611 # self.assertRaises(TypeError, key.check)
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500612
613
614 def test_regeneration(self):
615 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900616 :py:meth:`PKeyType.generate_key` can be called multiple times on the same
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500617 key to generate new keys.
618 """
619 key = PKey()
620 for type, bits in [(TYPE_RSA, 512), (TYPE_DSA, 576)]:
621 key.generate_key(type, bits)
622 self.assertEqual(key.type(), type)
623 self.assertEqual(key.bits(), bits)
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500624
625
Jean-Paul Calderone55ec1712009-05-13 14:14:30 -0400626 def test_inconsistentKey(self):
627 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900628 :py:`PKeyType.check` returns :py:exc:`Error` if the key is not consistent.
Jean-Paul Calderone55ec1712009-05-13 14:14:30 -0400629 """
630 key = load_privatekey(FILETYPE_PEM, inconsistentPrivateKeyPEM)
Jean-Paul Calderoned338e4e2009-05-13 15:45:07 -0400631 self.assertRaises(Error, key.check)
Jean-Paul Calderone55ec1712009-05-13 14:14:30 -0400632
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500633
Jean-Paul Calderonee81020e2011-06-12 21:48:57 -0400634 def test_check_wrong_args(self):
635 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900636 :py:meth:`PKeyType.check` raises :py:exc:`TypeError` if called with any arguments.
Jean-Paul Calderonee81020e2011-06-12 21:48:57 -0400637 """
638 self.assertRaises(TypeError, PKey().check, None)
639 self.assertRaises(TypeError, PKey().check, object())
640 self.assertRaises(TypeError, PKey().check, 1)
641
642
Jean-Paul Calderone02d01972011-10-31 10:39:29 -0400643 def test_check_public_key(self):
644 """
645 :py:meth:`PKeyType.check` raises :py:exc:`TypeError` if only the public
646 part of the key is available.
647 """
648 # A trick to get a public-only key
649 key = PKey()
650 key.generate_key(TYPE_RSA, 512)
651 cert = X509()
652 cert.set_pubkey(key)
653 pub = cert.get_pubkey()
654 self.assertRaises(TypeError, pub.check)
655
656
Jean-Paul Calderonee81020e2011-06-12 21:48:57 -0400657
Jean-Paul Calderone18808652009-07-05 12:54:05 -0400658class X509NameTests(TestCase):
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500659 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900660 Unit tests for :py:class:`OpenSSL.crypto.X509Name`.
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500661 """
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500662 def _x509name(self, **attrs):
663 # XXX There's no other way to get a new X509Name yet.
664 name = X509().get_subject()
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400665 attrs = list(attrs.items())
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500666 # Make the order stable - order matters!
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400667 def key(attr):
668 return attr[1]
669 attrs.sort(key=key)
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500670 for k, v in attrs:
671 setattr(name, k, v)
672 return name
673
674
Rick Deane15b1472009-07-09 15:53:42 -0500675 def test_type(self):
676 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900677 The type of X509Name objects is :py:class:`X509NameType`.
Rick Deane15b1472009-07-09 15:53:42 -0500678 """
Jean-Paul Calderone68649052009-07-17 21:14:27 -0400679 self.assertIdentical(X509Name, X509NameType)
680 self.assertEqual(X509NameType.__name__, 'X509Name')
681 self.assertTrue(isinstance(X509NameType, type))
682
Rick Deane15b1472009-07-09 15:53:42 -0500683 name = self._x509name()
684 self.assertTrue(
685 isinstance(name, X509NameType),
686 "%r is of type %r, should be %r" % (
687 name, type(name), X509NameType))
Rick Deane15b1472009-07-09 15:53:42 -0500688
689
Jean-Paul Calderone9ce9afb2011-04-22 18:16:22 -0400690 def test_onlyStringAttributes(self):
691 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900692 Attempting to set a non-:py:data:`str` attribute name on an :py:class:`X509NameType`
693 instance causes :py:exc:`TypeError` to be raised.
Jean-Paul Calderone9ce9afb2011-04-22 18:16:22 -0400694 """
695 name = self._x509name()
696 # Beyond these cases, you may also think that unicode should be
697 # rejected. Sorry, you're wrong. unicode is automatically converted to
698 # str outside of the control of X509Name, so there's no way to reject
699 # it.
Jean-Paul Calderoneff363be2013-03-03 10:21:23 -0800700
701 # Also, this used to test str subclasses, but that test is less relevant
702 # now that the implementation is in Python instead of C. Also PyPy
703 # automatically converts str subclasses to str when they are passed to
704 # setattr, so we can't test it on PyPy. Apparently CPython does this
705 # sometimes as well.
Jean-Paul Calderone9ce9afb2011-04-22 18:16:22 -0400706 self.assertRaises(TypeError, setattr, name, None, "hello")
707 self.assertRaises(TypeError, setattr, name, 30, "hello")
Jean-Paul Calderone9ce9afb2011-04-22 18:16:22 -0400708
709 def test_setInvalidAttribute(self):
710 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900711 Attempting to set any attribute name on an :py:class:`X509NameType` instance for
712 which no corresponding NID is defined causes :py:exc:`AttributeError` to be
Jean-Paul Calderone9ce9afb2011-04-22 18:16:22 -0400713 raised.
714 """
715 name = self._x509name()
716 self.assertRaises(AttributeError, setattr, name, "no such thing", None)
717
718
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500719 def test_attributes(self):
720 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900721 :py:class:`X509NameType` instances have attributes for each standard (?)
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500722 X509Name field.
723 """
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500724 name = self._x509name()
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500725 name.commonName = "foo"
726 self.assertEqual(name.commonName, "foo")
727 self.assertEqual(name.CN, "foo")
728 name.CN = "baz"
729 self.assertEqual(name.commonName, "baz")
730 self.assertEqual(name.CN, "baz")
731 name.commonName = "bar"
732 self.assertEqual(name.commonName, "bar")
733 self.assertEqual(name.CN, "bar")
734 name.CN = "quux"
735 self.assertEqual(name.commonName, "quux")
736 self.assertEqual(name.CN, "quux")
737
738
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500739 def test_copy(self):
740 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900741 :py:class:`X509Name` creates a new :py:class:`X509NameType` instance with all the same
742 attributes as an existing :py:class:`X509NameType` instance when called with
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500743 one.
744 """
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500745 name = self._x509name(commonName="foo", emailAddress="bar@example.com")
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500746
747 copy = X509Name(name)
748 self.assertEqual(copy.commonName, "foo")
749 self.assertEqual(copy.emailAddress, "bar@example.com")
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500750
751 # Mutate the copy and ensure the original is unmodified.
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500752 copy.commonName = "baz"
753 self.assertEqual(name.commonName, "foo")
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500754
755 # Mutate the original and ensure the copy is unmodified.
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500756 name.emailAddress = "quux@example.com"
757 self.assertEqual(copy.emailAddress, "bar@example.com")
758
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500759
760 def test_repr(self):
761 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900762 :py:func:`repr` passed an :py:class:`X509NameType` instance should return a string
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500763 containing a description of the type and the NIDs which have been set
764 on it.
765 """
766 name = self._x509name(commonName="foo", emailAddress="bar")
767 self.assertEqual(
768 repr(name),
769 "<X509Name object '/emailAddress=bar/CN=foo'>")
770
771
772 def test_comparison(self):
773 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900774 :py:class:`X509NameType` instances should compare based on their NIDs.
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500775 """
776 def _equality(a, b, assertTrue, assertFalse):
777 assertTrue(a == b, "(%r == %r) --> False" % (a, b))
778 assertFalse(a != b)
779 assertTrue(b == a)
780 assertFalse(b != a)
781
782 def assertEqual(a, b):
783 _equality(a, b, self.assertTrue, self.assertFalse)
784
785 # Instances compare equal to themselves.
786 name = self._x509name()
787 assertEqual(name, name)
788
789 # Empty instances should compare equal to each other.
790 assertEqual(self._x509name(), self._x509name())
791
792 # Instances with equal NIDs should compare equal to each other.
793 assertEqual(self._x509name(commonName="foo"),
794 self._x509name(commonName="foo"))
795
796 # Instance with equal NIDs set using different aliases should compare
797 # equal to each other.
798 assertEqual(self._x509name(commonName="foo"),
799 self._x509name(CN="foo"))
800
801 # Instances with more than one NID with the same values should compare
802 # equal to each other.
803 assertEqual(self._x509name(CN="foo", organizationalUnitName="bar"),
804 self._x509name(commonName="foo", OU="bar"))
805
806 def assertNotEqual(a, b):
807 _equality(a, b, self.assertFalse, self.assertTrue)
808
809 # Instances with different values for the same NID should not compare
810 # equal to each other.
811 assertNotEqual(self._x509name(CN="foo"),
812 self._x509name(CN="bar"))
813
814 # Instances with different NIDs should not compare equal to each other.
815 assertNotEqual(self._x509name(CN="foo"),
816 self._x509name(OU="foo"))
817
818 def _inequality(a, b, assertTrue, assertFalse):
819 assertTrue(a < b)
820 assertTrue(a <= b)
821 assertTrue(b > a)
822 assertTrue(b >= a)
823 assertFalse(a > b)
824 assertFalse(a >= b)
825 assertFalse(b < a)
826 assertFalse(b <= a)
827
828 def assertLessThan(a, b):
829 _inequality(a, b, self.assertTrue, self.assertFalse)
830
831 # An X509Name with a NID with a value which sorts less than the value
832 # of the same NID on another X509Name compares less than the other
833 # X509Name.
834 assertLessThan(self._x509name(CN="abc"),
835 self._x509name(CN="def"))
836
837 def assertGreaterThan(a, b):
838 _inequality(a, b, self.assertFalse, self.assertTrue)
839
840 # An X509Name with a NID with a value which sorts greater than the
841 # value of the same NID on another X509Name compares greater than the
842 # other X509Name.
843 assertGreaterThan(self._x509name(CN="def"),
844 self._x509name(CN="abc"))
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500845
846
Jean-Paul Calderone110cd092008-03-24 17:27:42 -0400847 def test_hash(self):
848 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900849 :py:meth:`X509Name.hash` returns an integer hash based on the value of the
Jean-Paul Calderone110cd092008-03-24 17:27:42 -0400850 name.
851 """
852 a = self._x509name(CN="foo")
853 b = self._x509name(CN="foo")
854 self.assertEqual(a.hash(), b.hash())
855 a.CN = "bar"
856 self.assertNotEqual(a.hash(), b.hash())
857
858
Jean-Paul Calderonee957a002008-03-25 15:16:51 -0400859 def test_der(self):
860 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900861 :py:meth:`X509Name.der` returns the DER encoded form of the name.
Jean-Paul Calderonee957a002008-03-25 15:16:51 -0400862 """
863 a = self._x509name(CN="foo", C="US")
864 self.assertEqual(
865 a.der(),
Jean-Paul Calderone2ac721b2010-08-22 19:20:00 -0400866 b('0\x1b1\x0b0\t\x06\x03U\x04\x06\x13\x02US'
867 '1\x0c0\n\x06\x03U\x04\x03\x13\x03foo'))
Jean-Paul Calderonee957a002008-03-25 15:16:51 -0400868
869
Jean-Paul Calderonec54cc182008-03-26 21:11:07 -0400870 def test_get_components(self):
871 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900872 :py:meth:`X509Name.get_components` returns a :py:data:`list` of
873 two-tuples of :py:data:`str`
Jean-Paul Calderonec54cc182008-03-26 21:11:07 -0400874 giving the NIDs and associated values which make up the name.
875 """
876 a = self._x509name()
877 self.assertEqual(a.get_components(), [])
878 a.CN = "foo"
Jean-Paul Calderone2ac721b2010-08-22 19:20:00 -0400879 self.assertEqual(a.get_components(), [(b("CN"), b("foo"))])
Jean-Paul Calderonec54cc182008-03-26 21:11:07 -0400880 a.organizationalUnitName = "bar"
881 self.assertEqual(
882 a.get_components(),
Jean-Paul Calderone2ac721b2010-08-22 19:20:00 -0400883 [(b("CN"), b("foo")), (b("OU"), b("bar"))])
Jean-Paul Calderonec54cc182008-03-26 21:11:07 -0400884
Jean-Paul Calderone110cd092008-03-24 17:27:42 -0400885
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -0400886class _PKeyInteractionTestsMixin:
887 """
888 Tests which involve another thing and a PKey.
889 """
890 def signable(self):
891 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900892 Return something with a :py:meth:`set_pubkey`, :py:meth:`set_pubkey`,
893 and :py:meth:`sign` method.
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -0400894 """
895 raise NotImplementedError()
896
897
898 def test_signWithUngenerated(self):
899 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900900 :py:meth:`X509Req.sign` raises :py:exc:`ValueError` when pass a
901 :py:class:`PKey` with no parts.
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -0400902 """
903 request = self.signable()
904 key = PKey()
905 self.assertRaises(ValueError, request.sign, key, 'MD5')
906
907
908 def test_signWithPublicKey(self):
909 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900910 :py:meth:`X509Req.sign` raises :py:exc:`ValueError` when pass a
911 :py:class:`PKey` with no private part as the signing key.
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -0400912 """
913 request = self.signable()
914 key = PKey()
915 key.generate_key(TYPE_RSA, 512)
916 request.set_pubkey(key)
917 pub = request.get_pubkey()
918 self.assertRaises(ValueError, request.sign, pub, 'MD5')
919
920
Jean-Paul Calderonecc05a912010-08-03 18:24:19 -0400921 def test_signWithUnknownDigest(self):
922 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900923 :py:meth:`X509Req.sign` raises :py:exc:`ValueError` when passed a digest name which is
Jean-Paul Calderonecc05a912010-08-03 18:24:19 -0400924 not known.
925 """
926 request = self.signable()
927 key = PKey()
928 key.generate_key(TYPE_RSA, 512)
929 self.assertRaises(ValueError, request.sign, key, "monkeys")
930
931
Jean-Paul Calderoneb9725592010-08-03 18:17:22 -0400932 def test_sign(self):
933 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900934 :py:meth:`X509Req.sign` succeeds when passed a private key object and a valid
935 digest function. :py:meth:`X509Req.verify` can be used to check the signature.
Jean-Paul Calderoneb9725592010-08-03 18:17:22 -0400936 """
937 request = self.signable()
938 key = PKey()
939 key.generate_key(TYPE_RSA, 512)
940 request.set_pubkey(key)
941 request.sign(key, 'MD5')
942 # If the type has a verify method, cover that too.
943 if getattr(request, 'verify', None) is not None:
944 pub = request.get_pubkey()
945 self.assertTrue(request.verify(pub))
946 # Make another key that won't verify.
947 key = PKey()
948 key.generate_key(TYPE_RSA, 512)
949 self.assertRaises(Error, request.verify, key)
950
951
952
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -0400953
Jean-Paul Calderone18808652009-07-05 12:54:05 -0400954class X509ReqTests(TestCase, _PKeyInteractionTestsMixin):
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500955 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900956 Tests for :py:class:`OpenSSL.crypto.X509Req`.
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500957 """
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -0400958 def signable(self):
959 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900960 Create and return a new :py:class:`X509Req`.
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -0400961 """
962 return X509Req()
963
964
Jean-Paul Calderone68649052009-07-17 21:14:27 -0400965 def test_type(self):
966 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900967 :py:obj:`X509Req` and :py:obj:`X509ReqType` refer to the same type object and can be
Jean-Paul Calderone68649052009-07-17 21:14:27 -0400968 used to create instances of that type.
969 """
970 self.assertIdentical(X509Req, X509ReqType)
971 self.assertConsistentType(X509Req, 'X509Req')
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500972
973
974 def test_construction(self):
975 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900976 :py:obj:`X509Req` takes no arguments and returns an :py:obj:`X509ReqType` instance.
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500977 """
978 request = X509Req()
979 self.assertTrue(
980 isinstance(request, X509ReqType),
981 "%r is of type %r, should be %r" % (request, type(request), X509ReqType))
982
983
Jean-Paul Calderone8dd19b82008-12-28 20:41:16 -0500984 def test_version(self):
985 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900986 :py:obj:`X509ReqType.set_version` sets the X.509 version of the certificate
987 request. :py:obj:`X509ReqType.get_version` returns the X.509 version of
Jean-Paul Calderone8dd19b82008-12-28 20:41:16 -0500988 the certificate request. The initial value of the version is 0.
989 """
990 request = X509Req()
991 self.assertEqual(request.get_version(), 0)
992 request.set_version(1)
993 self.assertEqual(request.get_version(), 1)
994 request.set_version(3)
995 self.assertEqual(request.get_version(), 3)
996
997
Jean-Paul Calderone54e49e92010-07-30 11:04:46 -0400998 def test_version_wrong_args(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -0400999 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001000 :py:obj:`X509ReqType.set_version` raises :py:obj:`TypeError` if called with the wrong
1001 number of arguments or with a non-:py:obj:`int` argument.
1002 :py:obj:`X509ReqType.get_version` raises :py:obj:`TypeError` if called with any
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04001003 arguments.
1004 """
Jean-Paul Calderone54e49e92010-07-30 11:04:46 -04001005 request = X509Req()
1006 self.assertRaises(TypeError, request.set_version)
1007 self.assertRaises(TypeError, request.set_version, "foo")
1008 self.assertRaises(TypeError, request.set_version, 1, 2)
1009 self.assertRaises(TypeError, request.get_version, None)
1010
1011
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -05001012 def test_get_subject(self):
1013 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001014 :py:obj:`X509ReqType.get_subject` returns an :py:obj:`X509Name` for the subject of
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -05001015 the request and which is valid even after the request object is
1016 otherwise dead.
1017 """
1018 request = X509Req()
1019 subject = request.get_subject()
1020 self.assertTrue(
1021 isinstance(subject, X509NameType),
1022 "%r is of type %r, should be %r" % (subject, type(subject), X509NameType))
1023 subject.commonName = "foo"
1024 self.assertEqual(request.get_subject().commonName, "foo")
1025 del request
1026 subject.commonName = "bar"
1027 self.assertEqual(subject.commonName, "bar")
Jean-Paul Calderone78381d22008-03-06 23:35:22 -05001028
1029
Jean-Paul Calderone54e49e92010-07-30 11:04:46 -04001030 def test_get_subject_wrong_args(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04001031 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001032 :py:obj:`X509ReqType.get_subject` raises :py:obj:`TypeError` if called with any
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04001033 arguments.
1034 """
Jean-Paul Calderone54e49e92010-07-30 11:04:46 -04001035 request = X509Req()
1036 self.assertRaises(TypeError, request.get_subject, None)
1037
1038
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04001039 def test_add_extensions(self):
1040 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001041 :py:obj:`X509Req.add_extensions` accepts a :py:obj:`list` of :py:obj:`X509Extension`
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04001042 instances and adds them to the X509 request.
1043 """
1044 request = X509Req()
1045 request.add_extensions([
Jean-Paul Calderonee16f9f32010-08-22 19:20:37 -04001046 X509Extension(b('basicConstraints'), True, b('CA:false'))])
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04001047 # XXX Add get_extensions so the rest of this unit test can be written.
1048
1049
1050 def test_add_extensions_wrong_args(self):
1051 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001052 :py:obj:`X509Req.add_extensions` raises :py:obj:`TypeError` if called with the wrong
1053 number of arguments or with a non-:py:obj:`list`. Or it raises :py:obj:`ValueError`
1054 if called with a :py:obj:`list` containing objects other than :py:obj:`X509Extension`
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04001055 instances.
1056 """
1057 request = X509Req()
1058 self.assertRaises(TypeError, request.add_extensions)
1059 self.assertRaises(TypeError, request.add_extensions, object())
1060 self.assertRaises(ValueError, request.add_extensions, [object()])
1061 self.assertRaises(TypeError, request.add_extensions, [], None)
1062
1063
Jean-Paul Calderone78381d22008-03-06 23:35:22 -05001064
Jean-Paul Calderone18808652009-07-05 12:54:05 -04001065class X509Tests(TestCase, _PKeyInteractionTestsMixin):
Jean-Paul Calderone78381d22008-03-06 23:35:22 -05001066 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001067 Tests for :py:obj:`OpenSSL.crypto.X509`.
Jean-Paul Calderone78381d22008-03-06 23:35:22 -05001068 """
Jean-Paul Calderone5ef86512008-04-26 19:06:28 -04001069 pemData = cleartextCertificatePEM + cleartextPrivateKeyPEM
Jean-Paul Calderone8114b452008-03-25 15:27:59 -04001070
Roland Hedberg7e4930e2008-04-22 22:58:50 +02001071 extpem = """
1072-----BEGIN CERTIFICATE-----
1073MIIC3jCCAkegAwIBAgIJAJHFjlcCgnQzMA0GCSqGSIb3DQEBBQUAMEcxCzAJBgNV
1074BAYTAlNFMRUwEwYDVQQIEwxXZXN0ZXJib3R0b20xEjAQBgNVBAoTCUNhdGFsb2dp
1075eDENMAsGA1UEAxMEUm9vdDAeFw0wODA0MjIxNDQ1MzhaFw0wOTA0MjIxNDQ1Mzha
1076MFQxCzAJBgNVBAYTAlNFMQswCQYDVQQIEwJXQjEUMBIGA1UEChMLT3Blbk1ldGFk
1077aXIxIjAgBgNVBAMTGW5vZGUxLm9tMi5vcGVubWV0YWRpci5vcmcwgZ8wDQYJKoZI
1078hvcNAQEBBQADgY0AMIGJAoGBAPIcQMrwbk2nESF/0JKibj9i1x95XYAOwP+LarwT
1079Op4EQbdlI9SY+uqYqlERhF19w7CS+S6oyqx0DRZSk4Y9dZ9j9/xgm2u/f136YS1u
1080zgYFPvfUs6PqYLPSM8Bw+SjJ+7+2+TN+Tkiof9WP1cMjodQwOmdsiRbR0/J7+b1B
1081hec1AgMBAAGjgcQwgcEwCQYDVR0TBAIwADAsBglghkgBhvhCAQ0EHxYdT3BlblNT
1082TCBHZW5lcmF0ZWQgQ2VydGlmaWNhdGUwHQYDVR0OBBYEFIdHsBcMVVMbAO7j6NCj
108303HgLnHaMB8GA1UdIwQYMBaAFL2h9Bf9Mre4vTdOiHTGAt7BRY/8MEYGA1UdEQQ/
1084MD2CDSouZXhhbXBsZS5vcmeCESoub20yLmV4bWFwbGUuY29thwSC7wgKgRNvbTJA
1085b3Blbm1ldGFkaXIub3JnMA0GCSqGSIb3DQEBBQUAA4GBALd7WdXkp2KvZ7/PuWZA
1086MPlIxyjS+Ly11+BNE0xGQRp9Wz+2lABtpgNqssvU156+HkKd02rGheb2tj7MX9hG
1087uZzbwDAZzJPjzDQDD7d3cWsrVcfIdqVU7epHqIadnOF+X0ghJ39pAm6VVadnSXCt
1088WpOdIpB8KksUTCzV591Nr1wd
1089-----END CERTIFICATE-----
1090 """
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -04001091 def signable(self):
1092 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001093 Create and return a new :py:obj:`X509`.
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -04001094 """
1095 return X509()
1096
1097
Jean-Paul Calderone68649052009-07-17 21:14:27 -04001098 def test_type(self):
1099 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001100 :py:obj:`X509` and :py:obj:`X509Type` refer to the same type object and can be used
Jean-Paul Calderone68649052009-07-17 21:14:27 -04001101 to create instances of that type.
1102 """
1103 self.assertIdentical(X509, X509Type)
1104 self.assertConsistentType(X509, 'X509')
1105
1106
Jean-Paul Calderone78381d22008-03-06 23:35:22 -05001107 def test_construction(self):
1108 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001109 :py:obj:`X509` takes no arguments and returns an instance of :py:obj:`X509Type`.
Jean-Paul Calderone78381d22008-03-06 23:35:22 -05001110 """
1111 certificate = X509()
1112 self.assertTrue(
1113 isinstance(certificate, X509Type),
1114 "%r is of type %r, should be %r" % (certificate,
1115 type(certificate),
1116 X509Type))
Rick Deane15b1472009-07-09 15:53:42 -05001117 self.assertEqual(type(X509Type).__name__, 'type')
1118 self.assertEqual(type(certificate).__name__, 'X509')
1119 self.assertEqual(type(certificate), X509Type)
Rick Dean04113e72009-07-16 12:06:35 -05001120 self.assertEqual(type(certificate), X509)
Jean-Paul Calderone78381d22008-03-06 23:35:22 -05001121
1122
Jean-Paul Calderone3544eb42010-07-30 22:09:47 -04001123 def test_get_version_wrong_args(self):
1124 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001125 :py:obj:`X509.get_version` raises :py:obj:`TypeError` if invoked with any arguments.
Jean-Paul Calderone3544eb42010-07-30 22:09:47 -04001126 """
1127 cert = X509()
1128 self.assertRaises(TypeError, cert.get_version, None)
1129
1130
1131 def test_set_version_wrong_args(self):
1132 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001133 :py:obj:`X509.set_version` raises :py:obj:`TypeError` if invoked with the wrong number
1134 of arguments or an argument not of type :py:obj:`int`.
Jean-Paul Calderone3544eb42010-07-30 22:09:47 -04001135 """
1136 cert = X509()
1137 self.assertRaises(TypeError, cert.set_version)
1138 self.assertRaises(TypeError, cert.set_version, None)
1139 self.assertRaises(TypeError, cert.set_version, 1, None)
1140
1141
1142 def test_version(self):
1143 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001144 :py:obj:`X509.set_version` sets the certificate version number.
1145 :py:obj:`X509.get_version` retrieves it.
Jean-Paul Calderone3544eb42010-07-30 22:09:47 -04001146 """
1147 cert = X509()
1148 cert.set_version(1234)
1149 self.assertEquals(cert.get_version(), 1234)
1150
1151
1152 def test_get_serial_number_wrong_args(self):
1153 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001154 :py:obj:`X509.get_serial_number` raises :py:obj:`TypeError` if invoked with any
Jean-Paul Calderone3544eb42010-07-30 22:09:47 -04001155 arguments.
1156 """
1157 cert = X509()
1158 self.assertRaises(TypeError, cert.get_serial_number, None)
1159
1160
Jean-Paul Calderone78381d22008-03-06 23:35:22 -05001161 def test_serial_number(self):
1162 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001163 The serial number of an :py:obj:`X509Type` can be retrieved and modified with
1164 :py:obj:`X509Type.get_serial_number` and :py:obj:`X509Type.set_serial_number`.
Jean-Paul Calderone78381d22008-03-06 23:35:22 -05001165 """
1166 certificate = X509()
1167 self.assertRaises(TypeError, certificate.set_serial_number)
1168 self.assertRaises(TypeError, certificate.set_serial_number, 1, 2)
1169 self.assertRaises(TypeError, certificate.set_serial_number, "1")
1170 self.assertRaises(TypeError, certificate.set_serial_number, 5.5)
1171 self.assertEqual(certificate.get_serial_number(), 0)
1172 certificate.set_serial_number(1)
1173 self.assertEqual(certificate.get_serial_number(), 1)
1174 certificate.set_serial_number(2 ** 32 + 1)
1175 self.assertEqual(certificate.get_serial_number(), 2 ** 32 + 1)
1176 certificate.set_serial_number(2 ** 64 + 1)
1177 self.assertEqual(certificate.get_serial_number(), 2 ** 64 + 1)
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001178 certificate.set_serial_number(2 ** 128 + 1)
1179 self.assertEqual(certificate.get_serial_number(), 2 ** 128 + 1)
1180
1181
1182 def _setBoundTest(self, which):
1183 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001184 :py:obj:`X509Type.set_notBefore` takes a string in the format of an ASN1
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001185 GENERALIZEDTIME and sets the beginning of the certificate's validity
1186 period to it.
1187 """
1188 certificate = X509()
1189 set = getattr(certificate, 'set_not' + which)
1190 get = getattr(certificate, 'get_not' + which)
1191
Jean-Paul Calderonee0615b52008-03-09 21:44:46 -04001192 # Starts with no value.
1193 self.assertEqual(get(), None)
1194
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001195 # GMT (Or is it UTC?) -exarkun
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001196 when = b("20040203040506Z")
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001197 set(when)
1198 self.assertEqual(get(), when)
1199
1200 # A plus two hours and thirty minutes offset
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001201 when = b("20040203040506+0530")
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001202 set(when)
1203 self.assertEqual(get(), when)
1204
1205 # A minus one hour fifteen minutes offset
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001206 when = b("20040203040506-0115")
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001207 set(when)
1208 self.assertEqual(get(), when)
1209
1210 # An invalid string results in a ValueError
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001211 self.assertRaises(ValueError, set, b("foo bar"))
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001212
Jean-Paul Calderone31ca2002010-01-30 15:14:43 -05001213 # The wrong number of arguments results in a TypeError.
1214 self.assertRaises(TypeError, set)
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001215 self.assertRaises(TypeError, set, b("20040203040506Z"), b("20040203040506Z"))
1216 self.assertRaises(TypeError, get, b("foo bar"))
1217
Jean-Paul Calderone31ca2002010-01-30 15:14:43 -05001218
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04001219 # XXX ASN1_TIME (not GENERALIZEDTIME)
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001220
1221 def test_set_notBefore(self):
1222 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001223 :py:obj:`X509Type.set_notBefore` takes a string in the format of an ASN1
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001224 GENERALIZEDTIME and sets the beginning of the certificate's validity
1225 period to it.
1226 """
1227 self._setBoundTest("Before")
1228
1229
1230 def test_set_notAfter(self):
1231 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001232 :py:obj:`X509Type.set_notAfter` takes a string in the format of an ASN1
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001233 GENERALIZEDTIME and sets the end of the certificate's validity period
1234 to it.
1235 """
1236 self._setBoundTest("After")
Jean-Paul Calderone76576d52008-03-24 16:04:46 -04001237
1238
Jean-Paul Calderone38a646d2008-03-25 15:16:18 -04001239 def test_get_notBefore(self):
1240 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001241 :py:obj:`X509Type.get_notBefore` returns a string in the format of an ASN1
Jean-Paul Calderone38a646d2008-03-25 15:16:18 -04001242 GENERALIZEDTIME even for certificates which store it as UTCTIME
1243 internally.
1244 """
Jean-Paul Calderone8114b452008-03-25 15:27:59 -04001245 cert = load_certificate(FILETYPE_PEM, self.pemData)
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001246 self.assertEqual(cert.get_notBefore(), b("20090325123658Z"))
Jean-Paul Calderone38a646d2008-03-25 15:16:18 -04001247
Rick Dean38a05c82009-07-18 01:41:30 -05001248
1249 def test_get_notAfter(self):
1250 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001251 :py:obj:`X509Type.get_notAfter` returns a string in the format of an ASN1
Rick Dean38a05c82009-07-18 01:41:30 -05001252 GENERALIZEDTIME even for certificates which store it as UTCTIME
1253 internally.
1254 """
1255 cert = load_certificate(FILETYPE_PEM, self.pemData)
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001256 self.assertEqual(cert.get_notAfter(), b("20170611123658Z"))
Rick Dean38a05c82009-07-18 01:41:30 -05001257
1258
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001259 def test_gmtime_adj_notBefore_wrong_args(self):
1260 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001261 :py:obj:`X509Type.gmtime_adj_notBefore` raises :py:obj:`TypeError` if called with the
1262 wrong number of arguments or a non-:py:obj:`int` argument.
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001263 """
1264 cert = X509()
1265 self.assertRaises(TypeError, cert.gmtime_adj_notBefore)
1266 self.assertRaises(TypeError, cert.gmtime_adj_notBefore, None)
1267 self.assertRaises(TypeError, cert.gmtime_adj_notBefore, 123, None)
1268
1269
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001270 def test_gmtime_adj_notBefore(self):
1271 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001272 :py:obj:`X509Type.gmtime_adj_notBefore` changes the not-before timestamp to be
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001273 the current time plus the number of seconds passed in.
1274 """
1275 cert = load_certificate(FILETYPE_PEM, self.pemData)
1276 now = datetime.utcnow() + timedelta(seconds=100)
1277 cert.gmtime_adj_notBefore(100)
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001278 self.assertEqual(cert.get_notBefore(), b(now.strftime("%Y%m%d%H%M%SZ")))
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001279
1280
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001281 def test_gmtime_adj_notAfter_wrong_args(self):
1282 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001283 :py:obj:`X509Type.gmtime_adj_notAfter` raises :py:obj:`TypeError` if called with the
1284 wrong number of arguments or a non-:py:obj:`int` argument.
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001285 """
1286 cert = X509()
1287 self.assertRaises(TypeError, cert.gmtime_adj_notAfter)
1288 self.assertRaises(TypeError, cert.gmtime_adj_notAfter, None)
1289 self.assertRaises(TypeError, cert.gmtime_adj_notAfter, 123, None)
1290
1291
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001292 def test_gmtime_adj_notAfter(self):
1293 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001294 :py:obj:`X509Type.gmtime_adj_notAfter` changes the not-after timestamp to be
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001295 the current time plus the number of seconds passed in.
1296 """
1297 cert = load_certificate(FILETYPE_PEM, self.pemData)
1298 now = datetime.utcnow() + timedelta(seconds=100)
1299 cert.gmtime_adj_notAfter(100)
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001300 self.assertEqual(cert.get_notAfter(), b(now.strftime("%Y%m%d%H%M%SZ")))
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001301
1302
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001303 def test_has_expired_wrong_args(self):
1304 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001305 :py:obj:`X509Type.has_expired` raises :py:obj:`TypeError` if called with any
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001306 arguments.
1307 """
1308 cert = X509()
1309 self.assertRaises(TypeError, cert.has_expired, None)
1310
1311
1312 def test_has_expired(self):
1313 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001314 :py:obj:`X509Type.has_expired` returns :py:obj:`True` if the certificate's not-after
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001315 time is in the past.
1316 """
1317 cert = X509()
1318 cert.gmtime_adj_notAfter(-1)
1319 self.assertTrue(cert.has_expired())
1320
1321
1322 def test_has_not_expired(self):
1323 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001324 :py:obj:`X509Type.has_expired` returns :py:obj:`False` if the certificate's not-after
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001325 time is in the future.
1326 """
1327 cert = X509()
1328 cert.gmtime_adj_notAfter(2)
1329 self.assertFalse(cert.has_expired())
1330
1331
Rick Dean38a05c82009-07-18 01:41:30 -05001332 def test_digest(self):
1333 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001334 :py:obj:`X509.digest` returns a string giving ":"-separated hex-encoded words
Rick Dean38a05c82009-07-18 01:41:30 -05001335 of the digest of the certificate.
1336 """
1337 cert = X509()
1338 self.assertEqual(
1339 cert.digest("md5"),
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001340 b("A8:EB:07:F8:53:25:0A:F2:56:05:C5:A5:C4:C4:C7:15"))
Rick Dean38a05c82009-07-18 01:41:30 -05001341
1342
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001343 def _extcert(self, pkey, extensions):
1344 cert = X509()
1345 cert.set_pubkey(pkey)
1346 cert.get_subject().commonName = "Unit Tests"
1347 cert.get_issuer().commonName = "Unit Tests"
1348 when = b(datetime.now().strftime("%Y%m%d%H%M%SZ"))
1349 cert.set_notBefore(when)
1350 cert.set_notAfter(when)
1351
1352 cert.add_extensions(extensions)
1353 return load_certificate(
1354 FILETYPE_PEM, dump_certificate(FILETYPE_PEM, cert))
1355
1356
Roland Hedberg7e4930e2008-04-22 22:58:50 +02001357 def test_extension_count(self):
1358 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001359 :py:obj:`X509.get_extension_count` returns the number of extensions that are
Jean-Paul Calderonef7b3ee62011-04-01 17:36:24 -04001360 present in the certificate.
Roland Hedberg7e4930e2008-04-22 22:58:50 +02001361 """
Jean-Paul Calderonef7b3ee62011-04-01 17:36:24 -04001362 pkey = load_privatekey(FILETYPE_PEM, client_key_pem)
Jean-Paul Calderone90abbc02011-04-06 18:20:22 -04001363 ca = X509Extension(b('basicConstraints'), True, b('CA:FALSE'))
1364 key = X509Extension(b('keyUsage'), True, b('digitalSignature'))
Jean-Paul Calderonef7b3ee62011-04-01 17:36:24 -04001365 subjectAltName = X509Extension(
Jean-Paul Calderone90abbc02011-04-06 18:20:22 -04001366 b('subjectAltName'), True, b('DNS:example.com'))
Jean-Paul Calderonef7b3ee62011-04-01 17:36:24 -04001367
1368 # Try a certificate with no extensions at all.
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001369 c = self._extcert(pkey, [])
Jean-Paul Calderonef7b3ee62011-04-01 17:36:24 -04001370 self.assertEqual(c.get_extension_count(), 0)
1371
1372 # And a certificate with one
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001373 c = self._extcert(pkey, [ca])
Jean-Paul Calderonef7b3ee62011-04-01 17:36:24 -04001374 self.assertEqual(c.get_extension_count(), 1)
1375
1376 # And a certificate with several
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001377 c = self._extcert(pkey, [ca, key, subjectAltName])
Jean-Paul Calderonef7b3ee62011-04-01 17:36:24 -04001378 self.assertEqual(c.get_extension_count(), 3)
Roland Hedberg7e4930e2008-04-22 22:58:50 +02001379
1380
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001381 def test_get_extension(self):
1382 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001383 :py:obj:`X509.get_extension` takes an integer and returns an :py:obj:`X509Extension`
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001384 corresponding to the extension at that index.
1385 """
1386 pkey = load_privatekey(FILETYPE_PEM, client_key_pem)
Jean-Paul Calderone90abbc02011-04-06 18:20:22 -04001387 ca = X509Extension(b('basicConstraints'), True, b('CA:FALSE'))
1388 key = X509Extension(b('keyUsage'), True, b('digitalSignature'))
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001389 subjectAltName = X509Extension(
Jean-Paul Calderone90abbc02011-04-06 18:20:22 -04001390 b('subjectAltName'), False, b('DNS:example.com'))
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001391
1392 cert = self._extcert(pkey, [ca, key, subjectAltName])
1393
1394 ext = cert.get_extension(0)
1395 self.assertTrue(isinstance(ext, X509Extension))
1396 self.assertTrue(ext.get_critical())
Jean-Paul Calderone90abbc02011-04-06 18:20:22 -04001397 self.assertEqual(ext.get_short_name(), b('basicConstraints'))
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001398
1399 ext = cert.get_extension(1)
1400 self.assertTrue(isinstance(ext, X509Extension))
1401 self.assertTrue(ext.get_critical())
Jean-Paul Calderone90abbc02011-04-06 18:20:22 -04001402 self.assertEqual(ext.get_short_name(), b('keyUsage'))
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001403
1404 ext = cert.get_extension(2)
1405 self.assertTrue(isinstance(ext, X509Extension))
1406 self.assertFalse(ext.get_critical())
Jean-Paul Calderone90abbc02011-04-06 18:20:22 -04001407 self.assertEqual(ext.get_short_name(), b('subjectAltName'))
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001408
1409 self.assertRaises(IndexError, cert.get_extension, -1)
1410 self.assertRaises(IndexError, cert.get_extension, 4)
1411 self.assertRaises(TypeError, cert.get_extension, "hello")
1412
1413
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04001414 def test_invalid_digest_algorithm(self):
1415 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001416 :py:obj:`X509.digest` raises :py:obj:`ValueError` if called with an unrecognized hash
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04001417 algorithm.
1418 """
1419 cert = X509()
1420 self.assertRaises(ValueError, cert.digest, "monkeys")
1421
1422
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001423 def test_get_subject_wrong_args(self):
1424 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001425 :py:obj:`X509.get_subject` raises :py:obj:`TypeError` if called with any arguments.
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001426 """
1427 cert = X509()
1428 self.assertRaises(TypeError, cert.get_subject, None)
1429
1430
1431 def test_get_subject(self):
1432 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001433 :py:obj:`X509.get_subject` returns an :py:obj:`X509Name` instance.
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001434 """
1435 cert = load_certificate(FILETYPE_PEM, self.pemData)
1436 subj = cert.get_subject()
1437 self.assertTrue(isinstance(subj, X509Name))
1438 self.assertEquals(
1439 subj.get_components(),
Jean-Paul Calderonedc3275f2010-08-22 17:04:09 -04001440 [(b('C'), b('US')), (b('ST'), b('IL')), (b('L'), b('Chicago')),
1441 (b('O'), b('Testing')), (b('CN'), b('Testing Root CA'))])
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001442
1443
1444 def test_set_subject_wrong_args(self):
1445 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001446 :py:obj:`X509.set_subject` raises a :py:obj:`TypeError` if called with the wrong
1447 number of arguments or an argument not of type :py:obj:`X509Name`.
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001448 """
1449 cert = X509()
1450 self.assertRaises(TypeError, cert.set_subject)
1451 self.assertRaises(TypeError, cert.set_subject, None)
1452 self.assertRaises(TypeError, cert.set_subject, cert.get_subject(), None)
1453
1454
1455 def test_set_subject(self):
1456 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001457 :py:obj:`X509.set_subject` changes the subject of the certificate to the one
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001458 passed in.
1459 """
1460 cert = X509()
1461 name = cert.get_subject()
1462 name.C = 'AU'
1463 name.O = 'Unit Tests'
1464 cert.set_subject(name)
1465 self.assertEquals(
1466 cert.get_subject().get_components(),
Jean-Paul Calderonedc3275f2010-08-22 17:04:09 -04001467 [(b('C'), b('AU')), (b('O'), b('Unit Tests'))])
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001468
1469
1470 def test_get_issuer_wrong_args(self):
1471 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001472 :py:obj:`X509.get_issuer` raises :py:obj:`TypeError` if called with any arguments.
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001473 """
1474 cert = X509()
1475 self.assertRaises(TypeError, cert.get_issuer, None)
1476
1477
1478 def test_get_issuer(self):
1479 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001480 :py:obj:`X509.get_issuer` returns an :py:obj:`X509Name` instance.
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001481 """
1482 cert = load_certificate(FILETYPE_PEM, self.pemData)
1483 subj = cert.get_issuer()
1484 self.assertTrue(isinstance(subj, X509Name))
Jean-Paul Calderone30a4cb32010-08-11 23:54:12 -04001485 comp = subj.get_components()
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001486 self.assertEquals(
Jean-Paul Calderone30a4cb32010-08-11 23:54:12 -04001487 comp,
Jean-Paul Calderonedc3275f2010-08-22 17:04:09 -04001488 [(b('C'), b('US')), (b('ST'), b('IL')), (b('L'), b('Chicago')),
1489 (b('O'), b('Testing')), (b('CN'), b('Testing Root CA'))])
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001490
1491
1492 def test_set_issuer_wrong_args(self):
1493 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001494 :py:obj:`X509.set_issuer` raises a :py:obj:`TypeError` if called with the wrong
1495 number of arguments or an argument not of type :py:obj:`X509Name`.
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001496 """
1497 cert = X509()
1498 self.assertRaises(TypeError, cert.set_issuer)
1499 self.assertRaises(TypeError, cert.set_issuer, None)
1500 self.assertRaises(TypeError, cert.set_issuer, cert.get_issuer(), None)
1501
1502
1503 def test_set_issuer(self):
1504 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001505 :py:obj:`X509.set_issuer` changes the issuer of the certificate to the one
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001506 passed in.
1507 """
1508 cert = X509()
1509 name = cert.get_issuer()
1510 name.C = 'AU'
1511 name.O = 'Unit Tests'
1512 cert.set_issuer(name)
1513 self.assertEquals(
1514 cert.get_issuer().get_components(),
Jean-Paul Calderonedc3275f2010-08-22 17:04:09 -04001515 [(b('C'), b('AU')), (b('O'), b('Unit Tests'))])
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001516
1517
1518 def test_get_pubkey_uninitialized(self):
1519 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001520 When called on a certificate with no public key, :py:obj:`X509.get_pubkey`
1521 raises :py:obj:`OpenSSL.crypto.Error`.
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001522 """
1523 cert = X509()
1524 self.assertRaises(Error, cert.get_pubkey)
1525
1526
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001527 def test_subject_name_hash_wrong_args(self):
1528 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001529 :py:obj:`X509.subject_name_hash` raises :py:obj:`TypeError` if called with any
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001530 arguments.
1531 """
1532 cert = X509()
1533 self.assertRaises(TypeError, cert.subject_name_hash, None)
1534
1535
1536 def test_subject_name_hash(self):
1537 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001538 :py:obj:`X509.subject_name_hash` returns the hash of the certificate's subject
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001539 name.
1540 """
1541 cert = load_certificate(FILETYPE_PEM, self.pemData)
Jean-Paul Calderone060a57e2011-05-04 18:02:49 -04001542 self.assertIn(
Jean-Paul Calderone2755fa52011-05-18 19:42:10 -04001543 cert.subject_name_hash(),
Jean-Paul Calderone060a57e2011-05-04 18:02:49 -04001544 [3350047874, # OpenSSL 0.9.8, MD5
1545 3278919224, # OpenSSL 1.0.0, SHA1
1546 ])
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001547
1548
Jean-Paul Calderone2755fa52011-05-18 19:42:10 -04001549 def test_get_signature_algorithm(self):
1550 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001551 :py:obj:`X509Type.get_signature_algorithm` returns a string which means
Jean-Paul Calderone2755fa52011-05-18 19:42:10 -04001552 the algorithm used to sign the certificate.
1553 """
1554 cert = load_certificate(FILETYPE_PEM, self.pemData)
Jean-Paul Calderone5d8e4052011-05-19 17:51:43 -04001555 self.assertEqual(
1556 b("sha1WithRSAEncryption"), cert.get_signature_algorithm())
Jean-Paul Calderone2755fa52011-05-18 19:42:10 -04001557
1558
1559 def test_get_undefined_signature_algorithm(self):
Jean-Paul Calderone5d8e4052011-05-19 17:51:43 -04001560 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001561 :py:obj:`X509Type.get_signature_algorithm` raises :py:obj:`ValueError` if the
Jean-Paul Calderone5d8e4052011-05-19 17:51:43 -04001562 signature algorithm is undefined or unknown.
1563 """
1564 # This certificate has been modified to indicate a bogus OID in the
1565 # signature algorithm field so that OpenSSL does not recognize it.
Jean-Paul Calderone2755fa52011-05-18 19:42:10 -04001566 certPEM = """\
1567-----BEGIN CERTIFICATE-----
1568MIIC/zCCAmigAwIBAgIBATAGBgJ8BQUAMHsxCzAJBgNVBAYTAlNHMREwDwYDVQQK
1569EwhNMkNyeXB0bzEUMBIGA1UECxMLTTJDcnlwdG8gQ0ExJDAiBgNVBAMTG00yQ3J5
1570cHRvIENlcnRpZmljYXRlIE1hc3RlcjEdMBsGCSqGSIb3DQEJARYObmdwc0Bwb3N0
1571MS5jb20wHhcNMDAwOTEwMDk1MTMwWhcNMDIwOTEwMDk1MTMwWjBTMQswCQYDVQQG
1572EwJTRzERMA8GA1UEChMITTJDcnlwdG8xEjAQBgNVBAMTCWxvY2FsaG9zdDEdMBsG
1573CSqGSIb3DQEJARYObmdwc0Bwb3N0MS5jb20wXDANBgkqhkiG9w0BAQEFAANLADBI
1574AkEArL57d26W9fNXvOhNlZzlPOACmvwOZ5AdNgLzJ1/MfsQQJ7hHVeHmTAjM664V
1575+fXvwUGJLziCeBo1ysWLRnl8CQIDAQABo4IBBDCCAQAwCQYDVR0TBAIwADAsBglg
1576hkgBhvhCAQ0EHxYdT3BlblNTTCBHZW5lcmF0ZWQgQ2VydGlmaWNhdGUwHQYDVR0O
1577BBYEFM+EgpK+eyZiwFU1aOPSbczbPSpVMIGlBgNVHSMEgZ0wgZqAFPuHI2nrnDqT
1578FeXFvylRT/7tKDgBoX+kfTB7MQswCQYDVQQGEwJTRzERMA8GA1UEChMITTJDcnlw
1579dG8xFDASBgNVBAsTC00yQ3J5cHRvIENBMSQwIgYDVQQDExtNMkNyeXB0byBDZXJ0
1580aWZpY2F0ZSBNYXN0ZXIxHTAbBgkqhkiG9w0BCQEWDm5ncHNAcG9zdDEuY29tggEA
1581MA0GCSqGSIb3DQEBBAUAA4GBADv8KpPo+gfJxN2ERK1Y1l17sz/ZhzoGgm5XCdbx
1582jEY7xKfpQngV599k1xhl11IMqizDwu0855agrckg2MCTmOI9DZzDD77tAYb+Dk0O
1583PEVk0Mk/V0aIsDE9bolfCi/i/QWZ3N8s5nTWMNyBBBmoSliWCm4jkkRZRD0ejgTN
1584tgI5
1585-----END CERTIFICATE-----
1586"""
1587 cert = load_certificate(FILETYPE_PEM, certPEM)
1588 self.assertRaises(ValueError, cert.get_signature_algorithm)
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001589
1590
Rick Dean38a05c82009-07-18 01:41:30 -05001591
Jean-Paul Calderonea63714c2013-03-05 17:02:26 -08001592class X509StoreTests(TestCase):
1593 """
1594 Test for :py:obj:`OpenSSL.crypto.X509Store`.
1595 """
1596 def test_type(self):
1597 """
1598 :py:obj:`X509StoreType` is a type object.
1599 """
1600 self.assertIdentical(X509Store, X509StoreType)
1601 self.assertConsistentType(X509Store, 'X509Store')
1602
1603
1604 def test_add_cert_wrong_args(self):
1605 store = X509Store()
1606 self.assertRaises(TypeError, store.add_cert)
1607 self.assertRaises(TypeError, store.add_cert, object())
1608 self.assertRaises(TypeError, store.add_cert, X509(), object())
1609
1610
1611 def test_add_cert(self):
1612 store = X509Store()
1613 store.add_cert(X509())
1614
1615
1616
Rick Dean623ee362009-07-17 12:22:16 -05001617class PKCS12Tests(TestCase):
1618 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001619 Test for :py:obj:`OpenSSL.crypto.PKCS12` and :py:obj:`OpenSSL.crypto.load_pkcs12`.
Rick Dean623ee362009-07-17 12:22:16 -05001620 """
1621 pemData = cleartextCertificatePEM + cleartextPrivateKeyPEM
1622
Jean-Paul Calderonec3a41f72009-07-25 12:36:02 -04001623 def test_type(self):
1624 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001625 :py:obj:`PKCS12Type` is a type object.
Jean-Paul Calderonec3a41f72009-07-25 12:36:02 -04001626 """
1627 self.assertIdentical(PKCS12, PKCS12Type)
1628 self.assertConsistentType(PKCS12, 'PKCS12')
1629
1630
Rick Deanf94096c2009-07-18 14:23:06 -05001631 def test_empty_construction(self):
Rick Dean38a05c82009-07-18 01:41:30 -05001632 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001633 :py:obj:`PKCS12` returns a new instance of :py:obj:`PKCS12` with no certificate,
Jean-Paul Calderonedc857b52009-07-25 12:25:07 -04001634 private key, CA certificates, or friendly name.
Rick Dean38a05c82009-07-18 01:41:30 -05001635 """
Jean-Paul Calderonea202edb2009-07-25 12:22:12 -04001636 p12 = PKCS12()
Rick Dean623ee362009-07-17 12:22:16 -05001637 self.assertEqual(None, p12.get_certificate())
1638 self.assertEqual(None, p12.get_privatekey())
1639 self.assertEqual(None, p12.get_ca_certificates())
Rick Dean42d69e12009-07-20 11:36:08 -05001640 self.assertEqual(None, p12.get_friendlyname())
Rick Dean623ee362009-07-17 12:22:16 -05001641
Rick Dean38a05c82009-07-18 01:41:30 -05001642
Rick Dean623ee362009-07-17 12:22:16 -05001643 def test_type_errors(self):
Rick Dean38a05c82009-07-18 01:41:30 -05001644 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001645 The :py:obj:`PKCS12` setter functions (:py:obj:`set_certificate`, :py:obj:`set_privatekey`,
1646 :py:obj:`set_ca_certificates`, and :py:obj:`set_friendlyname`) raise :py:obj:`TypeError`
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001647 when passed objects of types other than those expected.
Rick Dean38a05c82009-07-18 01:41:30 -05001648 """
Jean-Paul Calderonea202edb2009-07-25 12:22:12 -04001649 p12 = PKCS12()
Rick Dean623ee362009-07-17 12:22:16 -05001650 self.assertRaises(TypeError, p12.set_certificate, 3)
Rick Deanf94096c2009-07-18 14:23:06 -05001651 self.assertRaises(TypeError, p12.set_certificate, PKey())
1652 self.assertRaises(TypeError, p12.set_certificate, X509)
Rick Dean623ee362009-07-17 12:22:16 -05001653 self.assertRaises(TypeError, p12.set_privatekey, 3)
Rick Deanf94096c2009-07-18 14:23:06 -05001654 self.assertRaises(TypeError, p12.set_privatekey, 'legbone')
1655 self.assertRaises(TypeError, p12.set_privatekey, X509())
Rick Dean623ee362009-07-17 12:22:16 -05001656 self.assertRaises(TypeError, p12.set_ca_certificates, 3)
1657 self.assertRaises(TypeError, p12.set_ca_certificates, X509())
1658 self.assertRaises(TypeError, p12.set_ca_certificates, (3, 4))
Rick Deanf94096c2009-07-18 14:23:06 -05001659 self.assertRaises(TypeError, p12.set_ca_certificates, ( PKey(), ))
Rick Dean42d69e12009-07-20 11:36:08 -05001660 self.assertRaises(TypeError, p12.set_friendlyname, 6)
1661 self.assertRaises(TypeError, p12.set_friendlyname, ('foo', 'bar'))
Rick Dean623ee362009-07-17 12:22:16 -05001662
Rick Dean38a05c82009-07-18 01:41:30 -05001663
Rick Dean623ee362009-07-17 12:22:16 -05001664 def test_key_only(self):
1665 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001666 A :py:obj:`PKCS12` with only a private key can be exported using
1667 :py:obj:`PKCS12.export` and loaded again using :py:obj:`load_pkcs12`.
Rick Dean623ee362009-07-17 12:22:16 -05001668 """
1669 passwd = 'blah'
1670 p12 = PKCS12()
Jean-Paul Calderonea202edb2009-07-25 12:22:12 -04001671 pkey = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001672 p12.set_privatekey(pkey)
Rick Dean623ee362009-07-17 12:22:16 -05001673 self.assertEqual(None, p12.get_certificate())
1674 self.assertEqual(pkey, p12.get_privatekey())
Rick Dean321a0512009-08-13 17:21:29 -05001675 try:
1676 dumped_p12 = p12.export(passphrase=passwd, iter=2, maciter=3)
1677 except Error:
1678 # Some versions of OpenSSL will throw an exception
1679 # for this nearly useless PKCS12 we tried to generate:
1680 # [('PKCS12 routines', 'PKCS12_create', 'invalid null argument')]
1681 return
Rick Dean623ee362009-07-17 12:22:16 -05001682 p12 = load_pkcs12(dumped_p12, passwd)
1683 self.assertEqual(None, p12.get_ca_certificates())
1684 self.assertEqual(None, p12.get_certificate())
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001685
1686 # OpenSSL fails to bring the key back to us. So sad. Perhaps in the
1687 # future this will be improved.
1688 self.assertTrue(isinstance(p12.get_privatekey(), (PKey, type(None))))
Rick Dean623ee362009-07-17 12:22:16 -05001689
Rick Dean38a05c82009-07-18 01:41:30 -05001690
Rick Dean623ee362009-07-17 12:22:16 -05001691 def test_cert_only(self):
1692 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001693 A :py:obj:`PKCS12` with only a certificate can be exported using
1694 :py:obj:`PKCS12.export` and loaded again using :py:obj:`load_pkcs12`.
Rick Dean623ee362009-07-17 12:22:16 -05001695 """
1696 passwd = 'blah'
1697 p12 = PKCS12()
Jean-Paul Calderonea202edb2009-07-25 12:22:12 -04001698 cert = load_certificate(FILETYPE_PEM, cleartextCertificatePEM)
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001699 p12.set_certificate(cert)
Rick Dean623ee362009-07-17 12:22:16 -05001700 self.assertEqual(cert, p12.get_certificate())
1701 self.assertEqual(None, p12.get_privatekey())
Rick Dean321a0512009-08-13 17:21:29 -05001702 try:
1703 dumped_p12 = p12.export(passphrase=passwd, iter=2, maciter=3)
1704 except Error:
1705 # Some versions of OpenSSL will throw an exception
1706 # for this nearly useless PKCS12 we tried to generate:
1707 # [('PKCS12 routines', 'PKCS12_create', 'invalid null argument')]
1708 return
Rick Dean623ee362009-07-17 12:22:16 -05001709 p12 = load_pkcs12(dumped_p12, passwd)
1710 self.assertEqual(None, p12.get_privatekey())
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001711
1712 # OpenSSL fails to bring the cert back to us. Groany mcgroan.
1713 self.assertTrue(isinstance(p12.get_certificate(), (X509, type(None))))
1714
1715 # Oh ho. It puts the certificate into the ca certificates list, in
1716 # fact. Totally bogus, I would think. Nevertheless, let's exploit
1717 # that to check to see if it reconstructed the certificate we expected
1718 # it to. At some point, hopefully this will change so that
1719 # p12.get_certificate() is actually what returns the loaded
1720 # certificate.
1721 self.assertEqual(
1722 cleartextCertificatePEM,
1723 dump_certificate(FILETYPE_PEM, p12.get_ca_certificates()[0]))
Rick Dean623ee362009-07-17 12:22:16 -05001724
1725
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001726 def gen_pkcs12(self, cert_pem=None, key_pem=None, ca_pem=None, friendly_name=None):
Rick Dean623ee362009-07-17 12:22:16 -05001727 """
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001728 Generate a PKCS12 object with components from PEM. Verify that the set
1729 functions return None.
Rick Dean623ee362009-07-17 12:22:16 -05001730 """
Rick Deanf94096c2009-07-18 14:23:06 -05001731 p12 = PKCS12()
1732 if cert_pem:
1733 ret = p12.set_certificate(load_certificate(FILETYPE_PEM, cert_pem))
1734 self.assertEqual(ret, None)
1735 if key_pem:
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001736 ret = p12.set_privatekey(load_privatekey(FILETYPE_PEM, key_pem))
Rick Deanf94096c2009-07-18 14:23:06 -05001737 self.assertEqual(ret, None)
1738 if ca_pem:
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001739 ret = p12.set_ca_certificates((load_certificate(FILETYPE_PEM, ca_pem),))
Rick Deanf94096c2009-07-18 14:23:06 -05001740 self.assertEqual(ret, None)
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001741 if friendly_name:
1742 ret = p12.set_friendlyname(friendly_name)
Rick Dean42d69e12009-07-20 11:36:08 -05001743 self.assertEqual(ret, None)
Rick Deanf94096c2009-07-18 14:23:06 -05001744 return p12
1745
1746
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001747 def check_recovery(self, p12_str, key=None, cert=None, ca=None, passwd='',
1748 extra=()):
Rick Deanf94096c2009-07-18 14:23:06 -05001749 """
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001750 Use openssl program to confirm three components are recoverable from a
1751 PKCS12 string.
Rick Deanf94096c2009-07-18 14:23:06 -05001752 """
1753 if key:
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001754 recovered_key = _runopenssl(
1755 p12_str, "pkcs12", '-nocerts', '-nodes', '-passin',
1756 'pass:' + passwd, *extra)
Rick Deanf94096c2009-07-18 14:23:06 -05001757 self.assertEqual(recovered_key[-len(key):], key)
1758 if cert:
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001759 recovered_cert = _runopenssl(
1760 p12_str, "pkcs12", '-clcerts', '-nodes', '-passin',
1761 'pass:' + passwd, '-nokeys', *extra)
Rick Deanf94096c2009-07-18 14:23:06 -05001762 self.assertEqual(recovered_cert[-len(cert):], cert)
1763 if ca:
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001764 recovered_cert = _runopenssl(
1765 p12_str, "pkcs12", '-cacerts', '-nodes', '-passin',
1766 'pass:' + passwd, '-nokeys', *extra)
Rick Deanf94096c2009-07-18 14:23:06 -05001767 self.assertEqual(recovered_cert[-len(ca):], ca)
1768
1769
1770 def test_load_pkcs12(self):
1771 """
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001772 A PKCS12 string generated using the openssl command line can be loaded
Jonathan Ballet648875f2011-07-16 14:14:58 +09001773 with :py:obj:`load_pkcs12` and its components extracted and examined.
Rick Deanf94096c2009-07-18 14:23:06 -05001774 """
Rick Dean623ee362009-07-17 12:22:16 -05001775 passwd = 'whatever'
1776 pem = client_key_pem + client_cert_pem
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001777 p12_str = _runopenssl(
1778 pem, "pkcs12", '-export', '-clcerts', '-passout', 'pass:' + passwd)
Rick Dean623ee362009-07-17 12:22:16 -05001779 p12 = load_pkcs12(p12_str, passwd)
Jean-Paul Calderonea202edb2009-07-25 12:22:12 -04001780 # verify
Rick Deanf94096c2009-07-18 14:23:06 -05001781 self.assertTrue(isinstance(p12, PKCS12))
Rick Dean623ee362009-07-17 12:22:16 -05001782 cert_pem = dump_certificate(FILETYPE_PEM, p12.get_certificate())
1783 self.assertEqual(cert_pem, client_cert_pem)
1784 key_pem = dump_privatekey(FILETYPE_PEM, p12.get_privatekey())
1785 self.assertEqual(key_pem, client_key_pem)
1786 self.assertEqual(None, p12.get_ca_certificates())
Rick Deanf94096c2009-07-18 14:23:06 -05001787
Rick Deanee568302009-07-24 09:56:29 -05001788
1789 def test_load_pkcs12_garbage(self):
1790 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001791 :py:obj:`load_pkcs12` raises :py:obj:`OpenSSL.crypto.Error` when passed a string
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001792 which is not a PKCS12 dump.
Rick Deanee568302009-07-24 09:56:29 -05001793 """
1794 passwd = 'whatever'
1795 e = self.assertRaises(Error, load_pkcs12, 'fruit loops', passwd)
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -04001796 self.assertEqual( e.args[0][0][0], 'asn1 encoding routines')
1797 self.assertEqual( len(e.args[0][0]), 3)
Rick Deanee568302009-07-24 09:56:29 -05001798
1799
Rick Deanf94096c2009-07-18 14:23:06 -05001800 def test_replace(self):
1801 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001802 :py:obj:`PKCS12.set_certificate` replaces the certificate in a PKCS12 cluster.
1803 :py:obj:`PKCS12.set_privatekey` replaces the private key.
1804 :py:obj:`PKCS12.set_ca_certificates` replaces the CA certificates.
Rick Deanf94096c2009-07-18 14:23:06 -05001805 """
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001806 p12 = self.gen_pkcs12(client_cert_pem, client_key_pem, root_cert_pem)
1807 p12.set_certificate(load_certificate(FILETYPE_PEM, server_cert_pem))
1808 p12.set_privatekey(load_privatekey(FILETYPE_PEM, server_key_pem))
Jean-Paul Calderonea202edb2009-07-25 12:22:12 -04001809 root_cert = load_certificate(FILETYPE_PEM, root_cert_pem)
Rick Deanf94096c2009-07-18 14:23:06 -05001810 client_cert = load_certificate(FILETYPE_PEM, client_cert_pem)
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001811 p12.set_ca_certificates([root_cert]) # not a tuple
Rick Dean623ee362009-07-17 12:22:16 -05001812 self.assertEqual(1, len(p12.get_ca_certificates()))
1813 self.assertEqual(root_cert, p12.get_ca_certificates()[0])
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001814 p12.set_ca_certificates([client_cert, root_cert])
Rick Deanf94096c2009-07-18 14:23:06 -05001815 self.assertEqual(2, len(p12.get_ca_certificates()))
1816 self.assertEqual(client_cert, p12.get_ca_certificates()[0])
1817 self.assertEqual(root_cert, p12.get_ca_certificates()[1])
1818
1819
1820 def test_friendly_name(self):
1821 """
Jean-Paul Calderone64efa2c2011-09-11 10:00:09 -04001822 The *friendlyName* of a PKCS12 can be set and retrieved via
Jonathan Ballet648875f2011-07-16 14:14:58 +09001823 :py:obj:`PKCS12.get_friendlyname` and :py:obj:`PKCS12_set_friendlyname`, and a
1824 :py:obj:`PKCS12` with a friendly name set can be dumped with :py:obj:`PKCS12.export`.
Rick Deanf94096c2009-07-18 14:23:06 -05001825 """
Rick Deanf94096c2009-07-18 14:23:06 -05001826 passwd = 'Dogmeat[]{}!@#$%^&*()~`?/.,<>-_+=";:'
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001827 p12 = self.gen_pkcs12(server_cert_pem, server_key_pem, root_cert_pem)
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -04001828 for friendly_name in [b('Serverlicious'), None, b('###')]:
Rick Dean42d69e12009-07-20 11:36:08 -05001829 p12.set_friendlyname(friendly_name)
1830 self.assertEqual(p12.get_friendlyname(), friendly_name)
Jean-Paul Calderonea202edb2009-07-25 12:22:12 -04001831 dumped_p12 = p12.export(passphrase=passwd, iter=2, maciter=3)
Rick Dean42d69e12009-07-20 11:36:08 -05001832 reloaded_p12 = load_pkcs12(dumped_p12, passwd)
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001833 self.assertEqual(
Jean-Paul Calderone9da338d2011-05-04 11:40:54 -04001834 p12.get_friendlyname(), reloaded_p12.get_friendlyname())
Jean-Paul Calderonea202edb2009-07-25 12:22:12 -04001835 # We would use the openssl program to confirm the friendly
1836 # name, but it is not possible. The pkcs12 command
1837 # does not store the friendly name in the cert's
Rick Dean42d69e12009-07-20 11:36:08 -05001838 # alias, which we could then extract.
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001839 self.check_recovery(
1840 dumped_p12, key=server_key_pem, cert=server_cert_pem,
1841 ca=root_cert_pem, passwd=passwd)
Rick Deanf94096c2009-07-18 14:23:06 -05001842
1843
1844 def test_various_empty_passphrases(self):
1845 """
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001846 Test that missing, None, and '' passphrases are identical for PKCS12
1847 export.
Rick Deanf94096c2009-07-18 14:23:06 -05001848 """
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001849 p12 = self.gen_pkcs12(client_cert_pem, client_key_pem, root_cert_pem)
Rick Dean623ee362009-07-17 12:22:16 -05001850 passwd = ''
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001851 dumped_p12_empty = p12.export(iter=2, maciter=0, passphrase=passwd)
1852 dumped_p12_none = p12.export(iter=3, maciter=2, passphrase=None)
1853 dumped_p12_nopw = p12.export(iter=9, maciter=4)
1854 for dumped_p12 in [dumped_p12_empty, dumped_p12_none, dumped_p12_nopw]:
1855 self.check_recovery(
1856 dumped_p12, key=client_key_pem, cert=client_cert_pem,
1857 ca=root_cert_pem, passwd=passwd)
Rick Deanf94096c2009-07-18 14:23:06 -05001858
1859
1860 def test_removing_ca_cert(self):
1861 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001862 Passing :py:obj:`None` to :py:obj:`PKCS12.set_ca_certificates` removes all CA
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001863 certificates.
Rick Deanf94096c2009-07-18 14:23:06 -05001864 """
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001865 p12 = self.gen_pkcs12(server_cert_pem, server_key_pem, root_cert_pem)
1866 p12.set_ca_certificates(None)
Rick Dean623ee362009-07-17 12:22:16 -05001867 self.assertEqual(None, p12.get_ca_certificates())
Rick Deanf94096c2009-07-18 14:23:06 -05001868
1869
1870 def test_export_without_mac(self):
1871 """
Jean-Paul Calderone64efa2c2011-09-11 10:00:09 -04001872 Exporting a PKCS12 with a :py:obj:`maciter` of ``-1`` excludes the MAC
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001873 entirely.
Rick Deanf94096c2009-07-18 14:23:06 -05001874 """
1875 passwd = 'Lake Michigan'
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001876 p12 = self.gen_pkcs12(server_cert_pem, server_key_pem, root_cert_pem)
Rick Dean623ee362009-07-17 12:22:16 -05001877 dumped_p12 = p12.export(maciter=-1, passphrase=passwd, iter=2)
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001878 self.check_recovery(
1879 dumped_p12, key=server_key_pem, cert=server_cert_pem,
1880 passwd=passwd, extra=('-nomacver',))
1881
1882
1883 def test_load_without_mac(self):
1884 """
1885 Loading a PKCS12 without a MAC does something other than crash.
1886 """
1887 passwd = 'Lake Michigan'
1888 p12 = self.gen_pkcs12(server_cert_pem, server_key_pem, root_cert_pem)
1889 dumped_p12 = p12.export(maciter=-1, passphrase=passwd, iter=2)
Rick Dean321a0512009-08-13 17:21:29 -05001890 try:
1891 recovered_p12 = load_pkcs12(dumped_p12, passwd)
1892 # The person who generated this PCKS12 should be flogged,
1893 # or better yet we should have a means to determine
1894 # whether a PCKS12 had a MAC that was verified.
1895 # Anyway, libopenssl chooses to allow it, so the
1896 # pyopenssl binding does as well.
1897 self.assertTrue(isinstance(recovered_p12, PKCS12))
1898 except Error:
1899 # Failing here with an exception is preferred as some openssl
1900 # versions do.
1901 pass
Rick Dean623ee362009-07-17 12:22:16 -05001902
Jean-Paul Calderone38a646d2008-03-25 15:16:18 -04001903
Rick Dean25bcc1f2009-07-20 11:53:13 -05001904 def test_zero_len_list_for_ca(self):
1905 """
Jean-Paul Calderoneda1ffa72009-07-25 21:24:34 -04001906 A PKCS12 with an empty CA certificates list can be exported.
Rick Dean25bcc1f2009-07-20 11:53:13 -05001907 """
1908 passwd = 'Hobie 18'
Jean-Paul Calderoneda1ffa72009-07-25 21:24:34 -04001909 p12 = self.gen_pkcs12(server_cert_pem, server_key_pem)
Jean-Paul Calderonef6745b32013-03-01 15:08:46 -08001910 # p12.set_ca_certificates([])
1911 # self.assertEqual((), p12.get_ca_certificates())
1912 # dumped_p12 = p12.export(passphrase=passwd, iter=3)
1913 # self.check_recovery(
1914 # dumped_p12, key=server_key_pem, cert=server_cert_pem,
1915 # passwd=passwd)
Rick Dean25bcc1f2009-07-20 11:53:13 -05001916
1917
Rick Deanf94096c2009-07-18 14:23:06 -05001918 def test_export_without_args(self):
Jean-Paul Calderone38a646d2008-03-25 15:16:18 -04001919 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001920 All the arguments to :py:obj:`PKCS12.export` are optional.
Jean-Paul Calderone38a646d2008-03-25 15:16:18 -04001921 """
Jean-Paul Calderoneda1ffa72009-07-25 21:24:34 -04001922 p12 = self.gen_pkcs12(server_cert_pem, server_key_pem, root_cert_pem)
Rick Deanf94096c2009-07-18 14:23:06 -05001923 dumped_p12 = p12.export() # no args
Jean-Paul Calderoneda1ffa72009-07-25 21:24:34 -04001924 self.check_recovery(
1925 dumped_p12, key=server_key_pem, cert=server_cert_pem, passwd='')
Rick Deanf94096c2009-07-18 14:23:06 -05001926
1927
1928 def test_key_cert_mismatch(self):
1929 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001930 :py:obj:`PKCS12.export` raises an exception when a key and certificate
Jean-Paul Calderoneda1ffa72009-07-25 21:24:34 -04001931 mismatch.
Rick Deanf94096c2009-07-18 14:23:06 -05001932 """
Jean-Paul Calderoneda1ffa72009-07-25 21:24:34 -04001933 p12 = self.gen_pkcs12(server_cert_pem, client_key_pem, root_cert_pem)
1934 self.assertRaises(Error, p12.export)
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04001935
1936
1937
Jean-Paul Calderone7b874db2009-08-27 12:32:47 -04001938# These quoting functions taken directly from Twisted's twisted.python.win32.
1939_cmdLineQuoteRe = re.compile(r'(\\*)"')
1940_cmdLineQuoteRe2 = re.compile(r'(\\+)\Z')
1941def cmdLineQuote(s):
1942 """
1943 Internal method for quoting a single command-line argument.
1944
Jean-Paul Calderone64efa2c2011-09-11 10:00:09 -04001945 See http://www.perlmonks.org/?node_id=764004
1946
Jonathan Ballet648875f2011-07-16 14:14:58 +09001947 :type: :py:obj:`str`
Jonathan Ballet78b92a22011-07-16 08:07:26 +09001948 :param s: A single unquoted string to quote for something that is expecting
Jean-Paul Calderone7b874db2009-08-27 12:32:47 -04001949 cmd.exe-style quoting
1950
Jonathan Ballet648875f2011-07-16 14:14:58 +09001951 :rtype: :py:obj:`str`
Jonathan Ballet78b92a22011-07-16 08:07:26 +09001952 :return: A cmd.exe-style quoted string
Jean-Paul Calderone7b874db2009-08-27 12:32:47 -04001953 """
1954 s = _cmdLineQuoteRe2.sub(r"\1\1", _cmdLineQuoteRe.sub(r'\1\1\\"', s))
1955 return '"%s"' % s
1956
1957
1958
1959def quoteArguments(arguments):
1960 """
1961 Quote an iterable of command-line arguments for passing to CreateProcess or
Jonathan Ballet648875f2011-07-16 14:14:58 +09001962 a similar API. This allows the list passed to :py:obj:`reactor.spawnProcess` to
1963 match the child process's :py:obj:`sys.argv` properly.
Jean-Paul Calderone7b874db2009-08-27 12:32:47 -04001964
Jonathan Ballet648875f2011-07-16 14:14:58 +09001965 :type arguments: :py:obj:`iterable` of :py:obj:`str`
Jonathan Ballet78b92a22011-07-16 08:07:26 +09001966 :param arguments: An iterable of unquoted arguments to quote
Jean-Paul Calderone7b874db2009-08-27 12:32:47 -04001967
Jonathan Ballet648875f2011-07-16 14:14:58 +09001968 :rtype: :py:obj:`str`
1969 :return: A space-delimited string containing quoted versions of :py:obj:`arguments`
Jean-Paul Calderone7b874db2009-08-27 12:32:47 -04001970 """
1971 return ' '.join(map(cmdLineQuote, arguments))
1972
1973
Jean-Paul Calderoneb98eae02010-01-30 13:18:04 -05001974
Rick Dean4c9ad612009-07-17 15:05:22 -05001975def _runopenssl(pem, *args):
1976 """
1977 Run the command line openssl tool with the given arguments and write
Rick Dean55d1ce62009-08-13 17:40:24 -05001978 the given PEM to its stdin. Not safe for quotes.
Rick Dean4c9ad612009-07-17 15:05:22 -05001979 """
Jean-Paul Calderone038de952009-08-21 12:16:06 -04001980 if os.name == 'posix':
Jean-Paul Calderone30a4cb32010-08-11 23:54:12 -04001981 command = "openssl " + " ".join([
1982 "'%s'" % (arg.replace("'", "'\\''"),) for arg in args])
Rick Dean55d1ce62009-08-13 17:40:24 -05001983 else:
Jean-Paul Calderone50924502009-08-27 12:47:55 -04001984 command = "openssl " + quoteArguments(args)
Jean-Paul Calderone30a4cb32010-08-11 23:54:12 -04001985 proc = Popen(command, shell=True, stdin=PIPE, stdout=PIPE)
Jean-Paul Calderone62ca8da2010-08-11 19:58:08 -04001986 proc.stdin.write(pem)
1987 proc.stdin.close()
Jean-Paul Calderonee82e3252013-03-03 10:14:10 -08001988 output = proc.stdout.read()
1989 proc.stdout.close()
1990 proc.wait()
1991 return output
Rick Dean4c9ad612009-07-17 15:05:22 -05001992
1993
1994
Jean-Paul Calderone18808652009-07-05 12:54:05 -04001995class FunctionTests(TestCase):
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04001996 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001997 Tests for free-functions in the :py:obj:`OpenSSL.crypto` module.
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04001998 """
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04001999
2000 def test_load_privatekey_invalid_format(self):
2001 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002002 :py:obj:`load_privatekey` raises :py:obj:`ValueError` if passed an unknown filetype.
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04002003 """
2004 self.assertRaises(ValueError, load_privatekey, 100, root_key_pem)
2005
2006
2007 def test_load_privatekey_invalid_passphrase_type(self):
2008 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002009 :py:obj:`load_privatekey` raises :py:obj:`TypeError` if passed a passphrase that is
Jean-Paul Calderone64efa2c2011-09-11 10:00:09 -04002010 neither a :py:obj:`str` nor a callable.
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04002011 """
2012 self.assertRaises(
2013 TypeError,
2014 load_privatekey,
2015 FILETYPE_PEM, encryptedPrivateKeyPEMPassphrase, object())
2016
2017
2018 def test_load_privatekey_wrong_args(self):
2019 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002020 :py:obj:`load_privatekey` raises :py:obj:`TypeError` if called with the wrong number
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04002021 of arguments.
2022 """
2023 self.assertRaises(TypeError, load_privatekey)
2024
2025
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002026 def test_load_privatekey_wrongPassphrase(self):
2027 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002028 :py:obj:`load_privatekey` raises :py:obj:`OpenSSL.crypto.Error` when it is passed an
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002029 encrypted PEM and an incorrect passphrase.
2030 """
2031 self.assertRaises(
2032 Error,
Jean-Paul Calderone5be230f2010-08-22 19:27:58 -04002033 load_privatekey, FILETYPE_PEM, encryptedPrivateKeyPEM, b("quack"))
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002034
2035
Ziga Seilnacht376cf972009-12-22 16:04:10 +01002036 def test_load_privatekey_passphraseWrongType(self):
2037 """
Jean-Paul Calderone5d9d7f12011-09-14 09:48:58 -04002038 :py:obj:`load_privatekey` raises :py:obj:`ValueError` when it is passed a passphrase
Ziga Seilnacht376cf972009-12-22 16:04:10 +01002039 with a private key encoded in a format, that doesn't support
2040 encryption.
2041 """
2042 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
2043 blob = dump_privatekey(FILETYPE_ASN1, key)
2044 self.assertRaises(ValueError,
2045 load_privatekey, FILETYPE_ASN1, blob, "secret")
2046
2047
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002048 def test_load_privatekey_passphrase(self):
2049 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002050 :py:obj:`load_privatekey` can create a :py:obj:`PKey` object from an encrypted PEM
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002051 string if given the passphrase.
2052 """
2053 key = load_privatekey(
2054 FILETYPE_PEM, encryptedPrivateKeyPEM,
2055 encryptedPrivateKeyPEMPassphrase)
2056 self.assertTrue(isinstance(key, PKeyType))
2057
2058
Ziga Seilnacht6b90a402009-12-22 14:33:47 +01002059 def test_load_privatekey_passphrase_exception(self):
2060 """
2061 If the passphrase callback raises an exception, that exception is raised
2062 by :py:obj:`load_privatekey`.
2063 """
2064 def cb(ignored):
2065 raise ArithmeticError
2066
2067 self.assertRaises(ArithmeticError,
2068 load_privatekey, FILETYPE_PEM, encryptedPrivateKeyPEM, cb)
2069
2070
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002071 def test_load_privatekey_wrongPassphraseCallback(self):
2072 """
Jean-Paul Calderoned440a082011-09-14 11:02:05 -04002073 :py:obj:`load_privatekey` raises :py:obj:`OpenSSL.crypto.Error` when it
2074 is passed an encrypted PEM and a passphrase callback which returns an
2075 incorrect passphrase.
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002076 """
2077 called = []
2078 def cb(*a):
2079 called.append(None)
Jean-Paul Calderoned440a082011-09-14 11:02:05 -04002080 return b("quack")
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002081 self.assertRaises(
2082 Error,
2083 load_privatekey, FILETYPE_PEM, encryptedPrivateKeyPEM, cb)
2084 self.assertTrue(called)
2085
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002086
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002087 def test_load_privatekey_passphraseCallback(self):
2088 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002089 :py:obj:`load_privatekey` can create a :py:obj:`PKey` object from an encrypted PEM
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002090 string if given a passphrase callback which returns the correct
2091 password.
2092 """
2093 called = []
2094 def cb(writing):
2095 called.append(writing)
2096 return encryptedPrivateKeyPEMPassphrase
2097 key = load_privatekey(FILETYPE_PEM, encryptedPrivateKeyPEM, cb)
2098 self.assertTrue(isinstance(key, PKeyType))
2099 self.assertEqual(called, [False])
2100
2101
Jean-Paul Calderone105cb952011-09-14 10:16:46 -04002102 def test_load_privatekey_passphrase_wrong_return_type(self):
2103 """
2104 :py:obj:`load_privatekey` raises :py:obj:`ValueError` if the passphrase
2105 callback returns something other than a byte string.
2106 """
2107 self.assertRaises(
2108 ValueError,
2109 load_privatekey,
2110 FILETYPE_PEM, encryptedPrivateKeyPEM, lambda *args: 3)
2111
2112
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04002113 def test_dump_privatekey_wrong_args(self):
2114 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002115 :py:obj:`dump_privatekey` raises :py:obj:`TypeError` if called with the wrong number
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04002116 of arguments.
2117 """
2118 self.assertRaises(TypeError, dump_privatekey)
Jean-Paul Calderone1eeccd82011-09-14 10:18:52 -04002119 # If cipher name is given, password is required.
2120 self.assertRaises(
2121 ValueError, dump_privatekey, FILETYPE_PEM, PKey(), "foo")
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04002122
2123
2124 def test_dump_privatekey_unknown_cipher(self):
2125 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002126 :py:obj:`dump_privatekey` raises :py:obj:`ValueError` if called with an unrecognized
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04002127 cipher name.
2128 """
2129 key = PKey()
2130 key.generate_key(TYPE_RSA, 512)
2131 self.assertRaises(
2132 ValueError, dump_privatekey,
2133 FILETYPE_PEM, key, "zippers", "passphrase")
2134
2135
2136 def test_dump_privatekey_invalid_passphrase_type(self):
2137 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002138 :py:obj:`dump_privatekey` raises :py:obj:`TypeError` if called with a passphrase which
2139 is neither a :py:obj:`str` nor a callable.
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04002140 """
2141 key = PKey()
2142 key.generate_key(TYPE_RSA, 512)
2143 self.assertRaises(
2144 TypeError,
2145 dump_privatekey, FILETYPE_PEM, key, "blowfish", object())
2146
2147
2148 def test_dump_privatekey_invalid_filetype(self):
2149 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002150 :py:obj:`dump_privatekey` raises :py:obj:`ValueError` if called with an unrecognized
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04002151 filetype.
2152 """
2153 key = PKey()
2154 key.generate_key(TYPE_RSA, 512)
2155 self.assertRaises(ValueError, dump_privatekey, 100, key)
2156
2157
Ziga Seilnacht781295a2009-12-22 14:58:01 +01002158 def test_load_privatekey_passphraseCallbackLength(self):
2159 """
Jean-Paul Calderone5d9d7f12011-09-14 09:48:58 -04002160 :py:obj:`crypto.load_privatekey` should raise an error when the passphrase
Ziga Seilnacht781295a2009-12-22 14:58:01 +01002161 provided by the callback is too long, not silently truncate it.
2162 """
2163 def cb(ignored):
2164 return "a" * 1025
2165
2166 self.assertRaises(ValueError,
2167 load_privatekey, FILETYPE_PEM, encryptedPrivateKeyPEM, cb)
2168
2169
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002170 def test_dump_privatekey_passphrase(self):
2171 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002172 :py:obj:`dump_privatekey` writes an encrypted PEM when given a passphrase.
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002173 """
Jean-Paul Calderone5be230f2010-08-22 19:27:58 -04002174 passphrase = b("foo")
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002175 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
2176 pem = dump_privatekey(FILETYPE_PEM, key, "blowfish", passphrase)
Jean-Paul Calderone5be230f2010-08-22 19:27:58 -04002177 self.assertTrue(isinstance(pem, bytes))
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002178 loadedKey = load_privatekey(FILETYPE_PEM, pem, passphrase)
2179 self.assertTrue(isinstance(loadedKey, PKeyType))
2180 self.assertEqual(loadedKey.type(), key.type())
2181 self.assertEqual(loadedKey.bits(), key.bits())
2182
Jean-Paul Calderonef17e4212009-04-01 14:21:40 -04002183
Ziga Seilnacht376cf972009-12-22 16:04:10 +01002184 def test_dump_privatekey_passphraseWrongType(self):
2185 """
Jean-Paul Calderone5d9d7f12011-09-14 09:48:58 -04002186 :py:obj:`dump_privatekey` raises :py:obj:`ValueError` when it is passed a passphrase
Ziga Seilnacht376cf972009-12-22 16:04:10 +01002187 with a private key encoded in a format, that doesn't support
2188 encryption.
2189 """
2190 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
2191 self.assertRaises(ValueError,
2192 dump_privatekey, FILETYPE_ASN1, key, "blowfish", "secret")
2193
2194
Rick Dean5b7b6372009-04-01 11:34:06 -05002195 def test_dump_certificate(self):
2196 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002197 :py:obj:`dump_certificate` writes PEM, DER, and text.
Rick Dean5b7b6372009-04-01 11:34:06 -05002198 """
Jean-Paul Calderonef17e4212009-04-01 14:21:40 -04002199 pemData = cleartextCertificatePEM + cleartextPrivateKeyPEM
Rick Dean5b7b6372009-04-01 11:34:06 -05002200 cert = load_certificate(FILETYPE_PEM, pemData)
2201 dumped_pem = dump_certificate(FILETYPE_PEM, cert)
2202 self.assertEqual(dumped_pem, cleartextCertificatePEM)
2203 dumped_der = dump_certificate(FILETYPE_ASN1, cert)
Rick Dean4c9ad612009-07-17 15:05:22 -05002204 good_der = _runopenssl(dumped_pem, "x509", "-outform", "DER")
Rick Dean5b7b6372009-04-01 11:34:06 -05002205 self.assertEqual(dumped_der, good_der)
2206 cert2 = load_certificate(FILETYPE_ASN1, dumped_der)
2207 dumped_pem2 = dump_certificate(FILETYPE_PEM, cert2)
2208 self.assertEqual(dumped_pem2, cleartextCertificatePEM)
2209 dumped_text = dump_certificate(FILETYPE_TEXT, cert)
Rick Dean4c9ad612009-07-17 15:05:22 -05002210 good_text = _runopenssl(dumped_pem, "x509", "-noout", "-text")
Rick Dean5b7b6372009-04-01 11:34:06 -05002211 self.assertEqual(dumped_text, good_text)
2212
2213
Jean-Paul Calderonee82e3252013-03-03 10:14:10 -08002214 def test_dump_privatekey_pem(self):
Rick Dean5b7b6372009-04-01 11:34:06 -05002215 """
Jean-Paul Calderonee82e3252013-03-03 10:14:10 -08002216 :py:obj:`dump_privatekey` writes a PEM
Rick Dean5b7b6372009-04-01 11:34:06 -05002217 """
2218 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
Jean-Paul Calderone8e6ce972009-05-13 12:32:49 -04002219 self.assertTrue(key.check())
Rick Dean5b7b6372009-04-01 11:34:06 -05002220 dumped_pem = dump_privatekey(FILETYPE_PEM, key)
2221 self.assertEqual(dumped_pem, cleartextPrivateKeyPEM)
Jean-Paul Calderonee82e3252013-03-03 10:14:10 -08002222
2223
2224 def test_dump_privatekey_asn1(self):
2225 """
2226 :py:obj:`dump_privatekey` writes a DER
2227 """
2228 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
2229 dumped_pem = dump_privatekey(FILETYPE_PEM, key)
2230
Rick Dean5b7b6372009-04-01 11:34:06 -05002231 dumped_der = dump_privatekey(FILETYPE_ASN1, key)
Jean-Paul Calderonef17e4212009-04-01 14:21:40 -04002232 # XXX This OpenSSL call writes "writing RSA key" to standard out. Sad.
Rick Dean4c9ad612009-07-17 15:05:22 -05002233 good_der = _runopenssl(dumped_pem, "rsa", "-outform", "DER")
Rick Dean5b7b6372009-04-01 11:34:06 -05002234 self.assertEqual(dumped_der, good_der)
2235 key2 = load_privatekey(FILETYPE_ASN1, dumped_der)
2236 dumped_pem2 = dump_privatekey(FILETYPE_PEM, key2)
2237 self.assertEqual(dumped_pem2, cleartextPrivateKeyPEM)
Jean-Paul Calderonee82e3252013-03-03 10:14:10 -08002238
2239
2240 def test_dump_privatekey_text(self):
2241 """
2242 :py:obj:`dump_privatekey` writes a text
2243 """
2244 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
2245 dumped_pem = dump_privatekey(FILETYPE_PEM, key)
2246
Rick Dean5b7b6372009-04-01 11:34:06 -05002247 dumped_text = dump_privatekey(FILETYPE_TEXT, key)
Rick Dean4c9ad612009-07-17 15:05:22 -05002248 good_text = _runopenssl(dumped_pem, "rsa", "-noout", "-text")
Rick Dean5b7b6372009-04-01 11:34:06 -05002249 self.assertEqual(dumped_text, good_text)
2250
Jean-Paul Calderonef17e4212009-04-01 14:21:40 -04002251
Rick Dean5b7b6372009-04-01 11:34:06 -05002252 def test_dump_certificate_request(self):
2253 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002254 :py:obj:`dump_certificate_request` writes a PEM, DER, and text.
Rick Dean5b7b6372009-04-01 11:34:06 -05002255 """
2256 req = load_certificate_request(FILETYPE_PEM, cleartextCertificateRequestPEM)
2257 dumped_pem = dump_certificate_request(FILETYPE_PEM, req)
2258 self.assertEqual(dumped_pem, cleartextCertificateRequestPEM)
2259 dumped_der = dump_certificate_request(FILETYPE_ASN1, req)
Rick Dean4c9ad612009-07-17 15:05:22 -05002260 good_der = _runopenssl(dumped_pem, "req", "-outform", "DER")
Rick Dean5b7b6372009-04-01 11:34:06 -05002261 self.assertEqual(dumped_der, good_der)
2262 req2 = load_certificate_request(FILETYPE_ASN1, dumped_der)
2263 dumped_pem2 = dump_certificate_request(FILETYPE_PEM, req2)
2264 self.assertEqual(dumped_pem2, cleartextCertificateRequestPEM)
2265 dumped_text = dump_certificate_request(FILETYPE_TEXT, req)
Rick Dean4c9ad612009-07-17 15:05:22 -05002266 good_text = _runopenssl(dumped_pem, "req", "-noout", "-text")
Rick Dean5b7b6372009-04-01 11:34:06 -05002267 self.assertEqual(dumped_text, good_text)
Jean-Paul Calderoneaf43cdf2010-08-03 18:40:52 -04002268 self.assertRaises(ValueError, dump_certificate_request, 100, req)
Rick Dean5b7b6372009-04-01 11:34:06 -05002269
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002270
2271 def test_dump_privatekey_passphraseCallback(self):
2272 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002273 :py:obj:`dump_privatekey` writes an encrypted PEM when given a callback which
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002274 returns the correct passphrase.
2275 """
Jean-Paul Calderone5be230f2010-08-22 19:27:58 -04002276 passphrase = b("foo")
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002277 called = []
2278 def cb(writing):
2279 called.append(writing)
2280 return passphrase
2281 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
2282 pem = dump_privatekey(FILETYPE_PEM, key, "blowfish", cb)
Jean-Paul Calderone5be230f2010-08-22 19:27:58 -04002283 self.assertTrue(isinstance(pem, bytes))
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002284 self.assertEqual(called, [True])
2285 loadedKey = load_privatekey(FILETYPE_PEM, pem, passphrase)
2286 self.assertTrue(isinstance(loadedKey, PKeyType))
2287 self.assertEqual(loadedKey.type(), key.type())
2288 self.assertEqual(loadedKey.bits(), key.bits())
Rick Dean5b7b6372009-04-01 11:34:06 -05002289
2290
Ziga Seilnacht6b90a402009-12-22 14:33:47 +01002291 def test_dump_privatekey_passphrase_exception(self):
2292 """
Jean-Paul Calderone5d9d7f12011-09-14 09:48:58 -04002293 :py:obj:`dump_privatekey` should not overwrite the exception raised
Ziga Seilnacht6b90a402009-12-22 14:33:47 +01002294 by the passphrase callback.
2295 """
2296 def cb(ignored):
2297 raise ArithmeticError
2298
2299 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
2300 self.assertRaises(ArithmeticError,
2301 dump_privatekey, FILETYPE_PEM, key, "blowfish", cb)
2302
2303
Ziga Seilnacht781295a2009-12-22 14:58:01 +01002304 def test_dump_privatekey_passphraseCallbackLength(self):
2305 """
Jean-Paul Calderone5d9d7f12011-09-14 09:48:58 -04002306 :py:obj:`crypto.dump_privatekey` should raise an error when the passphrase
Ziga Seilnacht781295a2009-12-22 14:58:01 +01002307 provided by the callback is too long, not silently truncate it.
2308 """
2309 def cb(ignored):
2310 return "a" * 1025
2311
2312 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
2313 self.assertRaises(ValueError,
2314 dump_privatekey, FILETYPE_PEM, key, "blowfish", cb)
2315
2316
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -04002317 def test_load_pkcs7_data(self):
2318 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002319 :py:obj:`load_pkcs7_data` accepts a PKCS#7 string and returns an instance of
2320 :py:obj:`PKCS7Type`.
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -04002321 """
2322 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2323 self.assertTrue(isinstance(pkcs7, PKCS7Type))
2324
2325
Jean-Paul Calderonee82e3252013-03-03 10:14:10 -08002326 def test_load_pkcs7_data_invalid(self):
2327 """
2328 If the data passed to :py:obj:`load_pkcs7_data` is invalid,
2329 :py:obj:`Error` is raised.
2330 """
2331 self.assertRaises(Error, load_pkcs7_data, FILETYPE_PEM, "foo")
2332
2333
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -04002334
Jean-Paul Calderone68649052009-07-17 21:14:27 -04002335class PKCS7Tests(TestCase):
2336 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002337 Tests for :py:obj:`PKCS7Type`.
Jean-Paul Calderone68649052009-07-17 21:14:27 -04002338 """
2339 def test_type(self):
2340 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002341 :py:obj:`PKCS7Type` is a type object.
Jean-Paul Calderone68649052009-07-17 21:14:27 -04002342 """
2343 self.assertTrue(isinstance(PKCS7Type, type))
2344 self.assertEqual(PKCS7Type.__name__, 'PKCS7')
2345
2346 # XXX This doesn't currently work.
2347 # self.assertIdentical(PKCS7, PKCS7Type)
2348
2349
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04002350 # XXX Opposite results for all these following methods
2351
Jean-Paul Calderone07c93742010-07-30 10:53:41 -04002352 def test_type_is_signed_wrong_args(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002353 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002354 :py:obj:`PKCS7Type.type_is_signed` raises :py:obj:`TypeError` if called with any
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002355 arguments.
2356 """
Jean-Paul Calderone07c93742010-07-30 10:53:41 -04002357 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2358 self.assertRaises(TypeError, pkcs7.type_is_signed, None)
2359
2360
2361 def test_type_is_signed(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002362 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002363 :py:obj:`PKCS7Type.type_is_signed` returns :py:obj:`True` if the PKCS7 object is of
Jean-Paul Calderone64efa2c2011-09-11 10:00:09 -04002364 the type *signed*.
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002365 """
Jean-Paul Calderone07c93742010-07-30 10:53:41 -04002366 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2367 self.assertTrue(pkcs7.type_is_signed())
2368
2369
2370 def test_type_is_enveloped_wrong_args(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002371 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002372 :py:obj:`PKCS7Type.type_is_enveloped` raises :py:obj:`TypeError` if called with any
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002373 arguments.
2374 """
Jean-Paul Calderone07c93742010-07-30 10:53:41 -04002375 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2376 self.assertRaises(TypeError, pkcs7.type_is_enveloped, None)
2377
2378
2379 def test_type_is_enveloped(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002380 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002381 :py:obj:`PKCS7Type.type_is_enveloped` returns :py:obj:`False` if the PKCS7 object is
Jean-Paul Calderone64efa2c2011-09-11 10:00:09 -04002382 not of the type *enveloped*.
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002383 """
Jean-Paul Calderone07c93742010-07-30 10:53:41 -04002384 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2385 self.assertFalse(pkcs7.type_is_enveloped())
2386
2387
2388 def test_type_is_signedAndEnveloped_wrong_args(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002389 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002390 :py:obj:`PKCS7Type.type_is_signedAndEnveloped` raises :py:obj:`TypeError` if called
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002391 with any arguments.
2392 """
Jean-Paul Calderone07c93742010-07-30 10:53:41 -04002393 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2394 self.assertRaises(TypeError, pkcs7.type_is_signedAndEnveloped, None)
2395
2396
2397 def test_type_is_signedAndEnveloped(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002398 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002399 :py:obj:`PKCS7Type.type_is_signedAndEnveloped` returns :py:obj:`False` if the PKCS7
Jean-Paul Calderone64efa2c2011-09-11 10:00:09 -04002400 object is not of the type *signed and enveloped*.
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002401 """
Jean-Paul Calderone07c93742010-07-30 10:53:41 -04002402 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2403 self.assertFalse(pkcs7.type_is_signedAndEnveloped())
2404
2405
Jean-Paul Calderoneb4754b92010-07-30 11:00:08 -04002406 def test_type_is_data(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002407 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002408 :py:obj:`PKCS7Type.type_is_data` returns :py:obj:`False` if the PKCS7 object is not of
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002409 the type data.
2410 """
Jean-Paul Calderoneb4754b92010-07-30 11:00:08 -04002411 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2412 self.assertFalse(pkcs7.type_is_data())
2413
2414
2415 def test_type_is_data_wrong_args(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002416 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002417 :py:obj:`PKCS7Type.type_is_data` raises :py:obj:`TypeError` if called with any
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002418 arguments.
2419 """
Jean-Paul Calderoneb4754b92010-07-30 11:00:08 -04002420 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2421 self.assertRaises(TypeError, pkcs7.type_is_data, None)
2422
2423
Jean-Paul Calderone97b28ca2010-07-30 10:56:07 -04002424 def test_get_type_name_wrong_args(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002425 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002426 :py:obj:`PKCS7Type.get_type_name` raises :py:obj:`TypeError` if called with any
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002427 arguments.
2428 """
Jean-Paul Calderone97b28ca2010-07-30 10:56:07 -04002429 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2430 self.assertRaises(TypeError, pkcs7.get_type_name, None)
2431
2432
Jean-Paul Calderone4cbe05e2010-07-30 10:55:30 -04002433 def test_get_type_name(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002434 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002435 :py:obj:`PKCS7Type.get_type_name` returns a :py:obj:`str` giving the type name.
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002436 """
Jean-Paul Calderone4cbe05e2010-07-30 10:55:30 -04002437 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
Jean-Paul Calderone07640f12010-08-22 17:14:43 -04002438 self.assertEquals(pkcs7.get_type_name(), b('pkcs7-signedData'))
Jean-Paul Calderone4cbe05e2010-07-30 10:55:30 -04002439
2440
2441 def test_attribute(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002442 """
2443 If an attribute other than one of the methods tested here is accessed on
Jonathan Ballet648875f2011-07-16 14:14:58 +09002444 an instance of :py:obj:`PKCS7Type`, :py:obj:`AttributeError` is raised.
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002445 """
Jean-Paul Calderone4cbe05e2010-07-30 10:55:30 -04002446 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2447 self.assertRaises(AttributeError, getattr, pkcs7, "foo")
2448
2449
Jean-Paul Calderone68649052009-07-17 21:14:27 -04002450
Jean-Paul Calderoneb9725592010-08-03 18:17:22 -04002451class NetscapeSPKITests(TestCase, _PKeyInteractionTestsMixin):
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -04002452 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002453 Tests for :py:obj:`OpenSSL.crypto.NetscapeSPKI`.
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -04002454 """
Jean-Paul Calderoneb9725592010-08-03 18:17:22 -04002455 def signable(self):
2456 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002457 Return a new :py:obj:`NetscapeSPKI` for use with signing tests.
Jean-Paul Calderoneb9725592010-08-03 18:17:22 -04002458 """
2459 return NetscapeSPKI()
2460
2461
Jean-Paul Calderone68649052009-07-17 21:14:27 -04002462 def test_type(self):
2463 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002464 :py:obj:`NetscapeSPKI` and :py:obj:`NetscapeSPKIType` refer to the same type object
Jean-Paul Calderone68649052009-07-17 21:14:27 -04002465 and can be used to create instances of that type.
2466 """
2467 self.assertIdentical(NetscapeSPKI, NetscapeSPKIType)
2468 self.assertConsistentType(NetscapeSPKI, 'NetscapeSPKI')
2469
2470
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -04002471 def test_construction(self):
2472 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002473 :py:obj:`NetscapeSPKI` returns an instance of :py:obj:`NetscapeSPKIType`.
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -04002474 """
2475 nspki = NetscapeSPKI()
2476 self.assertTrue(isinstance(nspki, NetscapeSPKIType))
2477
Jean-Paul Calderoneb9725592010-08-03 18:17:22 -04002478
Jean-Paul Calderone969efaa2010-08-03 18:19:19 -04002479 def test_invalid_attribute(self):
2480 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002481 Accessing a non-existent attribute of a :py:obj:`NetscapeSPKI` instance causes
2482 an :py:obj:`AttributeError` to be raised.
Jean-Paul Calderone969efaa2010-08-03 18:19:19 -04002483 """
2484 nspki = NetscapeSPKI()
2485 self.assertRaises(AttributeError, lambda: nspki.foo)
2486
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04002487
Jean-Paul Calderone06ada9f2010-08-03 18:26:52 -04002488 def test_b64_encode(self):
2489 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002490 :py:obj:`NetscapeSPKI.b64_encode` encodes the certificate to a base64 blob.
Jean-Paul Calderone06ada9f2010-08-03 18:26:52 -04002491 """
2492 nspki = NetscapeSPKI()
2493 blob = nspki.b64_encode()
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002494 self.assertTrue(isinstance(blob, bytes))
Jean-Paul Calderone06ada9f2010-08-03 18:26:52 -04002495
2496
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -04002497
Rick Dean536ba022009-07-24 23:57:27 -05002498class RevokedTests(TestCase):
2499 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002500 Tests for :py:obj:`OpenSSL.crypto.Revoked`
Rick Dean536ba022009-07-24 23:57:27 -05002501 """
2502 def test_construction(self):
2503 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002504 Confirm we can create :py:obj:`OpenSSL.crypto.Revoked`. Check
Rick Dean536ba022009-07-24 23:57:27 -05002505 that it is empty.
2506 """
2507 revoked = Revoked()
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002508 self.assertTrue(isinstance(revoked, Revoked))
2509 self.assertEquals(type(revoked), Revoked)
2510 self.assertEquals(revoked.get_serial(), b('00'))
2511 self.assertEquals(revoked.get_rev_date(), None)
2512 self.assertEquals(revoked.get_reason(), None)
Rick Dean536ba022009-07-24 23:57:27 -05002513
2514
Jean-Paul Calderone4f74bfe2010-01-30 14:32:49 -05002515 def test_construction_wrong_args(self):
2516 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002517 Calling :py:obj:`OpenSSL.crypto.Revoked` with any arguments results
2518 in a :py:obj:`TypeError` being raised.
Jean-Paul Calderone4f74bfe2010-01-30 14:32:49 -05002519 """
2520 self.assertRaises(TypeError, Revoked, None)
2521 self.assertRaises(TypeError, Revoked, 1)
2522 self.assertRaises(TypeError, Revoked, "foo")
2523
2524
Rick Dean536ba022009-07-24 23:57:27 -05002525 def test_serial(self):
2526 """
Jean-Paul Calderoneb98eae02010-01-30 13:18:04 -05002527 Confirm we can set and get serial numbers from
Jonathan Ballet648875f2011-07-16 14:14:58 +09002528 :py:obj:`OpenSSL.crypto.Revoked`. Confirm errors are handled
Rick Dean536ba022009-07-24 23:57:27 -05002529 with grace.
2530 """
2531 revoked = Revoked()
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002532 ret = revoked.set_serial(b('10b'))
2533 self.assertEquals(ret, None)
Rick Dean536ba022009-07-24 23:57:27 -05002534 ser = revoked.get_serial()
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002535 self.assertEquals(ser, b('010B'))
Rick Dean536ba022009-07-24 23:57:27 -05002536
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002537 revoked.set_serial(b('31ppp')) # a type error would be nice
Rick Dean536ba022009-07-24 23:57:27 -05002538 ser = revoked.get_serial()
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002539 self.assertEquals(ser, b('31'))
Rick Dean536ba022009-07-24 23:57:27 -05002540
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002541 self.assertRaises(ValueError, revoked.set_serial, b('pqrst'))
Rick Dean536ba022009-07-24 23:57:27 -05002542 self.assertRaises(TypeError, revoked.set_serial, 100)
Jean-Paul Calderone4f74bfe2010-01-30 14:32:49 -05002543 self.assertRaises(TypeError, revoked.get_serial, 1)
2544 self.assertRaises(TypeError, revoked.get_serial, None)
2545 self.assertRaises(TypeError, revoked.get_serial, "")
Rick Dean536ba022009-07-24 23:57:27 -05002546
2547
2548 def test_date(self):
2549 """
Jean-Paul Calderoneb98eae02010-01-30 13:18:04 -05002550 Confirm we can set and get revocation dates from
Jonathan Ballet648875f2011-07-16 14:14:58 +09002551 :py:obj:`OpenSSL.crypto.Revoked`. Confirm errors are handled
Rick Dean536ba022009-07-24 23:57:27 -05002552 with grace.
2553 """
2554 revoked = Revoked()
2555 date = revoked.get_rev_date()
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002556 self.assertEquals(date, None)
Rick Dean536ba022009-07-24 23:57:27 -05002557
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002558 now = b(datetime.now().strftime("%Y%m%d%H%M%SZ"))
Rick Dean536ba022009-07-24 23:57:27 -05002559 ret = revoked.set_rev_date(now)
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002560 self.assertEqual(ret, None)
Rick Dean536ba022009-07-24 23:57:27 -05002561 date = revoked.get_rev_date()
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002562 self.assertEqual(date, now)
Rick Dean536ba022009-07-24 23:57:27 -05002563
2564
Rick Dean6385faf2009-07-26 00:07:47 -05002565 def test_reason(self):
2566 """
Jean-Paul Calderoneb98eae02010-01-30 13:18:04 -05002567 Confirm we can set and get revocation reasons from
Jonathan Ballet648875f2011-07-16 14:14:58 +09002568 :py:obj:`OpenSSL.crypto.Revoked`. The "get" need to work
Rick Dean6385faf2009-07-26 00:07:47 -05002569 as "set". Likewise, each reason of all_reasons() must work.
2570 """
2571 revoked = Revoked()
2572 for r in revoked.all_reasons():
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002573 for x in range(2):
Rick Dean6385faf2009-07-26 00:07:47 -05002574 ret = revoked.set_reason(r)
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002575 self.assertEquals(ret, None)
Rick Dean6385faf2009-07-26 00:07:47 -05002576 reason = revoked.get_reason()
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002577 self.assertEquals(
2578 reason.lower().replace(b(' '), b('')),
2579 r.lower().replace(b(' '), b('')))
Rick Dean6385faf2009-07-26 00:07:47 -05002580 r = reason # again with the resp of get
2581
2582 revoked.set_reason(None)
2583 self.assertEqual(revoked.get_reason(), None)
2584
2585
Jean-Paul Calderone4f74bfe2010-01-30 14:32:49 -05002586 def test_set_reason_wrong_arguments(self):
Rick Dean6385faf2009-07-26 00:07:47 -05002587 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002588 Calling :py:obj:`OpenSSL.crypto.Revoked.set_reason` with other than
Jean-Paul Calderone4f74bfe2010-01-30 14:32:49 -05002589 one argument, or an argument which isn't a valid reason,
Jonathan Ballet648875f2011-07-16 14:14:58 +09002590 results in :py:obj:`TypeError` or :py:obj:`ValueError` being raised.
Rick Dean6385faf2009-07-26 00:07:47 -05002591 """
2592 revoked = Revoked()
2593 self.assertRaises(TypeError, revoked.set_reason, 100)
Jean-Paul Calderone281b62b2010-08-28 14:22:29 -04002594 self.assertRaises(ValueError, revoked.set_reason, b('blue'))
Rick Dean6385faf2009-07-26 00:07:47 -05002595
Rick Dean536ba022009-07-24 23:57:27 -05002596
Jean-Paul Calderone4f74bfe2010-01-30 14:32:49 -05002597 def test_get_reason_wrong_arguments(self):
2598 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002599 Calling :py:obj:`OpenSSL.crypto.Revoked.get_reason` with any
2600 arguments results in :py:obj:`TypeError` being raised.
Jean-Paul Calderone4f74bfe2010-01-30 14:32:49 -05002601 """
2602 revoked = Revoked()
2603 self.assertRaises(TypeError, revoked.get_reason, None)
2604 self.assertRaises(TypeError, revoked.get_reason, 1)
2605 self.assertRaises(TypeError, revoked.get_reason, "foo")
2606
2607
2608
Rick Dean536ba022009-07-24 23:57:27 -05002609class CRLTests(TestCase):
2610 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002611 Tests for :py:obj:`OpenSSL.crypto.CRL`
Rick Dean536ba022009-07-24 23:57:27 -05002612 """
2613 cert = load_certificate(FILETYPE_PEM, cleartextCertificatePEM)
2614 pkey = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
2615
2616 def test_construction(self):
2617 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002618 Confirm we can create :py:obj:`OpenSSL.crypto.CRL`. Check
Rick Dean536ba022009-07-24 23:57:27 -05002619 that it is empty
2620 """
2621 crl = CRL()
2622 self.assertTrue( isinstance(crl, CRL) )
2623 self.assertEqual(crl.get_revoked(), None)
2624
2625
Jean-Paul Calderone2efd03e2010-01-30 13:59:55 -05002626 def test_construction_wrong_args(self):
2627 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002628 Calling :py:obj:`OpenSSL.crypto.CRL` with any number of arguments
2629 results in a :py:obj:`TypeError` being raised.
Jean-Paul Calderone2efd03e2010-01-30 13:59:55 -05002630 """
2631 self.assertRaises(TypeError, CRL, 1)
2632 self.assertRaises(TypeError, CRL, "")
2633 self.assertRaises(TypeError, CRL, None)
2634
2635
Rick Dean536ba022009-07-24 23:57:27 -05002636 def test_export(self):
2637 """
2638 Use python to create a simple CRL with a revocation, and export
2639 the CRL in formats of PEM, DER and text. Those outputs are verified
2640 with the openssl program.
2641 """
2642 crl = CRL()
2643 revoked = Revoked()
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002644 now = b(datetime.now().strftime("%Y%m%d%H%M%SZ"))
Rick Dean536ba022009-07-24 23:57:27 -05002645 revoked.set_rev_date(now)
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002646 revoked.set_serial(b('3ab'))
2647 revoked.set_reason(b('sUpErSeDEd'))
Rick Dean536ba022009-07-24 23:57:27 -05002648 crl.add_revoked(revoked)
2649
2650 # PEM format
2651 dumped_crl = crl.export(self.cert, self.pkey, days=20)
2652 text = _runopenssl(dumped_crl, "crl", "-noout", "-text")
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002653 text.index(b('Serial Number: 03AB'))
2654 text.index(b('Superseded'))
2655 text.index(b('Issuer: /C=US/ST=IL/L=Chicago/O=Testing/CN=Testing Root CA'))
Rick Dean536ba022009-07-24 23:57:27 -05002656
2657 # DER format
2658 dumped_crl = crl.export(self.cert, self.pkey, FILETYPE_ASN1)
2659 text = _runopenssl(dumped_crl, "crl", "-noout", "-text", "-inform", "DER")
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002660 text.index(b('Serial Number: 03AB'))
2661 text.index(b('Superseded'))
2662 text.index(b('Issuer: /C=US/ST=IL/L=Chicago/O=Testing/CN=Testing Root CA'))
Rick Dean536ba022009-07-24 23:57:27 -05002663
2664 # text format
2665 dumped_text = crl.export(self.cert, self.pkey, type=FILETYPE_TEXT)
2666 self.assertEqual(text, dumped_text)
2667
2668
Jean-Paul Calderonec7293bc2011-09-13 15:24:38 -04002669 def test_export_invalid(self):
2670 """
2671 If :py:obj:`CRL.export` is used with an uninitialized :py:obj:`X509`
Jean-Paul Calderoneb5871072012-03-09 14:58:00 -08002672 instance, :py:obj:`OpenSSL.crypto.Error` is raised.
Jean-Paul Calderonec7293bc2011-09-13 15:24:38 -04002673 """
2674 crl = CRL()
2675 self.assertRaises(Error, crl.export, X509(), PKey())
2676
2677
Jean-Paul Calderone56515342010-01-30 13:49:38 -05002678 def test_add_revoked_keyword(self):
2679 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002680 :py:obj:`OpenSSL.CRL.add_revoked` accepts its single argument as the
Jean-Paul Calderone64efa2c2011-09-11 10:00:09 -04002681 ``revoked`` keyword argument.
Jean-Paul Calderone56515342010-01-30 13:49:38 -05002682 """
2683 crl = CRL()
2684 revoked = Revoked()
2685 crl.add_revoked(revoked=revoked)
2686 self.assertTrue(isinstance(crl.get_revoked()[0], Revoked))
2687
Rick Dean6385faf2009-07-26 00:07:47 -05002688
Jean-Paul Calderone883ca4b2010-01-30 13:55:13 -05002689 def test_export_wrong_args(self):
2690 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002691 Calling :py:obj:`OpenSSL.CRL.export` with fewer than two or more than
Jean-Paul Calderonef1515862010-01-30 13:57:03 -05002692 four arguments, or with arguments other than the certificate,
2693 private key, integer file type, and integer number of days it
Jonathan Ballet648875f2011-07-16 14:14:58 +09002694 expects, results in a :py:obj:`TypeError` being raised.
Jean-Paul Calderone883ca4b2010-01-30 13:55:13 -05002695 """
2696 crl = CRL()
2697 self.assertRaises(TypeError, crl.export)
2698 self.assertRaises(TypeError, crl.export, self.cert)
2699 self.assertRaises(TypeError, crl.export, self.cert, self.pkey, FILETYPE_PEM, 10, "foo")
2700
Jean-Paul Calderonef1515862010-01-30 13:57:03 -05002701 self.assertRaises(TypeError, crl.export, None, self.pkey, FILETYPE_PEM, 10)
2702 self.assertRaises(TypeError, crl.export, self.cert, None, FILETYPE_PEM, 10)
2703 self.assertRaises(TypeError, crl.export, self.cert, self.pkey, None, 10)
2704 self.assertRaises(TypeError, crl.export, self.cert, FILETYPE_PEM, None)
2705
Jean-Paul Calderone883ca4b2010-01-30 13:55:13 -05002706
Jean-Paul Calderoneea198422010-01-30 13:58:23 -05002707 def test_export_unknown_filetype(self):
2708 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002709 Calling :py:obj:`OpenSSL.CRL.export` with a file type other than
2710 :py:obj:`FILETYPE_PEM`, :py:obj:`FILETYPE_ASN1`, or :py:obj:`FILETYPE_TEXT` results
2711 in a :py:obj:`ValueError` being raised.
Jean-Paul Calderoneea198422010-01-30 13:58:23 -05002712 """
2713 crl = CRL()
2714 self.assertRaises(ValueError, crl.export, self.cert, self.pkey, 100, 10)
2715
2716
Rick Dean536ba022009-07-24 23:57:27 -05002717 def test_get_revoked(self):
2718 """
Jean-Paul Calderoneb98eae02010-01-30 13:18:04 -05002719 Use python to create a simple CRL with two revocations.
Jonathan Ballet648875f2011-07-16 14:14:58 +09002720 Get back the :py:obj:`Revoked` using :py:obj:`OpenSSL.CRL.get_revoked` and
Rick Dean536ba022009-07-24 23:57:27 -05002721 verify them.
2722 """
2723 crl = CRL()
2724
2725 revoked = Revoked()
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002726 now = b(datetime.now().strftime("%Y%m%d%H%M%SZ"))
Rick Dean536ba022009-07-24 23:57:27 -05002727 revoked.set_rev_date(now)
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002728 revoked.set_serial(b('3ab'))
Rick Dean536ba022009-07-24 23:57:27 -05002729 crl.add_revoked(revoked)
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002730 revoked.set_serial(b('100'))
2731 revoked.set_reason(b('sUpErSeDEd'))
Rick Dean536ba022009-07-24 23:57:27 -05002732 crl.add_revoked(revoked)
2733
2734 revs = crl.get_revoked()
2735 self.assertEqual(len(revs), 2)
2736 self.assertEqual(type(revs[0]), Revoked)
2737 self.assertEqual(type(revs[1]), Revoked)
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002738 self.assertEqual(revs[0].get_serial(), b('03AB'))
2739 self.assertEqual(revs[1].get_serial(), b('0100'))
Rick Dean536ba022009-07-24 23:57:27 -05002740 self.assertEqual(revs[0].get_rev_date(), now)
2741 self.assertEqual(revs[1].get_rev_date(), now)
2742
2743
Jean-Paul Calderone46bdce42010-01-30 13:44:16 -05002744 def test_get_revoked_wrong_args(self):
2745 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002746 Calling :py:obj:`OpenSSL.CRL.get_revoked` with any arguments results
2747 in a :py:obj:`TypeError` being raised.
Jean-Paul Calderone46bdce42010-01-30 13:44:16 -05002748 """
2749 crl = CRL()
2750 self.assertRaises(TypeError, crl.get_revoked, None)
2751 self.assertRaises(TypeError, crl.get_revoked, 1)
2752 self.assertRaises(TypeError, crl.get_revoked, "")
2753 self.assertRaises(TypeError, crl.get_revoked, "", 1, None)
2754
2755
Jean-Paul Calderoneecef6fa2010-01-30 13:47:18 -05002756 def test_add_revoked_wrong_args(self):
2757 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002758 Calling :py:obj:`OpenSSL.CRL.add_revoked` with other than one
2759 argument results in a :py:obj:`TypeError` being raised.
Jean-Paul Calderoneecef6fa2010-01-30 13:47:18 -05002760 """
2761 crl = CRL()
2762 self.assertRaises(TypeError, crl.add_revoked)
2763 self.assertRaises(TypeError, crl.add_revoked, 1, 2)
2764 self.assertRaises(TypeError, crl.add_revoked, "foo", "bar")
2765
2766
Rick Dean536ba022009-07-24 23:57:27 -05002767 def test_load_crl(self):
2768 """
2769 Load a known CRL and inspect its revocations. Both
2770 PEM and DER formats are loaded.
2771 """
Jean-Paul Calderone3eb5cc72010-01-30 15:24:40 -05002772 crl = load_crl(FILETYPE_PEM, crlData)
Rick Dean536ba022009-07-24 23:57:27 -05002773 revs = crl.get_revoked()
2774 self.assertEqual(len(revs), 2)
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002775 self.assertEqual(revs[0].get_serial(), b('03AB'))
Rick Dean6385faf2009-07-26 00:07:47 -05002776 self.assertEqual(revs[0].get_reason(), None)
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002777 self.assertEqual(revs[1].get_serial(), b('0100'))
2778 self.assertEqual(revs[1].get_reason(), b('Superseded'))
Rick Dean536ba022009-07-24 23:57:27 -05002779
Jean-Paul Calderone3eb5cc72010-01-30 15:24:40 -05002780 der = _runopenssl(crlData, "crl", "-outform", "DER")
Jean-Paul Calderoneb98eae02010-01-30 13:18:04 -05002781 crl = load_crl(FILETYPE_ASN1, der)
Rick Dean536ba022009-07-24 23:57:27 -05002782 revs = crl.get_revoked()
2783 self.assertEqual(len(revs), 2)
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002784 self.assertEqual(revs[0].get_serial(), b('03AB'))
Rick Dean6385faf2009-07-26 00:07:47 -05002785 self.assertEqual(revs[0].get_reason(), None)
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002786 self.assertEqual(revs[1].get_serial(), b('0100'))
2787 self.assertEqual(revs[1].get_reason(), b('Superseded'))
Rick Dean536ba022009-07-24 23:57:27 -05002788
2789
Jean-Paul Calderone3eb5cc72010-01-30 15:24:40 -05002790 def test_load_crl_wrong_args(self):
2791 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002792 Calling :py:obj:`OpenSSL.crypto.load_crl` with other than two
2793 arguments results in a :py:obj:`TypeError` being raised.
Jean-Paul Calderone3eb5cc72010-01-30 15:24:40 -05002794 """
2795 self.assertRaises(TypeError, load_crl)
2796 self.assertRaises(TypeError, load_crl, FILETYPE_PEM)
2797 self.assertRaises(TypeError, load_crl, FILETYPE_PEM, crlData, None)
2798
2799
2800 def test_load_crl_bad_filetype(self):
2801 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002802 Calling :py:obj:`OpenSSL.crypto.load_crl` with an unknown file type
2803 raises a :py:obj:`ValueError`.
Jean-Paul Calderone3eb5cc72010-01-30 15:24:40 -05002804 """
2805 self.assertRaises(ValueError, load_crl, 100, crlData)
2806
2807
2808 def test_load_crl_bad_data(self):
2809 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002810 Calling :py:obj:`OpenSSL.crypto.load_crl` with file data which can't
2811 be loaded raises a :py:obj:`OpenSSL.crypto.Error`.
Jean-Paul Calderone3eb5cc72010-01-30 15:24:40 -05002812 """
2813 self.assertRaises(Error, load_crl, FILETYPE_PEM, "hello, world")
2814
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -04002815
James Yonan7c2e5d32010-02-27 05:45:50 -07002816class SignVerifyTests(TestCase):
2817 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002818 Tests for :py:obj:`OpenSSL.crypto.sign` and :py:obj:`OpenSSL.crypto.verify`.
James Yonan7c2e5d32010-02-27 05:45:50 -07002819 """
2820 def test_sign_verify(self):
Jean-Paul Calderonef3cb9d82010-06-22 10:29:33 -04002821 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002822 :py:obj:`sign` generates a cryptographic signature which :py:obj:`verify` can check.
Jean-Paul Calderonef3cb9d82010-06-22 10:29:33 -04002823 """
Jean-Paul Calderoneea305c52010-08-28 14:41:07 -04002824 content = b(
Jean-Paul Calderoneb98ce212010-06-22 09:46:27 -04002825 "It was a bright cold day in April, and the clocks were striking "
2826 "thirteen. Winston Smith, his chin nuzzled into his breast in an "
2827 "effort to escape the vile wind, slipped quickly through the "
2828 "glass doors of Victory Mansions, though not quickly enough to "
2829 "prevent a swirl of gritty dust from entering along with him.")
2830
2831 # sign the content with this private key
Jean-Paul Calderonef3cb9d82010-06-22 10:29:33 -04002832 priv_key = load_privatekey(FILETYPE_PEM, root_key_pem)
Jean-Paul Calderoneb98ce212010-06-22 09:46:27 -04002833 # verify the content with this cert
2834 good_cert = load_certificate(FILETYPE_PEM, root_cert_pem)
2835 # certificate unrelated to priv_key, used to trigger an error
2836 bad_cert = load_certificate(FILETYPE_PEM, server_cert_pem)
James Yonan7c2e5d32010-02-27 05:45:50 -07002837
Jean-Paul Calderoned08feb02010-10-12 21:53:24 -04002838 for digest in ['md5', 'sha1']:
James Yonan7c2e5d32010-02-27 05:45:50 -07002839 sig = sign(priv_key, content, digest)
2840
2841 # Verify the signature of content, will throw an exception if error.
2842 verify(good_cert, sig, content, digest)
2843
2844 # This should fail because the certificate doesn't match the
2845 # private key that was used to sign the content.
2846 self.assertRaises(Error, verify, bad_cert, sig, content, digest)
2847
2848 # This should fail because we've "tainted" the content after
2849 # signing it.
Jean-Paul Calderoneea305c52010-08-28 14:41:07 -04002850 self.assertRaises(
2851 Error, verify,
2852 good_cert, sig, content + b("tainted"), digest)
James Yonan7c2e5d32010-02-27 05:45:50 -07002853
2854 # test that unknown digest types fail
Jean-Paul Calderoneea305c52010-08-28 14:41:07 -04002855 self.assertRaises(
Jean-Paul Calderone9538f142010-10-13 22:13:40 -04002856 ValueError, sign, priv_key, content, "strange-digest")
Jean-Paul Calderoneea305c52010-08-28 14:41:07 -04002857 self.assertRaises(
Jean-Paul Calderone9538f142010-10-13 22:13:40 -04002858 ValueError, verify, good_cert, sig, content, "strange-digest")
James Yonan7c2e5d32010-02-27 05:45:50 -07002859
Jean-Paul Calderoneb98ce212010-06-22 09:46:27 -04002860
Jean-Paul Calderone9828f662010-12-08 22:57:26 -05002861 def test_sign_nulls(self):
2862 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002863 :py:obj:`sign` produces a signature for a string with embedded nulls.
Jean-Paul Calderone9828f662010-12-08 22:57:26 -05002864 """
2865 content = b("Watch out! \0 Did you see it?")
2866 priv_key = load_privatekey(FILETYPE_PEM, root_key_pem)
2867 good_cert = load_certificate(FILETYPE_PEM, root_cert_pem)
2868 sig = sign(priv_key, content, "sha1")
2869 verify(good_cert, sig, content, "sha1")
2870
2871
Rick Dean5b7b6372009-04-01 11:34:06 -05002872if __name__ == '__main__':
2873 main()