2 * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
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
11 * Generic dispatch table functions for ciphers.
14 /* For SSL3_VERSION */
15 #include <openssl/ssl.h>
16 #include "ciphercommon_local.h"
17 #include "prov/provider_ctx.h"
18 #include "prov/providercommon.h"
19 #include "prov/providercommonerr.h"
22 * Generic cipher functions for OSSL_PARAM gettables and settables
24 static const OSSL_PARAM cipher_known_gettable_params[] = {
25 OSSL_PARAM_uint(OSSL_CIPHER_PARAM_MODE, NULL),
26 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
27 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
28 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_BLOCK_SIZE, NULL),
29 OSSL_PARAM_ulong(OSSL_CIPHER_PARAM_FLAGS, NULL),
30 { OSSL_CIPHER_PARAM_TLS_MAC, OSSL_PARAM_OCTET_PTR, NULL, 0, OSSL_PARAM_UNMODIFIED },
33 const OSSL_PARAM *cipher_generic_gettable_params(void *provctx)
35 return cipher_known_gettable_params;
38 int cipher_generic_get_params(OSSL_PARAM params[], unsigned int md,
40 size_t kbits, size_t blkbits, size_t ivbits)
44 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_MODE);
45 if (p != NULL && !OSSL_PARAM_set_uint(p, md)) {
46 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
49 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_FLAGS);
50 if (p != NULL && !OSSL_PARAM_set_ulong(p, flags)) {
51 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
54 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
55 if (p != NULL && !OSSL_PARAM_set_size_t(p, kbits / 8)) {
56 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
59 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_BLOCK_SIZE);
60 if (p != NULL && !OSSL_PARAM_set_size_t(p, blkbits / 8)) {
61 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
64 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
65 if (p != NULL && !OSSL_PARAM_set_size_t(p, ivbits / 8)) {
66 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
72 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_START(cipher_generic)
73 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_END(cipher_generic)
75 CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_START(cipher_generic)
76 OSSL_PARAM_uint(OSSL_CIPHER_PARAM_TLS_VERSION, NULL),
77 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_TLS_MAC_SIZE, NULL),
78 CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_END(cipher_generic)
81 * Variable key length cipher functions for OSSL_PARAM settables
84 int cipher_var_keylen_set_ctx_params(void *vctx, const OSSL_PARAM params[])
86 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
89 if (!cipher_generic_set_ctx_params(vctx, params))
91 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_KEYLEN);
95 if (!OSSL_PARAM_get_size_t(p, &keylen)) {
96 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
104 CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_START(cipher_var_keylen)
105 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
106 CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_END(cipher_var_keylen)
109 * AEAD cipher functions for OSSL_PARAM gettables and settables
111 static const OSSL_PARAM cipher_aead_known_gettable_ctx_params[] = {
112 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
113 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
114 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN, NULL),
115 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_IV, NULL, 0),
116 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_IV_STATE, NULL, 0),
117 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
118 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD, NULL),
119 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN, NULL, 0),
122 const OSSL_PARAM *cipher_aead_gettable_ctx_params(ossl_unused void *provctx)
124 return cipher_aead_known_gettable_ctx_params;
127 static const OSSL_PARAM cipher_aead_known_settable_ctx_params[] = {
128 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_IVLEN, NULL),
129 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
130 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD, NULL, 0),
131 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED, NULL, 0),
132 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV, NULL, 0),
135 const OSSL_PARAM *cipher_aead_settable_ctx_params(ossl_unused void *provctx)
137 return cipher_aead_known_settable_ctx_params;
140 void cipher_generic_reset_ctx(PROV_CIPHER_CTX *ctx)
142 if (ctx != NULL && ctx->alloced) {
143 OPENSSL_free(ctx->tlsmac);
149 static int cipher_generic_init_internal(PROV_CIPHER_CTX *ctx,
150 const unsigned char *key, size_t keylen,
151 const unsigned char *iv, size_t ivlen,
157 ctx->enc = enc ? 1 : 0;
159 if (!ossl_prov_is_running())
162 if (iv != NULL && ctx->mode != EVP_CIPH_ECB_MODE) {
163 if (!cipher_generic_initiv(ctx, iv, ivlen))
167 if ((ctx->flags & EVP_CIPH_VARIABLE_LENGTH) == 0) {
168 if (keylen != ctx->keylen) {
169 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEYLEN);
173 ctx->keylen = keylen;
175 return ctx->hw->init(ctx, key, ctx->keylen);
180 int cipher_generic_einit(void *vctx, const unsigned char *key, size_t keylen,
181 const unsigned char *iv, size_t ivlen)
183 return cipher_generic_init_internal((PROV_CIPHER_CTX *)vctx, key, keylen,
187 int cipher_generic_dinit(void *vctx, const unsigned char *key, size_t keylen,
188 const unsigned char *iv, size_t ivlen)
190 return cipher_generic_init_internal((PROV_CIPHER_CTX *)vctx, key, keylen,
194 /* Max padding including padding length byte */
195 #define MAX_PADDING 256
197 int cipher_generic_block_update(void *vctx, unsigned char *out, size_t *outl,
198 size_t outsize, const unsigned char *in,
202 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
203 size_t blksz = ctx->blocksize;
206 if (ctx->tlsversion > 0) {
208 * Each update call corresponds to a TLS record and is individually
212 /* Sanity check inputs */
217 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
222 unsigned char padval;
227 padnum = blksz - (inl % blksz);
229 if (outsize < inl + padnum) {
230 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
234 if (padnum > MAX_PADDING) {
235 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
238 padval = (unsigned char)(padnum - 1);
239 if (ctx->tlsversion == SSL3_VERSION) {
241 memset(out + inl, 0, padnum - 1);
242 *(out + inl + padnum - 1) = padval;
244 /* we need to add 'padnum' padding bytes of value padval */
245 for (loop = inl; loop < inl + padnum; loop++)
251 if ((inl % blksz) != 0) {
252 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
257 /* Shouldn't normally fail */
258 if (!ctx->hw->cipher(ctx, out, in, inl)) {
259 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
264 OPENSSL_free(ctx->tlsmac);
269 /* This only fails if padding is publicly invalid */
272 && !tlsunpadblock(ctx->libctx, ctx->tlsversion, out, outl,
273 blksz, &ctx->tlsmac, &ctx->alloced,
274 ctx->tlsmacsize, 0)) {
275 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
282 nextblocks = fillblock(ctx->buf, &ctx->bufsz, blksz, &in, &inl);
284 nextblocks = inl & ~(blksz-1);
287 * If we're decrypting and we end an update on a block boundary we hold
288 * the last block back in case this is the last update call and the last
291 if (ctx->bufsz == blksz && (ctx->enc || inl > 0 || !ctx->pad)) {
292 if (outsize < blksz) {
293 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
296 if (!ctx->hw->cipher(ctx, out, ctx->buf, blksz)) {
297 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
304 if (nextblocks > 0) {
305 if (!ctx->enc && ctx->pad && nextblocks == inl) {
306 if (!ossl_assert(inl >= blksz)) {
307 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
312 outlint += nextblocks;
313 if (outsize < outlint) {
314 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
318 if (nextblocks > 0) {
319 if (!ctx->hw->cipher(ctx, out, in, nextblocks)) {
320 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
326 if (inl != 0 && !trailingdata(ctx->buf, &ctx->bufsz, blksz, &in, &inl)) {
327 /* ERR_raise already called */
335 int cipher_generic_block_final(void *vctx, unsigned char *out, size_t *outl,
338 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
339 size_t blksz = ctx->blocksize;
341 if (!ossl_prov_is_running())
344 if (ctx->tlsversion > 0) {
345 /* We never finalize TLS, so this is an error */
346 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
352 padblock(ctx->buf, &ctx->bufsz, blksz);
353 } else if (ctx->bufsz == 0) {
356 } else if (ctx->bufsz != blksz) {
357 ERR_raise(ERR_LIB_PROV, PROV_R_WRONG_FINAL_BLOCK_LENGTH);
361 if (outsize < blksz) {
362 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
365 if (!ctx->hw->cipher(ctx, out, ctx->buf, blksz)) {
366 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
375 if (ctx->bufsz != blksz) {
376 if (ctx->bufsz == 0 && !ctx->pad) {
380 ERR_raise(ERR_LIB_PROV, PROV_R_WRONG_FINAL_BLOCK_LENGTH);
384 if (!ctx->hw->cipher(ctx, ctx->buf, ctx->buf, blksz)) {
385 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
389 if (ctx->pad && !unpadblock(ctx->buf, &ctx->bufsz, blksz)) {
390 /* ERR_raise already called */
394 if (outsize < ctx->bufsz) {
395 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
398 memcpy(out, ctx->buf, ctx->bufsz);
404 int cipher_generic_stream_update(void *vctx, unsigned char *out, size_t *outl,
405 size_t outsize, const unsigned char *in,
408 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
416 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
420 if (!ctx->hw->cipher(ctx, out, in, inl)) {
421 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
427 * Remove any TLS padding. Only used by cipher_aes_cbc_hmac_sha1_hw.c and
428 * cipher_aes_cbc_hmac_sha256_hw.c
430 if (!ctx->enc && ctx->removetlspad > 0) {
431 /* The actual padding length */
432 *outl -= out[inl - 1] + 1;
434 /* MAC and explicit IV */
435 *outl -= ctx->removetlspad;
440 int cipher_generic_stream_final(void *vctx, unsigned char *out, size_t *outl,
443 if (!ossl_prov_is_running())
450 int cipher_generic_cipher(void *vctx,
451 unsigned char *out, size_t *outl, size_t outsize,
452 const unsigned char *in, size_t inl)
454 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
456 if (!ossl_prov_is_running())
460 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
464 if (!ctx->hw->cipher(ctx, out, in, inl)) {
465 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
473 int cipher_generic_get_ctx_params(void *vctx, OSSL_PARAM params[])
475 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
478 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
479 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->ivlen)) {
480 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
483 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_PADDING);
484 if (p != NULL && !OSSL_PARAM_set_uint(p, ctx->pad)) {
485 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
488 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IV);
490 && !OSSL_PARAM_set_octet_ptr(p, &ctx->oiv, ctx->ivlen)
491 && !OSSL_PARAM_set_octet_string(p, &ctx->oiv, ctx->ivlen)) {
492 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
495 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IV_STATE);
497 && !OSSL_PARAM_set_octet_ptr(p, &ctx->iv, ctx->ivlen)
498 && !OSSL_PARAM_set_octet_string(p, &ctx->iv, ctx->ivlen)) {
499 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
502 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_NUM);
503 if (p != NULL && !OSSL_PARAM_set_uint(p, ctx->num)) {
504 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
507 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
508 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->keylen)) {
509 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
512 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_TLS_MAC);
514 && !OSSL_PARAM_set_octet_ptr(p, ctx->tlsmac, ctx->tlsmacsize)) {
515 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
521 int cipher_generic_set_ctx_params(void *vctx, const OSSL_PARAM params[])
523 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
526 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_PADDING);
530 if (!OSSL_PARAM_get_uint(p, &pad)) {
531 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
534 ctx->pad = pad ? 1 : 0;
536 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_TLS_VERSION);
538 if (!OSSL_PARAM_get_uint(p, &ctx->tlsversion)) {
539 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
543 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_TLS_MAC_SIZE);
545 if (!OSSL_PARAM_get_size_t(p, &ctx->tlsmacsize)) {
546 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
550 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_NUM);
554 if (!OSSL_PARAM_get_uint(p, &num)) {
555 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
563 int cipher_generic_initiv(PROV_CIPHER_CTX *ctx, const unsigned char *iv,
566 if (ivlen != ctx->ivlen
567 || ivlen > sizeof(ctx->iv)) {
568 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IVLEN);
572 memcpy(ctx->iv, iv, ivlen);
573 memcpy(ctx->oiv, iv, ivlen);
577 void cipher_generic_initkey(void *vctx, size_t kbits, size_t blkbits,
578 size_t ivbits, unsigned int mode, uint64_t flags,
579 const PROV_CIPHER_HW *hw, void *provctx)
581 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
585 ctx->keylen = ((kbits) / 8);
586 ctx->ivlen = ((ivbits) / 8);
589 ctx->blocksize = blkbits / 8;
591 ctx->libctx = PROV_LIBRARY_CONTEXT_OF(provctx); /* used for rand */