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.27 by root, Tue Feb 15 13:31:22 2011 UTC vs.
Revision 1.32 by root, Thu Jul 18 13:35:19 2013 UTC

1.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.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 Sp \" Vertical space (when we can't use .PP) 5.de Sp \" Vertical space (when we can't use .PP)
6.if t .sp .5v 6.if t .sp .5v
… …
122.\} 122.\}
123.rm #[ #] #H #V #F C 123.rm #[ #] #H #V #F C
124.\" ======================================================================== 124.\" ========================================================================
125.\" 125.\"
126.IX Title "GVPE.CONF 5" 126.IX Title "GVPE.CONF 5"
127.TH GVPE.CONF 5 "2011-02-12" "2.24" "GNU Virtual Private Ethernet" 127.TH GVPE.CONF 5 "2013-07-17" "2.25" "GNU Virtual Private Ethernet"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes 128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents. 129.\" way too many mistakes in technical documents.
130.if n .ad l 130.if n .ad l
131.nh 131.nh
132.SH "NAME" 132.SH "NAME"
… …
158= 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
159extend 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
160after 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
161values, but not within the variable names or values themselves. 161values, but not within the variable names or values themselves.
162.PP 162.PP
163The 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
164\&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or 164variable overwrite earlier ones.
165(if the nodename starts with \*(L"!\*(R") on all nodes except the named one.
166.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
167For 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
168branch1, 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.
169.PP 198.Sp
170.Vb 3 199.Vb 3
171\& mtu = 1450 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 applied \*(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 a few global settings (like the \s-1UDP\s0 230Usually, a config file starts with a few global settings (like the \s-1UDP\s0
181port 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
182\&\f(CW\*(C`node = nickname\*(C'\fR line. 232\&\f(CW\*(C`node = nickname\*(C'\fR line.
… …
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 \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
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
… …
393currently supported. 476currently supported.
394.IP "keepalive = seconds" 4 477.IP "keepalive = seconds" 4
395.IX Item "keepalive = seconds" 478.IX Item "keepalive = seconds"
396Sets 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
397many seconds of inactivity the daemon will start to send keepalive probe 480many seconds of inactivity the daemon will start to send keepalive probe
398every 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
399is received within 15 seconds, the peer is considered unreachable and the 482is received within 15 seconds, the peer is considered unreachable and the
400connection is closed. 483connection is closed.
401.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 484.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4
402.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" 485.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical"
403Set the logging level. Connection established messages are logged at level 486Set the logging level. Connection established messages are logged at level
… …
410this information to the \f(CW\*(C`if\-up\*(C'\fR script. 493this information to the \f(CW\*(C`if\-up\*(C'\fR script.
411.Sp 494.Sp
412Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). 495Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
413.Sp 496.Sp
414This 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.
415.IP "node = nickname" 4 498.IP "nfmark = integer" 4
416.IX Item "node = nickname" 499.IX Item "nfmark = integer"
417Not 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
418used 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
419argument 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
420.IP "node-up = relative-or-absolute-path" 4 513.IP "node-up = relative-or-absolute-path" 4
421.IX Item "node-up = relative-or-absolute-path" 514.IX Item "node-up = relative-or-absolute-path"
422Sets a command (default: none) that should be called whenever a connection 515Sets a command (default: none) that should be called whenever a connection
423is established (even on rekeying operations). Note that node\-up/down 516is established (even on rekeying operations). Note that node\-up/down
424scripts will be run asynchronously, but execution is serialised, so there 517scripts will be run asynchronously, but execution is serialised, so there
… …
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
466.IP "node-change = relative-or-absolute-path" 4 559.IP "node-change = relative-or-absolute-path" 4
467.IX Item "node-change = relative-or-absolute-path" 560.IX Item "node-change = relative-or-absolute-path"
… …
471.IX Item "node-down = relative-or-absolute-path" 564.IX Item "node-down = relative-or-absolute-path"
472Same 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.
473.IP "pid-file = path" 4 566.IP "pid-file = path" 4
474.IX Item "pid-file = path" 567.IX Item "pid-file = path"
475The path to the pid file to check and create 568The path to the pid file to check and create
476(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.
477.IP "private-key = relative-path-to-key" 4 571.IP "private-key = relative-path-to-key" 4
478.IX Item "private-key = relative-path-to-key" 572.IX Item "private-key = relative-path-to-key"
479Sets the path (relative to the config directory) to the private key 573Sets the path (relative to the config directory) to the private key
480(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
481be 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
… …
485Since 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
486private 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
487not recommended to use this feature. 581not recommended to use this feature.
488.IP "rekey = seconds" 4 582.IP "rekey = seconds" 4
489.IX Item "rekey = seconds" 583.IX Item "rekey = seconds"
490Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are 584Sets the rekeying interval in seconds (default: \f(CW3607\fR). Connections are
491reestablished 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
492key. 586key.
493.IP "nfmark = integer" 4 587.IP "seed-device = path" 4
494.IX Item "nfmark = integer" 588.IX Item "seed-device = path"
495This advanced option, when set to a nonzero value (default: \f(CW0\fR), tries 589The random device used to initially and regularly seed the random
496to set the netfilter mark (or fwmark) value on all sockets gvpe uses to 590number generator (default: \fI/dev/urandom\fR). Randomness is of paramount
497send packets. 591importance to the security of the algorithms used in gvpe.
498.Sp 592.Sp
499This can be used to make gvpe use a different set of routing rules. For 593On program start and every seed-interval, gvpe will read 64 octets.
500example, on GNU/Linux, the \f(CW\*(C`if\-up\*(C'\fR could set \f(CW\*(C`nfmark\*(C'\fR to 1000 and then
501put all routing rules into table \f(CW99\fR and then use an ip rule to make
502gvpe traffic avoid that routing table, in effect routing normal traffic
503via gvpe and gvpe traffic via the normal system routing tables:
504.Sp 594.Sp
505.Vb 1 595Setting this path to the empty string will disable this functionality
506\& ip rule add not fwmark 1000 lookup 99 596completely (the underlying crypto library will likely look for entropy
507.Ve 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.
508.SS "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 602.SS "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
509.IX Subsection "NODE SPECIFIC SETTINGS" 603.IX Subsection "NODE SPECIFIC SETTINGS"
510The following settings are node-specific, that is, every node can have 604The following settings are node-specific, that is, every node can have
511different settings, even within the same gvpe instance. Settings that are 605different settings, even within the same gvpe instance. Settings that are
512set before the first node section set the defaults, settings that are 606set before the first node section set the defaults, settings that are
… …
614when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. 708when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option.
615.IP "enable-udp = yes|true|on | no|false|off" 4 709.IP "enable-udp = yes|true|on | no|false|off" 4
616.IX Item "enable-udp = yes|true|on | no|false|off" 710.IX Item "enable-udp = yes|true|on | no|false|off"
617See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol. 711See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol.
618.Sp 712.Sp
619Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, 713Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR).
620unless no other protocol is enabled for a node, in which case this
621protocol is enabled automatically).
622.Sp
623\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want to use it even though
624it might get switched on automatically, as some future version might
625default to another default protocol.
626.IP "hostname = hostname | ip [can not be defaulted]" 4 714.IP "hostname = hostname | ip [can not be defaulted]" 4
627.IX Item "hostname = hostname | ip [can not be defaulted]" 715.IX Item "hostname = hostname | ip [can not be defaulted]"
628Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0 716Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0
629address. It will be resolved before each connect request, so dyndns should 717address. It will be resolved before each connect request, so dyndns should
630work fine. If this setting is not specified and a router is available, 718work fine. If this setting is not specified and a router is available,
… …
717.IP "node-up, node-down" 4 805.IP "node-up, node-down" 4
718.IX Item "node-up, node-down" 806.IX Item "node-up, node-down"
719If used the node up or node-down scripts. 807If used the node up or node-down scripts.
720.IP "hostkey" 4 808.IP "hostkey" 4
721.IX Item "hostkey" 809.IX Item "hostkey"
722The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. 810The (default path of the) private key of the current host.
723.IP "pubkey/nodename" 4 811.IP "pubkey/nodename" 4
724.IX Item "pubkey/nodename" 812.IX Item "pubkey/nodename"
725The public keys of the other nodes, one file per node. 813The public keys of the other nodes, one file per node.
726.SH "SEE ALSO" 814.SH "SEE ALSO"
727.IX Header "SEE ALSO" 815.IX Header "SEE ALSO"

Diff Legend

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