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