ipif/README

   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.
  18
  19
  20 The documentation available is:
  21
  22 INSTALL
  23
  24   Build and install instructions for both ipif and udptunnel, and
  25   tutorial on setting up userv ipif and udptunnel in the usual way.
  26
  27 udptunnel (head comment)
  28
  29   Configuration and invocation reference information for the udptunnel
  30   VPN facility.
  31
  32 service.c (head comment)
  33
  34   Reference information for userv ipif service, including syntax of
  35   /etc/userv/ipif-networks, and command line arguments to userv ipif.
  36
  37 mech-*.c (head comments)
  38
  39   Detailed specifications of encryption, padding,
  40   etc. transformations.  For use by cryptographers only; otherwise,
  41   follow the advice elsewhere about what transformations to use.
  42
  43 forwarder.c (head comment)
  44
  45   Underlying UDP forwarding program invocation details.  This program
  46   is normally invoked correctly by `udptunnel'.  You should not need
  47   to read these details unless you are debugging or modifying udptunnel.
  48
  49
  50 This file is part of ipif, part of userv-utils
  51
  52 userv-utils are
  53 Copyright 1996-2013 Ian Jackson <ijackson@chiark.greenend.org.uk>
  54 Copyright 1998 David Damerell <damerell@chiark.greenend.org.uk>
  55 Copyright 1999,2003
  56    Chancellor Masters and Scholars of the University of Cambridge
  57 Copyright 2010 Tony Finch <fanf@dotat.at>
  58
  59 All the utilities here are free software; you can redistribute it and/or
  60 modify it under the terms of the GNU General Public License as published by
  61 the Free Software Foundation; either version 3 of the License, or (at your
  62 option) any later version.
  63
  64 This program is distributed in the hope that it will be useful, but
  65 WITHOUT ANY WARRANTY; without even the implied warranty of
  66 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  67 General Public License for more details.
  68
  69 You should have received a copy of the GNU General Public License
  70 along with userv-utils; if not, see http://www.gnu.org/licenses/.