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