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