Coverage Report

Created: 2022-11-30 06:20

/src/openssl/crypto/engine/tb_pkmeth.c
Line
Count
Source (jump to first uncovered line)
1
/* ====================================================================
2
 * Copyright (c) 2006 The OpenSSL Project.  All rights reserved.
3
 *
4
 * Redistribution and use in source and binary forms, with or without
5
 * modification, are permitted provided that the following conditions
6
 * are met:
7
 *
8
 * 1. Redistributions of source code must retain the above copyright
9
 *    notice, this list of conditions and the following disclaimer.
10
 *
11
 * 2. Redistributions in binary form must reproduce the above copyright
12
 *    notice, this list of conditions and the following disclaimer in
13
 *    the documentation and/or other materials provided with the
14
 *    distribution.
15
 *
16
 * 3. All advertising materials mentioning features or use of this
17
 *    software must display the following acknowledgment:
18
 *    "This product includes software developed by the OpenSSL Project
19
 *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
20
 *
21
 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22
 *    endorse or promote products derived from this software without
23
 *    prior written permission. For written permission, please contact
24
 *    licensing@OpenSSL.org.
25
 *
26
 * 5. Products derived from this software may not be called "OpenSSL"
27
 *    nor may "OpenSSL" appear in their names without prior written
28
 *    permission of the OpenSSL Project.
29
 *
30
 * 6. Redistributions of any form whatsoever must retain the following
31
 *    acknowledgment:
32
 *    "This product includes software developed by the OpenSSL Project
33
 *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
34
 *
35
 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36
 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
39
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46
 * OF THE POSSIBILITY OF SUCH DAMAGE.
47
 * ====================================================================
48
 *
49
 * This product includes cryptographic software written by Eric Young
50
 * (eay@cryptsoft.com).  This product includes software written by Tim
51
 * Hudson (tjh@cryptsoft.com).
52
 *
53
 */
54
55
#include "eng_int.h"
56
#include <openssl/evp.h>
57
58
/*
59
 * If this symbol is defined then ENGINE_get_pkey_meth_engine(), the function
60
 * that is used by EVP to hook in pkey_meth code and cache defaults (etc),
61
 * will display brief debugging summaries to stderr with the 'nid'.
62
 */
63
/* #define ENGINE_PKEY_METH_DEBUG */
64
65
static ENGINE_TABLE *pkey_meth_table = NULL;
66
67
void ENGINE_unregister_pkey_meths(ENGINE *e)
68
0
{
69
0
    engine_table_unregister(&pkey_meth_table, e);
70
0
}
71
72
static void engine_unregister_all_pkey_meths(void)
73
0
{
74
0
    engine_table_cleanup(&pkey_meth_table);
75
0
}
76
77
int ENGINE_register_pkey_meths(ENGINE *e)
78
209
{
79
209
    if (e->pkey_meths) {
80
38
        const int *nids;
81
38
        int num_nids = e->pkey_meths(e, NULL, &nids, 0);
82
38
        if (num_nids > 0)
83
38
            return engine_table_register(&pkey_meth_table,
84
38
                                         engine_unregister_all_pkey_meths, e,
85
38
                                         nids, num_nids, 0);
86
38
    }
87
171
    return 1;
88
209
}
89
90
void ENGINE_register_all_pkey_meths()
91
0
{
92
0
    ENGINE *e;
93
94
0
    for (e = ENGINE_get_first(); e; e = ENGINE_get_next(e))
95
0
        ENGINE_register_pkey_meths(e);
96
0
}
97
98
int ENGINE_set_default_pkey_meths(ENGINE *e)
99
0
{
100
0
    if (e->pkey_meths) {
101
0
        const int *nids;
102
0
        int num_nids = e->pkey_meths(e, NULL, &nids, 0);
103
0
        if (num_nids > 0)
104
0
            return engine_table_register(&pkey_meth_table,
105
0
                                         engine_unregister_all_pkey_meths, e,
106
0
                                         nids, num_nids, 1);
107
0
    }
108
0
    return 1;
109
0
}
110
111
/*
112
 * Exposed API function to get a functional reference from the implementation
113
 * table (ie. try to get a functional reference from the tabled structural
114
 * references) for a given pkey_meth 'nid'
115
 */
116
ENGINE *ENGINE_get_pkey_meth_engine(int nid)
117
0
{
118
0
    return engine_table_select(&pkey_meth_table, nid);
119
0
}
120
121
/* Obtains a pkey_meth implementation from an ENGINE functional reference */
122
const EVP_PKEY_METHOD *ENGINE_get_pkey_meth(ENGINE *e, int nid)
123
0
{
124
0
    EVP_PKEY_METHOD *ret;
125
0
    ENGINE_PKEY_METHS_PTR fn = ENGINE_get_pkey_meths(e);
126
0
    if (!fn || !fn(e, &ret, NULL, nid)) {
127
0
        ENGINEerr(ENGINE_F_ENGINE_GET_PKEY_METH,
128
0
                  ENGINE_R_UNIMPLEMENTED_PUBLIC_KEY_METHOD);
129
0
        return NULL;
130
0
    }
131
0
    return ret;
132
0
}
133
134
/* Gets the pkey_meth callback from an ENGINE structure */
135
ENGINE_PKEY_METHS_PTR ENGINE_get_pkey_meths(const ENGINE *e)
136
0
{
137
0
    return e->pkey_meths;
138
0
}
139
140
/* Sets the pkey_meth callback in an ENGINE structure */
141
int ENGINE_set_pkey_meths(ENGINE *e, ENGINE_PKEY_METHS_PTR f)
142
19
{
143
19
    e->pkey_meths = f;
144
19
    return 1;
145
19
}
146
147
/*
148
 * Internal function to free up EVP_PKEY_METHOD structures before an ENGINE
149
 * is destroyed
150
 */
151
152
void engine_pkey_meths_free(ENGINE *e)
153
0
{
154
0
    int i;
155
0
    EVP_PKEY_METHOD *pkm;
156
0
    if (e->pkey_meths) {
157
0
        const int *pknids;
158
0
        int npknids;
159
0
        npknids = e->pkey_meths(e, NULL, &pknids, 0);
160
0
        for (i = 0; i < npknids; i++) {
161
0
            if (e->pkey_meths(e, &pkm, NULL, pknids[i])) {
162
0
                EVP_PKEY_meth_free(pkm);
163
0
            }
164
0
        }
165
0
    }
166
0
}