// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

//! Shared TPM protocol constants and helpers used across the vTPM stack.

#![forbid(unsafe_code)]

pub mod tpm20proto;

use tpm20proto::NV_INDEX_RANGE_BASE_PLATFORM_MANUFACTURER;
use tpm20proto::NV_INDEX_RANGE_BASE_TCG_ASSIGNED;
use tpm20proto::ReservedHandle;
use tpm20proto::TPM20_HT_PERSISTENT;
use tpm20proto::TpmaNvBits;
use tpm20proto::TpmaObject;
use tpm20proto::TpmaObjectBits;

// --- Reserved handles for Storage Primary Key ranges from 0x81000000 – 0x810000ff ---

/// Reserved handle for the Storage Root Key (SRK).
pub const TPM_RSA_SRK_HANDLE: ReservedHandle = ReservedHandle::new(TPM20_HT_PERSISTENT, 0x01);

/// Reserved handle for the Azure-provisioned Attestation Key (AK).
pub const TPM_AZURE_AIK_HANDLE: ReservedHandle = ReservedHandle::new(TPM20_HT_PERSISTENT, 0x03);

/// Reserved handle for the persisted guest secret key.
pub const TPM_GUEST_SECRET_HANDLE: ReservedHandle = ReservedHandle::new(TPM20_HT_PERSISTENT, 0x04);

// --- Reserved handles for Microsoft (Component OEM) ranges from 0x01c101c0 to 0x01c101ff ---

/// NV index used to store the attestation key certificate payload.
pub const TPM_NV_INDEX_AIK_CERT: u32 = NV_INDEX_RANGE_BASE_TCG_ASSIGNED + 0x0001_01d0;

/// NV index used to mark that legacy vTPM mitigation has been applied.
pub const TPM_NV_INDEX_MITIGATED: u32 = NV_INDEX_RANGE_BASE_TCG_ASSIGNED + 0x0001_01d2;

// --- Reserved handles for Platform ranges from 0x01400000 to 0x017fffff ---

/// NV index used to persist the most recent attestation report.
pub const TPM_NV_INDEX_ATTESTATION_REPORT: u32 =
    NV_INDEX_RANGE_BASE_PLATFORM_MANUFACTURER + 0x0000_0001;

/// NV index used to persist the latest guest attestation input blob.
pub const TPM_NV_INDEX_GUEST_ATTESTATION_INPUT: u32 =
    NV_INDEX_RANGE_BASE_PLATFORM_MANUFACTURER + 0x0000_0002;

/// Expected object attributes for a correctly provisioned Attestation Key.
pub fn expected_ak_attributes() -> TpmaObject {
    TpmaObjectBits::new()
        .with_fixed_tpm(true)
        .with_fixed_parent(true)
        .with_sensitive_data_origin(true)
        .with_user_with_auth(true)
        .with_no_da(true)
        .with_restricted(true)
        .with_sign_encrypt(true)
        .into()
}

/// Expected NVRAM index attributes for a platform-created AKCert index.
pub fn platform_akcert_attributes() -> TpmaNvBits {
    TpmaNvBits::new()
        .with_nv_authread(true)
        .with_nv_authwrite(true)
        .with_nv_ownerread(true)
        .with_nv_platformcreate(true)
        .with_nv_no_da(true)
}

/// Default vTPM version provisioned for a new VMGS.
pub const TPM_DEFAULT_VERSION: &str = "1.38";

/// Default NVRAM index size provisioned for AKCert.
pub const TPM_DEFAULT_AKCERT_SIZE: usize = 4096;
