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