Jonathan Ballet | 6381da3 | 2011-07-20 16:43:38 +0900 | [diff] [blame] | 1 | .. _openssl-crypto: |
| 2 | |
| 3 | :py:mod:`crypto` --- Generic cryptographic module |
| 4 | ================================================= |
| 5 | |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 6 | .. py:module:: OpenSSL.crypto |
Jonathan Ballet | 6381da3 | 2011-07-20 16:43:38 +0900 | [diff] [blame] | 7 | :synopsis: Generic cryptographic module |
Jonathan Ballet | 648875f | 2011-07-16 14:14:58 +0900 | [diff] [blame] | 8 | |
Laurens Van Houtven | 07051d3 | 2014-06-19 12:00:30 +0200 | [diff] [blame] | 9 | Elliptic curves |
| 10 | --------------- |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 11 | |
Jean-Paul Calderone | c09fd58 | 2014-04-18 22:00:10 -0400 | [diff] [blame] | 12 | .. 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 Calderone | aaf516d | 2014-04-19 09:10:45 -0400 | [diff] [blame] | 18 | they identify themselves. |
Jean-Paul Calderone | c09fd58 | 2014-04-18 22:00:10 -0400 | [diff] [blame] | 19 | |
| 20 | The curve objects are useful as values for the argument accepted by |
Jean-Paul Calderone | 3b04e35 | 2014-04-19 09:29:10 -0400 | [diff] [blame] | 21 | :py:meth:`Context.set_tmp_ecdh` to specify which elliptical curve should be |
| 22 | used for ECDHE key exchange. |
Jean-Paul Calderone | c09fd58 | 2014-04-18 22:00:10 -0400 | [diff] [blame] | 23 | |
| 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 Houtven | 07051d3 | 2014-06-19 12:00:30 +0200 | [diff] [blame] | 34 | Serialization and deserialization |
| 35 | --------------------------------- |
| 36 | |
| 37 | The following serialization functions take one of these constants to |
| 38 | determine the format: |
| 39 | |
| 40 | .. py:data:: FILETYPE_PEM |
| 41 | FILETYPE_ASN1 |
| 42 | |
| 43 | Certificates |
| 44 | ~~~~~~~~~~~~ |
| 45 | |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 46 | .. 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 Houtven | 07051d3 | 2014-06-19 12:00:30 +0200 | [diff] [blame] | 51 | .. py:function:: load_certificate(type, buffer) |
| 52 | |
| 53 | Load a certificate (X509) from the string *buffer* encoded with the |
| 54 | type *type*. |
| 55 | |
| 56 | Certificate signing requests |
| 57 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 58 | |
| 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 Houtven | 07051d3 | 2014-06-19 12:00:30 +0200 | [diff] [blame] | 64 | .. 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 | |
| 69 | Private keys |
| 70 | ~~~~~~~~~~~~ |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 71 | |
| 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 Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 81 | .. 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 Houtven | 07051d3 | 2014-06-19 12:00:30 +0200 | [diff] [blame] | 90 | Certificate revocation lists |
| 91 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 92 | |
| 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 Houtven | 0f82087 | 2015-04-20 11:25:57 -0700 | [diff] [blame] | 102 | 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 Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 105 | |
| 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 Houtven | 07051d3 | 2014-06-19 12:00:30 +0200 | [diff] [blame] | 115 | Signing and verifying signatures |
| 116 | -------------------------------- |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 117 | |
| 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 | |
| 144 | X509 objects |
| 145 | ------------ |
| 146 | |
Laurens Van Houtven | c3baa7b | 2014-06-18 22:06:56 +0200 | [diff] [blame] | 147 | .. autoclass:: X509 |
| 148 | :members: |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 149 | |
| 150 | .. _openssl-x509name: |
| 151 | |
| 152 | X509Name objects |
| 153 | ---------------- |
| 154 | |
Laurens Van Houtven | 196195b | 2014-06-17 17:06:34 +0200 | [diff] [blame] | 155 | .. autoclass:: X509Name |
| 156 | :members: |
| 157 | :special-members: |
| 158 | :exclude-members: __repr__, __getattr__, __weakref__ |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 159 | |
| 160 | .. _openssl-x509req: |
| 161 | |
| 162 | X509Req objects |
| 163 | --------------- |
| 164 | |
Laurens Van Houtven | 3e83d24 | 2014-06-18 14:29:47 +0200 | [diff] [blame] | 165 | .. autoclass:: X509Req |
| 166 | :members: |
| 167 | :special-members: |
| 168 | :exclude-members: __weakref__ |
Jean-Paul Calderone | 26e07d6 | 2014-03-02 08:08:23 -0500 | [diff] [blame] | 169 | |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 170 | .. _openssl-x509store: |
| 171 | |
| 172 | X509Store objects |
| 173 | ----------------- |
| 174 | |
Laurens Van Houtven | 8aeafdd | 2014-06-17 15:33:42 +0200 | [diff] [blame] | 175 | .. autoclass:: X509Store |
| 176 | :members: |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 177 | |
Stephen Holsapple | 95a4665 | 2015-02-09 19:34:25 -0800 | [diff] [blame] | 178 | X509StoreContextError objects |
| 179 | ----------------------------- |
| 180 | |
| 181 | The X509StoreContextError is an exception raised from |
| 182 | `X509StoreContext.verify_certificate` in circumstances where a certificate |
| 183 | cannot be verified in a provided context. |
| 184 | |
Jean-Paul Calderone | 876b2ac | 2015-03-15 16:17:19 -0400 | [diff] [blame] | 185 | The certificate for which the verification error was detected is given by the |
| 186 | ``certificate`` attribute of the exception instance as a :class:`X509` |
| 187 | instance. |
| 188 | |
Laurens Van Houtven | 9313a4e | 2015-04-20 11:27:28 -0700 | [diff] [blame] | 189 | Details about the verification error are given in the exception's |
| 190 | ``args`` attribute. |
Stephen Holsapple | 95a4665 | 2015-02-09 19:34:25 -0800 | [diff] [blame] | 191 | |
Stephen Holsapple | 08ffaa6 | 2015-01-30 17:18:40 -0800 | [diff] [blame] | 192 | X509StoreContext objects |
| 193 | ------------------------ |
| 194 | |
| 195 | The X509StoreContext object is used for verifying a certificate against a set |
| 196 | of 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 Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 207 | .. _openssl-pkey: |
| 208 | |
| 209 | PKey objects |
| 210 | ------------ |
| 211 | |
Laurens Van Houtven | 6e7dd43 | 2014-06-17 16:10:57 +0200 | [diff] [blame] | 212 | .. autoclass:: PKey |
| 213 | :members: |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 214 | |
| 215 | .. _openssl-pkcs7: |
| 216 | |
Laurens Van Houtven | 9d4c074 | 2015-04-20 11:58:39 -0700 | [diff] [blame] | 217 | .. py:data:: TYPE_RSA |
| 218 | TYPE_DSA |
| 219 | |
| 220 | Key type constants. |
| 221 | |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 222 | PKCS7 objects |
| 223 | ------------- |
| 224 | |
| 225 | PKCS7 objects have the following methods: |
| 226 | |
Jonathan Ballet | 6381da3 | 2011-07-20 16:43:38 +0900 | [diff] [blame] | 227 | .. py:method:: PKCS7.type_is_signed() |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 228 | |
| 229 | FIXME |
| 230 | |
Jonathan Ballet | 6381da3 | 2011-07-20 16:43:38 +0900 | [diff] [blame] | 231 | .. py:method:: PKCS7.type_is_enveloped() |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 232 | |
| 233 | FIXME |
| 234 | |
Jonathan Ballet | 6381da3 | 2011-07-20 16:43:38 +0900 | [diff] [blame] | 235 | .. py:method:: PKCS7.type_is_signedAndEnveloped() |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 236 | |
| 237 | FIXME |
| 238 | |
Jonathan Ballet | 6381da3 | 2011-07-20 16:43:38 +0900 | [diff] [blame] | 239 | .. py:method:: PKCS7.type_is_data() |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 240 | |
| 241 | FIXME |
| 242 | |
Jonathan Ballet | 6381da3 | 2011-07-20 16:43:38 +0900 | [diff] [blame] | 243 | .. py:method:: PKCS7.get_type_name() |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 244 | |
| 245 | Get the type name of the PKCS7. |
| 246 | |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 247 | .. _openssl-pkcs12: |
| 248 | |
| 249 | PKCS12 objects |
| 250 | -------------- |
| 251 | |
Laurens Van Houtven | bb503a3 | 2014-06-19 12:28:08 +0200 | [diff] [blame] | 252 | .. autoclass:: PKCS12 |
| 253 | :members: |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 254 | |
| 255 | .. _openssl-509ext: |
| 256 | |
| 257 | X509Extension objects |
| 258 | --------------------- |
| 259 | |
Laurens Van Houtven | 2650de5 | 2014-06-18 13:47:47 +0200 | [diff] [blame] | 260 | .. autoclass:: X509Extension |
| 261 | :members: |
| 262 | :special-members: |
| 263 | :exclude-members: __weakref__ |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 264 | |
| 265 | .. _openssl-netscape-spki: |
| 266 | |
| 267 | NetscapeSPKI objects |
| 268 | -------------------- |
| 269 | |
Laurens Van Houtven | 59152b5 | 2014-06-19 16:42:30 +0200 | [diff] [blame] | 270 | .. autoclass:: NetscapeSPKI |
| 271 | :members: |
| 272 | :special-members: |
| 273 | :exclude-members: __weakref__ |
Jonathan Ballet | c9e066c | 2011-07-17 22:56:05 +0900 | [diff] [blame] | 274 | |
Laurens Van Houtven | 889b9d2 | 2015-04-20 12:18:28 -0700 | [diff] [blame] | 275 | .. _crl: |
| 276 | |
| 277 | CRL objects |
| 278 | ----------- |
| 279 | |
| 280 | .. autoclass:: CRL |
| 281 | :members: |
| 282 | :special-members: |
| 283 | :exclude-members: __weakref__ |
| 284 | |
| 285 | .. _revoked: |
| 286 | |
| 287 | Revoked objects |
| 288 | --------------- |
| 289 | |
| 290 | .. autoclass:: Revoked |
| 291 | :members: |
| 292 | |
Laurens Van Houtven | 3de6b2b | 2015-04-20 12:20:42 -0700 | [diff] [blame] | 293 | Exceptions |
| 294 | ---------- |
| 295 | |
| 296 | .. py:exception:: Error |
| 297 | |
| 298 | Generic exception used in the :py:mod:`.crypto` module. |
| 299 | |
Laurens Van Houtven | c3baa7b | 2014-06-18 22:06:56 +0200 | [diff] [blame] | 300 | Digest names |
| 301 | ------------ |
| 302 | |
| 303 | Several of the functions and methods in this module take a digest |
| 304 | name. These must be strings describing a digest algorithm supported by |
| 305 | OpenSSL (by ``EVP_get_digestbyname``, specifically). For example, |
| 306 | :py:const:`b"md5"` or :py:const:`b"sha1"`. |
| 307 | |
| 308 | More 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 |
| 310 | can be found online for the latest version of OpenSSL: |
| 311 | https://www.openssl.org/docs/crypto/EVP_DigestInit.html |
| 312 | |
Laurens Van Houtven | 13d56ba | 2014-06-17 16:00:26 +0200 | [diff] [blame] | 313 | Backwards compatible type names |
| 314 | ------------------------------- |
| 315 | |
| 316 | When PyOpenSSL was originally written, the most current version of |
| 317 | Python was 2.1. It made a distinction between classes and types. None |
| 318 | of the versions of Python currently supported by PyOpenSSL still |
| 319 | enforce that distinction: the type of an instance of an |
| 320 | :py:class:`X509` object is now simply :py:class:`X509`. Originally, |
| 321 | the type would have been :py:class:`X509Type`. These days, |
| 322 | :py:class:`X509Type` and :py:class:`X509` are literally the same |
| 323 | object. PyOpenSSL maintains these old names for backwards |
| 324 | compatibility. |
| 325 | |
| 326 | Here's a table of these backwards-compatible names: |
| 327 | |
| 328 | ========================= ============================= |
| 329 | Type 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 Houtven | 5faa281 | 2015-04-23 10:44:10 -0700 | [diff] [blame] | 343 | Some objects, such as :py:class`Revoked`, don't have ``Type`` |
Laurens Van Houtven | 13d56ba | 2014-06-17 16:00:26 +0200 | [diff] [blame] | 344 | equivalents, because they were added after the restriction had been |
| 345 | lifted. |