blob: 39df4a0b168c95244c826a0332bcf26f62f705e1 [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
53X.509 is an ITU-T standard for a `public key infrastructure`_. X.509v3 is
54defined in :rfc:`5280` (which obsoletes :rfc:`2459` and :rfc:`3280`). X.509
55certificates are commonly used in protocols like `TLS`_.
Paul Kehrerb2de9482014-12-11 14:54:48 -060056
57Loading Certificates
58~~~~~~~~~~~~~~~~~~~~
Paul Kehrer016e08a2014-11-26 09:41:18 -100059
60.. function:: load_pem_x509_certificate(data, backend)
61
62 .. versionadded:: 0.7
63
Paul Kehrere76cd272014-12-14 19:00:51 -060064 Deserialize a certificate from PEM encoded data. PEM certificates are
65 base64 decoded and have delimiters that look like
66 ``-----BEGIN CERTIFICATE-----``.
Paul Kehrer016e08a2014-11-26 09:41:18 -100067
68 :param bytes data: The PEM encoded certificate data.
69
70 :param backend: A backend supporting the
71 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
72 interface.
73
Paul Kehrere76cd272014-12-14 19:00:51 -060074 :returns: An instance of :class:`~cryptography.x509.Certificate`.
Paul Kehrer016e08a2014-11-26 09:41:18 -100075
76.. function:: load_der_x509_certificate(data, backend)
77
78 .. versionadded:: 0.7
79
Paul Kehrere76cd272014-12-14 19:00:51 -060080 Deserialize a certificate from DER encoded data. DER is a binary format
Paul Kehrer92aac382014-12-15 16:25:28 -060081 and is commonly found in files with the ``.cer`` extension (although file
82 extensions are not a guarantee of encoding type).
Paul Kehrer016e08a2014-11-26 09:41:18 -100083
84 :param bytes data: The DER encoded certificate data.
85
86 :param backend: A backend supporting the
87 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
88 interface.
89
Paul Kehrere76cd272014-12-14 19:00:51 -060090 :returns: An instance of :class:`~cryptography.x509.Certificate`.
Paul Kehrer016e08a2014-11-26 09:41:18 -100091
Paul Kehrer016e08a2014-11-26 09:41:18 -100092.. doctest::
93
Paul Kehrercc8a26e2014-12-16 12:40:16 -060094 >>> from cryptography import x509
Paul Kehrer016e08a2014-11-26 09:41:18 -100095 >>> from cryptography.hazmat.backends import default_backend
Paul Kehrercc8a26e2014-12-16 12:40:16 -060096 >>> cert = x509.load_pem_x509_certificate(pem_data, default_backend())
Paul Kehrer016e08a2014-11-26 09:41:18 -100097 >>> cert.serial
98 2
99
Paul Kehrera1a1f232015-03-15 15:34:35 -0500100Loading Certificate Signing Requests
101~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600102
Paul Kehrer31e39882015-03-11 11:37:04 -0500103.. function:: load_pem_x509_csr(data, backend)
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600104
105 .. versionadded:: 0.9
106
Paul Kehrera1a1f232015-03-15 15:34:35 -0500107 Deserialize a certificate signing request (CSR) from PEM encoded data. PEM
Paul Kehrer5aadb9c2015-03-11 20:48:42 -0500108 requests are base64 decoded and have delimiters that look like
Paul Kehrerd3dafbd2015-03-15 16:24:18 -0500109 ``-----BEGIN CERTIFICATE REQUEST-----``. This format is also known as
110 PKCS#10.
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600111
112 :param bytes data: The PEM encoded request data.
113
114 :param backend: A backend supporting the
115 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
116 interface.
117
Paul Kehrera1a1f232015-03-15 15:34:35 -0500118 :returns: An instance of
119 :class:`~cryptography.x509.CertificateSigningRequest`.
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600120
Paul Kehrer1effb6e2015-03-30 15:05:59 -0500121.. function:: load_der_x509_csr(data, backend)
122
123 .. versionadded:: 0.9
124
125 Deserialize a certificate signing request (CSR) from DER encoded data. DER
126 is a binary format and is not commonly used with CSRs.
127
128 :param bytes data: The DER encoded request data.
129
130 :param backend: A backend supporting the
131 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
132 interface.
133
134 :returns: An instance of
135 :class:`~cryptography.x509.CertificateSigningRequest`.
136
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600137.. doctest::
138
139 >>> from cryptography import x509
140 >>> from cryptography.hazmat.backends import default_backend
141 >>> from cryptography.hazmat.primitives import hashes
Paul Kehrera1a1f232015-03-15 15:34:35 -0500142 >>> csr = x509.load_pem_x509_csr(pem_req_data, default_backend())
143 >>> isinstance(csr.signature_hash_algorithm, hashes.SHA1)
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600144 True
145
Paul Kehrere76cd272014-12-14 19:00:51 -0600146X.509 Certificate Object
147~~~~~~~~~~~~~~~~~~~~~~~~
Paul Kehrerb2de9482014-12-11 14:54:48 -0600148
Paul Kehrere76cd272014-12-14 19:00:51 -0600149.. class:: Certificate
Paul Kehrerb2de9482014-12-11 14:54:48 -0600150
151 .. versionadded:: 0.7
152
153 .. attribute:: version
154
Paul Kehrere76cd272014-12-14 19:00:51 -0600155 :type: :class:`~cryptography.x509.Version`
Paul Kehrerb2de9482014-12-11 14:54:48 -0600156
Paul Kehrere76cd272014-12-14 19:00:51 -0600157 The certificate version as an enumeration. Version 3 certificates are
158 the latest version and also the only type you should see in practice.
Paul Kehrerb2de9482014-12-11 14:54:48 -0600159
Alex Gaynor89c4dc82014-12-16 16:49:33 -0800160 :raises cryptography.x509.InvalidVersion: If the version in the
Alex Gaynor6d7ab4c2014-12-16 16:50:33 -0800161 certificate is not a known
162 :class:`X.509 version <cryptography.x509.Version>`.
Paul Kehrer92aac382014-12-15 16:25:28 -0600163
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600164 .. doctest::
165
166 >>> cert.version
167 <Version.v3: 2>
168
Paul Kehrerb2de9482014-12-11 14:54:48 -0600169 .. method:: fingerprint(algorithm)
170
171 :param algorithm: The
Paul Kehrer601278a2015-02-12 12:51:00 -0600172 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
Paul Kehrerb2de9482014-12-11 14:54:48 -0600173 that will be used to generate the fingerprint.
174
175 :return bytes: The fingerprint using the supplied hash algorithm as
176 bytes.
177
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600178 .. doctest::
179
180 >>> from cryptography.hazmat.primitives import hashes
181 >>> cert.fingerprint(hashes.SHA256())
Paul Kehrer78a81502014-12-16 14:47:52 -0600182 '\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 -0600183
Paul Kehrerb2de9482014-12-11 14:54:48 -0600184 .. attribute:: serial
185
186 :type: int
187
188 The serial as a Python integer.
189
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600190 .. doctest::
191
192 >>> cert.serial
193 2
194
Paul Kehrerb2de9482014-12-11 14:54:48 -0600195 .. method:: public_key()
196
197 :type:
Alex Stapletonf79c2312014-12-30 12:50:14 +0000198 :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey` or
Paul Kehrer45efdbc2015-02-12 10:58:22 -0600199 :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey` or
200 :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey`
Paul Kehrerb2de9482014-12-11 14:54:48 -0600201
202 The public key associated with the certificate.
203
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600204 .. doctest::
205
Alex Stapletonf79c2312014-12-30 12:50:14 +0000206 >>> from cryptography.hazmat.primitives.asymmetric import rsa
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600207 >>> public_key = cert.public_key()
Alex Stapletonf79c2312014-12-30 12:50:14 +0000208 >>> isinstance(public_key, rsa.RSAPublicKey)
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600209 True
210
Paul Kehrerb2de9482014-12-11 14:54:48 -0600211 .. attribute:: not_valid_before
212
213 :type: :class:`datetime.datetime`
214
Paul Kehrer78a81502014-12-16 14:47:52 -0600215 A naïve datetime representing the beginning of the validity period for
216 the certificate in UTC. This value is inclusive.
Paul Kehrerb2de9482014-12-11 14:54:48 -0600217
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600218 .. doctest::
219
220 >>> cert.not_valid_before
221 datetime.datetime(2010, 1, 1, 8, 30)
222
Paul Kehrerb2de9482014-12-11 14:54:48 -0600223 .. attribute:: not_valid_after
224
225 :type: :class:`datetime.datetime`
226
Paul Kehrer78a81502014-12-16 14:47:52 -0600227 A naïve datetime representing the end of the validity period for the
228 certificate in UTC. This value is inclusive.
Paul Kehrerb2de9482014-12-11 14:54:48 -0600229
Paul Kehrercc8a26e2014-12-16 12:40:16 -0600230 .. doctest::
231
232 >>> cert.not_valid_after
233 datetime.datetime(2030, 12, 31, 8, 30)
234
Paul Kehrer719d5362015-01-01 20:03:52 -0600235 .. attribute:: issuer
236
237 .. versionadded:: 0.8
238
239 :type: :class:`Name`
240
241 The :class:`Name` of the issuer.
242
243 .. attribute:: subject
244
245 .. versionadded:: 0.8
246
247 :type: :class:`Name`
248
249 The :class:`Name` of the subject.
250
Paul Kehrer8802a5b2015-02-13 12:06:57 -0600251 .. attribute:: signature_hash_algorithm
Paul Kehrer56da2a52015-02-11 23:35:07 -0600252
Paul Kehrer8802a5b2015-02-13 12:06:57 -0600253 :type: :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
Paul Kehrer56da2a52015-02-11 23:35:07 -0600254
Paul Kehrere612ec72015-02-16 14:33:35 -0600255 Returns the
Paul Kehrer71d40c62015-02-19 08:21:04 -0600256 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` which
Paul Kehrer1a7ba872015-02-19 18:09:05 -0600257 was used in signing this certificate.
Paul Kehrer56da2a52015-02-11 23:35:07 -0600258
259 .. doctest::
260
Paul Kehrer8802a5b2015-02-13 12:06:57 -0600261 >>> from cryptography.hazmat.primitives import hashes
262 >>> isinstance(cert.signature_hash_algorithm, hashes.SHA256)
263 True
Paul Kehrer719d5362015-01-01 20:03:52 -0600264
Paul Kehrerfbb7ac82015-03-16 19:26:29 -0500265 .. attribute:: extensions
266
267 :type: :class:`Extensions`
268
269 The extensions encoded in the certificate.
270
271 :raises cryptography.x509.DuplicateExtension: If more than one
272 extension of the same type is found within the certificate.
273
Paul Kehrerfa56a232015-03-17 13:14:03 -0500274 .. doctest::
275
276 >>> for ext in cert.extensions:
277 ... print(ext)
278 <Extension(oid=<ObjectIdentifier(oid=2.5.29.19, name=basicConstraints)>, critical=True, value=<BasicConstraints(ca=True, path_length=None)>)>
279
Paul Kehrer5aadb9c2015-03-11 20:48:42 -0500280X.509 CSR (Certificate Signing Request) Object
281~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600282
Paul Kehrera1a1f232015-03-15 15:34:35 -0500283.. class:: CertificateSigningRequest
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600284
285 .. versionadded:: 0.9
286
287 .. method:: public_key()
288
289 :type:
290 :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey` or
291 :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey` or
292 :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey`
293
294 The public key associated with the request.
295
296 .. doctest::
297
298 >>> from cryptography.hazmat.primitives.asymmetric import rsa
Paul Kehrera1a1f232015-03-15 15:34:35 -0500299 >>> public_key = csr.public_key()
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600300 >>> isinstance(public_key, rsa.RSAPublicKey)
301 True
302
303 .. attribute:: subject
304
305 :type: :class:`Name`
306
307 The :class:`Name` of the subject.
308
309 .. attribute:: signature_hash_algorithm
310
311 :type: :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
312
313 Returns the
314 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm` which
315 was used in signing this request.
316
317 .. doctest::
318
319 >>> from cryptography.hazmat.primitives import hashes
Paul Kehrera1a1f232015-03-15 15:34:35 -0500320 >>> isinstance(csr.signature_hash_algorithm, hashes.SHA1)
Paul Kehrerdc480ad2015-02-23 12:14:54 -0600321 True
322
Paul Kehrer719d5362015-01-01 20:03:52 -0600323.. class:: Name
324
325 .. versionadded:: 0.8
326
Paul Kehrer53d8d492015-02-13 18:47:30 -0600327 An X509 Name is an ordered list of attributes. The object is iterable to
Paul Kehrerd21596e2015-02-14 09:17:26 -0600328 get every attribute or you can use :meth:`Name.get_attributes_for_oid` to
Paul Kehrer719d5362015-01-01 20:03:52 -0600329 obtain the specific type you want. Names are sometimes represented as a
Paul Kehrer53d8d492015-02-13 18:47:30 -0600330 slash or comma delimited string (e.g. ``/CN=mydomain.com/O=My Org/C=US`` or
331 ``CN=mydomain.com, O=My Org, C=US``).
Paul Kehrer719d5362015-01-01 20:03:52 -0600332
Paul Kehrer53d8d492015-02-13 18:47:30 -0600333 .. doctest::
Paul Kehrer719d5362015-01-01 20:03:52 -0600334
Paul Kehrer8b21a4a2015-02-14 07:56:36 -0600335 >>> len(cert.subject)
Paul Kehrer53d8d492015-02-13 18:47:30 -0600336 3
Paul Kehrer8b21a4a2015-02-14 07:56:36 -0600337 >>> for attribute in cert.subject:
338 ... print(attribute)
339 <NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.6, name=countryName)>, value=u'US')>
340 <NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.10, name=organizationName)>, value=u'Test Certificates 2011')>
341 <NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.3, name=commonName)>, value=u'Good CA')>
Paul Kehrer719d5362015-01-01 20:03:52 -0600342
Paul Kehrere901d642015-02-11 18:50:58 -0600343 .. method:: get_attributes_for_oid(oid)
Paul Kehrer719d5362015-01-01 20:03:52 -0600344
Paul Kehrere901d642015-02-11 18:50:58 -0600345 :param oid: An :class:`ObjectIdentifier` instance.
Paul Kehrer719d5362015-01-01 20:03:52 -0600346
Paul Kehrere901d642015-02-11 18:50:58 -0600347 :returns: A list of :class:`NameAttribute` instances that match the
348 OID provided. If nothing matches an empty list will be returned.
Paul Kehrer719d5362015-01-01 20:03:52 -0600349
350 .. doctest::
351
Paul Kehrere901d642015-02-11 18:50:58 -0600352 >>> cert.subject.get_attributes_for_oid(x509.OID_COMMON_NAME)
353 [<NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.3, name=commonName)>, value=u'Good CA')>]
Paul Kehrerb2de9482014-12-11 14:54:48 -0600354
Paul Kehrere76cd272014-12-14 19:00:51 -0600355.. class:: Version
Paul Kehrer016e08a2014-11-26 09:41:18 -1000356
357 .. versionadded:: 0.7
358
359 An enumeration for X.509 versions.
360
361 .. attribute:: v1
362
363 For version 1 X.509 certificates.
364
365 .. attribute:: v3
366
367 For version 3 X.509 certificates.
368
Paul Kehrer806bfb22015-02-02 17:05:24 -0600369.. class:: NameAttribute
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600370
371 .. versionadded:: 0.8
372
Paul Kehrer834d22f2015-02-06 11:01:07 -0600373 An X.509 name consists of a list of NameAttribute instances.
Paul Kehrer5b0a8d62015-01-30 20:05:55 -0600374
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600375 .. attribute:: oid
376
377 :type: :class:`ObjectIdentifier`
378
379 The attribute OID.
380
381 .. attribute:: value
382
Paul Kehrerd5852cb2015-01-30 08:25:23 -0600383 :type: :term:`text`
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600384
385 The value of the attribute.
386
387.. class:: ObjectIdentifier
388
389 .. versionadded:: 0.8
390
Paul Kehrer5b0a8d62015-01-30 20:05:55 -0600391 Object identifiers (frequently seen abbreviated as OID) identify the type
Paul Kehrer806bfb22015-02-02 17:05:24 -0600392 of a value (see: :class:`NameAttribute`).
Paul Kehrer5b0a8d62015-01-30 20:05:55 -0600393
Paul Kehrerd44f9a62015-02-04 14:47:34 -0600394 .. attribute:: dotted_string
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600395
396 :type: :class:`str`
397
Paul Kehrerfedf4f42015-02-06 11:22:07 -0600398 The dotted string value of the OID (e.g. ``"2.5.4.3"``)
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600399
Paul Kehrer8cf26422015-03-21 09:50:24 -0500400X.509 Extensions
401~~~~~~~~~~~~~~~~
402
Paul Kehrerfbb7ac82015-03-16 19:26:29 -0500403.. class:: Extensions
404
405 .. versionadded:: 0.9
406
407 An X.509 Extensions instance is an ordered list of extensions. The object
408 is iterable to get every extension.
409
Paul Kehrerfa56a232015-03-17 13:14:03 -0500410 .. method:: get_extension_for_oid(oid)
411
412 :param oid: An :class:`ObjectIdentifier` instance.
413
414 :returns: An instance of the extension class.
415
416 :raises cryptography.x509.ExtensionNotFound: If the certificate does
417 not have the extension requested.
418
419 :raises cryptography.x509.UnsupportedExtension: If the certificate
420 contains an extension that is not supported.
421
422 .. doctest::
423
424 >>> cert.extensions.get_extension_for_oid(x509.OID_BASIC_CONSTRAINTS)
425 <Extension(oid=<ObjectIdentifier(oid=2.5.29.19, name=basicConstraints)>, critical=True, value=<BasicConstraints(ca=True, path_length=None)>)>
426
Paul Kehrer8cf26422015-03-21 09:50:24 -0500427.. class:: Extension
428
429 .. versionadded:: 0.9
430
Paul Kehrer85894662015-03-22 13:19:31 -0500431 .. attribute:: oid
432
433 :type: :class:`ObjectIdentifier`
434
Paul Kehrer5553d572015-03-23 21:08:01 -0500435 The :ref:`extension OID <extension_oids>`.
Paul Kehrer8cf26422015-03-21 09:50:24 -0500436
437 .. attribute:: critical
438
439 :type: bool
440
Paul Kehrer58b75692015-03-22 23:24:58 -0500441 Determines whether a given extension is critical or not. :rfc:`5280`
442 requires that "A certificate-using system MUST reject the certificate
443 if it encounters a critical extension it does not recognize or a
444 critical extension that contains information that it cannot process".
Paul Kehrer8cf26422015-03-21 09:50:24 -0500445
Paul Kehrer85894662015-03-22 13:19:31 -0500446 .. attribute:: value
447
448 Returns an instance of the extension type corresponding to the OID.
449
Paul Kehrercecbbba2015-03-30 14:58:38 -0500450.. class:: KeyUsage
451
452 .. versionadded:: 0.9
453
454 The key usage extension defines the purpose of the key contained in the
455 certificate. The usage restriction might be employed when a key that could
456 be used for more than one operation is to be restricted. It corresponds to
457 :data:`OID_KEY_USAGE`.
458
459 .. attribute:: digital_signature
460
461 :type: bool
462
463 This is asserted when the subject public key is used for verifying
464 digital signatures, other than signatures on certificates
465 (``key_cert_sign``) and CRLs (``crl_sign``).
466
467 .. attribute:: content_commitment
468
469 :type: bool
470
471 This is asserted when the subject public key is used for verifying
472 digital signatures, other than signatures on certificates
473 (``key_cert_sign``) and CRLs (``crl_sign``). It is used to provide a
474 non-repudiation service that protects against the signing entity
475 falsely denying some action. In the case of later conflict, a
476 reliable third party may determine the authenticity of the signed
477 data. This was called ``non_repudiation`` in older revisions of the
478 X.509 specification.
479
480 .. attribute:: key_encipherment
481
482 :type: bool
483
484 This is asserted when the subject public key is used for enciphering
485 private or secret keys.
486
487 .. attribute:: data_encipherment
488
489 :type: bool
490
491 This is asserted when the subject public key is used for directly
492 enciphering raw user data without the use of an intermediate symmetric
493 cipher.
494
495 .. attribute:: key_agreement
496
497 :type: bool
498
499 This is asserted when the subject public key is used for key agreement.
500 For example, when a Diffie-Hellman key is to be used for key
501 management, then this bit is set.
502
503 .. attribute:: key_cert_sign
504
505 :type: bool
506
507 This is asserted when the subject public key is used for verifying
508 signatures on public key certificates. If this bit is asserted then
509 ``ca`` must be true in the :class:`BasicConstraints` extension.
510
511 .. attribute:: crl_sign
512
513 :type: bool
514
515 This is asserted when the subject public key is used for verifying
516 signatures on certificate revocation lists.
517
518 .. attribute:: encipher_only
519
520 :type: bool
521
522 The meaning of this bit is undefined in the absence of the
523 ``key_agreement`` bit. When this bit is asserted and the
524 ``key_agreement`` bit is also set, the subject public key may be
525 used only for enciphering data while performing key agreement.
526
527 :raises ValueError: This is raised if accessed when ``key_agreement``
528 is false.
529
530 .. attribute:: decipher_only
531
532 :type: bool
533
534 The meaning of this bit is undefined in the absence of the
535 ``key_agreement`` bit. When this bit is asserted and the
536 ``key_agreement`` bit is also set, the subject public key may be
537 used only for deciphering data while performing key agreement.
538
539 :raises ValueError: This is raised if accessed when ``key_agreement``
540 is false.
541
542
Paul Kehrer8cf26422015-03-21 09:50:24 -0500543.. class:: BasicConstraints
544
545 .. versionadded:: 0.9
546
Paul Kehrer85894662015-03-22 13:19:31 -0500547 Basic constraints is an X.509 extension type that defines whether a given
Paul Kehrer8cf26422015-03-21 09:50:24 -0500548 certificate is allowed to sign additional certificates and what path
Paul Kehrer85894662015-03-22 13:19:31 -0500549 length restrictions may exist. It corresponds to
550 :data:`OID_BASIC_CONSTRAINTS`.
Paul Kehrer8cf26422015-03-21 09:50:24 -0500551
552 .. attribute:: ca
553
554 :type: bool
555
556 Whether the certificate can sign certificates.
557
558 .. attribute:: path_length
559
Paul Kehrerfd1444c2015-03-21 19:47:05 -0500560 :type: int or None
Paul Kehrer8cf26422015-03-21 09:50:24 -0500561
562 The maximum path length for certificates subordinate to this
563 certificate. This attribute only has meaning if ``ca`` is true.
564 If ``ca`` is true then a path length of None means there's no
565 restriction on the number of subordinate CAs in the certificate chain.
566 If it is zero or greater then that number defines the maximum length.
567 For example, a ``path_length`` of 1 means the certificate can sign a
568 subordinate CA, but the subordinate CA is not allowed to create
Paul Kehrerfd1444c2015-03-21 19:47:05 -0500569 subordinates with ``ca`` set to true.
Paul Kehrer8cf26422015-03-21 09:50:24 -0500570
Paul Kehrerffa2a152015-03-31 08:18:25 -0500571.. class:: ExtendedKeyUsage
572
573 .. versionadded:: 0.9
574
575 This extension indicates one or more purposes for which the certified
576 public key may be used, in addition to or in place of the basic
577 purposes indicated in the key usage extension. The object is
578 iterable to obtain the list of :ref:`extended key usage OIDs <eku_oids>`.
579
Paul Kehrer8cf26422015-03-21 09:50:24 -0500580
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600581Object Identifiers
582~~~~~~~~~~~~~~~~~~
583
Paul Kehrer4bb46492015-02-07 16:59:14 -0600584X.509 elements are frequently identified by :class:`ObjectIdentifier`
585instances. The following common OIDs are available as constants.
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600586
Paul Kehrer56da2a52015-02-11 23:35:07 -0600587Name OIDs
588~~~~~~~~~
589
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600590.. data:: OID_COMMON_NAME
591
Paul Kehrerfb5ac9e2015-02-07 16:29:37 -0600592 Corresponds to the dotted string ``"2.5.4.3"``. Historically the domain
593 name would be encoded here for server certificates. :rfc:`2818` deprecates
594 this practice and names of that type should now be located in a
Paul Kehrer4bb46492015-02-07 16:59:14 -0600595 SubjectAlternativeName extension. This OID is typically seen in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -0600596
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600597.. data:: OID_COUNTRY_NAME
598
Paul Kehrer4bb46492015-02-07 16:59:14 -0600599 Corresponds to the dotted string ``"2.5.4.6"``. This OID is typically seen
600 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -0600601
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600602.. data:: OID_LOCALITY_NAME
603
Paul Kehrer4bb46492015-02-07 16:59:14 -0600604 Corresponds to the dotted string ``"2.5.4.7"``. This OID is typically seen
605 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -0600606
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600607.. data:: OID_STATE_OR_PROVINCE_NAME
608
Paul Kehrer4bb46492015-02-07 16:59:14 -0600609 Corresponds to the dotted string ``"2.5.4.8"``. This OID is typically seen
610 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -0600611
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600612.. data:: OID_ORGANIZATION_NAME
613
Paul Kehrer4bb46492015-02-07 16:59:14 -0600614 Corresponds to the dotted string ``"2.5.4.10"``. This OID is typically seen
615 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -0600616
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600617.. data:: OID_ORGANIZATIONAL_UNIT_NAME
618
Paul Kehrer4bb46492015-02-07 16:59:14 -0600619 Corresponds to the dotted string ``"2.5.4.11"``. This OID is typically seen
620 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -0600621
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600622.. data:: OID_SERIAL_NUMBER
623
Paul Kehrerfb5ac9e2015-02-07 16:29:37 -0600624 Corresponds to the dotted string ``"2.5.4.5"``. This is distinct from the
625 serial number of the certificate itself (which can be obtained with
Paul Kehrer4bb46492015-02-07 16:59:14 -0600626 :func:`Certificate.serial`). This OID is typically seen in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -0600627
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600628.. data:: OID_SURNAME
629
Paul Kehrer4bb46492015-02-07 16:59:14 -0600630 Corresponds to the dotted string ``"2.5.4.4"``. This OID is typically seen
631 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -0600632
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600633.. data:: OID_GIVEN_NAME
634
Paul Kehrer4bb46492015-02-07 16:59:14 -0600635 Corresponds to the dotted string ``"2.5.4.42"``. This OID is typically seen
636 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -0600637
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600638.. data:: OID_TITLE
639
Paul Kehrer4bb46492015-02-07 16:59:14 -0600640 Corresponds to the dotted string ``"2.5.4.12"``. This OID is typically seen
641 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -0600642
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600643.. data:: OID_GENERATION_QUALIFIER
644
Paul Kehrer4bb46492015-02-07 16:59:14 -0600645 Corresponds to the dotted string ``"2.5.4.44"``. This OID is typically seen
646 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -0600647
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600648.. data:: OID_DN_QUALIFIER
649
Paul Kehrerfb5ac9e2015-02-07 16:29:37 -0600650 Corresponds to the dotted string ``"2.5.4.46"``. This specifies
651 disambiguating information to add to the relative distinguished name of an
Paul Kehrer4bb46492015-02-07 16:59:14 -0600652 entry. See :rfc:`2256`. This OID is typically seen in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -0600653
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600654.. data:: OID_PSEUDONYM
655
Paul Kehrer4bb46492015-02-07 16:59:14 -0600656 Corresponds to the dotted string ``"2.5.4.65"``. This OID is typically seen
657 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -0600658
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600659.. data:: OID_DOMAIN_COMPONENT
660
Paul Kehrerfb5ac9e2015-02-07 16:29:37 -0600661 Corresponds to the dotted string ``"0.9.2342.19200300.100.1.25"``. A string
Paul Kehrer4bb46492015-02-07 16:59:14 -0600662 holding one component of a domain name. See :rfc:`4519`. This OID is
663 typically seen in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -0600664
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600665.. data:: OID_EMAIL_ADDRESS
666
Paul Kehrer4bb46492015-02-07 16:59:14 -0600667 Corresponds to the dotted string ``"1.2.840.113549.1.9.1"``. This OID is
668 typically seen in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -0600669
Paul Kehrer56da2a52015-02-11 23:35:07 -0600670Signature Algorithm OIDs
671~~~~~~~~~~~~~~~~~~~~~~~~
672
Paul Kehrer1a7ba872015-02-19 18:09:05 -0600673.. data:: OID_RSA_WITH_MD5
Paul Kehrer56da2a52015-02-11 23:35:07 -0600674
675 Corresponds to the dotted string ``"1.2.840.113549.1.1.4"``. This is
676 an MD5 digest signed by an RSA key.
677
Paul Kehrer1a7ba872015-02-19 18:09:05 -0600678.. data:: OID_RSA_WITH_SHA1
Paul Kehrer56da2a52015-02-11 23:35:07 -0600679
680 Corresponds to the dotted string ``"1.2.840.113549.1.1.5"``. This is
681 a SHA1 digest signed by an RSA key.
682
Paul Kehrer1a7ba872015-02-19 18:09:05 -0600683.. data:: OID_RSA_WITH_SHA224
Paul Kehrer56da2a52015-02-11 23:35:07 -0600684
685 Corresponds to the dotted string ``"1.2.840.113549.1.1.14"``. This is
686 a SHA224 digest signed by an RSA key.
687
Paul Kehrer1a7ba872015-02-19 18:09:05 -0600688.. data:: OID_RSA_WITH_SHA256
Paul Kehrer56da2a52015-02-11 23:35:07 -0600689
690 Corresponds to the dotted string ``"1.2.840.113549.1.1.11"``. This is
691 a SHA256 digest signed by an RSA key.
692
Paul Kehrer1a7ba872015-02-19 18:09:05 -0600693.. data:: OID_RSA_WITH_SHA384
Paul Kehrer56da2a52015-02-11 23:35:07 -0600694
695 Corresponds to the dotted string ``"1.2.840.113549.1.1.12"``. This is
696 a SHA384 digest signed by an RSA key.
697
Paul Kehrer1a7ba872015-02-19 18:09:05 -0600698.. data:: OID_RSA_WITH_SHA512
Paul Kehrer56da2a52015-02-11 23:35:07 -0600699
700 Corresponds to the dotted string ``"1.2.840.113549.1.1.13"``. This is
701 a SHA512 digest signed by an RSA key.
702
703.. data:: OID_ECDSA_WITH_SHA224
704
705 Corresponds to the dotted string ``"1.2.840.10045.4.3.1"``. This is
706 a SHA224 digest signed by an ECDSA key.
707
708.. data:: OID_ECDSA_WITH_SHA256
709
710 Corresponds to the dotted string ``"1.2.840.10045.4.3.2"``. This is
711 a SHA256 digest signed by an ECDSA key.
712
713.. data:: OID_ECDSA_WITH_SHA384
714
715 Corresponds to the dotted string ``"1.2.840.10045.4.3.3"``. This is
716 a SHA384 digest signed by an ECDSA key.
717
718.. data:: OID_ECDSA_WITH_SHA512
719
720 Corresponds to the dotted string ``"1.2.840.10045.4.3.4"``. This is
721 a SHA512 digest signed by an ECDSA key.
722
723.. data:: OID_DSA_WITH_SHA1
724
725 Corresponds to the dotted string ``"1.2.840.10040.4.3"``. This is
726 a SHA1 digest signed by a DSA key.
727
728.. data:: OID_DSA_WITH_SHA224
729
730 Corresponds to the dotted string ``"2.16.840.1.101.3.4.3.1"``. This is
731 a SHA224 digest signed by a DSA key.
732
733.. data:: OID_DSA_WITH_SHA256
734
Paul Kehrerfbb7ac82015-03-16 19:26:29 -0500735 Corresponds to the dotted string ``"2.16.840.1.101.3.4.3.2"``. This is
Paul Kehrer56da2a52015-02-11 23:35:07 -0600736 a SHA256 digest signed by a DSA key.
737
Paul Kehrerffa2a152015-03-31 08:18:25 -0500738.. _eku_oids:
739
Paul Kehrere1513fa2015-03-30 23:08:17 -0500740Extended Key Usage OIDs
741~~~~~~~~~~~~~~~~~~~~~~~
742
743.. data:: OID_SERVER_AUTH
744
745 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.1"``. This is used to
746 denote that a certificate may be used for TLS web server authentication.
747
748.. data:: OID_CLIENT_AUTH
749
750 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.2"``. This is used to
751 denote that a certificate may be used for TLS web client authentication.
752
753.. data:: OID_CODE_SIGNING
754
755 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.3"``. This is used to
756 denote that a certificate may be used for code signing.
757
758.. data:: OID_EMAIL_PROTECTION
759
760 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.4"``. This is used to
761 denote that a certificate may be used for email protection.
762
763.. data:: OID_TIME_STAMPING
764
765 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.8"``. This is used to
766 denote that a certificate may be used for time stamping.
767
768.. data:: OID_OCSP_SIGNING
769
770 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.9"``. This is used to
771 denote that a certificate may be used for signing OCSP responses.
772
Paul Kehrer5553d572015-03-23 21:08:01 -0500773.. _extension_oids:
774
Paul Kehrer2bb94642015-03-21 09:54:17 -0500775Extension OIDs
776~~~~~~~~~~~~~~
777
778.. data:: OID_BASIC_CONSTRAINTS
779
780 Corresponds to the dotted string ``"2.5.29.19"``. The identifier for the
Paul Kehrer611d3d32015-03-22 13:31:18 -0500781 :class:`BasicConstraints` extension type.
Paul Kehrer2bb94642015-03-21 09:54:17 -0500782
Paul Kehrercecbbba2015-03-30 14:58:38 -0500783.. data:: OID_KEY_USAGE
784
785 Corresponds to the dotted string ``"2.5.29.15"``. The identifier for the
786 :class:`KeyUsage` extension type.
787
Paul Kehrer56da2a52015-02-11 23:35:07 -0600788
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600789Exceptions
790~~~~~~~~~~
791
Paul Kehrere76cd272014-12-14 19:00:51 -0600792.. class:: InvalidVersion
Paul Kehrera68fd332014-11-27 07:08:40 -1000793
794 This is raised when an X.509 certificate has an invalid version number.
Paul Kehrer016e08a2014-11-26 09:41:18 -1000795
Paul Kehrerd5cccf72014-12-15 17:20:33 -0600796 .. attribute:: parsed_version
797
Paul Kehrerbbffc402014-12-17 13:33:55 -0600798 :type: int
799
800 Returns the raw version that was parsed from the certificate.
Paul Kehrerd5cccf72014-12-15 17:20:33 -0600801
Paul Kehrerfbb7ac82015-03-16 19:26:29 -0500802.. class:: DuplicateExtension
803
804 This is raised when more than one X.509 extension of the same type is
805 found within a certificate.
806
807 .. attribute:: oid
808
809 :type: :class:`ObjectIdentifier`
810
811 Returns the OID.
812
813.. class:: UnsupportedExtension
814
815 This is raised when a certificate contains an unsupported extension type.
816
817 .. attribute:: oid
818
819 :type: :class:`ObjectIdentifier`
820
821 Returns the OID.
822
Paul Kehrerfa56a232015-03-17 13:14:03 -0500823.. class:: ExtensionNotFound
824
825 This is raised when calling :meth:`Extensions.get_extension_for_oid` with
826 an extension OID that is not present in the certificate.
827
828 .. attribute:: oid
829
830 :type: :class:`ObjectIdentifier`
831
832 Returns the OID.
833
Paul Kehrer016e08a2014-11-26 09:41:18 -1000834
835.. _`public key infrastructure`: https://en.wikipedia.org/wiki/Public_key_infrastructure
Paul Kehrera68fd332014-11-27 07:08:40 -1000836.. _`TLS`: https://en.wikipedia.org/wiki/Transport_Layer_Security