1/*
2 * Copyright 2001-2018 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 (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.
27 */
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))
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)
49void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb);
50void 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 *engine_table_select_int(ENGINE_TABLE **table, int nid, const char *f,
66 int l);
67# define engine_table_select(t,n) \
68 engine_table_select_int(t,n,OPENSSL_FILE,OPENSSL_LINE)
69typedef void (engine_table_doall_cb) (int nid, STACK_OF(ENGINE) *sk,
70 ENGINE *def, void *arg);
71void 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
77 * caller may already be controlling of the engine lock.
78 */
79int engine_unlocked_init(ENGINE *e);
80int engine_unlocked_finish(ENGINE *e, int unlock_for_handlers);
81int engine_free_util(ENGINE *e, int not_locked);
82
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 */
88void engine_set_all_null(ENGINE *e);
89
90/*
91 * NB: Bitwise OR-able values for the "flags" variable in ENGINE are now
92 * exposed in engine.h.
93 */
94
95/* Free up dynamically allocated public key methods associated with ENGINE */
96
97void engine_pkey_meths_free(ENGINE *e);
98void engine_pkey_asn1_meths_free(ENGINE *e);
99
100/* Once initialisation function */
101extern CRYPTO_ONCE engine_lock_init;
102DECLARE_RUN_ONCE(do_engine_lock_init)
103
104/*
105 * This is a structure for storing implementations of various crypto
106 * algorithms and functions.
107 */
108struct 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;
114 const EC_KEY_METHOD *ec_meth;
115 const RAND_METHOD *rand_meth;
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 */
134 CRYPTO_REF_COUNT struct_ref;
135 /*
136 * reference count on usability of the engine type. NB: This controls the
137 * loading and initialisation of any functionality required by this
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};
149
150typedef struct st_engine_pile ENGINE_PILE;
151
152DEFINE_LHASH_OF(ENGINE_PILE);
153
154#endif /* OSSL_CRYPTO_ENGINE_ENG_LOCAL_H */
155