bsd/include/resolv.h.kame

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