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