resolv/resolv.h

   1 /*
   2  * ++Copyright++ 1983, 1987, 1989, 1993
   3  * -
   4  * Copyright (c) 1983, 1987, 1989, 1993
   5  *    The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. All advertising materials mentioning features or use of this software
  16  *    must display the following acknowledgement:
  17  *      This product includes software developed by the University of
  18  *      California, Berkeley and its contributors.
  19  * 4. Neither the name of the University nor the names of its contributors
  20  *    may be used to endorse or promote products derived from this software
  21  *    without specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  * -
  35  * Portions Copyright (c) 1993 by Digital Equipment Corporation.
  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, and that
  40  * the name of Digital Equipment Corporation not be used in advertising or
  41  * publicity pertaining to distribution of the document or software without
  42  * specific, written prior permission.
  43  *
  44  * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
  45  * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
  46  * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
  47  * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  48  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  49  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
  50  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  51  * SOFTWARE.
  52  * -
  53  * --Copyright--
  54  */
  55
  56 /*
  57  *      @(#)resolv.h    8.1 (Berkeley) 6/2/93
  58  *      $Id$
  59  */
  60
  61 #ifndef _RESOLV_H_
  62 #define _RESOLV_H_
  63
  64 #include <sys/param.h>
  65 #if (!defined(BSD)) || (BSD < 199306)
  66 # include <sys/bitypes.h>
  67 #else
  68 # include <sys/types.h>
  69 #endif
  70 #include <sys/cdefs.h>
  71 #include <stdio.h>
  72
  73 /*
  74  * revision information.  this is the release date in YYYYMMDD format.
  75  * it can change every day so the right thing to do with it is use it
  76  * in preprocessor commands such as "#if (__RES > 19931104)".  do not
  77  * compare for equality; rather, use it to determine whether your resolver
  78  * is new enough to contain a certain feature.
  79  */
  80
  81 #define __RES   19960229
  82
  83 /*
  84  * Resolver configuration file.
  85  * Normally not present, but may contain the address of the
  86  * inital name server(s) to query and the domain search list.
  87  */
  88
  89 #ifndef _PATH_RESCONF
  90 #define _PATH_RESCONF        "/etc/resolv.conf"
  91 #endif
  92
  93 /*
  94  * Global defines and variables for resolver stub.
  95  */
  96 #define MAXNS                   3       /* max # name servers we'll track */
  97 #define MAXDFLSRCH              3       /* # default domain levels to try */
  98 #define MAXDNSRCH               6       /* max # domains in search path */
  99 #define LOCALDOMAINPARTS        2       /* min levels in name that is "local" */
 100
 101 #define RES_TIMEOUT             5       /* min. seconds between retries */
 102 #define MAXRESOLVSORT           10      /* number of net to sort on */
 103 #define RES_MAXNDOTS            15      /* should reflect bit field size */
 104
 105 struct __res_state {
 106         int     retrans;                /* retransmition time interval */
 107         int     retry;                  /* number of times to retransmit */
 108         u_long  options;                /* option flags - see below. */
 109         int     nscount;                /* number of name servers */
 110         struct sockaddr_in
 111                 nsaddr_list[MAXNS];     /* address of name server */
 112 #define nsaddr  nsaddr_list[0]          /* for backward compatibility */
 113         u_short id;                     /* current packet id */
 114         char    *dnsrch[MAXDNSRCH+1];   /* components of domain to search */
 115         char    defdname[MAXDNAME];     /* default domain */
 116         u_long  pfcode;                 /* RES_PRF_ flags - see below. */
 117         unsigned ndots:4;               /* threshold for initial abs. query */
 118         unsigned nsort:4;               /* number of elements in sort_list[] */
 119         char    unused[3];
 120         struct {
 121                 struct in_addr  addr;
 122                 u_int32_t       mask;
 123         } sort_list[MAXRESOLVSORT];
 124         char    pad[72];                /* On an i38this means 512b total. */
 125 };
 126
 127 /*
 128  * Resolver options (keep these in synch with res_debug.c, please)
 129  */
 130 #define RES_INIT        0x00000001      /* address initialized */
 131 #define RES_DEBUG       0x00000002      /* print debug messages */
 132 #define RES_AAONLY      0x00000004      /* authoritative answers only (!IMPL)*/
 133 #define RES_USEVC       0x00000008      /* use virtual circuit */
 134 #define RES_PRIMARY     0x00000010      /* query primary server only (!IMPL) */
 135 #define RES_IGNTC       0x00000020      /* ignore trucation errors */
 136 #define RES_RECURSE     0x00000040      /* recursion desired */
 137 #define RES_DEFNAMES    0x00000080      /* use default domain name */
 138 #define RES_STAYOPEN    0x00000100      /* Keep TCP socket open */
 139 #define RES_DNSRCH      0x00000200      /* search up local domain tree */
 140 #define RES_INSECURE1   0x00000400      /* type 1 security disabled */
 141 #define RES_INSECURE2   0x00000800      /* type 2 security disabled */
 142 #define RES_NOALIASES   0x00001000      /* shuts off HOSTALIASES feature */
 143
 144 #define RES_DEFAULT     (RES_RECURSE | RES_DEFNAMES | RES_DNSRCH)
 145
 146 /*
 147  * Resolver "pfcode" values.  Used by dig.
 148  */
 149 #define RES_PRF_STATS   0x00000001
 150 /*                      0x00000002      */
 151 #define RES_PRF_CLASS   0x00000004
 152 #define RES_PRF_CMD     0x00000008
 153 #define RES_PRF_QUES    0x00000010
 154 #define RES_PRF_ANS     0x00000020
 155 #define RES_PRF_AUTH    0x00000040
 156 #define RES_PRF_ADD     0x00000080
 157 #define RES_PRF_HEAD1   0x00000100
 158 #define RES_PRF_HEAD2   0x00000200
 159 #define RES_PRF_TTLID   0x00000400
 160 #define RES_PRF_HEADX   0x00000800
 161 #define RES_PRF_QUERY   0x00001000
 162 #define RES_PRF_REPLY   0x00002000
 163 #define RES_PRF_INIT    0x00004000
 164 /*                      0x00008000      */
 165
 166 /* hooks are still experimental as of 4.9.2 */
 167 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
 168         res_sendhookact;
 169
 170 typedef res_sendhookact (*res_send_qhook)__P((struct sockaddr_in * const *ns,
 171                                               const u_char **query,
 172                                               int *querylen,
 173                                               u_char *ans,
 174                                               int anssiz,
 175                                               int *resplen));
 176
 177 typedef res_sendhookact (*res_send_rhook)__P((const struct sockaddr_in *ns,
 178                                               const u_char *query,
 179                                               int querylen,
 180                                               u_char *ans,
 181                                               int anssiz,
 182                                               int *resplen));
 183
 184 extern struct __res_state _res;
 185
 186 /* Private routines shared between libc/net, named, nslookup and others. */
 187 #define res_hnok        __res_hnok
 188 #define dn_isvalid      __dn_isvalid
 189 #define dn_skipname     __dn_skipname
 190 #define fp_query        __fp_query
 191 #define fp_nquery       __fp_nquery
 192 #define hostalias       __hostalias
 193 #define putlong         __putlong
 194 #define putshort        __putshort
 195 #define p_class         __p_class
 196 #define p_time          __p_time
 197 #define p_type          __p_type
 198 #define p_cdnname       __p_cdnname
 199 #define p_cdname        __p_cdname
 200 #define p_fqname        __p_fqname
 201 #define p_rr            __p_rr
 202 #define p_option        __p_option
 203 #define res_randomid    __res_randomid
 204 #define res_isourserver __res_isourserver
 205 #define res_nameinquery __res_nameinquery
 206 #define res_queriesmatch __res_queriesmatch
 207 __BEGIN_DECLS
 208 int      __res_hnok __P((const char *));
 209 int      __dn_isvalid __P((const char *));
 210 int      __dn_skipname __P((const u_char *, const u_char *));
 211 void     __fp_resstat __P((struct __res_state *, FILE *));
 212 void     __fp_query __P((const u_char *, FILE *));
 213 void     __fp_nquery __P((const u_char *, int, FILE *));
 214 char    *__hostalias __P((const char *));
 215 void     __putlong __P((u_int32_t, u_char *));
 216 void     __putshort __P((u_int16_t, u_char *));
 217 char    *__p_time __P((u_int32_t));
 218 void     __p_query __P((const u_char *));
 219 const u_char *__p_cdnname __P((const u_char *, const u_char *, int, FILE *));
 220 const u_char *__p_cdname __P((const u_char *, const u_char *, FILE *));
 221 const u_char *__p_fqname __P((const u_char *, const u_char *, FILE *));
 222 const u_char *__p_rr __P((const u_char *, const u_char *, FILE *));
 223 const char *__p_type __P((int));
 224 const char *__p_class __P((int));
 225 const char *__p_option __P((u_long option));
 226 int      dn_comp __P((const char *, u_char *, int, u_char **, u_char **));
 227 int      dn_expand __P((const u_char *, const u_char *, const u_char *,
 228                         char *, int));
 229 int      res_init __P((void));
 230 u_int16_t res_randomid __P((void));
 231 int      res_query __P((const char *, int, int, u_char *, int));
 232 int      res_search __P((const char *, int, int, u_char *, int));
 233 int      res_querydomain __P((const char *, const char *, int, int,
 234                               u_char *, int));
 235 int      res_mkquery __P((int, const char *, int, int, const u_char *, int,
 236                           const u_char *, u_char *, int));
 237 int      res_send __P((const u_char *, int, u_char *, int));
 238 int      res_isourserver __P((const struct sockaddr_in *));
 239 int      res_nameinquery __P((const char *, int, int,
 240                               const u_char *, const u_char *));
 241 int      res_queriesmatch __P((const u_char *, const u_char *,
 242                                const u_char *, const u_char *));
 243 /* XXX - these last two don't belong in the resolver */
 244 u_int    inet_nsap_addr __P((const char *, u_char *, int maxlen));
 245 char    *inet_nsap_ntoa __P((int, const u_char *, char *ascii));
 246 __END_DECLS
 247
 248 #endif /* !_RESOLV_H_ */