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.22 by pcg, Mon Sep 1 05:31:28 2008 UTC vs.
Revision 1.36 by root, Wed Mar 30 04:02:50 2016 UTC

1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) 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
… …
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.\"
51.\" Escape single quotes in literal strings from groff's Unicode transform. 45.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq 46.ie \n(.g .ds Aq \(aq
53.el .ds Aq ' 47.el .ds Aq '
54.\" 48.\"
55.\" 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
56.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index 50.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
57.\" 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
58.\" output yourself in some meaningful fashion. 52.\" output yourself in some meaningful fashion.
59.ie \nF \{\ 53.\"
54.\" Avoid warning from groff about undefined register 'F'.
60. de IX 55.de IX
61. tm Index:\\$1\t\\n%\t"\\$2"
62.. 56..
63. nr % 0 57.nr rF 0
64. 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. \}
65.\} 69.\}
66.el \{\ 70.rr rF
67. de IX
68..
69.\}
70.\" 71.\"
71.\" 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).
72.\" Fear. Run. Save yourself. No user-serviceable parts. 73.\" Fear. Run. Save yourself. No user-serviceable parts.
73. \" fudge factors for nroff and troff 74. \" fudge factors for nroff and troff
74.if n \{\ 75.if n \{\
… …
130.\} 131.\}
131.rm #[ #] #H #V #F C 132.rm #[ #] #H #V #F C
132.\" ======================================================================== 133.\" ========================================================================
133.\" 134.\"
134.IX Title "GVPE.CONF 5" 135.IX Title "GVPE.CONF 5"
135.TH GVPE.CONF 5 "2008-09-01" "2.2" "GNU Virtual Private Ethernet" 136.TH GVPE.CONF 5 "2015-10-31" "2.25" "GNU Virtual Private Ethernet"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes 137.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents. 138.\" way too many mistakes in technical documents.
138.if n .ad l 139.if n .ad l
139.nh 140.nh
140.SH "NAME" 141.SH "NAME"
… …
166= 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
167extend 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
168after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after 169after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after
169values, but not within the variable names or values themselves. 170values, but not within the variable names or values themselves.
170.PP 171.PP
171The 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
172\&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or 173variable overwrite earlier ones.
173(if the nodename starts with \*(L"!\*(R") on all nodes except the named one.
174.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
175For example, set the \s-1MTU\s0 to \f(CW1450\fR everywhere, loglevel to \f(CW\*(C`noise\*(C'\fR on 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
176branch1, and connect to \f(CW\*(C`ondemand\*(C'\fR everywhere but on branch2: 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.
177.PP 207.Sp
178.Vb 3 208.Vb 3
179\& mtu = 1450 209\& mtu = 1450
180\& on branch1 loglevel = noise 210\& on branch1 loglevel = noise
181\& on !branch2 connect = ondemand 211\& on !branch2 connect = ondemand
182.Ve 212.Ve
183.PP 213.IP "include relative-or-absolute-path" 4
184All settings are applied \*(L"in order\*(R", that is, later settings of the same 214.IX Item "include relative-or-absolute-path"
185variable 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
186.SH "ANATOMY OF A CONFIG FILE" 237.SH "ANATOMY OF A CONFIG FILE"
187.IX Header "ANATOMY OF A CONFIG FILE" 238.IX Header "ANATOMY OF A CONFIG FILE"
188Usually, a config file starts with a few global settings (like the \s-1UDP\s0 239Usually, a config file starts with a few global settings (like the \s-1UDP\s0
189port to listen on), followed by node-specific sections that begin with a 240port to listen on), followed by node-specific sections that begin with a
190\&\f(CW\*(C`node = nickname\*(C'\fR line. 241\&\f(CW\*(C`node = nickname\*(C'\fR line.
… …
196.PP 247.PP
197Node-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
198node section they will set the default values for all following nodes. 249node section they will set the default values for all following nodes.
199.SH "CONFIG VARIABLES" 250.SH "CONFIG VARIABLES"
200.IX Header "CONFIG VARIABLES" 251.IX Header "CONFIG VARIABLES"
201.Sh "\s-1GLOBAL\s0 \s-1SETTINGS\s0" 252.SS "\s-1GLOBAL SETTINGS\s0"
202.IX Subsection "GLOBAL SETTINGS" 253.IX Subsection "GLOBAL SETTINGS"
203Global settings will affect the behaviour of the running gvpe daemon, that 254Global settings will affect the behaviour of the running gvpe daemon, that
204is, 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
205values 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
206the 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).
207.IP "dns-forw-host = hostname/ip" 4 283.IP "dns-forw-host = hostname/ip" 4
208.IX Item "dns-forw-host = hostname/ip" 284.IX Item "dns-forw-host = hostname/ip"
209The \s-1DNS\s0 server to forward \s-1DNS\s0 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
210(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).
211.IP "dns-forw-port = port-number" 4 287.IP "dns-forw-port = port-number" 4
212.IX Item "dns-forw-port = port-number" 288.IX Item "dns-forw-port = port-number"
213The 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,
214which 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.
215.IP "dns-max-outstanding = integer-number-of-requests" 4 299.IP "dns-max-outstanding = integer-number-of-requests" 4
216.IX Item "dns-max-outstanding = integer-number-of-requests" 300.IX Item "dns-max-outstanding = integer-number-of-requests"
217The maximum number of outstanding \s-1DNS\s0 transport requests 301The maximum number of outstanding \s-1DNS\s0 transport requests
218(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given 302(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given
219limit without receiving replies. In heavily overloaded situations it might 303limit without receiving replies. In heavily overloaded situations it might
… …
310.IP "NODENAME=branch1" 4 394.IP "NODENAME=branch1" 4
311.IX Item "NODENAME=branch1" 395.IX Item "NODENAME=branch1"
312The nickname of the node. 396The nickname of the node.
313.IP "NODEID=1" 4 397.IP "NODEID=1" 4
314.IX Item "NODEID=1" 398.IX Item "NODEID=1"
315The numerical node \s-1ID\s0 of the node running this instance of \s-1GVPE\s0. The first 399The numerical node \s-1ID\s0 of the node running this instance of \s-1GVPE.\s0 The first
316node mentioned in the config 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.
317.RE 401.RE
318.RS 4 402.RS 4
319.Sp 403.Sp
320In addition, all node-specific variables (except \f(CW\*(C`NODEID\*(C'\fR) will be 404In addition, all node-specific variables (except \f(CW\*(C`NODEID\*(C'\fR) will be
321available with a postfix of \f(CW\*(C`_nodeid\*(C'\fR, which contains the value for that 405available with a postfix of \f(CW\*(C`_nodeid\*(C'\fR, which contains the value for that
… …
355instance using the same protocol, nor can you share the protocol with 439instance using the same protocol, nor can you share the protocol with
356other programs. 440other programs.
357.Sp 441.Sp
358The default is 47 (\s-1GRE\s0), which has a good chance of tunneling 442The default is 47 (\s-1GRE\s0), which has a good chance of tunneling
359through firewalls (but note that gvpe's rawip protocol is not \s-1GRE\s0 443through firewalls (but note that gvpe's rawip protocol is not \s-1GRE\s0
360compatible). Other common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 444compatible). Other common choices are 50 (\s-1IPSEC, ESP\s0), 51 (\s-1IPSEC, AH\s0), 4
361(\s-1IPIP\s0 tunnels) or 98 (\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).
362.IP "http-proxy-host = hostname/ip" 4 450.IP "http-proxy-host = hostname/ip" 4
363.IX Item "http-proxy-host = hostname/ip" 451.IX Item "http-proxy-host = hostname/ip"
364The \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
365compiled 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
366tcp connections through a http proxy server. 454tcp connections through a http proxy server.
… …
397currently supported. 485currently supported.
398.IP "keepalive = seconds" 4 486.IP "keepalive = seconds" 4
399.IX Item "keepalive = seconds" 487.IX Item "keepalive = seconds"
400Sets 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
401many seconds of inactivity the daemon will start to send keepalive probe 489many seconds of inactivity the daemon will start to send keepalive probe
402every 3 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
403is received within 15 seconds, the peer is considered unreachable and the 491is received within 15 seconds, the peer is considered unreachable and the
404connection is closed. 492connection is closed.
405.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 493.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4
406.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" 494.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical"
407Set the logging level. Connection established messages are logged at level 495Set the logging level. Connection established messages are logged at level
… …
414this information to the \f(CW\*(C`if\-up\*(C'\fR script. 502this information to the \f(CW\*(C`if\-up\*(C'\fR script.
415.Sp 503.Sp
416Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). 504Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
417.Sp 505.Sp
418This value must be the minimum of the \s-1MTU\s0 values of all nodes. 506This value must be the minimum of the \s-1MTU\s0 values of all nodes.
419.IP "node = nickname" 4 507.IP "nfmark = integer" 4
420.IX Item "node = nickname" 508.IX Item "nfmark = integer"
421Not 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
422used 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
423argument 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
424.IP "node-up = relative-or-absolute-path" 4 522.IP "node-up = relative-or-absolute-path" 4
425.IX Item "node-up = relative-or-absolute-path" 523.IX Item "node-up = relative-or-absolute-path"
426Sets a command (default: none) that should be called whenever a connection 524Sets a command (default: none) that should be called whenever a connection
427is established (even on rekeying operations). Note that node\-up/down 525is established (even on rekeying operations). Note that node\-up/down
428scripts will be run asynchronously, but execution is serialised, so there 526scripts will be run asynchronously, but execution is serialised, so there
429will only ever be one such script running. 527will only ever be one such script running.
430.Sp 528.Sp
431In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following 529In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following
432environment variables will be set: 530environment variables will be set (values are just examples):
433.RS 4 531.RS 4
434.IP "DESTNODE=branch2" 4 532.IP "DESTNODE=branch2" 4
435.IX Item "DESTNODE=branch2" 533.IX Item "DESTNODE=branch2"
436The name of the remote node. 534The name of the remote node.
437.IP "DESTID=2" 4 535.IP "DESTID=2" 4
438.IX Item "DESTID=2" 536.IX Item "DESTID=2"
439The 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.
440.IP "DESTIP=188.13.66.8" 4 542.IP "DESTIP=188.13.66.8" 4
441.IX Item "DESTIP=188.13.66.8" 543.IX Item "DESTIP=188.13.66.8"
442The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from 544The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from
443everywhere, as long as the other node can authenticate itself). 545everywhere, as long as the other node can authenticate itself).
444.IP "DESTPORT=655 # deprecated" 4 546.IP "DESTPORT=655 # deprecated" 4
445.IX Item "DESTPORT=655 # deprecated" 547.IX Item "DESTPORT=655 # deprecated"
446The \s-1UDP\s0 port used by the other side. 548The protocol port used by the other side, if applicable.
447.IP "STATE=UP" 4 549.IP "STATE=up" 4
448.IX Item "STATE=UP" 550.IX Item "STATE=up"
449Node-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
450with STATE=DOWN. 552with STATE=change and node-down scripts get called with STATE=down.
451.RE 553.RE
452.RS 4 554.RS 4
453.Sp 555.Sp
454Here 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
455mapping in some \s-1DNS\s0 zone: 557mapping in some \s-1DNS\s0 zone:
… …
457.Vb 6 559.Vb 6
458\& #!/bin/sh 560\& #!/bin/sh
459\& { 561\& {
460\& echo update delete $DESTNODE.lowttl.example.net. a 562\& echo update delete $DESTNODE.lowttl.example.net. a
461\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP 563\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
462\& echo 564\& echo
463\& } | nsupdate \-d \-k $CONFBASE:key.example.net. 565\& } | nsupdate \-d \-k $CONFBASE:key.example.net.
464.Ve 566.Ve
465.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).
466.IP "node-down = relative-or-absolute-path" 4 572.IP "node-down = relative-or-absolute-path" 4
467.IX Item "node-down = relative-or-absolute-path" 573.IX Item "node-down = relative-or-absolute-path"
468Same 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.
469.IP "pid-file = path" 4 575.IP "pid-file = path" 4
470.IX Item "pid-file = path" 576.IX Item "pid-file = path"
471The path to the pid file to check and create 577The path to the pid file to check and create
472(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.
473.IP "private-key = relative-path-to-key" 4 580.IP "private-key = relative-path-to-key" 4
474.IX Item "private-key = relative-path-to-key" 581.IX Item "private-key = relative-path-to-key"
475Sets the path (relative to the config directory) to the private key 582Sets the path (relative to the config directory) to the private key
476(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
477be 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
… …
481Since 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
482private key file should be kept secret per-node to avoid spoofing, it is 589private key file should be kept secret per-node to avoid spoofing, it is
483not recommended to use this feature. 590not recommended to use this feature.
484.IP "rekey = seconds" 4 591.IP "rekey = seconds" 4
485.IX Item "rekey = seconds" 592.IX Item "rekey = seconds"
486Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are 593Sets the rekeying interval in seconds (default: \f(CW3607\fR). Connections are
487reestablished every \f(CW\*(C`rekey\*(C'\fR seconds, making them use a new encryption 594reestablished every \f(CW\*(C`rekey\*(C'\fR seconds, making them use a new encryption
488key. 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.
489.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 628.SS "\s-1NODE SPECIFIC SETTINGS\s0"
490.IX Subsection "NODE SPECIFIC SETTINGS" 629.IX Subsection "NODE SPECIFIC SETTINGS"
491The following settings are node-specific, that is, every node can have 630The following settings are node-specific, that is, every node can have
492different settings, even within the same gvpe instance. Settings that are 631different settings, even within the same gvpe instance. Settings that are
493set before the first node section set the defaults, settings that are 632set before the first node section set the defaults, settings that are
494set within a node section only apply to the given node. 633set within a node section only apply to the given node.
495.IP "allow-direct = nodename" 4 634.IP "allow-direct = nodename" 4
496.IX Item "allow-direct = nodename" 635.IX Item "allow-direct = nodename"
497Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info. 636Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info.
498.IP "compress = yes|true|on | no|false|off" 4 637.IP "compress = yes|true|on | no|false|off" 4
499.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
500Wether to compress data packets sent to this node (default: \f(CW\*(C`yes\*(C'\fR). 641compress data packets sent to this node (default: \f(CW\*(C`yes\*(C'\fR). Compression is
501Compression 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
502overhead at all, so enabling this is often a good idea. 643only be used when the other side supports compression, so enabling this is
644often a good idea.
503.IP "connect = ondemand | never | always | disabled" 4 645.IP "connect = ondemand | never | always | disabled" 4
504.IX Item "connect = ondemand | never | always | disabled" 646.IX Item "connect = ondemand | never | always | disabled"
505Sets 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
506try to establish and keep a connection to the given node), \f(CW\*(C`never\*(C'\fR 648try to establish and keep a connection to the given node), \f(CW\*(C`never\*(C'\fR
507(never initiate a connection to the given host, but accept connections), 649(never initiate a connection to the given host, but accept connections),
… …
577.Sp 719.Sp
578Enable the \s-1ICMP\s0 transport using \s-1ICMP\s0 packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this 720Enable the \s-1ICMP\s0 transport using \s-1ICMP\s0 packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this
579node. 721node.
580.IP "enable-rawip = yes|true|on | no|false|off" 4 722.IP "enable-rawip = yes|true|on | no|false|off" 4
581.IX Item "enable-rawip = yes|true|on | no|false|off" 723.IX Item "enable-rawip = yes|true|on | no|false|off"
582See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol. 724See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW IP\s0 transport protocol.
583.Sp 725.Sp
584Enable 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
585(default: \f(CW\*(C`no\*(C'\fR). 727(default: \f(CW\*(C`no\*(C'\fR).
586.IP "enable-tcp = yes|true|on | no|false|off" 4 728.IP "enable-tcp = yes|true|on | no|false|off" 4
587.IX Item "enable-tcp = yes|true|on | no|false|off" 729.IX Item "enable-tcp = yes|true|on | no|false|off"
… …
592when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. 734when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option.
593.IP "enable-udp = yes|true|on | no|false|off" 4 735.IP "enable-udp = yes|true|on | no|false|off" 4
594.IX Item "enable-udp = yes|true|on | no|false|off" 736.IX Item "enable-udp = yes|true|on | no|false|off"
595See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol. 737See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol.
596.Sp 738.Sp
597Enable 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).
598unless no other protocol is enabled for a node, in which case this
599protocol is enabled automatically).
600.Sp
601\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want to use it even though
602it might get switched on automatically, as some future version might
603default to another default protocol.
604.IP "hostname = hostname | ip [can not be defaulted]" 4 740.IP "hostname = hostname | ip [can not be defaulted]" 4
605.IX Item "hostname = hostname | ip [can not be defaulted]" 741.IX Item "hostname = hostname | ip [can not be defaulted]"
606Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0 742Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0
607address. It will be resolved before each connect request, so dyndns should 743address. It will be resolved before each connect request, so dyndns should
608work fine. If this setting is not specified and a router is available, 744work fine. If this setting is not specified and a router is available,
609then the router will be queried for the address of this node. Otherwise, 745then the router will be queried for the address of this node. Otherwise,
610the connection attempt will fail. 746the connection attempt will fail.
… …
623.IX Item "if-up-data = value" 759.IX Item "if-up-data = value"
624The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR 760The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR
625script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR. 761script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR.
626.IP "inherit-tos = yes|true|on | no|false|off" 4 762.IP "inherit-tos = yes|true|on | no|false|off" 4
627.IX Item "inherit-tos = yes|true|on | no|false|off" 763.IX Item "inherit-tos = yes|true|on | no|false|off"
628Wether 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
629sending 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
630outgoing 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
631to 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.
632.IP "max-retry = positive-number" 4 777.IP "max-retry = positive-number" 4
633.IX Item "max-retry = positive-number" 778.IX Item "max-retry = positive-number"
634The maximum interval in seconds (default: \f(CW3600\fR, one hour) between 779The maximum interval in seconds (default: \f(CW3600\fR, one hour) between
635retries to establish a connection to this node. When a connection cannot 780retries to establish a connection to this node. When a connection cannot
636be established, gvpe uses exponential back-off capped at this value. It's 781be established, gvpe uses exponential back-off capped at this value. It's
… …
684Sets 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
685officially assigned by \s-1IANA\s0!). 830officially assigned by \s-1IANA\s0!).
686.SH "CONFIG DIRECTORY LAYOUT" 831.SH "CONFIG DIRECTORY LAYOUT"
687.IX Header "CONFIG DIRECTORY LAYOUT" 832.IX Header "CONFIG DIRECTORY LAYOUT"
688The default (or recommended) directory layout for the config directory is: 833The default (or recommended) directory layout for the config directory is:
689.IP "" 4 834.IP "gvpe.conf" 4
690.IX Xref "gvpe.conf" 835.IX Item "gvpe.conf"
691The config file. 836The config file.
692.IP "" 4 837.IP "if-up" 4
693.IX Xref "if-up" 838.IX Item "if-up"
694The if-up script 839The if-up script
695.IP "," 4 840.IP "node-up, node-down" 4
696.IX Xref "node-up node-down" 841.IX Item "node-up, node-down"
697If used the node up or node-down scripts. 842If used the node up or node-down scripts.
698.IP "" 4 843.IP "hostkey" 4
699.IX Xref "hostkey" 844.IX Item "hostkey"
700The 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.
701.IP "" 4 846.IP "pubkey/nodename" 4
702.IX Xref "pubkey nodename" 847.IX Item "pubkey/nodename"
703The public keys of the other nodes, one file per node. 848The public keys of the other nodes, one file per node.
704.SH "SEE ALSO" 849.SH "SEE ALSO"
705.IX Header "SEE ALSO" 850.IX Header "SEE ALSO"
706\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). 851\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).
707.SH "AUTHOR" 852.SH "AUTHOR"

Diff Legend

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