Merge tag 'drm-misc-fixes-2023-05-11' of git://anongit.freedesktop.org/drm/drm-misc...
[linux-block.git] / crypto / xts.c
CommitLineData
2874c5fd 1// SPDX-License-Identifier: GPL-2.0-or-later
f19f5111
RS
2/* XTS: as defined in IEEE1619/D16
3 * http://grouper.ieee.org/groups/1619/email/pdf00086.pdf
f19f5111
RS
4 *
5 * Copyright (c) 2007 Rik Snel <rsnel@cube.dyndns.org>
6 *
ddbc7361 7 * Based on ecb.c
f19f5111 8 * Copyright (c) 2006 Herbert Xu <herbert@gondor.apana.org.au>
f19f5111 9 */
0eb76ba2 10#include <crypto/internal/cipher.h>
f1c131b4
HX
11#include <crypto/internal/skcipher.h>
12#include <crypto/scatterwalk.h>
f19f5111
RS
13#include <linux/err.h>
14#include <linux/init.h>
15#include <linux/kernel.h>
16#include <linux/module.h>
17#include <linux/scatterlist.h>
18#include <linux/slab.h>
19
ce004556 20#include <crypto/xts.h>
f19f5111
RS
21#include <crypto/b128ops.h>
22#include <crypto/gf128mul.h>
23
a874f591 24struct xts_tfm_ctx {
f1c131b4 25 struct crypto_skcipher *child;
f19f5111
RS
26 struct crypto_cipher *tweak;
27};
28
f1c131b4
HX
29struct xts_instance_ctx {
30 struct crypto_skcipher_spawn spawn;
31 char name[CRYPTO_MAX_ALG_NAME];
32};
33
a874f591 34struct xts_request_ctx {
e55318c8 35 le128 t;
8083b1bf
AB
36 struct scatterlist *tail;
37 struct scatterlist sg[2];
f1c131b4
HX
38 struct skcipher_request subreq;
39};
40
a874f591
EB
41static int xts_setkey(struct crypto_skcipher *parent, const u8 *key,
42 unsigned int keylen)
f19f5111 43{
a874f591 44 struct xts_tfm_ctx *ctx = crypto_skcipher_ctx(parent);
f1c131b4
HX
45 struct crypto_skcipher *child;
46 struct crypto_cipher *tweak;
f19f5111
RS
47 int err;
48
f1c131b4 49 err = xts_verify_key(parent, key, keylen);
28856a9e
SM
50 if (err)
51 return err;
f19f5111 52
f1c131b4
HX
53 keylen /= 2;
54
25985edc 55 /* we need two cipher instances: one to compute the initial 'tweak'
f19f5111
RS
56 * by encrypting the IV (usually the 'plain' iv) and the other
57 * one to encrypt and decrypt the data */
58
59 /* tweak cipher, uses Key2 i.e. the second half of *key */
f1c131b4
HX
60 tweak = ctx->tweak;
61 crypto_cipher_clear_flags(tweak, CRYPTO_TFM_REQ_MASK);
62 crypto_cipher_set_flags(tweak, crypto_skcipher_get_flags(parent) &
f19f5111 63 CRYPTO_TFM_REQ_MASK);
f1c131b4 64 err = crypto_cipher_setkey(tweak, key + keylen, keylen);
f19f5111
RS
65 if (err)
66 return err;
67
f1c131b4 68 /* data cipher, uses Key1 i.e. the first half of *key */
f19f5111 69 child = ctx->child;
f1c131b4
HX
70 crypto_skcipher_clear_flags(child, CRYPTO_TFM_REQ_MASK);
71 crypto_skcipher_set_flags(child, crypto_skcipher_get_flags(parent) &
72 CRYPTO_TFM_REQ_MASK);
af5034e8 73 return crypto_skcipher_setkey(child, key, keylen);
f1c131b4 74}
f19f5111 75
78105c7e
OM
76/*
77 * We compute the tweak masks twice (both before and after the ECB encryption or
78 * decryption) to avoid having to allocate a temporary buffer and/or make
79 * mutliple calls to the 'ecb(..)' instance, which usually would be slower than
80 * just doing the gf128mul_x_ble() calls again.
81 */
a874f591
EB
82static int xts_xor_tweak(struct skcipher_request *req, bool second_pass,
83 bool enc)
f1c131b4 84{
a874f591 85 struct xts_request_ctx *rctx = skcipher_request_ctx(req);
78105c7e 86 struct crypto_skcipher *tfm = crypto_skcipher_reqtfm(req);
8083b1bf 87 const bool cts = (req->cryptlen % XTS_BLOCK_SIZE);
f1c131b4
HX
88 const int bs = XTS_BLOCK_SIZE;
89 struct skcipher_walk w;
78105c7e 90 le128 t = rctx->t;
f1c131b4 91 int err;
f19f5111 92
78105c7e
OM
93 if (second_pass) {
94 req = &rctx->subreq;
95 /* set to our TFM to enforce correct alignment: */
96 skcipher_request_set_tfm(req, tfm);
f1c131b4 97 }
78105c7e 98 err = skcipher_walk_virt(&w, req, false);
f19f5111 99
f1c131b4
HX
100 while (w.nbytes) {
101 unsigned int avail = w.nbytes;
e55318c8
OM
102 le128 *wsrc;
103 le128 *wdst;
f19f5111 104
f1c131b4
HX
105 wsrc = w.src.virt.addr;
106 wdst = w.dst.virt.addr;
f19f5111 107
f1c131b4 108 do {
8083b1bf
AB
109 if (unlikely(cts) &&
110 w.total - w.nbytes + avail < 2 * XTS_BLOCK_SIZE) {
111 if (!enc) {
112 if (second_pass)
113 rctx->t = t;
114 gf128mul_x_ble(&t, &t);
115 }
116 le128_xor(wdst, &t, wsrc);
117 if (enc && second_pass)
118 gf128mul_x_ble(&rctx->t, &t);
119 skcipher_walk_done(&w, avail - bs);
120 return 0;
121 }
122
78105c7e
OM
123 le128_xor(wdst++, &t, wsrc++);
124 gf128mul_x_ble(&t, &t);
f19f5111
RS
125 } while ((avail -= bs) >= bs);
126
f1c131b4
HX
127 err = skcipher_walk_done(&w, avail);
128 }
129
f19f5111
RS
130 return err;
131}
132
a874f591 133static int xts_xor_tweak_pre(struct skcipher_request *req, bool enc)
8083b1bf 134{
a874f591 135 return xts_xor_tweak(req, false, enc);
8083b1bf
AB
136}
137
a874f591 138static int xts_xor_tweak_post(struct skcipher_request *req, bool enc)
8083b1bf 139{
a874f591 140 return xts_xor_tweak(req, true, enc);
8083b1bf
AB
141}
142
255e48eb 143static void xts_cts_done(void *data, int err)
f19f5111 144{
255e48eb 145 struct skcipher_request *req = data;
8083b1bf
AB
146 le128 b;
147
148 if (!err) {
a874f591 149 struct xts_request_ctx *rctx = skcipher_request_ctx(req);
8083b1bf
AB
150
151 scatterwalk_map_and_copy(&b, rctx->tail, 0, XTS_BLOCK_SIZE, 0);
152 le128_xor(&b, &rctx->t, &b);
153 scatterwalk_map_and_copy(&b, rctx->tail, 0, XTS_BLOCK_SIZE, 1);
154 }
155
156 skcipher_request_complete(req, err);
157}
158
a874f591
EB
159static int xts_cts_final(struct skcipher_request *req,
160 int (*crypt)(struct skcipher_request *req))
8083b1bf 161{
a874f591
EB
162 const struct xts_tfm_ctx *ctx =
163 crypto_skcipher_ctx(crypto_skcipher_reqtfm(req));
8083b1bf 164 int offset = req->cryptlen & ~(XTS_BLOCK_SIZE - 1);
a874f591 165 struct xts_request_ctx *rctx = skcipher_request_ctx(req);
8083b1bf
AB
166 struct skcipher_request *subreq = &rctx->subreq;
167 int tail = req->cryptlen % XTS_BLOCK_SIZE;
168 le128 b[2];
169 int err;
170
171 rctx->tail = scatterwalk_ffwd(rctx->sg, req->dst,
172 offset - XTS_BLOCK_SIZE);
173
174 scatterwalk_map_and_copy(b, rctx->tail, 0, XTS_BLOCK_SIZE, 0);
958ea4e0 175 b[1] = b[0];
8083b1bf
AB
176 scatterwalk_map_and_copy(b, req->src, offset, tail, 0);
177
178 le128_xor(b, &rctx->t, b);
179
180 scatterwalk_map_and_copy(b, rctx->tail, 0, XTS_BLOCK_SIZE + tail, 1);
181
182 skcipher_request_set_tfm(subreq, ctx->child);
a874f591
EB
183 skcipher_request_set_callback(subreq, req->base.flags, xts_cts_done,
184 req);
8083b1bf
AB
185 skcipher_request_set_crypt(subreq, rctx->tail, rctx->tail,
186 XTS_BLOCK_SIZE, NULL);
187
188 err = crypt(subreq);
189 if (err)
190 return err;
191
192 scatterwalk_map_and_copy(b, rctx->tail, 0, XTS_BLOCK_SIZE, 0);
193 le128_xor(b, &rctx->t, b);
194 scatterwalk_map_and_copy(b, rctx->tail, 0, XTS_BLOCK_SIZE, 1);
195
196 return 0;
f1c131b4
HX
197}
198
255e48eb 199static void xts_encrypt_done(void *data, int err)
f1c131b4 200{
255e48eb 201 struct skcipher_request *req = data;
8083b1bf
AB
202
203 if (!err) {
a874f591 204 struct xts_request_ctx *rctx = skcipher_request_ctx(req);
8083b1bf 205
51c08251 206 rctx->subreq.base.flags &= CRYPTO_TFM_REQ_MAY_BACKLOG;
a874f591 207 err = xts_xor_tweak_post(req, true);
8083b1bf
AB
208
209 if (!err && unlikely(req->cryptlen % XTS_BLOCK_SIZE)) {
a874f591 210 err = xts_cts_final(req, crypto_skcipher_encrypt);
51c08251 211 if (err == -EINPROGRESS || err == -EBUSY)
8083b1bf
AB
212 return;
213 }
214 }
215
216 skcipher_request_complete(req, err);
f1c131b4
HX
217}
218
255e48eb 219static void xts_decrypt_done(void *data, int err)
f1c131b4 220{
255e48eb 221 struct skcipher_request *req = data;
aa4a829b 222
44427c0f 223 if (!err) {
a874f591 224 struct xts_request_ctx *rctx = skcipher_request_ctx(req);
44427c0f 225
51c08251 226 rctx->subreq.base.flags &= CRYPTO_TFM_REQ_MAY_BACKLOG;
a874f591 227 err = xts_xor_tweak_post(req, false);
8083b1bf
AB
228
229 if (!err && unlikely(req->cryptlen % XTS_BLOCK_SIZE)) {
a874f591 230 err = xts_cts_final(req, crypto_skcipher_decrypt);
51c08251 231 if (err == -EINPROGRESS || err == -EBUSY)
8083b1bf
AB
232 return;
233 }
44427c0f 234 }
f1c131b4 235
f1c131b4
HX
236 skcipher_request_complete(req, err);
237}
238
a874f591
EB
239static int xts_init_crypt(struct skcipher_request *req,
240 crypto_completion_t compl)
f1c131b4 241{
a874f591
EB
242 const struct xts_tfm_ctx *ctx =
243 crypto_skcipher_ctx(crypto_skcipher_reqtfm(req));
244 struct xts_request_ctx *rctx = skcipher_request_ctx(req);
78105c7e 245 struct skcipher_request *subreq = &rctx->subreq;
f1c131b4 246
8083b1bf
AB
247 if (req->cryptlen < XTS_BLOCK_SIZE)
248 return -EINVAL;
249
78105c7e 250 skcipher_request_set_tfm(subreq, ctx->child);
8083b1bf 251 skcipher_request_set_callback(subreq, req->base.flags, compl, req);
78105c7e 252 skcipher_request_set_crypt(subreq, req->dst, req->dst,
8083b1bf 253 req->cryptlen & ~(XTS_BLOCK_SIZE - 1), NULL);
f1c131b4 254
78105c7e
OM
255 /* calculate first value of T */
256 crypto_cipher_encrypt_one(ctx->tweak, (u8 *)&rctx->t, req->iv);
8083b1bf
AB
257
258 return 0;
f1c131b4
HX
259}
260
a874f591 261static int xts_encrypt(struct skcipher_request *req)
f1c131b4 262{
a874f591 263 struct xts_request_ctx *rctx = skcipher_request_ctx(req);
78105c7e 264 struct skcipher_request *subreq = &rctx->subreq;
8083b1bf
AB
265 int err;
266
a874f591
EB
267 err = xts_init_crypt(req, xts_encrypt_done) ?:
268 xts_xor_tweak_pre(req, true) ?:
8083b1bf 269 crypto_skcipher_encrypt(subreq) ?:
a874f591 270 xts_xor_tweak_post(req, true);
f1c131b4 271
8083b1bf
AB
272 if (err || likely((req->cryptlen % XTS_BLOCK_SIZE) == 0))
273 return err;
274
a874f591 275 return xts_cts_final(req, crypto_skcipher_encrypt);
f1c131b4
HX
276}
277
a874f591 278static int xts_decrypt(struct skcipher_request *req)
f1c131b4 279{
a874f591 280 struct xts_request_ctx *rctx = skcipher_request_ctx(req);
78105c7e 281 struct skcipher_request *subreq = &rctx->subreq;
8083b1bf
AB
282 int err;
283
a874f591
EB
284 err = xts_init_crypt(req, xts_decrypt_done) ?:
285 xts_xor_tweak_pre(req, false) ?:
8083b1bf 286 crypto_skcipher_decrypt(subreq) ?:
a874f591 287 xts_xor_tweak_post(req, false);
8083b1bf
AB
288
289 if (err || likely((req->cryptlen % XTS_BLOCK_SIZE) == 0))
290 return err;
78105c7e 291
a874f591 292 return xts_cts_final(req, crypto_skcipher_decrypt);
f19f5111
RS
293}
294
a874f591 295static int xts_init_tfm(struct crypto_skcipher *tfm)
f19f5111 296{
f1c131b4
HX
297 struct skcipher_instance *inst = skcipher_alg_instance(tfm);
298 struct xts_instance_ctx *ictx = skcipher_instance_ctx(inst);
a874f591 299 struct xts_tfm_ctx *ctx = crypto_skcipher_ctx(tfm);
f1c131b4
HX
300 struct crypto_skcipher *child;
301 struct crypto_cipher *tweak;
f19f5111 302
f1c131b4
HX
303 child = crypto_spawn_skcipher(&ictx->spawn);
304 if (IS_ERR(child))
305 return PTR_ERR(child);
f19f5111 306
f1c131b4 307 ctx->child = child;
f19f5111 308
f1c131b4
HX
309 tweak = crypto_alloc_cipher(ictx->name, 0, 0);
310 if (IS_ERR(tweak)) {
311 crypto_free_skcipher(ctx->child);
312 return PTR_ERR(tweak);
f19f5111
RS
313 }
314
f1c131b4
HX
315 ctx->tweak = tweak;
316
317 crypto_skcipher_set_reqsize(tfm, crypto_skcipher_reqsize(child) +
a874f591 318 sizeof(struct xts_request_ctx));
f19f5111
RS
319
320 return 0;
321}
322
a874f591 323static void xts_exit_tfm(struct crypto_skcipher *tfm)
f19f5111 324{
a874f591 325 struct xts_tfm_ctx *ctx = crypto_skcipher_ctx(tfm);
f1c131b4
HX
326
327 crypto_free_skcipher(ctx->child);
f19f5111
RS
328 crypto_free_cipher(ctx->tweak);
329}
330
a874f591 331static void xts_free_instance(struct skcipher_instance *inst)
f1c131b4 332{
a874f591
EB
333 struct xts_instance_ctx *ictx = skcipher_instance_ctx(inst);
334
335 crypto_drop_skcipher(&ictx->spawn);
f1c131b4
HX
336 kfree(inst);
337}
338
a874f591 339static int xts_create(struct crypto_template *tmpl, struct rtattr **tb)
f19f5111 340{
f1c131b4 341 struct skcipher_instance *inst;
f1c131b4
HX
342 struct xts_instance_ctx *ctx;
343 struct skcipher_alg *alg;
344 const char *cipher_name;
89027579 345 u32 mask;
f19f5111
RS
346 int err;
347
7bcb2c99
EB
348 err = crypto_check_attr_type(tb, CRYPTO_ALG_TYPE_SKCIPHER, &mask);
349 if (err)
350 return err;
f1c131b4
HX
351
352 cipher_name = crypto_attr_alg_name(tb[1]);
353 if (IS_ERR(cipher_name))
354 return PTR_ERR(cipher_name);
355
356 inst = kzalloc(sizeof(*inst) + sizeof(*ctx), GFP_KERNEL);
357 if (!inst)
358 return -ENOMEM;
359
360 ctx = skcipher_instance_ctx(inst);
361
b9f76ddd
EB
362 err = crypto_grab_skcipher(&ctx->spawn, skcipher_crypto_instance(inst),
363 cipher_name, 0, mask);
f1c131b4
HX
364 if (err == -ENOENT) {
365 err = -ENAMETOOLONG;
366 if (snprintf(ctx->name, CRYPTO_MAX_ALG_NAME, "ecb(%s)",
367 cipher_name) >= CRYPTO_MAX_ALG_NAME)
368 goto err_free_inst;
369
b9f76ddd
EB
370 err = crypto_grab_skcipher(&ctx->spawn,
371 skcipher_crypto_instance(inst),
372 ctx->name, 0, mask);
f1c131b4
HX
373 }
374
f19f5111 375 if (err)
f1c131b4 376 goto err_free_inst;
f19f5111 377
f1c131b4 378 alg = crypto_skcipher_spawn_alg(&ctx->spawn);
f19f5111 379
f1c131b4
HX
380 err = -EINVAL;
381 if (alg->base.cra_blocksize != XTS_BLOCK_SIZE)
732e5409 382 goto err_free_inst;
f19f5111 383
f1c131b4 384 if (crypto_skcipher_alg_ivsize(alg))
732e5409 385 goto err_free_inst;
f19f5111 386
f1c131b4
HX
387 err = crypto_inst_setname(skcipher_crypto_instance(inst), "xts",
388 &alg->base);
389 if (err)
732e5409 390 goto err_free_inst;
f19f5111 391
f1c131b4
HX
392 err = -EINVAL;
393 cipher_name = alg->base.cra_name;
f19f5111 394
f1c131b4
HX
395 /* Alas we screwed up the naming so we have to mangle the
396 * cipher name.
397 */
398 if (!strncmp(cipher_name, "ecb(", 4)) {
399 unsigned len;
f19f5111 400
f1c131b4
HX
401 len = strlcpy(ctx->name, cipher_name + 4, sizeof(ctx->name));
402 if (len < 2 || len >= sizeof(ctx->name))
732e5409 403 goto err_free_inst;
f19f5111 404
f1c131b4 405 if (ctx->name[len - 1] != ')')
732e5409 406 goto err_free_inst;
f19f5111 407
f1c131b4 408 ctx->name[len - 1] = 0;
f19f5111 409
f1c131b4 410 if (snprintf(inst->alg.base.cra_name, CRYPTO_MAX_ALG_NAME,
5125e4e8
CJ
411 "xts(%s)", ctx->name) >= CRYPTO_MAX_ALG_NAME) {
412 err = -ENAMETOOLONG;
732e5409 413 goto err_free_inst;
5125e4e8 414 }
f1c131b4 415 } else
732e5409 416 goto err_free_inst;
f19f5111 417
f1c131b4
HX
418 inst->alg.base.cra_priority = alg->base.cra_priority;
419 inst->alg.base.cra_blocksize = XTS_BLOCK_SIZE;
420 inst->alg.base.cra_alignmask = alg->base.cra_alignmask |
421 (__alignof__(u64) - 1);
422
423 inst->alg.ivsize = XTS_BLOCK_SIZE;
424 inst->alg.min_keysize = crypto_skcipher_alg_min_keysize(alg) * 2;
425 inst->alg.max_keysize = crypto_skcipher_alg_max_keysize(alg) * 2;
426
a874f591 427 inst->alg.base.cra_ctxsize = sizeof(struct xts_tfm_ctx);
f1c131b4 428
a874f591
EB
429 inst->alg.init = xts_init_tfm;
430 inst->alg.exit = xts_exit_tfm;
f1c131b4 431
a874f591
EB
432 inst->alg.setkey = xts_setkey;
433 inst->alg.encrypt = xts_encrypt;
434 inst->alg.decrypt = xts_decrypt;
f1c131b4 435
a874f591 436 inst->free = xts_free_instance;
f1c131b4
HX
437
438 err = skcipher_register_instance(tmpl, inst);
732e5409 439 if (err) {
f1c131b4 440err_free_inst:
a874f591 441 xts_free_instance(inst);
732e5409
EB
442 }
443 return err;
f19f5111
RS
444}
445
a874f591 446static struct crypto_template xts_tmpl = {
f19f5111 447 .name = "xts",
a874f591 448 .create = xts_create,
f19f5111
RS
449 .module = THIS_MODULE,
450};
451
a874f591 452static int __init xts_module_init(void)
f19f5111 453{
a874f591 454 return crypto_register_template(&xts_tmpl);
f19f5111
RS
455}
456
a874f591 457static void __exit xts_module_exit(void)
f19f5111 458{
a874f591 459 crypto_unregister_template(&xts_tmpl);
f19f5111
RS
460}
461
a874f591
EB
462subsys_initcall(xts_module_init);
463module_exit(xts_module_exit);
f19f5111
RS
464
465MODULE_LICENSE("GPL");
466MODULE_DESCRIPTION("XTS block cipher mode");
4943ba16 467MODULE_ALIAS_CRYPTO("xts");
0eb76ba2 468MODULE_IMPORT_NS(CRYPTO_INTERNAL);
dfe085d8 469MODULE_SOFTDEP("pre: ecb");