Cache node IDs in a hash table for faster lookups.
[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-2014 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-2014 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 don 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 ConnectTo
888 @item ConnectTo = <@var{name}>
889 Specifies which other tinc daemon to connect to on startup.
890 Multiple ConnectTo variables may be specified,
891 in which case outgoing connections to each specified tinc daemon are made.
892 The names should be known to this tinc daemon
893 (i.e., there should be a host configuration file for the name on the ConnectTo line).
894
895 If you don't specify a host with ConnectTo and don't enable AutoConnect,
896 tinc won't try to connect to other daemons at all,
897 and will instead just listen for incoming connections.
898
899 @cindex DecrementTTL
900 @item DecrementTTL = <yes | no> (no) [experimental]
901 When enabled, tinc will decrement the Time To Live field in IPv4 packets, or the Hop Limit field in IPv6 packets,
902 before forwarding a received packet to the virtual network device or to another node,
903 and will drop packets that have a TTL value of zero,
904 in which case it will send an ICMP Time Exceeded packet back.
905
906 Do not use this option if you use switch mode and want to use IPv6.
907
908 @cindex Device
909 @item Device = <@var{device}> (@file{/dev/tap0}, @file{/dev/net/tun} or other depending on platform)
910 The virtual network device to use.
911 Tinc will automatically detect what kind of device it is.
912 Note that you can only use one device per daemon.
913 Under Windows, use @var{Interface} instead of @var{Device}.
914 Note that you can only use one device per daemon.
915 See also @ref{Device files}.
916
917 @cindex DeviceType
918 @item DeviceType = <@var{type}> (platform dependent)
919 The type of the virtual network device.
920 Tinc will normally automatically select the right type of tun/tap interface, and this option should not be used.
921 However, this option can be used to select one of the special interface types, if support for them is compiled in.
922
923 @table @asis
924 @cindex dummy
925 @item dummy
926 Use a dummy interface.
927 No packets are ever read or written to a virtual network device.
928 Useful for testing, or when setting up a node that only forwards packets for other nodes.
929
930 @cindex raw_socket
931 @item raw_socket
932 Open a raw socket, and bind it to a pre-existing
933 @var{Interface} (eth0 by default).
934 All packets are read from this interface.
935 Packets received for the local node are written to the raw socket.
936 However, at least on Linux, the operating system does not process IP packets destined for the local host.
937
938 @cindex multicast
939 @item multicast
940 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}.
941 Packets are read from and written to this multicast socket.
942 This can be used to connect to UML, QEMU or KVM instances listening on the same multicast address.
943 Do NOT connect multiple tinc daemons to the same multicast address, this will very likely cause routing loops.
944 Also note that this can cause decrypted VPN packets to be sent out on a real network if misconfigured.
945
946 @cindex UML
947 @item uml (not compiled in by default)
948 Create a UNIX socket with the filename specified by
949 @var{Device}, or @file{@value{localstatedir}/run/@var{netname}.umlsocket}
950 if not specified.
951 Tinc will wait for a User Mode Linux instance to connect to this socket.
952
953 @cindex VDE
954 @item vde (not compiled in by default)
955 Uses the libvdeplug library to connect to a Virtual Distributed Ethernet switch,
956 using the UNIX socket specified by
957 @var{Device}, or @file{@value{localstatedir}/run/vde.ctl}
958 if not specified.
959 @end table
960
961 Also, in case tinc does not seem to correctly interpret packets received from the virtual network device,
962 it can be used to change the way packets are interpreted:
963
964 @table @asis
965 @item tun (BSD and Linux)
966 Set type to tun.
967 Depending on the platform, this can either be with or without an address family header (see below).
968
969 @cindex tunnohead
970 @item tunnohead (BSD)
971 Set type to tun without an address family header.
972 Tinc will expect packets read from the virtual network device to start with an IP header.
973 On some platforms IPv6 packets cannot be read from or written to the device in this mode.
974
975 @cindex tunifhead
976 @item tunifhead (BSD)
977 Set type to tun with an address family header.
978 Tinc will expect packets read from the virtual network device
979 to start with a four byte header containing the address family,
980 followed by an IP header.
981 This mode should support both IPv4 and IPv6 packets.
982
983 @item tap (BSD and Linux)
984 Set type to tap.
985 Tinc will expect packets read from the virtual network device
986 to start with an Ethernet header.
987 @end table
988
989 @cindex DirectOnly
990 @item DirectOnly = <yes|no> (no) [experimental]
991 When this option is enabled, packets that cannot be sent directly to the destination node,
992 but which would have to be forwarded by an intermediate node, are dropped instead.
993 When combined with the IndirectData option,
994 packets for nodes for which we do not have a meta connection with are also dropped.
995
996 @cindex Ed25519PrivateKeyFile
997 @item Ed25519PrivateKeyFile = <@var{path}> (@file{@value{sysconfdir}/tinc/@var{netname}/ed25519_key.priv})
998 The file in which the private Ed25519 key of this tinc daemon resides.
999 This is only used if ExperimentalProtocol is enabled.
1000
1001 @cindex ExperimentalProtocol
1002 @item ExperimentalProtocol = <yes|no> (yes)
1003 When this option is enabled, the SPTPS protocol will be used when connecting to nodes that also support it.
1004 Ephemeral ECDH will be used for key exchanges,
1005 and Ed25519 will be used instead of RSA for authentication.
1006 When enabled, an Ed25519 key must have been generated before with
1007 @samp{tinc generate-ed25519-keys}.
1008
1009 @cindex Forwarding
1010 @item Forwarding = <off|internal|kernel> (internal) [experimental]
1011 This option selects the way indirect packets are forwarded.
1012
1013 @table @asis
1014 @item off
1015 Incoming packets that are not meant for the local node,
1016 but which should be forwarded to another node, are dropped.
1017
1018 @item internal
1019 Incoming packets that are meant for another node are forwarded by tinc internally.
1020
1021 This is the default mode, and unless you really know you need another forwarding mode, don't change it.
1022
1023 @item kernel
1024 Incoming packets are always sent to the TUN/TAP device, even if the packets are not for the local node.
1025 This is less efficient, but allows the kernel to apply its routing and firewall rules on them,
1026 and can also help debugging.
1027 @end table
1028
1029 @cindex Hostnames
1030 @item Hostnames = <yes|no> (no)
1031 This option selects whether IP addresses (both real and on the VPN)
1032 should be resolved.  Since DNS lookups are blocking, it might affect
1033 tinc's efficiency, even stopping the daemon for a few seconds everytime
1034 it does a lookup if your DNS server is not responding.
1035
1036 This does not affect resolving hostnames to IP addresses from the
1037 configuration file, but whether hostnames should be resolved while logging.
1038
1039 @cindex Interface
1040 @item Interface = <@var{interface}>
1041 Defines the name of the interface corresponding to the virtual network device.
1042 Depending on the operating system and the type of device this may or may not actually set the name of the interface.
1043 Under Windows, this variable is used to select which network interface will be used.
1044 If you specified a Device, this variable is almost always already correctly set.
1045
1046 @cindex ListenAddress
1047 @item ListenAddress = <@var{address}> [<@var{port}>]
1048 If your computer has more than one IPv4 or IPv6 address, tinc
1049 will by default listen on all of them for incoming connections.
1050 This option can be used to restrict which addresses tinc listens on.
1051 Multiple ListenAddress variables may be specified,
1052 in which case listening sockets for each specified address are made.
1053
1054 If no @var{port} is specified, the socket will listen on the port specified by the Port option,
1055 or to port 655 if neither is given.
1056 To only listen on a specific port but not to a specific address, use "*" for the @var{address}.
1057
1058 @cindex LocalDiscovery
1059 @item LocalDiscovery = <yes | no> (no)
1060 When enabled, tinc will try to detect peers that are on the same local network.
1061 This will allow direct communication using LAN addresses, even if both peers are behind a NAT
1062 and they only ConnectTo a third node outside the NAT,
1063 which normally would prevent the peers from learning each other's LAN address.
1064
1065 Currently, local discovery is implemented by sending broadcast packets to the LAN during path MTU discovery.
1066 This feature may not work in all possible situations.
1067
1068 @cindex LocalDiscoveryAddress
1069 @item LocalDiscoveryAddress <@var{address}>
1070 If this variable is specified, local discovery packets are sent to the given @var{address}.
1071
1072 @cindex Mode
1073 @item Mode = <router|switch|hub> (router)
1074 This option selects the way packets are routed to other daemons.
1075
1076 @table @asis
1077 @cindex router
1078 @item router
1079 In this mode Subnet
1080 variables in the host configuration files will be used to form a routing table.
1081 Only packets of routable protocols (IPv4 and IPv6) are supported in this mode.
1082
1083 This is the default mode, and unless you really know you need another mode, don't change it.
1084
1085 @cindex switch
1086 @item switch
1087 In this mode the MAC addresses of the packets on the VPN will be used to
1088 dynamically create a routing table just like an Ethernet switch does.
1089 Unicast, multicast and broadcast packets of every protocol that runs over Ethernet are supported in this mode
1090 at the cost of frequent broadcast ARP requests and routing table updates.
1091
1092 This mode is primarily useful if you want to bridge Ethernet segments.
1093
1094 @cindex hub
1095 @item hub
1096 This mode is almost the same as the switch mode, but instead
1097 every packet will be broadcast to the other daemons
1098 while no routing table is managed.
1099 @end table
1100
1101 @cindex KeyExpire
1102 @item KeyExpire = <@var{seconds}> (3600)
1103 This option controls the time the encryption keys used to encrypt the data
1104 are valid.  It is common practice to change keys at regular intervals to
1105 make it even harder for crackers, even though it is thought to be nearly
1106 impossible to crack a single key.
1107
1108 @cindex MACExpire
1109 @item MACExpire = <@var{seconds}> (600)
1110 This option controls the amount of time MAC addresses are kept before they are removed.
1111 This only has effect when Mode is set to "switch".
1112
1113 @cindex MaxConnectionBurst
1114 @item MaxConnectionBurst = <@var{count}> (100)
1115 This option controls how many connections tinc accepts in quick succession.
1116 If there are more connections than the given number in a short time interval,
1117 tinc will reduce the number of accepted connections to only one per second,
1118 until the burst has passed.
1119
1120 @cindex Name
1121 @item Name = <@var{name}> [required]
1122 This is a symbolic name for this connection.
1123 The name should consist only of alfanumeric and underscore characters (a-z, A-Z, 0-9 and _), and is case sensitive.
1124
1125 If Name starts with a $, then the contents of the environment variable that follows will be used.
1126 In that case, invalid characters will be converted to underscores.
1127 If Name is $HOST, but no such environment variable exist,
1128 the hostname will be read using the gethostname() system call.
1129
1130 @cindex PingInterval
1131 @item PingInterval = <@var{seconds}> (60)
1132 The number of seconds of inactivity that tinc will wait before sending a
1133 probe to the other end.
1134
1135 @cindex PingTimeout
1136 @item PingTimeout = <@var{seconds}> (5)
1137 The number of seconds to wait for a response to pings or to allow meta
1138 connections to block. If the other end doesn't respond within this time,
1139 the connection is terminated, and the others will be notified of this.
1140
1141 @cindex PriorityInheritance
1142 @item PriorityInheritance = <yes|no> (no) [experimental]
1143 When this option is enabled the value of the TOS field of tunneled IPv4 packets
1144 will be inherited by the UDP packets that are sent out.
1145
1146 @cindex PrivateKey
1147 @item PrivateKey = <@var{key}> [obsolete]
1148 This is the RSA private key for tinc. However, for safety reasons it is
1149 advised to store private keys of any kind in separate files. This prevents
1150 accidental eavesdropping if you are editting the configuration file.
1151
1152 @cindex PrivateKeyFile
1153 @item PrivateKeyFile = <@var{path}> (@file{@value{sysconfdir}/tinc/@var{netname}/rsa_key.priv})
1154 This is the full path name of the RSA private key file that was
1155 generated by @samp{tinc generate-keys}.  It must be a full path, not a
1156 relative directory.
1157
1158 @cindex ProcessPriority
1159 @item ProcessPriority = <low|normal|high>
1160 When this option is used the priority of the tincd process will be adjusted.
1161 Increasing the priority may help to reduce latency and packet loss on the VPN.
1162
1163 @cindex Proxy
1164 @item Proxy = socks4 | socks5 | http | exec @var{...} [experimental]
1165 Use a proxy when making outgoing connections.
1166 The following proxy types are currently supported:
1167
1168 @table @asis
1169 @cindex socks4
1170 @item socks4 <@var{address}> <@var{port}> [<@var{username}>]
1171 Connects to the proxy using the SOCKS version 4 protocol.
1172 Optionally, a @var{username} can be supplied which will be passed on to the proxy server.
1173
1174 @cindex socks5
1175 @item socks5 <@var{address}> <@var{port}> [<@var{username}> <@var{password}>]
1176 Connect to the proxy using the SOCKS version 5 protocol.
1177 If a @var{username} and @var{password} are given, basic username/password authentication will be used,
1178 otherwise no authentication will be used.
1179
1180 @cindex http
1181 @item http <@var{address}> <@var{port}>
1182 Connects to the proxy and sends a HTTP CONNECT request.
1183
1184 @cindex exec
1185 @item exec <@var{command}>
1186 Executes the given command which should set up the outgoing connection.
1187 The environment variables @env{NAME}, @env{NODE}, @env{REMOTEADDRES} and @env{REMOTEPORT} are available.
1188 @end table
1189
1190 @cindex ReplayWindow
1191 @item ReplayWindow = <bytes> (16)
1192 This is the size of the replay tracking window for each remote node, in bytes.
1193 The window is a bitfield which tracks 1 packet per bit, so for example
1194 the default setting of 16 will track up to 128 packets in the window. In high
1195 bandwidth scenarios, setting this to a higher value can reduce packet loss from
1196 the interaction of replay tracking with underlying real packet loss and/or
1197 reordering. Setting this to zero will disable replay tracking completely and
1198 pass all traffic, but leaves tinc vulnerable to replay-based attacks on your
1199 traffic.
1200
1201 @cindex StrictSubnets
1202 @item StrictSubnets = <yes|no> (no) [experimental]
1203 When this option is enabled tinc will only use Subnet statements which are
1204 present in the host config files in the local
1205 @file{@value{sysconfdir}/tinc/@var{netname}/hosts/} directory.
1206 Subnets learned via connections to other nodes and which are not
1207 present in the local host config files are ignored.
1208
1209 @cindex TunnelServer
1210 @item TunnelServer = <yes|no> (no) [experimental]
1211 When this option is enabled tinc will no longer forward information between other tinc daemons,
1212 and will only allow connections with nodes for which host config files are present in the local
1213 @file{@value{sysconfdir}/tinc/@var{netname}/hosts/} directory.
1214 Setting this options also implicitly sets StrictSubnets.
1215
1216 @cindex UDPRcvBuf
1217 @item UDPRcvBuf = <bytes> (OS default)
1218 Sets the socket receive buffer size for the UDP socket, in bytes.
1219 If unset, the default buffer size will be used by the operating system.
1220
1221 @cindex UDPSndBuf
1222 @item UDPSndBuf = <bytes> Pq OS default
1223 Sets the socket send buffer size for the UDP socket, in bytes.
1224 If unset, the default buffer size will be used by the operating system.
1225
1226 @end table
1227
1228
1229 @c ==================================================================
1230 @node       Host configuration variables
1231 @subsection Host configuration variables
1232
1233 @table @asis
1234 @cindex Address
1235 @item Address = <@var{IP address}|@var{hostname}> [<port>] [recommended]
1236 This variable is only required if you want to connect to this host.  It
1237 must resolve to the external IP address where the host can be reached,
1238 not the one that is internal to the VPN.
1239 If no port is specified, the default Port is used.
1240 Multiple Address variables can be specified, in which case each address will be
1241 tried until a working connection has been established.
1242
1243 @cindex Cipher
1244 @item Cipher = <@var{cipher}> (blowfish)
1245 The symmetric cipher algorithm used to encrypt UDP packets using the legacy protocol.
1246 Any cipher supported by OpenSSL is recognized.
1247 Furthermore, specifying "none" will turn off packet encryption.
1248 It is best to use only those ciphers which support CBC mode.
1249 This option has no effect for connections using the SPTPS protocol, which always use AES-256-CTR.
1250
1251 @cindex ClampMSS
1252 @item ClampMSS = <yes|no> (yes)
1253 This option specifies whether tinc should clamp the maximum segment size (MSS)
1254 of TCP packets to the path MTU. This helps in situations where ICMP
1255 Fragmentation Needed or Packet too Big messages are dropped by firewalls.
1256
1257 @cindex Compression
1258 @item Compression = <@var{level}> (0)
1259 This option sets the level of compression used for UDP packets.
1260 Possible values are 0 (off), 1 (fast zlib) and any integer up to 9 (best zlib),
1261 10 (fast lzo) and 11 (best lzo).
1262
1263 @cindex Digest
1264 @item Digest = <@var{digest}> (sha1)
1265 The digest algorithm used to authenticate UDP packets using the legacy protocol.
1266 Any digest supported by OpenSSL is recognized.
1267 Furthermore, specifying "none" will turn off packet authentication.
1268 This option has no effect for connections using the SPTPS protocol, which always use HMAC-SHA-256.
1269
1270 @cindex IndirectData
1271 @item IndirectData = <yes|no> (no)
1272 When set to yes, other nodes which do not already have a meta connection to you
1273 will not try to establish direct communication with you.
1274 It is best to leave this option out or set it to no.
1275
1276 @cindex MACLength
1277 @item MACLength = <@var{bytes}> (4)
1278 The length of the message authentication code used to authenticate UDP packets using the legacy protocol.
1279 Can be anything from 0
1280 up to the length of the digest produced by the digest algorithm.
1281 This option has no effect for connections using the SPTPS protocol, which never truncate MACs.
1282
1283 @cindex PMTU
1284 @item PMTU = <@var{mtu}> (1514)
1285 This option controls the initial path MTU to this node.
1286
1287 @cindex PMTUDiscovery
1288 @item PMTUDiscovery = <yes|no> (yes)
1289 When this option is enabled, tinc will try to discover the path MTU to this node.
1290 After the path MTU has been discovered, it will be enforced on the VPN.
1291
1292 @cindex Port
1293 @item Port = <@var{port}> (655)
1294 This is the port this tinc daemon listens on.
1295 You can use decimal portnumbers or symbolic names (as listed in @file{/etc/services}).
1296
1297 @cindex PublicKey
1298 @item PublicKey = <@var{key}> [obsolete]
1299 This is the RSA public key for this host.
1300
1301 @cindex PublicKeyFile
1302 @item PublicKeyFile = <@var{path}> [obsolete]
1303 This is the full path name of the RSA public key file that was generated
1304 by @samp{tinc generate-keys}.  It must be a full path, not a relative
1305 directory.
1306
1307 @cindex PEM format
1308 From version 1.0pre4 on tinc will store the public key directly into the
1309 host configuration file in PEM format, the above two options then are not
1310 necessary. Either the PEM format is used, or exactly
1311 @strong{one of the above two options} must be specified
1312 in each host configuration file, if you want to be able to establish a
1313 connection with that host.
1314
1315 @cindex Subnet
1316 @item Subnet = <@var{address}[/@var{prefixlength}[#@var{weight}]]>
1317 The subnet which this tinc daemon will serve.
1318 Tinc tries to look up which other daemon it should send a packet to by searching the appropiate subnet.
1319 If the packet matches a subnet,
1320 it will be sent to the daemon who has this subnet in his host configuration file.
1321 Multiple subnet lines can be specified for each daemon.
1322
1323 Subnets can either be single MAC, IPv4 or IPv6 addresses,
1324 in which case a subnet consisting of only that single address is assumed,
1325 or they can be a IPv4 or IPv6 network address with a prefixlength.
1326 For example, IPv4 subnets must be in a form like 192.168.1.0/24,
1327 where 192.168.1.0 is the network address and 24 is the number of bits set in the netmask.
1328 Note that subnets like 192.168.1.1/24 are invalid!
1329 Read a networking HOWTO/FAQ/guide if you don't understand this.
1330 IPv6 subnets are notated like fec0:0:0:1::/64.
1331 MAC addresses are notated like 0:1a:2b:3c:4d:5e.
1332
1333 @cindex CIDR notation
1334 Prefixlength is the number of bits set to 1 in the netmask part; for
1335 example: netmask 255.255.255.0 would become /24, 255.255.252.0 becomes
1336 /22. This conforms to standard CIDR notation as described in
1337 @uref{http://www.ietf.org/rfc/rfc1519.txt, RFC1519}
1338
1339 A Subnet can be given a weight to indicate its priority over identical Subnets
1340 owned by different nodes. The default weight is 10. Lower values indicate
1341 higher priority. Packets will be sent to the node with the highest priority,
1342 unless that node is not reachable, in which case the node with the next highest
1343 priority will be tried, and so on.
1344
1345 @cindex TCPonly
1346 @item TCPonly = <yes|no> (no)
1347 If this variable is set to yes, then the packets are tunnelled over a
1348 TCP connection instead of a UDP connection.  This is especially useful
1349 for those who want to run a tinc daemon from behind a masquerading
1350 firewall, or if UDP packet routing is disabled somehow.
1351 Setting this options also implicitly sets IndirectData.
1352
1353 @cindex Weight
1354 @item Weight = <weight>
1355 If this variable is set, it overrides the weight given to connections made with
1356 another host. A higher weight means a lower priority is given to this
1357 connection when broadcasting or forwarding packets.
1358 @end table
1359
1360
1361 @c ==================================================================
1362 @node       Scripts
1363 @subsection Scripts
1364
1365 @cindex scripts
1366 Apart from reading the server and host configuration files,
1367 tinc can also run scripts at certain moments.
1368 Under Windows (not Cygwin), the scripts should have the extension @file{.bat} or @file{.cmd}.
1369
1370 @table @file
1371 @cindex tinc-up
1372 @item @value{sysconfdir}/tinc/@var{netname}/tinc-up
1373 This is the most important script.
1374 If it is present it will be executed right after the tinc daemon has been
1375 started and has connected to the virtual network device.
1376 It should be used to set up the corresponding network interface,
1377 but can also be used to start other things.
1378 Under Windows you can use the Network Connections control panel instead of creating this script.
1379
1380 @cindex tinc-down
1381 @item @value{sysconfdir}/tinc/@var{netname}/tinc-down
1382 This script is started right before the tinc daemon quits.
1383
1384 @item @value{sysconfdir}/tinc/@var{netname}/hosts/@var{host}-up
1385 This script is started when the tinc daemon with name @var{host} becomes reachable.
1386
1387 @item @value{sysconfdir}/tinc/@var{netname}/hosts/@var{host}-down
1388 This script is started when the tinc daemon with name @var{host} becomes unreachable.
1389
1390 @item @value{sysconfdir}/tinc/@var{netname}/host-up
1391 This script is started when any host becomes reachable.
1392
1393 @item @value{sysconfdir}/tinc/@var{netname}/host-down
1394 This script is started when any host becomes unreachable.
1395
1396 @item @value{sysconfdir}/tinc/@var{netname}/subnet-up
1397 This script is started when a Subnet becomes reachable.
1398 The Subnet and the node it belongs to are passed in environment variables.
1399
1400 @item @value{sysconfdir}/tinc/@var{netname}/subnet-down
1401 This script is started when a Subnet becomes unreachable.
1402
1403 @item @value{sysconfdir}/tinc/@var{netname}/invitation-created
1404 This script is started when a new invitation has been created.
1405
1406 @item @value{sysconfdir}/tinc/@var{netname}/invitation-accepted
1407 This script is started when an invitation has been used.
1408
1409 @end table
1410
1411 @cindex environment variables
1412 The scripts are started without command line arguments,
1413 but can make use of certain environment variables.
1414 Under UNIX like operating systems the names of environment variables must be preceded by a $ in scripts.
1415 Under Windows, in @file{.bat} or @file{.cmd} files, they have to be put between % signs.
1416
1417 @table @env
1418 @cindex NETNAME
1419 @item NETNAME
1420 If a netname was specified, this environment variable contains it.
1421
1422 @cindex NAME
1423 @item NAME
1424 Contains the name of this tinc daemon.
1425
1426 @cindex DEVICE
1427 @item DEVICE
1428 Contains the name of the virtual network device that tinc uses.
1429
1430 @cindex INTERFACE
1431 @item INTERFACE
1432 Contains the name of the virtual network interface that tinc uses.
1433 This should be used for commands like ifconfig.
1434
1435 @cindex NODE
1436 @item NODE
1437 When a host becomes (un)reachable, this is set to its name.
1438 If a subnet becomes (un)reachable, this is set to the owner of that subnet.
1439
1440 @cindex REMOTEADDRESS
1441 @item REMOTEADDRESS
1442 When a host becomes (un)reachable, this is set to its real address.
1443
1444 @cindex REMOTEPORT
1445 @item REMOTEPORT
1446 When a host becomes (un)reachable,
1447 this is set to the port number it uses for communication with other tinc daemons.
1448
1449 @cindex SUBNET
1450 @item SUBNET
1451 When a subnet becomes (un)reachable, this is set to the subnet.
1452
1453 @cindex WEIGHT
1454 @item WEIGHT
1455 When a subnet becomes (un)reachable, this is set to the subnet weight.
1456
1457 @cindex INVITATION_FILE
1458 @item INVITATION_FILE
1459 When the @file{invitation-created} script is called,
1460 this is set to the file where the invitation details will be stored.
1461
1462 @cindex INVITATION_URL
1463 @item INVITATION_URL
1464 When the @file{invitation-created} script is called,
1465 this is set to the invitation URL that has been created.
1466 @end table
1467
1468 Do not forget that under UNIX operating systems,
1469 you have to make the scripts executable, using the command @samp{chmod a+x script}.
1470
1471
1472 @c ==================================================================
1473 @node       How to configure
1474 @subsection How to configure
1475
1476 @subsubheading Step 1.  Creating initial configuration files.
1477
1478 The initial directory structure, configuration files and public/private keypairs are created using the following command:
1479
1480 @example
1481 tinc -n @var{netname} init @var{name}
1482 @end example
1483
1484 (You will need to run this as root, or use "sudo".)
1485 This will create the configuration directory @file{@value{sysconfdir}/tinc/@var{netname}.},
1486 and inside it will create another directory named @file{hosts/}.
1487 In the configuration directory, it will create the file @file{tinc.conf} with the following contents:
1488
1489 @example
1490 Name = @var{name}
1491 @end example
1492
1493 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}.
1494 It will also create a host configuration file @file{hosts/@var{name}},
1495 which will contain the corresponding public RSA and Ed25519 keys.
1496
1497 Finally, on UNIX operating systems, it will create an executable script @file{tinc-up},
1498 which will initially not do anything except warning that you should edit it.
1499
1500 @subsubheading Step 2.  Modifying the initial configuration.
1501
1502 Unless you want to use tinc in switch mode,
1503 you should now configure which range of addresses you will use on the VPN.
1504 Let's assume you will be part of a VPN which uses the address range 192.168.0.0/16,
1505 and you yourself have a smaller portion of that range: 192.168.2.0/24.
1506 Then you should run the following command:
1507
1508 @example
1509 tinc -n @var{netname} add subnet 192.168.2.0/24
1510 @end example
1511
1512 This will add a Subnet statement to your host configuration file.
1513 Try opening the file @file{@value{sysconfdir}/tinc/@var{netname}/hosts/@var{name}} in an editor.
1514 You should now see a file containing the public RSA and Ed25519 keys (which looks like a bunch of random characters),
1515 and the following line at the bottom:
1516
1517 @example
1518 Subnet = 192.168.2.0/24
1519 @end example
1520
1521 If you will use more than one address range, you can add more Subnets.
1522 For example, if you also use the IPv6 subnet fec0:0:0:2::/64, you can add it as well:
1523
1524 @example
1525 tinc -n @var{netname} add subnet fec0:0:0:2::/24
1526 @end example
1527
1528 This will add another line to the file @file{hosts/@var{name}}.
1529 If you make a mistake, you can undo it by simply using @samp{del} instead of @samp{add}.
1530
1531 If you want other tinc daemons to create meta-connections to your daemon,
1532 you should add your public IP address or hostname to your host configuration file.
1533 For example, if your hostname is foo.example.org, run:
1534
1535 @example
1536 tinc -n @var{netname} add address foo.example.org
1537 @end example
1538
1539 If you already know to which daemons your daemon should make meta-connections,
1540 you should configure that now as well.
1541 Suppose you want to connect to a daemon named "bar", run:
1542
1543 @example
1544 tinc -n @var{netname} add connectto bar
1545 @end example
1546
1547 Note that you specify the Name of the other daemon here, not an IP address or hostname!
1548 When you start tinc, and it tries to make a connection to "bar",
1549 it will look for a host configuration file named @file{hosts/bar},
1550 and will read Address statements and public keys from that file.
1551
1552 @subsubheading Step 2.  Exchanging configuration files.
1553
1554 If your daemon has a ConnectTo = bar statement in its @file{tinc.conf} file,
1555 or if bar has a ConnectTo your daemon, then you both need each other's host configuration files.
1556 You should send @file{hosts/@var{name}} to bar, and bar should send you his file which you should move to @file{hosts/bar}.
1557 If you are on a UNIX platform, you can easily send an email containing the necessary information using the following command
1558 (assuming the owner of bar has the email address bar@@example.org):
1559
1560 @example
1561 tinc -n @var{netname} export | mail -s "My config file" bar@@example.org
1562 @end example
1563
1564 If the owner of bar does the same to send his host configuration file to you,
1565 you can probably pipe his email through the following command,
1566 or you can just start this command in a terminal and copy&paste the email:
1567
1568 @example
1569 tinc -n @var{netname} import
1570 @end example
1571
1572 If you are the owner of bar yourself, and you have SSH access to that computer,
1573 you can also swap the host configuration files using the following command:
1574
1575 @example
1576 tinc -n @var{netname} export \
1577     | ssh bar.example.org tinc -n @var{netname} exchange \
1578     | tinc -n @var{netname} import
1579 @end example
1580
1581 You should repeat this for all nodes you ConnectTo, or which ConnectTo you.
1582 However, remember that you do not need to ConnectTo all nodes in the VPN;
1583 it is only necessary to create one or a few meta-connections,
1584 after the connections are made tinc will learn about all the other nodes in the VPN,
1585 and will automatically make other connections as necessary.
1586
1587
1588 @c ==================================================================
1589 @node    Network interfaces
1590 @section Network interfaces
1591
1592 Before tinc can start transmitting data over the tunnel, it must
1593 set up the virtual network interface.
1594
1595 First, decide which IP addresses you want to have associated with these
1596 devices, and what network mask they must have.
1597
1598 Tinc will open a virtual network device (@file{/dev/tun}, @file{/dev/tap0} or similar),
1599 which will also create a network interface called something like @samp{tun0}, @samp{tap0}.
1600 If you are using the Linux tun/tap driver, the network interface will by default have the same name as the @var{netname}.
1601 Under Windows you can change the name of the network interface from the Network Connections control panel.
1602
1603 @cindex tinc-up
1604 You can configure the network interface by putting ordinary ifconfig, route, and other commands
1605 to a script named @file{@value{sysconfdir}/tinc/@var{netname}/tinc-up}.
1606 When tinc starts, this script will be executed. When tinc exits, it will execute the script named
1607 @file{@value{sysconfdir}/tinc/@var{netname}/tinc-down}, but normally you don't need to create that script.
1608 You can manually open the script in an editor, or use the following command:
1609
1610 @example
1611 tinc -n @var{netname} edit tinc-up
1612 @end example
1613
1614 An example @file{tinc-up} script, that would be appropriate for the scenario in the previous section, is:
1615
1616 @example
1617 #!/bin/sh
1618 ifconfig $INTERFACE 192.168.2.1 netmask 255.255.0.0
1619 ip addr add fec0:0:0:2::/48 dev $INTERFACE
1620 @end example
1621
1622 The first command gives the interface an IPv4 address and a netmask.
1623 The kernel will also automatically add an IPv4 route to this interface, so normally you don't need
1624 to add route commands to the @file{tinc-up} script.
1625 The kernel will also bring the interface up after this command.
1626 @cindex netmask
1627 The netmask is the mask of the @emph{entire} VPN network, not just your
1628 own subnet.
1629 The second command gives the interface an IPv6 address and netmask,
1630 which will also automatically add an IPv6 route.
1631 If you only want to use "ip addr" commands on Linux, don't forget that it doesn't bring the interface up, unlike ifconfig,
1632 so you need to add @samp{ip link set $INTERFACE up} in that case.
1633
1634 The exact syntax of the ifconfig and route commands differs from platform to platform.
1635 You can look up the commands for setting addresses and adding routes in @ref{Platform specific information},
1636 but it is best to consult the manpages of those utilities on your platform.
1637
1638
1639 @c ==================================================================
1640 @node    Example configuration
1641 @section Example configuration
1642
1643
1644 @cindex example
1645 Imagine the following situation.  Branch A of our example `company' wants to connect
1646 three branch offices in B, C and D using the Internet.  All four offices
1647 have a 24/7 connection to the Internet.
1648
1649 A is going to serve as the center of the network.  B and C will connect
1650 to A, and D will connect to C.  Each office will be assigned their own IP
1651 network, 10.x.0.0.
1652
1653 @example
1654 A: net 10.1.0.0 mask 255.255.0.0 gateway 10.1.54.1 internet IP 1.2.3.4
1655 B: net 10.2.0.0 mask 255.255.0.0 gateway 10.2.1.12 internet IP 2.3.4.5
1656 C: net 10.3.0.0 mask 255.255.0.0 gateway 10.3.69.254 internet IP 3.4.5.6
1657 D: net 10.4.0.0 mask 255.255.0.0 gateway 10.4.3.32 internet IP 4.5.6.7
1658 @end example
1659
1660 Here, ``gateway'' is the VPN IP address of the machine that is running the
1661 tincd, and ``internet IP'' is the IP address of the firewall, which does not
1662 need to run tincd, but it must do a port forwarding of TCP and UDP on port
1663 655 (unless otherwise configured).
1664
1665 In this example, it is assumed that eth0 is the interface that points to
1666 the inner (physical) LAN of the office, although this could also be the
1667 same as the interface that leads to the Internet.  The configuration of
1668 the real interface is also shown as a comment, to give you an idea of
1669 how these example host is set up. All branches use the netname `company'
1670 for this particular VPN.
1671
1672 Each branch is set up using the @samp{tinc init} and @samp{tinc config} commands,
1673 here we just show the end results:
1674
1675 @subsubheading For Branch A
1676
1677 @emph{BranchA} would be configured like this:
1678
1679 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1680
1681 @example
1682 #!/bin/sh
1683
1684 # Real interface of internal network:
1685 # ifconfig eth0 10.1.54.1 netmask 255.255.0.0
1686
1687 ifconfig $INTERFACE 10.1.54.1 netmask 255.0.0.0
1688 @end example
1689
1690 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1691
1692 @example
1693 Name = BranchA
1694 @end example
1695
1696 On all hosts, @file{@value{sysconfdir}/tinc/company/hosts/BranchA} contains:
1697
1698 @example
1699 Subnet = 10.1.0.0/16
1700 Address = 1.2.3.4
1701
1702 -----BEGIN RSA PUBLIC KEY-----
1703 ...
1704 -----END RSA PUBLIC KEY-----
1705 @end example
1706
1707 Note that the IP addresses of eth0 and the VPN interface are the same.
1708 This is quite possible, if you make sure that the netmasks of the interfaces are different.
1709 It is in fact recommended to give both real internal network interfaces and VPN interfaces the same IP address,
1710 since that will make things a lot easier to remember and set up.
1711
1712
1713 @subsubheading For Branch B
1714
1715 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1716
1717 @example
1718 #!/bin/sh
1719
1720 # Real interface of internal network:
1721 # ifconfig eth0 10.2.43.8 netmask 255.255.0.0
1722
1723 ifconfig $INTERFACE 10.2.1.12 netmask 255.0.0.0
1724 @end example
1725
1726 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1727
1728 @example
1729 Name = BranchB
1730 ConnectTo = BranchA
1731 @end example
1732
1733 Note here that the internal address (on eth0) doesn't have to be the
1734 same as on the VPN interface.  Also, ConnectTo is given so that this node will
1735 always try to connect to BranchA.
1736
1737 On all hosts, in @file{@value{sysconfdir}/tinc/company/hosts/BranchB}:
1738
1739 @example
1740 Subnet = 10.2.0.0/16
1741 Address = 2.3.4.5
1742
1743 -----BEGIN RSA PUBLIC KEY-----
1744 ...
1745 -----END RSA PUBLIC KEY-----
1746 @end example
1747
1748
1749 @subsubheading For Branch C
1750
1751 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1752
1753 @example
1754 #!/bin/sh
1755
1756 # Real interface of internal network:
1757 # ifconfig eth0 10.3.69.254 netmask 255.255.0.0
1758
1759 ifconfig $INTERFACE 10.3.69.254 netmask 255.0.0.0
1760 @end example
1761
1762 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1763
1764 @example
1765 Name = BranchC
1766 ConnectTo = BranchA
1767 @end example
1768
1769 C already has another daemon that runs on port 655, so they have to
1770 reserve another port for tinc. It knows the portnumber it has to listen on
1771 from it's own host configuration file.
1772
1773 On all hosts, in @file{@value{sysconfdir}/tinc/company/hosts/BranchC}:
1774
1775 @example
1776 Address = 3.4.5.6
1777 Subnet = 10.3.0.0/16
1778 Port = 2000
1779
1780 -----BEGIN RSA PUBLIC KEY-----
1781 ...
1782 -----END RSA PUBLIC KEY-----
1783 @end example
1784
1785
1786 @subsubheading For Branch D
1787
1788 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1789
1790 @example
1791 #!/bin/sh
1792
1793 # Real interface of internal network:
1794 # ifconfig eth0 10.4.3.32 netmask 255.255.0.0
1795
1796 ifconfig $INTERFACE 10.4.3.32 netmask 255.0.0.0
1797 @end example
1798
1799 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1800
1801 @example
1802 Name = BranchD
1803 ConnectTo = BranchC
1804 @end example
1805
1806 D will be connecting to C, which has a tincd running for this network on
1807 port 2000. It knows the port number from the host configuration file.
1808
1809 On all hosts, in @file{@value{sysconfdir}/tinc/company/hosts/BranchD}:
1810
1811 @example
1812 Subnet = 10.4.0.0/16
1813 Address = 4.5.6.7
1814
1815 -----BEGIN RSA PUBLIC KEY-----
1816 ...
1817 -----END RSA PUBLIC KEY-----
1818 @end example
1819
1820 @subsubheading Key files
1821
1822 A, B, C and D all have their own public/private keypairs:
1823
1824 The private RSA key is stored in @file{@value{sysconfdir}/tinc/company/rsa_key.priv},
1825 the private Ed25519 key is stored in @file{@value{sysconfdir}/tinc/company/ed25519_key.priv},
1826 and the public RSA and Ed25519 keys are put into the host configuration file in the @file{@value{sysconfdir}/tinc/company/hosts/} directory.
1827
1828 @subsubheading Starting
1829
1830 After each branch has finished configuration and they have distributed
1831 the host configuration files amongst them, they can start their tinc daemons.
1832 They don't necessarily have to wait for the other branches to have started
1833 their daemons, tinc will try connecting until they are available.
1834
1835
1836 @c ==================================================================
1837 @node    Running tinc
1838 @chapter Running tinc
1839
1840 If everything else is done, you can start tinc by typing the following command:
1841
1842 @example
1843 tinc -n @var{netname} start
1844 @end example
1845
1846 @cindex daemon
1847 Tinc will detach from the terminal and continue to run in the background like a good daemon.
1848 If there are any problems however you can try to increase the debug level
1849 and look in the syslog to find out what the problems are.
1850
1851 @menu
1852 * Runtime options::
1853 * Signals::
1854 * Debug levels::
1855 * Solving problems::
1856 * Error messages::
1857 * Sending bug reports::
1858 @end menu
1859
1860
1861 @c ==================================================================
1862 @node    Runtime options
1863 @section Runtime options
1864
1865 Besides the settings in the configuration file, tinc also accepts some
1866 command line options.
1867
1868 @cindex command line
1869 @cindex runtime options
1870 @cindex options
1871 @c from the manpage
1872 @table @option
1873 @item -c, --config=@var{path}
1874 Read configuration options from the directory @var{path}.  The default is
1875 @file{@value{sysconfdir}/tinc/@var{netname}/}.
1876
1877 @item -D, --no-detach
1878 Don't fork and detach.
1879 This will also disable the automatic restart mechanism for fatal errors.
1880
1881 @cindex debug level
1882 @item -d, --debug=@var{level}
1883 Set debug level to @var{level}.  The higher the debug level, the more gets
1884 logged.  Everything goes via syslog.
1885
1886 @item -n, --net=@var{netname}
1887 Use configuration for net @var{netname}.
1888 This will let tinc read all configuration files from
1889 @file{@value{sysconfdir}/tinc/@var{netname}/}.
1890 Specifying . for @var{netname} is the same as not specifying any @var{netname}.
1891 @xref{Multiple networks}.
1892
1893 @item --pidfile=@var{filename}
1894 Store a cookie in @var{filename} which allows tinc to authenticate.
1895 If unspecified, the default is
1896 @file{@value{localstatedir}/run/tinc.@var{netname}.pid}.
1897
1898 @item -o, --option=[@var{HOST}.]@var{KEY}=@var{VALUE}
1899 Without specifying a @var{HOST}, this will set server configuration variable @var{KEY} to @var{VALUE}.
1900 If specified as @var{HOST}.@var{KEY}=@var{VALUE},
1901 this will set the host configuration variable @var{KEY} of the host named @var{HOST} to @var{VALUE}.
1902 This option can be used more than once to specify multiple configuration variables.
1903
1904 @item -L, --mlock
1905 Lock tinc into main memory.
1906 This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.
1907
1908 This option is not supported on all platforms.
1909
1910 @item --logfile[=@var{file}]
1911 Write log entries to a file instead of to the system logging facility.
1912 If @var{file} is omitted, the default is @file{@value{localstatedir}/log/tinc.@var{netname}.log}.
1913
1914 @item --bypass-security
1915 Disables encryption and authentication.
1916 Only useful for debugging.
1917
1918 @item -R, --chroot
1919 Change process root directory to the directory where the config file is
1920 located (@file{@value{sysconfdir}/tinc/@var{netname}/} as determined by
1921 -n/--net option or as given by -c/--config option), for added security.
1922 The chroot is performed after all the initialization is done, after
1923 writing pid files and opening network sockets.
1924
1925 Note that this option alone does not do any good without -U/--user, below.
1926
1927 Note also that tinc can't run scripts anymore (such as tinc-down or host-up),
1928 unless it's setup to be runnable inside chroot environment.
1929
1930 This option is not supported on all platforms.
1931 @item -U, --user=@var{user}
1932 Switch to the given @var{user} after initialization, at the same time as
1933 chroot is performed (see --chroot above).  With this option tinc drops
1934 privileges, for added security.
1935
1936 This option is not supported on all platforms.
1937
1938 @item --help
1939 Display a short reminder of these runtime options and terminate.
1940
1941 @item --version
1942 Output version information and exit.
1943
1944 @end table
1945
1946 @c ==================================================================
1947 @node    Signals
1948 @section Signals
1949
1950 @cindex signals
1951 You can also send the following signals to a running tincd process:
1952
1953 @c from the manpage
1954 @table @samp
1955
1956 @item ALRM
1957 Forces tinc to try to connect to all uplinks immediately.
1958 Usually tinc attempts to do this itself,
1959 but increases the time it waits between the attempts each time it failed,
1960 and if tinc didn't succeed to connect to an uplink the first time after it started,
1961 it defaults to the maximum time of 15 minutes.
1962
1963 @item HUP
1964 Partially rereads configuration files.
1965 Connections to hosts whose host config file are removed are closed.
1966 New outgoing connections specified in @file{tinc.conf} will be made.
1967 If the --logfile option is used, this will also close and reopen the log file,
1968 useful when log rotation is used.
1969
1970 @end table
1971
1972 @c ==================================================================
1973 @node    Debug levels
1974 @section Debug levels
1975
1976 @cindex debug levels
1977 The tinc daemon can send a lot of messages to the syslog.
1978 The higher the debug level, the more messages it will log.
1979 Each level inherits all messages of the previous level:
1980
1981 @c from the manpage
1982 @table @samp
1983
1984 @item 0
1985 This will log a message indicating tinc has started along with a version number.
1986 It will also log any serious error.
1987
1988 @item 1
1989 This will log all connections that are made with other tinc daemons.
1990
1991 @item 2
1992 This will log status and error messages from scripts and other tinc daemons.
1993
1994 @item 3
1995 This will log all requests that are exchanged with other tinc daemons. These include
1996 authentication, key exchange and connection list updates.
1997
1998 @item 4
1999 This will log a copy of everything received on the meta socket.
2000
2001 @item 5
2002 This will log all network traffic over the virtual private network.
2003
2004 @end table
2005
2006 @c ==================================================================
2007 @node    Solving problems
2008 @section Solving problems
2009
2010 If tinc starts without problems, but if the VPN doesn't work, you will have to find the cause of the problem.
2011 The first thing to do is to start tinc with a high debug level in the foreground,
2012 so you can directly see everything tinc logs:
2013
2014 @example
2015 tincd -n @var{netname} -d5 -D
2016 @end example
2017
2018 If tinc does not log any error messages, then you might want to check the following things:
2019
2020 @itemize
2021 @item @file{tinc-up} script
2022 Does this script contain the right commands?
2023 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.
2024
2025 @item Subnet
2026 Does the Subnet (or Subnets) in the host configuration file of this host match the portion of the VPN that belongs to this host?
2027
2028 @item Firewalls and NATs
2029 Do you have a firewall or a NAT device (a masquerading firewall or perhaps an ADSL router that performs masquerading)?
2030 If so, check that it allows TCP and UDP traffic on port 655.
2031 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.
2032 You can add @samp{TCPOnly = yes} to your host config file to force tinc to only use a single TCP connection,
2033 this works through most firewalls and NATs.
2034
2035 @end itemize
2036
2037
2038 @c ==================================================================
2039 @node    Error messages
2040 @section Error messages
2041
2042 What follows is a list of the most common error messages you might find in the logs.
2043 Some of them will only be visible if the debug level is high enough.
2044
2045 @table @samp
2046 @item Could not open /dev/tap0: No such device
2047
2048 @itemize
2049 @item You forgot to `modprobe netlink_dev' or `modprobe ethertap'.
2050 @item You forgot to compile `Netlink device emulation' in the kernel.
2051 @end itemize
2052
2053 @item Can't write to /dev/net/tun: No such device
2054
2055 @itemize
2056 @item You forgot to `modprobe tun'.
2057 @item You forgot to compile `Universal TUN/TAP driver' in the kernel.
2058 @item The tun device is located somewhere else in @file{/dev/}.
2059 @end itemize
2060
2061 @item Network address and prefix length do not match!
2062
2063 @itemize
2064 @item The Subnet field must contain a @emph{network} address, trailing bits should be 0.
2065 @item If you only want to use one IP address, set the netmask to /32.
2066 @end itemize
2067
2068 @item Error reading RSA key file `rsa_key.priv': No such file or directory
2069
2070 @itemize
2071 @item You forgot to create a public/private keypair.
2072 @item Specify the complete pathname to the private key file with the @samp{PrivateKeyFile} option.
2073 @end itemize
2074
2075 @item Warning: insecure file permissions for RSA private key file `rsa_key.priv'!
2076
2077 @itemize
2078 @item The private key file is readable by users other than root.
2079 Use chmod to correct the file permissions.
2080 @end itemize
2081
2082 @item Creating metasocket failed: Address family not supported
2083
2084 @itemize
2085 @item By default tinc tries to create both IPv4 and IPv6 sockets.
2086 On some platforms this might not be implemented.
2087 If the logs show @samp{Ready} later on, then at least one metasocket was created,
2088 and you can ignore this message.
2089 You can add @samp{AddressFamily = ipv4} to @file{tinc.conf} to prevent this from happening.
2090 @end itemize
2091
2092 @item Cannot route packet: unknown IPv4 destination 1.2.3.4
2093
2094 @itemize
2095 @item You try to send traffic to a host on the VPN for which no Subnet is known.
2096 @item If it is a broadcast address (ending in .255), it probably is a samba server or a Windows host sending broadcast packets.
2097 You can ignore it.
2098 @end itemize
2099
2100 @item Cannot route packet: ARP request for unknown address 1.2.3.4
2101
2102 @itemize
2103 @item You try to send traffic to a host on the VPN for which no Subnet is known.
2104 @end itemize
2105
2106 @item Packet with destination 1.2.3.4 is looping back to us!
2107
2108 @itemize
2109 @item Something is not configured right. Packets are being sent out to the
2110 virtual network device, but according to the Subnet directives in your host configuration
2111 file, those packets should go to your own host. Most common mistake is that
2112 you have a Subnet line in your host configuration file with a prefix length which is
2113 just as large as the prefix of the virtual network interface. The latter should in almost all
2114 cases be larger. Rethink your configuration.
2115 Note that you will only see this message if you specified a debug
2116 level of 5 or higher!
2117 @item Chances are that a @samp{Subnet = ...} line in the host configuration file of this tinc daemon is wrong.
2118 Change it to a subnet that is accepted locally by another interface,
2119 or if that is not the case, try changing the prefix length into /32.
2120 @end itemize
2121
2122 @item Node foo (1.2.3.4) is not reachable
2123
2124 @itemize
2125 @item Node foo does not have a connection anymore, its tinc daemon is not running or its connection to the Internet is broken.
2126 @end itemize
2127
2128 @item Received UDP packet from unknown source 1.2.3.4 (port 12345)
2129
2130 @itemize
2131 @item If you see this only sporadically, it is harmless and caused by a node sending packets using an old key.
2132 @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.
2133 You can add @samp{TCPOnly = yes} to host configuration files to force all VPN traffic to go over a TCP connection.
2134 @end itemize
2135
2136 @item Got bad/bogus/unauthorized REQUEST from foo (1.2.3.4 port 12345)
2137
2138 @itemize
2139 @item Node foo does not have the right public/private keypair.
2140 Generate new keypairs and distribute them again.
2141 @item An attacker tries to gain access to your VPN.
2142 @item A network error caused corruption of metadata sent from foo.
2143 @end itemize
2144
2145 @end table
2146
2147 @c ==================================================================
2148 @node    Sending bug reports
2149 @section Sending bug reports
2150
2151 If you really can't find the cause of a problem, or if you suspect tinc is not working right,
2152 you can send us a bugreport, see @ref{Contact information}.
2153 Be sure to include the following information in your bugreport:
2154
2155 @itemize
2156 @item A clear description of what you are trying to achieve and what the problem is.
2157 @item What platform (operating system, version, hardware architecture) and which version of tinc you use.
2158 @item If compiling tinc fails, a copy of @file{config.log} and the error messages you get.
2159 @item Otherwise, a copy of @file{tinc.conf}, @file{tinc-up} and all files in the @file{hosts/} directory.
2160 @item The output of the commands @samp{ifconfig -a} and @samp{route -n} (or @samp{netstat -rn} if that doesn't work).
2161 @item The output of any command that fails to work as it should (like ping or traceroute).
2162 @end itemize
2163
2164 @c ==================================================================
2165 @node    Controlling tinc
2166 @chapter Controlling tinc
2167
2168 @cindex command line interface
2169 You can start, stop, control and inspect a running tincd through the tinc
2170 command. A quick example:
2171
2172 @example
2173 tinc -n @var{netname} reload
2174 @end example
2175
2176 @cindex shell
2177 If tinc is started without a command, it will act as a shell; it will display a
2178 prompt, and commands can be entered on the prompt. If tinc is compiled with
2179 libreadline, history and command completion are available on the prompt. One
2180 can also pipe a script containing commands through tinc. In that case, lines
2181 starting with a # symbol will be ignored.
2182
2183 @menu
2184 * tinc runtime options::
2185 * tinc environment variables::
2186 * tinc commands::
2187 * tinc examples::
2188 * tinc top::
2189 @end menu
2190
2191
2192 @c ==================================================================
2193 @node    tinc runtime options
2194 @section tinc runtime options
2195
2196 @c from the manpage
2197 @table @option
2198 @item -c, --config=@var{path}
2199 Read configuration options from the directory @var{path}.  The default is
2200 @file{@value{sysconfdir}/tinc/@var{netname}/}.
2201
2202 @item -n, --net=@var{netname}
2203 Use configuration for net @var{netname}. @xref{Multiple networks}.
2204
2205 @item --pidfile=@var{filename}
2206 Use the cookie from @var{filename} to authenticate with a running tinc daemon.
2207 If unspecified, the default is
2208 @file{@value{localstatedir}/run/tinc.@var{netname}.pid}.
2209
2210 @item --help
2211 Display a short reminder of runtime options and commands, then terminate.
2212
2213 @item --version
2214 Output version information and exit.
2215
2216 @end table
2217
2218 @c ==================================================================
2219 @node    tinc environment variables
2220 @section tinc environment variables
2221
2222 @table @env
2223 @cindex NETNAME
2224 @item NETNAME
2225 If no netname is specified on the command line with the @option{-n} option,
2226 the value of this environment variable is used.
2227 @end table
2228
2229 @c ==================================================================
2230 @node    tinc commands
2231 @section tinc commands
2232
2233 @c from the manpage
2234 @table @code
2235
2236 @cindex init
2237 @item init [@var{name}]
2238 Create initial configuration files and RSA and Ed25519 keypairs with default length.
2239 If no @var{name} for this node is given, it will be asked for.
2240
2241 @cindex get
2242 @item get @var{variable}
2243 Print the current value of configuration variable @var{variable}.
2244 If more than one variable with the same name exists,
2245 the value of each of them will be printed on a separate line.
2246
2247 @cindex set
2248 @item set @var{variable} @var{value}
2249 Set configuration variable @var{variable} to the given @var{value}.
2250 All previously existing configuration variables with the same name are removed.
2251 To set a variable for a specific host, use the notation @var{host}.@var{variable}.
2252
2253 @cindex add
2254 @item add @var{variable} @var{value}
2255 As above, but without removing any previously existing configuration variables.
2256
2257 @cindex del
2258 @item del @var{variable} [@var{value}]
2259 Remove configuration variables with the same name and @var{value}.
2260 If no @var{value} is given, all configuration variables with the same name will be removed.
2261
2262 @cindex edit
2263 @item edit @var{filename}
2264 Start an editor for the given configuration file.
2265 You do not need to specify the full path to the file.
2266
2267 @cindex export
2268 @item export
2269 Export the host configuration file of the local node to standard output.
2270
2271 @cindex export-all
2272 @item export-all
2273 Export all host configuration files to standard output.
2274
2275 @cindex import
2276 @item import [--force]
2277 Import host configuration file(s) generated by the tinc export command from standard input.
2278 Already existing host configuration files are not overwritten unless the option --force is used.
2279
2280 @cindex exchange
2281 @item exchange [--force]
2282 The same as export followed by import.
2283
2284 @cindex exchange-all
2285 @item exchange-all [--force]
2286 The same as export-all followed by import.
2287
2288 @cindex invite
2289 @item invite @var{name}
2290 Prepares an invitation for a new node with the given @var{name},
2291 and prints a short invitation URL that can be used with the join command.
2292
2293 @cindex join
2294 @item join [@var{URL}]
2295 Join an existing VPN using an invitation URL created using the invite command.
2296 If no @var{URL} is given, it will be read from standard input.
2297
2298 @cindex start
2299 @item start [tincd options]
2300 Start @samp{tincd}, optionally with the given extra options.
2301
2302 @cindex stop
2303 @item stop
2304 Stop @samp{tincd}.
2305
2306 @cindex restart
2307 @item restart [tincd options]
2308 Restart @samp{tincd}, optionally with the given extra options.
2309
2310 @cindex reload
2311 @item reload
2312 Partially rereads configuration files. Connections to hosts whose host
2313 config files are removed are closed. New outgoing connections specified
2314 in @file{tinc.conf} will be made.
2315
2316 @cindex pid
2317 @item pid
2318 Shows the PID of the currently running @samp{tincd}.
2319
2320 @cindex generate-keys
2321 @item generate-keys [@var{bits}]
2322 Generate both RSA and Ed25519 keypairs (see below) and exit.
2323 tinc will ask where you want to store the files, but will default to the
2324 configuration directory (you can use the -c or -n option).
2325
2326 @cindex generate-ed25519-keys
2327 @item generate-ed25519-keys
2328 Generate public/private Ed25519 keypair and exit.
2329
2330 @cindex generate-rsa-keys
2331 @item generate-rsa-keys [@var{bits}]
2332 Generate public/private RSA keypair and exit.  If @var{bits} is omitted, the
2333 default length will be 2048 bits.  When saving keys to existing files, tinc
2334 will not delete the old keys; you have to remove them manually.
2335
2336 @cindex dump
2337 @item dump [reachable] nodes
2338 Dump a list of all known nodes in the VPN.
2339 If the reachable keyword is used, only lists reachable nodes.
2340
2341 @item dump edges
2342 Dump a list of all known connections in the VPN.
2343
2344 @item dump subnets
2345 Dump a list of all known subnets in the VPN.
2346
2347 @item dump connections
2348 Dump a list of all meta connections with ourself.
2349
2350 @cindex graph
2351 @item dump graph | digraph
2352 Dump a graph of the VPN in dotty format.
2353 Nodes are colored according to their reachability:
2354 red nodes are unreachable, orange nodes are indirectly reachable, green nodes are directly reachable.
2355 Black nodes are either directly or indirectly reachable, but direct reachability has not been tried yet.
2356
2357 @cindex info
2358 @item info @var{node} | @var{subnet} | @var{address}
2359 Show information about a particular @var{node}, @var{subnet} or @var{address}.
2360 If an @var{address} is given, any matching subnet will be shown.
2361
2362 @cindex purge
2363 @item purge
2364 Purges all information remembered about unreachable nodes.
2365
2366 @cindex debug
2367 @item debug @var{level}
2368 Sets debug level to @var{level}.
2369
2370 @cindex log
2371 @item log [@var{level}]
2372 Capture log messages from a running tinc daemon.
2373 An optional debug level can be given that will be applied only for log messages sent to tinc.
2374
2375 @cindex retry
2376 @item retry
2377 Forces tinc to try to connect to all uplinks immediately.
2378 Usually tinc attempts to do this itself,
2379 but increases the time it waits between the attempts each time it failed,
2380 and if tinc didn't succeed to connect to an uplink the first time after it started,
2381 it defaults to the maximum time of 15 minutes.
2382
2383 @cindex disconnect
2384 @item disconnect @var{node}
2385 Closes the meta connection with the given @var{node}.
2386
2387 @cindex top
2388 @item top
2389 If tinc is compiled with libcurses support, this will display live traffic statistics for all the known nodes,
2390 similar to the UNIX top command.
2391 See below for more information.
2392
2393 @cindex pcap
2394 @item pcap
2395 Dump VPN traffic going through the local tinc node in pcap-savefile format to standard output,
2396 from where it can be redirected to a file or piped through a program that can parse it directly,
2397 such as tcpdump.
2398
2399 @cindex network [@var{netname}]
2400 @item network
2401 If @var{netname} is given, switch to that network.
2402 Otherwise, display a list of all networks for which configuration files exist.
2403
2404 @end table
2405
2406 @c ==================================================================
2407 @node    tinc examples
2408 @section tinc examples
2409
2410 Examples of some commands:
2411
2412 @example
2413 tinc -n vpn dump graph | circo -Txlib
2414 tinc -n vpn pcap | tcpdump -r -
2415 tinc -n vpn top
2416 @end example
2417
2418 Examples of changing the configuration using tinc:
2419
2420 @example
2421 tinc -n vpn init foo
2422 tinc -n vpn add Subnet 192.168.1.0/24
2423 tinc -n vpn add bar.Address bar.example.com
2424 tinc -n vpn add ConnectTo bar
2425 tinc -n vpn export | gpg --clearsign | mail -s "My config" vpnmaster@@example.com
2426 @end example
2427
2428 @c ==================================================================
2429 @node    tinc top
2430 @section tinc top
2431
2432 @cindex top
2433 The top command connects to a running tinc daemon and repeatedly queries its per-node traffic counters.
2434 It displays a list of all the known nodes in the left-most column,
2435 and the amount of bytes and packets read from and sent to each node in the other columns.
2436 By default, the information is updated every second.
2437 The behaviour of the top command can be changed using the following keys:
2438
2439 @table @key
2440
2441 @item s
2442 Change the interval between updates.
2443 After pressing the @key{s} key, enter the desired interval in seconds, followed by enter.
2444 Fractional seconds are honored.
2445 Intervals lower than 0.1 seconds are not allowed.
2446
2447 @item c
2448 Toggle between displaying current traffic rates (in packets and bytes per second)
2449 and cummulative traffic (total packets and bytes since the tinc daemon started).
2450
2451 @item n
2452 Sort the list of nodes by name.
2453
2454 @item i
2455 Sort the list of nodes by incoming amount of bytes.
2456
2457 @item I
2458 Sort the list of nodes by incoming amount of packets.
2459
2460 @item o
2461 Sort the list of nodes by outgoing amount of bytes.
2462
2463 @item O
2464 Sort the list of nodes by outgoing amount of packets.
2465
2466 @item t
2467 Sort the list of nodes by sum of incoming and outgoing amount of bytes.
2468
2469 @item T
2470 Sort the list of nodes by sum of incoming and outgoing amount of packets.
2471
2472 @item b
2473 Show amount of traffic in bytes.
2474
2475 @item k
2476 Show amount of traffic in kilobytes.
2477
2478 @item M
2479 Show amount of traffic in megabytes.
2480
2481 @item G
2482 Show amount of traffic in gigabytes.
2483
2484 @item q
2485 Quit.
2486
2487 @end table
2488
2489
2490 @c ==================================================================
2491 @node    Technical information
2492 @chapter Technical information
2493
2494
2495 @menu
2496 * The connection::
2497 * The meta-protocol::
2498 * Security::
2499 @end menu
2500
2501
2502 @c ==================================================================
2503 @node    The connection
2504 @section The connection
2505
2506 @cindex connection
2507 Tinc is a daemon that takes VPN data and transmit that to another host
2508 computer over the existing Internet infrastructure.
2509
2510 @menu
2511 * The UDP tunnel::
2512 * The meta-connection::
2513 @end menu
2514
2515
2516 @c ==================================================================
2517 @node    The UDP tunnel
2518 @subsection The UDP tunnel
2519
2520 @cindex virtual network device
2521 @cindex frame type
2522 The data itself is read from a character device file, the so-called
2523 @emph{virtual network device}.  This device is associated with a network
2524 interface.  Any data sent to this interface can be read from the device,
2525 and any data written to the device gets sent from the interface.
2526 There are two possible types of virtual network devices:
2527 `tun' style, which are point-to-point devices which can only handle IPv4 and/or IPv6 packets,
2528 and `tap' style, which are Ethernet devices and handle complete Ethernet frames.
2529
2530 So when tinc reads an Ethernet frame from the device, it determines its
2531 type. When tinc is in it's default routing mode, it can handle IPv4 and IPv6
2532 packets. Depending on the Subnet lines, it will send the packets off to their destination IP address.
2533 In the `switch' and `hub' mode, tinc will use broadcasts and MAC address discovery
2534 to deduce the destination of the packets.
2535 Since the latter modes only depend on the link layer information,
2536 any protocol that runs over Ethernet is supported (for instance IPX and Appletalk).
2537 However, only `tap' style devices provide this information.
2538
2539 After the destination has been determined,
2540 the packet will be compressed (optionally),
2541 a sequence number will be added to the packet,
2542 the packet will then be encrypted
2543 and a message authentication code will be appended.
2544
2545 @cindex encapsulating
2546 @cindex UDP
2547 When that is done, time has come to actually transport the
2548 packet to the destination computer.  We do this by sending the packet
2549 over an UDP connection to the destination host.  This is called
2550 @emph{encapsulating}, the VPN packet (though now encrypted) is
2551 encapsulated in another IP datagram.
2552
2553 When the destination receives this packet, the same thing happens, only
2554 in reverse.  So it checks the message authentication code, decrypts the contents of the UDP datagram,
2555 checks the sequence number
2556 and writes the decrypted information to its own virtual network device.
2557
2558 If the virtual network device is a `tun' device (a point-to-point tunnel),
2559 there is no problem for the kernel to accept a packet.
2560 However, if it is a `tap' device (this is the only available type on FreeBSD),
2561 the destination MAC address must match that of the virtual network interface.
2562 If tinc is in it's default routing mode, ARP does not work, so the correct destination MAC
2563 can not be known by the sending host.
2564 Tinc solves this by letting the receiving end detect the MAC address of its own virtual network interface
2565 and overwriting the destination MAC address of the received packet.
2566
2567 In switch or hub modes ARP does work so the sender already knows the correct destination MAC address.
2568 In those modes every interface should have a unique MAC address, so make sure they are not the same.
2569 Because switch and hub modes rely on MAC addresses to function correctly,
2570 these modes cannot be used on the following operating systems which don't have a `tap' style virtual network device:
2571 OpenBSD, NetBSD, Darwin and Solaris.
2572
2573
2574 @c ==================================================================
2575 @node    The meta-connection
2576 @subsection The meta-connection
2577
2578 Having only a UDP connection available is not enough.  Though suitable
2579 for transmitting data, we want to be able to reliably send other
2580 information, such as routing and session key information to somebody.
2581
2582 @cindex TCP
2583 TCP is a better alternative, because it already contains protection
2584 against information being lost, unlike UDP.
2585
2586 So we establish two connections.  One for the encrypted VPN data, and one
2587 for other information, the meta-data.  Hence, we call the second
2588 connection the meta-connection.  We can now be sure that the
2589 meta-information doesn't get lost on the way to another computer.
2590
2591 @cindex data-protocol
2592 @cindex meta-protocol
2593 Like with any communication, we must have a protocol, so that everybody
2594 knows what everything stands for, and how she should react.  Because we
2595 have two connections, we also have two protocols.  The protocol used for
2596 the UDP data is the ``data-protocol,'' the other one is the
2597 ``meta-protocol.''
2598
2599 The reason we don't use TCP for both protocols is that UDP is much
2600 better for encapsulation, even while it is less reliable.  The real
2601 problem is that when TCP would be used to encapsulate a TCP stream
2602 that's on the private network, for every packet sent there would be
2603 three ACKs sent instead of just one.  Furthermore, if there would be
2604 a timeout, both TCP streams would sense the timeout, and both would
2605 start re-sending packets.
2606
2607
2608 @c ==================================================================
2609 @node    The meta-protocol
2610 @section The meta-protocol
2611
2612 The meta protocol is used to tie all tinc daemons together, and
2613 exchange information about which tinc daemon serves which virtual
2614 subnet.
2615
2616 The meta protocol consists of requests that can be sent to the other
2617 side.  Each request has a unique number and several parameters.  All
2618 requests are represented in the standard ASCII character set.  It is
2619 possible to use tools such as telnet or netcat to connect to a tinc
2620 daemon started with the --bypass-security option
2621 and to read and write requests by hand, provided that one
2622 understands the numeric codes sent.
2623
2624 The authentication scheme is described in @ref{Security}. After a
2625 successful authentication, the server and the client will exchange all the
2626 information about other tinc daemons and subnets they know of, so that both
2627 sides (and all the other tinc daemons behind them) have their information
2628 synchronised.
2629
2630 @cindex ADD_EDGE
2631 @cindex ADD_SUBNET
2632 @example
2633 message
2634 ------------------------------------------------------------------
2635 ADD_EDGE node1 node2 21.32.43.54 655 222 0
2636           |     |        |       |   |  +-> options
2637           |     |        |       |   +----> weight
2638           |     |        |       +--------> UDP port of node2
2639           |     |        +----------------> real address of node2
2640           |     +-------------------------> name of destination node
2641           +-------------------------------> name of source node
2642
2643 ADD_SUBNET node 192.168.1.0/24
2644             |         |     +--> prefixlength
2645             |         +--------> network address
2646             +------------------> owner of this subnet
2647 ------------------------------------------------------------------
2648 @end example
2649
2650 The ADD_EDGE messages are to inform other tinc daemons that a connection between
2651 two nodes exist. The address of the destination node is available so that
2652 VPN packets can be sent directly to that node.
2653
2654 The ADD_SUBNET messages inform other tinc daemons that certain subnets belong
2655 to certain nodes. tinc will use it to determine to which node a VPN packet has
2656 to be sent.
2657
2658 @cindex DEL_EDGE
2659 @cindex DEL_SUBNET
2660 @example
2661 message
2662 ------------------------------------------------------------------
2663 DEL_EDGE node1 node2
2664            |     +----> name of destination node
2665            +----------> name of source node
2666
2667 DEL_SUBNET node 192.168.1.0/24
2668              |         |     +--> prefixlength
2669              |         +--------> network address
2670              +------------------> owner of this subnet
2671 ------------------------------------------------------------------
2672 @end example
2673
2674 In case a connection between two daemons is closed or broken, DEL_EDGE messages
2675 are sent to inform the other daemons of that fact. Each daemon will calculate a
2676 new route to the the daemons, or mark them unreachable if there isn't any.
2677
2678 @cindex REQ_KEY
2679 @cindex ANS_KEY
2680 @cindex KEY_CHANGED
2681 @example
2682 message
2683 ------------------------------------------------------------------
2684 REQ_KEY origin destination
2685            |       +--> name of the tinc daemon it wants the key from
2686            +----------> name of the daemon that wants the key
2687
2688 ANS_KEY origin destination 4ae0b0a82d6e0078 91 64 4
2689            |       |       \______________/ |  |  +--> MAC length
2690            |       |               |        |  +-----> digest algorithm
2691            |       |               |        +--------> cipher algorithm
2692            |       |               +--> 128 bits key
2693            |       +--> name of the daemon that wants the key
2694            +----------> name of the daemon that uses this key
2695
2696 KEY_CHANGED origin
2697               +--> daemon that has changed it's packet key
2698 ------------------------------------------------------------------
2699 @end example
2700
2701 The keys used to encrypt VPN packets are not sent out directly. This is
2702 because it would generate a lot of traffic on VPNs with many daemons, and
2703 chances are that not every tinc daemon will ever send a packet to every
2704 other daemon. Instead, if a daemon needs a key it sends a request for it
2705 via the meta connection of the nearest hop in the direction of the
2706 destination.
2707
2708 @cindex PING
2709 @cindex PONG
2710 @example
2711 daemon  message
2712 ------------------------------------------------------------------
2713 origin  PING
2714 dest.   PONG
2715 ------------------------------------------------------------------
2716 @end example
2717
2718 There is also a mechanism to check if hosts are still alive. Since network
2719 failures or a crash can cause a daemon to be killed without properly
2720 shutting down the TCP connection, this is necessary to keep an up to date
2721 connection list. PINGs are sent at regular intervals, except when there
2722 is also some other traffic. A little bit of salt (random data) is added
2723 with each PING and PONG message, to make sure that long sequences of PING/PONG
2724 messages without any other traffic won't result in known plaintext.
2725
2726 This basically covers what is sent over the meta connection by tinc.
2727
2728
2729 @c ==================================================================
2730 @node    Security
2731 @section Security
2732
2733 @cindex TINC
2734 @cindex Cabal
2735 Tinc got its name from ``TINC,'' short for @emph{There Is No Cabal}; the
2736 alleged Cabal was/is an organisation that was said to keep an eye on the
2737 entire Internet.  As this is exactly what you @emph{don't} want, we named
2738 the tinc project after TINC.
2739
2740 @cindex SVPN
2741 But in order to be ``immune'' to eavesdropping, you'll have to encrypt
2742 your data. Because tinc is a @emph{Secure} VPN (SVPN) daemon, it does
2743 exactly that: encrypt.
2744 However, encryption in itself does not prevent an attacker from modifying the encrypted data.
2745 Therefore, tinc also authenticates the data.
2746 Finally, tinc uses sequence numbers (which themselves are also authenticated) to prevent an attacker from replaying valid packets.
2747
2748 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.
2749 The SPTPS protocol is designed to address some weaknesses in the legacy protocol.
2750 The new authentication protocol is used when two nodes connect to each other that both have the ExperimentalProtocol option set to yes,
2751 otherwise the legacy protocol will be used.
2752
2753 @menu
2754 * Legacy authentication protocol::
2755 * Simple Peer-to-Peer Security::
2756 * Encryption of network packets::
2757 * Security issues::
2758 @end menu
2759
2760
2761 @c ==================================================================
2762 @node       Legacy authentication protocol
2763 @subsection Legacy authentication protocol
2764
2765 @cindex legacy authentication protocol
2766
2767 @cindex ID
2768 @cindex META_KEY
2769 @cindex CHALLENGE
2770 @cindex CHAL_REPLY
2771 @cindex ACK
2772 @example
2773 daemon  message
2774 --------------------------------------------------------------------------
2775 client  <attempts connection>
2776
2777 server  <accepts connection>
2778
2779 client  ID client 17.2
2780               |   |  +-> minor protocol version
2781               |   +----> major protocol version
2782               +--------> name of tinc daemon
2783
2784 server  ID server 17.2
2785               |   |  +-> minor protocol version
2786               |   +----> major protocol version
2787               +--------> name of tinc daemon
2788
2789 client  META_KEY 94 64 0 0 5f0823a93e35b69e...7086ec7866ce582b
2790                  |  |  | | \_________________________________/
2791                  |  |  | |                 +-> RSAKEYLEN bits totally random string S1,
2792                  |  |  | |                     encrypted with server's public RSA key
2793                  |  |  | +-> compression level
2794                  |  |  +---> MAC length
2795                  |  +------> digest algorithm NID
2796                  +---------> cipher algorithm NID
2797
2798 server  META_KEY 94 64 0 0 6ab9c1640388f8f0...45d1a07f8a672630
2799                  |  |  | | \_________________________________/
2800                  |  |  | |                 +-> RSAKEYLEN bits totally random string S2,
2801                  |  |  | |                     encrypted with client's public RSA key
2802                  |  |  | +-> compression level
2803                  |  |  +---> MAC length
2804                  |  +------> digest algorithm NID
2805                  +---------> cipher algorithm NID
2806 --------------------------------------------------------------------------
2807 @end example
2808
2809 The protocol allows each side to specify encryption algorithms and parameters,
2810 but in practice they are always fixed, since older versions of tinc did not
2811 allow them to be different from the default values. The cipher is always
2812 Blowfish in OFB mode, the digest is SHA1, but the MAC length is zero and no
2813 compression is used.
2814
2815 From now on:
2816 @itemize
2817 @item the client will symmetrically encrypt outgoing traffic using S1
2818 @item the server will symmetrically encrypt outgoing traffic using S2
2819 @end itemize
2820
2821 @example
2822 --------------------------------------------------------------------------
2823 client  CHALLENGE da02add1817c1920989ba6ae2a49cecbda0
2824                   \_________________________________/
2825                                  +-> CHALLEN bits totally random string H1
2826
2827 server  CHALLENGE 57fb4b2ccd70d6bb35a64c142f47e61d57f
2828                   \_________________________________/
2829                                  +-> CHALLEN bits totally random string H2
2830
2831 client  CHAL_REPLY 816a86
2832                       +-> 160 bits SHA1 of H2
2833
2834 server  CHAL_REPLY 928ffe
2835                       +-> 160 bits SHA1 of H1
2836
2837 After the correct challenge replies are received, both ends have proved
2838 their identity. Further information is exchanged.
2839
2840 client  ACK 655 123 0
2841              |   |  +-> options
2842              |   +----> estimated weight
2843              +--------> listening port of client
2844
2845 server  ACK 655 321 0
2846              |   |  +-> options
2847              |   +----> estimated weight
2848              +--------> listening port of server
2849 --------------------------------------------------------------------------
2850 @end example
2851
2852 This legacy authentication protocol has several weaknesses, pointed out by security export Peter Gutmann.
2853 First, data is encrypted with RSA without padding.
2854 Padding schemes are designed to prevent attacks when the size of the plaintext is not equal to the size of the RSA key.
2855 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.
2856 There might be timing or other side-channel attacks against RSA encryption and decryption, tinc does not employ any protection against those.
2857 Furthermore, both sides send identical messages to each other, there is no distinction between server and client,
2858 which could make a MITM attack easier.
2859 However, no exploit is known in which a third party who is not already trusted by other nodes in the VPN could gain access.
2860 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.
2861 In other words, the legacy protocol does not provide perfect forward secrecy.
2862
2863 @c ==================================================================
2864 @node       Simple Peer-to-Peer Security
2865 @subsection Simple Peer-to-Peer Security
2866 @cindex SPTPS
2867
2868 The SPTPS protocol is designed to address the weaknesses in the legacy protocol.
2869 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.
2870 Instead, SPTPS always uses a very strong cipher suite:
2871 peers authenticate each other using 521 bits ECC keys,
2872 Diffie-Hellman using ephemeral 521 bits ECC keys is used to provide perfect forward secrecy (PFS),
2873 AES-256-CTR is used for encryption, and HMAC-SHA-256 for message authentication.
2874
2875 Similar to TLS, messages are split up in records.
2876 A complete logical record contains the following information:
2877
2878 @itemize
2879 @item uint32_t seqno (network byte order)
2880 @item uint16_t length (network byte order)
2881 @item uint8_t type
2882 @item opaque data[length]
2883 @item opaque hmac[HMAC_SIZE] (HMAC over all preceding fields)
2884 @end itemize
2885
2886 Depending on whether SPTPS records are sent via TCP or UDP, either the seqno or the length field is omitted on the wire
2887 (but they are still included in the calculation of the HMAC);
2888 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;
2889 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.
2890
2891 The type field is used to distinguish between application records or handshake records.
2892 Types 0 to 127 are application records, type 128 is a handshake record, and types 129 to 255 are reserved.
2893
2894 Before the initial handshake, no fields are encrypted, and the HMAC field is not present.
2895 After the authentication handshake, the length (if present), type and data fields are encrypted, and the HMAC field is present.
2896 For UDP packets, the seqno field is not encrypted, as it is used to determine the value of the counter used for encryption.
2897
2898 The authentication consists of an exchange of Key EXchange, SIGnature and ACKnowledge messages, transmitted using type 128 records.
2899
2900 Overview:
2901
2902 @example
2903 Initiator   Responder
2904 ---------------------
2905 KEX ->
2906             <- KEX
2907 SIG ->
2908             <- SIG
2909
2910 ...encrypt and HMAC using session keys from now on...
2911
2912 App ->
2913             <- App
2914 ...
2915             ...
2916
2917 ...key renegotiation starts here...
2918
2919 KEX ->
2920             <- KEX
2921 SIG ->
2922             <- SIG
2923 ACK ->
2924             <- ACK
2925
2926 ...encrypt and HMAC using new session keys from now on...
2927
2928 App ->
2929             <- App
2930 ...
2931             ...
2932 ---------------------
2933 @end example
2934
2935 Note that the responder does not need to wait before it receives the first KEX message,
2936 it can immediately send its own once it has accepted an incoming connection.
2937
2938 Key EXchange message:
2939
2940 @itemize
2941 @item uint8_t kex_version (always 0 in this version of SPTPS)
2942 @item opaque nonce[32] (random number)
2943 @item opaque ecdh_key[ECDH_SIZE]
2944 @end itemize
2945
2946 SIGnature message:
2947
2948 @itemize
2949 @item opaque ecdsa_signature[ECDSA_SIZE]
2950 @end itemize
2951
2952 ACKnowledge message:
2953
2954 @itemize
2955 @item empty (only sent after key renegotiation)
2956 @end itemize
2957
2958 Remarks:
2959
2960 @itemize
2961 @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.
2962 @item After receiving the other's KEX message, both KEX messages are concatenated (see below),
2963   and the result is signed using ECDSA.
2964   The result is sent to the other.
2965 @item After receiving the other's SIG message, the signature is verified.
2966   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.
2967 @item The shared secret key is expanded using a PRF.
2968   Both nonces and the application specific label are also used as input for the PRF.
2969 @item An ACK message is sent only when doing key renegotiation, and is sent using the old encryption keys.
2970 @item The expanded key is used to key the encryption and HMAC algorithms.
2971 @end itemize
2972
2973 The signature is calculated over this string:
2974
2975 @itemize
2976 @item uint8_t initiator (0 = local peer, 1 = remote peer is initiator)
2977 @item opaque remote_kex_message[1 + 32 + ECDH_SIZE]
2978 @item opaque local_kex_message[1 + 32 + ECDH_SIZE]
2979 @item opaque label[label_length]
2980 @end itemize
2981
2982 The PRF is calculated as follows:
2983
2984 @itemize
2985 @item A HMAC using SHA512 is used, the shared secret is used as the key.
2986 @item For each block of 64 bytes, a HMAC is calculated. For block n: hmac[n] =
2987   HMAC_SHA512(hmac[n - 1] + seed)
2988 @item For the first block (n = 1), hmac[0] is given by HMAC_SHA512(zeroes + seed),
2989   where zeroes is a block of 64 zero bytes.
2990 @end itemize
2991
2992 The seed is as follows:
2993
2994 @itemize
2995 @item const char[13] "key expansion"
2996 @item opaque responder_nonce[32]
2997 @item opaque initiator_nonce[32]
2998 @item opaque label[label_length]
2999 @end itemize
3000
3001 The expanded key is used as follows:
3002
3003 @itemize
3004 @item opaque responder_cipher_key[CIPHER_KEYSIZE]
3005 @item opaque responder_digest_key[DIGEST_KEYSIZE]
3006 @item opaque initiator_cipher_key[CIPHER_KEYSIZE]
3007 @item opaque initiator_digest_key[DIGEST_KEYSIZE]
3008 @end itemize
3009
3010 Where initiator_cipher_key is the key used by session initiator to encrypt
3011 messages sent to the responder.
3012
3013 When using 256 bits Ed25519 keys, the AES-256-CTR cipher and HMAC-SHA-256 digest algorithm,
3014 the sizes are as follows:
3015
3016 @example
3017 ECDH_SIZE:       32 (= 256/8)
3018 ECDSA_SIZE:      64 (= 2 * 256/8)
3019 CIPHER_KEYSIZE:  48 (= 256/8 + 128/8)
3020 DIGEST_KEYSIZE:  32 (= 256/8)
3021 @end example
3022
3023 Note that the cipher key also includes the initial value for the counter.
3024
3025 @c ==================================================================
3026 @node       Encryption of network packets
3027 @subsection Encryption of network packets
3028 @cindex encryption
3029
3030 A data packet can only be sent if the encryption key is known to both
3031 parties, and the connection is  activated. If the encryption key is not
3032 known, a request is sent to the destination using the meta connection
3033 to retrieve it.
3034
3035 @cindex UDP
3036 The UDP packets can be either encrypted with the legacy protocol or with SPTPS.
3037 In case of the legacy protocol, the UDP packet containing the network packet from the VPN has the following layout:
3038
3039 @example
3040 ... | IP header | UDP header | seqno | VPN packet | MAC | UDP trailer
3041                              \___________________/\_____/
3042                                        |             |
3043                                        V             +---> digest algorithm
3044                          Encrypted with symmetric cipher
3045 @end example
3046
3047
3048
3049
3050 So, the entire VPN packet is encrypted using a symmetric cipher, including a 32 bits
3051 sequence number that is added in front of the actual VPN packet, to act as a unique
3052 IV for each packet and to prevent replay attacks. A message authentication code
3053 is added to the UDP packet to prevent alteration of packets.
3054 Tinc by default encrypts network packets using Blowfish with 128 bit keys in CBC mode
3055 and uses 4 byte long message authentication codes to make sure
3056 eavesdroppers cannot get and cannot change any information at all from the
3057 packets they can intercept. The encryption algorithm and message authentication
3058 algorithm can be changed in the configuration. The length of the message
3059 authentication codes is also adjustable. The length of the key for the
3060 encryption algorithm is always the default length used by OpenSSL.
3061
3062 The SPTPS protocol is described in @ref{Simple Peer-to-Peer Security}.
3063 For comparison, this is how SPTPS UDP packets look:
3064
3065 @example
3066 ... | IP header | UDP header | seqno | type | VPN packet | MAC | UDP trailer
3067                                      \__________________/\_____/
3068                                                |            |
3069                                                V            +---> digest algorithm
3070                                  Encrypted with symmetric cipher
3071 @end example
3072
3073 The difference is that the seqno is not encrypted, since the encryption cipher is used in CTR mode,
3074 and therefore the seqno must be known before the packet can be decrypted.
3075 Furthermore, the MAC is never truncated.
3076 The SPTPS protocol always uses the AES-256-CTR cipher and HMAC-SHA-256 digest,
3077 this cannot be changed.
3078
3079
3080 @c ==================================================================
3081 @node    Security issues
3082 @subsection Security issues
3083
3084 In August 2000, we discovered the existence of a security hole in all versions
3085 of tinc up to and including 1.0pre2. This had to do with the way we exchanged
3086 keys. Since then, we have been working on a new authentication scheme to make
3087 tinc as secure as possible. The current version uses the OpenSSL library and
3088 uses strong authentication with RSA keys.
3089
3090 On the 29th of December 2001, Jerome Etienne posted a security analysis of tinc
3091 1.0pre4. Due to a lack of sequence numbers and a message authentication code
3092 for each packet, an attacker could possibly disrupt certain network services or
3093 launch a denial of service attack by replaying intercepted packets. The current
3094 version adds sequence numbers and message authentication codes to prevent such
3095 attacks.
3096
3097 On the 15th of September 2003, Peter Gutmann posted a security analysis of tinc
3098 1.0.1. He argues that the 32 bit sequence number used by tinc is not a good IV,
3099 that tinc's default length of 4 bytes for the MAC is too short, and he doesn't
3100 like tinc's use of RSA during authentication. We do not know of a security hole
3101 in the legacy protocol of tinc, but it is not as strong as TLS or IPsec.
3102
3103 This version of tinc comes with an improved protocol, called Simple Peer-to-Peer Security,
3104 which aims to be as strong as TLS with one of the strongest cipher suites.
3105
3106 Cryptography is a hard thing to get right. We cannot make any
3107 guarantees. Time, review and feedback are the only things that can
3108 prove the security of any cryptographic product. If you wish to review
3109 tinc or give us feedback, you are stronly encouraged to do so.
3110
3111
3112 @c ==================================================================
3113 @node    Platform specific information
3114 @chapter Platform specific information
3115
3116 @menu
3117 * Interface configuration::
3118 * Routes::
3119 @end menu
3120
3121 @c ==================================================================
3122 @node    Interface configuration
3123 @section Interface configuration
3124
3125 When configuring an interface, one normally assigns it an address and a
3126 netmask.  The address uniquely identifies the host on the network attached to
3127 the interface.  The netmask, combined with the address, forms a subnet.  It is
3128 used to add a route to the routing table instructing the kernel to send all
3129 packets which fall into that subnet to that interface.  Because all packets for
3130 the entire VPN should go to the virtual network interface used by tinc, the
3131 netmask should be such that it encompasses the entire VPN.
3132
3133 For IPv4 addresses:
3134
3135 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
3136 @item Linux
3137 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
3138 @item Linux iproute2
3139 @tab @code{ip addr add} @var{address}@code{/}@var{prefixlength} @code{dev} @var{interface}
3140 @item FreeBSD
3141 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
3142 @item OpenBSD
3143 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
3144 @item NetBSD
3145 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
3146 @item Solaris
3147 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
3148 @item Darwin (MacOS/X)
3149 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
3150 @item Windows
3151 @tab @code{netsh interface ip set address} @var{interface} @code{static} @var{address} @var{netmask}
3152 @end multitable
3153
3154 For IPv6 addresses:
3155
3156 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
3157 @item Linux
3158 @tab @code{ifconfig} @var{interface} @code{add} @var{address}@code{/}@var{prefixlength}
3159 @item FreeBSD
3160 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
3161 @item OpenBSD
3162 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
3163 @item NetBSD
3164 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
3165 @item Solaris
3166 @tab @code{ifconfig} @var{interface} @code{inet6 plumb up}
3167 @item
3168 @tab @code{ifconfig} @var{interface} @code{inet6 addif} @var{address} @var{address}
3169 @item Darwin (MacOS/X)
3170 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
3171 @item Windows
3172 @tab @code{netsh interface ipv6 add address} @var{interface} @code{static} @var{address}/@var{prefixlength}
3173 @end multitable
3174
3175 On some platforms, when running tinc in switch mode, the VPN interface must be set to tap mode with an ifconfig command:
3176
3177 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
3178 @item OpenBSD
3179 @tab @code{ifconfig} @var{interface} @code{link0}
3180 @end multitable
3181
3182 On Linux, it is possible to create a persistent tun/tap interface which will
3183 continue to exist even if tinc quit, although this is normally not required.
3184 It can be useful to set up a tun/tap interface owned by a non-root user, so
3185 tinc can be started without needing any root privileges at all.
3186
3187 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
3188 @item Linux
3189 @tab @code{ip tuntap add dev} @var{interface} @code{mode} @var{tun|tap} @code{user} @var{username}
3190 @end multitable
3191
3192 @c ==================================================================
3193 @node    Routes
3194 @section Routes
3195
3196 In some cases it might be necessary to add more routes to the virtual network
3197 interface.  There are two ways to indicate which interface a packet should go
3198 to, one is to use the name of the interface itself, another way is to specify
3199 the (local) address that is assigned to that interface (@var{local_address}). The
3200 former way is unambiguous and therefore preferable, but not all platforms
3201 support this.
3202
3203 Adding routes to IPv4 subnets:
3204
3205 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
3206 @item Linux
3207 @tab @code{route add -net} @var{network_address} @code{netmask} @var{netmask} @var{interface}
3208 @item Linux iproute2
3209 @tab @code{ip route add} @var{network_address}@code{/}@var{prefixlength} @code{dev} @var{interface}
3210 @item FreeBSD
3211 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
3212 @item OpenBSD
3213 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
3214 @item NetBSD
3215 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
3216 @item Solaris
3217 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address} @code{-interface}
3218 @item Darwin (MacOS/X)
3219 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
3220 @item Windows
3221 @tab @code{netsh routing ip add persistentroute} @var{network_address} @var{netmask} @var{interface} @var{local_address}
3222 @end multitable
3223
3224 Adding routes to IPv6 subnets:
3225
3226 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
3227 @item Linux
3228 @tab @code{route add -A inet6} @var{network_address}@code{/}@var{prefixlength} @var{interface}
3229 @item Linux iproute2
3230 @tab @code{ip route add} @var{network_address}@code{/}@var{prefixlength} @code{dev} @var{interface}
3231 @item FreeBSD
3232 @tab @code{route add -inet6} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
3233 @item OpenBSD
3234 @tab @code{route add -inet6} @var{network_address} @var{local_address} @code{-prefixlen} @var{prefixlength}
3235 @item NetBSD
3236 @tab @code{route add -inet6} @var{network_address} @var{local_address} @code{-prefixlen} @var{prefixlength}
3237 @item Solaris
3238 @tab @code{route add -inet6} @var{network_address}@code{/}@var{prefixlength} @var{local_address} @code{-interface}
3239 @item Darwin (MacOS/X)
3240 @tab ?
3241 @item Windows
3242 @tab @code{netsh interface ipv6 add route} @var{network address}/@var{prefixlength} @var{interface}
3243 @end multitable
3244
3245
3246 @c ==================================================================
3247 @node    About us
3248 @chapter About us
3249
3250
3251 @menu
3252 * Contact information::
3253 * Authors::
3254 @end menu
3255
3256
3257 @c ==================================================================
3258 @node    Contact information
3259 @section Contact information
3260
3261 @cindex website
3262 Tinc's website is at @url{http://www.tinc-vpn.org/},
3263 this server is located in the Netherlands.
3264
3265 @cindex IRC
3266 We have an IRC channel on the FreeNode and OFTC IRC networks. Connect to
3267 @uref{http://www.freenode.net/, irc.freenode.net}
3268 or
3269 @uref{http://www.oftc.net/, irc.oftc.net}
3270 and join channel #tinc.
3271
3272
3273 @c ==================================================================
3274 @node    Authors
3275 @section Authors
3276
3277 @table @asis
3278 @item Ivo Timmermans (zarq)
3279 @item Guus Sliepen (guus) (@email{guus@@tinc-vpn.org})
3280 @end table
3281
3282 We have received a lot of valuable input from users.  With their help,
3283 tinc has become the flexible and robust tool that it is today.  We have
3284 composed a list of contributions, in the file called @file{THANKS} in
3285 the source distribution.
3286
3287
3288 @c ==================================================================
3289 @node    Concept Index
3290 @unnumbered Concept Index
3291
3292 @c ==================================================================
3293 @printindex cp
3294
3295
3296 @c ==================================================================
3297 @contents
3298 @bye