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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.5 by pcg, Tue Mar 1 06:27:20 2005 UTC vs.
Revision 1.6 by pcg, Sun Mar 6 18:34:46 2005 UTC

…		…
60	values on different nodes using C<on>), but will affect the behaviour of	60	values on different nodes using C<on>), but will affect the behaviour of
61	the gvpe daemon and all connections it creates.	61	the gvpe daemon and all connections it creates.
62		62
63	=over 4	63	=over 4
64		64
65	=item loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical	65	=item dns-forw-host = hostname/ip
66		66
67	Set the logging level. Connection established messages are logged at level	67	The dns server to forward dns requests to for the DNS tunnel protocol
68	C<info>, notable errors are logged with C<error>. Default is C<info>.	68	(default: C<127.0.0.1>, changing it is highly recommended).
69		69
70	=item node = nickname	70	=item dns-forw-port = port-number
71		71
72	Not really a config setting but introduces a node section. The nickname is	72	The port where the C<dns-forw-host> is to be contacted (default: C<53>,
73	used to select the right configuration section and must be passed as an	73	which is fine in most cases).
74	argument to the gvpe daemon.
75		74
76	=item private-key = relative-path-to-key	75	=item if-up = relative-or-absolute-path
77		76
78	Sets the path (relative to the config directory) to the private key	77	Sets the path of a script that should be called immediately after the
79	(default: C<hostkey>). This is a printf format string so every C<%> must	78	network interface is initialized (but not neccessarily up). The following
80	be doubled. A single C<%s> is replaced by the hostname, so you could	79	environment variables are passed to it (the values are just examples):
81	use paths like C<hostkeys/%s> to fetch the files at the location where
82	C<gvpectrl> puts them.
83		80
84	Since only the private key file of the current node is used and the	81	=over 4
85	private key file should be kept secret per-host to avoid spoofings, it is	82
86	not recommended to use this feature.	83	=item CONFBASE=/etc/gvpe
		84
		85	The configuration base directory.
		86
		87	=item IFNAME=vpn0
		88
		89	The interface to initialize.
		90
		91	=item MTU=1436
		92
		93	The MTU to set the interface to. You can use lower values (if done
		94	consistently on all hosts), but this is usually ineffective.
		95
		96	=item MAC=fe:fd:80:00:00:01
		97
		98	The MAC address to set the interface to. The script must set the
		99	interface MAC to this value. You will most likely use one of these:
		100
		101	ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux
		102	ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD
		103
		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
		114	=item NODENAME=branch1
		115
		116	The nickname of the current node, as passed to the gvpe daemon.
		117
		118	=item NODEID=1
		119
		120	The numerical node id of the current node. The first node mentioned in the
		121	config file gets ID 1, the second ID 2 and so on.
		122
		123	=back
		124
		125	Here is a simple if-up script:
		126
		127	#!/bin/sh
		128	ip link set $IFNAME address $MAC mtu $MTU up
		129	[ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
		130	[ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
		131	ip route add 10.0.0.0/8 dev $IFNAME
		132
		133	More complicated examples (using routing to reduce arp traffic) can be
		134	found in the etc/ subdirectory of the distribution.
		135
		136	=item ifname = devname
		137
		138	Sets the tun interface name to the given name. The default is OS-specific
		139	and most probably something like C<tun0>.
87		140
88	=item ifpersist = yes\|true\|on \| no\|false\|off	141	=item ifpersist = yes\|true\|on \| no\|false\|off
89		142
90	Should the tun/tap device be made persistent, that is, should the device	143	Should the tun/tap device be made persistent, that is, should the device
91	stay up even when gvpe exits? Some versions of the tunnel device have	144	stay up even when gvpe exits? Some versions of the tunnel device have
92	problems sending packets when gvpe is restarted in persistent mode, so	145	problems sending packets when gvpe is restarted in persistent mode, so
93	if the connections can be established but you cannot send packets from	146	if the connections can be established but you cannot send packets from
94	the local node, try to set this to C<off> and do an ifconfig down on the	147	the local node, try to set this to C<off> and do an ifconfig down on the
95	device.	148	device.
96		149
97	=item ifname = devname	150	=item ip-proto = numerical-ip-protocol
98		151
99	Sets the tun interface name to the given name. The default is OS-specific	152	Sets the protocol number to be used for the rawip protocol. This is a
100	and most probably something like C<tun0>.	153	global option because all hosts must use the same protocol, and since
		154	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
		156	other programs.
101		157
102	=item rekey = seconds	158	The default is 47 (GRE), which has a good chance of tunneling through
		159	firewalls (but note that the rawip protocol is not GRE compatible). Other
		160	common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4 (IPIP tunnels) or 98
		161	(ENCAP, rfc1241)
103		162
104	Sets the rekeying interval in seconds (default: C<3600>). Connections are	163	=item http-proxy-host = hostname/ip
105	reestablished every C<rekey> seconds.	164
		165	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
		167	tcp connections through a http proxy server.
		168
		169	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
		171	requires authentication.
		172
		173	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
		175	server better use numerical IP addresses.
		176
		177	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
		179	on a port that the proxy allows (443, https, is a common choice).
		180
		181	If you have a router, connecting to it will suffice. Otherwise tcp must be
		182	enabled on all hosts.
		183
		184	Example:
		185
		186	http-proxy-host = proxy.example.com
		187	http-proxy-port = 3128 # 8080 is another common choice
		188	http-proxy-auth = schmorp:grumbeere
		189
		190	=item http-proxy-port = proxy-tcp-port
		191
		192	The port where your proxy server listens.
		193
		194	=item http-proxy-auth = login:password
		195
		196	The optional login and password used to authenticate to the proxy server,
		197	seperated by a literal colon (C<:>). Only basic authentication is
		198	currently supported.
106		199
107	=item keepalive = seconds	200	=item keepalive = seconds
108		201
109	Sets the keepalive probe interval in seconds (default: C<60>). After this	202	Sets the keepalive probe interval in seconds (default: C<60>). After this
110	many seconds of inactivity the daemon will start to send keepalive probe	203	many seconds of inactivity the daemon will start to send keepalive probe
111	every 5 seconds until it receives a reply from the other end. If no reply	204	every 5 seconds until it receives a reply from the other end. If no reply
112	is received within 30 seconds, the peer is considered unreachable and the	205	is received within 30 seconds, the peer is considered unreachable and the
113	connection is closed.	206	connection is closed.
114		207
		208	=item loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical
		209
		210	Set the logging level. Connection established messages are logged at level
		211	C<info>, notable errors are logged with C<error>. Default is C<info>.
		212
115	=item mtu = bytes	213	=item mtu = bytes
116		214
117	Sets the maximum MTU that should be used on outgoing packets (basically	215	Sets the maximum MTU that should be used on outgoing packets (basically
118	the MTU of the outgoing interface) The daemon will automatically calculate	216	the MTU of the outgoing interface) The daemon will automatically calculate
119	maximum overhead (e.g. udp header size, encryption blocksize...) and pass	217	maximum overhead (e.g. udp header size, encryption blocksize...) and pass
…		…
121		219
122	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).	220	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
123		221
124	This value must be the minimum of the mtu values of all hosts.	222	This value must be the minimum of the mtu values of all hosts.
125		223
126	=item ip-proto = numerical-ip-protocol	224	=item node = nickname
127		225
128	Sets the protocol number to be used for the rawip protocol. This is a	226	Not really a config setting but introduces a node section. The nickname is
129	global option because all hosts must use the same protocol, and since	227	used to select the right configuration section and must be passed as an
130	there are no port numbers, you cannot easily run more than one gvpe	228	argument to the gvpe daemon.
131	instance using the same protocol, nor can you share the protocol with
132	other programs.
133
134	The default is 47 (GRE), which has a good chance of tunneling through
135	firewalls (but note that the rawip protocol is not GRE compatible). Other
136	common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4 (IPIP tunnels) or 98
137	(ENCAP, rfc1241)
138
139	=item if-up = relative-or-absolute-path
140
141	Sets the path of a script that should be called immediately after the
142	network interface is initialized (but not neccessarily up). The following
143	environment variables are passed to it (the values are just examples):
144
145	=over 4
146
147	=item CONFBASE=/etc/gvpe
148
149	The configuration base directory.
150
151	=item IFNAME=vpn0
152
153	The interface to initialize.
154
155	=item MTU=1436
156
157	The MTU to set the interface to. You can use lower values (if done
158	consistently on all hosts), but this is usually ineffective.
159
160	=item MAC=fe:fd:80:00:00:01
161
162	The MAC address to set the interface to. The script must set the
163	interface MAC to this value. You will most likely use one of these:
164
165	ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux
166	ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD
167
168	Please see the C<gvpe.osdep(5)> manpage for platform-specific information.
169
170	=item IFTYPE=native # or tincd
171
172	=item IFSUBTYPE=linux # or freebsd, darwin etc..
173
174	The interface type (C<native> or C<tincd>) and the subtype (usually the os
175	name in lowercase) that this gvpe was configured for. Can be used to select
176	the correct syntax to use for network-related commands.
177
178	=item NODENAME=branch1
179
180	The nickname of the current node, as passed to the gvpe daemon.
181
182	=item NODEID=1
183
184	The numerical node id of the current node. The first node mentioned in the
185	config file gets ID 1, the second ID 2 and so on.
186
187	=back
188
189	Here is a simple if-up script:
190
191	#!/bin/sh
192	ip link set $IFNAME address $MAC mtu $MTU up
193	[ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
194	[ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
195	ip route add 10.0.0.0/8 dev $IFNAME
196
197	More complicated examples (using routing to reduce arp traffic) can be
198	found in the etc/ subdirectory of the distribution.
199		229
200	=item node-up = relative-or-absolute-path	230	=item node-up = relative-or-absolute-path
201		231
202	Sets a command (default: no script) that should be called whenever a	232	Sets a command (default: no script) that should be called whenever a
203	connection is established (even on rekeying operations). In addition	233	connection is established (even on rekeying operations). In addition
…		…
242		272
243	=item node-down = relative-or-absolute-path	273	=item node-down = relative-or-absolute-path
244		274
245	Same as C<node-up>, but gets called whenever a connection is lost.	275	Same as C<node-up>, but gets called whenever a connection is lost.
246		276
247	=item http-proxy-host = hostname/ip
248
249	The C<http-proxy-*> family of options are only available if gvpe was
250	compiled with the C<--enable-http-proxy> option and enable tunneling of
251	tcp connections through a http proxy server.
252
253	C<http-proxy-host> and C<http-proxy-port> should specify the hostname and
254	port number of the proxy server. See C<http-proxy-loginpw> if your proxy
255	requires authentication.
256
257	Please note that gvpe will still try to resolve all hostnames in the
258	configuration file, so if you are behind a proxy without access to a dns
259	server better use numerical IP addresses.
260
261	To make best use of this option disable all protocols except tcp in your
262	config file and make sure your routers (or all other hosts) are listening
263	on a port that the proxy allows (443, https, is a common choice).
264
265	If you have a router, connecting to it will suffice. Otherwise tcp must be
266	enabled on all hosts.
267
268	Example:
269
270	http-proxy-host = proxy.example.com
271	http-proxy-port = 3128 # 8080 is another common choice
272	http-proxy-auth = schmorp:grumbeere
273
274	=item http-proxy-port = proxy-tcp-port
275
276	The port where your proxy server listens.
277
278	=item http-proxy-auth = login:password
279
280	The optional login and password used to authenticate to the proxy server,
281	seperated by a literal colon (C<:>). Only basic authentication is
282	currently supported.
283
284	=item pid-file = path	277	=item pid-file = path
285		278
286	The path to the pid file to check and create (Default:	279	The path to the pid file to check and create
		280	(default: C<LOCALSTATEDIR/run/gvpe.pid>).
		281
		282	=item private-key = relative-path-to-key
		283
		284	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
		286	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
		288	C<gvpectrl> puts them.
		289
		290	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
		292	not recommended to use this feature.
		293
		294	=item rekey = seconds
		295
		296	Sets the rekeying interval in seconds (default: C<3600>). Connections are
		297	reestablished every C<rekey> seconds.
287		298
288	=back	299	=back
289		300
290	=head2 NODE SPECIFIC SETTINGS	301	=head2 NODE SPECIFIC SETTINGS
291		302
…		…
294	executed before the first node section set the defaults, settings that are	305	executed before the first node section set the defaults, settings that are
295	executed within a node section only apply to the given node.	306	executed within a node section only apply to the given node.
296		307
297	=over 4	308	=over 4
298		309
		310	=item compress = yes\|true\|on \| no\|false\|off
		311
		312	Wether to compress data packets sent to this host (default: C<yes>).
		313	Compression is really cheap even on slow computers and has no size
		314	overhead at all, so enabling this is a good idea.
		315
		316	=item connect = ondemand \| never \| always \| disabled
		317
		318	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>
		320	(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
		322	take it down after the keepalive interval) or C<disabled> (node is bad,
		323	don't talk to it).
		324
		325	=item dns-domain = domain-suffix
		326
		327	The DNS domain suffix that points to the DNS tunnel server. Needs to be
		328	set on both client and server.
		329
		330	The domain must point to a NS record that points to the I<dns-hostname>,
		331	i.e.
		332
		333	dns-domainname = tunnel.example.net
		334	dns-hostname = tunnel-server.example.net
		335
		336	Corresponds to the following DNS entries in the C<example.net> domain:
		337
		338	tunnel.example.net. NS tunnel-server.example.net.
		339	tunnel-server.example.net. A 13.13.13.13
		340
		341	=item dns-hostname = hostname/ip
		342
		343	The address to bind the DNS tunnel socket to, similar to the C<hostname>,
		344	but for the DNS tunnel protocol only. Default: C<0.0.0.0>, but that might
		345	change.
		346
299	=item udp-port = port-number	347	=item dns-port = port-number
300		348
301	Sets the port number used by the UDP protocol (default: C<655>, not	349	The port to bind the DNS tunnel socket to. Must be C<0> on all DNS tunnel
302	officially assigned by IANA!).	350	clients and C<53> on the server.
303
304	=item tcp-port = port-number
305
306	Similar to C<udp-port> (default: C<655>), but sets the TCP port number.
307		351
308	=item enable-rawip = yes\|true\|on \| no\|false\|off	352	=item enable-rawip = yes\|true\|on \| no\|false\|off
309		353
310	Enable the RAW IPv4 transport using the C<ip-proto> protocol	354	Enable the RAW IPv4 transport using the C<ip-proto> protocol
311	(default: C<no>). This is the best choice, since the overhead per packet	355	(default: C<no>). This is the best choice, since the overhead per packet
312	is only 38 bytes, as opposed to UDP's 58 (or TCP's 60+).	356	is only 38 bytes, as opposed to UDP's 58 (or TCP's 60+).
313
314	=item enable-udp = yes\|true\|on \| no\|false\|off
315
316	Enable the UDPv4 transport using the C<udp-port> port (default: C<no>,
317	unless no other protocol is enabled for a node, in which case this
318	protocol is enabled automatically). This is a good general choice since
319	UDP tunnels well through many firewalls.
320
321	NOTE: Please specify C<enable-udp = yes> if you want t use it even though
322	it might get switched on automatically, as some future version might
323	default to another default protocol.
324		357
325	=item enable-tcp = yes\|true\|on \| no\|false\|off	358	=item enable-tcp = yes\|true\|on \| no\|false\|off
326		359
327	Enable the TCPv4 transport using the C<tcp-port> port	360	Enable the TCPv4 transport using the C<tcp-port> port
328	(default: C<no>). Support for this horribly unsuitable protocol is only	361	(default: C<no>). Support for this horribly unsuitable protocol is only
329	available when gvpe was compiled using the C<--enable-tcp> option. Never	362	available when gvpe was compiled using the C<--enable-tcp> option. Never
330	use this transport unless you really must, it is horribly ineffiecent and	363	use this transport unless you really must, it is horribly ineffiecent and
331	resource-intensive compared to the other transports.	364	resource-intensive compared to the other transports.
		365
		366	=item enable-udp = yes\|true\|on \| no\|false\|off
		367
		368	Enable the UDPv4 transport using the C<udp-port> port (default: C<no>,
		369	unless no other protocol is enabled for a node, in which case this
		370	protocol is enabled automatically). This is a good general choice since
		371	UDP tunnels well through many firewalls.
		372
		373	NOTE: Please specify C<enable-udp = yes> if you want t use it even though
		374	it might get switched on automatically, as some future version might
		375	default to another default protocol.
		376
		377	=item inherit-tos = yes\|true\|on \| no\|false\|off
		378
		379	Wether to inherit the TOS settings of packets sent to the tunnel when
		380	sending packets to this node (default: C<yes>). If set to C<yes> then
		381	outgoing tunnel packets will have the same TOS setting as the packets sent
		382	to the tunnel device, which is usually what you want.
		383
		384	=item max-retry = positive-number
		385
		386	The maximum interval in seconds (default: C<28800>, 8 hours) between
		387	retries to establish a connection to this node. When a connection cannot
		388	be established, gvpe uses exponential backoff capped at this value. It's
		389	sometimes useful to set this to a much lower value (e.g. C<120>) on
		390	connections to routers that usually are stable but sometimes are down, to
		391	assure quick reconnections.
332		392
333	=item router-priority = 0 \| 1 \| positive-number>2	393	=item router-priority = 0 \| 1 \| positive-number>2
334		394
335	Sets the router priority of the given host (default: C<0>, disabled). If	395	Sets the router priority of the given host (default: C<0>, disabled). If
336	some host tries to connect to another host without a hostname, it asks	396	some host tries to connect to another host without a hostname, it asks
…		…
346	required, bump the C<router-priority> setting to higher than C<1> in their	406	required, bump the C<router-priority> setting to higher than C<1> in their
347	local config to route through specific hosts. If C<router-priority> is	407	local config to route through specific hosts. If C<router-priority> is
348	C<0>, then routing will be refused, so C<1> serves as a "enable, but do	408	C<0>, then routing will be refused, so C<1> serves as a "enable, but do
349	not use by default" switch.	409	not use by default" switch.
350		410
351	=item connect = ondemand \| never \| always \| disabled	411	=item tcp-port = port-number
352		412
353	Sets the connect mode (default: C<always>). It can be C<always> (always	413	Similar to C<udp-port> (default: C<655>), but sets the TCP port number.
354	try to establish and keep a connection to the given host), C<never>
355	(never initiate a connection to the given host, but accept connections),
356	C<ondemand> (try to establish a connection on the first packet sent, and
357	take it down after the keepalive interval) or C<disabled> (node is bad,
358	don't talk to it).
359		414
360	=item inherit-tos = yes\|true\|on \| no\|false\|off	415	=item udp-port = port-number
361		416
362	Wether to inherit the TOS settings of packets sent to the tunnel when	417	Sets the port number used by the UDP protocol (default: C<655>, not
363	sending packets to this node (default: C<yes>). If set to C<yes> then	418	officially assigned by IANA!).
364	outgoing tunnel packets will have the same TOS setting as the packets sent
365	to the tunnel device, which is usually what you want.
366
367	=item compress = yes\|true\|on \| no\|false\|off
368
369	Wether to compress data packets sent to this host (default: C<yes>).
370	Compression is really cheap even on slow computers and has no size
371	overhead at all, so enabling this is a good idea.
372
373	=item max-retry = positive-number
374
375	The maximum interval in seconds (default: C<28800>, 8 hours) between
376	retries to establish a connection to this node. When a connection cannot
377	be established, gvpe uses exponential backoff capped at this value. It's
378	sometimes useful to set this to a much lower value (e.g. C<120>) on
379	connections to routers that usually are stable but sometimes are down, to
380	assure quick reconnections.
381		419
382	=back	420	=back
383		421
384	=head1 CONFIG DIRECTORY LAYOUT	422	=head1 CONFIG DIRECTORY LAYOUT
385		423

Diff Legend

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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents): Revision 1.5 by pcg, Tue Mar 1 06:27:20 2005 UTC vs. Revision 1.6 by pcg, Sun Mar 6 18:34:46 2005 UTC

Diff Legend

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.5 by pcg, Tue Mar 1 06:27:20 2005 UTC vs.
Revision 1.6 by pcg, Sun Mar 6 18:34:46 2005 UTC