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