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
10 #include <openssl/params.h>
11 #include <openssl/core_dispatch.h>
12 #include <openssl/core_names.h>
13 #include <openssl/evp.h>
14 #include "internal/cryptlib.h"
15 #include "crypto/modes.h"
17 #define MAXCHUNK ((size_t)1 << (sizeof(long) * 8 - 2))
18 #define MAXBITCHUNK ((size_t)1 << (sizeof(size_t) * 8 - 4))
20 #define GENERIC_BLOCK_SIZE 16
21 #define IV_STATE_UNINITIALISED 0 /* initial state is not initialized */
22 #define IV_STATE_BUFFERED 1 /* iv has been copied to the iv buffer */
23 #define IV_STATE_COPIED 2 /* iv has been copied from the iv buffer */
24 #define IV_STATE_FINISHED 3 /* the iv has been used - so don't reuse it */
26 #define PROV_CIPHER_FUNC(type, name, args) typedef type (* OSSL_##name##_fn)args
28 typedef struct prov_cipher_hw_st PROV_CIPHER_HW;
29 typedef struct prov_cipher_ctx_st PROV_CIPHER_CTX;
31 typedef int (PROV_CIPHER_HW_FN)(PROV_CIPHER_CTX *dat, unsigned char *out,
32 const unsigned char *in, size_t len);
34 struct prov_cipher_ctx_st {
43 size_t keylen; /* key size (in bytes) */
46 size_t bufsz; /* Number of bytes in buf */
47 unsigned int pad : 1; /* Whether padding should be used or not */
48 unsigned int enc : 1; /* Set to 1 for encrypt, or 0 otherwise */
49 unsigned int iv_set : 1; /* Set when the iv is copied to the iv/oiv buffers */
52 * num contains the number of bytes of |iv| which are valid for modes that
53 * manage partial blocks themselves.
58 /* The original value of the iv */
59 unsigned char oiv[GENERIC_BLOCK_SIZE];
60 /* Buffer of partial blocks processed via update calls */
61 unsigned char buf[GENERIC_BLOCK_SIZE];
62 unsigned char iv[GENERIC_BLOCK_SIZE];
63 const PROV_CIPHER_HW *hw; /* hardware specific functions */
64 const void *ks; /* Pointer to algorithm specific key data */
68 struct prov_cipher_hw_st {
69 int (*init)(PROV_CIPHER_CTX *dat, const uint8_t *key, size_t keylen);
70 PROV_CIPHER_HW_FN *cipher;
71 void (*copyctx)(PROV_CIPHER_CTX *dst, const PROV_CIPHER_CTX *src);
74 OSSL_FUNC_cipher_encrypt_init_fn cipher_generic_einit;
75 OSSL_FUNC_cipher_decrypt_init_fn cipher_generic_dinit;
76 OSSL_FUNC_cipher_update_fn cipher_generic_block_update;
77 OSSL_FUNC_cipher_final_fn cipher_generic_block_final;
78 OSSL_FUNC_cipher_update_fn cipher_generic_stream_update;
79 OSSL_FUNC_cipher_final_fn cipher_generic_stream_final;
80 OSSL_FUNC_cipher_cipher_fn cipher_generic_cipher;
81 OSSL_FUNC_cipher_get_ctx_params_fn cipher_generic_get_ctx_params;
82 OSSL_FUNC_cipher_set_ctx_params_fn cipher_generic_set_ctx_params;
83 OSSL_FUNC_cipher_gettable_params_fn cipher_generic_gettable_params;
84 OSSL_FUNC_cipher_gettable_ctx_params_fn cipher_generic_gettable_ctx_params;
85 OSSL_FUNC_cipher_settable_ctx_params_fn cipher_generic_settable_ctx_params;
86 OSSL_FUNC_cipher_set_ctx_params_fn cipher_var_keylen_set_ctx_params;
87 OSSL_FUNC_cipher_settable_ctx_params_fn cipher_var_keylen_settable_ctx_params;
88 OSSL_FUNC_cipher_gettable_ctx_params_fn cipher_aead_gettable_ctx_params;
89 OSSL_FUNC_cipher_settable_ctx_params_fn cipher_aead_settable_ctx_params;
90 int cipher_generic_get_params(OSSL_PARAM params[], unsigned int md,
92 size_t kbits, size_t blkbits, size_t ivbits);
93 void cipher_generic_initkey(void *vctx, size_t kbits, size_t blkbits,
94 size_t ivbits, unsigned int mode, uint64_t flags,
95 const PROV_CIPHER_HW *hw, void *provctx);
97 #define IMPLEMENT_generic_cipher_func(alg, UCALG, lcmode, UCMODE, flags, kbits,\
98 blkbits, ivbits, typ) \
99 const OSSL_DISPATCH alg##kbits##lcmode##_functions[] = { \
100 { OSSL_FUNC_CIPHER_NEWCTX, \
101 (void (*)(void)) alg##_##kbits##_##lcmode##_newctx }, \
102 { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void)) alg##_freectx }, \
103 { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void)) alg##_dupctx }, \
104 { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))cipher_generic_einit }, \
105 { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))cipher_generic_dinit }, \
106 { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))cipher_generic_##typ##_update },\
107 { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))cipher_generic_##typ##_final }, \
108 { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))cipher_generic_cipher }, \
109 { OSSL_FUNC_CIPHER_GET_PARAMS, \
110 (void (*)(void)) alg##_##kbits##_##lcmode##_get_params }, \
111 { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, \
112 (void (*)(void))cipher_generic_get_ctx_params }, \
113 { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, \
114 (void (*)(void))cipher_generic_set_ctx_params }, \
115 { OSSL_FUNC_CIPHER_GETTABLE_PARAMS, \
116 (void (*)(void))cipher_generic_gettable_params }, \
117 { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS, \
118 (void (*)(void))cipher_generic_gettable_ctx_params }, \
119 { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS, \
120 (void (*)(void))cipher_generic_settable_ctx_params }, \
124 #define IMPLEMENT_var_keylen_cipher_func(alg, UCALG, lcmode, UCMODE, flags, \
125 kbits, blkbits, ivbits, typ) \
126 const OSSL_DISPATCH alg##kbits##lcmode##_functions[] = { \
127 { OSSL_FUNC_CIPHER_NEWCTX, \
128 (void (*)(void)) alg##_##kbits##_##lcmode##_newctx }, \
129 { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void)) alg##_freectx }, \
130 { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void)) alg##_dupctx }, \
131 { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))cipher_generic_einit }, \
132 { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))cipher_generic_dinit }, \
133 { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))cipher_generic_##typ##_update },\
134 { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))cipher_generic_##typ##_final }, \
135 { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))cipher_generic_cipher }, \
136 { OSSL_FUNC_CIPHER_GET_PARAMS, \
137 (void (*)(void)) alg##_##kbits##_##lcmode##_get_params }, \
138 { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, \
139 (void (*)(void))cipher_generic_get_ctx_params }, \
140 { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, \
141 (void (*)(void))cipher_var_keylen_set_ctx_params }, \
142 { OSSL_FUNC_CIPHER_GETTABLE_PARAMS, \
143 (void (*)(void))cipher_generic_gettable_params }, \
144 { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS, \
145 (void (*)(void))cipher_generic_gettable_ctx_params }, \
146 { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS, \
147 (void (*)(void))cipher_var_keylen_settable_ctx_params }, \
152 #define IMPLEMENT_generic_cipher_genfn(alg, UCALG, lcmode, UCMODE, flags, \
153 kbits, blkbits, ivbits, typ) \
154 static OSSL_FUNC_cipher_get_params_fn alg##_##kbits##_##lcmode##_get_params; \
155 static int alg##_##kbits##_##lcmode##_get_params(OSSL_PARAM params[]) \
157 return cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE, flags, \
158 kbits, blkbits, ivbits); \
160 static OSSL_FUNC_cipher_newctx_fn alg##_##kbits##_##lcmode##_newctx; \
161 static void * alg##_##kbits##_##lcmode##_newctx(void *provctx) \
163 PROV_##UCALG##_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx)); \
165 cipher_generic_initkey(ctx, kbits, blkbits, ivbits, \
166 EVP_CIPH_##UCMODE##_MODE, flags, \
167 PROV_CIPHER_HW_##alg##_##lcmode(kbits), NULL); \
172 #define IMPLEMENT_generic_cipher(alg, UCALG, lcmode, UCMODE, flags, kbits, \
173 blkbits, ivbits, typ) \
174 IMPLEMENT_generic_cipher_genfn(alg, UCALG, lcmode, UCMODE, flags, kbits, \
175 blkbits, ivbits, typ) \
176 IMPLEMENT_generic_cipher_func(alg, UCALG, lcmode, UCMODE, flags, kbits, \
177 blkbits, ivbits, typ)
179 #define IMPLEMENT_var_keylen_cipher(alg, UCALG, lcmode, UCMODE, flags, kbits, \
180 blkbits, ivbits, typ) \
181 IMPLEMENT_generic_cipher_genfn(alg, UCALG, lcmode, UCMODE, flags, kbits, \
182 blkbits, ivbits, typ) \
183 IMPLEMENT_var_keylen_cipher_func(alg, UCALG, lcmode, UCMODE, flags, kbits, \
184 blkbits, ivbits, typ)
186 PROV_CIPHER_HW_FN cipher_hw_generic_cbc;
187 PROV_CIPHER_HW_FN cipher_hw_generic_ecb;
188 PROV_CIPHER_HW_FN cipher_hw_generic_ofb128;
189 PROV_CIPHER_HW_FN cipher_hw_generic_cfb128;
190 PROV_CIPHER_HW_FN cipher_hw_generic_cfb8;
191 PROV_CIPHER_HW_FN cipher_hw_generic_cfb1;
192 PROV_CIPHER_HW_FN cipher_hw_generic_ctr;
193 PROV_CIPHER_HW_FN cipher_hw_chunked_cbc;
194 PROV_CIPHER_HW_FN cipher_hw_chunked_cfb8;
195 PROV_CIPHER_HW_FN cipher_hw_chunked_cfb128;
196 PROV_CIPHER_HW_FN cipher_hw_chunked_ofb128;
197 #define cipher_hw_chunked_ecb cipher_hw_generic_ecb
198 #define cipher_hw_chunked_ctr cipher_hw_generic_ctr
199 #define cipher_hw_chunked_cfb1 cipher_hw_generic_cfb1
201 #define IMPLEMENT_CIPHER_HW_OFB(MODE, NAME, CTX_NAME, KEY_NAME, FUNC_PREFIX) \
202 static int cipher_hw_##NAME##_##MODE##_cipher(PROV_CIPHER_CTX *ctx, \
203 unsigned char *out, \
204 const unsigned char *in, size_t len) \
206 int num = ctx->num; \
207 KEY_NAME *key = &(((CTX_NAME *)ctx)->ks.ks); \
209 while (len >= MAXCHUNK) { \
210 FUNC_PREFIX##_encrypt(in, out, MAXCHUNK, key, ctx->iv, &num); \
216 FUNC_PREFIX##_encrypt(in, out, (long)len, key, ctx->iv, &num); \
222 #define IMPLEMENT_CIPHER_HW_ECB(MODE, NAME, CTX_NAME, KEY_NAME, FUNC_PREFIX) \
223 static int cipher_hw_##NAME##_##MODE##_cipher(PROV_CIPHER_CTX *ctx, \
224 unsigned char *out, \
225 const unsigned char *in, size_t len) \
227 size_t i, bl = ctx->blocksize; \
228 KEY_NAME *key = &(((CTX_NAME *)ctx)->ks.ks); \
232 for (i = 0, len -= bl; i <= len; i += bl) \
233 FUNC_PREFIX##_encrypt(in + i, out + i, key, ctx->enc); \
237 #define IMPLEMENT_CIPHER_HW_CBC(MODE, NAME, CTX_NAME, KEY_NAME, FUNC_PREFIX) \
238 static int cipher_hw_##NAME##_##MODE##_cipher(PROV_CIPHER_CTX *ctx, \
239 unsigned char *out, \
240 const unsigned char *in, size_t len) \
242 KEY_NAME *key = &(((CTX_NAME *)ctx)->ks.ks); \
244 while (len >= MAXCHUNK) { \
245 FUNC_PREFIX##_encrypt(in, out, MAXCHUNK, key, ctx->iv, ctx->enc); \
251 FUNC_PREFIX##_encrypt(in, out, (long)len, key, ctx->iv, ctx->enc); \
255 #define IMPLEMENT_CIPHER_HW_CFB(MODE, NAME, CTX_NAME, KEY_NAME, FUNC_PREFIX) \
256 static int cipher_hw_##NAME##_##MODE##_cipher(PROV_CIPHER_CTX *ctx, \
257 unsigned char *out, \
258 const unsigned char *in, size_t len) \
260 size_t chunk = MAXCHUNK; \
261 KEY_NAME *key = &(((CTX_NAME *)ctx)->ks.ks); \
262 int num = ctx->num; \
266 while (len > 0 && len >= chunk) { \
267 FUNC_PREFIX##_encrypt(in, out, (long)chunk, key, ctx->iv, &num, \
279 #define IMPLEMENT_CIPHER_HW_COPYCTX(name, CTX_TYPE) \
280 static void name(PROV_CIPHER_CTX *dst, const PROV_CIPHER_CTX *src) \
282 CTX_TYPE *sctx = (CTX_TYPE *)src; \
283 CTX_TYPE *dctx = (CTX_TYPE *)dst; \
286 dst->ks = &dctx->ks.ks; \
289 #define CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_START(name) \
290 static const OSSL_PARAM name##_known_gettable_ctx_params[] = { \
291 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL), \
292 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL), \
293 OSSL_PARAM_uint(OSSL_CIPHER_PARAM_PADDING, NULL), \
294 OSSL_PARAM_uint(OSSL_CIPHER_PARAM_NUM, NULL), \
295 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_IV, NULL, 0),
297 #define CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_END(name) \
300 const OSSL_PARAM * name##_gettable_ctx_params(void) \
302 return name##_known_gettable_ctx_params; \
305 #define CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_START(name) \
306 static const OSSL_PARAM name##_known_settable_ctx_params[] = { \
307 OSSL_PARAM_uint(OSSL_CIPHER_PARAM_PADDING, NULL), \
308 OSSL_PARAM_uint(OSSL_CIPHER_PARAM_NUM, NULL),
309 #define CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_END(name) \
312 const OSSL_PARAM * name##_settable_ctx_params(void) \
314 return name##_known_settable_ctx_params; \
317 int cipher_generic_initiv(PROV_CIPHER_CTX *ctx, const unsigned char *iv,
320 size_t fillblock(unsigned char *buf, size_t *buflen, size_t blocksize,
321 const unsigned char **in, size_t *inlen);
322 int trailingdata(unsigned char *buf, size_t *buflen, size_t blocksize,
323 const unsigned char **in, size_t *inlen);