Force nul-termination of strings after vsnprintf().
[oweals/tinc.git] / README
1 This is the README file for tinc version 1.0.28. Installation
2 instructions may be found in the INSTALL file.
3
4 tinc is Copyright (C) 1998-2016 by:
5
6 Ivo Timmermans,
7 Guus Sliepen <guus@tinc-vpn.org>,
8 and others.
9
10 For a complete list of authors see the AUTHORS file.
11
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 2 of the License, or (at
15 your option) any later version. See the file COPYING for more details.
16
17
18 Security statement
19 ------------------
20
21 In August 2000, we discovered the existence of a security hole in all versions
22 of tinc up to and including 1.0pre2. This had to do with the way we exchanged
23 keys. Since then, we have been working on a new authentication scheme to make
24 tinc as secure as possible. The current version uses the OpenSSL library and
25 uses strong authentication with RSA keys.
26
27 On the 29th of December 2001, Jerome Etienne posted a security analysis of tinc
28 1.0pre4. Due to a lack of sequence numbers and a message authentication code
29 for each packet, an attacker could possibly disrupt certain network services or
30 launch a denial of service attack by replaying intercepted packets. The current
31 version adds sequence numbers and message authentication codes to prevent such
32 attacks.
33
34 On September the 15th of 2003, Peter Gutmann contacted us and showed us a
35 writeup describing various security issues in several VPN daemons. He showed
36 that tinc lacks perfect forward security, the connection authentication could
37 be done more properly, that the sequence number we use as an IV is not the best
38 practice and that the default length of the HMAC for packets is too short in
39 his opinion. We do not know of a way to exploit these weaknesses, but these
40 issues are being addressed in the tinc 1.1 branch.
41
42 Cryptography is a hard thing to get right. We cannot make any
43 guarantees. Time, review and feedback are the only things that can
44 prove the security of any cryptographic product. If you wish to review
45 tinc or give us feedback, you are strongly encouraged to do so.
46
47
48 Changes to configuration file format since 1.0pre5
49 --------------------------------------------------
50
51 Some configuration variables have different names now. Most notably "TapDevice"
52 should be changed into "Device", and "Device" should be changed into
53 "BindToDevice".
54
55 Compatibility
56 -------------
57
58 Version 1.0.28 is compatible with 1.0pre8, 1.0 and later, but not with older
59 versions of tinc.
60
61
62 Requirements
63 ------------
64
65 Since 1.0pre3, we use OpenSSL for all cryptographic functions.  So you
66 need to install this library first; grab it from
67 http://www.openssl.org/.  You will need version 0.9.7 or later.  If
68 this library is not installed on you system, configure will fail.  The
69 manual in doc/tinc.texi contains more detailed information on how to
70 install this library.
71
72 Since 1.0pre6, the zlib library is used for optional compression. You can
73 find it at http://www.gzip.org/zlib/. Because of a possible exploit in
74 earlier versions we recommend that you download version 1.1.4 or later.
75
76 Since 1.0, the lzo library is also used for optional compression. You can
77 find it at http://www.oberhumer.com/opensource/lzo/.
78
79 In order to compile tinc, you will need a GNU C compiler environment.
80
81
82 Features
83 --------
84
85 This version of tinc supports multiple virtual networks at once. To
86 use this feature, you may supply a netname via the -n or --net
87 options. The standard locations for the config files will then be
88 /etc/tinc/<net>/.
89
90 tincd regenerates its encryption key pairs. It does this on the first
91 activity after the keys have expired. This period is adjustable in the
92 configuration file, and the default time is 3600 seconds (one hour).
93
94 This version supports multiple subnets at once. They are also sorted
95 on subnet mask size. This means that it is possible to have
96 overlapping subnets on the VPN, as long as their subnet mask sizes
97 differ.
98
99 Since pre5, tinc can operate in several routing modes. The default mode,
100 "router", works exactly like the older version, and uses Subnet lines to
101 determine the destination of packets. The other two modes, "switch" and "hub",
102 allow the tinc daemons to work together like a single network switch or hub.
103 This is useful for bridging networks. The latter modes only work properly on
104 Linux, FreeBSD and Windows.
105
106 The algorithms used for encryption and generating message authentication codes
107 can now be changed in the configuration files. All cipher and digest algorithms
108 supported by OpenSSL can be used. Useful ciphers are "blowfish" (default),
109 "bf-ofb", "des", "des3", et cetera. Useful digests are "sha1" (default), "md5",
110 et cetera.
111
112 Support for routing IPv6 packets has been added. Just add Subnet lines with
113 IPv6 addresses (without using :: abbreviations) and use ifconfig or ip (from
114 the iproute package) to give the virtual network interface corresponding IPv6
115 addresses. tinc does not provide autoconfiguration for IPv6 hosts. Consider
116 using radvd or zebra if you need it.
117
118 It is also possible to make tunnels to other tinc daemons over IPv6 networks,
119 if the operating system supports IPv6.  tinc will automatically use both IPv6
120 and IPv4 when available, but this can be changed by adding the option
121 "AddressFamily = ipv4" or "AddressFamily = ipv6" to the tinc.conf file.
122
123 Normally, when started tinc will detach and run in the background. In a native
124 Windows environment this means tinc will install itself as a service, which will
125 restart after reboots.  To prevent tinc from detaching or running as a service,
126 use the -D option.
127