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
10 /* Dispatch functions for RC2 cipher modes ecb, cbc, ofb, cfb */
12 #include "cipher_rc2.h"
13 #include "internal/provider_algs.h"
14 #include "internal/providercommonerr.h"
16 #define RC2_40_MAGIC 0xa0
17 #define RC2_64_MAGIC 0x78
18 #define RC2_128_MAGIC 0x3a
20 static OSSL_OP_cipher_freectx_fn rc2_freectx;
21 static OSSL_OP_cipher_dupctx_fn rc2_dupctx;
22 static OSSL_OP_cipher_gettable_ctx_params_fn rc2_gettable_ctx_params;
23 static OSSL_OP_cipher_settable_ctx_params_fn rc2_settable_ctx_params;
25 static void rc2_freectx(void *vctx)
27 PROV_RC2_CTX *ctx = (PROV_RC2_CTX *)vctx;
29 OPENSSL_clear_free(ctx, sizeof(*ctx));
32 static void *rc2_dupctx(void *ctx)
34 PROV_RC2_CTX *in = (PROV_RC2_CTX *)ctx;
35 PROV_RC2_CTX *ret = OPENSSL_malloc(sizeof(*ret));
38 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
46 static int rc2_keybits_to_magic(int keybits)
56 ERR_raise(ERR_LIB_PROV, PROV_R_UNSUPPORTED_KEY_SIZE);
60 static int rc2_magic_to_keybits(int magic)
70 ERR_raise(ERR_LIB_PROV, PROV_R_UNSUPPORTED_KEY_SIZE);
74 static int rc2_get_ctx_params(void *vctx, OSSL_PARAM params[])
76 PROV_RC2_CTX *ctx = (PROV_RC2_CTX *)vctx;
79 if (!cipher_generic_get_ctx_params(vctx, params))
81 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_RC2_KEYBITS);
82 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->key_bits)) {
83 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
86 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_ALG_ID);
91 unsigned char *d = p->data;
92 unsigned char **dd = d == NULL ? NULL : &d;
94 if (p->data_type != OSSL_PARAM_OCTET_STRING) {
95 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
98 if ((type = ASN1_TYPE_new()) == NULL) {
99 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
103 /* Is this the original IV or the running IV? */
104 num = rc2_keybits_to_magic(ctx->key_bits);
105 if (!ASN1_TYPE_set_int_octetstring(type, num,
106 ctx->base.iv, ctx->base.ivlen)) {
107 ASN1_TYPE_free(type);
108 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
112 * IF the caller has a buffer, we pray to the gods they got the
113 * size right. There's no way to tell the i2d functions...
115 i = i2d_ASN1_TYPE(type, dd);
117 p->return_size = (size_t)i;
119 ASN1_TYPE_free(type);
121 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
128 static int rc2_set_ctx_params(void *vctx, OSSL_PARAM params[])
130 PROV_RC2_CTX *ctx = (PROV_RC2_CTX *)vctx;
133 if (!cipher_generic_set_ctx_params(vctx, params))
135 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_RC2_KEYBITS);
137 if (!OSSL_PARAM_get_size_t(p, &ctx->key_bits)) {
138 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
142 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_ALG_ID);
144 ASN1_TYPE *type = NULL;
146 const unsigned char *d = p->data;
148 unsigned char iv[16];
150 if (p->data_type != OSSL_PARAM_OCTET_STRING
151 || ctx->base.ivlen > sizeof(iv)
152 || (type = d2i_ASN1_TYPE(NULL, &d, p->data_size)) == NULL
153 || ((size_t)ASN1_TYPE_get_int_octetstring(type, &num, iv,
156 || !cipher_generic_initiv(&ctx->base, iv, ctx->base.ivlen)
157 || (ctx->key_bits = rc2_magic_to_keybits(num)) == 0) {
158 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
161 ASN1_TYPE_free(type);
165 * This code assumes that the caller will call
166 * EVP_CipherInit_ex() with a non NULL key in order to setup a key that
167 * uses the keylen and keybits that were set here.
169 ctx->base.keylen = ctx->key_bits / 8;
174 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_START(rc2)
175 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_RC2_KEYBITS, NULL),
176 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_END(rc2)
178 CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_START(rc2)
179 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_RC2_KEYBITS, NULL),
180 CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_END(rc2)
182 #define IMPLEMENT_cipher(alg, UCALG, lcmode, UCMODE, flags, kbits, blkbits, \
184 static OSSL_OP_cipher_get_params_fn alg##_##kbits##_##lcmode##_get_params; \
185 static int alg##_##kbits##_##lcmode##_get_params(OSSL_PARAM params[]) \
187 return cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE, flags, \
188 kbits, blkbits, ivbits); \
190 static OSSL_OP_cipher_newctx_fn alg##_##kbits##_##lcmode##_newctx; \
191 static void * alg##_##kbits##_##lcmode##_newctx(void *provctx) \
193 PROV_##UCALG##_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx)); \
195 cipher_generic_initkey(ctx, kbits, blkbits, ivbits, \
196 EVP_CIPH_##UCMODE##_MODE, flags, \
197 PROV_CIPHER_HW_##alg##_##lcmode(kbits), NULL); \
198 ctx->key_bits = kbits; \
202 const OSSL_DISPATCH alg##kbits##lcmode##_functions[] = { \
203 { OSSL_FUNC_CIPHER_NEWCTX, \
204 (void (*)(void)) alg##_##kbits##_##lcmode##_newctx }, \
205 { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void)) alg##_freectx }, \
206 { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void)) alg##_dupctx }, \
207 { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))cipher_generic_einit }, \
208 { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))cipher_generic_dinit }, \
209 { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))cipher_generic_##typ##_update },\
210 { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))cipher_generic_##typ##_final }, \
211 { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))cipher_generic_cipher }, \
212 { OSSL_FUNC_CIPHER_GET_PARAMS, \
213 (void (*)(void)) alg##_##kbits##_##lcmode##_get_params }, \
214 { OSSL_FUNC_CIPHER_GETTABLE_PARAMS, \
215 (void (*)(void))cipher_generic_gettable_params }, \
216 { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, \
217 (void (*)(void))rc2_get_ctx_params }, \
218 { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS, \
219 (void (*)(void))rc2_gettable_ctx_params }, \
220 { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, \
221 (void (*)(void))rc2_set_ctx_params }, \
222 { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS, \
223 (void (*)(void))rc2_settable_ctx_params }, \
227 /* rc2128ecb_functions */
228 IMPLEMENT_cipher(rc2, RC2, ecb, ECB, EVP_CIPH_VARIABLE_LENGTH, 128, 64, 0, block)
229 /* rc2128cbc_functions */
230 IMPLEMENT_cipher(rc2, RC2, cbc, CBC, EVP_CIPH_VARIABLE_LENGTH, 128, 64, 64, block)
231 /* rc240cbc_functions */
232 IMPLEMENT_cipher(rc2, RC2, cbc, CBC, EVP_CIPH_VARIABLE_LENGTH, 40, 64, 64, block)
233 /* rc264cbc_functions */
234 IMPLEMENT_cipher(rc2, RC2, cbc, CBC, EVP_CIPH_VARIABLE_LENGTH, 64, 64, 64, block)
236 /* rc2128ofb128_functions */
237 IMPLEMENT_cipher(rc2, RC2, ofb128, OFB, EVP_CIPH_VARIABLE_LENGTH, 128, 8, 64, stream)
238 /* rc2128cfb128_functions */
239 IMPLEMENT_cipher(rc2, RC2, cfb128, CFB, EVP_CIPH_VARIABLE_LENGTH, 128, 8, 64, stream)