strongSwan

h1. strongSwan Developer Documentation

h2. Contributions

Before starting development, please read our [[Contributions|contribution requirements]].

h2. Getting the Source Code

The easiest way to get the source code is checking it out from our "Git":http://git-scm.com/ repository:

<pre>

git clone git://git.strongswan.org/strongswan.git

</pre>The repository is also mirrored to "GitHub":https://github.com/strongswan/strongswan.

h2. Browsing the Source Code

The Git repository can be browsed online using either "Gitweb":http://git.strongswan.org/?p=strongswan.git or the integrated "repository browser":http://wiki.strongswan.org/projects/strongswan/repository (slower).

h2. Source Code Documentation

The newer parts of strongSwan use extractable inline documentation extensively. This documentation is extracted with [[doxygen]] for the latest release

and uploaded to "strongswan.org/apidoc":http://www.strongswan.org/apidoc.

h2. Code style

For our code we heavily use an [[ObjectOrientedC|object oriented programming style]] for C. Also have a look to our basic [[ProgrammingStyle|programming style]] guidelines.

h2. Quality Assurance

h3. Unit Tests

Our libraries are tested with an increasing number of unit tests. To run them use @make check@.

The following environment variables change the behavior of the test runner:

|TESTS_REDUCED_KEYLENGTHS|If this is set test cases that generate keys will do so only for reduced key lengths to avoid blocking on hosts with low entropy.|

|TESTS_SUITES|A comma-separated list of test suites to run (all suites are run if this is not specified).|

|TESTS_VERBOSITY|The log level used when running the tests (-1 to 4, see [[LoggerConfiguration]]), defaults to -1.|

|LEAK_DETECTIVE_DISABLE|If our custom memory allocator is enabled with _--enable-leak-detective_ it can be disabled temporarily by setting this variable in order to speed up running the tests.|

Coverage reports can be generated with @make coverage@ (requires [[Autoconf|configuring]] with _--enable-coverage_, which is not recommended for production builds as it disables all optimizations).

The unit tests also run automatically on "Travis CI":https://travis-ci.org/strongswan/strongswan: !https://travis-ci.org/strongswan/strongswan.svg?branch=master!:https://travis-ci.org/strongswan/strongswan

h3. Testing Environment

Our [[TestingEnvironment|integration and regression testing environment]] helps us ensure the quality of future releases.

The "results for the latest release":http://strongswan.org/testresults.html are published online.

h2. Components

The _src_ directory in the strongSwan distribution contains a set of components:

|[[charon]]|The IKE keying daemon.|

|[[libstrongswan]]|The strongSwan library with basic functions used by the daemons and utilities |

|[[libcharon]]|Contains most of the code and the plugins of the charon daemon |

|[[libhydra]]|Contains daemon-specific code and plugins used by both the charon und pluto daemons |

|[[DynamicUmlMeshModeler|dumm]]|An new and experimental UML testing framework in development.|

|[[IpsecCommand|ipsec]]|The ipsec command line tool wrapping commands and other tools.|

|[[libfast]]|A lightweight framework to build native web applications using ClearSilver and FastCGI.|

|[[Manager|manager]]|A graphical management application for charon based on libfast.|

|[[OpenAc|openac]]|Utility to build attribute certificates on the command line.|

|[[IpsecPKI|pki]]|Public Key Infrastructure utility.|

|[[ScepClient|scepclient]]|Utility to enroll certificates using the SCEP protocol.|

|[[IpsecStarter|starter]]|Reads _ipsec.conf_ and controls the keying daemon.|

|[[IpsecStroke|stroke]]|Command line utility to control charon via the stroke protocol.|

h2. Removed since [[5.0.0]]

|[[pluto]]|The old IKEv1 keying daemon.|

|libfreeswan|The deprecated library used by pluto.|

|[[IpsecWhack|whack]]|Command line utility to control pluto via the whack protocol.|