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 1
  63
  64 #include <features.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 <stdio.h>
  73 #include <netinet/in.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  * initial 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
 103 #define RES_TIMEOUT             5       /* min. seconds between retries */
 104 #define MAXRESOLVSORT           10      /* number of net to sort on */
 105 #define RES_MAXNDOTS            15      /* should reflect bit field size */
 106
 107 struct __res_state {
 108         int     retrans;                /* retransmission time interval */
 109         int     retry;                  /* number of times to retransmit */
 110         u_long  options;                /* option flags - see below. */
 111         int     nscount;                /* number of name servers */
 112         struct sockaddr_in
 113                 nsaddr_list[MAXNS];     /* address of name server */
 114 #define nsaddr  nsaddr_list[0]          /* for backward compatibility */
 115         u_short id;                     /* current message id */
 116         char    *dnsrch[MAXDNSRCH+1];   /* components of domain to search */
 117         char    defdname[256];          /* default domain (deprecated) */
 118         u_long  pfcode;                 /* RES_PRF_ flags - see below. */
 119         unsigned ndots:4;               /* threshold for initial abs. query */
 120         unsigned nsort:4;               /* number of elements in sort_list[] */
 121         char    unused[3];
 122         struct {
 123                 struct in_addr  addr;
 124                 u_int32_t       mask;
 125         } sort_list[MAXRESOLVSORT];
 126         char    pad[72];                /* on an i386 this means 512b total */
 127 };
 128
 129 /*
 130  * Resolver options (keep these in synch with res_debug.c, please)
 131  */
 132 #define RES_INIT        0x00000001      /* address initialized */
 133 #define RES_DEBUG       0x00000002      /* print debug messages */
 134 #define RES_AAONLY      0x00000004      /* authoritative answers only (!IMPL)*/
 135 #define RES_USEVC       0x00000008      /* use virtual circuit */
 136 #define RES_PRIMARY     0x00000010      /* query primary server only (!IMPL) */
 137 #define RES_IGNTC       0x00000020      /* ignore trucation errors */
 138 #define RES_RECURSE     0x00000040      /* recursion desired */
 139 #define RES_DEFNAMES    0x00000080      /* use default domain name */
 140 #define RES_STAYOPEN    0x00000100      /* Keep TCP socket open */
 141 #define RES_DNSRCH      0x00000200      /* search up local domain tree */
 142 #define RES_INSECURE1   0x00000400      /* type 1 security disabled */
 143 #define RES_INSECURE2   0x00000800      /* type 2 security disabled */
 144 #define RES_NOALIASES   0x00001000      /* shuts off HOSTALIASES feature */
 145 #define RES_USE_INET6   0x00002000      /* use/map IPv6 in gethostbyname() */
 146
 147 #define RES_DEFAULT     (RES_RECURSE | RES_DEFNAMES | RES_DNSRCH)
 148
 149 /*
 150  * Resolver "pfcode" values.  Used by dig.
 151  */
 152 #define RES_PRF_STATS   0x00000001
 153 /*                      0x00000002      */
 154 #define RES_PRF_CLASS   0x00000004
 155 #define RES_PRF_CMD     0x00000008
 156 #define RES_PRF_QUES    0x00000010
 157 #define RES_PRF_ANS     0x00000020
 158 #define RES_PRF_AUTH    0x00000040
 159 #define RES_PRF_ADD     0x00000080
 160 #define RES_PRF_HEAD1   0x00000100
 161 #define RES_PRF_HEAD2   0x00000200
 162 #define RES_PRF_TTLID   0x00000400
 163 #define RES_PRF_HEADX   0x00000800
 164 #define RES_PRF_QUERY   0x00001000
 165 #define RES_PRF_REPLY   0x00002000
 166 #define RES_PRF_INIT    0x00004000
 167 /*                      0x00008000      */
 168
 169 /* hooks are still experimental as of 4.9.2 */
 170 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
 171         res_sendhookact;
 172
 173 typedef res_sendhookact (*res_send_qhook)__PMT((struct sockaddr_in * const *ns,
 174                                                 const u_char **query,
 175                                                 int *querylen,
 176                                                 u_char *ans,
 177                                                 int anssiz,
 178                                                 int *resplen));
 179
 180 typedef res_sendhookact (*res_send_rhook)__PMT((const struct sockaddr_in *ns,
 181                                                 const u_char *query,
 182                                                 int querylen,
 183                                                 u_char *ans,
 184                                                 int anssiz,
 185                                                 int *resplen));
 186
 187 struct res_sym {
 188         int     number;         /* Identifying number, like T_MX */
 189         char *  name;           /* Its symbolic name, like "MX" */
 190         char *  humanname;      /* Its fun name, like "mail exchanger" */
 191 };
 192
 193 extern struct __res_state _res;
 194 extern const struct res_sym __p_class_syms[];
 195 extern const struct res_sym __p_type_syms[];
 196
 197 /* Private routines shared between libc/net, named, nslookup and others. */
 198 #define res_hnok        __res_hnok
 199 #define res_ownok       __res_ownok
 200 #define res_mailok      __res_mailok
 201 #define res_dnok        __res_dnok
 202 #define sym_ston        __sym_ston
 203 #define sym_ntos        __sym_ntos
 204 #define sym_ntop        __sym_ntop
 205 #define b64_ntop        __b64_ntop
 206 #define b64_pton        __b64_pton
 207 #define loc_ntoa        __loc_ntoa
 208 #define loc_aton        __loc_aton
 209 #define dn_skipname     __dn_skipname
 210 #define fp_resstat      __fp_resstat
 211 #define fp_query        __fp_query
 212 #define fp_nquery       __fp_nquery
 213 #define hostalias       __hostalias
 214 #define putlong         __putlong
 215 #define putshort        __putshort
 216 #define p_class         __p_class
 217 #define p_time          __p_time
 218 #define p_type          __p_type
 219 #define p_query         __p_query
 220 #define p_cdnname       __p_cdnname
 221 #define p_cdname        __p_cdname
 222 #define p_fqnname       __p_fqnname
 223 #define p_fqname        __p_fqname
 224 #define p_rr            __p_rr
 225 #define p_option        __p_option
 226 #define p_secstodate    __p_secstodate
 227 #define dn_count_labels __dn_count_labels
 228 #define dn_comp         __dn_comp
 229 #define res_randomid    __res_randomid
 230 #define res_send        __res_send
 231 #define res_isourserver __res_isourserver
 232 #define res_nameinquery __res_nameinquery
 233 #define res_queriesmatch __res_queriesmatch
 234 #define res_close       __res_close
 235
 236 #ifdef BIND_RES_POSIX3
 237 #define dn_expand       __dn_expand
 238 #define res_init        __res_init
 239 #define res_query       __res_query
 240 #define res_search      __res_search
 241 #define res_querydomain __res_querydomain
 242 #define res_mkquery     __res_mkquery
 243 #endif
 244
 245 __BEGIN_DECLS
 246 int             res_hnok __P((const char *));
 247 int             res_ownok __P((const char *));
 248 int             res_mailok __P((const char *));
 249 int             res_dnok __P((const char *));
 250 int             sym_ston __P((const struct res_sym *, char *, int *));
 251 const char *    sym_ntos __P((const struct res_sym *, int, int *));
 252 const char *    sym_ntop __P((const struct res_sym *, int, int *));
 253 int             b64_ntop __P((u_char const *, size_t, char *, size_t));
 254 int             b64_pton __P((char const *, u_char *, size_t));
 255 int             loc_aton __P((const char *, u_char *));
 256 const char *    loc_ntoa __P((const u_char *, char *));
 257 int             dn_skipname __P((const u_char *, const u_char *));
 258 void            fp_resstat __P((struct __res_state *, FILE *));
 259 void            fp_query __P((const u_char *, FILE *));
 260 void            fp_nquery __P((const u_char *, int, FILE *));
 261 const char *    hostalias __P((const char *));
 262 void            putlong __P((u_int32_t, u_char *));
 263 void            putshort __P((u_int16_t, u_char *));
 264 const char *    p_class __P((int));
 265 const char *    p_time __P((u_int32_t));
 266 const char *    p_type __P((int));
 267 void            p_query __P((const u_char *));
 268 const u_char *  p_cdnname __P((const u_char *, const u_char *, int, FILE *));
 269 const u_char *  p_cdname __P((const u_char *, const u_char *, FILE *));
 270 const u_char *  p_fqnname __P((const u_char *cp, const u_char *msg,
 271                                int, char *, int));
 272 const u_char *  p_fqname __P((const u_char *, const u_char *, FILE *));
 273 const u_char *  p_rr __P((const u_char *, const u_char *, FILE *));
 274 const char *    p_option __P((u_long option));
 275 char *          p_secstodate __P((u_long));
 276 int             dn_count_labels __P((char *));
 277 int             dn_comp __P((const char *, u_char *, int,
 278                              u_char **, u_char **));
 279 int             dn_expand __P((const u_char *, const u_char *, const u_char *,
 280                                char *, int));
 281 int             res_init __P((void));
 282 u_int           res_randomid __P((void));
 283 int             res_query __P((const char *, int, int, u_char *, int));
 284 int             res_search __P((const char *, int, int, u_char *, int));
 285 int             res_querydomain __P((const char *, const char *, int, int,
 286                                      u_char *, int));
 287 int             res_mkquery __P((int, const char *, int, int, const u_char *, int,
 288                                  const u_char *, u_char *, int));
 289 int             res_send __P((const u_char *, int, u_char *, int));
 290 int             res_isourserver __P((const struct sockaddr_in *));
 291 int             res_nameinquery __P((const char *, int, int,
 292                                      const u_char *, const u_char *));
 293 int             res_queriesmatch __P((const u_char *, const u_char *,
 294                                       const u_char *, const u_char *));
 295 void            res_close __P((void));
 296 __END_DECLS
 297
 298 #endif /* resolv.h */