This directory contains:

* userv ipif

  A userv service for allowing users to create network interfaces and
  handle the traffic for them.

* udptunnel

  A VPN tunnelling system based on userv ipif, which does encryption
  and can be used to join two hosts or whole networks.  It uses its
  own nonstandard protocols, not IPSEC.  Key setup is done via an ssh
  connection, and actual data packets are sent (encrypted) using UDP.
  With the appropriate configuration in userv ipif, users can be
  allowed to create VPN connections without needing root privilege.

These tools have only been tested on GNU/Linux, and userv ipif in
particular uses the Linux-specific `slattach' utility.


The documentation available is:

INSTALL

  Build and install instructions for both ipif and udptunnel, and
  tutorial on setting up userv ipif and udptunnel in the usual way.

udptunnel (head comment)

  Configuration and invocation reference information for the udptunnel
  VPN facility.

service.c (head comment)

  Reference information for userv ipif service, including syntax of
  /etc/userv/ipif-networks, and command line arguments to userv ipif.

mech-*.c (head comments)

  Detailed specifications of encryption, padding,
  etc. transformations.  For use by cryptographers only; otherwise,
  follow the advice elsewhere about what transformations to use.

forwarder.c (head comment)

  Underlying UDP forwarding program invocation details.  This program
  is normally invoked correctly by `udptunnel'.  You should not need
  to read these details unless you are debugging or modifying udptunnel.


Copyright (C) 1999-2000 Ian Jackson

This is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with userv-utils; if not, write to the Free Software
Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.


$Id: README,v 1.1 2000/09/18 00:31:11 ian Exp $
