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