ssl
¶
The ssl
module provides SSL contexts to wrap sockets in.
This module implements a subset of the corresponding CPython module,
as described below. For more information, refer to the original
CPython documentation: ssl
.
Available on these boards
- ssl.create_default_context() SSLContext ¶
Return the default SSLContext.
- class ssl.SSLContext¶
Settings related to SSL that can be applied to a socket by wrapping it. This is useful to provide SSL certificates to specific connections rather than all of them.
- check_hostname :bool¶
Whether to match the peer certificate’s hostname.
- load_verify_locations(cadata: Optional[str] = None) None ¶
Load a set of certification authority (CA) certificates used to validate other peers’ certificates.
- wrap_socket(sock: socketpool.Socket, *, server_side: bool = False, server_hostname: Optional[str] = None) SSLSocket ¶
Wraps the socket into a socket-compatible class that handles SSL negotiation. The socket must be of type SOCK_STREAM.
- class ssl.SSLSocket¶
Implements TLS security on a subset of
socketpool.Socket
functions. Cannot be created directly. Instead, callwrap_socket
on an existing socket object.Provides a subset of CPython’s
ssl.SSLSocket
API. It only implements the versions of recv that do not allocate bytes objects.- __exit__() None ¶
Automatically closes the Socket when exiting a context. See Lifetime and ContextManagers for more info.
- accept() Tuple[SSLSocket, Tuple[str, int]] ¶
Accept a connection on a listening socket of type SOCK_STREAM, creating a new socket of type SOCK_STREAM. Returns a tuple of (new_socket, remote_address)
- bind(address: Tuple[str, int]) None ¶
Bind a socket to an address
- Parameters
address (~tuple) – tuple of (remote_address, remote_port)
- connect(address: Tuple[str, int]) None ¶
Connect a socket to a remote address
- Parameters
address (~tuple) – tuple of (remote_address, remote_port)
- listen(backlog: int) None ¶
Set socket to listen for incoming connections
- Parameters
backlog (~int) – length of backlog queue for waiting connetions
- recv_into(buffer: circuitpython_typing.WriteableBuffer, bufsize: int) int ¶
Reads some bytes from the connected remote address, writing into the provided buffer. If bufsize <= len(buffer) is given, a maximum of bufsize bytes will be read into the buffer. If no valid value is given for bufsize, the default is the length of the given buffer.
Suits sockets of type SOCK_STREAM Returns an int of number of bytes read.
- send(bytes: circuitpython_typing.ReadableBuffer) int ¶
Send some bytes to the connected remote address. Suits sockets of type SOCK_STREAM
- Parameters
bytes (~bytes) – some bytes to send