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