Package tss.tpm

Class TPM2_SetPrimaryPolicy_REQUEST

java.lang.Object

tss.TpmStructure

tss.CmdStructure

tss.ReqStructure

tss.tpm.TPM2_SetPrimaryPolicy_REQUEST

All Implemented Interfaces:

TpmMarshaller

public class TPM2_SetPrimaryPolicy_REQUEST
extends ReqStructure

This command allows setting of the authorization policy for the lockout (lockoutPolicy), the platform hierarchy (platformPolicy), the storage hierarchy (ownerPolicy), and the endorsement hierarchy (endorsementPolicy). On TPMs implementing Authenticated Countdown Timers (ACT), this command may also be used to set the authorization policy for an ACT.

Field Summary

Fields

Modifier and Type	Field	Description
TPM_HANDLE	authHandle	TPM_RH_LOCKOUT, TPM_RH_ENDORSEMENT, TPM_RH_OWNER, TPMI_RH_ACT or TPM_RH_PLATFORM+{PP} Auth Index: 1 Auth Role: USER
byte[]	authPolicy	An authorization policy digest; may be the Empty Buffer If hashAlg is TPM_ALG_NULL, then this shall be an Empty Buffer.
TPM_ALG_ID	hashAlg	The hash algorithm to use for the policy If the authPolicy is an Empty Buffer, then this field shall be TPM_ALG_NULL.

Constructor Summary

Constructors

Constructor	Description
TPM2_SetPrimaryPolicy_REQUEST()
TPM2_SetPrimaryPolicy_REQUEST(TPM_HANDLE _authHandle, byte[] _authPolicy, TPM_ALG_ID _hashAlg)

Method Summary

Modifier and Type	Method	Description
static TPM2_SetPrimaryPolicy_REQUEST	fromBytes(byte[] byteBuf)	Static marshaling helper
static TPM2_SetPrimaryPolicy_REQUEST	fromTpm(byte[] byteBuf)	Deprecated. Use fromBytes(byte[]) instead
static TPM2_SetPrimaryPolicy_REQUEST	fromTpm(TpmBuffer buf)	Static marshaling helper
TPM_HANDLE[]	getHandles()
void	initFromTpm(TpmBuffer buf)	TpmMarshaller method
int	numAuthHandles()
int	numHandles()
SessEncInfo	sessEncInfo()
String	toString()
void	toStringInternal(TpmStructurePrinter _p, int d)	Serialize this object to the structure printer
byte[]	toTpm()	Deprecated. Use TpmStructure.toBytes() instead
void	toTpm(TpmBuffer buf)	TpmMarshaller method

Methods inherited from class tss.ReqStructure

typeName

Methods inherited from class tss.TpmStructure

equals, hashCode, toBytes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

authHandle

public TPM_HANDLE authHandle

TPM_RH_LOCKOUT, TPM_RH_ENDORSEMENT, TPM_RH_OWNER, TPMI_RH_ACT or TPM_RH_PLATFORM+{PP} Auth Index: 1 Auth Role: USER

authPolicy

public byte[] authPolicy

An authorization policy digest; may be the Empty Buffer If hashAlg is TPM_ALG_NULL, then this shall be an Empty Buffer.

hashAlg

public TPM_ALG_ID hashAlg

The hash algorithm to use for the policy If the authPolicy is an Empty Buffer, then this field shall be TPM_ALG_NULL.

Constructor Detail

TPM2_SetPrimaryPolicy_REQUEST

public TPM2_SetPrimaryPolicy_REQUEST()

TPM2_SetPrimaryPolicy_REQUEST

public TPM2_SetPrimaryPolicy_REQUEST(TPM_HANDLE _authHandle,
                                     byte[] _authPolicy,
                                     TPM_ALG_ID _hashAlg)

Parameters:

_authHandle - TPM_RH_LOCKOUT, TPM_RH_ENDORSEMENT, TPM_RH_OWNER, TPMI_RH_ACT or TPM_RH_PLATFORM+{PP} Auth Index: 1 Auth Role: USER

_authPolicy - An authorization policy digest; may be the Empty Buffer If hashAlg is TPM_ALG_NULL, then this shall be an Empty Buffer.

_hashAlg - The hash algorithm to use for the policy If the authPolicy is an Empty Buffer, then this field shall be TPM_ALG_NULL.

Method Detail

toTpm

public void toTpm(TpmBuffer buf)

TpmMarshaller method

Specified by:

toTpm in interface TpmMarshaller

Overrides:

toTpm in class TpmStructure

Parameters:

buf - An output byte buffer

initFromTpm

public void initFromTpm(TpmBuffer buf)

TpmMarshaller method

Specified by:

initFromTpm in interface TpmMarshaller

Overrides:

initFromTpm in class TpmStructure

Parameters:

buf - An input byte buffer

toTpm

public byte[] toTpm()

Deprecated.

Use TpmStructure.toBytes() instead

Returns:

Wire (marshaled) representation of this object

fromBytes

public static TPM2_SetPrimaryPolicy_REQUEST fromBytes(byte[] byteBuf)

Static marshaling helper

Parameters:

byteBuf - Wire representation of the object

Returns:

New object constructed from its wire representation

fromTpm

public static TPM2_SetPrimaryPolicy_REQUEST fromTpm(byte[] byteBuf)

Deprecated.

Use fromBytes(byte[]) instead

Parameters:

byteBuf - Wire representation of the object

Returns:

New object constructed from its wire representation

fromTpm

public static TPM2_SetPrimaryPolicy_REQUEST fromTpm(TpmBuffer buf)

Static marshaling helper

Parameters:

buf - Wire representation of the object

Returns:

New object constructed from its wire representation

toString

public String toString()

Overrides:

toString in class Object

toStringInternal

public void toStringInternal(TpmStructurePrinter _p,
                             int d)

Description copied from class: TpmStructure

Serialize this object to the structure printer

Overrides:

toStringInternal in class TpmStructure

Parameters:

_p - The structure accumulator

d - The data to serialize

numHandles

public int numHandles()

Overrides:

numHandles in class CmdStructure

Returns:

Number of TPM handles contained (as fields) in this data structure

numAuthHandles

public int numAuthHandles()

Overrides:

numAuthHandles in class ReqStructure

Returns:

Number of authorization TPM handles contained in this data structure

getHandles

public TPM_HANDLE[] getHandles()

Overrides:

getHandles in class ReqStructure

Returns:

An array of TPM handles contained in this TPM request data structure

sessEncInfo

public SessEncInfo sessEncInfo()

Overrides:

sessEncInfo in class CmdStructure

Returns:

Non-zero size info of the encryptable command/response parameter if session based encryption can be applied to this object (i.e. its first non-handle field is marshaled in size-prefixed form). Otherwise returns zero initialized struct.