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)));
232 *hostname = OPENSSL_strdup(host);
234 *service = OPENSSL_strdup(serv);
238 *hostname = OPENSSL_strdup(inet_ntoa(ap->s_in.sin_addr));
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);
249 char *BIO_ADDR_hostname_string(const BIO_ADDR *ap, int numeric)
251 char *hostname = NULL;
253 if (addr_strings(ap, numeric, &hostname, NULL))
259 char *BIO_ADDR_service_string(const BIO_ADDR *ap, int numeric)
261 char *service = NULL;
263 if (addr_strings(ap, numeric, NULL, &service))
269 char *BIO_ADDR_path_string(const BIO_ADDR *ap)
272 if (ap->sa.sa_family == AF_UNIX)
273 return OPENSSL_strdup(ap->s_un.sun_path);
279 * BIO_ADDR_sockaddr - non-public routine to return the struct sockaddr
280 * for a given BIO_ADDR. In reality, this is simply a type safe cast.
281 * The returned struct sockaddr is const, so it can't be tampered with.
283 const struct sockaddr *BIO_ADDR_sockaddr(const BIO_ADDR *ap)
289 * BIO_ADDR_sockaddr_noconst - non-public function that does the same
290 * as BIO_ADDR_sockaddr, but returns a non-const. USE WITH CARE, as
291 * it allows you to tamper with the data (and thereby the contents
292 * of the input BIO_ADDR).
294 struct sockaddr *BIO_ADDR_sockaddr_noconst(BIO_ADDR *ap)
300 * BIO_ADDR_sockaddr_size - non-public function that returns the size
301 * of the struct sockaddr the BIO_ADDR is using. If the protocol family
302 * isn't set or is something other than AF_INET, AF_INET6 or AF_UNIX,
303 * the size of the BIO_ADDR type is returned.
305 socklen_t BIO_ADDR_sockaddr_size(const BIO_ADDR *ap)
307 if (ap->sa.sa_family == AF_INET)
308 return sizeof(ap->s_in);
310 if (ap->sa.sa_family == AF_INET6)
311 return sizeof(ap->s_in6);
314 if (ap->sa.sa_family == AF_UNIX)
315 return sizeof(ap->s_un);
320 /**********************************************************************
322 * Address info database
326 const BIO_ADDRINFO *BIO_ADDRINFO_next(const BIO_ADDRINFO *bai)
329 return bai->bai_next;
333 int BIO_ADDRINFO_family(const BIO_ADDRINFO *bai)
336 return bai->bai_family;
340 int BIO_ADDRINFO_socktype(const BIO_ADDRINFO *bai)
343 return bai->bai_socktype;
347 int BIO_ADDRINFO_protocol(const BIO_ADDRINFO *bai)
350 if (bai->bai_protocol != 0)
351 return bai->bai_protocol;
354 if (bai->bai_family == AF_UNIX)
358 switch (bai->bai_socktype) {
371 * BIO_ADDRINFO_sockaddr_size - non-public function that returns the size
372 * of the struct sockaddr inside the BIO_ADDRINFO.
374 socklen_t BIO_ADDRINFO_sockaddr_size(const BIO_ADDRINFO *bai)
377 return bai->bai_addrlen;
382 * BIO_ADDRINFO_sockaddr - non-public function that returns bai_addr
383 * as the struct sockaddr it is.
385 const struct sockaddr *BIO_ADDRINFO_sockaddr(const BIO_ADDRINFO *bai)
388 return bai->bai_addr;
392 const BIO_ADDR *BIO_ADDRINFO_address(const BIO_ADDRINFO *bai)
395 return (BIO_ADDR *)bai->bai_addr;
399 void BIO_ADDRINFO_free(BIO_ADDRINFO *bai)
406 # define _cond bai->bai_family != AF_UNIX
416 /* Free manually when we know that addrinfo_wrap() was used.
417 * See further comment above addrinfo_wrap()
419 while (bai != NULL) {
420 BIO_ADDRINFO *next = bai->bai_next;
421 OPENSSL_free(bai->bai_addr);
427 /**********************************************************************
434 * The specs in hostserv can take these forms:
436 * host:service => *host = "host", *service = "service"
437 * host:* => *host = "host", *service = NULL
438 * host: => *host = "host", *service = NULL
439 * :service => *host = NULL, *service = "service"
440 * *:service => *host = NULL, *service = "service"
442 * in case no : is present in the string, the result depends on
443 * hostserv_prio, as follows:
445 * when hostserv_prio == BIO_PARSE_PRIO_HOST
446 * host => *host = "host", *service untouched
448 * when hostserv_prio == BIO_PARSE_PRIO_SERV
449 * service => *host untouched, *service = "service"
452 int BIO_parse_hostserv(const char *hostserv, char **host, char **service,
453 enum BIO_hostserv_priorities hostserv_prio)
455 const char *h = NULL; size_t hl = 0;
456 const char *p = NULL; size_t pl = 0;
458 if (*hostserv == '[') {
459 if ((p = strchr(hostserv, ']')) == NULL)
473 const char *p2 = strrchr(hostserv, ':');
474 p = strchr(hostserv, ':');
477 * Check for more than one colon. There are three possible
479 * 1. IPv6 address with port number, last colon being separator.
480 * 2. IPv6 address only.
481 * 3. IPv6 address only if hostserv_prio == BIO_PARSE_PRIO_HOST,
482 * IPv6 address and port number if hostserv_prio == BIO_PARSE_PRIO_SERV
483 * Because of this ambiguity, we currently choose to make it an
494 } else if (hostserv_prio == BIO_PARSE_PRIO_HOST) {
503 if (p != NULL && strchr(p, ':'))
506 if (h != NULL && host != NULL) {
508 || (hl == 1 && h[0] == '*')) {
511 *host = OPENSSL_strndup(h, hl);
516 if (p != NULL && service != NULL) {
518 || (pl == 1 && p[0] == '*')) {
521 *service = OPENSSL_strndup(p, pl);
522 if (*service == NULL)
529 BIOerr(BIO_F_BIO_PARSE_HOSTSERV, BIO_R_AMBIGUOUS_HOST_OR_SERVICE);
532 BIOerr(BIO_F_BIO_PARSE_HOSTSERV, BIO_R_MALFORMED_HOST_OR_SERVICE);
535 BIOerr(BIO_F_BIO_PARSE_HOSTSERV, ERR_R_MALLOC_FAILURE);
539 /* addrinfo_wrap is used to build our own addrinfo "chain".
540 * (it has only one entry, so calling it a chain may be a stretch)
541 * It should ONLY be called when getaddrinfo() and friends
542 * aren't available, OR when dealing with a non IP protocol
543 * family, such as AF_UNIX
545 * the return value is 1 on success, or 0 on failure, which
546 * only happens if a memory allocation error occurred.
548 static int addrinfo_wrap(int family, int socktype,
549 const void *where, size_t wherelen,
553 OPENSSL_assert(bai != NULL);
555 *bai = OPENSSL_zalloc(sizeof(**bai));
559 (*bai)->bai_family = family;
560 (*bai)->bai_socktype = socktype;
561 if (socktype == SOCK_STREAM)
562 (*bai)->bai_protocol = IPPROTO_TCP;
563 if (socktype == SOCK_DGRAM)
564 (*bai)->bai_protocol = IPPROTO_UDP;
566 if (family == AF_UNIX)
567 (*bai)->bai_protocol = 0;
570 /* Magic: We know that BIO_ADDR_sockaddr_noconst is really
571 just an advanced cast of BIO_ADDR* to struct sockaddr *
572 by the power of union, so while it may seem that we're
573 creating a memory leak here, we are not. It will be
575 BIO_ADDR *addr = BIO_ADDR_new();
577 BIO_ADDR_rawmake(addr, family, where, wherelen, port);
578 (*bai)->bai_addr = BIO_ADDR_sockaddr_noconst(addr);
581 (*bai)->bai_next = NULL;
582 if ((*bai)->bai_addr == NULL) {
583 BIO_ADDRINFO_free(*bai);
590 static void do_bio_lookup_init(void)
592 bio_lookup_lock = CRYPTO_THREAD_lock_new();
596 * BIO_lookup - look up the node and service you want to connect to.
597 * @node: the node you want to connect to.
598 * @service: the service you want to connect to.
599 * @lookup_type: declare intent with the result, client or server.
600 * @family: the address family you want to use. Use AF_UNSPEC for any, or
601 * AF_INET, AF_INET6 or AF_UNIX.
602 * @socktype: The socket type you want to use. Can be SOCK_STREAM, SOCK_DGRAM
604 * @res: Storage place for the resulting list of returned addresses
606 * This will do a lookup of the node and service that you want to connect to.
607 * It returns a linked list of different addresses you can try to connect to.
609 * When no longer needed you should call BIO_ADDRINFO_free() to free the result.
611 * The return value is 1 on success or 0 in case of error.
613 int BIO_lookup(const char *host, const char *service,
614 enum BIO_lookup_type lookup_type,
615 int family, int socktype, BIO_ADDRINFO **res)
617 int ret = 0; /* Assume failure */
632 BIOerr(BIO_F_BIO_LOOKUP, BIO_R_UNSUPPORTED_PROTOCOL_FAMILY);
637 if (family == AF_UNIX) {
638 if (addrinfo_wrap(family, socktype, host, strlen(host), 0, res))
641 BIOerr(BIO_F_BIO_LOOKUP, ERR_R_MALLOC_FAILURE);
646 if (BIO_sock_init() != 1)
652 struct addrinfo hints;
653 memset(&hints, 0, sizeof hints);
655 # ifdef AI_ADDRCONFIG
656 hints.ai_flags = AI_ADDRCONFIG;
658 hints.ai_family = family;
659 hints.ai_socktype = socktype;
661 if (lookup_type == BIO_LOOKUP_SERVER)
662 hints.ai_flags |= AI_PASSIVE;
664 /* Note that |res| SHOULD be a 'struct addrinfo **' thanks to
665 * macro magic in bio_lcl.h
667 switch ((gai_ret = getaddrinfo(host, service, &hints, res))) {
670 SYSerr(SYS_F_GETADDRINFO, get_last_socket_error());
671 BIOerr(BIO_F_BIO_LOOKUP, ERR_R_SYS_LIB);
675 ret = 1; /* Success */
678 BIOerr(BIO_F_BIO_LOOKUP, ERR_R_SYS_LIB);
679 ERR_add_error_data(1, gai_strerror(gai_ret));
684 const struct hostent *he;
686 * Because struct hostent is defined for 32-bit pointers only with
687 * VMS C, we need to make sure that '&he_fallback_address' and
688 * '&he_fallback_addresses' are 32-bit pointers
690 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
691 # pragma pointer_size save
692 # pragma pointer_size 32
694 /* Windows doesn't seem to have in_addr_t */
695 #ifdef OPENSSL_SYS_WINDOWS
696 static uint32_t he_fallback_address;
697 static const uint32_t *he_fallback_addresses[] =
698 { &he_fallback_address, NULL };
700 static in_addr_t he_fallback_address;
701 static const in_addr_t *he_fallback_addresses[] =
702 { &he_fallback_address, NULL };
704 static const struct hostent he_fallback =
705 { NULL, NULL, AF_INET, sizeof(he_fallback_address),
706 (char **)&he_fallback_addresses };
707 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
708 # pragma pointer_size restore
712 /* Apparently, on WIN64, s_proto and s_port have traded places... */
714 struct servent se_fallback = { NULL, NULL, NULL, 0 };
716 struct servent se_fallback = { NULL, NULL, 0, NULL };
719 CRYPTO_THREAD_run_once(&bio_lookup_init, do_bio_lookup_init);
721 CRYPTO_THREAD_write_lock(bio_lookup_lock);
722 he_fallback_address = INADDR_ANY;
725 switch(lookup_type) {
726 case BIO_LOOKUP_CLIENT:
727 he_fallback_address = INADDR_LOOPBACK;
729 case BIO_LOOKUP_SERVER:
730 he_fallback_address = INADDR_ANY;
733 OPENSSL_assert(("We forgot to handle a lookup type!" == 0));
737 he = gethostbyname(host);
740 #ifndef OPENSSL_SYS_WINDOWS
741 BIOerr(BIO_F_BIO_LOOKUP, ERR_R_SYS_LIB);
742 ERR_add_error_data(1, hstrerror(h_errno));
744 SYSerr(SYS_F_GETHOSTBYNAME, WSAGetLastError());
751 if (service == NULL) {
752 se_fallback.s_port = 0;
753 se_fallback.s_proto = NULL;
757 long portnum = strtol(service, &endp, 10);
760 * Because struct servent is defined for 32-bit pointers only with
761 * VMS C, we need to make sure that 'proto' is a 32-bit pointer.
763 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
764 # pragma pointer_size save
765 # pragma pointer_size 32
768 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
769 # pragma pointer_size restore
781 if (endp != service && *endp == '\0'
782 && portnum > 0 && portnum < 65536) {
783 se_fallback.s_port = htons(portnum);
784 se_fallback.s_proto = proto;
786 } else if (endp == service) {
787 se = getservbyname(service, proto);
790 #ifndef OPENSSL_SYS_WINDOWS
791 BIOerr(BIO_F_BIO_LOOKUP, ERR_R_SYS_LIB);
792 ERR_add_error_data(1, hstrerror(h_errno));
794 SYSerr(SYS_F_GETSERVBYNAME, WSAGetLastError());
799 BIOerr(BIO_F_BIO_LOOKUP, BIO_R_MALFORMED_HOST_OR_SERVICE);
808 * Because hostent::h_addr_list is an array of 32-bit pointers with VMS C,
809 * we must make sure our iterator designates the same element type, hence
810 * the pointer size dance.
812 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
813 # pragma pointer_size save
814 # pragma pointer_size 32
817 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
818 # pragma pointer_size restore
821 BIO_ADDRINFO *tmp_bai = NULL;
823 /* The easiest way to create a linked list from an
824 array is to start from the back */
825 for(addrlistp = he->h_addr_list; *addrlistp != NULL;
829 for(addresses = addrlistp - he->h_addr_list;
830 addrlistp--, addresses-- > 0; ) {
831 if (!addrinfo_wrap(he->h_addrtype, socktype,
832 *addrlistp, he->h_length,
833 se->s_port, &tmp_bai))
834 goto addrinfo_malloc_err;
835 tmp_bai->bai_next = *res;
839 BIO_ADDRINFO_free(*res);
841 BIOerr(BIO_F_BIO_LOOKUP, ERR_R_MALLOC_FAILURE);
849 CRYPTO_THREAD_unlock(bio_lookup_lock);
855 #endif /* OPENSSL_NO_SOCK */