/*
* Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the project nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*! \file
* Issues to be discussed:
*\li Thread safe-ness must be checked.
*\li Return values. There are nonstandard return values defined and used
* in the source code. This is because RFC2553 is silent about which error
* code must be returned for which situation.
*\li IPv4 classful (shortened) form. RFC2553 is silent about it. XNET 5.2
* says to use inet_aton() to convert IPv4 numeric to binary (allows
* classful form as a result).
* current code - disallow classful form for IPv4 (due to use of inet_pton).
*\li freeaddrinfo(NULL). RFC2553 is silent about it. XNET 5.2 says it is
* invalid.
* current code - SEGV on freeaddrinfo(NULL)
* Note:
*\li We use getipnodebyname() just for thread-safeness. There's no intent
* to let it do PF_UNSPEC (actually we never pass PF_UNSPEC to
* getipnodebyname().
*\li The code filters out AFs that are not supported by the kernel,
* when globbing NULL hostname (to loopback, or wildcard). Is it the right
* thing to do? What is the relationship with post-RFC2553 AI_ADDRCONFIG
* in ai_flags?
*\li (post-2553) semantics of AI_ADDRCONFIG itself is too vague.
* (1) what should we do against numeric hostname (2) what should we do
* against NULL hostname (3) what is AI_ADDRCONFIG itself. AF not ready?
* non-loopback address configured? global address configured?
* \par Additional Issue:
* To avoid search order issue, we have a big amount of code duplicate
* from gethnamaddr.c and some other places. The issues that there's no
* lower layer function to lookup "IPv4 or IPv6" record. Calling
* gethostbyname2 from getaddrinfo will end up in wrong search order, as
* follows:
* \li The code makes use of following calls when asked to resolver with
* ai_family = PF_UNSPEC:
*\code getipnodebyname(host, AF_INET6);
* getipnodebyname(host, AF_INET);
*\endcode
* \li This will result in the following queries if the node is configure to
* prefer /etc/hosts than DNS:
*\code
* lookup /etc/hosts for IPv6 address
* lookup DNS for IPv6 address
* lookup /etc/hosts for IPv4 address
* lookup DNS for IPv4 address
*\endcode
* which may not meet people's requirement.
* \li The right thing to happen is to have underlying layer which does
* PF_UNSPEC lookup (lookup both) and return chain of addrinfos.
* This would result in a bit of code duplicate with _dns_ghbyname() and
* friends.
*/
#if 0
static const char *ai_errlist[] = {
"Success",
"Address family for hostname not supported", /*%< EAI_ADDRFAMILY */
"Temporary failure in name resolution", /*%< EAI_AGAIN */
"Invalid value for ai_flags", /*%< EAI_BADFLAGS */
"Non-recoverable failure in name resolution", /*%< EAI_FAIL */
"ai_family not supported", /*%< EAI_FAMILY */
"Memory allocation failure", /*%< EAI_MEMORY */
"No address associated with hostname", /*%< EAI_NODATA */
"hostname nor servname provided, or not known", /*%< EAI_NONAME */
"servname not supported for ai_socktype", /*%< EAI_SERVICE */
"ai_socktype not supported", /*%< EAI_SOCKTYPE */
"System error returned in errno", /*%< EAI_SYSTEM */
"Invalid value for hints", /*%< EAI_BADHINTS */
"Resolved protocol is unknown", /*%< EAI_PROTOCOL */
"Unknown error", /*%< EAI_MAX */
};
#endif
/* XXX macros that make external reference is BAD. */
#if 0 /*%< bind8 has its own version */
char *
gai_strerror(ecode)
int ecode;
{
if (ecode < 0 || ecode > EAI_MAX)
ecode = EAI_MAX;
return ai_errlist[ecode];
}
#endif
memset(&sentinel, 0, sizeof(sentinel));
cur = &sentinel;
pai = &ai;
pai->ai_flags = 0;
pai->ai_family = PF_UNSPEC;
pai->ai_socktype = ANY;
pai->ai_protocol = ANY;
#if defined(sun) && defined(_SOCKLEN_T) && defined(__sparcv9)
/*
* clear _ai_pad to preserve binary
* compatibility with previously compiled 64-bit
* applications in a pre-SUSv3 environment by
* guaranteeing the upper 32-bits are empty.
*/
pai->_ai_pad = 0;
#endif
pai->ai_addrlen = 0;
pai->ai_canonname = NULL;
pai->ai_addr = NULL;
pai->ai_next = NULL;
if (hostname == NULL && servname == NULL)
return EAI_NONAME;
if (hints) {
/* error check for hints */
if (hints->ai_addrlen || hints->ai_canonname ||
hints->ai_addr || hints->ai_next)
SETERROR(EAI_BADHINTS); /*%< xxx */
if (hints->ai_flags & ~AI_MASK)
SETERROR(EAI_BADFLAGS);
switch (hints->ai_family) {
case PF_UNSPEC:
case PF_INET:
case PF_INET6:
break;
default:
SETERROR(EAI_FAMILY);
}
memcpy(pai, hints, sizeof(*pai));
#if defined(sun) && defined(_SOCKLEN_T) && defined(__sparcv9)
/*
* We need to clear _ai_pad to preserve binary
* compatibility. See prior comment.
*/
pai->_ai_pad = 0;
#endif
/*
* if both socktype/protocol are specified, check if they
* are meaningful combination.
*/
if (pai->ai_socktype != ANY && pai->ai_protocol != ANY) {
for (ex = explore; ex->e_af >= 0; ex++) {
if (pai->ai_family != ex->e_af)
continue;
if (ex->e_socktype == ANY)
continue;
if (ex->e_protocol == ANY)
continue;
if (pai->ai_socktype == ex->e_socktype &&
pai->ai_protocol != ex->e_protocol) {
SETERROR(EAI_BADHINTS);
}
}
}
}
/*
* post-2553: AI_ALL and AI_V4MAPPED are effective only against
* AF_INET6 query. They needs to be ignored if specified in other
* occassions.
*/
switch (pai->ai_flags & (AI_ALL | AI_V4MAPPED)) {
case AI_V4MAPPED:
case AI_ALL | AI_V4MAPPED:
if (pai->ai_family != AF_INET6)
pai->ai_flags &= ~(AI_ALL | AI_V4MAPPED);
break;
case AI_ALL:
#if 1
/* illegal */
SETERROR(EAI_BADFLAGS);
#else
pai->ai_flags &= ~(AI_ALL | AI_V4MAPPED);
break;
#endif
}
/*
* check for special cases. (1) numeric servname is disallowed if
* socktype/protocol are left unspecified. (2) servname is disallowed
* for raw and other inet{,6} sockets.
*/
if (MATCH_FAMILY(pai->ai_family, PF_INET, 1)
#ifdef PF_INET6
|| MATCH_FAMILY(pai->ai_family, PF_INET6, 1)
#endif
) {
ai0 = *pai; /* backup *pai */
/* NULL hostname, or numeric hostname */
for (ex = explore; ex->e_af >= 0; ex++) {
*pai = ai0;
if (!MATCH_FAMILY(pai->ai_family, ex->e_af, WILD_AF(ex)))
continue;
if (!MATCH(pai->ai_socktype, ex->e_socktype, WILD_SOCKTYPE(ex)))
continue;
if (!MATCH(pai->ai_protocol, ex->e_protocol, WILD_PROTOCOL(ex)))
continue;
if (pai->ai_family == PF_UNSPEC)
pai->ai_family = ex->e_af;
if (pai->ai_socktype == ANY && ex->e_socktype != ANY)
pai->ai_socktype = ex->e_socktype;
if (pai->ai_protocol == ANY && ex->e_protocol != ANY)
pai->ai_protocol = ex->e_protocol;
/*
* if the servname does not match socktype/protocol, ignore it.
*/
if (get_portmatch(pai, servname) != 0)
continue;
if (hostname == NULL) {
/*
* filter out AFs that are not supported by the kernel
* XXX errno?
*/
if (!addrconfig(pai->ai_family))
continue;
error = explore_null(pai, servname, &cur->ai_next);
} else
error = explore_numeric_scope(pai, hostname, servname,
&cur->ai_next);
if (error)
goto free;
while (cur && cur->ai_next)
cur = cur->ai_next;
}
/*
* XXX
* If numreic representation of AF1 can be interpreted as FQDN
* representation of AF2, we need to think again about the code below.
*/
if (sentinel.ai_next)
goto good;
if (pai->ai_flags & AI_NUMERICHOST)
SETERROR(EAI_NONAME);
if (hostname == NULL)
SETERROR(EAI_NONAME);
/*
* hostname as alphabetical name.
* We'll make sure that
* - if returning addrinfo list is empty, return non-zero error
* value (already known one or EAI_NONAME).
* - otherwise,
* + if we haven't had any errors, return 0 (i.e. success).
* + if we've had an error, free the list and return the error.
* without any assumption on the behavior of explore_fqdn().
*/
/* first, try to query DNS for all possible address families. */
*pai = ai0;
error = explore_fqdn(pai, hostname, servname, &afai);
if (error) {
if (afai != NULL)
freeaddrinfo(afai);
goto free;
}
if (afai == NULL) {
error = EAI_NONAME; /*%< we've had no errors. */
goto free;
}
/*
* we would like to prefer AF_INET6 than AF_INET, so we'll make an
* outer loop by AFs.
*/
for (ex = explore; ex->e_af >= 0; ex++) {
*pai = ai0;
if (pai->ai_family == PF_UNSPEC)
pai->ai_family = ex->e_af;
if (!MATCH_FAMILY(pai->ai_family, ex->e_af, WILD_AF(ex)))
continue;
if (!MATCH(pai->ai_socktype, ex->e_socktype,
WILD_SOCKTYPE(ex))) {
continue;
}
if (!MATCH(pai->ai_protocol, ex->e_protocol,
WILD_PROTOCOL(ex))) {
continue;
}
#ifdef AI_ADDRCONFIG
/*
* If AI_ADDRCONFIG is specified, check if we are
* expected to return the address family or not.
*/
if ((pai->ai_flags & AI_ADDRCONFIG) != 0 &&
!addrconfig(pai->ai_family))
continue;
#endif
if (pai->ai_family == PF_UNSPEC)
pai->ai_family = ex->e_af;
if (pai->ai_socktype == ANY && ex->e_socktype != ANY)
pai->ai_socktype = ex->e_socktype;
if (pai->ai_protocol == ANY && ex->e_protocol != ANY)
pai->ai_protocol = ex->e_protocol;
/*
* if the servname does not match socktype/protocol, ignore it.
*/
if (get_portmatch(pai, servname) != 0)
continue;
freeaddrinfo(afai); /*%< afai must not be NULL at this point. */
if (sentinel.ai_next) {
good:
*res = sentinel.ai_next;
return(SUCCESS);
} else {
/*
* All the process succeeded, but we've had an empty list.
* This can happen if the given hints do not match our
* candidates.
*/
error = EAI_NONAME;
}
free:
bad:
if (sentinel.ai_next)
freeaddrinfo(sentinel.ai_next);
*res = NULL;
return(error);
}
/* XXX need to malloc() the same way we do from other functions! */
static struct addrinfo *
copy_ai(pai)
const struct addrinfo *pai;
{
struct addrinfo *ai;
size_t l;
if (pai->ai_canonname) {
l = strlen(pai->ai_canonname) + 1;
if ((ai->ai_canonname = malloc(l)) == NULL) {
free(ai);
return NULL;
}
strcpy(ai->ai_canonname, pai->ai_canonname); /* (checked) */
} else {
/* just to make sure */
ai->ai_canonname = NULL;
}
ai->ai_next = NULL;
return ai;
}
static int
get_portmatch(const struct addrinfo *ai, const char *servname) {
/* get_port does not touch first argument. when matchonly == 1. */
/* LINTED const cast */
return get_port((const struct addrinfo *)ai, servname, 1);
}
static int
get_port(const struct addrinfo *ai, const char *servname, int matchonly) {
const char *proto;
struct servent *sp;
int port;
int allownumeric;
if (servname == NULL)
return 0;
switch (ai->ai_family) {
case AF_INET:
#ifdef AF_INET6
case AF_INET6:
#endif
break;
default:
return 0;
}
switch (ai->ai_socktype) {
case SOCK_RAW:
return EAI_SERVICE;
case SOCK_DGRAM:
case SOCK_STREAM:
allownumeric = 1;
break;
case ANY:
switch (ai->ai_family) {
case AF_INET:
#ifdef AF_INET6
case AF_INET6:
#endif
allownumeric = 1;
break;
default:
allownumeric = 0;
break;
}
break;
default:
return EAI_SOCKTYPE;
}
if (str_isnumber(servname)) {
if (!allownumeric)
return EAI_SERVICE;
port = atoi(servname);
if (port < 0 || port > 65535)
return EAI_SERVICE;
port = htons(port);
} else {
switch (ai->ai_socktype) {
case SOCK_DGRAM:
proto = "udp";
break;
case SOCK_STREAM:
proto = "tcp";
break;
default:
proto = NULL;
break;
}
if ((sp = getservbyname(servname, proto)) == NULL)
return EAI_SERVICE;
port = sp->s_port;
}
if (!matchonly) {
switch (ai->ai_family) {
case AF_INET:
((struct sockaddr_in *)(void *)
ai->ai_addr)->sin_port = port;
break;
case AF_INET6:
((struct sockaddr_in6 *)(void *)
ai->ai_addr)->sin6_port = port;
break;
}
}
if (af == PF_UNSPEC)
return NULL;
for (afd = afdl; afd->a_af; afd++) {
if (afd->a_af == af)
return afd;
}
return NULL;
}
/*%
* post-2553: AI_ADDRCONFIG check. if we use getipnodeby* as backend, backend
* will take care of it.
* the semantics of AI_ADDRCONFIG is not defined well. we are not sure
* if the code is right or not.
*/
static int
addrconfig(af)
int af;
{
int s;
/* XXX errno */
s = socket(af, SOCK_DGRAM, 0);
if (s < 0) {
if (errno != EMFILE)
return 0;
} else
close(s);
return 1;
}
/* convert a string to a scope identifier. XXX: IPv6 specific */
static int
ip6_str2scopeid(char *scope, struct sockaddr_in6 *sin6,
u_int32_t *scopeidp)
{
u_int32_t scopeid;
u_long lscopeid;
struct in6_addr *a6 = &sin6->sin6_addr;
char *ep;
/* empty scopeid portion is invalid */
if (*scope == '\0')
return (0);
#ifdef USE_IFNAMELINKID
if (IN6_IS_ADDR_LINKLOCAL(a6) || IN6_IS_ADDR_MC_LINKLOCAL(a6) ||
IN6_IS_ADDR_MC_NODELOCAL(a6)) {
/*
* Using interface names as link indices can be allowed
* only when we can assume a one-to-one mappings between
* links and interfaces. See comments in getnameinfo.c.
*/
scopeid = if_nametoindex(scope);
if (scopeid == 0)
goto trynumeric;
*scopeidp = scopeid;
return (1);
}
#endif
/* still unclear about literal, allow numeric only - placeholder */
if (IN6_IS_ADDR_SITELOCAL(a6) || IN6_IS_ADDR_MC_SITELOCAL(a6))
goto trynumeric;
if (IN6_IS_ADDR_MC_ORGLOCAL(a6))
goto trynumeric;
else
goto trynumeric; /*%< global */
/* try to convert to a numeric id as a last resort */
trynumeric:
errno = 0;
lscopeid = strtoul(scope, &ep, 10);
scopeid = lscopeid & 0xffffffff;
if (errno == 0 && ep && *ep == '\0' && scopeid == lscopeid) {
*scopeidp = scopeid;
return (1);
} else
return (0);
}
af = hp->h_addrtype;
if (pai->ai_family != AF_UNSPEC && af != pai->ai_family)
return(NULL);
afd = find_afd(af);
if (afd == NULL)
return(NULL);
aplist = hp->h_addr_list;
memset(&sentinel, 0, sizeof(sentinel));
cur = &sentinel;
for (i = 0; (ap = aplist[i]) != NULL; i++) {
#if 0 /*%< the trick seems too much */
af = hp->h_addr_list;
if (af == AF_INET6 &&
IN6_IS_ADDR_V4MAPPED((struct in6_addr *)ap)) {
af = AF_INET;
ap = ap + sizeof(struct in6_addr)
- sizeof(struct in_addr);
}
afd = find_afd(af);
if (afd == NULL)
continue;
#endif /* 0 */
GET_AI(cur->ai_next, afd, ap);
/* GET_PORT(cur->ai_next, servname); */
if ((pai->ai_flags & AI_CANONNAME) != 0) {
/*
* RFC2553 says that ai_canonname will be set only for
* the first element. we do it for all the elements,
* just for convenience.
*/
GET_CANONNAME(cur->ai_next, hp->h_name);
}
while (cur->ai_next) /*%< no need to loop, actually. */
cur = cur->ai_next;
continue;
free:
if (cur->ai_next)
freeaddrinfo(cur->ai_next);
cur->ai_next = NULL;
/* continue, without tht pointer CUR advanced. */
}