ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/gvpe/README
(Generate patch)

Comparing gvpe/README (file contents):
Revision 1.3 by pcg, Tue Mar 25 18:11:58 2003 UTC vs.
Revision 1.6 by pcg, Mon Jun 7 03:21:16 2004 UTC

1 1
2==== NAME ==== 2==== NAME ====
3 3
4 vpe - Overview of the virtual private ethernet suite. 4 GNU-VPE - Overview of the GNU Virtual Private Ethernet suite.
5 5
6 6
7==== DESCRIPTION ==== 7==== DESCRIPTION ====
8 8
9 Vpe is a suite designed to provide a virtual private network for 9 Vpe is a suite designed to provide a virtual private network for
10 multiple nodes over an untrusted network. 10 multiple nodes over an untrusted network.
11 11
12 "Virtual" means that no physical network is created (of course), but an 12 "Virtual" means that no physical network is created (of course), but an
13 ethernet is emulated by creating multiple tunnels between the member 13 ethernet is emulated by creating multiple tunnels between the member
14 nodes.
15
14 nodes. "Private" means that non-participating nodes cannot decode 16 "Private" means that non-participating nodes cannot decode ("sniff)" nor
15 ("sniff)" nor inject ("spoof") packets. In the case of vpe, even 17 inject ("spoof") packets.
16 participating nodes cannot spoof packets from other nodes. And "network" 18
17 means that more than two parties - many so-called vpn solutions only 19 In the case of vpe, even participating nodes cannot sniff packets send
18 create point-to-point tunnels - can participate in the network, so it's 20 to other nodes or spoof packets as if sent from other nodes.
19 possible to connect multiple branches of a company into a single 21
20 network. 22 "Network" means that more than two parties can participate in the
23 network, so for instance it's possible to connect multiple branches of a
24 company into a single network. Many so-called "vpn" solutions only
25 create point-to-point tunnels.
21 26
22 27
23== DESIGN GOALS == 28== DESIGN GOALS ==
24 29
25: SIMPLE DESIGN 30: SIMPLE DESIGN
53 Is the daemon used to establish and maintain conenctions to the 58 Is the daemon used to establish and maintain conenctions to the
54 other network members. It should be run on the gateway machine. 59 other network members. It should be run on the gateway machine.
55 60
56 61
57==== COMPILETIME CONFIGURATION ==== 62==== COMPILETIME CONFIGURATION ====
63
64 Please have a look at the ``vpe.osdep(5)'' manpage for platform-specific
65 information.
58 66
59 Here are a few recipes for compiling your vpe: 67 Here are a few recipes for compiling your vpe:
60 68
61 69
62== AS LOW PACKET OVERHEAD AS POSSIBLE == 70== AS LOW PACKET OVERHEAD AS POSSIBLE ==
202 files again. 210 files again.
203 211
204 212
205==== SEE ALSO ==== 213==== SEE ALSO ====
206 214
207 vpe(8), vpectrl(8), vped.conf(5). 215 vpe.osdep(5) for OS-depedendent information, vped.conf(5), vpectrl(8),
216 and for a description of the protocol and routing algorithms,
217 vpe.protocol(7).
208 218
209 219
210==== AUTHOR ==== 220==== AUTHOR ====
211 221
212 Marc Lehmann <vpe@plan9.de> 222 Marc Lehmann <vpe@plan9.de>
213 223
224
225==== COPYRIGHTS AND LICENSES ====
226
227 Vpe itself is distributed under the GENERAL PUBLIC LICENSE (see the file
228 COPYING that should be part of your distribution).
229
230 In some configurations it uses modified versions of the tinc vpn suite,
231 which is also available under the GENERAL PUBLIC LICENSE.
232
233 In some configurations (notably darwin), it uses a poll emulation
234 library that comes with the following license notice:
235
236 Copyright (c) 1995-2002 Brian M. Clapper
237 All rights reserved.
238
239 Redistribution and use in source and binary forms are permitted
240 provided that: (1) source distributions retain this entire
241 copyright notice and comment; (2) modifications made to the
242 software are prominently mentioned, and a copy of the original
243 software (or a pointer to its location) are included; and (3)
244 distributions including binaries display the following
245 acknowledgement: "This product includes software developed by Brian
246 M. Clapper <bmc@clapper.org>" in the documentation or other
247 materials provided with the distribution. The name of the author
248 may not be used to endorse or promote products derived from this
249 software without specific prior written permission.
250
251 THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
252 IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
253 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
254

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines