Update .gitignore.
[tinc] / doc / tinc.conf.5.in
1 .Dd 2014-01-29
2 .Dt TINC.CONF 5
3 .\" Manual page created by:
4 .\" Ivo Timmermans
5 .\" Guus Sliepen <guus@tinc-vpn.org>
6 .Sh NAME
7 .Nm tinc.conf
8 .Nd tinc daemon configuration
9 .Sh DESCRIPTION
10 The files in the
11 .Pa @sysconfdir@/tinc/
12 directory contain runtime and security information for the tinc daemon.
13 .Sh NETWORKS
14 To distinguish multiple instances of tinc running on one computer,
15 you can use the
16 .Fl n
17 option to assign a network name to each tinc daemon.
18 .Pp
19 The effect of this option is that the daemon will set its configuration root to
20 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa / ,
21 where 
22 .Ar NETNAME
23 is your argument to the
24 .Fl n
25 option.
26 You'll notice that messages appear in syslog as coming from
27 .Nm tincd. Ns Ar NETNAME ,
28 and on Linux, unless specified otherwise, the name of the virtual network interface will be the same as the network name.
29 .Pp
30 It is recommended that you use network names even if you run only one instance of tinc.
31 However, you can choose not to use the
32 .Fl n
33 option.
34 In this case, the network name would just be empty, and
35 .Nm tinc
36 now looks for files in
37 .Pa @sysconfdir@/tinc/ ,
38 instead of 
39 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa / ;
40 the configuration file should be
41 .Pa @sysconfdir@/tinc/tinc.conf ,
42 and the host configuration files are now expected to be in
43 .Pa @sysconfdir@/tinc/hosts/ .
44 .Sh NAMES
45 Each tinc daemon must have a name that is unique in the network which it will be part of.
46 The name will be used by other tinc daemons for identification.
47 The name has to be declared in the
48 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf
49 file.
50 .Pp
51 To make things easy,
52 choose something that will give unique and easy to remember names to your tinc daemon(s).
53 You could try things like hostnames, owner surnames or location names.
54 However, you are only allowed to use alphanumerical characters (a-z, A-Z, and 0-9) and underscores (_) in the name.
55 .Sh INITIAL CONFIGURATION
56 If you have not configured tinc yet, you can easily create a basic configuration using the following command:
57 .Bd -literal -offset indent
58 .Nm tinc Fl n Ar NETNAME Li init Ar NAME
59 .Ed
60 .Pp
61 You can further change the configuration as needed either by manually editing the configuration files,
62 or by using
63 .Xr tinc 8 .
64 .Sh PUBLIC/PRIVATE KEYS
65 The
66 .Nm tinc Li init
67 command will have generated both RSA and Ed25519 public/private keypairs.
68 The private keys should be stored in files named
69 .Pa rsa_key.priv
70 and
71 .Pa ed25519_key.priv
72 in the directory
73 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /
74 The public keys should be stored in the host configuration file
75 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Va NAME .
76 The RSA keys are used for backwards compatibility with tinc version 1.0.
77 If you are upgrading from version 1.0 to 1.1, you can keep the old configuration files,
78 but you will need to create Ed25519 keys using the following command:
79 .Bd -literal -offset indent
80 .Nm tinc Fl n Ar NETNAME Li generate-ed25519-keys
81 .Ed
82 .Sh SERVER CONFIGURATION
83 The server configuration of the daemon is done in the file
84 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf .
85 This file consists of comments (lines started with a
86 .Li # )
87 or assignments in the form of:
88 .Pp
89 .Va Variable Li = Ar Value .
90 .Pp
91 The variable names are case insensitive, and any spaces, tabs,
92 newlines and carriage returns are ignored.
93 Note: it is not required that you put in the 
94 .Li =
95 sign, but doing so improves readability.
96 If you leave it out, remember to replace it with at least one space character.
97 .Pp
98 The server configuration is complemented with host specific configuration (see the next section).
99 Although all configuration options for the local host listed in this document can also be put in
100 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf ,
101 it is recommended to put host specific configuration options in the host configuration file,
102 as this makes it easy to exchange with other nodes.
103 .Pp
104 You can edit the config file manually, but it is recommended that you use
105 .Xr tinc 8
106 to change configuration variables for you.
107 .Pp
108 Here are all valid variables, listed in alphabetical order.
109 The default value is given between parentheses.
110 .Bl -tag -width indent
111 .It Va AddressFamily Li = ipv4 | ipv6 | any Pq any
112 This option affects the address family of listening and outgoing sockets.
113 If
114 .Qq any
115 is selected, then depending on the operating system both IPv4 and IPv6 or just
116 IPv6 listening sockets will be created.
117 .It Va AutoConnect Li = yes | no Po no Pc Bq experimental
118 If set to yes,
119 .Nm tinc
120 will automatically set up meta connections to other nodes,
121 without requiring
122 .Va ConnectTo
123 variables.
124 .Pp
125 Note: it is not possible to connect to nodes using zero (system-assigned) ports in this way.
126 .It Va BindToAddress Li = Ar address Op Ar port
127 This is the same as
128 .Va ListenAddress ,
129 however the address given with the
130 .Va BindToAddress
131 option will also be used for outgoing connections. This is useful if your
132 computer has more than one IPv4 or IPv6 address, and you want 
133 .Nm tinc
134 to only use a specific one for outgoing packets.
135 .It Va BindToInterface Li = Ar interface Bq experimental
136 If your computer has more than one network interface,
137 .Nm tinc
138 will by default listen on all of them for incoming connections.
139 It is possible to bind only to a single interface with this variable.
140 .Pp
141 This option may not work on all platforms.
142 Also, on some platforms it will not actually bind to an interface,
143 but rather to the address that the interface has at the moment a socket is created.
144 .It Va Broadcast Li = no | mst | direct Po mst Pc Bq experimental
145 This option selects the way broadcast packets are sent to other daemons.
146 NOTE: all nodes in a VPN must use the same
147 .Va Broadcast
148 mode, otherwise routing loops can form.
149 .Bl -tag -width indent
150 .It no
151 Broadcast packets are never sent to other nodes.
152 .It mst
153 Broadcast packets are sent and forwarded via the VPN's Minimum Spanning Tree.
154 This ensures broadcast packets reach all nodes.
155 .It direct
156 Broadcast packets are sent directly to all nodes that can be reached directly.
157 Broadcast packets received from other nodes are never forwarded.
158 If the IndirectData option is also set, broadcast packets will only be sent to nodes which we have a meta connection to.
159 .El
160 .It Va BroadcastSubnet Li = Ar address Ns Op Li / Ns Ar prefixlength
161 Declares a broadcast subnet. Any packet with a destination address falling into such a subnet will be routed as a broadcast (provided all nodes have it declared).
162 This is most useful to declare subnet broadcast addresses (e.g. 10.42.255.255), otherwise
163 .Nm tinc
164 won't know what to do with them.
165 .Pp
166 Note that global broadcast addresses (MAC ff:ff:ff:ff:ff:ff, IPv4 255.255.255.255), as well as multicast space (IPv4 224.0.0.0/4, IPv6 ff00::/8) are always considered broadcast addresses and don't need to be declared.
167 .It Va ConnectTo Li = Ar name
168 Specifies which other tinc daemon to connect to on startup.
169 Multiple
170 .Va ConnectTo
171 variables may be specified,
172 in which case outgoing connections to each specified tinc daemon are made.
173 The names should be known to this tinc daemon
174 (i.e., there should be a host configuration file for the name on the
175 .Va ConnectTo
176 line).
177 .Pp
178 If you don't specify a host with
179 .Va ConnectTo
180 and don't enable
181 .Va AutoConnect ,
182 .Nm tinc
183 won't try to connect to other daemons at all,
184 and will instead just listen for incoming connections.
185 .It Va DecrementTTL Li = yes | no Po no Pc Bq experimental
186 When enabled,
187 .Nm tinc
188 will decrement the Time To Live field in IPv4 packets, or the Hop Limit field in IPv6 packets,
189 before forwarding a received packet to the virtual network device or to another node,
190 and will drop packets that have a TTL value of zero,
191 in which case it will send an ICMP Time Exceeded packet back.
192 .Pp
193 Do not use this option if you use switch mode and want to use IPv6.
194 .It Va Device Li = Ar device Po Pa /dev/tap0 , Pa /dev/net/tun No or other depending on platform Pc
195 The virtual network device to use.
196 .Nm tinc
197 will automatically detect what kind of device it is.
198 Note that you can only use one device per daemon.
199 Under Windows, use
200 .Va Interface
201 instead of
202 .Va Device .
203 The info pages of the tinc package contain more information
204 about configuring the virtual network device.
205 .It Va DeviceStandby Li = yes | no Po no Pc
206 When disabled,
207 .Nm tinc
208 calls tinc-up on startup, and tinc-down on shutdown. When enabled,
209 .Nm tinc
210 will only call tinc-up when at least one node is reachable, and will call tinc-down as soon as no nodes are reachable.
211 On Windows, this also determines when the virtual network interface "cable" is "plugged".
212 .It Va DeviceType Li = Ar type Pq platform dependent
213 The type of the virtual network device.
214 Tinc will normally automatically select the right type of tun/tap interface, and this option should not be used.
215 However, this option can be used to select one of the special interface types, if support for them is compiled in.
216 .Bl -tag -width indent
217 .It dummy
218 Use a dummy interface.
219 No packets are ever read or written to a virtual network device.
220 Useful for testing, or when setting up a node that only forwards packets for other nodes.
221 .It raw_socket
222 Open a raw socket, and bind it to a pre-existing
223 .Va Interface
224 (eth0 by default).
225 All packets are read from this interface.
226 Packets received for the local node are written to the raw socket.
227 However, at least on Linux, the operating system does not process IP packets destined for the local host.
228 .It multicast
229 Open a multicast UDP socket and bind it to the address and port (separated by spaces) and optionally a TTL value specified using
230 .Va Device .
231 Packets are read from and written to this multicast socket.
232 This can be used to connect to UML, QEMU or KVM instances listening on the same multicast address.
233 Do NOT connect multiple
234 .Nm tinc 
235 daemons to the same multicast address, this will very likely cause routing loops.
236 Also note that this can cause decrypted VPN packets to be sent out on a real network if misconfigured.
237 .It uml Pq not compiled in by default
238 Create a UNIX socket with the filename specified by
239 .Va Device ,
240 or
241 .Pa @localstatedir@/run/ Ns Ar NETNAME Ns Pa .umlsocket
242 if not specified.
243 .Nm tinc
244 will wait for a User Mode Linux instance to connect to this socket.
245 .It vde Pq not compiled in by default
246 Uses the libvdeplug library to connect to a Virtual Distributed Ethernet switch,
247 using the UNIX socket specified by
248 .Va Device ,
249 or
250 .Pa @localstatedir@/run/vde.ctl
251 if not specified.
252 .El
253 Also, in case tinc does not seem to correctly interpret packets received from the virtual network device,
254 it can be used to change the way packets are interpreted:
255 .Bl -tag -width indent
256 .It tun Pq BSD and Linux
257 Set type to tun.
258 Depending on the platform, this can either be with or without an address family header (see below).
259 .It tunnohead Pq BSD
260 Set type to tun without an address family header.
261 Tinc will expect packets read from the virtual network device to start with an IP header.
262 On some platforms IPv6 packets cannot be read from or written to the device in this mode.
263 .It tunifhead Pq BSD
264 Set type to tun with an address family header.
265 Tinc will expect packets read from the virtual network device
266 to start with a four byte header containing the address family,
267 followed by an IP header.
268 This mode should support both IPv4 and IPv6 packets.
269 .It tap Pq BSD and Linux
270 Set type to tap.
271 Tinc will expect packets read from the virtual network device
272 to start with an Ethernet header.
273 .El
274 .It Va DirectOnly Li = yes | no Po no Pc Bq experimental
275 When this option is enabled, packets that cannot be sent directly to the destination node,
276 but which would have to be forwarded by an intermediate node, are dropped instead.
277 When combined with the IndirectData option,
278 packets for nodes for which we do not have a meta connection with are also dropped.
279 .It Va Ed25519PrivateKeyFile Li = Ar filename Po Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /ed25519_key.priv Pc
280 The file in which the private Ed25519 key of this tinc daemon resides.
281 This is only used if
282 .Va ExperimentalProtocol
283 is enabled.
284 .It Va ExperimentalProtocol Li = yes | no Pq yes
285 When this option is enabled, the SPTPS protocol will be used when connecting to nodes that also support it.
286 Ephemeral ECDH will be used for key exchanges,
287 and Ed25519 will be used instead of RSA for authentication.
288 When enabled, an Ed25519 key must have been generated before with
289 .Nm tinc generate-ed25519-keys .
290 .It Va Forwarding Li = off | internal | kernel Po internal Pc Bq experimental
291 This option selects the way indirect packets are forwarded.
292 .Bl -tag -width indent
293 .It off
294 Incoming packets that are not meant for the local node,
295 but which should be forwarded to another node, are dropped.
296 .It internal
297 Incoming packets that are meant for another node are forwarded by tinc internally.
298 .Pp
299 This is the default mode, and unless you really know you need another forwarding mode, don't change it.
300 .It kernel
301 Incoming packets are always sent to the TUN/TAP device, even if the packets are not for the local node.
302 This is less efficient, but allows the kernel to apply its routing and firewall rules on them,
303 and can also help debugging.
304 .El
305 .It Va Hostnames Li = yes | no Pq no
306 This option selects whether IP addresses (both real and on the VPN) should
307 be resolved. Since DNS lookups are blocking, it might affect tinc's
308 efficiency, even stopping the daemon for a few seconds every time it does
309 a lookup if your DNS server is not responding.
310 .Pp
311 This does not affect resolving hostnames to IP addresses from the
312 host configuration files, but whether hostnames should be resolved while logging.
313 .It Va IffOneQueue Li = yes | no Po no Pc Bq experimental
314 (Linux only) Set IFF_ONE_QUEUE flag on TUN/TAP devices.
315 .It Va Interface Li = Ar interface
316 Defines the name of the interface corresponding to the virtual network device.
317 Depending on the operating system and the type of device this may or may not actually set the name of the interface.
318 Under Windows, this variable is used to select which network interface will be used.
319 If you specified a
320 .Va Device ,
321 this variable is almost always already correctly set.
322 .It Va KeyExpire Li = Ar seconds Pq 3600
323 This option controls the period the encryption keys used to encrypt the data are valid.
324 It is common practice to change keys at regular intervals to make it even harder for crackers,
325 even though it is thought to be nearly impossible to crack a single key.
326 .It Va ListenAddress Li = Ar address Op Ar port
327 If your computer has more than one IPv4 or IPv6 address,
328 .Nm tinc
329 will by default listen on all of them for incoming connections.
330 This option can be used to restrict which addresses tinc listens on.
331 Multiple
332 .Va ListenAddress
333 variables may be specified,
334 in which case listening sockets for each specified address are made.
335 .Pp
336 If no
337 .Ar port
338 is specified, the socket will listen on the port specified by the
339 .Va Port
340 option, or to port 655 if neither is given.
341 To only listen on a specific port but not on a specific address, use
342 .Li *
343 for the
344 .Ar address .
345 .Pp
346 If
347 .Ar port
348 is set to zero, it will be randomly assigned by the system. This is useful to randomize source ports of UDP packets, which can improve UDP hole punching reliability. In this case it is recommended to set
349 .Va AddressFamily
350 as well, otherwise
351 .Nm tinc
352 will assign different ports to different address families but other nodes can only know of one.
353 .It Va LocalDiscovery Li = yes | no Pq yes
354 When enabled,
355 .Nm tinc
356 will try to detect peers that are on the same local network.
357 This will allow direct communication using LAN addresses, even if both peers are behind a NAT
358 and they only ConnectTo a third node outside the NAT,
359 which normally would prevent the peers from learning each other's LAN address.
360 .Pp
361 Currently, local discovery is implemented by sending some packets to the local address of the node during UDP discovery. This will not work with old nodes that don't transmit their local address.
362 .It Va MACExpire Li = Ar seconds Pq 600
363 This option controls the amount of time MAC addresses are kept before they are removed.
364 This only has effect when
365 .Va Mode
366 is set to
367 .Qq switch .
368 .It Va MaxConnectionBurst Li = Ar count Pq 100
369 This option controls how many connections tinc accepts in quick succession.
370 If there are more connections than the given number in a short time interval,
371 tinc will reduce the number of accepted connections to only one per second,
372 until the burst has passed.
373 .It Va MaxTimeout Li = Ar seconds Pq 900
374 This is the maximum delay before trying to reconnect to other tinc daemons.
375 .It Va Mode Li = router | switch | hub Pq router
376 This option selects the way packets are routed to other daemons.
377 .Bl -tag -width indent
378 .It router
379 In this mode
380 .Va Subnet
381 variables in the host configuration files will be used to form a routing table.
382 Only packets of routable protocols (IPv4 and IPv6) are supported in this mode.
383 .Pp
384 This is the default mode, and unless you really know you need another mode, don't change it.
385 .It switch
386 In this mode the MAC addresses of the packets on the VPN will be used to
387 dynamically create a routing table just like an Ethernet switch does.
388 Unicast, multicast and broadcast packets of every protocol that runs over Ethernet are supported in this mode
389 at the cost of frequent broadcast ARP requests and routing table updates.
390 .Pp
391 This mode is primarily useful if you want to bridge Ethernet segments.
392 .It hub
393 This mode is almost the same as the switch mode, but instead
394 every packet will be broadcast to the other daemons
395 while no routing table is managed.
396 .El
397 .It Va Name Li = Ar name Bq required
398 This is the name which identifies this tinc daemon.
399 It must be unique for the virtual private network this daemon will connect to.
400 .Va Name
401 may only consist of alphanumeric and underscore characters (a-z, A-Z, 0-9 and _), and is case sensitive.
402 If 
403 .Va Name
404 starts with a
405 .Li $ ,
406 then the contents of the environment variable that follows will be used.
407 In that case, invalid characters will be converted to underscores.
408 If
409 .Va Name
410 is
411 .Li $HOST ,
412 but no such environment variable exist, the hostname will be read using the gethostname() system call.
413 .It Va PingInterval Li = Ar seconds Pq 60
414 The number of seconds of inactivity that
415 .Nm tinc
416 will wait before sending a probe to the other end.
417 .It Va PingTimeout Li = Ar seconds Pq 5
418 The number of seconds to wait for a response to pings or to allow meta
419 connections to block. If the other end doesn't respond within this time,
420 the connection is terminated,
421 and the others will be notified of this.
422 .It Va PriorityInheritance Li = yes | no Po no Pc Bq experimental
423 When this option is enabled the value of the TOS field of tunneled IPv4 packets
424 will be inherited by the UDP packets that are sent out.
425 .It Va PrivateKey Li = Ar key Bq obsolete
426 The private RSA key of this tinc daemon.
427 It will allow this tinc daemon to authenticate itself to other daemons.
428 .It Va PrivateKeyFile Li = Ar filename Po Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /rsa_key.priv Pc
429 The file in which the private RSA key of this tinc daemon resides.
430 .It Va ProcessPriority Li = low | normal | high
431 When this option is used the priority of the 
432 .Nm tincd
433 process will be adjusted.
434 Increasing the priority may help to reduce latency and packet loss on the VPN.
435 .It Va Proxy Li = socks4 | socks5 | http | exec Ar ... Bq experimental
436 Use a proxy when making outgoing connections.
437 The following proxy types are currently supported:
438 .Bl -tag -width indent
439 .It socks4 Ar address Ar port Op Ar username
440 Connects to the proxy using the SOCKS version 4 protocol.
441 Optionally, a
442 .Ar username
443 can be supplied which will be passed on to the proxy server.
444 Only IPv4 connections can be proxied using SOCKS 4.
445 .It socks5 Ar address Ar port Op Ar username Ar password
446 Connect to the proxy using the SOCKS version 5 protocol.
447 If a
448 .Ar username
449 and
450 .Ar password
451 are given, basic username/password authentication will be used,
452 otherwise no authentication will be used.
453 .It http Ar address Ar port
454 Connects to the proxy and sends a HTTP CONNECT request.
455 .It exec Ar command
456 Executes the given
457 .Ar command
458 which should set up the outgoing connection.
459 The environment variables
460 .Ev NAME ,
461 .Ev NODE ,
462 .Ev REMOTEADDRES
463 and
464 .Ev REMOTEPORT
465 are available.
466 .El
467 .It Va ReplayWindow Li = Ar bytes Pq 32
468 This is the size of the replay tracking window for each remote node, in bytes.
469 The window is a bitfield which tracks 1 packet per bit, so for example
470 the default setting of 32 will track up to 256 packets in the window. In high
471 bandwidth scenarios, setting this to a higher value can reduce packet loss from
472 the interaction of replay tracking with underlying real packet loss and/or
473 reordering. Setting this to zero will disable replay tracking completely and
474 pass all traffic, but leaves tinc vulnerable to replay-based attacks on your
475 traffic.
476 .It Va StrictSubnets Li = yes | no Po no Pc Bq experimental
477 When this option is enabled tinc will only use Subnet statements which are
478 present in the host config files in the local
479 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/
480 directory. Subnets learned via connections to other nodes and which are not
481 present in the local host config files are ignored.
482 .It Va TunnelServer Li = yes | no Po no Pc Bq experimental
483 When this option is enabled tinc will no longer forward information between other tinc daemons,
484 and will only allow connections with nodes for which host config files are present in the local
485 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/
486 directory.
487 Setting this options also implicitly sets StrictSubnets.
488 .It Va UDPDiscovery Li = yes | no Po yes Pc
489 When this option is enabled tinc will try to establish UDP connectivity to nodes,
490 using TCP while it determines if a node is reachable over UDP. If it is disabled,
491 tinc always assumes a node is reachable over UDP.
492 Note that tinc will never use UDP with nodes that have
493 .Va TCPOnly
494 enabled.
495 .It Va UDPDiscoveryKeepaliveInterval Li = Ar seconds Pq 9
496 The minimum amount of time between sending UDP ping datagrams to check UDP connectivity once it has been established.
497 Note that these pings are large, since they are used to verify link MTU as well.
498 .It Va UDPDiscoveryInterval Li = Ar seconds Pq 2
499 The minimum amount of time between sending UDP ping datagrams to try to establish UDP connectivity.
500 .It Va UDPDiscoveryTimeout Li = Ar seconds Pq 30
501 If tinc doesn't receive any UDP ping replies over the specified interval,
502 it will assume UDP communication is broken and will fall back to TCP.
503 .It Va UDPInfoInterval Li = Ar seconds Pq 5
504 The minimum amount of time between sending periodic updates about UDP addresses, which are mostly useful for UDP hole punching.
505 .It Va UDPRcvBuf Li = Ar bytes Pq 1048576
506 Sets the socket receive buffer size for the UDP socket, in bytes.
507 If set to zero, the default buffer size will be used by the operating system.
508 Note: this setting can have a significant impact on performance, especially raw throughput.
509 .It Va UDPSndBuf Li = Ar bytes Pq 1048576
510 Sets the socket send buffer size for the UDP socket, in bytes.
511 If set to zero, the default buffer size will be used by the operating system.
512 Note: this setting can have a significant impact on performance, especially raw throughput.
513 .It Va UPnP Li = yes | udponly | no Po no Pc
514 If this option is enabled then tinc will search for UPnP-IGD devices on the local network.
515 It will then create and maintain port mappings for tinc's listening TCP and UDP ports.
516 If set to "udponly", tinc will only create a mapping for its UDP (data) port, not for its TCP (metaconnection) port.
517 Note that tinc must have been built with miniupnpc support for this feature to be available.
518 Furthermore, be advised that enabling this can have security implications, because the miniupnpc library that
519 tinc uses might not be well-hardened with regard to malicious UPnP replies.
520 .It Va UPnPDiscoverWait Li = Ar seconds Pq 5
521 The amount of time to wait for replies when probing the local network for UPnP devices.
522 .It Va UPnPRefreshPeriod Li = Ar seconds Pq 60
523 How often tinc will re-add the port mapping, in case it gets reset on the UPnP device. This also controls the duration of the port mapping itself, which will be set to twice that duration.
524 .El
525 .Sh HOST CONFIGURATION FILES
526 The host configuration files contain all information needed
527 to establish a connection to those hosts.
528 A host configuration file is also required for the local tinc daemon,
529 it will use it to read in it's listen port, public key and subnets.
530 .Pp
531 The idea is that these files are portable.
532 You can safely mail your own host configuration file to someone else.
533 That other person can then copy it to his own hosts directory,
534 and now his tinc daemon will be able to connect to your tinc daemon.
535 Since host configuration files only contain public keys,
536 no secrets are revealed by sending out this information.
537 .Bl -tag -width indent
538 .It Va Address Li = Ar address Oo Ar port Oc Bq recommended
539 The IP address or hostname of this tinc daemon on the real network.
540 This will only be used when trying to make an outgoing connection to this tinc daemon.
541 Optionally, a port can be specified to use for this address.
542 Multiple
543 .Va Address
544 variables can be specified, in which case each address will be tried until a working
545 connection has been established.
546 .It Va Cipher Li = Ar cipher Pq blowfish
547 The symmetric cipher algorithm used to encrypt UDP packets.
548 Any cipher supported by OpenSSL is recognised.
549 Furthermore, specifying
550 .Qq none
551 will turn off packet encryption.
552 It is best to use only those ciphers which support CBC mode.
553 This option has no effect for connections between nodes using
554 .Va ExperimentalProtocol .
555 .It Va ClampMSS Li = yes | no Pq yes
556 This option specifies whether tinc should clamp the maximum segment size (MSS)
557 of TCP packets to the path MTU. This helps in situations where ICMP
558 Fragmentation Needed or Packet too Big messages are dropped by firewalls.
559 .It Va Compression Li = Ar level Pq 0
560 This option sets the level of compression used for UDP packets.
561 Possible values are 0 (off), 1 (fast zlib) and any integer up to 9 (best zlib),
562 10 (fast lzo) and 11 (best lzo).
563 .It Va Digest Li = Ar digest Pq sha1
564 The digest algorithm used to authenticate UDP packets.
565 Any digest supported by OpenSSL is recognised.
566 Furthermore, specifying
567 .Qq none
568 will turn off packet authentication.
569 This option has no effect for connections between nodes using
570 .Va ExperimentalProtocol .
571 .It Va IndirectData Li = yes | no Pq no
572 When set to yes, only nodes which already have a meta connection to you
573 will try to establish direct communication with you.
574 It is best to leave this option out or set it to no.
575 .It Va MACLength Li = Ar length Pq 4
576 The length of the message authentication code used to authenticate UDP packets.
577 Can be anything from
578 .Qq 0
579 up to the length of the digest produced by the digest algorithm.
580 This option has no effect for connections between nodes using
581 .Va ExperimentalProtocol .
582 .It Va PMTU Li = Ar mtu Po 1514 Pc
583 This option controls the initial path MTU to this node.
584 .It Va PMTUDiscovery Li = yes | no Po yes Pc
585 When this option is enabled, tinc will try to discover the path MTU to this node.
586 After the path MTU has been discovered, it will be enforced on the VPN.
587 .It Va MTUInfoInterval Li = Ar seconds Pq 5
588 The minimum amount of time between sending periodic updates about relay path MTU. Useful for quickly determining MTU to indirect nodes.
589 .It Va Port Li = Ar port Pq 655
590 The port number on which this tinc daemon is listening for incoming connections,
591 which is used if no port number is specified in an
592 .Va Address
593 statement.
594 .Pp
595 If this is set to zero, the port will be randomly assigned by the system. This is useful to randomize source ports of UDP packets, which can improve UDP hole punching reliability. When setting
596 .Va Port
597 to zero it is recommended to set
598 .Va AddressFamily
599 as well, otherwise
600 .Nm tinc
601 will assign different ports to different address families but other nodes can only know of one.
602 .It Va PublicKey Li = Ar key Bq obsolete
603 The public RSA key of this tinc daemon.
604 It will be used to cryptographically verify it's identity and to set up a secure connection.
605 .It Va PublicKeyFile Li = Ar filename Bq obsolete
606 The file in which the public RSA key of this tinc daemon resides.
607 .Pp
608 From version 1.0pre4 on
609 .Nm tinc
610 will store the public key directly into the host configuration file in PEM format,
611 the above two options then are not necessary.
612 Either the PEM format is used, or exactly one of the above two options must be specified
613 in each host configuration file,
614 if you want to be able to establish a connection with that host.
615 .It Va Subnet Li = Ar address Ns Op Li / Ns Ar prefixlength Ns Op Li # Ns Ar weight
616 The subnet which this tinc daemon will serve.
617 .Nm tinc
618 tries to look up which other daemon it should send a packet to by searching the appropriate subnet.
619 If the packet matches a subnet,
620 it will be sent to the daemon who has this subnet in his host configuration file.
621 Multiple
622 .Va Subnet
623 variables can be specified.
624 .Pp
625 Subnets can either be single MAC, IPv4 or IPv6 addresses,
626 in which case a subnet consisting of only that single address is assumed,
627 or they can be a IPv4 or IPv6 network address with a prefixlength.
628 For example, IPv4 subnets must be in a form like 192.168.1.0/24,
629 where 192.168.1.0 is the network address and 24 is the number of bits set in the netmask.
630 Note that subnets like 192.168.1.1/24 are invalid!
631 Read a networking HOWTO/FAQ/guide if you don't understand this.
632 IPv6 subnets are notated like fec0:0:0:1::/64.
633 MAC addresses are notated like 0:1a:2b:3c:4d:5e.
634 .Pp
635 A Subnet can be given a weight to indicate its priority over identical Subnets
636 owned by different nodes. The default weight is 10. Lower values indicate
637 higher priority. Packets will be sent to the node with the highest priority,
638 unless that node is not reachable, in which case the node with the next highest
639 priority will be tried, and so on.
640 .It Va TCPOnly Li = yes | no Pq no Bq obsolete
641 If this variable is set to yes,
642 then the packets are tunnelled over the TCP connection instead of a UDP connection.
643 This is especially useful for those who want to run a tinc daemon
644 from behind a masquerading firewall,
645 or if UDP packet routing is disabled somehow.
646 Setting this options also implicitly sets IndirectData.
647 .Pp
648 Since version 1.0.10, tinc will automatically detect whether communication via
649 UDP is possible or not.
650 .It Va Weight Li = Ar weight
651 If this variable is set, it overrides the weight given to connections made with
652 another host. A higher
653 .Ar weight
654 means a lower priority is given to this connection when broadcasting or
655 forwarding packets.
656 .El
657 .Sh SCRIPTS
658 Apart from reading the server and host configuration files,
659 tinc can also run scripts at certain moments.
660 Below is a list of filenames of scripts and a description of when they are run.
661 A script is only run if it exists and if it is executable.
662 .Pp
663 Scripts are run synchronously;
664 this means that tinc will temporarily stop processing packets until the called script finishes executing.
665 This guarantees that scripts will execute in the exact same order as the events that trigger them.
666 If you need to run commands asynchronously, you have to ensure yourself that they are being run in the background.
667 .Pp
668 Under Windows (not Cygwin), the scripts must have the extension
669 .Pa .bat
670 or
671 .Pa .cmd .
672 .Bl -tag -width indent
673 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-up
674 This is the most important script.
675 If it is present it will be executed right after the tinc daemon has been started and has connected to the virtual network device (or when the first node becomes reachable if
676 .Va DeviceStandby
677 is used).
678 It should be used to set up the corresponding network interface,
679 but can also be used to start other things.
680 .Pp
681 Under Windows you can use the Network Connections control panel instead of creating this script.
682 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
683 This script is started right before the tinc daemon quits (or when the last node becomes unreachable if
684 .Va DeviceStandby
685 is used).
686 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar HOST Ns Pa -up
687 This script is started when the tinc daemon with name
688 .Ar HOST
689 becomes reachable.
690 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar HOST Ns Pa -down
691 This script is started when the tinc daemon with name
692 .Ar HOST
693 becomes unreachable.
694 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /host-up
695 This script is started when any host becomes reachable.
696 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /host-down
697 This script is started when any host becomes unreachable.
698 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /subnet-up
699 This script is started when a Subnet becomes reachable.
700 The Subnet and the node it belongs to are passed in environment variables.
701 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /subnet-down
702 This script is started when a Subnet becomes unreachable.
703 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /invitation-created
704 This script is started when a new invitation has been created.
705 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /invitation-accepted
706 This script is started when an invitation has been used.
707 .El
708 .Pp
709 The scripts are started without command line arguments, but can make use of certain environment variables.
710 Under UNIX like operating systems the names of environment variables must be preceded by a
711 .Li $ 
712 in scripts.
713 Under Windows, in
714 .Pa .bat
715 or
716 .Pa .cmd
717 files, they have to be put between
718 .Li %
719 signs.
720 .Bl -tag -width indent
721 .It Ev NETNAME
722 If a netname was specified, this environment variable contains it.
723 .It Ev NAME
724 Contains the name of this tinc daemon.
725 .It Ev DEVICE
726 Contains the name of the virtual network device that tinc uses.
727 .It Ev INTERFACE
728 Contains the name of the virtual network interface that tinc uses.
729 This should be used for commands like
730 .Pa ifconfig .
731 .It Ev NODE
732 When a host becomes (un)reachable, this is set to its name.
733 If a subnet becomes (un)reachable, this is set to the owner of that subnet.
734 .It Ev REMOTEADDRESS
735 When a host becomes (un)reachable, this is set to its real address.
736 .It Ev REMOTEPORT
737 When a host becomes (un)reachable, this is set to the port number it uses for communication with other tinc daemons.
738 .It Ev SUBNET
739 When a subnet becomes (un)reachable, this is set to the subnet.
740 .It Ev WEIGHT
741 When a subnet becomes (un)reachable, this is set to the subnet weight.
742 .It Ev INVITATION_FILE
743 When the
744 .Pa invitation-created
745 script is called, this is set to the file where the invitation details will be stored.
746 .It Ev INVITATION_URL
747 When the
748 .Pa invitation-created
749 script is called, this is set to the invitation URL that has been created.
750 .El
751 .Pp
752 Do not forget that under UNIX operating systems, you have to make the scripts executable, using the command
753 .Nm chmod Li a+x Pa script .
754 .Sh FILES
755 The most important files are:
756 .Bl -tag -width indent
757 .It Pa @sysconfdir@/tinc/
758 The top directory for configuration files.
759 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf
760 The default name of the server configuration file for net
761 .Ar NETNAME .
762 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /conf.d/
763 Optional directory from which any .conf file will be loaded
764 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/
765 Host configuration files are kept in this directory.
766 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-up
767 If an executable file with this name exists,
768 it will be executed right after the tinc daemon has connected to the virtual network device.
769 It can be used to set up the corresponding network interface.
770 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
771 If an executable file with this name exists,
772 it will be executed right before the tinc daemon is going to close
773 its connection to the virtual network device.
774 .El
775 .Sh SEE ALSO
776 .Xr tincd 8 ,
777 .Xr tinc 8 ,
778 .Pa http://www.tinc-vpn.org/ ,
779 .Pa http://www.tldp.org/LDP/nag2/ .
780 .Pp
781 The full documentation for
782 .Nm tinc
783 is maintained as a Texinfo manual.
784 If the info and tinc programs are properly installed at your site, the command
785 .Ic info tinc
786 should give you access to the complete manual.
787 .Pp
788 .Nm tinc
789 comes with ABSOLUTELY NO WARRANTY.
790 This is free software, and you are welcome to redistribute it under certain conditions;
791 see the file COPYING for details.