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