extlibs/mbedtls/mbedtls/include/mbedtls/net_sockets.h

   1 /**
   2  * \file net_sockets.h
   3  *
   4  * \brief Network communication functions
   5  *
   6  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
   7  *  SPDX-License-Identifier: Apache-2.0
   8  *
   9  *  Licensed under the Apache License, Version 2.0 (the "License"); you may
  10  *  not use this file except in compliance with the License.
  11  *  You may obtain a copy of the License at
  12  *
  13  *  http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  *  Unless required by applicable law or agreed to in writing, software
  16  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  17  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  *  See the License for the specific language governing permissions and
  19  *  limitations under the License.
  20  *
  21  *  This file is part of mbed TLS (https://tls.mbed.org)
  22  */
  23 #ifndef MBEDTLS_NET_SOCKETS_H
  24 #define MBEDTLS_NET_SOCKETS_H
  25
  26 #if !defined(MBEDTLS_CONFIG_FILE)
  27 #include "config.h"
  28 #else
  29 #include MBEDTLS_CONFIG_FILE
  30 #endif
  31
  32 #include "ssl.h"
  33
  34 #include <stddef.h>
  35 #include <stdint.h>
  36
  37 #define MBEDTLS_ERR_NET_SOCKET_FAILED                     -0x0042  /**< Failed to open a socket. */
  38 #define MBEDTLS_ERR_NET_CONNECT_FAILED                    -0x0044  /**< The connection to the given server / port failed. */
  39 #define MBEDTLS_ERR_NET_BIND_FAILED                       -0x0046  /**< Binding of the socket failed. */
  40 #define MBEDTLS_ERR_NET_LISTEN_FAILED                     -0x0048  /**< Could not listen on the socket. */
  41 #define MBEDTLS_ERR_NET_ACCEPT_FAILED                     -0x004A  /**< Could not accept the incoming connection. */
  42 #define MBEDTLS_ERR_NET_RECV_FAILED                       -0x004C  /**< Reading information from the socket failed. */
  43 #define MBEDTLS_ERR_NET_SEND_FAILED                       -0x004E  /**< Sending information through the socket failed. */
  44 #define MBEDTLS_ERR_NET_CONN_RESET                        -0x0050  /**< Connection was reset by peer. */
  45 #define MBEDTLS_ERR_NET_UNKNOWN_HOST                      -0x0052  /**< Failed to get an IP address for the given hostname. */
  46 #define MBEDTLS_ERR_NET_BUFFER_TOO_SMALL                  -0x0043  /**< Buffer is too small to hold the data. */
  47 #define MBEDTLS_ERR_NET_INVALID_CONTEXT                   -0x0045  /**< The context is invalid, eg because it was free()ed. */
  48
  49 #define MBEDTLS_NET_LISTEN_BACKLOG         10 /**< The backlog that listen() should use. */
  50
  51 #define MBEDTLS_NET_PROTO_TCP 0 /**< The TCP transport protocol */
  52 #define MBEDTLS_NET_PROTO_UDP 1 /**< The UDP transport protocol */
  53
  54 #ifdef __cplusplus
  55 extern "C" {
  56 #endif
  57
  58 /**
  59  * Wrapper type for sockets.
  60  *
  61  * Currently backed by just a file descriptor, but might be more in the future
  62  * (eg two file descriptors for combined IPv4 + IPv6 support, or additional
  63  * structures for hand-made UDP demultiplexing).
  64  */
  65 typedef struct
  66 {
  67     int fd;             /**< The underlying file descriptor                 */
  68 }
  69 mbedtls_net_context;
  70
  71 /**
  72  * \brief          Initialize a context
  73  *                 Just makes the context ready to be used or freed safely.
  74  *
  75  * \param ctx      Context to initialize
  76  */
  77 void mbedtls_net_init( mbedtls_net_context *ctx );
  78
  79 /**
  80  * \brief          Initiate a connection with host:port in the given protocol
  81  *
  82  * \param ctx      Socket to use
  83  * \param host     Host to connect to
  84  * \param port     Port to connect to
  85  * \param proto    Protocol: MBEDTLS_NET_PROTO_TCP or MBEDTLS_NET_PROTO_UDP
  86  *
  87  * \return         0 if successful, or one of:
  88  *                      MBEDTLS_ERR_NET_SOCKET_FAILED,
  89  *                      MBEDTLS_ERR_NET_UNKNOWN_HOST,
  90  *                      MBEDTLS_ERR_NET_CONNECT_FAILED
  91  *
  92  * \note           Sets the socket in connected mode even with UDP.
  93  */
  94 int mbedtls_net_connect( mbedtls_net_context *ctx, const char *host, const char *port, int proto );
  95
  96 /**
  97  * \brief          Create a receiving socket on bind_ip:port in the chosen
  98  *                 protocol. If bind_ip == NULL, all interfaces are bound.
  99  *
 100  * \param ctx      Socket to use
 101  * \param bind_ip  IP to bind to, can be NULL
 102  * \param port     Port number to use
 103  * \param proto    Protocol: MBEDTLS_NET_PROTO_TCP or MBEDTLS_NET_PROTO_UDP
 104  *
 105  * \return         0 if successful, or one of:
 106  *                      MBEDTLS_ERR_NET_SOCKET_FAILED,
 107  *                      MBEDTLS_ERR_NET_BIND_FAILED,
 108  *                      MBEDTLS_ERR_NET_LISTEN_FAILED
 109  *
 110  * \note           Regardless of the protocol, opens the sockets and binds it.
 111  *                 In addition, make the socket listening if protocol is TCP.
 112  */
 113 int mbedtls_net_bind( mbedtls_net_context *ctx, const char *bind_ip, const char *port, int proto );
 114
 115 /**
 116  * \brief           Accept a connection from a remote client
 117  *
 118  * \param bind_ctx  Relevant socket
 119  * \param client_ctx Will contain the connected client socket
 120  * \param client_ip Will contain the client IP address
 121  * \param buf_size  Size of the client_ip buffer
 122  * \param ip_len    Will receive the size of the client IP written
 123  *
 124  * \return          0 if successful, or
 125  *                  MBEDTLS_ERR_NET_ACCEPT_FAILED, or
 126  *                  MBEDTLS_ERR_NET_BUFFER_TOO_SMALL if buf_size is too small,
 127  *                  MBEDTLS_ERR_SSL_WANT_READ if bind_fd was set to
 128  *                  non-blocking and accept() would block.
 129  */
 130 int mbedtls_net_accept( mbedtls_net_context *bind_ctx,
 131                         mbedtls_net_context *client_ctx,
 132                         void *client_ip, size_t buf_size, size_t *ip_len );
 133
 134 /**
 135  * \brief          Set the socket blocking
 136  *
 137  * \param ctx      Socket to set
 138  *
 139  * \return         0 if successful, or a non-zero error code
 140  */
 141 int mbedtls_net_set_block( mbedtls_net_context *ctx );
 142
 143 /**
 144  * \brief          Set the socket non-blocking
 145  *
 146  * \param ctx      Socket to set
 147  *
 148  * \return         0 if successful, or a non-zero error code
 149  */
 150 int mbedtls_net_set_nonblock( mbedtls_net_context *ctx );
 151
 152 /**
 153  * \brief          Portable usleep helper
 154  *
 155  * \param usec     Amount of microseconds to sleep
 156  *
 157  * \note           Real amount of time slept will not be less than
 158  *                 select()'s timeout granularity (typically, 10ms).
 159  */
 160 void mbedtls_net_usleep( unsigned long usec );
 161
 162 /**
 163  * \brief          Read at most 'len' characters. If no error occurs,
 164  *                 the actual amount read is returned.
 165  *
 166  * \param ctx      Socket
 167  * \param buf      The buffer to write to
 168  * \param len      Maximum length of the buffer
 169  *
 170  * \return         the number of bytes received,
 171  *                 or a non-zero error code; with a non-blocking socket,
 172  *                 MBEDTLS_ERR_SSL_WANT_READ indicates read() would block.
 173  */
 174 int mbedtls_net_recv( void *ctx, unsigned char *buf, size_t len );
 175
 176 /**
 177  * \brief          Write at most 'len' characters. If no error occurs,
 178  *                 the actual amount read is returned.
 179  *
 180  * \param ctx      Socket
 181  * \param buf      The buffer to read from
 182  * \param len      The length of the buffer
 183  *
 184  * \return         the number of bytes sent,
 185  *                 or a non-zero error code; with a non-blocking socket,
 186  *                 MBEDTLS_ERR_SSL_WANT_WRITE indicates write() would block.
 187  */
 188 int mbedtls_net_send( void *ctx, const unsigned char *buf, size_t len );
 189
 190 /**
 191  * \brief          Read at most 'len' characters, blocking for at most
 192  *                 'timeout' seconds. If no error occurs, the actual amount
 193  *                 read is returned.
 194  *
 195  * \param ctx      Socket
 196  * \param buf      The buffer to write to
 197  * \param len      Maximum length of the buffer
 198  * \param timeout  Maximum number of milliseconds to wait for data
 199  *                 0 means no timeout (wait forever)
 200  *
 201  * \return         the number of bytes received,
 202  *                 or a non-zero error code:
 203  *                 MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
 204  *                 MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
 205  *
 206  * \note           This function will block (until data becomes available or
 207  *                 timeout is reached) even if the socket is set to
 208  *                 non-blocking. Handling timeouts with non-blocking reads
 209  *                 requires a different strategy.
 210  */
 211 int mbedtls_net_recv_timeout( void *ctx, unsigned char *buf, size_t len,
 212                       uint32_t timeout );
 213
 214 /**
 215  * \brief          Gracefully shutdown the connection and free associated data
 216  *
 217  * \param ctx      The context to free
 218  */
 219 void mbedtls_net_free( mbedtls_net_context *ctx );
 220
 221 #ifdef __cplusplus
 222 }
 223 #endif
 224
 225 #endif /* net_sockets.h */