ac3a84
From fda254c954d6a543e1977edc1d283c915ee43adc Mon Sep 17 00:00:00 2001
ac3a84
From: Vitaly Kuznetsov <vkuznets@redhat.com>
ac3a84
Date: Tue, 15 Nov 2022 14:57:23 +0100
ac3a84
Subject: [PATCH] shared/tpm2-util: Fix "Error: Esys invalid ESAPI handle
ac3a84
 (40000001)" warning
ac3a84
ac3a84
systemd-cryptenroll complains (but succeeds!) upon binding to a signed PCR
ac3a84
policy:
ac3a84
ac3a84
$ systemd-cryptenroll --unlock-key-file=/tmp/passphrase --tpm2-device=auto
ac3a84
  --tpm2-public-key=... --tpm2-signature=..." /tmp/tmp.img
ac3a84
ac3a84
ERROR:esys:src/tss2-esys/esys_iutil.c:394:iesys_handle_to_tpm_handle() Error: Esys invalid ESAPI handle (40000001).
ac3a84
WARNING:esys:src/tss2-esys/esys_iutil.c:415:iesys_is_platform_handle() Convert handle from TPM2_RH to ESYS_TR, got: 0x40000001
ac3a84
ERROR:esys:src/tss2-esys/esys_iutil.c:394:iesys_handle_to_tpm_handle() Error: Esys invalid ESAPI handle (40000001).
ac3a84
WARNING:esys:src/tss2-esys/esys_iutil.c:415:iesys_is_platform_handle() Convert handle from TPM2_RH to ESYS_TR, got: 0x4000000
ac3a84
New TPM2 token enrolled as key slot 1.
ac3a84
ac3a84
The problem seems to be that Esys_LoadExternal() function from tpm2-tss
ac3a84
expects a 'ESYS_TR_RH*' constant specifying the requested hierarchy and not
ac3a84
a 'TPM2_RH_*' one (see Esys_LoadExternal() -> Esys_LoadExternal_Async() ->
ac3a84
iesys_handle_to_tpm_handle() call chain).
ac3a84
ac3a84
It all works because Esys_LoadExternal_Async() falls back to using the
ac3a84
supplied values when iesys_handle_to_tpm_handle() fails:
ac3a84
ac3a84
    r = iesys_handle_to_tpm_handle(hierarchy, &tpm_hierarchy);
ac3a84
    if (r != TSS2_RC_SUCCESS) {
ac3a84
        ...
ac3a84
        tpm_hierarchy = hierarchy;
ac3a84
    }
ac3a84
ac3a84
Note, TPM2_RH_OWNER was used on purpose to support older tpm2-tss versions
ac3a84
(pre https://github.com/tpm2-software/tpm2-tss/pull/1531), use meson magic
ac3a84
to preserve compatibility.
ac3a84
ac3a84
Signed-off-by: Vitaly Kuznetsov <vkuznets@redhat.com>
ac3a84
(cherry picked from commit 155c51293d5bf37f54c65fd0a66ea29e6eedd580)
ac3a84
ac3a84
Related: #2138081
ac3a84
---
ac3a84
 meson.build            | 3 +++
ac3a84
 src/shared/tpm2-util.c | 6 ++++++
ac3a84
 2 files changed, 9 insertions(+)
ac3a84
ac3a84
diff --git a/meson.build b/meson.build
ac3a84
index 7750534466..015849af49 100644
ac3a84
--- a/meson.build
ac3a84
+++ b/meson.build
ac3a84
@@ -1474,11 +1474,14 @@ if want_tpm2 != 'false' and not skip_deps
ac3a84
         tpm2 = dependency('tss2-esys tss2-rc tss2-mu',
ac3a84
                           required : want_tpm2 == 'true')
ac3a84
         have = tpm2.found()
ac3a84
+        have_esys3 = tpm2.version().version_compare('>= 3.0.0')
ac3a84
 else
ac3a84
         have = false
ac3a84
+        have_esys3 = false
ac3a84
         tpm2 = []
ac3a84
 endif
ac3a84
 conf.set10('HAVE_TPM2', have)
ac3a84
+conf.set10('HAVE_TSS2_ESYS3', have_esys3)
ac3a84
 
ac3a84
 want_elfutils = get_option('elfutils')
ac3a84
 if want_elfutils != 'false' and not skip_deps
ac3a84
diff --git a/src/shared/tpm2-util.c b/src/shared/tpm2-util.c
ac3a84
index 4d0df944a9..8171b3e9e9 100644
ac3a84
--- a/src/shared/tpm2-util.c
ac3a84
+++ b/src/shared/tpm2-util.c
ac3a84
@@ -1117,7 +1117,13 @@ static int tpm2_make_policy_session(
ac3a84
                                 ESYS_TR_NONE,
ac3a84
                                 NULL,
ac3a84
                                 &pubkey_tpm2,
ac3a84
+#if HAVE_TSS2_ESYS3
ac3a84
+                                /* tpm2-tss >= 3.0.0 requires a ESYS_TR_RH_* constant specifying the requested
ac3a84
+                                 * hierarchy, older versions need TPM2_RH_* instead. */
ac3a84
+                                ESYS_TR_RH_OWNER,
ac3a84
+#else
ac3a84
                                 TPM2_RH_OWNER,
ac3a84
+#endif
ac3a84
                                 &pubkey_handle);
ac3a84
                 if (rc != TSS2_RC_SUCCESS) {
ac3a84
                         r = log_error_errno(SYNTHETIC_ERRNO(ENOTRECOVERABLE),