include/resolv.h

   1 /*-
   2  * Copyright (c) 1983, 1987, 1989, 1993
   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 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  *      From Id: resolv.h,v 8.12 1998/04/28 19:36:46 halley Exp $
  54  * $FreeBSD$
  55  */
  56
  57 #ifndef _RESOLV_H_
  58 #define _RESOLV_H_
  59
  60 #include <sys/param.h>
  61 #include <sys/types.h>
  62 #include <sys/cdefs.h>
  63 #include <sys/socket.h>
  64 #include <stdio.h>
  65
  66 /*
  67  * Revision information.  This is the release date in YYYYMMDD format.
  68  * It can change every day so the right thing to do with it is use it
  69  * in preprocessor commands such as "#if (__RES > 19931104)".  Do not
  70  * compare for equality; rather, use it to determine whether your resolver
  71  * is new enough to contain a certain feature.
  72  */
  73
  74 #define __RES   19960801
  75
  76 /*
  77  * Resolver configuration file.
  78  * Normally not present, but may contain the address of the
  79  * inital name server(s) to query and the domain search list.
  80  */
  81
  82 #ifndef _PATH_RESCONF
  83 #define _PATH_RESCONF        "/etc/resolv.conf"
  84 #endif
  85
  86 /*
  87  * Global defines and variables for resolver stub.
  88  */
  89 #define MAXNS                   3       /* max # name servers we'll track */
  90 #define MAXDFLSRCH              3       /* # default domain levels to try */
  91 #define MAXDNSRCH               6       /* max # domains in search path */
  92 #define LOCALDOMAINPARTS        2       /* min levels in name that is "local" */
  93
  94 #define RES_TIMEOUT             5       /* min. seconds between retries */
  95 #define RES_DFLRETRY            4       /* retries per each name server */
  96 #define MAXRESOLVSORT           10      /* number of net to sort on */
  97 #define RES_MAXNDOTS            15      /* should reflect bit field size */
  98 #define RES_MAXRETRANS          30      /* only for resolv.conf/RES_OPTIONS */
  99 #define RES_MAXRETRY            5       /* only for resolv.conf/RES_OPTIONS */
 100
 101 struct __res_state {
 102         int     retrans;                /* retransmition time interval */
 103         int     retry;                  /* number of times to retransmit */
 104         u_long  options;                /* option flags - see below. */
 105         int     nscount;                /* number of name servers */
 106         struct sockaddr_in
 107                 nsaddr_list[MAXNS];     /* address of name server */
 108 #define nsaddr  nsaddr_list[0]          /* for backward compatibility */
 109         u_short id;                     /* current message id */
 110         char    *dnsrch[MAXDNSRCH+1];   /* components of domain to search */
 111         char    defdname[256];          /* default domain (deprecated) */
 112         u_long  pfcode;                 /* RES_PRF_ flags - see below. */
 113         unsigned ndots:4;               /* threshold for initial abs. query */
 114         unsigned nsort:4;               /* number of elements in sort_list[] */
 115         char    unused[3];
 116         struct {
 117                 struct in_addr  addr;
 118                 u_int32_t       mask;
 119         } sort_list[MAXRESOLVSORT];
 120         char    pad[72];                /* on an i386 this means 512b total */
 121 };
 122
 123 /* for INET6 */
 124 /*
 125  * replacement of __res_state, separated to keep binary compatibility.
 126  */
 127 struct __res_state_ext {
 128         struct sockaddr_storage nsaddr_list[MAXNS];
 129         struct {
 130                 int     af;             /* address family for addr, mask */
 131                 union {
 132                         struct  in_addr ina;
 133                         struct  in6_addr in6a;
 134                 } addr, mask;
 135         } sort_list[MAXRESOLVSORT];
 136 };
 137
 138 /*
 139  * Resolver options (keep these in synch with res_debug.c, please)
 140  */
 141 #define RES_INIT        0x00000001      /* address initialized */
 142 #define RES_DEBUG       0x00000002      /* print debug messages */
 143 #define RES_AAONLY      0x00000004      /* authoritative answers only (!IMPL)*/
 144 #define RES_USEVC       0x00000008      /* use virtual circuit */
 145 #define RES_PRIMARY     0x00000010      /* query primary server only (!IMPL) */
 146 #define RES_IGNTC       0x00000020      /* ignore truncation errors */
 147 #define RES_RECURSE     0x00000040      /* recursion desired */
 148 #define RES_DEFNAMES    0x00000080      /* use default domain name */
 149 #define RES_STAYOPEN    0x00000100      /* Keep TCP socket open */
 150 #define RES_DNSRCH      0x00000200      /* search up local domain tree */
 151 #define RES_INSECURE1   0x00000400      /* type 1 security disabled */
 152 #define RES_INSECURE2   0x00000800      /* type 2 security disabled */
 153 #define RES_NOALIASES   0x00001000      /* shuts off HOSTALIASES feature */
 154 #define RES_USE_INET6   0x00002000      /* use/map IPv6 in gethostbyname() */
 155 #define RES_NOTLDQUERY  0x00004000      /* Don't query TLD names */
 156 /* KAME extensions: use higher bit to avoid conflict with ISC use */
 157 #define RES_USE_EDNS0   0x40000000      /* use EDNS0 */
 158
 159 #define RES_DEFAULT     (RES_RECURSE | RES_DEFNAMES | RES_DNSRCH)
 160
 161 /*
 162  * Resolver "pfcode" values.  Used by dig.
 163  */
 164 #define RES_PRF_STATS   0x00000001
 165 #define RES_PRF_UPDATE  0x00000002
 166 #define RES_PRF_CLASS   0x00000004
 167 #define RES_PRF_CMD     0x00000008
 168 #define RES_PRF_QUES    0x00000010
 169 #define RES_PRF_ANS     0x00000020
 170 #define RES_PRF_AUTH    0x00000040
 171 #define RES_PRF_ADD     0x00000080
 172 #define RES_PRF_HEAD1   0x00000100
 173 #define RES_PRF_HEAD2   0x00000200
 174 #define RES_PRF_TTLID   0x00000400
 175 #define RES_PRF_HEADX   0x00000800
 176 #define RES_PRF_QUERY   0x00001000
 177 #define RES_PRF_REPLY   0x00002000
 178 #define RES_PRF_INIT    0x00004000
 179 /*                      0x00008000      */
 180
 181 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
 182         res_sendhookact;
 183
 184 typedef res_sendhookact (*res_send_qhook)(struct sockaddr * const *ns,
 185                                           const u_char **query,
 186                                           int *querylen,
 187                                           u_char *ans,
 188                                           int anssiz,
 189                                           int *resplen);
 190
 191 typedef res_sendhookact (*res_send_rhook)(const struct sockaddr *ns,
 192                                           const u_char *query,
 193                                           int querylen,
 194                                           u_char *ans,
 195                                           int anssiz,
 196                                           int *resplen);
 197
 198 struct res_sym {
 199         int     number;         /* Identifying number, like T_MX */
 200         char *  name;           /* Its symbolic name, like "MX" */
 201         char *  humanname;      /* Its fun name, like "mail exchanger" */
 202 };
 203
 204 __BEGIN_DECLS
 205 extern struct __res_state *___res(void);
 206 extern struct __res_state_ext *___res_ext(void);
 207 __END_DECLS
 208 #define _res            (*___res())
 209 /* for INET6 */
 210 #define _res_ext        (*___res_ext())
 211
 212 extern const struct res_sym __p_class_syms[];
 213 extern const struct res_sym __p_type_syms[];
 214
 215 /* Private routines shared between libc/net, named, nslookup and others. */
 216 #define res_hnok        __res_hnok
 217 #define res_ownok       __res_ownok
 218 #define res_mailok      __res_mailok
 219 #define res_dnok        __res_dnok
 220 #define sym_ston        __sym_ston
 221 #define sym_ntos        __sym_ntos
 222 #define sym_ntop        __sym_ntop
 223 #define b64_ntop        __b64_ntop
 224 #define b64_pton        __b64_pton
 225 #define loc_ntoa        __loc_ntoa
 226 #define loc_aton        __loc_aton
 227 #define fp_resstat      __fp_resstat
 228 #define p_query         __p_query
 229 #define dn_skipname     __dn_skipname
 230 #define fp_resstat      __fp_resstat
 231 #define fp_query        __fp_query
 232 #define fp_nquery       __fp_nquery
 233 #define hostalias       __hostalias
 234 #define putlong         __putlong
 235 #define putshort        __putshort
 236 #define p_class         __p_class
 237 #define p_time          __p_time
 238 #define p_type          __p_type
 239 #define p_query         __p_query
 240 #define p_cdnname       __p_cdnname
 241 #define p_section       __p_section
 242 #define p_cdname        __p_cdname
 243 #define p_fqnname       __p_fqnname
 244 #define p_fqname        __p_fqname
 245 #define p_option        __p_option
 246 #define p_secstodate    __p_secstodate
 247 #define dn_count_labels __dn_count_labels
 248 #define dn_comp         __dn_comp
 249 #define dn_expand       __dn_expand
 250 #define res_init        __res_init
 251 #define res_randomid    __res_randomid
 252 #define res_query       __res_query
 253 #define res_search      __res_search
 254 #define res_querydomain __res_querydomain
 255 #define res_mkquery     __res_mkquery
 256 #define res_send        __res_send
 257 #define res_isourserver __res_isourserver
 258 #define res_nameinquery __res_nameinquery
 259 #define res_queriesmatch __res_queriesmatch
 260 #define res_close       __res_close
 261 #define res_opt         __res_opt
 262 #define res_mkupdate    __res_mkupdate
 263 #define res_mkupdrec    __res_mkupdrec
 264 #define res_freeupdrec  __res_freeupdrec
 265
 266 __BEGIN_DECLS
 267 int             res_hnok(const char *);
 268 int             res_ownok(const char *);
 269 int             res_mailok(const char *);
 270 int             res_dnok(const char *);
 271 int             sym_ston(const struct res_sym *, const char *, int *);
 272 const char *    sym_ntos(const struct res_sym *, int, int *);
 273 const char *    sym_ntop(const struct res_sym *, int, int *);
 274 int             b64_ntop(u_char const *, size_t, char *, size_t);
 275 int             b64_pton(char const *, u_char *, size_t);
 276 int             loc_aton(const char *, u_char *);
 277 const char *    loc_ntoa(const u_char *, char *);
 278 int             dn_skipname(const u_char *, const u_char *);
 279 void            fp_resstat(struct __res_state *, FILE *);
 280 void            fp_query(const u_char *, FILE *);
 281 void            fp_nquery(const u_char *, int, FILE *);
 282 const char *    hostalias(const char *);
 283 void            putlong(u_int32_t, u_char *);
 284 void            putshort(u_int16_t, u_char *);
 285 const char *    p_class(int);
 286 const char *    p_time(u_int32_t);
 287 const char *    p_type(int);
 288 void            p_query(const u_char *);
 289 const u_char *  p_cdnname(const u_char *, const u_char *, int, FILE *);
 290 const u_char *  p_cdname(const u_char *, const u_char *, FILE *);
 291 const u_char *  p_fqnname(const u_char *, const u_char *,
 292                           int, char *, int);
 293 const u_char *  p_fqname(const u_char *, const u_char *, FILE *);
 294 const char *    p_option(u_long);
 295 char *          p_secstodate(u_long);
 296 int             dn_count_labels(const char *);
 297 int             dn_comp(const char *, u_char *, int, u_char **, u_char **);
 298 int             dn_expand(const u_char *, const u_char *, const u_char *,
 299                           char *, int);
 300 int             res_init(void);
 301 u_int           res_randomid(void);
 302 int             res_query(const char *, int, int, u_char *, int);
 303 int             res_search(const char *, int, int, u_char *, int);
 304 int             res_querydomain(const char *, const char *, int, int,
 305                                 u_char *, int);
 306 int             res_mkquery(int, const char *, int, int, const u_char *,
 307                             int, const u_char *, u_char *, int);
 308 int             res_send(const u_char *, int, u_char *, int);
 309 int             res_isourserver(const struct sockaddr_in *);
 310 int             res_nameinquery(const char *, int, int,
 311                                 const u_char *, const u_char *);
 312 int             res_queriesmatch(const u_char *, const u_char *,
 313                                  const u_char *, const u_char *);
 314 void            res_close(void);
 315 int             res_opt(int, u_char *, int, int);
 316 const char *    p_section(int, int);
 317 /* XXX These must be exported for BIND4 compatibility. */
 318 void            __putlong(u_int32_t, u_char *);
 319 void            __putshort(u_int16_t, u_char *);
 320 u_int32_t       _getlong(const u_char *);
 321 u_int16_t       _getshort(const u_char *);
 322 /* XXX The following depend on the ns_updrec typedef in arpa/nameser.h */
 323 #ifdef _ARPA_NAMESER_H_
 324 int             res_update(ns_updrec *);
 325 int             res_mkupdate(ns_updrec *, u_char *, int);
 326 ns_updrec *     res_mkupdrec(int, const char *, u_int, u_int, u_long);
 327 void            res_freeupdrec(ns_updrec *);
 328 #endif
 329 __END_DECLS
 330
 331 #endif /* !_RESOLV_H_ */