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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.20 by pcg, Sun Aug 10 22:18:58 2008 UTC vs.
Revision 1.34 by root, Thu Jul 18 17:35:10 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
…		…
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. Whitespace is allowed around the C<=> sign or after	30	after any directives. Whitespace is allowed around the C<=> sign or after
27	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 nodes. 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.
…		…
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).
		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.
74		166
75	=item dns-max-outstanding = integer-number-of-requests	167	=item dns-max-outstanding = integer-number-of-requests
76		168
77	The maximum number of outstanding DNS transport requests	169	The maximum number of outstanding DNS transport requests
78	(default: C<100>). GVPE will never issue more requests then the given	170	(default: C<100>). GVPE will never issue more requests then the given
79	limit without receiving replies. In heavily overloaded situations it might	171	limit without receiving replies. In heavily overloaded situations it might
80	help to set this to a low number (e.g. C<3> or even C<1>) to limit the	172	help to set this to a low number (e.g. C<3> or even C<1>) to limit the
81	number of parallel requests.	173	number of parallel requests.
82		174
83	The default should be working ok for most links.	175	The default should be working OK for most links.
84		176
85	=item dns-overlap-factor = float	177	=item dns-overlap-factor = float
86		178
87	The DNS transport uses the minimum request latency (B<min_latency>) seen	179	The DNS transport uses the minimum request latency (B<min_latency>) seen
88	during a connection as it's timing base. This factor (default: C<0.5>,	180	during a connection as it's timing base. This factor (default: C<0.5>,
…		…
91	request might be generated every B<min_latency> seconds, which means on	183	request might be generated every B<min_latency> seconds, which means on
92	average there should only ever be one outstanding request. A factor of	184	average there should only ever be one outstanding request. A factor of
93	C<0.5> means that GVPE will send requests twice as often as the minimum	185	C<0.5> means that GVPE will send requests twice as often as the minimum
94	latency measured.	186	latency measured.
95		187
96	For congested or picky dns forwarders you could use a value nearer to or	188	For congested or picky DNS forwarders you could use a value nearer to or
97	exceeding C<1>.	189	exceeding C<1>.
98		190
99	The default should be working ok for most links.	191	The default should be working OK for most links.
100		192
101	=item dns-send-interval = send-interval-in-seconds	193	=item dns-send-interval = send-interval-in-seconds
102		194
103	The minimum send interval (= maximum rate) that the DNS transport will	195	The minimum send interval (= maximum rate) that the DNS transport will
104	use to send new DNS requests. GVPE will not exceed this rate even when	196	use to send new DNS requests. GVPE will not exceed this rate even when
…		…
106	not send more than 100 DNS requests per connection per second. For	198	not send more than 100 DNS requests per connection per second. For
107	high-bandwidth links you could go lower, e.g. to C<0.001> or so. For	199	high-bandwidth links you could go lower, e.g. to C<0.001> or so. For
108	congested or rate-limited links, you might want to go higher, say C<0.1>,	200	congested or rate-limited links, you might want to go higher, say C<0.1>,
109	C<0.2> or even higher.	201	C<0.2> or even higher.
110		202
111	The default should be working ok for most links.	203	The default should be working OK for most links.
112		204
113	=item dns-timeout-factor = float	205	=item dns-timeout-factor = float
114		206
115	Factor to multiply the C<min_latency> (see C<dns-overlap-factor>) by to	207	Factor to multiply the C<min_latency> (see C<dns-overlap-factor>) by to
116	get request timeouts. The default of C<8> means that the DNS transport	208	get request timeouts. The default of C<8> means that the DNS transport
…		…
120		212
121	For congested links a higher value might be necessary (e.g. C<30>). If	213	For congested links a higher value might be necessary (e.g. C<30>). If
122	the link is very stable lower values (e.g. C<2>) might work	214	the link is very stable lower values (e.g. C<2>) might work
123	nicely. Values near or below C<1> makes no sense whatsoever.	215	nicely. Values near or below C<1> makes no sense whatsoever.
124		216
125	The default should be working ok for most links but will result in low	217	The default should be working OK for most links but will result in low
126	throughput if packet loss is high.	218	throughput if packet loss is high.
127		219
128	=item if-up = relative-or-absolute-path	220	=item if-up = relative-or-absolute-path
129		221
130	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
131	network interface is initialized (but not neccessarily up). The following	223	network interface is initialized (but not necessarily up). The following
132	environment variables are passed to it (the values are just examples).	224	environment variables are passed to it (the values are just examples).
133		225
134	Variables that have the same value on all nodes:	226	Variables that have the same value on all nodes:
135		227
136	=over 4	228	=over 4
…		…
175	=item MAC=fe:fd:80:00:00:01	267	=item MAC=fe:fd:80:00:00:01
176		268
177	The MAC address the network interface has to use.	269	The MAC address the network interface has to use.
178		270
179	Might be used to initialize interfaces on platforms where GVPE does not	271	Might be used to initialize interfaces on platforms where GVPE does not
180	do this automatically. Please see the C<gvpe.osdep(5)> manpage for	272	do this automatically. Please see the C<gvpe.osdep(5)> man page for
181	platform-specific information.	273	platform-specific information.
182		274
183	=item NODENAME=branch1	275	=item NODENAME=branch1
184		276
185	The nickname of the node.	277	The nickname of the node.
…		…
202	ip link set $IFNAME up	294	ip link set $IFNAME up
203	[ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME	295	[ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
204	[ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME	296	[ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
205	ip route add 10.0.0.0/8 dev $IFNAME	297	ip route add 10.0.0.0/8 dev $IFNAME
206		298
207	More complicated examples (using routing to reduce arp traffic) can be	299	More complicated examples (using routing to reduce ARP traffic) can be
208	found in the etc/ subdirectory of the distribution.	300	found in the F<etc/> subdirectory of the distribution.
209		301
210	=item ifname = devname	302	=item ifname = devname
211		303
212	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
213	and most probably something like C<tun0>.	305	and most probably something like C<tun0>.
…		…
227	global option because all nodes must use the same protocol, and since	319	global option because all nodes must use the same protocol, and since
228	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
229	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
230	other programs.	322	other programs.
231		323
232	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
233	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
234	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
235	(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).
236		332
237	=item http-proxy-host = hostname/ip	333	=item http-proxy-host = hostname/ip
238		334
239	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
240	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
…		…
243	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
244	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
245	requires authentication.	341	requires authentication.
246		342
247	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
248	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
249	server better use numerical IP addresses.	345	server better use numerical IP addresses.
250		346
251	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
252	config file and make sure your routers (or all other nodes) are listening	348	config file and make sure your routers (or all other nodes) are listening
253	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).
254		350
255	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
256	enabled on all nodes.	352	enabled on all nodes.
257		353
258	Example:	354	Example:
259		355
260	http-proxy-host = proxy.example.com	356	http-proxy-host = proxy.example.com
…		…
266	The port where your proxy server listens.	362	The port where your proxy server listens.
267		363
268	=item http-proxy-auth = login:password	364	=item http-proxy-auth = login:password
269		365
270	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,
271	seperated by a literal colon (C<:>). Only basic authentication is	367	separated by a literal colon (C<:>). Only basic authentication is
272	currently supported.	368	currently supported.
273		369
274	=item keepalive = seconds	370	=item keepalive = seconds
275		371
276	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
277	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
278	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
279	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
280	connection is closed.	376	connection is closed.
281		377
282	=item loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical	378	=item loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical
283		379
284	Set the logging level. Connection established messages are logged at level	380	Set the logging level. Connection established messages are logged at level
…		…
286		382
287	=item mtu = bytes	383	=item mtu = bytes
288		384
289	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
290	the MTU of the outgoing interface) The daemon will automatically calculate	386	the MTU of the outgoing interface) The daemon will automatically calculate
291	maximum overhead (e.g. udp header size, encryption blocksize...) and pass	387	maximum overhead (e.g. UDP header size, encryption blocksize...) and pass
292	this information to the C<if-up> script.	388	this information to the C<if-up> script.
293		389
294	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).	390	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
295		391
296	This value must be the minimum of the mtu values of all nodes.	392	This value must be the minimum of the MTU values of all nodes.
297		393
298	=item node = nickname	394	=item nfmark = integer
299		395
300	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
301	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
302	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
303		407
304	=item node-up = relative-or-absolute-path	408	=item node-up = relative-or-absolute-path
305		409
306	Sets a command (default: none) that should be called whenever a connection	410	Sets a command (default: none) that should be called whenever a connection
307	is established (even on rekeying operations). Note that node-up/down	411	is established (even on rekeying operations). Note that node-up/down
308	scripts will be run asynchronously, but execution is serialised, so there	412	scripts will be run asynchronously, but execution is serialised, so there
309	will only ever be one such script running.	413	will only ever be one such script running.
310		414
311	In addition to all the variables passed to C<if-up> scripts, the following	415	In addition to all the variables passed to C<if-up> scripts, the following
312	environment variables will be set:	416	environment variables will be set (values are just examples):
313		417
314	=over 4	418	=over 4
315		419
316	=item DESTNODE=branch2	420	=item DESTNODE=branch2
317		421
318	The name of the remote node.	422	The name of the remote node.
319		423
320	=item DESTID=2	424	=item DESTID=2
321		425
322	The node id of the remote node.	426	The node id of the remote node.
		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.
323		432
324	=item DESTIP=188.13.66.8	433	=item DESTIP=188.13.66.8
325		434
326	The numerical IP address of the remote node (gvpe accepts connections from	435	The numerical IP address of the remote node (gvpe accepts connections from
327	everywhere, as long as the other node can authenticate itself).	436	everywhere, as long as the other node can authenticate itself).
328		437
329	=item DESTPORT=655 # deprecated	438	=item DESTPORT=655 # deprecated
330		439
331	The UDP port used by the other side.	440	The protocol port used by the other side, if applicable.
332		441
333	=item STATE=UP	442	=item STATE=up
334		443
335	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
336	with STATE=DOWN.	445	with STATE=change and node-down scripts get called with STATE=down.
337		446
338	=back	447	=back
339		448
340	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
341	mapping in some dns zone:	450	mapping in some DNS zone:
342		451
343	#!/bin/sh	452	#!/bin/sh
344	{	453	{
345	echo update delete $DESTNODE.lowttl.example.net. a	454	echo update delete $DESTNODE.lowttl.example.net. a
346	echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP	455	echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
347	echo	456	echo
348	} \| nsupdate -d -k $CONFBASE:key.example.net.	457	} \| nsupdate -d -k $CONFBASE:key.example.net.
349		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
350	=item node-down = relative-or-absolute-path	464	=item node-down = relative-or-absolute-path
351		465
352	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.
353		467
354	=item pid-file = path	468	=item pid-file = path
355		469
356	The path to the pid file to check and create	470	The path to the pid file to check and create
357	(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<%%>.
358		473
359	=item private-key = relative-path-to-key	474	=item private-key = relative-path-to-key
360		475
361	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
362	(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
363	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
364	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
365	C<gvpectrl> puts them.	480	C<gvpectrl> puts them.
366		481
367	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
368	private key file should be kept secret per-node to avoid spoofings, it is	483	private key file should be kept secret per-node to avoid spoofing, it is
369	not recommended to use this feature.	484	not recommended to use this feature.
370		485
371	=item rekey = seconds	486	=item rekey = seconds
372		487
373	Sets the rekeying interval in seconds (default: C<3600>). Connections are	488	Sets the rekeying interval in seconds (default: C<3607>). Connections are
374	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.
375		526
376	=back	527	=back
377		528
378	=head2 NODE SPECIFIC SETTINGS	529	=head2 NODE SPECIFIC SETTINGS
379		530
…		…
388		539
389	Allow direct connections to this node. See C<deny-direct> for more info.	540	Allow direct connections to this node. See C<deny-direct> for more info.
390		541
391	=item compress = yes\|true\|on \| no\|false\|off	542	=item compress = yes\|true\|on \| no\|false\|off
392		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
393	Wether to compress data packets sent to this node (default: C<yes>).	546	compress data packets sent to this node (default: C<yes>). Compression is
394	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
395	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.
396		550
397	=item connect = ondemand \| never \| always \| disabled	551	=item connect = ondemand \| never \| always \| disabled
398		552
399	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
400	try to establish and keep a connection to the given node), C<never>	554	try to establish and keep a connection to the given node), C<never>
…		…
413	C<allow-direct> and C<deny-direct> statements. This only makes sense in	567	C<allow-direct> and C<deny-direct> statements. This only makes sense in
414	networks with routers, as routers are required for indirect connections.	568	networks with routers, as routers are required for indirect connections.
415		569
416	Sometimes, a node cannot reach some other nodes for reasons of network	570	Sometimes, a node cannot reach some other nodes for reasons of network
417	connectivity. For example, a node behind a firewall that only allows	571	connectivity. For example, a node behind a firewall that only allows
418	conenctions to/from a single other node in the network. In this case one	572	connections to/from a single other node in the network. In this case one
419	should specify C<deny-direct = *> and C<allow-direct = othernodename> (the other	573	should specify C<deny-direct = *> and C<allow-direct = othernodename> (the other
420	node I<must> be a router for this to work).	574	node I<must> be a router for this to work).
421		575
422	The algorithm to check wether a connection may be direct is as follows:	576	The algorithm to check whether a connection may be direct is as follows:
423		577
424	1. Other node mentioned in a C<allow-direct>? If yes, allow the connection.	578	1. Other node mentioned in an C<allow-direct>? If yes, allow the connection.
425		579
426	2. Other node mentioned in a C<deny-direct>? If yes, deny direct connections.	580	2. Other node mentioned in a C<deny-direct>? If yes, deny direct connections.
427		581
428	3. Allow the connection.	582	3. Allow the connection.
429		583
…		…
469		623
470	=item enable-icmp = yes\|true\|on \| no\|false\|off	624	=item enable-icmp = yes\|true\|on \| no\|false\|off
471		625
472	See gvpe.protocol(7) for a description of the ICMP transport protocol.	626	See gvpe.protocol(7) for a description of the ICMP transport protocol.
473		627
474	Enable the ICMP transport using icmp packets of type C<icmp-type> on this	628	Enable the ICMP transport using ICMP packets of type C<icmp-type> on this
475	node.	629	node.
476		630
477	=item enable-rawip = yes\|true\|on \| no\|false\|off	631	=item enable-rawip = yes\|true\|on \| no\|false\|off
478		632
479	See gvpe.protocol(7) for a description of the RAW IP transport protocol.	633	See gvpe.protocol(7) for a description of the RAW IP transport protocol.
…		…
491		645
492	=item enable-udp = yes\|true\|on \| no\|false\|off	646	=item enable-udp = yes\|true\|on \| no\|false\|off
493		647
494	See gvpe.protocol(7) for a description of the UDP transport protocol.	648	See gvpe.protocol(7) for a description of the UDP transport protocol.
495		649
496	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>).
497	unless no other protocol is enabled for a node, in which case this
498	protocol is enabled automatically).
499
500	NOTE: Please specify C<enable-udp = yes> if you want t use it even though
501	it might get switched on automatically, as some future version might
502	default to another default protocol.
503		651
504	=item hostname = hostname \| ip [can not be defaulted]	652	=item hostname = hostname \| ip [can not be defaulted]
505		653
506	Forces the address of this node to be set to the given dns hostname or ip	654	Forces the address of this node to be set to the given DNS hostname or IP
507	address. It will be resolved before each connect request, so dyndns should	655	address. It will be resolved before each connect request, so dyndns should
508	work fine. If this setting is not specified and a router is available,	656	work fine. If this setting is not specified and a router is available,
509	then the router will be queried for the address of this node. Otherwise,	657	then the router will be queried for the address of this node. Otherwise,
510	the connection attempt will fail.	658	the connection attempt will fail.
511		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
512	=item icmp-type = integer	663	=item icmp-type = integer
513		664
514	Sets the type value to be used for outgoing (and incoming) packets sent	665	Sets the type value to be used for outgoing (and incoming) packets sent
515	via the ICMP transport.	666	via the ICMP transport.
516		667
517	The default is C<0> (which is C<echo-reply>, also known as	668	The default is C<0> (which is C<echo-reply>, also known as
518	"ping-replies"). Other useful values include C<8> (C<echo-request>, a.k.a.	669	"ping-reply"). Other useful values include C<8> (C<echo-request>, a.k.a.
519	"ping") and C<11> (C<time-exceeded>), but any 8-bit value can be used.	670	"ping") and C<11> (C<time-exceeded>), but any 8-bit value can be used.
520		671
521	=item if-up-data = value	672	=item if-up-data = value
522		673
523	The value specified using this directive will be passed to the C<if-up>	674	The value specified using this directive will be passed to the C<if-up>
524	script in the environment variable C<IFUPDATA>.	675	script in the environment variable C<IFUPDATA>.
525		676
526	=item inherit-tos = yes\|true\|on \| no\|false\|off	677	=item inherit-tos = yes\|true\|on \| no\|false\|off
527		678
528	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
529	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
530	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
531	to the tunnel device, which is usually what you want.	682	to the tunnel device, which is usually what you want.
532		683
533	=item max-retry = positive-number	684	=item max-retry = positive-number
534		685
535	The maximum interval in seconds (default: C<3600>, one hour) between	686	The maximum interval in seconds (default: C<3600>, one hour) between
536	retries to establish a connection to this node. When a connection cannot	687	retries to establish a connection to this node. When a connection cannot
537	be established, gvpe uses exponential backoff capped at this value. It's	688	be established, gvpe uses exponential back-off capped at this value. It's
538	sometimes useful to set this to a much lower value (e.g. C<120>) on	689	sometimes useful to set this to a much lower value (e.g. C<120>) on
539	connections to routers that usually are stable but sometimes are down, to	690	connections to routers that usually are stable but sometimes are down, to
540	assure quick reconnections even after longer downtimes.	691	assure quick reconnections even after longer downtimes.
541		692
542	=item max-ttl = seconds	693	=item max-ttl = seconds
…		…
596		747
597	The default (or recommended) directory layout for the config directory is:	748	The default (or recommended) directory layout for the config directory is:
598		749
599	=over 4	750	=over 4
600		751
601	=item X<gvpe.conf>	752	=item gvpe.conf
602		753
603	The config file.	754	The config file.
604		755
605	=item X<if-up>	756	=item if-up
606		757
607	The if-up script	758	The if-up script
608		759
609	=item X<node-up>, X<node-down>	760	=item node-up, node-down
610		761
611	If used the node up or node-down scripts.	762	If used the node up or node-down scripts.
612		763
613	=item X<hostkey>	764	=item hostkey
614		765
615	The private key (taken from C<hostkeys/nodename>) of the current host.	766	The (default path of the) private key of the current host.
616		767
617	=item X<pubkey/nodename>	768	=item pubkey/nodename
618		769
619	The public keys of the other nodes, one file per node.	770	The public keys of the other nodes, one file per node.
620		771
621	=back	772	=back
622		773

Diff Legend

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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents): Revision 1.20 by pcg, Sun Aug 10 22:18:58 2008 UTC vs. Revision 1.34 by root, Thu Jul 18 17:35:10 2013 UTC

Diff Legend

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.20 by pcg, Sun Aug 10 22:18:58 2008 UTC vs.
Revision 1.34 by root, Thu Jul 18 17:35:10 2013 UTC