1 /* ====================================================================
2 * Copyright (c) 2015 The OpenSSL Project. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in
13 * the documentation and/or other materials provided with the
16 * 3. All advertising materials mentioning features or use of this
17 * software must display the following acknowledgment:
18 * "This product includes software developed by the OpenSSL Project
19 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
21 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22 * endorse or promote products derived from this software without
23 * prior written permission. For written permission, please contact
24 * openssl-core@openssl.org.
26 * 5. Products derived from this software may not be called "OpenSSL"
27 * nor may "OpenSSL" appear in their names without prior written
28 * permission of the OpenSSL Project.
30 * 6. Redistributions of any form whatsoever must retain the following
32 * "This product includes software developed by the OpenSSL Project
33 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
35 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46 * OF THE POSSIBILITY OF SUCH DAMAGE.
47 * ====================================================================
49 * This product includes cryptographic software written by Eric Young
50 * (eay@cryptsoft.com). This product includes software written by Tim
51 * Hudson (tjh@cryptsoft.com).
59 #include <openssl/err.h>
60 #include <openssl/buffer.h>
63 * Throughout this file and bio_lcl.h, the existence of the macro
64 * AI_PASSIVE is used to detect the availability of struct addrinfo,
65 * getnameinfo() and getaddrinfo(). If that macro doesn't exist,
66 * we use our own implementation instead, using gethostbyname,
67 * getservbyname and a few other.
70 /**********************************************************************
76 BIO_ADDR *BIO_ADDR_new(void)
78 BIO_ADDR *ret = (BIO_ADDR *)OPENSSL_zalloc(sizeof(BIO_ADDR));
79 ret->sa.sa_family = AF_UNSPEC;
83 void BIO_ADDR_free(BIO_ADDR *ap)
88 void BIO_ADDR_clear(BIO_ADDR *ap)
90 memset(ap, 0, sizeof(*ap));
91 ap->sa.sa_family = AF_UNSPEC;
95 * BIO_ADDR_make - non-public routine to fill a BIO_ADDR with the contents
96 * of a struct sockaddr.
98 int BIO_ADDR_make(BIO_ADDR *ap, const struct sockaddr *sa)
100 if (sa->sa_family == AF_INET) {
101 ap->sin = *(const struct sockaddr_in *)sa;
105 if (sa->sa_family == AF_INET6) {
106 ap->sin6 = *(const struct sockaddr_in6 *)sa;
111 if (ap->sa.sa_family == AF_UNIX) {
112 ap->sun = *(const struct sockaddr_un *)sa;
120 int BIO_ADDR_rawmake(BIO_ADDR *ap, int family,
121 const void *where, size_t wherelen,
125 if (family == AF_UNIX) {
126 if (wherelen + 1 > sizeof(ap->sun.sun_path))
128 memset(&ap->sun, 0, sizeof(ap->sun));
129 ap->sun.sun_family = family;
130 strncpy(ap->sun.sun_path, where, sizeof(ap->sun.sun_path) - 1);
134 if (family == AF_INET) {
135 if (wherelen != sizeof(struct in_addr))
137 memset(&ap->sin, 0, sizeof(ap->sin));
138 ap->sin.sin_family = family;
139 ap->sin.sin_port = port;
140 ap->sin.sin_addr = *(struct in_addr *)where;
144 if (family == AF_INET6) {
145 if (wherelen != sizeof(struct in6_addr))
147 memset(&ap->sin6, 0, sizeof(ap->sin6));
148 ap->sin6.sin6_family = family;
149 ap->sin6.sin6_port = port;
150 ap->sin6.sin6_addr = *(struct in6_addr *)where;
158 int BIO_ADDR_family(const BIO_ADDR *ap)
160 return ap->sa.sa_family;
163 int BIO_ADDR_rawaddress(const BIO_ADDR *ap, void *p, size_t *l)
166 const void *addrptr = NULL;
168 if (ap->sa.sa_family == AF_INET) {
169 len = sizeof(ap->sin.sin_addr);
170 addrptr = &ap->sin.sin_addr;
173 else if (ap->sa.sa_family == AF_INET6) {
174 len = sizeof(ap->sin6.sin6_addr);
175 addrptr = &ap->sin6.sin6_addr;
179 else if (ap->sa.sa_family == AF_UNIX) {
180 len = strlen(ap->sun.sun_path);
181 addrptr = &ap->sun.sun_path;
189 memcpy(p, addrptr, len);
197 unsigned short BIO_ADDR_rawport(const BIO_ADDR *ap)
199 if (ap->sa.sa_family == AF_INET)
200 return ap->sin.sin_port;
202 if (ap->sa.sa_family == AF_INET6)
203 return ap->sin6.sin6_port;
209 * addr_strings - helper function to get host and service names
210 * @ap: the BIO_ADDR that has the input info
211 * @numeric: 0 if actual names should be returned, 1 if the numeric
212 * representation should be returned.
213 * @hostname: a pointer to a pointer to a memory area to store the
214 * host name or numeric representation. Unused if NULL.
215 * @service: a pointer to a pointer to a memory area to store the
216 * service name or numeric representation. Unused if NULL.
218 * The return value is 0 on failure, with the error code in the error
219 * stack, and 1 on success.
221 static int addr_strings(const BIO_ADDR *ap, int numeric,
222 char **hostname, char **service)
224 if (BIO_sock_init() != 1)
230 char host[NI_MAXHOST], serv[NI_MAXSERV];
234 flags |= NI_NUMERICHOST | NI_NUMERICSERV;
236 if ((ret = getnameinfo(BIO_ADDR_sockaddr(ap),
237 BIO_ADDR_sockaddr_size(ap),
238 host, sizeof(host), serv, sizeof(serv),
241 if (ret == EAI_SYSTEM) {
242 SYSerr(SYS_F_GETNAMEINFO, get_last_socket_error());
243 BIOerr(BIO_F_ADDR_STRINGS, ERR_R_SYS_LIB);
247 BIOerr(BIO_F_ADDR_STRINGS, ERR_R_SYS_LIB);
248 ERR_add_error_data(1, gai_strerror(ret));
253 *hostname = OPENSSL_strdup(host);
255 *service = OPENSSL_strdup(serv);
259 *hostname = OPENSSL_strdup(inet_ntoa(ap->sin.sin_addr));
261 char serv[6]; /* port is 16 bits => max 5 decimal digits */
262 BIO_snprintf(serv, sizeof(serv), "%d", ntohs(ap->sin.sin_port));
263 *service = OPENSSL_strdup(serv);
270 char *BIO_ADDR_hostname_string(const BIO_ADDR *ap, int numeric)
272 char *hostname = NULL;
274 if (addr_strings(ap, numeric, &hostname, NULL))
280 char *BIO_ADDR_service_string(const BIO_ADDR *ap, int numeric)
282 char *service = NULL;
284 if (addr_strings(ap, numeric, NULL, &service))
290 char *BIO_ADDR_path_string(const BIO_ADDR *ap)
293 if (ap->sa.sa_family == AF_UNIX)
294 return OPENSSL_strdup(ap->sun.sun_path);
300 * BIO_ADDR_sockaddr - non-public routine to return the struct sockaddr
301 * for a given BIO_ADDR. In reality, this is simply a type safe cast.
302 * The returned struct sockaddr is const, so it can't be tampered with.
304 const struct sockaddr *BIO_ADDR_sockaddr(const BIO_ADDR *ap)
310 * BIO_ADDR_sockaddr_noconst - non-public function that does the same
311 * as BIO_ADDR_sockaddr, but returns a non-const. USE WITH CARE, as
312 * it allows you to tamper with the data (and thereby the contents
313 * of the input BIO_ADDR).
315 struct sockaddr *BIO_ADDR_sockaddr_noconst(BIO_ADDR *ap)
321 * BIO_ADDR_sockaddr_size - non-public function that returns the size
322 * of the struct sockaddr the BIO_ADDR is using. If the protocol family
323 * isn't set or is something other than AF_INET, AF_INET6 or AF_UNIX,
324 * the size of the BIO_ADDR type is returned.
326 socklen_t BIO_ADDR_sockaddr_size(const BIO_ADDR *ap)
328 if (ap->sa.sa_family == AF_INET)
329 return sizeof(ap->sin);
331 if (ap->sa.sa_family == AF_INET6)
332 return sizeof(ap->sin6);
335 if (ap->sa.sa_family == AF_UNIX)
336 return sizeof(ap->sun);
341 /**********************************************************************
343 * Address into database
347 const BIO_ADDRINFO *BIO_ADDRINFO_next(const BIO_ADDRINFO *bai)
350 return bai->bai_next;
354 int BIO_ADDRINFO_family(const BIO_ADDRINFO *bai)
357 return bai->bai_family;
361 int BIO_ADDRINFO_socktype(const BIO_ADDRINFO *bai)
364 return bai->bai_socktype;
368 int BIO_ADDRINFO_protocol(const BIO_ADDRINFO *bai)
371 return bai->bai_protocol;
376 * BIO_ADDRINFO_sockaddr_size - non-public function that returns the size
377 * of the struct sockaddr inside the BIO_ADDRINFO.
379 socklen_t BIO_ADDRINFO_sockaddr_size(const BIO_ADDRINFO *bai)
382 return bai->bai_addrlen;
387 * BIO_ADDRINFO_sockaddr - non-public function that returns bai_addr
388 * as the struct sockaddr it is.
390 const struct sockaddr *BIO_ADDRINFO_sockaddr(const BIO_ADDRINFO *bai)
393 return bai->bai_addr;
397 const BIO_ADDR *BIO_ADDRINFO_address(const BIO_ADDRINFO *bai)
400 return (BIO_ADDR *)bai->bai_addr;
404 void BIO_ADDRINFO_free(BIO_ADDRINFO *bai)
411 # define _cond bai->bai_family != AF_UNIX
421 /* Free manually when we know that addrinfo_wrap() was used.
422 * See further comment above addrinfo_wrap()
424 while (bai != NULL) {
425 BIO_ADDRINFO *next = bai->bai_next;
426 OPENSSL_free(bai->bai_addr);
432 /**********************************************************************
439 * The specs in hostserv can take these forms:
441 * host:service => *host = "host", *service = "service"
442 * host:* => *host = "host", *service = NULL
443 * host: => *host = "host", *service = NULL
444 * :service => *host = NULL, *service = "service"
445 * *:service => *host = NULL, *service = "service"
447 * in case no : is present in the string, the result depends on
448 * hostserv_prio, as follows:
450 * when hostserv_prio == BIO_PARSE_PRIO_HOST
451 * host => *host = "host", *service untouched
453 * when hostserv_prio == BIO_PARSE_PRIO_SERV
454 * service => *host untouched, *service = "service"
457 int BIO_parse_hostserv(const char *hostserv, char **host, char **service,
458 enum BIO_hostserv_priorities hostserv_prio)
460 const char *h = NULL; size_t hl = 0;
461 const char *p = NULL; size_t pl = 0;
463 if (*hostserv == '[') {
464 if ((p = strchr(hostserv, ']')) == NULL)
478 const char *p2 = strrchr(hostserv, ':');
479 p = strchr(hostserv, ':');
482 * Check for more than one colon. There are three possible
484 * 1. IPv6 address with port number, last colon being separator.
485 * 2. IPv6 address only.
486 * 3. IPv6 address only if hostserv_prio == BIO_PARSE_PRIO_HOST,
487 * IPv6 address and port number if hostserv_prio == BIO_PARSE_PRIO_SERV
488 * Because of this ambiguity, we currently choose to make it an
499 } else if (hostserv_prio == BIO_PARSE_PRIO_HOST) {
508 if (p != NULL && strchr(p, ':'))
511 if (h != NULL && host != NULL) {
513 || (hl == 1 && h[0] == '*')) {
516 *host = OPENSSL_strndup(h, hl);
521 if (p != NULL && service != NULL) {
523 || (pl == 1 && p[0] == '*')) {
526 *service = OPENSSL_strndup(p, pl);
527 if (*service == NULL)
534 BIOerr(BIO_F_BIO_PARSE_HOSTSERV, BIO_R_AMBIGUOUS_HOST_OR_SERVICE);
537 BIOerr(BIO_F_BIO_PARSE_HOSTSERV, BIO_R_MALFORMED_HOST_OR_SERVICE);
540 BIOerr(BIO_F_BIO_PARSE_HOSTSERV, ERR_R_MALLOC_FAILURE);
544 /* addrinfo_wrap is used to build our own addrinfo "chain".
545 * (it has only one entry, so calling it a chain may be a stretch)
546 * It should ONLY be called when getaddrinfo() and friends
547 * aren't available, OR when dealing with a non IP protocol
548 * family, such as AF_UNIX
550 * the return value is 1 on success, or 0 on failure, which
551 * only happens if a memory allocation error occured.
553 static int addrinfo_wrap(int family, int socktype,
554 const void *where, size_t wherelen,
558 OPENSSL_assert(bai != NULL);
560 *bai = (BIO_ADDRINFO *)OPENSSL_zalloc(sizeof(**bai));
564 (*bai)->bai_family = family;
565 (*bai)->bai_socktype = socktype;
566 if (socktype == SOCK_STREAM)
567 (*bai)->bai_protocol = IPPROTO_TCP;
568 if (socktype == SOCK_DGRAM)
569 (*bai)->bai_protocol = IPPROTO_UDP;
571 if (family == AF_UNIX)
572 (*bai)->bai_protocol = 0;
575 /* Magic: We know that BIO_ADDR_sockaddr_noconst is really
576 just an advanced cast of BIO_ADDR* to struct sockaddr *
577 by the power of union, so while it may seem that we're
578 creating a memory leak here, we are not. It will be
580 BIO_ADDR *addr = BIO_ADDR_new();
582 BIO_ADDR_rawmake(addr, family, where, wherelen, port);
583 (*bai)->bai_addr = BIO_ADDR_sockaddr_noconst(addr);
586 (*bai)->bai_next = NULL;
587 if ((*bai)->bai_addr == NULL) {
588 BIO_ADDRINFO_free(*bai);
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;
655 # ifdef AI_ADDRCONFIG
656 hints.ai_flags = AI_ADDRCONFIG;
658 hints.ai_family = family;
659 hints.ai_socktype = socktype;
660 hints.ai_protocol = 0;
661 hints.ai_addrlen = 0;
662 hints.ai_addr = NULL;
663 hints.ai_canonname = NULL;
664 hints.ai_next = NULL;
666 if (lookup_type == BIO_LOOKUP_SERVER)
667 hints.ai_flags |= AI_PASSIVE;
669 /* Note that |res| SHOULD be a 'struct addrinfo **' thanks to
670 * macro magic in bio_lcl.h
672 switch ((gai_ret = getaddrinfo(host, service, &hints, res))) {
675 SYSerr(SYS_F_GETADDRINFO, get_last_socket_error());
676 BIOerr(BIO_F_BIO_LOOKUP, ERR_R_SYS_LIB);
680 ret = 1; /* Success */
683 BIOerr(BIO_F_BIO_LOOKUP, ERR_R_SYS_LIB);
684 ERR_add_error_data(1, gai_strerror(gai_ret));
689 const struct hostent *he;
690 /* Windows doesn't seem to have in_addr_t */
691 #ifdef OPENSSL_SYS_WINDOWS
692 static uint32_t he_fallback_address;
693 static const uint32_t *he_fallback_addresses[] =
694 { &he_fallback_address, NULL };
696 static in_addr_t he_fallback_address;
697 static const in_addr_t *he_fallback_addresses[] =
698 { &he_fallback_address, NULL };
700 static const struct hostent he_fallback =
701 { NULL, NULL, AF_INET, sizeof(he_fallback_address),
702 (char **)&he_fallback_addresses };
704 /* Apprently, on WIN64, s_proto and s_port have traded places... */
706 struct servent se_fallback = { NULL, NULL, NULL, 0 };
708 struct servent se_fallback = { NULL, NULL, 0, NULL };
712 CRYPTO_w_lock(CRYPTO_LOCK_GETHOSTBYNAME);
713 CRYPTO_w_lock(CRYPTO_LOCK_GETSERVBYNAME);
714 he_fallback_address = INADDR_ANY;
717 switch(lookup_type) {
718 case BIO_LOOKUP_CLIENT:
719 he_fallback_address = INADDR_LOOPBACK;
721 case BIO_LOOKUP_SERVER:
722 he_fallback_address = INADDR_ANY;
725 OPENSSL_assert(("We forgot to handle a lookup type!" == 0));
729 he = gethostbyname(host);
732 #ifndef OPENSSL_SYS_WINDOWS
733 BIOerr(BIO_F_BIO_LOOKUP, ERR_R_SYS_LIB);
734 ERR_add_error_data(1, hstrerror(h_errno));
736 SYSerr(SYS_F_GETHOSTBYNAME, WSAGetLastError());
743 if (service == NULL) {
744 se_fallback.s_port = 0;
745 se_fallback.s_proto = proto;
749 long portnum = strtol(service, &endp, 10);
751 if (endp != service && *endp == '\0'
752 && portnum > 0 && portnum < 65536) {
753 se_fallback.s_port = htons(portnum);
754 se_fallback.s_proto = proto;
756 } else if (endp == service) {
765 se = getservbyname(service, proto);
768 #ifndef OPENSSL_SYS_WINDOWS
769 BIOerr(BIO_F_BIO_LOOKUP, ERR_R_SYS_LIB);
770 ERR_add_error_data(1, hstrerror(h_errno));
772 SYSerr(SYS_F_GETSERVBYNAME, WSAGetLastError());
777 BIOerr(BIO_F_BIO_LOOKUP, BIO_R_MALFORMED_HOST_OR_SERVICE);
787 BIO_ADDRINFO *tmp_bai = NULL;
789 /* The easiest way to create a linked list from an
790 array is to start from the back */
791 for(addrlistp = he->h_addr_list; *addrlistp != NULL;
795 for(addresses = addrlistp - he->h_addr_list;
796 addrlistp--, addresses-- > 0; ) {
797 if (!addrinfo_wrap(he->h_addrtype, socktype,
798 *addrlistp, he->h_length,
799 se->s_port, &tmp_bai))
800 goto addrinfo_malloc_err;
801 tmp_bai->bai_next = *res;
805 BIO_ADDRINFO_free(*res);
807 BIOerr(BIO_F_BIO_LOOKUP, ERR_R_MALLOC_FAILURE);
815 CRYPTO_w_unlock(CRYPTO_LOCK_GETSERVBYNAME);
816 CRYPTO_w_unlock(CRYPTO_LOCK_GETHOSTBYNAME);