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