plpks.c 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * POWER LPAR Platform KeyStore(PLPKS)
  4. * Copyright (C) 2022 IBM Corporation
  5. * Author: Nayna Jain <[email protected]>
  6. *
  7. * Provides access to variables stored in Power LPAR Platform KeyStore(PLPKS).
  8. */
  9. #define pr_fmt(fmt) "plpks: " fmt
  10. #include <linux/delay.h>
  11. #include <linux/errno.h>
  12. #include <linux/io.h>
  13. #include <linux/printk.h>
  14. #include <linux/slab.h>
  15. #include <linux/string.h>
  16. #include <linux/types.h>
  17. #include <asm/hvcall.h>
  18. #include <asm/machdep.h>
  19. #include "plpks.h"
  20. #define PKS_FW_OWNER 0x1
  21. #define PKS_BOOTLOADER_OWNER 0x2
  22. #define PKS_OS_OWNER 0x3
  23. #define LABEL_VERSION 0
  24. #define MAX_LABEL_ATTR_SIZE 16
  25. #define MAX_NAME_SIZE 239
  26. #define MAX_DATA_SIZE 4000
  27. #define PKS_FLUSH_MAX_TIMEOUT 5000 //msec
  28. #define PKS_FLUSH_SLEEP 10 //msec
  29. #define PKS_FLUSH_SLEEP_RANGE 400
  30. static u8 *ospassword;
  31. static u16 ospasswordlength;
  32. // Retrieved with H_PKS_GET_CONFIG
  33. static u16 maxpwsize;
  34. static u16 maxobjsize;
  35. struct plpks_auth {
  36. u8 version;
  37. u8 consumer;
  38. __be64 rsvd0;
  39. __be32 rsvd1;
  40. __be16 passwordlength;
  41. u8 password[];
  42. } __packed __aligned(16);
  43. struct label_attr {
  44. u8 prefix[8];
  45. u8 version;
  46. u8 os;
  47. u8 length;
  48. u8 reserved[5];
  49. };
  50. struct label {
  51. struct label_attr attr;
  52. u8 name[MAX_NAME_SIZE];
  53. size_t size;
  54. };
  55. static int pseries_status_to_err(int rc)
  56. {
  57. int err;
  58. switch (rc) {
  59. case H_SUCCESS:
  60. err = 0;
  61. break;
  62. case H_FUNCTION:
  63. err = -ENXIO;
  64. break;
  65. case H_PARAMETER:
  66. case H_P2:
  67. case H_P3:
  68. case H_P4:
  69. case H_P5:
  70. case H_P6:
  71. err = -EINVAL;
  72. break;
  73. case H_NOT_FOUND:
  74. err = -ENOENT;
  75. break;
  76. case H_BUSY:
  77. err = -EBUSY;
  78. break;
  79. case H_AUTHORITY:
  80. err = -EPERM;
  81. break;
  82. case H_NO_MEM:
  83. err = -ENOMEM;
  84. break;
  85. case H_RESOURCE:
  86. err = -EEXIST;
  87. break;
  88. case H_TOO_BIG:
  89. err = -EFBIG;
  90. break;
  91. case H_STATE:
  92. err = -EIO;
  93. break;
  94. case H_R_STATE:
  95. err = -EIO;
  96. break;
  97. case H_IN_USE:
  98. err = -EEXIST;
  99. break;
  100. case H_ABORTED:
  101. err = -EIO;
  102. break;
  103. default:
  104. err = -EINVAL;
  105. }
  106. return err;
  107. }
  108. static int plpks_gen_password(void)
  109. {
  110. unsigned long retbuf[PLPAR_HCALL_BUFSIZE] = { 0 };
  111. u8 *password, consumer = PKS_OS_OWNER;
  112. int rc;
  113. password = kzalloc(maxpwsize, GFP_KERNEL);
  114. if (!password)
  115. return -ENOMEM;
  116. rc = plpar_hcall(H_PKS_GEN_PASSWORD, retbuf, consumer, 0,
  117. virt_to_phys(password), maxpwsize);
  118. if (!rc) {
  119. ospasswordlength = maxpwsize;
  120. ospassword = kzalloc(maxpwsize, GFP_KERNEL);
  121. if (!ospassword) {
  122. kfree(password);
  123. return -ENOMEM;
  124. }
  125. memcpy(ospassword, password, ospasswordlength);
  126. } else {
  127. if (rc == H_IN_USE) {
  128. pr_warn("Password is already set for POWER LPAR Platform KeyStore\n");
  129. rc = 0;
  130. } else {
  131. goto out;
  132. }
  133. }
  134. out:
  135. kfree(password);
  136. return pseries_status_to_err(rc);
  137. }
  138. static struct plpks_auth *construct_auth(u8 consumer)
  139. {
  140. struct plpks_auth *auth;
  141. if (consumer > PKS_OS_OWNER)
  142. return ERR_PTR(-EINVAL);
  143. auth = kmalloc(struct_size(auth, password, maxpwsize), GFP_KERNEL);
  144. if (!auth)
  145. return ERR_PTR(-ENOMEM);
  146. auth->version = 1;
  147. auth->consumer = consumer;
  148. auth->rsvd0 = 0;
  149. auth->rsvd1 = 0;
  150. if (consumer == PKS_FW_OWNER || consumer == PKS_BOOTLOADER_OWNER) {
  151. auth->passwordlength = 0;
  152. return auth;
  153. }
  154. memcpy(auth->password, ospassword, ospasswordlength);
  155. auth->passwordlength = cpu_to_be16(ospasswordlength);
  156. return auth;
  157. }
  158. /**
  159. * Label is combination of label attributes + name.
  160. * Label attributes are used internally by kernel and not exposed to the user.
  161. */
  162. static struct label *construct_label(char *component, u8 varos, u8 *name,
  163. u16 namelen)
  164. {
  165. struct label *label;
  166. size_t slen;
  167. if (!name || namelen > MAX_NAME_SIZE)
  168. return ERR_PTR(-EINVAL);
  169. slen = strlen(component);
  170. if (component && slen > sizeof(label->attr.prefix))
  171. return ERR_PTR(-EINVAL);
  172. label = kzalloc(sizeof(*label), GFP_KERNEL);
  173. if (!label)
  174. return ERR_PTR(-ENOMEM);
  175. if (component)
  176. memcpy(&label->attr.prefix, component, slen);
  177. label->attr.version = LABEL_VERSION;
  178. label->attr.os = varos;
  179. label->attr.length = MAX_LABEL_ATTR_SIZE;
  180. memcpy(&label->name, name, namelen);
  181. label->size = sizeof(struct label_attr) + namelen;
  182. return label;
  183. }
  184. static int _plpks_get_config(void)
  185. {
  186. unsigned long retbuf[PLPAR_HCALL_BUFSIZE] = { 0 };
  187. struct {
  188. u8 version;
  189. u8 flags;
  190. __be32 rsvd0;
  191. __be16 maxpwsize;
  192. __be16 maxobjlabelsize;
  193. __be16 maxobjsize;
  194. __be32 totalsize;
  195. __be32 usedspace;
  196. __be32 supportedpolicies;
  197. __be64 rsvd1;
  198. } __packed config;
  199. size_t size;
  200. int rc;
  201. size = sizeof(config);
  202. rc = plpar_hcall(H_PKS_GET_CONFIG, retbuf, virt_to_phys(&config), size);
  203. if (rc != H_SUCCESS)
  204. return pseries_status_to_err(rc);
  205. maxpwsize = be16_to_cpu(config.maxpwsize);
  206. maxobjsize = be16_to_cpu(config.maxobjsize);
  207. return 0;
  208. }
  209. static int plpks_confirm_object_flushed(struct label *label,
  210. struct plpks_auth *auth)
  211. {
  212. unsigned long retbuf[PLPAR_HCALL_BUFSIZE] = { 0 };
  213. u64 timeout = 0;
  214. u8 status;
  215. int rc;
  216. do {
  217. rc = plpar_hcall(H_PKS_CONFIRM_OBJECT_FLUSHED, retbuf,
  218. virt_to_phys(auth), virt_to_phys(label),
  219. label->size);
  220. status = retbuf[0];
  221. if (rc) {
  222. if (rc == H_NOT_FOUND && status == 1)
  223. rc = 0;
  224. break;
  225. }
  226. if (!rc && status == 1)
  227. break;
  228. usleep_range(PKS_FLUSH_SLEEP,
  229. PKS_FLUSH_SLEEP + PKS_FLUSH_SLEEP_RANGE);
  230. timeout = timeout + PKS_FLUSH_SLEEP;
  231. } while (timeout < PKS_FLUSH_MAX_TIMEOUT);
  232. rc = pseries_status_to_err(rc);
  233. return rc;
  234. }
  235. int plpks_write_var(struct plpks_var var)
  236. {
  237. unsigned long retbuf[PLPAR_HCALL_BUFSIZE] = { 0 };
  238. struct plpks_auth *auth;
  239. struct label *label;
  240. int rc;
  241. if (!var.component || !var.data || var.datalen <= 0 ||
  242. var.namelen > MAX_NAME_SIZE || var.datalen > MAX_DATA_SIZE)
  243. return -EINVAL;
  244. if (var.policy & SIGNEDUPDATE)
  245. return -EINVAL;
  246. auth = construct_auth(PKS_OS_OWNER);
  247. if (IS_ERR(auth))
  248. return PTR_ERR(auth);
  249. label = construct_label(var.component, var.os, var.name, var.namelen);
  250. if (IS_ERR(label)) {
  251. rc = PTR_ERR(label);
  252. goto out;
  253. }
  254. rc = plpar_hcall(H_PKS_WRITE_OBJECT, retbuf, virt_to_phys(auth),
  255. virt_to_phys(label), label->size, var.policy,
  256. virt_to_phys(var.data), var.datalen);
  257. if (!rc)
  258. rc = plpks_confirm_object_flushed(label, auth);
  259. if (rc)
  260. pr_err("Failed to write variable %s for component %s with error %d\n",
  261. var.name, var.component, rc);
  262. rc = pseries_status_to_err(rc);
  263. kfree(label);
  264. out:
  265. kfree(auth);
  266. return rc;
  267. }
  268. int plpks_remove_var(char *component, u8 varos, struct plpks_var_name vname)
  269. {
  270. unsigned long retbuf[PLPAR_HCALL_BUFSIZE] = { 0 };
  271. struct plpks_auth *auth;
  272. struct label *label;
  273. int rc;
  274. if (!component || vname.namelen > MAX_NAME_SIZE)
  275. return -EINVAL;
  276. auth = construct_auth(PKS_OS_OWNER);
  277. if (IS_ERR(auth))
  278. return PTR_ERR(auth);
  279. label = construct_label(component, varos, vname.name, vname.namelen);
  280. if (IS_ERR(label)) {
  281. rc = PTR_ERR(label);
  282. goto out;
  283. }
  284. rc = plpar_hcall(H_PKS_REMOVE_OBJECT, retbuf, virt_to_phys(auth),
  285. virt_to_phys(label), label->size);
  286. if (!rc)
  287. rc = plpks_confirm_object_flushed(label, auth);
  288. if (rc)
  289. pr_err("Failed to remove variable %s for component %s with error %d\n",
  290. vname.name, component, rc);
  291. rc = pseries_status_to_err(rc);
  292. kfree(label);
  293. out:
  294. kfree(auth);
  295. return rc;
  296. }
  297. static int plpks_read_var(u8 consumer, struct plpks_var *var)
  298. {
  299. unsigned long retbuf[PLPAR_HCALL_BUFSIZE] = { 0 };
  300. struct plpks_auth *auth;
  301. struct label *label = NULL;
  302. u8 *output;
  303. int rc;
  304. if (var->namelen > MAX_NAME_SIZE)
  305. return -EINVAL;
  306. auth = construct_auth(consumer);
  307. if (IS_ERR(auth))
  308. return PTR_ERR(auth);
  309. if (consumer == PKS_OS_OWNER) {
  310. label = construct_label(var->component, var->os, var->name,
  311. var->namelen);
  312. if (IS_ERR(label)) {
  313. rc = PTR_ERR(label);
  314. goto out_free_auth;
  315. }
  316. }
  317. output = kzalloc(maxobjsize, GFP_KERNEL);
  318. if (!output) {
  319. rc = -ENOMEM;
  320. goto out_free_label;
  321. }
  322. if (consumer == PKS_OS_OWNER)
  323. rc = plpar_hcall(H_PKS_READ_OBJECT, retbuf, virt_to_phys(auth),
  324. virt_to_phys(label), label->size, virt_to_phys(output),
  325. maxobjsize);
  326. else
  327. rc = plpar_hcall(H_PKS_READ_OBJECT, retbuf, virt_to_phys(auth),
  328. virt_to_phys(var->name), var->namelen, virt_to_phys(output),
  329. maxobjsize);
  330. if (rc != H_SUCCESS) {
  331. pr_err("Failed to read variable %s for component %s with error %d\n",
  332. var->name, var->component, rc);
  333. rc = pseries_status_to_err(rc);
  334. goto out_free_output;
  335. }
  336. if (var->datalen == 0 || var->datalen > retbuf[0])
  337. var->datalen = retbuf[0];
  338. var->data = kzalloc(var->datalen, GFP_KERNEL);
  339. if (!var->data) {
  340. rc = -ENOMEM;
  341. goto out_free_output;
  342. }
  343. var->policy = retbuf[1];
  344. memcpy(var->data, output, var->datalen);
  345. rc = 0;
  346. out_free_output:
  347. kfree(output);
  348. out_free_label:
  349. kfree(label);
  350. out_free_auth:
  351. kfree(auth);
  352. return rc;
  353. }
  354. int plpks_read_os_var(struct plpks_var *var)
  355. {
  356. return plpks_read_var(PKS_OS_OWNER, var);
  357. }
  358. int plpks_read_fw_var(struct plpks_var *var)
  359. {
  360. return plpks_read_var(PKS_FW_OWNER, var);
  361. }
  362. int plpks_read_bootloader_var(struct plpks_var *var)
  363. {
  364. return plpks_read_var(PKS_BOOTLOADER_OWNER, var);
  365. }
  366. static __init int pseries_plpks_init(void)
  367. {
  368. int rc;
  369. rc = _plpks_get_config();
  370. if (rc) {
  371. pr_err("POWER LPAR Platform KeyStore is not supported or enabled\n");
  372. return rc;
  373. }
  374. rc = plpks_gen_password();
  375. if (rc)
  376. pr_err("Failed setting POWER LPAR Platform KeyStore Password\n");
  377. else
  378. pr_info("POWER LPAR Platform KeyStore initialized successfully\n");
  379. return rc;
  380. }
  381. machine_arch_initcall(pseries, pseries_plpks_init);