[thirdparty/openssl.git] / providers / implementations / ciphers / cipher_des.c

/*
 * Copyright 2019-2023 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

/*
 * DES low level APIs are deprecated for public use, but still ok for internal
 * use.
 */
#include "internal/deprecated.h"

#include <openssl/rand.h>
#include <openssl/proverr.h>
#include "prov/ciphercommon.h"
#include "cipher_des.h"
#include "prov/implementations.h"
#include "prov/providercommon.h"

#define DES_FLAGS PROV_CIPHER_FLAG_RAND_KEY

static OSSL_FUNC_cipher_freectx_fn des_freectx;
static OSSL_FUNC_cipher_encrypt_init_fn des_einit;
static OSSL_FUNC_cipher_decrypt_init_fn des_dinit;
static OSSL_FUNC_cipher_get_ctx_params_fn des_get_ctx_params;
static OSSL_FUNC_cipher_gettable_ctx_params_fn des_gettable_ctx_params;

static void *des_newctx(void *provctx, size_t kbits, size_t blkbits,
                        size_t ivbits, unsigned int mode, uint64_t flags,
                        const PROV_CIPHER_HW *hw)
{
    PROV_DES_CTX *ctx;

    if (!ossl_prov_is_running())
        return NULL;

    ctx = OPENSSL_zalloc(sizeof(*ctx));
    if (ctx != NULL)
        ossl_cipher_generic_initkey(ctx, kbits, blkbits, ivbits, mode, flags,
                                    hw, provctx);
    return ctx;
}

static void *des_dupctx(void *ctx)
{
    PROV_DES_CTX *in = (PROV_DES_CTX *)ctx;
    PROV_DES_CTX *ret;

    if (!ossl_prov_is_running())
        return NULL;

    ret = OPENSSL_malloc(sizeof(*ret));
    if (ret == NULL)
        return NULL;
    in->base.hw->copyctx(&ret->base, &in->base);

    return ret;
}

static void des_freectx(void *vctx)
{
    PROV_DES_CTX *ctx = (PROV_DES_CTX *)vctx;

    ossl_cipher_generic_reset_ctx((PROV_CIPHER_CTX *)vctx);
    OPENSSL_clear_free(ctx,  sizeof(*ctx));
}

static int des_init(void *vctx, const unsigned char *key, size_t keylen,
                    const unsigned char *iv, size_t ivlen,
                    const OSSL_PARAM params[], int enc)
{
    PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;

    if (!ossl_prov_is_running())
        return 0;

    ctx->num = 0;
    ctx->bufsz = 0;
    ctx->enc = enc;

    if (iv != NULL) {
        if (!ossl_cipher_generic_initiv(ctx, iv, ivlen))
            return 0;
    } else if (ctx->iv_set) {
        /* reset IV to keep compatibility with 1.1.1 */
        memcpy(ctx->iv, ctx->oiv, ctx->ivlen);
    }

    if (key != NULL) {
        if (keylen != ctx->keylen) {
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
            return 0;
        }
        if (!ctx->hw->init(ctx, key, keylen))
            return 0;
        ctx->key_set = 1;
    }
    return ossl_cipher_generic_set_ctx_params(ctx, params);
}

static int des_einit(void *vctx, const unsigned char *key, size_t keylen,
                     const unsigned char *iv, size_t ivlen,
                     const OSSL_PARAM params[])
{
    return des_init(vctx, key, keylen, iv, ivlen, params, 1);
}

static int des_dinit(void *vctx, const unsigned char *key, size_t keylen,
                     const unsigned char *iv, size_t ivlen,
                     const OSSL_PARAM params[])
{
    return des_init(vctx, key, keylen, iv, ivlen, params, 0);
}

static int des_generatekey(PROV_CIPHER_CTX *ctx, void *ptr)
{

    DES_cblock *deskey = ptr;
    size_t kl = ctx->keylen;

    if (kl == 0 || RAND_priv_bytes_ex(ctx->libctx, ptr, kl, 0) <= 0)
        return 0;
    DES_set_odd_parity(deskey);
    return 1;
}

CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_START(des)
    OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_RANDOM_KEY, NULL, 0),
CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_END(des)

static int des_get_ctx_params(void *vctx, OSSL_PARAM params[])
{
    PROV_CIPHER_CTX  *ctx = (PROV_CIPHER_CTX *)vctx;
    OSSL_PARAM *p;

    if (!ossl_cipher_generic_get_ctx_params(vctx, params))
        return 0;

    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_RANDOM_KEY);
    if (p != NULL && !des_generatekey(ctx, p->data)) {
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GENERATE_KEY);
        return 0;
    }
    return 1;
}

#define IMPLEMENT_des_cipher(type, lcmode, UCMODE, flags,                      \
                             kbits, blkbits, ivbits, block)                    \
static OSSL_FUNC_cipher_newctx_fn type##_##lcmode##_newctx;                    \
static void *des_##lcmode##_newctx(void *provctx)                              \
{                                                                              \
    return des_newctx(provctx, kbits, blkbits, ivbits,                         \
                      EVP_CIPH_##UCMODE##_MODE, flags,                         \
                      ossl_prov_cipher_hw_des_##lcmode());                          \
}                                                                              \
static OSSL_FUNC_cipher_get_params_fn des_##lcmode##_get_params;               \
static int des_##lcmode##_get_params(OSSL_PARAM params[])                      \
{                                                                              \
    return ossl_cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE,    \
                                          flags, kbits, blkbits, ivbits);      \
}                                                                              \
const OSSL_DISPATCH ossl_##des_##lcmode##_functions[] = {                      \
    { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))des_einit },              \
    { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))des_dinit },              \
    { OSSL_FUNC_CIPHER_UPDATE,                                                 \
      (void (*)(void))ossl_cipher_generic_##block##_update },                  \
    { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))ossl_cipher_generic_##block##_final },\
    { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))ossl_cipher_generic_cipher },   \
    { OSSL_FUNC_CIPHER_NEWCTX,                                                 \
      (void (*)(void))des_##lcmode##_newctx },                                 \
    { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void))des_dupctx },                   \
    { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))des_freectx },                 \
    { OSSL_FUNC_CIPHER_GET_PARAMS,                                             \
      (void (*)(void))des_##lcmode##_get_params },                             \
    { OSSL_FUNC_CIPHER_GETTABLE_PARAMS,                                        \
      (void (*)(void))ossl_cipher_generic_gettable_params },                   \
    { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, (void (*)(void))des_get_ctx_params },   \
    { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS,                                    \
      (void (*)(void))des_gettable_ctx_params },                               \
    { OSSL_FUNC_CIPHER_SET_CTX_PARAMS,                                         \
     (void (*)(void))ossl_cipher_generic_set_ctx_params },                     \
    { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS,                                    \
     (void (*)(void))ossl_cipher_generic_settable_ctx_params },                \
    OSSL_DISPATCH_END                                                          \
}

/* ossl_des_ecb_functions */
IMPLEMENT_des_cipher(des, ecb, ECB, DES_FLAGS, 64, 64, 0, block);
/* ossl_des_cbc_functions */
IMPLEMENT_des_cipher(des, cbc, CBC, DES_FLAGS, 64, 64, 64, block);
/* ossl_des_ofb64_functions */
IMPLEMENT_des_cipher(des, ofb64, OFB, DES_FLAGS, 64, 8, 64, stream);
/* ossl_des_cfb64_functions */
IMPLEMENT_des_cipher(des, cfb64, CFB, DES_FLAGS, 64, 8, 64, stream);
/* ossl_des_cfb1_functions */
IMPLEMENT_des_cipher(des, cfb1, CFB, DES_FLAGS, 64, 8, 64, stream);
/* ossl_des_cfb8_functions */
IMPLEMENT_des_cipher(des, cfb8, CFB, DES_FLAGS, 64, 8, 64, stream);
Commit	Line	Data
e3f3ee44	1	/*
da1c088f	2	* Copyright 2019-2023 The OpenSSL Project Authors. All Rights Reserved.
e3f3ee44 SL	3	*
	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
	8	*/
	9
c6fec81b P	10	/*
	11	* DES low level APIs are deprecated for public use, but still ok for internal
	12	* use.
	13	*/
	14	#include "internal/deprecated.h"
	15
2741128e TM	16	#include <openssl/rand.h>
2741128e TM	17	#include <openssl/proverr.h>
604e884b	18	#include "prov/ciphercommon.h"
e3f3ee44	19	#include "cipher_des.h"
af3e7e1b	20	#include "prov/implementations.h"
f99d3eed	21	#include "prov/providercommon.h"
e3f3ee44	22
f41fd10d	23	#define DES_FLAGS PROV_CIPHER_FLAG_RAND_KEY
e3f3ee44	24
363b1e5d DMSP	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;
e3f3ee44 SL	30
	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)
	34	{
f99d3eed	35	PROV_DES_CTX *ctx;
e3f3ee44	36
f99d3eed P	37	if (!ossl_prov_is_running())
	38	return NULL;
	39
	40	ctx = OPENSSL_zalloc(sizeof(*ctx));
e3f3ee44	41	if (ctx != NULL)
592dcfd3 P	42	ossl_cipher_generic_initkey(ctx, kbits, blkbits, ivbits, mode, flags,
592dcfd3 P	43	hw, provctx);
e3f3ee44 SL	44	return ctx;
	45	}
	46
