diff options
Diffstat (limited to 'linux/README.freeswan')
| -rw-r--r-- | linux/README.freeswan | 177 |
1 files changed, 177 insertions, 0 deletions
diff --git a/linux/README.freeswan b/linux/README.freeswan new file mode 100644 index 000000000..7d868e4cb --- /dev/null +++ b/linux/README.freeswan @@ -0,0 +1,177 @@ +* +* RCSID $Id: README.freeswan,v 1.1 2004/03/15 20:35:25 as Exp $ +* + + **************************************** + * IPSEC for Linux, Release 2.xx series * + **************************************** + + + +1. Files + +The contents of linux/net/ipsec/ (see below) join the linux kernel source tree. +as provided for higher up. + +The programs/ directory contains the user-level utilities which you need +to run IPSEC. See the top-level top/INSTALL to compile and install them. + +The test/ directory contains test scripts. + +The doc/ directory contains -- what else -- documentation. + +1.1. Kernel files + +The following are found in net/ipsec/: + +Makefile The Makefile +Config.in The configuration script for make menuconfig +defconfig Configuration defaults for first time. + +radij.c General-purpose radix-tree operations + +ipcomp.c IPCOMP interface code. + +pfkey_v2.c PF_KEYv2 socket interface code. +pfkey_v2_parser.c PF_KEYv2 message parsing and processing code. + +ipsec_init.c Initialization code, /proc interface. +ipsec_radij.c Interface with the radix tree code. +ipsec_netlink.c Interface with the netlink code. +ipsec_xform.c Routines and structures common to transforms. +ipsec_tunnel.c The outgoing packet processing code. +ipsec_rcv.c The incoming packet processing code. +ipsec_md5c.c Somewhat modified RSADSI MD5 C code. +ipsec_sha1.c Somewhat modified Steve Reid SHA-1 C code. + +sysctl_net_ipsec.c /proc/sys/net/ipsec/* variable definitions. + +version.c symbolic link to project version. + +radij.h Headers for radij.c + +ipcomp.h Headers used by IPCOMP code. + +ipsec_radij.h Interface with the radix tree code. +ipsec_netlink.h Headers used by the netlink interface. +ipsec_encap.h Headers defining encapsulation structures. +ipsec_xform.h Transform headers. +ipsec_tunnel.h Headers used by tunneling code. +ipsec_ipe4.h Headers for the IP-in-IP code. +ipsec_ah.h Headers common to AH transforms. +ipsec_md5h.h RSADSI MD5 headers. +ipsec_sha1.h SHA-1 headers. +ipsec_esp.h Headers common to ESP transfroms. +ipsec_rcv.h Headers for incoming packet processing code. + +1.2. User-level files. + +The following are found in utils/: + +eroute.c Create an "extended route" source code +spi.c Set up Security Associations source code +spigrp.c Link SPIs together source code. +tncfg.c Configure the tunneling features of the virtual interface + source code +klipsdebug.c Set/reset klips debugging features source code. +version.c symbolic link to project version. + +eroute.8 Create an "extended route" manual page +spi.8 Set up Security Associations manual page +spigrp.8 Link SPIs together manual page +tncfg.8 Configure the tunneling features of the virtual interface + manual page +klipsdebug.8 Set/reset klips debugging features manual page + +eroute.5 /proc/net/ipsec_eroute format manual page +spi.5 /proc/net/ipsec_spi format manual page +spigrp.5 /proc/net/ipsec_spigrp format manual page +tncfg.5 /proc/net/ipsec_tncfg format manual page +klipsdebug.5 /proc/net/ipsec_klipsdebug format manual page +version.5 /proc/net/ipsec_version format manual page +pf_key.5 /proc/net/pf_key format manual page + +Makefile Utilities makefile. + +*.8 Manpages for the respective utils. + + +1.3. Test files + +The test scripts are locate in testing/ and and documentation is found +at doc/src/umltesting.html. Automated testing via "make check" is available +provided that the User-Mode-Linux patches are available. + +* +* $Log: README.freeswan,v $ +* Revision 1.1 2004/03/15 20:35:25 as +* added files from freeswan-2.04-x509-1.5.3 +* +* Revision 1.11 2002/07/28 23:00:14 mcr +* removed docs on "test" directory. +* some slight "updates" +* +* Revision 1.10 2002/05/06 21:34:19 mcr +* Moved from linux/README,v +* +* Revision 1.9 2002/04/24 07:36:35 mcr +* Moved from ./klips/README,v +* +* Revision 1.8 2000/11/06 05:42:58 rgb +* Updated file list (had not been done in 2 years?). +* +* Revision 1.7 2000/08/21 17:30:09 rgb +* Remove any references to src/. +* +* Revision 1.6 1999/04/06 04:54:22 rgb +* Fix/Add RCSID Id: and Log: bits to make PHMDs happy. This includes +* patch shell fixes. +* +* Revision 1.5 1998/11/25 04:54:34 rgb +* Updated files section to include newer transforms and other files. +* +* Revision 1.4 1998/05/01 03:47:17 rgb +* Minor cleanup of utils filenames overlooked in major overhaul. +* +* Revision 1.3 1998/05/01 03:40:31 rgb +* Major overhaul. +* Removed install/initialise section with pointers to top-level INSTALL.txt. +* Updated filelists and providing descriptions of all files. +* Removed usage example and moved it to doc/*_setup.txt. +* +* Revision 1.2 1998/04/09 03:01:13 henry +* INSTALL.txt moves up, loses its installation instructions, and turns +* into the klips README. +* +* Revision 1.1.1.1 1998/04/08 05:35:13 henry +* RGB's ipsec-0.8pre2.tar.gz ipsec-0.8 +* +* +* Revision 0.7 rgb +* Cleaned up several transmission bugs. +* +* Revision 0.6 1997/09? ak +* Hooked in esp des-md5-96. +* Added copyrights. +* +* Revision 0.5 1997/06/03 04:28:46 ji +* Added transport mode. +* Added esp 3des-md5-96. +* +* Revision 0.4 1997/01/14 21:35:31 ji +* Added new transforms. +* Cleaned up the user-level programs. +* +* Revision 0.3 1996/11/20 11:59:33 ji +* *** empty log message *** +* +* +* New in this release (0.3; works with the 2.0.24 kernel) +* +* > Cleaned up a fair amount of crud. +* > Fixed truncated names of /proc/net entries. +* > Made RCS versioning visible to the external release. +* > Rationalized debugging facilities. +* > Rationalized untar directory structure. +* > Fixed non-incrementing IV in DES-CBC +* > Cleaned up this file a bit and provided additional examples |