j3d1/tinc
1
0
Fork 0
Code Issues 1 Pull requests Releases Wiki Activity

Update documentation.

Browse source
This commit is contained in:
Guus Sliepen 2003-08-09 00:53:22 +00:00
parent 7eed829d28
commit 9b579eb9ff
3 changed files with 233 additions and 148 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -136,11 +136,15 @@ If you don't specify a host with
.Nm tinc .Nm tinc
won't try to connect to other daemons at all, won't try to connect to other daemons at all,
and will instead just listen for incoming connections. and will instead just listen for incoming connections.
.It Va Device Li = Ar device Po /dev/tap0 or /dev/net/tun Pc .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. The virtual network device to use.
.Nm tinc .Nm tinc
will automatically detect what kind of device it is. will automatically detect what kind of device it is.
Note that you can only use one device per daemon. Note that you can only use one device per daemon.
Under Windows, use
.Va Interface
instead of
.Va Device .
The info pages of the tinc package contain more information The info pages of the tinc package contain more information
about configuring the virtual network device. about configuring the virtual network device.
.It Va Hostnames Li = yes | no Pq no .It Va Hostnames Li = yes | no Pq no
@ -153,19 +157,22 @@ This does not affect resolving hostnames to IP addresses from the
host configuration files. host configuration files.
.It Va Interface Li = Ar interface .It Va Interface Li = Ar interface
Defines the name of the interface corresponding to the virtual network device. 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 Depending on the operating system and the type of device this may or may not actually set the name of the interface.
or choose the device corresponding to this interface. Under Windows, this variable is used to select which network interface will be used.
.It Va KeyExpire Li = Ar period Pq 3600 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. 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, 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. even though it is thought to be nearly impossible to crack a single key.
.It Va MACExpire Li = Ar period Pq 600 .It Va MACExpire Li = Ar seconds Pq 600
This option controls the amount of time MAC addresses are kept before they are removed. This option controls the amount of time MAC addresses are kept before they are removed.
This only has effect when This only has effect when
.Va Mode .Va Mode
is set to is set to
.Qq switch . .Qq switch .
.It Va MaxTimeout Li = Ar period Pq 900 .It Va MaxTimeout Li = Ar seconds Pq 900
This is the maximum delay before trying to reconnect to other tinc daemons. This is the maximum delay before trying to reconnect to other tinc daemons.
.It Va Mode Li = router | switch | hub Pq router .It Va Mode Li = router | switch | hub Pq router
This option selects the way packets are routed to other daemons. This option selects the way packets are routed to other daemons.
@ -192,7 +199,7 @@ while no routing table is managed.
.It Va Name Li = Ar name Bq required .It Va Name Li = Ar name Bq required
This is the name which identifies this tinc daemon. This is the name which identifies this tinc daemon.
It must be unique for the virtual private network this daemon will connect to. It must be unique for the virtual private network this daemon will connect to.
.It Va PingTimeout Li = Ar period Pq 60 .It Va PingTimeout Li = Ar seconds Pq 60
The number of seconds of inactivity that The number of seconds of inactivity that
.Nm tinc .Nm tinc
will wait before sending a probe to the other end. will wait before sending a probe to the other end.
@ -205,7 +212,7 @@ will be inherited by the UDP packets that are sent out.
.It Va PrivateKey Li = Ar key Bq obsolete .It Va PrivateKey Li = Ar key Bq obsolete
The private RSA key of this tinc daemon. The private RSA key of this tinc daemon.
It will allow this tinc daemon to authenticate itself to other daemons. It will allow this tinc daemon to authenticate itself to other daemons.
.It Va PrivateKeyFile Li = Ar filename Bq recommended .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. The file in which the private RSA key of this tinc daemon resides.
Note that there must be exactly one of Note that there must be exactly one of
.Va PrivateKey .Va PrivateKey
@ -304,7 +311,59 @@ from behind a masquerading firewall,
or if UDP packet routing is disabled somehow. or if UDP packet routing is disabled somehow.
Setting this options also implicitly sets IndirectData. Setting this options also implicitly sets IndirectData.
.El .El
.Sh SCRIPTS
Apart from reading the server and host configuration files,
tinc can also run scripts at certain moments.
On 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.
.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
.Li $
in scripts.
Under Windows, in
.Pa .bat
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.
.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.
.El
.Sh FILES .Sh FILES
The most important files are:
.Bl -tag -width indent .Bl -tag -width indent
.It Pa @sysconfdir@/tinc/ .It Pa @sysconfdir@/tinc/
The top directory for configuration files. The top directory for configuration files.
@ -317,22 +376,10 @@ Host configuration files are kept in this directory.
If an executable file with this name exists, 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 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 can be used to set up the corresponding network interface.
.Pp
The environment variable
.Ev $NETNAME
will be passed to the executable.
If specified with the
.Va Interface
configuration variable,
or if the virtual network device is a Linux tun/tap device,
the environment variable
.Ev $INTERFACE
will be set to the name of the network interface.
.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-down .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
If an executable file with this name exists, If an executable file with this name exists,
it will be executed right before the tinc daemon is going to close it will be executed right before the tinc daemon is going to close
its connection to the virtual network device. its connection to the virtual network device.
The same environment variables will be passed as mentioned above.
.El .El
.Sh SEE ALSO .Sh SEE ALSO
.Xr tincd 8 , .Xr tincd 8 ,

254
doc/tinc.texi
View file

@ -1,5 +1,5 @@
\input texinfo @c -*-texinfo-*- \input texinfo @c -*-texinfo-*-
@c $Id: tinc.texi,v 1.8.4.43 2003/08/08 14:07:12 guus Exp $ @c $Id: tinc.texi,v 1.8.4.44 2003/08/09 00:53:22 guus Exp $
@c %**start of header @c %**start of header
@setfilename tinc.info @setfilename tinc.info
@settitle tinc Manual @settitle tinc Manual
@ -20,7 +20,7 @@ Copyright @copyright{} 1998-2003 Ivo Timmermans
<ivo@@o2w.nl>, Guus Sliepen <guus@@sliepen.eu.org> and <ivo@@o2w.nl>, Guus Sliepen <guus@@sliepen.eu.org> and
Wessel Dankers <wsl@@nl.linux.org>. Wessel Dankers <wsl@@nl.linux.org>.
$Id: tinc.texi,v 1.8.4.43 2003/08/08 14:07:12 guus Exp $ $Id: tinc.texi,v 1.8.4.44 2003/08/09 00:53:22 guus Exp $
Permission is granted to make and distribute verbatim copies of this Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are manual provided the copyright notice and this permission notice are
@ -47,7 +47,7 @@ Copyright @copyright{} 1998-2003 Ivo Timmermans
<ivo@@o2w.nl>, Guus Sliepen <guus@@sliepen.eu.org> and <ivo@@o2w.nl>, Guus Sliepen <guus@@sliepen.eu.org> and
Wessel Dankers <wsl@@nl.linux.org>. Wessel Dankers <wsl@@nl.linux.org>.
$Id: tinc.texi,v 1.8.4.43 2003/08/08 14:07:12 guus Exp $ $Id: tinc.texi,v 1.8.4.44 2003/08/09 00:53:22 guus Exp $
Permission is granted to make and distribute verbatim copies of this Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are manual provided the copyright notice and this permission notice are
@ -64,7 +64,7 @@ permission notice identical to this one.
@node Top, Introduction, (dir), (dir) @node Top, Introduction, (dir), (dir)
@menu @menu
* Introduction:: Introduction * Introduction::
* Preparations:: * Preparations::
* Installation:: * Installation::
* Configuration:: * Configuration::
@ -96,13 +96,13 @@ configure your computer to use tinc, as well as the configuration
process of tinc itself. process of tinc itself.
@menu @menu
* VPNs:: Virtual Private Networks in general * Virtual Private Networks::
* tinc:: about tinc * tinc:: About tinc
* Supported platforms:: * Supported platforms::
@end menu @end menu
@c ================================================================== @c ==================================================================
@node VPNs, tinc, Introduction, Introduction @node Virtual Private Networks, tinc, Introduction, Introduction
@section Virtual Private Networks @section Virtual Private Networks
@cindex VPN @cindex VPN
@ -140,7 +140,7 @@ through the VPN. This is what tinc was made for.
@c ================================================================== @c ==================================================================
@node tinc, Supported platforms, VPNs, Introduction @node tinc, Supported platforms, Virtual Private Networks, Introduction
@section tinc @section tinc
@cindex vpnd @cindex vpnd
@ -181,7 +181,7 @@ available too.
@section Supported platforms @section Supported platforms
@cindex platforms @cindex platforms
tinc has been verified to work under Linux, FreeBSD, OpenBSD, NetBSD, MacOS/X (Darwin), Solaris, and Windows (in a Cygwin environment), tinc has been verified to work under Linux, FreeBSD, OpenBSD, NetBSD, MacOS/X (Darwin), Solaris, and Windows (both natively and in a Cygwin environment),
with various hardware architectures. These are some of the platforms with various hardware architectures. These are some of the platforms
that are supported by the universal tun/tap device driver or other virtual network device drivers. that are supported by the universal tun/tap device driver or other virtual network device drivers.
Without such a driver, tinc will most Without such a driver, tinc will most
@ -263,20 +263,10 @@ downloaded from @uref{http://chrisp.de/en/projects/tunnel.html}.
IPv6 packets cannot be tunneled on Darwin. IPv6 packets cannot be tunneled on Darwin.
@c ================================================================== @c ==================================================================
@subsection Cygwin (Windows) @subsection Windows
@cindex Cygwin
@cindex Windows @cindex Windows
tinc on Windows, in a Cygwin environment, relies on the CIPE driver for its data tinc on Windows, in a Cygwin environment, relies on the CIPE driver or the TAP-Win32 driver for its data
acquisition from the kernel. This driver is not part of Windows but can be
downloaded from @uref{http://cipe-win32.sourceforge.net/}.
@c ==================================================================
@subsection MinGW (Windows)
@cindex MinGW
@cindex Windows
tinc on Windows (native), compiled using MinGW, relies on the CIPE driver for its data
acquisition from the kernel. This driver is not part of Windows but can be acquisition from the kernel. This driver is not part of Windows but can be
downloaded from @uref{http://cipe-win32.sourceforge.net/}. downloaded from @uref{http://cipe-win32.sourceforge.net/}.
@ -339,8 +329,7 @@ you should read the @uref{http://howto.linuxberg.com/LDP/HOWTO/Kernel-HOWTO.html
* Configuration of NetBSD kernels:: * Configuration of NetBSD kernels::
* Configuration of Solaris kernels:: * Configuration of Solaris kernels::
* Configuration of Darwin (MacOS/X) kernels:: * Configuration of Darwin (MacOS/X) kernels::
* Configuration of Cygwin (Windows):: * Configuration of Windows::
* Configuration of MinGW (Windows)::
@end menu @end menu
@ -444,7 +433,7 @@ the tun driver is included in the default kernel configuration.
@c ================================================================== @c ==================================================================
@node Configuration of Darwin (MacOS/X) kernels, Configuration of Cygwin (Windows), Configuration of Solaris kernels, Configuring the kernel @node Configuration of Darwin (MacOS/X) kernels, Configuration of Windows, Configuration of Solaris kernels, Configuring the kernel
@subsection Configuration of Darwin (MacOS/X) kernels @subsection Configuration of Darwin (MacOS/X) kernels
Darwin does not come with a tunnel driver. You must download it at Darwin does not come with a tunnel driver. You must download it at
@ -461,21 +450,13 @@ and the corresponding network interfaces.
@c ================================================================== @c ==================================================================
@node Configuration of Cygwin (Windows), Configuration of MinGW (Windows), Configuration of Darwin (MacOS/X) kernels, Configuring the kernel @node Configuration of Windows, , Configuration of Darwin (MacOS/X) kernels, Configuring the kernel
@subsection Configuration of Cygwin (Windows) @subsection Configuration of Windows
You will need to install the CIPE driver, you can download it from You will need to install the CIPE driver or the TAP-Win32 driver. You can download the CIPE driver from
@uref{http://cipe-win32.sourceforge.net}. Configure the CIPE network device in @uref{http://cipe-win32.sourceforge.net}. Using the Network Connections control panel,
the same way as you would do from the tinc-up script. configure the CIPE network device in the same way as you would do from the tinc-up script
as explained in the rest of the documentation.
@c ==================================================================
@node Configuration of MinGW (Windows), , Configuration of Cygwin (Windows), Configuring the kernel
@subsection Configuration of MinGW (Windows)
You will need to install the CIPE driver, you can download it from
@uref{http://cipe-win32.sourceforge.net}. Configure the CIPE network device in
the same way as you would do from the tinc-up script.
@c ================================================================== @c ==================================================================
@ -647,7 +628,7 @@ The documentation that comes along with your distribution will tell you how to d
@c ================================================================== @c ==================================================================
@node Darwin (MacOS/X) build environment, Cygwin (Windows) build environment, , Building and installing tinc @node Darwin (MacOS/X) build environment, Cygwin (Windows) build environment, Building and installing tinc, Building and installing tinc
@subsection Darwin (MacOS/X) build environment @subsection Darwin (MacOS/X) build environment
In order to build tinc on Darwin, you need to install the MacOS/X Developer Tools In order to build tinc on Darwin, you need to install the MacOS/X Developer Tools
@ -669,7 +650,7 @@ but all programs, including those started outside the Cygwin environment, will b
It will also support all features. It will also support all features.
@c ================================================================== @c ==================================================================
@node MinGW (Windows) build environment, , Cygwin (Windows) build environment, Building and installing tinc @node MinGW (Windows) build environment, , Cygwin (Windows) build environment, Building and installing tinc
@subsection MinGW (Windows) build environment @subsection MinGW (Windows) build environment
You will need to install the MinGW environment from @uref{http://www.mingw.org}. You will need to install the MinGW environment from @uref{http://www.mingw.org}.
@ -677,8 +658,6 @@ You will need to install the MinGW environment from @uref{http://www.mingw.org}.
When tinc is compiled using MinGW it runs natively under Windows, When tinc is compiled using MinGW it runs natively under Windows,
it is not necessary to keep MinGW installed. it is not necessary to keep MinGW installed.
When running natively, tinc is not able to start scripts,
nor is tinc able to receive signals.
When detaching, tinc will install itself as a service, When detaching, tinc will install itself as a service,
which will be restarted automatically after reboots. which will be restarted automatically after reboots.
@ -792,7 +771,6 @@ tinc 655/udp TINC
@node Configuration introduction, Multiple networks, Configuration, Configuration @node Configuration introduction, Multiple networks, Configuration, Configuration
@section Configuration introduction @section Configuration introduction
@cindex Network Administrators Guide
Before actually starting to configure tinc and editing files, Before actually starting to configure tinc and editing files,
make sure you have read this entire section so you know what to expect. make sure you have read this entire section so you know what to expect.
Then, make it clear to yourself how you want to organize your VPN: Then, make it clear to yourself how you want to organize your VPN:
@ -805,6 +783,7 @@ Do you want to run tinc in router mode or switch mode?
These questions can only be answered by yourself, These questions can only be answered by yourself,
you will not find the answers in this documentation. you will not find the answers in this documentation.
Make sure you have an adequate understanding of networks in general. Make sure you have an adequate understanding of networks in general.
@cindex Network Administrators Guide
A good resource on networking is the A good resource on networking is the
@uref{http://www.linuxdoc.org/LDP/nag2/, Linux Network Administrators Guide}. @uref{http://www.linuxdoc.org/LDP/nag2/, Linux Network Administrators Guide}.
@ -834,13 +813,13 @@ This means that you call tincd with the -n argument,
which will assign a netname to this daemon. which will assign a netname to this daemon.
The effect of this is that the daemon will set its configuration The effect of this is that the daemon will set its configuration
``root'' to @value{sysconfdir}/tinc/@emph{netname}/, where @emph{netname} is your argument to the -n ``root'' to @value{sysconfdir}/tinc/@var{netname}/, where @var{netname} is your argument to the -n
option. You'll notice that it appears in syslog as ``tinc.@emph{netname}''. option. You'll notice that it appears in syslog as ``tinc.@var{netname}''.
However, it is not strictly necessary that you call tinc with the -n However, it is not strictly necessary that you call tinc with the -n
option. In this case, the network name would just be empty, and it will option. In this case, the network name would just be empty, and it will
be used as such. tinc now looks for files in @value{sysconfdir}/tinc/, instead of be used as such. tinc now looks for files in @value{sysconfdir}/tinc/, instead of
@value{sysconfdir}/tinc/@emph{netname}/; the configuration file should be @value{sysconfdir}/tinc/tinc.conf, @value{sysconfdir}/tinc/@var{netname}/; the configuration file should be @value{sysconfdir}/tinc/tinc.conf,
and the host configuration files are now expected to be in @value{sysconfdir}/tinc/hosts/. and the host configuration files are now expected to be in @value{sysconfdir}/tinc/hosts/.
But it is highly recommended that you use this feature of tinc, because But it is highly recommended that you use this feature of tinc, because
@ -878,8 +857,8 @@ It does not matter if two tinc daemons have a `ConnectTo' value pointing to each
@section Configuration files @section Configuration files
The actual configuration of the daemon is done in the file The actual configuration of the daemon is done in the file
@file{@value{sysconfdir}/tinc/@emph{netname}/tinc.conf} and at least one other file in the directory @file{@value{sysconfdir}/tinc/@var{netname}/tinc.conf} and at least one other file in the directory
@file{@value{sysconfdir}/tinc/@emph{netname}/hosts/}. @file{@value{sysconfdir}/tinc/@var{netname}/hosts/}.
These file consists of comments (lines started with a #) or assignments These file consists of comments (lines started with a #) or assignments
in the form of in the form of
@ -895,29 +874,29 @@ out, remember to replace it with at least one space character.
In this section all valid variables are listed in alphabetical order. In this section all valid variables are listed in alphabetical order.
The default value is given between parentheses, The default value is given between parentheses,
other comments are between square brackets and other comments are between square brackets.
required directives are given in @strong{bold}.
@menu @menu
* Main configuration variables:: * Main configuration variables::
* Host configuration variables:: * Host configuration variables::
* Scripts::
* How to configure:: * How to configure::
@end menu @end menu
@c ================================================================== @c ==================================================================
@node Main configuration variables, Host configuration variables, Configuration files, Configuration files @node Main configuration variables, Host configuration variables, Configuration files, Configuration files
@subsection Main configuration variables @subsection Main configuration variables
@table @asis @table @asis
@cindex AddressFamily @cindex AddressFamily
@item AddressFamily = <ipv4|ipv6|any> (any) @item @var{AddressFamily} = <ipv4|ipv6|any> (any)
This option affects the address family of listening and outgoing sockets. This option affects the address family of listening and outgoing sockets.
If "any" is selected, then depending on the operating system If "any" is selected, then depending on the operating system
both IPv4 and IPv6 or just IPv6 listening sockets will be created. both IPv4 and IPv6 or just IPv6 listening sockets will be created.
@cindex BindToAddress @cindex BindToAddress
@item BindToAddress = <address> [experimental] @item @var{BindToAddress} = <address> [experimental]
If your computer has more than one IPv4 or IPv6 address, tinc If your computer has more than one IPv4 or IPv6 address, tinc
will by default listen on all of them for incoming connections. will by default listen on all of them for incoming connections.
It is possible to bind only to a single address with this variable. It is possible to bind only to a single address with this variable.
@ -925,7 +904,7 @@ It is possible to bind only to a single address with this variable.
This option may not work on all platforms. This option may not work on all platforms.
@cindex BindToInterface @cindex BindToInterface
@item BindToInterface = <interface> [experimental] @item @var{BindToInterface} = <interface> [experimental]
If you have more than one network interface in your computer, tinc will If you have more than one network interface in your computer, tinc will
by default listen on all of them for incoming connections. It is by default listen on all of them for incoming connections. It is
possible to bind tinc to a single interface like eth0 or ppp0 with this possible to bind tinc to a single interface like eth0 or ppp0 with this
@ -934,7 +913,7 @@ variable.
This option may not work on all platforms. This option may not work on all platforms.
@cindex ConnectTo @cindex ConnectTo
@item @strong{ConnectTo = <name>} @item @var{ConnectTo} = <name>
Specifies which other tinc daemon to connect to on startup. Specifies which other tinc daemon to connect to on startup.
Multiple ConnectTo variables may be specified, Multiple ConnectTo variables may be specified,
in which case outgoing connections to each specified tinc daemon are made. in which case outgoing connections to each specified tinc daemon are made.
@ -946,12 +925,16 @@ tinc won't try to connect to other daemons at all,
and will instead just listen for incoming connections. and will instead just listen for incoming connections.
@cindex Device @cindex Device
@item @strong{Device = <device>} (/dev/tap0 or /dev/net/tun) @item @var{Device} = <device> (@file{/dev/tap0}, @file{/dev/net/tun} or other depending on platform)
The virtual network device to use. Note that you can only use one device per The virtual network device to use.
daemon. See also @ref{Device files}. tinc will automatically detect what kind of device it is.
Note that you can only use one device per daemon.
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 Hostnames @cindex Hostnames
@item Hostnames = <yes|no> (no) @item @var{Hostnames} = <yes|no> (no)
This option selects whether IP addresses (both real and on the VPN) This option selects whether IP addresses (both real and on the VPN)
should be resolved. Since DNS lookups are blocking, it might affect should be resolved. Since DNS lookups are blocking, it might affect
tinc's efficiency, even stopping the daemon for a few seconds everytime tinc's efficiency, even stopping the daemon for a few seconds everytime
@ -961,13 +944,14 @@ This does not affect resolving hostnames to IP addresses from the
configuration file. configuration file.
@cindex Interface @cindex Interface
@item Interface = <interface> @item @var{Interface} = <interface>
Defines the name of the interface corresponding to the virtual network device. 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 Depending on the operating system and the type of device this may or may not actually set the name of the interface.
or choose the device corresponding to this interface. Under Windows, this variable is used to select which network interface will be used.
If you specified a Device, this variable is almost always already correctly set.
@cindex Mode @cindex Mode
@item Mode = <router|switch|hub> (router) @item @var{Mode} = <router|switch|hub> (router)
This option selects the way packets are routed to other daemons. This option selects the way packets are routed to other daemons.
@table @asis @table @asis
@ -996,82 +980,82 @@ while no routing table is managed.
@end table @end table
@cindex KeyExpire @cindex KeyExpire
@item KeyExpire = <seconds> (3600) @item @var{KeyExpire} = <seconds> (3600)
This option controls the time the encryption keys used to encrypt the data This option controls the time the encryption keys used to encrypt the data
are valid. It is common practice to change keys at regular intervals to 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 make it even harder for crackers, even though it is thought to be nearly
impossible to crack a single key. impossible to crack a single key.
@cindex MACExpire @cindex MACExpire
@item MACExpire = <seconds> (600) @item @var{MACExpire} = <seconds> (600)
This option controls the amount of time MAC addresses are kept before they are removed. This option controls the amount of time MAC addresses are kept before they are removed.
This only has effect when Mode is set to "switch". This only has effect when Mode is set to "switch".
@cindex Name @cindex Name
@item @strong{Name = <name>} @item @var{Name} = <name> [required]
This is a symbolic name for this connection. It can be anything This is a symbolic name for this connection. It can be anything
@cindex PingTimeout @cindex PingTimeout
@item PingTimeout = <seconds> (60) @item @var{PingTimeout} = <seconds> (60)
The number of seconds of inactivity that tinc will wait before sending a The number of seconds of inactivity that tinc will wait before sending a
probe to the other end. If that other end doesn't answer within that probe to the other end. If that other end doesn't answer within that
same amount of seconds, the connection is terminated, and the others same amount of seconds, the connection is terminated, and the others
will be notified of this. will be notified of this.
@cindex PriorityInheritance @cindex PriorityInheritance
@item PriorityInheritance = <yes|no> (no) [experimental] @item @var{PriorityInheritance} = <yes|no> (no) [experimental]
When this option is enabled the value of the TOS field of tunneled IPv4 packets 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. will be inherited by the UDP packets that are sent out.
@cindex PrivateKey @cindex PrivateKey
@item PrivateKey = <key> [obsolete] @item @var{PrivateKey} = <key> [obsolete]
This is the RSA private key for tinc. However, for safety reasons it is This is the RSA private key for tinc. However, for safety reasons it is
advised to store private keys of any kind in separate files. This prevents advised to store private keys of any kind in separate files. This prevents
accidental eavesdropping if you are editting the configuration file. accidental eavesdropping if you are editting the configuration file.
@cindex PrivateKeyFile @cindex PrivateKeyFile
@item @strong{PrivateKeyFile = <path>} [recommended] @item @var{PrivateKeyFile} = <path> (@file{@value{sysconfdir}/tinc/@var{netname}/rsa_key.priv})
This is the full path name of the RSA private key file that was This is the full path name of the RSA private key file that was
generated by ``tincd --generate-keys''. It must be a full path, not a generated by ``tincd --generate-keys''. It must be a full path, not a
relative directory. relative directory.
Note that there must be exactly one of PrivateKey Note that there must be exactly one of @var{PrivateKey}
or PrivateKeyFile or @var{PrivateKeyFile}
specified in the configuration file. specified in the configuration file.
@end table @end table
@c ================================================================== @c ==================================================================
@node Host configuration variables, How to configure, Main configuration variables, Configuration files @node Host configuration variables, Scripts, Main configuration variables, Configuration files
@subsection Host configuration variables @subsection Host configuration variables
@table @asis @table @asis
@cindex Address @cindex Address
@item @strong{Address = <IP address|hostname>} [recommended] @item @var{Address} = <IP address|hostname> [recommended]
This variable is only required if you want to connect to this host. It This variable is only required if you want to connect to this host. It
must resolve to the external IP address where the host can be reached, must resolve to the external IP address where the host can be reached,
not the one that is internal to the VPN. not the one that is internal to the VPN.
@cindex Cipher @cindex Cipher
@item Cipher = <cipher> (blowfish) @item @var{Cipher} = <cipher> (blowfish)
The symmetric cipher algorithm used to encrypt UDP packets. The symmetric cipher algorithm used to encrypt UDP packets.
Any cipher supported by OpenSSL is recognized. Any cipher supported by OpenSSL is recognized.
@cindex Compression @cindex Compression
@item Compression = <level> (0) @item @var{Compression} = <level> (0)
This option sets the level of compression used for UDP packets. 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), Possible values are 0 (off), 1 (fast zlib) and any integer up to 9 (best zlib),
10 (fast lzo) and 11 (best lzo). 10 (fast lzo) and 11 (best lzo).
@cindex Digest @cindex Digest
@item Digest = <digest> (sha1) @item @var{Digest} = <digest> (sha1)
The digest algorithm used to authenticate UDP packets. The digest algorithm used to authenticate UDP packets.
Any digest supported by OpenSSL is recognized. Any digest supported by OpenSSL is recognized.
Furthermore, specifying "none" will turn off packet authentication. Furthermore, specifying "none" will turn off packet authentication.
@cindex IndirectData @cindex IndirectData
@item IndirectData = <yes|no> (no) @item @var{IndirectData} = <yes|no> (no)
This option specifies whether other tinc daemons besides the one you This option specifies whether other tinc daemons besides the one you
specified with ConnectTo can make a direct connection to you. This is specified with ConnectTo can make a direct connection to you. This is
especially useful if you are behind a firewall and it is impossible to especially useful if you are behind a firewall and it is impossible to
@ -1079,22 +1063,22 @@ make a connection from the outside to your tinc daemon. Otherwise, it
is best to leave this option out or set it to no. is best to leave this option out or set it to no.
@cindex MACLength @cindex MACLength
@item MACLength = <length> (4) @item @var{MACLength} = <length> (4)
The length of the message authentication code used to authenticate UDP packets. The length of the message authentication code used to authenticate UDP packets.
Can be anything from 0 Can be anything from 0
up to the length of the digest produced by the digest algorithm. up to the length of the digest produced by the digest algorithm.
@cindex Port @cindex Port
@item Port = <port> (655) @item @var{Port} = <port> (655)
This is the port this tinc daemon listens on. This is the port this tinc daemon listens on.
You can use decimal portnumbers or symbolic names (as listed in /etc/services). You can use decimal portnumbers or symbolic names (as listed in /etc/services).
@cindex PublicKey @cindex PublicKey
@item PublicKey = <key> [obsolete] @item @var{PublicKey} = <key> [obsolete]
This is the RSA public key for this host. This is the RSA public key for this host.
@cindex PublicKeyFile @cindex PublicKeyFile
@item PublicKeyFile = <path> [obsolete] @item @var{PublicKeyFile} = <path> [obsolete]
This is the full path name of the RSA public key file that was generated This is the full path name of the RSA public key file that was generated
by ``tincd --generate-keys''. It must be a full path, not a relative by ``tincd --generate-keys''. It must be a full path, not a relative
directory. directory.
@ -1108,7 +1092,7 @@ in each host configuration file, if you want to be able to establish a
connection with that host. connection with that host.
@cindex Subnet @cindex Subnet
@item Subnet = <address[/prefixlength]> @item @var{Subnet} = <address[/prefixlength]>
The subnet which this tinc daemon will serve. The subnet which this tinc daemon will serve.
tinc tries to look up which other daemon it should send a packet to by searching the appropiate subnet. tinc tries to look up which other daemon it should send a packet to by searching the appropiate subnet.
If the packet matches a subnet, If the packet matches a subnet,
@ -1133,7 +1117,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} @uref{ftp://ftp.isi.edu/in-notes/rfc1519.txt, RFC1519}
@cindex TCPonly @cindex TCPonly
@item TCPonly = <yes|no> (no) [experimental] @item @var{TCPonly} = <yes|no> (no) [experimental]
If this variable is set to yes, then the packets are tunnelled over a 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 TCP connection instead of a UDP connection. This is especially useful
for those who want to run a tinc daemon from behind a masquerading for those who want to run a tinc daemon from behind a masquerading
@ -1143,18 +1127,86 @@ Setting this options also implicitly sets IndirectData.
@c ================================================================== @c ==================================================================
@node How to configure, , Host configuration variables, Configuration files @node Scripts, How to configure, Host configuration variables, Configuration files
@subsection Scripts
@cindex scripts
Apart from reading the server and host configuration files,
tinc can also run scripts at certain moments.
On Windows (not Cygwin), the scripts should have the extension .bat.
@table @file
@cindex tinc-up
@item @value{sysconfdir}/tinc/@var{netname}/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.
@cindex tinc-down
@item @value{sysconfdir}/tinc/@var{netname}/tinc-down
This script is started right before the tinc daemon quits.
@item @value{sysconfdir}/tinc/@var{netname}/hosts/@var{host}-up
This script is started when the tinc daemon with name @var{host} becomes reachable.
@item @value{sysconfdir}/tinc/@var{netname}/hosts/@var{host}-down
This script is started when the tinc daemon with name @var{host} becomes unreachable.
@end table
@cindex environment variables
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 $ in scripts.
Under Windows, in @file{.bat} files, they have to be put between % signs.
@table @env
@cindex NETNAME
@item NETNAME
If a netname was specified, this environment variable contains it.
@cindex NAME
@item NAME
Contains the name of this tinc daemon.
@cindex DEVICE
@item DEVICE
Contains the name of the virtual network device that tinc uses.
@cindex INTERFACE
@item INTERFACE
Contains the name of the virtual network interface that tinc uses.
This should be used for commands like ifconfig.
@cindex NODE
@item NODE
When a host becomes (un)reachable, this is set to its name.
@cindex REMOTEADDRESS
@item REMOTEADDRESS
When a host becomes (un)reachable, this is set to its real address.
@cindex REMOTEPORT
@item REMOTEPORT
When a host becomes (un)reachable,
this is set to the port number it uses for communication with other tinc daemons.
@end table
@c ==================================================================
@node How to configure, , Scripts, Configuration files
@subsection How to configure @subsection How to configure
@subsubheading Step 1. Creating the main configuration file @subsubheading Step 1. Creating the main configuration file
The main configuration file will be called @file{@value{sysconfdir}/tinc/@emph{netname}/tinc.conf}. The main configuration file will be called @file{@value{sysconfdir}/tinc/@var{netname}/tinc.conf}.
Adapt the following example to create a basic configuration file: Adapt the following example to create a basic configuration file:
@example @example
Name = @emph{yourname} Name = @var{yourname}
Device = @emph{/dev/tap0} Device = @file{/dev/tap0}
PrivateKeyFile = @value{sysconfdir}/tinc/@emph{netname}/rsa_key.priv
@end example @end example
Then, if you know to which other tinc daemon(s) yours is going to connect, Then, if you know to which other tinc daemon(s) yours is going to connect,
@ -1163,12 +1215,12 @@ add `ConnectTo' values.
@subsubheading Step 2. Creating your host configuration file @subsubheading Step 2. Creating your host configuration file
If you added a line containing `Name = yourname' in the main configuarion file, If you added a line containing `Name = yourname' in the main configuarion file,
you will need to create a host configuration file @file{@value{sysconfdir}/tinc/@emph{netname}/hosts/yourname}. you will need to create a host configuration file @file{@value{sysconfdir}/tinc/@var{netname}/hosts/yourname}.
Adapt the following example to create a host configuration file: Adapt the following example to create a host configuration file:
@example @example
Address = @emph{your.real.hostname.org} Address = your.real.hostname.org
Subnet = @emph{192.168.1.0/24} Subnet = 192.168.1.0/24
@end example @end example
You can also use an IP address instead of a hostname. You can also use an IP address instead of a hostname.
@ -1186,7 +1238,7 @@ Now that you have already created the main configuration file and your host conf
you can easily create a public/private keypair by entering the following command: you can easily create a public/private keypair by entering the following command:
@example @example
tincd -n @emph{netname} -K tincd -n @var{netname} -K
@end example @end example
tinc will generate a public and a private key and ask you where to put them. tinc will generate a public and a private key and ask you where to put them.
@ -1209,9 +1261,9 @@ if you are using the Linux tun/tap driver, the network interface will by default
@cindex tinc-up @cindex tinc-up
You can configure the network interface by putting ordinary ifconfig, route, and other commands You can configure the network interface by putting ordinary ifconfig, route, and other commands
to a script named @file{@value{sysconfdir}/tinc/@emph{netname}/tinc-up}. When tinc starts, this script to a script named @file{@value{sysconfdir}/tinc/@var{netname}/tinc-up}. When tinc starts, this script
will be executed. When tinc exits, it will execute the script named will be executed. When tinc exits, it will execute the script named
@file{@value{sysconfdir}/tinc/@emph{netname}/tinc-down}, but normally you don't need to create that script. @file{@value{sysconfdir}/tinc/@var{netname}/tinc-down}, but normally you don't need to create that script.
An example @file{tinc-up} script: An example @file{tinc-up} script:
@ -1436,7 +1488,7 @@ their daemons, tinc will try connecting until they are available.
If everything else is done, you can start tinc by typing the following command: If everything else is done, you can start tinc by typing the following command:
@example @example
tincd -n @emph{netname} tincd -n @var{netname}
@end example @end example
@cindex daemon @cindex daemon
@ -1451,7 +1503,7 @@ and look in the syslog to find out what the problems are.
@c ================================================================== @c ==================================================================
@node Runtime options, Error messages, , Running tinc @node Runtime options, Error messages, Running tinc, Running tinc
@section Runtime options @section Runtime options
Besides the settings in the configuration file, tinc also accepts some Besides the settings in the configuration file, tinc also accepts some
@ -1461,10 +1513,10 @@ command line options.
@cindex runtime options @cindex runtime options
@cindex options @cindex options
@c from the manpage @c from the manpage
@table @samp @table @option
@item -c, --config=PATH @item -c, --config=PATH
Read configuration options from the directory PATH. The default is Read configuration options from the directory PATH. The default is
@file{@value{sysconfdir}/tinc/@emph{netname}/}. @file{@value{sysconfdir}/tinc/@var{netname}/}.
@item -D, --no-detach @item -D, --no-detach
Don't fork and detach. Don't fork and detach.
@ -1850,7 +1902,7 @@ encryption algorithm is always the default length used by OpenSSL.
@c ================================================================== @c ==================================================================
@node Authentication protocol, Encryption of network packets, Security, Security @node Authentication protocol, Encryption of network packets, Security, Security
@subsection Authentication protocol @subsection Authentication protocol
@cindex authentication @cindex authentication
@ -1964,7 +2016,7 @@ an attacker) in the beginning of the encrypted stream.
@c ================================================================== @c ==================================================================
@node Encryption of network packets, , Authentication protocol, Security @node Encryption of network packets, , Authentication protocol, Security
@subsection Encryption of network packet @subsection Encryption of network packet
@cindex encryption @cindex encryption

40
doc/tincd.8.in
View file

@ -34,16 +34,19 @@ If that succeeds,
it will detach from the controlling terminal and continue in the background, it will detach from the controlling terminal and continue in the background,
accepting and setting up connections to other tinc daemons accepting and setting up connections to other tinc daemons
that are part of the virtual private network. that are part of the virtual private network.
Under Windows (native) tinc will install itself as a service, Under Windows (not Cygwin) tinc will install itself as a service,
which will be restarted automatically after reboots. which will be restarted automatically after reboots.
.Sh OPTIONS .Sh OPTIONS
.Bl -tag -width indent .Bl -tag -width indent
.It Fl c, -config Ns = Ns Ar DIR .It Fl c, -config Ns = Ns Ar DIR
Read configuration options from Read configuration files from
.Ar DIR . .Ar DIR
instead of
.Pa @sysconfdir@/tinc/ .
.It Fl D, -no-detach .It Fl D, -no-detach
Don't fork and detach. Don't fork and detach.
This will also disable the automatic restart mechanism for fatal errors. This will also disable the automatic restart mechanism for fatal errors.
If not mentioned otherwise, this will show log messages on the standard error output.
.It Fl d, -debug Ns Op = Ns Ar LEVEL .It Fl d, -debug Ns Op = Ns Ar LEVEL
Increase debug level or set it to Increase debug level or set it to
.Ar LEVEL .Ar LEVEL
@ -54,7 +57,7 @@ Attempt to kill a running
(optionally with the specified (optionally with the specified
.Ar SIGNAL .Ar SIGNAL
instead of SIGTERM) and exit. instead of SIGTERM) and exit.
Under native Windows the optional argument is ignored, Under Windows (not Cygwin) the optional argument is ignored,
the service will always be stopped and removed. the service will always be stopped and removed.
.It Fl n, -net Ns = Ns Ar NETNAME .It Fl n, -net Ns = Ns Ar NETNAME
Connect to net Connect to net
@ -78,6 +81,7 @@ Write PID to
.Ar FILE .Ar FILE
instead of instead of
.Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid. .Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid.
Under Windows this option will be ignored.
.It Fl -bypass-security .It Fl -bypass-security
Disables encryption and authentication of the meta protocol. Disables encryption and authentication of the meta protocol.
Only useful for debugging. Only useful for debugging.
@ -130,7 +134,7 @@ It will also any serious error.
.It 1 .It 1
This will log all connections that are made with other tinc daemons. This will log all connections that are made with other tinc daemons.
.It 2 .It 2
This will log status and error messages from other tinc daemons. This will log status and error messages from scripts and other tinc daemons.
.It 3 .It 3
This will log all requests that are exchanged with other tinc daemons. These include This will log all requests that are exchanged with other tinc daemons. These include
authentication, key exchange and connection list updates. authentication, key exchange and connection list updates.
@ -141,28 +145,10 @@ This will log all network traffic over the virtual private network.
.El .El
.Sh FILES .Sh FILES
.Bl -tag -width indent .Bl -tag -width indent
.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf .It Pa @sysconfdir@/tinc/
The configuration file for Directory containing the configuration files tinc uses.
.Nm . For more information, see
.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-up .Xr tinc.conf 5 .
Script which is executed as soon as the virtual network device has been allocated.
Purpose is to further configure that device.
.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
Script which is executed when
.Nm
exits.
Purpose is to cleanly shut down the virtual network device before it will be deallocated.
.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/*
The directory containing the host configuration files
used to authenticate other tinc daemons.
.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar NAME Ns Pa -up
Script which is executed as soon as host
.Ar NAME
becomes reachable.
.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar NAME Ns Pa -down
Script which is executed as soon as host
.Ar NAME
becomes unreachable.
.It Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid .It Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid
The PID of the currently running The PID of the currently running
.Nm .Nm