1 |
.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) |
2 |
.\" |
3 |
.\" Standard preamble: |
4 |
.\" ======================================================================== |
5 |
.de Sh \" Subsection heading |
6 |
.br |
7 |
.if t .Sp |
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. \*(C+ will |
29 |
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and |
30 |
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
31 |
.\" nothing in troff, for use with C<>. |
32 |
.tr \(*W- |
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 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
52 |
.ie \n(.g .ds Aq \(aq |
53 |
.el .ds Aq ' |
54 |
.\" |
55 |
.\" If the F register is turned on, we'll generate index entries on stderr for |
56 |
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
57 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
58 |
.\" output yourself in some meaningful fashion. |
59 |
.ie \nF \{\ |
60 |
. de IX |
61 |
. tm Index:\\$1\t\\n%\t"\\$2" |
62 |
.. |
63 |
. nr % 0 |
64 |
. rr F |
65 |
.\} |
66 |
.el \{\ |
67 |
. de IX |
68 |
.. |
69 |
.\} |
70 |
.\" |
71 |
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
72 |
.\" Fear. Run. Save yourself. No user-serviceable parts. |
73 |
. \" fudge factors for nroff and troff |
74 |
.if n \{\ |
75 |
. ds #H 0 |
76 |
. ds #V .8m |
77 |
. ds #F .3m |
78 |
. ds #[ \f1 |
79 |
. ds #] \fP |
80 |
.\} |
81 |
.if t \{\ |
82 |
. ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
83 |
. ds #V .6m |
84 |
. ds #F 0 |
85 |
. ds #[ \& |
86 |
. ds #] \& |
87 |
.\} |
88 |
. \" simple accents for nroff and troff |
89 |
.if n \{\ |
90 |
. ds ' \& |
91 |
. ds ` \& |
92 |
. ds ^ \& |
93 |
. ds , \& |
94 |
. ds ~ ~ |
95 |
. ds / |
96 |
.\} |
97 |
.if t \{\ |
98 |
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
99 |
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
100 |
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
101 |
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
102 |
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
103 |
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
104 |
.\} |
105 |
. \" troff and (daisy-wheel) nroff accents |
106 |
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
107 |
.ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
108 |
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
109 |
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
110 |
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
111 |
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
112 |
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
113 |
.ds ae a\h'-(\w'a'u*4/10)'e |
114 |
.ds Ae A\h'-(\w'A'u*4/10)'E |
115 |
. \" corrections for vroff |
116 |
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
117 |
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
118 |
. \" for low resolution devices (crt and lpr) |
119 |
.if \n(.H>23 .if \n(.V>19 \ |
120 |
\{\ |
121 |
. ds : e |
122 |
. ds 8 ss |
123 |
. ds o a |
124 |
. ds d- d\h'-1'\(ga |
125 |
. ds D- D\h'-1'\(hy |
126 |
. ds th \o'bp' |
127 |
. ds Th \o'LP' |
128 |
. ds ae ae |
129 |
. ds Ae AE |
130 |
.\} |
131 |
.rm #[ #] #H #V #F C |
132 |
.\" ======================================================================== |
133 |
.\" |
134 |
.IX Title "GVPE.CONF 5" |
135 |
.TH GVPE.CONF 5 "2009-03-23" "2.22" "GNU Virtual Private Ethernet" |
136 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
137 |
.\" way too many mistakes in technical documents. |
138 |
.if n .ad l |
139 |
.nh |
140 |
.SH "NAME" |
141 |
gvpe.conf \- configuration file for the GNU VPE daemon |
142 |
.SH "SYNOPSIS" |
143 |
.IX Header "SYNOPSIS" |
144 |
.Vb 4 |
145 |
\& # global options for all nodes |
146 |
\& udp\-port = 407 |
147 |
\& mtu = 1492 |
148 |
\& ifname = vpn0 |
149 |
\& |
150 |
\& # first node is named branch1 and is at 1.2.3.4 |
151 |
\& node = branch1 |
152 |
\& hostname = 1.2.3.4 |
153 |
\& |
154 |
\& # second node uses dns to resolve the address |
155 |
\& node = branch2 |
156 |
\& hostname = www.example.net |
157 |
\& udp\-port = 500 # this host uses a different udp\-port |
158 |
\& |
159 |
\& # third node has no fixed ip address |
160 |
\& node = branch3 |
161 |
\& connect = ondemand |
162 |
.Ve |
163 |
.SH "DESCRIPTION" |
164 |
.IX Header "DESCRIPTION" |
165 |
The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable |
166 |
= value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and |
167 |
extend to the end of the line. They can be used on their own lines, or |
168 |
after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after |
169 |
values, but not within the variable names or values themselves. |
170 |
.PP |
171 |
The only exception to the above is the \*(L"on\*(R" directive that can prefix any |
172 |
\&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or |
173 |
(if the nodename starts with \*(L"!\*(R") on all nodes except the named one. |
174 |
.PP |
175 |
For example, set the \s-1MTU\s0 to \f(CW1450\fR everywhere, loglevel to \f(CW\*(C`noise\*(C'\fR on |
176 |
branch1, and connect to \f(CW\*(C`ondemand\*(C'\fR everywhere but on branch2: |
177 |
.PP |
178 |
.Vb 3 |
179 |
\& mtu = 1450 |
180 |
\& on branch1 loglevel = noise |
181 |
\& on !branch2 connect = ondemand |
182 |
.Ve |
183 |
.PP |
184 |
All settings are applied \*(L"in order\*(R", that is, later settings of the same |
185 |
variable overwrite earlier ones. |
186 |
.SH "ANATOMY OF A CONFIG FILE" |
187 |
.IX Header "ANATOMY OF A CONFIG FILE" |
188 |
Usually, a config file starts with a few global settings (like the \s-1UDP\s0 |
189 |
port to listen on), followed by node-specific sections that begin with a |
190 |
\&\f(CW\*(C`node = nickname\*(C'\fR line. |
191 |
.PP |
192 |
Every node that is part of the network must have a section that starts |
193 |
with \f(CW\*(C`node = nickname\*(C'\fR. The number and order of the nodes is important |
194 |
and must be the same on all nodes. It is not uncommon for node sections to |
195 |
be completely empty \- if the default values are right. |
196 |
.PP |
197 |
Node-specific settings can be used at any time. If used before the first |
198 |
node section they will set the default values for all following nodes. |
199 |
.SH "CONFIG VARIABLES" |
200 |
.IX Header "CONFIG VARIABLES" |
201 |
.Sh "\s-1GLOBAL\s0 \s-1SETTINGS\s0" |
202 |
.IX Subsection "GLOBAL SETTINGS" |
203 |
Global settings will affect the behaviour of the running gvpe daemon, that |
204 |
is, they are in some sense node-specific (config files can set different |
205 |
values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of |
206 |
the gvpe daemon and all connections it creates. |
207 |
.IP "dns-forw-host = hostname/ip" 4 |
208 |
.IX Item "dns-forw-host = hostname/ip" |
209 |
The \s-1DNS\s0 server to forward \s-1DNS\s0 requests to for the \s-1DNS\s0 tunnel protocol |
210 |
(default: \f(CW127.0.0.1\fR, changing it is highly recommended). |
211 |
.IP "dns-forw-port = port-number" 4 |
212 |
.IX Item "dns-forw-port = port-number" |
213 |
The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR, |
214 |
which is fine in most cases). |
215 |
.IP "dns-max-outstanding = integer-number-of-requests" 4 |
216 |
.IX Item "dns-max-outstanding = integer-number-of-requests" |
217 |
The maximum number of outstanding \s-1DNS\s0 transport requests |
218 |
(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given |
219 |
limit without receiving replies. In heavily overloaded situations it might |
220 |
help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the |
221 |
number of parallel requests. |
222 |
.Sp |
223 |
The default should be working \s-1OK\s0 for most links. |
224 |
.IP "dns-overlap-factor = float" 4 |
225 |
.IX Item "dns-overlap-factor = float" |
226 |
The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen |
227 |
during a connection as it's timing base. This factor (default: \f(CW0.5\fR, |
228 |
must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending |
229 |
rate (= minimum send interval), i.e. a factor of \f(CW1\fR means that a new |
230 |
request might be generated every \fBmin_latency\fR seconds, which means on |
231 |
average there should only ever be one outstanding request. A factor of |
232 |
\&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum |
233 |
latency measured. |
234 |
.Sp |
235 |
For congested or picky \s-1DNS\s0 forwarders you could use a value nearer to or |
236 |
exceeding \f(CW1\fR. |
237 |
.Sp |
238 |
The default should be working \s-1OK\s0 for most links. |
239 |
.IP "dns-send-interval = send-interval-in-seconds" 4 |
240 |
.IX Item "dns-send-interval = send-interval-in-seconds" |
241 |
The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will |
242 |
use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when |
243 |
the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will |
244 |
not send more than 100 \s-1DNS\s0 requests per connection per second. For |
245 |
high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For |
246 |
congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR, |
247 |
\&\f(CW0.2\fR or even higher. |
248 |
.Sp |
249 |
The default should be working \s-1OK\s0 for most links. |
250 |
.IP "dns-timeout-factor = float" 4 |
251 |
.IX Item "dns-timeout-factor = float" |
252 |
Factor to multiply the \f(CW\*(C`min_latency\*(C'\fR (see \f(CW\*(C`dns\-overlap\-factor\*(C'\fR) by to |
253 |
get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport |
254 |
will resend the request when no reply has been received for longer than |
255 |
eight times the minimum (= expected) latency, assuming the request or |
256 |
reply has been lost. |
257 |
.Sp |
258 |
For congested links a higher value might be necessary (e.g. \f(CW30\fR). If |
259 |
the link is very stable lower values (e.g. \f(CW2\fR) might work |
260 |
nicely. Values near or below \f(CW1\fR makes no sense whatsoever. |
261 |
.Sp |
262 |
The default should be working \s-1OK\s0 for most links but will result in low |
263 |
throughput if packet loss is high. |
264 |
.IP "if-up = relative-or-absolute-path" 4 |
265 |
.IX Item "if-up = relative-or-absolute-path" |
266 |
Sets the path of a script that should be called immediately after the |
267 |
network interface is initialized (but not necessarily up). The following |
268 |
environment variables are passed to it (the values are just examples). |
269 |
.Sp |
270 |
Variables that have the same value on all nodes: |
271 |
.RS 4 |
272 |
.IP "CONFBASE=/etc/gvpe" 4 |
273 |
.IX Item "CONFBASE=/etc/gvpe" |
274 |
The configuration base directory. |
275 |
.IP "IFNAME=vpn0" 4 |
276 |
.IX Item "IFNAME=vpn0" |
277 |
The network interface to initialize. |
278 |
.IP "IFTYPE=native # or tincd" 4 |
279 |
.IX Item "IFTYPE=native # or tincd" |
280 |
.PD 0 |
281 |
.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 |
282 |
.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." |
283 |
.PD |
284 |
The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the |
285 |
\&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to |
286 |
select the correct syntax to use for network-related commands. |
287 |
.IP "MTU=1436" 4 |
288 |
.IX Item "MTU=1436" |
289 |
The \s-1MTU\s0 to set the interface to. You can use lower values (if done |
290 |
consistently on all nodes), but this is usually either inefficient or |
291 |
simply ineffective. |
292 |
.IP "NODES=5" 4 |
293 |
.IX Item "NODES=5" |
294 |
The number of nodes in this \s-1GVPE\s0 network. |
295 |
.RE |
296 |
.RS 4 |
297 |
.Sp |
298 |
Variables that are node-specific and with values pertaining to the node |
299 |
running this \s-1GVPE:\s0 |
300 |
.IP "IFUPDATA=string" 4 |
301 |
.IX Item "IFUPDATA=string" |
302 |
The value of the configuration directive \f(CW\*(C`if\-up\-data\*(C'\fR. |
303 |
.IP "MAC=fe:fd:80:00:00:01" 4 |
304 |
.IX Item "MAC=fe:fd:80:00:00:01" |
305 |
The \s-1MAC\s0 address the network interface has to use. |
306 |
.Sp |
307 |
Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not |
308 |
do this automatically. Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR man page for |
309 |
platform-specific information. |
310 |
.IP "NODENAME=branch1" 4 |
311 |
.IX Item "NODENAME=branch1" |
312 |
The nickname of the node. |
313 |
.IP "NODEID=1" 4 |
314 |
.IX Item "NODEID=1" |
315 |
The numerical node \s-1ID\s0 of the node running this instance of \s-1GVPE\s0. The first |
316 |
node mentioned in the config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on. |
317 |
.RE |
318 |
.RS 4 |
319 |
.Sp |
320 |
In addition, all node-specific variables (except \f(CW\*(C`NODEID\*(C'\fR) will be |
321 |
available with a postfix of \f(CW\*(C`_nodeid\*(C'\fR, which contains the value for that |
322 |
node, e.g. the \f(CW\*(C`MAC_1\*(C'\fR variable contains the \s-1MAC\s0 address of node #1, while |
323 |
the \f(CW\*(C`NODENAME_22\*(C'\fR variable contains the name of node #22. |
324 |
.Sp |
325 |
Here is a simple if-up script: |
326 |
.Sp |
327 |
.Vb 5 |
328 |
\& #!/bin/sh |
329 |
\& ip link set $IFNAME up |
330 |
\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME |
331 |
\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME |
332 |
\& ip route add 10.0.0.0/8 dev $IFNAME |
333 |
.Ve |
334 |
.Sp |
335 |
More complicated examples (using routing to reduce \s-1ARP\s0 traffic) can be |
336 |
found in the \fIetc/\fR subdirectory of the distribution. |
337 |
.RE |
338 |
.IP "ifname = devname" 4 |
339 |
.IX Item "ifname = devname" |
340 |
Sets the tun interface name to the given name. The default is OS-specific |
341 |
and most probably something like \f(CW\*(C`tun0\*(C'\fR. |
342 |
.IP "ifpersist = yes|true|on | no|false|off" 4 |
343 |
.IX Item "ifpersist = yes|true|on | no|false|off" |
344 |
Should the tun/tap device be made persistent, that is, should the device |
345 |
stay up even when gvpe exits? Some versions of the tunnel device have |
346 |
problems sending packets when gvpe is restarted in persistent mode, so |
347 |
if the connections can be established but you cannot send packets from |
348 |
the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the |
349 |
device. |
350 |
.IP "ip-proto = numerical-ip-protocol" 4 |
351 |
.IX Item "ip-proto = numerical-ip-protocol" |
352 |
Sets the protocol number to be used for the rawip protocol. This is a |
353 |
global option because all nodes must use the same protocol, and since |
354 |
there are no port numbers, you cannot easily run more than one gvpe |
355 |
instance using the same protocol, nor can you share the protocol with |
356 |
other programs. |
357 |
.Sp |
358 |
The default is 47 (\s-1GRE\s0), which has a good chance of tunneling |
359 |
through firewalls (but note that gvpe's rawip protocol is not \s-1GRE\s0 |
360 |
compatible). Other common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 |
361 |
(\s-1IPIP\s0 tunnels) or 98 (\s-1ENCAP\s0, rfc1241) |
362 |
.IP "http-proxy-host = hostname/ip" 4 |
363 |
.IX Item "http-proxy-host = hostname/ip" |
364 |
The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was |
365 |
compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of |
366 |
tcp connections through a http proxy server. |
367 |
.Sp |
368 |
\&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and |
369 |
port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy |
370 |
requires authentication. |
371 |
.Sp |
372 |
Please note that gvpe will still try to resolve all hostnames in the |
373 |
configuration file, so if you are behind a proxy without access to a \s-1DNS\s0 |
374 |
server better use numerical \s-1IP\s0 addresses. |
375 |
.Sp |
376 |
To make best use of this option disable all protocols except \s-1TCP\s0 in your |
377 |
config file and make sure your routers (or all other nodes) are listening |
378 |
on a port that the proxy allows (443, https, is a common choice). |
379 |
.Sp |
380 |
If you have a router, connecting to it will suffice. Otherwise \s-1TCP\s0 must be |
381 |
enabled on all nodes. |
382 |
.Sp |
383 |
Example: |
384 |
.Sp |
385 |
.Vb 3 |
386 |
\& http\-proxy\-host = proxy.example.com |
387 |
\& http\-proxy\-port = 3128 # 8080 is another common choice |
388 |
\& http\-proxy\-auth = schmorp:grumbeere |
389 |
.Ve |
390 |
.IP "http-proxy-port = proxy-tcp-port" 4 |
391 |
.IX Item "http-proxy-port = proxy-tcp-port" |
392 |
The port where your proxy server listens. |
393 |
.IP "http-proxy-auth = login:password" 4 |
394 |
.IX Item "http-proxy-auth = login:password" |
395 |
The optional login and password used to authenticate to the proxy server, |
396 |
separated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is |
397 |
currently supported. |
398 |
.IP "keepalive = seconds" 4 |
399 |
.IX Item "keepalive = seconds" |
400 |
Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this |
401 |
many seconds of inactivity the daemon will start to send keepalive probe |
402 |
every 3 seconds until it receives a reply from the other end. If no reply |
403 |
is received within 15 seconds, the peer is considered unreachable and the |
404 |
connection is closed. |
405 |
.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 |
406 |
.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" |
407 |
Set the logging level. Connection established messages are logged at level |
408 |
\&\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. |
409 |
.IP "mtu = bytes" 4 |
410 |
.IX Item "mtu = bytes" |
411 |
Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically |
412 |
the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate |
413 |
maximum overhead (e.g. \s-1UDP\s0 header size, encryption blocksize...) and pass |
414 |
this information to the \f(CW\*(C`if\-up\*(C'\fR script. |
415 |
.Sp |
416 |
Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
417 |
.Sp |
418 |
This value must be the minimum of the \s-1MTU\s0 values of all nodes. |
419 |
.IP "node = nickname" 4 |
420 |
.IX Item "node = nickname" |
421 |
Not really a config setting but introduces a node section. The nickname is |
422 |
used to select the right configuration section and must be passed as an |
423 |
argument to the gvpe daemon. |
424 |
.IP "node-up = relative-or-absolute-path" 4 |
425 |
.IX Item "node-up = relative-or-absolute-path" |
426 |
Sets a command (default: none) that should be called whenever a connection |
427 |
is established (even on rekeying operations). Note that node\-up/down |
428 |
scripts will be run asynchronously, but execution is serialised, so there |
429 |
will only ever be one such script running. |
430 |
.Sp |
431 |
In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following |
432 |
environment variables will be set: |
433 |
.RS 4 |
434 |
.IP "DESTNODE=branch2" 4 |
435 |
.IX Item "DESTNODE=branch2" |
436 |
The name of the remote node. |
437 |
.IP "DESTID=2" 4 |
438 |
.IX Item "DESTID=2" |
439 |
The node id of the remote node. |
440 |
.IP "DESTIP=188.13.66.8" 4 |
441 |
.IX Item "DESTIP=188.13.66.8" |
442 |
The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from |
443 |
everywhere, as long as the other node can authenticate itself). |
444 |
.IP "DESTPORT=655 # deprecated" 4 |
445 |
.IX Item "DESTPORT=655 # deprecated" |
446 |
The \s-1UDP\s0 port used by the other side. |
447 |
.IP "STATE=UP" 4 |
448 |
.IX Item "STATE=UP" |
449 |
Node-up scripts get called with STATE=UP, node-down scripts get called |
450 |
with STATE=DOWN. |
451 |
.RE |
452 |
.RS 4 |
453 |
.Sp |
454 |
Here is a nontrivial example that uses nsupdate to update the name => ip |
455 |
mapping in some \s-1DNS\s0 zone: |
456 |
.Sp |
457 |
.Vb 6 |
458 |
\& #!/bin/sh |
459 |
\& { |
460 |
\& echo update delete $DESTNODE.lowttl.example.net. a |
461 |
\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP |
462 |
\& echo |
463 |
\& } | nsupdate \-d \-k $CONFBASE:key.example.net. |
464 |
.Ve |
465 |
.RE |
466 |
.IP "node-down = relative-or-absolute-path" 4 |
467 |
.IX Item "node-down = relative-or-absolute-path" |
468 |
Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. |
469 |
.IP "pid-file = path" 4 |
470 |
.IX Item "pid-file = path" |
471 |
The path to the pid file to check and create |
472 |
(default: \f(CW\*(C`LOCALSTATEDIR/run/gvpe.pid\*(C'\fR). |
473 |
.IP "private-key = relative-path-to-key" 4 |
474 |
.IX Item "private-key = relative-path-to-key" |
475 |
Sets the path (relative to the config directory) to the private key |
476 |
(default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must |
477 |
be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could |
478 |
use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where |
479 |
\&\f(CW\*(C`gvpectrl\*(C'\fR puts them. |
480 |
.Sp |
481 |
Since only the private key file of the current node is used and the |
482 |
private key file should be kept secret per-node to avoid spoofing, it is |
483 |
not recommended to use this feature. |
484 |
.IP "rekey = seconds" 4 |
485 |
.IX Item "rekey = seconds" |
486 |
Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are |
487 |
reestablished every \f(CW\*(C`rekey\*(C'\fR seconds, making them use a new encryption |
488 |
key. |
489 |
.IP "nfmark = integer" 4 |
490 |
.IX Item "nfmark = integer" |
491 |
This advanced option, when set to a nonzero value (default: \f(CW0\fR), tries |
492 |
to set the netfilter mark (or fwmark) value on all sockets gvpe uses to |
493 |
send packets. |
494 |
.Sp |
495 |
This can be used to make gvpe use a different set of routing rules. For |
496 |
example, on GNU/Linux, the \f(CW\*(C`if\-up\*(C'\fR could set \f(CW\*(C`nfmark\*(C'\fR to 1000 and then |
497 |
put all routing rules into table \f(CW99\fR and then use an ip rule to make |
498 |
gvpe traffic avoid that routing table, in effect routing normal traffic |
499 |
via gvpe and gvpe traffic via the normal system routing tables: |
500 |
.Sp |
501 |
.Vb 1 |
502 |
\& ip rule add not fwmark 1000 lookup 99 |
503 |
.Ve |
504 |
.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
505 |
.IX Subsection "NODE SPECIFIC SETTINGS" |
506 |
The following settings are node-specific, that is, every node can have |
507 |
different settings, even within the same gvpe instance. Settings that are |
508 |
set before the first node section set the defaults, settings that are |
509 |
set within a node section only apply to the given node. |
510 |
.IP "allow-direct = nodename" 4 |
511 |
.IX Item "allow-direct = nodename" |
512 |
Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info. |
513 |
.IP "compress = yes|true|on | no|false|off" 4 |
514 |
.IX Item "compress = yes|true|on | no|false|off" |
515 |
Wether to compress data packets sent to this node (default: \f(CW\*(C`yes\*(C'\fR). |
516 |
Compression is really cheap even on slow computers and has no size |
517 |
overhead at all, so enabling this is often a good idea. |
518 |
.IP "connect = ondemand | never | always | disabled" 4 |
519 |
.IX Item "connect = ondemand | never | always | disabled" |
520 |
Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always |
521 |
try to establish and keep a connection to the given node), \f(CW\*(C`never\*(C'\fR |
522 |
(never initiate a connection to the given host, but accept connections), |
523 |
\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection when there are outstanding |
524 |
packets in the queue and take it down after the keepalive interval) or |
525 |
\&\f(CW\*(C`disabled\*(C'\fR (node is bad, don't talk to it). |
526 |
.Sp |
527 |
Routers will automatically be forced to \f(CW\*(C`always\*(C'\fR unless they are |
528 |
\&\f(CW\*(C`disabled\*(C'\fR, to ensure all nodes can talk to each other. |
529 |
.IP "deny-direct = nodename | *" 4 |
530 |
.IX Item "deny-direct = nodename | *" |
531 |
Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR |
532 |
is given). Only one node can be specified, but you can use multiple |
533 |
\&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in |
534 |
networks with routers, as routers are required for indirect connections. |
535 |
.Sp |
536 |
Sometimes, a node cannot reach some other nodes for reasons of network |
537 |
connectivity. For example, a node behind a firewall that only allows |
538 |
connections to/from a single other node in the network. In this case one |
539 |
should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other |
540 |
node \fImust\fR be a router for this to work). |
541 |
.Sp |
542 |
The algorithm to check whether a connection may be direct is as follows: |
543 |
.Sp |
544 |
1. Other node mentioned in an \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection. |
545 |
.Sp |
546 |
2. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections. |
547 |
.Sp |
548 |
3. Allow the connection. |
549 |
.Sp |
550 |
That is, \f(CW\*(C`allow\-direct\*(C'\fR takes precedence over \f(CW\*(C`deny\-direct\*(C'\fR. |
551 |
.Sp |
552 |
The check is done in both directions, i.e. both nodes must allow a direct |
553 |
connection before one is attempted, so you only need to specify connect |
554 |
limitations on one node. |
555 |
.IP "dns-domain = domain-suffix" 4 |
556 |
.IX Item "dns-domain = domain-suffix" |
557 |
The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node. |
558 |
.Sp |
559 |
The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, |
560 |
i.e. |
561 |
.Sp |
562 |
.Vb 2 |
563 |
\& dns\-domainname = tunnel.example.net |
564 |
\& dns\-hostname = tunnel\-server.example.net |
565 |
.Ve |
566 |
.Sp |
567 |
Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain: |
568 |
.Sp |
569 |
.Vb 2 |
570 |
\& tunnel.example.net. NS tunnel\-server.example.net. |
571 |
\& tunnel\-server.example.net. A 13.13.13.13 |
572 |
.Ve |
573 |
.IP "dns-hostname = hostname/ip" 4 |
574 |
.IX Item "dns-hostname = hostname/ip" |
575 |
The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR, |
576 |
but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might |
577 |
change. |
578 |
.IP "dns-port = port-number" 4 |
579 |
.IX Item "dns-port = port-number" |
580 |
The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers. |
581 |
.IP "enable-dns = yes|true|on | no|false|off" 4 |
582 |
.IX Item "enable-dns = yes|true|on | no|false|off" |
583 |
See \fIgvpe.protocol\fR\|(7) for a description of the \s-1DNS\s0 transport |
584 |
protocol. Avoid this protocol if you can. |
585 |
.Sp |
586 |
Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as |
587 |
client. Support for this transport protocol is only available when gvpe |
588 |
was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option. |
589 |
.IP "enable-icmp = yes|true|on | no|false|off" 4 |
590 |
.IX Item "enable-icmp = yes|true|on | no|false|off" |
591 |
See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol. |
592 |
.Sp |
593 |
Enable the \s-1ICMP\s0 transport using \s-1ICMP\s0 packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this |
594 |
node. |
595 |
.IP "enable-rawip = yes|true|on | no|false|off" 4 |
596 |
.IX Item "enable-rawip = yes|true|on | no|false|off" |
597 |
See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol. |
598 |
.Sp |
599 |
Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol |
600 |
(default: \f(CW\*(C`no\*(C'\fR). |
601 |
.IP "enable-tcp = yes|true|on | no|false|off" 4 |
602 |
.IX Item "enable-tcp = yes|true|on | no|false|off" |
603 |
See \fIgvpe.protocol\fR\|(7) for a description of the \s-1TCP\s0 transport protocol. |
604 |
.Sp |
605 |
Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port |
606 |
(default: \f(CW\*(C`no\*(C'\fR). Support for this transport protocol is only available |
607 |
when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. |
608 |
.IP "enable-udp = yes|true|on | no|false|off" 4 |
609 |
.IX Item "enable-udp = yes|true|on | no|false|off" |
610 |
See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol. |
611 |
.Sp |
612 |
Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, |
613 |
unless no other protocol is enabled for a node, in which case this |
614 |
protocol is enabled automatically). |
615 |
.Sp |
616 |
\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want to use it even though |
617 |
it might get switched on automatically, as some future version might |
618 |
default to another default protocol. |
619 |
.IP "hostname = hostname | ip [can not be defaulted]" 4 |
620 |
.IX Item "hostname = hostname | ip [can not be defaulted]" |
621 |
Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0 |
622 |
address. It will be resolved before each connect request, so dyndns should |
623 |
work fine. If this setting is not specified and a router is available, |
624 |
then the router will be queried for the address of this node. Otherwise, |
625 |
the connection attempt will fail. |
626 |
.Sp |
627 |
Note that \s-1DNS\s0 resolving is done synchronously, pausing the daemon. If that |
628 |
is an issue you need to specify \s-1IP\s0 addresses. |
629 |
.IP "icmp-type = integer" 4 |
630 |
.IX Item "icmp-type = integer" |
631 |
Sets the type value to be used for outgoing (and incoming) packets sent |
632 |
via the \s-1ICMP\s0 transport. |
633 |
.Sp |
634 |
The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as |
635 |
\&\*(L"ping-reply\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. |
636 |
\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. |
637 |
.IP "if-up-data = value" 4 |
638 |
.IX Item "if-up-data = value" |
639 |
The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR |
640 |
script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR. |
641 |
.IP "inherit-tos = yes|true|on | no|false|off" 4 |
642 |
.IX Item "inherit-tos = yes|true|on | no|false|off" |
643 |
Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
644 |
sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
645 |
outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
646 |
to the tunnel device, which is usually what you want. |
647 |
.IP "max-retry = positive-number" 4 |
648 |
.IX Item "max-retry = positive-number" |
649 |
The maximum interval in seconds (default: \f(CW3600\fR, one hour) between |
650 |
retries to establish a connection to this node. When a connection cannot |
651 |
be established, gvpe uses exponential back-off capped at this value. It's |
652 |
sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on |
653 |
connections to routers that usually are stable but sometimes are down, to |
654 |
assure quick reconnections even after longer downtimes. |
655 |
.IP "max-ttl = seconds" 4 |
656 |
.IX Item "max-ttl = seconds" |
657 |
Expire packets that couldn't be sent after this many seconds |
658 |
(default: \f(CW60\fR). Gvpe will normally queue packets for a node without an |
659 |
active connection, in the hope of establishing a connection soon. This |
660 |
value specifies the maximum lifetime a packet will stay in the queue, if a |
661 |
packet gets older, it will be thrown away. |
662 |
.IP "max-queue = positive\-number>=1" 4 |
663 |
.IX Item "max-queue = positive-number>=1" |
664 |
The maximum number of packets that will be queued (default: \f(CW512\fR) |
665 |
for this node. If more packets are sent then earlier packets will be |
666 |
expired. See \f(CW\*(C`max\-ttl\*(C'\fR, above. |
667 |
.IP "router-priority = 0 | 1 | positive\-number>=2" 4 |
668 |
.IX Item "router-priority = 0 | 1 | positive-number>=2" |
669 |
Sets the router priority of the given node (default: \f(CW0\fR, disabled). |
670 |
.Sp |
671 |
If some node tries to connect to another node but it doesn't have a |
672 |
hostname, it asks a router node for it's \s-1IP\s0 address. The router node |
673 |
chosen is the one with the highest priority larger than \f(CW1\fR that is |
674 |
currently reachable. This is called a \fImediated\fR connection, as the |
675 |
connection itself will still be direct, but it uses another node to |
676 |
mediate between the two nodes. |
677 |
.Sp |
678 |
The value \f(CW0\fR disables routing, that means if the node receives a packet |
679 |
not for itself it will not forward it but instead drop it. |
680 |
.Sp |
681 |
The special value \f(CW1\fR allows other hosts to route through the router |
682 |
host, but they will never route through it by default (i.e. the config |
683 |
file of another node needs to specify a router priority higher than one |
684 |
to choose such a node for routing). |
685 |
.Sp |
686 |
The idea behind this is that some hosts can, if required, bump the |
687 |
\&\f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their local config to |
688 |
route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is \f(CW0\fR, then routing |
689 |
will be refused, so \f(CW1\fR serves as a \*(L"enable, but do not use by default\*(R" |
690 |
switch. |
691 |
.Sp |
692 |
Nodes with \f(CW\*(C`router\-priority\*(C'\fR set to \f(CW2\fR or higher will always be forced |
693 |
to \f(CW\*(C`connect\*(C'\fR = \f(CW\*(C`always\*(C'\fR (unless they are \f(CW\*(C`disabled\*(C'\fR). |
694 |
.IP "tcp-port = port-number" 4 |
695 |
.IX Item "tcp-port = port-number" |
696 |
Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. |
697 |
.IP "udp-port = port-number" 4 |
698 |
.IX Item "udp-port = port-number" |
699 |
Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not |
700 |
officially assigned by \s-1IANA\s0!). |
701 |
.SH "CONFIG DIRECTORY LAYOUT" |
702 |
.IX Header "CONFIG DIRECTORY LAYOUT" |
703 |
The default (or recommended) directory layout for the config directory is: |
704 |
.IP "gvpe.conf" 4 |
705 |
.IX Item "gvpe.conf" |
706 |
The config file. |
707 |
.IP "if-up" 4 |
708 |
.IX Item "if-up" |
709 |
The if-up script |
710 |
.IP "node-up, node-down" 4 |
711 |
.IX Item "node-up, node-down" |
712 |
If used the node up or node-down scripts. |
713 |
.IP "hostkey" 4 |
714 |
.IX Item "hostkey" |
715 |
The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. |
716 |
.IP "pubkey/nodename" 4 |
717 |
.IX Item "pubkey/nodename" |
718 |
The public keys of the other nodes, one file per node. |
719 |
.SH "SEE ALSO" |
720 |
.IX Header "SEE ALSO" |
721 |
\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). |
722 |
.SH "AUTHOR" |
723 |
.IX Header "AUTHOR" |
724 |
Marc Lehmann <gvpe@schmorp.de> |