1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 |
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 |
… | |
… | |
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.PROTOCOL 7" |
134 | .IX Title "GVPE.PROTOCOL 7" |
132 | .TH GVPE.PROTOCOL 7 "2008-08-10" "2.2" "GNU Virtual Private Ethernet" |
135 | .TH GVPE.PROTOCOL 7 "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 "The GNU-VPE Protocols" |
140 | .SH "The GNU-VPE Protocols" |
134 | .IX Header "The GNU-VPE Protocols" |
141 | .IX Header "The GNU-VPE Protocols" |
135 | .SH "Overview" |
142 | .SH "Overview" |
136 | .IX Header "Overview" |
143 | .IX Header "Overview" |
137 | \&\s-1GVPE\s0 can make use of a number of protocols. One of them is the \s-1GNU\s0 \s-1VPE\s0 |
144 | \&\s-1GVPE\s0 can make use of a number of protocols. One of them is the \s-1GNU\s0 \s-1VPE\s0 |
… | |
… | |
150 | The following sections describe each transport protocol in more |
157 | The following sections describe each transport protocol in more |
151 | detail. They are sorted by overhead/efficiency, the most efficient |
158 | detail. They are sorted by overhead/efficiency, the most efficient |
152 | transport is listed first: |
159 | transport is listed first: |
153 | .Sh "\s-1RAW\s0 \s-1IP\s0" |
160 | .Sh "\s-1RAW\s0 \s-1IP\s0" |
154 | .IX Subsection "RAW IP" |
161 | .IX Subsection "RAW IP" |
155 | This protocol is the best choice, performance\-wise, as the minimum |
162 | This protocol is the best choice, performance-wise, as the minimum |
156 | overhead per packet is only 38 bytes. |
163 | overhead per packet is only 38 bytes. |
157 | .PP |
164 | .PP |
158 | It works by sending the \s-1VPN\s0 payload using raw ip frames (using the |
165 | It works by sending the \s-1VPN\s0 payload using raw \s-1IP\s0 frames (using the |
159 | protocol set by \f(CW\*(C`ip\-proto\*(C'\fR). |
166 | protocol set by \f(CW\*(C`ip\-proto\*(C'\fR). |
160 | .PP |
167 | .PP |
161 | Using raw ip frames has the drawback that many firewalls block \*(L"unknown\*(R" |
168 | Using raw \s-1IP\s0 frames has the drawback that many firewalls block \*(L"unknown\*(R" |
162 | protocols, so this transport only works if you have full \s-1IP\s0 connectivity |
169 | protocols, so this transport only works if you have full \s-1IP\s0 connectivity |
163 | between nodes. |
170 | between nodes. |
164 | .Sh "\s-1ICMP\s0" |
171 | .Sh "\s-1ICMP\s0" |
165 | .IX Subsection "ICMP" |
172 | .IX Subsection "ICMP" |
166 | This protocol offers very low overhead (minimum 42 bytes), and can |
173 | This protocol offers very low overhead (minimum 42 bytes), and can |
167 | sometimes tunnel through firewalls when other protocols can not. |
174 | sometimes tunnel through firewalls when other protocols can not. |
168 | .PP |
175 | .PP |
169 | It works by prepending an \s-1ICMP\s0 header with type \f(CW\*(C`icmp\-type\*(C'\fR and a code |
176 | It works by prepending an \s-1ICMP\s0 header with type \f(CW\*(C`icmp\-type\*(C'\fR and a code |
170 | of \f(CW255\fR. The default \f(CW\*(C`icmp\-type\*(C'\fR is \f(CW\*(C`echo\-reply\*(C'\fR, so the resulting |
177 | of \f(CW255\fR. The default \f(CW\*(C`icmp\-type\*(C'\fR is \f(CW\*(C`echo\-reply\*(C'\fR, so the resulting |
171 | packets look like echo replies, which looks rather strange to network |
178 | packets look like echo replies, which looks rather strange to network |
172 | admins. |
179 | administrators. |
173 | .PP |
180 | .PP |
174 | This transport should only be used if other transports (i.e. raw ip) are |
181 | This transport should only be used if other transports (i.e. raw \s-1IP\s0) are |
175 | not available or undesirable (due to their overhead). |
182 | not available or undesirable (due to their overhead). |
176 | .Sh "\s-1UDP\s0" |
183 | .Sh "\s-1UDP\s0" |
177 | .IX Subsection "UDP" |
184 | .IX Subsection "UDP" |
178 | This is a good general choice for the transport protocol as \s-1UDP\s0 packets |
185 | This is a good general choice for the transport protocol as \s-1UDP\s0 packets |
179 | tunnel well through most firewalls and routers, and the overhead per |
186 | tunnel well through most firewalls and routers, and the overhead per |
… | |
… | |
197 | It is an abuse of the usage a proxy was designed for, so make sure you are |
204 | It is an abuse of the usage a proxy was designed for, so make sure you are |
198 | allowed to use it for \s-1GVPE\s0. |
205 | allowed to use it for \s-1GVPE\s0. |
199 | .PP |
206 | .PP |
200 | This protocol also has server and client sides. If the \f(CW\*(C`tcp\-port\*(C'\fR is |
207 | This protocol also has server and client sides. If the \f(CW\*(C`tcp\-port\*(C'\fR is |
201 | set to zero, other nodes cannot connect to this node directly. If the |
208 | set to zero, other nodes cannot connect to this node directly. If the |
202 | \&\f(CW\*(C`tcp\-port\*(C'\fR is non\-zero, the node can act both as a client as well as a |
209 | \&\f(CW\*(C`tcp\-port\*(C'\fR is non-zero, the node can act both as a client as well as a |
203 | server. |
210 | server. |
204 | .Sh "\s-1DNS\s0" |
211 | .Sh "\s-1DNS\s0" |
205 | .IX Subsection "DNS" |
212 | .IX Subsection "DNS" |
206 | \&\fB\s-1WARNING:\s0\fR Parsing and generating \s-1DNS\s0 packets is rather tricky. The code |
213 | \&\fB\s-1WARNING:\s0\fR Parsing and generating \s-1DNS\s0 packets is rather tricky. The code |
207 | almost certainly contains buffer overflows and other, likely exploitable, |
214 | almost certainly contains buffer overflows and other, likely exploitable, |
… | |
… | |
224 | and an \f(CW\*(C`NS\*(C'\fR record pointing to the \s-1GVPE\s0 server (as given by the |
231 | and an \f(CW\*(C`NS\*(C'\fR record pointing to the \s-1GVPE\s0 server (as given by the |
225 | \&\f(CW\*(C`dns\-hostname\*(C'\fR directive). |
232 | \&\f(CW\*(C`dns\-hostname\*(C'\fR directive). |
226 | .PP |
233 | .PP |
227 | The only good side of this protocol is that it can tunnel through most |
234 | The only good side of this protocol is that it can tunnel through most |
228 | firewalls mostly undetected, iff the local \s-1DNS\s0 server/forwarder is sane |
235 | firewalls mostly undetected, iff the local \s-1DNS\s0 server/forwarder is sane |
229 | (which is true for most routers, \s-1WLAN\s0 gateways and nameservers). |
236 | (which is true for most routers, wireless \s-1LAN\s0 gateways and nameservers). |
230 | .PP |
237 | .PP |
231 | Finetuning needs to be done by editing \f(CW\*(C`src/vpn_dns.C\*(C'\fR directly. |
238 | Fine-tuning needs to be done by editing \f(CW\*(C`src/vpn_dns.C\*(C'\fR directly. |
232 | .SH "PART 2: The GNU VPE protocol" |
239 | .SH "PART 2: The GNU VPE protocol" |
233 | .IX Header "PART 2: The GNU VPE protocol" |
240 | .IX Header "PART 2: The GNU VPE protocol" |
234 | This section, unfortunately, is not yet finished, although the protocol |
241 | This section, unfortunately, is not yet finished, although the protocol |
235 | is stable (until bugs in the cryptography are found, which will likely |
242 | is stable (until bugs in the cryptography are found, which will likely |
236 | completely change the following description). Nevertheless, it should give |
243 | completely change the following description). Nevertheless, it should give |
237 | you some overview over the protocol. |
244 | you some overview over the protocol. |
238 | .Sh "Anatomy of a \s-1VPN\s0 packet" |
245 | .Sh "Anatomy of a \s-1VPN\s0 packet" |
239 | .IX Subsection "Anatomy of a VPN packet" |
246 | .IX Subsection "Anatomy of a VPN packet" |
240 | The exact layout and field lengths of a \s-1VPN\s0 packet is determined at |
247 | The exact layout and field lengths of a \s-1VPN\s0 packet is determined at |
241 | compiletime and doesn't change. The same structure is used for all |
248 | compile time and doesn't change. The same structure is used for all |
242 | transort protocols, be it \s-1RAWIP\s0 or \s-1TCP\s0. |
249 | transport protocols, be it \s-1RAWIP\s0 or \s-1TCP\s0. |
243 | .PP |
250 | .PP |
244 | .Vb 3 |
251 | .Vb 3 |
245 | \& +\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-+ |
252 | \& +\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-+ |
246 | \& | HMAC | TYPE | SRCDST | DATA | |
253 | \& | HMAC | TYPE | SRCDST | DATA | |
247 | \& +\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-+ |
254 | \& +\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-+ |
… | |
… | |
275 | initialization and starts at some random 31 bit value. \s-1VPE\s0 currently uses |
282 | initialization and starts at some random 31 bit value. \s-1VPE\s0 currently uses |
276 | a sliding window of 512 packets/sequence numbers to detect reordering, |
283 | a sliding window of 512 packets/sequence numbers to detect reordering, |
277 | duplication and replay attacks. |
284 | duplication and replay attacks. |
278 | .Sh "The authentication protocol" |
285 | .Sh "The authentication protocol" |
279 | .IX Subsection "The authentication protocol" |
286 | .IX Subsection "The authentication protocol" |
280 | Before hosts can exchange packets, they need to establish authenticity of |
287 | Before nodes can exchange packets, they need to establish authenticity of |
281 | the other side and a key. Every host has a private \s-1RSA\s0 key and the public |
288 | the other side and a key. Every node has a private \s-1RSA\s0 key and the public |
282 | \&\s-1RSA\s0 keys of all other hosts. |
289 | \&\s-1RSA\s0 keys of all other nodes. |
283 | .PP |
290 | .PP |
284 | A host establishes a simplex connection by sending the other host an |
291 | A host establishes a simplex connection by sending the other node an |
285 | \&\s-1RSA\s0 encrypted challenge containing a random challenge (consisting of |
292 | \&\s-1RSA\s0 encrypted challenge containing a random challenge (consisting of |
286 | the encryption key to use when sending packets, more random data and |
293 | the encryption key to use when sending packets, more random data and |
287 | \&\s-1PKCS1_OAEP\s0 padding) and a random 16 byte \*(L"challenge\-id\*(R" (used to detect |
294 | \&\s-1PKCS1_OAEP\s0 padding) and a random 16 byte \*(L"challenge-id\*(R" (used to detect |
288 | duplicate auth packets). The destination host will respond by replying |
295 | duplicate auth packets). The destination node will respond by replying |
289 | with an (unencrypted) \s-1RIPEMD160\s0 hash of the decrypted challenge, which |
296 | with an (unencrypted) \s-1RIPEMD160\s0 hash of the decrypted challenge, which |
290 | will authenticate that host. The destination host will also set the |
297 | will authenticate that node. The destination node will also set the |
291 | outgoing encryption parameters as given in the packet. |
298 | outgoing encryption parameters as given in the packet. |
292 | .PP |
299 | .PP |
293 | When the source host receives a correct auth reply (by verifying the |
300 | When the source node receives a correct auth reply (by verifying the |
294 | hash and the id, which will expire after 120 seconds), it will start to |
301 | hash and the id, which will expire after 120 seconds), it will start to |
295 | accept data packets from the destination host. |
302 | accept data packets from the destination node. |
296 | .PP |
303 | .PP |
297 | This means that a host can only initate a simplex connection, telling the |
304 | This means that a node can only initiate a simplex connection, telling the |
298 | other side the key it has to use when it sends packets. The challenge |
305 | other side the key it has to use when it sends packets. The challenge |
299 | reply is only used to set the current \s-1IP\s0 address of the other side and |
306 | reply is only used to set the current \s-1IP\s0 address of the other side and |
300 | protocol parameters. |
307 | protocol parameters. |
301 | .PP |
308 | .PP |
302 | This protocol is completely symmetric, so to be able to send packets the |
309 | This protocol is completely symmetric, so to be able to send packets the |
303 | destination host must send a challenge in the exact same way as already |
310 | destination node must send a challenge in the exact same way as already |
304 | described (so, in essence, two simplex connections are created per host |
311 | described (so, in essence, two simplex connections are created per node |
305 | pair). |
312 | pair). |
306 | .Sh "Retrying" |
313 | .Sh "Retrying" |
307 | .IX Subsection "Retrying" |
314 | .IX Subsection "Retrying" |
308 | When there is no response to an auth request, the host will send auth |
315 | When there is no response to an auth request, the node will send auth |
309 | requests in bursts with an exponential backoff. After some time it will |
316 | requests in bursts with an exponential back-off. After some time it will |
310 | resort to \s-1PING\s0 packets, which are very small (8 bytes + protocol header) |
317 | resort to \s-1PING\s0 packets, which are very small (8 bytes + protocol header) |
311 | and lightweight (no \s-1RSA\s0 operations required). A host that receives ping |
318 | and lightweight (no \s-1RSA\s0 operations required). A node that receives ping |
312 | requests from an unconnected peer will respond by trying to create a |
319 | requests from an unconnected peer will respond by trying to create a |
313 | connection. |
320 | connection. |
314 | .PP |
321 | .PP |
315 | In addition to the exponential backoff, there is a global rate-limit on |
322 | In addition to the exponential back-off, there is a global rate-limit on |
316 | a per-IP base. It allows long bursts but will limit total packet rate to |
323 | a per-IP base. It allows long bursts but will limit total packet rate to |
317 | something like one control packet every ten seconds, to avoid accidental |
324 | something like one control packet every ten seconds, to avoid accidental |
318 | floods due to protocol problems (like a \s-1RSA\s0 key file mismatch between two |
325 | floods due to protocol problems (like a \s-1RSA\s0 key file mismatch between two |
319 | hosts). |
326 | nodes). |
320 | .PP |
327 | .PP |
321 | The intervals between retries are limited by the \f(CW\*(C`max\-retry\*(C'\fR |
328 | The intervals between retries are limited by the \f(CW\*(C`max\-retry\*(C'\fR |
322 | configuration value. A node with \f(CW\*(C`connect\*(C'\fR = \f(CW\*(C`always\*(C'\fR will always retry, |
329 | configuration value. A node with \f(CW\*(C`connect\*(C'\fR = \f(CW\*(C`always\*(C'\fR will always retry, |
323 | a node with \f(CW\*(C`connect\*(C'\fR = \f(CW\*(C`ondemand\*(C'\fR will only try (and re\-try) to connect |
330 | a node with \f(CW\*(C`connect\*(C'\fR = \f(CW\*(C`ondemand\*(C'\fR will only try (and re-try) to connect |
324 | as long as there are packets in the queue, usually this limits the retry |
331 | as long as there are packets in the queue, usually this limits the retry |
325 | period to \f(CW\*(C`max\-ttl\*(C'\fR seconds. |
332 | period to \f(CW\*(C`max\-ttl\*(C'\fR seconds. |
326 | .PP |
333 | .PP |
327 | Sending packets over the \s-1VPN\s0 will reset the retry intervals as well, which |
334 | Sending packets over the \s-1VPN\s0 will reset the retry intervals as well, which |
328 | means as long as somebody is trying to send packets to a given node, \s-1GVPE\s0 |
335 | means as long as somebody is trying to send packets to a given node, \s-1GVPE\s0 |
… | |
… | |
330 | .Sh "Routing and Protocol translation" |
337 | .Sh "Routing and Protocol translation" |
331 | .IX Subsection "Routing and Protocol translation" |
338 | .IX Subsection "Routing and Protocol translation" |
332 | The \s-1GVPE\s0 routing algorithm is easy: there isn't much routing to speak |
339 | The \s-1GVPE\s0 routing algorithm is easy: there isn't much routing to speak |
333 | of: When routing packets to another node, \s-1GVPE\s0 trues the following |
340 | of: When routing packets to another node, \s-1GVPE\s0 trues the following |
334 | options, in order: |
341 | options, in order: |
335 | .IP "If the two hosts should be able to reach each other directly (common protocol, port known), then \s-1GVPE\s0 will send the packet directly to the other node." 4 |
342 | .IP "If the two nodes should be able to reach each other directly (common protocol, port known), then \s-1GVPE\s0 will send the packet directly to the other node." 4 |
336 | .IX Item "If the two hosts should be able to reach each other directly (common protocol, port known), then GVPE will send the packet directly to the other node." |
343 | .IX Item "If the two nodes should be able to reach each other directly (common protocol, port known), then GVPE will send the packet directly to the other node." |
337 | .PD 0 |
344 | .PD 0 |
338 | .ie n .IP "If this isn't possible (e.g. because the node doesn't have a \*(C`hostname\*(C' or known port), but the nodes speak a common protocol and a router is available, then \s-1GVPE\s0 will ask a router to ""mediate"" between both nodes (see below)." 4 |
345 | .ie n .IP "If this isn't possible (e.g. because the node doesn't have a \*(C`hostname\*(C' or known port), but the nodes speak a common protocol and a router is available, then \s-1GVPE\s0 will ask a router to ""mediate"" between both nodes (see below)." 4 |
339 | .el .IP "If this isn't possible (e.g. because the node doesn't have a \f(CW\*(C`hostname\*(C'\fR or known port), but the nodes speak a common protocol and a router is available, then \s-1GVPE\s0 will ask a router to ``mediate'' between both nodes (see below)." 4 |
346 | .el .IP "If this isn't possible (e.g. because the node doesn't have a \f(CW\*(C`hostname\*(C'\fR or known port), but the nodes speak a common protocol and a router is available, then \s-1GVPE\s0 will ask a router to ``mediate'' between both nodes (see below)." 4 |
340 | .IX Item "If this isn't possible (e.g. because the node doesn't have a hostname or known port), but the nodes speak a common protocol and a router is available, then GVPE will ask a router to mediate between both nodes (see below)." |
347 | .IX Item "If this isn't possible (e.g. because the node doesn't have a hostname or known port), but the nodes speak a common protocol and a router is available, then GVPE will ask a router to mediate between both nodes (see below)." |
341 | .ie n .IP "If a direct connection isn't possible (no common protocols) or forbidden (\*(C`deny\-direct\*(C'\fR) and there are any routers, then \s-1GVPE\s0 will try to send packets to the router with the highest priority that is connected already \fIand is able (as specified by the config file) to connect directly to the target node." 4 |
348 | .ie n .IP "If a direct connection isn't possible (no common protocols) or forbidden (\*(C`deny\-direct\*(C'\fR) and there are any routers, then \s-1GVPE\s0 will try to send packets to the router with the highest priority that is connected already \fIand is able (as specified by the config file) to connect directly to the target node." 4 |
… | |
… | |
351 | port number(s) to zero. It can declare other hosts as unreachable by using |
358 | port number(s) to zero. It can declare other hosts as unreachable by using |
352 | a config-file that disables all protocols for these other hosts. Another |
359 | a config-file that disables all protocols for these other hosts. Another |
353 | option is to disable all protocols on that host in the other config files. |
360 | option is to disable all protocols on that host in the other config files. |
354 | .PP |
361 | .PP |
355 | If two hosts cannot connect to each other because their \s-1IP\s0 address(es) |
362 | If two hosts cannot connect to each other because their \s-1IP\s0 address(es) |
356 | are not known (such as dialup hosts), one side will send a \fImediated\fR |
363 | are not known (such as dial-up hosts), one side will send a \fImediated\fR |
357 | connection request to a router (routers must be configured to act as |
364 | connection request to a router (routers must be configured to act as |
358 | routers!), which will send both the originating and the destination host |
365 | routers!), which will send both the originating and the destination host |
359 | a connection info request with protocol information and \s-1IP\s0 address of the |
366 | a connection info request with protocol information and \s-1IP\s0 address of the |
360 | other host (if known). Both hosts will then try to establish a direct |
367 | other host (if known). Both hosts will then try to establish a direct |
361 | connection to the other peer, which is usually possible even when both |
368 | connection to the other peer, which is usually possible even when both |