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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.21 by pcg, Mon Sep 1 05:31:28 2008 UTC vs.
Revision 1.36 by root, Thu Jun 25 09:09:29 2015 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 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
37	For example, set the MTU to C<1450> everywhere, loglevel to C<noise> on	67	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:	68	C<branch1>, and C<connect> to C<ondemand> everywhere but on branch2.
39		69
40	mtu = 1450	70	mtu = 1450
41	on branch1 loglevel = noise	71	on branch1 loglevel = noise
42	on !branch2 connect = ondemand	72	on !branch2 connect = ondemand
43		73
44	All settings are applied "in order", that is, later settings of the same	74	=item include relative-or-absolute-path
45	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
46		96
47	=head1 ANATOMY OF A CONFIG FILE	97	=head1 ANATOMY OF A CONFIG FILE
48		98
49	Usually, a config file starts with a few global settings (like the UDP	99	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	100	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	117	values on different nodes using C<on>), but will affect the behaviour of
68	the gvpe daemon and all connections it creates.	118	the gvpe daemon and all connections it creates.
69		119
70	=over 4	120	=over 4
71		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
72	=item dns-forw-host = hostname/ip	148	=item dns-forw-host = hostname/ip
73		149
74	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
75	(default: C<127.0.0.1>, changing it is highly recommended).	151	(default: C<127.0.0.1>, changing it is highly recommended).
76		152
77	=item dns-forw-port = port-number	153	=item dns-forw-port = port-number
78		154
79	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>,
80	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.
81		166
82	=item dns-max-outstanding = integer-number-of-requests	167	=item dns-max-outstanding = integer-number-of-requests
83		168
84	The maximum number of outstanding DNS transport requests	169	The maximum number of outstanding DNS transport requests
85	(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
…		…
237	other programs.	322	other programs.
238		323
239	The default is 47 (GRE), which has a good chance of tunneling	324	The default is 47 (GRE), which has a good chance of tunneling
240	through firewalls (but note that gvpe's rawip protocol is not GRE	325	through firewalls (but note that gvpe's rawip protocol is not GRE
241	compatible). Other common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4	326	compatible). Other common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4
242	(IPIP tunnels) or 98 (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).
243		332
244	=item http-proxy-host = hostname/ip	333	=item http-proxy-host = hostname/ip
245		334
246	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
247	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
…		…
280		369
281	=item keepalive = seconds	370	=item keepalive = seconds
282		371
283	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
284	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
285	every 3 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
286	is received within 15 seconds, the peer is considered unreachable and the	375	is received within 15 seconds, the peer is considered unreachable and the
287	connection is closed.	376	connection is closed.
288		377
289	=item loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical	378	=item loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical
290		379
…		…
300		389
301	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).	390	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
302		391
303	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.
304		393
305	=item node = nickname	394	=item nfmark = integer
306		395
307	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
308	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
309	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
310		407
311	=item node-up = relative-or-absolute-path	408	=item node-up = relative-or-absolute-path
312		409
313	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
314	is established (even on rekeying operations). Note that node-up/down	411	is established (even on rekeying operations). Note that node-up/down
315	scripts will be run asynchronously, but execution is serialised, so there	412	scripts will be run asynchronously, but execution is serialised, so there
316	will only ever be one such script running.	413	will only ever be one such script running.
317		414
318	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
319	environment variables will be set:	416	environment variables will be set (values are just examples):
320		417
321	=over 4	418	=over 4
322		419
323	=item DESTNODE=branch2	420	=item DESTNODE=branch2
324		421
325	The name of the remote node.	422	The name of the remote node.
326		423
327	=item DESTID=2	424	=item DESTID=2
328		425
329	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.
330		432
331	=item DESTIP=188.13.66.8	433	=item DESTIP=188.13.66.8
332		434
333	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
334	everywhere, as long as the other node can authenticate itself).	436	everywhere, as long as the other node can authenticate itself).
335		437
336	=item DESTPORT=655 # deprecated	438	=item DESTPORT=655 # deprecated
337		439
338	The UDP port used by the other side.	440	The protocol port used by the other side, if applicable.
339		441
340	=item STATE=UP	442	=item STATE=up
341		443
342	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
343	with STATE=DOWN.	445	with STATE=change and node-down scripts get called with STATE=down.
344		446
345	=back	447	=back
346		448
347	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
348	mapping in some DNS zone:	450	mapping in some DNS zone:
349		451
350	#!/bin/sh	452	#!/bin/sh
351	{	453	{
352	echo update delete $DESTNODE.lowttl.example.net. a	454	echo update delete $DESTNODE.lowttl.example.net. a
353	echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP	455	echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
354	echo	456	echo
355	} \| nsupdate -d -k $CONFBASE:key.example.net.	457	} \| nsupdate -d -k $CONFBASE:key.example.net.
356		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
357	=item node-down = relative-or-absolute-path	464	=item node-down = relative-or-absolute-path
358		465
359	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.
360		467
361	=item pid-file = path	468	=item pid-file = path
362		469
363	The path to the pid file to check and create	470	The path to the pid file to check and create
364	(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<%%>.
365		473
366	=item private-key = relative-path-to-key	474	=item private-key = relative-path-to-key
367		475
368	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
369	(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
…		…
375	private key file should be kept secret per-node to avoid spoofing, it is	483	private key file should be kept secret per-node to avoid spoofing, it is
376	not recommended to use this feature.	484	not recommended to use this feature.
377		485
378	=item rekey = seconds	486	=item rekey = seconds
379		487
380	Sets the rekeying interval in seconds (default: C<3600>). Connections are	488	Sets the rekeying interval in seconds (default: C<3607>). Connections are
381	reestablished every C<rekey> seconds, making them use a new encryption	489	reestablished every C<rekey> seconds, making them use a new encryption
382	key.	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.
383		526
384	=back	527	=back
385		528
386	=head2 NODE SPECIFIC SETTINGS	529	=head2 NODE SPECIFIC SETTINGS
387		530
…		…
396		539
397	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.
398		541
399	=item compress = yes\|true\|on \| no\|false\|off	542	=item compress = yes\|true\|on \| no\|false\|off
400		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
401	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
402	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
403	overhead at all, so enabling this is often a good idea.	548	only be used when the other side supports compression, so enabling this is
		549	often a good idea.
404		550
405	=item connect = ondemand \| never \| always \| disabled	551	=item connect = ondemand \| never \| always \| disabled
406		552
407	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
408	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>
…		…
499		645
500	=item enable-udp = yes\|true\|on \| no\|false\|off	646	=item enable-udp = yes\|true\|on \| no\|false\|off
501		647
502	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.
503		649
504	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>).
505	unless no other protocol is enabled for a node, in which case this
506	protocol is enabled automatically).
507
508	NOTE: Please specify C<enable-udp = yes> if you want to use it even though
509	it might get switched on automatically, as some future version might
510	default to another default protocol.
511		651
512	=item hostname = hostname \| ip [can not be defaulted]	652	=item hostname = hostname \| ip [can not be defaulted]
513		653
514	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
515	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
…		…
534	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>
535	script in the environment variable C<IFUPDATA>.	675	script in the environment variable C<IFUPDATA>.
536		676
537	=item inherit-tos = yes\|true\|on \| no\|false\|off	677	=item inherit-tos = yes\|true\|on \| no\|false\|off
538		678
539	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
540	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
541	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
542	to the tunnel device, which is usually what you want.	682	to the tunnel device, which is usually what you want.
		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.
