include/openssl/store.h

   1 /*
   2  * Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   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
   8  */
   9
  10 #ifndef OPENSSL_STORE_H
  11 # define OPENSSL_STORE_H
  12 # pragma once
  13
  14 # include <openssl/macros.h>
  15 # ifndef OPENSSL_NO_DEPRECATED_3_0
  16 #  define HEADER_OSSL_STORE_H
  17 # endif
  18
  19 # include <stdarg.h>
  20 # include <openssl/types.h>
  21 # include <openssl/pem.h>
  22 # include <openssl/storeerr.h>
  23
  24 # ifdef  __cplusplus
  25 extern "C" {
  26 # endif
  27
  28 /*-
  29  *  The main OSSL_STORE functions.
  30  *  ------------------------------
  31  *
  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.
  35  */
  36
  37 typedef struct ossl_store_ctx_st OSSL_STORE_CTX;
  38
  39 /*
  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
  42  * NULL).
  43  */
  44 typedef OSSL_STORE_INFO *(*OSSL_STORE_post_process_info_fn)(OSSL_STORE_INFO *,
  45                                                             void *);
  46
  47 /*
  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.
  51  *
  52  * Returns a context reference which represents the channel to communicate
  53  * through.
  54  */
  55 OSSL_STORE_CTX *
  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);
  59 OSSL_STORE_CTX *
  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);
  65
  66 /*
  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.
  71  */
  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);
  74
  75 /*
  76  * Common ctrl commands that different loaders may choose to support.
  77  */
  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
  82
  83 /*
  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.
  90  */
  91 OSSL_STORE_INFO *OSSL_STORE_load(OSSL_STORE_CTX *ctx);
  92
  93 /*
  94  * Check if end of data (end of file) is reached
  95  * Returns 1 on end, 0 otherwise.
  96  */
  97 int OSSL_STORE_eof(OSSL_STORE_CTX *ctx);
  98
  99 /*
 100  * Check if an error occurred
 101  * Returns 1 if it did, 0 otherwise.
 102  */
 103 int OSSL_STORE_error(OSSL_STORE_CTX *ctx);
 104
 105 /*
 106  * Close the channel
 107  * Returns 1 on success, 0 on error.
 108  */
 109 int OSSL_STORE_close(OSSL_STORE_CTX *ctx);
 110
 111 /*
 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.
 117  *
 118  * Returns a context reference which represents the channel to communicate
 119  * through.
 120  *
 121  * Note that this function is considered unsafe, all depending on what the
 122  * BIO actually reads.
 123  */
 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);
 129
 130 /*-
 131  *  Extracting OpenSSL types from and creating new OSSL_STORE_INFOs
 132  *  ---------------------------------------------------------------
 133  */
 134
 135 /*
 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.
 139  */
 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 * */
 146
 147 /*
 148  * Functions to generate OSSL_STORE_INFOs, one function for each type we
 149  * support having in them, as well as a generic constructor.
 150  *
 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.
 153  */
 154 OSSL_STORE_INFO *OSSL_STORE_INFO_new_NAME(char *name);
 155 int OSSL_STORE_INFO_set0_NAME_description(OSSL_STORE_INFO *info, char *desc);
 156 OSSL_STORE_INFO *OSSL_STORE_INFO_new_PARAMS(EVP_PKEY *params);
 157 OSSL_STORE_INFO *OSSL_STORE_INFO_new_PUBKEY(EVP_PKEY *pubkey);
 158 OSSL_STORE_INFO *OSSL_STORE_INFO_new_PKEY(EVP_PKEY *pkey);
 159 OSSL_STORE_INFO *OSSL_STORE_INFO_new_CERT(X509 *x509);
 160 OSSL_STORE_INFO *OSSL_STORE_INFO_new_CRL(X509_CRL *crl);
 161
 162 /*
 163  * Functions to try to extract data from a OSSL_STORE_INFO.
 164  */
 165 int OSSL_STORE_INFO_get_type(const OSSL_STORE_INFO *info);
 166 const char *OSSL_STORE_INFO_get0_NAME(const OSSL_STORE_INFO *info);
 167 char *OSSL_STORE_INFO_get1_NAME(const OSSL_STORE_INFO *info);
 168 const char *OSSL_STORE_INFO_get0_NAME_description(const OSSL_STORE_INFO *info);
 169 char *OSSL_STORE_INFO_get1_NAME_description(const OSSL_STORE_INFO *info);
 170 EVP_PKEY *OSSL_STORE_INFO_get0_PARAMS(const OSSL_STORE_INFO *info);
 171 EVP_PKEY *OSSL_STORE_INFO_get1_PARAMS(const OSSL_STORE_INFO *info);
 172 EVP_PKEY *OSSL_STORE_INFO_get0_PUBKEY(const OSSL_STORE_INFO *info);
 173 EVP_PKEY *OSSL_STORE_INFO_get1_PUBKEY(const OSSL_STORE_INFO *info);
 174 EVP_PKEY *OSSL_STORE_INFO_get0_PKEY(const OSSL_STORE_INFO *info);
 175 EVP_PKEY *OSSL_STORE_INFO_get1_PKEY(const OSSL_STORE_INFO *info);
 176 X509 *OSSL_STORE_INFO_get0_CERT(const OSSL_STORE_INFO *info);
 177 X509 *OSSL_STORE_INFO_get1_CERT(const OSSL_STORE_INFO *info);
 178 X509_CRL *OSSL_STORE_INFO_get0_CRL(const OSSL_STORE_INFO *info);
 179 X509_CRL *OSSL_STORE_INFO_get1_CRL(const OSSL_STORE_INFO *info);
 180
 181 const char *OSSL_STORE_INFO_type_string(int type);
 182
 183 /*
 184  * Free the OSSL_STORE_INFO
 185  */
 186 void OSSL_STORE_INFO_free(OSSL_STORE_INFO *info);
 187
 188
 189 /*-
 190  *  Functions to construct a search URI from a base URI and search criteria
 191  *  -----------------------------------------------------------------------
 192  */
 193
 194 /* OSSL_STORE search types */
 195 # define OSSL_STORE_SEARCH_BY_NAME              1 /* subject in certs, issuer in CRLs */
 196 # define OSSL_STORE_SEARCH_BY_ISSUER_SERIAL     2
 197 # define OSSL_STORE_SEARCH_BY_KEY_FINGERPRINT   3
 198 # define OSSL_STORE_SEARCH_BY_ALIAS             4
 199
 200 /* To check what search types the scheme handler supports */
 201 int OSSL_STORE_supports_search(OSSL_STORE_CTX *ctx, int search_type);
 202
 203 /* Search term constructors */
 204 /*
 205  * The input is considered to be owned by the caller, and must therefore
 206  * remain present throughout the lifetime of the returned OSSL_STORE_SEARCH
 207  */
 208 OSSL_STORE_SEARCH *OSSL_STORE_SEARCH_by_name(X509_NAME *name);
 209 OSSL_STORE_SEARCH *OSSL_STORE_SEARCH_by_issuer_serial(X509_NAME *name,
 210                                                       const ASN1_INTEGER
 211                                                       *serial);
 212 OSSL_STORE_SEARCH *OSSL_STORE_SEARCH_by_key_fingerprint(const EVP_MD *digest,
 213                                                         const unsigned char
 214                                                         *bytes, size_t len);
 215 OSSL_STORE_SEARCH *OSSL_STORE_SEARCH_by_alias(const char *alias);
 216
 217 /* Search term destructor */
 218 void OSSL_STORE_SEARCH_free(OSSL_STORE_SEARCH *search);
 219
 220 /* Search term accessors */
 221 int OSSL_STORE_SEARCH_get_type(const OSSL_STORE_SEARCH *criterion);
 222 X509_NAME *OSSL_STORE_SEARCH_get0_name(const OSSL_STORE_SEARCH *criterion);
 223 const ASN1_INTEGER *OSSL_STORE_SEARCH_get0_serial(const OSSL_STORE_SEARCH
 224                                                   *criterion);
 225 const unsigned char *OSSL_STORE_SEARCH_get0_bytes(const OSSL_STORE_SEARCH
 226                                                   *criterion, size_t *length);
 227 const char *OSSL_STORE_SEARCH_get0_string(const OSSL_STORE_SEARCH *criterion);
 228 const EVP_MD *OSSL_STORE_SEARCH_get0_digest(const OSSL_STORE_SEARCH *criterion);
 229
 230 /*
 231  * Add search criterion and expected return type (which can be unspecified)
 232  * to the loading channel.  This MUST happen before the first OSSL_STORE_load().
 233  */
 234 int OSSL_STORE_expect(OSSL_STORE_CTX *ctx, int expected_type);
 235 int OSSL_STORE_find(OSSL_STORE_CTX *ctx, const OSSL_STORE_SEARCH *search);
 236
 237
 238 /*-
 239  *  Function to fetch a loader and extract data from it
 240  *  ---------------------------------------------------
 241  */
 242
 243 typedef struct ossl_store_loader_st OSSL_STORE_LOADER;
 244
 245 OSSL_STORE_LOADER *OSSL_STORE_LOADER_fetch(const char *scheme,
 246                                            OPENSSL_CTX *libctx,
 247                                            const char *properties);
 248 int OSSL_STORE_LOADER_up_ref(OSSL_STORE_LOADER *loader);
 249 void OSSL_STORE_LOADER_free(OSSL_STORE_LOADER *loader);
 250 const OSSL_PROVIDER *OSSL_STORE_LOADER_provider(const OSSL_STORE_LOADER *
 251                                                 loader);
 252 const char *OSSL_STORE_LOADER_properties(const OSSL_STORE_LOADER *loader);
 253 int OSSL_STORE_LOADER_number(const OSSL_STORE_LOADER *loader);
 254 int OSSL_STORE_LOADER_is_a(const OSSL_STORE_LOADER *loader,
 255                            const char *scheme);
 256 void OSSL_STORE_LOADER_do_all_provided(OPENSSL_CTX *libctx,
 257                                        void (*fn)(OSSL_STORE_LOADER *loader,
 258                                                   void *arg),
 259                                        void *arg);
 260 void OSSL_STORE_LOADER_names_do_all(const OSSL_STORE_LOADER *loader,
 261                                     void (*fn)(const char *name, void *data),
 262                                     void *data);
 263
 264 /*-
 265  *  Function to register a loader for the given URI scheme.
 266  *  -------------------------------------------------------
 267  *
 268  *  The loader receives all the main components of an URI except for the
 269  *  scheme.
 270  */
 271
 272 /* struct ossl_store_loader_ctx_st is defined differently by each loader */
 273 typedef struct ossl_store_loader_ctx_st OSSL_STORE_LOADER_CTX;
 274 typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_open_fn)
 275     (const OSSL_STORE_LOADER *loader, const char *uri,
 276      const UI_METHOD *ui_method, void *ui_data);
 277 typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_open_with_libctx_fn)
 278     (const OSSL_STORE_LOADER *loader,
 279      const char *uri, OPENSSL_CTX *libctx, const char *propq,
 280      const UI_METHOD *ui_method, void *ui_data);
 281
 282 typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_attach_fn)
 283     (const OSSL_STORE_LOADER *loader, BIO *bio,
 284      OPENSSL_CTX *libctx, const char *propq,
 285      const UI_METHOD *ui_method, void *ui_data);
 286 typedef int (*OSSL_STORE_ctrl_fn)
 287     (OSSL_STORE_LOADER_CTX *ctx, int cmd, va_list args);
 288 typedef int (*OSSL_STORE_expect_fn)
 289     (OSSL_STORE_LOADER_CTX *ctx, int expected);
 290 typedef int (*OSSL_STORE_find_fn)
 291     (OSSL_STORE_LOADER_CTX *ctx, const OSSL_STORE_SEARCH *criteria);
 292 typedef OSSL_STORE_INFO *(*OSSL_STORE_load_fn)
 293     (OSSL_STORE_LOADER_CTX *ctx, const UI_METHOD *ui_method, void *ui_data);
 294 typedef int (*OSSL_STORE_eof_fn)(OSSL_STORE_LOADER_CTX *ctx);
 295 typedef int (*OSSL_STORE_error_fn)(OSSL_STORE_LOADER_CTX *ctx);
 296 typedef int (*OSSL_STORE_close_fn)(OSSL_STORE_LOADER_CTX *ctx);
 297
 298 OSSL_STORE_LOADER *OSSL_STORE_LOADER_new(ENGINE *e, const char *scheme);
 299 int OSSL_STORE_LOADER_set_open(OSSL_STORE_LOADER *loader,
 300                                OSSL_STORE_open_fn open_function);
 301 int OSSL_STORE_LOADER_set_open_with_libctx
 302     (OSSL_STORE_LOADER *loader,
 303      OSSL_STORE_open_with_libctx_fn open_with_libctx_function);
 304 int OSSL_STORE_LOADER_set_attach(OSSL_STORE_LOADER *loader,
 305                                  OSSL_STORE_attach_fn attach_function);
 306 int OSSL_STORE_LOADER_set_ctrl(OSSL_STORE_LOADER *loader,
 307                                OSSL_STORE_ctrl_fn ctrl_function);
 308 int OSSL_STORE_LOADER_set_expect(OSSL_STORE_LOADER *loader,
 309                                  OSSL_STORE_expect_fn expect_function);
 310 int OSSL_STORE_LOADER_set_find(OSSL_STORE_LOADER *loader,
 311                                OSSL_STORE_find_fn find_function);
 312 int OSSL_STORE_LOADER_set_load(OSSL_STORE_LOADER *loader,
 313                                OSSL_STORE_load_fn load_function);
 314 int OSSL_STORE_LOADER_set_eof(OSSL_STORE_LOADER *loader,
 315                               OSSL_STORE_eof_fn eof_function);
 316 int OSSL_STORE_LOADER_set_error(OSSL_STORE_LOADER *loader,
 317                                 OSSL_STORE_error_fn error_function);
 318 int OSSL_STORE_LOADER_set_close(OSSL_STORE_LOADER *loader,
 319                                 OSSL_STORE_close_fn close_function);
 320
 321 const ENGINE *OSSL_STORE_LOADER_get0_engine(const OSSL_STORE_LOADER *loader);
 322 const char * OSSL_STORE_LOADER_get0_scheme(const OSSL_STORE_LOADER *loader);
 323
 324 int OSSL_STORE_register_loader(OSSL_STORE_LOADER *loader);
 325 OSSL_STORE_LOADER *OSSL_STORE_unregister_loader(const char *scheme);
 326
 327 /*-
 328  *  Functions to list STORE loaders
 329  *  -------------------------------
 330  */
 331 int OSSL_STORE_do_all_loaders(void (*do_function) (const OSSL_STORE_LOADER
 332                                                    *loader, void *do_arg),
 333                               void *do_arg);
 334
 335 # ifdef  __cplusplus
 336 }
 337 # endif
 338 #endif