[tinc] / doc / tinc.conf.5
1 .Dd 2002-02-06
3 .\" Manual page created by:
4 .\" Ivo Timmermans <itimmermans@bigfoot.com>
5 .\" Guus Sliepen <guus@sliepen.warande.net>
6 .Sh NAME
7 .Nm tinc.conf
8 .Nd tinc daemon configuration
10 The files in the
11 .Pa /etc/tinc/
12 directory contain runtime and security information for the tinc daemon.
14 It is perfectly ok for you to run more than one tinc daemon.
15 However, in its default form,
16 you will soon notice that you can't use two different configuration files without the
17 .Fl c
18 option.
19 .Pp
20 We have thought of another way of dealing with this: network names.
21 This means that you call
22 .Nm
23 with the
24 .Fl n
25 option, which will assign a name to this daemon.
26 .Pp
27 The effect of this is that the daemon will set its configuration root to
28 .Pa /etc/tinc/ Ns Ar NETNAME Ns Pa / ,
29 where 
31 is your argument to the
32 .Fl n
33 option.
34 You'll notice that messages appear in syslog as coming from
35 .Nm tincd. Ns Ar NETNAME .
36 .Pp
37 However, it is not strictly necessary that you call tinc with the
38 .Fl n
39 option.
40 In this case, the network name would just be empty,
41 and it will be used as such.
42 .Nm tinc
43 now looks for files in
44 .Pa /etc/tinc/ ,
45 instead of 
46 .Pa /etc/tinc/ Ns Ar NETNAME Ns Pa / ;
47 the configuration file should be
48 .Pa /etc/tinc/tinc.conf ,
49 and the host configuration files are now expected to be in
50 .Pa /etc/tinc/hosts/ .
51 .Pp
52 But it is highly recommended that you use this feature of
53 .Nm tinc ,
54 because it will be so much clearer whom your daemon talks to.
55 Hence, we will assume that you use it.
56 .Sh NAMES
57 Each tinc daemon should have a name that is unique in the network which it will be part of.
58 The name will be used by other tinc daemons for identification.
59 The name has to be declared in the
60 .Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf
61 file.
62 .Pp
63 To make things easy,
64 choose something that will give unique and easy to remember names to your tinc daemon(s).
65 You could try things like hostnames, owner surnames or location names.
67 You should use 
68 .Ic tincd -K
69 to generate public/private keypairs.
70 It will generate two keys.
71 The private key should be stored in a separate file
72 .Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /rsa_key.priv
73 \-\- where 
75 stands for the network (see 
77 above.
78 The public key should be stored in the host configuration file
79 .Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Va NAME
80 \-\- where
81 .Va NAME
82 stands for the name of the local tinc daemon (see
83 .Sx NAMES ) .
85 The server configuration of the daemon is done in the file
86 .Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf .
87 This file consists of comments (lines started with a
88 .Li # )
89 or assignments in the form of:
90 .Pp
91 .Va Variable Li = Ar Value .
92 .Pp
93 The variable names are case insensitive, and any spaces, tabs,
94 newlines and carriage returns are ignored.
95 Note: it is not required that you put in the 
96 .Li =
97 sign, but doing so improves readability.
98 If you leave it out, remember to replace it with at least one space character.
99 .Pp
100 Here are all valid variables, listed in alphabetical order.
101 The default value is given between parentheses.
102 .Bl -tag -width indent
103 .It Va AddressFamily Li = ipv4 | ipv6 | any Po ipv4 Pc Bq experimental
104 This option affects the address family of listening and outgoing sockets.
105 If
106 .Qq any
107 is selected, then depending on the operating system both IPv4 and IPv6 or just
108 IPv6 listening sockets will be created.
109 .Pp
110 Mixing IPv4 and IPv6 may not work as desired.
111 It's best to choose one address family and use that for all tinc daemons on the VPN.
112 .It Va BindToInterface Li = Ar interface Bq experimental
113 If your computer has more than one network interface,
114 .Nm tinc
115 will by default listen on all of them for incoming connections.
116 It is possible to bind only to a single interface with this variable.
117 .Pp
118 This option may not work on all platforms.
119 .It Va BindToIP Li = Ar address Bq experimental
120 If your computer has more than one IP address on a single interface
121 (for example if you are running virtual hosts),
122 .Nm tinc
123 will by default listen on all of them for incoming connections.
124 It is possible to bind only to a single IP address with this variable.
125 It is still possible to listen on several interfaces at the same time though,
126 if they share the same IP address.
127 .Pp
128 This option may not work on all platforms.
129 .It Va ConnectTo Li = Ar name
130 Specifies which other tinc daemon to connect to on startup.
131 Multiple
132 .Va ConnectTo
133 variables may be specified,
134 in which case outgoing connections to each specified tinc daemon are made.
135 The names should be known to this tinc daemon
136 (i.e., there should be a host configuration file for the name on the
137 .Va ConnectTo
138 line).
139 .Pp
140 If you don't specify a host with
141 .Va ConnectTo ,
142 .Nm tinc
143 won't try to connect to other daemons at all,
144 and will instead just listen for incoming connections.
145 .It Va Device Li = Ar device Po /dev/tap0 or /dev/misc/net/tun Pc
146 The virtual network device to use.
147 .Nm tinc
148 will automatically detect what kind of device it is.
149 Note that you can only use one device per daemon.
150 The info pages of the tinc package contain more information
151 about configuring the virtual network device.
152 .It Va Hostnames Li = yes | no Pq no
153 This option selects whether IP addresses (both real and on the VPN) should
154 be resolved. Since DNS lookups are blocking, it might affect tinc's
155 efficiency, even stopping the daemon for a few seconds every time it does
156 a lookup if your DNS server is not responding.
157 .Pp
158 This does not affect resolving hostnames to IP addresses from the
159 host configuration files.
160 .It Va Interface Li = Ar interface
161 Defines the name of the interface corresponding to the virtual network device.
162 Depending on the operating system and the type of device this may or may not actually set the name.
163 Currently this option only affects the Linux tun/tap device.
164 .It Va KeyExpire Li = Ar period Pq 3600
165 This option controls the period the encryption keys used to encrypt the data are valid.
166 It is common practice to change keys at regular intervals to make it even harder for crackers,
167 even though it is thought to be nearly impossible to crack a single key.
168 .It Va MACExpire Li = Ar period Pq 600
169 This option controls the amount of time MAC addresses are kept before they are removed.
170 This only has effect when
171 .Va Mode
172 is set to
173 .Qq switch .
174 .It Va MaxTimeout Li = Ar period Pq 900
175 This is the maximum delay before trying to reconnect to other tinc daemons.
176 .It Va Mode Li = router | switch | hub Pq router
177 This option selects the way packets are routed to other daemons.
178 .Bl -tag -width indent
179 .It router
180 In this mode
181 .Va Subnet
182 variables in the host configuration files will be used to form a routing table.
183 Only unicast packets of routable protocols (IPv4 and IPv6) are supported in this mode.
184 .It switch
185 In this mode the MAC addresses of the packets on the VPN will be used to
186 dynamically create a routing table just like an Ethernet switch does.
187 Unicast, multicast and broadcast packets of every protocol that runs over Ethernet are supported in this mode
188 at the cost of frequent broadcast ARP requests and routing table updates.
189 .It hub
190 This mode is almost the same as the switch mode, but instead
191 every packet will be broadcast to the other daemons
192 while no routing table is managed.
193 .El
194 .It Va Name Li = Ar name Bq required
195 This is the name which identifies this tinc daemon.
196 It must be unique for the virtual private network this daemon will connect to.
197 .It Va PingTimeout Li = Ar period Pq 60
198 The number of seconds of inactivity that
199 .Nm tinc
200 will wait before sending a probe to the other end.
201 If that other end doesn't answer within that same amount of time,
202 the connection is terminated,
203 and the others will be notified of this.
204 .It Va PriorityInheritance Li = yes | no Po no Pc Bq experimental
205 When this option is enabled the value of the TOS field of tunneled IPv4 packets
206 will be inherited by the UDP packets that are sent out.
207 .It Va PrivateKey Li = Ar key Bq obsolete
208 The private RSA key of this tinc daemon.
209 It will allow this tinc daemon to authenticate itself to other daemons.
210 .It Va PrivateKeyFile Li = Ar filename Bq recommended
211 The file in which the private RSA key of this tinc daemon resides.
212 Note that there must be exactly one of
213 .Va PrivateKey
214 or
215 .Va PrivateKeyFile
216 specified in the configuration file.
217 .El
219 The host configuration files contain all information needed
220 to establish a connection to those hosts.
221 A host configuration file is also required for the local tinc daemon,
222 it will use it to read in it's listen port, public key and subnets.
223 .Pp
224 The idea is that these files are portable.
225 You can safely mail your own host configuration file to someone else.
226 That other person can then copy it to his own hosts directory,
227 and now his tinc daemon will be able to connect to your tinc daemon.
228 Since host configuration files only contain public keys,
229 no secrets are revealed by sending out this information.
230 .Bl -tag -width indent
231 .It Va Address Li = Ar address Bq recommended
232 The IP address or hostname of this tinc daemon on the real network.
233 This wil only be used when trying to make an outgoing connection to this tinc daemon.
234 Multiple
235 .Va Address
236 variables can be specified, in which case each address will be tried until a working
237 connection has been established.
238 .It Va Cipher Li = Ar cipher Pq blowfish
239 The symmetric cipher algorithm used to encrypt UDP packets.
240 Any cipher supported by OpenSSL is recognised.
241 Furthermore, specifying
242 .Qq none
243 will turn off packet encryption.
244 .It Va Compression Li = Ar level Pq 0
245 This option sets the level of compression used for UDP packets.
246 Possible values are 0 (off), 1 (fast) and any integer up to 9 (best).
247 .It Va Digest Li = Ar digest Pq sha1
248 The digest algorithm used to authenticate UDP packets.
249 Any digest supported by OpenSSL is recognised.
250 Furthermore, specifying
251 .Qq none
252 will turn off packet authentication.
253 .It Va IndirectData Li = yes | no Po no Pc Bq experimental
254 This option specifies whether other tinc daemons besides the one you specified with
255 .Va ConnectTo
256 can make a direct connection to you.
257 This is especially useful if you are behind a firewall
258 and it is impossible to make a connection from the outside to your tinc daemon.
259 Otherwise, it is best to leave this option out or set it to no.
260 .It Va MACLength Li = Ar length Pq 4
261 The length of the message authentication code used to authenticate UDP packets.
262 Can be anything from
263 .Qq 0
264 up to the length of the digest produced by the digest algorithm.
265 .It Va Port Li = Ar port Pq 655
266 The port number on which this tinc daemon is listening for incoming connections.
267 .It Va PublicKey Li = Ar key Bq obsolete
268 The public RSA key of this tinc daemon.
269 It will be used to cryptographically verify it's identity and to set up a secure connection.
270 .It Va PublicKeyFile Li = Ar filename Bq obsolete
271 The file in which the public RSA key of this tinc daemon resides.
272 .Pp
273 From version 1.0pre4 on
274 .Nm tinc
275 will store the public key directly into the host configuration file in PEM format,
276 the above two options then are not necessary.
277 Either the PEM format is used, or exactly one of the above two options must be specified
278 in each host configuration file,
279 if you want to be able to establish a connection with that host.
280 .It Va Subnet Li = Ar address Ns Op Li / Ns Ar masklength
281 The subnet which this tinc daemon will serve.
282 .Nm tinc
283 tries to look up which other daemon it should send a packet to by searching the appropriate subnet.
284 If the packet matches a subnet,
285 it will be sent to the daemon who has this subnet in his host configuration file.
286 Multiple
287 .Va Subnet
288 variables can be specified.
289 .Pp
290 Subnets can either be single MAC, IPv4 or IPv6 addresses,
291 in which case a subnet consisting of only that single address is assumed,
292 or they can be a IPv4 or IPv6 network address with a masklength.
293 Shorthand notations are not supported.
294 For example, IPv4 subnets must be in a form like,
295 where is the network address and 24 is the number of bits set in the netmask.
296 Note that subnets like are invalid!
297 Read a networking HOWTO/FAQ/guide if you don't understand this.
298 IPv6 subnets are notated like fec0:0:0:1:0:0:0:0/64.
299 MAC addresses are notated like 0:1a:2b:3c:4d:5e.
300 .It Va TCPOnly Li = yes | no Po no Pc Bq experimental
301 If this variable is set to yes,
302 then the packets are tunnelled over the TCP connection instead of a UDP connection.
303 This is especially useful for those who want to run a tinc daemon
304 from behind a masquerading firewall,
305 or if UDP packet routing is disabled somehow.
306 This is experimental code, try this at your own risk.
307 It may not work at all.
308 Setting this options also implicitly sets IndirectData.
309 .El
310 .Sh FILES
311 .Bl -tag -width indent
312 .It Pa /etc/tinc/
313 The top directory for configuration files.
314 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf
315 The default name of the server configuration file for net
316 .Ar NETNAME .
317 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /hosts/
318 Host configuration files are kept in this directory.
319 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc-up
320 If an executable file with this name exists,
321 it will be executed right after the tinc daemon has connected to the virtual network device.
322 It can be used to set up the corresponding network interface.
323 .Pp
324 The environment variable
325 .Ev $NETNAME
326 will be passed to the executable.
327 If specified with the
328 .Va Interface
329 configuration variable,
330 or if the virtual network device is a Linux tun/tap device,
331 the environment variable
333 will be set to the name of the network interface.
334 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
335 If an executable file with this name exists,
336 it will be executed right before the tinc daemon is going to close
337 its connection to the virtual network device.
338 The same environment variables will be passed as mentioned above.
339 .El
340 .Sh SEE ALSO
341 .Xr tincd 8 ,
342 .Pa http://tinc.nl.linux.org/ ,
343 .Pa http://www.linuxdoc.org/LDP/nag2/ .
344 .Pp
345 The full documentation for
346 .Nm tinc
347 is maintained as a Texinfo manual.
348 If the info and tinc programs are properly installed at your site, the command
349 .Ic info tinc
350 should give you access to the complete manual.
351 .Pp
352 .Nm tinc
354 This is free software, and you are welcome to redistribute it under certain conditions;
355 see the file COPYING for details.