blob: f056a7278f340e9d9793cf71818ca611673aa111 [file] [log] [blame]
Alex Gaynor4af5b372015-07-12 10:30:59 -05001X.509 Reference
2===============
Paul Kehrer016e08a2014-11-26 09:41:18 -10003
Paul Kehrera9d78c12014-11-26 10:59:03 -10004.. currentmodule:: cryptography.x509
Paul Kehrer016e08a2014-11-26 09:41:18 -10005
Paul Kehrerd26c4db2015-03-15 15:36:24 -05006.. testsetup::
7
Erik Trauschkedc570402015-09-24 20:24:28 -07008 pem_crl_data = b"""
9 -----BEGIN X509 CRL-----
10 MIIBtDCBnQIBAjANBgkqhkiG9w0BAQsFADAnMQswCQYDVQQGEwJVUzEYMBYGA1UE
11 AwwPY3J5cHRvZ3JhcGh5LmlvGA8yMDE1MDEwMTAwMDAwMFoYDzIwMTYwMTAxMDAw
12 MDAwWjA+MDwCAQAYDzIwMTUwMTAxMDAwMDAwWjAmMBgGA1UdGAQRGA8yMDE1MDEw
13 MTAwMDAwMFowCgYDVR0VBAMKAQEwDQYJKoZIhvcNAQELBQADggEBABRA4ww50Lz5
14 zk1j2+aluC4HPHqb7o06h4pTDcCGeXUKXIGeP5ntGGmIoxa26sNoLeOr8+5b43Gf
15 yWraHertllOwaOpNFEe+YZFaE9femtoDbf+GLMvRx/0wDfd3KxPoXnXKMXb2d1w4
16 RCLgmkYx6JyvS+5ciuLQVIKC+l7jwIUeZFLJMUJ8msM4pFYoGameeZmtjMbd/TNg
17 cVBfmZxNMHuLladJxvSo2esARo0TYPhYsgrREKoHwhpzSxdynjn4bOVkILfguwsN
18 qtEEMZFEv5Kb0GqRp2+Iagv2S6dg9JGvxVdsoGjaB6EbYSZ3Psx4aODasIn11uwo
19 X4B9vUQNXqc=
20 -----END X509 CRL-----
21 """.strip()
22
Paul Kehrerd26c4db2015-03-15 15:36:24 -050023 pem_req_data = b"""
24 -----BEGIN CERTIFICATE REQUEST-----
25 MIIC0zCCAbsCAQAwWTELMAkGA1UEBhMCVVMxETAPBgNVBAgMCElsbGlub2lzMRAw
26 DgYDVQQHDAdDaGljYWdvMREwDwYDVQQKDAhyNTA5IExMQzESMBAGA1UEAwwJaGVs
27 bG8uY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqhZx+Mo9VRd9
28 vsnWWa6NBCws21rZ0+1B/JGgB4hDsZS7iDE4Bj5z4idheFRtl8bBbdjPknq7BfoF
29 8v15Zq/Zv7i2xMSDL+LUrTBZezRd4bRTGqCm6YJ5EYkhqdcqeZleHCFImguHoq1J
30 Fh0+kObQrTHXw3ZP57a3o1IvyIUA3nNoCBL0QQhwBXaDXOojMKNR+bqB5ve8GS1y
31 Elr0AM/+cJsfaIahNQUgFKx3Eu3GeEOMKYOAG1lycgdQdmTUybLrT3U7vkClTseM
32 xHg1r5En7ALjONIhqRuq3rddYahrP8HXozb3zUy3cJ7P6IeaosuvNzvMXOX9P6HD
33 Ha9urDAJ1wIDAQABoDUwMwYJKoZIhvcNAQkOMSYwJDAiBgNVHREEGzAZggl3b3Js
34 ZC5jb22CDHdoYXRldmVyLmNvbTANBgkqhkiG9w0BAQUFAAOCAQEAS4Ro6h+z52SK
35 YSLCYARpnEu/rmh4jdqndt8naqcNb6uLx9mlKZ2W9on9XDjnSdQD9q+ZP5aZfESw
36 R0+rJhW9ZrNa/g1pt6M24ihclHYDAxYMWxT1z/TXXGM3TmZZ6gfYlNE1kkBuODHa
37 UYsR/1Ht1E1EsmmUimt2n+zQR2K8T9Coa+boaUW/GsTEuz1aaJAkj5ZvTDiIhRG4
38 AOCqFZOLAQmCCNgJnnspD9hDz/Ons085LF5wnYjN4/Nsk5tS6AGs3xjZ3jPoOGGn
39 82WQ9m4dBGoVDZXsobVTaN592JEYwN5iu72zRn7Einb4V4H5y3yD2dD4yWPlt4pk
40 5wFkeYsZEA==
41 -----END CERTIFICATE REQUEST-----
42 """.strip()
43
Paul Kehrerd3dafbd2015-03-15 16:24:18 -050044 pem_data = b"""
45 -----BEGIN CERTIFICATE-----
46 MIIDfDCCAmSgAwIBAgIBAjANBgkqhkiG9w0BAQsFADBFMQswCQYDVQQGEwJVUzEf
47 MB0GA1UEChMWVGVzdCBDZXJ0aWZpY2F0ZXMgMjAxMTEVMBMGA1UEAxMMVHJ1c3Qg
48 QW5jaG9yMB4XDTEwMDEwMTA4MzAwMFoXDTMwMTIzMTA4MzAwMFowQDELMAkGA1UE
49 BhMCVVMxHzAdBgNVBAoTFlRlc3QgQ2VydGlmaWNhdGVzIDIwMTExEDAOBgNVBAMT
50 B0dvb2QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCQWJpHYo37
51 Xfb7oJSPe+WvfTlzIG21WQ7MyMbGtK/m8mejCzR6c+f/pJhEH/OcDSMsXq8h5kXa
52 BGqWK+vSwD/Pzp5OYGptXmGPcthDtAwlrafkGOS4GqIJ8+k9XGKs+vQUXJKsOk47
53 RuzD6PZupq4s16xaLVqYbUC26UcY08GpnoLNHJZS/EmXw1ZZ3d4YZjNlpIpWFNHn
54 UGmdiGKXUPX/9H0fVjIAaQwjnGAbpgyCumWgzIwPpX+ElFOUr3z7BoVnFKhIXze+
55 VmQGSWxZxvWDUN90Ul0tLEpLgk3OVxUB4VUGuf15OJOpgo1xibINPmWt14Vda2N9
56 yrNKloJGZNqLAgMBAAGjfDB6MB8GA1UdIwQYMBaAFOR9X9FclYYILAWuvnW2ZafZ
57 XahmMB0GA1UdDgQWBBRYAYQkG7wrUpRKPaUQchRR9a86yTAOBgNVHQ8BAf8EBAMC
58 AQYwFwYDVR0gBBAwDjAMBgpghkgBZQMCATABMA8GA1UdEwEB/wQFMAMBAf8wDQYJ
59 KoZIhvcNAQELBQADggEBADWHlxbmdTXNwBL/llwhQqwnazK7CC2WsXBBqgNPWj7m
60 tvQ+aLG8/50Qc2Sun7o2VnwF9D18UUe8Gj3uPUYH+oSI1vDdyKcjmMbKRU4rk0eo
61 3UHNDXwqIVc9CQS9smyV+x1HCwL4TTrq+LXLKx/qVij0Yqk+UJfAtrg2jnYKXsCu
62 FMBQQnWCGrwa1g1TphRp/RmYHnMynYFmZrXtzFz+U9XEA7C+gPq4kqDI/iVfIT1s
63 6lBtdB50lrDVwl2oYfAvW/6sC2se2QleZidUmrziVNP4oEeXINokU6T6p//HM1FG
64 QYw2jOvpKcKtWCSAnegEbgsGYzATKjmPJPJ0npHFqzM=
65 -----END CERTIFICATE-----
66 """.strip()
67
Paul Kehrer93ae8052015-05-02 23:18:09 -050068 cryptography_cert_pem = b"""
69 -----BEGIN CERTIFICATE-----
70 MIIFvTCCBKWgAwIBAgICPyAwDQYJKoZIhvcNAQELBQAwRzELMAkGA1UEBhMCVVMx
71 FjAUBgNVBAoTDUdlb1RydXN0IEluYy4xIDAeBgNVBAMTF1JhcGlkU1NMIFNIQTI1
72 NiBDQSAtIEczMB4XDTE0MTAxNTEyMDkzMloXDTE4MTExNjAxMTUwM1owgZcxEzAR
73 BgNVBAsTCkdUNDg3NDI5NjUxMTAvBgNVBAsTKFNlZSB3d3cucmFwaWRzc2wuY29t
74 L3Jlc291cmNlcy9jcHMgKGMpMTQxLzAtBgNVBAsTJkRvbWFpbiBDb250cm9sIFZh
75 bGlkYXRlZCAtIFJhcGlkU1NMKFIpMRwwGgYDVQQDExN3d3cuY3J5cHRvZ3JhcGh5
76 LmlvMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAom/FebKJIot7Sp3s
77 itG1sicpe3thCssjI+g1JDAS7I3GLVNmbms1DOdIIqwf01gZkzzXBN2+9sOnyRaR
78 PPfCe1jTr3dk2y6rPE559vPa1nZQkhlzlhMhlPyjaT+S7g4Tio4qV2sCBZU01DZJ
79 CaksfohN+5BNVWoJzTbOcrHOEJ+M8B484KlBCiSxqf9cyNQKru4W3bHaCVNVJ8eu
80 6i6KyhzLa0L7yK3LXwwXVs583C0/vwFhccGWsFODqD/9xHUzsBIshE8HKjdjDi7Y
81 3BFQzVUQFjBB50NSZfAA/jcdt1blxJouc7z9T8Oklh+V5DDBowgAsrT4b6Z2Fq6/
82 r7D1GqivLK/ypUQmxq2WXWAUBb/Q6xHgxASxI4Br+CByIUQJsm8L2jzc7k+mF4hW
83 ltAIUkbo8fGiVnat0505YJgxWEDKOLc4Gda6d/7GVd5AvKrz242bUqeaWo6e4MTx
84 diku2Ma3rhdcr044Qvfh9hGyjqNjvhWY/I+VRWgihU7JrYvgwFdJqsQ5eiKT4OHi
85 gsejvWwkZzDtiQ+aQTrzM1FsY2swJBJsLSX4ofohlVRlIJCn/ME+XErj553431Lu
86 YQ5SzMd3nXzN78Vj6qzTfMUUY72UoT1/AcFiUMobgIqrrmwuNxfrkbVE2b6Bga74
87 FsJX63prvrJ41kuHK/16RQBM7fcCAwEAAaOCAWAwggFcMB8GA1UdIwQYMBaAFMOc
88 8/zTRgg0u85Gf6B8W/PiCMtZMFcGCCsGAQUFBwEBBEswSTAfBggrBgEFBQcwAYYT
89 aHR0cDovL2d2LnN5bWNkLmNvbTAmBggrBgEFBQcwAoYaaHR0cDovL2d2LnN5bWNi
90 LmNvbS9ndi5jcnQwDgYDVR0PAQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMB
91 BggrBgEFBQcDAjAvBgNVHREEKDAmghN3d3cuY3J5cHRvZ3JhcGh5Lmlvgg9jcnlw
92 dG9ncmFwaHkuaW8wKwYDVR0fBCQwIjAgoB6gHIYaaHR0cDovL2d2LnN5bWNiLmNv
93 bS9ndi5jcmwwDAYDVR0TAQH/BAIwADBFBgNVHSAEPjA8MDoGCmCGSAGG+EUBBzYw
94 LDAqBggrBgEFBQcCARYeaHR0cHM6Ly93d3cucmFwaWRzc2wuY29tL2xlZ2FsMA0G
95 CSqGSIb3DQEBCwUAA4IBAQAzIYO2jx7h17FBT74tJ2zbV9OKqGb7QF8y3wUtP4xc
96 dH80vprI/Cfji8s86kr77aAvAqjDjaVjHn7UzebhSUivvRPmfzRgyWBacomnXTSt
97 Xlt2dp2nDQuwGyK2vB7dMfKnQAkxwq1sYUXznB8i0IhhCAoXp01QGPKq51YoIlnF
98 7DRMk6iEaL1SJbkIrLsCQyZFDf0xtfW9DqXugMMLoxeCsBhZJQzNyS2ryirrv9LH
99 aK3+6IZjrcyy9bkpz/gzJucyhU+75c4My/mnRCrtItRbCQuiI5pd5poDowm+HH9i
100 GVI9+0lAFwxOUnOnwsoI40iOoxjLMGB+CgFLKCGUcWxP
101 -----END CERTIFICATE-----
102 """.strip()
103
Paul Kehrerb2de9482014-12-11 14:54:48 -0600104Loading Certificates
105~~~~~~~~~~~~~~~~~~~~
Paul Kehrer016e08a2014-11-26 09:41:18 -1000106
107.. function:: load_pem_x509_certificate(data, backend)
108
109 .. versionadded:: 0.7
110
Paul Kehrere76cd272014-12-14 19:00:51 -0600111 Deserialize a certificate from PEM encoded data. PEM certificates are
112 base64 decoded and have delimiters that look like
113 ``-----BEGIN CERTIFICATE-----``.
Paul Kehrer016e08a2014-11-26 09:41:18 -1000114
115 :param bytes data: The PEM encoded certificate data.
116
117 :param backend: A backend supporting the
118 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
119 interface.
120
Paul Kehrere76cd272014-12-14 19:00:51 -0600121 :returns: An instance of :class:`~cryptography.x509.Certificate`.
Paul Kehrer016e08a2014-11-26 09:41:18 -1000122
123.. function:: load_der_x509_certificate(data, backend)
124
125 .. versionadded:: 0.7
126
Paul Kehrere76cd272014-12-14 19:00:51 -0600127 Deserialize a certificate from DER encoded data. DER is a binary format
Paul Kehrer92aac382014-12-15 16:25:28 -0600128 and is commonly found in files with the ``.cer`` extension (although file
129 extensions are not a guarantee of encoding type).
Paul Kehrer016e08a2014-11-26 09:41:18 -1000130
131 :param bytes data: The DER encoded certificate data.
132
133 :param backend: A backend supporting the
134 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
135 interface.
136
Paul Kehrere76cd272014-12-14 19:00:51 -0600137 :returns: An instance of :class:`~cryptography.x509.Certificate`.
Paul Kehrer016e08a2014-11-26 09:41:18 -1000138
Paul Kehrer016e08a2014-11-26 09:41:18 -1000139.. doctest::
140
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600141 >>> from cryptography import x509
Paul Kehrer016e08a2014-11-26 09:41:18 -1000142 >>> from cryptography.hazmat.backends import default_backend
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600143 >>> cert = x509.load_pem_x509_certificate(pem_data, default_backend())
Paul Kehrer016e08a2014-11-26 09:41:18 -1000144 >>> cert.serial
145 2
146
Erik Trauschkedc570402015-09-24 20:24:28 -0700147Loading Certificate Revocation Lists
148~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
149
150.. function:: load_pem_x509_crl(data, backend)
151
152 .. versionadded:: 1.1
153
154 Deserialize a certificate revocation list (CRL) from PEM encoded data. PEM
155 requests are base64 decoded and have delimiters that look like
Erik Trauschke32bbfe02015-10-21 08:04:55 -0700156 ``-----BEGIN X509 CRL-----``.
Erik Trauschkedc570402015-09-24 20:24:28 -0700157
158 :param bytes data: The PEM encoded request data.
159
160 :param backend: A backend supporting the
161 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
162 interface.
163
164 :returns: An instance of
165 :class:`~cryptography.x509.CertificateRevocationList`.
166
167.. function:: load_der_x509_crl(data, backend)
168
169 .. versionadded:: 1.1
170
171 Deserialize a certificate revocation list (CRL) from DER encoded data. DER
172 is a binary format.
173
174 :param bytes data: The DER encoded request data.
175
176 :param backend: A backend supporting the
177 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
178 interface.
179
180 :returns: An instance of
181 :class:`~cryptography.x509.CertificateRevocationList`.
182
183.. doctest::
184
185 >>> from cryptography import x509
186 >>> from cryptography.hazmat.backends import default_backend
187 >>> from cryptography.hazmat.primitives import hashes
188 >>> crl = x509.load_pem_x509_crl(pem_crl_data, default_backend())
189 >>> isinstance(crl.signature_hash_algorithm, hashes.SHA256)
190 True
191
Paul Kehrera1a1f232015-03-15 15:34:35 -0500192Loading Certificate Signing Requests
193~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600194
Paul Kehrer31e39882015-03-11 11:37:04 -0500195.. function:: load_pem_x509_csr(data, backend)
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600196
197 .. versionadded:: 0.9
198
Paul Kehrera1a1f232015-03-15 15:34:35 -0500199 Deserialize a certificate signing request (CSR) from PEM encoded data. PEM
Paul Kehrer5aadb9c2015-03-11 20:48:42 -0500200 requests are base64 decoded and have delimiters that look like
Paul Kehrerd3dafbd2015-03-15 16:24:18 -0500201 ``-----BEGIN CERTIFICATE REQUEST-----``. This format is also known as
202 PKCS#10.
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600203
204 :param bytes data: The PEM encoded request data.
205
206 :param backend: A backend supporting the
207 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
208 interface.
209
Paul Kehrera1a1f232015-03-15 15:34:35 -0500210 :returns: An instance of
211 :class:`~cryptography.x509.CertificateSigningRequest`.
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600212
Paul Kehrer1effb6e2015-03-30 15:05:59 -0500213.. function:: load_der_x509_csr(data, backend)
214
215 .. versionadded:: 0.9
216
217 Deserialize a certificate signing request (CSR) from DER encoded data. DER
218 is a binary format and is not commonly used with CSRs.
219
220 :param bytes data: The DER encoded request data.
221
222 :param backend: A backend supporting the
223 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
224 interface.
225
226 :returns: An instance of
227 :class:`~cryptography.x509.CertificateSigningRequest`.
228
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600229.. doctest::
230
231 >>> from cryptography import x509
232 >>> from cryptography.hazmat.backends import default_backend
233 >>> from cryptography.hazmat.primitives import hashes
Paul Kehrera1a1f232015-03-15 15:34:35 -0500234 >>> csr = x509.load_pem_x509_csr(pem_req_data, default_backend())
235 >>> isinstance(csr.signature_hash_algorithm, hashes.SHA1)
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600236 True
237
Paul Kehrere76cd272014-12-14 19:00:51 -0600238X.509 Certificate Object
239~~~~~~~~~~~~~~~~~~~~~~~~
Paul Kehrerb2de9482014-12-11 14:54:48 -0600240
Paul Kehrere76cd272014-12-14 19:00:51 -0600241.. class:: Certificate
Paul Kehrerb2de9482014-12-11 14:54:48 -0600242
243 .. versionadded:: 0.7
244
245 .. attribute:: version
246
Paul Kehrere76cd272014-12-14 19:00:51 -0600247 :type: :class:`~cryptography.x509.Version`
Paul Kehrerb2de9482014-12-11 14:54:48 -0600248
Paul Kehrere76cd272014-12-14 19:00:51 -0600249 The certificate version as an enumeration. Version 3 certificates are
250 the latest version and also the only type you should see in practice.
Paul Kehrerb2de9482014-12-11 14:54:48 -0600251
Alex Gaynor89c4dc82014-12-16 16:49:33 -0800252 :raises cryptography.x509.InvalidVersion: If the version in the
Alex Gaynor6d7ab4c2014-12-16 16:50:33 -0800253 certificate is not a known
254 :class:`X.509 version <cryptography.x509.Version>`.
Paul Kehrer92aac382014-12-15 16:25:28 -0600255
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600256 .. doctest::
257
258 >>> cert.version
259 <Version.v3: 2>
260
Paul Kehrerb2de9482014-12-11 14:54:48 -0600261 .. method:: fingerprint(algorithm)
262
263 :param algorithm: The
Paul Kehrer601278a2015-02-12 12:51:00 -0600264 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
Paul Kehrerb2de9482014-12-11 14:54:48 -0600265 that will be used to generate the fingerprint.
266
Erik Trauschke2dcce902015-05-14 16:12:24 -0700267 :return bytes: The fingerprint using the supplied hash algorithm, as
Paul Kehrerb2de9482014-12-11 14:54:48 -0600268 bytes.
269
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600270 .. doctest::
271
272 >>> from cryptography.hazmat.primitives import hashes
273 >>> cert.fingerprint(hashes.SHA256())
Paul Kehrer78a81502014-12-16 14:47:52 -0600274 '\x86\xd2\x187Gc\xfc\xe7}[+E9\x8d\xb4\x8f\x10\xe5S\xda\x18u\xbe}a\x03\x08[\xac\xa04?'
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600275
Paul Kehrerb2de9482014-12-11 14:54:48 -0600276 .. attribute:: serial
277
278 :type: int
279
280 The serial as a Python integer.
281
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600282 .. doctest::
283
284 >>> cert.serial
285 2
286
Paul Kehrerb2de9482014-12-11 14:54:48 -0600287 .. method:: public_key()
288
Alex Gaynor4c2561a2015-10-12 23:53:39 -0400289 The public key associated with the certificate.
290
291 :returns:
Alex Stapletonf79c2312014-12-30 12:50:14 +0000292 :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey` or
Paul Kehrer45efdbc2015-02-12 10:58:22 -0600293 :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey` or
294 :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey`
Paul Kehrerb2de9482014-12-11 14:54:48 -0600295
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600296 .. doctest::
297
Alex Stapletonf79c2312014-12-30 12:50:14 +0000298 >>> from cryptography.hazmat.primitives.asymmetric import rsa
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600299 >>> public_key = cert.public_key()
Alex Stapletonf79c2312014-12-30 12:50:14 +0000300 >>> isinstance(public_key, rsa.RSAPublicKey)
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600301 True
302
Paul Kehrerb2de9482014-12-11 14:54:48 -0600303 .. attribute:: not_valid_before
304
305 :type: :class:`datetime.datetime`
306
Paul Kehrer78a81502014-12-16 14:47:52 -0600307 A naïve datetime representing the beginning of the validity period for
308 the certificate in UTC. This value is inclusive.
Paul Kehrerb2de9482014-12-11 14:54:48 -0600309
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600310 .. doctest::
311
312 >>> cert.not_valid_before
313 datetime.datetime(2010, 1, 1, 8, 30)
314
Paul Kehrerb2de9482014-12-11 14:54:48 -0600315 .. attribute:: not_valid_after
316
317 :type: :class:`datetime.datetime`
318
Paul Kehrer78a81502014-12-16 14:47:52 -0600319 A naïve datetime representing the end of the validity period for the
320 certificate in UTC. This value is inclusive.
Paul Kehrerb2de9482014-12-11 14:54:48 -0600321
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600322 .. doctest::
323
324 >>> cert.not_valid_after
325 datetime.datetime(2030, 12, 31, 8, 30)
326
Paul Kehrer719d5362015-01-01 20:03:52 -0600327 .. attribute:: issuer
328
329 .. versionadded:: 0.8
330
331 :type: :class:`Name`
332
333 The :class:`Name` of the issuer.
334
335 .. attribute:: subject
336
337 .. versionadded:: 0.8
338
339 :type: :class:`Name`
340
341 The :class:`Name` of the subject.
342
Paul Kehrer8802a5b2015-02-13 12:06:57 -0600343 .. attribute:: signature_hash_algorithm
Paul Kehrer56da2a52015-02-11 23:35:07 -0600344
Paul Kehrer8802a5b2015-02-13 12:06:57 -0600345 :type: :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
Paul Kehrer56da2a52015-02-11 23:35:07 -0600346
Paul Kehrere612ec72015-02-16 14:33:35 -0600347 Returns the
Paul Kehrer71d40c62015-02-19 08:21:04 -0600348 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` which
Paul Kehrer1a7ba872015-02-19 18:09:05 -0600349 was used in signing this certificate.
Paul Kehrer56da2a52015-02-11 23:35:07 -0600350
351 .. doctest::
352
Paul Kehrer8802a5b2015-02-13 12:06:57 -0600353 >>> from cryptography.hazmat.primitives import hashes
354 >>> isinstance(cert.signature_hash_algorithm, hashes.SHA256)
355 True
Paul Kehrer719d5362015-01-01 20:03:52 -0600356
Paul Kehrerfbb7ac82015-03-16 19:26:29 -0500357 .. attribute:: extensions
358
359 :type: :class:`Extensions`
360
361 The extensions encoded in the certificate.
362
363 :raises cryptography.x509.DuplicateExtension: If more than one
364 extension of the same type is found within the certificate.
365
Paul Kehrerd8fc0be2015-04-21 08:31:10 -0500366 :raises cryptography.x509.UnsupportedExtension: If the certificate
367 contains an extension that is not supported.
368
Paul Kehrerbed07352015-04-21 08:31:10 -0500369 :raises cryptography.x509.UnsupportedGeneralNameType: If an extension
370 contains a general name that is not supported.
371
Paul Kehrerb8968812015-05-15 09:01:34 -0700372 :raises UnicodeError: If an extension contains IDNA encoding that is
373 invalid or not compliant with IDNA 2008.
374
Paul Kehrerfa56a232015-03-17 13:14:03 -0500375 .. doctest::
376
377 >>> for ext in cert.extensions:
378 ... print(ext)
Paul Kehrerd774de92015-05-03 10:52:25 -0500379 <Extension(oid=<ObjectIdentifier(oid=2.5.29.35, name=authorityKeyIdentifier)>, critical=False, value=<AuthorityKeyIdentifier(key_identifier='\xe4}_\xd1\\\x95\x86\x08,\x05\xae\xbeu\xb6e\xa7\xd9]\xa8f', authority_cert_issuer=None, authority_cert_serial_number=None)>)>
Paul Kehrercbfb1012015-04-10 20:57:20 -0400380 <Extension(oid=<ObjectIdentifier(oid=2.5.29.14, name=subjectKeyIdentifier)>, critical=False, value=<SubjectKeyIdentifier(digest='X\x01\x84$\x1b\xbc+R\x94J=\xa5\x10r\x14Q\xf5\xaf:\xc9')>)>
Paul Kehrerb511ba82015-04-15 11:22:48 -0400381 <Extension(oid=<ObjectIdentifier(oid=2.5.29.15, name=keyUsage)>, critical=True, value=<KeyUsage(digital_signature=False, content_commitment=False, key_encipherment=False, data_encipherment=False, key_agreement=False, key_cert_sign=True, crl_sign=True, encipher_only=None, decipher_only=None)>)>
Paul Kehrer2008d9c2015-05-12 22:19:56 -0500382 <Extension(oid=<ObjectIdentifier(oid=2.5.29.32, name=certificatePolicies)>, critical=False, value=<CertificatePolicies([<PolicyInformation(policy_identifier=<ObjectIdentifier(oid=2.16.840.1.101.3.2.1.48.1, name=Unknown OID)>, policy_qualifiers=None)>])>)>
Paul Kehrerfa56a232015-03-17 13:14:03 -0500383 <Extension(oid=<ObjectIdentifier(oid=2.5.29.19, name=basicConstraints)>, critical=True, value=<BasicConstraints(ca=True, path_length=None)>)>
384
Andre Carona8aded62015-05-19 20:11:57 -0400385 .. method:: public_bytes(encoding)
386
Alex Gaynord0b376b2015-07-05 13:58:12 -0400387 .. versionadded:: 1.0
388
Andre Carona8aded62015-05-19 20:11:57 -0400389 :param encoding: The
390 :class:`~cryptography.hazmat.primitives.serialization.Encoding`
391 that will be used to serialize the certificate.
392
393 :return bytes: The data that can be written to a file or sent
394 over the network to be verified by clients.
395
Erik Trauschke2dcce902015-05-14 16:12:24 -0700396X.509 CRL (Certificate Revocation List) Object
397~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
398
399.. class:: CertificateRevocationList
400
401 .. versionadded:: 1.0
402
Erik Trauschke3cdabaf2015-10-13 09:42:53 -0700403 A CertificateRevocationList is an object representing a list of revoked
404 certificates. The object is iterable and will yield the RevokedCertificate
405 objects stored in this CRL.
406
407 .. doctest::
Erik Trauschkeb14f7d12015-10-13 09:55:39 -0700408
Erik Trauschke3cdabaf2015-10-13 09:42:53 -0700409 >>> len(crl)
410 1
Paul Kehrerdcdf9672015-10-21 20:27:28 -0500411 >>> revoked_certificate = crl[0]
412 >>> type(revoked_certificate)
Erik Trauschke3cdabaf2015-10-13 09:42:53 -0700413 <class 'cryptography.hazmat.backends.openssl.x509._RevokedCertificate'>
414 >>> for r in crl:
415 ... print(r.serial_number)
416 0
417
Erik Trauschke2dcce902015-05-14 16:12:24 -0700418 .. method:: fingerprint(algorithm)
419
420 :param algorithm: The
421 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
422 that will be used to generate the fingerprint.
423
424 :return bytes: The fingerprint using the supplied hash algorithm, as
425 bytes.
426
Erik Trauschkedc570402015-09-24 20:24:28 -0700427 .. doctest::
428
429 >>> from cryptography.hazmat.primitives import hashes
430 >>> crl.fingerprint(hashes.SHA256())
431 'e\xcf.\xc4:\x83?1\xdc\xf3\xfc\x95\xd7\xb3\x87\xb3\x8e\xf8\xb93!\x87\x07\x9d\x1b\xb4!\xb9\xe4W\xf4\x1f'
432
Erik Trauschke2dcce902015-05-14 16:12:24 -0700433 .. attribute:: signature_hash_algorithm
434
435 :type: :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
436
437 Returns the
438 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` which
439 was used in signing this CRL.
440
Erik Trauschkedc570402015-09-24 20:24:28 -0700441 .. doctest::
442
443 >>> from cryptography.hazmat.primitives import hashes
444 >>> isinstance(crl.signature_hash_algorithm, hashes.SHA256)
445 True
446
Erik Trauschke2dcce902015-05-14 16:12:24 -0700447 .. attribute:: issuer
448
449 :type: :class:`Name`
450
451 The :class:`Name` of the issuer.
452
Erik Trauschkedc570402015-09-24 20:24:28 -0700453 .. doctest::
454
455 >>> crl.issuer
456 <Name([<NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.6, name=countryName)>, value=u'US')>, <NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.3, name=commonName)>, value=u'cryptography.io')>])>
457
Erik Trauschke2dcce902015-05-14 16:12:24 -0700458 .. attribute:: next_update
459
460 :type: :class:`datetime.datetime`
461
462 A naïve datetime representing when the next update to this CRL is
463 expected.
464
Erik Trauschkedc570402015-09-24 20:24:28 -0700465 .. doctest::
466
467 >>> crl.next_update
468 datetime.datetime(2016, 1, 1, 0, 0)
469
Erik Trauschke2dcce902015-05-14 16:12:24 -0700470 .. attribute:: last_update
471
472 :type: :class:`datetime.datetime`
473
474 A naïve datetime representing when the this CRL was last updated.
475
Erik Trauschkedc570402015-09-24 20:24:28 -0700476 .. doctest::
Erik Trauschke2dcce902015-05-14 16:12:24 -0700477
Erik Trauschkedc570402015-09-24 20:24:28 -0700478 >>> crl.last_update
479 datetime.datetime(2015, 1, 1, 0, 0)
Erik Trauschke2dcce902015-05-14 16:12:24 -0700480
481 .. attribute:: extensions
482
483 :type: :class:`Extensions`
484
485 The extensions encoded in the CRL.
486
Andre Caron9bbfcea2015-05-18 20:55:29 -0400487X.509 Certificate Builder
488~~~~~~~~~~~~~~~~~~~~~~~~~
489
490.. class:: CertificateBuilder
491
Ian Cordasco1517a4b2015-08-02 22:11:19 -0500492 .. versionadded:: 1.0
493
494 .. doctest::
495
496 >>> from cryptography import x509
497 >>> from cryptography.hazmat.backends import default_backend
498 >>> from cryptography.hazmat.primitives import hashes
499 >>> from cryptography.hazmat.primitives.asymmetric import rsa
Paul Kehrere27f6582015-08-10 18:33:38 -0500500 >>> from cryptography.x509.oid import NameOID
Ian Cordasco1517a4b2015-08-02 22:11:19 -0500501 >>> import datetime
502 >>> import uuid
503 >>> one_day = datetime.timedelta(1, 0, 0)
504 >>> private_key = rsa.generate_private_key(
505 ... public_exponent=65537,
506 ... key_size=2048,
507 ... backend=default_backend()
508 ... )
509 >>> public_key = rsa.generate_private_key(
510 ... public_exponent=65537,
511 ... key_size=2048,
512 ... backend=default_backend()
513 ... ).public_key()
514 >>> builder = x509.CertificateBuilder()
515 >>> builder = builder.subject_name(x509.Name([
Paul Kehrere27f6582015-08-10 18:33:38 -0500516 ... x509.NameAttribute(NameOID.COMMON_NAME, u'cryptography.io'),
Ian Cordasco1517a4b2015-08-02 22:11:19 -0500517 ... ]))
518 >>> builder = builder.issuer_name(x509.Name([
Paul Kehrere27f6582015-08-10 18:33:38 -0500519 ... x509.NameAttribute(NameOID.COMMON_NAME, u'cryptography.io'),
Ian Cordasco1517a4b2015-08-02 22:11:19 -0500520 ... ]))
521 >>> builder = builder.not_valid_before(datetime.datetime.today() - one_day)
522 >>> builder = builder.not_valid_after(datetime.datetime(2018, 8, 2))
523 >>> builder = builder.serial_number(int(uuid.uuid4()))
524 >>> builder = builder.public_key(public_key)
525 >>> builder = builder.add_extension(
526 ... x509.BasicConstraints(ca=False, path_length=None), critical=True,
527 ... )
528 >>> certificate = builder.sign(
529 ... private_key=private_key, algorithm=hashes.SHA256(),
530 ... backend=default_backend()
531 ... )
532 >>> isinstance(certificate, x509.Certificate)
533 True
534
Ian Cordasco0092a0b2015-07-18 21:46:41 -0500535 .. method:: issuer_name(name)
Andre Caron9bbfcea2015-05-18 20:55:29 -0400536
537 Sets the issuer's distinguished name.
538
Ian Cordascoc9682ad2015-08-01 12:11:13 -0500539 :param name: The :class:`~cryptography.x509.Name` that describes the
540 issuer (CA).
Andre Caron9bbfcea2015-05-18 20:55:29 -0400541
Ian Cordasco0092a0b2015-07-18 21:46:41 -0500542 .. method:: subject_name(name)
Andre Caron9bbfcea2015-05-18 20:55:29 -0400543
544 Sets the subject's distinguished name.
545
Ian Cordascoc9682ad2015-08-01 12:11:13 -0500546 :param name: The :class:`~cryptography.x509.Name` that describes the
Ian Cordasco85fc4d52015-08-01 20:29:31 -0500547 subject.
Andre Caron9bbfcea2015-05-18 20:55:29 -0400548
Ian Cordasco0092a0b2015-07-18 21:46:41 -0500549 .. method:: public_key(public_key)
Andre Caron9bbfcea2015-05-18 20:55:29 -0400550
551 Sets the subject's public key.
552
Ian Cordasco8f571422015-08-02 11:31:08 -0500553 :param public_key: The subject's public key. This can be one of
554 :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey`,
555 :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey` or
556 :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey`
Andre Caron9bbfcea2015-05-18 20:55:29 -0400557
Ian Cordasco0092a0b2015-07-18 21:46:41 -0500558 .. method:: serial_number(serial_number)
Andre Caron9bbfcea2015-05-18 20:55:29 -0400559
560 Sets the certificate's serial number (an integer). The CA's policy
561 determines how it attributes serial numbers to certificates. The only
562 requirement is that this number uniquely identify the certificate given
563 the issuer.
564
565 :param serial_number: Integer number that will be used by the CA to
566 identify this certificate (most notably during certificate
Ian Cordasco17c89002015-08-02 21:13:59 -0500567 revocation checking). Users are encouraged to use a method of
568 generating 20 bytes of entropy, e.g., UUID4. For more information
Ian Cordascob7530a42015-08-02 22:47:06 -0500569 on secure random number generation, see :doc:`/random-numbers`.
Andre Caron9bbfcea2015-05-18 20:55:29 -0400570
Ian Cordasco0092a0b2015-07-18 21:46:41 -0500571 .. method:: not_valid_before(time)
Andre Caron9bbfcea2015-05-18 20:55:29 -0400572
573 Sets the certificate's activation time. This is the time from which
574 clients can start trusting the certificate. It may be different from
575 the time at which the certificate was created.
576
Ian Cordasco17c89002015-08-02 21:13:59 -0500577 :param time: The :class:`datetime.datetime` object (in UTC) that marks the
Andre Caron9bbfcea2015-05-18 20:55:29 -0400578 activation time for the certificate. The certificate may not be
579 trusted clients if it is used before this time.
580
Ian Cordasco0092a0b2015-07-18 21:46:41 -0500581 .. method:: not_valid_after(time)
Andre Caron9bbfcea2015-05-18 20:55:29 -0400582
583 Sets the certificate's expiration time. This is the time from which
584 clients should no longer trust the certificate. The CA's policy will
585 determine how long the certificate should remain in use.
586
Ian Cordasco17c89002015-08-02 21:13:59 -0500587 :param time: The :class:`datetime.datetime` object (in UTC) that marks the
Andre Caron9bbfcea2015-05-18 20:55:29 -0400588 expiration time for the certificate. The certificate may not be
589 trusted clients if it is used after this time.
590
Ian Cordasco17c89002015-08-02 21:13:59 -0500591 .. method:: add_extension(extension, critical)
Andre Caron9bbfcea2015-05-18 20:55:29 -0400592
593 Adds an X.509 extension to the certificate.
594
Paul Kehrer2c145cc2015-10-02 11:27:21 -0500595 :param extension: An extension conforming to the
596 :class:`~cryptography.x509.ExtensionType` interface.
Andre Caron9bbfcea2015-05-18 20:55:29 -0400597
Ian Cordasco17c89002015-08-02 21:13:59 -0500598 :param critical: Set to ``True`` if the extension must be understood and
599 handled by whoever reads the certificate.
600
Paul Kehrer9add80e2015-08-03 17:53:14 +0100601 .. method:: sign(private_key, algorithm, backend)
Andre Caron9bbfcea2015-05-18 20:55:29 -0400602
603 Sign the certificate using the CA's private key.
604
Ian Cordascoc5e1c252015-07-31 23:33:35 -0500605 :param private_key: The
606 :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPrivateKey`,
607 :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPrivateKey` or
608 :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePrivateKey`
609 that will be used to sign the certificate.
610
Andre Caron9bbfcea2015-05-18 20:55:29 -0400611 :param algorithm: The
612 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` that
613 will be used to generate the signature.
614
Paul Kehrer9add80e2015-08-03 17:53:14 +0100615 :param backend: Backend that will be used to build the certificate.
616 Must support the
617 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
618 interface.
619
Benjamin Peterson9ed312b2015-10-12 20:51:34 -0700620 :returns: :class:`~cryptography.x509.Certificate`
Andre Caron9bbfcea2015-05-18 20:55:29 -0400621
622
Paul Kehrer5aadb9c2015-03-11 20:48:42 -0500623X.509 CSR (Certificate Signing Request) Object
624~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600625
Paul Kehrera1a1f232015-03-15 15:34:35 -0500626.. class:: CertificateSigningRequest
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600627
628 .. versionadded:: 0.9
629
630 .. method:: public_key()
631
Alex Gaynor4c2561a2015-10-12 23:53:39 -0400632 The public key associated with the request.
633
634 :returns:
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600635 :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey` or
636 :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey` or
637 :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey`
638
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600639 .. doctest::
640
641 >>> from cryptography.hazmat.primitives.asymmetric import rsa
Paul Kehrera1a1f232015-03-15 15:34:35 -0500642 >>> public_key = csr.public_key()
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600643 >>> isinstance(public_key, rsa.RSAPublicKey)
644 True
645
646 .. attribute:: subject
647
648 :type: :class:`Name`
649
650 The :class:`Name` of the subject.
651
652 .. attribute:: signature_hash_algorithm
653
654 :type: :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
655
656 Returns the
657 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` which
658 was used in signing this request.
659
660 .. doctest::
661
662 >>> from cryptography.hazmat.primitives import hashes
Paul Kehrera1a1f232015-03-15 15:34:35 -0500663 >>> isinstance(csr.signature_hash_algorithm, hashes.SHA1)
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600664 True
665
Paul Kehrerc4e61942015-08-01 21:21:13 +0100666 .. attribute:: extensions
667
668 :type: :class:`Extensions`
669
670 The extensions encoded in the certificate signing request.
671
672 :raises cryptography.x509.DuplicateExtension: If more than one
Paul Kehrer24283d22015-08-01 21:31:19 +0100673 extension of the same type is found within the certificate signing request.
Paul Kehrerc4e61942015-08-01 21:21:13 +0100674
Paul Kehrer24283d22015-08-01 21:31:19 +0100675 :raises cryptography.x509.UnsupportedExtension: If the certificate signing request
Paul Kehrerc4e61942015-08-01 21:21:13 +0100676 contains an extension that is not supported.
677
678 :raises cryptography.x509.UnsupportedGeneralNameType: If an extension
679 contains a general name that is not supported.
680
681 :raises UnicodeError: If an extension contains IDNA encoding that is
682 invalid or not compliant with IDNA 2008.
683
684
Andre Caron476c5df2015-05-18 10:23:28 -0400685 .. method:: public_bytes(encoding)
686
Alex Gaynord0b376b2015-07-05 13:58:12 -0400687 .. versionadded:: 1.0
688
Andre Caron476c5df2015-05-18 10:23:28 -0400689 :param encoding: The
690 :class:`~cryptography.hazmat.primitives.serialization.Encoding`
691 that will be used to serialize the certificate request.
692
693 :return bytes: The data that can be written to a file or sent
694 over the network to be signed by the certificate
695 authority.
696
Erik Trauschke2dcce902015-05-14 16:12:24 -0700697X.509 Revoked Certificate Object
Erik Trauschkec5a8d172015-05-28 10:24:25 -0700698~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Erik Trauschke2dcce902015-05-14 16:12:24 -0700699
700.. class:: RevokedCertificate
701
702 .. versionadded:: 1.0
703
704 .. attribute:: serial_number
705
706 :type: :class:`int`
707
708 An integer representing the serial number of the revoked certificate.
709
Erik Trauschkedc570402015-09-24 20:24:28 -0700710 .. doctest::
711
Erik Trauschke3cdabaf2015-10-13 09:42:53 -0700712 >>> revoked_certificate.serial_number
Erik Trauschkedc570402015-09-24 20:24:28 -0700713 0
714
Erik Trauschke2dcce902015-05-14 16:12:24 -0700715 .. attribute:: revocation_date
716
717 :type: :class:`datetime.datetime`
718
719 A naïve datetime representing the date this certificates was revoked.
720
Erik Trauschkedc570402015-09-24 20:24:28 -0700721 .. doctest::
722
Erik Trauschke77f5a252015-10-14 08:06:38 -0700723 >>> revoked_certificate.revocation_date
Erik Trauschkedc570402015-09-24 20:24:28 -0700724 datetime.datetime(2015, 1, 1, 0, 0)
725
Erik Trauschke2dcce902015-05-14 16:12:24 -0700726 .. attribute:: extensions
727
728 :type: :class:`Extensions`
729
730 The extensions encoded in the revoked certificate.
Andre Caron476c5df2015-05-18 10:23:28 -0400731
Erik Trauschkedc570402015-09-24 20:24:28 -0700732 .. doctest::
733
Erik Trauschke77f5a252015-10-14 08:06:38 -0700734 >>> for ext in revoked_certificate.extensions:
Erik Trauschkedc570402015-09-24 20:24:28 -0700735 ... print(ext)
736 <Extension(oid=<ObjectIdentifier(oid=2.5.29.24, name=invalidityDate)>, critical=False, value=2015-01-01 00:00:00)>
737 <Extension(oid=<ObjectIdentifier(oid=2.5.29.21, name=cRLReason)>, critical=False, value=ReasonFlags.key_compromise)>
738
Andre Caron0ef595f2015-05-18 13:53:43 -0400739X.509 CSR (Certificate Signing Request) Builder Object
740~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
741
742.. class:: CertificateSigningRequestBuilder
743
Andre Carond259ee52015-06-02 23:47:11 -0400744 .. versionadded:: 1.0
745
746 .. doctest::
747
748 >>> from cryptography import x509
749 >>> from cryptography.hazmat.backends import default_backend
750 >>> from cryptography.hazmat.primitives import hashes
751 >>> from cryptography.hazmat.primitives.asymmetric import rsa
Paul Kehrere27f6582015-08-10 18:33:38 -0500752 >>> from cryptography.x509.oid import NameOID
Andre Carond259ee52015-06-02 23:47:11 -0400753 >>> private_key = rsa.generate_private_key(
754 ... public_exponent=65537,
755 ... key_size=2048,
756 ... backend=default_backend()
757 ... )
758 >>> builder = x509.CertificateSigningRequestBuilder()
Andre Carona9a51172015-06-06 20:18:44 -0400759 >>> builder = builder.subject_name(x509.Name([
Paul Kehrere27f6582015-08-10 18:33:38 -0500760 ... x509.NameAttribute(NameOID.COMMON_NAME, u'cryptography.io'),
Andre Carond259ee52015-06-02 23:47:11 -0400761 ... ]))
Ian Cordascof06b6be2015-06-21 10:09:18 -0500762 >>> builder = builder.add_extension(
Ian Cordasco0112b022015-06-16 17:51:18 -0500763 ... x509.BasicConstraints(ca=False, path_length=None), critical=True,
Andre Caron472fd692015-06-06 20:04:44 -0400764 ... )
Andre Carond259ee52015-06-02 23:47:11 -0400765 >>> request = builder.sign(
Alex Gaynorde9e5842015-06-26 20:11:23 -0400766 ... private_key, hashes.SHA256(), default_backend()
Andre Carond259ee52015-06-02 23:47:11 -0400767 ... )
768 >>> isinstance(request, x509.CertificateSigningRequest)
769 True
770
Andre Carona9a51172015-06-06 20:18:44 -0400771 .. method:: subject_name(name)
Andre Caron0ef595f2015-05-18 13:53:43 -0400772
Andre Caron341ff852015-06-06 20:14:31 -0400773 :param name: The :class:`~cryptography.x509.Name` of the certificate
774 subject.
775 :returns: A new
776 :class:`~cryptography.x509.CertificateSigningRequestBuilder`.
Andre Caron0ef595f2015-05-18 13:53:43 -0400777
Ian Cordascof06b6be2015-06-21 10:09:18 -0500778 .. method:: add_extension(extension, critical)
Andre Caron0ef595f2015-05-18 13:53:43 -0400779
Paul Kehrer2c145cc2015-10-02 11:27:21 -0500780 :param extension: An extension conforming to the
781 :class:`~cryptography.x509.ExtensionType` interface.
Andre Caron472fd692015-06-06 20:04:44 -0400782 :param critical: Set to `True` if the extension must be understood and
783 handled by whoever reads the certificate.
Andre Caron341ff852015-06-06 20:14:31 -0400784 :returns: A new
785 :class:`~cryptography.x509.CertificateSigningRequestBuilder`.
Andre Caron0ef595f2015-05-18 13:53:43 -0400786
Alex Gaynorb3b0fbe2015-06-26 19:57:18 -0400787 .. method:: sign(private_key, algorithm, backend)
Andre Caron0ef595f2015-05-18 13:53:43 -0400788
789 :param backend: Backend that will be used to sign the request.
790 Must support the
791 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
792 interface.
793
794 :param private_key: The
Andre Caron24f9bf42015-06-06 20:14:54 -0400795 :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPrivateKey`,
796 :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPrivateKey` or
797 :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePrivateKey`
Andre Caron0ef595f2015-05-18 13:53:43 -0400798 that will be used to sign the request. When the request is
799 signed by a certificate authority, the private key's associated
800 public key will be stored in the resulting certificate.
801
802 :param algorithm: The
803 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
804 that will be used to generate the request signature.
805
Andre Caron341ff852015-06-06 20:14:31 -0400806 :returns: A new
807 :class:`~cryptography.x509.CertificateSigningRequest`.
Andre Caron0ef595f2015-05-18 13:53:43 -0400808
809
Paul Kehrer719d5362015-01-01 20:03:52 -0600810.. class:: Name
811
812 .. versionadded:: 0.8
813
Paul Kehrer53d8d492015-02-13 18:47:30 -0600814 An X509 Name is an ordered list of attributes. The object is iterable to
Paul Kehrerd21596e2015-02-14 09:17:26 -0600815 get every attribute or you can use :meth:`Name.get_attributes_for_oid` to
Paul Kehrer719d5362015-01-01 20:03:52 -0600816 obtain the specific type you want. Names are sometimes represented as a
Paul Kehrer53d8d492015-02-13 18:47:30 -0600817 slash or comma delimited string (e.g. ``/CN=mydomain.com/O=My Org/C=US`` or
818 ``CN=mydomain.com, O=My Org, C=US``).
Paul Kehrer719d5362015-01-01 20:03:52 -0600819
Paul Kehrer53d8d492015-02-13 18:47:30 -0600820 .. doctest::
Paul Kehrer719d5362015-01-01 20:03:52 -0600821
Paul Kehrer8b21a4a2015-02-14 07:56:36 -0600822 >>> len(cert.subject)
Paul Kehrer53d8d492015-02-13 18:47:30 -0600823 3
Paul Kehrer8b21a4a2015-02-14 07:56:36 -0600824 >>> for attribute in cert.subject:
825 ... print(attribute)
826 <NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.6, name=countryName)>, value=u'US')>
827 <NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.10, name=organizationName)>, value=u'Test Certificates 2011')>
828 <NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.3, name=commonName)>, value=u'Good CA')>
Paul Kehrer719d5362015-01-01 20:03:52 -0600829
Paul Kehrere901d642015-02-11 18:50:58 -0600830 .. method:: get_attributes_for_oid(oid)
Paul Kehrer719d5362015-01-01 20:03:52 -0600831
Paul Kehrere901d642015-02-11 18:50:58 -0600832 :param oid: An :class:`ObjectIdentifier` instance.
Paul Kehrer719d5362015-01-01 20:03:52 -0600833
Paul Kehrere901d642015-02-11 18:50:58 -0600834 :returns: A list of :class:`NameAttribute` instances that match the
835 OID provided. If nothing matches an empty list will be returned.
Paul Kehrer719d5362015-01-01 20:03:52 -0600836
837 .. doctest::
838
Paul Kehrere27f6582015-08-10 18:33:38 -0500839 >>> cert.subject.get_attributes_for_oid(NameOID.COMMON_NAME)
Paul Kehrere901d642015-02-11 18:50:58 -0600840 [<NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.3, name=commonName)>, value=u'Good CA')>]
Paul Kehrerb2de9482014-12-11 14:54:48 -0600841
Paul Kehrere76cd272014-12-14 19:00:51 -0600842.. class:: Version
Paul Kehrer016e08a2014-11-26 09:41:18 -1000843
844 .. versionadded:: 0.7
845
846 An enumeration for X.509 versions.
847
848 .. attribute:: v1
849
850 For version 1 X.509 certificates.
851
852 .. attribute:: v3
853
854 For version 3 X.509 certificates.
855
Paul Kehrer806bfb22015-02-02 17:05:24 -0600856.. class:: NameAttribute
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600857
858 .. versionadded:: 0.8
859
Paul Kehrer834d22f2015-02-06 11:01:07 -0600860 An X.509 name consists of a list of NameAttribute instances.
Paul Kehrer5b0a8d62015-01-30 20:05:55 -0600861
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600862 .. attribute:: oid
863
864 :type: :class:`ObjectIdentifier`
865
866 The attribute OID.
867
868 .. attribute:: value
869
Paul Kehrerd5852cb2015-01-30 08:25:23 -0600870 :type: :term:`text`
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600871
872 The value of the attribute.
873
874.. class:: ObjectIdentifier
875
876 .. versionadded:: 0.8
877
Paul Kehrer5b0a8d62015-01-30 20:05:55 -0600878 Object identifiers (frequently seen abbreviated as OID) identify the type
Paul Kehrer806bfb22015-02-02 17:05:24 -0600879 of a value (see: :class:`NameAttribute`).
Paul Kehrer5b0a8d62015-01-30 20:05:55 -0600880
Paul Kehrerd44f9a62015-02-04 14:47:34 -0600881 .. attribute:: dotted_string
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600882
883 :type: :class:`str`
884
Paul Kehrerfedf4f42015-02-06 11:22:07 -0600885 The dotted string value of the OID (e.g. ``"2.5.4.3"``)
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600886
Paul Kehrer31bdf792015-03-25 14:11:00 -0500887.. _general_name_classes:
888
889General Name Classes
890~~~~~~~~~~~~~~~~~~~~
891
892.. class:: GeneralName
893
894 .. versionadded:: 0.9
895
896 This is the generic interface that all the following classes are registered
897 against.
898
Paul Kehrer47c32ba2015-10-28 09:12:07 +0900899.. class:: RFC822Name(value)
Paul Kehrer31bdf792015-03-25 14:11:00 -0500900
901 .. versionadded:: 0.9
902
903 This corresponds to an email address. For example, ``user@example.com``.
904
905 .. attribute:: value
906
907 :type: :term:`text`
908
Paul Kehrer47c32ba2015-10-28 09:12:07 +0900909.. class:: DNSName(value)
Paul Kehrer31bdf792015-03-25 14:11:00 -0500910
911 .. versionadded:: 0.9
912
913 This corresponds to a domain name. For example, ``cryptography.io``.
914
915 .. attribute:: value
916
917 :type: :term:`text`
918
Paul Kehrer47c32ba2015-10-28 09:12:07 +0900919.. class:: DirectoryName(value)
Paul Kehrer31bdf792015-03-25 14:11:00 -0500920
921 .. versionadded:: 0.9
922
923 This corresponds to a directory name.
924
925 .. attribute:: value
926
927 :type: :class:`Name`
928
Paul Kehrer47c32ba2015-10-28 09:12:07 +0900929.. class:: UniformResourceIdentifier(value)
Paul Kehrer31bdf792015-03-25 14:11:00 -0500930
931 .. versionadded:: 0.9
932
933 This corresponds to a uniform resource identifier. For example,
Paul Kehrerb8ef82e2015-04-22 16:04:24 -0500934 ``https://cryptography.io``. The URI is parsed and IDNA decoded (see
935 :rfc:`5895`).
936
937 .. note::
938
939 URIs that do not contain ``://`` in them will not be decoded.
Paul Kehrer31bdf792015-03-25 14:11:00 -0500940
941 .. attribute:: value
942
943 :type: :term:`text`
944
Paul Kehrer47c32ba2015-10-28 09:12:07 +0900945.. class:: IPAddress(value)
Paul Kehrer31bdf792015-03-25 14:11:00 -0500946
947 .. versionadded:: 0.9
948
949 This corresponds to an IP address.
950
951 .. attribute:: value
952
Paul Kehrereb177932015-05-17 18:33:33 -0700953 :type: :class:`~ipaddress.IPv4Address`,
954 :class:`~ipaddress.IPv6Address`, :class:`~ipaddress.IPv4Network`,
955 or :class:`~ipaddress.IPv6Network`.
Paul Kehrer31bdf792015-03-25 14:11:00 -0500956
Paul Kehrer47c32ba2015-10-28 09:12:07 +0900957.. class:: RegisteredID(value)
Paul Kehrer31bdf792015-03-25 14:11:00 -0500958
959 .. versionadded:: 0.9
960
961 This corresponds to a registered ID.
962
963 .. attribute:: value
964
965 :type: :class:`ObjectIdentifier`
966
Paul Kehrer47c32ba2015-10-28 09:12:07 +0900967.. class:: OtherName(type_id, value)
Joshua Tauberer2ee5e3c2015-07-04 20:09:46 +0000968
969 .. versionadded:: 1.0
970
Joshua Tauberer18b6fc82015-07-05 21:44:51 +0000971 This corresponds to an ``otherName.`` An ``otherName`` has a type identifier and a value represented in binary DER format.
Joshua Tauberer2ee5e3c2015-07-04 20:09:46 +0000972
973 .. attribute:: type_id
974
975 :type: :class:`ObjectIdentifier`
976
977 .. attribute:: value
978
979 :type: `bytes`
980
Paul Kehrer8cf26422015-03-21 09:50:24 -0500981X.509 Extensions
982~~~~~~~~~~~~~~~~
983
Paul Kehrerfbb7ac82015-03-16 19:26:29 -0500984.. class:: Extensions
985
986 .. versionadded:: 0.9
987
988 An X.509 Extensions instance is an ordered list of extensions. The object
989 is iterable to get every extension.
990
Paul Kehrerfa56a232015-03-17 13:14:03 -0500991 .. method:: get_extension_for_oid(oid)
992
993 :param oid: An :class:`ObjectIdentifier` instance.
994
995 :returns: An instance of the extension class.
996
997 :raises cryptography.x509.ExtensionNotFound: If the certificate does
998 not have the extension requested.
999
Paul Kehrerfa56a232015-03-17 13:14:03 -05001000 .. doctest::
1001
Paul Kehrere27f6582015-08-10 18:33:38 -05001002 >>> from cryptography.x509.oid import ExtensionOID
1003 >>> cert.extensions.get_extension_for_oid(ExtensionOID.BASIC_CONSTRAINTS)
Paul Kehrerfa56a232015-03-17 13:14:03 -05001004 <Extension(oid=<ObjectIdentifier(oid=2.5.29.19, name=basicConstraints)>, critical=True, value=<BasicConstraints(ca=True, path_length=None)>)>
1005
Phoebe Queen019b7f82015-08-12 03:52:03 +01001006 .. method:: get_extension_for_class(extclass)
1007
Phoebe Queen6a603eb2015-08-12 14:14:49 +01001008 .. versionadded:: 1.1
1009
Phoebe Queen019b7f82015-08-12 03:52:03 +01001010 :param extclass: An extension class.
1011
1012 :returns: An instance of the extension class.
1013
1014 :raises cryptography.x509.ExtensionNotFound: If the certificate does
1015 not have the extension requested.
1016
1017 .. doctest::
1018
1019 >>> from cryptography import x509
1020 >>> cert.extensions.get_extension_for_class(x509.BasicConstraints)
1021 <Extension(oid=<ObjectIdentifier(oid=2.5.29.19, name=basicConstraints)>, critical=True, value=<BasicConstraints(ca=True, path_length=None)>)>
1022
Paul Kehrer8cf26422015-03-21 09:50:24 -05001023.. class:: Extension
1024
1025 .. versionadded:: 0.9
1026
Paul Kehrer85894662015-03-22 13:19:31 -05001027 .. attribute:: oid
1028
1029 :type: :class:`ObjectIdentifier`
1030
Paul Kehrere27f6582015-08-10 18:33:38 -05001031 One of the :class:`~cryptography.x509.oid.ExtensionOID` OIDs.
Paul Kehrer8cf26422015-03-21 09:50:24 -05001032
1033 .. attribute:: critical
1034
1035 :type: bool
1036
Paul Kehrer58b75692015-03-22 23:24:58 -05001037 Determines whether a given extension is critical or not. :rfc:`5280`
1038 requires that "A certificate-using system MUST reject the certificate
1039 if it encounters a critical extension it does not recognize or a
1040 critical extension that contains information that it cannot process".
Paul Kehrer8cf26422015-03-21 09:50:24 -05001041
Paul Kehrer85894662015-03-22 13:19:31 -05001042 .. attribute:: value
1043
1044 Returns an instance of the extension type corresponding to the OID.
1045
Paul Kehrer14f0bd02015-08-06 11:55:18 +01001046.. class:: ExtensionType
1047
1048 .. versionadded:: 1.0
1049
1050 This is the interface against which all the following extension types are
1051 registered.
1052
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001053.. class:: KeyUsage(digital_signature, content_commitment, key_encipherment, data_encipherment, key_agreement, key_cert_sign, crl_sign, encipher_only, decipher_only)
Paul Kehrercecbbba2015-03-30 14:58:38 -05001054
1055 .. versionadded:: 0.9
1056
1057 The key usage extension defines the purpose of the key contained in the
1058 certificate. The usage restriction might be employed when a key that could
Paul Kehrerb33de932015-08-06 23:41:05 +01001059 be used for more than one operation is to be restricted.
Paul Kehrercecbbba2015-03-30 14:58:38 -05001060
Paul Kehrer822f3d32015-08-06 11:47:32 +01001061 .. attribute:: oid
1062
1063 .. versionadded:: 1.0
1064
1065 :type: :class:`ObjectIdentifier`
1066
Paul Kehrere27f6582015-08-10 18:33:38 -05001067 Returns :attr:`~cryptography.x509.oid.ExtensionOID.KEY_USAGE`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001068
Paul Kehrercecbbba2015-03-30 14:58:38 -05001069 .. attribute:: digital_signature
1070
1071 :type: bool
1072
Paul Kehrer738407b2015-04-01 22:39:02 -05001073 This purpose is set to true when the subject public key is used for verifying
Paul Kehrercecbbba2015-03-30 14:58:38 -05001074 digital signatures, other than signatures on certificates
1075 (``key_cert_sign``) and CRLs (``crl_sign``).
1076
1077 .. attribute:: content_commitment
1078
1079 :type: bool
1080
Paul Kehrer738407b2015-04-01 22:39:02 -05001081 This purpose is set to true when the subject public key is used for verifying
Paul Kehrercecbbba2015-03-30 14:58:38 -05001082 digital signatures, other than signatures on certificates
1083 (``key_cert_sign``) and CRLs (``crl_sign``). It is used to provide a
1084 non-repudiation service that protects against the signing entity
1085 falsely denying some action. In the case of later conflict, a
1086 reliable third party may determine the authenticity of the signed
1087 data. This was called ``non_repudiation`` in older revisions of the
1088 X.509 specification.
1089
1090 .. attribute:: key_encipherment
1091
1092 :type: bool
1093
Paul Kehrer738407b2015-04-01 22:39:02 -05001094 This purpose is set to true when the subject public key is used for
1095 enciphering private or secret keys.
Paul Kehrercecbbba2015-03-30 14:58:38 -05001096
1097 .. attribute:: data_encipherment
1098
1099 :type: bool
1100
Paul Kehrer738407b2015-04-01 22:39:02 -05001101 This purpose is set to true when the subject public key is used for
1102 directly enciphering raw user data without the use of an intermediate
1103 symmetric cipher.
Paul Kehrercecbbba2015-03-30 14:58:38 -05001104
1105 .. attribute:: key_agreement
1106
1107 :type: bool
1108
Paul Kehrer738407b2015-04-01 22:39:02 -05001109 This purpose is set to true when the subject public key is used for key
1110 agreement. For example, when a Diffie-Hellman key is to be used for
1111 key management, then this purpose is set to true.
Paul Kehrercecbbba2015-03-30 14:58:38 -05001112
1113 .. attribute:: key_cert_sign
1114
1115 :type: bool
1116
Paul Kehrer738407b2015-04-01 22:39:02 -05001117 This purpose is set to true when the subject public key is used for
1118 verifying signatures on public key certificates. If this purpose is set
1119 to true then ``ca`` must be true in the :class:`BasicConstraints`
1120 extension.
Paul Kehrercecbbba2015-03-30 14:58:38 -05001121
1122 .. attribute:: crl_sign
1123
1124 :type: bool
1125
Paul Kehrer738407b2015-04-01 22:39:02 -05001126 This purpose is set to true when the subject public key is used for
1127 verifying signatures on certificate revocation lists.
Paul Kehrercecbbba2015-03-30 14:58:38 -05001128
1129 .. attribute:: encipher_only
1130
1131 :type: bool
1132
Paul Kehrer738407b2015-04-01 22:39:02 -05001133 When this purposes is set to true and the ``key_agreement`` purpose is
1134 also set, the subject public key may be used only for enciphering data
1135 while performing key agreement.
Paul Kehrercecbbba2015-03-30 14:58:38 -05001136
1137 :raises ValueError: This is raised if accessed when ``key_agreement``
1138 is false.
1139
1140 .. attribute:: decipher_only
1141
1142 :type: bool
1143
Paul Kehrer738407b2015-04-01 22:39:02 -05001144 When this purposes is set to true and the ``key_agreement`` purpose is
1145 also set, the subject public key may be used only for deciphering data
1146 while performing key agreement.
Paul Kehrercecbbba2015-03-30 14:58:38 -05001147
1148 :raises ValueError: This is raised if accessed when ``key_agreement``
1149 is false.
1150
1151
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001152.. class:: BasicConstraints(ca, path_length)
Paul Kehrer8cf26422015-03-21 09:50:24 -05001153
1154 .. versionadded:: 0.9
1155
Paul Kehrer85894662015-03-22 13:19:31 -05001156 Basic constraints is an X.509 extension type that defines whether a given
Paul Kehrer8cf26422015-03-21 09:50:24 -05001157 certificate is allowed to sign additional certificates and what path
Paul Kehrerb33de932015-08-06 23:41:05 +01001158 length restrictions may exist.
Paul Kehrer8cf26422015-03-21 09:50:24 -05001159
Paul Kehrer822f3d32015-08-06 11:47:32 +01001160 .. attribute:: oid
1161
1162 .. versionadded:: 1.0
1163
1164 :type: :class:`ObjectIdentifier`
1165
Paul Kehrere27f6582015-08-10 18:33:38 -05001166 Returns :attr:`~cryptography.x509.oid.ExtensionOID.BASIC_CONSTRAINTS`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001167
Paul Kehrer8cf26422015-03-21 09:50:24 -05001168 .. attribute:: ca
1169
1170 :type: bool
1171
1172 Whether the certificate can sign certificates.
1173
1174 .. attribute:: path_length
1175
Paul Kehrerfd1444c2015-03-21 19:47:05 -05001176 :type: int or None
Paul Kehrer8cf26422015-03-21 09:50:24 -05001177
1178 The maximum path length for certificates subordinate to this
1179 certificate. This attribute only has meaning if ``ca`` is true.
1180 If ``ca`` is true then a path length of None means there's no
1181 restriction on the number of subordinate CAs in the certificate chain.
Alex Gaynor99c5f152015-05-03 10:01:04 -04001182 If it is zero or greater then it defines the maximum length for a
1183 subordinate CA's certificate chain. For example, a ``path_length`` of 1
1184 means the certificate can sign a subordinate CA, but the subordinate CA
1185 is not allowed to create subordinates with ``ca`` set to true.
Paul Kehrer8cf26422015-03-21 09:50:24 -05001186
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001187.. class:: ExtendedKeyUsage(usages)
Paul Kehrerffa2a152015-03-31 08:18:25 -05001188
1189 .. versionadded:: 0.9
1190
1191 This extension indicates one or more purposes for which the certified
1192 public key may be used, in addition to or in place of the basic
1193 purposes indicated in the key usage extension. The object is
Paul Kehrere27f6582015-08-10 18:33:38 -05001194 iterable to obtain the list of
1195 :class:`~cryptography.x509.oid.ExtendedKeyUsageOID` OIDs present.
Paul Kehrerffa2a152015-03-31 08:18:25 -05001196
Paul Kehrer1cb9e552015-10-28 09:37:29 +09001197 :param list usages: A list of
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001198 :class:`~cryptography.x509.oid.ExtendedKeyUsageOID` OIDs.
1199
Paul Kehrer822f3d32015-08-06 11:47:32 +01001200 .. attribute:: oid
1201
1202 .. versionadded:: 1.0
1203
1204 :type: :class:`ObjectIdentifier`
1205
Paul Kehrere27f6582015-08-10 18:33:38 -05001206 Returns :attr:`~cryptography.x509.oid.ExtensionOID.EXTENDED_KEY_USAGE`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001207
1208
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001209.. class:: OCSPNoCheck()
Paul Kehrer4a1038e2015-05-18 10:28:31 -07001210
Paul Kehrer506a2152015-05-26 08:01:18 -05001211 .. versionadded:: 1.0
Paul Kehrer4a1038e2015-05-18 10:28:31 -07001212
1213 This presence of this extension indicates that an OCSP client can trust a
1214 responder for the lifetime of the responder's certificate. CAs issuing
1215 such a certificate should realize that a compromise of the responder's key
1216 is as serious as the compromise of a CA key used to sign CRLs, at least for
1217 the validity period of this certificate. CA's may choose to issue this type
1218 of certificate with a very short lifetime and renew it frequently. This
1219 extension is only relevant when the certificate is an authorized OCSP
1220 responder.
1221
Paul Kehrer822f3d32015-08-06 11:47:32 +01001222 .. attribute:: oid
1223
1224 .. versionadded:: 1.0
1225
1226 :type: :class:`ObjectIdentifier`
1227
Paul Kehrere27f6582015-08-10 18:33:38 -05001228 Returns :attr:`~cryptography.x509.oid.ExtensionOID.OCSP_NO_CHECK`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001229
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001230.. class:: NameConstraints(permitted_subtrees, excluded_subtrees)
Paul Kehrere0017be2015-05-17 20:39:40 -06001231
1232 .. versionadded:: 1.0
1233
1234 The name constraints extension, which only has meaning in a CA certificate,
1235 defines a name space within which all subject names in certificates issued
1236 beneath the CA certificate must (or must not) be in. For specific details
1237 on the way this extension should be processed see :rfc:`5280`.
1238
Paul Kehrer822f3d32015-08-06 11:47:32 +01001239 .. attribute:: oid
1240
1241 .. versionadded:: 1.0
1242
1243 :type: :class:`ObjectIdentifier`
1244
Paul Kehrere27f6582015-08-10 18:33:38 -05001245 Returns :attr:`~cryptography.x509.oid.ExtensionOID.NAME_CONSTRAINTS`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001246
Paul Kehrere0017be2015-05-17 20:39:40 -06001247 .. attribute:: permitted_subtrees
1248
1249 :type: list of :class:`GeneralName` objects or None
1250
1251 The set of permitted name patterns. If a name matches this and an
1252 element in ``excluded_subtrees`` it is invalid. At least one of
1253 ``permitted_subtrees`` and ``excluded_subtrees`` will be non-None.
1254
1255 .. attribute:: excluded_subtrees
1256
1257 :type: list of :class:`GeneralName` objects or None
1258
1259 Any name matching a restriction in the ``excluded_subtrees`` field is
1260 invalid regardless of information appearing in the
1261 ``permitted_subtrees``. At least one of ``permitted_subtrees`` and
1262 ``excluded_subtrees`` will be non-None.
1263
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001264.. class:: AuthorityKeyIdentifier(key_identifier, authority_cert_issuer, authority_cert_serial_number)
Paul Kehrer2eb4ed92015-04-11 15:33:45 -04001265
1266 .. versionadded:: 0.9
1267
1268 The authority key identifier extension provides a means of identifying the
1269 public key corresponding to the private key used to sign a certificate.
Paul Kehrer8c8cd722015-04-19 09:15:04 -05001270 This extension is typically used to assist in determining the appropriate
1271 certificate chain. For more information about generation and use of this
1272 extension see `RFC 5280 section 4.2.1.1`_.
Paul Kehrer2eb4ed92015-04-11 15:33:45 -04001273
Paul Kehrer822f3d32015-08-06 11:47:32 +01001274 .. attribute:: oid
1275
1276 .. versionadded:: 1.0
1277
1278 :type: :class:`ObjectIdentifier`
1279
Paul Kehrere27f6582015-08-10 18:33:38 -05001280 Returns
1281 :attr:`~cryptography.x509.oid.ExtensionOID.AUTHORITY_KEY_IDENTIFIER`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001282
Paul Kehrer2eb4ed92015-04-11 15:33:45 -04001283 .. attribute:: key_identifier
1284
1285 :type: bytes
1286
Paul Kehrer9104b1d2015-04-18 09:23:44 -05001287 A value derived from the public key used to verify the certificate's
Paul Kehrer8c8cd722015-04-19 09:15:04 -05001288 signature.
Paul Kehrer9104b1d2015-04-18 09:23:44 -05001289
Paul Kehrer2eb4ed92015-04-11 15:33:45 -04001290 .. attribute:: authority_cert_issuer
1291
1292 :type: :class:`Name` or None
1293
Paul Kehrer9104b1d2015-04-18 09:23:44 -05001294 The :class:`Name` of the issuer's issuer.
1295
Paul Kehrer2eb4ed92015-04-11 15:33:45 -04001296 .. attribute:: authority_cert_serial_number
1297
1298 :type: int or None
1299
Paul Kehrer9104b1d2015-04-18 09:23:44 -05001300 The serial number of the issuer's issuer.
1301
Paul Kehrer253929a2015-08-05 17:30:39 +01001302 .. classmethod:: from_issuer_public_key(public_key)
1303
1304 .. versionadded:: 1.0
1305
1306 Creates a new AuthorityKeyIdentifier instance using the public key
1307 provided to generate the appropriate digest. This should be the
Paul Kehrer26ac47f2015-08-08 15:20:52 -05001308 **issuer's public key**. The resulting object will contain
1309 :attr:`~cryptography.x509.AuthorityKeyIdentifier.key_identifier`, but
1310 :attr:`~cryptography.x509.AuthorityKeyIdentifier.authority_cert_issuer`
1311 and
1312 :attr:`~cryptography.x509.AuthorityKeyIdentifier.authority_cert_serial_number`
1313 will be None.
1314 The generated ``key_identifier`` is the SHA1 hash of the ``subjectPublicKey``
1315 ASN.1 bit string. This is the first recommendation in :rfc:`5280`
Paul Kehrer253929a2015-08-05 17:30:39 +01001316 section 4.2.1.2.
1317
Paul Kehrercc671822015-08-08 15:41:54 -05001318 :param public_key: One of
1319 :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey`
1320 ,
1321 :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey`
1322 , or
1323 :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey`.
Paul Kehrer253929a2015-08-05 17:30:39 +01001324
1325 .. doctest::
1326
1327 >>> from cryptography import x509
1328 >>> from cryptography.hazmat.backends import default_backend
Paul Kehrercc671822015-08-08 15:41:54 -05001329 >>> issuer_cert = x509.load_pem_x509_certificate(pem_data, default_backend())
1330 >>> x509.AuthorityKeyIdentifier.from_issuer_public_key(issuer_cert.public_key())
Paul Kehrer253929a2015-08-05 17:30:39 +01001331 <AuthorityKeyIdentifier(key_identifier='X\x01\x84$\x1b\xbc+R\x94J=\xa5\x10r\x14Q\xf5\xaf:\xc9', authority_cert_issuer=None, authority_cert_serial_number=None)>
1332
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001333.. class:: SubjectKeyIdentifier(digest)
Paul Kehrer1eb82a62015-03-31 20:00:33 -05001334
1335 .. versionadded:: 0.9
1336
1337 The subject key identifier extension provides a means of identifying
1338 certificates that contain a particular public key.
1339
Paul Kehrer822f3d32015-08-06 11:47:32 +01001340 .. attribute:: oid
1341
1342 .. versionadded:: 1.0
1343
1344 :type: :class:`ObjectIdentifier`
1345
Paul Kehrere27f6582015-08-10 18:33:38 -05001346 Returns
1347 :attr:`~cryptography.x509.oid.ExtensionOID.SUBJECT_KEY_IDENTIFIER`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001348
Paul Kehrer1eb82a62015-03-31 20:00:33 -05001349 .. attribute:: digest
1350
1351 :type: bytes
1352
1353 The binary value of the identifier.
1354
Paul Kehrerd4a7f062015-08-05 18:32:18 +01001355 .. classmethod:: from_public_key(public_key)
Paul Kehrerf22f6122015-08-05 12:57:13 +01001356
1357 .. versionadded:: 1.0
1358
1359 Creates a new SubjectKeyIdentifier instance using the public key
1360 provided to generate the appropriate digest. This should be the public
Paul Kehrereb9ec002015-08-08 10:03:02 -05001361 key that is in the certificate. The generated digest is the SHA1 hash
1362 of the ``subjectPublicKey`` ASN.1 bit string. This is the first
1363 recommendation in :rfc:`5280` section 4.2.1.2.
Paul Kehrerf22f6122015-08-05 12:57:13 +01001364
1365 :param public_key: One of
1366 :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey`
1367 ,
1368 :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey`
1369 , or
1370 :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey`.
1371
Paul Kehrer253929a2015-08-05 17:30:39 +01001372 .. doctest::
1373
1374 >>> from cryptography import x509
1375 >>> from cryptography.hazmat.backends import default_backend
Paul Kehrercc671822015-08-08 15:41:54 -05001376 >>> csr = x509.load_pem_x509_csr(pem_req_data, default_backend())
1377 >>> x509.SubjectKeyIdentifier.from_public_key(csr.public_key())
1378 <SubjectKeyIdentifier(digest='\xdb\xaa\xf0\x06\x11\xdbD\xfe\xbf\x93\x03\x8av\x88WP7\xa6\x91\xf7')>
Paul Kehrer253929a2015-08-05 17:30:39 +01001379
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001380.. class:: SubjectAlternativeName(general_names)
Paul Kehrer31bdf792015-03-25 14:11:00 -05001381
1382 .. versionadded:: 0.9
1383
1384 Subject alternative name is an X.509 extension that provides a list of
1385 :ref:`general name <general_name_classes>` instances that provide a set
1386 of identities for which the certificate is valid. The object is iterable to
1387 get every element.
1388
Paul Kehrer1cb9e552015-10-28 09:37:29 +09001389 :param list general_names: A list of :class:`GeneralName` instances.
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001390
Paul Kehrer822f3d32015-08-06 11:47:32 +01001391 .. attribute:: oid
1392
1393 .. versionadded:: 1.0
1394
1395 :type: :class:`ObjectIdentifier`
1396
Paul Kehrere27f6582015-08-10 18:33:38 -05001397 Returns
1398 :attr:`~cryptography.x509.oid.ExtensionOID.SUBJECT_ALTERNATIVE_NAME`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001399
Paul Kehrer31bdf792015-03-25 14:11:00 -05001400 .. method:: get_values_for_type(type)
1401
1402 :param type: A :class:`GeneralName` provider. This is one of the
1403 :ref:`general name classes <general_name_classes>`.
1404
1405 :returns: A list of values extracted from the matched general names.
Joshua Taubererd2afad32015-07-06 22:37:53 +00001406 The type of the returned values depends on the :class:`GeneralName`.
Paul Kehrer31bdf792015-03-25 14:11:00 -05001407
Paul Kehrer93ae8052015-05-02 23:18:09 -05001408 .. doctest::
1409
1410 >>> from cryptography import x509
1411 >>> from cryptography.hazmat.backends import default_backend
1412 >>> from cryptography.hazmat.primitives import hashes
1413 >>> cert = x509.load_pem_x509_certificate(cryptography_cert_pem, default_backend())
Paul Kehrerd0cd5072015-05-02 23:27:00 -05001414 >>> # Get the subjectAltName extension from the certificate
Paul Kehrere27f6582015-08-10 18:33:38 -05001415 >>> ext = cert.extensions.get_extension_for_oid(ExtensionOID.SUBJECT_ALTERNATIVE_NAME)
Paul Kehrerd0cd5072015-05-02 23:27:00 -05001416 >>> # Get the dNSName entries from the SAN extension
1417 >>> ext.value.get_values_for_type(x509.DNSName)
Paul Kehrer93ae8052015-05-02 23:18:09 -05001418 [u'www.cryptography.io', u'cryptography.io']
1419
Paul Kehrer8cf26422015-03-21 09:50:24 -05001420
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001421.. class:: IssuerAlternativeName(general_names)
Paul Kehrer99125c92015-06-07 18:37:10 -05001422
1423 .. versionadded:: 1.0
1424
1425 Issuer alternative name is an X.509 extension that provides a list of
1426 :ref:`general name <general_name_classes>` instances that provide a set
1427 of identities for the certificate issuer. The object is iterable to
1428 get every element.
1429
Paul Kehrer1cb9e552015-10-28 09:37:29 +09001430 :param list general_names: A list of :class:`GeneralName` instances.
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001431
Paul Kehrer822f3d32015-08-06 11:47:32 +01001432 .. attribute:: oid
1433
1434 .. versionadded:: 1.0
1435
1436 :type: :class:`ObjectIdentifier`
1437
Paul Kehrere27f6582015-08-10 18:33:38 -05001438 Returns
1439 :attr:`~cryptography.x509.oid.ExtensionOID.ISSUER_ALTERNATIVE_NAME`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001440
Paul Kehrer99125c92015-06-07 18:37:10 -05001441 .. method:: get_values_for_type(type)
1442
1443 :param type: A :class:`GeneralName` provider. This is one of the
1444 :ref:`general name classes <general_name_classes>`.
1445
1446 :returns: A list of values extracted from the matched general names.
1447
1448
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001449.. class:: AuthorityInformationAccess(descriptions)
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001450
1451 .. versionadded:: 0.9
1452
1453 The authority information access extension indicates how to access
1454 information and services for the issuer of the certificate in which
1455 the extension appears. Information and services may include online
1456 validation services (such as OCSP) and issuer data. It is an iterable,
Paul Kehrere27f6582015-08-10 18:33:38 -05001457 containing one or more :class:`~cryptography.x509.AccessDescription`
1458 instances.
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001459
Paul Kehrer1cb9e552015-10-28 09:37:29 +09001460 :param list descriptions: A list of :class:`AccessDescription` objects.
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001461
Paul Kehrer822f3d32015-08-06 11:47:32 +01001462 .. attribute:: oid
1463
1464 .. versionadded:: 1.0
1465
1466 :type: :class:`ObjectIdentifier`
1467
Paul Kehrere27f6582015-08-10 18:33:38 -05001468 Returns
1469 :attr:`~cryptography.x509.oid.ExtensionOID.AUTHORITY_INFORMATION_ACCESS`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001470
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001471
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001472.. class:: AccessDescription(access_method, access_location)
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001473
Paul Kehrer5a485522015-05-06 00:29:12 -05001474 .. versionadded:: 0.9
1475
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001476 .. attribute:: access_method
1477
1478 :type: :class:`ObjectIdentifier`
1479
Paul Kehrerf506bca2015-05-02 22:31:47 -05001480 The access method defines what the ``access_location`` means. It must
Paul Kehrere27f6582015-08-10 18:33:38 -05001481 be either
1482 :attr:`~cryptography.x509.oid.AuthorityInformationAccessOID.OCSP` or
1483 :attr:`~cryptography.x509.oid.AuthorityInformationAccessOID.CA_ISSUERS`.
1484 If it is
1485 :attr:`~cryptography.x509.oid.AuthorityInformationAccessOID.OCSP`
1486 the access location will be where to obtain OCSP
1487 information for the certificate. If it is
1488 :attr:`~cryptography.x509.oid.AuthorityInformationAccessOID.CA_ISSUERS`
1489 the access location will provide additional information about the
1490 issuing certificate.
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001491
1492 .. attribute:: access_location
1493
1494 :type: :class:`GeneralName`
1495
Paul Kehrerf506bca2015-05-02 22:31:47 -05001496 Where to access the information defined by the access method.
1497
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001498.. class:: CRLDistributionPoints(distribution_points)
Paul Kehrer5a485522015-05-06 00:29:12 -05001499
1500 .. versionadded:: 0.9
1501
1502 The CRL distribution points extension identifies how CRL information is
1503 obtained. It is an iterable, containing one or more
1504 :class:`DistributionPoint` instances.
1505
Paul Kehrer1cb9e552015-10-28 09:37:29 +09001506 :param list distribution_points: A list of :class:`DistributionPoint`
1507 instances.
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001508
Paul Kehrer822f3d32015-08-06 11:47:32 +01001509 .. attribute:: oid
1510
1511 .. versionadded:: 1.0
1512
1513 :type: :class:`ObjectIdentifier`
1514
Paul Kehrere27f6582015-08-10 18:33:38 -05001515 Returns
1516 :attr:`~cryptography.x509.oid.ExtensionOID.CRL_DISTRIBUTION_POINTS`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001517
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001518.. class:: DistributionPoint(full_name, relative_name, reasons, crl_issuer)
Paul Kehrer5a485522015-05-06 00:29:12 -05001519
1520 .. versionadded:: 0.9
1521
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001522 .. attribute:: full_name
Paul Kehrer5a485522015-05-06 00:29:12 -05001523
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001524 :type: list of :class:`GeneralName` instances or None
Paul Kehrer5a485522015-05-06 00:29:12 -05001525
Paul Kehrerf2c072b2015-05-09 17:04:28 -05001526 This field describes methods to retrieve the CRL. At most one of
1527 ``full_name`` or ``relative_name`` will be non-None.
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001528
1529 .. attribute:: relative_name
1530
1531 :type: :class:`Name` or None
1532
1533 This field describes methods to retrieve the CRL relative to the CRL
Paul Kehrerf2c072b2015-05-09 17:04:28 -05001534 issuer. At most one of ``full_name`` or ``relative_name`` will be
1535 non-None.
Paul Kehrer5a485522015-05-06 00:29:12 -05001536
1537 .. attribute:: crl_issuer
1538
1539 :type: list of :class:`GeneralName` instances or None
1540
1541 Information about the issuer of the CRL.
1542
1543 .. attribute:: reasons
1544
Paul Kehrer3fd02602015-05-09 19:46:13 -05001545 :type: frozenset of :class:`ReasonFlags` or None
Paul Kehrer5a485522015-05-06 00:29:12 -05001546
1547 The reasons a given distribution point may be used for when performing
1548 revocation checks.
1549
1550.. class:: ReasonFlags
1551
1552 .. versionadded:: 0.9
1553
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001554 An enumeration for CRL reasons.
1555
1556 .. attribute:: unspecified
1557
1558 It is unspecified why the certificate was revoked. This reason cannot
1559 be used as a reason flag in a :class:`DistributionPoint`.
Paul Kehrer5a485522015-05-06 00:29:12 -05001560
1561 .. attribute:: key_compromise
1562
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001563 This reason indicates that the private key was compromised.
Paul Kehrer5a485522015-05-06 00:29:12 -05001564
1565 .. attribute:: ca_compromise
1566
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001567 This reason indicates that the CA issuing the certificate was
1568 compromised.
Paul Kehrer5a485522015-05-06 00:29:12 -05001569
1570 .. attribute:: affiliation_changed
1571
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001572 This reason indicates that the subject's name or other information has
1573 changed.
Paul Kehrer5a485522015-05-06 00:29:12 -05001574
1575 .. attribute:: superseded
1576
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001577 This reason indicates that a certificate has been superseded.
Paul Kehrer5a485522015-05-06 00:29:12 -05001578
1579 .. attribute:: cessation_of_operation
1580
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001581 This reason indicates that the certificate is no longer required.
Paul Kehrer5a485522015-05-06 00:29:12 -05001582
1583 .. attribute:: certificate_hold
1584
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001585 This reason indicates that the certificate is on hold.
Paul Kehrer5a485522015-05-06 00:29:12 -05001586
1587 .. attribute:: privilege_withdrawn
1588
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001589 This reason indicates that the privilege granted by this certificate
1590 have been withdrawn.
Paul Kehrer5a485522015-05-06 00:29:12 -05001591
1592 .. attribute:: aa_compromise
1593
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001594 When an attribute authority has been compromised.
1595
1596 .. attribute:: remove_from_crl
1597
1598 This reason indicates that the certificate was on hold and should be
1599 removed from the CRL. This reason cannot be used as a reason flag
1600 in a :class:`DistributionPoint`.
Paul Kehrer5a485522015-05-06 00:29:12 -05001601
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001602.. class:: InhibitAnyPolicy(skip_certs)
Paul Kehrer16fae762015-05-01 23:14:20 -05001603
1604 .. versionadded:: 1.0
1605
1606 The inhibit ``anyPolicy`` extension indicates that the special OID
Paul Kehrere27f6582015-08-10 18:33:38 -05001607 :attr:`~cryptography.x509.oid.CertificatePoliciesOID.ANY_POLICY`, is not
1608 considered an explicit match for other :class:`CertificatePolicies` except
1609 when it appears in an intermediate self-issued CA certificate. The value
1610 indicates the number of additional non-self-issued certificates that may
1611 appear in the path before
1612 :attr:`~cryptography.x509.oid.CertificatePoliciesOID.ANY_POLICY` is no
1613 longer permitted. For example, a value of one indicates that
1614 :attr:`~cryptography.x509.oid.CertificatePoliciesOID.ANY_POLICY` may be
1615 processed in certificates issued by the subject of this certificate, but
1616 not in additional certificates in the path.
Paul Kehrer16fae762015-05-01 23:14:20 -05001617
Paul Kehrer822f3d32015-08-06 11:47:32 +01001618 .. attribute:: oid
1619
1620 .. versionadded:: 1.0
1621
1622 :type: :class:`ObjectIdentifier`
1623
Paul Kehrere27f6582015-08-10 18:33:38 -05001624 Returns
1625 :attr:`~cryptography.x509.oid.ExtensionOID.INHIBIT_ANY_POLICY`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001626
Paul Kehrer16fae762015-05-01 23:14:20 -05001627 .. attribute:: skip_certs
1628
1629 :type: int
1630
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001631.. class:: CertificatePolicies(policies)
Paul Kehrer0d210922015-04-28 17:31:07 -05001632
1633 .. versionadded:: 0.9
1634
Paul Kehrer2e879742015-05-02 23:09:56 -05001635 The certificate policies extension is an iterable, containing one or more
1636 :class:`PolicyInformation` instances.
Paul Kehrer0d210922015-04-28 17:31:07 -05001637
Paul Kehrer1cb9e552015-10-28 09:37:29 +09001638 :param list policies: A list of :class:`PolicyInformation` instances.
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001639
Paul Kehrer822f3d32015-08-06 11:47:32 +01001640 .. attribute:: oid
1641
1642 .. versionadded:: 1.0
1643
1644 :type: :class:`ObjectIdentifier`
1645
Paul Kehrere27f6582015-08-10 18:33:38 -05001646 Returns
1647 :attr:`~cryptography.x509.oid.ExtensionOID.CERTIFICATE_POLICIES`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001648
Paul Kehrer0d210922015-04-28 17:31:07 -05001649Certificate Policies Classes
1650~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1651
1652These classes may be present within a :class:`CertificatePolicies` instance.
1653
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001654.. class:: PolicyInformation(policy_identifier, policy_qualifiers)
Paul Kehrer0d210922015-04-28 17:31:07 -05001655
1656 .. versionadded:: 0.9
1657
1658 Contains a policy identifier and an optional list of qualifiers.
1659
1660 .. attribute:: policy_identifier
1661
1662 :type: :class:`ObjectIdentifier`
1663
1664 .. attribute:: policy_qualifiers
1665
1666 :type: list
1667
Paul Kehrerba35b3b2015-05-10 13:07:59 -05001668 A list consisting of :term:`text` and/or :class:`UserNotice` objects.
Paul Kehrer3f8ddeb2015-05-11 00:25:36 -05001669 If the value is text it is a pointer to the practice statement
1670 published by the certificate authority. If it is a user notice it is
1671 meant for display to the relying party when the certificate is
1672 used.
Paul Kehrer2e879742015-05-02 23:09:56 -05001673
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001674.. class:: UserNotice(notice_reference, explicit_text)
Paul Kehrer0d210922015-04-28 17:31:07 -05001675
1676 .. versionadded:: 0.9
1677
Paul Kehrer2e879742015-05-02 23:09:56 -05001678 User notices are intended for display to a relying party when a certificate
1679 is used. In practice, few if any UIs expose this data and it is a rarely
1680 encoded component.
1681
Paul Kehrer0d210922015-04-28 17:31:07 -05001682 .. attribute:: notice_reference
1683
1684 :type: :class:`NoticeReference` or None
1685
Paul Kehrer2e879742015-05-02 23:09:56 -05001686 The notice reference field names an organization and identifies,
1687 by number, a particular statement prepared by that organization.
1688
Paul Kehrer0d210922015-04-28 17:31:07 -05001689 .. attribute:: explicit_text
1690
Paul Kehrer2e879742015-05-02 23:09:56 -05001691 This field includes an arbitrary textual statement directly in the
1692 certificate.
1693
Paul Kehrer0d210922015-04-28 17:31:07 -05001694 :type: :term:`text`
1695
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001696.. class:: NoticeReference(organization, notice_numbers)
Paul Kehrer0d210922015-04-28 17:31:07 -05001697
Paul Kehrer2e879742015-05-02 23:09:56 -05001698 Notice reference can name an organization and provide information about
1699 notices related to the certificate. For example, it might identify the
1700 organization name and notice number 1. Application software could
1701 have a notice file containing the current set of notices for the named
1702 organization; the application would then extract the notice text from the
1703 file and display it. In practice this is rarely seen.
1704
Paul Kehrer0d210922015-04-28 17:31:07 -05001705 .. versionadded:: 0.9
1706
1707 .. attribute:: organization
1708
Paul Kehrer66c61702015-05-12 16:39:18 -05001709 :type: :term:`text`
Paul Kehrer0d210922015-04-28 17:31:07 -05001710
Paul Kehrer3f8ddeb2015-05-11 00:25:36 -05001711 .. attribute:: notice_numbers
Paul Kehrer0d210922015-04-28 17:31:07 -05001712
Paul Kehrer66c61702015-05-12 16:39:18 -05001713 :type: list
Paul Kehrer0d210922015-04-28 17:31:07 -05001714
Paul Kehrer66c61702015-05-12 16:39:18 -05001715 A list of integers.
Paul Kehrer0d210922015-04-28 17:31:07 -05001716
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001717Object Identifiers
1718~~~~~~~~~~~~~~~~~~
1719
Paul Kehrer4bb46492015-02-07 16:59:14 -06001720X.509 elements are frequently identified by :class:`ObjectIdentifier`
1721instances. The following common OIDs are available as constants.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001722
Paul Kehrere27f6582015-08-10 18:33:38 -05001723.. currentmodule:: cryptography.x509.oid
Paul Kehrer56da2a52015-02-11 23:35:07 -06001724
Paul Kehrere27f6582015-08-10 18:33:38 -05001725.. class:: NameOID
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001726
Paul Kehrere27f6582015-08-10 18:33:38 -05001727 These OIDs are typically seen in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001728
Paul Kehrere27f6582015-08-10 18:33:38 -05001729 .. versionadded:: 1.0
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001730
Paul Kehrere27f6582015-08-10 18:33:38 -05001731 .. attribute:: COMMON_NAME
Paul Kehrer858b9b72015-02-05 09:50:31 -06001732
Paul Kehrere27f6582015-08-10 18:33:38 -05001733 Corresponds to the dotted string ``"2.5.4.3"``. Historically the domain
1734 name would be encoded here for server certificates. :rfc:`2818`
1735 deprecates this practice and names of that type should now be located
1736 in a :class:`~cryptography.x509.SubjectAlternativeName` extension.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001737
Paul Kehrere27f6582015-08-10 18:33:38 -05001738 .. attribute:: COUNTRY_NAME
Paul Kehrer858b9b72015-02-05 09:50:31 -06001739
Paul Kehrere27f6582015-08-10 18:33:38 -05001740 Corresponds to the dotted string ``"2.5.4.6"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001741
Paul Kehrere27f6582015-08-10 18:33:38 -05001742 .. attribute:: LOCALITY_NAME
Paul Kehrer858b9b72015-02-05 09:50:31 -06001743
Paul Kehrere27f6582015-08-10 18:33:38 -05001744 Corresponds to the dotted string ``"2.5.4.7"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001745
Paul Kehrere27f6582015-08-10 18:33:38 -05001746 .. attribute:: STATE_OR_PROVINCE_NAME
Paul Kehrer858b9b72015-02-05 09:50:31 -06001747
Paul Kehrere27f6582015-08-10 18:33:38 -05001748 Corresponds to the dotted string ``"2.5.4.8"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001749
Paul Kehrere27f6582015-08-10 18:33:38 -05001750 .. attribute:: ORGANIZATION_NAME
Paul Kehrer858b9b72015-02-05 09:50:31 -06001751
Paul Kehrere27f6582015-08-10 18:33:38 -05001752 Corresponds to the dotted string ``"2.5.4.10"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001753
Paul Kehrere27f6582015-08-10 18:33:38 -05001754 .. attribute:: ORGANIZATIONAL_UNIT_NAME
Paul Kehrer858b9b72015-02-05 09:50:31 -06001755
Paul Kehrere27f6582015-08-10 18:33:38 -05001756 Corresponds to the dotted string ``"2.5.4.11"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001757
Paul Kehrere27f6582015-08-10 18:33:38 -05001758 .. attribute:: SERIAL_NUMBER
Paul Kehrer858b9b72015-02-05 09:50:31 -06001759
Paul Kehrere27f6582015-08-10 18:33:38 -05001760 Corresponds to the dotted string ``"2.5.4.5"``. This is distinct from
1761 the serial number of the certificate itself (which can be obtained with
1762 :func:`~cryptography.x509.Certificate.serial`).
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001763
Paul Kehrere27f6582015-08-10 18:33:38 -05001764 .. attribute:: SURNAME
Paul Kehrer858b9b72015-02-05 09:50:31 -06001765
Paul Kehrere27f6582015-08-10 18:33:38 -05001766 Corresponds to the dotted string ``"2.5.4.4"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001767
Paul Kehrere27f6582015-08-10 18:33:38 -05001768 .. attribute:: GIVEN_NAME
Paul Kehrer858b9b72015-02-05 09:50:31 -06001769
Paul Kehrere27f6582015-08-10 18:33:38 -05001770 Corresponds to the dotted string ``"2.5.4.42"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001771
Paul Kehrere27f6582015-08-10 18:33:38 -05001772 .. attribute:: TITLE
Paul Kehrer858b9b72015-02-05 09:50:31 -06001773
Paul Kehrere27f6582015-08-10 18:33:38 -05001774 Corresponds to the dotted string ``"2.5.4.12"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001775
Paul Kehrere27f6582015-08-10 18:33:38 -05001776 .. attribute:: GENERATION_QUALIFIER
Paul Kehrer858b9b72015-02-05 09:50:31 -06001777
Paul Kehrere27f6582015-08-10 18:33:38 -05001778 Corresponds to the dotted string ``"2.5.4.44"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001779
Paul Kehrere27f6582015-08-10 18:33:38 -05001780 .. attribute:: DN_QUALIFIER
Paul Kehrer858b9b72015-02-05 09:50:31 -06001781
Paul Kehrere27f6582015-08-10 18:33:38 -05001782 Corresponds to the dotted string ``"2.5.4.46"``. This specifies
1783 disambiguating information to add to the relative distinguished name of an
1784 entry. See :rfc:`2256`.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001785
Paul Kehrere27f6582015-08-10 18:33:38 -05001786 .. attribute:: PSEUDONYM
Paul Kehrer858b9b72015-02-05 09:50:31 -06001787
Paul Kehrere27f6582015-08-10 18:33:38 -05001788 Corresponds to the dotted string ``"2.5.4.65"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001789
Paul Kehrere27f6582015-08-10 18:33:38 -05001790 .. attribute:: DOMAIN_COMPONENT
Paul Kehrer858b9b72015-02-05 09:50:31 -06001791
Paul Kehrere27f6582015-08-10 18:33:38 -05001792 Corresponds to the dotted string ``"0.9.2342.19200300.100.1.25"``. A string
1793 holding one component of a domain name. See :rfc:`4519`.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001794
Paul Kehrere27f6582015-08-10 18:33:38 -05001795 .. attribute:: EMAIL_ADDRESS
Paul Kehrer56da2a52015-02-11 23:35:07 -06001796
Paul Kehrere27f6582015-08-10 18:33:38 -05001797 Corresponds to the dotted string ``"1.2.840.113549.1.9.1"``.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001798
Paul Kehrer56da2a52015-02-11 23:35:07 -06001799
Paul Kehrere27f6582015-08-10 18:33:38 -05001800.. class:: SignatureAlgorithmOID
Paul Kehrer56da2a52015-02-11 23:35:07 -06001801
Paul Kehrere27f6582015-08-10 18:33:38 -05001802 .. versionadded:: 1.0
Paul Kehrer56da2a52015-02-11 23:35:07 -06001803
Paul Kehrere27f6582015-08-10 18:33:38 -05001804 .. attribute:: RSA_WITH_MD5
Paul Kehrer56da2a52015-02-11 23:35:07 -06001805
Paul Kehrere27f6582015-08-10 18:33:38 -05001806 Corresponds to the dotted string ``"1.2.840.113549.1.1.4"``. This is
1807 an MD5 digest signed by an RSA key.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001808
Paul Kehrere27f6582015-08-10 18:33:38 -05001809 .. attribute:: RSA_WITH_SHA1
Paul Kehrer56da2a52015-02-11 23:35:07 -06001810
Paul Kehrere27f6582015-08-10 18:33:38 -05001811 Corresponds to the dotted string ``"1.2.840.113549.1.1.5"``. This is
1812 a SHA1 digest signed by an RSA key.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001813
Paul Kehrere27f6582015-08-10 18:33:38 -05001814 .. attribute:: RSA_WITH_SHA224
Paul Kehrer56da2a52015-02-11 23:35:07 -06001815
Paul Kehrere27f6582015-08-10 18:33:38 -05001816 Corresponds to the dotted string ``"1.2.840.113549.1.1.14"``. This is
1817 a SHA224 digest signed by an RSA key.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001818
Paul Kehrere27f6582015-08-10 18:33:38 -05001819 .. attribute:: RSA_WITH_SHA256
Paul Kehrer56da2a52015-02-11 23:35:07 -06001820
Paul Kehrere27f6582015-08-10 18:33:38 -05001821 Corresponds to the dotted string ``"1.2.840.113549.1.1.11"``. This is
1822 a SHA256 digest signed by an RSA key.
Alex Gaynor3aadabf2015-06-23 22:06:21 -04001823
Paul Kehrere27f6582015-08-10 18:33:38 -05001824 .. attribute:: RSA_WITH_SHA384
Alex Gaynor3aadabf2015-06-23 22:06:21 -04001825
Paul Kehrere27f6582015-08-10 18:33:38 -05001826 Corresponds to the dotted string ``"1.2.840.113549.1.1.12"``. This is
1827 a SHA384 digest signed by an RSA key.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001828
Paul Kehrere27f6582015-08-10 18:33:38 -05001829 .. attribute:: RSA_WITH_SHA512
Paul Kehrer56da2a52015-02-11 23:35:07 -06001830
Paul Kehrere27f6582015-08-10 18:33:38 -05001831 Corresponds to the dotted string ``"1.2.840.113549.1.1.13"``. This is
1832 a SHA512 digest signed by an RSA key.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001833
Paul Kehrere27f6582015-08-10 18:33:38 -05001834 .. attribute:: ECDSA_WITH_SHA1
Paul Kehrer56da2a52015-02-11 23:35:07 -06001835
Paul Kehrere27f6582015-08-10 18:33:38 -05001836 Corresponds to the dotted string ``"1.2.840.10045.4.1"``. This is a SHA1
1837 digest signed by an ECDSA key.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001838
Paul Kehrere27f6582015-08-10 18:33:38 -05001839 .. attribute:: ECDSA_WITH_SHA224
Paul Kehrer56da2a52015-02-11 23:35:07 -06001840
Paul Kehrere27f6582015-08-10 18:33:38 -05001841 Corresponds to the dotted string ``"1.2.840.10045.4.3.1"``. This is
1842 a SHA224 digest signed by an ECDSA key.
1843
1844 .. attribute:: ECDSA_WITH_SHA256
1845
1846 Corresponds to the dotted string ``"1.2.840.10045.4.3.2"``. This is
1847 a SHA256 digest signed by an ECDSA key.
1848
1849 .. attribute:: ECDSA_WITH_SHA384
1850
1851 Corresponds to the dotted string ``"1.2.840.10045.4.3.3"``. This is
1852 a SHA384 digest signed by an ECDSA key.
1853
1854 .. attribute:: ECDSA_WITH_SHA512
1855
1856 Corresponds to the dotted string ``"1.2.840.10045.4.3.4"``. This is
1857 a SHA512 digest signed by an ECDSA key.
1858
1859 .. attribute:: DSA_WITH_SHA1
1860
1861 Corresponds to the dotted string ``"1.2.840.10040.4.3"``. This is
1862 a SHA1 digest signed by a DSA key.
1863
1864 .. attribute:: DSA_WITH_SHA224
1865
1866 Corresponds to the dotted string ``"2.16.840.1.101.3.4.3.1"``. This is
1867 a SHA224 digest signed by a DSA key.
1868
1869 .. attribute:: DSA_WITH_SHA256
Paul Kehrer56da2a52015-02-11 23:35:07 -06001870
Paul Kehrere27f6582015-08-10 18:33:38 -05001871 Corresponds to the dotted string ``"2.16.840.1.101.3.4.3.2"``. This is
1872 a SHA256 digest signed by a DSA key.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001873
Paul Kehrer56da2a52015-02-11 23:35:07 -06001874
Paul Kehrere27f6582015-08-10 18:33:38 -05001875.. class:: ExtendedKeyUsageOID
Paul Kehrer56da2a52015-02-11 23:35:07 -06001876
Paul Kehrere27f6582015-08-10 18:33:38 -05001877 .. versionadded:: 1.0
Paul Kehrer56da2a52015-02-11 23:35:07 -06001878
Paul Kehrere27f6582015-08-10 18:33:38 -05001879 .. attribute:: SERVER_AUTH
Paul Kehrer56da2a52015-02-11 23:35:07 -06001880
Paul Kehrere27f6582015-08-10 18:33:38 -05001881 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.1"``. This is used
1882 to denote that a certificate may be used for TLS web server
1883 authentication.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001884
Paul Kehrere27f6582015-08-10 18:33:38 -05001885 .. attribute:: CLIENT_AUTH
Paul Kehrer56da2a52015-02-11 23:35:07 -06001886
Paul Kehrere27f6582015-08-10 18:33:38 -05001887 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.2"``. This is used
1888 to denote that a certificate may be used for TLS web client
1889 authentication.
Paul Kehrerffa2a152015-03-31 08:18:25 -05001890
Paul Kehrere27f6582015-08-10 18:33:38 -05001891 .. attribute:: CODE_SIGNING
Paul Kehrere1513fa2015-03-30 23:08:17 -05001892
Paul Kehrere27f6582015-08-10 18:33:38 -05001893 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.3"``. This is used
1894 to denote that a certificate may be used for code signing.
Paul Kehrere1513fa2015-03-30 23:08:17 -05001895
Paul Kehrere27f6582015-08-10 18:33:38 -05001896 .. attribute:: EMAIL_PROTECTION
Paul Kehrere1513fa2015-03-30 23:08:17 -05001897
Paul Kehrere27f6582015-08-10 18:33:38 -05001898 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.4"``. This is used
1899 to denote that a certificate may be used for email protection.
Paul Kehrere1513fa2015-03-30 23:08:17 -05001900
Paul Kehrere27f6582015-08-10 18:33:38 -05001901 .. attribute:: TIME_STAMPING
Paul Kehrere1513fa2015-03-30 23:08:17 -05001902
Paul Kehrere27f6582015-08-10 18:33:38 -05001903 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.8"``. This is used
1904 to denote that a certificate may be used for time stamping.
Paul Kehrere1513fa2015-03-30 23:08:17 -05001905
Paul Kehrere27f6582015-08-10 18:33:38 -05001906 .. attribute:: OCSP_SIGNING
Paul Kehrere1513fa2015-03-30 23:08:17 -05001907
Paul Kehrere27f6582015-08-10 18:33:38 -05001908 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.9"``. This is used
1909 to denote that a certificate may be used for signing OCSP responses.
Paul Kehrere1513fa2015-03-30 23:08:17 -05001910
Paul Kehrere1513fa2015-03-30 23:08:17 -05001911
Paul Kehrere27f6582015-08-10 18:33:38 -05001912.. class:: AuthorityInformationAccessOID
Paul Kehrere1513fa2015-03-30 23:08:17 -05001913
Paul Kehrere27f6582015-08-10 18:33:38 -05001914 .. versionadded:: 1.0
Paul Kehrere1513fa2015-03-30 23:08:17 -05001915
Paul Kehrere27f6582015-08-10 18:33:38 -05001916 .. attribute:: OCSP
Paul Kehrere1513fa2015-03-30 23:08:17 -05001917
Paul Kehrere27f6582015-08-10 18:33:38 -05001918 Corresponds to the dotted string ``"1.3.6.1.5.5.7.48.1"``. Used as the
1919 identifier for OCSP data in
1920 :class:`~cryptography.x509.AccessDescription` objects.
Paul Kehrere1513fa2015-03-30 23:08:17 -05001921
Paul Kehrere27f6582015-08-10 18:33:38 -05001922 .. attribute:: CA_ISSUERS
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001923
Paul Kehrere27f6582015-08-10 18:33:38 -05001924 Corresponds to the dotted string ``"1.3.6.1.5.5.7.48.2"``. Used as the
1925 identifier for CA issuer data in
1926 :class:`~cryptography.x509.AccessDescription` objects.
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001927
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001928
Paul Kehrere27f6582015-08-10 18:33:38 -05001929.. class:: CertificatePoliciesOID
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001930
Paul Kehrere27f6582015-08-10 18:33:38 -05001931 .. versionadded:: 1.0
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001932
Paul Kehrere27f6582015-08-10 18:33:38 -05001933 .. attribute:: CPS_QUALIFIER
Paul Kehrer2e879742015-05-02 23:09:56 -05001934
Paul Kehrere27f6582015-08-10 18:33:38 -05001935 Corresponds to the dotted string ``"1.3.6.1.5.5.7.2.1"``.
Paul Kehrer2e879742015-05-02 23:09:56 -05001936
Paul Kehrere27f6582015-08-10 18:33:38 -05001937 .. attribute:: CPS_USER_NOTICE
Paul Kehrer2e879742015-05-02 23:09:56 -05001938
Paul Kehrere27f6582015-08-10 18:33:38 -05001939 Corresponds to the dotted string ``"1.3.6.1.5.5.7.2.2"``.
Paul Kehrer2e879742015-05-02 23:09:56 -05001940
Paul Kehrere27f6582015-08-10 18:33:38 -05001941 .. attribute:: ANY_POLICY
Paul Kehrer2e879742015-05-02 23:09:56 -05001942
Paul Kehrere27f6582015-08-10 18:33:38 -05001943 Corresponds to the dotted string ``"2.5.29.32.0"``.
Paul Kehrer16fae762015-05-01 23:14:20 -05001944
Paul Kehrer16fae762015-05-01 23:14:20 -05001945
Paul Kehrere27f6582015-08-10 18:33:38 -05001946.. class:: ExtensionOID
Paul Kehrer5553d572015-03-23 21:08:01 -05001947
Paul Kehrere27f6582015-08-10 18:33:38 -05001948 .. versionadded:: 1.0
Paul Kehrer2bb94642015-03-21 09:54:17 -05001949
Paul Kehrere27f6582015-08-10 18:33:38 -05001950 .. attribute:: BASIC_CONSTRAINTS
Paul Kehrer2bb94642015-03-21 09:54:17 -05001951
Paul Kehrere27f6582015-08-10 18:33:38 -05001952 Corresponds to the dotted string ``"2.5.29.19"``. The identifier for the
1953 :class:`~cryptography.x509.BasicConstraints` extension type.
Paul Kehrer2bb94642015-03-21 09:54:17 -05001954
Paul Kehrere27f6582015-08-10 18:33:38 -05001955 .. attribute:: KEY_USAGE
Paul Kehrercecbbba2015-03-30 14:58:38 -05001956
Paul Kehrere27f6582015-08-10 18:33:38 -05001957 Corresponds to the dotted string ``"2.5.29.15"``. The identifier for the
1958 :class:`~cryptography.x509.KeyUsage` extension type.
Paul Kehrercecbbba2015-03-30 14:58:38 -05001959
Paul Kehrere27f6582015-08-10 18:33:38 -05001960 .. attribute:: SUBJECT_ALTERNATIVE_NAME
Paul Kehrerd4f632e2015-05-12 08:25:42 -05001961
Paul Kehrere27f6582015-08-10 18:33:38 -05001962 Corresponds to the dotted string ``"2.5.29.17"``. The identifier for the
1963 :class:`~cryptography.x509.SubjectAlternativeName` extension type.
Paul Kehrerd4f632e2015-05-12 08:25:42 -05001964
Paul Kehrere27f6582015-08-10 18:33:38 -05001965 .. attribute:: ISSUER_ALTERNATIVE_NAME
Paul Kehrer99125c92015-06-07 18:37:10 -05001966
Paul Kehrere27f6582015-08-10 18:33:38 -05001967 Corresponds to the dotted string ``"2.5.29.18"``. The identifier for the
1968 :class:`~cryptography.x509.IssuerAlternativeName` extension type.
Paul Kehrer99125c92015-06-07 18:37:10 -05001969
Paul Kehrere27f6582015-08-10 18:33:38 -05001970 .. attribute:: SUBJECT_KEY_IDENTIFIER
Paul Kehrerd4f632e2015-05-12 08:25:42 -05001971
Paul Kehrere27f6582015-08-10 18:33:38 -05001972 Corresponds to the dotted string ``"2.5.29.14"``. The identifier for the
1973 :class:`~cryptography.x509.SubjectKeyIdentifier` extension type.
Paul Kehrerd4f632e2015-05-12 08:25:42 -05001974
Paul Kehrere27f6582015-08-10 18:33:38 -05001975 .. attribute:: NAME_CONSTRAINTS
Paul Kehrere0017be2015-05-17 20:39:40 -06001976
Paul Kehrere27f6582015-08-10 18:33:38 -05001977 Corresponds to the dotted string ``"2.5.29.30"``. The identifier for the
1978 :class:`~cryptography.x509.NameConstraints` extension type.
Paul Kehrere0017be2015-05-17 20:39:40 -06001979
Paul Kehrere27f6582015-08-10 18:33:38 -05001980 .. attribute:: CRL_DISTRIBUTION_POINTS
Paul Kehrerd4f632e2015-05-12 08:25:42 -05001981
Paul Kehrere27f6582015-08-10 18:33:38 -05001982 Corresponds to the dotted string ``"2.5.29.31"``. The identifier for the
1983 :class:`~cryptography.x509.CRLDistributionPoints` extension type.
Paul Kehrerd4f632e2015-05-12 08:25:42 -05001984
Paul Kehrere27f6582015-08-10 18:33:38 -05001985 .. attribute:: CERTIFICATE_POLICIES
Paul Kehrerd4f632e2015-05-12 08:25:42 -05001986
Paul Kehrere27f6582015-08-10 18:33:38 -05001987 Corresponds to the dotted string ``"2.5.29.32"``. The identifier for the
1988 :class:`~cryptography.x509.CertificatePolicies` extension type.
Paul Kehrerd4f632e2015-05-12 08:25:42 -05001989
Paul Kehrere27f6582015-08-10 18:33:38 -05001990 .. attribute:: AUTHORITY_KEY_IDENTIFIER
Paul Kehrerd4f632e2015-05-12 08:25:42 -05001991
Paul Kehrere27f6582015-08-10 18:33:38 -05001992 Corresponds to the dotted string ``"2.5.29.35"``. The identifier for the
1993 :class:`~cryptography.x509.AuthorityKeyIdentifier` extension type.
Paul Kehrerd4f632e2015-05-12 08:25:42 -05001994
Paul Kehrere27f6582015-08-10 18:33:38 -05001995 .. attribute:: EXTENDED_KEY_USAGE
Paul Kehrerd4f632e2015-05-12 08:25:42 -05001996
Paul Kehrere27f6582015-08-10 18:33:38 -05001997 Corresponds to the dotted string ``"2.5.29.37"``. The identifier for the
1998 :class:`~cryptography.x509.ExtendedKeyUsage` extension type.
Paul Kehrerd4f632e2015-05-12 08:25:42 -05001999
Paul Kehrere27f6582015-08-10 18:33:38 -05002000 .. attribute:: AUTHORITY_INFORMATION_ACCESS
Paul Kehrerd4f632e2015-05-12 08:25:42 -05002001
Paul Kehrere27f6582015-08-10 18:33:38 -05002002 Corresponds to the dotted string ``"1.3.6.1.5.5.7.1.1"``. The identifier
2003 for the :class:`~cryptography.x509.AuthorityInformationAccess` extension
2004 type.
Paul Kehrer56da2a52015-02-11 23:35:07 -06002005
Paul Kehrere27f6582015-08-10 18:33:38 -05002006 .. attribute:: INHIBIT_ANY_POLICY
Paul Kehrerb33de932015-08-06 23:41:05 +01002007
Paul Kehrere27f6582015-08-10 18:33:38 -05002008 Corresponds to the dotted string ``"2.5.29.54"``. The identifier
2009 for the :class:`~cryptography.x509.InhibitAnyPolicy` extension type.
Paul Kehrerb33de932015-08-06 23:41:05 +01002010
Paul Kehrere27f6582015-08-10 18:33:38 -05002011 .. attribute:: OCSP_NO_CHECK
Paul Kehrer4a1038e2015-05-18 10:28:31 -07002012
Paul Kehrere27f6582015-08-10 18:33:38 -05002013 Corresponds to the dotted string ``"1.3.6.1.5.5.7.48.1.5"``. The
2014 identifier for the :class:`~cryptography.x509.OCSPNoCheck` extension
2015 type.
Paul Kehrer4a1038e2015-05-18 10:28:31 -07002016
Paul Kehrer912d3fb2015-01-29 11:19:22 -06002017Exceptions
2018~~~~~~~~~~
Paul Kehrere27f6582015-08-10 18:33:38 -05002019.. currentmodule:: cryptography.x509
Paul Kehrer912d3fb2015-01-29 11:19:22 -06002020
Paul Kehrere76cd272014-12-14 19:00:51 -06002021.. class:: InvalidVersion
Paul Kehrera68fd332014-11-27 07:08:40 -10002022
2023 This is raised when an X.509 certificate has an invalid version number.
Paul Kehrer016e08a2014-11-26 09:41:18 -10002024
Paul Kehrerd5cccf72014-12-15 17:20:33 -06002025 .. attribute:: parsed_version
2026
Paul Kehrerbbffc402014-12-17 13:33:55 -06002027 :type: int
2028
2029 Returns the raw version that was parsed from the certificate.
Paul Kehrerd5cccf72014-12-15 17:20:33 -06002030
Paul Kehrerfbb7ac82015-03-16 19:26:29 -05002031.. class:: DuplicateExtension
2032
2033 This is raised when more than one X.509 extension of the same type is
2034 found within a certificate.
2035
2036 .. attribute:: oid
2037
2038 :type: :class:`ObjectIdentifier`
2039
2040 Returns the OID.
2041
2042.. class:: UnsupportedExtension
2043
2044 This is raised when a certificate contains an unsupported extension type.
2045
2046 .. attribute:: oid
2047
2048 :type: :class:`ObjectIdentifier`
2049
2050 Returns the OID.
2051
Paul Kehrerfa56a232015-03-17 13:14:03 -05002052.. class:: ExtensionNotFound
2053
2054 This is raised when calling :meth:`Extensions.get_extension_for_oid` with
2055 an extension OID that is not present in the certificate.
2056
2057 .. attribute:: oid
2058
2059 :type: :class:`ObjectIdentifier`
2060
2061 Returns the OID.
2062
Paul Kehrer9089c912015-04-20 22:15:20 -05002063.. class:: UnsupportedGeneralNameType
2064
2065 This is raised when a certificate contains an unsupported general name
2066 type in an extension.
2067
Paul Kehrerbed07352015-04-21 08:31:10 -05002068 .. attribute:: type
2069
Paul Kehrer0a621bf2015-04-22 09:22:56 -05002070 :type: int
2071
2072 The integer value of the unsupported type. The complete list of
2073 types can be found in `RFC 5280 section 4.2.1.6`_.
Paul Kehrerbed07352015-04-21 08:31:10 -05002074
Paul Kehrer016e08a2014-11-26 09:41:18 -10002075
Paul Kehrerc7c9a432015-04-19 09:20:13 -05002076.. _`RFC 5280 section 4.2.1.1`: https://tools.ietf.org/html/rfc5280#section-4.2.1.1
Paul Kehrer0a621bf2015-04-22 09:22:56 -05002077.. _`RFC 5280 section 4.2.1.6`: https://tools.ietf.org/html/rfc5280#section-4.2.1.6