cosmetics
[strongswan.git] / src / libstrongswan / credential_store.h
1 /**
2 * @file credential_store.h
3 *
4 * @brief Interface credential_store_t.
5 *
6 */
7
8 /*
9 * Copyright (C) 2005-2006 Martin Willi
10 * Copyright (C) 2005 Jan Hutter
11 * Hochschule fuer Technik Rapperswil
12 *
13 * This program is free software; you can redistribute it and/or modify it
14 * under the terms of the GNU General Public License as published by the
15 * Free Software Foundation; either version 2 of the License, or (at your
16 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
17 *
18 * This program is distributed in the hope that it will be useful, but
19 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
20 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 * for more details.
22 */
23
24 #ifndef CREDENTIAL_STORE_H_
25 #define CREDENTIAL_STORE_H_
26
27 typedef struct credential_store_t credential_store_t;
28
29 #include <library.h>
30 #include <crypto/x509.h>
31 #include <crypto/ca.h>
32 #include <crypto/rsa/rsa_private_key.h>
33 #include <crypto/rsa/rsa_public_key.h>
34 #include <utils/identification.h>
35
36
37 /**
38 * @brief The interface for a credential_store backend.
39 *
40 * @b Constructors:
41 * - stroke_create()
42 *
43 * @ingroup config
44 */
45 struct credential_store_t {
46
47 /**
48 * @brief Returns the secret shared by two specific IDs.
49 *
50 * The returned chunk must be destroyed by the caller after usage.
51 *
52 * @param this calling object
53 * @param my_id my ID identifiying the secret.
54 * @param other_id peer ID identifying the secret.
55 * @param[out] secret the pre-shared secret will be written there.
56 * @return
57 * - NOT_FOUND if no preshared secrets for specific ID could be found
58 * - SUCCESS
59 *
60 */
61 status_t (*get_shared_key) (credential_store_t *this, identification_t *my_id,
62 identification_t *other_id, chunk_t *shared_key);
63
64 /**
65 * @brief Returns the EAP secret for two specified IDs.
66 *
67 * The returned chunk must be destroyed by the caller after usage.
68 *
69 * @param this calling object
70 * @param my_id my ID identifiying the secret.
71 * @param other_id peer ID identifying the secret.
72 * @param[out] eap_key the EAP secret will be written here
73 * @return
74 * - NOT_FOUND if no preshared secrets for specific ID could be found
75 * - SUCCESS
76 *
77 */
78 status_t (*get_eap_key) (credential_store_t *this, identification_t *my_id,
79 identification_t *other_id, chunk_t *eap_key);
80
81 /**
82 * @brief Returns the RSA public key of a specific ID.
83 *
84 * @param this calling object
85 * @param id identification_t object identifiying the key.
86 * @return public key, or NULL if not found
87 */
88 rsa_public_key_t* (*get_rsa_public_key) (credential_store_t *this, identification_t *id);
89
90 /**
91 * @brief Returns the RSA public key of a specific ID if is trusted
92 *
93 * @param this calling object
94 * @param id identification_t object identifiying the key.
95 * @return public key, or NULL if not found or not trusted
96 */
97 rsa_public_key_t* (*get_trusted_public_key) (credential_store_t *this, identification_t *id);
98
99 /**
100 * @brief Returns the RSA private key belonging to an RSA public key
101 *
102 * The returned rsa_private_key_t must be destroyed by the caller after usage.
103 *
104 * @param this calling object
105 * @param pubkey public key
106 * @return private key, or NULL if not found
107 */
108 rsa_private_key_t* (*get_rsa_private_key) (credential_store_t *this, rsa_public_key_t *pubkey);
109
110 /**
111 * @brief Is there a matching RSA private key belonging to an RSA public key?
112 *
113 * @param this calling object
114 * @param pubkey public key
115 * @return TRUE if matching private key was found
116 */
117 bool (*has_rsa_private_key) (credential_store_t *this, rsa_public_key_t *pubkey);
118
119 /**
120 * @brief Returns the certificate of a specific ID.
121 *
122 * @param this calling object
123 * @param id identification_t object identifiying the cert.
124 * @return certificate, or NULL if not found
125 */
126 x509_t* (*get_certificate) (credential_store_t *this, identification_t *id);
127
128 /**
129 * @brief Returns the auth certificate of a specific subject distinguished name.
130 *
131 * @param this calling object
132 * @param auth_flags set of allowed authority types
133 * @param id identification_t object identifiying the cacert.
134 * @return certificate, or NULL if not found
135 */
136 x509_t* (*get_auth_certificate) (credential_store_t *this, u_int auth_flags, identification_t *id);
137
138 /**
139 * @brief Returns the ca certificate of a specific keyID.
140 *
141 * @param this calling object
142 * @param keyid identification_t object identifiying the cacert.
143 * @return certificate, or NULL if not found
144 */
145 x509_t* (*get_ca_certificate_by_keyid) (credential_store_t *this, chunk_t keyid);
146
147 /**
148 * @brief Returns the issuing ca of a given certificate.
149 *
150 * @param this calling object
151 * @param cert certificate for which issuer ca info is required
152 * @return ca info, or NULL if not found
153 */
154 ca_info_t* (*get_issuer) (credential_store_t *this, const x509_t* cert);
155
156 /**
157 * @brief Verify an X.509 certificate up to trust anchor without any status checks
158 *
159 * @param this calling object
160 * @param cert certificate to be verified
161 * @return TRUE if trusted
162 */
163 bool (*is_trusted) (credential_store_t *this, x509_t *cert);
164
165 /**
166 * @brief Verify an X.509 certificate up to trust anchor including status checks
167 *
168 * @param this calling object
169 * @param cert certificate to be verified
170 * @param found found a certificate copy in the credential store
171 * @return TRUE if valid, trusted, and current status is good
172 */
173 bool (*verify) (credential_store_t *this, x509_t *cert, bool *found);
174
175 /**
176 * @brief If an end certificate does not already exists in the credential store then add it.
177 *
178 * @param this calling object
179 * @param cert certificate to be added
180 * @return pointer to the added or already existing certificate
181 */
182 x509_t* (*add_end_certificate) (credential_store_t *this, x509_t *cert);
183
184 /**
185 * @brief If an authority certificate does not already exists in the credential store then add it.
186 *
187 * @param this calling object
188 * @param cert authority certificate to be added
189 * @param auth_flag authority flags to add to the certificate
190 * @return pointer to the added or already existing certificate
191 */
192 x509_t* (*add_auth_certificate) (credential_store_t *this, x509_t *cert, u_int auth_flag);
193
194 /**
195 * @brief If a ca info record does not already exists in the credential store then add it.
196 *
197 * @param this calling object
198 * @param ca_info ca info record to be added
199 */
200 void (*add_ca_info) (credential_store_t *this, ca_info_t *ca_info);
201
202 /**
203 * @brief Release a ca info record with a given name.
204 *
205 * @param this calling object
206 * @param name name of the ca info record to be released
207 * @return
208 * - SUCCESS, or
209 * - NOT_FOUND
210 */
211 status_t (*release_ca_info) (credential_store_t *this, const char *name);
212
213 /**
214 * @brief Create an iterator over all end certificates.
215 *
216 * @param this calling object
217 * @return iterator
218 */
219 iterator_t* (*create_cert_iterator) (credential_store_t *this);
220
221 /**
222 * @brief Create an iterator over all authority certificates.
223 *
224 * @param this calling object
225 * @return iterator
226 */
227 iterator_t* (*create_auth_cert_iterator) (credential_store_t *this);
228
229 /**
230 * @brief Create an iterator over all CA info records
231 *
232 * @param this calling object
233 * @return iterator
234 */
235 iterator_t* (*create_cainfo_iterator) (credential_store_t *this);
236
237 /**
238 * @brief Check if there are any CRLs.
239 *
240 * @param this calling object
241 * @param out output stream
242 * @param utc either utc or local time
243 */
244 void (*list_crls) (credential_store_t *this, FILE *out, bool utc);
245
246 /**
247 * @brief Check if there are any OCSP cert infos
248 *
249 * @param this calling object
250 * @param out output stream
251 * @param utc either utc or local time
252 */
253 void (*list_ocsp) (credential_store_t *this, FILE *out, bool utc);
254
255 /**
256 * @brief Loads ca certificates from a default directory.
257 *
258 * Certificates in both DER and PEM format are accepted
259 *
260 * @param this calling object
261 */
262 void (*load_ca_certificates) (credential_store_t *this);
263
264 /**
265 * @brief Loads ocsp certificates from a default directory.
266 *
267 * Certificates in both DER and PEM format are accepted
268 *
269 * @param this calling object
270 */
271 void (*load_ocsp_certificates) (credential_store_t *this);
272
273 /**
274 * @brief Loads CRLs from a default directory.
275 *
276 * Certificates in both DER and PEM format are accepted
277 *
278 * @param this calling object
279 * @param path directory to load crls from
280 */
281 void (*load_crls) (credential_store_t *this);
282
283 /**
284 * @brief Loads secrets in ipsec.secrets
285 *
286 * Currently, all RSA private key files must be in unencrypted form
287 * either in DER or PEM format.
288 *
289 * @param this calling object
290 */
291 void (*load_secrets) (credential_store_t *this);
292
293 /**
294 * @brief Destroys a credential_store_t object.
295 *
296 * @param this calling object
297 */
298 void (*destroy) (credential_store_t *this);
299 };
300
301 /**
302 * @brief Creates a credential_store_t instance.
303 *
304 * @param strict enforce a strict crl policy
305 * @return credential store instance.
306 *
307 * @ingroup config
308 */
309 credential_store_t *credential_store_create(bool strict);
310
311
312 #endif /*CREDENTIAL_STORE_H_*/