twisted.protocols.tls.TLSMemoryBIOProtocol : API documentation

TLSMemoryBIOProtocol is a protocol wrapper which uses OpenSSL via a memory BIO to encrypt bytes written to it before sending them on to the underlying transport and decrypts bytes received from the underlying transport before delivering them to the wrapped protocol.

In addition to producer events from the underlying transport, the need to wait for reads before a write can proceed means the TLSMemoryBIOProtocol may also want to pause a producer. Pause/resume events are therefore merged using the _ProducerMembrane wrapper. Non-streaming (pull) producers are supported by wrapping them with _PullToPush.

Instance Variables	_tlsConnection	The `OpenSSL.SSL.Connection` instance which is encrypted and decrypting this connection.
	_lostTLSConnection	A flag indicating whether connection loss has already been dealt with (`True`) or not (`False`). TLS disconnection is distinct from the underlying connection being lost.
	_writeBlockedOnRead	A flag indicating whether further writing must wait for data to be received (`True`) or not (`False`).
	_appSendBuffer	A `list` of `str` of application-level (cleartext) data which is waiting for `_writeBlockedOnRead` to be reset to `False` so it can be passed to and perhaps accepted by `_tlsConnection.send`.
	_connectWrapped	A flag indicating whether or not to call `makeConnection` on the wrapped protocol. This is for the reactor's `twisted.internet.interfaces.ITLSTransport.startTLS` implementation, since it has a protocol which it has already called `makeConnection` on, and which has no interest in a new transport. See #3821.
	_handshakeDone	A flag indicating whether or not the handshake is known to have completed successfully (`True`) or not (`False`). This is used to control error reporting behavior. If the handshake has not completed, the underlying `OpenSSL.SSL.Error` will be passed to the application's `connectionLost` method. If it has completed, any unexpected `OpenSSL.SSL.Error` will be turned into a `ConnectionLost`. This is weird; however, it is simply an attempt at a faithful re-implementation of the behavior provided by `twisted.internet.ssl`.
	_reason	If an unexpected `OpenSSL.SSL.Error` occurs which causes the connection to be lost, it is saved here. If appropriate, this may be used as the reason passed to the application protocol's `connectionLost` method.
	_producer	The current producer registered via `registerProducer`, or `None` if no producer has been registered or a previous one was unregistered.

Method	__init__	Undocumented
Method	getHandle	Return the `OpenSSL.SSL.Connection` object being used to encrypt and decrypt this connection.
Method	makeConnection	Connect this wrapper to the given transport and initialize the necessary `OpenSSL.SSL.Connection` with a memory BIO.
Method	dataReceived	Deliver any received bytes to the receive BIO and then read and deliver to the application any application-level data which becomes available as a result of this.
Method	connectionLost	Handle the possible repetition of calls to this method (due to either the underlying transport going away or due to an error at the TLS layer) and make sure the base implementation only gets invoked once.
Method	loseConnection	Send a TLS close alert and close the underlying connection.
Method	write	Process the given application bytes and send any resulting TLS traffic which arrives in the send BIO.
Method	writeSequence	Write a sequence of application bytes by joining them into one string and passing them to `write`.
Method	getPeerCertificate	Return an object with the peer's certificate info.
Method	registerProducer	Undocumented
Method	unregisterProducer	Undocumented
Method	_flushSendBIO	Read any bytes out of the send BIO and write them to the underlying transport.
Method	_flushReceiveBIO	No summary
Method	_shutdownTLS	Initiate, or reply to, the shutdown handshake of the TLS layer.
Method	_tlsShutdownFinished	Called when TLS connection has gone away; tell underlying transport to disconnect.
Method	_write	Process the given application bytes and send any resulting TLS traffic which arrives in the send BIO.

Inherited from ProtocolWrapper:

Method	logPrefix	Use a customized log prefix mentioning both the wrapped protocol and the current one.
Method	getPeer	Undocumented
Method	getHost	Undocumented
Method	stopConsuming	Undocumented
Method	__getattr__	Undocumented

Inherited from BaseProtocol (via ProtocolWrapper, Protocol):

Method

connectionMade

Called when a connection is made.

Return the OpenSSL.SSL.Connection object being used to encrypt and decrypt this connection.

This is done for the benefit of twisted.internet.ssl.Certificate's peerFromTransport and hostFromTransport methods only. A different system handle may be returned by future versions of this method.

Connect this wrapper to the given transport and initialize the necessary OpenSSL.SSL.Connection with a memory BIO.

Read any bytes out of the send BIO and write them to the underlying transport.

Try to receive any application-level bytes which are now available because of a previous write into the receive BIO. This will take care of delivering any application-level bytes which are received to the protocol, as well as handling of the various exceptions which can come from trying to get such bytes.

Deliver any received bytes to the receive BIO and then read and deliver to the application any application-level data which becomes available as a result of this.

Initiate, or reply to, the shutdown handshake of the TLS layer.

Called when TLS connection has gone away; tell underlying transport to disconnect.

Handle the possible repetition of calls to this method (due to either the underlying transport going away or due to an error at the TLS layer) and make sure the base implementation only gets invoked once.

Send a TLS close alert and close the underlying connection.

Process the given application bytes and send any resulting TLS traffic which arrives in the send BIO.

If loseConnection was called, subsequent calls to write will drop the bytes on the floor.

Process the given application bytes and send any resulting TLS traffic which arrives in the send BIO.

This may be called by dataReceived with bytes that were buffered before loseConnection was called, which is why this function doesn't check for disconnection but accepts the bytes regardless.

Write a sequence of application bytes by joining them into one string and passing them to write.

Return an object with the peer's certificate info.

t.p.t.TLSMemoryBIOProtocol(ProtocolWrapper) : class documentation