crypto/bio/b_sock2.c

   1 /*
   2  * Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   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
   8  */
   9
  10 #include <stdio.h>
  11 #include <stdlib.h>
  12 #include <errno.h>
  13
  14 #include "bio_lcl.h"
  15
  16 #include <openssl/err.h>
  17
  18 #ifndef OPENSSL_NO_SOCK
  19 # ifdef SO_MAXCONN
  20 #  define MAX_LISTEN  SO_MAXCONN
  21 # elif defined(SOMAXCONN)
  22 #  define MAX_LISTEN  SOMAXCONN
  23 # else
  24 #  define MAX_LISTEN  32
  25 # endif
  26
  27 /*-
  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)
  33  *
  34  * Creates a socket.  This should be called before calling any
  35  * of BIO_connect and BIO_listen.
  36  *
  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.
  39  */
  40 int BIO_socket(int domain, int socktype, int protocol, int options)
  41 {
  42     int sock = -1;
  43
  44     if (BIO_sock_init() != 1)
  45         return INVALID_SOCKET;
  46
  47     sock = socket(domain, socktype, protocol);
  48     if (sock == -1) {
  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;
  52     }
  53
  54     return sock;
  55 }
  56
  57 /*-
  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
  62  *
  63  * Connects to the address using the given socket and options.
  64  *
  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.
  69  *
  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.
  73  *
  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.
  76  */
  77 int BIO_connect(int sock, const BIO_ADDR *addr, int options)
  78 {
  79     const int on = 1;
  80
  81     if (sock == -1) {
  82         BIOerr(BIO_F_BIO_CONNECT, BIO_R_INVALID_SOCKET);
  83         return 0;
  84     }
  85
  86     if (!BIO_socket_nbio(sock, (options & BIO_SOCK_NONBLOCK) != 0))
  87         return 0;
  88
  89     if (options & BIO_SOCK_KEEPALIVE) {
  90         if (setsockopt(sock, SOL_SOCKET, SO_KEEPALIVE,
  91                        (const void *)&on, sizeof(on)) != 0) {
  92             SYSerr(SYS_F_SETSOCKOPT, get_last_socket_error());
  93             BIOerr(BIO_F_BIO_CONNECT, BIO_R_UNABLE_TO_KEEPALIVE);
  94             return 0;
  95         }
  96     }
  97
  98     if (options & BIO_SOCK_NODELAY) {
  99         if (setsockopt(sock, IPPROTO_TCP, TCP_NODELAY,
 100                        (const void *)&on, sizeof(on)) != 0) {
 101             SYSerr(SYS_F_SETSOCKOPT, get_last_socket_error());
 102             BIOerr(BIO_F_BIO_CONNECT, BIO_R_UNABLE_TO_NODELAY);
 103             return 0;
 104         }
 105     }
 106
 107     if (connect(sock, BIO_ADDR_sockaddr(addr),
 108                 BIO_ADDR_sockaddr_size(addr)) == -1) {
 109         if (!BIO_sock_should_retry(-1)) {
 110             SYSerr(SYS_F_CONNECT, get_last_socket_error());
 111             BIOerr(BIO_F_BIO_CONNECT, BIO_R_CONNECT_ERROR);
 112         }
 113         return 0;
 114     }
 115     return 1;
 116 }
 117
 118 /*-
 119  * BIO_bind - bind socket to address
 120  * @sock: the socket to set
 121  * @addr: local address to bind to
 122  * @options: BIO socket options
 123  *
 124  * Binds to the address using the given socket and options.
 125  *
 126  * Options can be a combination of the following:
 127  * - BIO_SOCK_REUSEADDR: Try to reuse the address and port combination
 128  *   for a recently closed port.
 129  *
 130  * When restarting the program it could be that the port is still in use.  If
 131  * you set to BIO_SOCK_REUSEADDR option it will try to reuse the port anyway.
 132  * It's recommended that you use this.
 133  */
 134 int BIO_bind(int sock, const BIO_ADDR *addr, int options)
 135 {
 136     int on = 1;
 137
 138     if (sock == -1) {
 139         BIOerr(BIO_F_BIO_BIND, BIO_R_INVALID_SOCKET);
 140         return 0;
 141     }
 142
 143 # ifndef OPENSSL_SYS_WINDOWS
 144     /*
 145      * SO_REUSEADDR has different behavior on Windows than on
 146      * other operating systems, don't set it there.
 147      */
 148     if (options & BIO_SOCK_REUSEADDR) {
 149         if (setsockopt(sock, SOL_SOCKET, SO_REUSEADDR,
 150                        (const void *)&on, sizeof(on)) != 0) {
 151             SYSerr(SYS_F_SETSOCKOPT, get_last_socket_error());
 152             BIOerr(BIO_F_BIO_BIND, BIO_R_UNABLE_TO_REUSEADDR);
 153             return 0;
 154         }
 155     }
 156 # endif
 157
 158     if (bind(sock, BIO_ADDR_sockaddr(addr), BIO_ADDR_sockaddr_size(addr)) != 0) {
 159         SYSerr(SYS_F_BIND, get_last_socket_error());
 160         BIOerr(BIO_F_BIO_BIND, BIO_R_UNABLE_TO_BIND_SOCKET);
 161         return 0;
 162     }
 163
 164     return 1;
 165 }
 166
 167 /*-
 168  * BIO_listen - Creates a listen socket
 169  * @sock: the socket to listen with
 170  * @addr: local address to bind to
 171  * @options: BIO socket options
 172  *
 173  * Binds to the address using the given socket and options, then
 174  * starts listening for incoming connections.
 175  *
 176  * Options can be a combination of the following:
 177  * - BIO_SOCK_KEEPALIVE: enable regularly sending keep-alive messages.
 178  * - BIO_SOCK_NONBLOCK: Make the socket non-blocking.
 179  * - BIO_SOCK_NODELAY: don't delay small messages.
 180  * - BIO_SOCK_REUSEADDR: Try to reuse the address and port combination
 181  *   for a recently closed port.
 182  * - BIO_SOCK_V6_ONLY: When creating an IPv6 socket, make it listen only
 183  *   for IPv6 addresses and not IPv4 addresses mapped to IPv6.
 184  *
 185  * It's recommended that you set up both an IPv6 and IPv4 listen socket, and
 186  * then check both for new clients that connect to it.  You want to set up
 187  * the socket as non-blocking in that case since else it could hang.
 188  *
 189  * Not all operating systems support IPv4 addresses on an IPv6 socket, and for
 190  * others it's an option.  If you pass the BIO_LISTEN_V6_ONLY it will try to
 191  * create the IPv6 sockets to only listen for IPv6 connection.
 192  *
 193  * It could be that the first BIO_listen() call will listen to all the IPv6
 194  * and IPv4 addresses and that then trying to bind to the IPv4 address will
 195  * fail.  We can't tell the difference between already listening ourself to
 196  * it and someone else listening to it when failing and errno is EADDRINUSE, so
 197  * it's recommended to not give an error in that case if the first call was
 198  * successful.
 199  *
 200  * When restarting the program it could be that the port is still in use.  If
 201  * you set to BIO_SOCK_REUSEADDR option it will try to reuse the port anyway.
 202  * It's recommended that you use this.
 203  */
 204 int BIO_listen(int sock, const BIO_ADDR *addr, int options)
 205 {
 206     int on = 1;
 207     int socktype;
 208     socklen_t socktype_len = sizeof(socktype);
 209
 210     if (sock == -1) {
 211         BIOerr(BIO_F_BIO_LISTEN, BIO_R_INVALID_SOCKET);
 212         return 0;
 213     }
 214
 215     if (getsockopt(sock, SOL_SOCKET, SO_TYPE,
 216                    (void *)&socktype, &socktype_len) != 0
 217         || socktype_len != sizeof(socktype)) {
 218         SYSerr(SYS_F_GETSOCKOPT, get_last_socket_error());
 219         BIOerr(BIO_F_BIO_LISTEN, BIO_R_GETTING_SOCKTYPE);
 220         return 0;
 221     }
 222
 223     if (!BIO_socket_nbio(sock, (options & BIO_SOCK_NONBLOCK) != 0))
 224         return 0;
 225
 226     if (options & BIO_SOCK_KEEPALIVE) {
 227         if (setsockopt(sock, SOL_SOCKET, SO_KEEPALIVE,
 228                        (const void *)&on, sizeof(on)) != 0) {
 229             SYSerr(SYS_F_SETSOCKOPT, get_last_socket_error());
 230             BIOerr(BIO_F_BIO_LISTEN, BIO_R_UNABLE_TO_KEEPALIVE);
 231             return 0;
 232         }
 233     }
 234
 235     if (options & BIO_SOCK_NODELAY) {
 236         if (setsockopt(sock, IPPROTO_TCP, TCP_NODELAY,
 237                        (const void *)&on, sizeof(on)) != 0) {
 238             SYSerr(SYS_F_SETSOCKOPT, get_last_socket_error());
 239             BIOerr(BIO_F_BIO_LISTEN, BIO_R_UNABLE_TO_NODELAY);
 240             return 0;
 241         }
 242     }
 243
 244 # ifdef IPV6_V6ONLY
 245     if (BIO_ADDR_family(addr) == AF_INET6) {
 246         /*
 247          * Note: Windows default of IPV6_V6ONLY is ON, and Linux is OFF.
 248          * Therefore we always have to use setsockopt here.
 249          */
 250         on = options & BIO_SOCK_V6_ONLY ? 1 : 0;
 251         if (setsockopt(sock, IPPROTO_IPV6, IPV6_V6ONLY,
 252                        (const void *)&on, sizeof(on)) != 0) {
 253             SYSerr(SYS_F_SETSOCKOPT, get_last_socket_error());
 254             BIOerr(BIO_F_BIO_LISTEN, BIO_R_LISTEN_V6_ONLY);
 255             return 0;
 256         }
 257     }
 258 # endif
 259
 260     if (!BIO_bind(sock, addr, options))
 261         return 0;
 262
 263     if (socktype != SOCK_DGRAM && listen(sock, MAX_LISTEN) == -1) {
 264         SYSerr(SYS_F_LISTEN, get_last_socket_error());
 265         BIOerr(BIO_F_BIO_LISTEN, BIO_R_UNABLE_TO_LISTEN_SOCKET);
 266         return 0;
 267     }
 268
 269     return 1;
 270 }
 271
 272 /*-
 273  * BIO_accept_ex - Accept new incoming connections
 274  * @sock: the listening socket
 275  * @addr: the BIO_ADDR to store the peer address in
 276  * @options: BIO socket options, applied on the accepted socket.
 277  *
 278  */
 279 int BIO_accept_ex(int accept_sock, BIO_ADDR *addr_, int options)
 280 {
 281     socklen_t len;
 282     int accepted_sock;
 283     BIO_ADDR locaddr;
 284     BIO_ADDR *addr = addr_ == NULL ? &locaddr : addr_;
 285
 286     len = sizeof(*addr);
 287     accepted_sock = accept(accept_sock,
 288                            BIO_ADDR_sockaddr_noconst(addr), &len);
 289     if (accepted_sock == -1) {
 290         if (!BIO_sock_should_retry(accepted_sock)) {
 291             SYSerr(SYS_F_ACCEPT, get_last_socket_error());
 292             BIOerr(BIO_F_BIO_ACCEPT_EX, BIO_R_ACCEPT_ERROR);
 293         }
 294         return INVALID_SOCKET;
 295     }
 296
 297     if (!BIO_socket_nbio(accepted_sock, (options & BIO_SOCK_NONBLOCK) != 0)) {
 298         closesocket(accepted_sock);
 299         return INVALID_SOCKET;
 300     }
 301
 302     return accepted_sock;
 303 }
 304
 305 /*-
 306  * BIO_closesocket - Close a socket
 307  * @sock: the socket to close
 308  */
 309 int BIO_closesocket(int sock)
 310 {
 311     if (closesocket(sock) < 0)
 312         return 0;
 313     return 1;
 314 }
 315 #endif