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