1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 |
1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 |
2 | .\" |
2 | .\" |
3 | .\" Standard preamble: |
3 | .\" Standard preamble: |
4 | .\" ======================================================================== |
4 | .\" ======================================================================== |
5 | .de Sh \" Subsection heading |
5 | .de Sh \" Subsection heading |
6 | .br |
6 | .br |
… | |
… | |
23 | .ft R |
23 | .ft R |
24 | .fi |
24 | .fi |
25 | .. |
25 | .. |
26 | .\" Set up some character translations and predefined strings. \*(-- will |
26 | .\" Set up some character translations and predefined strings. \*(-- will |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
28 | .\" double quote, and \*(R" will give a right double quote. | will give a |
28 | .\" double quote, and \*(R" will give a right double quote. \*(C+ will |
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
29 | .\" give a nicer C++. Capital omega is used to do unbreakable dashes and |
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
30 | .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. |
31 | .\" nothing in troff, for use with C<>. |
32 | .tr \(*W-|\(bv\*(Tr |
32 | .tr \(*W- |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
34 | .ie n \{\ |
34 | .ie n \{\ |
35 | . ds -- \(*W- |
35 | . ds -- \(*W- |
36 | . ds PI pi |
36 | . ds PI pi |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
… | |
… | |
127 | .\} |
127 | .\} |
128 | .rm #[ #] #H #V #F C |
128 | .rm #[ #] #H #V #F C |
129 | .\" ======================================================================== |
129 | .\" ======================================================================== |
130 | .\" |
130 | .\" |
131 | .IX Title "GVPE.CONF 5" |
131 | .IX Title "GVPE.CONF 5" |
132 | .TH GVPE.CONF 5 "2004-07-25" "1.7" "GNU Virtual Private Ethernet" |
132 | .TH GVPE.CONF 5 "2011-02-15" "2.24" "GNU Virtual Private Ethernet" |
133 | .SH "NAME" |
133 | .SH "NAME" |
134 | gvpe.conf \- configuration file for the GNU VPE daemon |
134 | gvpe.conf \- configuration file for the GNU VPE daemon |
135 | .SH "SYNOPSIS" |
135 | .SH "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
137 | .Vb 4 |
137 | .Vb 4 |
138 | \& enable-udp = yes |
138 | \& # global options for all nodes |
139 | \& udp-port = 407 |
139 | \& udp\-port = 407 |
140 | \& mtu = 1492 |
140 | \& mtu = 1492 |
141 | \& ifname = vpn0 |
141 | \& ifname = vpn0 |
142 | .Ve |
142 | .Ve |
143 | .PP |
143 | .PP |
144 | .Vb 2 |
144 | .Vb 3 |
|
|
145 | \& # first node is named branch1 and is at 1.2.3.4 |
145 | \& node = branch1 |
146 | \& node = branch1 |
146 | \& hostname = 1.2.3.4 |
147 | \& hostname = 1.2.3.4 |
147 | .Ve |
148 | .Ve |
148 | .PP |
149 | .PP |
149 | .Vb 3 |
150 | .Vb 4 |
|
|
151 | \& # second node uses dns to resolve the address |
150 | \& node = branch2 |
152 | \& node = branch2 |
151 | \& hostname = www.example.net |
153 | \& hostname = www.example.net |
152 | \& udp-port = 500 # this host uses a different udp-port |
154 | \& udp\-port = 500 # this host uses a different udp\-port |
153 | .Ve |
155 | .Ve |
154 | .PP |
156 | .PP |
155 | .Vb 2 |
157 | .Vb 3 |
|
|
158 | \& # third node has no fixed ip address |
156 | \& node = branch3 |
159 | \& node = branch3 |
157 | \& connect = ondemand |
160 | \& connect = ondemand |
158 | .Ve |
161 | .Ve |
159 | .SH "DESCRIPTION" |
162 | .SH "DESCRIPTION" |
160 | .IX Header "DESCRIPTION" |
163 | .IX Header "DESCRIPTION" |
161 | The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable |
164 | The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable |
162 | = value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and |
165 | = value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and |
163 | extend to the end of the line. They can be used on their own lines, or |
166 | extend to the end of the line. They can be used on their own lines, or |
164 | after any directives. Spaces are allowed before or after the \f(CW\*(C`=\*(C'\fR sign or |
167 | after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after |
165 | after values, but not within the variable names or values themselves. |
168 | values, but not within the variable names or values themselves. |
166 | .PP |
169 | .PP |
167 | The only exception to the above is the \*(L"on\*(R" directive that can prefix any |
170 | The only exception to the above is the \*(L"on\*(R" directive that can prefix any |
168 | \&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or |
171 | \&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or |
169 | (if the nodename starts with \*(L"!\*(R") on all nodes except the named one. |
172 | (if the nodename starts with \*(L"!\*(R") on all nodes except the named one. |
170 | .PP |
173 | .PP |
|
|
174 | For example, set the \s-1MTU\s0 to \f(CW1450\fR everywhere, loglevel to \f(CW\*(C`noise\*(C'\fR on |
|
|
175 | branch1, and connect to \f(CW\*(C`ondemand\*(C'\fR everywhere but on branch2: |
|
|
176 | .PP |
171 | .Vb 3 |
177 | .Vb 3 |
172 | \& name = value |
178 | \& mtu = 1450 |
173 | \& on branch1 loglevel = noise |
179 | \& on branch1 loglevel = noise |
174 | \& on !branch2 connect = ondemand |
180 | \& on !branch2 connect = ondemand |
175 | .Ve |
181 | .Ve |
176 | .PP |
182 | .PP |
177 | All settings are executed \*(L"in order\*(R", that is, later settings of the same |
183 | All settings are applied \*(L"in order\*(R", that is, later settings of the same |
178 | variable overwrite earlier ones. |
184 | variable overwrite earlier ones. |
179 | .SH "ANATOMY OF A CONFIG FILE" |
185 | .SH "ANATOMY OF A CONFIG FILE" |
180 | .IX Header "ANATOMY OF A CONFIG FILE" |
186 | .IX Header "ANATOMY OF A CONFIG FILE" |
181 | Usually, a config file starts with global settings (like the udp port to |
187 | Usually, a config file starts with a few global settings (like the \s-1UDP\s0 |
182 | listen on), followed by node-specific sections that begin with a \f(CW\*(C`node = |
188 | port to listen on), followed by node-specific sections that begin with a |
183 | nickname\*(C'\fR line. |
189 | \&\f(CW\*(C`node = nickname\*(C'\fR line. |
184 | .PP |
190 | .PP |
185 | Every node that is part of the network must have a section that starts |
191 | Every node that is part of the network must have a section that starts |
186 | with \f(CW\*(C`node = nickname\*(C'\fR. The number and order of the nodes is important |
192 | with \f(CW\*(C`node = nickname\*(C'\fR. The number and order of the nodes is important |
187 | and must be the same on all hosts. It is not uncommon for node sections to |
193 | and must be the same on all nodes. It is not uncommon for node sections to |
188 | be completely empty \- if the default values are right. |
194 | be completely empty \- if the default values are right. |
189 | .PP |
195 | .PP |
190 | Node-specific settings can be used at any time. If used before the first |
196 | Node-specific settings can be used at any time. If used before the first |
191 | node section they will set the default values for all following nodes. |
197 | node section they will set the default values for all following nodes. |
192 | .SH "CONFIG VARIABLES" |
198 | .SH "CONFIG VARIABLES" |
… | |
… | |
195 | .IX Subsection "GLOBAL SETTINGS" |
201 | .IX Subsection "GLOBAL SETTINGS" |
196 | Global settings will affect the behaviour of the running gvpe daemon, that |
202 | Global settings will affect the behaviour of the running gvpe daemon, that |
197 | is, they are in some sense node-specific (config files can set different |
203 | is, they are in some sense node-specific (config files can set different |
198 | values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of |
204 | values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of |
199 | the gvpe daemon and all connections it creates. |
205 | the gvpe daemon and all connections it creates. |
200 | .IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 |
206 | .IP "dns-forw-host = hostname/ip" 4 |
201 | .IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" |
207 | .IX Item "dns-forw-host = hostname/ip" |
202 | Set the logging level. Connection established messages are logged at level |
208 | The \s-1DNS\s0 server to forward \s-1DNS\s0 requests to for the \s-1DNS\s0 tunnel protocol |
203 | \&\f(CW\*(C`info\*(C'\fR, notable errors are logged with \f(CW\*(C`error\*(C'\fR. Default is \f(CW\*(C`info\*(C'\fR. |
209 | (default: \f(CW127.0.0.1\fR, changing it is highly recommended). |
204 | .IP "node = nickname" 4 |
210 | .IP "dns-forw-port = port-number" 4 |
205 | .IX Item "node = nickname" |
211 | .IX Item "dns-forw-port = port-number" |
206 | Not really a config setting but introduces a node section. The nickname is |
212 | The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR, |
207 | used to select the right configuration section and must be passed as an |
213 | which is fine in most cases). |
208 | argument to the gvpe daemon. |
214 | .IP "dns-max-outstanding = integer-number-of-requests" 4 |
209 | .IP "private-key = relative-path-to-key" 4 |
215 | .IX Item "dns-max-outstanding = integer-number-of-requests" |
210 | .IX Item "private-key = relative-path-to-key" |
216 | The maximum number of outstanding \s-1DNS\s0 transport requests |
211 | Sets the path (relative to the config directory) to the private key |
217 | (default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given |
212 | (default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must |
218 | limit without receiving replies. In heavily overloaded situations it might |
213 | be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could |
219 | help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the |
214 | use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where |
220 | number of parallel requests. |
215 | \&\f(CW\*(C`gvpectrl\*(C'\fR puts them. |
|
|
216 | .Sp |
221 | .Sp |
217 | Since only the private key file of the current node is used and the |
222 | The default should be working \s-1OK\s0 for most links. |
218 | private key file should be kept secret per-host to avoid spoofings, it is |
223 | .IP "dns-overlap-factor = float" 4 |
219 | not recommended to use this feature. |
224 | .IX Item "dns-overlap-factor = float" |
|
|
225 | The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen |
|
|
226 | during a connection as it's timing base. This factor (default: \f(CW0.5\fR, |
|
|
227 | must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending |
|
|
228 | rate (= minimum send interval), i.e. a factor of \f(CW1\fR means that a new |
|
|
229 | request might be generated every \fBmin_latency\fR seconds, which means on |
|
|
230 | average there should only ever be one outstanding request. A factor of |
|
|
231 | \&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum |
|
|
232 | latency measured. |
|
|
233 | .Sp |
|
|
234 | For congested or picky \s-1DNS\s0 forwarders you could use a value nearer to or |
|
|
235 | exceeding \f(CW1\fR. |
|
|
236 | .Sp |
|
|
237 | The default should be working \s-1OK\s0 for most links. |
|
|
238 | .IP "dns-send-interval = send-interval-in-seconds" 4 |
|
|
239 | .IX Item "dns-send-interval = send-interval-in-seconds" |
|
|
240 | The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will |
|
|
241 | use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when |
|
|
242 | the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will |
|
|
243 | not send more than 100 \s-1DNS\s0 requests per connection per second. For |
|
|
244 | high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For |
|
|
245 | congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR, |
|
|
246 | \&\f(CW0.2\fR or even higher. |
|
|
247 | .Sp |
|
|
248 | The default should be working \s-1OK\s0 for most links. |
|
|
249 | .IP "dns-timeout-factor = float" 4 |
|
|
250 | .IX Item "dns-timeout-factor = float" |
|
|
251 | Factor to multiply the \f(CW\*(C`min_latency\*(C'\fR (see \f(CW\*(C`dns\-overlap\-factor\*(C'\fR) by to |
|
|
252 | get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport |
|
|
253 | will resend the request when no reply has been received for longer than |
|
|
254 | eight times the minimum (= expected) latency, assuming the request or |
|
|
255 | reply has been lost. |
|
|
256 | .Sp |
|
|
257 | For congested links a higher value might be necessary (e.g. \f(CW30\fR). If |
|
|
258 | the link is very stable lower values (e.g. \f(CW2\fR) might work |
|
|
259 | nicely. Values near or below \f(CW1\fR makes no sense whatsoever. |
|
|
260 | .Sp |
|
|
261 | The default should be working \s-1OK\s0 for most links but will result in low |
|
|
262 | throughput if packet loss is high. |
|
|
263 | .IP "if-up = relative-or-absolute-path" 4 |
|
|
264 | .IX Item "if-up = relative-or-absolute-path" |
|
|
265 | Sets the path of a script that should be called immediately after the |
|
|
266 | network interface is initialized (but not necessarily up). The following |
|
|
267 | environment variables are passed to it (the values are just examples). |
|
|
268 | .Sp |
|
|
269 | Variables that have the same value on all nodes: |
|
|
270 | .RS 4 |
|
|
271 | .IP "CONFBASE=/etc/gvpe" 4 |
|
|
272 | .IX Item "CONFBASE=/etc/gvpe" |
|
|
273 | The configuration base directory. |
|
|
274 | .IP "IFNAME=vpn0" 4 |
|
|
275 | .IX Item "IFNAME=vpn0" |
|
|
276 | The network interface to initialize. |
|
|
277 | .IP "IFTYPE=native # or tincd" 4 |
|
|
278 | .IX Item "IFTYPE=native # or tincd" |
|
|
279 | .PD 0 |
|
|
280 | .IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 |
|
|
281 | .IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." |
|
|
282 | .PD |
|
|
283 | The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the |
|
|
284 | \&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to |
|
|
285 | select the correct syntax to use for network-related commands. |
|
|
286 | .IP "MTU=1436" 4 |
|
|
287 | .IX Item "MTU=1436" |
|
|
288 | The \s-1MTU\s0 to set the interface to. You can use lower values (if done |
|
|
289 | consistently on all nodes), but this is usually either inefficient or |
|
|
290 | simply ineffective. |
|
|
291 | .IP "NODES=5" 4 |
|
|
292 | .IX Item "NODES=5" |
|
|
293 | The number of nodes in this \s-1GVPE\s0 network. |
|
|
294 | .RE |
|
|
295 | .RS 4 |
|
|
296 | .Sp |
|
|
297 | Variables that are node-specific and with values pertaining to the node |
|
|
298 | running this \s-1GVPE:\s0 |
|
|
299 | .IP "IFUPDATA=string" 4 |
|
|
300 | .IX Item "IFUPDATA=string" |
|
|
301 | The value of the configuration directive \f(CW\*(C`if\-up\-data\*(C'\fR. |
|
|
302 | .IP "MAC=fe:fd:80:00:00:01" 4 |
|
|
303 | .IX Item "MAC=fe:fd:80:00:00:01" |
|
|
304 | The \s-1MAC\s0 address the network interface has to use. |
|
|
305 | .Sp |
|
|
306 | Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not |
|
|
307 | do this automatically. Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR man page for |
|
|
308 | platform-specific information. |
|
|
309 | .IP "NODENAME=branch1" 4 |
|
|
310 | .IX Item "NODENAME=branch1" |
|
|
311 | The nickname of the node. |
|
|
312 | .IP "NODEID=1" 4 |
|
|
313 | .IX Item "NODEID=1" |
|
|
314 | The numerical node \s-1ID\s0 of the node running this instance of \s-1GVPE\s0. The first |
|
|
315 | node mentioned in the config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on. |
|
|
316 | .RE |
|
|
317 | .RS 4 |
|
|
318 | .Sp |
|
|
319 | In addition, all node-specific variables (except \f(CW\*(C`NODEID\*(C'\fR) will be |
|
|
320 | available with a postfix of \f(CW\*(C`_nodeid\*(C'\fR, which contains the value for that |
|
|
321 | node, e.g. the \f(CW\*(C`MAC_1\*(C'\fR variable contains the \s-1MAC\s0 address of node #1, while |
|
|
322 | the \f(CW\*(C`NODENAME_22\*(C'\fR variable contains the name of node #22. |
|
|
323 | .Sp |
|
|
324 | Here is a simple if-up script: |
|
|
325 | .Sp |
|
|
326 | .Vb 5 |
|
|
327 | \& #!/bin/sh |
|
|
328 | \& ip link set $IFNAME up |
|
|
329 | \& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME |
|
|
330 | \& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME |
|
|
331 | \& ip route add 10.0.0.0/8 dev $IFNAME |
|
|
332 | .Ve |
|
|
333 | .Sp |
|
|
334 | More complicated examples (using routing to reduce \s-1ARP\s0 traffic) can be |
|
|
335 | found in the \fIetc/\fR subdirectory of the distribution. |
|
|
336 | .RE |
|
|
337 | .IP "ifname = devname" 4 |
|
|
338 | .IX Item "ifname = devname" |
|
|
339 | Sets the tun interface name to the given name. The default is OS-specific |
|
|
340 | and most probably something like \f(CW\*(C`tun0\*(C'\fR. |
220 | .IP "ifpersist = yes|true|on | no|false|off" 4 |
341 | .IP "ifpersist = yes|true|on | no|false|off" 4 |
221 | .IX Item "ifpersist = yes|true|on | no|false|off" |
342 | .IX Item "ifpersist = yes|true|on | no|false|off" |
222 | Should the tun/tap device be made persistent, that is, should the device |
343 | Should the tun/tap device be made persistent, that is, should the device |
223 | stay up even when gvpe exits? Some versions of the tunnel device have |
344 | stay up even when gvpe exits? Some versions of the tunnel device have |
224 | problems sending packets when gvpe is restarted in persistent mode, so |
345 | problems sending packets when gvpe is restarted in persistent mode, so |
225 | if the connections can be established but you cannot send packets from |
346 | if the connections can be established but you cannot send packets from |
226 | the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the |
347 | the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the |
227 | device. |
348 | device. |
228 | .IP "ifname = devname" 4 |
349 | .IP "ip-proto = numerical-ip-protocol" 4 |
229 | .IX Item "ifname = devname" |
350 | .IX Item "ip-proto = numerical-ip-protocol" |
230 | Sets the tun interface name to the given name. The default is OS-specific |
351 | Sets the protocol number to be used for the rawip protocol. This is a |
231 | and most probably something like \f(CW\*(C`tun0\*(C'\fR. |
352 | global option because all nodes must use the same protocol, and since |
232 | .IP "rekey = seconds" 4 |
353 | there are no port numbers, you cannot easily run more than one gvpe |
233 | .IX Item "rekey = seconds" |
354 | instance using the same protocol, nor can you share the protocol with |
234 | Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are |
355 | other programs. |
235 | reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. |
356 | .Sp |
|
|
357 | The default is 47 (\s-1GRE\s0), which has a good chance of tunneling |
|
|
358 | through firewalls (but note that gvpe's rawip protocol is not \s-1GRE\s0 |
|
|
359 | compatible). Other common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 |
|
|
360 | (\s-1IPIP\s0 tunnels) or 98 (\s-1ENCAP\s0, rfc1241). |
|
|
361 | .Sp |
|
|
362 | Many versions of Linux seem to have a bug that causes them to reorder |
|
|
363 | packets for some ip protocols (\s-1GRE\s0, \s-1ESP\s0) but not for others (\s-1AH\s0), so |
|
|
364 | choose wisely (that is, use 51, \s-1AH\s0). |
|
|
365 | .IP "http-proxy-host = hostname/ip" 4 |
|
|
366 | .IX Item "http-proxy-host = hostname/ip" |
|
|
367 | The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was |
|
|
368 | compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of |
|
|
369 | tcp connections through a http proxy server. |
|
|
370 | .Sp |
|
|
371 | \&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and |
|
|
372 | port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy |
|
|
373 | requires authentication. |
|
|
374 | .Sp |
|
|
375 | Please note that gvpe will still try to resolve all hostnames in the |
|
|
376 | configuration file, so if you are behind a proxy without access to a \s-1DNS\s0 |
|
|
377 | server better use numerical \s-1IP\s0 addresses. |
|
|
378 | .Sp |
|
|
379 | To make best use of this option disable all protocols except \s-1TCP\s0 in your |
|
|
380 | config file and make sure your routers (or all other nodes) are listening |
|
|
381 | on a port that the proxy allows (443, https, is a common choice). |
|
|
382 | .Sp |
|
|
383 | If you have a router, connecting to it will suffice. Otherwise \s-1TCP\s0 must be |
|
|
384 | enabled on all nodes. |
|
|
385 | .Sp |
|
|
386 | Example: |
|
|
387 | .Sp |
|
|
388 | .Vb 3 |
|
|
389 | \& http\-proxy\-host = proxy.example.com |
|
|
390 | \& http\-proxy\-port = 3128 # 8080 is another common choice |
|
|
391 | \& http\-proxy\-auth = schmorp:grumbeere |
|
|
392 | .Ve |
|
|
393 | .IP "http-proxy-port = proxy-tcp-port" 4 |
|
|
394 | .IX Item "http-proxy-port = proxy-tcp-port" |
|
|
395 | The port where your proxy server listens. |
|
|
396 | .IP "http-proxy-auth = login:password" 4 |
|
|
397 | .IX Item "http-proxy-auth = login:password" |
|
|
398 | The optional login and password used to authenticate to the proxy server, |
|
|
399 | separated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is |
|
|
400 | currently supported. |
236 | .IP "keepalive = seconds" 4 |
401 | .IP "keepalive = seconds" 4 |
237 | .IX Item "keepalive = seconds" |
402 | .IX Item "keepalive = seconds" |
238 | Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this |
403 | Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this |
239 | many seconds of inactivity the daemon will start to send keepalive probe |
404 | many seconds of inactivity the daemon will start to send keepalive probe |
240 | every 5 seconds until it receives a reply from the other end. If no reply |
405 | every 3 seconds until it receives a reply from the other end. If no reply |
241 | is received within 30 seconds, the peer is considered unreachable and the |
406 | is received within 15 seconds, the peer is considered unreachable and the |
242 | connection is closed. |
407 | connection is closed. |
|
|
408 | .IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 |
|
|
409 | .IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" |
|
|
410 | Set the logging level. Connection established messages are logged at level |
|
|
411 | \&\f(CW\*(C`info\*(C'\fR, notable errors are logged with \f(CW\*(C`error\*(C'\fR. Default is \f(CW\*(C`info\*(C'\fR. |
243 | .IP "mtu = bytes" 4 |
412 | .IP "mtu = bytes" 4 |
244 | .IX Item "mtu = bytes" |
413 | .IX Item "mtu = bytes" |
245 | Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically |
414 | Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically |
246 | the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate |
415 | the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate |
247 | maximum overhead (e.g. udp header size, encryption blocksize...) and pass |
416 | maximum overhead (e.g. \s-1UDP\s0 header size, encryption blocksize...) and pass |
248 | this information to the \f(CW\*(C`if\-up\*(C'\fR script. |
417 | this information to the \f(CW\*(C`if\-up\*(C'\fR script. |
249 | .Sp |
418 | .Sp |
250 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
419 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
251 | .Sp |
420 | .Sp |
252 | This value must be the minimum of the mtu values of all hosts. |
421 | This value must be the minimum of the \s-1MTU\s0 values of all nodes. |
253 | .IP "ip-proto = numerical-ip-protocol" 4 |
422 | .IP "node = nickname" 4 |
254 | .IX Item "ip-proto = numerical-ip-protocol" |
423 | .IX Item "node = nickname" |
255 | Sets the protocol number to be used for the rawip protocol. This is a |
424 | Not really a config setting but introduces a node section. The nickname is |
256 | global option because all hosts must use the same protocol, and since |
425 | used to select the right configuration section and must be passed as an |
257 | there are no port numbers, you cannot easily run more than one gvpe |
426 | argument to the gvpe daemon. |
258 | instance using the same protocol, nor can you share the protocol with |
|
|
259 | other programs. |
|
|
260 | .Sp |
|
|
261 | The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through |
|
|
262 | firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other |
|
|
263 | common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98 |
|
|
264 | (\s-1ENCAP\s0, rfc1241) |
|
|
265 | .IP "if-up = relative-or-absolute-path" 4 |
|
|
266 | .IX Item "if-up = relative-or-absolute-path" |
|
|
267 | Sets the path of a script that should be called immediately after the |
|
|
268 | network interface is initialized (but not neccessarily up). The following |
|
|
269 | environment variables are passed to it (the values are just examples): |
|
|
270 | .RS 4 |
|
|
271 | .IP "CONFBASE=/etc/gvpe" 4 |
|
|
272 | .IX Item "CONFBASE=/etc/gvpe" |
|
|
273 | The configuration base directory. |
|
|
274 | .IP "IFNAME=vpn0" 4 |
|
|
275 | .IX Item "IFNAME=vpn0" |
|
|
276 | The interface to initialize. |
|
|
277 | .IP "MTU=1436" 4 |
|
|
278 | .IX Item "MTU=1436" |
|
|
279 | The \s-1MTU\s0 to set the interface to. You can use lower values (if done |
|
|
280 | consistently on all hosts), but this is usually ineffective. |
|
|
281 | .IP "MAC=fe:fd:80:00:00:01" 4 |
|
|
282 | .IX Item "MAC=fe:fd:80:00:00:01" |
|
|
283 | The \s-1MAC\s0 address to set the interface to. The script *must* set the |
|
|
284 | interface \s-1MAC\s0 to this value. You will most likely use one of these: |
|
|
285 | .Sp |
|
|
286 | .Vb 2 |
|
|
287 | \& ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux |
|
|
288 | \& ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD |
|
|
289 | .Ve |
|
|
290 | .Sp |
|
|
291 | Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for platform-specific information. |
|
|
292 | .IP "IFTYPE=native # or tincd" 4 |
|
|
293 | .IX Item "IFTYPE=native # or tincd" |
|
|
294 | .PD 0 |
|
|
295 | .IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 |
|
|
296 | .IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." |
|
|
297 | .PD |
|
|
298 | The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os |
|
|
299 | name in lowercase) that this gvpe was configured for. Can be used to select |
|
|
300 | the correct syntax to use for network-related commands. |
|
|
301 | .IP "NODENAME=branch1" 4 |
|
|
302 | .IX Item "NODENAME=branch1" |
|
|
303 | The nickname of the current node, as passed to the gvpe daemon. |
|
|
304 | .IP "NODEID=1" 4 |
|
|
305 | .IX Item "NODEID=1" |
|
|
306 | The numerical node id of the current node. The first node mentioned in the |
|
|
307 | config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on. |
|
|
308 | .RE |
|
|
309 | .RS 4 |
|
|
310 | .Sp |
|
|
311 | Here is a simple if-up script: |
|
|
312 | .Sp |
|
|
313 | .Vb 5 |
|
|
314 | \& #!/bin/sh |
|
|
315 | \& ip link set $IFNAME address $MAC mtu $MTU up |
|
|
316 | \& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME |
|
|
317 | \& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME |
|
|
318 | \& ip route add 10.0.0.0/8 dev $IFNAME |
|
|
319 | .Ve |
|
|
320 | .Sp |
|
|
321 | More complicated examples (using routing to reduce arp traffic) can be |
|
|
322 | found in the etc/ subdirectory of the distribution. |
|
|
323 | .RE |
|
|
324 | .IP "node-up = relative-or-absolute-path" 4 |
427 | .IP "node-up = relative-or-absolute-path" 4 |
325 | .IX Item "node-up = relative-or-absolute-path" |
428 | .IX Item "node-up = relative-or-absolute-path" |
326 | Sets a command (default: no script) that should be called whenever a |
429 | Sets a command (default: none) that should be called whenever a connection |
327 | connection is established (even on rekeying operations). In addition |
430 | is established (even on rekeying operations). Note that node\-up/down |
|
|
431 | scripts will be run asynchronously, but execution is serialised, so there |
|
|
432 | will only ever be one such script running. |
|
|
433 | .Sp |
328 | to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment |
434 | In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following |
329 | variables will be set: |
435 | environment variables will be set (values are just examples): |
330 | .RS 4 |
436 | .RS 4 |
331 | .IP "DESTNODE=branch2" 4 |
437 | .IP "DESTNODE=branch2" 4 |
332 | .IX Item "DESTNODE=branch2" |
438 | .IX Item "DESTNODE=branch2" |
333 | The name of the remote node. |
439 | The name of the remote node. |
334 | .IP "DESTID=2" 4 |
440 | .IP "DESTID=2" 4 |
335 | .IX Item "DESTID=2" |
441 | .IX Item "DESTID=2" |
336 | The node id of the remote node. |
442 | The node id of the remote node. |
|
|
443 | .IP "DESTSI=rawip/88.99.77.55:0" 4 |
|
|
444 | .IX Item "DESTSI=rawip/88.99.77.55:0" |
|
|
445 | The \*(L"socket info\*(R" of the target node, protocol dependent but usually in |
|
|
446 | the format protocol/ip:port. |
337 | .IP "DESTIP=188.13.66.8" 4 |
447 | .IP "DESTIP=188.13.66.8" 4 |
338 | .IX Item "DESTIP=188.13.66.8" |
448 | .IX Item "DESTIP=188.13.66.8" |
339 | The numerical \s-1IP\s0 address of the remote host (gvpe accepts connections from |
449 | The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from |
340 | everywhere, as long as the other host can authenticate itself). |
450 | everywhere, as long as the other node can authenticate itself). |
341 | .IP "DESTPORT=655 # deprecated" 4 |
451 | .IP "DESTPORT=655 # deprecated" 4 |
342 | .IX Item "DESTPORT=655 # deprecated" |
452 | .IX Item "DESTPORT=655 # deprecated" |
343 | The \s-1UDP\s0 port used by the other side. |
453 | The protocol port used by the other side, if applicable. |
344 | .IP "STATE=UP" 4 |
454 | .IP "STATE=up" 4 |
345 | .IX Item "STATE=UP" |
455 | .IX Item "STATE=up" |
346 | Node-up scripts get called with STATE=UP, node-down scripts get called |
456 | Node-up scripts get called with STATE=up, node-change scripts get called |
347 | with STATE=DOWN. |
457 | with STATE=change and node-down scripts get called with STATE=down. |
348 | .RE |
458 | .RE |
349 | .RS 4 |
459 | .RS 4 |
350 | .Sp |
460 | .Sp |
351 | Here is a nontrivial example that uses nsupdate to update the name => ip |
461 | Here is a nontrivial example that uses nsupdate to update the name => ip |
352 | mapping in some dns zone: |
462 | mapping in some \s-1DNS\s0 zone: |
353 | .Sp |
463 | .Sp |
354 | .Vb 6 |
464 | .Vb 6 |
355 | \& #!/bin/sh |
465 | \& #!/bin/sh |
356 | \& { |
466 | \& { |
357 | \& echo update delete $DESTNODE.lowttl.example.net. a |
467 | \& echo update delete $DESTNODE.lowttl.example.net. a |
358 | \& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP |
468 | \& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP |
359 | \& echo |
469 | \& echo |
360 | \& } | nsupdate -d -k $CONFBASE:key.example.net. |
470 | \& } | nsupdate \-d \-k $CONFBASE:key.example.net. |
361 | .Ve |
471 | .Ve |
362 | .RE |
472 | .RE |
|
|
473 | .IP "node-change = relative-or-absolute-path" 4 |
|
|
474 | .IX Item "node-change = relative-or-absolute-path" |
|
|
475 | Same as \f(CW\*(C`node\-change\*(C'\fR, but gets called whenever something about a |
|
|
476 | connection changes (such as the source \s-1IP\s0 address). |
363 | .IP "node-down = relative-or-absolute-path" 4 |
477 | .IP "node-down = relative-or-absolute-path" 4 |
364 | .IX Item "node-down = relative-or-absolute-path" |
478 | .IX Item "node-down = relative-or-absolute-path" |
365 | Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. |
479 | Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. |
366 | .IP "http-proxy-host = hostname/ip" 4 |
|
|
367 | .IX Item "http-proxy-host = hostname/ip" |
|
|
368 | The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was |
|
|
369 | compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of |
|
|
370 | tcp connections through a http proxy server. |
|
|
371 | .Sp |
|
|
372 | \&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and |
|
|
373 | port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy |
|
|
374 | requires authentication. |
|
|
375 | .Sp |
|
|
376 | Please note that gvpe will still try to resolve all hostnames in the |
|
|
377 | configuration file, so if you are behind a proxy without access to a dns |
|
|
378 | server better use numerical \s-1IP\s0 addresses. |
|
|
379 | .Sp |
|
|
380 | To make best use of this option disable all protocols except tcp in your |
|
|
381 | config file and make sure your routers (or all other hosts) are listening |
|
|
382 | on a port that the proxy allows (443, https, is a common choice). |
|
|
383 | .Sp |
|
|
384 | If you have a router, connecting to it will suffice. Otherwise tcp must be |
|
|
385 | enabled on all hosts. |
|
|
386 | .Sp |
|
|
387 | Example: |
|
|
388 | .Sp |
|
|
389 | .Vb 3 |
|
|
390 | \& http-proxy-host = proxy.example.com |
|
|
391 | \& http-proxy-port = 3128 # 8080 is another common choice |
|
|
392 | \& http-proxy-auth = schmorp:grumbeere |
|
|
393 | .Ve |
|
|
394 | .IP "http-proxy-port = proxy-tcp-port" 4 |
|
|
395 | .IX Item "http-proxy-port = proxy-tcp-port" |
|
|
396 | The port where your proxy server listens. |
|
|
397 | .IP "http-proxy-auth = login:password" 4 |
|
|
398 | .IX Item "http-proxy-auth = login:password" |
|
|
399 | The optional login and password used to authenticate to the proxy server, |
|
|
400 | seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is |
|
|
401 | currently supported. |
|
|
402 | .IP "pid-file = path" 4 |
480 | .IP "pid-file = path" 4 |
403 | .IX Item "pid-file = path" |
481 | .IX Item "pid-file = path" |
404 | The path to the pid file to check and create (Default: |
482 | The path to the pid file to check and create |
|
|
483 | (default: \f(CW\*(C`LOCALSTATEDIR/run/gvpe.pid\*(C'\fR). |
|
|
484 | .IP "private-key = relative-path-to-key" 4 |
|
|
485 | .IX Item "private-key = relative-path-to-key" |
|
|
486 | Sets the path (relative to the config directory) to the private key |
|
|
487 | (default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must |
|
|
488 | be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could |
|
|
489 | use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where |
|
|
490 | \&\f(CW\*(C`gvpectrl\*(C'\fR puts them. |
|
|
491 | .Sp |
|
|
492 | Since only the private key file of the current node is used and the |
|
|
493 | private key file should be kept secret per-node to avoid spoofing, it is |
|
|
494 | not recommended to use this feature. |
|
|
495 | .IP "rekey = seconds" 4 |
|
|
496 | .IX Item "rekey = seconds" |
|
|
497 | Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are |
|
|
498 | reestablished every \f(CW\*(C`rekey\*(C'\fR seconds, making them use a new encryption |
|
|
499 | key. |
|
|
500 | .IP "nfmark = integer" 4 |
|
|
501 | .IX Item "nfmark = integer" |
|
|
502 | This advanced option, when set to a nonzero value (default: \f(CW0\fR), tries |
|
|
503 | to set the netfilter mark (or fwmark) value on all sockets gvpe uses to |
|
|
504 | send packets. |
|
|
505 | .Sp |
|
|
506 | This can be used to make gvpe use a different set of routing rules. For |
|
|
507 | example, on GNU/Linux, the \f(CW\*(C`if\-up\*(C'\fR could set \f(CW\*(C`nfmark\*(C'\fR to 1000 and then |
|
|
508 | put all routing rules into table \f(CW99\fR and then use an ip rule to make |
|
|
509 | gvpe traffic avoid that routing table, in effect routing normal traffic |
|
|
510 | via gvpe and gvpe traffic via the normal system routing tables: |
|
|
511 | .Sp |
|
|
512 | .Vb 1 |
|
|
513 | \& ip rule add not fwmark 1000 lookup 99 |
|
|
514 | .Ve |
405 | .Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
515 | .Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
406 | .IX Subsection "NODE SPECIFIC SETTINGS" |
516 | .IX Subsection "NODE SPECIFIC SETTINGS" |
407 | The following settings are node\-specific, that is, every node can have |
517 | The following settings are node\-specific, that is, every node can have |
408 | different settings, even within the same gvpe instance. Settings that are |
518 | different settings, even within the same gvpe instance. Settings that are |
409 | executed before the first node section set the defaults, settings that are |
519 | set before the first node section set the defaults, settings that are |
410 | executed within a node section only apply to the given node. |
520 | set within a node section only apply to the given node. |
|
|
521 | .IP "allow-direct = nodename" 4 |
|
|
522 | .IX Item "allow-direct = nodename" |
|
|
523 | Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info. |
|
|
524 | .IP "compress = yes|true|on | no|false|off" 4 |
|
|
525 | .IX Item "compress = yes|true|on | no|false|off" |
|
|
526 | For the current node, this specified whether it will accept compressed |
|
|
527 | packets, and for all other nodes, this specifies whether to try to |
|
|
528 | compress data packets sent to this node (default: \f(CW\*(C`yes\*(C'\fR). Compression is |
|
|
529 | really cheap even on slow computers, has no size overhead at all and will |
|
|
530 | only be used when the other side supports compression, so enabling this is |
|
|
531 | often a good idea. |
|
|
532 | .IP "connect = ondemand | never | always | disabled" 4 |
|
|
533 | .IX Item "connect = ondemand | never | always | disabled" |
|
|
534 | Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always |
|
|
535 | try to establish and keep a connection to the given node), \f(CW\*(C`never\*(C'\fR |
|
|
536 | (never initiate a connection to the given host, but accept connections), |
|
|
537 | \&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection when there are outstanding |
|
|
538 | packets in the queue and take it down after the keepalive interval) or |
|
|
539 | \&\f(CW\*(C`disabled\*(C'\fR (node is bad, don't talk to it). |
|
|
540 | .Sp |
|
|
541 | Routers will automatically be forced to \f(CW\*(C`always\*(C'\fR unless they are |
|
|
542 | \&\f(CW\*(C`disabled\*(C'\fR, to ensure all nodes can talk to each other. |
|
|
543 | .IP "deny-direct = nodename | *" 4 |
|
|
544 | .IX Item "deny-direct = nodename | *" |
|
|
545 | Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR |
|
|
546 | is given). Only one node can be specified, but you can use multiple |
|
|
547 | \&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in |
|
|
548 | networks with routers, as routers are required for indirect connections. |
|
|
549 | .Sp |
|
|
550 | Sometimes, a node cannot reach some other nodes for reasons of network |
|
|
551 | connectivity. For example, a node behind a firewall that only allows |
|
|
552 | connections to/from a single other node in the network. In this case one |
|
|
553 | should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other |
|
|
554 | node \fImust\fR be a router for this to work). |
|
|
555 | .Sp |
|
|
556 | The algorithm to check whether a connection may be direct is as follows: |
|
|
557 | .Sp |
|
|
558 | 1. Other node mentioned in an \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection. |
|
|
559 | .Sp |
|
|
560 | 2. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections. |
|
|
561 | .Sp |
|
|
562 | 3. Allow the connection. |
|
|
563 | .Sp |
|
|
564 | That is, \f(CW\*(C`allow\-direct\*(C'\fR takes precedence over \f(CW\*(C`deny\-direct\*(C'\fR. |
|
|
565 | .Sp |
|
|
566 | The check is done in both directions, i.e. both nodes must allow a direct |
|
|
567 | connection before one is attempted, so you only need to specify connect |
|
|
568 | limitations on one node. |
|
|
569 | .IP "dns-domain = domain-suffix" 4 |
|
|
570 | .IX Item "dns-domain = domain-suffix" |
|
|
571 | The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node. |
|
|
572 | .Sp |
|
|
573 | The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, |
|
|
574 | i.e. |
|
|
575 | .Sp |
|
|
576 | .Vb 2 |
|
|
577 | \& dns\-domainname = tunnel.example.net |
|
|
578 | \& dns\-hostname = tunnel\-server.example.net |
|
|
579 | .Ve |
|
|
580 | .Sp |
|
|
581 | Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain: |
|
|
582 | .Sp |
|
|
583 | .Vb 2 |
|
|
584 | \& tunnel.example.net. NS tunnel\-server.example.net. |
|
|
585 | \& tunnel\-server.example.net. A 13.13.13.13 |
|
|
586 | .Ve |
|
|
587 | .IP "dns-hostname = hostname/ip" 4 |
|
|
588 | .IX Item "dns-hostname = hostname/ip" |
|
|
589 | The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR, |
|
|
590 | but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might |
|
|
591 | change. |
|
|
592 | .IP "dns-port = port-number" 4 |
|
|
593 | .IX Item "dns-port = port-number" |
|
|
594 | The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers. |
|
|
595 | .IP "enable-dns = yes|true|on | no|false|off" 4 |
|
|
596 | .IX Item "enable-dns = yes|true|on | no|false|off" |
|
|
597 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1DNS\s0 transport |
|
|
598 | protocol. Avoid this protocol if you can. |
|
|
599 | .Sp |
|
|
600 | Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as |
|
|
601 | client. Support for this transport protocol is only available when gvpe |
|
|
602 | was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option. |
|
|
603 | .IP "enable-icmp = yes|true|on | no|false|off" 4 |
|
|
604 | .IX Item "enable-icmp = yes|true|on | no|false|off" |
|
|
605 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol. |
|
|
606 | .Sp |
|
|
607 | Enable the \s-1ICMP\s0 transport using \s-1ICMP\s0 packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this |
|
|
608 | node. |
|
|
609 | .IP "enable-rawip = yes|true|on | no|false|off" 4 |
|
|
610 | .IX Item "enable-rawip = yes|true|on | no|false|off" |
|
|
611 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol. |
|
|
612 | .Sp |
|
|
613 | Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol |
|
|
614 | (default: \f(CW\*(C`no\*(C'\fR). |
|
|
615 | .IP "enable-tcp = yes|true|on | no|false|off" 4 |
|
|
616 | .IX Item "enable-tcp = yes|true|on | no|false|off" |
|
|
617 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1TCP\s0 transport protocol. |
|
|
618 | .Sp |
|
|
619 | Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port |
|
|
620 | (default: \f(CW\*(C`no\*(C'\fR). Support for this transport protocol is only available |
|
|
621 | when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. |
|
|
622 | .IP "enable-udp = yes|true|on | no|false|off" 4 |
|
|
623 | .IX Item "enable-udp = yes|true|on | no|false|off" |
|
|
624 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol. |
|
|
625 | .Sp |
|
|
626 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR). |
|
|
627 | .IP "hostname = hostname | ip [can not be defaulted]" 4 |
|
|
628 | .IX Item "hostname = hostname | ip [can not be defaulted]" |
|
|
629 | Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0 |
|
|
630 | address. It will be resolved before each connect request, so dyndns should |
|
|
631 | work fine. If this setting is not specified and a router is available, |
|
|
632 | then the router will be queried for the address of this node. Otherwise, |
|
|
633 | the connection attempt will fail. |
|
|
634 | .Sp |
|
|
635 | Note that \s-1DNS\s0 resolving is done synchronously, pausing the daemon. If that |
|
|
636 | is an issue you need to specify \s-1IP\s0 addresses. |
|
|
637 | .IP "icmp-type = integer" 4 |
|
|
638 | .IX Item "icmp-type = integer" |
|
|
639 | Sets the type value to be used for outgoing (and incoming) packets sent |
|
|
640 | via the \s-1ICMP\s0 transport. |
|
|
641 | .Sp |
|
|
642 | The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as |
|
|
643 | \&\*(L"ping\-reply\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. |
|
|
644 | \&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. |
|
|
645 | .IP "if-up-data = value" 4 |
|
|
646 | .IX Item "if-up-data = value" |
|
|
647 | The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR |
|
|
648 | script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR. |
|
|
649 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
|
|
650 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
|
|
651 | Whether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
|
|
652 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
|
|
653 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
|
|
654 | to the tunnel device, which is usually what you want. |
|
|
655 | .IP "max-retry = positive-number" 4 |
|
|
656 | .IX Item "max-retry = positive-number" |
|
|
657 | The maximum interval in seconds (default: \f(CW3600\fR, one hour) between |
|
|
658 | retries to establish a connection to this node. When a connection cannot |
|
|
659 | be established, gvpe uses exponential back-off capped at this value. It's |
|
|
660 | sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on |
|
|
661 | connections to routers that usually are stable but sometimes are down, to |
|
|
662 | assure quick reconnections even after longer downtimes. |
|
|
663 | .IP "max-ttl = seconds" 4 |
|
|
664 | .IX Item "max-ttl = seconds" |
|
|
665 | Expire packets that couldn't be sent after this many seconds |
|
|
666 | (default: \f(CW60\fR). Gvpe will normally queue packets for a node without an |
|
|
667 | active connection, in the hope of establishing a connection soon. This |
|
|
668 | value specifies the maximum lifetime a packet will stay in the queue, if a |
|
|
669 | packet gets older, it will be thrown away. |
|
|
670 | .IP "max-queue = positive\-number>=1" 4 |
|
|
671 | .IX Item "max-queue = positive-number>=1" |
|
|
672 | The maximum number of packets that will be queued (default: \f(CW512\fR) |
|
|
673 | for this node. If more packets are sent then earlier packets will be |
|
|
674 | expired. See \f(CW\*(C`max\-ttl\*(C'\fR, above. |
|
|
675 | .IP "router-priority = 0 | 1 | positive\-number>=2" 4 |
|
|
676 | .IX Item "router-priority = 0 | 1 | positive-number>=2" |
|
|
677 | Sets the router priority of the given node (default: \f(CW0\fR, disabled). |
|
|
678 | .Sp |
|
|
679 | If some node tries to connect to another node but it doesn't have a |
|
|
680 | hostname, it asks a router node for it's \s-1IP\s0 address. The router node |
|
|
681 | chosen is the one with the highest priority larger than \f(CW1\fR that is |
|
|
682 | currently reachable. This is called a \fImediated\fR connection, as the |
|
|
683 | connection itself will still be direct, but it uses another node to |
|
|
684 | mediate between the two nodes. |
|
|
685 | .Sp |
|
|
686 | The value \f(CW0\fR disables routing, that means if the node receives a packet |
|
|
687 | not for itself it will not forward it but instead drop it. |
|
|
688 | .Sp |
|
|
689 | The special value \f(CW1\fR allows other hosts to route through the router |
|
|
690 | host, but they will never route through it by default (i.e. the config |
|
|
691 | file of another node needs to specify a router priority higher than one |
|
|
692 | to choose such a node for routing). |
|
|
693 | .Sp |
|
|
694 | The idea behind this is that some hosts can, if required, bump the |
|
|
695 | \&\f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their local config to |
|
|
696 | route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is \f(CW0\fR, then routing |
|
|
697 | will be refused, so \f(CW1\fR serves as a \*(L"enable, but do not use by default\*(R" |
|
|
698 | switch. |
|
|
699 | .Sp |
|
|
700 | Nodes with \f(CW\*(C`router\-priority\*(C'\fR set to \f(CW2\fR or higher will always be forced |
|
|
701 | to \f(CW\*(C`connect\*(C'\fR = \f(CW\*(C`always\*(C'\fR (unless they are \f(CW\*(C`disabled\*(C'\fR). |
|
|
702 | .IP "tcp-port = port-number" 4 |
|
|
703 | .IX Item "tcp-port = port-number" |
|
|
704 | Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. |
411 | .IP "udp-port = port-number" 4 |
705 | .IP "udp-port = port-number" 4 |
412 | .IX Item "udp-port = port-number" |
706 | .IX Item "udp-port = port-number" |
413 | Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not |
707 | Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not |
414 | officially assigned by \s-1IANA\s0!). |
708 | officially assigned by \s-1IANA\s0!). |
415 | .IP "tcp-port = port-number" 4 |
|
|
416 | .IX Item "tcp-port = port-number" |
|
|
417 | Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. |
|
|
418 | .IP "enable-rawip = yes|true|on | no|false|off" 4 |
|
|
419 | .IX Item "enable-rawip = yes|true|on | no|false|off" |
|
|
420 | Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol |
|
|
421 | (default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the overhead per packet |
|
|
422 | is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+). |
|
|
423 | .IP "enable-udp = yes|true|on | no|false|off" 4 |
|
|
424 | .IX Item "enable-udp = yes|true|on | no|false|off" |
|
|
425 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`yes\*(C'\fR, |
|
|
426 | but this will change!). This is a good general choice since \s-1UDP\s0 tunnels |
|
|
427 | well through many firewalls. |
|
|
428 | .Sp |
|
|
429 | \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR even though it is the default, as |
|
|
430 | some future version will have all protocols disabled by default. |
|
|
431 | .IP "enable-tcp = yes|true|on | no|false|off" 4 |
|
|
432 | .IX Item "enable-tcp = yes|true|on | no|false|off" |
|
|
433 | Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port |
|
|
434 | (default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only |
|
|
435 | available when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never |
|
|
436 | use this transport unless you really must, it is horribly ineffiecent and |
|
|
437 | resource-intensive compared to the other transports. |
|
|
438 | .IP "router-priority = 0 | 1 | positive\-number>2" 4 |
|
|
439 | .IX Item "router-priority = 0 | 1 | positive-number>2" |
|
|
440 | Sets the router priority of the given host (default: \f(CW0\fR, disabled). If |
|
|
441 | some host tries to connect to another host without a hostname, it asks |
|
|
442 | the router host for it's \s-1IP\s0 address. The router host is the one with the |
|
|
443 | highest priority larger than \f(CW1\fR that is currently reachable. |
|
|
444 | .Sp |
|
|
445 | Make sure all hosts always connect (\f(CW\*(C`connect = always\*(C'\fR) to the router |
|
|
446 | hosts, otherwise connecting to them might be impossible. |
|
|
447 | .Sp |
|
|
448 | The special value \f(CW1\fR allows other hosts to route through the router |
|
|
449 | host, but they will never route through it by default. The value \f(CW0\fR |
|
|
450 | disables routing. The idea behind this is that some hosts can, if |
|
|
451 | required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their |
|
|
452 | local config to route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is |
|
|
453 | \&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do |
|
|
454 | not use by default\*(R" switch. |
|
|
455 | .IP "connect = ondemand | never | always | disabled" 4 |
|
|
456 | .IX Item "connect = ondemand | never | always | disabled" |
|
|
457 | Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always |
|
|
458 | try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR |
|
|
459 | (nevr initiate a connection to the given host, but accept connections), |
|
|
460 | \&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and |
|
|
461 | take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, |
|
|
462 | don't talk to it). |
|
|
463 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
|
|
464 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
|
|
465 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
|
|
466 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
|
|
467 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
|
|
468 | to the tunnel device, which is usually what you want. |
|
|
469 | .IP "compress = yes|true|on | no|false|off" 4 |
|
|
470 | .IX Item "compress = yes|true|on | no|false|off" |
|
|
471 | Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). |
|
|
472 | Compression is really cheap even on slow computers and has no size |
|
|
473 | overhead at all, so enabling this is a good idea. |
|
|
474 | .IP "max-retry = positive-number" 4 |
|
|
475 | .IX Item "max-retry = positive-number" |
|
|
476 | The maximum interval in seconds (default: \f(CW28800\fR, 8 hours) between |
|
|
477 | retries to establish a connection to this node. When a connection cannot |
|
|
478 | be established, gvpe uses exponential backoff capped at this value. It's |
|
|
479 | sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on |
|
|
480 | connections to routers that usually are stable but sometimes are down, to |
|
|
481 | assure quick reconnections. |
|
|
482 | .SH "CONFIG DIRECTORY LAYOUT" |
709 | .SH "CONFIG DIRECTORY LAYOUT" |
483 | .IX Header "CONFIG DIRECTORY LAYOUT" |
710 | .IX Header "CONFIG DIRECTORY LAYOUT" |
484 | The default (or recommended) directory layout for the config directory is: |
711 | The default (or recommended) directory layout for the config directory is: |
485 | .IP "gvpe.conf" 4 |
712 | .IP "gvpe.conf" 4 |
486 | .IX Item "gvpe.conf" |
713 | .IX Item "gvpe.conf" |
… | |
… | |
500 | .SH "SEE ALSO" |
727 | .SH "SEE ALSO" |
501 | .IX Header "SEE ALSO" |
728 | .IX Header "SEE ALSO" |
502 | \&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). |
729 | \&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). |
503 | .SH "AUTHOR" |
730 | .SH "AUTHOR" |
504 | .IX Header "AUTHOR" |
731 | .IX Header "AUTHOR" |
505 | Marc Lehmann <gvpe@plan9.de> |
732 | Marc Lehmann <gvpe@schmorp.de> |