Simplify reading lines from configuration files.
[tinc] / doc / tinc.conf.5.in
1 .Dd 2010-01-16
2 .Dt TINC.CONF 5
3 .\" Manual page created by:
4 .\" Ivo Timmermans
5 .\" Guus Sliepen <guus@tinc-vpn.org>
6
7 .Sh NAME
8 .Nm tinc.conf
9 .Nd tinc daemon configuration
10
11 .Sh DESCRIPTION
12 The files in the
13 .Pa @sysconfdir@/tinc/
14 directory contain runtime and security information for the tinc daemon.
15
16 .Sh NETWORKS
17 It is perfectly ok for you to run more than one tinc daemon.
18 However, in its default form,
19 you will soon notice that you can't use two different configuration files without the
20 .Fl c
21 option.
22
23 .Pp
24 We have thought of another way of dealing with this: network names.
25 This means that you call
26 .Nm
27 with the
28 .Fl n
29 option, which will assign a name to this daemon.
30
31 .Pp
32 The effect of this is that the daemon will set its configuration root to
33 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa / ,
34 where 
35 .Ar NETNAME
36 is your argument to the
37 .Fl n
38 option.
39 You'll notice that messages appear in syslog as coming from
40 .Nm tincd. Ns Ar NETNAME .
41
42 .Pp
43 However, it is not strictly necessary that you call tinc with the
44 .Fl n
45 option.
46 In this case, the network name would just be empty,
47 and it will be used as such.
48 .Nm tinc
49 now looks for files in
50 .Pa @sysconfdir@/tinc/ ,
51 instead of 
52 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa / ;
53 the configuration file should be
54 .Pa @sysconfdir@/tinc/tinc.conf ,
55 and the host configuration files are now expected to be in
56 .Pa @sysconfdir@/tinc/hosts/ .
57
58 .Pp
59 But it is highly recommended that you use this feature of
60 .Nm tinc ,
61 because it will be so much clearer whom your daemon talks to.
62 Hence, we will assume that you use it.
63
64 .Sh NAMES
65 Each tinc daemon should have a name that is unique in the network which it will be part of.
66 The name will be used by other tinc daemons for identification.
67 The name has to be declared in the
68 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf
69 file.
70
71 .Pp
72 To make things easy,
73 choose something that will give unique and easy to remember names to your tinc daemon(s).
74 You could try things like hostnames, owner surnames or location names.
75
76 .Sh PUBLIC/PRIVATE KEYS
77 You should use 
78 .Ic tincd -K
79 to generate public/private keypairs.
80 It will generate two keys.
81 The private key should be stored in a separate file
82 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /rsa_key.priv
83 \-\- where 
84 .Ar NETNAME
85 stands for the network (see 
86 .Sx NETWORKS )
87 above.
88 The public key should be stored in the host configuration file
89 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Va NAME
90 \-\- where
91 .Va NAME
92 stands for the name of the local tinc daemon (see
93 .Sx NAMES ) .
94
95 .Sh SERVER CONFIGURATION
96 The server configuration of the daemon is done in the file
97 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf .
98 This file consists of comments (lines started with a
99 .Li # )
100 or assignments in the form of:
101
102 .Pp
103 .Va Variable Li = Ar Value .
104
105 .Pp
106 The variable names are case insensitive, and any spaces, tabs,
107 newlines and carriage returns are ignored.
108 Note: it is not required that you put in the 
109 .Li =
110 sign, but doing so improves readability.
111 If you leave it out, remember to replace it with at least one space character.
112
113 .Pp
114 Here are all valid variables, listed in alphabetical order.
115 The default value is given between parentheses.
116 .Bl -tag -width indent
117
118 .It Va AddressFamily Li = ipv4 | ipv6 | any Pq any
119 This option affects the address family of listening and outgoing sockets.
120 If
121 .Qq any
122 is selected, then depending on the operating system both IPv4 and IPv6 or just
123 IPv6 listening sockets will be created.
124
125 .It Va BindToAddress Li = Ar address Bq experimental
126 If your computer has more than one IPv4 or IPv6 address,
127 .Nm tinc
128 will by default listen on all of them for incoming connections.
129 It is possible to bind only to a single address with this variable.
130
131 .Pp
132 This option may not work on all platforms.
133
134 .It Va BindToInterface Li = Ar interface Bq experimental
135 If your computer has more than one network interface,
136 .Nm tinc
137 will by default listen on all of them for incoming connections.
138 It is possible to bind only to a single interface with this variable.
139
140 .Pp
141 This option may not work on all platforms.
142
143 .It Va ConnectTo Li = Ar name
144 Specifies which other tinc daemon to connect to on startup.
145 Multiple
146 .Va ConnectTo
147 variables may be specified,
148 in which case outgoing connections to each specified tinc daemon are made.
149 The names should be known to this tinc daemon
150 (i.e., there should be a host configuration file for the name on the
151 .Va ConnectTo
152 line).
153
154 .Pp
155 If you don't specify a host with
156 .Va ConnectTo ,
157 .Nm tinc
158 won't try to connect to other daemons at all,
159 and will instead just listen for incoming connections.
160
161 .It Va Device Li = Ar device Po Pa /dev/tap0 , Pa /dev/net/tun No or other depending on platform Pc
162 The virtual network device to use.
163 .Nm tinc
164 will automatically detect what kind of device it is.
165 Note that you can only use one device per daemon.
166 Under Windows, use
167 .Va Interface
168 instead of
169 .Va Device .
170 The info pages of the tinc package contain more information
171 about configuring the virtual network device.
172
173 .It Va DeviceType Li = tun | tunnohead | tunifhead | tap Po only supported on BSD platforms Pc
174 The type of the virtual network device.
175 Tinc will normally automatically select the right type, and this option should not be used.
176 However, in case tinc does not seem to correctly interpret packets received from the virtual network device,
177 using this option might help.
178 .Bl -tag -width indent
179
180 .It tun
181 Set type to tun.
182 Depending on the platform, this can either be with or without an address family header (see below).
183
184 .It tunnohead
185 Set type to tun without an address family header.
186 Tinc will expect packets read from the virtual network device to start with an IP header.
187 On some platforms IPv6 packets cannot be read from or written to the device in this mode.
188
189 .It tunifhead
190 Set type to tun with an address family header.
191 Tinc will expect packets read from the virtual network device
192 to start with a four byte header containing the address family,
193 followed by an IP header.
194 This mode should support both IPv4 and IPv6 packets.
195
196 .It tap
197 Set type to tap.
198 Tinc will expect packets read from the virtual network device
199 to start with an Ethernet header.
200 .El
201
202 .It Va GraphDumpFile Li = Ar filename Bq experimental
203 If this option is present,
204 .Nm tinc
205 will dump the current network graph to the file
206 .Ar filename
207 every minute, unless there were no changes to the graph.
208 The file is in a format that can be read by graphviz tools.
209 If
210 .Ar filename
211 starts with a pipe symbol |,
212 then the rest of the filename is interpreted as a shell command
213 that is executed, the graph is then sent to stdin.
214
215 .It Va Hostnames Li = yes | no Pq no
216 This option selects whether IP addresses (both real and on the VPN) should
217 be resolved. Since DNS lookups are blocking, it might affect tinc's
218 efficiency, even stopping the daemon for a few seconds every time it does
219 a lookup if your DNS server is not responding.
220
221 .Pp
222 This does not affect resolving hostnames to IP addresses from the
223 host configuration files.
224
225 .It Va Interface Li = Ar interface
226 Defines the name of the interface corresponding to the virtual network device.
227 Depending on the operating system and the type of device this may or may not actually set the name of the interface.
228 Under Windows, this variable is used to select which network interface will be used.
229 If you specified a
230 .Va Device ,
231 this variable is almost always already correctly set.
232
233 .It Va KeyExpire Li = Ar seconds Pq 3600
234 This option controls the period the encryption keys used to encrypt the data are valid.
235 It is common practice to change keys at regular intervals to make it even harder for crackers,
236 even though it is thought to be nearly impossible to crack a single key.
237
238 .It Va MACExpire Li = Ar seconds Pq 600
239 This option controls the amount of time MAC addresses are kept before they are removed.
240 This only has effect when
241 .Va Mode
242 is set to
243 .Qq switch .
244
245 .It Va MaxTimeout Li = Ar seconds Pq 900
246 This is the maximum delay before trying to reconnect to other tinc daemons.
247
248 .It Va Mode Li = router | switch | hub Pq router
249 This option selects the way packets are routed to other daemons.
250 .Bl -tag -width indent
251
252 .It router
253 In this mode
254 .Va Subnet
255 variables in the host configuration files will be used to form a routing table.
256 Only unicast packets of routable protocols (IPv4 and IPv6) are supported in this mode.
257
258 .Pp
259 This is the default mode, and unless you really know you need another mode, don't change it.
260
261 .It switch
262 In this mode the MAC addresses of the packets on the VPN will be used to
263 dynamically create a routing table just like an Ethernet switch does.
264 Unicast, multicast and broadcast packets of every protocol that runs over Ethernet are supported in this mode
265 at the cost of frequent broadcast ARP requests and routing table updates.
266
267 .Pp
268 This mode is primarily useful if you want to bridge Ethernet segments.
269
270 .It hub
271 This mode is almost the same as the switch mode, but instead
272 every packet will be broadcast to the other daemons
273 while no routing table is managed.
274 .El
275
276 .It Va Name Li = Ar name Bq required
277 This is the name which identifies this tinc daemon.
278 It must be unique for the virtual private network this daemon will connect to.
279
280 .It Va PingInterval Li = Ar seconds Pq 60
281 The number of seconds of inactivity that
282 .Nm tinc
283 will wait before sending a probe to the other end.
284
285 .It Va PingTimeout Li = Ar seconds Pq 5
286 The number of seconds to wait for a response to pings or to allow meta
287 connections to block. If the other end doesn't respond within this time,
288 the connection is terminated,
289 and the others will be notified of this.
290
291 .It Va PriorityInheritance Li = yes | no Po no Pc Bq experimental
292 When this option is enabled the value of the TOS field of tunneled IPv4 packets
293 will be inherited by the UDP packets that are sent out.
294
295 .It Va PrivateKey Li = Ar key Bq obsolete
296 The private RSA key of this tinc daemon.
297 It will allow this tinc daemon to authenticate itself to other daemons.
298
299 .It Va PrivateKeyFile Li = Ar filename Po Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /rsa_key.priv Pc
300 The file in which the private RSA key of this tinc daemon resides.
301 Note that there must be exactly one of
302 .Va PrivateKey
303 or
304 .Va PrivateKeyFile
305 specified in the configuration file.
306
307 .It Va ProcessPriority Li = low | normal | high
308 When this option is used the priority of the tincd process will be adjusted.
309 Increasing the priority may help to reduce latency and packet loss on the VPN.
310
311 .It Va TunnelServer Li = yes | no Po no Pc Bq experimental
312 When this option is enabled tinc will no longer forward information between other tinc daemons,
313 and will only allow nodes and subnets on the VPN which are present in the
314 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/
315 directory.
316 .El
317
318 .Sh HOST CONFIGURATION FILES
319 The host configuration files contain all information needed
320 to establish a connection to those hosts.
321 A host configuration file is also required for the local tinc daemon,
322 it will use it to read in it's listen port, public key and subnets.
323
324 .Pp
325 The idea is that these files are portable.
326 You can safely mail your own host configuration file to someone else.
327 That other person can then copy it to his own hosts directory,
328 and now his tinc daemon will be able to connect to your tinc daemon.
329 Since host configuration files only contain public keys,
330 no secrets are revealed by sending out this information.
331 .Bl -tag -width indent
332
333 .It Va Address Li = Ar address Oo port Oc Bq recommended
334 The IP address or hostname of this tinc daemon on the real network.
335 This will only be used when trying to make an outgoing connection to this tinc daemon.
336 Optionally, a port can be specified to use for this address.
337 Multiple
338 .Va Address
339 variables can be specified, in which case each address will be tried until a working
340 connection has been established.
341
342 .It Va Cipher Li = Ar cipher Pq blowfish
343 The symmetric cipher algorithm used to encrypt UDP packets.
344 Any cipher supported by OpenSSL is recognised.
345 Furthermore, specifying
346 .Qq none
347 will turn off packet encryption.
348 It is best to use only those ciphers which support CBC mode.
349
350 .It Va ClampMSS Li = yes | no Pq yes
351 This option specifies whether tinc should clamp the maximum segment size (MSS)
352 of TCP packets to the path MTU. This helps in situations where ICMP
353 Fragmentation Needed or Packet too Big messages are dropped by firewalls.
354
355 .It Va Compression Li = Ar level Pq 0
356 This option sets the level of compression used for UDP packets.
357 Possible values are 0 (off), 1 (fast zlib) and any integer up to 9 (best zlib),
358 10 (fast lzo) and 11 (best lzo).
359
360 .It Va Digest Li = Ar digest Pq sha1
361 The digest algorithm used to authenticate UDP packets.
362 Any digest supported by OpenSSL is recognised.
363 Furthermore, specifying
364 .Qq none
365 will turn off packet authentication.
366
367 .It Va IndirectData Li = yes | no Pq no
368 This option specifies whether other tinc daemons besides the one you specified with
369 .Va ConnectTo
370 can make a direct connection to you.
371 This is especially useful if you are behind a firewall
372 and it is impossible to make a connection from the outside to your tinc daemon.
373 Otherwise, it is best to leave this option out or set it to no.
374
375 .It Va MACLength Li = Ar length Pq 4
376 The length of the message authentication code used to authenticate UDP packets.
377 Can be anything from
378 .Qq 0
379 up to the length of the digest produced by the digest algorithm.
380
381 .It Va PMTU Li = Ar mtu Po 1514 Pc
382 This option controls the initial path MTU to this node.
383
384 .It Va PMTUDiscovery Li = yes | no Po yes Pc
385 When this option is enabled, tinc will try to discover the path MTU to this node.
386 After the path MTU has been discovered, it will be enforced on the VPN.
387
388 .It Va Port Li = Ar port Pq 655
389 The port number on which this tinc daemon is listening for incoming connections,
390 which is used if no port number is specified in an
391 .Va Address
392 statement.
393
394 .It Va PublicKey Li = Ar key Bq obsolete
395 The public RSA key of this tinc daemon.
396 It will be used to cryptographically verify it's identity and to set up a secure connection.
397
398 .It Va PublicKeyFile Li = Ar filename Bq obsolete
399 The file in which the public RSA key of this tinc daemon resides.
400
401 .Pp
402 From version 1.0pre4 on
403 .Nm tinc
404 will store the public key directly into the host configuration file in PEM format,
405 the above two options then are not necessary.
406 Either the PEM format is used, or exactly one of the above two options must be specified
407 in each host configuration file,
408 if you want to be able to establish a connection with that host.
409
410 .It Va Subnet Li = Ar address Ns Op Li / Ns Ar prefixlength Ns Op Li # Ns Ar weight
411 The subnet which this tinc daemon will serve.
412 .Nm tinc
413 tries to look up which other daemon it should send a packet to by searching the appropriate subnet.
414 If the packet matches a subnet,
415 it will be sent to the daemon who has this subnet in his host configuration file.
416 Multiple
417 .Va Subnet
418 variables can be specified.
419
420 .Pp
421 Subnets can either be single MAC, IPv4 or IPv6 addresses,
422 in which case a subnet consisting of only that single address is assumed,
423 or they can be a IPv4 or IPv6 network address with a prefixlength.
424 Shorthand notations are not supported.
425 For example, IPv4 subnets must be in a form like 192.168.1.0/24,
426 where 192.168.1.0 is the network address and 24 is the number of bits set in the netmask.
427 Note that subnets like 192.168.1.1/24 are invalid!
428 Read a networking HOWTO/FAQ/guide if you don't understand this.
429 IPv6 subnets are notated like fec0:0:0:1:0:0:0:0/64.
430 MAC addresses are notated like 0:1a:2b:3c:4d:5e.
431
432 .Pp
433 A Subnet can be given a weight to indicate its priority over identical Subnets
434 owned by different nodes.  The default weight is 10. Lower values indicate
435 higher priority. Packets will be sent to the node with the highest priority,
436 unless that node is not reachable, in which case the node with the next highest
437 priority will be tried, and so on.
438
439 .It Va TCPOnly Li = yes | no Pq no Bq obsolete
440 If this variable is set to yes,
441 then the packets are tunnelled over the TCP connection instead of a UDP connection.
442 This is especially useful for those who want to run a tinc daemon
443 from behind a masquerading firewall,
444 or if UDP packet routing is disabled somehow.
445 Setting this options also implicitly sets IndirectData.
446
447 .Pp
448 Since version 1.0.10, tinc will automatically detect whether communication via
449 UDP is possible or not.
450 .El
451
452 .Sh SCRIPTS
453 Apart from reading the server and host configuration files,
454 tinc can also run scripts at certain moments.
455 Under Windows (not Cygwin), the scripts should have the extension
456 .Pa .bat .
457 .Bl -tag -width indent
458
459 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-up
460 This is the most important script.
461 If it is present it will be executed right after the tinc daemon has been started and has connected to the virtual network device.
462 It should be used to set up the corresponding network interface,
463 but can also be used to start other things.
464 Under Windows you can use the Network Connections control panel instead of creating this script.
465
466 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
467 This script is started right before the tinc daemon quits.
468
469 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar HOST Ns Pa -up
470 This script is started when the tinc daemon with name
471 .Ar HOST
472 becomes reachable.
473
474 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar HOST Ns Pa -down
475 This script is started when the tinc daemon with name
476 .Ar HOST
477 becomes unreachable.
478
479 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /host-up
480 This script is started when any host becomes reachable.
481
482 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /host-down
483 This script is started when any host becomes unreachable.
484
485 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /subnet-up
486 This script is started when a Subnet becomes reachable.
487 The Subnet and the node it belongs to are passed in environment variables.
488
489 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /subnet-down
490 This script is started when a Subnet becomes unreachable.
491 .El
492
493 .Pp
494 The scripts are started without command line arguments, but can make use of certain environment variables.
495 Under UNIX like operating systems the names of environment variables must be preceded by a
496 .Li $ 
497 in scripts.
498 Under Windows, in
499 .Pa .bat
500 files, they have to be put between
501 .Li %
502 signs.
503 .Bl -tag -width indent
504
505 .It Ev NETNAME
506 If a netname was specified, this environment variable contains it.
507
508 .It Ev NAME
509 Contains the name of this tinc daemon.
510
511 .It Ev DEVICE
512 Contains the name of the virtual network device that tinc uses.
513
514 .It Ev INTERFACE
515 Contains the name of the virtual network interface that tinc uses.
516 This should be used for commands like
517 .Pa ifconfig .
518
519 .It Ev NODE
520 When a host becomes (un)reachable, this is set to its name.
521 If a subnet becomes (un)reachable, this is set to the owner of that subnet.
522
523 .It Ev REMOTEADDRESS
524 When a host becomes (un)reachable, this is set to its real address.
525
526 .It Ev REMOTEPORT
527 When a host becomes (un)reachable, this is set to the port number it uses for communication with other tinc daemons.
528
529 .It Ev SUBNET
530 When a subnet becomes (un)reachable, this is set to the subnet.
531
532 .It Ev WEIGHT
533 When a subnet becomes (un)reachable, this is set to the subnet weight.
534 .El
535
536 .Sh FILES
537 The most important files are:
538 .Bl -tag -width indent
539
540 .It Pa @sysconfdir@/tinc/
541 The top directory for configuration files.
542
543 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf
544 The default name of the server configuration file for net
545 .Ar NETNAME .
546
547 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/
548 Host configuration files are kept in this directory.
549
550 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-up
551 If an executable file with this name exists,
552 it will be executed right after the tinc daemon has connected to the virtual network device.
553 It can be used to set up the corresponding network interface.
554
555 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
556 If an executable file with this name exists,
557 it will be executed right before the tinc daemon is going to close
558 its connection to the virtual network device.
559 .El
560
561 .Sh SEE ALSO
562 .Xr tincd 8 ,
563 .Pa http://www.tinc-vpn.org/ ,
564 .Pa http://www.linuxdoc.org/LDP/nag2/ .
565
566 .Pp
567 The full documentation for
568 .Nm tinc
569 is maintained as a Texinfo manual.
570 If the info and tinc programs are properly installed at your site, the command
571 .Ic info tinc
572 should give you access to the complete manual.
573
574 .Pp
575 .Nm tinc
576 comes with ABSOLUTELY NO WARRANTY.
577 This is free software, and you are welcome to redistribute it under certain conditions;
578 see the file COPYING for details.