lagertonne/tinc
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Wiki Activity

Import Upstream version 1.0.9

Browse source
This commit is contained in:
Guus Sliepen 2019-08-26 13:44:38 +02:00
parent 6276954b04
commit 5d002cc66a
41 changed files with 3389 additions and 1210 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/Makefile.in
View file

@ -1,8 +1,8 @@
# Makefile.in generated by automake 1.10 from Makefile.am.
# Makefile.in generated by automake 1.10.1 from Makefile.am.
# @configure_input@
# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
# 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
# 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
# This Makefile.in is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.

BIN
doc/sample-config.tar.gz
View file

Binary file not shown.

2016
doc/texinfo.tex
View file

File diff suppressed because it is too large Load diff

121
doc/tinc.conf.5.in
View file

@ -1,21 +1,25 @@
.Dd 2002-04-09
.Dd 2008-12-22
.Dt TINC.CONF 5
.\" Manual page created by:
.\" Ivo Timmermans
.\" Guus Sliepen <guus@tinc-vpn.org>
.Sh NAME
.Nm tinc.conf
.Nd tinc daemon configuration
.Sh DESCRIPTION
The files in the
.Pa @sysconfdir@/tinc/
directory contain runtime and security information for the tinc daemon.
.Sh NETWORKS
It is perfectly ok for you to run more than one tinc daemon.
However, in its default form,
you will soon notice that you can't use two different configuration files without the
.Fl c
option.
.Pp
We have thought of another way of dealing with this: network names.
This means that you call
@ -23,6 +27,7 @@ This means that you call
with the
.Fl n
option, which will assign a name to this daemon.
.Pp
The effect of this is that the daemon will set its configuration root to
.Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa / ,
@ -33,6 +38,7 @@ is your argument to the
option.
You'll notice that messages appear in syslog as coming from
.Nm tincd. Ns Ar NETNAME .
.Pp
However, it is not strictly necessary that you call tinc with the
.Fl n
@ -48,21 +54,25 @@ the configuration file should be
.Pa @sysconfdir@/tinc/tinc.conf ,
and the host configuration files are now expected to be in
.Pa @sysconfdir@/tinc/hosts/ .
.Pp
But it is highly recommended that you use this feature of
.Nm tinc ,
because it will be so much clearer whom your daemon talks to.
Hence, we will assume that you use it.
.Sh NAMES
Each tinc daemon should have a name that is unique in the network which it will be part of.
The name will be used by other tinc daemons for identification.
The name has to be declared in the
.Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf
file.
.Pp
To make things easy,
choose something that will give unique and easy to remember names to your tinc daemon(s).
You could try things like hostnames, owner surnames or location names.
.Sh PUBLIC/PRIVATE KEYS
You should use
.Ic tincd -K
@ -81,14 +91,17 @@ The public key should be stored in the host configuration file
.Va NAME
stands for the name of the local tinc daemon (see
.Sx NAMES ) .
.Sh SERVER CONFIGURATION
The server configuration of the daemon is done in the file
.Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf .
This file consists of comments (lines started with a
.Li # )
or assignments in the form of:
.Pp
.Va Variable Li = Ar Value .
.Pp
The variable names are case insensitive, and any spaces, tabs,
newlines and carriage returns are ignored.
@ -96,30 +109,37 @@ Note: it is not required that you put in the
.Li =
sign, but doing so improves readability.
If you leave it out, remember to replace it with at least one space character.
.Pp
Here are all valid variables, listed in alphabetical order.
The default value is given between parentheses.
.Bl -tag -width indent
.It Va AddressFamily Li = ipv4 | ipv6 | any Pq any
This option affects the address family of listening and outgoing sockets.
If
.Qq any
is selected, then depending on the operating system both IPv4 and IPv6 or just
IPv6 listening sockets will be created.
.It Va BindToAddress Li = Ar address Bq experimental
If your computer has more than one IPv4 or IPv6 address,
.Nm tinc
will by default listen on all of them for incoming connections.
It is possible to bind only to a single address with this variable.
.Pp
This option may not work on all platforms.
.It Va BindToInterface Li = Ar interface Bq experimental
If your computer has more than one network interface,
.Nm tinc
will by default listen on all of them for incoming connections.
It is possible to bind only to a single interface with this variable.
.Pp
This option may not work on all platforms.
.It Va ConnectTo Li = Ar name
Specifies which other tinc daemon to connect to on startup.
Multiple
@ -130,12 +150,14 @@ The names should be known to this tinc daemon
(i.e., there should be a host configuration file for the name on the
.Va ConnectTo
line).
.Pp
If you don't specify a host with
.Va ConnectTo ,
.Nm tinc
won't try to connect to other daemons at all,
and will instead just listen for incoming connections.
.It Va Device Li = Ar device Po Pa /dev/tap0 , Pa /dev/net/tun No or other depending on platform Pc
The virtual network device to use.
.Nm tinc
@ -147,6 +169,36 @@ instead of
.Va Device .
The info pages of the tinc package contain more information
about configuring the virtual network device.
.It Va DeviceType Li = tun | tunnohead | tunifhead | tap Po only supported on BSD platforms Pc
The type of the virtual network device.
Tinc will normally automatically select the right type, and this option should not be used.
However, in case tinc does not seem to correctly interpret packets received from the virtual network device,
using this option might help.
.Bl -tag -width indent
.It tun
Set type to tun.
Depending on the platform, this can either be with or without an address family header (see below).
.It tunnohead
Set type to tun without an address family header.
Tinc will expect packets read from the virtual network device to start with an IP header.
On some platforms IPv6 packets cannot be read from or written to the device in this mode.
.It tunifhead
Set type to tun with an address family header.
Tinc will expect packets read from the virtual network device
to start with a four byte header containing the address family,
followed by an IP header.
This mode should support both IPv4 and IPv6 packets.
.It tap
Set type to tap.
Tinc will expect packets read from the virtual network device
to start with an Ethernet header.
.El
.It Va GraphDumpFile Li = Ar filename Bq experimental
If this option is present,
.Nm tinc
@ -159,14 +211,17 @@ If
starts with a pipe symbol |,
then the rest of the filename is interpreted as a shell command
that is executed, the graph is then sent to stdin.
.It Va Hostnames Li = yes | no Pq no
This option selects whether IP addresses (both real and on the VPN) should
be resolved. Since DNS lookups are blocking, it might affect tinc's
efficiency, even stopping the daemon for a few seconds every time it does
a lookup if your DNS server is not responding.
.Pp
This does not affect resolving hostnames to IP addresses from the
host configuration files.
.It Va Interface Li = Ar interface
Defines the name of the interface corresponding to the virtual network device.
Depending on the operating system and the type of device this may or may not actually set the name of the interface.
@ -174,58 +229,73 @@ Under Windows, this variable is used to select which network interface will be u
If you specified a
.Va Device ,
this variable is almost always already correctly set.
.It Va KeyExpire Li = Ar seconds Pq 3600
This option controls the period the encryption keys used to encrypt the data are valid.
It is common practice to change keys at regular intervals to make it even harder for crackers,
even though it is thought to be nearly impossible to crack a single key.
.It Va MACExpire Li = Ar seconds Pq 600
This option controls the amount of time MAC addresses are kept before they are removed.
This only has effect when
.Va Mode
is set to
.Qq switch .
.It Va MaxTimeout Li = Ar seconds Pq 900
This is the maximum delay before trying to reconnect to other tinc daemons.
.It Va Mode Li = router | switch | hub Pq router
This option selects the way packets are routed to other daemons.
.Bl -tag -width indent
.It router
In this mode
.Va Subnet
variables in the host configuration files will be used to form a routing table.
Only unicast packets of routable protocols (IPv4 and IPv6) are supported in this mode.
.Pp
This is the default mode, and unless you really know you need another mode, don't change it.
.It switch
In this mode the MAC addresses of the packets on the VPN will be used to
dynamically create a routing table just like an Ethernet switch does.
Unicast, multicast and broadcast packets of every protocol that runs over Ethernet are supported in this mode
at the cost of frequent broadcast ARP requests and routing table updates.
.Pp
This mode is primarily useful if you want to bridge Ethernet segments.
.It hub
This mode is almost the same as the switch mode, but instead
every packet will be broadcast to the other daemons
while no routing table is managed.
.El
.It Va Name Li = Ar name Bq required
This is the name which identifies this tinc daemon.
It must be unique for the virtual private network this daemon will connect to.
.It Va PingInterval Li = Ar seconds Pq 60
The number of seconds of inactivity that
.Nm tinc
will wait before sending a probe to the other end.
.It Va PingTimeout Li = Ar seconds Pq 5
The number of seconds to wait for a response to pings or to allow meta
connections to block. If the other end doesn't respond within this time,
the connection is terminated,
and the others will be notified of this.
.It Va PriorityInheritance Li = yes | no Po no Pc Bq experimental
When this option is enabled the value of the TOS field of tunneled IPv4 packets
will be inherited by the UDP packets that are sent out.
.It Va PrivateKey Li = Ar key Bq obsolete
The private RSA key of this tinc daemon.
It will allow this tinc daemon to authenticate itself to other daemons.
.It Va PrivateKeyFile Li = Ar filename Po Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /rsa_key.priv Pc
The file in which the private RSA key of this tinc daemon resides.
Note that there must be exactly one of
@ -233,17 +303,20 @@ Note that there must be exactly one of
or
.Va PrivateKeyFile
specified in the configuration file.
.It Va TunnelServer Li = yes | no Po no Pc Bq experimental
When this option is enabled tinc will no longer forward information between other tinc daemons,
and will only allow nodes and subnets on the VPN which are present in the
.Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/
directory.
.El
.Sh HOST CONFIGURATION FILES
The host configuration files contain all information needed
to establish a connection to those hosts.
A host configuration file is also required for the local tinc daemon,
it will use it to read in it's listen port, public key and subnets.
.Pp
The idea is that these files are portable.
You can safely mail your own host configuration file to someone else.
@ -252,6 +325,7 @@ and now his tinc daemon will be able to connect to your tinc daemon.
Since host configuration files only contain public keys,
no secrets are revealed by sending out this information.
.Bl -tag -width indent
.It Va Address Li = Ar address Bq recommended
The IP address or hostname of this tinc daemon on the real network.
This will only be used when trying to make an outgoing connection to this tinc daemon.
@ -259,6 +333,7 @@ Multiple
.Va Address
variables can be specified, in which case each address will be tried until a working
connection has been established.
.It Va Cipher Li = Ar cipher Pq blowfish
The symmetric cipher algorithm used to encrypt UDP packets.
Any cipher supported by OpenSSL is recognised.
@ -266,16 +341,19 @@ Furthermore, specifying
.Qq none
will turn off packet encryption.
It is best to use only those ciphers which support CBC mode.
.It Va Compression Li = Ar level Pq 0
This option sets the level of compression used for UDP packets.
Possible values are 0 (off), 1 (fast zlib) and any integer up to 9 (best zlib),
10 (fast lzo) and 11 (best lzo).
.It Va Digest Li = Ar digest Pq sha1
The digest algorithm used to authenticate UDP packets.
Any digest supported by OpenSSL is recognised.
Furthermore, specifying
.Qq none
will turn off packet authentication.
.It Va IndirectData Li = yes | no Pq no
This option specifies whether other tinc daemons besides the one you specified with
.Va ConnectTo
@ -283,23 +361,30 @@ can make a direct connection to you.
This is especially useful if you are behind a firewall
and it is impossible to make a connection from the outside to your tinc daemon.
Otherwise, it is best to leave this option out or set it to no.
.It Va MACLength Li = Ar length Pq 4
The length of the message authentication code used to authenticate UDP packets.
Can be anything from
.Qq 0
up to the length of the digest produced by the digest algorithm.
.It Va PMTU Li = Ar mtu Po 1514 Pc Bq experimental
.It Va PMTU Li = Ar mtu Po 1514 Pc
This option controls the initial path MTU to this node.
.It Va PMTUDiscovery Li = yes | no Po no Pc Bq experimental
.It Va PMTUDiscovery Li = yes | no Po yes Pc
When this option is enabled, tinc will try to discover the path MTU to this node.
After the path MTU has been discovered, it will be enforced on the VPN.
.It Va Port Li = Ar port Pq 655
The port number on which this tinc daemon is listening for incoming connections.
.It Va PublicKey Li = Ar key Bq obsolete
The public RSA key of this tinc daemon.
It will be used to cryptographically verify it's identity and to set up a secure connection.
.It Va PublicKeyFile Li = Ar filename Bq obsolete
The file in which the public RSA key of this tinc daemon resides.
.Pp
From version 1.0pre4 on
.Nm tinc
@ -308,6 +393,7 @@ the above two options then are not necessary.
Either the PEM format is used, or exactly one of the above two options must be specified
in each host configuration file,
if you want to be able to establish a connection with that host.
.It Va Subnet Li = Ar address Ns Op Li / Ns Ar prefixlength
The subnet which this tinc daemon will serve.
.Nm tinc
@ -317,6 +403,7 @@ it will be sent to the daemon who has this subnet in his host configuration file
Multiple
.Va Subnet
variables can be specified.
.Pp
Subnets can either be single MAC, IPv4 or IPv6 addresses,
in which case a subnet consisting of only that single address is assumed,
@ -328,6 +415,7 @@ Note that subnets like 192.168.1.1/24 are invalid!
Read a networking HOWTO/FAQ/guide if you don't understand this.
IPv6 subnets are notated like fec0:0:0:1:0:0:0:0/64.
MAC addresses are notated like 0:1a:2b:3c:4d:5e.
.It Va TCPOnly Li = yes | no Pq no
If this variable is set to yes,
then the packets are tunnelled over the TCP connection instead of a UDP connection.
@ -336,38 +424,48 @@ from behind a masquerading firewall,
or if UDP packet routing is disabled somehow.
Setting this options also implicitly sets IndirectData.
.El
.Sh SCRIPTS
Apart from reading the server and host configuration files,
tinc can also run scripts at certain moments.
Under Windows (not Cygwin), the scripts should have the extension
.Pa .bat .
.Bl -tag -width indent
.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-up
This is the most important script.
If it is present it will be executed right after the tinc daemon has been started and has connected to the virtual network device.
It should be used to set up the corresponding network interface,
but can also be used to start other things.
Under Windows you can use the Network Connections control panel instead of creating this script.
.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
This script is started right before the tinc daemon quits.
.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar HOST Ns Pa -up
This script is started when the tinc daemon with name
.Ar HOST
becomes reachable.
.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar HOST Ns Pa -down
This script is started when the tinc daemon with name
.Ar HOST
becomes unreachable.
.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /host-up
This script is started when any host becomes reachable.
.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /host-down
This script is started when any host becomes unreachable.
.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /subnet-up
This script is started when a Subnet becomes reachable.
The Subnet and the node it belongs to are passed in environment variables.
.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /subnet-down
This script is started when a Subnet becomes unreachable.
.El
.Pp
The scripts are started without command line arguments, but can make use of certain environment variables.
Under UNIX like operating systems the names of environment variables must be preceded by a
@ -379,49 +477,65 @@ files, they have to be put between
.Li %
signs.
.Bl -tag -width indent
.It Ev NETNAME
If a netname was specified, this environment variable contains it.
.It Ev NAME
Contains the name of this tinc daemon.
.It Ev DEVICE
Contains the name of the virtual network device that tinc uses.
.It Ev INTERFACE
Contains the name of the virtual network interface that tinc uses.
This should be used for commands like
.Pa ifconfig .
.It Ev NODE
When a host becomes (un)reachable, this is set to its name.
If a subnet becomes (un)reachable, this is set to the owner of that subnet.
.It Ev REMOTEADDRESS
When a host becomes (un)reachable, this is set to its real address.
.It Ev REMOTEPORT
When a host becomes (un)reachable, this is set to the port number it uses for communication with other tinc daemons.
.It Ev SUBNET
When a subnet becomes (un)reachable, this is set to the subnet.
.El
.Sh FILES
The most important files are:
.Bl -tag -width indent
.It Pa @sysconfdir@/tinc/
The top directory for configuration files.
.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf
The default name of the server configuration file for net
.Ar NETNAME .
.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/
Host configuration files are kept in this directory.
.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-up
If an executable file with this name exists,
it will be executed right after the tinc daemon has connected to the virtual network device.
It can be used to set up the corresponding network interface.
.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
If an executable file with this name exists,
it will be executed right before the tinc daemon is going to close
its connection to the virtual network device.
.El
.Sh SEE ALSO
.Xr tincd 8 ,
.Pa http://www.tinc-vpn.org/ ,
.Pa http://www.linuxdoc.org/LDP/nag2/ .
.Pp
The full documentation for
.Nm tinc
@ -429,6 +543,7 @@ is maintained as a Texinfo manual.
If the info and tinc programs are properly installed at your site, the command
.Ic info tinc
should give you access to the complete manual.
.Pp
.Nm tinc
comes with ABSOLUTELY NO WARRANTY.

348
doc/tinc.info
View file

@ -1,17 +1,17 @@
This is tinc.info, produced by makeinfo version 4.8 from tinc.texi.
This is tinc.info, produced by makeinfo version 4.11 from tinc.texi.
INFO-DIR-SECTION Networking tools
START-INFO-DIR-ENTRY
* tinc: (tinc). The tinc Manual.
END-INFO-DIR-ENTRY
This is the info manual for tinc version 1.0.8, a Virtual Private
This is the info manual for tinc version 1.0.9, a Virtual Private
Network daemon.
Copyright (C) 1998-2006 Ivo Timmermans, Guus Sliepen
Copyright (C) 1998-2008 Ivo Timmermans, Guus Sliepen
<guus@tinc-vpn.org> and Wessel Dankers <wsl@tinc-vpn.org>.
$Id: tinc.texi 1467 2006-11-11 20:37:58Z guus $
$Id: tinc.texi 1597 2008-12-22 21:29:21Z guus $
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
@ -173,8 +173,7 @@ File: tinc.info, Node: Configuring the kernel, Next: Libraries, Up: Preparati
* Menu:
* Configuration of Linux kernels 2.1.60 up to 2.4.0::
* Configuration of Linux kernels 2.4.0 and higher::
* Configuration of Linux kernels::
* Configuration of FreeBSD kernels::
* Configuration of OpenBSD kernels::
* Configuration of NetBSD kernels::
@ -183,53 +182,14 @@ File: tinc.info, Node: Configuring the kernel, Next: Libraries, Up: Preparati
* Configuration of Windows::

File: tinc.info, Node: Configuration of Linux kernels 2.1.60 up to 2.4.0, Next: Configuration of Linux kernels 2.4.0 and higher, Up: Configuring the kernel
File: tinc.info, Node: Configuration of Linux kernels, Next: Configuration of FreeBSD kernels, Up: Configuring the kernel
2.1.1 Configuration of Linux kernels 2.1.60 up to 2.4.0
-------------------------------------------------------
2.1.1 Configuration of Linux kernels
------------------------------------
For kernels up to 2.4.0, you need a kernel that supports the ethertap
For tinc to work, you need a kernel that supports the Universal tun/tap
device. Most distributions come with kernels that already support this.
If not, here are the options you have to turn on when configuring a new
kernel:
Code maturity level options
[*] Prompt for development and/or incomplete code/drivers
Networking options
[*] Kernel/User netlink socket
<M> Netlink device emulation
Network device support
<M> Ethertap network tap
If you want to run more than one instance of tinc or other programs
that use the ethertap, you have to compile the ethertap driver as a
module, otherwise you can also choose to compile it directly into the
kernel.
If you decide to build any of these as dynamic kernel modules, it's
a good idea to add these lines to `/etc/modules.conf':
alias char-major-36 netlink_dev
alias tap0 ethertap
options tap0 -o tap0 unit=0
alias tap1 ethertap
options tap1 -o tap1 unit=1
...
alias tap_N_ ethertap
options tap_N_ -o tap_N_ unit=_N_
Add as much alias/options lines as necessary.

File: tinc.info, Node: Configuration of Linux kernels 2.4.0 and higher, Next: Configuration of FreeBSD kernels, Prev: Configuration of Linux kernels 2.1.60 up to 2.4.0, Up: Configuring the kernel
2.1.2 Configuration of Linux kernels 2.4.0 and higher
-----------------------------------------------------
For kernels 2.4.0 and higher, you need a kernel that supports the
Universal tun/tap device. Most distributions come with kernels that
already support this. Here are the options you have to turn on when
configuring a new kernel:
Here are the options you have to turn on when configuring a new kernel:
Code maturity level options
[*] Prompt for development and/or incomplete code/drivers
@ -239,20 +199,15 @@ configuring a new kernel:
It's not necessary to compile this driver as a module, even if you
are going to run more than one instance of tinc.
If you have an early 2.4 kernel, you can choose both the tun/tap
driver and the `Ethertap network tap' device. This latter is marked
obsolete, and chances are that it won't even function correctly
anymore. Make sure you select the universal tun/tap driver.
If you decide to build the tun/tap driver as a kernel module, add
these lines to `/etc/modules.conf':
alias char-major-10-200 tun

File: tinc.info, Node: Configuration of FreeBSD kernels, Next: Configuration of OpenBSD kernels, Prev: Configuration of Linux kernels 2.4.0 and higher, Up: Configuring the kernel
File: tinc.info, Node: Configuration of FreeBSD kernels, Next: Configuration of OpenBSD kernels, Prev: Configuration of Linux kernels, Up: Configuring the kernel
2.1.3 Configuration of FreeBSD kernels
2.1.2 Configuration of FreeBSD kernels
--------------------------------------
For FreeBSD version 4.1 and higher, tun and tap drivers are included in
@ -261,18 +216,20 @@ the default kernel configuration. Using tap devices is recommended.

File: tinc.info, Node: Configuration of OpenBSD kernels, Next: Configuration of NetBSD kernels, Prev: Configuration of FreeBSD kernels, Up: Configuring the kernel
2.1.4 Configuration of OpenBSD kernels
2.1.3 Configuration of OpenBSD kernels
--------------------------------------
For OpenBSD version 2.9 and higher, the tun driver is included in the
default kernel configuration. There is also a kernel patch from
`http://diehard.n-r-g.com/stuff/openbsd/' which adds a tap device to
OpenBSD. This should work with tinc.
OpenBSD which should work with tinc, but with recent versions of
OpenBSD, a tun device can act as a tap device by setting the link0
option with ifconfig.

File: tinc.info, Node: Configuration of NetBSD kernels, Next: Configuration of Solaris kernels, Prev: Configuration of OpenBSD kernels, Up: Configuring the kernel
2.1.5 Configuration of NetBSD kernels
2.1.4 Configuration of NetBSD kernels
-------------------------------------
For NetBSD version 1.5.2 and higher, the tun driver is included in the
@ -283,7 +240,7 @@ default kernel configuration.

File: tinc.info, Node: Configuration of Solaris kernels, Next: Configuration of Darwin (MacOS/X) kernels, Prev: Configuration of NetBSD kernels, Up: Configuring the kernel
2.1.6 Configuration of Solaris kernels
2.1.5 Configuration of Solaris kernels
--------------------------------------
For Solaris 8 (SunOS 5.8) and higher, the tun driver may or may not be
@ -296,7 +253,7 @@ header file is missing, install it from the source package.

File: tinc.info, Node: Configuration of Darwin (MacOS/X) kernels, Next: Configuration of Windows, Prev: Configuration of Solaris kernels, Up: Configuring the kernel
2.1.7 Configuration of Darwin (MacOS/X) kernels
2.1.6 Configuration of Darwin (MacOS/X) kernels
-----------------------------------------------
Tinc on Darwin relies on a tunnel driver for its data acquisition from
@ -312,7 +269,7 @@ with the following command:

File: tinc.info, Node: Configuration of Windows, Prev: Configuration of Darwin (MacOS/X) kernels, Up: Configuring the kernel
2.1.8 Configuration of Windows
2.1.7 Configuration of Windows
------------------------------
You will need to install the latest TAP-Win32 driver from OpenVPN. You
@ -550,35 +507,13 @@ File: tinc.info, Node: Device files, Next: Other files, Up: System files
3.2.1 Device files
------------------
First, you'll need the special device file(s) that form the interface
between the kernel and the daemon.
Most operating systems nowadays come with the necessary device files by
default, or they have a mechanism to create them on demand.
The permissions for these files have to be such that only the super
user may read/write to this file. You'd want this, because otherwise
eavesdropping would become a bit too easy. This does, however, imply
that you'd have to run tincd as root.
If you use Linux and do not have udev installed, you may need to
create the following device file if it does not exist:
If you use Linux and have a kernel version prior to 2.4.0, you have
to make the ethertap devices:
mknod -m 600 /dev/tap0 c 36 16
mknod -m 600 /dev/tap1 c 36 17
...
mknod -m 600 /dev/tap_N_ c 36 _N+16_
There is a maximum of 16 ethertap devices.
If you use the universal tun/tap driver, you have to create the
following device file (unless it already exist):
mknod -m 600 /dev/tun c 10 200
If you use Linux, and you run the new 2.4 kernel using the devfs
filesystem, then the tun/tap device will probably be automatically
generated as `/dev/net/tun'.
Unlike the ethertap device, you do not need multiple device files if
you are planning to run multiple tinc daemons.
mknod -m 600 /dev/net/tun c 10 200

File: tinc.info, Node: Other files, Prev: Device files, Up: System files
@ -774,9 +709,37 @@ Device = <DEVICE> (`/dev/tap0', `/dev/net/tun' or other depending on platform)
The virtual network device to use. Tinc will automatically detect
what kind of device it is. Note that you can only use one device
per daemon. Under Windows, use INTERFACE instead of DEVICE. Note
that you can only use one device per daemon. See also *Note
that you can only use one device per daemon. See also *note
Device files::.
DeviceType = <tun|tunnohead|tunifhead|tap> (only supported on BSD platforms)
The type of the virtual network device. Tinc will normally
automatically select the right type, and this option should not be
used. However, in case tinc does not seem to correctly interpret
packets received from the virtual network device, using this
option might help.
tun
Set type to tun. Depending on the platform, this can either
be with or without an address family header (see below).
tunnohead
Set type to tun without an address family header. Tinc will
expect packets read from the virtual network device to start
with an IP header. On some platforms IPv6 packets cannot be
read from or written to the device in this mode.
tunifhead
Set type to tun with an address family header. Tinc will
expect packets read from the virtual network device to start
with a four byte header containing the address family,
followed by an IP header. This mode should support both IPv4
and IPv6 packets.
tap
Set type to tap. Tinc will expect packets read from the
virtual network device to start with an Ethernet header.
GraphDumpFile = <FILENAME> [experimental]
If this option is present, tinc will dump the current network
graph to the file FILENAME every minute, unless there were no
@ -843,7 +806,9 @@ MACExpire = <SECONDS> (600)
"switch".
Name = <NAME> [required]
This is a symbolic name for this connection. It can be anything
This is a symbolic name for this connection. The name should
consist only of alfanumeric and underscore characters (a-z, A-Z,
0-9 and _).
PingInterval = <SECONDS> (60)
The number of seconds of inactivity that tinc will wait before
@ -921,6 +886,14 @@ MACLength = <BYTES> (4)
UDP packets. Can be anything from 0 up to the length of the
digest produced by the digest algorithm.
PMTU = <MTU> (1514)
This option controls the initial path MTU to this node.
PMTUDiscovery = <yes|no> (yes)
When this option is enabled, tinc will try to discover the path
MTU to this node. After the path MTU has been discovered, it will
be enforced on the VPN.
Port = <PORT> (655)
This is the port this tinc daemon listens on. You can use decimal
portnumbers or symbolic names (as listed in `/etc/services').
@ -963,7 +936,7 @@ Subnet = <ADDRESS[/PREFIXLENGTH]>
becomes /22. This conforms to standard CIDR notation as described
in RFC1519 (ftp://ftp.isi.edu/in-notes/rfc1519.txt)
TCPonly = <yes|no> (no) [experimental]
TCPonly = <yes|no> (no)
If this variable is set to yes, then the packets are tunnelled
over a TCP connection instead of a UDP connection. This is
especially useful for those who want to run a tinc daemon from
@ -1140,7 +1113,7 @@ subnet.
The exact syntax of the ifconfig and route commands differs from
platform to platform. You can look up the commands for setting
addresses and adding routes in *Note Platform specific information::,
addresses and adding routes in *note Platform specific information::,
but it is best to consult the manpages of those utilities on your
platform.
@ -1618,7 +1591,7 @@ File: tinc.info, Node: Sending bug reports, Prev: Error messages, Up: Running
=======================
If you really can't find the cause of a problem, or if you suspect tinc
is not working right, you can send us a bugreport, see *Note Contact
is not working right, you can send us a bugreport, see *note Contact
information::. Be sure to include the following information in your
bugreport:
@ -1774,7 +1747,7 @@ possible to use tools such as telnet or netcat to connect to a tinc
daemon started with the -bypass-security option and to read and write
requests by hand, provided that one understands the numeric codes sent.
The authentication scheme is described in *Note Authentication
The authentication scheme is described in *note Authentication
protocol::. After a successful authentication, the server and the
client will exchange all the information about other tinc daemons and
subnets they know of, so that both sides (and all the other tinc
@ -2219,7 +2192,7 @@ Concept Index
* CHALLENGE: Authentication protocol.
(line 10)
* CIDR notation: Host configuration variables.
(line 77)
(line 85)
* Cipher: Host configuration variables.
(line 11)
* client: How connections work.
@ -2240,51 +2213,51 @@ Concept Index
* Device: Main configuration variables.
(line 38)
* device files: Device files. (line 6)
* DeviceType: Main configuration variables.
(line 45)
* Digest: Host configuration variables.
(line 22)
* encapsulating: The UDP tunnel. (line 30)
* encryption: Encryption of network packets.
(line 6)
* environment variables: Scripts. (line 43)
* ethertap: Configuration of Linux kernels 2.1.60 up to 2.4.0.
(line 6)
* example: Example configuration.
(line 6)
* frame type: The UDP tunnel. (line 6)
* GraphDumpFile: Main configuration variables.
(line 45)
(line 73)
* Hostnames: Main configuration variables.
(line 53)
(line 81)
* hub: Main configuration variables.
(line 94)
(line 122)
* ID: Authentication protocol.
(line 10)
* IndirectData: Host configuration variables.
(line 27)
* INTERFACE: Scripts. (line 58)
* Interface: Main configuration variables.
(line 63)
(line 91)
* IRC: Contact information. (line 9)
* key generation: Generating keypairs. (line 6)
* KEY_CHANGED: The meta-protocol. (line 64)
* KeyExpire: Main configuration variables.
(line 99)
(line 127)
* libraries: Libraries. (line 6)
* license: OpenSSL. (line 36)
* lzo: lzo. (line 6)
* MACExpire: Main configuration variables.
(line 105)
(line 133)
* MACLength: Host configuration variables.
(line 35)
* meta-protocol: The meta-connection. (line 18)
* META_KEY: Authentication protocol.
(line 10)
* Mode: Main configuration variables.
(line 71)
(line 99)
* multiple networks: Multiple networks. (line 6)
* NAME: Scripts. (line 52)
* Name: Main configuration variables.
(line 110)
(line 138)
* netmask: Network interfaces. (line 34)
* NETNAME: Scripts. (line 49)
* netname: Multiple networks. (line 6)
@ -2294,36 +2267,40 @@ Concept Index
* OpenSSL: OpenSSL. (line 6)
* options: Runtime options. (line 9)
* PEM format: Host configuration variables.
(line 52)
(line 60)
* PING: The meta-protocol. (line 89)
* PingInterval: Main configuration variables.
(line 113)
(line 143)
* PingTimeout: Main configuration variables.
(line 117)
(line 147)
* platforms: Supported platforms. (line 6)
* PMTU: Host configuration variables.
(line 40)
* PMTUDiscovery: Host configuration variables.
(line 43)
* PONG: The meta-protocol. (line 89)
* Port: Host configuration variables.
(line 40)
(line 48)
* port numbers: Other files. (line 17)
* PriorityInheritance: Main configuration variables.
(line 123)
(line 153)
* private: Virtual Private Networks.
(line 10)
* PrivateKey: Main configuration variables.
(line 128)
(line 158)
* PrivateKeyFile: Main configuration variables.
(line 134)
(line 164)
* PublicKey: Host configuration variables.
(line 44)
(line 52)
* PublicKeyFile: Host configuration variables.
(line 47)
(line 55)
* release: Supported platforms. (line 14)
* REMOTEADDRESS: Scripts. (line 67)
* REMOTEPORT: Scripts. (line 70)
* REQ_KEY: The meta-protocol. (line 64)
* requirements: Libraries. (line 6)
* router: Main configuration variables.
(line 74)
(line 102)
* runtime options: Runtime options. (line 9)
* scalability: tinc. (line 19)
* scripts: Scripts. (line 6)
@ -2332,13 +2309,13 @@ Concept Index
* signals: Signals. (line 6)
* SUBNET: Scripts. (line 74)
* Subnet: Host configuration variables.
(line 59)
(line 67)
* SVPN: Security. (line 11)
* switch: Main configuration variables.
(line 83)
(line 111)
* TCP: The meta-connection. (line 10)
* TCPonly: Host configuration variables.
(line 82)
(line 90)
* TINC: Security. (line 6)
* tinc: Introduction. (line 6)
* tinc-down: Scripts. (line 18)
@ -2346,12 +2323,16 @@ Concept Index
* tinc-up: Scripts. (line 10)
* tincd: tinc. (line 14)
* traditional VPNs: tinc. (line 19)
* tunifhead: Main configuration variables.
(line 62)
* TunnelServer: Main configuration variables.
(line 142)
(line 172)
* tunnohead: Main configuration variables.
(line 56)
* UDP <1>: Encryption of network packets.
(line 12)
* UDP: The UDP tunnel. (line 30)
* Universal tun/tap: Configuration of Linux kernels 2.4.0 and higher.
* Universal tun/tap: Configuration of Linux kernels.
(line 6)
* virtual: Virtual Private Networks.
(line 18)
@ -2365,67 +2346,66 @@ Concept Index

Tag Table:
Node: Top860
Node: Introduction1159
Node: Virtual Private Networks1969
Node: tinc3694
Node: Supported platforms5221
Node: Preparations5919
Node: Configuring the kernel6175
Node: Configuration of Linux kernels 2.1.60 up to 2.4.06655
Node: Configuration of Linux kernels 2.4.0 and higher8027
Node: Configuration of FreeBSD kernels9267
Node: Configuration of OpenBSD kernels9674
Node: Configuration of NetBSD kernels10166
Node: Configuration of Solaris kernels10571
Node: Configuration of Darwin (MacOS/X) kernels11232
Node: Configuration of Windows11935
Node: Libraries12449
Node: OpenSSL12837
Node: zlib15113
Node: lzo15942
Node: Installation16729
Node: Building and installing tinc17744
Node: Darwin (MacOS/X) build environment18403
Node: Cygwin (Windows) build environment18971
Node: MinGW (Windows) build environment19559
Node: System files20083
Node: Device files20348
Node: Other files21534
Node: Configuration22147
Node: Configuration introduction22458
Node: Multiple networks23731
Node: How connections work25157
Node: Configuration files26379
Node: Main configuration variables27386
Node: Host configuration variables33863
Node: Scripts38159
Node: How to configure40838
Node: Generating keypairs42101
Node: Network interfaces42600
Node: Example configuration44448
Node: Running tinc49760
Node: Runtime options50350
Node: Signals52357
Node: Debug levels53426
Node: Solving problems54362
Node: Error messages55792
Node: Sending bug reports60114
Node: Technical information61066
Node: The connection61297
Node: The UDP tunnel61609
Node: The meta-connection64670
Node: The meta-protocol66139
Node: Security71148
Node: Authentication protocol72278
Node: Encryption of network packets77282
Node: Security issues78655
Node: Platform specific information80272
Node: Interface configuration80500
Node: Routes82399
Node: About us84315
Node: Contact information84490
Node: Authors84894
Node: Concept Index85320
Node: Top861
Node: Introduction1160
Node: Virtual Private Networks1970
Node: tinc3695
Node: Supported platforms5222
Node: Preparations5920
Node: Configuring the kernel6176
Node: Configuration of Linux kernels6585
Node: Configuration of FreeBSD kernels7440
Node: Configuration of OpenBSD kernels7830
Node: Configuration of NetBSD kernels8438
Node: Configuration of Solaris kernels8843
Node: Configuration of Darwin (MacOS/X) kernels9504
Node: Configuration of Windows10207
Node: Libraries10721
Node: OpenSSL11109
Node: zlib13385
Node: lzo14214
Node: Installation15001
Node: Building and installing tinc16016
Node: Darwin (MacOS/X) build environment16675
Node: Cygwin (Windows) build environment17243
Node: MinGW (Windows) build environment17831
Node: System files18355
Node: Device files18620
Node: Other files19036
Node: Configuration19649
Node: Configuration introduction19960
Node: Multiple networks21233
Node: How connections work22659
Node: Configuration files23881
Node: Main configuration variables24888
Node: Host configuration variables32721
Node: Scripts37286
Node: How to configure39965
Node: Generating keypairs41228
Node: Network interfaces41727
Node: Example configuration43575
Node: Running tinc48887
Node: Runtime options49477
Node: Signals51484
Node: Debug levels52553
Node: Solving problems53489
Node: Error messages54919
Node: Sending bug reports59241
Node: Technical information60193
Node: The connection60424
Node: The UDP tunnel60736
Node: The meta-connection63797
Node: The meta-protocol65266
Node: Security70275
Node: Authentication protocol71405
Node: Encryption of network packets76409
Node: Security issues77782
Node: Platform specific information79399
Node: Interface configuration79627
Node: Routes81526
Node: About us83442
Node: Contact information83617
Node: Authors84021
Node: Concept Index84447

End Tag Table

148
doc/tinc.texi
View file

@ -1,5 +1,5 @@
\input texinfo @c -*-texinfo-*-
@c $Id: tinc.texi 1467 2006-11-11 20:37:58Z guus $
@c $Id: tinc.texi 1597 2008-12-22 21:29:21Z guus $
@c %**start of header
@setfilename tinc.info
@settitle tinc Manual
@ -16,11 +16,11 @@
This is the info manual for @value{PACKAGE} version @value{VERSION}, a Virtual Private Network daemon.
Copyright @copyright{} 1998-2006 Ivo Timmermans,
Copyright @copyright{} 1998-2008 Ivo Timmermans,
Guus Sliepen <guus@@tinc-vpn.org> and
Wessel Dankers <wsl@@tinc-vpn.org>.
$Id: tinc.texi 1467 2006-11-11 20:37:58Z guus $
$Id: tinc.texi 1597 2008-12-22 21:29:21Z guus $
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
@ -47,7 +47,7 @@ Copyright @copyright{} 1998-2006 Ivo Timmermans,
Guus Sliepen <guus@@tinc-vpn.org> and
Wessel Dankers <wsl@@tinc-vpn.org>.
$Id: tinc.texi 1467 2006-11-11 20:37:58Z guus $
$Id: tinc.texi 1597 2008-12-22 21:29:21Z guus $
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
@ -225,8 +225,7 @@ support tinc.
@section Configuring the kernel
@menu
* Configuration of Linux kernels 2.1.60 up to 2.4.0::
* Configuration of Linux kernels 2.4.0 and higher::
* Configuration of Linux kernels::
* Configuration of FreeBSD kernels::
* Configuration of OpenBSD kernels::
* Configuration of NetBSD kernels::
@ -237,51 +236,11 @@ support tinc.
@c ==================================================================
@node Configuration of Linux kernels 2.1.60 up to 2.4.0
@subsection Configuration of Linux kernels 2.1.60 up to 2.4.0
@cindex ethertap
For kernels up to 2.4.0, you need a kernel that supports the ethertap device.
Most distributions come with kernels that already support this.
If not, here are the options you have to turn on when configuring a new kernel:
@example
Code maturity level options
[*] Prompt for development and/or incomplete code/drivers
Networking options
[*] Kernel/User netlink socket
<M> Netlink device emulation
Network device support
<M> Ethertap network tap
@end example
If you want to run more than one instance of tinc or other programs that use
the ethertap, you have to compile the ethertap driver as a module, otherwise
you can also choose to compile it directly into the kernel.
If you decide to build any of these as dynamic kernel modules, it's a good idea
to add these lines to @file{/etc/modules.conf}:
@example
alias char-major-36 netlink_dev
alias tap0 ethertap
options tap0 -o tap0 unit=0
alias tap1 ethertap
options tap1 -o tap1 unit=1
...
alias tap@emph{N} ethertap
options tap@emph{N} -o tap@emph{N} unit=@emph{N}
@end example
Add as much alias/options lines as necessary.
@c ==================================================================
@node Configuration of Linux kernels 2.4.0 and higher
@subsection Configuration of Linux kernels 2.4.0 and higher
@node Configuration of Linux kernels
@subsection Configuration of Linux kernels
@cindex Universal tun/tap
For kernels 2.4.0 and higher, you need a kernel that supports the Universal tun/tap device.
For tinc to work, you need a kernel that supports the Universal tun/tap device.
Most distributions come with kernels that already support this.
Here are the options you have to turn on when configuring a new kernel:
@ -295,11 +254,6 @@ Network device support
It's not necessary to compile this driver as a module, even if you are going to
run more than one instance of tinc.
If you have an early 2.4 kernel, you can choose both the tun/tap driver and the
`Ethertap network tap' device. This latter is marked obsolete, and chances are
that it won't even function correctly anymore. Make sure you select the
universal tun/tap driver.
If you decide to build the tun/tap driver as a kernel module, add these lines
to @file{/etc/modules.conf}:
@ -323,9 +277,9 @@ Using tap devices is recommended.
For OpenBSD version 2.9 and higher,
the tun driver is included in the default kernel configuration.
There is also a kernel patch from @uref{http://diehard.n-r-g.com/stuff/openbsd/}
which adds a tap device to OpenBSD.
This should work with tinc.
which adds a tap device to OpenBSD which should work with tinc,
but with recent versions of OpenBSD,
a tun device can act as a tap device by setting the link0 option with ifconfig.
@c ==================================================================
@node Configuration of NetBSD kernels
@ -609,40 +563,16 @@ files on your system.
@subsection Device files
@cindex device files
First, you'll need the special device file(s) that form the interface
between the kernel and the daemon.
Most operating systems nowadays come with the necessary device files by default,
or they have a mechanism to create them on demand.
The permissions for these files have to be such that only the super user
may read/write to this file. You'd want this, because otherwise
eavesdropping would become a bit too easy. This does, however, imply
that you'd have to run tincd as root.
If you use Linux and have a kernel version prior to 2.4.0, you have to make the
ethertap devices:
If you use Linux and do not have udev installed,
you may need to create the following device file if it does not exist:
@example
mknod -m 600 /dev/tap0 c 36 16
mknod -m 600 /dev/tap1 c 36 17
...
mknod -m 600 /dev/tap@emph{N} c 36 @emph{N+16}
mknod -m 600 /dev/net/tun c 10 200
@end example
There is a maximum of 16 ethertap devices.
If you use the universal tun/tap driver, you have to create the
following device file (unless it already exist):
@example
mknod -m 600 /dev/tun c 10 200
@end example
If you use Linux, and you run the new 2.4 kernel using the devfs filesystem,
then the tun/tap device will probably be automatically generated as
@file{/dev/net/tun}.
Unlike the ethertap device, you do not need multiple device files if
you are planning to run multiple tinc daemons.
@c ==================================================================
@node Other files
@ -862,6 +792,38 @@ Under Windows, use @var{Interface} instead of @var{Device}.
Note that you can only use one device per daemon.
See also @ref{Device files}.
@cindex DeviceType
@item DeviceType = <tun|tunnohead|tunifhead|tap> (only supported on BSD platforms)
The type of the virtual network device.
Tinc will normally automatically select the right type, and this option should not be used.
However, in case tinc does not seem to correctly interpret packets received from the virtual network device,
using this option might help.
@table @asis
@item tun
Set type to tun.
Depending on the platform, this can either be with or without an address family header (see below).
@cindex tunnohead
@item tunnohead
Set type to tun without an address family header.
Tinc will expect packets read from the virtual network device to start with an IP header.
On some platforms IPv6 packets cannot be read from or written to the device in this mode.
@cindex tunifhead
@item tunifhead
Set type to tun with an address family header.
Tinc will expect packets read from the virtual network device
to start with a four byte header containing the address family,
followed by an IP header.
This mode should support both IPv4 and IPv6 packets.
@item tap
Set type to tap.
Tinc will expect packets read from the virtual network device
to start with an Ethernet header.
@end table
@cindex GraphDumpFile
@item GraphDumpFile = <@var{filename}> [experimental]
If this option is present,
@ -932,7 +894,8 @@ This only has effect when Mode is set to "switch".
@cindex Name
@item Name = <@var{name}> [required]
This is a symbolic name for this connection. It can be anything
This is a symbolic name for this connection.
The name should consist only of alfanumeric and underscore characters (a-z, A-Z, 0-9 and _).
@cindex PingInterval
@item PingInterval = <@var{seconds}> (60)
@ -1019,6 +982,15 @@ The length of the message authentication code used to authenticate UDP packets.
Can be anything from 0
up to the length of the digest produced by the digest algorithm.
@cindex PMTU
@item PMTU = <@var{mtu}> (1514)
This option controls the initial path MTU to this node.
@cindex PMTUDiscovery
@item PMTUDiscovery = <yes|no> (yes)
When this option is enabled, tinc will try to discover the path MTU to this node.
After the path MTU has been discovered, it will be enforced on the VPN.
@cindex Port
@item Port = <@var{port}> (655)
This is the port this tinc daemon listens on.
@ -1068,7 +1040,7 @@ example: netmask 255.255.255.0 would become /24, 255.255.252.0 becomes
@uref{ftp://ftp.isi.edu/in-notes/rfc1519.txt, RFC1519}
@cindex TCPonly
@item TCPonly = <yes|no> (no) [experimental]
@item TCPonly = <yes|no> (no)
If this variable is set to yes, then the packets are tunnelled over a
TCP connection instead of a UDP connection. This is especially useful
for those who want to run a tinc daemon from behind a masquerading