licence waiver section improved
[adns] / README
CommitLineData
95ecb688 1
d6e3e09b 2 GNU adns
9b21b383 3
1a0a5dbd 4 Advanced, easy to use, asynchronous-capable DNS client library and
5 utilities.
9b21b383 6
8e5a4960 7 adns is a resolver library for C (and C++) programs, and a collection
b6922f88 8 of useful DNS resolver utilities.
9b21b383 9
b6922f88 10C library
11
12 In contrast with the standard interfaces, gethostbyname et al and
13 libresolv, it has the following features:
95ecb688 14 * It is reasonably easy to use for simple programs which just want
15 to translate names to addresses, look up MX records, etc.
16 * It can be used in an asynchronous, non-blocking, manner. Many
17 queries can be handled simultaneously.
18 * Responses are decoded automatically into a natural representation
19 for a C program - there is no need to deal with DNS packet
20 formats.
21 * Sanity checking (eg, name syntax checking, reverse/forward
22 correspondence, CNAME pointing to CNAME) is performed
23 automatically.
24 * Time-to-live, CNAME and other similar information is returned in
df1d1f3a 25 an easy-to-use form, without getting in the way.
95ecb688 26 * There is no global state in the library; resolver state is an
27 opaque data structure which the client creates explicitly. A
28 program can have several instances of the resolver.
29 * Errors are reported to the application in a way that distinguishes
30 the various causes of failure properly.
31 * Understands conventional resolv.conf, but this can overridden by
32 environment variables.
33 * Flexibility. For example, the application can tell adns to: ignore
8e5a4960 34 environment variables (for setuid programs), disable hostname
35 syntax sanity checks to return arbitrary data, override or ignore
36 resolv.conf in favour of supplied configuration, etc.
95ecb688 37 * Believed to be correct ! For example, will correctly back off to
38 TCP in case of long replies or queries, or to other nameservers if
39 several are available. It has sensible handling of bad responses
40 etc.
9b21b383 41
8e5a4960 42DNS utility programs
43
1a0a5dbd 44 adns also comes with a number of utility programs for use from the
45 command line and in scripts:
46 * adnslogres is a much faster version of Apache's logresolv program.
47 * adnsresfilter is a filter which copies its input to its output,
48 replacing IP addresses by the corresponding names, without unduly
49 delaying the output. For example, you can usefully pipe the output
50 of netstat -n, tcpdump -ln, and the like, into it.
51 * adnshost is a general-purpose DNS lookup utility which can be used
8e5a4960 52 easily in from the command line and from shell scripts to do
53 simple lookups. In a more advanced mode it can be used as a
54 general-purpose DNS helper program for scripting languages which
6c55e47e 55 can invoke and communicate with subprocesses. See the [1]adnshost
56 usage message for a summary of its capabilities.
9b21b383 57
3a68c787 58Forthcoming:
59
60 I hope that future versions may also have the following features:
61 * The library should be useable by threads in a multithreaded
62 program in a natural way. It should multiplex many threads'
63 queries through a single query socket.
64 * IPv6 support.
65 * Some kind of awareness of DNSSEC.
66 * Possibly some very limited caching behaviour.
67 * There was, at one point, a draft native Perl interface from Tony
68 Finch.
69
0db99d9c 70Documentation
71
72 I'm afraid there is no manual yet. However, competent C programmers
6c55e47e 73 should be able to use the library based on the [2]commented adns.h
8e5a4960 74 header file, and the usage messages for the programs should be
75 sufficient.
9b21b383 76
df1d1f3a 77Feedback
78
bd3fce65 79 I'd be pleased if you would let me know if you're using my library in
80 your project, and what you think of it.
9b21b383 81
bd3fce65 82 If you are subscribed to adns-discuss please send feedback, including
83 bug reports, there; otherwise send mail to
84 adns-bugreports@chiark.greenend.org.uk. If you'd prefer that your
85 message wasn't forwarded to the adns-bugreports list, send it to
8e5a4960 86 adns-maint@chiark.greenend.org.uk.
9b21b383 87
df1d1f3a 88Mailinglists
89
90 I have set up mailinglists adns-announce and adns-discuss. The
91 announcements list is moderated and will contain only announcements of
6c55e47e 92 important bugs, new versions, etc. The bug reports address mentioned
df1d1f3a 93 above is also a mailing list; feel free to subscribe to it.
9b21b383 94
6c55e47e 95 There are [3]archives and subscription web pages, or you can subscribe
df1d1f3a 96 by sending mail containing the word `subscribe' to
97 adns-announce-REQUEST@chiark.greenend.org.uk or
98 adns-discuss-REQUEST@chiark.greenend.org.uk.
9b21b383 99
df1d1f3a 100Download
101
6c55e47e 102 Available for download from [4]chiark.greenend.org.uk are:
103 * The [5]current release as a gzipped tarfile.
104 * [6]adns.h API header file with comments, and [7]usage message for
b6922f88 105 adnshost (currently there is no manual, sorry).
6c55e47e 106 * All versions released so far are also available via [8]anonymous
3a68c787 107 FTP and [9]HTTP.
108
109 You can also access the project CVS repositories:
110 * A mirror of the source code repository is available via rsync from
d6e3e09b 111 rsync.chiark.greenend.org.uk::ftp/users/ian/cvs-pub/adns (use FTP
6c55e47e 112 first to find your way around), or via [10]cvsweb.
3a68c787 113 * This web page is maintained in [11]Savannah, where you can browse
114 the [12]webpage CVS.
9b21b383 115
3a68c787 116 adns is also available from the [13]GNU Project FTP servers and their
117 [14]mirrors.
9b21b383 118
6c55e47e 119Technical note
120
3a68c787 121 adns requires a real nameserver like [15]BIND or [16]Dents running on
6c55e47e 122 the same system or a nearby one, which must be willing to provide
123 `recursive service'. I.e., adns is a `stub resolver'. All properly
124 configured UN*X and GNU systems will already have such nameserver(s);
125 they are usually listed in /etc/resolv.conf.
9b21b383 126
127References and related projects
128
217cfd38 129 * [17]Haskell bindings by Peter Simons. * [18]port to MS Visual Studio
130 6 C++ by Jarle Aase.
9b21b383 131
df1d1f3a 132Copyright and licensing
133
849075a0 134 adns is Copyright 1997-2005 Ian Jackson, Copyright 1999-2004 Tony
b6922f88 135 Finch, and Copyright (C) 1991 Massachusetts Institute of Technology.
9b21b383 136
df1d1f3a 137 adns is free software; you can redistribute it and/or modify it under
138 the terms of the GNU General Public License as published by the Free
139 Software Foundation; either version 2 of the License, or (at your
140 option) any later version.
9b21b383 141
df1d1f3a 142 This program and documentation is distributed in the hope that it will
143 be useful, but without any warranty; without even the implied warranty
0db99d9c 144 of merchantability or fitness for a particular purpose. See the
217cfd38 145 [19]GNU General Public License for more details.
9b21b383 146
df1d1f3a 147 You should have received a copy of the GNU General Public License
148 along with adns, or one should be available above; if not, write to
217cfd38 149 the [20]Free Software Foundation, 59 Temple Place - Suite 330, Boston,
df1d1f3a 150 MA 02111-1307, USA, or email adns-maint@chiark.greenend.org.uk.
151 _________________________________________________________________
9b21b383 152
217cfd38 153 [21]Ian Jackson / [22]adns-maint@chiark.greenend.org.uk; more [23]free
df1d1f3a 154 software by me.
9b21b383 155
217cfd38 156 [24]GNU home page; [25]chiark home page; [26]site or mirror home page
9b21b383 157
849075a0 158 This web page is Copyright (C)1996-2005 Ian Jackson. See the
217cfd38 159 [27]Copyright/acknowledgements.
9b21b383 160
217cfd38 161 Use any browser - [28]Campaign for a non-browser-specific WWW
df1d1f3a 162
163References
164
6c55e47e 165 1. http://www.chiark.greenend.org.uk/~ian/adns/adnshost.txt
166 2. http://www.chiark.greenend.org.uk/~ian/adns/adns.h.txt
167 3. http://www.chiark.greenend.org.uk/mailman/listinfo
168 4. http://www.chiark.greenend.org.uk/~ian/adns/
169 5. http://www.chiark.greenend.org.uk/~ian/adns/adns.tar.gz
170 6. http://www.chiark.greenend.org.uk/~ian/adns/adns.h.txt
aa3ffb57 171 7. http://www.chiark.greenend.org.uk/~ian/adns/adnshost.txt
6c55e47e 172 8. ftp://ftp.chiark.greenend.org.uk/users/ian/adns/
d0ac9ea0 173 9. http://www.chiark.greenend.org.uk/~ian/adns/ftp/
6c55e47e 174 10. http://www.chiark.greenend.org.uk/ucgi/~ijackson/cvsweb/adns/
3a68c787 175 11. http://savannah.gnu.org/
176 12. http://savannah.gnu.org/cgi-bin/viewcvs/software/adns/?cvsroot=www.gnu.org
177 13. http://www.gnu.org/
178 14. http://www.gnu.org/order/ftp.html
179 15. http://www.isc.org/view.cgi?/products/BIND/index.phtml
180 16. http://www.dents.org/
217cfd38 181 17. http://cryp.to/hsdns/
182 18. http://adns.jgaa.com/
183 19. http://www.chiark.greenend.org.uk/~ian/COPYING.txt
184 20. http://www.fsf.org/
185 21. http://www.chiark.greenend.org.uk/
186 22. mailto:adns-maint@chiark.greenend.org.uk
187 23. http://www.chiark.greenend.org.uk/~ian/software/
188 24. http://www.gnu.org/
189 25. http://www.chiark.greenend.org.uk/
190 26. file://localhost/
191 27. http://www.chiark.greenend.org.uk/~ian/sw-www-copy.html
192 28. http://www.anybrowser.org/campaign/