2 * TCP/IP or UDP/IP networking functions
\r
4 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
\r
5 * SPDX-License-Identifier: Apache-2.0
\r
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
\r
8 * not use this file except in compliance with the License.
\r
9 * You may obtain a copy of the License at
\r
11 * http://www.apache.org/licenses/LICENSE-2.0
\r
13 * Unless required by applicable law or agreed to in writing, software
\r
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
\r
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
16 * See the License for the specific language governing permissions and
\r
17 * limitations under the License.
\r
19 * This file is part of mbed TLS (https://tls.mbed.org)
\r
22 /* Enable definition of getaddrinfo() even when compiling with -std=c99. Must
\r
23 * be set before config.h, which pulls in glibc's features.h indirectly.
\r
24 * Harmless on other platforms. */
\r
25 #define _POSIX_C_SOURCE 200112L
\r
27 #if !defined(MBEDTLS_CONFIG_FILE)
\r
28 #include "mbedtls/config.h"
\r
30 #include MBEDTLS_CONFIG_FILE
\r
33 #if defined(MBEDTLS_NET_C)
\r
35 #if !defined(unix) && !defined(__unix__) && !defined(__unix) && \
\r
36 !defined(__APPLE__) && !defined(_WIN32) && !defined(__QNXNTO__) && \
\r
38 #error "This module only works on Unix and Windows, see MBEDTLS_NET_C in config.h"
\r
41 #if defined(MBEDTLS_PLATFORM_C)
\r
42 #include "mbedtls/platform.h"
\r
47 #include "mbedtls/net_sockets.h"
\r
51 #if (defined(_WIN32) || defined(_WIN32_WCE)) && !defined(EFIX64) && \
\r
54 #define IS_EINTR( ret ) ( ( ret ) == WSAEINTR )
\r
56 #if !defined(_WIN32_WINNT) || (_WIN32_WINNT < 0x0501)
\r
58 /* Enables getaddrinfo() & Co */
\r
59 #define _WIN32_WINNT 0x0501
\r
62 #include <ws2tcpip.h>
\r
64 #include <winsock2.h>
\r
65 #include <windows.h>
\r
67 #if defined(_MSC_VER)
\r
68 #if defined(_WIN32_WCE)
\r
69 #pragma comment( lib, "ws2.lib" )
\r
71 #pragma comment( lib, "ws2_32.lib" )
\r
73 #endif /* _MSC_VER */
\r
75 #define read(fd,buf,len) recv( fd, (char*)( buf ), (int)( len ), 0 )
\r
76 #define write(fd,buf,len) send( fd, (char*)( buf ), (int)( len ), 0 )
\r
77 #define close(fd) closesocket(fd)
\r
79 static int wsa_init_done = 0;
\r
81 #else /* ( _WIN32 || _WIN32_WCE ) && !EFIX64 && !EFI32 */
\r
83 #include <sys/types.h>
\r
84 #include <sys/socket.h>
\r
85 #include <netinet/in.h>
\r
86 #include <arpa/inet.h>
\r
87 #include <sys/time.h>
\r
94 #define IS_EINTR( ret ) ( ( ret ) == EINTR )
\r
96 #endif /* ( _WIN32 || _WIN32_WCE ) && !EFIX64 && !EFI32 */
\r
98 /* Some MS functions want int and MSVC warns if we pass size_t,
\r
99 * but the standard functions use socklen_t, so cast only for MSVC */
\r
100 #if defined(_MSC_VER)
\r
101 #define MSVC_INT_CAST (int)
\r
103 #define MSVC_INT_CAST
\r
110 #include <stdint.h>
\r
113 * Prepare for using the sockets interface
\r
115 static int net_prepare( void )
\r
117 #if ( defined(_WIN32) || defined(_WIN32_WCE) ) && !defined(EFIX64) && \
\r
121 if( wsa_init_done == 0 )
\r
123 if( WSAStartup( MAKEWORD(2,0), &wsaData ) != 0 )
\r
124 return( MBEDTLS_ERR_NET_SOCKET_FAILED );
\r
129 #if !defined(EFIX64) && !defined(EFI32)
\r
130 signal( SIGPIPE, SIG_IGN );
\r
137 * Initialize a context
\r
139 void mbedtls_net_init( mbedtls_net_context *ctx )
\r
145 * Initiate a TCP connection with host:port and the given protocol
\r
147 int mbedtls_net_connect( mbedtls_net_context *ctx, const char *host,
\r
148 const char *port, int proto )
\r
151 struct addrinfo hints, *addr_list, *cur;
\r
153 if( ( ret = net_prepare() ) != 0 )
\r
156 /* Do name resolution with both IPv6 and IPv4 */
\r
157 memset( &hints, 0, sizeof( hints ) );
\r
158 hints.ai_family = AF_UNSPEC;
\r
159 hints.ai_socktype = proto == MBEDTLS_NET_PROTO_UDP ? SOCK_DGRAM : SOCK_STREAM;
\r
160 hints.ai_protocol = proto == MBEDTLS_NET_PROTO_UDP ? IPPROTO_UDP : IPPROTO_TCP;
\r
162 if( getaddrinfo( host, port, &hints, &addr_list ) != 0 )
\r
163 return( MBEDTLS_ERR_NET_UNKNOWN_HOST );
\r
165 /* Try the sockaddrs until a connection succeeds */
\r
166 ret = MBEDTLS_ERR_NET_UNKNOWN_HOST;
\r
167 for( cur = addr_list; cur != NULL; cur = cur->ai_next )
\r
169 ctx->fd = (int) socket( cur->ai_family, cur->ai_socktype,
\r
170 cur->ai_protocol );
\r
173 ret = MBEDTLS_ERR_NET_SOCKET_FAILED;
\r
177 if( connect( ctx->fd, cur->ai_addr, MSVC_INT_CAST cur->ai_addrlen ) == 0 )
\r
184 ret = MBEDTLS_ERR_NET_CONNECT_FAILED;
\r
187 freeaddrinfo( addr_list );
\r
193 * Create a listening socket on bind_ip:port
\r
195 int mbedtls_net_bind( mbedtls_net_context *ctx, const char *bind_ip, const char *port, int proto )
\r
198 struct addrinfo hints, *addr_list, *cur;
\r
200 if( ( ret = net_prepare() ) != 0 )
\r
203 /* Bind to IPv6 and/or IPv4, but only in the desired protocol */
\r
204 memset( &hints, 0, sizeof( hints ) );
\r
205 hints.ai_family = AF_UNSPEC;
\r
206 hints.ai_socktype = proto == MBEDTLS_NET_PROTO_UDP ? SOCK_DGRAM : SOCK_STREAM;
\r
207 hints.ai_protocol = proto == MBEDTLS_NET_PROTO_UDP ? IPPROTO_UDP : IPPROTO_TCP;
\r
208 if( bind_ip == NULL )
\r
209 hints.ai_flags = AI_PASSIVE;
\r
211 if( getaddrinfo( bind_ip, port, &hints, &addr_list ) != 0 )
\r
212 return( MBEDTLS_ERR_NET_UNKNOWN_HOST );
\r
214 /* Try the sockaddrs until a binding succeeds */
\r
215 ret = MBEDTLS_ERR_NET_UNKNOWN_HOST;
\r
216 for( cur = addr_list; cur != NULL; cur = cur->ai_next )
\r
218 ctx->fd = (int) socket( cur->ai_family, cur->ai_socktype,
\r
219 cur->ai_protocol );
\r
222 ret = MBEDTLS_ERR_NET_SOCKET_FAILED;
\r
227 if( setsockopt( ctx->fd, SOL_SOCKET, SO_REUSEADDR,
\r
228 (const char *) &n, sizeof( n ) ) != 0 )
\r
231 ret = MBEDTLS_ERR_NET_SOCKET_FAILED;
\r
235 if( bind( ctx->fd, cur->ai_addr, MSVC_INT_CAST cur->ai_addrlen ) != 0 )
\r
238 ret = MBEDTLS_ERR_NET_BIND_FAILED;
\r
242 /* Listen only makes sense for TCP */
\r
243 if( proto == MBEDTLS_NET_PROTO_TCP )
\r
245 if( listen( ctx->fd, MBEDTLS_NET_LISTEN_BACKLOG ) != 0 )
\r
248 ret = MBEDTLS_ERR_NET_LISTEN_FAILED;
\r
253 /* Bind was successful */
\r
258 freeaddrinfo( addr_list );
\r
264 #if ( defined(_WIN32) || defined(_WIN32_WCE) ) && !defined(EFIX64) && \
\r
267 * Check if the requested operation would be blocking on a non-blocking socket
\r
268 * and thus 'failed' with a negative return value.
\r
270 static int net_would_block( const mbedtls_net_context *ctx )
\r
273 return( WSAGetLastError() == WSAEWOULDBLOCK );
\r
277 * Check if the requested operation would be blocking on a non-blocking socket
\r
278 * and thus 'failed' with a negative return value.
\r
280 * Note: on a blocking socket this function always returns 0!
\r
282 static int net_would_block( const mbedtls_net_context *ctx )
\r
287 * Never return 'WOULD BLOCK' on a non-blocking socket
\r
289 if( ( fcntl( ctx->fd, F_GETFL ) & O_NONBLOCK ) != O_NONBLOCK )
\r
295 switch( errno = err )
\r
300 #if defined EWOULDBLOCK && EWOULDBLOCK != EAGAIN
\r
307 #endif /* ( _WIN32 || _WIN32_WCE ) && !EFIX64 && !EFI32 */
\r
310 * Accept a connection from a remote client
\r
312 int mbedtls_net_accept( mbedtls_net_context *bind_ctx,
\r
313 mbedtls_net_context *client_ctx,
\r
314 void *client_ip, size_t buf_size, size_t *ip_len )
\r
319 struct sockaddr_storage client_addr;
\r
321 #if defined(__socklen_t_defined) || defined(_SOCKLEN_T) || \
\r
322 defined(_SOCKLEN_T_DECLARED) || defined(__DEFINED_socklen_t)
\r
323 socklen_t n = (socklen_t) sizeof( client_addr );
\r
324 socklen_t type_len = (socklen_t) sizeof( type );
\r
326 int n = (int) sizeof( client_addr );
\r
327 int type_len = (int) sizeof( type );
\r
330 /* Is this a TCP or UDP socket? */
\r
331 if( getsockopt( bind_ctx->fd, SOL_SOCKET, SO_TYPE,
\r
332 (void *) &type, &type_len ) != 0 ||
\r
333 ( type != SOCK_STREAM && type != SOCK_DGRAM ) )
\r
335 return( MBEDTLS_ERR_NET_ACCEPT_FAILED );
\r
338 if( type == SOCK_STREAM )
\r
340 /* TCP: actual accept() */
\r
341 ret = client_ctx->fd = (int) accept( bind_ctx->fd,
\r
342 (struct sockaddr *) &client_addr, &n );
\r
346 /* UDP: wait for a message, but keep it in the queue */
\r
347 char buf[1] = { 0 };
\r
349 ret = (int) recvfrom( bind_ctx->fd, buf, sizeof( buf ), MSG_PEEK,
\r
350 (struct sockaddr *) &client_addr, &n );
\r
352 #if defined(_WIN32)
\r
353 if( ret == SOCKET_ERROR &&
\r
354 WSAGetLastError() == WSAEMSGSIZE )
\r
356 /* We know buf is too small, thanks, just peeking here */
\r
364 if( net_would_block( bind_ctx ) != 0 )
\r
365 return( MBEDTLS_ERR_SSL_WANT_READ );
\r
367 return( MBEDTLS_ERR_NET_ACCEPT_FAILED );
\r
370 /* UDP: hijack the listening socket to communicate with the client,
\r
371 * then bind a new socket to accept new connections */
\r
372 if( type != SOCK_STREAM )
\r
374 struct sockaddr_storage local_addr;
\r
377 if( connect( bind_ctx->fd, (struct sockaddr *) &client_addr, n ) != 0 )
\r
378 return( MBEDTLS_ERR_NET_ACCEPT_FAILED );
\r
380 client_ctx->fd = bind_ctx->fd;
\r
381 bind_ctx->fd = -1; /* In case we exit early */
\r
383 n = sizeof( struct sockaddr_storage );
\r
384 if( getsockname( client_ctx->fd,
\r
385 (struct sockaddr *) &local_addr, &n ) != 0 ||
\r
386 ( bind_ctx->fd = (int) socket( local_addr.ss_family,
\r
387 SOCK_DGRAM, IPPROTO_UDP ) ) < 0 ||
\r
388 setsockopt( bind_ctx->fd, SOL_SOCKET, SO_REUSEADDR,
\r
389 (const char *) &one, sizeof( one ) ) != 0 )
\r
391 return( MBEDTLS_ERR_NET_SOCKET_FAILED );
\r
394 if( bind( bind_ctx->fd, (struct sockaddr *) &local_addr, n ) != 0 )
\r
396 return( MBEDTLS_ERR_NET_BIND_FAILED );
\r
400 if( client_ip != NULL )
\r
402 if( client_addr.ss_family == AF_INET )
\r
404 struct sockaddr_in *addr4 = (struct sockaddr_in *) &client_addr;
\r
405 *ip_len = sizeof( addr4->sin_addr.s_addr );
\r
407 if( buf_size < *ip_len )
\r
408 return( MBEDTLS_ERR_NET_BUFFER_TOO_SMALL );
\r
410 memcpy( client_ip, &addr4->sin_addr.s_addr, *ip_len );
\r
414 struct sockaddr_in6 *addr6 = (struct sockaddr_in6 *) &client_addr;
\r
415 *ip_len = sizeof( addr6->sin6_addr.s6_addr );
\r
417 if( buf_size < *ip_len )
\r
418 return( MBEDTLS_ERR_NET_BUFFER_TOO_SMALL );
\r
420 memcpy( client_ip, &addr6->sin6_addr.s6_addr, *ip_len);
\r
428 * Set the socket blocking or non-blocking
\r
430 int mbedtls_net_set_block( mbedtls_net_context *ctx )
\r
432 #if ( defined(_WIN32) || defined(_WIN32_WCE) ) && !defined(EFIX64) && \
\r
435 return( ioctlsocket( ctx->fd, FIONBIO, &n ) );
\r
437 return( fcntl( ctx->fd, F_SETFL, fcntl( ctx->fd, F_GETFL ) & ~O_NONBLOCK ) );
\r
441 int mbedtls_net_set_nonblock( mbedtls_net_context *ctx )
\r
443 #if ( defined(_WIN32) || defined(_WIN32_WCE) ) && !defined(EFIX64) && \
\r
446 return( ioctlsocket( ctx->fd, FIONBIO, &n ) );
\r
448 return( fcntl( ctx->fd, F_SETFL, fcntl( ctx->fd, F_GETFL ) | O_NONBLOCK ) );
\r
453 * Check if data is available on the socket
\r
456 int mbedtls_net_poll( mbedtls_net_context *ctx, uint32_t rw, uint32_t timeout )
\r
467 return( MBEDTLS_ERR_NET_INVALID_CONTEXT );
\r
469 #if defined(__has_feature)
\r
470 #if __has_feature(memory_sanitizer)
\r
471 /* Ensure that memory sanitizers consider read_fds and write_fds as
\r
472 * initialized even on platforms such as Glibc/x86_64 where FD_ZERO
\r
473 * is implemented in assembly. */
\r
474 memset( &read_fds, 0, sizeof( read_fds ) );
\r
475 memset( &write_fds, 0, sizeof( write_fds ) );
\r
479 FD_ZERO( &read_fds );
\r
480 if( rw & MBEDTLS_NET_POLL_READ )
\r
482 rw &= ~MBEDTLS_NET_POLL_READ;
\r
483 FD_SET( fd, &read_fds );
\r
486 FD_ZERO( &write_fds );
\r
487 if( rw & MBEDTLS_NET_POLL_WRITE )
\r
489 rw &= ~MBEDTLS_NET_POLL_WRITE;
\r
490 FD_SET( fd, &write_fds );
\r
494 return( MBEDTLS_ERR_NET_BAD_INPUT_DATA );
\r
496 tv.tv_sec = timeout / 1000;
\r
497 tv.tv_usec = ( timeout % 1000 ) * 1000;
\r
501 ret = select( fd + 1, &read_fds, &write_fds, NULL,
\r
502 timeout == (uint32_t) -1 ? NULL : &tv );
\r
504 while( IS_EINTR( ret ) );
\r
507 return( MBEDTLS_ERR_NET_POLL_FAILED );
\r
510 if( FD_ISSET( fd, &read_fds ) )
\r
511 ret |= MBEDTLS_NET_POLL_READ;
\r
512 if( FD_ISSET( fd, &write_fds ) )
\r
513 ret |= MBEDTLS_NET_POLL_WRITE;
\r
519 * Portable usleep helper
\r
521 void mbedtls_net_usleep( unsigned long usec )
\r
523 #if defined(_WIN32)
\r
524 Sleep( ( usec + 999 ) / 1000 );
\r
527 tv.tv_sec = usec / 1000000;
\r
528 #if defined(__unix__) || defined(__unix) || \
\r
529 ( defined(__APPLE__) && defined(__MACH__) )
\r
530 tv.tv_usec = (suseconds_t) usec % 1000000;
\r
532 tv.tv_usec = usec % 1000000;
\r
534 select( 0, NULL, NULL, NULL, &tv );
\r
539 * Read at most 'len' characters
\r
541 int mbedtls_net_recv( void *ctx, unsigned char *buf, size_t len )
\r
544 int fd = ((mbedtls_net_context *) ctx)->fd;
\r
547 return( MBEDTLS_ERR_NET_INVALID_CONTEXT );
\r
549 ret = (int) read( fd, buf, len );
\r
553 if( net_would_block( ctx ) != 0 )
\r
554 return( MBEDTLS_ERR_SSL_WANT_READ );
\r
556 #if ( defined(_WIN32) || defined(_WIN32_WCE) ) && !defined(EFIX64) && \
\r
558 if( WSAGetLastError() == WSAECONNRESET )
\r
559 return( MBEDTLS_ERR_NET_CONN_RESET );
\r
561 if( errno == EPIPE || errno == ECONNRESET )
\r
562 return( MBEDTLS_ERR_NET_CONN_RESET );
\r
564 if( errno == EINTR )
\r
565 return( MBEDTLS_ERR_SSL_WANT_READ );
\r
568 return( MBEDTLS_ERR_NET_RECV_FAILED );
\r
575 * Read at most 'len' characters, blocking for at most 'timeout' ms
\r
577 int mbedtls_net_recv_timeout( void *ctx, unsigned char *buf,
\r
578 size_t len, uint32_t timeout )
\r
583 int fd = ((mbedtls_net_context *) ctx)->fd;
\r
586 return( MBEDTLS_ERR_NET_INVALID_CONTEXT );
\r
588 FD_ZERO( &read_fds );
\r
589 FD_SET( fd, &read_fds );
\r
591 tv.tv_sec = timeout / 1000;
\r
592 tv.tv_usec = ( timeout % 1000 ) * 1000;
\r
594 ret = select( fd + 1, &read_fds, NULL, NULL, timeout == 0 ? NULL : &tv );
\r
596 /* Zero fds ready means we timed out */
\r
598 return( MBEDTLS_ERR_SSL_TIMEOUT );
\r
602 #if ( defined(_WIN32) || defined(_WIN32_WCE) ) && !defined(EFIX64) && \
\r
604 if( WSAGetLastError() == WSAEINTR )
\r
605 return( MBEDTLS_ERR_SSL_WANT_READ );
\r
607 if( errno == EINTR )
\r
608 return( MBEDTLS_ERR_SSL_WANT_READ );
\r
611 return( MBEDTLS_ERR_NET_RECV_FAILED );
\r
614 /* This call will not block */
\r
615 return( mbedtls_net_recv( ctx, buf, len ) );
\r
619 * Write at most 'len' characters
\r
621 int mbedtls_net_send( void *ctx, const unsigned char *buf, size_t len )
\r
624 int fd = ((mbedtls_net_context *) ctx)->fd;
\r
627 return( MBEDTLS_ERR_NET_INVALID_CONTEXT );
\r
629 ret = (int) write( fd, buf, len );
\r
633 if( net_would_block( ctx ) != 0 )
\r
634 return( MBEDTLS_ERR_SSL_WANT_WRITE );
\r
636 #if ( defined(_WIN32) || defined(_WIN32_WCE) ) && !defined(EFIX64) && \
\r
638 if( WSAGetLastError() == WSAECONNRESET )
\r
639 return( MBEDTLS_ERR_NET_CONN_RESET );
\r
641 if( errno == EPIPE || errno == ECONNRESET )
\r
642 return( MBEDTLS_ERR_NET_CONN_RESET );
\r
644 if( errno == EINTR )
\r
645 return( MBEDTLS_ERR_SSL_WANT_WRITE );
\r
648 return( MBEDTLS_ERR_NET_SEND_FAILED );
\r
655 * Gracefully close the connection
\r
657 void mbedtls_net_free( mbedtls_net_context *ctx )
\r
659 if( ctx->fd == -1 )
\r
662 shutdown( ctx->fd, 2 );
\r
668 #endif /* MBEDTLS_NET_C */
\r