TLSSocket is a wrapper around Socket for interacting with TLS servers. More...
#include <TLSSocketWrapper.h>
Public Types |
Public Member Functions | |
TLSSocketWrapper (Socket *transport, const char *hostname=NULL, control_transport control=TRANSPORT_CONNECT_AND_CLOSE) | |
Create a TLSSocketWrapper. More... | |
virtual | ~TLSSocketWrapper () |
Destroy a socket wrapper. More... | |
void | set_hostname (const char *hostname) |
Set hostname. More... | |
nsapi_error_t | set_root_ca_cert (const void *root_ca, size_t len) |
Sets the certification of Root CA. More... | |
nsapi_error_t | set_root_ca_cert (const char *root_ca_pem) |
Sets the certification of Root CA. More... | |
nsapi_error_t | set_client_cert_key (const void *client_cert, size_t client_cert_len, const void *client_private_key_pem, size_t client_private_key_len) |
Sets client certificate, and client private key. More... | |
nsapi_error_t | set_client_cert_key (const char *client_cert_pem, const char *client_private_key_pem) |
Sets client certificate, and client private key. More... | |
virtual nsapi_error_t | send (const void *data, nsapi_size_t size) |
Send data over a TLS socket. More... | |
virtual nsapi_size_or_error_t | recv (void *data, nsapi_size_t size) |
Receive data over a TLS socket. More... | |
virtual nsapi_error_t | close () |
Closes the socket. More... | |
virtual nsapi_error_t | connect (const SocketAddress &address=SocketAddress()) |
Connects socket to a remote address. More... | |
virtual nsapi_size_or_error_t | sendto (const SocketAddress &address, const void *data, nsapi_size_t size) |
Send a message on a socket. More... | |
virtual nsapi_size_or_error_t | recvfrom (SocketAddress *address, void *data, nsapi_size_t size) |
Receive a data from a socket. More... | |
virtual nsapi_error_t | bind (const SocketAddress &address) |
Bind a specific address to a socket. More... | |
virtual void | set_blocking (bool blocking) |
Set blocking or non-blocking mode of the socket. More... | |
virtual void | set_timeout (int timeout) |
Set timeout on blocking socket operations. More... | |
virtual void | sigio (mbed::Callback< void()> func) |
Register a callback on state change of the socket. More... | |
virtual nsapi_error_t | setsockopt (int level, int optname, const void *optval, unsigned optlen) |
Set socket options. More... | |
virtual nsapi_error_t | getsockopt (int level, int optname, void *optval, unsigned *optlen) |
Get socket options. More... | |
virtual Socket * | accept (nsapi_error_t *error=NULL) |
Accepts a connection on a socket. More... | |
virtual nsapi_error_t | listen (int backlog=1) |
Listen for incoming connections. More... | |
virtual nsapi_error_t | getpeername (SocketAddress *address) |
Get the remote-end peer associated with this socket. More... | |
mbedtls_x509_crt * | get_own_cert () |
Get own certificate directly from Mbed TLS. More... | |
int | set_own_cert (mbedtls_x509_crt *crt) |
Set own certificate directly to Mbed TLS. More... | |
mbedtls_x509_crt * | get_ca_chain () |
Get CA chain structure. More... | |
void | set_ca_chain (mbedtls_x509_crt *crt) |
Set CA chain directly to Mbed TLS. More... | |
mbedtls_ssl_config * | get_ssl_config () |
Get internal Mbed TLS configuration structure. More... | |
void | set_ssl_config (mbedtls_ssl_config *conf) |
Override Mbed TLS configuration. More... | |
mbedtls_ssl_context * | get_ssl_context () |
Get internal Mbed TLS context structure. More... | |
TLSSocket is a wrapper around Socket for interacting with TLS servers.
TLSSocketWrapper can use any Socket as a transport. After completing the TLS handshake, it can be used as any Socket would be used.
Definition at line 44 of file TLSSocketWrapper.h.
enum control_transport |
Transport modes.
Enumerator | |
---|---|
TRANSPORT_KEEP | |
TRANSPORT_CONNECT_AND_CLOSE | |
TRANSPORT_CONNECT |
Does call only connect() on transport socket. |
TRANSPORT_CLOSE |
Does call close() on transport socket. |
Definition at line 47 of file TLSSocketWrapper.h.
TLSSocketWrapper | ( | Socket * | transport, |
const char * | hostname = NULL , |
||
control_transport | control = TRANSPORT_CONNECT_AND_CLOSE |
||
) |
Create a TLSSocketWrapper.
transport | Underlying transport socket to wrap. |
hostname | Hostname of the remote host, used for certificate checking. |
control | Transport control mode. See control_transport. |
|
virtual |
Destroy a socket wrapper.
Closes socket wrapper if the socket wrapper is still open.
|
virtual |
Accepts a connection on a socket.
The server socket must be bound and set to listen for connections. On a new connection, returns connected network socket to call close() that deallocates the resources. Referencing a returned pointer after a close() call is not allowed and leads to undefined behavior.
By default, accept blocks until incoming connection occurs. If socket is set to non-blocking or times out, error is set to NSAPI_ERROR_WOULD_BLOCK.
error | Pointer to storage of the error value or NULL. |
Implements Socket.
|
virtual |
Bind a specific address to a socket.
Binding a socket specifies the address and port on which to receive data. If the IP address is zeroed, only the port is bound.
address | Local address to bind. |
Implements Socket.
|
virtual |
Closes the socket.
Closes any open connection and deallocates any memory associated with the socket. Called from destructor if socket is not closed.
Implements Socket.
|
virtual |
Connects socket to a remote address.
Attempts to make connection on connection-mode protocol or set or reset the peer address on connectionless protocol.
Connectionless protocols also use the connected address to filter incoming packets for recv() and recvfrom() calls.
To reset the peer address, there must be zero initialized(default constructor) SocketAddress objects in the address parameter.
address | The SocketAddress of the remote peer. |
Implements Socket.
mbedtls_x509_crt* get_ca_chain | ( | ) |
Get CA chain structure.
mbedtls_x509_crt* get_own_cert | ( | ) |
Get own certificate directly from Mbed TLS.
mbedtls_ssl_config* get_ssl_config | ( | ) |
Get internal Mbed TLS configuration structure.
mbedtls_ssl_context* get_ssl_context | ( | ) |
Get internal Mbed TLS context structure.
|
virtual |
Get the remote-end peer associated with this socket.
Copy the remote peer address to a SocketAddress structure pointed by address parameter. Socket must be connected to have a peer address associated.
address | Pointer to SocketAddress structure. |
Implements Socket.
|
virtual |
Get socket options.
getsockopt() allows an application to retrieve stack-specific options from the underlying stack using stack-specific level and option names, or to request generic options using levels from nsapi_socket_level_t.
For unsupported options, NSAPI_ERROR_UNSUPPORTED is returned and the socket is unmodified.
level | Stack-specific protocol level or nsapi_socket_level_t. |
optname | Level-specific option name. |
optval | Destination for option value. |
optlen | Length of the option value. |
Implements Socket.
|
virtual |
Listen for incoming connections.
Marks the socket as a passive socket that can be used to accept incoming connections.
backlog | Number of pending connections that can be queued simultaneously, defaults to 1. |
Implements Socket.
|
virtual |
Receive data over a TLS socket.
The socket must be connected to a remote host. Returns the number of bytes received into the buffer.
data | Destination buffer for data received from the host. |
size | Size of the buffer in bytes. |
Implements Socket.
|
virtual |
Receive a data from a socket.
Receives a data and stores the source address in address if address is not NULL. Returns the number of bytes written into the buffer.
If socket is connected, only packets coming from connected peer address are accepted.
By default, recvfrom blocks until a datagram is received. If socket is set to non-blocking or times out with no data, NSAPI_ERROR_WOULD_BLOCK is returned.
address | Destination for the source address or NULL |
data | Destination buffer for datagram received from the host |
size | Size of the buffer in bytes |
Implements Socket.
|
virtual |
Send data over a TLS socket.
The socket must be connected to a remote host. Returns the number of bytes sent from the buffer.
data | Buffer of data to send to the host. |
size | Size of the buffer in bytes. |
Implements Socket.
|
virtual |
Send a message on a socket.
The sendto() function sends a message through a connection-mode or connectionless-mode socket. If the socket is a connectionless-mode socket, the message is sent to the address specified. If the socket is a connected-mode socket, address is ignored.
By default, sendto blocks until data is sent. If socket is set to non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned immediately.
address | Remote address |
data | Buffer of data to send to the host |
size | Size of the buffer in bytes |
Implements Socket.
|
virtual |
Set blocking or non-blocking mode of the socket.
Initially all sockets are in blocking mode. In non-blocking mode blocking operations such as send/recv/accept return NSAPI_ERROR_WOULD_BLOCK if they cannot continue.
set_blocking(false) is equivalent to set_timeout(0) set_blocking(true) is equivalent to set_timeout(-1)
blocking | true for blocking mode, false for non-blocking mode. |
Implements Socket.
void set_ca_chain | ( | mbedtls_x509_crt * | crt | ) |
Set CA chain directly to Mbed TLS.
crt | Mbed TLS X509 certificate chain. |
nsapi_error_t set_client_cert_key | ( | const void * | client_cert, |
size_t | client_cert_len, | ||
const void * | client_private_key_pem, | ||
size_t | client_private_key_len | ||
) |
Sets client certificate, and client private key.
client_cert | Client certification in PEM or DER format. |
client_cert_len | Certificate size including the terminating null byte for PEM data. |
client_private_key_pem | Client private key in PEM or DER format. |
client_private_key_len | Key size including the terminating null byte for PEM data |
nsapi_error_t set_client_cert_key | ( | const char * | client_cert_pem, |
const char * | client_private_key_pem | ||
) |
Sets client certificate, and client private key.
client_cert_pem | Client certification in PEM format. |
client_private_key_pem | Client private key in PEM format. |
void set_hostname | ( | const char * | hostname | ) |
Set hostname.
TLSSocket requires hostname used to verify the certificate. If hostname is not given in constructor, this function must be used before starting the TLS handshake.
hostname | Hostname of the remote host, used for certificate checking. |
int set_own_cert | ( | mbedtls_x509_crt * | crt | ) |
Set own certificate directly to Mbed TLS.
crt | Mbed TLS X509 certificate chain. |
nsapi_error_t set_root_ca_cert | ( | const void * | root_ca, |
size_t | len | ||
) |
Sets the certification of Root CA.
root_ca | Root CA Certificate in any Mbed TLS-supported format. |
len | Length of certificate (including terminating 0 for PEM). |
nsapi_error_t set_root_ca_cert | ( | const char * | root_ca_pem | ) |
Sets the certification of Root CA.
root_ca_pem | Root CA Certificate in PEM format. |
void set_ssl_config | ( | mbedtls_ssl_config * | conf | ) |
Override Mbed TLS configuration.
conf | Mbed TLS SSL configuration structure. |
|
virtual |
Set timeout on blocking socket operations.
Initially all sockets have unbounded timeouts. NSAPI_ERROR_WOULD_BLOCK is returned if a blocking operation takes longer than the specified timeout. A timeout of 0 removes the timeout from the socket. A negative value gives the socket an unbounded timeout.
set_timeout(0) is equivalent to set_blocking(false) set_timeout(-1) is equivalent to set_blocking(true)
timeout | Timeout in milliseconds |
Implements Socket.
|
virtual |
Set socket options.
setsockopt() allows an application to pass stack-specific options to the underlying stack using stack-specific level and option names, or to request generic options using levels from nsapi_socket_level_t.
For unsupported options, NSAPI_ERROR_UNSUPPORTED is returned and the socket is unmodified.
level | Stack-specific protocol level or nsapi_socket_level_t. |
optname | Level-specific option name. |
optval | Option value. |
optlen | Length of the option value. |
Implements Socket.
|
virtual |
Register a callback on state change of the socket.
The specified callback is called on state changes, such as when the socket can receive/send/accept successfully and when an error occurs. The callback may also be called spuriously without reason.
The callback may be called in an interrupt context and should not perform expensive operations such as receive/send calls.
Note! This is not intended as a replacement for a poll or attach-like asynchronous API, but rather as a building block for constructing such functionality. The exact timing of the registered function is not guaranteed and susceptible to change.
func | Function to call on state change. |
Implements Socket.