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