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