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