ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/gvpe/doc/gvpe.conf.5.pod
(Generate patch)

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.2 by pcg, Sun Jul 25 18:11:40 2004 UTC vs.
Revision 1.11 by pcg, Thu Mar 17 22:28:53 2005 UTC

2 2
3gvpe.conf - configuration file for the GNU VPE daemon 3gvpe.conf - configuration file for the GNU VPE daemon
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 enable-udp = yes
8 udp-port = 407 7 udp-port = 407
9 mtu = 1492 8 mtu = 1492
10 ifname = vpn0 9 ifname = vpn0
11 10
12 node = branch1 11 node = branch1
61values on different nodes using C<on>), but will affect the behaviour of 60values on different nodes using C<on>), but will affect the behaviour of
62the gvpe daemon and all connections it creates. 61the gvpe daemon and all connections it creates.
63 62
64=over 4 63=over 4
65 64
66=item loglevel = noise|trace|debug|info|notice|warn|error|critical 65=item dns-forw-host = hostname/ip
67 66
68Set the logging level. Connection established messages are logged at level 67The dns server to forward dns requests to for the DNS tunnel protocol
69C<info>, notable errors are logged with C<error>. Default is C<info>. 68(default: C<127.0.0.1>, changing it is highly recommended).
70 69
71=item node = nickname 70=item dns-forw-port = port-number
72 71
73Not really a config setting but introduces a node section. The nickname is 72The port where the C<dns-forw-host> is to be contacted (default: C<53>,
74used to select the right configuration section and must be passed as an 73which is fine in most cases).
75argument to the gvpe daemon.
76 74
77=item private-key = relative-path-to-key 75=item if-up = relative-or-absolute-path
78 76
79Sets the path (relative to the config directory) to the private key 77Sets the path of a script that should be called immediately after the
80(default: C<hostkey>). This is a printf format string so every C<%> must 78network interface is initialized (but not neccessarily up). The following
81be doubled. A single C<%s> is replaced by the hostname, so you could 79environment variables are passed to it (the values are just examples):
82use paths like C<hostkeys/%s> to fetch the files at the location where
83C<gvpectrl> puts them.
84 80
85Since only the private key file of the current node is used and the 81=over 4
86private key file should be kept secret per-host to avoid spoofings, it is 82
87not recommended to use this feature. 83=item CONFBASE=/etc/gvpe
84
85The configuration base directory.
86
87=item IFNAME=vpn0
88
89The interface to initialize.
90
91=item MTU=1436
92
93The MTU to set the interface to. You can use lower values (if done
94consistently on all hosts), but this is usually ineffective.
95
96=item MAC=fe:fd:80:00:00:01
97
98The MAC address to set the interface to. The script *must* set the
99interface MAC to this value. You will most likely use one of these:
100
101 ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux
102 ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD
103
104Please see the C<gvpe.osdep(5)> manpage for platform-specific information.
105
106=item IFTYPE=native # or tincd
107
108=item IFSUBTYPE=linux # or freebsd, darwin etc..
109
110The interface type (C<native> or C<tincd>) and the subtype (usually the os
111name in lowercase) that this gvpe was configured for. Can be used to select
112the correct syntax to use for network-related commands.
113
114=item NODENAME=branch1
115
116The nickname of the current node, as passed to the gvpe daemon.
117
118=item NODEID=1
119
120The numerical node id of the current node. The first node mentioned in the
121config file gets ID 1, the second ID 2 and so on.
122
123=back
124
125Here is a simple if-up script:
126
127 #!/bin/sh
128 ip link set $IFNAME address $MAC mtu $MTU up
129 [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
130 [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
131 ip route add 10.0.0.0/8 dev $IFNAME
132
133More complicated examples (using routing to reduce arp traffic) can be
134found in the etc/ subdirectory of the distribution.
135
136=item ifname = devname
137
138Sets the tun interface name to the given name. The default is OS-specific
139and most probably something like C<tun0>.
88 140
89=item ifpersist = yes|true|on | no|false|off 141=item ifpersist = yes|true|on | no|false|off
90 142
91Should the tun/tap device be made persistent, that is, should the device 143Should the tun/tap device be made persistent, that is, should the device
92stay up even when gvpe exits? Some versions of the tunnel device have 144stay up even when gvpe exits? Some versions of the tunnel device have
93problems sending packets when gvpe is restarted in persistent mode, so 145problems sending packets when gvpe is restarted in persistent mode, so
94if the connections can be established but you cannot send packets from 146if the connections can be established but you cannot send packets from
95the local node, try to set this to C<off> and do an ifconfig down on the 147the local node, try to set this to C<off> and do an ifconfig down on the
96device. 148device.
97 149
98=item ifname = devname 150=item ip-proto = numerical-ip-protocol
99 151
100Sets the tun interface name to the given name. The default is OS-specific 152Sets the protocol number to be used for the rawip protocol. This is a
101and most probably something like C<tun0>. 153global option because all hosts must use the same protocol, and since
154there are no port numbers, you cannot easily run more than one gvpe
155instance using the same protocol, nor can you share the protocol with
156other programs.
102 157
103=item rekey = seconds 158The default is 47 (GRE), which has a good chance of tunneling through
159firewalls (but note that the rawip protocol is not GRE compatible). Other
160common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4 (IPIP tunnels) or 98
161(ENCAP, rfc1241)
104 162
105Sets the rekeying interval in seconds (default: C<3600>). Connections are 163=item http-proxy-host = hostname/ip
106reestablished every C<rekey> seconds. 164
165The C<http-proxy-*> family of options are only available if gvpe was
166compiled with the C<--enable-http-proxy> option and enable tunneling of
167tcp connections through a http proxy server.
168
169C<http-proxy-host> and C<http-proxy-port> should specify the hostname and
170port number of the proxy server. See C<http-proxy-loginpw> if your proxy
171requires authentication.
172
173Please note that gvpe will still try to resolve all hostnames in the
174configuration file, so if you are behind a proxy without access to a dns
175server better use numerical IP addresses.
176
177To make best use of this option disable all protocols except tcp in your
178config file and make sure your routers (or all other hosts) are listening
179on a port that the proxy allows (443, https, is a common choice).
180
181If you have a router, connecting to it will suffice. Otherwise tcp must be
182enabled on all hosts.
183
184Example:
185
186 http-proxy-host = proxy.example.com
187 http-proxy-port = 3128 # 8080 is another common choice
188 http-proxy-auth = schmorp:grumbeere
189
190=item http-proxy-port = proxy-tcp-port
191
192The port where your proxy server listens.
193
194=item http-proxy-auth = login:password
195
196The optional login and password used to authenticate to the proxy server,
197seperated by a literal colon (C<:>). Only basic authentication is
198currently supported.
107 199
108=item keepalive = seconds 200=item keepalive = seconds
109 201
110Sets the keepalive probe interval in seconds (default: C<60>). After this 202Sets the keepalive probe interval in seconds (default: C<60>). After this
111many seconds of inactivity the daemon will start to send keepalive probe 203many seconds of inactivity the daemon will start to send keepalive probe
112every 5 seconds until it receives a reply from the other end. If no reply 204every 5 seconds until it receives a reply from the other end. If no reply
113is received within 30 seconds, the peer is considered unreachable and the 205is received within 30 seconds, the peer is considered unreachable and the
114connection is closed. 206connection is closed.
115 207
208=item loglevel = noise|trace|debug|info|notice|warn|error|critical
209
210Set the logging level. Connection established messages are logged at level
211C<info>, notable errors are logged with C<error>. Default is C<info>.
212
116=item mtu = bytes 213=item mtu = bytes
117 214
118Sets the maximum MTU that should be used on outgoing packets (basically 215Sets the maximum MTU that should be used on outgoing packets (basically
119the MTU of the outgoing interface) The daemon will automatically calculate 216the MTU of the outgoing interface) The daemon will automatically calculate
120maximum overhead (e.g. udp header size, encryption blocksize...) and pass 217maximum overhead (e.g. udp header size, encryption blocksize...) and pass
122 219
123Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). 220Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
124 221
125This value must be the minimum of the mtu values of all hosts. 222This value must be the minimum of the mtu values of all hosts.
126 223
127=item ip-proto = numerical-ip-protocol 224=item node = nickname
128 225
129Sets the protocol number to be used for the rawip protocol. This is a 226Not really a config setting but introduces a node section. The nickname is
130global option because all hosts must use the same protocol, and since 227used to select the right configuration section and must be passed as an
131there are no port numbers, you cannot easily run more than one gvpe 228argument to the gvpe daemon.
132instance using the same protocol, nor can you share the protocol with
133other programs.
134
135The default is 47 (GRE), which has a good chance of tunneling through
136firewalls (but note that the rawip protocol is not GRE compatible). Other
137common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4 (IPIP tunnels) or 98
138(ENCAP, rfc1241)
139
140=item if-up = relative-or-absolute-path
141
142Sets the path of a script that should be called immediately after the
143network interface is initialized (but not neccessarily up). The following
144environment variables are passed to it (the values are just examples):
145
146=over 4
147
148=item CONFBASE=/etc/gvpe
149
150The configuration base directory.
151
152=item IFNAME=vpn0
153
154The interface to initialize.
155
156=item MTU=1436
157
158The MTU to set the interface to. You can use lower values (if done
159consistently on all hosts), but this is usually ineffective.
160
161=item MAC=fe:fd:80:00:00:01
162
163The MAC address to set the interface to. The script *must* set the
164interface MAC to this value. You will most likely use one of these:
165
166 ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux
167 ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD
168
169Please see the C<gvpe.osdep(5)> manpage for platform-specific information.
170
171=item IFTYPE=native # or tincd
172
173=item IFSUBTYPE=linux # or freebsd, darwin etc..
174
175The interface type (C<native> or C<tincd>) and the subtype (usually the os
176name in lowercase) that this gvpe was configured for. Can be used to select
177the correct syntax to use for network-related commands.
178
179=item NODENAME=branch1
180
181The nickname of the current node, as passed to the gvpe daemon.
182
183=item NODEID=1
184
185The numerical node id of the current node. The first node mentioned in the
186config file gets ID 1, the second ID 2 and so on.
187
188=back
189
190Here is a simple if-up script:
191
192 #!/bin/sh
193 ip link set $IFNAME address $MAC mtu $MTU up
194 [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
195 [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
196 ip route add 10.0.0.0/8 dev $IFNAME
197
198More complicated examples (using routing to reduce arp traffic) can be
199found in the etc/ subdirectory of the distribution.
200 229
201=item node-up = relative-or-absolute-path 230=item node-up = relative-or-absolute-path
202 231
203Sets a command (default: no script) that should be called whenever a 232Sets a command (default: no script) that should be called whenever a
204connection is established (even on rekeying operations). In addition 233connection is established (even on rekeying operations). In addition
243 272
244=item node-down = relative-or-absolute-path 273=item node-down = relative-or-absolute-path
245 274
246Same as C<node-up>, but gets called whenever a connection is lost. 275Same as C<node-up>, but gets called whenever a connection is lost.
247 276
248=item http-proxy-host = hostname/ip
249
250The C<http-proxy-*> family of options are only available if gvpe was
251compiled with the C<--enable-http-proxy> option and enable tunneling of
252tcp connections through a http proxy server.
253
254C<http-proxy-host> and C<http-proxy-port> should specify the hostname and
255port number of the proxy server. See C<http-proxy-loginpw> if your proxy
256requires authentication.
257
258Please note that gvpe will still try to resolve all hostnames in the
259configuration file, so if you are behind a proxy without access to a dns
260server better use numerical IP addresses.
261
262To make best use of this option disable all protocols except tcp in your
263config file and make sure your routers (or all other hosts) are listening
264on a port that the proxy allows (443, https, is a common choice).
265
266If you have a router, connecting to it will suffice. Otherwise tcp must be
267enabled on all hosts.
268
269Example:
270
271 http-proxy-host = proxy.example.com
272 http-proxy-port = 3128 # 8080 is another common choice
273 http-proxy-auth = schmorp:grumbeere
274
275=item http-proxy-port = proxy-tcp-port
276
277The port where your proxy server listens.
278
279=item http-proxy-auth = login:password
280
281The optional login and password used to authenticate to the proxy server,
282seperated by a literal colon (C<:>). Only basic authentication is
283currently supported.
284
285=item pid-file = path 277=item pid-file = path
286 278
287The path to the pid file to check and create (Default: 279The path to the pid file to check and create
280(default: C<LOCALSTATEDIR/run/gvpe.pid>).
281
282=item private-key = relative-path-to-key
283
284Sets the path (relative to the config directory) to the private key
285(default: C<hostkey>). This is a printf format string so every C<%> must
286be doubled. A single C<%s> is replaced by the hostname, so you could
287use paths like C<hostkeys/%s> to fetch the files at the location where
288C<gvpectrl> puts them.
289
290Since only the private key file of the current node is used and the
291private key file should be kept secret per-host to avoid spoofings, it is
292not recommended to use this feature.
293
294=item rekey = seconds
295
296Sets the rekeying interval in seconds (default: C<3600>). Connections are
297reestablished every C<rekey> seconds.
288 298
289=back 299=back
290 300
291=head2 NODE SPECIFIC SETTINGS 301=head2 NODE SPECIFIC SETTINGS
292 302
295executed before the first node section set the defaults, settings that are 305executed before the first node section set the defaults, settings that are
296executed within a node section only apply to the given node. 306executed within a node section only apply to the given node.
297 307
298=over 4 308=over 4
299 309
310=item compress = yes|true|on | no|false|off
311
312Wether to compress data packets sent to this host (default: C<yes>).
313Compression is really cheap even on slow computers and has no size
314overhead at all, so enabling this is a good idea.
315
316=item connect = ondemand | never | always | disabled
317
318Sets the connect mode (default: C<always>). It can be C<always> (always
319try to establish and keep a connection to the given host), C<never>
320(never initiate a connection to the given host, but accept connections),
321C<ondemand> (try to establish a connection on the first packet sent, and
322take it down after the keepalive interval) or C<disabled> (node is bad,
323don't talk to it).
324
325=item dns-domain = domain-suffix
326
327The DNS domain suffix that points to the DNS tunnel server for this node.
328
329The domain must point to a NS record that points to the I<dns-hostname>,
330i.e.
331
332 dns-domainname = tunnel.example.net
333 dns-hostname = tunnel-server.example.net
334
335Corresponds to the following DNS entries in the C<example.net> domain:
336
337 tunnel.example.net. NS tunnel-server.example.net.
338 tunnel-server.example.net. A 13.13.13.13
339
340=item dns-hostname = hostname/ip
341
342The address to bind the DNS tunnel socket to, similar to the C<hostname>,
343but for the DNS tunnel protocol only. Default: C<0.0.0.0>, but that might
344change.
345
300=item udp-port = port-number 346=item dns-port = port-number
301 347
302Sets the port number used by the UDP protocol (default: C<655>, not 348The port to bind the DNS tunnel socket to. Must be C<53> on DNS tunnel servers.
303officially assigned by IANA!).
304 349
305=item tcp-port = port-number 350=item enable-dns = yes|true|on | no|false|off
306 351
307Similar to C<udp-port> (default: C<655>), but sets the TCP port number. 352See gvpe.protocol(7) for a description of the DNS transport
353protocol. Avoid this protocol if you can.
354
355Enable the DNS tunneling protocol on this node, either as server or as
356client. Support for this transport protocol is only available when gvpe
357was compiled using the C<--enable-dns> option.
358
359=item enable-icmp = yes|true|on | no|false|off
360
361See gvpe.protocol(7) for a description of the ICMP transport protocol.
362
363Enable the ICMP transport using icmp packets of type C<icmp-type> on this
364node.
308 365
309=item enable-rawip = yes|true|on | no|false|off 366=item enable-rawip = yes|true|on | no|false|off
310 367
368See gvpe.protocol(7) for a description of the RAW IP transport protocol.
369
311Enable the RAW IPv4 transport using the C<ip-proto> protocol 370Enable the RAW IPv4 transport using the C<ip-proto> protocol
312(default: C<no>). This is the best choice, since the overhead per packet 371(default: C<no>).
313is only 38 bytes, as opposed to UDP's 58 (or TCP's 60+). 372
373=item enable-tcp = yes|true|on | no|false|off
374
375See gvpe.protocol(7) for a description of the TCP transport protocol.
376
377Enable the TCPv4 transport using the C<tcp-port> port
378(default: C<no>). Support for this transport protocol is only available
379when gvpe was compiled using the C<--enable-tcp> option.
314 380
315=item enable-udp = yes|true|on | no|false|off 381=item enable-udp = yes|true|on | no|false|off
316 382
383See gvpe.protocol(7) for a description of the UDP transport protocol.
384
317Enable the UDPv4 transport using the C<udp-port> port (default: C<yes>, 385Enable the UDPv4 transport using the C<udp-port> port (default: C<no>,
318but this will change!). This is a good general choice since UDP tunnels 386unless no other protocol is enabled for a node, in which case this
319well through many firewalls. 387protocol is enabled automatically).
320 388
321NOTE: Please specify C<enable-udp = yes> even though it is the default, as 389NOTE: Please specify C<enable-udp = yes> if you want t use it even though
322some future version will have all protocols disabled by default. 390it might get switched on automatically, as some future version might
391default to another default protocol.
323 392
393=item icmp-type = integer
394
395Sets the type value to be used for outgoing (and incoming) packets sent
396via the ICMP transport.
397
398The default is C<0> (which is C<echo-reply>, also known as
399"ping-replies"). Other useful values include C<8> (C<echo-request>, a.k.a.
400"ping") and C<11> (C<time-exceeded>), but any 8-bit value can be used.
401
324=item enable-tcp = yes|true|on | no|false|off 402=item inherit-tos = yes|true|on | no|false|off
325 403
326Enable the TCPv4 transport using the C<tcp-port> port 404Wether to inherit the TOS settings of packets sent to the tunnel when
327(default: C<no>). Support for this horribly unsuitable protocol is only 405sending packets to this node (default: C<yes>). If set to C<yes> then
328available when gvpe was compiled using the C<--enable-tcp> option. Never 406outgoing tunnel packets will have the same TOS setting as the packets sent
329use this transport unless you really must, it is horribly ineffiecent and 407to the tunnel device, which is usually what you want.
330resource-intensive compared to the other transports.
331 408
409=item max-retry = positive-number
410
411The maximum interval in seconds (default: C<3600>, one hour) between
412retries to establish a connection to this node. When a connection cannot
413be established, gvpe uses exponential backoff capped at this value. It's
414sometimes useful to set this to a much lower value (e.g. C<120>) on
415connections to routers that usually are stable but sometimes are down, to
416assure quick reconnections even after longer downtimes.
417
332=item router-priority = 0 | 1 | positive-number>2 418=item router-priority = 0 | 1 | positive-number>=2
333 419
334Sets the router priority of the given host (default: C<0>, disabled). If 420Sets the router priority of the given host (default: C<0>, disabled). If
335some host tries to connect to another host without a hostname, it asks 421some host tries to connect to another host without a hostname, it asks
336the router host for it's IP address. The router host is the one with the 422the router host for it's IP address. The router host is the one with the
337highest priority larger than C<1> that is currently reachable. 423highest priority larger than C<1> that is currently reachable.
345required, bump the C<router-priority> setting to higher than C<1> in their 431required, bump the C<router-priority> setting to higher than C<1> in their
346local config to route through specific hosts. If C<router-priority> is 432local config to route through specific hosts. If C<router-priority> is
347C<0>, then routing will be refused, so C<1> serves as a "enable, but do 433C<0>, then routing will be refused, so C<1> serves as a "enable, but do
348not use by default" switch. 434not use by default" switch.
349 435
350=item connect = ondemand | never | always | disabled 436=item tcp-port = port-number
351 437
352Sets the connect mode (default: C<always>). It can be C<always> (always 438Similar to C<udp-port> (default: C<655>), but sets the TCP port number.
353try to establish and keep a connection to the given host), C<never>
354(nevr initiate a connection to the given host, but accept connections),
355C<ondemand> (try to establish a connection on the first packet sent, and
356take it down after the keepalive interval) or C<disabled> (node is bad,
357don't talk to it).
358 439
359=item inherit-tos = yes|true|on | no|false|off 440=item udp-port = port-number
360 441
361Wether to inherit the TOS settings of packets sent to the tunnel when 442Sets the port number used by the UDP protocol (default: C<655>, not
362sending packets to this node (default: C<yes>). If set to C<yes> then 443officially assigned by IANA!).
363outgoing tunnel packets will have the same TOS setting as the packets sent
364to the tunnel device, which is usually what you want.
365
366=item compress = yes|true|on | no|false|off
367
368Wether to compress data packets sent to this host (default: C<yes>).
369Compression is really cheap even on slow computers and has no size
370overhead at all, so enabling this is a good idea.
371
372=item max-retry = positive-number
373
374The maximum interval in seconds (default: C<28800>, 8 hours) between
375retries to establish a connection to this node. When a connection cannot
376be established, gvpe uses exponential backoff capped at this value. It's
377sometimes useful to set this to a much lower value (e.g. C<120>) on
378connections to routers that usually are stable but sometimes are down, to
379assure quick reconnections.
380 444
381=back 445=back
382 446
383=head1 CONFIG DIRECTORY LAYOUT 447=head1 CONFIG DIRECTORY LAYOUT
384 448
385The default (or recommended) directory layout for the config directory is: 449The default (or recommended) directory layout for the config directory is:
386 450
387=over 4 451=over 4
388 452
389=item gvpe.conf 453=item X<gvpe.conf>
390 454
391The config file. 455The config file.
392 456
393=item if-up 457=item X<if-up>
394 458
395The if-up script 459The if-up script
396 460
397=item node-up, node-down 461=item X<node-up>, X<node-down>
398 462
399If used the node up or node-down scripts. 463If used the node up or node-down scripts.
400 464
401=item hostkey 465=item X<hostkey>
402 466
403The private key (taken from C<hostkeys/nodename>) of the current host. 467The private key (taken from C<hostkeys/nodename>) of the current host.
404 468
405=item pubkey/nodename 469=item X<pubkey/nodename>
406 470
407The public keys of the other nodes, one file per node. 471The public keys of the other nodes, one file per node.
408 472
409=back 473=back
410 474

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines