keymgr_testutils.c

// Copyright lowRISC contributors (OpenTitan project).
// Licensed under the Apache License, Version 2.0, see LICENSE for details.
// SPDX-License-Identifier: Apache-2.0
 
#include "sw/device/lib/testing/keymgr_testutils.h"
 
#include "hw/top/dt/otp_ctrl.h"
#include "sw/device/lib/arch/boot_stage.h"
#include "sw/device/lib/dif/dif_flash_ctrl.h"
#include "sw/device/lib/dif/dif_keymgr.h"
#include "sw/device/lib/dif/dif_otp_ctrl.h"
#include "sw/device/lib/dif/dif_rstmgr.h"
#include "sw/device/lib/runtime/log.h"
#include "sw/device/lib/testing/entropy_testutils.h"
#include "sw/device/lib/testing/flash_ctrl_testutils.h"
#include "sw/device/lib/testing/kmac_testutils.h"
#include "sw/device/lib/testing/otp_ctrl_testutils.h"
#include "sw/device/lib/testing/rstmgr_testutils.h"
#include "sw/device/lib/testing/test_framework/check.h"
#include "sw/device/silicon_creator/lib/base/chip.h"
#include "sw/device/silicon_creator/lib/drivers/retention_sram.h"
 
#include "hw/top_egret/sw/autogen/top_egret.h"
 
#define MODULE_ID MAKE_MODULE_ID('k', 'm', 't')
 
enum {
  /** Flash Secret partition ID. */
  kFlashInfoPartitionId = 0,
 
  /** Secret partition flash bank ID. */
  kFlashInfoBankId = 0,
 
  /** Creator Secret flash info page ID. */
  kFlashInfoPageIdCreatorSecret = 1,
 
  /** Owner Secret flash info page ID. */
  kFlashInfoPageIdOwnerSecret = 2,
};
 
const static char *kKeymgrStageNames[] = {
    [kDifKeymgrStateReset] = "Reset",
    [kDifKeymgrStateInitialized] = "Init",
    [kDifKeymgrStateCreatorRootKey] = "CreatorRootKey",
    [kDifKeymgrStateOwnerIntermediateKey] = "OwnerIntKey",
    [kDifKeymgrStateOwnerRootKey] = "OwnerKey",
    [kDifKeymgrStateDisabled] = "Disabled",
    [kDifKeymgrStateInvalid] = "Invalid",
};
 
static status_t write_info_page(dif_flash_ctrl_state_t *flash, uint32_t page_id,
                                const keymgr_testutils_secret_t *data,
                                bool scramble) {
  uint32_t address = 0;
  if (scramble) {
    TRY(flash_ctrl_testutils_info_region_scrambled_setup(
        flash, page_id, kFlashInfoBankId, kFlashInfoPartitionId, &address));
  } else {
    TRY(flash_ctrl_testutils_info_region_setup(
        flash, page_id, kFlashInfoBankId, kFlashInfoPartitionId, &address));
  }
 
  TRY(flash_ctrl_testutils_erase_and_write_page(
      flash, address, kFlashInfoPartitionId, data->value,
      kDifFlashCtrlPartitionTypeInfo, ARRAYSIZE(data->value)));
 
  keymgr_testutils_secret_t readback_data;
  TRY(flash_ctrl_testutils_read(
      flash, address, kFlashInfoPartitionId, readback_data.value,
      kDifFlashCtrlPartitionTypeInfo, ARRAYSIZE(readback_data.value), 0));
  TRY_CHECK(memcmp(data->value, readback_data.value, sizeof(data->value)) == 0);
  return OK_STATUS();
}
 
status_t keymgr_testutils_flash_init(
    dif_flash_ctrl_state_t *flash,
    const keymgr_testutils_secret_t *creator_secret,
    const keymgr_testutils_secret_t *owner_secret) {
  // Initialize flash secrets.
  if (creator_secret) {
    write_info_page(flash, kFlashInfoPageIdCreatorSecret, creator_secret,
                    /*scramble=*/true);
  }
  write_info_page(flash, kFlashInfoPageIdOwnerSecret, owner_secret,
                  /*scramble=*/true);
  return OK_STATUS();
}
 
