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

   1 This is the README file for tinc version 1.1pre11. Installation
   2 instructions may be found in the INSTALL file.
   3
   4 tinc is Copyright © 1998-2016 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
  32 Compatibility
  33 -------------
  34
  35 Version 1.1pre11 is compatible with 1.0pre8, 1.0 and later, but not with older
  36 versions of tinc.
  37
  38 When the ExperimentalProtocol option is used, tinc is still compatible with
  39 1.0.X and 1.1pre11 itself, but not with any other 1.1preX version.
  40
  41
  42 Requirements
  43 ------------
  44
  45 In order to compile tinc, you will need a GNU C compiler environment. Please
  46 ensure you have the latest stable versions of all the required libraries:
  47
  48 - LibreSSL (http://www.libressl.org/) or OpenSSL (https://openssl.org/) version 1.0.0 or later.
  49
  50 The following libraries are used by default, but can be disabled if necessary:
  51
  52 - zlib (http://www.zlib.net/)
  53 - LZO (https://www.oberhumer.com/opensource/lzo/)
  54 - ncurses (http://invisible-island.net/ncurses/)
  55 - readline (https://cnswww.cns.cwru.edu/php/chet/readline/rltop.html)
  56
  57
  58 Features
  59 --------
  60
  61 Tinc is a peer-to-peer VPN daemon that supports VPNs with an arbitrary number
  62 of nodes. Instead of configuring tunnels, you give tinc the location and
  63 public key of a few nodes in the VPN. After making the initial connections to
  64 those nodes, tinc will learn about all other nodes on the VPN, and will make
  65 connections automatically. When direct connections are not possible, data will
  66 be forwarded by intermediate nodes.
  67
  68 Tinc 1.1 support two protocols. The first is a legacy protocol that provides
  69 backwards compatibility with tinc 1.0 nodes, and which by default uses 2048 bit
  70 RSA keys for authentication, and encrypts traffic using Blowfish in CBC mode
  71 and HMAC-SHA1. The second is a new protocol which uses Curve25519 keys for
  72 authentication, and encrypts traffic using Chacha20-Poly1305, and provides
  73 forward secrecy.
  74
  75 Tinc fully supports IPv6.
  76
  77 Tinc can operate in several routing modes. In the default mode, "router", every
  78 node is associated with one or more IPv4 and/or IPv6 Subnets. The other two
  79 modes, "switch" and "hub", let the tinc daemons work together to form a virtual
  80 Ethernet network switch or hub.
  81
  82 Normally, when started tinc will detach and run in the background. In a native
  83 Windows environment this means tinc will install itself as a service, which will
  84 restart after reboots.  To prevent tinc from detaching or running as a service,
  85 use the -D option.
  86
  87 The status of the VPN can be queried using the "tinc" command, which connects
  88 to a running tinc daemon via a control connection. The same tool also makes it
  89 easy to start and stop tinc, and to change its configuration.