Project

General

Profile

IKE keying daemon charon » History » Version 14

Tobias Brunner, 20.11.2008 18:00
typos

1 1 Martin Willi
2 14 Tobias Brunner
h1. IKEv2 keying daemon charon
3 14 Tobias Brunner
4 14 Tobias Brunner
5 14 Tobias Brunner
The _charon_ keying daemon was built from scratch to implement the IKEv2 protocol for strongSwan. 
6 1 Martin Willi
It has a fully multi-threaded design to meet todays requirements.
7 1 Martin Willi
8 14 Tobias Brunner
9 14 Tobias Brunner
h2. Architecture
10 14 Tobias Brunner
11 14 Tobias Brunner
<pre>
12 1 Martin Willi
      +---------------------------------+       +----------------------------+
13 4 Martin Willi
      |          Credentials            |       |          Backends          |
14 1 Martin Willi
      +---------------------------------+       +----------------------------+  
15 1 Martin Willi
                                                                              
16 1 Martin Willi
       +------------+    +-----------+        +------+            +----------+
17 1 Martin Willi
       |  receiver  |    |           |        |      |  +------+  | CHILD_SA |
18 1 Martin Willi
       +----+-------+    | Scheduler |        | IKE- |  | IKE- |--+----------+
19 1 Martin Willi
            |            |           |        | SA   |--| SA   |  | CHILD_SA |
20 1 Martin Willi
    +-------+--+         +-----------+        |      |  +------+  +----------+
21 1 Martin Willi
 <->|  socket  |               |              | Man- |
22 1 Martin Willi
    +-------+--+         +-----------+        | ager |  +------+  +----------+
23 1 Martin Willi
            |            |           |        |      |  | IKE- |--| CHILD_SA |
24 1 Martin Willi
       +----+-------+    | Processor |--------|      |--| SA   |  +----------+
25 1 Martin Willi
       |   sender   |    |           |        |      |  +------+                  
26 1 Martin Willi
       +------------+    +-----------+        +------+                   
27 1 Martin Willi
                                                                                 
28 1 Martin Willi
      +---------------------------------+       +----------------------------+
29 1 Martin Willi
      |               Bus               |       |      Kernel Interface      |
30 1 Martin Willi
      +---------------------------------+       +----------------------------+                                                                 
31 1 Martin Willi
             |                    |                           |
32 1 Martin Willi
      +-------------+     +-------------+                     V
33 1 Martin Willi
      | File-Logger |     |  Sys-Logger |                  //////
34 1 Martin Willi
      +-------------+     +-------------+                       
35 14 Tobias Brunner
</pre>
36 1 Martin Willi
37 1 Martin Willi
38 7 Martin Willi
||[browser:trunk/src/charon/processing/processor.h Processor]||The threading is realized with the help of a thread pool (called processor), which contains a fixed amount of precreated threads. All threads in the daemon originate from the processor. To delegate work to a thread, jobs are queued to the processor for asynchronous execution.||
39 7 Martin Willi
||[browser:trunk/src/charon/processing/scheduler.h Scheduler]||The scheduler is responsible to execute timed events. Jobs may be queued to the scheduler to get executed at a defined time (e.g. rekeying). The scheduler does not execute the jobs itself, it queues them to the processor.||
40 13 Tobias Brunner
||[browser:trunk/src/charon/sa/ike_sa_manager.h IKE_SA Manager]||The IKE_SA manager manages all IKE_SAs. It further handles the synchronization: Each IKE_SA must be checked out strictly and checked in again after use. The manager guarantees that only one thread may check out a single IKE_SA. This allows us to write the (complex) IKE_SAs routines non-threadsave.||
41 13 Tobias Brunner
||[browser:trunk/src/charon/sa/ike_sa.h IKE_SA]||The IKE_SA contain the state and the logic of each IKE_SA and handle the messages.||
42 13 Tobias Brunner
||[browser:trunk/src/charon/sa/child_sa.h CHILD_SA]||The CHILD_SA contains state about an IPsec security association and manages them. An IKE_SA may have multiple CHILD_SAs. Communication to the kernel takes place here through the kernel interface.||
43 13 Tobias Brunner
||[browser:trunk/src/charon/kernel/kernel_interface.h Kernel Interface]||The kernel interface installs IPsec security associations, policies, routes and virtual addresses. It further provides methods to enumerate interfaces and may notify the daemon about state changes at lower layers.||
44 7 Martin Willi
||[browser:trunk/src/charon/bus/bus.h Bus]||The bus receives signals from the different threads and relays them to interested listeners. Debugging signals, but also important state changes or error messages are sent over the bus.||
45 1 Martin Willi
||[browser:trunk/src/charon/control/controller.h Controller]||The controller provides a simple API for plugins to control the daemon (e.g. initiate IKE_SA, close IKE_SA, ...).||
46 1 Martin Willi
||[browser:trunk/src/charon/config/backend_manager.h Backends]||Backends are pluggable modules which provide configuration. They have to implement an API which the daemon core uses to get configuration.
47 1 Martin Willi
||[browser:trunk/src/charon/credentials/credential_manager.h Credentials]||Provides trustchain verification and credential serving using registered plugins.
48 7 Martin Willi
49 1 Martin Willi
50 1 Martin Willi
51 14 Tobias Brunner
h2. Plugins
52 14 Tobias Brunner
53 14 Tobias Brunner
54 5 Martin Willi
The daemon loads plugins at startup. These implement the [browser:trunk/src/libstrongswan/plugins/plugin.h plugin_t] interface. Each plugin registers itself at the daemon to hook in functionality. 
55 1 Martin Willi
56 14 Tobias Brunner
<pre>
57 4 Martin Willi
  +-------------------------------------+
