1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright IBM Corp. 2017,2019
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 <linux/random.h>
20 #include <linux/cpufeature.h>
21 #include <asm/zcrypt.h>
22 #include <asm/cpacf.h>
24 #include <crypto/aes.h>
26 #include "zcrypt_api.h"
27 #include "zcrypt_ccamisc.h"
29 MODULE_LICENSE("GPL");
30 MODULE_AUTHOR("IBM Corporation");
31 MODULE_DESCRIPTION("s390 protected key interface");
33 #define KEYBLOBBUFSIZE 8192 /* key buffer size used for internal processing */
34 #define MAXAPQNSINLIST 64 /* max 64 apqns within a apqn list */
36 /* mask of available pckmo subfunctions, fetched once at module init */
37 static cpacf_mask_t pckmo_functions;
40 * debug feature data and functions
43 static debug_info_t *debug_info;
45 #define DEBUG_DBG(...) debug_sprintf_event(debug_info, 6, ##__VA_ARGS__)
46 #define DEBUG_INFO(...) debug_sprintf_event(debug_info, 5, ##__VA_ARGS__)
47 #define DEBUG_WARN(...) debug_sprintf_event(debug_info, 4, ##__VA_ARGS__)
48 #define DEBUG_ERR(...) debug_sprintf_event(debug_info, 3, ##__VA_ARGS__)
50 static void __init pkey_debug_init(void)
52 /* 5 arguments per dbf entry (including the format string ptr) */
53 debug_info = debug_register("pkey", 1, 1, 5 * sizeof(long));
54 debug_register_view(debug_info, &debug_sprintf_view);
55 debug_set_level(debug_info, 3);
58 static void __exit pkey_debug_exit(void)
60 debug_unregister(debug_info);
63 /* inside view of a protected key token (only type 0x00 version 0x01) */
64 struct protaeskeytoken {
65 u8 type; /* 0x00 for PAES specific key tokens */
67 u8 version; /* should be 0x01 for protected AES key token */
69 u32 keytype; /* key type, one of the PKEY_KEYTYPE values */
70 u32 len; /* bytes actually stored in protkey[] */
71 u8 protkey[MAXPROTKEYSIZE]; /* the protected key blob */
75 * Create a protected key from a clear key value.
77 static int pkey_clr2protkey(u32 keytype,
78 const struct pkey_clrkey *clrkey,
79 struct pkey_protkey *protkey)
86 case PKEY_KEYTYPE_AES_128:
88 fc = CPACF_PCKMO_ENC_AES_128_KEY;
90 case PKEY_KEYTYPE_AES_192:
92 fc = CPACF_PCKMO_ENC_AES_192_KEY;
94 case PKEY_KEYTYPE_AES_256:
96 fc = CPACF_PCKMO_ENC_AES_256_KEY;
99 DEBUG_ERR("%s unknown/unsupported keytype %d\n",
105 * Check if the needed pckmo subfunction is available.
106 * These subfunctions can be enabled/disabled by customers
107 * in the LPAR profile or may even change on the fly.
109 if (!cpacf_test_func(&pckmo_functions, fc)) {
110 DEBUG_ERR("%s pckmo functions not available\n", __func__);
114 /* prepare param block */
115 memset(paramblock, 0, sizeof(paramblock));
116 memcpy(paramblock, clrkey->clrkey, keysize);
118 /* call the pckmo instruction */
119 cpacf_pckmo(fc, paramblock);
121 /* copy created protected key */
122 protkey->type = keytype;
123 protkey->len = keysize + 32;
124 memcpy(protkey->protkey, paramblock, keysize + 32);
130 * Find card and transform secure key into protected key.
132 static int pkey_skey2pkey(const u8 *key, struct pkey_protkey *pkey)
136 struct keytoken_header *hdr = (struct keytoken_header *)key;
139 * The cca_xxx2protkey call may fail when a card has been
140 * addressed where the master key was changed after last fetch
141 * of the mkvp into the cache. Try 3 times: First witout verify
142 * then with verify and last round with verify and old master
143 * key verification pattern match not ignored.
145 for (verify = 0; verify < 3; verify++) {
146 rc = cca_findcard(key, &cardnr, &domain, verify);
149 if (rc > 0 && verify < 2)
151 switch (hdr->version) {
153 rc = cca_sec2protkey(cardnr, domain,
155 &pkey->len, &pkey->type);
157 case TOKVER_CCA_VLSC:
158 rc = cca_cipher2protkey(cardnr, domain,
160 &pkey->len, &pkey->type);
170 DEBUG_DBG("%s failed rc=%d\n", __func__, rc);
176 * Verify key and give back some info about the key.
178 static int pkey_verifykey(const struct pkey_seckey *seckey,
179 u16 *pcardnr, u16 *pdomain,
180 u16 *pkeysize, u32 *pattributes)
182 struct secaeskeytoken *t = (struct secaeskeytoken *) seckey;
186 /* check the secure key for valid AES secure key */
187 rc = cca_check_secaeskeytoken(debug_info, 3, (u8 *) seckey, 0);
191 *pattributes = PKEY_VERIFY_ATTR_AES;
193 *pkeysize = t->bitsize;
195 /* try to find a card which can handle this key */
196 rc = cca_findcard(seckey->seckey, &cardnr, &domain, 1);
201 /* key mkvp matches to old master key mkvp */
202 DEBUG_DBG("%s secure key has old mkvp\n", __func__);
204 *pattributes |= PKEY_VERIFY_ATTR_OLD_MKVP;
214 DEBUG_DBG("%s rc=%d\n", __func__, rc);
219 * Generate a random protected key
221 static int pkey_genprotkey(u32 keytype, struct pkey_protkey *protkey)
223 struct pkey_clrkey clrkey;
228 case PKEY_KEYTYPE_AES_128:
231 case PKEY_KEYTYPE_AES_192:
234 case PKEY_KEYTYPE_AES_256:
238 DEBUG_ERR("%s unknown/unsupported keytype %d\n", __func__,
243 /* generate a dummy random clear key */
244 get_random_bytes(clrkey.clrkey, keysize);
246 /* convert it to a dummy protected key */
247 rc = pkey_clr2protkey(keytype, &clrkey, protkey);
251 /* replace the key part of the protected key with random bytes */
252 get_random_bytes(protkey->protkey, keysize);
258 * Verify if a protected key is still valid
260 static int pkey_verifyprotkey(const struct pkey_protkey *protkey)
264 u8 iv[AES_BLOCK_SIZE];
265 u8 key[MAXPROTKEYSIZE];
267 u8 null_msg[AES_BLOCK_SIZE];
268 u8 dest_buf[AES_BLOCK_SIZE];
271 switch (protkey->type) {
272 case PKEY_KEYTYPE_AES_128:
273 fc = CPACF_KMC_PAES_128;
275 case PKEY_KEYTYPE_AES_192:
276 fc = CPACF_KMC_PAES_192;
278 case PKEY_KEYTYPE_AES_256:
279 fc = CPACF_KMC_PAES_256;
282 DEBUG_ERR("%s unknown/unsupported keytype %d\n", __func__,
287 memset(null_msg, 0, sizeof(null_msg));
289 memset(param.iv, 0, sizeof(param.iv));
290 memcpy(param.key, protkey->protkey, sizeof(param.key));
292 k = cpacf_kmc(fc | CPACF_ENCRYPT, ¶m, null_msg, dest_buf,
294 if (k != sizeof(null_msg)) {
295 DEBUG_ERR("%s protected key is not valid\n", __func__);
296 return -EKEYREJECTED;
303 * Transform a non-CCA key token into a protected key
305 static int pkey_nonccatok2pkey(const u8 *key, u32 keylen,
306 struct pkey_protkey *protkey)
308 struct keytoken_header *hdr = (struct keytoken_header *)key;
309 struct protaeskeytoken *t;
311 switch (hdr->version) {
312 case TOKVER_PROTECTED_KEY:
313 if (keylen != sizeof(struct protaeskeytoken))
316 t = (struct protaeskeytoken *)key;
317 protkey->len = t->len;
318 protkey->type = t->keytype;
319 memcpy(protkey->protkey, t->protkey,
320 sizeof(protkey->protkey));
322 return pkey_verifyprotkey(protkey);
324 DEBUG_ERR("%s unknown/unsupported non-CCA token version %d\n",
325 __func__, hdr->version);
331 * Transform a CCA internal key token into a protected key
333 static int pkey_ccainttok2pkey(const u8 *key, u32 keylen,
334 struct pkey_protkey *protkey)
336 struct keytoken_header *hdr = (struct keytoken_header *)key;
338 switch (hdr->version) {
340 if (keylen != sizeof(struct secaeskeytoken))
343 case TOKVER_CCA_VLSC:
344 if (keylen < hdr->len || keylen > MAXCCAVLSCTOKENSIZE)
348 DEBUG_ERR("%s unknown/unsupported CCA internal token version %d\n",
349 __func__, hdr->version);
353 return pkey_skey2pkey(key, protkey);
357 * Transform a key blob (of any type) into a protected key
359 int pkey_keyblob2pkey(const u8 *key, u32 keylen,
360 struct pkey_protkey *protkey)
363 struct keytoken_header *hdr = (struct keytoken_header *)key;
365 if (keylen < sizeof(struct keytoken_header)) {
366 DEBUG_ERR("%s invalid keylen %d\n", __func__, keylen);
371 case TOKTYPE_NON_CCA:
372 rc = pkey_nonccatok2pkey(key, keylen, protkey);
374 case TOKTYPE_CCA_INTERNAL:
375 rc = pkey_ccainttok2pkey(key, keylen, protkey);
378 DEBUG_ERR("%s unknown/unsupported blob type %d\n",
379 __func__, hdr->type);
383 DEBUG_DBG("%s rc=%d\n", __func__, rc);
387 EXPORT_SYMBOL(pkey_keyblob2pkey);
389 static int pkey_genseckey2(const struct pkey_apqn *apqns, size_t nr_apqns,
390 enum pkey_key_type ktype, enum pkey_key_size ksize,
391 u32 kflags, u8 *keybuf, size_t *keybufsize)
393 int i, card, dom, rc;
395 /* check for at least one apqn given */
396 if (!apqns || !nr_apqns)
399 /* check key type and size */
401 case PKEY_TYPE_CCA_DATA:
402 case PKEY_TYPE_CCA_CIPHER:
403 if (*keybufsize < SECKEYBLOBSIZE)
410 case PKEY_SIZE_AES_128:
411 case PKEY_SIZE_AES_192:
412 case PKEY_SIZE_AES_256:
418 /* simple try all apqns from the list */
419 for (i = 0, rc = -ENODEV; i < nr_apqns; i++) {
420 card = apqns[i].card;
421 dom = apqns[i].domain;
422 if (ktype == PKEY_TYPE_CCA_DATA) {
423 rc = cca_genseckey(card, dom, ksize, keybuf);
424 *keybufsize = (rc ? 0 : SECKEYBLOBSIZE);
425 } else /* TOKVER_CCA_VLSC */
426 rc = cca_gencipherkey(card, dom, ksize, kflags,
435 static int pkey_clr2seckey2(const struct pkey_apqn *apqns, size_t nr_apqns,
436 enum pkey_key_type ktype, enum pkey_key_size ksize,
437 u32 kflags, const u8 *clrkey,
438 u8 *keybuf, size_t *keybufsize)
440 int i, card, dom, rc;
442 /* check for at least one apqn given */
443 if (!apqns || !nr_apqns)
446 /* check key type and size */
448 case PKEY_TYPE_CCA_DATA:
449 case PKEY_TYPE_CCA_CIPHER:
450 if (*keybufsize < SECKEYBLOBSIZE)
457 case PKEY_SIZE_AES_128:
458 case PKEY_SIZE_AES_192:
459 case PKEY_SIZE_AES_256:
465 /* simple try all apqns from the list */
466 for (i = 0, rc = -ENODEV; i < nr_apqns; i++) {
467 card = apqns[i].card;
468 dom = apqns[i].domain;
469 if (ktype == PKEY_TYPE_CCA_DATA) {
470 rc = cca_clr2seckey(card, dom, ksize,
472 *keybufsize = (rc ? 0 : SECKEYBLOBSIZE);
473 } else /* TOKVER_CCA_VLSC */
474 rc = cca_clr2cipherkey(card, dom, ksize, kflags,
475 clrkey, keybuf, keybufsize);
483 static int pkey_verifykey2(const u8 *key, size_t keylen,
484 u16 *cardnr, u16 *domain,
485 enum pkey_key_type *ktype,
486 enum pkey_key_size *ksize, u32 *flags)
489 u32 _nr_apqns, *_apqns = NULL;
490 struct keytoken_header *hdr = (struct keytoken_header *)key;
492 if (keylen < sizeof(struct keytoken_header) ||
493 hdr->type != TOKTYPE_CCA_INTERNAL)
496 if (hdr->version == TOKVER_CCA_AES) {
497 struct secaeskeytoken *t = (struct secaeskeytoken *)key;
499 rc = cca_check_secaeskeytoken(debug_info, 3, key, 0);
503 *ktype = PKEY_TYPE_CCA_DATA;
505 *ksize = (enum pkey_key_size) t->bitsize;
507 rc = cca_findcard2(&_apqns, &_nr_apqns, *cardnr, *domain,
508 ZCRYPT_CEX3C, t->mkvp, 0, 1);
509 if (rc == 0 && flags)
510 *flags = PKEY_FLAGS_MATCH_CUR_MKVP;
512 rc = cca_findcard2(&_apqns, &_nr_apqns,
514 ZCRYPT_CEX3C, 0, t->mkvp, 1);
515 if (rc == 0 && flags)
516 *flags = PKEY_FLAGS_MATCH_ALT_MKVP;
521 *cardnr = ((struct pkey_apqn *)_apqns)->card;
522 *domain = ((struct pkey_apqn *)_apqns)->domain;
524 } else if (hdr->version == TOKVER_CCA_VLSC) {
525 struct cipherkeytoken *t = (struct cipherkeytoken *)key;
527 rc = cca_check_secaescipherkey(debug_info, 3, key, 0, 1);
531 *ktype = PKEY_TYPE_CCA_CIPHER;
533 *ksize = PKEY_SIZE_UNKNOWN;
534 if (!t->plfver && t->wpllen == 512)
535 *ksize = PKEY_SIZE_AES_128;
536 else if (!t->plfver && t->wpllen == 576)
537 *ksize = PKEY_SIZE_AES_192;
538 else if (!t->plfver && t->wpllen == 640)
539 *ksize = PKEY_SIZE_AES_256;
542 rc = cca_findcard2(&_apqns, &_nr_apqns, *cardnr, *domain,
543 ZCRYPT_CEX6, t->mkvp0, 0, 1);
544 if (rc == 0 && flags)
545 *flags = PKEY_FLAGS_MATCH_CUR_MKVP;
547 rc = cca_findcard2(&_apqns, &_nr_apqns,
549 ZCRYPT_CEX6, 0, t->mkvp0, 1);
550 if (rc == 0 && flags)
551 *flags = PKEY_FLAGS_MATCH_ALT_MKVP;
556 *cardnr = ((struct pkey_apqn *)_apqns)->card;
557 *domain = ((struct pkey_apqn *)_apqns)->domain;
567 static int pkey_keyblob2pkey2(const struct pkey_apqn *apqns, size_t nr_apqns,
568 const u8 *key, size_t keylen,
569 struct pkey_protkey *pkey)
571 int i, card, dom, rc;
572 struct keytoken_header *hdr = (struct keytoken_header *)key;
574 /* check for at least one apqn given */
575 if (!apqns || !nr_apqns)
578 if (keylen < sizeof(struct keytoken_header))
582 case TOKTYPE_NON_CCA:
583 return pkey_nonccatok2pkey(key, keylen, pkey);
584 case TOKTYPE_CCA_INTERNAL:
585 switch (hdr->version) {
587 if (keylen != sizeof(struct secaeskeytoken))
589 if (cca_check_secaeskeytoken(debug_info, 3, key, 0))
592 case TOKVER_CCA_VLSC:
593 if (keylen < hdr->len || keylen > MAXCCAVLSCTOKENSIZE)
595 if (cca_check_secaescipherkey(debug_info, 3, key, 0, 1))
599 DEBUG_ERR("%s unknown CCA internal token version %d\n",
600 __func__, hdr->version);
605 DEBUG_ERR("%s unknown/unsupported blob type %d\n",
606 __func__, hdr->type);
610 /* simple try all apqns from the list */
611 for (i = 0, rc = -ENODEV; i < nr_apqns; i++) {
612 card = apqns[i].card;
613 dom = apqns[i].domain;
614 if (hdr->version == TOKVER_CCA_AES)
615 rc = cca_sec2protkey(card, dom, key, pkey->protkey,
616 &pkey->len, &pkey->type);
617 else /* TOKVER_CCA_VLSC */
618 rc = cca_cipher2protkey(card, dom, key, pkey->protkey,
619 &pkey->len, &pkey->type);
627 static int pkey_apqns4key(const u8 *key, size_t keylen, u32 flags,
628 struct pkey_apqn *apqns, size_t *nr_apqns)
631 u32 _nr_apqns, *_apqns = NULL;
632 struct keytoken_header *hdr = (struct keytoken_header *)key;
634 if (keylen < sizeof(struct keytoken_header) ||
635 hdr->type != TOKTYPE_CCA_INTERNAL ||
639 if (hdr->version == TOKVER_CCA_AES || hdr->version == TOKVER_CCA_VLSC) {
640 int minhwtype = ZCRYPT_CEX3C;
641 u64 cur_mkvp = 0, old_mkvp = 0;
643 if (hdr->version == TOKVER_CCA_AES) {
644 struct secaeskeytoken *t = (struct secaeskeytoken *)key;
646 if (flags & PKEY_FLAGS_MATCH_CUR_MKVP)
648 if (flags & PKEY_FLAGS_MATCH_ALT_MKVP)
651 struct cipherkeytoken *t = (struct cipherkeytoken *)key;
653 minhwtype = ZCRYPT_CEX6;
654 if (flags & PKEY_FLAGS_MATCH_CUR_MKVP)
656 if (flags & PKEY_FLAGS_MATCH_ALT_MKVP)
659 rc = cca_findcard2(&_apqns, &_nr_apqns, 0xFFFF, 0xFFFF,
660 minhwtype, cur_mkvp, old_mkvp, 1);
664 if (*nr_apqns < _nr_apqns)
667 memcpy(apqns, _apqns, _nr_apqns * sizeof(u32));
669 *nr_apqns = _nr_apqns;
677 static int pkey_apqns4keytype(enum pkey_key_type ktype,
678 u8 cur_mkvp[32], u8 alt_mkvp[32], u32 flags,
679 struct pkey_apqn *apqns, size_t *nr_apqns)
682 u32 _nr_apqns, *_apqns = NULL;
684 if (ktype == PKEY_TYPE_CCA_DATA || ktype == PKEY_TYPE_CCA_CIPHER) {
685 u64 cur_mkvp = 0, old_mkvp = 0;
686 int minhwtype = ZCRYPT_CEX3C;
688 if (flags & PKEY_FLAGS_MATCH_CUR_MKVP)
689 cur_mkvp = *((u64 *) cur_mkvp);
690 if (flags & PKEY_FLAGS_MATCH_ALT_MKVP)
691 old_mkvp = *((u64 *) alt_mkvp);
692 if (ktype == PKEY_TYPE_CCA_CIPHER)
693 minhwtype = ZCRYPT_CEX6;
694 rc = cca_findcard2(&_apqns, &_nr_apqns, 0xFFFF, 0xFFFF,
695 minhwtype, cur_mkvp, old_mkvp, 1);
699 if (*nr_apqns < _nr_apqns)
702 memcpy(apqns, _apqns, _nr_apqns * sizeof(u32));
704 *nr_apqns = _nr_apqns;
716 static void *_copy_key_from_user(void __user *ukey, size_t keylen)
720 if (!ukey || keylen < MINKEYBLOBSIZE || keylen > KEYBLOBBUFSIZE)
721 return ERR_PTR(-EINVAL);
722 kkey = kmalloc(keylen, GFP_KERNEL);
724 return ERR_PTR(-ENOMEM);
725 if (copy_from_user(kkey, ukey, keylen)) {
727 return ERR_PTR(-EFAULT);
733 static void *_copy_apqns_from_user(void __user *uapqns, size_t nr_apqns)
738 if (uapqns && nr_apqns > 0) {
739 nbytes = nr_apqns * sizeof(struct pkey_apqn);
740 kapqns = kmalloc(nbytes, GFP_KERNEL);
742 return ERR_PTR(-ENOMEM);
743 if (copy_from_user(kapqns, uapqns, nbytes))
744 return ERR_PTR(-EFAULT);
750 static long pkey_unlocked_ioctl(struct file *filp, unsigned int cmd,
757 struct pkey_genseck __user *ugs = (void __user *) arg;
758 struct pkey_genseck kgs;
760 if (copy_from_user(&kgs, ugs, sizeof(kgs)))
762 rc = cca_genseckey(kgs.cardnr, kgs.domain,
763 kgs.keytype, kgs.seckey.seckey);
764 DEBUG_DBG("%s cca_genseckey()=%d\n", __func__, rc);
767 if (copy_to_user(ugs, &kgs, sizeof(kgs)))
771 case PKEY_CLR2SECK: {
772 struct pkey_clr2seck __user *ucs = (void __user *) arg;
773 struct pkey_clr2seck kcs;
775 if (copy_from_user(&kcs, ucs, sizeof(kcs)))
777 rc = cca_clr2seckey(kcs.cardnr, kcs.domain, kcs.keytype,
778 kcs.clrkey.clrkey, kcs.seckey.seckey);
779 DEBUG_DBG("%s cca_clr2seckey()=%d\n", __func__, rc);
782 if (copy_to_user(ucs, &kcs, sizeof(kcs)))
784 memzero_explicit(&kcs, sizeof(kcs));
787 case PKEY_SEC2PROTK: {
788 struct pkey_sec2protk __user *usp = (void __user *) arg;
789 struct pkey_sec2protk ksp;
791 if (copy_from_user(&ksp, usp, sizeof(ksp)))
793 rc = cca_sec2protkey(ksp.cardnr, ksp.domain,
794 ksp.seckey.seckey, ksp.protkey.protkey,
795 NULL, &ksp.protkey.type);
796 DEBUG_DBG("%s cca_sec2protkey()=%d\n", __func__, rc);
799 if (copy_to_user(usp, &ksp, sizeof(ksp)))
803 case PKEY_CLR2PROTK: {
804 struct pkey_clr2protk __user *ucp = (void __user *) arg;
805 struct pkey_clr2protk kcp;
807 if (copy_from_user(&kcp, ucp, sizeof(kcp)))
809 rc = pkey_clr2protkey(kcp.keytype,
810 &kcp.clrkey, &kcp.protkey);
811 DEBUG_DBG("%s pkey_clr2protkey()=%d\n", __func__, rc);
814 if (copy_to_user(ucp, &kcp, sizeof(kcp)))
816 memzero_explicit(&kcp, sizeof(kcp));
819 case PKEY_FINDCARD: {
820 struct pkey_findcard __user *ufc = (void __user *) arg;
821 struct pkey_findcard kfc;
823 if (copy_from_user(&kfc, ufc, sizeof(kfc)))
825 rc = cca_findcard(kfc.seckey.seckey,
826 &kfc.cardnr, &kfc.domain, 1);
827 DEBUG_DBG("%s cca_findcard()=%d\n", __func__, rc);
830 if (copy_to_user(ufc, &kfc, sizeof(kfc)))
834 case PKEY_SKEY2PKEY: {
835 struct pkey_skey2pkey __user *usp = (void __user *) arg;
836 struct pkey_skey2pkey ksp;
838 if (copy_from_user(&ksp, usp, sizeof(ksp)))
840 rc = pkey_skey2pkey(ksp.seckey.seckey, &ksp.protkey);
841 DEBUG_DBG("%s pkey_skey2pkey()=%d\n", __func__, rc);
844 if (copy_to_user(usp, &ksp, sizeof(ksp)))
848 case PKEY_VERIFYKEY: {
849 struct pkey_verifykey __user *uvk = (void __user *) arg;
850 struct pkey_verifykey kvk;
852 if (copy_from_user(&kvk, uvk, sizeof(kvk)))
854 rc = pkey_verifykey(&kvk.seckey, &kvk.cardnr, &kvk.domain,
855 &kvk.keysize, &kvk.attributes);
856 DEBUG_DBG("%s pkey_verifykey()=%d\n", __func__, rc);
859 if (copy_to_user(uvk, &kvk, sizeof(kvk)))
863 case PKEY_GENPROTK: {
864 struct pkey_genprotk __user *ugp = (void __user *) arg;
865 struct pkey_genprotk kgp;
867 if (copy_from_user(&kgp, ugp, sizeof(kgp)))
869 rc = pkey_genprotkey(kgp.keytype, &kgp.protkey);
870 DEBUG_DBG("%s pkey_genprotkey()=%d\n", __func__, rc);
873 if (copy_to_user(ugp, &kgp, sizeof(kgp)))
877 case PKEY_VERIFYPROTK: {
878 struct pkey_verifyprotk __user *uvp = (void __user *) arg;
879 struct pkey_verifyprotk kvp;
881 if (copy_from_user(&kvp, uvp, sizeof(kvp)))
883 rc = pkey_verifyprotkey(&kvp.protkey);
884 DEBUG_DBG("%s pkey_verifyprotkey()=%d\n", __func__, rc);
887 case PKEY_KBLOB2PROTK: {
888 struct pkey_kblob2pkey __user *utp = (void __user *) arg;
889 struct pkey_kblob2pkey ktp;
892 if (copy_from_user(&ktp, utp, sizeof(ktp)))
894 kkey = _copy_key_from_user(ktp.key, ktp.keylen);
896 return PTR_ERR(kkey);
897 rc = pkey_keyblob2pkey(kkey, ktp.keylen, &ktp.protkey);
898 DEBUG_DBG("%s pkey_keyblob2pkey()=%d\n", __func__, rc);
902 if (copy_to_user(utp, &ktp, sizeof(ktp)))
906 case PKEY_GENSECK2: {
907 struct pkey_genseck2 __user *ugs = (void __user *) arg;
908 struct pkey_genseck2 kgs;
909 struct pkey_apqn *apqns;
910 size_t klen = KEYBLOBBUFSIZE;
913 if (copy_from_user(&kgs, ugs, sizeof(kgs)))
915 apqns = _copy_apqns_from_user(kgs.apqns, kgs.apqn_entries);
917 return PTR_ERR(apqns);
918 kkey = kmalloc(klen, GFP_KERNEL);
923 rc = pkey_genseckey2(apqns, kgs.apqn_entries,
924 kgs.type, kgs.size, kgs.keygenflags,
926 DEBUG_DBG("%s pkey_genseckey2()=%d\n", __func__, rc);
933 if (kgs.keylen < klen) {
937 if (copy_to_user(kgs.key, kkey, klen)) {
943 if (copy_to_user(ugs, &kgs, sizeof(kgs)))
948 case PKEY_CLR2SECK2: {
949 struct pkey_clr2seck2 __user *ucs = (void __user *) arg;
950 struct pkey_clr2seck2 kcs;
951 struct pkey_apqn *apqns;
952 size_t klen = KEYBLOBBUFSIZE;
955 if (copy_from_user(&kcs, ucs, sizeof(kcs)))
957 apqns = _copy_apqns_from_user(kcs.apqns, kcs.apqn_entries);
959 return PTR_ERR(apqns);
960 kkey = kmalloc(klen, GFP_KERNEL);
965 rc = pkey_clr2seckey2(apqns, kcs.apqn_entries,
966 kcs.type, kcs.size, kcs.keygenflags,
967 kcs.clrkey.clrkey, kkey, &klen);
968 DEBUG_DBG("%s pkey_clr2seckey2()=%d\n", __func__, rc);
975 if (kcs.keylen < klen) {
979 if (copy_to_user(kcs.key, kkey, klen)) {
985 if (copy_to_user(ucs, &kcs, sizeof(kcs)))
987 memzero_explicit(&kcs, sizeof(kcs));
991 case PKEY_VERIFYKEY2: {
992 struct pkey_verifykey2 __user *uvk = (void __user *) arg;
993 struct pkey_verifykey2 kvk;
996 if (copy_from_user(&kvk, uvk, sizeof(kvk)))
998 kkey = _copy_key_from_user(kvk.key, kvk.keylen);
1000 return PTR_ERR(kkey);
1001 rc = pkey_verifykey2(kkey, kvk.keylen,
1002 &kvk.cardnr, &kvk.domain,
1003 &kvk.type, &kvk.size, &kvk.flags);
1004 DEBUG_DBG("%s pkey_verifykey2()=%d\n", __func__, rc);
1008 if (copy_to_user(uvk, &kvk, sizeof(kvk)))
1012 case PKEY_KBLOB2PROTK2: {
1013 struct pkey_kblob2pkey2 __user *utp = (void __user *) arg;
1014 struct pkey_kblob2pkey2 ktp;
1015 struct pkey_apqn *apqns = NULL;
1018 if (copy_from_user(&ktp, utp, sizeof(ktp)))
1020 apqns = _copy_apqns_from_user(ktp.apqns, ktp.apqn_entries);
1022 return PTR_ERR(apqns);
1023 kkey = _copy_key_from_user(ktp.key, ktp.keylen);
1026 return PTR_ERR(kkey);
1028 rc = pkey_keyblob2pkey2(apqns, ktp.apqn_entries,
1029 kkey, ktp.keylen, &ktp.protkey);
1030 DEBUG_DBG("%s pkey_keyblob2pkey2()=%d\n", __func__, rc);
1035 if (copy_to_user(utp, &ktp, sizeof(ktp)))
1039 case PKEY_APQNS4K: {
1040 struct pkey_apqns4key __user *uak = (void __user *) arg;
1041 struct pkey_apqns4key kak;
1042 struct pkey_apqn *apqns = NULL;
1043 size_t nr_apqns, len;
1046 if (copy_from_user(&kak, uak, sizeof(kak)))
1048 nr_apqns = kak.apqn_entries;
1050 apqns = kmalloc_array(nr_apqns,
1051 sizeof(struct pkey_apqn),
1056 kkey = _copy_key_from_user(kak.key, kak.keylen);
1059 return PTR_ERR(kkey);
1061 rc = pkey_apqns4key(kkey, kak.keylen, kak.flags,
1063 DEBUG_DBG("%s pkey_apqns4key()=%d\n", __func__, rc);
1065 if (rc && rc != -ENOSPC) {
1069 if (!rc && kak.apqns) {
1070 if (nr_apqns > kak.apqn_entries) {
1074 len = nr_apqns * sizeof(struct pkey_apqn);
1076 if (copy_to_user(kak.apqns, apqns, len)) {
1082 kak.apqn_entries = nr_apqns;
1083 if (copy_to_user(uak, &kak, sizeof(kak)))
1088 case PKEY_APQNS4KT: {
1089 struct pkey_apqns4keytype __user *uat = (void __user *) arg;
1090 struct pkey_apqns4keytype kat;
1091 struct pkey_apqn *apqns = NULL;
1092 size_t nr_apqns, len;
1094 if (copy_from_user(&kat, uat, sizeof(kat)))
1096 nr_apqns = kat.apqn_entries;
1098 apqns = kmalloc_array(nr_apqns,
1099 sizeof(struct pkey_apqn),
1104 rc = pkey_apqns4keytype(kat.type, kat.cur_mkvp, kat.alt_mkvp,
1105 kat.flags, apqns, &nr_apqns);
1106 DEBUG_DBG("%s pkey_apqns4keytype()=%d\n", __func__, rc);
1107 if (rc && rc != -ENOSPC) {
1111 if (!rc && kat.apqns) {
1112 if (nr_apqns > kat.apqn_entries) {
1116 len = nr_apqns * sizeof(struct pkey_apqn);
1118 if (copy_to_user(kat.apqns, apqns, len)) {
1124 kat.apqn_entries = nr_apqns;
1125 if (copy_to_user(uat, &kat, sizeof(kat)))
1131 /* unknown/unsupported ioctl cmd */
1139 * Sysfs and file io operations
1143 * Sysfs attribute read function for all protected key binary attributes.
1144 * The implementation can not deal with partial reads, because a new random
1145 * protected key blob is generated with each read. In case of partial reads
1146 * (i.e. off != 0 or count < key blob size) -EINVAL is returned.
1148 static ssize_t pkey_protkey_aes_attr_read(u32 keytype, bool is_xts, char *buf,
1149 loff_t off, size_t count)
1151 struct protaeskeytoken protkeytoken;
1152 struct pkey_protkey protkey;
1155 if (off != 0 || count < sizeof(protkeytoken))
1158 if (count < 2 * sizeof(protkeytoken))
1161 memset(&protkeytoken, 0, sizeof(protkeytoken));
1162 protkeytoken.type = TOKTYPE_NON_CCA;
1163 protkeytoken.version = TOKVER_PROTECTED_KEY;
1164 protkeytoken.keytype = keytype;
1166 rc = pkey_genprotkey(protkeytoken.keytype, &protkey);
1170 protkeytoken.len = protkey.len;
1171 memcpy(&protkeytoken.protkey, &protkey.protkey, protkey.len);
1173 memcpy(buf, &protkeytoken, sizeof(protkeytoken));
1176 rc = pkey_genprotkey(protkeytoken.keytype, &protkey);
1180 protkeytoken.len = protkey.len;
1181 memcpy(&protkeytoken.protkey, &protkey.protkey, protkey.len);
1183 memcpy(buf + sizeof(protkeytoken), &protkeytoken,
1184 sizeof(protkeytoken));
1186 return 2 * sizeof(protkeytoken);
1189 return sizeof(protkeytoken);
1192 static ssize_t protkey_aes_128_read(struct file *filp,
1193 struct kobject *kobj,
1194 struct bin_attribute *attr,
1195 char *buf, loff_t off,
1198 return pkey_protkey_aes_attr_read(PKEY_KEYTYPE_AES_128, false, buf,
1202 static ssize_t protkey_aes_192_read(struct file *filp,
1203 struct kobject *kobj,
1204 struct bin_attribute *attr,
1205 char *buf, loff_t off,
1208 return pkey_protkey_aes_attr_read(PKEY_KEYTYPE_AES_192, false, buf,
1212 static ssize_t protkey_aes_256_read(struct file *filp,
1213 struct kobject *kobj,
1214 struct bin_attribute *attr,
1215 char *buf, loff_t off,
1218 return pkey_protkey_aes_attr_read(PKEY_KEYTYPE_AES_256, false, buf,
1222 static ssize_t protkey_aes_128_xts_read(struct file *filp,
1223 struct kobject *kobj,
1224 struct bin_attribute *attr,
1225 char *buf, loff_t off,
1228 return pkey_protkey_aes_attr_read(PKEY_KEYTYPE_AES_128, true, buf,
1232 static ssize_t protkey_aes_256_xts_read(struct file *filp,
1233 struct kobject *kobj,
1234 struct bin_attribute *attr,
1235 char *buf, loff_t off,
1238 return pkey_protkey_aes_attr_read(PKEY_KEYTYPE_AES_256, true, buf,
1242 static BIN_ATTR_RO(protkey_aes_128, sizeof(struct protaeskeytoken));
1243 static BIN_ATTR_RO(protkey_aes_192, sizeof(struct protaeskeytoken));
1244 static BIN_ATTR_RO(protkey_aes_256, sizeof(struct protaeskeytoken));
1245 static BIN_ATTR_RO(protkey_aes_128_xts, 2 * sizeof(struct protaeskeytoken));
1246 static BIN_ATTR_RO(protkey_aes_256_xts, 2 * sizeof(struct protaeskeytoken));
1248 static struct bin_attribute *protkey_attrs[] = {
1249 &bin_attr_protkey_aes_128,
1250 &bin_attr_protkey_aes_192,
1251 &bin_attr_protkey_aes_256,
1252 &bin_attr_protkey_aes_128_xts,
1253 &bin_attr_protkey_aes_256_xts,
1257 static struct attribute_group protkey_attr_group = {
1259 .bin_attrs = protkey_attrs,
1263 * Sysfs attribute read function for all secure key ccadata binary attributes.
1264 * The implementation can not deal with partial reads, because a new random
1265 * protected key blob is generated with each read. In case of partial reads
1266 * (i.e. off != 0 or count < key blob size) -EINVAL is returned.
1268 static ssize_t pkey_ccadata_aes_attr_read(u32 keytype, bool is_xts, char *buf,
1269 loff_t off, size_t count)
1272 struct pkey_seckey *seckey = (struct pkey_seckey *) buf;
1274 if (off != 0 || count < sizeof(struct secaeskeytoken))
1277 if (count < 2 * sizeof(struct secaeskeytoken))
1280 rc = cca_genseckey(-1, -1, keytype, seckey->seckey);
1286 rc = cca_genseckey(-1, -1, keytype, seckey->seckey);
1290 return 2 * sizeof(struct secaeskeytoken);
1293 return sizeof(struct secaeskeytoken);
1296 static ssize_t ccadata_aes_128_read(struct file *filp,
1297 struct kobject *kobj,
1298 struct bin_attribute *attr,
1299 char *buf, loff_t off,
1302 return pkey_ccadata_aes_attr_read(PKEY_KEYTYPE_AES_128, false, buf,
1306 static ssize_t ccadata_aes_192_read(struct file *filp,
1307 struct kobject *kobj,
1308 struct bin_attribute *attr,
1309 char *buf, loff_t off,
1312 return pkey_ccadata_aes_attr_read(PKEY_KEYTYPE_AES_192, false, buf,
1316 static ssize_t ccadata_aes_256_read(struct file *filp,
1317 struct kobject *kobj,
1318 struct bin_attribute *attr,
1319 char *buf, loff_t off,
1322 return pkey_ccadata_aes_attr_read(PKEY_KEYTYPE_AES_256, false, buf,
1326 static ssize_t ccadata_aes_128_xts_read(struct file *filp,
1327 struct kobject *kobj,
1328 struct bin_attribute *attr,
1329 char *buf, loff_t off,
1332 return pkey_ccadata_aes_attr_read(PKEY_KEYTYPE_AES_128, true, buf,
1336 static ssize_t ccadata_aes_256_xts_read(struct file *filp,
1337 struct kobject *kobj,
1338 struct bin_attribute *attr,
1339 char *buf, loff_t off,
1342 return pkey_ccadata_aes_attr_read(PKEY_KEYTYPE_AES_256, true, buf,
1346 static BIN_ATTR_RO(ccadata_aes_128, sizeof(struct secaeskeytoken));
1347 static BIN_ATTR_RO(ccadata_aes_192, sizeof(struct secaeskeytoken));
1348 static BIN_ATTR_RO(ccadata_aes_256, sizeof(struct secaeskeytoken));
1349 static BIN_ATTR_RO(ccadata_aes_128_xts, 2 * sizeof(struct secaeskeytoken));
1350 static BIN_ATTR_RO(ccadata_aes_256_xts, 2 * sizeof(struct secaeskeytoken));
1352 static struct bin_attribute *ccadata_attrs[] = {
1353 &bin_attr_ccadata_aes_128,
1354 &bin_attr_ccadata_aes_192,
1355 &bin_attr_ccadata_aes_256,
1356 &bin_attr_ccadata_aes_128_xts,
1357 &bin_attr_ccadata_aes_256_xts,
1361 static struct attribute_group ccadata_attr_group = {
1363 .bin_attrs = ccadata_attrs,
1366 #define CCACIPHERTOKENSIZE (sizeof(struct cipherkeytoken) + 80)
1369 * Sysfs attribute read function for all secure key ccacipher binary attributes.
1370 * The implementation can not deal with partial reads, because a new random
1371 * secure key blob is generated with each read. In case of partial reads
1372 * (i.e. off != 0 or count < key blob size) -EINVAL is returned.
1374 static ssize_t pkey_ccacipher_aes_attr_read(enum pkey_key_size keybits,
1375 bool is_xts, char *buf, loff_t off,
1381 if (off != 0 || count < CCACIPHERTOKENSIZE)
1384 if (count < 2 * CCACIPHERTOKENSIZE)
1387 keysize = CCACIPHERTOKENSIZE;
1388 rc = cca_gencipherkey(-1, -1, keybits, 0, buf, &keysize);
1391 memset(buf + keysize, 0, CCACIPHERTOKENSIZE - keysize);
1394 keysize = CCACIPHERTOKENSIZE;
1395 rc = cca_gencipherkey(-1, -1, keybits, 0,
1396 buf + CCACIPHERTOKENSIZE, &keysize);
1399 memset(buf + CCACIPHERTOKENSIZE + keysize, 0,
1400 CCACIPHERTOKENSIZE - keysize);
1402 return 2 * CCACIPHERTOKENSIZE;
1405 return CCACIPHERTOKENSIZE;
1408 static ssize_t ccacipher_aes_128_read(struct file *filp,
1409 struct kobject *kobj,
1410 struct bin_attribute *attr,
1411 char *buf, loff_t off,
1414 return pkey_ccacipher_aes_attr_read(PKEY_SIZE_AES_128, false, buf,
1418 static ssize_t ccacipher_aes_192_read(struct file *filp,
1419 struct kobject *kobj,
1420 struct bin_attribute *attr,
1421 char *buf, loff_t off,
1424 return pkey_ccacipher_aes_attr_read(PKEY_SIZE_AES_192, false, buf,
1428 static ssize_t ccacipher_aes_256_read(struct file *filp,
1429 struct kobject *kobj,
1430 struct bin_attribute *attr,
1431 char *buf, loff_t off,
1434 return pkey_ccacipher_aes_attr_read(PKEY_SIZE_AES_256, false, buf,
1438 static ssize_t ccacipher_aes_128_xts_read(struct file *filp,
1439 struct kobject *kobj,
1440 struct bin_attribute *attr,
1441 char *buf, loff_t off,
1444 return pkey_ccacipher_aes_attr_read(PKEY_SIZE_AES_128, true, buf,
1448 static ssize_t ccacipher_aes_256_xts_read(struct file *filp,
1449 struct kobject *kobj,
1450 struct bin_attribute *attr,
1451 char *buf, loff_t off,
1454 return pkey_ccacipher_aes_attr_read(PKEY_SIZE_AES_256, true, buf,
1458 static BIN_ATTR_RO(ccacipher_aes_128, CCACIPHERTOKENSIZE);
1459 static BIN_ATTR_RO(ccacipher_aes_192, CCACIPHERTOKENSIZE);
1460 static BIN_ATTR_RO(ccacipher_aes_256, CCACIPHERTOKENSIZE);
1461 static BIN_ATTR_RO(ccacipher_aes_128_xts, 2 * CCACIPHERTOKENSIZE);
1462 static BIN_ATTR_RO(ccacipher_aes_256_xts, 2 * CCACIPHERTOKENSIZE);
1464 static struct bin_attribute *ccacipher_attrs[] = {
1465 &bin_attr_ccacipher_aes_128,
1466 &bin_attr_ccacipher_aes_192,
1467 &bin_attr_ccacipher_aes_256,
1468 &bin_attr_ccacipher_aes_128_xts,
1469 &bin_attr_ccacipher_aes_256_xts,
1473 static struct attribute_group ccacipher_attr_group = {
1474 .name = "ccacipher",
1475 .bin_attrs = ccacipher_attrs,
1478 static const struct attribute_group *pkey_attr_groups[] = {
1479 &protkey_attr_group,
1480 &ccadata_attr_group,
1481 &ccacipher_attr_group,
1485 static const struct file_operations pkey_fops = {
1486 .owner = THIS_MODULE,
1487 .open = nonseekable_open,
1488 .llseek = no_llseek,
1489 .unlocked_ioctl = pkey_unlocked_ioctl,
1492 static struct miscdevice pkey_dev = {
1494 .minor = MISC_DYNAMIC_MINOR,
1497 .groups = pkey_attr_groups,
1503 static int __init pkey_init(void)
1505 cpacf_mask_t kmc_functions;
1508 * The pckmo instruction should be available - even if we don't
1509 * actually invoke it. This instruction comes with MSA 3 which
1510 * is also the minimum level for the kmc instructions which
1511 * are able to work with protected keys.
1513 if (!cpacf_query(CPACF_PCKMO, &pckmo_functions))
1516 /* check for kmc instructions available */
1517 if (!cpacf_query(CPACF_KMC, &kmc_functions))
1519 if (!cpacf_test_func(&kmc_functions, CPACF_KMC_PAES_128) ||
1520 !cpacf_test_func(&kmc_functions, CPACF_KMC_PAES_192) ||
1521 !cpacf_test_func(&kmc_functions, CPACF_KMC_PAES_256))
1526 return misc_register(&pkey_dev);
1532 static void __exit pkey_exit(void)
1534 misc_deregister(&pkey_dev);
1538 module_cpu_feature_match(MSA, pkey_init);
1539 module_exit(pkey_exit);