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