fixed compilation warnings and errors when not using curl
[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, identification_t *other_id, chunk_t *shared_key);
62
63 /**
64 * @brief Returns the RSA public key of a specific ID.
65 *
66 * @param this calling object
67 * @param id identification_t object identifiying the key.
68 * @return public key, or NULL if not found
69 */
70 rsa_public_key_t* (*get_rsa_public_key) (credential_store_t *this, identification_t *id);
71
72 /**
73 * @brief Returns the RSA public key of a specific ID if is trusted
74 *
75 * @param this calling object
76 * @param id identification_t object identifiying the key.
77 * @return public key, or NULL if not found or not trusted
78 */
79 rsa_public_key_t* (*get_trusted_public_key) (credential_store_t *this, identification_t *id);
80
81 /**
82 * @brief Returns the RSA private key belonging to an RSA public key
83 *
84 * The returned rsa_private_key_t must be destroyed by the caller after usage.
85 *
86 * @param this calling object
87 * @param pubkey public key
88 * @return private key, or NULL if not found
89 */
90 rsa_private_key_t* (*get_rsa_private_key) (credential_store_t *this, rsa_public_key_t *pubkey);
91
92 /**
93 * @brief Is there a matching RSA private key belonging to an RSA public key?
94 *
95 * @param this calling object
96 * @param pubkey public key
97 * @return TRUE if matching private key was found
98 */
99 bool (*has_rsa_private_key) (credential_store_t *this, rsa_public_key_t *pubkey);
100
101 /**
102 * @brief Returns the certificate of a specific ID.
103 *
104 * @param this calling object
105 * @param id identification_t object identifiying the cert.
106 * @return certificate, or NULL if not found
107 */
108 x509_t* (*get_certificate) (credential_store_t *this, identification_t *id);
109
110 /**
111 * @brief Returns the auth certificate of a specific subject distinguished name.
112 *
113 * @param this calling object
114 * @param auth_flags set of allowed authority types
115 * @param id identification_t object identifiying the cacert.
116 * @return certificate, or NULL if not found
117 */
118 x509_t* (*get_auth_certificate) (credential_store_t *this, u_int auth_flags, identification_t *id);
119
120 /**
121 * @brief Returns the ca certificate of a specific keyID.
122 *
123 * @param this calling object
124 * @param keyid identification_t object identifiying the cacert.
125 * @return certificate, or NULL if not found
126 */
127 x509_t* (*get_ca_certificate_by_keyid) (credential_store_t *this, chunk_t keyid);
128
129 /**
130 * @brief Returns the issuing ca of a given certificate.
131 *
132 * @param this calling object
133 * @param cert certificate for which issuer ca info is required
134 * @return ca info, or NULL if not found
135 */
136 ca_info_t* (*get_issuer) (credential_store_t *this, const x509_t* cert);
137
138 /**
139 * @brief Verify an X.509 certificate up to trust anchor without any status checks
140 *
141 * @param this calling object
142 * @param cert certificate to be verified
143 * @return TRUE if trusted
144 */
145 bool (*is_trusted) (credential_store_t *this, x509_t *cert);
146
147 /**
148 * @brief Verify an X.509 certificate up to trust anchor including status checks
149 *
150 * @param this calling object
151 * @param cert certificate to be verified
152 * @param found found a certificate copy in the credential store
153 * @return TRUE if valid, trusted, and current status is good
154 */
155 bool (*verify) (credential_store_t *this, x509_t *cert, bool *found);
156
157 /**
158 * @brief If an end certificate does not already exists in the credential store then add it.
159 *
160 * @param this calling object
161 * @param cert certificate to be added
162 * @return pointer to the added or already existing certificate
163 */
164 x509_t* (*add_end_certificate) (credential_store_t *this, x509_t *cert);
165
166 /**
167 * @brief If an authority certificate does not already exists in the credential store then add it.
168 *
169 * @param this calling object
170 * @param cert authority certificate to be added
171 * @param auth_flag authority flags to add to the certificate
172 * @return pointer to the added or already existing certificate
173 */
174 x509_t* (*add_auth_certificate) (credential_store_t *this, x509_t *cert, u_int auth_flag);
175
176 /**
177 * @brief If a ca info record does not already exists in the credential store then add it.
178 *
179 * @param this calling object
180 * @param ca_info ca info record to be added
181 */
182 void (*add_ca_info) (credential_store_t *this, ca_info_t *ca_info);
183
184 /**
185 * @brief Release a ca info record with a given name.
186 *
187 * @param this calling object
188 * @param name name of the ca info record to be released
189 * @return
190 * - SUCCESS, or
191 * - NOT_FOUND
192 */
193 status_t (*release_ca_info) (credential_store_t *this, const char *name);
194
195 /**
196 * @brief Create an iterator over all end certificates.
197 *
198 * @param this calling object
199 * @return iterator
200 */
201 iterator_t* (*create_cert_iterator) (credential_store_t *this);
202
203 /**
204 * @brief Create an iterator over all authority certificates.
205 *
206 * @param this calling object
207 * @return iterator
208 */
209 iterator_t* (*create_auth_cert_iterator) (credential_store_t *this);
210
211 /**
212 * @brief Create an iterator over all CA info records
213 *
214 * @param this calling object
215 * @return iterator
216 */
217 iterator_t* (*create_cainfo_iterator) (credential_store_t *this);
218
219 /**
220 * @brief Check if there are any CRLs.
221 *
222 * @param this calling object
223 * @param out output stream
224 * @param utc either utc or local time
225 */
226 void (*list_crls) (credential_store_t *this, FILE *out, bool utc);
227
228 /**
229 * @brief Loads ca certificates from a default directory.
230 *
231 * Certificates in both DER and PEM format are accepted
232 *
233 * @param this calling object
234 */
235 void (*load_ca_certificates) (credential_store_t *this);
236
237 /**
238 * @brief Loads ocsp certificates from a default directory.
239 *
240 * Certificates in both DER and PEM format are accepted
241 *
242 * @param this calling object
243 */
244 void (*load_ocsp_certificates) (credential_store_t *this);
245
246 /**
247 * @brief Loads CRLs from a default directory.
248 *
249 * Certificates in both DER and PEM format are accepted
250 *
251 * @param this calling object
252 * @param path directory to load crls from
253 */
254 void (*load_crls) (credential_store_t *this);
255
256 /**
257 * @brief Loads secrets in ipsec.secrets
258 *
259 * Currently, all RSA private key files must be in unencrypted form
260 * either in DER or PEM format.
261 *
262 * @param this calling object
263 */
264 void (*load_secrets) (credential_store_t *this);
265
266 /**
267 * @brief Destroys a credential_store_t object.
268 *
269 * @param this calling object
270 */
271 void (*destroy) (credential_store_t *this);
272 };
273
274 /**
275 * @brief Creates a credential_store_t instance.
276 *
277 * @param strict enforce a strict crl policy
278 * @return credential store instance.
279 *
280 * @ingroup config
281 */
282 credential_store_t *credential_store_create(bool strict);
283
284
285 #endif /*CREDENTIAL_STORE_H_*/