mirror of
https://github.com/stefanberger/libtpms
synced 2026-01-11 16:51:29 +00:00
158 lines
6.3 KiB
C
158 lines
6.3 KiB
C
/********************************************************************************/
|
|
/* */
|
|
/* */
|
|
/* Written by Ken Goldman */
|
|
/* IBM Thomas J. Watson Research Center */
|
|
/* */
|
|
/* Licenses and Notices */
|
|
/* */
|
|
/* 1. Copyright Licenses: */
|
|
/* */
|
|
/* - Trusted Computing Group (TCG) grants to the user of the source code in */
|
|
/* this specification (the "Source Code") a worldwide, irrevocable, */
|
|
/* nonexclusive, royalty free, copyright license to reproduce, create */
|
|
/* derivative works, distribute, display and perform the Source Code and */
|
|
/* derivative works thereof, and to grant others the rights granted herein. */
|
|
/* */
|
|
/* - The TCG grants to the user of the other parts of the specification */
|
|
/* (other than the Source Code) the rights to reproduce, distribute, */
|
|
/* display, and perform the specification solely for the purpose of */
|
|
/* developing products based on such documents. */
|
|
/* */
|
|
/* 2. Source Code Distribution Conditions: */
|
|
/* */
|
|
/* - Redistributions of Source Code must retain the above copyright licenses, */
|
|
/* this list of conditions and the following disclaimers. */
|
|
/* */
|
|
/* - Redistributions in binary form must reproduce the above copyright */
|
|
/* licenses, this list of conditions and the following disclaimers in the */
|
|
/* documentation and/or other materials provided with the distribution. */
|
|
/* */
|
|
/* 3. Disclaimers: */
|
|
/* */
|
|
/* - THE COPYRIGHT LICENSES SET FORTH ABOVE DO NOT REPRESENT ANY FORM OF */
|
|
/* LICENSE OR WAIVER, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, WITH */
|
|
/* RESPECT TO PATENT RIGHTS HELD BY TCG MEMBERS (OR OTHER THIRD PARTIES) */
|
|
/* THAT MAY BE NECESSARY TO IMPLEMENT THIS SPECIFICATION OR OTHERWISE. */
|
|
/* Contact TCG Administration (admin@trustedcomputinggroup.org) for */
|
|
/* information on specification licensing rights available through TCG */
|
|
/* membership agreements. */
|
|
/* */
|
|
/* - THIS SPECIFICATION IS PROVIDED "AS IS" WITH NO EXPRESS OR IMPLIED */
|
|
/* WARRANTIES WHATSOEVER, INCLUDING ANY WARRANTY OF MERCHANTABILITY OR */
|
|
/* FITNESS FOR A PARTICULAR PURPOSE, ACCURACY, COMPLETENESS, OR */
|
|
/* NONINFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS, OR ANY WARRANTY */
|
|
/* OTHERWISE ARISING OUT OF ANY PROPOSAL, SPECIFICATION OR SAMPLE. */
|
|
/* */
|
|
/* - Without limitation, TCG and its members and licensors disclaim all */
|
|
/* liability, including liability for infringement of any proprietary */
|
|
/* rights, relating to use of information in this specification and to the */
|
|
/* implementation of this specification, and TCG disclaims all liability for */
|
|
/* cost of procurement of substitute goods or services, lost profits, loss */
|
|
/* of use, loss of data or any incidental, consequential, direct, indirect, */
|
|
/* or special damages, whether under contract, tort, warranty or otherwise, */
|
|
/* arising in any way out of use or reliance upon this specification or any */
|
|
/* information herein. */
|
|
/* */
|
|
/* (c) Copyright IBM Corp. and others, 2023 */
|
|
/* */
|
|
/********************************************************************************/
|
|
|
|
//
|
|
// This file defines the PCR and PCR_Attributes structures and
|
|
// related interface functions
|
|
//
|
|
|
|
#ifndef _PCRSTRUCT_H_
|
|
#define _PCRSTRUCT_H_
|
|
|
|
#include "BaseTypes.h"
|
|
#include "TpmAlgorithmDefines.h"
|
|
#include "TpmTypes.h"
|
|
|
|
// a single PCR
|
|
typedef struct
|
|
{
|
|
#if ALG_SHA1
|
|
BYTE Sha1Pcr[SHA1_DIGEST_SIZE];
|
|
#endif
|
|
#if ALG_SHA256
|
|
BYTE Sha256Pcr[SHA256_DIGEST_SIZE];
|
|
#endif
|
|
#if ALG_SHA384
|
|
BYTE Sha384Pcr[SHA384_DIGEST_SIZE]; // libtpms: appended 'pcr'
|
|
#endif
|
|
#if ALG_SHA512
|
|
BYTE Sha512Pcr[SHA512_DIGEST_SIZE]; // libtpms: appended 'pcr'
|
|
#endif
|
|
#if ALG_SM3_256
|
|
BYTE Sm3_256[SM3_256_DIGEST_SIZE];
|
|
#endif
|
|
#if ALG_SHA3_256
|
|
BYTE Sha3_256[SHA3_256_DIGEST_SIZE];
|
|
#endif
|
|
#if ALG_SHA3_384
|
|
BYTE Sha3_384[SHA3_384_DIGEST_SIZE];
|
|
#endif
|
|
#if ALG_SHA3_512
|
|
BYTE Sha3_512[SHA3_512_DIGEST_SIZE];
|
|
#endif
|
|
} PCR;
|
|
|
|
// see the comments below for supportsPolicyAuth to explain this
|
|
#define MAX_PCR_GROUP_BITS 3
|
|
|
|
typedef struct
|
|
{
|
|
// SET if the PCR value should be saved in state save
|
|
unsigned int stateSave : 1;
|
|
|
|
// SET if the PCR is part of the "TCB group", causes the PCR counter not to increment
|
|
unsigned int doNotIncrementPcrCounter : 1;
|
|
|
|
// PCRs may support policy or auth-value authorization.
|
|
//
|
|
// Such authorization values, if supported, are set by
|
|
// TPM2_PCR_SetAuthPolicy and/or TPM2_PCR_SetAuthValue.
|
|
//
|
|
// PCRs that share the same policy/auth value are said to be in a "group".
|
|
// PCRs that don't support authorization are said to be in group Zero.
|
|
//
|
|
// Group numbers are only used internally to indicate which PCRs share an
|
|
// authorization value. IOW the TPM client cannot refer to PCRs by group
|
|
// number; the range of group numbers is implementation defined. zero
|
|
// indicates the PCR doesn't support policy or auth verification.
|
|
//
|
|
// The size of this field must be large enough to support
|
|
// NUM_POLICY_PCR_GROUP & NUM_AUTHVALUE_PCR_GROUP; the maximum number of groups
|
|
// actually supported by this build of the core library.
|
|
//
|
|
// The number of bits allocated here does not control the number of groups,
|
|
// but there is a static assert that the number of bits here is large
|
|
// enough.
|
|
unsigned int policyAuthGroup : MAX_PCR_GROUP_BITS;
|
|
unsigned int authValuesGroup : MAX_PCR_GROUP_BITS;
|
|
|
|
// these bitfields indicating the localities that can
|
|
// reset or extend this PCR. A SET bit indicates the PCR can
|
|
// be extended or reset from that locality. The low-order bit in
|
|
// each field is locality zero, and the high-order bit is locality 4.
|
|
unsigned int resetLocality : 5;
|
|
unsigned int extendLocality : 5;
|
|
} PCR_Attributes;
|
|
|
|
// Get pointer to particular PCR from array if that PCR is allocated.
|
|
// otherwise returns NULL
|
|
BYTE* GetPcrPointerIfAllocated(PCR* pPcrArray,
|
|
TPM_ALG_ID alg, // IN: algorithm for bank
|
|
UINT32 pcrNumber // IN: PCR number
|
|
);
|
|
|
|
// get a PCR pointer from the TPM's internal list, if it's allocated
|
|
// otherwise NULL
|
|
BYTE* GetPcrPointer(TPM_ALG_ID alg, // IN: algorithm for bank
|
|
UINT32 pcrNumber // IN: PCR number
|
|
);
|
|
|
|
#endif
|