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)
718 if (!ukey || keylen < MINKEYBLOBSIZE || keylen > KEYBLOBBUFSIZE)
719 return ERR_PTR(-EINVAL);
721 return memdup_user(ukey, keylen);
724 static void *_copy_apqns_from_user(void __user *uapqns, size_t nr_apqns)
726 if (!uapqns || nr_apqns == 0)
729 return memdup_user(uapqns, nr_apqns * sizeof(struct pkey_apqn));
732 static long pkey_unlocked_ioctl(struct file *filp, unsigned int cmd,
739 struct pkey_genseck __user *ugs = (void __user *) arg;
740 struct pkey_genseck kgs;
742 if (copy_from_user(&kgs, ugs, sizeof(kgs)))
744 rc = cca_genseckey(kgs.cardnr, kgs.domain,
745 kgs.keytype, kgs.seckey.seckey);
746 DEBUG_DBG("%s cca_genseckey()=%d\n", __func__, rc);
749 if (copy_to_user(ugs, &kgs, sizeof(kgs)))
753 case PKEY_CLR2SECK: {
754 struct pkey_clr2seck __user *ucs = (void __user *) arg;
755 struct pkey_clr2seck kcs;
757 if (copy_from_user(&kcs, ucs, sizeof(kcs)))
759 rc = cca_clr2seckey(kcs.cardnr, kcs.domain, kcs.keytype,
760 kcs.clrkey.clrkey, kcs.seckey.seckey);
761 DEBUG_DBG("%s cca_clr2seckey()=%d\n", __func__, rc);
764 if (copy_to_user(ucs, &kcs, sizeof(kcs)))
766 memzero_explicit(&kcs, sizeof(kcs));
769 case PKEY_SEC2PROTK: {
770 struct pkey_sec2protk __user *usp = (void __user *) arg;
771 struct pkey_sec2protk ksp;
773 if (copy_from_user(&ksp, usp, sizeof(ksp)))
775 rc = cca_sec2protkey(ksp.cardnr, ksp.domain,
776 ksp.seckey.seckey, ksp.protkey.protkey,
777 NULL, &ksp.protkey.type);
778 DEBUG_DBG("%s cca_sec2protkey()=%d\n", __func__, rc);
781 if (copy_to_user(usp, &ksp, sizeof(ksp)))
785 case PKEY_CLR2PROTK: {
786 struct pkey_clr2protk __user *ucp = (void __user *) arg;
787 struct pkey_clr2protk kcp;
789 if (copy_from_user(&kcp, ucp, sizeof(kcp)))
791 rc = pkey_clr2protkey(kcp.keytype,
792 &kcp.clrkey, &kcp.protkey);
793 DEBUG_DBG("%s pkey_clr2protkey()=%d\n", __func__, rc);
796 if (copy_to_user(ucp, &kcp, sizeof(kcp)))
798 memzero_explicit(&kcp, sizeof(kcp));
801 case PKEY_FINDCARD: {
802 struct pkey_findcard __user *ufc = (void __user *) arg;
803 struct pkey_findcard kfc;
805 if (copy_from_user(&kfc, ufc, sizeof(kfc)))
807 rc = cca_findcard(kfc.seckey.seckey,
808 &kfc.cardnr, &kfc.domain, 1);
809 DEBUG_DBG("%s cca_findcard()=%d\n", __func__, rc);
812 if (copy_to_user(ufc, &kfc, sizeof(kfc)))
816 case PKEY_SKEY2PKEY: {
817 struct pkey_skey2pkey __user *usp = (void __user *) arg;
818 struct pkey_skey2pkey ksp;
820 if (copy_from_user(&ksp, usp, sizeof(ksp)))
822 rc = pkey_skey2pkey(ksp.seckey.seckey, &ksp.protkey);
823 DEBUG_DBG("%s pkey_skey2pkey()=%d\n", __func__, rc);
826 if (copy_to_user(usp, &ksp, sizeof(ksp)))
830 case PKEY_VERIFYKEY: {
831 struct pkey_verifykey __user *uvk = (void __user *) arg;
832 struct pkey_verifykey kvk;
834 if (copy_from_user(&kvk, uvk, sizeof(kvk)))
836 rc = pkey_verifykey(&kvk.seckey, &kvk.cardnr, &kvk.domain,
837 &kvk.keysize, &kvk.attributes);
838 DEBUG_DBG("%s pkey_verifykey()=%d\n", __func__, rc);
841 if (copy_to_user(uvk, &kvk, sizeof(kvk)))
845 case PKEY_GENPROTK: {
846 struct pkey_genprotk __user *ugp = (void __user *) arg;
847 struct pkey_genprotk kgp;
849 if (copy_from_user(&kgp, ugp, sizeof(kgp)))
851 rc = pkey_genprotkey(kgp.keytype, &kgp.protkey);
852 DEBUG_DBG("%s pkey_genprotkey()=%d\n", __func__, rc);
855 if (copy_to_user(ugp, &kgp, sizeof(kgp)))
859 case PKEY_VERIFYPROTK: {
860 struct pkey_verifyprotk __user *uvp = (void __user *) arg;
861 struct pkey_verifyprotk kvp;
863 if (copy_from_user(&kvp, uvp, sizeof(kvp)))
865 rc = pkey_verifyprotkey(&kvp.protkey);
866 DEBUG_DBG("%s pkey_verifyprotkey()=%d\n", __func__, rc);
869 case PKEY_KBLOB2PROTK: {
870 struct pkey_kblob2pkey __user *utp = (void __user *) arg;
871 struct pkey_kblob2pkey ktp;
874 if (copy_from_user(&ktp, utp, sizeof(ktp)))
876 kkey = _copy_key_from_user(ktp.key, ktp.keylen);
878 return PTR_ERR(kkey);
879 rc = pkey_keyblob2pkey(kkey, ktp.keylen, &ktp.protkey);
880 DEBUG_DBG("%s pkey_keyblob2pkey()=%d\n", __func__, rc);
884 if (copy_to_user(utp, &ktp, sizeof(ktp)))
888 case PKEY_GENSECK2: {
889 struct pkey_genseck2 __user *ugs = (void __user *) arg;
890 struct pkey_genseck2 kgs;
891 struct pkey_apqn *apqns;
892 size_t klen = KEYBLOBBUFSIZE;
895 if (copy_from_user(&kgs, ugs, sizeof(kgs)))
897 apqns = _copy_apqns_from_user(kgs.apqns, kgs.apqn_entries);
899 return PTR_ERR(apqns);
900 kkey = kmalloc(klen, GFP_KERNEL);
905 rc = pkey_genseckey2(apqns, kgs.apqn_entries,
906 kgs.type, kgs.size, kgs.keygenflags,
908 DEBUG_DBG("%s pkey_genseckey2()=%d\n", __func__, rc);
915 if (kgs.keylen < klen) {
919 if (copy_to_user(kgs.key, kkey, klen)) {
925 if (copy_to_user(ugs, &kgs, sizeof(kgs)))
930 case PKEY_CLR2SECK2: {
931 struct pkey_clr2seck2 __user *ucs = (void __user *) arg;
932 struct pkey_clr2seck2 kcs;
933 struct pkey_apqn *apqns;
934 size_t klen = KEYBLOBBUFSIZE;
937 if (copy_from_user(&kcs, ucs, sizeof(kcs)))
939 apqns = _copy_apqns_from_user(kcs.apqns, kcs.apqn_entries);
941 return PTR_ERR(apqns);
942 kkey = kmalloc(klen, GFP_KERNEL);
947 rc = pkey_clr2seckey2(apqns, kcs.apqn_entries,
948 kcs.type, kcs.size, kcs.keygenflags,
949 kcs.clrkey.clrkey, kkey, &klen);
950 DEBUG_DBG("%s pkey_clr2seckey2()=%d\n", __func__, rc);
957 if (kcs.keylen < klen) {
961 if (copy_to_user(kcs.key, kkey, klen)) {
967 if (copy_to_user(ucs, &kcs, sizeof(kcs)))
969 memzero_explicit(&kcs, sizeof(kcs));
973 case PKEY_VERIFYKEY2: {
974 struct pkey_verifykey2 __user *uvk = (void __user *) arg;
975 struct pkey_verifykey2 kvk;
978 if (copy_from_user(&kvk, uvk, sizeof(kvk)))
980 kkey = _copy_key_from_user(kvk.key, kvk.keylen);
982 return PTR_ERR(kkey);
983 rc = pkey_verifykey2(kkey, kvk.keylen,
984 &kvk.cardnr, &kvk.domain,
985 &kvk.type, &kvk.size, &kvk.flags);
986 DEBUG_DBG("%s pkey_verifykey2()=%d\n", __func__, rc);
990 if (copy_to_user(uvk, &kvk, sizeof(kvk)))
994 case PKEY_KBLOB2PROTK2: {
995 struct pkey_kblob2pkey2 __user *utp = (void __user *) arg;
996 struct pkey_kblob2pkey2 ktp;
997 struct pkey_apqn *apqns = NULL;
1000 if (copy_from_user(&ktp, utp, sizeof(ktp)))
1002 apqns = _copy_apqns_from_user(ktp.apqns, ktp.apqn_entries);
1004 return PTR_ERR(apqns);
1005 kkey = _copy_key_from_user(ktp.key, ktp.keylen);
1008 return PTR_ERR(kkey);
1010 rc = pkey_keyblob2pkey2(apqns, ktp.apqn_entries,
1011 kkey, ktp.keylen, &ktp.protkey);
1012 DEBUG_DBG("%s pkey_keyblob2pkey2()=%d\n", __func__, rc);
1017 if (copy_to_user(utp, &ktp, sizeof(ktp)))
1021 case PKEY_APQNS4K: {
1022 struct pkey_apqns4key __user *uak = (void __user *) arg;
1023 struct pkey_apqns4key kak;
1024 struct pkey_apqn *apqns = NULL;
1025 size_t nr_apqns, len;
1028 if (copy_from_user(&kak, uak, sizeof(kak)))
1030 nr_apqns = kak.apqn_entries;
1032 apqns = kmalloc_array(nr_apqns,
1033 sizeof(struct pkey_apqn),
1038 kkey = _copy_key_from_user(kak.key, kak.keylen);
1041 return PTR_ERR(kkey);
1043 rc = pkey_apqns4key(kkey, kak.keylen, kak.flags,
1045 DEBUG_DBG("%s pkey_apqns4key()=%d\n", __func__, rc);
1047 if (rc && rc != -ENOSPC) {
1051 if (!rc && kak.apqns) {
1052 if (nr_apqns > kak.apqn_entries) {
1056 len = nr_apqns * sizeof(struct pkey_apqn);
1058 if (copy_to_user(kak.apqns, apqns, len)) {
1064 kak.apqn_entries = nr_apqns;
1065 if (copy_to_user(uak, &kak, sizeof(kak)))
1070 case PKEY_APQNS4KT: {
1071 struct pkey_apqns4keytype __user *uat = (void __user *) arg;
1072 struct pkey_apqns4keytype kat;
1073 struct pkey_apqn *apqns = NULL;
1074 size_t nr_apqns, len;
1076 if (copy_from_user(&kat, uat, sizeof(kat)))
1078 nr_apqns = kat.apqn_entries;
1080 apqns = kmalloc_array(nr_apqns,
1081 sizeof(struct pkey_apqn),
1086 rc = pkey_apqns4keytype(kat.type, kat.cur_mkvp, kat.alt_mkvp,
1087 kat.flags, apqns, &nr_apqns);
1088 DEBUG_DBG("%s pkey_apqns4keytype()=%d\n", __func__, rc);
1089 if (rc && rc != -ENOSPC) {
1093 if (!rc && kat.apqns) {
1094 if (nr_apqns > kat.apqn_entries) {
1098 len = nr_apqns * sizeof(struct pkey_apqn);
1100 if (copy_to_user(kat.apqns, apqns, len)) {
1106 kat.apqn_entries = nr_apqns;
1107 if (copy_to_user(uat, &kat, sizeof(kat)))
1113 /* unknown/unsupported ioctl cmd */
1121 * Sysfs and file io operations
1125 * Sysfs attribute read function for all protected key binary attributes.
1126 * The implementation can not deal with partial reads, because a new random
1127 * protected key blob is generated with each read. In case of partial reads
1128 * (i.e. off != 0 or count < key blob size) -EINVAL is returned.
1130 static ssize_t pkey_protkey_aes_attr_read(u32 keytype, bool is_xts, char *buf,
1131 loff_t off, size_t count)
1133 struct protaeskeytoken protkeytoken;
1134 struct pkey_protkey protkey;
1137 if (off != 0 || count < sizeof(protkeytoken))
1140 if (count < 2 * sizeof(protkeytoken))
1143 memset(&protkeytoken, 0, sizeof(protkeytoken));
1144 protkeytoken.type = TOKTYPE_NON_CCA;
1145 protkeytoken.version = TOKVER_PROTECTED_KEY;
1146 protkeytoken.keytype = keytype;
1148 rc = pkey_genprotkey(protkeytoken.keytype, &protkey);
1152 protkeytoken.len = protkey.len;
1153 memcpy(&protkeytoken.protkey, &protkey.protkey, protkey.len);
1155 memcpy(buf, &protkeytoken, sizeof(protkeytoken));
1158 rc = pkey_genprotkey(protkeytoken.keytype, &protkey);
1162 protkeytoken.len = protkey.len;
1163 memcpy(&protkeytoken.protkey, &protkey.protkey, protkey.len);
1165 memcpy(buf + sizeof(protkeytoken), &protkeytoken,
1166 sizeof(protkeytoken));
1168 return 2 * sizeof(protkeytoken);
1171 return sizeof(protkeytoken);
1174 static ssize_t protkey_aes_128_read(struct file *filp,
1175 struct kobject *kobj,
1176 struct bin_attribute *attr,
1177 char *buf, loff_t off,
1180 return pkey_protkey_aes_attr_read(PKEY_KEYTYPE_AES_128, false, buf,
1184 static ssize_t protkey_aes_192_read(struct file *filp,
1185 struct kobject *kobj,
1186 struct bin_attribute *attr,
1187 char *buf, loff_t off,
1190 return pkey_protkey_aes_attr_read(PKEY_KEYTYPE_AES_192, false, buf,
1194 static ssize_t protkey_aes_256_read(struct file *filp,
1195 struct kobject *kobj,
1196 struct bin_attribute *attr,
1197 char *buf, loff_t off,
1200 return pkey_protkey_aes_attr_read(PKEY_KEYTYPE_AES_256, false, buf,
1204 static ssize_t protkey_aes_128_xts_read(struct file *filp,
1205 struct kobject *kobj,
1206 struct bin_attribute *attr,
1207 char *buf, loff_t off,
1210 return pkey_protkey_aes_attr_read(PKEY_KEYTYPE_AES_128, true, buf,
1214 static ssize_t protkey_aes_256_xts_read(struct file *filp,
1215 struct kobject *kobj,
1216 struct bin_attribute *attr,
1217 char *buf, loff_t off,
1220 return pkey_protkey_aes_attr_read(PKEY_KEYTYPE_AES_256, true, buf,
1224 static BIN_ATTR_RO(protkey_aes_128, sizeof(struct protaeskeytoken));
1225 static BIN_ATTR_RO(protkey_aes_192, sizeof(struct protaeskeytoken));
1226 static BIN_ATTR_RO(protkey_aes_256, sizeof(struct protaeskeytoken));
1227 static BIN_ATTR_RO(protkey_aes_128_xts, 2 * sizeof(struct protaeskeytoken));
1228 static BIN_ATTR_RO(protkey_aes_256_xts, 2 * sizeof(struct protaeskeytoken));
1230 static struct bin_attribute *protkey_attrs[] = {
1231 &bin_attr_protkey_aes_128,
1232 &bin_attr_protkey_aes_192,
1233 &bin_attr_protkey_aes_256,
1234 &bin_attr_protkey_aes_128_xts,
1235 &bin_attr_protkey_aes_256_xts,
1239 static struct attribute_group protkey_attr_group = {
1241 .bin_attrs = protkey_attrs,
1245 * Sysfs attribute read function for all secure key ccadata binary attributes.
1246 * The implementation can not deal with partial reads, because a new random
1247 * protected key blob is generated with each read. In case of partial reads
1248 * (i.e. off != 0 or count < key blob size) -EINVAL is returned.
1250 static ssize_t pkey_ccadata_aes_attr_read(u32 keytype, bool is_xts, char *buf,
1251 loff_t off, size_t count)
1254 struct pkey_seckey *seckey = (struct pkey_seckey *) buf;
1256 if (off != 0 || count < sizeof(struct secaeskeytoken))
1259 if (count < 2 * sizeof(struct secaeskeytoken))
1262 rc = cca_genseckey(-1, -1, keytype, seckey->seckey);
1268 rc = cca_genseckey(-1, -1, keytype, seckey->seckey);
1272 return 2 * sizeof(struct secaeskeytoken);
1275 return sizeof(struct secaeskeytoken);
1278 static ssize_t ccadata_aes_128_read(struct file *filp,
1279 struct kobject *kobj,
1280 struct bin_attribute *attr,
1281 char *buf, loff_t off,
1284 return pkey_ccadata_aes_attr_read(PKEY_KEYTYPE_AES_128, false, buf,
1288 static ssize_t ccadata_aes_192_read(struct file *filp,
1289 struct kobject *kobj,
1290 struct bin_attribute *attr,
1291 char *buf, loff_t off,
1294 return pkey_ccadata_aes_attr_read(PKEY_KEYTYPE_AES_192, false, buf,
1298 static ssize_t ccadata_aes_256_read(struct file *filp,
1299 struct kobject *kobj,
1300 struct bin_attribute *attr,
1301 char *buf, loff_t off,
1304 return pkey_ccadata_aes_attr_read(PKEY_KEYTYPE_AES_256, false, buf,
1308 static ssize_t ccadata_aes_128_xts_read(struct file *filp,
1309 struct kobject *kobj,
1310 struct bin_attribute *attr,
1311 char *buf, loff_t off,
1314 return pkey_ccadata_aes_attr_read(PKEY_KEYTYPE_AES_128, true, buf,
1318 static ssize_t ccadata_aes_256_xts_read(struct file *filp,
1319 struct kobject *kobj,
1320 struct bin_attribute *attr,
1321 char *buf, loff_t off,
1324 return pkey_ccadata_aes_attr_read(PKEY_KEYTYPE_AES_256, true, buf,
1328 static BIN_ATTR_RO(ccadata_aes_128, sizeof(struct secaeskeytoken));
1329 static BIN_ATTR_RO(ccadata_aes_192, sizeof(struct secaeskeytoken));
1330 static BIN_ATTR_RO(ccadata_aes_256, sizeof(struct secaeskeytoken));
1331 static BIN_ATTR_RO(ccadata_aes_128_xts, 2 * sizeof(struct secaeskeytoken));
1332 static BIN_ATTR_RO(ccadata_aes_256_xts, 2 * sizeof(struct secaeskeytoken));
1334 static struct bin_attribute *ccadata_attrs[] = {
1335 &bin_attr_ccadata_aes_128,
1336 &bin_attr_ccadata_aes_192,
1337 &bin_attr_ccadata_aes_256,
1338 &bin_attr_ccadata_aes_128_xts,
1339 &bin_attr_ccadata_aes_256_xts,
1343 static struct attribute_group ccadata_attr_group = {
1345 .bin_attrs = ccadata_attrs,
1348 #define CCACIPHERTOKENSIZE (sizeof(struct cipherkeytoken) + 80)
1351 * Sysfs attribute read function for all secure key ccacipher binary attributes.
1352 * The implementation can not deal with partial reads, because a new random
1353 * secure key blob is generated with each read. In case of partial reads
1354 * (i.e. off != 0 or count < key blob size) -EINVAL is returned.
1356 static ssize_t pkey_ccacipher_aes_attr_read(enum pkey_key_size keybits,
1357 bool is_xts, char *buf, loff_t off,
1363 if (off != 0 || count < CCACIPHERTOKENSIZE)
1366 if (count < 2 * CCACIPHERTOKENSIZE)
1369 keysize = CCACIPHERTOKENSIZE;
1370 rc = cca_gencipherkey(-1, -1, keybits, 0, buf, &keysize);
1373 memset(buf + keysize, 0, CCACIPHERTOKENSIZE - keysize);
1376 keysize = CCACIPHERTOKENSIZE;
1377 rc = cca_gencipherkey(-1, -1, keybits, 0,
1378 buf + CCACIPHERTOKENSIZE, &keysize);
1381 memset(buf + CCACIPHERTOKENSIZE + keysize, 0,
1382 CCACIPHERTOKENSIZE - keysize);
1384 return 2 * CCACIPHERTOKENSIZE;
1387 return CCACIPHERTOKENSIZE;
1390 static ssize_t ccacipher_aes_128_read(struct file *filp,
1391 struct kobject *kobj,
1392 struct bin_attribute *attr,
1393 char *buf, loff_t off,
1396 return pkey_ccacipher_aes_attr_read(PKEY_SIZE_AES_128, false, buf,
1400 static ssize_t ccacipher_aes_192_read(struct file *filp,
1401 struct kobject *kobj,
1402 struct bin_attribute *attr,
1403 char *buf, loff_t off,
1406 return pkey_ccacipher_aes_attr_read(PKEY_SIZE_AES_192, false, buf,
1410 static ssize_t ccacipher_aes_256_read(struct file *filp,
1411 struct kobject *kobj,
1412 struct bin_attribute *attr,
1413 char *buf, loff_t off,
1416 return pkey_ccacipher_aes_attr_read(PKEY_SIZE_AES_256, false, buf,
1420 static ssize_t ccacipher_aes_128_xts_read(struct file *filp,
1421 struct kobject *kobj,
1422 struct bin_attribute *attr,
1423 char *buf, loff_t off,
1426 return pkey_ccacipher_aes_attr_read(PKEY_SIZE_AES_128, true, buf,
1430 static ssize_t ccacipher_aes_256_xts_read(struct file *filp,
1431 struct kobject *kobj,
1432 struct bin_attribute *attr,
1433 char *buf, loff_t off,
1436 return pkey_ccacipher_aes_attr_read(PKEY_SIZE_AES_256, true, buf,
1440 static BIN_ATTR_RO(ccacipher_aes_128, CCACIPHERTOKENSIZE);
1441 static BIN_ATTR_RO(ccacipher_aes_192, CCACIPHERTOKENSIZE);
1442 static BIN_ATTR_RO(ccacipher_aes_256, CCACIPHERTOKENSIZE);
1443 static BIN_ATTR_RO(ccacipher_aes_128_xts, 2 * CCACIPHERTOKENSIZE);
1444 static BIN_ATTR_RO(ccacipher_aes_256_xts, 2 * CCACIPHERTOKENSIZE);
1446 static struct bin_attribute *ccacipher_attrs[] = {
1447 &bin_attr_ccacipher_aes_128,
1448 &bin_attr_ccacipher_aes_192,
1449 &bin_attr_ccacipher_aes_256,
1450 &bin_attr_ccacipher_aes_128_xts,
1451 &bin_attr_ccacipher_aes_256_xts,
1455 static struct attribute_group ccacipher_attr_group = {
1456 .name = "ccacipher",
1457 .bin_attrs = ccacipher_attrs,
1460 static const struct attribute_group *pkey_attr_groups[] = {
1461 &protkey_attr_group,
1462 &ccadata_attr_group,
1463 &ccacipher_attr_group,
1467 static const struct file_operations pkey_fops = {
1468 .owner = THIS_MODULE,
1469 .open = nonseekable_open,
1470 .llseek = no_llseek,
1471 .unlocked_ioctl = pkey_unlocked_ioctl,
1474 static struct miscdevice pkey_dev = {
1476 .minor = MISC_DYNAMIC_MINOR,
1479 .groups = pkey_attr_groups,
1485 static int __init pkey_init(void)
1487 cpacf_mask_t kmc_functions;
1490 * The pckmo instruction should be available - even if we don't
1491 * actually invoke it. This instruction comes with MSA 3 which
1492 * is also the minimum level for the kmc instructions which
1493 * are able to work with protected keys.
1495 if (!cpacf_query(CPACF_PCKMO, &pckmo_functions))
1498 /* check for kmc instructions available */
1499 if (!cpacf_query(CPACF_KMC, &kmc_functions))
1501 if (!cpacf_test_func(&kmc_functions, CPACF_KMC_PAES_128) ||
1502 !cpacf_test_func(&kmc_functions, CPACF_KMC_PAES_192) ||
1503 !cpacf_test_func(&kmc_functions, CPACF_KMC_PAES_256))
1508 return misc_register(&pkey_dev);
1514 static void __exit pkey_exit(void)
1516 misc_deregister(&pkey_dev);
1520 module_cpu_feature_match(MSA, pkey_init);
1521 module_exit(pkey_exit);