www.tinc-vpn.org Git - tinc/blob - README

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