include/internal/core.h

   1 /*
   2  * Copyright 2019-2022 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 OSSL_INTERNAL_CORE_H
  11 # define OSSL_INTERNAL_CORE_H
  12 # pragma once
  13
  14 /*
  15  * namespaces:
  16  *
  17  * ossl_method_         Core Method API
  18  */
  19
  20 /*
  21  * construct an arbitrary method from a dispatch table found by looking
  22  * up a match for the < operation_id, name, property > combination.
  23  * constructor and destructor are the constructor and destructor for that
  24  * arbitrary object.
  25  *
  26  * These objects are normally cached, unless the provider says not to cache.
  27  * However, force_cache can be used to force caching whatever the provider
  28  * says (for example, because the application knows better).
  29  */
  30 typedef struct ossl_method_construct_method_st {
  31     /* Get a temporary store */
  32     void *(*get_tmp_store)(void *data);
  33     /* Reserve the appropriate method store */
  34     int (*lock_store)(void *store, void *data);
  35     /* Unreserve the appropriate method store */
  36     int (*unlock_store)(void *store, void *data);
  37     /* Get an already existing method from a store */
  38     void *(*get)(void *store, const OSSL_PROVIDER **prov, void *data);
  39     /* Store a method in a store */
  40     int (*put)(void *store, void *method, const OSSL_PROVIDER *prov,
  41                const char *name, const char *propdef, void *data);
  42     /* Construct a new method */
  43     void *(*construct)(const OSSL_ALGORITHM *algodef, OSSL_PROVIDER *prov,
  44                        void *data);
  45     /* Destruct a method */
  46     void (*destruct)(void *method, void *data);
  47 } OSSL_METHOD_CONSTRUCT_METHOD;
  48
  49 void *ossl_method_construct(OSSL_LIB_CTX *ctx, int operation_id,
  50                             OSSL_PROVIDER **provider_rw, int force_cache,
  51                             OSSL_METHOD_CONSTRUCT_METHOD *mcm, void *mcm_data);
  52
  53 void ossl_algorithm_do_all(OSSL_LIB_CTX *libctx, int operation_id,
  54                            OSSL_PROVIDER *provider,
  55                            int (*pre)(OSSL_PROVIDER *, int operation_id,
  56                                       int no_store, void *data, int *result),
  57                            int (*reserve_store)(int no_store, void *data),
  58                            void (*fn)(OSSL_PROVIDER *provider,
  59                                       const OSSL_ALGORITHM *algo,
  60                                       int no_store, void *data),
  61                            int (*unreserve_store)(void *data),
  62                            int (*post)(OSSL_PROVIDER *, int operation_id,
  63                                        int no_store, void *data, int *result),
  64                            void *data);
  65 char *ossl_algorithm_get1_first_name(const OSSL_ALGORITHM *algo);
  66
  67 __owur int ossl_lib_ctx_write_lock(OSSL_LIB_CTX *ctx);
  68 __owur int ossl_lib_ctx_read_lock(OSSL_LIB_CTX *ctx);
  69 int ossl_lib_ctx_unlock(OSSL_LIB_CTX *ctx);
  70 int ossl_lib_ctx_is_child(OSSL_LIB_CTX *ctx);
  71 #endif