1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * ChaCha20-Poly1305 AEAD, RFC7539
5 * Copyright (C) 2015 Martin Willi
8 #include <crypto/internal/aead.h>
9 #include <crypto/internal/hash.h>
10 #include <crypto/internal/skcipher.h>
11 #include <crypto/scatterwalk.h>
12 #include <crypto/chacha.h>
13 #include <crypto/poly1305.h>
14 #include <linux/err.h>
15 #include <linux/init.h>
16 #include <linux/kernel.h>
17 #include <linux/module.h>
19 struct chachapoly_instance_ctx
{
20 struct crypto_skcipher_spawn chacha
;
21 struct crypto_ahash_spawn poly
;
25 struct chachapoly_ctx
{
26 struct crypto_skcipher
*chacha
;
27 struct crypto_ahash
*poly
;
28 /* key bytes we use for the ChaCha20 IV */
34 /* zero byte padding for AD/ciphertext, as needed */
35 u8 pad
[POLY1305_BLOCK_SIZE
];
36 /* tail data with AD/ciphertext lengths */
41 struct scatterlist src
[1];
42 struct ahash_request req
; /* must be last member */
46 u8 iv
[CHACHA_IV_SIZE
];
47 struct scatterlist src
[1];
48 struct skcipher_request req
; /* must be last member */
51 struct chachapoly_req_ctx
{
52 struct scatterlist src
[2];
53 struct scatterlist dst
[2];
54 /* the key we generate for Poly1305 using Chacha20 */
55 u8 key
[POLY1305_KEY_SIZE
];
56 /* calculated Poly1305 tag */
57 u8 tag
[POLY1305_DIGEST_SIZE
];
58 /* length of data to en/decrypt, without ICV */
59 unsigned int cryptlen
;
60 /* Actual AD, excluding IV */
61 unsigned int assoclen
;
62 /* request flags, with MAY_SLEEP cleared if needed */
66 struct chacha_req chacha
;
70 static inline void async_done_continue(struct aead_request
*req
, int err
,
71 int (*cont
)(struct aead_request
*))
74 struct chachapoly_req_ctx
*rctx
= aead_request_ctx(req
);
76 rctx
->flags
&= ~CRYPTO_TFM_REQ_MAY_SLEEP
;
80 if (err
!= -EINPROGRESS
&& err
!= -EBUSY
)
81 aead_request_complete(req
, err
);
84 static void chacha_iv(u8
*iv
, struct aead_request
*req
, u32 icb
)
86 struct chachapoly_ctx
*ctx
= crypto_aead_ctx(crypto_aead_reqtfm(req
));
87 __le32 leicb
= cpu_to_le32(icb
);
89 memcpy(iv
, &leicb
, sizeof(leicb
));
90 memcpy(iv
+ sizeof(leicb
), ctx
->salt
, ctx
->saltlen
);
91 memcpy(iv
+ sizeof(leicb
) + ctx
->saltlen
, req
->iv
,
92 CHACHA_IV_SIZE
- sizeof(leicb
) - ctx
->saltlen
);
95 static int poly_verify_tag(struct aead_request
*req
)
97 struct chachapoly_req_ctx
*rctx
= aead_request_ctx(req
);
98 u8 tag
[sizeof(rctx
->tag
)];
100 scatterwalk_map_and_copy(tag
, req
->src
,
101 req
->assoclen
+ rctx
->cryptlen
,
103 if (crypto_memneq(tag
, rctx
->tag
, sizeof(tag
)))
108 static int poly_copy_tag(struct aead_request
*req
)
110 struct chachapoly_req_ctx
*rctx
= aead_request_ctx(req
);
112 scatterwalk_map_and_copy(rctx
->tag
, req
->dst
,
113 req
->assoclen
+ rctx
->cryptlen
,
114 sizeof(rctx
->tag
), 1);
118 static void chacha_decrypt_done(struct crypto_async_request
*areq
, int err
)
120 async_done_continue(areq
->data
, err
, poly_verify_tag
);
123 static int chacha_decrypt(struct aead_request
*req
)
125 struct chachapoly_ctx
*ctx
= crypto_aead_ctx(crypto_aead_reqtfm(req
));
126 struct chachapoly_req_ctx
*rctx
= aead_request_ctx(req
);
127 struct chacha_req
*creq
= &rctx
->u
.chacha
;
128 struct scatterlist
*src
, *dst
;
131 if (rctx
->cryptlen
== 0)
134 chacha_iv(creq
->iv
, req
, 1);
136 src
= scatterwalk_ffwd(rctx
->src
, req
->src
, req
->assoclen
);
138 if (req
->src
!= req
->dst
)
139 dst
= scatterwalk_ffwd(rctx
->dst
, req
->dst
, req
->assoclen
);
141 skcipher_request_set_callback(&creq
->req
, rctx
->flags
,
142 chacha_decrypt_done
, req
);
143 skcipher_request_set_tfm(&creq
->req
, ctx
->chacha
);
144 skcipher_request_set_crypt(&creq
->req
, src
, dst
,
145 rctx
->cryptlen
, creq
->iv
);
146 err
= crypto_skcipher_decrypt(&creq
->req
);
151 return poly_verify_tag(req
);
154 static int poly_tail_continue(struct aead_request
*req
)
156 struct chachapoly_req_ctx
*rctx
= aead_request_ctx(req
);
158 if (rctx
->cryptlen
== req
->cryptlen
) /* encrypting */
159 return poly_copy_tag(req
);
161 return chacha_decrypt(req
);
164 static void poly_tail_done(struct crypto_async_request
*areq
, int err
)
166 async_done_continue(areq
->data
, err
, poly_tail_continue
);
169 static int poly_tail(struct aead_request
*req
)
171 struct crypto_aead
*tfm
= crypto_aead_reqtfm(req
);
172 struct chachapoly_ctx
*ctx
= crypto_aead_ctx(tfm
);
173 struct chachapoly_req_ctx
*rctx
= aead_request_ctx(req
);
174 struct poly_req
*preq
= &rctx
->u
.poly
;
177 preq
->tail
.assoclen
= cpu_to_le64(rctx
->assoclen
);
178 preq
->tail
.cryptlen
= cpu_to_le64(rctx
->cryptlen
);
179 sg_init_one(preq
->src
, &preq
->tail
, sizeof(preq
->tail
));
181 ahash_request_set_callback(&preq
->req
, rctx
->flags
,
182 poly_tail_done
, req
);
183 ahash_request_set_tfm(&preq
->req
, ctx
->poly
);
184 ahash_request_set_crypt(&preq
->req
, preq
->src
,
185 rctx
->tag
, sizeof(preq
->tail
));
187 err
= crypto_ahash_finup(&preq
->req
);
191 return poly_tail_continue(req
);
194 static void poly_cipherpad_done(struct crypto_async_request
*areq
, int err
)
196 async_done_continue(areq
->data
, err
, poly_tail
);
199 static int poly_cipherpad(struct aead_request
*req
)
201 struct chachapoly_ctx
*ctx
= crypto_aead_ctx(crypto_aead_reqtfm(req
));
202 struct chachapoly_req_ctx
*rctx
= aead_request_ctx(req
);
203 struct poly_req
*preq
= &rctx
->u
.poly
;
207 padlen
= -rctx
->cryptlen
% POLY1305_BLOCK_SIZE
;
208 memset(preq
->pad
, 0, sizeof(preq
->pad
));
209 sg_init_one(preq
->src
, preq
->pad
, padlen
);
211 ahash_request_set_callback(&preq
->req
, rctx
->flags
,
212 poly_cipherpad_done
, req
);
213 ahash_request_set_tfm(&preq
->req
, ctx
->poly
);
214 ahash_request_set_crypt(&preq
->req
, preq
->src
, NULL
, padlen
);
216 err
= crypto_ahash_update(&preq
->req
);
220 return poly_tail(req
);
223 static void poly_cipher_done(struct crypto_async_request
*areq
, int err
)
225 async_done_continue(areq
->data
, err
, poly_cipherpad
);
228 static int poly_cipher(struct aead_request
*req
)
230 struct chachapoly_ctx
*ctx
= crypto_aead_ctx(crypto_aead_reqtfm(req
));
231 struct chachapoly_req_ctx
*rctx
= aead_request_ctx(req
);
232 struct poly_req
*preq
= &rctx
->u
.poly
;
233 struct scatterlist
*crypt
= req
->src
;
236 if (rctx
->cryptlen
== req
->cryptlen
) /* encrypting */
239 crypt
= scatterwalk_ffwd(rctx
->src
, crypt
, req
->assoclen
);
241 ahash_request_set_callback(&preq
->req
, rctx
->flags
,
242 poly_cipher_done
, req
);
243 ahash_request_set_tfm(&preq
->req
, ctx
->poly
);
244 ahash_request_set_crypt(&preq
->req
, crypt
, NULL
, rctx
->cryptlen
);
246 err
= crypto_ahash_update(&preq
->req
);
250 return poly_cipherpad(req
);
253 static void poly_adpad_done(struct crypto_async_request
*areq
, int err
)
255 async_done_continue(areq
->data
, err
, poly_cipher
);
258 static int poly_adpad(struct aead_request
*req
)
260 struct chachapoly_ctx
*ctx
= crypto_aead_ctx(crypto_aead_reqtfm(req
));
261 struct chachapoly_req_ctx
*rctx
= aead_request_ctx(req
);
262 struct poly_req
*preq
= &rctx
->u
.poly
;
266 padlen
= -rctx
->assoclen
% POLY1305_BLOCK_SIZE
;
267 memset(preq
->pad
, 0, sizeof(preq
->pad
));
268 sg_init_one(preq
->src
, preq
->pad
, padlen
);
270 ahash_request_set_callback(&preq
->req
, rctx
->flags
,
271 poly_adpad_done
, req
);
272 ahash_request_set_tfm(&preq
->req
, ctx
->poly
);
273 ahash_request_set_crypt(&preq
->req
, preq
->src
, NULL
, padlen
);
275 err
= crypto_ahash_update(&preq
->req
);
279 return poly_cipher(req
);
282 static void poly_ad_done(struct crypto_async_request
*areq
, int err
)
284 async_done_continue(areq
->data
, err
, poly_adpad
);
287 static int poly_ad(struct aead_request
*req
)
289 struct chachapoly_ctx
*ctx
= crypto_aead_ctx(crypto_aead_reqtfm(req
));
290 struct chachapoly_req_ctx
*rctx
= aead_request_ctx(req
);
291 struct poly_req
*preq
= &rctx
->u
.poly
;
294 ahash_request_set_callback(&preq
->req
, rctx
->flags
,
296 ahash_request_set_tfm(&preq
->req
, ctx
->poly
);
297 ahash_request_set_crypt(&preq
->req
, req
->src
, NULL
, rctx
->assoclen
);
299 err
= crypto_ahash_update(&preq
->req
);
303 return poly_adpad(req
);
306 static void poly_setkey_done(struct crypto_async_request
*areq
, int err
)
308 async_done_continue(areq
->data
, err
, poly_ad
);
311 static int poly_setkey(struct aead_request
*req
)
313 struct chachapoly_ctx
*ctx
= crypto_aead_ctx(crypto_aead_reqtfm(req
));
314 struct chachapoly_req_ctx
*rctx
= aead_request_ctx(req
);
315 struct poly_req
*preq
= &rctx
->u
.poly
;
318 sg_init_one(preq
->src
, rctx
->key
, sizeof(rctx
->key
));
320 ahash_request_set_callback(&preq
->req
, rctx
->flags
,
321 poly_setkey_done
, req
);
322 ahash_request_set_tfm(&preq
->req
, ctx
->poly
);
323 ahash_request_set_crypt(&preq
->req
, preq
->src
, NULL
, sizeof(rctx
->key
));
325 err
= crypto_ahash_update(&preq
->req
);
332 static void poly_init_done(struct crypto_async_request
*areq
, int err
)
334 async_done_continue(areq
->data
, err
, poly_setkey
);
337 static int poly_init(struct aead_request
*req
)
339 struct chachapoly_ctx
*ctx
= crypto_aead_ctx(crypto_aead_reqtfm(req
));
340 struct chachapoly_req_ctx
*rctx
= aead_request_ctx(req
);
341 struct poly_req
*preq
= &rctx
->u
.poly
;
344 ahash_request_set_callback(&preq
->req
, rctx
->flags
,
345 poly_init_done
, req
);
346 ahash_request_set_tfm(&preq
->req
, ctx
->poly
);
348 err
= crypto_ahash_init(&preq
->req
);
352 return poly_setkey(req
);
355 static void poly_genkey_done(struct crypto_async_request
*areq
, int err
)
357 async_done_continue(areq
->data
, err
, poly_init
);
360 static int poly_genkey(struct aead_request
*req
)
362 struct crypto_aead
*tfm
= crypto_aead_reqtfm(req
);
363 struct chachapoly_ctx
*ctx
= crypto_aead_ctx(tfm
);
364 struct chachapoly_req_ctx
*rctx
= aead_request_ctx(req
);
365 struct chacha_req
*creq
= &rctx
->u
.chacha
;
368 rctx
->assoclen
= req
->assoclen
;
370 if (crypto_aead_ivsize(tfm
) == 8) {
371 if (rctx
->assoclen
< 8)
376 memset(rctx
->key
, 0, sizeof(rctx
->key
));
377 sg_init_one(creq
->src
, rctx
->key
, sizeof(rctx
->key
));
379 chacha_iv(creq
->iv
, req
, 0);
381 skcipher_request_set_callback(&creq
->req
, rctx
->flags
,
382 poly_genkey_done
, req
);
383 skcipher_request_set_tfm(&creq
->req
, ctx
->chacha
);
384 skcipher_request_set_crypt(&creq
->req
, creq
->src
, creq
->src
,
385 POLY1305_KEY_SIZE
, creq
->iv
);
387 err
= crypto_skcipher_decrypt(&creq
->req
);
391 return poly_init(req
);
394 static void chacha_encrypt_done(struct crypto_async_request
*areq
, int err
)
396 async_done_continue(areq
->data
, err
, poly_genkey
);
399 static int chacha_encrypt(struct aead_request
*req
)
401 struct chachapoly_ctx
*ctx
= crypto_aead_ctx(crypto_aead_reqtfm(req
));
402 struct chachapoly_req_ctx
*rctx
= aead_request_ctx(req
);
403 struct chacha_req
*creq
= &rctx
->u
.chacha
;
404 struct scatterlist
*src
, *dst
;
407 if (req
->cryptlen
== 0)
410 chacha_iv(creq
->iv
, req
, 1);
412 src
= scatterwalk_ffwd(rctx
->src
, req
->src
, req
->assoclen
);
414 if (req
->src
!= req
->dst
)
415 dst
= scatterwalk_ffwd(rctx
->dst
, req
->dst
, req
->assoclen
);
417 skcipher_request_set_callback(&creq
->req
, rctx
->flags
,
418 chacha_encrypt_done
, req
);
419 skcipher_request_set_tfm(&creq
->req
, ctx
->chacha
);
420 skcipher_request_set_crypt(&creq
->req
, src
, dst
,
421 req
->cryptlen
, creq
->iv
);
422 err
= crypto_skcipher_encrypt(&creq
->req
);
427 return poly_genkey(req
);
430 static int chachapoly_encrypt(struct aead_request
*req
)
432 struct chachapoly_req_ctx
*rctx
= aead_request_ctx(req
);
434 rctx
->cryptlen
= req
->cryptlen
;
435 rctx
->flags
= aead_request_flags(req
);
437 /* encrypt call chain:
438 * - chacha_encrypt/done()
439 * - poly_genkey/done()
441 * - poly_setkey/done()
443 * - poly_adpad/done()
444 * - poly_cipher/done()
445 * - poly_cipherpad/done()
446 * - poly_tail/done/continue()
449 return chacha_encrypt(req
);
452 static int chachapoly_decrypt(struct aead_request
*req
)
454 struct chachapoly_req_ctx
*rctx
= aead_request_ctx(req
);
456 rctx
->cryptlen
= req
->cryptlen
- POLY1305_DIGEST_SIZE
;
457 rctx
->flags
= aead_request_flags(req
);
459 /* decrypt call chain:
460 * - poly_genkey/done()
462 * - poly_setkey/done()
464 * - poly_adpad/done()
465 * - poly_cipher/done()
466 * - poly_cipherpad/done()
467 * - poly_tail/done/continue()
468 * - chacha_decrypt/done()
469 * - poly_verify_tag()
471 return poly_genkey(req
);
474 static int chachapoly_setkey(struct crypto_aead
*aead
, const u8
*key
,
477 struct chachapoly_ctx
*ctx
= crypto_aead_ctx(aead
);
479 if (keylen
!= ctx
->saltlen
+ CHACHA_KEY_SIZE
)
482 keylen
-= ctx
->saltlen
;
483 memcpy(ctx
->salt
, key
+ keylen
, ctx
->saltlen
);
485 crypto_skcipher_clear_flags(ctx
->chacha
, CRYPTO_TFM_REQ_MASK
);
486 crypto_skcipher_set_flags(ctx
->chacha
, crypto_aead_get_flags(aead
) &
487 CRYPTO_TFM_REQ_MASK
);
488 return crypto_skcipher_setkey(ctx
->chacha
, key
, keylen
);
491 static int chachapoly_setauthsize(struct crypto_aead
*tfm
,
492 unsigned int authsize
)
494 if (authsize
!= POLY1305_DIGEST_SIZE
)
500 static int chachapoly_init(struct crypto_aead
*tfm
)
502 struct aead_instance
*inst
= aead_alg_instance(tfm
);
503 struct chachapoly_instance_ctx
*ictx
= aead_instance_ctx(inst
);
504 struct chachapoly_ctx
*ctx
= crypto_aead_ctx(tfm
);
505 struct crypto_skcipher
*chacha
;
506 struct crypto_ahash
*poly
;
509 poly
= crypto_spawn_ahash(&ictx
->poly
);
511 return PTR_ERR(poly
);
513 chacha
= crypto_spawn_skcipher(&ictx
->chacha
);
514 if (IS_ERR(chacha
)) {
515 crypto_free_ahash(poly
);
516 return PTR_ERR(chacha
);
519 ctx
->chacha
= chacha
;
521 ctx
->saltlen
= ictx
->saltlen
;
523 align
= crypto_aead_alignmask(tfm
);
524 align
&= ~(crypto_tfm_ctx_alignment() - 1);
525 crypto_aead_set_reqsize(
527 align
+ offsetof(struct chachapoly_req_ctx
, u
) +
528 max(offsetof(struct chacha_req
, req
) +
529 sizeof(struct skcipher_request
) +
530 crypto_skcipher_reqsize(chacha
),
531 offsetof(struct poly_req
, req
) +
532 sizeof(struct ahash_request
) +
533 crypto_ahash_reqsize(poly
)));
538 static void chachapoly_exit(struct crypto_aead
*tfm
)
540 struct chachapoly_ctx
*ctx
= crypto_aead_ctx(tfm
);
542 crypto_free_ahash(ctx
->poly
);
543 crypto_free_skcipher(ctx
->chacha
);
546 static void chachapoly_free(struct aead_instance
*inst
)
548 struct chachapoly_instance_ctx
*ctx
= aead_instance_ctx(inst
);
550 crypto_drop_skcipher(&ctx
->chacha
);
551 crypto_drop_ahash(&ctx
->poly
);
555 static int chachapoly_create(struct crypto_template
*tmpl
, struct rtattr
**tb
,
556 const char *name
, unsigned int ivsize
)
558 struct crypto_attr_type
*algt
;
560 struct aead_instance
*inst
;
561 struct chachapoly_instance_ctx
*ctx
;
562 struct skcipher_alg
*chacha
;
563 struct hash_alg_common
*poly
;
566 if (ivsize
> CHACHAPOLY_IV_SIZE
)
569 algt
= crypto_get_attr_type(tb
);
571 return PTR_ERR(algt
);
573 if ((algt
->type
^ CRYPTO_ALG_TYPE_AEAD
) & algt
->mask
)
576 mask
= crypto_requires_sync(algt
->type
, algt
->mask
);
578 inst
= kzalloc(sizeof(*inst
) + sizeof(*ctx
), GFP_KERNEL
);
581 ctx
= aead_instance_ctx(inst
);
582 ctx
->saltlen
= CHACHAPOLY_IV_SIZE
- ivsize
;
584 err
= crypto_grab_skcipher(&ctx
->chacha
, aead_crypto_instance(inst
),
585 crypto_attr_alg_name(tb
[1]), 0, mask
);
588 chacha
= crypto_spawn_skcipher_alg(&ctx
->chacha
);
590 err
= crypto_grab_ahash(&ctx
->poly
, aead_crypto_instance(inst
),
591 crypto_attr_alg_name(tb
[2]), 0, mask
);
594 poly
= crypto_spawn_ahash_alg(&ctx
->poly
);
597 if (poly
->digestsize
!= POLY1305_DIGEST_SIZE
)
599 /* Need 16-byte IV size, including Initial Block Counter value */
600 if (crypto_skcipher_alg_ivsize(chacha
) != CHACHA_IV_SIZE
)
602 /* Not a stream cipher? */
603 if (chacha
->base
.cra_blocksize
!= 1)
607 if (snprintf(inst
->alg
.base
.cra_name
, CRYPTO_MAX_ALG_NAME
,
608 "%s(%s,%s)", name
, chacha
->base
.cra_name
,
609 poly
->base
.cra_name
) >= CRYPTO_MAX_ALG_NAME
)
611 if (snprintf(inst
->alg
.base
.cra_driver_name
, CRYPTO_MAX_ALG_NAME
,
612 "%s(%s,%s)", name
, chacha
->base
.cra_driver_name
,
613 poly
->base
.cra_driver_name
) >= CRYPTO_MAX_ALG_NAME
)
616 inst
->alg
.base
.cra_flags
= (chacha
->base
.cra_flags
|
617 poly
->base
.cra_flags
) & CRYPTO_ALG_ASYNC
;
618 inst
->alg
.base
.cra_priority
= (chacha
->base
.cra_priority
+
619 poly
->base
.cra_priority
) / 2;
620 inst
->alg
.base
.cra_blocksize
= 1;
621 inst
->alg
.base
.cra_alignmask
= chacha
->base
.cra_alignmask
|
622 poly
->base
.cra_alignmask
;
623 inst
->alg
.base
.cra_ctxsize
= sizeof(struct chachapoly_ctx
) +
625 inst
->alg
.ivsize
= ivsize
;
626 inst
->alg
.chunksize
= crypto_skcipher_alg_chunksize(chacha
);
627 inst
->alg
.maxauthsize
= POLY1305_DIGEST_SIZE
;
628 inst
->alg
.init
= chachapoly_init
;
629 inst
->alg
.exit
= chachapoly_exit
;
630 inst
->alg
.encrypt
= chachapoly_encrypt
;
631 inst
->alg
.decrypt
= chachapoly_decrypt
;
632 inst
->alg
.setkey
= chachapoly_setkey
;
633 inst
->alg
.setauthsize
= chachapoly_setauthsize
;
635 inst
->free
= chachapoly_free
;
637 err
= aead_register_instance(tmpl
, inst
);
640 chachapoly_free(inst
);
645 static int rfc7539_create(struct crypto_template
*tmpl
, struct rtattr
**tb
)
647 return chachapoly_create(tmpl
, tb
, "rfc7539", 12);
650 static int rfc7539esp_create(struct crypto_template
*tmpl
, struct rtattr
**tb
)
652 return chachapoly_create(tmpl
, tb
, "rfc7539esp", 8);
655 static struct crypto_template rfc7539_tmpls
[] = {
658 .create
= rfc7539_create
,
659 .module
= THIS_MODULE
,
661 .name
= "rfc7539esp",
662 .create
= rfc7539esp_create
,
663 .module
= THIS_MODULE
,
667 static int __init
chacha20poly1305_module_init(void)
669 return crypto_register_templates(rfc7539_tmpls
,
670 ARRAY_SIZE(rfc7539_tmpls
));
673 static void __exit
chacha20poly1305_module_exit(void)
675 crypto_unregister_templates(rfc7539_tmpls
,
676 ARRAY_SIZE(rfc7539_tmpls
));
679 subsys_initcall(chacha20poly1305_module_init
);
680 module_exit(chacha20poly1305_module_exit
);
682 MODULE_LICENSE("GPL");
683 MODULE_AUTHOR("Martin Willi <martin@strongswan.org>");
684 MODULE_DESCRIPTION("ChaCha20-Poly1305 AEAD");
685 MODULE_ALIAS_CRYPTO("rfc7539");
686 MODULE_ALIAS_CRYPTO("rfc7539esp");