2 * Copyright 2016-2017 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 */);
63 * Common ctrl commands that different loaders may choose to support.
65 /* Where custom commands start */
66 # define OSSL_STORE_C_CUSTOM_START 100
69 * Read one data item (a key, a cert, a CRL) that is supported by the OSSL_STORE
70 * functionality, given a context.
71 * Returns a OSSL_STORE_INFO pointer, from which OpenSSL typed data can be
72 * extracted with OSSL_STORE_INFO_get0_PKEY(), OSSL_STORE_INFO_get0_CERT(), ...
73 * NULL is returned on error, which may include that the data found at the URI
74 * can't be figured out for certain or is ambiguous.
76 OSSL_STORE_INFO *OSSL_STORE_load(OSSL_STORE_CTX *ctx);
79 * Check if end of data (end of file) is reached
80 * Returns 1 on end, 0 otherwise.
82 int OSSL_STORE_eof(OSSL_STORE_CTX *ctx);
85 * Check if an error occured
86 * Returns 1 if it did, 0 otherwise.
88 int OSSL_STORE_error(OSSL_STORE_CTX *ctx);
92 * Returns 1 on success, 0 on error.
94 int OSSL_STORE_close(OSSL_STORE_CTX *ctx);
98 * Extracting OpenSSL types from and creating new OSSL_STORE_INFOs
99 * ---------------------------------------------------------------
103 * Types of data that can be ossl_stored in a OSSL_STORE_INFO.
104 * OSSL_STORE_INFO_NAME is typically found when getting a listing of
105 * available "files" / "tokens" / what have you.
107 # define OSSL_STORE_INFO_NAME 1 /* char * */
108 # define OSSL_STORE_INFO_PARAMS 2 /* EVP_PKEY * */
109 # define OSSL_STORE_INFO_PKEY 3 /* EVP_PKEY * */
110 # define OSSL_STORE_INFO_CERT 4 /* X509 * */
111 # define OSSL_STORE_INFO_CRL 5 /* X509_CRL * */
114 * Functions to generate OSSL_STORE_INFOs, one function for each type we
115 * support having in them. Along with each of them, one macro that
116 * can be used to determine what types are supported.
118 * In all cases, ownership of the object is transfered to the OSSL_STORE_INFO
119 * and will therefore be freed when the OSSL_STORE_INFO is freed.
121 OSSL_STORE_INFO *OSSL_STORE_INFO_new_NAME(char *name);
122 int OSSL_STORE_INFO_set0_NAME_description(OSSL_STORE_INFO *info, char *desc);
123 OSSL_STORE_INFO *OSSL_STORE_INFO_new_PARAMS(EVP_PKEY *params);
124 OSSL_STORE_INFO *OSSL_STORE_INFO_new_PKEY(EVP_PKEY *pkey);
125 OSSL_STORE_INFO *OSSL_STORE_INFO_new_CERT(X509 *x509);
126 OSSL_STORE_INFO *OSSL_STORE_INFO_new_CRL(X509_CRL *crl);
129 * Functions to try to extract data from a OSSL_STORE_INFO.
131 int OSSL_STORE_INFO_get_type(const OSSL_STORE_INFO *info);
132 const char *OSSL_STORE_INFO_get0_NAME(const OSSL_STORE_INFO *info);
133 char *OSSL_STORE_INFO_get1_NAME(const OSSL_STORE_INFO *info);
134 const char *OSSL_STORE_INFO_get0_NAME_description(const OSSL_STORE_INFO *info);
135 char *OSSL_STORE_INFO_get1_NAME_description(const OSSL_STORE_INFO *info);
136 EVP_PKEY *OSSL_STORE_INFO_get0_PARAMS(const OSSL_STORE_INFO *info);
137 EVP_PKEY *OSSL_STORE_INFO_get1_PARAMS(const OSSL_STORE_INFO *info);
138 EVP_PKEY *OSSL_STORE_INFO_get0_PKEY(const OSSL_STORE_INFO *info);
139 EVP_PKEY *OSSL_STORE_INFO_get1_PKEY(const OSSL_STORE_INFO *info);
140 X509 *OSSL_STORE_INFO_get0_CERT(const OSSL_STORE_INFO *info);
141 X509 *OSSL_STORE_INFO_get1_CERT(const OSSL_STORE_INFO *info);
142 X509_CRL *OSSL_STORE_INFO_get0_CRL(const OSSL_STORE_INFO *info);
143 X509_CRL *OSSL_STORE_INFO_get1_CRL(const OSSL_STORE_INFO *info);
145 const char *OSSL_STORE_INFO_type_string(int type);
148 * Free the OSSL_STORE_INFO
150 void OSSL_STORE_INFO_free(OSSL_STORE_INFO *info);
154 * Function to register a loader for the given URI scheme.
155 * -------------------------------------------------------
157 * The loader receives all the main components of an URI except for the
161 typedef struct ossl_store_loader_st OSSL_STORE_LOADER;
162 OSSL_STORE_LOADER *OSSL_STORE_LOADER_new(ENGINE *e, const char *scheme);
163 const ENGINE *OSSL_STORE_LOADER_get0_engine(const OSSL_STORE_LOADER *loader);
164 const char *OSSL_STORE_LOADER_get0_scheme(const OSSL_STORE_LOADER *loader);
165 /* struct ossl_store_loader_ctx_st is defined differently by each loader */
166 typedef struct ossl_store_loader_ctx_st OSSL_STORE_LOADER_CTX;
167 typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_open_fn)(const OSSL_STORE_LOADER
170 const UI_METHOD *ui_method,
172 int OSSL_STORE_LOADER_set_open(OSSL_STORE_LOADER *loader,
173 OSSL_STORE_open_fn open_function);
174 typedef int (*OSSL_STORE_ctrl_fn)(OSSL_STORE_LOADER_CTX *ctx, int cmd,
176 int OSSL_STORE_LOADER_set_ctrl(OSSL_STORE_LOADER *loader,
177 OSSL_STORE_ctrl_fn ctrl_function);
178 typedef OSSL_STORE_INFO *(*OSSL_STORE_load_fn)(OSSL_STORE_LOADER_CTX *ctx,
179 const UI_METHOD *ui_method,
181 int OSSL_STORE_LOADER_set_load(OSSL_STORE_LOADER *loader,
182 OSSL_STORE_load_fn load_function);
183 typedef int (*OSSL_STORE_eof_fn)(OSSL_STORE_LOADER_CTX *ctx);
184 int OSSL_STORE_LOADER_set_eof(OSSL_STORE_LOADER *loader,
185 OSSL_STORE_eof_fn eof_function);
186 typedef int (*OSSL_STORE_error_fn)(OSSL_STORE_LOADER_CTX *ctx);
187 int OSSL_STORE_LOADER_set_error(OSSL_STORE_LOADER *loader,
188 OSSL_STORE_error_fn error_function);
189 typedef int (*OSSL_STORE_close_fn)(OSSL_STORE_LOADER_CTX *ctx);
190 int OSSL_STORE_LOADER_set_close(OSSL_STORE_LOADER *loader,
191 OSSL_STORE_close_fn close_function);
192 void OSSL_STORE_LOADER_free(OSSL_STORE_LOADER *loader);
194 int OSSL_STORE_register_loader(OSSL_STORE_LOADER *loader);
195 OSSL_STORE_LOADER *OSSL_STORE_unregister_loader(const char *scheme);
198 * Functions to list STORE loaders
199 * -------------------------------
201 int OSSL_STORE_do_all_loaders(void (*do_function) (const OSSL_STORE_LOADER
202 *loader, void *do_arg),
209 int ERR_load_OSSL_STORE_strings(void);