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
= OPENSSL_zalloc(sizeof(*ret
));
80 ret
->sa
.sa_family
= AF_UNSPEC
;
84 void BIO_ADDR_free(BIO_ADDR
*ap
)
89 void BIO_ADDR_clear(BIO_ADDR
*ap
)
91 memset(ap
, 0, sizeof(*ap
));
92 ap
->sa
.sa_family
= AF_UNSPEC
;
96 * BIO_ADDR_make - non-public routine to fill a BIO_ADDR with the contents
97 * of a struct sockaddr.
99 int BIO_ADDR_make(BIO_ADDR
*ap
, const struct sockaddr
*sa
)
101 if (sa
->sa_family
== AF_INET
) {
102 ap
->sin
= *(const struct sockaddr_in
*)sa
;
106 if (sa
->sa_family
== AF_INET6
) {
107 ap
->sin6
= *(const struct sockaddr_in6
*)sa
;
112 if (ap
->sa
.sa_family
== AF_UNIX
) {
113 ap
->sun
= *(const struct sockaddr_un
*)sa
;
121 int BIO_ADDR_rawmake(BIO_ADDR
*ap
, int family
,
122 const void *where
, size_t wherelen
,
126 if (family
== AF_UNIX
) {
127 if (wherelen
+ 1 > sizeof(ap
->sun
.sun_path
))
129 memset(&ap
->sun
, 0, sizeof(ap
->sun
));
130 ap
->sun
.sun_family
= family
;
131 strncpy(ap
->sun
.sun_path
, where
, sizeof(ap
->sun
.sun_path
) - 1);
135 if (family
== AF_INET
) {
136 if (wherelen
!= sizeof(struct in_addr
))
138 memset(&ap
->sin
, 0, sizeof(ap
->sin
));
139 ap
->sin
.sin_family
= family
;
140 ap
->sin
.sin_port
= port
;
141 ap
->sin
.sin_addr
= *(struct in_addr
*)where
;
145 if (family
== AF_INET6
) {
146 if (wherelen
!= sizeof(struct in6_addr
))
148 memset(&ap
->sin6
, 0, sizeof(ap
->sin6
));
149 ap
->sin6
.sin6_family
= family
;
150 ap
->sin6
.sin6_port
= port
;
151 ap
->sin6
.sin6_addr
= *(struct in6_addr
*)where
;
159 int BIO_ADDR_family(const BIO_ADDR
*ap
)
161 return ap
->sa
.sa_family
;
164 int BIO_ADDR_rawaddress(const BIO_ADDR
*ap
, void *p
, size_t *l
)
167 const void *addrptr
= NULL
;
169 if (ap
->sa
.sa_family
== AF_INET
) {
170 len
= sizeof(ap
->sin
.sin_addr
);
171 addrptr
= &ap
->sin
.sin_addr
;
174 else if (ap
->sa
.sa_family
== AF_INET6
) {
175 len
= sizeof(ap
->sin6
.sin6_addr
);
176 addrptr
= &ap
->sin6
.sin6_addr
;
180 else if (ap
->sa
.sa_family
== AF_UNIX
) {
181 len
= strlen(ap
->sun
.sun_path
);
182 addrptr
= &ap
->sun
.sun_path
;
190 memcpy(p
, addrptr
, len
);
198 unsigned short BIO_ADDR_rawport(const BIO_ADDR
*ap
)
200 if (ap
->sa
.sa_family
== AF_INET
)
201 return ap
->sin
.sin_port
;
203 if (ap
->sa
.sa_family
== AF_INET6
)
204 return ap
->sin6
.sin6_port
;
210 * addr_strings - helper function to get host and service names
211 * @ap: the BIO_ADDR that has the input info
212 * @numeric: 0 if actual names should be returned, 1 if the numeric
213 * representation should be returned.
214 * @hostname: a pointer to a pointer to a memory area to store the
215 * host name or numeric representation. Unused if NULL.
216 * @service: a pointer to a pointer to a memory area to store the
217 * service name or numeric representation. Unused if NULL.
219 * The return value is 0 on failure, with the error code in the error
220 * stack, and 1 on success.
222 static int addr_strings(const BIO_ADDR
*ap
, int numeric
,
223 char **hostname
, char **service
)
225 if (BIO_sock_init() != 1)
231 char host
[NI_MAXHOST
], serv
[NI_MAXSERV
];
235 flags
|= NI_NUMERICHOST
| NI_NUMERICSERV
;
237 if ((ret
= getnameinfo(BIO_ADDR_sockaddr(ap
),
238 BIO_ADDR_sockaddr_size(ap
),
239 host
, sizeof(host
), serv
, sizeof(serv
),
242 if (ret
== EAI_SYSTEM
) {
243 SYSerr(SYS_F_GETNAMEINFO
, get_last_socket_error());
244 BIOerr(BIO_F_ADDR_STRINGS
, ERR_R_SYS_LIB
);
248 BIOerr(BIO_F_ADDR_STRINGS
, ERR_R_SYS_LIB
);
249 ERR_add_error_data(1, gai_strerror(ret
));
254 *hostname
= OPENSSL_strdup(host
);
256 *service
= OPENSSL_strdup(serv
);
260 *hostname
= OPENSSL_strdup(inet_ntoa(ap
->sin
.sin_addr
));
262 char serv
[6]; /* port is 16 bits => max 5 decimal digits */
263 BIO_snprintf(serv
, sizeof(serv
), "%d", ntohs(ap
->sin
.sin_port
));
264 *service
= OPENSSL_strdup(serv
);
271 char *BIO_ADDR_hostname_string(const BIO_ADDR
*ap
, int numeric
)
273 char *hostname
= NULL
;
275 if (addr_strings(ap
, numeric
, &hostname
, NULL
))
281 char *BIO_ADDR_service_string(const BIO_ADDR
*ap
, int numeric
)
283 char *service
= NULL
;
285 if (addr_strings(ap
, numeric
, NULL
, &service
))
291 char *BIO_ADDR_path_string(const BIO_ADDR
*ap
)
294 if (ap
->sa
.sa_family
== AF_UNIX
)
295 return OPENSSL_strdup(ap
->sun
.sun_path
);
301 * BIO_ADDR_sockaddr - non-public routine to return the struct sockaddr
302 * for a given BIO_ADDR. In reality, this is simply a type safe cast.
303 * The returned struct sockaddr is const, so it can't be tampered with.
305 const struct sockaddr
*BIO_ADDR_sockaddr(const BIO_ADDR
*ap
)
311 * BIO_ADDR_sockaddr_noconst - non-public function that does the same
312 * as BIO_ADDR_sockaddr, but returns a non-const. USE WITH CARE, as
313 * it allows you to tamper with the data (and thereby the contents
314 * of the input BIO_ADDR).
316 struct sockaddr
*BIO_ADDR_sockaddr_noconst(BIO_ADDR
*ap
)
322 * BIO_ADDR_sockaddr_size - non-public function that returns the size
323 * of the struct sockaddr the BIO_ADDR is using. If the protocol family
324 * isn't set or is something other than AF_INET, AF_INET6 or AF_UNIX,
325 * the size of the BIO_ADDR type is returned.
327 socklen_t
BIO_ADDR_sockaddr_size(const BIO_ADDR
*ap
)
329 if (ap
->sa
.sa_family
== AF_INET
)
330 return sizeof(ap
->sin
);
332 if (ap
->sa
.sa_family
== AF_INET6
)
333 return sizeof(ap
->sin6
);
336 if (ap
->sa
.sa_family
== AF_UNIX
)
337 return sizeof(ap
->sun
);
342 /**********************************************************************
344 * Address info database
348 const BIO_ADDRINFO
*BIO_ADDRINFO_next(const BIO_ADDRINFO
*bai
)
351 return bai
->bai_next
;
355 int BIO_ADDRINFO_family(const BIO_ADDRINFO
*bai
)
358 return bai
->bai_family
;
362 int BIO_ADDRINFO_socktype(const BIO_ADDRINFO
*bai
)
365 return bai
->bai_socktype
;
369 int BIO_ADDRINFO_protocol(const BIO_ADDRINFO
*bai
)
372 return bai
->bai_protocol
;
377 * BIO_ADDRINFO_sockaddr_size - non-public function that returns the size
378 * of the struct sockaddr inside the BIO_ADDRINFO.
380 socklen_t
BIO_ADDRINFO_sockaddr_size(const BIO_ADDRINFO
*bai
)
383 return bai
->bai_addrlen
;
388 * BIO_ADDRINFO_sockaddr - non-public function that returns bai_addr
389 * as the struct sockaddr it is.
391 const struct sockaddr
*BIO_ADDRINFO_sockaddr(const BIO_ADDRINFO
*bai
)
394 return bai
->bai_addr
;
398 const BIO_ADDR
*BIO_ADDRINFO_address(const BIO_ADDRINFO
*bai
)
401 return (BIO_ADDR
*)bai
->bai_addr
;
405 void BIO_ADDRINFO_free(BIO_ADDRINFO
*bai
)
412 # define _cond bai->bai_family != AF_UNIX
422 /* Free manually when we know that addrinfo_wrap() was used.
423 * See further comment above addrinfo_wrap()
425 while (bai
!= NULL
) {
426 BIO_ADDRINFO
*next
= bai
->bai_next
;
427 OPENSSL_free(bai
->bai_addr
);
433 /**********************************************************************
440 * The specs in hostserv can take these forms:
442 * host:service => *host = "host", *service = "service"
443 * host:* => *host = "host", *service = NULL
444 * host: => *host = "host", *service = NULL
445 * :service => *host = NULL, *service = "service"
446 * *:service => *host = NULL, *service = "service"
448 * in case no : is present in the string, the result depends on
449 * hostserv_prio, as follows:
451 * when hostserv_prio == BIO_PARSE_PRIO_HOST
452 * host => *host = "host", *service untouched
454 * when hostserv_prio == BIO_PARSE_PRIO_SERV
455 * service => *host untouched, *service = "service"
458 int BIO_parse_hostserv(const char *hostserv
, char **host
, char **service
,
459 enum BIO_hostserv_priorities hostserv_prio
)
461 const char *h
= NULL
; size_t hl
= 0;
462 const char *p
= NULL
; size_t pl
= 0;
464 if (*hostserv
== '[') {
465 if ((p
= strchr(hostserv
, ']')) == NULL
)
479 const char *p2
= strrchr(hostserv
, ':');
480 p
= strchr(hostserv
, ':');
483 * Check for more than one colon. There are three possible
485 * 1. IPv6 address with port number, last colon being separator.
486 * 2. IPv6 address only.
487 * 3. IPv6 address only if hostserv_prio == BIO_PARSE_PRIO_HOST,
488 * IPv6 address and port number if hostserv_prio == BIO_PARSE_PRIO_SERV
489 * Because of this ambiguity, we currently choose to make it an
500 } else if (hostserv_prio
== BIO_PARSE_PRIO_HOST
) {
509 if (p
!= NULL
&& strchr(p
, ':'))
512 if (h
!= NULL
&& host
!= NULL
) {
514 || (hl
== 1 && h
[0] == '*')) {
517 *host
= OPENSSL_strndup(h
, hl
);
522 if (p
!= NULL
&& service
!= NULL
) {
524 || (pl
== 1 && p
[0] == '*')) {
527 *service
= OPENSSL_strndup(p
, pl
);
528 if (*service
== NULL
)
535 BIOerr(BIO_F_BIO_PARSE_HOSTSERV
, BIO_R_AMBIGUOUS_HOST_OR_SERVICE
);
538 BIOerr(BIO_F_BIO_PARSE_HOSTSERV
, BIO_R_MALFORMED_HOST_OR_SERVICE
);
541 BIOerr(BIO_F_BIO_PARSE_HOSTSERV
, ERR_R_MALLOC_FAILURE
);
545 /* addrinfo_wrap is used to build our own addrinfo "chain".
546 * (it has only one entry, so calling it a chain may be a stretch)
547 * It should ONLY be called when getaddrinfo() and friends
548 * aren't available, OR when dealing with a non IP protocol
549 * family, such as AF_UNIX
551 * the return value is 1 on success, or 0 on failure, which
552 * only happens if a memory allocation error occured.
554 static int addrinfo_wrap(int family
, int socktype
,
555 const void *where
, size_t wherelen
,
559 OPENSSL_assert(bai
!= NULL
);
561 *bai
= OPENSSL_zalloc(sizeof(**bai
));
565 (*bai
)->bai_family
= family
;
566 (*bai
)->bai_socktype
= socktype
;
567 if (socktype
== SOCK_STREAM
)
568 (*bai
)->bai_protocol
= IPPROTO_TCP
;
569 if (socktype
== SOCK_DGRAM
)
570 (*bai
)->bai_protocol
= IPPROTO_UDP
;
572 if (family
== AF_UNIX
)
573 (*bai
)->bai_protocol
= 0;
576 /* Magic: We know that BIO_ADDR_sockaddr_noconst is really
577 just an advanced cast of BIO_ADDR* to struct sockaddr *
578 by the power of union, so while it may seem that we're
579 creating a memory leak here, we are not. It will be
581 BIO_ADDR
*addr
= BIO_ADDR_new();
583 BIO_ADDR_rawmake(addr
, family
, where
, wherelen
, port
);
584 (*bai
)->bai_addr
= BIO_ADDR_sockaddr_noconst(addr
);
587 (*bai
)->bai_next
= NULL
;
588 if ((*bai
)->bai_addr
== NULL
) {
589 BIO_ADDRINFO_free(*bai
);
597 * BIO_lookup - look up the node and service you want to connect to.
598 * @node: the node you want to connect to.
599 * @service: the service you want to connect to.
600 * @lookup_type: declare intent with the result, client or server.
601 * @family: the address family you want to use. Use AF_UNSPEC for any, or
602 * AF_INET, AF_INET6 or AF_UNIX.
603 * @socktype: The socket type you want to use. Can be SOCK_STREAM, SOCK_DGRAM
605 * @res: Storage place for the resulting list of returned addresses
607 * This will do a lookup of the node and service that you want to connect to.
608 * It returns a linked list of different addresses you can try to connect to.
610 * When no longer needed you should call BIO_ADDRINFO_free() to free the result.
612 * The return value is 1 on success or 0 in case of error.
614 int BIO_lookup(const char *host
, const char *service
,
615 enum BIO_lookup_type lookup_type
,
616 int family
, int socktype
, BIO_ADDRINFO
**res
)
618 int ret
= 0; /* Assume failure */
633 BIOerr(BIO_F_BIO_LOOKUP
, BIO_R_UNSUPPORTED_PROTOCOL_FAMILY
);
638 if (family
== AF_UNIX
) {
639 if (addrinfo_wrap(family
, socktype
, host
, strlen(host
), 0, res
))
642 BIOerr(BIO_F_BIO_LOOKUP
, ERR_R_MALLOC_FAILURE
);
647 if (BIO_sock_init() != 1)
653 struct addrinfo hints
;
656 # ifdef AI_ADDRCONFIG
657 hints
.ai_flags
= AI_ADDRCONFIG
;
659 hints
.ai_family
= family
;
660 hints
.ai_socktype
= socktype
;
661 hints
.ai_protocol
= 0;
662 hints
.ai_addrlen
= 0;
663 hints
.ai_addr
= NULL
;
664 hints
.ai_canonname
= NULL
;
665 hints
.ai_next
= NULL
;
667 if (lookup_type
== BIO_LOOKUP_SERVER
)
668 hints
.ai_flags
|= AI_PASSIVE
;
670 /* Note that |res| SHOULD be a 'struct addrinfo **' thanks to
671 * macro magic in bio_lcl.h
673 switch ((gai_ret
= getaddrinfo(host
, service
, &hints
, res
))) {
676 SYSerr(SYS_F_GETADDRINFO
, get_last_socket_error());
677 BIOerr(BIO_F_BIO_LOOKUP
, ERR_R_SYS_LIB
);
681 ret
= 1; /* Success */
684 BIOerr(BIO_F_BIO_LOOKUP
, ERR_R_SYS_LIB
);
685 ERR_add_error_data(1, gai_strerror(gai_ret
));
690 const struct hostent
*he
;
691 /* Windows doesn't seem to have in_addr_t */
692 #ifdef OPENSSL_SYS_WINDOWS
693 static uint32_t he_fallback_address
;
694 static const uint32_t *he_fallback_addresses
[] =
695 { &he_fallback_address
, NULL
};
697 static in_addr_t he_fallback_address
;
698 static const in_addr_t
*he_fallback_addresses
[] =
699 { &he_fallback_address
, NULL
};
701 static const struct hostent he_fallback
=
702 { NULL
, NULL
, AF_INET
, sizeof(he_fallback_address
),
703 (char **)&he_fallback_addresses
};
705 /* Apprently, on WIN64, s_proto and s_port have traded places... */
707 struct servent se_fallback
= { NULL
, NULL
, NULL
, 0 };
709 struct servent se_fallback
= { NULL
, NULL
, 0, NULL
};
713 CRYPTO_w_lock(CRYPTO_LOCK_GETHOSTBYNAME
);
714 CRYPTO_w_lock(CRYPTO_LOCK_GETSERVBYNAME
);
715 he_fallback_address
= INADDR_ANY
;
718 switch(lookup_type
) {
719 case BIO_LOOKUP_CLIENT
:
720 he_fallback_address
= INADDR_LOOPBACK
;
722 case BIO_LOOKUP_SERVER
:
723 he_fallback_address
= INADDR_ANY
;
726 OPENSSL_assert(("We forgot to handle a lookup type!" == 0));
730 he
= gethostbyname(host
);
733 #ifndef OPENSSL_SYS_WINDOWS
734 BIOerr(BIO_F_BIO_LOOKUP
, ERR_R_SYS_LIB
);
735 ERR_add_error_data(1, hstrerror(h_errno
));
737 SYSerr(SYS_F_GETHOSTBYNAME
, WSAGetLastError());
744 if (service
== NULL
) {
745 se_fallback
.s_port
= 0;
746 se_fallback
.s_proto
= proto
;
750 long portnum
= strtol(service
, &endp
, 10);
752 if (endp
!= service
&& *endp
== '\0'
753 && portnum
> 0 && portnum
< 65536) {
754 se_fallback
.s_port
= htons(portnum
);
755 se_fallback
.s_proto
= proto
;
757 } else if (endp
== service
) {
766 se
= getservbyname(service
, proto
);
769 #ifndef OPENSSL_SYS_WINDOWS
770 BIOerr(BIO_F_BIO_LOOKUP
, ERR_R_SYS_LIB
);
771 ERR_add_error_data(1, hstrerror(h_errno
));
773 SYSerr(SYS_F_GETSERVBYNAME
, WSAGetLastError());
778 BIOerr(BIO_F_BIO_LOOKUP
, BIO_R_MALFORMED_HOST_OR_SERVICE
);
788 BIO_ADDRINFO
*tmp_bai
= NULL
;
790 /* The easiest way to create a linked list from an
791 array is to start from the back */
792 for(addrlistp
= he
->h_addr_list
; *addrlistp
!= NULL
;
796 for(addresses
= addrlistp
- he
->h_addr_list
;
797 addrlistp
--, addresses
-- > 0; ) {
798 if (!addrinfo_wrap(he
->h_addrtype
, socktype
,
799 *addrlistp
, he
->h_length
,
800 se
->s_port
, &tmp_bai
))
801 goto addrinfo_malloc_err
;
802 tmp_bai
->bai_next
= *res
;
806 BIO_ADDRINFO_free(*res
);
808 BIOerr(BIO_F_BIO_LOOKUP
, ERR_R_MALLOC_FAILURE
);
816 CRYPTO_w_unlock(CRYPTO_LOCK_GETSERVBYNAME
);
817 CRYPTO_w_unlock(CRYPTO_LOCK_GETHOSTBYNAME
);