ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/gvpe/doc/gvpe.conf.5
(Generate patch)

Comparing gvpe/doc/gvpe.conf.5 (file contents):
Revision 1.13 by pcg, Wed Mar 23 21:55:39 2005 UTC vs.
Revision 1.33 by root, Fri Jul 19 21:01:16 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-23" "1.9" "GNU Virtual Private Ethernet" 127.TH GVPE.CONF 5 "2013-07-18" "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.
207.IP "dns-max-outstanding = integer-number-of-requests" 4 290.IP "dns-max-outstanding = integer-number-of-requests" 4
208.IX Item "dns-max-outstanding = integer-number-of-requests" 291.IX Item "dns-max-outstanding = integer-number-of-requests"
209The maximum number of outstanding \s-1DNS\s0 transport requests 292The maximum number of outstanding \s-1DNS\s0 transport requests
210(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given 293(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given
211limit without receiving replies. In heavily overloaded situations it might 294limit without receiving replies. In heavily overloaded situations it might
212help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the 295help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the
213number of parallel requests. 296number of parallel requests.
214.Sp 297.Sp
215The default should be working ok for most links. 298The default should be working \s-1OK\s0 for most links.
216.IP "dns-overlap-factor = float" 4 299.IP "dns-overlap-factor = float" 4
217.IX Item "dns-overlap-factor = float" 300.IX Item "dns-overlap-factor = float"
218The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen 301The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen
219during a connection as it's timing base. This factor (default: \f(CW0.5\fR, 302during a connection as it's timing base. This factor (default: \f(CW0.5\fR,
220must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending 303must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending
… …
222request might be generated every \fBmin_latency\fR seconds, which means on 305request might be generated every \fBmin_latency\fR seconds, which means on
223average there should only ever be one outstanding request. A factor of 306average there should only ever be one outstanding request. A factor of
224\&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum 307\&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum
225latency measured. 308latency measured.
226.Sp 309.Sp
227For congested or picky dns forwarders you could use a value nearer to or 310For congested or picky \s-1DNS\s0 forwarders you could use a value nearer to or
228exceeding \f(CW1\fR. 311exceeding \f(CW1\fR.
229.Sp 312.Sp
230The default should be working ok for most links. 313The default should be working \s-1OK\s0 for most links.
231.IP "dns-send-interval = send-interval-in-seconds" 4 314.IP "dns-send-interval = send-interval-in-seconds" 4
232.IX Item "dns-send-interval = send-interval-in-seconds" 315.IX Item "dns-send-interval = send-interval-in-seconds"
233The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will 316The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will
234use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when 317use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when
235the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will 318the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will
236not send more than 100 \s-1DNS\s0 requests per connection per second. For 319not send more than 100 \s-1DNS\s0 requests per connection per second. For
237high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For 320high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For
238congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR, 321congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR,
239\&\f(CW0.2\fR or even higher. 322\&\f(CW0.2\fR or even higher.
240.Sp 323.Sp
241The default should be working ok for most links. 324The default should be working \s-1OK\s0 for most links.
242.IP "dns-timeout-factor = float" 4 325.IP "dns-timeout-factor = float" 4
243.IX Item "dns-timeout-factor = float" 326.IX Item "dns-timeout-factor = float"
244Factor to multiply the \f(CW\*(C`min_latency\*(C'\fR (see \f(CW\*(C`dns\-overlap\-factor\*(C'\fR) by to 327Factor to multiply the \f(CW\*(C`min_latency\*(C'\fR (see \f(CW\*(C`dns\-overlap\-factor\*(C'\fR) by to
245get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport 328get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport
246will resend the request when no reply has been received for longer than 329will resend the request when no reply has been received for longer than
247eight times the minimum (= expected) latency, assuming the request or 330eight times the minimum (= expected) latency, assuming the request or
248reply has been lost. 331reply has been lost.
249.Sp 332.Sp
250For congested links a higher value might be necessary (e.g. \f(CW30\fR). If the 333For congested links a higher value might be necessary (e.g. \f(CW30\fR). If
251link is very stable lower values (e.g. \f(CW2\fR) might work nicely. Values 334the link is very stable lower values (e.g. \f(CW2\fR) might work
252near or below \f(CW1\fR makes no sense whatsoever. 335nicely. Values near or below \f(CW1\fR makes no sense whatsoever.
253.Sp 336.Sp
254The default should be working ok for most links. 337The default should be working \s-1OK\s0 for most links but will result in low
338throughput if packet loss is high.
255.IP "if-up = relative-or-absolute-path" 4 339.IP "if-up = relative-or-absolute-path" 4
256.IX Item "if-up = relative-or-absolute-path" 340.IX Item "if-up = relative-or-absolute-path"
257Sets 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
258network interface is initialized (but not neccessarily up). The following 342network interface is initialized (but not necessarily up). The following
259environment 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:
260.RS 4 346.RS 4
261.IP "CONFBASE=/etc/gvpe" 4 347.IP "CONFBASE=/etc/gvpe" 4
262.IX Item "CONFBASE=/etc/gvpe" 348.IX Item "CONFBASE=/etc/gvpe"
263The configuration base directory. 349The configuration base directory.
264.IP "IFNAME=vpn0" 4 350.IP "IFNAME=vpn0" 4
265.IX Item "IFNAME=vpn0" 351.IX Item "IFNAME=vpn0"
266The interface to initialize. 352The network interface to initialize.
267.IP "MTU=1436" 4
268.IX Item "MTU=1436"
269The \s-1MTU\s0 to set the interface to. You can use lower values (if done
270consistently on all hosts), but this is usually ineffective.
271.IP "MAC=fe:fd:80:00:00:01" 4
272.IX Item "MAC=fe:fd:80:00:00:01"
273The \s-1MAC\s0 address to set the interface to. The script *must* set the
274interface \s-1MAC\s0 to this value. You will most likely use one of these:
275.Sp
276.Vb 2
277\& ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux
278\& ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD
279.Ve
280.Sp
281Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for platform-specific information.
282.IP "IFTYPE=native # or tincd" 4 353.IP "IFTYPE=native # or tincd" 4
283.IX Item "IFTYPE=native # or tincd" 354.IX Item "IFTYPE=native # or tincd"
284.PD 0 355.PD 0
285.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 356.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4
286.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." 357.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.."
287.PD 358.PD
288The 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
289name 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
290the 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.
291.IP "NODENAME=branch1" 4 385.IP "NODENAME=branch1" 4
292.IX Item "NODENAME=branch1" 386.IX Item "NODENAME=branch1"
293The nickname of the current node, as passed to the gvpe daemon. 387The nickname of the node.
294.IP "NODEID=1" 4 388.IP "NODEID=1" 4
295.IX Item "NODEID=1" 389.IX Item "NODEID=1"
296The 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
297config 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.
298.RE 392.RE
299.RS 4 393.RS 4
300.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
301Here is a simple if-up script: 400Here is a simple if-up script:
302.Sp 401.Sp
303.Vb 5 402.Vb 5
304\& #!/bin/sh 403\& #!/bin/sh
305\& ip link set $IFNAME address $MAC mtu $MTU up 404\& ip link set $IFNAME up
306\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME 405\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
307\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME 406\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
308\& ip route add 10.0.0.0/8 dev $IFNAME 407\& ip route add 10.0.0.0/8 dev $IFNAME
309.Ve 408.Ve
310.Sp 409.Sp
311More complicated examples (using routing to reduce arp traffic) can be 410More complicated examples (using routing to reduce \s-1ARP\s0 traffic) can be
312found in the etc/ subdirectory of the distribution. 411found in the \fIetc/\fR subdirectory of the distribution.
313.RE 412.RE
314.IP "ifname = devname" 4 413.IP "ifname = devname" 4
315.IX Item "ifname = devname" 414.IX Item "ifname = devname"
316Sets 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
317and most probably something like \f(CW\*(C`tun0\*(C'\fR. 416and most probably something like \f(CW\*(C`tun0\*(C'\fR.
… …
324the 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
325device. 424device.
326.IP "ip-proto = numerical-ip-protocol" 4 425.IP "ip-proto = numerical-ip-protocol" 4
327.IX Item "ip-proto = numerical-ip-protocol" 426.IX Item "ip-proto = numerical-ip-protocol"
328Sets 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
329global option because all hosts must use the same protocol, and since 428global option because all nodes must use the same protocol, and since
330there 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
331instance using the same protocol, nor can you share the protocol with 430instance using the same protocol, nor can you share the protocol with
332other programs. 431other programs.
333.Sp 432.Sp
334The 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
335firewalls (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
336common 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
337(\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).
338.IP "http-proxy-host = hostname/ip" 4 441.IP "http-proxy-host = hostname/ip" 4
339.IX Item "http-proxy-host = hostname/ip" 442.IX Item "http-proxy-host = hostname/ip"
340The \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
341compiled 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
342tcp connections through a http proxy server. 445tcp connections through a http proxy server.
… …
344\&\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
345port 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
346requires authentication. 449requires authentication.
347.Sp 450.Sp
348Please 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
349configuration 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
350server better use numerical \s-1IP\s0 addresses. 453server better use numerical \s-1IP\s0 addresses.
351.Sp 454.Sp
352To 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
353config 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
354on 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).
355.Sp 458.Sp
356If 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
357enabled on all hosts. 460enabled on all nodes.
358.Sp 461.Sp
359Example: 462Example:
360.Sp 463.Sp
361.Vb 3 464.Vb 3
362\& http-proxy-host = proxy.example.com 465\& http\-proxy\-host = proxy.example.com
363\& http-proxy-port = 3128 # 8080 is another common choice 466\& http\-proxy\-port = 3128 # 8080 is another common choice
364\& http-proxy-auth = schmorp:grumbeere 467\& http\-proxy\-auth = schmorp:grumbeere
365.Ve 468.Ve
366.IP "http-proxy-port = proxy-tcp-port" 4 469.IP "http-proxy-port = proxy-tcp-port" 4
367.IX Item "http-proxy-port = proxy-tcp-port" 470.IX Item "http-proxy-port = proxy-tcp-port"
368The port where your proxy server listens. 471The port where your proxy server listens.
369.IP "http-proxy-auth = login:password" 4 472.IP "http-proxy-auth = login:password" 4
370.IX Item "http-proxy-auth = login:password" 473.IX Item "http-proxy-auth = login:password"
371The optional login and password used to authenticate to the proxy server, 474The optional login and password used to authenticate to the proxy server,
372seperated 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
373currently supported. 476currently supported.
374.IP "keepalive = seconds" 4 477.IP "keepalive = seconds" 4
375.IX Item "keepalive = seconds" 478.IX Item "keepalive = seconds"
376Sets 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
377many seconds of inactivity the daemon will start to send keepalive probe 480many seconds of inactivity the daemon will start to send keepalive probe
378every 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
379is received within 30 seconds, the peer is considered unreachable and the 482is received within 15 seconds, the peer is considered unreachable and the
380connection is closed. 483connection is closed.
381.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 484.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4
382.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" 485.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical"
383Set the logging level. Connection established messages are logged at level 486Set the logging level. Connection established messages are logged at level
384\&\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.
385.IP "mtu = bytes" 4 488.IP "mtu = bytes" 4
386.IX Item "mtu = bytes" 489.IX Item "mtu = bytes"
387Sets 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
388the \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
389maximum overhead (e.g. udp header size, encryption blocksize...) and pass 492maximum overhead (e.g. \s-1UDP\s0 header size, encryption blocksize...) and pass
390this information to the \f(CW\*(C`if\-up\*(C'\fR script. 493this information to the \f(CW\*(C`if\-up\*(C'\fR script.
391.Sp 494.Sp
392Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). 495Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
393.Sp 496.Sp
394This 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.
395.IP "node = nickname" 4 498.IP "nfmark = integer" 4
396.IX Item "node = nickname" 499.IX Item "nfmark = integer"
397Not 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
398used 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
399argument 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
400.IP "node-up = relative-or-absolute-path" 4 513.IP "node-up = relative-or-absolute-path" 4
401.IX Item "node-up = relative-or-absolute-path" 514.IX Item "node-up = relative-or-absolute-path"
402Sets a command (default: no script) that should be called whenever a 515Sets a command (default: none) that should be called whenever a connection
403connection 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
404to 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
405variables will be set: 521environment variables will be set (values are just examples):
406.RS 4 522.RS 4
407.IP "DESTNODE=branch2" 4 523.IP "DESTNODE=branch2" 4
408.IX Item "DESTNODE=branch2" 524.IX Item "DESTNODE=branch2"
409The name of the remote node. 525The name of the remote node.
410.IP "DESTID=2" 4 526.IP "DESTID=2" 4
411.IX Item "DESTID=2" 527.IX Item "DESTID=2"
412The 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.
413.IP "DESTIP=188.13.66.8" 4 533.IP "DESTIP=188.13.66.8" 4
414.IX Item "DESTIP=188.13.66.8" 534.IX Item "DESTIP=188.13.66.8"
415The 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
416everywhere, as long as the other host can authenticate itself). 536everywhere, as long as the other node can authenticate itself).
417.IP "DESTPORT=655 # deprecated" 4 537.IP "DESTPORT=655 # deprecated" 4
418.IX Item "DESTPORT=655 # deprecated" 538.IX Item "DESTPORT=655 # deprecated"
419The \s-1UDP\s0 port used by the other side. 539The protocol port used by the other side, if applicable.
420.IP "STATE=UP" 4 540.IP "STATE=up" 4
421.IX Item "STATE=UP" 541.IX Item "STATE=up"
422Node-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
423with STATE=DOWN. 543with STATE=change and node-down scripts get called with STATE=down.
424.RE 544.RE
425.RS 4 545.RS 4
426.Sp 546.Sp
427Here 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
428mapping in some dns zone: 548mapping in some \s-1DNS\s0 zone:
429.Sp 549.Sp
430.Vb 6 550.Vb 6
431\& #!/bin/sh 551\& #!/bin/sh
432\& { 552\& {
433\& echo update delete $DESTNODE.lowttl.example.net. a 553\& echo update delete $DESTNODE.lowttl.example.net. a
434\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP 554\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
435\& echo 555\& echo
436\& } | nsupdate -d -k $CONFBASE:key.example.net. 556\& } | nsupdate \-d \-k $CONFBASE:key.example.net.
437.Ve 557.Ve
438.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).
439.IP "node-down = relative-or-absolute-path" 4 563.IP "node-down = relative-or-absolute-path" 4
440.IX Item "node-down = relative-or-absolute-path" 564.IX Item "node-down = relative-or-absolute-path"
441Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. 565Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost.
442.IP "pid-file = path" 4 566.IP "pid-file = path" 4
443.IX Item "pid-file = path" 567.IX Item "pid-file = path"
444The path to the pid file to check and create 568The path to the pid file to check and create
445(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.
446.IP "private-key = relative-path-to-key" 4 571.IP "private-key = relative-path-to-key" 4
447.IX Item "private-key = relative-path-to-key" 572.IX Item "private-key = relative-path-to-key"
448Sets the path (relative to the config directory) to the private key 573Sets the path (relative to the config directory) to the private key
449(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
450be 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
451use 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
452\&\f(CW\*(C`gvpectrl\*(C'\fR puts them. 577\&\f(CW\*(C`gvpectrl\*(C'\fR puts them.
453.Sp 578.Sp
454Since 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
455private 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
456not recommended to use this feature. 581not recommended to use this feature.
457.IP "rekey = seconds" 4 582.IP "rekey = seconds" 4
458.IX Item "rekey = seconds" 583.IX Item "rekey = seconds"
459Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are 584Sets the rekeying interval in seconds (default: \f(CW3607\fR). Connections are
460reestablished 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.
602.IP "serial = string" 4
603.IX Item "serial = string"
604The configuration serial number. This can be any string up to 16 bytes
605length. Only when the serial matches on both sides of a conenction will
606the connection succeed. This is \fInot\fR a security mechanism and eay to
607spoof, this mechanism exists to alert users that their config is outdated.
608.Sp
609It's recommended to specify this is a date string such as \f(CW\*(C`2013\-05\-05\*(C'\fR or
610\&\f(CW\*(C`20121205084417).\*(C'\fR
611.Sp
612The exact algorithm is as this: if a connection request is received form a
613node with an identical serial, then it succeeds normally.
614.Sp
615If the remote serial is lower than the local serial, it is ignored.
616.Sp
617If the remote serial is higher than the local serial, a warning message is
618logged.
461.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 619.SS "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
462.IX Subsection "NODE SPECIFIC SETTINGS" 620.IX Subsection "NODE SPECIFIC SETTINGS"
463The following settings are node\-specific, that is, every node can have 621The following settings are node-specific, that is, every node can have
464different settings, even within the same gvpe instance. Settings that are 622different settings, even within the same gvpe instance. Settings that are
465executed before the first node section set the defaults, settings that are 623set before the first node section set the defaults, settings that are
466executed within a node section only apply to the given node. 624set within a node section only apply to the given node.
625.IP "allow-direct = nodename" 4
626.IX Item "allow-direct = nodename"
627Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info.
467.IP "compress = yes|true|on | no|false|off" 4 628.IP "compress = yes|true|on | no|false|off" 4
468.IX Item "compress = yes|true|on | no|false|off" 629.IX Item "compress = yes|true|on | no|false|off"
630For the current node, this specified whether it will accept compressed
631packets, and for all other nodes, this specifies whether to try to
469Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). 632compress data packets sent to this node (default: \f(CW\*(C`yes\*(C'\fR). Compression is
470Compression is really cheap even on slow computers and has no size 633really cheap even on slow computers, has no size overhead at all and will
471overhead at all, so enabling this is a good idea. 634only be used when the other side supports compression, so enabling this is
635often a good idea.
472.IP "connect = ondemand | never | always | disabled" 4 636.IP "connect = ondemand | never | always | disabled" 4
473.IX Item "connect = ondemand | never | always | disabled" 637.IX Item "connect = ondemand | never | always | disabled"
474Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always 638Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always
475try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR 639try to establish and keep a connection to the given node), \f(CW\*(C`never\*(C'\fR
476(never initiate a connection to the given host, but accept connections), 640(never initiate a connection to the given host, but accept connections),
477\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and 641\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection when there are outstanding
478take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, 642packets in the queue and take it down after the keepalive interval) or
479don't talk to it). 643\&\f(CW\*(C`disabled\*(C'\fR (node is bad, don't talk to it).
644.Sp
645Routers will automatically be forced to \f(CW\*(C`always\*(C'\fR unless they are
646\&\f(CW\*(C`disabled\*(C'\fR, to ensure all nodes can talk to each other.
647.IP "deny-direct = nodename | *" 4
648.IX Item "deny-direct = nodename | *"
649Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR
650is given). Only one node can be specified, but you can use multiple
651\&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in
652networks with routers, as routers are required for indirect connections.
653.Sp
654Sometimes, a node cannot reach some other nodes for reasons of network
655connectivity. For example, a node behind a firewall that only allows
656connections to/from a single other node in the network. In this case one
657should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other
658node \fImust\fR be a router for this to work).
659.Sp
660The algorithm to check whether a connection may be direct is as follows:
661.Sp
6621. Other node mentioned in an \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection.
663.Sp
6642. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections.
665.Sp
6663. Allow the connection.
667.Sp
668That is, \f(CW\*(C`allow\-direct\*(C'\fR takes precedence over \f(CW\*(C`deny\-direct\*(C'\fR.
669.Sp
670The check is done in both directions, i.e. both nodes must allow a direct
671connection before one is attempted, so you only need to specify connect
672limitations on one node.
480.IP "dns-domain = domain-suffix" 4 673.IP "dns-domain = domain-suffix" 4
481.IX Item "dns-domain = domain-suffix" 674.IX Item "dns-domain = domain-suffix"
482The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node. 675The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node.
483.Sp 676.Sp
484The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, 677The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR,
485i.e. 678i.e.
486.Sp 679.Sp
487.Vb 2 680.Vb 2
488\& dns-domainname = tunnel.example.net 681\& dns\-domainname = tunnel.example.net
489\& dns-hostname = tunnel-server.example.net 682\& dns\-hostname = tunnel\-server.example.net
490.Ve 683.Ve
491.Sp 684.Sp
492Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain: 685Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain:
493.Sp 686.Sp
494.Vb 2 687.Vb 2
495\& tunnel.example.net. NS tunnel-server.example.net. 688\& tunnel.example.net. NS tunnel\-server.example.net.
496\& tunnel-server.example.net. A 13.13.13.13 689\& tunnel\-server.example.net. A 13.13.13.13
497.Ve 690.Ve
498.IP "dns-hostname = hostname/ip" 4 691.IP "dns-hostname = hostname/ip" 4
499.IX Item "dns-hostname = hostname/ip" 692.IX Item "dns-hostname = hostname/ip"
500The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR, 693The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR,
501but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might 694but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might
… …
513was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option. 706was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option.
514.IP "enable-icmp = yes|true|on | no|false|off" 4 707.IP "enable-icmp = yes|true|on | no|false|off" 4
515.IX Item "enable-icmp = yes|true|on | no|false|off" 708.IX Item "enable-icmp = yes|true|on | no|false|off"
516See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol. 709See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol.
517.Sp 710.Sp
518Enable the \s-1ICMP\s0 transport using icmp packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this 711Enable the \s-1ICMP\s0 transport using \s-1ICMP\s0 packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this
519node. 712node.
520.IP "enable-rawip = yes|true|on | no|false|off" 4 713.IP "enable-rawip = yes|true|on | no|false|off" 4
521.IX Item "enable-rawip = yes|true|on | no|false|off" 714.IX Item "enable-rawip = yes|true|on | no|false|off"
522See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol. 715See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol.
523.Sp 716.Sp
… …
532when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. 725when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option.
533.IP "enable-udp = yes|true|on | no|false|off" 4 726.IP "enable-udp = yes|true|on | no|false|off" 4
534.IX Item "enable-udp = yes|true|on | no|false|off" 727.IX Item "enable-udp = yes|true|on | no|false|off"
535See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol. 728See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol.
536.Sp 729.Sp
537Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, 730Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR).
538unless no other protocol is enabled for a node, in which case this 731.IP "hostname = hostname | ip [can not be defaulted]" 4
539protocol is enabled automatically). 732.IX Item "hostname = hostname | ip [can not be defaulted]"
733Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0
734address. It will be resolved before each connect request, so dyndns should
735work fine. If this setting is not specified and a router is available,
736then the router will be queried for the address of this node. Otherwise,
737the connection attempt will fail.
540.Sp 738.Sp
541\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though 739Note that \s-1DNS\s0 resolving is done synchronously, pausing the daemon. If that
542it might get switched on automatically, as some future version might 740is an issue you need to specify \s-1IP\s0 addresses.
543default to another default protocol.
544.IP "icmp-type = integer" 4 741.IP "icmp-type = integer" 4
545.IX Item "icmp-type = integer" 742.IX Item "icmp-type = integer"
546Sets the type value to be used for outgoing (and incoming) packets sent 743Sets the type value to be used for outgoing (and incoming) packets sent
547via the \s-1ICMP\s0 transport. 744via the \s-1ICMP\s0 transport.
548.Sp 745.Sp
549The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as 746The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as
550\&\*(L"ping\-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. 747\&\*(L"ping-reply\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a.
551\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. 748\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used.
749.IP "if-up-data = value" 4
750.IX Item "if-up-data = value"
751The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR
752script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR.
552.IP "inherit-tos = yes|true|on | no|false|off" 4 753.IP "inherit-tos = yes|true|on | no|false|off" 4
553.IX Item "inherit-tos = yes|true|on | no|false|off" 754.IX Item "inherit-tos = yes|true|on | no|false|off"
554Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when 755Whether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when
555sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then 756sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then
556outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent 757outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
557to the tunnel device, which is usually what you want. 758to the tunnel device, which is usually what you want.
558.IP "max-retry = positive-number" 4 759.IP "max-retry = positive-number" 4
559.IX Item "max-retry = positive-number" 760.IX Item "max-retry = positive-number"
560The maximum interval in seconds (default: \f(CW3600\fR, one hour) between 761The maximum interval in seconds (default: \f(CW3600\fR, one hour) between
561retries to establish a connection to this node. When a connection cannot 762retries to establish a connection to this node. When a connection cannot
562be established, gvpe uses exponential backoff capped at this value. It's 763be established, gvpe uses exponential back-off capped at this value. It's
563sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on 764sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on
564connections to routers that usually are stable but sometimes are down, to 765connections to routers that usually are stable but sometimes are down, to
565assure quick reconnections even after longer downtimes. 766assure quick reconnections even after longer downtimes.
767.IP "max-ttl = seconds" 4
768.IX Item "max-ttl = seconds"
769Expire packets that couldn't be sent after this many seconds
770(default: \f(CW60\fR). Gvpe will normally queue packets for a node without an
771active connection, in the hope of establishing a connection soon. This
772value specifies the maximum lifetime a packet will stay in the queue, if a
773packet gets older, it will be thrown away.
774.IP "max-queue = positive\-number>=1" 4
775.IX Item "max-queue = positive-number>=1"
776The maximum number of packets that will be queued (default: \f(CW512\fR)
777for this node. If more packets are sent then earlier packets will be
778expired. See \f(CW\*(C`max\-ttl\*(C'\fR, above.
566.IP "router-priority = 0 | 1 | positive\-number>=2" 4 779.IP "router-priority = 0 | 1 | positive\-number>=2" 4
567.IX Item "router-priority = 0 | 1 | positive-number>=2" 780.IX Item "router-priority = 0 | 1 | positive-number>=2"
568Sets the router priority of the given host (default: \f(CW0\fR, disabled). If 781Sets the router priority of the given node (default: \f(CW0\fR, disabled).
569some host tries to connect to another host without a hostname, it asks
570the router host for it's \s-1IP\s0 address. The router host is the one with the
571highest priority larger than \f(CW1\fR that is currently reachable.
572.Sp 782.Sp
573Make sure all hosts always connect (\f(CW\*(C`connect = always\*(C'\fR) to the router 783If some node tries to connect to another node but it doesn't have a
574hosts, otherwise connecting to them might be impossible. 784hostname, it asks a router node for it's \s-1IP\s0 address. The router node
785chosen is the one with the highest priority larger than \f(CW1\fR that is
786currently reachable. This is called a \fImediated\fR connection, as the
787connection itself will still be direct, but it uses another node to
788mediate between the two nodes.
789.Sp
790The value \f(CW0\fR disables routing, that means if the node receives a packet
791not for itself it will not forward it but instead drop it.
575.Sp 792.Sp
576The special value \f(CW1\fR allows other hosts to route through the router 793The special value \f(CW1\fR allows other hosts to route through the router
577host, but they will never route through it by default. The value \f(CW0\fR 794host, but they will never route through it by default (i.e. the config
578disables routing. The idea behind this is that some hosts can, if 795file of another node needs to specify a router priority higher than one
796to choose such a node for routing).
797.Sp
798The idea behind this is that some hosts can, if required, bump the
579required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their 799\&\f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their local config to
580local config to route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is 800route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is \f(CW0\fR, then routing
581\&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do 801will be refused, so \f(CW1\fR serves as a \*(L"enable, but do not use by default\*(R"
582not use by default\*(R" switch. 802switch.
803.Sp
804Nodes with \f(CW\*(C`router\-priority\*(C'\fR set to \f(CW2\fR or higher will always be forced
805to \f(CW\*(C`connect\*(C'\fR = \f(CW\*(C`always\*(C'\fR (unless they are \f(CW\*(C`disabled\*(C'\fR).
583.IP "tcp-port = port-number" 4 806.IP "tcp-port = port-number" 4
584.IX Item "tcp-port = port-number" 807.IX Item "tcp-port = port-number"
585Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. 808Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number.
586.IP "udp-port = port-number" 4 809.IP "udp-port = port-number" 4
587.IX Item "udp-port = port-number" 810.IX Item "udp-port = port-number"
588Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not 811Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
589officially assigned by \s-1IANA\s0!). 812officially assigned by \s-1IANA\s0!).
590.SH "CONFIG DIRECTORY LAYOUT" 813.SH "CONFIG DIRECTORY LAYOUT"
591.IX Header "CONFIG DIRECTORY LAYOUT" 814.IX Header "CONFIG DIRECTORY LAYOUT"
592The default (or recommended) directory layout for the config directory is: 815The default (or recommended) directory layout for the config directory is:
593.IP "\(bu" 4 816.IP "gvpe.conf" 4
594.IX Xref "gvpe.conf" 817.IX Item "gvpe.conf"
595The config file. 818The config file.
596.IP "\(bu" 4 819.IP "if-up" 4
597.IX Xref "if-up" 820.IX Item "if-up"
598The if-up script 821The if-up script
599.IP "," 4 822.IP "node-up, node-down" 4
600.IX Xref "node-up node-down" 823.IX Item "node-up, node-down"
601If used the node up or node-down scripts. 824If used the node up or node-down scripts.
602.IP "\(bu" 4 825.IP "hostkey" 4
603.IX Xref "hostkey" 826.IX Item "hostkey"
604The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. 827The (default path of the) private key of the current host.
605.IP "\(bu" 4 828.IP "pubkey/nodename" 4
606.IX Xref "pubkey nodename" 829.IX Item "pubkey/nodename"
607The public keys of the other nodes, one file per node. 830The public keys of the other nodes, one file per node.
608.SH "SEE ALSO" 831.SH "SEE ALSO"
609.IX Header "SEE ALSO" 832.IX Header "SEE ALSO"
610\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). 833\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).
611.SH "AUTHOR" 834.SH "AUTHOR"
612.IX Header "AUTHOR" 835.IX Header "AUTHOR"
613Marc Lehmann <gvpe@plan9.de> 836Marc Lehmann <gvpe@schmorp.de>
837.SH "POD ERRORS"
838.IX Header "POD ERRORS"
839Hey! \fBThe above document had some coding errors, which are explained below:\fR
840.IP "Around line 516:" 4
841.IX Item "Around line 516:"
842Unterminated C<...> sequence

Diff Legend

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