[ViewVC] Diff of: cvs/gvpe/doc/gvpe.conf.5.pod

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.18 by pcg, Thu Aug 7 17:30:27 2008 UTC vs.
Revision 1.28 by root, Sun Mar 6 19:40:27 2011 UTC

…		…
2		2
3	gvpe.conf - configuration file for the GNU VPE daemon	3	gvpe.conf - configuration file for the GNU VPE daemon
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
		7	# global options for all nodes
7	udp-port = 407	8	udp-port = 407
8	mtu = 1492	9	mtu = 1492
9	ifname = vpn0	10	ifname = vpn0
10		11
		12	# first node is named branch1 and is at 1.2.3.4
11	node = branch1	13	node = branch1
12	hostname = 1.2.3.4	14	hostname = 1.2.3.4
13		15
		16	# second node uses dns to resolve the address
14	node = branch2	17	node = branch2
15	hostname = www.example.net	18	hostname = www.example.net
16	udp-port = 500 # this host uses a different udp-port	19	udp-port = 500 # this host uses a different udp-port
17		20
		21	# third node has no fixed ip address
18	node = branch3	22	node = branch3
19	connect = ondemand	23	connect = ondemand
20		24
21	=head1 DESCRIPTION	25	=head1 DESCRIPTION
22		26
…		…
24	= value> pairs. Empty lines are ignored. Comments start with a C<#> and	28	= value> pairs. Empty lines are ignored. Comments start with a C<#> and
25	extend to the end of the line. They can be used on their own lines, or	29	extend to the end of the line. They can be used on their own lines, or
26	after any directives. Whitespace is allowed around the C<=> sign or after	30	after any directives. Whitespace is allowed around the C<=> sign or after
27	values, but not within the variable names or values themselves.	31	values, but not within the variable names or values themselves.
28		32
29	The only exception to the above is the "on" directive that can prefix any	33	All settings are applied "in order", that is, later settings of the same
30	C<name = value> setting and will only "execute" it on the named node, or	34	variable overwrite earlier ones.
31	(if the nodename starts with "!") on all nodes except the named one.
32		35
33	name = value	36	The only exceptions to the above are the "on" and "include" directives:
		37
		38	=over 4
		39
		40	=item on nodename ...
		41
		42	=item on !nodename ...
		43
		44	You can prefix any configuration directive with C<on> and a nodename. GVPE
		45	will will only "execute" it on the named node, or (if the nodename starts
		46	with C<!>) on all nodes except the named one.
		47
		48	Example: set the MTU to C<1450> everywhere, C<loglevel> to C<noise> on
		49	C<branch1>, and C<connect> to C<ondemand> everywhere but on branch2.
		50
		51	mtu = 1450
34	on branch1 loglevel = noise	52	on branch1 loglevel = noise
35	on !branch2 connect = ondemand	53	on !branch2 connect = ondemand
36		54
37	All settings are executed "in order", that is, later settings of the same	55	=item include relative-or-absolute-path
38	variable overwrite earlier ones.	56
		57	Reads the specified file (the path must not contain whitespace or C<=>
		58	characters) and evaluate all config directives in it as if they were
		59	spelled out in place of the C<include> directive.
		60
		61	The path is a printf format string, that is, you must escape any C<%>
		62	by doubling it, and you can have a single C<%s> inside, which will be
		63	replaced by the current nodename.
		64
		65	Relative paths are interpreted relative to the GVPE config directory.
		66
		67	Example: include the file F<local.conf> in the config directory on every
		68	node.
		69
		70	include local.conf
		71
		72	Example: include a file F<conf/>nodenameF<.conf>
		73
		74	include conf/%s.conf
		75
		76	=back
