2 * Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
16 #include <openssl/err.h>
18 #ifndef OPENSSL_NO_SOCK
20 # define MAX_LISTEN SO_MAXCONN
21 # elif defined(SOMAXCONN)
22 # define MAX_LISTEN SOMAXCONN
24 # define MAX_LISTEN 32
28 * BIO_socket - create a socket
29 * @domain: the socket domain (AF_INET, AF_INET6, AF_UNIX, ...)
30 * @socktype: the socket type (SOCK_STEAM, SOCK_DGRAM)
31 * @protocol: the protocol to use (IPPROTO_TCP, IPPROTO_UDP)
32 * @options: BIO socket options (currently unused)
34 * Creates a socket. This should be called before calling any
35 * of BIO_connect and BIO_listen.
37 * Returns the file descriptor on success or INVALID_SOCKET on failure. On
38 * failure errno is set, and a status is added to the OpenSSL error stack.
40 int BIO_socket(int domain
, int socktype
, int protocol
, int options
)
44 if (BIO_sock_init() != 1)
45 return INVALID_SOCKET
;
47 sock
= socket(domain
, socktype
, protocol
);
49 ERR_raise_data(ERR_LIB_SYS
, get_last_socket_error(),
51 BIOerr(BIO_F_BIO_SOCKET
, BIO_R_UNABLE_TO_CREATE_SOCKET
);
52 return INVALID_SOCKET
;
59 * BIO_connect - connect to an address
60 * @sock: the socket to connect with
61 * @addr: the address to connect to
62 * @options: BIO socket options
64 * Connects to the address using the given socket and options.
66 * Options can be a combination of the following:
67 * - BIO_SOCK_KEEPALIVE: enable regularly sending keep-alive messages.
68 * - BIO_SOCK_NONBLOCK: Make the socket non-blocking.
69 * - BIO_SOCK_NODELAY: don't delay small messages.
71 * options holds BIO socket options that can be used
72 * You should call this for every address returned by BIO_lookup
73 * until the connection is successful.
75 * Returns 1 on success or 0 on failure. On failure errno is set
76 * and an error status is added to the OpenSSL error stack.
78 int BIO_connect(int sock
, const BIO_ADDR
*addr
, int options
)
83 BIOerr(BIO_F_BIO_CONNECT
, BIO_R_INVALID_SOCKET
);
87 if (!BIO_socket_nbio(sock
, (options
& BIO_SOCK_NONBLOCK
) != 0))
90 if (options
& BIO_SOCK_KEEPALIVE
) {
91 if (setsockopt(sock
, SOL_SOCKET
, SO_KEEPALIVE
,
92 (const void *)&on
, sizeof(on
)) != 0) {
93 ERR_raise_data(ERR_LIB_SYS
, get_last_socket_error(),
94 "calling setsockopt()");
95 BIOerr(BIO_F_BIO_CONNECT
, BIO_R_UNABLE_TO_KEEPALIVE
);
100 if (options
& BIO_SOCK_NODELAY
) {
101 if (setsockopt(sock
, IPPROTO_TCP
, TCP_NODELAY
,
102 (const void *)&on
, sizeof(on
)) != 0) {
103 ERR_raise_data(ERR_LIB_SYS
, get_last_socket_error(),
104 "calling setsockopt()");
105 BIOerr(BIO_F_BIO_CONNECT
, BIO_R_UNABLE_TO_NODELAY
);
110 if (connect(sock
, BIO_ADDR_sockaddr(addr
),
111 BIO_ADDR_sockaddr_size(addr
)) == -1) {
112 if (!BIO_sock_should_retry(-1)) {
113 ERR_raise_data(ERR_LIB_SYS
, get_last_socket_error(),
114 "calling connect()");
115 BIOerr(BIO_F_BIO_CONNECT
, BIO_R_CONNECT_ERROR
);
123 * BIO_bind - bind socket to address
124 * @sock: the socket to set
125 * @addr: local address to bind to
126 * @options: BIO socket options
128 * Binds to the address using the given socket and options.
130 * Options can be a combination of the following:
131 * - BIO_SOCK_REUSEADDR: Try to reuse the address and port combination
132 * for a recently closed port.
134 * When restarting the program it could be that the port is still in use. If
135 * you set to BIO_SOCK_REUSEADDR option it will try to reuse the port anyway.
136 * It's recommended that you use this.
138 int BIO_bind(int sock
, const BIO_ADDR
*addr
, int options
)
140 # ifndef OPENSSL_SYS_WINDOWS
145 BIOerr(BIO_F_BIO_BIND
, BIO_R_INVALID_SOCKET
);
149 # ifndef OPENSSL_SYS_WINDOWS
151 * SO_REUSEADDR has different behavior on Windows than on
152 * other operating systems, don't set it there.
154 if (options
& BIO_SOCK_REUSEADDR
) {
155 if (setsockopt(sock
, SOL_SOCKET
, SO_REUSEADDR
,
156 (const void *)&on
, sizeof(on
)) != 0) {
157 ERR_raise_data(ERR_LIB_SYS
, get_last_socket_error(),
158 "calling setsockopt()");
159 BIOerr(BIO_F_BIO_BIND
, BIO_R_UNABLE_TO_REUSEADDR
);
165 if (bind(sock
, BIO_ADDR_sockaddr(addr
), BIO_ADDR_sockaddr_size(addr
)) != 0) {
166 ERR_raise_data(ERR_LIB_SYS
, get_last_socket_error(),
168 BIOerr(BIO_F_BIO_BIND
, BIO_R_UNABLE_TO_BIND_SOCKET
);
176 * BIO_listen - Creates a listen socket
177 * @sock: the socket to listen with
178 * @addr: local address to bind to
179 * @options: BIO socket options
181 * Binds to the address using the given socket and options, then
182 * starts listening for incoming connections.
184 * Options can be a combination of the following:
185 * - BIO_SOCK_KEEPALIVE: enable regularly sending keep-alive messages.
186 * - BIO_SOCK_NONBLOCK: Make the socket non-blocking.
187 * - BIO_SOCK_NODELAY: don't delay small messages.
188 * - BIO_SOCK_REUSEADDR: Try to reuse the address and port combination
189 * for a recently closed port.
190 * - BIO_SOCK_V6_ONLY: When creating an IPv6 socket, make it listen only
191 * for IPv6 addresses and not IPv4 addresses mapped to IPv6.
193 * It's recommended that you set up both an IPv6 and IPv4 listen socket, and
194 * then check both for new clients that connect to it. You want to set up
195 * the socket as non-blocking in that case since else it could hang.
197 * Not all operating systems support IPv4 addresses on an IPv6 socket, and for
198 * others it's an option. If you pass the BIO_LISTEN_V6_ONLY it will try to
199 * create the IPv6 sockets to only listen for IPv6 connection.
201 * It could be that the first BIO_listen() call will listen to all the IPv6
202 * and IPv4 addresses and that then trying to bind to the IPv4 address will
203 * fail. We can't tell the difference between already listening ourself to
204 * it and someone else listening to it when failing and errno is EADDRINUSE, so
205 * it's recommended to not give an error in that case if the first call was
208 * When restarting the program it could be that the port is still in use. If
209 * you set to BIO_SOCK_REUSEADDR option it will try to reuse the port anyway.
210 * It's recommended that you use this.
212 int BIO_listen(int sock
, const BIO_ADDR
*addr
, int options
)
216 socklen_t socktype_len
= sizeof(socktype
);
219 BIOerr(BIO_F_BIO_LISTEN
, BIO_R_INVALID_SOCKET
);
223 if (getsockopt(sock
, SOL_SOCKET
, SO_TYPE
,
224 (void *)&socktype
, &socktype_len
) != 0
225 || socktype_len
!= sizeof(socktype
)) {
226 ERR_raise_data(ERR_LIB_SYS
, get_last_socket_error(),
227 "calling getsockopt()");
228 BIOerr(BIO_F_BIO_LISTEN
, BIO_R_GETTING_SOCKTYPE
);
232 if (!BIO_socket_nbio(sock
, (options
& BIO_SOCK_NONBLOCK
) != 0))
235 if (options
& BIO_SOCK_KEEPALIVE
) {
236 if (setsockopt(sock
, SOL_SOCKET
, SO_KEEPALIVE
,
237 (const void *)&on
, sizeof(on
)) != 0) {
238 ERR_raise_data(ERR_LIB_SYS
, get_last_socket_error(),
239 "calling setsockopt()");
240 BIOerr(BIO_F_BIO_LISTEN
, BIO_R_UNABLE_TO_KEEPALIVE
);
245 if (options
& BIO_SOCK_NODELAY
) {
246 if (setsockopt(sock
, IPPROTO_TCP
, TCP_NODELAY
,
247 (const void *)&on
, sizeof(on
)) != 0) {
248 ERR_raise_data(ERR_LIB_SYS
, get_last_socket_error(),
249 "calling setsockopt()");
250 BIOerr(BIO_F_BIO_LISTEN
, BIO_R_UNABLE_TO_NODELAY
);
256 if (BIO_ADDR_family(addr
) == AF_INET6
) {
258 * Note: Windows default of IPV6_V6ONLY is ON, and Linux is OFF.
259 * Therefore we always have to use setsockopt here.
261 on
= options
& BIO_SOCK_V6_ONLY
? 1 : 0;
262 if (setsockopt(sock
, IPPROTO_IPV6
, IPV6_V6ONLY
,
263 (const void *)&on
, sizeof(on
)) != 0) {
264 ERR_raise_data(ERR_LIB_SYS
, get_last_socket_error(),
265 "calling setsockopt()");
266 BIOerr(BIO_F_BIO_LISTEN
, BIO_R_LISTEN_V6_ONLY
);
272 if (!BIO_bind(sock
, addr
, options
))
275 if (socktype
!= SOCK_DGRAM
&& listen(sock
, MAX_LISTEN
) == -1) {
276 ERR_raise_data(ERR_LIB_SYS
, get_last_socket_error(),
278 BIOerr(BIO_F_BIO_LISTEN
, BIO_R_UNABLE_TO_LISTEN_SOCKET
);
286 * BIO_accept_ex - Accept new incoming connections
287 * @sock: the listening socket
288 * @addr: the BIO_ADDR to store the peer address in
289 * @options: BIO socket options, applied on the accepted socket.
292 int BIO_accept_ex(int accept_sock
, BIO_ADDR
*addr_
, int options
)
297 BIO_ADDR
*addr
= addr_
== NULL
? &locaddr
: addr_
;
300 accepted_sock
= accept(accept_sock
,
301 BIO_ADDR_sockaddr_noconst(addr
), &len
);
302 if (accepted_sock
== -1) {
303 if (!BIO_sock_should_retry(accepted_sock
)) {
304 ERR_raise_data(ERR_LIB_SYS
, get_last_socket_error(),
306 BIOerr(BIO_F_BIO_ACCEPT_EX
, BIO_R_ACCEPT_ERROR
);
308 return INVALID_SOCKET
;
311 if (!BIO_socket_nbio(accepted_sock
, (options
& BIO_SOCK_NONBLOCK
) != 0)) {
312 closesocket(accepted_sock
);
313 return INVALID_SOCKET
;
316 return accepted_sock
;
320 * BIO_closesocket - Close a socket
321 * @sock: the socket to close
323 int BIO_closesocket(int sock
)
325 if (closesocket(sock
) < 0)