1 // SPDX-License-Identifier: GPL-2.0-only
3 * Bit sliced AES using NEON instructions
5 * Copyright (C) 2017 Linaro Ltd <ard.biesheuvel@linaro.org>
10 #include <crypto/aes.h>
11 #include <crypto/ctr.h>
12 #include <crypto/internal/cipher.h>
13 #include <crypto/internal/simd.h>
14 #include <crypto/internal/skcipher.h>
15 #include <crypto/scatterwalk.h>
16 #include <crypto/xts.h>
17 #include <linux/module.h>
19 MODULE_AUTHOR("Ard Biesheuvel <ard.biesheuvel@linaro.org>");
20 MODULE_LICENSE("GPL v2");
22 MODULE_ALIAS_CRYPTO("ecb(aes)");
23 MODULE_ALIAS_CRYPTO("cbc(aes)-all");
24 MODULE_ALIAS_CRYPTO("ctr(aes)");
25 MODULE_ALIAS_CRYPTO("xts(aes)");
27 MODULE_IMPORT_NS(CRYPTO_INTERNAL);
29 asmlinkage void aesbs_convert_key(u8 out[], u32 const rk[], int rounds);
31 asmlinkage void aesbs_ecb_encrypt(u8 out[], u8 const in[], u8 const rk[],
32 int rounds, int blocks);
33 asmlinkage void aesbs_ecb_decrypt(u8 out[], u8 const in[], u8 const rk[],
34 int rounds, int blocks);
36 asmlinkage void aesbs_cbc_decrypt(u8 out[], u8 const in[], u8 const rk[],
37 int rounds, int blocks, u8 iv[]);
39 asmlinkage void aesbs_ctr_encrypt(u8 out[], u8 const in[], u8 const rk[],
40 int rounds, int blocks, u8 ctr[], u8 final[]);
42 asmlinkage void aesbs_xts_encrypt(u8 out[], u8 const in[], u8 const rk[],
43 int rounds, int blocks, u8 iv[], int);
44 asmlinkage void aesbs_xts_decrypt(u8 out[], u8 const in[], u8 const rk[],
45 int rounds, int blocks, u8 iv[], int);
49 u8 rk[13 * (8 * AES_BLOCK_SIZE) + 32] __aligned(AES_BLOCK_SIZE);
52 struct aesbs_cbc_ctx {
54 struct crypto_skcipher *enc_tfm;
57 struct aesbs_xts_ctx {
59 struct crypto_cipher *cts_tfm;
60 struct crypto_cipher *tweak_tfm;
63 struct aesbs_ctr_ctx {
64 struct aesbs_ctx key; /* must be first member */
65 struct crypto_aes_ctx fallback;
68 static int aesbs_setkey(struct crypto_skcipher *tfm, const u8 *in_key,
71 struct aesbs_ctx *ctx = crypto_skcipher_ctx(tfm);
72 struct crypto_aes_ctx rk;
75 err = aes_expandkey(&rk, in_key, key_len);
79 ctx->rounds = 6 + key_len / 4;
82 aesbs_convert_key(ctx->rk, rk.key_enc, ctx->rounds);
88 static int __ecb_crypt(struct skcipher_request *req,
89 void (*fn)(u8 out[], u8 const in[], u8 const rk[],
90 int rounds, int blocks))
92 struct crypto_skcipher *tfm = crypto_skcipher_reqtfm(req);
93 struct aesbs_ctx *ctx = crypto_skcipher_ctx(tfm);
94 struct skcipher_walk walk;
97 err = skcipher_walk_virt(&walk, req, false);
99 while (walk.nbytes >= AES_BLOCK_SIZE) {
100 unsigned int blocks = walk.nbytes / AES_BLOCK_SIZE;
102 if (walk.nbytes < walk.total)
103 blocks = round_down(blocks,
104 walk.stride / AES_BLOCK_SIZE);
107 fn(walk.dst.virt.addr, walk.src.virt.addr, ctx->rk,
108 ctx->rounds, blocks);
110 err = skcipher_walk_done(&walk,
111 walk.nbytes - blocks * AES_BLOCK_SIZE);
117 static int ecb_encrypt(struct skcipher_request *req)
119 return __ecb_crypt(req, aesbs_ecb_encrypt);
122 static int ecb_decrypt(struct skcipher_request *req)
124 return __ecb_crypt(req, aesbs_ecb_decrypt);
127 static int aesbs_cbc_setkey(struct crypto_skcipher *tfm, const u8 *in_key,
128 unsigned int key_len)
130 struct aesbs_cbc_ctx *ctx = crypto_skcipher_ctx(tfm);
131 struct crypto_aes_ctx rk;
134 err = aes_expandkey(&rk, in_key, key_len);
138 ctx->key.rounds = 6 + key_len / 4;
141 aesbs_convert_key(ctx->key.rk, rk.key_enc, ctx->key.rounds);
143 memzero_explicit(&rk, sizeof(rk));
145 return crypto_skcipher_setkey(ctx->enc_tfm, in_key, key_len);
148 static int cbc_encrypt(struct skcipher_request *req)
150 struct skcipher_request *subreq = skcipher_request_ctx(req);
151 struct crypto_skcipher *tfm = crypto_skcipher_reqtfm(req);
152 struct aesbs_cbc_ctx *ctx = crypto_skcipher_ctx(tfm);
154 skcipher_request_set_tfm(subreq, ctx->enc_tfm);
155 skcipher_request_set_callback(subreq,
156 skcipher_request_flags(req),
158 skcipher_request_set_crypt(subreq, req->src, req->dst,
159 req->cryptlen, req->iv);
161 return crypto_skcipher_encrypt(subreq);
164 static int cbc_decrypt(struct skcipher_request *req)
166 struct crypto_skcipher *tfm = crypto_skcipher_reqtfm(req);
167 struct aesbs_cbc_ctx *ctx = crypto_skcipher_ctx(tfm);
168 struct skcipher_walk walk;
171 err = skcipher_walk_virt(&walk, req, false);
173 while (walk.nbytes >= AES_BLOCK_SIZE) {
174 unsigned int blocks = walk.nbytes / AES_BLOCK_SIZE;
176 if (walk.nbytes < walk.total)
177 blocks = round_down(blocks,
178 walk.stride / AES_BLOCK_SIZE);
181 aesbs_cbc_decrypt(walk.dst.virt.addr, walk.src.virt.addr,
182 ctx->key.rk, ctx->key.rounds, blocks,
185 err = skcipher_walk_done(&walk,
186 walk.nbytes - blocks * AES_BLOCK_SIZE);
192 static int cbc_init(struct crypto_skcipher *tfm)
194 struct aesbs_cbc_ctx *ctx = crypto_skcipher_ctx(tfm);
195 unsigned int reqsize;
197 ctx->enc_tfm = crypto_alloc_skcipher("cbc(aes)", 0, CRYPTO_ALG_ASYNC |
198 CRYPTO_ALG_NEED_FALLBACK);
199 if (IS_ERR(ctx->enc_tfm))
200 return PTR_ERR(ctx->enc_tfm);
202 reqsize = sizeof(struct skcipher_request);
203 reqsize += crypto_skcipher_reqsize(ctx->enc_tfm);
204 crypto_skcipher_set_reqsize(tfm, reqsize);
209 static void cbc_exit(struct crypto_skcipher *tfm)
211 struct aesbs_cbc_ctx *ctx = crypto_skcipher_ctx(tfm);
213 crypto_free_skcipher(ctx->enc_tfm);
216 static int aesbs_ctr_setkey_sync(struct crypto_skcipher *tfm, const u8 *in_key,
217 unsigned int key_len)
219 struct aesbs_ctr_ctx *ctx = crypto_skcipher_ctx(tfm);
222 err = aes_expandkey(&ctx->fallback, in_key, key_len);
226 ctx->key.rounds = 6 + key_len / 4;
229 aesbs_convert_key(ctx->key.rk, ctx->fallback.key_enc, ctx->key.rounds);
235 static int ctr_encrypt(struct skcipher_request *req)
237 struct crypto_skcipher *tfm = crypto_skcipher_reqtfm(req);
238 struct aesbs_ctx *ctx = crypto_skcipher_ctx(tfm);
239 struct skcipher_walk walk;
240 u8 buf[AES_BLOCK_SIZE];
243 err = skcipher_walk_virt(&walk, req, false);
245 while (walk.nbytes > 0) {
246 unsigned int blocks = walk.nbytes / AES_BLOCK_SIZE;
247 u8 *final = (walk.total % AES_BLOCK_SIZE) ? buf : NULL;
249 if (walk.nbytes < walk.total) {
250 blocks = round_down(blocks,
251 walk.stride / AES_BLOCK_SIZE);
256 aesbs_ctr_encrypt(walk.dst.virt.addr, walk.src.virt.addr,
257 ctx->rk, ctx->rounds, blocks, walk.iv, final);
261 u8 *dst = walk.dst.virt.addr + blocks * AES_BLOCK_SIZE;
262 u8 *src = walk.src.virt.addr + blocks * AES_BLOCK_SIZE;
264 crypto_xor_cpy(dst, src, final,
265 walk.total % AES_BLOCK_SIZE);
267 err = skcipher_walk_done(&walk, 0);
270 err = skcipher_walk_done(&walk,
271 walk.nbytes - blocks * AES_BLOCK_SIZE);
277 static void ctr_encrypt_one(struct crypto_skcipher *tfm, const u8 *src, u8 *dst)
279 struct aesbs_ctr_ctx *ctx = crypto_skcipher_ctx(tfm);
283 * Temporarily disable interrupts to avoid races where
284 * cachelines are evicted when the CPU is interrupted
285 * to do something else.
287 local_irq_save(flags);
288 aes_encrypt(&ctx->fallback, dst, src);
289 local_irq_restore(flags);
292 static int ctr_encrypt_sync(struct skcipher_request *req)
294 if (!crypto_simd_usable())
295 return crypto_ctr_encrypt_walk(req, ctr_encrypt_one);
297 return ctr_encrypt(req);
300 static int aesbs_xts_setkey(struct crypto_skcipher *tfm, const u8 *in_key,
301 unsigned int key_len)
303 struct aesbs_xts_ctx *ctx = crypto_skcipher_ctx(tfm);
306 err = xts_verify_key(tfm, in_key, key_len);
311 err = crypto_cipher_setkey(ctx->cts_tfm, in_key, key_len);
314 err = crypto_cipher_setkey(ctx->tweak_tfm, in_key + key_len, key_len);
318 return aesbs_setkey(tfm, in_key, key_len);
321 static int xts_init(struct crypto_skcipher *tfm)
323 struct aesbs_xts_ctx *ctx = crypto_skcipher_ctx(tfm);
325 ctx->cts_tfm = crypto_alloc_cipher("aes", 0, 0);
326 if (IS_ERR(ctx->cts_tfm))
327 return PTR_ERR(ctx->cts_tfm);
329 ctx->tweak_tfm = crypto_alloc_cipher("aes", 0, 0);
330 if (IS_ERR(ctx->tweak_tfm))
331 crypto_free_cipher(ctx->cts_tfm);
333 return PTR_ERR_OR_ZERO(ctx->tweak_tfm);
336 static void xts_exit(struct crypto_skcipher *tfm)
338 struct aesbs_xts_ctx *ctx = crypto_skcipher_ctx(tfm);
340 crypto_free_cipher(ctx->tweak_tfm);
341 crypto_free_cipher(ctx->cts_tfm);
344 static int __xts_crypt(struct skcipher_request *req, bool encrypt,
345 void (*fn)(u8 out[], u8 const in[], u8 const rk[],
346 int rounds, int blocks, u8 iv[], int))
348 struct crypto_skcipher *tfm = crypto_skcipher_reqtfm(req);
349 struct aesbs_xts_ctx *ctx = crypto_skcipher_ctx(tfm);
350 int tail = req->cryptlen % AES_BLOCK_SIZE;
351 struct skcipher_request subreq;
352 u8 buf[2 * AES_BLOCK_SIZE];
353 struct skcipher_walk walk;
356 if (req->cryptlen < AES_BLOCK_SIZE)
359 if (unlikely(tail)) {
360 skcipher_request_set_tfm(&subreq, tfm);
361 skcipher_request_set_callback(&subreq,
362 skcipher_request_flags(req),
364 skcipher_request_set_crypt(&subreq, req->src, req->dst,
365 req->cryptlen - tail, req->iv);
369 err = skcipher_walk_virt(&walk, req, true);
373 crypto_cipher_encrypt_one(ctx->tweak_tfm, walk.iv, walk.iv);
375 while (walk.nbytes >= AES_BLOCK_SIZE) {
376 unsigned int blocks = walk.nbytes / AES_BLOCK_SIZE;
377 int reorder_last_tweak = !encrypt && tail > 0;
379 if (walk.nbytes < walk.total) {
380 blocks = round_down(blocks,
381 walk.stride / AES_BLOCK_SIZE);
382 reorder_last_tweak = 0;
386 fn(walk.dst.virt.addr, walk.src.virt.addr, ctx->key.rk,
387 ctx->key.rounds, blocks, walk.iv, reorder_last_tweak);
389 err = skcipher_walk_done(&walk,
390 walk.nbytes - blocks * AES_BLOCK_SIZE);
393 if (err || likely(!tail))
396 /* handle ciphertext stealing */
397 scatterwalk_map_and_copy(buf, req->dst, req->cryptlen - AES_BLOCK_SIZE,
399 memcpy(buf + AES_BLOCK_SIZE, buf, tail);
400 scatterwalk_map_and_copy(buf, req->src, req->cryptlen, tail, 0);
402 crypto_xor(buf, req->iv, AES_BLOCK_SIZE);
405 crypto_cipher_encrypt_one(ctx->cts_tfm, buf, buf);
407 crypto_cipher_decrypt_one(ctx->cts_tfm, buf, buf);
409 crypto_xor(buf, req->iv, AES_BLOCK_SIZE);
411 scatterwalk_map_and_copy(buf, req->dst, req->cryptlen - AES_BLOCK_SIZE,
412 AES_BLOCK_SIZE + tail, 1);
416 static int xts_encrypt(struct skcipher_request *req)
418 return __xts_crypt(req, true, aesbs_xts_encrypt);
421 static int xts_decrypt(struct skcipher_request *req)
423 return __xts_crypt(req, false, aesbs_xts_decrypt);
426 static struct skcipher_alg aes_algs[] = { {
427 .base.cra_name = "__ecb(aes)",
428 .base.cra_driver_name = "__ecb-aes-neonbs",
429 .base.cra_priority = 250,
430 .base.cra_blocksize = AES_BLOCK_SIZE,
431 .base.cra_ctxsize = sizeof(struct aesbs_ctx),
432 .base.cra_module = THIS_MODULE,
433 .base.cra_flags = CRYPTO_ALG_INTERNAL,
435 .min_keysize = AES_MIN_KEY_SIZE,
436 .max_keysize = AES_MAX_KEY_SIZE,
437 .walksize = 8 * AES_BLOCK_SIZE,
438 .setkey = aesbs_setkey,
439 .encrypt = ecb_encrypt,
440 .decrypt = ecb_decrypt,
442 .base.cra_name = "__cbc(aes)",
443 .base.cra_driver_name = "__cbc-aes-neonbs",
444 .base.cra_priority = 250,
445 .base.cra_blocksize = AES_BLOCK_SIZE,
446 .base.cra_ctxsize = sizeof(struct aesbs_cbc_ctx),
447 .base.cra_module = THIS_MODULE,
448 .base.cra_flags = CRYPTO_ALG_INTERNAL |
449 CRYPTO_ALG_NEED_FALLBACK,
451 .min_keysize = AES_MIN_KEY_SIZE,
452 .max_keysize = AES_MAX_KEY_SIZE,
453 .walksize = 8 * AES_BLOCK_SIZE,
454 .ivsize = AES_BLOCK_SIZE,
455 .setkey = aesbs_cbc_setkey,
456 .encrypt = cbc_encrypt,
457 .decrypt = cbc_decrypt,
461 .base.cra_name = "__ctr(aes)",
462 .base.cra_driver_name = "__ctr-aes-neonbs",
463 .base.cra_priority = 250,
464 .base.cra_blocksize = 1,
465 .base.cra_ctxsize = sizeof(struct aesbs_ctx),
466 .base.cra_module = THIS_MODULE,
467 .base.cra_flags = CRYPTO_ALG_INTERNAL,
469 .min_keysize = AES_MIN_KEY_SIZE,
470 .max_keysize = AES_MAX_KEY_SIZE,
471 .chunksize = AES_BLOCK_SIZE,
472 .walksize = 8 * AES_BLOCK_SIZE,
473 .ivsize = AES_BLOCK_SIZE,
474 .setkey = aesbs_setkey,
475 .encrypt = ctr_encrypt,
476 .decrypt = ctr_encrypt,
478 .base.cra_name = "ctr(aes)",
479 .base.cra_driver_name = "ctr-aes-neonbs-sync",
480 .base.cra_priority = 250 - 1,
481 .base.cra_blocksize = 1,
482 .base.cra_ctxsize = sizeof(struct aesbs_ctr_ctx),
483 .base.cra_module = THIS_MODULE,
485 .min_keysize = AES_MIN_KEY_SIZE,
486 .max_keysize = AES_MAX_KEY_SIZE,
487 .chunksize = AES_BLOCK_SIZE,
488 .walksize = 8 * AES_BLOCK_SIZE,
489 .ivsize = AES_BLOCK_SIZE,
490 .setkey = aesbs_ctr_setkey_sync,
491 .encrypt = ctr_encrypt_sync,
492 .decrypt = ctr_encrypt_sync,
494 .base.cra_name = "__xts(aes)",
495 .base.cra_driver_name = "__xts-aes-neonbs",
496 .base.cra_priority = 250,
497 .base.cra_blocksize = AES_BLOCK_SIZE,
498 .base.cra_ctxsize = sizeof(struct aesbs_xts_ctx),
499 .base.cra_module = THIS_MODULE,
500 .base.cra_flags = CRYPTO_ALG_INTERNAL,
502 .min_keysize = 2 * AES_MIN_KEY_SIZE,
503 .max_keysize = 2 * AES_MAX_KEY_SIZE,
504 .walksize = 8 * AES_BLOCK_SIZE,
505 .ivsize = AES_BLOCK_SIZE,
506 .setkey = aesbs_xts_setkey,
507 .encrypt = xts_encrypt,
508 .decrypt = xts_decrypt,
513 static struct simd_skcipher_alg *aes_simd_algs[ARRAY_SIZE(aes_algs)];
515 static void aes_exit(void)
519 for (i = 0; i < ARRAY_SIZE(aes_simd_algs); i++)
520 if (aes_simd_algs[i])
521 simd_skcipher_free(aes_simd_algs[i]);
523 crypto_unregister_skciphers(aes_algs, ARRAY_SIZE(aes_algs));
526 static int __init aes_init(void)
528 struct simd_skcipher_alg *simd;
529 const char *basename;
535 if (!(elf_hwcap & HWCAP_NEON))
538 err = crypto_register_skciphers(aes_algs, ARRAY_SIZE(aes_algs));
542 for (i = 0; i < ARRAY_SIZE(aes_algs); i++) {
543 if (!(aes_algs[i].base.cra_flags & CRYPTO_ALG_INTERNAL))
546 algname = aes_algs[i].base.cra_name + 2;
547 drvname = aes_algs[i].base.cra_driver_name + 2;
548 basename = aes_algs[i].base.cra_driver_name;
549 simd = simd_skcipher_create_compat(algname, drvname, basename);
552 goto unregister_simds;
554 aes_simd_algs[i] = simd;
563 late_initcall(aes_init);
564 module_exit(aes_exit);