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

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

Diff Legend

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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents): Revision 1.11 by pcg, Thu Mar 17 22:28:53 2005 UTC vs. Revision 1.24 by pcg, Sat Jul 18 05:59:16 2009 UTC

Diff Legend

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.11 by pcg, Thu Mar 17 22:28:53 2005 UTC vs.
Revision 1.24 by pcg, Sat Jul 18 05:59:16 2009 UTC