Added manager for DNS resolvers
[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 resolver resolver
53 * @ingroup libstrongswan
54 *
55 * @defgroup ipsec ipsec
56 * @ingroup libstrongswan
57 *
58 * @defgroup networking networking
59 * @ingroup libstrongswan
60 *
61 * @defgroup plugins plugins
62 * @ingroup libstrongswan
63 *
64 * @defgroup processing processing
65 * @ingroup libstrongswan
66 *
67 * @defgroup jobs jobs
68 * @ingroup processing
69 *
70 * @defgroup threading threading
71 * @ingroup libstrongswan
72 *
73 * @defgroup utils utils
74 * @ingroup libstrongswan
75 */
76
77 /**
78 * @defgroup library library
79 * @{ @ingroup libstrongswan
80 */
81
82 #ifndef LIBRARY_H_
83 #define LIBRARY_H_
84
85 #ifndef CONFIG_H_INCLUDED
86 # error config.h not included, pass "-include [...]/config.h" to gcc
87 #endif
88
89 /* make sure we include printf_hook.h and utils.h first */
90 #include "utils/printf_hook.h"
91 #include "utils/utils.h"
92 #include "networking/host_resolver.h"
93 #include "processing/processor.h"
94 #include "processing/scheduler.h"
95 #include "crypto/crypto_factory.h"
96 #include "crypto/proposal/proposal_keywords.h"
97 #include "fetcher/fetcher_manager.h"
98 #include "resolver/resolver_manager.h"
99 #include "database/database_factory.h"
100 #include "credentials/credential_factory.h"
101 #include "credentials/credential_manager.h"
102 #include "credentials/cred_encoding.h"
103 #include "utils/chunk.h"
104 #include "utils/integrity_checker.h"
105 #include "utils/leak_detective.h"
106 #include "utils/settings.h"
107 #include "plugins/plugin_loader.h"
108
109 typedef struct library_t library_t;
110
111 /**
112 * Libstrongswan library context, contains library relevant globals.
113 */
114 struct library_t {
115
116 /**
117 * Get an arbitrary object registered by name.
118 *
119 * @param name name of the object to get
120 * @return object, NULL if none found
121 */
122 void* (*get)(library_t *this, char *name);
123
124 /**
125 * (Un-)Register an arbitrary object using the given name.
126 *
127 * @param name name to register object under
128 * @param object object to register, NULL to unregister
129 * @return TRUE if registered, FALSE if name already taken
130 */
131 bool (*set)(library_t *this, char *name, void *object);
132
133 /**
134 * Printf hook registering facility
135 */
136 printf_hook_t *printf_hook;
137
138 /**
139 * Proposal keywords registry
140 */
141 proposal_keywords_t *proposal;
142
143 /**
144 * crypto algorithm registry and factory
145 */
146 crypto_factory_t *crypto;
147
148 /**
149 * credential constructor registry and factory
150 */
151 credential_factory_t *creds;
152
153 /**
154 * Manager for the credential set backends
155 */
156 credential_manager_t *credmgr;
157
158 /**
159 * Credential encoding registry and factory
160 */
161 cred_encoding_t *encoding;
162
163 /**
164 * URL fetching facility
165 */
166 fetcher_manager_t *fetcher;
167
168 /**
169 * Manager for DNS resolvers
170 */
171 resolver_manager_t *resolver;
172
173 /**
174 * database construction factory
175 */
176 database_factory_t *db;
177
178 /**
179 * plugin loading facility
180 */
181 plugin_loader_t *plugins;
182
183 /**
184 * process jobs using a thread pool
185 */
186 processor_t *processor;
187
188 /**
189 * schedule jobs
190 */
191 scheduler_t *scheduler;
192
193 /**
194 * resolve hosts by DNS name
195 */
196 host_resolver_t *hosts;
197
198 /**
199 * various settings loaded from settings file
200 */
201 settings_t *settings;
202
203 /**
204 * integrity checker to verify code integrity
205 */
206 integrity_checker_t *integrity;
207
208 /**
209 * Leak detective, if built and enabled
210 */
211 leak_detective_t *leak_detective;
212 };
213
214 /**
215 * Initialize library, creates "lib" instance.
216 *
217 * library_init() may be called multiple times in a single process, but each
218 * caller should call library_deinit() for each call to library_init().
219 *
220 * @param settings file to read settings from, may be NULL for default
221 * @return FALSE if integrity check failed
222 */
223 bool library_init(char *settings);
224
225 /**
226 * Deinitialize library, destroys "lib" instance.
227 */
228 void library_deinit();
229
230 /**
231 * Library instance, set after library_init() and before library_deinit() calls.
232 */
233 extern library_t *lib;
234
235 #endif /** LIBRARY_H_ @}*/