ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/gvpe/doc/gvpe.protocol.7
(Generate patch)

Comparing gvpe/doc/gvpe.protocol.7 (file contents):
Revision 1.8 by pcg, Sun Aug 10 23:04:05 2008 UTC vs.
Revision 1.12 by root, Sat Jul 13 04:10:29 2013 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 1.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 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) 5.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v 6.if t .sp .5v
15.if n .sp 7.if n .sp
16.. 8..
17.de Vb \" Begin verbatim text 9.de Vb \" Begin verbatim text
46. ds PI \(*p 38. ds PI \(*p
47. ds L" `` 39. ds L" ``
48. ds R" '' 40. ds R" ''
49'br\} 41'br\}
50.\" 42.\"
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el .ds Aq '
46.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for 47.\" 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 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the 49.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion. 50.\" output yourself in some meaningful fashion.
55.if \nF \{\ 51.ie \nF \{\
56. de IX 52. de IX
57. tm Index:\\$1\t\\n%\t"\\$2" 53. tm Index:\\$1\t\\n%\t"\\$2"
58.. 54..
59. nr % 0 55. nr % 0
60. rr F 56. rr F
61.\} 57.\}
62.\" 58.el \{\
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes 59. de IX
64.\" way too many mistakes in technical documents. 60..
65.hy 0 61.\}
66.if n .na
67.\" 62.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts. 64.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff 65. \" fudge factors for nroff and troff
71.if n \{\ 66.if n \{\
127.\} 122.\}
128.rm #[ #] #H #V #F C 123.rm #[ #] #H #V #F C
129.\" ======================================================================== 124.\" ========================================================================
130.\" 125.\"
131.IX Title "GVPE.PROTOCOL 7" 126.IX Title "GVPE.PROTOCOL 7"
132.TH GVPE.PROTOCOL 7 "2008-08-10" "2.2" "GNU Virtual Private Ethernet" 127.TH GVPE.PROTOCOL 7 "2013-07-12" "2.24" "GNU Virtual Private Ethernet"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents.
130.if n .ad l
131.nh
133.SH "The GNU-VPE Protocols" 132.SH "The GNU-VPE Protocols"
134.IX Header "The GNU-VPE Protocols" 133.IX Header "The GNU-VPE Protocols"
135.SH "Overview" 134.SH "Overview"
136.IX Header "Overview" 135.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 136\&\s-1GVPE\s0 can make use of a number of protocols. One of them is the \s-1GNU\s0 \s-1VPE\s0
148reliability, and robustness. 147reliability, and robustness.
149.PP 148.PP
150The following sections describe each transport protocol in more 149The following sections describe each transport protocol in more
151detail. They are sorted by overhead/efficiency, the most efficient 150detail. They are sorted by overhead/efficiency, the most efficient
152transport is listed first: 151transport is listed first:
153.Sh "\s-1RAW\s0 \s-1IP\s0" 152.SS "\s-1RAW\s0 \s-1IP\s0"
154.IX Subsection "RAW IP" 153.IX Subsection "RAW IP"
155This protocol is the best choice, performance\-wise, as the minimum 154This protocol is the best choice, performance-wise, as the minimum
156overhead per packet is only 38 bytes. 155overhead per packet is only 38 bytes.
157.PP 156.PP
158It works by sending the \s-1VPN\s0 payload using raw ip frames (using the 157It works by sending the \s-1VPN\s0 payload using raw \s-1IP\s0 frames (using the
159protocol set by \f(CW\*(C`ip\-proto\*(C'\fR). 158protocol set by \f(CW\*(C`ip\-proto\*(C'\fR).
160.PP 159.PP
161Using raw ip frames has the drawback that many firewalls block \*(L"unknown\*(R" 160Using raw \s-1IP\s0 frames has the drawback that many firewalls block \*(L"unknown\*(R"
162protocols, so this transport only works if you have full \s-1IP\s0 connectivity 161protocols, so this transport only works if you have full \s-1IP\s0 connectivity
163between nodes. 162between nodes.
164.Sh "\s-1ICMP\s0" 163.SS "\s-1ICMP\s0"
165.IX Subsection "ICMP" 164.IX Subsection "ICMP"
166This protocol offers very low overhead (minimum 42 bytes), and can 165This protocol offers very low overhead (minimum 42 bytes), and can
167sometimes tunnel through firewalls when other protocols can not. 166sometimes tunnel through firewalls when other protocols can not.
168.PP 167.PP
169It works by prepending an \s-1ICMP\s0 header with type \f(CW\*(C`icmp\-type\*(C'\fR and a code 168It works by prepending an \s-1ICMP\s0 header with type \f(CW\*(C`icmp\-type\*(C'\fR and a code
170of \f(CW255\fR. The default \f(CW\*(C`icmp\-type\*(C'\fR is \f(CW\*(C`echo\-reply\*(C'\fR, so the resulting 169of \f(CW255\fR. The default \f(CW\*(C`icmp\-type\*(C'\fR is \f(CW\*(C`echo\-reply\*(C'\fR, so the resulting
171packets look like echo replies, which looks rather strange to network 170packets look like echo replies, which looks rather strange to network
172admins. 171administrators.
173.PP 172.PP
174This transport should only be used if other transports (i.e. raw ip) are 173This transport should only be used if other transports (i.e. raw \s-1IP\s0) are
175not available or undesirable (due to their overhead). 174not available or undesirable (due to their overhead).
176.Sh "\s-1UDP\s0" 175.SS "\s-1UDP\s0"
177.IX Subsection "UDP" 176.IX Subsection "UDP"
178This is a good general choice for the transport protocol as \s-1UDP\s0 packets 177This is a good general choice for the transport protocol as \s-1UDP\s0 packets
179tunnel well through most firewalls and routers, and the overhead per 178tunnel well through most firewalls and routers, and the overhead per
180packet is moderate (minimum 58 bytes). 179packet is moderate (minimum 58 bytes).
181.PP 180.PP
182It should be used if \s-1RAW\s0 \s-1IP\s0 is not available. 181It should be used if \s-1RAW\s0 \s-1IP\s0 is not available.
183.Sh "\s-1TCP\s0" 182.SS "\s-1TCP\s0"
184.IX Subsection "TCP" 183.IX Subsection "TCP"
185This protocol is a very bad choice, as it not only has high overhead (more 184This protocol is a very bad choice, as it not only has high overhead (more
186than 60 bytes), but the transport also retries on it's own, which leads 185than 60 bytes), but the transport also retries on it's own, which leads
187to congestion when the link has moderate packet loss (as both the \s-1TCP\s0 186to congestion when the link has moderate packet loss (as both the \s-1TCP\s0
188transport and the tunneled traffic will retry, increasing congestion more 187transport and the tunneled traffic will retry, increasing congestion more
197It is an abuse of the usage a proxy was designed for, so make sure you are 196It is an abuse of the usage a proxy was designed for, so make sure you are
198allowed to use it for \s-1GVPE\s0. 197allowed to use it for \s-1GVPE\s0.
199.PP 198.PP
200This protocol also has server and client sides. If the \f(CW\*(C`tcp\-port\*(C'\fR is 199This protocol also has server and client sides. If the \f(CW\*(C`tcp\-port\*(C'\fR is
201set to zero, other nodes cannot connect to this node directly. If the 200set 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 201\&\f(CW\*(C`tcp\-port\*(C'\fR is non-zero, the node can act both as a client as well as a
203server. 202server.
204.Sh "\s-1DNS\s0" 203.SS "\s-1DNS\s0"
205.IX Subsection "DNS" 204.IX Subsection "DNS"
206\&\fB\s-1WARNING:\s0\fR Parsing and generating \s-1DNS\s0 packets is rather tricky. The code 205\&\fB\s-1WARNING:\s0\fR Parsing and generating \s-1DNS\s0 packets is rather tricky. The code
207almost certainly contains buffer overflows and other, likely exploitable, 206almost certainly contains buffer overflows and other, likely exploitable,
208bugs. You have been warned. 207bugs. You have been warned.
209.PP 208.PP
215traffic even if it doesn't need to transport packets. 214traffic even if it doesn't need to transport packets.
216.PP 215.PP
217In addition, the same problems as the \s-1TCP\s0 transport also plague this 216In addition, the same problems as the \s-1TCP\s0 transport also plague this
218protocol. 217protocol.
219.PP 218.PP
220It's only use is to tunnel through firewalls that do not allow direct 219Its only use is to tunnel through firewalls that do not allow direct
221internet access. Similar to using a \s-1HTTP\s0 proxy (as the \s-1TCP\s0 transport 220internet access. Similar to using a \s-1HTTP\s0 proxy (as the \s-1TCP\s0 transport
222does), it uses a local \s-1DNS\s0 server/forwarder (given by the \f(CW\*(C`dns\-forw\-host\*(C'\fR 221does), it uses a local \s-1DNS\s0 server/forwarder (given by the \f(CW\*(C`dns\-forw\-host\*(C'\fR
223configuration value) as a proxy to send and receive data as a client, 222configuration value) as a proxy to send and receive data as a client,
224and an \f(CW\*(C`NS\*(C'\fR record pointing to the \s-1GVPE\s0 server (as given by the 223and 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). 224\&\f(CW\*(C`dns\-hostname\*(C'\fR directive).
226.PP 225.PP
227The only good side of this protocol is that it can tunnel through most 226The only good side of this protocol is that it can tunnel through most
228firewalls mostly undetected, iff the local \s-1DNS\s0 server/forwarder is sane 227firewalls 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). 228(which is true for most routers, wireless \s-1LAN\s0 gateways and nameservers).
230.PP 229.PP
231Finetuning needs to be done by editing \f(CW\*(C`src/vpn_dns.C\*(C'\fR directly. 230Fine-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" 231.SH "PART 2: The GNU VPE protocol"
233.IX Header "PART 2: The GNU VPE protocol" 232.IX Header "PART 2: The GNU VPE protocol"
234This section, unfortunately, is not yet finished, although the protocol 233This section, unfortunately, is not yet finished, although the protocol
235is stable (until bugs in the cryptography are found, which will likely 234is stable (until bugs in the cryptography are found, which will likely
236completely change the following description). Nevertheless, it should give 235completely change the following description). Nevertheless, it should give
237you some overview over the protocol. 236you some overview over the protocol.
238.Sh "Anatomy of a \s-1VPN\s0 packet" 237.SS "Anatomy of a \s-1VPN\s0 packet"
239.IX Subsection "Anatomy of a VPN packet" 238.IX Subsection "Anatomy of a VPN packet"
240The exact layout and field lengths of a \s-1VPN\s0 packet is determined at 239The exact layout and field lengths of a \s-1VPN\s0 packet is determined at
241compiletime and doesn't change. The same structure is used for all 240compile time and doesn't change. The same structure is used for all
242transort protocols, be it \s-1RAWIP\s0 or \s-1TCP\s0. 241transport protocols, be it \s-1RAWIP\s0 or \s-1TCP\s0.
243.PP 242.PP
244.Vb 3 243.Vb 3
245\& +\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-+ 244\& +\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-+
246\& | HMAC | TYPE | SRCDST | DATA | 245\& | HMAC | TYPE | SRCDST | DATA |
247\& +\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-+ 246\& +\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-+
273.PP 272.PP
274\&\s-1SEQNO\s0 is a 32\-bit sequence number. It is negotiated at every connection 273\&\s-1SEQNO\s0 is a 32\-bit sequence number. It is negotiated at every connection
275initialization and starts at some random 31 bit value. \s-1VPE\s0 currently uses 274initialization and starts at some random 31 bit value. \s-1VPE\s0 currently uses
276a sliding window of 512 packets/sequence numbers to detect reordering, 275a sliding window of 512 packets/sequence numbers to detect reordering,
277duplication and replay attacks. 276duplication and replay attacks.
277.PP
278The encryption is done on \s-1RAND+SEQNO+DATA\s0 in \s-1CBC\s0 mode with zero \s-1IV\s0 (or,
279equivalently, the \s-1IV\s0 is \s-1RAND+SEQNO\s0, encrypted with the block cipher,
280unless \s-1RAND\s0 size is decreased or increased over the default value).
278.Sh "The authentication protocol" 281.SS "The authentication protocol"
279.IX Subsection "The authentication protocol" 282.IX Subsection "The authentication protocol"
280Before hosts can exchange packets, they need to establish authenticity of 283Before nodes can exchange packets, they need to establish authenticity of
281the other side and a key. Every host has a private \s-1RSA\s0 key and the public 284the 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. 285\&\s-1RSA\s0 keys of all other nodes.
283.PP 286.PP
284A host establishes a simplex connection by sending the other host an 287A host establishes a simplex connection by sending the other node an \s-1RSA\s0
285\&\s-1RSA\s0 encrypted challenge containing a random challenge (consisting of 288encrypted challenge containing a random challenge (consisting of the
286the encryption key to use when sending packets, more random data and 289encryption and authentication keys to use when sending packets, more
287\&\s-1PKCS1_OAEP\s0 padding) and a random 16 byte \*(L"challenge\-id\*(R" (used to detect 290random data and \s-1PKCS1_OAEP\s0 padding) and a random 16 byte \*(L"challenge-id\*(R"
288duplicate auth packets). The destination host will respond by replying 291(used to detect duplicate auth packets). The destination node will respond
289with an (unencrypted) \s-1RIPEMD160\s0 hash of the decrypted challenge, which 292by replying with an (unencrypted) hash of the decrypted challenge, which
290will authenticate that host. The destination host will also set the 293will authenticate that node. The destination node will also set the
291outgoing encryption parameters as given in the packet. 294outgoing encryption parameters as given in the packet.
292.PP 295.PP
293When the source host receives a correct auth reply (by verifying the 296When the source node receives a correct auth reply (by verifying the
294hash and the id, which will expire after 120 seconds), it will start to 297hash and the id, which will expire after 120 seconds), it will start to
295accept data packets from the destination host. 298accept data packets from the destination node.
296.PP 299.PP
297This means that a host can only initate a simplex connection, telling the 300This means that a node can only initiate a simplex connection, telling the
298other side the key it has to use when it sends packets. The challenge 301other side the key it has to use when it sends packets. The challenge
299reply is only used to set the current \s-1IP\s0 address of the other side and 302reply is only used to set the current \s-1IP\s0 address of the other side and
300protocol parameters. 303protocol parameters.
301.PP 304.PP
302This protocol is completely symmetric, so to be able to send packets the 305This protocol is completely symmetric, so to be able to send packets the
303destination host must send a challenge in the exact same way as already 306destination node must send a challenge in the exact same way as already
304described (so, in essence, two simplex connections are created per host 307described (so, in essence, two simplex connections are created per node
305pair). 308pair).
306.Sh "Retrying" 309.SS "Retrying"
307.IX Subsection "Retrying" 310.IX Subsection "Retrying"
308When there is no response to an auth request, the host will send auth 311When there is no response to an auth request, the node will send auth
309requests in bursts with an exponential backoff. After some time it will 312requests in bursts with an exponential back-off. After some time it will
310resort to \s-1PING\s0 packets, which are very small (8 bytes) and lightweight 313resort to \s-1PING\s0 packets, which are very small (8 bytes + protocol header)
311(no \s-1RSA\s0 operations required). A host that receives ping requests from an 314and lightweight (no \s-1RSA\s0 operations required). A node that receives ping
312unconnected peer will respond by trying to create a connection. 315requests from an unconnected peer will respond by trying to create a
316connection.
313.PP 317.PP
314In addition to the exponential backoff, there is a global rate-limit on 318In addition to the exponential back-off, there is a global rate-limit on
315a per-IP base. It allows long bursts but will limit total packet rate to 319a per-IP base. It allows long bursts but will limit total packet rate to
316something like one control packet every ten seconds, to avoid accidental 320something like one control packet every ten seconds, to avoid accidental
317floods due to protocol problems (like a \s-1RSA\s0 key file mismatch between two 321floods due to protocol problems (like a \s-1RSA\s0 key file mismatch between two
318hosts). 322nodes).
323.PP
324The intervals between retries are limited by the \f(CW\*(C`max\-retry\*(C'\fR
325configuration value. A node with \f(CW\*(C`connect\*(C'\fR = \f(CW\*(C`always\*(C'\fR will always retry,
326a node with \f(CW\*(C`connect\*(C'\fR = \f(CW\*(C`ondemand\*(C'\fR will only try (and re-try) to connect
327as long as there are packets in the queue, usually this limits the retry
328period to \f(CW\*(C`max\-ttl\*(C'\fR seconds.
329.PP
330Sending packets over the \s-1VPN\s0 will reset the retry intervals as well, which
331means as long as somebody is trying to send packets to a given node, \s-1GVPE\s0
332will try to connect every few seconds.
319.Sh "Routing and Protocol translation" 333.SS "Routing and Protocol translation"
320.IX Subsection "Routing and Protocol translation" 334.IX Subsection "Routing and Protocol translation"
321The gvpe routing algorithm is easy: there isn't any routing. \s-1GVPE\s0 always 335The \s-1GVPE\s0 routing algorithm is easy: there isn't much routing to speak
322tries to establish direct connections, if the protocol abilities of the 336of: When routing packets to another node, \s-1GVPE\s0 tries the following
323two hosts allow it. 337options, in order:
324.PP 338.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
325If the two hosts should be able to reach each other (common protocol, ip 339.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."
326and port all known), but cannot (network down), then there will be no 340.PD 0
327connection, point. 341.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
342.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
343.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)."
344.ie n .IP "If a direct connection isn't possible (no common protocols) or forbidden (\*(C`deny\-direct\*(C') 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\fR is able (as specified by the config file) to connect directly to the target node." 4
345.el .IP "If a direct connection isn't possible (no common protocols) or forbidden (\f(CW\*(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\fR is able (as specified by the config file) to connect directly to the target node." 4
346.IX Item "If a direct connection isn't possible (no common protocols) or forbidden (deny-direct) and there are any routers, then GVPE will try to send packets to the router with the highest priority that is connected already and is able (as specified by the config file) to connect directly to the target node."
347.IP "If no such router exists, then \s-1GVPE\s0 will simply send the packet to the node with the highest priority available." 4
348.IX Item "If no such router exists, then GVPE will simply send the packet to the node with the highest priority available."
349.IP "Failing all that, the packet will be dropped." 4
350.IX Item "Failing all that, the packet will be dropped."
351.PD
328.PP 352.PP
329A host can usually declare itself unreachable directly by setting it's 353A host can usually declare itself unreachable directly by setting it's
330port number(s) to zero. It can declare other hosts as unreachable by using 354port number(s) to zero. It can declare other hosts as unreachable by using
331a config-file that disables all protocols for these other hosts. 355a config-file that disables all protocols for these other hosts. Another
356option is to disable all protocols on that host in the other config files.
332.PP 357.PP
333If two hosts cannot connect to each other because their \s-1IP\s0 address(es) 358If two hosts cannot connect to each other because their \s-1IP\s0 address(es)
334are not known (such as dialup hosts), one side will send a connection 359are not known (such as dial-up hosts), one side will send a \fImediated\fR
335request to a router (routers must be configured to act as routers!), which 360connection request to a router (routers must be configured to act as
336will send both the originating and the destination host a connection info 361routers!), which will send both the originating and the destination host
337request with protocol information and \s-1IP\s0 address of the other host (if 362a connection info request with protocol information and \s-1IP\s0 address of the
338known). Both hosts will then try to establish a connection to the other 363other host (if known). Both hosts will then try to establish a direct
339peer, which is usually possible even when both hosts are behind a \s-1NAT\s0 364connection to the other peer, which is usually possible even when both
340gateway. 365hosts are behind a \s-1NAT\s0 gateway.
341.PP 366.PP
342If the hosts cannot reach each other because they have no common protocol, 367Routing via other nodes works because the \s-1SRCDST\s0 field is not encrypted,
343the originator instead use the router with highest priority and matching
344protocol as peer. Since the \s-1SRCDST\s0 field is not encrypted, the router host
345can just forward the packet to the destination host. Since each host uses 368so the router can just forward the packet to the destination host. Since
346it's own private key, the router will not be able to decrypt or encrypt 369each host uses it's own private key, the router will not be able to
347packets, it will just act as a simple router and protocol translator. 370decrypt or encrypt packets, it will just act as a simple router and
348.PP 371protocol translator.
349When no router is connected, the host will aggressively try to connect to
350all routers, and if a router is asked for an unconnected host it will try
351to ask another router to establish the connection.
352.PP
353\&... more not yet written about the details of the routing, please bug me
354\&...

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines