iaik.tc.tss.api.structs.tpm
Class TcTpmKey

Object
  extended by TcBasicTypeDecoder
      extended by TcCompositeTypeDecoder
          extended by TcTpmKey
All Implemented Interfaces:
TcITpmKey
Direct Known Subclasses:
TcTpmKeyNew

public class TcTpmKey
extends TcCompositeTypeDecoder
implements TcITpmKey

The TPM_KEY structure provides a mechanism to transport the entire asymmetric key pair. The private portion of the key is always encrypted.

TCPA 1.1b Main Specification, page number:
68

Constructor Summary
TcTpmKey()
          Constructor - see superclass for details
TcTpmKey(TcBlobData blob)
          Constructor - see superclass for details
TcTpmKey(TcBlobData blob, int offset)
          Constructor - see superclass for details
TcTpmKey(TcCompositeTypeDecoder composite)
          Constructor - see superclass for details
 
Method Summary
 TcTpmKeyParms getAlgorithmParms()
          Returns contents of the algorithmParms field.
 short getAuthDataUsage()
          Returns contents of the authDataUsage field.
 TcBlobData getEncData()
          Returns contents of the encData field.
 TcBlobData getEncoded()
          This method encodes the TPM_KEY_PARMS as a byte blob.
 long getEncSize()
          Returns contents of the encSize field.
 long getKeyFlags()
          Returns contents of the keyFlags field.
 int getKeyUsage()
          Returns contents of the keyUsage field.
 TcBlobData getPcrInfo()
          Returns contents of the pcrInfo field.
 long getPcrInfoSize()
          Returns contents of the pcrInfoSize field.
 TcTpmStorePubkey getPubKey()
          Returns contents of the pubKey field.
 TcTpmVersion getVer()
          Returns contents of the ver field.
 void setAlgorithmParms(TcTpmKeyParms algorithmParms)
          Sets the algorithmParms field.
 void setAuthDataUsage(short authDataUsage)
          Sets the authDataUsage field.
 void setEncData(TcBlobData encData)
          Sets the encData field.
 void setKeyFlags(long keyFlags)
          Sets the keyFlags field.
 void setKeyUsage(int keyUsage)
          Sets the keyUsage field.
 void setPcrInfo(TcBlobData pcrInfo)
          Sets the pcrInfo field.
 void setPubKey(TcTpmStorePubkey pubKey)
          Sets the pubKey field.
 void setVer(TcTpmStructVer ver)
          Sets the ver field.
 String toString()
          This method returns a String representation of the object.
 
Methods inherited from class TcBasicTypeDecoder
decodeBoolean, decodeByte, decodeBytes, decodeBytes, decodeTpmAlgorithmId, decodeTpmAuthDataUsage, decodeTpmEncScheme, decodeTpmKeyFlags, decodeTpmKeyUsage, decodeTpmSigScheme, decodeTssAlgorithmId, decodeTssEncScheme, decodeTssEvenType, decodeTssFlag, decodeTssHandle, decodeTssHContext, decodeTssHEncData, decodeTssHHash, decodeTssHKey, decodeTssHObjet, decodeTssHPcrs, decodeTssHPolicy, decodeTssHPS, decodeTssHTpm, decodeTssKeyUsageId, decodeTssMigrationScheme, decodeTssResult, decodeTssSigScheme, decodeUINT16, decodeUINT32, decodeUINT64
 
Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TcTpmKey

public TcTpmKey()
Constructor - see superclass for details


TcTpmKey

public TcTpmKey(TcBlobData blob)
Constructor - see superclass for details


TcTpmKey

public TcTpmKey(TcBlobData blob,
                int offset)
Constructor - see superclass for details


TcTpmKey

public TcTpmKey(TcCompositeTypeDecoder composite)
Constructor - see superclass for details

Method Detail

getEncoded

public TcBlobData getEncoded()
This method encodes the TPM_KEY_PARMS as a byte blob.

Specified by:
getEncoded in interface TcITpmKey
Specified by:
getEncoded in class TcCompositeTypeDecoder
Returns:
byte blob to be passed to other layers (e.g. TSS)

toString

public String toString()
This method returns a String representation of the object.

Specified by:
toString in interface TcITpmKey
Overrides:
toString in class TcCompositeTypeDecoder

getAlgorithmParms

public TcTpmKeyParms getAlgorithmParms()
Returns contents of the algorithmParms field.

Specified by:
getAlgorithmParms in interface TcITpmKey

setAlgorithmParms

public void setAlgorithmParms(TcTpmKeyParms algorithmParms)
Sets the algorithmParms field.

Specified by:
setAlgorithmParms in interface TcITpmKey

getAuthDataUsage

public short getAuthDataUsage()
Returns contents of the authDataUsage field.

Specified by:
getAuthDataUsage in interface TcITpmKey

setAuthDataUsage

public void setAuthDataUsage(short authDataUsage)
Sets the authDataUsage field.

Specified by:
setAuthDataUsage in interface TcITpmKey

getEncData

public TcBlobData getEncData()
Returns contents of the encData field.

Specified by:
getEncData in interface TcITpmKey

setEncData

public void setEncData(TcBlobData encData)
Sets the encData field.

Specified by:
setEncData in interface TcITpmKey

getEncSize

public long getEncSize()
Returns contents of the encSize field.

Specified by:
getEncSize in interface TcITpmKey

getKeyFlags

public long getKeyFlags()
Returns contents of the keyFlags field.

Specified by:
getKeyFlags in interface TcITpmKey

setKeyFlags

public void setKeyFlags(long keyFlags)
Sets the keyFlags field.

Specified by:
setKeyFlags in interface TcITpmKey

getKeyUsage

public int getKeyUsage()
Returns contents of the keyUsage field.

Specified by:
getKeyUsage in interface TcITpmKey

setKeyUsage

public void setKeyUsage(int keyUsage)
Sets the keyUsage field.

Specified by:
setKeyUsage in interface TcITpmKey

getPcrInfo

public TcBlobData getPcrInfo()
Returns contents of the pcrInfo field.

Specified by:
getPcrInfo in interface TcITpmKey

setPcrInfo

public void setPcrInfo(TcBlobData pcrInfo)
Sets the pcrInfo field.

Specified by:
setPcrInfo in interface TcITpmKey

getPcrInfoSize

public long getPcrInfoSize()
Returns contents of the pcrInfoSize field.

Specified by:
getPcrInfoSize in interface TcITpmKey

getPubKey

public TcTpmStorePubkey getPubKey()
Returns contents of the pubKey field.

Specified by:
getPubKey in interface TcITpmKey

setPubKey

public void setPubKey(TcTpmStorePubkey pubKey)
Sets the pubKey field.

Specified by:
setPubKey in interface TcITpmKey

getVer

public TcTpmVersion getVer()
Returns contents of the ver field.


setVer

public void setVer(TcTpmStructVer ver)
Sets the ver field.