1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright IBM Corp. 2017
6 * Author(s): Harald Freudenberger
9 #define KMSG_COMPONENT "pkey"
10 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
13 #include <linux/init.h>
14 #include <linux/miscdevice.h>
15 #include <linux/module.h>
16 #include <linux/slab.h>
17 #include <linux/kallsyms.h>
18 #include <linux/debugfs.h>
19 #include <asm/zcrypt.h>
20 #include <asm/cpacf.h>
23 #include "zcrypt_api.h"
25 MODULE_LICENSE("GPL");
26 MODULE_AUTHOR("IBM Corporation");
27 MODULE_DESCRIPTION("s390 protected key interface");
29 /* Size of parameter block used for all cca requests/replies */
32 /* Size of vardata block used for some of the cca requests/replies */
33 #define VARDATASIZE 4096
36 * debug feature data and functions
39 static debug_info_t *debug_info;
41 #define DEBUG_DBG(...) debug_sprintf_event(debug_info, 6, ##__VA_ARGS__)
42 #define DEBUG_INFO(...) debug_sprintf_event(debug_info, 5, ##__VA_ARGS__)
43 #define DEBUG_WARN(...) debug_sprintf_event(debug_info, 4, ##__VA_ARGS__)
44 #define DEBUG_ERR(...) debug_sprintf_event(debug_info, 3, ##__VA_ARGS__)
46 static void __init pkey_debug_init(void)
48 debug_info = debug_register("pkey", 1, 1, 4 * sizeof(long));
49 debug_register_view(debug_info, &debug_sprintf_view);
50 debug_set_level(debug_info, 3);
53 static void __exit pkey_debug_exit(void)
55 debug_unregister(debug_info);
58 /* inside view of a secure key token (only type 0x01 version 0x04) */
59 struct secaeskeytoken {
60 u8 type; /* 0x01 for internal key token */
62 u8 version; /* should be 0x04 */
64 u8 flag; /* key flags */
66 u64 mkvp; /* master key verification pattern */
67 u8 key[32]; /* key value (encrypted) */
68 u8 cv[8]; /* control vector */
69 u16 bitsize; /* key bit size */
70 u16 keysize; /* key byte size */
71 u8 tvv[4]; /* token validation value */
75 * Simple check if the token is a valid CCA secure AES key
76 * token. If keybitsize is given, the bitsize of the key is
77 * also checked. Returns 0 on success or errno value on failure.
79 static int check_secaeskeytoken(const u8 *token, int keybitsize)
81 struct secaeskeytoken *t = (struct secaeskeytoken *) token;
83 if (t->type != 0x01) {
85 "check_secaeskeytoken secure token check failed, type mismatch 0x%02x != 0x01\n",
89 if (t->version != 0x04) {
91 "check_secaeskeytoken secure token check failed, version mismatch 0x%02x != 0x04\n",
95 if (keybitsize > 0 && t->bitsize != keybitsize) {
97 "check_secaeskeytoken secure token check failed, bitsize mismatch %d != %d\n",
98 (int) t->bitsize, keybitsize);
106 * Allocate consecutive memory for request CPRB, request param
107 * block, reply CPRB and reply param block and fill in values
108 * for the common fields. Returns 0 on success or errno value
111 static int alloc_and_prep_cprbmem(size_t paramblen,
113 struct CPRBX **preqCPRB,
114 struct CPRBX **prepCPRB)
117 size_t cprbplusparamblen = sizeof(struct CPRBX) + paramblen;
118 struct CPRBX *preqcblk, *prepcblk;
121 * allocate consecutive memory for request CPRB, request param
122 * block, reply CPRB and reply param block
124 cprbmem = kzalloc(2 * cprbplusparamblen, GFP_KERNEL);
128 preqcblk = (struct CPRBX *) cprbmem;
129 prepcblk = (struct CPRBX *) (cprbmem + cprbplusparamblen);
131 /* fill request cprb struct */
132 preqcblk->cprb_len = sizeof(struct CPRBX);
133 preqcblk->cprb_ver_id = 0x02;
134 memcpy(preqcblk->func_id, "T2", 2);
135 preqcblk->rpl_msgbl = cprbplusparamblen;
137 preqcblk->req_parmb =
138 ((u8 *) preqcblk) + sizeof(struct CPRBX);
139 preqcblk->rpl_parmb =
140 ((u8 *) prepcblk) + sizeof(struct CPRBX);
144 *preqCPRB = preqcblk;
145 *prepCPRB = prepcblk;
151 * Free the cprb memory allocated with the function above.
152 * If the scrub value is not zero, the memory is filled
153 * with zeros before freeing (useful if there was some
154 * clear key material in there).
156 static void free_cprbmem(void *mem, size_t paramblen, int scrub)
159 memzero_explicit(mem, 2 * (sizeof(struct CPRBX) + paramblen));
164 * Helper function to prepare the xcrb struct
166 static inline void prep_xcrb(struct ica_xcRB *pxcrb,
168 struct CPRBX *preqcblk,
169 struct CPRBX *prepcblk)
171 memset(pxcrb, 0, sizeof(*pxcrb));
172 pxcrb->agent_ID = 0x4341; /* 'CA' */
173 pxcrb->user_defined = (cardnr == 0xFFFF ? AUTOSELECT : cardnr);
174 pxcrb->request_control_blk_length =
175 preqcblk->cprb_len + preqcblk->req_parml;
176 pxcrb->request_control_blk_addr = (void __user *) preqcblk;
177 pxcrb->reply_control_blk_length = preqcblk->rpl_msgbl;
178 pxcrb->reply_control_blk_addr = (void __user *) prepcblk;
182 * Helper function which calls zcrypt_send_cprb with
183 * memory management segment adjusted to kernel space
184 * so that the copy_from_user called within this
185 * function do in fact copy from kernel space.
187 static inline int _zcrypt_send_cprb(struct ica_xcRB *xcrb)
190 mm_segment_t old_fs = get_fs();
193 rc = zcrypt_send_cprb(xcrb);
200 * Generate (random) AES secure key.
202 int pkey_genseckey(u16 cardnr, u16 domain,
203 u32 keytype, struct pkey_seckey *seckey)
208 struct CPRBX *preqcblk, *prepcblk;
209 struct ica_xcRB xcrb;
225 u8 data[SECKEYBLOBSIZE];
239 /* ... some more data ... */
244 /* get already prepared memory for 2 cprbs with param block each */
245 rc = alloc_and_prep_cprbmem(PARMBSIZE, &mem, &preqcblk, &prepcblk);
249 /* fill request cprb struct */
250 preqcblk->domain = domain;
252 /* fill request cprb param block with KG request */
253 preqparm = (struct kgreqparm *) preqcblk->req_parmb;
254 memcpy(preqparm->subfunc_code, "KG", 2);
255 preqparm->rule_array_len = sizeof(preqparm->rule_array_len);
256 preqparm->lv1.len = sizeof(struct lv1);
257 memcpy(preqparm->lv1.key_form, "OP ", 8);
259 case PKEY_KEYTYPE_AES_128:
261 memcpy(preqparm->lv1.key_length, "KEYLN16 ", 8);
263 case PKEY_KEYTYPE_AES_192:
265 memcpy(preqparm->lv1.key_length, "KEYLN24 ", 8);
267 case PKEY_KEYTYPE_AES_256:
269 memcpy(preqparm->lv1.key_length, "KEYLN32 ", 8);
273 "pkey_genseckey unknown/unsupported keytype %d\n",
278 memcpy(preqparm->lv1.key_type1, "AESDATA ", 8);
279 preqparm->lv2.len = sizeof(struct lv2);
280 for (i = 0; i < 6; i++) {
281 preqparm->lv2.keyid[i].len = sizeof(struct keyid);
282 preqparm->lv2.keyid[i].attr = (i == 2 ? 0x30 : 0x10);
284 preqcblk->req_parml = sizeof(struct kgreqparm);
286 /* fill xcrb struct */
287 prep_xcrb(&xcrb, cardnr, preqcblk, prepcblk);
289 /* forward xcrb with request CPRB and reply CPRB to zcrypt dd */
290 rc = _zcrypt_send_cprb(&xcrb);
293 "pkey_genseckey zcrypt_send_cprb (cardnr=%d domain=%d) failed with errno %d\n",
294 (int) cardnr, (int) domain, rc);
298 /* check response returncode and reasoncode */
299 if (prepcblk->ccp_rtcode != 0) {
301 "pkey_genseckey secure key generate failure, card response %d/%d\n",
302 (int) prepcblk->ccp_rtcode,
303 (int) prepcblk->ccp_rscode);
308 /* process response cprb param block */
309 prepcblk->rpl_parmb = ((u8 *) prepcblk) + sizeof(struct CPRBX);
310 prepparm = (struct kgrepparm *) prepcblk->rpl_parmb;
312 /* check length of the returned secure key token */
313 seckeysize = prepparm->lv3.keyblock.toklen
314 - sizeof(prepparm->lv3.keyblock.toklen)
315 - sizeof(prepparm->lv3.keyblock.tokattr);
316 if (seckeysize != SECKEYBLOBSIZE) {
318 "pkey_genseckey secure token size mismatch %d != %d bytes\n",
319 seckeysize, SECKEYBLOBSIZE);
324 /* check secure key token */
325 rc = check_secaeskeytoken(prepparm->lv3.keyblock.tok, 8*keysize);
331 /* copy the generated secure key token */
332 memcpy(seckey->seckey, prepparm->lv3.keyblock.tok, SECKEYBLOBSIZE);
335 free_cprbmem(mem, PARMBSIZE, 0);
338 EXPORT_SYMBOL(pkey_genseckey);
341 * Generate an AES secure key with given key value.
343 int pkey_clr2seckey(u16 cardnr, u16 domain, u32 keytype,
344 const struct pkey_clrkey *clrkey,
345 struct pkey_seckey *seckey)
347 int rc, keysize, seckeysize;
349 struct CPRBX *preqcblk, *prepcblk;
350 struct ica_xcRB xcrb;
364 u8 data[SECKEYBLOBSIZE];
379 /* ... some more data ... */
384 /* get already prepared memory for 2 cprbs with param block each */
385 rc = alloc_and_prep_cprbmem(PARMBSIZE, &mem, &preqcblk, &prepcblk);
389 /* fill request cprb struct */
390 preqcblk->domain = domain;
392 /* fill request cprb param block with CM request */
393 preqparm = (struct cmreqparm *) preqcblk->req_parmb;
394 memcpy(preqparm->subfunc_code, "CM", 2);
395 memcpy(preqparm->rule_array, "AES ", 8);
396 preqparm->rule_array_len =
397 sizeof(preqparm->rule_array_len) + sizeof(preqparm->rule_array);
399 case PKEY_KEYTYPE_AES_128:
402 case PKEY_KEYTYPE_AES_192:
405 case PKEY_KEYTYPE_AES_256:
410 "pkey_clr2seckey unknown/unsupported keytype %d\n",
415 preqparm->lv1.len = sizeof(struct lv1) + keysize;
416 memcpy(preqparm->lv1.clrkey, clrkey->clrkey, keysize);
417 plv2 = (struct lv2 *) (((u8 *) &preqparm->lv2) + keysize);
418 plv2->len = sizeof(struct lv2);
419 plv2->keyid.len = sizeof(struct keyid);
420 plv2->keyid.attr = 0x30;
421 preqcblk->req_parml = sizeof(struct cmreqparm) + keysize;
423 /* fill xcrb struct */
424 prep_xcrb(&xcrb, cardnr, preqcblk, prepcblk);
426 /* forward xcrb with request CPRB and reply CPRB to zcrypt dd */
427 rc = _zcrypt_send_cprb(&xcrb);
430 "pkey_clr2seckey zcrypt_send_cprb (cardnr=%d domain=%d) failed with errno %d\n",
431 (int) cardnr, (int) domain, rc);
435 /* check response returncode and reasoncode */
436 if (prepcblk->ccp_rtcode != 0) {
438 "pkey_clr2seckey clear key import failure, card response %d/%d\n",
439 (int) prepcblk->ccp_rtcode,
440 (int) prepcblk->ccp_rscode);
445 /* process response cprb param block */
446 prepcblk->rpl_parmb = ((u8 *) prepcblk) + sizeof(struct CPRBX);
447 prepparm = (struct cmrepparm *) prepcblk->rpl_parmb;
449 /* check length of the returned secure key token */
450 seckeysize = prepparm->lv3.keyblock.toklen
451 - sizeof(prepparm->lv3.keyblock.toklen)
452 - sizeof(prepparm->lv3.keyblock.tokattr);
453 if (seckeysize != SECKEYBLOBSIZE) {
455 "pkey_clr2seckey secure token size mismatch %d != %d bytes\n",
456 seckeysize, SECKEYBLOBSIZE);
461 /* check secure key token */
462 rc = check_secaeskeytoken(prepparm->lv3.keyblock.tok, 8*keysize);
468 /* copy the generated secure key token */
469 memcpy(seckey->seckey, prepparm->lv3.keyblock.tok, SECKEYBLOBSIZE);
472 free_cprbmem(mem, PARMBSIZE, 1);
475 EXPORT_SYMBOL(pkey_clr2seckey);
478 * Derive a proteced key from the secure key blob.
480 int pkey_sec2protkey(u16 cardnr, u16 domain,
481 const struct pkey_seckey *seckey,
482 struct pkey_protkey *protkey)
486 struct CPRBX *preqcblk, *prepcblk;
487 struct ica_xcRB xcrb;
500 u8 token[0]; /* cca secure key token */
510 struct cpacfkeyblock {
511 u8 version; /* version of this struct */
517 u8 key[64]; /* the key (keylen bytes) */
522 u8 vp[32]; /* verification pattern */
527 /* get already prepared memory for 2 cprbs with param block each */
528 rc = alloc_and_prep_cprbmem(PARMBSIZE, &mem, &preqcblk, &prepcblk);
532 /* fill request cprb struct */
533 preqcblk->domain = domain;
535 /* fill request cprb param block with USK request */
536 preqparm = (struct uskreqparm *) preqcblk->req_parmb;
537 memcpy(preqparm->subfunc_code, "US", 2);
538 preqparm->rule_array_len = sizeof(preqparm->rule_array_len);
539 preqparm->lv1.len = sizeof(struct lv1);
540 preqparm->lv1.attr_len = sizeof(struct lv1) - sizeof(preqparm->lv1.len);
541 preqparm->lv1.attr_flags = 0x0001;
542 preqparm->lv2.len = sizeof(struct lv2) + SECKEYBLOBSIZE;
543 preqparm->lv2.attr_len = sizeof(struct lv2)
544 - sizeof(preqparm->lv2.len) + SECKEYBLOBSIZE;
545 preqparm->lv2.attr_flags = 0x0000;
546 memcpy(preqparm->lv2.token, seckey->seckey, SECKEYBLOBSIZE);
547 preqcblk->req_parml = sizeof(struct uskreqparm) + SECKEYBLOBSIZE;
549 /* fill xcrb struct */
550 prep_xcrb(&xcrb, cardnr, preqcblk, prepcblk);
552 /* forward xcrb with request CPRB and reply CPRB to zcrypt dd */
553 rc = _zcrypt_send_cprb(&xcrb);
556 "pkey_sec2protkey zcrypt_send_cprb (cardnr=%d domain=%d) failed with errno %d\n",
557 (int) cardnr, (int) domain, rc);
561 /* check response returncode and reasoncode */
562 if (prepcblk->ccp_rtcode != 0) {
564 "pkey_sec2protkey unwrap secure key failure, card response %d/%d\n",
565 (int) prepcblk->ccp_rtcode,
566 (int) prepcblk->ccp_rscode);
570 if (prepcblk->ccp_rscode != 0) {
572 "pkey_sec2protkey unwrap secure key warning, card response %d/%d\n",
573 (int) prepcblk->ccp_rtcode,
574 (int) prepcblk->ccp_rscode);
577 /* process response cprb param block */
578 prepcblk->rpl_parmb = ((u8 *) prepcblk) + sizeof(struct CPRBX);
579 prepparm = (struct uskrepparm *) prepcblk->rpl_parmb;
581 /* check the returned keyblock */
582 if (prepparm->lv3.keyblock.version != 0x01) {
584 "pkey_sec2protkey reply param keyblock version mismatch 0x%02x != 0x01\n",
585 (int) prepparm->lv3.keyblock.version);
590 /* copy the tanslated protected key */
591 switch (prepparm->lv3.keyblock.keylen) {
593 protkey->type = PKEY_KEYTYPE_AES_128;
596 protkey->type = PKEY_KEYTYPE_AES_192;
599 protkey->type = PKEY_KEYTYPE_AES_256;
602 DEBUG_ERR("pkey_sec2protkey unknown/unsupported keytype %d\n",
603 prepparm->lv3.keyblock.keylen);
607 protkey->len = prepparm->lv3.keyblock.keylen;
608 memcpy(protkey->protkey, prepparm->lv3.keyblock.key, protkey->len);
611 free_cprbmem(mem, PARMBSIZE, 0);
614 EXPORT_SYMBOL(pkey_sec2protkey);
617 * Create a protected key from a clear key value.
619 int pkey_clr2protkey(u32 keytype,
620 const struct pkey_clrkey *clrkey,
621 struct pkey_protkey *protkey)
628 case PKEY_KEYTYPE_AES_128:
630 fc = CPACF_PCKMO_ENC_AES_128_KEY;
632 case PKEY_KEYTYPE_AES_192:
634 fc = CPACF_PCKMO_ENC_AES_192_KEY;
636 case PKEY_KEYTYPE_AES_256:
638 fc = CPACF_PCKMO_ENC_AES_256_KEY;
641 DEBUG_ERR("pkey_clr2protkey unknown/unsupported keytype %d\n",
646 /* prepare param block */
647 memset(paramblock, 0, sizeof(paramblock));
648 memcpy(paramblock, clrkey->clrkey, keysize);
650 /* call the pckmo instruction */
651 cpacf_pckmo(fc, paramblock);
653 /* copy created protected key */
654 protkey->type = keytype;
655 protkey->len = keysize + 32;
656 memcpy(protkey->protkey, paramblock, keysize + 32);
660 EXPORT_SYMBOL(pkey_clr2protkey);
663 * query cryptographic facility from adapter
665 static int query_crypto_facility(u16 cardnr, u16 domain,
667 u8 *rarray, size_t *rarraylen,
668 u8 *varray, size_t *varraylen)
673 struct CPRBX *preqcblk, *prepcblk;
674 struct ica_xcRB xcrb;
681 u8 data[VARDATASIZE];
685 size_t parmbsize = sizeof(struct fqreqparm);
691 /* get already prepared memory for 2 cprbs with param block each */
692 rc = alloc_and_prep_cprbmem(parmbsize, &mem, &preqcblk, &prepcblk);
696 /* fill request cprb struct */
697 preqcblk->domain = domain;
699 /* fill request cprb param block with FQ request */
700 preqparm = (struct fqreqparm *) preqcblk->req_parmb;
701 memcpy(preqparm->subfunc_code, "FQ", 2);
702 strncpy(preqparm->rule_array, keyword, sizeof(preqparm->rule_array));
703 preqparm->rule_array_len =
704 sizeof(preqparm->rule_array_len) + sizeof(preqparm->rule_array);
705 preqparm->lv1.len = sizeof(preqparm->lv1);
706 preqparm->dummylen = sizeof(preqparm->dummylen);
707 preqcblk->req_parml = parmbsize;
709 /* fill xcrb struct */
710 prep_xcrb(&xcrb, cardnr, preqcblk, prepcblk);
712 /* forward xcrb with request CPRB and reply CPRB to zcrypt dd */
713 rc = _zcrypt_send_cprb(&xcrb);
716 "query_crypto_facility zcrypt_send_cprb (cardnr=%d domain=%d) failed with errno %d\n",
717 (int) cardnr, (int) domain, rc);
721 /* check response returncode and reasoncode */
722 if (prepcblk->ccp_rtcode != 0) {
724 "query_crypto_facility unwrap secure key failure, card response %d/%d\n",
725 (int) prepcblk->ccp_rtcode,
726 (int) prepcblk->ccp_rscode);
731 /* process response cprb param block */
732 prepcblk->rpl_parmb = ((u8 *) prepcblk) + sizeof(struct CPRBX);
733 prepparm = (struct fqrepparm *) prepcblk->rpl_parmb;
734 ptr = prepparm->lvdata;
736 /* check and possibly copy reply rule array */
737 len = *((u16 *) ptr);
738 if (len > sizeof(u16)) {
741 if (rarray && rarraylen && *rarraylen > 0) {
742 *rarraylen = (len > *rarraylen ? *rarraylen : len);
743 memcpy(rarray, ptr, *rarraylen);
747 /* check and possible copy reply var array */
748 len = *((u16 *) ptr);
749 if (len > sizeof(u16)) {
752 if (varray && varraylen && *varraylen > 0) {
753 *varraylen = (len > *varraylen ? *varraylen : len);
754 memcpy(varray, ptr, *varraylen);
760 free_cprbmem(mem, parmbsize, 0);
765 * Fetch the current and old mkvp values via
766 * query_crypto_facility from adapter.
768 static int fetch_mkvp(u16 cardnr, u16 domain, u64 mkvp[2])
772 u8 *rarray, *varray, *pg;
774 pg = (u8 *) __get_free_page(GFP_KERNEL);
778 varray = pg + PAGE_SIZE/2;
779 rlen = vlen = PAGE_SIZE/2;
781 rc = query_crypto_facility(cardnr, domain, "STATICSA",
782 rarray, &rlen, varray, &vlen);
783 if (rc == 0 && rlen > 8*8 && vlen > 184+8) {
784 if (rarray[8*8] == '2') {
785 /* current master key state is valid */
786 mkvp[0] = *((u64 *)(varray + 184));
787 mkvp[1] = *((u64 *)(varray + 172));
792 free_page((unsigned long) pg);
794 return found ? 0 : -ENOENT;
797 /* struct to hold cached mkvp info for each card/domain */
799 struct list_head list;
805 /* a list with mkvp_info entries */
806 static LIST_HEAD(mkvp_list);
807 static DEFINE_SPINLOCK(mkvp_list_lock);
809 static int mkvp_cache_fetch(u16 cardnr, u16 domain, u64 mkvp[2])
812 struct mkvp_info *ptr;
814 spin_lock_bh(&mkvp_list_lock);
815 list_for_each_entry(ptr, &mkvp_list, list) {
816 if (ptr->cardnr == cardnr &&
817 ptr->domain == domain) {
818 memcpy(mkvp, ptr->mkvp, 2 * sizeof(u64));
823 spin_unlock_bh(&mkvp_list_lock);
828 static void mkvp_cache_update(u16 cardnr, u16 domain, u64 mkvp[2])
831 struct mkvp_info *ptr;
833 spin_lock_bh(&mkvp_list_lock);
834 list_for_each_entry(ptr, &mkvp_list, list) {
835 if (ptr->cardnr == cardnr &&
836 ptr->domain == domain) {
837 memcpy(ptr->mkvp, mkvp, 2 * sizeof(u64));
843 ptr = kmalloc(sizeof(*ptr), GFP_ATOMIC);
845 spin_unlock_bh(&mkvp_list_lock);
848 ptr->cardnr = cardnr;
849 ptr->domain = domain;
850 memcpy(ptr->mkvp, mkvp, 2 * sizeof(u64));
851 list_add(&ptr->list, &mkvp_list);
853 spin_unlock_bh(&mkvp_list_lock);
856 static void mkvp_cache_scrub(u16 cardnr, u16 domain)
858 struct mkvp_info *ptr;
860 spin_lock_bh(&mkvp_list_lock);
861 list_for_each_entry(ptr, &mkvp_list, list) {
862 if (ptr->cardnr == cardnr &&
863 ptr->domain == domain) {
864 list_del(&ptr->list);
869 spin_unlock_bh(&mkvp_list_lock);
872 static void __exit mkvp_cache_free(void)
874 struct mkvp_info *ptr, *pnext;
876 spin_lock_bh(&mkvp_list_lock);
877 list_for_each_entry_safe(ptr, pnext, &mkvp_list, list) {
878 list_del(&ptr->list);
881 spin_unlock_bh(&mkvp_list_lock);
885 * Search for a matching crypto card based on the Master Key
886 * Verification Pattern provided inside a secure key.
888 int pkey_findcard(const struct pkey_seckey *seckey,
889 u16 *pcardnr, u16 *pdomain, int verify)
891 struct secaeskeytoken *t = (struct secaeskeytoken *) seckey;
892 struct zcrypt_device_matrix *device_matrix;
897 /* mkvp must not be zero */
901 /* fetch status of all crypto cards */
902 device_matrix = kmalloc(sizeof(struct zcrypt_device_matrix),
906 zcrypt_device_status_mask(device_matrix);
908 /* walk through all crypto cards */
909 for (i = 0; i < MAX_ZDEV_ENTRIES; i++) {
910 card = AP_QID_CARD(device_matrix->device[i].qid);
911 dom = AP_QID_QUEUE(device_matrix->device[i].qid);
912 if (device_matrix->device[i].online &&
913 device_matrix->device[i].functions & 0x04) {
914 /* an enabled CCA Coprocessor card */
915 /* try cached mkvp */
916 if (mkvp_cache_fetch(card, dom, mkvp) == 0 &&
917 t->mkvp == mkvp[0]) {
920 /* verify: fetch mkvp from adapter */
921 if (fetch_mkvp(card, dom, mkvp) == 0) {
922 mkvp_cache_update(card, dom, mkvp);
923 if (t->mkvp == mkvp[0])
928 /* Card is offline and/or not a CCA card. */
929 /* del mkvp entry from cache if it exists */
930 mkvp_cache_scrub(card, dom);
933 if (i >= MAX_ZDEV_ENTRIES) {
934 /* nothing found, so this time without cache */
935 for (i = 0; i < MAX_ZDEV_ENTRIES; i++) {
936 if (!(device_matrix->device[i].online &&
937 device_matrix->device[i].functions & 0x04))
939 card = AP_QID_CARD(device_matrix->device[i].qid);
940 dom = AP_QID_QUEUE(device_matrix->device[i].qid);
941 /* fresh fetch mkvp from adapter */
942 if (fetch_mkvp(card, dom, mkvp) == 0) {
943 mkvp_cache_update(card, dom, mkvp);
944 if (t->mkvp == mkvp[0])
946 if (t->mkvp == mkvp[1] && oi < 0)
950 if (i >= MAX_ZDEV_ENTRIES && oi >= 0) {
951 /* old mkvp matched, use this card then */
952 card = AP_QID_CARD(device_matrix->device[oi].qid);
953 dom = AP_QID_QUEUE(device_matrix->device[oi].qid);
956 if (i < MAX_ZDEV_ENTRIES || oi >= 0) {
965 kfree(device_matrix);
968 EXPORT_SYMBOL(pkey_findcard);
971 * Find card and transform secure key into protected key.
973 int pkey_skey2pkey(const struct pkey_seckey *seckey,
974 struct pkey_protkey *protkey)
980 * The pkey_sec2protkey call may fail when a card has been
981 * addressed where the master key was changed after last fetch
982 * of the mkvp into the cache. So first try without verify then
983 * with verify enabled (thus refreshing the mkvp for each card).
985 for (verify = 0; verify < 2; verify++) {
986 rc = pkey_findcard(seckey, &cardnr, &domain, verify);
989 rc = pkey_sec2protkey(cardnr, domain, seckey, protkey);
995 DEBUG_DBG("pkey_skey2pkey failed rc=%d\n", rc);
999 EXPORT_SYMBOL(pkey_skey2pkey);
1002 * Verify key and give back some info about the key.
1004 int pkey_verifykey(const struct pkey_seckey *seckey,
1005 u16 *pcardnr, u16 *pdomain,
1006 u16 *pkeysize, u32 *pattributes)
1008 struct secaeskeytoken *t = (struct secaeskeytoken *) seckey;
1013 /* check the secure key for valid AES secure key */
1014 rc = check_secaeskeytoken((u8 *) seckey, 0);
1018 *pattributes = PKEY_VERIFY_ATTR_AES;
1020 *pkeysize = t->bitsize;
1022 /* try to find a card which can handle this key */
1023 rc = pkey_findcard(seckey, &cardnr, &domain, 1);
1027 /* check mkvp for old mkvp match */
1028 rc = mkvp_cache_fetch(cardnr, domain, mkvp);
1031 if (t->mkvp == mkvp[1]) {
1032 DEBUG_DBG("pkey_verifykey secure key has old mkvp\n");
1034 *pattributes |= PKEY_VERIFY_ATTR_OLD_MKVP;
1043 DEBUG_DBG("pkey_verifykey rc=%d\n", rc);
1046 EXPORT_SYMBOL(pkey_verifykey);
1052 static long pkey_unlocked_ioctl(struct file *filp, unsigned int cmd,
1058 case PKEY_GENSECK: {
1059 struct pkey_genseck __user *ugs = (void __user *) arg;
1060 struct pkey_genseck kgs;
1062 if (copy_from_user(&kgs, ugs, sizeof(kgs)))
1064 rc = pkey_genseckey(kgs.cardnr, kgs.domain,
1065 kgs.keytype, &kgs.seckey);
1066 DEBUG_DBG("pkey_ioctl pkey_genseckey()=%d\n", rc);
1069 if (copy_to_user(ugs, &kgs, sizeof(kgs)))
1073 case PKEY_CLR2SECK: {
1074 struct pkey_clr2seck __user *ucs = (void __user *) arg;
1075 struct pkey_clr2seck kcs;
1077 if (copy_from_user(&kcs, ucs, sizeof(kcs)))
1079 rc = pkey_clr2seckey(kcs.cardnr, kcs.domain, kcs.keytype,
1080 &kcs.clrkey, &kcs.seckey);
1081 DEBUG_DBG("pkey_ioctl pkey_clr2seckey()=%d\n", rc);
1084 if (copy_to_user(ucs, &kcs, sizeof(kcs)))
1086 memzero_explicit(&kcs, sizeof(kcs));
1089 case PKEY_SEC2PROTK: {
1090 struct pkey_sec2protk __user *usp = (void __user *) arg;
1091 struct pkey_sec2protk ksp;
1093 if (copy_from_user(&ksp, usp, sizeof(ksp)))
1095 rc = pkey_sec2protkey(ksp.cardnr, ksp.domain,
1096 &ksp.seckey, &ksp.protkey);
1097 DEBUG_DBG("pkey_ioctl pkey_sec2protkey()=%d\n", rc);
1100 if (copy_to_user(usp, &ksp, sizeof(ksp)))
1104 case PKEY_CLR2PROTK: {
1105 struct pkey_clr2protk __user *ucp = (void __user *) arg;
1106 struct pkey_clr2protk kcp;
1108 if (copy_from_user(&kcp, ucp, sizeof(kcp)))
1110 rc = pkey_clr2protkey(kcp.keytype,
1111 &kcp.clrkey, &kcp.protkey);
1112 DEBUG_DBG("pkey_ioctl pkey_clr2protkey()=%d\n", rc);
1115 if (copy_to_user(ucp, &kcp, sizeof(kcp)))
1117 memzero_explicit(&kcp, sizeof(kcp));
1120 case PKEY_FINDCARD: {
1121 struct pkey_findcard __user *ufc = (void __user *) arg;
1122 struct pkey_findcard kfc;
1124 if (copy_from_user(&kfc, ufc, sizeof(kfc)))
1126 rc = pkey_findcard(&kfc.seckey,
1127 &kfc.cardnr, &kfc.domain, 1);
1128 DEBUG_DBG("pkey_ioctl pkey_findcard()=%d\n", rc);
1131 if (copy_to_user(ufc, &kfc, sizeof(kfc)))
1135 case PKEY_SKEY2PKEY: {
1136 struct pkey_skey2pkey __user *usp = (void __user *) arg;
1137 struct pkey_skey2pkey ksp;
1139 if (copy_from_user(&ksp, usp, sizeof(ksp)))
1141 rc = pkey_skey2pkey(&ksp.seckey, &ksp.protkey);
1142 DEBUG_DBG("pkey_ioctl pkey_skey2pkey()=%d\n", rc);
1145 if (copy_to_user(usp, &ksp, sizeof(ksp)))
1149 case PKEY_VERIFYKEY: {
1150 struct pkey_verifykey __user *uvk = (void __user *) arg;
1151 struct pkey_verifykey kvk;
1153 if (copy_from_user(&kvk, uvk, sizeof(kvk)))
1155 rc = pkey_verifykey(&kvk.seckey, &kvk.cardnr, &kvk.domain,
1156 &kvk.keysize, &kvk.attributes);
1157 DEBUG_DBG("pkey_ioctl pkey_verifykey()=%d\n", rc);
1160 if (copy_to_user(uvk, &kvk, sizeof(kvk)))
1165 /* unknown/unsupported ioctl cmd */
1173 * Sysfs and file io operations
1175 static const struct file_operations pkey_fops = {
1176 .owner = THIS_MODULE,
1177 .open = nonseekable_open,
1178 .llseek = no_llseek,
1179 .unlocked_ioctl = pkey_unlocked_ioctl,
1182 static struct miscdevice pkey_dev = {
1184 .minor = MISC_DYNAMIC_MINOR,
1192 static int __init pkey_init(void)
1194 cpacf_mask_t pckmo_functions;
1196 /* check for pckmo instructions available */
1197 if (!cpacf_query(CPACF_PCKMO, &pckmo_functions))
1199 if (!cpacf_test_func(&pckmo_functions, CPACF_PCKMO_ENC_AES_128_KEY) ||
1200 !cpacf_test_func(&pckmo_functions, CPACF_PCKMO_ENC_AES_192_KEY) ||
1201 !cpacf_test_func(&pckmo_functions, CPACF_PCKMO_ENC_AES_256_KEY))
1206 return misc_register(&pkey_dev);
1212 static void __exit pkey_exit(void)
1214 misc_deregister(&pkey_dev);
1219 module_init(pkey_init);
1220 module_exit(pkey_exit);