… | |
… | |
28 | = value> pairs. Empty lines are ignored. Comments start with a C<#> and |
28 | = value> pairs. Empty lines are ignored. Comments start with a C<#> and |
29 | extend to the end of the line. They can be used on their own lines, or |
29 | extend to the end of the line. They can be used on their own lines, or |
30 | after any directives. Whitespace is allowed around the C<=> sign or after |
30 | after any directives. Whitespace is allowed around the C<=> sign or after |
31 | values, but not within the variable names or values themselves. |
31 | values, but not within the variable names or values themselves. |
32 | |
32 | |
33 | The only exception to the above is the "on" directive that can prefix any |
33 | All settings are applied "in order", that is, later settings of the same |
34 | C<name = value> setting and will only "execute" it on the named node, or |
34 | variable overwrite earlier ones. |
35 | (if the nodename starts with "!") on all nodes except the named one. |
|
|
36 | |
35 | |
|
|
36 | The only exceptions to the above are the "on" and "include" directives: |
|
|
37 | |
|
|
38 | =over 4 |
|
|
39 | |
|
|
40 | =item on nodename ... |
|
|
41 | |
|
|
42 | =item on !nodename ... |
|
|
43 | |
|
|
44 | You can prefix any configuration directive with C<on> and a nodename. GVPE |
|
|
45 | will will only "execute" it on the named node, or (if the nodename starts |
|
|
46 | with C<!>) on all nodes except the named one. |
|
|
47 | |
37 | For example, set the MTU to C<1450> everywhere, loglevel to C<noise> on |
48 | Example: set the MTU to C<1450> everywhere, C<loglevel> to C<noise> on |
38 | branch1, and connect to C<ondemand> everywhere but on branch2: |
49 | C<branch1>, and C<connect> to C<ondemand> everywhere but on branch2. |
39 | |
50 | |
40 | mtu = 1450 |
51 | mtu = 1450 |
41 | on branch1 loglevel = noise |
52 | on branch1 loglevel = noise |
42 | on !branch2 connect = ondemand |
53 | on !branch2 connect = ondemand |
43 | |
54 | |
44 | All settings are applied "in order", that is, later settings of the same |
55 | =item include relative-or-absolute-path |
45 | variable overwrite earlier ones. |
56 | |
|
|
57 | Reads the specified file (the path must not contain whitespace or C<=> |
|
|
58 | characters) and evaluate all config directives in it as if they were |
|
|
59 | spelled out in place of the C<include> directive. |
|
|
60 | |
|
|
61 | The path is a printf format string, that is, you must escape any C<%> |
|
|
62 | by doubling it, and you can have a single C<%s> inside, which will be |
|
|
63 | replaced by the current nodename. |
|
|
64 | |
|
|
65 | Relative paths are interpreted relative to the GVPE config directory. |
|
|
66 | |
|
|
67 | Example: include the file F<local.conf> in the config directory on every |
|
|
68 | node. |
|
|
69 | |
|
|
70 | include local.conf |
|
|
71 | |
|
|
72 | Example: include a file F<conf/>nodenameF<.conf> |
|
|
73 | |
|
|
74 | include conf/%s.conf |
|
|
75 | |
|
|
76 | =back |
46 | |
77 | |
47 | =head1 ANATOMY OF A CONFIG FILE |
78 | =head1 ANATOMY OF A CONFIG FILE |
48 | |
79 | |
49 | Usually, a config file starts with a few global settings (like the UDP |
80 | Usually, a config file starts with a few global settings (like the UDP |
50 | port to listen on), followed by node-specific sections that begin with a |
81 | port to listen on), followed by node-specific sections that begin with a |
… | |
… | |
67 | values on different nodes using C<on>), but will affect the behaviour of |
98 | values on different nodes using C<on>), but will affect the behaviour of |
68 | the gvpe daemon and all connections it creates. |
99 | the gvpe daemon and all connections it creates. |
69 | |
100 | |
70 | =over 4 |
101 | =over 4 |
71 | |
102 | |
|
|
103 | =item chroot = path or / |
|
|
104 | |
|
|
105 | Tells GVPE to chroot(2) to the specified path after reading all necessary |
|
|
106 | files, binding to sockets and running the C<if-up> script, but before |
|
|
107 | running C<node-up> or any other scripts. |
|
|
108 | |
|
|
109 | The special path F</> instructs GVPE to create (and remove) an empty |
|
|
110 | temporary directory to use as new root. This is most secure, but makes it |
|
|
111 | impossible to use any scripts other than the C<if-up> one. |
|
|
112 | |
|
|
113 | =item chuid = numerical-uid |
|
|
114 | |
|
|
115 | =item chgid = numerical-gid |
|
|
116 | |
|
|
117 | These two options tell GVPE to change to the given user and/or group id |
|
|
118 | after reading all necessary files, binding to sockets and running the |
|
|
119 | C<if-up> script. |
|
|
120 | |
|
|
121 | Other scripts, such as C<node-up>, are run with the new user id or group id. |
|
|
122 | |
|
|
123 | =item chuser = username |
|
|
124 | |
|
|
125 | Alternative to C<chuid> and C<chgid>: Sets both C<chuid> and C<chgid> |
|
|
126 | to the user and (primary) group ids of the specified user (for example, |
|
|
127 | C<nobody>). |
|
|
128 | |
72 | =item dns-forw-host = hostname/ip |
129 | =item dns-forw-host = hostname/ip |
73 | |
130 | |
74 | The DNS server to forward DNS requests to for the DNS tunnel protocol |
131 | The DNS server to forward DNS requests to for the DNS tunnel protocol |
75 | (default: C<127.0.0.1>, changing it is highly recommended). |
132 | (default: C<127.0.0.1>, changing it is highly recommended). |
76 | |
133 | |
77 | =item dns-forw-port = port-number |
134 | =item dns-forw-port = port-number |
78 | |
135 | |
79 | The port where the C<dns-forw-host> is to be contacted (default: C<53>, |
136 | The port where the C<dns-forw-host> is to be contacted (default: C<53>, |
80 | which is fine in most cases). |
137 | which is fine in most cases). |
|
|
138 | |
|
|
139 | =item dns-case-preserving = yes|true|on | no|false|off |
|
|
140 | |
|
|
141 | Sets whether the DNS transport forwarding server preserves case (DNS |
|
|
142 | servers have to, but some access systems are even more broken than others) |
|
|
143 | (default: true). |
|
|
144 | |
|
|
145 | Normally, when the forwarding server changes the case of domain names then |
|
|
146 | GVPE will automatically set this to false. |
81 | |
147 | |
82 | =item dns-max-outstanding = integer-number-of-requests |
148 | =item dns-max-outstanding = integer-number-of-requests |
83 | |
149 | |
84 | The maximum number of outstanding DNS transport requests |
150 | The maximum number of outstanding DNS transport requests |
85 | (default: C<100>). GVPE will never issue more requests then the given |
151 | (default: C<100>). GVPE will never issue more requests then the given |
… | |
… | |
237 | other programs. |
303 | other programs. |
238 | |
304 | |
239 | The default is 47 (GRE), which has a good chance of tunneling |
305 | The default is 47 (GRE), which has a good chance of tunneling |
240 | through firewalls (but note that gvpe's rawip protocol is not GRE |
306 | through firewalls (but note that gvpe's rawip protocol is not GRE |
241 | compatible). Other common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4 |
307 | compatible). Other common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4 |
242 | (IPIP tunnels) or 98 (ENCAP, rfc1241) |
308 | (IPIP tunnels) or 98 (ENCAP, rfc1241). |
|
|
309 | |
|
|
310 | Many versions of Linux seem to have a bug that causes them to reorder |
|
|
311 | packets for some ip protocols (GRE, ESP) but not for others (AH), so |
|
|
312 | choose wisely (that is, use 51, AH). |
243 | |
313 | |
244 | =item http-proxy-host = hostname/ip |
314 | =item http-proxy-host = hostname/ip |
245 | |
315 | |
246 | The C<http-proxy-*> family of options are only available if gvpe was |
316 | The C<http-proxy-*> family of options are only available if gvpe was |
247 | compiled with the C<--enable-http-proxy> option and enable tunneling of |
317 | compiled with the C<--enable-http-proxy> option and enable tunneling of |
… | |
… | |
280 | |
350 | |
281 | =item keepalive = seconds |
351 | =item keepalive = seconds |
282 | |
352 | |
283 | Sets the keepalive probe interval in seconds (default: C<60>). After this |
353 | Sets the keepalive probe interval in seconds (default: C<60>). After this |
284 | many seconds of inactivity the daemon will start to send keepalive probe |
354 | many seconds of inactivity the daemon will start to send keepalive probe |
285 | every 3 seconds until it receives a reply from the other end. If no reply |
355 | every 3 seconds until it receives a reply from the other end. If no reply |
286 | is received within 15 seconds, the peer is considered unreachable and the |
356 | is received within 15 seconds, the peer is considered unreachable and the |
287 | connection is closed. |
357 | connection is closed. |
288 | |
358 | |
289 | =item loglevel = noise|trace|debug|info|notice|warn|error|critical |
359 | =item loglevel = noise|trace|debug|info|notice|warn|error|critical |
290 | |
360 | |
… | |
… | |
300 | |
370 | |
301 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
371 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
302 | |
372 | |
303 | This value must be the minimum of the MTU values of all nodes. |
373 | This value must be the minimum of the MTU values of all nodes. |
304 | |
374 | |
|
|
375 | =item nfmark = integer |
|
|
376 | |
|
|
377 | This advanced option, when set to a nonzero value (default: C<0>), tries |
|
|
378 | to set the netfilter mark (or fwmark) value on all sockets gvpe uses to |
|
|
379 | send packets. |
|
|
380 | |
|
|
381 | This can be used to make gvpe use a different set of routing rules. For |
|
|
382 | example, on GNU/Linux, the C<if-up> could set C<nfmark> to 1000 and then |
|
|
383 | put all routing rules into table C<99> and then use an ip rule to make |
|
|
384 | gvpe traffic avoid that routing table, in effect routing normal traffic |
|
|
385 | via gvpe and gvpe traffic via the normal system routing tables: |
|
|
386 | |
|
|
387 | ip rule add not fwmark 1000 lookup 99 |
|
|
388 | |
305 | =item node = nickname |
389 | =item node = nickname |
306 | |
390 | |
307 | Not really a config setting but introduces a node section. The nickname is |
391 | Not really a config setting but introduces a node section. The nickname is |
308 | used to select the right configuration section and must be passed as an |
392 | used to select the right configuration section and must be passed as an |
309 | argument to the gvpe daemon. |
393 | argument to the gvpe daemon. |
… | |
… | |
314 | is established (even on rekeying operations). Note that node-up/down |
398 | is established (even on rekeying operations). Note that node-up/down |
315 | scripts will be run asynchronously, but execution is serialised, so there |
399 | scripts will be run asynchronously, but execution is serialised, so there |
316 | will only ever be one such script running. |
400 | will only ever be one such script running. |
317 | |
401 | |
318 | In addition to all the variables passed to C<if-up> scripts, the following |
402 | In addition to all the variables passed to C<if-up> scripts, the following |
319 | environment variables will be set: |
403 | environment variables will be set (values are just examples): |
320 | |
404 | |
321 | =over 4 |
405 | =over 4 |
322 | |
406 | |
323 | =item DESTNODE=branch2 |
407 | =item DESTNODE=branch2 |
324 | |
408 | |
325 | The name of the remote node. |
409 | The name of the remote node. |
326 | |
410 | |
327 | =item DESTID=2 |
411 | =item DESTID=2 |
328 | |
412 | |
329 | The node id of the remote node. |
413 | The node id of the remote node. |
|
|
414 | |
|
|
415 | =item DESTSI=rawip/88.99.77.55:0 |
|
|
416 | |
|
|
417 | The "socket info" of the target node, protocol dependent but usually in |
|
|
418 | the format protocol/ip:port. |
330 | |
419 | |
331 | =item DESTIP=188.13.66.8 |
420 | =item DESTIP=188.13.66.8 |
332 | |
421 | |
333 | The numerical IP address of the remote node (gvpe accepts connections from |
422 | The numerical IP address of the remote node (gvpe accepts connections from |
334 | everywhere, as long as the other node can authenticate itself). |
423 | everywhere, as long as the other node can authenticate itself). |
335 | |
424 | |
336 | =item DESTPORT=655 # deprecated |
425 | =item DESTPORT=655 # deprecated |
337 | |
426 | |
338 | The UDP port used by the other side. |
427 | The protocol port used by the other side, if applicable. |
339 | |
428 | |
340 | =item STATE=UP |
429 | =item STATE=up |
341 | |
430 | |
342 | Node-up scripts get called with STATE=UP, node-down scripts get called |
431 | Node-up scripts get called with STATE=up, node-change scripts get called |
343 | with STATE=DOWN. |
432 | with STATE=change and node-down scripts get called with STATE=down. |
344 | |
433 | |
345 | =back |
434 | =back |
346 | |
435 | |
347 | Here is a nontrivial example that uses nsupdate to update the name => ip |
436 | Here is a nontrivial example that uses nsupdate to update the name => ip |
348 | mapping in some DNS zone: |
437 | mapping in some DNS zone: |
349 | |
438 | |
350 | #!/bin/sh |
439 | #!/bin/sh |
351 | { |
440 | { |
352 | echo update delete $DESTNODE.lowttl.example.net. a |
441 | echo update delete $DESTNODE.lowttl.example.net. a |
353 | echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP |
442 | echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP |
354 | echo |
443 | echo |
355 | } | nsupdate -d -k $CONFBASE:key.example.net. |
444 | } | nsupdate -d -k $CONFBASE:key.example.net. |
356 | |
445 | |
|
|
446 | =item node-change = relative-or-absolute-path |
|
|
447 | |
|
|
448 | Same as C<node-change>, but gets called whenever something about a |
|
|
449 | connection changes (such as the source IP address). |
|
|
450 | |
357 | =item node-down = relative-or-absolute-path |
451 | =item node-down = relative-or-absolute-path |
358 | |
452 | |
359 | Same as C<node-up>, but gets called whenever a connection is lost. |
453 | Same as C<node-up>, but gets called whenever a connection is lost. |
360 | |
454 | |
361 | =item pid-file = path |
455 | =item pid-file = path |
362 | |
456 | |
363 | The path to the pid file to check and create |
457 | The path to the pid file to check and create |
364 | (default: C<LOCALSTATEDIR/run/gvpe.pid>). |
458 | (default: C<LOCALSTATEDIR/run/gvpe.pid>). The first C<%s> is replaced by |
|
|
459 | the nodename - any other use of C<%> must be written as C<%%>. |
365 | |
460 | |
366 | =item private-key = relative-path-to-key |
461 | =item private-key = relative-path-to-key |
367 | |
462 | |
368 | Sets the path (relative to the config directory) to the private key |
463 | Sets the path (relative to the config directory) to the private key |
369 | (default: C<hostkey>). This is a printf format string so every C<%> must |
464 | (default: C<hostkey>). This is a printf format string so every C<%> must |
… | |
… | |
375 | private key file should be kept secret per-node to avoid spoofing, it is |
470 | private key file should be kept secret per-node to avoid spoofing, it is |
376 | not recommended to use this feature. |
471 | not recommended to use this feature. |
377 | |
472 | |
378 | =item rekey = seconds |
473 | =item rekey = seconds |
379 | |
474 | |
380 | Sets the rekeying interval in seconds (default: C<3600>). Connections are |
475 | Sets the rekeying interval in seconds (default: C<3607>). Connections are |
381 | reestablished every C<rekey> seconds, making them use a new encryption |
476 | reestablished every C<rekey> seconds, making them use a new encryption |
382 | key. |
477 | key. |
|
|
478 | |
|
|
479 | =item seed-device = path |
|
|
480 | |
|
|
481 | The random device used to initially and regularly seed the random |
|
|
482 | number generator (default: F</dev/urandom>). Randomness is of paramount |
|
|
483 | importance to the security of the algorithms used in gvpe. |
|
|
484 | |
|
|
485 | On program start and every seed-interval, gvpe will read 64 octets. |
|
|
486 | |
|
|
487 | Setting this path to the empty string will disable this functionality |
|
|
488 | completely (the underlying crypto library will likely look for entropy |
|
|
489 | sources on it's own though, so not all is lost). |
|
|
490 | |
|
|
491 | =item seed-interval = seconds |
|
|
492 | |
|
|
493 | The number of seconds between reseeds of the random number generator |
|
|
494 | (default: C<3613>). A value of C<0> disables this regular reseeding. |
383 | |
495 | |
384 | =back |
496 | =back |
385 | |
497 | |
386 | =head2 NODE SPECIFIC SETTINGS |
498 | =head2 NODE SPECIFIC SETTINGS |
387 | |
499 | |
… | |
… | |
396 | |
508 | |
397 | Allow direct connections to this node. See C<deny-direct> for more info. |
509 | Allow direct connections to this node. See C<deny-direct> for more info. |
398 | |
510 | |
399 | =item compress = yes|true|on | no|false|off |
511 | =item compress = yes|true|on | no|false|off |
400 | |
512 | |
|
|
513 | For the current node, this specified whether it will accept compressed |
|
|
514 | packets, and for all other nodes, this specifies whether to try to |
401 | Wether to compress data packets sent to this node (default: C<yes>). |
515 | compress data packets sent to this node (default: C<yes>). Compression is |
402 | Compression is really cheap even on slow computers and has no size |
516 | really cheap even on slow computers, has no size overhead at all and will |
403 | overhead at all, so enabling this is often a good idea. |
517 | only be used when the other side supports compression, so enabling this is |
|
|
518 | often a good idea. |
404 | |
519 | |
405 | =item connect = ondemand | never | always | disabled |
520 | =item connect = ondemand | never | always | disabled |
406 | |
521 | |
407 | Sets the connect mode (default: C<always>). It can be C<always> (always |
522 | Sets the connect mode (default: C<always>). It can be C<always> (always |
408 | try to establish and keep a connection to the given node), C<never> |
523 | try to establish and keep a connection to the given node), C<never> |
… | |
… | |
499 | |
614 | |
500 | =item enable-udp = yes|true|on | no|false|off |
615 | =item enable-udp = yes|true|on | no|false|off |
501 | |
616 | |
502 | See gvpe.protocol(7) for a description of the UDP transport protocol. |
617 | See gvpe.protocol(7) for a description of the UDP transport protocol. |
503 | |
618 | |
504 | Enable the UDPv4 transport using the C<udp-port> port (default: C<no>, |
619 | Enable the UDPv4 transport using the C<udp-port> port (default: C<no>). |
505 | unless no other protocol is enabled for a node, in which case this |
|
|
506 | protocol is enabled automatically). |
|
|
507 | |
|
|
508 | NOTE: Please specify C<enable-udp = yes> if you want to use it even though |
|
|
509 | it might get switched on automatically, as some future version might |
|
|
510 | default to another default protocol. |
|
|
511 | |
620 | |
512 | =item hostname = hostname | ip [can not be defaulted] |
621 | =item hostname = hostname | ip [can not be defaulted] |
513 | |
622 | |
514 | Forces the address of this node to be set to the given DNS hostname or IP |
623 | Forces the address of this node to be set to the given DNS hostname or IP |
515 | address. It will be resolved before each connect request, so dyndns should |
624 | address. It will be resolved before each connect request, so dyndns should |
… | |
… | |
534 | The value specified using this directive will be passed to the C<if-up> |
643 | The value specified using this directive will be passed to the C<if-up> |
535 | script in the environment variable C<IFUPDATA>. |
644 | script in the environment variable C<IFUPDATA>. |
536 | |
645 | |
537 | =item inherit-tos = yes|true|on | no|false|off |
646 | =item inherit-tos = yes|true|on | no|false|off |
538 | |
647 | |
539 | Wether to inherit the TOS settings of packets sent to the tunnel when |
648 | Whether to inherit the TOS settings of packets sent to the tunnel when |
540 | sending packets to this node (default: C<yes>). If set to C<yes> then |
649 | sending packets to this node (default: C<yes>). If set to C<yes> then |
541 | outgoing tunnel packets will have the same TOS setting as the packets sent |
650 | outgoing tunnel packets will have the same TOS setting as the packets sent |
542 | to the tunnel device, which is usually what you want. |
651 | to the tunnel device, which is usually what you want. |
543 | |
652 | |
544 | =item max-retry = positive-number |
653 | =item max-retry = positive-number |
… | |
… | |
621 | |
730 | |
622 | If used the node up or node-down scripts. |
731 | If used the node up or node-down scripts. |
623 | |
732 | |
624 | =item hostkey |
733 | =item hostkey |
625 | |
734 | |
626 | The private key (taken from C<hostkeys/nodename>) of the current host. |
735 | The (default path of the) private key of the current host. |
627 | |
736 | |
628 | =item pubkey/nodename |
737 | =item pubkey/nodename |
629 | |
738 | |
630 | The public keys of the other nodes, one file per node. |
739 | The public keys of the other nodes, one file per node. |
631 | |
740 | |