lookup.subproj/getaddrinfo.3

   1 .\"     $KAME: getaddrinfo.3,v 1.36 2005/01/05 03:23:05 itojun Exp $
   2 .\"     $OpenBSD: getaddrinfo.3,v 1.35 2004/12/21 03:40:31 jaredy Exp $
   3 .\"
   4 .\" Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   5 .\" Copyright (C) 2000, 2001  Internet Software Consortium.
   6 .\"
   7 .\" Permission to use, copy, modify, and distribute this software for any
   8 .\" purpose with or without fee is hereby granted, provided that the above
   9 .\" copyright notice and this permission notice appear in all copies.
  10 .\"
  11 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  12 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  13 .\" AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  14 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  15 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  16 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  17 .\" PERFORMANCE OF THIS SOFTWARE.
  18 .\"
  19 .\" $FreeBSD: src/lib/libc/net/getaddrinfo.3,v 1.34 2008/07/01 22:59:20 danger Exp $
  20 .\"
  21 .Dd July 1, 2008
  22 .Dt GETADDRINFO 3
  23 .Os
  24 .Sh NAME
  25 .Nm getaddrinfo ,
  26 .Nm freeaddrinfo
  27 .Nd socket address structure to host and service name
  28 .Sh SYNOPSIS
  29 .Fd #include <sys/types.h>
  30 .Fd #include <sys/socket.h>
  31 .Fd #include <netdb.h>
  32 .Ft int
  33 .Fo getaddrinfo
  34 .Fa "const char *hostname" "const char *servname"
  35 .Fa "const struct addrinfo *hints" "struct addrinfo **res"
  36 .Fc
  37 .Ft void
  38 .Fn freeaddrinfo "struct addrinfo *ai"
  39 .Sh DESCRIPTION
  40 The
  41 .Fn getaddrinfo
  42 function is used to get a list of
  43 .Tn IP
  44 addresses and port numbers for host
  45 .Fa hostname
  46 and service
  47 .Fa servname .
  48 It is a replacement for and provides more flexibility than the
  49 .Xr gethostbyname 3
  50 and
  51 .Xr getservbyname 3
  52 functions.
  53 .Pp
  54 The
  55 .Fa hostname
  56 and
  57 .Fa servname
  58 arguments are either pointers to NUL-terminated strings or the null pointer.
  59 An acceptable value for
  60 .Fa hostname
  61 is either a valid host name or a numeric host address string consisting
  62 of a dotted decimal IPv4 address or an IPv6 address.
  63 The
  64 .Fa servname
  65 is either a decimal port number or a service name listed in
  66 .Xr services 5 .
  67 At least one of
  68 .Fa hostname
  69 and
  70 .Fa servname
  71 must be non-null.
  72 .Pp
  73 .Fa hints
  74 is an optional pointer to a
  75 .Li struct addrinfo ,
  76 as defined by
  77 .Aq Pa netdb.h :
  78 .Bd -literal
  79 struct addrinfo {
  80         int ai_flags;           /* input flags */
  81         int ai_family;          /* protocol family for socket */
  82         int ai_socktype;        /* socket type */
  83         int ai_protocol;        /* protocol for socket */
  84         socklen_t ai_addrlen;   /* length of socket-address */
  85         struct sockaddr *ai_addr; /* socket-address for socket */
  86         char *ai_canonname;     /* canonical name for service location */
  87         struct addrinfo *ai_next; /* pointer to next in list */
  88 };
  89 .Ed
  90 .Pp
  91 This structure can be used to provide hints concerning the type of socket
  92 that the caller supports or wishes to use.
  93 The caller can supply the following structure elements in
  94 .Fa hints :
  95 .Bl -tag -width "ai_socktypeXX"
  96 .It Fa ai_family
  97 The protocol family that should be used.
  98 When
  99 .Fa ai_family
 100 is set to
 101 .Dv PF_UNSPEC ,
 102 it means the caller will accept any protocol family supported by the
 103 operating system.
 104 .It Fa ai_socktype
 105 Denotes the type of socket that is wanted:
 106 .Dv SOCK_STREAM ,
 107 .Dv SOCK_DGRAM ,
 108 or
 109 .Dv SOCK_RAW .
 110 When
 111 .Fa ai_socktype
 112 is zero the caller will accept any socket type.
 113 .It Fa ai_protocol
 114 Indicates which transport protocol is desired,
 115 .Dv IPPROTO_UDP
 116 or
 117 .Dv IPPROTO_TCP .
 118 If
 119 .Fa ai_protocol
 120 is zero the caller will accept any protocol.
 121 .It Fa ai_flags
 122 The
 123 .Fa ai_flags
 124 field to which the
 125 .Fa hints
 126 parameter points shall be set to zero
 127 or be the bitwise-inclusive OR of one or more of the values
 128 .Dv AI_ADDRCONFIG ,
 129 .Dv AI_ALL ,
 130 .Dv AI_CANONNAME ,
 131 .Dv AI_NUMERICHOST ,
 132 .Dv AI_NUMERICSERV ,
 133 .Dv AI_PASSIVE ,
 134 .Dv AI_V4MAPPED ,
 135 .Dv AI_V4MAPPED_CFG ,
 136 and
 137 .Dv AI_DEFAULT .
 138 .Bl -tag -width "AI_CANONNAMEXX"
 139 .It Dv AI_ADDRCONFIG
 140 If the
 141 .Dv AI_ADDRCONFIG
 142 bit is set, IPv4 addresses shall be returned only if
 143 an IPv4 address is configured on the local system,
 144 and IPv6 addresses shall be returned only if
 145 an IPv6 address is configured on the local system.
 146 .It Dv AI_ALL
 147 If the
 148 .Dv AI_ALL
 149 bit is set with the
 150 .Dv AI_V4MAPPED
 151 bit, then
 152 .Fn getaddrinfo
 153 shall return all matching IPv6 and IPv4 addresses.
 154 The
 155 .Dv AI_ALL
 156 bit without the
 157 .Dv AI_V4MAPPED
 158 bit is ignored.
 159 .It Dv AI_CANONNAME
 160 If the
 161 .Dv AI_CANONNAME
 162 bit is set, a successful call to
 163 .Fn getaddrinfo
 164 will return a NUL-terminated string containing the canonical name
 165 of the specified hostname in the
 166 .Fa ai_canonname
 167 element of the first
 168 .Li addrinfo
 169 structure returned.
 170 .It Dv AI_NUMERICHOST
 171 If the
 172 .Dv AI_NUMERICHOST
 173 bit is set, it indicates that
 174 .Fa hostname
 175 should be treated as a numeric string defining an IPv4 or IPv6 address
 176 and no name resolution should be attempted.
 177 .It Dv AI_NUMERICSERV
 178 If the
 179 .Dv AI_NUMERICSERV
 180 bit is set,
 181 then a non-null
 182 .Fa servname
 183 string supplied shall be a numeric port string.
 184 Otherwise, an
 185 .Dv EAI_NONAME
 186 error shall be returned.
 187 This bit shall prevent any type of name resolution service
 188 (for example, NIS+) from being invoked.
 189 .It Dv AI_PASSIVE
 190 If the
 191 .Dv AI_PASSIVE
 192 bit is set it indicates that the returned socket address structure
 193 is intended for use in a call to
 194 .Xr bind 2 .
 195 In this case, if the
 196 .Fa hostname
 197 argument is the null pointer, then the IP address portion of the
 198 socket address structure will be set to
 199 .Dv INADDR_ANY
 200 for an IPv4 address or
 201 .Dv IN6ADDR_ANY_INIT
 202 for an IPv6 address.
 203 .Pp
 204 If the
 205 .Dv AI_PASSIVE
 206 bit is not set, the returned socket address structure will be ready
 207 for use in a call to
 208 .Xr connect 2
 209 for a connection-oriented protocol or
 210 .Xr connect 2 ,
 211 .Xr sendto 2 ,
 212 or
 213 .Xr sendmsg 2
 214 if a connectionless protocol was chosen.
 215 The
 216 .Tn IP
 217 address portion of the socket address structure will be set to the
 218 loopback address if
 219 .Fa hostname
 220 is the null pointer and
 221 .Dv AI_PASSIVE
 222 is not set.
 223 .It Dv AI_V4MAPPED
 224 If the
 225 .Dv AI_V4MAPPED
 226 flag is specified along with an
 227 .Fa ai_family
 228 of
 229 .Dv PF_INET6 ,
 230 then
 231 .Fn getaddrinfo
 232 shall return IPv4-mapped IPv6 addresses
 233 on finding no matching IPv6 addresses (
 234 .Fa ai_addrlen
 235 shall be 16).
 236 The
 237 .Dv AI_V4MAPPED
 238 flag shall be ignored unless
 239 .Fa ai_family
 240 equals
 241 .Dv PF_INET6 .
 242 .It Dv AI_V4MAPPED_CFG
 243 The
 244 .Dv AI_V4MAPPED_CFG
 245 flag behaves exactly like the
 246 .Dv AI_V4MAPPED
 247 flag if the kernel supports IPv4-mapped IPv6 addresses. Otherwise it is ignored.
 248 .It Dv AI_DEFAULT
 249 .Dv AI_DEFAULT
 250 is defined as (
 251 .Dv AI_V4MAPPED_CFG
 252 |
 253 .Dv AI_ADDRCONFIG
 254 ).
 255 .El
 256 .El
 257 .Pp
 258 All other elements of the
 259 .Li addrinfo
 260 structure passed via
 261 .Fa hints
 262 must be zero or the null pointer.
 263 .Pp
 264 If
 265 .Fa hints
 266 is the null pointer,
 267 .Fn getaddrinfo
 268 behaves as if the caller provided a
 269 .Li struct addrinfo
 270 with
 271 .Fa ai_family
 272 set to
 273 .Dv PF_UNSPEC
 274 and all other elements set to zero or
 275 .Dv NULL .
 276 .Pp
 277 After a successful call to
 278 .Fn getaddrinfo ,
 279 .Fa *res
 280 is a pointer to a linked list of one or more
 281 .Li addrinfo
 282 structures.
 283 The list can be traversed by following the
 284 .Fa ai_next
 285 pointer in each
 286 .Li addrinfo
 287 structure until a null pointer is encountered.
 288 The three members
 289 .Fa ai_family,
 290 .Fa ai_socktype,
 291 and
 292 .Fa ai_protocol
 293 in each returned
 294 .Li addrinfo
 295 structure are suitable for a call to
 296 .Xr socket 2 .
 297 For each
 298 .Li addrinfo
 299 structure in the list, the
 300 .Fa ai_addr
 301 member points to a filled-in socket address structure of length
 302 .Fa ai_addrlen .
 303 .Pp
 304 This implementation of
 305 .Fn getaddrinfo
 306 allows numeric IPv6 address notation with scope identifier,
 307 as documented in section 11 of RFC 4007.
 308 By appending the percent character and scope identifier to addresses,
 309 one can fill the
 310 .Li sin6_scope_id
 311 field for addresses.
 312 This would make management of scoped addresses easier
 313 and allows cut-and-paste input of scoped addresses.
 314 .Pp
 315 At this moment the code supports only link-local addresses with the format.
 316 The scope identifier is hardcoded to the name of the hardware interface
 317 associated
 318 with the link
 319 .Po
 320 such as
 321 .Li ne0
 322 .Pc .
 323 An example is
 324 .Dq Li fe80::1%ne0 ,
 325 which means
 326 .Do
 327 .Li fe80::1
 328 on the link associated with the
 329 .Li ne0
 330 interface
 331 .Dc .
 332 .Pp
 333 The current implementation assumes a one-to-one relationship between
 334 the interface and link, which is not necessarily true from the specification.
 335 .Pp
 336 All of the information returned by
 337 .Fn getaddrinfo
 338 is dynamically allocated: the
 339 .Li addrinfo
 340 structures themselves as well as the socket address structures and
 341 the canonical host name strings included in the
 342 .Li addrinfo
 343 structures.
 344 .Pp
 345 Memory allocated for the dynamically allocated structures created by
 346 a successful call to
 347 .Fn getaddrinfo
 348 is released by the
 349 .Fn freeaddrinfo
 350 function.
 351 The
 352 .Fa ai
 353 pointer should be an
 354 .Li addrinfo
 355 structure created by a call to
 356 .Fn getaddrinfo .
 357 .Pp
 358 The current implementation supports synthesis of NAT64 mapped IPv6 addresses.
 359 If
 360 .Fa hostname
 361 is a numeric string defining an IPv4 address (for example,
 362 .Dq Li 192.0.2.1
 363 ) and
 364 .Fa ai_family
 365 is set to
 366 .Dv PF_UNSPEC
 367 or
 368 .Dv PF_INET6,
 369 .Fn getaddrinfo
 370 will synthesize the appropriate IPv6 address(es) (for example,
 371 .Dq Li 64:ff9b::192.0.2.1
 372 ) if the current interface supports IPv6, NAT64 and DNS64
 373 and does not support IPv4. If the
 374 .Dv AI_ADDRCONFIG
 375 flag is set, the IPv4 address will be suppressed on those interfaces.
 376 On non-qualifying interfaces,
 377 .Fn getaddrinfo
 378 is guaranteed to return immediately without attempting any resolution, and will
 379 return the IPv4 address if
 380 .Fa ai_family
 381 is
 382 .Dv PF_UNSPEC
 383 or
 384 .Dv PF_INET.
 385 NAT64 address synthesis can be disabled by setting the
 386 .Dv AI_NUMERICHOST
 387 flag. To best support NAT64 networks, it is recommended to resolve all
 388 IP address literals with
 389 .Fa ai_family
 390 set to
 391 .Dv PF_UNSPEC
 392 and
 393 .Fa ai_flags
 394 set to
 395 .Dv AI_DEFAULT.
 396 .Sh RETURN VALUES
 397 .Fn getaddrinfo
 398 returns zero on success or one of the error codes listed in
 399 .Xr gai_strerror 3
 400 if an error occurs.
 401 .Sh EXAMPLES
 402 The following code tries to connect to
 403 .Dq Li www.kame.net
 404 service
 405 .Dq Li http
 406 via a stream socket.
 407 It loops through all the addresses available, regardless of address family.
 408 If the destination resolves to an IPv4 address, it will use an
 409 .Dv PF_INET
 410 socket.
 411 Similarly, if it resolves to IPv6, an
 412 .Dv PF_INET6
 413 socket is used.
 414 Observe that there is no hardcoded reference to a particular address family.
 415 The code works even if
 416 .Fn getaddrinfo
 417 returns addresses that are not IPv4/v6.
 418 .Bd -literal -offset indent
 419 struct addrinfo hints, *res, *res0;
 420 int error;
 421 int s;
 422 const char *cause = NULL;
 423
 424 memset(&hints, 0, sizeof(hints));
 425 hints.ai_family = PF_UNSPEC;
 426 hints.ai_socktype = SOCK_STREAM;
 427 error = getaddrinfo("www.kame.net", "http", &hints, &res0);
 428 if (error) {
 429         errx(1, "%s", gai_strerror(error));
 430         /*NOTREACHED*/
 431 }
 432 s = -1;
 433 for (res = res0; res; res = res->ai_next) {
 434         s = socket(res->ai_family, res->ai_socktype,
 435             res->ai_protocol);
 436         if (s < 0) {
 437                 cause = "socket";
 438                 continue;
 439         }
 440
 441         if (connect(s, res->ai_addr, res->ai_addrlen) < 0) {
 442                 cause = "connect";
 443                 close(s);
 444                 s = -1;
 445                 continue;
 446         }
 447
 448         break;  /* okay we got one */
 449 }
 450 if (s < 0) {
 451         err(1, "%s", cause);
 452         /*NOTREACHED*/
 453 }
 454 freeaddrinfo(res0);
 455 .Ed
 456 .Pp
 457 The following example tries to open a wildcard listening socket onto service
 458 .Dq Li http ,
 459 for all the address families available.
 460 .Bd -literal -offset indent
 461 struct addrinfo hints, *res, *res0;
 462 int error;
 463 int s[MAXSOCK];
 464 int nsock;
 465 const char *cause = NULL;
 466
 467 memset(&hints, 0, sizeof(hints));
 468 hints.ai_family = PF_UNSPEC;
 469 hints.ai_socktype = SOCK_STREAM;
 470 hints.ai_flags = AI_PASSIVE;
 471 error = getaddrinfo(NULL, "http", &hints, &res0);
 472 if (error) {
 473         errx(1, "%s", gai_strerror(error));
 474         /*NOTREACHED*/
 475 }
 476 nsock = 0;
 477 for (res = res0; res && nsock < MAXSOCK; res = res->ai_next) {
 478         s[nsock] = socket(res->ai_family, res->ai_socktype,
 479             res->ai_protocol);
 480         if (s[nsock] < 0) {
 481                 cause = "socket";
 482                 continue;
 483         }
 484
 485         if (bind(s[nsock], res->ai_addr, res->ai_addrlen) < 0) {
 486                 cause = "bind";
 487                 close(s[nsock]);
 488                 continue;
 489         }
 490         (void) listen(s[nsock], 5);
 491
 492         nsock++;
 493 }
 494 if (nsock == 0) {
 495         err(1, "%s", cause);
 496         /*NOTREACHED*/
 497 }
 498 freeaddrinfo(res0);
 499 .Ed
 500 .Sh SEE ALSO
 501 .Xr bind 2 ,
 502 .Xr connect 2 ,
 503 .Xr send 2 ,
 504 .Xr socket 2 ,
 505 .Xr gai_strerror 3 ,
 506 .Xr gethostbyname 3 ,
 507 .Xr getnameinfo 3 ,
 508 .Xr getservbyname 3 ,
 509 .Xr resolver 3 ,
 510 .Xr hosts 5 ,
 511 .Xr resolv.conf 5 ,
 512 .Xr services 5 ,
 513 .Xr hostname 7 ,
 514 .Xr named 8
 515 .Rs
 516 .%A R. Gilligan
 517 .%A S. Thomson
 518 .%A J. Bound
 519 .%A J. McCann
 520 .%A W. Stevens
 521 .%T Basic Socket Interface Extensions for IPv6
 522 .%R RFC 3493
 523 .%D February 2003
 524 .Re
 525 .Rs
 526 .%A S. Deering
 527 .%A B. Haberman
 528 .%A T. Jinmei
 529 .%A E. Nordmark
 530 .%A B. Zill
 531 .%T "IPv6 Scoped Address Architecture"
 532 .%R RFC 4007
 533 .%D March 2005
 534 .Re
 535 .Rs
 536 .%A Craig Metz
 537 .%T Protocol Independence Using the Sockets API
 538 .%B "Proceedings of the freenix track: 2000 USENIX annual technical conference"
 539 .%D June 2000
 540 .Re
 541 .\".Sh BUGS
 542 .\"The
 543 .\".Nm
 544 .\"function as implemented in
 545 .\".Fx
 546 .\"currently does not support
 547 .\".Dv AI_ALL
 548 .\"and
 549 .\".Dv AI_V4MAPPED
 550 .\"flags and returns
 551 .\".Dv EAI_BADFLAGS
 552 .\"if one of them is specified.
 553 .Sh STANDARDS
 554 The
 555 .Fn getaddrinfo
 556 function is defined by the
 557 .St -p1003.1-2004
 558 specification and documented in
 559 .Dv "RFC 3493" ,
 560 .Dq Basic Socket Interface Extensions for IPv6 .