src/adns.h

   1 /*
   2  * Copyright (C)1998 Ian Jackson.
   3  * This version provided for review and comment only.
   4  *
   5  * $Id$
   6  */
   7 /*
   8  *  This file is part of adns, which is Copyright (C) 1997, 1998 Ian Jackson
   9  *
  10  *  This program is free software; you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License as published by
  12  *  the Free Software Foundation; either version 2, or (at your option)
  13  *  any later version.
  14  *
  15  *  This program is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *  GNU General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License
  21  *  along with this program; if not, write to the Free Software Foundation,
  22  *  Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  */
  24
  25 #ifndef ADNS_H_INCLUDED
  26 #define ADNS_H_INCLUDED
  27
  28 #include <stdio.h>
  29
  30 #include <sys/socket.h>
  31 #include <netinet/in.h>
  32
  33 typedef struct adns__state *adns_state;
  34 typedef struct adns__query *adns_query;
  35
  36 typedef enum {
  37   adns_if_noenv=        0x0001, /* do not look at environment */
  38   adns_if_noerrprint=   0x0002, /* never print output to stderr (_debug overrides) */
  39   adns_if_noserverwarn= 0x0004, /* do not warn to stderr about duff nameservers etc */
  40   adns_if_debug=        0x0008, /* enable all output to stderr plus debug msgs */
  41   adns_if_noautosys=    0x0010, /* do not make syscalls at every opportunity */
  42 } adns_initflags;
  43
  44 typedef enum {
  45   adns_qf_search=     0x0001, /* use the searchlist */
  46   adns_qf_usevc=      0x0002, /* use a virtual circuit (TCP connection) */
  47   adns_qf_anyquote=   0x0004,
  48   adns_qf_loosecname= 0x0008, /* allow refs to CNAMEs - without, get _s_cname */
  49   adns_qf_nocname=    0x0010, /* don't follow CNAMEs, instead give _s_cname */
  50 } adns_queryflags;
  51
  52 typedef enum {
  53   adns__rrt_typemask=  0x0ffff,
  54   adns__qtf_deref=     0x10000, /* dereference domains and perhaps produce extra data */
  55   adns__qtf_mail822=   0x20000, /* make mailboxes be in RFC822 rcpt field format */
  56
  57   adns_r_none=               0,
  58
  59   adns_r_a=                  1,
  60
  61   adns_r_ns_raw=             2,
  62   adns_r_ns=                    adns_r_ns_raw|adns__qtf_deref,
  63
  64   adns_r_cname=              5,
  65
  66   adns_r_soa_raw=            6,
  67   adns_r_soa=                   adns_r_soa_raw|adns__qtf_mail822,
  68
  69   adns_r_ptr_raw=           12,
  70   adns_r_ptr=                   adns_r_ptr_raw|adns__qtf_deref,
  71
  72   adns_r_hinfo=             13,
  73
  74   adns_r_mx_raw=            15,
  75   adns_r_mx=                    adns_r_mx_raw|adns__qtf_deref,
  76
  77   adns_r_txt=               16,
  78
  79   adns_r_rp_raw=            17,
  80   adns_r_rp=                    adns_r_rp_raw|adns__qtf_mail822,
  81
  82 } adns_rrtype;
  83
  84 /* In queries without qtf_anyquote, all domains must have standard
  85  * legal syntax.  In queries _with_ qtf_anyquote, domains in the query
  86  * or response may contain any characters, quoted according to
  87  * RFC1035 5.1.  On input to adns, the char* is a pointer to the
  88  * interior of a " delimited string, except that " may appear in it,
  89  * and on output, the char* is a pointer to a string which would be
  90  * legal either inside or outside " delimiters, and any characters
  91  * not usually legal in domain names will be quoted as \X
  92  * (if the character is 33-126 except \ and ") or \DDD.
  93  *
  94  * Do not ask for _raw records containing mailboxes without
  95  * specifying _qf_anyquote.
  96  */
  97
  98 typedef enum {
  99   /* fixme: think about error codes */
 100   adns_s_ok,
 101   adns_s_timeout,
 102   adns_s_nolocalmem,
 103   adns_s_allservfail,
 104   adns_s_servfail,
 105   adns_s_notimplemented,
 106   adns_s_refused,
 107   adns_s_reasonunknown,
 108   adns_s_norecurse,
 109   adns_s_serverfaulty,
 110   adns_s_unknownreply,
 111   adns_s_invaliddata,
 112   adns_s_max_tempfail= 99,
 113   adns_s_inconsistent, /* PTR gives domain whose A does not match */
 114   adns_s_cname, /* CNAME found where data eg A expected (not if _qf_loosecname) */
 115   adns_s_invalidanswerdomain,
 116   /* fixme: implement _s_cname */
 117   adns_s_max_remotemisconfig= 199,
 118   adns_s_nxdomain,
 119   adns_s_nodata,
 120   adns_s_invalidquerydomain,
 121   adns_s_domaintoolong,
 122 } adns_status;
 123
 124 typedef struct {
 125   char *dm;
 126   adns_status astatus;
 127   int naddrs; /* temp fail => -1, perm fail => 0, s_ok => >0 */
 128   struct in_addr *addrs;
 129 } adns_rr_dmaddr;
 130
 131 typedef struct {
 132   char *a, *b;
 133 } adns_rr_strpair;
 134
 135 typedef struct {
 136   int i;
 137   adns_rr_dmaddr dmaddr;
 138 } adns_rr_intdmaddr;
 139
 140 typedef struct {
 141   /* Used both for mx_raw, in which case i is the preference and str the domain,
 142    * and for txt, in which case each entry has i for the `text' length,
 143    * and str for the data (which will have had an extra nul appended
 144    * so that if it was plain text it is now a null-terminated string).
 145    */
 146   int i;
 147   char *str;
 148 } adns_rr_intstr;
 149
 150 typedef struct {
 151   char *ns0, *rp;
 152   unsigned long serial, refresh, retry, expire, minimum;
 153 } adns_rr_soa;
 154
 155 typedef struct {
 156   adns_status status;
 157   char *cname; /* always NULL if query was for CNAME records */
 158   adns_rrtype type; /* guaranteed to be same as in query */
 159   int nrrs, rrsz;
 160   union {
 161     void *untyped;
 162     unsigned char *bytes;
 163     char *(*str);                  /* ns_raw, cname, ptr, ptr_raw */
 164     adns_rr_intstr *(*manyistr);   /* txt (list of strings ends with i=-1, str=0) */
 165     struct in_addr *inaddr;        /* a */
 166     adns_rr_dmaddr *dmaddr;        /* ns */
 167     adns_rr_strpair *strpair;      /* hinfo ??fixme, rp, rp_raw */
 168     adns_rr_intdmaddr *intdmaddr;  /* mx */
 169     adns_rr_intstr *intstr;        /* mx_raw */
 170     adns_rr_soa *soa;              /* soa, soa_raw */
 171   } rrs;
 172 } adns_answer;
 173
 174 /* Memory management:
 175  *  adns_state and adns_query are actually pointers to malloc'd state;
 176  *  On submission questions are copied, including the owner domain;
 177  *  Answers are malloc'd as a single piece of memory; pointers in the
 178  *  answer struct point into further memory in the answer.
 179  * query_io:
 180  *  Must always be non-null pointer;
 181  *  If *query_io is 0 to start with then any query may be returned;
 182  *  If *query_io is !0 adns_query then only that query may be returned.
 183  *  If the call is successful, *query_io, *answer_r, and *context_r
 184  *  will all be set.
 185  * Errors:
 186  *  Return values are 0 or an errno value;
 187  *  Seriously fatal system errors (eg, failure to create sockets,
 188  *  malloc failure, etc.) return errno values;
 189  *  Other errors (nameserver failure, timed out connections, &c)
 190  *  are returned in the status field of the answer.  If status is
 191  *  nonzero then nrrs will be 0, otherwise it will be >0.
 192  *  type will always be the type requested;
 193  *  If no (appropriate) requests are done adns_check returns EWOULDBLOCK;
 194  *  If no (appropriate) requests are outstanding adns_query and adns_wait return ESRCH;
 195  */
 196
 197 int adns_init(adns_state *newstate_r, adns_initflags flags, FILE *diagfile/*0=>stderr*/);
 198
 199 int adns_synchronous(adns_state ads,
 200                      const char *owner,
 201                      adns_rrtype type,
 202                      adns_queryflags flags,
 203                      adns_answer **answer_r);
 204 /* Will not return EINTR. */
 205
 206 /* NB: if you set adns_if_noautosys then _submit and _check do not
 207  * make any system calls; you must use adns_callback (possibly after
 208  * adns_interest) to actually get things to happen.
 209  */
 210
 211 int adns_submit(adns_state ads,
 212                 const char *owner,
 213                 adns_rrtype type,
 214                 adns_queryflags flags,
 215                 void *context,
 216                 adns_query *query_r);
 217
 218 int adns_check(adns_state ads,
 219                adns_query *query_io,
 220                adns_answer **answer_r,
 221                void **context_r);
 222
 223 int adns_wait(adns_state ads,
 224               adns_query *query_io,
 225               adns_answer **answer_r,
 226               void **context_r);
 227 /* Might return EINTR - if so, try again */
 228
 229 void adns_cancel(adns_query query);
 230
 231 int adns_finish(adns_state);
 232 /* You may call this even if you have queries outstanding;
 233  * they will be cancelled.
 234  */
 235
 236 int adns_callback(adns_state, int maxfd, const fd_set *readfds, const fd_set *writefds,
 237                   const fd_set *exceptfds);
 238 /* Gives adns flow-of-control for a bit.  This will never block.
 239  * If maxfd == -1 then adns will check (make nonblocking system calls on)
 240  * all of its own filedescriptors; otherwise it will only use those
 241  * < maxfd and specified in the fd_set's, as if select had returned them.
 242  * Other fd's may be in the fd_sets, and will be ignored.
 243  * _callback returns how many adns fd's were in the various sets, so
 244  * you can tell if your select handling code has missed something and is going awol.
 245  *
 246  * May also return -1 if a critical syscall failed, setting errno.
 247  */
 248
 249 void adns_interest(adns_state, int *maxfd_io, fd_set *readfds_io,
 250                    fd_set *writefds_io, fd_set *exceptfds_io,
 251                    struct timeval **tv_mod, struct timeval *tv_buf);
 252 /* Find out file descriptors adns is interested in, and when it
 253  * would like the opportunity to time something out.  If you do not plan to
 254  * block then tv_mod may be 0.  Otherwise, tv_mod may point to 0 meaning
 255  * you have no timeout of your own, in which case tv_buf must be non-null and
 256  * _interest may fill it in and set *tv_mod=tv_buf.
 257  * readfds, writefds, exceptfds and maxfd may not be 0.
 258  */
 259
 260 /* Example expected/legal calling sequences:
 261  *  adns_init
 262  *  adns_submit 1
 263  *  adns_submit 2
 264  *  adns_submit 3
 265  *  adns_wait 1
 266  *  adns_check 3 -> EWOULDBLOCK
 267  *  adns_wait 2
 268  *  adns_wait 3
 269  *  ....
 270  *  adns_finish
 271  *
 272  *  adns_init _noautosys
 273  *  loop {
 274  *   adns_interest
 275  *   select
 276  *   adns_callback
 277  *   ...
 278  *   adns_submit / adns_check
 279  *   ...
 280  *  }
 281  */
 282
 283 adns_status adns_rr_info(adns_rrtype type,
 284                          const char **rrtname_r, const char **fmtname_r,
 285                          int *len_r,
 286                          const void *datap, char **data_r);
 287 /* Gets information in human-readable (but non-i18n) form
 288  * for eg debugging purposes.  type must be specified,
 289  * and the official name of the corresponding RR type will
 290  * be returned in *rrtname_r, and information about the processing
 291  * style in *fmtname_r.  The length of the table entry in an answer
 292  * for that type will be returned in in *len_r.
 293  * Any or all of rrtname_r, fmtname_r and len_r may be 0.
 294  * If fmtname_r is non-null then *fmtname_r may be
 295  * null on return, indicating that no special processing is
 296  * involved.
 297  *
 298  * data_r be must be non-null iff datap is.  In this case
 299  * *data_r will be set to point to a human-readable text
 300  * string representing the RR data.  The text will have
 301  * been obtained from malloc() and must be freed by the caller.
 302  *
 303  * Usually this routine will succeed.  Possible errors include:
 304  *  adns_s_nomemory
 305  *  adns_s_notimplemented (RR type not known)
 306  *  adns_s_invaliddata (*datap contained garbage)
 307  * If an error occurs then no memory has been allocated,
 308  * and *rrtname_r, *fmtname_r, *len_r and *data_r are undefined.
 309  */
 310
 311 const char *adns_strerror(adns_status st);
 312
 313 #endif