1/* 2 * Copyright 2001-2023 The OpenSSL Project Authors. All Rights Reserved. 3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved 4 * 5 * Licensed under the Apache License 2.0 (the "License"). You may not use 6 * this file except in compliance with the License. You can obtain a copy 7 * in the file LICENSE in the source distribution or at 8 * https://www.openssl.org/source/license.html 9 */ 10 11#ifndef OSSL_CRYPTO_ENGINE_ENG_LOCAL_H 12# define OSSL_CRYPTO_ENGINE_ENG_LOCAL_H 13 14# include <openssl/trace.h> 15# include "internal/cryptlib.h" 16# include "crypto/engine.h" 17# include "internal/thread_once.h" 18# include "internal/refcount.h" 19 20extern CRYPTO_RWLOCK *global_engine_lock; 21 22/* 23 * This prints the engine's pointer address, "struct" or "funct" to 24 * indicate the reference type, the before and after reference count, and 25 * the file:line-number pair. The "ENGINE_REF_PRINT" statements must come 26 * *after* the change. 27 */ 28# define ENGINE_REF_PRINT(e, isfunct, diff) \ 29 OSSL_TRACE6(ENGINE_REF_COUNT, \ 30 "engine: %p %s from %d to %d (%s:%d)\n", \ 31 (void *)(e), (isfunct ? "funct" : "struct"), \ 32 ((isfunct) \ 33 ? ((e)->funct_ref - (diff)) \ 34 : ((e)->struct_ref - (diff))), \ 35 ((isfunct) ? (e)->funct_ref : (e)->struct_ref), \ 36 (OPENSSL_FILE), (OPENSSL_LINE)) 37 38/* 39 * Any code that will need cleanup operations should use these functions to 40 * register callbacks. engine_cleanup_int() will call all registered 41 * callbacks in order. NB: both the "add" functions assume the engine lock to 42 * already be held (in "write" mode). 43 */ 44typedef void (ENGINE_CLEANUP_CB) (void); 45typedef struct st_engine_cleanup_item { 46 ENGINE_CLEANUP_CB *cb; 47} ENGINE_CLEANUP_ITEM; 48DEFINE_STACK_OF(ENGINE_CLEANUP_ITEM) 49int engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb); 50int engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb); 51 52/* We need stacks of ENGINEs for use in eng_table.c */ 53DEFINE_STACK_OF(ENGINE) 54 55/* 56 * This represents an implementation table. Dependent code should instantiate 57 * it as a (ENGINE_TABLE *) pointer value set initially to NULL. 58 */ 59typedef struct st_engine_table ENGINE_TABLE; 60int engine_table_register(ENGINE_TABLE **table, ENGINE_CLEANUP_CB *cleanup, 61 ENGINE *e, const int *nids, int num_nids, 62 int setdefault); 63void engine_table_unregister(ENGINE_TABLE **table, ENGINE *e); 64void engine_table_cleanup(ENGINE_TABLE **table); 65ENGINE *ossl_engine_table_select(ENGINE_TABLE **table, int nid, 66 const char *f, int l); 67typedef void (engine_table_doall_cb) (int nid, STACK_OF(ENGINE) *sk, 68 ENGINE *def, void *arg); 69void engine_table_doall(ENGINE_TABLE *table, engine_table_doall_cb *cb, 70 void *arg); 71 72/* 73 * Internal versions of API functions that have control over locking. These 74 * are used between C files when functionality needs to be shared but the 75 * caller may already be controlling of the engine lock. 76 */ 77int engine_unlocked_init(ENGINE *e); 78int engine_unlocked_finish(ENGINE *e, int unlock_for_handlers); 79int engine_free_util(ENGINE *e, int not_locked); 80 81/* 82 * This function will reset all "set"able values in an ENGINE to NULL. This 83 * won't touch reference counts or ex_data, but is equivalent to calling all 84 * the ENGINE_set_***() functions with a NULL value. 85 */ 86void engine_set_all_null(ENGINE *e); 87 88/* 89 * NB: Bitwise OR-able values for the "flags" variable in ENGINE are now 90 * exposed in engine.h. 91 */ 92 93/* Free up dynamically allocated public key methods associated with ENGINE */ 94 95void engine_pkey_meths_free(ENGINE *e); 96void engine_pkey_asn1_meths_free(ENGINE *e); 97 98/* Once initialisation function */ 99extern CRYPTO_ONCE engine_lock_init; 100DECLARE_RUN_ONCE(do_engine_lock_init) 101 102typedef void (*ENGINE_DYNAMIC_ID)(void); 103int engine_add_dynamic_id(ENGINE *e, ENGINE_DYNAMIC_ID dynamic_id, 104 int not_locked); 105void engine_remove_dynamic_id(ENGINE *e, int not_locked); 106 107/* 108 * This is a structure for storing implementations of various crypto 109 * algorithms and functions. 110 */ 111struct engine_st { 112 const char *id; 113 const char *name; 114 const RSA_METHOD *rsa_meth; 115 const DSA_METHOD *dsa_meth; 116 const DH_METHOD *dh_meth; 117 const EC_KEY_METHOD *ec_meth; 118 const RAND_METHOD *rand_meth; 119 /* Cipher handling is via this callback */ 120 ENGINE_CIPHERS_PTR ciphers; 121 /* Digest handling is via this callback */ 122 ENGINE_DIGESTS_PTR digests; 123 /* Public key handling via this callback */ 124 ENGINE_PKEY_METHS_PTR pkey_meths; 125 /* ASN1 public key handling via this callback */ 126 ENGINE_PKEY_ASN1_METHS_PTR pkey_asn1_meths; 127 ENGINE_GEN_INT_FUNC_PTR destroy; 128 ENGINE_GEN_INT_FUNC_PTR init; 129 ENGINE_GEN_INT_FUNC_PTR finish; 130 ENGINE_CTRL_FUNC_PTR ctrl; 131 ENGINE_LOAD_KEY_PTR load_privkey; 132 ENGINE_LOAD_KEY_PTR load_pubkey; 133 ENGINE_SSL_CLIENT_CERT_PTR load_ssl_client_cert; 134 const ENGINE_CMD_DEFN *cmd_defns; 135 int flags; 136 /* reference count on the structure itself */ 137 CRYPTO_REF_COUNT struct_ref; 138 /* 139 * reference count on usability of the engine type. NB: This controls the 140 * loading and initialisation of any functionality required by this 141 * engine, whereas the previous count is simply to cope with 142 * (de)allocation of this structure. Hence, running_ref <= struct_ref at 143 * all times. 144 */ 145 int funct_ref; 146 /* A place to store per-ENGINE data */ 147 CRYPTO_EX_DATA ex_data; 148 /* Used to maintain the linked-list of engines. */ 149 struct engine_st *prev; 150 struct engine_st *next; 151 /* Used to maintain the linked-list of dynamic engines. */ 152 struct engine_st *prev_dyn; 153 struct engine_st *next_dyn; 154 ENGINE_DYNAMIC_ID dynamic_id; 155}; 156 157typedef struct st_engine_pile ENGINE_PILE; 158 159DEFINE_LHASH_OF(ENGINE_PILE); 160 161#endif /* OSSL_CRYPTO_ENGINE_ENG_LOCAL_H */ 162