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
11 * DES low level APIs are deprecated for public use, but still ok for internal
14 #include "internal/deprecated.h"
16 #include <openssl/rand.h>
17 #include <openssl/proverr.h>
18 #include "prov/ciphercommon.h"
19 #include "cipher_des.h"
20 #include "prov/implementations.h"
21 #include "prov/providercommon.h"
25 static OSSL_FUNC_cipher_freectx_fn des_freectx;
26 static OSSL_FUNC_cipher_encrypt_init_fn des_einit;
27 static OSSL_FUNC_cipher_decrypt_init_fn des_dinit;
28 static OSSL_FUNC_cipher_get_ctx_params_fn des_get_ctx_params;
29 static OSSL_FUNC_cipher_gettable_ctx_params_fn des_gettable_ctx_params;
31 static void *des_newctx(void *provctx, size_t kbits, size_t blkbits,
32 size_t ivbits, unsigned int mode, uint64_t flags,
33 const PROV_CIPHER_HW *hw)
37 if (!ossl_prov_is_running())
40 ctx = OPENSSL_zalloc(sizeof(*ctx));
42 ossl_cipher_generic_initkey(ctx, kbits, blkbits, ivbits, mode, flags,
47 static void *des_dupctx(void *ctx)
49 PROV_DES_CTX *in = (PROV_DES_CTX *)ctx;
52 if (!ossl_prov_is_running())
55 ret = OPENSSL_malloc(sizeof(*ret));
57 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
60 in->base.hw->copyctx(&ret->base, &in->base);
65 static void des_freectx(void *vctx)
67 PROV_DES_CTX *ctx = (PROV_DES_CTX *)vctx;
69 ossl_cipher_generic_reset_ctx((PROV_CIPHER_CTX *)vctx);
70 OPENSSL_clear_free(ctx, sizeof(*ctx));
73 static int des_init(void *vctx, const unsigned char *key, size_t keylen,
74 const unsigned char *iv, size_t ivlen, int enc)
76 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
78 if (!ossl_prov_is_running())
86 if (!ossl_cipher_generic_initiv(ctx, iv, ivlen))
91 if (keylen != ctx->keylen) {
92 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEYLEN);
95 return ctx->hw->init(ctx, key, keylen);
100 static int des_einit(void *vctx, const unsigned char *key, size_t keylen,
101 const unsigned char *iv, size_t ivlen)
103 return des_init(vctx, key, keylen, iv, ivlen, 1);
106 static int des_dinit(void *vctx, const unsigned char *key, size_t keylen,
107 const unsigned char *iv, size_t ivlen)
109 return des_init(vctx, key, keylen, iv, ivlen, 0);
112 static int des_generatekey(PROV_CIPHER_CTX *ctx, void *ptr)
115 DES_cblock *deskey = ptr;
116 size_t kl = ctx->keylen;
118 if (kl == 0 || RAND_priv_bytes_ex(ctx->libctx, ptr, kl) <= 0)
120 DES_set_odd_parity(deskey);
124 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_START(des)
125 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_RANDOM_KEY, NULL, 0),
126 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_END(des)
128 static int des_get_ctx_params(void *vctx, OSSL_PARAM params[])
130 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
133 if (!ossl_cipher_generic_get_ctx_params(vctx, params))
136 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_RANDOM_KEY);
137 if (p != NULL && !des_generatekey(ctx, p->data)) {
138 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GENERATE_KEY);
144 #define IMPLEMENT_des_cipher(type, lcmode, UCMODE, flags, \
145 kbits, blkbits, ivbits, block) \
146 static OSSL_FUNC_cipher_newctx_fn type##_##lcmode##_newctx; \
147 static void *des_##lcmode##_newctx(void *provctx) \
149 return des_newctx(provctx, kbits, blkbits, ivbits, \
150 EVP_CIPH_##UCMODE##_MODE, flags, \
151 PROV_CIPHER_HW_des_##lcmode()); \
153 static OSSL_FUNC_cipher_get_params_fn des_##lcmode##_get_params; \
154 static int des_##lcmode##_get_params(OSSL_PARAM params[]) \
156 return ossl_cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE, \
157 flags, kbits, blkbits, ivbits); \
159 const OSSL_DISPATCH ossl_##des_##lcmode##_functions[] = { \
160 { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))des_einit }, \
161 { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))des_dinit }, \
162 { OSSL_FUNC_CIPHER_UPDATE, \
163 (void (*)(void))ossl_cipher_generic_##block##_update }, \
164 { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))ossl_cipher_generic_##block##_final },\
165 { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))ossl_cipher_generic_cipher }, \
166 { OSSL_FUNC_CIPHER_NEWCTX, \
167 (void (*)(void))des_##lcmode##_newctx }, \
168 { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void))des_dupctx }, \
169 { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))des_freectx }, \
170 { OSSL_FUNC_CIPHER_GET_PARAMS, \
171 (void (*)(void))des_##lcmode##_get_params }, \
172 { OSSL_FUNC_CIPHER_GETTABLE_PARAMS, \
173 (void (*)(void))ossl_cipher_generic_gettable_params }, \
174 { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, (void (*)(void))des_get_ctx_params }, \
175 { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS, \
176 (void (*)(void))des_gettable_ctx_params }, \
177 { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, \
178 (void (*)(void))ossl_cipher_generic_set_ctx_params }, \
179 { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS, \
180 (void (*)(void))ossl_cipher_generic_settable_ctx_params }, \
184 /* ossl_des_ecb_functions */
185 IMPLEMENT_des_cipher(des, ecb, ECB, DES_FLAGS, 64, 64, 0, block);
186 /* ossl_des_cbc_functions */
187 IMPLEMENT_des_cipher(des, cbc, CBC, DES_FLAGS, 64, 64, 64, block);
188 /* ossl_des_ofb64_functions */
189 IMPLEMENT_des_cipher(des, ofb64, OFB, DES_FLAGS, 64, 8, 64, stream);
190 /* ossl_des_cfb64_functions */
191 IMPLEMENT_des_cipher(des, cfb64, CFB, DES_FLAGS, 64, 8, 64, stream);
192 /* ossl_des_cfb1_functions */
193 IMPLEMENT_des_cipher(des, cfb1, CFB, DES_FLAGS, 64, 8, 64, stream);
194 /* ossl_des_cfb8_functions */
195 IMPLEMENT_des_cipher(des, cfb8, CFB, DES_FLAGS, 64, 8, 64, stream);