2 * Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (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 HEADER_OSSL_STORE_H
11 # define HEADER_OSSL_STORE_H
14 # include <openssl/ossl_typ.h>
15 # include <openssl/pem.h>
16 # include <openssl/storeerr.h>
23 * The main OSSL_STORE functions.
24 * ------------------------------
26 * These allow applications to open a channel to a resource with supported
27 * data (keys, certs, crls, ...), read the data a piece at a time and decide
28 * what to do with it, and finally close.
31 typedef struct ossl_store_ctx_st OSSL_STORE_CTX;
34 * Typedef for the OSSL_STORE_INFO post processing callback. This can be used
35 * to massage the given OSSL_STORE_INFO, or to drop it entirely (by returning
38 typedef OSSL_STORE_INFO *(*OSSL_STORE_post_process_info_fn)(OSSL_STORE_INFO *,
42 * Open a channel given a URI. The given UI method will be used any time the
43 * loader needs extra input, for example when a password or pin is needed, and
44 * will be passed the same user data every time it's needed in this context.
46 * Returns a context reference which represents the channel to communicate
49 OSSL_STORE_CTX *OSSL_STORE_open(const char *uri, const UI_METHOD *ui_method,
51 OSSL_STORE_post_process_info_fn post_process,
52 void *post_process_data);
55 * Control / fine tune the OSSL_STORE channel. |cmd| determines what is to be
56 * done, and depends on the underlying loader (use OSSL_STORE_get0_scheme to
57 * determine which loader is used), except for common commands (see below).
58 * Each command takes different arguments.
60 int OSSL_STORE_ctrl(OSSL_STORE_CTX *ctx, int cmd, ... /* args */);
61 int OSSL_STORE_vctrl(OSSL_STORE_CTX *ctx, int cmd, va_list args);
64 * Common ctrl commands that different loaders may choose to support.
66 /* int on = 0 or 1; STORE_ctrl(ctx, STORE_C_USE_SECMEM, &on); */
67 # define OSSL_STORE_C_USE_SECMEM 1
68 /* Where custom commands start */
69 # define OSSL_STORE_C_CUSTOM_START 100
72 * Read one data item (a key, a cert, a CRL) that is supported by the OSSL_STORE
73 * functionality, given a context.
74 * Returns a OSSL_STORE_INFO pointer, from which OpenSSL typed data can be
75 * extracted with OSSL_STORE_INFO_get0_PKEY(), OSSL_STORE_INFO_get0_CERT(), ...
76 * NULL is returned on error, which may include that the data found at the URI
77 * can't be figured out for certain or is ambiguous.
79 OSSL_STORE_INFO *OSSL_STORE_load(OSSL_STORE_CTX *ctx);
82 * Check if end of data (end of file) is reached
83 * Returns 1 on end, 0 otherwise.
85 int OSSL_STORE_eof(OSSL_STORE_CTX *ctx);
88 * Check if an error occured
89 * Returns 1 if it did, 0 otherwise.
91 int OSSL_STORE_error(OSSL_STORE_CTX *ctx);
95 * Returns 1 on success, 0 on error.
97 int OSSL_STORE_close(OSSL_STORE_CTX *ctx);
101 * Extracting OpenSSL types from and creating new OSSL_STORE_INFOs
102 * ---------------------------------------------------------------
106 * Types of data that can be ossl_stored in a OSSL_STORE_INFO.
107 * OSSL_STORE_INFO_NAME is typically found when getting a listing of
108 * available "files" / "tokens" / what have you.
110 # define OSSL_STORE_INFO_NAME 1 /* char * */
111 # define OSSL_STORE_INFO_PARAMS 2 /* EVP_PKEY * */
112 # define OSSL_STORE_INFO_PKEY 3 /* EVP_PKEY * */
113 # define OSSL_STORE_INFO_CERT 4 /* X509 * */
114 # define OSSL_STORE_INFO_CRL 5 /* X509_CRL * */
117 * Functions to generate OSSL_STORE_INFOs, one function for each type we
118 * support having in them, as well as a generic constructor.
120 * In all cases, ownership of the object is transfered to the OSSL_STORE_INFO
121 * and will therefore be freed when the OSSL_STORE_INFO is freed.
123 OSSL_STORE_INFO *OSSL_STORE_INFO_new_NAME(char *name);
124 int OSSL_STORE_INFO_set0_NAME_description(OSSL_STORE_INFO *info, char *desc);
125 OSSL_STORE_INFO *OSSL_STORE_INFO_new_PARAMS(EVP_PKEY *params);
126 OSSL_STORE_INFO *OSSL_STORE_INFO_new_PKEY(EVP_PKEY *pkey);
127 OSSL_STORE_INFO *OSSL_STORE_INFO_new_CERT(X509 *x509);
128 OSSL_STORE_INFO *OSSL_STORE_INFO_new_CRL(X509_CRL *crl);
131 * Functions to try to extract data from a OSSL_STORE_INFO.
133 int OSSL_STORE_INFO_get_type(const OSSL_STORE_INFO *info);
134 const char *OSSL_STORE_INFO_get0_NAME(const OSSL_STORE_INFO *info);
135 char *OSSL_STORE_INFO_get1_NAME(const OSSL_STORE_INFO *info);
136 const char *OSSL_STORE_INFO_get0_NAME_description(const OSSL_STORE_INFO *info);
137 char *OSSL_STORE_INFO_get1_NAME_description(const OSSL_STORE_INFO *info);
138 EVP_PKEY *OSSL_STORE_INFO_get0_PARAMS(const OSSL_STORE_INFO *info);
139 EVP_PKEY *OSSL_STORE_INFO_get1_PARAMS(const OSSL_STORE_INFO *info);
140 EVP_PKEY *OSSL_STORE_INFO_get0_PKEY(const OSSL_STORE_INFO *info);
141 EVP_PKEY *OSSL_STORE_INFO_get1_PKEY(const OSSL_STORE_INFO *info);
142 X509 *OSSL_STORE_INFO_get0_CERT(const OSSL_STORE_INFO *info);
143 X509 *OSSL_STORE_INFO_get1_CERT(const OSSL_STORE_INFO *info);
144 X509_CRL *OSSL_STORE_INFO_get0_CRL(const OSSL_STORE_INFO *info);
145 X509_CRL *OSSL_STORE_INFO_get1_CRL(const OSSL_STORE_INFO *info);
147 const char *OSSL_STORE_INFO_type_string(int type);
150 * Free the OSSL_STORE_INFO
152 void OSSL_STORE_INFO_free(OSSL_STORE_INFO *info);
155 * Add expected return type (which can be unspecified) to the loading channel.
156 * This MUST happen before the first STORE_load().
158 int OSSL_STORE_expect(OSSL_STORE_CTX *ctx, int expected_type);
162 * Function to register a loader for the given URI scheme.
163 * -------------------------------------------------------
165 * The loader receives all the main components of an URI except for the
169 typedef struct ossl_store_loader_st OSSL_STORE_LOADER;
170 OSSL_STORE_LOADER *OSSL_STORE_LOADER_new(ENGINE *e, const char *scheme);
171 const ENGINE *OSSL_STORE_LOADER_get0_engine(const OSSL_STORE_LOADER *loader);
172 const char *OSSL_STORE_LOADER_get0_scheme(const OSSL_STORE_LOADER *loader);
173 /* struct ossl_store_loader_ctx_st is defined differently by each loader */
174 typedef struct ossl_store_loader_ctx_st OSSL_STORE_LOADER_CTX;
175 typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_open_fn)(const OSSL_STORE_LOADER
178 const UI_METHOD *ui_method,
180 int OSSL_STORE_LOADER_set_open(OSSL_STORE_LOADER *loader,
181 OSSL_STORE_open_fn open_function);
182 typedef int (*OSSL_STORE_ctrl_fn)(OSSL_STORE_LOADER_CTX *ctx, int cmd,
184 int OSSL_STORE_LOADER_set_ctrl(OSSL_STORE_LOADER *loader,
185 OSSL_STORE_ctrl_fn ctrl_function);
186 typedef int (*OSSL_STORE_expect_fn)(OSSL_STORE_LOADER_CTX *ctx, int expected);
187 int OSSL_STORE_LOADER_set_expect(OSSL_STORE_LOADER *loader,
188 OSSL_STORE_expect_fn expect_function);
189 typedef OSSL_STORE_INFO *(*OSSL_STORE_load_fn)(OSSL_STORE_LOADER_CTX *ctx,
190 const UI_METHOD *ui_method,
192 int OSSL_STORE_LOADER_set_load(OSSL_STORE_LOADER *loader,
193 OSSL_STORE_load_fn load_function);
194 typedef int (*OSSL_STORE_eof_fn)(OSSL_STORE_LOADER_CTX *ctx);
195 int OSSL_STORE_LOADER_set_eof(OSSL_STORE_LOADER *loader,
196 OSSL_STORE_eof_fn eof_function);
197 typedef int (*OSSL_STORE_error_fn)(OSSL_STORE_LOADER_CTX *ctx);
198 int OSSL_STORE_LOADER_set_error(OSSL_STORE_LOADER *loader,
199 OSSL_STORE_error_fn error_function);
200 typedef int (*OSSL_STORE_close_fn)(OSSL_STORE_LOADER_CTX *ctx);
201 int OSSL_STORE_LOADER_set_close(OSSL_STORE_LOADER *loader,
202 OSSL_STORE_close_fn close_function);
203 void OSSL_STORE_LOADER_free(OSSL_STORE_LOADER *loader);
205 int OSSL_STORE_register_loader(OSSL_STORE_LOADER *loader);
206 OSSL_STORE_LOADER *OSSL_STORE_unregister_loader(const char *scheme);
209 * Functions to list STORE loaders
210 * -------------------------------
212 int OSSL_STORE_do_all_loaders(void (*do_function) (const OSSL_STORE_LOADER
213 *loader, void *do_arg),