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 /* Dispatch functions for RC2 cipher modes ecb, cbc, ofb, cfb */
13 * RC2 low level APIs are deprecated for public use, but still ok for internal
16 #include "internal/deprecated.h"
18 #include "cipher_rc2.h"
19 #include "prov/implementations.h"
20 #include "prov/providercommon.h"
21 #include "prov/providercommonerr.h"
23 #define RC2_40_MAGIC 0xa0
24 #define RC2_64_MAGIC 0x78
25 #define RC2_128_MAGIC 0x3a
27 static OSSL_FUNC_cipher_freectx_fn rc2_freectx
;
28 static OSSL_FUNC_cipher_dupctx_fn rc2_dupctx
;
29 static OSSL_FUNC_cipher_gettable_ctx_params_fn rc2_gettable_ctx_params
;
30 static OSSL_FUNC_cipher_settable_ctx_params_fn rc2_settable_ctx_params
;
32 static void rc2_freectx(void *vctx
)
34 PROV_RC2_CTX
*ctx
= (PROV_RC2_CTX
*)vctx
;
36 cipher_generic_reset_ctx((PROV_CIPHER_CTX
*)vctx
);
37 OPENSSL_clear_free(ctx
, sizeof(*ctx
));
40 static void *rc2_dupctx(void *ctx
)
42 PROV_RC2_CTX
*in
= (PROV_RC2_CTX
*)ctx
;
45 if (!ossl_prov_is_running())
48 ret
= OPENSSL_malloc(sizeof(*ret
));
50 ERR_raise(ERR_LIB_PROV
, ERR_R_MALLOC_FAILURE
);
58 static int rc2_keybits_to_magic(int keybits
)
68 ERR_raise(ERR_LIB_PROV
, PROV_R_UNSUPPORTED_KEY_SIZE
);
72 static int rc2_magic_to_keybits(int magic
)
82 ERR_raise(ERR_LIB_PROV
, PROV_R_UNSUPPORTED_KEY_SIZE
);
86 static int rc2_get_ctx_params(void *vctx
, OSSL_PARAM params
[])
88 PROV_RC2_CTX
*ctx
= (PROV_RC2_CTX
*)vctx
;
91 if (!cipher_generic_get_ctx_params(vctx
, params
))
93 p
= OSSL_PARAM_locate(params
, OSSL_CIPHER_PARAM_RC2_KEYBITS
);
94 if (p
!= NULL
&& !OSSL_PARAM_set_size_t(p
, ctx
->key_bits
)) {
95 ERR_raise(ERR_LIB_PROV
, PROV_R_FAILED_TO_SET_PARAMETER
);
98 p
= OSSL_PARAM_locate(params
, OSSL_CIPHER_PARAM_ALG_ID
);
103 unsigned char *d
= p
->data
;
104 unsigned char **dd
= d
== NULL
? NULL
: &d
;
106 if (p
->data_type
!= OSSL_PARAM_OCTET_STRING
) {
107 ERR_raise(ERR_LIB_PROV
, PROV_R_FAILED_TO_SET_PARAMETER
);
110 if ((type
= ASN1_TYPE_new()) == NULL
) {
111 ERR_raise(ERR_LIB_PROV
, ERR_R_MALLOC_FAILURE
);
115 /* Is this the original IV or the running IV? */
116 num
= rc2_keybits_to_magic(ctx
->key_bits
);
117 if (!ASN1_TYPE_set_int_octetstring(type
, num
,
118 ctx
->base
.iv
, ctx
->base
.ivlen
)) {
119 ASN1_TYPE_free(type
);
120 ERR_raise(ERR_LIB_PROV
, ERR_R_MALLOC_FAILURE
);
124 * IF the caller has a buffer, we pray to the gods they got the
125 * size right. There's no way to tell the i2d functions...
127 i
= i2d_ASN1_TYPE(type
, dd
);
129 p
->return_size
= (size_t)i
;
131 ASN1_TYPE_free(type
);
133 ERR_raise(ERR_LIB_PROV
, PROV_R_FAILED_TO_SET_PARAMETER
);
140 static int rc2_set_ctx_params(void *vctx
, OSSL_PARAM params
[])
142 PROV_RC2_CTX
*ctx
= (PROV_RC2_CTX
*)vctx
;
145 if (!cipher_var_keylen_set_ctx_params(vctx
, params
))
147 p
= OSSL_PARAM_locate_const(params
, OSSL_CIPHER_PARAM_RC2_KEYBITS
);
149 if (!OSSL_PARAM_get_size_t(p
, &ctx
->key_bits
)) {
150 ERR_raise(ERR_LIB_PROV
, PROV_R_FAILED_TO_GET_PARAMETER
);
154 p
= OSSL_PARAM_locate(params
, OSSL_CIPHER_PARAM_ALG_ID
);
156 ASN1_TYPE
*type
= NULL
;
158 const unsigned char *d
= p
->data
;
160 unsigned char iv
[16];
162 if (p
->data_type
!= OSSL_PARAM_OCTET_STRING
163 || ctx
->base
.ivlen
> sizeof(iv
)
164 || (type
= d2i_ASN1_TYPE(NULL
, &d
, p
->data_size
)) == NULL
165 || ((size_t)ASN1_TYPE_get_int_octetstring(type
, &num
, iv
,
168 || !cipher_generic_initiv(&ctx
->base
, iv
, ctx
->base
.ivlen
)
169 || (ctx
->key_bits
= rc2_magic_to_keybits(num
)) == 0) {
170 ERR_raise(ERR_LIB_PROV
, PROV_R_FAILED_TO_SET_PARAMETER
);
173 ASN1_TYPE_free(type
);
177 * This code assumes that the caller will call
178 * EVP_CipherInit_ex() with a non NULL key in order to setup a key that
179 * uses the keylen and keybits that were set here.
181 ctx
->base
.keylen
= ctx
->key_bits
/ 8;
186 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_START(rc2
)
187 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_RC2_KEYBITS
, NULL
),
188 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_END(rc2
)
190 CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_START(rc2
)
191 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN
, NULL
),
192 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_RC2_KEYBITS
, NULL
),
193 CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_END(rc2
)
195 #define IMPLEMENT_cipher(alg, UCALG, lcmode, UCMODE, flags, kbits, blkbits, \
197 static OSSL_FUNC_cipher_get_params_fn alg##_##kbits##_##lcmode##_get_params; \
198 static int alg##_##kbits##_##lcmode##_get_params(OSSL_PARAM params[]) \
200 return cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE, flags, \
201 kbits, blkbits, ivbits); \
203 static OSSL_FUNC_cipher_newctx_fn alg##_##kbits##_##lcmode##_newctx; \
204 static void * alg##_##kbits##_##lcmode##_newctx(void *provctx) \
206 PROV_##UCALG##_CTX *ctx; \
207 if (!ossl_prov_is_running()) \
209 ctx = OPENSSL_zalloc(sizeof(*ctx)); \
211 cipher_generic_initkey(ctx, kbits, blkbits, ivbits, \
212 EVP_CIPH_##UCMODE##_MODE, flags, \
213 PROV_CIPHER_HW_##alg##_##lcmode(kbits), NULL); \
214 ctx->key_bits = kbits; \
218 const OSSL_DISPATCH ossl_##alg##kbits##lcmode##_functions[] = { \
219 { OSSL_FUNC_CIPHER_NEWCTX, \
220 (void (*)(void)) alg##_##kbits##_##lcmode##_newctx }, \
221 { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void)) alg##_freectx }, \
222 { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void)) alg##_dupctx }, \
223 { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))cipher_generic_einit }, \
224 { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))cipher_generic_dinit }, \
225 { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))cipher_generic_##typ##_update },\
226 { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))cipher_generic_##typ##_final }, \
227 { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))cipher_generic_cipher }, \
228 { OSSL_FUNC_CIPHER_GET_PARAMS, \
229 (void (*)(void)) alg##_##kbits##_##lcmode##_get_params }, \
230 { OSSL_FUNC_CIPHER_GETTABLE_PARAMS, \
231 (void (*)(void))cipher_generic_gettable_params }, \
232 { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, \
233 (void (*)(void))rc2_get_ctx_params }, \
234 { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS, \
235 (void (*)(void))rc2_gettable_ctx_params }, \
236 { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, \
237 (void (*)(void))rc2_set_ctx_params }, \
238 { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS, \
239 (void (*)(void))rc2_settable_ctx_params }, \
243 /* ossl_rc2128ecb_functions */
244 IMPLEMENT_cipher(rc2
, RC2
, ecb
, ECB
, EVP_CIPH_VARIABLE_LENGTH
, 128, 64, 0, block
)
245 /* ossl_rc2128cbc_functions */
246 IMPLEMENT_cipher(rc2
, RC2
, cbc
, CBC
, EVP_CIPH_VARIABLE_LENGTH
, 128, 64, 64, block
)
247 /* ossl_rc240cbc_functions */
248 IMPLEMENT_cipher(rc2
, RC2
, cbc
, CBC
, EVP_CIPH_VARIABLE_LENGTH
, 40, 64, 64, block
)
249 /* ossl_rc264cbc_functions */
250 IMPLEMENT_cipher(rc2
, RC2
, cbc
, CBC
, EVP_CIPH_VARIABLE_LENGTH
, 64, 64, 64, block
)
252 /* ossl_rc2128ofb128_functions */
253 IMPLEMENT_cipher(rc2
, RC2
, ofb128
, OFB
, EVP_CIPH_VARIABLE_LENGTH
, 128, 8, 64, stream
)
254 /* ossl_rc2128cfb128_functions */
255 IMPLEMENT_cipher(rc2
, RC2
, cfb128
, CFB
, EVP_CIPH_VARIABLE_LENGTH
, 128, 8, 64, stream
)