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