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.20 by pcg, Sun Aug 10 10:35:26 2008 UTC vs.
Revision 1.23 by pcg, Wed Sep 3 04:58:46 2008 UTC

… …
130.\} 130.\}
131.rm #[ #] #H #V #F C 131.rm #[ #] #H #V #F C
132.\" ======================================================================== 132.\" ========================================================================
133.\" 133.\"
134.IX Title "GVPE.CONF 5" 134.IX Title "GVPE.CONF 5"
135.TH GVPE.CONF 5 "2008-08-07" "2.2" "GNU Virtual Private Ethernet" 135.TH GVPE.CONF 5 "2008-09-01" "2.2" "GNU Virtual Private Ethernet"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes 136.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents. 137.\" way too many mistakes in technical documents.
138.if n .ad l 138.if n .ad l
139.nh 139.nh
140.SH "NAME" 140.SH "NAME"
141gvpe.conf \- configuration file for the GNU VPE daemon 141gvpe.conf \- configuration file for the GNU VPE daemon
142.SH "SYNOPSIS" 142.SH "SYNOPSIS"
143.IX Header "SYNOPSIS" 143.IX Header "SYNOPSIS"
144.Vb 3 144.Vb 4
145\& # global options for all nodes
145\& udp\-port = 407 146\& udp\-port = 407
146\& mtu = 1492 147\& mtu = 1492
147\& ifname = vpn0 148\& ifname = vpn0
148\& 149\&
150\& # first node is named branch1 and is at 1.2.3.4
149\& node = branch1 151\& node = branch1
150\& hostname = 1.2.3.4 152\& hostname = 1.2.3.4
151\& 153\&
154\& # second node uses dns to resolve the address
152\& node = branch2 155\& node = branch2
153\& hostname = www.example.net 156\& hostname = www.example.net
154\& udp\-port = 500 # this host uses a different udp\-port 157\& udp\-port = 500 # this host uses a different udp\-port
155\& 158\&
159\& # third node has no fixed ip address
156\& node = branch3 160\& node = branch3
157\& connect = ondemand 161\& connect = ondemand
158.Ve 162.Ve
159.SH "DESCRIPTION" 163.SH "DESCRIPTION"
160.IX Header "DESCRIPTION" 164.IX Header "DESCRIPTION"
… …
166.PP 170.PP
167The only exception to the above is the \*(L"on\*(R" directive that can prefix any 171The 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 172\&\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. 173(if the nodename starts with \*(L"!\*(R") on all nodes except the named one.
170.PP 174.PP
175For example, set the \s-1MTU\s0 to \f(CW1450\fR everywhere, loglevel to \f(CW\*(C`noise\*(C'\fR on
176branch1, and connect to \f(CW\*(C`ondemand\*(C'\fR everywhere but on branch2:
177.PP
171.Vb 3 178.Vb 3
172\& name = value 179\& mtu = 1450
173\& on branch1 loglevel = noise 180\& on branch1 loglevel = noise
174\& on !branch2 connect = ondemand 181\& on !branch2 connect = ondemand
175.Ve 182.Ve
176.PP 183.PP
177All settings are executed \*(L"in order\*(R", that is, later settings of the same 184All settings are applied \*(L"in order\*(R", that is, later settings of the same
178variable overwrite earlier ones. 185variable overwrite earlier ones.
179.SH "ANATOMY OF A CONFIG FILE" 186.SH "ANATOMY OF A CONFIG FILE"
180.IX Header "ANATOMY OF A CONFIG FILE" 187.IX Header "ANATOMY OF A CONFIG FILE"
181Usually, a config file starts with global settings (like the udp port to 188Usually, a config file starts with a few global settings (like the \s-1UDP\s0
182listen on), followed by node-specific sections that begin with a \f(CW\*(C`node = 189port to listen on), followed by node-specific sections that begin with a
183nickname\*(C'\fR line. 190\&\f(CW\*(C`node = nickname\*(C'\fR line.
184.PP 191.PP
185Every node that is part of the network must have a section that starts 192Every node that is part of the network must have a section that starts
186with \f(CW\*(C`node = nickname\*(C'\fR. The number and order of the nodes is important 193with \f(CW\*(C`node = nickname\*(C'\fR. The number and order of the nodes is important
187and must be the same on all hosts. It is not uncommon for node sections to 194and must be the same on all nodes. It is not uncommon for node sections to
188be completely empty \- if the default values are right. 195be completely empty \- if the default values are right.
189.PP 196.PP
190Node-specific settings can be used at any time. If used before the first 197Node-specific settings can be used at any time. If used before the first
191node section they will set the default values for all following nodes. 198node section they will set the default values for all following nodes.
192.SH "CONFIG VARIABLES" 199.SH "CONFIG VARIABLES"
… …
197is, they are in some sense node-specific (config files can set different 204is, 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 205values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of
199the gvpe daemon and all connections it creates. 206the gvpe daemon and all connections it creates.
200.IP "dns-forw-host = hostname/ip" 4 207.IP "dns-forw-host = hostname/ip" 4
201.IX Item "dns-forw-host = hostname/ip" 208.IX Item "dns-forw-host = hostname/ip"
202The dns server to forward dns requests to for the \s-1DNS\s0 tunnel protocol 209The \s-1DNS\s0 server to forward \s-1DNS\s0 requests to for the \s-1DNS\s0 tunnel protocol
203(default: \f(CW127.0.0.1\fR, changing it is highly recommended). 210(default: \f(CW127.0.0.1\fR, changing it is highly recommended).
204.IP "dns-forw-port = port-number" 4 211.IP "dns-forw-port = port-number" 4
205.IX Item "dns-forw-port = port-number" 212.IX Item "dns-forw-port = port-number"
206The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR, 213The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR,
207which is fine in most cases). 214which is fine in most cases).
… …
211(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given 218(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given
212limit without receiving replies. In heavily overloaded situations it might 219limit without receiving replies. In heavily overloaded situations it might
213help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the 220help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the
214number of parallel requests. 221number of parallel requests.
215.Sp 222.Sp
216The default should be working ok for most links. 223The default should be working \s-1OK\s0 for most links.
217.IP "dns-overlap-factor = float" 4 224.IP "dns-overlap-factor = float" 4
218.IX Item "dns-overlap-factor = float" 225.IX Item "dns-overlap-factor = float"
219The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen 226The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen
220during a connection as it's timing base. This factor (default: \f(CW0.5\fR, 227during a connection as it's timing base. This factor (default: \f(CW0.5\fR,
221must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending 228must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending
… …
223request might be generated every \fBmin_latency\fR seconds, which means on 230request might be generated every \fBmin_latency\fR seconds, which means on
224average there should only ever be one outstanding request. A factor of 231average there should only ever be one outstanding request. A factor of
225\&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum 232\&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum
226latency measured. 233latency measured.
227.Sp 234.Sp
228For congested or picky dns forwarders you could use a value nearer to or 235For congested or picky \s-1DNS\s0 forwarders you could use a value nearer to or
229exceeding \f(CW1\fR. 236exceeding \f(CW1\fR.
230.Sp 237.Sp
231The default should be working ok for most links. 238The default should be working \s-1OK\s0 for most links.
232.IP "dns-send-interval = send-interval-in-seconds" 4 239.IP "dns-send-interval = send-interval-in-seconds" 4
233.IX Item "dns-send-interval = send-interval-in-seconds" 240.IX Item "dns-send-interval = send-interval-in-seconds"
234The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will 241The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will
235use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when 242use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when
236the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will 243the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will
237not send more than 100 \s-1DNS\s0 requests per connection per second. For 244not send more than 100 \s-1DNS\s0 requests per connection per second. For
238high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For 245high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For
239congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR, 246congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR,
240\&\f(CW0.2\fR or even higher. 247\&\f(CW0.2\fR or even higher.
241.Sp 248.Sp
242The default should be working ok for most links. 249The default should be working \s-1OK\s0 for most links.
243.IP "dns-timeout-factor = float" 4 250.IP "dns-timeout-factor = float" 4
244.IX Item "dns-timeout-factor = float" 251.IX Item "dns-timeout-factor = float"
245Factor to multiply the \f(CW\*(C`min_latency\*(C'\fR (see \f(CW\*(C`dns\-overlap\-factor\*(C'\fR) by to 252Factor to multiply the \f(CW\*(C`min_latency\*(C'\fR (see \f(CW\*(C`dns\-overlap\-factor\*(C'\fR) by to
246get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport 253get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport
247will resend the request when no reply has been received for longer than 254will resend the request when no reply has been received for longer than
… …
250.Sp 257.Sp
251For congested links a higher value might be necessary (e.g. \f(CW30\fR). If 258For congested links a higher value might be necessary (e.g. \f(CW30\fR). If
252the link is very stable lower values (e.g. \f(CW2\fR) might work 259the link is very stable lower values (e.g. \f(CW2\fR) might work
253nicely. Values near or below \f(CW1\fR makes no sense whatsoever. 260nicely. Values near or below \f(CW1\fR makes no sense whatsoever.
254.Sp 261.Sp
255The default should be working ok for most links but will result in low 262The default should be working \s-1OK\s0 for most links but will result in low
256throughput if packet loss is high. 263throughput if packet loss is high.
257.IP "if-up = relative-or-absolute-path" 4 264.IP "if-up = relative-or-absolute-path" 4
258.IX Item "if-up = relative-or-absolute-path" 265.IX Item "if-up = relative-or-absolute-path"
259Sets the path of a script that should be called immediately after the 266Sets the path of a script that should be called immediately after the
260network interface is initialized (but not neccessarily up). The following 267network interface is initialized (but not necessarily up). The following
261environment variables are passed to it (the values are just examples). 268environment variables are passed to it (the values are just examples).
262.Sp 269.Sp
263Variables that have the same value on all nodes: 270Variables that have the same value on all nodes:
264.RS 4 271.RS 4
265.IP "CONFBASE=/etc/gvpe" 4 272.IP "CONFBASE=/etc/gvpe" 4
… …
278\&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to 285\&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to
279select the correct syntax to use for network-related commands. 286select the correct syntax to use for network-related commands.
280.IP "MTU=1436" 4 287.IP "MTU=1436" 4
281.IX Item "MTU=1436" 288.IX Item "MTU=1436"
282The \s-1MTU\s0 to set the interface to. You can use lower values (if done 289The \s-1MTU\s0 to set the interface to. You can use lower values (if done
283consistently on all hosts), but this is usually ineffective. 290consistently on all nodes), but this is usually either inefficient or
291simply ineffective.
284.IP "NODES=5" 4 292.IP "NODES=5" 4
285.IX Item "NODES=5" 293.IX Item "NODES=5"
286The number of nodes in this \s-1GVPE\s0 network. 294The number of nodes in this \s-1GVPE\s0 network.
287.RE 295.RE
288.RS 4 296.RS 4
… …
295.IP "MAC=fe:fd:80:00:00:01" 4 303.IP "MAC=fe:fd:80:00:00:01" 4
296.IX Item "MAC=fe:fd:80:00:00:01" 304.IX Item "MAC=fe:fd:80:00:00:01"
297The \s-1MAC\s0 address the network interface has to use. 305The \s-1MAC\s0 address the network interface has to use.
298.Sp 306.Sp
299Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not 307Might 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 308do this automatically. Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR man page for
301platform-specific information. 309platform-specific information.
302.IP "NODENAME=branch1" 4 310.IP "NODENAME=branch1" 4
303.IX Item "NODENAME=branch1" 311.IX Item "NODENAME=branch1"
304The nickname of the node. 312The nickname of the node.
305.IP "NODEID=1" 4 313.IP "NODEID=1" 4
… …
322\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME 330\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
323\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME 331\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
324\& ip route add 10.0.0.0/8 dev $IFNAME 332\& ip route add 10.0.0.0/8 dev $IFNAME
325.Ve 333.Ve
326.Sp 334.Sp
327More complicated examples (using routing to reduce arp traffic) can be 335More complicated examples (using routing to reduce \s-1ARP\s0 traffic) can be
328found in the etc/ subdirectory of the distribution. 336found in the \fIetc/\fR subdirectory of the distribution.
329.RE 337.RE
330.IP "ifname = devname" 4 338.IP "ifname = devname" 4
331.IX Item "ifname = devname" 339.IX Item "ifname = devname"
332Sets the tun interface name to the given name. The default is OS-specific 340Sets the tun interface name to the given name. The default is OS-specific
333and most probably something like \f(CW\*(C`tun0\*(C'\fR. 341and most probably something like \f(CW\*(C`tun0\*(C'\fR.
… …
340the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the 348the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the
341device. 349device.
342.IP "ip-proto = numerical-ip-protocol" 4 350.IP "ip-proto = numerical-ip-protocol" 4
343.IX Item "ip-proto = numerical-ip-protocol" 351.IX Item "ip-proto = numerical-ip-protocol"
344Sets the protocol number to be used for the rawip protocol. This is a 352Sets the protocol number to be used for the rawip protocol. This is a
345global option because all hosts must use the same protocol, and since 353global option because all nodes must use the same protocol, and since
346there are no port numbers, you cannot easily run more than one gvpe 354there are no port numbers, you cannot easily run more than one gvpe
347instance using the same protocol, nor can you share the protocol with 355instance using the same protocol, nor can you share the protocol with
348other programs. 356other programs.
349.Sp 357.Sp
350The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through 358The default is 47 (\s-1GRE\s0), which has a good chance of tunneling
351firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other 359through firewalls (but note that gvpe's rawip protocol is not \s-1GRE\s0
352common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98 360compatible). Other common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4
353(\s-1ENCAP\s0, rfc1241) 361(\s-1IPIP\s0 tunnels) or 98 (\s-1ENCAP\s0, rfc1241)
354.IP "http-proxy-host = hostname/ip" 4 362.IP "http-proxy-host = hostname/ip" 4
355.IX Item "http-proxy-host = hostname/ip" 363.IX Item "http-proxy-host = hostname/ip"
356The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was 364The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was
357compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of 365compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of
358tcp connections through a http proxy server. 366tcp connections through a http proxy server.
… …
360\&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and 368\&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and
361port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy 369port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy
362requires authentication. 370requires authentication.
363.Sp 371.Sp
364Please note that gvpe will still try to resolve all hostnames in the 372Please note that gvpe will still try to resolve all hostnames in the
365configuration file, so if you are behind a proxy without access to a dns 373configuration file, so if you are behind a proxy without access to a \s-1DNS\s0
366server better use numerical \s-1IP\s0 addresses. 374server better use numerical \s-1IP\s0 addresses.
367.Sp 375.Sp
368To make best use of this option disable all protocols except tcp in your 376To make best use of this option disable all protocols except \s-1TCP\s0 in your
369config file and make sure your routers (or all other hosts) are listening 377config file and make sure your routers (or all other nodes) are listening
370on a port that the proxy allows (443, https, is a common choice). 378on a port that the proxy allows (443, https, is a common choice).
371.Sp 379.Sp
372If you have a router, connecting to it will suffice. Otherwise tcp must be 380If you have a router, connecting to it will suffice. Otherwise \s-1TCP\s0 must be
373enabled on all hosts. 381enabled on all nodes.
374.Sp 382.Sp
375Example: 383Example:
376.Sp 384.Sp
377.Vb 3 385.Vb 3
378\& http\-proxy\-host = proxy.example.com 386\& http\-proxy\-host = proxy.example.com
… …
383.IX Item "http-proxy-port = proxy-tcp-port" 391.IX Item "http-proxy-port = proxy-tcp-port"
384The port where your proxy server listens. 392The port where your proxy server listens.
385.IP "http-proxy-auth = login:password" 4 393.IP "http-proxy-auth = login:password" 4
386.IX Item "http-proxy-auth = login:password" 394.IX Item "http-proxy-auth = login:password"
387The optional login and password used to authenticate to the proxy server, 395The optional login and password used to authenticate to the proxy server,
388seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is 396separated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is
389currently supported. 397currently supported.
390.IP "keepalive = seconds" 4 398.IP "keepalive = seconds" 4
391.IX Item "keepalive = seconds" 399.IX Item "keepalive = seconds"
392Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this 400Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this
393many seconds of inactivity the daemon will start to send keepalive probe 401many seconds of inactivity the daemon will start to send keepalive probe
394every 5 seconds until it receives a reply from the other end. If no reply 402every 3 seconds until it receives a reply from the other end. If no reply
395is received within 30 seconds, the peer is considered unreachable and the 403is received within 15 seconds, the peer is considered unreachable and the
396connection is closed. 404connection is closed.
397.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 405.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4
398.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" 406.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical"
399Set the logging level. Connection established messages are logged at level 407Set the logging level. Connection established messages are logged at level
400\&\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. 408\&\f(CW\*(C`info\*(C'\fR, notable errors are logged with \f(CW\*(C`error\*(C'\fR. Default is \f(CW\*(C`info\*(C'\fR.
401.IP "mtu = bytes" 4 409.IP "mtu = bytes" 4
402.IX Item "mtu = bytes" 410.IX Item "mtu = bytes"
403Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically 411Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically
404the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate 412the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate
405maximum overhead (e.g. udp header size, encryption blocksize...) and pass 413maximum overhead (e.g. \s-1UDP\s0 header size, encryption blocksize...) and pass
406this information to the \f(CW\*(C`if\-up\*(C'\fR script. 414this information to the \f(CW\*(C`if\-up\*(C'\fR script.
407.Sp 415.Sp
408Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). 416Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
409.Sp 417.Sp
410This value must be the minimum of the mtu values of all hosts. 418This value must be the minimum of the \s-1MTU\s0 values of all nodes.
411.IP "node = nickname" 4 419.IP "node = nickname" 4
412.IX Item "node = nickname" 420.IX Item "node = nickname"
413Not really a config setting but introduces a node section. The nickname is 421Not really a config setting but introduces a node section. The nickname is
414used to select the right configuration section and must be passed as an 422used to select the right configuration section and must be passed as an
415argument to the gvpe daemon. 423argument to the gvpe daemon.
… …
429.IP "DESTID=2" 4 437.IP "DESTID=2" 4
430.IX Item "DESTID=2" 438.IX Item "DESTID=2"
431The node id of the remote node. 439The node id of the remote node.
432.IP "DESTIP=188.13.66.8" 4 440.IP "DESTIP=188.13.66.8" 4
433.IX Item "DESTIP=188.13.66.8" 441.IX Item "DESTIP=188.13.66.8"
434The numerical \s-1IP\s0 address of the remote host (gvpe accepts connections from 442The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from
435everywhere, as long as the other host can authenticate itself). 443everywhere, as long as the other node can authenticate itself).
436.IP "DESTPORT=655 # deprecated" 4 444.IP "DESTPORT=655 # deprecated" 4
437.IX Item "DESTPORT=655 # deprecated" 445.IX Item "DESTPORT=655 # deprecated"
438The \s-1UDP\s0 port used by the other side. 446The \s-1UDP\s0 port used by the other side.
439.IP "STATE=UP" 4 447.IP "STATE=UP" 4
440.IX Item "STATE=UP" 448.IX Item "STATE=UP"
… …
442with STATE=DOWN. 450with STATE=DOWN.
443.RE 451.RE
444.RS 4 452.RS 4
445.Sp 453.Sp
446Here is a nontrivial example that uses nsupdate to update the name => ip 454Here is a nontrivial example that uses nsupdate to update the name => ip
447mapping in some dns zone: 455mapping in some \s-1DNS\s0 zone:
448.Sp 456.Sp
449.Vb 6 457.Vb 6
450\& #!/bin/sh 458\& #!/bin/sh
451\& { 459\& {
452\& echo update delete $DESTNODE.lowttl.example.net. a 460\& echo update delete $DESTNODE.lowttl.example.net. a
… …
469be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could 477be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could
470use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where 478use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where
471\&\f(CW\*(C`gvpectrl\*(C'\fR puts them. 479\&\f(CW\*(C`gvpectrl\*(C'\fR puts them.
472.Sp 480.Sp
473Since only the private key file of the current node is used and the 481Since only the private key file of the current node is used and the
474private key file should be kept secret per-host to avoid spoofings, it is 482private key file should be kept secret per-node to avoid spoofing, it is
475not recommended to use this feature. 483not recommended to use this feature.
476.IP "rekey = seconds" 4 484.IP "rekey = seconds" 4
477.IX Item "rekey = seconds" 485.IX Item "rekey = seconds"
478Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are 486Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are
479reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. 487reestablished every \f(CW\*(C`rekey\*(C'\fR seconds, making them use a new encryption
488key.
480.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 489.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
481.IX Subsection "NODE SPECIFIC SETTINGS" 490.IX Subsection "NODE SPECIFIC SETTINGS"
482The following settings are node-specific, that is, every node can have 491The following settings are node-specific, that is, every node can have
483different settings, even within the same gvpe instance. Settings that are 492different settings, even within the same gvpe instance. Settings that are
484set before the first node section set the defaults, settings that are 493set before the first node section set the defaults, settings that are
… …
486.IP "allow-direct = nodename" 4 495.IP "allow-direct = nodename" 4
487.IX Item "allow-direct = nodename" 496.IX Item "allow-direct = nodename"
488Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info. 497Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info.
489.IP "compress = yes|true|on | no|false|off" 4 498.IP "compress = yes|true|on | no|false|off" 4
490.IX Item "compress = yes|true|on | no|false|off" 499.IX Item "compress = yes|true|on | no|false|off"
491Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). 500Wether to compress data packets sent to this node (default: \f(CW\*(C`yes\*(C'\fR).
492Compression is really cheap even on slow computers and has no size 501Compression is really cheap even on slow computers and has no size
493overhead at all, so enabling this is a good idea. 502overhead at all, so enabling this is often a good idea.
494.IP "connect = ondemand | never | always | disabled" 4 503.IP "connect = ondemand | never | always | disabled" 4
495.IX Item "connect = ondemand | never | always | disabled" 504.IX Item "connect = ondemand | never | always | disabled"
496Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always 505Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always
497try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR 506try to establish and keep a connection to the given node), \f(CW\*(C`never\*(C'\fR
498(never initiate a connection to the given host, but accept connections), 507(never initiate a connection to the given host, but accept connections),
499\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection when there are outstanding 508\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection when there are outstanding
500packets in the queue and take it down after the keepalive interval) or 509packets in the queue and take it down after the keepalive interval) or
501\&\f(CW\*(C`disabled\*(C'\fR (node is bad, don't talk to it). 510\&\f(CW\*(C`disabled\*(C'\fR (node is bad, don't talk to it).
511.Sp
512Routers will automatically be forced to \f(CW\*(C`always\*(C'\fR unless they are
513\&\f(CW\*(C`disabled\*(C'\fR, to ensure all nodes can talk to each other.
502.IP "deny-direct = nodename | *" 4 514.IP "deny-direct = nodename | *" 4
503.IX Item "deny-direct = nodename | *" 515.IX Item "deny-direct = nodename | *"
504Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR 516Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR
505is given). Only one node can be specified, but you can use multiple 517is given). Only one node can be specified, but you can use multiple
506\&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in 518\&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in
507networks with routers, as routers are required for indirect connections. 519networks with routers, as routers are required for indirect connections.
508.Sp 520.Sp
509Sometimes, a node cannot reach some other nodes for reasons of network 521Sometimes, a node cannot reach some other nodes for reasons of network
510connectivity. For example, a node behind a firewall that only allows 522connectivity. For example, a node behind a firewall that only allows
511conenctions to/from a single other node in the network. In this case one 523connections to/from a single other node in the network. In this case one
512should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other 524should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other
513node \fImust\fR be a router for this to work). 525node \fImust\fR be a router for this to work).
514.Sp 526.Sp
515The algorithm to check wether a connection may be direct is as follows: 527The algorithm to check whether a connection may be direct is as follows:
516.Sp 528.Sp
5171. Other node mentioned in a \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection. 5291. Other node mentioned in an \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection.
518.Sp 530.Sp
5192. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections. 5312. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections.
520.Sp 532.Sp
5213. Allow the connection. 5333. Allow the connection.
522.Sp 534.Sp
… …
561was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option. 573was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option.
562.IP "enable-icmp = yes|true|on | no|false|off" 4 574.IP "enable-icmp = yes|true|on | no|false|off" 4
563.IX Item "enable-icmp = yes|true|on | no|false|off" 575.IX Item "enable-icmp = yes|true|on | no|false|off"
564See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol. 576See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol.
565.Sp 577.Sp
566Enable the \s-1ICMP\s0 transport using icmp packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this 578Enable the \s-1ICMP\s0 transport using \s-1ICMP\s0 packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this
567node. 579node.
568.IP "enable-rawip = yes|true|on | no|false|off" 4 580.IP "enable-rawip = yes|true|on | no|false|off" 4
569.IX Item "enable-rawip = yes|true|on | no|false|off" 581.IX Item "enable-rawip = yes|true|on | no|false|off"
570See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol. 582See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol.
571.Sp 583.Sp
… …
584.Sp 596.Sp
585Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, 597Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR,
586unless no other protocol is enabled for a node, in which case this 598unless no other protocol is enabled for a node, in which case this
587protocol is enabled automatically). 599protocol is enabled automatically).
588.Sp 600.Sp
589\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though 601\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want to use it even though
590it might get switched on automatically, as some future version might 602it might get switched on automatically, as some future version might
591default to another default protocol. 603default to another default protocol.
592.IP "hostname = hostname | ip [can not be defaulted]" 4 604.IP "hostname = hostname | ip [can not be defaulted]" 4
593.IX Item "hostname = hostname | ip [can not be defaulted]" 605.IX Item "hostname = hostname | ip [can not be defaulted]"
594Forces the address of this node to be set to the given dns hostname or ip 606Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0
595address. It will be resolved before each connect request, so dyndns should 607address. It will be resolved before each connect request, so dyndns should
596work fine. If this setting is not specified and a router is available, 608work fine. If this setting is not specified and a router is available,
597then the router will be queried for the address of this node. Otherwise, 609then the router will be queried for the address of this node. Otherwise,
598the connection attempt will fail. 610the connection attempt will fail.
611.Sp
612Note that \s-1DNS\s0 resolving is done synchronously, pausing the daemon. If that
613is an issue you need to specify \s-1IP\s0 addresses.
599.IP "icmp-type = integer" 4 614.IP "icmp-type = integer" 4
600.IX Item "icmp-type = integer" 615.IX Item "icmp-type = integer"
601Sets the type value to be used for outgoing (and incoming) packets sent 616Sets the type value to be used for outgoing (and incoming) packets sent
602via the \s-1ICMP\s0 transport. 617via the \s-1ICMP\s0 transport.
603.Sp 618.Sp
604The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as 619The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as
605\&\*(L"ping-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. 620\&\*(L"ping-reply\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a.
606\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. 621\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used.
607.IP "if-up-data = value" 4 622.IP "if-up-data = value" 4
608.IX Item "if-up-data = value" 623.IX Item "if-up-data = value"
609The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR 624The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR
610script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR. 625script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR.
… …
616to the tunnel device, which is usually what you want. 631to the tunnel device, which is usually what you want.
617.IP "max-retry = positive-number" 4 632.IP "max-retry = positive-number" 4
618.IX Item "max-retry = positive-number" 633.IX Item "max-retry = positive-number"
619The maximum interval in seconds (default: \f(CW3600\fR, one hour) between 634The maximum interval in seconds (default: \f(CW3600\fR, one hour) between
620retries to establish a connection to this node. When a connection cannot 635retries to establish a connection to this node. When a connection cannot
621be established, gvpe uses exponential backoff capped at this value. It's 636be established, gvpe uses exponential back-off capped at this value. It's
622sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on 637sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on
623connections to routers that usually are stable but sometimes are down, to 638connections to routers that usually are stable but sometimes are down, to
624assure quick reconnections even after longer downtimes. 639assure quick reconnections even after longer downtimes.
625.IP "max-ttl = seconds" 4 640.IP "max-ttl = seconds" 4
626.IX Item "max-ttl = seconds" 641.IX Item "max-ttl = seconds"
627Expire packets that couldn't be sent after this many seconds 642Expire packets that couldn't be sent after this many seconds
628(default: \f(CW60\fR). Gvpe will normally queue packets for a node without an 643(default: \f(CW60\fR). Gvpe will normally queue packets for a node without an
629active connection, in the hope of establishing a connection soon. This 644active connection, in the hope of establishing a connection soon. This
630value specifies the maximum lifetime a packet will stay in the queue, if a 645value specifies the maximum lifetime a packet will stay in the queue, if a
631packet gets older, it will be thrown away. 646packet gets older, it will be thrown away.
632.IP "max-queue = positive-number" 4 647.IP "max-queue = positive\-number>=1" 4
633.IX Item "max-queue = positive-number" 648.IX Item "max-queue = positive-number>=1"
634The maximum number of packets that will be queued (default: \f(CW512\fR) 649The maximum number of packets that will be queued (default: \f(CW512\fR)
635for this node. If more packets are sent then earlier packets will be 650for this node. If more packets are sent then earlier packets will be
636expired. See \f(CW\*(C`max\-ttl\*(C'\fR, above. 651expired. See \f(CW\*(C`max\-ttl\*(C'\fR, above.
637.IP "router-priority = 0 | 1 | positive\-number>=2" 4 652.IP "router-priority = 0 | 1 | positive\-number>=2" 4
638.IX Item "router-priority = 0 | 1 | positive-number>=2" 653.IX Item "router-priority = 0 | 1 | positive-number>=2"
639Sets the router priority of the given host (default: \f(CW0\fR, disabled). If 654Sets the router priority of the given node (default: \f(CW0\fR, disabled).
640some host tries to connect to another host without a hostname, it asks
641the router host for it's \s-1IP\s0 address. The router host is the one with the
642highest priority larger than \f(CW1\fR that is currently reachable.
643.Sp 655.Sp
644Make sure all hosts always connect (\f(CW\*(C`connect = always\*(C'\fR) to the router 656If some node tries to connect to another node but it doesn't have a
645hosts, otherwise connecting to them might be impossible. 657hostname, it asks a router node for it's \s-1IP\s0 address. The router node
658chosen is the one with the highest priority larger than \f(CW1\fR that is
659currently reachable. This is called a \fImediated\fR connection, as the
660connection itself will still be direct, but it uses another node to
661mediate between the two nodes.
662.Sp
663The value \f(CW0\fR disables routing, that means if the node receives a packet
664not for itself it will not forward it but instead drop it.
646.Sp 665.Sp
647The special value \f(CW1\fR allows other hosts to route through the router 666The special value \f(CW1\fR allows other hosts to route through the router
648host, but they will never route through it by default. The value \f(CW0\fR 667host, but they will never route through it by default (i.e. the config
649disables routing. The idea behind this is that some hosts can, if 668file of another node needs to specify a router priority higher than one
669to choose such a node for routing).
670.Sp
671The idea behind this is that some hosts can, if required, bump the
650required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their 672\&\f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their local config to
651local config to route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is 673route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is \f(CW0\fR, then routing
652\&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do 674will be refused, so \f(CW1\fR serves as a \*(L"enable, but do not use by default\*(R"
653not use by default\*(R" switch. 675switch.
676.Sp
677Nodes with \f(CW\*(C`router\-priority\*(C'\fR set to \f(CW2\fR or higher will always be forced
678to \f(CW\*(C`connect\*(C'\fR = \f(CW\*(C`always\*(C'\fR (unless they are \f(CW\*(C`disabled\*(C'\fR).
654.IP "tcp-port = port-number" 4 679.IP "tcp-port = port-number" 4
655.IX Item "tcp-port = port-number" 680.IX Item "tcp-port = port-number"
656Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. 681Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number.
657.IP "udp-port = port-number" 4 682.IP "udp-port = port-number" 4
658.IX Item "udp-port = port-number" 683.IX Item "udp-port = port-number"
659Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not 684Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
660officially assigned by \s-1IANA\s0!). 685officially assigned by \s-1IANA\s0!).
661.SH "CONFIG DIRECTORY LAYOUT" 686.SH "CONFIG DIRECTORY LAYOUT"
662.IX Header "CONFIG DIRECTORY LAYOUT" 687.IX Header "CONFIG DIRECTORY LAYOUT"
663The default (or recommended) directory layout for the config directory is: 688The default (or recommended) directory layout for the config directory is:
664.IP "" 4 689.IP "gvpe.conf" 4
665.IX Xref "gvpe.conf" 690.IX Item "gvpe.conf"
666The config file. 691The config file.
667.IP "" 4 692.IP "if-up" 4
668.IX Xref "if-up" 693.IX Item "if-up"
669The if-up script 694The if-up script
670.IP "," 4 695.IP "node-up, node-down" 4
671.IX Xref "node-up node-down" 696.IX Item "node-up, node-down"
672If used the node up or node-down scripts. 697If used the node up or node-down scripts.
673.IP "" 4 698.IP "hostkey" 4
674.IX Xref "hostkey" 699.IX Item "hostkey"
675The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. 700The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host.
676.IP "" 4 701.IP "pubkey/nodename" 4
677.IX Xref "pubkey nodename" 702.IX Item "pubkey/nodename"
678The public keys of the other nodes, one file per node. 703The public keys of the other nodes, one file per node.
679.SH "SEE ALSO" 704.SH "SEE ALSO"
680.IX Header "SEE ALSO" 705.IX Header "SEE ALSO"
681\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). 706\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).
682.SH "AUTHOR" 707.SH "AUTHOR"

Diff Legend

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