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.20 by pcg, Sun Aug 10 10:35:26 2008 UTC vs.
Revision 1.21 by pcg, Sun Aug 10 22:18:58 2008 UTC

1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading 5.de Sh \" Subsection heading
6.br 6.br
46. ds PI \(*p 46. ds PI \(*p
47. ds L" `` 47. ds L" ``
48. ds R" '' 48. ds R" ''
49'br\} 49'br\}
50.\" 50.\"
51.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq
53.el .ds Aq '
54.\"
55.\" If the F register is turned on, we'll generate index entries on stderr for 51.\" 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 52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57.\" entries marked with X<> in POD. Of course, you'll have to process the 53.\" entries marked with X<> in POD. Of course, you'll have to process the
58.\" output yourself in some meaningful fashion. 54.\" output yourself in some meaningful fashion.
59.ie \nF \{\ 55.if \nF \{\
60. de IX 56. de IX
61. tm Index:\\$1\t\\n%\t"\\$2" 57. tm Index:\\$1\t\\n%\t"\\$2"
62.. 58..
63. nr % 0 59. nr % 0
64. rr F 60. rr F
65.\} 61.\}
66.el \{\ 62.\"
67. de IX 63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
68.. 64.\" way too many mistakes in technical documents.
69.\} 65.hy 0
66.if n .na
70.\" 67.\"
71.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72.\" Fear. Run. Save yourself. No user-serviceable parts. 69.\" Fear. Run. Save yourself. No user-serviceable parts.
73. \" fudge factors for nroff and troff 70. \" fudge factors for nroff and troff
74.if n \{\ 71.if n \{\
130.\} 127.\}
131.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
132.\" ======================================================================== 129.\" ========================================================================
133.\" 130.\"
134.IX Title "GVPE.CONF 5" 131.IX Title "GVPE.CONF 5"
135.TH GVPE.CONF 5 "2008-08-07" "2.2" "GNU Virtual Private Ethernet" 132.TH GVPE.CONF 5 "2008-08-10" "2.2" "GNU Virtual Private Ethernet"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents.
138.if n .ad l
139.nh
140.SH "NAME" 133.SH "NAME"
141gvpe.conf \- configuration file for the GNU VPE daemon 134gvpe.conf \- configuration file for the GNU VPE daemon
142.SH "SYNOPSIS" 135.SH "SYNOPSIS"
143.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
144.Vb 3 137.Vb 3
145\& udp\-port = 407 138\& udp\-port = 407
146\& mtu = 1492 139\& mtu = 1492
147\& ifname = vpn0 140\& ifname = vpn0
148\& 141.Ve
142.PP
143.Vb 2
149\& node = branch1 144\& node = branch1
150\& hostname = 1.2.3.4 145\& hostname = 1.2.3.4
151\& 146.Ve
147.PP
148.Vb 3
152\& node = branch2 149\& node = branch2
153\& hostname = www.example.net 150\& hostname = www.example.net
154\& udp\-port = 500 # this host uses a different udp\-port 151\& udp\-port = 500 # this host uses a different udp\-port
155\& 152.Ve
153.PP
154.Vb 2
156\& node = branch3 155\& node = branch3
157\& connect = ondemand 156\& connect = ondemand
158.Ve 157.Ve
159.SH "DESCRIPTION" 158.SH "DESCRIPTION"
160.IX Header "DESCRIPTION" 159.IX Header "DESCRIPTION"
182listen on), followed by node-specific sections that begin with a \f(CW\*(C`node = 181listen on), followed by node-specific sections that begin with a \f(CW\*(C`node =
183nickname\*(C'\fR line. 182nickname\*(C'\fR line.
184.PP 183.PP
185Every node that is part of the network must have a section that starts 184Every node that is part of the network must have a section that starts
186with \f(CW\*(C`node = nickname\*(C'\fR. The number and order of the nodes is important 185with \f(CW\*(C`node = nickname\*(C'\fR. The number and order of the nodes is important
187and must be the same on all hosts. It is not uncommon for node sections to 186and must be the same on all nodes. It is not uncommon for node sections to
188be completely empty \- if the default values are right. 187be completely empty \- if the default values are right.
189.PP 188.PP
190Node-specific settings can be used at any time. If used before the first 189Node-specific settings can be used at any time. If used before the first
191node section they will set the default values for all following nodes. 190node section they will set the default values for all following nodes.
192.SH "CONFIG VARIABLES" 191.SH "CONFIG VARIABLES"
278\&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to 277\&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to
279select the correct syntax to use for network-related commands. 278select the correct syntax to use for network-related commands.
280.IP "MTU=1436" 4 279.IP "MTU=1436" 4
281.IX Item "MTU=1436" 280.IX Item "MTU=1436"
282The \s-1MTU\s0 to set the interface to. You can use lower values (if done 281The \s-1MTU\s0 to set the interface to. You can use lower values (if done
283consistently on all hosts), but this is usually ineffective. 282consistently on all nodes), but this is usually either inefficient or
283simply ineffective.
284.IP "NODES=5" 4 284.IP "NODES=5" 4
285.IX Item "NODES=5" 285.IX Item "NODES=5"
286The number of nodes in this \s-1GVPE\s0 network. 286The number of nodes in this \s-1GVPE\s0 network.
287.RE 287.RE
288.RS 4 288.RS 4
340the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the 340the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the
341device. 341device.
342.IP "ip-proto = numerical-ip-protocol" 4 342.IP "ip-proto = numerical-ip-protocol" 4
343.IX Item "ip-proto = numerical-ip-protocol" 343.IX Item "ip-proto = numerical-ip-protocol"
344Sets the protocol number to be used for the rawip protocol. This is a 344Sets the protocol number to be used for the rawip protocol. This is a
345global option because all hosts must use the same protocol, and since 345global option because all nodes must use the same protocol, and since
346there are no port numbers, you cannot easily run more than one gvpe 346there are no port numbers, you cannot easily run more than one gvpe
347instance using the same protocol, nor can you share the protocol with 347instance using the same protocol, nor can you share the protocol with
348other programs. 348other programs.
349.Sp 349.Sp
350The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through 350The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through
364Please note that gvpe will still try to resolve all hostnames in the 364Please note that gvpe will still try to resolve all hostnames in the
365configuration file, so if you are behind a proxy without access to a dns 365configuration file, so if you are behind a proxy without access to a dns
366server better use numerical \s-1IP\s0 addresses. 366server better use numerical \s-1IP\s0 addresses.
367.Sp 367.Sp
368To make best use of this option disable all protocols except tcp in your 368To make best use of this option disable all protocols except tcp in your
369config file and make sure your routers (or all other hosts) are listening 369config file and make sure your routers (or all other nodes) are listening
370on a port that the proxy allows (443, https, is a common choice). 370on a port that the proxy allows (443, https, is a common choice).
371.Sp 371.Sp
372If you have a router, connecting to it will suffice. Otherwise tcp must be 372If you have a router, connecting to it will suffice. Otherwise tcp must be
373enabled on all hosts. 373enabled on all nodes.
374.Sp 374.Sp
375Example: 375Example:
376.Sp 376.Sp
377.Vb 3 377.Vb 3
378\& http\-proxy\-host = proxy.example.com 378\& http\-proxy\-host = proxy.example.com
405maximum overhead (e.g. udp header size, encryption blocksize...) and pass 405maximum overhead (e.g. udp header size, encryption blocksize...) and pass
406this information to the \f(CW\*(C`if\-up\*(C'\fR script. 406this information to the \f(CW\*(C`if\-up\*(C'\fR script.
407.Sp 407.Sp
408Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). 408Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
409.Sp 409.Sp
410This value must be the minimum of the mtu values of all hosts. 410This value must be the minimum of the mtu values of all nodes.
411.IP "node = nickname" 4 411.IP "node = nickname" 4
412.IX Item "node = nickname" 412.IX Item "node = nickname"
413Not really a config setting but introduces a node section. The nickname is 413Not really a config setting but introduces a node section. The nickname is
414used to select the right configuration section and must be passed as an 414used to select the right configuration section and must be passed as an
415argument to the gvpe daemon. 415argument to the gvpe daemon.
429.IP "DESTID=2" 4 429.IP "DESTID=2" 4
430.IX Item "DESTID=2" 430.IX Item "DESTID=2"
431The node id of the remote node. 431The node id of the remote node.
432.IP "DESTIP=188.13.66.8" 4 432.IP "DESTIP=188.13.66.8" 4
433.IX Item "DESTIP=188.13.66.8" 433.IX Item "DESTIP=188.13.66.8"
434The numerical \s-1IP\s0 address of the remote host (gvpe accepts connections from 434The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from
435everywhere, as long as the other host can authenticate itself). 435everywhere, as long as the other node can authenticate itself).
436.IP "DESTPORT=655 # deprecated" 4 436.IP "DESTPORT=655 # deprecated" 4
437.IX Item "DESTPORT=655 # deprecated" 437.IX Item "DESTPORT=655 # deprecated"
438The \s-1UDP\s0 port used by the other side. 438The \s-1UDP\s0 port used by the other side.
439.IP "STATE=UP" 4 439.IP "STATE=UP" 4
440.IX Item "STATE=UP" 440.IX Item "STATE=UP"
469be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could 469be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could
470use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where 470use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where
471\&\f(CW\*(C`gvpectrl\*(C'\fR puts them. 471\&\f(CW\*(C`gvpectrl\*(C'\fR puts them.
472.Sp 472.Sp
473Since only the private key file of the current node is used and the 473Since only the private key file of the current node is used and the
474private key file should be kept secret per-host to avoid spoofings, it is 474private key file should be kept secret per-node to avoid spoofings, it is
475not recommended to use this feature. 475not recommended to use this feature.
476.IP "rekey = seconds" 4 476.IP "rekey = seconds" 4
477.IX Item "rekey = seconds" 477.IX Item "rekey = seconds"
478Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are 478Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are
479reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. 479reestablished every \f(CW\*(C`rekey\*(C'\fR seconds.
480.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 480.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
481.IX Subsection "NODE SPECIFIC SETTINGS" 481.IX Subsection "NODE SPECIFIC SETTINGS"
482The following settings are node-specific, that is, every node can have 482The following settings are node\-specific, that is, every node can have
483different settings, even within the same gvpe instance. Settings that are 483different settings, even within the same gvpe instance. Settings that are
484set before the first node section set the defaults, settings that are 484set before the first node section set the defaults, settings that are
485set within a node section only apply to the given node. 485set within a node section only apply to the given node.
486.IP "allow-direct = nodename" 4 486.IP "allow-direct = nodename" 4
487.IX Item "allow-direct = nodename" 487.IX Item "allow-direct = nodename"
488Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info. 488Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info.
489.IP "compress = yes|true|on | no|false|off" 4 489.IP "compress = yes|true|on | no|false|off" 4
490.IX Item "compress = yes|true|on | no|false|off" 490.IX Item "compress = yes|true|on | no|false|off"
491Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). 491Wether to compress data packets sent to this node (default: \f(CW\*(C`yes\*(C'\fR).
492Compression is really cheap even on slow computers and has no size 492Compression is really cheap even on slow computers and has no size
493overhead at all, so enabling this is a good idea. 493overhead at all, so enabling this is a good idea.
494.IP "connect = ondemand | never | always | disabled" 4 494.IP "connect = ondemand | never | always | disabled" 4
495.IX Item "connect = ondemand | never | always | disabled" 495.IX Item "connect = ondemand | never | always | disabled"
496Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always 496Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always
497try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR 497try to establish and keep a connection to the given node), \f(CW\*(C`never\*(C'\fR
498(never initiate a connection to the given host, but accept connections), 498(never initiate a connection to the given host, but accept connections),
499\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection when there are outstanding 499\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection when there are outstanding
500packets in the queue and take it down after the keepalive interval) or 500packets in the queue and take it down after the keepalive interval) or
501\&\f(CW\*(C`disabled\*(C'\fR (node is bad, don't talk to it). 501\&\f(CW\*(C`disabled\*(C'\fR (node is bad, don't talk to it).
502.Sp
503Routers will automatically be forced to \f(CW\*(C`always\*(C'\fR unless they are
504\&\f(CW\*(C`disabled\*(C'\fR, to ensure all nodes can talk to each other.
502.IP "deny-direct = nodename | *" 4 505.IP "deny-direct = nodename | *" 4
503.IX Item "deny-direct = nodename | *" 506.IX Item "deny-direct = nodename | *"
504Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR 507Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR
505is given). Only one node can be specified, but you can use multiple 508is given). Only one node can be specified, but you can use multiple
506\&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in 509\&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in
600.IX Item "icmp-type = integer" 603.IX Item "icmp-type = integer"
601Sets the type value to be used for outgoing (and incoming) packets sent 604Sets the type value to be used for outgoing (and incoming) packets sent
602via the \s-1ICMP\s0 transport. 605via the \s-1ICMP\s0 transport.
603.Sp 606.Sp
604The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as 607The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as
605\&\*(L"ping-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. 608\&\*(L"ping\-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a.
606\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. 609\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used.
607.IP "if-up-data = value" 4 610.IP "if-up-data = value" 4
608.IX Item "if-up-data = value" 611.IX Item "if-up-data = value"
609The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR 612The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR
610script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR. 613script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR.
627Expire packets that couldn't be sent after this many seconds 630Expire packets that couldn't be sent after this many seconds
628(default: \f(CW60\fR). Gvpe will normally queue packets for a node without an 631(default: \f(CW60\fR). Gvpe will normally queue packets for a node without an
629active connection, in the hope of establishing a connection soon. This 632active connection, in the hope of establishing a connection soon. This
630value specifies the maximum lifetime a packet will stay in the queue, if a 633value specifies the maximum lifetime a packet will stay in the queue, if a
631packet gets older, it will be thrown away. 634packet gets older, it will be thrown away.
632.IP "max-queue = positive-number" 4 635.IP "max-queue = positive\-number>=1" 4
633.IX Item "max-queue = positive-number" 636.IX Item "max-queue = positive-number>=1"
634The maximum number of packets that will be queued (default: \f(CW512\fR) 637The maximum number of packets that will be queued (default: \f(CW512\fR)
635for this node. If more packets are sent then earlier packets will be 638for this node. If more packets are sent then earlier packets will be
636expired. See \f(CW\*(C`max\-ttl\*(C'\fR, above. 639expired. See \f(CW\*(C`max\-ttl\*(C'\fR, above.
637.IP "router-priority = 0 | 1 | positive\-number>=2" 4 640.IP "router-priority = 0 | 1 | positive\-number>=2" 4
638.IX Item "router-priority = 0 | 1 | positive-number>=2" 641.IX Item "router-priority = 0 | 1 | positive-number>=2"
639Sets the router priority of the given host (default: \f(CW0\fR, disabled). If 642Sets the router priority of the given node (default: \f(CW0\fR, disabled).
640some host tries to connect to another host without a hostname, it asks
641the router host for it's \s-1IP\s0 address. The router host is the one with the
642highest priority larger than \f(CW1\fR that is currently reachable.
643.Sp 643.Sp
644Make sure all hosts always connect (\f(CW\*(C`connect = always\*(C'\fR) to the router 644If some node tries to connect to another node but it doesn't have a
645hosts, otherwise connecting to them might be impossible. 645hostname, it asks a router node for it's \s-1IP\s0 address. The router node
646chosen is the one with the highest priority larger than \f(CW1\fR that is
647currently reachable. This is called a \fImediated\fR connection, as the
648connection itself will still be direct, but it uses another node to
649mediate between the two nodes.
650.Sp
651The value \f(CW0\fR disables routing, that means if the node receives a packet
652not for itself it will not forward it but instead drop it.
646.Sp 653.Sp
647The special value \f(CW1\fR allows other hosts to route through the router 654The special value \f(CW1\fR allows other hosts to route through the router
648host, but they will never route through it by default. The value \f(CW0\fR 655host, but they will never route through it by default (i.e. the config
649disables routing. The idea behind this is that some hosts can, if 656file of another node needs to specify a router priority higher than one
657to choose such a node for routing).
658.Sp
659The idea behind this is that some hosts can, if required, bump the
650required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their 660\&\f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their local config to
651local config to route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is 661route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is \f(CW0\fR, then routing
652\&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do 662will be refused, so \f(CW1\fR serves as a \*(L"enable, but do not use by default\*(R"
653not use by default\*(R" switch. 663switch.
664.Sp
665Nodes with \f(CW\*(C`router\-priority\*(C'\fR set to \f(CW2\fR or higher will always be forced
666to \f(CW\*(C`connect\*(C'\fR = \f(CW\*(C`always\*(C'\fR (unless they are \f(CW\*(C`disabled\*(C'\fR).
654.IP "tcp-port = port-number" 4 667.IP "tcp-port = port-number" 4
655.IX Item "tcp-port = port-number" 668.IX Item "tcp-port = port-number"
656Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. 669Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number.
657.IP "udp-port = port-number" 4 670.IP "udp-port = port-number" 4
658.IX Item "udp-port = port-number" 671.IX Item "udp-port = port-number"
659Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not 672Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
660officially assigned by \s-1IANA\s0!). 673officially assigned by \s-1IANA\s0!).
661.SH "CONFIG DIRECTORY LAYOUT" 674.SH "CONFIG DIRECTORY LAYOUT"
662.IX Header "CONFIG DIRECTORY LAYOUT" 675.IX Header "CONFIG DIRECTORY LAYOUT"
663The default (or recommended) directory layout for the config directory is: 676The default (or recommended) directory layout for the config directory is:
664.IP "" 4 677.IP "\(bu" 4
665.IX Xref "gvpe.conf" 678.IX Xref "gvpe.conf"
666The config file. 679The config file.
667.IP "" 4 680.IP "\(bu" 4
668.IX Xref "if-up" 681.IX Xref "if-up"
669The if-up script 682The if-up script
670.IP "," 4 683.IP "," 4
671.IX Xref "node-up node-down" 684.IX Xref "node-up node-down"
672If used the node up or node-down scripts. 685If used the node up or node-down scripts.
673.IP "" 4 686.IP "\(bu" 4
674.IX Xref "hostkey" 687.IX Xref "hostkey"
675The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. 688The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host.
676.IP "" 4 689.IP "\(bu" 4
677.IX Xref "pubkey nodename" 690.IX Xref "pubkey nodename"
678The public keys of the other nodes, one file per node. 691The public keys of the other nodes, one file per node.
679.SH "SEE ALSO" 692.SH "SEE ALSO"
680.IX Header "SEE ALSO" 693.IX Header "SEE ALSO"
681\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). 694\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines