include/resolv.h

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