strongSwan

h1. strongSwan Developer Documentation

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 _master_ branch 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, but can also be browsed here using the "Developer Documentation":http://wiki.strongswan.org/embedded/strongswan button above.

h2. Code style

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

h2. Contributions

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

h2. Components

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

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

|[[pluto]]|The IKEv1 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 |

|libfreeswan|The deprecated library used by pluto.|

|[[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 daemons pluto and charon.|

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

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