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 "prov/ciphercommon.h"
17 #include "cipher_des.h"
18 #include <openssl/rand.h>
19 #include "prov/implementations.h"
20 #include "prov/providercommonerr.h"
22 /* TODO(3.0) Figure out what flags need to be here */
23 #define DES_FLAGS (EVP_CIPH_RAND_KEY)
25 static OSSL_OP_cipher_freectx_fn des_freectx;
26 static OSSL_OP_cipher_encrypt_init_fn des_einit;
27 static OSSL_OP_cipher_decrypt_init_fn des_dinit;
28 static OSSL_OP_cipher_get_ctx_params_fn des_get_ctx_params;
29 static OSSL_OP_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)
35 PROV_DES_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx));
38 cipher_generic_initkey(ctx, kbits, blkbits, ivbits, mode, flags, hw,
43 static void *des_dupctx(void *ctx)
45 PROV_DES_CTX *in = (PROV_DES_CTX *)ctx;
46 PROV_DES_CTX *ret = OPENSSL_malloc(sizeof(*ret));
49 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
52 in->base.hw->copyctx(&ret->base, &in->base);
57 static void des_freectx(void *vctx)
59 PROV_DES_CTX *ctx = (PROV_DES_CTX *)vctx;
61 OPENSSL_clear_free(ctx, sizeof(*ctx));
64 static int des_init(void *vctx, const unsigned char *key, size_t keylen,
65 const unsigned char *iv, size_t ivlen, int enc)
67 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
72 if (!cipher_generic_initiv(ctx, iv, ivlen))
77 if (keylen != ctx->keylen) {
78 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEYLEN);
81 return ctx->hw->init(ctx, key, keylen);
86 static int des_einit(void *vctx, const unsigned char *key, size_t keylen,
87 const unsigned char *iv, size_t ivlen)
89 return des_init(vctx, key, keylen, iv, ivlen, 1);
92 static int des_dinit(void *vctx, const unsigned char *key, size_t keylen,
93 const unsigned char *iv, size_t ivlen)
95 return des_init(vctx, key, keylen, iv, ivlen, 0);
98 static int des_generatekey(PROV_CIPHER_CTX *ctx, void *ptr)
101 DES_cblock *deskey = ptr;
102 size_t kl = ctx->keylen;
104 if (kl == 0 || RAND_priv_bytes_ex(ctx->libctx, ptr, kl) <= 0)
106 DES_set_odd_parity(deskey);
110 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_START(des)
111 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_RANDOM_KEY, NULL, 0),
112 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_END(des)
114 static int des_get_ctx_params(void *vctx, OSSL_PARAM params[])
116 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
119 if (!cipher_generic_get_ctx_params(vctx, params))
122 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_RANDOM_KEY);
123 if (p != NULL && !des_generatekey(ctx, p->data)) {
124 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GENERATE_KEY);
130 #define IMPLEMENT_des_cipher(type, lcmode, UCMODE, flags, \
131 kbits, blkbits, ivbits, block) \
132 static OSSL_OP_cipher_newctx_fn type##_##lcmode##_newctx; \
133 static void *des_##lcmode##_newctx(void *provctx) \
135 return des_newctx(provctx, kbits, blkbits, ivbits, \
136 EVP_CIPH_##UCMODE##_MODE, flags, \
137 PROV_CIPHER_HW_des_##lcmode()); \
139 static OSSL_OP_cipher_get_params_fn des_##lcmode##_get_params; \
140 static int des_##lcmode##_get_params(OSSL_PARAM params[]) \
142 return cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE, flags, \
143 kbits, blkbits, ivbits); \
145 const OSSL_DISPATCH des_##lcmode##_functions[] = { \
146 { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))des_einit }, \
147 { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))des_dinit }, \
148 { OSSL_FUNC_CIPHER_UPDATE, \
149 (void (*)(void))cipher_generic_##block##_update }, \
150 { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))cipher_generic_##block##_final },\
151 { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))cipher_generic_cipher }, \
152 { OSSL_FUNC_CIPHER_NEWCTX, \
153 (void (*)(void))des_##lcmode##_newctx }, \
154 { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void))des_dupctx }, \
155 { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))des_freectx }, \
156 { OSSL_FUNC_CIPHER_GET_PARAMS, \
157 (void (*)(void))des_##lcmode##_get_params }, \
158 { OSSL_FUNC_CIPHER_GETTABLE_PARAMS, \
159 (void (*)(void))cipher_generic_gettable_params }, \
160 { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, (void (*)(void))des_get_ctx_params }, \
161 { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS, \
162 (void (*)(void))des_gettable_ctx_params }, \
163 { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, \
164 (void (*)(void))cipher_generic_set_ctx_params }, \
165 { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS, \
166 (void (*)(void))cipher_generic_settable_ctx_params }, \
170 /* des_ecb_functions */
171 IMPLEMENT_des_cipher(des, ecb, ECB, DES_FLAGS, 64, 64, 0, block);
172 /* des_cbc_functions */
173 IMPLEMENT_des_cipher(des, cbc, CBC, DES_FLAGS, 64, 64, 64, block);
174 /* des_ofb64_functions */
175 IMPLEMENT_des_cipher(des, ofb64, OFB, DES_FLAGS, 64, 8, 64, stream);
176 /* des_cfb64_functions */
177 IMPLEMENT_des_cipher(des, cfb64, CFB, DES_FLAGS, 64, 8, 64, stream);
178 /* des_cfb1_functions */
179 IMPLEMENT_des_cipher(des, cfb1, CFB, DES_FLAGS, 64, 8, 64, stream);
180 /* des_cfb8_functions */
181 IMPLEMENT_des_cipher(des, cfb8, CFB, DES_FLAGS, 64, 8, 64, stream);