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