Merge pull request #342 from dgarske/infineon_fw_recovery

Add Infineon firmware update recovery support

Author: JacobBarthelmeh

README.md

@@ -874,7 +874,6 @@ Connection: close
 * Add support for Endorsement certificates (EK Credential Profile).
 * Update to v1.59 of specification (adding CertifyX509).
 * Inner wrap support for SensitiveToPrivate.
-* Firmware upgrade support on TPM's.
 * Add support for IRQ (interrupt line)
 
 ## Support

examples/firmware/ifx_fw_update.c

@@ -94,35 +94,26 @@ static const char* TPM2_IFX_GetOpModeStr(int opMode)
     return opModeStr;
 }
 
-static int TPM2_IFX_PrintInfo(WOLFTPM2_DEV* dev)
+static void TPM2_IFX_PrintInfo(WOLFTPM2_CAPS* caps)
 {
-    int rc;
-    WOLFTPM2_CAPS caps;
-    rc = wolfTPM2_GetCapabilities(dev, &caps);
-    if (rc == TPM_RC_SUCCESS) {
-        printf("Mfg %s (%d), Vendor %s, Fw %u.%u (0x%x)\n",
-            caps.mfgStr, caps.mfg, caps.vendorStr, caps.fwVerMajor,
-            caps.fwVerMinor, caps.fwVerVendor);
-        printf("Operational mode: %s (0x%x)\n",
-            TPM2_IFX_GetOpModeStr(caps.opMode), caps.opMode);
-        printf("KeyGroupId 0x%x, FwCounter %d (%d same)\n",
-            caps.keyGroupId, caps.fwCounter, caps.fwCounterSame);
-        if (caps.keyGroupId == 0) {
-            printf("Error getting key group id from TPM!\n");
-            rc = -1;
-        }
-    }
-    return rc;
+    printf("Mfg %s (%d), Vendor %s, Fw %u.%u (0x%x)\n",
+        caps->mfgStr, caps->mfg, caps->vendorStr, caps->fwVerMajor,
+        caps->fwVerMinor, caps->fwVerVendor);
+    printf("Operational mode: %s (0x%x)\n",
+        TPM2_IFX_GetOpModeStr(caps->opMode), caps->opMode);
+    printf("KeyGroupId 0x%x, FwCounter %d (%d same)\n",
+        caps->keyGroupId, caps->fwCounter, caps->fwCounterSame);
 }
 
 int TPM2_IFX_Firmware_Update(void* userCtx, int argc, char *argv[])
 {
     int rc;
     WOLFTPM2_DEV dev;
+    WOLFTPM2_CAPS caps;
     const char* manifest_file = NULL;
     const char* firmware_file = NULL;
     fw_info_t fwinfo;
-    int abandon = 0;
+    int abandon = 0, recovery = 0;
 
     XMEMSET(&fwinfo, 0, sizeof(fwinfo));
 
@@ -156,10 +147,18 @@ int TPM2_IFX_Firmware_Update(void* userCtx, int argc, char *argv[])
         goto exit;
     }
 
-    rc = TPM2_IFX_PrintInfo(&dev);
-    if (rc != 0) {
+    rc = wolfTPM2_GetCapabilities(&dev, &caps);
+    if (rc != TPM_RC_SUCCESS) {
         goto exit;
     }
+    TPM2_IFX_PrintInfo(&caps);
+    if (caps.keyGroupId == 0) {
+        printf("Error getting key group id from TPM!\n");
+    }
+    if (caps.opMode == 0x02 || (caps.opMode & 0x80)) {
+        /* if opmode == 2 or 0x8x then we need to use recovery mode */
+        recovery = 1;
+    }
 
     if (abandon) {
         printf("Firmware Update Abandon:\n");
@@ -188,12 +187,21 @@ int TPM2_IFX_Firmware_Update(void* userCtx, int argc, char *argv[])
             &fwinfo.firmware_buf, &fwinfo.firmware_bufSz);
     }
     if (rc == 0) {
-        rc = wolfTPM2_FirmwareUpgrade(&dev,
-            fwinfo.manifest_buf, (uint32_t)fwinfo.manifest_bufSz,
-            TPM2_IFX_FwData_Cb, &fwinfo);
+        if (recovery) {
+            printf("Firmware Update (recovery mode):\n");
+            rc = wolfTPM2_FirmwareUpgradeRecover(&dev,
+                fwinfo.manifest_buf, (uint32_t)fwinfo.manifest_bufSz,
+                TPM2_IFX_FwData_Cb, &fwinfo);
+        }
+        else {
+            printf("Firmware Update (normal mode):\n");
+            rc = wolfTPM2_FirmwareUpgrade(&dev,
+                fwinfo.manifest_buf, (uint32_t)fwinfo.manifest_bufSz,
+                TPM2_IFX_FwData_Cb, &fwinfo);
+        }
     }
     if (rc == 0) {
-        rc = TPM2_IFX_PrintInfo(&dev);
+        TPM2_IFX_PrintInfo(&caps);
     }
 
 exit:

src/tpm2_wrap.c

@@ -7432,18 +7432,13 @@ static int tpm2_ifx_firmware_final(WOLFTPM2_DEV* dev)
     return rc;
 }
 
