a8afc06bdc45c49278f64847bfb5623ba1717e04
[tinc] / 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 These file consists of comments (lines started with a #) or assignments
722 in the form of
723
724 @example
725 Variable = Value.
726 @end example
727
728 The variable names are case insensitive, and any spaces, tabs, newlines
729 and carriage returns are ignored.  Note: it is not required that you put
730 in the `=' sign, but doing so improves readability.  If you leave it
731 out, remember to replace it with at least one space character.
732
733 The server configuration is complemented with host specific configuration (see
734 the next section). Although all host configuration options for the local node
735 listed in this document can also be put in
736 @file{@value{sysconfdir}/tinc/@var{netname}/tinc.conf}, it is recommended to
737 put host specific configuration options in the host configuration file, as this
738 makes it easy to exchange with other nodes.
739
740 In this section all valid variables are listed in alphabetical order.
741 The default value is given between parentheses,
742 other comments are between square brackets.
743
744 @menu
745 * Main configuration variables::
746 * Host configuration variables::
747 * Scripts::
748 * How to configure::
749 @end menu
750
751
752 @c ==================================================================
753 @node       Main configuration variables
754 @subsection Main configuration variables
755
756 @table @asis
757 @cindex AddressFamily
758 @item AddressFamily = <ipv4|ipv6|any> (any)
759 This option affects the address family of listening and outgoing sockets.
760 If any is selected, then depending on the operating system
761 both IPv4 and IPv6 or just IPv6 listening sockets will be created.
762
763 @cindex BindToAddress
764 @item BindToAddress = <@var{address}> [<@var{port}>] [experimental]
765 If your computer has more than one IPv4 or IPv6 address, tinc
766 will by default listen on all of them for incoming connections.
767 Multiple BindToAddress variables may be specified,
768 in which case listening sockets for each specified address are made.
769
770 If no @var{port} is specified, the socket will be bound to the port specified by the Port option,
771 or to port 655 if neither is given.
772 To only bind to a specific port but not to a specific address, use "*" for the @var{address}.
773
774 This option may not work on all platforms.
775
776 @cindex BindToInterface
777 @item BindToInterface = <@var{interface}> [experimental]
778 If you have more than one network interface in your computer, tinc will
779 by default listen on all of them for incoming connections.  It is
780 possible to bind tinc to a single interface like eth0 or ppp0 with this
781 variable.
782
783 This option may not work on all platforms.
784
785 @cindex Broadcast
786 @item Broadcast = <no | mst | direct> (mst) [experimental]
787 This option selects the way broadcast packets are sent to other daemons.
788 @emph{NOTE: all nodes in a VPN must use the same Broadcast mode, otherwise routing loops can form.}
789
790 @table @asis
791 @item no
792 Broadcast packets are never sent to other nodes.
793
794 @item mst
795 Broadcast packets are sent and forwarded via the VPN's Minimum Spanning Tree.
796 This ensures broadcast packets reach all nodes.
797
798 @item direct
799 Broadcast packets are sent directly to all nodes that can be reached directly.
800 Broadcast packets received from other nodes are never forwarded.
801 If the IndirectData option is also set, broadcast packets will only be sent to nodes which we have a meta connection to.
802 @end table
803
804 @cindex ConnectTo
805 @item ConnectTo = <@var{name}>
806 Specifies which other tinc daemon to connect to on startup.
807 Multiple ConnectTo variables may be specified,
808 in which case outgoing connections to each specified tinc daemon are made.
809 The names should be known to this tinc daemon
810 (i.e., there should be a host configuration file for the name on the ConnectTo line).
811
812 If you don't specify a host with ConnectTo,
813 tinc won't try to connect to other daemons at all,
814 and will instead just listen for incoming connections.
815
816 @cindex DecrementTTL
817 @item DecrementTTL = <yes | no> (no) [experimental]
818 When enabled, tinc will decrement the Time To Live field in IPv4 packets, or the Hop Limit field in IPv6 packets,
819 before forwarding a received packet to the virtual network device or to another node,
820 and will drop packets that have a TTL value of zero,
821 in which case it will send an ICMP Time Exceeded packet back.
822
823 Do not use this option if you use switch mode and want to use IPv6.
824
825 @cindex Device
826 @item Device = <@var{device}> (@file{/dev/tap0}, @file{/dev/net/tun} or other depending on platform)
827 The virtual network device to use.
828 Tinc will automatically detect what kind of device it is.
829 Note that you can only use one device per daemon.
830 Under Windows, use @var{Interface} instead of @var{Device}.
831 Note that you can only use one device per daemon.
832 See also @ref{Device files}.
833
834 @cindex DeviceType
835 @item DeviceType = <@var{type}> (platform dependent)
836 The type of the virtual network device.
837 Tinc will normally automatically select the right type of tun/tap interface, and this option should not be used.
838 However, this option can be used to select one of the special interface types, if support for them is compiled in.
839
840 @table @asis
841 @cindex dummy
842 @item dummy
843 Use a dummy interface.
844 No packets are ever read or written to a virtual network device.
845 Useful for testing, or when setting up a node that only forwards packets for other nodes.
846
847 @cindex raw_socket
848 @item raw_socket
849 Open a raw socket, and bind it to a pre-existing
850 @var{Interface} (eth0 by default).
851 All packets are read from this interface.
852 Packets received for the local node are written to the raw socket.
853 However, at least on Linux, the operating system does not process IP packets destined for the local host.
854
855 @cindex multicast
856 @item multicast
857 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}.
858 Packets are read from and written to this multicast socket.
859 This can be used to connect to UML, QEMU or KVM instances listening on the same multicast address.
860 Do NOT connect multiple tinc daemons to the same multicast address, this will very likely cause routing loops.
861 Also note that this can cause decrypted VPN packets to be sent out on a real network if misconfigured.
862
863 @cindex UML
864 @item uml (not compiled in by default)
865 Create a UNIX socket with the filename specified by
866 @var{Device}, or @file{@value{localstatedir}/run/@var{netname}.umlsocket}
867 if not specified.
868 Tinc will wait for a User Mode Linux instance to connect to this socket.
869
870 @cindex VDE
871 @item vde (not compiled in by default)
872 Uses the libvdeplug library to connect to a Virtual Distributed Ethernet switch,
873 using the UNIX socket specified by
874 @var{Device}, or @file{@value{localstatedir}/run/vde.ctl}
875 if not specified.
876 @end table
877
878 Also, in case tinc does not seem to correctly interpret packets received from the virtual network device,
879 it can be used to change the way packets are interpreted:
880
881 @table @asis
882 @item tun (BSD and Linux)
883 Set type to tun.
884 Depending on the platform, this can either be with or without an address family header (see below).
885
886 @cindex tunnohead
887 @item tunnohead (BSD)
888 Set type to tun without an address family header.
889 Tinc will expect packets read from the virtual network device to start with an IP header.
890 On some platforms IPv6 packets cannot be read from or written to the device in this mode.
891
892 @cindex tunifhead
893 @item tunifhead (BSD)
894 Set type to tun with an address family header.
895 Tinc will expect packets read from the virtual network device
896 to start with a four byte header containing the address family,
897 followed by an IP header.
898 This mode should support both IPv4 and IPv6 packets.
899
900 @item tap (BSD and Linux)
901 Set type to tap.
902 Tinc will expect packets read from the virtual network device
903 to start with an Ethernet header.
904 @end table
905
906 @cindex DirectOnly
907 @item DirectOnly = <yes|no> (no) [experimental]
908 When this option is enabled, packets that cannot be sent directly to the destination node,
909 but which would have to be forwarded by an intermediate node, are dropped instead.
910 When combined with the IndirectData option,
911 packets for nodes for which we do not have a meta connection with are also dropped.
912
913 @cindex Forwarding
914 @item Forwarding = <off|internal|kernel> (internal) [experimental]
915 This option selects the way indirect packets are forwarded.
916
917 @table @asis
918 @item off
919 Incoming packets that are not meant for the local node,
920 but which should be forwarded to another node, are dropped.
921
922 @item internal
923 Incoming packets that are meant for another node are forwarded by tinc internally.
924
925 This is the default mode, and unless you really know you need another forwarding mode, don't change it.
926
927 @item kernel
928 Incoming packets are always sent to the TUN/TAP device, even if the packets are not for the local node.
929 This is less efficient, but allows the kernel to apply its routing and firewall rules on them,
930 and can also help debugging.
931 @end table
932
933 @cindex GraphDumpFile
934 @item GraphDumpFile = <@var{filename}> [experimental]
935 If this option is present,
936 tinc will dump the current network graph to the file @var{filename}
937 every minute, unless there were no changes to the graph.
938 The file is in a format that can be read by graphviz tools.
939 If @var{filename} starts with a pipe symbol |,
940 then the rest of the filename is interpreted as a shell command
941 that is executed, the graph is then sent to stdin.
942
943 @cindex Hostnames
944 @item Hostnames = <yes|no> (no)
945 This option selects whether IP addresses (both real and on the VPN)
946 should be resolved.  Since DNS lookups are blocking, it might affect
947 tinc's efficiency, even stopping the daemon for a few seconds everytime
948 it does a lookup if your DNS server is not responding.
949
950 This does not affect resolving hostnames to IP addresses from the
951 configuration file, but whether hostnames should be resolved while logging.
952
953 @cindex Interface
954 @item Interface = <@var{interface}>
955 Defines the name of the interface corresponding to the virtual network device.
956 Depending on the operating system and the type of device this may or may not actually set the name of the interface.
957 Under Windows, this variable is used to select which network interface will be used.
958 If you specified a Device, this variable is almost always already correctly set.
959
960 @cindex LocalDiscovery
961 @item LocalDiscovery = <yes | no> (no) [experimental]
962 When enabled, tinc will try to detect peers that are on the same local network.
963 This will allow direct communication using LAN addresses, even if both peers are behind a NAT
964 and they only ConnectTo a third node outside the NAT,
965 which normally would prevent the peers from learning each other's LAN address.
966
967 Currently, local discovery is implemented by sending broadcast packets to the LAN during path MTU discovery.
968 This feature may not work in all possible situations.
969
970 @cindex Mode
971 @item Mode = <router|switch|hub> (router)
972 This option selects the way packets are routed to other daemons.
973
974 @table @asis
975 @cindex router
976 @item router
977 In this mode Subnet
978 variables in the host configuration files will be used to form a routing table.
979 Only unicast packets of routable protocols (IPv4 and IPv6) are supported in this mode.
980
981 This is the default mode, and unless you really know you need another mode, don't change it.
982
983 @cindex switch
984 @item switch
985 In this mode the MAC addresses of the packets on the VPN will be used to
986 dynamically create a routing table just like an Ethernet switch does.
987 Unicast, multicast and broadcast packets of every protocol that runs over Ethernet are supported in this mode
988 at the cost of frequent broadcast ARP requests and routing table updates.
989
990 This mode is primarily useful if you want to bridge Ethernet segments.
991
992 @cindex hub
993 @item hub
994 This mode is almost the same as the switch mode, but instead
995 every packet will be broadcast to the other daemons
996 while no routing table is managed.
997 @end table
998
999 @cindex KeyExpire
1000 @item KeyExpire = <@var{seconds}> (3600)
1001 This option controls the time the encryption keys used to encrypt the data
1002 are valid.  It is common practice to change keys at regular intervals to
1003 make it even harder for crackers, even though it is thought to be nearly
1004 impossible to crack a single key.
1005
1006 @cindex MACExpire
1007 @item MACExpire = <@var{seconds}> (600)
1008 This option controls the amount of time MAC addresses are kept before they are removed.
1009 This only has effect when Mode is set to "switch".
1010
1011 @cindex Name
1012 @item Name = <@var{name}> [required]
1013 This is a symbolic name for this connection.
1014 The name should consist only of alfanumeric and underscore characters (a-z, A-Z, 0-9 and _).
1015
1016 If Name starts with a $, then the contents of the environment variable that follows will be used.
1017 In that case, invalid characters will be converted to underscores.
1018 If Name is $HOST, but no such environment variable exist,
1019 the hostname will be read using the gethostnname() system call.
1020
1021 @cindex PingInterval
1022 @item PingInterval = <@var{seconds}> (60)
1023 The number of seconds of inactivity that tinc will wait before sending a
1024 probe to the other end.
1025
1026 @cindex PingTimeout
1027 @item PingTimeout = <@var{seconds}> (5)
1028 The number of seconds to wait for a response to pings or to allow meta
1029 connections to block. If the other end doesn't respond within this time,
1030 the connection is terminated, and the others will be notified of this.
1031
1032 @cindex PriorityInheritance
1033 @item PriorityInheritance = <yes|no> (no) [experimental]
1034 When this option is enabled the value of the TOS field of tunneled IPv4 packets
1035 will be inherited by the UDP packets that are sent out.
1036
1037 @cindex PrivateKey
1038 @item PrivateKey = <@var{key}> [obsolete]
1039 This is the RSA private key for tinc. However, for safety reasons it is
1040 advised to store private keys of any kind in separate files. This prevents
1041 accidental eavesdropping if you are editting the configuration file.
1042
1043 @cindex PrivateKeyFile
1044 @item PrivateKeyFile = <@var{path}> (@file{@value{sysconfdir}/tinc/@var{netname}/rsa_key.priv})
1045 This is the full path name of the RSA private key file that was
1046 generated by @samp{tincd --generate-keys}.  It must be a full path, not a
1047 relative directory.
1048
1049 @cindex ProcessPriority
1050 @item ProcessPriority = <low|normal|high>
1051 When this option is used the priority of the tincd process will be adjusted.
1052 Increasing the priority may help to reduce latency and packet loss on the VPN.
1053
1054 @cindex Proxy
1055 @item Proxy = socks4 | socks4 | http | exec @var{...} [experimental]
1056 Use a proxy when making outgoing connections.
1057 The following proxy types are currently supported:
1058
1059 @table @asis
1060 @cindex socks4
1061 @item socks4 <@var{address}> <@var{port}> [<@var{username}>]
1062 Connects to the proxy using the SOCKS version 4 protocol.
1063 Optionally, a @var{username} can be supplied which will be passed on to the proxy server.
1064
1065 @cindex socks5
1066 @item socks4 <@var{address}> <@var{port}> [<@var{username}> <@var{password}>]
1067 Connect to the proxy using the SOCKS version 5 protocol.
1068 If a @var{username} and @var{password} are given, basic username/password authentication will be used,
1069 otherwise no authentication will be used.
1070
1071 @cindex http
1072 @item http <@var{address}> <@var{port}>
1073 Connects to the proxy and sends a HTTP CONNECT request.
1074
1075 @cindex exec
1076 @item exec <@var{command}>
1077 Executes the given command which should set up the outgoing connection.
1078 The environment variables @env{NAME}, @env{NODE}, @env{REMOTEADDRES} and @env{REMOTEPORT} are available.
1079 @end table
1080
1081 @cindex ReplayWindow
1082 @item ReplayWindow = <bytes> (16)
1083 This is the size of the replay tracking window for each remote node, in bytes.
1084 The window is a bitfield which tracks 1 packet per bit, so for example
1085 the default setting of 16 will track up to 128 packets in the window. In high
1086 bandwidth scenarios, setting this to a higher value can reduce packet loss from
1087 the interaction of replay tracking with underlying real packet loss and/or
1088 reordering. Setting this to zero will disable replay tracking completely and
1089 pass all traffic, but leaves tinc vulnerable to replay-based attacks on your
1090 traffic.
1091
1092
1093 @cindex StrictSubnets
1094 @item StrictSubnets <yes|no> (no) [experimental]
1095 When this option is enabled tinc will only use Subnet statements which are
1096 present in the host config files in the local
1097 @file{@value{sysconfdir}/tinc/@var{netname}/hosts/} directory.
1098
1099 @cindex TunnelServer
1100 @item TunnelServer = <yes|no> (no) [experimental]
1101 When this option is enabled tinc will no longer forward information between other tinc daemons,
1102 and will only allow connections with nodes for which host config files are present in the local
1103 @file{@value{sysconfdir}/tinc/@var{netname}/hosts/} directory.
1104 Setting this options also implicitly sets StrictSubnets.
1105
1106 @cindex UDPRcvBuf
1107 @item UDPRcvBuf = <bytes> (OS default)
1108 Sets the socket receive buffer size for the UDP socket, in bytes.
1109 If unset, the default buffer size will be used by the operating system.
1110
1111 @cindex UDPSndBuf
1112 @item UDPSndBuf = <bytes> Pq OS default
1113 Sets the socket send buffer size for the UDP socket, in bytes.
1114 If unset, the default buffer size will be used by the operating system.
1115
1116 @end table
1117
1118
1119 @c ==================================================================
1120 @node       Host configuration variables
1121 @subsection Host configuration variables
1122
1123 @table @asis
1124 @cindex Address
1125 @item Address = <@var{IP address}|@var{hostname}> [<port>] [recommended]
1126 This variable is only required if you want to connect to this host.  It
1127 must resolve to the external IP address where the host can be reached,
1128 not the one that is internal to the VPN.
1129 If no port is specified, the default Port is used.
1130
1131 @cindex Cipher
1132 @item Cipher = <@var{cipher}> (blowfish)
1133 The symmetric cipher algorithm used to encrypt UDP packets.
1134 Any cipher supported by OpenSSL is recognized.
1135 Furthermore, specifying "none" will turn off packet encryption.
1136 It is best to use only those ciphers which support CBC mode.
1137
1138 @cindex ClampMSS
1139 @item ClampMSS = <yes|no> (yes)
1140 This option specifies whether tinc should clamp the maximum segment size (MSS)
1141 of TCP packets to the path MTU. This helps in situations where ICMP
1142 Fragmentation Needed or Packet too Big messages are dropped by firewalls.
1143
1144 @cindex Compression
1145 @item Compression = <@var{level}> (0)
1146 This option sets the level of compression used for UDP packets.
1147 Possible values are 0 (off), 1 (fast zlib) and any integer up to 9 (best zlib),
1148 10 (fast lzo) and 11 (best lzo).
1149
1150 @cindex Digest
1151 @item Digest = <@var{digest}> (sha1)
1152 The digest algorithm used to authenticate UDP packets.
1153 Any digest supported by OpenSSL is recognized.
1154 Furthermore, specifying "none" will turn off packet authentication.
1155
1156 @cindex IndirectData
1157 @item IndirectData = <yes|no> (no)
1158 This option specifies whether other tinc daemons besides the one you
1159 specified with ConnectTo can make a direct connection to you.  This is
1160 especially useful if you are behind a firewall and it is impossible to
1161 make a connection from the outside to your tinc daemon.  Otherwise, it
1162 is best to leave this option out or set it to no.
1163
1164 @cindex MACLength
1165 @item MACLength = <@var{bytes}> (4)
1166 The length of the message authentication code used to authenticate UDP packets.
1167 Can be anything from 0
1168 up to the length of the digest produced by the digest algorithm.
1169
1170 @cindex PMTU
1171 @item PMTU = <@var{mtu}> (1514)
1172 This option controls the initial path MTU to this node.
1173
1174 @cindex PMTUDiscovery
1175 @item PMTUDiscovery = <yes|no> (yes)
1176 When this option is enabled, tinc will try to discover the path MTU to this node.
1177 After the path MTU has been discovered, it will be enforced on the VPN.
1178
1179 @cindex Port
1180 @item Port = <@var{port}> (655)
1181 This is the port this tinc daemon listens on.
1182 You can use decimal portnumbers or symbolic names (as listed in @file{/etc/services}).
1183
1184 @cindex PublicKey
1185 @item PublicKey = <@var{key}> [obsolete]
1186 This is the RSA public key for this host.
1187
1188 @cindex PublicKeyFile
1189 @item PublicKeyFile = <@var{path}> [obsolete]
1190 This is the full path name of the RSA public key file that was generated
1191 by @samp{tincd --generate-keys}.  It must be a full path, not a relative
1192 directory.
1193
1194 @cindex PEM format
1195 From version 1.0pre4 on tinc will store the public key directly into the
1196 host configuration file in PEM format, the above two options then are not
1197 necessary. Either the PEM format is used, or exactly
1198 @strong{one of the above two options} must be specified
1199 in each host configuration file, if you want to be able to establish a
1200 connection with that host.
1201
1202 @cindex Subnet
1203 @item Subnet = <@var{address}[/@var{prefixlength}[#@var{weight}]]>
1204 The subnet which this tinc daemon will serve.
1205 Tinc tries to look up which other daemon it should send a packet to by searching the appropiate subnet.
1206 If the packet matches a subnet,
1207 it will be sent to the daemon who has this subnet in his host configuration file.
1208 Multiple subnet lines can be specified for each daemon.
1209
1210 Subnets can either be single MAC, IPv4 or IPv6 addresses,
1211 in which case a subnet consisting of only that single address is assumed,
1212 or they can be a IPv4 or IPv6 network address with a prefixlength.
1213 For example, IPv4 subnets must be in a form like 192.168.1.0/24,
1214 where 192.168.1.0 is the network address and 24 is the number of bits set in the netmask.
1215 Note that subnets like 192.168.1.1/24 are invalid!
1216 Read a networking HOWTO/FAQ/guide if you don't understand this.
1217 IPv6 subnets are notated like fec0:0:0:1::/64.
1218 MAC addresses are notated like 0:1a:2b:3c:4d:5e.
1219
1220 @cindex CIDR notation
1221 Prefixlength is the number of bits set to 1 in the netmask part; for
1222 example: netmask 255.255.255.0 would become /24, 255.255.252.0 becomes
1223 /22. This conforms to standard CIDR notation as described in
1224 @uref{http://www.ietf.org/rfc/rfc1519.txt, RFC1519}
1225
1226 @cindex Subnet weight
1227 A Subnet can be given a weight to indicate its priority over identical Subnets
1228 owned by different nodes. The default weight is 10. Lower values indicate
1229 higher priority. Packets will be sent to the node with the highest priority,
1230 unless that node is not reachable, in which case the node with the next highest
1231 priority will be tried, and so on.
1232
1233 @cindex TCPonly
1234 @item TCPonly = <yes|no> (no) [deprecated]
1235 If this variable is set to yes, then the packets are tunnelled over a
1236 TCP connection instead of a UDP connection.  This is especially useful
1237 for those who want to run a tinc daemon from behind a masquerading
1238 firewall, or if UDP packet routing is disabled somehow.
1239 Setting this options also implicitly sets IndirectData.
1240
1241 Since version 1.0.10, tinc will automatically detect whether communication via
1242 UDP is possible or not.
1243 @end table
1244
1245
1246 @c ==================================================================
1247 @node       Scripts
1248 @subsection Scripts
1249
1250 @cindex scripts
1251 Apart from reading the server and host configuration files,
1252 tinc can also run scripts at certain moments.
1253 Under Windows (not Cygwin), the scripts should have the extension .bat.
1254
1255 @table @file
1256 @cindex tinc-up
1257 @item @value{sysconfdir}/tinc/@var{netname}/tinc-up
1258 This is the most important script.
1259 If it is present it will be executed right after the tinc daemon has been
1260 started and has connected to the virtual network device.
1261 It should be used to set up the corresponding network interface,
1262 but can also be used to start other things.
1263 Under Windows you can use the Network Connections control panel instead of creating this script.
1264
1265 @cindex tinc-down
1266 @item @value{sysconfdir}/tinc/@var{netname}/tinc-down
1267 This script is started right before the tinc daemon quits.
1268
1269 @item @value{sysconfdir}/tinc/@var{netname}/hosts/@var{host}-up
1270 This script is started when the tinc daemon with name @var{host} becomes reachable.
1271
1272 @item @value{sysconfdir}/tinc/@var{netname}/hosts/@var{host}-down
1273 This script is started when the tinc daemon with name @var{host} becomes unreachable.
1274
1275 @item @value{sysconfdir}/tinc/@var{netname}/host-up
1276 This script is started when any host becomes reachable.
1277
1278 @item @value{sysconfdir}/tinc/@var{netname}/host-down
1279 This script is started when any host becomes unreachable.
1280
1281 @item @value{sysconfdir}/tinc/@var{netname}/subnet-up
1282 This script is started when a Subnet becomes reachable.
1283 The Subnet and the node it belongs to are passed in environment variables.
1284
1285 @item @value{sysconfdir}/tinc/@var{netname}/subnet-down
1286 This script is started when a Subnet becomes unreachable.
1287 @end table
1288
1289 @cindex environment variables
1290 The scripts are started without command line arguments,
1291 but can make use of certain environment variables.
1292 Under UNIX like operating systems the names of environment variables must be preceded by a $ in scripts.
1293 Under Windows, in @file{.bat} files, they have to be put between % signs.
1294
1295 @table @env
1296 @cindex NETNAME
1297 @item NETNAME
1298 If a netname was specified, this environment variable contains it.
1299
1300 @cindex NAME
1301 @item NAME
1302 Contains the name of this tinc daemon.
1303
1304 @cindex DEVICE
1305 @item DEVICE
1306 Contains the name of the virtual network device that tinc uses.
1307
1308 @cindex INTERFACE
1309 @item INTERFACE
1310 Contains the name of the virtual network interface that tinc uses.
1311 This should be used for commands like ifconfig.
1312
1313 @cindex NODE
1314 @item NODE
1315 When a host becomes (un)reachable, this is set to its name.
1316 If a subnet becomes (un)reachable, this is set to the owner of that subnet.
1317
1318 @cindex REMOTEADDRESS
1319 @item REMOTEADDRESS
1320 When a host becomes (un)reachable, this is set to its real address.
1321
1322 @cindex REMOTEPORT
1323 @item REMOTEPORT
1324 When a host becomes (un)reachable,
1325 this is set to the port number it uses for communication with other tinc daemons.
1326
1327 @cindex SUBNET
1328 @item SUBNET
1329 When a subnet becomes (un)reachable, this is set to the subnet.
1330
1331 @cindex WEIGHT
1332 @item WEIGHT
1333 When a subnet becomes (un)reachable, this is set to the subnet weight.
1334
1335 @end table
1336
1337
1338 @c ==================================================================
1339 @node       How to configure
1340 @subsection How to configure
1341
1342 @subsubheading Step 1.  Creating the main configuration file
1343
1344 The main configuration file will be called @file{@value{sysconfdir}/tinc/@var{netname}/tinc.conf}.
1345 Adapt the following example to create a basic configuration file:
1346
1347 @example
1348 Name = @var{yourname}
1349 Device = @file{/dev/tap0}
1350 @end example
1351
1352 Then, if you know to which other tinc daemon(s) yours is going to connect,
1353 add `ConnectTo' values.
1354
1355 @subsubheading Step 2.  Creating your host configuration file
1356
1357 If you added a line containing `Name = yourname' in the main configuarion file,
1358 you will need to create a host configuration file @file{@value{sysconfdir}/tinc/@var{netname}/hosts/yourname}.
1359 Adapt the following example to create a host configuration file:
1360
1361 @example
1362 Address = your.real.hostname.org
1363 Subnet = 192.168.1.0/24
1364 @end example
1365
1366 You can also use an IP address instead of a hostname.
1367 The `Subnet' specifies the address range that is local for @emph{your part of the VPN only}.
1368 If you have multiple address ranges you can specify more than one `Subnet'.
1369 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).
1370
1371
1372 @c ==================================================================
1373 @node    Generating keypairs
1374 @section Generating keypairs
1375
1376 @cindex key generation
1377 Now that you have already created the main configuration file and your host configuration file,
1378 you can easily create a public/private keypair by entering the following command:
1379
1380 @example
1381 tincd -n @var{netname} -K
1382 @end example
1383
1384 Tinc will generate a public and a private key and ask you where to put them.
1385 Just press enter to accept the defaults.
1386
1387
1388 @c ==================================================================
1389 @node    Network interfaces
1390 @section Network interfaces
1391
1392 Before tinc can start transmitting data over the tunnel, it must
1393 set up the virtual network interface.
1394
1395 First, decide which IP addresses you want to have associated with these
1396 devices, and what network mask they must have.
1397
1398 Tinc will open a virtual network device (@file{/dev/tun}, @file{/dev/tap0} or similar),
1399 which will also create a network interface called something like @samp{tun0}, @samp{tap0}.
1400 If you are using the Linux tun/tap driver, the network interface will by default have the same name as the @var{netname}.
1401 Under Windows you can change the name of the network interface from the Network Connections control panel.
1402
1403 @cindex tinc-up
1404 You can configure the network interface by putting ordinary ifconfig, route, and other commands
1405 to a script named @file{@value{sysconfdir}/tinc/@var{netname}/tinc-up}.
1406 When tinc starts, this script will be executed. When tinc exits, it will execute the script named
1407 @file{@value{sysconfdir}/tinc/@var{netname}/tinc-down}, but normally you don't need to create that script.
1408
1409 An example @file{tinc-up} script:
1410
1411 @example
1412 #!/bin/sh
1413 ifconfig $INTERFACE 192.168.1.1 netmask 255.255.0.0
1414 @end example
1415
1416 This script gives the interface an IP address and a netmask.
1417 The kernel will also automatically add a route to this interface, so normally you don't need
1418 to add route commands to the @file{tinc-up} script.
1419 The kernel will also bring the interface up after this command.
1420 @cindex netmask
1421 The netmask is the mask of the @emph{entire} VPN network, not just your
1422 own subnet.
1423
1424 The exact syntax of the ifconfig and route commands differs from platform to platform.
1425 You can look up the commands for setting addresses and adding routes in @ref{Platform specific information},
1426 but it is best to consult the manpages of those utilities on your platform.
1427
1428
1429 @c ==================================================================
1430 @node    Example configuration
1431 @section Example configuration
1432
1433
1434 @cindex example
1435 Imagine the following situation.  Branch A of our example `company' wants to connect
1436 three branch offices in B, C and D using the Internet.  All four offices
1437 have a 24/7 connection to the Internet.
1438
1439 A is going to serve as the center of the network.  B and C will connect
1440 to A, and D will connect to C.  Each office will be assigned their own IP
1441 network, 10.x.0.0.
1442
1443 @example
1444 A: net 10.1.0.0 mask 255.255.0.0 gateway 10.1.54.1 internet IP 1.2.3.4
1445 B: net 10.2.0.0 mask 255.255.0.0 gateway 10.2.1.12 internet IP 2.3.4.5
1446 C: net 10.3.0.0 mask 255.255.0.0 gateway 10.3.69.254 internet IP 3.4.5.6
1447 D: net 10.4.0.0 mask 255.255.0.0 gateway 10.4.3.32 internet IP 4.5.6.7
1448 @end example
1449
1450 Here, ``gateway'' is the VPN IP address of the machine that is running the
1451 tincd, and ``internet IP'' is the IP address of the firewall, which does not
1452 need to run tincd, but it must do a port forwarding of TCP and UDP on port
1453 655 (unless otherwise configured).
1454
1455 In this example, it is assumed that eth0 is the interface that points to
1456 the inner (physical) LAN of the office, although this could also be the
1457 same as the interface that leads to the Internet.  The configuration of
1458 the real interface is also shown as a comment, to give you an idea of
1459 how these example host is set up. All branches use the netname `company'
1460 for this particular VPN.
1461
1462 @subsubheading For Branch A
1463
1464 @emph{BranchA} would be configured like this:
1465
1466 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1467
1468 @example
1469 # Real interface of internal network:
1470 # ifconfig eth0 10.1.54.1 netmask 255.255.0.0
1471
1472 ifconfig $INTERFACE 10.1.54.1 netmask 255.0.0.0
1473 @end example
1474
1475 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1476
1477 @example
1478 Name = BranchA
1479 Device = /dev/tap0
1480 @end example
1481
1482 On all hosts, @file{@value{sysconfdir}/tinc/company/hosts/BranchA} contains:
1483
1484 @example
1485 Subnet = 10.1.0.0/16
1486 Address = 1.2.3.4
1487
1488 -----BEGIN RSA PUBLIC KEY-----
1489 ...
1490 -----END RSA PUBLIC KEY-----
1491 @end example
1492
1493 Note that the IP addresses of eth0 and tap0 are the same.
1494 This is quite possible, if you make sure that the netmasks of the interfaces are different.
1495 It is in fact recommended to give both real internal network interfaces and tap interfaces the same IP address,
1496 since that will make things a lot easier to remember and set up.
1497
1498
1499 @subsubheading For Branch B
1500
1501 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1502
1503 @example
1504 # Real interface of internal network:
1505 # ifconfig eth0 10.2.43.8 netmask 255.255.0.0
1506
1507 ifconfig $INTERFACE 10.2.1.12 netmask 255.0.0.0
1508 @end example
1509
1510 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1511
1512 @example
1513 Name = BranchB
1514 ConnectTo = BranchA
1515 @end example
1516
1517 Note here that the internal address (on eth0) doesn't have to be the
1518 same as on the tap0 device.  Also, ConnectTo is given so that this node will
1519 always try to connect to BranchA.
1520
1521 On all hosts, in @file{@value{sysconfdir}/tinc/company/hosts/BranchB}:
1522
1523 @example
1524 Subnet = 10.2.0.0/16
1525 Address = 2.3.4.5
1526
1527 -----BEGIN RSA PUBLIC KEY-----
1528 ...
1529 -----END RSA PUBLIC KEY-----
1530 @end example
1531
1532
1533 @subsubheading For Branch C
1534
1535 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1536
1537 @example
1538 # Real interface of internal network:
1539 # ifconfig eth0 10.3.69.254 netmask 255.255.0.0
1540
1541 ifconfig $INTERFACE 10.3.69.254 netmask 255.0.0.0
1542 @end example
1543
1544 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1545
1546 @example
1547 Name = BranchC
1548 ConnectTo = BranchA
1549 Device = /dev/tap1
1550 @end example
1551
1552 C already has another daemon that runs on port 655, so they have to
1553 reserve another port for tinc. It knows the portnumber it has to listen on
1554 from it's own host configuration file.
1555
1556 On all hosts, in @file{@value{sysconfdir}/tinc/company/hosts/BranchC}:
1557
1558 @example
1559 Address = 3.4.5.6
1560 Subnet = 10.3.0.0/16
1561 Port = 2000
1562
1563 -----BEGIN RSA PUBLIC KEY-----
1564 ...
1565 -----END RSA PUBLIC KEY-----
1566 @end example
1567
1568
1569 @subsubheading For Branch D
1570
1571 In @file{@value{sysconfdir}/tinc/company/tinc-up}:
1572
1573 @example
1574 # Real interface of internal network:
1575 # ifconfig eth0 10.4.3.32 netmask 255.255.0.0
1576
1577 ifconfig $INTERFACE 10.4.3.32 netmask 255.0.0.0
1578 @end example
1579
1580 and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
1581
1582 @example
1583 Name = BranchD
1584 ConnectTo = BranchC
1585 Device = /dev/net/tun
1586 @end example
1587
1588 D will be connecting to C, which has a tincd running for this network on
1589 port 2000. It knows the port number from the host configuration file.
1590 Also note that since D uses the tun/tap driver, the network interface
1591 will not be called `tun' or `tap0' or something like that, but will
1592 have the same name as netname.
1593
1594 On all hosts, in @file{@value{sysconfdir}/tinc/company/hosts/BranchD}:
1595
1596 @example
1597 Subnet = 10.4.0.0/16
1598 Address = 4.5.6.7
1599
1600 -----BEGIN RSA PUBLIC KEY-----
1601 ...
1602 -----END RSA PUBLIC KEY-----
1603 @end example
1604
1605 @subsubheading Key files
1606
1607 A, B, C and D all have generated a public/private keypair with the following command:
1608
1609 @example
1610 tincd -n company -K
1611 @end example
1612
1613 The private key is stored in @file{@value{sysconfdir}/tinc/company/rsa_key.priv},
1614 the public key is put into the host configuration file in the @file{@value{sysconfdir}/tinc/company/hosts/} directory.
1615 During key generation, tinc automatically guesses the right filenames based on the -n option and
1616 the Name directive in the @file{tinc.conf} file (if it is available).
1617
1618 @subsubheading Starting
1619
1620 After each branch has finished configuration and they have distributed
1621 the host configuration files amongst them, they can start their tinc daemons.
1622 They don't necessarily have to wait for the other branches to have started
1623 their daemons, tinc will try connecting until they are available.
1624
1625
1626 @c ==================================================================
1627 @node    Running tinc
1628 @chapter Running tinc
1629
1630 If everything else is done, you can start tinc by typing the following command:
1631
1632 @example
1633 tincd -n @var{netname}
1634 @end example
1635
1636 @cindex daemon
1637 Tinc will detach from the terminal and continue to run in the background like a good daemon.
1638 If there are any problems however you can try to increase the debug level
1639 and look in the syslog to find out what the problems are.
1640
1641 @menu
1642 * Runtime options::
1643 * Signals::
1644 * Debug levels::
1645 * Solving problems::
1646 * Error messages::
1647 * Sending bug reports::
1648 @end menu
1649
1650
1651 @c ==================================================================
1652 @node    Runtime options
1653 @section Runtime options
1654
1655 Besides the settings in the configuration file, tinc also accepts some
1656 command line options.
1657
1658 @cindex command line
1659 @cindex runtime options
1660 @cindex options
1661 @c from the manpage
1662 @table @option
1663 @item -c, --config=@var{path}
1664 Read configuration options from the directory @var{path}.  The default is
1665 @file{@value{sysconfdir}/tinc/@var{netname}/}.
1666
1667 @item -D, --no-detach
1668 Don't fork and detach.
1669 This will also disable the automatic restart mechanism for fatal errors.
1670
1671 @cindex debug level
1672 @item -d, --debug=@var{level}
1673 Set debug level to @var{level}.  The higher the debug level, the more gets
1674 logged.  Everything goes via syslog.
1675
1676 @item -k, --kill[=@var{signal}]
1677 Attempt to kill a running tincd (optionally with the specified @var{signal} instead of SIGTERM) and exit.
1678 Use it in conjunction with the -n option to make sure you kill the right tinc daemon.
1679 Under native Windows the optional argument is ignored,
1680 the service will always be stopped and removed.
1681
1682 @item -n, --net=@var{netname}
1683 Use configuration for net @var{netname}.
1684 This will let tinc read all configuration files from
1685 @file{@value{sysconfdir}/tinc/@var{netname}/}.
1686 Specifying . for @var{netname} is the same as not specifying any @var{netname}.
1687 @xref{Multiple networks}.
1688
1689 @item -K, --generate-keys[=@var{bits}]
1690 Generate public/private keypair of @var{bits} length. If @var{bits} is not specified,
1691 2048 is the default. tinc will ask where you want to store the files,
1692 but will default to the configuration directory (you can use the -c or -n option
1693 in combination with -K). After that, tinc will quit.
1694
1695 @item -o, --option=[@var{HOST}.]@var{KEY}=@var{VALUE}
1696 Without specifying a @var{HOST}, this will set server configuration variable @var{KEY} to @var{VALUE}.
1697 If specified as @var{HOST}.@var{KEY}=@var{VALUE},
1698 this will set the host configuration variable @var{KEY} of the host named @var{HOST} to @var{VALUE}.
1699 This option can be used more than once to specify multiple configuration variables.
1700
1701 @item -L, --mlock
1702 Lock tinc into main memory.
1703 This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.
1704
1705 @item --logfile[=@var{file}]
1706 Write log entries to a file instead of to the system logging facility.
1707 If @var{file} is omitted, the default is @file{@value{localstatedir}/log/tinc.@var{netname}.log}.
1708
1709 @item --pidfile=@var{file}
1710 Write PID to @var{file} instead of @file{@value{localstatedir}/run/tinc.@var{netname}.pid}.
1711
1712 @item --bypass-security
1713 Disables encryption and authentication.
1714 Only useful for debugging.
1715
1716 @item -R, --chroot
1717 Change process root directory to the directory where the config file is
1718 located (@file{@value{sysconfdir}/tinc/@var{netname}/} as determined by
1719 -n/--net option or as given by -c/--config option), for added security.
1720 The chroot is performed after all the initialization is done, after
1721 writing pid files and opening network sockets.
1722
1723 Note that this option alone does not do any good without -U/--user, below.
1724
1725 Note also that tinc can't run scripts anymore (such as tinc-down or host-up),
1726 unless it's setup to be runnable inside chroot environment.
1727
1728 @item -U, --user=@var{user}
1729 Switch to the given @var{user} after initialization, at the same time as
1730 chroot is performed (see --chroot above).  With this option tinc drops
1731 privileges, for added security.
1732
1733 @item --help
1734 Display a short reminder of these runtime options and terminate.
1735
1736 @item --version
1737 Output version information and exit.
1738
1739 @end table
1740
1741 @c ==================================================================
1742 @node    Signals
1743 @section Signals
1744
1745 @cindex signals
1746 You can also send the following signals to a running tincd process:
1747
1748 @c from the manpage
1749 @table @samp
1750
1751 @item ALRM
1752 Forces tinc to try to connect to all uplinks immediately.
1753 Usually tinc attempts to do this itself,
1754 but increases the time it waits between the attempts each time it failed,
1755 and if tinc didn't succeed to connect to an uplink the first time after it started,
1756 it defaults to the maximum time of 15 minutes.
1757
1758 @item HUP
1759 Partially rereads configuration files.
1760 Connections to hosts whose host config file are removed are closed.
1761 New outgoing connections specified in @file{tinc.conf} will be made.
1762 If the --logfile option is used, this will also close and reopen the log file,
1763 useful when log rotation is used.
1764
1765 @item INT
1766 Temporarily increases debug level to 5.
1767 Send this signal again to revert to the original level.
1768
1769 @item USR1
1770 Dumps the connection list to syslog.
1771
1772 @item USR2
1773 Dumps virtual network device statistics, all known nodes, edges and subnets to syslog.
1774
1775 @item WINCH
1776 Purges all information remembered about unreachable nodes.
1777
1778 @end table
1779
1780 @c ==================================================================
1781 @node    Debug levels
1782 @section Debug levels
1783
1784 @cindex debug levels
1785 The tinc daemon can send a lot of messages to the syslog.
1786 The higher the debug level, the more messages it will log.
1787 Each level inherits all messages of the previous level:
1788
1789 @c from the manpage
1790 @table @samp
1791
1792 @item 0
1793 This will log a message indicating tinc has started along with a version number.
1794 It will also log any serious error.
1795
1796 @item 1
1797 This will log all connections that are made with other tinc daemons.
1798
1799 @item 2
1800 This will log status and error messages from scripts and other tinc daemons.
1801
1802 @item 3
1803 This will log all requests that are exchanged with other tinc daemons. These include
1804 authentication, key exchange and connection list updates.
1805
1806 @item 4
1807 This will log a copy of everything received on the meta socket.
1808
1809 @item 5
1810 This will log all network traffic over the virtual private network.
1811
1812 @end table
1813
1814 @c ==================================================================
1815 @node    Solving problems
1816 @section Solving problems
1817
1818 If tinc starts without problems, but if the VPN doesn't work, you will have to find the cause of the problem.
1819 The first thing to do is to start tinc with a high debug level in the foreground,
1820 so you can directly see everything tinc logs:
1821
1822 @example
1823 tincd -n @var{netname} -d5 -D
1824 @end example
1825
1826 If tinc does not log any error messages, then you might want to check the following things:
1827
1828 @itemize
1829 @item @file{tinc-up} script
1830 Does this script contain the right commands?
1831 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.
1832
1833 @item Subnet
1834 Does the Subnet (or Subnets) in the host configuration file of this host match the portion of the VPN that belongs to this host?
1835
1836 @item Firewalls and NATs
1837 Do you have a firewall or a NAT device (a masquerading firewall or perhaps an ADSL router that performs masquerading)?
1838 If so, check that it allows TCP and UDP traffic on port 655.
1839 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.
1840 You can add @samp{TCPOnly = yes} to your host config file to force tinc to only use a single TCP connection,
1841 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.
1842
1843 @end itemize
1844
1845
1846 @c ==================================================================
1847 @node    Error messages
1848 @section Error messages
1849
1850 What follows is a list of the most common error messages you might find in the logs.
1851 Some of them will only be visible if the debug level is high enough.
1852
1853 @table @samp
1854 @item Could not open /dev/tap0: No such device
1855
1856 @itemize
1857 @item You forgot to `modprobe netlink_dev' or `modprobe ethertap'.
1858 @item You forgot to compile `Netlink device emulation' in the kernel.
1859 @end itemize
1860
1861 @item Can't write to /dev/net/tun: No such device
1862
1863 @itemize
1864 @item You forgot to `modprobe tun'.
1865 @item You forgot to compile `Universal TUN/TAP driver' in the kernel.
1866 @item The tun device is located somewhere else in @file{/dev/}.
1867 @end itemize
1868
1869 @item Network address and prefix length do not match!
1870
1871 @itemize
1872 @item The Subnet field must contain a @emph{network} address, trailing bits should be 0.
1873 @item If you only want to use one IP address, set the netmask to /32.
1874 @end itemize
1875
1876 @item Error reading RSA key file `rsa_key.priv': No such file or directory
1877
1878 @itemize
1879 @item You forgot to create a public/private keypair.
1880 @item Specify the complete pathname to the private key file with the @samp{PrivateKeyFile} option.
1881 @end itemize
1882
1883 @item Warning: insecure file permissions for RSA private key file `rsa_key.priv'!
1884
1885 @itemize
1886 @item The private key file is readable by users other than root.
1887 Use chmod to correct the file permissions.
1888 @end itemize
1889
1890 @item Creating metasocket failed: Address family not supported
1891
1892 @itemize
1893 @item By default tinc tries to create both IPv4 and IPv6 sockets.
1894 On some platforms this might not be implemented.
1895 If the logs show @samp{Ready} later on, then at least one metasocket was created,
1896 and you can ignore this message.
1897 You can add @samp{AddressFamily = ipv4} to @file{tinc.conf} to prevent this from happening.
1898 @end itemize
1899
1900 @item Cannot route packet: unknown IPv4 destination 1.2.3.4
1901
1902 @itemize
1903 @item You try to send traffic to a host on the VPN for which no Subnet is known.
1904 @item If it is a broadcast address (ending in .255), it probably is a samba server or a Windows host sending broadcast packets.
1905 You can ignore it.
1906 @end itemize
1907
1908 @item Cannot route packet: ARP request for unknown address 1.2.3.4
1909
1910 @itemize
1911 @item You try to send traffic to a host on the VPN for which no Subnet is known.
1912 @end itemize
1913
1914 @item Packet with destination 1.2.3.4 is looping back to us!
1915
1916 @itemize
1917 @item Something is not configured right. Packets are being sent out to the
1918 virtual network device, but according to the Subnet directives in your host configuration
1919 file, those packets should go to your own host. Most common mistake is that
1920 you have a Subnet line in your host configuration file with a prefix length which is
1921 just as large as the prefix of the virtual network interface. The latter should in almost all
1922 cases be larger. Rethink your configuration.
1923 Note that you will only see this message if you specified a debug
1924 level of 5 or higher!
1925 @item Chances are that a @samp{Subnet = ...} line in the host configuration file of this tinc daemon is wrong.
1926 Change it to a subnet that is accepted locally by another interface,
1927 or if that is not the case, try changing the prefix length into /32. 
1928 @end itemize
1929
1930 @item Node foo (1.2.3.4) is not reachable
1931
1932 @itemize
1933 @item Node foo does not have a connection anymore, its tinc daemon is not running or its connection to the Internet is broken.
1934 @end itemize
1935
1936 @item Received UDP packet from unknown source 1.2.3.4 (port 12345)
1937
1938 @itemize
1939 @item If you see this only sporadically, it is harmless and caused by a node sending packets using an old key.
1940 @end itemize
1941
1942 @item Got bad/bogus/unauthorized REQUEST from foo (1.2.3.4 port 12345)
1943
1944 @itemize
1945 @item Node foo does not have the right public/private keypair.
1946 Generate new keypairs and distribute them again.
1947 @item An attacker tries to gain access to your VPN.
1948 @item A network error caused corruption of metadata sent from foo.
1949 @end itemize
1950
1951 @end table
1952
1953 @c ==================================================================
1954 @node    Sending bug reports
1955 @section Sending bug reports
1956
1957 If you really can't find the cause of a problem, or if you suspect tinc is not working right,
1958 you can send us a bugreport, see @ref{Contact information}.
1959 Be sure to include the following information in your bugreport:
1960
1961 @itemize
1962 @item A clear description of what you are trying to achieve and what the problem is.
1963 @item What platform (operating system, version, hardware architecture) and which version of tinc you use.
1964 @item If compiling tinc fails, a copy of @file{config.log} and the error messages you get.
1965 @item Otherwise, a copy of @file{tinc.conf}, @file{tinc-up} and all files in the @file{hosts/} directory.
1966 @item The output of the commands @samp{ifconfig -a} and @samp{route -n} (or @samp{netstat -rn} if that doesn't work).
1967 @item The output of any command that fails to work as it should (like ping or traceroute).
1968 @end itemize
1969
1970 @c ==================================================================
1971 @node    Technical information
1972 @chapter Technical information
1973
1974
1975 @menu
1976 * The connection::
1977 * The meta-protocol::
1978 * Security::
1979 @end menu
1980
1981
1982 @c ==================================================================
1983 @node    The connection
1984 @section The connection
1985
1986 @cindex connection
1987 Tinc is a daemon that takes VPN data and transmit that to another host
1988 computer over the existing Internet infrastructure.
1989
1990 @menu
1991 * The UDP tunnel::
1992 * The meta-connection::
1993 @end menu
1994
1995
1996 @c ==================================================================
1997 @node    The UDP tunnel
1998 @subsection The UDP tunnel
1999
2000 @cindex virtual network device
2001 @cindex frame type
2002 The data itself is read from a character device file, the so-called
2003 @emph{virtual network device}.  This device is associated with a network
2004 interface.  Any data sent to this interface can be read from the device,
2005 and any data written to the device gets sent from the interface.
2006 There are two possible types of virtual network devices:
2007 `tun' style, which are point-to-point devices which can only handle IPv4 and/or IPv6 packets,
2008 and `tap' style, which are Ethernet devices and handle complete Ethernet frames.
2009
2010 So when tinc reads an Ethernet frame from the device, it determines its
2011 type. When tinc is in it's default routing mode, it can handle IPv4 and IPv6
2012 packets. Depending on the Subnet lines, it will send the packets off to their destination IP address.
2013 In the `switch' and `hub' mode, tinc will use broadcasts and MAC address discovery
2014 to deduce the destination of the packets.
2015 Since the latter modes only depend on the link layer information,
2016 any protocol that runs over Ethernet is supported (for instance IPX and Appletalk).
2017 However, only `tap' style devices provide this information.
2018
2019 After the destination has been determined,
2020 the packet will be compressed (optionally),
2021 a sequence number will be added to the packet,
2022 the packet will then be encrypted
2023 and a message authentication code will be appended.
2024
2025 @cindex encapsulating
2026 @cindex UDP
2027 When that is done, time has come to actually transport the
2028 packet to the destination computer.  We do this by sending the packet
2029 over an UDP connection to the destination host.  This is called
2030 @emph{encapsulating}, the VPN packet (though now encrypted) is
2031 encapsulated in another IP datagram.
2032
2033 When the destination receives this packet, the same thing happens, only
2034 in reverse.  So it checks the message authentication code, decrypts the contents of the UDP datagram,
2035 checks the sequence number
2036 and writes the decrypted information to its own virtual network device.
2037
2038 If the virtual network device is a `tun' device (a point-to-point tunnel),
2039 there is no problem for the kernel to accept a packet.
2040 However, if it is a `tap' device (this is the only available type on FreeBSD),
2041 the destination MAC address must match that of the virtual network interface.
2042 If tinc is in it's default routing mode, ARP does not work, so the correct destination MAC 
2043 can not be known by the sending host.
2044 Tinc solves this by letting the receiving end detect the MAC address of its own virtual network interface
2045 and overwriting the destination MAC address of the received packet.
2046
2047 In switch or hub modes ARP does work so the sender already knows the correct destination MAC address.
2048 In those modes every interface should have a unique MAC address, so make sure they are not the same.
2049 Because switch and hub modes rely on MAC addresses to function correctly,
2050 these modes cannot be used on the following operating systems which don't have a `tap' style virtual network device:
2051 OpenBSD, NetBSD, Darwin and Solaris.
2052
2053
2054 @c ==================================================================
2055 @node    The meta-connection
2056 @subsection The meta-connection
2057
2058 Having only a UDP connection available is not enough.  Though suitable
2059 for transmitting data, we want to be able to reliably send other
2060 information, such as routing and session key information to somebody.
2061
2062 @cindex TCP
2063 TCP is a better alternative, because it already contains protection
2064 against information being lost, unlike UDP.
2065
2066 So we establish two connections.  One for the encrypted VPN data, and one
2067 for other information, the meta-data.  Hence, we call the second
2068 connection the meta-connection.  We can now be sure that the
2069 meta-information doesn't get lost on the way to another computer.
2070
2071 @cindex data-protocol
2072 @cindex meta-protocol
2073 Like with any communication, we must have a protocol, so that everybody
2074 knows what everything stands for, and how she should react.  Because we
2075 have two connections, we also have two protocols.  The protocol used for
2076 the UDP data is the ``data-protocol,'' the other one is the
2077 ``meta-protocol.''
2078
2079 The reason we don't use TCP for both protocols is that UDP is much
2080 better for encapsulation, even while it is less reliable.  The real
2081 problem is that when TCP would be used to encapsulate a TCP stream
2082 that's on the private network, for every packet sent there would be
2083 three ACKs sent instead of just one.  Furthermore, if there would be
2084 a timeout, both TCP streams would sense the timeout, and both would
2085 start re-sending packets.
2086
2087
2088 @c ==================================================================
2089 @node    The meta-protocol
2090 @section The meta-protocol
2091
2092 The meta protocol is used to tie all tinc daemons together, and
2093 exchange information about which tinc daemon serves which virtual
2094 subnet.
2095
2096 The meta protocol consists of requests that can be sent to the other
2097 side.  Each request has a unique number and several parameters.  All
2098 requests are represented in the standard ASCII character set.  It is
2099 possible to use tools such as telnet or netcat to connect to a tinc
2100 daemon started with the --bypass-security option
2101 and to read and write requests by hand, provided that one
2102 understands the numeric codes sent.
2103
2104 The authentication scheme is described in @ref{Authentication protocol}. After a
2105 successful authentication, the server and the client will exchange all the
2106 information about other tinc daemons and subnets they know of, so that both
2107 sides (and all the other tinc daemons behind them) have their information
2108 synchronised.
2109
2110 @cindex ADD_EDGE
2111 @cindex ADD_SUBNET
2112 @example
2113 message
2114 ------------------------------------------------------------------
2115 ADD_EDGE node1 node2 21.32.43.54 655 222 0
2116           |     |        |       |   |  +-> options
2117           |     |        |       |   +----> weight
2118           |     |        |       +--------> UDP port of node2
2119           |     |        +----------------> real address of node2
2120           |     +-------------------------> name of destination node
2121           +-------------------------------> name of source node
2122
2123 ADD_SUBNET node 192.168.1.0/24
2124             |         |     +--> prefixlength
2125             |         +--------> network address
2126             +------------------> owner of this subnet
2127 ------------------------------------------------------------------
2128 @end example
2129
2130 The ADD_EDGE messages are to inform other tinc daemons that a connection between
2131 two nodes exist. The address of the destination node is available so that
2132 VPN packets can be sent directly to that node.
2133
2134 The ADD_SUBNET messages inform other tinc daemons that certain subnets belong
2135 to certain nodes. tinc will use it to determine to which node a VPN packet has
2136 to be sent.
2137
2138 @cindex DEL_EDGE
2139 @cindex DEL_SUBNET
2140 @example
2141 message
2142 ------------------------------------------------------------------
2143 DEL_EDGE node1 node2
2144            |     +----> name of destination node
2145            +----------> name of source node
2146
2147 DEL_SUBNET node 192.168.1.0/24
2148              |         |     +--> prefixlength
2149              |         +--------> network address
2150              +------------------> owner of this subnet
2151 ------------------------------------------------------------------
2152 @end example
2153
2154 In case a connection between two daemons is closed or broken, DEL_EDGE messages
2155 are sent to inform the other daemons of that fact. Each daemon will calculate a
2156 new route to the the daemons, or mark them unreachable if there isn't any.
2157
2158 @cindex REQ_KEY
2159 @cindex ANS_KEY
2160 @cindex KEY_CHANGED
2161 @example
2162 message
2163 ------------------------------------------------------------------
2164 REQ_KEY origin destination
2165            |       +--> name of the tinc daemon it wants the key from
2166            +----------> name of the daemon that wants the key      
2167
2168 ANS_KEY origin destination 4ae0b0a82d6e0078 91 64 4
2169            |       |       \______________/ |  |  +--> MAC length
2170            |       |               |        |  +-----> digest algorithm
2171            |       |               |        +--------> cipher algorithm
2172            |       |               +--> 128 bits key
2173            |       +--> name of the daemon that wants the key
2174            +----------> name of the daemon that uses this key
2175
2176 KEY_CHANGED origin
2177               +--> daemon that has changed it's packet key
2178 ------------------------------------------------------------------
2179 @end example
2180
2181 The keys used to encrypt VPN packets are not sent out directly. This is
2182 because it would generate a lot of traffic on VPNs with many daemons, and
2183 chances are that not every tinc daemon will ever send a packet to every
2184 other daemon. Instead, if a daemon needs a key it sends a request for it
2185 via the meta connection of the nearest hop in the direction of the
2186 destination.
2187
2188 @cindex PING
2189 @cindex PONG
2190 @example
2191 daemon  message
2192 ------------------------------------------------------------------
2193 origin  PING
2194 dest.   PONG
2195 ------------------------------------------------------------------
2196 @end example
2197
2198 There is also a mechanism to check if hosts are still alive. Since network
2199 failures or a crash can cause a daemon to be killed without properly
2200 shutting down the TCP connection, this is necessary to keep an up to date
2201 connection list. PINGs are sent at regular intervals, except when there
2202 is also some other traffic. A little bit of salt (random data) is added
2203 with each PING and PONG message, to make sure that long sequences of PING/PONG
2204 messages without any other traffic won't result in known plaintext.
2205
2206 This basically covers what is sent over the meta connection by tinc.
2207
2208
2209 @c ==================================================================
2210 @node    Security
2211 @section Security
2212
2213 @cindex TINC
2214 @cindex Cabal
2215 Tinc got its name from ``TINC,'' short for @emph{There Is No Cabal}; the
2216 alleged Cabal was/is an organisation that was said to keep an eye on the
2217 entire Internet.  As this is exactly what you @emph{don't} want, we named
2218 the tinc project after TINC.
2219
2220 @cindex SVPN
2221 But in order to be ``immune'' to eavesdropping, you'll have to encrypt
2222 your data.  Because tinc is a @emph{Secure} VPN (SVPN) daemon, it does
2223 exactly that: encrypt.
2224 Tinc by default uses blowfish encryption with 128 bit keys in CBC mode, 32 bit
2225 sequence numbers and 4 byte long message authentication codes to make sure
2226 eavesdroppers cannot get and cannot change any information at all from the
2227 packets they can intercept. The encryption algorithm and message authentication
2228 algorithm can be changed in the configuration. The length of the message
2229 authentication codes is also adjustable. The length of the key for the
2230 encryption algorithm is always the default length used by OpenSSL.
2231
2232 @menu
2233 * Authentication protocol::
2234 * Encryption of network packets::
2235 * Security issues::
2236 @end menu
2237
2238
2239 @c ==================================================================
2240 @node       Authentication protocol
2241 @subsection Authentication protocol
2242
2243 @cindex authentication
2244 A new scheme for authentication in tinc has been devised, which offers some
2245 improvements over the protocol used in 1.0pre2 and 1.0pre3. Explanation is
2246 below.
2247
2248 @cindex ID
2249 @cindex META_KEY
2250 @cindex CHALLENGE
2251 @cindex CHAL_REPLY
2252 @cindex ACK
2253 @example
2254 daemon  message
2255 --------------------------------------------------------------------------
2256 client  <attempts connection>
2257
2258 server  <accepts connection>
2259
2260 client  ID client 12
2261               |   +---> version
2262               +-------> name of tinc daemon
2263
2264 server  ID server 12
2265               |   +---> version
2266               +-------> name of tinc daemon
2267
2268 client  META_KEY 5f0823a93e35b69e...7086ec7866ce582b
2269                  \_________________________________/
2270                                  +-> RSAKEYLEN bits totally random string S1,
2271                                      encrypted with server's public RSA key
2272
2273 server  META_KEY 6ab9c1640388f8f0...45d1a07f8a672630
2274                  \_________________________________/
2275                                  +-> RSAKEYLEN bits totally random string S2,
2276                                      encrypted with client's public RSA key
2277
2278 From now on:
2279  - the client will symmetrically encrypt outgoing traffic using S1
2280  - the server will symmetrically encrypt outgoing traffic using S2
2281
2282 client  CHALLENGE da02add1817c1920989ba6ae2a49cecbda0
2283                   \_________________________________/
2284                                  +-> CHALLEN bits totally random string H1
2285
2286 server  CHALLENGE 57fb4b2ccd70d6bb35a64c142f47e61d57f
2287                   \_________________________________/
2288                                  +-> CHALLEN bits totally random string H2
2289
2290 client  CHAL_REPLY 816a86
2291                       +-> 160 bits SHA1 of H2
2292
2293 server  CHAL_REPLY 928ffe
2294                       +-> 160 bits SHA1 of H1
2295
2296 After the correct challenge replies are received, both ends have proved
2297 their identity. Further information is exchanged.
2298
2299 client  ACK 655 123 0
2300              |   |  +-> options
2301                  |   +----> estimated weight
2302                  +--------> listening port of client
2303
2304 server  ACK 655 321 0
2305              |   |  +-> options
2306                  |   +----> estimated weight
2307                  +--------> listening port of server
2308 --------------------------------------------------------------------------
2309 @end example
2310
2311 This new scheme has several improvements, both in efficiency and security.
2312
2313 First of all, the server sends exactly the same kind of messages over the wire
2314 as the client. The previous versions of tinc first authenticated the client,
2315 and then the server. This scheme even allows both sides to send their messages
2316 simultaneously, there is no need to wait for the other to send something first.
2317 This means that any calculations that need to be done upon sending or receiving
2318 a message can also be done in parallel. This is especially important when doing
2319 RSA encryption/decryption. Given that these calculations are the main part of
2320 the CPU time spent for the authentication, speed is improved by a factor 2.
2321
2322 Second, only one RSA encrypted message is sent instead of two. This reduces the
2323 amount of information attackers can see (and thus use for a cryptographic
2324 attack). It also improves speed by a factor two, making the total speedup a
2325 factor 4.
2326
2327 Third, and most important:
2328 The symmetric cipher keys are exchanged first, the challenge is done
2329 afterwards. In the previous authentication scheme, because a man-in-the-middle
2330 could pass the challenge/chal_reply phase (by just copying the messages between
2331 the two real tinc daemons), but no information was exchanged that was really
2332 needed to read the rest of the messages, the challenge/chal_reply phase was of
2333 no real use. The man-in-the-middle was only stopped by the fact that only after
2334 the ACK messages were encrypted with the symmetric cipher. Potentially, it
2335 could even send it's own symmetric key to the server (if it knew the server's
2336 public key) and read some of the metadata the server would send it (it was
2337 impossible for the mitm to read actual network packets though). The new scheme
2338 however prevents this.
2339
2340 This new scheme makes sure that first of all, symmetric keys are exchanged. The
2341 rest of the messages are then encrypted with the symmetric cipher. Then, each
2342 side can only read received messages if they have their private key. The
2343 challenge is there to let the other side know that the private key is really
2344 known, because a challenge reply can only be sent back if the challenge is
2345 decrypted correctly, and that can only be done with knowledge of the private
2346 key.
2347
2348 Fourth: the first thing that is sent via the symmetric cipher encrypted
2349 connection is a totally random string, so that there is no known plaintext (for
2350 an attacker) in the beginning of the encrypted stream.
2351
2352
2353 @c ==================================================================
2354 @node       Encryption of network packets
2355 @subsection Encryption of network packets
2356 @cindex encryption
2357
2358 A data packet can only be sent if the encryption key is known to both
2359 parties, and the connection is  activated. If the encryption key is not
2360 known, a request is sent to the destination using the meta connection
2361 to retrieve it. The packet is stored in a queue while waiting for the
2362 key to arrive.
2363
2364 @cindex UDP
2365 The UDP packet containing the network packet from the VPN has the following layout:
2366
2367 @example
2368 ... | IP header | UDP header | seqno | VPN packet | MAC | UDP trailer
2369                              \___________________/\_____/
2370                                        |             |
2371                                        V             +---> digest algorithm
2372                          Encrypted with symmetric cipher
2373 @end example
2374
2375 So, the entire VPN packet is encrypted using a symmetric cipher, including a 32 bits
2376 sequence number that is added in front of the actual VPN packet, to act as a unique
2377 IV for each packet and to prevent replay attacks. A message authentication code
2378 is added to the UDP packet to prevent alteration of packets. By default the
2379 first 4 bytes of the digest are used for this, but this can be changed using
2380 the MACLength configuration variable.
2381
2382 @c ==================================================================
2383 @node    Security issues
2384 @subsection Security issues
2385
2386 In August 2000, we discovered the existence of a security hole in all versions
2387 of tinc up to and including 1.0pre2. This had to do with the way we exchanged
2388 keys. Since then, we have been working on a new authentication scheme to make
2389 tinc as secure as possible. The current version uses the OpenSSL library and
2390 uses strong authentication with RSA keys.
2391
2392 On the 29th of December 2001, Jerome Etienne posted a security analysis of tinc
2393 1.0pre4. Due to a lack of sequence numbers and a message authentication code
2394 for each packet, an attacker could possibly disrupt certain network services or
2395 launch a denial of service attack by replaying intercepted packets. The current
2396 version adds sequence numbers and message authentication codes to prevent such
2397 attacks.
2398
2399 On the 15th of September 2003, Peter Gutmann posted a security analysis of tinc
2400 1.0.1. He argues that the 32 bit sequence number used by tinc is not a good IV,
2401 that tinc's default length of 4 bytes for the MAC is too short, and he doesn't
2402 like tinc's use of RSA during authentication. We do not know of a security hole
2403 in this version of tinc, but tinc's security is not as strong as TLS or IPsec.
2404 We will address these issues in tinc 2.0.
2405
2406 Cryptography is a hard thing to get right. We cannot make any
2407 guarantees. Time, review and feedback are the only things that can
2408 prove the security of any cryptographic product. If you wish to review
2409 tinc or give us feedback, you are stronly encouraged to do so.
2410
2411
2412 @c ==================================================================
2413 @node    Platform specific information
2414 @chapter Platform specific information
2415
2416 @menu
2417 * Interface configuration::
2418 * Routes::
2419 @end menu
2420
2421 @c ==================================================================
2422 @node    Interface configuration
2423 @section Interface configuration
2424
2425 When configuring an interface, one normally assigns it an address and a
2426 netmask.  The address uniquely identifies the host on the network attached to
2427 the interface.  The netmask, combined with the address, forms a subnet.  It is
2428 used to add a route to the routing table instructing the kernel to send all
2429 packets which fall into that subnet to that interface.  Because all packets for
2430 the entire VPN should go to the virtual network interface used by tinc, the
2431 netmask should be such that it encompasses the entire VPN.
2432
2433 For IPv4 addresses:
2434
2435 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
2436 @item Linux
2437 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
2438 @item Linux iproute2
2439 @tab @code{ip addr add} @var{address}@code{/}@var{prefixlength} @code{dev} @var{interface}
2440 @item FreeBSD
2441 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
2442 @item OpenBSD
2443 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
2444 @item NetBSD
2445 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
2446 @item Solaris
2447 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
2448 @item Darwin (MacOS/X)
2449 @tab @code{ifconfig} @var{interface} @var{address} @code{netmask} @var{netmask}
2450 @item Windows
2451 @tab @code{netsh interface ip set address} @var{interface} @code{static} @var{address} @var{netmask}
2452 @end multitable
2453
2454 For IPv6 addresses:
2455
2456 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
2457 @item Linux
2458 @tab @code{ifconfig} @var{interface} @code{add} @var{address}@code{/}@var{prefixlength}
2459 @item FreeBSD
2460 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
2461 @item OpenBSD
2462 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
2463 @item NetBSD
2464 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
2465 @item Solaris
2466 @tab @code{ifconfig} @var{interface} @code{inet6 plumb up}
2467 @item
2468 @tab @code{ifconfig} @var{interface} @code{inet6 addif} @var{address} @var{address}
2469 @item Darwin (MacOS/X)
2470 @tab @code{ifconfig} @var{interface} @code{inet6} @var{address} @code{prefixlen} @var{prefixlength}
2471 @item Windows
2472 @tab @code{netsh interface ipv6 add address} @var{interface} @code{static} @var{address}/@var{prefixlength}
2473 @end multitable
2474
2475 On some platforms, when running tinc in switch mode, the VPN interface must be set to tap mode with an ifconfig command:
2476
2477 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
2478 @item OpenBSD
2479 @tab @code{ifconfig} @var{interface} @code{link0}
2480 @end multitable
2481
2482 On Linux, it is possible to create a persistent tun/tap interface which will
2483 continue to exist even if tinc quit, although this is normally not required.
2484 It can be useful to set up a tun/tap interface owned by a non-root user, so
2485 tinc can be started without needing any root privileges at all.
2486
2487 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
2488 @item Linux
2489 @tab @code{ip tuntap add dev} @var{interface} @code{mode} @var{tun|tap} @code{user} @var{username}
2490 @end multitable
2491
2492 @c ==================================================================
2493 @node    Routes
2494 @section Routes
2495
2496 In some cases it might be necessary to add more routes to the virtual network
2497 interface.  There are two ways to indicate which interface a packet should go
2498 to, one is to use the name of the interface itself, another way is to specify
2499 the (local) address that is assigned to that interface (@var{local_address}). The
2500 former way is unambiguous and therefore preferable, but not all platforms
2501 support this.
2502
2503 Adding routes to IPv4 subnets:
2504
2505 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
2506 @item Linux
2507 @tab @code{route add -net} @var{network_address} @code{netmask} @var{netmask} @var{interface}
2508 @item Linux iproute2
2509 @tab @code{ip route add} @var{network_address}@code{/}@var{prefixlength} @code{dev} @var{interface}
2510 @item FreeBSD
2511 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
2512 @item OpenBSD
2513 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
2514 @item NetBSD
2515 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
2516 @item Solaris
2517 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address} @code{-interface}
2518 @item Darwin (MacOS/X)
2519 @tab @code{route add} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
2520 @item Windows
2521 @tab @code{netsh routing ip add persistentroute} @var{network_address} @var{netmask} @var{interface} @var{local_address}
2522 @end multitable
2523
2524 Adding routes to IPv6 subnets:
2525
2526 @multitable {Darwin (MacOS/X)} {ifconfig route add -bla network address netmask netmask prefixlength interface}
2527 @item Linux
2528 @tab @code{route add -A inet6} @var{network_address}@code{/}@var{prefixlength} @var{interface}
2529 @item Linux iproute2
2530 @tab @code{ip route add} @var{network_address}@code{/}@var{prefixlength} @code{dev} @var{interface}
2531 @item FreeBSD
2532 @tab @code{route add -inet6} @var{network_address}@code{/}@var{prefixlength} @var{local_address}
2533 @item OpenBSD
2534 @tab @code{route add -inet6} @var{network_address} @var{local_address} @code{-prefixlen} @var{prefixlength}
2535 @item NetBSD
2536 @tab @code{route add -inet6} @var{network_address} @var{local_address} @code{-prefixlen} @var{prefixlength}
2537 @item Solaris
2538 @tab @code{route add -inet6} @var{network_address}@code{/}@var{prefixlength} @var{local_address} @code{-interface}
2539 @item Darwin (MacOS/X)
2540 @tab ?
2541 @item Windows
2542 @tab @code{netsh interface ipv6 add route} @var{network address}/@var{prefixlength} @var{interface}
2543 @end multitable
2544
2545
2546 @c ==================================================================
2547 @node    About us
2548 @chapter About us
2549
2550
2551 @menu
2552 * Contact information::
2553 * Authors::
2554 @end menu
2555
2556
2557 @c ==================================================================
2558 @node    Contact information
2559 @section Contact information
2560
2561 @cindex website
2562 Tinc's website is at @url{http://www.tinc-vpn.org/},
2563 this server is located in the Netherlands.
2564
2565 @cindex IRC
2566 We have an IRC channel on the FreeNode and OFTC IRC networks. Connect to
2567 @uref{http://www.freenode.net/, irc.freenode.net}
2568 or
2569 @uref{http://www.oftc.net/, irc.oftc.net}
2570 and join channel #tinc.
2571
2572
2573 @c ==================================================================
2574 @node    Authors
2575 @section Authors
2576
2577 @table @asis
2578 @item Ivo Timmermans (zarq)
2579 @item Guus Sliepen (guus) (@email{guus@@tinc-vpn.org})
2580 @end table
2581
2582 We have received a lot of valuable input from users.  With their help,
2583 tinc has become the flexible and robust tool that it is today.  We have
2584 composed a list of contributions, in the file called @file{THANKS} in
2585 the source distribution.
2586
2587
2588 @c ==================================================================
2589 @node    Concept Index
2590 @unnumbered Concept Index
2591
2592 @c ==================================================================
2593 @printindex cp
2594
2595
2596 @c ==================================================================
2597 @contents
2598 @bye