abfc73f3 PS	47	static void des_dupctx(void ctx)
	48	{
	49	PROV_DES_CTX in = (PROV_DES_CTX )ctx;
f99d3eed	50	PROV_DES_CTX *ret;
abfc73f3	51
f99d3eed P	52	if (!ossl_prov_is_running())
	53	return NULL;
	54
	55	ret = OPENSSL_malloc(sizeof(*ret));
e077455e	56	if (ret == NULL)
abfc73f3	57	return NULL;
abfc73f3 PS	58	in->base.hw->copyctx(&ret->base, &in->base);
	59
	60	return ret;
	61	}
	62
e3f3ee44 SL	63	static void des_freectx(void *vctx)
e3f3ee44 SL	64	{
089cb623	65	PROV_DES_CTX ctx = (PROV_DES_CTX )vctx;
e3f3ee44	66
592dcfd3	67	ossl_cipher_generic_reset_ctx((PROV_CIPHER_CTX *)vctx);
e3f3ee44 SL	68	OPENSSL_clear_free(ctx, sizeof(*ctx));
	69	}
	70
	71	static int des_init(void vctx, const unsigned char key, size_t keylen,
deee9672 P	72	const unsigned char *iv, size_t ivlen,
deee9672 P	73	const OSSL_PARAM params[], int enc)
e3f3ee44 SL	74	{
	75	PROV_CIPHER_CTX ctx = (PROV_CIPHER_CTX )vctx;
	76
f99d3eed P	77	if (!ossl_prov_is_running())
	78	return 0;
	79
90409da6	80	ctx->num = 0;
914f97ee	81	ctx->bufsz = 0;
e3f3ee44 SL	82	ctx->enc = enc;
	83
	84	if (iv != NULL) {
592dcfd3	85	if (!ossl_cipher_generic_initiv(ctx, iv, ivlen))
e3f3ee44	86	return 0;
d6c6f6c5 TM	87	} else if (ctx->iv_set) {
	88	/* reset IV to keep compatibility with 1.1.1 */
	89	memcpy(ctx->iv, ctx->oiv, ctx->ivlen);
e3f3ee44 SL	90	}
	91
	92	if (key != NULL) {
	93	if (keylen != ctx->keylen) {
f5f29796	94	ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
e3f3ee44 SL	95	return 0;
e3f3ee44 SL	96	}
deee9672 P	97	if (!ctx->hw->init(ctx, key, keylen))
deee9672 P	98	return 0;
3a95d1e4	99	ctx->key_set = 1;
e3f3ee44	100	}
deee9672	101	return ossl_cipher_generic_set_ctx_params(ctx, params);
e3f3ee44 SL	102	}
	103
	104	static int des_einit(void vctx, const unsigned char key, size_t keylen,
deee9672 P	105	const unsigned char *iv, size_t ivlen,
deee9672 P	106	const OSSL_PARAM params[])
e3f3ee44	107	{
deee9672	108	return des_init(vctx, key, keylen, iv, ivlen, params, 1);
e3f3ee44 SL	109	}
	110
	111	static int des_dinit(void vctx, const unsigned char key, size_t keylen,
deee9672 P	112	const unsigned char *iv, size_t ivlen,
deee9672 P	113	const OSSL_PARAM params[])
e3f3ee44	114	{
deee9672	115	return des_init(vctx, key, keylen, iv, ivlen, params, 0);
e3f3ee44 SL	116	}
	117
	118	static int des_generatekey(PROV_CIPHER_CTX ctx, void ptr)
	119	{
	120
	121	DES_cblock *deskey = ptr;
	122	size_t kl = ctx->keylen;
	123
965fa9c0	124	if (kl == 0 \|\| RAND_priv_bytes_ex(ctx->libctx, ptr, kl, 0) <= 0)
e3f3ee44 SL	125	return 0;
	126	DES_set_odd_parity(deskey);
	127	return 1;
	128	}
	129
	130	CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_START(des)
	131	OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_RANDOM_KEY, NULL, 0),
	132	CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_END(des)
	133
	134	static int des_get_ctx_params(void *vctx, OSSL_PARAM params[])
	135	{
	136	PROV_CIPHER_CTX ctx = (PROV_CIPHER_CTX )vctx;
	137	OSSL_PARAM *p;
	138
592dcfd3	139	if (!ossl_cipher_generic_get_ctx_params(vctx, params))
e3f3ee44 SL	140	return 0;
	141
	142	p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_RANDOM_KEY);
	143	if (p != NULL && !des_generatekey(ctx, p->data)) {
	144	ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GENERATE_KEY);
	145	return 0;
	146	}
	147	return 1;
	148	}
	149
	150	#define IMPLEMENT_des_cipher(type, lcmode, UCMODE, flags, \
	151	kbits, blkbits, ivbits, block) \
