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