2 * Copyright 2019-2023 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
10 #ifndef OSSL_PROV_CIPHERCOMMON_H
11 # define OSSL_PROV_CIPHERCOMMON_H
14 # include <openssl/params.h>
15 # include <openssl/core_dispatch.h>
16 # include <openssl/core_names.h>
17 # include <openssl/evp.h>
18 # include "internal/cryptlib.h"
19 # include "crypto/modes.h"
21 # define MAXCHUNK ((size_t)1 << 30)
22 # define MAXBITCHUNK ((size_t)1 << (sizeof(size_t) * 8 - 4))
24 # define GENERIC_BLOCK_SIZE 16
25 # define IV_STATE_UNINITIALISED 0 /* initial state is not initialized */
26 # define IV_STATE_BUFFERED 1 /* iv has been copied to the iv buffer */
27 # define IV_STATE_COPIED 2 /* iv has been copied from the iv buffer */
28 # define IV_STATE_FINISHED 3 /* the iv has been used - so don't reuse it */
30 # define PROV_CIPHER_FUNC(type, name, args) typedef type (* OSSL_##name##_fn)args
32 typedef struct prov_cipher_hw_st PROV_CIPHER_HW
;
33 typedef struct prov_cipher_ctx_st PROV_CIPHER_CTX
;
35 typedef int (PROV_CIPHER_HW_FN
)(PROV_CIPHER_CTX
*dat
, unsigned char *out
,
36 const unsigned char *in
, size_t len
);
38 /* Internal flags that can be queried */
39 # define PROV_CIPHER_FLAG_AEAD 0x0001
40 # define PROV_CIPHER_FLAG_CUSTOM_IV 0x0002
41 # define PROV_CIPHER_FLAG_CTS 0x0004
42 # define PROV_CIPHER_FLAG_TLS1_MULTIBLOCK 0x0008
43 # define PROV_CIPHER_FLAG_RAND_KEY 0x0010
44 /* Internal flags that are only used within the provider */
45 # define PROV_CIPHER_FLAG_VARIABLE_LENGTH 0x0100
46 # define PROV_CIPHER_FLAG_INVERSE_CIPHER 0x0200
48 struct prov_cipher_ctx_st
{
49 /* place buffer at the beginning for memory alignment */
50 /* The original value of the iv */
51 unsigned char oiv
[GENERIC_BLOCK_SIZE
];
52 /* Buffer of partial blocks processed via update calls */
53 unsigned char buf
[GENERIC_BLOCK_SIZE
];
54 unsigned char iv
[GENERIC_BLOCK_SIZE
];
64 size_t keylen
; /* key size (in bytes) */
67 size_t bufsz
; /* Number of bytes in buf */
68 unsigned int cts_mode
; /* Use to set the type for CTS modes */
69 unsigned int pad
: 1; /* Whether padding should be used or not */
70 unsigned int enc
: 1; /* Set to 1 for encrypt, or 0 otherwise */
71 unsigned int iv_set
: 1; /* Set when the iv is copied to the iv/oiv buffers */
72 unsigned int key_set
: 1; /* Set when key is set on the context */
73 unsigned int updated
: 1; /* Set to 1 during update for one shot ciphers */
74 unsigned int variable_keylength
: 1;
75 unsigned int inverse_cipher
: 1; /* set to 1 to use inverse cipher */
76 unsigned int use_bits
: 1; /* Set to 0 for cfb1 to use bits instead of bytes */
78 unsigned int tlsversion
; /* If TLS padding is in use the TLS version number */
79 unsigned char *tlsmac
; /* tls MAC extracted from the last record */
81 * Whether the tlsmac data has been allocated or
82 * points into the user buffer.
84 size_t tlsmacsize
; /* Size of the TLS MAC */
85 int removetlspad
; /* Whether TLS padding should be removed or not */
86 size_t removetlsfixed
; /*
87 * Length of the fixed size data to remove when
88 * processing TLS data (equals mac size plus
89 * IV size if applicable)
93 * num contains the number of bytes of |iv| which are valid for modes that
94 * manage partial blocks themselves.
97 const PROV_CIPHER_HW
*hw
; /* hardware specific functions */
98 const void *ks
; /* Pointer to algorithm specific key data */
102 struct prov_cipher_hw_st
{
103 int (*init
)(PROV_CIPHER_CTX
*dat
, const uint8_t *key
, size_t keylen
);
104 PROV_CIPHER_HW_FN
*cipher
;
105 void (*copyctx
)(PROV_CIPHER_CTX
*dst
, const PROV_CIPHER_CTX
*src
);
108 void ossl_cipher_generic_reset_ctx(PROV_CIPHER_CTX
*ctx
);
109 OSSL_FUNC_cipher_encrypt_init_fn ossl_cipher_generic_einit
;
110 OSSL_FUNC_cipher_decrypt_init_fn ossl_cipher_generic_dinit
;
111 OSSL_FUNC_cipher_update_fn ossl_cipher_generic_block_update
;
112 OSSL_FUNC_cipher_final_fn ossl_cipher_generic_block_final
;
113 OSSL_FUNC_cipher_update_fn ossl_cipher_generic_stream_update
;
114 OSSL_FUNC_cipher_final_fn ossl_cipher_generic_stream_final
;
115 OSSL_FUNC_cipher_cipher_fn ossl_cipher_generic_cipher
;
116 OSSL_FUNC_cipher_get_ctx_params_fn ossl_cipher_generic_get_ctx_params
;
117 OSSL_FUNC_cipher_set_ctx_params_fn ossl_cipher_generic_set_ctx_params
;
118 OSSL_FUNC_cipher_gettable_params_fn ossl_cipher_generic_gettable_params
;
119 OSSL_FUNC_cipher_gettable_ctx_params_fn ossl_cipher_generic_gettable_ctx_params
;
120 OSSL_FUNC_cipher_settable_ctx_params_fn ossl_cipher_generic_settable_ctx_params
;
121 OSSL_FUNC_cipher_set_ctx_params_fn ossl_cipher_var_keylen_set_ctx_params
;
122 OSSL_FUNC_cipher_settable_ctx_params_fn ossl_cipher_var_keylen_settable_ctx_params
;
123 OSSL_FUNC_cipher_gettable_ctx_params_fn ossl_cipher_aead_gettable_ctx_params
;
124 OSSL_FUNC_cipher_settable_ctx_params_fn ossl_cipher_aead_settable_ctx_params
;
126 int ossl_cipher_generic_get_params(OSSL_PARAM params
[], unsigned int md
,
128 size_t kbits
, size_t blkbits
, size_t ivbits
);
129 void ossl_cipher_generic_initkey(void *vctx
, size_t kbits
, size_t blkbits
,
130 size_t ivbits
, unsigned int mode
,
132 const PROV_CIPHER_HW
*hw
, void *provctx
);
134 # define IMPLEMENT_generic_cipher_func(alg, UCALG, lcmode, UCMODE, flags, kbits,\
135 blkbits, ivbits, typ) \
136 const OSSL_DISPATCH ossl_##alg##kbits##lcmode##_functions[] = { \
137 { OSSL_FUNC_CIPHER_NEWCTX, \
138 (void (*)(void)) alg##_##kbits##_##lcmode##_newctx }, \
139 { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void)) alg##_freectx }, \
140 { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void)) alg##_dupctx }, \
141 { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))ossl_cipher_generic_einit }, \
142 { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))ossl_cipher_generic_dinit }, \
143 { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))ossl_cipher_generic_##typ##_update },\
144 { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))ossl_cipher_generic_##typ##_final }, \
145 { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))ossl_cipher_generic_cipher }, \
146 { OSSL_FUNC_CIPHER_GET_PARAMS, \
147 (void (*)(void)) alg##_##kbits##_##lcmode##_get_params }, \
148 { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, \
149 (void (*)(void))ossl_cipher_generic_get_ctx_params }, \
150 { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, \
151 (void (*)(void))ossl_cipher_generic_set_ctx_params }, \
152 { OSSL_FUNC_CIPHER_GETTABLE_PARAMS, \
153 (void (*)(void))ossl_cipher_generic_gettable_params }, \
154 { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS, \
155 (void (*)(void))ossl_cipher_generic_gettable_ctx_params }, \
156 { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS, \
157 (void (*)(void))ossl_cipher_generic_settable_ctx_params }, \
161 # define IMPLEMENT_var_keylen_cipher_func(alg, UCALG, lcmode, UCMODE, flags, \
162 kbits, blkbits, ivbits, typ) \
163 const OSSL_DISPATCH ossl_##alg##kbits##lcmode##_functions[] = { \
164 { OSSL_FUNC_CIPHER_NEWCTX, \
165 (void (*)(void)) alg##_##kbits##_##lcmode##_newctx }, \
166 { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void)) alg##_freectx }, \
167 { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void)) alg##_dupctx }, \
168 { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))ossl_cipher_generic_einit },\
169 { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))ossl_cipher_generic_dinit },\
170 { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))ossl_cipher_generic_##typ##_update },\
171 { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))ossl_cipher_generic_##typ##_final }, \
172 { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))ossl_cipher_generic_cipher }, \
173 { OSSL_FUNC_CIPHER_GET_PARAMS, \
174 (void (*)(void)) alg##_##kbits##_##lcmode##_get_params }, \
175 { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, \
176 (void (*)(void))ossl_cipher_generic_get_ctx_params }, \
177 { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, \
178 (void (*)(void))ossl_cipher_var_keylen_set_ctx_params }, \
179 { OSSL_FUNC_CIPHER_GETTABLE_PARAMS, \
180 (void (*)(void))ossl_cipher_generic_gettable_params }, \
181 { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS, \
182 (void (*)(void))ossl_cipher_generic_gettable_ctx_params }, \
183 { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS, \
184 (void (*)(void))ossl_cipher_var_keylen_settable_ctx_params }, \
189 # define IMPLEMENT_generic_cipher_genfn(alg, UCALG, lcmode, UCMODE, flags, \
190 kbits, blkbits, ivbits, typ) \
191 static OSSL_FUNC_cipher_get_params_fn alg##_##kbits##_##lcmode##_get_params; \
192 static int alg##_##kbits##_##lcmode##_get_params(OSSL_PARAM params[]) \
194 return ossl_cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE, \
195 flags, kbits, blkbits, ivbits); \
197 static OSSL_FUNC_cipher_newctx_fn alg##_##kbits##_##lcmode##_newctx; \
198 static void * alg##_##kbits##_##lcmode##_newctx(void *provctx) \
200 PROV_##UCALG##_CTX *ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(*ctx))\
203 ossl_cipher_generic_initkey(ctx, kbits, blkbits, ivbits, \
204 EVP_CIPH_##UCMODE##_MODE, flags, \
205 ossl_prov_cipher_hw_##alg##_##lcmode(kbits),\
211 # define IMPLEMENT_generic_cipher(alg, UCALG, lcmode, UCMODE, flags, kbits, \
212 blkbits, ivbits, typ) \
213 IMPLEMENT_generic_cipher_genfn(alg, UCALG, lcmode, UCMODE, flags, kbits, \
214 blkbits, ivbits, typ) \
215 IMPLEMENT_generic_cipher_func(alg, UCALG, lcmode, UCMODE, flags, kbits, \
216 blkbits, ivbits, typ)
218 # define IMPLEMENT_var_keylen_cipher(alg, UCALG, lcmode, UCMODE, flags, kbits, \
219 blkbits, ivbits, typ) \
220 IMPLEMENT_generic_cipher_genfn(alg, UCALG, lcmode, UCMODE, flags, kbits, \
221 blkbits, ivbits, typ) \
222 IMPLEMENT_var_keylen_cipher_func(alg, UCALG, lcmode, UCMODE, flags, kbits, \
223 blkbits, ivbits, typ)
225 PROV_CIPHER_HW_FN ossl_cipher_hw_generic_cbc
;
226 PROV_CIPHER_HW_FN ossl_cipher_hw_generic_ecb
;
227 PROV_CIPHER_HW_FN ossl_cipher_hw_generic_ofb128
;
228 PROV_CIPHER_HW_FN ossl_cipher_hw_generic_cfb128
;
229 PROV_CIPHER_HW_FN ossl_cipher_hw_generic_cfb8
;
230 PROV_CIPHER_HW_FN ossl_cipher_hw_generic_cfb1
;
231 PROV_CIPHER_HW_FN ossl_cipher_hw_generic_ctr
;
232 PROV_CIPHER_HW_FN ossl_cipher_hw_chunked_cbc
;
233 PROV_CIPHER_HW_FN ossl_cipher_hw_chunked_cfb8
;
234 PROV_CIPHER_HW_FN ossl_cipher_hw_chunked_cfb128
;
235 PROV_CIPHER_HW_FN ossl_cipher_hw_chunked_ofb128
;
236 # define ossl_cipher_hw_chunked_ecb ossl_cipher_hw_generic_ecb
237 # define ossl_cipher_hw_chunked_ctr ossl_cipher_hw_generic_ctr
238 # define ossl_cipher_hw_chunked_cfb1 ossl_cipher_hw_generic_cfb1
240 # define IMPLEMENT_CIPHER_HW_OFB(MODE, NAME, CTX_NAME, KEY_NAME, FUNC_PREFIX) \
241 static int cipher_hw_##NAME##_##MODE##_cipher(PROV_CIPHER_CTX *ctx, \
242 unsigned char *out, \
243 const unsigned char *in, size_t len) \
245 int num = ctx->num; \
246 KEY_NAME *key = &(((CTX_NAME *)ctx)->ks.ks); \
248 while (len >= MAXCHUNK) { \
249 FUNC_PREFIX##_encrypt(in, out, MAXCHUNK, key, ctx->iv, &num); \
255 FUNC_PREFIX##_encrypt(in, out, (long)len, key, ctx->iv, &num); \
261 # define IMPLEMENT_CIPHER_HW_ECB(MODE, NAME, CTX_NAME, KEY_NAME, FUNC_PREFIX) \
262 static int cipher_hw_##NAME##_##MODE##_cipher(PROV_CIPHER_CTX *ctx, \
263 unsigned char *out, \
264 const unsigned char *in, size_t len) \
266 size_t i, bl = ctx->blocksize; \
267 KEY_NAME *key = &(((CTX_NAME *)ctx)->ks.ks); \
271 for (i = 0, len -= bl; i <= len; i += bl) \
272 FUNC_PREFIX##_encrypt(in + i, out + i, key, ctx->enc); \
276 # define IMPLEMENT_CIPHER_HW_CBC(MODE, NAME, CTX_NAME, KEY_NAME, FUNC_PREFIX) \
277 static int cipher_hw_##NAME##_##MODE##_cipher(PROV_CIPHER_CTX *ctx, \
278 unsigned char *out, \
279 const unsigned char *in, size_t len) \
281 KEY_NAME *key = &(((CTX_NAME *)ctx)->ks.ks); \
283 while (len >= MAXCHUNK) { \
284 FUNC_PREFIX##_encrypt(in, out, MAXCHUNK, key, ctx->iv, ctx->enc); \
290 FUNC_PREFIX##_encrypt(in, out, (long)len, key, ctx->iv, ctx->enc); \
294 # define IMPLEMENT_CIPHER_HW_CFB(MODE, NAME, CTX_NAME, KEY_NAME, FUNC_PREFIX) \
295 static int cipher_hw_##NAME##_##MODE##_cipher(PROV_CIPHER_CTX *ctx, \
296 unsigned char *out, \
297 const unsigned char *in, size_t len) \
299 size_t chunk = MAXCHUNK; \
300 KEY_NAME *key = &(((CTX_NAME *)ctx)->ks.ks); \
301 int num = ctx->num; \
305 while (len > 0 && len >= chunk) { \
306 FUNC_PREFIX##_encrypt(in, out, (long)chunk, key, ctx->iv, &num, \
318 # define IMPLEMENT_CIPHER_HW_COPYCTX(name, CTX_TYPE) \
319 static void name(PROV_CIPHER_CTX *dst, const PROV_CIPHER_CTX *src) \
321 CTX_TYPE *sctx = (CTX_TYPE *)src; \
322 CTX_TYPE *dctx = (CTX_TYPE *)dst; \
325 dst->ks = &dctx->ks.ks; \
328 # define CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_START(name) \
329 static const OSSL_PARAM name##_known_gettable_ctx_params[] = { \
330 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL), \
331 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL), \
332 OSSL_PARAM_uint(OSSL_CIPHER_PARAM_PADDING, NULL), \
333 OSSL_PARAM_uint(OSSL_CIPHER_PARAM_NUM, NULL), \
334 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_IV, NULL, 0), \
335 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_UPDATED_IV, NULL, 0),
337 # define CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_END(name) \
340 const OSSL_PARAM * name##_gettable_ctx_params(ossl_unused void *cctx, \
341 ossl_unused void *provctx) \
343 return name##_known_gettable_ctx_params; \
346 # define CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_START(name) \
347 static const OSSL_PARAM name##_known_settable_ctx_params[] = { \
348 OSSL_PARAM_uint(OSSL_CIPHER_PARAM_PADDING, NULL), \
349 OSSL_PARAM_uint(OSSL_CIPHER_PARAM_NUM, NULL),
350 # define CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_END(name) \
353 const OSSL_PARAM * name##_settable_ctx_params(ossl_unused void *cctx, \
354 ossl_unused void *provctx) \
356 return name##_known_settable_ctx_params; \
359 int ossl_cipher_generic_initiv(PROV_CIPHER_CTX
*ctx
, const unsigned char *iv
,
362 size_t ossl_cipher_fillblock(unsigned char *buf
, size_t *buflen
,
364 const unsigned char **in
, size_t *inlen
);
365 int ossl_cipher_trailingdata(unsigned char *buf
, size_t *buflen
,
367 const unsigned char **in
, size_t *inlen
);