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