2 * RCSID $Id: README,v 1.8 2000/11/06 05:42:58 rgb Exp $
5 ****************************************
6 * IPSEC for Linux, Preliminary Release *
7 ****************************************
13 The contents of net/ipsec/ (see below) join the linux kernel source tree.
14 as provided for higher up.
16 The utils/ directory contains the user-level utilities which you need
17 to run IPSEC. See the top-level top/INSTALL to compile and install them.
19 The test/ directory contains test scripts.
21 The doc/ directory contains -- what else -- documentation. Not a lot
27 The following are found in net/ipsec/:
30 Config.in The configuration script for make menuconfig
31 defconfig Configuration defaults for first time.
33 radij.c General-purpose radix-tree operations
35 ipcomp.c IPCOMP interface code.
37 pfkey_v2.c PF_KEYv2 socket interface code.
38 pfkey_v2_parser.c PF_KEYv2 message parsing and processing code.
40 ipsec_init.c Initialization code, /proc interface.
41 ipsec_radij.c Interface with the radix tree code.
42 ipsec_netlink.c Interface with the netlink code.
43 ipsec_xform.c Routines and structures common to transforms.
44 ipsec_tunnel.c The outgoing packet processing code.
45 ipsec_rcv.c The incoming packet processing code.
46 ipsec_md5c.c Somewhat modified RSADSI MD5 C code.
47 ipsec_sha1.c Somewhat modified Steve Reid SHA-1 C code.
49 sysctl_net_ipsec.c /proc/sys/net/ipsec/* variable definitions.
51 version.c symbolic link to project version.
53 radij.h Headers for radij.c
55 ipcomp.h Headers used by IPCOMP code.
57 ipsec_radij.h Interface with the radix tree code.
58 ipsec_netlink.h Headers used by the netlink interface.
59 ipsec_encap.h Headers defining encapsulation structures.
60 ipsec_xform.h Transform headers.
61 ipsec_tunnel.h Headers used by tunneling code.
62 ipsec_ipe4.h Headers for the IP-in-IP code.
63 ipsec_ah.h Headers common to AH transforms.
64 ipsec_md5h.h RSADSI MD5 headers.
65 ipsec_sha1.h SHA-1 headers.
66 ipsec_esp.h Headers common to ESP transfroms.
67 ipsec_rcv.h Headers for incoming packet processing code.
69 1.2. User-level files.
71 The following are found in utils/:
73 eroute.c Create an "extended route" source code
74 spi.c Set up Security Associations source code
75 spigrp.c Link SPIs together source code.
76 tncfg.c Configure the tunneling features of the virtual interface
78 klipsdebug.c Set/reset klips debugging features source code.
79 version.c symbolic link to project version.
81 eroute.8 Create an "extended route" manual page
82 spi.8 Set up Security Associations manual page
83 spigrp.8 Link SPIs together manual page
84 tncfg.8 Configure the tunneling features of the virtual interface
86 klipsdebug.8 Set/reset klips debugging features manual page
88 eroute.5 /proc/net/ipsec_eroute format manual page
89 spi.5 /proc/net/ipsec_spi format manual page
90 spigrp.5 /proc/net/ipsec_spigrp format manual page
91 tncfg.5 /proc/net/ipsec_tncfg format manual page
92 klipsdebug.5 /proc/net/ipsec_klipsdebug format manual page
93 version.5 /proc/net/ipsec_version format manual page
94 pf_key.5 /proc/net/pf_key format manual page
96 Makefile Utilities makefile.
98 *.8 Manpages for the respective utils.
103 The test scripts are somewhat specific to site at the moment, but they will
104 be changed to be more general and generic soon.
106 The following are found in test/:
108 100 Sub-directory of scripts to be run on one ipsec-capable machine (.100)
109 103 Sub-directory of scripts to be run on one ipsec-capable machine (.103)
110 110 Sub-directory of scripts to be run on one ipsec-capable machine (.110)
111 ji Sub-directory of scripts from JI's setup.
112 west Sub-directory of scripts to be run on one ipsec-capable machine (west)
113 snoop110-100 Script for starting a modified tcpdump to monitor traffic
114 between two machines. MAC's must be changed for your setup.
115 snoop110-105 Script for starting a modified tcpdump to monitor traffic
116 between two machines. MAC's must be changed for your setup.
119 The following are found in test/100:
121 103 Script to setup IPSEC connections with (192.168.2.) 103.
122 110 Script to setup IPSEC connections with (192.168.2.) 110.
123 west Script to setup IPSEC connections with west.
126 The following are found in test/103:
128 100 Script to setup IPSEC connections with (192.168.2.) 100.
129 110 Script to setup IPSEC connections with (192.168.2.) 110.
132 The following are found in test/110:
134 100 Script to setup IPSEC connections with (192.168.2.) 100.
135 103 Script to setup IPSEC connections with (192.168.2.) 103.
136 105 Script to setup IPSEC connections with (192.168.2.) 105.
139 The scripts found in test/ji were undocumented and are out of date.
142 The following are found in test/west:
144 magellan Script to setup IPSEC connections with magellan (100).
147 1.4. Documentation files
149 The following are found in doc/:
151 COPYING-2.0 GNU General Public License concerning this software.
152 CREDITS People and organisations that creditted for contributions.
153 TODO Klips list of things to do.
154 DONE Klips list of things completed.
155 func_tree.txt Shows the calling tree of the klips module.
156 ji_setup.txt JI's sample setup (obsolete).
157 rgb_setup.txt RGB's sample setup.
160 2. Please see doc/TODO for a list of some of the known bugs and problems.
164 * Revision 1.8 2000/11/06 05:42:58 rgb
165 * Updated file list (had not been done in 2 years?).
167 * Revision 1.7 2000/08/21 17:30:09 rgb
168 * Remove any references to src/.
170 * Revision 1.6 1999/04/06 04:54:22 rgb
171 * Fix/Add RCSID Id: and Log: bits to make PHMDs happy. This includes
174 * Revision 1.5 1998/11/25 04:54:34 rgb
175 * Updated files section to include newer transforms and other files.
177 * Revision 1.4 1998/05/01 03:47:17 rgb
178 * Minor cleanup of utils filenames overlooked in major overhaul.
180 * Revision 1.3 1998/05/01 03:40:31 rgb
182 * Removed install/initialise section with pointers to top-level INSTALL.txt.
183 * Updated filelists and providing descriptions of all files.
184 * Removed usage example and moved it to doc/*_setup.txt.
186 * Revision 1.2 1998/04/09 03:01:13 henry
187 * INSTALL.txt moves up, loses its installation instructions, and turns
188 * into the klips README.
190 * Revision 1.1.1.1 1998/04/08 05:35:13 henry
191 * RGB's ipsec-0.8pre2.tar.gz ipsec-0.8
195 * Cleaned up several transmission bugs.
197 * Revision 0.6 1997/09? ak
198 * Hooked in esp des-md5-96.
201 * Revision 0.5 1997/06/03 04:28:46 ji
202 * Added transport mode.
203 * Added esp 3des-md5-96.
205 * Revision 0.4 1997/01/14 21:35:31 ji
206 * Added new transforms.
207 * Cleaned up the user-level programs.
209 * Revision 0.3 1996/11/20 11:59:33 ji
210 * *** empty log message ***
213 * New in this release (0.3; works with the 2.0.24 kernel)
215 * > Cleaned up a fair amount of crud.
216 * > Fixed truncated names of /proc/net entries.
217 * > Made RCS versioning visible to the external release.
218 * > Rationalized debugging facilities.
219 * > Rationalized untar directory structure.
220 * > Fixed non-incrementing IV in DES-CBC
221 * > Cleaned up this file a bit and provided additional examples