| 1 |
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 |
| 2 |
.\" |
| 3 |
.\" Standard preamble: |
| 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) |
| 14 |
.if t .sp .5v |
| 15 |
.if n .sp |
| 16 |
.. |
| 17 |
.de Vb \" Begin verbatim text |
| 18 |
.ft CW |
| 19 |
.nf |
| 20 |
.ne \\$1 |
| 21 |
.. |
| 22 |
.de Ve \" End verbatim text |
| 23 |
.ft R |
| 24 |
.fi |
| 25 |
.. |
| 26 |
.\" Set up some character translations and predefined strings. \*(-- will |
| 27 |
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| 28 |
.\" double quote, and \*(R" will give a right double quote. \*(C+ will |
| 29 |
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and |
| 30 |
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
| 31 |
.\" nothing in troff, for use with C<>. |
| 32 |
.tr \(*W- |
| 33 |
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| 34 |
.ie n \{\ |
| 35 |
. ds -- \(*W- |
| 36 |
. ds PI pi |
| 37 |
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| 38 |
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| 39 |
. ds L" "" |
| 40 |
. ds R" "" |
| 41 |
. ds C` |
| 42 |
. ds C' |
| 43 |
'br\} |
| 44 |
.el\{\ |
| 45 |
. ds -- \|\(em\| |
| 46 |
. ds PI \(*p |
| 47 |
. ds L" `` |
| 48 |
. ds R" '' |
| 49 |
'br\} |
| 50 |
.\" |
| 51 |
.\" 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 |
| 53 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 54 |
.\" output yourself in some meaningful fashion. |
| 55 |
.if \nF \{\ |
| 56 |
. de IX |
| 57 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 58 |
.. |
| 59 |
. nr % 0 |
| 60 |
. rr F |
| 61 |
.\} |
| 62 |
.\" |
| 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 |
.\" |
| 68 |
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| 69 |
.\" Fear. Run. Save yourself. No user-serviceable parts. |
| 70 |
. \" fudge factors for nroff and troff |
| 71 |
.if n \{\ |
| 72 |
. ds #H 0 |
| 73 |
. ds #V .8m |
| 74 |
. ds #F .3m |
| 75 |
. ds #[ \f1 |
| 76 |
. ds #] \fP |
| 77 |
.\} |
| 78 |
.if t \{\ |
| 79 |
. ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| 80 |
. ds #V .6m |
| 81 |
. ds #F 0 |
| 82 |
. ds #[ \& |
| 83 |
. ds #] \& |
| 84 |
.\} |
| 85 |
. \" simple accents for nroff and troff |
| 86 |
.if n \{\ |
| 87 |
. ds ' \& |
| 88 |
. ds ` \& |
| 89 |
. ds ^ \& |
| 90 |
. ds , \& |
| 91 |
. ds ~ ~ |
| 92 |
. ds / |
| 93 |
.\} |
| 94 |
.if t \{\ |
| 95 |
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| 96 |
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| 97 |
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| 98 |
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| 99 |
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| 100 |
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| 101 |
.\} |
| 102 |
. \" troff and (daisy-wheel) nroff accents |
| 103 |
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| 104 |
.ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| 105 |
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| 106 |
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| 107 |
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| 108 |
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| 109 |
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| 110 |
.ds ae a\h'-(\w'a'u*4/10)'e |
| 111 |
.ds Ae A\h'-(\w'A'u*4/10)'E |
| 112 |
. \" corrections for vroff |
| 113 |
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| 114 |
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| 115 |
. \" for low resolution devices (crt and lpr) |
| 116 |
.if \n(.H>23 .if \n(.V>19 \ |
| 117 |
\{\ |
| 118 |
. ds : e |
| 119 |
. ds 8 ss |
| 120 |
. ds o a |
| 121 |
. ds d- d\h'-1'\(ga |
| 122 |
. ds D- D\h'-1'\(hy |
| 123 |
. ds th \o'bp' |
| 124 |
. ds Th \o'LP' |
| 125 |
. ds ae ae |
| 126 |
. ds Ae AE |
| 127 |
.\} |
| 128 |
.rm #[ #] #H #V #F C |
| 129 |
.\" ======================================================================== |
| 130 |
.\" |
| 131 |
.IX Title "GVPE.CONF 5" |
| 132 |
.TH GVPE.CONF 5 "2008-08-10" "2.2" "GNU Virtual Private Ethernet" |
| 133 |
.SH "NAME" |
| 134 |
gvpe.conf \- configuration file for the GNU VPE daemon |
| 135 |
.SH "SYNOPSIS" |
| 136 |
.IX Header "SYNOPSIS" |
| 137 |
.Vb 3 |
| 138 |
\& udp\-port = 407 |
| 139 |
\& mtu = 1492 |
| 140 |
\& ifname = vpn0 |
| 141 |
.Ve |
| 142 |
.PP |
| 143 |
.Vb 2 |
| 144 |
\& node = branch1 |
| 145 |
\& hostname = 1.2.3.4 |
| 146 |
.Ve |
| 147 |
.PP |
| 148 |
.Vb 3 |
| 149 |
\& node = branch2 |
| 150 |
\& hostname = www.example.net |
| 151 |
\& udp\-port = 500 # this host uses a different udp\-port |
| 152 |
.Ve |
| 153 |
.PP |
| 154 |
.Vb 2 |
| 155 |
\& node = branch3 |
| 156 |
\& connect = ondemand |
| 157 |
.Ve |
| 158 |
.SH "DESCRIPTION" |
| 159 |
.IX Header "DESCRIPTION" |
| 160 |
The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable |
| 161 |
= 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 |
| 163 |
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. |
| 165 |
.PP |
| 166 |
The only exception to the above is the \*(L"on\*(R" directive that can prefix any |
| 167 |
\&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or |
| 168 |
(if the nodename starts with \*(L"!\*(R") on all nodes except the named one. |
| 169 |
.PP |
| 170 |
.Vb 3 |
| 171 |
\& name = value |
| 172 |
\& on branch1 loglevel = noise |
| 173 |
\& on !branch2 connect = ondemand |
| 174 |
.Ve |
| 175 |
.PP |
| 176 |
All settings are executed \*(L"in order\*(R", that is, later settings of the same |
| 177 |
variable overwrite earlier ones. |
| 178 |
.SH "ANATOMY OF A CONFIG FILE" |
| 179 |
.IX Header "ANATOMY OF A CONFIG FILE" |
| 180 |
Usually, a config file starts with global settings (like the udp port to |
| 181 |
listen on), followed by node-specific sections that begin with a \f(CW\*(C`node = |
| 182 |
nickname\*(C'\fR line. |
| 183 |
.PP |
| 184 |
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 |
| 186 |
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. |
| 188 |
.PP |
| 189 |
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. |
| 191 |
.SH "CONFIG VARIABLES" |
| 192 |
.IX Header "CONFIG VARIABLES" |
| 193 |
.Sh "\s-1GLOBAL\s0 \s-1SETTINGS\s0" |
| 194 |
.IX Subsection "GLOBAL SETTINGS" |
| 195 |
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 |
| 197 |
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. |
| 199 |
.IP "dns-forw-host = hostname/ip" 4 |
| 200 |
.IX Item "dns-forw-host = hostname/ip" |
| 201 |
The dns server to forward dns requests to for the \s-1DNS\s0 tunnel protocol |
| 202 |
(default: \f(CW127.0.0.1\fR, changing it is highly recommended). |
| 203 |
.IP "dns-forw-port = port-number" 4 |
| 204 |
.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, |
| 206 |
which is fine in most cases). |
| 207 |
.IP "dns-max-outstanding = integer-number-of-requests" 4 |
| 208 |
.IX Item "dns-max-outstanding = integer-number-of-requests" |
| 209 |
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 |
| 211 |
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 |
| 213 |
number of parallel requests. |
| 214 |
.Sp |
| 215 |
The default should be working ok for most links. |
| 216 |
.IP "dns-overlap-factor = float" 4 |
| 217 |
.IX Item "dns-overlap-factor = float" |
| 218 |
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, |
| 220 |
must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending |
| 221 |
rate (= minimum send interval), i.e. a factor of \f(CW1\fR means that a new |
| 222 |
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 |
| 224 |
\&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum |
| 225 |
latency measured. |
| 226 |
.Sp |
| 227 |
For congested or picky dns forwarders you could use a value nearer to or |
| 228 |
exceeding \f(CW1\fR. |
| 229 |
.Sp |
| 230 |
The default should be working ok for most links. |
| 231 |
.IP "dns-send-interval = send-interval-in-seconds" 4 |
| 232 |
.IX Item "dns-send-interval = send-interval-in-seconds" |
| 233 |
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 |
| 235 |
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 |
| 237 |
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, |
| 239 |
\&\f(CW0.2\fR or even higher. |
| 240 |
.Sp |
| 241 |
The default should be working ok for most links. |
| 242 |
.IP "dns-timeout-factor = float" 4 |
| 243 |
.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 |
| 245 |
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 |
| 247 |
eight times the minimum (= expected) latency, assuming the request or |
| 248 |
reply has been lost. |
| 249 |
.Sp |
| 250 |
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 |
| 252 |
nicely. Values near or below \f(CW1\fR makes no sense whatsoever. |
| 253 |
.Sp |
| 254 |
The default should be working ok for most links but will result in low |
| 255 |
throughput if packet loss is high. |
| 256 |
.IP "if-up = relative-or-absolute-path" 4 |
| 257 |
.IX Item "if-up = relative-or-absolute-path" |
| 258 |
Sets the path of a script that should be called immediately after the |
| 259 |
network interface is initialized (but not neccessarily up). The following |
| 260 |
environment variables are passed to it (the values are just examples). |
| 261 |
.Sp |
| 262 |
Variables that have the same value on all nodes: |
| 263 |
.RS 4 |
| 264 |
.IP "CONFBASE=/etc/gvpe" 4 |
| 265 |
.IX Item "CONFBASE=/etc/gvpe" |
| 266 |
The configuration base directory. |
| 267 |
.IP "IFNAME=vpn0" 4 |
| 268 |
.IX Item "IFNAME=vpn0" |
| 269 |
The network interface to initialize. |
| 270 |
.IP "IFTYPE=native # or tincd" 4 |
| 271 |
.IX Item "IFTYPE=native # or tincd" |
| 272 |
.PD 0 |
| 273 |
.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 |
| 274 |
.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." |
| 275 |
.PD |
| 276 |
The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the |
| 277 |
\&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to |
| 278 |
select the correct syntax to use for network-related commands. |
| 279 |
.IP "MTU=1436" 4 |
| 280 |
.IX Item "MTU=1436" |
| 281 |
The \s-1MTU\s0 to set the interface to. You can use lower values (if done |
| 282 |
consistently on all nodes), but this is usually either inefficient or |
| 283 |
simply ineffective. |
| 284 |
.IP "NODES=5" 4 |
| 285 |
.IX Item "NODES=5" |
| 286 |
The number of nodes in this \s-1GVPE\s0 network. |
| 287 |
.RE |
| 288 |
.RS 4 |
| 289 |
.Sp |
| 290 |
Variables that are node-specific and with values pertaining to the node |
| 291 |
running this \s-1GVPE:\s0 |
| 292 |
.IP "IFUPDATA=string" 4 |
| 293 |
.IX Item "IFUPDATA=string" |
| 294 |
The value of the configuration directive \f(CW\*(C`if\-up\-data\*(C'\fR. |
| 295 |
.IP "MAC=fe:fd:80:00:00:01" 4 |
| 296 |
.IX Item "MAC=fe:fd:80:00:00:01" |
| 297 |
The \s-1MAC\s0 address the network interface has to use. |
| 298 |
.Sp |
| 299 |
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 |
| 301 |
platform-specific information. |
| 302 |
.IP "NODENAME=branch1" 4 |
| 303 |
.IX Item "NODENAME=branch1" |
| 304 |
The nickname of the node. |
| 305 |
.IP "NODEID=1" 4 |
| 306 |
.IX Item "NODEID=1" |
| 307 |
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. |
| 309 |
.RE |
| 310 |
.RS 4 |
| 311 |
.Sp |
| 312 |
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 |
| 314 |
node, e.g. the \f(CW\*(C`MAC_1\*(C'\fR variable contains the \s-1MAC\s0 address of node #1, while |
| 315 |
the \f(CW\*(C`NODENAME_22\*(C'\fR variable contains the name of node #22. |
| 316 |
.Sp |
| 317 |
Here is a simple if-up script: |
| 318 |
.Sp |
| 319 |
.Vb 5 |
| 320 |
\& #!/bin/sh |
| 321 |
\& ip link set $IFNAME up |
| 322 |
\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME |
| 323 |
\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME |
| 324 |
\& ip route add 10.0.0.0/8 dev $IFNAME |
| 325 |
.Ve |
| 326 |
.Sp |
| 327 |
More complicated examples (using routing to reduce arp traffic) can be |
| 328 |
found in the etc/ subdirectory of the distribution. |
| 329 |
.RE |
| 330 |
.IP "ifname = devname" 4 |
| 331 |
.IX Item "ifname = devname" |
| 332 |
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. |
| 334 |
.IP "ifpersist = yes|true|on | no|false|off" 4 |
| 335 |
.IX Item "ifpersist = yes|true|on | no|false|off" |
| 336 |
Should the tun/tap device be made persistent, that is, should the device |
| 337 |
stay up even when gvpe exits? Some versions of the tunnel device have |
| 338 |
problems sending packets when gvpe is restarted in persistent mode, so |
| 339 |
if the connections can be established but you cannot send packets from |
| 340 |
the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the |
| 341 |
device. |
| 342 |
.IP "ip-proto = numerical-ip-protocol" 4 |
| 343 |
.IX Item "ip-proto = numerical-ip-protocol" |
| 344 |
Sets the protocol number to be used for the rawip protocol. This is a |
| 345 |
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 |
| 347 |
instance using the same protocol, nor can you share the protocol with |
| 348 |
other programs. |
| 349 |
.Sp |
| 350 |
The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through |
| 351 |
firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other |
| 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 |
| 353 |
(\s-1ENCAP\s0, rfc1241) |
| 354 |
.IP "http-proxy-host = hostname/ip" 4 |
| 355 |
.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 |
| 357 |
compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of |
| 358 |
tcp connections through a http proxy server. |
| 359 |
.Sp |
| 360 |
\&\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 |
| 362 |
requires authentication. |
| 363 |
.Sp |
| 364 |
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 |
| 366 |
server better use numerical \s-1IP\s0 addresses. |
| 367 |
.Sp |
| 368 |
To make best use of this option disable all protocols except tcp in your |
| 369 |
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). |
| 371 |
.Sp |
| 372 |
If you have a router, connecting to it will suffice. Otherwise tcp must be |
| 373 |
enabled on all nodes. |
| 374 |
.Sp |
| 375 |
Example: |
| 376 |
.Sp |
| 377 |
.Vb 3 |
| 378 |
\& http\-proxy\-host = proxy.example.com |
| 379 |
\& http\-proxy\-port = 3128 # 8080 is another common choice |
| 380 |
\& http\-proxy\-auth = schmorp:grumbeere |
| 381 |
.Ve |
| 382 |
.IP "http-proxy-port = proxy-tcp-port" 4 |
| 383 |
.IX Item "http-proxy-port = proxy-tcp-port" |
| 384 |
The port where your proxy server listens. |
| 385 |
.IP "http-proxy-auth = login:password" 4 |
| 386 |
.IX Item "http-proxy-auth = login:password" |
| 387 |
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 |
| 389 |
currently supported. |
| 390 |
.IP "keepalive = seconds" 4 |
| 391 |
.IX Item "keepalive = seconds" |
| 392 |
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 |
| 394 |
every 5 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 |
| 396 |
connection is closed. |
| 397 |
.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 |
| 398 |
.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" |
| 399 |
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. |
| 401 |
.IP "mtu = bytes" 4 |
| 402 |
.IX Item "mtu = bytes" |
| 403 |
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 |
| 405 |
maximum overhead (e.g. udp header size, encryption blocksize...) and pass |
| 406 |
this information to the \f(CW\*(C`if\-up\*(C'\fR script. |
| 407 |
.Sp |
| 408 |
Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
| 409 |
.Sp |
| 410 |
This value must be the minimum of the mtu values of all nodes. |
| 411 |
.IP "node = nickname" 4 |
| 412 |
.IX Item "node = nickname" |
| 413 |
Not really a config setting but introduces a node section. The nickname is |
| 414 |
used to select the right configuration section and must be passed as an |
| 415 |
argument to the gvpe daemon. |
| 416 |
.IP "node-up = relative-or-absolute-path" 4 |
| 417 |
.IX Item "node-up = relative-or-absolute-path" |
| 418 |
Sets a command (default: none) that should be called whenever a connection |
| 419 |
is established (even on rekeying operations). Note that node\-up/down |
| 420 |
scripts will be run asynchronously, but execution is serialised, so there |
| 421 |
will only ever be one such script running. |
| 422 |
.Sp |
| 423 |
In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following |
| 424 |
environment variables will be set: |
| 425 |
.RS 4 |
| 426 |
.IP "DESTNODE=branch2" 4 |
| 427 |
.IX Item "DESTNODE=branch2" |
| 428 |
The name of the remote node. |
| 429 |
.IP "DESTID=2" 4 |
| 430 |
.IX Item "DESTID=2" |
| 431 |
The node id of the remote node. |
| 432 |
.IP "DESTIP=188.13.66.8" 4 |
| 433 |
.IX Item "DESTIP=188.13.66.8" |
| 434 |
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). |
| 436 |
.IP "DESTPORT=655 # deprecated" 4 |
| 437 |
.IX Item "DESTPORT=655 # deprecated" |
| 438 |
The \s-1UDP\s0 port used by the other side. |
| 439 |
.IP "STATE=UP" 4 |
| 440 |
.IX Item "STATE=UP" |
| 441 |
Node-up scripts get called with STATE=UP, node-down scripts get called |
| 442 |
with STATE=DOWN. |
| 443 |
.RE |
| 444 |
.RS 4 |
| 445 |
.Sp |
| 446 |
Here is a nontrivial example that uses nsupdate to update the name => ip |
| 447 |
mapping in some dns zone: |
| 448 |
.Sp |
| 449 |
.Vb 6 |
| 450 |
\& #!/bin/sh |
| 451 |
\& { |
| 452 |
\& echo update delete $DESTNODE.lowttl.example.net. a |
| 453 |
\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP |
| 454 |
\& echo |
| 455 |
\& } | nsupdate \-d \-k $CONFBASE:key.example.net. |
| 456 |
.Ve |
| 457 |
.RE |
| 458 |
.IP "node-down = relative-or-absolute-path" 4 |
| 459 |
.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. |
| 461 |
.IP "pid-file = path" 4 |
| 462 |
.IX Item "pid-file = path" |
| 463 |
The path to the pid file to check and create |
| 464 |
(default: \f(CW\*(C`LOCALSTATEDIR/run/gvpe.pid\*(C'\fR). |
| 465 |
.IP "private-key = relative-path-to-key" 4 |
| 466 |
.IX Item "private-key = relative-path-to-key" |
| 467 |
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 |
| 469 |
be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could |
| 470 |
use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where |
| 471 |
\&\f(CW\*(C`gvpectrl\*(C'\fR puts them. |
| 472 |
.Sp |
| 473 |
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 |
| 475 |
not recommended to use this feature. |
| 476 |
.IP "rekey = seconds" 4 |
| 477 |
.IX Item "rekey = seconds" |
| 478 |
Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are |
| 479 |
reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. |
| 480 |
.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
| 481 |
.IX Subsection "NODE SPECIFIC SETTINGS" |
| 482 |
The following settings are node\-specific, that is, every node can have |
| 483 |
different settings, even within the same gvpe instance. Settings that are |
| 484 |
set before the first node section set the defaults, settings that are |
| 485 |
set within a node section only apply to the given node. |
| 486 |
.IP "allow-direct = nodename" 4 |
| 487 |
.IX Item "allow-direct = nodename" |
| 488 |
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 |
| 490 |
.IX Item "compress = yes|true|on | no|false|off" |
| 491 |
Wether to compress data packets sent to this node (default: \f(CW\*(C`yes\*(C'\fR). |
| 492 |
Compression is really cheap even on slow computers and has no size |
| 493 |
overhead at all, so enabling this is a good idea. |
| 494 |
.IP "connect = ondemand | never | always | disabled" 4 |
| 495 |
.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 |
| 497 |
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), |
| 499 |
\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection when there are outstanding |
| 500 |
packets in the queue and take it down after the keepalive interval) or |
| 501 |
\&\f(CW\*(C`disabled\*(C'\fR (node is bad, don't talk to it). |
| 502 |
.Sp |
| 503 |
Routers will automatically be forced to \f(CW\*(C`always\*(C'\fR unless they are |
| 504 |
\&\f(CW\*(C`disabled\*(C'\fR, to ensure all nodes can talk to each other. |
| 505 |
.IP "deny-direct = nodename | *" 4 |
| 506 |
.IX Item "deny-direct = nodename | *" |
| 507 |
Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR |
| 508 |
is given). Only one node can be specified, but you can use multiple |
| 509 |
\&\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. |
| 511 |
.Sp |
| 512 |
Sometimes, a node cannot reach some other nodes for reasons of network |
| 513 |
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 |
| 515 |
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). |
| 517 |
.Sp |
| 518 |
The algorithm to check wether a connection may be direct is as follows: |
| 519 |
.Sp |
| 520 |
1. Other node mentioned in a \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection. |
| 521 |
.Sp |
| 522 |
2. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections. |
| 523 |
.Sp |
| 524 |
3. Allow the connection. |
| 525 |
.Sp |
| 526 |
That is, \f(CW\*(C`allow\-direct\*(C'\fR takes precedence over \f(CW\*(C`deny\-direct\*(C'\fR. |
| 527 |
.Sp |
| 528 |
The check is done in both directions, i.e. both nodes must allow a direct |
| 529 |
connection before one is attempted, so you only need to specify connect |
| 530 |
limitations on one node. |
| 531 |
.IP "dns-domain = domain-suffix" 4 |
| 532 |
.IX Item "dns-domain = domain-suffix" |
| 533 |
The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node. |
| 534 |
.Sp |
| 535 |
The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, |
| 536 |
i.e. |
| 537 |
.Sp |
| 538 |
.Vb 2 |
| 539 |
\& dns\-domainname = tunnel.example.net |
| 540 |
\& dns\-hostname = tunnel\-server.example.net |
| 541 |
.Ve |
| 542 |
.Sp |
| 543 |
Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain: |
| 544 |
.Sp |
| 545 |
.Vb 2 |
| 546 |
\& tunnel.example.net. NS tunnel\-server.example.net. |
| 547 |
\& tunnel\-server.example.net. A 13.13.13.13 |
| 548 |
.Ve |
| 549 |
.IP "dns-hostname = hostname/ip" 4 |
| 550 |
.IX Item "dns-hostname = hostname/ip" |
| 551 |
The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR, |
| 552 |
but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might |
| 553 |
change. |
| 554 |
.IP "dns-port = port-number" 4 |
| 555 |
.IX Item "dns-port = port-number" |
| 556 |
The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers. |
| 557 |
.IP "enable-dns = yes|true|on | no|false|off" 4 |
| 558 |
.IX Item "enable-dns = yes|true|on | no|false|off" |
| 559 |
See \fIgvpe.protocol\fR\|(7) for a description of the \s-1DNS\s0 transport |
| 560 |
protocol. Avoid this protocol if you can. |
| 561 |
.Sp |
| 562 |
Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as |
| 563 |
client. Support for this transport protocol is only available when gvpe |
| 564 |
was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option. |
| 565 |
.IP "enable-icmp = yes|true|on | no|false|off" 4 |
| 566 |
.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. |
| 568 |
.Sp |
| 569 |
Enable the \s-1ICMP\s0 transport using icmp packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this |
| 570 |
node. |
| 571 |
.IP "enable-rawip = yes|true|on | no|false|off" 4 |
| 572 |
.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. |
| 574 |
.Sp |
| 575 |
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). |
| 577 |
.IP "enable-tcp = yes|true|on | no|false|off" 4 |
| 578 |
.IX Item "enable-tcp = yes|true|on | no|false|off" |
| 579 |
See \fIgvpe.protocol\fR\|(7) for a description of the \s-1TCP\s0 transport protocol. |
| 580 |
.Sp |
| 581 |
Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port |
| 582 |
(default: \f(CW\*(C`no\*(C'\fR). Support for this transport protocol is only available |
| 583 |
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 |
| 585 |
.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. |
| 587 |
.Sp |
| 588 |
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 |
| 596 |
.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 |
| 598 |
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, |
| 600 |
then the router will be queried for the address of this node. Otherwise, |
| 601 |
the connection attempt will fail. |
| 602 |
.IP "icmp-type = integer" 4 |
| 603 |
.IX Item "icmp-type = integer" |
| 604 |
Sets the type value to be used for outgoing (and incoming) packets sent |
| 605 |
via the \s-1ICMP\s0 transport. |
| 606 |
.Sp |
| 607 |
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. |
| 609 |
\&\*(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 |
| 611 |
.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 |
| 613 |
script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR. |
| 614 |
.IP "inherit-tos = yes|true|on | no|false|off" 4 |
| 615 |
.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 |
| 617 |
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 |
| 619 |
to the tunnel device, which is usually what you want. |
| 620 |
.IP "max-retry = positive-number" 4 |
| 621 |
.IX Item "max-retry = positive-number" |
| 622 |
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 |
| 624 |
be established, gvpe uses exponential backoff capped at this value. It's |
| 625 |
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 |
| 627 |
assure quick reconnections even after longer downtimes. |
| 628 |
.IP "max-ttl = seconds" 4 |
| 629 |
.IX Item "max-ttl = seconds" |
| 630 |
Expire packets that couldn't be sent after this many seconds |
| 631 |
(default: \f(CW60\fR). Gvpe will normally queue packets for a node without an |
| 632 |
active connection, in the hope of establishing a connection soon. This |
| 633 |
value specifies the maximum lifetime a packet will stay in the queue, if a |
| 634 |
packet gets older, it will be thrown away. |
| 635 |
.IP "max-queue = positive\-number>=1" 4 |
| 636 |
.IX Item "max-queue = positive-number>=1" |
| 637 |
The maximum number of packets that will be queued (default: \f(CW512\fR) |
| 638 |
for this node. If more packets are sent then earlier packets will be |
| 639 |
expired. See \f(CW\*(C`max\-ttl\*(C'\fR, above. |
| 640 |
.IP "router-priority = 0 | 1 | positive\-number>=2" 4 |
| 641 |
.IX Item "router-priority = 0 | 1 | positive-number>=2" |
| 642 |
Sets the router priority of the given node (default: \f(CW0\fR, disabled). |
| 643 |
.Sp |
| 644 |
If some node tries to connect to another node but it doesn't have a |
| 645 |
hostname, it asks a router node for it's \s-1IP\s0 address. The router node |
| 646 |
chosen is the one with the highest priority larger than \f(CW1\fR that is |
| 647 |
currently reachable. This is called a \fImediated\fR connection, as the |
| 648 |
connection itself will still be direct, but it uses another node to |
| 649 |
mediate between the two nodes. |
| 650 |
.Sp |
| 651 |
The value \f(CW0\fR disables routing, that means if the node receives a packet |
| 652 |
not for itself it will not forward it but instead drop it. |
| 653 |
.Sp |
| 654 |
The special value \f(CW1\fR allows other hosts to route through the router |
| 655 |
host, but they will never route through it by default (i.e. the config |
| 656 |
file of another node needs to specify a router priority higher than one |
| 657 |
to choose such a node for routing). |
| 658 |
.Sp |
| 659 |
The idea behind this is that some hosts can, if required, bump the |
| 660 |
\&\f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their local config to |
| 661 |
route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is \f(CW0\fR, then routing |
| 662 |
will be refused, so \f(CW1\fR serves as a \*(L"enable, but do not use by default\*(R" |
| 663 |
switch. |
| 664 |
.Sp |
| 665 |
Nodes with \f(CW\*(C`router\-priority\*(C'\fR set to \f(CW2\fR or higher will always be forced |
| 666 |
to \f(CW\*(C`connect\*(C'\fR = \f(CW\*(C`always\*(C'\fR (unless they are \f(CW\*(C`disabled\*(C'\fR). |
| 667 |
.IP "tcp-port = port-number" 4 |
| 668 |
.IX Item "tcp-port = port-number" |
| 669 |
Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. |
| 670 |
.IP "udp-port = port-number" 4 |
| 671 |
.IX Item "udp-port = port-number" |
| 672 |
Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not |
| 673 |
officially assigned by \s-1IANA\s0!). |
| 674 |
.SH "CONFIG DIRECTORY LAYOUT" |
| 675 |
.IX Header "CONFIG DIRECTORY LAYOUT" |
| 676 |
The default (or recommended) directory layout for the config directory is: |
| 677 |
.IP "\(bu" 4 |
| 678 |
.IX Xref "gvpe.conf" |
| 679 |
The config file. |
| 680 |
.IP "\(bu" 4 |
| 681 |
.IX Xref "if-up" |
| 682 |
The if-up script |
| 683 |
.IP "," 4 |
| 684 |
.IX Xref "node-up node-down" |
| 685 |
If used the node up or node-down scripts. |
| 686 |
.IP "\(bu" 4 |
| 687 |
.IX Xref "hostkey" |
| 688 |
The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. |
| 689 |
.IP "\(bu" 4 |
| 690 |
.IX Xref "pubkey nodename" |
| 691 |
The public keys of the other nodes, one file per node. |
| 692 |
.SH "SEE ALSO" |
| 693 |
.IX Header "SEE ALSO" |
| 694 |
\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). |
| 695 |
.SH "AUTHOR" |
| 696 |
.IX Header "AUTHOR" |
| 697 |
Marc Lehmann <gvpe@schmorp.de> |
