contrib/isc-dhcp/includes/minires/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 1.3 2000/07/17 20:54:12 mellon Exp $
  54  */
  55
  56 #ifndef _RESOLV_H_
  57 #define _RESOLV_H_
  58
  59 /*
  60  * This used to be defined in res_query.c, now it's in herror.c.
  61  * [XXX no it's not.  It's in irs/irs_data.c]
  62  * It was
  63  * never extern'd by any *.h file before it was placed here.  For thread
  64  * aware programs, the last h_errno value set is stored in res->h_errno.
  65  *
  66  * XXX: There doesn't seem to be a good reason for exposing RES_SET_H_ERRNO
  67  *      (and __h_errno_set) to the public via <resolv.h>.
  68  * XXX: __h_errno_set is really part of IRS, not part of the resolver.
  69  *      If somebody wants to build and use a resolver that doesn't use IRS,
  70  *      what do they do?  Perhaps something like
  71  *              #ifdef WANT_IRS
  72  *              # define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x)
  73  *              #else
  74  *              # define RES_SET_H_ERRNO(r,x) (h_errno = (r)->res_h_errno = (x))
  75  *              #endif
  76  */
  77
  78 #define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x)
  79 struct __res_state; /* forward */
  80 void __h_errno_set(struct __res_state *res, int err);
  81
  82 /*
  83  * Resolver configuration file.
  84  * Normally not present, but may contain the address of the
  85  * inital name server(s) to query and the domain search list.
  86  */
  87
  88 #ifndef _PATH_RESCONF
  89 #define _PATH_RESCONF        "/etc/resolv.conf"
  90 #endif
  91
  92 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
  93         res_sendhookact;
  94
  95 typedef res_sendhookact (*res_send_qhook) (struct sockaddr_in * const *ns,
  96                                               double **query,
  97                                               unsigned *querylen,
  98                                               double *ans,
  99                                               unsigned anssiz,
 100                                               int *resplen);
 101
 102 typedef res_sendhookact (*res_send_rhook) (const struct sockaddr_in *ns,
 103                                            double *query,
 104                                            unsigned querylen,
 105                                            double *ans,
 106                                            unsigned anssiz,
 107                                            int *resplen);
 108
 109 struct res_sym {
 110         int     number;         /* Identifying number, like T_MX */
 111         char *  name;           /* Its symbolic name, like "MX" */
 112         char *  humanname;      /* Its fun name, like "mail exchanger" */
 113 };
 114
 115 /*
 116  * Global defines and variables for resolver stub.
 117  */
 118 #define MAXNS                   3       /* max # name servers we'll track */
 119 #define MAXDFLSRCH              3       /* # default domain levels to try */
 120 #define MAXDNSRCH               6       /* max # domains in search path */
 121 #define LOCALDOMAINPARTS        2       /* min levels in name that is "local" */
 122
 123 #define RES_TIMEOUT             5       /* min. seconds between retries */
 124 #define MAXRESOLVSORT           10      /* number of net to sort on */
 125 #define RES_MAXNDOTS            15      /* should reflect bit field size */
 126 #define RES_MAXRETRANS          30      /* only for resolv.conf/RES_OPTIONS */
 127 #define RES_MAXRETRY            5       /* only for resolv.conf/RES_OPTIONS */
 128 #define RES_DFLRETRY            2       /* Default #/tries. */
 129
 130 struct __res_state {
 131         int     retrans;                /* retransmition time interval */
 132         int     retry;                  /* number of times to retransmit */
 133         u_long  options;                /* option flags - see below. */
 134         int     nscount;                /* number of name servers */
 135         struct sockaddr_in
 136                 nsaddr_list[MAXNS];     /* address of name server */
 137 #define nsaddr  nsaddr_list[0]          /* for backward compatibility */
 138         u_short id;                     /* current message id */
 139         char    *dnsrch[MAXDNSRCH+1];   /* components of domain to search */
 140         char    defdname[256];          /* default domain (deprecated) */
 141         u_long  pfcode;                 /* RES_PRF_ flags - see below. */
 142         unsigned ndots:4;               /* threshold for initial abs. query */
 143         unsigned nsort:4;               /* number of elements in sort_list[] */
 144         char    unused[3];
 145         struct {
 146                 struct in_addr  addr;
 147                 u_int32_t       mask;
 148         } sort_list[MAXRESOLVSORT];
 149         res_send_qhook qhook;           /* query hook */
 150         res_send_rhook rhook;           /* response hook */
 151         int     res_h_errno;            /* last one set for this context */
 152         int     _sock;                  /* PRIVATE: for res_send i/o */
 153         u_int   _flags;                 /* PRIVATE: see below */
 154         char    pad[52];                /* On an i386 this means 512b total. */
 155 };
 156
 157 typedef struct __res_state *res_state;
 158
 159 /*
 160  * Resolver flags (used to be discrete per-module statics ints).
 161  */
 162 #define RES_F_VC        0x00000001      /* socket is TCP */
 163 #define RES_F_CONN      0x00000002      /* socket is connected */
 164
 165 /* res_findzonecut() options */
 166 #define RES_EXHAUSTIVE  0x00000001      /* always do all queries */
 167
 168 /*
 169  * Resolver options (keep these in synch with res_debug.c, please)
 170  */
 171 #define RES_INIT        0x00000001      /* address initialized */
 172 #define RES_DEBUG       0x00000002      /* print debug messages */
 173 #define RES_AAONLY      0x00000004      /* authoritative answers only (!IMPL)*/
 174 #define RES_USEVC       0x00000008      /* use virtual circuit */
 175 #define RES_PRIMARY     0x00000010      /* query primary server only (!IMPL) */
 176 #define RES_IGNTC       0x00000020      /* ignore trucation errors */
 177 #define RES_RECURSE     0x00000040      /* recursion desired */
 178 #define RES_DEFNAMES    0x00000080      /* use default domain name */
 179 #define RES_STAYOPEN    0x00000100      /* Keep TCP socket open */
 180 #define RES_DNSRCH      0x00000200      /* search up local domain tree */
 181 #define RES_INSECURE1   0x00000400      /* type 1 security disabled */
 182 #define RES_INSECURE2   0x00000800      /* type 2 security disabled */
 183 #define RES_NOALIASES   0x00001000      /* shuts off HOSTALIASES feature */
 184 #define RES_USE_INET6   0x00002000      /* use/map IPv6 in gethostbyname() */
 185 #define RES_ROTATE      0x00004000      /* rotate ns list after each query */
 186 #define RES_NOCHECKNAME 0x00008000      /* do not check names for sanity. */
 187 #define RES_KEEPTSIG    0x00010000      /* do not strip TSIG records */
 188
 189 #define RES_DEFAULT     (RES_RECURSE | RES_DEFNAMES | RES_DNSRCH)
 190
 191 /*
 192  * Resolver "pfcode" values.  Used by dig.
 193  */
 194 #define RES_PRF_STATS   0x00000001
 195 #define RES_PRF_UPDATE  0x00000002
 196 #define RES_PRF_CLASS   0x00000004
 197 #define RES_PRF_CMD     0x00000008
 198 #define RES_PRF_QUES    0x00000010
 199 #define RES_PRF_ANS     0x00000020
 200 #define RES_PRF_AUTH    0x00000040
 201 #define RES_PRF_ADD     0x00000080
 202 #define RES_PRF_HEAD1   0x00000100
 203 #define RES_PRF_HEAD2   0x00000200
 204 #define RES_PRF_TTLID   0x00000400
 205 #define RES_PRF_HEADX   0x00000800
 206 #define RES_PRF_QUERY   0x00001000
 207 #define RES_PRF_REPLY   0x00002000
 208 #define RES_PRF_INIT    0x00004000
 209 /*                      0x00008000      */
 210
 211 #if 0
 212 /* Things involving an internal (static) resolver context. */
 213 #ifdef _REENTRANT
 214 extern struct __res_state *__res_state(void);
 215 #define _res (*__res_state())
 216 #else
 217 #ifndef __BIND_NOSTATIC
 218 extern struct __res_state _res;
 219 #endif
 220 #endif
 221
 222 void            fp_nquery (const u_char *, int, FILE *);
 223 void            fp_query (const u_char *, FILE *);
 224 const char *    hostalias (const char *);
 225 void            p_query (const u_char *);
 226 void            res_close (void);
 227 int             res_init (void);
 228 int             res_isourserver (const struct sockaddr_in *);
 229 int             res_mkquery (int, const char *, int, int, const u_char *,
 230                                  int, const u_char *, u_char *, int);
 231 int             res_query (const char *, int, int, u_char *, int);
 232 int             res_querydomain (const char *, const char *, int, int,
 233                                      u_char *, int);
 234 int             res_search (const char *, int, int, u_char *, int);
 235 int             res_send (const u_char *, int, u_char *, int);
 236 int             res_sendsigned (const u_char *, int, ns_tsig_key *,
 237                                     u_char *, int);
 238
 239 #if !defined(SHARED_LIBBIND) || defined(LIB)
 240 /*
 241  * If libbind is a shared object (well, DLL anyway)
 242  * these externs break the linker when resolv.h is
 243  * included by a lib client (like named)
 244  * Make them go away if a client is including this
 245  *
 246  */
 247 extern const struct res_sym __p_key_syms[];
 248 extern const struct res_sym __p_cert_syms[];
 249 extern const struct res_sym __p_class_syms[];
 250 extern const struct res_sym __p_type_syms[];
 251 extern const struct res_sym __p_rcode_syms[];
 252 #endif /* SHARED_LIBBIND */
 253
 254 int             res_hnok (const char *);
 255 int             res_ownok (const char *);
 256 int             res_mailok (const char *);
 257 int             res_dnok (const char *);
 258 int             sym_ston (const struct res_sym *, const char *, int *);
 259 const char *    sym_ntos (const struct res_sym *, int, int *);
 260 const char *    sym_ntop (const struct res_sym *, int, int *);
 261 int             b64_ntop (u_char const *, size_t, char *, size_t);
 262 int             b64_pton (char const *, u_char *, size_t);
 263 int             loc_aton (const char *ascii, u_char *binary);
 264 const char *    loc_ntoa (const u_char *binary, char *ascii);
 265 int             dn_skipname (const u_char *, const u_char *);
 266 void            putlong (u_int32_t, u_char *);
 267 void            putshort (u_int16_t, u_char *);
 268 const char *    p_class (int);
 269 const char *    p_time (u_int32_t);
 270 const char *    p_type (int);
 271 const char *    p_rcode (int);
 272 const u_char *  p_cdnname (const u_char *, const u_char *, int, FILE *);
 273 const u_char *  p_cdname (const u_char *, const u_char *, FILE *);
 274 const u_char *  p_fqnname (const u_char *cp, const u_char *msg,
 275                                int, char *, int);
 276 const u_char *  p_fqname (const u_char *, const u_char *, FILE *);
 277 const char *    p_option (u_long option);
 278 char *          p_secstodate (u_long);
 279 int             dn_count_labels (const char *);
 280 int             dn_expand (const u_char *, const u_char *, const u_char *,
 281                                char *, int);
 282 u_int           res_randomid (void);
 283 int             res_nameinquery (const char *, int, int,
 284                                      const u_char *, const u_char *);
 285 int             res_queriesmatch (const u_char *, const u_char *,
 286                                       const u_char *, const u_char *);
 287 const char *    p_section (int section, int opcode);
 288 /* Things involving a resolver context. */
 289 int             res_ninit (res_state);
 290 int             res_nisourserver (const res_state,
 291                                       const struct sockaddr_in *);
 292 void            fp_resstat (const res_state, FILE *);
 293 void            res_npquery (const res_state, const u_char *, int, FILE *);
 294 const char *    res_hostalias (const res_state, const char *,
 295                                    char *, size_t);
 296 int             res_nquery (res_state,
 297                                 const char *, int, int, u_char *, int);
 298 int             res_nsearch (res_state, const char *, int,
 299                                  int, u_char *, int);
 300 int             res_nquerydomain (res_state,
 301                                       const char *, const char *, int, int,
 302                                       u_char *, int);
 303 int             res_nmkquery (res_state,
 304                                   int, const char *, int, int, const u_char *,
 305                                   int, const u_char *, u_char *, int);
 306 int             res_nsend (res_state, const u_char *, int, u_char *, int);
 307 int             res_nsendsigned (res_state, const u_char *, int,
 308                                      ns_tsig_key *, u_char *, int);
 309 int             res_findzonecut (res_state, const char *, ns_class, int,
 310                                      char *, size_t, struct in_addr *, int);
 311 void            res_nclose (res_state);
 312
 313 #endif /* 0 */
 314 #endif /* !_RESOLV_H_ */