[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.31 by root, Sat Jul 13 04:10:29 2013 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 nfmark = integer
		376
		377	This advanced option, when set to a nonzero value (default: C<0>), tries
		378	to set the netfilter mark (or fwmark) value on all sockets gvpe uses to
		379	send packets.
		380
		381	This can be used to make gvpe use a different set of routing rules. For
		382	example, on GNU/Linux, the C<if-up> could set C<nfmark> to 1000 and then
		383	put all routing rules into table C<99> and then use an ip rule to make
		384	gvpe traffic avoid that routing table, in effect routing normal traffic
		385	via gvpe and gvpe traffic via the normal system routing tables:
		386
		387	ip rule add not fwmark 1000 lookup 99
		388
		389	=item node = nickname
		390
		391	Not really a config setting but introduces a node section. The nickname is
		392	used to select the right configuration section and must be passed as an
		393	argument to the gvpe daemon.
		394
139	=item if-up = relative-or-absolute-path	395	=item node-up = relative-or-absolute-path
140		396
141	Sets the path of a script that should be called immediately after the	397	Sets a command (default: none) that should be called whenever a connection
142	network interface is initialized (but not neccessarily up). The following	398	is established (even on rekeying operations). Note that node-up/down
		399	scripts will be run asynchronously, but execution is serialised, so there
		400	will only ever be one such script running.
		401
		402	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):	403	environment variables will be set (values are just examples):
144		404
145	=over 4	405	=over 4
146		406
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	407	=item DESTNODE=branch2
179		408
180	The nickname of the current node, as passed to the gvpe daemon.	409	The name of the remote node.
181		410
182	=item NODEID=1	411	=item DESTID=2
183		412
184	The numerical node id of the current node. The first node mentioned in the	413	The node id of the remote node.
185	config file gets ID 1, the second ID 2 and so on.	414
		415	=item DESTSI=rawip/88.99.77.55:0
		416
		417	The "socket info" of the target node, protocol dependent but usually in
		418	the format protocol/ip:port.
		419
		420	=item DESTIP=188.13.66.8
		421
		422	The numerical IP address of the remote node (gvpe accepts connections from
		423	everywhere, as long as the other node can authenticate itself).
		424
		425	=item DESTPORT=655 # deprecated
		426
		427	The protocol port used by the other side, if applicable.
		428
		429	=item STATE=up
		430
		431	Node-up scripts get called with STATE=up, node-change scripts get called
		432	with STATE=change and node-down scripts get called with STATE=down.
186		433
187	=back	434	=back
188		435
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	436	Here is a nontrivial example that uses nsupdate to update the name => ip
234	mapping in some dns zone:	437	mapping in some DNS zone:
235		438
236	#!/bin/sh	439	#!/bin/sh
237	{	440	{
238	echo update delete $DESTNODE.lowttl.example.net. a	441	echo update delete $DESTNODE.lowttl.example.net. a
239	echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP	442	echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
240	echo	443	echo
241	} \| nsupdate -d -k $CONFBASE:key.example.net.	444	} \| nsupdate -d -k $CONFBASE:key.example.net.
242		445
		446	=item node-change = relative-or-absolute-path
		447
		448	Same as C<node-change>, but gets called whenever something about a
		449	connection changes (such as the source IP address).
		450
