blob: 4f4ce4fac345dd07aac4e76a5552d60cfa742d9b [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
Paul Kehrerd91e7c12015-10-01 16:50:42 -0500385 .. attribute:: signature
386
387 .. versionadded:: 1.2
388
389 :type: bytes
390
391 The bytes of the certificate's signature.
392
Paul Kehrerd2898052015-11-03 22:00:41 +0900393 .. attribute:: tbs_certificate_bytes
Paul Kehrerd91e7c12015-10-01 16:50:42 -0500394
395 .. versionadded:: 1.2
396
397 :type: bytes
398
399 The DER encoded bytes payload (as defined by :rfc:`5280`) that is hashed
400 and then signed by the private key of the certificate's issuer. This
401 data may be used to validate a signature, but use extreme caution as
402 certificate validation is a complex problem that involves much more
403 than just signature checks.
404
Andre Carona8aded62015-05-19 20:11:57 -0400405 .. method:: public_bytes(encoding)
406
Alex Gaynord0b376b2015-07-05 13:58:12 -0400407 .. versionadded:: 1.0
408
Andre Carona8aded62015-05-19 20:11:57 -0400409 :param encoding: The
410 :class:`~cryptography.hazmat.primitives.serialization.Encoding`
411 that will be used to serialize the certificate.
412
413 :return bytes: The data that can be written to a file or sent
414 over the network to be verified by clients.
415
Erik Trauschke2dcce902015-05-14 16:12:24 -0700416X.509 CRL (Certificate Revocation List) Object
417~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
418
419.. class:: CertificateRevocationList
420
421 .. versionadded:: 1.0
422
Erik Trauschke3cdabaf2015-10-13 09:42:53 -0700423 A CertificateRevocationList is an object representing a list of revoked
424 certificates. The object is iterable and will yield the RevokedCertificate
425 objects stored in this CRL.
426
427 .. doctest::
Erik Trauschkeb14f7d12015-10-13 09:55:39 -0700428
Erik Trauschke3cdabaf2015-10-13 09:42:53 -0700429 >>> len(crl)
430 1
Paul Kehrerdcdf9672015-10-21 20:27:28 -0500431 >>> revoked_certificate = crl[0]
432 >>> type(revoked_certificate)
Erik Trauschke3cdabaf2015-10-13 09:42:53 -0700433 <class 'cryptography.hazmat.backends.openssl.x509._RevokedCertificate'>
434 >>> for r in crl:
435 ... print(r.serial_number)
436 0
437
Erik Trauschke2dcce902015-05-14 16:12:24 -0700438 .. method:: fingerprint(algorithm)
439
440 :param algorithm: The
441 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
442 that will be used to generate the fingerprint.
443
444 :return bytes: The fingerprint using the supplied hash algorithm, as
445 bytes.
446
Erik Trauschkedc570402015-09-24 20:24:28 -0700447 .. doctest::
448
449 >>> from cryptography.hazmat.primitives import hashes
450 >>> crl.fingerprint(hashes.SHA256())
451 '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'
452
Erik Trauschke2dcce902015-05-14 16:12:24 -0700453 .. attribute:: signature_hash_algorithm
454
455 :type: :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
456
457 Returns the
458 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` which
459 was used in signing this CRL.
460
Erik Trauschkedc570402015-09-24 20:24:28 -0700461 .. doctest::
462
463 >>> from cryptography.hazmat.primitives import hashes
464 >>> isinstance(crl.signature_hash_algorithm, hashes.SHA256)
465 True
466
Erik Trauschke2dcce902015-05-14 16:12:24 -0700467 .. attribute:: issuer
468
469 :type: :class:`Name`
470
471 The :class:`Name` of the issuer.
472
Erik Trauschkedc570402015-09-24 20:24:28 -0700473 .. doctest::
474
475 >>> crl.issuer
476 <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')>])>
477
Erik Trauschke2dcce902015-05-14 16:12:24 -0700478 .. attribute:: next_update
479
480 :type: :class:`datetime.datetime`
481
482 A naïve datetime representing when the next update to this CRL is
483 expected.
484
Erik Trauschkedc570402015-09-24 20:24:28 -0700485 .. doctest::
486
487 >>> crl.next_update
488 datetime.datetime(2016, 1, 1, 0, 0)
489
Erik Trauschke2dcce902015-05-14 16:12:24 -0700490 .. attribute:: last_update
491
492 :type: :class:`datetime.datetime`
493
494 A naïve datetime representing when the this CRL was last updated.
495
Erik Trauschkedc570402015-09-24 20:24:28 -0700496 .. doctest::
Erik Trauschke2dcce902015-05-14 16:12:24 -0700497
Erik Trauschkedc570402015-09-24 20:24:28 -0700498 >>> crl.last_update
499 datetime.datetime(2015, 1, 1, 0, 0)
Erik Trauschke2dcce902015-05-14 16:12:24 -0700500
501 .. attribute:: extensions
502
503 :type: :class:`Extensions`
504
505 The extensions encoded in the CRL.
506
Erik Trauschke6abe2bb2015-11-19 10:27:01 -0800507 .. attribute:: signature
508
509 .. versionadded:: 1.2
510
511 :type: bytes
512
513 The bytes of the CRL's signature.
514
515 .. attribute:: tbs_certlist_bytes
516
517 .. versionadded:: 1.2
518
519 :type: bytes
520
521 The DER encoded bytes payload (as defined by :rfc:`5280`) that is hashed
522 and then signed by the private key of the CRL's issuer. This data may be
523 used to validate a signature, but use extreme caution as CRL validation
524 is a complex problem that involves much more than just signature checks.
525
Paul Kehrer54a837d2015-12-20 23:42:32 -0600526 .. method:: public_bytes(encoding)
527
528 .. versionadded:: 1.2
529
530 :param encoding: The
531 :class:`~cryptography.hazmat.primitives.serialization.Encoding`
532 that will be used to serialize the certificate revocation list.
533
534 :return bytes: The data that can be written to a file or sent
535 over the network and used as part of a certificate verification
536 process.
537
Erik Trauschke6abe2bb2015-11-19 10:27:01 -0800538
Andre Caron9bbfcea2015-05-18 20:55:29 -0400539X.509 Certificate Builder
540~~~~~~~~~~~~~~~~~~~~~~~~~
541
542.. class:: CertificateBuilder
543
Ian Cordasco1517a4b2015-08-02 22:11:19 -0500544 .. versionadded:: 1.0
545
546 .. doctest::
547
548 >>> from cryptography import x509
549 >>> from cryptography.hazmat.backends import default_backend
550 >>> from cryptography.hazmat.primitives import hashes
551 >>> from cryptography.hazmat.primitives.asymmetric import rsa
Paul Kehrere27f6582015-08-10 18:33:38 -0500552 >>> from cryptography.x509.oid import NameOID
Ian Cordasco1517a4b2015-08-02 22:11:19 -0500553 >>> import datetime
554 >>> import uuid
555 >>> one_day = datetime.timedelta(1, 0, 0)
556 >>> private_key = rsa.generate_private_key(
557 ... public_exponent=65537,
558 ... key_size=2048,
559 ... backend=default_backend()
560 ... )
Cory Benfieldc47b2522015-12-07 15:25:12 +0000561 >>> public_key = private_key.public_key()
Ian Cordasco1517a4b2015-08-02 22:11:19 -0500562 >>> builder = x509.CertificateBuilder()
563 >>> builder = builder.subject_name(x509.Name([
Paul Kehrere27f6582015-08-10 18:33:38 -0500564 ... x509.NameAttribute(NameOID.COMMON_NAME, u'cryptography.io'),
Ian Cordasco1517a4b2015-08-02 22:11:19 -0500565 ... ]))
566 >>> builder = builder.issuer_name(x509.Name([
Paul Kehrere27f6582015-08-10 18:33:38 -0500567 ... x509.NameAttribute(NameOID.COMMON_NAME, u'cryptography.io'),
Ian Cordasco1517a4b2015-08-02 22:11:19 -0500568 ... ]))
569 >>> builder = builder.not_valid_before(datetime.datetime.today() - one_day)
570 >>> builder = builder.not_valid_after(datetime.datetime(2018, 8, 2))
571 >>> builder = builder.serial_number(int(uuid.uuid4()))
572 >>> builder = builder.public_key(public_key)
573 >>> builder = builder.add_extension(
574 ... x509.BasicConstraints(ca=False, path_length=None), critical=True,
575 ... )
576 >>> certificate = builder.sign(
577 ... private_key=private_key, algorithm=hashes.SHA256(),
578 ... backend=default_backend()
579 ... )
580 >>> isinstance(certificate, x509.Certificate)
581 True
582
Ian Cordasco0092a0b2015-07-18 21:46:41 -0500583 .. method:: issuer_name(name)
Andre Caron9bbfcea2015-05-18 20:55:29 -0400584
585 Sets the issuer's distinguished name.
586
Ian Cordascoc9682ad2015-08-01 12:11:13 -0500587 :param name: The :class:`~cryptography.x509.Name` that describes the
588 issuer (CA).
Andre Caron9bbfcea2015-05-18 20:55:29 -0400589
Ian Cordasco0092a0b2015-07-18 21:46:41 -0500590 .. method:: subject_name(name)
Andre Caron9bbfcea2015-05-18 20:55:29 -0400591
592 Sets the subject's distinguished name.
593
Ian Cordascoc9682ad2015-08-01 12:11:13 -0500594 :param name: The :class:`~cryptography.x509.Name` that describes the
Ian Cordasco85fc4d52015-08-01 20:29:31 -0500595 subject.
Andre Caron9bbfcea2015-05-18 20:55:29 -0400596
Ian Cordasco0092a0b2015-07-18 21:46:41 -0500597 .. method:: public_key(public_key)
Andre Caron9bbfcea2015-05-18 20:55:29 -0400598
599 Sets the subject's public key.
600
Ian Cordasco8f571422015-08-02 11:31:08 -0500601 :param public_key: The subject's public key. This can be one of
602 :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey`,
603 :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey` or
604 :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey`
Andre Caron9bbfcea2015-05-18 20:55:29 -0400605
Ian Cordasco0092a0b2015-07-18 21:46:41 -0500606 .. method:: serial_number(serial_number)
Andre Caron9bbfcea2015-05-18 20:55:29 -0400607
608 Sets the certificate's serial number (an integer). The CA's policy
609 determines how it attributes serial numbers to certificates. The only
610 requirement is that this number uniquely identify the certificate given
611 the issuer.
612
613 :param serial_number: Integer number that will be used by the CA to
614 identify this certificate (most notably during certificate
Ian Cordasco17c89002015-08-02 21:13:59 -0500615 revocation checking). Users are encouraged to use a method of
616 generating 20 bytes of entropy, e.g., UUID4. For more information
Ian Cordascob7530a42015-08-02 22:47:06 -0500617 on secure random number generation, see :doc:`/random-numbers`.
Andre Caron9bbfcea2015-05-18 20:55:29 -0400618
Ian Cordasco0092a0b2015-07-18 21:46:41 -0500619 .. method:: not_valid_before(time)
Andre Caron9bbfcea2015-05-18 20:55:29 -0400620
621 Sets the certificate's activation time. This is the time from which
622 clients can start trusting the certificate. It may be different from
623 the time at which the certificate was created.
624
Ian Cordasco17c89002015-08-02 21:13:59 -0500625 :param time: The :class:`datetime.datetime` object (in UTC) that marks the
Andre Caron9bbfcea2015-05-18 20:55:29 -0400626 activation time for the certificate. The certificate may not be
627 trusted clients if it is used before this time.
628
Ian Cordasco0092a0b2015-07-18 21:46:41 -0500629 .. method:: not_valid_after(time)
Andre Caron9bbfcea2015-05-18 20:55:29 -0400630
631 Sets the certificate's expiration time. This is the time from which
632 clients should no longer trust the certificate. The CA's policy will
633 determine how long the certificate should remain in use.
634
Ian Cordasco17c89002015-08-02 21:13:59 -0500635 :param time: The :class:`datetime.datetime` object (in UTC) that marks the
Andre Caron9bbfcea2015-05-18 20:55:29 -0400636 expiration time for the certificate. The certificate may not be
637 trusted clients if it is used after this time.
638
Ian Cordasco17c89002015-08-02 21:13:59 -0500639 .. method:: add_extension(extension, critical)
Andre Caron9bbfcea2015-05-18 20:55:29 -0400640
641 Adds an X.509 extension to the certificate.
642
Paul Kehrer2c145cc2015-10-02 11:27:21 -0500643 :param extension: An extension conforming to the
644 :class:`~cryptography.x509.ExtensionType` interface.
Andre Caron9bbfcea2015-05-18 20:55:29 -0400645
Ian Cordasco17c89002015-08-02 21:13:59 -0500646 :param critical: Set to ``True`` if the extension must be understood and
647 handled by whoever reads the certificate.
648
Paul Kehrer9add80e2015-08-03 17:53:14 +0100649 .. method:: sign(private_key, algorithm, backend)
Andre Caron9bbfcea2015-05-18 20:55:29 -0400650
651 Sign the certificate using the CA's private key.
652
Ian Cordascoc5e1c252015-07-31 23:33:35 -0500653 :param private_key: The
654 :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPrivateKey`,
655 :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPrivateKey` or
656 :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePrivateKey`
657 that will be used to sign the certificate.
658
Andre Caron9bbfcea2015-05-18 20:55:29 -0400659 :param algorithm: The
660 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` that
661 will be used to generate the signature.
662
Paul Kehrer9add80e2015-08-03 17:53:14 +0100663 :param backend: Backend that will be used to build the certificate.
664 Must support the
665 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
666 interface.
667
Benjamin Peterson9ed312b2015-10-12 20:51:34 -0700668 :returns: :class:`~cryptography.x509.Certificate`
Andre Caron9bbfcea2015-05-18 20:55:29 -0400669
670
Paul Kehrer5aadb9c2015-03-11 20:48:42 -0500671X.509 CSR (Certificate Signing Request) Object
672~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600673
Paul Kehrera1a1f232015-03-15 15:34:35 -0500674.. class:: CertificateSigningRequest
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600675
676 .. versionadded:: 0.9
677
678 .. method:: public_key()
679
Alex Gaynor4c2561a2015-10-12 23:53:39 -0400680 The public key associated with the request.
681
682 :returns:
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600683 :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey` or
684 :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey` or
685 :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey`
686
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600687 .. doctest::
688
689 >>> from cryptography.hazmat.primitives.asymmetric import rsa
Paul Kehrera1a1f232015-03-15 15:34:35 -0500690 >>> public_key = csr.public_key()
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600691 >>> isinstance(public_key, rsa.RSAPublicKey)
692 True
693
694 .. attribute:: subject
695
696 :type: :class:`Name`
697
698 The :class:`Name` of the subject.
699
700 .. attribute:: signature_hash_algorithm
701
702 :type: :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
703
704 Returns the
705 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` which
706 was used in signing this request.
707
708 .. doctest::
709
710 >>> from cryptography.hazmat.primitives import hashes
Paul Kehrera1a1f232015-03-15 15:34:35 -0500711 >>> isinstance(csr.signature_hash_algorithm, hashes.SHA1)
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600712 True
713
Paul Kehrerc4e61942015-08-01 21:21:13 +0100714 .. attribute:: extensions
715
716 :type: :class:`Extensions`
717
718 The extensions encoded in the certificate signing request.
719
720 :raises cryptography.x509.DuplicateExtension: If more than one
Paul Kehrer24283d22015-08-01 21:31:19 +0100721 extension of the same type is found within the certificate signing request.
Paul Kehrerc4e61942015-08-01 21:21:13 +0100722
Paul Kehrer24283d22015-08-01 21:31:19 +0100723 :raises cryptography.x509.UnsupportedExtension: If the certificate signing request
Paul Kehrerc4e61942015-08-01 21:21:13 +0100724 contains an extension that is not supported.
725
726 :raises cryptography.x509.UnsupportedGeneralNameType: If an extension
727 contains a general name that is not supported.
728
729 :raises UnicodeError: If an extension contains IDNA encoding that is
730 invalid or not compliant with IDNA 2008.
731
732
Andre Caron476c5df2015-05-18 10:23:28 -0400733 .. method:: public_bytes(encoding)
734
Alex Gaynord0b376b2015-07-05 13:58:12 -0400735 .. versionadded:: 1.0
736
Andre Caron476c5df2015-05-18 10:23:28 -0400737 :param encoding: The
738 :class:`~cryptography.hazmat.primitives.serialization.Encoding`
739 that will be used to serialize the certificate request.
740
741 :return bytes: The data that can be written to a file or sent
742 over the network to be signed by the certificate
743 authority.
744
Paul Kehrerab209392015-12-01 14:50:31 -0600745 .. attribute:: signature
746
747 .. versionadded:: 1.2
748
749 :type: bytes
750
751 The bytes of the certificate signing request's signature.
752
753 .. attribute:: tbs_certrequest_bytes
754
755 .. versionadded:: 1.2
756
757 :type: bytes
758
759 The DER encoded bytes payload (as defined by :rfc:`2986`) that is
760 hashed and then signed by the private key (corresponding to the public
761 key embedded in the CSR). This data may be used to validate the CSR
762 signature.
763
Erik Trauschke2dcce902015-05-14 16:12:24 -0700764X.509 Revoked Certificate Object
Erik Trauschkec5a8d172015-05-28 10:24:25 -0700765~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Erik Trauschke2dcce902015-05-14 16:12:24 -0700766
767.. class:: RevokedCertificate
768
769 .. versionadded:: 1.0
770
771 .. attribute:: serial_number
772
773 :type: :class:`int`
774
775 An integer representing the serial number of the revoked certificate.
776
Erik Trauschkedc570402015-09-24 20:24:28 -0700777 .. doctest::
778
Erik Trauschke3cdabaf2015-10-13 09:42:53 -0700779 >>> revoked_certificate.serial_number
Erik Trauschkedc570402015-09-24 20:24:28 -0700780 0
781
Erik Trauschke2dcce902015-05-14 16:12:24 -0700782 .. attribute:: revocation_date
783
784 :type: :class:`datetime.datetime`
785
786 A naïve datetime representing the date this certificates was revoked.
787
Erik Trauschkedc570402015-09-24 20:24:28 -0700788 .. doctest::
789
Erik Trauschke77f5a252015-10-14 08:06:38 -0700790 >>> revoked_certificate.revocation_date
Erik Trauschkedc570402015-09-24 20:24:28 -0700791 datetime.datetime(2015, 1, 1, 0, 0)
792
Erik Trauschke2dcce902015-05-14 16:12:24 -0700793 .. attribute:: extensions
794
795 :type: :class:`Extensions`
796
797 The extensions encoded in the revoked certificate.
Andre Caron476c5df2015-05-18 10:23:28 -0400798
Erik Trauschkedc570402015-09-24 20:24:28 -0700799 .. doctest::
800
Erik Trauschke77f5a252015-10-14 08:06:38 -0700801 >>> for ext in revoked_certificate.extensions:
Erik Trauschkedc570402015-09-24 20:24:28 -0700802 ... print(ext)
803 <Extension(oid=<ObjectIdentifier(oid=2.5.29.24, name=invalidityDate)>, critical=False, value=2015-01-01 00:00:00)>
804 <Extension(oid=<ObjectIdentifier(oid=2.5.29.21, name=cRLReason)>, critical=False, value=ReasonFlags.key_compromise)>
805
Andre Caron0ef595f2015-05-18 13:53:43 -0400806X.509 CSR (Certificate Signing Request) Builder Object
807~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
808
809.. class:: CertificateSigningRequestBuilder
810
Andre Carond259ee52015-06-02 23:47:11 -0400811 .. versionadded:: 1.0
812
813 .. doctest::
814
815 >>> from cryptography import x509
816 >>> from cryptography.hazmat.backends import default_backend
817 >>> from cryptography.hazmat.primitives import hashes
818 >>> from cryptography.hazmat.primitives.asymmetric import rsa
Paul Kehrere27f6582015-08-10 18:33:38 -0500819 >>> from cryptography.x509.oid import NameOID
Andre Carond259ee52015-06-02 23:47:11 -0400820 >>> private_key = rsa.generate_private_key(
821 ... public_exponent=65537,
822 ... key_size=2048,
823 ... backend=default_backend()
824 ... )
825 >>> builder = x509.CertificateSigningRequestBuilder()
Andre Carona9a51172015-06-06 20:18:44 -0400826 >>> builder = builder.subject_name(x509.Name([
Paul Kehrere27f6582015-08-10 18:33:38 -0500827 ... x509.NameAttribute(NameOID.COMMON_NAME, u'cryptography.io'),
Andre Carond259ee52015-06-02 23:47:11 -0400828 ... ]))
Ian Cordascof06b6be2015-06-21 10:09:18 -0500829 >>> builder = builder.add_extension(
Ian Cordasco0112b022015-06-16 17:51:18 -0500830 ... x509.BasicConstraints(ca=False, path_length=None), critical=True,
Andre Caron472fd692015-06-06 20:04:44 -0400831 ... )
Andre Carond259ee52015-06-02 23:47:11 -0400832 >>> request = builder.sign(
Alex Gaynorde9e5842015-06-26 20:11:23 -0400833 ... private_key, hashes.SHA256(), default_backend()
Andre Carond259ee52015-06-02 23:47:11 -0400834 ... )
835 >>> isinstance(request, x509.CertificateSigningRequest)
836 True
837
Andre Carona9a51172015-06-06 20:18:44 -0400838 .. method:: subject_name(name)
Andre Caron0ef595f2015-05-18 13:53:43 -0400839
Andre Caron341ff852015-06-06 20:14:31 -0400840 :param name: The :class:`~cryptography.x509.Name` of the certificate
841 subject.
842 :returns: A new
843 :class:`~cryptography.x509.CertificateSigningRequestBuilder`.
Andre Caron0ef595f2015-05-18 13:53:43 -0400844
Ian Cordascof06b6be2015-06-21 10:09:18 -0500845 .. method:: add_extension(extension, critical)
Andre Caron0ef595f2015-05-18 13:53:43 -0400846
Paul Kehrer2c145cc2015-10-02 11:27:21 -0500847 :param extension: An extension conforming to the
848 :class:`~cryptography.x509.ExtensionType` interface.
Andre Caron472fd692015-06-06 20:04:44 -0400849 :param critical: Set to `True` if the extension must be understood and
850 handled by whoever reads the certificate.
Andre Caron341ff852015-06-06 20:14:31 -0400851 :returns: A new
852 :class:`~cryptography.x509.CertificateSigningRequestBuilder`.
Andre Caron0ef595f2015-05-18 13:53:43 -0400853
Alex Gaynorb3b0fbe2015-06-26 19:57:18 -0400854 .. method:: sign(private_key, algorithm, backend)
Andre Caron0ef595f2015-05-18 13:53:43 -0400855
856 :param backend: Backend that will be used to sign the request.
857 Must support the
858 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
859 interface.
860
861 :param private_key: The
Andre Caron24f9bf42015-06-06 20:14:54 -0400862 :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPrivateKey`,
863 :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPrivateKey` or
864 :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePrivateKey`
Andre Caron0ef595f2015-05-18 13:53:43 -0400865 that will be used to sign the request. When the request is
866 signed by a certificate authority, the private key's associated
867 public key will be stored in the resulting certificate.
868
869 :param algorithm: The
870 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
871 that will be used to generate the request signature.
872
Andre Caron341ff852015-06-06 20:14:31 -0400873 :returns: A new
874 :class:`~cryptography.x509.CertificateSigningRequest`.
Andre Caron0ef595f2015-05-18 13:53:43 -0400875
876
Paul Kehrer719d5362015-01-01 20:03:52 -0600877.. class:: Name
878
879 .. versionadded:: 0.8
880
Paul Kehrer53d8d492015-02-13 18:47:30 -0600881 An X509 Name is an ordered list of attributes. The object is iterable to
Paul Kehrerd21596e2015-02-14 09:17:26 -0600882 get every attribute or you can use :meth:`Name.get_attributes_for_oid` to
Paul Kehrer719d5362015-01-01 20:03:52 -0600883 obtain the specific type you want. Names are sometimes represented as a
Paul Kehrer53d8d492015-02-13 18:47:30 -0600884 slash or comma delimited string (e.g. ``/CN=mydomain.com/O=My Org/C=US`` or
885 ``CN=mydomain.com, O=My Org, C=US``).
Paul Kehrer719d5362015-01-01 20:03:52 -0600886
Paul Kehrer53d8d492015-02-13 18:47:30 -0600887 .. doctest::
Paul Kehrer719d5362015-01-01 20:03:52 -0600888
Paul Kehrer8b21a4a2015-02-14 07:56:36 -0600889 >>> len(cert.subject)
Paul Kehrer53d8d492015-02-13 18:47:30 -0600890 3
Paul Kehrer8b21a4a2015-02-14 07:56:36 -0600891 >>> for attribute in cert.subject:
892 ... print(attribute)
893 <NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.6, name=countryName)>, value=u'US')>
894 <NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.10, name=organizationName)>, value=u'Test Certificates 2011')>
895 <NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.3, name=commonName)>, value=u'Good CA')>
Paul Kehrer719d5362015-01-01 20:03:52 -0600896
Paul Kehrere901d642015-02-11 18:50:58 -0600897 .. method:: get_attributes_for_oid(oid)
Paul Kehrer719d5362015-01-01 20:03:52 -0600898
Paul Kehrere901d642015-02-11 18:50:58 -0600899 :param oid: An :class:`ObjectIdentifier` instance.
Paul Kehrer719d5362015-01-01 20:03:52 -0600900
Paul Kehrere901d642015-02-11 18:50:58 -0600901 :returns: A list of :class:`NameAttribute` instances that match the
902 OID provided. If nothing matches an empty list will be returned.
Paul Kehrer719d5362015-01-01 20:03:52 -0600903
904 .. doctest::
905
Paul Kehrere27f6582015-08-10 18:33:38 -0500906 >>> cert.subject.get_attributes_for_oid(NameOID.COMMON_NAME)
Paul Kehrere901d642015-02-11 18:50:58 -0600907 [<NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.3, name=commonName)>, value=u'Good CA')>]
Paul Kehrerb2de9482014-12-11 14:54:48 -0600908
Paul Kehrere76cd272014-12-14 19:00:51 -0600909.. class:: Version
Paul Kehrer016e08a2014-11-26 09:41:18 -1000910
911 .. versionadded:: 0.7
912
913 An enumeration for X.509 versions.
914
915 .. attribute:: v1
916
917 For version 1 X.509 certificates.
918
919 .. attribute:: v3
920
921 For version 3 X.509 certificates.
922
Paul Kehrer806bfb22015-02-02 17:05:24 -0600923.. class:: NameAttribute
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600924
925 .. versionadded:: 0.8
926
Paul Kehrer834d22f2015-02-06 11:01:07 -0600927 An X.509 name consists of a list of NameAttribute instances.
Paul Kehrer5b0a8d62015-01-30 20:05:55 -0600928
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600929 .. attribute:: oid
930
931 :type: :class:`ObjectIdentifier`
932
933 The attribute OID.
934
935 .. attribute:: value
936
Paul Kehrerd5852cb2015-01-30 08:25:23 -0600937 :type: :term:`text`
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600938
939 The value of the attribute.
940
941.. class:: ObjectIdentifier
942
943 .. versionadded:: 0.8
944
Paul Kehrer5b0a8d62015-01-30 20:05:55 -0600945 Object identifiers (frequently seen abbreviated as OID) identify the type
Paul Kehrer806bfb22015-02-02 17:05:24 -0600946 of a value (see: :class:`NameAttribute`).
Paul Kehrer5b0a8d62015-01-30 20:05:55 -0600947
Paul Kehrerd44f9a62015-02-04 14:47:34 -0600948 .. attribute:: dotted_string
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600949
950 :type: :class:`str`
951
Paul Kehrerfedf4f42015-02-06 11:22:07 -0600952 The dotted string value of the OID (e.g. ``"2.5.4.3"``)
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600953
Paul Kehrer31bdf792015-03-25 14:11:00 -0500954.. _general_name_classes:
955
956General Name Classes
957~~~~~~~~~~~~~~~~~~~~
958
959.. class:: GeneralName
960
961 .. versionadded:: 0.9
962
963 This is the generic interface that all the following classes are registered
964 against.
965
Paul Kehrer47c32ba2015-10-28 09:12:07 +0900966.. class:: RFC822Name(value)
Paul Kehrer31bdf792015-03-25 14:11:00 -0500967
968 .. versionadded:: 0.9
969
970 This corresponds to an email address. For example, ``user@example.com``.
971
972 .. attribute:: value
973
974 :type: :term:`text`
975
Paul Kehrer47c32ba2015-10-28 09:12:07 +0900976.. class:: DNSName(value)
Paul Kehrer31bdf792015-03-25 14:11:00 -0500977
978 .. versionadded:: 0.9
979
980 This corresponds to a domain name. For example, ``cryptography.io``.
981
982 .. attribute:: value
983
984 :type: :term:`text`
985
Paul Kehrer47c32ba2015-10-28 09:12:07 +0900986.. class:: DirectoryName(value)
Paul Kehrer31bdf792015-03-25 14:11:00 -0500987
988 .. versionadded:: 0.9
989
990 This corresponds to a directory name.
991
992 .. attribute:: value
993
994 :type: :class:`Name`
995
Paul Kehrer47c32ba2015-10-28 09:12:07 +0900996.. class:: UniformResourceIdentifier(value)
Paul Kehrer31bdf792015-03-25 14:11:00 -0500997
998 .. versionadded:: 0.9
999
1000 This corresponds to a uniform resource identifier. For example,
Paul Kehrerb8ef82e2015-04-22 16:04:24 -05001001 ``https://cryptography.io``. The URI is parsed and IDNA decoded (see
1002 :rfc:`5895`).
1003
1004 .. note::
1005
1006 URIs that do not contain ``://`` in them will not be decoded.
Paul Kehrer31bdf792015-03-25 14:11:00 -05001007
1008 .. attribute:: value
1009
1010 :type: :term:`text`
1011
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001012.. class:: IPAddress(value)
Paul Kehrer31bdf792015-03-25 14:11:00 -05001013
1014 .. versionadded:: 0.9
1015
1016 This corresponds to an IP address.
1017
1018 .. attribute:: value
1019
Paul Kehrereb177932015-05-17 18:33:33 -07001020 :type: :class:`~ipaddress.IPv4Address`,
1021 :class:`~ipaddress.IPv6Address`, :class:`~ipaddress.IPv4Network`,
1022 or :class:`~ipaddress.IPv6Network`.
Paul Kehrer31bdf792015-03-25 14:11:00 -05001023
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001024.. class:: RegisteredID(value)
Paul Kehrer31bdf792015-03-25 14:11:00 -05001025
1026 .. versionadded:: 0.9
1027
1028 This corresponds to a registered ID.
1029
1030 .. attribute:: value
1031
1032 :type: :class:`ObjectIdentifier`
1033
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001034.. class:: OtherName(type_id, value)
Joshua Tauberer2ee5e3c2015-07-04 20:09:46 +00001035
1036 .. versionadded:: 1.0
1037
Joshua Tauberer18b6fc82015-07-05 21:44:51 +00001038 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 +00001039
1040 .. attribute:: type_id
1041
1042 :type: :class:`ObjectIdentifier`
1043
1044 .. attribute:: value
1045
1046 :type: `bytes`
1047
Paul Kehrer8cf26422015-03-21 09:50:24 -05001048X.509 Extensions
1049~~~~~~~~~~~~~~~~
1050
Paul Kehrerfbb7ac82015-03-16 19:26:29 -05001051.. class:: Extensions
1052
1053 .. versionadded:: 0.9
1054
1055 An X.509 Extensions instance is an ordered list of extensions. The object
1056 is iterable to get every extension.
1057
Paul Kehrerfa56a232015-03-17 13:14:03 -05001058 .. method:: get_extension_for_oid(oid)
1059
1060 :param oid: An :class:`ObjectIdentifier` instance.
1061
1062 :returns: An instance of the extension class.
1063
1064 :raises cryptography.x509.ExtensionNotFound: If the certificate does
1065 not have the extension requested.
1066
Paul Kehrerfa56a232015-03-17 13:14:03 -05001067 .. doctest::
1068
Paul Kehrere27f6582015-08-10 18:33:38 -05001069 >>> from cryptography.x509.oid import ExtensionOID
1070 >>> cert.extensions.get_extension_for_oid(ExtensionOID.BASIC_CONSTRAINTS)
Paul Kehrerfa56a232015-03-17 13:14:03 -05001071 <Extension(oid=<ObjectIdentifier(oid=2.5.29.19, name=basicConstraints)>, critical=True, value=<BasicConstraints(ca=True, path_length=None)>)>
1072
Phoebe Queen019b7f82015-08-12 03:52:03 +01001073 .. method:: get_extension_for_class(extclass)
1074
Phoebe Queen6a603eb2015-08-12 14:14:49 +01001075 .. versionadded:: 1.1
1076
Phoebe Queen019b7f82015-08-12 03:52:03 +01001077 :param extclass: An extension class.
1078
1079 :returns: An instance of the extension class.
1080
1081 :raises cryptography.x509.ExtensionNotFound: If the certificate does
1082 not have the extension requested.
1083
1084 .. doctest::
1085
1086 >>> from cryptography import x509
1087 >>> cert.extensions.get_extension_for_class(x509.BasicConstraints)
1088 <Extension(oid=<ObjectIdentifier(oid=2.5.29.19, name=basicConstraints)>, critical=True, value=<BasicConstraints(ca=True, path_length=None)>)>
1089
Paul Kehrer8cf26422015-03-21 09:50:24 -05001090.. class:: Extension
1091
1092 .. versionadded:: 0.9
1093
Paul Kehrer85894662015-03-22 13:19:31 -05001094 .. attribute:: oid
1095
1096 :type: :class:`ObjectIdentifier`
1097
Paul Kehrere27f6582015-08-10 18:33:38 -05001098 One of the :class:`~cryptography.x509.oid.ExtensionOID` OIDs.
Paul Kehrer8cf26422015-03-21 09:50:24 -05001099
1100 .. attribute:: critical
1101
1102 :type: bool
1103
Paul Kehrer58b75692015-03-22 23:24:58 -05001104 Determines whether a given extension is critical or not. :rfc:`5280`
1105 requires that "A certificate-using system MUST reject the certificate
1106 if it encounters a critical extension it does not recognize or a
1107 critical extension that contains information that it cannot process".
Paul Kehrer8cf26422015-03-21 09:50:24 -05001108
Paul Kehrer85894662015-03-22 13:19:31 -05001109 .. attribute:: value
1110
1111 Returns an instance of the extension type corresponding to the OID.
1112
Paul Kehrer14f0bd02015-08-06 11:55:18 +01001113.. class:: ExtensionType
1114
1115 .. versionadded:: 1.0
1116
1117 This is the interface against which all the following extension types are
1118 registered.
1119
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001120.. 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 -05001121
1122 .. versionadded:: 0.9
1123
1124 The key usage extension defines the purpose of the key contained in the
1125 certificate. The usage restriction might be employed when a key that could
Paul Kehrerb33de932015-08-06 23:41:05 +01001126 be used for more than one operation is to be restricted.
Paul Kehrercecbbba2015-03-30 14:58:38 -05001127
Paul Kehrer822f3d32015-08-06 11:47:32 +01001128 .. attribute:: oid
1129
1130 .. versionadded:: 1.0
1131
1132 :type: :class:`ObjectIdentifier`
1133
Paul Kehrere27f6582015-08-10 18:33:38 -05001134 Returns :attr:`~cryptography.x509.oid.ExtensionOID.KEY_USAGE`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001135
Paul Kehrercecbbba2015-03-30 14:58:38 -05001136 .. attribute:: digital_signature
1137
1138 :type: bool
1139
Paul Kehrer738407b2015-04-01 22:39:02 -05001140 This purpose is set to true when the subject public key is used for verifying
Paul Kehrercecbbba2015-03-30 14:58:38 -05001141 digital signatures, other than signatures on certificates
1142 (``key_cert_sign``) and CRLs (``crl_sign``).
1143
1144 .. attribute:: content_commitment
1145
1146 :type: bool
1147
Paul Kehrer738407b2015-04-01 22:39:02 -05001148 This purpose is set to true when the subject public key is used for verifying
Paul Kehrercecbbba2015-03-30 14:58:38 -05001149 digital signatures, other than signatures on certificates
1150 (``key_cert_sign``) and CRLs (``crl_sign``). It is used to provide a
1151 non-repudiation service that protects against the signing entity
1152 falsely denying some action. In the case of later conflict, a
1153 reliable third party may determine the authenticity of the signed
1154 data. This was called ``non_repudiation`` in older revisions of the
1155 X.509 specification.
1156
1157 .. attribute:: key_encipherment
1158
1159 :type: bool
1160
Paul Kehrer738407b2015-04-01 22:39:02 -05001161 This purpose is set to true when the subject public key is used for
1162 enciphering private or secret keys.
Paul Kehrercecbbba2015-03-30 14:58:38 -05001163
1164 .. attribute:: data_encipherment
1165
1166 :type: bool
1167
Paul Kehrer738407b2015-04-01 22:39:02 -05001168 This purpose is set to true when the subject public key is used for
1169 directly enciphering raw user data without the use of an intermediate
1170 symmetric cipher.
Paul Kehrercecbbba2015-03-30 14:58:38 -05001171
1172 .. attribute:: key_agreement
1173
1174 :type: bool
1175
Paul Kehrer738407b2015-04-01 22:39:02 -05001176 This purpose is set to true when the subject public key is used for key
1177 agreement. For example, when a Diffie-Hellman key is to be used for
1178 key management, then this purpose is set to true.
Paul Kehrercecbbba2015-03-30 14:58:38 -05001179
1180 .. attribute:: key_cert_sign
1181
1182 :type: bool
1183
Paul Kehrer738407b2015-04-01 22:39:02 -05001184 This purpose is set to true when the subject public key is used for
1185 verifying signatures on public key certificates. If this purpose is set
1186 to true then ``ca`` must be true in the :class:`BasicConstraints`
1187 extension.
Paul Kehrercecbbba2015-03-30 14:58:38 -05001188
1189 .. attribute:: crl_sign
1190
1191 :type: bool
1192
Paul Kehrer738407b2015-04-01 22:39:02 -05001193 This purpose is set to true when the subject public key is used for
1194 verifying signatures on certificate revocation lists.
Paul Kehrercecbbba2015-03-30 14:58:38 -05001195
1196 .. attribute:: encipher_only
1197
1198 :type: bool
1199
Paul Kehrer738407b2015-04-01 22:39:02 -05001200 When this purposes is set to true and the ``key_agreement`` purpose is
1201 also set, the subject public key may be used only for enciphering data
1202 while performing key agreement.
Paul Kehrercecbbba2015-03-30 14:58:38 -05001203
1204 :raises ValueError: This is raised if accessed when ``key_agreement``
1205 is false.
1206
1207 .. attribute:: decipher_only
1208
1209 :type: bool
1210
Paul Kehrer738407b2015-04-01 22:39:02 -05001211 When this purposes is set to true and the ``key_agreement`` purpose is
1212 also set, the subject public key may be used only for deciphering data
1213 while performing key agreement.
Paul Kehrercecbbba2015-03-30 14:58:38 -05001214
1215 :raises ValueError: This is raised if accessed when ``key_agreement``
1216 is false.
1217
1218
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001219.. class:: BasicConstraints(ca, path_length)
Paul Kehrer8cf26422015-03-21 09:50:24 -05001220
1221 .. versionadded:: 0.9
1222
Paul Kehrer85894662015-03-22 13:19:31 -05001223 Basic constraints is an X.509 extension type that defines whether a given
Paul Kehrer8cf26422015-03-21 09:50:24 -05001224 certificate is allowed to sign additional certificates and what path
Paul Kehrerb33de932015-08-06 23:41:05 +01001225 length restrictions may exist.
Paul Kehrer8cf26422015-03-21 09:50:24 -05001226
Paul Kehrer822f3d32015-08-06 11:47:32 +01001227 .. attribute:: oid
1228
1229 .. versionadded:: 1.0
1230
1231 :type: :class:`ObjectIdentifier`
1232
Paul Kehrere27f6582015-08-10 18:33:38 -05001233 Returns :attr:`~cryptography.x509.oid.ExtensionOID.BASIC_CONSTRAINTS`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001234
Paul Kehrer8cf26422015-03-21 09:50:24 -05001235 .. attribute:: ca
1236
1237 :type: bool
1238
1239 Whether the certificate can sign certificates.
1240
1241 .. attribute:: path_length
1242
Paul Kehrerfd1444c2015-03-21 19:47:05 -05001243 :type: int or None
Paul Kehrer8cf26422015-03-21 09:50:24 -05001244
1245 The maximum path length for certificates subordinate to this
1246 certificate. This attribute only has meaning if ``ca`` is true.
1247 If ``ca`` is true then a path length of None means there's no
1248 restriction on the number of subordinate CAs in the certificate chain.
Alex Gaynor99c5f152015-05-03 10:01:04 -04001249 If it is zero or greater then it defines the maximum length for a
1250 subordinate CA's certificate chain. For example, a ``path_length`` of 1
1251 means the certificate can sign a subordinate CA, but the subordinate CA
1252 is not allowed to create subordinates with ``ca`` set to true.
Paul Kehrer8cf26422015-03-21 09:50:24 -05001253
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001254.. class:: ExtendedKeyUsage(usages)
Paul Kehrerffa2a152015-03-31 08:18:25 -05001255
1256 .. versionadded:: 0.9
1257
1258 This extension indicates one or more purposes for which the certified
1259 public key may be used, in addition to or in place of the basic
1260 purposes indicated in the key usage extension. The object is
Paul Kehrere27f6582015-08-10 18:33:38 -05001261 iterable to obtain the list of
1262 :class:`~cryptography.x509.oid.ExtendedKeyUsageOID` OIDs present.
Paul Kehrerffa2a152015-03-31 08:18:25 -05001263
Paul Kehrer1cb9e552015-10-28 09:37:29 +09001264 :param list usages: A list of
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001265 :class:`~cryptography.x509.oid.ExtendedKeyUsageOID` OIDs.
1266
Paul Kehrer822f3d32015-08-06 11:47:32 +01001267 .. attribute:: oid
1268
1269 .. versionadded:: 1.0
1270
1271 :type: :class:`ObjectIdentifier`
1272
Paul Kehrere27f6582015-08-10 18:33:38 -05001273 Returns :attr:`~cryptography.x509.oid.ExtensionOID.EXTENDED_KEY_USAGE`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001274
1275
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001276.. class:: OCSPNoCheck()
Paul Kehrer4a1038e2015-05-18 10:28:31 -07001277
Paul Kehrer506a2152015-05-26 08:01:18 -05001278 .. versionadded:: 1.0
Paul Kehrer4a1038e2015-05-18 10:28:31 -07001279
1280 This presence of this extension indicates that an OCSP client can trust a
1281 responder for the lifetime of the responder's certificate. CAs issuing
1282 such a certificate should realize that a compromise of the responder's key
1283 is as serious as the compromise of a CA key used to sign CRLs, at least for
1284 the validity period of this certificate. CA's may choose to issue this type
1285 of certificate with a very short lifetime and renew it frequently. This
1286 extension is only relevant when the certificate is an authorized OCSP
1287 responder.
1288
Paul Kehrer822f3d32015-08-06 11:47:32 +01001289 .. attribute:: oid
1290
1291 .. versionadded:: 1.0
1292
1293 :type: :class:`ObjectIdentifier`
1294
Paul Kehrere27f6582015-08-10 18:33:38 -05001295 Returns :attr:`~cryptography.x509.oid.ExtensionOID.OCSP_NO_CHECK`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001296
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001297.. class:: NameConstraints(permitted_subtrees, excluded_subtrees)
Paul Kehrere0017be2015-05-17 20:39:40 -06001298
1299 .. versionadded:: 1.0
1300
1301 The name constraints extension, which only has meaning in a CA certificate,
1302 defines a name space within which all subject names in certificates issued
1303 beneath the CA certificate must (or must not) be in. For specific details
1304 on the way this extension should be processed see :rfc:`5280`.
1305
Paul Kehrer822f3d32015-08-06 11:47:32 +01001306 .. attribute:: oid
1307
1308 .. versionadded:: 1.0
1309
1310 :type: :class:`ObjectIdentifier`
1311
Paul Kehrere27f6582015-08-10 18:33:38 -05001312 Returns :attr:`~cryptography.x509.oid.ExtensionOID.NAME_CONSTRAINTS`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001313
Paul Kehrere0017be2015-05-17 20:39:40 -06001314 .. attribute:: permitted_subtrees
1315
1316 :type: list of :class:`GeneralName` objects or None
1317
1318 The set of permitted name patterns. If a name matches this and an
1319 element in ``excluded_subtrees`` it is invalid. At least one of
1320 ``permitted_subtrees`` and ``excluded_subtrees`` will be non-None.
1321
1322 .. attribute:: excluded_subtrees
1323
1324 :type: list of :class:`GeneralName` objects or None
1325
1326 Any name matching a restriction in the ``excluded_subtrees`` field is
1327 invalid regardless of information appearing in the
1328 ``permitted_subtrees``. At least one of ``permitted_subtrees`` and
1329 ``excluded_subtrees`` will be non-None.
1330
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001331.. class:: AuthorityKeyIdentifier(key_identifier, authority_cert_issuer, authority_cert_serial_number)
Paul Kehrer2eb4ed92015-04-11 15:33:45 -04001332
1333 .. versionadded:: 0.9
1334
1335 The authority key identifier extension provides a means of identifying the
1336 public key corresponding to the private key used to sign a certificate.
Paul Kehrer8c8cd722015-04-19 09:15:04 -05001337 This extension is typically used to assist in determining the appropriate
1338 certificate chain. For more information about generation and use of this
1339 extension see `RFC 5280 section 4.2.1.1`_.
Paul Kehrer2eb4ed92015-04-11 15:33:45 -04001340
Paul Kehrer822f3d32015-08-06 11:47:32 +01001341 .. attribute:: oid
1342
1343 .. versionadded:: 1.0
1344
1345 :type: :class:`ObjectIdentifier`
1346
Paul Kehrere27f6582015-08-10 18:33:38 -05001347 Returns
1348 :attr:`~cryptography.x509.oid.ExtensionOID.AUTHORITY_KEY_IDENTIFIER`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001349
Paul Kehrer2eb4ed92015-04-11 15:33:45 -04001350 .. attribute:: key_identifier
1351
1352 :type: bytes
1353
Paul Kehrer9104b1d2015-04-18 09:23:44 -05001354 A value derived from the public key used to verify the certificate's
Paul Kehrer8c8cd722015-04-19 09:15:04 -05001355 signature.
Paul Kehrer9104b1d2015-04-18 09:23:44 -05001356
Paul Kehrer2eb4ed92015-04-11 15:33:45 -04001357 .. attribute:: authority_cert_issuer
1358
1359 :type: :class:`Name` or None
1360
Paul Kehrer9104b1d2015-04-18 09:23:44 -05001361 The :class:`Name` of the issuer's issuer.
1362
Paul Kehrer2eb4ed92015-04-11 15:33:45 -04001363 .. attribute:: authority_cert_serial_number
1364
1365 :type: int or None
1366
Paul Kehrer9104b1d2015-04-18 09:23:44 -05001367 The serial number of the issuer's issuer.
1368
Paul Kehrer253929a2015-08-05 17:30:39 +01001369 .. classmethod:: from_issuer_public_key(public_key)
1370
1371 .. versionadded:: 1.0
1372
1373 Creates a new AuthorityKeyIdentifier instance using the public key
1374 provided to generate the appropriate digest. This should be the
Paul Kehrer26ac47f2015-08-08 15:20:52 -05001375 **issuer's public key**. The resulting object will contain
1376 :attr:`~cryptography.x509.AuthorityKeyIdentifier.key_identifier`, but
1377 :attr:`~cryptography.x509.AuthorityKeyIdentifier.authority_cert_issuer`
1378 and
1379 :attr:`~cryptography.x509.AuthorityKeyIdentifier.authority_cert_serial_number`
1380 will be None.
1381 The generated ``key_identifier`` is the SHA1 hash of the ``subjectPublicKey``
1382 ASN.1 bit string. This is the first recommendation in :rfc:`5280`
Paul Kehrer253929a2015-08-05 17:30:39 +01001383 section 4.2.1.2.
1384
Paul Kehrercc671822015-08-08 15:41:54 -05001385 :param public_key: One of
1386 :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey`
1387 ,
1388 :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey`
1389 , or
1390 :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey`.
Paul Kehrer253929a2015-08-05 17:30:39 +01001391
1392 .. doctest::
1393
1394 >>> from cryptography import x509
1395 >>> from cryptography.hazmat.backends import default_backend
Paul Kehrercc671822015-08-08 15:41:54 -05001396 >>> issuer_cert = x509.load_pem_x509_certificate(pem_data, default_backend())
1397 >>> x509.AuthorityKeyIdentifier.from_issuer_public_key(issuer_cert.public_key())
Paul Kehrer253929a2015-08-05 17:30:39 +01001398 <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)>
1399
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001400.. class:: SubjectKeyIdentifier(digest)
Paul Kehrer1eb82a62015-03-31 20:00:33 -05001401
1402 .. versionadded:: 0.9
1403
1404 The subject key identifier extension provides a means of identifying
1405 certificates that contain a particular public key.
1406
Paul Kehrer822f3d32015-08-06 11:47:32 +01001407 .. attribute:: oid
1408
1409 .. versionadded:: 1.0
1410
1411 :type: :class:`ObjectIdentifier`
1412
Paul Kehrere27f6582015-08-10 18:33:38 -05001413 Returns
1414 :attr:`~cryptography.x509.oid.ExtensionOID.SUBJECT_KEY_IDENTIFIER`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001415
Paul Kehrer1eb82a62015-03-31 20:00:33 -05001416 .. attribute:: digest
1417
1418 :type: bytes
1419
1420 The binary value of the identifier.
1421
Paul Kehrerd4a7f062015-08-05 18:32:18 +01001422 .. classmethod:: from_public_key(public_key)
Paul Kehrerf22f6122015-08-05 12:57:13 +01001423
1424 .. versionadded:: 1.0
1425
1426 Creates a new SubjectKeyIdentifier instance using the public key
1427 provided to generate the appropriate digest. This should be the public
Paul Kehrereb9ec002015-08-08 10:03:02 -05001428 key that is in the certificate. The generated digest is the SHA1 hash
1429 of the ``subjectPublicKey`` ASN.1 bit string. This is the first
1430 recommendation in :rfc:`5280` section 4.2.1.2.
Paul Kehrerf22f6122015-08-05 12:57:13 +01001431
1432 :param public_key: One of
1433 :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey`
1434 ,
1435 :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey`
1436 , or
1437 :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey`.
1438
Paul Kehrer253929a2015-08-05 17:30:39 +01001439 .. doctest::
1440
1441 >>> from cryptography import x509
1442 >>> from cryptography.hazmat.backends import default_backend
Paul Kehrercc671822015-08-08 15:41:54 -05001443 >>> csr = x509.load_pem_x509_csr(pem_req_data, default_backend())
1444 >>> x509.SubjectKeyIdentifier.from_public_key(csr.public_key())
1445 <SubjectKeyIdentifier(digest='\xdb\xaa\xf0\x06\x11\xdbD\xfe\xbf\x93\x03\x8av\x88WP7\xa6\x91\xf7')>
Paul Kehrer253929a2015-08-05 17:30:39 +01001446
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001447.. class:: SubjectAlternativeName(general_names)
Paul Kehrer31bdf792015-03-25 14:11:00 -05001448
1449 .. versionadded:: 0.9
1450
1451 Subject alternative name is an X.509 extension that provides a list of
1452 :ref:`general name <general_name_classes>` instances that provide a set
1453 of identities for which the certificate is valid. The object is iterable to
1454 get every element.
1455
Paul Kehrer1cb9e552015-10-28 09:37:29 +09001456 :param list general_names: A list of :class:`GeneralName` instances.
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001457
Paul Kehrer822f3d32015-08-06 11:47:32 +01001458 .. attribute:: oid
1459
1460 .. versionadded:: 1.0
1461
1462 :type: :class:`ObjectIdentifier`
1463
Paul Kehrere27f6582015-08-10 18:33:38 -05001464 Returns
1465 :attr:`~cryptography.x509.oid.ExtensionOID.SUBJECT_ALTERNATIVE_NAME`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001466
Paul Kehrer31bdf792015-03-25 14:11:00 -05001467 .. method:: get_values_for_type(type)
1468
1469 :param type: A :class:`GeneralName` provider. This is one of the
1470 :ref:`general name classes <general_name_classes>`.
1471
1472 :returns: A list of values extracted from the matched general names.
Joshua Taubererd2afad32015-07-06 22:37:53 +00001473 The type of the returned values depends on the :class:`GeneralName`.
Paul Kehrer31bdf792015-03-25 14:11:00 -05001474
Paul Kehrer93ae8052015-05-02 23:18:09 -05001475 .. doctest::
1476
1477 >>> from cryptography import x509
1478 >>> from cryptography.hazmat.backends import default_backend
1479 >>> from cryptography.hazmat.primitives import hashes
1480 >>> cert = x509.load_pem_x509_certificate(cryptography_cert_pem, default_backend())
Paul Kehrerd0cd5072015-05-02 23:27:00 -05001481 >>> # Get the subjectAltName extension from the certificate
Paul Kehrere27f6582015-08-10 18:33:38 -05001482 >>> ext = cert.extensions.get_extension_for_oid(ExtensionOID.SUBJECT_ALTERNATIVE_NAME)
Paul Kehrerd0cd5072015-05-02 23:27:00 -05001483 >>> # Get the dNSName entries from the SAN extension
1484 >>> ext.value.get_values_for_type(x509.DNSName)
Paul Kehrer93ae8052015-05-02 23:18:09 -05001485 [u'www.cryptography.io', u'cryptography.io']
1486
Paul Kehrer8cf26422015-03-21 09:50:24 -05001487
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001488.. class:: IssuerAlternativeName(general_names)
Paul Kehrer99125c92015-06-07 18:37:10 -05001489
1490 .. versionadded:: 1.0
1491
1492 Issuer alternative name is an X.509 extension that provides a list of
1493 :ref:`general name <general_name_classes>` instances that provide a set
1494 of identities for the certificate issuer. The object is iterable to
1495 get every element.
1496
Paul Kehrer1cb9e552015-10-28 09:37:29 +09001497 :param list general_names: A list of :class:`GeneralName` instances.
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001498
Paul Kehrer822f3d32015-08-06 11:47:32 +01001499 .. attribute:: oid
1500
1501 .. versionadded:: 1.0
1502
1503 :type: :class:`ObjectIdentifier`
1504
Paul Kehrere27f6582015-08-10 18:33:38 -05001505 Returns
1506 :attr:`~cryptography.x509.oid.ExtensionOID.ISSUER_ALTERNATIVE_NAME`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001507
Paul Kehrer99125c92015-06-07 18:37:10 -05001508 .. method:: get_values_for_type(type)
1509
1510 :param type: A :class:`GeneralName` provider. This is one of the
1511 :ref:`general name classes <general_name_classes>`.
1512
1513 :returns: A list of values extracted from the matched general names.
1514
1515
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001516.. class:: AuthorityInformationAccess(descriptions)
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001517
1518 .. versionadded:: 0.9
1519
1520 The authority information access extension indicates how to access
1521 information and services for the issuer of the certificate in which
1522 the extension appears. Information and services may include online
1523 validation services (such as OCSP) and issuer data. It is an iterable,
Paul Kehrere27f6582015-08-10 18:33:38 -05001524 containing one or more :class:`~cryptography.x509.AccessDescription`
1525 instances.
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001526
Paul Kehrer1cb9e552015-10-28 09:37:29 +09001527 :param list descriptions: A list of :class:`AccessDescription` objects.
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001528
Paul Kehrer822f3d32015-08-06 11:47:32 +01001529 .. attribute:: oid
1530
1531 .. versionadded:: 1.0
1532
1533 :type: :class:`ObjectIdentifier`
1534
Paul Kehrere27f6582015-08-10 18:33:38 -05001535 Returns
1536 :attr:`~cryptography.x509.oid.ExtensionOID.AUTHORITY_INFORMATION_ACCESS`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001537
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001538
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001539.. class:: AccessDescription(access_method, access_location)
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001540
Paul Kehrer5a485522015-05-06 00:29:12 -05001541 .. versionadded:: 0.9
1542
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001543 .. attribute:: access_method
1544
1545 :type: :class:`ObjectIdentifier`
1546
Paul Kehrerf506bca2015-05-02 22:31:47 -05001547 The access method defines what the ``access_location`` means. It must
Paul Kehrere27f6582015-08-10 18:33:38 -05001548 be either
1549 :attr:`~cryptography.x509.oid.AuthorityInformationAccessOID.OCSP` or
1550 :attr:`~cryptography.x509.oid.AuthorityInformationAccessOID.CA_ISSUERS`.
1551 If it is
1552 :attr:`~cryptography.x509.oid.AuthorityInformationAccessOID.OCSP`
1553 the access location will be where to obtain OCSP
1554 information for the certificate. If it is
1555 :attr:`~cryptography.x509.oid.AuthorityInformationAccessOID.CA_ISSUERS`
1556 the access location will provide additional information about the
1557 issuing certificate.
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001558
1559 .. attribute:: access_location
1560
1561 :type: :class:`GeneralName`
1562
Paul Kehrerf506bca2015-05-02 22:31:47 -05001563 Where to access the information defined by the access method.
1564
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001565.. class:: CRLDistributionPoints(distribution_points)
Paul Kehrer5a485522015-05-06 00:29:12 -05001566
1567 .. versionadded:: 0.9
1568
1569 The CRL distribution points extension identifies how CRL information is
1570 obtained. It is an iterable, containing one or more
1571 :class:`DistributionPoint` instances.
1572
Paul Kehrer1cb9e552015-10-28 09:37:29 +09001573 :param list distribution_points: A list of :class:`DistributionPoint`
1574 instances.
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001575
Paul Kehrer822f3d32015-08-06 11:47:32 +01001576 .. attribute:: oid
1577
1578 .. versionadded:: 1.0
1579
1580 :type: :class:`ObjectIdentifier`
1581
Paul Kehrere27f6582015-08-10 18:33:38 -05001582 Returns
1583 :attr:`~cryptography.x509.oid.ExtensionOID.CRL_DISTRIBUTION_POINTS`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001584
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001585.. class:: DistributionPoint(full_name, relative_name, reasons, crl_issuer)
Paul Kehrer5a485522015-05-06 00:29:12 -05001586
1587 .. versionadded:: 0.9
1588
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001589 .. attribute:: full_name
Paul Kehrer5a485522015-05-06 00:29:12 -05001590
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001591 :type: list of :class:`GeneralName` instances or None
Paul Kehrer5a485522015-05-06 00:29:12 -05001592
Paul Kehrerf2c072b2015-05-09 17:04:28 -05001593 This field describes methods to retrieve the CRL. At most one of
1594 ``full_name`` or ``relative_name`` will be non-None.
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001595
1596 .. attribute:: relative_name
1597
1598 :type: :class:`Name` or None
1599
1600 This field describes methods to retrieve the CRL relative to the CRL
Paul Kehrerf2c072b2015-05-09 17:04:28 -05001601 issuer. At most one of ``full_name`` or ``relative_name`` will be
1602 non-None.
Paul Kehrer5a485522015-05-06 00:29:12 -05001603
1604 .. attribute:: crl_issuer
1605
1606 :type: list of :class:`GeneralName` instances or None
1607
1608 Information about the issuer of the CRL.
1609
1610 .. attribute:: reasons
1611
Paul Kehrer3fd02602015-05-09 19:46:13 -05001612 :type: frozenset of :class:`ReasonFlags` or None
Paul Kehrer5a485522015-05-06 00:29:12 -05001613
1614 The reasons a given distribution point may be used for when performing
1615 revocation checks.
1616
1617.. class:: ReasonFlags
1618
1619 .. versionadded:: 0.9
1620
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001621 An enumeration for CRL reasons.
1622
1623 .. attribute:: unspecified
1624
1625 It is unspecified why the certificate was revoked. This reason cannot
1626 be used as a reason flag in a :class:`DistributionPoint`.
Paul Kehrer5a485522015-05-06 00:29:12 -05001627
1628 .. attribute:: key_compromise
1629
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001630 This reason indicates that the private key was compromised.
Paul Kehrer5a485522015-05-06 00:29:12 -05001631
1632 .. attribute:: ca_compromise
1633
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001634 This reason indicates that the CA issuing the certificate was
1635 compromised.
Paul Kehrer5a485522015-05-06 00:29:12 -05001636
1637 .. attribute:: affiliation_changed
1638
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001639 This reason indicates that the subject's name or other information has
1640 changed.
Paul Kehrer5a485522015-05-06 00:29:12 -05001641
1642 .. attribute:: superseded
1643
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001644 This reason indicates that a certificate has been superseded.
Paul Kehrer5a485522015-05-06 00:29:12 -05001645
1646 .. attribute:: cessation_of_operation
1647
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001648 This reason indicates that the certificate is no longer required.
Paul Kehrer5a485522015-05-06 00:29:12 -05001649
1650 .. attribute:: certificate_hold
1651
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001652 This reason indicates that the certificate is on hold.
Paul Kehrer5a485522015-05-06 00:29:12 -05001653
1654 .. attribute:: privilege_withdrawn
1655
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001656 This reason indicates that the privilege granted by this certificate
1657 have been withdrawn.
Paul Kehrer5a485522015-05-06 00:29:12 -05001658
1659 .. attribute:: aa_compromise
1660
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001661 When an attribute authority has been compromised.
1662
1663 .. attribute:: remove_from_crl
1664
1665 This reason indicates that the certificate was on hold and should be
1666 removed from the CRL. This reason cannot be used as a reason flag
1667 in a :class:`DistributionPoint`.
Paul Kehrer5a485522015-05-06 00:29:12 -05001668
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001669.. class:: InhibitAnyPolicy(skip_certs)
Paul Kehrer16fae762015-05-01 23:14:20 -05001670
1671 .. versionadded:: 1.0
1672
1673 The inhibit ``anyPolicy`` extension indicates that the special OID
Paul Kehrere27f6582015-08-10 18:33:38 -05001674 :attr:`~cryptography.x509.oid.CertificatePoliciesOID.ANY_POLICY`, is not
1675 considered an explicit match for other :class:`CertificatePolicies` except
1676 when it appears in an intermediate self-issued CA certificate. The value
1677 indicates the number of additional non-self-issued certificates that may
1678 appear in the path before
1679 :attr:`~cryptography.x509.oid.CertificatePoliciesOID.ANY_POLICY` is no
1680 longer permitted. For example, a value of one indicates that
1681 :attr:`~cryptography.x509.oid.CertificatePoliciesOID.ANY_POLICY` may be
1682 processed in certificates issued by the subject of this certificate, but
1683 not in additional certificates in the path.
Paul Kehrer16fae762015-05-01 23:14:20 -05001684
Paul Kehrer822f3d32015-08-06 11:47:32 +01001685 .. attribute:: oid
1686
1687 .. versionadded:: 1.0
1688
1689 :type: :class:`ObjectIdentifier`
1690
Paul Kehrere27f6582015-08-10 18:33:38 -05001691 Returns
1692 :attr:`~cryptography.x509.oid.ExtensionOID.INHIBIT_ANY_POLICY`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001693
Paul Kehrer16fae762015-05-01 23:14:20 -05001694 .. attribute:: skip_certs
1695
1696 :type: int
1697
Paul Kehrer3b95cd72015-12-22 21:40:20 -06001698.. class:: CRLNumber(crl_number)
1699
1700 .. versionadded:: 1.2
1701
Paul Kehrere32b9942015-12-22 22:26:53 -06001702 The CRL number is a CRL extension that conveys a monotonically increasing
1703 sequence number for a given CRL scope and CRL issuer. This extension allows
1704 users to easily determine when a particular CRL supersedes another CRL.
1705 :rfc:`5280` requires that this extension be present in conforming CRLs.
Paul Kehrer3b95cd72015-12-22 21:40:20 -06001706
1707 .. attribute:: oid
1708
1709 :type: :class:`ObjectIdentifier`
1710
1711 Returns
1712 :attr:`~cryptography.x509.oid.ExtensionOID.CRL_NUMBER`.
1713
1714 .. attribute:: crl_number
1715
1716 :type: int
1717
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001718.. class:: CertificatePolicies(policies)
Paul Kehrer0d210922015-04-28 17:31:07 -05001719
1720 .. versionadded:: 0.9
1721
Paul Kehrer2e879742015-05-02 23:09:56 -05001722 The certificate policies extension is an iterable, containing one or more
1723 :class:`PolicyInformation` instances.
Paul Kehrer0d210922015-04-28 17:31:07 -05001724
Paul Kehrer1cb9e552015-10-28 09:37:29 +09001725 :param list policies: A list of :class:`PolicyInformation` instances.
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001726
Paul Kehrer822f3d32015-08-06 11:47:32 +01001727 .. attribute:: oid
1728
1729 .. versionadded:: 1.0
1730
1731 :type: :class:`ObjectIdentifier`
1732
Paul Kehrere27f6582015-08-10 18:33:38 -05001733 Returns
1734 :attr:`~cryptography.x509.oid.ExtensionOID.CERTIFICATE_POLICIES`.
Paul Kehrer822f3d32015-08-06 11:47:32 +01001735
Paul Kehrer0d210922015-04-28 17:31:07 -05001736Certificate Policies Classes
1737~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1738
1739These classes may be present within a :class:`CertificatePolicies` instance.
1740
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001741.. class:: PolicyInformation(policy_identifier, policy_qualifiers)
Paul Kehrer0d210922015-04-28 17:31:07 -05001742
1743 .. versionadded:: 0.9
1744
1745 Contains a policy identifier and an optional list of qualifiers.
1746
1747 .. attribute:: policy_identifier
1748
1749 :type: :class:`ObjectIdentifier`
1750
1751 .. attribute:: policy_qualifiers
1752
1753 :type: list
1754
Paul Kehrerba35b3b2015-05-10 13:07:59 -05001755 A list consisting of :term:`text` and/or :class:`UserNotice` objects.
Paul Kehrer3f8ddeb2015-05-11 00:25:36 -05001756 If the value is text it is a pointer to the practice statement
1757 published by the certificate authority. If it is a user notice it is
1758 meant for display to the relying party when the certificate is
1759 used.
Paul Kehrer2e879742015-05-02 23:09:56 -05001760
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001761.. class:: UserNotice(notice_reference, explicit_text)
Paul Kehrer0d210922015-04-28 17:31:07 -05001762
1763 .. versionadded:: 0.9
1764
Paul Kehrer2e879742015-05-02 23:09:56 -05001765 User notices are intended for display to a relying party when a certificate
1766 is used. In practice, few if any UIs expose this data and it is a rarely
1767 encoded component.
1768
Paul Kehrer0d210922015-04-28 17:31:07 -05001769 .. attribute:: notice_reference
1770
1771 :type: :class:`NoticeReference` or None
1772
Paul Kehrer2e879742015-05-02 23:09:56 -05001773 The notice reference field names an organization and identifies,
1774 by number, a particular statement prepared by that organization.
1775
Paul Kehrer0d210922015-04-28 17:31:07 -05001776 .. attribute:: explicit_text
1777
Paul Kehrer2e879742015-05-02 23:09:56 -05001778 This field includes an arbitrary textual statement directly in the
1779 certificate.
1780
Paul Kehrer0d210922015-04-28 17:31:07 -05001781 :type: :term:`text`
1782
Paul Kehrer47c32ba2015-10-28 09:12:07 +09001783.. class:: NoticeReference(organization, notice_numbers)
Paul Kehrer0d210922015-04-28 17:31:07 -05001784
Paul Kehrer2e879742015-05-02 23:09:56 -05001785 Notice reference can name an organization and provide information about
1786 notices related to the certificate. For example, it might identify the
1787 organization name and notice number 1. Application software could
1788 have a notice file containing the current set of notices for the named
1789 organization; the application would then extract the notice text from the
1790 file and display it. In practice this is rarely seen.
1791
Paul Kehrer0d210922015-04-28 17:31:07 -05001792 .. versionadded:: 0.9
1793
1794 .. attribute:: organization
1795
Paul Kehrer66c61702015-05-12 16:39:18 -05001796 :type: :term:`text`
Paul Kehrer0d210922015-04-28 17:31:07 -05001797
Paul Kehrer3f8ddeb2015-05-11 00:25:36 -05001798 .. attribute:: notice_numbers
Paul Kehrer0d210922015-04-28 17:31:07 -05001799
Paul Kehrer66c61702015-05-12 16:39:18 -05001800 :type: list
Paul Kehrer0d210922015-04-28 17:31:07 -05001801
Paul Kehrer66c61702015-05-12 16:39:18 -05001802 A list of integers.
Paul Kehrer0d210922015-04-28 17:31:07 -05001803
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001804Object Identifiers
1805~~~~~~~~~~~~~~~~~~
1806
Paul Kehrer4bb46492015-02-07 16:59:14 -06001807X.509 elements are frequently identified by :class:`ObjectIdentifier`
1808instances. The following common OIDs are available as constants.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001809
Paul Kehrere27f6582015-08-10 18:33:38 -05001810.. currentmodule:: cryptography.x509.oid
Paul Kehrer56da2a52015-02-11 23:35:07 -06001811
Paul Kehrere27f6582015-08-10 18:33:38 -05001812.. class:: NameOID
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001813
Paul Kehrere27f6582015-08-10 18:33:38 -05001814 These OIDs are typically seen in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001815
Paul Kehrere27f6582015-08-10 18:33:38 -05001816 .. versionadded:: 1.0
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001817
Paul Kehrere27f6582015-08-10 18:33:38 -05001818 .. attribute:: COMMON_NAME
Paul Kehrer858b9b72015-02-05 09:50:31 -06001819
Paul Kehrere27f6582015-08-10 18:33:38 -05001820 Corresponds to the dotted string ``"2.5.4.3"``. Historically the domain
1821 name would be encoded here for server certificates. :rfc:`2818`
1822 deprecates this practice and names of that type should now be located
1823 in a :class:`~cryptography.x509.SubjectAlternativeName` extension.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001824
Paul Kehrere27f6582015-08-10 18:33:38 -05001825 .. attribute:: COUNTRY_NAME
Paul Kehrer858b9b72015-02-05 09:50:31 -06001826
Paul Kehrere27f6582015-08-10 18:33:38 -05001827 Corresponds to the dotted string ``"2.5.4.6"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001828
Paul Kehrere27f6582015-08-10 18:33:38 -05001829 .. attribute:: LOCALITY_NAME
Paul Kehrer858b9b72015-02-05 09:50:31 -06001830
Paul Kehrere27f6582015-08-10 18:33:38 -05001831 Corresponds to the dotted string ``"2.5.4.7"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001832
Paul Kehrere27f6582015-08-10 18:33:38 -05001833 .. attribute:: STATE_OR_PROVINCE_NAME
Paul Kehrer858b9b72015-02-05 09:50:31 -06001834
Paul Kehrere27f6582015-08-10 18:33:38 -05001835 Corresponds to the dotted string ``"2.5.4.8"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001836
Paul Kehrere27f6582015-08-10 18:33:38 -05001837 .. attribute:: ORGANIZATION_NAME
Paul Kehrer858b9b72015-02-05 09:50:31 -06001838
Paul Kehrere27f6582015-08-10 18:33:38 -05001839 Corresponds to the dotted string ``"2.5.4.10"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001840
Paul Kehrere27f6582015-08-10 18:33:38 -05001841 .. attribute:: ORGANIZATIONAL_UNIT_NAME
Paul Kehrer858b9b72015-02-05 09:50:31 -06001842
Paul Kehrere27f6582015-08-10 18:33:38 -05001843 Corresponds to the dotted string ``"2.5.4.11"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001844
Paul Kehrere27f6582015-08-10 18:33:38 -05001845 .. attribute:: SERIAL_NUMBER
Paul Kehrer858b9b72015-02-05 09:50:31 -06001846
Paul Kehrere27f6582015-08-10 18:33:38 -05001847 Corresponds to the dotted string ``"2.5.4.5"``. This is distinct from
1848 the serial number of the certificate itself (which can be obtained with
1849 :func:`~cryptography.x509.Certificate.serial`).
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001850
Paul Kehrere27f6582015-08-10 18:33:38 -05001851 .. attribute:: SURNAME
Paul Kehrer858b9b72015-02-05 09:50:31 -06001852
Paul Kehrere27f6582015-08-10 18:33:38 -05001853 Corresponds to the dotted string ``"2.5.4.4"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001854
Paul Kehrere27f6582015-08-10 18:33:38 -05001855 .. attribute:: GIVEN_NAME
Paul Kehrer858b9b72015-02-05 09:50:31 -06001856
Paul Kehrere27f6582015-08-10 18:33:38 -05001857 Corresponds to the dotted string ``"2.5.4.42"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001858
Paul Kehrere27f6582015-08-10 18:33:38 -05001859 .. attribute:: TITLE
Paul Kehrer858b9b72015-02-05 09:50:31 -06001860
Paul Kehrere27f6582015-08-10 18:33:38 -05001861 Corresponds to the dotted string ``"2.5.4.12"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001862
Paul Kehrere27f6582015-08-10 18:33:38 -05001863 .. attribute:: GENERATION_QUALIFIER
Paul Kehrer858b9b72015-02-05 09:50:31 -06001864
Paul Kehrere27f6582015-08-10 18:33:38 -05001865 Corresponds to the dotted string ``"2.5.4.44"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001866
Paul Kehrere27f6582015-08-10 18:33:38 -05001867 .. attribute:: DN_QUALIFIER
Paul Kehrer858b9b72015-02-05 09:50:31 -06001868
Paul Kehrere27f6582015-08-10 18:33:38 -05001869 Corresponds to the dotted string ``"2.5.4.46"``. This specifies
1870 disambiguating information to add to the relative distinguished name of an
1871 entry. See :rfc:`2256`.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001872
Paul Kehrere27f6582015-08-10 18:33:38 -05001873 .. attribute:: PSEUDONYM
Paul Kehrer858b9b72015-02-05 09:50:31 -06001874
Paul Kehrere27f6582015-08-10 18:33:38 -05001875 Corresponds to the dotted string ``"2.5.4.65"``.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001876
Paul Kehrere27f6582015-08-10 18:33:38 -05001877 .. attribute:: DOMAIN_COMPONENT
Paul Kehrer858b9b72015-02-05 09:50:31 -06001878
Paul Kehrere27f6582015-08-10 18:33:38 -05001879 Corresponds to the dotted string ``"0.9.2342.19200300.100.1.25"``. A string
1880 holding one component of a domain name. See :rfc:`4519`.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001881
Paul Kehrere27f6582015-08-10 18:33:38 -05001882 .. attribute:: EMAIL_ADDRESS
Paul Kehrer56da2a52015-02-11 23:35:07 -06001883
Paul Kehrere27f6582015-08-10 18:33:38 -05001884 Corresponds to the dotted string ``"1.2.840.113549.1.9.1"``.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001885
Alex Gaynor1d3f2bf2015-12-19 12:15:09 -05001886 .. attribute:: JURISDICTION_COUNTRY_NAME
1887
1888 Corresponds to the dotted string ``"1.3.6.1.4.1.311.60.2.1.3"``.
1889
Alex Gaynor45e507f2015-12-19 13:44:23 -05001890 .. attribute:: JURISDICTION_LOCALITY_NAME
1891
1892 Corresponds to the dotted string ``"1.3.6.1.4.1.311.60.2.1.1"``.
1893
1894 .. attribute:: JURISDICTION_STATE_OR_PROVINCE_NAME
1895
1896 Corresponds to the dotted string ``"1.3.6.1.4.1.311.60.2.1.2"``.
1897
Alex Gaynora2293c82015-12-19 20:49:15 -05001898 .. attribute:: BUSINESS_CATEGORY
1899
1900 Corresponds to the dotted string ``"2.5.4.15"``.
1901
Paul Kehrer56da2a52015-02-11 23:35:07 -06001902
Paul Kehrere27f6582015-08-10 18:33:38 -05001903.. class:: SignatureAlgorithmOID
Paul Kehrer56da2a52015-02-11 23:35:07 -06001904
Paul Kehrere27f6582015-08-10 18:33:38 -05001905 .. versionadded:: 1.0
Paul Kehrer56da2a52015-02-11 23:35:07 -06001906
Paul Kehrere27f6582015-08-10 18:33:38 -05001907 .. attribute:: RSA_WITH_MD5
Paul Kehrer56da2a52015-02-11 23:35:07 -06001908
Paul Kehrere27f6582015-08-10 18:33:38 -05001909 Corresponds to the dotted string ``"1.2.840.113549.1.1.4"``. This is
1910 an MD5 digest signed by an RSA key.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001911
Paul Kehrere27f6582015-08-10 18:33:38 -05001912 .. attribute:: RSA_WITH_SHA1
Paul Kehrer56da2a52015-02-11 23:35:07 -06001913
Paul Kehrere27f6582015-08-10 18:33:38 -05001914 Corresponds to the dotted string ``"1.2.840.113549.1.1.5"``. This is
1915 a SHA1 digest signed by an RSA key.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001916
Paul Kehrere27f6582015-08-10 18:33:38 -05001917 .. attribute:: RSA_WITH_SHA224
Paul Kehrer56da2a52015-02-11 23:35:07 -06001918
Paul Kehrere27f6582015-08-10 18:33:38 -05001919 Corresponds to the dotted string ``"1.2.840.113549.1.1.14"``. This is
1920 a SHA224 digest signed by an RSA key.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001921
Paul Kehrere27f6582015-08-10 18:33:38 -05001922 .. attribute:: RSA_WITH_SHA256
Paul Kehrer56da2a52015-02-11 23:35:07 -06001923
Paul Kehrere27f6582015-08-10 18:33:38 -05001924 Corresponds to the dotted string ``"1.2.840.113549.1.1.11"``. This is
1925 a SHA256 digest signed by an RSA key.
Alex Gaynor3aadabf2015-06-23 22:06:21 -04001926
Paul Kehrere27f6582015-08-10 18:33:38 -05001927 .. attribute:: RSA_WITH_SHA384
Alex Gaynor3aadabf2015-06-23 22:06:21 -04001928
Paul Kehrere27f6582015-08-10 18:33:38 -05001929 Corresponds to the dotted string ``"1.2.840.113549.1.1.12"``. This is
1930 a SHA384 digest signed by an RSA key.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001931
Paul Kehrere27f6582015-08-10 18:33:38 -05001932 .. attribute:: RSA_WITH_SHA512
Paul Kehrer56da2a52015-02-11 23:35:07 -06001933
Paul Kehrere27f6582015-08-10 18:33:38 -05001934 Corresponds to the dotted string ``"1.2.840.113549.1.1.13"``. This is
1935 a SHA512 digest signed by an RSA key.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001936
Paul Kehrere27f6582015-08-10 18:33:38 -05001937 .. attribute:: ECDSA_WITH_SHA1
Paul Kehrer56da2a52015-02-11 23:35:07 -06001938
Paul Kehrere27f6582015-08-10 18:33:38 -05001939 Corresponds to the dotted string ``"1.2.840.10045.4.1"``. This is a SHA1
1940 digest signed by an ECDSA key.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001941
Paul Kehrere27f6582015-08-10 18:33:38 -05001942 .. attribute:: ECDSA_WITH_SHA224
Paul Kehrer56da2a52015-02-11 23:35:07 -06001943
Paul Kehrere27f6582015-08-10 18:33:38 -05001944 Corresponds to the dotted string ``"1.2.840.10045.4.3.1"``. This is
1945 a SHA224 digest signed by an ECDSA key.
1946
1947 .. attribute:: ECDSA_WITH_SHA256
1948
1949 Corresponds to the dotted string ``"1.2.840.10045.4.3.2"``. This is
1950 a SHA256 digest signed by an ECDSA key.
1951
1952 .. attribute:: ECDSA_WITH_SHA384
1953
1954 Corresponds to the dotted string ``"1.2.840.10045.4.3.3"``. This is
1955 a SHA384 digest signed by an ECDSA key.
1956
1957 .. attribute:: ECDSA_WITH_SHA512
1958
1959 Corresponds to the dotted string ``"1.2.840.10045.4.3.4"``. This is
1960 a SHA512 digest signed by an ECDSA key.
1961
1962 .. attribute:: DSA_WITH_SHA1
1963
1964 Corresponds to the dotted string ``"1.2.840.10040.4.3"``. This is
1965 a SHA1 digest signed by a DSA key.
1966
1967 .. attribute:: DSA_WITH_SHA224
1968
1969 Corresponds to the dotted string ``"2.16.840.1.101.3.4.3.1"``. This is
1970 a SHA224 digest signed by a DSA key.
1971
1972 .. attribute:: DSA_WITH_SHA256
Paul Kehrer56da2a52015-02-11 23:35:07 -06001973
Paul Kehrere27f6582015-08-10 18:33:38 -05001974 Corresponds to the dotted string ``"2.16.840.1.101.3.4.3.2"``. This is
1975 a SHA256 digest signed by a DSA key.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001976
Paul Kehrer56da2a52015-02-11 23:35:07 -06001977
Paul Kehrere27f6582015-08-10 18:33:38 -05001978.. class:: ExtendedKeyUsageOID
Paul Kehrer56da2a52015-02-11 23:35:07 -06001979
Paul Kehrere27f6582015-08-10 18:33:38 -05001980 .. versionadded:: 1.0
Paul Kehrer56da2a52015-02-11 23:35:07 -06001981
Paul Kehrere27f6582015-08-10 18:33:38 -05001982 .. attribute:: SERVER_AUTH
Paul Kehrer56da2a52015-02-11 23:35:07 -06001983
Paul Kehrere27f6582015-08-10 18:33:38 -05001984 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.1"``. This is used
1985 to denote that a certificate may be used for TLS web server
1986 authentication.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001987
Paul Kehrere27f6582015-08-10 18:33:38 -05001988 .. attribute:: CLIENT_AUTH
Paul Kehrer56da2a52015-02-11 23:35:07 -06001989
Paul Kehrere27f6582015-08-10 18:33:38 -05001990 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.2"``. This is used
1991 to denote that a certificate may be used for TLS web client
1992 authentication.
Paul Kehrerffa2a152015-03-31 08:18:25 -05001993
Paul Kehrere27f6582015-08-10 18:33:38 -05001994 .. attribute:: CODE_SIGNING
Paul Kehrere1513fa2015-03-30 23:08:17 -05001995
Paul Kehrere27f6582015-08-10 18:33:38 -05001996 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.3"``. This is used
1997 to denote that a certificate may be used for code signing.
Paul Kehrere1513fa2015-03-30 23:08:17 -05001998
Paul Kehrere27f6582015-08-10 18:33:38 -05001999 .. attribute:: EMAIL_PROTECTION
Paul Kehrere1513fa2015-03-30 23:08:17 -05002000
Paul Kehrere27f6582015-08-10 18:33:38 -05002001 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.4"``. This is used
2002 to denote that a certificate may be used for email protection.
Paul Kehrere1513fa2015-03-30 23:08:17 -05002003
Paul Kehrere27f6582015-08-10 18:33:38 -05002004 .. attribute:: TIME_STAMPING
Paul Kehrere1513fa2015-03-30 23:08:17 -05002005
Paul Kehrere27f6582015-08-10 18:33:38 -05002006 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.8"``. This is used
2007 to denote that a certificate may be used for time stamping.
Paul Kehrere1513fa2015-03-30 23:08:17 -05002008
Paul Kehrere27f6582015-08-10 18:33:38 -05002009 .. attribute:: OCSP_SIGNING
Paul Kehrere1513fa2015-03-30 23:08:17 -05002010
Paul Kehrere27f6582015-08-10 18:33:38 -05002011 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.9"``. This is used
2012 to denote that a certificate may be used for signing OCSP responses.
Paul Kehrere1513fa2015-03-30 23:08:17 -05002013
Paul Kehrere1513fa2015-03-30 23:08:17 -05002014
Paul Kehrere27f6582015-08-10 18:33:38 -05002015.. class:: AuthorityInformationAccessOID
Paul Kehrere1513fa2015-03-30 23:08:17 -05002016
Paul Kehrere27f6582015-08-10 18:33:38 -05002017 .. versionadded:: 1.0
Paul Kehrere1513fa2015-03-30 23:08:17 -05002018
Paul Kehrere27f6582015-08-10 18:33:38 -05002019 .. attribute:: OCSP
Paul Kehrere1513fa2015-03-30 23:08:17 -05002020
Paul Kehrere27f6582015-08-10 18:33:38 -05002021 Corresponds to the dotted string ``"1.3.6.1.5.5.7.48.1"``. Used as the
2022 identifier for OCSP data in
2023 :class:`~cryptography.x509.AccessDescription` objects.
Paul Kehrere1513fa2015-03-30 23:08:17 -05002024
Paul Kehrere27f6582015-08-10 18:33:38 -05002025 .. attribute:: CA_ISSUERS
Paul Kehrer3e6d5582015-05-02 21:57:56 -05002026
Paul Kehrere27f6582015-08-10 18:33:38 -05002027 Corresponds to the dotted string ``"1.3.6.1.5.5.7.48.2"``. Used as the
2028 identifier for CA issuer data in
2029 :class:`~cryptography.x509.AccessDescription` objects.
Paul Kehrer3e6d5582015-05-02 21:57:56 -05002030
Paul Kehrer3e6d5582015-05-02 21:57:56 -05002031
Paul Kehrere27f6582015-08-10 18:33:38 -05002032.. class:: CertificatePoliciesOID
Paul Kehrer3e6d5582015-05-02 21:57:56 -05002033
Paul Kehrere27f6582015-08-10 18:33:38 -05002034 .. versionadded:: 1.0
Paul Kehrer3e6d5582015-05-02 21:57:56 -05002035
Paul Kehrere27f6582015-08-10 18:33:38 -05002036 .. attribute:: CPS_QUALIFIER
Paul Kehrer2e879742015-05-02 23:09:56 -05002037
Paul Kehrere27f6582015-08-10 18:33:38 -05002038 Corresponds to the dotted string ``"1.3.6.1.5.5.7.2.1"``.
Paul Kehrer2e879742015-05-02 23:09:56 -05002039
Paul Kehrere27f6582015-08-10 18:33:38 -05002040 .. attribute:: CPS_USER_NOTICE
Paul Kehrer2e879742015-05-02 23:09:56 -05002041
Paul Kehrere27f6582015-08-10 18:33:38 -05002042 Corresponds to the dotted string ``"1.3.6.1.5.5.7.2.2"``.
Paul Kehrer2e879742015-05-02 23:09:56 -05002043
Paul Kehrere27f6582015-08-10 18:33:38 -05002044 .. attribute:: ANY_POLICY
Paul Kehrer2e879742015-05-02 23:09:56 -05002045
Paul Kehrere27f6582015-08-10 18:33:38 -05002046 Corresponds to the dotted string ``"2.5.29.32.0"``.
Paul Kehrer16fae762015-05-01 23:14:20 -05002047
Paul Kehrer16fae762015-05-01 23:14:20 -05002048
Paul Kehrere27f6582015-08-10 18:33:38 -05002049.. class:: ExtensionOID
Paul Kehrer5553d572015-03-23 21:08:01 -05002050
Paul Kehrere27f6582015-08-10 18:33:38 -05002051 .. versionadded:: 1.0
Paul Kehrer2bb94642015-03-21 09:54:17 -05002052
Paul Kehrere27f6582015-08-10 18:33:38 -05002053 .. attribute:: BASIC_CONSTRAINTS
Paul Kehrer2bb94642015-03-21 09:54:17 -05002054
Paul Kehrere27f6582015-08-10 18:33:38 -05002055 Corresponds to the dotted string ``"2.5.29.19"``. The identifier for the
2056 :class:`~cryptography.x509.BasicConstraints` extension type.
Paul Kehrer2bb94642015-03-21 09:54:17 -05002057
Paul Kehrere27f6582015-08-10 18:33:38 -05002058 .. attribute:: KEY_USAGE
Paul Kehrercecbbba2015-03-30 14:58:38 -05002059
Paul Kehrere27f6582015-08-10 18:33:38 -05002060 Corresponds to the dotted string ``"2.5.29.15"``. The identifier for the
2061 :class:`~cryptography.x509.KeyUsage` extension type.
Paul Kehrercecbbba2015-03-30 14:58:38 -05002062
Paul Kehrere27f6582015-08-10 18:33:38 -05002063 .. attribute:: SUBJECT_ALTERNATIVE_NAME
Paul Kehrerd4f632e2015-05-12 08:25:42 -05002064
Paul Kehrere27f6582015-08-10 18:33:38 -05002065 Corresponds to the dotted string ``"2.5.29.17"``. The identifier for the
2066 :class:`~cryptography.x509.SubjectAlternativeName` extension type.
Paul Kehrerd4f632e2015-05-12 08:25:42 -05002067
Paul Kehrere27f6582015-08-10 18:33:38 -05002068 .. attribute:: ISSUER_ALTERNATIVE_NAME
Paul Kehrer99125c92015-06-07 18:37:10 -05002069
Paul Kehrere27f6582015-08-10 18:33:38 -05002070 Corresponds to the dotted string ``"2.5.29.18"``. The identifier for the
2071 :class:`~cryptography.x509.IssuerAlternativeName` extension type.
Paul Kehrer99125c92015-06-07 18:37:10 -05002072
Paul Kehrere27f6582015-08-10 18:33:38 -05002073 .. attribute:: SUBJECT_KEY_IDENTIFIER
Paul Kehrerd4f632e2015-05-12 08:25:42 -05002074
Paul Kehrere27f6582015-08-10 18:33:38 -05002075 Corresponds to the dotted string ``"2.5.29.14"``. The identifier for the
2076 :class:`~cryptography.x509.SubjectKeyIdentifier` extension type.
Paul Kehrerd4f632e2015-05-12 08:25:42 -05002077
Paul Kehrere27f6582015-08-10 18:33:38 -05002078 .. attribute:: NAME_CONSTRAINTS
Paul Kehrere0017be2015-05-17 20:39:40 -06002079
Paul Kehrere27f6582015-08-10 18:33:38 -05002080 Corresponds to the dotted string ``"2.5.29.30"``. The identifier for the
2081 :class:`~cryptography.x509.NameConstraints` extension type.
Paul Kehrere0017be2015-05-17 20:39:40 -06002082
Paul Kehrere27f6582015-08-10 18:33:38 -05002083 .. attribute:: CRL_DISTRIBUTION_POINTS
Paul Kehrerd4f632e2015-05-12 08:25:42 -05002084
Paul Kehrere27f6582015-08-10 18:33:38 -05002085 Corresponds to the dotted string ``"2.5.29.31"``. The identifier for the
2086 :class:`~cryptography.x509.CRLDistributionPoints` extension type.
Paul Kehrerd4f632e2015-05-12 08:25:42 -05002087
Paul Kehrere27f6582015-08-10 18:33:38 -05002088 .. attribute:: CERTIFICATE_POLICIES
Paul Kehrerd4f632e2015-05-12 08:25:42 -05002089
Paul Kehrere27f6582015-08-10 18:33:38 -05002090 Corresponds to the dotted string ``"2.5.29.32"``. The identifier for the
2091 :class:`~cryptography.x509.CertificatePolicies` extension type.
Paul Kehrerd4f632e2015-05-12 08:25:42 -05002092
Paul Kehrere27f6582015-08-10 18:33:38 -05002093 .. attribute:: AUTHORITY_KEY_IDENTIFIER
Paul Kehrerd4f632e2015-05-12 08:25:42 -05002094
Paul Kehrere27f6582015-08-10 18:33:38 -05002095 Corresponds to the dotted string ``"2.5.29.35"``. The identifier for the
2096 :class:`~cryptography.x509.AuthorityKeyIdentifier` extension type.
Paul Kehrerd4f632e2015-05-12 08:25:42 -05002097
Paul Kehrere27f6582015-08-10 18:33:38 -05002098 .. attribute:: EXTENDED_KEY_USAGE
Paul Kehrerd4f632e2015-05-12 08:25:42 -05002099
Paul Kehrere27f6582015-08-10 18:33:38 -05002100 Corresponds to the dotted string ``"2.5.29.37"``. The identifier for the
2101 :class:`~cryptography.x509.ExtendedKeyUsage` extension type.
Paul Kehrerd4f632e2015-05-12 08:25:42 -05002102
Paul Kehrere27f6582015-08-10 18:33:38 -05002103 .. attribute:: AUTHORITY_INFORMATION_ACCESS
Paul Kehrerd4f632e2015-05-12 08:25:42 -05002104
Paul Kehrere27f6582015-08-10 18:33:38 -05002105 Corresponds to the dotted string ``"1.3.6.1.5.5.7.1.1"``. The identifier
2106 for the :class:`~cryptography.x509.AuthorityInformationAccess` extension
2107 type.
Paul Kehrer56da2a52015-02-11 23:35:07 -06002108
Paul Kehrere27f6582015-08-10 18:33:38 -05002109 .. attribute:: INHIBIT_ANY_POLICY
Paul Kehrerb33de932015-08-06 23:41:05 +01002110
Paul Kehrere27f6582015-08-10 18:33:38 -05002111 Corresponds to the dotted string ``"2.5.29.54"``. The identifier
2112 for the :class:`~cryptography.x509.InhibitAnyPolicy` extension type.
Paul Kehrerb33de932015-08-06 23:41:05 +01002113
Paul Kehrere27f6582015-08-10 18:33:38 -05002114 .. attribute:: OCSP_NO_CHECK
Paul Kehrer4a1038e2015-05-18 10:28:31 -07002115
Paul Kehrere27f6582015-08-10 18:33:38 -05002116 Corresponds to the dotted string ``"1.3.6.1.5.5.7.48.1.5"``. The
2117 identifier for the :class:`~cryptography.x509.OCSPNoCheck` extension
2118 type.
Paul Kehrer4a1038e2015-05-18 10:28:31 -07002119
Paul Kehrer51f39cb2015-12-21 21:17:39 -06002120 .. attribute:: CRL_NUMBER
2121
2122 Corresponds to the dotted string ``"2.5.29.20"``. The identifier for
2123 the ``CRLNumber`` extension type. This extension only has meaning
2124 for certificate revocation lists.
2125
Paul Kehrer912d3fb2015-01-29 11:19:22 -06002126Exceptions
2127~~~~~~~~~~
Paul Kehrere27f6582015-08-10 18:33:38 -05002128.. currentmodule:: cryptography.x509
Paul Kehrer912d3fb2015-01-29 11:19:22 -06002129
Paul Kehrere76cd272014-12-14 19:00:51 -06002130.. class:: InvalidVersion
Paul Kehrera68fd332014-11-27 07:08:40 -10002131
2132 This is raised when an X.509 certificate has an invalid version number.
Paul Kehrer016e08a2014-11-26 09:41:18 -10002133
Paul Kehrerd5cccf72014-12-15 17:20:33 -06002134 .. attribute:: parsed_version
2135
Paul Kehrerbbffc402014-12-17 13:33:55 -06002136 :type: int
2137
2138 Returns the raw version that was parsed from the certificate.
Paul Kehrerd5cccf72014-12-15 17:20:33 -06002139
Paul Kehrerfbb7ac82015-03-16 19:26:29 -05002140.. class:: DuplicateExtension
2141
2142 This is raised when more than one X.509 extension of the same type is
2143 found within a certificate.
2144
2145 .. attribute:: oid
2146
2147 :type: :class:`ObjectIdentifier`
2148
2149 Returns the OID.
2150
2151.. class:: UnsupportedExtension
2152
2153 This is raised when a certificate contains an unsupported extension type.
2154
2155 .. attribute:: oid
2156
2157 :type: :class:`ObjectIdentifier`
2158
2159 Returns the OID.
2160
Paul Kehrerfa56a232015-03-17 13:14:03 -05002161.. class:: ExtensionNotFound
2162
2163 This is raised when calling :meth:`Extensions.get_extension_for_oid` with
2164 an extension OID that is not present in the certificate.
2165
2166 .. attribute:: oid
2167
2168 :type: :class:`ObjectIdentifier`
2169
2170 Returns the OID.
2171
Paul Kehrer9089c912015-04-20 22:15:20 -05002172.. class:: UnsupportedGeneralNameType
2173
2174 This is raised when a certificate contains an unsupported general name
2175 type in an extension.
2176
Paul Kehrerbed07352015-04-21 08:31:10 -05002177 .. attribute:: type
2178
Paul Kehrer0a621bf2015-04-22 09:22:56 -05002179 :type: int
2180
2181 The integer value of the unsupported type. The complete list of
2182 types can be found in `RFC 5280 section 4.2.1.6`_.
Paul Kehrerbed07352015-04-21 08:31:10 -05002183
Paul Kehrer016e08a2014-11-26 09:41:18 -10002184
Paul Kehrerc7c9a432015-04-19 09:20:13 -05002185.. _`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 -05002186.. _`RFC 5280 section 4.2.1.6`: https://tools.ietf.org/html/rfc5280#section-4.2.1.6