39		77
40	=head1 ANATOMY OF A CONFIG FILE	78	=head1 ANATOMY OF A CONFIG FILE
41		79
42	Usually, a config file starts with global settings (like the udp port to	80	Usually, a config file starts with a few global settings (like the UDP
43	listen on), followed by node-specific sections that begin with a C<node =	81	port to listen on), followed by node-specific sections that begin with a
44	nickname> line.	82	C<node = nickname> line.
45		83
46	Every node that is part of the network must have a section that starts	84	Every node that is part of the network must have a section that starts
47	with C<node = nickname>. The number and order of the nodes is important	85	with C<node = nickname>. The number and order of the nodes is important
48	and must be the same on all hosts. It is not uncommon for node sections to	86	and must be the same on all nodes. It is not uncommon for node sections to
49	be completely empty - if the default values are right.	87	be completely empty - if the default values are right.
50		88
51	Node-specific settings can be used at any time. If used before the first	89	Node-specific settings can be used at any time. If used before the first
52	node section they will set the default values for all following nodes.	90	node section they will set the default values for all following nodes.
53		91
…		…
62		100
63	=over 4	101	=over 4
64		102
65	=item dns-forw-host = hostname/ip	103	=item dns-forw-host = hostname/ip
66		104
67	The dns server to forward dns requests to for the DNS tunnel protocol	105	The DNS server to forward DNS requests to for the DNS tunnel protocol
68	(default: C<127.0.0.1>, changing it is highly recommended).	106	(default: C<127.0.0.1>, changing it is highly recommended).
69		107
70	=item dns-forw-port = port-number	108	=item dns-forw-port = port-number
71		109
72	The port where the C<dns-forw-host> is to be contacted (default: C<53>,	110	The port where the C<dns-forw-host> is to be contacted (default: C<53>,
73	which is fine in most cases).	111	which is fine in most cases).
		112
		113	=item dns-case-preserving = yes\|true\|on \| no\|false\|off
		114
		115	Sets whether the DNS transport forwarding server preserves case (DNS
		116	servers have to, but some access systems are even more broken than others)
		117	(default: true).
		118
		119	Normally, when the forwarding server changes the case of domain names then
		120	GVPE will automatically set this to false.
