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

Update the documentation to encourage using "tincctl init" and "tincctl config".

Browse source
This commit is contained in:
Guus Sliepen 2012-08-01 22:22:52 +02:00
parent 6396f42d74
commit 6bcd03c202
2 changed files with 233 additions and 123 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -14,22 +14,12 @@ The files in the
directory contain runtime and security information for the tinc daemon. directory contain runtime and security information for the tinc daemon.
.Sh NETWORKS .Sh NETWORKS
It is perfectly ok for you to run more than one tinc daemon. To distinguish multiple instances of tinc running on one computer,
However, in its default form, you can use the
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
.Nm
with the
.Fl n .Fl n
option, which will assign a name to this daemon. option to assign a network name to each tinc daemon.
.Pp .Pp
The effect of this is that the daemon will set its configuration root to The effect of this option is that the daemon will set its configuration root to
.Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa / , .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa / ,
where where
.Ar NETNAME .Ar NETNAME
@ -37,14 +27,14 @@ is your argument to the
.Fl n .Fl n
option. option.
You'll notice that messages appear in syslog as coming from You'll notice that messages appear in syslog as coming from
.Nm tincd. Ns Ar NETNAME . .Nm tincd. Ns Ar NETNAME ,
and on Linux, unless specified otherwise, the name of the virtual network interface will be the same as the network name.
.Pp .Pp
However, it is not strictly necessary that you call tinc with the It is recommended that you use network names even if you run only one instance of tinc.
However, you can choose not to use the
.Fl n .Fl n
option. option.
In this case, the network name would just be empty, In this case, the network name would just be empty, and
and it will be used as such.
.Nm tinc .Nm tinc
now looks for files in now looks for files in
.Pa @sysconfdir@/tinc/ , .Pa @sysconfdir@/tinc/ ,
@ -55,12 +45,6 @@ the configuration file should be
and the host configuration files are now expected to be in and the host configuration files are now expected to be in
.Pa @sysconfdir@/tinc/hosts/ . .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 .Sh NAMES
Each tinc daemon should have a name that is unique in the network which it will be part of. 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 will be used by other tinc daemons for identification.
@ -72,25 +56,38 @@ file.
To make things easy, To make things easy,
choose something that will give unique and easy to remember names to your tinc daemon(s). 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. You could try things like hostnames, owner surnames or location names.
However, you are only allowed to use alphanumerical characters (a-z, A-Z, and 0-9) and underscores (_) in the name.
.Sh INITIAL CONFIGURATION
If you have not configured tinc yet, you can easily create a basic configuration using the following command:
.Bd -literal -offset indent
.Nm tincctl Fl n Ar NETNAME Li init Ar NAME
.Ed
.Pp
You can further change the configuration as needed either by manually editing the configuration files,
or by using
.Xr tincctl 8 .
.Sh PUBLIC/PRIVATE KEYS .Sh PUBLIC/PRIVATE KEYS
You should use The
.Ic tincd -K .Nm tincctl Li init
to generate public/private keypairs. command will have generated both RSA and ECDSA public/private keypairs.
It will generate two keys. The private keys should be stored in files named
The private key should be stored in a separate file .Pa rsa_key.priv
.Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /rsa_key.priv and
\-\- where .Pa ecdsa_key.priv
.Ar NETNAME in the directory
stands for the network (see .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /
.Sx NETWORKS ) The public keys should be stored in the host configuration file
above. .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Va NAME .
The public key should be stored in the host configuration file
.Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Va NAME The RSA keys are used for backwards compatibility with tinc version 1.0.
\-\- where If you are upgrading from version 1.0 to 1.1, you can keep the old configuration files,
.Va NAME but you will need to create ECDSA keys using the following command:
stands for the name of the local tinc daemon (see .Bd -literal -offset indent
.Sx NAMES ) . .Nm tincctl Fl n Ar NETNAME Li generate-ecdsa-keys
.Ed
.Sh SERVER CONFIGURATION .Sh SERVER CONFIGURATION
The server configuration of the daemon is done in the file The server configuration of the daemon is done in the file
@ -117,6 +114,11 @@ Although all configuration options for the local host listed in this document ca
it is recommended to put host specific configuration options in the host configuration file, it is recommended to put host specific configuration options in the host configuration file,
as this makes it easy to exchange with other nodes. as this makes it easy to exchange with other nodes.
.Pp
You can edit the config file manually, but it is recommended that you use
.Xr tincctl 8
to change configuration variables for you.
.Pp .Pp
Here are all valid variables, listed in alphabetical order. Here are all valid variables, listed in alphabetical order.
The default value is given between parentheses. The default value is given between parentheses.
@ -129,7 +131,7 @@ If
is selected, then depending on the operating system both IPv4 and IPv6 or just is selected, then depending on the operating system both IPv4 and IPv6 or just
IPv6 listening sockets will be created. IPv6 listening sockets will be created.
.It Va BindToAddress Li = Ar address Oo Ar port Oc Bq experimental .It Va BindToAddress Li = Ar address Oo Ar port
If your computer has more than one IPv4 or IPv6 address, If your computer has more than one IPv4 or IPv6 address,
.Nm tinc .Nm tinc
will by default listen on all of them for incoming connections. will by default listen on all of them for incoming connections.
@ -147,8 +149,6 @@ To only bind to a specific port but not to a specific address, use
.Li * .Li *
for the for the
.Ar address . .Ar address .
.Pp
This option may not work on all platforms.
.It Va BindToInterface Li = Ar interface Bq experimental .It Va BindToInterface Li = Ar interface Bq experimental
If your computer has more than one network interface, If your computer has more than one network interface,
@ -158,6 +158,8 @@ It is possible to bind only to a single interface with this variable.
.Pp .Pp
This option may not work on all platforms. This option may not work on all platforms.
Also, on some platforms it will not actually bind to an interface,
but rather to the address that the interface has at the moment a socket is created.
.It Va Broadcast Li = no | mst | direct Po mst Pc Bq experimental .It Va Broadcast Li = no | mst | direct Po mst Pc Bq experimental
This option selects the way broadcast packets are sent to other daemons. This option selects the way broadcast packets are sent to other daemons.
@ -334,7 +336,7 @@ This is less efficient, but allows the kernel to apply its routing and firewall
and can also help debugging. and can also help debugging.
.El .El
.It Va GraphDumpFile Li = Ar filename Bq experimental .It Va GraphDumpFile Li = Ar filename
If this option is present, If this option is present,
.Nm tinc .Nm tinc
will dump the current network graph to the file will dump the current network graph to the file
@ -373,7 +375,7 @@ This option controls the period the encryption keys used to encrypt the data are
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 LocalDiscovery Li = yes | no Po no Pc Bq experimental .It Va LocalDiscovery Li = yes | no Pq no
When enabled, When enabled,
.Nm tinc .Nm tinc
will try to detect peers that are on the same local network. will try to detect peers that are on the same local network.
@ -468,7 +470,9 @@ or
specified in the configuration file. specified in the configuration file.
.It Va ProcessPriority Li = low | normal | high .It Va ProcessPriority Li = low | normal | high
When this option is used the priority of the tincd process will be adjusted. When this option is used the priority of the
.Nm tincd
process will be adjusted.
Increasing the priority may help to reduce latency and packet loss on the VPN. Increasing the priority may help to reduce latency and packet loss on the VPN.
.It Va Proxy Li = socks4 | socks5 | http | exec Ar ... Bq experimental .It Va Proxy Li = socks4 | socks5 | http | exec Ar ... Bq experimental
@ -753,6 +757,10 @@ When a subnet becomes (un)reachable, this is set to the subnet.
When a subnet becomes (un)reachable, this is set to the subnet weight. When a subnet becomes (un)reachable, this is set to the subnet weight.
.El .El
.Pp
Do not forget that under UNIX operating systems, you have to make the scripts executable, using the command
.Nm chmod Li a+x Pa script .
.Sh FILES .Sh FILES
The most important files are: The most important files are:
.Bl -tag -width indent .Bl -tag -width indent
@ -780,6 +788,7 @@ its connection to the virtual network device.
.Sh SEE ALSO .Sh SEE ALSO
.Xr tincd 8 , .Xr tincd 8 ,
.Xr tincctl 8 ,
.Pa http://www.tinc-vpn.org/ , .Pa http://www.tinc-vpn.org/ ,
.Pa http://www.linuxdoc.org/LDP/nag2/ . .Pa http://www.linuxdoc.org/LDP/nag2/ .

251
doc/tinc.texi
View file

@ -639,7 +639,6 @@ tinc 655/udp TINC
* Multiple networks:: * Multiple networks::
* How connections work:: * How connections work::
* Configuration files:: * Configuration files::
* Generating keypairs::
* Network interfaces:: * Network interfaces::
* Example configuration:: * Example configuration::
@end menu @end menu
@ -666,9 +665,15 @@ A good resource on networking is the
If you have everything clearly pictured in your mind, If you have everything clearly pictured in your mind,
proceed in the following order: proceed in the following order:
First, generate the configuration files (@file{tinc.conf}, your host configuration file, @file{tinc-up} and perhaps @file{tinc-down}). First, create the initial configuration files and public/private keypairs using the following command:
Then generate the keypairs. @example
Finally, distribute the host configuration files. tincctl -n @var{NETNAME} init @var{NAME}
@end example
Second, use @samp{tincctl -n @var{NETNAME} config ...} to further configure tinc.
Finally, export your host configuration file using @samp{tincctl -n @var{NETNAME} export} and send it to those
people or computers you want tinc to connect to.
They should send you their host configuration file back, which you can import using @samp{tincctl -n @var{NETNAME} import}.
These steps are described in the subsections below. These steps are described in the subsections below.
@ -678,30 +683,29 @@ These steps are described in the subsections below.
@cindex multiple networks @cindex multiple networks
@cindex netname @cindex netname
In order to allow you to run more than one tinc daemon on one computer, In order to allow you to run more than one tinc daemon on one computer,
for instance if your computer is part of more than one VPN, for instance if your computer is part of more than one VPN,
you can assign a @var{netname} to your VPN. you can assign a @var{netname} to your VPN.
It is not required if you only run one tinc daemon, It is not required if you only run one tinc daemon,
it doesn't even have to be the same on all the sites of your VPN, it doesn't even have to be the same on all the nodes of your VPN,
but it is recommended that you choose one anyway. but it is recommended that you choose one anyway.
We will asume you use a netname throughout this document. We will asume you use a netname throughout this document.
This means that you call tincd with the -n argument, This means that you call tincctl with the -n argument,
which will assign a netname to this daemon. which will specify the netname.
The effect of this is that the daemon will set its configuration The effect of this option is that tinc will set its configuration
root to @file{@value{sysconfdir}/tinc/@var{netname}/}, where @var{netname} is your argument to the -n root to @file{@value{sysconfdir}/tinc/@var{netname}/}, where @var{netname} is your argument to the -n option.
option. You'll notice that it appears in syslog as @file{tinc.@var{netname}}. You will also notice that log messages it appears in syslog as coming from @file{tinc.@var{netname}},
and on Linux, unless specified otherwise, the name of the virtual network interface will be the same as the network name.
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. If you don not use it, the network name will just be empty, and
be used as such. tinc now looks for files in @file{@value{sysconfdir}/tinc/}, instead of tinc will look for files in @file{@value{sysconfdir}/tinc/} instead of
@file{@value{sysconfdir}/tinc/@var{netname}/}; the configuration file should be @file{@value{sysconfdir}/tinc/tinc.conf}, @file{@value{sysconfdir}/tinc/@var{netname}/};
and the host configuration files are now expected to be in @file{@value{sysconfdir}/tinc/hosts/}. the configuration file will then be @file{@value{sysconfdir}/tinc/tinc.conf},
and the host configuration files are expected to be in @file{@value{sysconfdir}/tinc/hosts/}.
But it is highly recommended that you use this feature of tinc, because
it will be so much clearer whom your daemon talks to. Hence, we will
assume that you use it.
@c ================================================================== @c ==================================================================
@ -728,6 +732,25 @@ If you wish, you can view a tinc daemon without a `ConnectTo' value as a server,
and one which does specify such a value as a client. and one which does specify such a value as a client.
It does not matter if two tinc daemons have a `ConnectTo' value pointing to each other however. It does not matter if two tinc daemons have a `ConnectTo' value pointing to each other however.
Connections specified using `ConnectTo' are so-called meta-connections.
Tinc daemons exchange information about all other daemon they know about via these meta-connections.
After learning about all the daemons in the VPN,
tinc will create other connections as necessary in order to communicate with them.
For example, if there are three daemons named A, B and C, and A has @samp{ConnectTo = B} in its tinc.conf file,
and C has @samp{ConnectTo = B} in its tinc.conf file, then A will learn about C from B,
and will be able to exchange VPN packets with C without the need to have @samp{ConnectTo = C} in its tinc.conf file.
It could be that some daemons are located behind a Network Address Translation (NAT) device, or behind a firewall.
In the above scenario with three daemons, if A and C are behind a NAT,
B will automatically help A and C punch holes through their NAT,
in a way similar to the STUN protocol, so that A and C can still communicate with each other directly.
It is not always possible to do this however, and firewalls might also prevent direct communication.
In that case, VPN packets between A and C will be forwarded by B.
In effect, all nodes in the VPN will be able to talk to each other, as long as
their is a path of meta-connections between them, and whenever possible, two
nodes will communicate with each other directly.
@c ================================================================== @c ==================================================================
@node Configuration files @node Configuration files
@ -756,7 +779,10 @@ listed in this document can also be put in
put host specific configuration options in the host configuration file, as this put host specific configuration options in the host configuration file, as this
makes it easy to exchange with other nodes. makes it easy to exchange with other nodes.
In this section all valid variables are listed in alphabetical order. You can edit the config file manually, but it is recommended that you use
tincctl to change configuration variables for you.
In the following two subsections 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. other comments are between square brackets.
@ -780,7 +806,7 @@ 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 = <@var{address}> [<@var{port}>] [experimental] @item BindToAddress = <@var{address}> [<@var{port}>]
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.
Multiple BindToAddress variables may be specified, Multiple BindToAddress variables may be specified,
@ -790,8 +816,6 @@ If no @var{port} is specified, the socket will be bound to the port specified by
or to port 655 if neither is given. or to port 655 if neither is given.
To only bind to a specific port but not to a specific address, use "*" for the @var{address}. To only bind to a specific port but not to a specific address, use "*" for the @var{address}.
This option may not work on all platforms.
@cindex BindToInterface @cindex BindToInterface
@item BindToInterface = <@var{interface}> [experimental] @item BindToInterface = <@var{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
@ -800,6 +824,8 @@ possible to bind tinc to a single interface like eth0 or ppp0 with this
variable. variable.
This option may not work on all platforms. This option may not work on all platforms.
Also, on some platforms it will not actually bind to an interface,
but rather to the address that the interface has at the moment a socket is created.
@cindex Broadcast @cindex Broadcast
@item Broadcast = <no | mst | direct> (mst) [experimental] @item Broadcast = <no | mst | direct> (mst) [experimental]
@ -965,7 +991,7 @@ and can also help debugging.
@end table @end table
@cindex GraphDumpFile @cindex GraphDumpFile
@item GraphDumpFile = <@var{filename}> [experimental] @item GraphDumpFile = <@var{filename}>
If this option is present, If this option is present,
tinc will dump the current network graph to the file @var{filename} tinc will dump the current network graph to the file @var{filename}
every minute, unless there were no changes to the graph. every minute, unless there were no changes to the graph.
@ -992,7 +1018,7 @@ Under Windows, this variable is used to select which network interface will be u
If you specified a Device, this variable is almost always already correctly set. If you specified a Device, this variable is almost always already correctly set.
@cindex LocalDiscovery @cindex LocalDiscovery
@item LocalDiscovery = <yes | no> (no) [experimental] @item LocalDiscovery = <yes | no> (no)
When enabled, tinc will try to detect peers that are on the same local network. When enabled, tinc will try to detect peers that are on the same local network.
This will allow direct communication using LAN addresses, even if both peers are behind a NAT This will allow direct communication using LAN addresses, even if both peers are behind a NAT
and they only ConnectTo a third node outside the NAT, and they only ConnectTo a third node outside the NAT,
@ -1369,50 +1395,115 @@ When a subnet becomes (un)reachable, this is set to the subnet.
@node How to configure @node How to configure
@subsection How to configure @subsection How to configure
@subsubheading Step 1. Creating the main configuration file @subsubheading Step 1. Creating initial configuration files.
The main configuration file will be called @file{@value{sysconfdir}/tinc/@var{netname}/tinc.conf}. The initial directory structure, configuration files and public/private keypairs are created using the following command:
Adapt the following example to create a basic configuration file:
@example @example
Name = @var{yourname} tincctl -n @var{netname} init @var{name}
Device = @file{/dev/tap0}
@end example @end example
Then, if you know to which other tinc daemon(s) yours is going to connect, (You will need to run this as root, or use "sudo".)
add `ConnectTo' values. This will create the configuration directory @file{@value{sysconfdir}/tinc/@var{netname}.},
and inside it will create another directory named @file{hosts/}.
@subsubheading Step 2. Creating your host configuration file In the configuration directory, it will create the file @file{tinc.conf} with the following contents:
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/@var{netname}/hosts/yourname}.
Adapt the following example to create a host configuration file:
@example @example
Address = your.real.hostname.org Name = @var{name}
Subnet = 192.168.1.0/24
@end example @end example
You can also use an IP address instead of a hostname. It will also create private RSA and ECDSA keys, which will be stored in the files @file{rsa_key.priv} and @file{ecdsa_key.priv}.
The `Subnet' specifies the address range that is local for @emph{your part of the VPN only}. It will also create a host configuration file @file{hosts/@var{name}},
If you have multiple address ranges you can specify more than one `Subnet'. which will contain the corresponding public RSA and ECDSA keys.
You might also need to add a `Port' if you want your tinc daemon to run on a different port number than the default (655).
Finally, on UNIX operating systems, it will create an executable script @file{tinc-up},
which will initially not do anything except warning that you should edit it.
@c ================================================================== @subsubheading Step 2. Modifying the initial configuration.
@node Generating keypairs
@section Generating keypairs
@cindex key generation Unless you want to use tinc in switch mode,
Now that you have already created the main configuration file and your host configuration file, you should now configure which range of addresses you will use on the VPN.
you can easily create a public/private keypair by entering the following command: Let's assume you will be part of a VPN which uses the address range 192.168.0.0/16,
and you yourself have a smaller portion of that range: 192.168.2.0/24.
Then you should run the following command:
@example @example
tincctl -n @var{netname} generate-keys tincctl -n @var{netname} config add subnet 192.168.2.0/24
@end example @end example
Tinc will generate a public and a private key and ask you where to put them. This will add a Subnet statement to your host configuration file.
Just press enter to accept the defaults. Try opening the file @file{@value{sysconfdir}/tinc/@var{netname}/hosts/@var{name}} in an editor.
You should now see a file containing the public RSA and ECDSA keys (which looks like a bunch of random characters),
and the following line at the bottom:
@example
Subnet = 192.168.2.0/24
@end example
If you will use more than one address range, you can add more Subnets.
For example, if you also use the IPv6 subnet fec0:0:0:2::/64, you can add it as well:
@example
tincctl -n @var{netname} config add subnet fec0:0:0:2::/24
@end example
This will add another line to the file @file{hosts/@var{name}}.
If you make a mistake, you can undo it by simply using @samp{config del} instead of @samp{config add}.
If you want other tinc daemons to create meta-connections to your daemon,
you should add your public IP address or hostname to your host configuration file.
For example, if your hostname is foo.example.org, run:
@example
tincctl -n @var{netname} config add address foo.example.org
@end example
If you already know to which daemons your daemon should make meta-connections,
you should configure that now as well.
Suppose you want to connect to a daemon named "bar", run:
@example
tincctl -n @var{netname} config add connectto bar
@end example
Note that you specify the Name of the other daemon here, not an IP address or hostname!
When you start tinc, and it tries to make a connection to "bar",
it will look for a host configuration file named @file{hosts/bar},
and will read Address statements and public keys from that file.
@subsubheading Step 2. Exchanging configuration files.
If your daemon has a ConnectTo = bar statement in its @file{tinc.conf} file,
or if bar has a ConnectTo your daemon, then you both need each other's host configuration files.
You should send @file{hosts/@var{name}} to bar, and bar should send you his file which you should move to @file{hosts/bar}.
If you are on a UNIX platform, you can easily send an email containing the necessary information using the following command
(assuming the owner of bar has the email address bar@@example.org):
@example
tincctl -n @var{netname} export | mail -s "My config file" bar@@example.org
@end example
If the owner of bar does the same to send his host configuration file to you,
you can probably pipe his email through the following command,
or you can just start this command in a terminal and copy&paste the email:
@example
tincctl -n @var{netname} import
@end example
If you are the owner of bar yourself, and you have SSH access to that computer,
you can also swap the host configuration files using the following commands:
@example
tincctl -n @var{netname} export | ssh bar.example.org tincctl -n @var{netname} import
ssh bar.example.org tincctl -n @var{netname} export | tincctl -n @var{netname} import
@end example
You should repeat this for all nodes you ConnectTo, or which ConnectTo you.
However, remember that you do not need to ConnectTo all nodes in the VPN;
it is only necessary to create one or a few meta-connections,
after the connections are made tinc will learn about all the other nodes in the VPN,
and will automatically make other connections as necessary.
@c ================================================================== @c ==================================================================
@ -1435,21 +1526,31 @@ You can configure the network interface by putting ordinary ifconfig, route, and
to a script named @file{@value{sysconfdir}/tinc/@var{netname}/tinc-up}. 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 When tinc starts, this script will be executed. When tinc exits, it will execute the script named
@file{@value{sysconfdir}/tinc/@var{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.
You can manually open the script in an editor, or use the following command:
An example @file{tinc-up} script: @example
tincctl -n @var{netname} edit tinc-up
@end example
An example @file{tinc-up} script, that would be appropriate for the scenario in the previous section, is:
@example @example
#!/bin/sh #!/bin/sh
ifconfig $INTERFACE 192.168.1.1 netmask 255.255.0.0 ifconfig $INTERFACE 192.168.2.1 netmask 255.255.0.0
ip addr add fec0:0:0:2::/48 dev $INTERFACE
@end example @end example
This script gives the interface an IP address and a netmask. The first command gives the interface an IPv4 address and a netmask.
The kernel will also automatically add a route to this interface, so normally you don't need The kernel will also automatically add an IPv4 route to this interface, so normally you don't need
to add route commands to the @file{tinc-up} script. to add route commands to the @file{tinc-up} script.
The kernel will also bring the interface up after this command. The kernel will also bring the interface up after this command.
@cindex netmask @cindex netmask
The netmask is the mask of the @emph{entire} VPN network, not just your The netmask is the mask of the @emph{entire} VPN network, not just your
own subnet. own subnet.
The second command gives the interface an IPv6 address and netmask,
which will also automatically add an IPv6 route.
If you only want to use "ip addr" commands on Linux, don't forget that it doesn't bring the interface up, unlike ifconfig,
so you need to add @samp{ip link set $INTERFACE up} in that case.
The exact syntax of the ifconfig and route commands differs from platform to platform. 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 @ref{Platform specific information}, You can look up the commands for setting addresses and adding routes in @ref{Platform specific information},
@ -1489,6 +1590,9 @@ the real interface is also shown as a comment, to give you an idea of
how these example host is set up. All branches use the netname `company' how these example host is set up. All branches use the netname `company'
for this particular VPN. for this particular VPN.
Each branch is set up using the @samp{tincctl init} and @samp{tincctl config} commands,
here we just show the end results:
@subsubheading For Branch A @subsubheading For Branch A
@emph{BranchA} would be configured like this: @emph{BranchA} would be configured like this:
@ -1496,6 +1600,8 @@ for this particular VPN.
In @file{@value{sysconfdir}/tinc/company/tinc-up}: In @file{@value{sysconfdir}/tinc/company/tinc-up}:
@example @example
#!/bin/sh
# Real interface of internal network: # Real interface of internal network:
# ifconfig eth0 10.1.54.1 netmask 255.255.0.0 # ifconfig eth0 10.1.54.1 netmask 255.255.0.0
@ -1506,7 +1612,6 @@ and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
@example @example
Name = BranchA Name = BranchA
Device = /dev/tap0
@end example @end example
On all hosts, @file{@value{sysconfdir}/tinc/company/hosts/BranchA} contains: On all hosts, @file{@value{sysconfdir}/tinc/company/hosts/BranchA} contains:
@ -1520,9 +1625,9 @@ Address = 1.2.3.4
-----END RSA PUBLIC KEY----- -----END RSA PUBLIC KEY-----
@end example @end example
Note that the IP addresses of eth0 and tap0 are the same. Note that the IP addresses of eth0 and the VPN interface are the same.
This is quite possible, if you make sure that the netmasks of the interfaces are different. This is quite possible, if you make sure that the netmasks of the interfaces are different.
It is in fact recommended to give both real internal network interfaces and tap interfaces the same IP address, It is in fact recommended to give both real internal network interfaces and VPN interfaces the same IP address,
since that will make things a lot easier to remember and set up. since that will make things a lot easier to remember and set up.
@ -1531,6 +1636,8 @@ since that will make things a lot easier to remember and set up.
In @file{@value{sysconfdir}/tinc/company/tinc-up}: In @file{@value{sysconfdir}/tinc/company/tinc-up}:
@example @example
#!/bin/sh
# Real interface of internal network: # Real interface of internal network:
# ifconfig eth0 10.2.43.8 netmask 255.255.0.0 # ifconfig eth0 10.2.43.8 netmask 255.255.0.0
@ -1545,7 +1652,7 @@ ConnectTo = BranchA
@end example @end example
Note here that the internal address (on eth0) doesn't have to be the Note here that the internal address (on eth0) doesn't have to be the
same as on the tap0 device. Also, ConnectTo is given so that this node will same as on the VPN interface. Also, ConnectTo is given so that this node will
always try to connect to BranchA. always try to connect to BranchA.
On all hosts, in @file{@value{sysconfdir}/tinc/company/hosts/BranchB}: On all hosts, in @file{@value{sysconfdir}/tinc/company/hosts/BranchB}:
@ -1565,6 +1672,8 @@ Address = 2.3.4.5
In @file{@value{sysconfdir}/tinc/company/tinc-up}: In @file{@value{sysconfdir}/tinc/company/tinc-up}:
@example @example
#!/bin/sh
# Real interface of internal network: # Real interface of internal network:
# ifconfig eth0 10.3.69.254 netmask 255.255.0.0 # ifconfig eth0 10.3.69.254 netmask 255.255.0.0
@ -1576,7 +1685,6 @@ and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
@example @example
Name = BranchC Name = BranchC
ConnectTo = BranchA ConnectTo = BranchA
Device = /dev/tap1
@end example @end example
C already has another daemon that runs on port 655, so they have to C already has another daemon that runs on port 655, so they have to
@ -1601,6 +1709,8 @@ Port = 2000
In @file{@value{sysconfdir}/tinc/company/tinc-up}: In @file{@value{sysconfdir}/tinc/company/tinc-up}:
@example @example
#!/bin/sh
# Real interface of internal network: # Real interface of internal network:
# ifconfig eth0 10.4.3.32 netmask 255.255.0.0 # ifconfig eth0 10.4.3.32 netmask 255.255.0.0
@ -1612,14 +1722,10 @@ and in @file{@value{sysconfdir}/tinc/company/tinc.conf}:
@example @example
Name = BranchD Name = BranchD
ConnectTo = BranchC ConnectTo = BranchC
Device = /dev/net/tun
@end example @end example
D will be connecting to C, which has a tincd running for this network on D will be connecting to C, which has a tincd running for this network on
port 2000. It knows the port number from the host configuration file. port 2000. It knows the port number from the host configuration file.
Also note that since D uses the tun/tap driver, the network interface
will not be called `tun' or `tap0' or something like that, but will
have the same name as netname.
On all hosts, in @file{@value{sysconfdir}/tinc/company/hosts/BranchD}: On all hosts, in @file{@value{sysconfdir}/tinc/company/hosts/BranchD}:
@ -1634,16 +1740,11 @@ Address = 4.5.6.7
@subsubheading Key files @subsubheading Key files
A, B, C and D all have generated a public/private keypair with the following command: A, B, C and D all have their own public/private keypairs:
@example The private RSA key is stored in @file{@value{sysconfdir}/tinc/company/rsa_key.priv},
tincctl -n company generate-keys the private ECDSA key is stored in @file{@value{sysconfdir}/tinc/company/ecdsa_key.priv},
@end example and the public RSA and ECDSA keys are put into the host configuration file in the @file{@value{sysconfdir}/tinc/company/hosts/} directory.
The private key is stored in @file{@value{sysconfdir}/tinc/company/rsa_key.priv},
the public key is put into the host configuration file in the @file{@value{sysconfdir}/tinc/company/hosts/} directory.
During key generation, tinc automatically guesses the right filenames based on the -n option and
the Name directive in the @file{tinc.conf} file (if it is available).
@subsubheading Starting @subsubheading Starting
@ -1660,7 +1761,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 @var{netname} tincctl -n @var{netname} start
@end example @end example
@cindex daemon @cindex daemon