File Explorer

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 use5 * this file except in compliance with the License.  You can obtain a copy6 * in the file LICENSE in the source distribution or at7 * https://www.openssl.org/source/license.html8 */9 10#ifndef OPENSSL_STORE_H11#define OPENSSL_STORE_H12#pragma once13 14#include <openssl/macros.h>15#ifndef OPENSSL_NO_DEPRECATED_3_016#define HEADER_OSSL_STORE_H17#endif18 19#include <stdarg.h>20#include <openssl/types.h>21#include <openssl/pem.h>22#include <openssl/storeerr.h>23 24#ifdef __cplusplus25extern "C" {26#endif27 28/*-29 *  The main OSSL_STORE functions.30 *  ------------------------------31 *32 *  These allow applications to open a channel to a resource with supported33 *  data (keys, certs, crls, ...), read the data a piece at a time and decide34 *  what to do with it, and finally close.35 */36 37typedef struct ossl_store_ctx_st OSSL_STORE_CTX;38 39/*40 * Typedef for the OSSL_STORE_INFO post processing callback.  This can be used41 * to massage the given OSSL_STORE_INFO, or to drop it entirely (by returning42 * NULL).43 */44typedef 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 the49 * loader needs extra input, for example when a password or pin is needed, and50 * 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 communicate53 * through.54 */55OSSL_STORE_CTX *56OSSL_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);59OSSL_STORE_CTX *60OSSL_STORE_open_ex(const char *uri, OSSL_LIB_CTX *libctx, const char *propq,61    const UI_METHOD *ui_method, void *ui_data,62    const OSSL_PARAM params[],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 be68 * done, and depends on the underlying loader (use OSSL_STORE_get0_scheme to69 * determine which loader is used), except for common commands (see below).70 * Each command takes different arguments.71 */72#ifndef OPENSSL_NO_DEPRECATED_3_073OSSL_DEPRECATEDIN_3_0 int OSSL_STORE_ctrl(OSSL_STORE_CTX *ctx, int cmd,74    ... /* args */);75OSSL_DEPRECATEDIN_3_0 int OSSL_STORE_vctrl(OSSL_STORE_CTX *ctx, int cmd,76    va_list args);77#endif78 79#ifndef OPENSSL_NO_DEPRECATED_3_080 81/*82 * Common ctrl commands that different loaders may choose to support.83 */84/* int on = 0 or 1; STORE_ctrl(ctx, STORE_C_USE_SECMEM, &on); */85#define OSSL_STORE_C_USE_SECMEM 186/* Where custom commands start */87#define OSSL_STORE_C_CUSTOM_START 10088 89#endif90 91/*92 * Read one data item (a key, a cert, a CRL) that is supported by the OSSL_STORE93 * functionality, given a context.94 * Returns a OSSL_STORE_INFO pointer, from which OpenSSL typed data can be95 * extracted with OSSL_STORE_INFO_get0_PKEY(), OSSL_STORE_INFO_get0_CERT(), ...96 * NULL is returned on error, which may include that the data found at the URI97 * can't be figured out for certain or is ambiguous.98 */99OSSL_STORE_INFO *OSSL_STORE_load(OSSL_STORE_CTX *ctx);100 101/*102 * Deletes the object in the store by URI.103 * Returns 1 on success, 0 otherwise.104 */105int OSSL_STORE_delete(const char *uri, OSSL_LIB_CTX *libctx, const char *propq,106    const UI_METHOD *ui_method, void *ui_data,107    const OSSL_PARAM params[]);108 109/*110 * Check if end of data (end of file) is reached111 * Returns 1 on end, 0 otherwise.112 */113int OSSL_STORE_eof(OSSL_STORE_CTX *ctx);114 115/*116 * Check if an error occurred117 * Returns 1 if it did, 0 otherwise.118 */119int OSSL_STORE_error(OSSL_STORE_CTX *ctx);120 121/*122 * Close the channel123 * Returns 1 on success, 0 on error.124 */125int OSSL_STORE_close(OSSL_STORE_CTX *ctx);126 127/*128 * Attach to a BIO.  This works like OSSL_STORE_open() except it takes a129 * BIO instead of a uri, along with a scheme to use when reading.130 * The given UI method will be used any time the loader needs extra input,131 * for example when a password or pin is needed, and will be passed the132 * same user data every time it's needed in this context.133 *134 * Returns a context reference which represents the channel to communicate135 * through.136 *137 * Note that this function is considered unsafe, all depending on what the138 * BIO actually reads.139 */140OSSL_STORE_CTX *OSSL_STORE_attach(BIO *bio, const char *scheme,141    OSSL_LIB_CTX *libctx, const char *propq,142    const UI_METHOD *ui_method, void *ui_data,143    const OSSL_PARAM params[],144    OSSL_STORE_post_process_info_fn post_process,145    void *post_process_data);146 147/*-148 *  Extracting OpenSSL types from and creating new OSSL_STORE_INFOs149 *  ---------------------------------------------------------------150 */151 152/*153 * Types of data that can be ossl_stored in a OSSL_STORE_INFO.154 * OSSL_STORE_INFO_NAME is typically found when getting a listing of155 * available "files" / "tokens" / what have you.156 */157#define OSSL_STORE_INFO_NAME 1 /* char * */158#define OSSL_STORE_INFO_PARAMS 2 /* EVP_PKEY * */159#define OSSL_STORE_INFO_PUBKEY 3 /* EVP_PKEY * */160#define OSSL_STORE_INFO_PKEY 4 /* EVP_PKEY * */161#define OSSL_STORE_INFO_CERT 5 /* X509 * */162#define OSSL_STORE_INFO_CRL 6 /* X509_CRL * */163 164/*165 * Functions to generate OSSL_STORE_INFOs, one function for each type we166 * support having in them, as well as a generic constructor.167 *168 * In all cases, ownership of the object is transferred to the OSSL_STORE_INFO169 * and will therefore be freed when the OSSL_STORE_INFO is freed.170 */171OSSL_STORE_INFO *OSSL_STORE_INFO_new(int type, void *data);172OSSL_STORE_INFO *OSSL_STORE_INFO_new_NAME(char *name);173int OSSL_STORE_INFO_set0_NAME_description(OSSL_STORE_INFO *info, char *desc);174OSSL_STORE_INFO *OSSL_STORE_INFO_new_PARAMS(EVP_PKEY *params);175OSSL_STORE_INFO *OSSL_STORE_INFO_new_PUBKEY(EVP_PKEY *pubkey);176OSSL_STORE_INFO *OSSL_STORE_INFO_new_PKEY(EVP_PKEY *pkey);177OSSL_STORE_INFO *OSSL_STORE_INFO_new_CERT(X509 *x509);178OSSL_STORE_INFO *OSSL_STORE_INFO_new_CRL(X509_CRL *crl);179 180/*181 * Functions to try to extract data from a OSSL_STORE_INFO.182 */183int OSSL_STORE_INFO_get_type(const OSSL_STORE_INFO *info);184void *OSSL_STORE_INFO_get0_data(int type, const OSSL_STORE_INFO *info);185const char *OSSL_STORE_INFO_get0_NAME(const OSSL_STORE_INFO *info);186char *OSSL_STORE_INFO_get1_NAME(const OSSL_STORE_INFO *info);187const char *OSSL_STORE_INFO_get0_NAME_description(const OSSL_STORE_INFO *info);188char *OSSL_STORE_INFO_get1_NAME_description(const OSSL_STORE_INFO *info);189EVP_PKEY *OSSL_STORE_INFO_get0_PARAMS(const OSSL_STORE_INFO *info);190EVP_PKEY *OSSL_STORE_INFO_get1_PARAMS(const OSSL_STORE_INFO *info);191EVP_PKEY *OSSL_STORE_INFO_get0_PUBKEY(const OSSL_STORE_INFO *info);192EVP_PKEY *OSSL_STORE_INFO_get1_PUBKEY(const OSSL_STORE_INFO *info);193EVP_PKEY *OSSL_STORE_INFO_get0_PKEY(const OSSL_STORE_INFO *info);194EVP_PKEY *OSSL_STORE_INFO_get1_PKEY(const OSSL_STORE_INFO *info);195X509 *OSSL_STORE_INFO_get0_CERT(const OSSL_STORE_INFO *info);196X509 *OSSL_STORE_INFO_get1_CERT(const OSSL_STORE_INFO *info);197X509_CRL *OSSL_STORE_INFO_get0_CRL(const OSSL_STORE_INFO *info);198X509_CRL *OSSL_STORE_INFO_get1_CRL(const OSSL_STORE_INFO *info);199 200const char *OSSL_STORE_INFO_type_string(int type);201 202/*203 * Free the OSSL_STORE_INFO204 */205void OSSL_STORE_INFO_free(OSSL_STORE_INFO *info);206 207/*-208 *  Functions to construct a search URI from a base URI and search criteria209 *  -----------------------------------------------------------------------210 */211 212/* OSSL_STORE search types */213#define OSSL_STORE_SEARCH_BY_NAME 1 /* subject in certs, issuer in CRLs */214#define OSSL_STORE_SEARCH_BY_ISSUER_SERIAL 2215#define OSSL_STORE_SEARCH_BY_KEY_FINGERPRINT 3216#define OSSL_STORE_SEARCH_BY_ALIAS 4217 218/* To check what search types the scheme handler supports */219int OSSL_STORE_supports_search(OSSL_STORE_CTX *ctx, int search_type);220 221/* Search term constructors */222/*223 * The input is considered to be owned by the caller, and must therefore224 * remain present throughout the lifetime of the returned OSSL_STORE_SEARCH225 */226OSSL_STORE_SEARCH *OSSL_STORE_SEARCH_by_name(X509_NAME *name);227OSSL_STORE_SEARCH *OSSL_STORE_SEARCH_by_issuer_serial(X509_NAME *name,228    const ASN1_INTEGER229        *serial);230OSSL_STORE_SEARCH *OSSL_STORE_SEARCH_by_key_fingerprint(const EVP_MD *digest,231    const unsigned char232        *bytes,233    size_t len);234OSSL_STORE_SEARCH *OSSL_STORE_SEARCH_by_alias(const char *alias);235 236/* Search term destructor */237void OSSL_STORE_SEARCH_free(OSSL_STORE_SEARCH *search);238 239/* Search term accessors */240int OSSL_STORE_SEARCH_get_type(const OSSL_STORE_SEARCH *criterion);241X509_NAME *OSSL_STORE_SEARCH_get0_name(const OSSL_STORE_SEARCH *criterion);242const ASN1_INTEGER *OSSL_STORE_SEARCH_get0_serial(const OSSL_STORE_SEARCH243        *criterion);244const unsigned char *OSSL_STORE_SEARCH_get0_bytes(const OSSL_STORE_SEARCH245                                                      *criterion,246    size_t *length);247const char *OSSL_STORE_SEARCH_get0_string(const OSSL_STORE_SEARCH *criterion);248const EVP_MD *OSSL_STORE_SEARCH_get0_digest(const OSSL_STORE_SEARCH *criterion);249 250/*251 * Add search criterion and expected return type (which can be unspecified)252 * to the loading channel.  This MUST happen before the first OSSL_STORE_load().253 */254int OSSL_STORE_expect(OSSL_STORE_CTX *ctx, int expected_type);255int OSSL_STORE_find(OSSL_STORE_CTX *ctx, const OSSL_STORE_SEARCH *search);256 257/*-258 *  Function to fetch a loader and extract data from it259 *  ---------------------------------------------------260 */261 262typedef struct ossl_store_loader_st OSSL_STORE_LOADER;263 264OSSL_STORE_LOADER *OSSL_STORE_LOADER_fetch(OSSL_LIB_CTX *libctx,265    const char *scheme,266    const char *properties);267int OSSL_STORE_LOADER_up_ref(OSSL_STORE_LOADER *loader);268void OSSL_STORE_LOADER_free(OSSL_STORE_LOADER *loader);269const OSSL_PROVIDER *OSSL_STORE_LOADER_get0_provider(const OSSL_STORE_LOADER *270        loader);271const char *OSSL_STORE_LOADER_get0_properties(const OSSL_STORE_LOADER *loader);272const char *OSSL_STORE_LOADER_get0_description(const OSSL_STORE_LOADER *loader);273int OSSL_STORE_LOADER_is_a(const OSSL_STORE_LOADER *loader,274    const char *scheme);275void OSSL_STORE_LOADER_do_all_provided(OSSL_LIB_CTX *libctx,276    void (*fn)(OSSL_STORE_LOADER *loader,277        void *arg),278    void *arg);279int OSSL_STORE_LOADER_names_do_all(const OSSL_STORE_LOADER *loader,280    void (*fn)(const char *name, void *data),281    void *data);282 283/*-284 *  Function to register a loader for the given URI scheme.285 *  -------------------------------------------------------286 *287 *  The loader receives all the main components of an URI except for the288 *  scheme.289 */290 291#ifndef OPENSSL_NO_DEPRECATED_3_0292 293/* struct ossl_store_loader_ctx_st is defined differently by each loader */294typedef struct ossl_store_loader_ctx_st OSSL_STORE_LOADER_CTX;295typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_open_fn)(const OSSL_STORE_LOADER *loader, const char *uri,296    const UI_METHOD *ui_method, void *ui_data);297typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_open_ex_fn)(const OSSL_STORE_LOADER *loader,298    const char *uri, OSSL_LIB_CTX *libctx, const char *propq,299    const UI_METHOD *ui_method, void *ui_data);300 301typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_attach_fn)(const OSSL_STORE_LOADER *loader, BIO *bio,302    OSSL_LIB_CTX *libctx, const char *propq,303    const UI_METHOD *ui_method, void *ui_data);304typedef int (*OSSL_STORE_ctrl_fn)(OSSL_STORE_LOADER_CTX *ctx, int cmd, va_list args);305typedef int (*OSSL_STORE_expect_fn)(OSSL_STORE_LOADER_CTX *ctx, int expected);306typedef int (*OSSL_STORE_find_fn)(OSSL_STORE_LOADER_CTX *ctx, const OSSL_STORE_SEARCH *criteria);307typedef OSSL_STORE_INFO *(*OSSL_STORE_load_fn)(OSSL_STORE_LOADER_CTX *ctx, const UI_METHOD *ui_method, void *ui_data);308typedef int (*OSSL_STORE_eof_fn)(OSSL_STORE_LOADER_CTX *ctx);309typedef int (*OSSL_STORE_error_fn)(OSSL_STORE_LOADER_CTX *ctx);310typedef int (*OSSL_STORE_close_fn)(OSSL_STORE_LOADER_CTX *ctx);311 312#endif313#ifndef OPENSSL_NO_DEPRECATED_3_0314OSSL_DEPRECATEDIN_3_0315OSSL_STORE_LOADER *OSSL_STORE_LOADER_new(ENGINE *e, const char *scheme);316OSSL_DEPRECATEDIN_3_0317int OSSL_STORE_LOADER_set_open(OSSL_STORE_LOADER *loader,318    OSSL_STORE_open_fn open_function);319OSSL_DEPRECATEDIN_3_0320int OSSL_STORE_LOADER_set_open_ex(OSSL_STORE_LOADER *loader,321    OSSL_STORE_open_ex_fn open_ex_function);322OSSL_DEPRECATEDIN_3_0323int OSSL_STORE_LOADER_set_attach(OSSL_STORE_LOADER *loader,324    OSSL_STORE_attach_fn attach_function);325OSSL_DEPRECATEDIN_3_0326int OSSL_STORE_LOADER_set_ctrl(OSSL_STORE_LOADER *loader,327    OSSL_STORE_ctrl_fn ctrl_function);328OSSL_DEPRECATEDIN_3_0329int OSSL_STORE_LOADER_set_expect(OSSL_STORE_LOADER *loader,330    OSSL_STORE_expect_fn expect_function);331OSSL_DEPRECATEDIN_3_0332int OSSL_STORE_LOADER_set_find(OSSL_STORE_LOADER *loader,333    OSSL_STORE_find_fn find_function);334OSSL_DEPRECATEDIN_3_0335int OSSL_STORE_LOADER_set_load(OSSL_STORE_LOADER *loader,336    OSSL_STORE_load_fn load_function);337OSSL_DEPRECATEDIN_3_0338int OSSL_STORE_LOADER_set_eof(OSSL_STORE_LOADER *loader,339    OSSL_STORE_eof_fn eof_function);340OSSL_DEPRECATEDIN_3_0341int OSSL_STORE_LOADER_set_error(OSSL_STORE_LOADER *loader,342    OSSL_STORE_error_fn error_function);343OSSL_DEPRECATEDIN_3_0344int OSSL_STORE_LOADER_set_close(OSSL_STORE_LOADER *loader,345    OSSL_STORE_close_fn close_function);346OSSL_DEPRECATEDIN_3_0347const ENGINE *OSSL_STORE_LOADER_get0_engine(const OSSL_STORE_LOADER *loader);348OSSL_DEPRECATEDIN_3_0349const char *OSSL_STORE_LOADER_get0_scheme(const OSSL_STORE_LOADER *loader);350OSSL_DEPRECATEDIN_3_0351int OSSL_STORE_register_loader(OSSL_STORE_LOADER *loader);352OSSL_DEPRECATEDIN_3_0353OSSL_STORE_LOADER *OSSL_STORE_unregister_loader(const char *scheme);354#endif355 356/*-357 *  Functions to list STORE loaders358 *  -------------------------------359 */360#ifndef OPENSSL_NO_DEPRECATED_3_0361OSSL_DEPRECATEDIN_3_0362int OSSL_STORE_do_all_loaders(void (*do_function)(const OSSL_STORE_LOADER *loader,363                                  void *do_arg),364    void *do_arg);365#endif366 367#ifdef __cplusplus368}369#endif370#endif371