58 4 Martin Willi
  | charon                  +---+ +-----+------+
59 4 Martin Willi
  |                         |   | |   stroke   |
60 4 Martin Willi
  |                         |   | +-----+------+
61 4 Martin Willi
  | +-------------+         |   | +-----+------+
62 4 Martin Willi
  | | bus         |  ---->  | p | |    smp     |
63 4 Martin Willi
  | +-------------+         | l | +-----+------+
64 4 Martin Willi
  | +-------------+  <----  | u | +-----+------+
65 4 Martin Willi
  | | controller  |         | g | |    sql     |
66 4 Martin Willi
  | +-------------+  ---->  | i | +-----+------+
67 4 Martin Willi
  | +-------------+         | n | +-----+------+
68 4 Martin Willi
  | | credentials |  <----  |   | |  eap_aka   |
69 4 Martin Willi
  | +-------------+         | l | +-----+------+
70 4 Martin Willi
  | +-------------+  ---->  | o | +-----+------+
71 4 Martin Willi
  | | backends    |         | a | |  eap_sim   |
72 1 Martin Willi
  | +-------------+  <----  | d | +-----+------+
73 1 Martin Willi
  | +-------------+         | e | +-----+------+
74 1 Martin Willi
  | | eap         |  ---->  | r | |  eap_md5   |
75 4 Martin Willi
  | +-------------+         |   | +-----+------+
76 4 Martin Willi
  |                         |   | +-----+------+
77 4 Martin Willi
  |                         |   | |eap_identity|
78 4 Martin Willi
  |                         +---+ +-----+------+
79 1 Martin Willi
  +-------------------------------------+
80 14 Tobias Brunner
</pre>
81 4 Martin Willi
82 6 Martin Willi
There is a growing list of available plugins:
83 14 Tobias Brunner
||[browser:trunk/src/charon/plugins/stroke stroke]||The stroke plugin loads credentials from _/etc/ipsec.d_, reads _ipsec.secrets_ and accepts configurations and control commands from ipsec starter.||
84 14 Tobias Brunner
||[browser:trunk/src/charon/plugins/smp smp]||The smp plugin implements the [[SMP]] protocol to control and query the daemon using an XML interface.||
85 14 Tobias Brunner
||[browser:trunk/src/charon/plugins/sql sql]||The sql plugin provides credentials and configurations from a relational database, see [[SQL]].||
86 6 Martin Willi
||[browser:trunk/src/charon/plugins/eap_aka eap_aka]||Implements the AKA EAP module implemented completely in software.||
87 6 Martin Willi
||[browser:trunk/src/charon/plugins/eap_sim eap_sim]||Implements the SIM EAP module using either a triplet file or a third party card reader library.||
88 11 Martin Willi
||[browser:trunk/src/charon/plugins/eap_md5 eap_md5]||Implements the MD5 EAP module (CHAP).||
89 6 Martin Willi
||[browser:trunk/src/charon/plugins/eap_gtc eap_gtc]||Implements a GTC EAP module to use for PAM authentication.||
90 12 Martin Willi
||[browser:trunk/src/charon/plugins/eap_identity eap_identity]||EAP helper module to serve an Identity over EAP before doing EAP authentication.||
91 14 Tobias Brunner
||[browser:trunk/src/charon/plugins/load_tester load_tester]||Run [[LoadTests]] against self or a remote host.||
92 8 Martin Willi
||[browser:trunk/src/charon/plugins/medcli medcli]||Reads mediation/mediated connections for a client from a simple database.||
93 10 Martin Willi
||[browser:trunk/src/charon/plugins/medsrv medsrv]||Reads mediation connections for a mediation server from a simple database.||
94 8 Martin Willi
||[browser:trunk/src/charon/plugins/nm nm]||!NetworkManager configuration and control interface.||
95 8 Martin Willi
||[browser:trunk/src/charon/plugins/uci uci]||OpenWRT UCI configuration backend.||
96 1 Martin Willi
||[browser:trunk/src/charon/plugins/unit_tester unit_tester]||Simple unit testing framework for charon and libstrongswan.||