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
55 OSSL_STORE_CTX
*OSSL_STORE_open(const char *uri
, const UI_METHOD
*ui_method
,
57 OSSL_STORE_post_process_info_fn post_process
,
58 void *post_process_data
);
60 OSSL_STORE_CTX
*OSSL_STORE_open_with_libctx
61 (const char *uri
, OPENSSL_CTX
*libctx
, const char *propq
,
62 const UI_METHOD
*ui_method
, void *ui_data
,
63 OSSL_STORE_post_process_info_fn post_process
, void *post_process_data
);
66 * Control / fine tune the OSSL_STORE channel. |cmd| determines what is to be
67 * done, and depends on the underlying loader (use OSSL_STORE_get0_scheme to
68 * determine which loader is used), except for common commands (see below).
69 * Each command takes different arguments.
71 int OSSL_STORE_ctrl(OSSL_STORE_CTX
*ctx
, int cmd
, ... /* args */);
72 int OSSL_STORE_vctrl(OSSL_STORE_CTX
*ctx
, int cmd
, va_list args
);
75 * Common ctrl commands that different loaders may choose to support.
77 /* int on = 0 or 1; STORE_ctrl(ctx, STORE_C_USE_SECMEM, &on); */
78 # define OSSL_STORE_C_USE_SECMEM 1
79 /* Where custom commands start */
80 # define OSSL_STORE_C_CUSTOM_START 100
83 * Read one data item (a key, a cert, a CRL) that is supported by the OSSL_STORE
84 * functionality, given a context.
85 * Returns a OSSL_STORE_INFO pointer, from which OpenSSL typed data can be
86 * extracted with OSSL_STORE_INFO_get0_PKEY(), OSSL_STORE_INFO_get0_CERT(), ...
87 * NULL is returned on error, which may include that the data found at the URI
88 * can't be figured out for certain or is ambiguous.
90 OSSL_STORE_INFO
*OSSL_STORE_load(OSSL_STORE_CTX
*ctx
);
93 * Check if end of data (end of file) is reached
94 * Returns 1 on end, 0 otherwise.
96 int OSSL_STORE_eof(OSSL_STORE_CTX
*ctx
);
99 * Check if an error occurred
100 * Returns 1 if it did, 0 otherwise.
102 int OSSL_STORE_error(OSSL_STORE_CTX
*ctx
);
106 * Returns 1 on success, 0 on error.
108 int OSSL_STORE_close(OSSL_STORE_CTX
*ctx
);
111 * Attach to a BIO. This works like OSSL_STORE_open() except it takes a
112 * BIO instead of a uri, along with a scheme to use when reading.
113 * The given UI method will be used any time the loader needs extra input,
114 * for example when a password or pin is needed, and will be passed the
115 * same user data every time it's needed in this context.
117 * Returns a context reference which represents the channel to communicate
120 * Note that this function is considered unsafe, all depending on what the
121 * BIO actually reads.
123 OSSL_STORE_CTX
*OSSL_STORE_attach(BIO
*bio
, const char *scheme
,
124 OPENSSL_CTX
*libctx
, const char *propq
,
125 const UI_METHOD
*ui_method
, void *ui_data
,
126 OSSL_STORE_post_process_info_fn post_process
,
127 void *post_process_data
);
130 * Extracting OpenSSL types from and creating new OSSL_STORE_INFOs
131 * ---------------------------------------------------------------
135 * Types of data that can be ossl_stored in a OSSL_STORE_INFO.
136 * OSSL_STORE_INFO_NAME is typically found when getting a listing of
137 * available "files" / "tokens" / what have you.
139 # define OSSL_STORE_INFO_NAME 1 /* char * */
140 # define OSSL_STORE_INFO_PARAMS 2 /* EVP_PKEY * */
141 # define OSSL_STORE_INFO_PKEY 3 /* EVP_PKEY * */
142 # define OSSL_STORE_INFO_CERT 4 /* X509 * */
143 # define OSSL_STORE_INFO_CRL 5 /* X509_CRL * */
146 * Functions to generate OSSL_STORE_INFOs, one function for each type we
147 * support having in them, as well as a generic constructor.
149 * In all cases, ownership of the object is transferred to the OSSL_STORE_INFO
150 * and will therefore be freed when the OSSL_STORE_INFO is freed.
152 OSSL_STORE_INFO
*OSSL_STORE_INFO_new_NAME(char *name
);
153 int OSSL_STORE_INFO_set0_NAME_description(OSSL_STORE_INFO
*info
, char *desc
);
154 OSSL_STORE_INFO
*OSSL_STORE_INFO_new_PARAMS(EVP_PKEY
*params
);
155 OSSL_STORE_INFO
*OSSL_STORE_INFO_new_PKEY(EVP_PKEY
*pkey
);
156 OSSL_STORE_INFO
*OSSL_STORE_INFO_new_CERT(X509
*x509
);
157 OSSL_STORE_INFO
*OSSL_STORE_INFO_new_CRL(X509_CRL
*crl
);
160 * Functions to try to extract data from a OSSL_STORE_INFO.
162 int OSSL_STORE_INFO_get_type(const OSSL_STORE_INFO
*info
);
163 const char *OSSL_STORE_INFO_get0_NAME(const OSSL_STORE_INFO
*info
);
164 char *OSSL_STORE_INFO_get1_NAME(const OSSL_STORE_INFO
*info
);
165 const char *OSSL_STORE_INFO_get0_NAME_description(const OSSL_STORE_INFO
*info
);
166 char *OSSL_STORE_INFO_get1_NAME_description(const OSSL_STORE_INFO
*info
);
167 EVP_PKEY
*OSSL_STORE_INFO_get0_PARAMS(const OSSL_STORE_INFO
*info
);
168 EVP_PKEY
*OSSL_STORE_INFO_get1_PARAMS(const OSSL_STORE_INFO
*info
);
169 EVP_PKEY
*OSSL_STORE_INFO_get0_PKEY(const OSSL_STORE_INFO
*info
);
170 EVP_PKEY
*OSSL_STORE_INFO_get1_PKEY(const OSSL_STORE_INFO
*info
);
171 X509
*OSSL_STORE_INFO_get0_CERT(const OSSL_STORE_INFO
*info
);
172 X509
*OSSL_STORE_INFO_get1_CERT(const OSSL_STORE_INFO
*info
);
173 X509_CRL
*OSSL_STORE_INFO_get0_CRL(const OSSL_STORE_INFO
*info
);
174 X509_CRL
*OSSL_STORE_INFO_get1_CRL(const OSSL_STORE_INFO
*info
);
176 const char *OSSL_STORE_INFO_type_string(int type
);
179 * Free the OSSL_STORE_INFO
181 void OSSL_STORE_INFO_free(OSSL_STORE_INFO
*info
);
185 * Functions to construct a search URI from a base URI and search criteria
186 * -----------------------------------------------------------------------
189 /* OSSL_STORE search types */
190 # define OSSL_STORE_SEARCH_BY_NAME 1 /* subject in certs, issuer in CRLs */
191 # define OSSL_STORE_SEARCH_BY_ISSUER_SERIAL 2
192 # define OSSL_STORE_SEARCH_BY_KEY_FINGERPRINT 3
193 # define OSSL_STORE_SEARCH_BY_ALIAS 4
195 /* To check what search types the scheme handler supports */
196 int OSSL_STORE_supports_search(OSSL_STORE_CTX
*ctx
, int search_type
);
198 /* Search term constructors */
200 * The input is considered to be owned by the caller, and must therefore
201 * remain present throughout the lifetime of the returned OSSL_STORE_SEARCH
203 OSSL_STORE_SEARCH
*OSSL_STORE_SEARCH_by_name(X509_NAME
*name
);
204 OSSL_STORE_SEARCH
*OSSL_STORE_SEARCH_by_issuer_serial(X509_NAME
*name
,
207 OSSL_STORE_SEARCH
*OSSL_STORE_SEARCH_by_key_fingerprint(const EVP_MD
*digest
,
210 OSSL_STORE_SEARCH
*OSSL_STORE_SEARCH_by_alias(const char *alias
);
212 /* Search term destructor */
213 void OSSL_STORE_SEARCH_free(OSSL_STORE_SEARCH
*search
);
215 /* Search term accessors */
216 int OSSL_STORE_SEARCH_get_type(const OSSL_STORE_SEARCH
*criterion
);
217 X509_NAME
*OSSL_STORE_SEARCH_get0_name(const OSSL_STORE_SEARCH
*criterion
);
218 const ASN1_INTEGER
*OSSL_STORE_SEARCH_get0_serial(const OSSL_STORE_SEARCH
220 const unsigned char *OSSL_STORE_SEARCH_get0_bytes(const OSSL_STORE_SEARCH
221 *criterion
, size_t *length
);
222 const char *OSSL_STORE_SEARCH_get0_string(const OSSL_STORE_SEARCH
*criterion
);
223 const EVP_MD
*OSSL_STORE_SEARCH_get0_digest(const OSSL_STORE_SEARCH
*criterion
);
226 * Add search criterion and expected return type (which can be unspecified)
227 * to the loading channel. This MUST happen before the first OSSL_STORE_load().
229 int OSSL_STORE_expect(OSSL_STORE_CTX
*ctx
, int expected_type
);
230 int OSSL_STORE_find(OSSL_STORE_CTX
*ctx
, const OSSL_STORE_SEARCH
*search
);
234 * Function to register a loader for the given URI scheme.
235 * -------------------------------------------------------
237 * The loader receives all the main components of an URI except for the
241 typedef struct ossl_store_loader_st OSSL_STORE_LOADER
;
242 OSSL_STORE_LOADER
*OSSL_STORE_LOADER_new(ENGINE
*e
, const char *scheme
);
243 const ENGINE
*OSSL_STORE_LOADER_get0_engine(const OSSL_STORE_LOADER
*loader
);
244 const char *OSSL_STORE_LOADER_get0_scheme(const OSSL_STORE_LOADER
*loader
);
245 /* struct ossl_store_loader_ctx_st is defined differently by each loader */
246 typedef struct ossl_store_loader_ctx_st OSSL_STORE_LOADER_CTX
;
247 typedef OSSL_STORE_LOADER_CTX
*(*OSSL_STORE_open_fn
)
248 (const OSSL_STORE_LOADER
*loader
, const char *uri
,
249 const UI_METHOD
*ui_method
, void *ui_data
);
250 typedef OSSL_STORE_LOADER_CTX
*(*OSSL_STORE_open_with_libctx_fn
)
251 (const OSSL_STORE_LOADER
*loader
,
252 const char *uri
, OPENSSL_CTX
*libctx
, const char *propq
,
253 const UI_METHOD
*ui_method
, void *ui_data
);
255 int OSSL_STORE_LOADER_set_open(OSSL_STORE_LOADER
*loader
,
256 OSSL_STORE_open_fn open_function
);
257 typedef OSSL_STORE_LOADER_CTX
*(*OSSL_STORE_attach_fn
)
258 (const OSSL_STORE_LOADER
*loader
, BIO
*bio
,
259 OPENSSL_CTX
*libctx
, const char *propq
,
260 const UI_METHOD
*ui_method
, void *ui_data
);
261 int OSSL_STORE_LOADER_set_attach(OSSL_STORE_LOADER
*loader
,
262 OSSL_STORE_attach_fn attach_function
);
263 typedef int (*OSSL_STORE_ctrl_fn
)(OSSL_STORE_LOADER_CTX
*ctx
, int cmd
,
265 int OSSL_STORE_LOADER_set_ctrl(OSSL_STORE_LOADER
*loader
,
266 OSSL_STORE_ctrl_fn ctrl_function
);
267 typedef int (*OSSL_STORE_expect_fn
)(OSSL_STORE_LOADER_CTX
*ctx
, int expected
);
268 int OSSL_STORE_LOADER_set_expect(OSSL_STORE_LOADER
*loader
,
269 OSSL_STORE_expect_fn expect_function
);
270 typedef int (*OSSL_STORE_find_fn
)(OSSL_STORE_LOADER_CTX
*ctx
,
271 const OSSL_STORE_SEARCH
*criteria
);
272 int OSSL_STORE_LOADER_set_find(OSSL_STORE_LOADER
*loader
,
273 OSSL_STORE_find_fn find_function
);
274 typedef OSSL_STORE_INFO
*(*OSSL_STORE_load_fn
)(OSSL_STORE_LOADER_CTX
*ctx
,
275 const UI_METHOD
*ui_method
,
277 int OSSL_STORE_LOADER_set_load(OSSL_STORE_LOADER
*loader
,
278 OSSL_STORE_load_fn load_function
);
280 typedef int (*OSSL_STORE_eof_fn
)(OSSL_STORE_LOADER_CTX
*ctx
);
281 int OSSL_STORE_LOADER_set_eof(OSSL_STORE_LOADER
*loader
,
282 OSSL_STORE_eof_fn eof_function
);
283 typedef int (*OSSL_STORE_error_fn
)(OSSL_STORE_LOADER_CTX
*ctx
);
284 int OSSL_STORE_LOADER_set_error(OSSL_STORE_LOADER
*loader
,
285 OSSL_STORE_error_fn error_function
);
286 typedef int (*OSSL_STORE_close_fn
)(OSSL_STORE_LOADER_CTX
*ctx
);
287 int OSSL_STORE_LOADER_set_close(OSSL_STORE_LOADER
*loader
,
288 OSSL_STORE_close_fn close_function
);
289 void OSSL_STORE_LOADER_free(OSSL_STORE_LOADER
*loader
);
291 int OSSL_STORE_register_loader(OSSL_STORE_LOADER
*loader
);
292 OSSL_STORE_LOADER
*OSSL_STORE_unregister_loader(const char *scheme
);
295 * Functions to list STORE loaders
296 * -------------------------------
298 int OSSL_STORE_do_all_loaders(void (*do_function
) (const OSSL_STORE_LOADER
299 *loader
, void *do_arg
),