Add a chunk_from_str() initializer that does not include 0-terminator
[strongswan.git] / src / libstrongswan / library.h
1 /*
2 * Copyright (C) 2008 Martin Willi
3 * Hochschule fuer Technik Rapperswil
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 */
15
16 /**
17 * @defgroup libstrongswan libstrongswan
18 *
19 * @defgroup asn1 asn1
20 * @ingroup libstrongswan
21 *
22 * @defgroup bio bio
23 * @ingroup libstrongswan
24 *
25 * @defgroup collections collections
26 * @ingroup libstrongswan
27 *
28 * @defgroup credentials credentials
29 * @ingroup libstrongswan
30 *
31 * @defgroup keys keys
32 * @ingroup credentials
33 *
34 * @defgroup certificates certificates
35 * @ingroup credentials
36 *
37 * @defgroup containers containers
38 * @ingroup credentials
39 *
40 * @defgroup sets sets
41 * @ingroup credentials
42 *
43 * @defgroup crypto crypto
44 * @ingroup libstrongswan
45 *
46 * @defgroup database database
47 * @ingroup libstrongswan
48 *
49 * @defgroup fetcher fetcher
50 * @ingroup libstrongswan
51 *
52 * @defgroup ipsec ipsec
53 * @ingroup libstrongswan
54 *
55 * @defgroup networking networking
56 * @ingroup libstrongswan
57 *
58 * @defgroup plugins plugins
59 * @ingroup libstrongswan
60 *
61 * @defgroup processing processing
62 * @ingroup libstrongswan
63 *
64 * @defgroup jobs jobs
65 * @ingroup processing
66 *
67 * @defgroup threading threading
68 * @ingroup libstrongswan
69 *
70 * @defgroup utils utils
71 * @ingroup libstrongswan
72 */
73
74 /**
75 * @defgroup library library
76 * @{ @ingroup libstrongswan
77 */
78
79 #ifndef LIBRARY_H_
80 #define LIBRARY_H_
81
82 #ifndef CONFIG_H_INCLUDED
83 # error config.h not included, pass "-include [...]/config.h" to gcc
84 #endif
85
86 /* make sure we include printf_hook.h and utils.h first */
87 #include "utils/printf_hook.h"
88 #include "utils/utils.h"
89 #include "networking/host_resolver.h"
90 #include "processing/processor.h"
91 #include "processing/scheduler.h"
92 #include "crypto/crypto_factory.h"
93 #include "crypto/proposal/proposal_keywords.h"
94 #include "fetcher/fetcher_manager.h"
95 #include "database/database_factory.h"
96 #include "credentials/credential_factory.h"
97 #include "credentials/credential_manager.h"
98 #include "credentials/cred_encoding.h"
99 #include "utils/chunk.h"
100 #include "utils/integrity_checker.h"
101 #include "utils/leak_detective.h"
102 #include "utils/settings.h"
103 #include "plugins/plugin_loader.h"
104
105 typedef struct library_t library_t;
106
107 /**
108 * Libstrongswan library context, contains library relevant globals.
109 */
110 struct library_t {
111
112 /**
113 * Get an arbitrary object registered by name.
114 *
115 * @param name name of the object to get
116 * @return object, NULL if none found
117 */
118 void* (*get)(library_t *this, char *name);
119
120 /**
121 * (Un-)Register an arbitrary object using the given name.
122 *
123 * @param name name to register object under
124 * @param object object to register, NULL to unregister
125 * @return TRUE if registered, FALSE if name already taken
126 */
127 bool (*set)(library_t *this, char *name, void *object);
128
129 /**
130 * Printf hook registering facility
131 */
132 printf_hook_t *printf_hook;
133
134 /**
135 * Proposal keywords registry
136 */
137 proposal_keywords_t *proposal;
138
139 /**
140 * crypto algorithm registry and factory
141 */
142 crypto_factory_t *crypto;
143
144 /**
145 * credential constructor registry and factory
146 */
147 credential_factory_t *creds;
148
149 /**
150 * Manager for the credential set backends
151 */
152 credential_manager_t *credmgr;
153
154 /**
155 * Credential encoding registry and factory
156 */
157 cred_encoding_t *encoding;
158
159 /**
160 * URL fetching facility
161 */
162 fetcher_manager_t *fetcher;
163
164 /**
165 * database construction factory
166 */
167 database_factory_t *db;
168
169 /**
170 * plugin loading facility
171 */
172 plugin_loader_t *plugins;
173
174 /**
175 * process jobs using a thread pool
176 */
177 processor_t *processor;
178
179 /**
180 * schedule jobs
181 */
182 scheduler_t *scheduler;
183
184 /**
185 * resolve hosts by DNS name
186 */
187 host_resolver_t *hosts;
188
189 /**
190 * various settings loaded from settings file
191 */
192 settings_t *settings;
193
194 /**
195 * integrity checker to verify code integrity
196 */
197 integrity_checker_t *integrity;
198
199 /**
200 * Leak detective, if built and enabled
201 */
202 leak_detective_t *leak_detective;
203 };
204
205 /**
206 * Initialize library, creates "lib" instance.
207 *
208 * library_init() may be called multiple times in a single process, but each
209 * caller should call library_deinit() for each call to library_init().
210 *
211 * @param settings file to read settings from, may be NULL for default
212 * @return FALSE if integrity check failed
213 */
214 bool library_init(char *settings);
215
216 /**
217 * Deinitialize library, destroys "lib" instance.
218 */
219 void library_deinit();
220
221 /**
222 * Library instance, set after library_init() and before library_deinit() calls.
223 */
224 extern library_t *lib;
225
226 #endif /** LIBRARY_H_ @}*/