Commit | Line | Data |
---|---|---|
5124214b | 1 | This directory contains: |
2 | ||
3 | * userv ipif | |
4 | ||
5 | A userv service for allowing users to create network interfaces and | |
6 | handle the traffic for them. | |
7 | ||
8 | * udptunnel | |
9 | ||
97f318e0 IJ |
10 | This is deprecated. |
11 | ||
5124214b | 12 | A VPN tunnelling system based on userv ipif, which does encryption |
13 | and can be used to join two hosts or whole networks. It uses its | |
14 | own nonstandard protocols, not IPSEC. Key setup is done via an ssh | |
15 | connection, and actual data packets are sent (encrypted) using UDP. | |
16 | With the appropriate configuration in userv ipif, users can be | |
17 | allowed to create VPN connections without needing root privilege. | |
18 | ||
dd0d6c7e | 19 | These tools have only been tested on GNU/Linux. |
5124214b | 20 | |
21 | ||
22 | The documentation available is: | |
23 | ||
97f318e0 | 24 | INSTALL.udptunnel |
5124214b | 25 | |
26 | Build and install instructions for both ipif and udptunnel, and | |
27 | tutorial on setting up userv ipif and udptunnel in the usual way. | |
28 | ||
29 | udptunnel (head comment) | |
30 | ||
31 | Configuration and invocation reference information for the udptunnel | |
32 | VPN facility. | |
33 | ||
34 | service.c (head comment) | |
35 | ||
36 | Reference information for userv ipif service, including syntax of | |
37 | /etc/userv/ipif-networks, and command line arguments to userv ipif. | |
38 | ||
39 | mech-*.c (head comments) | |
40 | ||
41 | Detailed specifications of encryption, padding, | |
42 | etc. transformations. For use by cryptographers only; otherwise, | |
43 | follow the advice elsewhere about what transformations to use. | |
44 | ||
45 | forwarder.c (head comment) | |
46 | ||
47 | Underlying UDP forwarding program invocation details. This program | |
48 | is normally invoked correctly by `udptunnel'. You should not need | |
49 | to read these details unless you are debugging or modifying udptunnel. | |
50 | ||
51 | ||
c07be359 | 52 | This file is part of ipif, part of userv-utils |
5124214b | 53 | |
9028e234 IJ |
54 | userv-utils are |
55 | Copyright 1996-2013 Ian Jackson <ijackson@chiark.greenend.org.uk> | |
56 | Copyright 1998 David Damerell <damerell@chiark.greenend.org.uk> | |
57 | Copyright 1999,2003 | |
58 | Chancellor Masters and Scholars of the University of Cambridge | |
59 | Copyright 2010 Tony Finch <fanf@dotat.at> | |
60 | ||
61 | All the utilities here are free software; you can redistribute it and/or | |
62 | modify it under the terms of the GNU General Public License as published by | |
63 | the Free Software Foundation; either version 3 of the License, or (at your | |
64 | option) any later version. | |
5124214b | 65 | |
66 | This program is distributed in the hope that it will be useful, but | |
67 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
68 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
69 | General Public License for more details. | |
70 | ||
71 | You should have received a copy of the GNU General Public License | |
9028e234 | 72 | along with userv-utils; if not, see http://www.gnu.org/licenses/. |