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.9 by pcg, Mon Mar 14 17:40:01 2005 UTC vs.
Revision 1.32 by root, Thu Jul 18 13:35:19 2013 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 1.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP) 5.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v 6.if t .sp .5v
15.if n .sp 7.if n .sp
16.. 8..
17.de Vb \" Begin verbatim text 9.de Vb \" Begin verbatim text
… …
23.ft R 15.ft R
24.fi 16.fi
25.. 17..
26.\" Set up some character translations and predefined strings. \*(-- will 18.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left 19.\" 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 20.\" 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 21.\" 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' 22.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31.\" expand to `' in nroff, nothing in troff, for use with C<>. 23.\" nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr 24.tr \(*W-
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' 25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\ 26.ie n \{\
35. ds -- \(*W- 27. ds -- \(*W-
36. ds PI pi 28. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 29. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
… …
46. ds PI \(*p 38. ds PI \(*p
47. ds L" `` 39. ds L" ``
48. ds R" '' 40. ds R" ''
49'br\} 41'br\}
50.\" 42.\"
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el .ds Aq '
46.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for 47.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the 49.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion. 50.\" output yourself in some meaningful fashion.
55.if \nF \{\ 51.ie \nF \{\
56. de IX 52. de IX
57. tm Index:\\$1\t\\n%\t"\\$2" 53. tm Index:\\$1\t\\n%\t"\\$2"
58.. 54..
59. nr % 0 55. nr % 0
60. rr F 56. rr F
61.\} 57.\}
62.\" 58.el \{\
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes 59. de IX
64.\" way too many mistakes in technical documents. 60..
65.hy 0 61.\}
66.if n .na
67.\" 62.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts. 64.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff 65. \" fudge factors for nroff and troff
71.if n \{\ 66.if n \{\
… …
127.\} 122.\}
128.rm #[ #] #H #V #F C 123.rm #[ #] #H #V #F C
129.\" ======================================================================== 124.\" ========================================================================
130.\" 125.\"
131.IX Title "GVPE.CONF 5" 126.IX Title "GVPE.CONF 5"
132.TH GVPE.CONF 5 "2005-03-14" "1.8" "GNU Virtual Private Ethernet" 127.TH GVPE.CONF 5 "2013-07-17" "2.25" "GNU Virtual Private Ethernet"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents.
130.if n .ad l
131.nh
133.SH "NAME" 132.SH "NAME"
134gvpe.conf \- configuration file for the GNU VPE daemon 133gvpe.conf \- configuration file for the GNU VPE daemon
135.SH "SYNOPSIS" 134.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 135.IX Header "SYNOPSIS"
137.Vb 3 136.Vb 4
137\& # global options for all nodes
138\& udp-port = 407 138\& udp\-port = 407
139\& mtu = 1492 139\& mtu = 1492
140\& ifname = vpn0 140\& ifname = vpn0
141.Ve 141\&
142.PP 142\& # first node is named branch1 and is at 1.2.3.4
143.Vb 2
144\& node = branch1 143\& node = branch1
145\& hostname = 1.2.3.4 144\& hostname = 1.2.3.4
146.Ve 145\&
147.PP 146\& # second node uses dns to resolve the address
148.Vb 3
149\& node = branch2 147\& node = branch2
150\& hostname = www.example.net 148\& hostname = www.example.net
151\& udp-port = 500 # this host uses a different udp-port 149\& udp\-port = 500 # this host uses a different udp\-port
152.Ve 150\&
153.PP 151\& # third node has no fixed ip address
154.Vb 2
155\& node = branch3 152\& node = branch3
156\& connect = ondemand 153\& connect = ondemand
157.Ve 154.Ve
158.SH "DESCRIPTION" 155.SH "DESCRIPTION"
159.IX Header "DESCRIPTION" 156.IX Header "DESCRIPTION"
160The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable 157The 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 158= 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 159extend 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 160after 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. 161values, but not within the variable names or values themselves.
165.PP 162.PP
166The only exception to the above is the \*(L"on\*(R" directive that can prefix any 163All settings are applied \*(L"in order\*(R", that is, later settings of the same
167\&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or 164variable overwrite earlier ones.
168(if the nodename starts with \*(L"!\*(R") on all nodes except the named one.
169.PP 165.PP
166The only exceptions to the above are the following directives:
167.IP "node nodename" 4
168.IX Item "node nodename"
169Introduces a node section. The nodename is used to select the right
170configuration section and is the same string as is passed as an argument
171to the gvpe daemon.
172.Sp
173Multiple \f(CW\*(C`node\*(C'\fR statements with the same node name are supported and will
174be merged together.
175.IP "global" 4
176.IX Item "global"
177This statement switches back to the global section, which is mainly
178useful if you want to include a second config file, e..g for local
179customisations. To do that, simply include this at the very end of your
180config file:
181.Sp
182.Vb 2
183\& global
184\& include local.conf
185.Ve
186.IP "on nodename ..." 4
187.IX Item "on nodename ..."
188.PD 0
189.IP "on !nodename ..." 4
190.IX Item "on !nodename ..."
191.PD
192You can prefix any configuration directive with \f(CW\*(C`on\*(C'\fR and a nodename. \s-1GVPE\s0
193will will only \*(L"execute\*(R" it on the named node, or (if the nodename starts
194with \f(CW\*(C`!\*(C'\fR) on all nodes except the named one.
195.Sp
196Example: set the \s-1MTU\s0 to \f(CW1450\fR everywhere, \f(CW\*(C`loglevel\*(C'\fR to \f(CW\*(C`noise\*(C'\fR on
197\&\f(CW\*(C`branch1\*(C'\fR, and \f(CW\*(C`connect\*(C'\fR to \f(CW\*(C`ondemand\*(C'\fR everywhere but on branch2.
198.Sp
170.Vb 3 199.Vb 3
171\& name = value 200\& mtu = 1450
172\& on branch1 loglevel = noise 201\& on branch1 loglevel = noise
173\& on !branch2 connect = ondemand 202\& on !branch2 connect = ondemand
174.Ve 203.Ve
175.PP 204.IP "include relative-or-absolute-path" 4
176All settings are executed \*(L"in order\*(R", that is, later settings of the same 205.IX Item "include relative-or-absolute-path"
177variable overwrite earlier ones. 206Reads the specified file (the path must not contain whitespace or \f(CW\*(C`=\*(C'\fR
207characters) and evaluate all config directives in it as if they were
208spelled out in place of the \f(CW\*(C`include\*(C'\fR directive.
209.Sp
210The path is a printf format string, that is, you must escape any \f(CW\*(C`%\*(C'\fR
211by doubling it, and you can have a single \f(CW%s\fR inside, which will be
212replaced by the current nodename.
213.Sp
214Relative paths are interpreted relative to the \s-1GVPE\s0 config directory.
215.Sp
216Example: include the file \fIlocal.conf\fR in the config directory on every
217node.
218.Sp
219.Vb 1
220\& include local.conf
221.Ve
222.Sp
223Example: include a file \fIconf/\fRnodename\fI.conf\fR
224.Sp
225.Vb 1
226\& include conf/%s.conf
227.Ve
178.SH "ANATOMY OF A CONFIG FILE" 228.SH "ANATOMY OF A CONFIG FILE"
179.IX Header "ANATOMY OF A CONFIG FILE" 229.IX Header "ANATOMY OF A CONFIG FILE"
180Usually, a config file starts with global settings (like the udp port to 230Usually, a config file starts with a few global settings (like the \s-1UDP\s0
181listen on), followed by node-specific sections that begin with a \f(CW\*(C`node = 231port to listen on), followed by node-specific sections that begin with a
182nickname\*(C'\fR line. 232\&\f(CW\*(C`node = nickname\*(C'\fR line.
183.PP 233.PP
184Every node that is part of the network must have a section that starts 234Every 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 235with \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 236and must be the same on all nodes. It is not uncommon for node sections to
187be completely empty \- if the default values are right. 237be completely empty \- if the default values are right.
188.PP 238.PP
189Node-specific settings can be used at any time. If used before the first 239Node-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. 240node section they will set the default values for all following nodes.
191.SH "CONFIG VARIABLES" 241.SH "CONFIG VARIABLES"
192.IX Header "CONFIG VARIABLES" 242.IX Header "CONFIG VARIABLES"
193.Sh "\s-1GLOBAL\s0 \s-1SETTINGS\s0" 243.SS "\s-1GLOBAL\s0 \s-1SETTINGS\s0"
194.IX Subsection "GLOBAL SETTINGS" 244.IX Subsection "GLOBAL SETTINGS"
195Global settings will affect the behaviour of the running gvpe daemon, that 245Global settings will affect the behaviour of the running gvpe daemon, that
196is, they are in some sense node-specific (config files can set different 246is, they are in some sense node-specific (config files can set different
197values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of 247values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of
198the gvpe daemon and all connections it creates. 248the gvpe daemon and all connections it creates.
249.IP "chroot = path or /" 4
250.IX Item "chroot = path or /"
251Tells \s-1GVPE\s0 to \fIchroot\fR\|(2) to the specified path after reading all necessary
252files, binding to sockets and running the \f(CW\*(C`if\-up\*(C'\fR script, but before
253running \f(CW\*(C`node\-up\*(C'\fR or any other scripts.
254.Sp
255The special path \fI/\fR instructs \s-1GVPE\s0 to create (and remove) an empty
256temporary directory to use as new root. This is most secure, but makes it
257impossible to use any scripts other than the \f(CW\*(C`if\-up\*(C'\fR one.
258.IP "chuid = numerical-uid" 4
259.IX Item "chuid = numerical-uid"
260.PD 0
261.IP "chgid = numerical-gid" 4
262.IX Item "chgid = numerical-gid"
263.PD
264These two options tell \s-1GVPE\s0 to change to the given user and/or group id
265after reading all necessary files, binding to sockets and running the
266\&\f(CW\*(C`if\-up\*(C'\fR script.
267.Sp
268Other scripts, such as \f(CW\*(C`node\-up\*(C'\fR, are run with the new user id or group id.
269.IP "chuser = username" 4
270.IX Item "chuser = username"
271Alternative to \f(CW\*(C`chuid\*(C'\fR and \f(CW\*(C`chgid\*(C'\fR: Sets both \f(CW\*(C`chuid\*(C'\fR and \f(CW\*(C`chgid\*(C'\fR
272to the user and (primary) group ids of the specified user (for example,
273\&\f(CW\*(C`nobody\*(C'\fR).
199.IP "dns-forw-host = hostname/ip" 4 274.IP "dns-forw-host = hostname/ip" 4
200.IX Item "dns-forw-host = hostname/ip" 275.IX Item "dns-forw-host = hostname/ip"
201The dns server to forward dns requests to for the \s-1DNS\s0 tunnel protocol 276The \s-1DNS\s0 server to forward \s-1DNS\s0 requests to for the \s-1DNS\s0 tunnel protocol
202(default: \f(CW127.0.0.1\fR, changing it is highly recommended). 277(default: \f(CW127.0.0.1\fR, changing it is highly recommended).
203.IP "dns-forw-port = port-number" 4 278.IP "dns-forw-port = port-number" 4
204.IX Item "dns-forw-port = port-number" 279.IX Item "dns-forw-port = port-number"
205The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR, 280The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR,
206which is fine in most cases). 281which is fine in most cases).
282.IP "dns-case-preserving = yes|true|on | no|false|off" 4
283.IX Item "dns-case-preserving = yes|true|on | no|false|off"
284Sets whether the \s-1DNS\s0 transport forwarding server preserves case (\s-1DNS\s0
285servers have to, but some access systems are even more broken than others)
286(default: true).
287.Sp
288Normally, when the forwarding server changes the case of domain names then
289\&\s-1GVPE\s0 will automatically set this to false.
290.IP "dns-max-outstanding = integer-number-of-requests" 4
291.IX Item "dns-max-outstanding = integer-number-of-requests"
292The maximum number of outstanding \s-1DNS\s0 transport requests
293(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given
294limit without receiving replies. In heavily overloaded situations it might
295help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the
296number of parallel requests.
297.Sp
298The default should be working \s-1OK\s0 for most links.
299.IP "dns-overlap-factor = float" 4
300.IX Item "dns-overlap-factor = float"
301The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen
302during a connection as it's timing base. This factor (default: \f(CW0.5\fR,
303must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending
304rate (= minimum send interval), i.e. a factor of \f(CW1\fR means that a new
305request might be generated every \fBmin_latency\fR seconds, which means on
306average there should only ever be one outstanding request. A factor of
307\&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum
308latency measured.
309.Sp
310For congested or picky \s-1DNS\s0 forwarders you could use a value nearer to or
311exceeding \f(CW1\fR.
312.Sp
313The default should be working \s-1OK\s0 for most links.
314.IP "dns-send-interval = send-interval-in-seconds" 4
315.IX Item "dns-send-interval = send-interval-in-seconds"
316The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will
317use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when
318the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will
319not send more than 100 \s-1DNS\s0 requests per connection per second. For
320high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For
321congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR,
322\&\f(CW0.2\fR or even higher.
323.Sp
324The default should be working \s-1OK\s0 for most links.
325.IP "dns-timeout-factor = float" 4
326.IX Item "dns-timeout-factor = float"
327Factor to multiply the \f(CW\*(C`min_latency\*(C'\fR (see \f(CW\*(C`dns\-overlap\-factor\*(C'\fR) by to
328get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport
329will resend the request when no reply has been received for longer than
330eight times the minimum (= expected) latency, assuming the request or
331reply has been lost.
332.Sp
333For congested links a higher value might be necessary (e.g. \f(CW30\fR). If
334the link is very stable lower values (e.g. \f(CW2\fR) might work
335nicely. Values near or below \f(CW1\fR makes no sense whatsoever.
336.Sp
337The default should be working \s-1OK\s0 for most links but will result in low
338throughput if packet loss is high.
207.IP "if-up = relative-or-absolute-path" 4 339.IP "if-up = relative-or-absolute-path" 4
208.IX Item "if-up = relative-or-absolute-path" 340.IX Item "if-up = relative-or-absolute-path"
209Sets the path of a script that should be called immediately after the 341Sets the path of a script that should be called immediately after the
210network interface is initialized (but not neccessarily up). The following 342network interface is initialized (but not necessarily up). The following
211environment variables are passed to it (the values are just examples): 343environment variables are passed to it (the values are just examples).
344.Sp
345Variables that have the same value on all nodes:
212.RS 4 346.RS 4
213.IP "CONFBASE=/etc/gvpe" 4 347.IP "CONFBASE=/etc/gvpe" 4
214.IX Item "CONFBASE=/etc/gvpe" 348.IX Item "CONFBASE=/etc/gvpe"
215The configuration base directory. 349The configuration base directory.
216.IP "IFNAME=vpn0" 4 350.IP "IFNAME=vpn0" 4
217.IX Item "IFNAME=vpn0" 351.IX Item "IFNAME=vpn0"
218The interface to initialize. 352The network interface to initialize.
219.IP "MTU=1436" 4
220.IX Item "MTU=1436"
221The \s-1MTU\s0 to set the interface to. You can use lower values (if done
222consistently on all hosts), but this is usually ineffective.
223.IP "MAC=fe:fd:80:00:00:01" 4
224.IX Item "MAC=fe:fd:80:00:00:01"
225The \s-1MAC\s0 address to set the interface to. The script *must* set the
226interface \s-1MAC\s0 to this value. You will most likely use one of these:
227.Sp
228.Vb 2
229\& ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux
230\& ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD
231.Ve
232.Sp
233Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for platform-specific information.
234.IP "IFTYPE=native # or tincd" 4 353.IP "IFTYPE=native # or tincd" 4
235.IX Item "IFTYPE=native # or tincd" 354.IX Item "IFTYPE=native # or tincd"
236.PD 0 355.PD 0
237.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 356.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4
238.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." 357.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.."
239.PD 358.PD
240The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os 359The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the
241name in lowercase) that this gvpe was configured for. Can be used to select 360\&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to
242the correct syntax to use for network-related commands. 361select the correct syntax to use for network-related commands.
362.IP "MTU=1436" 4
363.IX Item "MTU=1436"
364The \s-1MTU\s0 to set the interface to. You can use lower values (if done
365consistently on all nodes), but this is usually either inefficient or
366simply ineffective.
367.IP "NODES=5" 4
368.IX Item "NODES=5"
369The number of nodes in this \s-1GVPE\s0 network.
370.RE
371.RS 4
372.Sp
373Variables that are node-specific and with values pertaining to the node
374running this \s-1GVPE:\s0
375.IP "IFUPDATA=string" 4
376.IX Item "IFUPDATA=string"
377The value of the configuration directive \f(CW\*(C`if\-up\-data\*(C'\fR.
378.IP "MAC=fe:fd:80:00:00:01" 4
379.IX Item "MAC=fe:fd:80:00:00:01"
380The \s-1MAC\s0 address the network interface has to use.
381.Sp
382Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not
383do this automatically. Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR man page for
384platform-specific information.
243.IP "NODENAME=branch1" 4 385.IP "NODENAME=branch1" 4
244.IX Item "NODENAME=branch1" 386.IX Item "NODENAME=branch1"
245The nickname of the current node, as passed to the gvpe daemon. 387The nickname of the node.
246.IP "NODEID=1" 4 388.IP "NODEID=1" 4
247.IX Item "NODEID=1" 389.IX Item "NODEID=1"
248The numerical node id of the current node. The first node mentioned in the 390The numerical node \s-1ID\s0 of the node running this instance of \s-1GVPE\s0. The first
249config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on. 391node mentioned in the config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on.
250.RE 392.RE
251.RS 4 393.RS 4
252.Sp 394.Sp
395In addition, all node-specific variables (except \f(CW\*(C`NODEID\*(C'\fR) will be
396available with a postfix of \f(CW\*(C`_nodeid\*(C'\fR, which contains the value for that
397node, e.g. the \f(CW\*(C`MAC_1\*(C'\fR variable contains the \s-1MAC\s0 address of node #1, while
398the \f(CW\*(C`NODENAME_22\*(C'\fR variable contains the name of node #22.
399.Sp
253Here is a simple if-up script: 400Here is a simple if-up script:
254.Sp 401.Sp
255.Vb 5 402.Vb 5
256\& #!/bin/sh 403\& #!/bin/sh
257\& ip link set $IFNAME address $MAC mtu $MTU up 404\& ip link set $IFNAME up
258\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME 405\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
259\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME 406\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
260\& ip route add 10.0.0.0/8 dev $IFNAME 407\& ip route add 10.0.0.0/8 dev $IFNAME
261.Ve 408.Ve
262.Sp 409.Sp
263More complicated examples (using routing to reduce arp traffic) can be 410More complicated examples (using routing to reduce \s-1ARP\s0 traffic) can be
264found in the etc/ subdirectory of the distribution. 411found in the \fIetc/\fR subdirectory of the distribution.
265.RE 412.RE
266.IP "ifname = devname" 4 413.IP "ifname = devname" 4
267.IX Item "ifname = devname" 414.IX Item "ifname = devname"
268Sets the tun interface name to the given name. The default is OS-specific 415Sets the tun interface name to the given name. The default is OS-specific
269and most probably something like \f(CW\*(C`tun0\*(C'\fR. 416and most probably something like \f(CW\*(C`tun0\*(C'\fR.
… …
276the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the 423the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the
277device. 424device.
278.IP "ip-proto = numerical-ip-protocol" 4 425.IP "ip-proto = numerical-ip-protocol" 4
279.IX Item "ip-proto = numerical-ip-protocol" 426.IX Item "ip-proto = numerical-ip-protocol"
280Sets the protocol number to be used for the rawip protocol. This is a 427Sets the protocol number to be used for the rawip protocol. This is a
281global option because all hosts must use the same protocol, and since 428global option because all nodes must use the same protocol, and since
282there are no port numbers, you cannot easily run more than one gvpe 429there are no port numbers, you cannot easily run more than one gvpe
283instance using the same protocol, nor can you share the protocol with 430instance using the same protocol, nor can you share the protocol with
284other programs. 431other programs.
285.Sp 432.Sp
286The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through 433The default is 47 (\s-1GRE\s0), which has a good chance of tunneling
287firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other 434through firewalls (but note that gvpe's rawip protocol is not \s-1GRE\s0
288common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98 435compatible). Other common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4
289(\s-1ENCAP\s0, rfc1241) 436(\s-1IPIP\s0 tunnels) or 98 (\s-1ENCAP\s0, rfc1241).
437.Sp
438Many versions of Linux seem to have a bug that causes them to reorder
439packets for some ip protocols (\s-1GRE\s0, \s-1ESP\s0) but not for others (\s-1AH\s0), so
440choose wisely (that is, use 51, \s-1AH\s0).
290.IP "http-proxy-host = hostname/ip" 4 441.IP "http-proxy-host = hostname/ip" 4
291.IX Item "http-proxy-host = hostname/ip" 442.IX Item "http-proxy-host = hostname/ip"
292The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was 443The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was
293compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of 444compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of
294tcp connections through a http proxy server. 445tcp connections through a http proxy server.
… …
296\&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and 447\&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and
297port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy 448port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy
298requires authentication. 449requires authentication.
299.Sp 450.Sp
300Please note that gvpe will still try to resolve all hostnames in the 451Please note that gvpe will still try to resolve all hostnames in the
301configuration file, so if you are behind a proxy without access to a dns 452configuration file, so if you are behind a proxy without access to a \s-1DNS\s0
302server better use numerical \s-1IP\s0 addresses. 453server better use numerical \s-1IP\s0 addresses.
303.Sp 454.Sp
304To make best use of this option disable all protocols except tcp in your 455To make best use of this option disable all protocols except \s-1TCP\s0 in your
305config file and make sure your routers (or all other hosts) are listening 456config file and make sure your routers (or all other nodes) are listening
306on a port that the proxy allows (443, https, is a common choice). 457on a port that the proxy allows (443, https, is a common choice).
307.Sp 458.Sp
308If you have a router, connecting to it will suffice. Otherwise tcp must be 459If you have a router, connecting to it will suffice. Otherwise \s-1TCP\s0 must be
309enabled on all hosts. 460enabled on all nodes.
310.Sp 461.Sp
311Example: 462Example:
312.Sp 463.Sp
313.Vb 3 464.Vb 3
314\& http-proxy-host = proxy.example.com 465\& http\-proxy\-host = proxy.example.com
315\& http-proxy-port = 3128 # 8080 is another common choice 466\& http\-proxy\-port = 3128 # 8080 is another common choice
316\& http-proxy-auth = schmorp:grumbeere 467\& http\-proxy\-auth = schmorp:grumbeere
317.Ve 468.Ve
318.IP "http-proxy-port = proxy-tcp-port" 4 469.IP "http-proxy-port = proxy-tcp-port" 4
319.IX Item "http-proxy-port = proxy-tcp-port" 470.IX Item "http-proxy-port = proxy-tcp-port"
320The port where your proxy server listens. 471The port where your proxy server listens.
321.IP "http-proxy-auth = login:password" 4 472.IP "http-proxy-auth = login:password" 4
322.IX Item "http-proxy-auth = login:password" 473.IX Item "http-proxy-auth = login:password"
323The optional login and password used to authenticate to the proxy server, 474The optional login and password used to authenticate to the proxy server,
324seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is 475separated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is
325currently supported. 476currently supported.
326.IP "keepalive = seconds" 4 477.IP "keepalive = seconds" 4
327.IX Item "keepalive = seconds" 478.IX Item "keepalive = seconds"
328Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this 479Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this
329many seconds of inactivity the daemon will start to send keepalive probe 480many seconds of inactivity the daemon will start to send keepalive probe
330every 5 seconds until it receives a reply from the other end. If no reply 481every 3 seconds until it receives a reply from the other end. If no reply
331is received within 30 seconds, the peer is considered unreachable and the 482is received within 15 seconds, the peer is considered unreachable and the
332connection is closed. 483connection is closed.
333.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 484.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4
334.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" 485.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical"
335Set the logging level. Connection established messages are logged at level 486Set the logging level. Connection established messages are logged at level
336\&\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. 487\&\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.
337.IP "mtu = bytes" 4 488.IP "mtu = bytes" 4
338.IX Item "mtu = bytes" 489.IX Item "mtu = bytes"
339Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically 490Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically
340the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate 491the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate
341maximum overhead (e.g. udp header size, encryption blocksize...) and pass 492maximum overhead (e.g. \s-1UDP\s0 header size, encryption blocksize...) and pass
342this information to the \f(CW\*(C`if\-up\*(C'\fR script. 493this information to the \f(CW\*(C`if\-up\*(C'\fR script.
343.Sp 494.Sp
344Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). 495Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
345.Sp 496.Sp
346This value must be the minimum of the mtu values of all hosts. 497This value must be the minimum of the \s-1MTU\s0 values of all nodes.
347.IP "node = nickname" 4 498.IP "nfmark = integer" 4
348.IX Item "node = nickname" 499.IX Item "nfmark = integer"
349Not really a config setting but introduces a node section. The nickname is 500This advanced option, when set to a nonzero value (default: \f(CW0\fR), tries
350used to select the right configuration section and must be passed as an 501to set the netfilter mark (or fwmark) value on all sockets gvpe uses to
351argument to the gvpe daemon. 502send packets.
503.Sp
504This can be used to make gvpe use a different set of routing rules. For
505example, on GNU/Linux, the \f(CW\*(C`if\-up\*(C'\fR could set \f(CW\*(C`nfmark\*(C'\fR to 1000 and then
506put all routing rules into table \f(CW99\fR and then use an ip rule to make
507gvpe traffic avoid that routing table, in effect routing normal traffic
508via gvpe and gvpe traffic via the normal system routing tables:
509.Sp
510.Vb 1
511\& ip rule add not fwmark 1000 lookup 99
512.Ve
352.IP "node-up = relative-or-absolute-path" 4 513.IP "node-up = relative-or-absolute-path" 4
353.IX Item "node-up = relative-or-absolute-path" 514.IX Item "node-up = relative-or-absolute-path"
354Sets a command (default: no script) that should be called whenever a 515Sets a command (default: none) that should be called whenever a connection
355connection is established (even on rekeying operations). In addition 516is established (even on rekeying operations). Note that node\-up/down
517scripts will be run asynchronously, but execution is serialised, so there
518will only ever be one such script running.
519.Sp
356to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment 520In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following
357variables will be set: 521environment variables will be set (values are just examples):
358.RS 4 522.RS 4
359.IP "DESTNODE=branch2" 4 523.IP "DESTNODE=branch2" 4
360.IX Item "DESTNODE=branch2" 524.IX Item "DESTNODE=branch2"
361The name of the remote node. 525The name of the remote node.
362.IP "DESTID=2" 4 526.IP "DESTID=2" 4
363.IX Item "DESTID=2" 527.IX Item "DESTID=2"
364The node id of the remote node. 528The node id of the remote node.
529.IP "DESTSI=rawip/88.99.77.55:0" 4
530.IX Item "DESTSI=rawip/88.99.77.55:0"
531The \*(L"socket info\*(R" of the target node, protocol dependent but usually in
532the format protocol/ip:port.
365.IP "DESTIP=188.13.66.8" 4 533.IP "DESTIP=188.13.66.8" 4
366.IX Item "DESTIP=188.13.66.8" 534.IX Item "DESTIP=188.13.66.8"
367The numerical \s-1IP\s0 address of the remote host (gvpe accepts connections from 535The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from
368everywhere, as long as the other host can authenticate itself). 536everywhere, as long as the other node can authenticate itself).
369.IP "DESTPORT=655 # deprecated" 4 537.IP "DESTPORT=655 # deprecated" 4
370.IX Item "DESTPORT=655 # deprecated" 538.IX Item "DESTPORT=655 # deprecated"
371The \s-1UDP\s0 port used by the other side. 539The protocol port used by the other side, if applicable.
372.IP "STATE=UP" 4 540.IP "STATE=up" 4
373.IX Item "STATE=UP" 541.IX Item "STATE=up"
374Node-up scripts get called with STATE=UP, node-down scripts get called 542Node-up scripts get called with STATE=up, node-change scripts get called
375with STATE=DOWN. 543with STATE=change and node-down scripts get called with STATE=down.
376.RE 544.RE
377.RS 4 545.RS 4
378.Sp 546.Sp
379Here is a nontrivial example that uses nsupdate to update the name => ip 547Here is a nontrivial example that uses nsupdate to update the name => ip
380mapping in some dns zone: 548mapping in some \s-1DNS\s0 zone:
381.Sp 549.Sp
382.Vb 6 550.Vb 6
383\& #!/bin/sh 551\& #!/bin/sh
384\& { 552\& {
385\& echo update delete $DESTNODE.lowttl.example.net. a 553\& echo update delete $DESTNODE.lowttl.example.net. a
386\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP 554\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
387\& echo 555\& echo
388\& } | nsupdate -d -k $CONFBASE:key.example.net. 556\& } | nsupdate \-d \-k $CONFBASE:key.example.net.
389.Ve 557.Ve
390.RE 558.RE
559.IP "node-change = relative-or-absolute-path" 4
560.IX Item "node-change = relative-or-absolute-path"
561Same as \f(CW\*(C`node\-change\*(C'\fR, but gets called whenever something about a
562connection changes (such as the source \s-1IP\s0 address).
391.IP "node-down = relative-or-absolute-path" 4 563.IP "node-down = relative-or-absolute-path" 4
392.IX Item "node-down = relative-or-absolute-path" 564.IX Item "node-down = relative-or-absolute-path"
393Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. 565Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost.
394.IP "pid-file = path" 4 566.IP "pid-file = path" 4
395.IX Item "pid-file = path" 567.IX Item "pid-file = path"
396The path to the pid file to check and create 568The path to the pid file to check and create
397(default: \f(CW\*(C`LOCALSTATEDIR/run/gvpe.pid\*(C'\fR). 569(default: \f(CW\*(C`LOCALSTATEDIR/run/gvpe.pid\*(C'\fR). The first \f(CW%s\fR is replaced by
570the nodename \- any other use of \f(CW\*(C`%\*(C'\fR must be written as \f(CW\*(C`%%\*(C'\fR.
398.IP "private-key = relative-path-to-key" 4 571.IP "private-key = relative-path-to-key" 4
399.IX Item "private-key = relative-path-to-key" 572.IX Item "private-key = relative-path-to-key"
400Sets the path (relative to the config directory) to the private key 573Sets the path (relative to the config directory) to the private key
401(default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must 574(default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must
402be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could 575be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could
403use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where 576use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where
404\&\f(CW\*(C`gvpectrl\*(C'\fR puts them. 577\&\f(CW\*(C`gvpectrl\*(C'\fR puts them.
405.Sp 578.Sp
406Since only the private key file of the current node is used and the 579Since only the private key file of the current node is used and the
407private key file should be kept secret per-host to avoid spoofings, it is 580private key file should be kept secret per-node to avoid spoofing, it is
408not recommended to use this feature. 581not recommended to use this feature.
409.IP "rekey = seconds" 4 582.IP "rekey = seconds" 4
410.IX Item "rekey = seconds" 583.IX Item "rekey = seconds"
411Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are 584Sets the rekeying interval in seconds (default: \f(CW3607\fR). Connections are
412reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. 585reestablished every \f(CW\*(C`rekey\*(C'\fR seconds, making them use a new encryption
586key.
587.IP "seed-device = path" 4
588.IX Item "seed-device = path"
589The random device used to initially and regularly seed the random
590number generator (default: \fI/dev/urandom\fR). Randomness is of paramount
591importance to the security of the algorithms used in gvpe.
592.Sp
593On program start and every seed-interval, gvpe will read 64 octets.
594.Sp
595Setting this path to the empty string will disable this functionality
596completely (the underlying crypto library will likely look for entropy
597sources on it's own though, so not all is lost).
598.IP "seed-interval = seconds" 4
599.IX Item "seed-interval = seconds"
600The number of seconds between reseeds of the random number generator
601(default: \f(CW3613\fR). A value of \f(CW0\fR disables this regular reseeding.
413.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 602.SS "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
414.IX Subsection "NODE SPECIFIC SETTINGS" 603.IX Subsection "NODE SPECIFIC SETTINGS"
415The following settings are node\-specific, that is, every node can have 604The following settings are node-specific, that is, every node can have
416different settings, even within the same gvpe instance. Settings that are 605different settings, even within the same gvpe instance. Settings that are
417executed before the first node section set the defaults, settings that are 606set before the first node section set the defaults, settings that are
418executed within a node section only apply to the given node. 607set within a node section only apply to the given node.
608.IP "allow-direct = nodename" 4
609.IX Item "allow-direct = nodename"
610Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info.
419.IP "compress = yes|true|on | no|false|off" 4 611.IP "compress = yes|true|on | no|false|off" 4
420.IX Item "compress = yes|true|on | no|false|off" 612.IX Item "compress = yes|true|on | no|false|off"
613For the current node, this specified whether it will accept compressed
614packets, and for all other nodes, this specifies whether to try to
421Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). 615compress data packets sent to this node (default: \f(CW\*(C`yes\*(C'\fR). Compression is
422Compression is really cheap even on slow computers and has no size 616really cheap even on slow computers, has no size overhead at all and will
423overhead at all, so enabling this is a good idea. 617only be used when the other side supports compression, so enabling this is
618often a good idea.
424.IP "connect = ondemand | never | always | disabled" 4 619.IP "connect = ondemand | never | always | disabled" 4
425.IX Item "connect = ondemand | never | always | disabled" 620.IX Item "connect = ondemand | never | always | disabled"
426Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always 621Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always
427try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR 622try to establish and keep a connection to the given node), \f(CW\*(C`never\*(C'\fR
428(never initiate a connection to the given host, but accept connections), 623(never initiate a connection to the given host, but accept connections),
429\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and 624\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection when there are outstanding
430take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, 625packets in the queue and take it down after the keepalive interval) or
431don't talk to it). 626\&\f(CW\*(C`disabled\*(C'\fR (node is bad, don't talk to it).
627.Sp
628Routers will automatically be forced to \f(CW\*(C`always\*(C'\fR unless they are
629\&\f(CW\*(C`disabled\*(C'\fR, to ensure all nodes can talk to each other.
630.IP "deny-direct = nodename | *" 4
631.IX Item "deny-direct = nodename | *"
632Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR
633is given). Only one node can be specified, but you can use multiple
634\&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in
635networks with routers, as routers are required for indirect connections.
636.Sp
637Sometimes, a node cannot reach some other nodes for reasons of network
638connectivity. For example, a node behind a firewall that only allows
639connections to/from a single other node in the network. In this case one
640should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other
641node \fImust\fR be a router for this to work).
642.Sp
643The algorithm to check whether a connection may be direct is as follows:
644.Sp
6451. Other node mentioned in an \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection.
646.Sp
6472. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections.
648.Sp
6493. Allow the connection.
650.Sp
651That is, \f(CW\*(C`allow\-direct\*(C'\fR takes precedence over \f(CW\*(C`deny\-direct\*(C'\fR.
652.Sp
653The check is done in both directions, i.e. both nodes must allow a direct
654connection before one is attempted, so you only need to specify connect
655limitations on one node.
432.IP "dns-domain = domain-suffix" 4 656.IP "dns-domain = domain-suffix" 4
433.IX Item "dns-domain = domain-suffix" 657.IX Item "dns-domain = domain-suffix"
434The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node. 658The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node.
435.Sp 659.Sp
436The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, 660The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR,
437i.e. 661i.e.
438.Sp 662.Sp
439.Vb 2 663.Vb 2
440\& dns-domainname = tunnel.example.net 664\& dns\-domainname = tunnel.example.net
441\& dns-hostname = tunnel-server.example.net 665\& dns\-hostname = tunnel\-server.example.net
442.Ve 666.Ve
443.Sp 667.Sp
444Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain: 668Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain:
445.Sp 669.Sp
446.Vb 2 670.Vb 2
447\& tunnel.example.net. NS tunnel-server.example.net. 671\& tunnel.example.net. NS tunnel\-server.example.net.
448\& tunnel-server.example.net. A 13.13.13.13 672\& tunnel\-server.example.net. A 13.13.13.13
449.Ve 673.Ve
450.IP "dns-hostname = hostname/ip" 4 674.IP "dns-hostname = hostname/ip" 4
451.IX Item "dns-hostname = hostname/ip" 675.IX Item "dns-hostname = hostname/ip"
452The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR, 676The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR,
453but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might 677but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might
… …
455.IP "dns-port = port-number" 4 679.IP "dns-port = port-number" 4
456.IX Item "dns-port = port-number" 680.IX Item "dns-port = port-number"
457The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers. 681The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers.
458.IP "enable-dns = yes|true|on | no|false|off" 4 682.IP "enable-dns = yes|true|on | no|false|off" 4
459.IX Item "enable-dns = yes|true|on | no|false|off" 683.IX Item "enable-dns = yes|true|on | no|false|off"
684See \fIgvpe.protocol\fR\|(7) for a description of the \s-1DNS\s0 transport
685protocol. Avoid this protocol if you can.
686.Sp
460Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as 687Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as
461client (only available when gvpe was compiled with \f(CW\*(C`\-\-enable\-dns\*(C'\fR). 688client. Support for this transport protocol is only available when gvpe
689was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option.
690.IP "enable-icmp = yes|true|on | no|false|off" 4
691.IX Item "enable-icmp = yes|true|on | no|false|off"
692See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol.
462.Sp 693.Sp
463\&\fB\s-1WARNING:\s0\fR Parsing and generating \s-1DNS\s0 packets is rather tricky. The code 694Enable the \s-1ICMP\s0 transport using \s-1ICMP\s0 packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this
464almost certainly contains buffer overflows and other, likely exploitable, 695node.
465bugs. You have been warned.
466.Sp
467This is the worst choice of transport protocol with respect to overhead
468(overhead can be 2\-3 times higher than the transferred data), and probably
469the best choice when tunneling through firewalls.
470.IP "enable-rawip = yes|true|on | no|false|off" 4 696.IP "enable-rawip = yes|true|on | no|false|off" 4
471.IX Item "enable-rawip = yes|true|on | no|false|off" 697.IX Item "enable-rawip = yes|true|on | no|false|off"
698See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol.
699.Sp
472Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol 700Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol
473(default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the minimum overhead per 701(default: \f(CW\*(C`no\*(C'\fR).
474packet is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+).
475.IP "enable-tcp = yes|true|on | no|false|off" 4 702.IP "enable-tcp = yes|true|on | no|false|off" 4
476.IX Item "enable-tcp = yes|true|on | no|false|off" 703.IX Item "enable-tcp = yes|true|on | no|false|off"
704See \fIgvpe.protocol\fR\|(7) for a description of the \s-1TCP\s0 transport protocol.
705.Sp
477Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port 706Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port
478(default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only 707(default: \f(CW\*(C`no\*(C'\fR). Support for this transport protocol is only available
479available when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never 708when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option.
480use this transport unless you really must, it is very inefficient and
481resource-intensive compared to the other transports (except for \s-1DNS\s0, which
482is worse).
483.IP "enable-udp = yes|true|on | no|false|off" 4 709.IP "enable-udp = yes|true|on | no|false|off" 4
484.IX Item "enable-udp = yes|true|on | no|false|off" 710.IX Item "enable-udp = yes|true|on | no|false|off"
711See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol.
712.Sp
485Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, 713Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR).
486unless no other protocol is enabled for a node, in which case this 714.IP "hostname = hostname | ip [can not be defaulted]" 4
487protocol is enabled automatically). This is a good general choice since 715.IX Item "hostname = hostname | ip [can not be defaulted]"
488\&\s-1UDP\s0 tunnels well through many firewalls. 716Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0
717address. It will be resolved before each connect request, so dyndns should
718work fine. If this setting is not specified and a router is available,
719then the router will be queried for the address of this node. Otherwise,
720the connection attempt will fail.
489.Sp 721.Sp
490\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though 722Note that \s-1DNS\s0 resolving is done synchronously, pausing the daemon. If that
491it might get switched on automatically, as some future version might 723is an issue you need to specify \s-1IP\s0 addresses.
492default to another default protocol. 724.IP "icmp-type = integer" 4
725.IX Item "icmp-type = integer"
726Sets the type value to be used for outgoing (and incoming) packets sent
727via the \s-1ICMP\s0 transport.
728.Sp
729The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as
730\&\*(L"ping-reply\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a.
731\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used.
732.IP "if-up-data = value" 4
733.IX Item "if-up-data = value"
734The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR
735script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR.
493.IP "inherit-tos = yes|true|on | no|false|off" 4 736.IP "inherit-tos = yes|true|on | no|false|off" 4
494.IX Item "inherit-tos = yes|true|on | no|false|off" 737.IX Item "inherit-tos = yes|true|on | no|false|off"
495Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when 738Whether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when
496sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then 739sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then
497outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent 740outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
498to the tunnel device, which is usually what you want. 741to the tunnel device, which is usually what you want.
499.IP "max-retry = positive-number" 4 742.IP "max-retry = positive-number" 4
500.IX Item "max-retry = positive-number" 743.IX Item "max-retry = positive-number"
501The maximum interval in seconds (default: \f(CW3600\fR, one hour) between 744The maximum interval in seconds (default: \f(CW3600\fR, one hour) between
502retries to establish a connection to this node. When a connection cannot 745retries to establish a connection to this node. When a connection cannot
503be established, gvpe uses exponential backoff capped at this value. It's 746be established, gvpe uses exponential back-off capped at this value. It's
504sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on 747sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on
505connections to routers that usually are stable but sometimes are down, to 748connections to routers that usually are stable but sometimes are down, to
506assure quick reconnections even after longer downtimes. 749assure quick reconnections even after longer downtimes.
750.IP "max-ttl = seconds" 4
751.IX Item "max-ttl = seconds"
752Expire packets that couldn't be sent after this many seconds
753(default: \f(CW60\fR). Gvpe will normally queue packets for a node without an
754active connection, in the hope of establishing a connection soon. This
755value specifies the maximum lifetime a packet will stay in the queue, if a
756packet gets older, it will be thrown away.
757.IP "max-queue = positive\-number>=1" 4
758.IX Item "max-queue = positive-number>=1"
759The maximum number of packets that will be queued (default: \f(CW512\fR)
760for this node. If more packets are sent then earlier packets will be
761expired. See \f(CW\*(C`max\-ttl\*(C'\fR, above.
507.IP "router-priority = 0 | 1 | positive\-number>=2" 4 762.IP "router-priority = 0 | 1 | positive\-number>=2" 4
508.IX Item "router-priority = 0 | 1 | positive-number>=2" 763.IX Item "router-priority = 0 | 1 | positive-number>=2"
509Sets the router priority of the given host (default: \f(CW0\fR, disabled). If 764Sets the router priority of the given node (default: \f(CW0\fR, disabled).
510some host tries to connect to another host without a hostname, it asks
511the router host for it's \s-1IP\s0 address. The router host is the one with the
512highest priority larger than \f(CW1\fR that is currently reachable.
513.Sp 765.Sp
514Make sure all hosts always connect (\f(CW\*(C`connect = always\*(C'\fR) to the router 766If some node tries to connect to another node but it doesn't have a
515hosts, otherwise connecting to them might be impossible. 767hostname, it asks a router node for it's \s-1IP\s0 address. The router node
768chosen is the one with the highest priority larger than \f(CW1\fR that is
769currently reachable. This is called a \fImediated\fR connection, as the
770connection itself will still be direct, but it uses another node to
771mediate between the two nodes.
772.Sp
773The value \f(CW0\fR disables routing, that means if the node receives a packet
774not for itself it will not forward it but instead drop it.
516.Sp 775.Sp
517The special value \f(CW1\fR allows other hosts to route through the router 776The special value \f(CW1\fR allows other hosts to route through the router
518host, but they will never route through it by default. The value \f(CW0\fR 777host, but they will never route through it by default (i.e. the config
519disables routing. The idea behind this is that some hosts can, if 778file of another node needs to specify a router priority higher than one
779to choose such a node for routing).
780.Sp
781The idea behind this is that some hosts can, if required, bump the
520required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their 782\&\f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their local config to
521local config to route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is 783route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is \f(CW0\fR, then routing
522\&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do 784will be refused, so \f(CW1\fR serves as a \*(L"enable, but do not use by default\*(R"
523not use by default\*(R" switch. 785switch.
786.Sp
787Nodes with \f(CW\*(C`router\-priority\*(C'\fR set to \f(CW2\fR or higher will always be forced
788to \f(CW\*(C`connect\*(C'\fR = \f(CW\*(C`always\*(C'\fR (unless they are \f(CW\*(C`disabled\*(C'\fR).
524.IP "tcp-port = port-number" 4 789.IP "tcp-port = port-number" 4
525.IX Item "tcp-port = port-number" 790.IX Item "tcp-port = port-number"
526Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. 791Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number.
527.IP "udp-port = port-number" 4 792.IP "udp-port = port-number" 4
528.IX Item "udp-port = port-number" 793.IX Item "udp-port = port-number"
529Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not 794Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
530officially assigned by \s-1IANA\s0!). 795officially assigned by \s-1IANA\s0!).
531.SH "CONFIG DIRECTORY LAYOUT" 796.SH "CONFIG DIRECTORY LAYOUT"
532.IX Header "CONFIG DIRECTORY LAYOUT" 797.IX Header "CONFIG DIRECTORY LAYOUT"
533The default (or recommended) directory layout for the config directory is: 798The default (or recommended) directory layout for the config directory is:
534.IP "\(bu" 4 799.IP "gvpe.conf" 4
535.IX Xref "gvpe.conf" 800.IX Item "gvpe.conf"
536The config file. 801The config file.
537.IP "\(bu" 4 802.IP "if-up" 4
538.IX Xref "if-up" 803.IX Item "if-up"
539The if-up script 804The if-up script
540.IP "," 4 805.IP "node-up, node-down" 4
541.IX Xref "node-up node-down" 806.IX Item "node-up, node-down"
542If used the node up or node-down scripts. 807If used the node up or node-down scripts.
543.IP "\(bu" 4 808.IP "hostkey" 4
544.IX Xref "hostkey" 809.IX Item "hostkey"
545The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. 810The (default path of the) private key of the current host.
546.IP "\(bu" 4 811.IP "pubkey/nodename" 4
547.IX Xref "pubkey nodename" 812.IX Item "pubkey/nodename"
548The public keys of the other nodes, one file per node. 813The public keys of the other nodes, one file per node.
549.SH "SEE ALSO" 814.SH "SEE ALSO"
550.IX Header "SEE ALSO" 815.IX Header "SEE ALSO"
551\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). 816\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).
552.SH "AUTHOR" 817.SH "AUTHOR"
553.IX Header "AUTHOR" 818.IX Header "AUTHOR"
554Marc Lehmann <gvpe@plan9.de> 819Marc Lehmann <gvpe@schmorp.de>

Diff Legend

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