static status_t check_lock_otp_partition(void) {
  dif_otp_ctrl_t otp;
  TRY(dif_otp_ctrl_init_from_dt(kDtOtpCtrl, &otp));
 
  bool is_computed;
  TRY(dif_otp_ctrl_is_digest_computed(&otp, kDifOtpCtrlPartitionSecret2,
                                      &is_computed));
  if (is_computed) {
    uint64_t digest;
    TRY(dif_otp_ctrl_get_digest(&otp, kDifOtpCtrlPartitionSecret2, &digest));
    LOG_INFO("OTP partition locked. Digest: %x-%x", ((uint32_t *)&digest)[0],
             ((uint32_t *)&digest)[1]);
    return OK_STATUS();
  }
 
  TRY(otp_ctrl_testutils_lock_partition(&otp, kDifOtpCtrlPartitionSecret2, 0));
  return OK_STATUS();
}
 
static status_t dif_init(dif_keymgr_t *keymgr, dif_kmac_t *kmac) {
  // Initialize KMAC in preparation for keymgr use.
  TRY(dif_kmac_init(mmio_region_from_addr(TOP_EGRET_KMAC_BASE_ADDR), kmac));
 
  // We shouldn't use the KMAC block's default entropy setting for keymgr, so
  // configure it to use software entropy (and a sideloaded key, although it
  // shouldn't matter here and tests should reconfigure if needed).
  TRY(kmac_testutils_config(kmac, /*sideload=*/true));
 
  // Initialize keymgr context.
  TRY(dif_keymgr_init(mmio_region_from_addr(TOP_EGRET_KEYMGR_BASE_ADDR),
                      keymgr));
  return OK_STATUS();
}
 
status_t keymgr_initialize_sim_dv(dif_keymgr_t *keymgr, dif_kmac_t *kmac) {
  // Initialize keymgr and advance to CreatorRootKey state.
  TRY(keymgr_testutils_startup(keymgr, kmac));
  LOG_INFO("Keymgr entered CreatorRootKey State");
  // Generate identity at CreatorRootKey (to follow same sequence and reuse
  // chip_sw_keymgr_key_derivation_vseq.sv).
  TRY(keymgr_testutils_generate_identity(
      keymgr,
      (dif_keymgr_identity_seed_params_t){.cdi_type = kDifKeymgrSealingCdi}));
  LOG_INFO("Keymgr generated identity at CreatorRootKey State");
 
  // Advance to OwnerIntermediateKey state and check that the state is correct.
  // The sim_dv testbench expects this state.
  TRY(keymgr_testutils_advance_state(keymgr, &kOwnerIntParams));
  TRY(keymgr_testutils_check_state(keymgr,
                                   kDifKeymgrStateOwnerIntermediateKey));
  LOG_INFO("Keymgr entered OwnerIntKey State");
  return OK_STATUS();
}
 
status_t keymgr_initialize_sival(dif_keymgr_t *keymgr, dif_kmac_t *kmac) {
  dif_keymgr_state_t keymgr_state;
  TRY(keymgr_testutils_try_startup(keymgr, kmac, &keymgr_state));
 
  if (keymgr_state == kDifKeymgrStateInitialized) {
    TRY(keymgr_testutils_advance_state(keymgr, &kOwnerIntParams));
    TRY(dif_keymgr_get_state(keymgr, &keymgr_state));
  }
 
  if (keymgr_state == kDifKeymgrStateOwnerIntermediateKey) {
    TRY(keymgr_testutils_advance_state(keymgr, &kOwnerRootKeyParams));
  }
 
  return keymgr_testutils_check_state(keymgr, kDifKeymgrStateOwnerRootKey);
}
 
status_t keymgr_testutils_initialize(dif_keymgr_t *keymgr, dif_kmac_t *kmac) {
  if (kBootStage == kBootStageOwner) {
    return keymgr_initialize_sival(keymgr, kmac);
  }
  // All other configurations use the sim_dv initialization.
  return keymgr_initialize_sim_dv(keymgr, kmac);
}
 
status_t keymgr_testutils_try_startup(dif_keymgr_t *keymgr, dif_kmac_t *kmac,
                                      dif_keymgr_state_t *keymgr_state) {
  TRY(dif_init(keymgr, kmac));
 
  // Check keymgr state. If initialized, there is no need to proceed with
  // the initialization process.
  TRY(dif_keymgr_get_state(keymgr, keymgr_state));
 
  if (*keymgr_state == kDifKeymgrStateInvalid ||
      *keymgr_state == kDifKeymgrStateDisabled) {
    LOG_INFO("Unexpected keymgr state: 0x%x", keymgr_state);
    return INTERNAL();
  }
 
  if (*keymgr_state == kDifKeymgrStateReset) {
    TRY(keymgr_testutils_startup(keymgr, kmac));
    TRY(dif_keymgr_get_state(keymgr, keymgr_state));
  }
 
  return OK_STATUS();
}
 
