crypto/store/store_local.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 #include <openssl/core_dispatch.h>
  11 #include "internal/thread_once.h"
  12 #include "internal/refcount.h"
  13 #include <openssl/dsa.h>
  14 #include <openssl/engine.h>
  15 #include <openssl/evp.h>
  16 #include <openssl/lhash.h>
  17 #include <openssl/x509.h>
  18 #include <openssl/store.h>
  19 #include "internal/passphrase.h"
  20
  21 /*-
  22  *  OSSL_STORE_INFO stuff
  23  *  ---------------------
  24  */
  25
  26 struct ossl_store_info_st {
  27     int type;
  28     union {
  29         void *data;              /* used internally as generic pointer */
  30
  31         struct {
  32             char *name;
  33             char *desc;
  34         } name;                  /* when type == OSSL_STORE_INFO_NAME */
  35
  36         EVP_PKEY *params;        /* when type == OSSL_STORE_INFO_PARAMS */
  37         EVP_PKEY *pubkey;        /* when type == OSSL_STORE_INFO_PUBKEY */
  38         EVP_PKEY *pkey;          /* when type == OSSL_STORE_INFO_PKEY */
  39         X509 *x509;              /* when type == OSSL_STORE_INFO_CERT */
  40         X509_CRL *crl;           /* when type == OSSL_STORE_INFO_CRL */
  41     } _;
  42 };
  43 DEFINE_STACK_OF(OSSL_STORE_INFO)
  44
  45 /*-
  46  *  OSSL_STORE_SEARCH stuff
  47  *  -----------------------
  48  */
  49
  50 struct ossl_store_search_st {
  51     int search_type;
  52
  53     /*
  54      * Used by OSSL_STORE_SEARCH_BY_NAME and
  55      * OSSL_STORE_SEARCH_BY_ISSUER_SERIAL
  56      */
  57     X509_NAME *name; /* TODO constify this; leads to API incompatibility */
  58
  59     /* Used by OSSL_STORE_SEARCH_BY_ISSUER_SERIAL */
  60     const ASN1_INTEGER *serial;
  61
  62     /* Used by OSSL_STORE_SEARCH_BY_KEY_FINGERPRINT */
  63     const EVP_MD *digest;
  64
  65     /*
  66      * Used by OSSL_STORE_SEARCH_BY_KEY_FINGERPRINT and
  67      * OSSL_STORE_SEARCH_BY_ALIAS
  68      */
  69     const unsigned char *string;
  70     size_t stringlength;
  71 };
  72
  73 /*-
  74  *  OSSL_STORE_LOADER stuff
  75  *  -----------------------
  76  */
  77
  78 int ossl_store_register_loader_int(OSSL_STORE_LOADER *loader);
  79 OSSL_STORE_LOADER *ossl_store_unregister_loader_int(const char *scheme);
  80
  81 /* loader stuff */
  82 struct ossl_store_loader_st {
  83     /* Legacy stuff */
  84     const char *scheme;
  85     ENGINE *engine;
  86     OSSL_STORE_open_fn open;
  87     OSSL_STORE_attach_fn attach;
  88     OSSL_STORE_ctrl_fn ctrl;
  89     OSSL_STORE_expect_fn expect;
  90     OSSL_STORE_find_fn find;
  91     OSSL_STORE_load_fn load;
  92     OSSL_STORE_eof_fn eof;
  93     OSSL_STORE_error_fn error;
  94     OSSL_STORE_close_fn close;
  95     OSSL_STORE_open_with_libctx_fn open_with_libctx;
  96
  97     /* Provider stuff */
  98     OSSL_PROVIDER *prov;
  99     int scheme_id;
 100     const char *propdef;
 101
 102     CRYPTO_REF_COUNT refcnt;
 103     CRYPTO_RWLOCK *lock;
 104
 105     OSSL_FUNC_store_open_fn *p_open;
 106     OSSL_FUNC_store_attach_fn *p_attach;
 107     OSSL_FUNC_store_settable_ctx_params_fn *p_settable_ctx_params;
 108     OSSL_FUNC_store_set_ctx_params_fn *p_set_ctx_params;
 109     OSSL_FUNC_store_load_fn *p_load;
 110     OSSL_FUNC_store_eof_fn *p_eof;
 111     OSSL_FUNC_store_close_fn *p_close;
 112     OSSL_FUNC_store_export_object_fn *p_export_object;
 113 };
 114 DEFINE_LHASH_OF(OSSL_STORE_LOADER);
 115
 116 const OSSL_STORE_LOADER *ossl_store_get0_loader_int(const char *scheme);
 117 void ossl_store_destroy_loaders_int(void);
 118
 119 /*-
 120  *  OSSL_STORE_CTX stuff
 121  *  ---------------------
 122  */
 123
 124 struct ossl_store_ctx_st {
 125     const OSSL_STORE_LOADER *loader; /* legacy */
 126     OSSL_STORE_LOADER *fetched_loader;
 127     OSSL_STORE_LOADER_CTX *loader_ctx;
 128     OSSL_STORE_post_process_info_fn post_process;
 129     void *post_process_data;
 130     int expected_type;
 131
 132     char *properties;
 133
 134     /* 0 before the first STORE_load(), 1 otherwise */
 135     int loading;
 136     /* 1 on load error, only valid for fetched loaders */
 137     int error_flag;
 138
 139     /*
 140      * Cache of stuff, to be able to return the contents of a PKCS#12
 141      * blob, one object at a time.
 142      */
 143     STACK_OF(OSSL_STORE_INFO) *cached_info;
 144
 145     struct ossl_passphrase_data_st pwdata;
 146 };
 147
 148 /*-
 149  *  OSSL_STORE init stuff
 150  *  ---------------------
 151  */
 152
 153 int ossl_store_init_once(void);
 154
 155 /*-
 156  *  'file' scheme stuff
 157  *  -------------------
 158  */
 159
 160 OSSL_STORE_LOADER_CTX *ossl_store_file_attach_pem_bio_int(BIO *bp);
 161 int ossl_store_file_detach_pem_bio_int(OSSL_STORE_LOADER_CTX *ctx);
 162
 163 /*-
 164  * Provider stuff
 165  * -------------------
 166  */
 167 OSSL_STORE_LOADER *ossl_store_loader_fetch(OPENSSL_CTX *libctx,
 168                                            const char *scheme,
 169                                            const char *properties);
 170 OSSL_STORE_LOADER *ossl_store_loader_fetch_by_number(OPENSSL_CTX *libctx,
 171                                                      int scheme_id,
 172                                                      const char *properties);
 173
 174 /* Standard function to handle the result from OSSL_FUNC_store_load() */
 175 struct ossl_load_result_data_st {
 176     OSSL_STORE_INFO *v;          /* To be filled in */
 177     OSSL_STORE_CTX *ctx;
 178 };
 179 OSSL_CALLBACK ossl_store_handle_load_result;