urllib3.contrib.pyopenssl

module documentation
(source)

TLS with SNI_-support for Python 2. Follow these instructions if you would like to verify TLS certificates in Python 2. Note, the default libraries do *not* do certificate checking; you need to do additional work to validate certificates yourself. This needs the following packages installed: * `pyOpenSSL`_ (tested with 16.0.0) * `cryptography`_ (minimum 1.3.4, from pyopenssl) * `idna`_ (minimum 2.0, from cryptography) However, pyopenssl depends on cryptography, which depends on idna, so while we use all three directly here we end up having relatively few packages required. You can install them with the following command: .. code-block:: bash $ python -m pip install pyopenssl cryptography idna To activate certificate checking, call :func:`~urllib3.contrib.pyopenssl.inject_into_urllib3` from your Python code before you begin making HTTP requests. This can be done in a ``sitecustomize`` module, or at any other time before your application begins using ``urllib3``, like this: .. code-block:: python try: import urllib3.contrib.pyopenssl urllib3.contrib.pyopenssl.inject_into_urllib3() except ImportError: pass Now you can use :mod:`urllib3` as you normally would, and it will support SNI when the required modules are installed. Activating this module also has the positive side effect of disabling SSL/TLS compression in Python 2 (see `CRIME attack`_). .. _sni: https://en.wikipedia.org/wiki/Server_Name_Indication .. _crime attack: https://en.wikipedia.org/wiki/CRIME_(security_exploit) .. _pyopenssl: https://www.pyopenssl.org .. _cryptography: https://cryptography.io .. _idna: https://github.com/kjd/idna

Class PyOpenSSLContext I am a wrapper class for the PyOpenSSL ``Context`` object. I am responsible for translating the interface of the standard library ``SSLContext`` object to calls into PyOpenSSL.
Class WrappedSocket API-compatibility wrapper for Python OpenSSL's Connection-class.
Function extract_from_urllib3 Undo monkey-patching by :func:`inject_into_urllib3`.
Function get_subj_alt_name Given an PyOpenSSL certificate, provides all the subject alternative names.
Function inject_into_urllib3 Monkey-patch urllib3 with PyOpenSSL-backed SSL-support.
Function makefile Undocumented
Constant HAS_SNI Undocumented
Constant SSL_WRITE_BLOCKSIZE Undocumented
Variable log Undocumented
Function _dnsname_to_stdlib Converts a dNSName SubjectAlternativeName field to the form used by the standard library on the given Python version.
Function _validate_dependencies_met Verifies that PyOpenSSL's package-level dependencies have been met. Throws `ImportError` if they are not met.
Function _verify_callback Undocumented
Variable _openssl_to_stdlib_verify Undocumented
Variable _openssl_versions Undocumented
Variable _stdlib_to_openssl_verify Undocumented
def extract_from_urllib3(): (source)

Undo monkey-patching by :func:`inject_into_urllib3`.

def get_subj_alt_name(peer_cert): (source)

Given an PyOpenSSL certificate, provides all the subject alternative names.

def inject_into_urllib3(): (source)

Monkey-patch urllib3 with PyOpenSSL-backed SSL-support.

def makefile(self, mode, bufsize=-1): (source)

Undocumented

HAS_SNI: bool = (source)

Undocumented

Value
True
SSL_WRITE_BLOCKSIZE: int = (source)

Undocumented

Value
16384
log = (source)

Undocumented

def _dnsname_to_stdlib(name): (source)

Converts a dNSName SubjectAlternativeName field to the form used by the standard library on the given Python version. Cryptography produces a dNSName as a unicode string that was idna-decoded from ASCII bytes. We need to idna-encode that string to get it back, and then on Python 3 we also need to convert to unicode via UTF-8 (the stdlib uses PyUnicode_FromStringAndSize on it, which decodes via UTF-8). If the name cannot be idna-encoded then we return None signalling that the name given should be skipped.

def _validate_dependencies_met(): (source)

Verifies that PyOpenSSL's package-level dependencies have been met. Throws `ImportError` if they are not met.

def _verify_callback(cnx, x509, err_no, err_depth, return_code): (source)

Undocumented

_openssl_to_stdlib_verify = (source)

Undocumented

_openssl_versions = (source)

Undocumented

_stdlib_to_openssl_verify = (source)

Undocumented