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