contrib/bind/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  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 /*
  35  * Portions Copyright (c) 1996-1999 by Internet Software Consortium.
  36  *
  37  * Permission to use, copy, modify, and distribute this software for any
  38  * purpose with or without fee is hereby granted, provided that the above
  39  * copyright notice and this permission notice appear in all copies.
  40  *
  41  * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
  42  * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
  43  * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
  44  * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  45  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  46  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
  47  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  48  * SOFTWARE.
  49  */
  50
  51 /*
  52  *      @(#)resolv.h    8.1 (Berkeley) 6/2/93
  53  *      $Id: resolv.h,v 8.29 1999/10/07 08:24:14 vixie Exp $
  54  */
  55
  56 #ifndef _RESOLV_H_
  57 #define _RESOLV_H_
  58
  59 #include <sys/param.h>
  60 #if (!defined(BSD)) || (BSD < 199306)
  61 # include <sys/bitypes.h>
  62 #else
  63 # include <sys/types.h>
  64 #endif
  65 #include <sys/cdefs.h>
  66 #include <stdio.h>
  67
  68 /*
  69  * Revision information.  This is the release date in YYYYMMDD format.
  70  * It can change every day so the right thing to do with it is use it
  71  * in preprocessor commands such as "#if (__RES > 19931104)".  Do not
  72  * compare for equality; rather, use it to determine whether your resolver
  73  * is new enough to contain a certain feature.
  74  */
  75
  76 #define __RES   19991006
  77
  78 /*
  79  * This used to be defined in res_query.c, now it's in herror.c.
  80  * [XXX no it's not.  It's in irs/irs_data.c]
  81  * It was
  82  * never extern'd by any *.h file before it was placed here.  For thread
  83  * aware programs, the last h_errno value set is stored in res->h_errno.
  84  *
  85  * XXX: There doesn't seem to be a good reason for exposing RES_SET_H_ERRNO
  86  *      (and __h_errno_set) to the public via <resolv.h>.
  87  * XXX: __h_errno_set is really part of IRS, not part of the resolver.
  88  *      If somebody wants to build and use a resolver that doesn't use IRS,
  89  *      what do they do?  Perhaps something like
  90  *              #ifdef WANT_IRS
  91  *              # define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x)
  92  *              #else
  93  *              # define RES_SET_H_ERRNO(r,x) (h_errno = (r)->res_h_errno = (x))
  94  *              #endif
  95  */
  96
  97 #define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x)
  98 struct __res_state; /* forward */
  99 void __h_errno_set(struct __res_state *res, int err);
 100
 101 /*
 102  * Resolver configuration file.
 103  * Normally not present, but may contain the address of the
 104  * inital name server(s) to query and the domain search list.
 105  */
 106
 107 #ifndef _PATH_RESCONF
 108 #define _PATH_RESCONF        "/etc/resolv.conf"
 109 #endif
 110
 111 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
 112         res_sendhookact;
 113
 114 typedef res_sendhookact (*res_send_qhook)__P((struct sockaddr_in * const *ns,
 115                                               const u_char **query,
 116                                               int *querylen,
 117                                               u_char *ans,
 118                                               int anssiz,
 119                                               int *resplen));
 120
 121 typedef res_sendhookact (*res_send_rhook)__P((const struct sockaddr_in *ns,
 122                                               const u_char *query,
 123                                               int querylen,
 124                                               u_char *ans,
 125                                               int anssiz,
 126                                               int *resplen));
 127
 128 struct res_sym {
 129         int     number;         /* Identifying number, like T_MX */
 130         char *  name;           /* Its symbolic name, like "MX" */
 131         char *  humanname;      /* Its fun name, like "mail exchanger" */
 132 };
 133
 134 /*
 135  * Global defines and variables for resolver stub.
 136  */
 137 #define MAXNS                   3       /* max # name servers we'll track */
 138 #define MAXDFLSRCH              3       /* # default domain levels to try */
 139 #define MAXDNSRCH               6       /* max # domains in search path */
 140 #define LOCALDOMAINPARTS        2       /* min levels in name that is "local" */
 141
 142 #define RES_TIMEOUT             5       /* min. seconds between retries */
 143 #define MAXRESOLVSORT           10      /* number of net to sort on */
 144 #define RES_MAXNDOTS            15      /* should reflect bit field size */
 145 #define RES_MAXRETRANS          30      /* only for resolv.conf/RES_OPTIONS */
 146 #define RES_MAXRETRY            5       /* only for resolv.conf/RES_OPTIONS */
 147 #define RES_DFLRETRY            2       /* Default #/tries. */
 148
 149 struct __res_state {
 150         int     retrans;                /* retransmition time interval */
 151         int     retry;                  /* number of times to retransmit */
 152         u_long  options;                /* option flags - see below. */
 153         int     nscount;                /* number of name servers */
 154         struct sockaddr_in
 155                 nsaddr_list[MAXNS];     /* address of name server */
 156 #define nsaddr  nsaddr_list[0]          /* for backward compatibility */
 157         u_short id;                     /* current message id */
 158         char    *dnsrch[MAXDNSRCH+1];   /* components of domain to search */
 159         char    defdname[256];          /* default domain (deprecated) */
 160         u_long  pfcode;                 /* RES_PRF_ flags - see below. */
 161         unsigned ndots:4;               /* threshold for initial abs. query */
 162         unsigned nsort:4;               /* number of elements in sort_list[] */
 163         char    unused[3];
 164         struct {
 165                 struct in_addr  addr;
 166                 u_int32_t       mask;
 167         } sort_list[MAXRESOLVSORT];
 168         res_send_qhook qhook;           /* query hook */
 169         res_send_rhook rhook;           /* response hook */
 170         int     res_h_errno;            /* last one set for this context */
 171         int     _sock;                  /* PRIVATE: for res_send i/o */
 172         u_int   _flags;                 /* PRIVATE: see below */
 173         char    pad[52];                /* On an i386 this means 512b total. */
 174 };
 175
 176 typedef struct __res_state *res_state;
 177
 178 /*
 179  * Resolver flags (used to be discrete per-module statics ints).
 180  */
 181 #define RES_F_VC        0x00000001      /* socket is TCP */
 182 #define RES_F_CONN      0x00000002      /* socket is connected */
 183
 184 /* res_findzonecut() options */
 185 #define RES_EXHAUSTIVE  0x00000001      /* always do all queries */
 186
 187 /*
 188  * Resolver options (keep these in synch with res_debug.c, please)
 189  */
 190 #define RES_INIT        0x00000001      /* address initialized */
 191 #define RES_DEBUG       0x00000002      /* print debug messages */
 192 #define RES_AAONLY      0x00000004      /* authoritative answers only (!IMPL)*/
 193 #define RES_USEVC       0x00000008      /* use virtual circuit */
 194 #define RES_PRIMARY     0x00000010      /* query primary server only (!IMPL) */
 195 #define RES_IGNTC       0x00000020      /* ignore trucation errors */
 196 #define RES_RECURSE     0x00000040      /* recursion desired */
 197 #define RES_DEFNAMES    0x00000080      /* use default domain name */
 198 #define RES_STAYOPEN    0x00000100      /* Keep TCP socket open */
 199 #define RES_DNSRCH      0x00000200      /* search up local domain tree */
 200 #define RES_INSECURE1   0x00000400      /* type 1 security disabled */
 201 #define RES_INSECURE2   0x00000800      /* type 2 security disabled */
 202 #define RES_NOALIASES   0x00001000      /* shuts off HOSTALIASES feature */
 203 #define RES_USE_INET6   0x00002000      /* use/map IPv6 in gethostbyname() */
 204 #define RES_ROTATE      0x00004000      /* rotate ns list after each query */
 205 #define RES_NOCHECKNAME 0x00008000      /* do not check names for sanity. */
 206 #define RES_KEEPTSIG    0x00010000      /* do not strip TSIG records */
 207
 208 #define RES_DEFAULT     (RES_RECURSE | RES_DEFNAMES | RES_DNSRCH)
 209
 210 /*
 211  * Resolver "pfcode" values.  Used by dig.
 212  */
 213 #define RES_PRF_STATS   0x00000001
 214 #define RES_PRF_UPDATE  0x00000002
 215 #define RES_PRF_CLASS   0x00000004
 216 #define RES_PRF_CMD     0x00000008
 217 #define RES_PRF_QUES    0x00000010
 218 #define RES_PRF_ANS     0x00000020
 219 #define RES_PRF_AUTH    0x00000040
 220 #define RES_PRF_ADD     0x00000080
 221 #define RES_PRF_HEAD1   0x00000100
 222 #define RES_PRF_HEAD2   0x00000200
 223 #define RES_PRF_TTLID   0x00000400
 224 #define RES_PRF_HEADX   0x00000800
 225 #define RES_PRF_QUERY   0x00001000
 226 #define RES_PRF_REPLY   0x00002000
 227 #define RES_PRF_INIT    0x00004000
 228 /*                      0x00008000      */
 229
 230 /* Things involving an internal (static) resolver context. */
 231 #ifdef _REENTRANT
 232 extern struct __res_state *__res_state(void);
 233 #define _res (*__res_state())
 234 #else
 235 #ifndef __BIND_NOSTATIC
 236 extern struct __res_state _res;
 237 #endif
 238 #endif
 239
 240 #ifndef __BIND_NOSTATIC
 241 #define fp_nquery               __fp_nquery
 242 #define fp_query                __fp_query
 243 #define hostalias               __hostalias
 244 #define p_query                 __p_query
 245 #define res_close               __res_close
 246 #define res_init                __res_init
 247 #define res_isourserver         __res_isourserver
 248 #define res_mkquery             __res_mkquery
 249 #define res_query               __res_query
 250 #define res_querydomain         __res_querydomain
 251 #define res_search              __res_search
 252 #define res_send                __res_send
 253 #define res_sendsigned          __res_sendsigned
 254
 255 __BEGIN_DECLS
 256 void            fp_nquery __P((const u_char *, int, FILE *));
 257 void            fp_query __P((const u_char *, FILE *));
 258 const char *    hostalias __P((const char *));
 259 void            p_query __P((const u_char *));
 260 void            res_close __P((void));
 261 int             res_init __P((void));
 262 int             res_isourserver __P((const struct sockaddr_in *));
 263 int             res_mkquery __P((int, const char *, int, int, const u_char *,
 264                                  int, const u_char *, u_char *, int));
 265 int             res_query __P((const char *, int, int, u_char *, int));
 266 int             res_querydomain __P((const char *, const char *, int, int,
 267                                      u_char *, int));
 268 int             res_search __P((const char *, int, int, u_char *, int));
 269 int             res_send __P((const u_char *, int, u_char *, int));
 270 int             res_sendsigned __P((const u_char *, int, ns_tsig_key *,
 271                                     u_char *, int));
 272 __END_DECLS
 273 #endif
 274
 275 #if !defined(SHARED_LIBBIND) || defined(LIB)
 276 /*
 277  * If libbind is a shared object (well, DLL anyway)
 278  * these externs break the linker when resolv.h is
 279  * included by a lib client (like named)
 280  * Make them go away if a client is including this
 281  *
 282  */
 283 extern const struct res_sym __p_key_syms[];
 284 extern const struct res_sym __p_cert_syms[];
 285 extern const struct res_sym __p_class_syms[];
 286 extern const struct res_sym __p_type_syms[];
 287 extern const struct res_sym __p_rcode_syms[];
 288 #endif /* SHARED_LIBBIND */
 289
 290 #define b64_ntop                __b64_ntop
 291 #define b64_pton                __b64_pton
 292 #define dn_comp                 __dn_comp
 293 #define dn_count_labels         __dn_count_labels
 294 #define dn_expand               __dn_expand
 295 #define dn_skipname             __dn_skipname
 296 #define fp_resstat              __fp_resstat
 297 #define loc_aton                __loc_aton
 298 #define loc_ntoa                __loc_ntoa
 299 #define p_cdname                __p_cdname
 300 #define p_cdnname               __p_cdnname
 301 #define p_class                 __p_class
 302 #define p_fqname                __p_fqname
 303 #define p_fqnname               __p_fqnname
 304 #define p_option                __p_option
 305 #define p_secstodate            __p_secstodate
 306 #define p_section               __p_section
 307 #define p_time                  __p_time
 308 #define p_type                  __p_type
 309 #define p_rcode                 __p_rcode
 310 #define putlong                 __putlong
 311 #define putshort                __putshort
 312 #define res_dnok                __res_dnok
 313 #define res_findzonecut         __res_findzonecut
 314 #define res_hnok                __res_hnok
 315 #define res_hostalias           __res_hostalias
 316 #define res_mailok              __res_mailok
 317 #define res_nameinquery         __res_nameinquery
 318 #define res_nclose              __res_nclose
 319 #define res_ninit               __res_ninit
 320 #define res_nmkquery            __res_nmkquery
 321 #define res_npquery             __res_npquery
 322 #define res_nquery              __res_nquery
 323 #define res_nquerydomain        __res_nquerydomain
 324 #define res_nsearch             __res_nsearch
 325 #define res_nsend               __res_nsend
 326 #define res_nsendsigned         __res_nsendsigned
 327 #define res_nisourserver        __res_nisourserver
 328 #define res_ownok               __res_ownok
 329 #define res_queriesmatch        __res_queriesmatch
 330 #define res_randomid            __res_randomid
 331 #define sym_ntop                __sym_ntop
 332 #define sym_ntos                __sym_ntos
 333 #define sym_ston                __sym_ston
 334 __BEGIN_DECLS
 335 int             res_hnok __P((const char *));
 336 int             res_ownok __P((const char *));
 337 int             res_mailok __P((const char *));
 338 int             res_dnok __P((const char *));
 339 int             sym_ston __P((const struct res_sym *, const char *, int *));
 340 const char *    sym_ntos __P((const struct res_sym *, int, int *));
 341 const char *    sym_ntop __P((const struct res_sym *, int, int *));
 342 int             b64_ntop __P((u_char const *, size_t, char *, size_t));
 343 int             b64_pton __P((char const *, u_char *, size_t));
 344 int             loc_aton __P((const char *ascii, u_char *binary));
 345 const char *    loc_ntoa __P((const u_char *binary, char *ascii));
 346 int             dn_skipname __P((const u_char *, const u_char *));
 347 void            putlong __P((u_int32_t, u_char *));
 348 void            putshort __P((u_int16_t, u_char *));
 349 const char *    p_class __P((int));
 350 const char *    p_time __P((u_int32_t));
 351 const char *    p_type __P((int));
 352 const char *    p_rcode __P((int));
 353 const u_char *  p_cdnname __P((const u_char *, const u_char *, int, FILE *));
 354 const u_char *  p_cdname __P((const u_char *, const u_char *, FILE *));
 355 const u_char *  p_fqnname __P((const u_char *cp, const u_char *msg,
 356                                int, char *, int));
 357 const u_char *  p_fqname __P((const u_char *, const u_char *, FILE *));
 358 const char *    p_option __P((u_long option));
 359 char *          p_secstodate __P((u_long));
 360 int             dn_count_labels __P((const char *));
 361 int             dn_comp __P((const char *, u_char *, int,
 362                              u_char **, u_char **));
 363 int             dn_expand __P((const u_char *, const u_char *, const u_char *,
 364                                char *, int));
 365 u_int           res_randomid __P((void));
 366 int             res_nameinquery __P((const char *, int, int,
 367                                      const u_char *, const u_char *));
 368 int             res_queriesmatch __P((const u_char *, const u_char *,
 369                                       const u_char *, const u_char *));
 370 const char *    p_section __P((int section, int opcode));
 371 /* Things involving a resolver context. */
 372 int             res_ninit __P((res_state));
 373 int             res_nisourserver __P((const res_state,
 374                                       const struct sockaddr_in *));
 375 void            fp_resstat __P((const res_state, FILE *));
 376 void            res_npquery __P((const res_state, const u_char *, int, FILE *));
 377 const char *    res_hostalias __P((const res_state, const char *,
 378                                    char *, size_t));
 379 int             res_nquery __P((res_state,
 380                                 const char *, int, int, u_char *, int));
 381 int             res_nsearch __P((res_state, const char *, int,
 382                                  int, u_char *, int));
 383 int             res_nquerydomain __P((res_state,
 384                                       const char *, const char *, int, int,
 385                                       u_char *, int));
 386 int             res_nmkquery __P((res_state,
 387                                   int, const char *, int, int, const u_char *,
 388                                   int, const u_char *, u_char *, int));
 389 int             res_nsend __P((res_state, const u_char *, int, u_char *, int));
 390 int             res_nsendsigned __P((res_state, const u_char *, int,
 391                                      ns_tsig_key *, u_char *, int));
 392 int             res_findzonecut __P((res_state, const char *, ns_class, int,
 393                                      char *, size_t, struct in_addr *, int));
 394 void            res_nclose __P((res_state));
 395 __END_DECLS
 396
 397 #endif /* !_RESOLV_H_ */