include/resolv.h

   1 /*
   2  * Copyright (c) 1983, 1987, 1989
   3  *    The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 4. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 /*
  31  * Portions Copyright (c) 1996-1999 by Internet Software Consortium.
  32  *
  33  * Permission to use, copy, modify, and distribute this software for any
  34  * purpose with or without fee is hereby granted, provided that the above
  35  * copyright notice and this permission notice appear in all copies.
  36  *
  37  * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
  38  * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
  39  * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
  40  * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  41  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  42  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
  43  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  44  * SOFTWARE.
  45  */
  46
  47 /*
  48  *      @(#)resolv.h    8.1 (Berkeley) 6/2/93
  49  *      $BINDId: resolv.h,v 8.31 2000/03/30 20:16:50 vixie Exp $
  50  */
  51
  52 #ifndef _RESOLV_H_
  53
  54 /* These headers are needed for types used in the `struct res_state'
  55    declaration.  */
  56 #include <sys/types.h>
  57 #include <netinet/in.h>
  58
  59 #ifndef __need_res_state
  60 # define _RESOLV_H_
  61
  62 # include <sys/param.h>
  63 # include <sys/cdefs.h>
  64 # include <stdio.h>
  65 # include <arpa/nameser.h>
  66 #endif
  67
  68 #ifndef __res_state_defined
  69 # define __res_state_defined
  70
  71 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
  72         res_sendhookact;
  73
  74 typedef res_sendhookact (*res_send_qhook) (struct sockaddr_in * const *ns,
  75                                            const u_char **query,
  76                                            int *querylen,
  77                                            u_char *ans,
  78                                            int anssiz,
  79                                            int *resplen);
  80
  81 typedef res_sendhookact (*res_send_rhook) (const struct sockaddr_in *ns,
  82                                            const u_char *query,
  83                                            int querylen,
  84                                            u_char *ans,
  85                                            int anssiz,
  86                                            int *resplen);
  87
  88 /*
  89  * Global defines and variables for resolver stub.
  90  */
  91 # define MAXNS                  3       /* max # name servers we'll track */
  92 # define MAXDFLSRCH             3       /* # default domain levels to try */
  93 # define MAXDNSRCH              6       /* max # domains in search path */
  94 # define LOCALDOMAINPARTS       2       /* min levels in name that is "local" */
  95
  96 # define RES_TIMEOUT            5       /* min. seconds between retries */
  97 # define MAXRESOLVSORT          10      /* number of net to sort on */
  98 # define RES_MAXNDOTS           15      /* should reflect bit field size */
  99 # define RES_MAXRETRANS         30      /* only for resolv.conf/RES_OPTIONS */
 100 # define RES_MAXRETRY           5       /* only for resolv.conf/RES_OPTIONS */
 101 # define RES_DFLRETRY           3       /* Default #/tries. */
 102 /* (glibc uses RES_DFLRETRY of 2 but also does _res.retry = 4 sometimes (!) */
 103 # define RES_MAXTIME            65535   /* Infinity, in milliseconds. */
 104
 105 /* _res (an instance of this structure) uses 0.5kb in bss
 106  * in "ordinary" libc's (glibc, xBSD). We want to be less wasteful.
 107  * We (1) shuffle and shrink some integer fields,
 108  * and (2) can switch off stuff we don't support.
 109  * Everything inside __UCLIBC_HAS_COMPAT_RES_STATE__
 110  * is not actually used by uclibc and can be configured off.
 111  * However, this will prevent some programs from building.
 112  * Really obscure stuff with no observed users in the wild is under
 113  * __UCLIBC_HAS_EXTRA_COMPAT_RES_STATE__.
 114  * I guess it's safe to set that to N.
 115  */
 116 struct __res_state {
 117 #ifdef __UCLIBC_HAS_COMPAT_RES_STATE__
 118         int     retrans;                /* retransmission time interval */
 119         int     retry;                  /* number of times to retransmit */
 120 #endif
 121         u_int32_t options;              /* (was: ulong) option flags - see below. */
 122         struct sockaddr_in nsaddr_list[MAXNS]; /* address of name server */
 123 #define nsaddr nsaddr_list[0]           /* for backward compatibility */
 124         char    *dnsrch[MAXDNSRCH + 1]; /* components of domain to search */
 125 #ifdef __UCLIBC_HAS_COMPAT_RES_STATE__
 126         /* googling for "_res.defdname" says it's still sometimes used.
 127          * Pity. It's huge, I want to move it to EXTRA_COMPAT... */
 128         char    defdname[256];          /* default domain (deprecated) */
 129 #endif
 130         u_int8_t nscount;               /* (was: int) number of name servers */
 131         u_int8_t ndots;                 /* (was: unsigned:4) threshold for initial abs. query */
 132 #ifdef __UCLIBC_HAS_COMPAT_RES_STATE__
 133         u_int8_t nsort;                 /* (was: unsigned:4) number of elements in sort_list[] */
 134         u_int16_t pfcode;               /* (was: ulong) RES_PRF_ flags. Used by dig. */
 135         unsigned short id;              /* current message id */
 136         int     res_h_errno;            /* last one set for this context */
 137         struct {
 138                 struct in_addr  addr;
 139                 u_int32_t       mask;
 140         } sort_list[MAXRESOLVSORT];
 141 #endif
 142
 143 #ifdef __UCLIBC_HAS_IPV6__
 144         /* I assume that the intention is to store all
 145          * DNS servers' addresses here, and duplicate in nsaddr_list[]
 146          * those which have IPv4 address. In the case of IPv4 address
 147          * _u._ext.nsaddrs[x] will point to some nsaddr_list[y],
 148          * otherwise it will point into malloc'ed sockaddr_in6.
 149          * nscount is the number of IPv4 addresses and _u._ext.nscount
 150          * is the number of addresses of all kinds.
 151          *
 152          * If this differs from established usage and you need
 153          * to change this, please describe how it is supposed to work.
 154          */
 155         union {
 156                 struct {
 157                         struct sockaddr_in6     *nsaddrs[MAXNS];
 158                         u_int8_t                nscount; /* (was: u_int16_t) */
 159 #ifdef __UCLIBC_HAS_COMPAT_RES_STATE__
 160                         /* rather obscure, and differs in BSD and glibc */
 161                         u_int16_t               nstimes[MAXNS];
 162                         int                     nssocks[MAXNS];
 163                         u_int16_t               nscount6;
 164                         u_int16_t               nsinit;
 165                         /* glibc also has: */
 166                         /*u_int16_t             nsmap[MAXNS];*/
 167                         /*unsigned long long    initstamp;*/
 168 #endif
 169                 } _ext;
 170         } _u;
 171 #endif
 172
 173 #ifdef __UCLIBC_HAS_EXTRA_COMPAT_RES_STATE__
 174         /* Truly obscure stuff.
 175          * Googling for "_res.XXX" for these members
 176          * turned up basically empty */
 177         res_send_qhook qhook;           /* query hook */
 178         res_send_rhook rhook;           /* response hook */
 179         int     _vcsock;                /* PRIVATE: for res_send VC i/o */
 180         unsigned _flags;                /* PRIVATE: see below */
 181 #endif
 182 };
 183
 184 typedef struct __res_state *res_state;
 185 # undef __need_res_state
 186 #endif
 187
 188 #ifdef _RESOLV_H_
 189 /*
 190  * Revision information.  This is the release date in YYYYMMDD format.
 191  * It can change every day so the right thing to do with it is use it
 192  * in preprocessor commands such as "#if (__RES > 19931104)".  Do not
 193  * compare for equality; rather, use it to determine whether your resolver
 194  * is new enough to contain a certain feature.
 195  */
 196
 197 #if 0
 198 #define __RES   19991006
 199 #else
 200 #define __RES   19960801
 201 #endif
 202
 203 /*
 204  * Resolver configuration file.
 205  * Normally not present, but may contain the address of the
 206  * inital name server(s) to query and the domain search list.
 207  */
 208
 209 #ifndef _PATH_RESCONF
 210 #define _PATH_RESCONF        "/etc/resolv.conf"
 211 #endif
 212
 213 struct res_sym {
 214         int     number;         /* Identifying number, like T_MX */
 215         char *  name;           /* Its symbolic name, like "MX" */
 216         char *  humanname;      /* Its fun name, like "mail exchanger" */
 217 };
 218
 219 /*
 220  * Resolver flags (used to be discrete per-module statics ints).
 221  */
 222 #define RES_F_VC        0x00000001      /* socket is TCP */
 223 #define RES_F_CONN      0x00000002      /* socket is connected */
 224
 225 /* res_findzonecut() options */
 226 #define RES_EXHAUSTIVE  0x00000001      /* always do all queries */
 227
 228 /*
 229  * Resolver options (keep these in synch with res_debug.c, please)
 230  * (which of these do we really implement??)
 231  */
 232 #define RES_INIT        0x00000001      /* address initialized */
 233 #define RES_DEBUG       0x00000002      /* print debug messages */
 234 #define RES_AAONLY      0x00000004      /* authoritative answers only (!IMPL)*/
 235 #define RES_USEVC       0x00000008      /* use virtual circuit */
 236 #define RES_PRIMARY     0x00000010      /* query primary server only (!IMPL) */
 237 #define RES_IGNTC       0x00000020      /* ignore trucation errors */
 238 #define RES_RECURSE     0x00000040      /* recursion desired */
 239 #define RES_DEFNAMES    0x00000080      /* use default domain name */
 240 #define RES_STAYOPEN    0x00000100      /* Keep TCP socket open */
 241 #define RES_DNSRCH      0x00000200      /* search up local domain tree */
 242 #define RES_INSECURE1   0x00000400      /* type 1 security disabled */
 243 #define RES_INSECURE2   0x00000800      /* type 2 security disabled */
 244 #define RES_NOALIASES   0x00001000      /* shuts off HOSTALIASES feature */
 245 #define RES_USE_INET6   0x00002000      /* use/map IPv6 in gethostbyname() */
 246 #define RES_ROTATE      0x00004000      /* rotate ns list after each query */
 247 #define RES_NOCHECKNAME 0x00008000      /* do not check names for sanity. */
 248 #define RES_KEEPTSIG    0x00010000      /* do not strip TSIG records */
 249 #define RES_BLAST       0x00020000      /* blast all recursive servers */
 250 #if 0
 251 #define RES_USEBSTRING  0x00040000      /* IPv6 reverse lookup with byte
 252                                            strings */
 253 #define RES_NOIP6DOTINT 0x00080000      /* Do not use .ip6.int in IPv6
 254                                            reverse lookup */
 255
 256 #define RES_DEFAULT     (RES_RECURSE|RES_DEFNAMES|RES_DNSRCH|RES_NOIP6DOTINT)
 257 #else
 258 #define RES_DEFAULT     (RES_RECURSE|RES_DEFNAMES|RES_DNSRCH)
 259 #endif
 260
 261 /*
 262  * Resolver "pfcode" values.  Used by dig.
 263  */
 264 #define RES_PRF_STATS   0x00000001
 265 #define RES_PRF_UPDATE  0x00000002
 266 #define RES_PRF_CLASS   0x00000004
 267 #define RES_PRF_CMD     0x00000008
 268 #define RES_PRF_QUES    0x00000010
 269 #define RES_PRF_ANS     0x00000020
 270 #define RES_PRF_AUTH    0x00000040
 271 #define RES_PRF_ADD     0x00000080
 272 #define RES_PRF_HEAD1   0x00000100
 273 #define RES_PRF_HEAD2   0x00000200
 274 #define RES_PRF_TTLID   0x00000400
 275 #define RES_PRF_HEADX   0x00000800
 276 #define RES_PRF_QUERY   0x00001000
 277 #define RES_PRF_REPLY   0x00002000
 278 #define RES_PRF_INIT    0x00004000
 279 /*                      0x00008000      */
 280
 281 /* Things involving an internal (static) resolver context. */
 282 #if 0
 283 __BEGIN_DECLS
 284 extern struct __res_state *__res_state(void) __attribute__ ((__const__));
 285 __END_DECLS
 286 #define _res (*__res_state())
 287 #else
 288 extern struct __res_state _res;
 289 #endif
 290
 291 #define fp_nquery               __fp_nquery
 292 #define fp_query                __fp_query
 293 #define hostalias               __hostalias
 294 #define p_query                 __p_query
 295 #define res_close               __res_close
 296 #define res_init                __res_init
 297 #define res_isourserver         __res_isourserver
 298 #define res_mkquery             __res_mkquery
 299 #define res_query               __res_query
 300 #define res_querydomain         __res_querydomain
 301 #define res_search              __res_search
 302 #define res_send                __res_send
 303
 304 __BEGIN_DECLS
 305 void            fp_nquery (const u_char *, int, FILE *) __THROW;
 306 void            fp_query (const u_char *, FILE *) __THROW;
 307 const char *    hostalias (const char *) __THROW;
 308 void            p_query (const u_char *) __THROW;
 309 #ifdef __UCLIBC_HAS_BSD_RES_CLOSE__
 310 void            res_close (void) __THROW;
 311 #endif
 312 int             res_init (void) __THROW;
 313 libc_hidden_proto(res_init)
 314 int             res_isourserver (const struct sockaddr_in *) __THROW;
 315 int             res_mkquery (int, const char *, int, int, const u_char *,
 316                              int, const u_char *, u_char *, int) __THROW;
 317 int             res_query (const char *, int, int, u_char *, int) __THROW;
 318 libc_hidden_proto(res_query)
 319 int             res_querydomain (const char *, const char *, int, int,
 320                                  u_char *, int) __THROW;
 321 libc_hidden_proto(res_querydomain)
 322 int             res_search (const char *, int, int, u_char *, int) __THROW;
 323 int             res_send (const u_char *, int, u_char *, int) __THROW;
 324 __END_DECLS
 325
 326 #define b64_ntop                __b64_ntop
 327 #define b64_pton                __b64_pton
 328 #define dn_comp                 __dn_comp
 329 #define dn_count_labels         __dn_count_labels
 330 #define dn_expand               __dn_expand
 331 #define dn_skipname             __dn_skipname
 332 #define fp_resstat              __fp_resstat
 333 #define loc_aton                __loc_aton
 334 #define loc_ntoa                __loc_ntoa
 335 #define p_cdname                __p_cdname
 336 #define p_cdnname               __p_cdnname
 337 #define p_class                 __p_class
 338 #define p_fqname                __p_fqname
 339 #define p_fqnname               __p_fqnname
 340 #define p_option                __p_option
 341 #define p_secstodate            __p_secstodate
 342 #define p_section               __p_section
 343 #define p_time                  __p_time
 344 #define p_type                  __p_type
 345 #define p_rcode                 __p_rcode
 346 #define putlong                 __putlong
 347 #define putshort                __putshort
 348 #define res_dnok                __res_dnok
 349 #define res_hnok                __res_hnok
 350 #define res_hostalias           __res_hostalias
 351 #define res_mailok              __res_mailok
 352 #define res_nameinquery         __res_nameinquery
 353 #define res_nclose              __res_nclose
 354 #define res_ninit               __res_ninit
 355 #define res_nmkquery            __res_nmkquery
 356 #define res_npquery             __res_npquery
 357 #define res_nquery              __res_nquery
 358 #define res_nquerydomain        __res_nquerydomain
 359 #define res_nsearch             __res_nsearch
 360 #define res_nsend               __res_nsend
 361 #define res_nisourserver        __res_nisourserver
 362 #define res_ownok               __res_ownok
 363 #define res_queriesmatch        __res_queriesmatch
 364 #define res_randomid            __res_randomid
 365 #define sym_ntop                __sym_ntop
 366 #define sym_ntos                __sym_ntos
 367 #define sym_ston                __sym_ston
 368 __BEGIN_DECLS
 369 int             res_hnok (const char *) __THROW;
 370 int             res_ownok (const char *) __THROW;
 371 int             res_mailok (const char *) __THROW;
 372 int             res_dnok (const char *) __THROW;
 373 int             sym_ston (const struct res_sym *, const char *, int *) __THROW;
 374 const char *    sym_ntos (const struct res_sym *, int, int *) __THROW;
 375 const char *    sym_ntop (const struct res_sym *, int, int *) __THROW;
 376 int             b64_ntop (u_char const *, size_t, char *, size_t) __THROW;
 377 int             b64_pton (char const *, u_char *, size_t) __THROW;
 378 int             loc_aton (const char *ascii, u_char *binary) __THROW;
 379 const char *    loc_ntoa (const u_char *binary, char *ascii) __THROW;
 380 int             dn_skipname (const u_char *, const u_char *) __THROW;
 381 void            putlong (u_int32_t, u_char *) __THROW;
 382 void            putshort (u_int16_t, u_char *) __THROW;
 383 const char *    p_class (int) __THROW;
 384 const char *    p_time (u_int32_t) __THROW;
 385 const char *    p_type (int) __THROW;
 386 const char *    p_rcode (int) __THROW;
 387 const u_char *  p_cdnname (const u_char *, const u_char *, int, FILE *)
 388      __THROW;
 389 const u_char *  p_cdname (const u_char *, const u_char *, FILE *) __THROW;
 390 const u_char *  p_fqnname (const u_char *cp, const u_char *msg,
 391                            int, char *, int) __THROW;
 392 const u_char *  p_fqname (const u_char *, const u_char *, FILE *) __THROW;
 393 const char *    p_option (u_long option) __THROW;
 394 char *          p_secstodate (u_long) __THROW;
 395 int             dn_count_labels (const char *) __THROW;
 396 int             dn_comp (const char *, u_char *, int, u_char **, u_char **)
 397      __THROW;
 398 int             dn_expand (const u_char *, const u_char *, const u_char *,
 399                            char *, int) __THROW;
 400 u_int           res_randomid (void) __THROW;
 401 int             res_nameinquery (const char *, int, int,
 402                                  const u_char *, const u_char *) __THROW;
 403 int             res_queriesmatch (const u_char *, const u_char *,
 404                                   const u_char *, const u_char *) __THROW;
 405 const char *    p_section (int section, int opcode) __THROW;
 406 /* Things involving a resolver context. */
 407 int             res_ninit (res_state) __THROW;
 408 int             res_nisourserver (const res_state,
 409                                   const struct sockaddr_in *) __THROW;
 410 void            fp_resstat (const res_state, FILE *) __THROW;
 411 void            res_npquery (const res_state, const u_char *, int, FILE *)
 412      __THROW;
 413 const char *    res_hostalias (const res_state, const char *, char *, size_t)
 414      __THROW;
 415 int             res_nquery (res_state, const char *, int, int, u_char *, int)
 416      __THROW;
 417 int             res_nsearch (res_state, const char *, int, int, u_char *, int)
 418      __THROW;
 419 int             res_nquerydomain (res_state, const char *, const char *, int,
 420                                   int, u_char *, int) __THROW;
 421 int             res_nmkquery (res_state, int, const char *, int, int,
 422                               const u_char *, int, const u_char *, u_char *,
 423                               int) __THROW;
 424 int             res_nsend (res_state, const u_char *, int, u_char *, int)
 425      __THROW;
 426 void            res_nclose (res_state) __THROW;
 427 __END_DECLS
 428 #endif
 429
 430 #endif /* !_RESOLV_H_ */