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

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

Diff Legend

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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents): Revision 1.19 by pcg, Thu Aug 7 19:07:02 2008 UTC vs. Revision 1.31 by root, Sat Jul 13 04:10:29 2013 UTC

Diff Legend

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.19 by pcg, Thu Aug 7 19:07:02 2008 UTC vs.
Revision 1.31 by root, Sat Jul 13 04:10:29 2013 UTC