543		693
544	=item max-retry = positive-number	694	=item max-retry = positive-number
545		695
546	The maximum interval in seconds (default: C<3600>, one hour) between	696	The maximum interval in seconds (default: C<3600>, one hour) between
547	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
…		…
607		757
608	The default (or recommended) directory layout for the config directory is:	758	The default (or recommended) directory layout for the config directory is:
609		759
610	=over 4	760	=over 4
611		761
612	=item X<gvpe.conf>	762	=item gvpe.conf
613		763
614	The config file.	764	The config file.
615		765
616	=item X<if-up>	766	=item if-up
617		767
618	The if-up script	768	The if-up script
619		769
620	=item X<node-up>, X<node-down>	770	=item node-up, node-down
621		771
622	If used the node up or node-down scripts.	772	If used the node up or node-down scripts.
623		773
624	=item X<hostkey>	774	=item hostkey
625		775
626	The private key (taken from C<hostkeys/nodename>) of the current host.	776	The (default path of the) private key of the current host.
627		777
628	=item X<pubkey/nodename>	778	=item pubkey/nodename
629		779
630	The public keys of the other nodes, one file per node.	780	The public keys of the other nodes, one file per node.
631		781
632	=back	782	=back
633		783

Diff Legend

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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents): Revision 1.21 by pcg, Mon Sep 1 05:31:28 2008 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.21 by pcg, Mon Sep 1 05:31:28 2008 UTC vs.
Revision 1.36 by root, Thu Jun 25 09:09:29 2015 UTC