"Fossies" - the Fresh Open Source Software Archive

Member "freeswan-2.06/linux/README.freeswan" (28 Jul 2002, 5585 Bytes) of package /linux/misc/old/freeswan-2.06.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 *
    2 * RCSID $Id: README.freeswan,v 1.11 2002/07/28 23:00:14 mcr Exp $
    3 *
    4 
    5                ****************************************
    6                * IPSEC for Linux, Release 2.xx series *
    7                ****************************************
    8 
    9 
   10 
   11 1. Files
   12 
   13 The contents of linux/net/ipsec/ (see below) join the linux kernel source tree.
   14 as provided for higher up.
   15 
   16 The programs/ directory contains the user-level utilities which you need
   17 to run IPSEC.  See the top-level top/INSTALL to compile and install them.
   18 
   19 The test/ directory contains test scripts.
   20 
   21 The doc/ directory contains -- what else -- documentation. 
   22 
   23 1.1. Kernel files
   24 
   25 The following are found in net/ipsec/:
   26 
   27 Makefile			The Makefile
   28 Config.in			The configuration script for make menuconfig
   29 defconfig			Configuration defaults for first time.
   30 
   31 radij.c				General-purpose radix-tree operations
   32 
   33 ipcomp.c			IPCOMP interface code.
   34 
   35 pfkey_v2.c			PF_KEYv2 socket interface code.
   36 pfkey_v2_parser.c		PF_KEYv2 message parsing and processing code.
   37 
   38 ipsec_init.c			Initialization code, /proc interface.
   39 ipsec_radij.c			Interface with the radix tree code.
   40 ipsec_netlink.c			Interface with the netlink code.
   41 ipsec_xform.c			Routines and structures common to transforms.
   42 ipsec_tunnel.c			The outgoing packet processing code.
   43 ipsec_rcv.c			The incoming packet processing code.
   44 ipsec_md5c.c			Somewhat modified RSADSI MD5 C code.
   45 ipsec_sha1.c			Somewhat modified Steve Reid SHA-1 C code.
   46 
   47 sysctl_net_ipsec.c		/proc/sys/net/ipsec/* variable definitions.
   48 
   49 version.c			symbolic link to project version.
   50 
   51 radij.h				Headers for radij.c
   52 
   53 ipcomp.h			Headers used by IPCOMP code.
   54 
   55 ipsec_radij.h			Interface with the radix tree code.
   56 ipsec_netlink.h			Headers used by the netlink interface.
   57 ipsec_encap.h			Headers defining encapsulation structures.
   58 ipsec_xform.h			Transform headers.
   59 ipsec_tunnel.h			Headers used by tunneling code.
   60 ipsec_ipe4.h			Headers for the IP-in-IP code.
   61 ipsec_ah.h			Headers common to AH transforms.
   62 ipsec_md5h.h			RSADSI MD5 headers.
   63 ipsec_sha1.h			SHA-1 headers.
   64 ipsec_esp.h			Headers common to ESP transfroms.
   65 ipsec_rcv.h			Headers for incoming packet processing code.
   66 
   67 1.2. User-level files.
   68 
   69 The following are found in utils/:
   70 
   71 eroute.c	Create an "extended route" source code
   72 spi.c		Set up Security Associations source code
   73 spigrp.c        Link SPIs together source code.
   74 tncfg.c         Configure the tunneling features of the virtual interface
   75 		source code
   76 klipsdebug.c	Set/reset klips debugging features source code.
   77 version.c	symbolic link to project version.
   78 
   79 eroute.8	Create an "extended route" manual page
   80 spi.8		Set up Security Associations manual page
   81 spigrp.8        Link SPIs together manual page
   82 tncfg.8         Configure the tunneling features of the virtual interface
   83 		manual page
   84 klipsdebug.8	Set/reset klips debugging features manual page
   85 
   86 eroute.5	/proc/net/ipsec_eroute format manual page
   87 spi.5		/proc/net/ipsec_spi format manual page
   88 spigrp.5	/proc/net/ipsec_spigrp format manual page
   89 tncfg.5		/proc/net/ipsec_tncfg format manual page
   90 klipsdebug.5	/proc/net/ipsec_klipsdebug format manual page
   91 version.5	/proc/net/ipsec_version format manual page
   92 pf_key.5	/proc/net/pf_key format manual page
   93 
   94 Makefile	Utilities makefile.
   95 
   96 *.8		Manpages for the respective utils.
   97 
   98 
   99 1.3. Test files
  100 
  101 The test scripts are locate in testing/ and and documentation is found
  102 at doc/src/umltesting.html. Automated testing via "make check" is available
  103 provided that the User-Mode-Linux patches are available.
  104 
  105 *
  106 * $Log: README.freeswan,v $
  107 * Revision 1.11  2002/07/28 23:00:14  mcr
  108 * 	removed docs on "test" directory.
  109 * 	some slight "updates"
  110 *
  111 * Revision 1.10  2002/05/06 21:34:19  mcr
  112 * Moved from linux/README,v
  113 *
  114 * Revision 1.9  2002/04/24 07:36:35  mcr
  115 * Moved from ./klips/README,v
  116 *
  117 * Revision 1.8  2000/11/06 05:42:58  rgb
  118 * Updated file list (had not been done in 2 years?).
  119 *
  120 * Revision 1.7  2000/08/21 17:30:09  rgb
  121 * Remove any references to src/.
  122 *
  123 * Revision 1.6  1999/04/06 04:54:22  rgb
  124 * Fix/Add RCSID Id: and Log: bits to make PHMDs happy.  This includes
  125 * patch shell fixes.
  126 *
  127 * Revision 1.5  1998/11/25 04:54:34  rgb
  128 * Updated files section to include newer transforms and other files.
  129 *
  130 * Revision 1.4  1998/05/01 03:47:17  rgb
  131 * Minor cleanup of utils filenames overlooked in major overhaul.
  132 *
  133 * Revision 1.3  1998/05/01 03:40:31  rgb
  134 * Major overhaul.
  135 * Removed install/initialise section with pointers to top-level INSTALL.txt.
  136 * Updated filelists and providing descriptions of all files.
  137 * Removed usage example and moved it to doc/*_setup.txt.
  138 *
  139 * Revision 1.2  1998/04/09 03:01:13  henry
  140 * INSTALL.txt moves up, loses its installation instructions, and turns
  141 * into the klips README.
  142 *
  143 * Revision 1.1.1.1  1998/04/08 05:35:13  henry
  144 * RGB's ipsec-0.8pre2.tar.gz ipsec-0.8
  145 *
  146 *
  147 * Revision 0.7  rgb
  148 * Cleaned up several transmission bugs.
  149 *
  150 * Revision 0.6  1997/09?  ak
  151 * Hooked in esp des-md5-96.
  152 * Added copyrights.
  153 * 
  154 * Revision 0.5  1997/06/03 04:28:46  ji
  155 * Added transport mode.
  156 * Added esp 3des-md5-96.
  157 *
  158 * Revision 0.4  1997/01/14 21:35:31  ji
  159 * Added new transforms.
  160 * Cleaned up the user-level programs.
  161 *
  162 * Revision 0.3  1996/11/20 11:59:33  ji
  163 * *** empty log message ***
  164 *
  165 *
  166 * New in this release (0.3; works with the 2.0.24 kernel)
  167 *
  168 *   > Cleaned up a fair amount of crud.
  169 *   > Fixed truncated names of /proc/net entries.
  170 *   > Made RCS versioning visible to the external release.
  171 *   > Rationalized debugging facilities.
  172 *   > Rationalized untar directory structure.
  173 *   > Fixed non-incrementing IV in DES-CBC
  174 *   > Cleaned up this file a bit and provided additional examples