… | |
… | |
43 | listen on), followed by node-specific sections that begin with a C<node = |
43 | listen on), followed by node-specific sections that begin with a C<node = |
44 | nickname> line. |
44 | nickname> line. |
45 | |
45 | |
46 | Every node that is part of the network must have a section that starts |
46 | Every node that is part of the network must have a section that starts |
47 | with C<node = nickname>. The number and order of the nodes is important |
47 | with C<node = nickname>. The number and order of the nodes is important |
48 | and must be the same on all hosts. It is not uncommon for node sections to |
48 | and must be the same on all nodes. It is not uncommon for node sections to |
49 | be completely empty - if the default values are right. |
49 | be completely empty - if the default values are right. |
50 | |
50 | |
51 | Node-specific settings can be used at any time. If used before the first |
51 | Node-specific settings can be used at any time. If used before the first |
52 | node section they will set the default values for all following nodes. |
52 | node section they will set the default values for all following nodes. |
53 | |
53 | |
… | |
… | |
152 | select the correct syntax to use for network-related commands. |
152 | select the correct syntax to use for network-related commands. |
153 | |
153 | |
154 | =item MTU=1436 |
154 | =item MTU=1436 |
155 | |
155 | |
156 | The MTU to set the interface to. You can use lower values (if done |
156 | The MTU to set the interface to. You can use lower values (if done |
157 | consistently on all hosts), but this is usually ineffective. |
157 | consistently on all nodes), but this is usually either inefficient or |
|
|
158 | simply ineffective. |
158 | |
159 | |
159 | =item NODES=5 |
160 | =item NODES=5 |
160 | |
161 | |
161 | The number of nodes in this GVPE network. |
162 | The number of nodes in this GVPE network. |
162 | |
163 | |
… | |
… | |
221 | device. |
222 | device. |
222 | |
223 | |
223 | =item ip-proto = numerical-ip-protocol |
224 | =item ip-proto = numerical-ip-protocol |
224 | |
225 | |
225 | Sets the protocol number to be used for the rawip protocol. This is a |
226 | Sets the protocol number to be used for the rawip protocol. This is a |
226 | global option because all hosts must use the same protocol, and since |
227 | global option because all nodes must use the same protocol, and since |
227 | there are no port numbers, you cannot easily run more than one gvpe |
228 | there are no port numbers, you cannot easily run more than one gvpe |
228 | instance using the same protocol, nor can you share the protocol with |
229 | instance using the same protocol, nor can you share the protocol with |
229 | other programs. |
230 | other programs. |
230 | |
231 | |
231 | The default is 47 (GRE), which has a good chance of tunneling through |
232 | The default is 47 (GRE), which has a good chance of tunneling through |
… | |
… | |
246 | Please note that gvpe will still try to resolve all hostnames in the |
247 | Please note that gvpe will still try to resolve all hostnames in the |
247 | configuration file, so if you are behind a proxy without access to a dns |
248 | configuration file, so if you are behind a proxy without access to a dns |
248 | server better use numerical IP addresses. |
249 | server better use numerical IP addresses. |
249 | |
250 | |
250 | To make best use of this option disable all protocols except tcp in your |
251 | To make best use of this option disable all protocols except tcp in your |
251 | config file and make sure your routers (or all other hosts) are listening |
252 | config file and make sure your routers (or all other nodes) are listening |
252 | on a port that the proxy allows (443, https, is a common choice). |
253 | on a port that the proxy allows (443, https, is a common choice). |
253 | |
254 | |
254 | If you have a router, connecting to it will suffice. Otherwise tcp must be |
255 | If you have a router, connecting to it will suffice. Otherwise tcp must be |
255 | enabled on all hosts. |
256 | enabled on all nodes. |
256 | |
257 | |
257 | Example: |
258 | Example: |
258 | |
259 | |
259 | http-proxy-host = proxy.example.com |
260 | http-proxy-host = proxy.example.com |
260 | http-proxy-port = 3128 # 8080 is another common choice |
261 | http-proxy-port = 3128 # 8080 is another common choice |
… | |
… | |
290 | maximum overhead (e.g. udp header size, encryption blocksize...) and pass |
291 | maximum overhead (e.g. udp header size, encryption blocksize...) and pass |
291 | this information to the C<if-up> script. |
292 | this information to the C<if-up> script. |
292 | |
293 | |
293 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
294 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
294 | |
295 | |
295 | This value must be the minimum of the mtu values of all hosts. |
296 | This value must be the minimum of the mtu values of all nodes. |
296 | |
297 | |
297 | =item node = nickname |
298 | =item node = nickname |
298 | |
299 | |
299 | Not really a config setting but introduces a node section. The nickname is |
300 | Not really a config setting but introduces a node section. The nickname is |
300 | used to select the right configuration section and must be passed as an |
301 | used to select the right configuration section and must be passed as an |
… | |
… | |
320 | |
321 | |
321 | The node id of the remote node. |
322 | The node id of the remote node. |
322 | |
323 | |
323 | =item DESTIP=188.13.66.8 |
324 | =item DESTIP=188.13.66.8 |
324 | |
325 | |
325 | The numerical IP address of the remote host (gvpe accepts connections from |
326 | The numerical IP address of the remote node (gvpe accepts connections from |
326 | everywhere, as long as the other host can authenticate itself). |
327 | everywhere, as long as the other node can authenticate itself). |
327 | |
328 | |
328 | =item DESTPORT=655 # deprecated |
329 | =item DESTPORT=655 # deprecated |
329 | |
330 | |
330 | The UDP port used by the other side. |
331 | The UDP port used by the other side. |
331 | |
332 | |
… | |
… | |
362 | be doubled. A single C<%s> is replaced by the hostname, so you could |
363 | be doubled. A single C<%s> is replaced by the hostname, so you could |
363 | use paths like C<hostkeys/%s> to fetch the files at the location where |
364 | use paths like C<hostkeys/%s> to fetch the files at the location where |
364 | C<gvpectrl> puts them. |
365 | C<gvpectrl> puts them. |
365 | |
366 | |
366 | Since only the private key file of the current node is used and the |
367 | Since only the private key file of the current node is used and the |
367 | private key file should be kept secret per-host to avoid spoofings, it is |
368 | private key file should be kept secret per-node to avoid spoofings, it is |
368 | not recommended to use this feature. |
369 | not recommended to use this feature. |
369 | |
370 | |
370 | =item rekey = seconds |
371 | =item rekey = seconds |
371 | |
372 | |
372 | Sets the rekeying interval in seconds (default: C<3600>). Connections are |
373 | Sets the rekeying interval in seconds (default: C<3600>). Connections are |
… | |
… | |
387 | |
388 | |
388 | Allow direct connections to this node. See C<deny-direct> for more info. |
389 | Allow direct connections to this node. See C<deny-direct> for more info. |
389 | |
390 | |
390 | =item compress = yes|true|on | no|false|off |
391 | =item compress = yes|true|on | no|false|off |
391 | |
392 | |
392 | Wether to compress data packets sent to this host (default: C<yes>). |
393 | Wether to compress data packets sent to this node (default: C<yes>). |
393 | Compression is really cheap even on slow computers and has no size |
394 | Compression is really cheap even on slow computers and has no size |
394 | overhead at all, so enabling this is a good idea. |
395 | overhead at all, so enabling this is a good idea. |
395 | |
396 | |
396 | =item connect = ondemand | never | always | disabled |
397 | =item connect = ondemand | never | always | disabled |
397 | |
398 | |
398 | Sets the connect mode (default: C<always>). It can be C<always> (always |
399 | Sets the connect mode (default: C<always>). It can be C<always> (always |
399 | try to establish and keep a connection to the given host), C<never> |
400 | try to establish and keep a connection to the given node), C<never> |
400 | (never initiate a connection to the given host, but accept connections), |
401 | (never initiate a connection to the given host, but accept connections), |
401 | C<ondemand> (try to establish a connection when there are outstanding |
402 | C<ondemand> (try to establish a connection when there are outstanding |
402 | packets in the queue and take it down after the keepalive interval) or |
403 | packets in the queue and take it down after the keepalive interval) or |
403 | C<disabled> (node is bad, don't talk to it). |
404 | C<disabled> (node is bad, don't talk to it). |
|
|
405 | |
|
|
406 | Routers will automatically be forced to C<always> unless they are |
|
|
407 | C<disabled>, to ensure all nodes can talk to each other. |
404 | |
408 | |
405 | =item deny-direct = nodename | * |
409 | =item deny-direct = nodename | * |
406 | |
410 | |
407 | Deny direct connections to the specified node (or all nodes when C<*> |
411 | Deny direct connections to the specified node (or all nodes when C<*> |
408 | is given). Only one node can be specified, but you can use multiple |
412 | is given). Only one node can be specified, but you can use multiple |
… | |
… | |
541 | (default: C<60>). Gvpe will normally queue packets for a node without an |
545 | (default: C<60>). Gvpe will normally queue packets for a node without an |
542 | active connection, in the hope of establishing a connection soon. This |
546 | active connection, in the hope of establishing a connection soon. This |
543 | value specifies the maximum lifetime a packet will stay in the queue, if a |
547 | value specifies the maximum lifetime a packet will stay in the queue, if a |
544 | packet gets older, it will be thrown away. |
548 | packet gets older, it will be thrown away. |
545 | |
549 | |
546 | =item max-queue = positive-number |
550 | =item max-queue = positive-number>=1 |
547 | |
551 | |
548 | The maximum number of packets that will be queued (default: C<512>) |
552 | The maximum number of packets that will be queued (default: C<512>) |
549 | for this node. If more packets are sent then earlier packets will be |
553 | for this node. If more packets are sent then earlier packets will be |
550 | expired. See C<max-ttl>, above. |
554 | expired. See C<max-ttl>, above. |
551 | |
555 | |
552 | =item router-priority = 0 | 1 | positive-number>=2 |
556 | =item router-priority = 0 | 1 | positive-number>=2 |
553 | |
557 | |
554 | Sets the router priority of the given host (default: C<0>, disabled). If |
558 | Sets the router priority of the given node (default: C<0>, disabled). |
555 | some host tries to connect to another host without a hostname, it asks |
|
|
556 | the router host for it's IP address. The router host is the one with the |
|
|
557 | highest priority larger than C<1> that is currently reachable. |
|
|
558 | |
559 | |
559 | Make sure all hosts always connect (C<connect = always>) to the router |
560 | If some node tries to connect to another node but it doesn't have a |
560 | hosts, otherwise connecting to them might be impossible. |
561 | hostname, it asks a router node for it's IP address. The router node |
|
|
562 | chosen is the one with the highest priority larger than C<1> that is |
|
|
563 | currently reachable. This is called a I<mediated> connection, as the |
|
|
564 | connection itself will still be direct, but it uses another node to |
|
|
565 | mediate between the two nodes. |
|
|
566 | |
|
|
567 | The value C<0> disables routing, that means if the node receives a packet |
|
|
568 | not for itself it will not forward it but instead drop it. |
561 | |
569 | |
562 | The special value C<1> allows other hosts to route through the router |
570 | The special value C<1> allows other hosts to route through the router |
563 | host, but they will never route through it by default. The value C<0> |
571 | host, but they will never route through it by default (i.e. the config |
564 | disables routing. The idea behind this is that some hosts can, if |
572 | file of another node needs to specify a router priority higher than one |
|
|
573 | to choose such a node for routing). |
|
|
574 | |
|
|
575 | The idea behind this is that some hosts can, if required, bump the |
565 | required, bump the C<router-priority> setting to higher than C<1> in their |
576 | C<router-priority> setting to higher than C<1> in their local config to |
566 | local config to route through specific hosts. If C<router-priority> is |
577 | route through specific hosts. If C<router-priority> is C<0>, then routing |
567 | C<0>, then routing will be refused, so C<1> serves as a "enable, but do |
578 | will be refused, so C<1> serves as a "enable, but do not use by default" |
568 | not use by default" switch. |
579 | switch. |
|
|
580 | |
|
|
581 | Nodes with C<router-priority> set to C<2> or higher will always be forced |
|
|
582 | to C<connect> = C<always> (unless they are C<disabled>). |
569 | |
583 | |
570 | =item tcp-port = port-number |
584 | =item tcp-port = port-number |
571 | |
585 | |
572 | Similar to C<udp-port> (default: C<655>), but sets the TCP port number. |
586 | Similar to C<udp-port> (default: C<655>), but sets the TCP port number. |
573 | |
587 | |