6337b3c7278bb07c3ddfc6d605aaafe49046c38e
[tinc] / doc / tinc.texi
1 \input texinfo   @c -*-texinfo-*-
2 @c %**start of header
3 @setfilename tinc.info
4 @settitle tinc Manual
5 @setchapternewpage odd
6 @c %**end of header
7
8 @include tincinclude.texi
9
10 @ifinfo
11 @dircategory Networking tools
12 @direntry
13 * tinc: (tinc).              The tinc Manual.
14 @end direntry
15
16 This is the info manual for @value{PACKAGE} version @value{VERSION}, a Virtual Private Network daemon.
17
18 Copyright @copyright{} 1998-2012 Ivo Timmermans,
19 Guus Sliepen <guus@@tinc-vpn.org> and
20 Wessel Dankers <wsl@@tinc-vpn.org>.
21
22 Permission is granted to make and distribute verbatim copies of this
23 manual provided the copyright notice and this permission notice are
24 preserved on all copies.
25
26 Permission is granted to copy and distribute modified versions of this
27 manual under the conditions for verbatim copying, provided that the
28 entire resulting derived work is distributed under the terms of a
29 permission notice identical to this one.
30
31 @end ifinfo
32
33 @titlepage
34 @title tinc Manual
35 @subtitle Setting up a Virtual Private Network with tinc
36 @author Ivo Timmermans and Guus Sliepen
37
38 @page
39 @vskip 0pt plus 1filll
40 This is the info manual for @value{PACKAGE} version @value{VERSION}, a Virtual Private Network daemon.
41
42 Copyright @copyright{} 1998-2012 Ivo Timmermans,
43 Guus Sliepen <guus@@tinc-vpn.org> and
44 Wessel Dankers <wsl@@tinc-vpn.org>.
45
46 Permission is granted to make and distribute verbatim copies of this
47 manual provided the copyright notice and this permission notice are
48 preserved on all copies.
49
50 Permission is granted to copy and distribute modified versions of this
51 manual under the conditions for verbatim copying, provided that the
52 entire resulting derived work is distributed under the terms of a
53 permission notice identical to this one.
54
55 @end titlepage
56
57 @ifnottex
58 @c ==================================================================
59 @node Top
60 @top Top
61
62 @menu
63 * Introduction::
64 * Preparations::
65 * Installation::
66 * Configuration::
67 * Running tinc::
68 * Controlling tinc::
69 * Technical information::
70 * Platform specific information::
71 * About us::
72 * Concept Index::               All used terms explained
73 @end menu
74 @end ifnottex
75
76 @c ==================================================================
77 @node    Introduction
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 * Virtual Private Networks::
96 * tinc::                        About tinc
97 * Supported platforms::
98 @end menu
99
100 @c ==================================================================
101 @node    Virtual Private Networks
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 single 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
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 "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
177 @section Supported platforms
178
179 @cindex platforms
180 Tinc has been verified to work under Linux, FreeBSD, OpenBSD, NetBSD, MacOS/X (Darwin), Solaris, and Windows (both natively and in a Cygwin environment),
181 with 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://www.tinc-vpn.org/platforms/}.
191
192 @c
193 @c
194 @c
195 @c
196 @c
197 @c
198 @c       Preparing your system
199 @c
200 @c
201 @c
202 @c
203 @c
204
205 @c ==================================================================
206 @node    Preparations
207 @chapter Preparations
208
209 This chapter contains information on how to prepare your system to
210 support tinc.
211
212 @menu
213 * Configuring the kernel::
214 * Libraries::
215 @end menu
216
217
218 @c ==================================================================
219 @node    Configuring the kernel
220 @section Configuring the kernel
221
222 @menu
223 * Configuration of Linux kernels::
224 * Configuration of FreeBSD kernels::
225 * Configuration of OpenBSD kernels::
226 * Configuration of NetBSD kernels::
227 * Configuration of Solaris kernels::
228 * Configuration of Darwin (MacOS/X) kernels::
229 * Configuration of Windows::
230 @end menu
231
232
233 @c ==================================================================
234 @node       Configuration of Linux kernels
235 @subsection Configuration of Linux kernels
236
237 @cindex Universal tun/tap
238 For tinc to work, you need a kernel that supports the Universal tun/tap device.
239 Most distributions come with kernels that already support this.
240 Here are the options you have to turn on when configuring a new kernel:
241
242 @example
243 Code maturity level options
244 [*] Prompt for development and/or incomplete code/drivers
245 Network device support
246 <M> Universal tun/tap device driver support
247 @end example
248
249 It's not necessary to compile this driver as a module, even if you are going to
250 run more than one instance of tinc.
251
252 If you decide to build the tun/tap driver as a kernel module, add these lines
253 to @file{/etc/modules.conf}:
254
255 @example
256 alias char-major-10-200 tun
257 @end example
258
259
260 @c ==================================================================
261 @node       Configuration of FreeBSD kernels
262 @subsection Configuration of FreeBSD kernels
263
264 For FreeBSD version 4.1 and higher, tun and tap drivers are included in the default kernel configuration.
265 The tap driver can be loaded with @code{kldload if_tap}, or by adding @code{if_tap_load="YES"} to @file{/boot/loader.conf}. 
266
267
268 @c ==================================================================
269 @node       Configuration of OpenBSD kernels
270 @subsection Configuration of OpenBSD kernels
271
272 For OpenBSD version 2.9 and higher,
273 the tun driver is included in the default kernel configuration.
274 There is also a kernel patch from @uref{http://diehard.n-r-g.com/stuff/openbsd/}
275 which adds a tap device to OpenBSD which should work with tinc,
276 but with recent versions of OpenBSD,
277 a tun device can act as a tap device by setting the link0 option with ifconfig.
278
279
280 @c ==================================================================
281 @node       Configuration of NetBSD kernels
282 @subsection Configuration of NetBSD kernels
283
284 For NetBSD version 1.5.2 and higher,
285 the tun driver is included in the default kernel configuration.
286
287 Tunneling IPv6 may not work on NetBSD's tun device.
288
289
290 @c ==================================================================
291 @node       Configuration of Solaris kernels
292 @subsection Configuration of Solaris kernels
293
294 For Solaris 8 (SunOS 5.8) and higher,
295 the tun driver may or may not be included in the default kernel configuration.
296 If it isn't, the source can be downloaded from @uref{http://vtun.sourceforge.net/tun/}.
297 For x86 and sparc64 architectures, precompiled versions can be found at @uref{http://www.monkey.org/~dugsong/fragroute/}.
298 If the @file{net/if_tun.h} header file is missing, install it from the source package.
299
300
301 @c ==================================================================
302 @node       Configuration of Darwin (MacOS/X) kernels
303 @subsection Configuration of Darwin (MacOS/X) kernels
304
305 Tinc on Darwin relies on a tunnel driver for its data acquisition from the kernel.
306 Tinc supports either the driver from @uref{http://tuntaposx.sourceforge.net/},
307 which supports both tun and tap style devices,
308 and also the driver from from @uref{http://chrisp.de/en/projects/tunnel.html}.
309 The former driver is recommended.
310 The tunnel driver must be loaded before starting tinc with the following command:
311
312 @example
313 kmodload tunnel
314 @end example
315
316
317 @c ==================================================================
318 @node       Configuration of Windows
319 @subsection Configuration of Windows
320
321 You will need to install the latest TAP-Win32 driver from OpenVPN.
322 You can download it from @uref{http://openvpn.sourceforge.net}.
323 Using the Network Connections control panel,
324 configure the TAP-Win32 network interface in the same way as you would do from the tinc-up script,
325 as explained in the rest of the documentation.
326
327
328 @c ==================================================================
329 @node    Libraries
330 @section Libraries
331
332 @cindex requirements
333 @cindex libraries
334 Before you can configure or build tinc, you need to have the OpenSSL,
335 zlib and lzo libraries installed on your system.  If you try to configure tinc without
336 having them installed, configure will give you an error message, and stop.
337
338 @menu
339 * OpenSSL::
340 * zlib::
341 * lzo::
342 * libevent::
343 * libcurses::
344 * libreadline::
345 @end menu
346
347
348 @c ==================================================================
349 @node       OpenSSL
350 @subsection OpenSSL
351
352 @cindex OpenSSL
353 For all cryptography-related functions, tinc uses the functions provided
354 by the OpenSSL library.
355
356 If this library is not installed, you wil get an error when configuring
357 tinc for build.  Support for running tinc with other cryptographic libraries
358 installed @emph{may} be added in the future.
359
360 You can use your operating system's package manager to install this if
361 available.  Make sure you install the development AND runtime versions
362 of this package.
363
364 If you have to install OpenSSL manually, you can get the source code
365 from @url{http://www.openssl.org/}.  Instructions on how to configure,
366 build and install this package are included within the package.  Please
367 make sure you build development and runtime libraries (which is the
368 default).
369
370 If you installed the OpenSSL libraries from source, it may be necessary
371 to let configure know where they are, by passing configure one of the
372 --with-openssl-* parameters.
373
374 @example
375 --with-openssl=DIR      OpenSSL library and headers prefix
376 --with-openssl-include=DIR OpenSSL headers directory
377                         (Default is OPENSSL_DIR/include)
378 --with-openssl-lib=DIR  OpenSSL library directory
379                         (Default is OPENSSL_DIR/lib)
380 @end example
381
382
383 @subsubheading License
384
385 @cindex license
386 The complete source code of tinc is covered by the GNU GPL version 2.
387 Since the license under which OpenSSL is distributed is not directly
388 compatible with the terms of the GNU GPL
389 @uref{http://www.openssl.org/support/faq.html#LEGAL2}, we
390 include an exemption to the GPL (see also the file COPYING.README) to allow
391 everyone to create a statically or dynamically linked executable:
392
393 @quotation
394 This program is released under the GPL with the additional exemption
395 that compiling, linking, and/or using OpenSSL is allowed.  You may
396 provide binary packages linked to the OpenSSL libraries, provided that
397 all other requirements of the GPL are met.
398 @end quotation
399
400 Since the LZO library used by tinc is also covered by the GPL,
401 we also present the following exemption:
402
403 @quotation
404 Hereby I grant a special exception to the tinc VPN project
405 (http://www.tinc-vpn.org/) to link the LZO library with the OpenSSL library
406 (http://www.openssl.org).
407
408 Markus F.X.J. Oberhumer
409 @end quotation
410
411
412 @c ==================================================================
413 @node       zlib
414 @subsection zlib
415
416 @cindex zlib
417 For the optional compression of UDP packets, tinc uses the functions provided
418 by the zlib library.
419
420 If this library is not installed, you wil get an error when running the
421 configure script.  You can either install the zlib library, or disable support
422 for zlib compression by using the "--disable-zlib" option when running the
423 configure script. Note that if you disable support for zlib, the resulting
424 binary will not work correctly on VPNs where zlib compression is used.
425
426 You can use your operating system's package manager to install this if
427 available.  Make sure you install the development AND runtime versions
428 of this package.
429
430 If you have to install zlib manually, you can get the source code
431 from @url{http://www.gzip.org/zlib/}.  Instructions on how to configure,
432 build and install this package are included within the package.  Please
433 make sure you build development and runtime libraries (which is the
434 default).
435
436
437 @c ==================================================================
438 @node       lzo
439 @subsection lzo
440
441 @cindex lzo
442 Another form of compression is offered using the LZO library.
443
444 If this library is not installed, you wil get an error when running the
445 configure script.  You can either install the LZO library, or disable support
446 for LZO compression by using the "--disable-lzo" option when running the
447 configure script. Note that if you disable support for LZO, the resulting
448 binary will not work correctly on VPNs where LZO compression is used.
449
450 You can use your operating system's package manager to install this if
451 available.  Make sure you install the development AND runtime versions
452 of this package.
453
454 If you have to install lzo manually, you can get the source code
455 from @url{http://www.oberhumer.com/opensource/lzo/}.  Instructions on how to configure,
456 build and install this package are included within the package.  Please
457 make sure you build development and runtime libraries (which is the
458 default).
459
460
461 @c ==================================================================
462 @node       libevent
463 @subsection libevent
464
465 @cindex libevent
466 For the main event loop, tinc uses the libevent library.
467
468 If this library is not installed, you wil get an error when configuring
469 tinc for build.
470
471 You can use your operating system's package manager to install this if
472 available.  Make sure you install the development AND runtime versions
473 of this package.
474
475 If you have to install libevent manually, you can get the source code
476 from @url{http://libevent.org/}. Instructions on how to configure,
477 build and install this package are included within the package.  Please
478 make sure you build development and runtime libraries (which is the
479 default).
480
481
482 @c ==================================================================
483 @node       libcurses
484 @subsection libcurses
485
486 @cindex libcurses
487 For the "tincctl top" command, tinc requires a curses library.
488
489 If this library is not installed, you wil get an error when running the
490 configure script.  You can either install a suitable curses library, or disable
491 all functionality that depends on a curses library by using the
492 "--disable-curses" option when running the configure script.
493
494 There are several curses libraries. It is recommended that you install
495 "ncurses" (@url{http://invisible-island.net/ncurses/}),
496 however other curses libraries should also work.
497 In particular, "PDCurses" (@url{http://pdcurses.sourceforge.net/})
498 is recommended if you want to compile tinc for Windows.
499
500 You can use your operating system's package manager to install this if
501 available. Make sure you install the development AND runtime versions
502 of this package.
503
504
505 @c ==================================================================
506 @node       libreadline
507 @subsection libreadline
508
509 @cindex libevent
510 For the "tincctl" command's shell functionality, tinc uses the readline library.
511
512 If this library is not installed, you wil get an error when running the
513 configure script.  You can either install a suitable readline library, or
514 disable all functionality that depends on a readline library by using the
515 "--disable-readline" option when running the configure script.
516
517 You can use your operating system's package manager to install this if
518 available.  Make sure you install the development AND runtime versions
519 of this package.
520
521 If you have to install libreadline manually, you can get the source code from
522 @url{http://www.gnu.org/software/readline/}. Instructions on how to configure,
523 build and install this package are included within the package.  Please make
524 sure you build development and runtime libraries (which is the default).
525
526
527 @c
528 @c
529 @c
530 @c      Installing tinc
531 @c
532 @c
533 @c
534 @c
535
536 @c ==================================================================
537 @node    Installation
538 @chapter Installation
539
540 If you use Debian, you may want to install one of the
541 precompiled packages for your system.  These packages are equipped with
542 system startup scripts and sample configurations.
543
544 If you cannot use one of the precompiled packages, or you want to compile tinc
545 for yourself, you can use the source.  The source is distributed under
546 the GNU General Public License (GPL).  Download the source from the
547 @uref{http://www.tinc-vpn.org/download/, download page}, which has
548 the checksums of these files listed; you may wish to check these with
549 md5sum before continuing.
550
551 Tinc comes in a convenient autoconf/automake package, which you can just
552 treat the same as any other package.  Which is just untar it, type
553 `./configure' and then `make'.
554 More detailed instructions are in the file @file{INSTALL}, which is
555 included in the source distribution.
556
557 @menu
558 * Building and installing tinc::
559 * System files::
560 @end menu
561
562
563 @c ==================================================================
564 @node    Building and installing tinc
565 @section Building and installing tinc
566
567 Detailed instructions on configuring the source, building tinc and installing tinc
568 can be found in the file called @file{INSTALL}.
569
570 @cindex binary package
571 If you happen to have a binary package for tinc for your distribution,
572 you can use the package management tools of that distribution to install tinc.
573 The documentation that comes along with your distribution will tell you how to do that.
574
575 @menu
576 * Darwin (MacOS/X) build environment::
577 * Cygwin (Windows) build environment::
578 * MinGW (Windows) build environment::
579 @end menu
580
581
582 @c ==================================================================
583 @node       Darwin (MacOS/X) build environment
584 @subsection Darwin (MacOS/X) build environment
585
586 In order to build tinc on Darwin, you need to install the MacOS/X Developer Tools
587 from @uref{http://developer.apple.com/tools/macosxtools.html} and
588 a recent version of Fink from @uref{http://www.finkproject.org/}.
589
590 After installation use fink to download and install the following packages:
591 autoconf25, automake, dlcompat, m4, openssl, zlib and lzo.
592
593 @c ==================================================================
594 @node       Cygwin (Windows) build environment
595 @subsection Cygwin (Windows) build environment
596
597 If Cygwin hasn't already been installed, install it directly from
598 @uref{http://www.cygwin.com/}.
599
600 When tinc is compiled in a Cygwin environment, it can only be run in this environment,
601 but all programs, including those started outside the Cygwin environment, will be able to use the VPN.
602 It will also support all features.
603
604 @c ==================================================================
605 @node       MinGW (Windows) build environment
606 @subsection MinGW (Windows) build environment
607
608 You will need to install the MinGW environment from @uref{http://www.mingw.org}.
609
610 When tinc is compiled using MinGW it runs natively under Windows,
611 it is not necessary to keep MinGW installed.
612
613 When detaching, tinc will install itself as a service,
614 which will be restarted automatically after reboots.
615
616
617 @c ==================================================================
618 @node    System files
619 @section System files
620
621 Before you can run tinc, you must make sure you have all the needed
622 files on your system.
623
624 @menu
625 * Device files::
626 * Other files::
627 @end menu
628
629
630 @c ==================================================================
631 @node       Device files
632 @subsection Device files
633
634 @cindex device files
635 Most operating systems nowadays come with the necessary device files by default,
636 or they have a mechanism to create them on demand.
637
638 If you use Linux and do not have udev installed,
639 you may need to create the following device file if it does not exist:
640
641 @example
642 mknod -m 600 /dev/net/tun c 10 200
643 @end example
644
645
646 @c ==================================================================
647 @node       Other files
648 @subsection Other files
649
650 @subsubheading @file{/etc/networks}
651
652 You may add a line to @file{/etc/networks} so that your VPN will get a
653 symbolic name.  For example:
654
655 @example
656 myvpn 10.0.0.0
657 @end example
658
659 @subsubheading @file{/etc/services}
660
661 @cindex port numbers
662 You may add this line to @file{/etc/services}.  The effect is that you
663 may supply a @samp{tinc} as a valid port number to some programs.  The
664 number 655 is registered with the IANA.
665
666 @example
667 tinc            655/tcp    TINC
668 tinc            655/udp    TINC
669 #                          Ivo Timmermans <ivo@@tinc-vpn.org>
670 @end example
671
672
673 @c
674 @c
675 @c
676 @c
677 @c         Configuring tinc
678 @c
679 @c
680 @c
681 @c
682
683
684 @c ==================================================================
685 @node    Configuration
686 @chapter Configuration
687
688 @menu
689 * Configuration introduction::
690 * Multiple networks::
691 * How connections work::
692 * Configuration files::
693 * Network interfaces::
694 * Example configuration::
695 @end menu
696
697 @c ==================================================================
698 @node    Configuration introduction
699 @section Configuration introduction
700
701 Before actually starting to configure tinc and editing files,
702 make sure you have read this entire section so you know what to expect.
703 Then, make it clear to yourself how you want to organize your VPN:
704 What are the nodes (computers running tinc)?
705 What IP addresses/subnets do they have?
706 What is the network mask of the entire VPN?
707 Do you need special firewall rules?
708 Do you have to set up masquerading or forwarding rules?
709 Do you want to run tinc in router mode or switch mode?
710 These questions can only be answered by yourself,
711 you will not find the answers in this documentation.
712 Make sure you have an adequate understanding of networks in general.
713 @cindex Network Administrators Guide
714 A good resource on networking is the
715 @uref{http://www.tldp.org/LDP/nag2/, Linux Network Administrators Guide}.
716
717 If you have everything clearly pictured in your mind,
718 proceed in the following order:
719 First, create the initial configuration files and public/private keypairs using the following command:
720 @example
721 tincctl -n @var{NETNAME} init @var{NAME}
722 @end example
723 Second, use @samp{tincctl -n @var{NETNAME} config ...} to further configure tinc.
724 Finally, export your host configuration file using @samp{tincctl -n @var{NETNAME} export} and send it to those
725 people or computers you want tinc to connect to.
726 They should send you their host configuration file back, which you can import using @samp{tincctl -n @var{NETNAME} import}.
727
728 These steps are described in the subsections below.
729
730
731 @c ==================================================================
732 @node    Multiple networks
733 @section Multiple networks
734
735 @cindex multiple networks
736 @cindex netname
737
738 In order to allow you to run more than one tinc daemon on one computer,
739 for instance if your computer is part of more than one VPN,
740 you can assign a @var{netname} to your VPN.
741 It is not required if you only run one tinc daemon,
742 it doesn't even have to be the same on all the nodes of your VPN,
743 but it is recommended that you choose one anyway.
744
745 We will asume you use a netname throughout this document.
746 This means that you call tincctl with the -n argument,
747 which will specify the netname.
748
749 The effect of this option is that tinc will set its configuration
750 root to @file{@value{sysconfdir}/tinc/@var{netname}/}, where @var{netname} is your argument to the -n option.
751 You will also notice that log messages it appears in syslog as coming from @file{tinc.@var{netname}},
752 and on Linux, unless specified otherwise, the name of the virtual network interface will be the same as the network name.
753
754 However, it is not strictly necessary that you call tinc with the -n
755 option. If you don not use it, the network name will just be empty, and
756 tinc will look for files in @file{@value{sysconfdir}/tinc/} instead of
757 @file{@value{sysconfdir}/tinc/@var{netname}/};
758 the configuration file will then be @file{@value{sysconfdir}/tinc/tinc.conf},
759 and the host configuration files are expected to be in @file{@value{sysconfdir}/tinc/hosts/}.
760
761
762 @c ==================================================================
763 @node    How connections work
764 @section How connections work
765
766 When tinc starts up, it parses the command-line options and then
767 reads in the configuration file tinc.conf.
768 If it sees one or more  `ConnectTo' values pointing to other tinc daemons in that file,
769 it will try to connect to those other daemons.
770 Whether this succeeds or not and whether `ConnectTo' is specified or not,
771 tinc will listen for incoming connection from other deamons.
772 If you did specify a `ConnectTo' value and the other side is not responding,
773 tinc will keep retrying.
774 This means that once started, tinc will stay running until you tell it to stop,
775 and failures to connect to other tinc daemons will not stop your tinc daemon
776 for trying again later.
777 This means you don't have to intervene if there are temporary network problems.
778
779 @cindex client
780 @cindex server
781 There is no real distinction between a server and a client in tinc.
782 If you wish, you can view a tinc daemon without a `ConnectTo' value as a server,
783 and one which does specify such a value as a client.
784 It does not matter if two tinc daemons have a `ConnectTo' value pointing to each other however.
785
786 Connections specified using `ConnectTo' are so-called meta-connections.
787 Tinc daemons exchange information about all other daemon they know about via these meta-connections.
788 After learning about all the daemons in the VPN,
789 tinc will create other connections as necessary in order to communicate with them.
790 For example, if there are three daemons named A, B and C, and A has @samp{ConnectTo = B} in its tinc.conf file,
791 and C has @samp{ConnectTo = B} in its tinc.conf file, then A will learn about C from B,
792 and will be able to exchange VPN packets with C without the need to have @samp{ConnectTo = C} in its tinc.conf file.
793
794 It could be that some daemons are located behind a Network Address Translation (NAT) device, or behind a firewall.
795 In the above scenario with three daemons, if A and C are behind a NAT,
796 B will automatically help A and C punch holes through their NAT,
797 in a way similar to the STUN protocol, so that A and C can still communicate with each other directly.
798 It is not always possible to do this however, and firewalls might also prevent direct communication.
799 In that case, VPN packets between A and C will be forwarded by B.
800
801 In effect, all nodes in the VPN will be able to talk to each other, as long as
802 their is a path of meta-connections between them, and whenever possible, two
803 nodes will communicate with each other directly.
804
805
806 @c ==================================================================
807 @node    Configuration files
808 @section Configuration files
809
810 The actual configuration of the daemon is done in the file
811 @file{@value{sysconfdir}/tinc/@var{netname}/tinc.conf} and at least one other file in the directory
812 @file{@value{sysconfdir}/tinc/@var{netname}/hosts/}.
813
814 These file consists of comments (lines started with a #) or assignments
815 in the form of
816
817 @example
818 Variable = Value.
819 @end example
820
821 The variable names are case insensitive, and any spaces, tabs, newlines
822 and carriage returns are ignored.  Note: it is not required that you put
823 in the `=' sign, but doing so improves readability.  If you leave it
824 out, remember to replace it with at least one space character.
825
826 The server configuration is complemented with host specific configuration (see
827 the next section). Although all host configuration options for the local node
828 listed in this document can also be put in
829 @file{@value{sysconfdir}/tinc/@var{netname}/tinc.conf}, it is recommended to
830 put host specific configuration options in the host configuration file, as this
831 makes it easy to exchange with other nodes.
832
833 You can edit the config file manually, but it is recommended that you use
834 tincctl to change configuration variables for you.
835
836 In the following two subsections all valid variables are listed in alphabetical order.
837 The default value is given between parentheses,
838 other comments are between square brackets.
839
840 @menu
841 * Main configuration variables::
842 * Host configuration variables::
843 * Scripts::
844 * How to configure::
845 @end menu
846
847
848 @c ==================================================================
849 @node       Main configuration variables
850 @subsection Main configuration variables
851
852 @table @asis
853 @cindex AddressFamily
854 @item AddressFamily = <ipv4|ipv6|any> (any)
855 This option affects the address family of listening and outgoing sockets.
856 If any is selected, then depending on the operating system
857 both IPv4 and IPv6 or just IPv6 listening sockets will be created.
858
859 @cindex AutoConnect
860 @item AutoConnect = <count> (0) [experimental]
861 If set to a non-zero value,
862 tinc will try to only have count meta connections to other nodes,
863 by automatically making or breaking connections to known nodes.
864 Higher values increase redundancy but also increase meta data overhead.
865 When using this option, a good value is 3.
866
867 @cindex BindToAddress
868 @item BindToAddress = <@var{address}> [<@var{port}>]
869 If your computer has more than one IPv4 or IPv6 address, tinc
870 will by default listen on all of them for incoming connections.
871 Multiple BindToAddress variables may be specified,
872 in which case listening sockets for each specified address are made.
873
874 If no @var{port} is specified, the socket will be bound to the port specified by the Port option,
875 or to port 655 if neither is given.
876 To only bind to a specific port but not to a specific address, use "*" for the @var{address}.
877
878 @cindex BindToInterface
879 @item BindToInterface = <@var{interface}> [experimental]
880 If you have more than one network interface in your computer, tinc will
881 by default listen on all of them for incoming connections.  It is
882 possible to bind tinc to a single interface like eth0 or ppp0 with this
883 variable.
884
885 This option may not work on all platforms.
886 Also, on some platforms it will not actually bind to an interface,
887 but rather to the address that the interface has at the moment a socket is created.
888
889 @cindex Broadcast
890 @item Broadcast = <no | mst | direct> (mst) [experimental]
891 This option selects the way broadcast packets are sent to other daemons.
892 @emph{NOTE: all nodes in a VPN must use the same Broadcast mode, otherwise routing loops can form.}
893
894 @table @asis
895 @item no
896 Broadcast packets are never sent to other nodes.
897
898 @item mst
899 Broadcast packets are sent and forwarded via the VPN's Minimum Spanning Tree.
900 This ensures broadcast packets reach all nodes.
901
902 @item direct
903 Broadcast packets are sent directly to all nodes that can be reached directly.
904 Broadcast packets received from other nodes are never forwarded.
905 If the IndirectData option is also set, broadcast packets will only be sent to nodes which we have a meta connection to.
906 @end table
907
908 @cindex ConnectTo
909 @item ConnectTo = <@var{name}>
910 Specifies which other tinc daemon to connect to on startup.
911 Multiple ConnectTo variables may be specified,
912 in which case outgoing connections to each specified tinc daemon are made.
913 The names should be known to this tinc daemon
914 (i.e., there should be a host configuration file for the name on the ConnectTo line).
915
916 If you don't specify a host with ConnectTo,
917 tinc won't try to connect to other daemons at all,
918 and will instead just listen for incoming connections.
919
920 @cindex DecrementTTL
921 @item DecrementTTL = <yes | no> (no) [experimental]
922 When enabled, tinc will decrement the Time To Live field in IPv4 packets, or the Hop Limit field in IPv6 packets,
923 before forwarding a received packet to the virtual network device or to another node,
924 and will drop packets that have a TTL value of zero,
925 in which case it will send an ICMP Time Exceeded packet back.
926
927 Do not use this option if you use switch mode and want to use IPv6.
928
929 @cindex Device
930 @item Device = <@var{device}> (@file{/dev/tap0}, @file{/dev/net/tun} or other depending on platform)
931 The virtual network device to use.
932 Tinc will automatically detect what kind of device it is.
933 Note that you can only use one device per daemon.
934 Under Windows, use @var{Interface} instead of @var{Device}.
935 Note that you can only use one device per daemon.
936 See also @ref{Device files}.
937
938 @cindex DeviceType
939 @item DeviceType = <@var{type}> (platform dependent)
940 The type of the virtual network device.
941 Tinc will normally automatically select the right type of tun/tap interface, and this option should not be used.
942 However, this option can be used to select one of the special interface types, if support for them is compiled in.
943
944 @table @asis
945 @cindex dummy
946 @item dummy
947 Use a dummy interface.
948 No packets are ever read or written to a virtual network device.
949 Useful for testing, or when setting up a node that only forwards packets for other nodes.
950
951 @cindex raw_socket
952 @item raw_socket
953 Open a raw socket, and bind it to a pre-existing
954 @var{Interface} (eth0 by default).
955 All packets are read from this interface.
956 Packets received for the local node are written to the raw socket.
957 However, at least on Linux, the operating system does not process IP packets destined for the local host.
958
959 @cindex multicast
960 @item multicast
961 Open a multicast UDP socket and bind it to the address and port (separated by spaces) and optionally a TTL value specified using @var{Device}.
962 Packets are read from and written to this multicast socket.
963 This can be used to connect to UML, QEMU or KVM instances listening on the same multicast address.
964 Do NOT connect multiple tinc daemons to the same multicast address, this will very likely cause routing loops.
965 Also note that this can cause decrypted VPN packets to be sent out on a real network if misconfigured.
966
967 @cindex UML
968 @item uml (not compiled in by default)
969 Create a UNIX socket with the filename specified by
970 @var{Device}, or @file{@value{localstatedir}/run/@var{netname}.umlsocket}
971 if not specified.
972 Tinc will wait for a User Mode Linux instance to connect to this socket.
973
974 @cindex VDE
975 @item vde (not compiled in by default)
976 Uses the libvdeplug library to connect to a Virtual Distributed Ethernet switch,
977 using the UNIX socket specified by
978 @var{Device}, or @file{@value{localstatedir}/run/vde.ctl}
979 if not specified.
980 @end table
981
982 Also, in case tinc does not seem to correctly interpret packets received from the virtual network device,
983 it can be used to change the way packets are interpreted:
984
985 @table @asis
986 @item tun (BSD and Linux)
987 Set type to tun.
988 Depending on the platform, this can either be with or without an address family header (see below).
989
990 @cindex tunnohead
991 @item tunnohead (BSD)
992 Set type to tun without an address family header.
993 Tinc will expect packets read from the virtual network device to start with an IP header.
994 On some platforms IPv6 packets cannot be read from or written to the device in this mode.
995
996 @cindex tunifhead
997 @item tunifhead (BSD)
998 Set type to tun with an address family header.
999 Tinc will expect packets read from the virtual network device
1000 to start with a four byte header containing the address family,
1001 followed by an IP header.
1002 This mode should support both IPv4 and IPv6 packets.
1003
1004 @item tap (BSD and Linux)
1005 Set type to tap.
1006 Tinc will expect packets read from the virtual network device
1007 to start with an Ethernet header.
1008 @end table
1009
1010 @cindex DirectOnly
1011 @item DirectOnly = <yes|no> (no) [experimental]
1012 When this option is enabled, packets that cannot be sent directly to the destination node,
1013 but which would have to be forwarded by an intermediate node, are dropped instead.
1014 When combined with the IndirectData option,
1015 packets for nodes for which we do not have a meta connection with are also dropped.
1016
1017 @cindex ECDSAPrivateKeyFile
1018 @item ECDSAPrivateKeyFile = <@var{path}> (@file{@value{sysconfdir}/tinc/@var{netname}/ecdsa_key.priv})
1019 The file in which the private ECDSA key of this tinc daemon resides.
1020 This is only used if ExperimentalProtocol is enabled.
1021
1022 @cindex ExperimentalProtocol
1023 @item ExperimentalProtocol = <yes|no> (no) [experimental]
1024 When this option is enabled, experimental protocol enhancements will be used.
1025 Ephemeral ECDH will be used for key exchanges,
1026 and ECDSA will be used instead of RSA for authentication.
1027 When enabled, an ECDSA key must have been generated before with
1028 @samp{tincctl generate-ecdsa-keys}.
1029 The experimental protocol may change at any time,
1030 and there is no guarantee that tinc will run stable when it is used.
1031
1032 @cindex Forwarding
1033 @item Forwarding = <off|internal|kernel> (internal) [experimental]
1034 This option selects the way indirect packets are forwarded.
1035
1036 @table @asis
1037 @item off
1038 Incoming packets that are not meant for the local node,
1039 but which should be forwarded to another node, are dropped.
1040
1041 @item internal
1042 Incoming packets that are meant for another node are forwarded by tinc internally.
1043
1044 This is the default mode, and unless you really know you need another forwarding mode, don't change it.
1045
1046 @item kernel
1047 Incoming packets are always sent to the TUN/TAP device, even if the packets are not for the local node.
1048 This is less efficient, but allows the kernel to apply its routing and firewall rules on them,
1049 and can also help debugging.
1050 @end table
1051
1052 @cindex GraphDumpFile
1053 @item GraphDumpFile = <@var{filename}>
1054 If this option is present,
1055 tinc will dump the current network graph to the file @var{filename}
1056 every minute, unless there were no changes to the graph.
1057 The file is in a format that can be read by graphviz tools.
1058 If @var{filename} starts with a pipe symbol |,
1059 then the rest of the filename is interpreted as a shell command
1060 that is executed, the graph is then sent to stdin.
1061
1062 @cindex Hostnames
1063 @item Hostnames = <yes|no> (no)
1064 This option selects whether IP addresses (both real and on the VPN)
1065 should be resolved.  Since DNS lookups are blocking, it might affect
1066 tinc's efficiency, even stopping the daemon for a few seconds everytime
1067 it does a lookup if your DNS server is not responding.
1068
1069 This does not affect resolving hostnames to IP addresses from the
1070 configuration file, but whether hostnames should be resolved while logging.
1071
1072 @cindex Interface
1073 @item Interface = <@var{interface}>
1074 Defines the name of the interface corresponding to the virtual network device.
1075 Depending on the operating system and the type of device this may or may not actually set the name of the interface.
1076 Under Windows, this variable is used to select which network interface will be used.
1077 If you specified a Device, this variable is almost always already correctly set.
1078
1079 @cindex LocalDiscovery
1080 @item LocalDiscovery = <yes | no> (no)
1081 When enabled, tinc will try to detect peers that are on the same local network.
1082 This will allow direct communication using LAN addresses, even if both peers are behind a NAT
1083 and they only ConnectTo a third node outside the NAT,
1084 which normally would prevent the peers from learning each other's LAN address.
1085
1086 Currently, local discovery is implemented by sending broadcast packets to the LAN during path MTU discovery.
1087 This feature may not work in all possible situations.
1088
1089 @cindex Mode
1090 @item Mode = <router|switch|hub> (router)
1091 This option selects the way packets are routed to other daemons.
1092
1093 @table @asis
1094 @cindex router
1095 @item router
1096 In this mode Subnet
1097 variables in the host configuration files will be used to form a routing table.
1098 Only unicast packets of routable protocols (IPv4 and IPv6) are supported in this mode.
1099
1100 This is the default mode, and unless you really know you need another mode, don't change it.
1101
1102 @cindex switch
1103 @item switch
1104 In this mode the MAC addresses of the packets on the VPN will be used to
1105 dynamically create a routing table just like an Ethernet switch does.
1106 Unicast, multicast and broadcast packets of every protocol that runs over Ethernet are supported in this mode
1107 at the cost of frequent broadcast ARP requests and routing table updates.
1108
1109 This mode is primarily useful if you want to bridge Ethernet segments.
1110
1111 @cindex hub
1112 @item hub
1113 This mode is almost the same as the switch mode, but instead
1114 every packet will be broadcast to the other daemons
1115 while no routing table is managed.
1116 @end table
1117
1118 @cindex KeyExpire
1119 @item KeyExpire = <@var{seconds}> (3600)
1120 This option controls the time the encryption keys used to encrypt the data
1121 are valid.  It is common practice to change keys at regular intervals to
1122 make it even harder for crackers, even though it is thought to be nearly
1123 impossible to crack a single key.
1124
1125 @cindex MACExpire
1126 @item MACExpire = <@var{seconds}> (600)
1127 This option controls the amount of time MAC addresses are kept before they are removed.
1128 This only has effect when Mode is set to "switch".
1129
1130 @cindex Name
1131 @item Name = <@var{name}> [required]
1132 This is a symbolic name for this connection.
1133 The name should consist only of alfanumeric and underscore characters (a-z, A-Z, 0-9 and _).
1134
1135 If Name starts with a $, then the contents of the environment variable that follows will be used.
1136 In that case, invalid characters will be converted to underscores.
1137 If Name is $HOST, but no such environment variable exist,
1138 the hostname will be read using the gethostnname() system call.
1139
1140 @cindex PingInterval
1141 @item PingInterval = <@var{seconds}> (60)
1142 The number of seconds of inactivity that tinc will wait before sending a
1143 probe to the other end.
1144
1145 @cindex PingTimeout
1146 @item PingTimeout = <@var{seconds}> (5)
1147 The number of seconds to wait for a response to pings or to allow meta
1148 connections to block. If the other end doesn't respond within this time,
1149 the connection is terminated, and the others will be notified of this.
1150
1151 @cindex PriorityInheritance
1152 @item PriorityInheritance = <yes|no> (no) [experimental]
1153 When this option is enabled the value of the TOS field of tunneled IPv4 packets
1154 will be inherited by the UDP packets that are sent out.
1155
1156 @cindex PrivateKey
1157 @item PrivateKey = <@var{key}> [obsolete]
1158 This is the RSA private key for tinc. However, for safety reasons it is
1159 advised to store private keys of any kind in separate files. This prevents
1160 accidental eavesdropping if you are editting the configuration file.
1161
1162 @cindex PrivateKeyFile
1163 @item PrivateKeyFile = <@var{path}> (@file{@value{sysconfdir}/tinc/@var{netname}/rsa_key.priv})
1164 This is the full path name of the RSA private key file that was
1165 generated by @samp{tincctl generate-keys}.  It must be a full path, not a
1166 relative directory.
1167
1168 Note that there must be exactly one of PrivateKey
1169 or PrivateKeyFile
1170 specified in the configuration file.
1171
1172 @cindex ProcessPriority
1173 @item ProcessPriority = <low|normal|high>
1174 When this option is used the priority of the tincd process will be adjusted.
1175 Increasing the priority may help to reduce latency and packet loss on the VPN.
1176
1177 @cindex Proxy
1178 @item Proxy = socks4 | socks4 | http | exec @var{...} [experimental]
1179 Use a proxy when making outgoing connections.
1180 The following proxy types are currently supported:
1181
1182 @table @asis
1183 @cindex socks4
1184 @item socks4 <@var{address}> <@var{port}> [<@var{username}>]
1185 Connects to the proxy using the SOCKS version 4 protocol.
1186 Optionally, a @var{username} can be supplied which will be passed on to the proxy server.
1187
1188 @cindex socks5
1189 @item socks4 <@var{address}> <@var{port}> [<@var{username}> <@var{password}>]
1190 Connect to the proxy using the SOCKS version 5 protocol.
1191 If a @var{username} and @var{password} are given, basic username/password authentication will be used,
1192 otherwise no authentication will be used.
1193
1194 @cindex http
1195 @item http <@var{address}> <@var{port}>
1196 Connects to the proxy and sends a HTTP CONNECT request.
1197
1198 @cindex exec
1199 @item exec <@var{command}>
1200 Executes the given command which should set up the outgoing connection.
1201 The environment variables @env{NAME}, @env{NODE}, @env{REMOTEADDRES} and @env{REMOTEPORT} are available.
1202 @end table
1203
1204 @cindex ReplayWindow
1205 @item ReplayWindow = <bytes> (16)
1206 This is the size of the replay tracking window for each remote node, in bytes.
1207 The window is a bitfield which tracks 1 packet per bit, so for example
1208 the default setting of 16 will track up to 128 packets in the window. In high
1209 bandwidth scenarios, setting this to a higher value can reduce packet loss from
1210 the interaction of replay tracking with underlying real packet loss and/or
1211 reordering. Setting this to zero will disable replay tracking completely and
1212 pass all traffic, but leaves tinc vulnerable to replay-based attacks on your
1213 traffic.
1214
1215
1216 @cindex StrictSubnets
1217 @item StrictSubnets <yes|no> (no) [experimental]
1218 When this option is enabled tinc will only use Subnet statements which are
1219 present in the host config files in the local
1220 @file{@value{sysconfdir}/tinc/@var{netname}/hosts/} directory.
1221
1222 @cindex TunnelServer
1223 @item TunnelServer = <yes|no> (no) [experimental]
1224 When this option is enabled tinc will no longer forward information between other tinc daemons,
1225 and will only allow connections with nodes for which host config files are present in the local
1226 @file{@value{sysconfdir}/tinc/@var{netname}/hosts/} directory.
1227 Setting this options also implicitly sets StrictSubnets.
1228
1229 @cindex UDPRcvBuf
1230 @item UDPRcvBuf = <bytes> (OS default)
1231 Sets the socket receive buffer size for the UDP socket, in bytes.
1232 If unset, the default buffer size will be used by the operating system.
1233
1234 @cindex UDPSndBuf
1235 @item UDPSndBuf = <bytes> Pq OS default
1236 Sets the socket send buffer size for the UDP socket, in bytes.
1237 If unset, the default buffer size will be used by the operating system.
1238
1239 @end table
1240
1241
1242 @c ==================================================================
1243 @node       Host configuration variables
1244 @subsection Host configuration variables
1245
1246 @table @asis
1247 @cindex Address
1248 @item Address = <@var{IP address}|@var{hostname}> [<port>] [recommended]
1249 This variable is only required if you want to connect to this host.  It
1250 must resolve to the external IP address where the host can be reached,
1251 not the one that is internal to the VPN.
1252 If no port is specified, the default Port is used.
1253
1254 @cindex Cipher
1255 @item Cipher = <@var{cipher}> (blowfish)
1256 The symmetric cipher algorithm used to encrypt UDP packets.
1257 Any cipher supported by OpenSSL is recognized.
1258 Furthermore, specifying "none" will turn off packet encryption.
1259 It is best to use only those ciphers which support CBC mode.
1260
1261 @cindex ClampMSS
1262 @item ClampMSS = <yes|no> (yes)
1263 This option specifies whether tinc should clamp the maximum segment size (MSS)
1264 of TCP packets to the path MTU. This helps in situations where ICMP
1265 Fragmentation Needed or Packet too Big messages are dropped by firewalls.
1266
1267 @cindex Compression
1268 @item Compression = <@var{level}> (0)
1269 This option sets the level of compression used for UDP packets.
1270 Possible values are 0 (off), 1 (fast zlib) and any integer up to 9 (best zlib),
1271 10 (fast lzo) and 11 (best lzo).
1272
1273 @cindex Digest
1274 @item Digest = <@var{digest}> (sha1)
1275 The digest algorithm used to authenticate UDP packets.
1276 Any digest supported by OpenSSL is recognized.
1277 Furthermore, specifying "none" will turn off packet authentication.
1278
1279 @cindex IndirectData
1280 @item IndirectData = <yes|no> (no)
1281 This option specifies whether other tinc daemons besides the one you
1282 specified with ConnectTo can make a direct connection to you.  This is
1283 especially useful if you are behind a firewall and it is impossible to
1284 make a connection from the outside to your tinc daemon.  Otherwise, it
1285 is best to leave this option out or set it to no.
1286
1287 @cindex MACLength
1288 @item MACLength = <@var{bytes}> (4)
1289 The length of the message authentication code used to authenticate UDP packets.
1290 Can be anything from 0
1291 up to the length of the digest produced by the digest algorithm.
1292
1293 @cindex PMTU
1294 @item PMTU = <@var{mtu}> (1514)
1295 This option controls the initial path MTU to this node.
1296
1297 @cindex PMTUDiscovery
1298 @item PMTUDiscovery = <yes|no> (yes)
1299 When this option is enabled, tinc will try to discover the path MTU to this node.
1300 After the path MTU has been discovered, it will be enforced on the VPN.
1301
1302 @cindex Port
1303 @item Port = <@var{port}> (655)
1304 This is the port this tinc daemon listens on.
1305 You can use decimal portnumbers or symbolic names (as listed in @file{/etc/services}).
1306
1307 @cindex PublicKey
1308 @item PublicKey = <@var{key}> [obsolete]
1309 This is the RSA public key for this host.
1310
1311 @cindex PublicKeyFile
1312 @item PublicKeyFile = <@var{path}> [obsolete]
1313 This is the full path name of the RSA public key file that was generated
1314 by @samp{tincctl generate-keys}.  It must be a full path, not a relative
1315 directory.
1316
1317 @cindex PEM format
1318 From version 1.0pre4 on tinc will store the public key directly into the
1319 host configuration file in PEM format, the above two options then are not
1320 necessary. Either the PEM format is used, or exactly
1321 @strong{one of the above two options} must be specified
1322 in each host configuration file, if you want to be able to establish a
1323 connection with that host.
1324
1325 @cindex Subnet
1326 @item Subnet = <@var{address}[/@var{prefixlength}[#@var{weight}]]>
1327 The subnet which this tinc daemon will serve.
1328 Tinc tries to look up which other daemon it should send a packet to by searching the appropiate subnet.
1329 If the packet matches a subnet,
1330 it will be sent to the daemon who has this subnet in his host configuration file.
1331 Multiple subnet lines can be specified for each daemon.
1332
1333 Subnets can either be single MAC, IPv4 or IPv6 addresses,
1334 in which case a subnet consisting of only that single address is assumed,
1335 or they can be a IPv4 or IPv6 network address with a prefixlength.
1336 For example, IPv4 subnets must be in a form like 192.168.1.0/24,
1337 where 192.168.1.0 is the network address and 24 is the number of bits set in the netmask.
1338 Note that subnets like 192.168.1.1/24 are invalid!
1339 Read a networking HOWTO/FAQ/guide if you don't understand this.
1340 IPv6 subnets are notated like fec0:0:0:1::/64.
1341 MAC addresses are notated like 0:1a:2b:3c:4d:5e.
1342
1343 @cindex CIDR notation
1344 Prefixlength is the number of bits set to 1 in the netmask part; for
1345 example: netmask 255.255.255.0 would become /24, 255.255.252.0 becomes
1346 /22. This conforms to standard CIDR notation as described in
1347 @uref{http://www.ietf.org/rfc/rfc1519.txt, RFC1519}
1348
1349 A Subnet can be given a weight to indicate its priority over identical Subnets
1350 owned by different nodes. The default weight is 10. Lower values indicate
1351 higher priority. Packets will be sent to the node with the highest priority,
1352 unless that node is not reachable, in which case the node with the next highest
1353 priority will be tried, and so on.
1354
1355 @cindex TCPonly
1356 @item TCPonly = <yes|no> (no)
1357 If this variable is set to yes, then the packets are tunnelled over a
1358 TCP connection instead of a UDP connection.  This is especially useful
1359 for those who want to run a tinc daemon from behind a masquerading
1360 firewall, or if UDP packet routing is disabled somehow.
1361 Setting this options also implicitly sets IndirectData.
1362 @end table
1363
1364
1365 @c ==================================================================
1366 @node       Scripts
1367 @subsection Scripts
1368
1369 @cindex scripts
1370 Apart from reading the server and host configuration files,
1371 tinc can also run scripts at certain moments.
1372 Under Windows (not Cygwin), the scripts should have the extension .bat.
1373
1374 @table @file
1375 @cindex tinc-up
1376 @item @value{sysconfdir}/tinc/@var{netname}/tinc-up
1377 This is the most important script.
1378 If it is present it will be executed right after the tinc daemon has been
1379 started and has connected to the virtual network device.
1380 It should be used to set up the corresponding network interface,
1381 but can also be used to start other things.
1382 Under Windows you can use the Network Connections control panel instead of creating this script.
1383
1384 @cindex tinc-down
1385 @item @value{sysconfdir}/tinc/@var{netname}/tinc-down
1386 This script is started right before the tinc daemon quits.
1387
1388 @item @value{sysconfdir}/tinc/@var{netname}/hosts/@var{host}-up
1389 This script is started when the tinc daemon with name @var{host} becomes reachable.
1390
1391 @item @value{sysconfdir}/tinc/@var{netname}/hosts/@var{host}-down
1392 This script is started when the tinc daemon with name @var{host} becomes unreachable.
1393
1394 @item @value{sysconfdir}/tinc/@var{netname}/host-up
1395 This script is started when any host becomes reachable.
1396
1397 @item @value{sysconfdir}/tinc/@var{netname}/host-down
1398 This script is started when any host becomes unreachable.
1399
1400 @item @value{sysconfdir}/tinc/@var{netname}/subnet-up
1401 This script is started when a Subnet becomes reachable.
1402 The Subnet and the node it belongs to are passed in environment variables.
1403
1404 @item @value{sysconfdir}/tinc/@var{netname}/subnet-down
1405 This script is started when a Subnet becomes unreachable.
1406 @end table
1407
1408 @cindex environment variables
1409 The scripts are started without command line arguments,
1410 but can make use of certain environment variables.
1411 Under UNIX like operating systems the names of environment variables must be preceded by a $ in scripts.
1412 Under Windows, in @file{.bat} files, they have to be put between % signs.
1413
1414 @table @env
1415 @cindex NETNAME
1416 @item NETNAME
1417 If a netname was specified, this environment variable contains it.
1418
1419 @cindex NAME
1420 @item NAME
1421 Contains the name of this tinc daemon.
1422
1423 @cindex DEVICE
1424 @item DEVICE
1425 Contains the name of the virtual network device that tinc uses.
1426
1427 @cindex INTERFACE
1428 @item INTERFACE
1429 Contains the name of the virtual network interface that tinc uses.
1430 This should be used for commands like ifconfig.
1431
1432 @cindex NODE
1433 @item NODE
1434 When a host becomes (un)reachable, this is set to its name.
1435 If a subnet becomes (un)reachable, this is set to the owner of that subnet.
1436
1437 @cindex REMOTEADDRESS
1438 @item REMOTEADDRESS
1439 When a host becomes (un)reachable, this is set to its real address.
1440
1441 @cindex REMOTEPORT
1442 @item REMOTEPORT
1443 When a host becomes (un)reachable,
1444 this is set to the port number it uses for communication with other tinc daemons.
1445
1446 @cindex SUBNET
1447 @item SUBNET
1448 When a subnet becomes (un)reachable, this is set to the subnet.
1449
1450 @end table
1451
1452
1453 @c ==================================================================
1454 @node       How to configure
1455 @subsection How to configure
1456
1457 @subsubheading Step 1.  Creating initial configuration files.
1458
1459 The initial directory structure, configuration files and public/private keypairs are created using the following command:
1460
1461 @example
1462 tincctl -n @var{netname} init @var{name}
1463 @end example
1464
1465 (You will need to run this as root, or use "sudo".)
1466 This will create the configuration directory @file{@value{sysconfdir}/tinc/@var{netname}.},
1467 and inside it will create another directory named @file{hosts/}.
1468 In the configuration directory, it will create the file @file{tinc.conf} with the following contents:
1469
1470 @example
1471 Name = @var{name}
1472 @end example
1473
1474 It will also create private RSA and ECDSA keys, which will be stored in the files @file{rsa_key.priv} and @file{ecdsa_key.priv}.
1475 It will also create a host configuration file @file{hosts/@var{name}},
1476 which will contain the corresponding public RSA and ECDSA keys.
1477
1478 Finally, on UNIX operating systems, it will create an executable script @file{tinc-up},
1479 which will initially not do anything except warning that you should edit it.
1480
1481 @subsubheading Step 2.  Modifying the initial configuration.
1482
1483 Unless you want to use tinc in switch mode,
1484 you should now configure which range of addresses you will use on the VPN.
1485 Let's assume you will be part of a VPN which uses the address range 192.168.0.0/16,
1486 and you yourself have a smaller portion of that range: 192.168.2.0/24.
1487 Then you should run the following command:
1488
1489 @example
1490 tincctl -n @var{netname} config add subnet 192.168.2.0/24
1491 @end example
1492
1493 This will add a Subnet statement to your host configuration file.
1494 Try opening the file @file{@value{sysconfdir}/tinc/@var{netname}/hosts/@var{name}} in an editor.
1495 You should now see a file containing the public RSA and ECDSA keys (which looks like a bunch of random characters),
1496 and the following line at the bottom:
1497
1498 @example
1499 Subnet = 192.168.2.0/24
1500 @end example
1501
1502 If you will use more than one address range, you can add more Subnets.
1503 For example, if you also use the IPv6 subnet fec0:0:0:2::/64, you can add it as well:
1504
1505 @example
1506 tincctl -n @var{netname} config add subnet fec0:0:0:2::/24
1507 @end example
1508
1509 This will add another line to the file @file{hosts/@var{name}}.
1510 If you make a mistake, you can undo it by simply using @samp{config del} instead of @samp{config add}.
1511
1512 If you want other tinc daemons to create meta-connections to your daemon,
1513 you should add your public IP address or hostname to your host configuration file.
1514 For example, if your hostname is foo.example.org, run:
1515
1516 @example
1517 tincctl -n @var{netname} config add address foo.example.org
1518 @end example
1519
1520 If you already know to which daemons your daemon should make meta-connections,
1521 you should configure that now as well.
1522 Suppose you want to connect to a daemon named "bar", run:
1523
1524 @example
1525 tincctl -n @var{netname} config add connectto bar
1526 @end example
1527
1528 Note that you specify the Name of the other daemon here, not an IP address or hostname!
1529 When you start tinc, and it tries to make a connection to "bar",
1530 it will look for a host configuration file named @file{hosts/bar},
1531 and will read Address statements and public keys from that file.
1532
1533 @subsubheading Step 2.  Exchanging configuration files.
1534
1535 If your daemon has a ConnectTo = bar statement in its @file{tinc.conf} file,
1536 or if bar has a ConnectTo your daemon, then you both need each other's host configuration files.
1537 You should send @file{hosts/@var{name}} to bar, and bar should send you his file which you should move to @file{hosts/bar}.
1538 If you are on a UNIX platform, you can easily send an email containing the necessary information using the following command
1539 (assuming the owner of bar has the email address bar@@example.org):
1540
1541 @example
1542 tincctl -n @var{netname} export | mail -s "My config file" bar@@example.org
1543 @end example
1544
1545 If the owner of bar does the same to send his host configuration file to you,
1546 you can probably pipe his email through the following command,
1547 or you can just start this command in a terminal and copy&paste the email:
1548
1549 @example
1550 tincctl -n @var{netname} import
1551 @end example
1552
1553 If you are the owner of bar yourself, and you have SSH access to that computer,
1554 you can also swap the host configuration files using the following commands:
1555
1556 @example
1557 tincctl -n @var{netname} export | ssh bar.example.org tincctl -n @var{netname} import
1558 ssh bar.example.org tincctl -n @var{netname} export | tincctl -n @var{netname} import
1559 @end example
1560
1561 You should repeat this for all nodes you ConnectTo, or which ConnectTo you.
1562 However, remember that you do not need to ConnectTo all nodes in the VPN;
1563 it is only necessary to create one or a few meta-connections,
1564 after the connections are made tinc will learn about all the other nodes in the VPN,
1565 and will automatically make other connections as necessary.
1566
1567
1568 @c ==================================================================
1569 @node    Network interfaces
1570 @section Network interfaces
1571
1572 Before tinc can start transmitting data over the tunnel, it must
1573 set up the virtual network interface.
1574
1575 First, decide which IP addresses you want to have associated with these
1576 devices, and what network mask they must have.
1577
1578 Tinc will open a virtual network device (@file{/dev/tun}, @file{/dev/tap0} or similar),
1579 which will also create a network interface called something like @samp{tun0}, @samp{tap0}.
1580 If you are using the Linux tun/tap driver, the network interface will by default have the same name as the @var{netname}.
1581 Under Windows you can change the name of the network interface from the Network Connections control panel.
1582
1583 @cindex tinc-up
1584 You can configure the network interface by putting ordinary ifconfig, route, and other commands
1585 to a script named @file{@value{sysconfdir}/tinc/@var{netname}/tinc-up}.
1586 When tinc starts, this script will be executed. When tinc exits, it will execute the script named
1587 @file{@value{sysconfdir}/tinc/@var{netname}/tinc-down}, but normally you don't need to create that script.
1588 You can manually open the script in an editor, or use the following command:
1589
1590 @example
1591 tincctl -n @var{netname} edit tinc-up
1592 @end example
1593
1594 An example @file{tinc-up} script, that would be appropriate for the scenario in the previous section, is:
1595
1596 @example
1597 #!/bin/sh
1598 ifconfig $INTERFACE 192.168.2.1 netmask 255.255.0.0
1599 ip addr add fec0:0:0:2::/48 dev $INTERFACE
1600 @end example
1601
1602 The first command gives the interface an IPv4 address and a netmask.
1603 The kernel will also automatically add an IPv4 route to this interface, so normally you don't need
1604 to add route commands to the @file{tinc-up} script.
1605 The kernel will also bring the interface up after this command.
1606 @cindex netmask
1607 The netmask is the mask of the @emph{entire} VPN network, not just your
1608 own subnet.
1609 The second command gives the interface an IPv6 address and netmask,
1610 which will also automatically add an IPv6 route.
1611 If you only want to use "ip addr" commands on Linux, don't forget that it doesn't bring the interface up, unlike ifconfig,
1612 so you need to add @samp{ip link set $INTERFACE up} in that case.
1613
1614 The exact syntax of the ifconfig and route commands differs from platform to platform.
1615 You can look up the commands for setting addresses and adding routes in @ref{Platform specific information},
1616 but it is best to consult the manpages of those utilities on your platform.
1617
1618
1619 @c ==================================================================
1620 @node    Example configuration
1621 @section Example configuration
1622
1623
1624 @cindex example
1625 Imagine the following situation.  Branch A of our example `company' wants to connect
1626 three branch offices in B, C and D using the Internet.  All four offices
1627 have a 24/7 connection to the Internet.
1628
1629 A is going to serve as the center of the network.  B and C will connect
1630 to A, and D will connect to C.  Each office will be assigned their own IP
1631 network, 10.x.0.0.
1632
1633 @example
1634 A: net 10.1.0.0 mask 255.255.0.0 gateway 10.1.54.1 internet IP 1.2.3.4
1635 B: net 10.2.0.0 mask 255.255.0.0 gateway 10.2.1.12 internet IP 2.3.4.5
1636 C: net 10.3.0.0 mask 255.255.0.0 gateway 10.3.69.254 internet IP 3.4.5.6
1637 D: net 10.4.0.0 mask 255.255.0.0 gateway 10.4.3.32 internet IP 4.5.6.7
1638 @end example
1639
1640 Here, ``gateway'' is the VPN IP address of the machine that is running the
1641 tincd, and ``internet IP'' is the IP address of the firewall, which does not
1642 need to run tincd, but it must do a port forwarding of TCP and UDP on port
1643 655 (unless otherwise configured).
1644
1645 In this example, it is assumed that eth0 is the interface that points to
1646 the inner (physical) LAN of the office, although this could also be the
1647 same as the interface that leads to the Internet.  The configuration of
1648 the real interface is also shown as a comment, to give you an idea of
1649 how these example host is set up. All branches use the netname `company'
1650 for this particular VPN.
1651
1652 Each branch is set up using the @samp{tincctl init} and @samp{tincctl config} commands,
1653 here we just show the end results:
1654
1655 @subsubheading For Branch A
1656
1657 @emph{BranchA} would be configured like this:
1658
1659 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1660
1661 @example
1662 #!/bin/sh
1663
1664 # Real interface of internal network:
1665 # ifconfig eth0 10.1.54.1 netmask 255.255.0.0
1666
1667 ifconfig $INTERFACE 10.1.54.1 netmask 255.0.0.0
1668 @end example
1669
1670 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1671
1672 @example
1673 Name = BranchA
1674 @end example
1675
1676 On all hosts, @file{@value{sysconfdir}/tinc/company/hosts/BranchA} contains:
1677
1678 @example
1679 Subnet = 10.1.0.0/16
1680 Address = 1.2.3.4
1681
1682 -----BEGIN RSA PUBLIC KEY-----
1683 ...
1684 -----END RSA PUBLIC KEY-----
1685 @end example
1686
1687 Note that the IP addresses of eth0 and the VPN interface are the same.
1688 This is quite possible, if you make sure that the netmasks of the interfaces are different.
1689 It is in fact recommended to give both real internal network interfaces and VPN interfaces the same IP address,
1690 since that will make things a lot easier to remember and set up.
1691
1692
1693 @subsubheading For Branch B
1694
1695 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1696
1697 @example
1698 #!/bin/sh
1699
1700 # Real interface of internal network:
1701 # ifconfig eth0 10.2.43.8 netmask 255.255.0.0
1702
1703 ifconfig $INTERFACE 10.2.1.12 netmask 255.0.0.0
1704 @end example
1705
1706 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1707
1708 @example
1709 Name = BranchB
1710 ConnectTo = BranchA
1711 @end example
1712
1713 Note here that the internal address (on eth0) doesn't have to be the
1714 same as on the VPN interface.  Also, ConnectTo is given so that this node will
1715 always try to connect to BranchA.
1716
1717 On all hosts, in @file{@value{sysconfdir}/tinc/company/hosts/BranchB}:
1718
1719 @example
1720 Subnet = 10.2.0.0/16
1721 Address = 2.3.4.5
1722
1723 -----BEGIN RSA PUBLIC KEY-----
1724 ...
1725 -----END RSA PUBLIC KEY-----
1726 @end example
1727
1728
1729 @subsubheading For Branch C
1730
1731 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1732
1733 @example
1734 #!/bin/sh
1735
1736 # Real interface of internal network:
1737 # ifconfig eth0 10.3.69.254 netmask 255.255.0.0
1738
1739 ifconfig $INTERFACE 10.3.69.254 netmask 255.0.0.0
1740 @end example
1741
1742 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1743
1744 @example
1745 Name = BranchC
1746 ConnectTo = BranchA
1747 @end example
1748
1749 C already has another daemon that runs on port 655, so they have to
1750 reserve another port for tinc. It knows the portnumber it has to listen on
1751 from it's own host configuration file.
1752
1753 On all hosts, in @file{@value{sysconfdir}/tinc/company/hosts/BranchC}:
1754
1755 @example
1756 Address = 3.4.5.6
1757 Subnet = 10.3.0.0/16
1758 Port = 2000
1759
1760 -----BEGIN RSA PUBLIC KEY-----
1761 ...
1762 -----END RSA PUBLIC KEY-----
1763 @end example
1764
1765
1766 @subsubheading For Branch D
1767
1768 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1769
1770 @example
1771 #!/bin/sh
1772
1773 # Real interface of internal network:
1774 # ifconfig eth0 10.4.3.32 netmask 255.255.0.0
1775
1776 ifconfig $INTERFACE 10.4.3.32 netmask 255.0.0.0
1777 @end example
1778
1779 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1780
1781 @example
1782 Name = BranchD
1783 ConnectTo = BranchC
1784 @end example
1785
1786 D will be connecting to C, which has a tincd running for this network on
1787 port 2000. It knows the port number from the host configuration file.
1788
1789 On all hosts, in @file{@value{sysconfdir}/tinc/company/hosts/BranchD}:
1790
1791 @example
1792 Subnet = 10.4.0.0/16
1793 Address = 4.5.6.7
1794
1795 -----BEGIN RSA PUBLIC KEY-----
1796 ...
1797 -----END RSA PUBLIC KEY-----
1798 @end example
1799
1800 @subsubheading Key files
1801
1802 A, B, C and D all have their own public/private keypairs:
1803
1804 The private RSA key is stored in @file{@value{sysconfdir}/tinc/company/rsa_key.priv},
1805 the private ECDSA key is stored in @file{@value{sysconfdir}/tinc/company/ecdsa_key.priv},
1806 and the public RSA and ECDSA keys are put into the host configuration file in the @file{@value{sysconfdir}/tinc/company/hosts/} directory.
1807
1808 @subsubheading Starting
1809
1810 After each branch has finished configuration and they have distributed
1811 the host configuration files amongst them, they can start their tinc daemons.
1812 They don't necessarily have to wait for the other branches to have started
1813 their daemons, tinc will try connecting until they are available.
1814
1815
1816 @c ==================================================================
1817 @node    Running tinc
1818 @chapter Running tinc
1819
1820 If everything else is done, you can start tinc by typing the following command:
1821
1822 @example
1823 tincctl -n @var{netname} start
1824 @end example
1825
1826 @cindex daemon
1827 Tinc will detach from the terminal and continue to run in the background like a good daemon.
1828 If there are any problems however you can try to increase the debug level
1829 and look in the syslog to find out what the problems are.
1830
1831 @menu
1832 * Runtime options::
1833 * Signals::
1834 * Debug levels::
1835 * Solving problems::
1836 * Error messages::
1837 * Sending bug reports::
1838 @end menu
1839
1840
1841 @c ==================================================================
1842 @node    Runtime options
1843 @section Runtime options
1844
1845 Besides the settings in the configuration file, tinc also accepts some
1846 command line options.
1847
1848 @cindex command line
1849 @cindex runtime options
1850 @cindex options
1851 @c from the manpage
1852 @table @option
1853 @item -c, --config=@var{path}
1854 Read configuration options from the directory @var{path}.  The default is
1855 @file{@value{sysconfdir}/tinc/@var{netname}/}.
1856
1857 @item -D, --no-detach
1858 Don't fork and detach.
1859 This will also disable the automatic restart mechanism for fatal errors.
1860
1861 @cindex debug level
1862 @item -d, --debug=@var{level}
1863 Set debug level to @var{level}.  The higher the debug level, the more gets
1864 logged.  Everything goes via syslog.
1865
1866 @item -n, --net=@var{netname}
1867 Use configuration for net @var{netname}.
1868 This will let tinc read all configuration files from
1869 @file{@value{sysconfdir}/tinc/@var{netname}/}.
1870 Specifying . for @var{netname} is the same as not specifying any @var{netname}.
1871 @xref{Multiple networks}.
1872
1873 @item --pidfile=@var{filename}
1874 Store a cookie in @var{filename} which allows tincctl to authenticate.
1875 If unspecified, the default is
1876 @file{@value{localstatedir}/run/tinc.@var{netname}.pid}.
1877
1878 @item -o, --option=[@var{HOST}.]@var{KEY}=@var{VALUE}
1879 Without specifying a @var{HOST}, this will set server configuration variable @var{KEY} to @var{VALUE}.
1880 If specified as @var{HOST}.@var{KEY}=@var{VALUE},
1881 this will set the host configuration variable @var{KEY} of the host named @var{HOST} to @var{VALUE}.
1882 This option can be used more than once to specify multiple configuration variables.
1883
1884 @item -L, --mlock
1885 Lock tinc into main memory.
1886 This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.
1887
1888 @item --logfile[=@var{file}]
1889 Write log entries to a file instead of to the system logging facility.
1890 If @var{file} is omitted, the default is @file{@value{localstatedir}/log/tinc.@var{netname}.log}.
1891
1892 @item --bypass-security
1893 Disables encryption and authentication.
1894 Only useful for debugging.
1895
1896 @item -R, --chroot
1897 Change process root directory to the directory where the config file is
1898 located (@file{@value{sysconfdir}/tinc/@var{netname}/} as determined by
1899 -n/--net option or as given by -c/--config option), for added security.
1900 The chroot is performed after all the initialization is done, after
1901 writing pid files and opening network sockets.
1902
1903 Note that this option alone does not do any good without -U/--user, below.
1904
1905 Note also that tinc can't run scripts anymore (such as tinc-down or host-up),
1906 unless it's setup to be runnable inside chroot environment.
1907
1908 @item -U, --user=@var{user}
1909 Switch to the given @var{user} after initialization, at the same time as
1910 chroot is performed (see --chroot above).  With this option tinc drops
1911 privileges, for added security.
1912
1913 @item --help
1914 Display a short reminder of these runtime options and terminate.
1915
1916 @item --version
1917 Output version information and exit.
1918
1919 @end table
1920
1921 @c ==================================================================
1922 @node    Signals
1923 @section Signals
1924
1925 @cindex signals
1926 You can also send the following signals to a running tincd process:
1927
1928 @c from the manpage
1929 @table @samp
1930
1931 @item ALRM
1932 Forces tinc to try to connect to all uplinks immediately.
1933 Usually tinc attempts to do this itself,
1934 but increases the time it waits between the attempts each time it failed,
1935 and if tinc didn't succeed to connect to an uplink the first time after it started,
1936 it defaults to the maximum time of 15 minutes.
1937
1938 @item HUP
1939 Partially rereads configuration files.
1940 Connections to hosts whose host config file are removed are closed.
1941 New outgoing connections specified in @file{tinc.conf} will be made.
1942 If the --logfile option is used, this will also close and reopen the log file,
1943 useful when log rotation is used.
1944
1945 @end table
1946
1947 @c ==================================================================
1948 @node    Debug levels
1949 @section Debug levels
1950
1951 @cindex debug levels
1952 The tinc daemon can send a lot of messages to the syslog.
1953 The higher the debug level, the more messages it will log.
1954 Each level inherits all messages of the previous level:
1955
1956 @c from the manpage
1957 @table @samp
1958
1959 @item 0
1960 This will log a message indicating tinc has started along with a version number.
1961 It will also log any serious error.
1962
1963 @item 1
1964 This will log all connections that are made with other tinc daemons.
1965
1966 @item 2
1967 This will log status and error messages from scripts and other tinc daemons.
1968
1969 @item 3
1970 This will log all requests that are exchanged with other tinc daemons. These include
1971 authentication, key exchange and connection list updates.
1972
1973 @item 4
1974 This will log a copy of everything received on the meta socket.
1975
1976 @item 5
1977 This will log all network traffic over the virtual private network.
1978
1979 @end table
1980
1981 @c ==================================================================
1982 @node    Solving problems
1983 @section Solving problems
1984
1985 If tinc starts without problems, but if the VPN doesn't work, you will have to find the cause of the problem.
1986 The first thing to do is to start tinc with a high debug level in the foreground,
1987 so you can directly see everything tinc logs:
1988
1989 @example
1990 tincd -n @var{netname} -d5 -D
1991 @end example
1992
1993 If tinc does not log any error messages, then you might want to check the following things:
1994
1995 @itemize
1996 @item @file{tinc-up} script
1997 Does this script contain the right commands?
1998 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.
1999
2000 @item Subnet
2001 Does the Subnet (or Subnets) in the host configuration file of this host match the portion of the VPN that belongs to this host?
2002
2003 @item Firewalls and NATs
2004 Do you have a firewall or a NAT device (a masquerading firewall or perhaps an ADSL router that performs masquerading)?
2005 If so, check that it allows TCP and UDP traffic on port 655.
2006 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.
2007 You can add @samp{TCPOnly = yes} to your host config file to force tinc to only use a single TCP connection,
2008 this works through most firewalls and NATs.
2009
2010 @end itemize
2011
2012
2013 @c ==================================================================
2014 @node    Error messages
2015 @section Error messages
2016
2017 What follows is a list of the most common error messages you might find in the logs.
2018 Some of them will only be visible if the debug level is high enough.
2019
2020 @table @samp
2021 @item Could not open /dev/tap0: No such device
2022
2023 @itemize
2024 @item You forgot to `modprobe netlink_dev' or `modprobe ethertap'.
2025 @item You forgot to compile `Netlink device emulation' in the kernel.
2026 @end itemize
2027
2028 @item Can't write to /dev/net/tun: No such device
2029
2030 @itemize
2031 @item You forgot to `modprobe tun'.
2032 @item You forgot to compile `Universal TUN/TAP driver' in the kernel.
2033 @item The tun device is located somewhere else in @file{/dev/}.
2034 @end itemize
2035
2036 @item Network address and prefix length do not match!
2037
2038 @itemize
2039 @item The Subnet field must contain a @emph{network} address, trailing bits should be 0.
2040 @item If you only want to use one IP address, set the netmask to /32.
2041 @end itemize
2042
2043 @item Error reading RSA key file `rsa_key.priv': No such file or directory
2044
2045 @itemize
2046 @item You forgot to create a public/private keypair.
2047 @item Specify the complete pathname to the private key file with the @samp{PrivateKeyFile} option.
2048 @end itemize
2049
2050 @item Warning: insecure file permissions for RSA private key file `rsa_key.priv'!
2051
2052 @itemize
2053 @item The private key file is readable by users other than root.
2054 Use chmod to correct the file permissions.
2055 @end itemize
2056
2057 @item Creating metasocket failed: Address family not supported
2058
2059 @itemize
2060 @item By default tinc tries to create both IPv4 and IPv6 sockets.
2061 On some platforms this might not be implemented.
2062 If the logs show @samp{Ready} later on, then at least one metasocket was created,
2063 and you can ignore this message.
2064 You can add @samp{AddressFamily = ipv4} to @file{tinc.conf} to prevent this from happening.
2065 @end itemize
2066
2067 @item Cannot route packet: unknown IPv4 destination 1.2.3.4
2068
2069 @itemize
2070 @item You try to send traffic to a host on the VPN for which no Subnet is known.
2071 @item If it is a broadcast address (ending in .255), it probably is a samba server or a Windows host sending broadcast packets.
2072 You can ignore it.
2073 @end itemize
2074
2075 @item Cannot route packet: ARP request for unknown address 1.2.3.4
2076
2077 @itemize
2078 @item You try to send traffic to a host on the VPN for which no Subnet is known.
2079 @end itemize
2080
2081 @item Packet with destination 1.2.3.4 is looping back to us!
2082
2083 @itemize
2084 @item Something is not configured right. Packets are being sent out to the
2085 virtual network device, but according to the Subnet directives in your host configuration
2086 file, those packets should go to your own host. Most common mistake is that
2087 you have a Subnet line in your host configuration file with a prefix length which is
2088 just as large as the prefix of the virtual network interface. The latter should in almost all
2089 cases be larger. Rethink your configuration.
2090 Note that you will only see this message if you specified a debug
2091 level of 5 or higher!
2092 @item Chances are that a @samp{Subnet = ...} line in the host configuration file of this tinc daemon is wrong.
2093 Change it to a subnet that is accepted locally by another interface,
2094 or if that is not the case, try changing the prefix length into /32. 
2095 @end itemize
2096
2097 @item Node foo (1.2.3.4) is not reachable
2098
2099 @itemize
2100 @item Node foo does not have a connection anymore, its tinc daemon is not running or its connection to the Internet is broken.
2101 @end itemize
2102
2103 @item Received UDP packet from unknown source 1.2.3.4 (port 12345)
2104
2105 @itemize
2106 @item If you see this only sporadically, it is harmless and caused by a node sending packets using an old key.
2107 @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.
2108 You can add @samp{TCPOnly = yes} to host configuration files to force all VPN traffic to go over a TCP connection.
2109 @end itemize
2110
2111 @item Got bad/bogus/unauthorized REQUEST from foo (1.2.3.4 port 12345)
2112
2113 @itemize
2114 @item Node foo does not have the right public/private keypair.
2115 Generate new keypairs and distribute them again.
2116 @item An attacker tries to gain access to your VPN.
2117 @item A network error caused corruption of metadata sent from foo.
2118 @end itemize
2119
2120 @end table
2121
2122 @c ==================================================================
2123 @node    Sending bug reports
2124 @section Sending bug reports
2125
2126 If you really can't find the cause of a problem, or if you suspect tinc is not working right,
2127 you can send us a bugreport, see @ref{Contact information}.
2128 Be sure to include the following information in your bugreport:
2129
2130 @itemize
2131 @item A clear description of what you are trying to achieve and what the problem is.
2132 @item What platform (operating system, version, hardware architecture) and which version of tinc you use.
2133 @item If compiling tinc fails, a copy of @file{config.log} and the error messages you get.
2134 @item Otherwise, a copy of @file{tinc.conf}, @file{tinc-up} and all files in the @file{hosts/} directory.
2135 @item The output of the commands @samp{ifconfig -a} and @samp{route -n} (or @samp{netstat -rn} if that doesn't work).
2136 @item The output of any command that fails to work as it should (like ping or traceroute).
2137 @end itemize
2138
2139 @c ==================================================================
2140 @node    Controlling tinc
2141 @chapter Controlling tinc
2142
2143 You can control and inspect a running tincd through the tincctl
2144 command. A quick example:
2145
2146 @example
2147 tincctl -n @var{netname} reload
2148 @end example
2149
2150 @menu
2151 * tincctl runtime options::
2152 * tincctl environment variables::
2153 * tincctl commands::
2154 * tincctl examples::
2155 * tincctl top::
2156 @end menu
2157
2158
2159 @c ==================================================================
2160 @node    tincctl runtime options
2161 @section tincctl runtime options
2162
2163 @c from the manpage
2164 @table @option
2165 @item -c, --config=@var{path}
2166 Read configuration options from the directory @var{path}.  The default is
2167 @file{@value{sysconfdir}/tinc/@var{netname}/}.
2168
2169 @item -n, --net=@var{netname}
2170 Use configuration for net @var{netname}. @xref{Multiple networks}.
2171
2172 @item --pidfile=@var{filename}
2173 Use the cookie from @var{filename} to authenticate with a running tinc daemon.
2174 If unspecified, the default is
2175 @file{@value{localstatedir}/run/tinc.@var{netname}.pid}.
2176
2177 @item --help
2178 Display a short reminder of runtime options and commands, then terminate.
2179
2180 @item --version
2181 Output version information and exit.
2182
2183 @end table
2184
2185 @c ==================================================================
2186 @node    tincctl environment variables
2187 @section tincctl environment variables
2188
2189 @table @env
2190 @cindex NETNAME
2191 @item NETNAME
2192 If no netname is specified on the command line with the @option{-n} option,
2193 the value of this environment variable is used.
2194 @end table
2195
2196 @c ==================================================================
2197 @node    tincctl commands
2198 @section tincctl commands
2199
2200 @c from the manpage
2201 @table @code
2202
2203 @item init [@var{name}]
2204 Create initial configuration files and RSA and ECDSA keypairs with default length.
2205 If no @var{name} for this node is given, it will be asked for.
2206
2207 @item config [get] @var{variable}
2208 Print the current value of configuration variable @var{variable}.
2209 If more than one variable with the same name exists,
2210 the value of each of them will be printed on a separate line.
2211
2212 @item config [set] @var{variable} @var{value}
2213 Set configuration variable @var{variable} to the given @var{value}.
2214 All previously existing configuration variables with the same name are removed.
2215 To set a variable for a specific host, use the notation @var{host}.@var{variable}.
2216
2217 @item config add @var{variable} @var{value}
2218 As above, but without removing any previously existing configuration variables.
2219
2220 @item config del @var{variable} [@var{value}]
2221 Remove configuration variables with the same name and @var{value}.
2222 If no @var{value} is given, all configuration variables with the same name will be removed.
2223
2224 @item edit @var{filename}
2225 Start an editor for the given configuration file.
2226 You do not need to specify the full path to the file.
2227
2228 @item export
2229 Export the host configuration file of the local node to standard output.
2230
2231 @item export-all
2232 Export all host configuration files to standard output.
2233
2234 @item import [--force]
2235 Import host configuration file(s) from standard input.
2236 Already existing host configuration files are not overwritten unless the option --force is used.
2237
2238 @item start [tincd options]
2239 Start @samp{tincd}, optionally with the given extra options.
2240
2241 @item stop
2242 Stop @samp{tincd}.
2243
2244 @item restart
2245 Restart @samp{tincd}.
2246
2247 @item reload
2248 Partially rereads configuration files. Connections to hosts whose host
2249 config files are removed are closed. New outgoing connections specified
2250 in @file{tinc.conf} will be made.
2251
2252 @item pid
2253 Shows the PID of the currently running @samp{tincd}.
2254
2255 @item generate-keys [@var{bits}]
2256 Generate public/private keypair of @var{bits} length. If @var{bits} is not specified,
2257 1024 is the default. tinc will ask where you want to store the files,
2258 but will default to the configuration directory (you can use the -c or -n
2259 option).
2260
2261 @item dump nodes
2262 Dump a list of all known nodes in the VPN.
2263
2264 @item dump edges
2265 Dump a list of all known connections in the VPN.
2266
2267 @item dump subnets
2268 Dump a list of all known subnets in the VPN.
2269
2270 @item dump connections
2271 Dump a list of all meta connections with ourself.
2272
2273 @item dump graph | digraph
2274 Dump a graph of the VPN in dotty format.
2275 Nodes are colored according to their reachability:
2276 red nodes are unreachable, orange nodes are indirectly reachable, green nodes are directly reachable.
2277 Black nodes are either directly or indirectly reachable, but direct reachability has not been tried yet.
2278
2279 @item info @var{node} | @var{subnet} | @var{address}
2280 Show information about a particular @var{node}, @var{subnet} or @var{address}.
2281 If an @var{address} is given, any matching subnet will be shown.
2282
2283 @item purge
2284 Purges all information remembered about unreachable nodes.
2285
2286 @item debug @var{level}
2287 Sets debug level to @var{level}.
2288
2289 @item log [@var{level}]
2290 Capture log messages from a running tinc daemon.
2291 An optional debug level can be given that will be applied only for log messages sent to tincctl.
2292
2293 @item retry
2294 Forces tinc to try to connect to all uplinks immediately.
2295 Usually tinc attempts to do this itself,
2296 but increases the time it waits between the attempts each time it failed,
2297 and if tinc didn't succeed to connect to an uplink the first time after it started,
2298 it defaults to the maximum time of 15 minutes.
2299
2300 @item disconnect @var{node}
2301 Closes the meta connection with the given @var{node}.
2302
2303 @item top
2304 If tincctl is compiled with libcurses support, this will display live traffic statistics for all the known nodes,
2305 similar to the UNIX top command.
2306 See below for more information.
2307
2308 @item pcap
2309 Dump VPN traffic going through the local tinc node in pcap-savefile format to standard output,
2310 from where it can be redirected to a file or piped through a program that can parse it directly,
2311 such as tcpdump.
2312
2313 @end table
2314
2315 @c ==================================================================
2316 @node    tincctl examples
2317 @section tincctl examples
2318
2319 Examples of some commands:
2320
2321 @example
2322 tincctl -n vpn dump graph | circo -Txlib
2323 tincctl -n vpn pcap | tcpdump -r -
2324 tincctl -n vpn top
2325 @end example
2326
2327 Example of configuring tinc using tincctl:
2328
2329 @example
2330 tincctl -n vpn init foo
2331 tincctl -n vpn config Subnet 192.168.1.0/24
2332 tincctl -n vpn config bar.Address bar.example.com
2333 tincctl -n vpn config ConnectTo bar
2334 tincctl -n vpn export | gpg --clearsign | mail -s "My config" vpnmaster@@example.com
2335 @end example
2336
2337 @c ==================================================================
2338 @node    tincctl top
2339 @section tincctl top
2340
2341 The top command connects to a running tinc daemon and repeatedly queries its per-node traffic counters.
2342 It displays a list of all the known nodes in the left-most column,
2343 and the amount of bytes and packets read from and sent to each node in the other columns.
2344 By default, the information is updated every second.
2345 The behaviour of the top command can be changed using the following keys:
2346
2347 @table @key
2348
2349 @item s
2350 Change the interval between updates.
2351 After pressing the @key{s} key, enter the desired interval in seconds, followed by enter.
2352 Fractional seconds are honored.
2353 Intervals lower than 0.1 seconds are not allowed.
2354
2355 @item c
2356 Toggle between displaying current traffic rates (in packets and bytes per second)
2357 and cummulative traffic (total packets and bytes since the tinc daemon started).
2358
2359 @item n
2360 Sort the list of nodes by name.
2361
2362 @item i
2363 Sort the list of nodes by incoming amount of bytes.
2364
2365 @item I
2366 Sort the list of nodes by incoming amount of packets.
2367
2368 @item o
2369 Sort the list of nodes by outgoing amount of bytes.
2370
2371 @item O
2372 Sort the list of nodes by outgoing amount of packets.
2373
2374 @item t
2375 Sort the list of nodes by sum of incoming and outgoing amount of bytes.
2376
2377 @item T
2378 Sort the list of nodes by sum of incoming and outgoing amount of packets.
2379
2380 @item b
2381 Show amount of traffic in bytes.
2382
2383 @item k
2384 Show amount of traffic in kilobytes.
2385
2386 @item M
2387 Show amount of traffic in megabytes.
2388
2389 @item G
2390 Show amount of traffic in gigabytes.
2391
2392 @item q
2393 Quit.
2394
2395 @end table
2396
2397
2398 @c ==================================================================
2399 @node    Technical information
2400 @chapter Technical information
2401
2402
2403 @menu
2404 * The connection::
2405 * The meta-protocol::
2406 * Security::
2407 @end menu
2408
2409
2410 @c ==================================================================
2411 @node    The connection
2412 @section The connection
2413
2414 @cindex connection
2415 Tinc is a daemon that takes VPN data and transmit that to another host
2416 computer over the existing Internet infrastructure.
2417
2418 @menu
2419 * The UDP tunnel::
2420 * The meta-connection::
2421 @end menu
2422
2423
2424 @c ==================================================================
2425 @node    The UDP tunnel
2426 @subsection The UDP tunnel
2427
2428 @cindex virtual network device
2429 @cindex frame type
2430 The data itself is read from a character device file, the so-called
2431 @emph{virtual network device}.  This device is associated with a network
2432 interface.  Any data sent to this interface can be read from the device,
2433 and any data written to the device gets sent from the interface.
2434 There are two possible types of virtual network devices:
2435 `tun' style, which are point-to-point devices which can only handle IPv4 and/or IPv6 packets,
2436 and `tap' style, which are Ethernet devices and handle complete Ethernet frames.
2437
2438 So when tinc reads an Ethernet frame from the device, it determines its
2439 type. When tinc is in it's default routing mode, it can handle IPv4 and IPv6
2440 packets. Depending on the Subnet lines, it will send the packets off to their destination IP address.
2441 In the `switch' and `hub' mode, tinc will use broadcasts and MAC address discovery
2442 to deduce the destination of the packets.
2443 Since the latter modes only depend on the link layer information,
2444 any protocol that runs over Ethernet is supported (for instance IPX and Appletalk).
2445 However, only `tap' style devices provide this information.
2446
2447 After the destination has been determined,
2448 the packet will be compressed (optionally),
2449 a sequence number will be added to the packet,
2450 the packet will then be encrypted
2451 and a message authentication code will be appended.
2452
2453 @cindex encapsulating
2454 @cindex UDP
2455 When that is done, time has come to actually transport the
2456 packet to the destination computer.  We do this by sending the packet
2457 over an UDP connection to the destination host.  This is called
2458 @emph{encapsulating}, the VPN packet (though now encrypted) is
2459 encapsulated in another IP datagram.
2460
2461 When the destination receives this packet, the same thing happens, only
2462 in reverse.  So it checks the message authentication code, decrypts the contents of the UDP datagram,
2463 checks the sequence number
2464 and writes the decrypted information to its own virtual network device.
2465
2466 If the virtual network device is a `tun' device (a point-to-point tunnel),
2467 there is no problem for the kernel to accept a packet.
2468 However, if it is a `tap' device (this is the only available type on FreeBSD),
2469 the destination MAC address must match that of the virtual network interface.
2470 If tinc is in it's default routing mode, ARP does not work, so the correct destination MAC 
2471 can not be known by the sending host.
2472 Tinc solves this by letting the receiving end detect the MAC address of its own virtual network interface
2473 and overwriting the destination MAC address of the received packet.
2474
2475 In switch or hub modes ARP does work so the sender already knows the correct destination MAC address.
2476 In those modes every interface should have a unique MAC address, so make sure they are not the same.
2477 Because switch and hub modes rely on MAC addresses to function correctly,
2478 these modes cannot be used on the following operating systems which don't have a `tap' style virtual network device:
2479 OpenBSD, NetBSD, Darwin and Solaris.
2480
2481
2482 @c ==================================================================
2483 @node    The meta-connection
2484 @subsection The meta-connection
2485
2486 Having only a UDP connection available is not enough.  Though suitable
2487 for transmitting data, we want to be able to reliably send other
2488 information, such as routing and session key information to somebody.
2489
2490 @cindex TCP
2491 TCP is a better alternative, because it already contains protection
2492 against information being lost, unlike UDP.
2493
2494 So we establish two connections.  One for the encrypted VPN data, and one
2495 for other information, the meta-data.  Hence, we call the second
2496 connection the meta-connection.  We can now be sure that the
2497 meta-information doesn't get lost on the way to another computer.
2498
2499 @cindex data-protocol
2500 @cindex meta-protocol
2501 Like with any communication, we must have a protocol, so that everybody
2502 knows what everything stands for, and how she should react.  Because we
2503 have two connections, we also have two protocols.  The protocol used for
2504 the UDP data is the ``data-protocol,'' the other one is the
2505 ``meta-protocol.''
2506
2507 The reason we don't use TCP for both protocols is that UDP is much
2508 better for encapsulation, even while it is less reliable.  The real
2509 problem is that when TCP would be used to encapsulate a TCP stream
2510 that's on the private network, for every packet sent there would be
2511 three ACKs sent instead of just one.  Furthermore, if there would be
2512 a timeout, both TCP streams would sense the timeout, and both would
2513 start re-sending packets.
2514
2515
2516 @c ==================================================================
2517 @node    The meta-protocol
2518 @section The meta-protocol
2519
2520 The meta protocol is used to tie all tinc daemons together, and
2521 exchange information about which tinc daemon serves which virtual
2522 subnet.
2523
2524 The meta protocol consists of requests that can be sent to the other
2525 side.  Each request has a unique number and several parameters.  All
2526 requests are represented in the standard ASCII character set.  It is
2527 possible to use tools such as telnet or netcat to connect to a tinc
2528 daemon started with the --bypass-security option
2529 and to read and write requests by hand, provided that one
2530 understands the numeric codes sent.
2531
2532 The authentication scheme is described in @ref{Authentication protocol}. After a
2533 successful authentication, the server and the client will exchange all the
2534 information about other tinc daemons and subnets they know of, so that both
2535 sides (and all the other tinc daemons behind them) have their information
2536 synchronised.
2537
2538 @cindex ADD_EDGE
2539 @cindex ADD_SUBNET
2540 @example
2541 message
2542 ------------------------------------------------------------------
2543 ADD_EDGE node1 node2 21.32.43.54 655 222 0
2544           |     |        |       |   |  +-> options
2545           |     |        |       |   +----> weight
2546           |     |        |       +--------> UDP port of node2
2547           |     |        +----------------> real address of node2
2548           |     +-------------------------> name of destination node
2549           +-------------------------------> name of source node
2550
2551 ADD_SUBNET node 192.168.1.0/24
2552             |         |     +--> prefixlength
2553             |         +--------> network address
2554             +------------------> owner of this subnet
2555 ------------------------------------------------------------------
2556 @end example
2557
2558 The ADD_EDGE messages are to inform other tinc daemons that a connection between
2559 two nodes exist. The address of the destination node is available so that
2560 VPN packets can be sent directly to that node.
2561
2562 The ADD_SUBNET messages inform other tinc daemons that certain subnets belong
2563 to certain nodes. tinc will use it to determine to which node a VPN packet has
2564 to be sent.
2565
2566 @cindex DEL_EDGE
2567 @cindex DEL_SUBNET
2568 @example
2569 message
2570 ------------------------------------------------------------------
2571 DEL_EDGE node1 node2
2572            |     +----> name of destination node
2573            +----------> name of source node
2574
2575 DEL_SUBNET node 192.168.1.0/24
2576              |         |     +--> prefixlength
2577              |         +--------> network address
2578              +------------------> owner of this subnet
2579 ------------------------------------------------------------------
2580 @end example
2581
2582 In case a connection between two daemons is closed or broken, DEL_EDGE messages
2583 are sent to inform the other daemons of that fact. Each daemon will calculate a
2584 new route to the the daemons, or mark them unreachable if there isn't any.
2585
2586 @cindex REQ_KEY
2587 @cindex ANS_KEY
2588 @cindex KEY_CHANGED
2589 @example
2590 message
2591 ------------------------------------------------------------------
2592 REQ_KEY origin destination
2593            |       +--> name of the tinc daemon it wants the key from
2594            +----------> name of the daemon that wants the key      
2595
2596 ANS_KEY origin destination 4ae0b0a82d6e0078 91 64 4
2597            |       |       \______________/ |  |  +--> MAC length
2598            |       |               |        |  +-----> digest algorithm
2599            |       |               |        +--------> cipher algorithm
2600            |       |               +--> 128 bits key
2601            |       +--> name of the daemon that wants the key
2602            +----------> name of the daemon that uses this key
2603
2604 KEY_CHANGED origin
2605               +--> daemon that has changed it's packet key
2606 ------------------------------------------------------------------
2607 @end example
2608
2609 The keys used to encrypt VPN packets are not sent out directly. This is
2610 because it would generate a lot of traffic on VPNs with many daemons, and
2611 chances are that not every tinc daemon will ever send a packet to every
2612 other daemon. Instead, if a daemon needs a key it sends a request for it
2613 via the meta connection of the nearest hop in the direction of the
2614 destination.
2615
2616 @cindex PING
2617 @cindex PONG
2618 @example
2619 daemon  message
2620 ------------------------------------------------------------------
2621 origin  PING
2622 dest.   PONG
2623 ------------------------------------------------------------------
2624 @end example
2625
2626 There is also a mechanism to check if hosts are still alive. Since network
2627 failures or a crash can cause a daemon to be killed without properly
2628 shutting down the TCP connection, this is necessary to keep an up to date
2629 connection list. PINGs are sent at regular intervals, except when there
2630 is also some other traffic. A little bit of salt (random data) is added
2631 with each PING and PONG message, to make sure that long sequences of PING/PONG
2632 messages without any other traffic won't result in known plaintext.
2633
2634 This basically covers what is sent over the meta connection by tinc.
2635
2636
2637 @c ==================================================================
2638 @node    Security
2639 @section Security
2640
2641 @cindex TINC
2642 @cindex Cabal
2643 Tinc got its name from ``TINC,'' short for @emph{There Is No Cabal}; the
2644 alleged Cabal was/is an organisation that was said to keep an eye on the
2645 entire Internet.  As this is exactly what you @emph{don't} want, we named
2646 the tinc project after TINC.
2647
2648 @cindex SVPN
2649 But in order to be ``immune'' to eavesdropping, you'll have to encrypt
2650 your data.  Because tinc is a @emph{Secure} VPN (SVPN) daemon, it does
2651 exactly that: encrypt.
2652 Tinc by default uses blowfish encryption with 128 bit keys in CBC mode, 32 bit
2653 sequence numbers and 4 byte long message authentication codes to make sure
2654 eavesdroppers cannot get and cannot change any information at all from the
2655 packets they can intercept. The encryption algorithm and message authentication
2656 algorithm can be changed in the configuration. The length of the message
2657 authentication codes is also adjustable. The length of the key for the
2658 encryption algorithm is always the default length used by OpenSSL.
2659
2660 @menu
2661 * Authentication protocol::
2662 * Encryption of network packets::
2663 * Security issues::
2664 @end menu
2665
2666
2667 @c ==================================================================
2668 @node       Authentication protocol
2669 @subsection Authentication protocol
2670
2671 @cindex authentication
2672 A new scheme for authentication in tinc has been devised, which offers some
2673 improvements over the protocol used in 1.0pre2 and 1.0pre3. Explanation is
2674 below.
2675
2676 @cindex ID
2677 @cindex META_KEY
2678 @cindex CHALLENGE
2679 @cindex CHAL_REPLY
2680 @cindex ACK
2681 @example
2682 daemon  message
2683 --------------------------------------------------------------------------
2684 client  <attempts connection>
2685
2686 server  <accepts connection>
2687
2688 client  ID client 12
2689               |   +---> version
2690               +-------> name of tinc daemon
2691
2692 server  ID server 12
2693               |   +---> version
2694               +-------> name of tinc daemon
2695
2696 client  META_KEY 5f0823a93e35b69e...7086ec7866ce582b
2697                  \_________________________________/
2698                                  +-> RSAKEYLEN bits totally random string S1,
2699                                      encrypted with server's public RSA key
2700
2701 server  META_KEY 6ab9c1640388f8f0...45d1a07f8a672630
2702                  \_________________________________/
2703                                  +-> RSAKEYLEN bits totally random string S2,
2704                                      encrypted with client's public RSA key
2705
2706 From now on:
2707  - the client will symmetrically encrypt outgoing traffic using S1
2708  - the server will symmetrically encrypt outgoing traffic using S2
2709
2710 client  CHALLENGE da02add1817c1920989ba6ae2a49cecbda0
2711                   \_________________________________/
2712                                  +-> CHALLEN bits totally random string H1
2713
2714 server  CHALLENGE 57fb4b2ccd70d6bb35a64c142f47e61d57f
2715                   \_________________________________/
2716                                  +-> CHALLEN bits totally random string H2
2717
2718 client  CHAL_REPLY 816a86
2719                       +-> 160 bits SHA1 of H2
2720
2721 server  CHAL_REPLY 928ffe
2722                       +-> 160 bits SHA1 of H1
2723
2724 After the correct challenge replies are received, both ends have proved
2725 their identity. Further information is exchanged.
2726
2727 client  ACK 655 123 0
2728              |   |  +-> options
2729                  |   +----> estimated weight
2730                  +--------> listening port of client
2731
2732 server  ACK 655 321 0
2733              |   |  +-> options
2734                  |   +----> estimated weight
2735                  +--------> listening port of server
2736 --------------------------------------------------------------------------
2737 @end example
2738
2739 This new scheme has several improvements, both in efficiency and security.
2740
2741 First of all, the server sends exactly the same kind of messages over the wire
2742 as the client. The previous versions of tinc first authenticated the client,
2743 and then the server. This scheme even allows both sides to send their messages
2744 simultaneously, there is no need to wait for the other to send something first.
2745 This means that any calculations that need to be done upon sending or receiving
2746 a message can also be done in parallel. This is especially important when doing
2747 RSA encryption/decryption. Given that these calculations are the main part of
2748 the CPU time spent for the authentication, speed is improved by a factor 2.
2749
2750 Second, only one RSA encrypted message is sent instead of two. This reduces the
2751 amount of information attackers can see (and thus use for a cryptographic
2752 attack). It also improves speed by a factor two, making the total speedup a
2753 factor 4.
2754
2755 Third, and most important:
2756 The symmetric cipher keys are exchanged first, the challenge is done
2757 afterwards. In the previous authentication scheme, because a man-in-the-middle
2758 could pass the challenge/chal_reply phase (by just copying the messages between
2759 the two real tinc daemons), but no information was exchanged that was really
2760 needed to read the rest of the messages, the challenge/chal_reply phase was of
2761 no real use. The man-in-the-middle was only stopped by the fact that only after
2762 the ACK messages were encrypted with the symmetric cipher. Potentially, it
2763 could even send it's own symmetric key to the server (if it knew the server's
2764 public key) and read some of the metadata the server would send it (it was
2765 impossible for the mitm to read actual network packets though). The new scheme
2766 however prevents this.
2767
2768 This new scheme makes sure that first of all, symmetric keys are exchanged. The
2769 rest of the messages are then encrypted with the symmetric cipher. Then, each
2770 side can only read received messages if they have their private key. The
2771 challenge is there to let the other side know that the private key is really
2772 known, because a challenge reply can only be sent back if the challenge is
2773 decrypted correctly, and that can only be done with knowledge of the private
2774 key.
2775
2776 Fourth: the first thing that is sent via the symmetric cipher encrypted
2777 connection is a totally random string, so that there is no known plaintext (for
2778 an attacker) in the beginning of the encrypted stream.
2779
2780
2781 @c ==================================================================
2782 @node       Encryption of network packets
2783 @subsection Encryption of network packets
2784 @cindex encryption
2785
2786 A data packet can only be sent if the encryption key is known to both
2787 parties, and the connection is  activated. If the encryption key is not
2788 known, a request is sent to the destination using the meta connection
2789 to retrieve it. The packet is stored in a queue while waiting for the
2790 key to arrive.
2791
2792 @cindex UDP
2793 The UDP packet containing the network packet from the VPN has the following layout:
2794
2795 @example
2796 ... | IP header | UDP header | seqno | VPN packet | MAC | UDP trailer
2797                              \___________________/\_____/
2798                                        |             |
2799                                        V             +---> digest algorithm
2800                          Encrypted with symmetric cipher
2801 @end example
2802
2803 So, the entire VPN packet is encrypted using a symmetric cipher, including a 32 bits
2804 sequence number that is added in front of the actual VPN packet, to act as a unique
2805 IV for each packet and to prevent replay attacks. A message authentication code
2806 is added to the UDP packet to prevent alteration of packets. By default the
2807 first 4 bytes of the digest are used for this, but this can be changed using
2808 the MACLength configuration variable.
2809
2810 @c ==================================================================
2811 @node    Security issues
2812 @subsection Security issues
2813
2814 In August 2000, we discovered the existence of a security hole in all versions
2815 of tinc up to and including 1.0pre2. This had to do with the way we exchanged
2816 keys. Since then, we have been working on a new authentication scheme to make
2817 tinc as secure as possible. The current version uses the OpenSSL library and
2818 uses strong authentication with RSA keys.
2819
2820 On the 29th of December 2001, Jerome Etienne posted a security analysis of tinc
2821 1.0pre4. Due to a lack of sequence numbers and a message authentication code
2822 for each packet, an attacker could possibly disrupt certain network services or
2823 launch a denial of service attack by replaying intercepted packets. The current
2824 version adds sequence numbers and message authentication codes to prevent such
2825 attacks.
2826
2827 On the 15th of September 2003, Peter Gutmann posted a security analysis of tinc
2828 1.0.1. He argues that the 32 bit sequence number used by tinc is not a good IV,
2829 that tinc's default length of 4 bytes for the MAC is too short, and he doesn't
2830 like tinc's use of RSA during authentication. We do not know of a security hole
2831 in this version of tinc, but tinc's security is not as strong as TLS or IPsec.
2832 We will address these issues in tinc 2.0.
2833
2834 Cryptography is a hard thing to get right. We cannot make any
2835 guarantees. Time, review and feedback are the only things that can
2836 prove the security of any cryptographic product. If you wish to review
2837 tinc or give us feedback, you are stronly encouraged to do so.
2838
2839
2840 @c ==================================================================
2841 @node    Platform specific information
2842 @chapter Platform specific information
2843
2844 @menu
2845 * Interface configuration::
2846 * Routes::
2847 @end menu
2848
2849 @c ==================================================================
2850 @node    Interface configuration
2851 @section Interface configuration
2852
2853 When configuring an interface, one normally assigns it an address and a
2854 netmask.  The address uniquely identifies the host on the network attached to
2855 the interface.  The netmask, combined with the address, forms a subnet.  It is
2856 used to add a route to the routing table instructing the kernel to send all
2857 packets which fall into that subnet to that interface.  Because all packets for
2858 the entire VPN should go to the virtual network interface used by tinc, the
2859 netmask should be such that it encompasses the entire VPN.
2860
2861 For IPv4 addresses:
2862
2863 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
2864 @item Linux
2865 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
2866 @item Linux iproute2
2867 @tab @code{ip addr add} @var{address}@code{/}@var{prefixlength} @code{dev} @var{interface}
2868 @item FreeBSD
2869 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
2870 @item OpenBSD
2871 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
2872 @item NetBSD
2873 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
2874 @item Solaris
2875 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
2876 @item Darwin (MacOS/X)
2877 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
2878 @item Windows
2879 @tab @code{netsh interface ip set address} @var{interface} @code{static} @var{address} @var{netmask}
2880 @end multitable
2881
2882 For IPv6 addresses:
2883
2884 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
2885 @item Linux
2886 @tab @code{ifconfig} @var{interface} @code{add} @var{address}@code{/}@var{prefixlength}
2887 @item FreeBSD
2888 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
2889 @item OpenBSD
2890 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
2891 @item NetBSD
2892 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
2893 @item Solaris
2894 @tab @code{ifconfig} @var{interface} @code{inet6 plumb up}
2895 @item
2896 @tab @code{ifconfig} @var{interface} @code{inet6 addif} @var{address} @var{address}
2897 @item Darwin (MacOS/X)
2898 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
2899 @item Windows
2900 @tab @code{netsh interface ipv6 add address} @var{interface} @code{static} @var{address}/@var{prefixlength}
2901 @end multitable
2902
2903 On some platforms, when running tinc in switch mode, the VPN interface must be set to tap mode with an ifconfig command:
2904
2905 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
2906 @item OpenBSD
2907 @tab @code{ifconfig} @var{interface} @code{link0}
2908 @end multitable
2909
2910 On Linux, it is possible to create a persistent tun/tap interface which will
2911 continue to exist even if tinc quit, although this is normally not required.
2912 It can be useful to set up a tun/tap interface owned by a non-root user, so
2913 tinc can be started without needing any root privileges at all.
2914
2915 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
2916 @item Linux
2917 @tab @code{ip tuntap add dev} @var{interface} @code{mode} @var{tun|tap} @code{user} @var{username}
2918 @end multitable
2919
2920 @c ==================================================================
2921 @node    Routes
2922 @section Routes
2923
2924 In some cases it might be necessary to add more routes to the virtual network
2925 interface.  There are two ways to indicate which interface a packet should go
2926 to, one is to use the name of the interface itself, another way is to specify
2927 the (local) address that is assigned to that interface (@var{local_address}). The
2928 former way is unambiguous and therefore preferable, but not all platforms
2929 support this.
2930
2931 Adding routes to IPv4 subnets:
2932
2933 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
2934 @item Linux
2935 @tab @code{route add -net} @var{network_address} @code{netmask} @var{netmask} @var{interface}
2936 @item Linux iproute2
2937 @tab @code{ip route add} @var{network_address}@code{/}@var{prefixlength} @code{dev} @var{interface}
2938 @item FreeBSD
2939 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
2940 @item OpenBSD
2941 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
2942 @item NetBSD
2943 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
2944 @item Solaris
2945 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address} @code{-interface}
2946 @item Darwin (MacOS/X)
2947 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
2948 @item Windows
2949 @tab @code{netsh routing ip add persistentroute} @var{network_address} @var{netmask} @var{interface} @var{local_address}
2950 @end multitable
2951
2952 Adding routes to IPv6 subnets:
2953
2954 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
2955 @item Linux
2956 @tab @code{route add -A inet6} @var{network_address}@code{/}@var{prefixlength} @var{interface}
2957 @item Linux iproute2
2958 @tab @code{ip route add} @var{network_address}@code{/}@var{prefixlength} @code{dev} @var{interface}
2959 @item FreeBSD
2960 @tab @code{route add -inet6} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
2961 @item OpenBSD
2962 @tab @code{route add -inet6} @var{network_address} @var{local_address} @code{-prefixlen} @var{prefixlength}
2963 @item NetBSD
2964 @tab @code{route add -inet6} @var{network_address} @var{local_address} @code{-prefixlen} @var{prefixlength}
2965 @item Solaris
2966 @tab @code{route add -inet6} @var{network_address}@code{/}@var{prefixlength} @var{local_address} @code{-interface}
2967 @item Darwin (MacOS/X)
2968 @tab ?
2969 @item Windows
2970 @tab @code{netsh interface ipv6 add route} @var{network address}/@var{prefixlength} @var{interface}
2971 @end multitable
2972
2973
2974 @c ==================================================================
2975 @node    About us
2976 @chapter About us
2977
2978
2979 @menu
2980 * Contact information::
2981 * Authors::
2982 @end menu
2983
2984
2985 @c ==================================================================
2986 @node    Contact information
2987 @section Contact information
2988
2989 @cindex website
2990 Tinc's website is at @url{http://www.tinc-vpn.org/},
2991 this server is located in the Netherlands.
2992
2993 @cindex IRC
2994 We have an IRC channel on the FreeNode and OFTC IRC networks. Connect to
2995 @uref{http://www.freenode.net/, irc.freenode.net}
2996 or
2997 @uref{http://www.oftc.net/, irc.oftc.net}
2998 and join channel #tinc.
2999
3000
3001 @c ==================================================================
3002 @node    Authors
3003 @section Authors
3004
3005 @table @asis
3006 @item Ivo Timmermans (zarq)
3007 @item Guus Sliepen (guus) (@email{guus@@tinc-vpn.org})
3008 @end table
3009
3010 We have received a lot of valuable input from users.  With their help,
3011 tinc has become the flexible and robust tool that it is today.  We have
3012 composed a list of contributions, in the file called @file{THANKS} in
3013 the source distribution.
3014
3015
3016 @c ==================================================================
3017 @node    Concept Index
3018 @unnumbered Concept Index
3019
3020 @c ==================================================================
3021 @printindex cp
3022
3023
3024 @c ==================================================================
3025 @contents
3026 @bye