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.36 by root, Wed Mar 30 04:02:50 2016 UTC

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

Diff Legend

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