Remove unused add_scalar function.
[tinc] / doc / tinc.texi
1 \input texinfo   @c -*-texinfo-*-
2 @c %**start of header
3 @setfilename tinc.info
4 @settitle tinc Manual
5 @setchapternewpage odd
6 @c %**end of header
7
8 @include tincinclude.texi
9
10 @ifinfo
11 @dircategory Networking tools
12 @direntry
13 * tinc: (tinc).              The tinc Manual.
14 @end direntry
15
16 This is the info manual for @value{PACKAGE} version @value{VERSION}, a Virtual Private Network daemon.
17
18 Copyright @copyright{} 1998-2016 Ivo Timmermans,
19 Guus Sliepen <guus@@tinc-vpn.org> and
20 Wessel Dankers <wsl@@tinc-vpn.org>.
21
22 Permission is granted to make and distribute verbatim copies of this
23 manual provided the copyright notice and this permission notice are
24 preserved on all copies.
25
26 Permission is granted to copy and distribute modified versions of this
27 manual under the conditions for verbatim copying, provided that the
28 entire resulting derived work is distributed under the terms of a
29 permission notice identical to this one.
30
31 @end ifinfo
32
33 @afourpaper
34 @paragraphindent none
35 @finalout
36
37 @titlepage
38 @title tinc Manual
39 @subtitle Setting up a Virtual Private Network with tinc
40 @author Ivo Timmermans and Guus Sliepen
41
42 @page
43 @vskip 0pt plus 1filll
44 This is the info manual for @value{PACKAGE} version @value{VERSION}, a Virtual Private Network daemon.
45
46 Copyright @copyright{} 1998-2016 Ivo Timmermans,
47 Guus Sliepen <guus@@tinc-vpn.org> and
48 Wessel Dankers <wsl@@tinc-vpn.org>.
49
50 Permission is granted to make and distribute verbatim copies of this
51 manual provided the copyright notice and this permission notice are
52 preserved on all copies.
53
54 Permission is granted to copy and distribute modified versions of this
55 manual under the conditions for verbatim copying, provided that the
56 entire resulting derived work is distributed under the terms of a
57 permission notice identical to this one.
58
59 @end titlepage
60
61 @ifnottex
62 @c ==================================================================
63 @node Top
64 @top Top
65
66 @menu
67 * Introduction::
68 * Preparations::
69 * Installation::
70 * Configuration::
71 * Running tinc::
72 * Controlling tinc::
73 * Invitations::
74 * Technical information::
75 * Platform specific information::
76 * About us::
77 * Concept Index::               All used terms explained
78 @end menu
79 @end ifnottex
80
81 @c ==================================================================
82 @node    Introduction
83 @chapter Introduction
84
85 @cindex tinc
86 Tinc is a Virtual Private Network (VPN) daemon that uses tunneling and
87 encryption to create a secure private network between hosts on the
88 Internet.
89
90 Because the tunnel appears to the IP level network code as a normal
91 network device, there is no need to adapt any existing software.
92 The encrypted tunnels allows VPN sites to share information with each other
93 over the Internet without exposing any information to others.
94
95 This document is the manual for tinc.  Included are chapters on how to
96 configure your computer to use tinc, as well as the configuration
97 process of tinc itself.
98
99 @menu
100 * Virtual Private Networks::
101 * tinc::                        About tinc
102 * Supported platforms::
103 @end menu
104
105 @c ==================================================================
106 @node    Virtual Private Networks
107 @section Virtual Private Networks
108
109 @cindex VPN
110 A Virtual Private Network or VPN is a network that can only be accessed
111 by a few elected computers that participate.  This goal is achievable in
112 more than just one way.
113
114 @cindex private
115 Private networks can consist of a single stand-alone Ethernet LAN.  Or
116 even two computers hooked up using a null-modem cable.  In these cases,
117 it is
118 obvious that the network is @emph{private}, no one can access it from the
119 outside.  But if your computers are linked to the Internet, the network
120 is not private anymore, unless one uses firewalls to block all private
121 traffic.  But then, there is no way to send private data to trusted
122 computers on the other end of the Internet.
123
124 @cindex virtual
125 This problem can be solved by using @emph{virtual} networks.  Virtual
126 networks can live on top of other networks, but they use encapsulation to
127 keep using their private address space so they do not interfere with
128 the Internet.  Mostly, virtual networks appear like a single LAN, even though
129 they can span the entire world.  But virtual networks can't be secured
130 by using firewalls, because the traffic that flows through it has to go
131 through the Internet, where other people can look at it.
132
133 As is the case with either type of VPN, anybody could eavesdrop.  Or
134 worse, alter data.  Hence it's probably advisable to encrypt the data
135 that flows over the network.
136
137 When one introduces encryption, we can form a true VPN.  Other people may
138 see encrypted traffic, but if they don't know how to decipher it (they
139 need to know the key for that), they cannot read the information that flows
140 through the VPN.  This is what tinc was made for.
141
142
143 @c ==================================================================
144 @node    tinc
145 @section tinc
146
147 @cindex vpnd
148 I really don't quite remember what got us started, but it must have been
149 Guus' idea.  He wrote a simple implementation (about 50 lines of C) that
150 used the ethertap device that Linux knows of since somewhere
151 about kernel 2.1.60.  It didn't work immediately and he improved it a
152 bit.  At this stage, the project was still simply called "vpnd".
153
154 Since then, a lot has changed---to say the least.
155
156 @cindex tincd
157 Tinc now supports encryption, it consists of a single daemon (tincd) for
158 both the receiving and sending end, it has become largely
159 runtime-configurable---in short, it has become a full-fledged
160 professional package.
161
162 @cindex traditional VPNs
163 @cindex scalability
164 Tinc also allows more than two sites to connect to eachother and form a single VPN.
165 Traditionally VPNs are created by making tunnels, which only have two endpoints.
166 Larger VPNs with more sites are created by adding more tunnels.
167 Tinc takes another approach: only endpoints are specified,
168 the software itself will take care of creating the tunnels.
169 This allows for easier configuration and improved scalability.
170
171 A lot can---and will be---changed. We have a number of things that we would like to
172 see in the future releases of tinc.  Not everything will be available in
173 the near future.  Our first objective is to make tinc work perfectly as
174 it stands, and then add more advanced features.
175
176 Meanwhile, we're always open-minded towards new ideas.  And we're
177 available too.
178
179
180 @c ==================================================================
181 @node    Supported platforms
182 @section Supported platforms
183
184 @cindex platforms
185 Tinc has been verified to work under Linux, FreeBSD, OpenBSD, NetBSD, MacOS/X (Darwin), Solaris, and Windows (both natively and in a Cygwin environment),
186 with various hardware architectures.  These are some of the platforms
187 that are supported by the universal tun/tap device driver or other virtual network device drivers.
188 Without such a driver, tinc will most
189 likely compile and run, but it will not be able to send or receive data
190 packets.
191
192 @cindex release
193 For an up to date list of supported platforms, please check the list on
194 our website:
195 @uref{https://www.tinc-vpn.org/platforms/}.
196
197 @c
198 @c
199 @c
200 @c
201 @c
202 @c
203 @c       Preparing your system
204 @c
205 @c
206 @c
207 @c
208 @c
209
210 @c ==================================================================
211 @node    Preparations
212 @chapter Preparations
213
214 This chapter contains information on how to prepare your system to
215 support tinc.
216
217 @menu
218 * Configuring the kernel::
219 * Libraries::
220 @end menu
221
222
223 @c ==================================================================
224 @node    Configuring the kernel
225 @section Configuring the kernel
226
227 @menu
228 * Configuration of Linux kernels::
229 * Configuration of FreeBSD kernels::
230 * Configuration of OpenBSD kernels::
231 * Configuration of NetBSD kernels::
232 * Configuration of Solaris kernels::
233 * Configuration of Darwin (MacOS/X) kernels::
234 * Configuration of Windows::
235 @end menu
236
237
238 @c ==================================================================
239 @node       Configuration of Linux kernels
240 @subsection Configuration of Linux kernels
241
242 @cindex Universal tun/tap
243 For tinc to work, you need a kernel that supports the Universal tun/tap device.
244 Most distributions come with kernels that already support this.
245 Here are the options you have to turn on when configuring a new kernel:
246
247 @example
248 Code maturity level options
249 [*] Prompt for development and/or incomplete code/drivers
250 Network device support
251 <M> Universal tun/tap device driver support
252 @end example
253
254 It's not necessary to compile this driver as a module, even if you are going to
255 run more than one instance of tinc.
256
257 If you decide to build the tun/tap driver as a kernel module, add these lines
258 to @file{/etc/modules.conf}:
259
260 @example
261 alias char-major-10-200 tun
262 @end example
263
264
265 @c ==================================================================
266 @node       Configuration of FreeBSD kernels
267 @subsection Configuration of FreeBSD kernels
268
269 For FreeBSD version 4.1 and higher, tun and tap drivers are included in the default kernel configuration.
270 The tap driver can be loaded with @code{kldload if_tap}, or by adding @code{if_tap_load="YES"} to @file{/boot/loader.conf}.
271
272
273 @c ==================================================================
274 @node       Configuration of OpenBSD kernels
275 @subsection Configuration of OpenBSD kernels
276
277 Recent versions of OpenBSD come with both tun and tap devices enabled in the default kernel configuration.
278
279
280 @c ==================================================================
281 @node       Configuration of NetBSD kernels
282 @subsection Configuration of NetBSD kernels
283
284 For NetBSD version 1.5.2 and higher,
285 the tun driver is included in the default kernel configuration.
286
287 Tunneling IPv6 may not work on NetBSD's tun device.
288
289
290 @c ==================================================================
291 @node       Configuration of Solaris kernels
292 @subsection Configuration of Solaris kernels
293
294 For Solaris 8 (SunOS 5.8) and higher,
295 the tun driver may or may not be included in the default kernel configuration.
296 If it isn't, the source can be downloaded from @uref{http://vtun.sourceforge.net/tun/}.
297 For x86 and sparc64 architectures, precompiled versions can be found at @uref{https://www.monkey.org/~dugsong/fragroute/}.
298 If the @file{net/if_tun.h} header file is missing, install it from the source package.
299
300
301 @c ==================================================================
302 @node       Configuration of Darwin (MacOS/X) kernels
303 @subsection Configuration of Darwin (MacOS/X) kernels
304
305 Tinc on Darwin relies on a tunnel driver for its data acquisition from the kernel.
306 OS X version 10.6.8 and later have a built-in tun driver called "utun".
307 Tinc also supports the driver from @uref{http://tuntaposx.sourceforge.net/},
308 which supports both tun and tap style devices,
309
310 By default, tinc expects the tuntaposx driver to be installed.
311 To use the utun driver, set add @code{Device = utunX} to @file{tinc.conf},
312 where X is the desired number for the utun interface.
313 You can also omit the number, in which case the first free number will be chosen.
314
315
316 @c ==================================================================
317 @node       Configuration of Windows
318 @subsection Configuration of Windows
319
320 You will need to install the latest TAP-Win32 driver from OpenVPN.
321 You can download it from @uref{https://openvpn.net/index.php/open-source/downloads.html}.
322 Using the Network Connections control panel,
323 configure the TAP-Win32 network interface in the same way as you would do from the tinc-up script,
324 as explained in the rest of the documentation.
325
326
327 @c ==================================================================
328 @node    Libraries
329 @section Libraries
330
331 @cindex requirements
332 @cindex libraries
333 Before you can configure or build tinc, you need to have the LibreSSL or OpenSSL, zlib,
334 lzo, curses and readline libraries installed on your system.  If you try to
335 configure tinc without having them installed, configure will give you an error
336 message, and stop.
337
338 @menu
339 * LibreSSL/OpenSSL::
340 * zlib::
341 * lzo::
342 * libcurses::
343 * libreadline::
344 @end menu
345
346
347 @c ==================================================================
348 @node       LibreSSL/OpenSSL
349 @subsection LibreSSL/OpenSSL
350
351 @cindex LibreSSL
352 @cindex OpenSSL
353 For all cryptography-related functions, tinc uses the functions provided
354 by the LibreSSL or the OpenSSL library.
355
356 If this library is not installed, you wil get an error when configuring
357 tinc for build.  Support for running tinc with other cryptographic libraries
358 installed @emph{may} be added in the future.
359
360 You can use your operating system's package manager to install this if
361 available.  Make sure you install the development AND runtime versions
362 of this package.
363
364 If your operating system comes neither with LibreSSL or OpenSSL, you have to
365 install one manually.  It is recommended that you get the latest version of
366 LibreSSL from @url{http://www.libressl.org/}.  Instructions on how to
367 configure, build and install this package are included within the package.
368 Please make sure you build development and runtime libraries (which is the
369 default).
370
371 If you installed the LibreSSL or OpenSSL libraries from source, it may be necessary
372 to let configure know where they are, by passing configure one of the
373 --with-openssl-* parameters. Note that you even have to use --with-openssl-* if you
374 are using LibreSSL.
375
376 @example
377 --with-openssl=DIR      LibreSSL/OpenSSL library and headers prefix
378 --with-openssl-include=DIR LibreSSL/OpenSSL headers directory
379                         (Default is OPENSSL_DIR/include)
380 --with-openssl-lib=DIR  LibreSSL/OpenSSL library directory
381                         (Default is OPENSSL_DIR/lib)
382 @end example
383
384
385 @subsubheading License
386
387 @cindex license
388 The complete source code of tinc is covered by the GNU GPL version 2.
389 Since the license under which OpenSSL is distributed is not directly
390 compatible with the terms of the GNU GPL
391 @uref{https://www.openssl.org/support/faq.html#LEGAL2}, we
392 include an exemption to the GPL (see also the file COPYING.README) to allow
393 everyone to create a statically or dynamically linked executable:
394
395 @quotation
396 This program is released under the GPL with the additional exemption
397 that compiling, linking, and/or using OpenSSL is allowed.  You may
398 provide binary packages linked to the OpenSSL libraries, provided that
399 all other requirements of the GPL are met.
400 @end quotation
401
402 Since the LZO library used by tinc is also covered by the GPL,
403 we also present the following exemption:
404
405 @quotation
406 Hereby I grant a special exception to the tinc VPN project
407 (https://www.tinc-vpn.org/) to link the LZO library with the OpenSSL library
408 (https://www.openssl.org).
409
410 Markus F.X.J. Oberhumer
411 @end quotation
412
413
414 @c ==================================================================
415 @node       zlib
416 @subsection zlib
417
418 @cindex zlib
419 For the optional compression of UDP packets, tinc uses the functions provided
420 by the zlib library.
421
422 If this library is not installed, you wil get an error when running the
423 configure script.  You can either install the zlib library, or disable support
424 for zlib compression by using the "--disable-zlib" option when running the
425 configure script. Note that if you disable support for zlib, the resulting
426 binary will not work correctly on VPNs where zlib compression is used.
427
428 You can use your operating system's package manager to install this if
429 available.  Make sure you install the development AND runtime versions
430 of this package.
431
432 If you have to install zlib manually, you can get the source code
433 from @url{http://www.zlib.net/}.  Instructions on how to configure,
434 build and install this package are included within the package.  Please
435 make sure you build development and runtime libraries (which is the
436 default).
437
438
439 @c ==================================================================
440 @node       lzo
441 @subsection lzo
442
443 @cindex lzo
444 Another form of compression is offered using the LZO library.
445
446 If this library is not installed, you wil get an error when running the
447 configure script.  You can either install the LZO library, or disable support
448 for LZO compression by using the "--disable-lzo" option when running the
449 configure script. Note that if you disable support for LZO, the resulting
450 binary will not work correctly on VPNs where LZO compression is used.
451
452 You can use your operating system's package manager to install this if
453 available.  Make sure you install the development AND runtime versions
454 of this package.
455
456 If you have to install lzo manually, you can get the source code
457 from @url{https://www.oberhumer.com/opensource/lzo/}.  Instructions on how to configure,
458 build and install this package are included within the package.  Please
459 make sure you build development and runtime libraries (which is the
460 default).
461
462
463 @c ==================================================================
464 @node       libcurses
465 @subsection libcurses
466
467 @cindex libcurses
468 For the "tinc top" command, tinc requires a curses library.
469
470 If this library is not installed, you wil get an error when running the
471 configure script.  You can either install a suitable curses library, or disable
472 all functionality that depends on a curses library by using the
473 "--disable-curses" option when running the configure script.
474
475 There are several curses libraries. It is recommended that you install
476 "ncurses" (@url{http://invisible-island.net/ncurses/}),
477 however other curses libraries should also work.
478 In particular, "PDCurses" (@url{http://pdcurses.sourceforge.net/})
479 is recommended if you want to compile tinc for Windows.
480
481 You can use your operating system's package manager to install this if
482 available. Make sure you install the development AND runtime versions
483 of this package.
484
485
486 @c ==================================================================
487 @node       libreadline
488 @subsection libreadline
489
490 @cindex libreadline
491 For the "tinc" command's shell functionality, tinc uses the readline library.
492
493 If this library is not installed, you wil get an error when running the
494 configure script.  You can either install a suitable readline library, or
495 disable all functionality that depends on a readline library by using the
496 "--disable-readline" option when running the configure script.
497
498 You can use your operating system's package manager to install this if
499 available.  Make sure you install the development AND runtime versions
500 of this package.
501
502 If you have to install libreadline manually, you can get the source code from
503 @url{http://www.gnu.org/software/readline/}. Instructions on how to configure,
504 build and install this package are included within the package.  Please make
505 sure you build development and runtime libraries (which is the default).
506
507
508 @c
509 @c
510 @c
511 @c      Installing tinc
512 @c
513 @c
514 @c
515 @c
516
517 @c ==================================================================
518 @node    Installation
519 @chapter Installation
520
521 If you use Debian, you may want to install one of the
522 precompiled packages for your system.  These packages are equipped with
523 system startup scripts and sample configurations.
524
525 If you cannot use one of the precompiled packages, or you want to compile tinc
526 for yourself, you can use the source.  The source is distributed under
527 the GNU General Public License (GPL).  Download the source from the
528 @uref{https://www.tinc-vpn.org/download/, download page}.
529
530 Tinc comes in a convenient autoconf/automake package, which you can just
531 treat the same as any other package.  Which is just untar it, type
532 `./configure' and then `make'.
533 More detailed instructions are in the file @file{INSTALL}, which is
534 included in the source distribution.
535
536 @menu
537 * Building and installing tinc::
538 * System files::
539 @end menu
540
541
542 @c ==================================================================
543 @node    Building and installing tinc
544 @section Building and installing tinc
545
546 Detailed instructions on configuring the source, building tinc and installing tinc
547 can be found in the file called @file{INSTALL}.
548
549 @cindex binary package
550 If you happen to have a binary package for tinc for your distribution,
551 you can use the package management tools of that distribution to install tinc.
552 The documentation that comes along with your distribution will tell you how to do that.
553
554 @menu
555 * Darwin (MacOS/X) build environment::
556 * Cygwin (Windows) build environment::
557 * MinGW (Windows) build environment::
558 @end menu
559
560
561 @c ==================================================================
562 @node       Darwin (MacOS/X) build environment
563 @subsection Darwin (MacOS/X) build environment
564
565 In order to build tinc on Darwin, you need to install Xcode from @uref{https://developer.apple.com/xcode/}.
566 It might also help to install a recent version of Fink from @uref{http://www.finkproject.org/}.
567
568 You need to download and install LibreSSL (or OpenSSL) and LZO,
569 either directly from their websites (see @ref{Libraries}) or using Fink.
570
571 @c ==================================================================
572 @node       Cygwin (Windows) build environment
573 @subsection Cygwin (Windows) build environment
574
575 If Cygwin hasn't already been installed, install it directly from
576 @uref{https://www.cygwin.com/}.
577
578 When tinc is compiled in a Cygwin environment, it can only be run in this environment,
579 but all programs, including those started outside the Cygwin environment, will be able to use the VPN.
580 It will also support all features.
581
582 @c ==================================================================
583 @node       MinGW (Windows) build environment
584 @subsection MinGW (Windows) build environment
585
586 You will need to install the MinGW environment from @uref{http://www.mingw.org}.
587 You also need to download and install LibreSSL (or OpenSSL) and LZO.
588
589 When tinc is compiled using MinGW it runs natively under Windows,
590 it is not necessary to keep MinGW installed.
591
592 When detaching, tinc will install itself as a service,
593 which will be restarted automatically after reboots.
594
595
596 @c ==================================================================
597 @node    System files
598 @section System files
599
600 Before you can run tinc, you must make sure you have all the needed
601 files on your system.
602
603 @menu
604 * Device files::
605 * Other files::
606 @end menu
607
608
609 @c ==================================================================
610 @node       Device files
611 @subsection Device files
612
613 @cindex device files
614 Most operating systems nowadays come with the necessary device files by default,
615 or they have a mechanism to create them on demand.
616
617 If you use Linux and do not have udev installed,
618 you may need to create the following device file if it does not exist:
619
620 @example
621 mknod -m 600 /dev/net/tun c 10 200
622 @end example
623
624
625 @c ==================================================================
626 @node       Other files
627 @subsection Other files
628
629 @subsubheading @file{/etc/networks}
630
631 You may add a line to @file{/etc/networks} so that your VPN will get a
632 symbolic name.  For example:
633
634 @example
635 myvpn 10.0.0.0
636 @end example
637
638 @subsubheading @file{/etc/services}
639
640 @cindex port numbers
641 You may add this line to @file{/etc/services}.  The effect is that you
642 may supply a @samp{tinc} as a valid port number to some programs.  The
643 number 655 is registered with the IANA.
644
645 @example
646 tinc            655/tcp    TINC
647 tinc            655/udp    TINC
648 #                          Ivo Timmermans <ivo@@tinc-vpn.org>
649 @end example
650
651
652 @c
653 @c
654 @c
655 @c
656 @c         Configuring tinc
657 @c
658 @c
659 @c
660 @c
661
662
663 @c ==================================================================
664 @node    Configuration
665 @chapter Configuration
666
667 @menu
668 * Configuration introduction::
669 * Multiple networks::
670 * How connections work::
671 * Configuration files::
672 * Network interfaces::
673 * Example configuration::
674 @end menu
675
676 @c ==================================================================
677 @node    Configuration introduction
678 @section Configuration introduction
679
680 Before actually starting to configure tinc and editing files,
681 make sure you have read this entire section so you know what to expect.
682 Then, make it clear to yourself how you want to organize your VPN:
683 What are the nodes (computers running tinc)?
684 What IP addresses/subnets do they have?
685 What is the network mask of the entire VPN?
686 Do you need special firewall rules?
687 Do you have to set up masquerading or forwarding rules?
688 Do you want to run tinc in router mode or switch mode?
689 These questions can only be answered by yourself,
690 you will not find the answers in this documentation.
691 Make sure you have an adequate understanding of networks in general.
692 @cindex Network Administrators Guide
693 A good resource on networking is the
694 @uref{http://www.tldp.org/LDP/nag2/, Linux Network Administrators Guide}.
695
696 If you have everything clearly pictured in your mind,
697 proceed in the following order:
698 First, create the initial configuration files and public/private keypairs using the following command:
699 @example
700 tinc -n @var{NETNAME} init @var{NAME}
701 @end example
702 Second, use @samp{tinc -n @var{NETNAME} add ...} to further configure tinc.
703 Finally, export your host configuration file using @samp{tinc -n @var{NETNAME} export} and send it to those
704 people or computers you want tinc to connect to.
705 They should send you their host configuration file back, which you can import using @samp{tinc -n @var{NETNAME} import}.
706
707 These steps are described in the subsections below.
708
709
710 @c ==================================================================
711 @node    Multiple networks
712 @section Multiple networks
713
714 @cindex multiple networks
715 @cindex netname
716
717 In order to allow you to run more than one tinc daemon on one computer,
718 for instance if your computer is part of more than one VPN,
719 you can assign a @var{netname} to your VPN.
720 It is not required if you only run one tinc daemon,
721 it doesn't even have to be the same on all the nodes of your VPN,
722 but it is recommended that you choose one anyway.
723
724 We will asume you use a netname throughout this document.
725 This means that you call tinc with the -n argument,
726 which will specify the netname.
727
728 The effect of this option is that tinc will set its configuration
729 root to @file{@value{sysconfdir}/tinc/@var{netname}/}, where @var{netname} is your argument to the -n option.
730 You will also notice that log messages it appears in syslog as coming from @file{tinc.@var{netname}},
731 and on Linux, unless specified otherwise, the name of the virtual network interface will be the same as the network name.
732
733 However, it is not strictly necessary that you call tinc with the -n
734 option. If you do not use it, the network name will just be empty, and
735 tinc will look for files in @file{@value{sysconfdir}/tinc/} instead of
736 @file{@value{sysconfdir}/tinc/@var{netname}/};
737 the configuration file will then be @file{@value{sysconfdir}/tinc/tinc.conf},
738 and the host configuration files are expected to be in @file{@value{sysconfdir}/tinc/hosts/}.
739
740
741 @c ==================================================================
742 @node    How connections work
743 @section How connections work
744
745 When tinc starts up, it parses the command-line options and then
746 reads in the configuration file tinc.conf.
747 If it sees one or more  `ConnectTo' values pointing to other tinc daemons in that file,
748 it will try to connect to those other daemons.
749 Whether this succeeds or not and whether `ConnectTo' is specified or not,
750 tinc will listen for incoming connection from other deamons.
751 If you did specify a `ConnectTo' value and the other side is not responding,
752 tinc will keep retrying.
753 This means that once started, tinc will stay running until you tell it to stop,
754 and failures to connect to other tinc daemons will not stop your tinc daemon
755 for trying again later.
756 This means you don't have to intervene if there are temporary network problems.
757
758 @cindex client
759 @cindex server
760 There is no real distinction between a server and a client in tinc.
761 If you wish, you can view a tinc daemon without a `ConnectTo' value as a server,
762 and one which does specify such a value as a client.
763 It does not matter if two tinc daemons have a `ConnectTo' value pointing to each other however.
764
765 Connections specified using `ConnectTo' are so-called meta-connections.
766 Tinc daemons exchange information about all other daemon they know about via these meta-connections.
767 After learning about all the daemons in the VPN,
768 tinc will create other connections as necessary in order to communicate with them.
769 For example, if there are three daemons named A, B and C, and A has @samp{ConnectTo = B} in its tinc.conf file,
770 and C has @samp{ConnectTo = B} in its tinc.conf file, then A will learn about C from B,
771 and will be able to exchange VPN packets with C without the need to have @samp{ConnectTo = C} in its tinc.conf file.
772
773 It could be that some daemons are located behind a Network Address Translation (NAT) device, or behind a firewall.
774 In the above scenario with three daemons, if A and C are behind a NAT,
775 B will automatically help A and C punch holes through their NAT,
776 in a way similar to the STUN protocol, so that A and C can still communicate with each other directly.
777 It is not always possible to do this however, and firewalls might also prevent direct communication.
778 In that case, VPN packets between A and C will be forwarded by B.
779
780 In effect, all nodes in the VPN will be able to talk to each other, as long as
781 their is a path of meta-connections between them, and whenever possible, two
782 nodes will communicate with each other directly.
783
784
785 @c ==================================================================
786 @node    Configuration files
787 @section Configuration files
788
789 The actual configuration of the daemon is done in the file
790 @file{@value{sysconfdir}/tinc/@var{netname}/tinc.conf} and at least one other file in the directory
791 @file{@value{sysconfdir}/tinc/@var{netname}/hosts/}.
792
793 An optionnal directory @file{@value{sysconfdir}/tinc/@var{netname}/conf.d} can be added from which
794 any .conf file will be read.
795
796 These file consists of comments (lines started with a #) or assignments
797 in the form of
798
799 @example
800 Variable = Value.
801 @end example
802
803 The variable names are case insensitive, and any spaces, tabs, newlines
804 and carriage returns are ignored.  Note: it is not required that you put
805 in the `=' sign, but doing so improves readability.  If you leave it
806 out, remember to replace it with at least one space character.
807
808 The server configuration is complemented with host specific configuration (see
809 the next section). Although all host configuration options for the local node
810 listed in this document can also be put in
811 @file{@value{sysconfdir}/tinc/@var{netname}/tinc.conf}, it is recommended to
812 put host specific configuration options in the host configuration file, as this
813 makes it easy to exchange with other nodes.
814
815 You can edit the config file manually, but it is recommended that you use
816 the tinc command to change configuration variables for you.
817
818 In the following two subsections all valid variables are listed in alphabetical order.
819 The default value is given between parentheses,
820 other comments are between square brackets.
821
822 @menu
823 * Main configuration variables::
824 * Host configuration variables::
825 * Scripts::
826 * How to configure::
827 @end menu
828
829
830 @c ==================================================================
831 @node       Main configuration variables
832 @subsection Main configuration variables
833
834 @table @asis
835 @cindex AddressFamily
836 @item AddressFamily = <ipv4|ipv6|any> (any)
837 This option affects the address family of listening and outgoing sockets.
838 If any is selected, then depending on the operating system
839 both IPv4 and IPv6 or just IPv6 listening sockets will be created.
840
841 @cindex AutoConnect
842 @item AutoConnect = <yes|no> (no) [experimental]
843 If set to yes, tinc will automatically set up meta connections to other nodes,
844 without requiring @var{ConnectTo} variables.
845
846 @cindex BindToAddress
847 @item BindToAddress = <@var{address}> [<@var{port}>]
848 This is the same as ListenAddress, however the address given with the BindToAddress option
849 will also be used for outgoing connections.
850 This is useful if your computer has more than one IPv4 or IPv6 address,
851 and you want tinc to only use a specific one for outgoing packets.
852
853 @cindex BindToInterface
854 @item BindToInterface = <@var{interface}> [experimental]
855 If you have more than one network interface in your computer, tinc will
856 by default listen on all of them for incoming connections.  It is
857 possible to bind tinc to a single interface like eth0 or ppp0 with this
858 variable.
859
860 This option may not work on all platforms.
861 Also, on some platforms it will not actually bind to an interface,
862 but rather to the address that the interface has at the moment a socket is created.
863
864 @cindex Broadcast
865 @item Broadcast = <no | mst | direct> (mst) [experimental]
866 This option selects the way broadcast packets are sent to other daemons.
867 @emph{NOTE: all nodes in a VPN must use the same Broadcast mode, otherwise routing loops can form.}
868
869 @table @asis
870 @item no
871 Broadcast packets are never sent to other nodes.
872
873 @item mst
874 Broadcast packets are sent and forwarded via the VPN's Minimum Spanning Tree.
875 This ensures broadcast packets reach all nodes.
876
877 @item direct
878 Broadcast packets are sent directly to all nodes that can be reached directly.
879 Broadcast packets received from other nodes are never forwarded.
880 If the IndirectData option is also set, broadcast packets will only be sent to nodes which we have a meta connection to.
881 @end table
882
883 @cindex BroadcastSubnet
884 @item BroadcastSubnet = @var{address}[/@var{prefixlength}]
885 Declares a broadcast subnet.
886 Any packet with a destination address falling into such a subnet will be routed as a broadcast
887 (provided all nodes have it declared).
888 This is most useful to declare subnet broadcast addresses (e.g. 10.42.255.255),
889 otherwise tinc won't know what to do with them.
890
891 Note that global broadcast addresses (MAC ff:ff:ff:ff:ff:ff, IPv4 255.255.255.255),
892 as well as multicast space (IPv4 224.0.0.0/4, IPv6 ff00::/8)
893 are always considered broadcast addresses and don't need to be declared.
894
895 @cindex ConnectTo
896 @item ConnectTo = <@var{name}>
897 Specifies which other tinc daemon to connect to on startup.
898 Multiple ConnectTo variables may be specified,
899 in which case outgoing connections to each specified tinc daemon are made.
900 The names should be known to this tinc daemon
901 (i.e., there should be a host configuration file for the name on the ConnectTo line).
902
903 If you don't specify a host with ConnectTo and don't enable AutoConnect,
904 tinc won't try to connect to other daemons at all,
905 and will instead just listen for incoming connections.
906
907 @cindex DecrementTTL
908 @item DecrementTTL = <yes | no> (no) [experimental]
909 When enabled, tinc will decrement the Time To Live field in IPv4 packets, or the Hop Limit field in IPv6 packets,
910 before forwarding a received packet to the virtual network device or to another node,
911 and will drop packets that have a TTL value of zero,
912 in which case it will send an ICMP Time Exceeded packet back.
913
914 Do not use this option if you use switch mode and want to use IPv6.
915
916 @cindex Device
917 @item Device = <@var{device}> (@file{/dev/tap0}, @file{/dev/net/tun} or other depending on platform)
918 The virtual network device to use.
919 Tinc will automatically detect what kind of device it is.
920 Note that you can only use one device per daemon.
921 Under Windows, use @var{Interface} instead of @var{Device}.
922 Note that you can only use one device per daemon.
923 See also @ref{Device files}.
924
925 @cindex DeviceStandby
926 @item DeviceStandby = <yes | no> (no)
927 When disabled, tinc calls @file{tinc-up} on startup, and @file{tinc-down} on shutdown.
928 When enabled, tinc will only call @file{tinc-up} when at least one node is reachable,
929 and will call @file{tinc-down} as soon as no nodes are reachable.
930 On Windows, this also determines when the virtual network interface "cable" is "plugged".
931
932 @cindex DeviceType
933 @item DeviceType = <@var{type}> (platform dependent)
934 The type of the virtual network device.
935 Tinc will normally automatically select the right type of tun/tap interface, and this option should not be used.
936 However, this option can be used to select one of the special interface types, if support for them is compiled in.
937
938 @table @asis
939 @cindex dummy
940 @item dummy
941 Use a dummy interface.
942 No packets are ever read or written to a virtual network device.
943 Useful for testing, or when setting up a node that only forwards packets for other nodes.
944
945 @cindex raw_socket
946 @item raw_socket
947 Open a raw socket, and bind it to a pre-existing
948 @var{Interface} (eth0 by default).
949 All packets are read from this interface.
950 Packets received for the local node are written to the raw socket.
951 However, at least on Linux, the operating system does not process IP packets destined for the local host.
952
953 @cindex multicast
954 @item multicast
955 Open a multicast UDP socket and bind it to the address and port (separated by spaces) and optionally a TTL value specified using @var{Device}.
956 Packets are read from and written to this multicast socket.
957 This can be used to connect to UML, QEMU or KVM instances listening on the same multicast address.
958 Do NOT connect multiple tinc daemons to the same multicast address, this will very likely cause routing loops.
959 Also note that this can cause decrypted VPN packets to be sent out on a real network if misconfigured.
960
961 @cindex fd
962 @item fd
963 Use a file descriptor.
964 All packets are read from this interface.
965 Packets received for the local node are written to it.
966
967 @cindex UML
968 @item uml (not compiled in by default)
969 Create a UNIX socket with the filename specified by
970 @var{Device}, or @file{@value{localstatedir}/run/@var{netname}.umlsocket}
971 if not specified.
972 Tinc will wait for a User Mode Linux instance to connect to this socket.
973
974 @cindex VDE
975 @item vde (not compiled in by default)
976 Uses the libvdeplug library to connect to a Virtual Distributed Ethernet switch,
977 using the UNIX socket specified by
978 @var{Device}, or @file{@value{localstatedir}/run/vde.ctl}
979 if not specified.
980 @end table
981
982 Also, in case tinc does not seem to correctly interpret packets received from the virtual network device,
983 it can be used to change the way packets are interpreted:
984
985 @table @asis
986 @item tun (BSD and Linux)
987 Set type to tun.
988 Depending on the platform, this can either be with or without an address family header (see below).
989
990 @cindex tunnohead
991 @item tunnohead (BSD)
992 Set type to tun without an address family header.
993 Tinc will expect packets read from the virtual network device to start with an IP header.
994 On some platforms IPv6 packets cannot be read from or written to the device in this mode.
995
996 @cindex tunifhead
997 @item tunifhead (BSD)
998 Set type to tun with an address family header.
999 Tinc will expect packets read from the virtual network device
1000 to start with a four byte header containing the address family,
1001 followed by an IP header.
1002 This mode should support both IPv4 and IPv6 packets.
1003
1004 @cindex utun
1005 @item utun (OS X)
1006 Set type to utun.
1007 This is only supported on OS X version 10.6.8 and higher, but doesn't require the tuntaposx module.
1008 This mode should support both IPv4 and IPv6 packets.
1009
1010 @item tap (BSD and Linux)
1011 Set type to tap.
1012 Tinc will expect packets read from the virtual network device
1013 to start with an Ethernet header.
1014 @end table
1015
1016 @cindex DirectOnly
1017 @item DirectOnly = <yes|no> (no) [experimental]
1018 When this option is enabled, packets that cannot be sent directly to the destination node,
1019 but which would have to be forwarded by an intermediate node, are dropped instead.
1020 When combined with the IndirectData option,
1021 packets for nodes for which we do not have a meta connection with are also dropped.
1022
1023 @cindex Ed25519PrivateKeyFile
1024 @item Ed25519PrivateKeyFile = <@var{path}> (@file{@value{sysconfdir}/tinc/@var{netname}/ed25519_key.priv})
1025 The file in which the private Ed25519 key of this tinc daemon resides.
1026 This is only used if ExperimentalProtocol is enabled.
1027
1028 @cindex ExperimentalProtocol
1029 @item ExperimentalProtocol = <yes|no> (yes)
1030 When this option is enabled, the SPTPS protocol will be used when connecting to nodes that also support it.
1031 Ephemeral ECDH will be used for key exchanges,
1032 and Ed25519 will be used instead of RSA for authentication.
1033 When enabled, an Ed25519 key must have been generated before with
1034 @samp{tinc generate-ed25519-keys}.
1035
1036 @cindex Forwarding
1037 @item Forwarding = <off|internal|kernel> (internal) [experimental]
1038 This option selects the way indirect packets are forwarded.
1039
1040 @table @asis
1041 @item off
1042 Incoming packets that are not meant for the local node,
1043 but which should be forwarded to another node, are dropped.
1044
1045 @item internal
1046 Incoming packets that are meant for another node are forwarded by tinc internally.
1047
1048 This is the default mode, and unless you really know you need another forwarding mode, don't change it.
1049
1050 @item kernel
1051 Incoming packets are always sent to the TUN/TAP device, even if the packets are not for the local node.
1052 This is less efficient, but allows the kernel to apply its routing and firewall rules on them,
1053 and can also help debugging.
1054 @end table
1055
1056 @cindex Hostnames
1057 @item Hostnames = <yes|no> (no)
1058 This option selects whether IP addresses (both real and on the VPN)
1059 should be resolved.  Since DNS lookups are blocking, it might affect
1060 tinc's efficiency, even stopping the daemon for a few seconds everytime
1061 it does a lookup if your DNS server is not responding.
1062
1063 This does not affect resolving hostnames to IP addresses from the
1064 configuration file, but whether hostnames should be resolved while logging.
1065
1066 @cindex Interface
1067 @item Interface = <@var{interface}>
1068 Defines the name of the interface corresponding to the virtual network device.
1069 Depending on the operating system and the type of device this may or may not actually set the name of the interface.
1070 Under Windows, this variable is used to select which network interface will be used.
1071 If you specified a Device, this variable is almost always already correctly set.
1072
1073 @cindex ListenAddress
1074 @item ListenAddress = <@var{address}> [<@var{port}>]
1075 If your computer has more than one IPv4 or IPv6 address, tinc
1076 will by default listen on all of them for incoming connections.
1077 This option can be used to restrict which addresses tinc listens on.
1078 Multiple ListenAddress variables may be specified,
1079 in which case listening sockets for each specified address are made.
1080
1081 If no @var{port} is specified, the socket will listen on the port specified by the Port option,
1082 or to port 655 if neither is given.
1083 To only listen on a specific port but not to a specific address, use "*" for the @var{address}.
1084
1085 @cindex LocalDiscovery
1086 @item LocalDiscovery = <yes | no> (no)
1087 When enabled, tinc will try to detect peers that are on the same local network.
1088 This will allow direct communication using LAN addresses, even if both peers are behind a NAT
1089 and they only ConnectTo a third node outside the NAT,
1090 which normally would prevent the peers from learning each other's LAN address.
1091
1092 Currently, local discovery is implemented by sending some packets to the local address of the node during UDP discovery.
1093 This will not work with old nodes that don't transmit their local address.
1094
1095 @cindex Mode
1096 @item Mode = <router|switch|hub> (router)
1097 This option selects the way packets are routed to other daemons.
1098
1099 @table @asis
1100 @cindex router
1101 @item router
1102 In this mode Subnet
1103 variables in the host configuration files will be used to form a routing table.
1104 Only packets of routable protocols (IPv4 and IPv6) are supported in this mode.
1105
1106 This is the default mode, and unless you really know you need another mode, don't change it.
1107
1108 @cindex switch
1109 @item switch
1110 In this mode the MAC addresses of the packets on the VPN will be used to
1111 dynamically create a routing table just like an Ethernet switch does.
1112 Unicast, multicast and broadcast packets of every protocol that runs over Ethernet are supported in this mode
1113 at the cost of frequent broadcast ARP requests and routing table updates.
1114
1115 This mode is primarily useful if you want to bridge Ethernet segments.
1116
1117 @cindex hub
1118 @item hub
1119 This mode is almost the same as the switch mode, but instead
1120 every packet will be broadcast to the other daemons
1121 while no routing table is managed.
1122 @end table
1123
1124 @cindex KeyExpire
1125 @item KeyExpire = <@var{seconds}> (3600)
1126 This option controls the time the encryption keys used to encrypt the data
1127 are valid.  It is common practice to change keys at regular intervals to
1128 make it even harder for crackers, even though it is thought to be nearly
1129 impossible to crack a single key.
1130
1131 @cindex MACExpire
1132 @item MACExpire = <@var{seconds}> (600)
1133 This option controls the amount of time MAC addresses are kept before they are removed.
1134 This only has effect when Mode is set to "switch".
1135
1136 @cindex MaxConnectionBurst
1137 @item MaxConnectionBurst = <@var{count}> (100)
1138 This option controls how many connections tinc accepts in quick succession.
1139 If there are more connections than the given number in a short time interval,
1140 tinc will reduce the number of accepted connections to only one per second,
1141 until the burst has passed.
1142
1143 @cindex Name
1144 @item Name = <@var{name}> [required]
1145 This is a symbolic name for this connection.
1146 The name must consist only of alfanumeric and underscore characters (a-z, A-Z, 0-9 and _), and is case sensitive.
1147
1148 If Name starts with a $, then the contents of the environment variable that follows will be used.
1149 In that case, invalid characters will be converted to underscores.
1150 If Name is $HOST, but no such environment variable exist,
1151 the hostname will be read using the gethostname() system call.
1152
1153 @cindex PingInterval
1154 @item PingInterval = <@var{seconds}> (60)
1155 The number of seconds of inactivity that tinc will wait before sending a
1156 probe to the other end.
1157
1158 @cindex PingTimeout
1159 @item PingTimeout = <@var{seconds}> (5)
1160 The number of seconds to wait for a response to pings or to allow meta
1161 connections to block. If the other end doesn't respond within this time,
1162 the connection is terminated, and the others will be notified of this.
1163
1164 @cindex PriorityInheritance
1165 @item PriorityInheritance = <yes|no> (no) [experimental]
1166 When this option is enabled the value of the TOS field of tunneled IPv4 packets
1167 will be inherited by the UDP packets that are sent out.
1168
1169 @cindex PrivateKey
1170 @item PrivateKey = <@var{key}> [obsolete]
1171 This is the RSA private key for tinc. However, for safety reasons it is
1172 advised to store private keys of any kind in separate files. This prevents
1173 accidental eavesdropping if you are editting the configuration file.
1174
1175 @cindex PrivateKeyFile
1176 @item PrivateKeyFile = <@var{path}> (@file{@value{sysconfdir}/tinc/@var{netname}/rsa_key.priv})
1177 This is the full path name of the RSA private key file that was
1178 generated by @samp{tinc generate-keys}.  It must be a full path, not a
1179 relative directory.
1180
1181 @cindex ProcessPriority
1182 @item ProcessPriority = <low|normal|high>
1183 When this option is used the priority of the tincd process will be adjusted.
1184 Increasing the priority may help to reduce latency and packet loss on the VPN.
1185
1186 @cindex Proxy
1187 @item Proxy = socks4 | socks5 | http | exec @var{...} [experimental]
1188 Use a proxy when making outgoing connections.
1189 The following proxy types are currently supported:
1190
1191 @table @asis
1192 @cindex socks4
1193 @item socks4 <@var{address}> <@var{port}> [<@var{username}>]
1194 Connects to the proxy using the SOCKS version 4 protocol.
1195 Optionally, a @var{username} can be supplied which will be passed on to the proxy server.
1196
1197 @cindex socks5
1198 @item socks5 <@var{address}> <@var{port}> [<@var{username}> <@var{password}>]
1199 Connect to the proxy using the SOCKS version 5 protocol.
1200 If a @var{username} and @var{password} are given, basic username/password authentication will be used,
1201 otherwise no authentication will be used.
1202
1203 @cindex http
1204 @item http <@var{address}> <@var{port}>
1205 Connects to the proxy and sends a HTTP CONNECT request.
1206
1207 @cindex exec
1208 @item exec <@var{command}>
1209 Executes the given command which should set up the outgoing connection.
1210 The environment variables @env{NAME}, @env{NODE}, @env{REMOTEADDRES} and @env{REMOTEPORT} are available.
1211 @end table
1212
1213 @cindex ReplayWindow
1214 @item ReplayWindow = <bytes> (32)
1215 This is the size of the replay tracking window for each remote node, in bytes.
1216 The window is a bitfield which tracks 1 packet per bit, so for example
1217 the default setting of 32 will track up to 256 packets in the window. In high
1218 bandwidth scenarios, setting this to a higher value can reduce packet loss from
1219 the interaction of replay tracking with underlying real packet loss and/or
1220 reordering. Setting this to zero will disable replay tracking completely and
1221 pass all traffic, but leaves tinc vulnerable to replay-based attacks on your
1222 traffic.
1223
1224 @cindex StrictSubnets
1225 @item StrictSubnets = <yes|no> (no) [experimental]
1226 When this option is enabled tinc will only use Subnet statements which are
1227 present in the host config files in the local
1228 @file{@value{sysconfdir}/tinc/@var{netname}/hosts/} directory.
1229 Subnets learned via connections to other nodes and which are not
1230 present in the local host config files are ignored.
1231
1232 @cindex TunnelServer
1233 @item TunnelServer = <yes|no> (no) [experimental]
1234 When this option is enabled tinc will no longer forward information between other tinc daemons,
1235 and will only allow connections with nodes for which host config files are present in the local
1236 @file{@value{sysconfdir}/tinc/@var{netname}/hosts/} directory.
1237 Setting this options also implicitly sets StrictSubnets.
1238
1239 @cindex UDPDiscovey
1240 @item UDPDiscovery = <yes|no> (yes)
1241 When this option is enabled tinc will try to establish UDP connectivity to nodes,
1242 using TCP while it determines if a node is reachable over UDP. If it is disabled,
1243 tinc always assumes a node is reachable over UDP.
1244 Note that tinc will never use UDP with nodes that have TCPOnly enabled.
1245
1246 @cindex UDPDiscoveryKeepaliveInterval
1247 @item UDPDiscoveryKeepaliveInterval = <seconds> (9)
1248 The minimum amount of time between sending UDP ping datagrams to check UDP connectivity once it has been established.
1249 Note that these pings are large, since they are used to verify link MTU as well.
1250
1251 @cindex UDPDiscoveryInterval
1252 @item UDPDiscoveryInterval = <seconds> (2)
1253 The minimum amount of time between sending UDP ping datagrams to try to establish UDP connectivity.
1254
1255 @cindex UDPDiscoveryTimeout
1256 @item UDPDiscoveryTimeout = <seconds> (30)
1257 If tinc doesn't receive any UDP ping replies over the specified interval,
1258 it will assume UDP communication is broken and will fall back to TCP.
1259
1260 @cindex UDPInfoInterval
1261 @item UDPInfoInterval = <seconds> (5)
1262 The minimum amount of time between sending periodic updates about UDP addresses, which are mostly useful for UDP hole punching.
1263
1264 @cindex UDPRcvBuf
1265 @item UDPRcvBuf = <bytes> (1048576)
1266 Sets the socket receive buffer size for the UDP socket, in bytes.
1267 If set to zero, the default buffer size will be used by the operating system.
1268 Note: this setting can have a significant impact on performance, especially raw throughput.
1269
1270 @cindex UDPSndBuf
1271 @item UDPSndBuf = <bytes> (1048576)
1272 Sets the socket send buffer size for the UDP socket, in bytes.
1273 If set to zero, the default buffer size will be used by the operating system.
1274 Note: this setting can have a significant impact on performance, especially raw throughput.
1275
1276 @cindex UPnP
1277 @item UPnP = <yes|udponly|no> (no)
1278 If this option is enabled then tinc will search for UPnP-IGD devices on the local network.
1279 It will then create and maintain port mappings for tinc's listening TCP and UDP ports.
1280 If set to "udponly", tinc will only create a mapping for its UDP (data) port, not for its TCP (metaconnection) port.
1281 Note that tinc must have been built with miniupnpc support for this feature to be available.
1282 Furthermore, be advised that enabling this can have security implications, because the miniupnpc library that
1283 tinc uses might not be well-hardened with regard to malicious UPnP replies.
1284
1285 @cindex UPnPDiscoverWait
1286 @item UPnPDiscoverWait = <seconds> (5)
1287 The amount of time to wait for replies when probing the local network for UPnP devices.
1288
1289 @cindex UPnPRefreshPeriod
1290 @item UPnPRefreshPeriod = <seconds> (5)
1291 How often tinc will re-add the port mapping, in case it gets reset on the UPnP device.
1292 This also controls the duration of the port mapping itself, which will be set to twice that duration.
1293
1294 @end table
1295
1296
1297 @c ==================================================================
1298 @node       Host configuration variables
1299 @subsection Host configuration variables
1300
1301 @table @asis
1302 @cindex Address
1303 @item Address = <@var{IP address}|@var{hostname}> [<port>] [recommended]
1304 This variable is only required if you want to connect to this host.  It
1305 must resolve to the external IP address where the host can be reached,
1306 not the one that is internal to the VPN.
1307 If no port is specified, the default Port is used.
1308 Multiple Address variables can be specified, in which case each address will be
1309 tried until a working connection has been established.
1310
1311 @cindex Cipher
1312 @item Cipher = <@var{cipher}> (blowfish)
1313 The symmetric cipher algorithm used to encrypt UDP packets using the legacy protocol.
1314 Any cipher supported by LibreSSL or OpenSSL is recognized.
1315 Furthermore, specifying "none" will turn off packet encryption.
1316 It is best to use only those ciphers which support CBC mode.
1317 This option has no effect for connections using the SPTPS protocol, which always use AES-256-CTR.
1318
1319 @cindex ClampMSS
1320 @item ClampMSS = <yes|no> (yes)
1321 This option specifies whether tinc should clamp the maximum segment size (MSS)
1322 of TCP packets to the path MTU. This helps in situations where ICMP
1323 Fragmentation Needed or Packet too Big messages are dropped by firewalls.
1324
1325 @cindex Compression
1326 @item Compression = <@var{level}> (0)
1327 This option sets the level of compression used for UDP packets.
1328 Possible values are 0 (off), 1 (fast zlib) and any integer up to 9 (best zlib),
1329 10 (fast lzo) and 11 (best lzo).
1330
1331 @cindex Digest
1332 @item Digest = <@var{digest}> (sha1)
1333 The digest algorithm used to authenticate UDP packets using the legacy protocol.
1334 Any digest supported by LibreSSL or OpenSSL is recognized.
1335 Furthermore, specifying "none" will turn off packet authentication.
1336 This option has no effect for connections using the SPTPS protocol, which always use HMAC-SHA-256.
1337
1338 @cindex IndirectData
1339 @item IndirectData = <yes|no> (no)
1340 When set to yes, other nodes which do not already have a meta connection to you
1341 will not try to establish direct communication with you.
1342 It is best to leave this option out or set it to no.
1343
1344 @cindex MACLength
1345 @item MACLength = <@var{bytes}> (4)
1346 The length of the message authentication code used to authenticate UDP packets using the legacy protocol.
1347 Can be anything from 0
1348 up to the length of the digest produced by the digest algorithm.
1349 This option has no effect for connections using the SPTPS protocol, which never truncate MACs.
1350
1351 @cindex PMTU
1352 @item PMTU = <@var{mtu}> (1514)
1353 This option controls the initial path MTU to this node.
1354
1355 @cindex PMTUDiscovery
1356 @item PMTUDiscovery = <yes|no> (yes)
1357 When this option is enabled, tinc will try to discover the path MTU to this node.
1358 After the path MTU has been discovered, it will be enforced on the VPN.
1359
1360 @cindex MTUInfoInterval
1361 @item MTUInfoInterval = <seconds> (5)
1362 The minimum amount of time between sending periodic updates about relay path MTU. Useful for quickly determining MTU to indirect nodes.
1363
1364 @cindex Port
1365 @item Port = <@var{port}> (655)
1366 This is the port this tinc daemon listens on.
1367 You can use decimal portnumbers or symbolic names (as listed in @file{/etc/services}).
1368
1369 @cindex PublicKey
1370 @item PublicKey = <@var{key}> [obsolete]
1371 This is the RSA public key for this host.
1372
1373 @cindex PublicKeyFile
1374 @item PublicKeyFile = <@var{path}> [obsolete]
1375 This is the full path name of the RSA public key file that was generated
1376 by @samp{tinc generate-keys}.  It must be a full path, not a relative
1377 directory.
1378
1379 @cindex PEM format
1380 From version 1.0pre4 on tinc will store the public key directly into the
1381 host configuration file in PEM format, the above two options then are not
1382 necessary. Either the PEM format is used, or exactly
1383 @strong{one of the above two options} must be specified
1384 in each host configuration file, if you want to be able to establish a
1385 connection with that host.
1386
1387 @cindex Subnet
1388 @item Subnet = <@var{address}[/@var{prefixlength}[#@var{weight}]]>
1389 The subnet which this tinc daemon will serve.
1390 Tinc tries to look up which other daemon it should send a packet to by searching the appropiate subnet.
1391 If the packet matches a subnet,
1392 it will be sent to the daemon who has this subnet in his host configuration file.
1393 Multiple subnet lines can be specified for each daemon.
1394
1395 Subnets can either be single MAC, IPv4 or IPv6 addresses,
1396 in which case a subnet consisting of only that single address is assumed,
1397 or they can be a IPv4 or IPv6 network address with a prefixlength.
1398 For example, IPv4 subnets must be in a form like 192.168.1.0/24,
1399 where 192.168.1.0 is the network address and 24 is the number of bits set in the netmask.
1400 Note that subnets like 192.168.1.1/24 are invalid!
1401 Read a networking HOWTO/FAQ/guide if you don't understand this.
1402 IPv6 subnets are notated like fec0:0:0:1::/64.
1403 MAC addresses are notated like 0:1a:2b:3c:4d:5e.
1404
1405 @cindex CIDR notation
1406 Prefixlength is the number of bits set to 1 in the netmask part; for
1407 example: netmask 255.255.255.0 would become /24, 255.255.252.0 becomes
1408 /22. This conforms to standard CIDR notation as described in
1409 @uref{https://www.ietf.org/rfc/rfc1519.txt, RFC1519}
1410
1411 A Subnet can be given a weight to indicate its priority over identical Subnets
1412 owned by different nodes. The default weight is 10. Lower values indicate
1413 higher priority. Packets will be sent to the node with the highest priority,
1414 unless that node is not reachable, in which case the node with the next highest
1415 priority will be tried, and so on.
1416
1417 @cindex TCPonly
1418 @item TCPonly = <yes|no> (no)
1419 If this variable is set to yes, then the packets are tunnelled over a
1420 TCP connection instead of a UDP connection.  This is especially useful
1421 for those who want to run a tinc daemon from behind a masquerading
1422 firewall, or if UDP packet routing is disabled somehow.
1423 Setting this options also implicitly sets IndirectData.
1424
1425 @cindex Weight
1426 @item Weight = <weight>
1427 If this variable is set, it overrides the weight given to connections made with
1428 another host. A higher weight means a lower priority is given to this
1429 connection when broadcasting or forwarding packets.
1430 @end table
1431
1432
1433 @c ==================================================================
1434 @node       Scripts
1435 @subsection Scripts
1436
1437 @cindex scripts
1438 Apart from reading the server and host configuration files,
1439 tinc can also run scripts at certain moments.
1440 Below is a list of filenames of scripts and a description of when they are run.
1441 A script is only run if it exists and if it is executable.
1442
1443 Scripts are run synchronously;
1444 this means that tinc will temporarily stop processing packets until the called script finishes executing.
1445 This guarantees that scripts will execute in the exact same order as the events that trigger them.
1446 If you need to run commands asynchronously, you have to ensure yourself that they are being run in the background.
1447
1448 Under Windows (not Cygwin), the scripts should have the extension @file{.bat} or @file{.cmd}.
1449
1450 @table @file
1451 @cindex tinc-up
1452 @item @value{sysconfdir}/tinc/@var{netname}/tinc-up
1453 This is the most important script.
1454 If it is present it will be executed right after the tinc daemon has been
1455 started and has connected to the virtual network device.
1456 It should be used to set up the corresponding network interface,
1457 but can also be used to start other things.
1458
1459 Under Windows you can use the Network Connections control panel instead of creating this script.
1460
1461 @cindex tinc-down
1462 @item @value{sysconfdir}/tinc/@var{netname}/tinc-down
1463 This script is started right before the tinc daemon quits.
1464
1465 @item @value{sysconfdir}/tinc/@var{netname}/hosts/@var{host}-up
1466 This script is started when the tinc daemon with name @var{host} becomes reachable.
1467
1468 @item @value{sysconfdir}/tinc/@var{netname}/hosts/@var{host}-down
1469 This script is started when the tinc daemon with name @var{host} becomes unreachable.
1470
1471 @item @value{sysconfdir}/tinc/@var{netname}/host-up
1472 This script is started when any host becomes reachable.
1473
1474 @item @value{sysconfdir}/tinc/@var{netname}/host-down
1475 This script is started when any host becomes unreachable.
1476
1477 @item @value{sysconfdir}/tinc/@var{netname}/subnet-up
1478 This script is started when a Subnet becomes reachable.
1479 The Subnet and the node it belongs to are passed in environment variables.
1480
1481 @item @value{sysconfdir}/tinc/@var{netname}/subnet-down
1482 This script is started when a Subnet becomes unreachable.
1483
1484 @item @value{sysconfdir}/tinc/@var{netname}/invitation-created
1485 This script is started when a new invitation has been created.
1486
1487 @item @value{sysconfdir}/tinc/@var{netname}/invitation-accepted
1488 This script is started when an invitation has been used.
1489
1490 @end table
1491
1492 @cindex environment variables
1493 The scripts are started without command line arguments,
1494 but can make use of certain environment variables.
1495 Under UNIX like operating systems the names of environment variables must be preceded by a $ in scripts.
1496 Under Windows, in @file{.bat} or @file{.cmd} files, they have to be put between % signs.
1497
1498 @table @env
1499 @cindex NETNAME
1500 @item NETNAME
1501 If a netname was specified, this environment variable contains it.
1502
1503 @cindex NAME
1504 @item NAME
1505 Contains the name of this tinc daemon.
1506
1507 @cindex DEVICE
1508 @item DEVICE
1509 Contains the name of the virtual network device that tinc uses.
1510
1511 @cindex INTERFACE
1512 @item INTERFACE
1513 Contains the name of the virtual network interface that tinc uses.
1514 This should be used for commands like ifconfig.
1515
1516 @cindex NODE
1517 @item NODE
1518 When a host becomes (un)reachable, this is set to its name.
1519 If a subnet becomes (un)reachable, this is set to the owner of that subnet.
1520
1521 @cindex REMOTEADDRESS
1522 @item REMOTEADDRESS
1523 When a host becomes (un)reachable, this is set to its real address.
1524
1525 @cindex REMOTEPORT
1526 @item REMOTEPORT
1527 When a host becomes (un)reachable,
1528 this is set to the port number it uses for communication with other tinc daemons.
1529
1530 @cindex SUBNET
1531 @item SUBNET
1532 When a subnet becomes (un)reachable, this is set to the subnet.
1533
1534 @cindex WEIGHT
1535 @item WEIGHT
1536 When a subnet becomes (un)reachable, this is set to the subnet weight.
1537
1538 @cindex INVITATION_FILE
1539 @item INVITATION_FILE
1540 When the @file{invitation-created} script is called,
1541 this is set to the file where the invitation details will be stored.
1542
1543 @cindex INVITATION_URL
1544 @item INVITATION_URL
1545 When the @file{invitation-created} script is called,
1546 this is set to the invitation URL that has been created.
1547 @end table
1548
1549 Do not forget that under UNIX operating systems,
1550 you have to make the scripts executable, using the command @samp{chmod a+x script}.
1551
1552
1553 @c ==================================================================
1554 @node       How to configure
1555 @subsection How to configure
1556
1557 @subsubheading Step 1.  Creating initial configuration files.
1558
1559 The initial directory structure, configuration files and public/private keypairs are created using the following command:
1560
1561 @example
1562 tinc -n @var{netname} init @var{name}
1563 @end example
1564
1565 (You will need to run this as root, or use "sudo".)
1566 This will create the configuration directory @file{@value{sysconfdir}/tinc/@var{netname}.},
1567 and inside it will create another directory named @file{hosts/}.
1568 In the configuration directory, it will create the file @file{tinc.conf} with the following contents:
1569
1570 @example
1571 Name = @var{name}
1572 @end example
1573
1574 It will also create private RSA and Ed25519 keys, which will be stored in the files @file{rsa_key.priv} and @file{ed25519_key.priv}.
1575 It will also create a host configuration file @file{hosts/@var{name}},
1576 which will contain the corresponding public RSA and Ed25519 keys.
1577
1578 Finally, on UNIX operating systems, it will create an executable script @file{tinc-up},
1579 which will initially not do anything except warning that you should edit it.
1580
1581 @subsubheading Step 2.  Modifying the initial configuration.
1582
1583 Unless you want to use tinc in switch mode,
1584 you should now configure which range of addresses you will use on the VPN.
1585 Let's assume you will be part of a VPN which uses the address range 192.168.0.0/16,
1586 and you yourself have a smaller portion of that range: 192.168.2.0/24.
1587 Then you should run the following command:
1588
1589 @example
1590 tinc -n @var{netname} add subnet 192.168.2.0/24
1591 @end example
1592
1593 This will add a Subnet statement to your host configuration file.
1594 Try opening the file @file{@value{sysconfdir}/tinc/@var{netname}/hosts/@var{name}} in an editor.
1595 You should now see a file containing the public RSA and Ed25519 keys (which looks like a bunch of random characters),
1596 and the following line at the bottom:
1597
1598 @example
1599 Subnet = 192.168.2.0/24
1600 @end example
1601
1602 If you will use more than one address range, you can add more Subnets.
1603 For example, if you also use the IPv6 subnet fec0:0:0:2::/64, you can add it as well:
1604
1605 @example
1606 tinc -n @var{netname} add subnet fec0:0:0:2::/24
1607 @end example
1608
1609 This will add another line to the file @file{hosts/@var{name}}.
1610 If you make a mistake, you can undo it by simply using @samp{del} instead of @samp{add}.
1611
1612 If you want other tinc daemons to create meta-connections to your daemon,
1613 you should add your public IP address or hostname to your host configuration file.
1614 For example, if your hostname is foo.example.org, run:
1615
1616 @example
1617 tinc -n @var{netname} add address foo.example.org
1618 @end example
1619
1620 If you already know to which daemons your daemon should make meta-connections,
1621 you should configure that now as well.
1622 Suppose you want to connect to a daemon named "bar", run:
1623
1624 @example
1625 tinc -n @var{netname} add connectto bar
1626 @end example
1627
1628 Note that you specify the Name of the other daemon here, not an IP address or hostname!
1629 When you start tinc, and it tries to make a connection to "bar",
1630 it will look for a host configuration file named @file{hosts/bar},
1631 and will read Address statements and public keys from that file.
1632
1633 @subsubheading Step 2.  Exchanging configuration files.
1634
1635 If your daemon has a ConnectTo = bar statement in its @file{tinc.conf} file,
1636 or if bar has a ConnectTo your daemon, then you both need each other's host configuration files.
1637 You should send @file{hosts/@var{name}} to bar, and bar should send you his file which you should move to @file{hosts/bar}.
1638 If you are on a UNIX platform, you can easily send an email containing the necessary information using the following command
1639 (assuming the owner of bar has the email address bar@@example.org):
1640
1641 @example
1642 tinc -n @var{netname} export | mail -s "My config file" bar@@example.org
1643 @end example
1644
1645 If the owner of bar does the same to send his host configuration file to you,
1646 you can probably pipe his email through the following command,
1647 or you can just start this command in a terminal and copy&paste the email:
1648
1649 @example
1650 tinc -n @var{netname} import
1651 @end example
1652
1653 If you are the owner of bar yourself, and you have SSH access to that computer,
1654 you can also swap the host configuration files using the following command:
1655
1656 @example
1657 tinc -n @var{netname} export \
1658     | ssh bar.example.org tinc -n @var{netname} exchange \
1659     | tinc -n @var{netname} import
1660 @end example
1661
1662 You should repeat this for all nodes you ConnectTo, or which ConnectTo you.
1663 However, remember that you do not need to ConnectTo all nodes in the VPN;
1664 it is only necessary to create one or a few meta-connections,
1665 after the connections are made tinc will learn about all the other nodes in the VPN,
1666 and will automatically make other connections as necessary.
1667
1668
1669 @c ==================================================================
1670 @node    Network interfaces
1671 @section Network interfaces
1672
1673 Before tinc can start transmitting data over the tunnel, it must
1674 set up the virtual network interface.
1675
1676 First, decide which IP addresses you want to have associated with these
1677 devices, and what network mask they must have.
1678
1679 Tinc will open a virtual network device (@file{/dev/tun}, @file{/dev/tap0} or similar),
1680 which will also create a network interface called something like @samp{tun0}, @samp{tap0}.
1681 If you are using the Linux tun/tap driver, the network interface will by default have the same name as the @var{netname}.
1682 Under Windows you can change the name of the network interface from the Network Connections control panel.
1683
1684 @cindex tinc-up
1685 You can configure the network interface by putting ordinary ifconfig, route, and other commands
1686 to a script named @file{@value{sysconfdir}/tinc/@var{netname}/tinc-up}.
1687 When tinc starts, this script will be executed. When tinc exits, it will execute the script named
1688 @file{@value{sysconfdir}/tinc/@var{netname}/tinc-down}, but normally you don't need to create that script.
1689 You can manually open the script in an editor, or use the following command:
1690
1691 @example
1692 tinc -n @var{netname} edit tinc-up
1693 @end example
1694
1695 An example @file{tinc-up} script, that would be appropriate for the scenario in the previous section, is:
1696
1697 @example
1698 #!/bin/sh
1699 ifconfig $INTERFACE 192.168.2.1 netmask 255.255.0.0
1700 ip addr add fec0:0:0:2::/48 dev $INTERFACE
1701 @end example
1702
1703 The first command gives the interface an IPv4 address and a netmask.
1704 The kernel will also automatically add an IPv4 route to this interface, so normally you don't need
1705 to add route commands to the @file{tinc-up} script.
1706 The kernel will also bring the interface up after this command.
1707 @cindex netmask
1708 The netmask is the mask of the @emph{entire} VPN network, not just your
1709 own subnet.
1710 The second command gives the interface an IPv6 address and netmask,
1711 which will also automatically add an IPv6 route.
1712 If you only want to use "ip addr" commands on Linux, don't forget that it doesn't bring the interface up, unlike ifconfig,
1713 so you need to add @samp{ip link set $INTERFACE up} in that case.
1714
1715 The exact syntax of the ifconfig and route commands differs from platform to platform.
1716 You can look up the commands for setting addresses and adding routes in @ref{Platform specific information},
1717 but it is best to consult the manpages of those utilities on your platform.
1718
1719
1720 @c ==================================================================
1721 @node    Example configuration
1722 @section Example configuration
1723
1724
1725 @cindex example
1726 Imagine the following situation.  Branch A of our example `company' wants to connect
1727 three branch offices in B, C and D using the Internet.  All four offices
1728 have a 24/7 connection to the Internet.
1729
1730 A is going to serve as the center of the network.  B and C will connect
1731 to A, and D will connect to C.  Each office will be assigned their own IP
1732 network, 10.x.0.0.
1733
1734 @example
1735 A: net 10.1.0.0 mask 255.255.0.0 gateway 10.1.54.1 internet IP 1.2.3.4
1736 B: net 10.2.0.0 mask 255.255.0.0 gateway 10.2.1.12 internet IP 2.3.4.5
1737 C: net 10.3.0.0 mask 255.255.0.0 gateway 10.3.69.254 internet IP 3.4.5.6
1738 D: net 10.4.0.0 mask 255.255.0.0 gateway 10.4.3.32 internet IP 4.5.6.7
1739 @end example
1740
1741 Here, ``gateway'' is the VPN IP address of the machine that is running the
1742 tincd, and ``internet IP'' is the IP address of the firewall, which does not
1743 need to run tincd, but it must do a port forwarding of TCP and UDP on port
1744 655 (unless otherwise configured).
1745
1746 In this example, it is assumed that eth0 is the interface that points to
1747 the inner (physical) LAN of the office, although this could also be the
1748 same as the interface that leads to the Internet.  The configuration of
1749 the real interface is also shown as a comment, to give you an idea of
1750 how these example host is set up. All branches use the netname `company'
1751 for this particular VPN.
1752
1753 Each branch is set up using the @samp{tinc init} and @samp{tinc config} commands,
1754 here we just show the end results:
1755
1756 @subsubheading For Branch A
1757
1758 @emph{BranchA} would be configured like this:
1759
1760 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1761
1762 @example
1763 #!/bin/sh
1764
1765 # Real interface of internal network:
1766 # ifconfig eth0 10.1.54.1 netmask 255.255.0.0
1767
1768 ifconfig $INTERFACE 10.1.54.1 netmask 255.0.0.0
1769 @end example
1770
1771 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1772
1773 @example
1774 Name = BranchA
1775 @end example
1776
1777 On all hosts, @file{@value{sysconfdir}/tinc/company/hosts/BranchA} contains:
1778
1779 @example
1780 Subnet = 10.1.0.0/16
1781 Address = 1.2.3.4
1782
1783 -----BEGIN RSA PUBLIC KEY-----
1784 ...
1785 -----END RSA PUBLIC KEY-----
1786 @end example
1787
1788 Note that the IP addresses of eth0 and the VPN interface are the same.
1789 This is quite possible, if you make sure that the netmasks of the interfaces are different.
1790 It is in fact recommended to give both real internal network interfaces and VPN interfaces the same IP address,
1791 since that will make things a lot easier to remember and set up.
1792
1793
1794 @subsubheading For Branch B
1795
1796 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1797
1798 @example
1799 #!/bin/sh
1800
1801 # Real interface of internal network:
1802 # ifconfig eth0 10.2.43.8 netmask 255.255.0.0
1803
1804 ifconfig $INTERFACE 10.2.1.12 netmask 255.0.0.0
1805 @end example
1806
1807 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1808
1809 @example
1810 Name = BranchB
1811 ConnectTo = BranchA
1812 @end example
1813
1814 Note here that the internal address (on eth0) doesn't have to be the
1815 same as on the VPN interface.  Also, ConnectTo is given so that this node will
1816 always try to connect to BranchA.
1817
1818 On all hosts, in @file{@value{sysconfdir}/tinc/company/hosts/BranchB}:
1819
1820 @example
1821 Subnet = 10.2.0.0/16
1822 Address = 2.3.4.5
1823
1824 -----BEGIN RSA PUBLIC KEY-----
1825 ...
1826 -----END RSA PUBLIC KEY-----
1827 @end example
1828
1829
1830 @subsubheading For Branch C
1831
1832 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1833
1834 @example
1835 #!/bin/sh
1836
1837 # Real interface of internal network:
1838 # ifconfig eth0 10.3.69.254 netmask 255.255.0.0
1839
1840 ifconfig $INTERFACE 10.3.69.254 netmask 255.0.0.0
1841 @end example
1842
1843 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1844
1845 @example
1846 Name = BranchC
1847 ConnectTo = BranchA
1848 @end example
1849
1850 C already has another daemon that runs on port 655, so they have to
1851 reserve another port for tinc. It knows the portnumber it has to listen on
1852 from it's own host configuration file.
1853
1854 On all hosts, in @file{@value{sysconfdir}/tinc/company/hosts/BranchC}:
1855
1856 @example
1857 Address = 3.4.5.6
1858 Subnet = 10.3.0.0/16
1859 Port = 2000
1860
1861 -----BEGIN RSA PUBLIC KEY-----
1862 ...
1863 -----END RSA PUBLIC KEY-----
1864 @end example
1865
1866
1867 @subsubheading For Branch D
1868
1869 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1870
1871 @example
1872 #!/bin/sh
1873
1874 # Real interface of internal network:
1875 # ifconfig eth0 10.4.3.32 netmask 255.255.0.0
1876
1877 ifconfig $INTERFACE 10.4.3.32 netmask 255.0.0.0
1878 @end example
1879
1880 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1881
1882 @example
1883 Name = BranchD
1884 ConnectTo = BranchC
1885 @end example
1886
1887 D will be connecting to C, which has a tincd running for this network on
1888 port 2000. It knows the port number from the host configuration file.
1889
1890 On all hosts, in @file{@value{sysconfdir}/tinc/company/hosts/BranchD}:
1891
1892 @example
1893 Subnet = 10.4.0.0/16
1894 Address = 4.5.6.7
1895
1896 -----BEGIN RSA PUBLIC KEY-----
1897 ...
1898 -----END RSA PUBLIC KEY-----
1899 @end example
1900
1901 @subsubheading Key files
1902
1903 A, B, C and D all have their own public/private keypairs:
1904
1905 The private RSA key is stored in @file{@value{sysconfdir}/tinc/company/rsa_key.priv},
1906 the private Ed25519 key is stored in @file{@value{sysconfdir}/tinc/company/ed25519_key.priv},
1907 and the public RSA and Ed25519 keys are put into the host configuration file in the @file{@value{sysconfdir}/tinc/company/hosts/} directory.
1908
1909 @subsubheading Starting
1910
1911 After each branch has finished configuration and they have distributed
1912 the host configuration files amongst them, they can start their tinc daemons.
1913 They don't necessarily have to wait for the other branches to have started
1914 their daemons, tinc will try connecting until they are available.
1915
1916
1917 @c ==================================================================
1918 @node    Running tinc
1919 @chapter Running tinc
1920
1921 If everything else is done, you can start tinc by typing the following command:
1922
1923 @example
1924 tinc -n @var{netname} start
1925 @end example
1926
1927 @cindex daemon
1928 Tinc will detach from the terminal and continue to run in the background like a good daemon.
1929 If there are any problems however you can try to increase the debug level
1930 and look in the syslog to find out what the problems are.
1931
1932 @menu
1933 * Runtime options::
1934 * Signals::
1935 * Debug levels::
1936 * Solving problems::
1937 * Error messages::
1938 * Sending bug reports::
1939 @end menu
1940
1941
1942 @c ==================================================================
1943 @node    Runtime options
1944 @section Runtime options
1945
1946 Besides the settings in the configuration file, tinc also accepts some
1947 command line options.
1948
1949 @cindex command line
1950 @cindex runtime options
1951 @cindex options
1952 @c from the manpage
1953 @table @option
1954 @item -c, --config=@var{path}
1955 Read configuration options from the directory @var{path}.  The default is
1956 @file{@value{sysconfdir}/tinc/@var{netname}/}.
1957
1958 @item -D, --no-detach
1959 Don't fork and detach.
1960 This will also disable the automatic restart mechanism for fatal errors.
1961
1962 @cindex debug level
1963 @item -d, --debug=@var{level}
1964 Set debug level to @var{level}.  The higher the debug level, the more gets
1965 logged.  Everything goes via syslog.
1966
1967 @item -n, --net=@var{netname}
1968 Use configuration for net @var{netname}.
1969 This will let tinc read all configuration files from
1970 @file{@value{sysconfdir}/tinc/@var{netname}/}.
1971 Specifying . for @var{netname} is the same as not specifying any @var{netname}.
1972 @xref{Multiple networks}.
1973
1974 @item --pidfile=@var{filename}
1975 Store a cookie in @var{filename} which allows tinc to authenticate.
1976 If unspecified, the default is
1977 @file{@value{localstatedir}/run/tinc.@var{netname}.pid}.
1978
1979 @item -o, --option=[@var{HOST}.]@var{KEY}=@var{VALUE}
1980 Without specifying a @var{HOST}, this will set server configuration variable @var{KEY} to @var{VALUE}.
1981 If specified as @var{HOST}.@var{KEY}=@var{VALUE},
1982 this will set the host configuration variable @var{KEY} of the host named @var{HOST} to @var{VALUE}.
1983 This option can be used more than once to specify multiple configuration variables.
1984
1985 @item -L, --mlock
1986 Lock tinc into main memory.
1987 This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.
1988
1989 This option is not supported on all platforms.
1990
1991 @item --logfile[=@var{file}]
1992 Write log entries to a file instead of to the system logging facility.
1993 If @var{file} is omitted, the default is @file{@value{localstatedir}/log/tinc.@var{netname}.log}.
1994
1995 @item --bypass-security
1996 Disables encryption and authentication.
1997 Only useful for debugging.
1998
1999 @item -R, --chroot
2000 Change process root directory to the directory where the config file is
2001 located (@file{@value{sysconfdir}/tinc/@var{netname}/} as determined by
2002 -n/--net option or as given by -c/--config option), for added security.
2003 The chroot is performed after all the initialization is done, after
2004 writing pid files and opening network sockets.
2005
2006 Note that this option alone does not do any good without -U/--user, below.
2007
2008 Note also that tinc can't run scripts anymore (such as tinc-down or host-up),
2009 unless it's setup to be runnable inside chroot environment.
2010
2011 This option is not supported on all platforms.
2012 @item -U, --user=@var{user}
2013 Switch to the given @var{user} after initialization, at the same time as
2014 chroot is performed (see --chroot above).  With this option tinc drops
2015 privileges, for added security.
2016
2017 This option is not supported on all platforms.
2018
2019 @item --help
2020 Display a short reminder of these runtime options and terminate.
2021
2022 @item --version
2023 Output version information and exit.
2024
2025 @end table
2026
2027 @c ==================================================================
2028 @node    Signals
2029 @section Signals
2030
2031 @cindex signals
2032 You can also send the following signals to a running tincd process:
2033
2034 @c from the manpage
2035 @table @samp
2036
2037 @item ALRM
2038 Forces tinc to try to connect to all uplinks immediately.
2039 Usually tinc attempts to do this itself,
2040 but increases the time it waits between the attempts each time it failed,
2041 and if tinc didn't succeed to connect to an uplink the first time after it started,
2042 it defaults to the maximum time of 15 minutes.
2043
2044 @item HUP
2045 Partially rereads configuration files.
2046 Connections to hosts whose host config file are removed are closed.
2047 New outgoing connections specified in @file{tinc.conf} will be made.
2048 If the --logfile option is used, this will also close and reopen the log file,
2049 useful when log rotation is used.
2050
2051 @end table
2052
2053 @c ==================================================================
2054 @node    Debug levels
2055 @section Debug levels
2056
2057 @cindex debug levels
2058 The tinc daemon can send a lot of messages to the syslog.
2059 The higher the debug level, the more messages it will log.
2060 Each level inherits all messages of the previous level:
2061
2062 @c from the manpage
2063 @table @samp
2064
2065 @item 0
2066 This will log a message indicating tinc has started along with a version number.
2067 It will also log any serious error.
2068
2069 @item 1
2070 This will log all connections that are made with other tinc daemons.
2071
2072 @item 2
2073 This will log status and error messages from scripts and other tinc daemons.
2074
2075 @item 3
2076 This will log all requests that are exchanged with other tinc daemons. These include
2077 authentication, key exchange and connection list updates.
2078
2079 @item 4
2080 This will log a copy of everything received on the meta socket.
2081
2082 @item 5
2083 This will log all network traffic over the virtual private network.
2084
2085 @end table
2086
2087 @c ==================================================================
2088 @node    Solving problems
2089 @section Solving problems
2090
2091 If tinc starts without problems, but if the VPN doesn't work, you will have to find the cause of the problem.
2092 The first thing to do is to start tinc with a high debug level in the foreground,
2093 so you can directly see everything tinc logs:
2094
2095 @example
2096 tincd -n @var{netname} -d5 -D
2097 @end example
2098
2099 If tinc does not log any error messages, then you might want to check the following things:
2100
2101 @itemize
2102 @item @file{tinc-up} script
2103 Does this script contain the right commands?
2104 Normally you must give the interface the address of this host on the VPN, and the netmask must be big enough so that the entire VPN is covered.
2105
2106 @item Subnet
2107 Does the Subnet (or Subnets) in the host configuration file of this host match the portion of the VPN that belongs to this host?
2108
2109 @item Firewalls and NATs
2110 Do you have a firewall or a NAT device (a masquerading firewall or perhaps an ADSL router that performs masquerading)?
2111 If so, check that it allows TCP and UDP traffic on port 655.
2112 If it masquerades and the host running tinc is behind it, make sure that it forwards TCP and UDP traffic to port 655 to the host running tinc.
2113 You can add @samp{TCPOnly = yes} to your host config file to force tinc to only use a single TCP connection,
2114 this works through most firewalls and NATs.
2115
2116 @end itemize
2117
2118
2119 @c ==================================================================
2120 @node    Error messages
2121 @section Error messages
2122
2123 What follows is a list of the most common error messages you might find in the logs.
2124 Some of them will only be visible if the debug level is high enough.
2125
2126 @table @samp
2127 @item Could not open /dev/tap0: No such device
2128
2129 @itemize
2130 @item You forgot to `modprobe netlink_dev' or `modprobe ethertap'.
2131 @item You forgot to compile `Netlink device emulation' in the kernel.
2132 @end itemize
2133
2134 @item Can't write to /dev/net/tun: No such device
2135
2136 @itemize
2137 @item You forgot to `modprobe tun'.
2138 @item You forgot to compile `Universal TUN/TAP driver' in the kernel.
2139 @item The tun device is located somewhere else in @file{/dev/}.
2140 @end itemize
2141
2142 @item Network address and prefix length do not match!
2143
2144 @itemize
2145 @item The Subnet field must contain a @emph{network} address, trailing bits should be 0.
2146 @item If you only want to use one IP address, set the netmask to /32.
2147 @end itemize
2148
2149 @item Error reading RSA key file `rsa_key.priv': No such file or directory
2150
2151 @itemize
2152 @item You forgot to create a public/private keypair.
2153 @item Specify the complete pathname to the private key file with the @samp{PrivateKeyFile} option.
2154 @end itemize
2155
2156 @item Warning: insecure file permissions for RSA private key file `rsa_key.priv'!
2157
2158 @itemize
2159 @item The private key file is readable by users other than root.
2160 Use chmod to correct the file permissions.
2161 @end itemize
2162
2163 @item Creating metasocket failed: Address family not supported
2164
2165 @itemize
2166 @item By default tinc tries to create both IPv4 and IPv6 sockets.
2167 On some platforms this might not be implemented.
2168 If the logs show @samp{Ready} later on, then at least one metasocket was created,
2169 and you can ignore this message.
2170 You can add @samp{AddressFamily = ipv4} to @file{tinc.conf} to prevent this from happening.
2171 @end itemize
2172
2173 @item Cannot route packet: unknown IPv4 destination 1.2.3.4
2174
2175 @itemize
2176 @item You try to send traffic to a host on the VPN for which no Subnet is known.
2177 @item If it is a broadcast address (ending in .255), it probably is a samba server or a Windows host sending broadcast packets.
2178 You can ignore it.
2179 @end itemize
2180
2181 @item Cannot route packet: ARP request for unknown address 1.2.3.4
2182
2183 @itemize
2184 @item You try to send traffic to a host on the VPN for which no Subnet is known.
2185 @end itemize
2186
2187 @item Packet with destination 1.2.3.4 is looping back to us!
2188
2189 @itemize
2190 @item Something is not configured right. Packets are being sent out to the
2191 virtual network device, but according to the Subnet directives in your host configuration
2192 file, those packets should go to your own host. Most common mistake is that
2193 you have a Subnet line in your host configuration file with a prefix length which is
2194 just as large as the prefix of the virtual network interface. The latter should in almost all
2195 cases be larger. Rethink your configuration.
2196 Note that you will only see this message if you specified a debug
2197 level of 5 or higher!
2198 @item Chances are that a @samp{Subnet = ...} line in the host configuration file of this tinc daemon is wrong.
2199 Change it to a subnet that is accepted locally by another interface,
2200 or if that is not the case, try changing the prefix length into /32.
2201 @end itemize
2202
2203 @item Node foo (1.2.3.4) is not reachable
2204
2205 @itemize
2206 @item Node foo does not have a connection anymore, its tinc daemon is not running or its connection to the Internet is broken.
2207 @end itemize
2208
2209 @item Received UDP packet from unknown source 1.2.3.4 (port 12345)
2210
2211 @itemize
2212 @item If you see this only sporadically, it is harmless and caused by a node sending packets using an old key.
2213 @item If you see this often and another node is not reachable anymore, then a NAT (masquerading firewall) is changing the source address of UDP packets.
2214 You can add @samp{TCPOnly = yes} to host configuration files to force all VPN traffic to go over a TCP connection.
2215 @end itemize
2216
2217 @item Got bad/bogus/unauthorized REQUEST from foo (1.2.3.4 port 12345)
2218
2219 @itemize
2220 @item Node foo does not have the right public/private keypair.
2221 Generate new keypairs and distribute them again.
2222 @item An attacker tries to gain access to your VPN.
2223 @item A network error caused corruption of metadata sent from foo.
2224 @end itemize
2225
2226 @end table
2227
2228 @c ==================================================================
2229 @node    Sending bug reports
2230 @section Sending bug reports
2231
2232 If you really can't find the cause of a problem, or if you suspect tinc is not working right,
2233 you can send us a bugreport, see @ref{Contact information}.
2234 Be sure to include the following information in your bugreport:
2235
2236 @itemize
2237 @item A clear description of what you are trying to achieve and what the problem is.
2238 @item What platform (operating system, version, hardware architecture) and which version of tinc you use.
2239 @item If compiling tinc fails, a copy of @file{config.log} and the error messages you get.
2240 @item Otherwise, a copy of @file{tinc.conf}, @file{tinc-up} and all files in the @file{hosts/} directory.
2241 @item The output of the commands @samp{ifconfig -a} and @samp{route -n} (or @samp{netstat -rn} if that doesn't work).
2242 @item The output of any command that fails to work as it should (like ping or traceroute).
2243 @end itemize
2244
2245 @c ==================================================================
2246 @node    Controlling tinc
2247 @chapter Controlling tinc
2248
2249 @cindex command line interface
2250 You can start, stop, control and inspect a running tincd through the tinc
2251 command. A quick example:
2252
2253 @example
2254 tinc -n @var{netname} reload
2255 @end example
2256
2257 @cindex shell
2258 If tinc is started without a command, it will act as a shell; it will display a
2259 prompt, and commands can be entered on the prompt. If tinc is compiled with
2260 libreadline, history and command completion are available on the prompt. One
2261 can also pipe a script containing commands through tinc. In that case, lines
2262 starting with a # symbol will be ignored.
2263
2264 @menu
2265 * tinc runtime options::
2266 * tinc environment variables::
2267 * tinc commands::
2268 * tinc examples::
2269 * tinc top::
2270 @end menu
2271
2272
2273 @c ==================================================================
2274 @node    tinc runtime options
2275 @section tinc runtime options
2276
2277 @c from the manpage
2278 @table @option
2279 @item -c, --config=@var{path}
2280 Read configuration options from the directory @var{path}.  The default is
2281 @file{@value{sysconfdir}/tinc/@var{netname}/}.
2282
2283 @item -n, --net=@var{netname}
2284 Use configuration for net @var{netname}. @xref{Multiple networks}.
2285
2286 @item --pidfile=@var{filename}
2287 Use the cookie from @var{filename} to authenticate with a running tinc daemon.
2288 If unspecified, the default is
2289 @file{@value{localstatedir}/run/tinc.@var{netname}.pid}.
2290
2291 @item --force
2292 Force some commands to work despite warnings.
2293
2294 @item --help
2295 Display a short reminder of runtime options and commands, then terminate.
2296
2297 @item --version
2298 Output version information and exit.
2299
2300 @end table
2301
2302 @c ==================================================================
2303 @node    tinc environment variables
2304 @section tinc environment variables
2305
2306 @table @env
2307 @cindex NETNAME
2308 @item NETNAME
2309 If no netname is specified on the command line with the @option{-n} option,
2310 the value of this environment variable is used.
2311 @end table
2312
2313 @c ==================================================================
2314 @node    tinc commands
2315 @section tinc commands
2316
2317 @c from the manpage
2318 @table @code
2319
2320 @cindex init
2321 @item init [@var{name}]
2322 Create initial configuration files and RSA and Ed25519 keypairs with default length.
2323 If no @var{name} for this node is given, it will be asked for.
2324
2325 @cindex get
2326 @item get @var{variable}
2327 Print the current value of configuration variable @var{variable}.
2328 If more than one variable with the same name exists,
2329 the value of each of them will be printed on a separate line.
2330
2331 @cindex set
2332 @item set @var{variable} @var{value}
2333 Set configuration variable @var{variable} to the given @var{value}.
2334 All previously existing configuration variables with the same name are removed.
2335 To set a variable for a specific host, use the notation @var{host}.@var{variable}.
2336
2337 @cindex add
2338 @item add @var{variable} @var{value}
2339 As above, but without removing any previously existing configuration variables.
2340 If the variable already exists with the given value, nothing happens.
2341
2342 @cindex del
2343 @item del @var{variable} [@var{value}]
2344 Remove configuration variables with the same name and @var{value}.
2345 If no @var{value} is given, all configuration variables with the same name will be removed.
2346
2347 @cindex edit
2348 @item edit @var{filename}
2349 Start an editor for the given configuration file.
2350 You do not need to specify the full path to the file.
2351
2352 @cindex export
2353 @item export
2354 Export the host configuration file of the local node to standard output.
2355
2356 @cindex export-all
2357 @item export-all
2358 Export all host configuration files to standard output.
2359
2360 @cindex import
2361 @item import
2362 Import host configuration file(s) generated by the tinc export command from standard input.
2363 Already existing host configuration files are not overwritten unless the option --force is used.
2364
2365 @cindex exchange
2366 @item exchange
2367 The same as export followed by import.
2368
2369 @cindex exchange-all
2370 @item exchange-all
2371 The same as export-all followed by import.
2372
2373 @cindex invite
2374 @item invite @var{name}
2375 Prepares an invitation for a new node with the given @var{name},
2376 and prints a short invitation URL that can be used with the join command.
2377
2378 @cindex join
2379 @item join [@var{URL}]
2380 Join an existing VPN using an invitation URL created using the invite command.
2381 If no @var{URL} is given, it will be read from standard input.
2382
2383 @cindex start
2384 @item start [tincd options]
2385 Start @samp{tincd}, optionally with the given extra options.
2386
2387 @cindex stop
2388 @item stop
2389 Stop @samp{tincd}.
2390
2391 @cindex restart
2392 @item restart [tincd options]
2393 Restart @samp{tincd}, optionally with the given extra options.
2394
2395 @cindex reload
2396 @item reload
2397 Partially rereads configuration files. Connections to hosts whose host
2398 config files are removed are closed. New outgoing connections specified
2399 in @file{tinc.conf} will be made.
2400
2401 @cindex pid
2402 @item pid
2403 Shows the PID of the currently running @samp{tincd}.
2404
2405 @cindex generate-keys
2406 @item generate-keys [@var{bits}]
2407 Generate both RSA and Ed25519 keypairs (see below) and exit.
2408 tinc will ask where you want to store the files, but will default to the
2409 configuration directory (you can use the -c or -n option).
2410
2411 @cindex generate-ed25519-keys
2412 @item generate-ed25519-keys
2413 Generate public/private Ed25519 keypair and exit.
2414
2415 @cindex generate-rsa-keys
2416 @item generate-rsa-keys [@var{bits}]
2417 Generate public/private RSA keypair and exit.  If @var{bits} is omitted, the
2418 default length will be 2048 bits.  When saving keys to existing files, tinc
2419 will not delete the old keys; you have to remove them manually.
2420
2421 @cindex dump
2422 @item dump [reachable] nodes
2423 Dump a list of all known nodes in the VPN.
2424 If the reachable keyword is used, only lists reachable nodes.
2425
2426 @item dump edges
2427 Dump a list of all known connections in the VPN.
2428
2429 @item dump subnets
2430 Dump a list of all known subnets in the VPN.
2431
2432 @item dump connections
2433 Dump a list of all meta connections with ourself.
2434
2435 @cindex graph
2436 @item dump graph | digraph
2437 Dump a graph of the VPN in dotty format.
2438 Nodes are colored according to their reachability:
2439 red nodes are unreachable, orange nodes are indirectly reachable, green nodes are directly reachable.
2440 Black nodes are either directly or indirectly reachable, but direct reachability has not been tried yet.
2441
2442 @item dump invitations
2443 Dump a list of outstanding invitations.
2444 The filename of the invitation, as well as the name of the node that is being invited is shown for each invitation.
2445
2446 @cindex info
2447 @item info @var{node} | @var{subnet} | @var{address}
2448 Show information about a particular @var{node}, @var{subnet} or @var{address}.
2449 If an @var{address} is given, any matching subnet will be shown.
2450
2451 @cindex purge
2452 @item purge
2453 Purges all information remembered about unreachable nodes.
2454
2455 @cindex debug
2456 @item debug @var{level}
2457 Sets debug level to @var{level}.
2458
2459 @cindex log
2460 @item log [@var{level}]
2461 Capture log messages from a running tinc daemon.
2462 An optional debug level can be given that will be applied only for log messages sent to tinc.
2463
2464 @cindex retry
2465 @item retry
2466 Forces tinc to try to connect to all uplinks immediately.
2467 Usually tinc attempts to do this itself,
2468 but increases the time it waits between the attempts each time it failed,
2469 and if tinc didn't succeed to connect to an uplink the first time after it started,
2470 it defaults to the maximum time of 15 minutes.
2471
2472 @cindex disconnect
2473 @item disconnect @var{node}
2474 Closes the meta connection with the given @var{node}.
2475
2476 @cindex top
2477 @item top
2478 If tinc is compiled with libcurses support, this will display live traffic statistics for all the known nodes,
2479 similar to the UNIX top command.
2480 See below for more information.
2481
2482 @cindex pcap
2483 @item pcap
2484 Dump VPN traffic going through the local tinc node in pcap-savefile format to standard output,
2485 from where it can be redirected to a file or piped through a program that can parse it directly,
2486 such as tcpdump.
2487
2488 @cindex network
2489 @item network [@var{netname}]
2490 If @var{netname} is given, switch to that network.
2491 Otherwise, display a list of all networks for which configuration files exist.
2492
2493 @cindex fsck
2494 @item fsck
2495 This will check the configuration files for possible problems,
2496 such as unsafe file permissions, missing executable bit on script,
2497 unknown and obsolete configuration variables, wrong public and/or private keys, and so on.
2498
2499 When problems are found, this will be printed on a line with WARNING or ERROR in front of it.
2500 Most problems must be corrected by the user itself, however in some cases (like file permissions and missing public keys),
2501 tinc will ask if it should fix the problem.
2502
2503 @cindex sign
2504 @item sign [@var{filename}]
2505 Sign a file with the local node's private key.
2506 If no @var{filename} is given, the file is read from standard input.
2507 The signed file is written to standard output.
2508
2509 @cindex verify
2510 @item verify @var{name} [@var{filename}]
2511
2512 Check the signature of a file against a node's public key.
2513 The @var{name} of the node must be given,
2514 or can be "." to check against the local node's public key,
2515 or "*" to allow a signature from any node whose public key is known.
2516 If no @var{filename} is given, the file is read from standard input.
2517 If the verification is succesful, a copy of the input with the signature removed is written to standard output, and the exit code will be zero.
2518 If the verification failed, nothing will be written to standard output, and the exit code will be non-zero.
2519
2520 @end table
2521
2522 @c ==================================================================
2523 @node    tinc examples
2524 @section tinc examples
2525
2526 Examples of some commands:
2527
2528 @example
2529 tinc -n vpn dump graph | circo -Txlib
2530 tinc -n vpn pcap | tcpdump -r -
2531 tinc -n vpn top
2532 @end example
2533
2534 Examples of changing the configuration using tinc:
2535
2536 @example
2537 tinc -n vpn init foo
2538 tinc -n vpn add Subnet 192.168.1.0/24
2539 tinc -n vpn add bar.Address bar.example.com
2540 tinc -n vpn add ConnectTo bar
2541 tinc -n vpn export | gpg --clearsign | mail -s "My config" vpnmaster@@example.com
2542 @end example
2543
2544 @c ==================================================================
2545 @node    tinc top
2546 @section tinc top
2547
2548 @cindex top
2549 The top command connects to a running tinc daemon and repeatedly queries its per-node traffic counters.
2550 It displays a list of all the known nodes in the left-most column,
2551 and the amount of bytes and packets read from and sent to each node in the other columns.
2552 By default, the information is updated every second.
2553 The behaviour of the top command can be changed using the following keys:
2554
2555 @table @key
2556
2557 @item s
2558 Change the interval between updates.
2559 After pressing the @key{s} key, enter the desired interval in seconds, followed by enter.
2560 Fractional seconds are honored.
2561 Intervals lower than 0.1 seconds are not allowed.
2562
2563 @item c
2564 Toggle between displaying current traffic rates (in packets and bytes per second)
2565 and cummulative traffic (total packets and bytes since the tinc daemon started).
2566
2567 @item n
2568 Sort the list of nodes by name.
2569
2570 @item i
2571 Sort the list of nodes by incoming amount of bytes.
2572
2573 @item I
2574 Sort the list of nodes by incoming amount of packets.
2575
2576 @item o
2577 Sort the list of nodes by outgoing amount of bytes.
2578
2579 @item O
2580 Sort the list of nodes by outgoing amount of packets.
2581
2582 @item t
2583 Sort the list of nodes by sum of incoming and outgoing amount of bytes.
2584
2585 @item T
2586 Sort the list of nodes by sum of incoming and outgoing amount of packets.
2587
2588 @item b
2589 Show amount of traffic in bytes.
2590
2591 @item k
2592 Show amount of traffic in kilobytes.
2593
2594 @item M
2595 Show amount of traffic in megabytes.
2596
2597 @item G
2598 Show amount of traffic in gigabytes.
2599
2600 @item q
2601 Quit.
2602
2603 @end table
2604
2605
2606 @c ==================================================================
2607 @node    Invitations
2608 @chapter Invitations
2609
2610 Invitations are an easy way to add new nodes to an existing VPN.  Invitations
2611 can be created on an existing node using the @code{tinc invite} command, which
2612 generates a relatively short URL which can be given to someone else, who uses
2613 the @code{tinc join} command to automatically set up tinc so it can connect to
2614 the inviting node.  The next sections describe how invitations actually work,
2615 and how to further automate the invitations.
2616
2617 @menu
2618 * How invitations work::
2619 * Invitation file format::
2620 * Writing an invitation-created script::
2621 @end menu
2622
2623
2624 @c ==================================================================
2625 @node    How invitations work
2626 @section How invitations work
2627
2628 When an invitation is created on a node (which from now on we will call the
2629 server) using the @code{tinc invite} command, an invitation file is created
2630 that contains all the information necessary for the invitee (which we will call
2631 the client) to create its configuration files. The invitation file is stays on
2632 the server, but a URL is generated that has enough information for the client
2633 to contact the server and to retrieve the invitation file. The whole URL is
2634 around 80 characters long and looks like this:
2635
2636 @example
2637 server.example.org:12345/cW1NhLHS-1WPFlcFio8ztYHvewTTKYZp8BjEKg3vbMtDz7w4
2638 @end example
2639
2640 It is composed of four parts:
2641
2642 @example
2643 hostname : port / keyhash cookie
2644 @end example
2645
2646 The hostname and port tell the client how to reach the tinc daemon on the server.
2647 The part after the slash looks like one blob, but is composed of two parts.
2648 The keyhash is the hash of the public key of the server.
2649 The cookie is a shared secret that identifies the client to the server.
2650
2651 When the client connects to the server in order to join the VPN, the client and
2652 server will exchange temporary public keys. The client verifies that the hash
2653 of the server's public key matches the keyhash from the invitation URL. If
2654 not, it will immediately exit with an error. Otherwise, an ECDH exchange will
2655 happen so the client and server can communicate privately with each other. The
2656 client will then present the cookie to the server. The server uses this to
2657 look up the corresponding invitation file it generated earlier. If it exists,
2658 it will send the invitation file to the client. The client will also create a
2659 permanent public key, and send it to the server. After the exchange is
2660 completed, the connection is broken. The server creates a host config file for
2661 the client containing the client's permanent public key, and the client creates
2662 tinc.conf, host config files and possibly a tinc-up script based on the
2663 information in the invitation file.
2664
2665 It is important that the invitation URL is kept secret until it is used; if
2666 another person gets a copy of the invitation URL before the real client runs
2667 the @code{tinc join} command, then that other person can try to join the VPN.
2668
2669
2670 @c ==================================================================
2671 @node    Invitation file format
2672 @section Invitation file format
2673
2674 The contents of an invitation file that is generated by the @code{tinc invite}
2675 command looks like this:
2676
2677 @example
2678 Name = client
2679 Netname = vpn
2680 ConnectTo = server
2681 #-------------------------------------#
2682 Name = server
2683 Ed25519PublicKey = augbnwegoij123587...
2684 Address = server.example.com
2685 @end example
2686
2687 The file is basically a concatenation of several host config blocks. Each host
2688 config block starts with @code{Name = ...}.  Lines that look like @code{#---#}
2689 are not important, it just makes it easier for humans to read the file.
2690
2691 The first host config block is always the one representing the invitee. So the
2692 first Name statement determines the name that the invitee will get. From the
2693 first block, the @file{tinc.conf} and @file{hosts/client} files will be
2694 generated; the @code{tinc join} command on the client will automatically
2695 separate statements based on whether they should be in @file{tinc.conf} or in a
2696 host config file. Some statements are special and are treated differently:
2697
2698 @table @asis
2699 @item Netname = <@var{netname}>
2700 This is a hint to the invitee which netname to use for the VPN.  It is used if
2701 the invitee did not already specify a netname, and if there is no pre-existing
2702 configuration with the same netname.
2703
2704 @cindex Ifconfig
2705 @item Ifconfig = <@var{address}[/@var{netmask}] | dhcp | dhcp6 | slaac>
2706 This is a hint for generating a @file{tinc-up} script.
2707 If an address is specified, a command will be added to @file{tinc-up} so the VPN interface will be configured to have the given address.
2708 If it is the word "dhcp", a command will be added to start a DHCP client on the VPN interface.
2709 If it is the word dhcpv6, it will be a DHCPv6 client.
2710 If it is "slaac", then it will add commands to enable IPv6 stateless address autoconfiguration.
2711 It is also possible to specify a MAC address, in which case a command will be added to set the MAC address of the VPN interface.
2712
2713 The exact commands added to the @file{tinc-up} script depends on the operating system the client is using.
2714 Multiple Ifconfig statements can be specified, however one should only use one Ifconfig statement per address family.
2715
2716 @cindex Route
2717 @item Route = <@var{address}[/@var{netmask}]> [<@var{gateway}>]
2718 This is a hint for generating a @file{tinc-up} script.
2719 Route statements are similar to Ifconfig statements, but add routes instead of addresses.
2720 These only allow IPv4 and IPv6 routes.
2721 If no gateway address is specified, the route is directed to the VPN interface.
2722 In general, a gateway is only necessary when running tinc in switch mode.
2723 @end table
2724
2725 Subsequent host config blocks are copied verbatim into their respective files
2726 in @file{hosts/}. The invitation file generated by @code{tinc invite} will
2727 normally only contain two blocks; one for the client and one for the server.
2728
2729
2730 @c ==================================================================
2731 @node    Writing an invitation-created script
2732 @section Writing an invitation-created script
2733
2734 When an invitation is generated, the "invitation-created" script is called (if
2735 it exists) right after the invitation file is written, but before the URL has
2736 been written to stdout. This allows one to change the invitation file
2737 automatically before the invitation URL is passed to the invitee. Here is an
2738 example shell script that aproximately recreates the default invitation file:
2739
2740 @example
2741 #!/bin/sh
2742
2743 cat >$INVITATION_FILE <<EOF
2744 Name = $NODE
2745 Netname = $NETNAME
2746 ConnectTo = $NAME
2747 #----------------#
2748 EOF
2749
2750 tinc export >>$INVITATION_FILE
2751 @end example
2752
2753 You can add more ConnectTo statements, and change `tinc export` to `tinc
2754 export-all` for example. But you can also use the script to automatically hand
2755 out a Subnet to the invitee. Note that the script doesn't have to be a shell script,
2756 you can use any language, it just has to be executable.
2757
2758
2759 @c ==================================================================
2760 @node    Technical information
2761 @chapter Technical information
2762
2763
2764 @menu
2765 * The connection::
2766 * The meta-protocol::
2767 * Security::
2768 @end menu
2769
2770
2771 @c ==================================================================
2772 @node    The connection
2773 @section The connection
2774
2775 @cindex connection
2776 Tinc is a daemon that takes VPN data and transmit that to another host
2777 computer over the existing Internet infrastructure.
2778
2779 @menu
2780 * The UDP tunnel::
2781 * The meta-connection::
2782 @end menu
2783
2784
2785 @c ==================================================================
2786 @node    The UDP tunnel
2787 @subsection The UDP tunnel
2788
2789 @cindex virtual network device
2790 @cindex frame type
2791 The data itself is read from a character device file, the so-called
2792 @emph{virtual network device}.  This device is associated with a network
2793 interface.  Any data sent to this interface can be read from the device,
2794 and any data written to the device gets sent from the interface.
2795 There are two possible types of virtual network devices:
2796 `tun' style, which are point-to-point devices which can only handle IPv4 and/or IPv6 packets,
2797 and `tap' style, which are Ethernet devices and handle complete Ethernet frames.
2798
2799 So when tinc reads an Ethernet frame from the device, it determines its
2800 type. When tinc is in it's default routing mode, it can handle IPv4 and IPv6
2801 packets. Depending on the Subnet lines, it will send the packets off to their destination IP address.
2802 In the `switch' and `hub' mode, tinc will use broadcasts and MAC address discovery
2803 to deduce the destination of the packets.
2804 Since the latter modes only depend on the link layer information,
2805 any protocol that runs over Ethernet is supported (for instance IPX and Appletalk).
2806 However, only `tap' style devices provide this information.
2807
2808 After the destination has been determined,
2809 the packet will be compressed (optionally),
2810 a sequence number will be added to the packet,
2811 the packet will then be encrypted
2812 and a message authentication code will be appended.
2813
2814 @cindex encapsulating
2815 @cindex UDP
2816 When that is done, time has come to actually transport the
2817 packet to the destination computer.  We do this by sending the packet
2818 over an UDP connection to the destination host.  This is called
2819 @emph{encapsulating}, the VPN packet (though now encrypted) is
2820 encapsulated in another IP datagram.
2821
2822 When the destination receives this packet, the same thing happens, only
2823 in reverse.  So it checks the message authentication code, decrypts the contents of the UDP datagram,
2824 checks the sequence number
2825 and writes the decrypted information to its own virtual network device.
2826
2827 If the virtual network device is a `tun' device (a point-to-point tunnel),
2828 there is no problem for the kernel to accept a packet.
2829 However, if it is a `tap' device (this is the only available type on FreeBSD),
2830 the destination MAC address must match that of the virtual network interface.
2831 If tinc is in it's default routing mode, ARP does not work, so the correct destination MAC
2832 can not be known by the sending host.
2833 Tinc solves this by letting the receiving end detect the MAC address of its own virtual network interface
2834 and overwriting the destination MAC address of the received packet.
2835
2836 In switch or hub modes ARP does work so the sender already knows the correct destination MAC address.
2837 In those modes every interface should have a unique MAC address, so make sure they are not the same.
2838 Because switch and hub modes rely on MAC addresses to function correctly,
2839 these modes cannot be used on the following operating systems which don't have a `tap' style virtual network device:
2840 OpenBSD, NetBSD, Darwin and Solaris.
2841
2842
2843 @c ==================================================================
2844 @node    The meta-connection
2845 @subsection The meta-connection
2846
2847 Having only a UDP connection available is not enough.  Though suitable
2848 for transmitting data, we want to be able to reliably send other
2849 information, such as routing and session key information to somebody.
2850
2851 @cindex TCP
2852 TCP is a better alternative, because it already contains protection
2853 against information being lost, unlike UDP.
2854
2855 So we establish two connections.  One for the encrypted VPN data, and one
2856 for other information, the meta-data.  Hence, we call the second
2857 connection the meta-connection.  We can now be sure that the
2858 meta-information doesn't get lost on the way to another computer.
2859
2860 @cindex data-protocol
2861 @cindex meta-protocol
2862 Like with any communication, we must have a protocol, so that everybody
2863 knows what everything stands for, and how she should react.  Because we
2864 have two connections, we also have two protocols.  The protocol used for
2865 the UDP data is the ``data-protocol,'' the other one is the
2866 ``meta-protocol.''
2867
2868 The reason we don't use TCP for both protocols is that UDP is much
2869 better for encapsulation, even while it is less reliable.  The real
2870 problem is that when TCP would be used to encapsulate a TCP stream
2871 that's on the private network, for every packet sent there would be
2872 three ACKs sent instead of just one.  Furthermore, if there would be
2873 a timeout, both TCP streams would sense the timeout, and both would
2874 start re-sending packets.
2875
2876
2877 @c ==================================================================
2878 @node    The meta-protocol
2879 @section The meta-protocol
2880
2881 The meta protocol is used to tie all tinc daemons together, and
2882 exchange information about which tinc daemon serves which virtual
2883 subnet.
2884
2885 The meta protocol consists of requests that can be sent to the other
2886 side.  Each request has a unique number and several parameters.  All
2887 requests are represented in the standard ASCII character set.  It is
2888 possible to use tools such as telnet or netcat to connect to a tinc
2889 daemon started with the --bypass-security option
2890 and to read and write requests by hand, provided that one
2891 understands the numeric codes sent.
2892
2893 The authentication scheme is described in @ref{Security}. After a
2894 successful authentication, the server and the client will exchange all the
2895 information about other tinc daemons and subnets they know of, so that both
2896 sides (and all the other tinc daemons behind them) have their information
2897 synchronised.
2898
2899 @cindex ADD_EDGE
2900 @cindex ADD_SUBNET
2901 @example
2902 message
2903 ------------------------------------------------------------------
2904 ADD_EDGE node1 node2 21.32.43.54 655 222 0
2905           |     |        |       |   |  +-> options
2906           |     |        |       |   +----> weight
2907           |     |        |       +--------> UDP port of node2
2908           |     |        +----------------> real address of node2
2909           |     +-------------------------> name of destination node
2910           +-------------------------------> name of source node
2911
2912 ADD_SUBNET node 192.168.1.0/24
2913             |         |     +--> prefixlength
2914             |         +--------> network address
2915             +------------------> owner of this subnet
2916 ------------------------------------------------------------------
2917 @end example
2918
2919 The ADD_EDGE messages are to inform other tinc daemons that a connection between
2920 two nodes exist. The address of the destination node is available so that
2921 VPN packets can be sent directly to that node.
2922
2923 The ADD_SUBNET messages inform other tinc daemons that certain subnets belong
2924 to certain nodes. tinc will use it to determine to which node a VPN packet has
2925 to be sent.
2926
2927 @cindex DEL_EDGE
2928 @cindex DEL_SUBNET
2929 @example
2930 message
2931 ------------------------------------------------------------------
2932 DEL_EDGE node1 node2
2933            |     +----> name of destination node
2934            +----------> name of source node
2935
2936 DEL_SUBNET node 192.168.1.0/24
2937              |         |     +--> prefixlength
2938              |         +--------> network address
2939              +------------------> owner of this subnet
2940 ------------------------------------------------------------------
2941 @end example
2942
2943 In case a connection between two daemons is closed or broken, DEL_EDGE messages
2944 are sent to inform the other daemons of that fact. Each daemon will calculate a
2945 new route to the the daemons, or mark them unreachable if there isn't any.
2946
2947 @cindex REQ_KEY
2948 @cindex ANS_KEY
2949 @cindex KEY_CHANGED
2950 @example
2951 message
2952 ------------------------------------------------------------------
2953 REQ_KEY origin destination
2954            |       +--> name of the tinc daemon it wants the key from
2955            +----------> name of the daemon that wants the key
2956
2957 ANS_KEY origin destination 4ae0b0a82d6e0078 91 64 4
2958            |       |       \______________/ |  |  +--> MAC length
2959            |       |               |        |  +-----> digest algorithm
2960            |       |               |        +--------> cipher algorithm
2961            |       |               +--> 128 bits key
2962            |       +--> name of the daemon that wants the key
2963            +----------> name of the daemon that uses this key
2964
2965 KEY_CHANGED origin
2966               +--> daemon that has changed it's packet key
2967 ------------------------------------------------------------------
2968 @end example
2969
2970 The keys used to encrypt VPN packets are not sent out directly. This is
2971 because it would generate a lot of traffic on VPNs with many daemons, and
2972 chances are that not every tinc daemon will ever send a packet to every
2973 other daemon. Instead, if a daemon needs a key it sends a request for it
2974 via the meta connection of the nearest hop in the direction of the
2975 destination.
2976
2977 @cindex PING
2978 @cindex PONG
2979 @example
2980 daemon  message
2981 ------------------------------------------------------------------
2982 origin  PING
2983 dest.   PONG
2984 ------------------------------------------------------------------
2985 @end example
2986
2987 There is also a mechanism to check if hosts are still alive. Since network
2988 failures or a crash can cause a daemon to be killed without properly
2989 shutting down the TCP connection, this is necessary to keep an up to date
2990 connection list. PINGs are sent at regular intervals, except when there
2991 is also some other traffic. A little bit of salt (random data) is added
2992 with each PING and PONG message, to make sure that long sequences of PING/PONG
2993 messages without any other traffic won't result in known plaintext.
2994
2995 This basically covers what is sent over the meta connection by tinc.
2996
2997
2998 @c ==================================================================
2999 @node    Security
3000 @section Security
3001
3002 @cindex TINC
3003 @cindex Cabal
3004 Tinc got its name from ``TINC,'' short for @emph{There Is No Cabal}; the
3005 alleged Cabal was/is an organisation that was said to keep an eye on the
3006 entire Internet.  As this is exactly what you @emph{don't} want, we named
3007 the tinc project after TINC.
3008
3009 @cindex SVPN
3010 But in order to be ``immune'' to eavesdropping, you'll have to encrypt
3011 your data. Because tinc is a @emph{Secure} VPN (SVPN) daemon, it does
3012 exactly that: encrypt.
3013 However, encryption in itself does not prevent an attacker from modifying the encrypted data.
3014 Therefore, tinc also authenticates the data.
3015 Finally, tinc uses sequence numbers (which themselves are also authenticated) to prevent an attacker from replaying valid packets.
3016
3017 Since version 1.1pre3, tinc has two protocols used to protect your data; the legacy protocol, and the new Simple Peer-to-Peer Security (SPTPS) protocol.
3018 The SPTPS protocol is designed to address some weaknesses in the legacy protocol.
3019 The new authentication protocol is used when two nodes connect to each other that both have the ExperimentalProtocol option set to yes,
3020 otherwise the legacy protocol will be used.
3021
3022 @menu
3023 * Legacy authentication protocol::
3024 * Simple Peer-to-Peer Security::
3025 * Encryption of network packets::
3026 * Security issues::
3027 @end menu
3028
3029
3030 @c ==================================================================
3031 @node       Legacy authentication protocol
3032 @subsection Legacy authentication protocol
3033
3034 @cindex legacy authentication protocol
3035
3036 @cindex ID
3037 @cindex META_KEY
3038 @cindex CHALLENGE
3039 @cindex CHAL_REPLY
3040 @cindex ACK
3041 @example
3042 daemon  message
3043 --------------------------------------------------------------------------
3044 client  <attempts connection>
3045
3046 server  <accepts connection>
3047
3048 client  ID client 17.2
3049               |   |  +-> minor protocol version
3050               |   +----> major protocol version
3051               +--------> name of tinc daemon
3052
3053 server  ID server 17.2
3054               |   |  +-> minor protocol version
3055               |   +----> major protocol version
3056               +--------> name of tinc daemon
3057
3058 client  META_KEY 94 64 0 0 5f0823a93e35b69e...7086ec7866ce582b
3059                  |  |  | | \_________________________________/
3060                  |  |  | |                 +-> RSAKEYLEN bits totally random string S1,
3061                  |  |  | |                     encrypted with server's public RSA key
3062                  |  |  | +-> compression level
3063                  |  |  +---> MAC length
3064                  |  +------> digest algorithm NID
3065                  +---------> cipher algorithm NID
3066
3067 server  META_KEY 94 64 0 0 6ab9c1640388f8f0...45d1a07f8a672630
3068                  |  |  | | \_________________________________/
3069                  |  |  | |                 +-> RSAKEYLEN bits totally random string S2,
3070                  |  |  | |                     encrypted with client's public RSA key
3071                  |  |  | +-> compression level
3072                  |  |  +---> MAC length
3073                  |  +------> digest algorithm NID
3074                  +---------> cipher algorithm NID
3075 --------------------------------------------------------------------------
3076 @end example
3077
3078 The protocol allows each side to specify encryption algorithms and parameters,
3079 but in practice they are always fixed, since older versions of tinc did not
3080 allow them to be different from the default values. The cipher is always
3081 Blowfish in OFB mode, the digest is SHA1, but the MAC length is zero and no
3082 compression is used.
3083
3084 From now on:
3085 @itemize
3086 @item the client will symmetrically encrypt outgoing traffic using S1
3087 @item the server will symmetrically encrypt outgoing traffic using S2
3088 @end itemize
3089
3090 @example
3091 --------------------------------------------------------------------------
3092 client  CHALLENGE da02add1817c1920989ba6ae2a49cecbda0
3093                   \_________________________________/
3094                                  +-> CHALLEN bits totally random string H1
3095
3096 server  CHALLENGE 57fb4b2ccd70d6bb35a64c142f47e61d57f
3097                   \_________________________________/
3098                                  +-> CHALLEN bits totally random string H2
3099
3100 client  CHAL_REPLY 816a86
3101                       +-> 160 bits SHA1 of H2
3102
3103 server  CHAL_REPLY 928ffe
3104                       +-> 160 bits SHA1 of H1
3105
3106 After the correct challenge replies are received, both ends have proved
3107 their identity. Further information is exchanged.
3108
3109 client  ACK 655 123 0
3110              |   |  +-> options
3111              |   +----> estimated weight
3112              +--------> listening port of client
3113
3114 server  ACK 655 321 0
3115              |   |  +-> options
3116              |   +----> estimated weight
3117              +--------> listening port of server
3118 --------------------------------------------------------------------------
3119 @end example
3120
3121 This legacy authentication protocol has several weaknesses, pointed out by security export Peter Gutmann.
3122 First, data is encrypted with RSA without padding.
3123 Padding schemes are designed to prevent attacks when the size of the plaintext is not equal to the size of the RSA key.
3124 Tinc always encrypts random nonces that have the same size as the RSA key, so we do not believe this leads to a break of the security.
3125 There might be timing or other side-channel attacks against RSA encryption and decryption, tinc does not employ any protection against those.
3126 Furthermore, both sides send identical messages to each other, there is no distinction between server and client,
3127 which could make a MITM attack easier.
3128 However, no exploit is known in which a third party who is not already trusted by other nodes in the VPN could gain access.
3129 Finally, the RSA keys are used to directly encrypt the session keys, which means that if the RSA keys are compromised, it is possible to decrypt all previous VPN traffic.
3130 In other words, the legacy protocol does not provide perfect forward secrecy.
3131
3132 @c ==================================================================
3133 @node       Simple Peer-to-Peer Security
3134 @subsection Simple Peer-to-Peer Security
3135 @cindex SPTPS
3136
3137 The SPTPS protocol is designed to address the weaknesses in the legacy protocol.
3138 SPTPS is based on TLS 1.2, but has been simplified: there is no support for exchanging public keys, and there is no cipher suite negotiation.
3139 Instead, SPTPS always uses a very strong cipher suite:
3140 peers authenticate each other using 521 bits ECC keys,
3141 Diffie-Hellman using ephemeral 521 bits ECC keys is used to provide perfect forward secrecy (PFS),
3142 AES-256-CTR is used for encryption, and HMAC-SHA-256 for message authentication.
3143
3144 Similar to TLS, messages are split up in records.
3145 A complete logical record contains the following information:
3146
3147 @itemize
3148 @item uint32_t seqno (network byte order)
3149 @item uint16_t length (network byte order)
3150 @item uint8_t type
3151 @item opaque data[length]
3152 @item opaque hmac[HMAC_SIZE] (HMAC over all preceding fields)
3153 @end itemize
3154
3155 Depending on whether SPTPS records are sent via TCP or UDP, either the seqno or the length field is omitted on the wire
3156 (but they are still included in the calculation of the HMAC);
3157 for TCP packets are guaranteed to arrive in-order so we can infer the seqno, but packets can be split or merged, so we still need the length field to determine the boundaries between records;
3158 for UDP packets we know that there is exactly one record per packet, and we know the length of a packet, but packets can be dropped, duplicated and/or reordered, so we need to include the seqno.
3159
3160 The type field is used to distinguish between application records or handshake records.
3161 Types 0 to 127 are application records, type 128 is a handshake record, and types 129 to 255 are reserved.
3162
3163 Before the initial handshake, no fields are encrypted, and the HMAC field is not present.
3164 After the authentication handshake, the length (if present), type and data fields are encrypted, and the HMAC field is present.
3165 For UDP packets, the seqno field is not encrypted, as it is used to determine the value of the counter used for encryption.
3166
3167 The authentication consists of an exchange of Key EXchange, SIGnature and ACKnowledge messages, transmitted using type 128 records.
3168
3169 Overview:
3170
3171 @example
3172 Initiator   Responder
3173 ---------------------
3174 KEX ->
3175             <- KEX
3176 SIG ->
3177             <- SIG
3178
3179 ...encrypt and HMAC using session keys from now on...
3180
3181 App ->
3182             <- App
3183 ...
3184             ...
3185
3186 ...key renegotiation starts here...
3187
3188 KEX ->
3189             <- KEX
3190 SIG ->
3191             <- SIG
3192 ACK ->
3193             <- ACK
3194
3195 ...encrypt and HMAC using new session keys from now on...
3196
3197 App ->
3198             <- App
3199 ...
3200             ...
3201 ---------------------
3202 @end example
3203
3204 Note that the responder does not need to wait before it receives the first KEX message,
3205 it can immediately send its own once it has accepted an incoming connection.
3206
3207 Key EXchange message:
3208
3209 @itemize
3210 @item uint8_t kex_version (always 0 in this version of SPTPS)
3211 @item opaque nonce[32] (random number)
3212 @item opaque ecdh_key[ECDH_SIZE]
3213 @end itemize
3214
3215 SIGnature message:
3216
3217 @itemize
3218 @item opaque ecdsa_signature[ECDSA_SIZE]
3219 @end itemize
3220
3221 ACKnowledge message:
3222
3223 @itemize
3224 @item empty (only sent after key renegotiation)
3225 @end itemize
3226
3227 Remarks:
3228
3229 @itemize
3230 @item At the start, both peers generate a random nonce and an Elliptic Curve public key and send it to the other in the KEX message.
3231 @item After receiving the other's KEX message, both KEX messages are concatenated (see below),
3232   and the result is signed using ECDSA.
3233   The result is sent to the other.
3234 @item After receiving the other's SIG message, the signature is verified.
3235   If it is correct, the shared secret is calculated from the public keys exchanged in the KEX message using the Elliptic Curve Diffie-Helman algorithm.
3236 @item The shared secret key is expanded using a PRF.
3237   Both nonces and the application specific label are also used as input for the PRF.
3238 @item An ACK message is sent only when doing key renegotiation, and is sent using the old encryption keys.
3239 @item The expanded key is used to key the encryption and HMAC algorithms.
3240 @end itemize
3241
3242 The signature is calculated over this string:
3243
3244 @itemize
3245 @item uint8_t initiator (0 = local peer, 1 = remote peer is initiator)
3246 @item opaque remote_kex_message[1 + 32 + ECDH_SIZE]
3247 @item opaque local_kex_message[1 + 32 + ECDH_SIZE]
3248 @item opaque label[label_length]
3249 @end itemize
3250
3251 The PRF is calculated as follows:
3252
3253 @itemize
3254 @item A HMAC using SHA512 is used, the shared secret is used as the key.
3255 @item For each block of 64 bytes, a HMAC is calculated. For block n: hmac[n] =
3256   HMAC_SHA512(hmac[n - 1] + seed)
3257 @item For the first block (n = 1), hmac[0] is given by HMAC_SHA512(zeroes + seed),
3258   where zeroes is a block of 64 zero bytes.
3259 @end itemize
3260
3261 The seed is as follows:
3262
3263 @itemize
3264 @item const char[13] "key expansion"
3265 @item opaque responder_nonce[32]
3266 @item opaque initiator_nonce[32]
3267 @item opaque label[label_length]
3268 @end itemize
3269
3270 The expanded key is used as follows:
3271
3272 @itemize
3273 @item opaque responder_cipher_key[CIPHER_KEYSIZE]
3274 @item opaque responder_digest_key[DIGEST_KEYSIZE]
3275 @item opaque initiator_cipher_key[CIPHER_KEYSIZE]
3276 @item opaque initiator_digest_key[DIGEST_KEYSIZE]
3277 @end itemize
3278
3279 Where initiator_cipher_key is the key used by session initiator to encrypt
3280 messages sent to the responder.
3281
3282 When using 256 bits Ed25519 keys, the AES-256-CTR cipher and HMAC-SHA-256 digest algorithm,
3283 the sizes are as follows:
3284
3285 @example
3286 ECDH_SIZE:       32 (= 256/8)
3287 ECDSA_SIZE:      64 (= 2 * 256/8)
3288 CIPHER_KEYSIZE:  48 (= 256/8 + 128/8)
3289 DIGEST_KEYSIZE:  32 (= 256/8)
3290 @end example
3291
3292 Note that the cipher key also includes the initial value for the counter.
3293
3294 @c ==================================================================
3295 @node       Encryption of network packets
3296 @subsection Encryption of network packets
3297 @cindex encryption
3298
3299 A data packet can only be sent if the encryption key is known to both
3300 parties, and the connection is  activated. If the encryption key is not
3301 known, a request is sent to the destination using the meta connection
3302 to retrieve it.
3303
3304 @cindex UDP
3305 The UDP packets can be either encrypted with the legacy protocol or with SPTPS.
3306 In case of the legacy protocol, the UDP packet containing the network packet from the VPN has the following layout:
3307
3308 @example
3309 ... | IP header | UDP header | seqno | VPN packet | MAC | UDP trailer
3310                              \___________________/\_____/
3311                                        |             |
3312                                        V             +---> digest algorithm
3313                          Encrypted with symmetric cipher
3314 @end example
3315
3316
3317
3318
3319 So, the entire VPN packet is encrypted using a symmetric cipher, including a 32 bits
3320 sequence number that is added in front of the actual VPN packet, to act as a unique
3321 IV for each packet and to prevent replay attacks. A message authentication code
3322 is added to the UDP packet to prevent alteration of packets.
3323 Tinc by default encrypts network packets using Blowfish with 128 bit keys in CBC mode
3324 and uses 4 byte long message authentication codes to make sure
3325 eavesdroppers cannot get and cannot change any information at all from the
3326 packets they can intercept. The encryption algorithm and message authentication
3327 algorithm can be changed in the configuration. The length of the message
3328 authentication codes is also adjustable. The length of the key for the
3329 encryption algorithm is always the default length used by LibreSSL/OpenSSL.
3330
3331 The SPTPS protocol is described in @ref{Simple Peer-to-Peer Security}.
3332 For comparison, this is how SPTPS UDP packets look:
3333
3334 @example
3335 ... | IP header | UDP header | seqno | type | VPN packet | MAC | UDP trailer
3336                                      \__________________/\_____/
3337                                                |            |
3338                                                V            +---> digest algorithm
3339                                  Encrypted with symmetric cipher
3340 @end example
3341
3342 The difference is that the seqno is not encrypted, since the encryption cipher is used in CTR mode,
3343 and therefore the seqno must be known before the packet can be decrypted.
3344 Furthermore, the MAC is never truncated.
3345 The SPTPS protocol always uses the AES-256-CTR cipher and HMAC-SHA-256 digest,
3346 this cannot be changed.
3347
3348
3349 @c ==================================================================
3350 @node    Security issues
3351 @subsection Security issues
3352
3353 In August 2000, we discovered the existence of a security hole in all versions
3354 of tinc up to and including 1.0pre2. This had to do with the way we exchanged
3355 keys. Since then, we have been working on a new authentication scheme to make
3356 tinc as secure as possible. The current version uses the LibreSSL or OpenSSL library and
3357 uses strong authentication with RSA keys.
3358
3359 On the 29th of December 2001, Jerome Etienne posted a security analysis of tinc
3360 1.0pre4. Due to a lack of sequence numbers and a message authentication code
3361 for each packet, an attacker could possibly disrupt certain network services or
3362 launch a denial of service attack by replaying intercepted packets. The current
3363 version adds sequence numbers and message authentication codes to prevent such
3364 attacks.
3365
3366 On the 15th of September 2003, Peter Gutmann posted a security analysis of tinc
3367 1.0.1. He argues that the 32 bit sequence number used by tinc is not a good IV,
3368 that tinc's default length of 4 bytes for the MAC is too short, and he doesn't
3369 like tinc's use of RSA during authentication. We do not know of a security hole
3370 in the legacy protocol of tinc, but it is not as strong as TLS or IPsec.
3371
3372 This version of tinc comes with an improved protocol, called Simple Peer-to-Peer Security,
3373 which aims to be as strong as TLS with one of the strongest cipher suites.
3374
3375 Cryptography is a hard thing to get right. We cannot make any
3376 guarantees. Time, review and feedback are the only things that can
3377 prove the security of any cryptographic product. If you wish to review
3378 tinc or give us feedback, you are stronly encouraged to do so.
3379
3380
3381 @c ==================================================================
3382 @node    Platform specific information
3383 @chapter Platform specific information
3384
3385 @menu
3386 * Interface configuration::
3387 * Routes::
3388 @end menu
3389
3390 @c ==================================================================
3391 @node    Interface configuration
3392 @section Interface configuration
3393
3394 When configuring an interface, one normally assigns it an address and a
3395 netmask.  The address uniquely identifies the host on the network attached to
3396 the interface.  The netmask, combined with the address, forms a subnet.  It is
3397 used to add a route to the routing table instructing the kernel to send all
3398 packets which fall into that subnet to that interface.  Because all packets for
3399 the entire VPN should go to the virtual network interface used by tinc, the
3400 netmask should be such that it encompasses the entire VPN.
3401
3402 For IPv4 addresses:
3403
3404 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
3405 @item Linux
3406 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
3407 @item Linux iproute2
3408 @tab @code{ip addr add} @var{address}@code{/}@var{prefixlength} @code{dev} @var{interface}
3409 @item FreeBSD
3410 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
3411 @item OpenBSD
3412 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
3413 @item NetBSD
3414 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
3415 @item Solaris
3416 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
3417 @item Darwin (MacOS/X)
3418 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
3419 @item Windows
3420 @tab @code{netsh interface ip set address} @var{interface} @code{static} @var{address} @var{netmask}
3421 @end multitable
3422
3423 For IPv6 addresses:
3424
3425 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
3426 @item Linux
3427 @tab @code{ifconfig} @var{interface} @code{add} @var{address}@code{/}@var{prefixlength}
3428 @item FreeBSD
3429 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
3430 @item OpenBSD
3431 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
3432 @item NetBSD
3433 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
3434 @item Solaris
3435 @tab @code{ifconfig} @var{interface} @code{inet6 plumb up}
3436 @item
3437 @tab @code{ifconfig} @var{interface} @code{inet6 addif} @var{address} @var{address}
3438 @item Darwin (MacOS/X)
3439 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
3440 @item Windows
3441 @tab @code{netsh interface ipv6 add address} @var{interface} @code{static} @var{address}/@var{prefixlength}
3442 @end multitable
3443
3444 On some platforms, when running tinc in switch mode, the VPN interface must be set to tap mode with an ifconfig command:
3445
3446 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
3447 @item OpenBSD
3448 @tab @code{ifconfig} @var{interface} @code{link0}
3449 @end multitable
3450
3451 On Linux, it is possible to create a persistent tun/tap interface which will
3452 continue to exist even if tinc quit, although this is normally not required.
3453 It can be useful to set up a tun/tap interface owned by a non-root user, so
3454 tinc can be started without needing any root privileges at all.
3455
3456 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
3457 @item Linux
3458 @tab @code{ip tuntap add dev} @var{interface} @code{mode} @var{tun|tap} @code{user} @var{username}
3459 @end multitable
3460
3461 @c ==================================================================
3462 @node    Routes
3463 @section Routes
3464
3465 In some cases it might be necessary to add more routes to the virtual network
3466 interface.  There are two ways to indicate which interface a packet should go
3467 to, one is to use the name of the interface itself, another way is to specify
3468 the (local) address that is assigned to that interface (@var{local_address}). The
3469 former way is unambiguous and therefore preferable, but not all platforms
3470 support this.
3471
3472 Adding routes to IPv4 subnets:
3473
3474 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
3475 @item Linux
3476 @tab @code{route add -net} @var{network_address} @code{netmask} @var{netmask} @var{interface}
3477 @item Linux iproute2
3478 @tab @code{ip route add} @var{network_address}@code{/}@var{prefixlength} @code{dev} @var{interface}
3479 @item FreeBSD
3480 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
3481 @item OpenBSD
3482 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
3483 @item NetBSD
3484 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
3485 @item Solaris
3486 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address} @code{-interface}
3487 @item Darwin (MacOS/X)
3488 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
3489 @item Windows
3490 @tab @code{netsh routing ip add persistentroute} @var{network_address} @var{netmask} @var{interface} @var{local_address}
3491 @end multitable
3492
3493 Adding routes to IPv6 subnets:
3494
3495 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
3496 @item Linux
3497 @tab @code{route add -A inet6} @var{network_address}@code{/}@var{prefixlength} @var{interface}
3498 @item Linux iproute2
3499 @tab @code{ip route add} @var{network_address}@code{/}@var{prefixlength} @code{dev} @var{interface}
3500 @item FreeBSD
3501 @tab @code{route add -inet6} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
3502 @item OpenBSD
3503 @tab @code{route add -inet6} @var{network_address} @var{local_address} @code{-prefixlen} @var{prefixlength}
3504 @item NetBSD
3505 @tab @code{route add -inet6} @var{network_address} @var{local_address} @code{-prefixlen} @var{prefixlength}
3506 @item Solaris
3507 @tab @code{route add -inet6} @var{network_address}@code{/}@var{prefixlength} @var{local_address} @code{-interface}
3508 @item Darwin (MacOS/X)
3509 @tab ?
3510 @item Windows
3511 @tab @code{netsh interface ipv6 add route} @var{network address}/@var{prefixlength} @var{interface}
3512 @end multitable
3513
3514
3515 @c ==================================================================
3516 @node    About us
3517 @chapter About us
3518
3519
3520 @menu
3521 * Contact information::
3522 * Authors::
3523 @end menu
3524
3525
3526 @c ==================================================================
3527 @node    Contact information
3528 @section Contact information
3529
3530 @cindex website
3531 Tinc's website is at @url{https://www.tinc-vpn.org/},
3532 this server is located in the Netherlands.
3533
3534 @cindex IRC
3535 We have an IRC channel on the FreeNode and OFTC IRC networks. Connect to
3536 @uref{https://freenode.net/, irc.freenode.net}
3537 or
3538 @uref{https://www.oftc.net/, irc.oftc.net}
3539 and join channel #tinc.
3540
3541
3542 @c ==================================================================
3543 @node    Authors
3544 @section Authors
3545
3546 @table @asis
3547 @item Ivo Timmermans (zarq)
3548 @item Guus Sliepen (guus) (@email{guus@@tinc-vpn.org})
3549 @end table
3550
3551 We have received a lot of valuable input from users.  With their help,
3552 tinc has become the flexible and robust tool that it is today.  We have
3553 composed a list of contributions, in the file called @file{THANKS} in
3554 the source distribution.
3555
3556
3557 @c ==================================================================
3558 @node    Concept Index
3559 @unnumbered Concept Index
3560
3561 @c ==================================================================
3562 @printindex cp
3563
3564
3565 @c ==================================================================
3566 @contents
3567 @bye