1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 |
1 | .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) |
2 | .\" |
2 | .\" |
3 | .\" Standard preamble: |
3 | .\" Standard preamble: |
4 | .\" ======================================================================== |
4 | .\" ======================================================================== |
5 | .de Sh \" Subsection heading |
5 | .de Sh \" Subsection heading |
6 | .br |
6 | .br |
… | |
… | |
23 | .ft R |
23 | .ft R |
24 | .fi |
24 | .fi |
25 | .. |
25 | .. |
26 | .\" Set up some character translations and predefined strings. \*(-- will |
26 | .\" Set up some character translations and predefined strings. \*(-- will |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
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 |
28 | .\" double quote, and \*(R" will give a right double quote. \*(C+ will |
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
29 | .\" give a nicer C++. Capital omega is used to do unbreakable dashes and |
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
30 | .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. |
31 | .\" nothing in troff, for use with C<>. |
32 | .tr \(*W-|\(bv\*(Tr |
32 | .tr \(*W- |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
34 | .ie n \{\ |
34 | .ie n \{\ |
35 | . ds -- \(*W- |
35 | . ds -- \(*W- |
36 | . ds PI pi |
36 | . ds PI pi |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
… | |
… | |
46 | . ds PI \(*p |
46 | . ds PI \(*p |
47 | . ds L" `` |
47 | . ds L" `` |
48 | . ds R" '' |
48 | . ds R" '' |
49 | 'br\} |
49 | 'br\} |
50 | .\" |
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 | .\" |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for |
55 | .\" 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 |
56 | .\" 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 |
57 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
54 | .\" output yourself in some meaningful fashion. |
58 | .\" output yourself in some meaningful fashion. |
55 | .if \nF \{\ |
59 | .ie \nF \{\ |
56 | . de IX |
60 | . de IX |
57 | . tm Index:\\$1\t\\n%\t"\\$2" |
61 | . tm Index:\\$1\t\\n%\t"\\$2" |
58 | .. |
62 | .. |
59 | . nr % 0 |
63 | . nr % 0 |
60 | . rr F |
64 | . rr F |
61 | .\} |
65 | .\} |
62 | .\" |
66 | .el \{\ |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
67 | . de IX |
64 | .\" way too many mistakes in technical documents. |
68 | .. |
65 | .hy 0 |
69 | .\} |
66 | .if n .na |
|
|
67 | .\" |
70 | .\" |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
71 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
72 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
70 | . \" fudge factors for nroff and troff |
73 | . \" fudge factors for nroff and troff |
71 | .if n \{\ |
74 | .if n \{\ |
… | |
… | |
127 | .\} |
130 | .\} |
128 | .rm #[ #] #H #V #F C |
131 | .rm #[ #] #H #V #F C |
129 | .\" ======================================================================== |
132 | .\" ======================================================================== |
130 | .\" |
133 | .\" |
131 | .IX Title "GVPE.CONF 5" |
134 | .IX Title "GVPE.CONF 5" |
132 | .TH GVPE.CONF 5 "2005-03-06" "1.8" "GNU Virtual Private Ethernet" |
135 | .TH GVPE.CONF 5 "2008-08-07" "2.2" "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 |
133 | .SH "NAME" |
140 | .SH "NAME" |
134 | gvpe.conf \- configuration file for the GNU VPE daemon |
141 | gvpe.conf \- configuration file for the GNU VPE daemon |
135 | .SH "SYNOPSIS" |
142 | .SH "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
143 | .IX Header "SYNOPSIS" |
137 | .Vb 3 |
144 | .Vb 3 |
138 | \& udp-port = 407 |
145 | \& udp\-port = 407 |
139 | \& mtu = 1492 |
146 | \& mtu = 1492 |
140 | \& ifname = vpn0 |
147 | \& ifname = vpn0 |
141 | .Ve |
148 | \& |
142 | .PP |
|
|
143 | .Vb 2 |
|
|
144 | \& node = branch1 |
149 | \& node = branch1 |
145 | \& hostname = 1.2.3.4 |
150 | \& hostname = 1.2.3.4 |
146 | .Ve |
151 | \& |
147 | .PP |
|
|
148 | .Vb 3 |
|
|
149 | \& node = branch2 |
152 | \& node = branch2 |
150 | \& hostname = www.example.net |
153 | \& hostname = www.example.net |
151 | \& udp-port = 500 # this host uses a different udp-port |
154 | \& udp\-port = 500 # this host uses a different udp\-port |
152 | .Ve |
155 | \& |
153 | .PP |
|
|
154 | .Vb 2 |
|
|
155 | \& node = branch3 |
156 | \& node = branch3 |
156 | \& connect = ondemand |
157 | \& connect = ondemand |
157 | .Ve |
158 | .Ve |
158 | .SH "DESCRIPTION" |
159 | .SH "DESCRIPTION" |
159 | .IX Header "DESCRIPTION" |
160 | .IX Header "DESCRIPTION" |
160 | The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable |
161 | The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable |
161 | = value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and |
162 | = value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and |
162 | extend to the end of the line. They can be used on their own lines, or |
163 | extend to the end of the line. They can be used on their own lines, or |
163 | after any directives. Spaces are allowed before or after the \f(CW\*(C`=\*(C'\fR sign or |
164 | after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after |
164 | after values, but not within the variable names or values themselves. |
165 | values, but not within the variable names or values themselves. |
165 | .PP |
166 | .PP |
166 | The only exception to the above is the \*(L"on\*(R" directive that can prefix any |
167 | The only exception to the above is the \*(L"on\*(R" directive that can prefix any |
167 | \&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or |
168 | \&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or |
168 | (if the nodename starts with \*(L"!\*(R") on all nodes except the named one. |
169 | (if the nodename starts with \*(L"!\*(R") on all nodes except the named one. |
169 | .PP |
170 | .PP |
… | |
… | |
202 | (default: \f(CW127.0.0.1\fR, changing it is highly recommended). |
203 | (default: \f(CW127.0.0.1\fR, changing it is highly recommended). |
203 | .IP "dns-forw-port = port-number" 4 |
204 | .IP "dns-forw-port = port-number" 4 |
204 | .IX Item "dns-forw-port = port-number" |
205 | .IX Item "dns-forw-port = port-number" |
205 | The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR, |
206 | The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR, |
206 | which is fine in most cases). |
207 | which is fine in most cases). |
|
|
208 | .IP "dns-max-outstanding = integer-number-of-requests" 4 |
|
|
209 | .IX Item "dns-max-outstanding = integer-number-of-requests" |
|
|
210 | The maximum number of outstanding \s-1DNS\s0 transport requests |
|
|
211 | (default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given |
|
|
212 | limit without receiving replies. In heavily overloaded situations it might |
|
|
213 | help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the |
|
|
214 | number of parallel requests. |
|
|
215 | .Sp |
|
|
216 | The default should be working ok for most links. |
|
|
217 | .IP "dns-overlap-factor = float" 4 |
|
|
218 | .IX Item "dns-overlap-factor = float" |
|
|
219 | The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen |
|
|
220 | during a connection as it's timing base. This factor (default: \f(CW0.5\fR, |
|
|
221 | must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending |
|
|
222 | rate (= minimum send interval), i.e. a factor of \f(CW1\fR means that a new |
|
|
223 | request might be generated every \fBmin_latency\fR seconds, which means on |
|
|
224 | average there should only ever be one outstanding request. A factor of |
|
|
225 | \&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum |
|
|
226 | latency measured. |
|
|
227 | .Sp |
|
|
228 | For congested or picky dns forwarders you could use a value nearer to or |
|
|
229 | exceeding \f(CW1\fR. |
|
|
230 | .Sp |
|
|
231 | The default should be working ok for most links. |
|
|
232 | .IP "dns-send-interval = send-interval-in-seconds" 4 |
|
|
233 | .IX Item "dns-send-interval = send-interval-in-seconds" |
|
|
234 | The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will |
|
|
235 | use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when |
|
|
236 | the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will |
|
|
237 | not send more than 100 \s-1DNS\s0 requests per connection per second. For |
|
|
238 | high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For |
|
|
239 | congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR, |
|
|
240 | \&\f(CW0.2\fR or even higher. |
|
|
241 | .Sp |
|
|
242 | The default should be working ok for most links. |
|
|
243 | .IP "dns-timeout-factor = float" 4 |
|
|
244 | .IX Item "dns-timeout-factor = float" |
|
|
245 | Factor to multiply the \f(CW\*(C`min_latency\*(C'\fR (see \f(CW\*(C`dns\-overlap\-factor\*(C'\fR) by to |
|
|
246 | get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport |
|
|
247 | will resend the request when no reply has been received for longer than |
|
|
248 | eight times the minimum (= expected) latency, assuming the request or |
|
|
249 | reply has been lost. |
|
|
250 | .Sp |
|
|
251 | For congested links a higher value might be necessary (e.g. \f(CW30\fR). If |
|
|
252 | the link is very stable lower values (e.g. \f(CW2\fR) might work |
|
|
253 | nicely. Values near or below \f(CW1\fR makes no sense whatsoever. |
|
|
254 | .Sp |
|
|
255 | The default should be working ok for most links but will result in low |
|
|
256 | throughput if packet loss is high. |
207 | .IP "if-up = relative-or-absolute-path" 4 |
257 | .IP "if-up = relative-or-absolute-path" 4 |
208 | .IX Item "if-up = relative-or-absolute-path" |
258 | .IX Item "if-up = relative-or-absolute-path" |
209 | Sets the path of a script that should be called immediately after the |
259 | Sets the path of a script that should be called immediately after the |
210 | network interface is initialized (but not neccessarily up). The following |
260 | network interface is initialized (but not neccessarily up). The following |
211 | environment variables are passed to it (the values are just examples): |
261 | environment variables are passed to it (the values are just examples). |
|
|
262 | .Sp |
|
|
263 | Variables that have the same value on all nodes: |
212 | .RS 4 |
264 | .RS 4 |
213 | .IP "CONFBASE=/etc/gvpe" 4 |
265 | .IP "CONFBASE=/etc/gvpe" 4 |
214 | .IX Item "CONFBASE=/etc/gvpe" |
266 | .IX Item "CONFBASE=/etc/gvpe" |
215 | The configuration base directory. |
267 | The configuration base directory. |
216 | .IP "IFNAME=vpn0" 4 |
268 | .IP "IFNAME=vpn0" 4 |
217 | .IX Item "IFNAME=vpn0" |
269 | .IX Item "IFNAME=vpn0" |
218 | The interface to initialize. |
270 | The network interface to initialize. |
219 | .IP "MTU=1436" 4 |
|
|
220 | .IX Item "MTU=1436" |
|
|
221 | The \s-1MTU\s0 to set the interface to. You can use lower values (if done |
|
|
222 | consistently on all hosts), but this is usually ineffective. |
|
|
223 | .IP "MAC=fe:fd:80:00:00:01" 4 |
|
|
224 | .IX Item "MAC=fe:fd:80:00:00:01" |
|
|
225 | The \s-1MAC\s0 address to set the interface to. The script *must* set the |
|
|
226 | interface \s-1MAC\s0 to this value. You will most likely use one of these: |
|
|
227 | .Sp |
|
|
228 | .Vb 2 |
|
|
229 | \& ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux |
|
|
230 | \& ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD |
|
|
231 | .Ve |
|
|
232 | .Sp |
|
|
233 | Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for platform-specific information. |
|
|
234 | .IP "IFTYPE=native # or tincd" 4 |
271 | .IP "IFTYPE=native # or tincd" 4 |
235 | .IX Item "IFTYPE=native # or tincd" |
272 | .IX Item "IFTYPE=native # or tincd" |
236 | .PD 0 |
273 | .PD 0 |
237 | .IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 |
274 | .IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 |
238 | .IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." |
275 | .IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." |
239 | .PD |
276 | .PD |
240 | The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os |
277 | The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the |
241 | name in lowercase) that this gvpe was configured for. Can be used to select |
278 | \&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to |
242 | the correct syntax to use for network-related commands. |
279 | select the correct syntax to use for network-related commands. |
|
|
280 | .IP "MTU=1436" 4 |
|
|
281 | .IX Item "MTU=1436" |
|
|
282 | The \s-1MTU\s0 to set the interface to. You can use lower values (if done |
|
|
283 | consistently on all hosts), but this is usually ineffective. |
|
|
284 | .IP "NODES=5" 4 |
|
|
285 | .IX Item "NODES=5" |
|
|
286 | The number of nodes in this \s-1GVPE\s0 network. |
|
|
287 | .RE |
|
|
288 | .RS 4 |
|
|
289 | .Sp |
|
|
290 | Variables that are node-specific and with values pertaining to the node |
|
|
291 | running this \s-1GVPE:\s0 |
|
|
292 | .IP "IFUPDATA=string" 4 |
|
|
293 | .IX Item "IFUPDATA=string" |
|
|
294 | The value of the configuration directive \f(CW\*(C`if\-up\-data\*(C'\fR. |
|
|
295 | .IP "MAC=fe:fd:80:00:00:01" 4 |
|
|
296 | .IX Item "MAC=fe:fd:80:00:00:01" |
|
|
297 | The \s-1MAC\s0 address the network interface has to use. |
|
|
298 | .Sp |
|
|
299 | Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not |
|
|
300 | do this automatically. Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for |
|
|
301 | platform-specific information. |
243 | .IP "NODENAME=branch1" 4 |
302 | .IP "NODENAME=branch1" 4 |
244 | .IX Item "NODENAME=branch1" |
303 | .IX Item "NODENAME=branch1" |
245 | The nickname of the current node, as passed to the gvpe daemon. |
304 | The nickname of the node. |
246 | .IP "NODEID=1" 4 |
305 | .IP "NODEID=1" 4 |
247 | .IX Item "NODEID=1" |
306 | .IX Item "NODEID=1" |
248 | The numerical node id of the current node. The first node mentioned in the |
307 | The numerical node \s-1ID\s0 of the node running this instance of \s-1GVPE\s0. The first |
249 | config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on. |
308 | node mentioned in the config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on. |
250 | .RE |
309 | .RE |
251 | .RS 4 |
310 | .RS 4 |
252 | .Sp |
311 | .Sp |
|
|
312 | In addition, all node-specific variables (except \f(CW\*(C`NODEID\*(C'\fR) will be |
|
|
313 | available with a postfix of \f(CW\*(C`_nodeid\*(C'\fR, which contains the value for that |
|
|
314 | node, e.g. the \f(CW\*(C`MAC_1\*(C'\fR variable contains the \s-1MAC\s0 address of node #1, while |
|
|
315 | the \f(CW\*(C`NODENAME_22\*(C'\fR variable contains the name of node #22. |
|
|
316 | .Sp |
253 | Here is a simple if-up script: |
317 | Here is a simple if-up script: |
254 | .Sp |
318 | .Sp |
255 | .Vb 5 |
319 | .Vb 5 |
256 | \& #!/bin/sh |
320 | \& #!/bin/sh |
257 | \& ip link set $IFNAME address $MAC mtu $MTU up |
321 | \& ip link set $IFNAME up |
258 | \& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME |
322 | \& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME |
259 | \& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME |
323 | \& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME |
260 | \& ip route add 10.0.0.0/8 dev $IFNAME |
324 | \& ip route add 10.0.0.0/8 dev $IFNAME |
261 | .Ve |
325 | .Ve |
262 | .Sp |
326 | .Sp |
… | |
… | |
309 | enabled on all hosts. |
373 | enabled on all hosts. |
310 | .Sp |
374 | .Sp |
311 | Example: |
375 | Example: |
312 | .Sp |
376 | .Sp |
313 | .Vb 3 |
377 | .Vb 3 |
314 | \& http-proxy-host = proxy.example.com |
378 | \& http\-proxy\-host = proxy.example.com |
315 | \& http-proxy-port = 3128 # 8080 is another common choice |
379 | \& http\-proxy\-port = 3128 # 8080 is another common choice |
316 | \& http-proxy-auth = schmorp:grumbeere |
380 | \& http\-proxy\-auth = schmorp:grumbeere |
317 | .Ve |
381 | .Ve |
318 | .IP "http-proxy-port = proxy-tcp-port" 4 |
382 | .IP "http-proxy-port = proxy-tcp-port" 4 |
319 | .IX Item "http-proxy-port = proxy-tcp-port" |
383 | .IX Item "http-proxy-port = proxy-tcp-port" |
320 | The port where your proxy server listens. |
384 | The port where your proxy server listens. |
321 | .IP "http-proxy-auth = login:password" 4 |
385 | .IP "http-proxy-auth = login:password" 4 |
… | |
… | |
349 | Not really a config setting but introduces a node section. The nickname is |
413 | Not really a config setting but introduces a node section. The nickname is |
350 | used to select the right configuration section and must be passed as an |
414 | used to select the right configuration section and must be passed as an |
351 | argument to the gvpe daemon. |
415 | argument to the gvpe daemon. |
352 | .IP "node-up = relative-or-absolute-path" 4 |
416 | .IP "node-up = relative-or-absolute-path" 4 |
353 | .IX Item "node-up = relative-or-absolute-path" |
417 | .IX Item "node-up = relative-or-absolute-path" |
354 | Sets a command (default: no script) that should be called whenever a |
418 | Sets a command (default: none) that should be called whenever a connection |
355 | connection is established (even on rekeying operations). In addition |
419 | is established (even on rekeying operations). Note that node\-up/down |
|
|
420 | scripts will be run asynchronously, but execution is serialised, so there |
|
|
421 | will only ever be one such script running. |
|
|
422 | .Sp |
356 | to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment |
423 | In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following |
357 | variables will be set: |
424 | environment variables will be set: |
358 | .RS 4 |
425 | .RS 4 |
359 | .IP "DESTNODE=branch2" 4 |
426 | .IP "DESTNODE=branch2" 4 |
360 | .IX Item "DESTNODE=branch2" |
427 | .IX Item "DESTNODE=branch2" |
361 | The name of the remote node. |
428 | The name of the remote node. |
362 | .IP "DESTID=2" 4 |
429 | .IP "DESTID=2" 4 |
… | |
… | |
383 | \& #!/bin/sh |
450 | \& #!/bin/sh |
384 | \& { |
451 | \& { |
385 | \& echo update delete $DESTNODE.lowttl.example.net. a |
452 | \& echo update delete $DESTNODE.lowttl.example.net. a |
386 | \& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP |
453 | \& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP |
387 | \& echo |
454 | \& echo |
388 | \& } | nsupdate -d -k $CONFBASE:key.example.net. |
455 | \& } | nsupdate \-d \-k $CONFBASE:key.example.net. |
389 | .Ve |
456 | .Ve |
390 | .RE |
457 | .RE |
391 | .IP "node-down = relative-or-absolute-path" 4 |
458 | .IP "node-down = relative-or-absolute-path" 4 |
392 | .IX Item "node-down = relative-or-absolute-path" |
459 | .IX Item "node-down = relative-or-absolute-path" |
393 | Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. |
460 | Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. |
… | |
… | |
410 | .IX Item "rekey = seconds" |
477 | .IX Item "rekey = seconds" |
411 | Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are |
478 | Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are |
412 | reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. |
479 | reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. |
413 | .Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
480 | .Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
414 | .IX Subsection "NODE SPECIFIC SETTINGS" |
481 | .IX Subsection "NODE SPECIFIC SETTINGS" |
415 | The following settings are node\-specific, that is, every node can have |
482 | The following settings are node-specific, that is, every node can have |
416 | different settings, even within the same gvpe instance. Settings that are |
483 | different settings, even within the same gvpe instance. Settings that are |
417 | executed before the first node section set the defaults, settings that are |
484 | set before the first node section set the defaults, settings that are |
418 | executed within a node section only apply to the given node. |
485 | set within a node section only apply to the given node. |
|
|
486 | .IP "allow-direct = nodename" 4 |
|
|
487 | .IX Item "allow-direct = nodename" |
|
|
488 | Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info. |
419 | .IP "compress = yes|true|on | no|false|off" 4 |
489 | .IP "compress = yes|true|on | no|false|off" 4 |
420 | .IX Item "compress = yes|true|on | no|false|off" |
490 | .IX Item "compress = yes|true|on | no|false|off" |
421 | Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). |
491 | Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). |
422 | Compression is really cheap even on slow computers and has no size |
492 | Compression is really cheap even on slow computers and has no size |
423 | overhead at all, so enabling this is a good idea. |
493 | overhead at all, so enabling this is a good idea. |
424 | .IP "connect = ondemand | never | always | disabled" 4 |
494 | .IP "connect = ondemand | never | always | disabled" 4 |
425 | .IX Item "connect = ondemand | never | always | disabled" |
495 | .IX Item "connect = ondemand | never | always | disabled" |
426 | Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always |
496 | Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always |
427 | try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR |
497 | try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR |
428 | (never initiate a connection to the given host, but accept connections), |
498 | (never initiate a connection to the given host, but accept connections), |
429 | \&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and |
499 | \&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection when there are outstanding |
430 | take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, |
500 | packets in the queue and take it down after the keepalive interval) or |
431 | don't talk to it). |
501 | \&\f(CW\*(C`disabled\*(C'\fR (node is bad, don't talk to it). |
|
|
502 | .IP "deny-direct = nodename | *" 4 |
|
|
503 | .IX Item "deny-direct = nodename | *" |
|
|
504 | Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR |
|
|
505 | is given). Only one node can be specified, but you can use multiple |
|
|
506 | \&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in |
|
|
507 | networks with routers, as routers are required for indirect connections. |
|
|
508 | .Sp |
|
|
509 | Sometimes, a node cannot reach some other nodes for reasons of network |
|
|
510 | connectivity. For example, a node behind a firewall that only allows |
|
|
511 | conenctions to/from a single other node in the network. In this case one |
|
|
512 | should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other |
|
|
513 | node \fImust\fR be a router for this to work). |
|
|
514 | .Sp |
|
|
515 | The algorithm to check wether a connection may be direct is as follows: |
|
|
516 | .Sp |
|
|
517 | 1. Other node mentioned in a \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection. |
|
|
518 | .Sp |
|
|
519 | 2. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections. |
|
|
520 | .Sp |
|
|
521 | 3. Allow the connection. |
|
|
522 | .Sp |
|
|
523 | That is, \f(CW\*(C`allow\-direct\*(C'\fR takes precedence over \f(CW\*(C`deny\-direct\*(C'\fR. |
|
|
524 | .Sp |
|
|
525 | The check is done in both directions, i.e. both nodes must allow a direct |
|
|
526 | connection before one is attempted, so you only need to specify connect |
|
|
527 | limitations on one node. |
432 | .IP "dns-domain = domain-suffix" 4 |
528 | .IP "dns-domain = domain-suffix" 4 |
433 | .IX Item "dns-domain = domain-suffix" |
529 | .IX Item "dns-domain = domain-suffix" |
434 | The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server. Needs to be |
530 | The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node. |
435 | set on both client and server. |
|
|
436 | .Sp |
531 | .Sp |
437 | The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, |
532 | The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, |
438 | i.e. |
533 | i.e. |
439 | .Sp |
534 | .Sp |
440 | .Vb 2 |
535 | .Vb 2 |
441 | \& dns-domainname = tunnel.example.net |
536 | \& dns\-domainname = tunnel.example.net |
442 | \& dns-hostname = tunnel-server.example.net |
537 | \& dns\-hostname = tunnel\-server.example.net |
443 | .Ve |
538 | .Ve |
444 | .Sp |
539 | .Sp |
445 | Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain: |
540 | Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain: |
446 | .Sp |
541 | .Sp |
447 | .Vb 2 |
542 | .Vb 2 |
448 | \& tunnel.example.net. NS tunnel-server.example.net. |
543 | \& tunnel.example.net. NS tunnel\-server.example.net. |
449 | \& tunnel-server.example.net. A 13.13.13.13 |
544 | \& tunnel\-server.example.net. A 13.13.13.13 |
450 | .Ve |
545 | .Ve |
451 | .IP "dns-hostname = hostname/ip" 4 |
546 | .IP "dns-hostname = hostname/ip" 4 |
452 | .IX Item "dns-hostname = hostname/ip" |
547 | .IX Item "dns-hostname = hostname/ip" |
453 | The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR, |
548 | The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR, |
454 | but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might |
549 | but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might |
455 | change. |
550 | change. |
456 | .IP "dns-port = port-number" 4 |
551 | .IP "dns-port = port-number" 4 |
457 | .IX Item "dns-port = port-number" |
552 | .IX Item "dns-port = port-number" |
458 | The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW0\fR on all \s-1DNS\s0 tunnel |
553 | The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers. |
459 | clients and \f(CW53\fR on the server. |
554 | .IP "enable-dns = yes|true|on | no|false|off" 4 |
|
|
555 | .IX Item "enable-dns = yes|true|on | no|false|off" |
|
|
556 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1DNS\s0 transport |
|
|
557 | protocol. Avoid this protocol if you can. |
|
|
558 | .Sp |
|
|
559 | Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as |
|
|
560 | client. Support for this transport protocol is only available when gvpe |
|
|
561 | was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option. |
|
|
562 | .IP "enable-icmp = yes|true|on | no|false|off" 4 |
|
|
563 | .IX Item "enable-icmp = yes|true|on | no|false|off" |
|
|
564 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol. |
|
|
565 | .Sp |
|
|
566 | Enable the \s-1ICMP\s0 transport using icmp packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this |
|
|
567 | node. |
460 | .IP "enable-rawip = yes|true|on | no|false|off" 4 |
568 | .IP "enable-rawip = yes|true|on | no|false|off" 4 |
461 | .IX Item "enable-rawip = yes|true|on | no|false|off" |
569 | .IX Item "enable-rawip = yes|true|on | no|false|off" |
|
|
570 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol. |
|
|
571 | .Sp |
462 | Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol |
572 | Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol |
463 | (default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the overhead per packet |
573 | (default: \f(CW\*(C`no\*(C'\fR). |
464 | is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+). |
|
|
465 | .IP "enable-tcp = yes|true|on | no|false|off" 4 |
574 | .IP "enable-tcp = yes|true|on | no|false|off" 4 |
466 | .IX Item "enable-tcp = yes|true|on | no|false|off" |
575 | .IX Item "enable-tcp = yes|true|on | no|false|off" |
|
|
576 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1TCP\s0 transport protocol. |
|
|
577 | .Sp |
467 | Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port |
578 | Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port |
468 | (default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only |
579 | (default: \f(CW\*(C`no\*(C'\fR). Support for this transport protocol is only available |
469 | available when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never |
580 | when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. |
470 | use this transport unless you really must, it is horribly ineffiecent and |
|
|
471 | resource-intensive compared to the other transports. |
|
|
472 | .IP "enable-udp = yes|true|on | no|false|off" 4 |
581 | .IP "enable-udp = yes|true|on | no|false|off" 4 |
473 | .IX Item "enable-udp = yes|true|on | no|false|off" |
582 | .IX Item "enable-udp = yes|true|on | no|false|off" |
|
|
583 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol. |
|
|
584 | .Sp |
474 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, |
585 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, |
475 | unless no other protocol is enabled for a node, in which case this |
586 | unless no other protocol is enabled for a node, in which case this |
476 | protocol is enabled automatically). This is a good general choice since |
587 | protocol is enabled automatically). |
477 | \&\s-1UDP\s0 tunnels well through many firewalls. |
|
|
478 | .Sp |
588 | .Sp |
479 | \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though |
589 | \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though |
480 | it might get switched on automatically, as some future version might |
590 | it might get switched on automatically, as some future version might |
481 | default to another default protocol. |
591 | default to another default protocol. |
|
|
592 | .IP "hostname = hostname | ip [can not be defaulted]" 4 |
|
|
593 | .IX Item "hostname = hostname | ip [can not be defaulted]" |
|
|
594 | Forces the address of this node to be set to the given dns hostname or ip |
|
|
595 | address. It will be resolved before each connect request, so dyndns should |
|
|
596 | work fine. If this setting is not specified and a router is available, |
|
|
597 | then the router will be queried for the address of this node. Otherwise, |
|
|
598 | the connection attempt will fail. |
|
|
599 | .IP "icmp-type = integer" 4 |
|
|
600 | .IX Item "icmp-type = integer" |
|
|
601 | Sets the type value to be used for outgoing (and incoming) packets sent |
|
|
602 | via the \s-1ICMP\s0 transport. |
|
|
603 | .Sp |
|
|
604 | The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as |
|
|
605 | \&\*(L"ping-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. |
|
|
606 | \&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. |
|
|
607 | .IP "if-up-data = value" 4 |
|
|
608 | .IX Item "if-up-data = value" |
|
|
609 | The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR |
|
|
610 | script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR. |
482 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
611 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
483 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
612 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
484 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
613 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
485 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
614 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
486 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
615 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
487 | to the tunnel device, which is usually what you want. |
616 | to the tunnel device, which is usually what you want. |
488 | .IP "max-retry = positive-number" 4 |
617 | .IP "max-retry = positive-number" 4 |
489 | .IX Item "max-retry = positive-number" |
618 | .IX Item "max-retry = positive-number" |
490 | The maximum interval in seconds (default: \f(CW28800\fR, 8 hours) between |
619 | The maximum interval in seconds (default: \f(CW3600\fR, one hour) between |
491 | retries to establish a connection to this node. When a connection cannot |
620 | retries to establish a connection to this node. When a connection cannot |
492 | be established, gvpe uses exponential backoff capped at this value. It's |
621 | be established, gvpe uses exponential backoff capped at this value. It's |
493 | sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on |
622 | sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on |
494 | connections to routers that usually are stable but sometimes are down, to |
623 | connections to routers that usually are stable but sometimes are down, to |
495 | assure quick reconnections. |
624 | assure quick reconnections even after longer downtimes. |
|
|
625 | .IP "max-ttl = seconds" 4 |
|
|
626 | .IX Item "max-ttl = seconds" |
|
|
627 | Expire packets that couldn't be sent after this many seconds |
|
|
628 | (default: \f(CW60\fR). Gvpe will normally queue packets for a node without an |
|
|
629 | active connection, in the hope of establishing a connection soon. This |
|
|
630 | value specifies the maximum lifetime a packet will stay in the queue, if a |
|
|
631 | packet gets older, it will be thrown away. |
|
|
632 | .IP "max-queue = positive-number" 4 |
|
|
633 | .IX Item "max-queue = positive-number" |
|
|
634 | The maximum number of packets that will be queued (default: \f(CW512\fR) |
|
|
635 | for this node. If more packets are sent then earlier packets will be |
|
|
636 | expired. See \f(CW\*(C`max\-ttl\*(C'\fR, above. |
496 | .IP "router-priority = 0 | 1 | positive\-number>2" 4 |
637 | .IP "router-priority = 0 | 1 | positive\-number>=2" 4 |
497 | .IX Item "router-priority = 0 | 1 | positive-number>2" |
638 | .IX Item "router-priority = 0 | 1 | positive-number>=2" |
498 | Sets the router priority of the given host (default: \f(CW0\fR, disabled). If |
639 | Sets the router priority of the given host (default: \f(CW0\fR, disabled). If |
499 | some host tries to connect to another host without a hostname, it asks |
640 | some host tries to connect to another host without a hostname, it asks |
500 | the router host for it's \s-1IP\s0 address. The router host is the one with the |
641 | the router host for it's \s-1IP\s0 address. The router host is the one with the |
501 | highest priority larger than \f(CW1\fR that is currently reachable. |
642 | highest priority larger than \f(CW1\fR that is currently reachable. |
502 | .Sp |
643 | .Sp |
… | |
… | |
518 | Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not |
659 | Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not |
519 | officially assigned by \s-1IANA\s0!). |
660 | officially assigned by \s-1IANA\s0!). |
520 | .SH "CONFIG DIRECTORY LAYOUT" |
661 | .SH "CONFIG DIRECTORY LAYOUT" |
521 | .IX Header "CONFIG DIRECTORY LAYOUT" |
662 | .IX Header "CONFIG DIRECTORY LAYOUT" |
522 | The default (or recommended) directory layout for the config directory is: |
663 | The default (or recommended) directory layout for the config directory is: |
523 | .IP "\(bu" 4 |
664 | .IP "" 4 |
524 | .IX Xref "gvpe.conf" |
665 | .IX Xref "gvpe.conf" |
525 | The config file. |
666 | The config file. |
526 | .IP "\(bu" 4 |
667 | .IP "" 4 |
527 | .IX Xref "if-up" |
668 | .IX Xref "if-up" |
528 | The if-up script |
669 | The if-up script |
529 | .IP "," 4 |
670 | .IP "," 4 |
530 | .IX Xref "node-up node-down" |
671 | .IX Xref "node-up node-down" |
531 | If used the node up or node-down scripts. |
672 | If used the node up or node-down scripts. |
532 | .IP "\(bu" 4 |
673 | .IP "" 4 |
533 | .IX Xref "hostkey" |
674 | .IX Xref "hostkey" |
534 | The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. |
675 | The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. |
535 | .IP "\(bu" 4 |
676 | .IP "" 4 |
536 | .IX Xref "pubkey nodename" |
677 | .IX Xref "pubkey nodename" |
537 | The public keys of the other nodes, one file per node. |
678 | The public keys of the other nodes, one file per node. |
538 | .SH "SEE ALSO" |
679 | .SH "SEE ALSO" |
539 | .IX Header "SEE ALSO" |
680 | .IX Header "SEE ALSO" |
540 | \&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). |
681 | \&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). |
541 | .SH "AUTHOR" |
682 | .SH "AUTHOR" |
542 | .IX Header "AUTHOR" |
683 | .IX Header "AUTHOR" |
543 | Marc Lehmann <gvpe@plan9.de> |
684 | Marc Lehmann <gvpe@schmorp.de> |