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

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

Diff Legend

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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents): Revision 1.9 by pcg, Mon Mar 14 17:40:01 2005 UTC vs. Revision 1.36 by root, Thu Jun 25 09:09:29 2015 UTC

Diff Legend

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.9 by pcg, Mon Mar 14 17:40:01 2005 UTC vs.
Revision 1.36 by root, Thu Jun 25 09:09:29 2015 UTC