]> git.proxmox.com Git - mirror_edk2.git/blame - StdLib/BsdSocketLib/getnameinfo.c
Fix a bug about the iSCSI DHCP dependency issue.
[mirror_edk2.git] / StdLib / BsdSocketLib / getnameinfo.c
CommitLineData
3bdf9aae 1/* $NetBSD: getnameinfo.c,v 1.45 2006/10/15 16:14:46 christos Exp $ */\r
2/* $KAME: getnameinfo.c,v 1.45 2000/09/25 22:43:56 itojun Exp $ */\r
3\r
4/*\r
5 * Copyright (c) 2000 Ben Harris.\r
6 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.\r
7 * All rights reserved.\r
8 *\r
9 * Redistribution and use in source and binary forms, with or without\r
10 * modification, are permitted provided that the following conditions\r
11 * are met:\r
12 * 1. Redistributions of source code must retain the above copyright\r
13 * notice, this list of conditions and the following disclaimer.\r
14 * 2. Redistributions in binary form must reproduce the above copyright\r
15 * notice, this list of conditions and the following disclaimer in the\r
16 * documentation and/or other materials provided with the distribution.\r
17 * 3. Neither the name of the project nor the names of its contributors\r
18 * may be used to endorse or promote products derived from this software\r
19 * without specific prior written permission.\r
20 *\r
21 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND\r
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE\r
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS\r
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT\r
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY\r
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\r
31 * SUCH DAMAGE.\r
32 */\r
33\r
34/*\r
35 * Issues to be discussed:\r
36 * - Thread safe-ness must be checked\r
37 * - RFC2553 says that we should raise error on short buffer. X/Open says\r
38 * we need to truncate the result. We obey RFC2553 (and X/Open should be\r
39 * modified). ipngwg rough consensus seems to follow RFC2553.\r
40 * - What is "local" in NI_FQDN?\r
41 * - NI_NAMEREQD and NI_NUMERICHOST conflict with each other.\r
42 * - (KAME extension) always attach textual scopeid (fe80::1%lo0), if\r
43 * sin6_scope_id is filled - standardization status?\r
44 * XXX breaks backward compat for code that expects no scopeid.\r
45 * beware on merge.\r
46 */\r
47\r
48#define INET6 1\r
49\r
50#include <sys/cdefs.h>\r
51#if defined(LIBC_SCCS) && !defined(lint)\r
52__RCSID("$NetBSD: getnameinfo.c,v 1.45 2006/10/15 16:14:46 christos Exp $");\r
53#endif /* LIBC_SCCS and not lint */\r
54\r
55#include "namespace.h"\r
56#include <sys/types.h>\r
57#include <sys/socket.h>\r
58#include <net/if.h>\r
59#include <net/if_dl.h>\r
60//#include <net/if_ieee1394.h>\r
61//#include <net/if_types.h>\r
62#include <netinet/in.h>\r
63#include <arpa/inet.h>\r
64#include <arpa/nameser.h>\r
65#include <assert.h>\r
66#include <limits.h>\r
67#include <netdb.h>\r
68#include <resolv.h>\r
69#include <stddef.h>\r
70#include <string.h>\r
71\r
72#include <net/servent.h>\r
73\r
74#define CLLADDR(x) ( LLADDR(x) )\r
75#define endservent_r(svd) endservent()\r
76#define getservbyport_r(Port,pProto,pSv,pSvd) getservbyport(Port,pProto)\r
77\r
78#ifdef __weak_alias\r
79__weak_alias(getnameinfo,_getnameinfo)\r
80#endif\r
81\r
82static\r
83int\r
84hexname(\r
85 const u_int8_t * cp,\r
86 size_t len,\r
87 char * host,\r
88 socklen_t hostlen\r
89 );\r
90\r
91static const struct afd {\r
92 int a_af;\r
93 socklen_t a_addrlen;\r
94 socklen_t a_socklen;\r
95 int a_off;\r
96} afdl [] = {\r
97#ifdef INET6\r
98 {PF_INET6, sizeof(struct in6_addr), sizeof(struct sockaddr_in6),\r
99 offsetof(struct sockaddr_in6, sin6_addr)},\r
100#endif\r
101 {PF_INET, sizeof(struct in_addr), sizeof(struct sockaddr_in),\r
102 offsetof(struct sockaddr_in, sin_addr)},\r
103 {0, 0, 0, 0},\r
104};\r
105\r
106struct sockinet {\r
107 u_char si_len;\r
108 u_char si_family;\r
109 u_short si_port;\r
110};\r
111\r
112static int getnameinfo_inet __P((const struct sockaddr *, socklen_t, char *,\r
113 socklen_t, char *, socklen_t, int));\r
114#ifdef INET6\r
115static int ip6_parsenumeric __P((const struct sockaddr *, const char *, char *,\r
116 socklen_t, int));\r
117static int ip6_sa2str __P((const struct sockaddr_in6 *, char *, size_t,\r
118 int));\r
119#endif\r
120static int getnameinfo_link __P((const struct sockaddr *, socklen_t, char *,\r
121 socklen_t, char *, socklen_t, int));\r
122static int hexname __P((const u_int8_t *, size_t, char *, socklen_t));\r
123\r
124/*\r
125 * Top-level getnameinfo() code. Look at the address family, and pick an\r
126 * appropriate function to call.\r
127 */\r
128int\r
129getnameinfo(\r
130 const struct sockaddr * sa,\r
131 socklen_t salen,\r
132 char * host,\r
133 socklen_t hostlen,\r
134 char * serv,\r
135 socklen_t servlen,\r
136 int flags\r
137 )\r
138{\r
139\r
140 switch (sa->sa_family) {\r
141 case AF_INET:\r
142 case AF_INET6:\r
143 return getnameinfo_inet(sa, salen, host, hostlen,\r
144 serv, servlen, flags);\r
145 case AF_LINK:\r
146 return getnameinfo_link(sa, salen, host, hostlen,\r
147 serv, servlen, flags);\r
148 default:\r
149 return EAI_FAMILY;\r
150 }\r
151}\r
152\r
153\r
154/*\r
155 * getnameinfo_inet():\r
156 * Format an IPv4 or IPv6 sockaddr into a printable string.\r
157 */\r
158static\r
159int\r
160getnameinfo_inet(\r
161 const struct sockaddr * sa,\r
162 socklen_t salen,\r
163 char * host,\r
164 socklen_t hostlen,\r
165 char * serv,\r
166 socklen_t servlen,\r
167 int flags\r
168 )\r
169{\r
170 const struct afd *afd;\r
171 struct servent *sp;\r
172 struct hostent *hp;\r
173 u_short port;\r
174 int family, i;\r
175 const char *addr;\r
176 u_int32_t v4a;\r
177 char numserv[512];\r
178 char numaddr[512];\r
179\r
180 /* sa is checked below */\r
181 /* host may be NULL */\r
182 /* serv may be NULL */\r
183\r
184 if (sa == NULL)\r
185 return EAI_FAIL;\r
186\r
187#ifdef BSD4_4\r
188 if (sa->sa_len != salen)\r
189 return EAI_FAIL;\r
190#endif\r
191\r
192 family = sa->sa_family;\r
193 for (i = 0; afdl[i].a_af; i++)\r
194 if (afdl[i].a_af == family) {\r
195 afd = &afdl[i];\r
196 goto found;\r
197 }\r
198 return EAI_FAMILY;\r
199\r
200 found:\r
201 if (salen != afd->a_socklen)\r
202 return EAI_FAIL;\r
203\r
204 /* network byte order */\r
205 port = ((const struct sockinet *)(const void *)sa)->si_port;\r
206 addr = (const char *)(const void *)sa + afd->a_off;\r
207\r
208 if (serv == NULL || servlen == 0) {\r
209 /*\r
210 * do nothing in this case.\r
211 * in case you are wondering if "&&" is more correct than\r
212 * "||" here: rfc2553bis-03 says that serv == NULL OR\r
213 * servlen == 0 means that the caller does not want the result.\r
214 */\r
215 } else {\r
216 if (flags & NI_NUMERICSERV)\r
217 sp = NULL;\r
218 else {\r
219 struct servent_data svd;\r
220// struct servent sv;\r
221\r
222 (void)memset(&svd, 0, sizeof(svd));\r
223 sp = getservbyport_r(port,\r
224 (flags & NI_DGRAM) ? "udp" : "tcp", &sv, &svd);\r
225 endservent_r(&svd);\r
226 }\r
227 if (sp) {\r
228 if (strlen(sp->s_name) + 1 > servlen)\r
229 return EAI_MEMORY;\r
230 strlcpy(serv, sp->s_name, servlen);\r
231 } else {\r
232 snprintf(numserv, sizeof(numserv), "%u", ntohs(port));\r
233 if (strlen(numserv) + 1 > servlen)\r
234 return EAI_MEMORY;\r
235 strlcpy(serv, numserv, servlen);\r
236 }\r
237 }\r
238\r
239 switch (sa->sa_family) {\r
240 case AF_INET:\r
241 v4a = (u_int32_t)\r
242 ntohl(((const struct sockaddr_in *)\r
243 (const void *)sa)->sin_addr.s_addr);\r
244 if (IN_MULTICAST(v4a) || IN_EXPERIMENTAL(v4a))\r
245 flags |= NI_NUMERICHOST;\r
246 v4a >>= IN_CLASSA_NSHIFT;\r
247 if (v4a == 0)\r
248 flags |= NI_NUMERICHOST;\r
249 break;\r
250#ifdef INET6\r
251 case AF_INET6:\r
252 {\r
253 const struct sockaddr_in6 *sin6;\r
254 sin6 = (const struct sockaddr_in6 *)(const void *)sa;\r
255 switch (sin6->sin6_addr.s6_addr[0]) {\r
256 case 0x00:\r
257 if (IN6_IS_ADDR_V4MAPPED(&sin6->sin6_addr))\r
258 ;\r
259 else if (IN6_IS_ADDR_LOOPBACK(&sin6->sin6_addr))\r
260 ;\r
261 else\r
262 flags |= NI_NUMERICHOST;\r
263 break;\r
264 default:\r
265 if (IN6_IS_ADDR_LINKLOCAL(&sin6->sin6_addr)) {\r
266 flags |= NI_NUMERICHOST;\r
267 }\r
268 else if (IN6_IS_ADDR_MULTICAST(&sin6->sin6_addr))\r
269 flags |= NI_NUMERICHOST;\r
270 break;\r
271 }\r
272 }\r
273 break;\r
274#endif\r
275 }\r
276 if (host == NULL || hostlen == 0) {\r
277 /*\r
278 * do nothing in this case.\r
279 * in case you are wondering if "&&" is more correct than\r
280 * "||" here: rfc2553bis-03 says that host == NULL or\r
281 * hostlen == 0 means that the caller does not want the result.\r
282 */\r
283 } else if (flags & NI_NUMERICHOST) {\r
284 size_t numaddrlen;\r
285\r
286 /* NUMERICHOST and NAMEREQD conflicts with each other */\r
287 if (flags & NI_NAMEREQD)\r
288 return EAI_NONAME;\r
289\r
290 switch(afd->a_af) {\r
291#ifdef INET6\r
292 case AF_INET6:\r
293 {\r
294 int error;\r
295\r
296 if ((error = ip6_parsenumeric(sa, addr, host,\r
297 hostlen, flags)) != 0)\r
298 return(error);\r
299 break;\r
300 }\r
301#endif\r
302 default:\r
303 if (inet_ntop(afd->a_af, addr, numaddr, sizeof(numaddr))\r
304 == NULL)\r
305 return EAI_SYSTEM;\r
306 numaddrlen = strlen(numaddr);\r
307 if (numaddrlen + 1 > hostlen) /* don't forget terminator */\r
308 return EAI_MEMORY;\r
309 strlcpy(host, numaddr, hostlen);\r
310 break;\r
311 }\r
312 } else {\r
313 hp = gethostbyaddr(addr, afd->a_addrlen, afd->a_af);\r
314\r
315 if (hp) {\r
316#if 0\r
317 /*\r
318 * commented out, since "for local host" is not\r
319 * implemented here - see RFC2553 p30\r
320 */\r
321 if (flags & NI_NOFQDN) {\r
322 char *p;\r
323 p = strchr(hp->h_name, '.');\r
324 if (p)\r
325 *p = '\0';\r
326 }\r
327#endif\r
328 if (strlen(hp->h_name) + 1 > hostlen) {\r
329 return EAI_MEMORY;\r
330 }\r
331 strlcpy(host, hp->h_name, hostlen);\r
332 } else {\r
333 if (flags & NI_NAMEREQD)\r
334 return EAI_NONAME;\r
335 switch(afd->a_af) {\r
336#ifdef INET6\r
337 case AF_INET6:\r
338 {\r
339 int error;\r
340\r
341 if ((error = ip6_parsenumeric(sa, addr, host,\r
342 hostlen,\r
343 flags)) != 0)\r
344 return(error);\r
345 break;\r
346 }\r
347#endif\r
348 default:\r
349 if (inet_ntop(afd->a_af, addr, host,\r
350 hostlen) == NULL)\r
351 return EAI_SYSTEM;\r
352 break;\r
353 }\r
354 }\r
355 }\r
356 return(0);\r
357}\r
358\r
359#ifdef INET6\r
360static int\r
361ip6_parsenumeric(\r
362 const struct sockaddr *sa,\r
363 const char *addr,\r
364 char *host,\r
365 socklen_t hostlen,\r
366 int flags\r
367 )\r
368{\r
369 size_t numaddrlen;\r
370 char numaddr[512];\r
371\r
372 _DIAGASSERT(sa != NULL);\r
373 _DIAGASSERT(addr != NULL);\r
374 _DIAGASSERT(host != NULL);\r
375\r
376 if (inet_ntop(AF_INET6, addr, numaddr, sizeof(numaddr)) == NULL)\r
377 return EAI_SYSTEM;\r
378\r
379 numaddrlen = strlen(numaddr);\r
380 if (numaddrlen + 1 > hostlen) /* don't forget terminator */\r
381 return EAI_OVERFLOW;\r
382 strlcpy(host, numaddr, hostlen);\r
383\r
384 if (((const struct sockaddr_in6 *)(const void *)sa)->sin6_scope_id) {\r
385 char zonebuf[MAXHOSTNAMELEN];\r
386 int zonelen;\r
387\r
388 zonelen = ip6_sa2str(\r
389 (const struct sockaddr_in6 *)(const void *)sa,\r
390 zonebuf, sizeof(zonebuf), flags);\r
391 if (zonelen < 0)\r
392 return EAI_OVERFLOW;\r
393 if ((size_t) zonelen + 1 + numaddrlen + 1 > hostlen)\r
394 return EAI_OVERFLOW;\r
395 /* construct <numeric-addr><delim><zoneid> */\r
396 memcpy(host + numaddrlen + 1, zonebuf,\r
397 (size_t)zonelen);\r
398 host[numaddrlen] = SCOPE_DELIMITER;\r
399 host[numaddrlen + 1 + zonelen] = '\0';\r
400 }\r
401\r
402 return 0;\r
403}\r
404\r
405/* ARGSUSED */\r
406static int\r
407ip6_sa2str(\r
408 const struct sockaddr_in6 *sa6,\r
409 char *buf,\r
410 size_t bufsiz,\r
411 int flags\r
412 )\r
413{\r
414 unsigned int ifindex;\r
415 const struct in6_addr *a6;\r
416 int n;\r
417\r
418 _DIAGASSERT(sa6 != NULL);\r
419 _DIAGASSERT(buf != NULL);\r
420\r
421 ifindex = (unsigned int)sa6->sin6_scope_id;\r
422 a6 = &sa6->sin6_addr;\r
423\r
424#ifdef NI_NUMERICSCOPE\r
425 if ((flags & NI_NUMERICSCOPE) != 0) {\r
426 n = snprintf(buf, bufsiz, "%u", sa6->sin6_scope_id);\r
427 if ((n < 0) || ((size_t)n >= bufsiz))\r
428 return -1;\r
429 else\r
430 return n;\r
431 }\r
432#endif\r
433\r
434#if 0\r
435 /* if_indextoname() does not take buffer size. not a good api... */\r
436 if ((IN6_IS_ADDR_LINKLOCAL(a6) || IN6_IS_ADDR_MC_LINKLOCAL(a6)) &&\r
437 bufsiz >= IF_NAMESIZE) {\r
438 char *p = if_indextoname(ifindex, buf);\r
439 if (p) {\r
440 return(strlen(p));\r
441 }\r
442 }\r
443#endif // 0\r
444\r
445 /* last resort */\r
446 n = snprintf(buf, bufsiz, "%u", sa6->sin6_scope_id);\r
447 if (n < 0 || (size_t) n >= bufsiz)\r
448 return -1;\r
449 else\r
450 return n;\r
451}\r
452#endif /* INET6 */\r
453\r
454\r
455/*\r
456 * getnameinfo_link():\r
457 * Format a link-layer address into a printable format, paying attention to\r
458 * the interface type.\r
459 */\r
460/* ARGSUSED */\r
461static\r
462int\r
463getnameinfo_link (\r
464 const struct sockaddr * sa,\r
465 socklen_t salen,\r
466 char * host,\r
467 socklen_t hostlen,\r
468 char * serv,\r
469 socklen_t servlen,\r
470 int flags\r
471 )\r
472{\r
473 const struct sockaddr_dl *sdl =\r
474 (const struct sockaddr_dl *)(const void *)sa;\r
475// const struct ieee1394_hwaddr *iha;\r
476 int n;\r
477\r
478 if (serv != NULL && servlen > 0)\r
479 *serv = '\0';\r
480\r
481 if (sdl->sdl_nlen == 0 && sdl->sdl_alen == 0 && sdl->sdl_slen == 0) {\r
482 n = snprintf(host, hostlen, "link#%u", sdl->sdl_index);\r
483 if (n < 0 || (socklen_t) n > hostlen) {\r
484 *host = '\0';\r
485 return EAI_MEMORY;\r
486 }\r
487 return 0;\r
488 }\r
489\r
490#if 0\r
491 switch (sdl->sdl_type) {\r
492#ifdef IFT_ECONET\r
493 case IFT_ECONET:\r
494 if (sdl->sdl_alen < 2)\r
495 return EAI_FAMILY;\r
496 if (CLLADDR(sdl)[1] == 0)\r
497 n = snprintf(host, hostlen, "%u", CLLADDR(sdl)[0]);\r
498 else\r
499 n = snprintf(host, hostlen, "%u.%u",\r
500 CLLADDR(sdl)[1], CLLADDR(sdl)[0]);\r
501 if (n < 0 || (socklen_t) n >= hostlen) {\r
502 *host = '\0';\r
503 return EAI_MEMORY;\r
504 } else\r
505 return 0;\r
506#endif\r
507 case IFT_IEEE1394:\r
508 if (sdl->sdl_alen < sizeof(iha->iha_uid))\r
509 return EAI_FAMILY;\r
510 iha =\r
511 (const struct ieee1394_hwaddr *)(const void *)CLLADDR(sdl);\r
512 return hexname(iha->iha_uid, sizeof(iha->iha_uid),\r
513 host, hostlen);\r
514 /*\r
515 * The following have zero-length addresses.\r
516 * IFT_ATM (net/if_atmsubr.c)\r
517 * IFT_FAITH (net/if_faith.c)\r
518 * IFT_GIF (net/if_gif.c)\r
519 * IFT_LOOP (net/if_loop.c)\r
520 * IFT_PPP (net/if_ppp.c, net/if_spppsubr.c)\r
521 * IFT_SLIP (net/if_sl.c, net/if_strip.c)\r
522 * IFT_STF (net/if_stf.c)\r
523 * IFT_L2VLAN (net/if_vlan.c)\r
524 * IFT_PROPVIRTUAL (net/if_bridge.h>\r
525 */\r
526 /*\r
527 * The following use IPv4 addresses as link-layer addresses:\r
528 * IFT_OTHER (net/if_gre.c)\r
529 */\r
530 case IFT_ARCNET: /* default below is believed correct for all these. */\r
531 case IFT_ETHER:\r
532 case IFT_FDDI:\r
533 case IFT_HIPPI:\r
534 case IFT_ISO88025:\r
535 default:\r
536#endif // 0\r
537 return hexname((const u_int8_t *)CLLADDR(sdl),\r
538 (size_t)sdl->sdl_alen, host, hostlen);\r
539// }\r
540}\r
541\r
542static\r
543int\r
544hexname(\r
545 const u_int8_t * cp,\r
546 size_t len,\r
547 char * host,\r
548 socklen_t hostlen\r
549 )\r
550{\r
551 int n;\r
552 size_t i;\r
553 char *outp = host;\r
554\r
555 *outp = '\0';\r
556 for (i = 0; i < len; i++) {\r
557 n = snprintf(outp, hostlen, "%s%02x",\r
558 i ? ":" : "", cp[i]);\r
559 if (n < 0 || (socklen_t) n >= hostlen) {\r
560 *host = '\0';\r
561 return EAI_MEMORY;\r
562 }\r
563 outp += n;\r
564 hostlen -= n;\r
565 }\r
566 return 0;\r
567}\r