2 * Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (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 SYSerr(SYS_F_SOCKET, get_last_socket_error());
50 BIOerr(BIO_F_BIO_SOCKET, BIO_R_UNABLE_TO_CREATE_SOCKET);
51 return INVALID_SOCKET;
58 * BIO_connect - connect to an address
59 * @sock: the socket to connect with
60 * @addr: the address to connect to
61 * @options: BIO socket options
63 * Connects to the address using the given socket and options.
65 * Options can be a combination of the following:
66 * - BIO_SOCK_KEEPALIVE: enable regularly sending keep-alive messages.
67 * - BIO_SOCK_NONBLOCK: Make the socket non-blocking.
68 * - BIO_SOCK_NODELAY: don't delay small messages.
70 * options holds BIO socket options that can be used
71 * You should call this for every address returned by BIO_lookup
72 * until the connection is successful.
74 * Returns 1 on success or 0 on failure. On failure errno is set
75 * and an error status is added to the OpenSSL error stack.
77 int BIO_connect(int sock, const BIO_ADDR *addr, int options)
82 BIOerr(BIO_F_BIO_CONNECT, BIO_R_INVALID_SOCKET);
86 if (!BIO_socket_nbio(sock, (options & BIO_SOCK_NONBLOCK) != 0))
89 if (options & BIO_SOCK_KEEPALIVE) {
90 if (setsockopt(sock, SOL_SOCKET, SO_KEEPALIVE, &on, sizeof(on)) != 0) {
91 SYSerr(SYS_F_SETSOCKOPT, get_last_socket_error());
92 BIOerr(BIO_F_BIO_CONNECT, BIO_R_UNABLE_TO_KEEPALIVE);
97 if (options & BIO_SOCK_NODELAY) {
98 if (setsockopt(sock, IPPROTO_TCP, TCP_NODELAY, &on, sizeof(on)) != 0) {
99 SYSerr(SYS_F_SETSOCKOPT, get_last_socket_error());
100 BIOerr(BIO_F_BIO_CONNECT, BIO_R_UNABLE_TO_NODELAY);
105 if (connect(sock, BIO_ADDR_sockaddr(addr),
106 BIO_ADDR_sockaddr_size(addr)) == -1) {
107 if (!BIO_sock_should_retry(-1)) {
108 SYSerr(SYS_F_CONNECT, get_last_socket_error());
109 BIOerr(BIO_F_BIO_CONNECT, BIO_R_CONNECT_ERROR);
117 * BIO_listen - Creates a listen socket
118 * @sock: the socket to listen with
119 * @addr: local address to bind to
120 * @options: BIO socket options
122 * Binds to the address using the given socket and options, then
123 * starts listening for incoming connections.
125 * Options can be a combination of the following:
126 * - BIO_SOCK_KEEPALIVE: enable regularly sending keep-alive messages.
127 * - BIO_SOCK_NONBLOCK: Make the socket non-blocking.
128 * - BIO_SOCK_NODELAY: don't delay small messages.
129 * - BIO_SOCK_REUSEADDR: Try to reuse the address and port combination
130 * for a recently closed port.
131 * - BIO_SOCK_V6_ONLY: When creating an IPv6 socket, make it listen only
132 * for IPv6 addresses and not IPv4 addresses mapped to IPv6.
134 * It's recommended that you set up both an IPv6 and IPv4 listen socket, and
135 * then check both for new clients that connect to it. You want to set up
136 * the socket as non-blocking in that case since else it could hang.
138 * Not all operating systems support IPv4 addresses on an IPv6 socket, and for
139 * others it's an option. If you pass the BIO_LISTEN_V6_ONLY it will try to
140 * create the IPv6 sockets to only listen for IPv6 connection.
142 * It could be that the first BIO_listen() call will listen to all the IPv6
143 * and IPv4 addresses and that then trying to bind to the IPv4 address will
144 * fail. We can't tell the difference between already listening ourself to
145 * it and someone else listening to it when failing and errno is EADDRINUSE, so
146 * it's recommended to not give an error in that case if the first call was
149 * When restarting the program it could be that the port is still in use. If
150 * you set to BIO_SOCK_REUSEADDR option it will try to reuse the port anyway.
151 * It's recommended that you use this.
153 int BIO_listen(int sock, const BIO_ADDR *addr, int options)
157 socklen_t socktype_len = sizeof(socktype);
160 BIOerr(BIO_F_BIO_LISTEN, BIO_R_INVALID_SOCKET);
164 if (getsockopt(sock, SOL_SOCKET, SO_TYPE, &socktype, &socktype_len) != 0
165 || socktype_len != sizeof(socktype)) {
166 SYSerr(SYS_F_GETSOCKOPT, get_last_socket_error());
167 BIOerr(BIO_F_BIO_LISTEN, BIO_R_GETTING_SOCKTYPE);
171 if (!BIO_socket_nbio(sock, (options & BIO_SOCK_NONBLOCK) != 0))
174 # ifndef OPENSSL_SYS_WINDOWS
175 /* SO_REUSEADDR has different behavior on Windows than on
176 * other operating systems, don't set it there. */
177 if (options & BIO_SOCK_REUSEADDR) {
178 if (setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on)) != 0) {
179 SYSerr(SYS_F_SETSOCKOPT, get_last_socket_error());
180 BIOerr(BIO_F_BIO_LISTEN, BIO_R_UNABLE_TO_REUSEADDR);
186 if (options & BIO_SOCK_KEEPALIVE) {
187 if (setsockopt(sock, SOL_SOCKET, SO_KEEPALIVE, &on, sizeof(on)) != 0) {
188 SYSerr(SYS_F_SETSOCKOPT, get_last_socket_error());
189 BIOerr(BIO_F_BIO_LISTEN, BIO_R_UNABLE_TO_KEEPALIVE);
194 if (options & BIO_SOCK_NODELAY) {
195 if (setsockopt(sock, IPPROTO_TCP, TCP_NODELAY, &on, sizeof(on)) != 0) {
196 SYSerr(SYS_F_SETSOCKOPT, get_last_socket_error());
197 BIOerr(BIO_F_BIO_LISTEN, BIO_R_UNABLE_TO_NODELAY);
203 if ((options & BIO_SOCK_V6_ONLY) && BIO_ADDR_family(addr) == AF_INET6) {
204 if (setsockopt(sock, IPPROTO_IPV6, IPV6_V6ONLY, &on, sizeof(on)) != 0) {
205 SYSerr(SYS_F_SETSOCKOPT, get_last_socket_error());
206 BIOerr(BIO_F_BIO_LISTEN, BIO_R_LISTEN_V6_ONLY);
212 if (bind(sock, BIO_ADDR_sockaddr(addr), BIO_ADDR_sockaddr_size(addr)) != 0) {
213 SYSerr(SYS_F_BIND, get_last_socket_error());
214 BIOerr(BIO_F_BIO_LISTEN, BIO_R_UNABLE_TO_BIND_SOCKET);
218 if (socktype != SOCK_DGRAM && listen(sock, MAX_LISTEN) == -1) {
219 SYSerr(SYS_F_LISTEN, get_last_socket_error());
220 BIOerr(BIO_F_BIO_LISTEN, BIO_R_UNABLE_TO_LISTEN_SOCKET);
228 * BIO_accept_ex - Accept new incoming connections
229 * @sock: the listening socket
230 * @addr: the BIO_ADDR to store the peer address in
231 * @options: BIO socket options, applied on the accepted socket.
234 int BIO_accept_ex(int accept_sock, BIO_ADDR *addr_, int options)
239 BIO_ADDR *addr = addr_ == NULL ? &locaddr : addr_;
242 accepted_sock = accept(accept_sock,
243 BIO_ADDR_sockaddr_noconst(addr), &len);
244 if (accepted_sock == -1) {
245 if (!BIO_sock_should_retry(accepted_sock)) {
246 SYSerr(SYS_F_ACCEPT, get_last_socket_error());
247 BIOerr(BIO_F_BIO_ACCEPT_EX, BIO_R_ACCEPT_ERROR);
249 return INVALID_SOCKET;
252 if (!BIO_socket_nbio(accepted_sock, (options & BIO_SOCK_NONBLOCK) != 0)) {
253 closesocket(accepted_sock);
254 return INVALID_SOCKET;
257 return accepted_sock;
261 * BIO_closesocket - Close a socket
262 * @sock: the socket to close
264 int BIO_closesocket(int sock)
266 if (closesocket(sock) < 0)