This file is a guide to the locations of files within the FreeS/WAN distribution. Everything described here should be on your system once you download, gunzip, and untar the distribution.
This distribution contains two major subsystems
plus assorted odds and ends.
The top directory has essential information in text files:
The doc directory contains the bulk of the documentation, most of it in HTML format. See the index file for details.
KLIPS is Kerne L IP Security. It lives in the klips directory, of course.
The "make insert" step of installation installs the patches and makes a symbolic link from the kernel tree to klips/net/ipsec. The odd name of klips/net/ipsec is dictated by some annoying limitations of the scripts which build the Linux kernel. The symbolic-link business is a bit messy, but all the alternatives are worse.
These are all normally invoked by ipsec(8) with commands such as
ipsec tncfg argumentsThere are section 8 man pages for all of these; the names have "ipsec_" as a prefix, so your man command should be something like:
man 8 ipsec_tncfg
Pluto is our key management and negotiation daemon. It lives in the pluto directory, along with its low-level user utility, whack.
There are no subdirectories. Documentation is a man page, pluto.8. This covers whack as well.
The utils directory contains a growing collection of higher-level user utilities, the commands that administer and control the software. Most of the things that you will actually have to run yourself are in there.
ipsec(8) is normally the only program installed in a standard directory, /usr/local/sbin. It is used to invoke the others, both those listed below and the ones in klips/utils mentioned above.
There are .8 manual pages for these. look is covered in barf.8. The man pages have an "ipsec_" prefix so your man command should be something like:
man 8 ipsec_auto
Examples are in various files with names utils/*.eg
The lib directory is the FreeS/WAN library, also steadily growing,
used by both user-level and kernel code.
It includes section 3 man pages for the library routines.
Note that this library has its own license, different from the GPL used for other code in FreeS/WAN.
The library includes its own documentation.
Older versions (up to 1.7) of FreeS/WAN included a copy of this library in the FreeS/WAN distribution.
Since 1.8, we have begun to rely on the system copy of GMP.