lib/libc/net/resolver.3

   1 .\" Copyright (c) 1985, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)resolver.3  8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: src/lib/libc/net/resolver.3,v 1.33 2007/01/09 00:28:02 imp Exp $
  30 .\" $DragonFly: src/lib/libc/net/resolver.3,v 1.4 2007/11/23 23:16:36 swildner Exp $
  31 .\"
  32 .Dd November 4, 2006
  33 .Dt RESOLVER 3
  34 .Os
  35 .Sh NAME
  36 .Nm res_query ,
  37 .Nm res_search ,
  38 .Nm res_mkquery ,
  39 .Nm res_send ,
  40 .Nm res_init ,
  41 .Nm dn_comp ,
  42 .Nm dn_expand ,
  43 .Nm dn_skipname ,
  44 .Nm ns_get16 ,
  45 .Nm ns_get32 ,
  46 .Nm ns_put16 ,
  47 .Nm ns_put32
  48 .Nd resolver routines
  49 .Sh LIBRARY
  50 .Lb libc
  51 .Sh SYNOPSIS
  52 .In sys/types.h
  53 .In netinet/in.h
  54 .In arpa/nameser.h
  55 .In resolv.h
  56 .Ft int
  57 .Fo res_query
  58 .Fa "const char *dname"
  59 .Fa "int class"
  60 .Fa "int type"
  61 .Fa "u_char *answer"
  62 .Fa "int anslen"
  63 .Fc
  64 .Ft int
  65 .Fo res_search
  66 .Fa "const char *dname"
  67 .Fa "int class"
  68 .Fa "int type"
  69 .Fa "u_char *answer"
  70 .Fa "int anslen"
  71 .Fc
  72 .Ft int
  73 .Fo res_mkquery
  74 .Fa "int op"
  75 .Fa "const char *dname"
  76 .Fa "int class"
  77 .Fa "int type"
  78 .Fa "const u_char *data"
  79 .Fa "int datalen"
  80 .Fa "const u_char *newrr_in"
  81 .Fa "u_char *buf"
  82 .Fa "int buflen"
  83 .Fc
  84 .Ft int
  85 .Fo res_send
  86 .Fa "const u_char *msg"
  87 .Fa "int msglen"
  88 .Fa "u_char *answer"
  89 .Fa "int anslen"
  90 .Fc
  91 .Ft int
  92 .Fn res_init void
  93 .Ft int
  94 .Fo dn_comp
  95 .Fa "const char *exp_dn"
  96 .Fa "u_char *comp_dn"
  97 .Fa "int length"
  98 .Fa "u_char **dnptrs"
  99 .Fa "u_char **lastdnptr"
 100 .Fc
 101 .Ft int
 102 .Fo dn_expand
 103 .Fa "const u_char *msg"
 104 .Fa "const u_char *eomorig"
 105 .Fa "const u_char *comp_dn"
 106 .Fa "char *exp_dn"
 107 .Fa "int length"
 108 .Fc
 109 .Ft int
 110 .Fn dn_skipname "const u_char *comp_dn" "const u_char *eom"
 111 .Ft u_int
 112 .Fn ns_get16 "const u_char *src"
 113 .Ft u_long
 114 .Fn ns_get32 "const u_char *src"
 115 .Ft void
 116 .Fn ns_put16 "u_int src" "u_char *dst"
 117 .Ft void
 118 .Fn ns_put32 "u_long src" "u_char *dst"
 119 .Sh DESCRIPTION
 120 These routines are used for making, sending and interpreting
 121 query and reply messages with Internet domain name servers.
 122 .Pp
 123 Global configuration and state information that is used by the
 124 resolver routines is kept in the structure
 125 .Va _res .
 126 Most of the values have reasonable defaults and can be ignored.
 127 Options
 128 stored in
 129 .Va _res.options
 130 are defined in
 131 .In resolv.h
 132 and are as follows.
 133 Options are stored as a simple bit mask containing the bitwise ``or''
 134 of the options enabled.
 135 .Bl -tag -width RES_USE_INET6
 136 .It Dv RES_INIT
 137 True if the initial name server address and default domain name are
 138 initialized (i.e.,
 139 .Fn res_init
 140 has been called).
 141 .It Dv RES_DEBUG
 142 Print debugging messages.
 143 .It Dv RES_AAONLY
 144 Accept authoritative answers only.
 145 With this option,
 146 .Fn res_send
 147 should continue until it finds an authoritative answer or finds an error.
 148 Currently this is not implemented.
 149 .It Dv RES_USEVC
 150 Use
 151 .Tn TCP
 152 connections for queries instead of
 153 .Tn UDP
 154 datagrams.
 155 .It Dv RES_STAYOPEN
 156 Used with
 157 .Dv RES_USEVC
 158 to keep the
 159 .Tn TCP
 160 connection open between
 161 queries.
 162 This is useful only in programs that regularly do many queries.
 163 .Tn UDP
 164 should be the normal mode used.
 165 .It Dv RES_IGNTC
 166 Unused currently (ignore truncation errors, i.e., do not retry with
 167 .Tn TCP ) .
 168 .It Dv RES_RECURSE
 169 Set the recursion-desired bit in queries.
 170 This is the default.
 171 .Pf ( Fn res_send
 172 does not do iterative queries and expects the name server
 173 to handle recursion.)
 174 .It Dv RES_DEFNAMES
 175 If set,
 176 .Fn res_search
 177 will append the default domain name to single-component names
 178 (those that do not contain a dot).
 179 This option is enabled by default.
 180 .It Dv RES_DNSRCH
 181 If this option is set,
 182 .Fn res_search
 183 will search for host names in the current domain and in parent domains; see
 184 .Xr hostname 7 .
 185 This is used by the standard host lookup routine
 186 .Xr gethostbyname 3 .
 187 This option is enabled by default.
 188 .It Dv RES_NOALIASES
 189 This option turns off the user level aliasing feature controlled by the
 190 .Dq Ev HOSTALIASES
 191 environment variable.
 192 Network daemons should set this option.
 193 .It Dv RES_USE_INET6
 194 Enables support for IPv6-only applications.
 195 This causes IPv4 addresses to be returned as an IPv4 mapped address.
 196 For example,
 197 .Li 10.1.1.1
 198 will be returned as
 199 .Li ::ffff:10.1.1.1 .
 200 The option is meaningful with certain kernel configuration only.
 201 .It Dv RES_USE_EDNS0
 202 Enables support for OPT pseudo-RR for EDNS0 extension.
 203 With the option, resolver code will attach OPT pseudo-RR into DNS queries,
 204 to inform of our receive buffer size.
 205 The option will allow DNS servers to take advantage of non-default receive
 206 buffer size, and to send larger replies.
 207 DNS query packets with EDNS0 extension is not compatible with
 208 non-EDNS0 DNS servers.
 209 .El
 210 .Pp
 211 The
 212 .Fn res_init
 213 routine
 214 reads the configuration file (if any; see
 215 .Xr resolver 5 )
 216 to get the default domain name,
 217 search list and
 218 the Internet address of the local name server(s).
 219 If no server is configured, the host running
 220 the resolver is tried.
 221 The current domain name is defined by the hostname
 222 if not specified in the configuration file;
 223 it can be overridden by the environment variable
 224 .Ev LOCALDOMAIN .
 225 This environment variable may contain several blank-separated
 226 tokens if you wish to override the
 227 .Em "search list"
 228 on a per-process basis.
 229 This is similar to the
 230 .Ic search
 231 command in the configuration file.
 232 Another environment variable
 233 .Dq Ev RES_OPTIONS
 234 can be set to
 235 override certain internal resolver options which are otherwise
 236 set by changing fields in the
 237 .Va _res
 238 structure or are inherited from the configuration file's
 239 .Ic options
 240 command.
 241 The syntax of the
 242 .Dq Ev RES_OPTIONS
 243 environment variable is explained in
 244 .Xr resolver 5 .
 245 Initialization normally occurs on the first call
 246 to one of the following routines.
 247 .Pp
 248 The
 249 .Fn res_query
 250 function provides an interface to the server query mechanism.
 251 It constructs a query, sends it to the local server,
 252 awaits a response, and makes preliminary checks on the reply.
 253 The query requests information of the specified
 254 .Fa type
 255 and
 256 .Fa class
 257 for the specified fully-qualified domain name
 258 .Fa dname .
 259 The reply message is left in the
 260 .Fa answer
 261 buffer with length
 262 .Fa anslen
 263 supplied by the caller.
 264 .Pp
 265 The
 266 .Fn res_search
 267 routine makes a query and awaits a response like
 268 .Fn res_query ,
 269 but in addition, it implements the default and search rules
 270 controlled by the
 271 .Dv RES_DEFNAMES
 272 and
 273 .Dv RES_DNSRCH
 274 options.
 275 It returns the first successful reply.
 276 .Pp
 277 The remaining routines are lower-level routines used by
 278 .Fn res_query .
 279 The
 280 .Fn res_mkquery
 281 function
 282 constructs a standard query message and places it in
 283 .Fa buf .
 284 It returns the size of the query, or \-1 if the query is
 285 larger than
 286 .Fa buflen .
 287 The query type
 288 .Fa op
 289 is usually
 290 .Dv QUERY ,
 291 but can be any of the query types defined in
 292 .In arpa/nameser.h .
 293 The domain name for the query is given by
 294 .Fa dname .
 295 The
 296 .Fa newrr_in
 297 argument
 298 is currently unused but is intended for making update messages.
 299 .Pp
 300 The
 301 .Fn res_send
 302 routine
 303 sends a pre-formatted query and returns an answer.
 304 It will call
 305 .Fn res_init
 306 if
 307 .Dv RES_INIT
 308 is not set, send the query to the local name server, and
 309 handle timeouts and retries.
 310 The length of the reply message is returned, or
 311 \-1 if there were errors.
 312 .Pp
 313 The
 314 .Fn dn_comp
 315 function
 316 compresses the domain name
 317 .Fa exp_dn
 318 and stores it in
 319 .Fa comp_dn .
 320 The size of the compressed name is returned or \-1 if there were errors.
 321 The size of the array pointed to by
 322 .Fa comp_dn
 323 is given by
 324 .Fa length .
 325 The compression uses
 326 an array of pointers
 327 .Fa dnptrs
 328 to previously-compressed names in the current message.
 329 The first pointer points to
 330 the beginning of the message and the list ends with
 331 .Dv NULL .
 332 The limit to the array is specified by
 333 .Fa lastdnptr .
 334 A side effect of
 335 .Fn dn_comp
 336 is to update the list of pointers for
 337 labels inserted into the message
 338 as the name is compressed.
 339 If
 340 .Fa dnptr
 341 is
 342 .Dv NULL ,
 343 names are not compressed.
 344 If
 345 .Fa lastdnptr
 346 is
 347 .Dv NULL ,
 348 the list of labels is not updated.
 349 .Pp
 350 The
 351 .Fn dn_expand
 352 entry
 353 expands the compressed domain name
 354 .Fa comp_dn
 355 to a full domain name
 356 The compressed name is contained in a query or reply message;
 357 .Fa msg
 358 is a pointer to the beginning of the message.
 359 The uncompressed name is placed in the buffer indicated by
 360 .Fa exp_dn
 361 which is of size
 362 .Fa length .
 363 The size of compressed name is returned or \-1 if there was an error.
 364 .Pp
 365 The
 366 .Fn dn_skipname
 367 function skips over a compressed domain name, which starts at a location
 368 pointed to by
 369 .Fa comp_dn .
 370 The compressed name is contained in a query or reply message;
 371 .Fa eom
 372 is a pointer to the end of the message.
 373 The size of compressed name is returned or \-1 if there was
 374 an error.
 375 .Pp
 376 The
 377 .Fn ns_get16
 378 function gets a 16-bit quantity from a buffer pointed to by
 379 .Fa src .
 380 .Pp
 381 The
 382 .Fn ns_get32
 383 function gets a 32-bit quantity from a buffer pointed to by
 384 .Fa src .
 385 .Pp
 386 The
 387 .Fn ns_put16
 388 function puts a 16-bit quantity
 389 .Fa src
 390 to a buffer pointed to by
 391 .Fa dst .
 392 .Pp
 393 The
 394 .Fn ns_put32
 395 function puts a 32-bit quantity
 396 .Fa src
 397 to a buffer pointed to by
 398 .Fa dst .
 399 .Sh IMPLEMENTATION NOTES
 400 This implementation of the resolver is thread-safe, but it will not
 401 function properly if the programmer attempts to declare his or her own
 402 .Va _res
 403 structure in an attempt to replace the per-thread version referred to
 404 by that macro.
 405 .Sh RETURN VALUES
 406 The
 407 .Fn res_init
 408 function will return 0 on success, or \-1 in a threaded program if
 409 per-thread storage could not be allocated.
 410 .Pp
 411 The
 412 .Fn res_mkquery ,
 413 .Fn res_search ,
 414 and
 415 .Fn res_query
 416 functions return the size of the response on success, or \-1 if an
 417 error occurs.
 418 The integer
 419 .Vt h_errno
 420 may be checked to determine the reason for error.
 421 See
 422 .Xr gethostbyname 3
 423 for more information.
 424 .Sh FILES
 425 .Bl -tag -width /etc/resolv.conf
 426 .It Pa /etc/resolv.conf
 427 The configuration file,
 428 see
 429 .Xr resolver 5 .
 430 .El
 431 .Sh SEE ALSO
 432 .Xr gethostbyname 3 ,
 433 .Xr resolver 5 ,
 434 .Xr hostname 7 ,
 435 .Xr named 8
 436 .Pp
 437 .%T RFC 1032 ,
 438 .%T RFC 1033 ,
 439 .%T RFC 1034 ,
 440 .%T RFC 1035 ,
 441 .%T RFC 974
 442 .Rs
 443 .%T "Name Server Operations Guide for BIND"
 444 .Re
 445 .Sh HISTORY
 446 The
 447 .Nm
 448 function appeared in
 449 .Bx 4.3 .