1 /* $FreeBSD: src/lib/libc/net/getnameinfo.c,v 1.20 2007/02/28 21:18:38 bms Exp $ */
2 /* $KAME: getnameinfo.c,v 1.61 2002/06/27 09:25:47 itojun Exp $ */
5 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
6 * Copyright (c) 2000 Ben Harris.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the project nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * Issues to be discussed:
36 * - Thread safe-ness must be checked
37 * - RFC2553 says that we should raise error on short buffer. X/Open says
38 * we need to truncate the result. We obey RFC2553 (and X/Open should be
39 * modified). ipngwg rough consensus seems to follow RFC2553.
40 * - What is "local" in NI_FQDN?
41 * - NI_NAMEREQD and NI_NUMERICHOST conflict with each other.
42 * - (KAME extension) always attach textual scopeid (fe80::1%lo0), if
43 * sin6_scope_id is filled - standardization status?
44 * XXX breaks backward compat for code that expects no scopeid.
48 #include <sys/types.h>
49 #include <sys/socket.h>
51 #include <net/if_dl.h>
52 #include <net/if_types.h>
53 #include <netinet/in.h>
54 #include <arpa/inet.h>
55 #include <arpa/nameser.h>
62 static int getnameinfo_inet(const struct sockaddr *, socklen_t, char *,
63 size_t, char *, size_t, int);
65 static int ip6_parsenumeric(const struct sockaddr *, const char *, char *,
67 static int ip6_sa2str(const struct sockaddr_in6 *, char *, size_t, int);
69 static int getnameinfo_link(const struct sockaddr *, socklen_t, char *,
70 size_t, char *, size_t, int);
71 static int hexname(const u_int8_t *, size_t, char *, size_t);
74 getnameinfo(const struct sockaddr *sa, socklen_t salen, char *host,
75 size_t hostlen, char *serv, size_t servlen, int flags)
78 switch (sa->sa_family) {
83 return getnameinfo_inet(sa, salen, host, hostlen, serv,
86 return getnameinfo_link(sa, salen, host, hostlen, serv,
93 static const struct afd {
100 {PF_INET6, sizeof(struct in6_addr), sizeof(struct sockaddr_in6),
101 offsetof(struct sockaddr_in6, sin6_addr)},
103 {PF_INET, sizeof(struct in_addr), sizeof(struct sockaddr_in),
104 offsetof(struct sockaddr_in, sin_addr)},
115 getnameinfo_inet(const struct sockaddr *sa, socklen_t salen, char *host,
116 size_t hostlen, char *serv, size_t servlen, int flags)
118 const struct afd *afd;
132 family = sa->sa_family;
133 for (i = 0; afdl[i].a_af; i++)
134 if (afdl[i].a_af == family) {
141 if (salen != afd->a_socklen)
144 /* network byte order */
145 port = ((const struct sockinet *)sa)->si_port;
146 addr = (const char *)sa + afd->a_off;
148 if (serv == NULL || servlen == 0) {
150 * do nothing in this case.
151 * in case you are wondering if "&&" is more correct than
152 * "||" here: rfc2553bis-03 says that serv == NULL OR
153 * servlen == 0 means that the caller does not want the result.
156 if (flags & NI_NUMERICSERV)
159 sp = getservbyport(port,
160 (flags & NI_DGRAM) ? "udp" : "tcp");
163 if (strlen(sp->s_name) + 1 > servlen)
165 strlcpy(serv, sp->s_name, servlen);
167 snprintf(numserv, sizeof(numserv), "%u", ntohs(port));
168 if (strlen(numserv) + 1 > servlen)
170 strlcpy(serv, numserv, servlen);
174 switch (sa->sa_family) {
177 ntohl(((const struct sockaddr_in *)sa)->sin_addr.s_addr);
178 if (IN_MULTICAST(v4a) || IN_EXPERIMENTAL(v4a))
179 flags |= NI_NUMERICHOST;
180 v4a >>= IN_CLASSA_NSHIFT;
182 flags |= NI_NUMERICHOST;
187 const struct sockaddr_in6 *sin6;
188 sin6 = (const struct sockaddr_in6 *)sa;
189 switch (sin6->sin6_addr.s6_addr[0]) {
191 if (IN6_IS_ADDR_V4MAPPED(&sin6->sin6_addr))
193 else if (IN6_IS_ADDR_LOOPBACK(&sin6->sin6_addr))
196 flags |= NI_NUMERICHOST;
199 if (IN6_IS_ADDR_LINKLOCAL(&sin6->sin6_addr)) {
200 flags |= NI_NUMERICHOST;
202 else if (IN6_IS_ADDR_MULTICAST(&sin6->sin6_addr))
203 flags |= NI_NUMERICHOST;
210 if (host == NULL || hostlen == 0) {
212 * do nothing in this case.
213 * in case you are wondering if "&&" is more correct than
214 * "||" here: rfc2553bis-03 says that host == NULL or
215 * hostlen == 0 means that the caller does not want the result.
217 } else if (flags & NI_NUMERICHOST) {
220 /* NUMERICHOST and NAMEREQD conflicts with each other */
221 if (flags & NI_NAMEREQD)
230 if ((error = ip6_parsenumeric(sa, addr, host,
231 hostlen, flags)) != 0)
237 if (inet_ntop(afd->a_af, addr, numaddr, sizeof(numaddr))
240 numaddrlen = strlen(numaddr);
241 if (numaddrlen + 1 > hostlen) /* don't forget terminator */
243 strlcpy(host, numaddr, hostlen);
247 hp = getipnodebyaddr(addr, afd->a_addrlen, afd->a_af, &h_error);
252 * commented out, since "for local host" is not
253 * implemented here - see RFC2553 p30
255 if (flags & NI_NOFQDN) {
257 p = strchr(hp->h_name, '.');
262 if (strlen(hp->h_name) + 1 > hostlen) {
266 strlcpy(host, hp->h_name, hostlen);
269 if (flags & NI_NAMEREQD)
277 if ((error = ip6_parsenumeric(sa, addr, host,
285 if (inet_ntop(afd->a_af, addr, host,
297 ip6_parsenumeric(const struct sockaddr *sa, const char *addr, char *host,
298 size_t hostlen, int flags)
303 if (inet_ntop(AF_INET6, addr, numaddr, sizeof(numaddr)) == NULL)
306 numaddrlen = strlen(numaddr);
307 if (numaddrlen + 1 > hostlen) /* don't forget terminator */
309 strlcpy(host, numaddr, hostlen);
311 if (((const struct sockaddr_in6 *)sa)->sin6_scope_id) {
312 char zonebuf[MAXHOSTNAMELEN];
315 zonelen = ip6_sa2str(
316 (const struct sockaddr_in6 *)(const void *)sa,
317 zonebuf, sizeof(zonebuf), flags);
320 if (zonelen + 1 + numaddrlen + 1 > hostlen)
323 /* construct <numeric-addr><delim><zoneid> */
324 memcpy(host + numaddrlen + 1, zonebuf,
326 host[numaddrlen] = SCOPE_DELIMITER;
327 host[numaddrlen + 1 + zonelen] = '\0';
335 ip6_sa2str(const struct sockaddr_in6 *sa6, char *buf, size_t bufsiz, int flags)
337 unsigned int ifindex;
338 const struct in6_addr *a6;
341 ifindex = (unsigned int)sa6->sin6_scope_id;
342 a6 = &sa6->sin6_addr;
344 #ifdef NI_NUMERICSCOPE
345 if ((flags & NI_NUMERICSCOPE) != 0) {
346 n = snprintf(buf, bufsiz, "%u", sa6->sin6_scope_id);
347 if (n < 0 || n >= bufsiz)
354 /* if_indextoname() does not take buffer size. not a good api... */
355 if ((IN6_IS_ADDR_LINKLOCAL(a6) || IN6_IS_ADDR_MC_LINKLOCAL(a6) ||
356 IN6_IS_ADDR_MC_NODELOCAL(a6)) && bufsiz >= IF_NAMESIZE) {
357 char *p = if_indextoname(ifindex, buf);
364 n = snprintf(buf, bufsiz, "%u", sa6->sin6_scope_id);
365 if (n < 0 || (size_t)n >= bufsiz)
373 * getnameinfo_link():
374 * Format a link-layer address into a printable format, paying attention to
375 * the interface type.
379 getnameinfo_link(const struct sockaddr *sa, socklen_t salen, char *host,
380 size_t hostlen, char *serv, size_t servlen, int flags)
382 const struct sockaddr_dl *sdl =
383 (const struct sockaddr_dl *)(const void *)sa;
386 if (serv != NULL && servlen > 0)
389 if (sdl->sdl_nlen == 0 && sdl->sdl_alen == 0 && sdl->sdl_slen == 0) {
390 n = snprintf(host, hostlen, "link#%d", sdl->sdl_index);
398 switch (sdl->sdl_type) {
400 * The following have zero-length addresses.
401 * IFT_ATM (net/if_atmsubr.c)
402 * IFT_FAITH (net/if_faith.c)
403 * IFT_GIF (net/if_gif.c)
404 * IFT_LOOP (net/if_loop.c)
405 * IFT_PPP (net/if_ppp.c, net/if_spppsubr.c)
406 * IFT_SLIP (net/if_sl.c, net/if_strip.c)
407 * IFT_STF (net/if_stf.c)
408 * IFT_L2VLAN (net/if_vlan.c)
409 * IFT_BRIDGE (net/if_bridge.h>
412 * The following use IPv4 addresses as link-layer addresses:
413 * IFT_OTHER (net/if_gre.c)
414 * IFT_OTHER (netinet/ip_ipip.c)
416 /* default below is believed correct for all these. */
423 return hexname((u_int8_t *)LLADDR(sdl), (size_t)sdl->sdl_alen,
429 hexname(const u_int8_t *cp, size_t len, char *host, size_t hostlen)
435 for (i = 0; i < len; i++) {
436 n = snprintf(outp, hostlen, "%s%02x",
437 i ? ":" : "", cp[i]);
438 if (n < 0 || n >= hostlen) {