fd_device: allow fd to be passed through a unix socket
[tinc] / doc / tinc.conf.5.in
1 .Dd 2017-09-02
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
10 The files in the
11 .Pa @sysconfdir@/tinc/
12 directory contain runtime and security information for the tinc daemon.
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 
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.
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 .
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
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 Pq yes
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., 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, as well as multicast space (IPv4, 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 have disabled
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 fd
238 Use a file descriptor, given directly as an integer or passed through a unix domain socket.
239 On Linux, an abstract socket address can be specified by using "@" as a prefix.
240 All packets are read from this interface.
241 Packets received for the local node are written to it.
242 .It uml Pq not compiled in by default
243 Create a UNIX socket with the filename specified by
244 .Va Device ,
245 or
246 .Pa @runstatedir@/ Ns Ar NETNAME Ns Pa .umlsocket
247 if not specified.
248 .Nm tinc
249 will wait for a User Mode Linux instance to connect to this socket.
250 .It vde Pq not compiled in by default
251 Uses the libvdeplug library to connect to a Virtual Distributed Ethernet switch,
252 using the UNIX socket specified by
253 .Va Device ,
254 or
255 .Pa @runstatedir@/vde.ctl
256 if not specified.
257 .El
258 Also, in case tinc does not seem to correctly interpret packets received from the virtual network device,
259 it can be used to change the way packets are interpreted:
260 .Bl -tag -width indent
261 .It tun Pq BSD and Linux
262 Set type to tun.
263 Depending on the platform, this can either be with or without an address family header (see below).
264 .It tunnohead Pq BSD
265 Set type to tun without an address family header.
266 Tinc will expect packets read from the virtual network device to start with an IP header.
267 On some platforms IPv6 packets cannot be read from or written to the device in this mode.
268 .It tunifhead Pq BSD
269 Set type to tun with an address family header.
270 Tinc will expect packets read from the virtual network device
271 to start with a four byte header containing the address family,
272 followed by an IP header.
273 This mode should support both IPv4 and IPv6 packets.
274 .It utun Pq OS X
275 Set type to utun.
276 This is only supported on OS X version 10.6.8 and higher, but doesn't require the tuntaposx module.
277 This mode should support both IPv4 and IPv6 packets.
278 .It tap Pq BSD and Linux
279 Set type to tap.
280 Tinc will expect packets read from the virtual network device
281 to start with an Ethernet header.
282 .El
283 .It Va DirectOnly Li = yes | no Po no Pc Bq experimental
284 When this option is enabled, packets that cannot be sent directly to the destination node,
285 but which would have to be forwarded by an intermediate node, are dropped instead.
286 When combined with the IndirectData option,
287 packets for nodes for which we do not have a meta connection with are also dropped.
288 .It Va Ed25519PrivateKeyFile Li = Ar filename Po Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /ed25519_key.priv Pc
289 The file in which the private Ed25519 key of this tinc daemon resides.
290 This is only used if
291 .Va ExperimentalProtocol
292 is enabled.
293 .It Va ExperimentalProtocol Li = yes | no Pq yes
294 When this option is enabled, the SPTPS protocol will be used when connecting to nodes that also support it.
295 Ephemeral ECDH will be used for key exchanges,
296 and Ed25519 will be used instead of RSA for authentication.
297 When enabled, an Ed25519 key must have been generated before with
298 .Nm tinc generate-ed25519-keys .
299 .It Va Forwarding Li = off | internal | kernel Po internal Pc Bq experimental
300 This option selects the way indirect packets are forwarded.
301 .Bl -tag -width indent
302 .It off
303 Incoming packets that are not meant for the local node,
304 but which should be forwarded to another node, are dropped.
305 .It internal
306 Incoming packets that are meant for another node are forwarded by tinc internally.
307 .Pp
308 This is the default mode, and unless you really know you need another forwarding mode, don't change it.
309 .It kernel
310 Incoming packets using the legacy protocol are always sent to the TUN/TAP device,
311 even if the packets are not for the local node.
312 This is less efficient, but allows the kernel to apply its routing and firewall rules on them,
313 and can also help debugging.
314 Incoming packets using the SPTPS protocol are dropped, since they are end-to-end encrypted.
315 .El
316 .It Va FWMark Li = Ar value Po 0 Pc Bq experimental
317 When set to a non-zero value, all TCP and UDP sockets created by tinc will use the given value as the firewall mark.
318 This can be used for mark-based routing or for packet filtering.
319 This option is currently only supported on Linux.
320 .It Va Hostnames Li = yes | no Pq no
321 This option selects whether IP addresses (both real and on the VPN) should
322 be resolved. Since DNS lookups are blocking, it might affect tinc's
323 efficiency, even stopping the daemon for a few seconds every time it does
324 a lookup if your DNS server is not responding.
325 .Pp
326 This does not affect resolving hostnames to IP addresses from the
327 host configuration files, but whether hostnames should be resolved while logging.
328 .It Va IffOneQueue Li = yes | no Po no Pc Bq experimental
329 (Linux only) Set IFF_ONE_QUEUE flag on TUN/TAP devices.
330 .It Va Interface Li = Ar interface
331 Defines the name of the interface corresponding to the virtual network device.
332 Depending on the operating system and the type of device this may or may not actually set the name of the interface.
333 Under Windows, this variable is used to select which network interface will be used.
334 If you specified a
335 .Va Device ,
336 this variable is almost always already correctly set.
337 .It Va InvitationExpire Li = Ar seconds Pq 604800
338 This option controls the period invitations are valid.
339 .It Va KeyExpire Li = Ar seconds Pq 3600
340 This option controls the period the encryption keys used to encrypt the data are valid.
341 It is common practice to change keys at regular intervals to make it even harder for crackers,
342 even though it is thought to be nearly impossible to crack a single key.
343 .It Va ListenAddress Li = Ar address Op Ar port
344 If your computer has more than one IPv4 or IPv6 address,
345 .Nm tinc
346 will by default listen on all of them for incoming connections.
347 This option can be used to restrict which addresses tinc listens on.
348 Multiple
349 .Va ListenAddress
350 variables may be specified,
351 in which case listening sockets for each specified address are made.
352 .Pp
353 If no
354 .Ar port
355 is specified, the socket will listen on the port specified by the
356 .Va Port
357 option, or to port 655 if neither is given.
358 To only listen on a specific port but not on a specific address, use
359 .Li *
360 for the
361 .Ar address .
362 .Pp
363 If
364 .Ar port
365 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
366 .Va AddressFamily
367 as well, otherwise
368 .Nm tinc
369 will assign different ports to different address families but other nodes can only know of one.
370 .It Va LocalDiscovery Li = yes | no Pq yes
371 When enabled,
372 .Nm tinc
373 will try to detect peers that are on the same local network.
374 This will allow direct communication using LAN addresses, even if both peers are behind a NAT
375 and they only ConnectTo a third node outside the NAT,
376 which normally would prevent the peers from learning each other's LAN address.
377 .Pp
378 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.
379 .It Va LogLevel Li = level Pq 0
380 This option controls the verbosity of the logging. The higher the debug level, the more messages it will log.
381 .It Va MACExpire Li = Ar seconds Pq 600
382 This option controls the amount of time MAC addresses are kept before they are removed.
383 This only has effect when
384 .Va Mode
385 is set to
386 .Qq switch .
387 .It Va MaxConnectionBurst Li = Ar count Pq 100
388 This option controls how many connections tinc accepts in quick succession.
389 If there are more connections than the given number in a short time interval,
390 tinc will reduce the number of accepted connections to only one per second,
391 until the burst has passed.
392 .It Va MaxTimeout Li = Ar seconds Pq 900
393 This is the maximum delay before trying to reconnect to other tinc daemons.
394 .It Va Mode Li = router | switch | hub Pq router
395 This option selects the way packets are routed to other daemons.
396 .Bl -tag -width indent
397 .It router
398 In this mode
399 .Va Subnet
400 variables in the host configuration files will be used to form a routing table.
401 Only packets of routable protocols (IPv4 and IPv6) are supported in this mode.
402 .Pp
403 This is the default mode, and unless you really know you need another mode, don't change it.
404 .It switch
405 In this mode the MAC addresses of the packets on the VPN will be used to
406 dynamically create a routing table just like an Ethernet switch does.
407 Unicast, multicast and broadcast packets of every protocol that runs over Ethernet are supported in this mode
408 at the cost of frequent broadcast ARP requests and routing table updates.
409 .Pp
410 This mode is primarily useful if you want to bridge Ethernet segments.
411 .It hub
412 This mode is almost the same as the switch mode, but instead
413 every packet will be broadcast to the other daemons
414 while no routing table is managed.
415 .El
416 .It Va Name Li = Ar name Bq required
417 This is the name which identifies this tinc daemon.
418 It must be unique for the virtual private network this daemon will connect to.
419 .Va Name
420 may only consist of alphanumeric and underscore characters (a-z, A-Z, 0-9 and _), and is case sensitive.
421 If 
422 .Va Name
423 starts with a
424 .Li $ ,
425 then the contents of the environment variable that follows will be used.
426 In that case, invalid characters will be converted to underscores.
427 If
428 .Va Name
429 is
430 .Li $HOST ,
431 but no such environment variable exist, the hostname will be read using the gethostname() system call.
432 .It Va PingInterval Li = Ar seconds Pq 60
433 The number of seconds of inactivity that
434 .Nm tinc
435 will wait before sending a probe to the other end.
436 .It Va PingTimeout Li = Ar seconds Pq 5
437 The number of seconds to wait for a response to pings or to allow meta
438 connections to block. If the other end doesn't respond within this time,
439 the connection is terminated,
440 and the others will be notified of this.
441 .It Va PriorityInheritance Li = yes | no Po no Pc Bq experimental
442 When this option is enabled the value of the TOS field of tunneled IPv4 packets
443 will be inherited by the UDP packets that are sent out.
444 .It Va PrivateKey Li = Ar key Bq obsolete
445 The private RSA key of this tinc daemon.
446 It will allow this tinc daemon to authenticate itself to other daemons.
447 .It Va PrivateKeyFile Li = Ar filename Po Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /rsa_key.priv Pc
448 The file in which the private RSA key of this tinc daemon resides.
449 .It Va ProcessPriority Li = low | normal | high
450 When this option is used the priority of the 
451 .Nm tincd
452 process will be adjusted.
453 Increasing the priority may help to reduce latency and packet loss on the VPN.
454 .It Va Proxy Li = socks4 | socks5 | http | exec Ar ... Bq experimental
455 Use a proxy when making outgoing connections.
456 The following proxy types are currently supported:
457 .Bl -tag -width indent
458 .It socks4 Ar address Ar port Op Ar username
459 Connects to the proxy using the SOCKS version 4 protocol.
460 Optionally, a
461 .Ar username
462 can be supplied which will be passed on to the proxy server.
463 Only IPv4 connections can be proxied using SOCKS 4.
464 .It socks5 Ar address Ar port Op Ar username Ar password
465 Connect to the proxy using the SOCKS version 5 protocol.
466 If a
467 .Ar username
468 and
469 .Ar password
470 are given, basic username/password authentication will be used,
471 otherwise no authentication will be used.
472 .It http Ar address Ar port
473 Connects to the proxy and sends a HTTP CONNECT request.
474 .It exec Ar command
475 Executes the given
476 .Ar command
477 which should set up the outgoing connection.
478 The environment variables
479 .Ev NAME ,
480 .Ev NODE ,
482 and
484 are available.
485 .El
486 .It Va ReplayWindow Li = Ar bytes Pq 32
487 This is the size of the replay tracking window for each remote node, in bytes.
488 The window is a bitfield which tracks 1 packet per bit, so for example
489 the default setting of 32 will track up to 256 packets in the window. In high
490 bandwidth scenarios, setting this to a higher value can reduce packet loss from
491 the interaction of replay tracking with underlying real packet loss and/or
492 reordering. Setting this to zero will disable replay tracking completely and
493 pass all traffic, but leaves tinc vulnerable to replay-based attacks on your
494 traffic.
495 .It Va StrictSubnets Li = yes | no Po no Pc Bq experimental
496 When this option is enabled tinc will only use Subnet statements which are
497 present in the host config files in the local
498 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/
499 directory. Subnets learned via connections to other nodes and which are not
500 present in the local host config files are ignored.
501 .It Va TunnelServer Li = yes | no Po no Pc Bq experimental
502 When this option is enabled tinc will no longer forward information between other tinc daemons,
503 and will only allow connections with nodes for which host config files are present in the local
504 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/
505 directory.
506 Setting this options also implicitly sets StrictSubnets.
507 .It Va UDPDiscovery Li = yes | no Po yes Pc
508 When this option is enabled tinc will try to establish UDP connectivity to nodes,
509 using TCP while it determines if a node is reachable over UDP. If it is disabled,
510 tinc always assumes a node is reachable over UDP.
511 Note that tinc will never use UDP with nodes that have
512 .Va TCPOnly
513 enabled.
514 .It Va UDPDiscoveryKeepaliveInterval Li = Ar seconds Pq 9
515 The minimum amount of time between sending UDP ping datagrams to check UDP connectivity once it has been established.
516 Note that these pings are large, since they are used to verify link MTU as well.
517 .It Va UDPDiscoveryInterval Li = Ar seconds Pq 2
518 The minimum amount of time between sending UDP ping datagrams to try to establish UDP connectivity.
519 .It Va UDPDiscoveryTimeout Li = Ar seconds Pq 30
520 If tinc doesn't receive any UDP ping replies over the specified interval,
521 it will assume UDP communication is broken and will fall back to TCP.
522 .It Va UDPInfoInterval Li = Ar seconds Pq 5
523 The minimum amount of time between sending periodic updates about UDP addresses, which are mostly useful for UDP hole punching.
524 .It Va UDPRcvBuf Li = Ar bytes Pq 1048576
525 Sets the socket receive buffer size for the UDP socket, in bytes.
526 If set to zero, the default buffer size will be used by the operating system.
527 Note: this setting can have a significant impact on performance, especially raw throughput.
528 .It Va UDPSndBuf Li = Ar bytes Pq 1048576
529 Sets the socket send buffer size for the UDP socket, in bytes.
530 If set to zero, the default buffer size will be used by the operating system.
531 Note: this setting can have a significant impact on performance, especially raw throughput.
532 .It Va UPnP Li = yes | udponly | no Po no Pc
533 If this option is enabled then tinc will search for UPnP-IGD devices on the local network.
534 It will then create and maintain port mappings for tinc's listening TCP and UDP ports.
535 If set to "udponly", tinc will only create a mapping for its UDP (data) port, not for its TCP (metaconnection) port.
536 Note that tinc must have been built with miniupnpc support for this feature to be available.
537 Furthermore, be advised that enabling this can have security implications, because the miniupnpc library that
538 tinc uses might not be well-hardened with regard to malicious UPnP replies.
539 .It Va UPnPDiscoverWait Li = Ar seconds Pq 5
540 The amount of time to wait for replies when probing the local network for UPnP devices.
541 .It Va UPnPRefreshPeriod Li = Ar seconds Pq 60
542 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.
543 .El
545 The host configuration files contain all information needed
546 to establish a connection to those hosts.
547 A host configuration file is also required for the local tinc daemon,
548 it will use it to read in it's listen port, public key and subnets.
549 .Pp
550 The idea is that these files are portable.
551 You can safely mail your own host configuration file to someone else.
552 That other person can then copy it to his own hosts directory,
553 and now his tinc daemon will be able to connect to your tinc daemon.
554 Since host configuration files only contain public keys,
555 no secrets are revealed by sending out this information.
556 .Bl -tag -width indent
557 .It Va Address Li = Ar address Oo Ar port Oc Bq recommended
558 The IP address or hostname of this tinc daemon on the real network.
559 This will only be used when trying to make an outgoing connection to this tinc daemon.
560 Optionally, a port can be specified to use for this address.
561 Multiple
562 .Va Address
563 variables can be specified, in which case each address will be tried until a working
564 connection has been established.
565 .It Va Cipher Li = Ar cipher Pq blowfish
566 The symmetric cipher algorithm used to encrypt UDP packets.
567 Any cipher supported by LibreSSL or OpenSSL is recognised.
568 Furthermore, specifying
569 .Qq none
570 will turn off packet encryption.
571 It is best to use only those ciphers which support CBC mode.
572 This option has no effect for connections between nodes using
573 .Va ExperimentalProtocol .
574 .It Va ClampMSS Li = yes | no Pq yes
575 This option specifies whether tinc should clamp the maximum segment size (MSS)
576 of TCP packets to the path MTU. This helps in situations where ICMP
577 Fragmentation Needed or Packet too Big messages are dropped by firewalls.
578 .It Va Compression Li = Ar level Pq 0
579 This option sets the level of compression used for UDP packets.
580 Possible values are 0 (off), 1 (fast zlib) and any integer up to 9 (best zlib),
581 10 (fast lzo) and 11 (best lzo).
582 .It Va Digest Li = Ar digest Pq sha1
583 The digest algorithm used to authenticate UDP packets.
584 Any digest supported by LibreSSL or OpenSSL is recognised.
585 Furthermore, specifying
586 .Qq none
587 will turn off packet authentication.
588 This option has no effect for connections between nodes using
589 .Va ExperimentalProtocol .
590 .It Va IndirectData Li = yes | no Pq no
591 When set to yes, only nodes which already have a meta connection to you
592 will try to establish direct communication with you.
593 It is best to leave this option out or set it to no.
594 .It Va MACLength Li = Ar length Pq 4
595 The length of the message authentication code used to authenticate UDP packets.
596 Can be anything from
597 .Qq 0
598 up to the length of the digest produced by the digest algorithm.
599 This option has no effect for connections between nodes using
600 .Va ExperimentalProtocol .
601 .It Va PMTU Li = Ar mtu Po 1514 Pc
602 This option controls the initial path MTU to this node.
603 .It Va PMTUDiscovery Li = yes | no Po yes Pc
604 When this option is enabled, tinc will try to discover the path MTU to this node.
605 After the path MTU has been discovered, it will be enforced on the VPN.
606 .It Va MTUInfoInterval Li = Ar seconds Pq 5
607 The minimum amount of time between sending periodic updates about relay path MTU. Useful for quickly determining MTU to indirect nodes.
608 .It Va Port Li = Ar port Pq 655
609 The port number on which this tinc daemon is listening for incoming connections,
610 which is used if no port number is specified in an
611 .Va Address
612 statement.
613 .Pp
614 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
615 .Va Port
616 to zero it is recommended to set
617 .Va AddressFamily
618 as well, otherwise
619 .Nm tinc
620 will assign different ports to different address families but other nodes can only know of one.
621 .It Va PublicKey Li = Ar key Bq obsolete
622 The public RSA key of this tinc daemon.
623 It will be used to cryptographically verify it's identity and to set up a secure connection.
624 .It Va PublicKeyFile Li = Ar filename Bq obsolete
625 The file in which the public RSA key of this tinc daemon resides.
626 .Pp
627 From version 1.0pre4 on
628 .Nm tinc
629 will store the public key directly into the host configuration file in PEM format,
630 the above two options then are not necessary.
631 Either the PEM format is used, or exactly one of the above two options must be specified
632 in each host configuration file,
633 if you want to be able to establish a connection with that host.
634 .It Va Subnet Li = Ar address Ns Op Li / Ns Ar prefixlength Ns Op Li # Ns Ar weight
635 The subnet which this tinc daemon will serve.
636 .Nm tinc
637 tries to look up which other daemon it should send a packet to by searching the appropriate subnet.
638 If the packet matches a subnet,
639 it will be sent to the daemon who has this subnet in his host configuration file.
640 Multiple
641 .Va Subnet
642 variables can be specified.
643 .Pp
644 Subnets can either be single MAC, IPv4 or IPv6 addresses,
645 in which case a subnet consisting of only that single address is assumed,
646 or they can be a IPv4 or IPv6 network address with a prefixlength.
647 For example, IPv4 subnets must be in a form like,
648 where is the network address and 24 is the number of bits set in the netmask.
649 Note that subnets like are invalid!
650 Read a networking HOWTO/FAQ/guide if you don't understand this.
651 IPv6 subnets are notated like fec0:0:0:1::/64.
652 MAC addresses are notated like 0:1a:2b:3c:4d:5e.
653 .Pp
654 A Subnet can be given a weight to indicate its priority over identical Subnets
655 owned by different nodes. The default weight is 10. Lower values indicate
656 higher priority. Packets will be sent to the node with the highest priority,
657 unless that node is not reachable, in which case the node with the next highest
658 priority will be tried, and so on.
659 .It Va TCPOnly Li = yes | no Pq no Bq obsolete
660 If this variable is set to yes,
661 then the packets are tunnelled over the TCP connection instead of a UDP connection.
662 This is especially useful for those who want to run a tinc daemon
663 from behind a masquerading firewall,
664 or if UDP packet routing is disabled somehow.
665 Setting this options also implicitly sets IndirectData.
666 .Pp
667 Since version 1.0.10, tinc will automatically detect whether communication via
668 UDP is possible or not.
669 .It Va Weight Li = Ar weight
670 If this variable is set, it overrides the weight given to connections made with
671 another host. A higher
672 .Ar weight
673 means a lower priority is given to this connection when broadcasting or
674 forwarding packets.
675 .El
677 Apart from reading the server and host configuration files,
678 tinc can also run scripts at certain moments.
679 Below is a list of filenames of scripts and a description of when they are run.
680 A script is only run if it exists and if it is executable.
681 .Pp
682 Scripts are run synchronously;
683 this means that tinc will temporarily stop processing packets until the called script finishes executing.
684 This guarantees that scripts will execute in the exact same order as the events that trigger them.
685 If you need to run commands asynchronously, you have to ensure yourself that they are being run in the background.
686 .Pp
687 Under Windows, the scripts must have the extension
688 .Pa .bat
689 or
690 .Pa .cmd .
691 .Bl -tag -width indent
692 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-up
693 This is the most important script.
694 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
695 .Va DeviceStandby
696 is used).
697 It should be used to set up the corresponding network interface,
698 but can also be used to start other things.
699 .Pp
700 Under Windows you can use the Network Connections control panel instead of creating this script.
701 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
702 This script is started right before the tinc daemon quits (or when the last node becomes unreachable if
703 .Va DeviceStandby
704 is used).
705 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar HOST Ns Pa -up
706 This script is started when the tinc daemon with name
707 .Ar HOST
708 becomes reachable.
709 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar HOST Ns Pa -down
710 This script is started when the tinc daemon with name
711 .Ar HOST
712 becomes unreachable.
713 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /host-up
714 This script is started when any host becomes reachable.
715 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /host-down
716 This script is started when any host becomes unreachable.
717 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /subnet-up
718 This script is started when a Subnet becomes reachable.
719 The Subnet and the node it belongs to are passed in environment variables.
720 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /subnet-down
721 This script is started when a Subnet becomes unreachable.
722 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /invitation-created
723 This script is started when a new invitation has been created.
724 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /invitation-accepted
725 This script is started when an invitation has been used.
726 .El
727 .Pp
728 The scripts are started without command line arguments, but can make use of certain environment variables.
729 Under UNIX like operating systems the names of environment variables must be preceded by a
730 .Li $ 
731 in scripts.
732 Under Windows, in
733 .Pa .bat
734 or
735 .Pa .cmd
736 files, they have to be put between
737 .Li %
738 signs.
739 .Bl -tag -width indent
740 .It Ev NETNAME
741 If a netname was specified, this environment variable contains it.
742 .It Ev NAME
743 Contains the name of this tinc daemon.
744 .It Ev DEVICE
745 Contains the name of the virtual network device that tinc uses.
747 Contains the name of the virtual network interface that tinc uses.
748 This should be used for commands like
749 .Pa ifconfig .
750 .It Ev NODE
751 When a host becomes (un)reachable, this is set to its name.
752 If a subnet becomes (un)reachable, this is set to the owner of that subnet.
754 When a host becomes (un)reachable, this is set to its real address.
756 When a host becomes (un)reachable, this is set to the port number it uses for communication with other tinc daemons.
757 .It Ev SUBNET
758 When a subnet becomes (un)reachable, this is set to the subnet.
759 .It Ev WEIGHT
760 When a subnet becomes (un)reachable, this is set to the subnet weight.
762 When the
763 .Pa invitation-created
764 script is called, this is set to the file where the invitation details will be stored.
766 When the
767 .Pa invitation-created
768 script is called, this is set to the invitation URL that has been created.
769 .El
770 .Pp
771 Do not forget that under UNIX operating systems, you have to make the scripts executable, using the command
772 .Nm chmod Li a+x Pa script .
773 .Sh FILES
774 The most important files are:
775 .Bl -tag -width indent
776 .It Pa @sysconfdir@/tinc/
777 The top directory for configuration files.
778 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf
779 The default name of the server configuration file for net
780 .Ar NETNAME .
781 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /conf.d/
782 Optional directory from which any .conf file will be loaded
783 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/
784 Host configuration files are kept in this directory.
785 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-up
786 If an executable file with this name exists,
787 it will be executed right after the tinc daemon has connected to the virtual network device.
788 It can be used to set up the corresponding network interface.
789 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
790 If an executable file with this name exists,
791 it will be executed right before the tinc daemon is going to close
792 its connection to the virtual network device.
793 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /invitations/
794 This directory contains outstanding invitations.
795 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /invitation-data
796 After a successful join, this file contains a copy of the invitation data received.
797 .El
798 .Sh SEE ALSO
799 .Xr tincd 8 ,
800 .Xr tinc 8 ,
801 .Pa https://www.tinc-vpn.org/ ,
802 .Pa http://www.tldp.org/LDP/nag2/ .
803 .Pp
804 The full documentation for
805 .Nm tinc
806 is maintained as a Texinfo manual.
807 If the info and tinc programs are properly installed at your site, the command
808 .Ic info tinc
809 should give you access to the complete manual.
810 .Pp
811 .Nm tinc
813 This is free software, and you are welcome to redistribute it under certain conditions;
814 see the file COPYING for details.