/src/openssl/providers/implementations/ciphers/cipher_chacha20_poly1305.c
Line | Count | Source |
1 | | /* |
2 | | * Copyright 2019-2025 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 <string.h> |
13 | | #include <openssl/proverr.h> |
14 | | #include "cipher_chacha20_poly1305.h" |
15 | | #include "prov/implementations.h" |
16 | | #include "prov/providercommon.h" |
17 | | #include "providers/implementations/ciphers/cipher_chacha20_poly1305.inc" |
18 | | |
19 | 149k | #define CHACHA20_POLY1305_KEYLEN CHACHA_KEY_SIZE |
20 | 136k | #define CHACHA20_POLY1305_BLKLEN 1 |
21 | 1.48k | #define CHACHA20_POLY1305_MAX_IVLEN 12 |
22 | 9.09k | #define CHACHA20_POLY1305_MODE 0 |
23 | 136k | #define CHACHA20_POLY1305_FLAGS (PROV_CIPHER_FLAG_AEAD \ |
24 | 136k | | PROV_CIPHER_FLAG_CUSTOM_IV) |
25 | | |
26 | | static OSSL_FUNC_cipher_newctx_fn chacha20_poly1305_newctx; |
27 | | static OSSL_FUNC_cipher_freectx_fn chacha20_poly1305_freectx; |
28 | | static OSSL_FUNC_cipher_dupctx_fn chacha20_poly1305_dupctx; |
29 | | static OSSL_FUNC_cipher_encrypt_init_fn chacha20_poly1305_einit; |
30 | | static OSSL_FUNC_cipher_decrypt_init_fn chacha20_poly1305_dinit; |
31 | | static OSSL_FUNC_cipher_get_params_fn chacha20_poly1305_get_params; |
32 | | static OSSL_FUNC_cipher_get_ctx_params_fn chacha20_poly1305_get_ctx_params; |
33 | | static OSSL_FUNC_cipher_set_ctx_params_fn chacha20_poly1305_set_ctx_params; |
34 | | static OSSL_FUNC_cipher_cipher_fn chacha20_poly1305_cipher; |
35 | | static OSSL_FUNC_cipher_final_fn chacha20_poly1305_final; |
36 | | static OSSL_FUNC_cipher_gettable_ctx_params_fn chacha20_poly1305_gettable_ctx_params; |
37 | | static OSSL_FUNC_cipher_settable_ctx_params_fn chacha20_poly1305_settable_ctx_params; |
38 | | #define chacha20_poly1305_gettable_params ossl_cipher_generic_gettable_params |
39 | | |
40 | | static void *chacha20_poly1305_newctx(void *provctx) |
41 | 9.09k | { |
42 | 9.09k | PROV_CHACHA20_POLY1305_CTX *ctx; |
43 | | |
44 | 9.09k | if (!ossl_prov_is_running()) |
45 | 0 | return NULL; |
46 | | |
47 | 9.09k | ctx = OPENSSL_zalloc(sizeof(*ctx)); |
48 | 9.09k | if (ctx != NULL) { |
49 | 9.09k | ossl_cipher_generic_initkey(&ctx->base, CHACHA20_POLY1305_KEYLEN * 8, |
50 | 9.09k | CHACHA20_POLY1305_BLKLEN * 8, |
51 | 9.09k | CHACHA20_POLY1305_IVLEN * 8, |
52 | 9.09k | CHACHA20_POLY1305_MODE, |
53 | 9.09k | CHACHA20_POLY1305_FLAGS, |
54 | 9.09k | ossl_prov_cipher_hw_chacha20_poly1305( |
55 | 9.09k | CHACHA20_POLY1305_KEYLEN * 8), |
56 | 9.09k | NULL); |
57 | 9.09k | ctx->tls_payload_length = NO_TLS_PAYLOAD_LENGTH; |
58 | 9.09k | ossl_chacha20_initctx(&ctx->chacha); |
59 | 9.09k | } |
60 | 9.09k | return ctx; |
61 | 9.09k | } |
62 | | |
63 | | static void *chacha20_poly1305_dupctx(void *provctx) |
64 | 0 | { |
65 | 0 | PROV_CHACHA20_POLY1305_CTX *ctx = provctx; |
66 | 0 | PROV_CHACHA20_POLY1305_CTX *dctx = NULL; |
67 | |
|
68 | 0 | if (ctx == NULL) |
69 | 0 | return NULL; |
70 | 0 | dctx = OPENSSL_memdup(ctx, sizeof(*ctx)); |
71 | 0 | if (dctx != NULL && dctx->base.tlsmac != NULL && dctx->base.alloced) { |
72 | 0 | dctx->base.tlsmac = OPENSSL_memdup(dctx->base.tlsmac, |
73 | 0 | dctx->base.tlsmacsize); |
74 | 0 | if (dctx->base.tlsmac == NULL) { |
75 | 0 | OPENSSL_free(dctx); |
76 | 0 | dctx = NULL; |
77 | 0 | } |
78 | 0 | } |
79 | 0 | return dctx; |
80 | 0 | } |
81 | | |
82 | | static void chacha20_poly1305_freectx(void *vctx) |
83 | 9.09k | { |
84 | 9.09k | PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx; |
85 | | |
86 | 9.09k | if (ctx != NULL) { |
87 | 9.09k | ossl_cipher_generic_reset_ctx((PROV_CIPHER_CTX *)vctx); |
88 | 9.09k | OPENSSL_clear_free(ctx, sizeof(*ctx)); |
89 | 9.09k | } |
90 | 9.09k | } |
91 | | |
92 | | static int chacha20_poly1305_get_params(OSSL_PARAM params[]) |
93 | 127k | { |
94 | 127k | return ossl_cipher_generic_get_params(params, 0, CHACHA20_POLY1305_FLAGS, |
95 | 127k | CHACHA20_POLY1305_KEYLEN * 8, |
96 | 127k | CHACHA20_POLY1305_BLKLEN * 8, |
97 | 127k | CHACHA20_POLY1305_IVLEN * 8); |
98 | 127k | } |
99 | | |
100 | | static int chacha20_poly1305_get_ctx_params(void *vctx, OSSL_PARAM params[]) |
101 | 52.3k | { |
102 | 52.3k | PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx; |
103 | 52.3k | struct chacha20_poly1305_get_ctx_params_st p; |
104 | | |
105 | 52.3k | if (ctx == NULL || !chacha20_poly1305_get_ctx_params_decoder(params, &p)) |
106 | 0 | return 0; |
107 | | |
108 | 52.3k | if (p.ivlen != NULL |
109 | 2.93k | && !OSSL_PARAM_set_size_t(p.ivlen, CHACHA20_POLY1305_IVLEN)) { |
110 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER); |
111 | 0 | return 0; |
112 | 0 | } |
113 | | |
114 | 52.3k | if (p.keylen != NULL |
115 | 3.23k | && !OSSL_PARAM_set_size_t(p.keylen, CHACHA20_POLY1305_KEYLEN)) { |
116 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER); |
117 | 0 | return 0; |
118 | 0 | } |
119 | | |
120 | 52.3k | if (p.taglen != NULL |
121 | 0 | && !OSSL_PARAM_set_size_t(p.taglen, ctx->tag_len)) { |
122 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER); |
123 | 0 | return 0; |
124 | 0 | } |
125 | | |
126 | 52.3k | if (p.pad != NULL |
127 | 2.27k | && !OSSL_PARAM_set_size_t(p.pad, ctx->tls_aad_pad_sz)) { |
128 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER); |
129 | 0 | return 0; |
130 | 0 | } |
131 | | |
132 | 52.3k | if (p.tag != NULL) { |
133 | 43.9k | if (p.tag->data_type != OSSL_PARAM_OCTET_STRING) { |
134 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER); |
135 | 0 | return 0; |
136 | 0 | } |
137 | 43.9k | if (!ctx->base.enc) { |
138 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_TAG_NOT_SET); |
139 | 0 | return 0; |
140 | 0 | } |
141 | 43.9k | if (p.tag->data_size == 0 || p.tag->data_size > POLY1305_BLOCK_SIZE) { |
142 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAG_LENGTH); |
143 | 0 | return 0; |
144 | 0 | } |
145 | 43.9k | memcpy(p.tag->data, ctx->tag, p.tag->data_size); |
146 | 43.9k | } |
147 | 52.3k | return 1; |
148 | 52.3k | } |
149 | | |
150 | | static const OSSL_PARAM *chacha20_poly1305_gettable_ctx_params(ossl_unused void *cctx, ossl_unused void *provctx) |
151 | 66 | { |
152 | 66 | return chacha20_poly1305_get_ctx_params_list; |
153 | 66 | } |
154 | | |
155 | | static const OSSL_PARAM *chacha20_poly1305_settable_ctx_params( |
156 | | ossl_unused void *cctx, ossl_unused void *provctx) |
157 | 18 | { |
158 | 18 | return chacha20_poly1305_set_ctx_params_list; |
159 | 18 | } |
160 | | |
161 | | static int chacha20_poly1305_set_ctx_params(void *vctx, |
162 | | const OSSL_PARAM params[]) |
163 | 102k | { |
164 | 102k | size_t len; |
165 | 102k | PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx; |
166 | 102k | PROV_CIPHER_HW_CHACHA20_POLY1305 *hw = (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->base.hw; |
167 | 102k | struct chacha20_poly1305_set_ctx_params_st p; |
168 | | |
169 | 102k | if (!chacha20_poly1305_set_ctx_params_decoder(params, &p)) |
170 | 0 | return 0; |
171 | | |
172 | 102k | if (p.keylen != NULL) { |
173 | 13 | if (!OSSL_PARAM_get_size_t(p.keylen, &len)) { |
174 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER); |
175 | 0 | return 0; |
176 | 0 | } |
177 | 13 | if (len != CHACHA20_POLY1305_KEYLEN) { |
178 | 6 | ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH); |
179 | 6 | return 0; |
180 | 6 | } |
181 | 13 | } |
182 | | |
183 | 102k | if (p.ivlen != NULL) { |
184 | 1.48k | if (!OSSL_PARAM_get_size_t(p.ivlen, &len)) { |
185 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER); |
186 | 0 | return 0; |
187 | 0 | } |
188 | 1.48k | if (len != CHACHA20_POLY1305_MAX_IVLEN) { |
189 | 2 | ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH); |
190 | 2 | return 0; |
191 | 2 | } |
192 | 1.48k | ctx->iv_state = IV_STATE_UNINITIALISED; |
193 | 1.48k | } |
194 | | |
195 | 102k | if (p.tag != NULL) { |
196 | 25.0k | if (p.tag->data_type != OSSL_PARAM_OCTET_STRING) { |
197 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER); |
198 | 0 | return 0; |
199 | 0 | } |
200 | 25.0k | if (p.tag->data_size == 0 || p.tag->data_size > POLY1305_BLOCK_SIZE) { |
201 | 2 | ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAG_LENGTH); |
202 | 2 | return 0; |
203 | 2 | } |
204 | 25.0k | if (p.tag->data != NULL) { |
205 | 25.0k | if (ctx->base.enc) { |
206 | 3 | ERR_raise(ERR_LIB_PROV, PROV_R_TAG_NOT_NEEDED); |
207 | 3 | return 0; |
208 | 3 | } |
209 | 25.0k | memcpy(ctx->tag, p.tag->data, p.tag->data_size); |
210 | 25.0k | } |
211 | 25.0k | ctx->tag_len = p.tag->data_size; |
212 | 25.0k | } |
213 | | |
214 | 102k | if (p.aad != NULL) { |
215 | 2.29k | if (p.aad->data_type != OSSL_PARAM_OCTET_STRING) { |
216 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER); |
217 | 0 | return 0; |
218 | 0 | } |
219 | 2.29k | len = hw->tls_init(&ctx->base, p.aad->data, p.aad->data_size); |
220 | 2.29k | if (len == 0) { |
221 | 18 | ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DATA); |
222 | 18 | return 0; |
223 | 18 | } |
224 | 2.27k | ctx->tls_aad_pad_sz = len; |
225 | 2.27k | } |
226 | | |
227 | 102k | if (p.fixed != NULL) { |
228 | 0 | if (p.fixed->data_type != OSSL_PARAM_OCTET_STRING) { |
229 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER); |
230 | 0 | return 0; |
231 | 0 | } |
232 | 0 | if (hw->tls_iv_set_fixed(&ctx->base, p.fixed->data, |
233 | 0 | p.fixed->data_size) |
234 | 0 | == 0) { |
235 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH); |
236 | 0 | return 0; |
237 | 0 | } |
238 | 0 | } |
239 | 102k | return 1; |
240 | 102k | } |
241 | | |
242 | | static int chacha20_poly1305_einit(void *vctx, const unsigned char *key, |
243 | | size_t keylen, const unsigned char *iv, |
244 | | size_t ivlen, const OSSL_PARAM params[]) |
245 | 124k | { |
246 | 124k | int ret; |
247 | | |
248 | | /* The generic function checks for ossl_prov_is_running() */ |
249 | 124k | ret = ossl_cipher_generic_einit(vctx, key, keylen, iv, ivlen, NULL); |
250 | 124k | if (ret && iv != NULL) { |
251 | 119k | PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx; |
252 | 119k | PROV_CHACHA20_POLY1305_CTX *cctx = (PROV_CHACHA20_POLY1305_CTX *)vctx; |
253 | 119k | PROV_CIPHER_HW_CHACHA20_POLY1305 *hw = (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw; |
254 | | |
255 | 119k | hw->initiv(ctx); |
256 | 119k | cctx->iv_state = IV_STATE_BUFFERED; |
257 | 119k | } |
258 | 124k | if (ret && !chacha20_poly1305_set_ctx_params(vctx, params)) |
259 | 0 | ret = 0; |
260 | 124k | return ret; |
261 | 124k | } |
262 | | |
263 | | static int chacha20_poly1305_dinit(void *vctx, const unsigned char *key, |
264 | | size_t keylen, const unsigned char *iv, |
265 | | size_t ivlen, const OSSL_PARAM params[]) |
266 | 77.5k | { |
267 | 77.5k | int ret; |
268 | | |
269 | | /* The generic function checks for ossl_prov_is_running() */ |
270 | 77.5k | ret = ossl_cipher_generic_dinit(vctx, key, keylen, iv, ivlen, NULL); |
271 | 77.5k | if (ret && iv != NULL) { |
272 | 74.2k | PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx; |
273 | 74.2k | PROV_CHACHA20_POLY1305_CTX *cctx = (PROV_CHACHA20_POLY1305_CTX *)vctx; |
274 | 74.2k | PROV_CIPHER_HW_CHACHA20_POLY1305 *hw = (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw; |
275 | | |
276 | 74.2k | hw->initiv(ctx); |
277 | 74.2k | cctx->iv_state = IV_STATE_BUFFERED; |
278 | 74.2k | } |
279 | 77.5k | if (ret && !chacha20_poly1305_set_ctx_params(vctx, params)) |
280 | 0 | ret = 0; |
281 | 77.5k | return ret; |
282 | 77.5k | } |
283 | | |
284 | | static int chacha20_poly1305_cipher(void *vctx, unsigned char *out, |
285 | | size_t *outl, size_t outsize, |
286 | | const unsigned char *in, size_t inl) |
287 | 383k | { |
288 | 383k | PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx; |
289 | 383k | PROV_CIPHER_HW_CHACHA20_POLY1305 *hw = (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw; |
290 | | |
291 | 383k | if (!ossl_prov_is_running()) |
292 | 0 | return 0; |
293 | | |
294 | 383k | if (inl == 0) { |
295 | 0 | *outl = 0; |
296 | 0 | return 1; |
297 | 0 | } |
298 | | |
299 | 383k | if (outsize < inl) { |
300 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL); |
301 | 0 | return 0; |
302 | 0 | } |
303 | | |
304 | 383k | if (!hw->aead_cipher(ctx, out, outl, in, inl)) |
305 | 5.58k | return 0; |
306 | | |
307 | 378k | return 1; |
308 | 383k | } |
309 | | |
310 | | static int chacha20_poly1305_update(void *vctx, unsigned char *out, |
311 | | size_t *outl, size_t outsize, |
312 | | const unsigned char *in, size_t inl) |
313 | 90.8k | { |
314 | 90.8k | PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx; |
315 | | |
316 | 90.8k | if (ctx->iv_state == IV_STATE_FINISHED) |
317 | 0 | return 0; |
318 | | |
319 | 90.8k | return chacha20_poly1305_cipher(vctx, out, outl, outsize, in, inl); |
320 | 90.8k | } |
321 | | |
322 | | static int chacha20_poly1305_final(void *vctx, unsigned char *out, size_t *outl, |
323 | | size_t outsize) |
324 | 44.2k | { |
325 | 44.2k | PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx; |
326 | 44.2k | PROV_CIPHER_HW_CHACHA20_POLY1305 *hw = (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->base.hw; |
327 | | |
328 | 44.2k | if (!ossl_prov_is_running()) |
329 | 0 | return 0; |
330 | | |
331 | | /* The tag must be set before actually decrypting data */ |
332 | 44.2k | if (!ctx->base.enc && ctx->tag_len == 0) { |
333 | 0 | ERR_raise(ERR_LIB_PROV, PROV_R_TAG_NOT_SET); |
334 | 0 | return 0; |
335 | 0 | } |
336 | | |
337 | 44.2k | if (hw->aead_cipher((PROV_CIPHER_CTX *)ctx, out, outl, NULL, 0) <= 0) |
338 | 10.4k | return 0; |
339 | | |
340 | 33.8k | *outl = 0; |
341 | | |
342 | | /* Don't reuse the IV */ |
343 | 33.8k | ctx->iv_state = IV_STATE_FINISHED; |
344 | 33.8k | return 1; |
345 | 44.2k | } |
346 | | |
347 | | /* ossl_chacha20_ossl_poly1305_functions */ |
348 | | const OSSL_DISPATCH ossl_chacha20_ossl_poly1305_functions[] = { |
349 | | { OSSL_FUNC_CIPHER_NEWCTX, (void (*)(void))chacha20_poly1305_newctx }, |
350 | | { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))chacha20_poly1305_freectx }, |
351 | | { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void))chacha20_poly1305_dupctx }, |
352 | | { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))chacha20_poly1305_einit }, |
353 | | { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))chacha20_poly1305_dinit }, |
354 | | { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))chacha20_poly1305_update }, |
355 | | { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))chacha20_poly1305_final }, |
356 | | { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))chacha20_poly1305_cipher }, |
357 | | { OSSL_FUNC_CIPHER_GET_PARAMS, |
358 | | (void (*)(void))chacha20_poly1305_get_params }, |
359 | | { OSSL_FUNC_CIPHER_GETTABLE_PARAMS, |
360 | | (void (*)(void))chacha20_poly1305_gettable_params }, |
361 | | { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, |
362 | | (void (*)(void))chacha20_poly1305_get_ctx_params }, |
363 | | { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS, |
364 | | (void (*)(void))chacha20_poly1305_gettable_ctx_params }, |
365 | | { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, |
366 | | (void (*)(void))chacha20_poly1305_set_ctx_params }, |
367 | | { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS, |
368 | | (void (*)(void))chacha20_poly1305_settable_ctx_params }, |
369 | | OSSL_DISPATCH_END |
370 | | }; |