1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 |
1 | .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) |
2 | .\" |
2 | .\" |
3 | .\" Standard preamble: |
3 | .\" Standard preamble: |
4 | .\" ======================================================================== |
4 | .\" ======================================================================== |
5 | .de Sh \" Subsection heading |
5 | .de Sh \" Subsection heading |
6 | .br |
6 | .br |
… | |
… | |
23 | .ft R |
23 | .ft R |
24 | .fi |
24 | .fi |
25 | .. |
25 | .. |
26 | .\" Set up some character translations and predefined strings. \*(-- will |
26 | .\" Set up some character translations and predefined strings. \*(-- will |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
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 |
28 | .\" double quote, and \*(R" will give a right double quote. \*(C+ will |
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
29 | .\" give a nicer C++. Capital omega is used to do unbreakable dashes and |
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
30 | .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. |
31 | .\" nothing in troff, for use with C<>. |
32 | .tr \(*W-|\(bv\*(Tr |
32 | .tr \(*W- |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
34 | .ie n \{\ |
34 | .ie n \{\ |
35 | . ds -- \(*W- |
35 | . ds -- \(*W- |
36 | . ds PI pi |
36 | . ds PI pi |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
… | |
… | |
46 | . ds PI \(*p |
46 | . ds PI \(*p |
47 | . ds L" `` |
47 | . ds L" `` |
48 | . ds R" '' |
48 | . ds R" '' |
49 | 'br\} |
49 | 'br\} |
50 | .\" |
50 | .\" |
|
|
51 | .\" Escape single quotes in literal strings from groff's Unicode transform. |
|
|
52 | .ie \n(.g .ds Aq \(aq |
|
|
53 | .el .ds Aq ' |
|
|
54 | .\" |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for |
55 | .\" 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 |
56 | .\" 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 |
57 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
54 | .\" output yourself in some meaningful fashion. |
58 | .\" output yourself in some meaningful fashion. |
55 | .if \nF \{\ |
59 | .ie \nF \{\ |
56 | . de IX |
60 | . de IX |
57 | . tm Index:\\$1\t\\n%\t"\\$2" |
61 | . tm Index:\\$1\t\\n%\t"\\$2" |
58 | .. |
62 | .. |
59 | . nr % 0 |
63 | . nr % 0 |
60 | . rr F |
64 | . rr F |
61 | .\} |
65 | .\} |
62 | .\" |
66 | .el \{\ |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
67 | . de IX |
64 | .\" way too many mistakes in technical documents. |
68 | .. |
65 | .hy 0 |
69 | .\} |
66 | .if n .na |
|
|
67 | .\" |
70 | .\" |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
71 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
72 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
70 | . \" fudge factors for nroff and troff |
73 | . \" fudge factors for nroff and troff |
71 | .if n \{\ |
74 | .if n \{\ |
… | |
… | |
127 | .\} |
130 | .\} |
128 | .rm #[ #] #H #V #F C |
131 | .rm #[ #] #H #V #F C |
129 | .\" ======================================================================== |
132 | .\" ======================================================================== |
130 | .\" |
133 | .\" |
131 | .IX Title "GVPE.CONF 5" |
134 | .IX Title "GVPE.CONF 5" |
132 | .TH GVPE.CONF 5 "2005-03-17" "1.8" "GNU Virtual Private Ethernet" |
135 | .TH GVPE.CONF 5 "2008-09-01" "2.2" "GNU Virtual Private Ethernet" |
|
|
136 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
|
|
137 | .\" way too many mistakes in technical documents. |
|
|
138 | .if n .ad l |
|
|
139 | .nh |
133 | .SH "NAME" |
140 | .SH "NAME" |
134 | gvpe.conf \- configuration file for the GNU VPE daemon |
141 | gvpe.conf \- configuration file for the GNU VPE daemon |
135 | .SH "SYNOPSIS" |
142 | .SH "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
143 | .IX Header "SYNOPSIS" |
137 | .Vb 3 |
144 | .Vb 4 |
|
|
145 | \& # global options for all nodes |
138 | \& udp-port = 407 |
146 | \& udp\-port = 407 |
139 | \& mtu = 1492 |
147 | \& mtu = 1492 |
140 | \& ifname = vpn0 |
148 | \& ifname = vpn0 |
141 | .Ve |
149 | \& |
142 | .PP |
150 | \& # first node is named branch1 and is at 1.2.3.4 |
143 | .Vb 2 |
|
|
144 | \& node = branch1 |
151 | \& node = branch1 |
145 | \& hostname = 1.2.3.4 |
152 | \& hostname = 1.2.3.4 |
146 | .Ve |
153 | \& |
147 | .PP |
154 | \& # second node uses dns to resolve the address |
148 | .Vb 3 |
|
|
149 | \& node = branch2 |
155 | \& node = branch2 |
150 | \& hostname = www.example.net |
156 | \& hostname = www.example.net |
151 | \& udp-port = 500 # this host uses a different udp-port |
157 | \& udp\-port = 500 # this host uses a different udp\-port |
152 | .Ve |
158 | \& |
153 | .PP |
159 | \& # third node has no fixed ip address |
154 | .Vb 2 |
|
|
155 | \& node = branch3 |
160 | \& node = branch3 |
156 | \& connect = ondemand |
161 | \& connect = ondemand |
157 | .Ve |
162 | .Ve |
158 | .SH "DESCRIPTION" |
163 | .SH "DESCRIPTION" |
159 | .IX Header "DESCRIPTION" |
164 | .IX Header "DESCRIPTION" |
160 | The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable |
165 | 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 |
166 | = 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 |
167 | 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 |
168 | after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after |
164 | after values, but not within the variable names or values themselves. |
169 | values, but not within the variable names or values themselves. |
165 | .PP |
170 | .PP |
166 | The only exception to the above is the \*(L"on\*(R" directive that can prefix any |
171 | 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 |
172 | \&\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. |
173 | (if the nodename starts with \*(L"!\*(R") on all nodes except the named one. |
169 | .PP |
174 | .PP |
|
|
175 | For example, set the \s-1MTU\s0 to \f(CW1450\fR everywhere, loglevel to \f(CW\*(C`noise\*(C'\fR on |
|
|
176 | branch1, and connect to \f(CW\*(C`ondemand\*(C'\fR everywhere but on branch2: |
|
|
177 | .PP |
170 | .Vb 3 |
178 | .Vb 3 |
171 | \& name = value |
179 | \& mtu = 1450 |
172 | \& on branch1 loglevel = noise |
180 | \& on branch1 loglevel = noise |
173 | \& on !branch2 connect = ondemand |
181 | \& on !branch2 connect = ondemand |
174 | .Ve |
182 | .Ve |
175 | .PP |
183 | .PP |
176 | All settings are executed \*(L"in order\*(R", that is, later settings of the same |
184 | All settings are applied \*(L"in order\*(R", that is, later settings of the same |
177 | variable overwrite earlier ones. |
185 | variable overwrite earlier ones. |
178 | .SH "ANATOMY OF A CONFIG FILE" |
186 | .SH "ANATOMY OF A CONFIG FILE" |
179 | .IX Header "ANATOMY OF A CONFIG FILE" |
187 | .IX Header "ANATOMY OF A CONFIG FILE" |
180 | Usually, a config file starts with global settings (like the udp port to |
188 | Usually, a config file starts with a few global settings (like the \s-1UDP\s0 |
181 | listen on), followed by node-specific sections that begin with a \f(CW\*(C`node = |
189 | port to listen on), followed by node-specific sections that begin with a |
182 | nickname\*(C'\fR line. |
190 | \&\f(CW\*(C`node = nickname\*(C'\fR line. |
183 | .PP |
191 | .PP |
184 | Every node that is part of the network must have a section that starts |
192 | 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 |
193 | 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 |
194 | 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. |
195 | be completely empty \- if the default values are right. |
188 | .PP |
196 | .PP |
189 | Node-specific settings can be used at any time. If used before the first |
197 | 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. |
198 | node section they will set the default values for all following nodes. |
191 | .SH "CONFIG VARIABLES" |
199 | .SH "CONFIG VARIABLES" |
… | |
… | |
196 | is, they are in some sense node-specific (config files can set different |
204 | 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 |
205 | 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. |
206 | the gvpe daemon and all connections it creates. |
199 | .IP "dns-forw-host = hostname/ip" 4 |
207 | .IP "dns-forw-host = hostname/ip" 4 |
200 | .IX Item "dns-forw-host = hostname/ip" |
208 | .IX Item "dns-forw-host = hostname/ip" |
201 | The dns server to forward dns requests to for the \s-1DNS\s0 tunnel protocol |
209 | The \s-1DNS\s0 server to forward \s-1DNS\s0 requests to for the \s-1DNS\s0 tunnel protocol |
202 | (default: \f(CW127.0.0.1\fR, changing it is highly recommended). |
210 | (default: \f(CW127.0.0.1\fR, changing it is highly recommended). |
203 | .IP "dns-forw-port = port-number" 4 |
211 | .IP "dns-forw-port = port-number" 4 |
204 | .IX Item "dns-forw-port = port-number" |
212 | .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, |
213 | 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). |
214 | which is fine in most cases). |
|
|
215 | .IP "dns-max-outstanding = integer-number-of-requests" 4 |
|
|
216 | .IX Item "dns-max-outstanding = integer-number-of-requests" |
|
|
217 | The maximum number of outstanding \s-1DNS\s0 transport requests |
|
|
218 | (default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given |
|
|
219 | limit without receiving replies. In heavily overloaded situations it might |
|
|
220 | help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the |
|
|
221 | number of parallel requests. |
|
|
222 | .Sp |
|
|
223 | The default should be working \s-1OK\s0 for most links. |
|
|
224 | .IP "dns-overlap-factor = float" 4 |
|
|
225 | .IX Item "dns-overlap-factor = float" |
|
|
226 | The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen |
|
|
227 | during a connection as it's timing base. This factor (default: \f(CW0.5\fR, |
|
|
228 | must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending |
|
|
229 | rate (= minimum send interval), i.e. a factor of \f(CW1\fR means that a new |
|
|
230 | request might be generated every \fBmin_latency\fR seconds, which means on |
|
|
231 | average there should only ever be one outstanding request. A factor of |
|
|
232 | \&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum |
|
|
233 | latency measured. |
|
|
234 | .Sp |
|
|
235 | For congested or picky \s-1DNS\s0 forwarders you could use a value nearer to or |
|
|
236 | exceeding \f(CW1\fR. |
|
|
237 | .Sp |
|
|
238 | The default should be working \s-1OK\s0 for most links. |
|
|
239 | .IP "dns-send-interval = send-interval-in-seconds" 4 |
|
|
240 | .IX Item "dns-send-interval = send-interval-in-seconds" |
|
|
241 | The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will |
|
|
242 | use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when |
|
|
243 | the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will |
|
|
244 | not send more than 100 \s-1DNS\s0 requests per connection per second. For |
|
|
245 | high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For |
|
|
246 | congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR, |
|
|
247 | \&\f(CW0.2\fR or even higher. |
|
|
248 | .Sp |
|
|
249 | The default should be working \s-1OK\s0 for most links. |
|
|
250 | .IP "dns-timeout-factor = float" 4 |
|
|
251 | .IX Item "dns-timeout-factor = float" |
|
|
252 | Factor to multiply the \f(CW\*(C`min_latency\*(C'\fR (see \f(CW\*(C`dns\-overlap\-factor\*(C'\fR) by to |
|
|
253 | get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport |
|
|
254 | will resend the request when no reply has been received for longer than |
|
|
255 | eight times the minimum (= expected) latency, assuming the request or |
|
|
256 | reply has been lost. |
|
|
257 | .Sp |
|
|
258 | For congested links a higher value might be necessary (e.g. \f(CW30\fR). If |
|
|
259 | the link is very stable lower values (e.g. \f(CW2\fR) might work |
|
|
260 | nicely. Values near or below \f(CW1\fR makes no sense whatsoever. |
|
|
261 | .Sp |
|
|
262 | The default should be working \s-1OK\s0 for most links but will result in low |
|
|
263 | throughput if packet loss is high. |
207 | .IP "if-up = relative-or-absolute-path" 4 |
264 | .IP "if-up = relative-or-absolute-path" 4 |
208 | .IX Item "if-up = relative-or-absolute-path" |
265 | .IX Item "if-up = relative-or-absolute-path" |
209 | Sets the path of a script that should be called immediately after the |
266 | Sets the path of a script that should be called immediately after the |
210 | network interface is initialized (but not neccessarily up). The following |
267 | network interface is initialized (but not necessarily up). The following |
211 | environment variables are passed to it (the values are just examples): |
268 | environment variables are passed to it (the values are just examples). |
|
|
269 | .Sp |
|
|
270 | Variables that have the same value on all nodes: |
212 | .RS 4 |
271 | .RS 4 |
213 | .IP "CONFBASE=/etc/gvpe" 4 |
272 | .IP "CONFBASE=/etc/gvpe" 4 |
214 | .IX Item "CONFBASE=/etc/gvpe" |
273 | .IX Item "CONFBASE=/etc/gvpe" |
215 | The configuration base directory. |
274 | The configuration base directory. |
216 | .IP "IFNAME=vpn0" 4 |
275 | .IP "IFNAME=vpn0" 4 |
217 | .IX Item "IFNAME=vpn0" |
276 | .IX Item "IFNAME=vpn0" |
218 | The interface to initialize. |
277 | The network 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 |
278 | .IP "IFTYPE=native # or tincd" 4 |
235 | .IX Item "IFTYPE=native # or tincd" |
279 | .IX Item "IFTYPE=native # or tincd" |
236 | .PD 0 |
280 | .PD 0 |
237 | .IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 |
281 | .IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 |
238 | .IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." |
282 | .IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." |
239 | .PD |
283 | .PD |
240 | The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os |
284 | The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the |
241 | name in lowercase) that this gvpe was configured for. Can be used to select |
285 | \&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to |
242 | the correct syntax to use for network-related commands. |
286 | select the correct syntax to use for network-related commands. |
|
|
287 | .IP "MTU=1436" 4 |
|
|
288 | .IX Item "MTU=1436" |
|
|
289 | The \s-1MTU\s0 to set the interface to. You can use lower values (if done |
|
|
290 | consistently on all nodes), but this is usually either inefficient or |
|
|
291 | simply ineffective. |
|
|
292 | .IP "NODES=5" 4 |
|
|
293 | .IX Item "NODES=5" |
|
|
294 | The number of nodes in this \s-1GVPE\s0 network. |
|
|
295 | .RE |
|
|
296 | .RS 4 |
|
|
297 | .Sp |
|
|
298 | Variables that are node-specific and with values pertaining to the node |
|
|
299 | running this \s-1GVPE:\s0 |
|
|
300 | .IP "IFUPDATA=string" 4 |
|
|
301 | .IX Item "IFUPDATA=string" |
|
|
302 | The value of the configuration directive \f(CW\*(C`if\-up\-data\*(C'\fR. |
|
|
303 | .IP "MAC=fe:fd:80:00:00:01" 4 |
|
|
304 | .IX Item "MAC=fe:fd:80:00:00:01" |
|
|
305 | The \s-1MAC\s0 address the network interface has to use. |
|
|
306 | .Sp |
|
|
307 | Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not |
|
|
308 | do this automatically. Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR man page for |
|
|
309 | platform-specific information. |
243 | .IP "NODENAME=branch1" 4 |
310 | .IP "NODENAME=branch1" 4 |
244 | .IX Item "NODENAME=branch1" |
311 | .IX Item "NODENAME=branch1" |
245 | The nickname of the current node, as passed to the gvpe daemon. |
312 | The nickname of the node. |
246 | .IP "NODEID=1" 4 |
313 | .IP "NODEID=1" 4 |
247 | .IX Item "NODEID=1" |
314 | .IX Item "NODEID=1" |
248 | The numerical node id of the current node. The first node mentioned in the |
315 | The numerical node \s-1ID\s0 of the node running this instance of \s-1GVPE\s0. The first |
249 | config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on. |
316 | node mentioned in the config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on. |
250 | .RE |
317 | .RE |
251 | .RS 4 |
318 | .RS 4 |
252 | .Sp |
319 | .Sp |
|
|
320 | In addition, all node-specific variables (except \f(CW\*(C`NODEID\*(C'\fR) will be |
|
|
321 | available with a postfix of \f(CW\*(C`_nodeid\*(C'\fR, which contains the value for that |
|
|
322 | node, e.g. the \f(CW\*(C`MAC_1\*(C'\fR variable contains the \s-1MAC\s0 address of node #1, while |
|
|
323 | the \f(CW\*(C`NODENAME_22\*(C'\fR variable contains the name of node #22. |
|
|
324 | .Sp |
253 | Here is a simple if-up script: |
325 | Here is a simple if-up script: |
254 | .Sp |
326 | .Sp |
255 | .Vb 5 |
327 | .Vb 5 |
256 | \& #!/bin/sh |
328 | \& #!/bin/sh |
257 | \& ip link set $IFNAME address $MAC mtu $MTU up |
329 | \& ip link set $IFNAME up |
258 | \& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME |
330 | \& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME |
259 | \& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME |
331 | \& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME |
260 | \& ip route add 10.0.0.0/8 dev $IFNAME |
332 | \& ip route add 10.0.0.0/8 dev $IFNAME |
261 | .Ve |
333 | .Ve |
262 | .Sp |
334 | .Sp |
263 | More complicated examples (using routing to reduce arp traffic) can be |
335 | More complicated examples (using routing to reduce \s-1ARP\s0 traffic) can be |
264 | found in the etc/ subdirectory of the distribution. |
336 | found in the \fIetc/\fR subdirectory of the distribution. |
265 | .RE |
337 | .RE |
266 | .IP "ifname = devname" 4 |
338 | .IP "ifname = devname" 4 |
267 | .IX Item "ifname = devname" |
339 | .IX Item "ifname = devname" |
268 | Sets the tun interface name to the given name. The default is OS-specific |
340 | 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. |
341 | and most probably something like \f(CW\*(C`tun0\*(C'\fR. |
… | |
… | |
276 | the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the |
348 | the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the |
277 | device. |
349 | device. |
278 | .IP "ip-proto = numerical-ip-protocol" 4 |
350 | .IP "ip-proto = numerical-ip-protocol" 4 |
279 | .IX Item "ip-proto = numerical-ip-protocol" |
351 | .IX Item "ip-proto = numerical-ip-protocol" |
280 | Sets the protocol number to be used for the rawip protocol. This is a |
352 | 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 |
353 | global option because all nodes must use the same protocol, and since |
282 | there are no port numbers, you cannot easily run more than one gvpe |
354 | 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 |
355 | instance using the same protocol, nor can you share the protocol with |
284 | other programs. |
356 | other programs. |
285 | .Sp |
357 | .Sp |
286 | The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through |
358 | The default is 47 (\s-1GRE\s0), which has a good chance of tunneling |
287 | firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other |
359 | through firewalls (but note that gvpe's rawip protocol is not \s-1GRE\s0 |
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 |
360 | compatible). Other common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 |
289 | (\s-1ENCAP\s0, rfc1241) |
361 | (\s-1IPIP\s0 tunnels) or 98 (\s-1ENCAP\s0, rfc1241) |
290 | .IP "http-proxy-host = hostname/ip" 4 |
362 | .IP "http-proxy-host = hostname/ip" 4 |
291 | .IX Item "http-proxy-host = hostname/ip" |
363 | .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 |
364 | 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 |
365 | compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of |
294 | tcp connections through a http proxy server. |
366 | tcp connections through a http proxy server. |
… | |
… | |
296 | \&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and |
368 | \&\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 |
369 | port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy |
298 | requires authentication. |
370 | requires authentication. |
299 | .Sp |
371 | .Sp |
300 | Please note that gvpe will still try to resolve all hostnames in the |
372 | 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 |
373 | configuration file, so if you are behind a proxy without access to a \s-1DNS\s0 |
302 | server better use numerical \s-1IP\s0 addresses. |
374 | server better use numerical \s-1IP\s0 addresses. |
303 | .Sp |
375 | .Sp |
304 | To make best use of this option disable all protocols except tcp in your |
376 | To make best use of this option disable all protocols except \s-1TCP\s0 in your |
305 | config file and make sure your routers (or all other hosts) are listening |
377 | config file and make sure your routers (or all other nodes) are listening |
306 | on a port that the proxy allows (443, https, is a common choice). |
378 | on a port that the proxy allows (443, https, is a common choice). |
307 | .Sp |
379 | .Sp |
308 | If you have a router, connecting to it will suffice. Otherwise tcp must be |
380 | If you have a router, connecting to it will suffice. Otherwise \s-1TCP\s0 must be |
309 | enabled on all hosts. |
381 | enabled on all nodes. |
310 | .Sp |
382 | .Sp |
311 | Example: |
383 | Example: |
312 | .Sp |
384 | .Sp |
313 | .Vb 3 |
385 | .Vb 3 |
314 | \& http-proxy-host = proxy.example.com |
386 | \& http\-proxy\-host = proxy.example.com |
315 | \& http-proxy-port = 3128 # 8080 is another common choice |
387 | \& http\-proxy\-port = 3128 # 8080 is another common choice |
316 | \& http-proxy-auth = schmorp:grumbeere |
388 | \& http\-proxy\-auth = schmorp:grumbeere |
317 | .Ve |
389 | .Ve |
318 | .IP "http-proxy-port = proxy-tcp-port" 4 |
390 | .IP "http-proxy-port = proxy-tcp-port" 4 |
319 | .IX Item "http-proxy-port = proxy-tcp-port" |
391 | .IX Item "http-proxy-port = proxy-tcp-port" |
320 | The port where your proxy server listens. |
392 | The port where your proxy server listens. |
321 | .IP "http-proxy-auth = login:password" 4 |
393 | .IP "http-proxy-auth = login:password" 4 |
322 | .IX Item "http-proxy-auth = login:password" |
394 | .IX Item "http-proxy-auth = login:password" |
323 | The optional login and password used to authenticate to the proxy server, |
395 | 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 |
396 | separated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is |
325 | currently supported. |
397 | currently supported. |
326 | .IP "keepalive = seconds" 4 |
398 | .IP "keepalive = seconds" 4 |
327 | .IX Item "keepalive = seconds" |
399 | .IX Item "keepalive = seconds" |
328 | Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this |
400 | 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 |
401 | 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 |
402 | every 3 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 |
403 | is received within 15 seconds, the peer is considered unreachable and the |
332 | connection is closed. |
404 | connection is closed. |
333 | .IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 |
405 | .IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 |
334 | .IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" |
406 | .IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" |
335 | Set the logging level. Connection established messages are logged at level |
407 | 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. |
408 | \&\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 |
409 | .IP "mtu = bytes" 4 |
338 | .IX Item "mtu = bytes" |
410 | .IX Item "mtu = bytes" |
339 | Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically |
411 | 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 |
412 | 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 |
413 | maximum overhead (e.g. \s-1UDP\s0 header size, encryption blocksize...) and pass |
342 | this information to the \f(CW\*(C`if\-up\*(C'\fR script. |
414 | this information to the \f(CW\*(C`if\-up\*(C'\fR script. |
343 | .Sp |
415 | .Sp |
344 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
416 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
345 | .Sp |
417 | .Sp |
346 | This value must be the minimum of the mtu values of all hosts. |
418 | This value must be the minimum of the \s-1MTU\s0 values of all nodes. |
347 | .IP "node = nickname" 4 |
419 | .IP "node = nickname" 4 |
348 | .IX Item "node = nickname" |
420 | .IX Item "node = nickname" |
349 | Not really a config setting but introduces a node section. The nickname is |
421 | 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 |
422 | used to select the right configuration section and must be passed as an |
351 | argument to the gvpe daemon. |
423 | argument to the gvpe daemon. |
352 | .IP "node-up = relative-or-absolute-path" 4 |
424 | .IP "node-up = relative-or-absolute-path" 4 |
353 | .IX Item "node-up = relative-or-absolute-path" |
425 | .IX Item "node-up = relative-or-absolute-path" |
354 | Sets a command (default: no script) that should be called whenever a |
426 | Sets a command (default: none) that should be called whenever a connection |
355 | connection is established (even on rekeying operations). In addition |
427 | is established (even on rekeying operations). Note that node\-up/down |
|
|
428 | scripts will be run asynchronously, but execution is serialised, so there |
|
|
429 | will only ever be one such script running. |
|
|
430 | .Sp |
356 | to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment |
431 | In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following |
357 | variables will be set: |
432 | environment variables will be set: |
358 | .RS 4 |
433 | .RS 4 |
359 | .IP "DESTNODE=branch2" 4 |
434 | .IP "DESTNODE=branch2" 4 |
360 | .IX Item "DESTNODE=branch2" |
435 | .IX Item "DESTNODE=branch2" |
361 | The name of the remote node. |
436 | The name of the remote node. |
362 | .IP "DESTID=2" 4 |
437 | .IP "DESTID=2" 4 |
363 | .IX Item "DESTID=2" |
438 | .IX Item "DESTID=2" |
364 | The node id of the remote node. |
439 | The node id of the remote node. |
365 | .IP "DESTIP=188.13.66.8" 4 |
440 | .IP "DESTIP=188.13.66.8" 4 |
366 | .IX Item "DESTIP=188.13.66.8" |
441 | .IX Item "DESTIP=188.13.66.8" |
367 | The numerical \s-1IP\s0 address of the remote host (gvpe accepts connections from |
442 | The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from |
368 | everywhere, as long as the other host can authenticate itself). |
443 | everywhere, as long as the other node can authenticate itself). |
369 | .IP "DESTPORT=655 # deprecated" 4 |
444 | .IP "DESTPORT=655 # deprecated" 4 |
370 | .IX Item "DESTPORT=655 # deprecated" |
445 | .IX Item "DESTPORT=655 # deprecated" |
371 | The \s-1UDP\s0 port used by the other side. |
446 | The \s-1UDP\s0 port used by the other side. |
372 | .IP "STATE=UP" 4 |
447 | .IP "STATE=UP" 4 |
373 | .IX Item "STATE=UP" |
448 | .IX Item "STATE=UP" |
… | |
… | |
375 | with STATE=DOWN. |
450 | with STATE=DOWN. |
376 | .RE |
451 | .RE |
377 | .RS 4 |
452 | .RS 4 |
378 | .Sp |
453 | .Sp |
379 | Here is a nontrivial example that uses nsupdate to update the name => ip |
454 | Here is a nontrivial example that uses nsupdate to update the name => ip |
380 | mapping in some dns zone: |
455 | mapping in some \s-1DNS\s0 zone: |
381 | .Sp |
456 | .Sp |
382 | .Vb 6 |
457 | .Vb 6 |
383 | \& #!/bin/sh |
458 | \& #!/bin/sh |
384 | \& { |
459 | \& { |
385 | \& echo update delete $DESTNODE.lowttl.example.net. a |
460 | \& echo update delete $DESTNODE.lowttl.example.net. a |
386 | \& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP |
461 | \& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP |
387 | \& echo |
462 | \& echo |
388 | \& } | nsupdate -d -k $CONFBASE:key.example.net. |
463 | \& } | nsupdate \-d \-k $CONFBASE:key.example.net. |
389 | .Ve |
464 | .Ve |
390 | .RE |
465 | .RE |
391 | .IP "node-down = relative-or-absolute-path" 4 |
466 | .IP "node-down = relative-or-absolute-path" 4 |
392 | .IX Item "node-down = relative-or-absolute-path" |
467 | .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. |
468 | Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. |
… | |
… | |
402 | be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could |
477 | 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 |
478 | 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. |
479 | \&\f(CW\*(C`gvpectrl\*(C'\fR puts them. |
405 | .Sp |
480 | .Sp |
406 | Since only the private key file of the current node is used and the |
481 | 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 |
482 | private key file should be kept secret per-node to avoid spoofing, it is |
408 | not recommended to use this feature. |
483 | not recommended to use this feature. |
409 | .IP "rekey = seconds" 4 |
484 | .IP "rekey = seconds" 4 |
410 | .IX Item "rekey = seconds" |
485 | .IX Item "rekey = seconds" |
411 | Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are |
486 | Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are |
412 | reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. |
487 | reestablished every \f(CW\*(C`rekey\*(C'\fR seconds, making them use a new encryption |
|
|
488 | key. |
413 | .Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
489 | .Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
414 | .IX Subsection "NODE SPECIFIC SETTINGS" |
490 | .IX Subsection "NODE SPECIFIC SETTINGS" |
415 | The following settings are node\-specific, that is, every node can have |
491 | The following settings are node-specific, that is, every node can have |
416 | different settings, even within the same gvpe instance. Settings that are |
492 | different settings, even within the same gvpe instance. Settings that are |
417 | executed before the first node section set the defaults, settings that are |
493 | set before the first node section set the defaults, settings that are |
418 | executed within a node section only apply to the given node. |
494 | set within a node section only apply to the given node. |
|
|
495 | .IP "allow-direct = nodename" 4 |
|
|
496 | .IX Item "allow-direct = nodename" |
|
|
497 | Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info. |
419 | .IP "compress = yes|true|on | no|false|off" 4 |
498 | .IP "compress = yes|true|on | no|false|off" 4 |
420 | .IX Item "compress = yes|true|on | no|false|off" |
499 | .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). |
500 | Wether to compress data packets sent to this node (default: \f(CW\*(C`yes\*(C'\fR). |
422 | Compression is really cheap even on slow computers and has no size |
501 | Compression is really cheap even on slow computers and has no size |
423 | overhead at all, so enabling this is a good idea. |
502 | overhead at all, so enabling this is often a good idea. |
424 | .IP "connect = ondemand | never | always | disabled" 4 |
503 | .IP "connect = ondemand | never | always | disabled" 4 |
425 | .IX Item "connect = ondemand | never | always | disabled" |
504 | .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 |
505 | 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 |
506 | try to establish and keep a connection to the given node), \f(CW\*(C`never\*(C'\fR |
428 | (never initiate a connection to the given host, but accept connections), |
507 | (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 |
508 | \&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection when there are outstanding |
430 | take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, |
509 | packets in the queue and take it down after the keepalive interval) or |
431 | don't talk to it). |
510 | \&\f(CW\*(C`disabled\*(C'\fR (node is bad, don't talk to it). |
|
|
511 | .Sp |
|
|
512 | Routers will automatically be forced to \f(CW\*(C`always\*(C'\fR unless they are |
|
|
513 | \&\f(CW\*(C`disabled\*(C'\fR, to ensure all nodes can talk to each other. |
|
|
514 | .IP "deny-direct = nodename | *" 4 |
|
|
515 | .IX Item "deny-direct = nodename | *" |
|
|
516 | Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR |
|
|
517 | is given). Only one node can be specified, but you can use multiple |
|
|
518 | \&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in |
|
|
519 | networks with routers, as routers are required for indirect connections. |
|
|
520 | .Sp |
|
|
521 | Sometimes, a node cannot reach some other nodes for reasons of network |
|
|
522 | connectivity. For example, a node behind a firewall that only allows |
|
|
523 | connections to/from a single other node in the network. In this case one |
|
|
524 | should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other |
|
|
525 | node \fImust\fR be a router for this to work). |
|
|
526 | .Sp |
|
|
527 | The algorithm to check whether a connection may be direct is as follows: |
|
|
528 | .Sp |
|
|
529 | 1. Other node mentioned in an \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection. |
|
|
530 | .Sp |
|
|
531 | 2. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections. |
|
|
532 | .Sp |
|
|
533 | 3. Allow the connection. |
|
|
534 | .Sp |
|
|
535 | That is, \f(CW\*(C`allow\-direct\*(C'\fR takes precedence over \f(CW\*(C`deny\-direct\*(C'\fR. |
|
|
536 | .Sp |
|
|
537 | The check is done in both directions, i.e. both nodes must allow a direct |
|
|
538 | connection before one is attempted, so you only need to specify connect |
|
|
539 | limitations on one node. |
432 | .IP "dns-domain = domain-suffix" 4 |
540 | .IP "dns-domain = domain-suffix" 4 |
433 | .IX Item "dns-domain = domain-suffix" |
541 | .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. |
542 | The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node. |
435 | .Sp |
543 | .Sp |
436 | The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, |
544 | The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, |
437 | i.e. |
545 | i.e. |
438 | .Sp |
546 | .Sp |
439 | .Vb 2 |
547 | .Vb 2 |
440 | \& dns-domainname = tunnel.example.net |
548 | \& dns\-domainname = tunnel.example.net |
441 | \& dns-hostname = tunnel-server.example.net |
549 | \& dns\-hostname = tunnel\-server.example.net |
442 | .Ve |
550 | .Ve |
443 | .Sp |
551 | .Sp |
444 | Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain: |
552 | Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain: |
445 | .Sp |
553 | .Sp |
446 | .Vb 2 |
554 | .Vb 2 |
447 | \& tunnel.example.net. NS tunnel-server.example.net. |
555 | \& tunnel.example.net. NS tunnel\-server.example.net. |
448 | \& tunnel-server.example.net. A 13.13.13.13 |
556 | \& tunnel\-server.example.net. A 13.13.13.13 |
449 | .Ve |
557 | .Ve |
450 | .IP "dns-hostname = hostname/ip" 4 |
558 | .IP "dns-hostname = hostname/ip" 4 |
451 | .IX Item "dns-hostname = hostname/ip" |
559 | .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, |
560 | 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 |
561 | but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might |
… | |
… | |
465 | was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option. |
573 | was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option. |
466 | .IP "enable-icmp = yes|true|on | no|false|off" 4 |
574 | .IP "enable-icmp = yes|true|on | no|false|off" 4 |
467 | .IX Item "enable-icmp = yes|true|on | no|false|off" |
575 | .IX Item "enable-icmp = yes|true|on | no|false|off" |
468 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol. |
576 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol. |
469 | .Sp |
577 | .Sp |
470 | Enable the \s-1ICMP\s0 transport using icmp packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this |
578 | Enable the \s-1ICMP\s0 transport using \s-1ICMP\s0 packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this |
471 | node. |
579 | node. |
472 | .IP "enable-rawip = yes|true|on | no|false|off" 4 |
580 | .IP "enable-rawip = yes|true|on | no|false|off" 4 |
473 | .IX Item "enable-rawip = yes|true|on | no|false|off" |
581 | .IX Item "enable-rawip = yes|true|on | no|false|off" |
474 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol. |
582 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol. |
475 | .Sp |
583 | .Sp |
… | |
… | |
488 | .Sp |
596 | .Sp |
489 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, |
597 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, |
490 | unless no other protocol is enabled for a node, in which case this |
598 | unless no other protocol is enabled for a node, in which case this |
491 | protocol is enabled automatically). |
599 | protocol is enabled automatically). |
492 | .Sp |
600 | .Sp |
493 | \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though |
601 | \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want to use it even though |
494 | it might get switched on automatically, as some future version might |
602 | it might get switched on automatically, as some future version might |
495 | default to another default protocol. |
603 | default to another default protocol. |
|
|
604 | .IP "hostname = hostname | ip [can not be defaulted]" 4 |
|
|
605 | .IX Item "hostname = hostname | ip [can not be defaulted]" |
|
|
606 | Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0 |
|
|
607 | address. It will be resolved before each connect request, so dyndns should |
|
|
608 | work fine. If this setting is not specified and a router is available, |
|
|
609 | then the router will be queried for the address of this node. Otherwise, |
|
|
610 | the connection attempt will fail. |
|
|
611 | .Sp |
|
|
612 | Note that \s-1DNS\s0 resolving is done synchronously, pausing the daemon. If that |
|
|
613 | is an issue you need to specify \s-1IP\s0 addresses. |
496 | .IP "icmp-type = integer" 4 |
614 | .IP "icmp-type = integer" 4 |
497 | .IX Item "icmp-type = integer" |
615 | .IX Item "icmp-type = integer" |
498 | Sets the type value to be used for outgoing (and incoming) packets sent |
616 | Sets the type value to be used for outgoing (and incoming) packets sent |
499 | via the \s-1ICMP\s0 transport. |
617 | via the \s-1ICMP\s0 transport. |
500 | .Sp |
618 | .Sp |
501 | The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as |
619 | The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as |
502 | \&\*(L"ping\-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. |
620 | \&\*(L"ping-reply\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. |
503 | \&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. |
621 | \&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. |
|
|
622 | .IP "if-up-data = value" 4 |
|
|
623 | .IX Item "if-up-data = value" |
|
|
624 | The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR |
|
|
625 | script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR. |
504 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
626 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
505 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
627 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
506 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
628 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
507 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
629 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
508 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
630 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
509 | to the tunnel device, which is usually what you want. |
631 | to the tunnel device, which is usually what you want. |
510 | .IP "max-retry = positive-number" 4 |
632 | .IP "max-retry = positive-number" 4 |
511 | .IX Item "max-retry = positive-number" |
633 | .IX Item "max-retry = positive-number" |
512 | The maximum interval in seconds (default: \f(CW3600\fR, one hour) between |
634 | The maximum interval in seconds (default: \f(CW3600\fR, one hour) between |
513 | retries to establish a connection to this node. When a connection cannot |
635 | retries to establish a connection to this node. When a connection cannot |
514 | be established, gvpe uses exponential backoff capped at this value. It's |
636 | be established, gvpe uses exponential back-off capped at this value. It's |
515 | sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on |
637 | sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on |
516 | connections to routers that usually are stable but sometimes are down, to |
638 | connections to routers that usually are stable but sometimes are down, to |
517 | assure quick reconnections even after longer downtimes. |
639 | assure quick reconnections even after longer downtimes. |
|
|
640 | .IP "max-ttl = seconds" 4 |
|
|
641 | .IX Item "max-ttl = seconds" |
|
|
642 | Expire packets that couldn't be sent after this many seconds |
|
|
643 | (default: \f(CW60\fR). Gvpe will normally queue packets for a node without an |
|
|
644 | active connection, in the hope of establishing a connection soon. This |
|
|
645 | value specifies the maximum lifetime a packet will stay in the queue, if a |
|
|
646 | packet gets older, it will be thrown away. |
|
|
647 | .IP "max-queue = positive\-number>=1" 4 |
|
|
648 | .IX Item "max-queue = positive-number>=1" |
|
|
649 | The maximum number of packets that will be queued (default: \f(CW512\fR) |
|
|
650 | for this node. If more packets are sent then earlier packets will be |
|
|
651 | expired. See \f(CW\*(C`max\-ttl\*(C'\fR, above. |
518 | .IP "router-priority = 0 | 1 | positive\-number>=2" 4 |
652 | .IP "router-priority = 0 | 1 | positive\-number>=2" 4 |
519 | .IX Item "router-priority = 0 | 1 | positive-number>=2" |
653 | .IX Item "router-priority = 0 | 1 | positive-number>=2" |
520 | Sets the router priority of the given host (default: \f(CW0\fR, disabled). If |
654 | Sets the router priority of the given node (default: \f(CW0\fR, disabled). |
521 | some host tries to connect to another host without a hostname, it asks |
|
|
522 | the router host for it's \s-1IP\s0 address. The router host is the one with the |
|
|
523 | highest priority larger than \f(CW1\fR that is currently reachable. |
|
|
524 | .Sp |
655 | .Sp |
525 | Make sure all hosts always connect (\f(CW\*(C`connect = always\*(C'\fR) to the router |
656 | If some node tries to connect to another node but it doesn't have a |
526 | hosts, otherwise connecting to them might be impossible. |
657 | hostname, it asks a router node for it's \s-1IP\s0 address. The router node |
|
|
658 | chosen is the one with the highest priority larger than \f(CW1\fR that is |
|
|
659 | currently reachable. This is called a \fImediated\fR connection, as the |
|
|
660 | connection itself will still be direct, but it uses another node to |
|
|
661 | mediate between the two nodes. |
|
|
662 | .Sp |
|
|
663 | The value \f(CW0\fR disables routing, that means if the node receives a packet |
|
|
664 | not for itself it will not forward it but instead drop it. |
527 | .Sp |
665 | .Sp |
528 | The special value \f(CW1\fR allows other hosts to route through the router |
666 | The special value \f(CW1\fR allows other hosts to route through the router |
529 | host, but they will never route through it by default. The value \f(CW0\fR |
667 | host, but they will never route through it by default (i.e. the config |
530 | disables routing. The idea behind this is that some hosts can, if |
668 | file of another node needs to specify a router priority higher than one |
|
|
669 | to choose such a node for routing). |
|
|
670 | .Sp |
|
|
671 | The idea behind this is that some hosts can, if required, bump the |
531 | required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their |
672 | \&\f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their local config to |
532 | local config to route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is |
673 | route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is \f(CW0\fR, then routing |
533 | \&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do |
674 | will be refused, so \f(CW1\fR serves as a \*(L"enable, but do not use by default\*(R" |
534 | not use by default\*(R" switch. |
675 | switch. |
|
|
676 | .Sp |
|
|
677 | Nodes with \f(CW\*(C`router\-priority\*(C'\fR set to \f(CW2\fR or higher will always be forced |
|
|
678 | to \f(CW\*(C`connect\*(C'\fR = \f(CW\*(C`always\*(C'\fR (unless they are \f(CW\*(C`disabled\*(C'\fR). |
535 | .IP "tcp-port = port-number" 4 |
679 | .IP "tcp-port = port-number" 4 |
536 | .IX Item "tcp-port = port-number" |
680 | .IX Item "tcp-port = port-number" |
537 | Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. |
681 | Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. |
538 | .IP "udp-port = port-number" 4 |
682 | .IP "udp-port = port-number" 4 |
539 | .IX Item "udp-port = port-number" |
683 | .IX Item "udp-port = port-number" |
540 | Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not |
684 | Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not |
541 | officially assigned by \s-1IANA\s0!). |
685 | officially assigned by \s-1IANA\s0!). |
542 | .SH "CONFIG DIRECTORY LAYOUT" |
686 | .SH "CONFIG DIRECTORY LAYOUT" |
543 | .IX Header "CONFIG DIRECTORY LAYOUT" |
687 | .IX Header "CONFIG DIRECTORY LAYOUT" |
544 | The default (or recommended) directory layout for the config directory is: |
688 | The default (or recommended) directory layout for the config directory is: |
545 | .IP "\(bu" 4 |
689 | .IP "" 4 |
546 | .IX Xref "gvpe.conf" |
690 | .IX Xref "gvpe.conf" |
547 | The config file. |
691 | The config file. |
548 | .IP "\(bu" 4 |
692 | .IP "" 4 |
549 | .IX Xref "if-up" |
693 | .IX Xref "if-up" |
550 | The if-up script |
694 | The if-up script |
551 | .IP "," 4 |
695 | .IP "," 4 |
552 | .IX Xref "node-up node-down" |
696 | .IX Xref "node-up node-down" |
553 | If used the node up or node-down scripts. |
697 | If used the node up or node-down scripts. |
554 | .IP "\(bu" 4 |
698 | .IP "" 4 |
555 | .IX Xref "hostkey" |
699 | .IX Xref "hostkey" |
556 | The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. |
700 | The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. |
557 | .IP "\(bu" 4 |
701 | .IP "" 4 |
558 | .IX Xref "pubkey nodename" |
702 | .IX Xref "pubkey nodename" |
559 | The public keys of the other nodes, one file per node. |
703 | The public keys of the other nodes, one file per node. |
560 | .SH "SEE ALSO" |
704 | .SH "SEE ALSO" |
561 | .IX Header "SEE ALSO" |
705 | .IX Header "SEE ALSO" |
562 | \&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). |
706 | \&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). |
563 | .SH "AUTHOR" |
707 | .SH "AUTHOR" |
564 | .IX Header "AUTHOR" |
708 | .IX Header "AUTHOR" |
565 | Marc Lehmann <gvpe@plan9.de> |
709 | Marc Lehmann <gvpe@schmorp.de> |