blob: 101f3bdb1009b9e4943d1d256bd91bea228050e9 [file] [log] [blame]
Jonathan Ballet6381da32011-07-20 16:43:38 +09001.. _openssl-crypto:
2
3:py:mod:`crypto` --- Generic cryptographic module
4=================================================
5
Jonathan Balletc9e066c2011-07-17 22:56:05 +09006.. py:module:: OpenSSL.crypto
Jonathan Ballet6381da32011-07-20 16:43:38 +09007 :synopsis: Generic cryptographic module
Jonathan Ballet648875f2011-07-16 14:14:58 +09008
Laurens Van Houtven07051d32014-06-19 12:00:30 +02009Elliptic curves
10---------------
Jonathan Balletc9e066c2011-07-17 22:56:05 +090011
Jean-Paul Calderonec09fd582014-04-18 22:00:10 -040012.. py:function:: get_elliptic_curves
13
14 Return a set of objects representing the elliptic curves supported in the
15 OpenSSL build in use.
16
17 The curve objects have a :py:class:`unicode` ``name`` attribute by which
Jean-Paul Calderoneaaf516d2014-04-19 09:10:45 -040018 they identify themselves.
Jean-Paul Calderonec09fd582014-04-18 22:00:10 -040019
20 The curve objects are useful as values for the argument accepted by
Jean-Paul Calderone3b04e352014-04-19 09:29:10 -040021 :py:meth:`Context.set_tmp_ecdh` to specify which elliptical curve should be
22 used for ECDHE key exchange.
Jean-Paul Calderonec09fd582014-04-18 22:00:10 -040023
24
25.. py:function:: get_elliptic_curve
26
27 Return a single curve object selected by name.
28
29 See :py:func:`get_elliptic_curves` for information about curve objects.
30
31 If the named curve is not supported then :py:class:`ValueError` is raised.
32
33
Laurens Van Houtven07051d32014-06-19 12:00:30 +020034Serialization and deserialization
35---------------------------------
36
37The following serialization functions take one of these constants to
38determine the format:
39
40.. py:data:: FILETYPE_PEM
41 FILETYPE_ASN1
42
43Certificates
44~~~~~~~~~~~~
45
Jonathan Balletc9e066c2011-07-17 22:56:05 +090046.. py:function:: dump_certificate(type, cert)
47
48 Dump the certificate *cert* into a buffer string encoded with the type
49 *type*.
50
Laurens Van Houtven07051d32014-06-19 12:00:30 +020051.. py:function:: load_certificate(type, buffer)
52
53 Load a certificate (X509) from the string *buffer* encoded with the
54 type *type*.
55
56Certificate signing requests
57~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Jonathan Balletc9e066c2011-07-17 22:56:05 +090058
59.. py:function:: dump_certificate_request(type, req)
60
61 Dump the certificate request *req* into a buffer string encoded with the
62 type *type*.
63
Laurens Van Houtven07051d32014-06-19 12:00:30 +020064.. py:function:: load_certificate_request(type, buffer)
65
66 Load a certificate request (X509Req) from the string *buffer* encoded with
67 the type *type*.
68
69Private keys
70~~~~~~~~~~~~
Jonathan Balletc9e066c2011-07-17 22:56:05 +090071
72.. py:function:: dump_privatekey(type, pkey[, cipher, passphrase])
73
74 Dump the private key *pkey* into a buffer string encoded with the type
75 *type*, optionally (if *type* is :py:const:`FILETYPE_PEM`) encrypting it
76 using *cipher* and *passphrase*.
77
78 *passphrase* must be either a string or a callback for providing the
79 pass phrase.
80
Jonathan Balletc9e066c2011-07-17 22:56:05 +090081.. py:function:: load_privatekey(type, buffer[, passphrase])
82
83 Load a private key (PKey) from the string *buffer* encoded with the type
84 *type* (must be one of :py:const:`FILETYPE_PEM` and
85 :py:const:`FILETYPE_ASN1`).
86
87 *passphrase* must be either a string or a callback for providing the pass
88 phrase.
89
Laurens Van Houtven07051d32014-06-19 12:00:30 +020090Certificate revocation lists
91~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Jonathan Balletc9e066c2011-07-17 22:56:05 +090092
93.. py:function:: load_crl(type, buffer)
94
95 Load Certificate Revocation List (CRL) data from a string *buffer*.
96 *buffer* encoded with the type *type*. The type *type* must either
97 :py:const:`FILETYPE_PEM` or :py:const:`FILETYPE_ASN1`).
98
99
100.. py:function:: load_pkcs7_data(type, buffer)
101
Laurens Van Houtven0f820872015-04-20 11:25:57 -0700102 Load pkcs7 data from the string *buffer* encoded with the type
103 *type*. The type *type* must either :py:const:`FILETYPE_PEM` or
104 :py:const:`FILETYPE_ASN1`).
Jonathan Balletc9e066c2011-07-17 22:56:05 +0900105
106
107.. py:function:: load_pkcs12(buffer[, passphrase])
108
109 Load pkcs12 data from the string *buffer*. If the pkcs12 structure is
110 encrypted, a *passphrase* must be included. The MAC is always
111 checked and thus required.
112
113 See also the man page for the C function :py:func:`PKCS12_parse`.
114
Laurens Van Houtven07051d32014-06-19 12:00:30 +0200115Signing and verifying signatures
116--------------------------------
Jonathan Balletc9e066c2011-07-17 22:56:05 +0900117
118.. py:function:: sign(key, data, digest)
119
120 Sign a data string using the given key and message digest.
121
122 *key* is a :py:class:`PKey` instance. *data* is a ``str`` instance.
123 *digest* is a ``str`` naming a supported message digest type, for example
124 :py:const:`sha1`.
125
126 .. versionadded:: 0.11
127
128
129.. py:function:: verify(certificate, signature, data, digest)
130
131 Verify the signature for a data string.
132
133 *certificate* is a :py:class:`X509` instance corresponding to the private
134 key which generated the signature. *signature* is a *str* instance giving
135 the signature itself. *data* is a *str* instance giving the data to which
136 the signature applies. *digest* is a *str* instance naming the message
137 digest type of the signature, for example :py:const:`sha1`.
138
139 .. versionadded:: 0.11
140
141
142.. _openssl-x509:
143
144X509 objects
145------------
146
Laurens Van Houtvenc3baa7b2014-06-18 22:06:56 +0200147.. autoclass:: X509
148 :members:
Jonathan Balletc9e066c2011-07-17 22:56:05 +0900149
150.. _openssl-x509name:
151
152X509Name objects
153----------------
154
Laurens Van Houtven196195b2014-06-17 17:06:34 +0200155.. autoclass:: X509Name
156 :members:
157 :special-members:
158 :exclude-members: __repr__, __getattr__, __weakref__
Jonathan Balletc9e066c2011-07-17 22:56:05 +0900159
160.. _openssl-x509req:
161
162X509Req objects
163---------------
164
Laurens Van Houtven3e83d242014-06-18 14:29:47 +0200165.. autoclass:: X509Req
166 :members:
167 :special-members:
168 :exclude-members: __weakref__
Jean-Paul Calderone26e07d62014-03-02 08:08:23 -0500169
Jonathan Balletc9e066c2011-07-17 22:56:05 +0900170.. _openssl-x509store:
171
172X509Store objects
173-----------------
174
Laurens Van Houtven8aeafdd2014-06-17 15:33:42 +0200175.. autoclass:: X509Store
176 :members:
Jonathan Balletc9e066c2011-07-17 22:56:05 +0900177
Stephen Holsapple95a46652015-02-09 19:34:25 -0800178X509StoreContextError objects
179-----------------------------
180
181The X509StoreContextError is an exception raised from
182`X509StoreContext.verify_certificate` in circumstances where a certificate
183cannot be verified in a provided context.
184
Jean-Paul Calderone876b2ac2015-03-15 16:17:19 -0400185The certificate for which the verification error was detected is given by the
186``certificate`` attribute of the exception instance as a :class:`X509`
187instance.
188
Laurens Van Houtven9313a4e2015-04-20 11:27:28 -0700189Details about the verification error are given in the exception's
190``args`` attribute.
Stephen Holsapple95a46652015-02-09 19:34:25 -0800191
Stephen Holsapple08ffaa62015-01-30 17:18:40 -0800192X509StoreContext objects
193------------------------
194
195The X509StoreContext object is used for verifying a certificate against a set
196of trusted certificates.
197
198
199.. py:method:: X509StoreContext.verify_certificate()
200
201 Verify a certificate in the context of this initialized `X509StoreContext`.
202 On error, raises `X509StoreContextError`, otherwise does nothing.
203
204 .. versionadded:: 0.15
205
206
Jonathan Balletc9e066c2011-07-17 22:56:05 +0900207.. _openssl-pkey:
208
209PKey objects
210------------
211
Laurens Van Houtven6e7dd432014-06-17 16:10:57 +0200212.. autoclass:: PKey
213 :members:
Jonathan Balletc9e066c2011-07-17 22:56:05 +0900214
215.. _openssl-pkcs7:
216
Laurens Van Houtven9d4c0742015-04-20 11:58:39 -0700217.. py:data:: TYPE_RSA
218 TYPE_DSA
219
220 Key type constants.
221
Jonathan Balletc9e066c2011-07-17 22:56:05 +0900222PKCS7 objects
223-------------
224
225PKCS7 objects have the following methods:
226
Jonathan Ballet6381da32011-07-20 16:43:38 +0900227.. py:method:: PKCS7.type_is_signed()
Jonathan Balletc9e066c2011-07-17 22:56:05 +0900228
229 FIXME
230
Jonathan Ballet6381da32011-07-20 16:43:38 +0900231.. py:method:: PKCS7.type_is_enveloped()
Jonathan Balletc9e066c2011-07-17 22:56:05 +0900232
233 FIXME
234
Jonathan Ballet6381da32011-07-20 16:43:38 +0900235.. py:method:: PKCS7.type_is_signedAndEnveloped()
Jonathan Balletc9e066c2011-07-17 22:56:05 +0900236
237 FIXME
238
Jonathan Ballet6381da32011-07-20 16:43:38 +0900239.. py:method:: PKCS7.type_is_data()
Jonathan Balletc9e066c2011-07-17 22:56:05 +0900240
241 FIXME
242
Jonathan Ballet6381da32011-07-20 16:43:38 +0900243.. py:method:: PKCS7.get_type_name()
Jonathan Balletc9e066c2011-07-17 22:56:05 +0900244
245 Get the type name of the PKCS7.
246
Jonathan Balletc9e066c2011-07-17 22:56:05 +0900247.. _openssl-pkcs12:
248
249PKCS12 objects
250--------------
251
Laurens Van Houtvenbb503a32014-06-19 12:28:08 +0200252.. autoclass:: PKCS12
253 :members:
Jonathan Balletc9e066c2011-07-17 22:56:05 +0900254
255.. _openssl-509ext:
256
257X509Extension objects
258---------------------
259
Laurens Van Houtven2650de52014-06-18 13:47:47 +0200260.. autoclass:: X509Extension
261 :members:
262 :special-members:
263 :exclude-members: __weakref__
Jonathan Balletc9e066c2011-07-17 22:56:05 +0900264
265.. _openssl-netscape-spki:
266
267NetscapeSPKI objects
268--------------------
269
Laurens Van Houtven59152b52014-06-19 16:42:30 +0200270.. autoclass:: NetscapeSPKI
271 :members:
272 :special-members:
273 :exclude-members: __weakref__
Jonathan Balletc9e066c2011-07-17 22:56:05 +0900274
Laurens Van Houtven889b9d22015-04-20 12:18:28 -0700275.. _crl:
276
277CRL objects
278-----------
279
280.. autoclass:: CRL
281 :members:
282 :special-members:
283 :exclude-members: __weakref__
284
285.. _revoked:
286
287Revoked objects
288---------------
289
290.. autoclass:: Revoked
291 :members:
292
Laurens Van Houtven3de6b2b2015-04-20 12:20:42 -0700293Exceptions
294----------
295
296.. py:exception:: Error
297
298 Generic exception used in the :py:mod:`.crypto` module.
299
Laurens Van Houtvenc3baa7b2014-06-18 22:06:56 +0200300Digest names
301------------
302
303Several of the functions and methods in this module take a digest
304name. These must be strings describing a digest algorithm supported by
305OpenSSL (by ``EVP_get_digestbyname``, specifically). For example,
306:py:const:`b"md5"` or :py:const:`b"sha1"`.
307
308More information and a list of these digest names can be found in the
309``EVP_DigestInit(3)`` man page of your OpenSSL installation. This page
310can be found online for the latest version of OpenSSL:
311https://www.openssl.org/docs/crypto/EVP_DigestInit.html
312
Laurens Van Houtven13d56ba2014-06-17 16:00:26 +0200313Backwards compatible type names
314-------------------------------
315
316When PyOpenSSL was originally written, the most current version of
317Python was 2.1. It made a distinction between classes and types. None
318of the versions of Python currently supported by PyOpenSSL still
319enforce that distinction: the type of an instance of an
320:py:class:`X509` object is now simply :py:class:`X509`. Originally,
321the type would have been :py:class:`X509Type`. These days,
322:py:class:`X509Type` and :py:class:`X509` are literally the same
323object. PyOpenSSL maintains these old names for backwards
324compatibility.
325
326Here's a table of these backwards-compatible names:
327
328========================= =============================
329Type name Backwards-compatible name
330========================= =============================
331:py:class:`X509` :py:class:`X509Type`
332:py:class:`X509Name` :py:class:`X509NameType`
333:py:class:`X509Req` :py:class:`X509ReqType`
334:py:class:`X509Store` :py:class:`X509StoreType`
335:py:class:`X509Extension` :py:class:`X509ExtensionType`
336:py:class:`PKey` :py:class:`PKeyType`
337:py:class:`PKCS7` :py:class:`PKCS7Type`
338:py:class:`PKCS12` :py:class:`PKCS12Type`
339:py:class:`NetscapeSPKI` :py:class:`NetscapeSPKIType`
340:py:class:`CRL` :py:class:`CRLType`
341========================= =============================
342
Laurens Van Houtven5faa2812015-04-23 10:44:10 -0700343Some objects, such as :py:class`Revoked`, don't have ``Type``
Laurens Van Houtven13d56ba2014-06-17 16:00:26 +0200344equivalents, because they were added after the restriction had been
345lifted.