1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 |
1 | .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.30) |
2 | .\" |
2 | .\" |
3 | .\" Standard preamble: |
3 | .\" Standard preamble: |
4 | .\" ======================================================================== |
4 | .\" ======================================================================== |
5 | .de Sh \" Subsection heading |
|
|
6 | .br |
|
|
7 | .if t .Sp |
|
|
8 | .ne 5 |
|
|
9 | .PP |
|
|
10 | \fB\\$1\fR |
|
|
11 | .PP |
|
|
12 | .. |
|
|
13 | .de Sp \" Vertical space (when we can't use .PP) |
5 | .de Sp \" Vertical space (when we can't use .PP) |
14 | .if t .sp .5v |
6 | .if t .sp .5v |
15 | .if n .sp |
7 | .if n .sp |
16 | .. |
8 | .. |
17 | .de Vb \" Begin verbatim text |
9 | .de Vb \" Begin verbatim text |
… | |
… | |
44 | .el\{\ |
36 | .el\{\ |
45 | . ds -- \|\(em\| |
37 | . ds -- \|\(em\| |
46 | . ds PI \(*p |
38 | . ds PI \(*p |
47 | . ds L" `` |
39 | . ds L" `` |
48 | . ds R" '' |
40 | . ds R" '' |
|
|
41 | . ds C` |
|
|
42 | . ds C' |
49 | 'br\} |
43 | 'br\} |
50 | .\" |
44 | .\" |
|
|
45 | .\" Escape single quotes in literal strings from groff's Unicode transform. |
|
|
46 | .ie \n(.g .ds Aq \(aq |
|
|
47 | .el .ds Aq ' |
|
|
48 | .\" |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for |
49 | .\" If the F register is turned on, we'll generate index entries on stderr for |
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
50 | .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
51 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
54 | .\" output yourself in some meaningful fashion. |
52 | .\" output yourself in some meaningful fashion. |
55 | .if \nF \{\ |
53 | .\" |
|
|
54 | .\" Avoid warning from groff about undefined register 'F'. |
56 | . de IX |
55 | .de IX |
57 | . tm Index:\\$1\t\\n%\t"\\$2" |
|
|
58 | .. |
56 | .. |
59 | . nr % 0 |
57 | .nr rF 0 |
60 | . rr F |
58 | .if \n(.g .if rF .nr rF 1 |
|
|
59 | .if (\n(rF:(\n(.g==0)) \{ |
|
|
60 | . if \nF \{ |
|
|
61 | . de IX |
|
|
62 | . tm Index:\\$1\t\\n%\t"\\$2" |
|
|
63 | .. |
|
|
64 | . if !\nF==2 \{ |
|
|
65 | . nr % 0 |
|
|
66 | . nr F 2 |
|
|
67 | . \} |
|
|
68 | . \} |
61 | .\} |
69 | .\} |
62 | .\" |
70 | .rr rF |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
|
|
64 | .\" way too many mistakes in technical documents. |
|
|
65 | .hy 0 |
|
|
66 | .if n .na |
|
|
67 | .\" |
71 | .\" |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
72 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
73 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
70 | . \" fudge factors for nroff and troff |
74 | . \" fudge factors for nroff and troff |
71 | .if n \{\ |
75 | .if n \{\ |
… | |
… | |
127 | .\} |
131 | .\} |
128 | .rm #[ #] #H #V #F C |
132 | .rm #[ #] #H #V #F C |
129 | .\" ======================================================================== |
133 | .\" ======================================================================== |
130 | .\" |
134 | .\" |
131 | .IX Title "GVPE.CONF 5" |
135 | .IX Title "GVPE.CONF 5" |
132 | .TH GVPE.CONF 5 "2008-08-10" "2.2" "GNU Virtual Private Ethernet" |
136 | .TH GVPE.CONF 5 "2016-11-02" "2.25" "GNU Virtual Private Ethernet" |
|
|
137 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
|
|
138 | .\" way too many mistakes in technical documents. |
|
|
139 | .if n .ad l |
|
|
140 | .nh |
133 | .SH "NAME" |
141 | .SH "NAME" |
134 | gvpe.conf \- configuration file for the GNU VPE daemon |
142 | gvpe.conf \- configuration file for the GNU VPE daemon |
135 | .SH "SYNOPSIS" |
143 | .SH "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
144 | .IX Header "SYNOPSIS" |
137 | .Vb 3 |
145 | .Vb 4 |
|
|
146 | \& # global options for all nodes |
138 | \& udp\-port = 407 |
147 | \& udp\-port = 407 |
139 | \& mtu = 1492 |
148 | \& mtu = 1492 |
140 | \& ifname = vpn0 |
149 | \& ifname = vpn0 |
141 | .Ve |
150 | \& |
142 | .PP |
151 | \& # first node is named branch1 and is at 1.2.3.4 |
143 | .Vb 2 |
|
|
144 | \& node = branch1 |
152 | \& node = branch1 |
145 | \& hostname = 1.2.3.4 |
153 | \& hostname = 1.2.3.4 |
146 | .Ve |
154 | \& |
147 | .PP |
155 | \& # second node uses dns to resolve the address |
148 | .Vb 3 |
|
|
149 | \& node = branch2 |
156 | \& node = branch2 |
150 | \& hostname = www.example.net |
157 | \& hostname = www.example.net |
151 | \& udp\-port = 500 # this host uses a different udp\-port |
158 | \& udp\-port = 500 # this host uses a different udp\-port |
152 | .Ve |
159 | \& |
153 | .PP |
160 | \& # third node has no fixed ip address |
154 | .Vb 2 |
|
|
155 | \& node = branch3 |
161 | \& node = branch3 |
156 | \& connect = ondemand |
162 | \& connect = ondemand |
157 | .Ve |
163 | .Ve |
158 | .SH "DESCRIPTION" |
164 | .SH "DESCRIPTION" |
159 | .IX Header "DESCRIPTION" |
165 | .IX Header "DESCRIPTION" |
… | |
… | |
161 | = value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and |
167 | = value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and |
162 | extend to the end of the line. They can be used on their own lines, or |
168 | extend to the end of the line. They can be used on their own lines, or |
163 | after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after |
169 | after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after |
164 | values, but not within the variable names or values themselves. |
170 | values, but not within the variable names or values themselves. |
165 | .PP |
171 | .PP |
166 | The only exception to the above is the \*(L"on\*(R" directive that can prefix any |
172 | All settings are applied \*(L"in order\*(R", that is, later settings of the same |
167 | \&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or |
173 | variable overwrite earlier ones. |
168 | (if the nodename starts with \*(L"!\*(R") on all nodes except the named one. |
|
|
169 | .PP |
174 | .PP |
|
|
175 | The only exceptions to the above are the following directives: |
|
|
176 | .IP "node nodename" 4 |
|
|
177 | .IX Item "node nodename" |
|
|
178 | Introduces a node section. The nodename is used to select the right |
|
|
179 | configuration section and is the same string as is passed as an argument |
|
|
180 | to the gvpe daemon. |
|
|
181 | .Sp |
|
|
182 | Multiple \f(CW\*(C`node\*(C'\fR statements with the same node name are supported and will |
|
|
183 | be merged together. |
|
|
184 | .IP "global" 4 |
|
|
185 | .IX Item "global" |
|
|
186 | This statement switches back to the global section, which is mainly |
|
|
187 | useful if you want to include a second config file, e..g for local |
|
|
188 | customisations. To do that, simply include this at the very end of your |
|
|
189 | config file: |
|
|
190 | .Sp |
|
|
191 | .Vb 2 |
|
|
192 | \& global |
|
|
193 | \& include local.conf |
|
|
194 | .Ve |
|
|
195 | .IP "on nodename ..." 4 |
|
|
196 | .IX Item "on nodename ..." |
|
|
197 | .PD 0 |
|
|
198 | .IP "on !nodename ..." 4 |
|
|
199 | .IX Item "on !nodename ..." |
|
|
200 | .PD |
|
|
201 | You can prefix any configuration directive with \f(CW\*(C`on\*(C'\fR and a nodename. \s-1GVPE\s0 |
|
|
202 | will will only \*(L"execute\*(R" it on the named node, or (if the nodename starts |
|
|
203 | with \f(CW\*(C`!\*(C'\fR) on all nodes except the named one. |
|
|
204 | .Sp |
|
|
205 | Example: set the \s-1MTU\s0 to \f(CW1450\fR everywhere, \f(CW\*(C`loglevel\*(C'\fR to \f(CW\*(C`noise\*(C'\fR on |
|
|
206 | \&\f(CW\*(C`branch1\*(C'\fR, and \f(CW\*(C`connect\*(C'\fR to \f(CW\*(C`ondemand\*(C'\fR everywhere but on branch2. |
|
|
207 | .Sp |
170 | .Vb 3 |
208 | .Vb 3 |
171 | \& name = value |
209 | \& mtu = 1450 |
172 | \& on branch1 loglevel = noise |
210 | \& on branch1 loglevel = noise |
173 | \& on !branch2 connect = ondemand |
211 | \& on !branch2 connect = ondemand |
174 | .Ve |
212 | .Ve |
175 | .PP |
213 | .IP "include relative-or-absolute-path" 4 |
176 | All settings are executed \*(L"in order\*(R", that is, later settings of the same |
214 | .IX Item "include relative-or-absolute-path" |
177 | variable overwrite earlier ones. |
215 | Reads the specified file (the path must not contain whitespace or \f(CW\*(C`=\*(C'\fR |
|
|
216 | characters) and evaluate all config directives in it as if they were |
|
|
217 | spelled out in place of the \f(CW\*(C`include\*(C'\fR directive. |
|
|
218 | .Sp |
|
|
219 | The path is a printf format string, that is, you must escape any \f(CW\*(C`%\*(C'\fR |
|
|
220 | by doubling it, and you can have a single \f(CW%s\fR inside, which will be |
|
|
221 | replaced by the current nodename. |
|
|
222 | .Sp |
|
|
223 | Relative paths are interpreted relative to the \s-1GVPE\s0 config directory. |
|
|
224 | .Sp |
|
|
225 | Example: include the file \fIlocal.conf\fR in the config directory on every |
|
|
226 | node. |
|
|
227 | .Sp |
|
|
228 | .Vb 1 |
|
|
229 | \& include local.conf |
|
|
230 | .Ve |
|
|
231 | .Sp |
|
|
232 | Example: include a file \fIconf/\fRnodename\fI.conf\fR |
|
|
233 | .Sp |
|
|
234 | .Vb 1 |
|
|
235 | \& include conf/%s.conf |
|
|
236 | .Ve |
178 | .SH "ANATOMY OF A CONFIG FILE" |
237 | .SH "ANATOMY OF A CONFIG FILE" |
179 | .IX Header "ANATOMY OF A CONFIG FILE" |
238 | .IX Header "ANATOMY OF A CONFIG FILE" |
180 | Usually, a config file starts with global settings (like the udp port to |
239 | Usually, a config file starts with a few global settings (like the \s-1UDP\s0 |
181 | listen on), followed by node-specific sections that begin with a \f(CW\*(C`node = |
240 | port to listen on), followed by node-specific sections that begin with a |
182 | nickname\*(C'\fR line. |
241 | \&\f(CW\*(C`node = nickname\*(C'\fR line. |
183 | .PP |
242 | .PP |
184 | Every node that is part of the network must have a section that starts |
243 | Every node that is part of the network must have a section that starts |
185 | with \f(CW\*(C`node = nickname\*(C'\fR. The number and order of the nodes is important |
244 | with \f(CW\*(C`node = nickname\*(C'\fR. The number and order of the nodes is important |
186 | and must be the same on all nodes. It is not uncommon for node sections to |
245 | and must be the same on all nodes. It is not uncommon for node sections to |
187 | be completely empty \- if the default values are right. |
246 | be completely empty \- if the default values are right. |
188 | .PP |
247 | .PP |
189 | Node-specific settings can be used at any time. If used before the first |
248 | Node-specific settings can be used at any time. If used before the first |
190 | node section they will set the default values for all following nodes. |
249 | node section they will set the default values for all following nodes. |
191 | .SH "CONFIG VARIABLES" |
250 | .SH "CONFIG VARIABLES" |
192 | .IX Header "CONFIG VARIABLES" |
251 | .IX Header "CONFIG VARIABLES" |
193 | .Sh "\s-1GLOBAL\s0 \s-1SETTINGS\s0" |
252 | .SS "\s-1GLOBAL SETTINGS\s0" |
194 | .IX Subsection "GLOBAL SETTINGS" |
253 | .IX Subsection "GLOBAL SETTINGS" |
195 | Global settings will affect the behaviour of the running gvpe daemon, that |
254 | Global settings will affect the behaviour of the running gvpe daemon, that |
196 | is, they are in some sense node-specific (config files can set different |
255 | is, they are in some sense node-specific (config files can set different |
197 | values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of |
256 | values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of |
198 | the gvpe daemon and all connections it creates. |
257 | the gvpe daemon and all connections it creates. |
|
|
258 | .IP "chroot = path or /" 4 |
|
|
259 | .IX Item "chroot = path or /" |
|
|
260 | Tells \s-1GVPE\s0 to \fIchroot\fR\|(2) to the specified path after reading all necessary |
|
|
261 | files, binding to sockets and running the \f(CW\*(C`if\-up\*(C'\fR script, but before |
|
|
262 | running \f(CW\*(C`node\-up\*(C'\fR or any other scripts. |
|
|
263 | .Sp |
|
|
264 | The special path \fI/\fR instructs \s-1GVPE\s0 to create (and remove) an empty |
|
|
265 | temporary directory to use as new root. This is most secure, but makes it |
|
|
266 | impossible to use any scripts other than the \f(CW\*(C`if\-up\*(C'\fR one. |
|
|
267 | .IP "chuid = numerical-uid" 4 |
|
|
268 | .IX Item "chuid = numerical-uid" |
|
|
269 | .PD 0 |
|
|
270 | .IP "chgid = numerical-gid" 4 |
|
|
271 | .IX Item "chgid = numerical-gid" |
|
|
272 | .PD |
|
|
273 | These two options tell \s-1GVPE\s0 to change to the given user and/or group id |
|
|
274 | after reading all necessary files, binding to sockets and running the |
|
|
275 | \&\f(CW\*(C`if\-up\*(C'\fR script. |
|
|
276 | .Sp |
|
|
277 | Other scripts, such as \f(CW\*(C`node\-up\*(C'\fR, are run with the new user id or group id. |
|
|
278 | .IP "chuser = username" 4 |
|
|
279 | .IX Item "chuser = username" |
|
|
280 | Alternative to \f(CW\*(C`chuid\*(C'\fR and \f(CW\*(C`chgid\*(C'\fR: Sets both \f(CW\*(C`chuid\*(C'\fR and \f(CW\*(C`chgid\*(C'\fR |
|
|
281 | to the user and (primary) group ids of the specified user (for example, |
|
|
282 | \&\f(CW\*(C`nobody\*(C'\fR). |
199 | .IP "dns-forw-host = hostname/ip" 4 |
283 | .IP "dns-forw-host = hostname/ip" 4 |
200 | .IX Item "dns-forw-host = hostname/ip" |
284 | .IX Item "dns-forw-host = hostname/ip" |
201 | The dns server to forward dns requests to for the \s-1DNS\s0 tunnel protocol |
285 | The \s-1DNS\s0 server to forward \s-1DNS\s0 requests to for the \s-1DNS\s0 tunnel protocol |
202 | (default: \f(CW127.0.0.1\fR, changing it is highly recommended). |
286 | (default: \f(CW127.0.0.1\fR, changing it is highly recommended). |
203 | .IP "dns-forw-port = port-number" 4 |
287 | .IP "dns-forw-port = port-number" 4 |
204 | .IX Item "dns-forw-port = port-number" |
288 | .IX Item "dns-forw-port = port-number" |
205 | The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR, |
289 | The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR, |
206 | which is fine in most cases). |
290 | which is fine in most cases). |
|
|
291 | .IP "dns-case-preserving = yes|true|on | no|false|off" 4 |
|
|
292 | .IX Item "dns-case-preserving = yes|true|on | no|false|off" |
|
|
293 | Sets whether the \s-1DNS\s0 transport forwarding server preserves case (\s-1DNS\s0 |
|
|
294 | servers have to, but some access systems are even more broken than others) |
|
|
295 | (default: true). |
|
|
296 | .Sp |
|
|
297 | Normally, when the forwarding server changes the case of domain names then |
|
|
298 | \&\s-1GVPE\s0 will automatically set this to false. |
207 | .IP "dns-max-outstanding = integer-number-of-requests" 4 |
299 | .IP "dns-max-outstanding = integer-number-of-requests" 4 |
208 | .IX Item "dns-max-outstanding = integer-number-of-requests" |
300 | .IX Item "dns-max-outstanding = integer-number-of-requests" |
209 | The maximum number of outstanding \s-1DNS\s0 transport requests |
301 | The maximum number of outstanding \s-1DNS\s0 transport requests |
210 | (default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given |
302 | (default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given |
211 | limit without receiving replies. In heavily overloaded situations it might |
303 | limit without receiving replies. In heavily overloaded situations it might |
212 | help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the |
304 | help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the |
213 | number of parallel requests. |
305 | number of parallel requests. |
214 | .Sp |
306 | .Sp |
215 | The default should be working ok for most links. |
307 | The default should be working \s-1OK\s0 for most links. |
216 | .IP "dns-overlap-factor = float" 4 |
308 | .IP "dns-overlap-factor = float" 4 |
217 | .IX Item "dns-overlap-factor = float" |
309 | .IX Item "dns-overlap-factor = float" |
218 | The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen |
310 | The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen |
219 | during a connection as it's timing base. This factor (default: \f(CW0.5\fR, |
311 | during a connection as it's timing base. This factor (default: \f(CW0.5\fR, |
220 | must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending |
312 | must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending |
… | |
… | |
222 | request might be generated every \fBmin_latency\fR seconds, which means on |
314 | request might be generated every \fBmin_latency\fR seconds, which means on |
223 | average there should only ever be one outstanding request. A factor of |
315 | average there should only ever be one outstanding request. A factor of |
224 | \&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum |
316 | \&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum |
225 | latency measured. |
317 | latency measured. |
226 | .Sp |
318 | .Sp |
227 | For congested or picky dns forwarders you could use a value nearer to or |
319 | For congested or picky \s-1DNS\s0 forwarders you could use a value nearer to or |
228 | exceeding \f(CW1\fR. |
320 | exceeding \f(CW1\fR. |
229 | .Sp |
321 | .Sp |
230 | The default should be working ok for most links. |
322 | The default should be working \s-1OK\s0 for most links. |
231 | .IP "dns-send-interval = send-interval-in-seconds" 4 |
323 | .IP "dns-send-interval = send-interval-in-seconds" 4 |
232 | .IX Item "dns-send-interval = send-interval-in-seconds" |
324 | .IX Item "dns-send-interval = send-interval-in-seconds" |
233 | The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will |
325 | The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will |
234 | use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when |
326 | use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when |
235 | the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will |
327 | the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will |
236 | not send more than 100 \s-1DNS\s0 requests per connection per second. For |
328 | not send more than 100 \s-1DNS\s0 requests per connection per second. For |
237 | high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For |
329 | high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For |
238 | congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR, |
330 | congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR, |
239 | \&\f(CW0.2\fR or even higher. |
331 | \&\f(CW0.2\fR or even higher. |
240 | .Sp |
332 | .Sp |
241 | The default should be working ok for most links. |
333 | The default should be working \s-1OK\s0 for most links. |
242 | .IP "dns-timeout-factor = float" 4 |
334 | .IP "dns-timeout-factor = float" 4 |
243 | .IX Item "dns-timeout-factor = float" |
335 | .IX Item "dns-timeout-factor = float" |
244 | Factor to multiply the \f(CW\*(C`min_latency\*(C'\fR (see \f(CW\*(C`dns\-overlap\-factor\*(C'\fR) by to |
336 | Factor to multiply the \f(CW\*(C`min_latency\*(C'\fR (see \f(CW\*(C`dns\-overlap\-factor\*(C'\fR) by to |
245 | get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport |
337 | get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport |
246 | will resend the request when no reply has been received for longer than |
338 | will resend the request when no reply has been received for longer than |
… | |
… | |
249 | .Sp |
341 | .Sp |
250 | For congested links a higher value might be necessary (e.g. \f(CW30\fR). If |
342 | For congested links a higher value might be necessary (e.g. \f(CW30\fR). If |
251 | the link is very stable lower values (e.g. \f(CW2\fR) might work |
343 | the link is very stable lower values (e.g. \f(CW2\fR) might work |
252 | nicely. Values near or below \f(CW1\fR makes no sense whatsoever. |
344 | nicely. Values near or below \f(CW1\fR makes no sense whatsoever. |
253 | .Sp |
345 | .Sp |
254 | The default should be working ok for most links but will result in low |
346 | The default should be working \s-1OK\s0 for most links but will result in low |
255 | throughput if packet loss is high. |
347 | throughput if packet loss is high. |
256 | .IP "if-up = relative-or-absolute-path" 4 |
348 | .IP "if-up = relative-or-absolute-path" 4 |
257 | .IX Item "if-up = relative-or-absolute-path" |
349 | .IX Item "if-up = relative-or-absolute-path" |
258 | Sets the path of a script that should be called immediately after the |
350 | Sets the path of a script that should be called immediately after the |
259 | network interface is initialized (but not neccessarily up). The following |
351 | network interface is initialized (but not necessarily up). The following |
260 | environment variables are passed to it (the values are just examples). |
352 | environment variables are passed to it (the values are just examples). |
261 | .Sp |
353 | .Sp |
262 | Variables that have the same value on all nodes: |
354 | Variables that have the same value on all nodes: |
263 | .RS 4 |
355 | .RS 4 |
264 | .IP "CONFBASE=/etc/gvpe" 4 |
356 | .IP "CONFBASE=/etc/gvpe" 4 |
… | |
… | |
295 | .IP "MAC=fe:fd:80:00:00:01" 4 |
387 | .IP "MAC=fe:fd:80:00:00:01" 4 |
296 | .IX Item "MAC=fe:fd:80:00:00:01" |
388 | .IX Item "MAC=fe:fd:80:00:00:01" |
297 | The \s-1MAC\s0 address the network interface has to use. |
389 | The \s-1MAC\s0 address the network interface has to use. |
298 | .Sp |
390 | .Sp |
299 | Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not |
391 | Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not |
300 | do this automatically. Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for |
392 | do this automatically. Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR man page for |
301 | platform-specific information. |
393 | platform-specific information. |
302 | .IP "NODENAME=branch1" 4 |
394 | .IP "NODENAME=branch1" 4 |
303 | .IX Item "NODENAME=branch1" |
395 | .IX Item "NODENAME=branch1" |
304 | The nickname of the node. |
396 | The nickname of the node. |
305 | .IP "NODEID=1" 4 |
397 | .IP "NODEID=1" 4 |
306 | .IX Item "NODEID=1" |
398 | .IX Item "NODEID=1" |
307 | The numerical node \s-1ID\s0 of the node running this instance of \s-1GVPE\s0. The first |
399 | The numerical node \s-1ID\s0 of the node running this instance of \s-1GVPE.\s0 The first |
308 | node mentioned in the config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on. |
400 | node mentioned in the config file gets \s-1ID 1,\s0 the second \s-1ID 2\s0 and so on. |
309 | .RE |
401 | .RE |
310 | .RS 4 |
402 | .RS 4 |
311 | .Sp |
403 | .Sp |
312 | In addition, all node-specific variables (except \f(CW\*(C`NODEID\*(C'\fR) will be |
404 | In addition, all node-specific variables (except \f(CW\*(C`NODEID\*(C'\fR) will be |
313 | available with a postfix of \f(CW\*(C`_nodeid\*(C'\fR, which contains the value for that |
405 | available with a postfix of \f(CW\*(C`_nodeid\*(C'\fR, which contains the value for that |
… | |
… | |
322 | \& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME |
414 | \& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME |
323 | \& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME |
415 | \& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME |
324 | \& ip route add 10.0.0.0/8 dev $IFNAME |
416 | \& ip route add 10.0.0.0/8 dev $IFNAME |
325 | .Ve |
417 | .Ve |
326 | .Sp |
418 | .Sp |
327 | More complicated examples (using routing to reduce arp traffic) can be |
419 | More complicated examples (using routing to reduce \s-1ARP\s0 traffic) can be |
328 | found in the etc/ subdirectory of the distribution. |
420 | found in the \fIetc/\fR subdirectory of the distribution. |
329 | .RE |
421 | .RE |
330 | .IP "ifname = devname" 4 |
422 | .IP "ifname = devname" 4 |
331 | .IX Item "ifname = devname" |
423 | .IX Item "ifname = devname" |
332 | Sets the tun interface name to the given name. The default is OS-specific |
424 | Sets the tun interface name to the given name. The default is OS-specific |
333 | and most probably something like \f(CW\*(C`tun0\*(C'\fR. |
425 | and most probably something like \f(CW\*(C`tun0\*(C'\fR. |
… | |
… | |
345 | global option because all nodes must use the same protocol, and since |
437 | global option because all nodes must use the same protocol, and since |
346 | there are no port numbers, you cannot easily run more than one gvpe |
438 | there are no port numbers, you cannot easily run more than one gvpe |
347 | instance using the same protocol, nor can you share the protocol with |
439 | instance using the same protocol, nor can you share the protocol with |
348 | other programs. |
440 | other programs. |
349 | .Sp |
441 | .Sp |
350 | The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through |
442 | The default is 47 (\s-1GRE\s0), which has a good chance of tunneling |
351 | firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other |
443 | through firewalls (but note that gvpe's rawip protocol is not \s-1GRE\s0 |
352 | common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98 |
444 | compatible). Other common choices are 50 (\s-1IPSEC, ESP\s0), 51 (\s-1IPSEC, AH\s0), 4 |
353 | (\s-1ENCAP\s0, rfc1241) |
445 | (\s-1IPIP\s0 tunnels) or 98 (\s-1ENCAP,\s0 rfc1241). |
|
|
446 | .Sp |
|
|
447 | Many versions of Linux seem to have a bug that causes them to reorder |
|
|
448 | packets for some ip protocols (\s-1GRE, ESP\s0) but not for others (\s-1AH\s0), so |
|
|
449 | choose wisely (that is, use 51, \s-1AH\s0). |
354 | .IP "http-proxy-host = hostname/ip" 4 |
450 | .IP "http-proxy-host = hostname/ip" 4 |
355 | .IX Item "http-proxy-host = hostname/ip" |
451 | .IX Item "http-proxy-host = hostname/ip" |
356 | The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was |
452 | The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was |
357 | compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of |
453 | compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of |
358 | tcp connections through a http proxy server. |
454 | tcp connections through a http proxy server. |
… | |
… | |
360 | \&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and |
456 | \&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and |
361 | port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy |
457 | port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy |
362 | requires authentication. |
458 | requires authentication. |
363 | .Sp |
459 | .Sp |
364 | Please note that gvpe will still try to resolve all hostnames in the |
460 | Please note that gvpe will still try to resolve all hostnames in the |
365 | configuration file, so if you are behind a proxy without access to a dns |
461 | configuration file, so if you are behind a proxy without access to a \s-1DNS\s0 |
366 | server better use numerical \s-1IP\s0 addresses. |
462 | server better use numerical \s-1IP\s0 addresses. |
367 | .Sp |
463 | .Sp |
368 | To make best use of this option disable all protocols except tcp in your |
464 | To make best use of this option disable all protocols except \s-1TCP\s0 in your |
369 | config file and make sure your routers (or all other nodes) are listening |
465 | config file and make sure your routers (or all other nodes) are listening |
370 | on a port that the proxy allows (443, https, is a common choice). |
466 | on a port that the proxy allows (443, https, is a common choice). |
371 | .Sp |
467 | .Sp |
372 | If you have a router, connecting to it will suffice. Otherwise tcp must be |
468 | If you have a router, connecting to it will suffice. Otherwise \s-1TCP\s0 must be |
373 | enabled on all nodes. |
469 | enabled on all nodes. |
374 | .Sp |
470 | .Sp |
375 | Example: |
471 | Example: |
376 | .Sp |
472 | .Sp |
377 | .Vb 3 |
473 | .Vb 3 |
… | |
… | |
383 | .IX Item "http-proxy-port = proxy-tcp-port" |
479 | .IX Item "http-proxy-port = proxy-tcp-port" |
384 | The port where your proxy server listens. |
480 | The port where your proxy server listens. |
385 | .IP "http-proxy-auth = login:password" 4 |
481 | .IP "http-proxy-auth = login:password" 4 |
386 | .IX Item "http-proxy-auth = login:password" |
482 | .IX Item "http-proxy-auth = login:password" |
387 | The optional login and password used to authenticate to the proxy server, |
483 | The optional login and password used to authenticate to the proxy server, |
388 | seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is |
484 | separated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is |
389 | currently supported. |
485 | currently supported. |
390 | .IP "keepalive = seconds" 4 |
486 | .IP "keepalive = seconds" 4 |
391 | .IX Item "keepalive = seconds" |
487 | .IX Item "keepalive = seconds" |
392 | Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this |
488 | Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this |
393 | many seconds of inactivity the daemon will start to send keepalive probe |
489 | many seconds of inactivity the daemon will start to send keepalive probe |
394 | every 5 seconds until it receives a reply from the other end. If no reply |
490 | every 3 seconds until it receives a reply from the other end. If no reply |
395 | is received within 30 seconds, the peer is considered unreachable and the |
491 | is received within 15 seconds, the peer is considered unreachable and the |
396 | connection is closed. |
492 | connection is closed. |
397 | .IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 |
493 | .IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 |
398 | .IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" |
494 | .IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" |
399 | Set the logging level. Connection established messages are logged at level |
495 | Set the logging level. Connection established messages are logged at level |
400 | \&\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. |
496 | \&\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. |
401 | .IP "mtu = bytes" 4 |
497 | .IP "mtu = bytes" 4 |
402 | .IX Item "mtu = bytes" |
498 | .IX Item "mtu = bytes" |
403 | Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically |
499 | Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically |
404 | the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate |
500 | the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate |
405 | maximum overhead (e.g. udp header size, encryption blocksize...) and pass |
501 | maximum overhead (e.g. \s-1UDP\s0 header size, encryption blocksize...) and pass |
406 | this information to the \f(CW\*(C`if\-up\*(C'\fR script. |
502 | this information to the \f(CW\*(C`if\-up\*(C'\fR script. |
407 | .Sp |
503 | .Sp |
408 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
504 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
409 | .Sp |
505 | .Sp |
410 | This value must be the minimum of the mtu values of all nodes. |
506 | This value must be the minimum of the \s-1MTU\s0 values of all nodes. |
411 | .IP "node = nickname" 4 |
507 | .IP "nfmark = integer" 4 |
412 | .IX Item "node = nickname" |
508 | .IX Item "nfmark = integer" |
413 | Not really a config setting but introduces a node section. The nickname is |
509 | This advanced option, when set to a nonzero value (default: \f(CW0\fR), tries |
414 | used to select the right configuration section and must be passed as an |
510 | to set the netfilter mark (or fwmark) value on all sockets gvpe uses to |
415 | argument to the gvpe daemon. |
511 | send packets. |
|
|
512 | .Sp |
|
|
513 | This can be used to make gvpe use a different set of routing rules. For |
|
|
514 | example, on GNU/Linux, the \f(CW\*(C`if\-up\*(C'\fR could set \f(CW\*(C`nfmark\*(C'\fR to 1000 and then |
|
|
515 | put all routing rules into table \f(CW99\fR and then use an ip rule to make |
|
|
516 | gvpe traffic avoid that routing table, in effect routing normal traffic |
|
|
517 | via gvpe and gvpe traffic via the normal system routing tables: |
|
|
518 | .Sp |
|
|
519 | .Vb 1 |
|
|
520 | \& ip rule add not fwmark 1000 lookup 99 |
|
|
521 | .Ve |
416 | .IP "node-up = relative-or-absolute-path" 4 |
522 | .IP "node-up = relative-or-absolute-path" 4 |
417 | .IX Item "node-up = relative-or-absolute-path" |
523 | .IX Item "node-up = relative-or-absolute-path" |
418 | Sets a command (default: none) that should be called whenever a connection |
524 | Sets a command (default: none) that should be called whenever a connection |
419 | is established (even on rekeying operations). Note that node\-up/down |
525 | is established (even on rekeying operations). Note that node\-up/down |
420 | scripts will be run asynchronously, but execution is serialised, so there |
526 | scripts will be run asynchronously, but execution is serialised, so there |
421 | will only ever be one such script running. |
527 | will only ever be one such script running. |
422 | .Sp |
528 | .Sp |
423 | In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following |
529 | In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following |
424 | environment variables will be set: |
530 | environment variables will be set (values are just examples): |
425 | .RS 4 |
531 | .RS 4 |
426 | .IP "DESTNODE=branch2" 4 |
532 | .IP "DESTNODE=branch2" 4 |
427 | .IX Item "DESTNODE=branch2" |
533 | .IX Item "DESTNODE=branch2" |
428 | The name of the remote node. |
534 | The name of the remote node. |
429 | .IP "DESTID=2" 4 |
535 | .IP "DESTID=2" 4 |
430 | .IX Item "DESTID=2" |
536 | .IX Item "DESTID=2" |
431 | The node id of the remote node. |
537 | The node id of the remote node. |
|
|
538 | .IP "DESTSI=rawip/88.99.77.55:0" 4 |
|
|
539 | .IX Item "DESTSI=rawip/88.99.77.55:0" |
|
|
540 | The \*(L"socket info\*(R" of the target node, protocol dependent but usually in |
|
|
541 | the format protocol/ip:port. |
432 | .IP "DESTIP=188.13.66.8" 4 |
542 | .IP "DESTIP=188.13.66.8" 4 |
433 | .IX Item "DESTIP=188.13.66.8" |
543 | .IX Item "DESTIP=188.13.66.8" |
434 | The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from |
544 | The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from |
435 | everywhere, as long as the other node can authenticate itself). |
545 | everywhere, as long as the other node can authenticate itself). |
436 | .IP "DESTPORT=655 # deprecated" 4 |
546 | .IP "DESTPORT=655 # deprecated" 4 |
437 | .IX Item "DESTPORT=655 # deprecated" |
547 | .IX Item "DESTPORT=655 # deprecated" |
438 | The \s-1UDP\s0 port used by the other side. |
548 | The protocol port used by the other side, if applicable. |
439 | .IP "STATE=UP" 4 |
549 | .IP "STATE=up" 4 |
440 | .IX Item "STATE=UP" |
550 | .IX Item "STATE=up" |
441 | Node-up scripts get called with STATE=UP, node-down scripts get called |
551 | Node-up scripts get called with STATE=up, node-change scripts get called |
442 | with STATE=DOWN. |
552 | with STATE=change and node-down scripts get called with STATE=down. |
443 | .RE |
553 | .RE |
444 | .RS 4 |
554 | .RS 4 |
445 | .Sp |
555 | .Sp |
446 | Here is a nontrivial example that uses nsupdate to update the name => ip |
556 | Here is a nontrivial example that uses nsupdate to update the name => ip |
447 | mapping in some dns zone: |
557 | mapping in some \s-1DNS\s0 zone: |
448 | .Sp |
558 | .Sp |
449 | .Vb 6 |
559 | .Vb 6 |
450 | \& #!/bin/sh |
560 | \& #!/bin/sh |
451 | \& { |
561 | \& { |
452 | \& echo update delete $DESTNODE.lowttl.example.net. a |
562 | \& echo update delete $DESTNODE.lowttl.example.net. a |
453 | \& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP |
563 | \& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP |
454 | \& echo |
564 | \& echo |
455 | \& } | nsupdate \-d \-k $CONFBASE:key.example.net. |
565 | \& } | nsupdate \-d \-k $CONFBASE:key.example.net. |
456 | .Ve |
566 | .Ve |
457 | .RE |
567 | .RE |
|
|
568 | .IP "node-change = relative-or-absolute-path" 4 |
|
|
569 | .IX Item "node-change = relative-or-absolute-path" |
|
|
570 | Same as \f(CW\*(C`node\-change\*(C'\fR, but gets called whenever something about a |
|
|
571 | connection changes (such as the source \s-1IP\s0 address). |
458 | .IP "node-down = relative-or-absolute-path" 4 |
572 | .IP "node-down = relative-or-absolute-path" 4 |
459 | .IX Item "node-down = relative-or-absolute-path" |
573 | .IX Item "node-down = relative-or-absolute-path" |
460 | Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. |
574 | Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. |
461 | .IP "pid-file = path" 4 |
575 | .IP "pid-file = path" 4 |
462 | .IX Item "pid-file = path" |
576 | .IX Item "pid-file = path" |
463 | The path to the pid file to check and create |
577 | The path to the pid file to check and create |
464 | (default: \f(CW\*(C`LOCALSTATEDIR/run/gvpe.pid\*(C'\fR). |
578 | (default: \f(CW\*(C`LOCALSTATEDIR/run/gvpe.pid\*(C'\fR). The first \f(CW%s\fR is replaced by |
|
|
579 | the nodename \- any other use of \f(CW\*(C`%\*(C'\fR must be written as \f(CW\*(C`%%\*(C'\fR. |
465 | .IP "private-key = relative-path-to-key" 4 |
580 | .IP "private-key = relative-path-to-key" 4 |
466 | .IX Item "private-key = relative-path-to-key" |
581 | .IX Item "private-key = relative-path-to-key" |
467 | Sets the path (relative to the config directory) to the private key |
582 | Sets the path (relative to the config directory) to the private key |
468 | (default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must |
583 | (default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must |
469 | be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could |
584 | be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could use |
470 | use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where |
585 | paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to be able to share the same config directory |
471 | \&\f(CW\*(C`gvpectrl\*(C'\fR puts them. |
586 | between nodes. |
472 | .Sp |
587 | .Sp |
473 | Since only the private key file of the current node is used and the |
588 | Since only the private key file of the current node is used and the |
474 | private key file should be kept secret per-node to avoid spoofings, it is |
589 | private key file should be kept secret per-node to avoid spoofing, it is |
475 | not recommended to use this feature. |
590 | not recommended to use this feature this way though. |
476 | .IP "rekey = seconds" 4 |
591 | .IP "rekey = seconds" 4 |
477 | .IX Item "rekey = seconds" |
592 | .IX Item "rekey = seconds" |
478 | Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are |
593 | Sets the rekeying interval in seconds (default: \f(CW3607\fR). Connections are |
479 | reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. |
594 | reestablished every \f(CW\*(C`rekey\*(C'\fR seconds, making them use a new encryption |
|
|
595 | key. |
|
|
596 | .IP "seed-device = path" 4 |
|
|
597 | .IX Item "seed-device = path" |
|
|
598 | The random device used to initially and regularly seed the random |
|
|
599 | number generator (default: \fI/dev/urandom\fR). Randomness is of paramount |
|
|
600 | importance to the security of the algorithms used in gvpe. |
|
|
601 | .Sp |
|
|
602 | On program start and every seed-interval, gvpe will read 64 octets. |
|
|
603 | .Sp |
|
|
604 | Setting this path to the empty string will disable this functionality |
|
|
605 | completely (the underlying crypto library will likely look for entropy |
|
|
606 | sources on it's own though, so not all is lost). |
|
|
607 | .IP "seed-interval = seconds" 4 |
|
|
608 | .IX Item "seed-interval = seconds" |
|
|
609 | The number of seconds between reseeds of the random number generator |
|
|
610 | (default: \f(CW3613\fR). A value of \f(CW0\fR disables this regular reseeding. |
|
|
611 | .IP "serial = string" 4 |
|
|
612 | .IX Item "serial = string" |
|
|
613 | The configuration serial number. This can be any string up to 16 bytes |
|
|
614 | length. Only when the serial matches on both sides of a conenction will |
|
|
615 | the connection succeed. This is \fInot\fR a security mechanism and eay to |
|
|
616 | spoof, this mechanism exists to alert users that their config is outdated. |
|
|
617 | .Sp |
|
|
618 | It's recommended to specify this is a date string such as \f(CW\*(C`2013\-05\-05\*(C'\fR or |
|
|
619 | \&\f(CW20121205084417\fR. |
|
|
620 | .Sp |
|
|
621 | The exact algorithm is as this: if a connection request is received form a |
|
|
622 | node with an identical serial, then it succeeds normally. |
|
|
623 | .Sp |
|
|
624 | If the remote serial is lower than the local serial, it is ignored. |
|
|
625 | .Sp |
|
|
626 | If the remote serial is higher than the local serial, a warning message is |
|
|
627 | logged. |
480 | .Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
628 | .SS "\s-1NODE SPECIFIC SETTINGS\s0" |
481 | .IX Subsection "NODE SPECIFIC SETTINGS" |
629 | .IX Subsection "NODE SPECIFIC SETTINGS" |
482 | The following settings are node\-specific, that is, every node can have |
630 | The following settings are node-specific, that is, every node can have |
483 | different settings, even within the same gvpe instance. Settings that are |
631 | different settings, even within the same gvpe instance. Settings that are |
484 | set before the first node section set the defaults, settings that are |
632 | set before the first node section set the defaults, settings that are |
485 | set within a node section only apply to the given node. |
633 | set within a node section only apply to the given node. |
486 | .IP "allow-direct = nodename" 4 |
634 | .IP "allow-direct = nodename" 4 |
487 | .IX Item "allow-direct = nodename" |
635 | .IX Item "allow-direct = nodename" |
488 | Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info. |
636 | Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info. |
489 | .IP "compress = yes|true|on | no|false|off" 4 |
637 | .IP "compress = yes|true|on | no|false|off" 4 |
490 | .IX Item "compress = yes|true|on | no|false|off" |
638 | .IX Item "compress = yes|true|on | no|false|off" |
|
|
639 | For the current node, this specified whether it will accept compressed |
|
|
640 | packets, and for all other nodes, this specifies whether to try to |
491 | Wether to compress data packets sent to this node (default: \f(CW\*(C`yes\*(C'\fR). |
641 | compress data packets sent to this node (default: \f(CW\*(C`yes\*(C'\fR). Compression is |
492 | Compression is really cheap even on slow computers and has no size |
642 | really cheap even on slow computers, has no size overhead at all and will |
493 | overhead at all, so enabling this is a good idea. |
643 | only be used when the other side supports compression, so enabling this is |
|
|
644 | often a good idea. |
494 | .IP "connect = ondemand | never | always | disabled" 4 |
645 | .IP "connect = ondemand | never | always | disabled" 4 |
495 | .IX Item "connect = ondemand | never | always | disabled" |
646 | .IX Item "connect = ondemand | never | always | disabled" |
496 | Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always |
647 | Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always |
497 | try to establish and keep a connection to the given node), \f(CW\*(C`never\*(C'\fR |
648 | try to establish and keep a connection to the given node), \f(CW\*(C`never\*(C'\fR |
498 | (never initiate a connection to the given host, but accept connections), |
649 | (never initiate a connection to the given host, but accept connections), |
… | |
… | |
509 | \&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in |
660 | \&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in |
510 | networks with routers, as routers are required for indirect connections. |
661 | networks with routers, as routers are required for indirect connections. |
511 | .Sp |
662 | .Sp |
512 | Sometimes, a node cannot reach some other nodes for reasons of network |
663 | Sometimes, a node cannot reach some other nodes for reasons of network |
513 | connectivity. For example, a node behind a firewall that only allows |
664 | connectivity. For example, a node behind a firewall that only allows |
514 | conenctions to/from a single other node in the network. In this case one |
665 | connections to/from a single other node in the network. In this case one |
515 | should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other |
666 | should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other |
516 | node \fImust\fR be a router for this to work). |
667 | node \fImust\fR be a router for this to work). |
517 | .Sp |
668 | .Sp |
518 | The algorithm to check wether a connection may be direct is as follows: |
669 | The algorithm to check whether a connection may be direct is as follows: |
519 | .Sp |
670 | .Sp |
520 | 1. Other node mentioned in a \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection. |
671 | 1. Other node mentioned in an \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection. |
521 | .Sp |
672 | .Sp |
522 | 2. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections. |
673 | 2. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections. |
523 | .Sp |
674 | .Sp |
524 | 3. Allow the connection. |
675 | 3. Allow the connection. |
525 | .Sp |
676 | .Sp |
… | |
… | |
564 | was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option. |
715 | was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option. |
565 | .IP "enable-icmp = yes|true|on | no|false|off" 4 |
716 | .IP "enable-icmp = yes|true|on | no|false|off" 4 |
566 | .IX Item "enable-icmp = yes|true|on | no|false|off" |
717 | .IX Item "enable-icmp = yes|true|on | no|false|off" |
567 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol. |
718 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol. |
568 | .Sp |
719 | .Sp |
569 | Enable the \s-1ICMP\s0 transport using icmp packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this |
720 | Enable the \s-1ICMP\s0 transport using \s-1ICMP\s0 packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this |
570 | node. |
721 | node. |
571 | .IP "enable-rawip = yes|true|on | no|false|off" 4 |
722 | .IP "enable-rawip = yes|true|on | no|false|off" 4 |
572 | .IX Item "enable-rawip = yes|true|on | no|false|off" |
723 | .IX Item "enable-rawip = yes|true|on | no|false|off" |
573 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol. |
724 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW IP\s0 transport protocol. |
574 | .Sp |
725 | .Sp |
575 | Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol |
726 | Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol |
576 | (default: \f(CW\*(C`no\*(C'\fR). |
727 | (default: \f(CW\*(C`no\*(C'\fR). |
577 | .IP "enable-tcp = yes|true|on | no|false|off" 4 |
728 | .IP "enable-tcp = yes|true|on | no|false|off" 4 |
578 | .IX Item "enable-tcp = yes|true|on | no|false|off" |
729 | .IX Item "enable-tcp = yes|true|on | no|false|off" |
… | |
… | |
583 | when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. |
734 | when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. |
584 | .IP "enable-udp = yes|true|on | no|false|off" 4 |
735 | .IP "enable-udp = yes|true|on | no|false|off" 4 |
585 | .IX Item "enable-udp = yes|true|on | no|false|off" |
736 | .IX Item "enable-udp = yes|true|on | no|false|off" |
586 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol. |
737 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol. |
587 | .Sp |
738 | .Sp |
588 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, |
739 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR). |
589 | unless no other protocol is enabled for a node, in which case this |
|
|
590 | protocol is enabled automatically). |
|
|
591 | .Sp |
|
|
592 | \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though |
|
|
593 | it might get switched on automatically, as some future version might |
|
|
594 | default to another default protocol. |
|
|
595 | .IP "hostname = hostname | ip [can not be defaulted]" 4 |
740 | .IP "hostname = hostname | ip [can not be defaulted]" 4 |
596 | .IX Item "hostname = hostname | ip [can not be defaulted]" |
741 | .IX Item "hostname = hostname | ip [can not be defaulted]" |
597 | Forces the address of this node to be set to the given dns hostname or ip |
742 | Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0 |
598 | address. It will be resolved before each connect request, so dyndns should |
743 | address. It will be resolved before each connect request, so dyndns should |
599 | work fine. If this setting is not specified and a router is available, |
744 | work fine. If this setting is not specified and a router is available, |
600 | then the router will be queried for the address of this node. Otherwise, |
745 | then the router will be queried for the address of this node. Otherwise, |
601 | the connection attempt will fail. |
746 | the connection attempt will fail. |
|
|
747 | .Sp |
|
|
748 | Note that \s-1DNS\s0 resolving is done synchronously, pausing the daemon. If that |
|
|
749 | is an issue you need to specify \s-1IP\s0 addresses. |
602 | .IP "icmp-type = integer" 4 |
750 | .IP "icmp-type = integer" 4 |
603 | .IX Item "icmp-type = integer" |
751 | .IX Item "icmp-type = integer" |
604 | Sets the type value to be used for outgoing (and incoming) packets sent |
752 | Sets the type value to be used for outgoing (and incoming) packets sent |
605 | via the \s-1ICMP\s0 transport. |
753 | via the \s-1ICMP\s0 transport. |
606 | .Sp |
754 | .Sp |
607 | The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as |
755 | The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as |
608 | \&\*(L"ping\-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. |
756 | \&\*(L"ping-reply\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. |
609 | \&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. |
757 | \&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. |
610 | .IP "if-up-data = value" 4 |
758 | .IP "if-up-data = value" 4 |
611 | .IX Item "if-up-data = value" |
759 | .IX Item "if-up-data = value" |
612 | The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR |
760 | The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR |
613 | script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR. |
761 | script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR. |
614 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
762 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
615 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
763 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
616 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
764 | Whether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
617 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
765 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
618 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
766 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
619 | to the tunnel device, which is usually what you want. |
767 | to the tunnel device, which is usually what you want. |
|
|
768 | .IP "low-power = yes|true|on | no|false|off" 4 |
|
|
769 | .IX Item "low-power = yes|true|on | no|false|off" |
|
|
770 | If true, designates a node as a low-power node. Low-power nodes use |
|
|
771 | larger timeouts and try to reduce cpu time. Other nodes talking to a |
|
|
772 | low-power node will also use larger timeouts, and will use less aggressive |
|
|
773 | optimisations, in the hope of reducing load. Security is not compromised. |
|
|
774 | .Sp |
|
|
775 | The typical low-power node would be a mobile phone, where wakeups and |
|
|
776 | encryption can significantly increase power drain. |
620 | .IP "max-retry = positive-number" 4 |
777 | .IP "max-retry = positive-number" 4 |
621 | .IX Item "max-retry = positive-number" |
778 | .IX Item "max-retry = positive-number" |
622 | The maximum interval in seconds (default: \f(CW3600\fR, one hour) between |
779 | The maximum interval in seconds (default: \f(CW3600\fR, one hour) between |
623 | retries to establish a connection to this node. When a connection cannot |
780 | retries to establish a connection to this node. When a connection cannot |
624 | be established, gvpe uses exponential backoff capped at this value. It's |
781 | be established, gvpe uses exponential back-off capped at this value. It's |
625 | sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on |
782 | sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on |
626 | connections to routers that usually are stable but sometimes are down, to |
783 | connections to routers that usually are stable but sometimes are down, to |
627 | assure quick reconnections even after longer downtimes. |
784 | assure quick reconnections even after longer downtimes. |
628 | .IP "max-ttl = seconds" 4 |
785 | .IP "max-ttl = seconds" 4 |
629 | .IX Item "max-ttl = seconds" |
786 | .IX Item "max-ttl = seconds" |
… | |
… | |
672 | Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not |
829 | Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not |
673 | officially assigned by \s-1IANA\s0!). |
830 | officially assigned by \s-1IANA\s0!). |
674 | .SH "CONFIG DIRECTORY LAYOUT" |
831 | .SH "CONFIG DIRECTORY LAYOUT" |
675 | .IX Header "CONFIG DIRECTORY LAYOUT" |
832 | .IX Header "CONFIG DIRECTORY LAYOUT" |
676 | The default (or recommended) directory layout for the config directory is: |
833 | The default (or recommended) directory layout for the config directory is: |
677 | .IP "\(bu" 4 |
834 | .IP "gvpe.conf" 4 |
678 | .IX Xref "gvpe.conf" |
835 | .IX Item "gvpe.conf" |
679 | The config file. |
836 | The config file. |
680 | .IP "\(bu" 4 |
837 | .IP "if-up" 4 |
681 | .IX Xref "if-up" |
838 | .IX Item "if-up" |
682 | The if-up script |
839 | The if-up script |
683 | .IP "," 4 |
840 | .IP "node-up, node-down" 4 |
684 | .IX Xref "node-up node-down" |
841 | .IX Item "node-up, node-down" |
685 | If used the node up or node-down scripts. |
842 | If used the node up or node-down scripts. |
686 | .IP "\(bu" 4 |
843 | .IP "hostkey" 4 |
687 | .IX Xref "hostkey" |
844 | .IX Item "hostkey" |
688 | The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. |
845 | The (default path of the) private key of the current host. |
689 | .IP "\(bu" 4 |
846 | .IP "pubkey/nodename" 4 |
690 | .IX Xref "pubkey nodename" |
847 | .IX Item "pubkey/nodename" |
691 | The public keys of the other nodes, one file per node. |
848 | The public keys of the other nodes, one file per node. |
692 | .SH "SEE ALSO" |
849 | .SH "SEE ALSO" |
693 | .IX Header "SEE ALSO" |
850 | .IX Header "SEE ALSO" |
694 | \&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). |
851 | \&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). |
695 | .SH "AUTHOR" |
852 | .SH "AUTHOR" |