X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=adns.git;a=blobdiff_plain;f=src%2Fadns.h;h=d265506814de32e444862e611e9fb5070d2e8a9f;hp=f749f6e5c1a843505f60ec0e8a2992b713b8cb8d;hb=916c16caf305556040317cafbc084ba38996bab1;hpb=ddfda8613e6fd8b49d8532a6d34d26df29add034 diff --git a/src/adns.h b/src/adns.h index f749f6e..d265506 100644 --- a/src/adns.h +++ b/src/adns.h @@ -1,8 +1,32 @@ -/**/ +/* + * Copyright (C)1998 Ian Jackson. + * This version provided for review and comment only. + * + * $Id$ + */ +/* + * This file is part of adns, which is Copyright (C) 1997, 1998 Ian Jackson + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2, or (at your option) + * any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + */ #ifndef ADNS_H_INCLUDED #define ADNS_H_INCLUDED +#include + #include #include @@ -29,44 +53,31 @@ typedef enum { adns__rrt_typemask= 0x0ffff, adns__qtf_deref= 0x10000, /* dereference domains and perhaps produce extra data */ adns__qtf_mail822= 0x20000, /* make mailboxes be in RFC822 rcpt field format */ - adns__qtf_masterfmt= 0x80000, /* convert RRs to master file format, return as str */ adns_r_none= 0, adns_r_a= 1, - adns_r_a_mf= adns_r_a|adns__qtf_mf, adns_r_ns_raw= 2, adns_r_ns= adns_r_ns_raw|adns__qtf_deref, - adns_r_ns_mf= adns_r_ns_raw|adns__qtf_mf, adns_r_cname= 5, - adns_r_cname_mf= adns_r_cname|adns__qtf_mf, adns_r_soa_raw= 6, adns_r_soa= adns_r_soa_raw|adns__qtf_mail822, - adns_r_soa_mf= adns_r_soa_raw|adns__qtf_mf, - - adns_r_null= 10, - adns_r_null_mf= adns_r_null|adns__qtf_mf, adns_r_ptr_raw= 12, adns_r_ptr= adns_r_ptr_raw|adns__qtf_deref, - adns_r_ptr_mf= adns_r_ptr_raw|adns__qtf_mf, adns_r_hinfo= 13, - adns_r_hinfo_mf= adns_r_hinfo|adns__qtf_mf, adns_r_mx_raw= 15, adns_r_mx= adns_r_mx_raw|adns__qtf_deref, - adns_r_mx_mf= adns_r_mx_raw|adns__qtf_mf, adns_r_txt= 16, - adns_r_txt_mf= adns_r_txt|adns__qtf_mf, adns_r_rp_raw= 17, - adns_r_rp= adns_r_rp_raw|adns__qtf_mail822 - adns_r_rp_mf= adns_r_rp_raw|adns__qtf_mf, + adns_r_rp= adns_r_rp_raw|adns__qtf_mail822, } adns_rrtype; @@ -80,8 +91,6 @@ typedef enum { * not usually legal in domain names will be quoted as \X * (if the character is 33-126 except \ and ") or \DDD. * - * _qtf_anyquote is ignored for _mf queries. - * * Do not ask for _raw records containing mailboxes without * specifying _qf_anyquote. */ @@ -89,16 +98,26 @@ typedef enum { typedef enum { adns_s_ok, adns_s_timeout, - adns_s_unknownqtype, adns_s_nolocalmem, adns_s_allservfail, + adns_s_servfail, + adns_s_notimplemented, + adns_s_refused, + adns_s_reasonunknown, + adns_s_norecurse, + adns_s_serverfaulty, + adns_s_unknownreply, + adns_s_invaliddata, adns_s_max_tempfail= 99, adns_s_inconsistent, /* PTR gives domain whose A does not match */ adns_s_cname, /* CNAME found where data eg A expected (not if _qf_loosecname) */ - adns_s_max_misconfig= 199; + adns_s_invalidanswerdomain, + /* fixme: implement _s_cname */ + adns_s_max_remotemisconfig= 199, adns_s_nxdomain, - adns_s_norecord, - adns_s_invaliddomain + adns_s_nodata, + adns_s_invalidquerydomain, + adns_s_domaintoolong, } adns_status; typedef struct { @@ -106,36 +125,57 @@ typedef struct { adns_status astatus; int naddrs; /* temp fail => -1, perm fail => 0, s_ok => >0 */ struct in_addr *addrs; -} adns_dmaddr; +} adns_rr_dmaddr; + +typedef struct { + char *a, *b; +} adns_rr_strpair; + +typedef struct { + int i; + adns_rr_dmaddr dmaddr; +} adns_rr_intdmaddr; + +typedef struct { + int i; + char *str; +} adns_rr_intstr; + +typedef struct { + char *ns0, *rp; + unsigned long serial, refresh, retry, expire, minimum; +} adns_rr_soa; typedef struct { adns_status status; char *cname; /* always NULL if query was for CNAME records */ - adns_rrtype type; - int nrrs; + adns_rrtype type; /* guaranteed to be same as in query */ + int nrrs, rrsz; union { - struct in_addr inaddr[1]; /* a */ - char (*str)[1]; /* ns_raw, cname, ptr, ptr_raw, txt, _mf */ - adns_dmaddr dmaddr[1]; /* ns */ - struct { char *a, *b; } strpair[1]; /* hinfo, rp, rp_raw */ - struct { int pref; adns_dmaddrs dmaddr; } intdmaddr[1]; /* mx */ - struct { int pref; char *str; } intstr[1]; /* mx_raw */ - struct { - char *ns0, *rp; - unsigned long serial, refresh, retry, expire, minimum; - } soa[1]; /* soa, soa_raw */ - /* NULL is empty */ + void *untyped; + unsigned char *bytes; + char *(*str); /* ns_raw, cname, ptr, ptr_raw */ + char *(**manystr); /* txt (list is null-terminated) */ + struct in_addr *inaddr; /* a */ + adns_rr_dmaddr *dmaddr; /* ns */ + adns_rr_strpair *strpair; /* hinfo, rp, rp_raw */ + adns_rr_intdmaddr *intdmaddr; /* mx */ + adns_rr_intstr *intstr; /* mx_raw */ + adns_rr_soa *soa; /* soa, soa_raw */ } rrs; } adns_answer; /* Memory management: * adns_state and adns_query are actually pointers to malloc'd state; * On submission questions are copied, including the owner domain; - * Answers are malloc'd as a single piece of memory. + * Answers are malloc'd as a single piece of memory; pointers in the + * answer struct point into further memory in the answer. * query_io: * Must always be non-null pointer; * If *query_io is 0 to start with then any query may be returned; * If *query_io is !0 adns_query then only that query may be returned. + * If the call is successful, *query_io, *answer_r, and *context_r + * will all be set. * Errors: * Return values are 0 or an errno value; * Seriously fatal system errors (eg, failure to create sockets, @@ -146,8 +186,6 @@ typedef struct { * type will always be the type requested; * If no (appropriate) requests are done adns_check returns EWOULDBLOCK; * If no (appropriate) requests are outstanding adns_query and adns_wait return ESRCH; - * If malloc failure occurs during internal allocation or processing - * ands_check and _wait set *answer to 0. */ int adns_init(adns_state *newstate_r, adns_initflags flags, FILE *diagfile/*0=>stderr*/); @@ -182,9 +220,12 @@ int adns_wait(adns_state ads, void **context_r); /* Might return EINTR - if so, try again */ -void adns_cancel(adns_state ads, adns_query query); +void adns_cancel(adns_query query); int adns_finish(adns_state); +/* You may call this even if you have queries outstanding; + * they will be cancelled. + */ int adns_callback(adns_state, int maxfd, const fd_set *readfds, const fd_set *writefds, const fd_set *exceptfds); @@ -195,6 +236,8 @@ int adns_callback(adns_state, int maxfd, const fd_set *readfds, const fd_set *wr * Other fd's may be in the fd_sets, and will be ignored. * _callback returns how many adns fd's were in the various sets, so * you can tell if your select handling code has missed something and is going awol. + * + * May also return -1 if a critical syscall failed, setting errno. */ void adns_interest(adns_state, int *maxfd_io, fd_set *readfds_io, @@ -231,4 +274,34 @@ void adns_interest(adns_state, int *maxfd_io, fd_set *readfds_io, * } */ +adns_status adns_rr_info(adns_rrtype type, + const char **rrtname_r, const char **fmtname_r, + int *len_r, + const void *datap, char **data_r); +/* Gets information in human-readable (but non-i18n) form + * for eg debugging purposes. type must be specified, + * and the official name of the corresponding RR type will + * be returned in *rrtname_r, and information about the processing + * style in *fmtname_r. The length of the table entry in an answer + * for that type will be returned in in *len_r. + * Any or all of rrtname_r, fmtname_r and len_r may be 0. + * If fmtname_r is non-null then *fmtname_r may be + * null on return, indicating that no special processing is + * involved. + * + * data_r be must be non-null iff datap is. In this case + * *data_r will be set to point to a human-readable text + * string representing the RR data. The text will have + * been obtained from malloc() and must be freed by the caller. + * + * Usually this routine will succeed. Possible errors include: + * adns_s_nomemory + * adns_s_notimplemented (RR type not known) + * adns_s_invaliddata (*datap contained garbage) + * If an error occurs then no memory has been allocated, + * and *rrtname_r, *fmtname_r, *len_r and *data_r are undefined. + */ + +const char *adns_strerror(adns_status st); + #endif