1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Authenc: Simple AEAD wrapper for IPsec
5 * Copyright (c) 2007-2015 Herbert Xu <herbert@gondor.apana.org.au>
8 #include <crypto/internal/aead.h>
9 #include <crypto/internal/hash.h>
10 #include <crypto/internal/skcipher.h>
11 #include <crypto/authenc.h>
12 #include <crypto/null.h>
13 #include <crypto/scatterwalk.h>
14 #include <linux/err.h>
15 #include <linux/init.h>
16 #include <linux/kernel.h>
17 #include <linux/module.h>
18 #include <linux/rtnetlink.h>
19 #include <linux/slab.h>
20 #include <linux/spinlock.h>
22 struct authenc_instance_ctx {
23 struct crypto_ahash_spawn auth;
24 struct crypto_skcipher_spawn enc;
28 struct crypto_authenc_ctx {
29 struct crypto_ahash *auth;
30 struct crypto_skcipher *enc;
31 struct crypto_sync_skcipher *null;
34 struct authenc_request_ctx {
35 struct scatterlist src[2];
36 struct scatterlist dst[2];
40 static void authenc_request_complete(struct aead_request *req, int err)
42 if (err != -EINPROGRESS)
43 aead_request_complete(req, err);
46 int crypto_authenc_extractkeys(struct crypto_authenc_keys *keys, const u8 *key,
49 struct rtattr *rta = (struct rtattr *)key;
50 struct crypto_authenc_key_param *param;
52 if (!RTA_OK(rta, keylen))
54 if (rta->rta_type != CRYPTO_AUTHENC_KEYA_PARAM)
58 * RTA_OK() didn't align the rtattr's payload when validating that it
59 * fits in the buffer. Yet, the keys should start on the next 4-byte
60 * aligned boundary. To avoid confusion, require that the rtattr
61 * payload be exactly the param struct, which has a 4-byte aligned size.
63 if (RTA_PAYLOAD(rta) != sizeof(*param))
65 BUILD_BUG_ON(sizeof(*param) % RTA_ALIGNTO);
67 param = RTA_DATA(rta);
68 keys->enckeylen = be32_to_cpu(param->enckeylen);
71 keylen -= rta->rta_len;
73 if (keylen < keys->enckeylen)
76 keys->authkeylen = keylen - keys->enckeylen;
78 keys->enckey = key + keys->authkeylen;
82 EXPORT_SYMBOL_GPL(crypto_authenc_extractkeys);
84 static int crypto_authenc_setkey(struct crypto_aead *authenc, const u8 *key,
87 struct crypto_authenc_ctx *ctx = crypto_aead_ctx(authenc);
88 struct crypto_ahash *auth = ctx->auth;
89 struct crypto_skcipher *enc = ctx->enc;
90 struct crypto_authenc_keys keys;
93 if (crypto_authenc_extractkeys(&keys, key, keylen) != 0)
96 crypto_ahash_clear_flags(auth, CRYPTO_TFM_REQ_MASK);
97 crypto_ahash_set_flags(auth, crypto_aead_get_flags(authenc) &
99 err = crypto_ahash_setkey(auth, keys.authkey, keys.authkeylen);
103 crypto_skcipher_clear_flags(enc, CRYPTO_TFM_REQ_MASK);
104 crypto_skcipher_set_flags(enc, crypto_aead_get_flags(authenc) &
105 CRYPTO_TFM_REQ_MASK);
106 err = crypto_skcipher_setkey(enc, keys.enckey, keys.enckeylen);
108 memzero_explicit(&keys, sizeof(keys));
112 static void authenc_geniv_ahash_done(struct crypto_async_request *areq, int err)
114 struct aead_request *req = areq->data;
115 struct crypto_aead *authenc = crypto_aead_reqtfm(req);
116 struct aead_instance *inst = aead_alg_instance(authenc);
117 struct authenc_instance_ctx *ictx = aead_instance_ctx(inst);
118 struct authenc_request_ctx *areq_ctx = aead_request_ctx(req);
119 struct ahash_request *ahreq = (void *)(areq_ctx->tail + ictx->reqoff);
124 scatterwalk_map_and_copy(ahreq->result, req->dst,
125 req->assoclen + req->cryptlen,
126 crypto_aead_authsize(authenc), 1);
129 aead_request_complete(req, err);
132 static int crypto_authenc_genicv(struct aead_request *req, unsigned int flags)
134 struct crypto_aead *authenc = crypto_aead_reqtfm(req);
135 struct aead_instance *inst = aead_alg_instance(authenc);
136 struct crypto_authenc_ctx *ctx = crypto_aead_ctx(authenc);
137 struct authenc_instance_ctx *ictx = aead_instance_ctx(inst);
138 struct crypto_ahash *auth = ctx->auth;
139 struct authenc_request_ctx *areq_ctx = aead_request_ctx(req);
140 struct ahash_request *ahreq = (void *)(areq_ctx->tail + ictx->reqoff);
141 u8 *hash = areq_ctx->tail;
144 hash = (u8 *)ALIGN((unsigned long)hash + crypto_ahash_alignmask(auth),
145 crypto_ahash_alignmask(auth) + 1);
147 ahash_request_set_tfm(ahreq, auth);
148 ahash_request_set_crypt(ahreq, req->dst, hash,
149 req->assoclen + req->cryptlen);
150 ahash_request_set_callback(ahreq, flags,
151 authenc_geniv_ahash_done, req);
153 err = crypto_ahash_digest(ahreq);
157 scatterwalk_map_and_copy(hash, req->dst, req->assoclen + req->cryptlen,
158 crypto_aead_authsize(authenc), 1);
163 static void crypto_authenc_encrypt_done(struct crypto_async_request *req,
166 struct aead_request *areq = req->data;
171 err = crypto_authenc_genicv(areq, 0);
174 authenc_request_complete(areq, err);
177 static int crypto_authenc_copy_assoc(struct aead_request *req)
179 struct crypto_aead *authenc = crypto_aead_reqtfm(req);
180 struct crypto_authenc_ctx *ctx = crypto_aead_ctx(authenc);
181 SYNC_SKCIPHER_REQUEST_ON_STACK(skreq, ctx->null);
183 skcipher_request_set_sync_tfm(skreq, ctx->null);
184 skcipher_request_set_callback(skreq, aead_request_flags(req),
186 skcipher_request_set_crypt(skreq, req->src, req->dst, req->assoclen,
189 return crypto_skcipher_encrypt(skreq);
192 static int crypto_authenc_encrypt(struct aead_request *req)
194 struct crypto_aead *authenc = crypto_aead_reqtfm(req);
195 struct aead_instance *inst = aead_alg_instance(authenc);
196 struct crypto_authenc_ctx *ctx = crypto_aead_ctx(authenc);
197 struct authenc_instance_ctx *ictx = aead_instance_ctx(inst);
198 struct authenc_request_ctx *areq_ctx = aead_request_ctx(req);
199 struct crypto_skcipher *enc = ctx->enc;
200 unsigned int cryptlen = req->cryptlen;
201 struct skcipher_request *skreq = (void *)(areq_ctx->tail +
203 struct scatterlist *src, *dst;
206 src = scatterwalk_ffwd(areq_ctx->src, req->src, req->assoclen);
209 if (req->src != req->dst) {
210 err = crypto_authenc_copy_assoc(req);
214 dst = scatterwalk_ffwd(areq_ctx->dst, req->dst, req->assoclen);
217 skcipher_request_set_tfm(skreq, enc);
218 skcipher_request_set_callback(skreq, aead_request_flags(req),
219 crypto_authenc_encrypt_done, req);
220 skcipher_request_set_crypt(skreq, src, dst, cryptlen, req->iv);
222 err = crypto_skcipher_encrypt(skreq);
226 return crypto_authenc_genicv(req, aead_request_flags(req));
229 static int crypto_authenc_decrypt_tail(struct aead_request *req,
232 struct crypto_aead *authenc = crypto_aead_reqtfm(req);
233 struct aead_instance *inst = aead_alg_instance(authenc);
234 struct crypto_authenc_ctx *ctx = crypto_aead_ctx(authenc);
235 struct authenc_instance_ctx *ictx = aead_instance_ctx(inst);
236 struct authenc_request_ctx *areq_ctx = aead_request_ctx(req);
237 struct ahash_request *ahreq = (void *)(areq_ctx->tail + ictx->reqoff);
238 struct skcipher_request *skreq = (void *)(areq_ctx->tail +
240 unsigned int authsize = crypto_aead_authsize(authenc);
241 u8 *ihash = ahreq->result + authsize;
242 struct scatterlist *src, *dst;
244 scatterwalk_map_and_copy(ihash, req->src, ahreq->nbytes, authsize, 0);
246 if (crypto_memneq(ihash, ahreq->result, authsize))
249 src = scatterwalk_ffwd(areq_ctx->src, req->src, req->assoclen);
252 if (req->src != req->dst)
253 dst = scatterwalk_ffwd(areq_ctx->dst, req->dst, req->assoclen);
255 skcipher_request_set_tfm(skreq, ctx->enc);
256 skcipher_request_set_callback(skreq, flags,
257 req->base.complete, req->base.data);
258 skcipher_request_set_crypt(skreq, src, dst,
259 req->cryptlen - authsize, req->iv);
261 return crypto_skcipher_decrypt(skreq);
264 static void authenc_verify_ahash_done(struct crypto_async_request *areq,
267 struct aead_request *req = areq->data;
272 err = crypto_authenc_decrypt_tail(req, 0);
275 authenc_request_complete(req, err);
278 static int crypto_authenc_decrypt(struct aead_request *req)
280 struct crypto_aead *authenc = crypto_aead_reqtfm(req);
281 unsigned int authsize = crypto_aead_authsize(authenc);
282 struct aead_instance *inst = aead_alg_instance(authenc);
283 struct crypto_authenc_ctx *ctx = crypto_aead_ctx(authenc);
284 struct authenc_instance_ctx *ictx = aead_instance_ctx(inst);
285 struct crypto_ahash *auth = ctx->auth;
286 struct authenc_request_ctx *areq_ctx = aead_request_ctx(req);
287 struct ahash_request *ahreq = (void *)(areq_ctx->tail + ictx->reqoff);
288 u8 *hash = areq_ctx->tail;
291 hash = (u8 *)ALIGN((unsigned long)hash + crypto_ahash_alignmask(auth),
292 crypto_ahash_alignmask(auth) + 1);
294 ahash_request_set_tfm(ahreq, auth);
295 ahash_request_set_crypt(ahreq, req->src, hash,
296 req->assoclen + req->cryptlen - authsize);
297 ahash_request_set_callback(ahreq, aead_request_flags(req),
298 authenc_verify_ahash_done, req);
300 err = crypto_ahash_digest(ahreq);
304 return crypto_authenc_decrypt_tail(req, aead_request_flags(req));
307 static int crypto_authenc_init_tfm(struct crypto_aead *tfm)
309 struct aead_instance *inst = aead_alg_instance(tfm);
310 struct authenc_instance_ctx *ictx = aead_instance_ctx(inst);
311 struct crypto_authenc_ctx *ctx = crypto_aead_ctx(tfm);
312 struct crypto_ahash *auth;
313 struct crypto_skcipher *enc;
314 struct crypto_sync_skcipher *null;
317 auth = crypto_spawn_ahash(&ictx->auth);
319 return PTR_ERR(auth);
321 enc = crypto_spawn_skcipher(&ictx->enc);
326 null = crypto_get_default_null_skcipher();
329 goto err_free_skcipher;
335 crypto_aead_set_reqsize(
337 sizeof(struct authenc_request_ctx) +
340 crypto_ahash_reqsize(auth) +
341 sizeof(struct ahash_request),
342 sizeof(struct skcipher_request) +
343 crypto_skcipher_reqsize(enc)));
348 crypto_free_skcipher(enc);
350 crypto_free_ahash(auth);
354 static void crypto_authenc_exit_tfm(struct crypto_aead *tfm)
356 struct crypto_authenc_ctx *ctx = crypto_aead_ctx(tfm);
358 crypto_free_ahash(ctx->auth);
359 crypto_free_skcipher(ctx->enc);
360 crypto_put_default_null_skcipher();
363 static void crypto_authenc_free(struct aead_instance *inst)
365 struct authenc_instance_ctx *ctx = aead_instance_ctx(inst);
367 crypto_drop_skcipher(&ctx->enc);
368 crypto_drop_ahash(&ctx->auth);
372 static int crypto_authenc_create(struct crypto_template *tmpl,
376 struct aead_instance *inst;
377 struct authenc_instance_ctx *ctx;
378 struct hash_alg_common *auth;
379 struct crypto_alg *auth_base;
380 struct skcipher_alg *enc;
383 err = crypto_check_attr_type(tb, CRYPTO_ALG_TYPE_AEAD, &mask);
387 inst = kzalloc(sizeof(*inst) + sizeof(*ctx), GFP_KERNEL);
390 ctx = aead_instance_ctx(inst);
392 err = crypto_grab_ahash(&ctx->auth, aead_crypto_instance(inst),
393 crypto_attr_alg_name(tb[1]), 0, mask);
396 auth = crypto_spawn_ahash_alg(&ctx->auth);
397 auth_base = &auth->base;
399 err = crypto_grab_skcipher(&ctx->enc, aead_crypto_instance(inst),
400 crypto_attr_alg_name(tb[2]), 0, mask);
403 enc = crypto_spawn_skcipher_alg(&ctx->enc);
405 ctx->reqoff = ALIGN(2 * auth->digestsize + auth_base->cra_alignmask,
406 auth_base->cra_alignmask + 1);
409 if (snprintf(inst->alg.base.cra_name, CRYPTO_MAX_ALG_NAME,
410 "authenc(%s,%s)", auth_base->cra_name,
411 enc->base.cra_name) >=
415 if (snprintf(inst->alg.base.cra_driver_name, CRYPTO_MAX_ALG_NAME,
416 "authenc(%s,%s)", auth_base->cra_driver_name,
417 enc->base.cra_driver_name) >= CRYPTO_MAX_ALG_NAME)
420 inst->alg.base.cra_priority = enc->base.cra_priority * 10 +
421 auth_base->cra_priority;
422 inst->alg.base.cra_blocksize = enc->base.cra_blocksize;
423 inst->alg.base.cra_alignmask = auth_base->cra_alignmask |
424 enc->base.cra_alignmask;
425 inst->alg.base.cra_ctxsize = sizeof(struct crypto_authenc_ctx);
427 inst->alg.ivsize = crypto_skcipher_alg_ivsize(enc);
428 inst->alg.chunksize = crypto_skcipher_alg_chunksize(enc);
429 inst->alg.maxauthsize = auth->digestsize;
431 inst->alg.init = crypto_authenc_init_tfm;
432 inst->alg.exit = crypto_authenc_exit_tfm;
434 inst->alg.setkey = crypto_authenc_setkey;
435 inst->alg.encrypt = crypto_authenc_encrypt;
436 inst->alg.decrypt = crypto_authenc_decrypt;
438 inst->free = crypto_authenc_free;
440 err = aead_register_instance(tmpl, inst);
443 crypto_authenc_free(inst);
448 static struct crypto_template crypto_authenc_tmpl = {
450 .create = crypto_authenc_create,
451 .module = THIS_MODULE,
454 static int __init crypto_authenc_module_init(void)
456 return crypto_register_template(&crypto_authenc_tmpl);
459 static void __exit crypto_authenc_module_exit(void)
461 crypto_unregister_template(&crypto_authenc_tmpl);
464 subsys_initcall(crypto_authenc_module_init);
465 module_exit(crypto_authenc_module_exit);
467 MODULE_LICENSE("GPL");
468 MODULE_DESCRIPTION("Simple AEAD wrapper for IPsec");
469 MODULE_ALIAS_CRYPTO("authenc");