Deprecate Low Level Camellia APIs
[openssl.git] / crypto / evp / e_camellia.c
1 /*
2  * Copyright 2006-2018 The OpenSSL Project Authors. All Rights Reserved.
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
10 /*
11  * Camellia low level APIs are deprecated for public use, but still ok for
12  * internal use.
13  */
14 #include "internal/deprecated.h"
15
16 #include <openssl/opensslconf.h>
17 #ifdef OPENSSL_NO_CAMELLIA
18 NON_EMPTY_TRANSLATION_UNIT
19 #else
20
21 # include <openssl/evp.h>
22 # include <openssl/err.h>
23 # include <string.h>
24 # include <assert.h>
25 # include <openssl/camellia.h>
26 # include "crypto/evp.h"
27 # include "crypto/modes.h"
28 # include "crypto/cmll_platform.h"
29
30 static int camellia_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
31                              const unsigned char *iv, int enc);
32
33 /* Camellia subkey Structure */
34 typedef struct {
35     CAMELLIA_KEY ks;
36     block128_f block;
37     union {
38         cbc128_f cbc;
39         ctr128_f ctr;
40     } stream;
41 } EVP_CAMELLIA_KEY;
42
43 # define MAXBITCHUNK     ((size_t)1<<(sizeof(size_t)*8-4))
44
45 /* Attribute operation for Camellia */
46 # define data(ctx)       EVP_C_DATA(EVP_CAMELLIA_KEY,ctx)
47
48 # if defined(AES_ASM) && (defined(__sparc) || defined(__sparc__))
49 /* ---------^^^ this is not a typo, just a way to detect that
50  * assembler support was in general requested... */
51 #  include "sparc_arch.h"
52
53
54 static int cmll_t4_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
55                             const unsigned char *iv, int enc)
56 {
57     int ret, mode, bits;
58     EVP_CAMELLIA_KEY *dat =
59         (EVP_CAMELLIA_KEY *)EVP_CIPHER_CTX_get_cipher_data(ctx);
60
61     mode = EVP_CIPHER_CTX_mode(ctx);
62     bits = EVP_CIPHER_CTX_key_length(ctx) * 8;
63
64     cmll_t4_set_key(key, bits, &dat->ks);
65
66     if ((mode == EVP_CIPH_ECB_MODE || mode == EVP_CIPH_CBC_MODE)
67         && !enc) {
68         ret = 0;
69         dat->block = (block128_f) cmll_t4_decrypt;
70         switch (bits) {
71         case 128:
72             dat->stream.cbc = mode == EVP_CIPH_CBC_MODE ?
73                 (cbc128_f) cmll128_t4_cbc_decrypt : NULL;
74             break;
75         case 192:
76         case 256:
77             dat->stream.cbc = mode == EVP_CIPH_CBC_MODE ?
78                 (cbc128_f) cmll256_t4_cbc_decrypt : NULL;
79             break;
80         default:
81             ret = -1;
82         }
83     } else {
84         ret = 0;
85         dat->block = (block128_f) cmll_t4_encrypt;
86         switch (bits) {
87         case 128:
88             if (mode == EVP_CIPH_CBC_MODE)
89                 dat->stream.cbc = (cbc128_f) cmll128_t4_cbc_encrypt;
90             else if (mode == EVP_CIPH_CTR_MODE)
91                 dat->stream.ctr = (ctr128_f) cmll128_t4_ctr32_encrypt;
92             else
93                 dat->stream.cbc = NULL;
94             break;
95         case 192:
96         case 256:
97             if (mode == EVP_CIPH_CBC_MODE)
98                 dat->stream.cbc = (cbc128_f) cmll256_t4_cbc_encrypt;
99             else if (mode == EVP_CIPH_CTR_MODE)
100                 dat->stream.ctr = (ctr128_f) cmll256_t4_ctr32_encrypt;
101             else
102                 dat->stream.cbc = NULL;
103             break;
104         default:
105             ret = -1;
106         }
107     }
108
109     if (ret < 0) {
110         EVPerr(EVP_F_CMLL_T4_INIT_KEY, EVP_R_CAMELLIA_KEY_SETUP_FAILED);
111         return 0;
112     }
113
114     return 1;
115 }
116
117 #  define cmll_t4_cbc_cipher camellia_cbc_cipher
118 static int cmll_t4_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
119                               const unsigned char *in, size_t len);
120
121 #  define cmll_t4_ecb_cipher camellia_ecb_cipher
122 static int cmll_t4_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
123                               const unsigned char *in, size_t len);
124
125 #  define cmll_t4_ofb_cipher camellia_ofb_cipher
126 static int cmll_t4_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
127                               const unsigned char *in, size_t len);
128
129 #  define cmll_t4_cfb_cipher camellia_cfb_cipher
130 static int cmll_t4_cfb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
131                               const unsigned char *in, size_t len);
132
133 #  define cmll_t4_cfb8_cipher camellia_cfb8_cipher
134 static int cmll_t4_cfb8_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
135                                const unsigned char *in, size_t len);
136
137 #  define cmll_t4_cfb1_cipher camellia_cfb1_cipher
138 static int cmll_t4_cfb1_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
139                                const unsigned char *in, size_t len);
140
141 #  define cmll_t4_ctr_cipher camellia_ctr_cipher
142 static int cmll_t4_ctr_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
143                               const unsigned char *in, size_t len);
144
145 #  define BLOCK_CIPHER_generic(nid,keylen,blocksize,ivlen,nmode,mode,MODE,flags) \
146 static const EVP_CIPHER cmll_t4_##keylen##_##mode = { \
147         nid##_##keylen##_##nmode,blocksize,keylen/8,ivlen, \
148         flags|EVP_CIPH_##MODE##_MODE,   \
149         cmll_t4_init_key,               \
150         cmll_t4_##mode##_cipher,        \
151         NULL,                           \
152         sizeof(EVP_CAMELLIA_KEY),       \
153         NULL,NULL,NULL,NULL }; \
154 static const EVP_CIPHER camellia_##keylen##_##mode = { \
155         nid##_##keylen##_##nmode,blocksize,     \
156         keylen/8,ivlen, \
157         flags|EVP_CIPH_##MODE##_MODE,   \
158         camellia_init_key,              \
159         camellia_##mode##_cipher,       \
160         NULL,                           \
161         sizeof(EVP_CAMELLIA_KEY),       \
162         NULL,NULL,NULL,NULL }; \
163 const EVP_CIPHER *EVP_camellia_##keylen##_##mode(void) \
164 { return SPARC_CMLL_CAPABLE?&cmll_t4_##keylen##_##mode:&camellia_##keylen##_##mode; }
165
166 # else
167
168 #  define BLOCK_CIPHER_generic(nid,keylen,blocksize,ivlen,nmode,mode,MODE,flags) \
169 static const EVP_CIPHER camellia_##keylen##_##mode = { \
170         nid##_##keylen##_##nmode,blocksize,keylen/8,ivlen, \
171         flags|EVP_CIPH_##MODE##_MODE,   \
172         camellia_init_key,              \
173         camellia_##mode##_cipher,       \
174         NULL,                           \
175         sizeof(EVP_CAMELLIA_KEY),       \
176         NULL,NULL,NULL,NULL }; \
177 const EVP_CIPHER *EVP_camellia_##keylen##_##mode(void) \
178 { return &camellia_##keylen##_##mode; }
179
180 # endif
181
182 # define BLOCK_CIPHER_generic_pack(nid,keylen,flags)             \
183         BLOCK_CIPHER_generic(nid,keylen,16,16,cbc,cbc,CBC,flags|EVP_CIPH_FLAG_DEFAULT_ASN1)     \
184         BLOCK_CIPHER_generic(nid,keylen,16,0,ecb,ecb,ECB,flags|EVP_CIPH_FLAG_DEFAULT_ASN1)      \
185         BLOCK_CIPHER_generic(nid,keylen,1,16,ofb128,ofb,OFB,flags|EVP_CIPH_FLAG_DEFAULT_ASN1)   \
186         BLOCK_CIPHER_generic(nid,keylen,1,16,cfb128,cfb,CFB,flags|EVP_CIPH_FLAG_DEFAULT_ASN1)   \
187         BLOCK_CIPHER_generic(nid,keylen,1,16,cfb1,cfb1,CFB,flags)       \
188         BLOCK_CIPHER_generic(nid,keylen,1,16,cfb8,cfb8,CFB,flags)       \
189         BLOCK_CIPHER_generic(nid, keylen, 1, 16, ctr, ctr, CTR, flags)
190
191 /* The subkey for Camellia is generated. */
192 static int camellia_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
193                              const unsigned char *iv, int enc)
194 {
195     int ret, mode;
196     EVP_CAMELLIA_KEY *dat = EVP_C_DATA(EVP_CAMELLIA_KEY,ctx);
197
198     ret = Camellia_set_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8, &dat->ks);
199     if (ret < 0) {
200         EVPerr(EVP_F_CAMELLIA_INIT_KEY, EVP_R_CAMELLIA_KEY_SETUP_FAILED);
201         return 0;
202     }
203
204     mode = EVP_CIPHER_CTX_mode(ctx);
205     if ((mode == EVP_CIPH_ECB_MODE || mode == EVP_CIPH_CBC_MODE)
206         && !enc) {
207         dat->block = (block128_f) Camellia_decrypt;
208         dat->stream.cbc = mode == EVP_CIPH_CBC_MODE ?
209             (cbc128_f) Camellia_cbc_encrypt : NULL;
210     } else {
211         dat->block = (block128_f) Camellia_encrypt;
212         dat->stream.cbc = mode == EVP_CIPH_CBC_MODE ?
213             (cbc128_f) Camellia_cbc_encrypt : NULL;
214     }
215
216     return 1;
217 }
218
219 static int camellia_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
220                                const unsigned char *in, size_t len)
221 {
222     EVP_CAMELLIA_KEY *dat = EVP_C_DATA(EVP_CAMELLIA_KEY,ctx);
223
224     if (dat->stream.cbc)
225         (*dat->stream.cbc) (in, out, len, &dat->ks,
226                             EVP_CIPHER_CTX_iv_noconst(ctx),
227                             EVP_CIPHER_CTX_encrypting(ctx));
228     else if (EVP_CIPHER_CTX_encrypting(ctx))
229         CRYPTO_cbc128_encrypt(in, out, len, &dat->ks,
230                               EVP_CIPHER_CTX_iv_noconst(ctx), dat->block);
231     else
232         CRYPTO_cbc128_decrypt(in, out, len, &dat->ks,
233                               EVP_CIPHER_CTX_iv_noconst(ctx), dat->block);
234
235     return 1;
236 }
237
238 static int camellia_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
239                                const unsigned char *in, size_t len)
240 {
241     size_t bl = EVP_CIPHER_CTX_block_size(ctx);
242     size_t i;
243     EVP_CAMELLIA_KEY *dat = EVP_C_DATA(EVP_CAMELLIA_KEY,ctx);
244
245     if (len < bl)
246         return 1;
247
248     for (i = 0, len -= bl; i <= len; i += bl)
249         (*dat->block) (in + i, out + i, &dat->ks);
250
251     return 1;
252 }
253
254 static int camellia_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
255                                const unsigned char *in, size_t len)
256 {
257     EVP_CAMELLIA_KEY *dat = EVP_C_DATA(EVP_CAMELLIA_KEY,ctx);
258
259     int num = EVP_CIPHER_CTX_num(ctx);
260     CRYPTO_ofb128_encrypt(in, out, len, &dat->ks,
261                           EVP_CIPHER_CTX_iv_noconst(ctx), &num, dat->block);
262     EVP_CIPHER_CTX_set_num(ctx, num);
263     return 1;
264 }
265
266 static int camellia_cfb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
267                                const unsigned char *in, size_t len)
268 {
269     EVP_CAMELLIA_KEY *dat = EVP_C_DATA(EVP_CAMELLIA_KEY,ctx);
270
271     int num = EVP_CIPHER_CTX_num(ctx);
272     CRYPTO_cfb128_encrypt(in, out, len, &dat->ks,
273                           EVP_CIPHER_CTX_iv_noconst(ctx), &num, EVP_CIPHER_CTX_encrypting(ctx), dat->block);
274     EVP_CIPHER_CTX_set_num(ctx, num);
275     return 1;
276 }
277
278 static int camellia_cfb8_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
279                                 const unsigned char *in, size_t len)
280 {
281     EVP_CAMELLIA_KEY *dat = EVP_C_DATA(EVP_CAMELLIA_KEY,ctx);
282
283     int num = EVP_CIPHER_CTX_num(ctx);
284     CRYPTO_cfb128_8_encrypt(in, out, len, &dat->ks,
285                             EVP_CIPHER_CTX_iv_noconst(ctx), &num, EVP_CIPHER_CTX_encrypting(ctx), dat->block);
286     EVP_CIPHER_CTX_set_num(ctx, num);
287     return 1;
288 }
289
290 static int camellia_cfb1_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
291                                 const unsigned char *in, size_t len)
292 {
293     EVP_CAMELLIA_KEY *dat = EVP_C_DATA(EVP_CAMELLIA_KEY,ctx);
294
295     if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS)) {
296         int num = EVP_CIPHER_CTX_num(ctx);
297         CRYPTO_cfb128_1_encrypt(in, out, len, &dat->ks,
298                                 EVP_CIPHER_CTX_iv_noconst(ctx), &num, EVP_CIPHER_CTX_encrypting(ctx), dat->block);
299         EVP_CIPHER_CTX_set_num(ctx, num);
300         return 1;
301     }
302
303     while (len >= MAXBITCHUNK) {
304         int num = EVP_CIPHER_CTX_num(ctx);
305         CRYPTO_cfb128_1_encrypt(in, out, MAXBITCHUNK * 8, &dat->ks,
306                                 EVP_CIPHER_CTX_iv_noconst(ctx), &num, EVP_CIPHER_CTX_encrypting(ctx), dat->block);
307         EVP_CIPHER_CTX_set_num(ctx, num);
308         len -= MAXBITCHUNK;
309         out += MAXBITCHUNK;
310         in  += MAXBITCHUNK;
311     }
312     if (len) {
313         int num = EVP_CIPHER_CTX_num(ctx);
314         CRYPTO_cfb128_1_encrypt(in, out, len * 8, &dat->ks,
315                                 EVP_CIPHER_CTX_iv_noconst(ctx), &num, EVP_CIPHER_CTX_encrypting(ctx), dat->block);
316         EVP_CIPHER_CTX_set_num(ctx, num);
317     }
318
319     return 1;
320 }
321
322 static int camellia_ctr_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
323                                const unsigned char *in, size_t len)
324 {
325     unsigned int num = EVP_CIPHER_CTX_num(ctx);
326     EVP_CAMELLIA_KEY *dat = EVP_C_DATA(EVP_CAMELLIA_KEY,ctx);
327
328     if (dat->stream.ctr)
329         CRYPTO_ctr128_encrypt_ctr32(in, out, len, &dat->ks,
330                                     EVP_CIPHER_CTX_iv_noconst(ctx),
331                                     EVP_CIPHER_CTX_buf_noconst(ctx), &num,
332                                     dat->stream.ctr);
333     else
334         CRYPTO_ctr128_encrypt(in, out, len, &dat->ks,
335                               EVP_CIPHER_CTX_iv_noconst(ctx),
336                               EVP_CIPHER_CTX_buf_noconst(ctx), &num,
337                               dat->block);
338     EVP_CIPHER_CTX_set_num(ctx, num);
339     return 1;
340 }
341
342 BLOCK_CIPHER_generic_pack(NID_camellia, 128, 0)
343     BLOCK_CIPHER_generic_pack(NID_camellia, 192, 0)
344     BLOCK_CIPHER_generic_pack(NID_camellia, 256, 0)
345 #endif