status_t keymgr_testutils_init_nvm_then_reset(void) {
  dif_flash_ctrl_state_t flash;
  dif_rstmgr_t rstmgr;
  dif_otp_ctrl_t otp_ctrl;
 
  TRY(dif_rstmgr_init(mmio_region_from_addr(TOP_EGRET_RSTMGR_AON_BASE_ADDR),
                      &rstmgr));
  const dif_rstmgr_reset_info_bitfield_t reset_info =
      rstmgr_testutils_reason_get();
 
  // POR reset.
  if (reset_info == kDifRstmgrResetInfoPor) {
    LOG_INFO("Powered up for the first time, program flash");
 
    TRY(dif_flash_ctrl_init_state(
        &flash, mmio_region_from_addr(TOP_EGRET_FLASH_CTRL_CORE_BASE_ADDR)));
    TRY(dif_otp_ctrl_init(
        mmio_region_from_addr(TOP_EGRET_OTP_CTRL_CORE_BASE_ADDR), &otp_ctrl));
 
    bool secret2_computed = false;
    TRY(dif_otp_ctrl_is_digest_computed(&otp_ctrl, kDifOtpCtrlPartitionSecret2,
                                        &secret2_computed));
 
    // Only initialise the creator secret if `SECRET2` digest has not been
    // computed. `flash_ctrl` will throw a recoverable error if we try to write
    // this afterwards.
    const keymgr_testutils_secret_t *creator_secret = NULL;
    if (!secret2_computed) {
      creator_secret = &kCreatorSecret;
    }
    TRY(keymgr_testutils_flash_init(&flash, creator_secret, &kOwnerSecret));
 
    TRY(check_lock_otp_partition());
 
    // Reboot device.
    LOG_INFO("Requesting a reset to make OTP partitions accessible to keymgr");
    rstmgr_testutils_reason_clear();
    TRY(dif_rstmgr_software_device_reset(&rstmgr));
 
    // Wait here until device reset.
    wait_for_interrupt();
 
    // Should never reach this.
    return INTERNAL();
 
  } else {
    // Not POR reset: this function has done its job (or can't run because it's
    // supposed to run after POR).
    return OK_STATUS();
  }
}
 
status_t keymgr_testutils_startup(dif_keymgr_t *keymgr, dif_kmac_t *kmac) {
  dif_rstmgr_t rstmgr;
 
  // Check the last word of the retention SRAM creator area to determine the
  // type of the ROM.
  bool is_using_test_rom =
      retention_sram_get()
          ->creator
          .reserved[ARRAYSIZE((retention_sram_t){0}.creator.reserved) - 1] ==
      TEST_ROM_IDENTIFIER;
 
  TRY(keymgr_testutils_init_nvm_then_reset());
 
  TRY(dif_rstmgr_init(mmio_region_from_addr(TOP_EGRET_RSTMGR_AON_BASE_ADDR),
                      &rstmgr));
  const dif_rstmgr_reset_info_bitfield_t info = rstmgr_testutils_reason_get();
 
  TRY_CHECK(info == kDifRstmgrResetInfoSw, "Unexpected reset reason: %08x",
            info);
 
  LOG_INFO("Initializing entropy complex in Auto mode");
 
  TRY(entropy_testutils_auto_mode_init());
 
  LOG_INFO("Powered up for the second time, actuate keymgr and perform test.");
 
  TRY(dif_init(keymgr, kmac));
 
  // Advance to Initialized state.
  TRY(keymgr_testutils_check_state(keymgr, kDifKeymgrStateReset));
  TRY(keymgr_testutils_advance_state(keymgr, NULL));
  TRY(keymgr_testutils_check_state(keymgr, kDifKeymgrStateInitialized));
  LOG_INFO("Keymgr entered Init State");
 
  // Advance to CreatorRootKey state.
  if (is_using_test_rom) {
    LOG_INFO("Using test_rom, setting inputs and advancing state...");
    TRY(keymgr_testutils_advance_state(keymgr, &kCreatorParams));
  } else {
    LOG_INFO("Using rom, only advancing state...");
    TRY(dif_keymgr_advance_state_raw(keymgr));
    TRY(keymgr_testutils_wait_for_operation_done(keymgr));
  }
  TRY(keymgr_testutils_check_state(keymgr, kDifKeymgrStateCreatorRootKey));
  LOG_INFO("Keymgr entered CreatorRootKey State");
 
  // Identity generation is not really necessary for all tests, but it is
  // added to make sure each test using this function is also compatible with
  // the DV_WAIT sequences from keymgr_key_derivation vseq
  TRY(keymgr_testutils_generate_identity(
      keymgr,
      (dif_keymgr_identity_seed_params_t){.cdi_type = kDifKeymgrSealingCdi}));
  LOG_INFO("Keymgr generated identity at CreatorRootKey State");
 
  return OK_STATUS();
}
 
