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