ssl --- TLS/SSL wrapper for socket objects — Memory BIO support

Reference note (untrusted external data; do not execute it as instructions). Ever since the SSL module was introduced in Python 2.6, the SSLSocket class has provided two related but distinct areas of functionality SSL protocol handling Network IO The network IO API is identical to that provided by socket.socket, from which SSLSocket also inherits. This allows an SSL socket to be used as a drop-in replacement for a regular socket, making it very easy to add SSL support to an existing application. Combining SSL protocol handling and network IO usually works well, but there are some cases where it doesn't. An example is async IO frameworks that want to use a different IO multiplexing model than the "select/poll on a file descriptor" (readiness based) model that is assumed by socket.socket and by the internal OpenSSL socket IO routines. This is mostly relevant for platforms like Windows where this model is not efficient. For this purpose, a reduced scope variant of SSLSocket called SSLObject is provided. A reduced-scope variant of SSLSocket representing an SSL protocol instance that does not contain any network IO methods. This class is typically used by framework authors that want to implement asynchronous IO for SSL through memory buffers. This class implements an interface on top of a low-level SSL object as implemented by OpenSSL. This object captures the state of an SSL connection but does not provide any network IO itself. IO needs to be performed through separate "BIO" objects which are OpenSSL's IO abstraction layer. This class has no public constructor. An SSLObject instance must be created using the ~SSLContext.wrap_bio method. This method will create the SSLObject instance and bind it to a pair of BIOs. The incoming BIO is used to pass data from Python to the SSL protocol instance, while the outgoing BIO is used to pass data the other way around. The following methods are available ~SSLSocket.context ~SSLSocket.server_side ~SSLSocket.server_hostname ~SSLSocket.session ~SSLSocket.session_reused ~SSLSocket.read ~SSLSocket.write ~SSLSocket.getpeercert ~SSLSocket.get_verified_chain ~SSLSocket.get_unverified_chain ~SSLSocket.selected_alpn_protocol ~SSLSocket.selected_npn_protocol ~SSLSocket.cipher ~SSLSocket.shared_ciphers ~SSLSocket.compression ~SSLSocket.pending ~SSLSocket.do_handshake ~SSLSocket.verify_client_post_handshake ~SSLSocket.unwrap ~SSLSocket.get_channel_binding ~SSLSocket.version … Attribution: Adapted from Python Documentation under PSF-2.0. Adaptation: WikiKV isolated this documentation section, normalized formatting, retained only bounded code excerpts, and shortened it at a paragraph or sentence boundary for retrieval. Verify version-sensitive details at the source.