2 * AMD Cryptographic Coprocessor (CCP) SHA crypto API support
4 * Copyright (C) 2013 Advanced Micro Devices, Inc.
6 * Author: Tom Lendacky <thomas.lendacky@amd.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/module.h>
14 #include <linux/sched.h>
15 #include <linux/delay.h>
16 #include <linux/scatterlist.h>
17 #include <linux/crypto.h>
18 #include <crypto/algapi.h>
19 #include <crypto/hash.h>
20 #include <crypto/internal/hash.h>
21 #include <crypto/sha.h>
22 #include <crypto/scatterwalk.h>
24 #include "ccp-crypto.h"
27 static int ccp_sha_complete(struct crypto_async_request *async_req, int ret)
29 struct ahash_request *req = ahash_request_cast(async_req);
30 struct crypto_ahash *tfm = crypto_ahash_reqtfm(req);
31 struct ccp_sha_req_ctx *rctx = ahash_request_ctx(req);
32 unsigned int digest_size = crypto_ahash_digestsize(tfm);
38 /* Save remaining data to buffer */
39 unsigned int offset = rctx->nbytes - rctx->hash_rem;
40 scatterwalk_map_and_copy(rctx->buf, rctx->src,
41 offset, rctx->hash_rem, 0);
42 rctx->buf_count = rctx->hash_rem;
46 /* Update result area if supplied */
48 memcpy(req->result, rctx->ctx, digest_size);
51 sg_free_table(&rctx->data_sg);
56 static int ccp_do_sha_update(struct ahash_request *req, unsigned int nbytes,
59 struct crypto_ahash *tfm = crypto_ahash_reqtfm(req);
60 struct ccp_ctx *ctx = crypto_ahash_ctx(tfm);
61 struct ccp_sha_req_ctx *rctx = ahash_request_ctx(req);
62 struct scatterlist *sg;
63 unsigned int block_size =
64 crypto_tfm_alg_blocksize(crypto_ahash_tfm(tfm));
65 unsigned int sg_count;
70 len = (u64)rctx->buf_count + (u64)nbytes;
72 if (!final && (len <= block_size)) {
73 scatterwalk_map_and_copy(rctx->buf + rctx->buf_count, req->src,
75 rctx->buf_count += nbytes;
81 rctx->nbytes = nbytes;
84 rctx->hash_rem = final ? 0 : len & (block_size - 1);
85 rctx->hash_cnt = len - rctx->hash_rem;
86 if (!final && !rctx->hash_rem) {
87 /* CCP can't do zero length final, so keep some data around */
88 rctx->hash_cnt -= block_size;
89 rctx->hash_rem = block_size;
92 /* Initialize the context scatterlist */
93 sg_init_one(&rctx->ctx_sg, rctx->ctx, sizeof(rctx->ctx));
96 if (rctx->buf_count && nbytes) {
97 /* Build the data scatterlist table - allocate enough entries
98 * for both data pieces (buffer and input data)
100 gfp = req->base.flags & CRYPTO_TFM_REQ_MAY_SLEEP ?
101 GFP_KERNEL : GFP_ATOMIC;
102 sg_count = sg_nents(req->src) + 1;
103 ret = sg_alloc_table(&rctx->data_sg, sg_count, gfp);
107 sg_init_one(&rctx->buf_sg, rctx->buf, rctx->buf_count);
108 sg = ccp_crypto_sg_table_add(&rctx->data_sg, &rctx->buf_sg);
109 sg = ccp_crypto_sg_table_add(&rctx->data_sg, req->src);
112 sg = rctx->data_sg.sgl;
113 } else if (rctx->buf_count) {
114 sg_init_one(&rctx->buf_sg, rctx->buf, rctx->buf_count);
121 rctx->msg_bits += (rctx->hash_cnt << 3); /* Total in bits */
123 memset(&rctx->cmd, 0, sizeof(rctx->cmd));
124 INIT_LIST_HEAD(&rctx->cmd.entry);
125 rctx->cmd.engine = CCP_ENGINE_SHA;
126 rctx->cmd.u.sha.type = rctx->type;
127 rctx->cmd.u.sha.ctx = &rctx->ctx_sg;
128 rctx->cmd.u.sha.ctx_len = sizeof(rctx->ctx);
129 rctx->cmd.u.sha.src = sg;
130 rctx->cmd.u.sha.src_len = rctx->hash_cnt;
131 rctx->cmd.u.sha.opad = ctx->u.sha.key_len ?
132 &ctx->u.sha.opad_sg : NULL;
133 rctx->cmd.u.sha.opad_len = ctx->u.sha.key_len ?
134 ctx->u.sha.opad_count : 0;
135 rctx->cmd.u.sha.first = rctx->first;
136 rctx->cmd.u.sha.final = rctx->final;
137 rctx->cmd.u.sha.msg_bits = rctx->msg_bits;
141 ret = ccp_crypto_enqueue_request(&req->base, &rctx->cmd);
146 static int ccp_sha_init(struct ahash_request *req)
148 struct crypto_ahash *tfm = crypto_ahash_reqtfm(req);
149 struct ccp_ctx *ctx = crypto_ahash_ctx(tfm);
150 struct ccp_sha_req_ctx *rctx = ahash_request_ctx(req);
151 struct ccp_crypto_ahash_alg *alg =
152 ccp_crypto_ahash_alg(crypto_ahash_tfm(tfm));
153 unsigned int block_size =
154 crypto_tfm_alg_blocksize(crypto_ahash_tfm(tfm));
156 memset(rctx, 0, sizeof(*rctx));
158 rctx->type = alg->type;
161 if (ctx->u.sha.key_len) {
162 /* Buffer the HMAC key for first update */
163 memcpy(rctx->buf, ctx->u.sha.ipad, block_size);
164 rctx->buf_count = block_size;
170 static int ccp_sha_update(struct ahash_request *req)
172 return ccp_do_sha_update(req, req->nbytes, 0);
175 static int ccp_sha_final(struct ahash_request *req)
177 return ccp_do_sha_update(req, 0, 1);
180 static int ccp_sha_finup(struct ahash_request *req)
182 return ccp_do_sha_update(req, req->nbytes, 1);
185 static int ccp_sha_digest(struct ahash_request *req)
189 ret = ccp_sha_init(req);
193 return ccp_sha_finup(req);
196 static int ccp_sha_setkey(struct crypto_ahash *tfm, const u8 *key,
197 unsigned int key_len)
199 struct ccp_ctx *ctx = crypto_tfm_ctx(crypto_ahash_tfm(tfm));
200 struct crypto_shash *shash = ctx->u.sha.hmac_tfm;
202 SHASH_DESC_ON_STACK(sdesc, shash);
204 unsigned int block_size = crypto_shash_blocksize(shash);
205 unsigned int digest_size = crypto_shash_digestsize(shash);
208 /* Set to zero until complete */
209 ctx->u.sha.key_len = 0;
211 /* Clear key area to provide zero padding for keys smaller
212 * than the block size
214 memset(ctx->u.sha.key, 0, sizeof(ctx->u.sha.key));
216 if (key_len > block_size) {
217 /* Must hash the input key */
219 sdesc->flags = crypto_ahash_get_flags(tfm) &
220 CRYPTO_TFM_REQ_MAY_SLEEP;
222 ret = crypto_shash_digest(sdesc, key, key_len,
225 crypto_ahash_set_flags(tfm, CRYPTO_TFM_RES_BAD_KEY_LEN);
229 key_len = digest_size;
231 memcpy(ctx->u.sha.key, key, key_len);
233 for (i = 0; i < block_size; i++) {
234 ctx->u.sha.ipad[i] = ctx->u.sha.key[i] ^ 0x36;
235 ctx->u.sha.opad[i] = ctx->u.sha.key[i] ^ 0x5c;
238 sg_init_one(&ctx->u.sha.opad_sg, ctx->u.sha.opad, block_size);
239 ctx->u.sha.opad_count = block_size;
241 ctx->u.sha.key_len = key_len;
246 static int ccp_sha_cra_init(struct crypto_tfm *tfm)
248 struct ccp_ctx *ctx = crypto_tfm_ctx(tfm);
249 struct crypto_ahash *ahash = __crypto_ahash_cast(tfm);
251 ctx->complete = ccp_sha_complete;
252 ctx->u.sha.key_len = 0;
254 crypto_ahash_set_reqsize(ahash, sizeof(struct ccp_sha_req_ctx));
259 static void ccp_sha_cra_exit(struct crypto_tfm *tfm)
263 static int ccp_hmac_sha_cra_init(struct crypto_tfm *tfm)
265 struct ccp_ctx *ctx = crypto_tfm_ctx(tfm);
266 struct ccp_crypto_ahash_alg *alg = ccp_crypto_ahash_alg(tfm);
267 struct crypto_shash *hmac_tfm;
269 hmac_tfm = crypto_alloc_shash(alg->child_alg, 0, 0);
270 if (IS_ERR(hmac_tfm)) {
271 pr_warn("could not load driver %s need for HMAC support\n",
273 return PTR_ERR(hmac_tfm);
276 ctx->u.sha.hmac_tfm = hmac_tfm;
278 return ccp_sha_cra_init(tfm);
281 static void ccp_hmac_sha_cra_exit(struct crypto_tfm *tfm)
283 struct ccp_ctx *ctx = crypto_tfm_ctx(tfm);
285 if (ctx->u.sha.hmac_tfm)
286 crypto_free_shash(ctx->u.sha.hmac_tfm);
288 ccp_sha_cra_exit(tfm);
293 const char *drv_name;
294 enum ccp_sha_type type;
299 static struct ccp_sha_def sha_algs[] = {
302 .drv_name = "sha1-ccp",
303 .type = CCP_SHA_TYPE_1,
304 .digest_size = SHA1_DIGEST_SIZE,
305 .block_size = SHA1_BLOCK_SIZE,
309 .drv_name = "sha224-ccp",
310 .type = CCP_SHA_TYPE_224,
311 .digest_size = SHA224_DIGEST_SIZE,
312 .block_size = SHA224_BLOCK_SIZE,
316 .drv_name = "sha256-ccp",
317 .type = CCP_SHA_TYPE_256,
318 .digest_size = SHA256_DIGEST_SIZE,
319 .block_size = SHA256_BLOCK_SIZE,
323 static int ccp_register_hmac_alg(struct list_head *head,
324 const struct ccp_sha_def *def,
325 const struct ccp_crypto_ahash_alg *base_alg)
327 struct ccp_crypto_ahash_alg *ccp_alg;
328 struct ahash_alg *alg;
329 struct hash_alg_common *halg;
330 struct crypto_alg *base;
333 ccp_alg = kzalloc(sizeof(*ccp_alg), GFP_KERNEL);
337 /* Copy the base algorithm and only change what's necessary */
338 *ccp_alg = *base_alg;
339 INIT_LIST_HEAD(&ccp_alg->entry);
341 strncpy(ccp_alg->child_alg, def->name, CRYPTO_MAX_ALG_NAME);
344 alg->setkey = ccp_sha_setkey;
349 snprintf(base->cra_name, CRYPTO_MAX_ALG_NAME, "hmac(%s)", def->name);
350 snprintf(base->cra_driver_name, CRYPTO_MAX_ALG_NAME, "hmac-%s",
352 base->cra_init = ccp_hmac_sha_cra_init;
353 base->cra_exit = ccp_hmac_sha_cra_exit;
355 ret = crypto_register_ahash(alg);
357 pr_err("%s ahash algorithm registration error (%d)\n",
358 base->cra_name, ret);
363 list_add(&ccp_alg->entry, head);
368 static int ccp_register_sha_alg(struct list_head *head,
369 const struct ccp_sha_def *def)
371 struct ccp_crypto_ahash_alg *ccp_alg;
372 struct ahash_alg *alg;
373 struct hash_alg_common *halg;
374 struct crypto_alg *base;
377 ccp_alg = kzalloc(sizeof(*ccp_alg), GFP_KERNEL);
381 INIT_LIST_HEAD(&ccp_alg->entry);
383 ccp_alg->type = def->type;
386 alg->init = ccp_sha_init;
387 alg->update = ccp_sha_update;
388 alg->final = ccp_sha_final;
389 alg->finup = ccp_sha_finup;
390 alg->digest = ccp_sha_digest;
393 halg->digestsize = def->digest_size;
396 snprintf(base->cra_name, CRYPTO_MAX_ALG_NAME, "%s", def->name);
397 snprintf(base->cra_driver_name, CRYPTO_MAX_ALG_NAME, "%s",
399 base->cra_flags = CRYPTO_ALG_TYPE_AHASH | CRYPTO_ALG_ASYNC |
400 CRYPTO_ALG_KERN_DRIVER_ONLY |
401 CRYPTO_ALG_NEED_FALLBACK;
402 base->cra_blocksize = def->block_size;
403 base->cra_ctxsize = sizeof(struct ccp_ctx);
404 base->cra_priority = CCP_CRA_PRIORITY;
405 base->cra_type = &crypto_ahash_type;
406 base->cra_init = ccp_sha_cra_init;
407 base->cra_exit = ccp_sha_cra_exit;
408 base->cra_module = THIS_MODULE;
410 ret = crypto_register_ahash(alg);
412 pr_err("%s ahash algorithm registration error (%d)\n",
413 base->cra_name, ret);
418 list_add(&ccp_alg->entry, head);
420 ret = ccp_register_hmac_alg(head, def, ccp_alg);
425 int ccp_register_sha_algs(struct list_head *head)
429 for (i = 0; i < ARRAY_SIZE(sha_algs); i++) {
430 ret = ccp_register_sha_alg(head, &sha_algs[i]);