tss.tpm

Class TPM2_PolicySecret_REQUEST

java.lang.Object

tss.TpmStructure

tss.tpm.TPM2_PolicySecret_REQUEST

All Implemented Interfaces:

TpmMarshaller

public class TPM2_PolicySecret_REQUEST
extends TpmStructure

This command includes a secret-based authorization to a policy. The caller proves knowledge of the secret value using an authorization session using the authValue associated with authHandle. A password session, an HMAC session, or a policy session containing TPM2_PolicyAuthValue() or TPM2_PolicyPassword() will satisfy this requirement.

Field Summary

Fields

Modifier and Type	Field and Description
TPM_HANDLE	authHandle handle for an entity providing the authorization Auth Index: 1 Auth Role: USER
byte[]	cpHashA digest of the command parameters to which this authorization is limited This not the cpHash for this command but the cpHash for the command to which this policy session will be applied.
int	expiration time when authorization will expire, measured in seconds from the time that nonceTPM was generated If expiration is non-negative, a NULL Ticket is returned.
byte[]	nonceTPM the policy nonce for the session This can be the Empty Buffer.
byte[]	policyRef a reference to a policy relating to the authorization may be the Empty Buffer Size is limited to be no larger than the nonce size supported on the TPM.
TPM_HANDLE	policySession handle for the policy session being extended Auth Index: None

Constructor Summary

Constructors

Constructor and Description
TPM2_PolicySecret_REQUEST() This command includes a secret-based authorization to a policy.
TPM2_PolicySecret_REQUEST(TPM_HANDLE _authHandle, TPM_HANDLE _policySession, byte[] _nonceTPM, byte[] _cpHashA, byte[] _policyRef, int _expiration) This command includes a secret-based authorization to a policy.

Method Summary

Modifier and Type	Method and Description
static TPM2_PolicySecret_REQUEST	fromTpm(byte[] x)
static TPM2_PolicySecret_REQUEST	fromTpm(InByteBuf buf)
void	initFromTpm(InByteBuf buf) Populate this object from the TPM representation in the input byte buffer object
String	toString()
void	toStringInternal(TpmStructurePrinter _p, int d) Serialize this object to the structure printer
byte[]	toTpm() Convert this object to its TPM representation and return it as a byte array
void	toTpm(OutByteBuf buf) Convert this object to its TPM representation and store in the output byte buffer object

Methods inherited from class tss.TpmStructure

equals, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

authHandle

public TPM_HANDLE authHandle

handle for an entity providing the authorization Auth Index: 1 Auth Role: USER

policySession

public TPM_HANDLE policySession

handle for the policy session being extended Auth Index: None

nonceTPM

public byte[] nonceTPM

the policy nonce for the session This can be the Empty Buffer.

cpHashA

public byte[] cpHashA

digest of the command parameters to which this authorization is limited This not the cpHash for this command but the cpHash for the command to which this policy session will be applied. If it is not limited, the parameter will be the Empty Buffer.

policyRef

public byte[] policyRef

a reference to a policy relating to the authorization may be the Empty Buffer Size is limited to be no larger than the nonce size supported on the TPM.

expiration

public int expiration

time when authorization will expire, measured in seconds from the time that nonceTPM was generated If expiration is non-negative, a NULL Ticket is returned. See 23.2.5.

Constructor Detail

TPM2_PolicySecret_REQUEST

public TPM2_PolicySecret_REQUEST(TPM_HANDLE _authHandle,
                                 TPM_HANDLE _policySession,
                                 byte[] _nonceTPM,
                                 byte[] _cpHashA,
                                 byte[] _policyRef,
                                 int _expiration)

This command includes a secret-based authorization to a policy. The caller proves knowledge of the secret value using an authorization session using the authValue associated with authHandle. A password session, an HMAC session, or a policy session containing TPM2_PolicyAuthValue() or TPM2_PolicyPassword() will satisfy this requirement.

Parameters:

_authHandle - handle for an entity providing the authorization Auth Index: 1 Auth Role: USER

_policySession - handle for the policy session being extended Auth Index: None

_nonceTPM - the policy nonce for the session This can be the Empty Buffer.

_cpHashA - digest of the command parameters to which this authorization is limited This not the cpHash for this command but the cpHash for the command to which this policy session will be applied. If it is not limited, the parameter will be the Empty Buffer.

_policyRef - a reference to a policy relating to the authorization may be the Empty Buffer Size is limited to be no larger than the nonce size supported on the TPM.

_expiration - time when authorization will expire, measured in seconds from the time that nonceTPM was generated If expiration is non-negative, a NULL Ticket is returned. See 23.2.5.

TPM2_PolicySecret_REQUEST

public TPM2_PolicySecret_REQUEST()

This command includes a secret-based authorization to a policy. The caller proves knowledge of the secret value using an authorization session using the authValue associated with authHandle. A password session, an HMAC session, or a policy session containing TPM2_PolicyAuthValue() or TPM2_PolicyPassword() will satisfy this requirement.

Method Detail

toTpm

public void toTpm(OutByteBuf buf)

Description copied from interface: TpmMarshaller

Convert this object to its TPM representation and store in the output byte buffer object

Parameters:

buf - An output byte buffer

initFromTpm

public void initFromTpm(InByteBuf buf)

Description copied from interface: TpmMarshaller

Populate this object from the TPM representation in the input byte buffer object

Parameters:

buf - An input byte buffer

toTpm

public byte[] toTpm()

Description copied from interface: TpmMarshaller

Convert this object to its TPM representation and return it as a byte array

Returns:

Byte buffer with the TPM 2.0 compatible wire representation of the object

fromTpm

public static TPM2_PolicySecret_REQUEST fromTpm(byte[] x)

fromTpm

public static TPM2_PolicySecret_REQUEST fromTpm(InByteBuf buf)

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

Specified by:

toStringInternal in class TpmStructure

Parameters:

_p - The structure accumulator

d - The data to serialize