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