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

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

Diff Legend

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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents): Revision 1.5 by pcg, Tue Mar 1 06:27:20 2005 UTC vs. Revision 1.22 by pcg, Mon Sep 1 06:06:11 2008 UTC

Diff Legend

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.5 by pcg, Tue Mar 1 06:27:20 2005 UTC vs.
Revision 1.22 by pcg, Mon Sep 1 06:06:11 2008 UTC