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