Classe « SSLObject »

Informations générales

Héritage

builtins.object
    SSLObject

Définition

class SSLObject(builtins.object):

help(SSLObject)

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 does not have a public constructor. Instances are returned by
``SSLContext.wrap_bio``. This class is typically used by framework authors
that want to implement asynchronous IO for SSL through memory buffers.

When compared to ``SSLSocket``, this object lacks the following features:

 * Any form of network IO, including methods such as ``recv`` and ``send``.
 * The ``do_handshake_on_connect`` and ``suppress_ragged_eofs`` machinery.

Constructeur(s)

Signature du constructeur	Description
__init__(self, args, *kwargs)

Liste des propriétés

Nom de la propriété	Description
context	The SSLContext that is currently in use. _{[extrait de context.__doc__]}
server_hostname	The currently set server hostname (for SNI), or ``None`` if no _{[extrait de server_hostname.__doc__]}
server_side	Whether this is a server-side socket. _{[extrait de server_side.__doc__]}
session	The SSLSession for client socket. _{[extrait de session.__doc__]}
session_reused	Was the client session reused during handshake _{[extrait de session_reused.__doc__]}

Liste des opérateurs

Opérateurs hérités de la classe object

__eq__, __ge__, __gt__, __le__, __lt__, __ne__

Liste des méthodes

Toutes les méthodes Méthodes d'instance Méthodes statiques

Signature de la méthode	Description
cipher(self)	Return the currently selected cipher as a 3-tuple ``(name, _{[extrait de cipher.__doc__]}
compression(self)	Return the current compression algorithm in use, or ``None`` if _{[extrait de compression.__doc__]}
do_handshake(self)	Start the SSL/TLS handshake. _{[extrait de do_handshake.__doc__]}
get_channel_binding(self, cb_type='tls-unique')	Get channel binding data for current connection. Raise ValueError _{[extrait de get_channel_binding.__doc__]}
get_unverified_chain(self)	Returns raw certificate chain provided by the other _{[extrait de get_unverified_chain.__doc__]}
get_verified_chain(self)	Returns verified certificate chain provided by the other _{[extrait de get_verified_chain.__doc__]}
getpeercert(self, binary_form=False)	Returns a formatted version of the data in the certificate provided _{[extrait de getpeercert.__doc__]}
pending(self)	Return the number of bytes that can be read immediately. _{[extrait de pending.__doc__]}
read(self, len=1024, buffer=None)	Read up to 'len' bytes from the SSL object and return them. _{[extrait de read.__doc__]}
selected_alpn_protocol(self)	Return the currently selected ALPN protocol as a string, or ``None`` _{[extrait de selected_alpn_protocol.__doc__]}
selected_npn_protocol(self)	Return the currently selected NPN protocol as a string, or ``None`` _{[extrait de selected_npn_protocol.__doc__]}
shared_ciphers(self)	Return a list of ciphers shared by the client during the handshake or _{[extrait de shared_ciphers.__doc__]}
unwrap(self)	Start the SSL shutdown handshake. _{[extrait de unwrap.__doc__]}
verify_client_post_handshake(self)
version(self)	Return a string identifying the protocol version used by the _{[extrait de version.__doc__]}
write(self, data)	Write 'data' to the SSL object and return the number of bytes _{[extrait de write.__doc__]}