README

   1 This is the README file for tinc version 1.0.34. Installation
   2 instructions may be found in the INSTALL file.
   3
   4 tinc is Copyright (C) 1998-2018 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 The Sweet32 attack affects versions of tinc prior to 1.0.30.
  43
  44 Cryptography is a hard thing to get right. We cannot make any
  45 guarantees. Time, review and feedback are the only things that can
  46 prove the security of any cryptographic product. If you wish to review
  47 tinc or give us feedback, you are strongly encouraged to do so.
  48
  49
  50 Compatibility
  51 -------------
  52
  53 Version 1.0.31 is compatible with 1.0pre8, 1.0 and later, but not with older
  54 versions of tinc. Note that since version 1.0.30, tinc requires all nodes in
  55 the VPN to be compiled with a version of LibreSSL or OpenSSL that supports the
  56 AES256 and SHA256 algorithms.
  57
  58
  59 Requirements
  60 ------------
  61
  62 The OpenSSL library is used for all cryptographic functions. You can find it at
  63 https://www.openssl.org/. You will need version 1.0.1 or later with support for
  64 AES256 and SHA256 enabled. If this library is not installed on your system, the
  65 configure script will fail.  The manual in doc/tinc.texi contains more detailed
  66 information on how to install this library. Alternatively, you may also use the
  67 LibreSSL library.
  68
  69 The zlib library is used for optional compression. You can
  70 find it at https://zlib.net/. Because of a possible exploit in
  71 earlier versions we recommend that you download version 1.1.4 or later.
  72
  73 The LZO library is also used for optional compression. You can
  74 find it at https://www.oberhumer.com/opensource/lzo/.
  75
  76 In order to compile tinc, you will need a C99 compliant compiler.
  77
  78
  79 Features
  80 --------
  81
  82 This version of tinc supports multiple virtual networks at once. To
  83 use this feature, you may supply a netname via the -n or --net
  84 options. The standard locations for the config files will then be
  85 /etc/tinc/<net>/.
  86
  87 tincd regenerates its encryption key pairs. It does this on the first
  88 activity after the keys have expired. This period is adjustable in the
  89 configuration file, and the default time is 3600 seconds (one hour).
  90
  91 This version supports multiple subnets at once. They are also sorted
  92 on subnet mask size. This means that it is possible to have
  93 overlapping subnets on the VPN, as long as their subnet mask sizes
  94 differ.
  95
  96 Since pre5, tinc can operate in several routing modes. The default mode,
  97 "router", works exactly like the older version, and uses Subnet lines to
  98 determine the destination of packets. The other two modes, "switch" and "hub",
  99 allow the tinc daemons to work together like a single network switch or hub.
 100 This is useful for bridging networks. The latter modes only work properly on
 101 Linux, FreeBSD and Windows.
 102
 103 The algorithms used for encryption and generating message authentication codes
 104 can now be changed in the configuration files. All cipher and digest algorithms
 105 supported by OpenSSL can be used. Useful ciphers are "blowfish" (default),
 106 "bf-ofb", "des", "des3", et cetera. Useful digests are "sha1" (default), "md5",
 107 et cetera.
 108
 109 Support for routing IPv6 packets has been added. Just add Subnet lines with
 110 IPv6 addresses (without using :: abbreviations) and use ifconfig or ip (from
 111 the iproute package) to give the virtual network interface corresponding IPv6
 112 addresses. tinc does not provide autoconfiguration for IPv6 hosts. Consider
 113 using radvd or zebra if you need it.
 114
 115 It is also possible to make tunnels to other tinc daemons over IPv6 networks,
 116 if the operating system supports IPv6.  tinc will automatically use both IPv6
 117 and IPv4 when available, but this can be changed by adding the option
 118 "AddressFamily = ipv4" or "AddressFamily = ipv6" to the tinc.conf file.
 119
 120 Normally, when started tinc will detach and run in the background. In a native
 121 Windows environment this means tinc will install itself as a service, which will
 122 restart after reboots.  To prevent tinc from detaching or running as a service,
 123 use the -D option.
 124