-int wolfTPM2_FirmwareUpgrade(WOLFTPM2_DEV* dev,
+int wolfTPM2_FirmwareUpgradeHash(WOLFTPM2_DEV* dev, TPM_ALG_ID hashAlg,
+    uint8_t* manifest_hash, uint32_t manifest_hash_sz,
     uint8_t* manifest, uint32_t manifest_sz,
     wolfTPM2FwDataCb cb, void* cb_ctx)
 {
     int rc;
     WOLFTPM2_CAPS caps;
-    TPM_ALG_ID hashAlg;
-    uint8_t  manifest_hash[TPM_SHA384_DIGEST_SIZE];
-    uint32_t manifest_hash_sz = (uint32_t)sizeof(manifest_hash);
-
-    /* Can use SHA2-384 or SHA2-512 for manifest hash */
-    hashAlg = TPM_ALG_SHA384;
 
     /* check the operational mode */
     rc = wolfTPM2_GetCapabilities(dev, &caps);
@@ -7456,16 +7451,12 @@ int wolfTPM2_FirmwareUpgrade(WOLFTPM2_DEV* dev,
             return tpm2_ifx_firmware_final(dev);
         }
     }
-
-    if (rc == TPM_RC_SUCCESS) {
-        /* hash the manifest */
-        rc = wc_Sha384Hash(manifest, manifest_sz, manifest_hash);
-    }
-    if (rc == TPM_RC_SUCCESS) {
+    if (rc == TPM_RC_SUCCESS && caps.opMode == 0x00) {
         rc = tpm2_ifx_firmware_enable_policy(dev);
-    }
-    if (rc == TPM_RC_SUCCESS) {
-        rc = tpm2_ifx_firmware_start(dev, hashAlg, manifest_hash, manifest_hash_sz);
+        if (rc == TPM_RC_SUCCESS) {
+            rc = tpm2_ifx_firmware_start(dev, hashAlg,
+                manifest_hash, manifest_hash_sz);
+        }
     }
     if (rc == TPM_RC_SUCCESS) {
         rc = tpm2_ifx_firmware_manifest(dev, manifest, manifest_sz);
@@ -7485,6 +7476,37 @@ int wolfTPM2_FirmwareUpgrade(WOLFTPM2_DEV* dev,
     return rc;
 }
 
+int wolfTPM2_FirmwareUpgrade(WOLFTPM2_DEV* dev,
+    uint8_t* manifest, uint32_t manifest_sz,
+    wolfTPM2FwDataCb cb, void* cb_ctx)
+{
+    int rc;
+    uint8_t manifest_hash[TPM_SHA384_DIGEST_SIZE];
+
+    /* hash the manifest */
+    rc = wc_Sha384Hash(manifest, manifest_sz, manifest_hash);
+    if (rc == 0) {
+        rc = wolfTPM2_FirmwareUpgradeHash(dev, TPM_ALG_SHA384,
+            manifest_hash, (uint32_t)sizeof(manifest_hash),
+            manifest, manifest_sz, cb, cb_ctx);
+    }
+    return rc;
+}
+
+int wolfTPM2_FirmwareUpgradeRecover(WOLFTPM2_DEV* dev,
+    uint8_t* manifest, uint32_t manifest_sz,
+    wolfTPM2FwDataCb cb, void* cb_ctx)
+{
+    uint8_t manifest_hash[TPM_SHA384_DIGEST_SIZE];
+
+    /* recovery mode manifest hash is all 0x3C */
+    XMEMSET(manifest_hash, 0x3C, sizeof(manifest_hash));
+
+    return wolfTPM2_FirmwareUpgradeHash(dev, TPM_ALG_SHA384,
+            manifest_hash, (uint32_t)sizeof(manifest_hash),
+            manifest, manifest_sz, cb, cb_ctx);
+}
+
 /* terminate a firmware update */
 int wolfTPM2_FirmwareUpgradeCancel(WOLFTPM2_DEV* dev)
 {

wolftpm/tpm2_wrap.h

@@ -3578,9 +3578,17 @@ WOLFTPM_LOCAL int GetKeyTemplateECC(TPMT_PUBLIC* publicTemplate,
 typedef int (*wolfTPM2FwDataCb)(
     uint8_t* data, uint32_t data_req_sz, uint32_t offset, void* cb_ctx);
 
+WOLFTPM_API int wolfTPM2_FirmwareUpgradeHash(WOLFTPM2_DEV* dev,
+    TPM_ALG_ID hashAlg, /* Can use SHA2-384 or SHA2-512 for manifest hash */
+    uint8_t* manifest_hash, uint32_t manifest_hash_sz,
+    uint8_t* manifest, uint32_t manifest_sz,
+    wolfTPM2FwDataCb cb, void* cb_ctx);
 WOLFTPM_API int wolfTPM2_FirmwareUpgrade(WOLFTPM2_DEV* dev,
     uint8_t* manifest, uint32_t manifest_sz,
     wolfTPM2FwDataCb cb, void* cb_ctx);
+WOLFTPM_API int wolfTPM2_FirmwareUpgradeRecover(WOLFTPM2_DEV* dev,
+    uint8_t* manifest, uint32_t manifest_sz,
+    wolfTPM2FwDataCb cb, void* cb_ctx);
 WOLFTPM_API int wolfTPM2_FirmwareUpgradeCancel(WOLFTPM2_DEV* dev);
 
 #endif /* WOLFTPM_FIRMWARE_UPGRADE */