243	=item node-down = relative-or-absolute-path	451	=item node-down = relative-or-absolute-path
244		452
245	Same as C<node-up>, but gets called whenever a connection is lost.	453	Same as C<node-up>, but gets called whenever a connection is lost.
246		454
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	455	=item pid-file = path
285		456
286	The path to the pid file to check and create (Default:	457	The path to the pid file to check and create
		458	(default: C<LOCALSTATEDIR/run/gvpe.pid>).
		459
		460	=item private-key = relative-path-to-key
		461
		462	Sets the path (relative to the config directory) to the private key
		463	(default: C<hostkey>). This is a printf format string so every C<%> must
		464	be doubled. A single C<%s> is replaced by the hostname, so you could
		465	use paths like C<hostkeys/%s> to fetch the files at the location where
		466	C<gvpectrl> puts them.
		467
		468	Since only the private key file of the current node is used and the
		469	private key file should be kept secret per-node to avoid spoofing, it is
		470	not recommended to use this feature.
		471
		472	=item rekey = seconds
		473
		474	Sets the rekeying interval in seconds (default: C<3607>). Connections are
		475	reestablished every C<rekey> seconds, making them use a new encryption
		476	key.
		477
		478	=item seed-device = path
		479
		480	The random device used to initially and regularly seed the random
		481	number generator (default: F</dev/urandom>). Randomness is of paramount
		482	importance to the security of the algorithms used in gvpe.
		483
		484	On program start and every seed-interval, gvpe will read 64 octets.
		485
		486	Setting this path to the empty string will disable this functionality
		487	completely (the underlying crypto library will likely look for entropy
		488	sources on it's own though, so not all is lost).
		489
		490	=item seed-interval = seconds
		491
		492	The number of seconds between reseeds of the random number generator
		493	(default: C<3613>). A value of C<0> disables this regular reseeding.
287		494
288	=back	495	=back
289		496
290	=head2 NODE SPECIFIC SETTINGS	497	=head2 NODE SPECIFIC SETTINGS
291		498
292	The following settings are node-specific, that is, every node can have	499	The following settings are node-specific, that is, every node can have
293	different settings, even within the same gvpe instance. Settings that are	500	different settings, even within the same gvpe instance. Settings that are
294	executed before the first node section set the defaults, settings that are	501	set before the first node section set the defaults, settings that are
295	executed within a node section only apply to the given node.	502	set within a node section only apply to the given node.
296		503
297	=over 4	504	=over 4
298		505
		506	=item allow-direct = nodename
		507
		508	Allow direct connections to this node. See C<deny-direct> for more info.
		509
		510	=item compress = yes\|true\|on \| no\|false\|off
		511
		512	For the current node, this specified whether it will accept compressed
		513	packets, and for all other nodes, this specifies whether to try to
		514	compress data packets sent to this node (default: C<yes>). Compression is
		515	really cheap even on slow computers, has no size overhead at all and will
		516	only be used when the other side supports compression, so enabling this is
		517	often a good idea.
		518
		519	=item connect = ondemand \| never \| always \| disabled
		520
		521	Sets the connect mode (default: C<always>). It can be C<always> (always
		522	try to establish and keep a connection to the given node), C<never>
		523	(never initiate a connection to the given host, but accept connections),
		524	C<ondemand> (try to establish a connection when there are outstanding
		525	packets in the queue and take it down after the keepalive interval) or
		526	C<disabled> (node is bad, don't talk to it).
		527
		528	Routers will automatically be forced to C<always> unless they are
		529	C<disabled>, to ensure all nodes can talk to each other.
		530
		531	=item deny-direct = nodename \| *
		532
		533	Deny direct connections to the specified node (or all nodes when C<*>
		534	is given). Only one node can be specified, but you can use multiple
		535	C<allow-direct> and C<deny-direct> statements. This only makes sense in
		536	networks with routers, as routers are required for indirect connections.
		537
		538	Sometimes, a node cannot reach some other nodes for reasons of network
		539	connectivity. For example, a node behind a firewall that only allows
		540	connections to/from a single other node in the network. In this case one
		541	should specify C<deny-direct = *> and C<allow-direct = othernodename> (the other
		542	node I<must> be a router for this to work).
		543
		544	The algorithm to check whether a connection may be direct is as follows:
		545
		546	1. Other node mentioned in an C<allow-direct>? If yes, allow the connection.
		547
		548	2. Other node mentioned in a C<deny-direct>? If yes, deny direct connections.
		549
		550	3. Allow the connection.
		551
		552	That is, C<allow-direct> takes precedence over C<deny-direct>.
		553
		554	The check is done in both directions, i.e. both nodes must allow a direct
		555	connection before one is attempted, so you only need to specify connect
		556	limitations on one node.
		557
		558	=item dns-domain = domain-suffix
		559
		560	The DNS domain suffix that points to the DNS tunnel server for this node.
		561
		562	The domain must point to a NS record that points to the I<dns-hostname>,
		563	i.e.
		564
		565	dns-domainname = tunnel.example.net
		566	dns-hostname = tunnel-server.example.net
		567
		568	Corresponds to the following DNS entries in the C<example.net> domain:
		569
		570	tunnel.example.net. NS tunnel-server.example.net.
		571	tunnel-server.example.net. A 13.13.13.13
		572
		573	=item dns-hostname = hostname/ip
		574
		575	The address to bind the DNS tunnel socket to, similar to the C<hostname>,
		576	but for the DNS tunnel protocol only. Default: C<0.0.0.0>, but that might
		577	change.
		578
299	=item udp-port = port-number	579	=item dns-port = port-number
300		580
301	Sets the port number used by the UDP protocol (default: C<655>, not	581	The port to bind the DNS tunnel socket to. Must be C<53> on DNS tunnel servers.
302	officially assigned by IANA!).
303		582
304	=item tcp-port = port-number	583	=item enable-dns = yes\|true\|on \| no\|false\|off
305		584
306	Similar to C<udp-port> (default: C<655>), but sets the TCP port number.	585	See gvpe.protocol(7) for a description of the DNS transport
		586	protocol. Avoid this protocol if you can.
		587
		588	Enable the DNS tunneling protocol on this node, either as server or as
		589	client. Support for this transport protocol is only available when gvpe
		590	was compiled using the C<--enable-dns> option.
		591
		592	=item enable-icmp = yes\|true\|on \| no\|false\|off
		593
		594	See gvpe.protocol(7) for a description of the ICMP transport protocol.
		595
		596	Enable the ICMP transport using ICMP packets of type C<icmp-type> on this
		597	node.
307		598
308	=item enable-rawip = yes\|true\|on \| no\|false\|off	599	=item enable-rawip = yes\|true\|on \| no\|false\|off
309		600
		601	See gvpe.protocol(7) for a description of the RAW IP transport protocol.
		602
310	Enable the RAW IPv4 transport using the C<ip-proto> protocol	603	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	604	(default: C<no>).
312	is only 38 bytes, as opposed to UDP's 58 (or TCP's 60+).	605
		606	=item enable-tcp = yes\|true\|on \| no\|false\|off
		607
		608	See gvpe.protocol(7) for a description of the TCP transport protocol.
		609
		610	Enable the TCPv4 transport using the C<tcp-port> port
		611	(default: C<no>). Support for this transport protocol is only available
		612	when gvpe was compiled using the C<--enable-tcp> option.
313		613
314	=item enable-udp = yes\|true\|on \| no\|false\|off	614	=item enable-udp = yes\|true\|on \| no\|false\|off
315		615
		616	See gvpe.protocol(7) for a description of the UDP transport protocol.
		617
316	Enable the UDPv4 transport using the C<udp-port> port (default: C<no>,	618	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		619
321	NOTE: Please specify C<enable-udp = yes> if you want t use it even though	620	=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		621
325	=item enable-tcp = yes\|true\|on \| no\|false\|off	622	Forces the address of this node to be set to the given DNS hostname or IP
		623	address. It will be resolved before each connect request, so dyndns should
		624	work fine. If this setting is not specified and a router is available,
		625	then the router will be queried for the address of this node. Otherwise,
		626	the connection attempt will fail.
326		627
327	Enable the TCPv4 transport using the C<tcp-port> port	628	Note that DNS resolving is done synchronously, pausing the daemon. If that
328	(default: C<no>). Support for this horribly unsuitable protocol is only	629	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		630
333	=item router-priority = 0 \| 1 \| positive-number>2	631	=item icmp-type = integer
334		632
335	Sets the router priority of the given host (default: C<0>, disabled). If	633	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	634	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		635
340	Make sure all hosts always connect (C<connect = always>) to the router	636	The default is C<0> (which is C<echo-reply>, also known as
341	hosts, otherwise connecting to them might be impossible.	637	"ping-reply"). Other useful values include C<8> (C<echo-request>, a.k.a.
		638	"ping") and C<11> (C<time-exceeded>), but any 8-bit value can be used.
342		639
343	The special value C<1> allows other hosts to route through the router	640	=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		641
351	=item connect = ondemand \| never \| always \| disabled	642	The value specified using this directive will be passed to the C<if-up>
352		643	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		644
360	=item inherit-tos = yes\|true\|on \| no\|false\|off	645	=item inherit-tos = yes\|true\|on \| no\|false\|off
361		646
362	Wether to inherit the TOS settings of packets sent to the tunnel when	647	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	648	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	649	outgoing tunnel packets will have the same TOS setting as the packets sent
365	to the tunnel device, which is usually what you want.	650	to the tunnel device, which is usually what you want.
366		651
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	652	=item max-retry = positive-number
374		653
375	The maximum interval in seconds (default: C<28800>, 8 hours) between	654	The maximum interval in seconds (default: C<3600>, one hour) between
376	retries to establish a connection to this node. When a connection cannot	655	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	656	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	657	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	658	connections to routers that usually are stable but sometimes are down, to
380	assure quick reconnections.	659	assure quick reconnections even after longer downtimes.
		660
		661	=item max-ttl = seconds
		662
		663	Expire packets that couldn't be sent after this many seconds
		664	(default: C<60>). Gvpe will normally queue packets for a node without an
		665	active connection, in the hope of establishing a connection soon. This
		666	value specifies the maximum lifetime a packet will stay in the queue, if a
		667	packet gets older, it will be thrown away.
		668
		669	=item max-queue = positive-number>=1
		670
		671	The maximum number of packets that will be queued (default: C<512>)
		672	for this node. If more packets are sent then earlier packets will be
		673	expired. See C<max-ttl>, above.
		674
		675	=item router-priority = 0 \| 1 \| positive-number>=2
		676
		677	Sets the router priority of the given node (default: C<0>, disabled).
		678
		679	If some node tries to connect to another node but it doesn't have a
		680	hostname, it asks a router node for it's IP address. The router node
		681	chosen is the one with the highest priority larger than C<1> that is
		682	currently reachable. This is called a I<mediated> connection, as the
		683	connection itself will still be direct, but it uses another node to
		684	mediate between the two nodes.
		685
		686	The value C<0> disables routing, that means if the node receives a packet
		687	not for itself it will not forward it but instead drop it.
		688
		689	The special value C<1> allows other hosts to route through the router
		690	host, but they will never route through it by default (i.e. the config
		691	file of another node needs to specify a router priority higher than one
		692	to choose such a node for routing).
		693
		694	The idea behind this is that some hosts can, if required, bump the
		695	C<router-priority> setting to higher than C<1> in their local config to
		696	route through specific hosts. If C<router-priority> is C<0>, then routing
		697	will be refused, so C<1> serves as a "enable, but do not use by default"
		698	switch.
		699
		700	Nodes with C<router-priority> set to C<2> or higher will always be forced
		701	to C<connect> = C<always> (unless they are C<disabled>).
		702
		703	=item tcp-port = port-number
		704
		705	Similar to C<udp-port> (default: C<655>), but sets the TCP port number.
		706
		707	=item udp-port = port-number
		708
		709	Sets the port number used by the UDP protocol (default: C<655>, not
		710	officially assigned by IANA!).
381		711
382	=back	712	=back
383		713
384	=head1 CONFIG DIRECTORY LAYOUT	714	=head1 CONFIG DIRECTORY LAYOUT
385		715
386	The default (or recommended) directory layout for the config directory is:	716	The default (or recommended) directory layout for the config directory is:
387		717
388	=over 4	718	=over 4
389		719
390	=item X<gvpe.conf>	720	=item gvpe.conf
391		721
392	The config file.	722	The config file.
393		723
394	=item X<if-up>	724	=item if-up
395		725
396	The if-up script	726	The if-up script
397		727
398	=item X<node-up>, X<node-down>	728	=item node-up, node-down
399		729
400	If used the node up or node-down scripts.	730	If used the node up or node-down scripts.
401		731
402	=item X<hostkey>	732	=item hostkey
403		733
404	The private key (taken from C<hostkeys/nodename>) of the current host.	734	The private key (taken from C<hostkeys/nodename>) of the current host.
405		735
406	=item X<pubkey/nodename>	736	=item pubkey/nodename
407		737
408	The public keys of the other nodes, one file per node.	738	The public keys of the other nodes, one file per node.
409		739
410	=back	740	=back
411		741
…		…
413		743
414	gvpe(5), gvpe(8), gvpectrl(8).	744	gvpe(5), gvpe(8), gvpectrl(8).
415		745
416	=head1 AUTHOR	746	=head1 AUTHOR
417		747
418	Marc Lehmann <gvpe@plan9.de>	748	Marc Lehmann <gvpe@schmorp.de>
419		749

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.31 by root, Sat Jul 13 04:10:29 2013 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.31 by root, Sat Jul 13 04:10:29 2013 UTC