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