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