pip._vendor.urllib3.util.ssltransport.SSLTransport Class Reference

Public Member Functions
	__init__ (self, socket, ssl_context, server_hostname=None, suppress_ragged_eofs=True)
	__enter__ (self)
	__exit__ (self, *_)
	fileno (self)
	read (self, len=1024, buffer=None)
	recv (self, len=1024, flags=0)
	recv_into (self, buffer, nbytes=None, flags=0)
	sendall (self, data, flags=0)
	send (self, data, flags=0)
	makefile (self, mode="r", buffering=None, encoding=None, errors=None, newline=None)
	unwrap (self)
	close (self)
	getpeercert (self, binary_form=False)
	version (self)
	cipher (self)
	selected_alpn_protocol (self)
	selected_npn_protocol (self)
	shared_ciphers (self)
	compression (self)
	settimeout (self, value)
	gettimeout (self)

Public Attributes
	incoming
	outgoing
	suppress_ragged_eofs
	socket
	sslobj

Protected Member Functions
	_decref_socketios (self)
	_wrap_ssl_read (self, len, buffer=None)
	_ssl_io_loop (self, func, *args)

Static Protected Member Functions
	_validate_ssl_context_for_tls_in_tls (ssl_context)

Detailed Description

The SSLTransport wraps an existing socket and establishes an SSL connection.

Contrary to Python's implementation of SSLSocket, it allows you to chain
multiple TLS connections together. It's particularly useful if you need to
implement TLS within TLS.

The class supports most of the socket API operations.

Constructor & Destructor Documentation

__init__()

pip._vendor.urllib3.util.ssltransport.SSLTransport.__init__	(		self,
			socket,
			ssl_context,
			server_hostname = None,
			suppress_ragged_eofs = True
	)

Create an SSLTransport around socket using the provided ssl_context.

Member Function Documentation

_ssl_io_loop()

pip._vendor.urllib3.util.ssltransport.SSLTransport._ssl_io_loop (   self,   func, *  args  )

protected

Performs an I/O loop between incoming/outgoing and the socket.

_validate_ssl_context_for_tls_in_tls()

pip._vendor.urllib3.util.ssltransport.SSLTransport._validate_ssl_context_for_tls_in_tls (   ssl_context )

staticprotected

Raises a ProxySchemeUnsupported if the provided ssl_context can't be used
for TLS in TLS.

The only requirement is that the ssl_context provides the 'wrap_bio'
methods.

makefile()

pip._vendor.urllib3.util.ssltransport.SSLTransport.makefile	(		self,
			mode = "r",
			buffering = None,
			encoding = None,
			errors = None,
			newline = None
	)

Python's httpclient uses makefile and buffered io when reading HTTP
messages and we need to support it.

This is unfortunately a copy and paste of socket.py makefile with small
changes to point to the socket directly.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/urllib3/util/ssltransport.py