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