Documentation

Documentation

Includes

config.h

#include "config.h"
#include "config.h"

MBEDTLS_CONFIG_FILE

#include MBEDTLS_CONFIG_FILE
#include MBEDTLS_CONFIG_FILE

ssl.h

#include "ssl.h"
#include "ssl.h"

stddef.h

#include <stddef.h>
#include 

stdint.h

#include <stdint.h>
#include 

Macros

Marco MBEDTLS_NET_SOCKETS_H

#define MBEDTLS_NET_SOCKETS_H


      

Marco MBEDTLS_ERR_NET_SOCKET_FAILED

#define MBEDTLS_ERR_NET_SOCKET_FAILED                    -66 /**< Failed to open a socket. */


      

Marco MBEDTLS_ERR_NET_CONNECT_FAILED

#define MBEDTLS_ERR_NET_CONNECT_FAILED                   -68 /**< The connection to the given server / port failed. */


      

Marco MBEDTLS_ERR_NET_BIND_FAILED

#define MBEDTLS_ERR_NET_BIND_FAILED                      -70 /**< Binding of the socket failed. */


      

Marco MBEDTLS_ERR_NET_LISTEN_FAILED

#define MBEDTLS_ERR_NET_LISTEN_FAILED                    -72 /**< Could not listen on the socket. */


      

Marco MBEDTLS_ERR_NET_ACCEPT_FAILED

#define MBEDTLS_ERR_NET_ACCEPT_FAILED                    -4A /**< Could not accept the incoming connection. */


      

Marco MBEDTLS_ERR_NET_RECV_FAILED

#define MBEDTLS_ERR_NET_RECV_FAILED                      -4C /**< Reading information from the socket failed. */


      

Marco MBEDTLS_ERR_NET_SEND_FAILED

#define MBEDTLS_ERR_NET_SEND_FAILED                      -4E /**< Sending information through the socket failed. */


      

Marco MBEDTLS_ERR_NET_CONN_RESET

#define MBEDTLS_ERR_NET_CONN_RESET                       -80 /**< Connection was reset by peer. */


      

Marco MBEDTLS_ERR_NET_UNKNOWN_HOST

#define MBEDTLS_ERR_NET_UNKNOWN_HOST                     -82 /**< Failed to get an IP address for the given hostname. */


      

Marco MBEDTLS_ERR_NET_BUFFER_TOO_SMALL

#define MBEDTLS_ERR_NET_BUFFER_TOO_SMALL                 -67 /**< Buffer is too small to hold the data. */


      

Marco MBEDTLS_ERR_NET_INVALID_CONTEXT

#define MBEDTLS_ERR_NET_INVALID_CONTEXT                  -69 /**< The context is invalid, eg because it was free()ed. */


      

Marco MBEDTLS_ERR_NET_POLL_FAILED

#define MBEDTLS_ERR_NET_POLL_FAILED                      -71 /**< Polling the net context failed. */


      

Marco MBEDTLS_ERR_NET_BAD_INPUT_DATA

#define MBEDTLS_ERR_NET_BAD_INPUT_DATA                   -73 /**< Input invalid. */


      

Marco MBEDTLS_NET_LISTEN_BACKLOG

#define MBEDTLS_NET_LISTEN_BACKLOG        10 /**< The backlog that listen() should use. */


      

Marco MBEDTLS_NET_PROTO_TCP

#define MBEDTLS_NET_PROTO_TCP 0 /**< The TCP transport protocol */


      

Marco MBEDTLS_NET_PROTO_UDP

#define MBEDTLS_NET_PROTO_UDP 1 /**< The UDP transport protocol */


      

Marco MBEDTLS_NET_POLL_READ

#define MBEDTLS_NET_POLL_READ 1 /**< Used in \c mbedtls_net_poll to check for pending data  */


      

Marco MBEDTLS_NET_POLL_WRITE

#define MBEDTLS_NET_POLL_WRITE 2 /**< Used in \c mbedtls_net_poll to check if write possible */

      

Functions

Func mbedtls_net_init

void mbedtls_net_init( mbedtls_net_context *ctx );
/**
 * \brief          Initialize a context
 *                 Just makes the context ready to be used or freed safely.
 *
 * \param ctx      Context to initialize
 */

Func mbedtls_net_connect

int mbedtls_net_connect( mbedtls_net_context *ctx, const char *host, const char *port, int proto );
/**
 * \brief          Initiate a connection with host:port in the given protocol
 *
 * \param ctx      Socket to use
 * \param host     Host to connect to
 * \param port     Port to connect to
 * \param proto    Protocol: MBEDTLS_NET_PROTO_TCP or MBEDTLS_NET_PROTO_UDP
 *
 * \return         0 if successful, or one of:
 *                      MBEDTLS_ERR_NET_SOCKET_FAILED,
 *                      MBEDTLS_ERR_NET_UNKNOWN_HOST,
 *                      MBEDTLS_ERR_NET_CONNECT_FAILED
 *
 * \note           Sets the socket in connected mode even with UDP.
 */

Func mbedtls_net_bind

int mbedtls_net_bind( mbedtls_net_context *ctx, const char *bind_ip, const char *port, int proto );
/**
 * \brief          Create a receiving socket on bind_ip:port in the chosen
 *                 protocol. If bind_ip == NULL, all interfaces are bound.
 *
 * \param ctx      Socket to use
 * \param bind_ip  IP to bind to, can be NULL
 * \param port     Port number to use
 * \param proto    Protocol: MBEDTLS_NET_PROTO_TCP or MBEDTLS_NET_PROTO_UDP
 *
 * \return         0 if successful, or one of:
 *                      MBEDTLS_ERR_NET_SOCKET_FAILED,
 *                      MBEDTLS_ERR_NET_BIND_FAILED,
 *                      MBEDTLS_ERR_NET_LISTEN_FAILED
 *
 * \note           Regardless of the protocol, opens the sockets and binds it.
 *                 In addition, make the socket listening if protocol is TCP.
 */

