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