1 // SPDX-License-Identifier: GPL-2.0-only
3 * Accelerated GHASH implementation with ARMv8 vmull.p64 instructions.
5 * Copyright (C) 2015 - 2018 Linaro Ltd. <ard.biesheuvel@linaro.org>
11 #include <asm/unaligned.h>
12 #include <crypto/cryptd.h>
13 #include <crypto/internal/hash.h>
14 #include <crypto/internal/simd.h>
15 #include <crypto/gf128mul.h>
16 #include <linux/cpufeature.h>
17 #include <linux/crypto.h>
18 #include <linux/module.h>
20 MODULE_DESCRIPTION("GHASH secure hash using ARMv8 Crypto Extensions");
21 MODULE_AUTHOR("Ard Biesheuvel <ard.biesheuvel@linaro.org>");
22 MODULE_LICENSE("GPL v2");
23 MODULE_ALIAS_CRYPTO("ghash");
25 #define GHASH_BLOCK_SIZE 16
26 #define GHASH_DIGEST_SIZE 16
35 struct ghash_desc_ctx {
36 u64 digest[GHASH_DIGEST_SIZE/sizeof(u64)];
37 u8 buf[GHASH_BLOCK_SIZE];
41 struct ghash_async_ctx {
42 struct cryptd_ahash *cryptd_tfm;
45 asmlinkage void pmull_ghash_update_p64(int blocks, u64 dg[], const char *src,
46 struct ghash_key const *k,
49 asmlinkage void pmull_ghash_update_p8(int blocks, u64 dg[], const char *src,
50 struct ghash_key const *k,
53 static void (*pmull_ghash_update)(int blocks, u64 dg[], const char *src,
54 struct ghash_key const *k,
57 static int ghash_init(struct shash_desc *desc)
59 struct ghash_desc_ctx *ctx = shash_desc_ctx(desc);
61 *ctx = (struct ghash_desc_ctx){};
65 static int ghash_update(struct shash_desc *desc, const u8 *src,
68 struct ghash_desc_ctx *ctx = shash_desc_ctx(desc);
69 unsigned int partial = ctx->count % GHASH_BLOCK_SIZE;
73 if ((partial + len) >= GHASH_BLOCK_SIZE) {
74 struct ghash_key *key = crypto_shash_ctx(desc->tfm);
78 int p = GHASH_BLOCK_SIZE - partial;
80 memcpy(ctx->buf + partial, src, p);
85 blocks = len / GHASH_BLOCK_SIZE;
86 len %= GHASH_BLOCK_SIZE;
89 pmull_ghash_update(blocks, ctx->digest, src, key,
90 partial ? ctx->buf : NULL);
92 src += blocks * GHASH_BLOCK_SIZE;
96 memcpy(ctx->buf + partial, src, len);
100 static int ghash_final(struct shash_desc *desc, u8 *dst)
102 struct ghash_desc_ctx *ctx = shash_desc_ctx(desc);
103 unsigned int partial = ctx->count % GHASH_BLOCK_SIZE;
106 struct ghash_key *key = crypto_shash_ctx(desc->tfm);
108 memset(ctx->buf + partial, 0, GHASH_BLOCK_SIZE - partial);
110 pmull_ghash_update(1, ctx->digest, ctx->buf, key, NULL);
113 put_unaligned_be64(ctx->digest[1], dst);
114 put_unaligned_be64(ctx->digest[0], dst + 8);
116 *ctx = (struct ghash_desc_ctx){};
120 static void ghash_reflect(u64 h[], const be128 *k)
122 u64 carry = be64_to_cpu(k->a) >> 63;
124 h[0] = (be64_to_cpu(k->b) << 1) | carry;
125 h[1] = (be64_to_cpu(k->a) << 1) | (be64_to_cpu(k->b) >> 63);
128 h[1] ^= 0xc200000000000000UL;
131 static int ghash_setkey(struct crypto_shash *tfm,
132 const u8 *inkey, unsigned int keylen)
134 struct ghash_key *key = crypto_shash_ctx(tfm);
137 if (keylen != GHASH_BLOCK_SIZE) {
138 crypto_shash_set_flags(tfm, CRYPTO_TFM_RES_BAD_KEY_LEN);
142 memcpy(&k, inkey, GHASH_BLOCK_SIZE);
143 ghash_reflect(key->h, &k);
146 gf128mul_lle(&h, &k);
147 ghash_reflect(key->h2, &h);
149 gf128mul_lle(&h, &k);
150 ghash_reflect(key->h3, &h);
152 gf128mul_lle(&h, &k);
153 ghash_reflect(key->h4, &h);
158 static struct shash_alg ghash_alg = {
159 .digestsize = GHASH_DIGEST_SIZE,
161 .update = ghash_update,
162 .final = ghash_final,
163 .setkey = ghash_setkey,
164 .descsize = sizeof(struct ghash_desc_ctx),
166 .cra_name = "__ghash",
167 .cra_driver_name = "__driver-ghash-ce",
169 .cra_flags = CRYPTO_ALG_INTERNAL,
170 .cra_blocksize = GHASH_BLOCK_SIZE,
171 .cra_ctxsize = sizeof(struct ghash_key),
172 .cra_module = THIS_MODULE,
176 static int ghash_async_init(struct ahash_request *req)
178 struct crypto_ahash *tfm = crypto_ahash_reqtfm(req);
179 struct ghash_async_ctx *ctx = crypto_ahash_ctx(tfm);
180 struct ahash_request *cryptd_req = ahash_request_ctx(req);
181 struct cryptd_ahash *cryptd_tfm = ctx->cryptd_tfm;
182 struct shash_desc *desc = cryptd_shash_desc(cryptd_req);
183 struct crypto_shash *child = cryptd_ahash_child(cryptd_tfm);
186 return crypto_shash_init(desc);
189 static int ghash_async_update(struct ahash_request *req)
191 struct ahash_request *cryptd_req = ahash_request_ctx(req);
192 struct crypto_ahash *tfm = crypto_ahash_reqtfm(req);
193 struct ghash_async_ctx *ctx = crypto_ahash_ctx(tfm);
194 struct cryptd_ahash *cryptd_tfm = ctx->cryptd_tfm;
196 if (!crypto_simd_usable() ||
197 (in_atomic() && cryptd_ahash_queued(cryptd_tfm))) {
198 memcpy(cryptd_req, req, sizeof(*req));
199 ahash_request_set_tfm(cryptd_req, &cryptd_tfm->base);
200 return crypto_ahash_update(cryptd_req);
202 struct shash_desc *desc = cryptd_shash_desc(cryptd_req);
203 return shash_ahash_update(req, desc);
207 static int ghash_async_final(struct ahash_request *req)
209 struct ahash_request *cryptd_req = ahash_request_ctx(req);
210 struct crypto_ahash *tfm = crypto_ahash_reqtfm(req);
211 struct ghash_async_ctx *ctx = crypto_ahash_ctx(tfm);
212 struct cryptd_ahash *cryptd_tfm = ctx->cryptd_tfm;
214 if (!crypto_simd_usable() ||
215 (in_atomic() && cryptd_ahash_queued(cryptd_tfm))) {
216 memcpy(cryptd_req, req, sizeof(*req));
217 ahash_request_set_tfm(cryptd_req, &cryptd_tfm->base);
218 return crypto_ahash_final(cryptd_req);
220 struct shash_desc *desc = cryptd_shash_desc(cryptd_req);
221 return crypto_shash_final(desc, req->result);
225 static int ghash_async_digest(struct ahash_request *req)
227 struct crypto_ahash *tfm = crypto_ahash_reqtfm(req);
228 struct ghash_async_ctx *ctx = crypto_ahash_ctx(tfm);
229 struct ahash_request *cryptd_req = ahash_request_ctx(req);
230 struct cryptd_ahash *cryptd_tfm = ctx->cryptd_tfm;
232 if (!crypto_simd_usable() ||
233 (in_atomic() && cryptd_ahash_queued(cryptd_tfm))) {
234 memcpy(cryptd_req, req, sizeof(*req));
235 ahash_request_set_tfm(cryptd_req, &cryptd_tfm->base);
236 return crypto_ahash_digest(cryptd_req);
238 struct shash_desc *desc = cryptd_shash_desc(cryptd_req);
239 struct crypto_shash *child = cryptd_ahash_child(cryptd_tfm);
242 return shash_ahash_digest(req, desc);
246 static int ghash_async_import(struct ahash_request *req, const void *in)
248 struct ahash_request *cryptd_req = ahash_request_ctx(req);
249 struct crypto_ahash *tfm = crypto_ahash_reqtfm(req);
250 struct ghash_async_ctx *ctx = crypto_ahash_ctx(tfm);
251 struct shash_desc *desc = cryptd_shash_desc(cryptd_req);
253 desc->tfm = cryptd_ahash_child(ctx->cryptd_tfm);
255 return crypto_shash_import(desc, in);
258 static int ghash_async_export(struct ahash_request *req, void *out)
260 struct ahash_request *cryptd_req = ahash_request_ctx(req);
261 struct shash_desc *desc = cryptd_shash_desc(cryptd_req);
263 return crypto_shash_export(desc, out);
266 static int ghash_async_setkey(struct crypto_ahash *tfm, const u8 *key,
269 struct ghash_async_ctx *ctx = crypto_ahash_ctx(tfm);
270 struct crypto_ahash *child = &ctx->cryptd_tfm->base;
273 crypto_ahash_clear_flags(child, CRYPTO_TFM_REQ_MASK);
274 crypto_ahash_set_flags(child, crypto_ahash_get_flags(tfm)
275 & CRYPTO_TFM_REQ_MASK);
276 err = crypto_ahash_setkey(child, key, keylen);
277 crypto_ahash_set_flags(tfm, crypto_ahash_get_flags(child)
278 & CRYPTO_TFM_RES_MASK);
283 static int ghash_async_init_tfm(struct crypto_tfm *tfm)
285 struct cryptd_ahash *cryptd_tfm;
286 struct ghash_async_ctx *ctx = crypto_tfm_ctx(tfm);
288 cryptd_tfm = cryptd_alloc_ahash("__driver-ghash-ce",
290 CRYPTO_ALG_INTERNAL);
291 if (IS_ERR(cryptd_tfm))
292 return PTR_ERR(cryptd_tfm);
293 ctx->cryptd_tfm = cryptd_tfm;
294 crypto_ahash_set_reqsize(__crypto_ahash_cast(tfm),
295 sizeof(struct ahash_request) +
296 crypto_ahash_reqsize(&cryptd_tfm->base));
301 static void ghash_async_exit_tfm(struct crypto_tfm *tfm)
303 struct ghash_async_ctx *ctx = crypto_tfm_ctx(tfm);
305 cryptd_free_ahash(ctx->cryptd_tfm);
308 static struct ahash_alg ghash_async_alg = {
309 .init = ghash_async_init,
310 .update = ghash_async_update,
311 .final = ghash_async_final,
312 .setkey = ghash_async_setkey,
313 .digest = ghash_async_digest,
314 .import = ghash_async_import,
315 .export = ghash_async_export,
316 .halg.digestsize = GHASH_DIGEST_SIZE,
317 .halg.statesize = sizeof(struct ghash_desc_ctx),
320 .cra_driver_name = "ghash-ce",
322 .cra_flags = CRYPTO_ALG_ASYNC,
323 .cra_blocksize = GHASH_BLOCK_SIZE,
324 .cra_ctxsize = sizeof(struct ghash_async_ctx),
325 .cra_module = THIS_MODULE,
326 .cra_init = ghash_async_init_tfm,
327 .cra_exit = ghash_async_exit_tfm,
331 static int __init ghash_ce_mod_init(void)
335 if (!(elf_hwcap & HWCAP_NEON))
338 if (elf_hwcap2 & HWCAP2_PMULL)
339 pmull_ghash_update = pmull_ghash_update_p64;
341 pmull_ghash_update = pmull_ghash_update_p8;
343 err = crypto_register_shash(&ghash_alg);
346 err = crypto_register_ahash(&ghash_async_alg);
353 crypto_unregister_shash(&ghash_alg);
357 static void __exit ghash_ce_mod_exit(void)
359 crypto_unregister_ahash(&ghash_async_alg);
360 crypto_unregister_shash(&ghash_alg);
363 module_init(ghash_ce_mod_init);
364 module_exit(ghash_ce_mod_exit);