status_t keymgr_testutils_advance_state(
    const dif_keymgr_t *keymgr, const dif_keymgr_state_params_t *params) {
  TRY(dif_keymgr_advance_state(keymgr, params));
  return keymgr_testutils_wait_for_operation_done(keymgr);
}
 
status_t keymgr_testutils_check_state(const dif_keymgr_t *keymgr,
                                      const dif_keymgr_state_t exp_state) {
  dif_keymgr_state_t act_state;
  TRY(dif_keymgr_get_state(keymgr, &act_state));
  TRY_CHECK(act_state == exp_state,
            "Keymgr in unexpected state: %x, expected to be %x", act_state,
            exp_state);
  return OK_STATUS();
}
 
status_t keymgr_testutils_generate_identity(
    const dif_keymgr_t *keymgr,
    const dif_keymgr_identity_seed_params_t params) {
  TRY(dif_keymgr_generate_identity_seed(keymgr, params));
  return keymgr_testutils_wait_for_operation_done(keymgr);
}
 
status_t keymgr_testutils_generate_versioned_key(
    const dif_keymgr_t *keymgr,
    const dif_keymgr_versioned_key_params_t params) {
  TRY(dif_keymgr_generate_versioned_key(keymgr, params));
  return keymgr_testutils_wait_for_operation_done(keymgr);
}
 
status_t keymgr_testutils_disable(const dif_keymgr_t *keymgr) {
  TRY(dif_keymgr_disable(keymgr));
  return keymgr_testutils_wait_for_operation_done(keymgr);
}
 
status_t keymgr_testutils_wait_for_operation_done(const dif_keymgr_t *keymgr) {
  dif_keymgr_status_codes_t status;
  do {
    TRY(dif_keymgr_get_status_codes(keymgr, &status));
  } while (status == 0);
  TRY_CHECK(status == kDifKeymgrStatusCodeIdle, "Unexpected status: %x",
            status);
  return OK_STATUS();
}
 
status_t keymgr_testutils_max_key_version_get(const dif_keymgr_t *keymgr,
                                              uint32_t *max_key_version) {
  dif_keymgr_state_t keymgr_state;
  TRY(dif_keymgr_get_state(keymgr, &keymgr_state));
 
  if (keymgr_state == kDifKeymgrStateInvalid ||
      keymgr_state == kDifKeymgrStateDisabled ||
      keymgr_state == kDifKeymgrStateReset) {
    LOG_INFO("Unexpected keymgr state: 0x%x", keymgr_state);
    return INTERNAL();
  }
 
  dif_keymgr_max_key_version_t versions;
  TRY(dif_keymgr_read_max_key_version(keymgr, &versions));
 
  switch (keymgr_state) {
    case kDifKeymgrStateCreatorRootKey:
      *max_key_version = versions.creator_max_key_version;
      break;
    case kDifKeymgrStateOwnerIntermediateKey:
      *max_key_version = versions.owner_int_max_key_version;
      break;
    case kDifKeymgrStateOwnerRootKey:
      *max_key_version = versions.owner_max_key_version;
      break;
    default:
      return INTERNAL();
  }
 
  return OK_STATUS();
}
 
status_t keymgr_testutils_state_string_get(const dif_keymgr_t *keymgr,
                                           const char **stage_name) {
  dif_keymgr_state_t state;
  CHECK_DIF_OK(dif_keymgr_get_state(keymgr, &state));
 
  if (state >= ARRAYSIZE(kKeymgrStageNames)) {
    *stage_name = NULL;
    return INTERNAL();
  }
 
  *stage_name = kKeymgrStageNames[state];
  return OK_STATUS();
}