blob: f79f630cda10a86edc50235393ac1c19eda35f33 [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
Andre Caron6d7e39b2015-05-31 18:10:04 -0400482 :param version: The :class:`Version` of the X.509 protocol.
483 :returns: A new `CertificateSigningRequestBuilder`.
Andre Caron0ef595f2015-05-18 13:53:43 -0400484
485 .. method:: set_subject_name(name)
486
487 :param name: The :class:`Name` of the certificate subject.
Andre Caron6d7e39b2015-05-31 18:10:04 -0400488 :returns: A new `CertificateSigningRequestBuilder`.
Andre Caron0ef595f2015-05-18 13:53:43 -0400489
490 .. method:: add_extension(extension)
491
492 :param extension: The :class:`Extension` to add to the request.
Andre Caron6d7e39b2015-05-31 18:10:04 -0400493 :returns: A new `CertificateSigningRequestBuilder`.
Andre Caron0ef595f2015-05-18 13:53:43 -0400494
495 .. method:: sign(backend, private_key, algorithm)
496
497 :param backend: Backend that will be used to sign the request.
498 Must support the
499 :class:`~cryptography.hazmat.backends.interfaces.X509Backend`
500 interface.
501
502 :param private_key: The
503 :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPrivateKey`
504 that will be used to sign the request. When the request is
505 signed by a certificate authority, the private key's associated
506 public key will be stored in the resulting certificate.
507
508 :param algorithm: The
509 :class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
510 that will be used to generate the request signature.
511
512 :type: :class:`CertificateSigningRequest`
513
514
Paul Kehrer719d5362015-01-01 20:03:52 -0600515.. class:: Name
516
517 .. versionadded:: 0.8
518
Paul Kehrer53d8d492015-02-13 18:47:30 -0600519 An X509 Name is an ordered list of attributes. The object is iterable to
Paul Kehrerd21596e2015-02-14 09:17:26 -0600520 get every attribute or you can use :meth:`Name.get_attributes_for_oid` to
Paul Kehrer719d5362015-01-01 20:03:52 -0600521 obtain the specific type you want. Names are sometimes represented as a
Paul Kehrer53d8d492015-02-13 18:47:30 -0600522 slash or comma delimited string (e.g. ``/CN=mydomain.com/O=My Org/C=US`` or
523 ``CN=mydomain.com, O=My Org, C=US``).
Paul Kehrer719d5362015-01-01 20:03:52 -0600524
Paul Kehrer53d8d492015-02-13 18:47:30 -0600525 .. doctest::
Paul Kehrer719d5362015-01-01 20:03:52 -0600526
Paul Kehrer8b21a4a2015-02-14 07:56:36 -0600527 >>> len(cert.subject)
Paul Kehrer53d8d492015-02-13 18:47:30 -0600528 3
Paul Kehrer8b21a4a2015-02-14 07:56:36 -0600529 >>> for attribute in cert.subject:
530 ... print(attribute)
531 <NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.6, name=countryName)>, value=u'US')>
532 <NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.10, name=organizationName)>, value=u'Test Certificates 2011')>
533 <NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.3, name=commonName)>, value=u'Good CA')>
Paul Kehrer719d5362015-01-01 20:03:52 -0600534
Paul Kehrere901d642015-02-11 18:50:58 -0600535 .. method:: get_attributes_for_oid(oid)
Paul Kehrer719d5362015-01-01 20:03:52 -0600536
Paul Kehrere901d642015-02-11 18:50:58 -0600537 :param oid: An :class:`ObjectIdentifier` instance.
Paul Kehrer719d5362015-01-01 20:03:52 -0600538
Paul Kehrere901d642015-02-11 18:50:58 -0600539 :returns: A list of :class:`NameAttribute` instances that match the
540 OID provided. If nothing matches an empty list will be returned.
Paul Kehrer719d5362015-01-01 20:03:52 -0600541
542 .. doctest::
543
Paul Kehrere901d642015-02-11 18:50:58 -0600544 >>> cert.subject.get_attributes_for_oid(x509.OID_COMMON_NAME)
545 [<NameAttribute(oid=<ObjectIdentifier(oid=2.5.4.3, name=commonName)>, value=u'Good CA')>]
Paul Kehrerb2de9482014-12-11 14:54:48 -0600546
Paul Kehrere76cd272014-12-14 19:00:51 -0600547.. class:: Version
Paul Kehrer016e08a2014-11-26 09:41:18 -1000548
549 .. versionadded:: 0.7
550
551 An enumeration for X.509 versions.
552
553 .. attribute:: v1
554
555 For version 1 X.509 certificates.
556
557 .. attribute:: v3
558
559 For version 3 X.509 certificates.
560
Paul Kehrer806bfb22015-02-02 17:05:24 -0600561.. class:: NameAttribute
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600562
563 .. versionadded:: 0.8
564
Paul Kehrer834d22f2015-02-06 11:01:07 -0600565 An X.509 name consists of a list of NameAttribute instances.
Paul Kehrer5b0a8d62015-01-30 20:05:55 -0600566
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600567 .. attribute:: oid
568
569 :type: :class:`ObjectIdentifier`
570
571 The attribute OID.
572
573 .. attribute:: value
574
Paul Kehrerd5852cb2015-01-30 08:25:23 -0600575 :type: :term:`text`
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600576
577 The value of the attribute.
578
579.. class:: ObjectIdentifier
580
581 .. versionadded:: 0.8
582
Paul Kehrer5b0a8d62015-01-30 20:05:55 -0600583 Object identifiers (frequently seen abbreviated as OID) identify the type
Paul Kehrer806bfb22015-02-02 17:05:24 -0600584 of a value (see: :class:`NameAttribute`).
Paul Kehrer5b0a8d62015-01-30 20:05:55 -0600585
Paul Kehrerd44f9a62015-02-04 14:47:34 -0600586 .. attribute:: dotted_string
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600587
588 :type: :class:`str`
589
Paul Kehrerfedf4f42015-02-06 11:22:07 -0600590 The dotted string value of the OID (e.g. ``"2.5.4.3"``)
Paul Kehrer912d3fb2015-01-29 11:19:22 -0600591
Paul Kehrer31bdf792015-03-25 14:11:00 -0500592.. _general_name_classes:
593
594General Name Classes
595~~~~~~~~~~~~~~~~~~~~
596
597.. class:: GeneralName
598
599 .. versionadded:: 0.9
600
601 This is the generic interface that all the following classes are registered
602 against.
603
604.. class:: RFC822Name
605
606 .. versionadded:: 0.9
607
608 This corresponds to an email address. For example, ``user@example.com``.
609
610 .. attribute:: value
611
612 :type: :term:`text`
613
614.. class:: DNSName
615
616 .. versionadded:: 0.9
617
618 This corresponds to a domain name. For example, ``cryptography.io``.
619
620 .. attribute:: value
621
622 :type: :term:`text`
623
624.. class:: DirectoryName
625
626 .. versionadded:: 0.9
627
628 This corresponds to a directory name.
629
630 .. attribute:: value
631
632 :type: :class:`Name`
633
634.. class:: UniformResourceIdentifier
635
636 .. versionadded:: 0.9
637
638 This corresponds to a uniform resource identifier. For example,
Paul Kehrerb8ef82e2015-04-22 16:04:24 -0500639 ``https://cryptography.io``. The URI is parsed and IDNA decoded (see
640 :rfc:`5895`).
641
642 .. note::
643
644 URIs that do not contain ``://`` in them will not be decoded.
Paul Kehrer31bdf792015-03-25 14:11:00 -0500645
646 .. attribute:: value
647
648 :type: :term:`text`
649
650.. class:: IPAddress
651
652 .. versionadded:: 0.9
653
654 This corresponds to an IP address.
655
656 .. attribute:: value
657
Paul Kehrereb177932015-05-17 18:33:33 -0700658 :type: :class:`~ipaddress.IPv4Address`,
659 :class:`~ipaddress.IPv6Address`, :class:`~ipaddress.IPv4Network`,
660 or :class:`~ipaddress.IPv6Network`.
Paul Kehrer31bdf792015-03-25 14:11:00 -0500661
662.. class:: RegisteredID
663
664 .. versionadded:: 0.9
665
666 This corresponds to a registered ID.
667
668 .. attribute:: value
669
670 :type: :class:`ObjectIdentifier`
671
Paul Kehrer8cf26422015-03-21 09:50:24 -0500672X.509 Extensions
673~~~~~~~~~~~~~~~~
674
Paul Kehrerfbb7ac82015-03-16 19:26:29 -0500675.. class:: Extensions
676
677 .. versionadded:: 0.9
678
679 An X.509 Extensions instance is an ordered list of extensions. The object
680 is iterable to get every extension.
681
Paul Kehrerfa56a232015-03-17 13:14:03 -0500682 .. method:: get_extension_for_oid(oid)
683
684 :param oid: An :class:`ObjectIdentifier` instance.
685
686 :returns: An instance of the extension class.
687
688 :raises cryptography.x509.ExtensionNotFound: If the certificate does
689 not have the extension requested.
690
Paul Kehrerfa56a232015-03-17 13:14:03 -0500691 .. doctest::
692
693 >>> cert.extensions.get_extension_for_oid(x509.OID_BASIC_CONSTRAINTS)
694 <Extension(oid=<ObjectIdentifier(oid=2.5.29.19, name=basicConstraints)>, critical=True, value=<BasicConstraints(ca=True, path_length=None)>)>
695
Paul Kehrer8cf26422015-03-21 09:50:24 -0500696.. class:: Extension
697
698 .. versionadded:: 0.9
699
Paul Kehrer85894662015-03-22 13:19:31 -0500700 .. attribute:: oid
701
702 :type: :class:`ObjectIdentifier`
703
Paul Kehrer5553d572015-03-23 21:08:01 -0500704 The :ref:`extension OID <extension_oids>`.
Paul Kehrer8cf26422015-03-21 09:50:24 -0500705
706 .. attribute:: critical
707
708 :type: bool
709
Paul Kehrer58b75692015-03-22 23:24:58 -0500710 Determines whether a given extension is critical or not. :rfc:`5280`
711 requires that "A certificate-using system MUST reject the certificate
712 if it encounters a critical extension it does not recognize or a
713 critical extension that contains information that it cannot process".
Paul Kehrer8cf26422015-03-21 09:50:24 -0500714
Paul Kehrer85894662015-03-22 13:19:31 -0500715 .. attribute:: value
716
717 Returns an instance of the extension type corresponding to the OID.
718
Paul Kehrercecbbba2015-03-30 14:58:38 -0500719.. class:: KeyUsage
720
721 .. versionadded:: 0.9
722
723 The key usage extension defines the purpose of the key contained in the
724 certificate. The usage restriction might be employed when a key that could
725 be used for more than one operation is to be restricted. It corresponds to
726 :data:`OID_KEY_USAGE`.
727
728 .. attribute:: digital_signature
729
730 :type: bool
731
Paul Kehrer738407b2015-04-01 22:39:02 -0500732 This purpose is set to true when the subject public key is used for verifying
Paul Kehrercecbbba2015-03-30 14:58:38 -0500733 digital signatures, other than signatures on certificates
734 (``key_cert_sign``) and CRLs (``crl_sign``).
735
736 .. attribute:: content_commitment
737
738 :type: bool
739
Paul Kehrer738407b2015-04-01 22:39:02 -0500740 This purpose is set to true when the subject public key is used for verifying
Paul Kehrercecbbba2015-03-30 14:58:38 -0500741 digital signatures, other than signatures on certificates
742 (``key_cert_sign``) and CRLs (``crl_sign``). It is used to provide a
743 non-repudiation service that protects against the signing entity
744 falsely denying some action. In the case of later conflict, a
745 reliable third party may determine the authenticity of the signed
746 data. This was called ``non_repudiation`` in older revisions of the
747 X.509 specification.
748
749 .. attribute:: key_encipherment
750
751 :type: bool
752
Paul Kehrer738407b2015-04-01 22:39:02 -0500753 This purpose is set to true when the subject public key is used for
754 enciphering private or secret keys.
Paul Kehrercecbbba2015-03-30 14:58:38 -0500755
756 .. attribute:: data_encipherment
757
758 :type: bool
759
Paul Kehrer738407b2015-04-01 22:39:02 -0500760 This purpose is set to true when the subject public key is used for
761 directly enciphering raw user data without the use of an intermediate
762 symmetric cipher.
Paul Kehrercecbbba2015-03-30 14:58:38 -0500763
764 .. attribute:: key_agreement
765
766 :type: bool
767
Paul Kehrer738407b2015-04-01 22:39:02 -0500768 This purpose is set to true when the subject public key is used for key
769 agreement. For example, when a Diffie-Hellman key is to be used for
770 key management, then this purpose is set to true.
Paul Kehrercecbbba2015-03-30 14:58:38 -0500771
772 .. attribute:: key_cert_sign
773
774 :type: bool
775
Paul Kehrer738407b2015-04-01 22:39:02 -0500776 This purpose is set to true when the subject public key is used for
777 verifying signatures on public key certificates. If this purpose is set
778 to true then ``ca`` must be true in the :class:`BasicConstraints`
779 extension.
Paul Kehrercecbbba2015-03-30 14:58:38 -0500780
781 .. attribute:: crl_sign
782
783 :type: bool
784
Paul Kehrer738407b2015-04-01 22:39:02 -0500785 This purpose is set to true when the subject public key is used for
786 verifying signatures on certificate revocation lists.
Paul Kehrercecbbba2015-03-30 14:58:38 -0500787
788 .. attribute:: encipher_only
789
790 :type: bool
791
Paul Kehrer738407b2015-04-01 22:39:02 -0500792 When this purposes is set to true and the ``key_agreement`` purpose is
793 also set, the subject public key may be used only for enciphering data
794 while performing key agreement.
Paul Kehrercecbbba2015-03-30 14:58:38 -0500795
796 :raises ValueError: This is raised if accessed when ``key_agreement``
797 is false.
798
799 .. attribute:: decipher_only
800
801 :type: bool
802
Paul Kehrer738407b2015-04-01 22:39:02 -0500803 When this purposes is set to true and the ``key_agreement`` purpose is
804 also set, the subject public key may be used only for deciphering data
805 while performing key agreement.
Paul Kehrercecbbba2015-03-30 14:58:38 -0500806
807 :raises ValueError: This is raised if accessed when ``key_agreement``
808 is false.
809
810
Paul Kehrer8cf26422015-03-21 09:50:24 -0500811.. class:: BasicConstraints
812
813 .. versionadded:: 0.9
814
Paul Kehrer85894662015-03-22 13:19:31 -0500815 Basic constraints is an X.509 extension type that defines whether a given
Paul Kehrer8cf26422015-03-21 09:50:24 -0500816 certificate is allowed to sign additional certificates and what path
Paul Kehrer85894662015-03-22 13:19:31 -0500817 length restrictions may exist. It corresponds to
818 :data:`OID_BASIC_CONSTRAINTS`.
Paul Kehrer8cf26422015-03-21 09:50:24 -0500819
820 .. attribute:: ca
821
822 :type: bool
823
824 Whether the certificate can sign certificates.
825
826 .. attribute:: path_length
827
Paul Kehrerfd1444c2015-03-21 19:47:05 -0500828 :type: int or None
Paul Kehrer8cf26422015-03-21 09:50:24 -0500829
830 The maximum path length for certificates subordinate to this
831 certificate. This attribute only has meaning if ``ca`` is true.
832 If ``ca`` is true then a path length of None means there's no
833 restriction on the number of subordinate CAs in the certificate chain.
Alex Gaynor99c5f152015-05-03 10:01:04 -0400834 If it is zero or greater then it defines the maximum length for a
835 subordinate CA's certificate chain. For example, a ``path_length`` of 1
836 means the certificate can sign a subordinate CA, but the subordinate CA
837 is not allowed to create subordinates with ``ca`` set to true.
Paul Kehrer8cf26422015-03-21 09:50:24 -0500838
Paul Kehrerffa2a152015-03-31 08:18:25 -0500839.. class:: ExtendedKeyUsage
840
841 .. versionadded:: 0.9
842
843 This extension indicates one or more purposes for which the certified
844 public key may be used, in addition to or in place of the basic
845 purposes indicated in the key usage extension. The object is
846 iterable to obtain the list of :ref:`extended key usage OIDs <eku_oids>`.
847
Paul Kehrer4a1038e2015-05-18 10:28:31 -0700848.. class:: OCSPNoCheck
849
Paul Kehrer506a2152015-05-26 08:01:18 -0500850 .. versionadded:: 1.0
Paul Kehrer4a1038e2015-05-18 10:28:31 -0700851
852 This presence of this extension indicates that an OCSP client can trust a
853 responder for the lifetime of the responder's certificate. CAs issuing
854 such a certificate should realize that a compromise of the responder's key
855 is as serious as the compromise of a CA key used to sign CRLs, at least for
856 the validity period of this certificate. CA's may choose to issue this type
857 of certificate with a very short lifetime and renew it frequently. This
858 extension is only relevant when the certificate is an authorized OCSP
859 responder.
860
Paul Kehrere0017be2015-05-17 20:39:40 -0600861.. class:: NameConstraints
862
863 .. versionadded:: 1.0
864
865 The name constraints extension, which only has meaning in a CA certificate,
866 defines a name space within which all subject names in certificates issued
867 beneath the CA certificate must (or must not) be in. For specific details
868 on the way this extension should be processed see :rfc:`5280`.
869
870 .. attribute:: permitted_subtrees
871
872 :type: list of :class:`GeneralName` objects or None
873
874 The set of permitted name patterns. If a name matches this and an
875 element in ``excluded_subtrees`` it is invalid. At least one of
876 ``permitted_subtrees`` and ``excluded_subtrees`` will be non-None.
877
878 .. attribute:: excluded_subtrees
879
880 :type: list of :class:`GeneralName` objects or None
881
882 Any name matching a restriction in the ``excluded_subtrees`` field is
883 invalid regardless of information appearing in the
884 ``permitted_subtrees``. At least one of ``permitted_subtrees`` and
885 ``excluded_subtrees`` will be non-None.
886
Paul Kehrer2eb4ed92015-04-11 15:33:45 -0400887.. class:: AuthorityKeyIdentifier
888
889 .. versionadded:: 0.9
890
891 The authority key identifier extension provides a means of identifying the
892 public key corresponding to the private key used to sign a certificate.
Paul Kehrer8c8cd722015-04-19 09:15:04 -0500893 This extension is typically used to assist in determining the appropriate
894 certificate chain. For more information about generation and use of this
895 extension see `RFC 5280 section 4.2.1.1`_.
Paul Kehrer2eb4ed92015-04-11 15:33:45 -0400896
897 .. attribute:: key_identifier
898
899 :type: bytes
900
Paul Kehrer9104b1d2015-04-18 09:23:44 -0500901 A value derived from the public key used to verify the certificate's
Paul Kehrer8c8cd722015-04-19 09:15:04 -0500902 signature.
Paul Kehrer9104b1d2015-04-18 09:23:44 -0500903
Paul Kehrer2eb4ed92015-04-11 15:33:45 -0400904 .. attribute:: authority_cert_issuer
905
906 :type: :class:`Name` or None
907
Paul Kehrer9104b1d2015-04-18 09:23:44 -0500908 The :class:`Name` of the issuer's issuer.
909
Paul Kehrer2eb4ed92015-04-11 15:33:45 -0400910 .. attribute:: authority_cert_serial_number
911
912 :type: int or None
913
Paul Kehrer9104b1d2015-04-18 09:23:44 -0500914 The serial number of the issuer's issuer.
915
Paul Kehrer1eb82a62015-03-31 20:00:33 -0500916.. class:: SubjectKeyIdentifier
917
918 .. versionadded:: 0.9
919
920 The subject key identifier extension provides a means of identifying
921 certificates that contain a particular public key.
922
923 .. attribute:: digest
924
925 :type: bytes
926
927 The binary value of the identifier.
928
Paul Kehrer31bdf792015-03-25 14:11:00 -0500929.. class:: SubjectAlternativeName
930
931 .. versionadded:: 0.9
932
933 Subject alternative name is an X.509 extension that provides a list of
934 :ref:`general name <general_name_classes>` instances that provide a set
935 of identities for which the certificate is valid. The object is iterable to
936 get every element.
937
938 .. method:: get_values_for_type(type)
939
940 :param type: A :class:`GeneralName` provider. This is one of the
941 :ref:`general name classes <general_name_classes>`.
942
943 :returns: A list of values extracted from the matched general names.
944
Paul Kehrer93ae8052015-05-02 23:18:09 -0500945 .. doctest::
946
947 >>> from cryptography import x509
948 >>> from cryptography.hazmat.backends import default_backend
949 >>> from cryptography.hazmat.primitives import hashes
950 >>> cert = x509.load_pem_x509_certificate(cryptography_cert_pem, default_backend())
Paul Kehrerd0cd5072015-05-02 23:27:00 -0500951 >>> # Get the subjectAltName extension from the certificate
Paul Kehrer93ae8052015-05-02 23:18:09 -0500952 >>> ext = cert.extensions.get_extension_for_oid(x509.OID_SUBJECT_ALTERNATIVE_NAME)
Paul Kehrerd0cd5072015-05-02 23:27:00 -0500953 >>> # Get the dNSName entries from the SAN extension
954 >>> ext.value.get_values_for_type(x509.DNSName)
Paul Kehrer93ae8052015-05-02 23:18:09 -0500955 [u'www.cryptography.io', u'cryptography.io']
956
Paul Kehrer8cf26422015-03-21 09:50:24 -0500957
Paul Kehrer99125c92015-06-07 18:37:10 -0500958.. class:: IssuerAlternativeName
959
960 .. versionadded:: 1.0
961
962 Issuer alternative name is an X.509 extension that provides a list of
963 :ref:`general name <general_name_classes>` instances that provide a set
964 of identities for the certificate issuer. The object is iterable to
965 get every element.
966
967 .. method:: get_values_for_type(type)
968
969 :param type: A :class:`GeneralName` provider. This is one of the
970 :ref:`general name classes <general_name_classes>`.
971
972 :returns: A list of values extracted from the matched general names.
973
974
Paul Kehrer3e6d5582015-05-02 21:57:56 -0500975.. class:: AuthorityInformationAccess
976
977 .. versionadded:: 0.9
978
979 The authority information access extension indicates how to access
980 information and services for the issuer of the certificate in which
981 the extension appears. Information and services may include online
982 validation services (such as OCSP) and issuer data. It is an iterable,
983 containing one or more :class:`AccessDescription` instances.
984
985
986.. class:: AccessDescription
987
Paul Kehrer5a485522015-05-06 00:29:12 -0500988 .. versionadded:: 0.9
989
Paul Kehrer3e6d5582015-05-02 21:57:56 -0500990 .. attribute:: access_method
991
992 :type: :class:`ObjectIdentifier`
993
Paul Kehrerf506bca2015-05-02 22:31:47 -0500994 The access method defines what the ``access_location`` means. It must
995 be either :data:`OID_OCSP` or :data:`OID_CA_ISSUERS`. If it is
996 :data:`OID_OCSP` the access location will be where to obtain OCSP
997 information for the certificate. If it is :data:`OID_CA_ISSUERS` the
998 access location will provide additional information about the issuing
999 certificate.
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001000
1001 .. attribute:: access_location
1002
1003 :type: :class:`GeneralName`
1004
Paul Kehrerf506bca2015-05-02 22:31:47 -05001005 Where to access the information defined by the access method.
1006
Paul Kehrer5a485522015-05-06 00:29:12 -05001007.. class:: CRLDistributionPoints
1008
1009 .. versionadded:: 0.9
1010
1011 The CRL distribution points extension identifies how CRL information is
1012 obtained. It is an iterable, containing one or more
1013 :class:`DistributionPoint` instances.
1014
1015.. class:: DistributionPoint
1016
1017 .. versionadded:: 0.9
1018
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001019 .. attribute:: full_name
Paul Kehrer5a485522015-05-06 00:29:12 -05001020
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001021 :type: list of :class:`GeneralName` instances or None
Paul Kehrer5a485522015-05-06 00:29:12 -05001022
Paul Kehrerf2c072b2015-05-09 17:04:28 -05001023 This field describes methods to retrieve the CRL. At most one of
1024 ``full_name`` or ``relative_name`` will be non-None.
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001025
1026 .. attribute:: relative_name
1027
1028 :type: :class:`Name` or None
1029
1030 This field describes methods to retrieve the CRL relative to the CRL
Paul Kehrerf2c072b2015-05-09 17:04:28 -05001031 issuer. At most one of ``full_name`` or ``relative_name`` will be
1032 non-None.
Paul Kehrer5a485522015-05-06 00:29:12 -05001033
1034 .. attribute:: crl_issuer
1035
1036 :type: list of :class:`GeneralName` instances or None
1037
1038 Information about the issuer of the CRL.
1039
1040 .. attribute:: reasons
1041
Paul Kehrer3fd02602015-05-09 19:46:13 -05001042 :type: frozenset of :class:`ReasonFlags` or None
Paul Kehrer5a485522015-05-06 00:29:12 -05001043
1044 The reasons a given distribution point may be used for when performing
1045 revocation checks.
1046
1047.. class:: ReasonFlags
1048
1049 .. versionadded:: 0.9
1050
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001051 An enumeration for CRL reasons.
1052
1053 .. attribute:: unspecified
1054
1055 It is unspecified why the certificate was revoked. This reason cannot
1056 be used as a reason flag in a :class:`DistributionPoint`.
Paul Kehrer5a485522015-05-06 00:29:12 -05001057
1058 .. attribute:: key_compromise
1059
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001060 This reason indicates that the private key was compromised.
Paul Kehrer5a485522015-05-06 00:29:12 -05001061
1062 .. attribute:: ca_compromise
1063
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001064 This reason indicates that the CA issuing the certificate was
1065 compromised.
Paul Kehrer5a485522015-05-06 00:29:12 -05001066
1067 .. attribute:: affiliation_changed
1068
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001069 This reason indicates that the subject's name or other information has
1070 changed.
Paul Kehrer5a485522015-05-06 00:29:12 -05001071
1072 .. attribute:: superseded
1073
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001074 This reason indicates that a certificate has been superseded.
Paul Kehrer5a485522015-05-06 00:29:12 -05001075
1076 .. attribute:: cessation_of_operation
1077
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001078 This reason indicates that the certificate is no longer required.
Paul Kehrer5a485522015-05-06 00:29:12 -05001079
1080 .. attribute:: certificate_hold
1081
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001082 This reason indicates that the certificate is on hold.
Paul Kehrer5a485522015-05-06 00:29:12 -05001083
1084 .. attribute:: privilege_withdrawn
1085
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001086 This reason indicates that the privilege granted by this certificate
1087 have been withdrawn.
Paul Kehrer5a485522015-05-06 00:29:12 -05001088
1089 .. attribute:: aa_compromise
1090
Paul Kehrer4e8dacd2015-05-09 10:38:23 -05001091 When an attribute authority has been compromised.
1092
1093 .. attribute:: remove_from_crl
1094
1095 This reason indicates that the certificate was on hold and should be
1096 removed from the CRL. This reason cannot be used as a reason flag
1097 in a :class:`DistributionPoint`.
Paul Kehrer5a485522015-05-06 00:29:12 -05001098
Paul Kehrer16fae762015-05-01 23:14:20 -05001099.. class:: InhibitAnyPolicy
1100
1101 .. versionadded:: 1.0
1102
1103 The inhibit ``anyPolicy`` extension indicates that the special OID
1104 :data:`OID_ANY_POLICY`, is not considered an explicit match for other
1105 :class:`CertificatePolicies` except when it appears in an intermediate
1106 self-issued CA certificate. The value indicates the number of additional
1107 non-self-issued certificates that may appear in the path before
1108 :data:`OID_ANY_POLICY` is no longer permitted. For example, a value
1109 of one indicates that :data:`OID_ANY_POLICY` may be processed in
1110 certificates issued by the subject of this certificate, but not in
1111 additional certificates in the path.
1112
1113 .. attribute:: skip_certs
1114
1115 :type: int
1116
Paul Kehrer0d210922015-04-28 17:31:07 -05001117.. class:: CertificatePolicies
1118
1119 .. versionadded:: 0.9
1120
Paul Kehrer2e879742015-05-02 23:09:56 -05001121 The certificate policies extension is an iterable, containing one or more
1122 :class:`PolicyInformation` instances.
Paul Kehrer0d210922015-04-28 17:31:07 -05001123
1124Certificate Policies Classes
1125~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1126
1127These classes may be present within a :class:`CertificatePolicies` instance.
1128
1129.. class:: PolicyInformation
1130
1131 .. versionadded:: 0.9
1132
1133 Contains a policy identifier and an optional list of qualifiers.
1134
1135 .. attribute:: policy_identifier
1136
1137 :type: :class:`ObjectIdentifier`
1138
1139 .. attribute:: policy_qualifiers
1140
1141 :type: list
1142
Paul Kehrerba35b3b2015-05-10 13:07:59 -05001143 A list consisting of :term:`text` and/or :class:`UserNotice` objects.
Paul Kehrer3f8ddeb2015-05-11 00:25:36 -05001144 If the value is text it is a pointer to the practice statement
1145 published by the certificate authority. If it is a user notice it is
1146 meant for display to the relying party when the certificate is
1147 used.
Paul Kehrer2e879742015-05-02 23:09:56 -05001148
Paul Kehrer0d210922015-04-28 17:31:07 -05001149.. class:: UserNotice
1150
1151 .. versionadded:: 0.9
1152
Paul Kehrer2e879742015-05-02 23:09:56 -05001153 User notices are intended for display to a relying party when a certificate
1154 is used. In practice, few if any UIs expose this data and it is a rarely
1155 encoded component.
1156
Paul Kehrer0d210922015-04-28 17:31:07 -05001157 .. attribute:: notice_reference
1158
1159 :type: :class:`NoticeReference` or None
1160
Paul Kehrer2e879742015-05-02 23:09:56 -05001161 The notice reference field names an organization and identifies,
1162 by number, a particular statement prepared by that organization.
1163
Paul Kehrer0d210922015-04-28 17:31:07 -05001164 .. attribute:: explicit_text
1165
Paul Kehrer2e879742015-05-02 23:09:56 -05001166 This field includes an arbitrary textual statement directly in the
1167 certificate.
1168
Paul Kehrer0d210922015-04-28 17:31:07 -05001169 :type: :term:`text`
1170
1171.. class:: NoticeReference
1172
Paul Kehrer2e879742015-05-02 23:09:56 -05001173 Notice reference can name an organization and provide information about
1174 notices related to the certificate. For example, it might identify the
1175 organization name and notice number 1. Application software could
1176 have a notice file containing the current set of notices for the named
1177 organization; the application would then extract the notice text from the
1178 file and display it. In practice this is rarely seen.
1179
Paul Kehrer0d210922015-04-28 17:31:07 -05001180 .. versionadded:: 0.9
1181
1182 .. attribute:: organization
1183
Paul Kehrer66c61702015-05-12 16:39:18 -05001184 :type: :term:`text`
Paul Kehrer0d210922015-04-28 17:31:07 -05001185
Paul Kehrer3f8ddeb2015-05-11 00:25:36 -05001186 .. attribute:: notice_numbers
Paul Kehrer0d210922015-04-28 17:31:07 -05001187
Paul Kehrer66c61702015-05-12 16:39:18 -05001188 :type: list
Paul Kehrer0d210922015-04-28 17:31:07 -05001189
Paul Kehrer66c61702015-05-12 16:39:18 -05001190 A list of integers.
Paul Kehrer0d210922015-04-28 17:31:07 -05001191
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001192Object Identifiers
1193~~~~~~~~~~~~~~~~~~
1194
Paul Kehrer4bb46492015-02-07 16:59:14 -06001195X.509 elements are frequently identified by :class:`ObjectIdentifier`
1196instances. The following common OIDs are available as constants.
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001197
Paul Kehrer56da2a52015-02-11 23:35:07 -06001198Name OIDs
1199~~~~~~~~~
1200
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001201.. data:: OID_COMMON_NAME
1202
Paul Kehrerfb5ac9e2015-02-07 16:29:37 -06001203 Corresponds to the dotted string ``"2.5.4.3"``. Historically the domain
1204 name would be encoded here for server certificates. :rfc:`2818` deprecates
1205 this practice and names of that type should now be located in a
Paul Kehrer4bb46492015-02-07 16:59:14 -06001206 SubjectAlternativeName extension. This OID is typically seen in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001207
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001208.. data:: OID_COUNTRY_NAME
1209
Paul Kehrer4bb46492015-02-07 16:59:14 -06001210 Corresponds to the dotted string ``"2.5.4.6"``. This OID is typically seen
1211 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001212
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001213.. data:: OID_LOCALITY_NAME
1214
Paul Kehrer4bb46492015-02-07 16:59:14 -06001215 Corresponds to the dotted string ``"2.5.4.7"``. This OID is typically seen
1216 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001217
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001218.. data:: OID_STATE_OR_PROVINCE_NAME
1219
Paul Kehrer4bb46492015-02-07 16:59:14 -06001220 Corresponds to the dotted string ``"2.5.4.8"``. This OID is typically seen
1221 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001222
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001223.. data:: OID_ORGANIZATION_NAME
1224
Paul Kehrer4bb46492015-02-07 16:59:14 -06001225 Corresponds to the dotted string ``"2.5.4.10"``. This OID is typically seen
1226 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001227
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001228.. data:: OID_ORGANIZATIONAL_UNIT_NAME
1229
Paul Kehrer4bb46492015-02-07 16:59:14 -06001230 Corresponds to the dotted string ``"2.5.4.11"``. This OID is typically seen
1231 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001232
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001233.. data:: OID_SERIAL_NUMBER
1234
Paul Kehrerfb5ac9e2015-02-07 16:29:37 -06001235 Corresponds to the dotted string ``"2.5.4.5"``. This is distinct from the
1236 serial number of the certificate itself (which can be obtained with
Paul Kehrer4bb46492015-02-07 16:59:14 -06001237 :func:`Certificate.serial`). This OID is typically seen in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001238
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001239.. data:: OID_SURNAME
1240
Paul Kehrer4bb46492015-02-07 16:59:14 -06001241 Corresponds to the dotted string ``"2.5.4.4"``. This OID is typically seen
1242 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001243
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001244.. data:: OID_GIVEN_NAME
1245
Paul Kehrer4bb46492015-02-07 16:59:14 -06001246 Corresponds to the dotted string ``"2.5.4.42"``. This OID is typically seen
1247 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001248
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001249.. data:: OID_TITLE
1250
Paul Kehrer4bb46492015-02-07 16:59:14 -06001251 Corresponds to the dotted string ``"2.5.4.12"``. This OID is typically seen
1252 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001253
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001254.. data:: OID_GENERATION_QUALIFIER
1255
Paul Kehrer4bb46492015-02-07 16:59:14 -06001256 Corresponds to the dotted string ``"2.5.4.44"``. This OID is typically seen
1257 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001258
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001259.. data:: OID_DN_QUALIFIER
1260
Paul Kehrerfb5ac9e2015-02-07 16:29:37 -06001261 Corresponds to the dotted string ``"2.5.4.46"``. This specifies
1262 disambiguating information to add to the relative distinguished name of an
Paul Kehrer4bb46492015-02-07 16:59:14 -06001263 entry. See :rfc:`2256`. This OID is typically seen in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001264
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001265.. data:: OID_PSEUDONYM
1266
Paul Kehrer4bb46492015-02-07 16:59:14 -06001267 Corresponds to the dotted string ``"2.5.4.65"``. This OID is typically seen
1268 in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001269
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001270.. data:: OID_DOMAIN_COMPONENT
1271
Paul Kehrerfb5ac9e2015-02-07 16:29:37 -06001272 Corresponds to the dotted string ``"0.9.2342.19200300.100.1.25"``. A string
Paul Kehrer4bb46492015-02-07 16:59:14 -06001273 holding one component of a domain name. See :rfc:`4519`. This OID is
1274 typically seen in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001275
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001276.. data:: OID_EMAIL_ADDRESS
1277
Paul Kehrer4bb46492015-02-07 16:59:14 -06001278 Corresponds to the dotted string ``"1.2.840.113549.1.9.1"``. This OID is
1279 typically seen in X.509 names.
Paul Kehrer858b9b72015-02-05 09:50:31 -06001280
Paul Kehrer56da2a52015-02-11 23:35:07 -06001281Signature Algorithm OIDs
1282~~~~~~~~~~~~~~~~~~~~~~~~
1283
Paul Kehrer1a7ba872015-02-19 18:09:05 -06001284.. data:: OID_RSA_WITH_MD5
Paul Kehrer56da2a52015-02-11 23:35:07 -06001285
1286 Corresponds to the dotted string ``"1.2.840.113549.1.1.4"``. This is
1287 an MD5 digest signed by an RSA key.
1288
Paul Kehrer1a7ba872015-02-19 18:09:05 -06001289.. data:: OID_RSA_WITH_SHA1
Paul Kehrer56da2a52015-02-11 23:35:07 -06001290
1291 Corresponds to the dotted string ``"1.2.840.113549.1.1.5"``. This is
1292 a SHA1 digest signed by an RSA key.
1293
Paul Kehrer1a7ba872015-02-19 18:09:05 -06001294.. data:: OID_RSA_WITH_SHA224
Paul Kehrer56da2a52015-02-11 23:35:07 -06001295
1296 Corresponds to the dotted string ``"1.2.840.113549.1.1.14"``. This is
1297 a SHA224 digest signed by an RSA key.
1298
Paul Kehrer1a7ba872015-02-19 18:09:05 -06001299.. data:: OID_RSA_WITH_SHA256
Paul Kehrer56da2a52015-02-11 23:35:07 -06001300
1301 Corresponds to the dotted string ``"1.2.840.113549.1.1.11"``. This is
1302 a SHA256 digest signed by an RSA key.
1303
Paul Kehrer1a7ba872015-02-19 18:09:05 -06001304.. data:: OID_RSA_WITH_SHA384
Paul Kehrer56da2a52015-02-11 23:35:07 -06001305
1306 Corresponds to the dotted string ``"1.2.840.113549.1.1.12"``. This is
1307 a SHA384 digest signed by an RSA key.
1308
Paul Kehrer1a7ba872015-02-19 18:09:05 -06001309.. data:: OID_RSA_WITH_SHA512
Paul Kehrer56da2a52015-02-11 23:35:07 -06001310
1311 Corresponds to the dotted string ``"1.2.840.113549.1.1.13"``. This is
1312 a SHA512 digest signed by an RSA key.
1313
Alex Gaynor3aadabf2015-06-23 22:06:21 -04001314.. data:: OID_ECDSA_WITH_SHA1
1315
1316 Corresponds to the dotted string ``"1.2.840.10045.4.1"``. This is a SHA1
1317 digest signed by an ECDSA key.
1318
Paul Kehrer56da2a52015-02-11 23:35:07 -06001319.. data:: OID_ECDSA_WITH_SHA224
1320
1321 Corresponds to the dotted string ``"1.2.840.10045.4.3.1"``. This is
1322 a SHA224 digest signed by an ECDSA key.
1323
1324.. data:: OID_ECDSA_WITH_SHA256
1325
1326 Corresponds to the dotted string ``"1.2.840.10045.4.3.2"``. This is
1327 a SHA256 digest signed by an ECDSA key.
1328
1329.. data:: OID_ECDSA_WITH_SHA384
1330
1331 Corresponds to the dotted string ``"1.2.840.10045.4.3.3"``. This is
1332 a SHA384 digest signed by an ECDSA key.
1333
1334.. data:: OID_ECDSA_WITH_SHA512
1335
1336 Corresponds to the dotted string ``"1.2.840.10045.4.3.4"``. This is
1337 a SHA512 digest signed by an ECDSA key.
1338
1339.. data:: OID_DSA_WITH_SHA1
1340
1341 Corresponds to the dotted string ``"1.2.840.10040.4.3"``. This is
1342 a SHA1 digest signed by a DSA key.
1343
1344.. data:: OID_DSA_WITH_SHA224
1345
1346 Corresponds to the dotted string ``"2.16.840.1.101.3.4.3.1"``. This is
1347 a SHA224 digest signed by a DSA key.
1348
1349.. data:: OID_DSA_WITH_SHA256
1350
Paul Kehrerfbb7ac82015-03-16 19:26:29 -05001351 Corresponds to the dotted string ``"2.16.840.1.101.3.4.3.2"``. This is
Paul Kehrer56da2a52015-02-11 23:35:07 -06001352 a SHA256 digest signed by a DSA key.
1353
Paul Kehrerffa2a152015-03-31 08:18:25 -05001354.. _eku_oids:
1355
Paul Kehrere1513fa2015-03-30 23:08:17 -05001356Extended Key Usage OIDs
1357~~~~~~~~~~~~~~~~~~~~~~~
1358
1359.. data:: OID_SERVER_AUTH
1360
1361 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.1"``. This is used to
1362 denote that a certificate may be used for TLS web server authentication.
1363
1364.. data:: OID_CLIENT_AUTH
1365
1366 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.2"``. This is used to
1367 denote that a certificate may be used for TLS web client authentication.
1368
1369.. data:: OID_CODE_SIGNING
1370
1371 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.3"``. This is used to
1372 denote that a certificate may be used for code signing.
1373
1374.. data:: OID_EMAIL_PROTECTION
1375
1376 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.4"``. This is used to
1377 denote that a certificate may be used for email protection.
1378
1379.. data:: OID_TIME_STAMPING
1380
1381 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.8"``. This is used to
1382 denote that a certificate may be used for time stamping.
1383
1384.. data:: OID_OCSP_SIGNING
1385
1386 Corresponds to the dotted string ``"1.3.6.1.5.5.7.3.9"``. This is used to
1387 denote that a certificate may be used for signing OCSP responses.
1388
Paul Kehrer3e6d5582015-05-02 21:57:56 -05001389Authority Information Access OIDs
1390~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1391
1392.. data:: OID_OCSP
1393
1394 Corresponds to the dotted string ``"1.3.6.1.5.5.7.48.1"``. Used as the
1395 identifier for OCSP data in :class:`AccessDescription` objects.
1396
1397.. data:: OID_CA_ISSUERS
1398
1399 Corresponds to the dotted string ``"1.3.6.1.5.5.7.48.2"``. Used as the
1400 identifier for CA issuer data in :class:`AccessDescription` objects.
1401
Paul Kehrer2e879742015-05-02 23:09:56 -05001402Policy Qualifier OIDs
1403~~~~~~~~~~~~~~~~~~~~~
1404
1405.. data:: OID_CPS_QUALIFIER
1406
Paul Kehrerba35b3b2015-05-10 13:07:59 -05001407 Corresponds to the dotted string ``"1.3.6.1.5.5.7.2.1"``.
Paul Kehrer2e879742015-05-02 23:09:56 -05001408
1409.. data:: OID_CPS_USER_NOTICE
1410
Paul Kehrerba35b3b2015-05-10 13:07:59 -05001411 Corresponds to the dotted string ``"1.3.6.1.5.5.7.2.2"``.
Paul Kehrer2e879742015-05-02 23:09:56 -05001412
Paul Kehrer16fae762015-05-01 23:14:20 -05001413.. data:: OID_ANY_POLICY
1414
1415 Corresponds to the dotted string ``"2.5.29.32.0"``.
1416
Paul Kehrer5553d572015-03-23 21:08:01 -05001417.. _extension_oids:
1418
Paul Kehrer2bb94642015-03-21 09:54:17 -05001419Extension OIDs
1420~~~~~~~~~~~~~~
1421
1422.. data:: OID_BASIC_CONSTRAINTS
1423
1424 Corresponds to the dotted string ``"2.5.29.19"``. The identifier for the
Paul Kehrer611d3d32015-03-22 13:31:18 -05001425 :class:`BasicConstraints` extension type.
Paul Kehrer2bb94642015-03-21 09:54:17 -05001426
Paul Kehrercecbbba2015-03-30 14:58:38 -05001427.. data:: OID_KEY_USAGE
1428
1429 Corresponds to the dotted string ``"2.5.29.15"``. The identifier for the
1430 :class:`KeyUsage` extension type.
1431
Paul Kehrerd4f632e2015-05-12 08:25:42 -05001432.. data:: OID_SUBJECT_ALTERNATIVE_NAME
1433
1434 Corresponds to the dotted string ``"2.5.29.17"``. The identifier for the
1435 :class:`SubjectAlternativeName` extension type.
1436
Paul Kehrer99125c92015-06-07 18:37:10 -05001437.. data:: OID_ISSUER_ALTERNATIVE_NAME
1438
1439 Corresponds to the dotted string ``"2.5.29.18"``. The identifier for the
1440 :class:`IssuerAlternativeName` extension type.
1441
Paul Kehrerd4f632e2015-05-12 08:25:42 -05001442.. data:: OID_SUBJECT_KEY_IDENTIFIER
1443
1444 Corresponds to the dotted string ``"2.5.29.14"``. The identifier for the
1445 :class:`SubjectKeyIdentifier` extension type.
1446
Paul Kehrere0017be2015-05-17 20:39:40 -06001447.. data:: OID_NAME_CONSTRAINTS
1448
1449 Corresponds to the dotted string ``"2.5.29.30"``. The identifier for the
1450 :class:`NameConstraints` extension type.
1451
Paul Kehrerd4f632e2015-05-12 08:25:42 -05001452.. data:: OID_CRL_DISTRIBUTION_POINTS
1453
1454 Corresponds to the dotted string ``"2.5.29.31"``. The identifier for the
1455 :class:`CRLDistributionPoints` extension type.
1456
1457.. data:: OID_CERTIFICATE_POLICIES
1458
1459 Corresponds to the dotted string ``"2.5.29.32"``. The identifier for the
1460 :class:`CertificatePolicies` extension type.
1461
1462.. data:: OID_AUTHORITY_KEY_IDENTIFIER
1463
1464 Corresponds to the dotted string ``"2.5.29.35"``. The identifier for the
1465 :class:`AuthorityKeyIdentifier` extension type.
1466
1467.. data:: OID_EXTENDED_KEY_USAGE
1468
1469 Corresponds to the dotted string ``"2.5.29.37"``. The identifier for the
1470 :class:`ExtendedKeyUsage` extension type.
1471
1472.. data:: OID_AUTHORITY_INFORMATION_ACCESS
1473
1474 Corresponds to the dotted string ``"1.3.6.1.5.5.7.1.1"``. The identifier
1475 for the :class:`AuthorityInformationAccess` extension type.
Paul Kehrer56da2a52015-02-11 23:35:07 -06001476
Paul Kehrer4a1038e2015-05-18 10:28:31 -07001477.. data:: OID_OCSP_NO_CHECK
1478
1479 Corresponds to the dotted string ``"1.3.6.1.5.5.7.48.1.5"``. The identifier
1480 for the :class:`OCSPNoCheck` extension type.
1481
Paul Kehrer912d3fb2015-01-29 11:19:22 -06001482Exceptions
1483~~~~~~~~~~
1484
Paul Kehrere76cd272014-12-14 19:00:51 -06001485.. class:: InvalidVersion
Paul Kehrera68fd332014-11-27 07:08:40 -10001486
1487 This is raised when an X.509 certificate has an invalid version number.
Paul Kehrer016e08a2014-11-26 09:41:18 -10001488
Paul Kehrerd5cccf72014-12-15 17:20:33 -06001489 .. attribute:: parsed_version
1490
Paul Kehrerbbffc402014-12-17 13:33:55 -06001491 :type: int
1492
1493 Returns the raw version that was parsed from the certificate.
Paul Kehrerd5cccf72014-12-15 17:20:33 -06001494
Paul Kehrerfbb7ac82015-03-16 19:26:29 -05001495.. class:: DuplicateExtension
1496
1497 This is raised when more than one X.509 extension of the same type is
1498 found within a certificate.
1499
1500 .. attribute:: oid
1501
1502 :type: :class:`ObjectIdentifier`
1503
1504 Returns the OID.
1505
1506.. class:: UnsupportedExtension
1507
1508 This is raised when a certificate contains an unsupported extension type.
1509
1510 .. attribute:: oid
1511
1512 :type: :class:`ObjectIdentifier`
1513
1514 Returns the OID.
1515
Paul Kehrerfa56a232015-03-17 13:14:03 -05001516.. class:: ExtensionNotFound
1517
1518 This is raised when calling :meth:`Extensions.get_extension_for_oid` with
1519 an extension OID that is not present in the certificate.
1520
1521 .. attribute:: oid
1522
1523 :type: :class:`ObjectIdentifier`
1524
1525 Returns the OID.
1526
Paul Kehrer9089c912015-04-20 22:15:20 -05001527.. class:: UnsupportedGeneralNameType
1528
1529 This is raised when a certificate contains an unsupported general name
1530 type in an extension.
1531
Paul Kehrerbed07352015-04-21 08:31:10 -05001532 .. attribute:: type
1533
Paul Kehrer0a621bf2015-04-22 09:22:56 -05001534 :type: int
1535
1536 The integer value of the unsupported type. The complete list of
1537 types can be found in `RFC 5280 section 4.2.1.6`_.
Paul Kehrerbed07352015-04-21 08:31:10 -05001538
Paul Kehrer016e08a2014-11-26 09:41:18 -10001539
1540.. _`public key infrastructure`: https://en.wikipedia.org/wiki/Public_key_infrastructure
Paul Kehrera68fd332014-11-27 07:08:40 -10001541.. _`TLS`: https://en.wikipedia.org/wiki/Transport_Layer_Security
Paul Kehrerc7c9a432015-04-19 09:20:13 -05001542.. _`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 -05001543.. _`RFC 5280 section 4.2.1.6`: https://tools.ietf.org/html/rfc5280#section-4.2.1.6