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