74		121
75	=item dns-max-outstanding = integer-number-of-requests	122	=item dns-max-outstanding = integer-number-of-requests
76		123
77	The maximum number of outstanding DNS transport requests	124	The maximum number of outstanding DNS transport requests
78	(default: C<100>). GVPE will never issue more requests then the given	125	(default: C<100>). GVPE will never issue more requests then the given
79	limit without receiving replies. In heavily overloaded situations it might	126	limit without receiving replies. In heavily overloaded situations it might
80	help to set this to a low number (e.g. C<3> or even C<1>) to limit the	127	help to set this to a low number (e.g. C<3> or even C<1>) to limit the
81	number of parallel requests.	128	number of parallel requests.
82		129
83	The default should be working ok for most links.	130	The default should be working OK for most links.
84		131
85	=item dns-overlap-factor = float	132	=item dns-overlap-factor = float
86		133
87	The DNS transport uses the minimum request latency (B<min_latency>) seen	134	The DNS transport uses the minimum request latency (B<min_latency>) seen
88	during a connection as it's timing base. This factor (default: C<0.5>,	135	during a connection as it's timing base. This factor (default: C<0.5>,
…		…
91	request might be generated every B<min_latency> seconds, which means on	138	request might be generated every B<min_latency> seconds, which means on
92	average there should only ever be one outstanding request. A factor of	139	average there should only ever be one outstanding request. A factor of
93	C<0.5> means that GVPE will send requests twice as often as the minimum	140	C<0.5> means that GVPE will send requests twice as often as the minimum
94	latency measured.	141	latency measured.
95		142
96	For congested or picky dns forwarders you could use a value nearer to or	143	For congested or picky DNS forwarders you could use a value nearer to or
97	exceeding C<1>.	144	exceeding C<1>.
98		145
99	The default should be working ok for most links.	146	The default should be working OK for most links.
100		147
101	=item dns-send-interval = send-interval-in-seconds	148	=item dns-send-interval = send-interval-in-seconds
102		149
103	The minimum send interval (= maximum rate) that the DNS transport will	150	The minimum send interval (= maximum rate) that the DNS transport will
104	use to send new DNS requests. GVPE will not exceed this rate even when	151	use to send new DNS requests. GVPE will not exceed this rate even when
…		…
106	not send more than 100 DNS requests per connection per second. For	153	not send more than 100 DNS requests per connection per second. For
107	high-bandwidth links you could go lower, e.g. to C<0.001> or so. For	154	high-bandwidth links you could go lower, e.g. to C<0.001> or so. For
108	congested or rate-limited links, you might want to go higher, say C<0.1>,	155	congested or rate-limited links, you might want to go higher, say C<0.1>,
109	C<0.2> or even higher.	156	C<0.2> or even higher.
110		157
111	The default should be working ok for most links.	158	The default should be working OK for most links.
112		159
113	=item dns-timeout-factor = float	160	=item dns-timeout-factor = float
114		161
115	Factor to multiply the C<min_latency> (see C<dns-overlap-factor>) by to	162	Factor to multiply the C<min_latency> (see C<dns-overlap-factor>) by to
116	get request timeouts. The default of C<8> means that the DNS transport	163	get request timeouts. The default of C<8> means that the DNS transport
…		…
120		167
121	For congested links a higher value might be necessary (e.g. C<30>). If	168	For congested links a higher value might be necessary (e.g. C<30>). If
122	the link is very stable lower values (e.g. C<2>) might work	169	the link is very stable lower values (e.g. C<2>) might work
123	nicely. Values near or below C<1> makes no sense whatsoever.	170	nicely. Values near or below C<1> makes no sense whatsoever.
124		171
125	The default should be working ok for most links but will result in low	172	The default should be working OK for most links but will result in low
126	throughput if packet loss is high.	173	throughput if packet loss is high.
127		174
128	=item if-up = relative-or-absolute-path	175	=item if-up = relative-or-absolute-path
129		176
130	Sets the path of a script that should be called immediately after the	177	Sets the path of a script that should be called immediately after the
131	network interface is initialized (but not neccessarily up). The following	178	network interface is initialized (but not necessarily up). The following
132	environment variables are passed to it (the values are just examples).	179	environment variables are passed to it (the values are just examples).
133		180
134	Variables that have the same value on all nodes:	181	Variables that have the same value on all nodes:
135		182
136	=over 4	183	=over 4
…		…
152	select the correct syntax to use for network-related commands.	199	select the correct syntax to use for network-related commands.
153		200
154	=item MTU=1436	201	=item MTU=1436
155		202
156	The MTU to set the interface to. You can use lower values (if done	203	The MTU to set the interface to. You can use lower values (if done
157	consistently on all hosts), but this is usually ineffective.	204	consistently on all nodes), but this is usually either inefficient or
		205	simply ineffective.
158		206
159	=item NODES=5	207	=item NODES=5
160		208
161	The number of nodes in this GVPE network.	209	The number of nodes in this GVPE network.
162		210
…		…
174	=item MAC=fe:fd:80:00:00:01	222	=item MAC=fe:fd:80:00:00:01
175		223
176	The MAC address the network interface has to use.	224	The MAC address the network interface has to use.
177		225
178	Might be used to initialize interfaces on platforms where GVPE does not	226	Might be used to initialize interfaces on platforms where GVPE does not
179	do this automatically. Please see the C<gvpe.osdep(5)> manpage for	227	do this automatically. Please see the C<gvpe.osdep(5)> man page for
180	platform-specific information.	228	platform-specific information.
181		229
182	=item NODENAME=branch1	230	=item NODENAME=branch1
183		231
184	The nickname of the node.	232	The nickname of the node.
…		…
201	ip link set $IFNAME up	249	ip link set $IFNAME up
202	[ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME	250	[ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
203	[ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME	251	[ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
204	ip route add 10.0.0.0/8 dev $IFNAME	252	ip route add 10.0.0.0/8 dev $IFNAME
205		253
206	More complicated examples (using routing to reduce arp traffic) can be	254	More complicated examples (using routing to reduce ARP traffic) can be
207	found in the etc/ subdirectory of the distribution.	255	found in the F<etc/> subdirectory of the distribution.
208		256
209	=item ifname = devname	257	=item ifname = devname
210		258
211	Sets the tun interface name to the given name. The default is OS-specific	259	Sets the tun interface name to the given name. The default is OS-specific
212	and most probably something like C<tun0>.	260	and most probably something like C<tun0>.
…		…
221	device.	269	device.
222		270
223	=item ip-proto = numerical-ip-protocol	271	=item ip-proto = numerical-ip-protocol
224		272
225	Sets the protocol number to be used for the rawip protocol. This is a	273	Sets the protocol number to be used for the rawip protocol. This is a
226	global option because all hosts must use the same protocol, and since	274	global option because all nodes must use the same protocol, and since
227	there are no port numbers, you cannot easily run more than one gvpe	275	there are no port numbers, you cannot easily run more than one gvpe
228	instance using the same protocol, nor can you share the protocol with	276	instance using the same protocol, nor can you share the protocol with
229	other programs.	277	other programs.
230		278
231	The default is 47 (GRE), which has a good chance of tunneling through	279	The default is 47 (GRE), which has a good chance of tunneling
232	firewalls (but note that the rawip protocol is not GRE compatible). Other	280	through firewalls (but note that gvpe's rawip protocol is not GRE
233	common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4 (IPIP tunnels) or 98	281	compatible). Other common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4
234	(ENCAP, rfc1241)	282	(IPIP tunnels) or 98 (ENCAP, rfc1241).
		283
		284	Many versions of Linux seem to have a bug that causes them to reorder
		285	packets for some ip protocols (GRE, ESP) but not for others (AH), so
		286	choose wisely (that is, use 51, AH).
235		287
236	=item http-proxy-host = hostname/ip	288	=item http-proxy-host = hostname/ip
237		289
238	The C<http-proxy-*> family of options are only available if gvpe was	290	The C<http-proxy-*> family of options are only available if gvpe was
239	compiled with the C<--enable-http-proxy> option and enable tunneling of	291	compiled with the C<--enable-http-proxy> option and enable tunneling of
…		…
242	C<http-proxy-host> and C<http-proxy-port> should specify the hostname and	294	C<http-proxy-host> and C<http-proxy-port> should specify the hostname and
243	port number of the proxy server. See C<http-proxy-loginpw> if your proxy	295	port number of the proxy server. See C<http-proxy-loginpw> if your proxy
244	requires authentication.	296	requires authentication.
245		297
246	Please note that gvpe will still try to resolve all hostnames in the	298	Please note that gvpe will still try to resolve all hostnames in the
247	configuration file, so if you are behind a proxy without access to a dns	299	configuration file, so if you are behind a proxy without access to a DNS
248	server better use numerical IP addresses.	300	server better use numerical IP addresses.
249		301
250	To make best use of this option disable all protocols except tcp in your	302	To make best use of this option disable all protocols except TCP in your
251	config file and make sure your routers (or all other hosts) are listening	303	config file and make sure your routers (or all other nodes) are listening
252	on a port that the proxy allows (443, https, is a common choice).	304	on a port that the proxy allows (443, https, is a common choice).
253		305
254	If you have a router, connecting to it will suffice. Otherwise tcp must be	306	If you have a router, connecting to it will suffice. Otherwise TCP must be
255	enabled on all hosts.	307	enabled on all nodes.
256		308
257	Example:	309	Example:
258		310
259	http-proxy-host = proxy.example.com	311	http-proxy-host = proxy.example.com
260	http-proxy-port = 3128 # 8080 is another common choice	312	http-proxy-port = 3128 # 8080 is another common choice
…		…
265	The port where your proxy server listens.	317	The port where your proxy server listens.
266		318
267	=item http-proxy-auth = login:password	319	=item http-proxy-auth = login:password
268		320
269	The optional login and password used to authenticate to the proxy server,	321	The optional login and password used to authenticate to the proxy server,
270	seperated by a literal colon (C<:>). Only basic authentication is	322	separated by a literal colon (C<:>). Only basic authentication is
271	currently supported.	323	currently supported.
272		324
273	=item keepalive = seconds	325	=item keepalive = seconds
274		326
275	Sets the keepalive probe interval in seconds (default: C<60>). After this	327	Sets the keepalive probe interval in seconds (default: C<60>). After this
276	many seconds of inactivity the daemon will start to send keepalive probe	328	many seconds of inactivity the daemon will start to send keepalive probe
277	every 5 seconds until it receives a reply from the other end. If no reply	329	every 3 seconds until it receives a reply from the other end. If no reply
278	is received within 30 seconds, the peer is considered unreachable and the	330	is received within 15 seconds, the peer is considered unreachable and the
279	connection is closed.	331	connection is closed.
280		332
281	=item loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical	333	=item loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical
282		334
283	Set the logging level. Connection established messages are logged at level	335	Set the logging level. Connection established messages are logged at level
…		…
285		337
286	=item mtu = bytes	338	=item mtu = bytes
287		339
288	Sets the maximum MTU that should be used on outgoing packets (basically	340	Sets the maximum MTU that should be used on outgoing packets (basically
289	the MTU of the outgoing interface) The daemon will automatically calculate	341	the MTU of the outgoing interface) The daemon will automatically calculate
290	maximum overhead (e.g. udp header size, encryption blocksize...) and pass	342	maximum overhead (e.g. UDP header size, encryption blocksize...) and pass
291	this information to the C<if-up> script.	343	this information to the C<if-up> script.
292		344
293	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).	345	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
294		346
295	This value must be the minimum of the mtu values of all hosts.	347	This value must be the minimum of the MTU values of all nodes.
296		348
297	=item node = nickname	349	=item node = nickname
298		350
299	Not really a config setting but introduces a node section. The nickname is	351	Not really a config setting but introduces a node section. The nickname is
300	used to select the right configuration section and must be passed as an	352	used to select the right configuration section and must be passed as an
301	argument to the gvpe daemon.	353	argument to the gvpe daemon.
302		354
303	=item node-up = relative-or-absolute-path	355	=item node-up = relative-or-absolute-path
304		356
305	Sets a command (default: no script) that should be called whenever a	357	Sets a command (default: none) that should be called whenever a connection
306	connection is established (even on rekeying operations). In addition to	358	is established (even on rekeying operations). Note that node-up/down
		359	scripts will be run asynchronously, but execution is serialised, so there
		360	will only ever be one such script running.
		361
307	all the variables passed to C<if-up> scripts, the following environment	362	In addition to all the variables passed to C<if-up> scripts, the following
308	variables will be set:	363	environment variables will be set (values are just examples):
309		364
310	=over 4	365	=over 4
311		366
312	=item DESTNODE=branch2	367	=item DESTNODE=branch2
313		368
…		…
315		370
316	=item DESTID=2	371	=item DESTID=2
317		372
318	The node id of the remote node.	373	The node id of the remote node.
319		374
		375	=item DESTSI=rawip/88.99.77.55:0
		376
		377	The "socket info" of the target node, protocol dependent but usually in
		378	the format protocol/ip:port.
		379
320	=item DESTIP=188.13.66.8	380	=item DESTIP=188.13.66.8
321		381
322	The numerical IP address of the remote host (gvpe accepts connections from	382	The numerical IP address of the remote node (gvpe accepts connections from
323	everywhere, as long as the other host can authenticate itself).	383	everywhere, as long as the other node can authenticate itself).
324		384
325	=item DESTPORT=655 # deprecated	385	=item DESTPORT=655 # deprecated
326		386
327	The UDP port used by the other side.	387	The protocol port used by the other side, if applicable.
328		388
329	=item STATE=UP	389	=item STATE=up
330		390
331	Node-up scripts get called with STATE=UP, node-down scripts get called	391	Node-up scripts get called with STATE=up, node-change scripts get called
332	with STATE=DOWN.	392	with STATE=change and node-down scripts get called with STATE=down.
333		393
334	=back	394	=back
335		395
336	Here is a nontrivial example that uses nsupdate to update the name => ip	396	Here is a nontrivial example that uses nsupdate to update the name => ip
337	mapping in some dns zone:	397	mapping in some DNS zone:
338		398
339	#!/bin/sh	399	#!/bin/sh
340	{	400	{
341	echo update delete $DESTNODE.lowttl.example.net. a	401	echo update delete $DESTNODE.lowttl.example.net. a
342	echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP	402	echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
343	echo	403	echo
344	} \| nsupdate -d -k $CONFBASE:key.example.net.	404	} \| nsupdate -d -k $CONFBASE:key.example.net.
345		405
		406	=item node-change = relative-or-absolute-path
		407
		408	Same as C<node-change>, but gets called whenever something about a
		409	connection changes (such as the source IP address).
		410
346	=item node-down = relative-or-absolute-path	411	=item node-down = relative-or-absolute-path
347		412
348	Same as C<node-up>, but gets called whenever a connection is lost.	413	Same as C<node-up>, but gets called whenever a connection is lost.
349		414
350	=item pid-file = path	415	=item pid-file = path
…		…
359	be doubled. A single C<%s> is replaced by the hostname, so you could	424	be doubled. A single C<%s> is replaced by the hostname, so you could
360	use paths like C<hostkeys/%s> to fetch the files at the location where	425	use paths like C<hostkeys/%s> to fetch the files at the location where
361	C<gvpectrl> puts them.	426	C<gvpectrl> puts them.
362		427
363	Since only the private key file of the current node is used and the	428	Since only the private key file of the current node is used and the
364	private key file should be kept secret per-host to avoid spoofings, it is	429	private key file should be kept secret per-node to avoid spoofing, it is
365	not recommended to use this feature.	430	not recommended to use this feature.
366		431
367	=item rekey = seconds	432	=item rekey = seconds
368		433
369	Sets the rekeying interval in seconds (default: C<3600>). Connections are	434	Sets the rekeying interval in seconds (default: C<3600>). Connections are
370	reestablished every C<rekey> seconds.	435	reestablished every C<rekey> seconds, making them use a new encryption
		436	key.
		437
		438	=item nfmark = integer
		439
		440	This advanced option, when set to a nonzero value (default: C<0>), tries
		441	to set the netfilter mark (or fwmark) value on all sockets gvpe uses to
		442	send packets.
		443
		444	This can be used to make gvpe use a different set of routing rules. For
		445	example, on GNU/Linux, the C<if-up> could set C<nfmark> to 1000 and then
		446	put all routing rules into table C<99> and then use an ip rule to make
		447	gvpe traffic avoid that routing table, in effect routing normal traffic
		448	via gvpe and gvpe traffic via the normal system routing tables:
		449
		450	ip rule add not fwmark 1000 lookup 99
371		451
372	=back	452	=back
373		453
374	=head2 NODE SPECIFIC SETTINGS	454	=head2 NODE SPECIFIC SETTINGS
375		455
…		…
384		464
385	Allow direct connections to this node. See C<deny-direct> for more info.	465	Allow direct connections to this node. See C<deny-direct> for more info.
386		466
387	=item compress = yes\|true\|on \| no\|false\|off	467	=item compress = yes\|true\|on \| no\|false\|off
388		468
		469	For the current node, this specified whether it will accept compressed
		470	packets, and for all other nodes, this specifies whether to try to
389	Wether to compress data packets sent to this host (default: C<yes>).	471	compress data packets sent to this node (default: C<yes>). Compression is
390	Compression is really cheap even on slow computers and has no size	472	really cheap even on slow computers, has no size overhead at all and will
391	overhead at all, so enabling this is a good idea.	473	only be used when the other side supports compression, so enabling this is
		474	often a good idea.
392		475
393	=item connect = ondemand \| never \| always \| disabled	476	=item connect = ondemand \| never \| always \| disabled
394		477
395	Sets the connect mode (default: C<always>). It can be C<always> (always	478	Sets the connect mode (default: C<always>). It can be C<always> (always
396	try to establish and keep a connection to the given host), C<never>	479	try to establish and keep a connection to the given node), C<never>
397	(never initiate a connection to the given host, but accept connections),	480	(never initiate a connection to the given host, but accept connections),
398	C<ondemand> (try to establish a connection when there are outstanding	481	C<ondemand> (try to establish a connection when there are outstanding
399	packets in the queue and take it down after the keepalive interval) or	482	packets in the queue and take it down after the keepalive interval) or
400	C<disabled> (node is bad, don't talk to it).	483	C<disabled> (node is bad, don't talk to it).
401		484
		485	Routers will automatically be forced to C<always> unless they are
		486	C<disabled>, to ensure all nodes can talk to each other.
		487
402	=item deny-direct = nodename \| *	488	=item deny-direct = nodename \| *
403		489
404	Deny direct connections to the specified node (or all nodes when C<*>	490	Deny direct connections to the specified node (or all nodes when C<*>
405	is given). Only one node can be specified, but you can use multiple	491	is given). Only one node can be specified, but you can use multiple
406	C<allow-direct> and C<deny-direct> statements. This only makes sense in	492	C<allow-direct> and C<deny-direct> statements. This only makes sense in
407	networks with routers, as routers are required for indirect connections.	493	networks with routers, as routers are required for indirect connections.
408		494
409	Sometimes, a node cannot reach some other nodes for reasons of network	495	Sometimes, a node cannot reach some other nodes for reasons of network
410	connectivity. For example, a node behind a firewall that only allows	496	connectivity. For example, a node behind a firewall that only allows
411	conenctions to/from a single other node in the network. In this case one	497	connections to/from a single other node in the network. In this case one
412	should specify C<deny-direct = *> and C<allow-direct = othernodename> (the other	498	should specify C<deny-direct = *> and C<allow-direct = othernodename> (the other
413	node I<must> be a router for this to work).	499	node I<must> be a router for this to work).
414		500
415	The algorithm to check wether a connection may be direct is as follows:	501	The algorithm to check whether a connection may be direct is as follows:
416		502
417	1. Other node mentioned in a C<allow-direct>? If yes, allow the connection.	503	1. Other node mentioned in an C<allow-direct>? If yes, allow the connection.
418		504
419	2. Other node mentioned in a C<deny-direct>? If yes, deny direct connections.	505	2. Other node mentioned in a C<deny-direct>? If yes, deny direct connections.
420		506
421	3. Allow the connection.	507	3. Allow the connection.
422		508
…		…
462		548
463	=item enable-icmp = yes\|true\|on \| no\|false\|off	549	=item enable-icmp = yes\|true\|on \| no\|false\|off
464		550
465	See gvpe.protocol(7) for a description of the ICMP transport protocol.	551	See gvpe.protocol(7) for a description of the ICMP transport protocol.
466		552
467	Enable the ICMP transport using icmp packets of type C<icmp-type> on this	553	Enable the ICMP transport using ICMP packets of type C<icmp-type> on this
468	node.	554	node.
469		555
470	=item enable-rawip = yes\|true\|on \| no\|false\|off	556	=item enable-rawip = yes\|true\|on \| no\|false\|off
471		557
472	See gvpe.protocol(7) for a description of the RAW IP transport protocol.	558	See gvpe.protocol(7) for a description of the RAW IP transport protocol.
…		…
484		570
485	=item enable-udp = yes\|true\|on \| no\|false\|off	571	=item enable-udp = yes\|true\|on \| no\|false\|off
486		572
487	See gvpe.protocol(7) for a description of the UDP transport protocol.	573	See gvpe.protocol(7) for a description of the UDP transport protocol.
488		574
489	Enable the UDPv4 transport using the C<udp-port> port (default: C<no>,	575	Enable the UDPv4 transport using the C<udp-port> port (default: C<no>).
490	unless no other protocol is enabled for a node, in which case this
491	protocol is enabled automatically).
492
493	NOTE: Please specify C<enable-udp = yes> if you want t use it even though
494	it might get switched on automatically, as some future version might
495	default to another default protocol.
496		576
497	=item hostname = hostname \| ip [can not be defaulted]	577	=item hostname = hostname \| ip [can not be defaulted]
498		578
499	Forces the address of this node to be set to the given dns hostname or ip	579	Forces the address of this node to be set to the given DNS hostname or IP
500	address. It will be resolved before each connect request, so dyndns should	580	address. It will be resolved before each connect request, so dyndns should
501	work fine. If this setting is not specified and a router is available,	581	work fine. If this setting is not specified and a router is available,
502	then the router will be queried for the address of this node. Otherwise,	582	then the router will be queried for the address of this node. Otherwise,
503	the connection attempt will fail.	583	the connection attempt will fail.
504		584
		585	Note that DNS resolving is done synchronously, pausing the daemon. If that
		586	is an issue you need to specify IP addresses.
		587
505	=item icmp-type = integer	588	=item icmp-type = integer
506		589
507	Sets the type value to be used for outgoing (and incoming) packets sent	590	Sets the type value to be used for outgoing (and incoming) packets sent
508	via the ICMP transport.	591	via the ICMP transport.
509		592
510	The default is C<0> (which is C<echo-reply>, also known as	593	The default is C<0> (which is C<echo-reply>, also known as
511	"ping-replies"). Other useful values include C<8> (C<echo-request>, a.k.a.	594	"ping-reply"). Other useful values include C<8> (C<echo-request>, a.k.a.
512	"ping") and C<11> (C<time-exceeded>), but any 8-bit value can be used.	595	"ping") and C<11> (C<time-exceeded>), but any 8-bit value can be used.
513		596
514	=item if-up-data = value	597	=item if-up-data = value
515		598
516	The value specified using this directive will be passed to the C<if-up>	599	The value specified using this directive will be passed to the C<if-up>
517	script in the environment variable C<IFUPDATA>.	600	script in the environment variable C<IFUPDATA>.
518		601
519	=item inherit-tos = yes\|true\|on \| no\|false\|off	602	=item inherit-tos = yes\|true\|on \| no\|false\|off
520		603
521	Wether to inherit the TOS settings of packets sent to the tunnel when	604	Whether to inherit the TOS settings of packets sent to the tunnel when
522	sending packets to this node (default: C<yes>). If set to C<yes> then	605	sending packets to this node (default: C<yes>). If set to C<yes> then
523	outgoing tunnel packets will have the same TOS setting as the packets sent	606	outgoing tunnel packets will have the same TOS setting as the packets sent
524	to the tunnel device, which is usually what you want.	607	to the tunnel device, which is usually what you want.
525		608
526	=item max-retry = positive-number	609	=item max-retry = positive-number
527		610
528	The maximum interval in seconds (default: C<3600>, one hour) between	611	The maximum interval in seconds (default: C<3600>, one hour) between
529	retries to establish a connection to this node. When a connection cannot	612	retries to establish a connection to this node. When a connection cannot
530	be established, gvpe uses exponential backoff capped at this value. It's	613	be established, gvpe uses exponential back-off capped at this value. It's
531	sometimes useful to set this to a much lower value (e.g. C<120>) on	614	sometimes useful to set this to a much lower value (e.g. C<120>) on
532	connections to routers that usually are stable but sometimes are down, to	615	connections to routers that usually are stable but sometimes are down, to
533	assure quick reconnections even after longer downtimes.	616	assure quick reconnections even after longer downtimes.
534		617
535	=item max-ttl = seconds	618	=item max-ttl = seconds
…		…
538	(default: C<60>). Gvpe will normally queue packets for a node without an	621	(default: C<60>). Gvpe will normally queue packets for a node without an
539	active connection, in the hope of establishing a connection soon. This	622	active connection, in the hope of establishing a connection soon. This
540	value specifies the maximum lifetime a packet will stay in the queue, if a	623	value specifies the maximum lifetime a packet will stay in the queue, if a
541	packet gets older, it will be thrown away.	624	packet gets older, it will be thrown away.
542		625
543	=item max-queue = positive-number	626	=item max-queue = positive-number>=1
544		627
545	The maximum number of packets that will be queued (default: C<512>)	628	The maximum number of packets that will be queued (default: C<512>)
546	for this node. If more packets are sent then earlier packets will be	629	for this node. If more packets are sent then earlier packets will be
547	expired. See C<max-ttl>, above.	630	expired. See C<max-ttl>, above.
548		631
549	=item router-priority = 0 \| 1 \| positive-number>=2	632	=item router-priority = 0 \| 1 \| positive-number>=2
550		633
551	Sets the router priority of the given host (default: C<0>, disabled). If	634	Sets the router priority of the given node (default: C<0>, disabled).
552	some host tries to connect to another host without a hostname, it asks
553	the router host for it's IP address. The router host is the one with the
554	highest priority larger than C<1> that is currently reachable.
555		635
556	Make sure all hosts always connect (C<connect = always>) to the router	636	If some node tries to connect to another node but it doesn't have a
557	hosts, otherwise connecting to them might be impossible.	637	hostname, it asks a router node for it's IP address. The router node
		638	chosen is the one with the highest priority larger than C<1> that is
		639	currently reachable. This is called a I<mediated> connection, as the
		640	connection itself will still be direct, but it uses another node to
		641	mediate between the two nodes.
		642
		643	The value C<0> disables routing, that means if the node receives a packet
		644	not for itself it will not forward it but instead drop it.
558		645
559	The special value C<1> allows other hosts to route through the router	646	The special value C<1> allows other hosts to route through the router
560	host, but they will never route through it by default. The value C<0>	647	host, but they will never route through it by default (i.e. the config
561	disables routing. The idea behind this is that some hosts can, if	648	file of another node needs to specify a router priority higher than one
		649	to choose such a node for routing).
		650
		651	The idea behind this is that some hosts can, if required, bump the
562	required, bump the C<router-priority> setting to higher than C<1> in their	652	C<router-priority> setting to higher than C<1> in their local config to
563	local config to route through specific hosts. If C<router-priority> is	653	route through specific hosts. If C<router-priority> is C<0>, then routing
564	C<0>, then routing will be refused, so C<1> serves as a "enable, but do	654	will be refused, so C<1> serves as a "enable, but do not use by default"
565	not use by default" switch.	655	switch.
		656
		657	Nodes with C<router-priority> set to C<2> or higher will always be forced
		658	to C<connect> = C<always> (unless they are C<disabled>).
566		659
567	=item tcp-port = port-number	660	=item tcp-port = port-number
568		661
569	Similar to C<udp-port> (default: C<655>), but sets the TCP port number.	662	Similar to C<udp-port> (default: C<655>), but sets the TCP port number.
570		663
…		…
579		672
580	The default (or recommended) directory layout for the config directory is:	673	The default (or recommended) directory layout for the config directory is:
581		674
582	=over 4	675	=over 4
583		676
584	=item X<gvpe.conf>	677	=item gvpe.conf
585		678
586	The config file.	679	The config file.
587		680
588	=item X<if-up>	681	=item if-up
589		682
590	The if-up script	683	The if-up script
591		684
592	=item X<node-up>, X<node-down>	685	=item node-up, node-down
593		686
594	If used the node up or node-down scripts.	687	If used the node up or node-down scripts.
595		688
596	=item X<hostkey>	689	=item hostkey
597		690
598	The private key (taken from C<hostkeys/nodename>) of the current host.	691	The private key (taken from C<hostkeys/nodename>) of the current host.
599		692
600	=item X<pubkey/nodename>	693	=item pubkey/nodename
601		694
602	The public keys of the other nodes, one file per node.	695	The public keys of the other nodes, one file per node.
603		696
604	=back	697	=back
605		698

Diff Legend

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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents): Revision 1.18 by pcg, Thu Aug 7 17:30:27 2008 UTC vs. Revision 1.28 by root, Sun Mar 6 19:40:27 2011 UTC

Diff Legend

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.18 by pcg, Thu Aug 7 17:30:27 2008 UTC vs.
Revision 1.28 by root, Sun Mar 6 19:40:27 2011 UTC