blob: ed2d5d322cfae732316726d237a73fe899342983 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
2 * \file net.h
Paul Bakkere0ccd0a2009-01-04 16:27:10 +00003 *
Paul Bakkercce9d772011-11-18 14:26:47 +00004 * \brief Network communication functions
Paul Bakker37ca75d2011-01-06 12:28:03 +00005 *
Manuel Pégourié-Gonnarda658a402015-01-23 09:45:19 +00006 * Copyright (C) 2006-2011, ARM Limited, All Rights Reserved
Paul Bakkerb96f1542010-07-18 20:36:00 +00007 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +00008 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakkere0ccd0a2009-01-04 16:27:10 +00009 *
Paul Bakkere0ccd0a2009-01-04 16:27:10 +000010 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Paul Bakker5121ce52009-01-03 21:22:43 +000023 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020024#ifndef MBEDTLS_NET_H
25#define MBEDTLS_NET_H
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if !defined(MBEDTLS_CONFIG_FILE)
Manuel Pégourié-Gonnard9d9b0032014-09-18 11:22:45 +020028#include "config.h"
29#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020030#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnard9d9b0032014-09-18 11:22:45 +020031#endif
32
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +010033#include "ssl.h"
34
Rich Evans00ab4702015-02-06 13:43:58 +000035#include <stddef.h>
Manuel Pégourié-Gonnardab229102015-04-15 11:53:16 +020036#include <stdint.h>
Manuel Pégourié-Gonnardc8d8e972014-10-01 15:01:39 +020037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020038#define MBEDTLS_ERR_NET_SOCKET_FAILED -0x0042 /**< Failed to open a socket. */
39#define MBEDTLS_ERR_NET_CONNECT_FAILED -0x0044 /**< The connection to the given server / port failed. */
40#define MBEDTLS_ERR_NET_BIND_FAILED -0x0046 /**< Binding of the socket failed. */
41#define MBEDTLS_ERR_NET_LISTEN_FAILED -0x0048 /**< Could not listen on the socket. */
42#define MBEDTLS_ERR_NET_ACCEPT_FAILED -0x004A /**< Could not accept the incoming connection. */
43#define MBEDTLS_ERR_NET_RECV_FAILED -0x004C /**< Reading information from the socket failed. */
44#define MBEDTLS_ERR_NET_SEND_FAILED -0x004E /**< Sending information through the socket failed. */
45#define MBEDTLS_ERR_NET_CONN_RESET -0x0050 /**< Connection was reset by peer. */
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +010046#define MBEDTLS_ERR_NET_UNKNOWN_HOST -0x0052 /**< Failed to get an IP address for the given hostname. */
Manuel Pégourié-Gonnard0b104b02015-05-14 21:52:40 +020047#define MBEDTLS_ERR_NET_BUFFER_TOO_SMALL -0x0043 /**< Buffer is too small to hold the data. */
Paul Bakker5121ce52009-01-03 21:22:43 +000048
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020049#define MBEDTLS_NET_LISTEN_BACKLOG 10 /**< The backlog that listen() should use. */
Paul Bakker192381a2011-05-20 12:31:31 +000050
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020051#define MBEDTLS_NET_PROTO_TCP 0 /**< The TCP transport protocol */
52#define MBEDTLS_NET_PROTO_UDP 1 /**< The UDP transport protocol */
Manuel Pégourié-Gonnardf5a13122014-03-23 17:38:16 +010053
Paul Bakker5121ce52009-01-03 21:22:43 +000054#ifdef __cplusplus
55extern "C" {
56#endif
57
58/**
Manuel Pégourié-Gonnardf5a13122014-03-23 17:38:16 +010059 * \brief Initiate a connection with host:port in the given protocol
Paul Bakker5121ce52009-01-03 21:22:43 +000060 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +000061 * \param fd Socket to use
62 * \param host Host to connect to
63 * \param port Port to connect to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020064 * \param proto Protocol: MBEDTLS_NET_PROTO_TCP or MBEDTLS_NET_PROTO_UDP
Paul Bakker13e2dfe2009-07-28 07:18:38 +000065 *
Paul Bakker5121ce52009-01-03 21:22:43 +000066 * \return 0 if successful, or one of:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020067 * MBEDTLS_ERR_NET_SOCKET_FAILED,
68 * MBEDTLS_ERR_NET_UNKNOWN_HOST,
69 * MBEDTLS_ERR_NET_CONNECT_FAILED
Manuel Pégourié-Gonnardf5a13122014-03-23 17:38:16 +010070 *
71 * \note Sets the socket in connected mode even with UDP.
Paul Bakker5121ce52009-01-03 21:22:43 +000072 */
Manuel Pégourié-Gonnardc0d74942015-06-23 12:30:57 +020073int mbedtls_net_connect( int *fd, const char *host, const char *port, int proto );
Paul Bakker5121ce52009-01-03 21:22:43 +000074
75/**
Manuel Pégourié-Gonnardf5a13122014-03-23 17:38:16 +010076 * \brief Create a receiving socket on bind_ip:port in the chosen
77 * protocol. If bind_ip == NULL, all interfaces are bound.
Paul Bakker5121ce52009-01-03 21:22:43 +000078 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +000079 * \param fd Socket to use
80 * \param bind_ip IP to bind to, can be NULL
81 * \param port Port number to use
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020082 * \param proto Protocol: MBEDTLS_NET_PROTO_TCP or MBEDTLS_NET_PROTO_UDP
Paul Bakker13e2dfe2009-07-28 07:18:38 +000083 *
Paul Bakker5121ce52009-01-03 21:22:43 +000084 * \return 0 if successful, or one of:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020085 * MBEDTLS_ERR_NET_SOCKET_FAILED,
86 * MBEDTLS_ERR_NET_BIND_FAILED,
87 * MBEDTLS_ERR_NET_LISTEN_FAILED
Manuel Pégourié-Gonnardf5a13122014-03-23 17:38:16 +010088 *
89 * \note Regardless of the protocol, opens the sockets and binds it.
90 * In addition, make the socket listening if protocol is TCP.
Paul Bakker5121ce52009-01-03 21:22:43 +000091 */
Manuel Pégourié-Gonnardc0d74942015-06-23 12:30:57 +020092int mbedtls_net_bind( int *fd, const char *bind_ip, const char *port, int proto );
Paul Bakker5121ce52009-01-03 21:22:43 +000093
94/**
Paul Bakker13e2dfe2009-07-28 07:18:38 +000095 * \brief Accept a connection from a remote client
Paul Bakker5121ce52009-01-03 21:22:43 +000096 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +000097 * \param bind_fd Relevant socket
98 * \param client_fd Will contain the connected client socket
99 * \param client_ip Will contain the client IP address
Manuel Pégourié-Gonnard0b104b02015-05-14 21:52:40 +0200100 * \param buf_size Size of the client_ip buffer
101 * \param ip_len Will receive the size of the client IP written
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000102 *
Manuel Pégourié-Gonnard0b104b02015-05-14 21:52:40 +0200103 * \return 0 if successful, or
104 * MBEDTLS_ERR_NET_ACCEPT_FAILED, or
105 * MBEDTLS_ERR_NET_BUFFER_TOO_SMALL if buf_size is too small,
106 * MBEDTLS_ERR_SSL_WANT_READ if bind_fd was set to
Manuel Pégourié-Gonnarddad1ad72015-05-14 21:54:55 +0200107 * non-blocking and accept() would block.
Manuel Pégourié-Gonnardf5a13122014-03-23 17:38:16 +0100108 *
109 * \note With UDP, connects the bind_fd to the client and just copy
110 * its descriptor to client_fd. New clients will not be able
111 * to connect until you close the socket and bind a new one.
Paul Bakker5121ce52009-01-03 21:22:43 +0000112 */
Manuel Pégourié-Gonnard0b104b02015-05-14 21:52:40 +0200113int mbedtls_net_accept( int bind_fd, int *client_fd,
114 void *client_ip, size_t buf_size, size_t *ip_len );
Paul Bakker5121ce52009-01-03 21:22:43 +0000115
116/**
117 * \brief Set the socket blocking
118 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000119 * \param fd Socket to set
120 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000121 * \return 0 if successful, or a non-zero error code
122 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200123int mbedtls_net_set_block( int fd );
Paul Bakker5121ce52009-01-03 21:22:43 +0000124
125/**
126 * \brief Set the socket non-blocking
127 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000128 * \param fd Socket to set
129 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000130 * \return 0 if successful, or a non-zero error code
131 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200132int mbedtls_net_set_nonblock( int fd );
Paul Bakker5121ce52009-01-03 21:22:43 +0000133
134/**
135 * \brief Portable usleep helper
136 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000137 * \param usec Amount of microseconds to sleep
138 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000139 * \note Real amount of time slept will not be less than
140 * select()'s timeout granularity (typically, 10ms).
141 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200142void mbedtls_net_usleep( unsigned long usec );
Paul Bakker5121ce52009-01-03 21:22:43 +0000143
144/**
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000145 * \brief Read at most 'len' characters. If no error occurs,
146 * the actual amount read is returned.
147 *
148 * \param ctx Socket
149 * \param buf The buffer to write to
150 * \param len Maximum length of the buffer
Paul Bakker5121ce52009-01-03 21:22:43 +0000151 *
Manuel Pégourié-Gonnard81abefd2015-05-29 12:53:47 +0200152 * \return the number of bytes received,
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +0100153 * or a non-zero error code; with a non-blocking socket,
Manuel Pégourié-Gonnarddad1ad72015-05-14 21:54:55 +0200154 * MBEDTLS_ERR_SSL_WANT_READ indicates read() would block.
Paul Bakker5121ce52009-01-03 21:22:43 +0000155 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200156int mbedtls_net_recv( void *ctx, unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +0000157
158/**
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000159 * \brief Write at most 'len' characters. If no error occurs,
160 * the actual amount read is returned.
161 *
162 * \param ctx Socket
Paul Bakkerff60ee62010-03-16 21:09:09 +0000163 * \param buf The buffer to read from
164 * \param len The length of the buffer
Paul Bakker5121ce52009-01-03 21:22:43 +0000165 *
Manuel Pégourié-Gonnard81abefd2015-05-29 12:53:47 +0200166 * \return the number of bytes sent,
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +0100167 * or a non-zero error code; with a non-blocking socket,
Manuel Pégourié-Gonnarddad1ad72015-05-14 21:54:55 +0200168 * MBEDTLS_ERR_SSL_WANT_WRITE indicates write() would block.
Paul Bakker5121ce52009-01-03 21:22:43 +0000169 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200170int mbedtls_net_send( void *ctx, const unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +0000171
Manuel Pégourié-Gonnard9d9b0032014-09-18 11:22:45 +0200172/**
173 * \brief Read at most 'len' characters, blocking for at most
174 * 'timeout' seconds. If no error occurs, the actual amount
175 * read is returned.
176 *
177 * \param ctx Socket
178 * \param buf The buffer to write to
179 * \param len Maximum length of the buffer
Manuel Pégourié-Gonnardc8d8e972014-10-01 15:01:39 +0200180 * \param timeout Maximum number of milliseconds to wait for data
Manuel Pégourié-Gonnard9d9b0032014-09-18 11:22:45 +0200181 *
Manuel Pégourié-Gonnard81abefd2015-05-29 12:53:47 +0200182 * \return the number of bytes received,
Manuel Pégourié-Gonnard9d9b0032014-09-18 11:22:45 +0200183 * or a non-zero error code:
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +0100184 * MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
185 * MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
Manuel Pégourié-Gonnard9d9b0032014-09-18 11:22:45 +0200186 *
187 * \note This function will block (until data becomes available or
188 * timeout is reached) even if the socket is set to
189 * non-blocking. Handling timeouts with non-blocking reads
190 * requires a different strategy.
191 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200192int mbedtls_net_recv_timeout( void *ctx, unsigned char *buf, size_t len,
Manuel Pégourié-Gonnardc8d8e972014-10-01 15:01:39 +0200193 uint32_t timeout );
Manuel Pégourié-Gonnard9d9b0032014-09-18 11:22:45 +0200194
Paul Bakker5121ce52009-01-03 21:22:43 +0000195/**
196 * \brief Gracefully shutdown the connection
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000197 *
198 * \param fd The socket to close
Paul Bakker5121ce52009-01-03 21:22:43 +0000199 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200200void mbedtls_net_close( int fd );
Paul Bakker5121ce52009-01-03 21:22:43 +0000201
202#ifdef __cplusplus
203}
204#endif
205
206#endif /* net.h */