2 * Copyright 2016-2022 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
15 * VC configurations may define UNICODE, to indicate to the C RTL that
16 * WCHAR functions are preferred.
17 * This affects functions like gai_strerror(), which is implemented as
18 * an alias macro for gai_strerrorA() (which returns a const char *) or
19 * gai_strerrorW() (which returns a const WCHAR *). This source file
20 * assumes POSIX declarations, so prefer the non-UNICODE definitions.
27 #include "bio_local.h"
28 #include <openssl/crypto.h>
30 #ifndef OPENSSL_NO_SOCK
31 #include <openssl/err.h>
32 #include <openssl/buffer.h>
33 #include "internal/thread_once.h"
35 CRYPTO_RWLOCK *bio_lookup_lock;
36 static CRYPTO_ONCE bio_lookup_init = CRYPTO_ONCE_STATIC_INIT;
39 * Throughout this file and bio_local.h, the existence of the macro
40 * AI_PASSIVE is used to detect the availability of struct addrinfo,
41 * getnameinfo() and getaddrinfo(). If that macro doesn't exist,
42 * we use our own implementation instead, using gethostbyname,
43 * getservbyname and a few other.
46 /**********************************************************************
52 BIO_ADDR *BIO_ADDR_new(void)
54 BIO_ADDR *ret = OPENSSL_zalloc(sizeof(*ret));
57 ERR_raise(ERR_LIB_BIO, ERR_R_MALLOC_FAILURE);
61 ret->sa.sa_family = AF_UNSPEC;
65 void BIO_ADDR_free(BIO_ADDR *ap)
70 BIO_ADDR *BIO_ADDR_dup(const BIO_ADDR *ap)
77 memcpy(ret, ap, sizeof(BIO_ADDR));
82 void BIO_ADDR_clear(BIO_ADDR *ap)
84 memset(ap, 0, sizeof(*ap));
85 ap->sa.sa_family = AF_UNSPEC;
89 * BIO_ADDR_make - non-public routine to fill a BIO_ADDR with the contents
90 * of a struct sockaddr.
92 int BIO_ADDR_make(BIO_ADDR *ap, const struct sockaddr *sa)
94 if (sa->sa_family == AF_INET) {
95 memcpy(&(ap->s_in), sa, sizeof(struct sockaddr_in));
99 if (sa->sa_family == AF_INET6) {
100 memcpy(&(ap->s_in6), sa, sizeof(struct sockaddr_in6));
105 if (sa->sa_family == AF_UNIX) {
106 memcpy(&(ap->s_un), sa, sizeof(struct sockaddr_un));
114 int BIO_ADDR_rawmake(BIO_ADDR *ap, int family,
115 const void *where, size_t wherelen,
119 if (family == AF_UNIX) {
120 if (wherelen + 1 > sizeof(ap->s_un.sun_path))
122 memset(&ap->s_un, 0, sizeof(ap->s_un));
123 ap->s_un.sun_family = family;
124 strncpy(ap->s_un.sun_path, where, sizeof(ap->s_un.sun_path) - 1);
128 if (family == AF_INET) {
129 if (wherelen != sizeof(struct in_addr))
131 memset(&ap->s_in, 0, sizeof(ap->s_in));
132 ap->s_in.sin_family = family;
133 ap->s_in.sin_port = port;
134 ap->s_in.sin_addr = *(struct in_addr *)where;
138 if (family == AF_INET6) {
139 if (wherelen != sizeof(struct in6_addr))
141 memset(&ap->s_in6, 0, sizeof(ap->s_in6));
142 ap->s_in6.sin6_family = family;
143 ap->s_in6.sin6_port = port;
144 ap->s_in6.sin6_addr = *(struct in6_addr *)where;
152 int BIO_ADDR_family(const BIO_ADDR *ap)
154 return ap->sa.sa_family;
157 int BIO_ADDR_rawaddress(const BIO_ADDR *ap, void *p, size_t *l)
160 const void *addrptr = NULL;
162 if (ap->sa.sa_family == AF_INET) {
163 len = sizeof(ap->s_in.sin_addr);
164 addrptr = &ap->s_in.sin_addr;
167 else if (ap->sa.sa_family == AF_INET6) {
168 len = sizeof(ap->s_in6.sin6_addr);
169 addrptr = &ap->s_in6.sin6_addr;
173 else if (ap->sa.sa_family == AF_UNIX) {
174 len = strlen(ap->s_un.sun_path);
175 addrptr = &ap->s_un.sun_path;
183 memcpy(p, addrptr, len);
191 unsigned short BIO_ADDR_rawport(const BIO_ADDR *ap)
193 if (ap->sa.sa_family == AF_INET)
194 return ap->s_in.sin_port;
196 if (ap->sa.sa_family == AF_INET6)
197 return ap->s_in6.sin6_port;
203 * addr_strings - helper function to get host and service names
204 * @ap: the BIO_ADDR that has the input info
205 * @numeric: 0 if actual names should be returned, 1 if the numeric
206 * representation should be returned.
207 * @hostname: a pointer to a pointer to a memory area to store the
208 * host name or numeric representation. Unused if NULL.
209 * @service: a pointer to a pointer to a memory area to store the
210 * service name or numeric representation. Unused if NULL.
212 * The return value is 0 on failure, with the error code in the error
213 * stack, and 1 on success.
215 static int addr_strings(const BIO_ADDR *ap, int numeric,
216 char **hostname, char **service)
218 if (BIO_sock_init() != 1)
224 char host[NI_MAXHOST] = "", serv[NI_MAXSERV] = "";
228 flags |= NI_NUMERICHOST | NI_NUMERICSERV;
230 if ((ret = getnameinfo(BIO_ADDR_sockaddr(ap),
231 BIO_ADDR_sockaddr_size(ap),
232 host, sizeof(host), serv, sizeof(serv),
235 if (ret == EAI_SYSTEM) {
236 ERR_raise_data(ERR_LIB_SYS, get_last_socket_error(),
237 "calling getnameinfo()");
241 ERR_raise_data(ERR_LIB_BIO, ERR_R_SYS_LIB, gai_strerror(ret));
246 /* VMS getnameinfo() has a bug, it doesn't fill in serv, which
247 * leaves it with whatever garbage that happens to be there.
248 * However, we initialise serv with the empty string (serv[0]
249 * is therefore NUL), so it gets real easy to detect when things
250 * didn't go the way one might expect.
252 if (serv[0] == '\0') {
253 BIO_snprintf(serv, sizeof(serv), "%d",
254 ntohs(BIO_ADDR_rawport(ap)));
257 if (hostname != NULL)
258 *hostname = OPENSSL_strdup(host);
260 *service = OPENSSL_strdup(serv);
263 if (hostname != NULL)
264 *hostname = OPENSSL_strdup(inet_ntoa(ap->s_in.sin_addr));
265 if (service != NULL) {
266 char serv[6]; /* port is 16 bits => max 5 decimal digits */
267 BIO_snprintf(serv, sizeof(serv), "%d", ntohs(ap->s_in.sin_port));
268 *service = OPENSSL_strdup(serv);
272 if ((hostname != NULL && *hostname == NULL)
273 || (service != NULL && *service == NULL)) {
274 if (hostname != NULL) {
275 OPENSSL_free(*hostname);
278 if (service != NULL) {
279 OPENSSL_free(*service);
282 ERR_raise(ERR_LIB_BIO, ERR_R_MALLOC_FAILURE);
289 char *BIO_ADDR_hostname_string(const BIO_ADDR *ap, int numeric)
291 char *hostname = NULL;
293 if (addr_strings(ap, numeric, &hostname, NULL))
299 char *BIO_ADDR_service_string(const BIO_ADDR *ap, int numeric)
301 char *service = NULL;
303 if (addr_strings(ap, numeric, NULL, &service))
309 char *BIO_ADDR_path_string(const BIO_ADDR *ap)
312 if (ap->sa.sa_family == AF_UNIX)
313 return OPENSSL_strdup(ap->s_un.sun_path);
319 * BIO_ADDR_sockaddr - non-public routine to return the struct sockaddr
320 * for a given BIO_ADDR. In reality, this is simply a type safe cast.
321 * The returned struct sockaddr is const, so it can't be tampered with.
323 const struct sockaddr *BIO_ADDR_sockaddr(const BIO_ADDR *ap)
329 * BIO_ADDR_sockaddr_noconst - non-public function that does the same
330 * as BIO_ADDR_sockaddr, but returns a non-const. USE WITH CARE, as
331 * it allows you to tamper with the data (and thereby the contents
332 * of the input BIO_ADDR).
334 struct sockaddr *BIO_ADDR_sockaddr_noconst(BIO_ADDR *ap)
340 * BIO_ADDR_sockaddr_size - non-public function that returns the size
341 * of the struct sockaddr the BIO_ADDR is using. If the protocol family
342 * isn't set or is something other than AF_INET, AF_INET6 or AF_UNIX,
343 * the size of the BIO_ADDR type is returned.
345 socklen_t BIO_ADDR_sockaddr_size(const BIO_ADDR *ap)
347 if (ap->sa.sa_family == AF_INET)
348 return sizeof(ap->s_in);
350 if (ap->sa.sa_family == AF_INET6)
351 return sizeof(ap->s_in6);
354 if (ap->sa.sa_family == AF_UNIX)
355 return sizeof(ap->s_un);
360 /**********************************************************************
362 * Address info database
366 const BIO_ADDRINFO *BIO_ADDRINFO_next(const BIO_ADDRINFO *bai)
369 return bai->bai_next;
373 int BIO_ADDRINFO_family(const BIO_ADDRINFO *bai)
376 return bai->bai_family;
380 int BIO_ADDRINFO_socktype(const BIO_ADDRINFO *bai)
383 return bai->bai_socktype;
387 int BIO_ADDRINFO_protocol(const BIO_ADDRINFO *bai)
390 if (bai->bai_protocol != 0)
391 return bai->bai_protocol;
394 if (bai->bai_family == AF_UNIX)
398 switch (bai->bai_socktype) {
411 * BIO_ADDRINFO_sockaddr_size - non-public function that returns the size
412 * of the struct sockaddr inside the BIO_ADDRINFO.
414 socklen_t BIO_ADDRINFO_sockaddr_size(const BIO_ADDRINFO *bai)
417 return bai->bai_addrlen;
422 * BIO_ADDRINFO_sockaddr - non-public function that returns bai_addr
423 * as the struct sockaddr it is.
425 const struct sockaddr *BIO_ADDRINFO_sockaddr(const BIO_ADDRINFO *bai)
428 return bai->bai_addr;
432 const BIO_ADDR *BIO_ADDRINFO_address(const BIO_ADDRINFO *bai)
435 return (BIO_ADDR *)bai->bai_addr;
439 void BIO_ADDRINFO_free(BIO_ADDRINFO *bai)
446 # define _cond bai->bai_family != AF_UNIX
456 /* Free manually when we know that addrinfo_wrap() was used.
457 * See further comment above addrinfo_wrap()
459 while (bai != NULL) {
460 BIO_ADDRINFO *next = bai->bai_next;
461 OPENSSL_free(bai->bai_addr);
467 /**********************************************************************
474 * The specs in hostserv can take these forms:
476 * host:service => *host = "host", *service = "service"
477 * host:* => *host = "host", *service = NULL
478 * host: => *host = "host", *service = NULL
479 * :service => *host = NULL, *service = "service"
480 * *:service => *host = NULL, *service = "service"
482 * in case no : is present in the string, the result depends on
483 * hostserv_prio, as follows:
485 * when hostserv_prio == BIO_PARSE_PRIO_HOST
486 * host => *host = "host", *service untouched
488 * when hostserv_prio == BIO_PARSE_PRIO_SERV
489 * service => *host untouched, *service = "service"
492 int BIO_parse_hostserv(const char *hostserv, char **host, char **service,
493 enum BIO_hostserv_priorities hostserv_prio)
495 const char *h = NULL; size_t hl = 0;
496 const char *p = NULL; size_t pl = 0;
498 if (*hostserv == '[') {
499 if ((p = strchr(hostserv, ']')) == NULL)
513 const char *p2 = strrchr(hostserv, ':');
514 p = strchr(hostserv, ':');
517 * Check for more than one colon. There are three possible
519 * 1. IPv6 address with port number, last colon being separator.
520 * 2. IPv6 address only.
521 * 3. IPv6 address only if hostserv_prio == BIO_PARSE_PRIO_HOST,
522 * IPv6 address and port number if hostserv_prio == BIO_PARSE_PRIO_SERV
523 * Because of this ambiguity, we currently choose to make it an
534 } else if (hostserv_prio == BIO_PARSE_PRIO_HOST) {
543 if (p != NULL && strchr(p, ':'))
546 if (h != NULL && host != NULL) {
548 || (hl == 1 && h[0] == '*')) {
551 *host = OPENSSL_strndup(h, hl);
556 if (p != NULL && service != NULL) {
558 || (pl == 1 && p[0] == '*')) {
561 *service = OPENSSL_strndup(p, pl);
562 if (*service == NULL)
569 ERR_raise(ERR_LIB_BIO, BIO_R_AMBIGUOUS_HOST_OR_SERVICE);
572 ERR_raise(ERR_LIB_BIO, BIO_R_MALFORMED_HOST_OR_SERVICE);
575 ERR_raise(ERR_LIB_BIO, ERR_R_MALLOC_FAILURE);
579 /* addrinfo_wrap is used to build our own addrinfo "chain".
580 * (it has only one entry, so calling it a chain may be a stretch)
581 * It should ONLY be called when getaddrinfo() and friends
582 * aren't available, OR when dealing with a non IP protocol
583 * family, such as AF_UNIX
585 * the return value is 1 on success, or 0 on failure, which
586 * only happens if a memory allocation error occurred.
588 static int addrinfo_wrap(int family, int socktype,
589 const void *where, size_t wherelen,
593 if ((*bai = OPENSSL_zalloc(sizeof(**bai))) == NULL) {
594 ERR_raise(ERR_LIB_BIO, ERR_R_MALLOC_FAILURE);
598 (*bai)->bai_family = family;
599 (*bai)->bai_socktype = socktype;
600 if (socktype == SOCK_STREAM)
601 (*bai)->bai_protocol = IPPROTO_TCP;
602 if (socktype == SOCK_DGRAM)
603 (*bai)->bai_protocol = IPPROTO_UDP;
605 if (family == AF_UNIX)
606 (*bai)->bai_protocol = 0;
609 /* Magic: We know that BIO_ADDR_sockaddr_noconst is really
610 just an advanced cast of BIO_ADDR* to struct sockaddr *
611 by the power of union, so while it may seem that we're
612 creating a memory leak here, we are not. It will be
614 BIO_ADDR *addr = BIO_ADDR_new();
616 BIO_ADDR_rawmake(addr, family, where, wherelen, port);
617 (*bai)->bai_addr = BIO_ADDR_sockaddr_noconst(addr);
620 (*bai)->bai_next = NULL;
621 if ((*bai)->bai_addr == NULL) {
622 BIO_ADDRINFO_free(*bai);
629 DEFINE_RUN_ONCE_STATIC(do_bio_lookup_init)
631 bio_lookup_lock = CRYPTO_THREAD_lock_new();
632 return bio_lookup_lock != NULL;
635 int BIO_lookup(const char *host, const char *service,
636 enum BIO_lookup_type lookup_type,
637 int family, int socktype, BIO_ADDRINFO **res)
639 return BIO_lookup_ex(host, service, lookup_type, family, socktype, 0, res);
643 * BIO_lookup_ex - look up the host and service you want to connect to.
644 * @host: the host (or node, in case family == AF_UNIX) you want to connect to.
645 * @service: the service you want to connect to.
646 * @lookup_type: declare intent with the result, client or server.
647 * @family: the address family you want to use. Use AF_UNSPEC for any, or
648 * AF_INET, AF_INET6 or AF_UNIX.
649 * @socktype: The socket type you want to use. Can be SOCK_STREAM, SOCK_DGRAM
651 * @protocol: The protocol to use, e.g. IPPROTO_TCP or IPPROTO_UDP or 0 for all.
652 * Note that some platforms may not return IPPROTO_SCTP without
653 * explicitly requesting it (i.e. IPPROTO_SCTP may not be returned
654 * with 0 for the protocol)
655 * @res: Storage place for the resulting list of returned addresses
657 * This will do a lookup of the host and service that you want to connect to.
658 * It returns a linked list of different addresses you can try to connect to.
660 * When no longer needed you should call BIO_ADDRINFO_free() to free the result.
662 * The return value is 1 on success or 0 in case of error.
664 int BIO_lookup_ex(const char *host, const char *service, int lookup_type,
665 int family, int socktype, int protocol, BIO_ADDRINFO **res)
667 int ret = 0; /* Assume failure */
682 ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_PROTOCOL_FAMILY);
687 if (family == AF_UNIX) {
688 if (addrinfo_wrap(family, socktype, host, strlen(host), 0, res))
691 ERR_raise(ERR_LIB_BIO, ERR_R_MALLOC_FAILURE);
696 if (BIO_sock_init() != 1)
701 int gai_ret = 0, old_ret = 0;
702 struct addrinfo hints;
704 memset(&hints, 0, sizeof(hints));
706 hints.ai_family = family;
707 hints.ai_socktype = socktype;
708 hints.ai_protocol = protocol;
709 # ifdef AI_ADDRCONFIG
711 if (host != NULL && family == AF_UNSPEC)
713 hints.ai_flags |= AI_ADDRCONFIG;
716 if (lookup_type == BIO_LOOKUP_SERVER)
717 hints.ai_flags |= AI_PASSIVE;
719 /* Note that |res| SHOULD be a 'struct addrinfo **' thanks to
720 * macro magic in bio_local.h
722 # if defined(AI_ADDRCONFIG) && defined(AI_NUMERICHOST)
725 switch ((gai_ret = getaddrinfo(host, service, &hints, res))) {
728 ERR_raise_data(ERR_LIB_SYS, get_last_socket_error(),
729 "calling getaddrinfo()");
730 ERR_raise(ERR_LIB_BIO, ERR_R_SYS_LIB);
735 ERR_raise(ERR_LIB_BIO, ERR_R_MALLOC_FAILURE);
739 ret = 1; /* Success */
742 # if defined(AI_ADDRCONFIG) && defined(AI_NUMERICHOST)
743 if (hints.ai_flags & AI_ADDRCONFIG) {
744 hints.ai_flags &= ~AI_ADDRCONFIG;
745 hints.ai_flags |= AI_NUMERICHOST;
750 ERR_raise_data(ERR_LIB_BIO, ERR_R_SYS_LIB,
751 gai_strerror(old_ret ? old_ret : gai_ret));
756 const struct hostent *he;
758 * Because struct hostent is defined for 32-bit pointers only with
759 * VMS C, we need to make sure that '&he_fallback_address' and
760 * '&he_fallback_addresses' are 32-bit pointers
762 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
763 # pragma pointer_size save
764 # pragma pointer_size 32
766 /* Windows doesn't seem to have in_addr_t */
767 #if defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_MSDOS)
768 static uint32_t he_fallback_address;
769 static const char *he_fallback_addresses[] =
770 { (char *)&he_fallback_address, NULL };
772 static in_addr_t he_fallback_address;
773 static const char *he_fallback_addresses[] =
774 { (char *)&he_fallback_address, NULL };
776 static const struct hostent he_fallback =
777 { NULL, NULL, AF_INET, sizeof(he_fallback_address),
778 (char **)&he_fallback_addresses };
779 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
780 # pragma pointer_size restore
784 /* Apparently, on WIN64, s_proto and s_port have traded places... */
786 struct servent se_fallback = { NULL, NULL, NULL, 0 };
788 struct servent se_fallback = { NULL, NULL, 0, NULL };
791 if (!RUN_ONCE(&bio_lookup_init, do_bio_lookup_init)) {
792 ERR_raise(ERR_LIB_BIO, ERR_R_MALLOC_FAILURE);
797 if (!CRYPTO_THREAD_write_lock(bio_lookup_lock)) {
801 he_fallback_address = INADDR_ANY;
804 switch (lookup_type) {
805 case BIO_LOOKUP_CLIENT:
806 he_fallback_address = INADDR_LOOPBACK;
808 case BIO_LOOKUP_SERVER:
809 he_fallback_address = INADDR_ANY;
812 /* We forgot to handle a lookup type! */
813 assert("We forgot to handle a lookup type!" == NULL);
814 ERR_raise(ERR_LIB_BIO, ERR_R_INTERNAL_ERROR);
819 he = gethostbyname(host);
822 #ifndef OPENSSL_SYS_WINDOWS
824 * This might be misleading, because h_errno is used as if
825 * it was errno. To minimize mixup add 1000. Underlying
826 * reason for this is that hstrerror is declared obsolete,
827 * not to mention that a) h_errno is not always guaranteed
828 * to be meaningless; b) hstrerror can reside in yet another
829 * library, linking for sake of hstrerror is an overkill;
830 * c) this path is not executed on contemporary systems
831 * anyway [above getaddrinfo/gai_strerror is]. We just let
832 * system administrator figure this out...
834 # if defined(OPENSSL_SYS_VXWORKS)
835 /* h_errno doesn't exist on VxWorks */
836 ERR_raise_data(ERR_LIB_SYS, 1000,
837 "calling gethostbyname()");
839 ERR_raise_data(ERR_LIB_SYS, 1000 + h_errno,
840 "calling gethostbyname()");
843 ERR_raise_data(ERR_LIB_SYS, get_last_socket_error(),
844 "calling gethostbyname()");
851 if (service == NULL) {
852 se_fallback.s_port = 0;
853 se_fallback.s_proto = NULL;
857 long portnum = strtol(service, &endp, 10);
860 * Because struct servent is defined for 32-bit pointers only with
861 * VMS C, we need to make sure that 'proto' is a 32-bit pointer.
863 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
864 # pragma pointer_size save
865 # pragma pointer_size 32
868 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
869 # pragma pointer_size restore
881 if (endp != service && *endp == '\0'
882 && portnum > 0 && portnum < 65536) {
883 se_fallback.s_port = htons((unsigned short)portnum);
884 se_fallback.s_proto = proto;
886 } else if (endp == service) {
887 se = getservbyname(service, proto);
890 ERR_raise_data(ERR_LIB_SYS, get_last_socket_error(),
891 "calling getservbyname()");
895 ERR_raise(ERR_LIB_BIO, BIO_R_MALFORMED_HOST_OR_SERVICE);
904 * Because hostent::h_addr_list is an array of 32-bit pointers with VMS C,
905 * we must make sure our iterator designates the same element type, hence
906 * the pointer size dance.
908 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
909 # pragma pointer_size save
910 # pragma pointer_size 32
913 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
914 # pragma pointer_size restore
917 BIO_ADDRINFO *tmp_bai = NULL;
919 /* The easiest way to create a linked list from an
920 array is to start from the back */
921 for (addrlistp = he->h_addr_list; *addrlistp != NULL;
925 for (addresses = addrlistp - he->h_addr_list;
926 addrlistp--, addresses-- > 0; ) {
927 if (!addrinfo_wrap(he->h_addrtype, socktype,
928 *addrlistp, he->h_length,
929 se->s_port, &tmp_bai))
930 goto addrinfo_malloc_err;
931 tmp_bai->bai_next = *res;
935 BIO_ADDRINFO_free(*res);
937 ERR_raise(ERR_LIB_BIO, ERR_R_MALLOC_FAILURE);
945 CRYPTO_THREAD_unlock(bio_lookup_lock);
951 #endif /* OPENSSL_NO_SOCK */