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