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