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

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.30 by root, Tue Dec 4 13:23:17 2012 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.30 by root, Tue Dec 4 13:23:17 2012 UTC