ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/gvpe/doc/vped.conf.5
Revision: 1.6
Committed: Fri Mar 28 18:19:14 2003 UTC (21 years, 2 months ago) by pcg
Branch: MAIN
Changes since 1.5: +2 -2 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 .\" Automatically generated by Pod::Man v1.36, Pod::Parser v1.13
2 .\"
3 .\" Standard preamble:
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)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. | will give a
29 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
32 .tr \(*W-|\(bv\*(Tr
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 . ds -- \(*W-
36 . ds PI pi
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39 . ds L" ""
40 . ds R" ""
41 . ds C`
42 . ds C'
43 'br\}
44 .el\{\
45 . ds -- \|\(em\|
46 . ds PI \(*p
47 . ds L" ``
48 . ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 . de IX
57 . tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 . nr % 0
60 . rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
71 .if n \{\
72 . ds #H 0
73 . ds #V .8m
74 . ds #F .3m
75 . ds #[ \f1
76 . ds #] \fP
77 .\}
78 .if t \{\
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 . ds #V .6m
81 . ds #F 0
82 . ds #[ \&
83 . ds #] \&
84 .\}
85 . \" simple accents for nroff and troff
86 .if n \{\
87 . ds ' \&
88 . ds ` \&
89 . ds ^ \&
90 . ds , \&
91 . ds ~ ~
92 . ds /
93 .\}
94 .if t \{\
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 . ds : e
119 . ds 8 ss
120 . ds o a
121 . ds d- d\h'-1'\(ga
122 . ds D- D\h'-1'\(hy
123 . ds th \o'bp'
124 . ds Th \o'LP'
125 . ds ae ae
126 . ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "VPED.CONF 5"
132 .TH VPED.CONF 5 "2003-03-28" "0.1" "Virtual Private Ethernet"
133 .SH "NAME"
134 vped.conf \- vpe daemon configuration file
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 .Vb 3
138 \& udp-port = 407
139 \& mtu = 1492
140 \& ifname = vpn0
141 .Ve
142 .PP
143 .Vb 2
144 \& node = branch1
145 \& hostname = 1.2.3.4
146 .Ve
147 .PP
148 .Vb 3
149 \& node = branch2
150 \& hostname = www.example.net
151 \& udp-port = 500 # this host uses a different udp-port
152 .Ve
153 .PP
154 .Vb 2
155 \& node = branch3
156 \& connect = ondemand
157 .Ve
158 .SH "DESCRIPTION"
159 .IX Header "DESCRIPTION"
160 The vpe config file consists of a series of lines that contain \f(CW\*(C`variable
161 = value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and
162 extend to the end of the line. They can be used on their own lines, or
163 after any directives. Spaces are allowed before or after the \f(CW\*(C`=\*(C'\fR sign or
164 after values, but not within the variable names or values themselves.
165 .PP
166 The only exception to the above is the \*(L"on\*(R" directive that can prefix any
167 \&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or
168 (if the nodename starts with \*(L"!\*(R") on all nodes except the named one.
169 .PP
170 .Vb 3
171 \& name = value
172 \& on branch1 loglevel = noise
173 \& on !branch2 connect = ondemand
174 .Ve
175 .PP
176 All settings are executed \*(L"in order\*(R", that is, later settings of the same
177 variable overwrite earlier ones.
178 .SH "ANATOMY OF A CONFIG FILE"
179 .IX Header "ANATOMY OF A CONFIG FILE"
180 Usually, a config file starts with global settings (like the udp port to
181 listen on), followed by node-specific sections that begin with a \f(CW\*(C`node =
182 nickname\*(C'\fR line.
183 .PP
184 Every node that is part of the network must have a section that starts
185 with \f(CW\*(C`node = nickname\*(C'\fR. The number and order of the nodes is important
186 and must be the same on all hosts. It is not uncommon for node sections to
187 be completely empty \- if the default values are right.
188 .PP
189 Node-specific settings can be used at any time. If used before the first
190 node section they will set the default values for all following nodes.
191 .SH "CONFIG VARIABLES"
192 .IX Header "CONFIG VARIABLES"
193 .Sh "\s-1GLOBAL\s0 \s-1SETTINGS\s0"
194 .IX Subsection "GLOBAL SETTINGS"
195 Global settings will affect the behaviour of the running vped daemon, that
196 is, they are in some sense node-specific (config files can set different
197 values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of
198 the vped daemon and all connections it creates.
199 .IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4
200 .IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical"
201 Set the logging level. Connection established messages are logged at level
202 \&\f(CW\*(C`info\*(C'\fR, notable errors are logged with \f(CW\*(C`error\*(C'\fR. Default is \f(CW\*(C`info\*(C'\fR.
203 .IP "node = nickname" 4
204 .IX Item "node = nickname"
205 Not really a config setting but introduces a node section. The nickname is
206 used to select the right configuration section and must be passed as an
207 argument to the vped daemon.
208 .IP "private-key = relative-path-to-key" 4
209 .IX Item "private-key = relative-path-to-key"
210 Sets the path (relative to the config directory) to the private key
211 (default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must
212 be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could
213 use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where
214 \&\f(CW\*(C`vpectrl\*(C'\fR puts them.
215 .Sp
216 Since only the private key file of the current node is used and the
217 private key file should be kept secret per-host to avoid spoofings, it is
218 not recommended to use this feature.
219 .IP "ifpersist = yes|true|on | no|false|off" 4
220 .IX Item "ifpersist = yes|true|on | no|false|off"
221 Should the tun/tap device be made persistent, that is, should the device
222 stay up even when vped exits? Some versions of the tunnel device have
223 problems sending packets when vped is restarted in persistent mode, so
224 if the connections can be established but you cannot send packets from
225 the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the
226 device.
227 .IP "ifname = devname" 4
228 .IX Item "ifname = devname"
229 Sets the tun interface name to the given name. The default is OS-specific
230 and most probably something like \f(CW\*(C`tun0\*(C'\fR.
231 .IP "rekey = seconds" 4
232 .IX Item "rekey = seconds"
233 Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are
234 reestablished every \f(CW\*(C`rekey\*(C'\fR seconds.
235 .IP "keepalive = seconds" 4
236 .IX Item "keepalive = seconds"
237 Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this
238 many seconds of inactivity the daemon will start to send keepalive probe
239 every 5 seconds until it receives a reply from the other end. If no reply
240 is received within 30 seconds, the peer is considered unreachable and the
241 connection is closed.
242 .IP "mtu = bytes" 4
243 .IX Item "mtu = bytes"
244 Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically
245 the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate
246 maximum overhead (e.g. udp header size, encryption blocksize...) and pass
247 this information to the \f(CW\*(C`if\-up\*(C'\fR script.
248 .Sp
249 Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
250 .Sp
251 This value must be the minimum of the mtu values of all hosts.
252 .IP "ip-proto = numerical-ip-protocol" 4
253 .IX Item "ip-proto = numerical-ip-protocol"
254 Sets the protocol number to be used for the rawip protocol. This is a
255 global option because all hosts must use the same protocol, and since
256 there are no port numbers, you cannot easily run more than one vped
257 instance using the same protocol, nor can you share the protocol with
258 other programs.
259 .Sp
260 The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through
261 firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other
262 common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98
263 (\s-1ENCAP\s0, rfc1241)
264 .IP "enable-udp = yes|true|on | no|false|off" 4
265 .IX Item "enable-udp = yes|true|on | no|false|off"
266 Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port
267 (default: \f(CW\*(C`yes\*(C'\fR). This is a good general choice since \s-1UDP\s0 tunnels well
268 through many firewalls.
269 .IP "enable-rawip = yes|true|on | no|false|off" 4
270 .IX Item "enable-rawip = yes|true|on | no|false|off"
271 Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol
272 (default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the overhead per packet
273 is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+).
274 .IP "if-up = relative-or-absolute-path" 4
275 .IX Item "if-up = relative-or-absolute-path"
276 Sets the path of a script that should be called immediately after the
277 network interface is initialized (but not neccessarily up). The following
278 environment variables are passed to it (the values are just examples):
279 .RS 4
280 .IP "CONFBASE=/etc/vpe" 4
281 .IX Item "CONFBASE=/etc/vpe"
282 The configuration base directory.
283 .IP "IFNAME=vpn0" 4
284 .IX Item "IFNAME=vpn0"
285 The interface to initialize.
286 .IP "MTU=1436" 4
287 .IX Item "MTU=1436"
288 The \s-1MTU\s0 to set the interface to. You can use lower values (if done
289 consistently on all hosts), but this is usually ineffective.
290 .IP "MAC=fe:fd:80:00:00:01" 4
291 .IX Item "MAC=fe:fd:80:00:00:01"
292 The \s-1MAC\s0 address to set the interface to. The script *must* set the
293 interface \s-1MAC\s0 to this value. On GNU/Linux you will most likely use this:
294 .Sp
295 .Vb 1
296 \& ip link set $IFNAME address $MAC mtu $MTU up
297 .Ve
298 .IP "NODENAME=branch1" 4
299 .IX Item "NODENAME=branch1"
300 The nickname of the current node, as passed to the vped daemon.
301 .IP "NODEID=1" 4
302 .IX Item "NODEID=1"
303 The numerical node id of the current node. The first node mentioned in the
304 config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on.
305 .RE
306 .RS 4
307 .Sp
308 Here is a simple if-up script:
309 .Sp
310 .Vb 5
311 \& #!/bin/sh
312 \& ip link set $IFNAME address $MAC mtu $MTU up
313 \& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
314 \& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
315 \& ip route add 10.0.0.0/8 dev $IFNAME
316 .Ve
317 .Sp
318 More complicated examples (using routing to reduce arp traffic) can be
319 found in the etc/ subdirectory of the distribution.
320 .RE
321 .IP "node-up = relative-or-absolute-path" 4
322 .IX Item "node-up = relative-or-absolute-path"
323 Sets a command (default: no script) that should be called whenever a
324 connection is established (even on rekeying operations). In addition
325 to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment
326 variables will be set:
327 .RS 4
328 .IP "DESTNODE=branch2" 4
329 .IX Item "DESTNODE=branch2"
330 The name of the remote node.
331 .IP "DESTID=2" 4
332 .IX Item "DESTID=2"
333 The node id of the remote node.
334 .IP "DESTIP=188.13.66.8" 4
335 .IX Item "DESTIP=188.13.66.8"
336 The numerical \s-1IP\s0 address of the remote host (vped accepts connections from
337 everywhere, as long as the other host can authenticate itself).
338 .IP "DESTPORT=407 # deprecated" 4
339 .IX Item "DESTPORT=407 # deprecated"
340 The \s-1UDP\s0 port used by the other side.
341 .IP "STATE=UP" 4
342 .IX Item "STATE=UP"
343 Node-up scripts get called with STATE=UP, node-down scripts get called
344 with STATE=DOWN.
345 .RE
346 .RS 4
347 .Sp
348 Here is a nontrivial example that uses nsupdate to update the name => ip
349 mapping in some dns zone:
350 .Sp
351 .Vb 6
352 \& #!/bin/sh
353 \& {
354 \& echo update delete $DESTNODE.lowttl.example.net. a
355 \& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
356 \& echo
357 \& } | nsupdate -d -k $CONFBASE:key.example.net.
358 .Ve
359 .RE
360 .IP "node-down = relative-or-absolute-path" 4
361 .IX Item "node-down = relative-or-absolute-path"
362 Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost.
363 .Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
364 .IX Subsection "NODE SPECIFIC SETTINGS"
365 The following settings are node\-specific, that is, every node can have
366 different settings, even within the same vped instance. Settings that are
367 executed before the first node section set the defaults, settings that are
368 executed within a node section only apply to the given node.
369 .IP "udp-port = port-number" 4
370 .IX Item "udp-port = port-number"
371 Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW407\fR, not
372 officially assigned by \s-1IANA\s0!).
373 .IP "router-priority = positive-number" 4
374 .IX Item "router-priority = positive-number"
375 Sets the router priority of the given host (default: \f(CW0\fR, disabled). If
376 some host tries to connect to another host without a hostname, it asks
377 the router host for it's \s-1IP\s0 address. The router host is the one with the
378 highest priority that is currently reachable. Make sure all clients always
379 connect to the router hosts, otherwise conencting to them is impossible.
380 .IP "connect = ondemand|never|always|disabled" 4
381 .IX Item "connect = ondemand|never|always|disabled"
382 Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always
383 try to establish and keep a conenction to the given host), \f(CW\*(C`never\*(C'\fR
384 (nevr initiate a connection to the given host, but accept connections),
385 \&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and
386 take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad,
387 don't talk to it).
388 .IP "inherit-tos = yes|true|on | no|false|off" 4
389 .IX Item "inherit-tos = yes|true|on | no|false|off"
390 Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when
391 sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then
392 outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
393 to the tunnel device, which is usually what you want.
394 .IP "compress = yes|true|on | no|false|off" 4
395 .IX Item "compress = yes|true|on | no|false|off"
396 Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR).
397 Compression is really cheap even on slow computers and has no size
398 overhead at all, so enabling this is a good idea.
399 .SH "CONFIG DIRECTORY LAYOUT"
400 .IX Header "CONFIG DIRECTORY LAYOUT"
401 The default (or recommended) directory layout for the config directory is:
402 .IP "vped.conf" 4
403 .IX Item "vped.conf"
404 The config file.
405 .IP "if-up" 4
406 .IX Item "if-up"
407 The if-up script
408 .IP "node\-up, node-down" 4
409 .IX Item "node-up, node-down"
410 If used the node up or node-down scripts.
411 .IP "hostkey" 4
412 .IX Item "hostkey"
413 The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host.
414 .IP "pubkey/nodename" 4
415 .IX Item "pubkey/nodename"
416 The public keys of the other nodes, one file per node.
417 .SH "SEE ALSO"
418 .IX Header "SEE ALSO"
419 \&\fIvpe\fR\|(5), \fIvped\fR\|(8), \fIvpectrl\fR\|(8).
420 .SH "AUTHOR"
421 .IX Header "AUTHOR"
422 Marc Lehmann <vpe@plan9.de>