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.13 by pcg, Wed Mar 23 21:55:39 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-23" "1.9" "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"
… …
245get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport 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 246will resend the request when no reply has been received for longer than
247eight times the minimum (= expected) latency, assuming the request or 247eight times the minimum (= expected) latency, assuming the request or
248reply has been lost. 248reply has been lost.
249.Sp 249.Sp
250For congested links a higher value might be necessary (e.g. \f(CW30\fR). If the 250For congested links a higher value might be necessary (e.g. \f(CW30\fR). If
251link is very stable lower values (e.g. \f(CW2\fR) might work nicely. Values 251the link is very stable lower values (e.g. \f(CW2\fR) might work
252near or below \f(CW1\fR makes no sense whatsoever. 252nicely. Values near or below \f(CW1\fR makes no sense whatsoever.
253.Sp 253.Sp
254The default should be working ok for most links. 254The default should be working ok for most links but will result in low
255throughput if packet loss is high.
255.IP "if-up = relative-or-absolute-path" 4 256.IP "if-up = relative-or-absolute-path" 4
256.IX Item "if-up = relative-or-absolute-path" 257.IX Item "if-up = relative-or-absolute-path"
257Sets 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
258network interface is initialized (but not neccessarily up). The following 259network interface is initialized (but not neccessarily up). The following
259environment 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:
260.RS 4 263.RS 4
261.IP "CONFBASE=/etc/gvpe" 4 264.IP "CONFBASE=/etc/gvpe" 4
262.IX Item "CONFBASE=/etc/gvpe" 265.IX Item "CONFBASE=/etc/gvpe"
263The configuration base directory. 266The configuration base directory.
264.IP "IFNAME=vpn0" 4 267.IP "IFNAME=vpn0" 4
265.IX Item "IFNAME=vpn0" 268.IX Item "IFNAME=vpn0"
266The interface to initialize. 269The network interface to initialize.
267.IP "MTU=1436" 4
268.IX Item "MTU=1436"
269The \s-1MTU\s0 to set the interface to. You can use lower values (if done
270consistently on all hosts), but this is usually ineffective.
271.IP "MAC=fe:fd:80:00:00:01" 4
272.IX Item "MAC=fe:fd:80:00:00:01"
273The \s-1MAC\s0 address to set the interface to. The script *must* set the
274interface \s-1MAC\s0 to this value. You will most likely use one of these:
275.Sp
276.Vb 2
277\& ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux
278\& ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD
279.Ve
280.Sp
281Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for platform-specific information.
282.IP "IFTYPE=native # or tincd" 4 270.IP "IFTYPE=native # or tincd" 4
283.IX Item "IFTYPE=native # or tincd" 271.IX Item "IFTYPE=native # or tincd"
284.PD 0 272.PD 0
285.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 273.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4
286.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." 274.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.."
287.PD 275.PD
288The 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
289name 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
290the 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.
291.IP "NODENAME=branch1" 4 302.IP "NODENAME=branch1" 4
292.IX Item "NODENAME=branch1" 303.IX Item "NODENAME=branch1"
293The nickname of the current node, as passed to the gvpe daemon. 304The nickname of the node.
294.IP "NODEID=1" 4 305.IP "NODEID=1" 4
295.IX Item "NODEID=1" 306.IX Item "NODEID=1"
296The 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
297config 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.
298.RE 309.RE
299.RS 4 310.RS 4
300.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
301Here is a simple if-up script: 317Here is a simple if-up script:
302.Sp 318.Sp
303.Vb 5 319.Vb 5
304\& #!/bin/sh 320\& #!/bin/sh
305\& ip link set $IFNAME address $MAC mtu $MTU up 321\& ip link set $IFNAME up
306\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME 322\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
307\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME 323\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
308\& ip route add 10.0.0.0/8 dev $IFNAME 324\& ip route add 10.0.0.0/8 dev $IFNAME
309.Ve 325.Ve
310.Sp 326.Sp
… …
324the 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
325device. 341device.
326.IP "ip-proto = numerical-ip-protocol" 4 342.IP "ip-proto = numerical-ip-protocol" 4
327.IX Item "ip-proto = numerical-ip-protocol" 343.IX Item "ip-proto = numerical-ip-protocol"
328Sets 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
329global option because all hosts must use the same protocol, and since 345global option because all nodes must use the same protocol, and since
330there 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
331instance using the same protocol, nor can you share the protocol with 347instance using the same protocol, nor can you share the protocol with
332other programs. 348other programs.
333.Sp 349.Sp
334The 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
… …
348Please 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
349configuration 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
350server better use numerical \s-1IP\s0 addresses. 366server better use numerical \s-1IP\s0 addresses.
351.Sp 367.Sp
352To 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
353config 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
354on 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).
355.Sp 371.Sp
356If 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
357enabled on all hosts. 373enabled on all nodes.
358.Sp 374.Sp
359Example: 375Example:
360.Sp 376.Sp
361.Vb 3 377.Vb 3
362\& http-proxy-host = proxy.example.com 378\& http\-proxy\-host = proxy.example.com
363\& http-proxy-port = 3128 # 8080 is another common choice 379\& http\-proxy\-port = 3128 # 8080 is another common choice
364\& http-proxy-auth = schmorp:grumbeere 380\& http\-proxy\-auth = schmorp:grumbeere
365.Ve 381.Ve
366.IP "http-proxy-port = proxy-tcp-port" 4 382.IP "http-proxy-port = proxy-tcp-port" 4
367.IX Item "http-proxy-port = proxy-tcp-port" 383.IX Item "http-proxy-port = proxy-tcp-port"
368The port where your proxy server listens. 384The port where your proxy server listens.
369.IP "http-proxy-auth = login:password" 4 385.IP "http-proxy-auth = login:password" 4
… …
389maximum overhead (e.g. udp header size, encryption blocksize...) and pass 405maximum overhead (e.g. udp header size, encryption blocksize...) and pass
390this information to the \f(CW\*(C`if\-up\*(C'\fR script. 406this information to the \f(CW\*(C`if\-up\*(C'\fR script.
391.Sp 407.Sp
392Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). 408Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
393.Sp 409.Sp
394This 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.
395.IP "node = nickname" 4 411.IP "node = nickname" 4
396.IX Item "node = nickname" 412.IX Item "node = nickname"
397Not 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
398used 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
399argument to the gvpe daemon. 415argument to the gvpe daemon.
400.IP "node-up = relative-or-absolute-path" 4 416.IP "node-up = relative-or-absolute-path" 4
401.IX Item "node-up = relative-or-absolute-path" 417.IX Item "node-up = relative-or-absolute-path"
402Sets a command (default: no script) that should be called whenever a 418Sets a command (default: none) that should be called whenever a connection
403connection 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
404to 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
405variables will be set: 424environment variables will be set:
406.RS 4 425.RS 4
407.IP "DESTNODE=branch2" 4 426.IP "DESTNODE=branch2" 4
408.IX Item "DESTNODE=branch2" 427.IX Item "DESTNODE=branch2"
409The name of the remote node. 428The name of the remote node.
410.IP "DESTID=2" 4 429.IP "DESTID=2" 4
411.IX Item "DESTID=2" 430.IX Item "DESTID=2"
412The node id of the remote node. 431The node id of the remote node.
413.IP "DESTIP=188.13.66.8" 4 432.IP "DESTIP=188.13.66.8" 4
414.IX Item "DESTIP=188.13.66.8" 433.IX Item "DESTIP=188.13.66.8"
415The 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
416everywhere, as long as the other host can authenticate itself). 435everywhere, as long as the other node can authenticate itself).
417.IP "DESTPORT=655 # deprecated" 4 436.IP "DESTPORT=655 # deprecated" 4
418.IX Item "DESTPORT=655 # deprecated" 437.IX Item "DESTPORT=655 # deprecated"
419The \s-1UDP\s0 port used by the other side. 438The \s-1UDP\s0 port used by the other side.
420.IP "STATE=UP" 4 439.IP "STATE=UP" 4
421.IX Item "STATE=UP" 440.IX Item "STATE=UP"
… …
431\& #!/bin/sh 450\& #!/bin/sh
432\& { 451\& {
433\& echo update delete $DESTNODE.lowttl.example.net. a 452\& echo update delete $DESTNODE.lowttl.example.net. a
434\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP 453\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
435\& echo 454\& echo
436\& } | nsupdate -d -k $CONFBASE:key.example.net. 455\& } | nsupdate \-d \-k $CONFBASE:key.example.net.
437.Ve 456.Ve
438.RE 457.RE
439.IP "node-down = relative-or-absolute-path" 4 458.IP "node-down = relative-or-absolute-path" 4
440.IX Item "node-down = relative-or-absolute-path" 459.IX Item "node-down = relative-or-absolute-path"
441Same 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.
… …
450be 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
451use 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
452\&\f(CW\*(C`gvpectrl\*(C'\fR puts them. 471\&\f(CW\*(C`gvpectrl\*(C'\fR puts them.
453.Sp 472.Sp
454Since 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
455private 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
456not recommended to use this feature. 475not recommended to use this feature.
457.IP "rekey = seconds" 4 476.IP "rekey = seconds" 4
458.IX Item "rekey = seconds" 477.IX Item "rekey = seconds"
459Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are 478Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are
460reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. 479reestablished every \f(CW\*(C`rekey\*(C'\fR seconds.
461.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 480.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
462.IX Subsection "NODE SPECIFIC SETTINGS" 481.IX Subsection "NODE SPECIFIC SETTINGS"
463The following settings are node\-specific, that is, every node can have 482The following settings are node\-specific, that is, every node can have
464different settings, even within the same gvpe instance. Settings that are 483different settings, even within the same gvpe instance. Settings that are
465executed before the first node section set the defaults, settings that are 484set before the first node section set the defaults, settings that are
466executed 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.
467.IP "compress = yes|true|on | no|false|off" 4 489.IP "compress = yes|true|on | no|false|off" 4
468.IX Item "compress = yes|true|on | no|false|off" 490.IX Item "compress = yes|true|on | no|false|off"
469Wether 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).
470Compression is really cheap even on slow computers and has no size 492Compression is really cheap even on slow computers and has no size
471overhead at all, so enabling this is a good idea. 493overhead at all, so enabling this is a good idea.
472.IP "connect = ondemand | never | always | disabled" 4 494.IP "connect = ondemand | never | always | disabled" 4
473.IX Item "connect = ondemand | never | always | disabled" 495.IX Item "connect = ondemand | never | always | disabled"
474Sets 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
475try 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
476(never initiate a connection to the given host, but accept connections), 498(never initiate a connection to the given host, but accept connections),
477\&\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
478take 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
479don'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.
480.IP "dns-domain = domain-suffix" 4 531.IP "dns-domain = domain-suffix" 4
481.IX Item "dns-domain = domain-suffix" 532.IX Item "dns-domain = domain-suffix"
482The \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.
483.Sp 534.Sp
484The 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,
485i.e. 536i.e.
486.Sp 537.Sp
487.Vb 2 538.Vb 2
488\& dns-domainname = tunnel.example.net 539\& dns\-domainname = tunnel.example.net
489\& dns-hostname = tunnel-server.example.net 540\& dns\-hostname = tunnel\-server.example.net
490.Ve 541.Ve
491.Sp 542.Sp
492Corresponds 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:
493.Sp 544.Sp
494.Vb 2 545.Vb 2
495\& tunnel.example.net. NS tunnel-server.example.net. 546\& tunnel.example.net. NS tunnel\-server.example.net.
496\& tunnel-server.example.net. A 13.13.13.13 547\& tunnel\-server.example.net. A 13.13.13.13
497.Ve 548.Ve
498.IP "dns-hostname = hostname/ip" 4 549.IP "dns-hostname = hostname/ip" 4
499.IX Item "dns-hostname = hostname/ip" 550.IX Item "dns-hostname = hostname/ip"
500The 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,
501but 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
… …
539protocol is enabled automatically). 590protocol is enabled automatically).
540.Sp 591.Sp
541\&\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
542it might get switched on automatically, as some future version might 593it might get switched on automatically, as some future version might
543default 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.
544.IP "icmp-type = integer" 4 602.IP "icmp-type = integer" 4
545.IX Item "icmp-type = integer" 603.IX Item "icmp-type = integer"
546Sets 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
547via the \s-1ICMP\s0 transport. 605via the \s-1ICMP\s0 transport.
548.Sp 606.Sp
549The 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
550\&\*(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.
551\&\*(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.
552.IP "inherit-tos = yes|true|on | no|false|off" 4 614.IP "inherit-tos = yes|true|on | no|false|off" 4
553.IX Item "inherit-tos = yes|true|on | no|false|off" 615.IX Item "inherit-tos = yes|true|on | no|false|off"
554Wether 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
555sending 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
556outgoing 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
… …
561retries to establish a connection to this node. When a connection cannot 623retries to establish a connection to this node. When a connection cannot
562be established, gvpe uses exponential backoff capped at this value. It's 624be established, gvpe uses exponential backoff capped at this value. It's
563sometimes 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
564connections to routers that usually are stable but sometimes are down, to 626connections to routers that usually are stable but sometimes are down, to
565assure 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.
566.IP "router-priority = 0 | 1 | positive\-number>=2" 4 640.IP "router-priority = 0 | 1 | positive\-number>=2" 4
567.IX Item "router-priority = 0 | 1 | positive-number>=2" 641.IX Item "router-priority = 0 | 1 | positive-number>=2"
568Sets 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).
569some host tries to connect to another host without a hostname, it asks
570the router host for it's \s-1IP\s0 address. The router host is the one with the
571highest priority larger than \f(CW1\fR that is currently reachable.
572.Sp 643.Sp
573Make 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
574hosts, 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.
575.Sp 653.Sp
576The 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
577host, 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
578disables 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
579required, 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
580local 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
581\&\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"
582not 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).
583.IP "tcp-port = port-number" 4 667.IP "tcp-port = port-number" 4
584.IX Item "tcp-port = port-number" 668.IX Item "tcp-port = port-number"
585Similar 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.
586.IP "udp-port = port-number" 4 670.IP "udp-port = port-number" 4
587.IX Item "udp-port = port-number" 671.IX Item "udp-port = port-number"
… …
608.SH "SEE ALSO" 692.SH "SEE ALSO"
609.IX Header "SEE ALSO" 693.IX Header "SEE ALSO"
610\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). 694\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).
611.SH "AUTHOR" 695.SH "AUTHOR"
612.IX Header "AUTHOR" 696.IX Header "AUTHOR"
613Marc Lehmann <gvpe@plan9.de> 697Marc Lehmann <gvpe@schmorp.de>

Diff Legend

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