… | |
… | |
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 | |
… | |
… | |
314 | is established (even on rekeying operations). Note that node-up/down |
384 | is established (even on rekeying operations). Note that node-up/down |
315 | scripts will be run asynchronously, but execution is serialised, so there |
385 | scripts will be run asynchronously, but execution is serialised, so there |
316 | will only ever be one such script running. |
386 | will only ever be one such script running. |
317 | |
387 | |
318 | In addition to all the variables passed to C<if-up> scripts, the following |
388 | In addition to all the variables passed to C<if-up> scripts, the following |
319 | environment variables will be set: |
389 | environment variables will be set (values are just examples): |
320 | |
390 | |
321 | =over 4 |
391 | =over 4 |
322 | |
392 | |
323 | =item DESTNODE=branch2 |
393 | =item DESTNODE=branch2 |
324 | |
394 | |
325 | The name of the remote node. |
395 | The name of the remote node. |
326 | |
396 | |
327 | =item DESTID=2 |
397 | =item DESTID=2 |
328 | |
398 | |
329 | The node id of the remote node. |
399 | The node id of the remote node. |
|
|
400 | |
|
|
401 | =item DESTSI=rawip/88.99.77.55:0 |
|
|
402 | |
|
|
403 | The "socket info" of the target node, protocol dependent but usually in |
|
|
404 | the format protocol/ip:port. |
330 | |
405 | |
331 | =item DESTIP=188.13.66.8 |
406 | =item DESTIP=188.13.66.8 |
332 | |
407 | |
333 | The numerical IP address of the remote node (gvpe accepts connections from |
408 | The numerical IP address of the remote node (gvpe accepts connections from |
334 | everywhere, as long as the other node can authenticate itself). |
409 | everywhere, as long as the other node can authenticate itself). |
335 | |
410 | |
336 | =item DESTPORT=655 # deprecated |
411 | =item DESTPORT=655 # deprecated |
337 | |
412 | |
338 | The UDP port used by the other side. |
413 | The protocol port used by the other side, if applicable. |
339 | |
414 | |
340 | =item STATE=UP |
415 | =item STATE=up |
341 | |
416 | |
342 | Node-up scripts get called with STATE=UP, node-down scripts get called |
417 | Node-up scripts get called with STATE=up, node-change scripts get called |
343 | with STATE=DOWN. |
418 | with STATE=change and node-down scripts get called with STATE=down. |
344 | |
419 | |
345 | =back |
420 | =back |
346 | |
421 | |
347 | Here is a nontrivial example that uses nsupdate to update the name => ip |
422 | Here is a nontrivial example that uses nsupdate to update the name => ip |
348 | mapping in some DNS zone: |
423 | mapping in some DNS zone: |
349 | |
424 | |
350 | #!/bin/sh |
425 | #!/bin/sh |
351 | { |
426 | { |
352 | echo update delete $DESTNODE.lowttl.example.net. a |
427 | echo update delete $DESTNODE.lowttl.example.net. a |
353 | echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP |
428 | echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP |
354 | echo |
429 | echo |
355 | } | nsupdate -d -k $CONFBASE:key.example.net. |
430 | } | nsupdate -d -k $CONFBASE:key.example.net. |
|
|
431 | |
|
|
432 | =item node-change = relative-or-absolute-path |
|
|
433 | |
|
|
434 | Same as C<node-change>, but gets called whenever something about a |
|
|
435 | connection changes (such as the source IP address). |
356 | |
436 | |
357 | =item node-down = relative-or-absolute-path |
437 | =item node-down = relative-or-absolute-path |
358 | |
438 | |
359 | Same as C<node-up>, but gets called whenever a connection is lost. |
439 | Same as C<node-up>, but gets called whenever a connection is lost. |
360 | |
440 | |
… | |
… | |
379 | |
459 | |
380 | Sets the rekeying interval in seconds (default: C<3600>). Connections are |
460 | Sets the rekeying interval in seconds (default: C<3600>). Connections are |
381 | reestablished every C<rekey> seconds, making them use a new encryption |
461 | reestablished every C<rekey> seconds, making them use a new encryption |
382 | key. |
462 | key. |
383 | |
463 | |
|
|
464 | =item nfmark = integer |
|
|
465 | |
|
|
466 | This advanced option, when set to a nonzero value (default: C<0>), tries |
|
|
467 | to set the netfilter mark (or fwmark) value on all sockets gvpe uses to |
|
|
468 | send packets. |
|
|
469 | |
|
|
470 | This can be used to make gvpe use a different set of routing rules. For |
|
|
471 | example, on GNU/Linux, the C<if-up> could set C<nfmark> to 1000 and then |
|
|
472 | put all routing rules into table C<99> and then use an ip rule to make |
|
|
473 | gvpe traffic avoid that routing table, in effect routing normal traffic |
|
|
474 | via gvpe and gvpe traffic via the normal system routing tables: |
|
|
475 | |
|
|
476 | ip rule add not fwmark 1000 lookup 99 |
|
|
477 | |
384 | =back |
478 | =back |
385 | |
479 | |
386 | =head2 NODE SPECIFIC SETTINGS |
480 | =head2 NODE SPECIFIC SETTINGS |
387 | |
481 | |
388 | The following settings are node-specific, that is, every node can have |
482 | The following settings are node-specific, that is, every node can have |
… | |
… | |
396 | |
490 | |
397 | Allow direct connections to this node. See C<deny-direct> for more info. |
491 | Allow direct connections to this node. See C<deny-direct> for more info. |
398 | |
492 | |
399 | =item compress = yes|true|on | no|false|off |
493 | =item compress = yes|true|on | no|false|off |
400 | |
494 | |
|
|
495 | For the current node, this specified whether it will accept compressed |
|
|
496 | 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>). |
497 | 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 |
498 | 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. |
499 | only be used when the other side supports compression, so enabling this is |
|
|
500 | often a good idea. |
404 | |
501 | |
405 | =item connect = ondemand | never | always | disabled |
502 | =item connect = ondemand | never | always | disabled |
406 | |
503 | |
407 | Sets the connect mode (default: C<always>). It can be C<always> (always |
504 | 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> |
505 | try to establish and keep a connection to the given node), C<never> |
… | |
… | |
499 | |
596 | |
500 | =item enable-udp = yes|true|on | no|false|off |
597 | =item enable-udp = yes|true|on | no|false|off |
501 | |
598 | |
502 | See gvpe.protocol(7) for a description of the UDP transport protocol. |
599 | See gvpe.protocol(7) for a description of the UDP transport protocol. |
503 | |
600 | |
504 | Enable the UDPv4 transport using the C<udp-port> port (default: C<no>, |
601 | 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 | |
602 | |
512 | =item hostname = hostname | ip [can not be defaulted] |
603 | =item hostname = hostname | ip [can not be defaulted] |
513 | |
604 | |
514 | Forces the address of this node to be set to the given DNS hostname or IP |
605 | 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 |
606 | 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> |
625 | The value specified using this directive will be passed to the C<if-up> |
535 | script in the environment variable C<IFUPDATA>. |
626 | script in the environment variable C<IFUPDATA>. |
536 | |
627 | |
537 | =item inherit-tos = yes|true|on | no|false|off |
628 | =item inherit-tos = yes|true|on | no|false|off |
538 | |
629 | |
539 | Wether to inherit the TOS settings of packets sent to the tunnel when |
630 | 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 |
631 | 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 |
632 | outgoing tunnel packets will have the same TOS setting as the packets sent |
542 | to the tunnel device, which is usually what you want. |
633 | to the tunnel device, which is usually what you want. |
543 | |
634 | |
544 | =item max-retry = positive-number |
635 | =item max-retry = positive-number |