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