From 8d4f97693260279e0411b73f3186976178058b73 Mon Sep 17 00:00:00 2001 From: Hynek Schlawack Date: Sat, 19 Mar 2016 08:15:03 +0100 Subject: Fix some links and markup --- doc/api/crypto.rst | 66 +++++++++++++++++++++++++----------------------------- 1 file changed, 31 insertions(+), 35 deletions(-) (limited to 'doc') diff --git a/doc/api/crypto.rst b/doc/api/crypto.rst index 27da7e8..ae8a64a 100644 --- a/doc/api/crypto.rst +++ b/doc/api/crypto.rst @@ -297,49 +297,45 @@ Exceptions Generic exception used in the :py:mod:`.crypto` module. + Digest names ------------ -Several of the functions and methods in this module take a digest -name. These must be strings describing a digest algorithm supported by -OpenSSL (by ``EVP_get_digestbyname``, specifically). For example, -:py:const:`b"md5"` or :py:const:`b"sha1"`. +Several of the functions and methods in this module take a digest name. +These must be strings describing a digest algorithm supported by OpenSSL (by ``EVP_get_digestbyname``, specifically). +For example, :const:`b"md5"` or :const:`b"sha1"`. + +More information and a list of these digest names can be found in the ``EVP_DigestInit(3)`` man page of your OpenSSL installation. +This page can be found online for the latest version of OpenSSL: +https://www.openssl.org/docs/manmaster/crypto/EVP_DigestInit.html -More information and a list of these digest names can be found in the -``EVP_DigestInit(3)`` man page of your OpenSSL installation. This page -can be found online for the latest version of OpenSSL: -https://www.openssl.org/docs/crypto/EVP_DigestInit.html Backwards compatible type names ------------------------------- -When PyOpenSSL was originally written, the most current version of -Python was 2.1. It made a distinction between classes and types. None -of the versions of Python currently supported by PyOpenSSL still -enforce that distinction: the type of an instance of an -:py:class:`X509` object is now simply :py:class:`X509`. Originally, -the type would have been :py:class:`X509Type`. These days, -:py:class:`X509Type` and :py:class:`X509` are literally the same -object. PyOpenSSL maintains these old names for backwards -compatibility. +When PyOpenSSL was originally written, the most current version of Python was 2.1. +It made a distinction between classes and types. +None of the versions of Python currently supported by pyOpenSSL still enforce that distinction: +the type of an instance of an :class:`X509` object is now simply :class:`X509`. +Originally, the type would have been :class:`X509Type`. +These days, :class:`X509Type` and :class:`X509` are literally the same object. +pyOpenSSL maintains these old names for backwards compatibility. Here's a table of these backwards-compatible names: -========================= ============================= -Type name Backwards-compatible name -========================= ============================= -:py:class:`X509` :py:class:`X509Type` -:py:class:`X509Name` :py:class:`X509NameType` -:py:class:`X509Req` :py:class:`X509ReqType` -:py:class:`X509Store` :py:class:`X509StoreType` -:py:class:`X509Extension` :py:class:`X509ExtensionType` -:py:class:`PKey` :py:class:`PKeyType` -:py:class:`PKCS7` :py:class:`PKCS7Type` -:py:class:`PKCS12` :py:class:`PKCS12Type` -:py:class:`NetscapeSPKI` :py:class:`NetscapeSPKIType` -:py:class:`CRL` :py:class:`CRLType` -========================= ============================= - -Some objects, such as :py:class`Revoked`, don't have ``Type`` -equivalents, because they were added after the restriction had been -lifted. +====================== ========================== +Type name Backwards-compatible name +====================== ========================== +:class:`X509` :class:`X509Type` +:class:`X509Name` :class:`X509NameType` +:class:`X509Req` :class:`X509ReqType` +:class:`X509Store` :class:`X509StoreType` +:class:`X509Extension` :class:`X509ExtensionType` +:class:`PKey` :class:`PKeyType` +:class:`PKCS7` :class:`PKCS7Type` +:class:`PKCS12` :class:`PKCS12Type` +:class:`NetscapeSPKI` :class:`NetscapeSPKIType` +:class:`CRL` :class:`CRLType` +====================== ========================== + +Some objects, such as :class:`Revoked`, don't have ``Type`` equivalents, because they were added after the restriction had been lifted. -- cgit v1.2.1