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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.27 by root, Tue Feb 15 14:34:39 2011 UTC vs.
Revision 1.31 by root, Sat Jul 13 04:10:29 2013 UTC

…		…
28	= 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
29	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
30	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
31	values, but not within the variable names or values themselves.	31	values, but not within the variable names or values themselves.
32		32
33	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
34	C<name = value> setting and will only "execute" it on the named node, or	34	variable overwrite earlier ones.
35	(if the nodename starts with "!") on all nodes except the named one.
36		35
		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
37	For example, set the MTU to C<1450> everywhere, loglevel to C<noise> on	48	Example: set the MTU to C<1450> everywhere, C<loglevel> to C<noise> on
38	branch1, and connect to C<ondemand> everywhere but on branch2:	49	C<branch1>, and C<connect> to C<ondemand> everywhere but on branch2.
39		50
40	mtu = 1450	51	mtu = 1450
41	on branch1 loglevel = noise	52	on branch1 loglevel = noise
42	on !branch2 connect = ondemand	53	on !branch2 connect = ondemand
43		54
44	All settings are applied "in order", that is, later settings of the same	55	=item include relative-or-absolute-path
45	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
46		77
47	=head1 ANATOMY OF A CONFIG FILE	78	=head1 ANATOMY OF A CONFIG FILE
48		79
49	Usually, a config file starts with a few global settings (like the UDP	80	Usually, a config file starts with a few global settings (like the UDP
50	port to listen on), followed by node-specific sections that begin with a	81	port to listen on), followed by node-specific sections that begin with a
…		…
67	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
68	the gvpe daemon and all connections it creates.	99	the gvpe daemon and all connections it creates.
69		100
70	=over 4	101	=over 4
71		102
		103	=item chroot = path or /
		104
		105	Tells GVPE to chroot(2) to the specified path after reading all necessary
		106	files, binding to sockets and running the C<if-up> script, but before
		107	running C<node-up> or any other scripts.
		108
		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.
		112
		113	=item chuid = numerical-uid
		114
		115	=item chgid = numerical-gid
		116
		117	These two options tell GVPE to change to the given user and/or group id
		118	after reading all necessary files, binding to sockets and running the
		119	C<if-up> script.
		120
		121	Other scripts, such as C<node-up>, are run with the new user id or group id.
		122
		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
72	=item dns-forw-host = hostname/ip	129	=item dns-forw-host = hostname/ip
73		130
74	The DNS server to forward DNS requests to for the DNS tunnel protocol	131	The DNS server to forward DNS requests to for the DNS tunnel protocol
75	(default: C<127.0.0.1>, changing it is highly recommended).	132	(default: C<127.0.0.1>, changing it is highly recommended).
76		133
77	=item dns-forw-port = port-number	134	=item dns-forw-port = port-number
78		135
79	The port where the C<dns-forw-host> is to be contacted (default: C<53>,	136	The port where the C<dns-forw-host> is to be contacted (default: C<53>,
80	which is fine in most cases).	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.
81		147
82	=item dns-max-outstanding = integer-number-of-requests	148	=item dns-max-outstanding = integer-number-of-requests
83		149
84	The maximum number of outstanding DNS transport requests	150	The maximum number of outstanding DNS transport requests
85	(default: C<100>). GVPE will never issue more requests then the given	151	(default: C<100>). GVPE will never issue more requests then the given
…		…
284		350
285	=item keepalive = seconds	351	=item keepalive = seconds
286		352
287	Sets the keepalive probe interval in seconds (default: C<60>). After this	353	Sets the keepalive probe interval in seconds (default: C<60>). After this
288	many seconds of inactivity the daemon will start to send keepalive probe	354	many seconds of inactivity the daemon will start to send keepalive probe
289	every 3 seconds until it receives a reply from the other end. If no reply	355	every 3 seconds until it receives a reply from the other end. If no reply
290	is received within 15 seconds, the peer is considered unreachable and the	356	is received within 15 seconds, the peer is considered unreachable and the
291	connection is closed.	357	connection is closed.
292		358
293	=item loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical	359	=item loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical
294		360
…		…
304		370
305	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).	371	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
306		372
307	This value must be the minimum of the MTU values of all nodes.	373	This value must be the minimum of the MTU values of all nodes.
308		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
309	=item node = nickname	389	=item node = nickname
310		390
311	Not really a config setting but introduces a node section. The nickname is	391	Not really a config setting but introduces a node section. The nickname is
312	used to select the right configuration section and must be passed as an	392	used to select the right configuration section and must be passed as an
313	argument to the gvpe daemon.	393	argument to the gvpe daemon.
…		…
358		438
359	#!/bin/sh	439	#!/bin/sh
360	{	440	{
361	echo update delete $DESTNODE.lowttl.example.net. a	441	echo update delete $DESTNODE.lowttl.example.net. a
362	echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP	442	echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
363	echo	443	echo
364	} \| nsupdate -d -k $CONFBASE:key.example.net.	444	} \| nsupdate -d -k $CONFBASE:key.example.net.
365		445
366	=item node-change = relative-or-absolute-path	446	=item node-change = relative-or-absolute-path
367		447
368	Same as C<node-change>, but gets called whenever something about a	448	Same as C<node-change>, but gets called whenever something about a
…		…
389	private key file should be kept secret per-node to avoid spoofing, it is	469	private key file should be kept secret per-node to avoid spoofing, it is
390	not recommended to use this feature.	470	not recommended to use this feature.
391		471
392	=item rekey = seconds	472	=item rekey = seconds
393		473
394	Sets the rekeying interval in seconds (default: C<3600>). Connections are	474	Sets the rekeying interval in seconds (default: C<3607>). Connections are
395	reestablished every C<rekey> seconds, making them use a new encryption	475	reestablished every C<rekey> seconds, making them use a new encryption
396	key.	476	key.
397		477
398	=item nfmark = integer	478	=item seed-device = path
399		479
400	This advanced option, when set to a nonzero value (default: C<0>), tries	480	The random device used to initially and regularly seed the random
401	to set the netfilter mark (or fwmark) value on all sockets gvpe uses to	481	number generator (default: F</dev/urandom>). Randomness is of paramount
402	send packets.	482	importance to the security of the algorithms used in gvpe.
403		483
404	This can be used to make gvpe use a different set of routing rules. For	484	On program start and every seed-interval, gvpe will read 64 octets.
405	example, on GNU/Linux, the C<if-up> could set C<nfmark> to 1000 and then
406	put all routing rules into table C<99> and then use an ip rule to make
407	gvpe traffic avoid that routing table, in effect routing normal traffic
408	via gvpe and gvpe traffic via the normal system routing tables:
409		485
410	ip rule add not fwmark 1000 lookup 99	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.
411		494
412	=back	495	=back
413		496
414	=head2 NODE SPECIFIC SETTINGS	497	=head2 NODE SPECIFIC SETTINGS
415		498

Diff Legend

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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents): Revision 1.27 by root, Tue Feb 15 14:34:39 2011 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.27 by root, Tue Feb 15 14:34:39 2011 UTC vs.
Revision 1.31 by root, Sat Jul 13 04:10:29 2013 UTC