| Absolute File Name: | /home/opencoverage/opencoverage/guest-scripts/openssl/src/crypto/engine/eng_int.h |
| Source code | Switch to Preprocessed file |
| Line | Source | Count |
|---|---|---|
| 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 OpenSSL license (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 HEADER_ENGINE_INT_H | - |
| 12 | # define HEADER_ENGINE_INT_H | - |
| 13 | - | |
| 14 | # include "internal/cryptlib.h" | - |
| 15 | # include "internal/engine.h" | - |
| 16 | # include "internal/thread_once.h" | - |
| 17 | # include "internal/refcount.h" | - |
| 18 | - | |
| 19 | extern CRYPTO_RWLOCK *global_engine_lock; | - |
| 20 | - | |
| 21 | /* | - |
| 22 | * If we compile with this symbol defined, then both reference counts in the | - |
| 23 | * ENGINE structure will be monitored with a line of output on stderr for | - |
| 24 | * each change. This prints the engine's pointer address (truncated to | - |
| 25 | * unsigned int), "struct" or "funct" to indicate the reference type, the | - |
| 26 | * before and after reference count, and the file:line-number pair. The | - |
| 27 | * "engine_ref_debug" statements must come *after* the change. | - |
| 28 | */ | - |
| 29 | # ifdef ENGINE_REF_COUNT_DEBUG | - |
| 30 | - | |
| 31 | # define engine_ref_debug(e, isfunct, diff) \ | - |
| 32 | fprintf(stderr, "engine: %08x %s from %d to %d (%s:%d)\n", \ | - |
| 33 | (unsigned int)(e), (isfunct ? "funct" : "struct"), \ | - |
| 34 | ((isfunct) ? ((e)->funct_ref - (diff)) : ((e)->struct_ref - (diff))), \ | - |
| 35 | ((isfunct) ? (e)->funct_ref : (e)->struct_ref), \ | - |
| 36 | (OPENSSL_FILE), (OPENSSL_LINE)) | - |
| 37 | - | |
| 38 | # else | - |
| 39 | - | |
| 40 | # define engine_ref_debug(e, isfunct, diff) | - |
| 41 | - | |
| 42 | # endif | - |
| 43 | - | |
| 44 | /* | - |
| 45 | * Any code that will need cleanup operations should use these functions to | - |
| 46 | * register callbacks. engine_cleanup_int() will call all registered | - |
| 47 | * callbacks in order. NB: both the "add" functions assume the engine lock to | - |
| 48 | * already be held (in "write" mode). | - |
| 49 | */ | - |
| 50 | typedef void (ENGINE_CLEANUP_CB) (void); | - |
| 51 | typedef struct st_engine_cleanup_item { | - |
| 52 | ENGINE_CLEANUP_CB *cb; | - |
| 53 | } ENGINE_CLEANUP_ITEM; | - |
| 54 | DEFINE_STACK_OF(ENGINE_CLEANUP_ITEM) never executed: end of blocknever executed: end of blockexecuted 1960 times by 1 test: end of blockExecuted by:
never executed: end of blocknever executed: return OPENSSL_sk_num((const OPENSSL_STACK *)sk);never executed: return (ENGINE_CLEANUP_ITEM *)OPENSSL_sk_value((const OPENSSL_STACK *)sk, idx);never executed: return (struct stack_st_ENGINE_CLEANUP_ITEM *)OPENSSL_sk_new((OPENSSL_sk_compfunc)compare);executed 1960 times by 1 test: return (struct stack_st_ENGINE_CLEANUP_ITEM *)OPENSSL_sk_new_null();Executed by:
never executed: return (struct stack_st_ENGINE_CLEANUP_ITEM *)OPENSSL_sk_new_reserve((OPENSSL_sk_compfunc)compare, n);never executed: return OPENSSL_sk_reserve((OPENSSL_STACK *)sk, n);never executed: return (ENGINE_CLEANUP_ITEM *)OPENSSL_sk_delete((OPENSSL_STACK *)sk, i);never executed: return (ENGINE_CLEANUP_ITEM *)OPENSSL_sk_delete_ptr((OPENSSL_STACK *)sk, (const void *)ptr);executed 1963 times by 1 test: return OPENSSL_sk_push((OPENSSL_STACK *)sk, (const void *)ptr);Executed by:
never executed: return OPENSSL_sk_unshift((OPENSSL_STACK *)sk, (const void *)ptr);never executed: return (ENGINE_CLEANUP_ITEM *)OPENSSL_sk_pop((OPENSSL_STACK *)sk);never executed: return (ENGINE_CLEANUP_ITEM *)OPENSSL_sk_shift((OPENSSL_STACK *)sk);executed 1101 times by 1 test: return OPENSSL_sk_insert((OPENSSL_STACK *)sk, (const void *)ptr, idx);Executed by:
never executed: return (ENGINE_CLEANUP_ITEM *)OPENSSL_sk_set((OPENSSL_STACK *)sk, idx, (const void *)ptr);never executed: return OPENSSL_sk_find((OPENSSL_STACK *)sk, (const void *)ptr);never executed: return OPENSSL_sk_find_ex((OPENSSL_STACK *)sk, (const void *)ptr);never executed: return OPENSSL_sk_is_sorted((const OPENSSL_STACK *)sk);never executed: return (struct stack_st_ENGINE_CLEANUP_ITEM *)OPENSSL_sk_dup((const OPENSSL_STACK *)sk);never executed: return (struct stack_st_ENGINE_CLEANUP_ITEM *)OPENSSL_sk_deep_copy((const OPENSSL_STACK *)sk, (OPENSSL_sk_copyfunc)copyfunc, (OPENSSL_sk_freefunc)freefunc);never executed: return (sk_ENGINE_CLEANUP_ITEM_compfunc)OPENSSL_sk_set_cmp_func((OPENSSL_STACK *)sk, (OPENSSL_sk_compfunc)compare); | 0-1963 |
| 55 | void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb); | - |
| 56 | void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb); | - |
| 57 | - | |
| 58 | /* We need stacks of ENGINEs for use in eng_table.c */ | - |
| 59 | DEFINE_STACK_OF(ENGINE) executed 2936 times by 1 test: end of blockExecuted by:
never executed: end of blocknever executed: end of blocknever executed: end of blocknever executed: return OPENSSL_sk_num((const OPENSSL_STACK *)sk);never executed: return (ENGINE *)OPENSSL_sk_value((const OPENSSL_STACK *)sk, idx);never executed: return (struct stack_st_ENGINE *)OPENSSL_sk_new((OPENSSL_sk_compfunc)compare);executed 2936 times by 1 test: return (struct stack_st_ENGINE *)OPENSSL_sk_new_null();Executed by:
never executed: return (struct stack_st_ENGINE *)OPENSSL_sk_new_reserve((OPENSSL_sk_compfunc)compare, n);never executed: return OPENSSL_sk_reserve((OPENSSL_STACK *)sk, n);never executed: return (ENGINE *)OPENSSL_sk_delete((OPENSSL_STACK *)sk, i);executed 2936 times by 1 test: return (ENGINE *)OPENSSL_sk_delete_ptr((OPENSSL_STACK *)sk, (const void *)ptr);Executed by:
executed 2936 times by 1 test: return OPENSSL_sk_push((OPENSSL_STACK *)sk, (const void *)ptr);Executed by:
never executed: return OPENSSL_sk_unshift((OPENSSL_STACK *)sk, (const void *)ptr);never executed: return (ENGINE *)OPENSSL_sk_pop((OPENSSL_STACK *)sk);never executed: return (ENGINE *)OPENSSL_sk_shift((OPENSSL_STACK *)sk);never executed: return OPENSSL_sk_insert((OPENSSL_STACK *)sk, (const void *)ptr, idx);never executed: return (ENGINE *)OPENSSL_sk_set((OPENSSL_STACK *)sk, idx, (const void *)ptr);never executed: return OPENSSL_sk_find((OPENSSL_STACK *)sk, (const void *)ptr);never executed: return OPENSSL_sk_find_ex((OPENSSL_STACK *)sk, (const void *)ptr);never executed: return OPENSSL_sk_is_sorted((const OPENSSL_STACK *)sk);never executed: return (struct stack_st_ENGINE *)OPENSSL_sk_dup((const OPENSSL_STACK *)sk);never executed: return (struct stack_st_ENGINE *)OPENSSL_sk_deep_copy((const OPENSSL_STACK *)sk, (OPENSSL_sk_copyfunc)copyfunc, (OPENSSL_sk_freefunc)freefunc);never executed: return (sk_ENGINE_compfunc)OPENSSL_sk_set_cmp_func((OPENSSL_STACK *)sk, (OPENSSL_sk_compfunc)compare); | 0-2936 |
| 60 | - | |
| 61 | /* | - |
| 62 | * If this symbol is defined then engine_table_select(), the function that is | - |
| 63 | * used by RSA, DSA (etc) code to select registered ENGINEs, cache defaults | - |
| 64 | * and functional references (etc), will display debugging summaries to | - |
| 65 | * stderr. | - |
| 66 | */ | - |
| 67 | /* #define ENGINE_TABLE_DEBUG */ | - |
| 68 | - | |
| 69 | /* | - |
| 70 | * This represents an implementation table. Dependent code should instantiate | - |
| 71 | * it as a (ENGINE_TABLE *) pointer value set initially to NULL. | - |
| 72 | */ | - |
| 73 | typedef struct st_engine_table ENGINE_TABLE; | - |
| 74 | int engine_table_register(ENGINE_TABLE **table, ENGINE_CLEANUP_CB *cleanup, | - |
| 75 | ENGINE *e, const int *nids, int num_nids, | - |
| 76 | int setdefault); | - |
| 77 | void engine_table_unregister(ENGINE_TABLE **table, ENGINE *e); | - |
| 78 | void engine_table_cleanup(ENGINE_TABLE **table); | - |
| 79 | # ifndef ENGINE_TABLE_DEBUG | - |
| 80 | ENGINE *engine_table_select(ENGINE_TABLE **table, int nid); | - |
| 81 | # else | - |
| 82 | ENGINE *engine_table_select_tmp(ENGINE_TABLE **table, int nid, const char *f, | - |
| 83 | int l); | - |
| 84 | # define engine_table_select(t,n) engine_table_select_tmp(t,n,OPENSSL_FILE,OPENSSL_LINE) | - |
| 85 | # endif | - |
| 86 | typedef void (engine_table_doall_cb) (int nid, STACK_OF(ENGINE) *sk, | - |
| 87 | ENGINE *def, void *arg); | - |
| 88 | void engine_table_doall(ENGINE_TABLE *table, engine_table_doall_cb *cb, | - |
| 89 | void *arg); | - |
| 90 | - | |
| 91 | /* | - |
| 92 | * Internal versions of API functions that have control over locking. These | - |
| 93 | * are used between C files when functionality needs to be shared but the | - |
| 94 | * caller may already be controlling of the engine lock. | - |
| 95 | */ | - |
| 96 | int engine_unlocked_init(ENGINE *e); | - |
| 97 | int engine_unlocked_finish(ENGINE *e, int unlock_for_handlers); | - |
| 98 | int engine_free_util(ENGINE *e, int not_locked); | - |
| 99 | - | |
| 100 | /* | - |
| 101 | * This function will reset all "set"able values in an ENGINE to NULL. This | - |
| 102 | * won't touch reference counts or ex_data, but is equivalent to calling all | - |
| 103 | * the ENGINE_set_***() functions with a NULL value. | - |
| 104 | */ | - |
| 105 | void engine_set_all_null(ENGINE *e); | - |
| 106 | - | |
| 107 | /* | - |
| 108 | * NB: Bitwise OR-able values for the "flags" variable in ENGINE are now | - |
| 109 | * exposed in engine.h. | - |
| 110 | */ | - |
| 111 | - | |
| 112 | /* Free up dynamically allocated public key methods associated with ENGINE */ | - |
| 113 | - | |
| 114 | void engine_pkey_meths_free(ENGINE *e); | - |
| 115 | void engine_pkey_asn1_meths_free(ENGINE *e); | - |
| 116 | - | |
| 117 | /* Once initialisation function */ | - |
| 118 | extern CRYPTO_ONCE engine_lock_init; | - |
| 119 | DECLARE_RUN_ONCE(do_engine_lock_init) | - |
| 120 | - | |
| 121 | /* | - |
| 122 | * This is a structure for storing implementations of various crypto | - |
| 123 | * algorithms and functions. | - |
| 124 | */ | - |
| 125 | struct engine_st { | - |
| 126 | const char *id; | - |
| 127 | const char *name; | - |
| 128 | const RSA_METHOD *rsa_meth; | - |
| 129 | const DSA_METHOD *dsa_meth; | - |
| 130 | const DH_METHOD *dh_meth; | - |
| 131 | const EC_KEY_METHOD *ec_meth; | - |
| 132 | const RAND_METHOD *rand_meth; | - |
| 133 | /* Cipher handling is via this callback */ | - |
| 134 | ENGINE_CIPHERS_PTR ciphers; | - |
| 135 | /* Digest handling is via this callback */ | - |
| 136 | ENGINE_DIGESTS_PTR digests; | - |
| 137 | /* Public key handling via this callback */ | - |
| 138 | ENGINE_PKEY_METHS_PTR pkey_meths; | - |
| 139 | /* ASN1 public key handling via this callback */ | - |
| 140 | ENGINE_PKEY_ASN1_METHS_PTR pkey_asn1_meths; | - |
| 141 | ENGINE_GEN_INT_FUNC_PTR destroy; | - |
| 142 | ENGINE_GEN_INT_FUNC_PTR init; | - |
| 143 | ENGINE_GEN_INT_FUNC_PTR finish; | - |
| 144 | ENGINE_CTRL_FUNC_PTR ctrl; | - |
| 145 | ENGINE_LOAD_KEY_PTR load_privkey; | - |
| 146 | ENGINE_LOAD_KEY_PTR load_pubkey; | - |
| 147 | ENGINE_SSL_CLIENT_CERT_PTR load_ssl_client_cert; | - |
| 148 | const ENGINE_CMD_DEFN *cmd_defns; | - |
| 149 | int flags; | - |
| 150 | /* reference count on the structure itself */ | - |
| 151 | CRYPTO_REF_COUNT struct_ref; | - |
| 152 | /* | - |
| 153 | * reference count on usability of the engine type. NB: This controls the | - |
| 154 | * loading and initialisation of any functionality required by this | - |
| 155 | * engine, whereas the previous count is simply to cope with | - |
| 156 | * (de)allocation of this structure. Hence, running_ref <= struct_ref at | - |
| 157 | * all times. | - |
| 158 | */ | - |
| 159 | int funct_ref; | - |
| 160 | /* A place to store per-ENGINE data */ | - |
| 161 | CRYPTO_EX_DATA ex_data; | - |
| 162 | /* Used to maintain the linked-list of engines. */ | - |
| 163 | struct engine_st *prev; | - |
| 164 | struct engine_st *next; | - |
| 165 | }; | - |
| 166 | - | |
| 167 | typedef struct st_engine_pile ENGINE_PILE; | - |
| 168 | - | |
| 169 | DEFINE_LHASH_OF(ENGINE_PILE); executed 1101 times by 1 test: end of blockExecuted by:
never executed: end of blocknever executed: end of blocknever executed: end of blocknever executed: end of blockexecuted 1101 times by 1 test: end of blockExecuted by:
executed 1101 times by 1 test: return (struct lhash_st_ENGINE_PILE *) OPENSSL_LH_new((OPENSSL_LH_HASHFUNC)hfn, (OPENSSL_LH_COMPFUNC)cfn);Executed by:
executed 2936 times by 1 test: return (ENGINE_PILE *)OPENSSL_LH_insert((OPENSSL_LHASH *)lh, d);Executed by:
never executed: return (ENGINE_PILE *)OPENSSL_LH_delete((OPENSSL_LHASH *)lh, d);executed 17921 times by 1 test: return (ENGINE_PILE *)OPENSSL_LH_retrieve((OPENSSL_LHASH *)lh, d);Executed by:
never executed: return OPENSSL_LH_error((OPENSSL_LHASH *)lh);never executed: return OPENSSL_LH_num_items((OPENSSL_LHASH *)lh);never executed: return OPENSSL_LH_get_down_load((OPENSSL_LHASH *)lh); | 0-17921 |
| 170 | - | |
| 171 | #endif /* HEADER_ENGINE_INT_H */ | - |
| Source code | Switch to Preprocessed file |