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