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.2 by pcg, Sun Jul 25 18:11:39 2004 UTC vs.
Revision 1.19 by pcg, Thu Mar 29 17:35:20 2007 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
… …
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 "2004-07-25" "1.7" "GNU Virtual Private Ethernet" 132.TH GVPE.CONF 5 "2007-01-31" "2.01" "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 4 137.Vb 3
138\& enable-udp = yes
139\& udp-port = 407 138\& udp-port = 407
140\& mtu = 1492 139\& mtu = 1492
141\& ifname = vpn0 140\& ifname = vpn0
142.Ve 141.Ve
143.PP 142.PP
… …
159.SH "DESCRIPTION" 158.SH "DESCRIPTION"
160.IX Header "DESCRIPTION" 159.IX Header "DESCRIPTION"
161The 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
162= 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
163extend 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
164after 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
165after values, but not within the variable names or values themselves. 164values, but not within the variable names or values themselves.
166.PP 165.PP
167The 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
168\&\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
169(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.
170.PP 169.PP
… …
195.IX Subsection "GLOBAL SETTINGS" 194.IX Subsection "GLOBAL SETTINGS"
196Global settings will affect the behaviour of the running gvpe daemon, that 195Global settings will affect the behaviour of the running gvpe daemon, that
197is, they are in some sense node-specific (config files can set different 196is, they are in some sense node-specific (config files can set different
198values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of 197values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of
199the gvpe daemon and all connections it creates. 198the gvpe daemon and all connections it creates.
200.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 199.IP "dns-forw-host = hostname/ip" 4
201.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" 200.IX Item "dns-forw-host = hostname/ip"
202Set the logging level. Connection established messages are logged at level 201The dns server to forward dns requests to for the \s-1DNS\s0 tunnel protocol
203\&\f(CW\*(C`info\*(C'\fR, notable errors are logged with \f(CW\*(C`error\*(C'\fR. Default is \f(CW\*(C`info\*(C'\fR. 202(default: \f(CW127.0.0.1\fR, changing it is highly recommended).
204.IP "node = nickname" 4 203.IP "dns-forw-port = port-number" 4
205.IX Item "node = nickname" 204.IX Item "dns-forw-port = port-number"
206Not really a config setting but introduces a node section. The nickname is 205The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR,
207used to select the right configuration section and must be passed as an 206which is fine in most cases).
208argument to the gvpe daemon. 207.IP "dns-max-outstanding = integer-number-of-requests" 4
209.IP "private-key = relative-path-to-key" 4 208.IX Item "dns-max-outstanding = integer-number-of-requests"
210.IX Item "private-key = relative-path-to-key" 209The maximum number of outstanding \s-1DNS\s0 transport requests
211Sets the path (relative to the config directory) to the private key 210(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given
212(default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must 211limit without receiving replies. In heavily overloaded situations it might
213be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could 212help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the
214use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where 213number of parallel requests.
215\&\f(CW\*(C`gvpectrl\*(C'\fR puts them.
216.Sp 214.Sp
217Since only the private key file of the current node is used and the 215The default should be working ok for most links.
218private key file should be kept secret per-host to avoid spoofings, it is 216.IP "dns-overlap-factor = float" 4
219not recommended to use this feature. 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.
256.IP "if-up = relative-or-absolute-path" 4
257.IX Item "if-up = relative-or-absolute-path"
258Sets the path of a script that should be called immediately after the
259network interface is initialized (but not neccessarily up). The following
260environment variables are passed to it (the values are just examples).
261.Sp
262Variables that have the same value on all nodes:
263.RS 4
264.IP "CONFBASE=/etc/gvpe" 4
265.IX Item "CONFBASE=/etc/gvpe"
266The configuration base directory.
267.IP "IFNAME=vpn0" 4
268.IX Item "IFNAME=vpn0"
269The network interface to initialize.
270.IP "IFTYPE=native # or tincd" 4
271.IX Item "IFTYPE=native # or tincd"
272.PD 0
273.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4
274.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.."
275.PD
276The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the
277\&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to
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 hosts), but this is usually ineffective.
283.IP "NODES=5" 4
284.IX Item "NODES=5"
285The number of nodes in this \s-1GVPE\s0 network.
286.RE
287.RS 4
288.Sp
289Variables that are node-specific and with values pertaining to the node
290running this \s-1GVPE:\s0
291.IP "IFUPDATA=string" 4
292.IX Item "IFUPDATA=string"
293The value of the configuration directive \f(CW\*(C`if\-up\-data\*(C'\fR.
294.IP "MAC=fe:fd:80:00:00:01" 4
295.IX Item "MAC=fe:fd:80:00:00:01"
296The \s-1MAC\s0 address the network interface has to use.
297.Sp
298Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not
299do this automatically. Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for
300platform-specific information.
301.IP "NODENAME=branch1" 4
302.IX Item "NODENAME=branch1"
303The nickname of the node.
304.IP "NODEID=1" 4
305.IX Item "NODEID=1"
306The numerical node \s-1ID\s0 of the node running this instance of \s-1GVPE\s0. The first
307node mentioned in the config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on.
308.RE
309.RS 4
310.Sp
311In addition, all node-specific variables (except \f(CW\*(C`NODEID\*(C'\fR) will be
312available with a postfix of \f(CW\*(C`_nodeid\*(C'\fR, which contains the value for that
313node, e.g. the \f(CW\*(C`MAC_1\*(C'\fR variable contains the \s-1MAC\s0 address of node #1, while
314the \f(CW\*(C`NODENAME_22\*(C'\fR variable contains the name of node #22.
315.Sp
316Here is a simple if-up script:
317.Sp
318.Vb 5
319\& #!/bin/sh
320\& ip link set $IFNAME up
321\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
322\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
323\& ip route add 10.0.0.0/8 dev $IFNAME
324.Ve
325.Sp
326More complicated examples (using routing to reduce arp traffic) can be
327found in the etc/ subdirectory of the distribution.
328.RE
329.IP "ifname = devname" 4
330.IX Item "ifname = devname"
331Sets the tun interface name to the given name. The default is OS-specific
332and most probably something like \f(CW\*(C`tun0\*(C'\fR.
220.IP "ifpersist = yes|true|on | no|false|off" 4 333.IP "ifpersist = yes|true|on | no|false|off" 4
221.IX Item "ifpersist = yes|true|on | no|false|off" 334.IX Item "ifpersist = yes|true|on | no|false|off"
222Should the tun/tap device be made persistent, that is, should the device 335Should the tun/tap device be made persistent, that is, should the device
223stay up even when gvpe exits? Some versions of the tunnel device have 336stay up even when gvpe exits? Some versions of the tunnel device have
224problems sending packets when gvpe is restarted in persistent mode, so 337problems sending packets when gvpe is restarted in persistent mode, so
225if the connections can be established but you cannot send packets from 338if the connections can be established but you cannot send packets from
226the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the 339the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the
227device. 340device.
228.IP "ifname = devname" 4 341.IP "ip-proto = numerical-ip-protocol" 4
229.IX Item "ifname = devname" 342.IX Item "ip-proto = numerical-ip-protocol"
230Sets the tun interface name to the given name. The default is OS-specific 343Sets the protocol number to be used for the rawip protocol. This is a
231and most probably something like \f(CW\*(C`tun0\*(C'\fR. 344global option because all hosts must use the same protocol, and since
232.IP "rekey = seconds" 4 345there are no port numbers, you cannot easily run more than one gvpe
233.IX Item "rekey = seconds" 346instance using the same protocol, nor can you share the protocol with
234Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are 347other programs.
235reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. 348.Sp
349The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through
350firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other
351common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98
352(\s-1ENCAP\s0, rfc1241)
353.IP "http-proxy-host = hostname/ip" 4
354.IX Item "http-proxy-host = hostname/ip"
355The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was
356compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of
357tcp connections through a http proxy server.
358.Sp
359\&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and
360port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy
361requires authentication.
362.Sp
363Please note that gvpe will still try to resolve all hostnames in the
364configuration file, so if you are behind a proxy without access to a dns
365server better use numerical \s-1IP\s0 addresses.
366.Sp
367To make best use of this option disable all protocols except tcp in your
368config file and make sure your routers (or all other hosts) are listening
369on a port that the proxy allows (443, https, is a common choice).
370.Sp
371If you have a router, connecting to it will suffice. Otherwise tcp must be
372enabled on all hosts.
373.Sp
374Example:
375.Sp
376.Vb 3
377\& http-proxy-host = proxy.example.com
378\& http-proxy-port = 3128 # 8080 is another common choice
379\& http-proxy-auth = schmorp:grumbeere
380.Ve
381.IP "http-proxy-port = proxy-tcp-port" 4
382.IX Item "http-proxy-port = proxy-tcp-port"
383The port where your proxy server listens.
384.IP "http-proxy-auth = login:password" 4
385.IX Item "http-proxy-auth = login:password"
386The optional login and password used to authenticate to the proxy server,
387seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is
388currently supported.
236.IP "keepalive = seconds" 4 389.IP "keepalive = seconds" 4
237.IX Item "keepalive = seconds" 390.IX Item "keepalive = seconds"
238Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this 391Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this
239many seconds of inactivity the daemon will start to send keepalive probe 392many seconds of inactivity the daemon will start to send keepalive probe
240every 5 seconds until it receives a reply from the other end. If no reply 393every 5 seconds until it receives a reply from the other end. If no reply
241is received within 30 seconds, the peer is considered unreachable and the 394is received within 30 seconds, the peer is considered unreachable and the
242connection is closed. 395connection is closed.
396.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4
397.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical"
398Set the logging level. Connection established messages are logged at level
399\&\f(CW\*(C`info\*(C'\fR, notable errors are logged with \f(CW\*(C`error\*(C'\fR. Default is \f(CW\*(C`info\*(C'\fR.
243.IP "mtu = bytes" 4 400.IP "mtu = bytes" 4
244.IX Item "mtu = bytes" 401.IX Item "mtu = bytes"
245Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically 402Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically
246the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate 403the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate
247maximum overhead (e.g. udp header size, encryption blocksize...) and pass 404maximum overhead (e.g. udp header size, encryption blocksize...) and pass
248this information to the \f(CW\*(C`if\-up\*(C'\fR script. 405this information to the \f(CW\*(C`if\-up\*(C'\fR script.
249.Sp 406.Sp
250Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). 407Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
251.Sp 408.Sp
252This value must be the minimum of the mtu values of all hosts. 409This value must be the minimum of the mtu values of all hosts.
253.IP "ip-proto = numerical-ip-protocol" 4 410.IP "node = nickname" 4
254.IX Item "ip-proto = numerical-ip-protocol" 411.IX Item "node = nickname"
255Sets the protocol number to be used for the rawip protocol. This is a 412Not really a config setting but introduces a node section. The nickname is
256global option because all hosts must use the same protocol, and since 413used to select the right configuration section and must be passed as an
257there are no port numbers, you cannot easily run more than one gvpe 414argument to the gvpe daemon.
258instance using the same protocol, nor can you share the protocol with
259other programs.
260.Sp
261The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through
262firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other
263common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98
264(\s-1ENCAP\s0, rfc1241)
265.IP "if-up = relative-or-absolute-path" 4
266.IX Item "if-up = relative-or-absolute-path"
267Sets the path of a script that should be called immediately after the
268network interface is initialized (but not neccessarily up). The following
269environment variables are passed to it (the values are just examples):
270.RS 4
271.IP "CONFBASE=/etc/gvpe" 4
272.IX Item "CONFBASE=/etc/gvpe"
273The configuration base directory.
274.IP "IFNAME=vpn0" 4
275.IX Item "IFNAME=vpn0"
276The interface to initialize.
277.IP "MTU=1436" 4
278.IX Item "MTU=1436"
279The \s-1MTU\s0 to set the interface to. You can use lower values (if done
280consistently on all hosts), but this is usually ineffective.
281.IP "MAC=fe:fd:80:00:00:01" 4
282.IX Item "MAC=fe:fd:80:00:00:01"
283The \s-1MAC\s0 address to set the interface to. The script *must* set the
284interface \s-1MAC\s0 to this value. You will most likely use one of these:
285.Sp
286.Vb 2
287\& ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux
288\& ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD
289.Ve
290.Sp
291Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for platform-specific information.
292.IP "IFTYPE=native # or tincd" 4
293.IX Item "IFTYPE=native # or tincd"
294.PD 0
295.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4
296.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.."
297.PD
298The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os
299name in lowercase) that this gvpe was configured for. Can be used to select
300the correct syntax to use for network-related commands.
301.IP "NODENAME=branch1" 4
302.IX Item "NODENAME=branch1"
303The nickname of the current node, as passed to the gvpe daemon.
304.IP "NODEID=1" 4
305.IX Item "NODEID=1"
306The numerical node id of the current node. The first node mentioned in the
307config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on.
308.RE
309.RS 4
310.Sp
311Here is a simple if-up script:
312.Sp
313.Vb 5
314\& #!/bin/sh
315\& ip link set $IFNAME address $MAC mtu $MTU up
316\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
317\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
318\& ip route add 10.0.0.0/8 dev $IFNAME
319.Ve
320.Sp
321More complicated examples (using routing to reduce arp traffic) can be
322found in the etc/ subdirectory of the distribution.
323.RE
324.IP "node-up = relative-or-absolute-path" 4 415.IP "node-up = relative-or-absolute-path" 4
325.IX Item "node-up = relative-or-absolute-path" 416.IX Item "node-up = relative-or-absolute-path"
326Sets a command (default: no script) that should be called whenever a 417Sets a command (default: no script) that should be called whenever a
327connection is established (even on rekeying operations). In addition 418connection is established (even on rekeying operations). In addition to
328to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment 419all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment
329variables will be set: 420variables will be set:
330.RS 4 421.RS 4
331.IP "DESTNODE=branch2" 4 422.IP "DESTNODE=branch2" 4
332.IX Item "DESTNODE=branch2" 423.IX Item "DESTNODE=branch2"
333The name of the remote node. 424The name of the remote node.
… …
361.Ve 452.Ve
362.RE 453.RE
363.IP "node-down = relative-or-absolute-path" 4 454.IP "node-down = relative-or-absolute-path" 4
364.IX Item "node-down = relative-or-absolute-path" 455.IX Item "node-down = relative-or-absolute-path"
365Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. 456Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost.
366.IP "http-proxy-host = hostname/ip" 4
367.IX Item "http-proxy-host = hostname/ip"
368The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was
369compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of
370tcp connections through a http proxy server.
371.Sp
372\&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and
373port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy
374requires authentication.
375.Sp
376Please note that gvpe will still try to resolve all hostnames in the
377configuration file, so if you are behind a proxy without access to a dns
378server better use numerical \s-1IP\s0 addresses.
379.Sp
380To make best use of this option disable all protocols except tcp in your
381config file and make sure your routers (or all other hosts) are listening
382on a port that the proxy allows (443, https, is a common choice).
383.Sp
384If you have a router, connecting to it will suffice. Otherwise tcp must be
385enabled on all hosts.
386.Sp
387Example:
388.Sp
389.Vb 3
390\& http-proxy-host = proxy.example.com
391\& http-proxy-port = 3128 # 8080 is another common choice
392\& http-proxy-auth = schmorp:grumbeere
393.Ve
394.IP "http-proxy-port = proxy-tcp-port" 4
395.IX Item "http-proxy-port = proxy-tcp-port"
396The port where your proxy server listens.
397.IP "http-proxy-auth = login:password" 4
398.IX Item "http-proxy-auth = login:password"
399The optional login and password used to authenticate to the proxy server,
400seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is
401currently supported.
402.IP "pid-file = path" 4 457.IP "pid-file = path" 4
403.IX Item "pid-file = path" 458.IX Item "pid-file = path"
404The path to the pid file to check and create (Default: 459The path to the pid file to check and create
460(default: \f(CW\*(C`LOCALSTATEDIR/run/gvpe.pid\*(C'\fR).
461.IP "private-key = relative-path-to-key" 4
462.IX Item "private-key = relative-path-to-key"
463Sets the path (relative to the config directory) to the private key
464(default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must
465be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could
466use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where
467\&\f(CW\*(C`gvpectrl\*(C'\fR puts them.
468.Sp
469Since only the private key file of the current node is used and the
470private key file should be kept secret per-host to avoid spoofings, it is
471not recommended to use this feature.
472.IP "rekey = seconds" 4
473.IX Item "rekey = seconds"
474Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are
475reestablished every \f(CW\*(C`rekey\*(C'\fR seconds.
405.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 476.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
406.IX Subsection "NODE SPECIFIC SETTINGS" 477.IX Subsection "NODE SPECIFIC SETTINGS"
407The following settings are node\-specific, that is, every node can have 478The following settings are node\-specific, that is, every node can have
408different settings, even within the same gvpe instance. Settings that are 479different settings, even within the same gvpe instance. Settings that are
409executed before the first node section set the defaults, settings that are 480set before the first node section set the defaults, settings that are
410executed within a node section only apply to the given node. 481set within a node section only apply to the given node.
482.IP "allow-direct = nodename" 4
483.IX Item "allow-direct = nodename"
484Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info.
485.IP "compress = yes|true|on | no|false|off" 4
486.IX Item "compress = yes|true|on | no|false|off"
487Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR).
488Compression is really cheap even on slow computers and has no size
489overhead at all, so enabling this is a good idea.
490.IP "connect = ondemand | never | always | disabled" 4
491.IX Item "connect = ondemand | never | always | disabled"
492Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always
493try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR
494(never initiate a connection to the given host, but accept connections),
495\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and
496take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad,
497don't talk to it).
498.IP "deny-direct = nodename | *" 4
499.IX Item "deny-direct = nodename | *"
500Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR
501is given). Only one node can be specified, but you can use multiple
502\&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in
503networks with routers, as routers are required for indirect connections.
504.Sp
505Sometimes, a node cannot reach some other nodes for reasons of network
506connectivity. For example, a node behind a firewall that only allows
507conenctions to/from a single other node in the network. In this case one
508should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other
509node \fImust\fR be a router for this to work).
510.Sp
511The algorithm to check wether a connection may be direct is as follows:
512.Sp
5131. Other node mentioned in a \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection.
514.Sp
5152. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections.
516.Sp
5173. Allow the connection.
518.Sp
519That is, \f(CW\*(C`allow\-direct\*(C'\fR takes precedence over \f(CW\*(C`deny\-direct\*(C'\fR.
520.Sp
521The check is done in both directions, i.e. both nodes must allow a direct
522connection before one is attempted, so you only need to specify connect
523limitations on one node.
524.IP "dns-domain = domain-suffix" 4
525.IX Item "dns-domain = domain-suffix"
526The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node.
527.Sp
528The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR,
529i.e.
530.Sp
531.Vb 2
532\& dns-domainname = tunnel.example.net
533\& dns-hostname = tunnel-server.example.net
534.Ve
535.Sp
536Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain:
537.Sp
538.Vb 2
539\& tunnel.example.net. NS tunnel-server.example.net.
540\& tunnel-server.example.net. A 13.13.13.13
541.Ve
542.IP "dns-hostname = hostname/ip" 4
543.IX Item "dns-hostname = hostname/ip"
544The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR,
545but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might
546change.
411.IP "udp-port = port-number" 4 547.IP "dns-port = port-number" 4
412.IX Item "udp-port = port-number" 548.IX Item "dns-port = port-number"
413Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not 549The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers.
414officially assigned by \s-1IANA\s0!). 550.IP "enable-dns = yes|true|on | no|false|off" 4
415.IP "tcp-port = port-number" 4 551.IX Item "enable-dns = yes|true|on | no|false|off"
416.IX Item "tcp-port = port-number" 552See \fIgvpe.protocol\fR\|(7) for a description of the \s-1DNS\s0 transport
417Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. 553protocol. Avoid this protocol if you can.
554.Sp
555Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as
556client. Support for this transport protocol is only available when gvpe
557was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option.
558.IP "enable-icmp = yes|true|on | no|false|off" 4
559.IX Item "enable-icmp = yes|true|on | no|false|off"
560See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol.
561.Sp
562Enable the \s-1ICMP\s0 transport using icmp packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this
563node.
418.IP "enable-rawip = yes|true|on | no|false|off" 4 564.IP "enable-rawip = yes|true|on | no|false|off" 4
419.IX Item "enable-rawip = yes|true|on | no|false|off" 565.IX Item "enable-rawip = yes|true|on | no|false|off"
566See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol.
567.Sp
420Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol 568Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol
421(default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the overhead per packet 569(default: \f(CW\*(C`no\*(C'\fR).
422is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+). 570.IP "enable-tcp = yes|true|on | no|false|off" 4
571.IX Item "enable-tcp = yes|true|on | no|false|off"
572See \fIgvpe.protocol\fR\|(7) for a description of the \s-1TCP\s0 transport protocol.
573.Sp
574Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port
575(default: \f(CW\*(C`no\*(C'\fR). Support for this transport protocol is only available
576when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option.
423.IP "enable-udp = yes|true|on | no|false|off" 4 577.IP "enable-udp = yes|true|on | no|false|off" 4
424.IX Item "enable-udp = yes|true|on | no|false|off" 578.IX Item "enable-udp = yes|true|on | no|false|off"
579See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol.
580.Sp
425Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`yes\*(C'\fR, 581Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR,
426but this will change!). This is a good general choice since \s-1UDP\s0 tunnels 582unless no other protocol is enabled for a node, in which case this
427well through many firewalls. 583protocol is enabled automatically).
428.Sp 584.Sp
429\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR even though it is the default, as 585\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though
430some future version will have all protocols disabled by default. 586it might get switched on automatically, as some future version might
587default to another default protocol.
588.IP "hostname = hostname | ip [can not be defaulted]" 4
589.IX Item "hostname = hostname | ip [can not be defaulted]"
590Forces the address of this node to be set to the given dns hostname or ip
591address. It will be resolved before each connect request, so dyndns should
592work fine. If this setting is not specified and a router is available,
593then the router will be queried for the address of this node. Otherwise,
594the connection attempt will fail.
595.IP "icmp-type = integer" 4
596.IX Item "icmp-type = integer"
597Sets the type value to be used for outgoing (and incoming) packets sent
598via the \s-1ICMP\s0 transport.
599.Sp
600The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as
601\&\*(L"ping\-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a.
602\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used.
603.IP "if-up-data = value" 4
604.IX Item "if-up-data = value"
605The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR
606script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR.
431.IP "enable-tcp = yes|true|on | no|false|off" 4 607.IP "inherit-tos = yes|true|on | no|false|off" 4
432.IX Item "enable-tcp = yes|true|on | no|false|off" 608.IX Item "inherit-tos = yes|true|on | no|false|off"
433Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port 609Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when
434(default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only 610sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then
435available when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never 611outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
436use this transport unless you really must, it is horribly ineffiecent and 612to the tunnel device, which is usually what you want.
437resource-intensive compared to the other transports. 613.IP "max-retry = positive-number" 4
614.IX Item "max-retry = positive-number"
615The maximum interval in seconds (default: \f(CW3600\fR, one hour) between
616retries to establish a connection to this node. When a connection cannot
617be established, gvpe uses exponential backoff capped at this value. It's
618sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on
619connections to routers that usually are stable but sometimes are down, to
620assure quick reconnections even after longer downtimes.
438.IP "router-priority = 0 | 1 | positive\-number>2" 4 621.IP "router-priority = 0 | 1 | positive\-number>=2" 4
439.IX Item "router-priority = 0 | 1 | positive-number>2" 622.IX Item "router-priority = 0 | 1 | positive-number>=2"
440Sets the router priority of the given host (default: \f(CW0\fR, disabled). If 623Sets the router priority of the given host (default: \f(CW0\fR, disabled). If
441some host tries to connect to another host without a hostname, it asks 624some host tries to connect to another host without a hostname, it asks
442the router host for it's \s-1IP\s0 address. The router host is the one with the 625the router host for it's \s-1IP\s0 address. The router host is the one with the
443highest priority larger than \f(CW1\fR that is currently reachable. 626highest priority larger than \f(CW1\fR that is currently reachable.
444.Sp 627.Sp
… …
450disables routing. The idea behind this is that some hosts can, if 633disables routing. The idea behind this is that some hosts can, if
451required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their 634required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their
452local config to route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is 635local config to route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is
453\&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do 636\&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do
454not use by default\*(R" switch. 637not use by default\*(R" switch.
455.IP "connect = ondemand | never | always | disabled" 4 638.IP "tcp-port = port-number" 4
456.IX Item "connect = ondemand | never | always | disabled" 639.IX Item "tcp-port = port-number"
457Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always 640Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number.
458try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR 641.IP "udp-port = port-number" 4
459(nevr initiate a connection to the given host, but accept connections), 642.IX Item "udp-port = port-number"
460\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and 643Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
461take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, 644officially assigned by \s-1IANA\s0!).
462don't talk to it).
463.IP "inherit-tos = yes|true|on | no|false|off" 4
464.IX Item "inherit-tos = yes|true|on | no|false|off"
465Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when
466sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then
467outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
468to the tunnel device, which is usually what you want.
469.IP "compress = yes|true|on | no|false|off" 4
470.IX Item "compress = yes|true|on | no|false|off"
471Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR).
472Compression is really cheap even on slow computers and has no size
473overhead at all, so enabling this is a good idea.
474.IP "max-retry = positive-number" 4
475.IX Item "max-retry = positive-number"
476The maximum interval in seconds (default: \f(CW28800\fR, 8 hours) between
477retries to establish a connection to this node. When a connection cannot
478be established, gvpe uses exponential backoff capped at this value. It's
479sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on
480connections to routers that usually are stable but sometimes are down, to
481assure quick reconnections.
482.SH "CONFIG DIRECTORY LAYOUT" 645.SH "CONFIG DIRECTORY LAYOUT"
483.IX Header "CONFIG DIRECTORY LAYOUT" 646.IX Header "CONFIG DIRECTORY LAYOUT"
484The default (or recommended) directory layout for the config directory is: 647The default (or recommended) directory layout for the config directory is:
485.IP "gvpe.conf" 4 648.IP "\(bu" 4
486.IX Item "gvpe.conf" 649.IX Xref "gvpe.conf"
487The config file. 650The config file.
488.IP "if-up" 4 651.IP "\(bu" 4
489.IX Item "if-up" 652.IX Xref "if-up"
490The if-up script 653The if-up script
491.IP "node\-up, node-down" 4 654.IP "," 4
492.IX Item "node-up, node-down" 655.IX Xref "node-up node-down"
493If used the node up or node-down scripts. 656If used the node up or node-down scripts.
494.IP "hostkey" 4 657.IP "\(bu" 4
495.IX Item "hostkey" 658.IX Xref "hostkey"
496The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. 659The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host.
497.IP "pubkey/nodename" 4 660.IP "\(bu" 4
498.IX Item "pubkey/nodename" 661.IX Xref "pubkey nodename"
499The public keys of the other nodes, one file per node. 662The public keys of the other nodes, one file per node.
500.SH "SEE ALSO" 663.SH "SEE ALSO"
501.IX Header "SEE ALSO" 664.IX Header "SEE ALSO"
502\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). 665\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).
503.SH "AUTHOR" 666.SH "AUTHOR"
504.IX Header "AUTHOR" 667.IX Header "AUTHOR"
505Marc Lehmann <gvpe@plan9.de> 668Marc Lehmann <gvpe@schmorp.de>

Diff Legend

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