---------------------------
- strongSwan - Installation
+ strongSwan - Installation
---------------------------
Contents
--------
- 1. Required packages
- 2. Optional packages
- 2.1 libcurl
- 2.2 OpenLDAP
- 2.3 PKCS#11 smartcard library modules
- 3. Building strongSwan with a Linux 2.4 kernel
- 4. Updating strongSwan with a Linux 2.4 kernel
- 5. Building strongSwan with a Linux 2.6 kernel
+ 1. Overview
+ 2. Required packages
+ 3. Optional packages
+ 3.1 HTTP fetcher
+ 3.2 LDAP
+ 3.3 Other pluggable modules
+ 4. Kernel configuration
-
-1. Required packages
- -----------------
-
- In order to be able to build strongSwan you'll need the GNU Multiprecision
- Arithmetic Library (GMP) available from http://www.swox.com/gmp/.
-
- The libgmp library and the corresponding header file gmp.h are usually
- included in the form of one or two packages in the major Linux
- distributions (SuSE: gmp; Debian unstable: libgmp3, libgmp3-dev).
-
-
-2. Optional packages
- -----------------
-
-2.1 libcurl
- -------
-
- If you intend to dynamically fetch Certificate Revocation Lists (CRLs)
- from an HTTP server or as an alternative want to use the Online
- Certificate Status Protocol (OCSP) then you will need the libcurl library
- available from http://curl.haxx.se/.
-
- In order to keep the library as compact as possible for use with strongSwan
- you can build libcurl from the sources with the optimized options
-
- ./configure --prefix=<dir> --without-ssl \
- --disable-ldap --disable-telnet \
- --disable-dict --disable-gopher \
- --disable-debug \
- --enable-nonblocking --enable-thread
-
- As an alternative you can use the ready-made packages included with your
- favorite Linux distribution (SuSE: curl, curl-devel).
-
- In order to activate the use of the libcurl library in strongSwan you must
- set the USE_LIBCURL option in "Makefile.inc":
-
- # include libcurl support (CRL fetching, OCSP and SCEP)
- USE_LIBCURL?=true
-
- Under Gentoo emerge strongSwan with
-
- USE="curl -ssl" emerge strongswan
-
-
-2.2 OpenLDAP
+1. Overview
--------
- If you intend to dynamically fetch Certificate Revocation Lists (CRLs)
- from an LDAP server then you will need the libldap library available
- from http://www.openldap.org/.
-
- OpenLDAP is usually included with your Linux distribution. You will need
- both the run-time and development environments (SuSE: openldap2,
- openldap2-devel).
-
- In order to activate the use of the libldap library in strongSwan you must
- set the USE_LDAP option in "Makefile.inc":
+ Since version 4.x strongSwan uses the GNU build system (Autotools).
+ This simplifies the build process and package maintenance. First, check for
+ the availability of required packages on your system (section 2.). You may
+ want to include support for additional features, which require other
+ packages to be installed (section 3.).
- # include LDAP support (CRL fetching)
- USE_LDAP?=true
+ To compile an extracted tarball, run the ./configure script first:
- Depending upon whether your LDAP server understands the V3 (preferred) or
- V2 LDAP protocol, uncomment one ot the two following lines:
+ ./configure
- # Uncomment to enable dynamic CRL fetching using LDAP V3
- LDAP_VERSION=3
- # Uncomment to enable dynamic CRL fetching using LDAP V2
- #LDAP_VERSION=2
+ You may want to specify some arguments listed in section 3., or see the
+ available options of the script using "./configure --help".
- The latest OpenLDAP releases use the LDAP V3 protocol, whereas older
- versions require LDAP V2.
+ After a successful run of the script, run
- Under Gentoo emerge strongSwan with
+ make
- USE="ldap -ssl" emerge strongswan
+ followed by
+ make install
-2.3 PKCS#11 smartcard library modules
- ---------------------------------
+ in the usual manner.
- If you want to securely store your X.509 certificates and private RSA keys
- on a smart card or a USB crypto token then you will need a PKCS #11 library
- for the smart card of your choice. The OpenSC PKCS#11 library (use
- versions >= 0.9.4) available from http://www.opensc.org/ supports quite a
- selection of cards and tokens (e.g. Aladdin eToken Pro32k, Schlumberger
- Cryptoflex e-gate, Oberthur AuthentIC, etc.) but requires that a PKCS#15
- directory structure be present on the smart card. But in principle
- any other PKCS#11 library could be used since the PKCS#11 API hides the
- internal data representation on the card.
+ To check if your kernel fulfills the requirements, see section 4.
- For USB crypto token support you must add the OpenCT driver library
- (version >= 0.6.2) from the OpenSC site, whereas for serial smartcard
- readers you'll need the pcsc-lite library and the matching driver from the
- M.U.S.C.L.E project http://www.linuxnet.com/ .
+ Next add your connections to "/etc/ipsec.conf" and your secrets to
+ "/etc/ipsec.secrets".
- In order to activate the PKCS#11-based smartcard support in strongSwan
- you must set the USE_SMARTCARD option in "Makefile.inc":
+ At last start strongSwan with
- #include PKCS11-based smartcard support
- USE_SMARTCARD?=true
+ ipsec start
- During compilation no externel smart card libraries must be present.
- strongSwan directly references a copy of the standard RSAREF pkcs11.h
- header files stored in the pluto/rsaref sub directory. During compile
- time a pathname to a default PKCS#11 dynamical library can be specified
- in "Makefile.inc"
- # Uncomment this line if using OpenSC <= 0.9.6
- PKCS11_DEFAULT_LIB=\"/usr/lib/pkcs11/opensc-pkcs11.so\"
- # Uncomment tis line if using OpenSC >= 0.10.0
- #PKCS11_DEFAULT_LIB=\"usr/lib/opensc-pkcs11.so\"
+2. Required packages
+ -----------------
- This default path to the easily-obtainable OpenSC library module can be
- simply overridden during run-time by specifying an alternative path in
- ipsec.conf pointing to any dynamic PKCS#11 library of your choice.
+ In order to be able to build strongSwan you'll need one of the following
+ cryptographic libraries:
- config setup
- pkcs11module="/usr/lib/xyz-pkcs11.so"
+ * The GNU Multiprecision Arithmetic Library (GMP, libgmp)
+ http://www.gmplib.org
+ * The OpenSSL cryptographic library (libcrypto)
+ http://www.openssl.org
+ * The GNU cryptographic library (libgcrypt)
+ http://www.gnupg.org
- Under Gentoo emerge strongSwan with
+ If no other options are specified during ./configure libgmp will be used.
- USE="smartcard usb -pam -X" emerge strongswan
+ The libraries and the corresponding header files are usually included in
+ the form of one or two packages in the major Linux distributions (for GMP on
+ Debian: libgmp3 and libgmp3-dev).
-3. Building strongSwan with a Linux 2.4 kernel
- -------------------------------------------
+3. Optional packages
+ -----------------
- * Building strongSwan with a Linux 2.4 kernel requires the presence of the
- matching kernel sources referenced via the symbolic link /usr/src/linux.
- The use of the vanilla kernel sources from ftp.kernel.org is strongly
- recommended.
+3.1 HTTP Fetcher
+ ------------
- Before building strongSwan you must have compiled the kernel sources at
- least once:
+ If you intend to dynamically fetch Certificate Revocation Lists (CRLs)
+ from an HTTP server or as an alternative want to use the Online
+ Certificate Status Protocol (OCSP) then you will need the either of the
+ following libraries:
- make menuconfig; make dep; make bzImage; make modules
+ * The cURL library (libcurl)
+ http://curl.haxx.se/libcurl/
+ * The LibSoup library (libsoup)
+ https://live.gnome.org/LibSoup
- * Now change into the strongswan-2.x.x source directory.
+ In order to activate the use of either of these libraries in strongSwan you
+ must enable the appropriate ./configure switch.
- First uncomment any desired compile options in "programs/pluto/Makefile"
- (see section 2. Optional packages).
- Then in the top source directory type
+3.2 LDAP
+ ----
- make menumod
+ If you intend to dynamically fetch Certificate Revocation Lists (CRLs)
+ from an LDAP server then you will need the libldap library available
+ from http://www.openldap.org/.
- This command applies an ESP_IN_UDP encapsulation patch which is required
- for NAT-Traversal to the kernel sources.
-
- In the "Networking options" menu set
-
- <M> IP Security Protocol (strongSwan IPsec)
-
- in order to build KLIPS as a loadable kernel module "ipsec.o". Do not
- forget to save the modified configuration file when leaving "menumod".
-
- The strongSwan userland programs are now automatically built and
- installed, whereas the ipsec.o kernel module and the crypto modules
- are only built and must be installed with the command
-
- make minstall
-
- * If you intend to use the NAT-Traversal feature then you must compile the
- patched kernel sources again by executing
-
- make bzImage
-
- and then install and boot the modified kernel.
-
- * Next add your connections to "/etc/ipsec.conf" and start strongSwan with
-
- ipsec setup start
-
-
-4. Updating strongSwan with a Linux 2.4 kernel
- -------------------------------------------
-
- * If you have already successfully installed strongSwan and want to update
- to a newer version then the following shortcut can be taken:
-
- First uncomment any desired compile options in "programs/pluto/Makefile"
- (see section 2. Optional packages).
-
- Then in the strongwan-2.x.x top directory type
-
- make programs; make install
-
- followed by
+ OpenLDAP is usually included with your Linux distribution. You will need
+ both the run-time and development environments (SuSE: openldap2,
+ openldap2-devel).
- make module; make minstall
+ In order to activate the use of the libldap library in strongSwan you must
+ enable the ./configure switch:
- * You can then start the updated strongSwan version with
+ ./configure [...] --enable-ldap
- ipsec setup restart
+ LDAP Protocol version 2 is not supported anymore, --enable-ldap uses always
+ version 3 of the LDAP protocol
-5. Building strongSwan with a Linux 2.6 kernel
- -------------------------------------------
+3.3 Other pluggable modules
+ -----------------------
- * Because the Linux 2.6 kernel comes with a built-in native IPsec stack,
- you won't need to build the strongSwan kernel modules. Please make sure
- that the the following Linux 2.6 IPsec kernel modules are available:
+ There are many other optional plugins that, for instance, provide support
+ for PKCS#11 or SQL databases.
+ For a more detailed description of these refer to our wiki:
- o af_key
- o ah4
- o esp4
- o ipcomp
- o xfrm_user
+ * http://wiki.strongswan.org
- Also the built-in kernel Cryptoapi modules with selected encryption and
- hash algorithms should be available.
- * First uncomment any desired compile options in "programs/pluto/Makefile"
- (see section 2. Optional packages).
+4. Kernel configuration
+ --------------------
- Then in the strongwan-2.x.x top directory type
+ Since version 4.x strongSwan only supports 2.6.x and 3.x kernels and its
+ native NETKEY IPsec stack. Please make sure that the following IPsec kernel
+ modules are available:
- make programs
+ * af_key
+ * ah4
+ * esp4
+ * ipcomp
+ * xfrm_user
+ * xfrm4_tunnel
- followed by
+ These may be built into the kernel or as modules. Modules get loaded
+ automatically at strongSwan startup.
- make install
+ Also the built-in kernel Cryptoapi modules with selected encryption and
+ hash algorithms should be available.
- * Next add your connections to "etc/ipsec.conf" and start strongSwan with
+ Support for multiple routing tables is also recommended.
- ipsec setup start
+ For a more up-to-date list of recommended modules refer to:
------------------------------------------------------------------------------
+ * http://wiki.strongswan.org/projects/strongswan/wiki/KernelModules
-This file is RCSID $Id: INSTALL,v 1.8 2006/01/22 16:22:23 as Exp $