1 /* 2 * Copyright 2016-2023 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; 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 #ifndef OPENSSL_NO_DEPRECATED_3_0 84 /* Legacy stuff */ 85 const char *scheme; 86 ENGINE *engine; 87 OSSL_STORE_open_fn open; 88 OSSL_STORE_attach_fn attach; 89 OSSL_STORE_ctrl_fn ctrl; 90 OSSL_STORE_expect_fn expect; 91 OSSL_STORE_find_fn find; 92 OSSL_STORE_load_fn load; 93 OSSL_STORE_eof_fn eof; 94 OSSL_STORE_error_fn error; 95 OSSL_STORE_close_fn closefn; 96 OSSL_STORE_open_ex_fn open_ex; 97 #endif 98 99 /* Provider stuff */ 100 OSSL_PROVIDER *prov; 101 int scheme_id; 102 const char *propdef; 103 const char *description; 104 105 CRYPTO_REF_COUNT refcnt; 106 107 OSSL_FUNC_store_open_fn *p_open; 108 OSSL_FUNC_store_attach_fn *p_attach; 109 OSSL_FUNC_store_settable_ctx_params_fn *p_settable_ctx_params; 110 OSSL_FUNC_store_set_ctx_params_fn *p_set_ctx_params; 111 OSSL_FUNC_store_load_fn *p_load; 112 OSSL_FUNC_store_eof_fn *p_eof; 113 OSSL_FUNC_store_close_fn *p_close; 114 OSSL_FUNC_store_export_object_fn *p_export_object; 115 OSSL_FUNC_store_delete_fn *p_delete; 116 OSSL_FUNC_store_open_ex_fn *p_open_ex; 117 }; 118 DEFINE_LHASH_OF_EX(OSSL_STORE_LOADER); 119 120 const OSSL_STORE_LOADER *ossl_store_get0_loader_int(const char *scheme); 121 void ossl_store_destroy_loaders_int(void); 122 123 #ifdef OPENSSL_NO_DEPRECATED_3_0 124 /* struct ossl_store_loader_ctx_st is defined differently by each loader */ 125 typedef struct ossl_store_loader_ctx_st OSSL_STORE_LOADER_CTX; 126 #endif 127 128 /*- 129 * OSSL_STORE_CTX stuff 130 * --------------------- 131 */ 132 133 struct ossl_store_ctx_st { 134 const OSSL_STORE_LOADER *loader; /* legacy */ 135 OSSL_STORE_LOADER *fetched_loader; 136 OSSL_STORE_LOADER_CTX *loader_ctx; 137 OSSL_STORE_post_process_info_fn post_process; 138 void *post_process_data; 139 int expected_type; 140 141 char *properties; 142 143 /* 0 before the first STORE_load(), 1 otherwise */ 144 int loading; 145 /* 1 on load error, only valid for fetched loaders */ 146 int error_flag; 147 148 /* 149 * Cache of stuff, to be able to return the contents of a PKCS#12 150 * blob, one object at a time. 151 */ 152 STACK_OF(OSSL_STORE_INFO) *cached_info; 153 154 struct ossl_passphrase_data_st pwdata; 155 }; 156 157 /*- 158 * 'file' scheme stuff 159 * ------------------- 160 */ 161 162 OSSL_STORE_LOADER_CTX *ossl_store_file_attach_pem_bio_int(BIO *bp); 163 int ossl_store_file_detach_pem_bio_int(OSSL_STORE_LOADER_CTX *ctx); 164 165 /*- 166 * Provider stuff 167 * ------------------- 168 */ 169 OSSL_STORE_LOADER *ossl_store_loader_fetch(OSSL_LIB_CTX *libctx, 170 const char *scheme, 171 const char *properties); 172 173 /* Standard function to handle the result from OSSL_FUNC_store_load() */ 174 struct ossl_load_result_data_st { 175 OSSL_STORE_INFO *v; /* To be filled in */ 176 OSSL_STORE_CTX *ctx; 177 }; 178 OSSL_CALLBACK ossl_store_handle_load_result; 179