/src/openssl30/providers/implementations/ciphers/cipher_chacha20_poly1305.c
Line | Count | Source (jump to first uncovered line) |
1 | | /* |
2 | | * Copyright 2019-2023 The OpenSSL Project Authors. All Rights Reserved. |
3 | | * |
4 | | * Licensed under the Apache License 2.0 (the "License"). You may not use |
5 | | * this file except in compliance with the License. You can obtain a copy |
6 | | * in the file LICENSE in the source distribution or at |
7 | | * https://www.openssl.org/source/license.html |
8 | | */ |
9 | | |
10 | | /* Dispatch functions for chacha20_poly1305 cipher */ |
11 | | |
12 | | #include <openssl/proverr.h> |
13 | | #include "cipher_chacha20_poly1305.h" |
14 | | #include "prov/implementations.h" |
15 | | #include "prov/providercommon.h" |
16 | | |
17 | 4.60k | #define CHACHA20_POLY1305_KEYLEN CHACHA_KEY_SIZE |
18 | 1.53k | #define CHACHA20_POLY1305_BLKLEN 1 |
19 | 1.47k | #define CHACHA20_POLY1305_MAX_IVLEN 12 |
20 | 1.53k | #define CHACHA20_POLY1305_MODE 0 |
21 | 1.53k | #define CHACHA20_POLY1305_FLAGS (PROV_CIPHER_FLAG_AEAD \ |
22 | 1.53k | | PROV_CIPHER_FLAG_CUSTOM_IV) |
23 | | |
24 | | static OSSL_FUNC_cipher_newctx_fn chacha20_poly1305_newctx; |
25 | | static OSSL_FUNC_cipher_freectx_fn chacha20_poly1305_freectx; |
26 | | static OSSL_FUNC_cipher_encrypt_init_fn chacha20_poly1305_einit; |
27 | | static OSSL_FUNC_cipher_decrypt_init_fn chacha20_poly1305_dinit; |
28 | | static OSSL_FUNC_cipher_get_params_fn chacha20_poly1305_get_params; |
29 | | static OSSL_FUNC_cipher_get_ctx_params_fn chacha20_poly1305_get_ctx_params; |
30 | | static OSSL_FUNC_cipher_set_ctx_params_fn chacha20_poly1305_set_ctx_params; |
31 | | static OSSL_FUNC_cipher_cipher_fn chacha20_poly1305_cipher; |
32 | | static OSSL_FUNC_cipher_final_fn chacha20_poly1305_final; |
33 | | static OSSL_FUNC_cipher_gettable_ctx_params_fn chacha20_poly1305_gettable_ctx_params; |
34 | | #define chacha20_poly1305_settable_ctx_params ossl_cipher_aead_settable_ctx_params |
35 | | #define chacha20_poly1305_gettable_params ossl_cipher_generic_gettable_params |
36 | | #define chacha20_poly1305_update chacha20_poly1305_cipher |
37 | | |
38 | | static void *chacha20_poly1305_newctx(void *provctx) |
39 | 1.53k | { |
40 | 1.53k | PROV_CHACHA20_POLY1305_CTX *ctx; |
41 | | |
42 | 1.53k | if (!ossl_prov_is_running()) |
43 | 0 | return NULL; |
44 | | |
45 | 1.53k | ctx = OPENSSL_zalloc(sizeof(*ctx)); |
46 | 1.53k | if (ctx != NULL) { |
47 | 1.53k | ossl_cipher_generic_initkey(&ctx->base, CHACHA20_POLY1305_KEYLEN * 8, |
48 | 1.53k | CHACHA20_POLY1305_BLKLEN * 8, |
49 | 1.53k | CHACHA20_POLY1305_IVLEN * 8, |
50 | 1.53k | CHACHA20_POLY1305_MODE, |
51 | 1.53k | CHACHA20_POLY1305_FLAGS, |
52 | 1.53k | ossl_prov_cipher_hw_chacha20_poly1305( |
53 | 1.53k | CHACHA20_POLY1305_KEYLEN * 8), |
54 | 1.53k | NULL); |
55 | 1.53k | ctx->tls_payload_length = NO_TLS_PAYLOAD_LENGTH; |
56 | 1.53k | ossl_chacha20_initctx(&ctx->chacha); |
57 | 1.53k | } |
58 | 1.53k | return ctx; |
59 | 1.53k | } |
60 | | |
61 | | static void chacha20_poly1305_freectx(void *vctx) |
62 | 1.53k | { |
63 | 1.53k | PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx; |
64 | | |
65 | 1.53k | if (ctx != NULL) { |
66 | 1.53k | ossl_cipher_generic_reset_ctx((PROV_CIPHER_CTX *)vctx); |
67 | 1.53k | OPENSSL_clear_free(ctx, sizeof(*ctx)); |
68 | 1.53k | } |
69 | 1.53k | } |
70 | | |
71 | | static int chacha20_poly1305_get_params(OSSL_PARAM params[]) |
72 | 6 | { |
73 | 6 | return ossl_cipher_generic_get_params(params, 0, CHACHA20_POLY1305_FLAGS, |
74 | 6 | CHACHA20_POLY1305_KEYLEN * 8, |
75 | 6 | CHACHA20_POLY1305_BLKLEN * 8, |
76 | 6 | CHACHA20_POLY1305_IVLEN * 8); |
77 | 6 | } |
78 | | |
79 | | static int chacha20_poly1305_get_ctx_params(void *vctx, OSSL_PARAM params[]) |
80 | 19.3k | { |
81 | 19.3k | PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx; |
82 | 19.3k | OSSL_PARAM *p; |
83 | | |
84 | 19.3k | p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN); |
85 | 19.3k | if (p != NULL) { |
86 | 15.6k | if (!OSSL_PARAM_set_size_t(p, CHACHA20_POLY1305_IVLEN)) { |
87 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER); |
88 | 0 | return 0; |
89 | 0 | } |
90 | 15.6k | } |
91 | 19.3k | p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN); |
92 | 19.3k | if (p != NULL && !OSSL_PARAM_set_size_t(p, CHACHA20_POLY1305_KEYLEN)) { |
93 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER); |
94 | 0 | return 0; |
95 | 0 | } |
96 | 19.3k | p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAGLEN); |
97 | 19.3k | if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->tag_len)) { |
98 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER); |
99 | 0 | return 0; |
100 | 0 | } |
101 | 19.3k | p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD); |
102 | 19.3k | if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->tls_aad_pad_sz)) { |
103 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER); |
104 | 0 | return 0; |
105 | 0 | } |
106 | | |
107 | 19.3k | p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAG); |
108 | 19.3k | if (p != NULL) { |
109 | 2.10k | if (p->data_type != OSSL_PARAM_OCTET_STRING) { |
110 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER); |
111 | 0 | return 0; |
112 | 0 | } |
113 | 2.10k | if (!ctx->base.enc) { |
114 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_TAG_NOT_SET); |
115 | 0 | return 0; |
116 | 0 | } |
117 | 2.10k | if (p->data_size == 0 || p->data_size > POLY1305_BLOCK_SIZE) { |
118 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAG_LENGTH); |
119 | 0 | return 0; |
120 | 0 | } |
121 | 2.10k | memcpy(p->data, ctx->tag, p->data_size); |
122 | 2.10k | } |
123 | | |
124 | 19.3k | return 1; |
125 | 19.3k | } |
126 | | |
127 | | static const OSSL_PARAM chacha20_poly1305_known_gettable_ctx_params[] = { |
128 | | OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL), |
129 | | OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL), |
130 | | OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN, NULL), |
131 | | OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0), |
132 | | OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD, NULL), |
133 | | OSSL_PARAM_END |
134 | | }; |
135 | | static const OSSL_PARAM *chacha20_poly1305_gettable_ctx_params |
136 | | (ossl_unused void *cctx, ossl_unused void *provctx) |
137 | 6 | { |
138 | 6 | return chacha20_poly1305_known_gettable_ctx_params; |
139 | 6 | } |
140 | | |
141 | | static int chacha20_poly1305_set_ctx_params(void *vctx, |
142 | | const OSSL_PARAM params[]) |
143 | 50.7k | { |
144 | 50.7k | const OSSL_PARAM *p; |
145 | 50.7k | size_t len; |
146 | 50.7k | PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx; |
147 | 50.7k | PROV_CIPHER_HW_CHACHA20_POLY1305 *hw = |
148 | 50.7k | (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->base.hw; |
149 | | |
150 | 50.7k | if (params == NULL) |
151 | 27.1k | return 1; |
152 | | |
153 | 23.6k | p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_KEYLEN); |
154 | 23.6k | if (p != NULL) { |
155 | 0 | if (!OSSL_PARAM_get_size_t(p, &len)) { |
156 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER); |
157 | 0 | return 0; |
158 | 0 | } |
159 | 0 | if (len != CHACHA20_POLY1305_KEYLEN) { |
160 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH); |
161 | 0 | return 0; |
162 | 0 | } |
163 | 0 | } |
164 | 23.6k | p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_IVLEN); |
165 | 23.6k | if (p != NULL) { |
166 | 1.47k | if (!OSSL_PARAM_get_size_t(p, &len)) { |
167 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER); |
168 | 0 | return 0; |
169 | 0 | } |
170 | 1.47k | if (len != CHACHA20_POLY1305_MAX_IVLEN) { |
171 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH); |
172 | 0 | return 0; |
173 | 0 | } |
174 | 1.47k | } |
175 | | |
176 | 23.6k | p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TAG); |
177 | 23.6k | if (p != NULL) { |
178 | 22.0k | if (p->data_type != OSSL_PARAM_OCTET_STRING) { |
179 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER); |
180 | 0 | return 0; |
181 | 0 | } |
182 | 22.0k | if (p->data_size == 0 || p->data_size > POLY1305_BLOCK_SIZE) { |
183 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAG_LENGTH); |
184 | 0 | return 0; |
185 | 0 | } |
186 | 22.0k | if (p->data != NULL) { |
187 | 22.0k | if (ctx->base.enc) { |
188 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_TAG_NOT_NEEDED); |
189 | 0 | return 0; |
190 | 0 | } |
191 | 22.0k | memcpy(ctx->tag, p->data, p->data_size); |
192 | 22.0k | } |
193 | 22.0k | ctx->tag_len = p->data_size; |
194 | 22.0k | } |
195 | | |
196 | 23.6k | p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TLS1_AAD); |
197 | 23.6k | if (p != NULL) { |
198 | 58 | if (p->data_type != OSSL_PARAM_OCTET_STRING) { |
199 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER); |
200 | 0 | return 0; |
201 | 0 | } |
202 | 58 | len = hw->tls_init(&ctx->base, p->data, p->data_size); |
203 | 58 | if (len == 0) { |
204 | 3 | ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DATA); |
205 | 3 | return 0; |
206 | 3 | } |
207 | 55 | ctx->tls_aad_pad_sz = len; |
208 | 55 | } |
209 | | |
210 | 23.6k | p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED); |
211 | 23.6k | if (p != NULL) { |
212 | 0 | if (p->data_type != OSSL_PARAM_OCTET_STRING) { |
213 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER); |
214 | 0 | return 0; |
215 | 0 | } |
216 | 0 | if (hw->tls_iv_set_fixed(&ctx->base, p->data, p->data_size) == 0) { |
217 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH); |
218 | 0 | return 0; |
219 | 0 | } |
220 | 0 | } |
221 | | /* ignore OSSL_CIPHER_PARAM_AEAD_MAC_KEY */ |
222 | 23.6k | return 1; |
223 | 23.6k | } |
224 | | |
225 | | static int chacha20_poly1305_einit(void *vctx, const unsigned char *key, |
226 | | size_t keylen, const unsigned char *iv, |
227 | | size_t ivlen, const OSSL_PARAM params[]) |
228 | 3.93k | { |
229 | 3.93k | int ret; |
230 | | |
231 | | /* The generic function checks for ossl_prov_is_running() */ |
232 | 3.93k | ret = ossl_cipher_generic_einit(vctx, key, keylen, iv, ivlen, NULL); |
233 | 3.93k | if (ret && iv != NULL) { |
234 | 2.10k | PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx; |
235 | 2.10k | PROV_CIPHER_HW_CHACHA20_POLY1305 *hw = |
236 | 2.10k | (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw; |
237 | | |
238 | 2.10k | hw->initiv(ctx); |
239 | 2.10k | } |
240 | 3.93k | if (ret && !chacha20_poly1305_set_ctx_params(vctx, params)) |
241 | 0 | ret = 0; |
242 | 3.93k | return ret; |
243 | 3.93k | } |
244 | | |
245 | | static int chacha20_poly1305_dinit(void *vctx, const unsigned char *key, |
246 | | size_t keylen, const unsigned char *iv, |
247 | | size_t ivlen, const OSSL_PARAM params[]) |
248 | 23.1k | { |
249 | 23.1k | int ret; |
250 | | |
251 | | /* The generic function checks for ossl_prov_is_running() */ |
252 | 23.1k | ret = ossl_cipher_generic_dinit(vctx, key, keylen, iv, ivlen, NULL); |
253 | 23.1k | if (ret && iv != NULL) { |
254 | 22.0k | PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx; |
255 | 22.0k | PROV_CIPHER_HW_CHACHA20_POLY1305 *hw = |
256 | 22.0k | (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw; |
257 | | |
258 | 22.0k | hw->initiv(ctx); |
259 | 22.0k | } |
260 | 23.1k | if (ret && !chacha20_poly1305_set_ctx_params(vctx, params)) |
261 | 0 | ret = 0; |
262 | 23.1k | return ret; |
263 | 23.1k | } |
264 | | |
265 | | static int chacha20_poly1305_cipher(void *vctx, unsigned char *out, |
266 | | size_t *outl, size_t outsize, |
267 | | const unsigned char *in, size_t inl) |
268 | 48.2k | { |
269 | 48.2k | PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx; |
270 | 48.2k | PROV_CIPHER_HW_CHACHA20_POLY1305 *hw = |
271 | 48.2k | (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw; |
272 | | |
273 | 48.2k | if (!ossl_prov_is_running()) |
274 | 0 | return 0; |
275 | | |
276 | 48.2k | if (inl == 0) { |
277 | 0 | *outl = 0; |
278 | 0 | return 1; |
279 | 0 | } |
280 | | |
281 | 48.2k | if (outsize < inl) { |
282 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL); |
283 | 0 | return 0; |
284 | 0 | } |
285 | | |
286 | 48.2k | if (!hw->aead_cipher(ctx, out, outl, in, inl)) |
287 | 51 | return 0; |
288 | | |
289 | 48.2k | return 1; |
290 | 48.2k | } |
291 | | |
292 | | static int chacha20_poly1305_final(void *vctx, unsigned char *out, size_t *outl, |
293 | | size_t outsize) |
294 | 24.1k | { |
295 | 24.1k | PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx; |
296 | 24.1k | PROV_CIPHER_HW_CHACHA20_POLY1305 *hw = |
297 | 24.1k | (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw; |
298 | | |
299 | 24.1k | if (!ossl_prov_is_running()) |
300 | 0 | return 0; |
301 | | |
302 | 24.1k | if (hw->aead_cipher(ctx, out, outl, NULL, 0) <= 0) |
303 | 21.8k | return 0; |
304 | | |
305 | 2.27k | *outl = 0; |
306 | 2.27k | return 1; |
307 | 24.1k | } |
308 | | |
309 | | /* ossl_chacha20_ossl_poly1305_functions */ |
310 | | const OSSL_DISPATCH ossl_chacha20_ossl_poly1305_functions[] = { |
311 | | { OSSL_FUNC_CIPHER_NEWCTX, (void (*)(void))chacha20_poly1305_newctx }, |
312 | | { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))chacha20_poly1305_freectx }, |
313 | | { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))chacha20_poly1305_einit }, |
314 | | { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))chacha20_poly1305_dinit }, |
315 | | { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))chacha20_poly1305_update }, |
316 | | { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))chacha20_poly1305_final }, |
317 | | { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))chacha20_poly1305_cipher }, |
318 | | { OSSL_FUNC_CIPHER_GET_PARAMS, |
319 | | (void (*)(void))chacha20_poly1305_get_params }, |
320 | | { OSSL_FUNC_CIPHER_GETTABLE_PARAMS, |
321 | | (void (*)(void))chacha20_poly1305_gettable_params }, |
322 | | { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, |
323 | | (void (*)(void))chacha20_poly1305_get_ctx_params }, |
324 | | { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS, |
325 | | (void (*)(void))chacha20_poly1305_gettable_ctx_params }, |
326 | | { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, |
327 | | (void (*)(void))chacha20_poly1305_set_ctx_params }, |
328 | | { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS, |
329 | | (void (*)(void))chacha20_poly1305_settable_ctx_params }, |
330 | | { 0, NULL } |
331 | | }; |
332 | | |