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 #include "ciphercommon_local.h"
15 #include "prov/provider_ctx.h"
16 #include "prov/providercommonerr.h"
19 * Generic cipher functions for OSSL_PARAM gettables and settables
21 static const OSSL_PARAM cipher_known_gettable_params[] = {
22 OSSL_PARAM_uint(OSSL_CIPHER_PARAM_MODE, NULL),
23 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
24 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
25 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_BLOCK_SIZE, NULL),
26 OSSL_PARAM_ulong(OSSL_CIPHER_PARAM_FLAGS, NULL),
27 { OSSL_CIPHER_PARAM_TLS_MAC, OSSL_PARAM_OCTET_PTR, NULL, 0, OSSL_PARAM_UNMODIFIED },
30 const OSSL_PARAM *cipher_generic_gettable_params(void)
32 return cipher_known_gettable_params;
35 int cipher_generic_get_params(OSSL_PARAM params[], unsigned int md,
37 size_t kbits, size_t blkbits, size_t ivbits)
41 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_MODE);
42 if (p != NULL && !OSSL_PARAM_set_uint(p, md)) {
43 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
46 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_FLAGS);
47 if (p != NULL && !OSSL_PARAM_set_ulong(p, flags)) {
48 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
51 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
52 if (p != NULL && !OSSL_PARAM_set_size_t(p, kbits / 8)) {
53 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
56 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_BLOCK_SIZE);
57 if (p != NULL && !OSSL_PARAM_set_size_t(p, blkbits / 8)) {
58 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
61 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
62 if (p != NULL && !OSSL_PARAM_set_size_t(p, ivbits / 8)) {
63 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
69 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_START(cipher_generic)
70 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_END(cipher_generic)
72 CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_START(cipher_generic)
73 OSSL_PARAM_uint(OSSL_CIPHER_PARAM_TLS_VERSION, NULL),
74 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_TLS_MAC_SIZE, NULL),
75 CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_END(cipher_generic)
78 * Variable key length cipher functions for OSSL_PARAM settables
81 int cipher_var_keylen_set_ctx_params(void *vctx, const OSSL_PARAM params[])
83 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
86 if (!cipher_generic_set_ctx_params(vctx, params))
88 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_KEYLEN);
92 if (!OSSL_PARAM_get_size_t(p, &keylen)) {
93 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
101 CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_START(cipher_var_keylen)
102 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
103 CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_END(cipher_var_keylen)
106 * AEAD cipher functions for OSSL_PARAM gettables and settables
108 static const OSSL_PARAM cipher_aead_known_gettable_ctx_params[] = {
109 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
110 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
111 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN, NULL),
112 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_IV, NULL, 0),
113 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
114 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD, NULL),
115 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN, NULL, 0),
118 const OSSL_PARAM *cipher_aead_gettable_ctx_params(void)
120 return cipher_aead_known_gettable_ctx_params;
123 static const OSSL_PARAM cipher_aead_known_settable_ctx_params[] = {
124 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_IVLEN, NULL),
125 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
126 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD, NULL, 0),
127 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED, NULL, 0),
128 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV, NULL, 0),
131 const OSSL_PARAM *cipher_aead_settable_ctx_params(void)
133 return cipher_aead_known_settable_ctx_params;
136 static int cipher_generic_init_internal(PROV_CIPHER_CTX *ctx,
137 const unsigned char *key, size_t keylen,
138 const unsigned char *iv, size_t ivlen,
141 ctx->enc = enc ? 1 : 0;
143 if (iv != NULL && ctx->mode != EVP_CIPH_ECB_MODE) {
144 if (!cipher_generic_initiv(ctx, iv, ivlen))
148 if ((ctx->flags & EVP_CIPH_VARIABLE_LENGTH) == 0) {
149 if (keylen != ctx->keylen) {
150 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEYLEN);
154 ctx->keylen = keylen;
156 return ctx->hw->init(ctx, key, ctx->keylen);
161 int cipher_generic_einit(void *vctx, const unsigned char *key, size_t keylen,
162 const unsigned char *iv, size_t ivlen)
164 return cipher_generic_init_internal((PROV_CIPHER_CTX *)vctx, key, keylen,
168 int cipher_generic_dinit(void *vctx, const unsigned char *key, size_t keylen,
169 const unsigned char *iv, size_t ivlen)
171 return cipher_generic_init_internal((PROV_CIPHER_CTX *)vctx, key, keylen,
175 int cipher_generic_block_update(void *vctx, unsigned char *out, size_t *outl,
176 size_t outsize, const unsigned char *in,
180 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
181 size_t blksz = ctx->blocksize;
184 if (ctx->tlsversion > 0) {
186 * Each update call corresponds to a TLS record and is individually
190 /* Sanity check inputs */
192 || (inl % blksz) != 0
196 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
200 /* Shouldn't normally fail */
201 if (!ctx->hw->cipher(ctx, out, in, inl)) {
202 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
206 /* This only fails if padding is publicly invalid */
207 /* TODO(3.0): FIX ME FIX ME - Figure out aead */
210 && !tlsunpadblock(ctx->libctx, ctx->tlsversion, out, outl,
211 blksz, &ctx->tlsmac, &ctx->alloced,
212 ctx->tlsmacsize, 0)) {
213 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
220 nextblocks = fillblock(ctx->buf, &ctx->bufsz, blksz, &in, &inl);
222 nextblocks = inl & ~(blksz-1);
225 * If we're decrypting and we end an update on a block boundary we hold
226 * the last block back in case this is the last update call and the last
229 if (ctx->bufsz == blksz && (ctx->enc || inl > 0 || !ctx->pad)) {
230 if (outsize < blksz) {
231 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
234 if (!ctx->hw->cipher(ctx, out, ctx->buf, blksz)) {
235 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
242 if (nextblocks > 0) {
243 if (!ctx->enc && ctx->pad && nextblocks == inl) {
244 if (!ossl_assert(inl >= blksz)) {
245 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
250 outlint += nextblocks;
251 if (outsize < outlint) {
252 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
256 if (nextblocks > 0) {
257 if (!ctx->hw->cipher(ctx, out, in, nextblocks)) {
258 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
264 if (inl != 0 && !trailingdata(ctx->buf, &ctx->bufsz, blksz, &in, &inl)) {
265 /* ERR_raise already called */
273 int cipher_generic_block_final(void *vctx, unsigned char *out, size_t *outl,
276 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
277 size_t blksz = ctx->blocksize;
279 if (ctx->tlsversion > 0) {
280 /* We never finalize TLS, so this is an error */
281 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
287 padblock(ctx->buf, &ctx->bufsz, blksz);
288 } else if (ctx->bufsz == 0) {
291 } else if (ctx->bufsz != blksz) {
292 ERR_raise(ERR_LIB_PROV, PROV_R_WRONG_FINAL_BLOCK_LENGTH);
296 if (outsize < blksz) {
297 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
300 if (!ctx->hw->cipher(ctx, out, ctx->buf, blksz)) {
301 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
310 if (ctx->bufsz != blksz) {
311 if (ctx->bufsz == 0 && !ctx->pad) {
315 ERR_raise(ERR_LIB_PROV, PROV_R_WRONG_FINAL_BLOCK_LENGTH);
319 if (!ctx->hw->cipher(ctx, ctx->buf, ctx->buf, blksz)) {
320 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
324 if (ctx->pad && !unpadblock(ctx->buf, &ctx->bufsz, blksz)) {
325 /* ERR_raise already called */
329 if (outsize < ctx->bufsz) {
330 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
333 memcpy(out, ctx->buf, ctx->bufsz);
339 int cipher_generic_stream_update(void *vctx, unsigned char *out, size_t *outl,
340 size_t outsize, const unsigned char *in,
343 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
351 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
355 if (!ctx->hw->cipher(ctx, out, in, inl)) {
356 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
362 * Remove any TLS padding. Only used by cipher_aes_cbc_hmac_sha1_hw.c and
363 * cipher_aes_cbc_hmac_sha256_hw.c
365 if (!ctx->enc && ctx->removetlspad > 0) {
366 /* The actual padding length */
367 *outl -= out[inl - 1] + 1;
369 /* MAC and explicit IV */
370 *outl -= ctx->removetlspad;
375 int cipher_generic_stream_final(void *vctx, unsigned char *out, size_t *outl,
382 int cipher_generic_cipher(void *vctx,
383 unsigned char *out, size_t *outl, size_t outsize,
384 const unsigned char *in, size_t inl)
386 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
389 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
393 if (!ctx->hw->cipher(ctx, out, in, inl)) {
394 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
402 int cipher_generic_get_ctx_params(void *vctx, OSSL_PARAM params[])
404 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
407 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
408 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->ivlen)) {
409 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
412 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_PADDING);
413 if (p != NULL && !OSSL_PARAM_set_uint(p, ctx->pad)) {
414 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
417 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IV);
419 && !OSSL_PARAM_set_octet_ptr(p, &ctx->oiv, ctx->ivlen)
420 && !OSSL_PARAM_set_octet_string(p, &ctx->oiv, ctx->ivlen)) {
421 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
424 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_NUM);
425 if (p != NULL && !OSSL_PARAM_set_uint(p, ctx->num)) {
426 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
429 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
430 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->keylen)) {
431 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
434 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_TLS_MAC);
436 && !OSSL_PARAM_set_octet_ptr(p, ctx->tlsmac, ctx->tlsmacsize)) {
437 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
443 int cipher_generic_set_ctx_params(void *vctx, const OSSL_PARAM params[])
445 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
448 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_PADDING);
452 if (!OSSL_PARAM_get_uint(p, &pad)) {
453 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
456 ctx->pad = pad ? 1 : 0;
458 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_TLS_VERSION);
460 if (!OSSL_PARAM_get_uint(p, &ctx->tlsversion)) {
461 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
465 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_TLS_MAC_SIZE);
467 if (!OSSL_PARAM_get_size_t(p, &ctx->tlsmacsize)) {
468 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
472 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_NUM);
476 if (!OSSL_PARAM_get_uint(p, &num)) {
477 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
485 int cipher_generic_initiv(PROV_CIPHER_CTX *ctx, const unsigned char *iv,
488 if (ivlen != ctx->ivlen
489 || ivlen > sizeof(ctx->iv)) {
490 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IVLEN);
494 memcpy(ctx->iv, iv, ivlen);
495 memcpy(ctx->oiv, iv, ivlen);
499 void cipher_generic_initkey(void *vctx, size_t kbits, size_t blkbits,
500 size_t ivbits, unsigned int mode, uint64_t flags,
501 const PROV_CIPHER_HW *hw, void *provctx)
503 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
507 ctx->keylen = ((kbits) / 8);
508 ctx->ivlen = ((ivbits) / 8);
511 ctx->blocksize = blkbits / 8;
513 ctx->libctx = PROV_LIBRARY_CONTEXT_OF(provctx); /* used for rand */