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