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

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