1 /* $KAME: getnameinfo.c,v 1.61 2002/06/27 09:25:47 itojun Exp $ */
4 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
5 * Copyright (c) 2000 Ben Harris.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the project nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * Issues to be discussed:
35 * - Thread safe-ness must be checked
36 * - RFC2553 says that we should raise error on short buffer. X/Open says
37 * we need to truncate the result. We obey RFC2553 (and X/Open should be
38 * modified). ipngwg rough consensus seems to follow RFC2553.
39 * - What is "local" in NI_FQDN?
40 * - NI_NAMEREQD and NI_NUMERICHOST conflict with each other.
41 * - (KAME extension) always attach textual scopeid (fe80::1%lo0), if
42 * sin6_scope_id is filled - standardization status?
43 * XXX breaks backward compat for code that expects no scopeid.
47 #include <sys/cdefs.h>
48 __FBSDID("$FreeBSD$");
50 #include <sys/types.h>
51 #include <sys/socket.h>
53 #include <net/if_dl.h>
54 #include <net/if_types.h>
55 #include <net/firewire.h>
56 #include <netinet/in.h>
57 #include <arpa/inet.h>
58 #include <arpa/nameser.h>
65 static int getnameinfo_inet(const struct sockaddr *, socklen_t, char *,
66 size_t, char *, size_t, int);
68 static int ip6_parsenumeric(const struct sockaddr *, const char *, char *,
70 static int ip6_sa2str(const struct sockaddr_in6 *, char *, size_t, int);
72 static int getnameinfo_link(const struct sockaddr *, socklen_t, char *,
73 size_t, char *, size_t, int);
74 static int hexname(const u_int8_t *, size_t, char *, size_t);
77 getnameinfo(const struct sockaddr *sa, socklen_t salen,
78 char *host, size_t hostlen, char *serv, size_t servlen,
82 switch (sa->sa_family) {
87 return getnameinfo_inet(sa, salen, host, hostlen, serv,
90 return getnameinfo_link(sa, salen, host, hostlen, serv,
97 static const struct afd {
104 {PF_INET6, sizeof(struct in6_addr), sizeof(struct sockaddr_in6),
105 offsetof(struct sockaddr_in6, sin6_addr)},
107 {PF_INET, sizeof(struct in_addr), sizeof(struct sockaddr_in),
108 offsetof(struct sockaddr_in, sin_addr)},
119 getnameinfo_inet(const struct sockaddr *sa, socklen_t salen,
120 char *host, size_t hostlen, char *serv, size_t servlen,
123 const struct afd *afd;
137 family = sa->sa_family;
138 for (i = 0; afdl[i].a_af; i++)
139 if (afdl[i].a_af == family) {
146 if (salen != afd->a_socklen)
149 /* network byte order */
150 port = ((const struct sockinet *)sa)->si_port;
151 addr = (const char *)sa + afd->a_off;
153 if (serv == NULL || servlen == 0) {
155 * do nothing in this case.
156 * in case you are wondering if "&&" is more correct than
157 * "||" here: rfc2553bis-03 says that serv == NULL OR
158 * servlen == 0 means that the caller does not want the result.
161 if (flags & NI_NUMERICSERV)
164 sp = getservbyport(port,
165 (flags & NI_DGRAM) ? "udp" : "tcp");
168 if (strlen(sp->s_name) + 1 > servlen)
170 strlcpy(serv, sp->s_name, servlen);
172 snprintf(numserv, sizeof(numserv), "%u", ntohs(port));
173 if (strlen(numserv) + 1 > servlen)
175 strlcpy(serv, numserv, servlen);
179 switch (sa->sa_family) {
182 ntohl(((const struct sockaddr_in *)sa)->sin_addr.s_addr);
183 if (IN_MULTICAST(v4a) || IN_EXPERIMENTAL(v4a))
184 flags |= NI_NUMERICHOST;
185 v4a >>= IN_CLASSA_NSHIFT;
187 flags |= NI_NUMERICHOST;
192 const struct sockaddr_in6 *sin6;
193 sin6 = (const struct sockaddr_in6 *)sa;
194 switch (sin6->sin6_addr.s6_addr[0]) {
196 if (IN6_IS_ADDR_V4MAPPED(&sin6->sin6_addr))
198 else if (IN6_IS_ADDR_LOOPBACK(&sin6->sin6_addr))
201 flags |= NI_NUMERICHOST;
204 if (IN6_IS_ADDR_LINKLOCAL(&sin6->sin6_addr)) {
205 flags |= NI_NUMERICHOST;
207 else if (IN6_IS_ADDR_MULTICAST(&sin6->sin6_addr))
208 flags |= NI_NUMERICHOST;
215 if (host == NULL || hostlen == 0) {
217 * do nothing in this case.
218 * in case you are wondering if "&&" is more correct than
219 * "||" here: rfc2553bis-03 says that host == NULL or
220 * hostlen == 0 means that the caller does not want the result.
222 } else if (flags & NI_NUMERICHOST) {
225 /* NUMERICHOST and NAMEREQD conflicts with each other */
226 if (flags & NI_NAMEREQD)
235 if ((error = ip6_parsenumeric(sa, addr, host,
236 hostlen, flags)) != 0)
242 if (inet_ntop(afd->a_af, addr, numaddr, sizeof(numaddr))
245 numaddrlen = strlen(numaddr);
246 if (numaddrlen + 1 > hostlen) /* don't forget terminator */
248 strlcpy(host, numaddr, hostlen);
252 hp = getipnodebyaddr(addr, afd->a_addrlen, afd->a_af, &h_error);
257 * commented out, since "for local host" is not
258 * implemented here - see RFC2553 p30
260 if (flags & NI_NOFQDN) {
262 p = strchr(hp->h_name, '.');
267 if (strlen(hp->h_name) + 1 > hostlen) {
271 strlcpy(host, hp->h_name, hostlen);
274 if (flags & NI_NAMEREQD)
282 if ((error = ip6_parsenumeric(sa, addr, host,
290 if (inet_ntop(afd->a_af, addr, host,
302 ip6_parsenumeric(const struct sockaddr *sa, const char *addr,
303 char *host, size_t hostlen, int flags)
308 if (inet_ntop(AF_INET6, addr, numaddr, sizeof(numaddr)) == NULL)
311 numaddrlen = strlen(numaddr);
312 if (numaddrlen + 1 > hostlen) /* don't forget terminator */
314 strlcpy(host, numaddr, hostlen);
316 if (((const struct sockaddr_in6 *)sa)->sin6_scope_id) {
317 char zonebuf[MAXHOSTNAMELEN];
320 zonelen = ip6_sa2str(
321 (const struct sockaddr_in6 *)(const void *)sa,
322 zonebuf, sizeof(zonebuf), flags);
325 if (zonelen + 1 + numaddrlen + 1 > hostlen)
328 /* construct <numeric-addr><delim><zoneid> */
329 memcpy(host + numaddrlen + 1, zonebuf,
331 host[numaddrlen] = SCOPE_DELIMITER;
332 host[numaddrlen + 1 + zonelen] = '\0';
340 ip6_sa2str(const struct sockaddr_in6 *sa6, char *buf, size_t bufsiz, int flags)
342 unsigned int ifindex;
343 const struct in6_addr *a6;
346 ifindex = (unsigned int)sa6->sin6_scope_id;
347 a6 = &sa6->sin6_addr;
349 #ifdef NI_NUMERICSCOPE
350 if ((flags & NI_NUMERICSCOPE) != 0) {
351 n = snprintf(buf, bufsiz, "%u", sa6->sin6_scope_id);
352 if (n < 0 || n >= bufsiz)
359 /* if_indextoname() does not take buffer size. not a good api... */
360 if ((IN6_IS_ADDR_LINKLOCAL(a6) || IN6_IS_ADDR_MC_LINKLOCAL(a6) ||
361 IN6_IS_ADDR_MC_NODELOCAL(a6)) && bufsiz >= IF_NAMESIZE) {
362 char *p = if_indextoname(ifindex, buf);
369 n = snprintf(buf, bufsiz, "%u", sa6->sin6_scope_id);
370 if (n < 0 || (size_t)n >= bufsiz)
378 * getnameinfo_link():
379 * Format a link-layer address into a printable format, paying attention to
380 * the interface type.
384 getnameinfo_link(const struct sockaddr *sa, socklen_t salen,
385 char *host, size_t hostlen, char *serv, size_t servlen, int flags)
387 const struct sockaddr_dl *sdl =
388 (const struct sockaddr_dl *)(const void *)sa;
389 const struct fw_hwaddr *iha;
392 if (serv != NULL && servlen > 0)
395 if (sdl->sdl_nlen == 0 && sdl->sdl_alen == 0 && sdl->sdl_slen == 0) {
396 n = snprintf(host, hostlen, "link#%d", sdl->sdl_index);
404 switch (sdl->sdl_type) {
406 if (sdl->sdl_alen < sizeof(iha->sender_unique_ID_hi) +
407 sizeof(iha->sender_unique_ID_lo))
409 iha = (const struct fw_hwaddr *)(const void *)LLADDR(sdl);
410 return hexname((const u_int8_t *)&iha->sender_unique_ID_hi,
411 sizeof(iha->sender_unique_ID_hi) +
412 sizeof(iha->sender_unique_ID_lo),
415 * The following have zero-length addresses.
416 * IFT_ATM (net/if_atmsubr.c)
417 * IFT_FAITH (net/if_faith.c)
418 * IFT_GIF (net/if_gif.c)
419 * IFT_LOOP (net/if_loop.c)
420 * IFT_PPP (net/if_ppp.c, net/if_spppsubr.c)
421 * IFT_SLIP (net/if_sl.c, net/if_strip.c)
422 * IFT_STF (net/if_stf.c)
423 * IFT_L2VLAN (net/if_vlan.c)
424 * IFT_BRIDGE (net/if_bridge.h>
427 * The following use IPv4 addresses as link-layer addresses:
428 * IFT_OTHER (net/if_gre.c)
429 * IFT_OTHER (netinet/ip_ipip.c)
431 /* default below is believed correct for all these. */
438 return hexname((u_int8_t *)LLADDR(sdl), (size_t)sdl->sdl_alen,
444 hexname(cp, len, host, hostlen)
453 for (i = 0; i < len; i++) {
454 n = snprintf(outp, hostlen, "%s%02x",
455 i ? ":" : "", cp[i]);
456 if (n < 0 || n >= hostlen) {