1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Glue Code for assembler optimized version of 3DES
5 * Copyright © 2014 Jussi Kivilinna <jussi.kivilinna@mbnet.fi>
7 * CBC & ECB parts based on code (crypto/cbc.c,ecb.c) by:
8 * Copyright (c) 2006 Herbert Xu <herbert@gondor.apana.org.au>
9 * CTR part based on code (crypto/ctr.c) by:
10 * (C) Copyright IBM Corp. 2007 - Joy Latten <latten@us.ibm.com>
13 #include <crypto/algapi.h>
14 #include <crypto/des.h>
15 #include <crypto/internal/skcipher.h>
16 #include <linux/crypto.h>
17 #include <linux/init.h>
18 #include <linux/module.h>
19 #include <linux/types.h>
21 struct des3_ede_x86_ctx {
22 u32 enc_expkey[DES3_EDE_EXPKEY_WORDS];
23 u32 dec_expkey[DES3_EDE_EXPKEY_WORDS];
26 /* regular block cipher functions */
27 asmlinkage void des3_ede_x86_64_crypt_blk(const u32 *expkey, u8 *dst,
30 /* 3-way parallel cipher functions */
31 asmlinkage void des3_ede_x86_64_crypt_blk_3way(const u32 *expkey, u8 *dst,
34 static inline void des3_ede_enc_blk(struct des3_ede_x86_ctx *ctx, u8 *dst,
37 u32 *enc_ctx = ctx->enc_expkey;
39 des3_ede_x86_64_crypt_blk(enc_ctx, dst, src);
42 static inline void des3_ede_dec_blk(struct des3_ede_x86_ctx *ctx, u8 *dst,
45 u32 *dec_ctx = ctx->dec_expkey;
47 des3_ede_x86_64_crypt_blk(dec_ctx, dst, src);
50 static inline void des3_ede_enc_blk_3way(struct des3_ede_x86_ctx *ctx, u8 *dst,
53 u32 *enc_ctx = ctx->enc_expkey;
55 des3_ede_x86_64_crypt_blk_3way(enc_ctx, dst, src);
58 static inline void des3_ede_dec_blk_3way(struct des3_ede_x86_ctx *ctx, u8 *dst,
61 u32 *dec_ctx = ctx->dec_expkey;
63 des3_ede_x86_64_crypt_blk_3way(dec_ctx, dst, src);
66 static void des3_ede_x86_encrypt(struct crypto_tfm *tfm, u8 *dst, const u8 *src)
68 des3_ede_enc_blk(crypto_tfm_ctx(tfm), dst, src);
71 static void des3_ede_x86_decrypt(struct crypto_tfm *tfm, u8 *dst, const u8 *src)
73 des3_ede_dec_blk(crypto_tfm_ctx(tfm), dst, src);
76 static int ecb_crypt(struct skcipher_request *req, const u32 *expkey)
78 const unsigned int bsize = DES3_EDE_BLOCK_SIZE;
79 struct skcipher_walk walk;
83 err = skcipher_walk_virt(&walk, req, false);
85 while ((nbytes = walk.nbytes)) {
86 u8 *wsrc = walk.src.virt.addr;
87 u8 *wdst = walk.dst.virt.addr;
89 /* Process four block batch */
90 if (nbytes >= bsize * 3) {
92 des3_ede_x86_64_crypt_blk_3way(expkey, wdst,
98 } while (nbytes >= bsize * 3);
104 /* Handle leftovers */
106 des3_ede_x86_64_crypt_blk(expkey, wdst, wsrc);
111 } while (nbytes >= bsize);
114 err = skcipher_walk_done(&walk, nbytes);
120 static int ecb_encrypt(struct skcipher_request *req)
122 struct crypto_skcipher *tfm = crypto_skcipher_reqtfm(req);
123 struct des3_ede_x86_ctx *ctx = crypto_skcipher_ctx(tfm);
125 return ecb_crypt(req, ctx->enc_expkey);
128 static int ecb_decrypt(struct skcipher_request *req)
130 struct crypto_skcipher *tfm = crypto_skcipher_reqtfm(req);
131 struct des3_ede_x86_ctx *ctx = crypto_skcipher_ctx(tfm);
133 return ecb_crypt(req, ctx->dec_expkey);
136 static unsigned int __cbc_encrypt(struct des3_ede_x86_ctx *ctx,
137 struct skcipher_walk *walk)
139 unsigned int bsize = DES3_EDE_BLOCK_SIZE;
140 unsigned int nbytes = walk->nbytes;
141 u64 *src = (u64 *)walk->src.virt.addr;
142 u64 *dst = (u64 *)walk->dst.virt.addr;
143 u64 *iv = (u64 *)walk->iv;
147 des3_ede_enc_blk(ctx, (u8 *)dst, (u8 *)dst);
153 } while (nbytes >= bsize);
155 *(u64 *)walk->iv = *iv;
159 static int cbc_encrypt(struct skcipher_request *req)
161 struct crypto_skcipher *tfm = crypto_skcipher_reqtfm(req);
162 struct des3_ede_x86_ctx *ctx = crypto_skcipher_ctx(tfm);
163 struct skcipher_walk walk;
167 err = skcipher_walk_virt(&walk, req, false);
169 while ((nbytes = walk.nbytes)) {
170 nbytes = __cbc_encrypt(ctx, &walk);
171 err = skcipher_walk_done(&walk, nbytes);
177 static unsigned int __cbc_decrypt(struct des3_ede_x86_ctx *ctx,
178 struct skcipher_walk *walk)
180 unsigned int bsize = DES3_EDE_BLOCK_SIZE;
181 unsigned int nbytes = walk->nbytes;
182 u64 *src = (u64 *)walk->src.virt.addr;
183 u64 *dst = (u64 *)walk->dst.virt.addr;
187 /* Start of the last block. */
188 src += nbytes / bsize - 1;
189 dst += nbytes / bsize - 1;
193 /* Process four block batch */
194 if (nbytes >= bsize * 3) {
196 nbytes -= bsize * 3 - bsize;
203 des3_ede_dec_blk_3way(ctx, (u8 *)dst, (u8 *)src);
215 } while (nbytes >= bsize * 3);
218 /* Handle leftovers */
220 des3_ede_dec_blk(ctx, (u8 *)dst, (u8 *)src);
232 *dst ^= *(u64 *)walk->iv;
233 *(u64 *)walk->iv = last_iv;
238 static int cbc_decrypt(struct skcipher_request *req)
240 struct crypto_skcipher *tfm = crypto_skcipher_reqtfm(req);
241 struct des3_ede_x86_ctx *ctx = crypto_skcipher_ctx(tfm);
242 struct skcipher_walk walk;
246 err = skcipher_walk_virt(&walk, req, false);
248 while ((nbytes = walk.nbytes)) {
249 nbytes = __cbc_decrypt(ctx, &walk);
250 err = skcipher_walk_done(&walk, nbytes);
256 static void ctr_crypt_final(struct des3_ede_x86_ctx *ctx,
257 struct skcipher_walk *walk)
259 u8 *ctrblk = walk->iv;
260 u8 keystream[DES3_EDE_BLOCK_SIZE];
261 u8 *src = walk->src.virt.addr;
262 u8 *dst = walk->dst.virt.addr;
263 unsigned int nbytes = walk->nbytes;
265 des3_ede_enc_blk(ctx, keystream, ctrblk);
266 crypto_xor_cpy(dst, keystream, src, nbytes);
268 crypto_inc(ctrblk, DES3_EDE_BLOCK_SIZE);
271 static unsigned int __ctr_crypt(struct des3_ede_x86_ctx *ctx,
272 struct skcipher_walk *walk)
274 unsigned int bsize = DES3_EDE_BLOCK_SIZE;
275 unsigned int nbytes = walk->nbytes;
276 __be64 *src = (__be64 *)walk->src.virt.addr;
277 __be64 *dst = (__be64 *)walk->dst.virt.addr;
278 u64 ctrblk = be64_to_cpu(*(__be64 *)walk->iv);
281 /* Process four block batch */
282 if (nbytes >= bsize * 3) {
284 /* create ctrblks for parallel encrypt */
285 ctrblocks[0] = cpu_to_be64(ctrblk++);
286 ctrblocks[1] = cpu_to_be64(ctrblk++);
287 ctrblocks[2] = cpu_to_be64(ctrblk++);
289 des3_ede_enc_blk_3way(ctx, (u8 *)ctrblocks,
292 dst[0] = src[0] ^ ctrblocks[0];
293 dst[1] = src[1] ^ ctrblocks[1];
294 dst[2] = src[2] ^ ctrblocks[2];
298 } while ((nbytes -= bsize * 3) >= bsize * 3);
304 /* Handle leftovers */
306 ctrblocks[0] = cpu_to_be64(ctrblk++);
308 des3_ede_enc_blk(ctx, (u8 *)ctrblocks, (u8 *)ctrblocks);
310 dst[0] = src[0] ^ ctrblocks[0];
314 } while ((nbytes -= bsize) >= bsize);
317 *(__be64 *)walk->iv = cpu_to_be64(ctrblk);
321 static int ctr_crypt(struct skcipher_request *req)
323 struct crypto_skcipher *tfm = crypto_skcipher_reqtfm(req);
324 struct des3_ede_x86_ctx *ctx = crypto_skcipher_ctx(tfm);
325 struct skcipher_walk walk;
329 err = skcipher_walk_virt(&walk, req, false);
331 while ((nbytes = walk.nbytes) >= DES3_EDE_BLOCK_SIZE) {
332 nbytes = __ctr_crypt(ctx, &walk);
333 err = skcipher_walk_done(&walk, nbytes);
337 ctr_crypt_final(ctx, &walk);
338 err = skcipher_walk_done(&walk, 0);
344 static int des3_ede_x86_setkey(struct crypto_tfm *tfm, const u8 *key,
347 struct des3_ede_x86_ctx *ctx = crypto_tfm_ctx(tfm);
351 /* Generate encryption context using generic implementation. */
352 err = __des3_ede_setkey(ctx->enc_expkey, &tfm->crt_flags, key, keylen);
356 /* Fix encryption context for this implementation and form decryption
358 j = DES3_EDE_EXPKEY_WORDS - 2;
359 for (i = 0; i < DES3_EDE_EXPKEY_WORDS; i += 2, j -= 2) {
360 tmp = ror32(ctx->enc_expkey[i + 1], 4);
361 ctx->enc_expkey[i + 1] = tmp;
363 ctx->dec_expkey[j + 0] = ctx->enc_expkey[i + 0];
364 ctx->dec_expkey[j + 1] = tmp;
370 static int des3_ede_x86_setkey_skcipher(struct crypto_skcipher *tfm,
374 return des3_ede_x86_setkey(&tfm->base, key, keylen);
377 static struct crypto_alg des3_ede_cipher = {
378 .cra_name = "des3_ede",
379 .cra_driver_name = "des3_ede-asm",
381 .cra_flags = CRYPTO_ALG_TYPE_CIPHER,
382 .cra_blocksize = DES3_EDE_BLOCK_SIZE,
383 .cra_ctxsize = sizeof(struct des3_ede_x86_ctx),
385 .cra_module = THIS_MODULE,
388 .cia_min_keysize = DES3_EDE_KEY_SIZE,
389 .cia_max_keysize = DES3_EDE_KEY_SIZE,
390 .cia_setkey = des3_ede_x86_setkey,
391 .cia_encrypt = des3_ede_x86_encrypt,
392 .cia_decrypt = des3_ede_x86_decrypt,
397 static struct skcipher_alg des3_ede_skciphers[] = {
399 .base.cra_name = "ecb(des3_ede)",
400 .base.cra_driver_name = "ecb-des3_ede-asm",
401 .base.cra_priority = 300,
402 .base.cra_blocksize = DES3_EDE_BLOCK_SIZE,
403 .base.cra_ctxsize = sizeof(struct des3_ede_x86_ctx),
404 .base.cra_module = THIS_MODULE,
405 .min_keysize = DES3_EDE_KEY_SIZE,
406 .max_keysize = DES3_EDE_KEY_SIZE,
407 .setkey = des3_ede_x86_setkey_skcipher,
408 .encrypt = ecb_encrypt,
409 .decrypt = ecb_decrypt,
411 .base.cra_name = "cbc(des3_ede)",
412 .base.cra_driver_name = "cbc-des3_ede-asm",
413 .base.cra_priority = 300,
414 .base.cra_blocksize = DES3_EDE_BLOCK_SIZE,
415 .base.cra_ctxsize = sizeof(struct des3_ede_x86_ctx),
416 .base.cra_module = THIS_MODULE,
417 .min_keysize = DES3_EDE_KEY_SIZE,
418 .max_keysize = DES3_EDE_KEY_SIZE,
419 .ivsize = DES3_EDE_BLOCK_SIZE,
420 .setkey = des3_ede_x86_setkey_skcipher,
421 .encrypt = cbc_encrypt,
422 .decrypt = cbc_decrypt,
424 .base.cra_name = "ctr(des3_ede)",
425 .base.cra_driver_name = "ctr-des3_ede-asm",
426 .base.cra_priority = 300,
427 .base.cra_blocksize = 1,
428 .base.cra_ctxsize = sizeof(struct des3_ede_x86_ctx),
429 .base.cra_module = THIS_MODULE,
430 .min_keysize = DES3_EDE_KEY_SIZE,
431 .max_keysize = DES3_EDE_KEY_SIZE,
432 .ivsize = DES3_EDE_BLOCK_SIZE,
433 .chunksize = DES3_EDE_BLOCK_SIZE,
434 .setkey = des3_ede_x86_setkey_skcipher,
435 .encrypt = ctr_crypt,
436 .decrypt = ctr_crypt,
440 static bool is_blacklisted_cpu(void)
442 if (boot_cpu_data.x86_vendor != X86_VENDOR_INTEL)
445 if (boot_cpu_data.x86 == 0x0f) {
447 * On Pentium 4, des3_ede-x86_64 is slower than generic C
448 * implementation because use of 64bit rotates (which are really
449 * slow on P4). Therefore blacklist P4s.
458 module_param(force, int, 0);
459 MODULE_PARM_DESC(force, "Force module load, ignore CPU blacklist");
461 static int __init des3_ede_x86_init(void)
465 if (!force && is_blacklisted_cpu()) {
466 pr_info("des3_ede-x86_64: performance on this CPU would be suboptimal: disabling des3_ede-x86_64.\n");
470 err = crypto_register_alg(&des3_ede_cipher);
474 err = crypto_register_skciphers(des3_ede_skciphers,
475 ARRAY_SIZE(des3_ede_skciphers));
477 crypto_unregister_alg(&des3_ede_cipher);
482 static void __exit des3_ede_x86_fini(void)
484 crypto_unregister_alg(&des3_ede_cipher);
485 crypto_unregister_skciphers(des3_ede_skciphers,
486 ARRAY_SIZE(des3_ede_skciphers));
489 module_init(des3_ede_x86_init);
490 module_exit(des3_ede_x86_fini);
492 MODULE_LICENSE("GPL");
493 MODULE_DESCRIPTION("Triple DES EDE Cipher Algorithm, asm optimized");
494 MODULE_ALIAS_CRYPTO("des3_ede");
495 MODULE_ALIAS_CRYPTO("des3_ede-asm");
496 MODULE_AUTHOR("Jussi Kivilinna <jussi.kivilinna@iki.fi>");