tpm-v2.c 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * Copyright (c) 2018 Bootlin
  4. * Author: Miquel Raynal <miquel.raynal@bootlin.com>
  5. */
  6. #include <common.h>
  7. #include <dm.h>
  8. #include <log.h>
  9. #include <mapmem.h>
  10. #include <tpm-common.h>
  11. #include <tpm-v2.h>
  12. #include "tpm-user-utils.h"
  13. static int do_tpm2_startup(cmd_tbl_t *cmdtp, int flag, int argc,
  14. char * const argv[])
  15. {
  16. enum tpm2_startup_types mode;
  17. struct udevice *dev;
  18. int ret;
  19. ret = get_tpm(&dev);
  20. if (ret)
  21. return ret;
  22. if (argc != 2)
  23. return CMD_RET_USAGE;
  24. if (!strcasecmp("TPM2_SU_CLEAR", argv[1])) {
  25. mode = TPM2_SU_CLEAR;
  26. } else if (!strcasecmp("TPM2_SU_STATE", argv[1])) {
  27. mode = TPM2_SU_STATE;
  28. } else {
  29. printf("Couldn't recognize mode string: %s\n", argv[1]);
  30. return CMD_RET_FAILURE;
  31. }
  32. return report_return_code(tpm2_startup(dev, mode));
  33. }
  34. static int do_tpm2_self_test(cmd_tbl_t *cmdtp, int flag, int argc,
  35. char * const argv[])
  36. {
  37. enum tpm2_yes_no full_test;
  38. struct udevice *dev;
  39. int ret;
  40. ret = get_tpm(&dev);
  41. if (ret)
  42. return ret;
  43. if (argc != 2)
  44. return CMD_RET_USAGE;
  45. if (!strcasecmp("full", argv[1])) {
  46. full_test = TPMI_YES;
  47. } else if (!strcasecmp("continue", argv[1])) {
  48. full_test = TPMI_NO;
  49. } else {
  50. printf("Couldn't recognize test mode: %s\n", argv[1]);
  51. return CMD_RET_FAILURE;
  52. }
  53. return report_return_code(tpm2_self_test(dev, full_test));
  54. }
  55. static int do_tpm2_clear(cmd_tbl_t *cmdtp, int flag, int argc,
  56. char * const argv[])
  57. {
  58. u32 handle = 0;
  59. const char *pw = (argc < 3) ? NULL : argv[2];
  60. const ssize_t pw_sz = pw ? strlen(pw) : 0;
  61. struct udevice *dev;
  62. int ret;
  63. ret = get_tpm(&dev);
  64. if (ret)
  65. return ret;
  66. if (argc < 2 || argc > 3)
  67. return CMD_RET_USAGE;
  68. if (pw_sz > TPM2_DIGEST_LEN)
  69. return -EINVAL;
  70. if (!strcasecmp("TPM2_RH_LOCKOUT", argv[1]))
  71. handle = TPM2_RH_LOCKOUT;
  72. else if (!strcasecmp("TPM2_RH_PLATFORM", argv[1]))
  73. handle = TPM2_RH_PLATFORM;
  74. else
  75. return CMD_RET_USAGE;
  76. return report_return_code(tpm2_clear(dev, handle, pw, pw_sz));
  77. }
  78. static int do_tpm2_pcr_extend(cmd_tbl_t *cmdtp, int flag, int argc,
  79. char * const argv[])
  80. {
  81. struct udevice *dev;
  82. struct tpm_chip_priv *priv;
  83. u32 index = simple_strtoul(argv[1], NULL, 0);
  84. void *digest = map_sysmem(simple_strtoul(argv[2], NULL, 0), 0);
  85. int ret;
  86. u32 rc;
  87. if (argc != 3)
  88. return CMD_RET_USAGE;
  89. ret = get_tpm(&dev);
  90. if (ret)
  91. return ret;
  92. priv = dev_get_uclass_priv(dev);
  93. if (!priv)
  94. return -EINVAL;
  95. if (index >= priv->pcr_count)
  96. return -EINVAL;
  97. rc = tpm2_pcr_extend(dev, index, digest);
  98. unmap_sysmem(digest);
  99. return report_return_code(rc);
  100. }
  101. static int do_tpm_pcr_read(cmd_tbl_t *cmdtp, int flag, int argc,
  102. char * const argv[])
  103. {
  104. struct udevice *dev;
  105. struct tpm_chip_priv *priv;
  106. u32 index, rc;
  107. unsigned int updates;
  108. void *data;
  109. int ret;
  110. if (argc != 3)
  111. return CMD_RET_USAGE;
  112. ret = get_tpm(&dev);
  113. if (ret)
  114. return ret;
  115. priv = dev_get_uclass_priv(dev);
  116. if (!priv)
  117. return -EINVAL;
  118. index = simple_strtoul(argv[1], NULL, 0);
  119. if (index >= priv->pcr_count)
  120. return -EINVAL;
  121. data = map_sysmem(simple_strtoul(argv[2], NULL, 0), 0);
  122. rc = tpm2_pcr_read(dev, index, priv->pcr_select_min, data, &updates);
  123. if (!rc) {
  124. printf("PCR #%u content (%u known updates):\n", index, updates);
  125. print_byte_string(data, TPM2_DIGEST_LEN);
  126. }
  127. unmap_sysmem(data);
  128. return report_return_code(rc);
  129. }
  130. static int do_tpm_get_capability(cmd_tbl_t *cmdtp, int flag, int argc,
  131. char * const argv[])
  132. {
  133. u32 capability, property, rc;
  134. u8 *data;
  135. size_t count;
  136. int i, j;
  137. struct udevice *dev;
  138. int ret;
  139. ret = get_tpm(&dev);
  140. if (ret)
  141. return ret;
  142. if (argc != 5)
  143. return CMD_RET_USAGE;
  144. capability = simple_strtoul(argv[1], NULL, 0);
  145. property = simple_strtoul(argv[2], NULL, 0);
  146. data = map_sysmem(simple_strtoul(argv[3], NULL, 0), 0);
  147. count = simple_strtoul(argv[4], NULL, 0);
  148. rc = tpm2_get_capability(dev, capability, property, data, count);
  149. if (rc)
  150. goto unmap_data;
  151. printf("Capabilities read from TPM:\n");
  152. for (i = 0; i < count; i++) {
  153. printf("Property 0x");
  154. for (j = 0; j < 4; j++)
  155. printf("%02x", data[(i * 8) + j]);
  156. printf(": 0x");
  157. for (j = 4; j < 8; j++)
  158. printf("%02x", data[(i * 8) + j]);
  159. printf("\n");
  160. }
  161. unmap_data:
  162. unmap_sysmem(data);
  163. return report_return_code(rc);
  164. }
  165. static int do_tpm_dam_reset(cmd_tbl_t *cmdtp, int flag, int argc,
  166. char *const argv[])
  167. {
  168. const char *pw = (argc < 2) ? NULL : argv[1];
  169. const ssize_t pw_sz = pw ? strlen(pw) : 0;
  170. struct udevice *dev;
  171. int ret;
  172. ret = get_tpm(&dev);
  173. if (ret)
  174. return ret;
  175. if (argc > 2)
  176. return CMD_RET_USAGE;
  177. if (pw_sz > TPM2_DIGEST_LEN)
  178. return -EINVAL;
  179. return report_return_code(tpm2_dam_reset(dev, pw, pw_sz));
  180. }
  181. static int do_tpm_dam_parameters(cmd_tbl_t *cmdtp, int flag, int argc,
  182. char *const argv[])
  183. {
  184. const char *pw = (argc < 5) ? NULL : argv[4];
  185. const ssize_t pw_sz = pw ? strlen(pw) : 0;
  186. /*
  187. * No Dictionary Attack Mitigation (DAM) means:
  188. * maxtries = 0xFFFFFFFF, recovery_time = 1, lockout_recovery = 0
  189. */
  190. unsigned long int max_tries;
  191. unsigned long int recovery_time;
  192. unsigned long int lockout_recovery;
  193. struct udevice *dev;
  194. int ret;
  195. ret = get_tpm(&dev);
  196. if (ret)
  197. return ret;
  198. if (argc < 4 || argc > 5)
  199. return CMD_RET_USAGE;
  200. if (pw_sz > TPM2_DIGEST_LEN)
  201. return -EINVAL;
  202. if (strict_strtoul(argv[1], 0, &max_tries))
  203. return CMD_RET_USAGE;
  204. if (strict_strtoul(argv[2], 0, &recovery_time))
  205. return CMD_RET_USAGE;
  206. if (strict_strtoul(argv[3], 0, &lockout_recovery))
  207. return CMD_RET_USAGE;
  208. log(LOGC_NONE, LOGL_INFO, "Changing dictionary attack parameters:\n");
  209. log(LOGC_NONE, LOGL_INFO, "- maxTries: %lu", max_tries);
  210. log(LOGC_NONE, LOGL_INFO, "- recoveryTime: %lu\n", recovery_time);
  211. log(LOGC_NONE, LOGL_INFO, "- lockoutRecovery: %lu\n", lockout_recovery);
  212. return report_return_code(tpm2_dam_parameters(dev, pw, pw_sz, max_tries,
  213. recovery_time,
  214. lockout_recovery));
  215. }
  216. static int do_tpm_change_auth(cmd_tbl_t *cmdtp, int flag, int argc,
  217. char *const argv[])
  218. {
  219. u32 handle;
  220. const char *newpw = argv[2];
  221. const char *oldpw = (argc == 3) ? NULL : argv[3];
  222. const ssize_t newpw_sz = strlen(newpw);
  223. const ssize_t oldpw_sz = oldpw ? strlen(oldpw) : 0;
  224. struct udevice *dev;
  225. int ret;
  226. ret = get_tpm(&dev);
  227. if (ret)
  228. return ret;
  229. if (argc < 3 || argc > 4)
  230. return CMD_RET_USAGE;
  231. if (newpw_sz > TPM2_DIGEST_LEN || oldpw_sz > TPM2_DIGEST_LEN)
  232. return -EINVAL;
  233. if (!strcasecmp("TPM2_RH_LOCKOUT", argv[1]))
  234. handle = TPM2_RH_LOCKOUT;
  235. else if (!strcasecmp("TPM2_RH_ENDORSEMENT", argv[1]))
  236. handle = TPM2_RH_ENDORSEMENT;
  237. else if (!strcasecmp("TPM2_RH_OWNER", argv[1]))
  238. handle = TPM2_RH_OWNER;
  239. else if (!strcasecmp("TPM2_RH_PLATFORM", argv[1]))
  240. handle = TPM2_RH_PLATFORM;
  241. else
  242. return CMD_RET_USAGE;
  243. return report_return_code(tpm2_change_auth(dev, handle, newpw, newpw_sz,
  244. oldpw, oldpw_sz));
  245. }
  246. static int do_tpm_pcr_setauthpolicy(cmd_tbl_t *cmdtp, int flag, int argc,
  247. char * const argv[])
  248. {
  249. u32 index = simple_strtoul(argv[1], NULL, 0);
  250. char *key = argv[2];
  251. const char *pw = (argc < 4) ? NULL : argv[3];
  252. const ssize_t pw_sz = pw ? strlen(pw) : 0;
  253. struct udevice *dev;
  254. int ret;
  255. ret = get_tpm(&dev);
  256. if (ret)
  257. return ret;
  258. if (strlen(key) != TPM2_DIGEST_LEN)
  259. return -EINVAL;
  260. if (argc < 3 || argc > 4)
  261. return CMD_RET_USAGE;
  262. return report_return_code(tpm2_pcr_setauthpolicy(dev, pw, pw_sz, index,
  263. key));
  264. }
  265. static int do_tpm_pcr_setauthvalue(cmd_tbl_t *cmdtp, int flag,
  266. int argc, char * const argv[])
  267. {
  268. u32 index = simple_strtoul(argv[1], NULL, 0);
  269. char *key = argv[2];
  270. const ssize_t key_sz = strlen(key);
  271. const char *pw = (argc < 4) ? NULL : argv[3];
  272. const ssize_t pw_sz = pw ? strlen(pw) : 0;
  273. struct udevice *dev;
  274. int ret;
  275. ret = get_tpm(&dev);
  276. if (ret)
  277. return ret;
  278. if (strlen(key) != TPM2_DIGEST_LEN)
  279. return -EINVAL;
  280. if (argc < 3 || argc > 4)
  281. return CMD_RET_USAGE;
  282. return report_return_code(tpm2_pcr_setauthvalue(dev, pw, pw_sz, index,
  283. key, key_sz));
  284. }
  285. static cmd_tbl_t tpm2_commands[] = {
  286. U_BOOT_CMD_MKENT(info, 0, 1, do_tpm_info, "", ""),
  287. U_BOOT_CMD_MKENT(init, 0, 1, do_tpm_init, "", ""),
  288. U_BOOT_CMD_MKENT(startup, 0, 1, do_tpm2_startup, "", ""),
  289. U_BOOT_CMD_MKENT(self_test, 0, 1, do_tpm2_self_test, "", ""),
  290. U_BOOT_CMD_MKENT(clear, 0, 1, do_tpm2_clear, "", ""),
  291. U_BOOT_CMD_MKENT(pcr_extend, 0, 1, do_tpm2_pcr_extend, "", ""),
  292. U_BOOT_CMD_MKENT(pcr_read, 0, 1, do_tpm_pcr_read, "", ""),
  293. U_BOOT_CMD_MKENT(get_capability, 0, 1, do_tpm_get_capability, "", ""),
  294. U_BOOT_CMD_MKENT(dam_reset, 0, 1, do_tpm_dam_reset, "", ""),
  295. U_BOOT_CMD_MKENT(dam_parameters, 0, 1, do_tpm_dam_parameters, "", ""),
  296. U_BOOT_CMD_MKENT(change_auth, 0, 1, do_tpm_change_auth, "", ""),
  297. U_BOOT_CMD_MKENT(pcr_setauthpolicy, 0, 1,
  298. do_tpm_pcr_setauthpolicy, "", ""),
  299. U_BOOT_CMD_MKENT(pcr_setauthvalue, 0, 1,
  300. do_tpm_pcr_setauthvalue, "", ""),
  301. };
  302. cmd_tbl_t *get_tpm2_commands(unsigned int *size)
  303. {
  304. *size = ARRAY_SIZE(tpm2_commands);
  305. return tpm2_commands;
  306. }
  307. U_BOOT_CMD(tpm2, CONFIG_SYS_MAXARGS, 1, do_tpm, "Issue a TPMv2.x command",
  308. "<command> [<arguments>]\n"
  309. "\n"
  310. "info\n"
  311. " Show information about the TPM.\n"
  312. "init\n"
  313. " Initialize the software stack. Always the first command to issue.\n"
  314. "startup <mode>\n"
  315. " Issue a TPM2_Startup command.\n"
  316. " <mode> is one of:\n"
  317. " * TPM2_SU_CLEAR (reset state)\n"
  318. " * TPM2_SU_STATE (preserved state)\n"
  319. "self_test <type>\n"
  320. " Test the TPM capabilities.\n"
  321. " <type> is one of:\n"
  322. " * full (perform all tests)\n"
  323. " * continue (only check untested tests)\n"
  324. "clear <hierarchy>\n"
  325. " Issue a TPM2_Clear command.\n"
  326. " <hierarchy> is one of:\n"
  327. " * TPM2_RH_LOCKOUT\n"
  328. " * TPM2_RH_PLATFORM\n"
  329. "pcr_extend <pcr> <digest_addr>\n"
  330. " Extend PCR #<pcr> with digest at <digest_addr>.\n"
  331. " <pcr>: index of the PCR\n"
  332. " <digest_addr>: address of a 32-byte SHA256 digest\n"
  333. "pcr_read <pcr> <digest_addr>\n"
  334. " Read PCR #<pcr> to memory address <digest_addr>.\n"
  335. " <pcr>: index of the PCR\n"
  336. " <digest_addr>: address to store the a 32-byte SHA256 digest\n"
  337. "get_capability <capability> <property> <addr> <count>\n"
  338. " Read and display <count> entries indexed by <capability>/<property>.\n"
  339. " Values are 4 bytes long and are written at <addr>.\n"
  340. " <capability>: capability\n"
  341. " <property>: property\n"
  342. " <addr>: address to store <count> entries of 4 bytes\n"
  343. " <count>: number of entries to retrieve\n"
  344. "dam_reset [<password>]\n"
  345. " If the TPM is not in a LOCKOUT state, reset the internal error counter.\n"
  346. " <password>: optional password\n"
  347. "dam_parameters <max_tries> <recovery_time> <lockout_recovery> [<password>]\n"
  348. " If the TPM is not in a LOCKOUT state, set the DAM parameters\n"
  349. " <maxTries>: maximum number of failures before lockout,\n"
  350. " 0 means always locking\n"
  351. " <recoveryTime>: time before decrement of the error counter,\n"
  352. " 0 means no lockout\n"
  353. " <lockoutRecovery>: time of a lockout (before the next try),\n"
  354. " 0 means a reboot is needed\n"
  355. " <password>: optional password of the LOCKOUT hierarchy\n"
  356. "change_auth <hierarchy> <new_pw> [<old_pw>]\n"
  357. " <hierarchy>: the hierarchy\n"
  358. " <new_pw>: new password for <hierarchy>\n"
  359. " <old_pw>: optional previous password of <hierarchy>\n"
  360. "pcr_setauthpolicy|pcr_setauthvalue <pcr> <key> [<password>]\n"
  361. " Change the <key> to access PCR #<pcr>.\n"
  362. " hierarchy and may be empty.\n"
  363. " /!\\WARNING: untested function, use at your own risks !\n"
  364. " <pcr>: index of the PCR\n"
  365. " <key>: secret to protect the access of PCR #<pcr>\n"
  366. " <password>: optional password of the PLATFORM hierarchy\n"
  367. );