Update copyright dates and documentation.
[adns] / INSTALL
... / ...
CommitLineData
1INSTALLATION INSTRUCTIONS for GNU ADNS
2
31. Read the security note below.
4
52. Standard GNU package build process:
6 $ ./configure [--disable-dynamic] [--prefix=... ...]
7 $ make
8 # make install
9
10Unfortunately, there is no comprehensive documentation yet. For now,
11use the comments in the public header file adns.h, and for the C
12programs their usage messages. If you find this information
13ambiguous, incomplete or wrong, please report it as a bug.
14
15
16TESTED PLATFORMS
17
18The following platforms have been tested at at least some point and
19should work - please report if they don't:
20 [adns] OS
21 1.0 Linux glibc 2.1 (actually tested on Debian 2.2)
22 1.0 Solaris 2.6, 2.7, 2.8 [3]
23 1.0 FreeBSD 3.2, 4.0 (no poll(2), so no adnsresfilter)
24The following work, but only with --disable-dynamic:
25 1.0 IRIX 6.5 *not* with GCC [1], [2]
26 1.0 AIX 4.1.5
27 1.0 HP-UX 10.20, 11.00
28Later versions of the same OS should work too. [adns] is the latest
29version of adns that has been tested. Usually entries in this table
30mean they pass adns's own regression test, when compiled with GCC,
31and appear to install and run correctly.
32
33Notes/known problems:
34 [1] IRIX 6.5 inet_ntoa seems to break with GCC.
35 [2] The SGI IRIX compiler produces many spurious warnings.
36 [3] Dynamically linked, needs some help to find libadns.so.0.1.
37
38The following platforms are known to be deficient and will not work:
39 Solaris 2.5 Lacks vsnprintf - install glibc ?
40 TruUnix64 (DEC UNIX 4.0f) Lacks vsnprintf - install glibc ?
41Please don't report these problems unless you have a nice,
42straightforward solution or workaround for them. (I don't consider
43including a `vsnprintf' implementation nice, so don't send me one.)
44
45
46PORTABILITY INFORMATION
47
48You will find that adns requires a reasonably standard and up to date
49system. Non-GNU, non-UNIX systems are not supported.
50
51The build system assumes by default that you have ELF shared
52libraries, and that the directory in which libadns.so.1 will be
53installed is on your dynamic library search path. If your system
54doesn't have ELF shared libraries then dynamic linking is not
55supported by adns. Use the --disable-shared configure option.
56Please don't send me patches to use libtool (which I dislike).
57
58The adnsresfilter utility uses `tsearch' from the C library (a la SVID
59and X/Open). If you don't have tsearch configure will arranges for
60adnsresfilter not to be built. To fix this, install a C library
61containing tsearch, such as the GNU C library. It is best if tsearch
62uses an automatically-balancing tree algorithm, like the glibc version
63does. Simple binary trees may perform badly.
64
65You will probably find that GNU Make is required.
66Please do not report this as a bug; install GNU Make instead.
67
68
69SECURITY AND PERFORMANCE - AN IMPORTANT NOTE
70
71adns is not a full-service resolver. It does no caching of responses
72at all, and has no defence against bad nameservers or fake packets
73which appear to come from your real nameservers. It relies on the
74full-service resolvers listed in resolv.conf to handle these tasks.
75
76For secure and reasonable operation you MUST run a full-service
77nameserver on the same system as your adns applications, or on the
78same local, fully trusted network. You MUST only list such
79nameservers in the adns configuration (eg resolv.conf).
80
81You MUST use a firewall or other means to block packets which appear
82to come from these nameservers, but which were actually sent by other,
83untrusted, entities.
84
85Furthermore, adns is not DNSSEC-aware in this version; it doesn't
86understand even how to ask a DNSSEC-aware nameserver to perform the
87DNSSEC cryptographic signature checking.
88
89
90COPYRIGHT
91
92This file, INSTALL, contains installation instructions and other
93details for adns. It is
94 Copyright (C) 1997-2000 Ian Jackson <ian@davenant.greenend.org.uk>
95
96adns is
97 Copyright (C) 1997-2000 Ian Jackson <ian@davenant.greenend.org.uk>
98 Copyright (C) 1999-2000 Tony Finch <dot@dotat.at> [1]
99 Copyright (C) 1991 Massachusetts Institute of Technology [2]
100
101adns is free software; you can redistribute it and/or modify it under
102the terms of the GNU General Public License as published by the Free
103Software Foundation; either version 2 of the License, or (at your
104option) any later version.
105
106This program is distributed in the hope that it will be useful, but
107WITHOUT ANY WARRANTY; without even the implied warranty of
108MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
109General Public License for more details.
110
111You should have received a copy of the GNU General Public License
112along with adns as the file COPYING; if not, email me at the address
113above or write to the Free Software Foundation, 59 Temple Place -
114Suite 330, Boston, MA 02111-1307, USA.
115
116[1] Tony Finch holds the original copyright on client/adnslogres.c and
117 client/fanftest.c, and some modifications to those files.
118[2] MIT hold the original copyright on the included install-sh,
119 which came via GNU autoconf.
120
121# Local variables:
122# mode: text
123# End: