SecurityProviderTPMHsm Class

Package:

com.microsoft.azure.sdk.iot.provisioning.security.hsm

• java.lang.Object
• • SecurityProvider
  • • SecurityProviderTpm
    • • com.microsoft.azure.sdk.iot.provisioning.security.hsm.SecurityProviderTPMHsm

public class SecurityProviderTPMHsm extends SecurityProviderTpm

Constructor Summary

Constructor	Description
SecurityProviderTPMHsm()	Constructor for creating a Security Provider on TPM hardware
SecurityProviderTPMHsm(String registrationId)	Constructor for creating a Security Provider on TPM hardware with the supplied Registration ID

Method Summary

Modifier and Type	Method and Description
byte []	activateIdentityKey(byte[] key) Activates the Identity with the nonce provided from the service
byte []	getEndorsementKey() Getter for extracting EndorsementKey from TPM
String	getRegistrationId() Getter for the Registration ID if it was provided. Default is returned otherwise.
byte []	getStorageRootKey() Getter for extracting StorageRootKey from TPM
byte []	signWithIdentity(byte[] deviceIdData) This method signs the TPM with the provided device ID

Inherited Members

SecurityProvider.getSSLContext()

Constructor Details

SecurityProviderTPMHsm

public SecurityProviderTPMHsm()

Constructor for creating a Security Provider on TPM hardware

Throws:

SecurityProviderException - If the constructor could not start the TPM

SecurityProviderTPMHsm

public SecurityProviderTPMHsm(String registrationId)

Constructor for creating a Security Provider on TPM hardware with the supplied Registration ID

Parameters:

registrationId -

A nonnull 

</code> or empty value tied to this registration </p>

Throws:

SecurityProviderException - If the constructor could not start the TPM

Method Details

activateIdentityKey

public byte [] activateIdentityKey(byte[] key)

Activates the Identity with the nonce provided from the service

Parameters:

key - Key for activating the TPM

Returns:

null 

</code> value is returned. Place holder for eventual returns. </p>

Throws:

SecurityProviderException - If activation was not successful.

getEndorsementKey

public byte [] getEndorsementKey()

Getter for extracting EndorsementKey from TPM

Returns:

The Endorsement Key from TPM

getRegistrationId

public String getRegistrationId()

Getter for the Registration ID if it was provided. Default is returned otherwise.

Returns:

The registration ID tied to this registration instance

Throws:

SecurityProviderException - If registration ID could not be extracted

getStorageRootKey

public byte [] getStorageRootKey()

Getter for extracting StorageRootKey from TPM

Returns:

The StorageRootKey from TPM

signWithIdentity

public byte [] signWithIdentity(byte[] deviceIdData)

This method signs the TPM with the provided device ID

Parameters:

deviceIdData -

A nonnull 

</code> or empty value for the device ID </p>

Returns:

The signature after signing data.

Throws:

SecurityProviderException - If signing was not successful