54c04c4da5e063c973fc6a0afe3501f1afa83acb
[strongswan.git] / src / charon / config / credentials / 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 ca certificate of a specific subject distinguished name.
112 *
113 * @param this calling object
114 * @param id identification_t object identifiying the cacert.
115 * @return certificate, or NULL if not found
116 */
117 x509_t* (*get_ca_certificate) (credential_store_t *this, identification_t *id);
118
119 /**
120 * @brief Returns the ca certificate of a specific keyID.
121 *
122 * @param this calling object
123 * @param keyid identification_t object identifiying the cacert.
124 * @return certificate, or NULL if not found
125 */
126 x509_t* (*get_ca_certificate_by_keyid) (credential_store_t *this, chunk_t keyid);
127
128 /**
129 * @brief Returns the issuer certificate of a given certificate.
130 *
131 * @param this calling object
132 * @param id certificate for which issuer cert is required
133 * @return certificate, or NULL if not found
134 */
135 x509_t* (*get_issuer_certificate) (credential_store_t *this, const x509_t* cert);
136
137 /**
138 * @brief Verify an X.509 certificate up to trust anchor including revocation checks
139 *
140 * @param this calling object
141 * @param cert certificate to be verified
142 * @param found found a certificate copy in the credential store
143 * @return TRUE if trusted
144 */
145 bool (*verify) (credential_store_t *this, x509_t *cert, bool *found);
146
147 /**
148 * @brief If an end certificate does not already exists in the credential store then add it.
149 *
150 * @param this calling object
151 * @param cert certificate to be added
152 * @return pointer to the added or already existing certificate
153 */
154 x509_t* (*add_end_certificate) (credential_store_t *this, x509_t *cert);
155
156 /**
157 * @brief If a ca certificate does not already exists in the credential store then add it.
158 *
159 * @param this calling object
160 * @param cert ca certificate to be added
161 * @return pointer to the added or already existing certificate
162 */
163 x509_t* (*add_ca_certificate) (credential_store_t *this, x509_t *cert);
164
165 /**
166 * @brief If a ca info record does not already exists in the credential store then add it.
167 *
168 * @param this calling object
169 * @param ca_info ca info record to be added
170 */
171 void (*add_ca_info) (credential_store_t *this, ca_info_t *ca_info);
172
173 /**
174 * @brief Release a ca info record with a given name.
175 *
176 * @param this calling object
177 * @param name name of the ca info record to be released
178 * @return
179 * - SUCCESS, or
180 * - NOT_FOUND
181 */
182 status_t (*release_ca_info) (credential_store_t *this, const char *name);
183
184 /**
185 * @brief Create an iterator over all end certificates.
186 *
187 * @param this calling object
188 * @return iterator
189 */
190 iterator_t* (*create_cert_iterator) (credential_store_t *this);
191
192 /**
193 * @brief Create an iterator over all CA certificates.
194 *
195 * @param this calling object
196 * @return iterator
197 */
198 iterator_t* (*create_cacert_iterator) (credential_store_t *this);
199
200 /**
201 * @brief Create an iterator over all CA info records
202 *
203 * @param this calling object
204 * @return iterator
205 */
206 iterator_t* (*create_cainfo_iterator) (credential_store_t *this);
207
208 /**
209 * @brief Create an iterator over all CRLs.
210 *
211 * @param this calling object
212 * @return iterator
213 */
214 iterator_t* (*create_crl_iterator) (credential_store_t *this);
215
216 /**
217 * @brief Loads trusted CA certificates from a default directory.
218 *
219 * Certificates in both DER and PEM format are accepted
220 *
221 * @param this calling object
222 * @param path directory to load certificates from
223 */
224 void (*load_ca_certificates) (credential_store_t *this);
225
226 /**
227 * @brief Loads CRLs from a default directory.
228 *
229 * Certificates in both DER and PEM format are accepted
230 *
231 * @param this calling object
232 * @param path directory to load crls from
233 */
234 void (*load_crls) (credential_store_t *this);
235
236 /**
237 * @brief Loads secrets in ipsec.secrets
238 *
239 * Currently, all RSA private key files must be in unencrypted form
240 * either in DER or PEM format.
241 *
242 * @param this calling object
243 */
244 void (*load_secrets) (credential_store_t *this);
245
246 /**
247 * @brief Destroys a credential_store_t object.
248 *
249 * @param this calling object
250 */
251 void (*destroy) (credential_store_t *this);
252 };
253
254 /**
255 * @brief Creates a credential_store_t instance.
256 *
257 * @param strict enforce a strict crl policy
258 * @return credential store instance.
259 *
260 * @ingroup config
261 */
262 credential_store_t *credential_store_create(bool strict);
263
264
265 #endif /*CREDENTIAL_STORE_H_*/