/usr/share/doc/python-openssl-doc/html/_sources/api/crypto.txt is in python-openssl-doc 0.15.1-2ubuntu0.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 | .. _openssl-crypto:
:py:mod:`crypto` --- Generic cryptographic module
=================================================
.. py:module:: OpenSSL.crypto
:synopsis: Generic cryptographic module
.. py:data:: X509Type
See :py:class:`X509`.
.. py:class:: X509()
A class representing X.509 certificates.
.. py:data:: X509NameType
See :py:class:`X509Name`.
.. py:class:: X509Name(x509name)
A class representing X.509 Distinguished Names.
This constructor creates a copy of *x509name* which should be an
instance of :py:class:`X509Name`.
.. py:data:: X509ReqType
See :py:class:`X509Req`.
.. py:class:: X509Req()
A class representing X.509 certificate requests.
.. py:data:: X509StoreType
See :py:class:`X509Store`
.. py:data X509Store
A class representing the X.509 store.
.. py:data:: X509StoreContext
A class representing the X.509 store context.
.. py:data:: PKeyType
See :py:class:`PKey`.
.. py:class:: PKey()
A class representing DSA or RSA keys.
.. py:data:: PKCS7Type
A Python type object representing the PKCS7 object type.
.. py:data:: PKCS12Type
A Python type object representing the PKCS12 object type.
.. py:data:: X509ExtensionType
See :py:class:`X509Extension`.
.. py:class:: X509Extension(typename, critical, value[, subject][, issuer])
A class representing an X.509 v3 certificate extensions. See
http://openssl.org/docs/apps/x509v3_config.html#STANDARD_EXTENSIONS for
*typename* strings and their options. Optional parameters *subject* and
*issuer* must be X509 objects.
.. py:data:: NetscapeSPKIType
See :py:class:`NetscapeSPKI`.
.. py:class:: NetscapeSPKI([enc])
A class representing Netscape SPKI objects.
If the *enc* argument is present, it should be a base64-encoded string
representing a NetscapeSPKI object, as returned by the :py:meth:`b64_encode`
method.
.. py:class:: CRL()
A class representing Certifcate Revocation List objects.
.. py:class:: Revoked()
A class representing Revocation objects of CRL.
.. py:data:: FILETYPE_PEM
FILETYPE_ASN1
File type constants.
.. py:data:: TYPE_RSA
TYPE_DSA
Key type constants.
.. py:exception:: Error
Generic exception used in the :py:mod:`.crypto` module.
.. py:function:: get_elliptic_curves
Return a set of objects representing the elliptic curves supported in the
OpenSSL build in use.
The curve objects have a :py:class:`unicode` ``name`` attribute by which
they identify themselves.
The curve objects are useful as values for the argument accepted by
:py:meth:`Context.set_tmp_ecdh` to specify which elliptical curve should be
used for ECDHE key exchange.
.. py:function:: get_elliptic_curve
Return a single curve object selected by name.
See :py:func:`get_elliptic_curves` for information about curve objects.
If the named curve is not supported then :py:class:`ValueError` is raised.
.. py:function:: dump_certificate(type, cert)
Dump the certificate *cert* into a buffer string encoded with the type
*type*.
.. py:function:: dump_certificate_request(type, req)
Dump the certificate request *req* into a buffer string encoded with the
type *type*.
.. py:function:: dump_privatekey(type, pkey[, cipher, passphrase])
Dump the private key *pkey* into a buffer string encoded with the type
*type*, optionally (if *type* is :py:const:`FILETYPE_PEM`) encrypting it
using *cipher* and *passphrase*.
*passphrase* must be either a string or a callback for providing the
pass phrase.
.. py:function:: load_certificate(type, buffer)
Load a certificate (X509) from the string *buffer* encoded with the
type *type*.
.. py:function:: load_certificate_request(type, buffer)
Load a certificate request (X509Req) from the string *buffer* encoded with
the type *type*.
.. py:function:: load_privatekey(type, buffer[, passphrase])
Load a private key (PKey) from the string *buffer* encoded with the type
*type* (must be one of :py:const:`FILETYPE_PEM` and
:py:const:`FILETYPE_ASN1`).
*passphrase* must be either a string or a callback for providing the pass
phrase.
.. py:function:: load_crl(type, buffer)
Load Certificate Revocation List (CRL) data from a string *buffer*.
*buffer* encoded with the type *type*. The type *type* must either
:py:const:`FILETYPE_PEM` or :py:const:`FILETYPE_ASN1`).
.. py:function:: load_pkcs7_data(type, buffer)
Load pkcs7 data from the string *buffer* encoded with the type *type*.
.. py:function:: load_pkcs12(buffer[, passphrase])
Load pkcs12 data from the string *buffer*. If the pkcs12 structure is
encrypted, a *passphrase* must be included. The MAC is always
checked and thus required.
See also the man page for the C function :py:func:`PKCS12_parse`.
.. py:function:: sign(key, data, digest)
Sign a data string using the given key and message digest.
*key* is a :py:class:`PKey` instance. *data* is a ``str`` instance.
*digest* is a ``str`` naming a supported message digest type, for example
:py:const:`sha1`.
.. versionadded:: 0.11
.. py:function:: verify(certificate, signature, data, digest)
Verify the signature for a data string.
*certificate* is a :py:class:`X509` instance corresponding to the private
key which generated the signature. *signature* is a *str* instance giving
the signature itself. *data* is a *str* instance giving the data to which
the signature applies. *digest* is a *str* instance naming the message
digest type of the signature, for example :py:const:`sha1`.
.. versionadded:: 0.11
.. _openssl-x509:
X509 objects
------------
X509 objects have the following methods:
.. py:method:: X509.get_issuer()
Return an X509Name object representing the issuer of the certificate.
.. py:method:: X509.get_pubkey()
Return a :py:class:`PKey` object representing the public key of the certificate.
.. py:method:: X509.get_serial_number()
Return the certificate serial number.
.. py:method:: X509.get_signature_algorithm()
Return the signature algorithm used in the certificate. If the algorithm is
undefined, raise :py:data:`ValueError`.
.. versionadded:: 0.13
.. py:method:: X509.get_subject()
Return an :py:class:`X509Name` object representing the subject of the certificate.
.. py:method:: X509.get_version()
Return the certificate version.
.. py:method:: X509.get_notBefore()
Return a string giving the time before which the certificate is not valid. The
string is formatted as an ASN1 GENERALIZEDTIME::
YYYYMMDDhhmmssZ
YYYYMMDDhhmmss+hhmm
YYYYMMDDhhmmss-hhmm
If no value exists for this field, :py:data:`None` is returned.
.. py:method:: X509.get_notAfter()
Return a string giving the time after which the certificate is not valid. The
string is formatted as an ASN1 GENERALIZEDTIME::
YYYYMMDDhhmmssZ
YYYYMMDDhhmmss+hhmm
YYYYMMDDhhmmss-hhmm
If no value exists for this field, :py:data:`None` is returned.
.. py:method:: X509.set_notBefore(when)
Change the time before which the certificate is not valid. *when* is a
string formatted as an ASN1 GENERALIZEDTIME::
YYYYMMDDhhmmssZ
YYYYMMDDhhmmss+hhmm
YYYYMMDDhhmmss-hhmm
.. py:method:: X509.set_notAfter(when)
Change the time after which the certificate is not valid. *when* is a
string formatted as an ASN1 GENERALIZEDTIME::
YYYYMMDDhhmmssZ
YYYYMMDDhhmmss+hhmm
YYYYMMDDhhmmss-hhmm
.. py:method:: X509.gmtime_adj_notBefore(time)
Adjust the timestamp (in GMT) when the certificate starts being valid.
.. py:method:: X509.gmtime_adj_notAfter(time)
Adjust the timestamp (in GMT) when the certificate stops being valid.
.. py:method:: X509.has_expired()
Checks the certificate's time stamp against current time. Returns true if the
certificate has expired and false otherwise.
.. py:method:: X509.set_issuer(issuer)
Set the issuer of the certificate to *issuer*.
.. py:method:: X509.set_pubkey(pkey)
Set the public key of the certificate to *pkey*.
.. py:method:: X509.set_serial_number(serialno)
Set the serial number of the certificate to *serialno*.
.. py:method:: X509.set_subject(subject)
Set the subject of the certificate to *subject*.
.. py:method:: X509.set_version(version)
Set the certificate version to *version*.
.. py:method:: X509.sign(pkey, digest)
Sign the certificate, using the key *pkey* and the message digest algorithm
identified by the string *digest*.
.. py:method:: X509.subject_name_hash()
Return the hash of the certificate subject.
.. py:method:: X509.digest(digest_name)
Return a digest of the certificate, using the *digest_name* method.
*digest_name* must be a string describing a digest algorithm supported
by OpenSSL (by EVP_get_digestbyname, specifically). For example,
:py:const:`"md5"` or :py:const:`"sha1"`.
.. py:method:: X509.add_extensions(extensions)
Add the extensions in the sequence *extensions* to the certificate.
.. py:method:: X509.get_extension_count()
Return the number of extensions on this certificate.
.. versionadded:: 0.12
.. py:method:: X509.get_extension(index)
Retrieve the extension on this certificate at the given index.
Extensions on a certificate are kept in order. The index parameter selects
which extension will be returned. The returned object will be an
:py:class:`X509Extension` instance.
.. versionadded:: 0.12
.. _openssl-x509name:
X509Name objects
----------------
X509Name objects have the following methods:
.. py:method:: X509Name.hash()
Return an integer giving the first four bytes of the MD5 digest of the DER
representation of the name.
.. py:method:: X509Name.der()
Return a string giving the DER representation of the name.
.. py:method:: X509Name.get_components()
Return a list of two-tuples of strings giving the components of the name.
X509Name objects have the following members:
.. py:attribute:: X509Name.countryName
The country of the entity. :py:attr:`C` may be used as an alias for
:py:attr:`countryName`.
.. py:attribute:: X509Name.stateOrProvinceName
The state or province of the entity. :py:attr:`ST` may be used as an alias for
:py:attr:`stateOrProvinceName`.
.. py:attribute:: X509Name.localityName
The locality of the entity. :py:attr:`L` may be used as an alias for
:py:attr:`localityName`.
.. py:attribute:: X509Name.organizationName
The organization name of the entity. :py:attr:`O` may be used as an alias for
:py:attr:`organizationName`.
.. py:attribute:: X509Name.organizationalUnitName
The organizational unit of the entity. :py:attr:`OU` may be used as an alias for
:py:attr:`organizationalUnitName`.
.. py:attribute:: X509Name.commonName
The common name of the entity. :py:attr:`CN` may be used as an alias for
:py:attr:`commonName`.
.. py:attribute:: X509Name.emailAddress
The e-mail address of the entity.
.. _openssl-x509req:
X509Req objects
---------------
X509Req objects have the following methods:
.. py:method:: X509Req.get_pubkey()
Return a :py:class:`PKey` object representing the public key of the certificate request.
.. py:method:: X509Req.get_subject()
Return an :py:class:`X509Name` object representing the subject of the certificate.
.. py:method:: X509Req.set_pubkey(pkey)
Set the public key of the certificate request to *pkey*.
.. py:method:: X509Req.sign(pkey, digest)
Sign the certificate request, using the key *pkey* and the message digest
algorithm identified by the string *digest*.
.. py:method:: X509Req.verify(pkey)
Verify a certificate request using the public key *pkey*.
.. py:method:: X509Req.set_version(version)
Set the version (RFC 2459, 4.1.2.1) of the certificate request to
*version*.
.. py:method:: X509Req.get_version()
Get the version (RFC 2459, 4.1.2.1) of the certificate request.
.. py:method:: X509Req.get_extensions()
Get extensions to the request.
.. versionadded:: 0.15
.. _openssl-x509store:
X509Store objects
-----------------
The X509Store object has currently just one method:
.. py:method:: X509Store.add_cert(cert)
Add the certificate *cert* to the certificate store.
X509StoreContextError objects
-----------------------------
The X509StoreContextError is an exception raised from
`X509StoreContext.verify_certificate` in circumstances where a certificate
cannot be verified in a provided context.
The certificate for which the verification error was detected is given by the
``certificate`` attribute of the exception instance as a :class:`X509`
instance.
Details about the verification error are given in the exception's ``args`` attribute.
X509StoreContext objects
------------------------
The X509StoreContext object is used for verifying a certificate against a set
of trusted certificates.
.. py:method:: X509StoreContext.verify_certificate()
Verify a certificate in the context of this initialized `X509StoreContext`.
On error, raises `X509StoreContextError`, otherwise does nothing.
.. versionadded:: 0.15
.. _openssl-pkey:
PKey objects
------------
The PKey object has the following methods:
.. py:method:: PKey.bits()
Return the number of bits of the key.
.. py:method:: PKey.generate_key(type, bits)
Generate a public/private key pair of the type *type* (one of
:py:const:`TYPE_RSA` and :py:const:`TYPE_DSA`) with the size *bits*.
.. py:method:: PKey.type()
Return the type of the key.
.. py:method:: PKey.check()
Check the consistency of this key, returning True if it is consistent and
raising an exception otherwise. This is only valid for RSA keys. See the
OpenSSL RSA_check_key man page for further limitations.
.. _openssl-pkcs7:
PKCS7 objects
-------------
PKCS7 objects have the following methods:
.. py:method:: PKCS7.type_is_signed()
FIXME
.. py:method:: PKCS7.type_is_enveloped()
FIXME
.. py:method:: PKCS7.type_is_signedAndEnveloped()
FIXME
.. py:method:: PKCS7.type_is_data()
FIXME
.. py:method:: PKCS7.get_type_name()
Get the type name of the PKCS7.
.. _openssl-pkcs12:
PKCS12 objects
--------------
PKCS12 objects have the following methods:
.. py:method:: PKCS12.export([passphrase=None][, iter=2048][, maciter=1])
Returns a PKCS12 object as a string.
The optional *passphrase* must be a string not a callback.
See also the man page for the C function :py:func:`PKCS12_create`.
.. py:method:: PKCS12.get_ca_certificates()
Return CA certificates within the PKCS12 object as a tuple. Returns
:py:const:`None` if no CA certificates are present.
.. py:method:: PKCS12.get_certificate()
Return certificate portion of the PKCS12 structure.
.. py:method:: PKCS12.get_friendlyname()
Return friendlyName portion of the PKCS12 structure.
.. py:method:: PKCS12.get_privatekey()
Return private key portion of the PKCS12 structure
.. py:method:: PKCS12.set_ca_certificates(cacerts)
Replace or set the CA certificates within the PKCS12 object with the sequence *cacerts*.
Set *cacerts* to :py:const:`None` to remove all CA certificates.
.. py:method:: PKCS12.set_certificate(cert)
Replace or set the certificate portion of the PKCS12 structure.
.. py:method:: PKCS12.set_friendlyname(name)
Replace or set the friendlyName portion of the PKCS12 structure.
.. py:method:: PKCS12.set_privatekey(pkey)
Replace or set private key portion of the PKCS12 structure
.. _openssl-509ext:
X509Extension objects
---------------------
X509Extension objects have several methods:
.. py:method:: X509Extension.get_critical()
Return the critical field of the extension object.
.. py:method:: X509Extension.get_short_name()
Retrieve the short descriptive name for this extension.
The result is a byte string like :py:const:`basicConstraints`.
.. versionadded:: 0.12
.. py:method:: X509Extension.get_data()
Retrieve the data for this extension.
The result is the ASN.1 encoded form of the extension data as a byte string.
.. versionadded:: 0.12
.. _openssl-netscape-spki:
NetscapeSPKI objects
--------------------
NetscapeSPKI objects have the following methods:
.. py:method:: NetscapeSPKI.b64_encode()
Return a base64-encoded string representation of the object.
.. py:method:: NetscapeSPKI.get_pubkey()
Return the public key of object.
.. py:method:: NetscapeSPKI.set_pubkey(key)
Set the public key of the object to *key*.
.. py:method:: NetscapeSPKI.sign(key, digest_name)
Sign the NetscapeSPKI object using the given *key* and *digest_name*.
*digest_name* must be a string describing a digest algorithm supported by
OpenSSL (by EVP_get_digestbyname, specifically). For example,
:py:const:`"md5"` or :py:const:`"sha1"`.
.. py:method:: NetscapeSPKI.verify(key)
Verify the NetscapeSPKI object using the given *key*.
.. _crl:
CRL objects
-----------
CRL objects have the following methods:
.. py:method:: CRL.add_revoked(revoked)
Add a Revoked object to the CRL, by value not reference.
.. py:method:: CRL.export(cert, key[, type=FILETYPE_PEM][, days=100][, digest=b'md5'])
Use *cert* and *key* to sign the CRL and return the CRL as a string.
*days* is the number of days before the next CRL is due.
*digest* is the algorithm that will be used to sign CRL.
.. py:method:: CRL.get_revoked()
Return a tuple of Revoked objects, by value not reference.
.. _revoked:
Revoked objects
---------------
Revoked objects have the following methods:
.. py:method:: Revoked.all_reasons()
Return a list of all supported reasons.
.. py:method:: Revoked.get_reason()
Return the revocation reason as a str. Can be
None, which differs from "Unspecified".
.. py:method:: Revoked.get_rev_date()
Return the revocation date as a str.
The string is formatted as an ASN1 GENERALIZEDTIME.
.. py:method:: Revoked.get_serial()
Return a str containing a hex number of the serial of the revoked certificate.
.. py:method:: Revoked.set_reason(reason)
Set the revocation reason. *reason* must be None or a string, but the
values are limited. Spaces and case are ignored. See
:py:meth:`all_reasons`.
.. py:method:: Revoked.set_rev_date(date)
Set the revocation date.
The string is formatted as an ASN1 GENERALIZEDTIME.
.. py:method:: Revoked.set_serial(serial)
*serial* is a string containing a hex number of the serial of the revoked certificate.
|