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.34 by root, Fri Oct 11 08:40:56 2013 UTC

1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) 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
… …
51.\" Escape single quotes in literal strings from groff's Unicode transform. 43.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq 44.ie \n(.g .ds Aq \(aq
53.el .ds Aq ' 45.el .ds Aq '
54.\" 46.\"
55.\" 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
56.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index 48.\" 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 49.\" entries marked with X<> in POD. Of course, you'll have to process the
58.\" output yourself in some meaningful fashion. 50.\" output yourself in some meaningful fashion.
59.ie \nF \{\ 51.ie \nF \{\
60. de IX 52. de IX
61. tm Index:\\$1\t\\n%\t"\\$2" 53. tm Index:\\$1\t\\n%\t"\\$2"
… …
130.\} 122.\}
131.rm #[ #] #H #V #F C 123.rm #[ #] #H #V #F C
132.\" ======================================================================== 124.\" ========================================================================
133.\" 125.\"
134.IX Title "GVPE.CONF 5" 126.IX Title "GVPE.CONF 5"
135.TH GVPE.CONF 5 "2008-09-01" "2.2" "GNU Virtual Private Ethernet" 127.TH GVPE.CONF 5 "2013-10-11" "2.25" "GNU Virtual Private Ethernet"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes 128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents. 129.\" way too many mistakes in technical documents.
138.if n .ad l 130.if n .ad l
139.nh 131.nh
140.SH "NAME" 132.SH "NAME"
… …
166= 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
167extend 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
168after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after 160after 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. 161values, but not within the variable names or values themselves.
170.PP 162.PP
171The 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
172\&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or 164variable overwrite earlier ones.
173(if the nodename starts with \*(L"!\*(R") on all nodes except the named one.
174.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
175For example, set the \s-1MTU\s0 to \f(CW1450\fR everywhere, loglevel to \f(CW\*(C`noise\*(C'\fR on 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
176branch1, and connect to \f(CW\*(C`ondemand\*(C'\fR everywhere but on branch2: 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.
177.PP 198.Sp
178.Vb 3 199.Vb 3
179\& mtu = 1450 200\& mtu = 1450
180\& on branch1 loglevel = noise 201\& on branch1 loglevel = noise
181\& on !branch2 connect = ondemand 202\& on !branch2 connect = ondemand
182.Ve 203.Ve
183.PP 204.IP "include relative-or-absolute-path" 4
184All settings are applied \*(L"in order\*(R", that is, later settings of the same 205.IX Item "include relative-or-absolute-path"
185variable 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
186.SH "ANATOMY OF A CONFIG FILE" 228.SH "ANATOMY OF A CONFIG FILE"
187.IX Header "ANATOMY OF A CONFIG FILE" 229.IX Header "ANATOMY OF A CONFIG FILE"
188Usually, a config file starts with a few global settings (like the \s-1UDP\s0 230Usually, 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 231port to listen on), followed by node-specific sections that begin with a
190\&\f(CW\*(C`node = nickname\*(C'\fR line. 232\&\f(CW\*(C`node = nickname\*(C'\fR line.
… …
196.PP 238.PP
197Node-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
198node section they will set the default values for all following nodes. 240node section they will set the default values for all following nodes.
199.SH "CONFIG VARIABLES" 241.SH "CONFIG VARIABLES"
200.IX Header "CONFIG VARIABLES" 242.IX Header "CONFIG VARIABLES"
201.Sh "\s-1GLOBAL\s0 \s-1SETTINGS\s0" 243.SS "\s-1GLOBAL\s0 \s-1SETTINGS\s0"
202.IX Subsection "GLOBAL SETTINGS" 244.IX Subsection "GLOBAL SETTINGS"
203Global settings will affect the behaviour of the running gvpe daemon, that 245Global settings will affect the behaviour of the running gvpe daemon, that
204is, 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
205values 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
206the 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).
207.IP "dns-forw-host = hostname/ip" 4 274.IP "dns-forw-host = hostname/ip" 4
208.IX Item "dns-forw-host = hostname/ip" 275.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 276The \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). 277(default: \f(CW127.0.0.1\fR, changing it is highly recommended).
211.IP "dns-forw-port = port-number" 4 278.IP "dns-forw-port = port-number" 4
212.IX Item "dns-forw-port = port-number" 279.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, 280The 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). 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.
215.IP "dns-max-outstanding = integer-number-of-requests" 4 290.IP "dns-max-outstanding = integer-number-of-requests" 4
216.IX Item "dns-max-outstanding = integer-number-of-requests" 291.IX Item "dns-max-outstanding = integer-number-of-requests"
217The maximum number of outstanding \s-1DNS\s0 transport requests 292The 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 293(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 294limit without receiving replies. In heavily overloaded situations it might
… …
356other programs. 431other programs.
357.Sp 432.Sp
358The default is 47 (\s-1GRE\s0), which has a good chance of tunneling 433The 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 434through 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 435compatible). Other common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4
361(\s-1IPIP\s0 tunnels) or 98 (\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).
362.IP "http-proxy-host = hostname/ip" 4 441.IP "http-proxy-host = hostname/ip" 4
363.IX Item "http-proxy-host = hostname/ip" 442.IX Item "http-proxy-host = hostname/ip"
364The \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
365compiled 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
366tcp connections through a http proxy server. 445tcp connections through a http proxy server.
… …
397currently supported. 476currently supported.
398.IP "keepalive = seconds" 4 477.IP "keepalive = seconds" 4
399.IX Item "keepalive = seconds" 478.IX Item "keepalive = seconds"
400Sets 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
401many seconds of inactivity the daemon will start to send keepalive probe 480many 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 481every 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 482is received within 15 seconds, the peer is considered unreachable and the
404connection is closed. 483connection is closed.
405.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 484.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4
406.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" 485.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical"
407Set the logging level. Connection established messages are logged at level 486Set the logging level. Connection established messages are logged at level
… …
414this information to the \f(CW\*(C`if\-up\*(C'\fR script. 493this information to the \f(CW\*(C`if\-up\*(C'\fR script.
415.Sp 494.Sp
416Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). 495Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
417.Sp 496.Sp
418This value must be the minimum of the \s-1MTU\s0 values of all nodes. 497This value must be the minimum of the \s-1MTU\s0 values of all nodes.
419.IP "node = nickname" 4 498.IP "nfmark = integer" 4
420.IX Item "node = nickname" 499.IX Item "nfmark = integer"
421Not 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
422used 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
423argument 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
424.IP "node-up = relative-or-absolute-path" 4 513.IP "node-up = relative-or-absolute-path" 4
425.IX Item "node-up = relative-or-absolute-path" 514.IX Item "node-up = relative-or-absolute-path"
426Sets a command (default: none) that should be called whenever a connection 515Sets a command (default: none) that should be called whenever a connection
427is established (even on rekeying operations). Note that node\-up/down 516is established (even on rekeying operations). Note that node\-up/down
428scripts will be run asynchronously, but execution is serialised, so there 517scripts will be run asynchronously, but execution is serialised, so there
429will only ever be one such script running. 518will only ever be one such script running.
430.Sp 519.Sp
431In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following 520In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following
432environment variables will be set: 521environment variables will be set (values are just examples):
433.RS 4 522.RS 4
434.IP "DESTNODE=branch2" 4 523.IP "DESTNODE=branch2" 4
435.IX Item "DESTNODE=branch2" 524.IX Item "DESTNODE=branch2"
436The name of the remote node. 525The name of the remote node.
437.IP "DESTID=2" 4 526.IP "DESTID=2" 4
438.IX Item "DESTID=2" 527.IX Item "DESTID=2"
439The 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.
440.IP "DESTIP=188.13.66.8" 4 533.IP "DESTIP=188.13.66.8" 4
441.IX Item "DESTIP=188.13.66.8" 534.IX Item "DESTIP=188.13.66.8"
442The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from 535The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from
443everywhere, as long as the other node can authenticate itself). 536everywhere, as long as the other node can authenticate itself).
444.IP "DESTPORT=655 # deprecated" 4 537.IP "DESTPORT=655 # deprecated" 4
445.IX Item "DESTPORT=655 # deprecated" 538.IX Item "DESTPORT=655 # deprecated"
446The \s-1UDP\s0 port used by the other side. 539The protocol port used by the other side, if applicable.
447.IP "STATE=UP" 4 540.IP "STATE=up" 4
448.IX Item "STATE=UP" 541.IX Item "STATE=up"
449Node-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
450with STATE=DOWN. 543with STATE=change and node-down scripts get called with STATE=down.
451.RE 544.RE
452.RS 4 545.RS 4
453.Sp 546.Sp
454Here 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
455mapping in some \s-1DNS\s0 zone: 548mapping in some \s-1DNS\s0 zone:
… …
457.Vb 6 550.Vb 6
458\& #!/bin/sh 551\& #!/bin/sh
459\& { 552\& {
460\& echo update delete $DESTNODE.lowttl.example.net. a 553\& echo update delete $DESTNODE.lowttl.example.net. a
461\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP 554\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
462\& echo 555\& echo
463\& } | nsupdate \-d \-k $CONFBASE:key.example.net. 556\& } | nsupdate \-d \-k $CONFBASE:key.example.net.
464.Ve 557.Ve
465.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).
466.IP "node-down = relative-or-absolute-path" 4 563.IP "node-down = relative-or-absolute-path" 4
467.IX Item "node-down = relative-or-absolute-path" 564.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. 565Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost.
469.IP "pid-file = path" 4 566.IP "pid-file = path" 4
470.IX Item "pid-file = path" 567.IX Item "pid-file = path"
471The path to the pid file to check and create 568The path to the pid file to check and create
472(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.
473.IP "private-key = relative-path-to-key" 4 571.IP "private-key = relative-path-to-key" 4
474.IX Item "private-key = relative-path-to-key" 572.IX Item "private-key = relative-path-to-key"
475Sets the path (relative to the config directory) to the private key 573Sets 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 574(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 575be 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 579Since 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 580private key file should be kept secret per-node to avoid spoofing, it is
483not recommended to use this feature. 581not recommended to use this feature.
484.IP "rekey = seconds" 4 582.IP "rekey = seconds" 4
485.IX Item "rekey = seconds" 583.IX Item "rekey = seconds"
486Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are 584Sets 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 585reestablished every \f(CW\*(C`rekey\*(C'\fR seconds, making them use a new encryption
488key. 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.
489.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 619.SS "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
490.IX Subsection "NODE SPECIFIC SETTINGS" 620.IX Subsection "NODE SPECIFIC SETTINGS"
491The following settings are node-specific, that is, every node can have 621The following settings are node-specific, that is, every node can have
492different settings, even within the same gvpe instance. Settings that are 622different settings, even within the same gvpe instance. Settings that are
493set before the first node section set the defaults, settings that are 623set before the first node section set the defaults, settings that are
494set within a node section only apply to the given node. 624set within a node section only apply to the given node.
495.IP "allow-direct = nodename" 4 625.IP "allow-direct = nodename" 4
496.IX Item "allow-direct = nodename" 626.IX Item "allow-direct = nodename"
497Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info. 627Allow 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 628.IP "compress = yes|true|on | no|false|off" 4
499.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
500Wether to compress data packets sent to this node (default: \f(CW\*(C`yes\*(C'\fR). 632compress 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 633really cheap even on slow computers, has no size overhead at all and will
502overhead at all, so enabling this is often a good idea. 634only be used when the other side supports compression, so enabling this is
635often a good idea.
503.IP "connect = ondemand | never | always | disabled" 4 636.IP "connect = ondemand | never | always | disabled" 4
504.IX Item "connect = ondemand | never | always | disabled" 637.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 638Sets 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 639try 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), 640(never initiate a connection to the given host, but accept connections),
… …
592when 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.
593.IP "enable-udp = yes|true|on | no|false|off" 4 726.IP "enable-udp = yes|true|on | no|false|off" 4
594.IX Item "enable-udp = yes|true|on | no|false|off" 727.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. 728See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol.
596.Sp 729.Sp
597Enable 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).
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 731.IP "hostname = hostname | ip [can not be defaulted]" 4
605.IX Item "hostname = hostname | ip [can not be defaulted]" 732.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 733Forces 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 734address. It will be resolved before each connect request, so dyndns should
608work fine. If this setting is not specified and a router is available, 735work fine. If this setting is not specified and a router is available,
… …
623.IX Item "if-up-data = value" 750.IX Item "if-up-data = value"
624The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR 751The 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. 752script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR.
626.IP "inherit-tos = yes|true|on | no|false|off" 4 753.IP "inherit-tos = yes|true|on | no|false|off" 4
627.IX Item "inherit-tos = yes|true|on | no|false|off" 754.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 755Whether 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 756sending 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 757outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
631to the tunnel device, which is usually what you want. 758to the tunnel device, which is usually what you want.
759.IP "low-power = yes|true|on | no|false|off" 4
760.IX Item "low-power = yes|true|on | no|false|off"
761If true, designates a node as a low-power node. Low-power nodes use
762larger timeouts and try to reduce cpu time. Other nodes talking to a
763low-power node will also use larger timeouts, and will use less aggressive
764optimisations, in the hope of reducing load. Security is not compromised.
765.Sp
766The typical low-power node would be a mobile phone, where wakeups and
767encryption can significantly increase power drain.
632.IP "max-retry = positive-number" 4 768.IP "max-retry = positive-number" 4
633.IX Item "max-retry = positive-number" 769.IX Item "max-retry = positive-number"
634The maximum interval in seconds (default: \f(CW3600\fR, one hour) between 770The maximum interval in seconds (default: \f(CW3600\fR, one hour) between
635retries to establish a connection to this node. When a connection cannot 771retries to establish a connection to this node. When a connection cannot
636be established, gvpe uses exponential back-off capped at this value. It's 772be 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 820Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
685officially assigned by \s-1IANA\s0!). 821officially assigned by \s-1IANA\s0!).
686.SH "CONFIG DIRECTORY LAYOUT" 822.SH "CONFIG DIRECTORY LAYOUT"
687.IX Header "CONFIG DIRECTORY LAYOUT" 823.IX Header "CONFIG DIRECTORY LAYOUT"
688The default (or recommended) directory layout for the config directory is: 824The default (or recommended) directory layout for the config directory is:
689.IP "" 4 825.IP "gvpe.conf" 4
690.IX Xref "gvpe.conf" 826.IX Item "gvpe.conf"
691The config file. 827The config file.
692.IP "" 4 828.IP "if-up" 4
693.IX Xref "if-up" 829.IX Item "if-up"
694The if-up script 830The if-up script
695.IP "," 4 831.IP "node-up, node-down" 4
696.IX Xref "node-up node-down" 832.IX Item "node-up, node-down"
697If used the node up or node-down scripts. 833If used the node up or node-down scripts.
698.IP "" 4 834.IP "hostkey" 4
699.IX Xref "hostkey" 835.IX Item "hostkey"
700The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. 836The (default path of the) private key of the current host.
701.IP "" 4 837.IP "pubkey/nodename" 4
702.IX Xref "pubkey nodename" 838.IX Item "pubkey/nodename"
703The public keys of the other nodes, one file per node. 839The public keys of the other nodes, one file per node.
704.SH "SEE ALSO" 840.SH "SEE ALSO"
705.IX Header "SEE ALSO" 841.IX Header "SEE ALSO"
706\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). 842\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).
707.SH "AUTHOR" 843.SH "AUTHOR"
708.IX Header "AUTHOR" 844.IX Header "AUTHOR"
709Marc Lehmann <gvpe@schmorp.de> 845Marc Lehmann <gvpe@schmorp.de>
846.SH "POD ERRORS"
847.IX Header "POD ERRORS"
848Hey! \fBThe above document had some coding errors, which are explained below:\fR
849.IP "Around line 516:" 4
850.IX Item "Around line 516:"
851Unterminated C<...> sequence

Diff Legend

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