1 | .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) |
1 | .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) |
2 | .\" |
2 | .\" |
3 | .\" Standard preamble: |
3 | .\" Standard preamble: |
4 | .\" ======================================================================== |
4 | .\" ======================================================================== |
5 | .de Sp \" Vertical space (when we can't use .PP) |
5 | .de Sp \" Vertical space (when we can't use .PP) |
6 | .if t .sp .5v |
6 | .if t .sp .5v |
… | |
… | |
36 | .el\{\ |
36 | .el\{\ |
37 | . ds -- \|\(em\| |
37 | . ds -- \|\(em\| |
38 | . ds PI \(*p |
38 | . ds PI \(*p |
39 | . ds L" `` |
39 | . ds L" `` |
40 | . ds R" '' |
40 | . ds R" '' |
|
|
41 | . ds C` |
|
|
42 | . ds C' |
41 | 'br\} |
43 | 'br\} |
42 | .\" |
44 | .\" |
43 | .\" Escape single quotes in literal strings from groff's Unicode transform. |
45 | .\" Escape single quotes in literal strings from groff's Unicode transform. |
44 | .ie \n(.g .ds Aq \(aq |
46 | .ie \n(.g .ds Aq \(aq |
45 | .el .ds Aq ' |
47 | .el .ds Aq ' |
46 | .\" |
48 | .\" |
47 | .\" 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 |
48 | .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
50 | .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
49 | .\" 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 |
50 | .\" output yourself in some meaningful fashion. |
52 | .\" output yourself in some meaningful fashion. |
51 | .ie \nF \{\ |
53 | .\" |
|
|
54 | .\" Avoid warning from groff about undefined register 'F'. |
52 | . de IX |
55 | .de IX |
53 | . tm Index:\\$1\t\\n%\t"\\$2" |
|
|
54 | .. |
56 | .. |
55 | . nr % 0 |
57 | .nr rF 0 |
56 | . 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 | . \} |
57 | .\} |
69 | .\} |
58 | .el \{\ |
70 | .rr rF |
59 | . de IX |
|
|
60 | .. |
|
|
61 | .\} |
|
|
62 | .\" |
71 | .\" |
63 | .\" 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). |
64 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
73 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
65 | . \" fudge factors for nroff and troff |
74 | . \" fudge factors for nroff and troff |
66 | .if n \{\ |
75 | .if n \{\ |
… | |
… | |
122 | .\} |
131 | .\} |
123 | .rm #[ #] #H #V #F C |
132 | .rm #[ #] #H #V #F C |
124 | .\" ======================================================================== |
133 | .\" ======================================================================== |
125 | .\" |
134 | .\" |
126 | .IX Title "GVPE.CONF 5" |
135 | .IX Title "GVPE.CONF 5" |
127 | .TH GVPE.CONF 5 "2011-02-12" "2.24" "GNU Virtual Private Ethernet" |
136 | .TH GVPE.CONF 5 "2016-11-12" "3.0" "GNU Virtual Private Ethernet" |
128 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
137 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
129 | .\" way too many mistakes in technical documents. |
138 | .\" way too many mistakes in technical documents. |
130 | .if n .ad l |
139 | .if n .ad l |
131 | .nh |
140 | .nh |
132 | .SH "NAME" |
141 | .SH "NAME" |
… | |
… | |
158 | = 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 |
159 | 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 |
160 | 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 |
161 | values, but not within the variable names or values themselves. |
170 | values, but not within the variable names or values themselves. |
162 | .PP |
171 | .PP |
163 | 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 |
164 | \&\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. |
165 | (if the nodename starts with \*(L"!\*(R") on all nodes except the named one. |
|
|
166 | .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 |
167 | For example, set the \s-1MTU\s0 to \f(CW1450\fR everywhere, loglevel to \f(CW\*(C`noise\*(C'\fR on |
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 |
168 | branch1, and connect to \f(CW\*(C`ondemand\*(C'\fR everywhere but on branch2: |
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. |
169 | .PP |
207 | .Sp |
170 | .Vb 3 |
208 | .Vb 3 |
171 | \& mtu = 1450 |
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 applied \*(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 a few global settings (like the \s-1UDP\s0 |
239 | Usually, a config file starts with a few global settings (like the \s-1UDP\s0 |
181 | port to listen on), followed by node-specific sections that begin with a |
240 | port to listen on), followed by node-specific sections that begin with a |
182 | \&\f(CW\*(C`node = nickname\*(C'\fR line. |
241 | \&\f(CW\*(C`node = nickname\*(C'\fR line. |
… | |
… | |
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 | .SS "\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 \s-1DNS\s0 server to forward \s-1DNS\s0 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 |
… | |
… | |
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 |
… | |
… | |
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 |
442 | The default is 47 (\s-1GRE\s0), which has a good chance of tunneling |
351 | through firewalls (but note that gvpe's rawip protocol is not \s-1GRE\s0 |
443 | through firewalls (but note that gvpe's rawip protocol is not \s-1GRE\s0 |
352 | compatible). Other common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 |
444 | compatible). Other common choices are 50 (\s-1IPSEC, ESP\s0), 51 (\s-1IPSEC, AH\s0), 4 |
353 | (\s-1IPIP\s0 tunnels) or 98 (\s-1ENCAP\s0, rfc1241). |
445 | (\s-1IPIP\s0 tunnels) or 98 (\s-1ENCAP,\s0 rfc1241). |
354 | .Sp |
446 | .Sp |
355 | Many versions of Linux seem to have a bug that causes them to reorder |
447 | Many versions of Linux seem to have a bug that causes them to reorder |
356 | packets for some ip protocols (\s-1GRE\s0, \s-1ESP\s0) but not for others (\s-1AH\s0), so |
448 | packets for some ip protocols (\s-1GRE, ESP\s0) but not for others (\s-1AH\s0), so |
357 | choose wisely (that is, use 51, \s-1AH\s0). |
449 | choose wisely (that is, use 51, \s-1AH\s0). |
358 | .IP "http-proxy-host = hostname/ip" 4 |
450 | .IP "http-proxy-host = hostname/ip" 4 |
359 | .IX Item "http-proxy-host = hostname/ip" |
451 | .IX Item "http-proxy-host = hostname/ip" |
360 | 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 |
361 | 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 |
… | |
… | |
393 | currently supported. |
485 | currently supported. |
394 | .IP "keepalive = seconds" 4 |
486 | .IP "keepalive = seconds" 4 |
395 | .IX Item "keepalive = seconds" |
487 | .IX Item "keepalive = seconds" |
396 | 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 |
397 | 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 |
398 | every 3 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 |
399 | is received within 15 seconds, the peer is considered unreachable and the |
491 | is received within 15 seconds, the peer is considered unreachable and the |
400 | connection is closed. |
492 | connection is closed. |
401 | .IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 |
493 | .IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 |
402 | .IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" |
494 | .IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" |
403 | Set the logging level. Connection established messages are logged at level |
495 | Set the logging level. Connection established messages are logged at level |
… | |
… | |
410 | 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. |
411 | .Sp |
503 | .Sp |
412 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
504 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
413 | .Sp |
505 | .Sp |
414 | This value must be the minimum of the \s-1MTU\s0 values of all nodes. |
506 | This value must be the minimum of the \s-1MTU\s0 values of all nodes. |
415 | .IP "node = nickname" 4 |
507 | .IP "nfmark = integer" 4 |
416 | .IX Item "node = nickname" |
508 | .IX Item "nfmark = integer" |
417 | 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 |
418 | 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 |
419 | 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 |
420 | .IP "node-up = relative-or-absolute-path" 4 |
522 | .IP "node-up = relative-or-absolute-path" 4 |
421 | .IX Item "node-up = relative-or-absolute-path" |
523 | .IX Item "node-up = relative-or-absolute-path" |
422 | 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 |
423 | is established (even on rekeying operations). Note that node\-up/down |
525 | is established (even on rekeying operations). Note that node\-up/down |
424 | scripts will be run asynchronously, but execution is serialised, so there |
526 | scripts will be run asynchronously, but execution is serialised, so there |
… | |
… | |
457 | .Vb 6 |
559 | .Vb 6 |
458 | \& #!/bin/sh |
560 | \& #!/bin/sh |
459 | \& { |
561 | \& { |
460 | \& echo update delete $DESTNODE.lowttl.example.net. a |
562 | \& echo update delete $DESTNODE.lowttl.example.net. a |
461 | \& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP |
563 | \& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP |
462 | \& echo |
564 | \& echo |
463 | \& } | nsupdate \-d \-k $CONFBASE:key.example.net. |
565 | \& } | nsupdate \-d \-k $CONFBASE:key.example.net. |
464 | .Ve |
566 | .Ve |
465 | .RE |
567 | .RE |
466 | .IP "node-change = relative-or-absolute-path" 4 |
568 | .IP "node-change = relative-or-absolute-path" 4 |
467 | .IX Item "node-change = relative-or-absolute-path" |
569 | .IX Item "node-change = relative-or-absolute-path" |
… | |
… | |
471 | .IX Item "node-down = relative-or-absolute-path" |
573 | .IX Item "node-down = relative-or-absolute-path" |
472 | 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. |
473 | .IP "pid-file = path" 4 |
575 | .IP "pid-file = path" 4 |
474 | .IX Item "pid-file = path" |
576 | .IX Item "pid-file = path" |
475 | The path to the pid file to check and create |
577 | The path to the pid file to check and create |
476 | (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. |
477 | .IP "private-key = relative-path-to-key" 4 |
580 | .IP "private-key = relative-path-to-key" 4 |
478 | .IX Item "private-key = relative-path-to-key" |
581 | .IX Item "private-key = relative-path-to-key" |
479 | 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 |
480 | (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 |
481 | 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 |
482 | 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 |
483 | \&\f(CW\*(C`gvpectrl\*(C'\fR puts them. |
586 | between nodes. |
484 | .Sp |
587 | .Sp |
485 | 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 |
486 | private key file should be kept secret per-node to avoid spoofing, it is |
589 | private key file should be kept secret per-node to avoid spoofing, it is |
487 | not recommended to use this feature. |
590 | not recommended to use this feature this way though. |
488 | .IP "rekey = seconds" 4 |
591 | .IP "rekey = seconds" 4 |
489 | .IX Item "rekey = seconds" |
592 | .IX Item "rekey = seconds" |
490 | 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 |
491 | reestablished every \f(CW\*(C`rekey\*(C'\fR seconds, making them use a new encryption |
594 | reestablished every \f(CW\*(C`rekey\*(C'\fR seconds, making them use a new encryption |
492 | key. |
595 | key. |
493 | .IP "nfmark = integer" 4 |
596 | .IP "seed-device = path" 4 |
494 | .IX Item "nfmark = integer" |
597 | .IX Item "seed-device = path" |
495 | This advanced option, when set to a nonzero value (default: \f(CW0\fR), tries |
598 | The random device used to initially and regularly seed the random |
496 | to set the netfilter mark (or fwmark) value on all sockets gvpe uses to |
599 | number generator (default: \fI/dev/urandom\fR). Randomness is of paramount |
497 | send packets. |
600 | importance to the security of the algorithms used in gvpe. |
498 | .Sp |
601 | .Sp |
499 | This can be used to make gvpe use a different set of routing rules. For |
602 | On program start and every seed-interval, gvpe will read 64 octets. |
500 | example, on GNU/Linux, the \f(CW\*(C`if\-up\*(C'\fR could set \f(CW\*(C`nfmark\*(C'\fR to 1000 and then |
|
|
501 | put all routing rules into table \f(CW99\fR and then use an ip rule to make |
|
|
502 | gvpe traffic avoid that routing table, in effect routing normal traffic |
|
|
503 | via gvpe and gvpe traffic via the normal system routing tables: |
|
|
504 | .Sp |
603 | .Sp |
505 | .Vb 1 |
604 | Setting this path to the empty string will disable this functionality |
506 | \& ip rule add not fwmark 1000 lookup 99 |
605 | completely (the underlying crypto library will likely look for entropy |
507 | .Ve |
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 connection 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. |
508 | .SS "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
628 | .SS "\s-1NODE SPECIFIC SETTINGS\s0" |
509 | .IX Subsection "NODE SPECIFIC SETTINGS" |
629 | .IX Subsection "NODE SPECIFIC SETTINGS" |
510 | 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 |
511 | different settings, even within the same gvpe instance. Settings that are |
631 | different settings, even within the same gvpe instance. Settings that are |
512 | 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 |
513 | set within a node section only apply to the given node. |
633 | set within a node section only apply to the given node. |
… | |
… | |
599 | .Sp |
719 | .Sp |
600 | Enable the \s-1ICMP\s0 transport using \s-1ICMP\s0 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 |
601 | node. |
721 | node. |
602 | .IP "enable-rawip = yes|true|on | no|false|off" 4 |
722 | .IP "enable-rawip = yes|true|on | no|false|off" 4 |
603 | .IX Item "enable-rawip = yes|true|on | no|false|off" |
723 | .IX Item "enable-rawip = yes|true|on | no|false|off" |
604 | 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. |
605 | .Sp |
725 | .Sp |
606 | 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 |
607 | (default: \f(CW\*(C`no\*(C'\fR). |
727 | (default: \f(CW\*(C`no\*(C'\fR). |
608 | .IP "enable-tcp = yes|true|on | no|false|off" 4 |
728 | .IP "enable-tcp = yes|true|on | no|false|off" 4 |
609 | .IX Item "enable-tcp = yes|true|on | no|false|off" |
729 | .IX Item "enable-tcp = yes|true|on | no|false|off" |
… | |
… | |
614 | 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. |
615 | .IP "enable-udp = yes|true|on | no|false|off" 4 |
735 | .IP "enable-udp = yes|true|on | no|false|off" 4 |
616 | .IX Item "enable-udp = yes|true|on | no|false|off" |
736 | .IX Item "enable-udp = yes|true|on | no|false|off" |
617 | 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. |
618 | .Sp |
738 | .Sp |
619 | 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). |
620 | unless no other protocol is enabled for a node, in which case this |
|
|
621 | protocol is enabled automatically). |
|
|
622 | .Sp |
|
|
623 | \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want to use it even though |
|
|
624 | it might get switched on automatically, as some future version might |
|
|
625 | default to another default protocol. |
|
|
626 | .IP "hostname = hostname | ip [can not be defaulted]" 4 |
740 | .IP "hostname = hostname | ip [can not be defaulted]" 4 |
627 | .IX Item "hostname = hostname | ip [can not be defaulted]" |
741 | .IX Item "hostname = hostname | ip [can not be defaulted]" |
628 | Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0 |
742 | Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0 |
629 | 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 |
630 | 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, |
631 | 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, |
632 | the connection attempt will fail. |
746 | the connection attempt will fail. |
… | |
… | |
649 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
763 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
650 | Whether 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 |
651 | 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 |
652 | 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 |
653 | 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. |
654 | .IP "max-retry = positive-number" 4 |
777 | .IP "max-retry = positive-number" 4 |
655 | .IX Item "max-retry = positive-number" |
778 | .IX Item "max-retry = positive-number" |
656 | 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 |
657 | 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 |
658 | be established, gvpe uses exponential back-off capped at this value. It's |
781 | be established, gvpe uses exponential back-off capped at this value. It's |
… | |
… | |
717 | .IP "node-up, node-down" 4 |
840 | .IP "node-up, node-down" 4 |
718 | .IX Item "node-up, node-down" |
841 | .IX Item "node-up, node-down" |
719 | If used the node up or node-down scripts. |
842 | If used the node up or node-down scripts. |
720 | .IP "hostkey" 4 |
843 | .IP "hostkey" 4 |
721 | .IX Item "hostkey" |
844 | .IX Item "hostkey" |
722 | 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. |
723 | .IP "pubkey/nodename" 4 |
846 | .IP "pubkey/nodename" 4 |
724 | .IX Item "pubkey/nodename" |
847 | .IX Item "pubkey/nodename" |
725 | The public keys of the other nodes, one file per node. |
848 | The public keys of the other nodes, one file per node. |
726 | .SH "SEE ALSO" |
849 | .SH "SEE ALSO" |
727 | .IX Header "SEE ALSO" |
850 | .IX Header "SEE ALSO" |