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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.2 by pcg, Sun Jul 25 18:11:40 2004 UTC vs.
Revision 1.28 by root, Sun Mar 6 19:40:27 2011 UTC

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

Diff Legend

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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents): Revision 1.2 by pcg, Sun Jul 25 18:11:40 2004 UTC vs. Revision 1.28 by root, Sun Mar 6 19:40:27 2011 UTC

Diff Legend

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.2 by pcg, Sun Jul 25 18:11:40 2004 UTC vs.
Revision 1.28 by root, Sun Mar 6 19:40:27 2011 UTC