| 1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 |
|
|
| 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. | will give a |
|
|
| 29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
|
|
| 30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
|
|
| 31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. |
|
|
| 32 | .tr \(*W-|\(bv\*(Tr |
|
|
| 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 "2005-03-14" "1.8" "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. Spaces are allowed before or after the \f(CW\*(C`=\*(C'\fR sign or |
|
|
| 164 | after 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 hosts. 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 "if-up = relative-or-absolute-path" 4 |
|
|
| 208 | .IX Item "if-up = relative-or-absolute-path" |
|
|
| 209 | Sets the path of a script that should be called immediately after the |
|
|
| 210 | network interface is initialized (but not neccessarily up). The following |
|
|
| 211 | environment variables are passed to it (the values are just examples): |
|
|
| 212 | .RS 4 |
|
|
| 213 | .IP "CONFBASE=/etc/gvpe" 4 |
|
|
| 214 | .IX Item "CONFBASE=/etc/gvpe" |
|
|
| 215 | The configuration base directory. |
|
|
| 216 | .IP "IFNAME=vpn0" 4 |
|
|
| 217 | .IX Item "IFNAME=vpn0" |
|
|
| 218 | The interface to initialize. |
|
|
| 219 | .IP "MTU=1436" 4 |
|
|
| 220 | .IX Item "MTU=1436" |
|
|
| 221 | The \s-1MTU\s0 to set the interface to. You can use lower values (if done |
|
|
| 222 | consistently on all hosts), but this is usually ineffective. |
|
|
| 223 | .IP "MAC=fe:fd:80:00:00:01" 4 |
|
|
| 224 | .IX Item "MAC=fe:fd:80:00:00:01" |
|
|
| 225 | The \s-1MAC\s0 address to set the interface to. The script *must* set the |
|
|
| 226 | interface \s-1MAC\s0 to this value. You will most likely use one of these: |
|
|
| 227 | .Sp |
|
|
| 228 | .Vb 2 |
|
|
| 229 | \& ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux |
|
|
| 230 | \& ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD |
|
|
| 231 | .Ve |
|
|
| 232 | .Sp |
|
|
| 233 | Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for platform-specific information. |
|
|
| 234 | .IP "IFTYPE=native # or tincd" 4 |
|
|
| 235 | .IX Item "IFTYPE=native # or tincd" |
|
|
| 236 | .PD 0 |
|
|
| 237 | .IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 |
|
|
| 238 | .IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." |
|
|
| 239 | .PD |
|
|
| 240 | The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os |
|
|
| 241 | name in lowercase) that this gvpe was configured for. Can be used to select |
|
|
| 242 | the correct syntax to use for network-related commands. |
|
|
| 243 | .IP "NODENAME=branch1" 4 |
|
|
| 244 | .IX Item "NODENAME=branch1" |
|
|
| 245 | The nickname of the current node, as passed to the gvpe daemon. |
|
|
| 246 | .IP "NODEID=1" 4 |
|
|
| 247 | .IX Item "NODEID=1" |
|
|
| 248 | The numerical node id of the current node. The first node mentioned in the |
|
|
| 249 | config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on. |
|
|
| 250 | .RE |
|
|
| 251 | .RS 4 |
|
|
| 252 | .Sp |
|
|
| 253 | Here is a simple if-up script: |
|
|
| 254 | .Sp |
|
|
| 255 | .Vb 5 |
|
|
| 256 | \& #!/bin/sh |
|
|
| 257 | \& ip link set $IFNAME address $MAC mtu $MTU up |
|
|
| 258 | \& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME |
|
|
| 259 | \& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME |
|
|
| 260 | \& ip route add 10.0.0.0/8 dev $IFNAME |
|
|
| 261 | .Ve |
|
|
| 262 | .Sp |
|
|
| 263 | More complicated examples (using routing to reduce arp traffic) can be |
|
|
| 264 | found in the etc/ subdirectory of the distribution. |
|
|
| 265 | .RE |
|
|
| 266 | .IP "ifname = devname" 4 |
|
|
| 267 | .IX Item "ifname = devname" |
|
|
| 268 | Sets the tun interface name to the given name. The default is OS-specific |
|
|
| 269 | and most probably something like \f(CW\*(C`tun0\*(C'\fR. |
|
|
| 270 | .IP "ifpersist = yes|true|on | no|false|off" 4 |
|
|
| 271 | .IX Item "ifpersist = yes|true|on | no|false|off" |
|
|
| 272 | Should the tun/tap device be made persistent, that is, should the device |
|
|
| 273 | stay up even when gvpe exits? Some versions of the tunnel device have |
|
|
| 274 | problems sending packets when gvpe is restarted in persistent mode, so |
|
|
| 275 | if the connections can be established but you cannot send packets from |
|
|
| 276 | the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the |
|
|
| 277 | device. |
|
|
| 278 | .IP "ip-proto = numerical-ip-protocol" 4 |
|
|
| 279 | .IX Item "ip-proto = numerical-ip-protocol" |
|
|
| 280 | Sets the protocol number to be used for the rawip protocol. This is a |
|
|
| 281 | global option because all hosts must use the same protocol, and since |
|
|
| 282 | there are no port numbers, you cannot easily run more than one gvpe |
|
|
| 283 | instance using the same protocol, nor can you share the protocol with |
|
|
| 284 | other programs. |
|
|
| 285 | .Sp |
|
|
| 286 | The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through |
|
|
| 287 | firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other |
|
|
| 288 | common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98 |
|
|
| 289 | (\s-1ENCAP\s0, rfc1241) |
|
|
| 290 | .IP "http-proxy-host = hostname/ip" 4 |
|
|
| 291 | .IX Item "http-proxy-host = hostname/ip" |
|
|
| 292 | The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was |
|
|
| 293 | compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of |
|
|
| 294 | tcp connections through a http proxy server. |
|
|
| 295 | .Sp |
|
|
| 296 | \&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and |
|
|
| 297 | port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy |
|
|
| 298 | requires authentication. |
|
|
| 299 | .Sp |
|
|
| 300 | Please note that gvpe will still try to resolve all hostnames in the |
|
|
| 301 | configuration file, so if you are behind a proxy without access to a dns |
|
|
| 302 | server better use numerical \s-1IP\s0 addresses. |
|
|
| 303 | .Sp |
|
|
| 304 | To make best use of this option disable all protocols except tcp in your |
|
|
| 305 | config file and make sure your routers (or all other hosts) are listening |
|
|
| 306 | on a port that the proxy allows (443, https, is a common choice). |
|
|
| 307 | .Sp |
|
|
| 308 | If you have a router, connecting to it will suffice. Otherwise tcp must be |
|
|
| 309 | enabled on all hosts. |
|
|
| 310 | .Sp |
|
|
| 311 | Example: |
|
|
| 312 | .Sp |
|
|
| 313 | .Vb 3 |
|
|
| 314 | \& http-proxy-host = proxy.example.com |
|
|
| 315 | \& http-proxy-port = 3128 # 8080 is another common choice |
|
|
| 316 | \& http-proxy-auth = schmorp:grumbeere |
|
|
| 317 | .Ve |
|
|
| 318 | .IP "http-proxy-port = proxy-tcp-port" 4 |
|
|
| 319 | .IX Item "http-proxy-port = proxy-tcp-port" |
|
|
| 320 | The port where your proxy server listens. |
|
|
| 321 | .IP "http-proxy-auth = login:password" 4 |
|
|
| 322 | .IX Item "http-proxy-auth = login:password" |
|
|
| 323 | The optional login and password used to authenticate to the proxy server, |
|
|
| 324 | seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is |
|
|
| 325 | currently supported. |
|
|
| 326 | .IP "keepalive = seconds" 4 |
|
|
| 327 | .IX Item "keepalive = seconds" |
|
|
| 328 | Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this |
|
|
| 329 | many seconds of inactivity the daemon will start to send keepalive probe |
|
|
| 330 | every 5 seconds until it receives a reply from the other end. If no reply |
|
|
| 331 | is received within 30 seconds, the peer is considered unreachable and the |
|
|
| 332 | connection is closed. |
|
|
| 333 | .IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 |
|
|
| 334 | .IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" |
|
|
| 335 | Set the logging level. Connection established messages are logged at level |
|
|
| 336 | \&\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. |
|
|
| 337 | .IP "mtu = bytes" 4 |
|
|
| 338 | .IX Item "mtu = bytes" |
|
|
| 339 | Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically |
|
|
| 340 | the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate |
|
|
| 341 | maximum overhead (e.g. udp header size, encryption blocksize...) and pass |
|
|
| 342 | this information to the \f(CW\*(C`if\-up\*(C'\fR script. |
|
|
| 343 | .Sp |
|
|
| 344 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
|
|
| 345 | .Sp |
|
|
| 346 | This value must be the minimum of the mtu values of all hosts. |
|
|
| 347 | .IP "node = nickname" 4 |
|
|
| 348 | .IX Item "node = nickname" |
|
|
| 349 | Not really a config setting but introduces a node section. The nickname is |
|
|
| 350 | used to select the right configuration section and must be passed as an |
|
|
| 351 | argument to the gvpe daemon. |
|
|
| 352 | .IP "node-up = relative-or-absolute-path" 4 |
|
|
| 353 | .IX Item "node-up = relative-or-absolute-path" |
|
|
| 354 | Sets a command (default: no script) that should be called whenever a |
|
|
| 355 | connection is established (even on rekeying operations). In addition |
|
|
| 356 | to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment |
|
|
| 357 | variables will be set: |
|
|
| 358 | .RS 4 |
|
|
| 359 | .IP "DESTNODE=branch2" 4 |
|
|
| 360 | .IX Item "DESTNODE=branch2" |
|
|
| 361 | The name of the remote node. |
|
|
| 362 | .IP "DESTID=2" 4 |
|
|
| 363 | .IX Item "DESTID=2" |
|
|
| 364 | The node id of the remote node. |
|
|
| 365 | .IP "DESTIP=188.13.66.8" 4 |
|
|
| 366 | .IX Item "DESTIP=188.13.66.8" |
|
|
| 367 | The numerical \s-1IP\s0 address of the remote host (gvpe accepts connections from |
|
|
| 368 | everywhere, as long as the other host can authenticate itself). |
|
|
| 369 | .IP "DESTPORT=655 # deprecated" 4 |
|
|
| 370 | .IX Item "DESTPORT=655 # deprecated" |
|
|
| 371 | The \s-1UDP\s0 port used by the other side. |
|
|
| 372 | .IP "STATE=UP" 4 |
|
|
| 373 | .IX Item "STATE=UP" |
|
|
| 374 | Node-up scripts get called with STATE=UP, node-down scripts get called |
|
|
| 375 | with STATE=DOWN. |
|
|
| 376 | .RE |
|
|
| 377 | .RS 4 |
|
|
| 378 | .Sp |
|
|
| 379 | Here is a nontrivial example that uses nsupdate to update the name => ip |
|
|
| 380 | mapping in some dns zone: |
|
|
| 381 | .Sp |
|
|
| 382 | .Vb 6 |
|
|
| 383 | \& #!/bin/sh |
|
|
| 384 | \& { |
|
|
| 385 | \& echo update delete $DESTNODE.lowttl.example.net. a |
|
|
| 386 | \& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP |
|
|
| 387 | \& echo |
|
|
| 388 | \& } | nsupdate -d -k $CONFBASE:key.example.net. |
|
|
| 389 | .Ve |
|
|
| 390 | .RE |
|
|
| 391 | .IP "node-down = relative-or-absolute-path" 4 |
|
|
| 392 | .IX Item "node-down = relative-or-absolute-path" |
|
|
| 393 | Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. |
|
|
| 394 | .IP "pid-file = path" 4 |
|
|
| 395 | .IX Item "pid-file = path" |
|
|
| 396 | The path to the pid file to check and create |
|
|
| 397 | (default: \f(CW\*(C`LOCALSTATEDIR/run/gvpe.pid\*(C'\fR). |
|
|
| 398 | .IP "private-key = relative-path-to-key" 4 |
|
|
| 399 | .IX Item "private-key = relative-path-to-key" |
|
|
| 400 | Sets the path (relative to the config directory) to the private key |
|
|
| 401 | (default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must |
|
|
| 402 | be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could |
|
|
| 403 | use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where |
|
|
| 404 | \&\f(CW\*(C`gvpectrl\*(C'\fR puts them. |
|
|
| 405 | .Sp |
|
|
| 406 | Since only the private key file of the current node is used and the |
|
|
| 407 | private key file should be kept secret per-host to avoid spoofings, it is |
|
|
| 408 | not recommended to use this feature. |
|
|
| 409 | .IP "rekey = seconds" 4 |
|
|
| 410 | .IX Item "rekey = seconds" |
|
|
| 411 | Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are |
|
|
| 412 | reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. |
|
|
| 413 | .Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
|
|
| 414 | .IX Subsection "NODE SPECIFIC SETTINGS" |
|
|
| 415 | The following settings are node\-specific, that is, every node can have |
|
|
| 416 | different settings, even within the same gvpe instance. Settings that are |
|
|
| 417 | executed before the first node section set the defaults, settings that are |
|
|
| 418 | executed within a node section only apply to the given node. |
|
|
| 419 | .IP "compress = yes|true|on | no|false|off" 4 |
|
|
| 420 | .IX Item "compress = yes|true|on | no|false|off" |
|
|
| 421 | Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). |
|
|
| 422 | Compression is really cheap even on slow computers and has no size |
|
|
| 423 | overhead at all, so enabling this is a good idea. |
|
|
| 424 | .IP "connect = ondemand | never | always | disabled" 4 |
|
|
| 425 | .IX Item "connect = ondemand | never | always | disabled" |
|
|
| 426 | Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always |
|
|
| 427 | try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR |
|
|
| 428 | (never initiate a connection to the given host, but accept connections), |
|
|
| 429 | \&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and |
|
|
| 430 | take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, |
|
|
| 431 | don't talk to it). |
|
|
| 432 | .IP "dns-domain = domain-suffix" 4 |
|
|
| 433 | .IX Item "dns-domain = domain-suffix" |
|
|
| 434 | The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node. |
|
|
| 435 | .Sp |
|
|
| 436 | The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, |
|
|
| 437 | i.e. |
|
|
| 438 | .Sp |
|
|
| 439 | .Vb 2 |
|
|
| 440 | \& dns-domainname = tunnel.example.net |
|
|
| 441 | \& dns-hostname = tunnel-server.example.net |
|
|
| 442 | .Ve |
|
|
| 443 | .Sp |
|
|
| 444 | Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain: |
|
|
| 445 | .Sp |
|
|
| 446 | .Vb 2 |
|
|
| 447 | \& tunnel.example.net. NS tunnel-server.example.net. |
|
|
| 448 | \& tunnel-server.example.net. A 13.13.13.13 |
|
|
| 449 | .Ve |
|
|
| 450 | .IP "dns-hostname = hostname/ip" 4 |
|
|
| 451 | .IX Item "dns-hostname = hostname/ip" |
|
|
| 452 | The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR, |
|
|
| 453 | but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might |
|
|
| 454 | change. |
|
|
| 455 | .IP "dns-port = port-number" 4 |
|
|
| 456 | .IX Item "dns-port = port-number" |
|
|
| 457 | The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers. |
|
|
| 458 | .IP "enable-dns = yes|true|on | no|false|off" 4 |
|
|
| 459 | .IX Item "enable-dns = yes|true|on | no|false|off" |
|
|
| 460 | Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as |
|
|
| 461 | client (only available when gvpe was compiled with \f(CW\*(C`\-\-enable\-dns\*(C'\fR). |
|
|
| 462 | .Sp |
|
|
| 463 | \&\fB\s-1WARNING:\s0\fR Parsing and generating \s-1DNS\s0 packets is rather tricky. The code |
|
|
| 464 | almost certainly contains buffer overflows and other, likely exploitable, |
|
|
| 465 | bugs. You have been warned. |
|
|
| 466 | .Sp |
|
|
| 467 | This is the worst choice of transport protocol with respect to overhead |
|
|
| 468 | (overhead can be 2\-3 times higher than the transferred data), and probably |
|
|
| 469 | the best choice when tunneling through firewalls. |
|
|
| 470 | .IP "enable-rawip = yes|true|on | no|false|off" 4 |
|
|
| 471 | .IX Item "enable-rawip = yes|true|on | no|false|off" |
|
|
| 472 | Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol |
|
|
| 473 | (default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the minimum overhead per |
|
|
| 474 | packet is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+). |
|
|
| 475 | .IP "enable-tcp = yes|true|on | no|false|off" 4 |
|
|
| 476 | .IX Item "enable-tcp = yes|true|on | no|false|off" |
|
|
| 477 | Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port |
|
|
| 478 | (default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only |
|
|
| 479 | available when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never |
|
|
| 480 | use this transport unless you really must, it is very inefficient and |
|
|
| 481 | resource-intensive compared to the other transports (except for \s-1DNS\s0, which |
|
|
| 482 | is worse). |
|
|
| 483 | .IP "enable-udp = yes|true|on | no|false|off" 4 |
|
|
| 484 | .IX Item "enable-udp = yes|true|on | no|false|off" |
|
|
| 485 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, |
|
|
| 486 | unless no other protocol is enabled for a node, in which case this |
|
|
| 487 | protocol is enabled automatically). This is a good general choice since |
|
|
| 488 | \&\s-1UDP\s0 tunnels well through many firewalls. |
|
|
| 489 | .Sp |
|
|
| 490 | \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though |
|
|
| 491 | it might get switched on automatically, as some future version might |
|
|
| 492 | default to another default protocol. |
|
|
| 493 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
|
|
| 494 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
|
|
| 495 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
|
|
| 496 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
|
|
| 497 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
|
|
| 498 | to the tunnel device, which is usually what you want. |
|
|
| 499 | .IP "max-retry = positive-number" 4 |
|
|
| 500 | .IX Item "max-retry = positive-number" |
|
|
| 501 | The maximum interval in seconds (default: \f(CW3600\fR, one hour) between |
|
|
| 502 | retries to establish a connection to this node. When a connection cannot |
|
|
| 503 | be established, gvpe uses exponential backoff capped at this value. It's |
|
|
| 504 | sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on |
|
|
| 505 | connections to routers that usually are stable but sometimes are down, to |
|
|
| 506 | assure quick reconnections even after longer downtimes. |
|
|
| 507 | .IP "router-priority = 0 | 1 | positive\-number>=2" 4 |
|
|
| 508 | .IX Item "router-priority = 0 | 1 | positive-number>=2" |
|
|
| 509 | Sets the router priority of the given host (default: \f(CW0\fR, disabled). If |
|
|
| 510 | some host tries to connect to another host without a hostname, it asks |
|
|
| 511 | the router host for it's \s-1IP\s0 address. The router host is the one with the |
|
|
| 512 | highest priority larger than \f(CW1\fR that is currently reachable. |
|
|
| 513 | .Sp |
|
|
| 514 | Make sure all hosts always connect (\f(CW\*(C`connect = always\*(C'\fR) to the router |
|
|
| 515 | hosts, otherwise connecting to them might be impossible. |
|
|
| 516 | .Sp |
|
|
| 517 | The special value \f(CW1\fR allows other hosts to route through the router |
|
|
| 518 | host, but they will never route through it by default. The value \f(CW0\fR |
|
|
| 519 | disables routing. The idea behind this is that some hosts can, if |
|
|
| 520 | required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their |
|
|
| 521 | local config to route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is |
|
|
| 522 | \&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do |
|
|
| 523 | not use by default\*(R" switch. |
|
|
| 524 | .IP "tcp-port = port-number" 4 |
|
|
| 525 | .IX Item "tcp-port = port-number" |
|
|
| 526 | Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. |
|
|
| 527 | .IP "udp-port = port-number" 4 |
|
|
| 528 | .IX Item "udp-port = port-number" |
|
|
| 529 | Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not |
|
|
| 530 | officially assigned by \s-1IANA\s0!). |
|
|
| 531 | .SH "CONFIG DIRECTORY LAYOUT" |
|
|
| 532 | .IX Header "CONFIG DIRECTORY LAYOUT" |
|
|
| 533 | The default (or recommended) directory layout for the config directory is: |
|
|
| 534 | .IP "\(bu" 4 |
|
|
| 535 | .IX Xref "gvpe.conf" |
|
|
| 536 | The config file. |
|
|
| 537 | .IP "\(bu" 4 |
|
|
| 538 | .IX Xref "if-up" |
|
|
| 539 | The if-up script |
|
|
| 540 | .IP "," 4 |
|
|
| 541 | .IX Xref "node-up node-down" |
|
|
| 542 | If used the node up or node-down scripts. |
|
|
| 543 | .IP "\(bu" 4 |
|
|
| 544 | .IX Xref "hostkey" |
|
|
| 545 | The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. |
|
|
| 546 | .IP "\(bu" 4 |
|
|
| 547 | .IX Xref "pubkey nodename" |
|
|
| 548 | The public keys of the other nodes, one file per node. |
|
|
| 549 | .SH "SEE ALSO" |
|
|
| 550 | .IX Header "SEE ALSO" |
|
|
| 551 | \&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). |
|
|
| 552 | .SH "AUTHOR" |
|
|
| 553 | .IX Header "AUTHOR" |
|
|
| 554 | Marc Lehmann <gvpe@plan9.de> |
|
|