Func mbedtls_net_accept

int mbedtls_net_accept( mbedtls_net_context *bind_ctx,
                       mbedtls_net_context *client_ctx,
                       void *client_ip, size_t buf_size, size_t *ip_len );
/**
 * \brief           Accept a connection from a remote client
 *
 * \param bind_ctx  Relevant socket
 * \param client_ctx Will contain the connected client socket
 * \param client_ip Will contain the client IP address, can be NULL
 * \param buf_size  Size of the client_ip buffer
 * \param ip_len    Will receive the size of the client IP written,
 *                  can be NULL if client_ip is null
 *
 * \return          0 if successful, or
 *                  MBEDTLS_ERR_NET_ACCEPT_FAILED, or
 *                  MBEDTLS_ERR_NET_BUFFER_TOO_SMALL if buf_size is too small,
 *                  MBEDTLS_ERR_SSL_WANT_READ if bind_fd was set to
 *                  non-blocking and accept() would block.
 */

Func mbedtls_net_poll

int mbedtls_net_poll( mbedtls_net_context *ctx, uint32_t rw, uint32_t timeout );
/**
 * \brief          Check and wait for the context to be ready for read/write
 *
 * \param ctx      Socket to check
 * \param rw       Bitflag composed of MBEDTLS_NET_POLL_READ and
 *                 MBEDTLS_NET_POLL_WRITE specifying the events
 *                 to wait for:
 *                 - If MBEDTLS_NET_POLL_READ is set, the function
 *                   will return as soon as the net context is available
 *                   for reading.
 *                 - If MBEDTLS_NET_POLL_WRITE is set, the function
 *                   will return as soon as the net context is available
 *                   for writing.
 * \param timeout  Maximal amount of time to wait before returning,
 *                 in milliseconds. If \c timeout is zero, the
 *                 function returns immediately. If \c timeout is
 *                 -1u, the function blocks potentially indefinitely.
 *
 * \return         Bitmask composed of MBEDTLS_NET_POLL_READ/WRITE
 *                 on success or timeout, or a negative return code otherwise.
 */

Func mbedtls_net_set_block

int mbedtls_net_set_block( mbedtls_net_context *ctx );
/**
 * \brief          Set the socket blocking
 *
 * \param ctx      Socket to set
 *
 * \return         0 if successful, or a non-zero error code
 */

Func mbedtls_net_set_nonblock

int mbedtls_net_set_nonblock( mbedtls_net_context *ctx );
/**
 * \brief          Set the socket non-blocking
 *
 * \param ctx      Socket to set
 *
 * \return         0 if successful, or a non-zero error code
 */

Func mbedtls_net_usleep

void mbedtls_net_usleep( unsigned long usec );
/**
 * \brief          Portable usleep helper
 *
 * \param usec     Amount of microseconds to sleep
 *
 * \note           Real amount of time slept will not be less than
 *                 select()'s timeout granularity (typically, 10ms).
 */

Func mbedtls_net_recv

int mbedtls_net_recv( void *ctx, unsigned char *buf, size_t len );
/**
 * \brief          Read at most 'len' characters. If no error occurs,
 *                 the actual amount read is returned.
 *
 * \param ctx      Socket
 * \param buf      The buffer to write to
 * \param len      Maximum length of the buffer
 *
 * \return         the number of bytes received,
 *                 or a non-zero error code; with a non-blocking socket,
 *                 MBEDTLS_ERR_SSL_WANT_READ indicates read() would block.
 */

Func mbedtls_net_send

int mbedtls_net_send( void *ctx, const unsigned char *buf, size_t len );
/**
 * \brief          Write at most 'len' characters. If no error occurs,
 *                 the actual amount read is returned.
 *
 * \param ctx      Socket
 * \param buf      The buffer to read from
 * \param len      The length of the buffer
 *
 * \return         the number of bytes sent,
 *                 or a non-zero error code; with a non-blocking socket,
 *                 MBEDTLS_ERR_SSL_WANT_WRITE indicates write() would block.
 */

Func mbedtls_net_recv_timeout

int mbedtls_net_recv_timeout( void *ctx, unsigned char *buf, size_t len,
                     uint32_t timeout );
/**
 * \brief          Read at most 'len' characters, blocking for at most
 *                 'timeout' seconds. If no error occurs, the actual amount
 *                 read is returned.
 *
 * \param ctx      Socket
 * \param buf      The buffer to write to
 * \param len      Maximum length of the buffer
 * \param timeout  Maximum number of milliseconds to wait for data
 *                 0 means no timeout (wait forever)
 *
 * \return         the number of bytes received,
 *                 or a non-zero error code:
 *                 MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
 *                 MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
 *
 * \note           This function will block (until data becomes available or
 *                 timeout is reached) even if the socket is set to
 *                 non-blocking. Handling timeouts with non-blocking reads
 *                 requires a different strategy.
 */

Func mbedtls_net_free

void mbedtls_net_free( mbedtls_net_context *ctx );
/**
 * \brief          Gracefully shutdown the connection and free associated data
 *
 * \param ctx      The context to free
 */

Vars

Consts

Types

Typedefs

Typedef mbedtls_net_context;

typedef struct mbedtls_net_context
{
   int fd;            /**< The underlying file descriptor                 */
}
mbedtls_net_context;
/**
 * Wrapper type for sockets.
 *
 * Currently backed by just a file descriptor, but might be more in the future
 * (eg two file descriptors for combined IPv4 + IPv6 support, or additional
 * structures for hand-made UDP demultiplexing).
 */