ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/gvpe/doc/gvpe.conf.5
(Generate patch)

Comparing gvpe/doc/gvpe.conf.5 (file contents):
Revision 1.11 by pcg, Thu Mar 17 23:59:37 2005 UTC vs.
Revision 1.21 by pcg, Sun Aug 10 22:18:58 2008 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
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
… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "GVPE.CONF 5" 131.IX Title "GVPE.CONF 5"
132.TH GVPE.CONF 5 "2005-03-17" "1.8" "GNU Virtual Private Ethernet" 132.TH GVPE.CONF 5 "2008-08-10" "2.2" "GNU Virtual Private Ethernet"
133.SH "NAME" 133.SH "NAME"
134gvpe.conf \- configuration file for the GNU VPE daemon 134gvpe.conf \- configuration file for the GNU VPE daemon
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 3 137.Vb 3
138\& udp-port = 407 138\& udp\-port = 407
139\& mtu = 1492 139\& mtu = 1492
140\& ifname = vpn0 140\& ifname = vpn0
141.Ve 141.Ve
142.PP 142.PP
143.Vb 2 143.Vb 2
… …
146.Ve 146.Ve
147.PP 147.PP
148.Vb 3 148.Vb 3
149\& node = branch2 149\& node = branch2
150\& hostname = www.example.net 150\& hostname = www.example.net
151\& udp-port = 500 # this host uses a different udp-port 151\& udp\-port = 500 # this host uses a different udp\-port
152.Ve 152.Ve
153.PP 153.PP
154.Vb 2 154.Vb 2
155\& node = branch3 155\& node = branch3
156\& connect = ondemand 156\& connect = ondemand
… …
158.SH "DESCRIPTION" 158.SH "DESCRIPTION"
159.IX Header "DESCRIPTION" 159.IX Header "DESCRIPTION"
160The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable 160The 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 161= value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and
162extend to the end of the line. They can be used on their own lines, or 162extend to the end of the line. They can be used on their own lines, or
163after any directives. Spaces are allowed before or after the \f(CW\*(C`=\*(C'\fR sign or 163after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after
164after values, but not within the variable names or values themselves. 164values, but not within the variable names or values themselves.
165.PP 165.PP
166The only exception to the above is the \*(L"on\*(R" directive that can prefix any 166The 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 167\&\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. 168(if the nodename starts with \*(L"!\*(R") on all nodes except the named one.
169.PP 169.PP
… …
181listen on), followed by node-specific sections that begin with a \f(CW\*(C`node = 181listen on), followed by node-specific sections that begin with a \f(CW\*(C`node =
182nickname\*(C'\fR line. 182nickname\*(C'\fR line.
183.PP 183.PP
184Every node that is part of the network must have a section that starts 184Every node that is part of the network must have a section that starts
185with \f(CW\*(C`node = nickname\*(C'\fR. The number and order of the nodes is important 185with \f(CW\*(C`node = nickname\*(C'\fR. The number and order of the nodes is important
186and must be the same on all hosts. It is not uncommon for node sections to 186and must be the same on all nodes. It is not uncommon for node sections to
187be completely empty \- if the default values are right. 187be completely empty \- if the default values are right.
188.PP 188.PP
189Node-specific settings can be used at any time. If used before the first 189Node-specific settings can be used at any time. If used before the first
190node section they will set the default values for all following nodes. 190node section they will set the default values for all following nodes.
191.SH "CONFIG VARIABLES" 191.SH "CONFIG VARIABLES"
… …
202(default: \f(CW127.0.0.1\fR, changing it is highly recommended). 202(default: \f(CW127.0.0.1\fR, changing it is highly recommended).
203.IP "dns-forw-port = port-number" 4 203.IP "dns-forw-port = port-number" 4
204.IX Item "dns-forw-port = port-number" 204.IX Item "dns-forw-port = port-number"
205The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR, 205The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR,
206which is fine in most cases). 206which is fine in most cases).
207.IP "dns-max-outstanding = integer-number-of-requests" 4
208.IX Item "dns-max-outstanding = integer-number-of-requests"
209The maximum number of outstanding \s-1DNS\s0 transport requests
210(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given
211limit without receiving replies. In heavily overloaded situations it might
212help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the
213number of parallel requests.
214.Sp
215The default should be working ok for most links.
216.IP "dns-overlap-factor = float" 4
217.IX Item "dns-overlap-factor = float"
218The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen
219during a connection as it's timing base. This factor (default: \f(CW0.5\fR,
220must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending
221rate (= minimum send interval), i.e. a factor of \f(CW1\fR means that a new
222request might be generated every \fBmin_latency\fR seconds, which means on
223average there should only ever be one outstanding request. A factor of
224\&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum
225latency measured.
226.Sp
227For congested or picky dns forwarders you could use a value nearer to or
228exceeding \f(CW1\fR.
229.Sp
230The default should be working ok for most links.
231.IP "dns-send-interval = send-interval-in-seconds" 4
232.IX Item "dns-send-interval = send-interval-in-seconds"
233The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will
234use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when
235the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will
236not send more than 100 \s-1DNS\s0 requests per connection per second. For
237high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For
238congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR,
239\&\f(CW0.2\fR or even higher.
240.Sp
241The default should be working ok for most links.
242.IP "dns-timeout-factor = float" 4
243.IX Item "dns-timeout-factor = float"
244Factor to multiply the \f(CW\*(C`min_latency\*(C'\fR (see \f(CW\*(C`dns\-overlap\-factor\*(C'\fR) by to
245get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport
246will resend the request when no reply has been received for longer than
247eight times the minimum (= expected) latency, assuming the request or
248reply has been lost.
249.Sp
250For congested links a higher value might be necessary (e.g. \f(CW30\fR). If
251the link is very stable lower values (e.g. \f(CW2\fR) might work
252nicely. Values near or below \f(CW1\fR makes no sense whatsoever.
253.Sp
254The default should be working ok for most links but will result in low
255throughput if packet loss is high.
207.IP "if-up = relative-or-absolute-path" 4 256.IP "if-up = relative-or-absolute-path" 4
208.IX Item "if-up = relative-or-absolute-path" 257.IX Item "if-up = relative-or-absolute-path"
209Sets the path of a script that should be called immediately after the 258Sets the path of a script that should be called immediately after the
210network interface is initialized (but not neccessarily up). The following 259network interface is initialized (but not neccessarily up). The following
211environment variables are passed to it (the values are just examples): 260environment variables are passed to it (the values are just examples).
261.Sp
262Variables that have the same value on all nodes:
212.RS 4 263.RS 4
213.IP "CONFBASE=/etc/gvpe" 4 264.IP "CONFBASE=/etc/gvpe" 4
214.IX Item "CONFBASE=/etc/gvpe" 265.IX Item "CONFBASE=/etc/gvpe"
215The configuration base directory. 266The configuration base directory.
216.IP "IFNAME=vpn0" 4 267.IP "IFNAME=vpn0" 4
217.IX Item "IFNAME=vpn0" 268.IX Item "IFNAME=vpn0"
218The interface to initialize. 269The network interface to initialize.
219.IP "MTU=1436" 4
220.IX Item "MTU=1436"
221The \s-1MTU\s0 to set the interface to. You can use lower values (if done
222consistently 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"
225The \s-1MAC\s0 address to set the interface to. The script *must* set the
226interface \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
233Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for platform-specific information.
234.IP "IFTYPE=native # or tincd" 4 270.IP "IFTYPE=native # or tincd" 4
235.IX Item "IFTYPE=native # or tincd" 271.IX Item "IFTYPE=native # or tincd"
236.PD 0 272.PD 0
237.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 273.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4
238.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." 274.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.."
239.PD 275.PD
240The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os 276The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the
241name in lowercase) that this gvpe was configured for. Can be used to select 277\&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to
242the correct syntax to use for network-related commands. 278select the correct syntax to use for network-related commands.
279.IP "MTU=1436" 4
280.IX Item "MTU=1436"
281The \s-1MTU\s0 to set the interface to. You can use lower values (if done
282consistently on all nodes), but this is usually either inefficient or
283simply ineffective.
284.IP "NODES=5" 4
285.IX Item "NODES=5"
286The number of nodes in this \s-1GVPE\s0 network.
287.RE
288.RS 4
289.Sp
290Variables that are node-specific and with values pertaining to the node
291running this \s-1GVPE:\s0
292.IP "IFUPDATA=string" 4
293.IX Item "IFUPDATA=string"
294The 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"
297The \s-1MAC\s0 address the network interface has to use.
298.Sp
299Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not
300do this automatically. Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for
301platform-specific information.
243.IP "NODENAME=branch1" 4 302.IP "NODENAME=branch1" 4
244.IX Item "NODENAME=branch1" 303.IX Item "NODENAME=branch1"
245The nickname of the current node, as passed to the gvpe daemon. 304The nickname of the node.
246.IP "NODEID=1" 4 305.IP "NODEID=1" 4
247.IX Item "NODEID=1" 306.IX Item "NODEID=1"
248The numerical node id of the current node. The first node mentioned in the 307The numerical node \s-1ID\s0 of the node running this instance of \s-1GVPE\s0. The first
249config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on. 308node 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
312In addition, all node-specific variables (except \f(CW\*(C`NODEID\*(C'\fR) will be
313available with a postfix of \f(CW\*(C`_nodeid\*(C'\fR, which contains the value for that
314node, e.g. the \f(CW\*(C`MAC_1\*(C'\fR variable contains the \s-1MAC\s0 address of node #1, while
315the \f(CW\*(C`NODENAME_22\*(C'\fR variable contains the name of node #22.
316.Sp
253Here is a simple if-up script: 317Here 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
… …
276the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the 340the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the
277device. 341device.
278.IP "ip-proto = numerical-ip-protocol" 4 342.IP "ip-proto = numerical-ip-protocol" 4
279.IX Item "ip-proto = numerical-ip-protocol" 343.IX Item "ip-proto = numerical-ip-protocol"
280Sets the protocol number to be used for the rawip protocol. This is a 344Sets the protocol number to be used for the rawip protocol. This is a
281global option because all hosts must use the same protocol, and since 345global option because all nodes must use the same protocol, and since
282there are no port numbers, you cannot easily run more than one gvpe 346there are no port numbers, you cannot easily run more than one gvpe
283instance using the same protocol, nor can you share the protocol with 347instance using the same protocol, nor can you share the protocol with
284other programs. 348other programs.
285.Sp 349.Sp
286The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through 350The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through
… …
300Please note that gvpe will still try to resolve all hostnames in the 364Please note that gvpe will still try to resolve all hostnames in the
301configuration file, so if you are behind a proxy without access to a dns 365configuration file, so if you are behind a proxy without access to a dns
302server better use numerical \s-1IP\s0 addresses. 366server better use numerical \s-1IP\s0 addresses.
303.Sp 367.Sp
304To make best use of this option disable all protocols except tcp in your 368To make best use of this option disable all protocols except tcp in your
305config file and make sure your routers (or all other hosts) are listening 369config file and make sure your routers (or all other nodes) are listening
306on a port that the proxy allows (443, https, is a common choice). 370on a port that the proxy allows (443, https, is a common choice).
307.Sp 371.Sp
308If you have a router, connecting to it will suffice. Otherwise tcp must be 372If you have a router, connecting to it will suffice. Otherwise tcp must be
309enabled on all hosts. 373enabled on all nodes.
310.Sp 374.Sp
311Example: 375Example:
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"
320The port where your proxy server listens. 384The port where your proxy server listens.
321.IP "http-proxy-auth = login:password" 4 385.IP "http-proxy-auth = login:password" 4
… …
341maximum overhead (e.g. udp header size, encryption blocksize...) and pass 405maximum overhead (e.g. udp header size, encryption blocksize...) and pass
342this information to the \f(CW\*(C`if\-up\*(C'\fR script. 406this information to the \f(CW\*(C`if\-up\*(C'\fR script.
343.Sp 407.Sp
344Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). 408Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
345.Sp 409.Sp
346This value must be the minimum of the mtu values of all hosts. 410This value must be the minimum of the mtu values of all nodes.
347.IP "node = nickname" 4 411.IP "node = nickname" 4
348.IX Item "node = nickname" 412.IX Item "node = nickname"
349Not really a config setting but introduces a node section. The nickname is 413Not really a config setting but introduces a node section. The nickname is
350used to select the right configuration section and must be passed as an 414used to select the right configuration section and must be passed as an
351argument to the gvpe daemon. 415argument 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"
354Sets a command (default: no script) that should be called whenever a 418Sets a command (default: none) that should be called whenever a connection
355connection is established (even on rekeying operations). In addition 419is established (even on rekeying operations). Note that node\-up/down
420scripts will be run asynchronously, but execution is serialised, so there
421will only ever be one such script running.
422.Sp
356to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment 423In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following
357variables will be set: 424environment 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"
361The name of the remote node. 428The name of the remote node.
362.IP "DESTID=2" 4 429.IP "DESTID=2" 4
363.IX Item "DESTID=2" 430.IX Item "DESTID=2"
364The node id of the remote node. 431The node id of the remote node.
365.IP "DESTIP=188.13.66.8" 4 432.IP "DESTIP=188.13.66.8" 4
366.IX Item "DESTIP=188.13.66.8" 433.IX Item "DESTIP=188.13.66.8"
367The numerical \s-1IP\s0 address of the remote host (gvpe accepts connections from 434The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from
368everywhere, as long as the other host can authenticate itself). 435everywhere, as long as the other node can authenticate itself).
369.IP "DESTPORT=655 # deprecated" 4 436.IP "DESTPORT=655 # deprecated" 4
370.IX Item "DESTPORT=655 # deprecated" 437.IX Item "DESTPORT=655 # deprecated"
371The \s-1UDP\s0 port used by the other side. 438The \s-1UDP\s0 port used by the other side.
372.IP "STATE=UP" 4 439.IP "STATE=UP" 4
373.IX Item "STATE=UP" 440.IX Item "STATE=UP"
… …
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"
393Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. 460Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost.
… …
402be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could 469be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could
403use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where 470use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where
404\&\f(CW\*(C`gvpectrl\*(C'\fR puts them. 471\&\f(CW\*(C`gvpectrl\*(C'\fR puts them.
405.Sp 472.Sp
406Since only the private key file of the current node is used and the 473Since only the private key file of the current node is used and the
407private key file should be kept secret per-host to avoid spoofings, it is 474private key file should be kept secret per-node to avoid spoofings, it is
408not recommended to use this feature. 475not recommended to use this feature.
409.IP "rekey = seconds" 4 476.IP "rekey = seconds" 4
410.IX Item "rekey = seconds" 477.IX Item "rekey = seconds"
411Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are 478Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are
412reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. 479reestablished 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"
415The following settings are node\-specific, that is, every node can have 482The following settings are node\-specific, that is, every node can have
416different settings, even within the same gvpe instance. Settings that are 483different settings, even within the same gvpe instance. Settings that are
417executed before the first node section set the defaults, settings that are 484set before the first node section set the defaults, settings that are
418executed within a node section only apply to the given node. 485set within a node section only apply to the given node.
486.IP "allow-direct = nodename" 4
487.IX Item "allow-direct = nodename"
488Allow 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"
421Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). 491Wether to compress data packets sent to this node (default: \f(CW\*(C`yes\*(C'\fR).
422Compression is really cheap even on slow computers and has no size 492Compression is really cheap even on slow computers and has no size
423overhead at all, so enabling this is a good idea. 493overhead 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"
426Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always 496Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always
427try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR 497try to establish and keep a connection to the given node), \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
430take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, 500packets in the queue and take it down after the keepalive interval) or
431don't talk to it). 501\&\f(CW\*(C`disabled\*(C'\fR (node is bad, don't talk to it).
502.Sp
503Routers will automatically be forced to \f(CW\*(C`always\*(C'\fR unless they are
504\&\f(CW\*(C`disabled\*(C'\fR, to ensure all nodes can talk to each other.
505.IP "deny-direct = nodename | *" 4
506.IX Item "deny-direct = nodename | *"
507Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR
508is given). Only one node can be specified, but you can use multiple
509\&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in
510networks with routers, as routers are required for indirect connections.
511.Sp
512Sometimes, a node cannot reach some other nodes for reasons of network
513connectivity. For example, a node behind a firewall that only allows
514conenctions to/from a single other node in the network. In this case one
515should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other
516node \fImust\fR be a router for this to work).
517.Sp
518The algorithm to check wether a connection may be direct is as follows:
519.Sp
5201. Other node mentioned in a \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection.
521.Sp
5222. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections.
523.Sp
5243. Allow the connection.
525.Sp
526That is, \f(CW\*(C`allow\-direct\*(C'\fR takes precedence over \f(CW\*(C`deny\-direct\*(C'\fR.
527.Sp
528The check is done in both directions, i.e. both nodes must allow a direct
529connection before one is attempted, so you only need to specify connect
530limitations on one node.
432.IP "dns-domain = domain-suffix" 4 531.IP "dns-domain = domain-suffix" 4
433.IX Item "dns-domain = domain-suffix" 532.IX Item "dns-domain = domain-suffix"
434The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node. 533The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node.
435.Sp 534.Sp
436The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, 535The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR,
437i.e. 536i.e.
438.Sp 537.Sp
439.Vb 2 538.Vb 2
440\& dns-domainname = tunnel.example.net 539\& dns\-domainname = tunnel.example.net
441\& dns-hostname = tunnel-server.example.net 540\& dns\-hostname = tunnel\-server.example.net
442.Ve 541.Ve
443.Sp 542.Sp
444Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain: 543Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain:
445.Sp 544.Sp
446.Vb 2 545.Vb 2
447\& tunnel.example.net. NS tunnel-server.example.net. 546\& tunnel.example.net. NS tunnel\-server.example.net.
448\& tunnel-server.example.net. A 13.13.13.13 547\& tunnel\-server.example.net. A 13.13.13.13
449.Ve 548.Ve
450.IP "dns-hostname = hostname/ip" 4 549.IP "dns-hostname = hostname/ip" 4
451.IX Item "dns-hostname = hostname/ip" 550.IX Item "dns-hostname = hostname/ip"
452The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR, 551The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR,
453but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might 552but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might
… …
491protocol is enabled automatically). 590protocol is enabled automatically).
492.Sp 591.Sp
493\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though 592\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though
494it might get switched on automatically, as some future version might 593it might get switched on automatically, as some future version might
495default to another default protocol. 594default to another default protocol.
595.IP "hostname = hostname | ip [can not be defaulted]" 4
596.IX Item "hostname = hostname | ip [can not be defaulted]"
597Forces the address of this node to be set to the given dns hostname or ip
598address. It will be resolved before each connect request, so dyndns should
599work fine. If this setting is not specified and a router is available,
600then the router will be queried for the address of this node. Otherwise,
601the connection attempt will fail.
496.IP "icmp-type = integer" 4 602.IP "icmp-type = integer" 4
497.IX Item "icmp-type = integer" 603.IX Item "icmp-type = integer"
498Sets the type value to be used for outgoing (and incoming) packets sent 604Sets the type value to be used for outgoing (and incoming) packets sent
499via the \s-1ICMP\s0 transport. 605via the \s-1ICMP\s0 transport.
500.Sp 606.Sp
501The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as 607The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as
502\&\*(L"ping\-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. 608\&\*(L"ping\-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a.
503\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. 609\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used.
610.IP "if-up-data = value" 4
611.IX Item "if-up-data = value"
612The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR
613script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR.
504.IP "inherit-tos = yes|true|on | no|false|off" 4 614.IP "inherit-tos = yes|true|on | no|false|off" 4
505.IX Item "inherit-tos = yes|true|on | no|false|off" 615.IX Item "inherit-tos = yes|true|on | no|false|off"
506Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when 616Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when
507sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then 617sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then
508outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent 618outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
… …
513retries to establish a connection to this node. When a connection cannot 623retries to establish a connection to this node. When a connection cannot
514be established, gvpe uses exponential backoff capped at this value. It's 624be established, gvpe uses exponential backoff capped at this value. It's
515sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on 625sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on
516connections to routers that usually are stable but sometimes are down, to 626connections to routers that usually are stable but sometimes are down, to
517assure quick reconnections even after longer downtimes. 627assure quick reconnections even after longer downtimes.
628.IP "max-ttl = seconds" 4
629.IX Item "max-ttl = seconds"
630Expire packets that couldn't be sent after this many seconds
631(default: \f(CW60\fR). Gvpe will normally queue packets for a node without an
632active connection, in the hope of establishing a connection soon. This
633value specifies the maximum lifetime a packet will stay in the queue, if a
634packet gets older, it will be thrown away.
635.IP "max-queue = positive\-number>=1" 4
636.IX Item "max-queue = positive-number>=1"
637The maximum number of packets that will be queued (default: \f(CW512\fR)
638for this node. If more packets are sent then earlier packets will be
639expired. See \f(CW\*(C`max\-ttl\*(C'\fR, above.
518.IP "router-priority = 0 | 1 | positive\-number>=2" 4 640.IP "router-priority = 0 | 1 | positive\-number>=2" 4
519.IX Item "router-priority = 0 | 1 | positive-number>=2" 641.IX Item "router-priority = 0 | 1 | positive-number>=2"
520Sets the router priority of the given host (default: \f(CW0\fR, disabled). If 642Sets the router priority of the given node (default: \f(CW0\fR, disabled).
521some host tries to connect to another host without a hostname, it asks
522the router host for it's \s-1IP\s0 address. The router host is the one with the
523highest priority larger than \f(CW1\fR that is currently reachable.
524.Sp 643.Sp
525Make sure all hosts always connect (\f(CW\*(C`connect = always\*(C'\fR) to the router 644If some node tries to connect to another node but it doesn't have a
526hosts, otherwise connecting to them might be impossible. 645hostname, it asks a router node for it's \s-1IP\s0 address. The router node
646chosen is the one with the highest priority larger than \f(CW1\fR that is
647currently reachable. This is called a \fImediated\fR connection, as the
648connection itself will still be direct, but it uses another node to
649mediate between the two nodes.
650.Sp
651The value \f(CW0\fR disables routing, that means if the node receives a packet
652not for itself it will not forward it but instead drop it.
527.Sp 653.Sp
528The special value \f(CW1\fR allows other hosts to route through the router 654The special value \f(CW1\fR allows other hosts to route through the router
529host, but they will never route through it by default. The value \f(CW0\fR 655host, but they will never route through it by default (i.e. the config
530disables routing. The idea behind this is that some hosts can, if 656file of another node needs to specify a router priority higher than one
657to choose such a node for routing).
658.Sp
659The idea behind this is that some hosts can, if required, bump the
531required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their 660\&\f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their local config to
532local config to route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is 661route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is \f(CW0\fR, then routing
533\&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do 662will be refused, so \f(CW1\fR serves as a \*(L"enable, but do not use by default\*(R"
534not use by default\*(R" switch. 663switch.
664.Sp
665Nodes with \f(CW\*(C`router\-priority\*(C'\fR set to \f(CW2\fR or higher will always be forced
666to \f(CW\*(C`connect\*(C'\fR = \f(CW\*(C`always\*(C'\fR (unless they are \f(CW\*(C`disabled\*(C'\fR).
535.IP "tcp-port = port-number" 4 667.IP "tcp-port = port-number" 4
536.IX Item "tcp-port = port-number" 668.IX Item "tcp-port = port-number"
537Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. 669Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number.
538.IP "udp-port = port-number" 4 670.IP "udp-port = port-number" 4
539.IX Item "udp-port = port-number" 671.IX Item "udp-port = port-number"
… …
560.SH "SEE ALSO" 692.SH "SEE ALSO"
561.IX Header "SEE ALSO" 693.IX Header "SEE ALSO"
562\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). 694\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).
563.SH "AUTHOR" 695.SH "AUTHOR"
564.IX Header "AUTHOR" 696.IX Header "AUTHOR"
565Marc Lehmann <gvpe@plan9.de> 697Marc Lehmann <gvpe@schmorp.de>

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines