1100628Sume/* $KAME: getnameinfo.c,v 1.61 2002/06/27 09:25:47 itojun Exp $ */ 262615Sitojun 355163Sshin/* 455163Sshin * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. 5167121Sbms * Copyright (c) 2000 Ben Harris. 655163Sshin * All rights reserved. 755163Sshin * 855163Sshin * Redistribution and use in source and binary forms, with or without 955163Sshin * modification, are permitted provided that the following conditions 1055163Sshin * are met: 1155163Sshin * 1. Redistributions of source code must retain the above copyright 1255163Sshin * notice, this list of conditions and the following disclaimer. 1355163Sshin * 2. Redistributions in binary form must reproduce the above copyright 1455163Sshin * notice, this list of conditions and the following disclaimer in the 1555163Sshin * documentation and/or other materials provided with the distribution. 1655163Sshin * 3. Neither the name of the project nor the names of its contributors 1755163Sshin * may be used to endorse or promote products derived from this software 1855163Sshin * without specific prior written permission. 1955163Sshin * 2055163Sshin * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND 2155163Sshin * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2255163Sshin * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2355163Sshin * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE 2455163Sshin * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2555163Sshin * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2655163Sshin * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2755163Sshin * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2855163Sshin * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2955163Sshin * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 3055163Sshin * SUCH DAMAGE. 3155163Sshin */ 3255163Sshin 3355163Sshin/* 3455163Sshin * Issues to be discussed: 3555163Sshin * - Thread safe-ness must be checked 3662615Sitojun * - RFC2553 says that we should raise error on short buffer. X/Open says 3762615Sitojun * we need to truncate the result. We obey RFC2553 (and X/Open should be 3866374Sitojun * modified). ipngwg rough consensus seems to follow RFC2553. 3962615Sitojun * - What is "local" in NI_FQDN? 4062615Sitojun * - NI_NAMEREQD and NI_NUMERICHOST conflict with each other. 4199252Sume * - (KAME extension) always attach textual scopeid (fe80::1%lo0), if 4299252Sume * sin6_scope_id is filled - standardization status? 4399252Sume * XXX breaks backward compat for code that expects no scopeid. 4499252Sume * beware on merge. 4555163Sshin */ 4655163Sshin 4792986Sobrien#include <sys/cdefs.h> 4892986Sobrien__FBSDID("$FreeBSD$"); 4992986Sobrien 5055163Sshin#include <sys/types.h> 5155163Sshin#include <sys/socket.h> 5255163Sshin#include <net/if.h> 53167121Sbms#include <net/if_dl.h> 54167121Sbms#include <net/if_types.h> 55199221Sume#include <net/firewire.h> 5655163Sshin#include <netinet/in.h> 5755163Sshin#include <arpa/inet.h> 5855163Sshin#include <arpa/nameser.h> 5955163Sshin#include <netdb.h> 6055163Sshin#include <resolv.h> 6155163Sshin#include <string.h> 6255163Sshin#include <stddef.h> 6362615Sitojun#include <errno.h> 6455163Sshin 65167121Sbmsstatic int getnameinfo_inet(const struct sockaddr *, socklen_t, char *, 66167121Sbms size_t, char *, size_t, int); 67167121Sbms#ifdef INET6 68167121Sbmsstatic int ip6_parsenumeric(const struct sockaddr *, const char *, char *, 69167121Sbms size_t, int); 70167121Sbmsstatic int ip6_sa2str(const struct sockaddr_in6 *, char *, size_t, int); 71167121Sbms#endif 72167121Sbmsstatic int getnameinfo_link(const struct sockaddr *, socklen_t, char *, 73167121Sbms size_t, char *, size_t, int); 74167121Sbmsstatic int hexname(const u_int8_t *, size_t, char *, size_t); 75167121Sbms 76167121Sbmsint 77167121Sbmsgetnameinfo(const struct sockaddr *sa, socklen_t salen, 78167121Sbms char *host, size_t hostlen, char *serv, size_t servlen, 79167121Sbms int flags) 80167121Sbms{ 81167121Sbms 82167121Sbms switch (sa->sa_family) { 83167121Sbms case AF_INET: 84167121Sbms#ifdef INET6 85167121Sbms case AF_INET6: 86167121Sbms#endif 87167121Sbms return getnameinfo_inet(sa, salen, host, hostlen, serv, 88167121Sbms servlen, flags); 89167121Sbms case AF_LINK: 90167121Sbms return getnameinfo_link(sa, salen, host, hostlen, serv, 91167121Sbms servlen, flags); 92167121Sbms default: 93167121Sbms return EAI_FAMILY; 94167121Sbms } 95167121Sbms} 96167121Sbms 97100628Sumestatic const struct afd { 9855163Sshin int a_af; 99145831Sume size_t a_addrlen; 100145831Sume socklen_t a_socklen; 10155163Sshin int a_off; 10255163Sshin} afdl [] = { 10355163Sshin#ifdef INET6 10455163Sshin {PF_INET6, sizeof(struct in6_addr), sizeof(struct sockaddr_in6), 10555163Sshin offsetof(struct sockaddr_in6, sin6_addr)}, 10655163Sshin#endif 10755163Sshin {PF_INET, sizeof(struct in_addr), sizeof(struct sockaddr_in), 10855163Sshin offsetof(struct sockaddr_in, sin_addr)}, 10955163Sshin {0, 0, 0}, 11055163Sshin}; 11155163Sshin 11255163Sshinstruct sockinet { 11355163Sshin u_char si_len; 11455163Sshin u_char si_family; 11555163Sshin u_short si_port; 11655163Sshin}; 11755163Sshin 118167121Sbmsstatic int 119167121Sbmsgetnameinfo_inet(const struct sockaddr *sa, socklen_t salen, 120157119Sume char *host, size_t hostlen, char *serv, size_t servlen, 121157119Sume int flags) 12255163Sshin{ 123100628Sume const struct afd *afd; 12455163Sshin struct servent *sp; 12555163Sshin struct hostent *hp; 12655163Sshin u_short port; 12755163Sshin int family, i; 12862615Sitojun const char *addr; 12962615Sitojun u_int32_t v4a; 13055163Sshin int h_error; 13155163Sshin char numserv[512]; 13255163Sshin char numaddr[512]; 13355163Sshin 13455163Sshin if (sa == NULL) 135100628Sume return EAI_FAIL; 13655163Sshin 13755163Sshin family = sa->sa_family; 13855163Sshin for (i = 0; afdl[i].a_af; i++) 13955163Sshin if (afdl[i].a_af == family) { 14055163Sshin afd = &afdl[i]; 14155163Sshin goto found; 14255163Sshin } 143100628Sume return EAI_FAMILY; 144100628Sume 14555163Sshin found: 14655163Sshin if (salen != afd->a_socklen) 147100628Sume return EAI_FAIL; 148100628Sume 14962615Sitojun /* network byte order */ 15062615Sitojun port = ((const struct sockinet *)sa)->si_port; 15162615Sitojun addr = (const char *)sa + afd->a_off; 15255163Sshin 15355163Sshin if (serv == NULL || servlen == 0) { 15462615Sitojun /* 15562615Sitojun * do nothing in this case. 15662615Sitojun * in case you are wondering if "&&" is more correct than 157100628Sume * "||" here: rfc2553bis-03 says that serv == NULL OR 158100628Sume * servlen == 0 means that the caller does not want the result. 15962615Sitojun */ 16055163Sshin } else { 16155163Sshin if (flags & NI_NUMERICSERV) 16255163Sshin sp = NULL; 16355163Sshin else { 16455163Sshin sp = getservbyport(port, 16555163Sshin (flags & NI_DGRAM) ? "udp" : "tcp"); 16655163Sshin } 16755163Sshin if (sp) { 16866374Sitojun if (strlen(sp->s_name) + 1 > servlen) 169100628Sume return EAI_MEMORY; 170114443Snectar strlcpy(serv, sp->s_name, servlen); 17155163Sshin } else { 172100628Sume snprintf(numserv, sizeof(numserv), "%u", ntohs(port)); 17366374Sitojun if (strlen(numserv) + 1 > servlen) 174100628Sume return EAI_MEMORY; 175114443Snectar strlcpy(serv, numserv, servlen); 17655163Sshin } 17755163Sshin } 17855163Sshin 17955163Sshin switch (sa->sa_family) { 18055163Sshin case AF_INET: 18162615Sitojun v4a = (u_int32_t) 18262615Sitojun ntohl(((const struct sockaddr_in *)sa)->sin_addr.s_addr); 18355163Sshin if (IN_MULTICAST(v4a) || IN_EXPERIMENTAL(v4a)) 18455163Sshin flags |= NI_NUMERICHOST; 18555163Sshin v4a >>= IN_CLASSA_NSHIFT; 18656671Sshin if (v4a == 0) 187157119Sume flags |= NI_NUMERICHOST; 18855163Sshin break; 18955163Sshin#ifdef INET6 19055163Sshin case AF_INET6: 19155163Sshin { 19262615Sitojun const struct sockaddr_in6 *sin6; 19362615Sitojun sin6 = (const struct sockaddr_in6 *)sa; 19462615Sitojun switch (sin6->sin6_addr.s6_addr[0]) { 19562615Sitojun case 0x00: 19662615Sitojun if (IN6_IS_ADDR_V4MAPPED(&sin6->sin6_addr)) 19762615Sitojun ; 19862615Sitojun else if (IN6_IS_ADDR_LOOPBACK(&sin6->sin6_addr)) 19962615Sitojun ; 20062615Sitojun else 20162615Sitojun flags |= NI_NUMERICHOST; 20262615Sitojun break; 20362615Sitojun default: 20462615Sitojun if (IN6_IS_ADDR_LINKLOCAL(&sin6->sin6_addr)) { 20562615Sitojun flags |= NI_NUMERICHOST; 20662615Sitojun } 20762615Sitojun else if (IN6_IS_ADDR_MULTICAST(&sin6->sin6_addr)) 20862615Sitojun flags |= NI_NUMERICHOST; 20962615Sitojun break; 21062615Sitojun } 21155163Sshin } 21255163Sshin break; 21355163Sshin#endif 21455163Sshin } 21555163Sshin if (host == NULL || hostlen == 0) { 21662615Sitojun /* 21762615Sitojun * do nothing in this case. 21862615Sitojun * in case you are wondering if "&&" is more correct than 219100628Sume * "||" here: rfc2553bis-03 says that host == NULL or 220100628Sume * hostlen == 0 means that the caller does not want the result. 22162615Sitojun */ 22255163Sshin } else if (flags & NI_NUMERICHOST) { 223145831Sume size_t numaddrlen; 22462615Sitojun 22555163Sshin /* NUMERICHOST and NAMEREQD conflicts with each other */ 22655163Sshin if (flags & NI_NAMEREQD) 227100628Sume return EAI_NONAME; 22862615Sitojun 22962615Sitojun switch(afd->a_af) { 23055163Sshin#ifdef INET6 23162615Sitojun case AF_INET6: 23262615Sitojun { 23362615Sitojun int error; 23455163Sshin 23562615Sitojun if ((error = ip6_parsenumeric(sa, addr, host, 23662615Sitojun hostlen, flags)) != 0) 23762615Sitojun return(error); 23862615Sitojun break; 23955163Sshin } 24062615Sitojun#endif 24162615Sitojun default: 24262615Sitojun if (inet_ntop(afd->a_af, addr, numaddr, sizeof(numaddr)) 24362615Sitojun == NULL) 244100628Sume return EAI_SYSTEM; 24562615Sitojun numaddrlen = strlen(numaddr); 24662615Sitojun if (numaddrlen + 1 > hostlen) /* don't forget terminator */ 247100628Sume return EAI_MEMORY; 248114443Snectar strlcpy(host, numaddr, hostlen); 24962615Sitojun break; 25062615Sitojun } 25155163Sshin } else { 25255163Sshin hp = getipnodebyaddr(addr, afd->a_addrlen, afd->a_af, &h_error); 25362615Sitojun 25455163Sshin if (hp) { 25562615Sitojun#if 0 25662615Sitojun /* 25762615Sitojun * commented out, since "for local host" is not 25862615Sitojun * implemented here - see RFC2553 p30 25962615Sitojun */ 26055163Sshin if (flags & NI_NOFQDN) { 26162615Sitojun char *p; 26255163Sshin p = strchr(hp->h_name, '.'); 26362615Sitojun if (p) 26462615Sitojun *p = '\0'; 26555163Sshin } 26662615Sitojun#endif 26766374Sitojun if (strlen(hp->h_name) + 1 > hostlen) { 26855163Sshin freehostent(hp); 269100628Sume return EAI_MEMORY; 27055163Sshin } 271114443Snectar strlcpy(host, hp->h_name, hostlen); 27255163Sshin freehostent(hp); 27355163Sshin } else { 27455163Sshin if (flags & NI_NAMEREQD) 275100628Sume return EAI_NONAME; 27662615Sitojun switch(afd->a_af) { 27762615Sitojun#ifdef INET6 27862615Sitojun case AF_INET6: 27962615Sitojun { 28062615Sitojun int error; 28162615Sitojun 28262615Sitojun if ((error = ip6_parsenumeric(sa, addr, host, 28362615Sitojun hostlen, 28462615Sitojun flags)) != 0) 28562615Sitojun return(error); 28662615Sitojun break; 28762615Sitojun } 28862615Sitojun#endif 28962615Sitojun default: 29062615Sitojun if (inet_ntop(afd->a_af, addr, host, 29162615Sitojun hostlen) == NULL) 292100628Sume return EAI_SYSTEM; 29362615Sitojun break; 29462615Sitojun } 29555163Sshin } 29655163Sshin } 297100628Sume return(0); 29855163Sshin} 29962615Sitojun 30062615Sitojun#ifdef INET6 30162615Sitojunstatic int 302157119Sumeip6_parsenumeric(const struct sockaddr *sa, const char *addr, 303157119Sume char *host, size_t hostlen, int flags) 30462615Sitojun{ 305145831Sume size_t numaddrlen; 30662615Sitojun char numaddr[512]; 30762615Sitojun 308100628Sume if (inet_ntop(AF_INET6, addr, numaddr, sizeof(numaddr)) == NULL) 309100628Sume return EAI_SYSTEM; 31062615Sitojun 31162615Sitojun numaddrlen = strlen(numaddr); 31262615Sitojun if (numaddrlen + 1 > hostlen) /* don't forget terminator */ 313158790Sume return EAI_OVERFLOW; 314114443Snectar strlcpy(host, numaddr, hostlen); 31562615Sitojun 31699252Sume if (((const struct sockaddr_in6 *)sa)->sin6_scope_id) { 31799252Sume char zonebuf[MAXHOSTNAMELEN]; 31899252Sume int zonelen; 31962615Sitojun 32099252Sume zonelen = ip6_sa2str( 32199252Sume (const struct sockaddr_in6 *)(const void *)sa, 32299252Sume zonebuf, sizeof(zonebuf), flags); 32399252Sume if (zonelen < 0) 324158790Sume return EAI_OVERFLOW; 32599252Sume if (zonelen + 1 + numaddrlen + 1 > hostlen) 326158790Sume return EAI_OVERFLOW; 327100628Sume 328100628Sume /* construct <numeric-addr><delim><zoneid> */ 32999252Sume memcpy(host + numaddrlen + 1, zonebuf, 330100628Sume (size_t)zonelen); 33199252Sume host[numaddrlen] = SCOPE_DELIMITER; 33299252Sume host[numaddrlen + 1 + zonelen] = '\0'; 33362615Sitojun } 33462615Sitojun 33562615Sitojun return 0; 33662615Sitojun} 33762615Sitojun 33862615Sitojun/* ARGSUSED */ 33962615Sitojunstatic int 340157119Sumeip6_sa2str(const struct sockaddr_in6 *sa6, char *buf, size_t bufsiz, int flags) 34162615Sitojun{ 342100628Sume unsigned int ifindex; 343100628Sume const struct in6_addr *a6; 344100628Sume int n; 34562615Sitojun 346100628Sume ifindex = (unsigned int)sa6->sin6_scope_id; 347100628Sume a6 = &sa6->sin6_addr; 348100628Sume 34962615Sitojun#ifdef NI_NUMERICSCOPE 350100628Sume if ((flags & NI_NUMERICSCOPE) != 0) { 351100628Sume n = snprintf(buf, bufsiz, "%u", sa6->sin6_scope_id); 352100628Sume if (n < 0 || n >= bufsiz) 353100628Sume return -1; 354100628Sume else 355100628Sume return n; 35662615Sitojun } 35762615Sitojun#endif 35862615Sitojun 35962615Sitojun /* if_indextoname() does not take buffer size. not a good api... */ 360100628Sume if ((IN6_IS_ADDR_LINKLOCAL(a6) || IN6_IS_ADDR_MC_LINKLOCAL(a6) || 361100628Sume IN6_IS_ADDR_MC_NODELOCAL(a6)) && bufsiz >= IF_NAMESIZE) { 36262615Sitojun char *p = if_indextoname(ifindex, buf); 36362615Sitojun if (p) { 36462615Sitojun return(strlen(p)); 36562615Sitojun } 36662615Sitojun } 36762615Sitojun 36862615Sitojun /* last resort */ 369100628Sume n = snprintf(buf, bufsiz, "%u", sa6->sin6_scope_id); 370145831Sume if (n < 0 || (size_t)n >= bufsiz) 371100628Sume return -1; 372100628Sume else 373100628Sume return n; 37462615Sitojun} 37562615Sitojun#endif /* INET6 */ 376167121Sbms 377167121Sbms/* 378167121Sbms * getnameinfo_link(): 379167121Sbms * Format a link-layer address into a printable format, paying attention to 380167121Sbms * the interface type. 381167121Sbms */ 382167121Sbms/* ARGSUSED */ 383167121Sbmsstatic int 384167121Sbmsgetnameinfo_link(const struct sockaddr *sa, socklen_t salen, 385167121Sbms char *host, size_t hostlen, char *serv, size_t servlen, int flags) 386167121Sbms{ 387167121Sbms const struct sockaddr_dl *sdl = 388167121Sbms (const struct sockaddr_dl *)(const void *)sa; 389199221Sume const struct fw_hwaddr *iha; 390167121Sbms int n; 391167121Sbms 392167121Sbms if (serv != NULL && servlen > 0) 393167121Sbms *serv = '\0'; 394167121Sbms 395167121Sbms if (sdl->sdl_nlen == 0 && sdl->sdl_alen == 0 && sdl->sdl_slen == 0) { 396167121Sbms n = snprintf(host, hostlen, "link#%d", sdl->sdl_index); 397167121Sbms if (n > hostlen) { 398167121Sbms *host = '\0'; 399167121Sbms return EAI_MEMORY; 400167121Sbms } 401167121Sbms return 0; 402167121Sbms } 403167121Sbms 404167121Sbms switch (sdl->sdl_type) { 405199221Sume case IFT_IEEE1394: 406199221Sume if (sdl->sdl_alen < sizeof(iha->sender_unique_ID_hi) + 407199221Sume sizeof(iha->sender_unique_ID_lo)) 408199221Sume return EAI_FAMILY; 409199221Sume iha = (const struct fw_hwaddr *)(const void *)LLADDR(sdl); 410199221Sume return hexname((const u_int8_t *)&iha->sender_unique_ID_hi, 411199221Sume sizeof(iha->sender_unique_ID_hi) + 412199221Sume sizeof(iha->sender_unique_ID_lo), 413199221Sume host, hostlen); 414167121Sbms /* 415167121Sbms * The following have zero-length addresses. 416167121Sbms * IFT_ATM (net/if_atmsubr.c) 417167121Sbms * IFT_FAITH (net/if_faith.c) 418167121Sbms * IFT_GIF (net/if_gif.c) 419167121Sbms * IFT_LOOP (net/if_loop.c) 420167121Sbms * IFT_PPP (net/if_ppp.c, net/if_spppsubr.c) 421167121Sbms * IFT_SLIP (net/if_sl.c, net/if_strip.c) 422167121Sbms * IFT_STF (net/if_stf.c) 423167121Sbms * IFT_L2VLAN (net/if_vlan.c) 424167121Sbms * IFT_BRIDGE (net/if_bridge.h> 425167121Sbms */ 426167121Sbms /* 427167121Sbms * The following use IPv4 addresses as link-layer addresses: 428167121Sbms * IFT_OTHER (net/if_gre.c) 429167121Sbms * IFT_OTHER (netinet/ip_ipip.c) 430167121Sbms */ 431167121Sbms /* default below is believed correct for all these. */ 432167121Sbms case IFT_ARCNET: 433167121Sbms case IFT_ETHER: 434167121Sbms case IFT_FDDI: 435167121Sbms case IFT_HIPPI: 436167121Sbms case IFT_ISO88025: 437167121Sbms default: 438167121Sbms return hexname((u_int8_t *)LLADDR(sdl), (size_t)sdl->sdl_alen, 439167121Sbms host, hostlen); 440167121Sbms } 441167121Sbms} 442167121Sbms 443167121Sbmsstatic int 444167121Sbmshexname(cp, len, host, hostlen) 445167121Sbms const u_int8_t *cp; 446167121Sbms char *host; 447167121Sbms size_t len, hostlen; 448167121Sbms{ 449167121Sbms int i, n; 450167121Sbms char *outp = host; 451167121Sbms 452167121Sbms *outp = '\0'; 453167121Sbms for (i = 0; i < len; i++) { 454167121Sbms n = snprintf(outp, hostlen, "%s%02x", 455167121Sbms i ? ":" : "", cp[i]); 456167121Sbms if (n < 0 || n >= hostlen) { 457167121Sbms *host = '\0'; 458167121Sbms return EAI_MEMORY; 459167121Sbms } 460167121Sbms outp += n; 461167121Sbms hostlen -= n; 462167121Sbms } 463167121Sbms return 0; 464167121Sbms} 465