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

   1 This is the README file for tinc version 1.1pre17. Installation
   2 instructions may be found in the INSTALL file.
   3
   4 tinc is Copyright © 1998-2018 Ivo Timmermans, Guus Sliepen <guus@tinc-vpn.org>, and others.
   5
   6 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 This is a pre-release
  15 ---------------------
  16
  17 Please note that this is NOT a stable release. Until version 1.1.0 is released,
  18 please use one of the 1.0.x versions if you need a stable version of tinc.
  19
  20 Although tinc 1.1 will be protocol compatible with tinc 1.0.x, the
  21 functionality of the tinc program may still change, and the control socket
  22 protocol is not fixed yet.
  23
  24
  25 Security statement
  26 ------------------
  27
  28 This version uses an experimental and unfinished cryptographic protocol. Use it
  29 at your own risk.
  30
  31 When connecting to nodes that use the legacy protocol used in tinc 1.0, be
  32 aware that any security issues in tinc 1.0 will apply to tinc 1.1 as well. On
  33 September 6th, 2018, Michael Yonly contacted us and provided proof-of-concept
  34 code that allowed a remote attacker to create an authenticated, one-way
  35 connection with a node using the legacy protocol, and also that there was a
  36 possibility for a man-in-the-middle to force UDP packets from a node to be sent
  37 in plaintext. The first issue was trivial to exploit on tinc versions prior to
  38 1.0.30, but the changes in 1.0.30 to mitigate the Sweet32 attack made this
  39 weakness much harder to exploit. These issues have been fixed in tinc 1.0.35
  40 and tinc 1.1pre17. The new protocol in the tinc 1.1 branch is not susceptible
  41 to these issues. However, be aware that SPTPS is only used between nodes
  42 running tinc 1.1pre* or later, and in a VPN with nodes running different
  43 versions, the security might only be as good as that of the oldest version.
  44
  45
  46 Compatibility
  47 -------------
  48
  49 Version 1.1pre17 is compatible with 1.0pre8, 1.0 and later, but not with older
  50 versions of tinc.
  51
  52 When the ExperimentalProtocol option is used, tinc is still compatible with
  53 1.0.X, 1.1pre11 and later, but not with any version between 1.1pre1 and
  54 1.1pre10.
  55
  56
  57 Requirements
  58 ------------
  59
  60 In order to compile tinc, you will need a GNU C compiler environment. Please
  61 ensure you have the latest stable versions of all the required libraries:
  62
  63 - LibreSSL (http://www.libressl.org/) or OpenSSL (https://openssl.org/) version 1.0.0 or later.
  64
  65 The following libraries are used by default, but can be disabled if necessary:
  66
  67 - zlib (https://zlib.net/)
  68 - LZO (https://www.oberhumer.com/opensource/lzo/)
  69 - ncurses (https://invisible-island.net/ncurses/)
  70 - readline (https://cnswww.cns.cwru.edu/php/chet/readline/rltop.html)
  71
  72
  73 Features
  74 --------
  75
  76 Tinc is a peer-to-peer VPN daemon that supports VPNs with an arbitrary number
  77 of nodes. Instead of configuring tunnels, you give tinc the location and
  78 public key of a few nodes in the VPN. After making the initial connections to
  79 those nodes, tinc will learn about all other nodes on the VPN, and will make
  80 connections automatically. When direct connections are not possible, data will
  81 be forwarded by intermediate nodes.
  82
  83 Tinc 1.1 support two protocols. The first is a legacy protocol that provides
  84 backwards compatibility with tinc 1.0 nodes, and which by default uses 2048 bit
  85 RSA keys for authentication, and encrypts traffic using AES256 in CBC mode
  86 and HMAC-SHA256. The second is a new protocol which uses Curve25519 keys for
  87 authentication, and encrypts traffic using Chacha20-Poly1305, and provides
  88 forward secrecy.
  89
  90 Tinc fully supports IPv6.
  91
  92 Tinc can operate in several routing modes. In the default mode, "router", every
  93 node is associated with one or more IPv4 and/or IPv6 Subnets. The other two
  94 modes, "switch" and "hub", let the tinc daemons work together to form a virtual
  95 Ethernet network switch or hub.
  96
  97 Normally, when started tinc will detach and run in the background. In a native
  98 Windows environment this means tinc will install itself as a service, which will
  99 restart after reboots. To prevent tinc from detaching or running as a service,
 100 use the -D option.
 101
 102 The status of the VPN can be queried using the "tinc" command, which connects
 103 to a running tinc daemon via a control connection. The same tool also makes it
 104 easy to start and stop tinc, and to change its configuration.