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
13 #include <openssl/crypto.h>
15 #ifndef OPENSSL_NO_SOCK
16 #include <openssl/err.h>
17 #include <openssl/buffer.h>
20 CRYPTO_RWLOCK *bio_lookup_lock;
21 static CRYPTO_ONCE bio_lookup_init = CRYPTO_ONCE_STATIC_INIT;
24 * Throughout this file and bio_lcl.h, the existence of the macro
25 * AI_PASSIVE is used to detect the availability of struct addrinfo,
26 * getnameinfo() and getaddrinfo(). If that macro doesn't exist,
27 * we use our own implementation instead, using gethostbyname,
28 * getservbyname and a few other.
31 /**********************************************************************
37 BIO_ADDR *BIO_ADDR_new(void)
39 BIO_ADDR *ret = OPENSSL_zalloc(sizeof(*ret));
42 BIOerr(BIO_F_BIO_ADDR_NEW, ERR_R_MALLOC_FAILURE);
46 ret->sa.sa_family = AF_UNSPEC;
50 void BIO_ADDR_free(BIO_ADDR *ap)
55 void BIO_ADDR_clear(BIO_ADDR *ap)
57 memset(ap, 0, sizeof(*ap));
58 ap->sa.sa_family = AF_UNSPEC;
62 * BIO_ADDR_make - non-public routine to fill a BIO_ADDR with the contents
63 * of a struct sockaddr.
65 int BIO_ADDR_make(BIO_ADDR *ap, const struct sockaddr *sa)
67 if (sa->sa_family == AF_INET) {
68 ap->s_in = *(const struct sockaddr_in *)sa;
72 if (sa->sa_family == AF_INET6) {
73 ap->s_in6 = *(const struct sockaddr_in6 *)sa;
78 if (ap->sa.sa_family == AF_UNIX) {
79 ap->s_un = *(const struct sockaddr_un *)sa;
87 int BIO_ADDR_rawmake(BIO_ADDR *ap, int family,
88 const void *where, size_t wherelen,
92 if (family == AF_UNIX) {
93 if (wherelen + 1 > sizeof(ap->s_un.sun_path))
95 memset(&ap->s_un, 0, sizeof(ap->s_un));
96 ap->s_un.sun_family = family;
97 strncpy(ap->s_un.sun_path, where, sizeof(ap->s_un.sun_path) - 1);
101 if (family == AF_INET) {
102 if (wherelen != sizeof(struct in_addr))
104 memset(&ap->s_in, 0, sizeof(ap->s_in));
105 ap->s_in.sin_family = family;
106 ap->s_in.sin_port = port;
107 ap->s_in.sin_addr = *(struct in_addr *)where;
111 if (family == AF_INET6) {
112 if (wherelen != sizeof(struct in6_addr))
114 memset(&ap->s_in6, 0, sizeof(ap->s_in6));
115 ap->s_in6.sin6_family = family;
116 ap->s_in6.sin6_port = port;
117 ap->s_in6.sin6_addr = *(struct in6_addr *)where;
125 int BIO_ADDR_family(const BIO_ADDR *ap)
127 return ap->sa.sa_family;
130 int BIO_ADDR_rawaddress(const BIO_ADDR *ap, void *p, size_t *l)
133 const void *addrptr = NULL;
135 if (ap->sa.sa_family == AF_INET) {
136 len = sizeof(ap->s_in.sin_addr);
137 addrptr = &ap->s_in.sin_addr;
140 else if (ap->sa.sa_family == AF_INET6) {
141 len = sizeof(ap->s_in6.sin6_addr);
142 addrptr = &ap->s_in6.sin6_addr;
146 else if (ap->sa.sa_family == AF_UNIX) {
147 len = strlen(ap->s_un.sun_path);
148 addrptr = &ap->s_un.sun_path;
156 memcpy(p, addrptr, len);
164 unsigned short BIO_ADDR_rawport(const BIO_ADDR *ap)
166 if (ap->sa.sa_family == AF_INET)
167 return ap->s_in.sin_port;
169 if (ap->sa.sa_family == AF_INET6)
170 return ap->s_in6.sin6_port;
176 * addr_strings - helper function to get host and service names
177 * @ap: the BIO_ADDR that has the input info
178 * @numeric: 0 if actual names should be returned, 1 if the numeric
179 * representation should be returned.
180 * @hostname: a pointer to a pointer to a memory area to store the
181 * host name or numeric representation. Unused if NULL.
182 * @service: a pointer to a pointer to a memory area to store the
183 * service name or numeric representation. Unused if NULL.
185 * The return value is 0 on failure, with the error code in the error
186 * stack, and 1 on success.
188 static int addr_strings(const BIO_ADDR *ap, int numeric,
189 char **hostname, char **service)
191 if (BIO_sock_init() != 1)
197 char host[NI_MAXHOST] = "", serv[NI_MAXSERV] = "";
201 flags |= NI_NUMERICHOST | NI_NUMERICSERV;
203 if ((ret = getnameinfo(BIO_ADDR_sockaddr(ap),
204 BIO_ADDR_sockaddr_size(ap),
205 host, sizeof(host), serv, sizeof(serv),
208 if (ret == EAI_SYSTEM) {
209 SYSerr(SYS_F_GETNAMEINFO, get_last_socket_error());
210 BIOerr(BIO_F_ADDR_STRINGS, ERR_R_SYS_LIB);
214 BIOerr(BIO_F_ADDR_STRINGS, ERR_R_SYS_LIB);
215 ERR_add_error_data(1, gai_strerror(ret));
220 /* VMS getnameinfo() has a bug, it doesn't fill in serv, which
221 * leaves it with whatever garbage that happens to be there.
222 * However, we initialise serv with the empty string (serv[0]
223 * is therefore NUL), so it gets real easy to detect when things
224 * didn't go the way one might expect.
226 if (serv[0] == '\0') {
227 BIO_snprintf(serv, sizeof(serv), "%d",
228 ntohs(BIO_ADDR_rawport(ap)));
231 if (hostname != NULL)
232 *hostname = OPENSSL_strdup(host);
234 *service = OPENSSL_strdup(serv);
237 if (hostname != NULL)
238 *hostname = OPENSSL_strdup(inet_ntoa(ap->s_in.sin_addr));
239 if (service != NULL) {
240 char serv[6]; /* port is 16 bits => max 5 decimal digits */
241 BIO_snprintf(serv, sizeof(serv), "%d", ntohs(ap->s_in.sin_port));
242 *service = OPENSSL_strdup(serv);
246 if ((hostname != NULL && *hostname == NULL)
247 || (service != NULL && *service == NULL)) {
248 if (hostname != NULL) {
249 OPENSSL_free(*hostname);
252 if (service != NULL) {
253 OPENSSL_free(*service);
256 BIOerr(BIO_F_ADDR_STRINGS, ERR_R_MALLOC_FAILURE);
263 char *BIO_ADDR_hostname_string(const BIO_ADDR *ap, int numeric)
265 char *hostname = NULL;
267 if (addr_strings(ap, numeric, &hostname, NULL))
273 char *BIO_ADDR_service_string(const BIO_ADDR *ap, int numeric)
275 char *service = NULL;
277 if (addr_strings(ap, numeric, NULL, &service))
283 char *BIO_ADDR_path_string(const BIO_ADDR *ap)
286 if (ap->sa.sa_family == AF_UNIX)
287 return OPENSSL_strdup(ap->s_un.sun_path);
293 * BIO_ADDR_sockaddr - non-public routine to return the struct sockaddr
294 * for a given BIO_ADDR. In reality, this is simply a type safe cast.
295 * The returned struct sockaddr is const, so it can't be tampered with.
297 const struct sockaddr *BIO_ADDR_sockaddr(const BIO_ADDR *ap)
303 * BIO_ADDR_sockaddr_noconst - non-public function that does the same
304 * as BIO_ADDR_sockaddr, but returns a non-const. USE WITH CARE, as
305 * it allows you to tamper with the data (and thereby the contents
306 * of the input BIO_ADDR).
308 struct sockaddr *BIO_ADDR_sockaddr_noconst(BIO_ADDR *ap)
314 * BIO_ADDR_sockaddr_size - non-public function that returns the size
315 * of the struct sockaddr the BIO_ADDR is using. If the protocol family
316 * isn't set or is something other than AF_INET, AF_INET6 or AF_UNIX,
317 * the size of the BIO_ADDR type is returned.
319 socklen_t BIO_ADDR_sockaddr_size(const BIO_ADDR *ap)
321 if (ap->sa.sa_family == AF_INET)
322 return sizeof(ap->s_in);
324 if (ap->sa.sa_family == AF_INET6)
325 return sizeof(ap->s_in6);
328 if (ap->sa.sa_family == AF_UNIX)
329 return sizeof(ap->s_un);
334 /**********************************************************************
336 * Address info database
340 const BIO_ADDRINFO *BIO_ADDRINFO_next(const BIO_ADDRINFO *bai)
343 return bai->bai_next;
347 int BIO_ADDRINFO_family(const BIO_ADDRINFO *bai)
350 return bai->bai_family;
354 int BIO_ADDRINFO_socktype(const BIO_ADDRINFO *bai)
357 return bai->bai_socktype;
361 int BIO_ADDRINFO_protocol(const BIO_ADDRINFO *bai)
364 if (bai->bai_protocol != 0)
365 return bai->bai_protocol;
368 if (bai->bai_family == AF_UNIX)
372 switch (bai->bai_socktype) {
385 * BIO_ADDRINFO_sockaddr_size - non-public function that returns the size
386 * of the struct sockaddr inside the BIO_ADDRINFO.
388 socklen_t BIO_ADDRINFO_sockaddr_size(const BIO_ADDRINFO *bai)
391 return bai->bai_addrlen;
396 * BIO_ADDRINFO_sockaddr - non-public function that returns bai_addr
397 * as the struct sockaddr it is.
399 const struct sockaddr *BIO_ADDRINFO_sockaddr(const BIO_ADDRINFO *bai)
402 return bai->bai_addr;
406 const BIO_ADDR *BIO_ADDRINFO_address(const BIO_ADDRINFO *bai)
409 return (BIO_ADDR *)bai->bai_addr;
413 void BIO_ADDRINFO_free(BIO_ADDRINFO *bai)
420 # define _cond bai->bai_family != AF_UNIX
430 /* Free manually when we know that addrinfo_wrap() was used.
431 * See further comment above addrinfo_wrap()
433 while (bai != NULL) {
434 BIO_ADDRINFO *next = bai->bai_next;
435 OPENSSL_free(bai->bai_addr);
441 /**********************************************************************
448 * The specs in hostserv can take these forms:
450 * host:service => *host = "host", *service = "service"
451 * host:* => *host = "host", *service = NULL
452 * host: => *host = "host", *service = NULL
453 * :service => *host = NULL, *service = "service"
454 * *:service => *host = NULL, *service = "service"
456 * in case no : is present in the string, the result depends on
457 * hostserv_prio, as follows:
459 * when hostserv_prio == BIO_PARSE_PRIO_HOST
460 * host => *host = "host", *service untouched
462 * when hostserv_prio == BIO_PARSE_PRIO_SERV
463 * service => *host untouched, *service = "service"
466 int BIO_parse_hostserv(const char *hostserv, char **host, char **service,
467 enum BIO_hostserv_priorities hostserv_prio)
469 const char *h = NULL; size_t hl = 0;
470 const char *p = NULL; size_t pl = 0;
472 if (*hostserv == '[') {
473 if ((p = strchr(hostserv, ']')) == NULL)
487 const char *p2 = strrchr(hostserv, ':');
488 p = strchr(hostserv, ':');
491 * Check for more than one colon. There are three possible
493 * 1. IPv6 address with port number, last colon being separator.
494 * 2. IPv6 address only.
495 * 3. IPv6 address only if hostserv_prio == BIO_PARSE_PRIO_HOST,
496 * IPv6 address and port number if hostserv_prio == BIO_PARSE_PRIO_SERV
497 * Because of this ambiguity, we currently choose to make it an
508 } else if (hostserv_prio == BIO_PARSE_PRIO_HOST) {
517 if (p != NULL && strchr(p, ':'))
520 if (h != NULL && host != NULL) {
522 || (hl == 1 && h[0] == '*')) {
525 *host = OPENSSL_strndup(h, hl);
530 if (p != NULL && service != NULL) {
532 || (pl == 1 && p[0] == '*')) {
535 *service = OPENSSL_strndup(p, pl);
536 if (*service == NULL)
543 BIOerr(BIO_F_BIO_PARSE_HOSTSERV, BIO_R_AMBIGUOUS_HOST_OR_SERVICE);
546 BIOerr(BIO_F_BIO_PARSE_HOSTSERV, BIO_R_MALFORMED_HOST_OR_SERVICE);
549 BIOerr(BIO_F_BIO_PARSE_HOSTSERV, ERR_R_MALLOC_FAILURE);
553 /* addrinfo_wrap is used to build our own addrinfo "chain".
554 * (it has only one entry, so calling it a chain may be a stretch)
555 * It should ONLY be called when getaddrinfo() and friends
556 * aren't available, OR when dealing with a non IP protocol
557 * family, such as AF_UNIX
559 * the return value is 1 on success, or 0 on failure, which
560 * only happens if a memory allocation error occurred.
562 static int addrinfo_wrap(int family, int socktype,
563 const void *where, size_t wherelen,
567 OPENSSL_assert(bai != NULL);
569 *bai = OPENSSL_zalloc(sizeof(**bai));
573 (*bai)->bai_family = family;
574 (*bai)->bai_socktype = socktype;
575 if (socktype == SOCK_STREAM)
576 (*bai)->bai_protocol = IPPROTO_TCP;
577 if (socktype == SOCK_DGRAM)
578 (*bai)->bai_protocol = IPPROTO_UDP;
580 if (family == AF_UNIX)
581 (*bai)->bai_protocol = 0;
584 /* Magic: We know that BIO_ADDR_sockaddr_noconst is really
585 just an advanced cast of BIO_ADDR* to struct sockaddr *
586 by the power of union, so while it may seem that we're
587 creating a memory leak here, we are not. It will be
589 BIO_ADDR *addr = BIO_ADDR_new();
591 BIO_ADDR_rawmake(addr, family, where, wherelen, port);
592 (*bai)->bai_addr = BIO_ADDR_sockaddr_noconst(addr);
595 (*bai)->bai_next = NULL;
596 if ((*bai)->bai_addr == NULL) {
597 BIO_ADDRINFO_free(*bai);
604 static void do_bio_lookup_init(void)
606 bio_lookup_lock = CRYPTO_THREAD_lock_new();
610 * BIO_lookup - look up the node and service you want to connect to.
611 * @node: the node you want to connect to.
612 * @service: the service you want to connect to.
613 * @lookup_type: declare intent with the result, client or server.
614 * @family: the address family you want to use. Use AF_UNSPEC for any, or
615 * AF_INET, AF_INET6 or AF_UNIX.
616 * @socktype: The socket type you want to use. Can be SOCK_STREAM, SOCK_DGRAM
618 * @res: Storage place for the resulting list of returned addresses
620 * This will do a lookup of the node and service that you want to connect to.
621 * It returns a linked list of different addresses you can try to connect to.
623 * When no longer needed you should call BIO_ADDRINFO_free() to free the result.
625 * The return value is 1 on success or 0 in case of error.
627 int BIO_lookup(const char *host, const char *service,
628 enum BIO_lookup_type lookup_type,
629 int family, int socktype, BIO_ADDRINFO **res)
631 int ret = 0; /* Assume failure */
646 BIOerr(BIO_F_BIO_LOOKUP, BIO_R_UNSUPPORTED_PROTOCOL_FAMILY);
651 if (family == AF_UNIX) {
652 if (addrinfo_wrap(family, socktype, host, strlen(host), 0, res))
655 BIOerr(BIO_F_BIO_LOOKUP, ERR_R_MALLOC_FAILURE);
660 if (BIO_sock_init() != 1)
666 struct addrinfo hints;
667 memset(&hints, 0, sizeof hints);
669 # ifdef AI_ADDRCONFIG
670 hints.ai_flags = AI_ADDRCONFIG;
672 hints.ai_family = family;
673 hints.ai_socktype = socktype;
675 if (lookup_type == BIO_LOOKUP_SERVER)
676 hints.ai_flags |= AI_PASSIVE;
678 /* Note that |res| SHOULD be a 'struct addrinfo **' thanks to
679 * macro magic in bio_lcl.h
681 switch ((gai_ret = getaddrinfo(host, service, &hints, res))) {
684 SYSerr(SYS_F_GETADDRINFO, get_last_socket_error());
685 BIOerr(BIO_F_BIO_LOOKUP, ERR_R_SYS_LIB);
689 ret = 1; /* Success */
692 BIOerr(BIO_F_BIO_LOOKUP, ERR_R_SYS_LIB);
693 ERR_add_error_data(1, gai_strerror(gai_ret));
698 const struct hostent *he;
700 * Because struct hostent is defined for 32-bit pointers only with
701 * VMS C, we need to make sure that '&he_fallback_address' and
702 * '&he_fallback_addresses' are 32-bit pointers
704 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
705 # pragma pointer_size save
706 # pragma pointer_size 32
708 /* Windows doesn't seem to have in_addr_t */
709 #ifdef OPENSSL_SYS_WINDOWS
710 static uint32_t he_fallback_address;
711 static const uint32_t *he_fallback_addresses[] =
712 { &he_fallback_address, NULL };
714 static in_addr_t he_fallback_address;
715 static const in_addr_t *he_fallback_addresses[] =
716 { &he_fallback_address, NULL };
718 static const struct hostent he_fallback =
719 { NULL, NULL, AF_INET, sizeof(he_fallback_address),
720 (char **)&he_fallback_addresses };
721 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
722 # pragma pointer_size restore
726 /* Apparently, on WIN64, s_proto and s_port have traded places... */
728 struct servent se_fallback = { NULL, NULL, NULL, 0 };
730 struct servent se_fallback = { NULL, NULL, 0, NULL };
733 CRYPTO_THREAD_run_once(&bio_lookup_init, do_bio_lookup_init);
735 CRYPTO_THREAD_write_lock(bio_lookup_lock);
736 he_fallback_address = INADDR_ANY;
739 switch(lookup_type) {
740 case BIO_LOOKUP_CLIENT:
741 he_fallback_address = INADDR_LOOPBACK;
743 case BIO_LOOKUP_SERVER:
744 he_fallback_address = INADDR_ANY;
747 OPENSSL_assert(("We forgot to handle a lookup type!" == 0));
751 he = gethostbyname(host);
754 #ifndef OPENSSL_SYS_WINDOWS
755 BIOerr(BIO_F_BIO_LOOKUP, ERR_R_SYS_LIB);
756 ERR_add_error_data(1, hstrerror(h_errno));
758 SYSerr(SYS_F_GETHOSTBYNAME, WSAGetLastError());
765 if (service == NULL) {
766 se_fallback.s_port = 0;
767 se_fallback.s_proto = NULL;
771 long portnum = strtol(service, &endp, 10);
774 * Because struct servent is defined for 32-bit pointers only with
775 * VMS C, we need to make sure that 'proto' is a 32-bit pointer.
777 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
778 # pragma pointer_size save
779 # pragma pointer_size 32
782 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
783 # pragma pointer_size restore
795 if (endp != service && *endp == '\0'
796 && portnum > 0 && portnum < 65536) {
797 se_fallback.s_port = htons(portnum);
798 se_fallback.s_proto = proto;
800 } else if (endp == service) {
801 se = getservbyname(service, proto);
804 #ifndef OPENSSL_SYS_WINDOWS
805 BIOerr(BIO_F_BIO_LOOKUP, ERR_R_SYS_LIB);
806 ERR_add_error_data(1, hstrerror(h_errno));
808 SYSerr(SYS_F_GETSERVBYNAME, WSAGetLastError());
813 BIOerr(BIO_F_BIO_LOOKUP, BIO_R_MALFORMED_HOST_OR_SERVICE);
822 * Because hostent::h_addr_list is an array of 32-bit pointers with VMS C,
823 * we must make sure our iterator designates the same element type, hence
824 * the pointer size dance.
826 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
827 # pragma pointer_size save
828 # pragma pointer_size 32
831 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
832 # pragma pointer_size restore
835 BIO_ADDRINFO *tmp_bai = NULL;
837 /* The easiest way to create a linked list from an
838 array is to start from the back */
839 for(addrlistp = he->h_addr_list; *addrlistp != NULL;
843 for(addresses = addrlistp - he->h_addr_list;
844 addrlistp--, addresses-- > 0; ) {
845 if (!addrinfo_wrap(he->h_addrtype, socktype,
846 *addrlistp, he->h_length,
847 se->s_port, &tmp_bai))
848 goto addrinfo_malloc_err;
849 tmp_bai->bai_next = *res;
853 BIO_ADDRINFO_free(*res);
855 BIOerr(BIO_F_BIO_LOOKUP, ERR_R_MALLOC_FAILURE);
863 CRYPTO_THREAD_unlock(bio_lookup_lock);
869 #endif /* OPENSSL_NO_SOCK */