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

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

Diff Legend

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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents): Revision 1.12 by pcg, Wed Mar 23 17:03:58 2005 UTC vs. Revision 1.23 by pcg, Mon Mar 23 15:22:00 2009 UTC

Diff Legend

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.12 by pcg, Wed Mar 23 17:03:58 2005 UTC vs.
Revision 1.23 by pcg, Mon Mar 23 15:22:00 2009 UTC