TPM2_StartAuthSession_REQUEST (TSS.Java 0.2.0 API)

java.lang.Object
- tss.TpmStructure
- - tss.tpm.TPM2_StartAuthSession_REQUEST

All Implemented Interfaces:

TpmMarshaller
```
public class TPM2_StartAuthSession_REQUEST
extends TpmStructure
```
This command is used to start an authorization session using alternative methods of establishing the session key (sessionKey). The session key is then used to derive values used for authorization and for encrypting parameters.

Field Summary

Fields
Modifier and Type	Field and Description
`TPM_ALG_ID`	`authHash` hash algorithm to use for the session Shall be a hash algorithm supported by the TPM and not TPM_ALG_NULL
`TPM_HANDLE`	`bind` entity providing the authValue may be TPM_RH_NULL Auth Index: None
`byte[]`	`encryptedSalt` value encrypted according to the type of tpmKey If tpmKey is TPM_RH_NULL, this shall be the Empty Buffer.
`byte[]`	`nonceCaller` initial nonceCaller, sets nonceTPM size for the session shall be at least 16 octets
`TPM_SE`	`sessionType` indicates the type of the session; simple HMAC or policy (including a trial policy)
`TPMT_SYM_DEF`	`symmetric` the algorithm and key size for parameter encryption may select TPM_ALG_NULL
`TPM_HANDLE`	`tpmKey` handle of a loaded decrypt key used to encrypt salt may be TPM_RH_NULL Auth Index: None

Constructor Summary

Constructors
Constructor and Description
`TPM2_StartAuthSession_REQUEST()` This command is used to start an authorization session using alternative methods of establishing the session key (sessionKey).
`TPM2_StartAuthSession_REQUEST(TPM_HANDLE _tpmKey, TPM_HANDLE _bind, byte[] _nonceCaller, byte[] _encryptedSalt, TPM_SE _sessionType, TPMT_SYM_DEF _symmetric, TPM_ALG_ID _authHash)` This command is used to start an authorization session using alternative methods of establishing the session key (sessionKey).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static TPM2_StartAuthSession_REQUEST`	`fromTpm(byte[] x)`
`static TPM2_StartAuthSession_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
  - tpmKey
```
public TPM_HANDLE tpmKey
```
    handle of a loaded decrypt key used to encrypt salt may be TPM_RH_NULL Auth Index: None
  - bind
```
public TPM_HANDLE bind
```
    entity providing the authValue may be TPM_RH_NULL Auth Index: None
  - nonceCaller
```
public byte[] nonceCaller
```
    initial nonceCaller, sets nonceTPM size for the session shall be at least 16 octets
  - encryptedSalt
```
public byte[] encryptedSalt
```
    value encrypted according to the type of tpmKey If tpmKey is TPM_RH_NULL, this shall be the Empty Buffer.
  - sessionType
```
public TPM_SE sessionType
```
    indicates the type of the session; simple HMAC or policy (including a trial policy)
  - symmetric
```
public TPMT_SYM_DEF symmetric
```
    the algorithm and key size for parameter encryption may select TPM_ALG_NULL
  - authHash
```
public TPM_ALG_ID authHash
```
    hash algorithm to use for the session Shall be a hash algorithm supported by the TPM and not TPM_ALG_NULL
- Constructor Detail
  - TPM2_StartAuthSession_REQUEST
```
public TPM2_StartAuthSession_REQUEST(TPM_HANDLE _tpmKey,
                                     TPM_HANDLE _bind,
                                     byte[] _nonceCaller,
                                     byte[] _encryptedSalt,
                                     TPM_SE _sessionType,
                                     TPMT_SYM_DEF _symmetric,
                                     TPM_ALG_ID _authHash)
```
    This command is used to start an authorization session using alternative methods of establishing the session key (sessionKey). The session key is then used to derive values used for authorization and for encrypting parameters.
    
    Parameters:
    
    _tpmKey - handle of a loaded decrypt key used to encrypt salt may be TPM_RH_NULL Auth Index: None
    
    _bind - entity providing the authValue may be TPM_RH_NULL Auth Index: None
    
    _nonceCaller - initial nonceCaller, sets nonceTPM size for the session shall be at least 16 octets
    
    _encryptedSalt - value encrypted according to the type of tpmKey If tpmKey is TPM_RH_NULL, this shall be the Empty Buffer.
    
    _sessionType - indicates the type of the session; simple HMAC or policy (including a trial policy)
    
    _symmetric - the algorithm and key size for parameter encryption may select TPM_ALG_NULL
    
    _authHash - hash algorithm to use for the session Shall be a hash algorithm supported by the TPM and not TPM_ALG_NULL
  - TPM2_StartAuthSession_REQUEST
```
public TPM2_StartAuthSession_REQUEST()
```
    This command is used to start an authorization session using alternative methods of establishing the session key (sessionKey). The session key is then used to derive values used for authorization and for encrypting parameters.
- 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_StartAuthSession_REQUEST fromTpm(byte[] x)
```
  - fromTpm
```
public static TPM2_StartAuthSession_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

Class TPM2_StartAuthSession_REQUEST

Field Summary

Constructor Summary

Method Summary

Methods inherited from class tss.TpmStructure

Methods inherited from class java.lang.Object

Field Detail

tpmKey

bind

nonceCaller

encryptedSalt

sessionType

symmetric

authHash

Constructor Detail

TPM2_StartAuthSession_REQUEST

TPM2_StartAuthSession_REQUEST

Method Detail

toTpm

initFromTpm

toTpm

fromTpm

fromTpm

toString

toStringInternal