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

Class SecurityProviderTPMHsm

java.lang.Object

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

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

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

public class SecurityProviderTPMHsm
extends com.microsoft.azure.sdk.iot.provisioning.security.SecurityProviderTpm

Constructor Summary

Constructors

Constructor and 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.
byte[]	getStorageRootKey() Getter for extracting StorageRootKey from TPM
byte[]	signWithIdentity(byte[] deviceIdData) This method signs the TPM with the provided device ID

Methods inherited from class com.microsoft.azure.sdk.iot.provisioning.security.SecurityProvider

getSSLContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecurityProviderTPMHsm

public SecurityProviderTPMHsm()
                       throws com.microsoft.azure.sdk.iot.provisioning.security.exceptions.SecurityProviderException

Constructor for creating a Security Provider on TPM hardware

Throws:

com.microsoft.azure.sdk.iot.provisioning.security.exceptions.SecurityProviderException - If the constructor could not start the TPM

SecurityProviderTPMHsm

public SecurityProviderTPMHsm(String registrationId)
                       throws com.microsoft.azure.sdk.iot.provisioning.security.exceptions.SecurityProviderException

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

Parameters:

registrationId - A non null or empty value tied to this registration

Throws:

com.microsoft.azure.sdk.iot.provisioning.security.exceptions.SecurityProviderException - If the constructor could not start the TPM

Method Detail

getRegistrationId

public String getRegistrationId()
                         throws com.microsoft.azure.sdk.iot.provisioning.security.exceptions.SecurityProviderException

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

Overrides:

getRegistrationId in class com.microsoft.azure.sdk.iot.provisioning.security.SecurityProviderTpm

Returns:

The registration ID tied to this registration instance

Throws:

com.microsoft.azure.sdk.iot.provisioning.security.exceptions.SecurityProviderException - If registration ID could not be extracted

activateIdentityKey

public byte[] activateIdentityKey(byte[] key)
                           throws com.microsoft.azure.sdk.iot.provisioning.security.exceptions.SecurityProviderException

Activates the Identity with the nonce provided from the service

Specified by:

activateIdentityKey in class com.microsoft.azure.sdk.iot.provisioning.security.SecurityProviderTpm

Parameters:

key - Key for activating the TPM

Returns:

null value is returned. Place holder for eventual returns.

Throws:

com.microsoft.azure.sdk.iot.provisioning.security.exceptions.SecurityProviderException - If activation was not successful.

signWithIdentity

public byte[] signWithIdentity(byte[] deviceIdData)
                        throws com.microsoft.azure.sdk.iot.provisioning.security.exceptions.SecurityProviderException

This method signs the TPM with the provided device ID

Specified by:

signWithIdentity in class com.microsoft.azure.sdk.iot.provisioning.security.SecurityProviderTpm

Parameters:

deviceIdData - A non null or empty value for the device ID

Returns:

The signature after signing data.

Throws:

com.microsoft.azure.sdk.iot.provisioning.security.exceptions.SecurityProviderException - If signing was not successful

getEndorsementKey

public byte[] getEndorsementKey()

Getter for extracting EndorsementKey from TPM

Specified by:

getEndorsementKey in class com.microsoft.azure.sdk.iot.provisioning.security.SecurityProviderTpm

Returns:

The Endorsement Key from TPM

getStorageRootKey

public byte[] getStorageRootKey()

Getter for extracting StorageRootKey from TPM

Specified by:

getStorageRootKey in class com.microsoft.azure.sdk.iot.provisioning.security.SecurityProviderTpm

Returns:

The StorageRootKey from TPM