| 1 | .Dd 2002-04-09 |
1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 |
| 2 | .Dt TINC.CONF 5 |
2 | .\" |
| 3 | .\" Manual page created by: |
3 | .\" Standard preamble: |
| 4 | .\" Ivo Timmermans <ivo@o2w.nl> |
4 | .\" ======================================================================== |
| 5 | .\" Guus Sliepen <guus@sliepen.eu.org> |
5 | .de Sh \" Subsection heading |
| 6 | .Sh NAME |
6 | .br |
| 7 | .Nm tinc.conf |
7 | .if t .Sp |
| 8 | .Nd tinc daemon configuration |
8 | .ne 5 |
|
|
9 | .PP |
|
|
10 | \fB\\$1\fR |
|
|
11 | .PP |
|
|
12 | .. |
|
|
13 | .de Sp \" Vertical space (when we can't use .PP) |
|
|
14 | .if t .sp .5v |
|
|
15 | .if n .sp |
|
|
16 | .. |
|
|
17 | .de Vb \" Begin verbatim text |
|
|
18 | .ft CW |
|
|
19 | .nf |
|
|
20 | .ne \\$1 |
|
|
21 | .. |
|
|
22 | .de Ve \" End verbatim text |
|
|
23 | .ft R |
|
|
24 | .fi |
|
|
25 | .. |
|
|
26 | .\" Set up some character translations and predefined strings. \*(-- will |
|
|
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
|
|
28 | .\" double quote, and \*(R" will give a right double quote. | will give a |
|
|
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
|
|
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
|
|
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. |
|
|
32 | .tr \(*W-|\(bv\*(Tr |
|
|
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
|
|
34 | .ie n \{\ |
|
|
35 | . ds -- \(*W- |
|
|
36 | . ds PI pi |
|
|
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
|
|
38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
|
|
39 | . ds L" "" |
|
|
40 | . ds R" "" |
|
|
41 | . ds C` |
|
|
42 | . ds C' |
|
|
43 | 'br\} |
|
|
44 | .el\{\ |
|
|
45 | . ds -- \|\(em\| |
|
|
46 | . ds PI \(*p |
|
|
47 | . ds L" `` |
|
|
48 | . ds R" '' |
|
|
49 | 'br\} |
|
|
50 | .\" |
|
|
51 | .\" If the F register is turned on, we'll generate index entries on stderr for |
|
|
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
|
|
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
|
|
54 | .\" output yourself in some meaningful fashion. |
|
|
55 | .if \nF \{\ |
|
|
56 | . de IX |
|
|
57 | . tm Index:\\$1\t\\n%\t"\\$2" |
|
|
58 | .. |
|
|
59 | . nr % 0 |
|
|
60 | . rr F |
|
|
61 | .\} |
|
|
62 | .\" |
|
|
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
|
|
64 | .\" way too many mistakes in technical documents. |
|
|
65 | .hy 0 |
|
|
66 | .if n .na |
|
|
67 | .\" |
|
|
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
|
|
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
|
|
70 | . \" fudge factors for nroff and troff |
|
|
71 | .if n \{\ |
|
|
72 | . ds #H 0 |
|
|
73 | . ds #V .8m |
|
|
74 | . ds #F .3m |
|
|
75 | . ds #[ \f1 |
|
|
76 | . ds #] \fP |
|
|
77 | .\} |
|
|
78 | .if t \{\ |
|
|
79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
|
|
80 | . ds #V .6m |
|
|
81 | . ds #F 0 |
|
|
82 | . ds #[ \& |
|
|
83 | . ds #] \& |
|
|
84 | .\} |
|
|
85 | . \" simple accents for nroff and troff |
|
|
86 | .if n \{\ |
|
|
87 | . ds ' \& |
|
|
88 | . ds ` \& |
|
|
89 | . ds ^ \& |
|
|
90 | . ds , \& |
|
|
91 | . ds ~ ~ |
|
|
92 | . ds / |
|
|
93 | .\} |
|
|
94 | .if t \{\ |
|
|
95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
|
|
96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
|
|
97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
|
|
98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
|
|
99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
|
|
100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
|
|
101 | .\} |
|
|
102 | . \" troff and (daisy-wheel) nroff accents |
|
|
103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
|
|
104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
|
|
105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
|
|
106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
|
|
107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
|
|
108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
|
|
109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
|
|
110 | .ds ae a\h'-(\w'a'u*4/10)'e |
|
|
111 | .ds Ae A\h'-(\w'A'u*4/10)'E |
|
|
112 | . \" corrections for vroff |
|
|
113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
|
|
114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
|
|
115 | . \" for low resolution devices (crt and lpr) |
|
|
116 | .if \n(.H>23 .if \n(.V>19 \ |
|
|
117 | \{\ |
|
|
118 | . ds : e |
|
|
119 | . ds 8 ss |
|
|
120 | . ds o a |
|
|
121 | . ds d- d\h'-1'\(ga |
|
|
122 | . ds D- D\h'-1'\(hy |
|
|
123 | . ds th \o'bp' |
|
|
124 | . ds Th \o'LP' |
|
|
125 | . ds ae ae |
|
|
126 | . ds Ae AE |
|
|
127 | .\} |
|
|
128 | .rm #[ #] #H #V #F C |
|
|
129 | .\" ======================================================================== |
|
|
130 | .\" |
|
|
131 | .IX Title "VPED.CONF 5" |
|
|
132 | .TH VPED.CONF 5 "2004-04-01" "1.5" "Virtual Private Ethernet" |
|
|
133 | .SH "NAME" |
|
|
134 | vped.conf \- vpe daemon configuration file |
|
|
135 | .SH "SYNOPSIS" |
|
|
136 | .IX Header "SYNOPSIS" |
|
|
137 | .Vb 4 |
|
|
138 | \& enable-udp = yes |
|
|
139 | \& udp-port = 407 |
|
|
140 | \& mtu = 1492 |
|
|
141 | \& ifname = vpn0 |
|
|
142 | .Ve |
|
|
143 | .PP |
|
|
144 | .Vb 2 |
|
|
145 | \& node = branch1 |
|
|
146 | \& hostname = 1.2.3.4 |
|
|
147 | .Ve |
|
|
148 | .PP |
|
|
149 | .Vb 3 |
|
|
150 | \& node = branch2 |
|
|
151 | \& hostname = www.example.net |
|
|
152 | \& udp-port = 500 # this host uses a different udp-port |
|
|
153 | .Ve |
|
|
154 | .PP |
|
|
155 | .Vb 2 |
|
|
156 | \& node = branch3 |
|
|
157 | \& connect = ondemand |
|
|
158 | .Ve |
| 9 | .Sh DESCRIPTION |
159 | .SH "DESCRIPTION" |
| 10 | The files in the |
160 | .IX Header "DESCRIPTION" |
| 11 | .Pa /etc/tinc/ |
161 | The vpe config file consists of a series of lines that contain \f(CW\*(C`variable |
| 12 | directory contain runtime and security information for the tinc daemon. |
162 | = value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and |
| 13 | .Sh NETWORKS |
163 | extend to the end of the line. They can be used on their own lines, or |
| 14 | It is perfectly ok for you to run more than one tinc daemon. |
164 | after any directives. Spaces are allowed before or after the \f(CW\*(C`=\*(C'\fR sign or |
| 15 | However, in its default form, |
165 | after values, but not within the variable names or values themselves. |
| 16 | you will soon notice that you can't use two different configuration files without the |
166 | .PP |
| 17 | .Fl c |
167 | The only exception to the above is the \*(L"on\*(R" directive that can prefix any |
| 18 | option. |
168 | \&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or |
| 19 | .Pp |
169 | (if the nodename starts with \*(L"!\*(R") on all nodes except the named one. |
| 20 | We have thought of another way of dealing with this: network names. |
170 | .PP |
| 21 | This means that you call |
171 | .Vb 3 |
| 22 | .Nm |
172 | \& name = value |
| 23 | with the |
173 | \& on branch1 loglevel = noise |
| 24 | .Fl n |
174 | \& on !branch2 connect = ondemand |
| 25 | option, which will assign a name to this daemon. |
175 | .Ve |
| 26 | .Pp |
176 | .PP |
| 27 | The effect of this is that the daemon will set its configuration root to |
177 | All settings are executed \*(L"in order\*(R", that is, later settings of the same |
| 28 | .Pa /etc/tinc/ Ns Ar NETNAME Ns Pa / , |
178 | variable overwrite earlier ones. |
| 29 | where |
179 | .SH "ANATOMY OF A CONFIG FILE" |
| 30 | .Ar NETNAME |
180 | .IX Header "ANATOMY OF A CONFIG FILE" |
| 31 | is your argument to the |
181 | Usually, a config file starts with global settings (like the udp port to |
| 32 | .Fl n |
182 | listen on), followed by node-specific sections that begin with a \f(CW\*(C`node = |
| 33 | option. |
183 | nickname\*(C'\fR line. |
| 34 | You'll notice that messages appear in syslog as coming from |
184 | .PP |
| 35 | .Nm tincd. Ns Ar NETNAME . |
185 | Every node that is part of the network must have a section that starts |
| 36 | .Pp |
186 | with \f(CW\*(C`node = nickname\*(C'\fR. The number and order of the nodes is important |
| 37 | However, it is not strictly necessary that you call tinc with the |
187 | and must be the same on all hosts. It is not uncommon for node sections to |
| 38 | .Fl n |
188 | be completely empty \- if the default values are right. |
| 39 | option. |
189 | .PP |
| 40 | In this case, the network name would just be empty, |
190 | Node-specific settings can be used at any time. If used before the first |
| 41 | and it will be used as such. |
191 | node section they will set the default values for all following nodes. |
| 42 | .Nm tinc |
192 | .SH "CONFIG VARIABLES" |
| 43 | now looks for files in |
193 | .IX Header "CONFIG VARIABLES" |
| 44 | .Pa /etc/tinc/ , |
194 | .Sh "\s-1GLOBAL\s0 \s-1SETTINGS\s0" |
| 45 | instead of |
195 | .IX Subsection "GLOBAL SETTINGS" |
| 46 | .Pa /etc/tinc/ Ns Ar NETNAME Ns Pa / ; |
196 | Global settings will affect the behaviour of the running vped daemon, that |
| 47 | the configuration file should be |
197 | is, they are in some sense node-specific (config files can set different |
| 48 | .Pa /etc/tinc/tinc.conf , |
198 | values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of |
| 49 | and the host configuration files are now expected to be in |
199 | the vped daemon and all connections it creates. |
| 50 | .Pa /etc/tinc/hosts/ . |
200 | .IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 |
| 51 | .Pp |
201 | .IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" |
| 52 | But it is highly recommended that you use this feature of |
202 | Set the logging level. Connection established messages are logged at level |
| 53 | .Nm tinc , |
203 | \&\f(CW\*(C`info\*(C'\fR, notable errors are logged with \f(CW\*(C`error\*(C'\fR. Default is \f(CW\*(C`info\*(C'\fR. |
| 54 | because it will be so much clearer whom your daemon talks to. |
204 | .IP "node = nickname" 4 |
| 55 | Hence, we will assume that you use it. |
205 | .IX Item "node = nickname" |
| 56 | .Sh NAMES |
206 | Not really a config setting but introduces a node section. The nickname is |
| 57 | Each tinc daemon should have a name that is unique in the network which it will be part of. |
207 | used to select the right configuration section and must be passed as an |
| 58 | The name will be used by other tinc daemons for identification. |
208 | argument to the vped daemon. |
| 59 | The name has to be declared in the |
209 | .IP "private-key = relative-path-to-key" 4 |
| 60 | .Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf |
210 | .IX Item "private-key = relative-path-to-key" |
| 61 | file. |
211 | Sets the path (relative to the config directory) to the private key |
| 62 | .Pp |
212 | (default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must |
| 63 | To make things easy, |
213 | be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could |
| 64 | choose something that will give unique and easy to remember names to your tinc daemon(s). |
214 | use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where |
| 65 | You could try things like hostnames, owner surnames or location names. |
215 | \&\f(CW\*(C`vpectrl\*(C'\fR puts them. |
| 66 | .Sh PUBLIC/PRIVATE KEYS |
216 | .Sp |
| 67 | You should use |
217 | Since only the private key file of the current node is used and the |
| 68 | .Ic tincd -K |
218 | private key file should be kept secret per-host to avoid spoofings, it is |
| 69 | to generate public/private keypairs. |
219 | not recommended to use this feature. |
| 70 | It will generate two keys. |
220 | .IP "ifpersist = yes|true|on | no|false|off" 4 |
| 71 | The private key should be stored in a separate file |
221 | .IX Item "ifpersist = yes|true|on | no|false|off" |
| 72 | .Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /rsa_key.priv |
222 | Should the tun/tap device be made persistent, that is, should the device |
| 73 | \-\- where |
223 | stay up even when vped exits? Some versions of the tunnel device have |
| 74 | .Ar NETNAME |
224 | problems sending packets when vped is restarted in persistent mode, so |
| 75 | stands for the network (see |
225 | if the connections can be established but you cannot send packets from |
| 76 | .Sx NETWORKS ) |
226 | the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the |
| 77 | above. |
227 | device. |
| 78 | The public key should be stored in the host configuration file |
228 | .IP "ifname = devname" 4 |
| 79 | .Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Va NAME |
229 | .IX Item "ifname = devname" |
| 80 | \-\- where |
230 | Sets the tun interface name to the given name. The default is OS-specific |
| 81 | .Va NAME |
231 | and most probably something like \f(CW\*(C`tun0\*(C'\fR. |
| 82 | stands for the name of the local tinc daemon (see |
232 | .IP "rekey = seconds" 4 |
| 83 | .Sx NAMES ) . |
233 | .IX Item "rekey = seconds" |
| 84 | .Sh SERVER CONFIGURATION |
234 | Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are |
| 85 | The server configuration of the daemon is done in the file |
235 | reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. |
| 86 | .Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf . |
236 | .IP "keepalive = seconds" 4 |
| 87 | This file consists of comments (lines started with a |
237 | .IX Item "keepalive = seconds" |
| 88 | .Li # ) |
238 | Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this |
| 89 | or assignments in the form of: |
239 | many seconds of inactivity the daemon will start to send keepalive probe |
| 90 | .Pp |
240 | every 5 seconds until it receives a reply from the other end. If no reply |
| 91 | .Va Variable Li = Ar Value . |
241 | is received within 30 seconds, the peer is considered unreachable and the |
| 92 | .Pp |
242 | connection is closed. |
| 93 | The variable names are case insensitive, and any spaces, tabs, |
243 | .IP "mtu = bytes" 4 |
| 94 | newlines and carriage returns are ignored. |
244 | .IX Item "mtu = bytes" |
| 95 | Note: it is not required that you put in the |
245 | Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically |
| 96 | .Li = |
246 | the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate |
| 97 | sign, but doing so improves readability. |
247 | maximum overhead (e.g. udp header size, encryption blocksize...) and pass |
| 98 | If you leave it out, remember to replace it with at least one space character. |
248 | this information to the \f(CW\*(C`if\-up\*(C'\fR script. |
| 99 | .Pp |
249 | .Sp |
| 100 | Here are all valid variables, listed in alphabetical order. |
250 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
| 101 | The default value is given between parentheses. |
251 | .Sp |
| 102 | .Bl -tag -width indent |
252 | This value must be the minimum of the mtu values of all hosts. |
| 103 | .It Va AddressFamily Li = ipv4 | ipv6 | any Po ipv4 Pc Bq experimental |
253 | .IP "ip-proto = numerical-ip-protocol" 4 |
| 104 | This option affects the address family of listening and outgoing sockets. |
254 | .IX Item "ip-proto = numerical-ip-protocol" |
| 105 | If |
255 | Sets the protocol number to be used for the rawip protocol. This is a |
| 106 | .Qq any |
256 | global option because all hosts must use the same protocol, and since |
| 107 | is selected, then depending on the operating system both IPv4 and IPv6 or just |
257 | there are no port numbers, you cannot easily run more than one vped |
| 108 | IPv6 listening sockets will be created. |
258 | instance using the same protocol, nor can you share the protocol with |
| 109 | .It Va BindToInterface Li = Ar interface Bq experimental |
259 | other programs. |
| 110 | If your computer has more than one network interface, |
260 | .Sp |
| 111 | .Nm tinc |
261 | The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through |
| 112 | will by default listen on all of them for incoming connections. |
262 | firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other |
| 113 | It is possible to bind only to a single interface with this variable. |
263 | common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98 |
| 114 | .Pp |
264 | (\s-1ENCAP\s0, rfc1241) |
| 115 | This option may not work on all platforms. |
265 | .IP "if-up = relative-or-absolute-path" 4 |
| 116 | .It Va ConnectTo Li = Ar name |
266 | .IX Item "if-up = relative-or-absolute-path" |
| 117 | Specifies which other tinc daemon to connect to on startup. |
267 | Sets the path of a script that should be called immediately after the |
| 118 | Multiple |
268 | network interface is initialized (but not neccessarily up). The following |
| 119 | .Va ConnectTo |
269 | environment variables are passed to it (the values are just examples): |
| 120 | variables may be specified, |
270 | .RS 4 |
| 121 | in which case outgoing connections to each specified tinc daemon are made. |
271 | .IP "CONFBASE=/etc/vpe" 4 |
| 122 | The names should be known to this tinc daemon |
272 | .IX Item "CONFBASE=/etc/vpe" |
| 123 | (i.e., there should be a host configuration file for the name on the |
273 | The configuration base directory. |
| 124 | .Va ConnectTo |
274 | .IP "IFNAME=vpn0" 4 |
| 125 | line). |
275 | .IX Item "IFNAME=vpn0" |
| 126 | .Pp |
276 | The interface to initialize. |
| 127 | If you don't specify a host with |
277 | .IP "MTU=1436" 4 |
| 128 | .Va ConnectTo , |
278 | .IX Item "MTU=1436" |
| 129 | .Nm tinc |
279 | The \s-1MTU\s0 to set the interface to. You can use lower values (if done |
| 130 | won't try to connect to other daemons at all, |
280 | consistently on all hosts), but this is usually ineffective. |
| 131 | and will instead just listen for incoming connections. |
281 | .IP "MAC=fe:fd:80:00:00:01" 4 |
| 132 | .It Va Device Li = Ar device Po /dev/tap0 or /dev/net/tun Pc |
282 | .IX Item "MAC=fe:fd:80:00:00:01" |
| 133 | The virtual network device to use. |
283 | The \s-1MAC\s0 address to set the interface to. The script *must* set the |
| 134 | .Nm tinc |
284 | interface \s-1MAC\s0 to this value. You will most likely use one of these: |
| 135 | will automatically detect what kind of device it is. |
285 | .Sp |
| 136 | Note that you can only use one device per daemon. |
286 | .Vb 2 |
| 137 | The info pages of the tinc package contain more information |
287 | \& ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux |
| 138 | about configuring the virtual network device. |
288 | \& ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD |
| 139 | .It Va Hostnames Li = yes | no Pq no |
289 | .Ve |
| 140 | This option selects whether IP addresses (both real and on the VPN) should |
290 | .Sp |
| 141 | be resolved. Since DNS lookups are blocking, it might affect tinc's |
291 | Please see the \f(CW\*(C`vpe.osdep(5)\*(C'\fR manpage for platform-specific information. |
| 142 | efficiency, even stopping the daemon for a few seconds every time it does |
292 | .IP "IFTYPE=native # or tincd" 4 |
| 143 | a lookup if your DNS server is not responding. |
293 | .IX Item "IFTYPE=native # or tincd" |
| 144 | .Pp |
294 | .PD 0 |
| 145 | This does not affect resolving hostnames to IP addresses from the |
295 | .IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 |
| 146 | host configuration files. |
296 | .IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." |
| 147 | .It Va Interface Li = Ar interface |
297 | .PD |
| 148 | Defines the name of the interface corresponding to the virtual network device. |
298 | The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os |
| 149 | Depending on the operating system and the type of device this may or may not actually set the name. |
299 | name in lowercase) that this vpe was configured for. Can be used to select |
| 150 | Currently this option only affects the Linux tun/tap device. |
300 | the correct syntax to use for network-related commands. |
| 151 | .It Va KeyExpire Li = Ar period Pq 3600 |
301 | .IP "NODENAME=branch1" 4 |
| 152 | This option controls the period the encryption keys used to encrypt the data are valid. |
302 | .IX Item "NODENAME=branch1" |
| 153 | It is common practice to change keys at regular intervals to make it even harder for crackers, |
303 | The nickname of the current node, as passed to the vped daemon. |
| 154 | even though it is thought to be nearly impossible to crack a single key. |
304 | .IP "NODEID=1" 4 |
| 155 | .It Va MACExpire Li = Ar period Pq 600 |
305 | .IX Item "NODEID=1" |
| 156 | This option controls the amount of time MAC addresses are kept before they are removed. |
306 | The numerical node id of the current node. The first node mentioned in the |
| 157 | This only has effect when |
307 | config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on. |
| 158 | .Va Mode |
308 | .RE |
| 159 | is set to |
309 | .RS 4 |
| 160 | .Qq switch . |
310 | .Sp |
| 161 | .It Va MaxTimeout Li = Ar period Pq 900 |
311 | Here is a simple if-up script: |
| 162 | This is the maximum delay before trying to reconnect to other tinc daemons. |
312 | .Sp |
| 163 | .It Va Mode Li = router | switch | hub Pq router |
313 | .Vb 5 |
| 164 | This option selects the way packets are routed to other daemons. |
314 | \& #!/bin/sh |
| 165 | .Bl -tag -width indent |
315 | \& ip link set $IFNAME address $MAC mtu $MTU up |
| 166 | .It router |
316 | \& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME |
| 167 | In this mode |
317 | \& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME |
| 168 | .Va Subnet |
318 | \& ip route add 10.0.0.0/8 dev $IFNAME |
| 169 | variables in the host configuration files will be used to form a routing table. |
319 | .Ve |
| 170 | Only unicast packets of routable protocols (IPv4 and IPv6) are supported in this mode. |
320 | .Sp |
| 171 | .It switch |
321 | More complicated examples (using routing to reduce arp traffic) can be |
| 172 | In this mode the MAC addresses of the packets on the VPN will be used to |
322 | found in the etc/ subdirectory of the distribution. |
| 173 | dynamically create a routing table just like an Ethernet switch does. |
323 | .RE |
| 174 | Unicast, multicast and broadcast packets of every protocol that runs over Ethernet are supported in this mode |
324 | .IP "node-up = relative-or-absolute-path" 4 |
| 175 | at the cost of frequent broadcast ARP requests and routing table updates. |
325 | .IX Item "node-up = relative-or-absolute-path" |
| 176 | .It hub |
326 | Sets a command (default: no script) that should be called whenever a |
| 177 | This mode is almost the same as the switch mode, but instead |
327 | connection is established (even on rekeying operations). In addition |
| 178 | every packet will be broadcast to the other daemons |
328 | to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment |
| 179 | while no routing table is managed. |
329 | variables will be set: |
| 180 | .El |
330 | .RS 4 |
| 181 | .It Va Name Li = Ar name Bq required |
331 | .IP "DESTNODE=branch2" 4 |
| 182 | This is the name which identifies this tinc daemon. |
332 | .IX Item "DESTNODE=branch2" |
| 183 | It must be unique for the virtual private network this daemon will connect to. |
333 | The name of the remote node. |
| 184 | .It Va PingTimeout Li = Ar period Pq 60 |
334 | .IP "DESTID=2" 4 |
| 185 | The number of seconds of inactivity that |
335 | .IX Item "DESTID=2" |
| 186 | .Nm tinc |
336 | The node id of the remote node. |
| 187 | will wait before sending a probe to the other end. |
337 | .IP "DESTIP=188.13.66.8" 4 |
| 188 | If that other end doesn't answer within that same amount of time, |
338 | .IX Item "DESTIP=188.13.66.8" |
| 189 | the connection is terminated, |
339 | The numerical \s-1IP\s0 address of the remote host (vped accepts connections from |
| 190 | and the others will be notified of this. |
340 | everywhere, as long as the other host can authenticate itself). |
| 191 | .It Va PriorityInheritance Li = yes | no Po no Pc Bq experimental |
341 | .IP "DESTPORT=655 # deprecated" 4 |
| 192 | When this option is enabled the value of the TOS field of tunneled IPv4 packets |
342 | .IX Item "DESTPORT=655 # deprecated" |
| 193 | will be inherited by the UDP packets that are sent out. |
343 | The \s-1UDP\s0 port used by the other side. |
| 194 | .It Va PrivateKey Li = Ar key Bq obsolete |
344 | .IP "STATE=UP" 4 |
| 195 | The private RSA key of this tinc daemon. |
345 | .IX Item "STATE=UP" |
| 196 | It will allow this tinc daemon to authenticate itself to other daemons. |
346 | Node-up scripts get called with STATE=UP, node-down scripts get called |
| 197 | .It Va PrivateKeyFile Li = Ar filename Bq recommended |
347 | with STATE=DOWN. |
| 198 | The file in which the private RSA key of this tinc daemon resides. |
348 | .RE |
| 199 | Note that there must be exactly one of |
349 | .RS 4 |
| 200 | .Va PrivateKey |
350 | .Sp |
| 201 | or |
351 | Here is a nontrivial example that uses nsupdate to update the name => ip |
| 202 | .Va PrivateKeyFile |
352 | mapping in some dns zone: |
| 203 | specified in the configuration file. |
353 | .Sp |
| 204 | .El |
354 | .Vb 6 |
| 205 | .Sh HOST CONFIGURATION FILES |
355 | \& #!/bin/sh |
| 206 | The host configuration files contain all information needed |
356 | \& { |
| 207 | to establish a connection to those hosts. |
357 | \& echo update delete $DESTNODE.lowttl.example.net. a |
| 208 | A host configuration file is also required for the local tinc daemon, |
358 | \& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP |
| 209 | it will use it to read in it's listen port, public key and subnets. |
359 | \& echo |
| 210 | .Pp |
360 | \& } | nsupdate -d -k $CONFBASE:key.example.net. |
| 211 | The idea is that these files are portable. |
361 | .Ve |
| 212 | You can safely mail your own host configuration file to someone else. |
362 | .RE |
| 213 | That other person can then copy it to his own hosts directory, |
363 | .IP "node-down = relative-or-absolute-path" 4 |
| 214 | and now his tinc daemon will be able to connect to your tinc daemon. |
364 | .IX Item "node-down = relative-or-absolute-path" |
| 215 | Since host configuration files only contain public keys, |
365 | Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. |
| 216 | no secrets are revealed by sending out this information. |
366 | .IP "http-proxy-host = hostname/ip" 4 |
| 217 | .Bl -tag -width indent |
367 | .IX Item "http-proxy-host = hostname/ip" |
| 218 | .It Va Address Li = Ar address Bq recommended |
368 | The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if vpe was |
| 219 | The IP address or hostname of this tinc daemon on the real network. |
369 | compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of |
| 220 | This wil only be used when trying to make an outgoing connection to this tinc daemon. |
370 | tcp connections through a http proxy server. |
| 221 | Multiple |
371 | .Sp |
| 222 | .Va Address |
372 | \&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and |
| 223 | variables can be specified, in which case each address will be tried until a working |
373 | port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy |
| 224 | connection has been established. |
374 | requires authentication. |
| 225 | .It Va Cipher Li = Ar cipher Pq blowfish |
375 | .Sp |
| 226 | The symmetric cipher algorithm used to encrypt UDP packets. |
376 | Please note that vpe will still try to resolve all hostnames in the |
| 227 | Any cipher supported by OpenSSL is recognised. |
377 | configuration file, so if you are behind a proxy without access to a dns |
| 228 | Furthermore, specifying |
378 | server better use numerical \s-1IP\s0 addresses. |
| 229 | .Qq none |
379 | .Sp |
| 230 | will turn off packet encryption. |
380 | To make best use of this option disable all protocols except tcp in your |
| 231 | .It Va Compression Li = Ar level Pq 0 |
381 | config file and make sure your routers (or all other hosts) are listening |
| 232 | This option sets the level of compression used for UDP packets. |
382 | on a port that the proxy allows (443, https, is a common choice). |
| 233 | Possible values are 0 (off), 1 (fast) and any integer up to 9 (best). |
383 | .Sp |
| 234 | .It Va Digest Li = Ar digest Pq sha1 |
384 | If you have a router, connecting to it will suffice. Otherwise tcp must be |
| 235 | The digest algorithm used to authenticate UDP packets. |
385 | enabled on all hosts. |
| 236 | Any digest supported by OpenSSL is recognised. |
386 | .Sp |
| 237 | Furthermore, specifying |
387 | Example: |
| 238 | .Qq none |
388 | .Sp |
| 239 | will turn off packet authentication. |
389 | .Vb 3 |
| 240 | .It Va IndirectData Li = yes | no Pq no |
390 | \& http-proxy-host = proxy.example.com |
| 241 | This option specifies whether other tinc daemons besides the one you specified with |
391 | \& http-proxy-port = 3128 # 8080 is another common choice |
| 242 | .Va ConnectTo |
392 | \& http-proxy-auth = schmorp:grumbeere |
| 243 | can make a direct connection to you. |
393 | .Ve |
| 244 | This is especially useful if you are behind a firewall |
394 | .IP "http-proxy-port = proxy-tcp-port" 4 |
| 245 | and it is impossible to make a connection from the outside to your tinc daemon. |
395 | .IX Item "http-proxy-port = proxy-tcp-port" |
| 246 | Otherwise, it is best to leave this option out or set it to no. |
396 | The port where your proxy server listens. |
| 247 | .It Va MACLength Li = Ar length Pq 4 |
397 | .IP "http-proxy-auth = login:password" 4 |
| 248 | The length of the message authentication code used to authenticate UDP packets. |
398 | .IX Item "http-proxy-auth = login:password" |
| 249 | Can be anything from |
399 | The optional login and password used to authenticate to the proxy server, |
| 250 | .Qq 0 |
400 | seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is |
| 251 | up to the length of the digest produced by the digest algorithm. |
401 | currently supported. |
| 252 | .It Va Port Li = Ar port Pq 655 |
402 | .IP "pid-file = path" 4 |
| 253 | The port number on which this tinc daemon is listening for incoming connections. |
403 | .IX Item "pid-file = path" |
| 254 | .It Va PublicKey Li = Ar key Bq obsolete |
404 | The path to the pid file to check and create (Default: |
| 255 | The public RSA key of this tinc daemon. |
405 | .Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
| 256 | It will be used to cryptographically verify it's identity and to set up a secure connection. |
406 | .IX Subsection "NODE SPECIFIC SETTINGS" |
| 257 | .It Va PublicKeyFile Li = Ar filename Bq obsolete |
407 | The following settings are node\-specific, that is, every node can have |
| 258 | The file in which the public RSA key of this tinc daemon resides. |
408 | different settings, even within the same vped instance. Settings that are |
| 259 | .Pp |
409 | executed before the first node section set the defaults, settings that are |
| 260 | From version 1.0pre4 on |
410 | executed within a node section only apply to the given node. |
| 261 | .Nm tinc |
411 | .IP "udp-port = port-number" 4 |
| 262 | will store the public key directly into the host configuration file in PEM format, |
412 | .IX Item "udp-port = port-number" |
| 263 | the above two options then are not necessary. |
413 | Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not |
| 264 | Either the PEM format is used, or exactly one of the above two options must be specified |
414 | officially assigned by \s-1IANA\s0!). |
| 265 | in each host configuration file, |
415 | .IP "tcp-port = port-number" 4 |
| 266 | if you want to be able to establish a connection with that host. |
416 | .IX Item "tcp-port = port-number" |
| 267 | .It Va Subnet Li = Ar address Ns Op Li / Ns Ar prefixlength |
417 | Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. |
| 268 | The subnet which this tinc daemon will serve. |
418 | .IP "enable-rawip = yes|true|on | no|false|off" 4 |
| 269 | .Nm tinc |
419 | .IX Item "enable-rawip = yes|true|on | no|false|off" |
| 270 | tries to look up which other daemon it should send a packet to by searching the appropriate subnet. |
420 | Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol |
| 271 | If the packet matches a subnet, |
421 | (default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the overhead per packet |
| 272 | it will be sent to the daemon who has this subnet in his host configuration file. |
422 | is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+). |
| 273 | Multiple |
423 | .IP "enable-udp = yes|true|on | no|false|off" 4 |
| 274 | .Va Subnet |
424 | .IX Item "enable-udp = yes|true|on | no|false|off" |
| 275 | variables can be specified. |
425 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`yes\*(C'\fR, |
| 276 | .Pp |
426 | but this will change!). This is a good general choice since \s-1UDP\s0 tunnels |
| 277 | Subnets can either be single MAC, IPv4 or IPv6 addresses, |
427 | well through many firewalls. |
| 278 | in which case a subnet consisting of only that single address is assumed, |
428 | .Sp |
| 279 | or they can be a IPv4 or IPv6 network address with a prefixlength. |
429 | \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR even though it is the default, as |
| 280 | Shorthand notations are not supported. |
430 | some future version will have all protocols disabled by default. |
| 281 | For example, IPv4 subnets must be in a form like 192.168.1.0/24, |
431 | .IP "enable-tcp = yes|true|on | no|false|off" 4 |
| 282 | where 192.168.1.0 is the network address and 24 is the number of bits set in the netmask. |
432 | .IX Item "enable-tcp = yes|true|on | no|false|off" |
| 283 | Note that subnets like 192.168.1.1/24 are invalid! |
433 | Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port |
| 284 | Read a networking HOWTO/FAQ/guide if you don't understand this. |
434 | (default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only |
| 285 | IPv6 subnets are notated like fec0:0:0:1:0:0:0:0/64. |
435 | available when vpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never |
| 286 | MAC addresses are notated like 0:1a:2b:3c:4d:5e. |
436 | use this transport unless you really must, it is horribly ineffiecent and |
| 287 | .It Va TCPOnly Li = yes | no Pq no |
437 | resource-intensive compared to the other transports. |
| 288 | If this variable is set to yes, |
438 | .IP "router-priority = positive-number" 4 |
| 289 | then the packets are tunnelled over the TCP connection instead of a UDP connection. |
439 | .IX Item "router-priority = positive-number" |
| 290 | This is especially useful for those who want to run a tinc daemon |
440 | Sets the router priority of the given host (default: \f(CW0\fR, disabled). If |
| 291 | from behind a masquerading firewall, |
441 | some host tries to connect to another host without a hostname, it asks |
| 292 | or if UDP packet routing is disabled somehow. |
442 | the router host for it's \s-1IP\s0 address. The router host is the one with the |
| 293 | Setting this options also implicitly sets IndirectData. |
443 | highest priority that is currently reachable. Make sure all clients always |
| 294 | .El |
444 | connect to the router hosts, otherwise conencting to them is impossible. |
| 295 | .Sh FILES |
445 | .IP "connect = ondemand|never|always|disabled" 4 |
| 296 | .Bl -tag -width indent |
446 | .IX Item "connect = ondemand|never|always|disabled" |
| 297 | .It Pa /etc/tinc/ |
447 | Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always |
| 298 | The top directory for configuration files. |
448 | try to establish and keep a conenction to the given host), \f(CW\*(C`never\*(C'\fR |
| 299 | .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf |
449 | (nevr initiate a connection to the given host, but accept connections), |
| 300 | The default name of the server configuration file for net |
450 | \&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and |
| 301 | .Ar NETNAME . |
451 | take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, |
| 302 | .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /hosts/ |
452 | don't talk to it). |
| 303 | Host configuration files are kept in this directory. |
453 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
| 304 | .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc-up |
454 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
| 305 | If an executable file with this name exists, |
455 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
| 306 | it will be executed right after the tinc daemon has connected to the virtual network device. |
456 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
| 307 | It can be used to set up the corresponding network interface. |
457 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
| 308 | .Pp |
458 | to the tunnel device, which is usually what you want. |
| 309 | The environment variable |
459 | .IP "compress = yes|true|on | no|false|off" 4 |
| 310 | .Ev $NETNAME |
460 | .IX Item "compress = yes|true|on | no|false|off" |
| 311 | will be passed to the executable. |
461 | Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). |
| 312 | If specified with the |
462 | Compression is really cheap even on slow computers and has no size |
| 313 | .Va Interface |
463 | overhead at all, so enabling this is a good idea. |
| 314 | configuration variable, |
464 | .SH "CONFIG DIRECTORY LAYOUT" |
| 315 | or if the virtual network device is a Linux tun/tap device, |
465 | .IX Header "CONFIG DIRECTORY LAYOUT" |
| 316 | the environment variable |
466 | The default (or recommended) directory layout for the config directory is: |
| 317 | .Ev $INTERFACE |
467 | .IP "vped.conf" 4 |
| 318 | will be set to the name of the network interface. |
468 | .IX Item "vped.conf" |
| 319 | .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc-down |
469 | The config file. |
| 320 | If an executable file with this name exists, |
470 | .IP "if-up" 4 |
| 321 | it will be executed right before the tinc daemon is going to close |
471 | .IX Item "if-up" |
| 322 | its connection to the virtual network device. |
472 | The if-up script |
| 323 | The same environment variables will be passed as mentioned above. |
473 | .IP "node\-up, node-down" 4 |
| 324 | .El |
474 | .IX Item "node-up, node-down" |
|
|
475 | If used the node up or node-down scripts. |
|
|
476 | .IP "hostkey" 4 |
|
|
477 | .IX Item "hostkey" |
|
|
478 | The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. |
|
|
479 | .IP "pubkey/nodename" 4 |
|
|
480 | .IX Item "pubkey/nodename" |
|
|
481 | The public keys of the other nodes, one file per node. |
| 325 | .Sh SEE ALSO |
482 | .SH "SEE ALSO" |
| 326 | .Xr tincd 8 , |
483 | .IX Header "SEE ALSO" |
| 327 | .Pa http://tinc.nl.linux.org/ , |
484 | \&\fIvpe\fR\|(5), \fIvped\fR\|(8), \fIvpectrl\fR\|(8). |
| 328 | .Pa http://www.linuxdoc.org/LDP/nag2/ . |
485 | .SH "AUTHOR" |
| 329 | .Pp |
486 | .IX Header "AUTHOR" |
| 330 | The full documentation for |
487 | Marc Lehmann <vpe@plan9.de> |
| 331 | .Nm tinc |
|
|
| 332 | is maintained as a Texinfo manual. |
|
|
| 333 | If the info and tinc programs are properly installed at your site, the command |
|
|
| 334 | .Ic info tinc |
|
|
| 335 | should give you access to the complete manual. |
|
|
| 336 | .Pp |
|
|
| 337 | .Nm tinc |
|
|
| 338 | comes with ABSOLUTELY NO WARRANTY. |
|
|
| 339 | This is free software, and you are welcome to redistribute it under certain conditions; |
|
|
| 340 | see the file COPYING for details. |
|
|
