- fixed bad bugs in kernel interface
[strongswan.git] / Source / charon / threads / stroke_interface.h
1 /**
2 * @file stroke.h
3 *
4 * @brief Interface of stroke_t.
5 *
6 */
7
8 /*
9 * Copyright (C) 2006 Martin Willi
10 * Hochschule fuer Technik Rapperswil
11 *
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
19 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 * for more details.
21 */
22
23 #ifndef STROKE_INTERFACE_H_
24 #define STROKE_INTERFACE_H_
25
26 #include <config/policy_store.h>
27 #include <config/connection_store.h>
28 #include <config/credential_store.h>
29
30
31 #define IPSEC_DIR "/etc/ipsec.d/"
32 #define PRIVATE_KEY_DIR IPSEC_DIR "private/"
33 #define CERTIFICATE_DIR IPSEC_DIR "certs/"
34
35
36 typedef struct stroke_t stroke_t;
37
38 /**
39 * @brief Stroke is a configuration and control interface which
40 * allows other processes to modify charons behavior.
41 *
42 * stroke_t allows config manipulation (as whack in pluto).
43 * Messages of type stroke_msg_t's are sent over a unix socket
44 * (/var/run/charon.ctl). stroke_t implements the connections_t
45 * and the policies_t interface, which means it acts as a
46 * configuration backend for those too. stroke_t uses an own
47 * thread to read from the socket.
48 *
49 * @warning DO NOT cast stroke_t to any of the implemented interfaces!
50 * stroke_t implements multiple interfaces, so you must use
51 * stroke_t.interface_xy to access the specific interface! You have
52 * been warned...
53 *
54 * @todo Add clean thread cancellation
55 *
56 * @b Constructors:
57 * - stroke_create()
58 *
59 * @ingroup threads
60 */
61 struct stroke_t {
62
63 /**
64 * Implements connection_store_t interface
65 */
66 connection_store_t connections;
67
68 /**
69 * Implements policy_store_t interface
70 */
71 policy_store_t policies;
72
73 /**
74 * Implements credential_store_t interfacce
75 */
76 credential_store_t credentials;
77
78 /**
79 * @brief Destroy a stroke_t instance.
80 *
81 * @param this stroke_t objec to destroy
82 */
83 void (*destroy) (stroke_t *this);
84 };
85
86
87 /**
88 * @brief Create the stroke interface and listen on the socket.
89 *
90 * @return stroke_t object
91 *
92 * @ingroup threads
93 */
94 stroke_t *stroke_create();
95
96 #endif /* STROKE_INTERFACE_H_ */