resolv/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 /*
  72  * Global defines and variables for resolver stub.
  73  */
  74 # define MAXNS                  3       /* max # name servers we'll track */
  75 # define MAXDFLSRCH             3       /* # default domain levels to try */
  76 # define MAXDNSRCH              6       /* max # domains in search path */
  77 # define LOCALDOMAINPARTS       2       /* min levels in name that is "local" */
  78
  79 # define RES_TIMEOUT            5       /* min. seconds between retries */
  80 # define MAXRESOLVSORT          10      /* number of net to sort on */
  81 # define RES_MAXNDOTS           15      /* should reflect bit field size */
  82 # define RES_MAXRETRANS         30      /* only for resolv.conf/RES_OPTIONS */
  83 # define RES_MAXRETRY           5       /* only for resolv.conf/RES_OPTIONS */
  84 # define RES_DFLRETRY           2       /* Default #/tries. */
  85 # define RES_MAXTIME            65535   /* Infinity, in milliseconds. */
  86
  87 struct __res_state {
  88         int     retrans;                /* retransmition time interval */
  89         int     retry;                  /* number of times to retransmit */
  90         unsigned long options;          /* option flags - see below. */
  91         int     nscount;                /* number of name servers */
  92         struct sockaddr_in
  93                 nsaddr_list[MAXNS];     /* address of name server */
  94 # define nsaddr nsaddr_list[0]          /* for backward compatibility */
  95         unsigned short id;              /* current message id */
  96         /* 2 byte hole here.  */
  97         char    *dnsrch[MAXDNSRCH+1];   /* components of domain to search */
  98         char    defdname[256];          /* default domain (deprecated) */
  99         unsigned long pfcode;           /* RES_PRF_ flags - see below. */
 100         unsigned ndots:4;               /* threshold for initial abs. query */
 101         unsigned nsort:4;               /* number of elements in sort_list[] */
 102         unsigned ipv6_unavail:1;        /* connecting to IPv6 server failed */
 103         unsigned unused:23;
 104         struct {
 105                 struct in_addr  addr;
 106                 uint32_t        mask;
 107         } sort_list[MAXRESOLVSORT];
 108         /* 4 byte hole here on 64-bit architectures.  */
 109         void * __glibc_unused_qhook;
 110         void * __glibc_unused_rhook;
 111         int     res_h_errno;            /* last one set for this context */
 112         int     _vcsock;                /* PRIVATE: for res_send VC i/o */
 113         unsigned int _flags;            /* PRIVATE: see below */
 114         /* 4 byte hole here on 64-bit architectures.  */
 115         union {
 116                 char    pad[52];        /* On an i386 this means 512b total. */
 117                 struct {
 118                         uint16_t                nscount;
 119                         uint16_t                nsmap[MAXNS];
 120                         int                     nssocks[MAXNS];
 121                         uint16_t                nscount6;
 122                         uint16_t                nsinit;
 123                         struct sockaddr_in6     *nsaddrs[MAXNS];
 124 #ifdef _LIBC
 125                         unsigned long long int  initstamp
 126                           __attribute__((packed));
 127 #else
 128                         unsigned int            _initstamp[2];
 129 #endif
 130                 } _ext;
 131         } _u;
 132 };
 133
 134 typedef struct __res_state *res_state;
 135 # undef __need_res_state
 136 #endif
 137
 138 #ifdef _RESOLV_H_
 139 /*
 140  * Revision information.  This is the release date in YYYYMMDD format.
 141  * It can change every day so the right thing to do with it is use it
 142  * in preprocessor commands such as "#if (__RES > 19931104)".  Do not
 143  * compare for equality; rather, use it to determine whether your resolver
 144  * is new enough to contain a certain feature.
 145  */
 146
 147 #define __RES   19991006
 148
 149 /*
 150  * Resolver configuration file.
 151  * Normally not present, but may contain the address of the
 152  * inital name server(s) to query and the domain search list.
 153  */
 154
 155 #ifndef _PATH_RESCONF
 156 #define _PATH_RESCONF        "/etc/resolv.conf"
 157 #endif
 158
 159 struct res_sym {
 160         int     number;         /* Identifying number, like T_MX */
 161         char *  name;           /* Its symbolic name, like "MX" */
 162         char *  humanname;      /* Its fun name, like "mail exchanger" */
 163 };
 164
 165 /*
 166  * Resolver flags (used to be discrete per-module statics ints).
 167  */
 168 #define RES_F_VC        0x00000001      /* socket is TCP */
 169 #define RES_F_CONN      0x00000002      /* socket is connected */
 170 #define RES_F_EDNS0ERR  0x00000004      /* EDNS0 caused errors */
 171
 172 /* res_findzonecut() options */
 173 #define RES_EXHAUSTIVE  0x00000001      /* always do all queries */
 174
 175 /*
 176  * Resolver options (keep these in synch with res_debug.c, please)
 177  */
 178 #define RES_INIT        0x00000001      /* address initialized */
 179 #define RES_DEBUG       0x00000002      /* print debug messages */
 180 #define RES_AAONLY \
 181   __glibc_macro_warning ("RES_AAONLY is deprecated") 0x00000004
 182 #define RES_USEVC       0x00000008      /* use virtual circuit */
 183 #define RES_PRIMARY \
 184   __glibc_macro_warning ("RES_PRIMARY is deprecated") 0x00000010
 185 #define RES_IGNTC       0x00000020      /* ignore trucation errors */
 186 #define RES_RECURSE     0x00000040      /* recursion desired */
 187 #define RES_DEFNAMES    0x00000080      /* use default domain name */
 188 #define RES_STAYOPEN    0x00000100      /* Keep TCP socket open */
 189 #define RES_DNSRCH      0x00000200      /* search up local domain tree */
 190 #define RES_INSECURE1   0x00000400      /* type 1 security disabled */
 191 #define RES_INSECURE2   0x00000800      /* type 2 security disabled */
 192 #define RES_NOALIASES   0x00001000      /* shuts off HOSTALIASES feature */
 193 #define RES_USE_INET6   0x00002000      /* use/map IPv6 in gethostbyname() */
 194 #define RES_ROTATE      0x00004000      /* rotate ns list after each query */
 195 #define RES_NOCHECKNAME \
 196   __glibc_macro_warning ("RES_NOCHECKNAME is deprecated") 0x00008000
 197 #define RES_KEEPTSIG \
 198   __glibc_macro_warning ("RES_KEEPTSIG is deprecated") 0x00010000
 199 #define RES_BLAST       0x00020000      /* blast all recursive servers */
 200 #define RES_USEBSTRING  0x00040000      /* IPv6 reverse lookup with byte
 201                                            strings */
 202 #define RES_USE_EDNS0   0x00100000      /* Use EDNS0.  */
 203 #define RES_SNGLKUP     0x00200000      /* one outstanding request at a time */
 204 #define RES_SNGLKUPREOP 0x00400000      /* -"-, but open new socket for each
 205                                            request */
 206 #define RES_USE_DNSSEC  0x00800000      /* use DNSSEC using OK bit in OPT */
 207 #define RES_NOTLDQUERY  0x01000000      /* Do not look up unqualified name
 208                                            as a TLD.  */
 209
 210 #define RES_DEFAULT     (RES_RECURSE|RES_DEFNAMES|RES_DNSRCH)
 211
 212 /*
 213  * Resolver "pfcode" values.  Used by dig.
 214  */
 215 #define RES_PRF_STATS   0x00000001
 216 #define RES_PRF_UPDATE  0x00000002
 217 #define RES_PRF_CLASS   0x00000004
 218 #define RES_PRF_CMD     0x00000008
 219 #define RES_PRF_QUES    0x00000010
 220 #define RES_PRF_ANS     0x00000020
 221 #define RES_PRF_AUTH    0x00000040
 222 #define RES_PRF_ADD     0x00000080
 223 #define RES_PRF_HEAD1   0x00000100
 224 #define RES_PRF_HEAD2   0x00000200
 225 #define RES_PRF_TTLID   0x00000400
 226 #define RES_PRF_HEADX   0x00000800
 227 #define RES_PRF_QUERY   0x00001000
 228 #define RES_PRF_REPLY   0x00002000
 229 #define RES_PRF_INIT    0x00004000
 230 /*                      0x00008000      */
 231
 232 /* Things involving an internal (static) resolver context. */
 233 __BEGIN_DECLS
 234 extern struct __res_state *__res_state(void) __attribute__ ((__const__));
 235 __END_DECLS
 236 #define _res (*__res_state())
 237
 238 #define fp_nquery               __fp_nquery
 239 #define fp_query                __fp_query
 240 #define hostalias               __hostalias
 241 #define p_query                 __p_query
 242 #define res_close               __res_close
 243 #define res_init                __res_init
 244 #define res_isourserver         __res_isourserver
 245 #define res_mkquery             __res_mkquery
 246 #define res_query               __res_query
 247 #define res_querydomain         __res_querydomain
 248 #define res_search              __res_search
 249 #define res_send                __res_send
 250
 251 __BEGIN_DECLS
 252 void            fp_nquery (const unsigned char *, int, FILE *) __THROW;
 253 void            fp_query (const unsigned char *, FILE *) __THROW;
 254 const char *    hostalias (const char *) __THROW;
 255 void            p_query (const unsigned char *) __THROW;
 256 void            res_close (void) __THROW;
 257 int             res_init (void) __THROW;
 258 int             res_isourserver (const struct sockaddr_in *) __THROW;
 259 int             res_mkquery (int, const char *, int, int,
 260                              const unsigned char *, int, const unsigned char *,
 261                              unsigned char *, int) __THROW;
 262 int             res_query (const char *, int, int, unsigned char *, int)
 263      __THROW;
 264 int             res_querydomain (const char *, const char *, int, int,
 265                                  unsigned char *, int) __THROW;
 266 int             res_search (const char *, int, int, unsigned char *, int)
 267      __THROW;
 268 int             res_send (const unsigned char *, int, unsigned char *, int)
 269      __THROW;
 270 __END_DECLS
 271
 272 #define b64_ntop                __b64_ntop
 273 #define b64_pton                __b64_pton
 274 #define dn_comp                 __dn_comp
 275 #define dn_count_labels         __dn_count_labels
 276 #define dn_expand               __dn_expand
 277 #define dn_skipname             __dn_skipname
 278 #define fp_resstat              __fp_resstat
 279 #define loc_aton                __loc_aton
 280 #define loc_ntoa                __loc_ntoa
 281 #define p_cdname                __p_cdname
 282 #define p_cdnname               __p_cdnname
 283 #define p_class                 __p_class
 284 #define p_fqname                __p_fqname
 285 #define p_fqnname               __p_fqnname
 286 #define p_option                __p_option
 287 #define p_secstodate            __p_secstodate
 288 #define p_section               __p_section
 289 #define p_time                  __p_time
 290 #define p_type                  __p_type
 291 #define p_rcode                 __p_rcode
 292 #define putlong                 __putlong
 293 #define putshort                __putshort
 294 #define res_dnok                __res_dnok
 295 #define res_hnok                __res_hnok
 296 #define res_hostalias           __res_hostalias
 297 #define res_mailok              __res_mailok
 298 #define res_nameinquery         __res_nameinquery
 299 #define res_nclose              __res_nclose
 300 #define res_ninit               __res_ninit
 301 #define res_nmkquery            __res_nmkquery
 302 #define res_npquery             __res_npquery
 303 #define res_nquery              __res_nquery
 304 #define res_nquerydomain        __res_nquerydomain
 305 #define res_nsearch             __res_nsearch
 306 #define res_nsend               __res_nsend
 307 #define res_nisourserver        __res_nisourserver
 308 #define res_ownok               __res_ownok
 309 #define res_queriesmatch        __res_queriesmatch
 310 #define res_randomid            __res_randomid
 311 #define sym_ntop                __sym_ntop
 312 #define sym_ntos                __sym_ntos
 313 #define sym_ston                __sym_ston
 314 __BEGIN_DECLS
 315 int             res_hnok (const char *) __THROW;
 316 int             res_ownok (const char *) __THROW;
 317 int             res_mailok (const char *) __THROW;
 318 int             res_dnok (const char *) __THROW;
 319 int             sym_ston (const struct res_sym *, const char *, int *) __THROW;
 320 const char *    sym_ntos (const struct res_sym *, int, int *) __THROW;
 321 const char *    sym_ntop (const struct res_sym *, int, int *) __THROW;
 322 int             b64_ntop (const unsigned char *, size_t, char *, size_t)
 323      __THROW;
 324 int             b64_pton (char const *, unsigned char *, size_t) __THROW;
 325 int             loc_aton (const char *__ascii, unsigned char *__binary) __THROW;
 326 const char *    loc_ntoa (const unsigned char *__binary, char *__ascii) __THROW;
 327 int             dn_skipname (const unsigned char *, const unsigned char *)
 328      __THROW;
 329 void            putlong (uint32_t, unsigned char *) __THROW;
 330 void            putshort (uint16_t, unsigned char *) __THROW;
 331 const char *    p_class (int) __THROW;
 332 const char *    p_time (uint32_t) __THROW;
 333 const char *    p_type (int) __THROW;
 334 const char *    p_rcode (int) __THROW;
 335 const unsigned char * p_cdnname (const unsigned char *,
 336                                  const unsigned char *, int, FILE *) __THROW;
 337 const unsigned char * p_cdname (const unsigned char *, const unsigned char *,
 338                                 FILE *) __THROW;
 339 const unsigned char * p_fqnname (const unsigned char *__cp,
 340                                  const unsigned char *__msg,
 341                                  int, char *, int) __THROW;
 342 const unsigned char * p_fqname (const unsigned char *,
 343                                 const unsigned char *, FILE *) __THROW;
 344 const char *    p_option (unsigned long __option) __THROW;
 345 char *          p_secstodate (unsigned long) __THROW;
 346 int             dn_count_labels (const char *) __THROW;
 347 int             dn_comp (const char *, unsigned char *, int, unsigned char **,
 348                          unsigned char **) __THROW;
 349 int             dn_expand (const unsigned char *, const unsigned char *,
 350                            const unsigned char *, char *, int) __THROW;
 351 unsigned int    res_randomid (void) __THROW;
 352 int             res_nameinquery (const char *, int, int,
 353                                  const unsigned char *,
 354                                  const unsigned char *) __THROW;
 355 int             res_queriesmatch (const unsigned char *,
 356                                   const unsigned char *,
 357                                   const unsigned char *,
 358                                   const unsigned char *) __THROW;
 359 const char *    p_section (int __section, int __opcode) __THROW;
 360 /* Things involving a resolver context. */
 361 int             res_ninit (res_state) __THROW;
 362 int             res_nisourserver (const res_state,
 363                                   const struct sockaddr_in *) __THROW;
 364 void            fp_resstat (const res_state, FILE *) __THROW;
 365 void            res_npquery (const res_state, const unsigned char *, int,
 366                              FILE *) __THROW;
 367 const char *    res_hostalias (const res_state, const char *, char *, size_t)
 368      __THROW;
 369 int             res_nquery (res_state, const char *, int, int,
 370                             unsigned char *, int) __THROW;
 371 int             res_nsearch (res_state, const char *, int, int,
 372                              unsigned char *, int) __THROW;
 373 int             res_nquerydomain (res_state, const char *, const char *, int,
 374                                   int, unsigned char *, int) __THROW;
 375 int             res_nmkquery (res_state, int, const char *, int, int,
 376                               const unsigned char *, int,
 377                               const unsigned char *, unsigned char *, int)
 378      __THROW;
 379 int             res_nsend (res_state, const unsigned char *, int,
 380                            unsigned char *, int) __THROW;
 381 void            res_nclose (res_state) __THROW;
 382 __END_DECLS
 383 #endif
 384
 385 #endif /* !_RESOLV_H_ */