2 * Copyright 1995-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 and SHA-1 low level APIs are deprecated for public use, but still ok for
14 #include "internal/deprecated.h"
16 #include <openssl/sha.h>
17 #include <openssl/rand.h>
18 #include "cipher_tdes_default.h"
19 #include "crypto/evp.h"
20 #include "prov/implementations.h"
21 #include "prov/providercommon.h"
22 #include "prov/providercommonerr.h"
24 #define TDES_WRAP_FLAGS PROV_CIPHER_FLAG_CUSTOM_IV
26 static OSSL_FUNC_cipher_update_fn tdes_wrap_update;
27 static OSSL_FUNC_cipher_cipher_fn tdes_wrap_cipher;
29 static const unsigned char wrap_iv[8] =
31 0x4a, 0xdd, 0xa2, 0x2c, 0x79, 0xe8, 0x21, 0x05
34 static int des_ede3_unwrap(PROV_CIPHER_CTX *ctx, unsigned char *out,
35 const unsigned char *in, size_t inl)
37 unsigned char icv[8], iv[TDES_IVLEN], sha1tmp[SHA_DIGEST_LENGTH];
45 memcpy(ctx->iv, wrap_iv, 8);
46 /* Decrypt first block which will end up as icv */
47 ctx->hw->cipher(ctx, icv, in, 8);
48 /* Decrypt central blocks */
50 * If decrypting in place move whole output along a block so the next
51 * des_ede_cbc_cipher is in place.
54 memmove(out, out + 8, inl - 8);
57 ctx->hw->cipher(ctx, out, in + 8, inl - 16);
58 /* Decrypt final block which will be IV */
59 ctx->hw->cipher(ctx, iv, in + inl - 8, 8);
60 /* Reverse order of everything */
61 BUF_reverse(icv, NULL, 8);
62 BUF_reverse(out, NULL, inl - 16);
63 BUF_reverse(ctx->iv, iv, 8);
64 /* Decrypt again using new IV */
65 ctx->hw->cipher(ctx, out, out, inl - 16);
66 ctx->hw->cipher(ctx, icv, icv, 8);
67 /* Work out SHA1 hash of first portion */
68 SHA1(out, inl - 16, sha1tmp);
70 if (!CRYPTO_memcmp(sha1tmp, icv, 8))
72 OPENSSL_cleanse(icv, 8);
73 OPENSSL_cleanse(sha1tmp, SHA_DIGEST_LENGTH);
74 OPENSSL_cleanse(iv, 8);
75 OPENSSL_cleanse(ctx->iv, sizeof(ctx->iv));
77 OPENSSL_cleanse(out, inl - 16);
82 static int des_ede3_wrap(PROV_CIPHER_CTX *ctx, unsigned char *out,
83 const unsigned char *in, size_t inl)
85 unsigned char sha1tmp[SHA_DIGEST_LENGTH];
86 size_t ivlen = TDES_IVLEN;
87 size_t icvlen = TDES_IVLEN;
88 size_t len = inl + ivlen + icvlen;
93 /* Copy input to output buffer + 8 so we have space for IV */
94 memmove(out + ivlen, in, inl);
96 SHA1(in, inl, sha1tmp);
97 memcpy(out + inl + ivlen, sha1tmp, icvlen);
98 OPENSSL_cleanse(sha1tmp, SHA_DIGEST_LENGTH);
99 /* Generate random IV */
100 if (RAND_bytes_ex(ctx->libctx, ctx->iv, ivlen) <= 0)
102 memcpy(out, ctx->iv, ivlen);
103 /* Encrypt everything after IV in place */
104 ctx->hw->cipher(ctx, out + ivlen, out + ivlen, inl + ivlen);
105 BUF_reverse(out, NULL, len);
106 memcpy(ctx->iv, wrap_iv, ivlen);
107 ctx->hw->cipher(ctx, out, out, len);
111 static int tdes_wrap_cipher_internal(PROV_CIPHER_CTX *ctx, unsigned char *out,
112 const unsigned char *in, size_t inl)
115 * Sanity check input length: we typically only wrap keys so EVP_MAXCHUNK
116 * is more than will ever be needed. Also input length must be a multiple
119 if (inl >= EVP_MAXCHUNK || inl % 8)
122 return des_ede3_wrap(ctx, out, in, inl);
124 return des_ede3_unwrap(ctx, out, in, inl);
127 static int tdes_wrap_cipher(void *vctx,
128 unsigned char *out, size_t *outl, size_t outsize,
129 const unsigned char *in, size_t inl)
131 PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
135 if (!ossl_prov_is_running())
139 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
143 ret = tdes_wrap_cipher_internal(ctx, out, in, inl);
151 static int tdes_wrap_update(void *vctx, unsigned char *out, size_t *outl,
152 size_t outsize, const unsigned char *in,
159 ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
163 if (!tdes_wrap_cipher(vctx, out, outl, outsize, in, inl)) {
164 ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
171 # define IMPLEMENT_WRAP_CIPHER(flags, kbits, blkbits, ivbits) \
172 static OSSL_FUNC_cipher_newctx_fn tdes_wrap_newctx; \
173 static void *tdes_wrap_newctx(void *provctx) \
175 return tdes_newctx(provctx, EVP_CIPH_WRAP_MODE, kbits, blkbits, ivbits, \
176 flags, ossl_prov_cipher_hw_tdes_wrap_cbc()); \
178 static OSSL_FUNC_cipher_get_params_fn tdes_wrap_get_params; \
179 static int tdes_wrap_get_params(OSSL_PARAM params[]) \
181 return ossl_cipher_generic_get_params(params, EVP_CIPH_WRAP_MODE, flags, \
182 kbits, blkbits, ivbits); \
184 const OSSL_DISPATCH ossl_tdes_wrap_cbc_functions[] = \
186 { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void)) tdes_einit }, \
187 { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void)) tdes_dinit }, \
188 { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))tdes_wrap_cipher }, \
189 { OSSL_FUNC_CIPHER_NEWCTX, (void (*)(void))tdes_wrap_newctx }, \
190 { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))tdes_freectx }, \
191 { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))tdes_wrap_update }, \
192 { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))ossl_cipher_generic_stream_final },\
193 { OSSL_FUNC_CIPHER_GET_PARAMS, (void (*)(void))tdes_wrap_get_params }, \
194 { OSSL_FUNC_CIPHER_GETTABLE_PARAMS, \
195 (void (*)(void))ossl_cipher_generic_gettable_params }, \
196 { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, (void (*)(void))tdes_get_ctx_params }, \
197 { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS, \
198 (void (*)(void))tdes_gettable_ctx_params }, \
199 { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, \
200 (void (*)(void))ossl_cipher_generic_set_ctx_params }, \
201 { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS, \
202 (void (*)(void))ossl_cipher_generic_settable_ctx_params }, \
206 /* ossl_tdes_wrap_cbc_functions */
207 IMPLEMENT_WRAP_CIPHER(TDES_WRAP_FLAGS, 64*3, 64, 0);