Releasing 1.0.12.
[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 GraphDumpFile
822 @item GraphDumpFile = <@var{filename}> [experimental]
823 If this option is present,
824 tinc will dump the current network graph to the file @var{filename}
825 every minute, unless there were no changes to the graph.
826 The file is in a format that can be read by graphviz tools.
827 If @var{filename} starts with a pipe symbol |,
828 then the rest of the filename is interpreted as a shell command
829 that is executed, the graph is then sent to stdin.
830
831 @cindex Hostnames
832 @item Hostnames = <yes|no> (no)
833 This option selects whether IP addresses (both real and on the VPN)
834 should be resolved.  Since DNS lookups are blocking, it might affect
835 tinc's efficiency, even stopping the daemon for a few seconds everytime
836 it does a lookup if your DNS server is not responding.
837
838 This does not affect resolving hostnames to IP addresses from the
839 configuration file.
840
841 @cindex Interface
842 @item Interface = <@var{interface}>
843 Defines the name of the interface corresponding to the virtual network device.
844 Depending on the operating system and the type of device this may or may not actually set the name of the interface.
845 Under Windows, this variable is used to select which network interface will be used.
846 If you specified a Device, this variable is almost always already correctly set.
847
848 @cindex Mode
849 @item Mode = <router|switch|hub> (router)
850 This option selects the way packets are routed to other daemons.
851
852 @table @asis
853 @cindex router
854 @item router
855 In this mode Subnet
856 variables in the host configuration files will be used to form a routing table.
857 Only unicast packets of routable protocols (IPv4 and IPv6) are supported in this mode.
858
859 This is the default mode, and unless you really know you need another mode, don't change it.
860
861 @cindex switch
862 @item switch
863 In this mode the MAC addresses of the packets on the VPN will be used to
864 dynamically create a routing table just like an Ethernet switch does.
865 Unicast, multicast and broadcast packets of every protocol that runs over Ethernet are supported in this mode
866 at the cost of frequent broadcast ARP requests and routing table updates.
867
868 This mode is primarily useful if you want to bridge Ethernet segments.
869
870 @cindex hub
871 @item hub
872 This mode is almost the same as the switch mode, but instead
873 every packet will be broadcast to the other daemons
874 while no routing table is managed.
875 @end table
876
877 @cindex KeyExpire
878 @item KeyExpire = <@var{seconds}> (3600)
879 This option controls the time the encryption keys used to encrypt the data
880 are valid.  It is common practice to change keys at regular intervals to
881 make it even harder for crackers, even though it is thought to be nearly
882 impossible to crack a single key.
883
884 @cindex MACExpire
885 @item MACExpire = <@var{seconds}> (600)
886 This option controls the amount of time MAC addresses are kept before they are removed.
887 This only has effect when Mode is set to "switch".
888
889 @cindex Name
890 @item Name = <@var{name}> [required]
891 This is a symbolic name for this connection.
892 The name should consist only of alfanumeric and underscore characters (a-z, A-Z, 0-9 and _).
893
894 @cindex PingInterval
895 @item PingInterval = <@var{seconds}> (60)
896 The number of seconds of inactivity that tinc will wait before sending a
897 probe to the other end.
898
899 @cindex PingTimeout
900 @item PingTimeout = <@var{seconds}> (5)
901 The number of seconds to wait for a response to pings or to allow meta
902 connections to block. If the other end doesn't respond within this time,
903 the connection is terminated, and the others will be notified of this.
904
905 @cindex PriorityInheritance
906 @item PriorityInheritance = <yes|no> (no) [experimental]
907 When this option is enabled the value of the TOS field of tunneled IPv4 packets
908 will be inherited by the UDP packets that are sent out.
909
910 @cindex PrivateKey
911 @item PrivateKey = <@var{key}> [obsolete]
912 This is the RSA private key for tinc. However, for safety reasons it is
913 advised to store private keys of any kind in separate files. This prevents
914 accidental eavesdropping if you are editting the configuration file.
915
916 @cindex PrivateKeyFile
917 @item PrivateKeyFile = <@var{path}> (@file{@value{sysconfdir}/tinc/@var{netname}/rsa_key.priv})
918 This is the full path name of the RSA private key file that was
919 generated by @samp{tincd --generate-keys}.  It must be a full path, not a
920 relative directory.
921
922 Note that there must be exactly one of PrivateKey
923 or PrivateKeyFile
924 specified in the configuration file.
925
926 @cindex ProcessPriority
927 @item ProcessPriority = <low|normal|high>
928 When this option is used the priority of the tincd process will be adjusted.
929 Increasing the priority may help to reduce latency and packet loss on the VPN.
930
931 @cindex TunnelServer
932 @item TunnelServer = <yes|no> (no) [experimental]
933 When this option is enabled tinc will no longer forward information between other tinc daemons,
934 and will only allow nodes and subnets on the VPN which are present in the
935 @file{@value{sysconfdir}/tinc/@var{netname}/hosts/} directory.
936
937 @end table
938
939
940 @c ==================================================================
941 @node       Host configuration variables
942 @subsection Host configuration variables
943
944 @table @asis
945 @cindex Address
946 @item Address = <@var{IP address}|@var{hostname}> [<port>] [recommended]
947 This variable is only required if you want to connect to this host.  It
948 must resolve to the external IP address where the host can be reached,
949 not the one that is internal to the VPN.
950 If no port is specified, the default Port is used.
951
952 @cindex Cipher
953 @item Cipher = <@var{cipher}> (blowfish)
954 The symmetric cipher algorithm used to encrypt UDP packets.
955 Any cipher supported by OpenSSL is recognized.
956 Furthermore, specifying "none" will turn off packet encryption.
957 It is best to use only those ciphers which support CBC mode.
958
959 @cindex ClampMSS
960 @item ClampMSS = <yes|no> (yes)
961 This option specifies whether tinc should clamp the maximum segment size (MSS)
962 of TCP packets to the path MTU. This helps in situations where ICMP
963 Fragmentation Needed or Packet too Big messages are dropped by firewalls.
964
965 @cindex Compression
966 @item Compression = <@var{level}> (0)
967 This option sets the level of compression used for UDP packets.
968 Possible values are 0 (off), 1 (fast zlib) and any integer up to 9 (best zlib),
969 10 (fast lzo) and 11 (best lzo).
970
971 @cindex Digest
972 @item Digest = <@var{digest}> (sha1)
973 The digest algorithm used to authenticate UDP packets.
974 Any digest supported by OpenSSL is recognized.
975 Furthermore, specifying "none" will turn off packet authentication.
976
977 @cindex IndirectData
978 @item IndirectData = <yes|no> (no)
979 This option specifies whether other tinc daemons besides the one you
980 specified with ConnectTo can make a direct connection to you.  This is
981 especially useful if you are behind a firewall and it is impossible to
982 make a connection from the outside to your tinc daemon.  Otherwise, it
983 is best to leave this option out or set it to no.
984
985 @cindex MACLength
986 @item MACLength = <@var{bytes}> (4)
987 The length of the message authentication code used to authenticate UDP packets.
988 Can be anything from 0
989 up to the length of the digest produced by the digest algorithm.
990
991 @cindex PMTU
992 @item PMTU = <@var{mtu}> (1514)
993 This option controls the initial path MTU to this node.
994
995 @cindex PMTUDiscovery
996 @item PMTUDiscovery = <yes|no> (yes)
997 When this option is enabled, tinc will try to discover the path MTU to this node.
998 After the path MTU has been discovered, it will be enforced on the VPN.
999
1000 @cindex Port
1001 @item Port = <@var{port}> (655)
1002 This is the port this tinc daemon listens on.
1003 You can use decimal portnumbers or symbolic names (as listed in @file{/etc/services}).
1004
1005 @cindex PublicKey
1006 @item PublicKey = <@var{key}> [obsolete]
1007 This is the RSA public key for this host.
1008
1009 @cindex PublicKeyFile
1010 @item PublicKeyFile = <@var{path}> [obsolete]
1011 This is the full path name of the RSA public key file that was generated
1012 by @samp{tincd --generate-keys}.  It must be a full path, not a relative
1013 directory.
1014
1015 @cindex PEM format
1016 From version 1.0pre4 on tinc will store the public key directly into the
1017 host configuration file in PEM format, the above two options then are not
1018 necessary. Either the PEM format is used, or exactly
1019 @strong{one of the above two options} must be specified
1020 in each host configuration file, if you want to be able to establish a
1021 connection with that host.
1022
1023 @cindex Subnet
1024 @item Subnet = <@var{address}[/@var{prefixlength}[#@var{weight}]]>
1025 The subnet which this tinc daemon will serve.
1026 Tinc tries to look up which other daemon it should send a packet to by searching the appropiate subnet.
1027 If the packet matches a subnet,
1028 it will be sent to the daemon who has this subnet in his host configuration file.
1029 Multiple subnet lines can be specified for each daemon.
1030
1031 Subnets can either be single MAC, IPv4 or IPv6 addresses,
1032 in which case a subnet consisting of only that single address is assumed,
1033 or they can be a IPv4 or IPv6 network address with a prefixlength.
1034 Shorthand notations are not supported.
1035 For example, IPv4 subnets must be in a form like 192.168.1.0/24,
1036 where 192.168.1.0 is the network address and 24 is the number of bits set in the netmask.
1037 Note that subnets like 192.168.1.1/24 are invalid!
1038 Read a networking HOWTO/FAQ/guide if you don't understand this.
1039 IPv6 subnets are notated like fec0:0:0:1:0:0:0:0/64.
1040 MAC addresses are notated like 0:1a:2b:3c:4d:5e.
1041
1042 @cindex CIDR notation
1043 Prefixlength is the number of bits set to 1 in the netmask part; for
1044 example: netmask 255.255.255.0 would become /24, 255.255.252.0 becomes
1045 /22. This conforms to standard CIDR notation as described in
1046 @uref{ftp://ftp.isi.edu/in-notes/rfc1519.txt, RFC1519}
1047
1048 @cindex Subnet weight
1049 A Subnet can be given a weight to indicate its priority over identical Subnets
1050 owned by different nodes. The default weight is 10. Lower values indicate
1051 higher priority. Packets will be sent to the node with the highest priority,
1052 unless that node is not reachable, in which case the node with the next highest
1053 priority will be tried, and so on.
1054
1055 @cindex TCPonly
1056 @item TCPonly = <yes|no> (no) [deprecated]
1057 If this variable is set to yes, then the packets are tunnelled over a
1058 TCP connection instead of a UDP connection.  This is especially useful
1059 for those who want to run a tinc daemon from behind a masquerading
1060 firewall, or if UDP packet routing is disabled somehow.
1061 Setting this options also implicitly sets IndirectData.
1062
1063 Since version 1.0.10, tinc will automatically detect whether communication via
1064 UDP is possible or not.
1065 @end table
1066
1067
1068 @c ==================================================================
1069 @node       Scripts
1070 @subsection Scripts
1071
1072 @cindex scripts
1073 Apart from reading the server and host configuration files,
1074 tinc can also run scripts at certain moments.
1075 Under Windows (not Cygwin), the scripts should have the extension .bat.
1076
1077 @table @file
1078 @cindex tinc-up
1079 @item @value{sysconfdir}/tinc/@var{netname}/tinc-up
1080 This is the most important script.
1081 If it is present it will be executed right after the tinc daemon has been
1082 started and has connected to the virtual network device.
1083 It should be used to set up the corresponding network interface,
1084 but can also be used to start other things.
1085 Under Windows you can use the Network Connections control panel instead of creating this script.
1086
1087 @cindex tinc-down
1088 @item @value{sysconfdir}/tinc/@var{netname}/tinc-down
1089 This script is started right before the tinc daemon quits.
1090
1091 @item @value{sysconfdir}/tinc/@var{netname}/hosts/@var{host}-up
1092 This script is started when the tinc daemon with name @var{host} becomes reachable.
1093
1094 @item @value{sysconfdir}/tinc/@var{netname}/hosts/@var{host}-down
1095 This script is started when the tinc daemon with name @var{host} becomes unreachable.
1096
1097 @item @value{sysconfdir}/tinc/@var{netname}/host-up
1098 This script is started when any host becomes reachable.
1099
1100 @item @value{sysconfdir}/tinc/@var{netname}/host-down
1101 This script is started when any host becomes unreachable.
1102
1103 @item @value{sysconfdir}/tinc/@var{netname}/subnet-up
1104 This script is started when a Subnet becomes reachable.
1105 The Subnet and the node it belongs to are passed in environment variables.
1106
1107 @item @value{sysconfdir}/tinc/@var{netname}/subnet-down
1108 This script is started when a Subnet becomes unreachable.
1109 @end table
1110
1111 @cindex environment variables
1112 The scripts are started without command line arguments,
1113 but can make use of certain environment variables.
1114 Under UNIX like operating systems the names of environment variables must be preceded by a $ in scripts.
1115 Under Windows, in @file{.bat} files, they have to be put between % signs.
1116
1117 @table @env
1118 @cindex NETNAME
1119 @item NETNAME
1120 If a netname was specified, this environment variable contains it.
1121
1122 @cindex NAME
1123 @item NAME
1124 Contains the name of this tinc daemon.
1125
1126 @cindex DEVICE
1127 @item DEVICE
1128 Contains the name of the virtual network device that tinc uses.
1129
1130 @cindex INTERFACE
1131 @item INTERFACE
1132 Contains the name of the virtual network interface that tinc uses.
1133 This should be used for commands like ifconfig.
1134
1135 @cindex NODE
1136 @item NODE
1137 When a host becomes (un)reachable, this is set to its name.
1138 If a subnet becomes (un)reachable, this is set to the owner of that subnet.
1139
1140 @cindex REMOTEADDRESS
1141 @item REMOTEADDRESS
1142 When a host becomes (un)reachable, this is set to its real address.
1143
1144 @cindex REMOTEPORT
1145 @item REMOTEPORT
1146 When a host becomes (un)reachable,
1147 this is set to the port number it uses for communication with other tinc daemons.
1148
1149 @cindex SUBNET
1150 @item SUBNET
1151 When a subnet becomes (un)reachable, this is set to the subnet.
1152
1153 @cindex WEIGHT
1154 @item WEIGHT
1155 When a subnet becomes (un)reachable, this is set to the subnet weight.
1156
1157 @end table
1158
1159
1160 @c ==================================================================
1161 @node       How to configure
1162 @subsection How to configure
1163
1164 @subsubheading Step 1.  Creating the main configuration file
1165
1166 The main configuration file will be called @file{@value{sysconfdir}/tinc/@var{netname}/tinc.conf}.
1167 Adapt the following example to create a basic configuration file:
1168
1169 @example
1170 Name = @var{yourname}
1171 Device = @file{/dev/tap0}
1172 @end example
1173
1174 Then, if you know to which other tinc daemon(s) yours is going to connect,
1175 add `ConnectTo' values.
1176
1177 @subsubheading Step 2.  Creating your host configuration file
1178
1179 If you added a line containing `Name = yourname' in the main configuarion file,
1180 you will need to create a host configuration file @file{@value{sysconfdir}/tinc/@var{netname}/hosts/yourname}.
1181 Adapt the following example to create a host configuration file:
1182
1183 @example
1184 Address = your.real.hostname.org
1185 Subnet = 192.168.1.0/24
1186 @end example
1187
1188 You can also use an IP address instead of a hostname.
1189 The `Subnet' specifies the address range that is local for @emph{your part of the VPN only}.
1190 If you have multiple address ranges you can specify more than one `Subnet'.
1191 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).
1192
1193
1194 @c ==================================================================
1195 @node    Generating keypairs
1196 @section Generating keypairs
1197
1198 @cindex key generation
1199 Now that you have already created the main configuration file and your host configuration file,
1200 you can easily create a public/private keypair by entering the following command:
1201
1202 @example
1203 tincd -n @var{netname} -K
1204 @end example
1205
1206 Tinc will generate a public and a private key and ask you where to put them.
1207 Just press enter to accept the defaults.
1208
1209
1210 @c ==================================================================
1211 @node    Network interfaces
1212 @section Network interfaces
1213
1214 Before tinc can start transmitting data over the tunnel, it must
1215 set up the virtual network interface.
1216
1217 First, decide which IP addresses you want to have associated with these
1218 devices, and what network mask they must have.
1219
1220 Tinc will open a virtual network device (@file{/dev/tun}, @file{/dev/tap0} or similar),
1221 which will also create a network interface called something like @samp{tun0}, @samp{tap0}.
1222 If you are using the Linux tun/tap driver, the network interface will by default have the same name as the @var{netname}.
1223 Under Windows you can change the name of the network interface from the Network Connections control panel.
1224
1225 @cindex tinc-up
1226 You can configure the network interface by putting ordinary ifconfig, route, and other commands
1227 to a script named @file{@value{sysconfdir}/tinc/@var{netname}/tinc-up}.
1228 When tinc starts, this script will be executed. When tinc exits, it will execute the script named
1229 @file{@value{sysconfdir}/tinc/@var{netname}/tinc-down}, but normally you don't need to create that script.
1230
1231 An example @file{tinc-up} script:
1232
1233 @example
1234 #!/bin/sh
1235 ifconfig $INTERFACE 192.168.1.1 netmask 255.255.0.0
1236 @end example
1237
1238 This script gives the interface an IP address and a netmask.
1239 The kernel will also automatically add a route to this interface, so normally you don't need
1240 to add route commands to the @file{tinc-up} script.
1241 The kernel will also bring the interface up after this command.
1242 @cindex netmask
1243 The netmask is the mask of the @emph{entire} VPN network, not just your
1244 own subnet.
1245
1246 The exact syntax of the ifconfig and route commands differs from platform to platform.
1247 You can look up the commands for setting addresses and adding routes in @ref{Platform specific information},
1248 but it is best to consult the manpages of those utilities on your platform.
1249
1250
1251 @c ==================================================================
1252 @node    Example configuration
1253 @section Example configuration
1254
1255
1256 @cindex example
1257 Imagine the following situation.  Branch A of our example `company' wants to connect
1258 three branch offices in B, C and D using the Internet.  All four offices
1259 have a 24/7 connection to the Internet.
1260
1261 A is going to serve as the center of the network.  B and C will connect
1262 to A, and D will connect to C.  Each office will be assigned their own IP
1263 network, 10.x.0.0.
1264
1265 @example
1266 A: net 10.1.0.0 mask 255.255.0.0 gateway 10.1.54.1 internet IP 1.2.3.4
1267 B: net 10.2.0.0 mask 255.255.0.0 gateway 10.2.1.12 internet IP 2.3.4.5
1268 C: net 10.3.0.0 mask 255.255.0.0 gateway 10.3.69.254 internet IP 3.4.5.6
1269 D: net 10.4.0.0 mask 255.255.0.0 gateway 10.4.3.32 internet IP 4.5.6.7
1270 @end example
1271
1272 Here, ``gateway'' is the VPN IP address of the machine that is running the
1273 tincd, and ``internet IP'' is the IP address of the firewall, which does not
1274 need to run tincd, but it must do a port forwarding of TCP and UDP on port
1275 655 (unless otherwise configured).
1276
1277 In this example, it is assumed that eth0 is the interface that points to
1278 the inner (physical) LAN of the office, although this could also be the
1279 same as the interface that leads to the Internet.  The configuration of
1280 the real interface is also shown as a comment, to give you an idea of
1281 how these example host is set up. All branches use the netname `company'
1282 for this particular VPN.
1283
1284 @subsubheading For Branch A
1285
1286 @emph{BranchA} would be configured like this:
1287
1288 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1289
1290 @example
1291 # Real interface of internal network:
1292 # ifconfig eth0 10.1.54.1 netmask 255.255.0.0
1293
1294 ifconfig $INTERFACE 10.1.54.1 netmask 255.0.0.0
1295 @end example
1296
1297 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1298
1299 @example
1300 Name = BranchA
1301 Device = /dev/tap0
1302 @end example
1303
1304 On all hosts, @file{@value{sysconfdir}/tinc/company/hosts/BranchA} contains:
1305
1306 @example
1307 Subnet = 10.1.0.0/16
1308 Address = 1.2.3.4
1309
1310 -----BEGIN RSA PUBLIC KEY-----
1311 ...
1312 -----END RSA PUBLIC KEY-----
1313 @end example
1314
1315 Note that the IP addresses of eth0 and tap0 are the same.
1316 This is quite possible, if you make sure that the netmasks of the interfaces are different.
1317 It is in fact recommended to give give both real internal network interfaces and tap interfaces the same IP address,
1318 since that will make things a lot easier to remember and set up.
1319
1320
1321 @subsubheading For Branch B
1322
1323 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1324
1325 @example
1326 # Real interface of internal network:
1327 # ifconfig eth0 10.2.43.8 netmask 255.255.0.0
1328
1329 ifconfig $INTERFACE 10.2.1.12 netmask 255.0.0.0
1330 @end example
1331
1332 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1333
1334 @example
1335 Name = BranchB
1336 ConnectTo = BranchA
1337 @end example
1338
1339 Note here that the internal address (on eth0) doesn't have to be the
1340 same as on the tap0 device.  Also, ConnectTo is given so that no-one can
1341 connect to this node.
1342
1343 On all hosts, in @file{@value{sysconfdir}/tinc/company/hosts/BranchB}:
1344
1345 @example
1346 Subnet = 10.2.0.0/16
1347 Address = 2.3.4.5
1348
1349 -----BEGIN RSA PUBLIC KEY-----
1350 ...
1351 -----END RSA PUBLIC KEY-----
1352 @end example
1353
1354
1355 @subsubheading For Branch C
1356
1357 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1358
1359 @example
1360 # Real interface of internal network:
1361 # ifconfig eth0 10.3.69.254 netmask 255.255.0.0
1362
1363 ifconfig $INTERFACE 10.3.69.254 netmask 255.0.0.0
1364 @end example
1365
1366 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1367
1368 @example
1369 Name = BranchC
1370 ConnectTo = BranchA
1371 Device = /dev/tap1
1372 @end example
1373
1374 C already has another daemon that runs on port 655, so they have to
1375 reserve another port for tinc. It knows the portnumber it has to listen on
1376 from it's own host configuration file.
1377
1378 On all hosts, in @file{@value{sysconfdir}/tinc/company/hosts/BranchC}:
1379
1380 @example
1381 Address = 3.4.5.6
1382 Subnet = 10.3.0.0/16
1383 Port = 2000
1384
1385 -----BEGIN RSA PUBLIC KEY-----
1386 ...
1387 -----END RSA PUBLIC KEY-----
1388 @end example
1389
1390
1391 @subsubheading For Branch D
1392
1393 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1394
1395 @example
1396 # Real interface of internal network:
1397 # ifconfig eth0 10.4.3.32 netmask 255.255.0.0
1398
1399 ifconfig $INTERFACE 10.4.3.32 netmask 255.0.0.0
1400 @end example
1401
1402 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1403
1404 @example
1405 Name = BranchD
1406 ConnectTo = BranchC
1407 Device = /dev/net/tun
1408 @end example
1409
1410 D will be connecting to C, which has a tincd running for this network on
1411 port 2000. It knows the port number from the host configuration file.
1412 Also note that since D uses the tun/tap driver, the network interface
1413 will not be called `tun' or `tap0' or something like that, but will
1414 have the same name as netname.
1415
1416 On all hosts, in @file{@value{sysconfdir}/tinc/company/hosts/BranchD}:
1417
1418 @example
1419 Subnet = 10.4.0.0/16
1420 Address = 4.5.6.7
1421
1422 -----BEGIN RSA PUBLIC KEY-----
1423 ...
1424 -----END RSA PUBLIC KEY-----
1425 @end example
1426
1427 @subsubheading Key files
1428
1429 A, B, C and D all have generated a public/private keypair with the following command:
1430
1431 @example
1432 tincd -n company -K
1433 @end example
1434
1435 The private key is stored in @file{@value{sysconfdir}/tinc/company/rsa_key.priv},
1436 the public key is put into the host configuration file in the @file{@value{sysconfdir}/tinc/company/hosts/} directory.
1437 During key generation, tinc automatically guesses the right filenames based on the -n option and
1438 the Name directive in the @file{tinc.conf} file (if it is available).
1439
1440 @subsubheading Starting
1441
1442 After each branch has finished configuration and they have distributed
1443 the host configuration files amongst them, they can start their tinc daemons.
1444 They don't necessarily have to wait for the other branches to have started
1445 their daemons, tinc will try connecting until they are available.
1446
1447
1448 @c ==================================================================
1449 @node    Running tinc
1450 @chapter Running tinc
1451
1452 If everything else is done, you can start tinc by typing the following command:
1453
1454 @example
1455 tincd -n @var{netname}
1456 @end example
1457
1458 @cindex daemon
1459 Tinc will detach from the terminal and continue to run in the background like a good daemon.
1460 If there are any problems however you can try to increase the debug level
1461 and look in the syslog to find out what the problems are.
1462
1463 @menu
1464 * Runtime options::
1465 * Signals::
1466 * Debug levels::
1467 * Solving problems::
1468 * Error messages::
1469 * Sending bug reports::
1470 @end menu
1471
1472
1473 @c ==================================================================
1474 @node    Runtime options
1475 @section Runtime options
1476
1477 Besides the settings in the configuration file, tinc also accepts some
1478 command line options.
1479
1480 @cindex command line
1481 @cindex runtime options
1482 @cindex options
1483 @c from the manpage
1484 @table @option
1485 @item -c, --config=@var{path}
1486 Read configuration options from the directory @var{path}.  The default is
1487 @file{@value{sysconfdir}/tinc/@var{netname}/}.
1488
1489 @item -D, --no-detach
1490 Don't fork and detach.
1491 This will also disable the automatic restart mechanism for fatal errors.
1492
1493 @cindex debug level
1494 @item -d, --debug=@var{level}
1495 Set debug level to @var{level}.  The higher the debug level, the more gets
1496 logged.  Everything goes via syslog.
1497
1498 @item -k, --kill[=@var{signal}]
1499 Attempt to kill a running tincd (optionally with the specified @var{signal} instead of SIGTERM) and exit.
1500 Use it in conjunction with the -n option to make sure you kill the right tinc daemon.
1501 Under native Windows the optional argument is ignored,
1502 the service will always be stopped and removed.
1503
1504 @item -n, --net=@var{netname}
1505 Use configuration for net @var{netname}. @xref{Multiple networks}.
1506
1507 @item -K, --generate-keys[=@var{bits}]
1508 Generate public/private keypair of @var{bits} length. If @var{bits} is not specified,
1509 2048 is the default. tinc will ask where you want to store the files,
1510 but will default to the configuration directory (you can use the -c or -n option
1511 in combination with -K). After that, tinc will quit.
1512
1513 @item -L, --mlock
1514 Lock tinc into main memory.
1515 This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.
1516
1517 @item --logfile[=@var{file}]
1518 Write log entries to a file instead of to the system logging facility.
1519 If @var{file} is omitted, the default is @file{@value{localstatedir}/log/tinc.@var{netname}.log}.
1520
1521 @item --pidfile=@var{file}
1522 Write PID to @var{file} instead of @file{@value{localstatedir}/run/tinc.@var{netname}.pid}.
1523
1524 @item --bypass-security
1525 Disables encryption and authentication.
1526 Only useful for debugging.
1527
1528 @item -R, --chroot
1529 Change process root directory to the directory where the config file is
1530 located (@file{@value{sysconfdir}/tinc/@var{netname}/} as determined by
1531 -n/--net option or as given by -c/--config option), for added security.
1532 The chroot is performed after all the initialization is done, after
1533 writing pid files and opening network sockets.
1534
1535 Note that this option alone does not do any good without -U/--user, below.
1536
1537 Note also that tinc can't run scripts anymore (such as tinc-down or host-up),
1538 unless it's setup to be runnable inside chroot environment.
1539
1540 @item -U, --user=@var{user}
1541 Switch to the given @var{user} after initialization, at the same time as
1542 chroot is performed (see --chroot above).  With this option tinc drops
1543 privileges, for added security.
1544
1545 @item --help
1546 Display a short reminder of these runtime options and terminate.
1547
1548 @item --version
1549 Output version information and exit.
1550
1551 @end table
1552
1553 @c ==================================================================
1554 @node    Signals
1555 @section Signals
1556
1557 @cindex signals
1558 You can also send the following signals to a running tincd process:
1559
1560 @c from the manpage
1561 @table @samp
1562
1563 @item ALRM
1564 Forces tinc to try to connect to all uplinks immediately.
1565 Usually tinc attempts to do this itself,
1566 but increases the time it waits between the attempts each time it failed,
1567 and if tinc didn't succeed to connect to an uplink the first time after it started,
1568 it defaults to the maximum time of 15 minutes.
1569
1570 @item HUP
1571 Partially rereads configuration files.
1572 Connections to hosts whose host config file are removed are closed.
1573 New outgoing connections specified in @file{tinc.conf} will be made.
1574
1575 @item INT
1576 Temporarily increases debug level to 5.
1577 Send this signal again to revert to the original level.
1578
1579 @item USR1
1580 Dumps the connection list to syslog.
1581
1582 @item USR2
1583 Dumps virtual network device statistics, all known nodes, edges and subnets to syslog.
1584
1585 @item WINCH
1586 Purges all information remembered about unreachable nodes.
1587
1588 @end table
1589
1590 @c ==================================================================
1591 @node    Debug levels
1592 @section Debug levels
1593
1594 @cindex debug levels
1595 The tinc daemon can send a lot of messages to the syslog.
1596 The higher the debug level, the more messages it will log.
1597 Each level inherits all messages of the previous level:
1598
1599 @c from the manpage
1600 @table @samp
1601
1602 @item 0
1603 This will log a message indicating tinc has started along with a version number.
1604 It will also log any serious error.
1605
1606 @item 1
1607 This will log all connections that are made with other tinc daemons.
1608
1609 @item 2
1610 This will log status and error messages from scripts and other tinc daemons.
1611
1612 @item 3
1613 This will log all requests that are exchanged with other tinc daemons. These include
1614 authentication, key exchange and connection list updates.
1615
1616 @item 4
1617 This will log a copy of everything received on the meta socket.
1618
1619 @item 5
1620 This will log all network traffic over the virtual private network.
1621
1622 @end table
1623
1624 @c ==================================================================
1625 @node    Solving problems
1626 @section Solving problems
1627
1628 If tinc starts without problems, but if the VPN doesn't work, you will have to find the cause of the problem.
1629 The first thing to do is to start tinc with a high debug level in the foreground,
1630 so you can directly see everything tinc logs:
1631
1632 @example
1633 tincd -n @var{netname} -d5 -D
1634 @end example
1635
1636 If tinc does not log any error messages, then you might want to check the following things:
1637
1638 @itemize
1639 @item @file{tinc-up} script
1640 Does this script contain the right commands?
1641 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.
1642
1643 @item Subnet
1644 Does the Subnet (or Subnets) in the host configuration file of this host match the portion of the VPN that belongs to this host?
1645
1646 @item Firewalls and NATs
1647 Do you have a firewall or a NAT device (a masquerading firewall or perhaps an ADSL router that performs masquerading)?
1648 If so, check that it allows TCP and UDP traffic on port 655.
1649 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.
1650 You can add @samp{TCPOnly = yes} to your host config file to force tinc to only use a single TCP connection,
1651 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.
1652
1653 @end itemize
1654
1655
1656 @c ==================================================================
1657 @node    Error messages
1658 @section Error messages
1659
1660 What follows is a list of the most common error messages you might find in the logs.
1661 Some of them will only be visible if the debug level is high enough.
1662
1663 @table @samp
1664 @item Could not open /dev/tap0: No such device
1665
1666 @itemize
1667 @item You forgot to `modprobe netlink_dev' or `modprobe ethertap'.
1668 @item You forgot to compile `Netlink device emulation' in the kernel.
1669 @end itemize
1670
1671 @item Can't write to /dev/net/tun: No such device
1672
1673 @itemize
1674 @item You forgot to `modprobe tun'.
1675 @item You forgot to compile `Universal TUN/TAP driver' in the kernel.
1676 @item The tun device is located somewhere else in @file{/dev/}.
1677 @end itemize
1678
1679 @item Network address and prefix length do not match!
1680
1681 @itemize
1682 @item The Subnet field must contain a @emph{network} address, trailing bits should be 0.
1683 @item If you only want to use one IP address, set the netmask to /32.
1684 @end itemize
1685
1686 @item Error reading RSA key file `rsa_key.priv': No such file or directory
1687
1688 @itemize
1689 @item You forgot to create a public/private keypair.
1690 @item Specify the complete pathname to the private key file with the @samp{PrivateKeyFile} option.
1691 @end itemize
1692
1693 @item Warning: insecure file permissions for RSA private key file `rsa_key.priv'!
1694
1695 @itemize
1696 @item The private key file is readable by users other than root.
1697 Use chmod to correct the file permissions.
1698 @end itemize
1699
1700 @item Creating metasocket failed: Address family not supported
1701
1702 @itemize
1703 @item By default tinc tries to create both IPv4 and IPv6 sockets.
1704 On some platforms this might not be implemented.
1705 If the logs show @samp{Ready} later on, then at least one metasocket was created,
1706 and you can ignore this message.
1707 You can add @samp{AddressFamily = ipv4} to @file{tinc.conf} to prevent this from happening.
1708 @end itemize
1709
1710 @item Cannot route packet: unknown IPv4 destination 1.2.3.4
1711
1712 @itemize
1713 @item You try to send traffic to a host on the VPN for which no Subnet is known.
1714 @item If it is a broadcast address (ending in .255), it probably is a samba server or a Windows host sending broadcast packets.
1715 You can ignore it.
1716 @end itemize
1717
1718 @item Cannot route packet: ARP request for unknown address 1.2.3.4
1719
1720 @itemize
1721 @item You try to send traffic to a host on the VPN for which no Subnet is known.
1722 @end itemize
1723
1724 @item Packet with destination 1.2.3.4 is looping back to us!
1725
1726 @itemize
1727 @item Something is not configured right. Packets are being sent out to the
1728 virtual network device, but according to the Subnet directives in your host configuration
1729 file, those packets should go to your own host. Most common mistake is that
1730 you have a Subnet line in your host configuration file with a prefix length which is
1731 just as large as the prefix of the virtual network interface. The latter should in almost all
1732 cases be larger. Rethink your configuration.
1733 Note that you will only see this message if you specified a debug
1734 level of 5 or higher!
1735 @item Chances are that a @samp{Subnet = ...} line in the host configuration file of this tinc daemon is wrong.
1736 Change it to a subnet that is accepted locally by another interface,
1737 or if that is not the case, try changing the prefix length into /32. 
1738 @end itemize
1739
1740 @item Node foo (1.2.3.4) is not reachable
1741
1742 @itemize
1743 @item Node foo does not have a connection anymore, its tinc daemon is not running or its connection to the Internet is broken.
1744 @end itemize
1745
1746 @item Received UDP packet from unknown source 1.2.3.4 (port 12345)
1747
1748 @itemize
1749 @item If you see this only sporadically, it is harmless and caused by a node sending packets using an old key.
1750 @end itemize
1751
1752 @item Got bad/bogus/unauthorized REQUEST from foo (1.2.3.4 port 12345)
1753
1754 @itemize
1755 @item Node foo does not have the right public/private keypair.
1756 Generate new keypairs and distribute them again.
1757 @item An attacker tries to gain access to your VPN.
1758 @item A network error caused corruption of metadata sent from foo.
1759 @end itemize
1760
1761 @end table
1762
1763 @c ==================================================================
1764 @node    Sending bug reports
1765 @section Sending bug reports
1766
1767 If you really can't find the cause of a problem, or if you suspect tinc is not working right,
1768 you can send us a bugreport, see @ref{Contact information}.
1769 Be sure to include the following information in your bugreport:
1770
1771 @itemize
1772 @item A clear description of what you are trying to achieve and what the problem is.
1773 @item What platform (operating system, version, hardware architecture) and which version of tinc you use.
1774 @item If compiling tinc fails, a copy of @file{config.log} and the error messages you get.
1775 @item Otherwise, a copy of @file{tinc.conf}, @file{tinc-up} and all files in the @file{hosts/} directory.
1776 @item The output of the commands @samp{ifconfig -a} and @samp{route -n} (or @samp{netstat -rn} if that doesn't work).
1777 @item The output of any command that fails to work as it should (like ping or traceroute).
1778 @end itemize
1779
1780 @c ==================================================================
1781 @node    Technical information
1782 @chapter Technical information
1783
1784
1785 @menu
1786 * The connection::
1787 * The meta-protocol::
1788 * Security::
1789 @end menu
1790
1791
1792 @c ==================================================================
1793 @node    The connection
1794 @section The connection
1795
1796 @cindex connection
1797 Tinc is a daemon that takes VPN data and transmit that to another host
1798 computer over the existing Internet infrastructure.
1799
1800 @menu
1801 * The UDP tunnel::
1802 * The meta-connection::
1803 @end menu
1804
1805
1806 @c ==================================================================
1807 @node    The UDP tunnel
1808 @subsection The UDP tunnel
1809
1810 @cindex virtual network device
1811 @cindex frame type
1812 The data itself is read from a character device file, the so-called
1813 @emph{virtual network device}.  This device is associated with a network
1814 interface.  Any data sent to this interface can be read from the device,
1815 and any data written to the device gets sent from the interface.
1816 There are two possible types of virtual network devices:
1817 `tun' style, which are point-to-point devices which can only handle IPv4 and/or IPv6 packets,
1818 and `tap' style, which are Ethernet devices and handle complete Ethernet frames.
1819
1820 So when tinc reads an Ethernet frame from the device, it determines its
1821 type. When tinc is in it's default routing mode, it can handle IPv4 and IPv6
1822 packets. Depending on the Subnet lines, it will send the packets off to their destination IP address.
1823 In the `switch' and `hub' mode, tinc will use broadcasts and MAC address discovery
1824 to deduce the destination of the packets.
1825 Since the latter modes only depend on the link layer information,
1826 any protocol that runs over Ethernet is supported (for instance IPX and Appletalk).
1827 However, only `tap' style devices provide this information.
1828
1829 After the destination has been determined,
1830 the packet will be compressed (optionally),
1831 a sequence number will be added to the packet,
1832 the packet will then be encrypted
1833 and a message authentication code will be appended.
1834
1835 @cindex encapsulating
1836 @cindex UDP
1837 When that is done, time has come to actually transport the
1838 packet to the destination computer.  We do this by sending the packet
1839 over an UDP connection to the destination host.  This is called
1840 @emph{encapsulating}, the VPN packet (though now encrypted) is
1841 encapsulated in another IP datagram.
1842
1843 When the destination receives this packet, the same thing happens, only
1844 in reverse.  So it checks the message authentication code, decrypts the contents of the UDP datagram,
1845 checks the sequence number
1846 and writes the decrypted information to its own virtual network device.
1847
1848 If the virtual network device is a `tun' device (a point-to-point tunnel),
1849 there is no problem for the kernel to accept a packet.
1850 However, if it is a `tap' device (this is the only available type on FreeBSD),
1851 the destination MAC address must match that of the virtual network interface.
1852 If tinc is in it's default routing mode, ARP does not work, so the correct destination MAC 
1853 can not be known by the sending host.
1854 Tinc solves this by letting the receiving end detect the MAC address of its own virtual network interface
1855 and overwriting the destination MAC address of the received packet.
1856
1857 In switch or hub modes ARP does work so the sender already knows the correct destination MAC address.
1858 In those modes every interface should have a unique MAC address, so make sure they are not the same.
1859 Because switch and hub modes rely on MAC addresses to function correctly,
1860 these modes cannot be used on the following operating systems which don't have a `tap' style virtual network device:
1861 OpenBSD, NetBSD, Darwin and Solaris.
1862
1863
1864 @c ==================================================================
1865 @node    The meta-connection
1866 @subsection The meta-connection
1867
1868 Having only a UDP connection available is not enough.  Though suitable
1869 for transmitting data, we want to be able to reliably send other
1870 information, such as routing and session key information to somebody.
1871
1872 @cindex TCP
1873 TCP is a better alternative, because it already contains protection
1874 against information being lost, unlike UDP.
1875
1876 So we establish two connections.  One for the encrypted VPN data, and one
1877 for other information, the meta-data.  Hence, we call the second
1878 connection the meta-connection.  We can now be sure that the
1879 meta-information doesn't get lost on the way to another computer.
1880
1881 @cindex data-protocol
1882 @cindex meta-protocol
1883 Like with any communication, we must have a protocol, so that everybody
1884 knows what everything stands for, and how she should react.  Because we
1885 have two connections, we also have two protocols.  The protocol used for
1886 the UDP data is the ``data-protocol,'' the other one is the
1887 ``meta-protocol.''
1888
1889 The reason we don't use TCP for both protocols is that UDP is much
1890 better for encapsulation, even while it is less reliable.  The real
1891 problem is that when TCP would be used to encapsulate a TCP stream
1892 that's on the private network, for every packet sent there would be
1893 three ACKs sent instead of just one.  Furthermore, if there would be
1894 a timeout, both TCP streams would sense the timeout, and both would
1895 start re-sending packets.
1896
1897
1898 @c ==================================================================
1899 @node    The meta-protocol
1900 @section The meta-protocol
1901
1902 The meta protocol is used to tie all tinc daemons together, and
1903 exchange information about which tinc daemon serves which virtual
1904 subnet.
1905
1906 The meta protocol consists of requests that can be sent to the other
1907 side.  Each request has a unique number and several parameters.  All
1908 requests are represented in the standard ASCII character set.  It is
1909 possible to use tools such as telnet or netcat to connect to a tinc
1910 daemon started with the --bypass-security option
1911 and to read and write requests by hand, provided that one
1912 understands the numeric codes sent.
1913
1914 The authentication scheme is described in @ref{Authentication protocol}. After a
1915 successful authentication, the server and the client will exchange all the
1916 information about other tinc daemons and subnets they know of, so that both
1917 sides (and all the other tinc daemons behind them) have their information
1918 synchronised.
1919
1920 @cindex ADD_EDGE
1921 @cindex ADD_SUBNET
1922 @example
1923 message
1924 ------------------------------------------------------------------
1925 ADD_EDGE node1 node2 21.32.43.54 655 222 0
1926           |     |        |       |   |  +-> options
1927           |     |        |       |   +----> weight
1928           |     |        |       +--------> UDP port of node2
1929           |     |        +----------------> real address of node2
1930           |     +-------------------------> name of destination node
1931           +-------------------------------> name of source node
1932
1933 ADD_SUBNET node 192.168.1.0/24
1934             |         |     +--> prefixlength
1935             |         +--------> network address
1936             +------------------> owner of this subnet
1937 ------------------------------------------------------------------
1938 @end example
1939
1940 The ADD_EDGE messages are to inform other tinc daemons that a connection between
1941 two nodes exist. The address of the destination node is available so that
1942 VPN packets can be sent directly to that node.
1943
1944 The ADD_SUBNET messages inform other tinc daemons that certain subnets belong
1945 to certain nodes. tinc will use it to determine to which node a VPN packet has
1946 to be sent.
1947
1948 @cindex DEL_EDGE
1949 @cindex DEL_SUBNET
1950 @example
1951 message
1952 ------------------------------------------------------------------
1953 DEL_EDGE node1 node2
1954            |     +----> name of destination node
1955            +----------> name of source node
1956
1957 DEL_SUBNET node 192.168.1.0/24
1958              |         |     +--> prefixlength
1959              |         +--------> network address
1960              +------------------> owner of this subnet
1961 ------------------------------------------------------------------
1962 @end example
1963
1964 In case a connection between two daemons is closed or broken, DEL_EDGE messages
1965 are sent to inform the other daemons of that fact. Each daemon will calculate a
1966 new route to the the daemons, or mark them unreachable if there isn't any.
1967
1968 @cindex REQ_KEY
1969 @cindex ANS_KEY
1970 @cindex KEY_CHANGED
1971 @example
1972 message
1973 ------------------------------------------------------------------
1974 REQ_KEY origin destination
1975            |       +--> name of the tinc daemon it wants the key from
1976            +----------> name of the daemon that wants the key      
1977
1978 ANS_KEY origin destination 4ae0b0a82d6e0078 91 64 4
1979            |       |       \______________/ |  |  +--> MAC length
1980            |       |               |        |  +-----> digest algorithm
1981            |       |               |        +--------> cipher algorithm
1982            |       |               +--> 128 bits key
1983            |       +--> name of the daemon that wants the key
1984            +----------> name of the daemon that uses this key
1985
1986 KEY_CHANGED origin
1987               +--> daemon that has changed it's packet key
1988 ------------------------------------------------------------------
1989 @end example
1990
1991 The keys used to encrypt VPN packets are not sent out directly. This is
1992 because it would generate a lot of traffic on VPNs with many daemons, and
1993 chances are that not every tinc daemon will ever send a packet to every
1994 other daemon. Instead, if a daemon needs a key it sends a request for it
1995 via the meta connection of the nearest hop in the direction of the
1996 destination.
1997
1998 @cindex PING
1999 @cindex PONG
2000 @example
2001 daemon  message
2002 ------------------------------------------------------------------
2003 origin  PING
2004 dest.   PONG
2005 ------------------------------------------------------------------
2006 @end example
2007
2008 There is also a mechanism to check if hosts are still alive. Since network
2009 failures or a crash can cause a daemon to be killed without properly
2010 shutting down the TCP connection, this is necessary to keep an up to date
2011 connection list. PINGs are sent at regular intervals, except when there
2012 is also some other traffic. A little bit of salt (random data) is added
2013 with each PING and PONG message, to make sure that long sequences of PING/PONG
2014 messages without any other traffic won't result in known plaintext.
2015
2016 This basically covers what is sent over the meta connection by tinc.
2017
2018
2019 @c ==================================================================
2020 @node    Security
2021 @section Security
2022
2023 @cindex TINC
2024 @cindex Cabal
2025 Tinc got its name from ``TINC,'' short for @emph{There Is No Cabal}; the
2026 alleged Cabal was/is an organisation that was said to keep an eye on the
2027 entire Internet.  As this is exactly what you @emph{don't} want, we named
2028 the tinc project after TINC.
2029
2030 @cindex SVPN
2031 But in order to be ``immune'' to eavesdropping, you'll have to encrypt
2032 your data.  Because tinc is a @emph{Secure} VPN (SVPN) daemon, it does
2033 exactly that: encrypt.
2034 Tinc by default uses blowfish encryption with 128 bit keys in CBC mode, 32 bit
2035 sequence numbers and 4 byte long message authentication codes to make sure
2036 eavesdroppers cannot get and cannot change any information at all from the
2037 packets they can intercept. The encryption algorithm and message authentication
2038 algorithm can be changed in the configuration. The length of the message
2039 authentication codes is also adjustable. The length of the key for the
2040 encryption algorithm is always the default length used by OpenSSL.
2041
2042 @menu
2043 * Authentication protocol::
2044 * Encryption of network packets::
2045 * Security issues::
2046 @end menu
2047
2048
2049 @c ==================================================================
2050 @node       Authentication protocol
2051 @subsection Authentication protocol
2052
2053 @cindex authentication
2054 A new scheme for authentication in tinc has been devised, which offers some
2055 improvements over the protocol used in 1.0pre2 and 1.0pre3. Explanation is
2056 below.
2057
2058 @cindex ID
2059 @cindex META_KEY
2060 @cindex CHALLENGE
2061 @cindex CHAL_REPLY
2062 @cindex ACK
2063 @example
2064 daemon  message
2065 --------------------------------------------------------------------------
2066 client  <attempts connection>
2067
2068 server  <accepts connection>
2069
2070 client  ID client 12
2071               |   +---> version
2072               +-------> name of tinc daemon
2073
2074 server  ID server 12
2075               |   +---> version
2076               +-------> name of tinc daemon
2077
2078 client  META_KEY 5f0823a93e35b69e...7086ec7866ce582b
2079                  \_________________________________/
2080                                  +-> RSAKEYLEN bits totally random string S1,
2081                                      encrypted with server's public RSA key
2082
2083 server  META_KEY 6ab9c1640388f8f0...45d1a07f8a672630
2084                  \_________________________________/
2085                                  +-> RSAKEYLEN bits totally random string S2,
2086                                      encrypted with client's public RSA key
2087
2088 From now on:
2089  - the client will symmetrically encrypt outgoing traffic using S1
2090  - the server will symmetrically encrypt outgoing traffic using S2
2091
2092 client  CHALLENGE da02add1817c1920989ba6ae2a49cecbda0
2093                   \_________________________________/
2094                                  +-> CHALLEN bits totally random string H1
2095
2096 server  CHALLENGE 57fb4b2ccd70d6bb35a64c142f47e61d57f
2097                   \_________________________________/
2098                                  +-> CHALLEN bits totally random string H2
2099
2100 client  CHAL_REPLY 816a86
2101                       +-> 160 bits SHA1 of H2
2102
2103 server  CHAL_REPLY 928ffe
2104                       +-> 160 bits SHA1 of H1
2105
2106 After the correct challenge replies are received, both ends have proved
2107 their identity. Further information is exchanged.
2108
2109 client  ACK 655 123 0
2110              |   |  +-> options
2111                  |   +----> estimated weight
2112                  +--------> listening port of client
2113
2114 server  ACK 655 321 0
2115              |   |  +-> options
2116                  |   +----> estimated weight
2117                  +--------> listening port of server
2118 --------------------------------------------------------------------------
2119 @end example
2120
2121 This new scheme has several improvements, both in efficiency and security.
2122
2123 First of all, the server sends exactly the same kind of messages over the wire
2124 as the client. The previous versions of tinc first authenticated the client,
2125 and then the server. This scheme even allows both sides to send their messages
2126 simultaneously, there is no need to wait for the other to send something first.
2127 This means that any calculations that need to be done upon sending or receiving
2128 a message can also be done in parallel. This is especially important when doing
2129 RSA encryption/decryption. Given that these calculations are the main part of
2130 the CPU time spent for the authentication, speed is improved by a factor 2.
2131
2132 Second, only one RSA encrypted message is sent instead of two. This reduces the
2133 amount of information attackers can see (and thus use for a cryptographic
2134 attack). It also improves speed by a factor two, making the total speedup a
2135 factor 4.
2136
2137 Third, and most important:
2138 The symmetric cipher keys are exchanged first, the challenge is done
2139 afterwards. In the previous authentication scheme, because a man-in-the-middle
2140 could pass the challenge/chal_reply phase (by just copying the messages between
2141 the two real tinc daemons), but no information was exchanged that was really
2142 needed to read the rest of the messages, the challenge/chal_reply phase was of
2143 no real use. The man-in-the-middle was only stopped by the fact that only after
2144 the ACK messages were encrypted with the symmetric cipher. Potentially, it
2145 could even send it's own symmetric key to the server (if it knew the server's
2146 public key) and read some of the metadata the server would send it (it was
2147 impossible for the mitm to read actual network packets though). The new scheme
2148 however prevents this.
2149
2150 This new scheme makes sure that first of all, symmetric keys are exchanged. The
2151 rest of the messages are then encrypted with the symmetric cipher. Then, each
2152 side can only read received messages if they have their private key. The
2153 challenge is there to let the other side know that the private key is really
2154 known, because a challenge reply can only be sent back if the challenge is
2155 decrypted correctly, and that can only be done with knowledge of the private
2156 key.
2157
2158 Fourth: the first thing that is sent via the symmetric cipher encrypted
2159 connection is a totally random string, so that there is no known plaintext (for
2160 an attacker) in the beginning of the encrypted stream.
2161
2162
2163 @c ==================================================================
2164 @node       Encryption of network packets
2165 @subsection Encryption of network packets
2166 @cindex encryption
2167
2168 A data packet can only be sent if the encryption key is known to both
2169 parties, and the connection is  activated. If the encryption key is not
2170 known, a request is sent to the destination using the meta connection
2171 to retrieve it. The packet is stored in a queue while waiting for the
2172 key to arrive.
2173
2174 @cindex UDP
2175 The UDP packet containing the network packet from the VPN has the following layout:
2176
2177 @example
2178 ... | IP header | UDP header | seqno | VPN packet | MAC | UDP trailer
2179                              \___________________/\_____/
2180                                        |             |
2181                                        V             +---> digest algorithm
2182                          Encrypted with symmetric cipher
2183 @end example
2184
2185 So, the entire VPN packet is encrypted using a symmetric cipher, including a 32 bits
2186 sequence number that is added in front of the actual VPN packet, to act as a unique
2187 IV for each packet and to prevent replay attacks. A message authentication code
2188 is added to the UDP packet to prevent alteration of packets. By default the
2189 first 4 bytes of the digest are used for this, but this can be changed using
2190 the MACLength configuration variable.
2191
2192 @c ==================================================================
2193 @node    Security issues
2194 @subsection Security issues
2195
2196 In August 2000, we discovered the existence of a security hole in all versions
2197 of tinc up to and including 1.0pre2. This had to do with the way we exchanged
2198 keys. Since then, we have been working on a new authentication scheme to make
2199 tinc as secure as possible. The current version uses the OpenSSL library and
2200 uses strong authentication with RSA keys.
2201
2202 On the 29th of December 2001, Jerome Etienne posted a security analysis of tinc
2203 1.0pre4. Due to a lack of sequence numbers and a message authentication code
2204 for each packet, an attacker could possibly disrupt certain network services or
2205 launch a denial of service attack by replaying intercepted packets. The current
2206 version adds sequence numbers and message authentication codes to prevent such
2207 attacks.
2208
2209 On the 15th of September 2003, Peter Gutmann posted a security analysis of tinc
2210 1.0.1. He argues that the 32 bit sequence number used by tinc is not a good IV,
2211 that tinc's default length of 4 bytes for the MAC is too short, and he doesn't
2212 like tinc's use of RSA during authentication. We do not know of a security hole
2213 in this version of tinc, but tinc's security is not as strong as TLS or IPsec.
2214 We will address these issues in tinc 2.0.
2215
2216 Cryptography is a hard thing to get right. We cannot make any
2217 guarantees. Time, review and feedback are the only things that can
2218 prove the security of any cryptographic product. If you wish to review
2219 tinc or give us feedback, you are stronly encouraged to do so.
2220
2221
2222 @c ==================================================================
2223 @node    Platform specific information
2224 @chapter Platform specific information
2225
2226 @menu
2227 * Interface configuration::
2228 * Routes::
2229 @end menu
2230
2231 @c ==================================================================
2232 @node    Interface configuration
2233 @section Interface configuration
2234
2235 When configuring an interface, one normally assigns it an address and a
2236 netmask.  The address uniquely identifies the host on the network attached to
2237 the interface.  The netmask, combined with the address, forms a subnet.  It is
2238 used to add a route to the routing table instructing the kernel to send all
2239 packets which fall into that subnet to that interface.  Because all packets for
2240 the entire VPN should go to the virtual network interface used by tinc, the
2241 netmask should be such that it encompasses the entire VPN.
2242
2243 For IPv4 addresses:
2244
2245 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
2246 @item Linux
2247 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
2248 @item Linux iproute2
2249 @tab @code{ip addr add} @var{address}@code{/}@var{prefixlength} @code{dev} @var{interface}
2250 @item FreeBSD
2251 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
2252 @item OpenBSD
2253 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
2254 @item NetBSD
2255 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
2256 @item Solaris
2257 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
2258 @item Darwin (MacOS/X)
2259 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
2260 @item Windows
2261 @tab @code{netsh interface ip set address} @var{interface} @code{static} @var{address} @var{netmask}
2262 @end multitable
2263
2264
2265 For IPv6 addresses:
2266
2267 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
2268 @item Linux
2269 @tab @code{ifconfig} @var{interface} @code{add} @var{address}@code{/}@var{prefixlength}
2270 @item FreeBSD
2271 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
2272 @item OpenBSD
2273 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
2274 @item NetBSD
2275 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
2276 @item Solaris
2277 @tab @code{ifconfig} @var{interface} @code{inet6 plumb up}
2278 @item
2279 @tab @code{ifconfig} @var{interface} @code{inet6 addif} @var{address} @var{address}
2280 @item Darwin (MacOS/X)
2281 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
2282 @item Windows
2283 @tab @code{netsh interface ipv6 add address} @var{interface} @code{static} @var{address}/@var{prefixlength}
2284 @end multitable
2285
2286
2287 @c ==================================================================
2288 @node    Routes
2289 @section Routes
2290
2291 In some cases it might be necessary to add more routes to the virtual network
2292 interface.  There are two ways to indicate which interface a packet should go
2293 to, one is to use the name of the interface itself, another way is to specify
2294 the (local) address that is assigned to that interface (@var{local_address}). The
2295 former way is unambiguous and therefore preferable, but not all platforms
2296 support this.
2297
2298 Adding routes to IPv4 subnets:
2299
2300 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
2301 @item Linux
2302 @tab @code{route add -net} @var{network_address} @code{netmask} @var{netmask} @var{interface}
2303 @item Linux iproute2
2304 @tab @code{ip route add} @var{network_address}@code{/}@var{prefixlength} @code{dev} @var{interface}
2305 @item FreeBSD
2306 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
2307 @item OpenBSD
2308 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
2309 @item NetBSD
2310 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
2311 @item Solaris
2312 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address} @code{-interface}
2313 @item Darwin (MacOS/X)
2314 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
2315 @item Windows
2316 @tab @code{netsh routing ip add persistentroute} @var{network_address} @var{netmask} @var{interface} @var{local_address}
2317 @end multitable
2318
2319 Adding routes to IPv6 subnets:
2320
2321 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
2322 @item Linux
2323 @tab @code{route add -A inet6} @var{network_address}@code{/}@var{prefixlength} @var{interface}
2324 @item Linux iproute2
2325 @tab @code{ip route add} @var{network_address}@code{/}@var{prefixlength} @code{dev} @var{interface}
2326 @item FreeBSD
2327 @tab @code{route add -inet6} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
2328 @item OpenBSD
2329 @tab @code{route add -inet6} @var{network_address} @var{local_address} @code{-prefixlen} @var{prefixlength}
2330 @item NetBSD
2331 @tab @code{route add -inet6} @var{network_address} @var{local_address} @code{-prefixlen} @var{prefixlength}
2332 @item Solaris
2333 @tab @code{route add -inet6} @var{network_address}@code{/}@var{prefixlength} @var{local_address} @code{-interface}
2334 @item Darwin (MacOS/X)
2335 @tab ?
2336 @item Windows
2337 @tab @code{netsh interface ipv6 add route} @var{network address}/@var{prefixlength} @var{interface}
2338 @end multitable
2339
2340
2341 @c ==================================================================
2342 @node    About us
2343 @chapter About us
2344
2345
2346 @menu
2347 * Contact information::
2348 * Authors::
2349 @end menu
2350
2351
2352 @c ==================================================================
2353 @node    Contact information
2354 @section Contact information
2355
2356 @cindex website
2357 Tinc's website is at @url{http://www.tinc-vpn.org/},
2358 this server is located in the Netherlands.
2359
2360 @cindex IRC
2361 We have an IRC channel on the FreeNode and OFTC IRC networks. Connect to
2362 @uref{http://www.freenode.net/, irc.freenode.net}
2363 or
2364 @uref{http://www.oftc.net/, irc.oftc.net}
2365 and join channel #tinc.
2366
2367
2368 @c ==================================================================
2369 @node    Authors
2370 @section Authors
2371
2372 @table @asis
2373 @item Ivo Timmermans (zarq)
2374 @item Guus Sliepen (guus) (@email{guus@@tinc-vpn.org})
2375 @end table
2376
2377 We have received a lot of valuable input from users.  With their help,
2378 tinc has become the flexible and robust tool that it is today.  We have
2379 composed a list of contributions, in the file called @file{THANKS} in
2380 the source distribution.
2381
2382
2383 @c ==================================================================
2384 @node    Concept Index
2385 @unnumbered Concept Index
2386
2387 @c ==================================================================
2388 @printindex cp
2389
2390
2391 @c ==================================================================
2392 @contents
2393 @bye