com.microsoft.azure.sdk.iot.provisioning.service.configs

Class TpmAttestation

java.lang.Object

com.microsoft.azure.sdk.iot.provisioning.service.configs.Attestation

com.microsoft.azure.sdk.iot.provisioning.service.configs.TpmAttestation

public class TpmAttestation
extends Attestation

Representation of a single Device Provisioning Service TPM Attestation.

The provisioning service supports Trusted Platform Module, or TPM, as the device attestation mechanism. User must provide the Endorsement Key, and can, optionally, provide the Storage Root Key.

See Also:

Device Enrollment, Trusted Platform Module

Constructor Summary

Constructors

Constructor and Description
TpmAttestation(String endorsementKey) CONSTRUCTOR
TpmAttestation(String endorsementKey, String storageRootKey) CONSTRUCTOR
TpmAttestation(TpmAttestation tpm) CONSTRUCTOR (COPY)

Method Summary

Modifier and Type	Method and Description
String	getEndorsementKey() Getter for the endorsementKey.
String	getStorageRootKey() Getter for the storageRootKey.

Methods inherited from class java.lang.Object

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

Constructor Detail

TpmAttestation

public TpmAttestation(String endorsementKey,
                      String storageRootKey)

CONSTRUCTOR

This function will create a new instance of the TPM attestation with both endorsement and storage root keys. Only the endorsement key is mandatory.

Parameters:

endorsementKey - the String with the TPM endorsement key. It cannot be null or empty.

storageRootKey - the String with the TPM storage root key. It can be null or empty.

Throws:

IllegalArgumentException - If the endorsementKey is null or empty.

TpmAttestation

public TpmAttestation(String endorsementKey)

CONSTRUCTOR

This function will create a new instance of the TPM attestation with the endorsement key.

Parameters:

endorsementKey - the String with the TPM endorsement key. It cannot be null or empty.

Throws:

IllegalArgumentException - If the endorsementKey is null or empty.

TpmAttestation

public TpmAttestation(TpmAttestation tpm)

CONSTRUCTOR (COPY)

This function will create a new instance of the TPM attestation copying the endorsementKey and storageRootKey from the provided attestation.

Parameters:

tpm - the original TpmAttestation to copy. It cannot be null.

Throws:

IllegalArgumentException - if the provided tpm is null.

Method Detail

getEndorsementKey

public String getEndorsementKey()

Getter for the endorsementKey.

Returns:

The String with the stored endorsementKey. It cannot be null or empty.

getStorageRootKey

public String getStorageRootKey()

Getter for the storageRootKey.

Returns:

The String with the stored storageRootKey. It can be null or empty.