2 * AMD Cryptographic Coprocessor (CCP) SHA crypto API support
4 * Copyright (C) 2013,2016 Advanced Micro Devices, Inc.
6 * Author: Tom Lendacky <thomas.lendacky@amd.com>
7 * Author: Gary R Hook <gary.hook@amd.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
14 #include <linux/module.h>
15 #include <linux/sched.h>
16 #include <linux/delay.h>
17 #include <linux/scatterlist.h>
18 #include <linux/crypto.h>
19 #include <crypto/algapi.h>
20 #include <crypto/hash.h>
21 #include <crypto/internal/hash.h>
22 #include <crypto/sha.h>
23 #include <crypto/scatterwalk.h>
25 #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
;
41 scatterwalk_map_and_copy(rctx
->buf
, rctx
->src
,
42 offset
, rctx
->hash_rem
, 0);
43 rctx
->buf_count
= rctx
->hash_rem
;
48 /* Update result area if supplied */
50 memcpy(req
->result
, rctx
->ctx
, digest_size
);
53 sg_free_table(&rctx
->data_sg
);
58 static int ccp_do_sha_update(struct ahash_request
*req
, unsigned int nbytes
,
61 struct crypto_ahash
*tfm
= crypto_ahash_reqtfm(req
);
62 struct ccp_ctx
*ctx
= crypto_ahash_ctx(tfm
);
63 struct ccp_sha_req_ctx
*rctx
= ahash_request_ctx(req
);
64 struct scatterlist
*sg
;
65 unsigned int block_size
=
66 crypto_tfm_alg_blocksize(crypto_ahash_tfm(tfm
));
67 unsigned int sg_count
;
72 len
= (u64
)rctx
->buf_count
+ (u64
)nbytes
;
74 if (!final
&& (len
<= block_size
)) {
75 scatterwalk_map_and_copy(rctx
->buf
+ rctx
->buf_count
, req
->src
,
77 rctx
->buf_count
+= nbytes
;
83 rctx
->nbytes
= nbytes
;
86 rctx
->hash_rem
= final
? 0 : len
& (block_size
- 1);
87 rctx
->hash_cnt
= len
- rctx
->hash_rem
;
88 if (!final
&& !rctx
->hash_rem
) {
89 /* CCP can't do zero length final, so keep some data around */
90 rctx
->hash_cnt
-= block_size
;
91 rctx
->hash_rem
= block_size
;
94 /* Initialize the context scatterlist */
95 sg_init_one(&rctx
->ctx_sg
, rctx
->ctx
, sizeof(rctx
->ctx
));
98 if (rctx
->buf_count
&& nbytes
) {
99 /* Build the data scatterlist table - allocate enough entries
100 * for both data pieces (buffer and input data)
102 gfp
= req
->base
.flags
& CRYPTO_TFM_REQ_MAY_SLEEP
?
103 GFP_KERNEL
: GFP_ATOMIC
;
104 sg_count
= sg_nents(req
->src
) + 1;
105 ret
= sg_alloc_table(&rctx
->data_sg
, sg_count
, gfp
);
109 sg_init_one(&rctx
->buf_sg
, rctx
->buf
, rctx
->buf_count
);
110 sg
= ccp_crypto_sg_table_add(&rctx
->data_sg
, &rctx
->buf_sg
);
115 sg
= ccp_crypto_sg_table_add(&rctx
->data_sg
, req
->src
);
122 sg
= rctx
->data_sg
.sgl
;
123 } else if (rctx
->buf_count
) {
124 sg_init_one(&rctx
->buf_sg
, rctx
->buf
, rctx
->buf_count
);
131 rctx
->msg_bits
+= (rctx
->hash_cnt
<< 3); /* Total in bits */
133 memset(&rctx
->cmd
, 0, sizeof(rctx
->cmd
));
134 INIT_LIST_HEAD(&rctx
->cmd
.entry
);
135 rctx
->cmd
.engine
= CCP_ENGINE_SHA
;
136 rctx
->cmd
.u
.sha
.type
= rctx
->type
;
137 rctx
->cmd
.u
.sha
.ctx
= &rctx
->ctx_sg
;
139 switch (rctx
->type
) {
141 rctx
->cmd
.u
.sha
.ctx_len
= SHA1_DIGEST_SIZE
;
143 case CCP_SHA_TYPE_224
:
144 rctx
->cmd
.u
.sha
.ctx_len
= SHA224_DIGEST_SIZE
;
146 case CCP_SHA_TYPE_256
:
147 rctx
->cmd
.u
.sha
.ctx_len
= SHA256_DIGEST_SIZE
;
150 /* Should never get here */
154 rctx
->cmd
.u
.sha
.src
= sg
;
155 rctx
->cmd
.u
.sha
.src_len
= rctx
->hash_cnt
;
156 rctx
->cmd
.u
.sha
.opad
= ctx
->u
.sha
.key_len
?
157 &ctx
->u
.sha
.opad_sg
: NULL
;
158 rctx
->cmd
.u
.sha
.opad_len
= ctx
->u
.sha
.key_len
?
159 ctx
->u
.sha
.opad_count
: 0;
160 rctx
->cmd
.u
.sha
.first
= rctx
->first
;
161 rctx
->cmd
.u
.sha
.final
= rctx
->final
;
162 rctx
->cmd
.u
.sha
.msg_bits
= rctx
->msg_bits
;
166 ret
= ccp_crypto_enqueue_request(&req
->base
, &rctx
->cmd
);
171 sg_free_table(&rctx
->data_sg
);
176 static int ccp_sha_init(struct ahash_request
*req
)
178 struct crypto_ahash
*tfm
= crypto_ahash_reqtfm(req
);
179 struct ccp_ctx
*ctx
= crypto_ahash_ctx(tfm
);
180 struct ccp_sha_req_ctx
*rctx
= ahash_request_ctx(req
);
181 struct ccp_crypto_ahash_alg
*alg
=
182 ccp_crypto_ahash_alg(crypto_ahash_tfm(tfm
));
183 unsigned int block_size
=
184 crypto_tfm_alg_blocksize(crypto_ahash_tfm(tfm
));
186 memset(rctx
, 0, sizeof(*rctx
));
188 rctx
->type
= alg
->type
;
191 if (ctx
->u
.sha
.key_len
) {
192 /* Buffer the HMAC key for first update */
193 memcpy(rctx
->buf
, ctx
->u
.sha
.ipad
, block_size
);
194 rctx
->buf_count
= block_size
;
200 static int ccp_sha_update(struct ahash_request
*req
)
202 return ccp_do_sha_update(req
, req
->nbytes
, 0);
205 static int ccp_sha_final(struct ahash_request
*req
)
207 return ccp_do_sha_update(req
, 0, 1);
210 static int ccp_sha_finup(struct ahash_request
*req
)
212 return ccp_do_sha_update(req
, req
->nbytes
, 1);
215 static int ccp_sha_digest(struct ahash_request
*req
)
219 ret
= ccp_sha_init(req
);
223 return ccp_sha_finup(req
);
226 static int ccp_sha_export(struct ahash_request
*req
, void *out
)
228 struct ccp_sha_req_ctx
*rctx
= ahash_request_ctx(req
);
229 struct ccp_sha_exp_ctx state
;
231 /* Don't let anything leak to 'out' */
232 memset(&state
, 0, sizeof(state
));
234 state
.type
= rctx
->type
;
235 state
.msg_bits
= rctx
->msg_bits
;
236 state
.first
= rctx
->first
;
237 memcpy(state
.ctx
, rctx
->ctx
, sizeof(state
.ctx
));
238 state
.buf_count
= rctx
->buf_count
;
239 memcpy(state
.buf
, rctx
->buf
, sizeof(state
.buf
));
241 /* 'out' may not be aligned so memcpy from local variable */
242 memcpy(out
, &state
, sizeof(state
));
247 static int ccp_sha_import(struct ahash_request
*req
, const void *in
)
249 struct ccp_sha_req_ctx
*rctx
= ahash_request_ctx(req
);
250 struct ccp_sha_exp_ctx state
;
252 /* 'in' may not be aligned so memcpy to local variable */
253 memcpy(&state
, in
, sizeof(state
));
255 memset(rctx
, 0, sizeof(*rctx
));
256 rctx
->type
= state
.type
;
257 rctx
->msg_bits
= state
.msg_bits
;
258 rctx
->first
= state
.first
;
259 memcpy(rctx
->ctx
, state
.ctx
, sizeof(rctx
->ctx
));
260 rctx
->buf_count
= state
.buf_count
;
261 memcpy(rctx
->buf
, state
.buf
, sizeof(rctx
->buf
));
266 static int ccp_sha_setkey(struct crypto_ahash
*tfm
, const u8
*key
,
267 unsigned int key_len
)
269 struct ccp_ctx
*ctx
= crypto_tfm_ctx(crypto_ahash_tfm(tfm
));
270 struct crypto_shash
*shash
= ctx
->u
.sha
.hmac_tfm
;
272 SHASH_DESC_ON_STACK(sdesc
, shash
);
274 unsigned int block_size
= crypto_shash_blocksize(shash
);
275 unsigned int digest_size
= crypto_shash_digestsize(shash
);
278 /* Set to zero until complete */
279 ctx
->u
.sha
.key_len
= 0;
281 /* Clear key area to provide zero padding for keys smaller
282 * than the block size
284 memset(ctx
->u
.sha
.key
, 0, sizeof(ctx
->u
.sha
.key
));
286 if (key_len
> block_size
) {
287 /* Must hash the input key */
289 sdesc
->flags
= crypto_ahash_get_flags(tfm
) &
290 CRYPTO_TFM_REQ_MAY_SLEEP
;
292 ret
= crypto_shash_digest(sdesc
, key
, key_len
,
295 crypto_ahash_set_flags(tfm
, CRYPTO_TFM_RES_BAD_KEY_LEN
);
299 key_len
= digest_size
;
301 memcpy(ctx
->u
.sha
.key
, key
, key_len
);
304 for (i
= 0; i
< block_size
; i
++) {
305 ctx
->u
.sha
.ipad
[i
] = ctx
->u
.sha
.key
[i
] ^ 0x36;
306 ctx
->u
.sha
.opad
[i
] = ctx
->u
.sha
.key
[i
] ^ 0x5c;
309 sg_init_one(&ctx
->u
.sha
.opad_sg
, ctx
->u
.sha
.opad
, block_size
);
310 ctx
->u
.sha
.opad_count
= block_size
;
312 ctx
->u
.sha
.key_len
= key_len
;
317 static int ccp_sha_cra_init(struct crypto_tfm
*tfm
)
319 struct ccp_ctx
*ctx
= crypto_tfm_ctx(tfm
);
320 struct crypto_ahash
*ahash
= __crypto_ahash_cast(tfm
);
322 ctx
->complete
= ccp_sha_complete
;
323 ctx
->u
.sha
.key_len
= 0;
325 crypto_ahash_set_reqsize(ahash
, sizeof(struct ccp_sha_req_ctx
));
330 static void ccp_sha_cra_exit(struct crypto_tfm
*tfm
)
334 static int ccp_hmac_sha_cra_init(struct crypto_tfm
*tfm
)
336 struct ccp_ctx
*ctx
= crypto_tfm_ctx(tfm
);
337 struct ccp_crypto_ahash_alg
*alg
= ccp_crypto_ahash_alg(tfm
);
338 struct crypto_shash
*hmac_tfm
;
340 hmac_tfm
= crypto_alloc_shash(alg
->child_alg
, 0, 0);
341 if (IS_ERR(hmac_tfm
)) {
342 pr_warn("could not load driver %s need for HMAC support\n",
344 return PTR_ERR(hmac_tfm
);
347 ctx
->u
.sha
.hmac_tfm
= hmac_tfm
;
349 return ccp_sha_cra_init(tfm
);
352 static void ccp_hmac_sha_cra_exit(struct crypto_tfm
*tfm
)
354 struct ccp_ctx
*ctx
= crypto_tfm_ctx(tfm
);
356 if (ctx
->u
.sha
.hmac_tfm
)
357 crypto_free_shash(ctx
->u
.sha
.hmac_tfm
);
359 ccp_sha_cra_exit(tfm
);
363 unsigned int version
;
365 const char *drv_name
;
366 enum ccp_sha_type type
;
371 static struct ccp_sha_def sha_algs
[] = {
373 .version
= CCP_VERSION(3, 0),
375 .drv_name
= "sha1-ccp",
376 .type
= CCP_SHA_TYPE_1
,
377 .digest_size
= SHA1_DIGEST_SIZE
,
378 .block_size
= SHA1_BLOCK_SIZE
,
381 .version
= CCP_VERSION(3, 0),
383 .drv_name
= "sha224-ccp",
384 .type
= CCP_SHA_TYPE_224
,
385 .digest_size
= SHA224_DIGEST_SIZE
,
386 .block_size
= SHA224_BLOCK_SIZE
,
389 .version
= CCP_VERSION(3, 0),
391 .drv_name
= "sha256-ccp",
392 .type
= CCP_SHA_TYPE_256
,
393 .digest_size
= SHA256_DIGEST_SIZE
,
394 .block_size
= SHA256_BLOCK_SIZE
,
398 static int ccp_register_hmac_alg(struct list_head
*head
,
399 const struct ccp_sha_def
*def
,
400 const struct ccp_crypto_ahash_alg
*base_alg
)
402 struct ccp_crypto_ahash_alg
*ccp_alg
;
403 struct ahash_alg
*alg
;
404 struct hash_alg_common
*halg
;
405 struct crypto_alg
*base
;
408 ccp_alg
= kzalloc(sizeof(*ccp_alg
), GFP_KERNEL
);
412 /* Copy the base algorithm and only change what's necessary */
413 *ccp_alg
= *base_alg
;
414 INIT_LIST_HEAD(&ccp_alg
->entry
);
416 strncpy(ccp_alg
->child_alg
, def
->name
, CRYPTO_MAX_ALG_NAME
);
419 alg
->setkey
= ccp_sha_setkey
;
424 snprintf(base
->cra_name
, CRYPTO_MAX_ALG_NAME
, "hmac(%s)", def
->name
);
425 snprintf(base
->cra_driver_name
, CRYPTO_MAX_ALG_NAME
, "hmac-%s",
427 base
->cra_init
= ccp_hmac_sha_cra_init
;
428 base
->cra_exit
= ccp_hmac_sha_cra_exit
;
430 ret
= crypto_register_ahash(alg
);
432 pr_err("%s ahash algorithm registration error (%d)\n",
433 base
->cra_name
, ret
);
438 list_add(&ccp_alg
->entry
, head
);
443 static int ccp_register_sha_alg(struct list_head
*head
,
444 const struct ccp_sha_def
*def
)
446 struct ccp_crypto_ahash_alg
*ccp_alg
;
447 struct ahash_alg
*alg
;
448 struct hash_alg_common
*halg
;
449 struct crypto_alg
*base
;
452 ccp_alg
= kzalloc(sizeof(*ccp_alg
), GFP_KERNEL
);
456 INIT_LIST_HEAD(&ccp_alg
->entry
);
458 ccp_alg
->type
= def
->type
;
461 alg
->init
= ccp_sha_init
;
462 alg
->update
= ccp_sha_update
;
463 alg
->final
= ccp_sha_final
;
464 alg
->finup
= ccp_sha_finup
;
465 alg
->digest
= ccp_sha_digest
;
466 alg
->export
= ccp_sha_export
;
467 alg
->import
= ccp_sha_import
;
470 halg
->digestsize
= def
->digest_size
;
471 halg
->statesize
= sizeof(struct ccp_sha_exp_ctx
);
474 snprintf(base
->cra_name
, CRYPTO_MAX_ALG_NAME
, "%s", def
->name
);
475 snprintf(base
->cra_driver_name
, CRYPTO_MAX_ALG_NAME
, "%s",
477 base
->cra_flags
= CRYPTO_ALG_TYPE_AHASH
| CRYPTO_ALG_ASYNC
|
478 CRYPTO_ALG_KERN_DRIVER_ONLY
|
479 CRYPTO_ALG_NEED_FALLBACK
;
480 base
->cra_blocksize
= def
->block_size
;
481 base
->cra_ctxsize
= sizeof(struct ccp_ctx
);
482 base
->cra_priority
= CCP_CRA_PRIORITY
;
483 base
->cra_type
= &crypto_ahash_type
;
484 base
->cra_init
= ccp_sha_cra_init
;
485 base
->cra_exit
= ccp_sha_cra_exit
;
486 base
->cra_module
= THIS_MODULE
;
488 ret
= crypto_register_ahash(alg
);
490 pr_err("%s ahash algorithm registration error (%d)\n",
491 base
->cra_name
, ret
);
496 list_add(&ccp_alg
->entry
, head
);
498 ret
= ccp_register_hmac_alg(head
, def
, ccp_alg
);
503 int ccp_register_sha_algs(struct list_head
*head
)
506 unsigned int ccpversion
= ccp_version();
508 for (i
= 0; i
< ARRAY_SIZE(sha_algs
); i
++) {
509 if (sha_algs
[i
].version
> ccpversion
)
511 ret
= ccp_register_sha_alg(head
, &sha_algs
[i
]);