363b1e5d	152	static OSSL_FUNC_cipher_newctx_fn type##_##lcmode##_newctx; \
e3f3ee44 SL	153	static void des_##lcmode##_newctx(void provctx) \
	154	{ \
	155	return des_newctx(provctx, kbits, blkbits, ivbits, \
	156	EVP_CIPH_##UCMODE##_MODE, flags, \
e36b3c2f	157	ossl_prov_cipher_hw_des_##lcmode()); \
e3f3ee44	158	} \
363b1e5d	159	static OSSL_FUNC_cipher_get_params_fn des_##lcmode##_get_params; \
e3f3ee44 SL	160	static int des_##lcmode##_get_params(OSSL_PARAM params[]) \
e3f3ee44 SL	161	{ \
592dcfd3 P	162	return ossl_cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE, \
592dcfd3 P	163	flags, kbits, blkbits, ivbits); \
e3f3ee44	164	} \
1be63951	165	const OSSL_DISPATCH ossl_##des_##lcmode##_functions[] = { \
e3f3ee44 SL	166	{ OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))des_einit }, \
	167	{ OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))des_dinit }, \
	168	{ OSSL_FUNC_CIPHER_UPDATE, \
592dcfd3 P	169	(void (*)(void))ossl_cipher_generic_##block##_update }, \
	170	{ OSSL_FUNC_CIPHER_FINAL, (void (*)(void))ossl_cipher_generic_##block##_final },\
	171	{ OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))ossl_cipher_generic_cipher }, \
e3f3ee44 SL	172	{ OSSL_FUNC_CIPHER_NEWCTX, \
e3f3ee44 SL	173	(void (*)(void))des_##lcmode##_newctx }, \
abfc73f3	174	{ OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void))des_dupctx }, \
e3f3ee44 SL	175	{ OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))des_freectx }, \
	176	{ OSSL_FUNC_CIPHER_GET_PARAMS, \
	177	(void (*)(void))des_##lcmode##_get_params }, \
	178	{ OSSL_FUNC_CIPHER_GETTABLE_PARAMS, \
592dcfd3	179	(void (*)(void))ossl_cipher_generic_gettable_params }, \
e3f3ee44 SL	180	{ OSSL_FUNC_CIPHER_GET_CTX_PARAMS, (void (*)(void))des_get_ctx_params }, \
	181	{ OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS, \
	182	(void (*)(void))des_gettable_ctx_params }, \
	183	{ OSSL_FUNC_CIPHER_SET_CTX_PARAMS, \
592dcfd3	184	(void (*)(void))ossl_cipher_generic_set_ctx_params }, \
e3f3ee44	185	{ OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS, \
592dcfd3	186	(void (*)(void))ossl_cipher_generic_settable_ctx_params }, \
1e6bd31e	187	OSSL_DISPATCH_END \
e3f3ee44 SL	188	}
e3f3ee44 SL	189
1be63951	190	/* ossl_des_ecb_functions */
e3f3ee44	191	IMPLEMENT_des_cipher(des, ecb, ECB, DES_FLAGS, 64, 64, 0, block);
1be63951	192	/* ossl_des_cbc_functions */
e3f3ee44	193	IMPLEMENT_des_cipher(des, cbc, CBC, DES_FLAGS, 64, 64, 64, block);
1be63951	194	/* ossl_des_ofb64_functions */
e3f3ee44	195	IMPLEMENT_des_cipher(des, ofb64, OFB, DES_FLAGS, 64, 8, 64, stream);
1be63951	196	/* ossl_des_cfb64_functions */
e3f3ee44	197	IMPLEMENT_des_cipher(des, cfb64, CFB, DES_FLAGS, 64, 8, 64, stream);
1be63951	198	/* ossl_des_cfb1_functions */
e3f3ee44	199	IMPLEMENT_des_cipher(des, cfb1, CFB, DES_FLAGS, 64, 8, 64, stream);
1be63951	200	/* ossl_des_cfb8_functions */
e3f3ee44	201	IMPLEMENT_des_cipher(des, cfb8, CFB, DES_FLAGS, 64, 8, 64, stream);