2 * Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 #ifndef OPENSSL_STORE_H
11 # define OPENSSL_STORE_H
14 # include <openssl/macros.h>
15 # ifndef OPENSSL_NO_DEPRECATED_3_0
16 # define HEADER_OSSL_STORE_H
20 # include <openssl/types.h>
21 # include <openssl/pem.h>
22 # include <openssl/storeerr.h>
29 * The main OSSL_STORE functions.
30 * ------------------------------
32 * These allow applications to open a channel to a resource with supported
33 * data (keys, certs, crls, ...), read the data a piece at a time and decide
34 * what to do with it, and finally close.
37 typedef struct ossl_store_ctx_st OSSL_STORE_CTX;
40 * Typedef for the OSSL_STORE_INFO post processing callback. This can be used
41 * to massage the given OSSL_STORE_INFO, or to drop it entirely (by returning
44 typedef OSSL_STORE_INFO *(*OSSL_STORE_post_process_info_fn)(OSSL_STORE_INFO *,
48 * Open a channel given a URI. The given UI method will be used any time the
49 * loader needs extra input, for example when a password or pin is needed, and
50 * will be passed the same user data every time it's needed in this context.
52 * Returns a context reference which represents the channel to communicate
56 OSSL_STORE_open(const char *uri, const UI_METHOD *ui_method, void *ui_data,
57 OSSL_STORE_post_process_info_fn post_process,
58 void *post_process_data);
60 OSSL_STORE_open_with_libctx(const char *uri,
61 OPENSSL_CTX *libctx, const char *propq,
62 const UI_METHOD *ui_method, void *ui_data,
63 OSSL_STORE_post_process_info_fn post_process,
64 void *post_process_data);
67 * Control / fine tune the OSSL_STORE channel. |cmd| determines what is to be
68 * done, and depends on the underlying loader (use OSSL_STORE_get0_scheme to
69 * determine which loader is used), except for common commands (see below).
70 * Each command takes different arguments.
72 int OSSL_STORE_ctrl(OSSL_STORE_CTX *ctx, int cmd, ... /* args */);
73 int OSSL_STORE_vctrl(OSSL_STORE_CTX *ctx, int cmd, va_list args);
76 * Common ctrl commands that different loaders may choose to support.
78 /* int on = 0 or 1; STORE_ctrl(ctx, STORE_C_USE_SECMEM, &on); */
79 # define OSSL_STORE_C_USE_SECMEM 1
80 /* Where custom commands start */
81 # define OSSL_STORE_C_CUSTOM_START 100
84 * Read one data item (a key, a cert, a CRL) that is supported by the OSSL_STORE
85 * functionality, given a context.
86 * Returns a OSSL_STORE_INFO pointer, from which OpenSSL typed data can be
87 * extracted with OSSL_STORE_INFO_get0_PKEY(), OSSL_STORE_INFO_get0_CERT(), ...
88 * NULL is returned on error, which may include that the data found at the URI
89 * can't be figured out for certain or is ambiguous.
91 OSSL_STORE_INFO *OSSL_STORE_load(OSSL_STORE_CTX *ctx);
94 * Check if end of data (end of file) is reached
95 * Returns 1 on end, 0 otherwise.
97 int OSSL_STORE_eof(OSSL_STORE_CTX *ctx);
100 * Check if an error occurred
101 * Returns 1 if it did, 0 otherwise.
103 int OSSL_STORE_error(OSSL_STORE_CTX *ctx);
107 * Returns 1 on success, 0 on error.
109 int OSSL_STORE_close(OSSL_STORE_CTX *ctx);
112 * Attach to a BIO. This works like OSSL_STORE_open() except it takes a
113 * BIO instead of a uri, along with a scheme to use when reading.
114 * The given UI method will be used any time the loader needs extra input,
115 * for example when a password or pin is needed, and will be passed the
116 * same user data every time it's needed in this context.
118 * Returns a context reference which represents the channel to communicate
121 * Note that this function is considered unsafe, all depending on what the
122 * BIO actually reads.
124 OSSL_STORE_CTX *OSSL_STORE_attach(BIO *bio, const char *scheme,
125 OPENSSL_CTX *libctx, const char *propq,
126 const UI_METHOD *ui_method, void *ui_data,
127 OSSL_STORE_post_process_info_fn post_process,
128 void *post_process_data);
131 * Extracting OpenSSL types from and creating new OSSL_STORE_INFOs
132 * ---------------------------------------------------------------
136 * Types of data that can be ossl_stored in a OSSL_STORE_INFO.
137 * OSSL_STORE_INFO_NAME is typically found when getting a listing of
138 * available "files" / "tokens" / what have you.
140 # define OSSL_STORE_INFO_NAME 1 /* char * */
141 # define OSSL_STORE_INFO_PARAMS 2 /* EVP_PKEY * */
142 # define OSSL_STORE_INFO_PUBKEY 3 /* EVP_PKEY * */
143 # define OSSL_STORE_INFO_PKEY 4 /* EVP_PKEY * */
144 # define OSSL_STORE_INFO_CERT 5 /* X509 * */
145 # define OSSL_STORE_INFO_CRL 6 /* X509_CRL * */
148 * Functions to generate OSSL_STORE_INFOs, one function for each type we
149 * support having in them, as well as a generic constructor.
151 * In all cases, ownership of the object is transferred to the OSSL_STORE_INFO
152 * and will therefore be freed when the OSSL_STORE_INFO is freed.
154 OSSL_STORE_INFO *OSSL_STORE_INFO_new(int type, void *data);
155 OSSL_STORE_INFO *OSSL_STORE_INFO_new_NAME(char *name);
156 int OSSL_STORE_INFO_set0_NAME_description(OSSL_STORE_INFO *info, char *desc);
157 OSSL_STORE_INFO *OSSL_STORE_INFO_new_PARAMS(EVP_PKEY *params);
158 OSSL_STORE_INFO *OSSL_STORE_INFO_new_PUBKEY(EVP_PKEY *pubkey);
159 OSSL_STORE_INFO *OSSL_STORE_INFO_new_PKEY(EVP_PKEY *pkey);
160 OSSL_STORE_INFO *OSSL_STORE_INFO_new_CERT(X509 *x509);
161 OSSL_STORE_INFO *OSSL_STORE_INFO_new_CRL(X509_CRL *crl);
164 * Functions to try to extract data from a OSSL_STORE_INFO.
166 int OSSL_STORE_INFO_get_type(const OSSL_STORE_INFO *info);
167 void *OSSL_STORE_INFO_get0_data(int type, const OSSL_STORE_INFO *info);
168 const char *OSSL_STORE_INFO_get0_NAME(const OSSL_STORE_INFO *info);
169 char *OSSL_STORE_INFO_get1_NAME(const OSSL_STORE_INFO *info);
170 const char *OSSL_STORE_INFO_get0_NAME_description(const OSSL_STORE_INFO *info);
171 char *OSSL_STORE_INFO_get1_NAME_description(const OSSL_STORE_INFO *info);
172 EVP_PKEY *OSSL_STORE_INFO_get0_PARAMS(const OSSL_STORE_INFO *info);
173 EVP_PKEY *OSSL_STORE_INFO_get1_PARAMS(const OSSL_STORE_INFO *info);
174 EVP_PKEY *OSSL_STORE_INFO_get0_PUBKEY(const OSSL_STORE_INFO *info);
175 EVP_PKEY *OSSL_STORE_INFO_get1_PUBKEY(const OSSL_STORE_INFO *info);
176 EVP_PKEY *OSSL_STORE_INFO_get0_PKEY(const OSSL_STORE_INFO *info);
177 EVP_PKEY *OSSL_STORE_INFO_get1_PKEY(const OSSL_STORE_INFO *info);
178 X509 *OSSL_STORE_INFO_get0_CERT(const OSSL_STORE_INFO *info);
179 X509 *OSSL_STORE_INFO_get1_CERT(const OSSL_STORE_INFO *info);
180 X509_CRL *OSSL_STORE_INFO_get0_CRL(const OSSL_STORE_INFO *info);
181 X509_CRL *OSSL_STORE_INFO_get1_CRL(const OSSL_STORE_INFO *info);
183 const char *OSSL_STORE_INFO_type_string(int type);
186 * Free the OSSL_STORE_INFO
188 void OSSL_STORE_INFO_free(OSSL_STORE_INFO *info);
192 * Functions to construct a search URI from a base URI and search criteria
193 * -----------------------------------------------------------------------
196 /* OSSL_STORE search types */
197 # define OSSL_STORE_SEARCH_BY_NAME 1 /* subject in certs, issuer in CRLs */
198 # define OSSL_STORE_SEARCH_BY_ISSUER_SERIAL 2
199 # define OSSL_STORE_SEARCH_BY_KEY_FINGERPRINT 3
200 # define OSSL_STORE_SEARCH_BY_ALIAS 4
202 /* To check what search types the scheme handler supports */
203 int OSSL_STORE_supports_search(OSSL_STORE_CTX *ctx, int search_type);
205 /* Search term constructors */
207 * The input is considered to be owned by the caller, and must therefore
208 * remain present throughout the lifetime of the returned OSSL_STORE_SEARCH
210 OSSL_STORE_SEARCH *OSSL_STORE_SEARCH_by_name(X509_NAME *name);
211 OSSL_STORE_SEARCH *OSSL_STORE_SEARCH_by_issuer_serial(X509_NAME *name,
214 OSSL_STORE_SEARCH *OSSL_STORE_SEARCH_by_key_fingerprint(const EVP_MD *digest,
217 OSSL_STORE_SEARCH *OSSL_STORE_SEARCH_by_alias(const char *alias);
219 /* Search term destructor */
220 void OSSL_STORE_SEARCH_free(OSSL_STORE_SEARCH *search);
222 /* Search term accessors */
223 int OSSL_STORE_SEARCH_get_type(const OSSL_STORE_SEARCH *criterion);
224 X509_NAME *OSSL_STORE_SEARCH_get0_name(const OSSL_STORE_SEARCH *criterion);
225 const ASN1_INTEGER *OSSL_STORE_SEARCH_get0_serial(const OSSL_STORE_SEARCH
227 const unsigned char *OSSL_STORE_SEARCH_get0_bytes(const OSSL_STORE_SEARCH
228 *criterion, size_t *length);
229 const char *OSSL_STORE_SEARCH_get0_string(const OSSL_STORE_SEARCH *criterion);
230 const EVP_MD *OSSL_STORE_SEARCH_get0_digest(const OSSL_STORE_SEARCH *criterion);
233 * Add search criterion and expected return type (which can be unspecified)
234 * to the loading channel. This MUST happen before the first OSSL_STORE_load().
236 int OSSL_STORE_expect(OSSL_STORE_CTX *ctx, int expected_type);
237 int OSSL_STORE_find(OSSL_STORE_CTX *ctx, const OSSL_STORE_SEARCH *search);
241 * Function to fetch a loader and extract data from it
242 * ---------------------------------------------------
245 typedef struct ossl_store_loader_st OSSL_STORE_LOADER;
247 OSSL_STORE_LOADER *OSSL_STORE_LOADER_fetch(const char *scheme,
249 const char *properties);
250 int OSSL_STORE_LOADER_up_ref(OSSL_STORE_LOADER *loader);
251 void OSSL_STORE_LOADER_free(OSSL_STORE_LOADER *loader);
252 const OSSL_PROVIDER *OSSL_STORE_LOADER_provider(const OSSL_STORE_LOADER *
254 const char *OSSL_STORE_LOADER_properties(const OSSL_STORE_LOADER *loader);
255 int OSSL_STORE_LOADER_number(const OSSL_STORE_LOADER *loader);
256 int OSSL_STORE_LOADER_is_a(const OSSL_STORE_LOADER *loader,
258 void OSSL_STORE_LOADER_do_all_provided(OPENSSL_CTX *libctx,
259 void (*fn)(OSSL_STORE_LOADER *loader,
262 void OSSL_STORE_LOADER_names_do_all(const OSSL_STORE_LOADER *loader,
263 void (*fn)(const char *name, void *data),
267 * Function to register a loader for the given URI scheme.
268 * -------------------------------------------------------
270 * The loader receives all the main components of an URI except for the
274 /* struct ossl_store_loader_ctx_st is defined differently by each loader */
275 typedef struct ossl_store_loader_ctx_st OSSL_STORE_LOADER_CTX;
276 typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_open_fn)
277 (const OSSL_STORE_LOADER *loader, const char *uri,
278 const UI_METHOD *ui_method, void *ui_data);
279 typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_open_with_libctx_fn)
280 (const OSSL_STORE_LOADER *loader,
281 const char *uri, OPENSSL_CTX *libctx, const char *propq,
282 const UI_METHOD *ui_method, void *ui_data);
284 typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_attach_fn)
285 (const OSSL_STORE_LOADER *loader, BIO *bio,
286 OPENSSL_CTX *libctx, const char *propq,
287 const UI_METHOD *ui_method, void *ui_data);
288 typedef int (*OSSL_STORE_ctrl_fn)
289 (OSSL_STORE_LOADER_CTX *ctx, int cmd, va_list args);
290 typedef int (*OSSL_STORE_expect_fn)
291 (OSSL_STORE_LOADER_CTX *ctx, int expected);
292 typedef int (*OSSL_STORE_find_fn)
293 (OSSL_STORE_LOADER_CTX *ctx, const OSSL_STORE_SEARCH *criteria);
294 typedef OSSL_STORE_INFO *(*OSSL_STORE_load_fn)
295 (OSSL_STORE_LOADER_CTX *ctx, const UI_METHOD *ui_method, void *ui_data);
296 typedef int (*OSSL_STORE_eof_fn)(OSSL_STORE_LOADER_CTX *ctx);
297 typedef int (*OSSL_STORE_error_fn)(OSSL_STORE_LOADER_CTX *ctx);
298 typedef int (*OSSL_STORE_close_fn)(OSSL_STORE_LOADER_CTX *ctx);
300 OSSL_STORE_LOADER *OSSL_STORE_LOADER_new(ENGINE *e, const char *scheme);
301 int OSSL_STORE_LOADER_set_open(OSSL_STORE_LOADER *loader,
302 OSSL_STORE_open_fn open_function);
303 int OSSL_STORE_LOADER_set_open_with_libctx
304 (OSSL_STORE_LOADER *loader,
305 OSSL_STORE_open_with_libctx_fn open_with_libctx_function);
306 int OSSL_STORE_LOADER_set_attach(OSSL_STORE_LOADER *loader,
307 OSSL_STORE_attach_fn attach_function);
308 int OSSL_STORE_LOADER_set_ctrl(OSSL_STORE_LOADER *loader,
309 OSSL_STORE_ctrl_fn ctrl_function);
310 int OSSL_STORE_LOADER_set_expect(OSSL_STORE_LOADER *loader,
311 OSSL_STORE_expect_fn expect_function);
312 int OSSL_STORE_LOADER_set_find(OSSL_STORE_LOADER *loader,
313 OSSL_STORE_find_fn find_function);
314 int OSSL_STORE_LOADER_set_load(OSSL_STORE_LOADER *loader,
315 OSSL_STORE_load_fn load_function);
316 int OSSL_STORE_LOADER_set_eof(OSSL_STORE_LOADER *loader,
317 OSSL_STORE_eof_fn eof_function);
318 int OSSL_STORE_LOADER_set_error(OSSL_STORE_LOADER *loader,
319 OSSL_STORE_error_fn error_function);
320 int OSSL_STORE_LOADER_set_close(OSSL_STORE_LOADER *loader,
321 OSSL_STORE_close_fn close_function);
323 const ENGINE *OSSL_STORE_LOADER_get0_engine(const OSSL_STORE_LOADER *loader);
324 const char * OSSL_STORE_LOADER_get0_scheme(const OSSL_STORE_LOADER *loader);
326 int OSSL_STORE_register_loader(OSSL_STORE_LOADER *loader);
327 OSSL_STORE_LOADER *OSSL_STORE_unregister_loader(const char *scheme);
330 * Functions to list STORE loaders
331 * -------------------------------
333 int OSSL_STORE_do_all_loaders(void (*do_function) (const OSSL_STORE_LOADER
334 *loader, void *do_arg),