blob: 17a26b09f3d76de57090c78fb1b13b6eae90bdce [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 Calderone2aa2b332008-03-06 21:43:14 -050016from OpenSSL.crypto import 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 """
279 # Basic setup stuff to generate a certificate
280 self.pkey = PKey()
281 self.pkey.generate_key(TYPE_RSA, 384)
282 self.req = X509Req()
283 self.req.set_pubkey(self.pkey)
284 # Authority good you have.
285 self.req.get_subject().commonName = "Yoda root CA"
286 self.x509 = X509()
287 self.subject = self.x509.get_subject()
288 self.subject.commonName = self.req.get_subject().commonName
289 self.x509.set_issuer(self.subject)
290 self.x509.set_pubkey(self.pkey)
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400291 now = b(datetime.now().strftime("%Y%m%d%H%M%SZ"))
292 expire = b((datetime.now() + timedelta(days=100)).strftime("%Y%m%d%H%M%SZ"))
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400293 self.x509.set_notBefore(now)
294 self.x509.set_notAfter(expire)
295
296
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -0400297 def test_str(self):
298 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900299 The string representation of :py:class:`X509Extension` instances as returned by
300 :py:data:`str` includes stuff.
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -0400301 """
302 # This isn't necessarily the best string representation. Perhaps it
303 # will be changed/improved in the future.
304 self.assertEquals(
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400305 str(X509Extension(b('basicConstraints'), True, b('CA:false'))),
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -0400306 'CA:FALSE')
307
308
Jean-Paul Calderone68649052009-07-17 21:14:27 -0400309 def test_type(self):
310 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900311 :py:class:`X509Extension` and :py:class:`X509ExtensionType` refer to the same type object
Jean-Paul Calderone68649052009-07-17 21:14:27 -0400312 and can be used to create instances of that type.
313 """
314 self.assertIdentical(X509Extension, X509ExtensionType)
315 self.assertConsistentType(
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400316 X509Extension,
317 'X509Extension', b('basicConstraints'), True, b('CA:true'))
Jean-Paul Calderone68649052009-07-17 21:14:27 -0400318
319
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500320 def test_construction(self):
321 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900322 :py:class:`X509Extension` accepts an extension type name, a critical flag,
323 and an extension value and returns an :py:class:`X509ExtensionType` instance.
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500324 """
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400325 basic = X509Extension(b('basicConstraints'), True, b('CA:true'))
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500326 self.assertTrue(
327 isinstance(basic, X509ExtensionType),
328 "%r is of type %r, should be %r" % (
329 basic, type(basic), X509ExtensionType))
330
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400331 comment = X509Extension(
332 b('nsComment'), False, b('pyOpenSSL unit test'))
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500333 self.assertTrue(
334 isinstance(comment, X509ExtensionType),
335 "%r is of type %r, should be %r" % (
336 comment, type(comment), X509ExtensionType))
337
338
Jean-Paul Calderone391585f2008-12-31 14:36:31 -0500339 def test_invalid_extension(self):
340 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900341 :py:class:`X509Extension` raises something if it is passed a bad extension
Jean-Paul Calderone391585f2008-12-31 14:36:31 -0500342 name or value.
343 """
344 self.assertRaises(
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400345 Error, X509Extension, b('thisIsMadeUp'), False, b('hi'))
Jean-Paul Calderone391585f2008-12-31 14:36:31 -0500346 self.assertRaises(
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400347 Error, X509Extension, b('basicConstraints'), False, b('blah blah'))
Jean-Paul Calderone391585f2008-12-31 14:36:31 -0500348
Jean-Paul Calderone2ee1e7c2008-12-31 14:58:38 -0500349 # Exercise a weird one (an extension which uses the r2i method). This
350 # exercises the codepath that requires a non-NULL ctx to be passed to
351 # X509V3_EXT_nconf. It can't work now because we provide no
352 # configuration database. It might be made to work in the future.
353 self.assertRaises(
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400354 Error, X509Extension, b('proxyCertInfo'), True,
355 b('language:id-ppl-anyLanguage,pathlen:1,policy:text:AB'))
Jean-Paul Calderone2ee1e7c2008-12-31 14:58:38 -0500356
Jean-Paul Calderone391585f2008-12-31 14:36:31 -0500357
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500358 def test_get_critical(self):
359 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900360 :py:meth:`X509ExtensionType.get_critical` returns the value of the
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500361 extension's critical flag.
362 """
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400363 ext = X509Extension(b('basicConstraints'), True, b('CA:true'))
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500364 self.assertTrue(ext.get_critical())
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400365 ext = X509Extension(b('basicConstraints'), False, b('CA:true'))
Jean-Paul Calderonee7db4b42008-12-31 13:39:24 -0500366 self.assertFalse(ext.get_critical())
367
Jean-Paul Calderone7535dab2008-03-06 18:53:11 -0500368
Jean-Paul Calderonef8c5fab2008-12-31 15:53:48 -0500369 def test_get_short_name(self):
370 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900371 :py:meth:`X509ExtensionType.get_short_name` returns a string giving the short
Jean-Paul Calderonef8c5fab2008-12-31 15:53:48 -0500372 type name of the extension.
373 """
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400374 ext = X509Extension(b('basicConstraints'), True, b('CA:true'))
375 self.assertEqual(ext.get_short_name(), b('basicConstraints'))
376 ext = X509Extension(b('nsComment'), True, b('foo bar'))
377 self.assertEqual(ext.get_short_name(), b('nsComment'))
Jean-Paul Calderonef8c5fab2008-12-31 15:53:48 -0500378
379
Jean-Paul Calderone5a9e4612011-04-01 18:27:45 -0400380 def test_get_data(self):
381 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900382 :py:meth:`X509Extension.get_data` returns a string giving the data of the
Jean-Paul Calderone5a9e4612011-04-01 18:27:45 -0400383 extension.
384 """
385 ext = X509Extension(b('basicConstraints'), True, b('CA:true'))
386 # Expect to get back the DER encoded form of CA:true.
387 self.assertEqual(ext.get_data(), b('0\x03\x01\x01\xff'))
388
389
390 def test_get_data_wrong_args(self):
391 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900392 :py:meth:`X509Extension.get_data` raises :py:exc:`TypeError` if passed any arguments.
Jean-Paul Calderone5a9e4612011-04-01 18:27:45 -0400393 """
394 ext = X509Extension(b('basicConstraints'), True, b('CA:true'))
395 self.assertRaises(TypeError, ext.get_data, None)
396 self.assertRaises(TypeError, ext.get_data, "foo")
397 self.assertRaises(TypeError, ext.get_data, 7)
398
399
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400400 def test_unused_subject(self):
Rick Dean47262da2009-07-08 16:17:17 -0500401 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900402 The :py:data:`subject` parameter to :py:class:`X509Extension` may be provided for an
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400403 extension which does not use it and is ignored in this case.
Rick Dean47262da2009-07-08 16:17:17 -0500404 """
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400405 ext1 = X509Extension(
406 b('basicConstraints'), False, b('CA:TRUE'), subject=self.x509)
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400407 self.x509.add_extensions([ext1])
408 self.x509.sign(self.pkey, 'sha1')
409 # This is a little lame. Can we think of a better way?
410 text = dump_certificate(FILETYPE_TEXT, self.x509)
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400411 self.assertTrue(b('X509v3 Basic Constraints:') in text)
412 self.assertTrue(b('CA:TRUE') in text)
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400413
414
415 def test_subject(self):
416 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900417 If an extension requires a subject, the :py:data:`subject` parameter to
418 :py:class:`X509Extension` provides its value.
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400419 """
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400420 ext3 = X509Extension(
421 b('subjectKeyIdentifier'), False, b('hash'), subject=self.x509)
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400422 self.x509.add_extensions([ext3])
423 self.x509.sign(self.pkey, 'sha1')
424 text = dump_certificate(FILETYPE_TEXT, self.x509)
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400425 self.assertTrue(b('X509v3 Subject Key Identifier:') in text)
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400426
427
428 def test_missing_subject(self):
429 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900430 If an extension requires a subject and the :py:data:`subject` parameter is
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400431 given no value, something happens.
432 """
433 self.assertRaises(
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400434 Error, X509Extension, b('subjectKeyIdentifier'), False, b('hash'))
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400435
436
437 def test_invalid_subject(self):
438 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900439 If the :py:data:`subject` parameter is given a value which is not an
440 :py:class:`X509` instance, :py:exc:`TypeError` is raised.
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400441 """
442 for badObj in [True, object(), "hello", [], self]:
443 self.assertRaises(
444 TypeError,
445 X509Extension,
446 'basicConstraints', False, 'CA:TRUE', subject=badObj)
447
448
449 def test_unused_issuer(self):
450 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900451 The :py:data:`issuer` parameter to :py:class:`X509Extension` may be provided for an
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400452 extension which does not use it and is ignored in this case.
453 """
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400454 ext1 = X509Extension(
455 b('basicConstraints'), False, b('CA:TRUE'), issuer=self.x509)
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400456 self.x509.add_extensions([ext1])
457 self.x509.sign(self.pkey, 'sha1')
458 text = dump_certificate(FILETYPE_TEXT, self.x509)
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400459 self.assertTrue(b('X509v3 Basic Constraints:') in text)
460 self.assertTrue(b('CA:TRUE') in text)
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400461
462
463 def test_issuer(self):
464 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900465 If an extension requires a issuer, the :py:data:`issuer` parameter to
466 :py:class:`X509Extension` provides its value.
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400467 """
468 ext2 = X509Extension(
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400469 b('authorityKeyIdentifier'), False, b('issuer:always'),
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400470 issuer=self.x509)
471 self.x509.add_extensions([ext2])
472 self.x509.sign(self.pkey, 'sha1')
473 text = dump_certificate(FILETYPE_TEXT, self.x509)
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400474 self.assertTrue(b('X509v3 Authority Key Identifier:') in text)
475 self.assertTrue(b('DirName:/CN=Yoda root CA') in text)
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400476
477
478 def test_missing_issuer(self):
479 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900480 If an extension requires an issue and the :py:data:`issuer` parameter is given
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400481 no value, something happens.
482 """
483 self.assertRaises(
484 Error,
485 X509Extension,
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400486 b('authorityKeyIdentifier'), False,
487 b('keyid:always,issuer:always'))
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400488
489
490 def test_invalid_issuer(self):
491 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900492 If the :py:data:`issuer` parameter is given a value which is not an
493 :py:class:`X509` instance, :py:exc:`TypeError` is raised.
Jean-Paul Calderonef0179c72009-07-17 15:48:22 -0400494 """
495 for badObj in [True, object(), "hello", [], self]:
496 self.assertRaises(
497 TypeError,
498 X509Extension,
499 'authorityKeyIdentifier', False, 'keyid:always,issuer:always',
500 issuer=badObj)
Rick Dean47262da2009-07-08 16:17:17 -0500501
502
Jean-Paul Calderone391585f2008-12-31 14:36:31 -0500503
Jean-Paul Calderone18808652009-07-05 12:54:05 -0400504class PKeyTests(TestCase):
Jean-Paul Calderoneac930e12008-03-06 18:50:51 -0500505 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900506 Unit tests for :py:class:`OpenSSL.crypto.PKey`.
Jean-Paul Calderoneac930e12008-03-06 18:50:51 -0500507 """
Jean-Paul Calderone68649052009-07-17 21:14:27 -0400508 def test_type(self):
509 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900510 :py:class:`PKey` and :py:class:`PKeyType` refer to the same type object
511 and can be used to create instances of that type.
Jean-Paul Calderone68649052009-07-17 21:14:27 -0400512 """
513 self.assertIdentical(PKey, PKeyType)
514 self.assertConsistentType(PKey, 'PKey')
515
516
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500517 def test_construction(self):
518 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900519 :py:class:`PKey` takes no arguments and returns a new :py:class:`PKey` instance.
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500520 """
521 self.assertRaises(TypeError, PKey, None)
522 key = PKey()
523 self.assertTrue(
524 isinstance(key, PKeyType),
525 "%r is of type %r, should be %r" % (key, type(key), PKeyType))
526
527
528 def test_pregeneration(self):
529 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900530 :py:attr:`PKeyType.bits` and :py:attr:`PKeyType.type` return :py:data:`0` before the key is
531 generated. :py:attr:`PKeyType.check` raises :py:exc:`TypeError` before the key is
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500532 generated.
533 """
534 key = PKey()
535 self.assertEqual(key.type(), 0)
536 self.assertEqual(key.bits(), 0)
Jean-Paul Calderone55ec1712009-05-13 14:14:30 -0400537 self.assertRaises(TypeError, key.check)
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500538
539
540 def test_failedGeneration(self):
541 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900542 :py:meth:`PKeyType.generate_key` takes two arguments, the first giving the key
543 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 -0500544 number of bits to generate. If an invalid type is specified or
Jonathan Ballet648875f2011-07-16 14:14:58 +0900545 generation fails, :py:exc:`Error` is raised. If an invalid number of bits is
546 specified, :py:exc:`ValueError` or :py:exc:`Error` is raised.
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500547 """
548 key = PKey()
549 self.assertRaises(TypeError, key.generate_key)
550 self.assertRaises(TypeError, key.generate_key, 1, 2, 3)
551 self.assertRaises(TypeError, key.generate_key, "foo", "bar")
552 self.assertRaises(Error, key.generate_key, -1, 0)
Jean-Paul Calderoneab82db72008-03-06 00:09:31 -0500553
Jean-Paul Calderoneab82db72008-03-06 00:09:31 -0500554 self.assertRaises(ValueError, key.generate_key, TYPE_RSA, -1)
555 self.assertRaises(ValueError, key.generate_key, TYPE_RSA, 0)
Jean-Paul Calderoned71fe982008-03-06 00:31:50 -0500556
557 # XXX RSA generation for small values of bits is fairly buggy in a wide
558 # range of OpenSSL versions. I need to figure out what the safe lower
559 # bound for a reasonable number of OpenSSL versions is and explicitly
560 # check for that in the wrapper. The failure behavior is typically an
561 # infinite loop inside OpenSSL.
562
563 # self.assertRaises(Error, key.generate_key, TYPE_RSA, 2)
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500564
565 # XXX DSA generation seems happy with any number of bits. The DSS
566 # says bits must be between 512 and 1024 inclusive. OpenSSL's DSA
567 # generator doesn't seem to care about the upper limit at all. For
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500568 # the lower limit, it uses 512 if anything smaller is specified.
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500569 # So, it doesn't seem possible to make generate_key fail for
570 # TYPE_DSA with a bits argument which is at least an int.
571
572 # self.assertRaises(Error, key.generate_key, TYPE_DSA, -7)
573
574
575 def test_rsaGeneration(self):
576 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900577 :py:meth:`PKeyType.generate_key` generates an RSA key when passed
578 :py:data:`TYPE_RSA` as a type and a reasonable number of bits.
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500579 """
580 bits = 128
581 key = PKey()
582 key.generate_key(TYPE_RSA, bits)
583 self.assertEqual(key.type(), TYPE_RSA)
584 self.assertEqual(key.bits(), bits)
Jean-Paul Calderone8e6ce972009-05-13 12:32:49 -0400585 self.assertTrue(key.check())
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500586
587
588 def test_dsaGeneration(self):
589 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900590 :py:meth:`PKeyType.generate_key` generates a DSA key when passed
591 :py:data:`TYPE_DSA` as a type and a reasonable number of bits.
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500592 """
593 # 512 is a magic number. The DSS (Digital Signature Standard)
594 # allows a minimum of 512 bits for DSA. DSA_generate_parameters
595 # will silently promote any value below 512 to 512.
596 bits = 512
597 key = PKey()
598 key.generate_key(TYPE_DSA, bits)
599 self.assertEqual(key.type(), TYPE_DSA)
600 self.assertEqual(key.bits(), bits)
Jean-Paul Calderone8e6ce972009-05-13 12:32:49 -0400601 self.assertRaises(TypeError, key.check)
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500602
603
604 def test_regeneration(self):
605 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900606 :py:meth:`PKeyType.generate_key` can be called multiple times on the same
Jean-Paul Calderoned8782ad2008-03-04 23:39:59 -0500607 key to generate new keys.
608 """
609 key = PKey()
610 for type, bits in [(TYPE_RSA, 512), (TYPE_DSA, 576)]:
611 key.generate_key(type, bits)
612 self.assertEqual(key.type(), type)
613 self.assertEqual(key.bits(), bits)
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500614
615
Jean-Paul Calderone55ec1712009-05-13 14:14:30 -0400616 def test_inconsistentKey(self):
617 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900618 :py:`PKeyType.check` returns :py:exc:`Error` if the key is not consistent.
Jean-Paul Calderone55ec1712009-05-13 14:14:30 -0400619 """
620 key = load_privatekey(FILETYPE_PEM, inconsistentPrivateKeyPEM)
Jean-Paul Calderoned338e4e2009-05-13 15:45:07 -0400621 self.assertRaises(Error, key.check)
Jean-Paul Calderone55ec1712009-05-13 14:14:30 -0400622
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500623
Jean-Paul Calderonee81020e2011-06-12 21:48:57 -0400624 def test_check_wrong_args(self):
625 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900626 :py:meth:`PKeyType.check` raises :py:exc:`TypeError` if called with any arguments.
Jean-Paul Calderonee81020e2011-06-12 21:48:57 -0400627 """
628 self.assertRaises(TypeError, PKey().check, None)
629 self.assertRaises(TypeError, PKey().check, object())
630 self.assertRaises(TypeError, PKey().check, 1)
631
632
633
Jean-Paul Calderone18808652009-07-05 12:54:05 -0400634class X509NameTests(TestCase):
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500635 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900636 Unit tests for :py:class:`OpenSSL.crypto.X509Name`.
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500637 """
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500638 def _x509name(self, **attrs):
639 # XXX There's no other way to get a new X509Name yet.
640 name = X509().get_subject()
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400641 attrs = list(attrs.items())
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500642 # Make the order stable - order matters!
Jean-Paul Calderone40dd0992010-08-22 17:52:07 -0400643 def key(attr):
644 return attr[1]
645 attrs.sort(key=key)
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500646 for k, v in attrs:
647 setattr(name, k, v)
648 return name
649
650
Rick Deane15b1472009-07-09 15:53:42 -0500651 def test_type(self):
652 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900653 The type of X509Name objects is :py:class:`X509NameType`.
Rick Deane15b1472009-07-09 15:53:42 -0500654 """
Jean-Paul Calderone68649052009-07-17 21:14:27 -0400655 self.assertIdentical(X509Name, X509NameType)
656 self.assertEqual(X509NameType.__name__, 'X509Name')
657 self.assertTrue(isinstance(X509NameType, type))
658
Rick Deane15b1472009-07-09 15:53:42 -0500659 name = self._x509name()
660 self.assertTrue(
661 isinstance(name, X509NameType),
662 "%r is of type %r, should be %r" % (
663 name, type(name), X509NameType))
Rick Deane15b1472009-07-09 15:53:42 -0500664
665
Jean-Paul Calderone9ce9afb2011-04-22 18:16:22 -0400666 def test_onlyStringAttributes(self):
667 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900668 Attempting to set a non-:py:data:`str` attribute name on an :py:class:`X509NameType`
669 instance causes :py:exc:`TypeError` to be raised.
Jean-Paul Calderone9ce9afb2011-04-22 18:16:22 -0400670 """
671 name = self._x509name()
672 # Beyond these cases, you may also think that unicode should be
673 # rejected. Sorry, you're wrong. unicode is automatically converted to
674 # str outside of the control of X509Name, so there's no way to reject
675 # it.
676 self.assertRaises(TypeError, setattr, name, None, "hello")
677 self.assertRaises(TypeError, setattr, name, 30, "hello")
678 class evil(str):
679 pass
680 self.assertRaises(TypeError, setattr, name, evil(), "hello")
681
682
683 def test_setInvalidAttribute(self):
684 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900685 Attempting to set any attribute name on an :py:class:`X509NameType` instance for
686 which no corresponding NID is defined causes :py:exc:`AttributeError` to be
Jean-Paul Calderone9ce9afb2011-04-22 18:16:22 -0400687 raised.
688 """
689 name = self._x509name()
690 self.assertRaises(AttributeError, setattr, name, "no such thing", None)
691
692
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500693 def test_attributes(self):
694 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900695 :py:class:`X509NameType` instances have attributes for each standard (?)
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500696 X509Name field.
697 """
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500698 name = self._x509name()
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500699 name.commonName = "foo"
700 self.assertEqual(name.commonName, "foo")
701 self.assertEqual(name.CN, "foo")
702 name.CN = "baz"
703 self.assertEqual(name.commonName, "baz")
704 self.assertEqual(name.CN, "baz")
705 name.commonName = "bar"
706 self.assertEqual(name.commonName, "bar")
707 self.assertEqual(name.CN, "bar")
708 name.CN = "quux"
709 self.assertEqual(name.commonName, "quux")
710 self.assertEqual(name.CN, "quux")
711
712
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500713 def test_copy(self):
714 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900715 :py:class:`X509Name` creates a new :py:class:`X509NameType` instance with all the same
716 attributes as an existing :py:class:`X509NameType` instance when called with
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500717 one.
718 """
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500719 name = self._x509name(commonName="foo", emailAddress="bar@example.com")
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500720
721 copy = X509Name(name)
722 self.assertEqual(copy.commonName, "foo")
723 self.assertEqual(copy.emailAddress, "bar@example.com")
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500724
725 # Mutate the copy and ensure the original is unmodified.
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500726 copy.commonName = "baz"
727 self.assertEqual(name.commonName, "foo")
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500728
729 # Mutate the original and ensure the copy is unmodified.
Jean-Paul Calderoneeff3cd92008-03-05 22:35:26 -0500730 name.emailAddress = "quux@example.com"
731 self.assertEqual(copy.emailAddress, "bar@example.com")
732
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500733
734 def test_repr(self):
735 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900736 :py:func:`repr` passed an :py:class:`X509NameType` instance should return a string
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500737 containing a description of the type and the NIDs which have been set
738 on it.
739 """
740 name = self._x509name(commonName="foo", emailAddress="bar")
741 self.assertEqual(
742 repr(name),
743 "<X509Name object '/emailAddress=bar/CN=foo'>")
744
745
746 def test_comparison(self):
747 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900748 :py:class:`X509NameType` instances should compare based on their NIDs.
Jean-Paul Calderonee098dc72008-03-06 18:36:19 -0500749 """
750 def _equality(a, b, assertTrue, assertFalse):
751 assertTrue(a == b, "(%r == %r) --> False" % (a, b))
752 assertFalse(a != b)
753 assertTrue(b == a)
754 assertFalse(b != a)
755
756 def assertEqual(a, b):
757 _equality(a, b, self.assertTrue, self.assertFalse)
758
759 # Instances compare equal to themselves.
760 name = self._x509name()
761 assertEqual(name, name)
762
763 # Empty instances should compare equal to each other.
764 assertEqual(self._x509name(), self._x509name())
765
766 # Instances with equal NIDs should compare equal to each other.
767 assertEqual(self._x509name(commonName="foo"),
768 self._x509name(commonName="foo"))
769
770 # Instance with equal NIDs set using different aliases should compare
771 # equal to each other.
772 assertEqual(self._x509name(commonName="foo"),
773 self._x509name(CN="foo"))
774
775 # Instances with more than one NID with the same values should compare
776 # equal to each other.
777 assertEqual(self._x509name(CN="foo", organizationalUnitName="bar"),
778 self._x509name(commonName="foo", OU="bar"))
779
780 def assertNotEqual(a, b):
781 _equality(a, b, self.assertFalse, self.assertTrue)
782
783 # Instances with different values for the same NID should not compare
784 # equal to each other.
785 assertNotEqual(self._x509name(CN="foo"),
786 self._x509name(CN="bar"))
787
788 # Instances with different NIDs should not compare equal to each other.
789 assertNotEqual(self._x509name(CN="foo"),
790 self._x509name(OU="foo"))
791
792 def _inequality(a, b, assertTrue, assertFalse):
793 assertTrue(a < b)
794 assertTrue(a <= b)
795 assertTrue(b > a)
796 assertTrue(b >= a)
797 assertFalse(a > b)
798 assertFalse(a >= b)
799 assertFalse(b < a)
800 assertFalse(b <= a)
801
802 def assertLessThan(a, b):
803 _inequality(a, b, self.assertTrue, self.assertFalse)
804
805 # An X509Name with a NID with a value which sorts less than the value
806 # of the same NID on another X509Name compares less than the other
807 # X509Name.
808 assertLessThan(self._x509name(CN="abc"),
809 self._x509name(CN="def"))
810
811 def assertGreaterThan(a, b):
812 _inequality(a, b, self.assertFalse, self.assertTrue)
813
814 # An X509Name with a NID with a value which sorts greater than the
815 # value of the same NID on another X509Name compares greater than the
816 # other X509Name.
817 assertGreaterThan(self._x509name(CN="def"),
818 self._x509name(CN="abc"))
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500819
820
Jean-Paul Calderone110cd092008-03-24 17:27:42 -0400821 def test_hash(self):
822 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900823 :py:meth:`X509Name.hash` returns an integer hash based on the value of the
Jean-Paul Calderone110cd092008-03-24 17:27:42 -0400824 name.
825 """
826 a = self._x509name(CN="foo")
827 b = self._x509name(CN="foo")
828 self.assertEqual(a.hash(), b.hash())
829 a.CN = "bar"
830 self.assertNotEqual(a.hash(), b.hash())
831
832
Jean-Paul Calderonee957a002008-03-25 15:16:51 -0400833 def test_der(self):
834 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900835 :py:meth:`X509Name.der` returns the DER encoded form of the name.
Jean-Paul Calderonee957a002008-03-25 15:16:51 -0400836 """
837 a = self._x509name(CN="foo", C="US")
838 self.assertEqual(
839 a.der(),
Jean-Paul Calderone2ac721b2010-08-22 19:20:00 -0400840 b('0\x1b1\x0b0\t\x06\x03U\x04\x06\x13\x02US'
841 '1\x0c0\n\x06\x03U\x04\x03\x13\x03foo'))
Jean-Paul Calderonee957a002008-03-25 15:16:51 -0400842
843
Jean-Paul Calderonec54cc182008-03-26 21:11:07 -0400844 def test_get_components(self):
845 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900846 :py:meth:`X509Name.get_components` returns a :py:data:`list` of
847 two-tuples of :py:data:`str`
Jean-Paul Calderonec54cc182008-03-26 21:11:07 -0400848 giving the NIDs and associated values which make up the name.
849 """
850 a = self._x509name()
851 self.assertEqual(a.get_components(), [])
852 a.CN = "foo"
Jean-Paul Calderone2ac721b2010-08-22 19:20:00 -0400853 self.assertEqual(a.get_components(), [(b("CN"), b("foo"))])
Jean-Paul Calderonec54cc182008-03-26 21:11:07 -0400854 a.organizationalUnitName = "bar"
855 self.assertEqual(
856 a.get_components(),
Jean-Paul Calderone2ac721b2010-08-22 19:20:00 -0400857 [(b("CN"), b("foo")), (b("OU"), b("bar"))])
Jean-Paul Calderonec54cc182008-03-26 21:11:07 -0400858
Jean-Paul Calderone110cd092008-03-24 17:27:42 -0400859
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -0400860class _PKeyInteractionTestsMixin:
861 """
862 Tests which involve another thing and a PKey.
863 """
864 def signable(self):
865 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900866 Return something with a :py:meth:`set_pubkey`, :py:meth:`set_pubkey`,
867 and :py:meth:`sign` method.
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -0400868 """
869 raise NotImplementedError()
870
871
872 def test_signWithUngenerated(self):
873 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900874 :py:meth:`X509Req.sign` raises :py:exc:`ValueError` when pass a
875 :py:class:`PKey` with no parts.
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -0400876 """
877 request = self.signable()
878 key = PKey()
879 self.assertRaises(ValueError, request.sign, key, 'MD5')
880
881
882 def test_signWithPublicKey(self):
883 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900884 :py:meth:`X509Req.sign` raises :py:exc:`ValueError` when pass a
885 :py:class:`PKey` with no private part as the signing key.
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -0400886 """
887 request = self.signable()
888 key = PKey()
889 key.generate_key(TYPE_RSA, 512)
890 request.set_pubkey(key)
891 pub = request.get_pubkey()
892 self.assertRaises(ValueError, request.sign, pub, 'MD5')
893
894
Jean-Paul Calderonecc05a912010-08-03 18:24:19 -0400895 def test_signWithUnknownDigest(self):
896 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900897 :py:meth:`X509Req.sign` raises :py:exc:`ValueError` when passed a digest name which is
Jean-Paul Calderonecc05a912010-08-03 18:24:19 -0400898 not known.
899 """
900 request = self.signable()
901 key = PKey()
902 key.generate_key(TYPE_RSA, 512)
903 self.assertRaises(ValueError, request.sign, key, "monkeys")
904
905
Jean-Paul Calderoneb9725592010-08-03 18:17:22 -0400906 def test_sign(self):
907 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900908 :py:meth:`X509Req.sign` succeeds when passed a private key object and a valid
909 digest function. :py:meth:`X509Req.verify` can be used to check the signature.
Jean-Paul Calderoneb9725592010-08-03 18:17:22 -0400910 """
911 request = self.signable()
912 key = PKey()
913 key.generate_key(TYPE_RSA, 512)
914 request.set_pubkey(key)
915 request.sign(key, 'MD5')
916 # If the type has a verify method, cover that too.
917 if getattr(request, 'verify', None) is not None:
918 pub = request.get_pubkey()
919 self.assertTrue(request.verify(pub))
920 # Make another key that won't verify.
921 key = PKey()
922 key.generate_key(TYPE_RSA, 512)
923 self.assertRaises(Error, request.verify, key)
924
925
926
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -0400927
Jean-Paul Calderone18808652009-07-05 12:54:05 -0400928class X509ReqTests(TestCase, _PKeyInteractionTestsMixin):
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500929 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900930 Tests for :py:class:`OpenSSL.crypto.X509Req`.
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500931 """
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -0400932 def signable(self):
933 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900934 Create and return a new :py:class:`X509Req`.
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -0400935 """
936 return X509Req()
937
938
Jean-Paul Calderone68649052009-07-17 21:14:27 -0400939 def test_type(self):
940 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900941 :py:obj:`X509Req` and :py:obj:`X509ReqType` refer to the same type object and can be
Jean-Paul Calderone68649052009-07-17 21:14:27 -0400942 used to create instances of that type.
943 """
944 self.assertIdentical(X509Req, X509ReqType)
945 self.assertConsistentType(X509Req, 'X509Req')
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500946
947
948 def test_construction(self):
949 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900950 :py:obj:`X509Req` takes no arguments and returns an :py:obj:`X509ReqType` instance.
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500951 """
952 request = X509Req()
953 self.assertTrue(
954 isinstance(request, X509ReqType),
955 "%r is of type %r, should be %r" % (request, type(request), X509ReqType))
956
957
Jean-Paul Calderone8dd19b82008-12-28 20:41:16 -0500958 def test_version(self):
959 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900960 :py:obj:`X509ReqType.set_version` sets the X.509 version of the certificate
961 request. :py:obj:`X509ReqType.get_version` returns the X.509 version of
Jean-Paul Calderone8dd19b82008-12-28 20:41:16 -0500962 the certificate request. The initial value of the version is 0.
963 """
964 request = X509Req()
965 self.assertEqual(request.get_version(), 0)
966 request.set_version(1)
967 self.assertEqual(request.get_version(), 1)
968 request.set_version(3)
969 self.assertEqual(request.get_version(), 3)
970
971
Jean-Paul Calderone54e49e92010-07-30 11:04:46 -0400972 def test_version_wrong_args(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -0400973 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900974 :py:obj:`X509ReqType.set_version` raises :py:obj:`TypeError` if called with the wrong
975 number of arguments or with a non-:py:obj:`int` argument.
976 :py:obj:`X509ReqType.get_version` raises :py:obj:`TypeError` if called with any
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -0400977 arguments.
978 """
Jean-Paul Calderone54e49e92010-07-30 11:04:46 -0400979 request = X509Req()
980 self.assertRaises(TypeError, request.set_version)
981 self.assertRaises(TypeError, request.set_version, "foo")
982 self.assertRaises(TypeError, request.set_version, 1, 2)
983 self.assertRaises(TypeError, request.get_version, None)
984
985
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500986 def test_get_subject(self):
987 """
Jonathan Ballet648875f2011-07-16 14:14:58 +0900988 :py:obj:`X509ReqType.get_subject` returns an :py:obj:`X509Name` for the subject of
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500989 the request and which is valid even after the request object is
990 otherwise dead.
991 """
992 request = X509Req()
993 subject = request.get_subject()
994 self.assertTrue(
995 isinstance(subject, X509NameType),
996 "%r is of type %r, should be %r" % (subject, type(subject), X509NameType))
997 subject.commonName = "foo"
998 self.assertEqual(request.get_subject().commonName, "foo")
999 del request
1000 subject.commonName = "bar"
1001 self.assertEqual(subject.commonName, "bar")
Jean-Paul Calderone78381d22008-03-06 23:35:22 -05001002
1003
Jean-Paul Calderone54e49e92010-07-30 11:04:46 -04001004 def test_get_subject_wrong_args(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04001005 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001006 :py:obj:`X509ReqType.get_subject` raises :py:obj:`TypeError` if called with any
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04001007 arguments.
1008 """
Jean-Paul Calderone54e49e92010-07-30 11:04:46 -04001009 request = X509Req()
1010 self.assertRaises(TypeError, request.get_subject, None)
1011
1012
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04001013 def test_add_extensions(self):
1014 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001015 :py:obj:`X509Req.add_extensions` accepts a :py:obj:`list` of :py:obj:`X509Extension`
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04001016 instances and adds them to the X509 request.
1017 """
1018 request = X509Req()
1019 request.add_extensions([
Jean-Paul Calderonee16f9f32010-08-22 19:20:37 -04001020 X509Extension(b('basicConstraints'), True, b('CA:false'))])
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04001021 # XXX Add get_extensions so the rest of this unit test can be written.
1022
1023
1024 def test_add_extensions_wrong_args(self):
1025 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001026 :py:obj:`X509Req.add_extensions` raises :py:obj:`TypeError` if called with the wrong
1027 number of arguments or with a non-:py:obj:`list`. Or it raises :py:obj:`ValueError`
1028 if called with a :py:obj:`list` containing objects other than :py:obj:`X509Extension`
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04001029 instances.
1030 """
1031 request = X509Req()
1032 self.assertRaises(TypeError, request.add_extensions)
1033 self.assertRaises(TypeError, request.add_extensions, object())
1034 self.assertRaises(ValueError, request.add_extensions, [object()])
1035 self.assertRaises(TypeError, request.add_extensions, [], None)
1036
1037
Jean-Paul Calderone78381d22008-03-06 23:35:22 -05001038
Jean-Paul Calderone18808652009-07-05 12:54:05 -04001039class X509Tests(TestCase, _PKeyInteractionTestsMixin):
Jean-Paul Calderone78381d22008-03-06 23:35:22 -05001040 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001041 Tests for :py:obj:`OpenSSL.crypto.X509`.
Jean-Paul Calderone78381d22008-03-06 23:35:22 -05001042 """
Jean-Paul Calderone5ef86512008-04-26 19:06:28 -04001043 pemData = cleartextCertificatePEM + cleartextPrivateKeyPEM
Jean-Paul Calderone8114b452008-03-25 15:27:59 -04001044
Roland Hedberg7e4930e2008-04-22 22:58:50 +02001045 extpem = """
1046-----BEGIN CERTIFICATE-----
1047MIIC3jCCAkegAwIBAgIJAJHFjlcCgnQzMA0GCSqGSIb3DQEBBQUAMEcxCzAJBgNV
1048BAYTAlNFMRUwEwYDVQQIEwxXZXN0ZXJib3R0b20xEjAQBgNVBAoTCUNhdGFsb2dp
1049eDENMAsGA1UEAxMEUm9vdDAeFw0wODA0MjIxNDQ1MzhaFw0wOTA0MjIxNDQ1Mzha
1050MFQxCzAJBgNVBAYTAlNFMQswCQYDVQQIEwJXQjEUMBIGA1UEChMLT3Blbk1ldGFk
1051aXIxIjAgBgNVBAMTGW5vZGUxLm9tMi5vcGVubWV0YWRpci5vcmcwgZ8wDQYJKoZI
1052hvcNAQEBBQADgY0AMIGJAoGBAPIcQMrwbk2nESF/0JKibj9i1x95XYAOwP+LarwT
1053Op4EQbdlI9SY+uqYqlERhF19w7CS+S6oyqx0DRZSk4Y9dZ9j9/xgm2u/f136YS1u
1054zgYFPvfUs6PqYLPSM8Bw+SjJ+7+2+TN+Tkiof9WP1cMjodQwOmdsiRbR0/J7+b1B
1055hec1AgMBAAGjgcQwgcEwCQYDVR0TBAIwADAsBglghkgBhvhCAQ0EHxYdT3BlblNT
1056TCBHZW5lcmF0ZWQgQ2VydGlmaWNhdGUwHQYDVR0OBBYEFIdHsBcMVVMbAO7j6NCj
105703HgLnHaMB8GA1UdIwQYMBaAFL2h9Bf9Mre4vTdOiHTGAt7BRY/8MEYGA1UdEQQ/
1058MD2CDSouZXhhbXBsZS5vcmeCESoub20yLmV4bWFwbGUuY29thwSC7wgKgRNvbTJA
1059b3Blbm1ldGFkaXIub3JnMA0GCSqGSIb3DQEBBQUAA4GBALd7WdXkp2KvZ7/PuWZA
1060MPlIxyjS+Ly11+BNE0xGQRp9Wz+2lABtpgNqssvU156+HkKd02rGheb2tj7MX9hG
1061uZzbwDAZzJPjzDQDD7d3cWsrVcfIdqVU7epHqIadnOF+X0ghJ39pAm6VVadnSXCt
1062WpOdIpB8KksUTCzV591Nr1wd
1063-----END CERTIFICATE-----
1064 """
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -04001065 def signable(self):
1066 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001067 Create and return a new :py:obj:`X509`.
Jean-Paul Calderoneac0d95f2008-03-10 00:00:42 -04001068 """
1069 return X509()
1070
1071
Jean-Paul Calderone68649052009-07-17 21:14:27 -04001072 def test_type(self):
1073 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001074 :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 -04001075 to create instances of that type.
1076 """
1077 self.assertIdentical(X509, X509Type)
1078 self.assertConsistentType(X509, 'X509')
1079
1080
Jean-Paul Calderone78381d22008-03-06 23:35:22 -05001081 def test_construction(self):
1082 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001083 :py:obj:`X509` takes no arguments and returns an instance of :py:obj:`X509Type`.
Jean-Paul Calderone78381d22008-03-06 23:35:22 -05001084 """
1085 certificate = X509()
1086 self.assertTrue(
1087 isinstance(certificate, X509Type),
1088 "%r is of type %r, should be %r" % (certificate,
1089 type(certificate),
1090 X509Type))
Rick Deane15b1472009-07-09 15:53:42 -05001091 self.assertEqual(type(X509Type).__name__, 'type')
1092 self.assertEqual(type(certificate).__name__, 'X509')
1093 self.assertEqual(type(certificate), X509Type)
Rick Dean04113e72009-07-16 12:06:35 -05001094 self.assertEqual(type(certificate), X509)
Jean-Paul Calderone78381d22008-03-06 23:35:22 -05001095
1096
Jean-Paul Calderone3544eb42010-07-30 22:09:47 -04001097 def test_get_version_wrong_args(self):
1098 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001099 :py:obj:`X509.get_version` raises :py:obj:`TypeError` if invoked with any arguments.
Jean-Paul Calderone3544eb42010-07-30 22:09:47 -04001100 """
1101 cert = X509()
1102 self.assertRaises(TypeError, cert.get_version, None)
1103
1104
1105 def test_set_version_wrong_args(self):
1106 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001107 :py:obj:`X509.set_version` raises :py:obj:`TypeError` if invoked with the wrong number
1108 of arguments or an argument not of type :py:obj:`int`.
Jean-Paul Calderone3544eb42010-07-30 22:09:47 -04001109 """
1110 cert = X509()
1111 self.assertRaises(TypeError, cert.set_version)
1112 self.assertRaises(TypeError, cert.set_version, None)
1113 self.assertRaises(TypeError, cert.set_version, 1, None)
1114
1115
1116 def test_version(self):
1117 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001118 :py:obj:`X509.set_version` sets the certificate version number.
1119 :py:obj:`X509.get_version` retrieves it.
Jean-Paul Calderone3544eb42010-07-30 22:09:47 -04001120 """
1121 cert = X509()
1122 cert.set_version(1234)
1123 self.assertEquals(cert.get_version(), 1234)
1124
1125
1126 def test_get_serial_number_wrong_args(self):
1127 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001128 :py:obj:`X509.get_serial_number` raises :py:obj:`TypeError` if invoked with any
Jean-Paul Calderone3544eb42010-07-30 22:09:47 -04001129 arguments.
1130 """
1131 cert = X509()
1132 self.assertRaises(TypeError, cert.get_serial_number, None)
1133
1134
Jean-Paul Calderone78381d22008-03-06 23:35:22 -05001135 def test_serial_number(self):
1136 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001137 The serial number of an :py:obj:`X509Type` can be retrieved and modified with
1138 :py:obj:`X509Type.get_serial_number` and :py:obj:`X509Type.set_serial_number`.
Jean-Paul Calderone78381d22008-03-06 23:35:22 -05001139 """
1140 certificate = X509()
1141 self.assertRaises(TypeError, certificate.set_serial_number)
1142 self.assertRaises(TypeError, certificate.set_serial_number, 1, 2)
1143 self.assertRaises(TypeError, certificate.set_serial_number, "1")
1144 self.assertRaises(TypeError, certificate.set_serial_number, 5.5)
1145 self.assertEqual(certificate.get_serial_number(), 0)
1146 certificate.set_serial_number(1)
1147 self.assertEqual(certificate.get_serial_number(), 1)
1148 certificate.set_serial_number(2 ** 32 + 1)
1149 self.assertEqual(certificate.get_serial_number(), 2 ** 32 + 1)
1150 certificate.set_serial_number(2 ** 64 + 1)
1151 self.assertEqual(certificate.get_serial_number(), 2 ** 64 + 1)
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001152 certificate.set_serial_number(2 ** 128 + 1)
1153 self.assertEqual(certificate.get_serial_number(), 2 ** 128 + 1)
1154
1155
1156 def _setBoundTest(self, which):
1157 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001158 :py:obj:`X509Type.set_notBefore` takes a string in the format of an ASN1
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001159 GENERALIZEDTIME and sets the beginning of the certificate's validity
1160 period to it.
1161 """
1162 certificate = X509()
1163 set = getattr(certificate, 'set_not' + which)
1164 get = getattr(certificate, 'get_not' + which)
1165
Jean-Paul Calderonee0615b52008-03-09 21:44:46 -04001166 # Starts with no value.
1167 self.assertEqual(get(), None)
1168
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001169 # GMT (Or is it UTC?) -exarkun
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001170 when = b("20040203040506Z")
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001171 set(when)
1172 self.assertEqual(get(), when)
1173
1174 # A plus two hours and thirty minutes offset
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001175 when = b("20040203040506+0530")
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001176 set(when)
1177 self.assertEqual(get(), when)
1178
1179 # A minus one hour fifteen minutes offset
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001180 when = b("20040203040506-0115")
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001181 set(when)
1182 self.assertEqual(get(), when)
1183
1184 # An invalid string results in a ValueError
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001185 self.assertRaises(ValueError, set, b("foo bar"))
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001186
Jean-Paul Calderone31ca2002010-01-30 15:14:43 -05001187 # The wrong number of arguments results in a TypeError.
1188 self.assertRaises(TypeError, set)
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001189 self.assertRaises(TypeError, set, b("20040203040506Z"), b("20040203040506Z"))
1190 self.assertRaises(TypeError, get, b("foo bar"))
1191
Jean-Paul Calderone31ca2002010-01-30 15:14:43 -05001192
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04001193 # XXX ASN1_TIME (not GENERALIZEDTIME)
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001194
1195 def test_set_notBefore(self):
1196 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001197 :py:obj:`X509Type.set_notBefore` takes a string in the format of an ASN1
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001198 GENERALIZEDTIME and sets the beginning of the certificate's validity
1199 period to it.
1200 """
1201 self._setBoundTest("Before")
1202
1203
1204 def test_set_notAfter(self):
1205 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001206 :py:obj:`X509Type.set_notAfter` takes a string in the format of an ASN1
Jean-Paul Calderone525ef802008-03-09 20:39:42 -04001207 GENERALIZEDTIME and sets the end of the certificate's validity period
1208 to it.
1209 """
1210 self._setBoundTest("After")
Jean-Paul Calderone76576d52008-03-24 16:04:46 -04001211
1212
Jean-Paul Calderone38a646d2008-03-25 15:16:18 -04001213 def test_get_notBefore(self):
1214 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001215 :py:obj:`X509Type.get_notBefore` returns a string in the format of an ASN1
Jean-Paul Calderone38a646d2008-03-25 15:16:18 -04001216 GENERALIZEDTIME even for certificates which store it as UTCTIME
1217 internally.
1218 """
Jean-Paul Calderone8114b452008-03-25 15:27:59 -04001219 cert = load_certificate(FILETYPE_PEM, self.pemData)
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001220 self.assertEqual(cert.get_notBefore(), b("20090325123658Z"))
Jean-Paul Calderone38a646d2008-03-25 15:16:18 -04001221
Rick Dean38a05c82009-07-18 01:41:30 -05001222
1223 def test_get_notAfter(self):
1224 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001225 :py:obj:`X509Type.get_notAfter` returns a string in the format of an ASN1
Rick Dean38a05c82009-07-18 01:41:30 -05001226 GENERALIZEDTIME even for certificates which store it as UTCTIME
1227 internally.
1228 """
1229 cert = load_certificate(FILETYPE_PEM, self.pemData)
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001230 self.assertEqual(cert.get_notAfter(), b("20170611123658Z"))
Rick Dean38a05c82009-07-18 01:41:30 -05001231
1232
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001233 def test_gmtime_adj_notBefore_wrong_args(self):
1234 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001235 :py:obj:`X509Type.gmtime_adj_notBefore` raises :py:obj:`TypeError` if called with the
1236 wrong number of arguments or a non-:py:obj:`int` argument.
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001237 """
1238 cert = X509()
1239 self.assertRaises(TypeError, cert.gmtime_adj_notBefore)
1240 self.assertRaises(TypeError, cert.gmtime_adj_notBefore, None)
1241 self.assertRaises(TypeError, cert.gmtime_adj_notBefore, 123, None)
1242
1243
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001244 def test_gmtime_adj_notBefore(self):
1245 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001246 :py:obj:`X509Type.gmtime_adj_notBefore` changes the not-before timestamp to be
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001247 the current time plus the number of seconds passed in.
1248 """
1249 cert = load_certificate(FILETYPE_PEM, self.pemData)
1250 now = datetime.utcnow() + timedelta(seconds=100)
1251 cert.gmtime_adj_notBefore(100)
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001252 self.assertEqual(cert.get_notBefore(), b(now.strftime("%Y%m%d%H%M%SZ")))
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001253
1254
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001255 def test_gmtime_adj_notAfter_wrong_args(self):
1256 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001257 :py:obj:`X509Type.gmtime_adj_notAfter` raises :py:obj:`TypeError` if called with the
1258 wrong number of arguments or a non-:py:obj:`int` argument.
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001259 """
1260 cert = X509()
1261 self.assertRaises(TypeError, cert.gmtime_adj_notAfter)
1262 self.assertRaises(TypeError, cert.gmtime_adj_notAfter, None)
1263 self.assertRaises(TypeError, cert.gmtime_adj_notAfter, 123, None)
1264
1265
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001266 def test_gmtime_adj_notAfter(self):
1267 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001268 :py:obj:`X509Type.gmtime_adj_notAfter` changes the not-after timestamp to be
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001269 the current time plus the number of seconds passed in.
1270 """
1271 cert = load_certificate(FILETYPE_PEM, self.pemData)
1272 now = datetime.utcnow() + timedelta(seconds=100)
1273 cert.gmtime_adj_notAfter(100)
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001274 self.assertEqual(cert.get_notAfter(), b(now.strftime("%Y%m%d%H%M%SZ")))
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001275
1276
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001277 def test_has_expired_wrong_args(self):
1278 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001279 :py:obj:`X509Type.has_expired` raises :py:obj:`TypeError` if called with any
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001280 arguments.
1281 """
1282 cert = X509()
1283 self.assertRaises(TypeError, cert.has_expired, None)
1284
1285
1286 def test_has_expired(self):
1287 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001288 :py:obj:`X509Type.has_expired` returns :py:obj:`True` if the certificate's not-after
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001289 time is in the past.
1290 """
1291 cert = X509()
1292 cert.gmtime_adj_notAfter(-1)
1293 self.assertTrue(cert.has_expired())
1294
1295
1296 def test_has_not_expired(self):
1297 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001298 :py:obj:`X509Type.has_expired` returns :py:obj:`False` if the certificate's not-after
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001299 time is in the future.
1300 """
1301 cert = X509()
1302 cert.gmtime_adj_notAfter(2)
1303 self.assertFalse(cert.has_expired())
1304
1305
Rick Dean38a05c82009-07-18 01:41:30 -05001306 def test_digest(self):
1307 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001308 :py:obj:`X509.digest` returns a string giving ":"-separated hex-encoded words
Rick Dean38a05c82009-07-18 01:41:30 -05001309 of the digest of the certificate.
1310 """
1311 cert = X509()
1312 self.assertEqual(
1313 cert.digest("md5"),
Jean-Paul Calderonee890db32010-08-22 16:55:15 -04001314 b("A8:EB:07:F8:53:25:0A:F2:56:05:C5:A5:C4:C4:C7:15"))
Rick Dean38a05c82009-07-18 01:41:30 -05001315
1316
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001317 def _extcert(self, pkey, extensions):
1318 cert = X509()
1319 cert.set_pubkey(pkey)
1320 cert.get_subject().commonName = "Unit Tests"
1321 cert.get_issuer().commonName = "Unit Tests"
1322 when = b(datetime.now().strftime("%Y%m%d%H%M%SZ"))
1323 cert.set_notBefore(when)
1324 cert.set_notAfter(when)
1325
1326 cert.add_extensions(extensions)
1327 return load_certificate(
1328 FILETYPE_PEM, dump_certificate(FILETYPE_PEM, cert))
1329
1330
Roland Hedberg7e4930e2008-04-22 22:58:50 +02001331 def test_extension_count(self):
1332 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001333 :py:obj:`X509.get_extension_count` returns the number of extensions that are
Jean-Paul Calderonef7b3ee62011-04-01 17:36:24 -04001334 present in the certificate.
Roland Hedberg7e4930e2008-04-22 22:58:50 +02001335 """
Jean-Paul Calderonef7b3ee62011-04-01 17:36:24 -04001336 pkey = load_privatekey(FILETYPE_PEM, client_key_pem)
Jean-Paul Calderone90abbc02011-04-06 18:20:22 -04001337 ca = X509Extension(b('basicConstraints'), True, b('CA:FALSE'))
1338 key = X509Extension(b('keyUsage'), True, b('digitalSignature'))
Jean-Paul Calderonef7b3ee62011-04-01 17:36:24 -04001339 subjectAltName = X509Extension(
Jean-Paul Calderone90abbc02011-04-06 18:20:22 -04001340 b('subjectAltName'), True, b('DNS:example.com'))
Jean-Paul Calderonef7b3ee62011-04-01 17:36:24 -04001341
1342 # Try a certificate with no extensions at all.
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001343 c = self._extcert(pkey, [])
Jean-Paul Calderonef7b3ee62011-04-01 17:36:24 -04001344 self.assertEqual(c.get_extension_count(), 0)
1345
1346 # And a certificate with one
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001347 c = self._extcert(pkey, [ca])
Jean-Paul Calderonef7b3ee62011-04-01 17:36:24 -04001348 self.assertEqual(c.get_extension_count(), 1)
1349
1350 # And a certificate with several
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001351 c = self._extcert(pkey, [ca, key, subjectAltName])
Jean-Paul Calderonef7b3ee62011-04-01 17:36:24 -04001352 self.assertEqual(c.get_extension_count(), 3)
Roland Hedberg7e4930e2008-04-22 22:58:50 +02001353
1354
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001355 def test_get_extension(self):
1356 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001357 :py:obj:`X509.get_extension` takes an integer and returns an :py:obj:`X509Extension`
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001358 corresponding to the extension at that index.
1359 """
1360 pkey = load_privatekey(FILETYPE_PEM, client_key_pem)
Jean-Paul Calderone90abbc02011-04-06 18:20:22 -04001361 ca = X509Extension(b('basicConstraints'), True, b('CA:FALSE'))
1362 key = X509Extension(b('keyUsage'), True, b('digitalSignature'))
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001363 subjectAltName = X509Extension(
Jean-Paul Calderone90abbc02011-04-06 18:20:22 -04001364 b('subjectAltName'), False, b('DNS:example.com'))
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001365
1366 cert = self._extcert(pkey, [ca, key, subjectAltName])
1367
1368 ext = cert.get_extension(0)
1369 self.assertTrue(isinstance(ext, X509Extension))
1370 self.assertTrue(ext.get_critical())
Jean-Paul Calderone90abbc02011-04-06 18:20:22 -04001371 self.assertEqual(ext.get_short_name(), b('basicConstraints'))
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001372
1373 ext = cert.get_extension(1)
1374 self.assertTrue(isinstance(ext, X509Extension))
1375 self.assertTrue(ext.get_critical())
Jean-Paul Calderone90abbc02011-04-06 18:20:22 -04001376 self.assertEqual(ext.get_short_name(), b('keyUsage'))
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001377
1378 ext = cert.get_extension(2)
1379 self.assertTrue(isinstance(ext, X509Extension))
1380 self.assertFalse(ext.get_critical())
Jean-Paul Calderone90abbc02011-04-06 18:20:22 -04001381 self.assertEqual(ext.get_short_name(), b('subjectAltName'))
Jean-Paul Calderone83a593d2011-04-01 17:45:07 -04001382
1383 self.assertRaises(IndexError, cert.get_extension, -1)
1384 self.assertRaises(IndexError, cert.get_extension, 4)
1385 self.assertRaises(TypeError, cert.get_extension, "hello")
1386
1387
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04001388 def test_invalid_digest_algorithm(self):
1389 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001390 :py:obj:`X509.digest` raises :py:obj:`ValueError` if called with an unrecognized hash
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04001391 algorithm.
1392 """
1393 cert = X509()
1394 self.assertRaises(ValueError, cert.digest, "monkeys")
1395
1396
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001397 def test_get_subject_wrong_args(self):
1398 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001399 :py:obj:`X509.get_subject` raises :py:obj:`TypeError` if called with any arguments.
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001400 """
1401 cert = X509()
1402 self.assertRaises(TypeError, cert.get_subject, None)
1403
1404
1405 def test_get_subject(self):
1406 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001407 :py:obj:`X509.get_subject` returns an :py:obj:`X509Name` instance.
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001408 """
1409 cert = load_certificate(FILETYPE_PEM, self.pemData)
1410 subj = cert.get_subject()
1411 self.assertTrue(isinstance(subj, X509Name))
1412 self.assertEquals(
1413 subj.get_components(),
Jean-Paul Calderonedc3275f2010-08-22 17:04:09 -04001414 [(b('C'), b('US')), (b('ST'), b('IL')), (b('L'), b('Chicago')),
1415 (b('O'), b('Testing')), (b('CN'), b('Testing Root CA'))])
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001416
1417
1418 def test_set_subject_wrong_args(self):
1419 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001420 :py:obj:`X509.set_subject` raises a :py:obj:`TypeError` if called with the wrong
1421 number of arguments or an argument not of type :py:obj:`X509Name`.
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001422 """
1423 cert = X509()
1424 self.assertRaises(TypeError, cert.set_subject)
1425 self.assertRaises(TypeError, cert.set_subject, None)
1426 self.assertRaises(TypeError, cert.set_subject, cert.get_subject(), None)
1427
1428
1429 def test_set_subject(self):
1430 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001431 :py:obj:`X509.set_subject` changes the subject of the certificate to the one
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001432 passed in.
1433 """
1434 cert = X509()
1435 name = cert.get_subject()
1436 name.C = 'AU'
1437 name.O = 'Unit Tests'
1438 cert.set_subject(name)
1439 self.assertEquals(
1440 cert.get_subject().get_components(),
Jean-Paul Calderonedc3275f2010-08-22 17:04:09 -04001441 [(b('C'), b('AU')), (b('O'), b('Unit Tests'))])
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001442
1443
1444 def test_get_issuer_wrong_args(self):
1445 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001446 :py:obj:`X509.get_issuer` raises :py:obj:`TypeError` if called with any arguments.
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001447 """
1448 cert = X509()
1449 self.assertRaises(TypeError, cert.get_issuer, None)
1450
1451
1452 def test_get_issuer(self):
1453 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001454 :py:obj:`X509.get_issuer` returns an :py:obj:`X509Name` instance.
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001455 """
1456 cert = load_certificate(FILETYPE_PEM, self.pemData)
1457 subj = cert.get_issuer()
1458 self.assertTrue(isinstance(subj, X509Name))
Jean-Paul Calderone30a4cb32010-08-11 23:54:12 -04001459 comp = subj.get_components()
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001460 self.assertEquals(
Jean-Paul Calderone30a4cb32010-08-11 23:54:12 -04001461 comp,
Jean-Paul Calderonedc3275f2010-08-22 17:04:09 -04001462 [(b('C'), b('US')), (b('ST'), b('IL')), (b('L'), b('Chicago')),
1463 (b('O'), b('Testing')), (b('CN'), b('Testing Root CA'))])
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001464
1465
1466 def test_set_issuer_wrong_args(self):
1467 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001468 :py:obj:`X509.set_issuer` raises a :py:obj:`TypeError` if called with the wrong
1469 number of arguments or an argument not of type :py:obj:`X509Name`.
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001470 """
1471 cert = X509()
1472 self.assertRaises(TypeError, cert.set_issuer)
1473 self.assertRaises(TypeError, cert.set_issuer, None)
1474 self.assertRaises(TypeError, cert.set_issuer, cert.get_issuer(), None)
1475
1476
1477 def test_set_issuer(self):
1478 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001479 :py:obj:`X509.set_issuer` changes the issuer of the certificate to the one
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001480 passed in.
1481 """
1482 cert = X509()
1483 name = cert.get_issuer()
1484 name.C = 'AU'
1485 name.O = 'Unit Tests'
1486 cert.set_issuer(name)
1487 self.assertEquals(
1488 cert.get_issuer().get_components(),
Jean-Paul Calderonedc3275f2010-08-22 17:04:09 -04001489 [(b('C'), b('AU')), (b('O'), b('Unit Tests'))])
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001490
1491
1492 def test_get_pubkey_uninitialized(self):
1493 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001494 When called on a certificate with no public key, :py:obj:`X509.get_pubkey`
1495 raises :py:obj:`OpenSSL.crypto.Error`.
Jean-Paul Calderone4f237b22010-07-30 22:29:39 -04001496 """
1497 cert = X509()
1498 self.assertRaises(Error, cert.get_pubkey)
1499
1500
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001501 def test_subject_name_hash_wrong_args(self):
1502 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001503 :py:obj:`X509.subject_name_hash` raises :py:obj:`TypeError` if called with any
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001504 arguments.
1505 """
1506 cert = X509()
1507 self.assertRaises(TypeError, cert.subject_name_hash, None)
1508
1509
1510 def test_subject_name_hash(self):
1511 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001512 :py:obj:`X509.subject_name_hash` returns the hash of the certificate's subject
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001513 name.
1514 """
1515 cert = load_certificate(FILETYPE_PEM, self.pemData)
Jean-Paul Calderone060a57e2011-05-04 18:02:49 -04001516 self.assertIn(
Jean-Paul Calderone2755fa52011-05-18 19:42:10 -04001517 cert.subject_name_hash(),
Jean-Paul Calderone060a57e2011-05-04 18:02:49 -04001518 [3350047874, # OpenSSL 0.9.8, MD5
1519 3278919224, # OpenSSL 1.0.0, SHA1
1520 ])
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001521
1522
Jean-Paul Calderone2755fa52011-05-18 19:42:10 -04001523 def test_get_signature_algorithm(self):
1524 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001525 :py:obj:`X509Type.get_signature_algorithm` returns a string which means
Jean-Paul Calderone2755fa52011-05-18 19:42:10 -04001526 the algorithm used to sign the certificate.
1527 """
1528 cert = load_certificate(FILETYPE_PEM, self.pemData)
Jean-Paul Calderone5d8e4052011-05-19 17:51:43 -04001529 self.assertEqual(
1530 b("sha1WithRSAEncryption"), cert.get_signature_algorithm())
Jean-Paul Calderone2755fa52011-05-18 19:42:10 -04001531
1532
1533 def test_get_undefined_signature_algorithm(self):
Jean-Paul Calderone5d8e4052011-05-19 17:51:43 -04001534 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001535 :py:obj:`X509Type.get_signature_algorithm` raises :py:obj:`ValueError` if the
Jean-Paul Calderone5d8e4052011-05-19 17:51:43 -04001536 signature algorithm is undefined or unknown.
1537 """
1538 # This certificate has been modified to indicate a bogus OID in the
1539 # signature algorithm field so that OpenSSL does not recognize it.
Jean-Paul Calderone2755fa52011-05-18 19:42:10 -04001540 certPEM = """\
1541-----BEGIN CERTIFICATE-----
1542MIIC/zCCAmigAwIBAgIBATAGBgJ8BQUAMHsxCzAJBgNVBAYTAlNHMREwDwYDVQQK
1543EwhNMkNyeXB0bzEUMBIGA1UECxMLTTJDcnlwdG8gQ0ExJDAiBgNVBAMTG00yQ3J5
1544cHRvIENlcnRpZmljYXRlIE1hc3RlcjEdMBsGCSqGSIb3DQEJARYObmdwc0Bwb3N0
1545MS5jb20wHhcNMDAwOTEwMDk1MTMwWhcNMDIwOTEwMDk1MTMwWjBTMQswCQYDVQQG
1546EwJTRzERMA8GA1UEChMITTJDcnlwdG8xEjAQBgNVBAMTCWxvY2FsaG9zdDEdMBsG
1547CSqGSIb3DQEJARYObmdwc0Bwb3N0MS5jb20wXDANBgkqhkiG9w0BAQEFAANLADBI
1548AkEArL57d26W9fNXvOhNlZzlPOACmvwOZ5AdNgLzJ1/MfsQQJ7hHVeHmTAjM664V
1549+fXvwUGJLziCeBo1ysWLRnl8CQIDAQABo4IBBDCCAQAwCQYDVR0TBAIwADAsBglg
1550hkgBhvhCAQ0EHxYdT3BlblNTTCBHZW5lcmF0ZWQgQ2VydGlmaWNhdGUwHQYDVR0O
1551BBYEFM+EgpK+eyZiwFU1aOPSbczbPSpVMIGlBgNVHSMEgZ0wgZqAFPuHI2nrnDqT
1552FeXFvylRT/7tKDgBoX+kfTB7MQswCQYDVQQGEwJTRzERMA8GA1UEChMITTJDcnlw
1553dG8xFDASBgNVBAsTC00yQ3J5cHRvIENBMSQwIgYDVQQDExtNMkNyeXB0byBDZXJ0
1554aWZpY2F0ZSBNYXN0ZXIxHTAbBgkqhkiG9w0BCQEWDm5ncHNAcG9zdDEuY29tggEA
1555MA0GCSqGSIb3DQEBBAUAA4GBADv8KpPo+gfJxN2ERK1Y1l17sz/ZhzoGgm5XCdbx
1556jEY7xKfpQngV599k1xhl11IMqizDwu0855agrckg2MCTmOI9DZzDD77tAYb+Dk0O
1557PEVk0Mk/V0aIsDE9bolfCi/i/QWZ3N8s5nTWMNyBBBmoSliWCm4jkkRZRD0ejgTN
1558tgI5
1559-----END CERTIFICATE-----
1560"""
1561 cert = load_certificate(FILETYPE_PEM, certPEM)
1562 self.assertRaises(ValueError, cert.get_signature_algorithm)
Jean-Paul Calderoneccf9d482010-07-30 22:36:42 -04001563
1564
Rick Dean38a05c82009-07-18 01:41:30 -05001565
Rick Dean623ee362009-07-17 12:22:16 -05001566class PKCS12Tests(TestCase):
1567 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001568 Test for :py:obj:`OpenSSL.crypto.PKCS12` and :py:obj:`OpenSSL.crypto.load_pkcs12`.
Rick Dean623ee362009-07-17 12:22:16 -05001569 """
1570 pemData = cleartextCertificatePEM + cleartextPrivateKeyPEM
1571
Jean-Paul Calderonec3a41f72009-07-25 12:36:02 -04001572 def test_type(self):
1573 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001574 :py:obj:`PKCS12Type` is a type object.
Jean-Paul Calderonec3a41f72009-07-25 12:36:02 -04001575 """
1576 self.assertIdentical(PKCS12, PKCS12Type)
1577 self.assertConsistentType(PKCS12, 'PKCS12')
1578
1579
Rick Deanf94096c2009-07-18 14:23:06 -05001580 def test_empty_construction(self):
Rick Dean38a05c82009-07-18 01:41:30 -05001581 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001582 :py:obj:`PKCS12` returns a new instance of :py:obj:`PKCS12` with no certificate,
Jean-Paul Calderonedc857b52009-07-25 12:25:07 -04001583 private key, CA certificates, or friendly name.
Rick Dean38a05c82009-07-18 01:41:30 -05001584 """
Jean-Paul Calderonea202edb2009-07-25 12:22:12 -04001585 p12 = PKCS12()
Rick Dean623ee362009-07-17 12:22:16 -05001586 self.assertEqual(None, p12.get_certificate())
1587 self.assertEqual(None, p12.get_privatekey())
1588 self.assertEqual(None, p12.get_ca_certificates())
Rick Dean42d69e12009-07-20 11:36:08 -05001589 self.assertEqual(None, p12.get_friendlyname())
Rick Dean623ee362009-07-17 12:22:16 -05001590
Rick Dean38a05c82009-07-18 01:41:30 -05001591
Rick Dean623ee362009-07-17 12:22:16 -05001592 def test_type_errors(self):
Rick Dean38a05c82009-07-18 01:41:30 -05001593 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001594 The :py:obj:`PKCS12` setter functions (:py:obj:`set_certificate`, :py:obj:`set_privatekey`,
1595 :py:obj:`set_ca_certificates`, and :py:obj:`set_friendlyname`) raise :py:obj:`TypeError`
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001596 when passed objects of types other than those expected.
Rick Dean38a05c82009-07-18 01:41:30 -05001597 """
Jean-Paul Calderonea202edb2009-07-25 12:22:12 -04001598 p12 = PKCS12()
Rick Dean623ee362009-07-17 12:22:16 -05001599 self.assertRaises(TypeError, p12.set_certificate, 3)
Rick Deanf94096c2009-07-18 14:23:06 -05001600 self.assertRaises(TypeError, p12.set_certificate, PKey())
1601 self.assertRaises(TypeError, p12.set_certificate, X509)
Rick Dean623ee362009-07-17 12:22:16 -05001602 self.assertRaises(TypeError, p12.set_privatekey, 3)
Rick Deanf94096c2009-07-18 14:23:06 -05001603 self.assertRaises(TypeError, p12.set_privatekey, 'legbone')
1604 self.assertRaises(TypeError, p12.set_privatekey, X509())
Rick Dean623ee362009-07-17 12:22:16 -05001605 self.assertRaises(TypeError, p12.set_ca_certificates, 3)
1606 self.assertRaises(TypeError, p12.set_ca_certificates, X509())
1607 self.assertRaises(TypeError, p12.set_ca_certificates, (3, 4))
Rick Deanf94096c2009-07-18 14:23:06 -05001608 self.assertRaises(TypeError, p12.set_ca_certificates, ( PKey(), ))
Rick Dean42d69e12009-07-20 11:36:08 -05001609 self.assertRaises(TypeError, p12.set_friendlyname, 6)
1610 self.assertRaises(TypeError, p12.set_friendlyname, ('foo', 'bar'))
Rick Dean623ee362009-07-17 12:22:16 -05001611
Rick Dean38a05c82009-07-18 01:41:30 -05001612
Rick Dean623ee362009-07-17 12:22:16 -05001613 def test_key_only(self):
1614 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001615 A :py:obj:`PKCS12` with only a private key can be exported using
1616 :py:obj:`PKCS12.export` and loaded again using :py:obj:`load_pkcs12`.
Rick Dean623ee362009-07-17 12:22:16 -05001617 """
1618 passwd = 'blah'
1619 p12 = PKCS12()
Jean-Paul Calderonea202edb2009-07-25 12:22:12 -04001620 pkey = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001621 p12.set_privatekey(pkey)
Rick Dean623ee362009-07-17 12:22:16 -05001622 self.assertEqual(None, p12.get_certificate())
1623 self.assertEqual(pkey, p12.get_privatekey())
Rick Dean321a0512009-08-13 17:21:29 -05001624 try:
1625 dumped_p12 = p12.export(passphrase=passwd, iter=2, maciter=3)
1626 except Error:
1627 # Some versions of OpenSSL will throw an exception
1628 # for this nearly useless PKCS12 we tried to generate:
1629 # [('PKCS12 routines', 'PKCS12_create', 'invalid null argument')]
1630 return
Rick Dean623ee362009-07-17 12:22:16 -05001631 p12 = load_pkcs12(dumped_p12, passwd)
1632 self.assertEqual(None, p12.get_ca_certificates())
1633 self.assertEqual(None, p12.get_certificate())
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001634
1635 # OpenSSL fails to bring the key back to us. So sad. Perhaps in the
1636 # future this will be improved.
1637 self.assertTrue(isinstance(p12.get_privatekey(), (PKey, type(None))))
Rick Dean623ee362009-07-17 12:22:16 -05001638
Rick Dean38a05c82009-07-18 01:41:30 -05001639
Rick Dean623ee362009-07-17 12:22:16 -05001640 def test_cert_only(self):
1641 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001642 A :py:obj:`PKCS12` with only a certificate can be exported using
1643 :py:obj:`PKCS12.export` and loaded again using :py:obj:`load_pkcs12`.
Rick Dean623ee362009-07-17 12:22:16 -05001644 """
1645 passwd = 'blah'
1646 p12 = PKCS12()
Jean-Paul Calderonea202edb2009-07-25 12:22:12 -04001647 cert = load_certificate(FILETYPE_PEM, cleartextCertificatePEM)
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001648 p12.set_certificate(cert)
Rick Dean623ee362009-07-17 12:22:16 -05001649 self.assertEqual(cert, p12.get_certificate())
1650 self.assertEqual(None, p12.get_privatekey())
Rick Dean321a0512009-08-13 17:21:29 -05001651 try:
1652 dumped_p12 = p12.export(passphrase=passwd, iter=2, maciter=3)
1653 except Error:
1654 # Some versions of OpenSSL will throw an exception
1655 # for this nearly useless PKCS12 we tried to generate:
1656 # [('PKCS12 routines', 'PKCS12_create', 'invalid null argument')]
1657 return
Rick Dean623ee362009-07-17 12:22:16 -05001658 p12 = load_pkcs12(dumped_p12, passwd)
1659 self.assertEqual(None, p12.get_privatekey())
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001660
1661 # OpenSSL fails to bring the cert back to us. Groany mcgroan.
1662 self.assertTrue(isinstance(p12.get_certificate(), (X509, type(None))))
1663
1664 # Oh ho. It puts the certificate into the ca certificates list, in
1665 # fact. Totally bogus, I would think. Nevertheless, let's exploit
1666 # that to check to see if it reconstructed the certificate we expected
1667 # it to. At some point, hopefully this will change so that
1668 # p12.get_certificate() is actually what returns the loaded
1669 # certificate.
1670 self.assertEqual(
1671 cleartextCertificatePEM,
1672 dump_certificate(FILETYPE_PEM, p12.get_ca_certificates()[0]))
Rick Dean623ee362009-07-17 12:22:16 -05001673
1674
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001675 def gen_pkcs12(self, cert_pem=None, key_pem=None, ca_pem=None, friendly_name=None):
Rick Dean623ee362009-07-17 12:22:16 -05001676 """
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001677 Generate a PKCS12 object with components from PEM. Verify that the set
1678 functions return None.
Rick Dean623ee362009-07-17 12:22:16 -05001679 """
Rick Deanf94096c2009-07-18 14:23:06 -05001680 p12 = PKCS12()
1681 if cert_pem:
1682 ret = p12.set_certificate(load_certificate(FILETYPE_PEM, cert_pem))
1683 self.assertEqual(ret, None)
1684 if key_pem:
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001685 ret = p12.set_privatekey(load_privatekey(FILETYPE_PEM, key_pem))
Rick Deanf94096c2009-07-18 14:23:06 -05001686 self.assertEqual(ret, None)
1687 if ca_pem:
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001688 ret = p12.set_ca_certificates((load_certificate(FILETYPE_PEM, ca_pem),))
Rick Deanf94096c2009-07-18 14:23:06 -05001689 self.assertEqual(ret, None)
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001690 if friendly_name:
1691 ret = p12.set_friendlyname(friendly_name)
Rick Dean42d69e12009-07-20 11:36:08 -05001692 self.assertEqual(ret, None)
Rick Deanf94096c2009-07-18 14:23:06 -05001693 return p12
1694
1695
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001696 def check_recovery(self, p12_str, key=None, cert=None, ca=None, passwd='',
1697 extra=()):
Rick Deanf94096c2009-07-18 14:23:06 -05001698 """
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001699 Use openssl program to confirm three components are recoverable from a
1700 PKCS12 string.
Rick Deanf94096c2009-07-18 14:23:06 -05001701 """
1702 if key:
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001703 recovered_key = _runopenssl(
1704 p12_str, "pkcs12", '-nocerts', '-nodes', '-passin',
1705 'pass:' + passwd, *extra)
Rick Deanf94096c2009-07-18 14:23:06 -05001706 self.assertEqual(recovered_key[-len(key):], key)
1707 if cert:
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001708 recovered_cert = _runopenssl(
1709 p12_str, "pkcs12", '-clcerts', '-nodes', '-passin',
1710 'pass:' + passwd, '-nokeys', *extra)
Rick Deanf94096c2009-07-18 14:23:06 -05001711 self.assertEqual(recovered_cert[-len(cert):], cert)
1712 if ca:
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001713 recovered_cert = _runopenssl(
1714 p12_str, "pkcs12", '-cacerts', '-nodes', '-passin',
1715 'pass:' + passwd, '-nokeys', *extra)
Rick Deanf94096c2009-07-18 14:23:06 -05001716 self.assertEqual(recovered_cert[-len(ca):], ca)
1717
1718
1719 def test_load_pkcs12(self):
1720 """
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001721 A PKCS12 string generated using the openssl command line can be loaded
Jonathan Ballet648875f2011-07-16 14:14:58 +09001722 with :py:obj:`load_pkcs12` and its components extracted and examined.
Rick Deanf94096c2009-07-18 14:23:06 -05001723 """
Rick Dean623ee362009-07-17 12:22:16 -05001724 passwd = 'whatever'
1725 pem = client_key_pem + client_cert_pem
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001726 p12_str = _runopenssl(
1727 pem, "pkcs12", '-export', '-clcerts', '-passout', 'pass:' + passwd)
Rick Dean623ee362009-07-17 12:22:16 -05001728 p12 = load_pkcs12(p12_str, passwd)
Jean-Paul Calderonea202edb2009-07-25 12:22:12 -04001729 # verify
Rick Deanf94096c2009-07-18 14:23:06 -05001730 self.assertTrue(isinstance(p12, PKCS12))
Rick Dean623ee362009-07-17 12:22:16 -05001731 cert_pem = dump_certificate(FILETYPE_PEM, p12.get_certificate())
1732 self.assertEqual(cert_pem, client_cert_pem)
1733 key_pem = dump_privatekey(FILETYPE_PEM, p12.get_privatekey())
1734 self.assertEqual(key_pem, client_key_pem)
1735 self.assertEqual(None, p12.get_ca_certificates())
Rick Deanf94096c2009-07-18 14:23:06 -05001736
Rick Deanee568302009-07-24 09:56:29 -05001737
1738 def test_load_pkcs12_garbage(self):
1739 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001740 :py:obj:`load_pkcs12` raises :py:obj:`OpenSSL.crypto.Error` when passed a string
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001741 which is not a PKCS12 dump.
Rick Deanee568302009-07-24 09:56:29 -05001742 """
1743 passwd = 'whatever'
1744 e = self.assertRaises(Error, load_pkcs12, 'fruit loops', passwd)
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -04001745 self.assertEqual( e.args[0][0][0], 'asn1 encoding routines')
1746 self.assertEqual( len(e.args[0][0]), 3)
Rick Deanee568302009-07-24 09:56:29 -05001747
1748
Rick Deanf94096c2009-07-18 14:23:06 -05001749 def test_replace(self):
1750 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001751 :py:obj:`PKCS12.set_certificate` replaces the certificate in a PKCS12 cluster.
1752 :py:obj:`PKCS12.set_privatekey` replaces the private key.
1753 :py:obj:`PKCS12.set_ca_certificates` replaces the CA certificates.
Rick Deanf94096c2009-07-18 14:23:06 -05001754 """
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001755 p12 = self.gen_pkcs12(client_cert_pem, client_key_pem, root_cert_pem)
1756 p12.set_certificate(load_certificate(FILETYPE_PEM, server_cert_pem))
1757 p12.set_privatekey(load_privatekey(FILETYPE_PEM, server_key_pem))
Jean-Paul Calderonea202edb2009-07-25 12:22:12 -04001758 root_cert = load_certificate(FILETYPE_PEM, root_cert_pem)
Rick Deanf94096c2009-07-18 14:23:06 -05001759 client_cert = load_certificate(FILETYPE_PEM, client_cert_pem)
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001760 p12.set_ca_certificates([root_cert]) # not a tuple
Rick Dean623ee362009-07-17 12:22:16 -05001761 self.assertEqual(1, len(p12.get_ca_certificates()))
1762 self.assertEqual(root_cert, p12.get_ca_certificates()[0])
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001763 p12.set_ca_certificates([client_cert, root_cert])
Rick Deanf94096c2009-07-18 14:23:06 -05001764 self.assertEqual(2, len(p12.get_ca_certificates()))
1765 self.assertEqual(client_cert, p12.get_ca_certificates()[0])
1766 self.assertEqual(root_cert, p12.get_ca_certificates()[1])
1767
1768
1769 def test_friendly_name(self):
1770 """
Jean-Paul Calderone64efa2c2011-09-11 10:00:09 -04001771 The *friendlyName* of a PKCS12 can be set and retrieved via
Jonathan Ballet648875f2011-07-16 14:14:58 +09001772 :py:obj:`PKCS12.get_friendlyname` and :py:obj:`PKCS12_set_friendlyname`, and a
1773 :py:obj:`PKCS12` with a friendly name set can be dumped with :py:obj:`PKCS12.export`.
Rick Deanf94096c2009-07-18 14:23:06 -05001774 """
Rick Deanf94096c2009-07-18 14:23:06 -05001775 passwd = 'Dogmeat[]{}!@#$%^&*()~`?/.,<>-_+=";:'
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001776 p12 = self.gen_pkcs12(server_cert_pem, server_key_pem, root_cert_pem)
Jean-Paul Calderoneadd7bf02010-08-22 17:38:30 -04001777 for friendly_name in [b('Serverlicious'), None, b('###')]:
Rick Dean42d69e12009-07-20 11:36:08 -05001778 p12.set_friendlyname(friendly_name)
1779 self.assertEqual(p12.get_friendlyname(), friendly_name)
Jean-Paul Calderonea202edb2009-07-25 12:22:12 -04001780 dumped_p12 = p12.export(passphrase=passwd, iter=2, maciter=3)
Rick Dean42d69e12009-07-20 11:36:08 -05001781 reloaded_p12 = load_pkcs12(dumped_p12, passwd)
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001782 self.assertEqual(
Jean-Paul Calderone9da338d2011-05-04 11:40:54 -04001783 p12.get_friendlyname(), reloaded_p12.get_friendlyname())
Jean-Paul Calderonea202edb2009-07-25 12:22:12 -04001784 # We would use the openssl program to confirm the friendly
1785 # name, but it is not possible. The pkcs12 command
1786 # does not store the friendly name in the cert's
Rick Dean42d69e12009-07-20 11:36:08 -05001787 # alias, which we could then extract.
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001788 self.check_recovery(
1789 dumped_p12, key=server_key_pem, cert=server_cert_pem,
1790 ca=root_cert_pem, passwd=passwd)
Rick Deanf94096c2009-07-18 14:23:06 -05001791
1792
1793 def test_various_empty_passphrases(self):
1794 """
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001795 Test that missing, None, and '' passphrases are identical for PKCS12
1796 export.
Rick Deanf94096c2009-07-18 14:23:06 -05001797 """
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001798 p12 = self.gen_pkcs12(client_cert_pem, client_key_pem, root_cert_pem)
Rick Dean623ee362009-07-17 12:22:16 -05001799 passwd = ''
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001800 dumped_p12_empty = p12.export(iter=2, maciter=0, passphrase=passwd)
1801 dumped_p12_none = p12.export(iter=3, maciter=2, passphrase=None)
1802 dumped_p12_nopw = p12.export(iter=9, maciter=4)
1803 for dumped_p12 in [dumped_p12_empty, dumped_p12_none, dumped_p12_nopw]:
1804 self.check_recovery(
1805 dumped_p12, key=client_key_pem, cert=client_cert_pem,
1806 ca=root_cert_pem, passwd=passwd)
Rick Deanf94096c2009-07-18 14:23:06 -05001807
1808
1809 def test_removing_ca_cert(self):
1810 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001811 Passing :py:obj:`None` to :py:obj:`PKCS12.set_ca_certificates` removes all CA
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001812 certificates.
Rick Deanf94096c2009-07-18 14:23:06 -05001813 """
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001814 p12 = self.gen_pkcs12(server_cert_pem, server_key_pem, root_cert_pem)
1815 p12.set_ca_certificates(None)
Rick Dean623ee362009-07-17 12:22:16 -05001816 self.assertEqual(None, p12.get_ca_certificates())
Rick Deanf94096c2009-07-18 14:23:06 -05001817
1818
1819 def test_export_without_mac(self):
1820 """
Jean-Paul Calderone64efa2c2011-09-11 10:00:09 -04001821 Exporting a PKCS12 with a :py:obj:`maciter` of ``-1`` excludes the MAC
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001822 entirely.
Rick Deanf94096c2009-07-18 14:23:06 -05001823 """
1824 passwd = 'Lake Michigan'
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001825 p12 = self.gen_pkcs12(server_cert_pem, server_key_pem, root_cert_pem)
Rick Dean623ee362009-07-17 12:22:16 -05001826 dumped_p12 = p12.export(maciter=-1, passphrase=passwd, iter=2)
Jean-Paul Calderone7426ed82009-07-25 21:19:23 -04001827 self.check_recovery(
1828 dumped_p12, key=server_key_pem, cert=server_cert_pem,
1829 passwd=passwd, extra=('-nomacver',))
1830
1831
1832 def test_load_without_mac(self):
1833 """
1834 Loading a PKCS12 without a MAC does something other than crash.
1835 """
1836 passwd = 'Lake Michigan'
1837 p12 = self.gen_pkcs12(server_cert_pem, server_key_pem, root_cert_pem)
1838 dumped_p12 = p12.export(maciter=-1, passphrase=passwd, iter=2)
Rick Dean321a0512009-08-13 17:21:29 -05001839 try:
1840 recovered_p12 = load_pkcs12(dumped_p12, passwd)
1841 # The person who generated this PCKS12 should be flogged,
1842 # or better yet we should have a means to determine
1843 # whether a PCKS12 had a MAC that was verified.
1844 # Anyway, libopenssl chooses to allow it, so the
1845 # pyopenssl binding does as well.
1846 self.assertTrue(isinstance(recovered_p12, PKCS12))
1847 except Error:
1848 # Failing here with an exception is preferred as some openssl
1849 # versions do.
1850 pass
Rick Dean623ee362009-07-17 12:22:16 -05001851
Jean-Paul Calderone38a646d2008-03-25 15:16:18 -04001852
Rick Dean25bcc1f2009-07-20 11:53:13 -05001853 def test_zero_len_list_for_ca(self):
1854 """
Jean-Paul Calderoneda1ffa72009-07-25 21:24:34 -04001855 A PKCS12 with an empty CA certificates list can be exported.
Rick Dean25bcc1f2009-07-20 11:53:13 -05001856 """
1857 passwd = 'Hobie 18'
Jean-Paul Calderoneda1ffa72009-07-25 21:24:34 -04001858 p12 = self.gen_pkcs12(server_cert_pem, server_key_pem)
1859 p12.set_ca_certificates([])
Rick Dean25bcc1f2009-07-20 11:53:13 -05001860 self.assertEqual((), p12.get_ca_certificates())
1861 dumped_p12 = p12.export(passphrase=passwd, iter=3)
Jean-Paul Calderoneda1ffa72009-07-25 21:24:34 -04001862 self.check_recovery(
1863 dumped_p12, key=server_key_pem, cert=server_cert_pem,
1864 passwd=passwd)
Rick Dean25bcc1f2009-07-20 11:53:13 -05001865
1866
Rick Deanf94096c2009-07-18 14:23:06 -05001867 def test_export_without_args(self):
Jean-Paul Calderone38a646d2008-03-25 15:16:18 -04001868 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001869 All the arguments to :py:obj:`PKCS12.export` are optional.
Jean-Paul Calderone38a646d2008-03-25 15:16:18 -04001870 """
Jean-Paul Calderoneda1ffa72009-07-25 21:24:34 -04001871 p12 = self.gen_pkcs12(server_cert_pem, server_key_pem, root_cert_pem)
Rick Deanf94096c2009-07-18 14:23:06 -05001872 dumped_p12 = p12.export() # no args
Jean-Paul Calderoneda1ffa72009-07-25 21:24:34 -04001873 self.check_recovery(
1874 dumped_p12, key=server_key_pem, cert=server_cert_pem, passwd='')
Rick Deanf94096c2009-07-18 14:23:06 -05001875
1876
1877 def test_key_cert_mismatch(self):
1878 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001879 :py:obj:`PKCS12.export` raises an exception when a key and certificate
Jean-Paul Calderoneda1ffa72009-07-25 21:24:34 -04001880 mismatch.
Rick Deanf94096c2009-07-18 14:23:06 -05001881 """
Jean-Paul Calderoneda1ffa72009-07-25 21:24:34 -04001882 p12 = self.gen_pkcs12(server_cert_pem, client_key_pem, root_cert_pem)
1883 self.assertRaises(Error, p12.export)
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04001884
1885
1886
Jean-Paul Calderone7b874db2009-08-27 12:32:47 -04001887# These quoting functions taken directly from Twisted's twisted.python.win32.
1888_cmdLineQuoteRe = re.compile(r'(\\*)"')
1889_cmdLineQuoteRe2 = re.compile(r'(\\+)\Z')
1890def cmdLineQuote(s):
1891 """
1892 Internal method for quoting a single command-line argument.
1893
Jean-Paul Calderone64efa2c2011-09-11 10:00:09 -04001894 See http://www.perlmonks.org/?node_id=764004
1895
Jonathan Ballet648875f2011-07-16 14:14:58 +09001896 :type: :py:obj:`str`
Jonathan Ballet78b92a22011-07-16 08:07:26 +09001897 :param s: A single unquoted string to quote for something that is expecting
Jean-Paul Calderone7b874db2009-08-27 12:32:47 -04001898 cmd.exe-style quoting
1899
Jonathan Ballet648875f2011-07-16 14:14:58 +09001900 :rtype: :py:obj:`str`
Jonathan Ballet78b92a22011-07-16 08:07:26 +09001901 :return: A cmd.exe-style quoted string
Jean-Paul Calderone7b874db2009-08-27 12:32:47 -04001902 """
1903 s = _cmdLineQuoteRe2.sub(r"\1\1", _cmdLineQuoteRe.sub(r'\1\1\\"', s))
1904 return '"%s"' % s
1905
1906
1907
1908def quoteArguments(arguments):
1909 """
1910 Quote an iterable of command-line arguments for passing to CreateProcess or
Jonathan Ballet648875f2011-07-16 14:14:58 +09001911 a similar API. This allows the list passed to :py:obj:`reactor.spawnProcess` to
1912 match the child process's :py:obj:`sys.argv` properly.
Jean-Paul Calderone7b874db2009-08-27 12:32:47 -04001913
Jonathan Ballet648875f2011-07-16 14:14:58 +09001914 :type arguments: :py:obj:`iterable` of :py:obj:`str`
Jonathan Ballet78b92a22011-07-16 08:07:26 +09001915 :param arguments: An iterable of unquoted arguments to quote
Jean-Paul Calderone7b874db2009-08-27 12:32:47 -04001916
Jonathan Ballet648875f2011-07-16 14:14:58 +09001917 :rtype: :py:obj:`str`
1918 :return: A space-delimited string containing quoted versions of :py:obj:`arguments`
Jean-Paul Calderone7b874db2009-08-27 12:32:47 -04001919 """
1920 return ' '.join(map(cmdLineQuote, arguments))
1921
1922
Jean-Paul Calderoneb98eae02010-01-30 13:18:04 -05001923
Rick Dean4c9ad612009-07-17 15:05:22 -05001924def _runopenssl(pem, *args):
1925 """
1926 Run the command line openssl tool with the given arguments and write
Rick Dean55d1ce62009-08-13 17:40:24 -05001927 the given PEM to its stdin. Not safe for quotes.
Rick Dean4c9ad612009-07-17 15:05:22 -05001928 """
Jean-Paul Calderone038de952009-08-21 12:16:06 -04001929 if os.name == 'posix':
Jean-Paul Calderone30a4cb32010-08-11 23:54:12 -04001930 command = "openssl " + " ".join([
1931 "'%s'" % (arg.replace("'", "'\\''"),) for arg in args])
Rick Dean55d1ce62009-08-13 17:40:24 -05001932 else:
Jean-Paul Calderone50924502009-08-27 12:47:55 -04001933 command = "openssl " + quoteArguments(args)
Jean-Paul Calderone30a4cb32010-08-11 23:54:12 -04001934 proc = Popen(command, shell=True, stdin=PIPE, stdout=PIPE)
Jean-Paul Calderone62ca8da2010-08-11 19:58:08 -04001935 proc.stdin.write(pem)
1936 proc.stdin.close()
1937 return proc.stdout.read()
Rick Dean4c9ad612009-07-17 15:05:22 -05001938
1939
1940
Jean-Paul Calderone18808652009-07-05 12:54:05 -04001941class FunctionTests(TestCase):
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04001942 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001943 Tests for free-functions in the :py:obj:`OpenSSL.crypto` module.
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04001944 """
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04001945
1946 def test_load_privatekey_invalid_format(self):
1947 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001948 :py:obj:`load_privatekey` raises :py:obj:`ValueError` if passed an unknown filetype.
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04001949 """
1950 self.assertRaises(ValueError, load_privatekey, 100, root_key_pem)
1951
1952
1953 def test_load_privatekey_invalid_passphrase_type(self):
1954 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001955 :py:obj:`load_privatekey` raises :py:obj:`TypeError` if passed a passphrase that is
Jean-Paul Calderone64efa2c2011-09-11 10:00:09 -04001956 neither a :py:obj:`str` nor a callable.
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04001957 """
1958 self.assertRaises(
1959 TypeError,
1960 load_privatekey,
1961 FILETYPE_PEM, encryptedPrivateKeyPEMPassphrase, object())
1962
1963
1964 def test_load_privatekey_wrong_args(self):
1965 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001966 :py:obj:`load_privatekey` raises :py:obj:`TypeError` if called with the wrong number
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04001967 of arguments.
1968 """
1969 self.assertRaises(TypeError, load_privatekey)
1970
1971
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04001972 def test_load_privatekey_wrongPassphrase(self):
1973 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001974 :py:obj:`load_privatekey` raises :py:obj:`OpenSSL.crypto.Error` when it is passed an
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04001975 encrypted PEM and an incorrect passphrase.
1976 """
1977 self.assertRaises(
1978 Error,
Jean-Paul Calderone5be230f2010-08-22 19:27:58 -04001979 load_privatekey, FILETYPE_PEM, encryptedPrivateKeyPEM, b("quack"))
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04001980
1981
Ziga Seilnacht376cf972009-12-22 16:04:10 +01001982 def test_load_privatekey_passphraseWrongType(self):
1983 """
Jean-Paul Calderone5d9d7f12011-09-14 09:48:58 -04001984 :py:obj:`load_privatekey` raises :py:obj:`ValueError` when it is passed a passphrase
Ziga Seilnacht376cf972009-12-22 16:04:10 +01001985 with a private key encoded in a format, that doesn't support
1986 encryption.
1987 """
1988 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
1989 blob = dump_privatekey(FILETYPE_ASN1, key)
1990 self.assertRaises(ValueError,
1991 load_privatekey, FILETYPE_ASN1, blob, "secret")
1992
1993
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04001994 def test_load_privatekey_passphrase(self):
1995 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09001996 :py:obj:`load_privatekey` can create a :py:obj:`PKey` object from an encrypted PEM
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04001997 string if given the passphrase.
1998 """
1999 key = load_privatekey(
2000 FILETYPE_PEM, encryptedPrivateKeyPEM,
2001 encryptedPrivateKeyPEMPassphrase)
2002 self.assertTrue(isinstance(key, PKeyType))
2003
2004
Ziga Seilnacht6b90a402009-12-22 14:33:47 +01002005 def test_load_privatekey_passphrase_exception(self):
2006 """
2007 If the passphrase callback raises an exception, that exception is raised
2008 by :py:obj:`load_privatekey`.
2009 """
2010 def cb(ignored):
2011 raise ArithmeticError
2012
2013 self.assertRaises(ArithmeticError,
2014 load_privatekey, FILETYPE_PEM, encryptedPrivateKeyPEM, cb)
2015
2016
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002017 def test_load_privatekey_wrongPassphraseCallback(self):
2018 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002019 :py:obj:`load_privatekey` raises :py:obj:`OpenSSL.crypto.Error` when it is passed an
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002020 encrypted PEM and a passphrase callback which returns an incorrect
2021 passphrase.
2022 """
2023 called = []
2024 def cb(*a):
2025 called.append(None)
2026 return "quack"
2027 self.assertRaises(
2028 Error,
2029 load_privatekey, FILETYPE_PEM, encryptedPrivateKeyPEM, cb)
2030 self.assertTrue(called)
2031
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002032
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002033 def test_load_privatekey_passphraseCallback(self):
2034 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002035 :py:obj:`load_privatekey` can create a :py:obj:`PKey` object from an encrypted PEM
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002036 string if given a passphrase callback which returns the correct
2037 password.
2038 """
2039 called = []
2040 def cb(writing):
2041 called.append(writing)
2042 return encryptedPrivateKeyPEMPassphrase
2043 key = load_privatekey(FILETYPE_PEM, encryptedPrivateKeyPEM, cb)
2044 self.assertTrue(isinstance(key, PKeyType))
2045 self.assertEqual(called, [False])
2046
2047
Jean-Paul Calderone105cb952011-09-14 10:16:46 -04002048 def test_load_privatekey_passphrase_wrong_return_type(self):
2049 """
2050 :py:obj:`load_privatekey` raises :py:obj:`ValueError` if the passphrase
2051 callback returns something other than a byte string.
2052 """
2053 self.assertRaises(
2054 ValueError,
2055 load_privatekey,
2056 FILETYPE_PEM, encryptedPrivateKeyPEM, lambda *args: 3)
2057
2058
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04002059 def test_dump_privatekey_wrong_args(self):
2060 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002061 :py:obj:`dump_privatekey` raises :py:obj:`TypeError` if called with the wrong number
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04002062 of arguments.
2063 """
2064 self.assertRaises(TypeError, dump_privatekey)
Jean-Paul Calderone1eeccd82011-09-14 10:18:52 -04002065 # If cipher name is given, password is required.
2066 self.assertRaises(
2067 ValueError, dump_privatekey, FILETYPE_PEM, PKey(), "foo")
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04002068
2069
2070 def test_dump_privatekey_unknown_cipher(self):
2071 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002072 :py:obj:`dump_privatekey` raises :py:obj:`ValueError` if called with an unrecognized
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04002073 cipher name.
2074 """
2075 key = PKey()
2076 key.generate_key(TYPE_RSA, 512)
2077 self.assertRaises(
2078 ValueError, dump_privatekey,
2079 FILETYPE_PEM, key, "zippers", "passphrase")
2080
2081
2082 def test_dump_privatekey_invalid_passphrase_type(self):
2083 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002084 :py:obj:`dump_privatekey` raises :py:obj:`TypeError` if called with a passphrase which
2085 is neither a :py:obj:`str` nor a callable.
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04002086 """
2087 key = PKey()
2088 key.generate_key(TYPE_RSA, 512)
2089 self.assertRaises(
2090 TypeError,
2091 dump_privatekey, FILETYPE_PEM, key, "blowfish", object())
2092
2093
2094 def test_dump_privatekey_invalid_filetype(self):
2095 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002096 :py:obj:`dump_privatekey` raises :py:obj:`ValueError` if called with an unrecognized
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04002097 filetype.
2098 """
2099 key = PKey()
2100 key.generate_key(TYPE_RSA, 512)
2101 self.assertRaises(ValueError, dump_privatekey, 100, key)
2102
2103
Ziga Seilnacht781295a2009-12-22 14:58:01 +01002104 def test_load_privatekey_passphraseCallbackLeak(self):
2105 """
Jean-Paul Calderone5d9d7f12011-09-14 09:48:58 -04002106 :py:obj:`crypto.load_privatekey` should not leak a reference to the
Ziga Seilnacht781295a2009-12-22 14:58:01 +01002107 passphrase when the passphrase is provided by a callback.
2108 """
2109 def cb(ignored):
2110 return encryptedPrivateKeyPEMPassphrase
2111
2112 startCount = sys.getrefcount(encryptedPrivateKeyPEMPassphrase)
2113 for i in range(100):
2114 load_privatekey(FILETYPE_PEM, encryptedPrivateKeyPEM, cb)
2115 endCount = sys.getrefcount(encryptedPrivateKeyPEMPassphrase)
2116 self.assert_(endCount - startCount < 5, endCount - startCount)
2117
2118
2119 def test_load_privatekey_passphraseCallbackLength(self):
2120 """
Jean-Paul Calderone5d9d7f12011-09-14 09:48:58 -04002121 :py:obj:`crypto.load_privatekey` should raise an error when the passphrase
Ziga Seilnacht781295a2009-12-22 14:58:01 +01002122 provided by the callback is too long, not silently truncate it.
2123 """
2124 def cb(ignored):
2125 return "a" * 1025
2126
2127 self.assertRaises(ValueError,
2128 load_privatekey, FILETYPE_PEM, encryptedPrivateKeyPEM, cb)
2129
2130
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002131 def test_dump_privatekey_passphrase(self):
2132 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002133 :py:obj:`dump_privatekey` writes an encrypted PEM when given a passphrase.
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002134 """
Jean-Paul Calderone5be230f2010-08-22 19:27:58 -04002135 passphrase = b("foo")
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002136 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
2137 pem = dump_privatekey(FILETYPE_PEM, key, "blowfish", passphrase)
Jean-Paul Calderone5be230f2010-08-22 19:27:58 -04002138 self.assertTrue(isinstance(pem, bytes))
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002139 loadedKey = load_privatekey(FILETYPE_PEM, pem, passphrase)
2140 self.assertTrue(isinstance(loadedKey, PKeyType))
2141 self.assertEqual(loadedKey.type(), key.type())
2142 self.assertEqual(loadedKey.bits(), key.bits())
2143
Jean-Paul Calderonef17e4212009-04-01 14:21:40 -04002144
Ziga Seilnacht376cf972009-12-22 16:04:10 +01002145 def test_dump_privatekey_passphraseWrongType(self):
2146 """
Jean-Paul Calderone5d9d7f12011-09-14 09:48:58 -04002147 :py:obj:`dump_privatekey` raises :py:obj:`ValueError` when it is passed a passphrase
Ziga Seilnacht376cf972009-12-22 16:04:10 +01002148 with a private key encoded in a format, that doesn't support
2149 encryption.
2150 """
2151 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
2152 self.assertRaises(ValueError,
2153 dump_privatekey, FILETYPE_ASN1, key, "blowfish", "secret")
2154
2155
Rick Dean5b7b6372009-04-01 11:34:06 -05002156 def test_dump_certificate(self):
2157 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002158 :py:obj:`dump_certificate` writes PEM, DER, and text.
Rick Dean5b7b6372009-04-01 11:34:06 -05002159 """
Jean-Paul Calderonef17e4212009-04-01 14:21:40 -04002160 pemData = cleartextCertificatePEM + cleartextPrivateKeyPEM
Rick Dean5b7b6372009-04-01 11:34:06 -05002161 cert = load_certificate(FILETYPE_PEM, pemData)
2162 dumped_pem = dump_certificate(FILETYPE_PEM, cert)
2163 self.assertEqual(dumped_pem, cleartextCertificatePEM)
2164 dumped_der = dump_certificate(FILETYPE_ASN1, cert)
Rick Dean4c9ad612009-07-17 15:05:22 -05002165 good_der = _runopenssl(dumped_pem, "x509", "-outform", "DER")
Rick Dean5b7b6372009-04-01 11:34:06 -05002166 self.assertEqual(dumped_der, good_der)
2167 cert2 = load_certificate(FILETYPE_ASN1, dumped_der)
2168 dumped_pem2 = dump_certificate(FILETYPE_PEM, cert2)
2169 self.assertEqual(dumped_pem2, cleartextCertificatePEM)
2170 dumped_text = dump_certificate(FILETYPE_TEXT, cert)
Rick Dean4c9ad612009-07-17 15:05:22 -05002171 good_text = _runopenssl(dumped_pem, "x509", "-noout", "-text")
Rick Dean5b7b6372009-04-01 11:34:06 -05002172 self.assertEqual(dumped_text, good_text)
2173
2174
2175 def test_dump_privatekey(self):
2176 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002177 :py:obj:`dump_privatekey` writes a PEM, DER, and text.
Rick Dean5b7b6372009-04-01 11:34:06 -05002178 """
2179 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
Jean-Paul Calderone8e6ce972009-05-13 12:32:49 -04002180 self.assertTrue(key.check())
Rick Dean5b7b6372009-04-01 11:34:06 -05002181 dumped_pem = dump_privatekey(FILETYPE_PEM, key)
2182 self.assertEqual(dumped_pem, cleartextPrivateKeyPEM)
2183 dumped_der = dump_privatekey(FILETYPE_ASN1, key)
Jean-Paul Calderonef17e4212009-04-01 14:21:40 -04002184 # XXX This OpenSSL call writes "writing RSA key" to standard out. Sad.
Rick Dean4c9ad612009-07-17 15:05:22 -05002185 good_der = _runopenssl(dumped_pem, "rsa", "-outform", "DER")
Rick Dean5b7b6372009-04-01 11:34:06 -05002186 self.assertEqual(dumped_der, good_der)
2187 key2 = load_privatekey(FILETYPE_ASN1, dumped_der)
2188 dumped_pem2 = dump_privatekey(FILETYPE_PEM, key2)
2189 self.assertEqual(dumped_pem2, cleartextPrivateKeyPEM)
2190 dumped_text = dump_privatekey(FILETYPE_TEXT, key)
Rick Dean4c9ad612009-07-17 15:05:22 -05002191 good_text = _runopenssl(dumped_pem, "rsa", "-noout", "-text")
Rick Dean5b7b6372009-04-01 11:34:06 -05002192 self.assertEqual(dumped_text, good_text)
2193
Jean-Paul Calderonef17e4212009-04-01 14:21:40 -04002194
Rick Dean5b7b6372009-04-01 11:34:06 -05002195 def test_dump_certificate_request(self):
2196 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002197 :py:obj:`dump_certificate_request` writes a PEM, DER, and text.
Rick Dean5b7b6372009-04-01 11:34:06 -05002198 """
2199 req = load_certificate_request(FILETYPE_PEM, cleartextCertificateRequestPEM)
2200 dumped_pem = dump_certificate_request(FILETYPE_PEM, req)
2201 self.assertEqual(dumped_pem, cleartextCertificateRequestPEM)
2202 dumped_der = dump_certificate_request(FILETYPE_ASN1, req)
Rick Dean4c9ad612009-07-17 15:05:22 -05002203 good_der = _runopenssl(dumped_pem, "req", "-outform", "DER")
Rick Dean5b7b6372009-04-01 11:34:06 -05002204 self.assertEqual(dumped_der, good_der)
2205 req2 = load_certificate_request(FILETYPE_ASN1, dumped_der)
2206 dumped_pem2 = dump_certificate_request(FILETYPE_PEM, req2)
2207 self.assertEqual(dumped_pem2, cleartextCertificateRequestPEM)
2208 dumped_text = dump_certificate_request(FILETYPE_TEXT, req)
Rick Dean4c9ad612009-07-17 15:05:22 -05002209 good_text = _runopenssl(dumped_pem, "req", "-noout", "-text")
Rick Dean5b7b6372009-04-01 11:34:06 -05002210 self.assertEqual(dumped_text, good_text)
Jean-Paul Calderoneaf43cdf2010-08-03 18:40:52 -04002211 self.assertRaises(ValueError, dump_certificate_request, 100, req)
Rick Dean5b7b6372009-04-01 11:34:06 -05002212
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002213
2214 def test_dump_privatekey_passphraseCallback(self):
2215 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002216 :py:obj:`dump_privatekey` writes an encrypted PEM when given a callback which
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002217 returns the correct passphrase.
2218 """
Jean-Paul Calderone5be230f2010-08-22 19:27:58 -04002219 passphrase = b("foo")
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002220 called = []
2221 def cb(writing):
2222 called.append(writing)
2223 return passphrase
2224 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
2225 pem = dump_privatekey(FILETYPE_PEM, key, "blowfish", cb)
Jean-Paul Calderone5be230f2010-08-22 19:27:58 -04002226 self.assertTrue(isinstance(pem, bytes))
Jean-Paul Calderone828c9cb2008-04-26 18:06:54 -04002227 self.assertEqual(called, [True])
2228 loadedKey = load_privatekey(FILETYPE_PEM, pem, passphrase)
2229 self.assertTrue(isinstance(loadedKey, PKeyType))
2230 self.assertEqual(loadedKey.type(), key.type())
2231 self.assertEqual(loadedKey.bits(), key.bits())
Rick Dean5b7b6372009-04-01 11:34:06 -05002232
2233
Ziga Seilnacht6b90a402009-12-22 14:33:47 +01002234 def test_dump_privatekey_passphrase_exception(self):
2235 """
Jean-Paul Calderone5d9d7f12011-09-14 09:48:58 -04002236 :py:obj:`dump_privatekey` should not overwrite the exception raised
Ziga Seilnacht6b90a402009-12-22 14:33:47 +01002237 by the passphrase callback.
2238 """
2239 def cb(ignored):
2240 raise ArithmeticError
2241
2242 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
2243 self.assertRaises(ArithmeticError,
2244 dump_privatekey, FILETYPE_PEM, key, "blowfish", cb)
2245
2246
Ziga Seilnacht781295a2009-12-22 14:58:01 +01002247 def test_dump_privatekey_passphraseCallbackLeak(self):
2248 """
Jean-Paul Calderone5d9d7f12011-09-14 09:48:58 -04002249 :py:obj:`crypto.dump_privatekey` should not leak a reference to the
Ziga Seilnacht781295a2009-12-22 14:58:01 +01002250 passphrase when the passphrase is provided by a callback.
2251 """
2252 def cb(ignored):
2253 return encryptedPrivateKeyPEMPassphrase
2254
2255 startCount = sys.getrefcount(encryptedPrivateKeyPEMPassphrase)
2256 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
2257 for i in range(100):
2258 dump_privatekey(FILETYPE_PEM, key, "blowfish", cb)
2259 endCount = sys.getrefcount(encryptedPrivateKeyPEMPassphrase)
2260 self.assert_(endCount - startCount < 5, endCount - startCount)
2261
2262
2263 def test_dump_privatekey_passphraseCallbackLength(self):
2264 """
Jean-Paul Calderone5d9d7f12011-09-14 09:48:58 -04002265 :py:obj:`crypto.dump_privatekey` should raise an error when the passphrase
Ziga Seilnacht781295a2009-12-22 14:58:01 +01002266 provided by the callback is too long, not silently truncate it.
2267 """
2268 def cb(ignored):
2269 return "a" * 1025
2270
2271 key = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
2272 self.assertRaises(ValueError,
2273 dump_privatekey, FILETYPE_PEM, key, "blowfish", cb)
2274
2275
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -04002276 def test_load_pkcs7_data(self):
2277 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002278 :py:obj:`load_pkcs7_data` accepts a PKCS#7 string and returns an instance of
2279 :py:obj:`PKCS7Type`.
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -04002280 """
2281 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2282 self.assertTrue(isinstance(pkcs7, PKCS7Type))
2283
2284
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -04002285
Jean-Paul Calderone68649052009-07-17 21:14:27 -04002286class PKCS7Tests(TestCase):
2287 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002288 Tests for :py:obj:`PKCS7Type`.
Jean-Paul Calderone68649052009-07-17 21:14:27 -04002289 """
2290 def test_type(self):
2291 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002292 :py:obj:`PKCS7Type` is a type object.
Jean-Paul Calderone68649052009-07-17 21:14:27 -04002293 """
2294 self.assertTrue(isinstance(PKCS7Type, type))
2295 self.assertEqual(PKCS7Type.__name__, 'PKCS7')
2296
2297 # XXX This doesn't currently work.
2298 # self.assertIdentical(PKCS7, PKCS7Type)
2299
2300
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04002301 # XXX Opposite results for all these following methods
2302
Jean-Paul Calderone07c93742010-07-30 10:53:41 -04002303 def test_type_is_signed_wrong_args(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002304 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002305 :py:obj:`PKCS7Type.type_is_signed` raises :py:obj:`TypeError` if called with any
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002306 arguments.
2307 """
Jean-Paul Calderone07c93742010-07-30 10:53:41 -04002308 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2309 self.assertRaises(TypeError, pkcs7.type_is_signed, None)
2310
2311
2312 def test_type_is_signed(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002313 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002314 :py:obj:`PKCS7Type.type_is_signed` returns :py:obj:`True` if the PKCS7 object is of
Jean-Paul Calderone64efa2c2011-09-11 10:00:09 -04002315 the type *signed*.
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002316 """
Jean-Paul Calderone07c93742010-07-30 10:53:41 -04002317 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2318 self.assertTrue(pkcs7.type_is_signed())
2319
2320
2321 def test_type_is_enveloped_wrong_args(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002322 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002323 :py:obj:`PKCS7Type.type_is_enveloped` raises :py:obj:`TypeError` if called with any
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002324 arguments.
2325 """
Jean-Paul Calderone07c93742010-07-30 10:53:41 -04002326 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2327 self.assertRaises(TypeError, pkcs7.type_is_enveloped, None)
2328
2329
2330 def test_type_is_enveloped(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002331 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002332 :py:obj:`PKCS7Type.type_is_enveloped` returns :py:obj:`False` if the PKCS7 object is
Jean-Paul Calderone64efa2c2011-09-11 10:00:09 -04002333 not of the type *enveloped*.
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002334 """
Jean-Paul Calderone07c93742010-07-30 10:53:41 -04002335 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2336 self.assertFalse(pkcs7.type_is_enveloped())
2337
2338
2339 def test_type_is_signedAndEnveloped_wrong_args(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002340 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002341 :py:obj:`PKCS7Type.type_is_signedAndEnveloped` raises :py:obj:`TypeError` if called
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002342 with any arguments.
2343 """
Jean-Paul Calderone07c93742010-07-30 10:53:41 -04002344 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2345 self.assertRaises(TypeError, pkcs7.type_is_signedAndEnveloped, None)
2346
2347
2348 def test_type_is_signedAndEnveloped(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002349 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002350 :py:obj:`PKCS7Type.type_is_signedAndEnveloped` returns :py:obj:`False` if the PKCS7
Jean-Paul Calderone64efa2c2011-09-11 10:00:09 -04002351 object is not of the type *signed and enveloped*.
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002352 """
Jean-Paul Calderone07c93742010-07-30 10:53:41 -04002353 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2354 self.assertFalse(pkcs7.type_is_signedAndEnveloped())
2355
2356
Jean-Paul Calderoneb4754b92010-07-30 11:00:08 -04002357 def test_type_is_data(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002358 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002359 :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 -04002360 the type data.
2361 """
Jean-Paul Calderoneb4754b92010-07-30 11:00:08 -04002362 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2363 self.assertFalse(pkcs7.type_is_data())
2364
2365
2366 def test_type_is_data_wrong_args(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002367 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002368 :py:obj:`PKCS7Type.type_is_data` raises :py:obj:`TypeError` if called with any
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002369 arguments.
2370 """
Jean-Paul Calderoneb4754b92010-07-30 11:00:08 -04002371 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2372 self.assertRaises(TypeError, pkcs7.type_is_data, None)
2373
2374
Jean-Paul Calderone97b28ca2010-07-30 10:56:07 -04002375 def test_get_type_name_wrong_args(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002376 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002377 :py:obj:`PKCS7Type.get_type_name` raises :py:obj:`TypeError` if called with any
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002378 arguments.
2379 """
Jean-Paul Calderone97b28ca2010-07-30 10:56:07 -04002380 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2381 self.assertRaises(TypeError, pkcs7.get_type_name, None)
2382
2383
Jean-Paul Calderone4cbe05e2010-07-30 10:55:30 -04002384 def test_get_type_name(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002385 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002386 :py:obj:`PKCS7Type.get_type_name` returns a :py:obj:`str` giving the type name.
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002387 """
Jean-Paul Calderone4cbe05e2010-07-30 10:55:30 -04002388 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
Jean-Paul Calderone07640f12010-08-22 17:14:43 -04002389 self.assertEquals(pkcs7.get_type_name(), b('pkcs7-signedData'))
Jean-Paul Calderone4cbe05e2010-07-30 10:55:30 -04002390
2391
2392 def test_attribute(self):
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002393 """
2394 If an attribute other than one of the methods tested here is accessed on
Jonathan Ballet648875f2011-07-16 14:14:58 +09002395 an instance of :py:obj:`PKCS7Type`, :py:obj:`AttributeError` is raised.
Jean-Paul Calderoneaa6c0692010-09-08 22:43:09 -04002396 """
Jean-Paul Calderone4cbe05e2010-07-30 10:55:30 -04002397 pkcs7 = load_pkcs7_data(FILETYPE_PEM, pkcs7Data)
2398 self.assertRaises(AttributeError, getattr, pkcs7, "foo")
2399
2400
Jean-Paul Calderone68649052009-07-17 21:14:27 -04002401
Jean-Paul Calderoneb9725592010-08-03 18:17:22 -04002402class NetscapeSPKITests(TestCase, _PKeyInteractionTestsMixin):
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -04002403 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002404 Tests for :py:obj:`OpenSSL.crypto.NetscapeSPKI`.
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -04002405 """
Jean-Paul Calderoneb9725592010-08-03 18:17:22 -04002406 def signable(self):
2407 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002408 Return a new :py:obj:`NetscapeSPKI` for use with signing tests.
Jean-Paul Calderoneb9725592010-08-03 18:17:22 -04002409 """
2410 return NetscapeSPKI()
2411
2412
Jean-Paul Calderone68649052009-07-17 21:14:27 -04002413 def test_type(self):
2414 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002415 :py:obj:`NetscapeSPKI` and :py:obj:`NetscapeSPKIType` refer to the same type object
Jean-Paul Calderone68649052009-07-17 21:14:27 -04002416 and can be used to create instances of that type.
2417 """
2418 self.assertIdentical(NetscapeSPKI, NetscapeSPKIType)
2419 self.assertConsistentType(NetscapeSPKI, 'NetscapeSPKI')
2420
2421
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -04002422 def test_construction(self):
2423 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002424 :py:obj:`NetscapeSPKI` returns an instance of :py:obj:`NetscapeSPKIType`.
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -04002425 """
2426 nspki = NetscapeSPKI()
2427 self.assertTrue(isinstance(nspki, NetscapeSPKIType))
2428
Jean-Paul Calderoneb9725592010-08-03 18:17:22 -04002429
Jean-Paul Calderone969efaa2010-08-03 18:19:19 -04002430 def test_invalid_attribute(self):
2431 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002432 Accessing a non-existent attribute of a :py:obj:`NetscapeSPKI` instance causes
2433 an :py:obj:`AttributeError` to be raised.
Jean-Paul Calderone969efaa2010-08-03 18:19:19 -04002434 """
2435 nspki = NetscapeSPKI()
2436 self.assertRaises(AttributeError, lambda: nspki.foo)
2437
Jean-Paul Calderonefe1b9bd2010-08-03 18:00:21 -04002438
Jean-Paul Calderone06ada9f2010-08-03 18:26:52 -04002439 def test_b64_encode(self):
2440 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002441 :py:obj:`NetscapeSPKI.b64_encode` encodes the certificate to a base64 blob.
Jean-Paul Calderone06ada9f2010-08-03 18:26:52 -04002442 """
2443 nspki = NetscapeSPKI()
2444 blob = nspki.b64_encode()
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002445 self.assertTrue(isinstance(blob, bytes))
Jean-Paul Calderone06ada9f2010-08-03 18:26:52 -04002446
2447
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -04002448
Rick Dean536ba022009-07-24 23:57:27 -05002449class RevokedTests(TestCase):
2450 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002451 Tests for :py:obj:`OpenSSL.crypto.Revoked`
Rick Dean536ba022009-07-24 23:57:27 -05002452 """
2453 def test_construction(self):
2454 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002455 Confirm we can create :py:obj:`OpenSSL.crypto.Revoked`. Check
Rick Dean536ba022009-07-24 23:57:27 -05002456 that it is empty.
2457 """
2458 revoked = Revoked()
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002459 self.assertTrue(isinstance(revoked, Revoked))
2460 self.assertEquals(type(revoked), Revoked)
2461 self.assertEquals(revoked.get_serial(), b('00'))
2462 self.assertEquals(revoked.get_rev_date(), None)
2463 self.assertEquals(revoked.get_reason(), None)
Rick Dean536ba022009-07-24 23:57:27 -05002464
2465
Jean-Paul Calderone4f74bfe2010-01-30 14:32:49 -05002466 def test_construction_wrong_args(self):
2467 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002468 Calling :py:obj:`OpenSSL.crypto.Revoked` with any arguments results
2469 in a :py:obj:`TypeError` being raised.
Jean-Paul Calderone4f74bfe2010-01-30 14:32:49 -05002470 """
2471 self.assertRaises(TypeError, Revoked, None)
2472 self.assertRaises(TypeError, Revoked, 1)
2473 self.assertRaises(TypeError, Revoked, "foo")
2474
2475
Rick Dean536ba022009-07-24 23:57:27 -05002476 def test_serial(self):
2477 """
Jean-Paul Calderoneb98eae02010-01-30 13:18:04 -05002478 Confirm we can set and get serial numbers from
Jonathan Ballet648875f2011-07-16 14:14:58 +09002479 :py:obj:`OpenSSL.crypto.Revoked`. Confirm errors are handled
Rick Dean536ba022009-07-24 23:57:27 -05002480 with grace.
2481 """
2482 revoked = Revoked()
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002483 ret = revoked.set_serial(b('10b'))
2484 self.assertEquals(ret, None)
Rick Dean536ba022009-07-24 23:57:27 -05002485 ser = revoked.get_serial()
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002486 self.assertEquals(ser, b('010B'))
Rick Dean536ba022009-07-24 23:57:27 -05002487
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002488 revoked.set_serial(b('31ppp')) # a type error would be nice
Rick Dean536ba022009-07-24 23:57:27 -05002489 ser = revoked.get_serial()
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002490 self.assertEquals(ser, b('31'))
Rick Dean536ba022009-07-24 23:57:27 -05002491
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002492 self.assertRaises(ValueError, revoked.set_serial, b('pqrst'))
Rick Dean536ba022009-07-24 23:57:27 -05002493 self.assertRaises(TypeError, revoked.set_serial, 100)
Jean-Paul Calderone4f74bfe2010-01-30 14:32:49 -05002494 self.assertRaises(TypeError, revoked.get_serial, 1)
2495 self.assertRaises(TypeError, revoked.get_serial, None)
2496 self.assertRaises(TypeError, revoked.get_serial, "")
Rick Dean536ba022009-07-24 23:57:27 -05002497
2498
2499 def test_date(self):
2500 """
Jean-Paul Calderoneb98eae02010-01-30 13:18:04 -05002501 Confirm we can set and get revocation dates from
Jonathan Ballet648875f2011-07-16 14:14:58 +09002502 :py:obj:`OpenSSL.crypto.Revoked`. Confirm errors are handled
Rick Dean536ba022009-07-24 23:57:27 -05002503 with grace.
2504 """
2505 revoked = Revoked()
2506 date = revoked.get_rev_date()
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002507 self.assertEquals(date, None)
Rick Dean536ba022009-07-24 23:57:27 -05002508
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002509 now = b(datetime.now().strftime("%Y%m%d%H%M%SZ"))
Rick Dean536ba022009-07-24 23:57:27 -05002510 ret = revoked.set_rev_date(now)
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002511 self.assertEqual(ret, None)
Rick Dean536ba022009-07-24 23:57:27 -05002512 date = revoked.get_rev_date()
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002513 self.assertEqual(date, now)
Rick Dean536ba022009-07-24 23:57:27 -05002514
2515
Rick Dean6385faf2009-07-26 00:07:47 -05002516 def test_reason(self):
2517 """
Jean-Paul Calderoneb98eae02010-01-30 13:18:04 -05002518 Confirm we can set and get revocation reasons from
Jonathan Ballet648875f2011-07-16 14:14:58 +09002519 :py:obj:`OpenSSL.crypto.Revoked`. The "get" need to work
Rick Dean6385faf2009-07-26 00:07:47 -05002520 as "set". Likewise, each reason of all_reasons() must work.
2521 """
2522 revoked = Revoked()
2523 for r in revoked.all_reasons():
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002524 for x in range(2):
Rick Dean6385faf2009-07-26 00:07:47 -05002525 ret = revoked.set_reason(r)
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002526 self.assertEquals(ret, None)
Rick Dean6385faf2009-07-26 00:07:47 -05002527 reason = revoked.get_reason()
Jean-Paul Calderoneeacad4a2010-08-22 17:12:55 -04002528 self.assertEquals(
2529 reason.lower().replace(b(' '), b('')),
2530 r.lower().replace(b(' '), b('')))
Rick Dean6385faf2009-07-26 00:07:47 -05002531 r = reason # again with the resp of get
2532
2533 revoked.set_reason(None)
2534 self.assertEqual(revoked.get_reason(), None)
2535
2536
Jean-Paul Calderone4f74bfe2010-01-30 14:32:49 -05002537 def test_set_reason_wrong_arguments(self):
Rick Dean6385faf2009-07-26 00:07:47 -05002538 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002539 Calling :py:obj:`OpenSSL.crypto.Revoked.set_reason` with other than
Jean-Paul Calderone4f74bfe2010-01-30 14:32:49 -05002540 one argument, or an argument which isn't a valid reason,
Jonathan Ballet648875f2011-07-16 14:14:58 +09002541 results in :py:obj:`TypeError` or :py:obj:`ValueError` being raised.
Rick Dean6385faf2009-07-26 00:07:47 -05002542 """
2543 revoked = Revoked()
2544 self.assertRaises(TypeError, revoked.set_reason, 100)
Jean-Paul Calderone281b62b2010-08-28 14:22:29 -04002545 self.assertRaises(ValueError, revoked.set_reason, b('blue'))
Rick Dean6385faf2009-07-26 00:07:47 -05002546
Rick Dean536ba022009-07-24 23:57:27 -05002547
Jean-Paul Calderone4f74bfe2010-01-30 14:32:49 -05002548 def test_get_reason_wrong_arguments(self):
2549 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002550 Calling :py:obj:`OpenSSL.crypto.Revoked.get_reason` with any
2551 arguments results in :py:obj:`TypeError` being raised.
Jean-Paul Calderone4f74bfe2010-01-30 14:32:49 -05002552 """
2553 revoked = Revoked()
2554 self.assertRaises(TypeError, revoked.get_reason, None)
2555 self.assertRaises(TypeError, revoked.get_reason, 1)
2556 self.assertRaises(TypeError, revoked.get_reason, "foo")
2557
2558
2559
Rick Dean536ba022009-07-24 23:57:27 -05002560class CRLTests(TestCase):
2561 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002562 Tests for :py:obj:`OpenSSL.crypto.CRL`
Rick Dean536ba022009-07-24 23:57:27 -05002563 """
2564 cert = load_certificate(FILETYPE_PEM, cleartextCertificatePEM)
2565 pkey = load_privatekey(FILETYPE_PEM, cleartextPrivateKeyPEM)
2566
2567 def test_construction(self):
2568 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002569 Confirm we can create :py:obj:`OpenSSL.crypto.CRL`. Check
Rick Dean536ba022009-07-24 23:57:27 -05002570 that it is empty
2571 """
2572 crl = CRL()
2573 self.assertTrue( isinstance(crl, CRL) )
2574 self.assertEqual(crl.get_revoked(), None)
2575
2576
Jean-Paul Calderone2efd03e2010-01-30 13:59:55 -05002577 def test_construction_wrong_args(self):
2578 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002579 Calling :py:obj:`OpenSSL.crypto.CRL` with any number of arguments
2580 results in a :py:obj:`TypeError` being raised.
Jean-Paul Calderone2efd03e2010-01-30 13:59:55 -05002581 """
2582 self.assertRaises(TypeError, CRL, 1)
2583 self.assertRaises(TypeError, CRL, "")
2584 self.assertRaises(TypeError, CRL, None)
2585
2586
Rick Dean536ba022009-07-24 23:57:27 -05002587 def test_export(self):
2588 """
2589 Use python to create a simple CRL with a revocation, and export
2590 the CRL in formats of PEM, DER and text. Those outputs are verified
2591 with the openssl program.
2592 """
2593 crl = CRL()
2594 revoked = Revoked()
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002595 now = b(datetime.now().strftime("%Y%m%d%H%M%SZ"))
Rick Dean536ba022009-07-24 23:57:27 -05002596 revoked.set_rev_date(now)
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002597 revoked.set_serial(b('3ab'))
2598 revoked.set_reason(b('sUpErSeDEd'))
Rick Dean536ba022009-07-24 23:57:27 -05002599 crl.add_revoked(revoked)
2600
2601 # PEM format
2602 dumped_crl = crl.export(self.cert, self.pkey, days=20)
2603 text = _runopenssl(dumped_crl, "crl", "-noout", "-text")
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002604 text.index(b('Serial Number: 03AB'))
2605 text.index(b('Superseded'))
2606 text.index(b('Issuer: /C=US/ST=IL/L=Chicago/O=Testing/CN=Testing Root CA'))
Rick Dean536ba022009-07-24 23:57:27 -05002607
2608 # DER format
2609 dumped_crl = crl.export(self.cert, self.pkey, FILETYPE_ASN1)
2610 text = _runopenssl(dumped_crl, "crl", "-noout", "-text", "-inform", "DER")
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002611 text.index(b('Serial Number: 03AB'))
2612 text.index(b('Superseded'))
2613 text.index(b('Issuer: /C=US/ST=IL/L=Chicago/O=Testing/CN=Testing Root CA'))
Rick Dean536ba022009-07-24 23:57:27 -05002614
2615 # text format
2616 dumped_text = crl.export(self.cert, self.pkey, type=FILETYPE_TEXT)
2617 self.assertEqual(text, dumped_text)
2618
2619
Jean-Paul Calderonec7293bc2011-09-13 15:24:38 -04002620 def test_export_invalid(self):
2621 """
2622 If :py:obj:`CRL.export` is used with an uninitialized :py:obj:`X509`
2623 instance, :py:obj:`ValueError` is raised.
2624 """
2625 crl = CRL()
2626 self.assertRaises(Error, crl.export, X509(), PKey())
2627
2628
Jean-Paul Calderone56515342010-01-30 13:49:38 -05002629 def test_add_revoked_keyword(self):
2630 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002631 :py:obj:`OpenSSL.CRL.add_revoked` accepts its single argument as the
Jean-Paul Calderone64efa2c2011-09-11 10:00:09 -04002632 ``revoked`` keyword argument.
Jean-Paul Calderone56515342010-01-30 13:49:38 -05002633 """
2634 crl = CRL()
2635 revoked = Revoked()
2636 crl.add_revoked(revoked=revoked)
2637 self.assertTrue(isinstance(crl.get_revoked()[0], Revoked))
2638
Rick Dean6385faf2009-07-26 00:07:47 -05002639
Jean-Paul Calderone883ca4b2010-01-30 13:55:13 -05002640 def test_export_wrong_args(self):
2641 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002642 Calling :py:obj:`OpenSSL.CRL.export` with fewer than two or more than
Jean-Paul Calderonef1515862010-01-30 13:57:03 -05002643 four arguments, or with arguments other than the certificate,
2644 private key, integer file type, and integer number of days it
Jonathan Ballet648875f2011-07-16 14:14:58 +09002645 expects, results in a :py:obj:`TypeError` being raised.
Jean-Paul Calderone883ca4b2010-01-30 13:55:13 -05002646 """
2647 crl = CRL()
2648 self.assertRaises(TypeError, crl.export)
2649 self.assertRaises(TypeError, crl.export, self.cert)
2650 self.assertRaises(TypeError, crl.export, self.cert, self.pkey, FILETYPE_PEM, 10, "foo")
2651
Jean-Paul Calderonef1515862010-01-30 13:57:03 -05002652 self.assertRaises(TypeError, crl.export, None, self.pkey, FILETYPE_PEM, 10)
2653 self.assertRaises(TypeError, crl.export, self.cert, None, FILETYPE_PEM, 10)
2654 self.assertRaises(TypeError, crl.export, self.cert, self.pkey, None, 10)
2655 self.assertRaises(TypeError, crl.export, self.cert, FILETYPE_PEM, None)
2656
Jean-Paul Calderone883ca4b2010-01-30 13:55:13 -05002657
Jean-Paul Calderoneea198422010-01-30 13:58:23 -05002658 def test_export_unknown_filetype(self):
2659 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002660 Calling :py:obj:`OpenSSL.CRL.export` with a file type other than
2661 :py:obj:`FILETYPE_PEM`, :py:obj:`FILETYPE_ASN1`, or :py:obj:`FILETYPE_TEXT` results
2662 in a :py:obj:`ValueError` being raised.
Jean-Paul Calderoneea198422010-01-30 13:58:23 -05002663 """
2664 crl = CRL()
2665 self.assertRaises(ValueError, crl.export, self.cert, self.pkey, 100, 10)
2666
2667
Rick Dean536ba022009-07-24 23:57:27 -05002668 def test_get_revoked(self):
2669 """
Jean-Paul Calderoneb98eae02010-01-30 13:18:04 -05002670 Use python to create a simple CRL with two revocations.
Jonathan Ballet648875f2011-07-16 14:14:58 +09002671 Get back the :py:obj:`Revoked` using :py:obj:`OpenSSL.CRL.get_revoked` and
Rick Dean536ba022009-07-24 23:57:27 -05002672 verify them.
2673 """
2674 crl = CRL()
2675
2676 revoked = Revoked()
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002677 now = b(datetime.now().strftime("%Y%m%d%H%M%SZ"))
Rick Dean536ba022009-07-24 23:57:27 -05002678 revoked.set_rev_date(now)
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002679 revoked.set_serial(b('3ab'))
Rick Dean536ba022009-07-24 23:57:27 -05002680 crl.add_revoked(revoked)
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002681 revoked.set_serial(b('100'))
2682 revoked.set_reason(b('sUpErSeDEd'))
Rick Dean536ba022009-07-24 23:57:27 -05002683 crl.add_revoked(revoked)
2684
2685 revs = crl.get_revoked()
2686 self.assertEqual(len(revs), 2)
2687 self.assertEqual(type(revs[0]), Revoked)
2688 self.assertEqual(type(revs[1]), Revoked)
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002689 self.assertEqual(revs[0].get_serial(), b('03AB'))
2690 self.assertEqual(revs[1].get_serial(), b('0100'))
Rick Dean536ba022009-07-24 23:57:27 -05002691 self.assertEqual(revs[0].get_rev_date(), now)
2692 self.assertEqual(revs[1].get_rev_date(), now)
2693
2694
Jean-Paul Calderone46bdce42010-01-30 13:44:16 -05002695 def test_get_revoked_wrong_args(self):
2696 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002697 Calling :py:obj:`OpenSSL.CRL.get_revoked` with any arguments results
2698 in a :py:obj:`TypeError` being raised.
Jean-Paul Calderone46bdce42010-01-30 13:44:16 -05002699 """
2700 crl = CRL()
2701 self.assertRaises(TypeError, crl.get_revoked, None)
2702 self.assertRaises(TypeError, crl.get_revoked, 1)
2703 self.assertRaises(TypeError, crl.get_revoked, "")
2704 self.assertRaises(TypeError, crl.get_revoked, "", 1, None)
2705
2706
Jean-Paul Calderoneecef6fa2010-01-30 13:47:18 -05002707 def test_add_revoked_wrong_args(self):
2708 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002709 Calling :py:obj:`OpenSSL.CRL.add_revoked` with other than one
2710 argument results in a :py:obj:`TypeError` being raised.
Jean-Paul Calderoneecef6fa2010-01-30 13:47:18 -05002711 """
2712 crl = CRL()
2713 self.assertRaises(TypeError, crl.add_revoked)
2714 self.assertRaises(TypeError, crl.add_revoked, 1, 2)
2715 self.assertRaises(TypeError, crl.add_revoked, "foo", "bar")
2716
2717
Rick Dean536ba022009-07-24 23:57:27 -05002718 def test_load_crl(self):
2719 """
2720 Load a known CRL and inspect its revocations. Both
2721 PEM and DER formats are loaded.
2722 """
Jean-Paul Calderone3eb5cc72010-01-30 15:24:40 -05002723 crl = load_crl(FILETYPE_PEM, crlData)
Rick Dean536ba022009-07-24 23:57:27 -05002724 revs = crl.get_revoked()
2725 self.assertEqual(len(revs), 2)
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002726 self.assertEqual(revs[0].get_serial(), b('03AB'))
Rick Dean6385faf2009-07-26 00:07:47 -05002727 self.assertEqual(revs[0].get_reason(), None)
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002728 self.assertEqual(revs[1].get_serial(), b('0100'))
2729 self.assertEqual(revs[1].get_reason(), b('Superseded'))
Rick Dean536ba022009-07-24 23:57:27 -05002730
Jean-Paul Calderone3eb5cc72010-01-30 15:24:40 -05002731 der = _runopenssl(crlData, "crl", "-outform", "DER")
Jean-Paul Calderoneb98eae02010-01-30 13:18:04 -05002732 crl = load_crl(FILETYPE_ASN1, der)
Rick Dean536ba022009-07-24 23:57:27 -05002733 revs = crl.get_revoked()
2734 self.assertEqual(len(revs), 2)
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002735 self.assertEqual(revs[0].get_serial(), b('03AB'))
Rick Dean6385faf2009-07-26 00:07:47 -05002736 self.assertEqual(revs[0].get_reason(), None)
Jean-Paul Calderoneb894fe12010-08-22 19:30:19 -04002737 self.assertEqual(revs[1].get_serial(), b('0100'))
2738 self.assertEqual(revs[1].get_reason(), b('Superseded'))
Rick Dean536ba022009-07-24 23:57:27 -05002739
2740
Jean-Paul Calderone3eb5cc72010-01-30 15:24:40 -05002741 def test_load_crl_wrong_args(self):
2742 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002743 Calling :py:obj:`OpenSSL.crypto.load_crl` with other than two
2744 arguments results in a :py:obj:`TypeError` being raised.
Jean-Paul Calderone3eb5cc72010-01-30 15:24:40 -05002745 """
2746 self.assertRaises(TypeError, load_crl)
2747 self.assertRaises(TypeError, load_crl, FILETYPE_PEM)
2748 self.assertRaises(TypeError, load_crl, FILETYPE_PEM, crlData, None)
2749
2750
2751 def test_load_crl_bad_filetype(self):
2752 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002753 Calling :py:obj:`OpenSSL.crypto.load_crl` with an unknown file type
2754 raises a :py:obj:`ValueError`.
Jean-Paul Calderone3eb5cc72010-01-30 15:24:40 -05002755 """
2756 self.assertRaises(ValueError, load_crl, 100, crlData)
2757
2758
2759 def test_load_crl_bad_data(self):
2760 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002761 Calling :py:obj:`OpenSSL.crypto.load_crl` with file data which can't
2762 be loaded raises a :py:obj:`OpenSSL.crypto.Error`.
Jean-Paul Calderone3eb5cc72010-01-30 15:24:40 -05002763 """
2764 self.assertRaises(Error, load_crl, FILETYPE_PEM, "hello, world")
2765
Jean-Paul Calderonedc138fa2009-06-27 14:32:07 -04002766
James Yonan7c2e5d32010-02-27 05:45:50 -07002767class SignVerifyTests(TestCase):
2768 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002769 Tests for :py:obj:`OpenSSL.crypto.sign` and :py:obj:`OpenSSL.crypto.verify`.
James Yonan7c2e5d32010-02-27 05:45:50 -07002770 """
2771 def test_sign_verify(self):
Jean-Paul Calderonef3cb9d82010-06-22 10:29:33 -04002772 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002773 :py:obj:`sign` generates a cryptographic signature which :py:obj:`verify` can check.
Jean-Paul Calderonef3cb9d82010-06-22 10:29:33 -04002774 """
Jean-Paul Calderoneea305c52010-08-28 14:41:07 -04002775 content = b(
Jean-Paul Calderoneb98ce212010-06-22 09:46:27 -04002776 "It was a bright cold day in April, and the clocks were striking "
2777 "thirteen. Winston Smith, his chin nuzzled into his breast in an "
2778 "effort to escape the vile wind, slipped quickly through the "
2779 "glass doors of Victory Mansions, though not quickly enough to "
2780 "prevent a swirl of gritty dust from entering along with him.")
2781
2782 # sign the content with this private key
Jean-Paul Calderonef3cb9d82010-06-22 10:29:33 -04002783 priv_key = load_privatekey(FILETYPE_PEM, root_key_pem)
Jean-Paul Calderoneb98ce212010-06-22 09:46:27 -04002784 # verify the content with this cert
2785 good_cert = load_certificate(FILETYPE_PEM, root_cert_pem)
2786 # certificate unrelated to priv_key, used to trigger an error
2787 bad_cert = load_certificate(FILETYPE_PEM, server_cert_pem)
James Yonan7c2e5d32010-02-27 05:45:50 -07002788
Jean-Paul Calderoned08feb02010-10-12 21:53:24 -04002789 for digest in ['md5', 'sha1']:
James Yonan7c2e5d32010-02-27 05:45:50 -07002790 sig = sign(priv_key, content, digest)
2791
2792 # Verify the signature of content, will throw an exception if error.
2793 verify(good_cert, sig, content, digest)
2794
2795 # This should fail because the certificate doesn't match the
2796 # private key that was used to sign the content.
2797 self.assertRaises(Error, verify, bad_cert, sig, content, digest)
2798
2799 # This should fail because we've "tainted" the content after
2800 # signing it.
Jean-Paul Calderoneea305c52010-08-28 14:41:07 -04002801 self.assertRaises(
2802 Error, verify,
2803 good_cert, sig, content + b("tainted"), digest)
James Yonan7c2e5d32010-02-27 05:45:50 -07002804
2805 # test that unknown digest types fail
Jean-Paul Calderoneea305c52010-08-28 14:41:07 -04002806 self.assertRaises(
Jean-Paul Calderone9538f142010-10-13 22:13:40 -04002807 ValueError, sign, priv_key, content, "strange-digest")
Jean-Paul Calderoneea305c52010-08-28 14:41:07 -04002808 self.assertRaises(
Jean-Paul Calderone9538f142010-10-13 22:13:40 -04002809 ValueError, verify, good_cert, sig, content, "strange-digest")
James Yonan7c2e5d32010-02-27 05:45:50 -07002810
Jean-Paul Calderoneb98ce212010-06-22 09:46:27 -04002811
Jean-Paul Calderone9828f662010-12-08 22:57:26 -05002812 def test_sign_nulls(self):
2813 """
Jonathan Ballet648875f2011-07-16 14:14:58 +09002814 :py:obj:`sign` produces a signature for a string with embedded nulls.
Jean-Paul Calderone9828f662010-12-08 22:57:26 -05002815 """
2816 content = b("Watch out! \0 Did you see it?")
2817 priv_key = load_privatekey(FILETYPE_PEM, root_key_pem)
2818 good_cert = load_certificate(FILETYPE_PEM, root_cert_pem)
2819 sig = sign(priv_key, content, "sha1")
2820 verify(good_cert, sig, content, "sha1")
2821
2822
Rick Dean5b7b6372009-04-01 11:34:06 -05002823if __name__ == '__main__':
2824 main()