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