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