/********************************************************************************/
/*										*/
/*		fUnctions that return the type of a handle.	     		*/
/*			     Written by Ken Goldman				*/
/*		       IBM Thomas J. Watson Research Center			*/
/*            $Id: Handle.c 1047 2017-07-20 18:27:34Z kgoldman $			*/
/*										*/
/*  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, 2016, 2017				*/
/*										*/
/********************************************************************************/

/* 9.6 Handle.c */
/* 9.6.1 Description */
/* This file contains the functions that return the type of a handle. */
/* 9.6.2 Includes */
#include "Tpm.h"
/* 9.6.3 Functions */
/* 9.6.3.1 HandleGetType() */
/* This function returns the type of a handle which is the MSO of the handle. */
TPM_HT
HandleGetType(
	      TPM_HANDLE       handle         // IN: a handle to be checked
	      )
{
    // return the upper bytes of input data
    return (TPM_HT)((handle & HR_RANGE_MASK) >> HR_SHIFT);
}
/* 9.6.3.2 NextPermanentHandle() */
/* This function returns the permanent handle that is equal to the input value or is the next higher
   value. If there is no handle with the input value and there is no next higher value, it returns
   0: */
TPM_HANDLE
NextPermanentHandle(
		    TPM_HANDLE       inHandle       // IN: the handle to check
		    )
{
    // If inHandle is below the start of the range of permanent handles
    // set it to the start and scan from there
    if(inHandle < TPM_RH_FIRST)
	inHandle = TPM_RH_FIRST;
    // scan from input value until we find an implemented permanent handle
    // or go out of range
    for(; inHandle <= TPM_RH_LAST; inHandle++)
	{
	    switch(inHandle)
		{
		  case TPM_RH_OWNER:
		  case TPM_RH_NULL:
		  case TPM_RS_PW:
		  case TPM_RH_LOCKOUT:
		  case TPM_RH_ENDORSEMENT:
		  case TPM_RH_PLATFORM:
		  case TPM_RH_PLATFORM_NV:
#ifdef  VENDOR_PERMANENT
		  case VENDOR_PERMANENT:
#endif
		    return inHandle;
		    break;
		  default:
		    break;
		}
	}
    // Out of range on the top
    return 0;
}
/* 9.6.3.3 PermanentCapGetHandles() */
/* This function returns a list of the permanent handles of PCR, started from handle. If handle is
   larger than the largest permanent handle, an empty list will be returned with more set to NO. */
/* Return Values Meaning */
/* YES if there are more handles available */
/* NO all the available handles has been returned */
TPMI_YES_NO
PermanentCapGetHandles(
		       TPM_HANDLE       handle,        // IN: start handle
		       UINT32           count,         // IN: count of returned handles
		       TPML_HANDLE     *handleList     // OUT: list of handle
		       )
{
    TPMI_YES_NO     more = NO;
    UINT32          i;
    pAssert(HandleGetType(handle) == TPM_HT_PERMANENT);
    // Initialize output handle list
    handleList->count = 0;
    // The maximum count of handles we may return is MAX_CAP_HANDLES
    if(count > MAX_CAP_HANDLES) count = MAX_CAP_HANDLES;
    // Iterate permanent handle range
    for(i = NextPermanentHandle(handle);
	i != 0; i = NextPermanentHandle(i + 1))
	{
	    if(handleList->count < count)
		{
		    // If we have not filled up the return list, add this permanent
		    // handle to it
		    handleList->handle[handleList->count] = i;
		    handleList->count++;
		}
	    else
		{
		    // If the return list is full but we still have permanent handle
		    // available, report this and stop iterating
		    more = YES;
		    break;
		}
	}
    return more;
}
/* 9.6.3.4 PermanentHandleGetPolicy() */
/* This function returns a list of the permanent handles of PCR, started from handle. If handle is
   larger than the largest permanent handle, an empty list will be returned with more set to NO. */
/* Return Values Meaning */
/* YES if there are more handles available */
/* NO all the available handles has been returned */
TPMI_YES_NO
PermanentHandleGetPolicy(
			 TPM_HANDLE           handle,        // IN: start handle
			 UINT32               count,         // IN: max count of returned handles
			 TPML_TAGGED_POLICY  *policyList     // OUT: list of handle
			 )
{
    TPMI_YES_NO     more = NO;
    pAssert(HandleGetType(handle) == TPM_HT_PERMANENT);
    // Initialize output handle list
    policyList->count = 0;
    // The maximum count of policies we may return is MAX_TAGGED_POLICIES
    if(count > MAX_TAGGED_POLICIES)
	count = MAX_TAGGED_POLICIES;
    // Iterate permanent handle range
    for(handle = NextPermanentHandle(handle);
	handle != 0;
	handle = NextPermanentHandle(handle + 1))
	{
	    TPM2B_DIGEST    policyDigest;
	    TPM_ALG_ID      policyAlg;
	    // Check to see if this permanent handle has a policy
	    policyAlg = EntityGetAuthPolicy(handle, &policyDigest);
	    if(policyAlg == TPM_ALG_ERROR)
		continue;
	    if(policyList->count < count)
		{
		    // If we have not filled up the return list, add this
		    // policy to the list;
		    policyList->policies[policyList->count].handle = handle;
		    policyList->policies[policyList->count].policyHash.hashAlg = policyAlg;
		    MemoryCopy(&policyList->policies[policyList->count].policyHash.digest,
			       policyDigest.t.buffer, policyDigest.t.size);
		    policyList->count++;
		}
	    else
		{
		    // If the return list is full but we still have permanent handle
		    // available, report this and stop iterating
		    more = YES;
		    break;
		}
	}
    return more;
}
