- Check for NULL tree->delete callback
[tinc] / README
1 This is the README file for tinc version 1.0pre3. Installation
2 instructions may be found in the INSTALL file.
3
4 tinc is Copyright (C) 1998,1999,2000 Ivo Timmermans
5 <itimmermans@bigfoot.com>, Guus Sliepen <guus@sliepen.warande.net> and
6 others. For a complete list of authors see the AUTHORS file.
7
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or (at
11 your option) any later version. See the file COPYING for more details.
12
13
14 Security statement
15 ------------------
16
17 In august 2000, we discovered the existence of a security hole in all
18 versions of tinc up to and including 1.0pre2. This had to do with the
19 way we exchanged keys. Since then, we have been working on a new
20 authentication scheme to make tinc as secure as possible. The current
21 version uses the OpenSSL library and does authentication in much the
22 same way as the SSH protocol does.
23
24 Cryptography is a hard thing to get right. We cannot make any
25 guarantees. Time, review and feedback are the only things that can
26 prove the security of any cryptographic product. If you wish to review
27 tinc or give us feedback, you are stronly encouraged to do so.
28
29
30 Requirements
31 ------------
32
33 Since 1.0pre3, we use OpenSSL for all cryptographic functions.  So you
34 need to install this library first; grab it from
35 http://www.openssl.org/.  We recommend version 0.9.5 or better.  If
36 this library is not installed on you system, configure will fail.  The
37 manual in doc/tinc.texi contains more detailed information on how to
38 install this library.
39
40
41 Features
42 --------
43
44 This version of tinc supports multiple virtual networks at once. To
45 use this feature, you may supply a netname via the -n or --net
46 options. The standard locations for the config files will then be
47 /etc/tinc/<net>/. Because of this feature, tinc will send packets
48 directly to their destinations, instead of to the uplink. If this
49 behaviour is undesirable (for instance because of firewalls or other
50 restrictions), please use an older version of tinc (I would recommend
51 tinc-0.2.19).
52
53 In order to force the kernel to accept received packets, the
54 destination MAC address will be set to FE:FD:00:00:00:00 upon
55 reception. The MAC address of the ethertap or tun/tap interface must
56 also be set to this address. See the manual for more detailed
57 information.
58
59 tincd regenerates its encryption key pairs. It does this on the first
60 activity after the keys have expired. This period is adjustable in the
61 configuration file, and the default time is 3600 seconds (one hour).
62
63 This version supports multiple subnets at once. They are also sorted
64 on subnet mask size. This means that it is possible to have
65 overlapping subnets on the VPN, as long as their subnet mask sizes
66 differ.