2 * Copyright 2019 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 "cipher_local.h"
15 #include "internal/provider_ctx.h"
16 #include "internal/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),
29 const OSSL_PARAM *cipher_generic_gettable_params(void)
31 return cipher_known_gettable_params;
34 int cipher_generic_get_params(OSSL_PARAM params[], unsigned int md,
36 size_t kbits, size_t blkbits, size_t ivbits)
40 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_MODE);
41 if (p != NULL && !OSSL_PARAM_set_uint(p, md)) {
42 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
45 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_FLAGS);
46 if (p != NULL && !OSSL_PARAM_set_ulong(p, flags)) {
47 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
50 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
51 if (p != NULL && !OSSL_PARAM_set_size_t(p, kbits / 8)) {
52 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
55 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_BLOCK_SIZE);
56 if (p != NULL && !OSSL_PARAM_set_size_t(p, blkbits / 8)) {
57 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
60 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
61 if (p != NULL && !OSSL_PARAM_set_size_t(p, ivbits / 8)) {
62 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
68 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_START(cipher_generic)
69 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_END(cipher_generic)
71 CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_START(cipher_generic)
72 CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_END(cipher_generic)
75 * AEAD cipher functions for OSSL_PARAM gettables and settables
77 static const OSSL_PARAM cipher_aead_known_gettable_ctx_params[] = {
78 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
79 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
80 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN, NULL),
81 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_IV, NULL, 0),
82 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
83 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD, NULL),
86 const OSSL_PARAM *cipher_aead_gettable_ctx_params(void)
88 return cipher_aead_known_gettable_ctx_params;
91 static const OSSL_PARAM cipher_aead_known_settable_ctx_params[] = {
92 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
93 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_IVLEN, NULL),
94 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
95 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD, NULL, 0),
96 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED, NULL, 0),
99 const OSSL_PARAM *cipher_aead_settable_ctx_params(void)
101 return cipher_aead_known_settable_ctx_params;
104 static int cipher_generic_init_internal(PROV_CIPHER_CTX *ctx,
105 const unsigned char *key, size_t keylen,
106 const unsigned char *iv, size_t ivlen,
109 ctx->enc = enc ? 1 : 0;
111 if (iv != NULL && ctx->mode != EVP_CIPH_ECB_MODE) {
112 if (ivlen != ctx->ivlen) {
113 ERR_raise(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR);
116 memcpy(ctx->iv, iv, ctx->ivlen);
119 if ((ctx->flags & EVP_CIPH_VARIABLE_LENGTH) == 0) {
120 if (keylen != ctx->keylen) {
121 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEYLEN);
125 ctx->keylen = keylen;
127 return ctx->hw->init(ctx, key, ctx->keylen);
132 int cipher_generic_einit(void *vctx, const unsigned char *key, size_t keylen,
133 const unsigned char *iv, size_t ivlen)
135 return cipher_generic_init_internal((PROV_CIPHER_CTX *)vctx, key, keylen,
139 int cipher_generic_dinit(void *vctx, const unsigned char *key, size_t keylen,
140 const unsigned char *iv, size_t ivlen)
142 return cipher_generic_init_internal((PROV_CIPHER_CTX *)vctx, key, keylen,
146 int cipher_generic_block_update(void *vctx, unsigned char *out, size_t *outl,
147 size_t outsize, const unsigned char *in,
151 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
152 size_t blksz = ctx->blocksize;
153 size_t nextblocks = fillblock(ctx->buf, &ctx->bufsz, blksz, &in, &inl);
156 * If we're decrypting and we end an update on a block boundary we hold
157 * the last block back in case this is the last update call and the last
160 if (ctx->bufsz == blksz && (ctx->enc || inl > 0 || !ctx->pad)) {
161 if (outsize < blksz) {
162 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
165 if (!ctx->hw->cipher(ctx, out, ctx->buf, blksz)) {
166 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
173 if (nextblocks > 0) {
174 if (!ctx->enc && ctx->pad && nextblocks == inl) {
175 if (!ossl_assert(inl >= blksz)) {
176 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
181 outlint += nextblocks;
182 if (outsize < outlint) {
183 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
186 if (!ctx->hw->cipher(ctx, out, in, nextblocks)) {
187 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
193 if (!trailingdata(ctx->buf, &ctx->bufsz, blksz, &in, &inl)) {
194 /* ERR_raise already called */
202 int cipher_generic_block_final(void *vctx, unsigned char *out, size_t *outl,
205 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
206 size_t blksz = ctx->blocksize;
210 padblock(ctx->buf, &ctx->bufsz, blksz);
211 } else if (ctx->bufsz == 0) {
214 } else if (ctx->bufsz != blksz) {
215 ERR_raise(ERR_LIB_PROV, PROV_R_WRONG_FINAL_BLOCK_LENGTH);
219 if (outsize < blksz) {
220 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
223 if (!ctx->hw->cipher(ctx, out, ctx->buf, blksz)) {
224 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
233 if (ctx->bufsz != blksz) {
234 if (ctx->bufsz == 0 && !ctx->pad) {
238 ERR_raise(ERR_LIB_PROV, PROV_R_WRONG_FINAL_BLOCK_LENGTH);
242 if (!ctx->hw->cipher(ctx, ctx->buf, ctx->buf, blksz)) {
243 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
247 if (ctx->pad && !unpadblock(ctx->buf, &ctx->bufsz, blksz)) {
248 /* ERR_raise already called */
252 if (outsize < ctx->bufsz) {
253 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
256 memcpy(out, ctx->buf, ctx->bufsz);
262 int cipher_generic_stream_update(void *vctx, unsigned char *out, size_t *outl,
263 size_t outsize, const unsigned char *in,
266 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
269 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
273 if (!ctx->hw->cipher(ctx, out, in, inl)) {
274 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
281 int cipher_generic_stream_final(void *vctx, unsigned char *out, size_t *outl,
288 int cipher_generic_cipher(void *vctx,
289 unsigned char *out, size_t *outl, size_t outsize,
290 const unsigned char *in, size_t inl)
292 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
295 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
299 if (!ctx->hw->cipher(ctx, out, in, inl)) {
300 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
308 int cipher_generic_get_ctx_params(void *vctx, OSSL_PARAM params[])
310 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
313 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
314 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->ivlen)) {
315 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
318 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_PADDING);
319 if (p != NULL && !OSSL_PARAM_set_uint(p, ctx->pad)) {
320 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
323 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IV);
325 && !OSSL_PARAM_set_octet_ptr(p, &ctx->iv, ctx->ivlen)
326 && !OSSL_PARAM_set_octet_string(p, &ctx->iv, ctx->ivlen)) {
327 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
330 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_NUM);
331 if (p != NULL && !OSSL_PARAM_set_uint(p, ctx->num)) {
332 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
335 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
336 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->keylen)) {
337 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
344 int cipher_generic_set_ctx_params(void *vctx, const OSSL_PARAM params[])
346 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
349 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_PADDING);
353 if (!OSSL_PARAM_get_uint(p, &pad)) {
354 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
357 ctx->pad = pad ? 1 : 0;
359 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_NUM);
363 if (!OSSL_PARAM_get_uint(p, &num)) {
364 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
369 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_KEYLEN);
373 if (!OSSL_PARAM_get_size_t(p, &keylen)) {
374 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
377 ctx->keylen = keylen;
382 void cipher_generic_initkey(void *vctx, size_t kbits, size_t blkbits,
383 size_t ivbits, unsigned int mode, uint64_t flags,
384 const PROV_CIPHER_HW *hw, void *provctx)
386 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
390 ctx->keylen = ((kbits) / 8);
391 ctx->ivlen = ((ivbits) / 8);
394 ctx->blocksize = blkbits / 8;
396 ctx->libctx = PROV_LIBRARY_CONTEXT_OF(provctx); /* used for rand */