blob: 8507edc1cc5d55da73f373cfec198710a825f166 [file] [log] [blame]
Paul Kehrer016e08a2014-11-26 09:41:18 -10001X.509
2=====
3
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
8 pem_req_data = b"""
9 -----BEGIN CERTIFICATE REQUEST-----
10 MIIC0zCCAbsCAQAwWTELMAkGA1UEBhMCVVMxETAPBgNVBAgMCElsbGlub2lzMRAw
11 DgYDVQQHDAdDaGljYWdvMREwDwYDVQQKDAhyNTA5IExMQzESMBAGA1UEAwwJaGVs
12 bG8uY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqhZx+Mo9VRd9
13 vsnWWa6NBCws21rZ0+1B/JGgB4hDsZS7iDE4Bj5z4idheFRtl8bBbdjPknq7BfoF
14 8v15Zq/Zv7i2xMSDL+LUrTBZezRd4bRTGqCm6YJ5EYkhqdcqeZleHCFImguHoq1J
15 Fh0+kObQrTHXw3ZP57a3o1IvyIUA3nNoCBL0QQhwBXaDXOojMKNR+bqB5ve8GS1y
16 Elr0AM/+cJsfaIahNQUgFKx3Eu3GeEOMKYOAG1lycgdQdmTUybLrT3U7vkClTseM
17 xHg1r5En7ALjONIhqRuq3rddYahrP8HXozb3zUy3cJ7P6IeaosuvNzvMXOX9P6HD
18 Ha9urDAJ1wIDAQABoDUwMwYJKoZIhvcNAQkOMSYwJDAiBgNVHREEGzAZggl3b3Js
19 ZC5jb22CDHdoYXRldmVyLmNvbTANBgkqhkiG9w0BAQUFAAOCAQEAS4Ro6h+z52SK
20 YSLCYARpnEu/rmh4jdqndt8naqcNb6uLx9mlKZ2W9on9XDjnSdQD9q+ZP5aZfESw
21 R0+rJhW9ZrNa/g1pt6M24ihclHYDAxYMWxT1z/TXXGM3TmZZ6gfYlNE1kkBuODHa
22 UYsR/1Ht1E1EsmmUimt2n+zQR2K8T9Coa+boaUW/GsTEuz1aaJAkj5ZvTDiIhRG4
23 AOCqFZOLAQmCCNgJnnspD9hDz/Ons085LF5wnYjN4/Nsk5tS6AGs3xjZ3jPoOGGn
24 82WQ9m4dBGoVDZXsobVTaN592JEYwN5iu72zRn7Einb4V4H5y3yD2dD4yWPlt4pk
25 5wFkeYsZEA==
26 -----END CERTIFICATE REQUEST-----
27 """.strip()
28
Paul Kehrerd3dafbd2015-03-15 16:24:18 -050029 pem_data = b"""
30 -----BEGIN CERTIFICATE-----
31 MIIDfDCCAmSgAwIBAgIBAjANBgkqhkiG9w0BAQsFADBFMQswCQYDVQQGEwJVUzEf
32 MB0GA1UEChMWVGVzdCBDZXJ0aWZpY2F0ZXMgMjAxMTEVMBMGA1UEAxMMVHJ1c3Qg
33 QW5jaG9yMB4XDTEwMDEwMTA4MzAwMFoXDTMwMTIzMTA4MzAwMFowQDELMAkGA1UE
34 BhMCVVMxHzAdBgNVBAoTFlRlc3QgQ2VydGlmaWNhdGVzIDIwMTExEDAOBgNVBAMT
35 B0dvb2QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCQWJpHYo37
36 Xfb7oJSPe+WvfTlzIG21WQ7MyMbGtK/m8mejCzR6c+f/pJhEH/OcDSMsXq8h5kXa
37 BGqWK+vSwD/Pzp5OYGptXmGPcthDtAwlrafkGOS4GqIJ8+k9XGKs+vQUXJKsOk47
38 RuzD6PZupq4s16xaLVqYbUC26UcY08GpnoLNHJZS/EmXw1ZZ3d4YZjNlpIpWFNHn
39 UGmdiGKXUPX/9H0fVjIAaQwjnGAbpgyCumWgzIwPpX+ElFOUr3z7BoVnFKhIXze+
40 VmQGSWxZxvWDUN90Ul0tLEpLgk3OVxUB4VUGuf15OJOpgo1xibINPmWt14Vda2N9
41 yrNKloJGZNqLAgMBAAGjfDB6MB8GA1UdIwQYMBaAFOR9X9FclYYILAWuvnW2ZafZ
42 XahmMB0GA1UdDgQWBBRYAYQkG7wrUpRKPaUQchRR9a86yTAOBgNVHQ8BAf8EBAMC
43 AQYwFwYDVR0gBBAwDjAMBgpghkgBZQMCATABMA8GA1UdEwEB/wQFMAMBAf8wDQYJ
44 KoZIhvcNAQELBQADggEBADWHlxbmdTXNwBL/llwhQqwnazK7CC2WsXBBqgNPWj7m
45 tvQ+aLG8/50Qc2Sun7o2VnwF9D18UUe8Gj3uPUYH+oSI1vDdyKcjmMbKRU4rk0eo
46 3UHNDXwqIVc9CQS9smyV+x1HCwL4TTrq+LXLKx/qVij0Yqk+UJfAtrg2jnYKXsCu
47 FMBQQnWCGrwa1g1TphRp/RmYHnMynYFmZrXtzFz+U9XEA7C+gPq4kqDI/iVfIT1s
48 6lBtdB50lrDVwl2oYfAvW/6sC2se2QleZidUmrziVNP4oEeXINokU6T6p//HM1FG
49 QYw2jOvpKcKtWCSAnegEbgsGYzATKjmPJPJ0npHFqzM=
50 -----END CERTIFICATE-----
51 """.strip()
52
Paul Kehrer93ae8052015-05-02 23:18:09 -050053 cryptography_cert_pem = b"""
54 -----BEGIN CERTIFICATE-----
55 MIIFvTCCBKWgAwIBAgICPyAwDQYJKoZIhvcNAQELBQAwRzELMAkGA1UEBhMCVVMx
56 FjAUBgNVBAoTDUdlb1RydXN0IEluYy4xIDAeBgNVBAMTF1JhcGlkU1NMIFNIQTI1
57 NiBDQSAtIEczMB4XDTE0MTAxNTEyMDkzMloXDTE4MTExNjAxMTUwM1owgZcxEzAR
58 BgNVBAsTCkdUNDg3NDI5NjUxMTAvBgNVBAsTKFNlZSB3d3cucmFwaWRzc2wuY29t
59 L3Jlc291cmNlcy9jcHMgKGMpMTQxLzAtBgNVBAsTJkRvbWFpbiBDb250cm9sIFZh
60 bGlkYXRlZCAtIFJhcGlkU1NMKFIpMRwwGgYDVQQDExN3d3cuY3J5cHRvZ3JhcGh5
61 LmlvMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAom/FebKJIot7Sp3s
62 itG1sicpe3thCssjI+g1JDAS7I3GLVNmbms1DOdIIqwf01gZkzzXBN2+9sOnyRaR
63 PPfCe1jTr3dk2y6rPE559vPa1nZQkhlzlhMhlPyjaT+S7g4Tio4qV2sCBZU01DZJ
64 CaksfohN+5BNVWoJzTbOcrHOEJ+M8B484KlBCiSxqf9cyNQKru4W3bHaCVNVJ8eu
65 6i6KyhzLa0L7yK3LXwwXVs583C0/vwFhccGWsFODqD/9xHUzsBIshE8HKjdjDi7Y
66 3BFQzVUQFjBB50NSZfAA/jcdt1blxJouc7z9T8Oklh+V5DDBowgAsrT4b6Z2Fq6/
67 r7D1GqivLK/ypUQmxq2WXWAUBb/Q6xHgxASxI4Br+CByIUQJsm8L2jzc7k+mF4hW
68 ltAIUkbo8fGiVnat0505YJgxWEDKOLc4Gda6d/7GVd5AvKrz242bUqeaWo6e4MTx
69 diku2Ma3rhdcr044Qvfh9hGyjqNjvhWY/I+VRWgihU7JrYvgwFdJqsQ5eiKT4OHi
70 gsejvWwkZzDtiQ+aQTrzM1FsY2swJBJsLSX4ofohlVRlIJCn/ME+XErj553431Lu
71 YQ5SzMd3nXzN78Vj6qzTfMUUY72UoT1/AcFiUMobgIqrrmwuNxfrkbVE2b6Bga74
72 FsJX63prvrJ41kuHK/16RQBM7fcCAwEAAaOCAWAwggFcMB8GA1UdIwQYMBaAFMOc
73 8/zTRgg0u85Gf6B8W/PiCMtZMFcGCCsGAQUFBwEBBEswSTAfBggrBgEFBQcwAYYT
74 aHR0cDovL2d2LnN5bWNkLmNvbTAmBggrBgEFBQcwAoYaaHR0cDovL2d2LnN5bWNi
75 LmNvbS9ndi5jcnQwDgYDVR0PAQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMB
76 BggrBgEFBQcDAjAvBgNVHREEKDAmghN3d3cuY3J5cHRvZ3JhcGh5Lmlvgg9jcnlw
77 dG9ncmFwaHkuaW8wKwYDVR0fBCQwIjAgoB6gHIYaaHR0cDovL2d2LnN5bWNiLmNv
78 bS9ndi5jcmwwDAYDVR0TAQH/BAIwADBFBgNVHSAEPjA8MDoGCmCGSAGG+EUBBzYw
79 LDAqBggrBgEFBQcCARYeaHR0cHM6Ly93d3cucmFwaWRzc2wuY29tL2xlZ2FsMA0G
80 CSqGSIb3DQEBCwUAA4IBAQAzIYO2jx7h17FBT74tJ2zbV9OKqGb7QF8y3wUtP4xc
81 dH80vprI/Cfji8s86kr77aAvAqjDjaVjHn7UzebhSUivvRPmfzRgyWBacomnXTSt
82 Xlt2dp2nDQuwGyK2vB7dMfKnQAkxwq1sYUXznB8i0IhhCAoXp01QGPKq51YoIlnF
83 7DRMk6iEaL1SJbkIrLsCQyZFDf0xtfW9DqXugMMLoxeCsBhZJQzNyS2ryirrv9LH
84 aK3+6IZjrcyy9bkpz/gzJucyhU+75c4My/mnRCrtItRbCQuiI5pd5poDowm+HH9i
85 GVI9+0lAFwxOUnOnwsoI40iOoxjLMGB+CgFLKCGUcWxP
86 -----END CERTIFICATE-----
87 """.strip()
88
Paul Kehrerd3dafbd2015-03-15 16:24:18 -050089X.509 is an ITU-T standard for a `public key infrastructure`_. X.509v3 is
90defined in :rfc:`5280` (which obsoletes :rfc:`2459` and :rfc:`3280`). X.509
91certificates are commonly used in protocols like `TLS`_.
Paul Kehrerb2de9482014-12-11 14:54:48 -060092
93Loading Certificates
94~~~~~~~~~~~~~~~~~~~~
Paul Kehrer016e08a2014-11-26 09:41:18 -100095
96.. function:: load_pem_x509_certificate(data, backend)
97
98 .. versionadded:: 0.7
99
Paul Kehrere76cd272014-12-14 19:00:51 -0600100 Deserialize a certificate from PEM encoded data. PEM certificates are
101 base64 decoded and have delimiters that look like
102 ``-----BEGIN CERTIFICATE-----``.
Paul Kehrer016e08a2014-11-26 09:41:18 -1000103
104 :param bytes data: The PEM encoded certificate data.
105
106 :param backend: A backend supporting the
107 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
108 interface.
109
Paul Kehrere76cd272014-12-14 19:00:51 -0600110 :returns: An instance of :class:`~cryptography.x509.Certificate`.
Paul Kehrer016e08a2014-11-26 09:41:18 -1000111
112.. function:: load_der_x509_certificate(data, backend)
113
114 .. versionadded:: 0.7
115
Paul Kehrere76cd272014-12-14 19:00:51 -0600116 Deserialize a certificate from DER encoded data. DER is a binary format
Paul Kehrer92aac382014-12-15 16:25:28 -0600117 and is commonly found in files with the ``.cer`` extension (although file
118 extensions are not a guarantee of encoding type).
Paul Kehrer016e08a2014-11-26 09:41:18 -1000119
120 :param bytes data: The DER encoded certificate data.
121
122 :param backend: A backend supporting the
123 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
124 interface.
125
Paul Kehrere76cd272014-12-14 19:00:51 -0600126 :returns: An instance of :class:`~cryptography.x509.Certificate`.
Paul Kehrer016e08a2014-11-26 09:41:18 -1000127
Paul Kehrer016e08a2014-11-26 09:41:18 -1000128.. doctest::
129
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600130 >>> from cryptography import x509
Paul Kehrer016e08a2014-11-26 09:41:18 -1000131 >>> from cryptography.hazmat.backends import default_backend
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600132 >>> cert = x509.load_pem_x509_certificate(pem_data, default_backend())
Paul Kehrer016e08a2014-11-26 09:41:18 -1000133 >>> cert.serial
134 2
135
Paul Kehrera1a1f232015-03-15 15:34:35 -0500136Loading Certificate Signing Requests
137~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600138
Paul Kehrer31e39882015-03-11 11:37:04 -0500139.. function:: load_pem_x509_csr(data, backend)
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600140
141 .. versionadded:: 0.9
142
Paul Kehrera1a1f232015-03-15 15:34:35 -0500143 Deserialize a certificate signing request (CSR) from PEM encoded data. PEM
Paul Kehrer5aadb9c2015-03-11 20:48:42 -0500144 requests are base64 decoded and have delimiters that look like
Paul Kehrerd3dafbd2015-03-15 16:24:18 -0500145 ``-----BEGIN CERTIFICATE REQUEST-----``. This format is also known as
146 PKCS#10.
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600147
148 :param bytes data: The PEM encoded request data.
149
150 :param backend: A backend supporting the
151 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
152 interface.
153
Paul Kehrera1a1f232015-03-15 15:34:35 -0500154 :returns: An instance of
155 :class:`~cryptography.x509.CertificateSigningRequest`.
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600156
Paul Kehrer1effb6e2015-03-30 15:05:59 -0500157.. function:: load_der_x509_csr(data, backend)
158
159 .. versionadded:: 0.9
160
161 Deserialize a certificate signing request (CSR) from DER encoded data. DER
162 is a binary format and is not commonly used with CSRs.
163
164 :param bytes data: The DER encoded request data.
165
166 :param backend: A backend supporting the
167 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
168 interface.
169
170 :returns: An instance of
171 :class:`~cryptography.x509.CertificateSigningRequest`.
172
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600173.. doctest::
174
175 >>> from cryptography import x509
176 >>> from cryptography.hazmat.backends import default_backend
177 >>> from cryptography.hazmat.primitives import hashes
Paul Kehrera1a1f232015-03-15 15:34:35 -0500178 >>> csr = x509.load_pem_x509_csr(pem_req_data, default_backend())
179 >>> isinstance(csr.signature_hash_algorithm, hashes.SHA1)
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600180 True
181
Paul Kehrere76cd272014-12-14 19:00:51 -0600182X.509 Certificate Object
183~~~~~~~~~~~~~~~~~~~~~~~~
Paul Kehrerb2de9482014-12-11 14:54:48 -0600184
Paul Kehrere76cd272014-12-14 19:00:51 -0600185.. class:: Certificate
Paul Kehrerb2de9482014-12-11 14:54:48 -0600186
187 .. versionadded:: 0.7
188
189 .. attribute:: version
190
Paul Kehrere76cd272014-12-14 19:00:51 -0600191 :type: :class:`~cryptography.x509.Version`
Paul Kehrerb2de9482014-12-11 14:54:48 -0600192
Paul Kehrere76cd272014-12-14 19:00:51 -0600193 The certificate version as an enumeration. Version 3 certificates are
194 the latest version and also the only type you should see in practice.
Paul Kehrerb2de9482014-12-11 14:54:48 -0600195
Alex Gaynor89c4dc82014-12-16 16:49:33 -0800196 :raises cryptography.x509.InvalidVersion: If the version in the
Alex Gaynor6d7ab4c2014-12-16 16:50:33 -0800197 certificate is not a known
198 :class:`X.509 version <cryptography.x509.Version>`.
Paul Kehrer92aac382014-12-15 16:25:28 -0600199
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600200 .. doctest::
201
202 >>> cert.version
203 <Version.v3: 2>
204
Paul Kehrerb2de9482014-12-11 14:54:48 -0600205 .. method:: fingerprint(algorithm)
206
207 :param algorithm: The
Paul Kehrer601278a2015-02-12 12:51:00 -0600208 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
Paul Kehrerb2de9482014-12-11 14:54:48 -0600209 that will be used to generate the fingerprint.
210
Erik Trauschke2dcce902015-05-14 16:12:24 -0700211 :return bytes: The fingerprint using the supplied hash algorithm, as
Paul Kehrerb2de9482014-12-11 14:54:48 -0600212 bytes.
213
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600214 .. doctest::
215
216 >>> from cryptography.hazmat.primitives import hashes
217 >>> cert.fingerprint(hashes.SHA256())
Paul Kehrer78a81502014-12-16 14:47:52 -0600218 '\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 -0600219
Paul Kehrerb2de9482014-12-11 14:54:48 -0600220 .. attribute:: serial
221
222 :type: int
223
224 The serial as a Python integer.
225
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600226 .. doctest::
227
228 >>> cert.serial
229 2
230
Paul Kehrerb2de9482014-12-11 14:54:48 -0600231 .. method:: public_key()
232
233 :type:
Alex Stapletonf79c2312014-12-30 12:50:14 +0000234 :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey` or
Paul Kehrer45efdbc2015-02-12 10:58:22 -0600235 :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey` or
236 :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey`
Paul Kehrerb2de9482014-12-11 14:54:48 -0600237
238 The public key associated with the certificate.
239
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600240 .. doctest::
241
Alex Stapletonf79c2312014-12-30 12:50:14 +0000242 >>> from cryptography.hazmat.primitives.asymmetric import rsa
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600243 >>> public_key = cert.public_key()
Alex Stapletonf79c2312014-12-30 12:50:14 +0000244 >>> isinstance(public_key, rsa.RSAPublicKey)
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600245 True
246
Paul Kehrerb2de9482014-12-11 14:54:48 -0600247 .. attribute:: not_valid_before
248
249 :type: :class:`datetime.datetime`
250
Paul Kehrer78a81502014-12-16 14:47:52 -0600251 A naïve datetime representing the beginning of the validity period for
252 the certificate in UTC. This value is inclusive.
Paul Kehrerb2de9482014-12-11 14:54:48 -0600253
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600254 .. doctest::
255
256 >>> cert.not_valid_before
257 datetime.datetime(2010, 1, 1, 8, 30)
258
Paul Kehrerb2de9482014-12-11 14:54:48 -0600259 .. attribute:: not_valid_after
260
261 :type: :class:`datetime.datetime`
262
Paul Kehrer78a81502014-12-16 14:47:52 -0600263 A naïve datetime representing the end of the validity period for the
264 certificate in UTC. This value is inclusive.
Paul Kehrerb2de9482014-12-11 14:54:48 -0600265
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600266 .. doctest::
267
268 >>> cert.not_valid_after
269 datetime.datetime(2030, 12, 31, 8, 30)
270
Paul Kehrer719d5362015-01-01 20:03:52 -0600271 .. attribute:: issuer
272
273 .. versionadded:: 0.8
274
275 :type: :class:`Name`
276
277 The :class:`Name` of the issuer.
278
279 .. attribute:: subject
280
281 .. versionadded:: 0.8
282
283 :type: :class:`Name`
284
285 The :class:`Name` of the subject.
286
Paul Kehrer8802a5b2015-02-13 12:06:57 -0600287 .. attribute:: signature_hash_algorithm
Paul Kehrer56da2a52015-02-11 23:35:07 -0600288
Paul Kehrer8802a5b2015-02-13 12:06:57 -0600289 :type: :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
Paul Kehrer56da2a52015-02-11 23:35:07 -0600290
Paul Kehrere612ec72015-02-16 14:33:35 -0600291 Returns the
Paul Kehrer71d40c62015-02-19 08:21:04 -0600292 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` which
Paul Kehrer1a7ba872015-02-19 18:09:05 -0600293 was used in signing this certificate.
Paul Kehrer56da2a52015-02-11 23:35:07 -0600294
295 .. doctest::
296
Paul Kehrer8802a5b2015-02-13 12:06:57 -0600297 >>> from cryptography.hazmat.primitives import hashes
298 >>> isinstance(cert.signature_hash_algorithm, hashes.SHA256)
299 True
Paul Kehrer719d5362015-01-01 20:03:52 -0600300
Paul Kehrerfbb7ac82015-03-16 19:26:29 -0500301 .. attribute:: extensions
302
303 :type: :class:`Extensions`
304
305 The extensions encoded in the certificate.
306
307 :raises cryptography.x509.DuplicateExtension: If more than one
308 extension of the same type is found within the certificate.
309
Paul Kehrerd8fc0be2015-04-21 08:31:10 -0500310 :raises cryptography.x509.UnsupportedExtension: If the certificate
311 contains an extension that is not supported.
312
Paul Kehrerbed07352015-04-21 08:31:10 -0500313 :raises cryptography.x509.UnsupportedGeneralNameType: If an extension
314 contains a general name that is not supported.
315
Paul Kehrerb8968812015-05-15 09:01:34 -0700316 :raises UnicodeError: If an extension contains IDNA encoding that is
317 invalid or not compliant with IDNA 2008.
318
Paul Kehrerfa56a232015-03-17 13:14:03 -0500319 .. doctest::
320
321 >>> for ext in cert.extensions:
322 ... print(ext)
Paul Kehrerd774de92015-05-03 10:52:25 -0500323 <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 -0400324 <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 -0400325 <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 -0500326 <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 -0500327 <Extension(oid=<ObjectIdentifier(oid=2.5.29.19, name=basicConstraints)>, critical=True, value=<BasicConstraints(ca=True, path_length=None)>)>
328
Andre Carona8aded62015-05-19 20:11:57 -0400329 .. method:: public_bytes(encoding)
330
331 :param encoding: The
332 :class:`~cryptography.hazmat.primitives.serialization.Encoding`
333 that will be used to serialize the certificate.
334
335 :return bytes: The data that can be written to a file or sent
336 over the network to be verified by clients.
337
Erik Trauschke2dcce902015-05-14 16:12:24 -0700338X.509 CRL (Certificate Revocation List) Object
339~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
340
341.. class:: CertificateRevocationList
342
343 .. versionadded:: 1.0
344
345 .. method:: fingerprint(algorithm)
346
347 :param algorithm: The
348 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
349 that will be used to generate the fingerprint.
350
351 :return bytes: The fingerprint using the supplied hash algorithm, as
352 bytes.
353
354 .. attribute:: signature_hash_algorithm
355
356 :type: :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
357
358 Returns the
359 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` which
360 was used in signing this CRL.
361
362 .. attribute:: issuer
363
364 :type: :class:`Name`
365
366 The :class:`Name` of the issuer.
367
368 .. attribute:: next_update
369
370 :type: :class:`datetime.datetime`
371
372 A naïve datetime representing when the next update to this CRL is
373 expected.
374
375 .. attribute:: last_update
376
377 :type: :class:`datetime.datetime`
378
379 A naïve datetime representing when the this CRL was last updated.
380
Erik Trauschkeabb7b6e2015-05-27 15:07:35 -0700381 .. attribute:: revoked_certificates
Erik Trauschke2dcce902015-05-14 16:12:24 -0700382
383 :type: list of :class:`RevokedCertificate`
384
385 The revoked certificates listed in this CRL.
386
387 .. attribute:: extensions
388
389 :type: :class:`Extensions`
390
391 The extensions encoded in the CRL.
392
Paul Kehrer5aadb9c2015-03-11 20:48:42 -0500393X.509 CSR (Certificate Signing Request) Object
394~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600395
Paul Kehrera1a1f232015-03-15 15:34:35 -0500396.. class:: CertificateSigningRequest
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600397
398 .. versionadded:: 0.9
399
400 .. method:: public_key()
401
402 :type:
403 :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey` or
404 :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey` or
405 :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey`
406
407 The public key associated with the request.
408
409 .. doctest::
410
411 >>> from cryptography.hazmat.primitives.asymmetric import rsa
Paul Kehrera1a1f232015-03-15 15:34:35 -0500412 >>> public_key = csr.public_key()
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600413 >>> isinstance(public_key, rsa.RSAPublicKey)
414 True
415
416 .. attribute:: subject
417
418 :type: :class:`Name`
419
420 The :class:`Name` of the subject.
421
422 .. attribute:: signature_hash_algorithm
423
424 :type: :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
425
426 Returns the
427 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` which
428 was used in signing this request.
429
430 .. doctest::
431
432 >>> from cryptography.hazmat.primitives import hashes
Paul Kehrera1a1f232015-03-15 15:34:35 -0500433 >>> isinstance(csr.signature_hash_algorithm, hashes.SHA1)
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600434 True
435
Andre Caron476c5df2015-05-18 10:23:28 -0400436 .. method:: public_bytes(encoding)
437
438 :param encoding: The
439 :class:`~cryptography.hazmat.primitives.serialization.Encoding`
440 that will be used to serialize the certificate request.
441
442 :return bytes: The data that can be written to a file or sent
443 over the network to be signed by the certificate
444 authority.
445
Erik Trauschke2dcce902015-05-14 16:12:24 -0700446X.509 Revoked Certificate Object
Erik Trauschkec5a8d172015-05-28 10:24:25 -0700447~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Erik Trauschke2dcce902015-05-14 16:12:24 -0700448
449.. class:: RevokedCertificate
450
451 .. versionadded:: 1.0
452
453 .. attribute:: serial_number
454
455 :type: :class:`int`
456
457 An integer representing the serial number of the revoked certificate.
458
459 .. attribute:: revocation_date
460
461 :type: :class:`datetime.datetime`
462
463 A naïve datetime representing the date this certificates was revoked.
464
465 .. attribute:: extensions
466
467 :type: :class:`Extensions`
468
469 The extensions encoded in the revoked certificate.
Andre Caron476c5df2015-05-18 10:23:28 -0400470
Andre Caron0ef595f2015-05-18 13:53:43 -0400471X.509 CSR (Certificate Signing Request) Builder Object
472~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
473
474.. class:: CertificateSigningRequestBuilder
475
476 .. method:: __init__()
477
478 Creates an empty certificate signing request.
479
480 .. method:: set_version(version)
481
482 :param version: The :class:`Version` of the X.509 protocol.
483
484 .. method:: set_subject_name(name)
485
486 :param name: The :class:`Name` of the certificate subject.
487
488 .. method:: add_extension(extension)
489
490 :param extension: The :class:`Extension` to add to the request.
491
492 .. method:: sign(backend, private_key, algorithm)
493
494 :param backend: Backend that will be used to sign the request.
495 Must support the
496 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
497 interface.
498
499 :param private_key: The
500 :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPrivateKey`
501 that will be used to sign the request. When the request is
502 signed by a certificate authority, the private key's associated
503 public key will be stored in the resulting certificate.
504
505 :param algorithm: The
506 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
507 that will be used to generate the request signature.
508
509 :type: :class:`CertificateSigningRequest`
510
511
Paul Kehrer719d5362015-01-01 20:03:52 -0600512.. class:: Name
513
514 .. versionadded:: 0.8
515
Paul Kehrer53d8d492015-02-13 18:47:30 -0600516 An X509 Name is an ordered list of attributes. The object is iterable to
Paul Kehrerd21596e2015-02-14 09:17:26 -0600517 get every attribute or you can use :meth:`Name.get_attributes_for_oid` to
Paul Kehrer719d5362015-01-01 20:03:52 -0600518 obtain the specific type you want. Names are sometimes represented as a
Paul Kehrer53d8d492015-02-13 18:47:30 -0600519 slash or comma delimited string (e.g. ``/CN=mydomain.com/O=My Org/C=US`` or
520 ``CN=mydomain.com, O=My Org, C=US``).
Paul Kehrer719d5362015-01-01 20:03:52 -0600521
Paul Kehrer53d8d492015-02-13 18:47:30 -0600522 .. doctest::
Paul Kehrer719d5362015-01-01 20:03:52 -0600523
Paul Kehrer8b21a4a2015-02-14 07:56:36 -0600524 >>> len(cert.subject)
Paul Kehrer53d8d492015-02-13 18:47:30 -0600525 3
Paul Kehrer8b21a4a2015-02-14 07:56:36 -0600526 >>> for attribute in cert.subject:
527 ... print(attribute)
528 <NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.6, name=countryName)>, value=u'US')>
529 <NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.10, name=organizationName)>, value=u'Test Certificates 2011')>
530 <NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.3, name=commonName)>, value=u'Good CA')>
Paul Kehrer719d5362015-01-01 20:03:52 -0600531
Paul Kehrere901d642015-02-11 18:50:58 -0600532 .. method:: get_attributes_for_oid(oid)
Paul Kehrer719d5362015-01-01 20:03:52 -0600533
Paul Kehrere901d642015-02-11 18:50:58 -0600534 :param oid: An :class:`ObjectIdentifier` instance.
Paul Kehrer719d5362015-01-01 20:03:52 -0600535
Paul Kehrere901d642015-02-11 18:50:58 -0600536 :returns: A list of :class:`NameAttribute` instances that match the
537 OID provided. If nothing matches an empty list will be returned.
Paul Kehrer719d5362015-01-01 20:03:52 -0600538
539 .. doctest::
540
Paul Kehrere901d642015-02-11 18:50:58 -0600541 >>> cert.subject.get_attributes_for_oid(x509.OID_COMMON_NAME)
542 [<NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.3, name=commonName)>, value=u'Good CA')>]
Paul Kehrerb2de9482014-12-11 14:54:48 -0600543
Paul Kehrere76cd272014-12-14 19:00:51 -0600544.. class:: Version
Paul Kehrer016e08a2014-11-26 09:41:18 -1000545
546 .. versionadded:: 0.7
547
548 An enumeration for X.509 versions.
549
550 .. attribute:: v1
551
552 For version 1 X.509 certificates.
553
554 .. attribute:: v3
555
556 For version 3 X.509 certificates.
557
Paul Kehrer806bfb22015-02-02 17:05:24 -0600558.. class:: NameAttribute
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600559
560 .. versionadded:: 0.8
561
Paul Kehrer834d22f2015-02-06 11:01:07 -0600562 An X.509 name consists of a list of NameAttribute instances.
Paul Kehrer5b0a8d62015-01-30 20:05:55 -0600563
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600564 .. attribute:: oid
565
566 :type: :class:`ObjectIdentifier`
567
568 The attribute OID.
569
570 .. attribute:: value
571
Paul Kehrerd5852cb2015-01-30 08:25:23 -0600572 :type: :term:`text`
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600573
574 The value of the attribute.
575
576.. class:: ObjectIdentifier
577
578 .. versionadded:: 0.8
579
Paul Kehrer5b0a8d62015-01-30 20:05:55 -0600580 Object identifiers (frequently seen abbreviated as OID) identify the type
Paul Kehrer806bfb22015-02-02 17:05:24 -0600581 of a value (see: :class:`NameAttribute`).
Paul Kehrer5b0a8d62015-01-30 20:05:55 -0600582
Paul Kehrerd44f9a62015-02-04 14:47:34 -0600583 .. attribute:: dotted_string
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600584
585 :type: :class:`str`
586
Paul Kehrerfedf4f42015-02-06 11:22:07 -0600587 The dotted string value of the OID (e.g. ``"2.5.4.3"``)
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600588
Paul Kehrer31bdf792015-03-25 14:11:00 -0500589.. _general_name_classes:
590
591General Name Classes
592~~~~~~~~~~~~~~~~~~~~
593
594.. class:: GeneralName
595
596 .. versionadded:: 0.9
597
598 This is the generic interface that all the following classes are registered
599 against.
600
601.. class:: RFC822Name
602
603 .. versionadded:: 0.9
604
605 This corresponds to an email address. For example, ``user@example.com``.
606
607 .. attribute:: value
608
609 :type: :term:`text`
610
611.. class:: DNSName
612
613 .. versionadded:: 0.9
614
615 This corresponds to a domain name. For example, ``cryptography.io``.
616
617 .. attribute:: value
618
619 :type: :term:`text`
620
621.. class:: DirectoryName
622
623 .. versionadded:: 0.9
624
625 This corresponds to a directory name.
626
627 .. attribute:: value
628
629 :type: :class:`Name`
630
631.. class:: UniformResourceIdentifier
632
633 .. versionadded:: 0.9
634
635 This corresponds to a uniform resource identifier. For example,
Paul Kehrerb8ef82e2015-04-22 16:04:24 -0500636 ``https://cryptography.io``. The URI is parsed and IDNA decoded (see
637 :rfc:`5895`).
638
639 .. note::
640
641 URIs that do not contain ``://`` in them will not be decoded.
Paul Kehrer31bdf792015-03-25 14:11:00 -0500642
643 .. attribute:: value
644
645 :type: :term:`text`
646
647.. class:: IPAddress
648
649 .. versionadded:: 0.9
650
651 This corresponds to an IP address.
652
653 .. attribute:: value
654
Paul Kehrereb177932015-05-17 18:33:33 -0700655 :type: :class:`~ipaddress.IPv4Address`,
656 :class:`~ipaddress.IPv6Address`, :class:`~ipaddress.IPv4Network`,
657 or :class:`~ipaddress.IPv6Network`.
Paul Kehrer31bdf792015-03-25 14:11:00 -0500658
659.. class:: RegisteredID
660
661 .. versionadded:: 0.9
662
663 This corresponds to a registered ID.
664
665 .. attribute:: value
666
667 :type: :class:`ObjectIdentifier`
668
Paul Kehrer8cf26422015-03-21 09:50:24 -0500669X.509 Extensions
670~~~~~~~~~~~~~~~~
671
Paul Kehrerfbb7ac82015-03-16 19:26:29 -0500672.. class:: Extensions
673
674 .. versionadded:: 0.9
675
676 An X.509 Extensions instance is an ordered list of extensions. The object
677 is iterable to get every extension.
678
Paul Kehrerfa56a232015-03-17 13:14:03 -0500679 .. method:: get_extension_for_oid(oid)
680
681 :param oid: An :class:`ObjectIdentifier` instance.
682
683 :returns: An instance of the extension class.
684
685 :raises cryptography.x509.ExtensionNotFound: If the certificate does
686 not have the extension requested.
687
Paul Kehrerfa56a232015-03-17 13:14:03 -0500688 .. doctest::
689
690 >>> cert.extensions.get_extension_for_oid(x509.OID_BASIC_CONSTRAINTS)
691 <Extension(oid=<ObjectIdentifier(oid=2.5.29.19, name=basicConstraints)>, critical=True, value=<BasicConstraints(ca=True, path_length=None)>)>
692
Paul Kehrer8cf26422015-03-21 09:50:24 -0500693.. class:: Extension
694
695 .. versionadded:: 0.9
696
Paul Kehrer85894662015-03-22 13:19:31 -0500697 .. attribute:: oid
698
699 :type: :class:`ObjectIdentifier`
700
Paul Kehrer5553d572015-03-23 21:08:01 -0500701 The :ref:`extension OID <extension_oids>`.
Paul Kehrer8cf26422015-03-21 09:50:24 -0500702
703 .. attribute:: critical
704
705 :type: bool
706
Paul Kehrer58b75692015-03-22 23:24:58 -0500707 Determines whether a given extension is critical or not. :rfc:`5280`
708 requires that "A certificate-using system MUST reject the certificate
709 if it encounters a critical extension it does not recognize or a
710 critical extension that contains information that it cannot process".
Paul Kehrer8cf26422015-03-21 09:50:24 -0500711
Paul Kehrer85894662015-03-22 13:19:31 -0500712 .. attribute:: value
713
714 Returns an instance of the extension type corresponding to the OID.
715
Paul Kehrercecbbba2015-03-30 14:58:38 -0500716.. class:: KeyUsage
717
718 .. versionadded:: 0.9
719
720 The key usage extension defines the purpose of the key contained in the
721 certificate. The usage restriction might be employed when a key that could
722 be used for more than one operation is to be restricted. It corresponds to
723 :data:`OID_KEY_USAGE`.
724
725 .. attribute:: digital_signature
726
727 :type: bool
728
Paul Kehrer738407b2015-04-01 22:39:02 -0500729 This purpose is set to true when the subject public key is used for verifying
Paul Kehrercecbbba2015-03-30 14:58:38 -0500730 digital signatures, other than signatures on certificates
731 (``key_cert_sign``) and CRLs (``crl_sign``).
732
733 .. attribute:: content_commitment
734
735 :type: bool
736
Paul Kehrer738407b2015-04-01 22:39:02 -0500737 This purpose is set to true when the subject public key is used for verifying
Paul Kehrercecbbba2015-03-30 14:58:38 -0500738 digital signatures, other than signatures on certificates
739 (``key_cert_sign``) and CRLs (``crl_sign``). It is used to provide a
740 non-repudiation service that protects against the signing entity
741 falsely denying some action. In the case of later conflict, a
742 reliable third party may determine the authenticity of the signed
743 data. This was called ``non_repudiation`` in older revisions of the
744 X.509 specification.
745
746 .. attribute:: key_encipherment
747
748 :type: bool
749
Paul Kehrer738407b2015-04-01 22:39:02 -0500750 This purpose is set to true when the subject public key is used for
751 enciphering private or secret keys.
Paul Kehrercecbbba2015-03-30 14:58:38 -0500752
753 .. attribute:: data_encipherment
754
755 :type: bool
756
Paul Kehrer738407b2015-04-01 22:39:02 -0500757 This purpose is set to true when the subject public key is used for
758 directly enciphering raw user data without the use of an intermediate
759 symmetric cipher.
Paul Kehrercecbbba2015-03-30 14:58:38 -0500760
761 .. attribute:: key_agreement
762
763 :type: bool
764
Paul Kehrer738407b2015-04-01 22:39:02 -0500765 This purpose is set to true when the subject public key is used for key
766 agreement. For example, when a Diffie-Hellman key is to be used for
767 key management, then this purpose is set to true.
Paul Kehrercecbbba2015-03-30 14:58:38 -0500768
769 .. attribute:: key_cert_sign
770
771 :type: bool
772
Paul Kehrer738407b2015-04-01 22:39:02 -0500773 This purpose is set to true when the subject public key is used for
774 verifying signatures on public key certificates. If this purpose is set
775 to true then ``ca`` must be true in the :class:`BasicConstraints`
776 extension.
Paul Kehrercecbbba2015-03-30 14:58:38 -0500777
778 .. attribute:: crl_sign
779
780 :type: bool
781
Paul Kehrer738407b2015-04-01 22:39:02 -0500782 This purpose is set to true when the subject public key is used for
783 verifying signatures on certificate revocation lists.
Paul Kehrercecbbba2015-03-30 14:58:38 -0500784
785 .. attribute:: encipher_only
786
787 :type: bool
788
Paul Kehrer738407b2015-04-01 22:39:02 -0500789 When this purposes is set to true and the ``key_agreement`` purpose is
790 also set, the subject public key may be used only for enciphering data
791 while performing key agreement.
Paul Kehrercecbbba2015-03-30 14:58:38 -0500792
793 :raises ValueError: This is raised if accessed when ``key_agreement``
794 is false.
795
796 .. attribute:: decipher_only
797
798 :type: bool
799
Paul Kehrer738407b2015-04-01 22:39:02 -0500800 When this purposes is set to true and the ``key_agreement`` purpose is
801 also set, the subject public key may be used only for deciphering data
802 while performing key agreement.
Paul Kehrercecbbba2015-03-30 14:58:38 -0500803
804 :raises ValueError: This is raised if accessed when ``key_agreement``
805 is false.
806
807
Paul Kehrer8cf26422015-03-21 09:50:24 -0500808.. class:: BasicConstraints
809
810 .. versionadded:: 0.9
811
Paul Kehrer85894662015-03-22 13:19:31 -0500812 Basic constraints is an X.509 extension type that defines whether a given
Paul Kehrer8cf26422015-03-21 09:50:24 -0500813 certificate is allowed to sign additional certificates and what path
Paul Kehrer85894662015-03-22 13:19:31 -0500814 length restrictions may exist. It corresponds to
815 :data:`OID_BASIC_CONSTRAINTS`.
Paul Kehrer8cf26422015-03-21 09:50:24 -0500816
817 .. attribute:: ca
818
819 :type: bool
820
821 Whether the certificate can sign certificates.
822
823 .. attribute:: path_length
824
Paul Kehrerfd1444c2015-03-21 19:47:05 -0500825 :type: int or None
Paul Kehrer8cf26422015-03-21 09:50:24 -0500826
827 The maximum path length for certificates subordinate to this
828 certificate. This attribute only has meaning if ``ca`` is true.
829 If ``ca`` is true then a path length of None means there's no
830 restriction on the number of subordinate CAs in the certificate chain.
Alex Gaynor99c5f152015-05-03 10:01:04 -0400831 If it is zero or greater then it defines the maximum length for a
832 subordinate CA's certificate chain. For example, a ``path_length`` of 1
833 means the certificate can sign a subordinate CA, but the subordinate CA
834 is not allowed to create subordinates with ``ca`` set to true.
Paul Kehrer8cf26422015-03-21 09:50:24 -0500835
Paul Kehrerffa2a152015-03-31 08:18:25 -0500836.. class:: ExtendedKeyUsage
837
838 .. versionadded:: 0.9
839
840 This extension indicates one or more purposes for which the certified
841 public key may be used, in addition to or in place of the basic
842 purposes indicated in the key usage extension. The object is
843 iterable to obtain the list of :ref:`extended key usage OIDs <eku_oids>`.
844
Paul Kehrer4a1038e2015-05-18 10:28:31 -0700845.. class:: OCSPNoCheck
846
Paul Kehrer506a2152015-05-26 08:01:18 -0500847 .. versionadded:: 1.0
Paul Kehrer4a1038e2015-05-18 10:28:31 -0700848
849 This presence of this extension indicates that an OCSP client can trust a
850 responder for the lifetime of the responder's certificate. CAs issuing
851 such a certificate should realize that a compromise of the responder's key
852 is as serious as the compromise of a CA key used to sign CRLs, at least for
853 the validity period of this certificate. CA's may choose to issue this type
854 of certificate with a very short lifetime and renew it frequently. This
855 extension is only relevant when the certificate is an authorized OCSP
856 responder.
857
Paul Kehrere0017be2015-05-17 20:39:40 -0600858.. class:: NameConstraints
859
860 .. versionadded:: 1.0
861
862 The name constraints extension, which only has meaning in a CA certificate,
863 defines a name space within which all subject names in certificates issued
864 beneath the CA certificate must (or must not) be in. For specific details
865 on the way this extension should be processed see :rfc:`5280`.
866
867 .. attribute:: permitted_subtrees
868
869 :type: list of :class:`GeneralName` objects or None
870
871 The set of permitted name patterns. If a name matches this and an
872 element in ``excluded_subtrees`` it is invalid. At least one of
873 ``permitted_subtrees`` and ``excluded_subtrees`` will be non-None.
874
875 .. attribute:: excluded_subtrees
876
877 :type: list of :class:`GeneralName` objects or None
878
879 Any name matching a restriction in the ``excluded_subtrees`` field is
880 invalid regardless of information appearing in the
881 ``permitted_subtrees``. At least one of ``permitted_subtrees`` and
882 ``excluded_subtrees`` will be non-None.
883
Paul Kehrer2eb4ed92015-04-11 15:33:45 -0400884.. class:: AuthorityKeyIdentifier
885
886 .. versionadded:: 0.9
887
888 The authority key identifier extension provides a means of identifying the
889 public key corresponding to the private key used to sign a certificate.
Paul Kehrer8c8cd722015-04-19 09:15:04 -0500890 This extension is typically used to assist in determining the appropriate
891 certificate chain. For more information about generation and use of this
892 extension see `RFC 5280 section 4.2.1.1`_.
Paul Kehrer2eb4ed92015-04-11 15:33:45 -0400893
894 .. attribute:: key_identifier
895
896 :type: bytes
897
Paul Kehrer9104b1d2015-04-18 09:23:44 -0500898 A value derived from the public key used to verify the certificate's
Paul Kehrer8c8cd722015-04-19 09:15:04 -0500899 signature.
Paul Kehrer9104b1d2015-04-18 09:23:44 -0500900
Paul Kehrer2eb4ed92015-04-11 15:33:45 -0400901 .. attribute:: authority_cert_issuer
902
903 :type: :class:`Name` or None
904
Paul Kehrer9104b1d2015-04-18 09:23:44 -0500905 The :class:`Name` of the issuer's issuer.
906
Paul Kehrer2eb4ed92015-04-11 15:33:45 -0400907 .. attribute:: authority_cert_serial_number
908
909 :type: int or None
910
Paul Kehrer9104b1d2015-04-18 09:23:44 -0500911 The serial number of the issuer's issuer.
912
Paul Kehrer1eb82a62015-03-31 20:00:33 -0500913.. class:: SubjectKeyIdentifier
914
915 .. versionadded:: 0.9
916
917 The subject key identifier extension provides a means of identifying
918 certificates that contain a particular public key.
919
920 .. attribute:: digest
921
922 :type: bytes
923
924 The binary value of the identifier.
925
Paul Kehrer31bdf792015-03-25 14:11:00 -0500926.. class:: SubjectAlternativeName
927
928 .. versionadded:: 0.9
929
930 Subject alternative name is an X.509 extension that provides a list of
931 :ref:`general name <general_name_classes>` instances that provide a set
932 of identities for which the certificate is valid. The object is iterable to
933 get every element.
934
935 .. method:: get_values_for_type(type)
936
937 :param type: A :class:`GeneralName` provider. This is one of the
938 :ref:`general name classes <general_name_classes>`.
939
940 :returns: A list of values extracted from the matched general names.
941
Paul Kehrer93ae8052015-05-02 23:18:09 -0500942 .. doctest::
943
944 >>> from cryptography import x509
945 >>> from cryptography.hazmat.backends import default_backend
946 >>> from cryptography.hazmat.primitives import hashes
947 >>> cert = x509.load_pem_x509_certificate(cryptography_cert_pem, default_backend())
Paul Kehrerd0cd5072015-05-02 23:27:00 -0500948 >>> # Get the subjectAltName extension from the certificate
Paul Kehrer93ae8052015-05-02 23:18:09 -0500949 >>> ext = cert.extensions.get_extension_for_oid(x509.OID_SUBJECT_ALTERNATIVE_NAME)
Paul Kehrerd0cd5072015-05-02 23:27:00 -0500950 >>> # Get the dNSName entries from the SAN extension
951 >>> ext.value.get_values_for_type(x509.DNSName)
Paul Kehrer93ae8052015-05-02 23:18:09 -0500952 [u'www.cryptography.io', u'cryptography.io']
953
Paul Kehrer8cf26422015-03-21 09:50:24 -0500954
Paul Kehrer99125c92015-06-07 18:37:10 -0500955.. class:: IssuerAlternativeName
956
957 .. versionadded:: 1.0
958
959 Issuer alternative name is an X.509 extension that provides a list of
960 :ref:`general name <general_name_classes>` instances that provide a set
961 of identities for the certificate issuer. The object is iterable to
962 get every element.
963
964 .. method:: get_values_for_type(type)
965
966 :param type: A :class:`GeneralName` provider. This is one of the
967 :ref:`general name classes <general_name_classes>`.
968
969 :returns: A list of values extracted from the matched general names.
970
971
Paul Kehrer3e6d5582015-05-02 21:57:56 -0500972.. class:: AuthorityInformationAccess
973
974 .. versionadded:: 0.9
975
976 The authority information access extension indicates how to access
977 information and services for the issuer of the certificate in which
978 the extension appears. Information and services may include online
979 validation services (such as OCSP) and issuer data. It is an iterable,
980 containing one or more :class:`AccessDescription` instances.
981
982
983.. class:: AccessDescription
984
Paul Kehrer5a485522015-05-06 00:29:12 -0500985 .. versionadded:: 0.9
986
Paul Kehrer3e6d5582015-05-02 21:57:56 -0500987 .. attribute:: access_method
988
989 :type: :class:`ObjectIdentifier`
990
Paul Kehrerf506bca2015-05-02 22:31:47 -0500991 The access method defines what the ``access_location`` means. It must
992 be either :data:`OID_OCSP` or :data:`OID_CA_ISSUERS`. If it is
993 :data:`OID_OCSP` the access location will be where to obtain OCSP
994 information for the certificate. If it is :data:`OID_CA_ISSUERS` the
995 access location will provide additional information about the issuing
996 certificate.
Paul Kehrer3e6d5582015-05-02 21:57:56 -0500997
998 .. attribute:: access_location
999
1000 :type: :class:`GeneralName`
1001
Paul Kehrerf506bca2015-05-02 22:31:47 -05001002 Where to access the information defined by the access method.
1003
Paul Kehrer5a485522015-05-06 00:29:12 -05001004.. class:: CRLDistributionPoints
1005
1006 .. versionadded:: 0.9
1007
1008 The CRL distribution points extension identifies how CRL information is
1009 obtained. It is an iterable, containing one or more
1010 :class:`DistributionPoint` instances.
1011
1012.. class:: DistributionPoint
1013
1014 .. versionadded:: 0.9
1015
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001016 .. attribute:: full_name
Paul Kehrer5a485522015-05-06 00:29:12 -05001017
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001018 :type: list of :class:`GeneralName` instances or None
Paul Kehrer5a485522015-05-06 00:29:12 -05001019
Paul Kehrerf2c072b2015-05-09 17:04:28 -05001020 This field describes methods to retrieve the CRL. At most one of
1021 ``full_name`` or ``relative_name`` will be non-None.
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001022
1023 .. attribute:: relative_name
1024
1025 :type: :class:`Name` or None
1026
1027 This field describes methods to retrieve the CRL relative to the CRL
Paul Kehrerf2c072b2015-05-09 17:04:28 -05001028 issuer. At most one of ``full_name`` or ``relative_name`` will be
1029 non-None.
Paul Kehrer5a485522015-05-06 00:29:12 -05001030
1031 .. attribute:: crl_issuer
1032
1033 :type: list of :class:`GeneralName` instances or None
1034
1035 Information about the issuer of the CRL.
1036
1037 .. attribute:: reasons
1038
Paul Kehrer3fd02602015-05-09 19:46:13 -05001039 :type: frozenset of :class:`ReasonFlags` or None
Paul Kehrer5a485522015-05-06 00:29:12 -05001040
1041 The reasons a given distribution point may be used for when performing
1042 revocation checks.
1043
1044.. class:: ReasonFlags
1045
1046 .. versionadded:: 0.9
1047
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001048 An enumeration for CRL reasons.
1049
1050 .. attribute:: unspecified
1051
1052 It is unspecified why the certificate was revoked. This reason cannot
1053 be used as a reason flag in a :class:`DistributionPoint`.
Paul Kehrer5a485522015-05-06 00:29:12 -05001054
1055 .. attribute:: key_compromise
1056
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001057 This reason indicates that the private key was compromised.
Paul Kehrer5a485522015-05-06 00:29:12 -05001058
1059 .. attribute:: ca_compromise
1060
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001061 This reason indicates that the CA issuing the certificate was
1062 compromised.
Paul Kehrer5a485522015-05-06 00:29:12 -05001063
1064 .. attribute:: affiliation_changed
1065
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001066 This reason indicates that the subject's name or other information has
1067 changed.
Paul Kehrer5a485522015-05-06 00:29:12 -05001068
1069 .. attribute:: superseded
1070
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001071 This reason indicates that a certificate has been superseded.
Paul Kehrer5a485522015-05-06 00:29:12 -05001072
1073 .. attribute:: cessation_of_operation
1074
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001075 This reason indicates that the certificate is no longer required.
Paul Kehrer5a485522015-05-06 00:29:12 -05001076
1077 .. attribute:: certificate_hold
1078
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001079 This reason indicates that the certificate is on hold.
Paul Kehrer5a485522015-05-06 00:29:12 -05001080
1081 .. attribute:: privilege_withdrawn
1082
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001083 This reason indicates that the privilege granted by this certificate
1084 have been withdrawn.
Paul Kehrer5a485522015-05-06 00:29:12 -05001085
1086 .. attribute:: aa_compromise
1087
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001088 When an attribute authority has been compromised.
1089
1090 .. attribute:: remove_from_crl
1091
1092 This reason indicates that the certificate was on hold and should be
1093 removed from the CRL. This reason cannot be used as a reason flag
1094 in a :class:`DistributionPoint`.
Paul Kehrer5a485522015-05-06 00:29:12 -05001095
Paul Kehrer16fae762015-05-01 23:14:20 -05001096.. class:: InhibitAnyPolicy
1097
1098 .. versionadded:: 1.0
1099
1100 The inhibit ``anyPolicy`` extension indicates that the special OID
1101 :data:`OID_ANY_POLICY`, is not considered an explicit match for other
1102 :class:`CertificatePolicies` except when it appears in an intermediate
1103 self-issued CA certificate. The value indicates the number of additional
1104 non-self-issued certificates that may appear in the path before
1105 :data:`OID_ANY_POLICY` is no longer permitted. For example, a value
1106 of one indicates that :data:`OID_ANY_POLICY` may be processed in
1107 certificates issued by the subject of this certificate, but not in
1108 additional certificates in the path.
1109
1110 .. attribute:: skip_certs
1111
1112 :type: int
1113
Paul Kehrer0d210922015-04-28 17:31:07 -05001114.. class:: CertificatePolicies
1115
1116 .. versionadded:: 0.9
1117
Paul Kehrer2e879742015-05-02 23:09:56 -05001118 The certificate policies extension is an iterable, containing one or more
1119 :class:`PolicyInformation` instances.
Paul Kehrer0d210922015-04-28 17:31:07 -05001120
1121Certificate Policies Classes
1122~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1123
1124These classes may be present within a :class:`CertificatePolicies` instance.
1125
1126.. class:: PolicyInformation
1127
1128 .. versionadded:: 0.9
1129
1130 Contains a policy identifier and an optional list of qualifiers.
1131
1132 .. attribute:: policy_identifier
1133
1134 :type: :class:`ObjectIdentifier`
1135
1136 .. attribute:: policy_qualifiers
1137
1138 :type: list
1139
Paul Kehrerba35b3b2015-05-10 13:07:59 -05001140 A list consisting of :term:`text` and/or :class:`UserNotice` objects.
Paul Kehrer3f8ddeb2015-05-11 00:25:36 -05001141 If the value is text it is a pointer to the practice statement
1142 published by the certificate authority. If it is a user notice it is
1143 meant for display to the relying party when the certificate is
1144 used.
Paul Kehrer2e879742015-05-02 23:09:56 -05001145
Paul Kehrer0d210922015-04-28 17:31:07 -05001146.. class:: UserNotice
1147
1148 .. versionadded:: 0.9
1149
Paul Kehrer2e879742015-05-02 23:09:56 -05001150 User notices are intended for display to a relying party when a certificate
1151 is used. In practice, few if any UIs expose this data and it is a rarely
1152 encoded component.
1153
Paul Kehrer0d210922015-04-28 17:31:07 -05001154 .. attribute:: notice_reference
1155
1156 :type: :class:`NoticeReference` or None
1157
Paul Kehrer2e879742015-05-02 23:09:56 -05001158 The notice reference field names an organization and identifies,
1159 by number, a particular statement prepared by that organization.
1160
Paul Kehrer0d210922015-04-28 17:31:07 -05001161 .. attribute:: explicit_text
1162
Paul Kehrer2e879742015-05-02 23:09:56 -05001163 This field includes an arbitrary textual statement directly in the
1164 certificate.
1165
Paul Kehrer0d210922015-04-28 17:31:07 -05001166 :type: :term:`text`
1167
1168.. class:: NoticeReference
1169
Paul Kehrer2e879742015-05-02 23:09:56 -05001170 Notice reference can name an organization and provide information about
1171 notices related to the certificate. For example, it might identify the
1172 organization name and notice number 1. Application software could
1173 have a notice file containing the current set of notices for the named
1174 organization; the application would then extract the notice text from the
1175 file and display it. In practice this is rarely seen.
1176
Paul Kehrer0d210922015-04-28 17:31:07 -05001177 .. versionadded:: 0.9
1178
1179 .. attribute:: organization
1180
Paul Kehrer66c61702015-05-12 16:39:18 -05001181 :type: :term:`text`
Paul Kehrer0d210922015-04-28 17:31:07 -05001182
Paul Kehrer3f8ddeb2015-05-11 00:25:36 -05001183 .. attribute:: notice_numbers
Paul Kehrer0d210922015-04-28 17:31:07 -05001184
Paul Kehrer66c61702015-05-12 16:39:18 -05001185 :type: list
Paul Kehrer0d210922015-04-28 17:31:07 -05001186
Paul Kehrer66c61702015-05-12 16:39:18 -05001187 A list of integers.
Paul Kehrer0d210922015-04-28 17:31:07 -05001188
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001189Object Identifiers
1190~~~~~~~~~~~~~~~~~~
1191
Paul Kehrer4bb46492015-02-07 16:59:14 -06001192X.509 elements are frequently identified by :class:`ObjectIdentifier`
1193instances. The following common OIDs are available as constants.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001194
Paul Kehrer56da2a52015-02-11 23:35:07 -06001195Name OIDs
1196~~~~~~~~~
1197
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001198.. data:: OID_COMMON_NAME
1199
Paul Kehrerfb5ac9e2015-02-07 16:29:37 -06001200 Corresponds to the dotted string ``"2.5.4.3"``. Historically the domain
1201 name would be encoded here for server certificates. :rfc:`2818` deprecates
1202 this practice and names of that type should now be located in a
Paul Kehrer4bb46492015-02-07 16:59:14 -06001203 SubjectAlternativeName extension. This OID is typically seen in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001204
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001205.. data:: OID_COUNTRY_NAME
1206
Paul Kehrer4bb46492015-02-07 16:59:14 -06001207 Corresponds to the dotted string ``"2.5.4.6"``. This OID is typically seen
1208 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001209
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001210.. data:: OID_LOCALITY_NAME
1211
Paul Kehrer4bb46492015-02-07 16:59:14 -06001212 Corresponds to the dotted string ``"2.5.4.7"``. This OID is typically seen
1213 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001214
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001215.. data:: OID_STATE_OR_PROVINCE_NAME
1216
Paul Kehrer4bb46492015-02-07 16:59:14 -06001217 Corresponds to the dotted string ``"2.5.4.8"``. This OID is typically seen
1218 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001219
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001220.. data:: OID_ORGANIZATION_NAME
1221
Paul Kehrer4bb46492015-02-07 16:59:14 -06001222 Corresponds to the dotted string ``"2.5.4.10"``. This OID is typically seen
1223 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001224
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001225.. data:: OID_ORGANIZATIONAL_UNIT_NAME
1226
Paul Kehrer4bb46492015-02-07 16:59:14 -06001227 Corresponds to the dotted string ``"2.5.4.11"``. This OID is typically seen
1228 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001229
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001230.. data:: OID_SERIAL_NUMBER
1231
Paul Kehrerfb5ac9e2015-02-07 16:29:37 -06001232 Corresponds to the dotted string ``"2.5.4.5"``. This is distinct from the
1233 serial number of the certificate itself (which can be obtained with
Paul Kehrer4bb46492015-02-07 16:59:14 -06001234 :func:`Certificate.serial`). This OID is typically seen in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001235
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001236.. data:: OID_SURNAME
1237
Paul Kehrer4bb46492015-02-07 16:59:14 -06001238 Corresponds to the dotted string ``"2.5.4.4"``. This OID is typically seen
1239 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001240
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001241.. data:: OID_GIVEN_NAME
1242
Paul Kehrer4bb46492015-02-07 16:59:14 -06001243 Corresponds to the dotted string ``"2.5.4.42"``. This OID is typically seen
1244 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001245
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001246.. data:: OID_TITLE
1247
Paul Kehrer4bb46492015-02-07 16:59:14 -06001248 Corresponds to the dotted string ``"2.5.4.12"``. This OID is typically seen
1249 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001250
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001251.. data:: OID_GENERATION_QUALIFIER
1252
Paul Kehrer4bb46492015-02-07 16:59:14 -06001253 Corresponds to the dotted string ``"2.5.4.44"``. This OID is typically seen
1254 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001255
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001256.. data:: OID_DN_QUALIFIER
1257
Paul Kehrerfb5ac9e2015-02-07 16:29:37 -06001258 Corresponds to the dotted string ``"2.5.4.46"``. This specifies
1259 disambiguating information to add to the relative distinguished name of an
Paul Kehrer4bb46492015-02-07 16:59:14 -06001260 entry. See :rfc:`2256`. This OID is typically seen in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001261
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001262.. data:: OID_PSEUDONYM
1263
Paul Kehrer4bb46492015-02-07 16:59:14 -06001264 Corresponds to the dotted string ``"2.5.4.65"``. This OID is typically seen
1265 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001266
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001267.. data:: OID_DOMAIN_COMPONENT
1268
Paul Kehrerfb5ac9e2015-02-07 16:29:37 -06001269 Corresponds to the dotted string ``"0.9.2342.19200300.100.1.25"``. A string
Paul Kehrer4bb46492015-02-07 16:59:14 -06001270 holding one component of a domain name. See :rfc:`4519`. This OID is
1271 typically seen in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001272
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001273.. data:: OID_EMAIL_ADDRESS
1274
Paul Kehrer4bb46492015-02-07 16:59:14 -06001275 Corresponds to the dotted string ``"1.2.840.113549.1.9.1"``. This OID is
1276 typically seen in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001277
Paul Kehrer56da2a52015-02-11 23:35:07 -06001278Signature Algorithm OIDs
1279~~~~~~~~~~~~~~~~~~~~~~~~
1280
Paul Kehrer1a7ba872015-02-19 18:09:05 -06001281.. data:: OID_RSA_WITH_MD5
Paul Kehrer56da2a52015-02-11 23:35:07 -06001282
1283 Corresponds to the dotted string ``"1.2.840.113549.1.1.4"``. This is
1284 an MD5 digest signed by an RSA key.
1285
Paul Kehrer1a7ba872015-02-19 18:09:05 -06001286.. data:: OID_RSA_WITH_SHA1
Paul Kehrer56da2a52015-02-11 23:35:07 -06001287
1288 Corresponds to the dotted string ``"1.2.840.113549.1.1.5"``. This is
1289 a SHA1 digest signed by an RSA key.
1290
Paul Kehrer1a7ba872015-02-19 18:09:05 -06001291.. data:: OID_RSA_WITH_SHA224
Paul Kehrer56da2a52015-02-11 23:35:07 -06001292
1293 Corresponds to the dotted string ``"1.2.840.113549.1.1.14"``. This is
1294 a SHA224 digest signed by an RSA key.
1295
Paul Kehrer1a7ba872015-02-19 18:09:05 -06001296.. data:: OID_RSA_WITH_SHA256
Paul Kehrer56da2a52015-02-11 23:35:07 -06001297
1298 Corresponds to the dotted string ``"1.2.840.113549.1.1.11"``. This is
1299 a SHA256 digest signed by an RSA key.
1300
Paul Kehrer1a7ba872015-02-19 18:09:05 -06001301.. data:: OID_RSA_WITH_SHA384
Paul Kehrer56da2a52015-02-11 23:35:07 -06001302
1303 Corresponds to the dotted string ``"1.2.840.113549.1.1.12"``. This is
1304 a SHA384 digest signed by an RSA key.
1305
Paul Kehrer1a7ba872015-02-19 18:09:05 -06001306.. data:: OID_RSA_WITH_SHA512
Paul Kehrer56da2a52015-02-11 23:35:07 -06001307
1308 Corresponds to the dotted string ``"1.2.840.113549.1.1.13"``. This is
1309 a SHA512 digest signed by an RSA key.
1310
Alex Gaynor3aadabf2015-06-23 22:06:21 -04001311.. data:: OID_ECDSA_WITH_SHA1
1312
1313 Corresponds to the dotted string ``"1.2.840.10045.4.1"``. This is a SHA1
1314 digest signed by an ECDSA key.
1315
Paul Kehrer56da2a52015-02-11 23:35:07 -06001316.. data:: OID_ECDSA_WITH_SHA224
1317
1318 Corresponds to the dotted string ``"1.2.840.10045.4.3.1"``. This is
1319 a SHA224 digest signed by an ECDSA key.
1320
1321.. data:: OID_ECDSA_WITH_SHA256
1322
1323 Corresponds to the dotted string ``"1.2.840.10045.4.3.2"``. This is
1324 a SHA256 digest signed by an ECDSA key.
1325
1326.. data:: OID_ECDSA_WITH_SHA384
1327
1328 Corresponds to the dotted string ``"1.2.840.10045.4.3.3"``. This is
1329 a SHA384 digest signed by an ECDSA key.
1330
1331.. data:: OID_ECDSA_WITH_SHA512
1332
1333 Corresponds to the dotted string ``"1.2.840.10045.4.3.4"``. This is
1334 a SHA512 digest signed by an ECDSA key.
1335
1336.. data:: OID_DSA_WITH_SHA1
1337
1338 Corresponds to the dotted string ``"1.2.840.10040.4.3"``. This is
1339 a SHA1 digest signed by a DSA key.
1340
1341.. data:: OID_DSA_WITH_SHA224
1342
1343 Corresponds to the dotted string ``"2.16.840.1.101.3.4.3.1"``. This is
1344 a SHA224 digest signed by a DSA key.
1345
1346.. data:: OID_DSA_WITH_SHA256
1347
Paul Kehrerfbb7ac82015-03-16 19:26:29 -05001348 Corresponds to the dotted string ``"2.16.840.1.101.3.4.3.2"``. This is
Paul Kehrer56da2a52015-02-11 23:35:07 -06001349 a SHA256 digest signed by a DSA key.
1350
Paul Kehrerffa2a152015-03-31 08:18:25 -05001351.. _eku_oids:
1352
Paul Kehrere1513fa2015-03-30 23:08:17 -05001353Extended Key Usage OIDs
1354~~~~~~~~~~~~~~~~~~~~~~~
1355
1356.. data:: OID_SERVER_AUTH
1357
1358 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.1"``. This is used to
1359 denote that a certificate may be used for TLS web server authentication.
1360
1361.. data:: OID_CLIENT_AUTH
1362
1363 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.2"``. This is used to
1364 denote that a certificate may be used for TLS web client authentication.
1365
1366.. data:: OID_CODE_SIGNING
1367
1368 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.3"``. This is used to
1369 denote that a certificate may be used for code signing.
1370
1371.. data:: OID_EMAIL_PROTECTION
1372
1373 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.4"``. This is used to
1374 denote that a certificate may be used for email protection.
1375
1376.. data:: OID_TIME_STAMPING
1377
1378 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.8"``. This is used to
1379 denote that a certificate may be used for time stamping.
1380
1381.. data:: OID_OCSP_SIGNING
1382
1383 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.9"``. This is used to
1384 denote that a certificate may be used for signing OCSP responses.
1385
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001386Authority Information Access OIDs
1387~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1388
1389.. data:: OID_OCSP
1390
1391 Corresponds to the dotted string ``"1.3.6.1.5.5.7.48.1"``. Used as the
1392 identifier for OCSP data in :class:`AccessDescription` objects.
1393
1394.. data:: OID_CA_ISSUERS
1395
1396 Corresponds to the dotted string ``"1.3.6.1.5.5.7.48.2"``. Used as the
1397 identifier for CA issuer data in :class:`AccessDescription` objects.
1398
Paul Kehrer2e879742015-05-02 23:09:56 -05001399Policy Qualifier OIDs
1400~~~~~~~~~~~~~~~~~~~~~
1401
1402.. data:: OID_CPS_QUALIFIER
1403
Paul Kehrerba35b3b2015-05-10 13:07:59 -05001404 Corresponds to the dotted string ``"1.3.6.1.5.5.7.2.1"``.
Paul Kehrer2e879742015-05-02 23:09:56 -05001405
1406.. data:: OID_CPS_USER_NOTICE
1407
Paul Kehrerba35b3b2015-05-10 13:07:59 -05001408 Corresponds to the dotted string ``"1.3.6.1.5.5.7.2.2"``.
Paul Kehrer2e879742015-05-02 23:09:56 -05001409
Paul Kehrer16fae762015-05-01 23:14:20 -05001410.. data:: OID_ANY_POLICY
1411
1412 Corresponds to the dotted string ``"2.5.29.32.0"``.
1413
Paul Kehrer5553d572015-03-23 21:08:01 -05001414.. _extension_oids:
1415
Paul Kehrer2bb94642015-03-21 09:54:17 -05001416Extension OIDs
1417~~~~~~~~~~~~~~
1418
1419.. data:: OID_BASIC_CONSTRAINTS
1420
1421 Corresponds to the dotted string ``"2.5.29.19"``. The identifier for the
Paul Kehrer611d3d32015-03-22 13:31:18 -05001422 :class:`BasicConstraints` extension type.
Paul Kehrer2bb94642015-03-21 09:54:17 -05001423
Paul Kehrercecbbba2015-03-30 14:58:38 -05001424.. data:: OID_KEY_USAGE
1425
1426 Corresponds to the dotted string ``"2.5.29.15"``. The identifier for the
1427 :class:`KeyUsage` extension type.
1428
Paul Kehrerd4f632e2015-05-12 08:25:42 -05001429.. data:: OID_SUBJECT_ALTERNATIVE_NAME
1430
1431 Corresponds to the dotted string ``"2.5.29.17"``. The identifier for the
1432 :class:`SubjectAlternativeName` extension type.
1433
Paul Kehrer99125c92015-06-07 18:37:10 -05001434.. data:: OID_ISSUER_ALTERNATIVE_NAME
1435
1436 Corresponds to the dotted string ``"2.5.29.18"``. The identifier for the
1437 :class:`IssuerAlternativeName` extension type.
1438
Paul Kehrerd4f632e2015-05-12 08:25:42 -05001439.. data:: OID_SUBJECT_KEY_IDENTIFIER
1440
1441 Corresponds to the dotted string ``"2.5.29.14"``. The identifier for the
1442 :class:`SubjectKeyIdentifier` extension type.
1443
Paul Kehrere0017be2015-05-17 20:39:40 -06001444.. data:: OID_NAME_CONSTRAINTS
1445
1446 Corresponds to the dotted string ``"2.5.29.30"``. The identifier for the
1447 :class:`NameConstraints` extension type.
1448
Paul Kehrerd4f632e2015-05-12 08:25:42 -05001449.. data:: OID_CRL_DISTRIBUTION_POINTS
1450
1451 Corresponds to the dotted string ``"2.5.29.31"``. The identifier for the
1452 :class:`CRLDistributionPoints` extension type.
1453
1454.. data:: OID_CERTIFICATE_POLICIES
1455
1456 Corresponds to the dotted string ``"2.5.29.32"``. The identifier for the
1457 :class:`CertificatePolicies` extension type.
1458
1459.. data:: OID_AUTHORITY_KEY_IDENTIFIER
1460
1461 Corresponds to the dotted string ``"2.5.29.35"``. The identifier for the
1462 :class:`AuthorityKeyIdentifier` extension type.
1463
1464.. data:: OID_EXTENDED_KEY_USAGE
1465
1466 Corresponds to the dotted string ``"2.5.29.37"``. The identifier for the
1467 :class:`ExtendedKeyUsage` extension type.
1468
1469.. data:: OID_AUTHORITY_INFORMATION_ACCESS
1470
1471 Corresponds to the dotted string ``"1.3.6.1.5.5.7.1.1"``. The identifier
1472 for the :class:`AuthorityInformationAccess` extension type.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001473
Paul Kehrer4a1038e2015-05-18 10:28:31 -07001474.. data:: OID_OCSP_NO_CHECK
1475
1476 Corresponds to the dotted string ``"1.3.6.1.5.5.7.48.1.5"``. The identifier
1477 for the :class:`OCSPNoCheck` extension type.
1478
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001479Exceptions
1480~~~~~~~~~~
1481
Paul Kehrere76cd272014-12-14 19:00:51 -06001482.. class:: InvalidVersion
Paul Kehrera68fd332014-11-27 07:08:40 -10001483
1484 This is raised when an X.509 certificate has an invalid version number.
Paul Kehrer016e08a2014-11-26 09:41:18 -10001485
Paul Kehrerd5cccf72014-12-15 17:20:33 -06001486 .. attribute:: parsed_version
1487
Paul Kehrerbbffc402014-12-17 13:33:55 -06001488 :type: int
1489
1490 Returns the raw version that was parsed from the certificate.
Paul Kehrerd5cccf72014-12-15 17:20:33 -06001491
Paul Kehrerfbb7ac82015-03-16 19:26:29 -05001492.. class:: DuplicateExtension
1493
1494 This is raised when more than one X.509 extension of the same type is
1495 found within a certificate.
1496
1497 .. attribute:: oid
1498
1499 :type: :class:`ObjectIdentifier`
1500
1501 Returns the OID.
1502
1503.. class:: UnsupportedExtension
1504
1505 This is raised when a certificate contains an unsupported extension type.
1506
1507 .. attribute:: oid
1508
1509 :type: :class:`ObjectIdentifier`
1510
1511 Returns the OID.
1512
Paul Kehrerfa56a232015-03-17 13:14:03 -05001513.. class:: ExtensionNotFound
1514
1515 This is raised when calling :meth:`Extensions.get_extension_for_oid` with
1516 an extension OID that is not present in the certificate.
1517
1518 .. attribute:: oid
1519
1520 :type: :class:`ObjectIdentifier`
1521
1522 Returns the OID.
1523
Paul Kehrer9089c912015-04-20 22:15:20 -05001524.. class:: UnsupportedGeneralNameType
1525
1526 This is raised when a certificate contains an unsupported general name
1527 type in an extension.
1528
Paul Kehrerbed07352015-04-21 08:31:10 -05001529 .. attribute:: type
1530
Paul Kehrer0a621bf2015-04-22 09:22:56 -05001531 :type: int
1532
1533 The integer value of the unsupported type. The complete list of
1534 types can be found in `RFC 5280 section 4.2.1.6`_.
Paul Kehrerbed07352015-04-21 08:31:10 -05001535
Paul Kehrer016e08a2014-11-26 09:41:18 -10001536
1537.. _`public key infrastructure`: https://en.wikipedia.org/wiki/Public_key_infrastructure
Paul Kehrera68fd332014-11-27 07:08:40 -10001538.. _`TLS`: https://en.wikipedia.org/wiki/Transport_Layer_Security
Paul Kehrerc7c9a432015-04-19 09:20:13 -05001539.. _`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 -05001540.. _`RFC 5280 section 4.2.1.6`: https://tools.ietf.org/html/rfc5280#section-4.2.1.6