1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2013 The Chromium OS Authors.
10 #include <asm/unaligned.h>
11 #include <tpm-common.h>
13 #include "tpm-user-utils.h"
16 static int do_tpm_startup(struct cmd_tbl *cmdtp, int flag, int argc,
19 enum tpm_startup_type mode;
28 if (!strcasecmp("TPM_ST_CLEAR", argv[1])) {
30 } else if (!strcasecmp("TPM_ST_STATE", argv[1])) {
32 } else if (!strcasecmp("TPM_ST_DEACTIVATED", argv[1])) {
33 mode = TPM_ST_DEACTIVATED;
35 printf("Couldn't recognize mode string: %s\n", argv[1]);
36 return CMD_RET_FAILURE;
39 return report_return_code(tpm_startup(dev, mode));
42 static int do_tpm_nv_define_space(struct cmd_tbl *cmdtp, int flag, int argc,
45 u32 index, perm, size;
55 index = simple_strtoul(argv[1], NULL, 0);
56 perm = simple_strtoul(argv[2], NULL, 0);
57 size = simple_strtoul(argv[3], NULL, 0);
59 return report_return_code(tpm1_nv_define_space(dev, index, perm, size));
62 static int do_tpm_nv_read_value(struct cmd_tbl *cmdtp, int flag, int argc,
75 index = simple_strtoul(argv[1], NULL, 0);
76 data = (void *)simple_strtoul(argv[2], NULL, 0);
77 count = simple_strtoul(argv[3], NULL, 0);
79 rc = tpm_nv_read_value(dev, index, data, count);
81 puts("area content:\n");
82 print_byte_string(data, count);
85 return report_return_code(rc);
88 static int do_tpm_nv_write_value(struct cmd_tbl *cmdtp, int flag, int argc,
101 return CMD_RET_USAGE;
102 index = simple_strtoul(argv[1], NULL, 0);
103 data = parse_byte_string(argv[2], NULL, &count);
105 printf("Couldn't parse byte string %s\n", argv[2]);
106 return CMD_RET_FAILURE;
109 rc = tpm_nv_write_value(dev, index, data, count);
112 return report_return_code(rc);
115 static int do_tpm_extend(struct cmd_tbl *cmdtp, int flag, int argc,
118 u8 in_digest[20], out_digest[20];
127 return CMD_RET_USAGE;
128 index = simple_strtoul(argv[1], NULL, 0);
129 if (!parse_byte_string(argv[2], in_digest, NULL)) {
130 printf("Couldn't parse byte string %s\n", argv[2]);
131 return CMD_RET_FAILURE;
134 rc = tpm_pcr_extend(dev, index, in_digest, out_digest);
136 puts("PCR value after execution of the command:\n");
137 print_byte_string(out_digest, sizeof(out_digest));
140 return report_return_code(rc);
143 static int do_tpm_pcr_read(struct cmd_tbl *cmdtp, int flag, int argc,
146 u32 index, count, rc;
155 return CMD_RET_USAGE;
156 index = simple_strtoul(argv[1], NULL, 0);
157 data = (void *)simple_strtoul(argv[2], NULL, 0);
158 count = simple_strtoul(argv[3], NULL, 0);
160 rc = tpm_pcr_read(dev, index, data, count);
162 puts("Named PCR content:\n");
163 print_byte_string(data, count);
166 return report_return_code(rc);
169 static int do_tpm_tsc_physical_presence(struct cmd_tbl *cmdtp, int flag,
170 int argc, char *const argv[])
181 return CMD_RET_USAGE;
182 presence = (u16)simple_strtoul(argv[1], NULL, 0);
184 return report_return_code(tpm_tsc_physical_presence(dev, presence));
187 static int do_tpm_read_pubek(struct cmd_tbl *cmdtp, int flag, int argc,
199 return CMD_RET_USAGE;
200 data = (void *)simple_strtoul(argv[1], NULL, 0);
201 count = simple_strtoul(argv[2], NULL, 0);
203 rc = tpm_read_pubek(dev, data, count);
205 puts("pubek value:\n");
206 print_byte_string(data, count);
209 return report_return_code(rc);
212 static int do_tpm_physical_set_deactivated(struct cmd_tbl *cmdtp, int flag,
213 int argc, char *const argv[])
224 return CMD_RET_USAGE;
225 state = (u8)simple_strtoul(argv[1], NULL, 0);
227 return report_return_code(tpm_physical_set_deactivated(dev, state));
230 static int do_tpm_get_capability(struct cmd_tbl *cmdtp, int flag, int argc,
233 u32 cap_area, sub_cap, rc;
243 return CMD_RET_USAGE;
244 cap_area = simple_strtoul(argv[1], NULL, 0);
245 sub_cap = simple_strtoul(argv[2], NULL, 0);
246 cap = (void *)simple_strtoul(argv[3], NULL, 0);
247 count = simple_strtoul(argv[4], NULL, 0);
249 rc = tpm_get_capability(dev, cap_area, sub_cap, cap, count);
251 puts("capability information:\n");
252 print_byte_string(cap, count);
255 return report_return_code(rc);
258 static int do_tpm_raw_transfer(struct cmd_tbl *cmdtp, int flag, int argc,
264 size_t count, response_length = sizeof(response);
267 command = parse_byte_string(argv[1], NULL, &count);
269 printf("Couldn't parse byte string %s\n", argv[1]);
270 return CMD_RET_FAILURE;
277 rc = tpm_xfer(dev, command, count, response, &response_length);
280 puts("tpm response:\n");
281 print_byte_string(response, response_length);
284 return report_return_code(rc);
287 static int do_tpm_nv_define(struct cmd_tbl *cmdtp, int flag, int argc,
290 u32 index, perm, size;
299 return CMD_RET_USAGE;
300 size = type_string_get_space_size(argv[1]);
302 printf("Couldn't parse arguments\n");
303 return CMD_RET_USAGE;
305 index = simple_strtoul(argv[2], NULL, 0);
306 perm = simple_strtoul(argv[3], NULL, 0);
308 return report_return_code(tpm1_nv_define_space(dev, index, perm, size));
311 static int do_tpm_nv_read(struct cmd_tbl *cmdtp, int flag, int argc,
314 u32 index, count, err;
324 return CMD_RET_USAGE;
325 if (argc != 3 + type_string_get_num_values(argv[1]))
326 return CMD_RET_USAGE;
327 index = simple_strtoul(argv[2], NULL, 0);
328 data = type_string_alloc(argv[1], &count);
330 printf("Couldn't parse arguments\n");
331 return CMD_RET_USAGE;
334 err = tpm_nv_read_value(dev, index, data, count);
336 if (type_string_write_vars(argv[1], data, argv + 3)) {
337 printf("Couldn't write to variables\n");
343 return report_return_code(err);
346 static int do_tpm_nv_write(struct cmd_tbl *cmdtp, int flag, int argc,
349 u32 index, count, err;
359 return CMD_RET_USAGE;
360 if (argc != 3 + type_string_get_num_values(argv[1]))
361 return CMD_RET_USAGE;
362 index = simple_strtoul(argv[2], NULL, 0);
363 data = type_string_alloc(argv[1], &count);
365 printf("Couldn't parse arguments\n");
366 return CMD_RET_USAGE;
368 if (type_string_pack(argv[1], argv + 3, data)) {
369 printf("Couldn't parse arguments\n");
371 return CMD_RET_USAGE;
374 err = tpm_nv_write_value(dev, index, data, count);
377 return report_return_code(err);
380 #ifdef CONFIG_TPM_AUTH_SESSIONS
382 static int do_tpm_oiap(struct cmd_tbl *cmdtp, int flag, int argc,
385 u32 auth_handle, err;
393 err = tpm1_oiap(dev, &auth_handle);
395 return report_return_code(err);
398 #ifdef CONFIG_TPM_LOAD_KEY_BY_SHA1
399 static int do_tpm_load_key_by_sha1(struct cmd_tbl *cmdtp, int flag, int argc,
402 u32 parent_handle = 0;
403 u32 key_len, key_handle, err;
404 u8 usage_auth[DIGEST_LENGTH];
405 u8 parent_hash[DIGEST_LENGTH];
414 return CMD_RET_USAGE;
416 parse_byte_string(argv[1], parent_hash, NULL);
417 key = (void *)simple_strtoul(argv[2], NULL, 0);
418 key_len = simple_strtoul(argv[3], NULL, 0);
419 if (strlen(argv[4]) != 2 * DIGEST_LENGTH)
420 return CMD_RET_FAILURE;
421 parse_byte_string(argv[4], usage_auth, NULL);
423 err = tpm_find_key_sha1(usage_auth, parent_hash, &parent_handle);
425 printf("Could not find matching parent key (err = %d)\n", err);
426 return CMD_RET_FAILURE;
429 printf("Found parent key %08x\n", parent_handle);
431 err = tpm_load_key2_oiap(parent_handle, key, key_len, usage_auth,
434 printf("Key handle is 0x%x\n", key_handle);
435 env_set_hex("key_handle", key_handle);
438 return report_return_code(err);
440 #endif /* CONFIG_TPM_LOAD_KEY_BY_SHA1 */
442 static int do_tpm_load_key2_oiap(struct cmd_tbl *cmdtp, int flag, int argc,
445 u32 parent_handle, key_len, key_handle, err;
446 u8 usage_auth[DIGEST_LENGTH];
456 return CMD_RET_USAGE;
458 parent_handle = simple_strtoul(argv[1], NULL, 0);
459 key = (void *)simple_strtoul(argv[2], NULL, 0);
460 key_len = simple_strtoul(argv[3], NULL, 0);
461 if (strlen(argv[4]) != 2 * DIGEST_LENGTH)
462 return CMD_RET_FAILURE;
463 parse_byte_string(argv[4], usage_auth, NULL);
465 err = tpm1_load_key2_oiap(dev, parent_handle, key, key_len, usage_auth,
468 printf("Key handle is 0x%x\n", key_handle);
470 return report_return_code(err);
473 static int do_tpm_get_pub_key_oiap(struct cmd_tbl *cmdtp, int flag, int argc,
477 u8 usage_auth[DIGEST_LENGTH];
478 u8 pub_key_buffer[TPM_PUBKEY_MAX_LENGTH];
479 size_t pub_key_len = sizeof(pub_key_buffer);
488 return CMD_RET_USAGE;
490 key_handle = simple_strtoul(argv[1], NULL, 0);
491 if (strlen(argv[2]) != 2 * DIGEST_LENGTH)
492 return CMD_RET_FAILURE;
493 parse_byte_string(argv[2], usage_auth, NULL);
495 err = tpm1_get_pub_key_oiap(dev, key_handle, usage_auth, pub_key_buffer,
498 printf("dump of received pub key structure:\n");
499 print_byte_string(pub_key_buffer, pub_key_len);
501 return report_return_code(err);
504 TPM_COMMAND_NO_ARG(tpm1_end_oiap)
506 #endif /* CONFIG_TPM_AUTH_SESSIONS */
508 #ifdef CONFIG_TPM_FLUSH_RESOURCES
509 static int do_tpm_flush(struct cmd_tbl *cmdtp, int flag, int argc,
521 return CMD_RET_USAGE;
523 if (!strcasecmp(argv[1], "key"))
525 else if (!strcasecmp(argv[1], "auth"))
527 else if (!strcasecmp(argv[1], "hash"))
529 else if (!strcasecmp(argv[1], "trans"))
531 else if (!strcasecmp(argv[1], "context"))
532 type = TPM_RT_CONTEXT;
533 else if (!strcasecmp(argv[1], "counter"))
534 type = TPM_RT_COUNTER;
535 else if (!strcasecmp(argv[1], "delegate"))
536 type = TPM_RT_DELEGATE;
537 else if (!strcasecmp(argv[1], "daa_tpm"))
538 type = TPM_RT_DAA_TPM;
539 else if (!strcasecmp(argv[1], "daa_v0"))
540 type = TPM_RT_DAA_V0;
541 else if (!strcasecmp(argv[1], "daa_v1"))
542 type = TPM_RT_DAA_V1;
545 printf("Resource type %s unknown.\n", argv[1]);
549 if (!strcasecmp(argv[2], "all")) {
556 /* fetch list of already loaded resources in the TPM */
557 err = tpm_get_capability(dev, TPM_CAP_HANDLE, type, buf,
560 printf("tpm_get_capability returned error %d.\n", err);
563 res_count = get_unaligned_be16(buf);
565 for (i = 0; i < res_count; ++i, ptr += 4)
566 tpm1_flush_specific(dev, get_unaligned_be32(ptr), type);
568 u32 handle = simple_strtoul(argv[2], NULL, 0);
571 printf("Illegal resource handle %s\n", argv[2]);
574 tpm1_flush_specific(dev, cpu_to_be32(handle), type);
579 #endif /* CONFIG_TPM_FLUSH_RESOURCES */
581 #ifdef CONFIG_TPM_LIST_RESOURCES
582 static int do_tpm_list(struct cmd_tbl *cmdtp, int flag, int argc,
593 return CMD_RET_USAGE;
595 if (!strcasecmp(argv[1], "key"))
597 else if (!strcasecmp(argv[1], "auth"))
599 else if (!strcasecmp(argv[1], "hash"))
601 else if (!strcasecmp(argv[1], "trans"))
603 else if (!strcasecmp(argv[1], "context"))
604 type = TPM_RT_CONTEXT;
605 else if (!strcasecmp(argv[1], "counter"))
606 type = TPM_RT_COUNTER;
607 else if (!strcasecmp(argv[1], "delegate"))
608 type = TPM_RT_DELEGATE;
609 else if (!strcasecmp(argv[1], "daa_tpm"))
610 type = TPM_RT_DAA_TPM;
611 else if (!strcasecmp(argv[1], "daa_v0"))
612 type = TPM_RT_DAA_V0;
613 else if (!strcasecmp(argv[1], "daa_v1"))
614 type = TPM_RT_DAA_V1;
617 printf("Resource type %s unknown.\n", argv[1]);
621 /* fetch list of already loaded resources in the TPM */
622 err = tpm_get_capability(TPM_CAP_HANDLE, type, buf,
625 printf("tpm_get_capability returned error %d.\n", err);
628 res_count = get_unaligned_be16(buf);
631 printf("Resources of type %s (%02x):\n", argv[1], type);
635 for (i = 0; i < res_count; ++i, ptr += 4)
636 printf("Index %d: %08x\n", i, get_unaligned_be32(ptr));
641 #endif /* CONFIG_TPM_LIST_RESOURCES */
643 TPM_COMMAND_NO_ARG(tpm_self_test_full)
644 TPM_COMMAND_NO_ARG(tpm_continue_self_test)
645 TPM_COMMAND_NO_ARG(tpm_force_clear)
646 TPM_COMMAND_NO_ARG(tpm_physical_enable)
647 TPM_COMMAND_NO_ARG(tpm_physical_disable)
649 static struct cmd_tbl tpm1_commands[] = {
650 U_BOOT_CMD_MKENT(device, 0, 1, do_tpm_device, "", ""),
651 U_BOOT_CMD_MKENT(info, 0, 1, do_tpm_info, "", ""),
652 U_BOOT_CMD_MKENT(init, 0, 1, do_tpm_init, "", ""),
653 U_BOOT_CMD_MKENT(startup, 0, 1,
654 do_tpm_startup, "", ""),
655 U_BOOT_CMD_MKENT(self_test_full, 0, 1,
656 do_tpm_self_test_full, "", ""),
657 U_BOOT_CMD_MKENT(continue_self_test, 0, 1,
658 do_tpm_continue_self_test, "", ""),
659 U_BOOT_CMD_MKENT(force_clear, 0, 1,
660 do_tpm_force_clear, "", ""),
661 U_BOOT_CMD_MKENT(physical_enable, 0, 1,
662 do_tpm_physical_enable, "", ""),
663 U_BOOT_CMD_MKENT(physical_disable, 0, 1,
664 do_tpm_physical_disable, "", ""),
665 U_BOOT_CMD_MKENT(nv_define_space, 0, 1,
666 do_tpm_nv_define_space, "", ""),
667 U_BOOT_CMD_MKENT(nv_read_value, 0, 1,
668 do_tpm_nv_read_value, "", ""),
669 U_BOOT_CMD_MKENT(nv_write_value, 0, 1,
670 do_tpm_nv_write_value, "", ""),
671 U_BOOT_CMD_MKENT(extend, 0, 1,
672 do_tpm_extend, "", ""),
673 U_BOOT_CMD_MKENT(pcr_read, 0, 1,
674 do_tpm_pcr_read, "", ""),
675 U_BOOT_CMD_MKENT(tsc_physical_presence, 0, 1,
676 do_tpm_tsc_physical_presence, "", ""),
677 U_BOOT_CMD_MKENT(read_pubek, 0, 1,
678 do_tpm_read_pubek, "", ""),
679 U_BOOT_CMD_MKENT(physical_set_deactivated, 0, 1,
680 do_tpm_physical_set_deactivated, "", ""),
681 U_BOOT_CMD_MKENT(get_capability, 0, 1,
682 do_tpm_get_capability, "", ""),
683 U_BOOT_CMD_MKENT(raw_transfer, 0, 1,
684 do_tpm_raw_transfer, "", ""),
685 U_BOOT_CMD_MKENT(nv_define, 0, 1,
686 do_tpm_nv_define, "", ""),
687 U_BOOT_CMD_MKENT(nv_read, 0, 1,
688 do_tpm_nv_read, "", ""),
689 U_BOOT_CMD_MKENT(nv_write, 0, 1,
690 do_tpm_nv_write, "", ""),
691 #ifdef CONFIG_TPM_AUTH_SESSIONS
692 U_BOOT_CMD_MKENT(oiap, 0, 1,
693 do_tpm_oiap, "", ""),
694 U_BOOT_CMD_MKENT(end_oiap, 0, 1,
695 do_tpm1_end_oiap, "", ""),
696 U_BOOT_CMD_MKENT(load_key2_oiap, 0, 1,
697 do_tpm_load_key2_oiap, "", ""),
698 #ifdef CONFIG_TPM_LOAD_KEY_BY_SHA1
699 U_BOOT_CMD_MKENT(load_key_by_sha1, 0, 1,
700 do_tpm_load_key_by_sha1, "", ""),
701 #endif /* CONFIG_TPM_LOAD_KEY_BY_SHA1 */
702 U_BOOT_CMD_MKENT(get_pub_key_oiap, 0, 1,
703 do_tpm_get_pub_key_oiap, "", ""),
704 #endif /* CONFIG_TPM_AUTH_SESSIONS */
705 #ifdef CONFIG_TPM_FLUSH_RESOURCES
706 U_BOOT_CMD_MKENT(flush, 0, 1,
707 do_tpm_flush, "", ""),
708 #endif /* CONFIG_TPM_FLUSH_RESOURCES */
709 #ifdef CONFIG_TPM_LIST_RESOURCES
710 U_BOOT_CMD_MKENT(list, 0, 1,
711 do_tpm_list, "", ""),
712 #endif /* CONFIG_TPM_LIST_RESOURCES */
715 struct cmd_tbl *get_tpm1_commands(unsigned int *size)
717 *size = ARRAY_SIZE(tpm1_commands);
719 return tpm1_commands;
722 U_BOOT_CMD(tpm, CONFIG_SYS_MAXARGS, 1, do_tpm,
723 "Issue a TPMv1.x command",
725 " - Issue TPM command <cmd> with arguments <args...>.\n"
726 "Admin Startup and State Commands:\n"
727 " device [num device]\n"
728 " - Show all devices or set the specified device\n"
729 " info - Show information about the TPM\n"
731 " - Put TPM into a state where it waits for 'startup' command.\n"
733 " - Issue TPM_Starup command. <mode> is one of TPM_ST_CLEAR,\n"
734 " TPM_ST_STATE, and TPM_ST_DEACTIVATED.\n"
735 "Admin Testing Commands:\n"
737 " - Test all of the TPM capabilities.\n"
738 " continue_self_test\n"
739 " - Inform TPM that it should complete the self-test.\n"
740 "Admin Opt-in Commands:\n"
742 " - Set the PERMANENT disable flag to FALSE using physical presence as\n"
744 " physical_disable\n"
745 " - Set the PERMANENT disable flag to TRUE using physical presence as\n"
747 " physical_set_deactivated 0|1\n"
748 " - Set deactivated flag.\n"
749 "Admin Ownership Commands:\n"
751 " - Issue TPM_ForceClear command.\n"
752 " tsc_physical_presence flags\n"
753 " - Set TPM device's Physical Presence flags to <flags>.\n"
754 "The Capability Commands:\n"
755 " get_capability cap_area sub_cap addr count\n"
756 " - Read <count> bytes of TPM capability indexed by <cap_area> and\n"
757 " <sub_cap> to memory address <addr>.\n"
758 #if defined(CONFIG_TPM_FLUSH_RESOURCES) || defined(CONFIG_TPM_LIST_RESOURCES)
759 "Resource management functions\n"
761 #ifdef CONFIG_TPM_FLUSH_RESOURCES
762 " flush resource_type id\n"
763 " - flushes a resource of type <resource_type> (may be one of key, auth,\n"
764 " hash, trans, context, counter, delegate, daa_tpm, daa_v0, daa_v1),\n"
765 " and id <id> from the TPM. Use an <id> of \"all\" to flush all\n"
766 " resources of that type.\n"
767 #endif /* CONFIG_TPM_FLUSH_RESOURCES */
768 #ifdef CONFIG_TPM_LIST_RESOURCES
769 " list resource_type\n"
770 " - lists resources of type <resource_type> (may be one of key, auth,\n"
771 " hash, trans, context, counter, delegate, daa_tpm, daa_v0, daa_v1),\n"
772 " contained in the TPM.\n"
773 #endif /* CONFIG_TPM_LIST_RESOURCES */
774 #ifdef CONFIG_TPM_AUTH_SESSIONS
775 "Storage functions\n"
776 " loadkey2_oiap parent_handle key_addr key_len usage_auth\n"
777 " - loads a key data from memory address <key_addr>, <key_len> bytes\n"
778 " into TPM using the parent key <parent_handle> with authorization\n"
779 " <usage_auth> (20 bytes hex string).\n"
780 #ifdef CONFIG_TPM_LOAD_KEY_BY_SHA1
781 " load_key_by_sha1 parent_hash key_addr key_len usage_auth\n"
782 " - loads a key data from memory address <key_addr>, <key_len> bytes\n"
783 " into TPM using the parent hash <parent_hash> (20 bytes hex string)\n"
784 " with authorization <usage_auth> (20 bytes hex string).\n"
785 #endif /* CONFIG_TPM_LOAD_KEY_BY_SHA1 */
786 " get_pub_key_oiap key_handle usage_auth\n"
787 " - get the public key portion of a loaded key <key_handle> using\n"
788 " authorization <usage auth> (20 bytes hex string)\n"
789 #endif /* CONFIG_TPM_AUTH_SESSIONS */
790 "Endorsement Key Handling Commands:\n"
791 " read_pubek addr count\n"
792 " - Read <count> bytes of the public endorsement key to memory\n"
794 "Integrity Collection and Reporting Commands:\n"
795 " extend index digest_hex_string\n"
796 " - Add a new measurement to a PCR. Update PCR <index> with the 20-bytes\n"
797 " <digest_hex_string>\n"
798 " pcr_read index addr count\n"
799 " - Read <count> bytes from PCR <index> to memory address <addr>.\n"
800 #ifdef CONFIG_TPM_AUTH_SESSIONS
801 "Authorization Sessions\n"
803 " - setup an OIAP session\n"
805 " - terminates an active OIAP session\n"
806 #endif /* CONFIG_TPM_AUTH_SESSIONS */
807 "Non-volatile Storage Commands:\n"
808 " nv_define_space index permission size\n"
809 " - Establish a space at index <index> with <permission> of <size> bytes.\n"
810 " nv_read_value index addr count\n"
811 " - Read <count> bytes from space <index> to memory address <addr>.\n"
812 " nv_write_value index addr count\n"
813 " - Write <count> bytes from memory address <addr> to space <index>.\n"
814 "Miscellaneous helper functions:\n"
815 " raw_transfer byte_string\n"
816 " - Send a byte string <byte_string> to TPM and print the response.\n"
817 " Non-volatile storage helper functions:\n"
818 " These helper functions treat a non-volatile space as a non-padded\n"
819 " sequence of integer values. These integer values are defined by a type\n"
820 " string, which is a text string of 'bwd' characters: 'b' means a 8-bit\n"
821 " value, 'w' 16-bit value, 'd' 32-bit value. All helper functions take\n"
822 " a type string as their first argument.\n"
823 " nv_define type_string index perm\n"
824 " - Define a space <index> with permission <perm>.\n"
825 " nv_read types_string index vars...\n"
826 " - Read from space <index> to environment variables <vars...>.\n"
827 " nv_write types_string index values...\n"
828 " - Write to space <index> from values <values...>.\n"