1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995
|
/* SPDX-License-Identifier: BSD-3-Clause */
#include <ctype.h>
#include <dlfcn.h>
#include <inttypes.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "files.h"
#include "log.h"
#include "tool_rc.h"
#include "tpm2.h"
#include "tpm2_alg_util.h"
#include "tpm2_attr_util.h"
#include "tpm2_openssl.h"
#include "tpm2_tool.h"
#include "tpm2_util.h"
// verify that the quote digest equals the digest we calculated
bool tpm2_util_verify_digests(TPM2B_DIGEST *quoteDigest,
TPM2B_DIGEST *pcr_digest) {
// Sanity check -- they should at least be same size!
if (quoteDigest->size != pcr_digest->size) {
LOG_ERR("FATAL ERROR: PCR values failed to match quote's digest!");
return false;
}
// Compare running digest with quote's digest
int k;
for (k = 0; k < quoteDigest->size; k++) {
if (quoteDigest->buffer[k] != pcr_digest->buffer[k]) {
LOG_ERR("FATAL ERROR: PCR values failed to match quote's digest!");
return false;
}
}
return true;
}
bool tpm2_util_concat_buffer(TPM2B_MAX_BUFFER *result, TPM2B *append) {
if (!result || !append) {
return false;
}
if ((result->size + append->size) < result->size) {
return false;
}
if ((result->size + append->size) > TPM2_MAX_DIGEST_BUFFER) {
return false;
}
memcpy(&result->buffer[result->size], append->buffer, append->size);
result->size += append->size;
return true;
}
bool tpm2_util_string_to_uint8(const char *str, uint8_t *value) {
uint32_t tmp;
bool result = tpm2_util_string_to_uint32(str, &tmp);
if (!result) {
return false;
}
/* overflow on 8 bits? */
if (tmp > UINT8_MAX) {
return false;
}
*value = (uint8_t) tmp;
return true;
}
bool tpm2_util_string_to_uint16(const char *str, uint16_t *value) {
uint32_t tmp;
bool result = tpm2_util_string_to_uint32(str, &tmp);
if (!result) {
return false;
}
/* overflow on 16 bits? */
if (tmp > UINT16_MAX) {
return false;
}
*value = (uint16_t) tmp;
return true;
}
bool tpm2_util_string_to_uint32(const char *str, uint32_t *value) {
char *endptr;
if (str == NULL || *str == '\0') {
return false;
}
/* clear errno before the call, should be 0 afterwards */
errno = 0;
unsigned long int tmp = strtoul(str, &endptr, 0);
if (errno || tmp > UINT32_MAX) {
return false;
}
/*
* The entire string should be able to be converted or fail
* We already checked that str starts with a null byte, so no
* need to check that again per the man page.
*/
if (*endptr != '\0') {
return false;
}
*value = (uint32_t) tmp;
return true;
}
bool tpm2_util_string_to_uint64(const char *str, uint64_t *value) {
char *endptr;
if (str == NULL || *str == '\0') {
return false;
}
/* clear errno before the call, should be 0 afterwards */
errno = 0;
/*
* unsigned long long is at least 64 bits, although commonly just 64 bits even on 64 bit systems
* however, ensure that on some weird system it isn't greater than 64 bits since it is allowed by
* the standard.
*/
unsigned long long int tmp = strtoull(str, &endptr, 0);
if (errno || tmp > UINT64_MAX) {
return false;
}
/*
* The entire string should be able to be converted or fail
* We already checked that str starts with a null byte, so no
* need to check that again per the man page.
*/
if (*endptr != '\0') {
return false;
}
*value = (uint64_t) tmp;
return true;
}
bool tpm2_util_string_to_int32(const char *str, int32_t *value) {
char *endptr;
if (str == NULL || *str == '\0') {
return false;
}
/* clear errno before the call, should be 0 afterwards */
errno = 0;
signed long int tmp = strtol(str, &endptr, 0);
if (errno || tmp > INT32_MAX) {
return false;
}
/*
* The entire string should be able to be converted or fail
* We already checked that str starts with a null byte, so no
* need to check that again per the man page.
*/
if (*endptr != '\0') {
return false;
}
*value = (int32_t) tmp;
return true;
}
int tpm2_util_hex_to_byte_structure(const char *input_string, UINT16 *byte_length,
BYTE *byte_buffer) {
int str_length; //if the input_string likes "1a2b...", no prefix "0x"
int i = 0;
if (input_string == NULL || byte_length == NULL || byte_buffer == NULL)
return -1;
str_length = strlen(input_string);
if (str_length % 2)
return -2;
for (i = 0; i < str_length; i++) {
if (!isxdigit(input_string[i]))
return -3;
}
if (*byte_length < str_length / 2)
return -4;
*byte_length = str_length / 2;
for (i = 0; i < *byte_length; i++) {
char tmp_str[4] = { 0 };
tmp_str[0] = input_string[i * 2];
tmp_str[1] = input_string[i * 2 + 1];
byte_buffer[i] = strtol(tmp_str, NULL, 16);
}
return 0;
}
bool tpm2_util_bin_from_hex_or_file(const char *input, UINT16 *len, BYTE *buffer) {
bool result = false;
FILE *f = fopen(input, "rb");
if (!f) {
result = tpm2_util_hex_to_byte_structure(input, len, buffer) == 0;
goto out;
}
result = file_read_bytes_from_file(f, buffer, len, input);
fclose(f);
out:
if (!result) {
LOG_ERR("Could not convert \"%s\". Neither a file path nor hex string.",
input);
}
return result;
}
void tpm2_util_hexdump2(FILE *f, const BYTE *data, size_t len) {
size_t i;
for (i = 0; i < len; i++) {
fprintf(f, "%02x", data[i]);
}
}
void tpm2_util_hexdump(const BYTE *data, size_t len) {
if (!output_enabled) {
return;
}
tpm2_util_hexdump2(stdout, data, len);
}
bool tpm2_util_is_big_endian(void) {
uint32_t test_word;
uint8_t *test_byte;
test_word = 0xFF000000;
test_byte = (uint8_t *) (&test_word);
return test_byte[0] == 0xFF;
}
#define STRING_BYTES_ENDIAN_CONVERT(size) \
UINT##size tpm2_util_endian_swap_##size(UINT##size data) { \
\
UINT##size converted; \
UINT8 *bytes = (UINT8 *)&data; \
UINT8 *tmp = (UINT8 *)&converted; \
\
size_t i; \
for(i=0; i < sizeof(UINT##size); i ++) { \
tmp[i] = bytes[sizeof(UINT##size) - i - 1]; \
} \
\
return converted; \
}
STRING_BYTES_ENDIAN_CONVERT(16)
STRING_BYTES_ENDIAN_CONVERT(32)
STRING_BYTES_ENDIAN_CONVERT(64)
#define STRING_BYTES_ENDIAN_HTON(size) \
UINT##size tpm2_util_hton_##size(UINT##size data) { \
\
bool is_big_endian = tpm2_util_is_big_endian(); \
if (is_big_endian) { \
return data; \
} \
\
return tpm2_util_endian_swap_##size(data); \
}
STRING_BYTES_ENDIAN_HTON(16)
STRING_BYTES_ENDIAN_HTON(32)
STRING_BYTES_ENDIAN_HTON(64)
/*
* Converting from host-to-network (hton) or network-to-host (ntoh) is
* the same operation: if endianess differs between host and data, swap
* endianess. Thus we can just call the hton routines, but have some nice
* names for folks.
*/
UINT16 tpm2_util_ntoh_16(UINT16 data) {
return tpm2_util_hton_16(data);
}
UINT32 tpm2_util_ntoh_32(UINT32 data) {
return tpm2_util_hton_32(data);
}
UINT64 tpm2_util_ntoh_64(UINT64 data) {
return tpm2_util_hton_64(data);
}
UINT32 tpm2_util_pop_count(UINT32 data) {
static const UINT8 bits_per_nibble[] =
{0,1,1,2,1,2,2,3,1,2,2,3,2,3,3,4};
UINT8 count = 0;
UINT8 *d = (UINT8 *) &data;
size_t i;
for (i = 0; i < sizeof(data); i++) {
count += bits_per_nibble[d[i] & 0x0f];
count += bits_per_nibble[d[i] >> 4];
}
return count;
}
#define TPM2_UTIL_KEYDATA_INIT { .len = 0 };
typedef struct tpm2_util_keydata tpm2_util_keydata;
struct tpm2_util_keydata {
UINT16 len;
struct {
const char *name;
TPM2B *value;
} entries[2];
};
static void tpm2_util_public_to_keydata(TPMT_PUBLIC *public,
tpm2_util_keydata *keydata) {
switch (public->type) {
case TPM2_ALG_RSA:
keydata->len = 1;
keydata->entries[0].name = tpm2_alg_util_algtostr(
public->type, tpm2_alg_util_flags_any);
keydata->entries[0].value = (TPM2B *) &public->unique.rsa;
return;
case TPM2_ALG_KEYEDHASH:
keydata->len = 1;
keydata->entries[0].name = tpm2_alg_util_algtostr(
public->type, tpm2_alg_util_flags_any);
keydata->entries[0].value =
(TPM2B *) &public->unique.keyedHash;
return;
case TPM2_ALG_SYMCIPHER:
keydata->len = 1;
keydata->entries[0].name = tpm2_alg_util_algtostr(
public->type, tpm2_alg_util_flags_any);
keydata->entries[0].value = (TPM2B *) &public->unique.sym;
return;
case TPM2_ALG_ECC:
keydata->len = 2;
keydata->entries[0].name = "x";
keydata->entries[0].value = (TPM2B *) &public->unique.ecc.x;
keydata->entries[1].name = "y";
keydata->entries[1].value = (TPM2B *) &public->unique.ecc.y;
return;
default:
LOG_WARN("The algorithm type(0x%4.4x) is not supported",
public->type);
}
return;
}
void print_yaml_indent(size_t indent_count) {
while (indent_count--) {
tpm2_tool_output(" ");
}
}
void tpm2_util_tpma_object_to_yaml(TPMA_OBJECT obj, char *indent) {
if (!indent) {
indent = "";
}
char *attrs = tpm2_attr_util_obj_attrtostr(obj);
tpm2_tool_output("%sattributes:\n", indent);
tpm2_tool_output("%s value: %s\n", indent, attrs);
tpm2_tool_output("%s raw: 0x%x\n", indent, obj);
free(attrs);
}
static void print_alg_raw(const char *name, TPM2_ALG_ID alg, const char *indent) {
tpm2_tool_output("%s%s:\n", indent, name);
tpm2_tool_output("%s value: %s\n", indent,
tpm2_alg_util_algtostr(alg, tpm2_alg_util_flags_any));
tpm2_tool_output("%s raw: 0x%x\n", indent, alg);
}
static void print_scheme_common(TPMI_ALG_RSA_SCHEME scheme, const char *indent) {
print_alg_raw("scheme", scheme, indent);
}
static void print_sym(TPMT_SYM_DEF_OBJECT *sym, const char *indent) {
print_alg_raw("sym-alg", sym->algorithm, indent);
print_alg_raw("sym-mode", sym->mode.sym, indent);
tpm2_tool_output("%ssym-keybits: %u\n", indent, sym->keyBits.sym);
}
static void print_rsa_scheme(TPMT_RSA_SCHEME *scheme, const char *indent) {
print_scheme_common(scheme->scheme, indent);
/*
* everything is a union on a hash algorithm except for RSAES which
* has nothing. So on RSAES skip the hash algorithm printing
*/
if (scheme->scheme != TPM2_ALG_RSAES) {
print_alg_raw("scheme-halg", scheme->details.oaep.hashAlg, indent);
}
}
static void print_ecc_scheme(TPMT_ECC_SCHEME *scheme, const char *indent) {
print_scheme_common(scheme->scheme, indent);
/*
* everything but ecdaa uses only hash alg
* in a union, so we only need to do things differently
* for ecdaa.
*/
print_alg_raw("scheme-halg", scheme->details.oaep.hashAlg, indent);
if (scheme->scheme == TPM2_ALG_ECDAA) {
tpm2_tool_output("%sscheme-count: %u\n", indent,
scheme->details.ecdaa.count);
}
}
static void print_kdf_scheme(TPMT_KDF_SCHEME *kdf, const char *indent) {
print_alg_raw("kdfa-alg", kdf->scheme, indent);
/*
* The hash algorithm for the KDFA is in a union, just grab one of them.
*/
print_alg_raw("kdfa-halg", kdf->details.mgf1.hashAlg, indent);
}
void tpm2_util_tpmt_public_to_yaml(TPMT_PUBLIC *public, char *indent) {
if (!indent) {
indent = "";
}
tpm2_tool_output("%sname-alg:\n", indent);
tpm2_tool_output("%s value: %s\n", indent,
tpm2_alg_util_algtostr(public->nameAlg,
tpm2_alg_util_flags_any));
tpm2_tool_output("%s raw: 0x%x\n", indent, public->nameAlg);
tpm2_util_tpma_object_to_yaml(public->objectAttributes, indent);
tpm2_tool_output("%stype:\n", indent);
tpm2_tool_output("%s value: %s\n", indent,
tpm2_alg_util_algtostr(public->type,
tpm2_alg_util_flags_any));
tpm2_tool_output("%s raw: 0x%x\n", indent, public->type);
switch (public->type) {
case TPM2_ALG_SYMCIPHER: {
TPMS_SYMCIPHER_PARMS *s = &public->parameters.symDetail;
print_sym(&s->sym, indent);
}
break;
case TPM2_ALG_KEYEDHASH: {
TPMS_KEYEDHASH_PARMS *k = &public->parameters.keyedHashDetail;
tpm2_tool_output("%salgorithm: \n", indent);
tpm2_tool_output("%s value: %s\n", indent,
tpm2_alg_util_algtostr(k->scheme.scheme,
tpm2_alg_util_flags_any));
tpm2_tool_output("%s raw: 0x%x\n", indent, k->scheme.scheme);
if (k->scheme.scheme == TPM2_ALG_HMAC) {
tpm2_tool_output("%shash-alg:\n", indent);
tpm2_tool_output("%s value: %s\n", indent,
tpm2_alg_util_algtostr(k->scheme.details.hmac.hashAlg,
tpm2_alg_util_flags_any));
tpm2_tool_output("%s raw: 0x%x\n", indent,
k->scheme.details.hmac.hashAlg);
} else if (k->scheme.scheme == TPM2_ALG_XOR) {
tpm2_tool_output("%shash-alg:\n", indent);
tpm2_tool_output("%s value: %s\n", indent,
tpm2_alg_util_algtostr(
k->scheme.details.exclusiveOr.hashAlg,
tpm2_alg_util_flags_any));
tpm2_tool_output("%s raw: 0x%x\n", indent,
k->scheme.details.exclusiveOr.hashAlg);
tpm2_tool_output("%skdfa-alg:\n", indent);
tpm2_tool_output("%s value: %s\n", indent,
tpm2_alg_util_algtostr(k->scheme.details.exclusiveOr.kdf,
tpm2_alg_util_flags_any));
tpm2_tool_output("%s raw: 0x%x\n", indent,
k->scheme.details.exclusiveOr.kdf);
}
}
break;
case TPM2_ALG_RSA: {
TPMS_RSA_PARMS *r = &public->parameters.rsaDetail;
tpm2_tool_output("%sexponent: %u\n", indent, r->exponent ? r->exponent : 65537);
tpm2_tool_output("%sbits: %u\n", indent, r->keyBits);
print_rsa_scheme(&r->scheme, indent);
print_sym(&r->symmetric, indent);
}
break;
case TPM2_ALG_ECC: {
TPMS_ECC_PARMS *e = &public->parameters.eccDetail;
tpm2_tool_output("%scurve-id:\n", indent);
tpm2_tool_output("%s value: %s\n", indent,
tpm2_alg_util_ecc_to_str(e->curveID));
tpm2_tool_output("%s raw: 0x%x\n", indent, e->curveID);
print_kdf_scheme(&e->kdf, indent);
print_ecc_scheme(&e->scheme, indent);
print_sym(&e->symmetric, indent);
}
break;
}
tpm2_util_keydata keydata = TPM2_UTIL_KEYDATA_INIT
;
tpm2_util_public_to_keydata(public, &keydata);
UINT16 i;
/* if no keydata len will be 0 and it wont print */
for (i = 0; i < keydata.len; i++) {
tpm2_tool_output("%s%s: ", indent, keydata.entries[i].name);
tpm2_util_print_tpm2b(keydata.entries[i].value);
tpm2_tool_output("%s\n", indent);
}
if (public->authPolicy.size) {
tpm2_tool_output("%sauthorization policy: ", indent);
tpm2_util_hexdump(public->authPolicy.buffer,
public->authPolicy.size);
tpm2_tool_output("%s\n", indent);
}
}
void tpm2_util_public_to_yaml(TPM2B_PUBLIC *public, char *indent) {
tpm2_util_tpmt_public_to_yaml(&public->publicArea, indent);
}
bool tpm2_util_calc_unique(TPMI_ALG_HASH name_alg,
TPM2B_PRIVATE_VENDOR_SPECIFIC *key, TPM2B_DIGEST *seed,
TPM2B_DIGEST *unique_data) {
TPM2B_MAX_BUFFER buf = { .size = key->size + seed->size };
if (buf.size > sizeof(buf.buffer)) {
LOG_ERR("Seed and key size are too big");
return false;
}
memcpy(buf.buffer, seed->buffer, seed->size);
memcpy(&buf.buffer[seed->size], key->buffer, key->size);
digester d = tpm2_openssl_halg_to_digester(name_alg);
if (!d) {
return false;
}
unique_data->size = tpm2_alg_util_get_hash_size(name_alg);
d(buf.buffer, buf.size, unique_data->buffer);
return true;
}
ESYS_TR tpm2_tpmi_hierarchy_to_esys_tr(TPMI_RH_PROVISION inh) {
switch (inh) {
case TPM2_RH_OWNER:
return ESYS_TR_RH_OWNER;
case TPM2_RH_PLATFORM:
return ESYS_TR_RH_PLATFORM;
case TPM2_RH_ENDORSEMENT:
return ESYS_TR_RH_ENDORSEMENT;
case TPM2_RH_NULL:
return ESYS_TR_RH_NULL;
case TPM2_RH_LOCKOUT:
return ESYS_TR_RH_LOCKOUT;
}
return ESYS_TR_NONE;
}
tool_rc tpm2_util_sys_handle_to_esys_handle(ESYS_CONTEXT *context,
TPM2_HANDLE sys_handle, ESYS_TR *esys_handle) {
ESYS_TR h = tpm2_tpmi_hierarchy_to_esys_tr(sys_handle);
if (h != ESYS_TR_NONE) {
*esys_handle = h;
return tool_rc_success;
}
return tpm2_from_tpm_public(context, sys_handle, ESYS_TR_NONE, ESYS_TR_NONE,
ESYS_TR_NONE, esys_handle);
}
char *tpm2_util_getenv(const char *name) {
return getenv(name);
}
/**
* Parses a hierarchy value from an option argument.
* @param value
* The string to parse, which can be a numerical string as
* understood by strtoul() with a base of 0, or an:
* - o - Owner hierarchy
* - p - Platform hierarchy
* - e - Endorsement hierarchy
* - n - Null hierarchy
* @param hierarchy
* The parsed hierarchy as output.
* @param flags
* What hierarchies should be supported by
* the parsing.
* @return
* True on success, False otherwise.
*/
static bool filter_hierarchy_handles(TPMI_RH_PROVISION hierarchy,
tpm2_handle_flags flags) {
switch (hierarchy) {
case TPM2_RH_OWNER:
if (!(flags & TPM2_HANDLE_FLAGS_O)) {
LOG_ERR("Unexpected handle - TPM2_RH_OWNER");
return false;
}
break;
case TPM2_RH_PLATFORM:
if (!(flags & TPM2_HANDLE_FLAGS_P)) {
LOG_ERR("Unexpected handle - TPM2_RH_PLATFORM");
return false;
}
break;
case TPM2_RH_ENDORSEMENT:
if (!(flags & TPM2_HANDLE_FLAGS_E)) {
LOG_ERR("Unexpected handle - TPM2_RH_ENDORSEMENT");
return false;
}
break;
case TPM2_RH_NULL:
if (!(flags & TPM2_HANDLE_FLAGS_N)) {
LOG_ERR("Unexpected handle - TPM2_RH_NULL");
return false;
}
break;
case TPM2_RH_LOCKOUT:
if (!(flags & TPM2_HANDLE_FLAGS_L)) {
LOG_ERR("Unexpected handle - TPM2_RH_LOCKOUT");
return false;
}
break;
default: //If specified a random offset to the permanent handle range
if (flags == TPM2_HANDLE_ALL_W_NV || flags == TPM2_HANDLE_FLAGS_NONE) {
return true;
}
return false;
}
return true;
}
static bool filter_handles(TPMI_RH_PROVISION *hierarchy,
tpm2_handle_flags flags) {
TPM2_RH range = *hierarchy & TPM2_HR_RANGE_MASK;
/*
* if their is no range, then it could be NV or PCR, use flags
* to figure out what it is.
*/
if (range == 0) {
if (flags & TPM2_HANDLE_FLAGS_NV) {
*hierarchy += TPM2_HR_NV_INDEX;
range = *hierarchy & TPM2_HR_RANGE_MASK;
} else if (flags & TPM2_HANDLE_FLAGS_PCR) {
*hierarchy += TPM2_HR_PCR;
range = *hierarchy & TPM2_HR_RANGE_MASK;
} else {
LOG_ERR("Implicit indices are not supported.");
return false;
}
}
/* now that we have fixed up any non-ranged handles, check them */
if (range == TPM2_HR_NV_INDEX) {
if (!(flags & TPM2_HANDLE_FLAGS_NV)) {
LOG_ERR("NV-Index handles are not supported by this command.");
return false;
}
if (*hierarchy < TPM2_NV_INDEX_FIRST
|| *hierarchy > TPM2_NV_INDEX_LAST) {
LOG_ERR("NV-Index handle is out of range.");
return false;
}
return true;
} else if (range == TPM2_HR_PCR) {
if (!(flags & TPM2_HANDLE_FLAGS_PCR)) {
LOG_ERR("PCR handles are not supported by this command.");
return false;
}
/* first is 0 so no possible way unsigned is less than 0, thus no check */
if (*hierarchy > TPM2_PCR_LAST) {
LOG_ERR("PCR handle out of range.");
return false;
}
return true;
} else if (range == TPM2_HR_TRANSIENT) {
if (!(flags & TPM2_HANDLES_FLAGS_TRANSIENT)) {
LOG_ERR("Transient handles are not supported by this command.");
return false;
}
return true;
} else if (range == TPM2_HR_PERMANENT) {
return filter_hierarchy_handles(*hierarchy, flags);
} else if (range == TPM2_HR_PERSISTENT) {
if (!(flags & TPM2_HANDLES_FLAGS_PERSISTENT)) {
LOG_ERR("Persistent handles are not supported by this command.");
return false;
}
if (*hierarchy < TPM2_PERSISTENT_FIRST
|| *hierarchy > TPM2_PERSISTENT_LAST) {
LOG_ERR("Persistent handle out of range.");
return false;
}
return true;
}
/* else its a session flag and shouldn't use this interface */
return false;
}
bool tpm2_util_handle_from_optarg(const char *value,
TPMI_RH_PROVISION *hierarchy, tpm2_handle_flags flags) {
if (!value || !value[0]) {
return false;
}
if ((flags & TPM2_HANDLE_FLAGS_NV) && (flags & TPM2_HANDLE_FLAGS_PCR)) {
LOG_ERR("Cannot specify NV and PCR index together");
return false;
}
*hierarchy = 0;
bool is_o = !strncmp(value, "owner", strlen(value));
if (is_o) {
*hierarchy = TPM2_RH_OWNER;
}
bool is_p = !strncmp(value, "platform", strlen(value));
if (is_p) {
*hierarchy = TPM2_RH_PLATFORM;
}
bool is_e = !strncmp(value, "endorsement", strlen(value));
if (is_e) {
*hierarchy = TPM2_RH_ENDORSEMENT;
}
bool is_n = !strncmp(value, "null", strlen(value));
if (is_n) {
*hierarchy = TPM2_RH_NULL;
}
bool is_l = !strncmp(value, "lockout", strlen(value));
if (is_l) {
*hierarchy = TPM2_RH_LOCKOUT;
}
bool result = true;
if (!*hierarchy) {
/*
* This branch is executed when hierarchy is specified as a hex handle.
* The raw hex returned may be a generic (non hierarchy) TPM2_HANDLE.
*/
result = tpm2_util_string_to_uint32(value, hierarchy);
}
if (!result) {
char msg[256] = { 0 };
char print_flags[32] = { '[', '\0' };
if (flags & TPM2_HANDLE_FLAGS_O) {
strncat(print_flags, "o|",
sizeof(print_flags) - strlen(print_flags) - 1);
}
if (flags & TPM2_HANDLE_FLAGS_P) {
strncat(print_flags, "p|",
sizeof(print_flags) - strlen(print_flags) - 1);
}
if (flags & TPM2_HANDLE_FLAGS_E) {
strncat(print_flags, "e|",
sizeof(print_flags) - strlen(print_flags) - 1);
}
if (flags & TPM2_HANDLE_FLAGS_N) {
strncat(print_flags, "n|",
sizeof(print_flags) - strlen(print_flags) - 1);
}
if (flags & TPM2_HANDLE_FLAGS_L) {
strncat(print_flags, "l|",
sizeof(print_flags) - strlen(print_flags) - 1);
}
size_t len = strlen(print_flags);
if (print_flags[len - 1] == '|') {
len--;
print_flags[len] = '\0';
}
strncat(print_flags, "]",
sizeof(print_flags) - strlen(print_flags) - 1);
len++;
bool has_print_flags = len > 2;
if (has_print_flags) {
snprintf(msg, sizeof(msg), "expected %s or ", print_flags);
}
strncat(msg, "a handle number", sizeof(msg) - strlen(msg) - 1);
LOG_ERR("Incorrect handle value, got: \"%s\", expected %s", value, msg);
return false;
}
/*
* If the caller specifies the expected valid hierarchies, either as string,
* or hex handles, they are additionally filtered here.
*/
bool res = filter_handles(hierarchy, flags);
if (!res) {
LOG_ERR("Unknown or unsupported handle, got: \"%s\"", value);
}
return res;
}
bool tpm2_util_get_label(const char *value, TPM2B_DATA *label) {
if (!value) {
label->size = 0;
return true;
}
FILE *f = fopen(value, "rb");
if (f) {
/* set size one smaller for NUL byte */
label->size = sizeof(label->buffer) - 1;
size_t cnt = fread(label->buffer, 1, label->size, f);
if (!feof(f)) {
LOG_ERR("label file \"%s\" larger than expected. Expected %u",
value, label->size);
fclose(f);
return false;
}
if (ferror(f)) {
LOG_ERR("reading label file \"%s\" error: %s", value,
strerror(errno));
fclose(f);
return false;
}
fclose(f);
label->size = cnt;
/* Set NUL byte and increment */
label->buffer[label->size++] = '\0';
return true;
}
size_t len = strlen(value);
if (len > sizeof(label->buffer) - 1) {
LOG_ERR("label file \"%s\" larger than expected. Expected %zu", value,
sizeof(label->buffer) - 1);
return false;
}
memcpy(label->buffer, value, len);
label->size = len;
/* Set NUL byte and increment */
label->buffer[label->size++] = '\0';
return true;
}
void tpm2_util_print_time(const TPMS_TIME_INFO *current_time) {
tpm2_tool_output("time: %"PRIu64"\n", current_time->time);
tpm2_tool_output("clock_info:\n");
tpm2_tool_output(" clock: %"PRIu64"\n",
current_time->clockInfo.clock);
tpm2_tool_output(" reset_count: %"PRIu32"\n",
current_time->clockInfo.resetCount);
tpm2_tool_output(" restart_count: %"PRIu32"\n",
current_time->clockInfo.restartCount);
tpm2_tool_output(" safe: %s\n",
current_time->clockInfo.safe ? "yes" : "no");
}
bool tpm2_calq_qname(TPM2B_NAME *pqname,
TPMI_ALG_HASH halg, TPM2B_NAME *name, TPM2B_NAME *qname) {
// QNB ≔ HB (QNA || NAMEB)
bool result = false;
const EVP_MD *md = tpm2_openssl_halg_from_tpmhalg(halg);
EVP_MD_CTX *mdctx = EVP_MD_CTX_create();
if (!mdctx) {
LOG_ERR("%s", tpm2_openssl_get_err());
return false;
}
int rc = EVP_DigestInit_ex(mdctx, md, NULL);
if (!rc) {
LOG_ERR("%s", tpm2_openssl_get_err());
goto out;
}
size_t offset = sizeof(halg);
rc = EVP_DigestUpdate(mdctx, pqname->name, pqname->size);
if (!rc) {
LOG_ERR("%s", tpm2_openssl_get_err());
goto out;
}
rc = EVP_DigestUpdate(mdctx, name->name, name->size);
if (!rc) {
LOG_ERR("%s", tpm2_openssl_get_err());
goto out;
}
unsigned size = EVP_MD_size(md);
rc = EVP_DigestFinal_ex(mdctx, &qname->name[offset], &size);
if (!rc) {
LOG_ERR("%s", tpm2_openssl_get_err());
goto out;
}
/* hash sizes are not bigger than 16 bits, safe truncate */
qname->size = (UINT16)size;
/* put the hash alg on the front, since name already has it in marshalled
* proper form just use it.
*/
memcpy(qname->name, name->name, offset);
qname->size += offset;
result = true;
out:
EVP_MD_CTX_destroy(mdctx);
return result;
}
|