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