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

Class SecurityProviderSymmetricKey

java.lang.Object

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

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

public class SecurityProviderSymmetricKey
extends SecurityProvider

Constructor Summary

Constructors

Constructor and Description
SecurityProviderSymmetricKey(byte[] symmetricKey, String registrationId) Constructor for Symmetric key security provider

Method Summary

Modifier and Type	Method and Description
String	getRegistrationId() Unique id required for registration
SSLContext	getSSLContext() Retrieves the SSL context loaded with trusted certs.
byte[]	getSymmetricKey() Getter for Symmetric key
byte[]	HMACSignData(byte[] signature, byte[] base64DecodedKey) Signs data using the provided base 64 decoded key using HMAC SHA 256

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityProviderSymmetricKey

public SecurityProviderSymmetricKey(byte[] symmetricKey,
                                    String registrationId)

Constructor for Symmetric key security provider

Parameters:

symmetricKey - Symmetric key to be used

registrationId - Registration ID to be used

Method Detail

getSymmetricKey

public byte[] getSymmetricKey()

Getter for Symmetric key

Returns:

Returns Symmetric Key byte array

getRegistrationId

public String getRegistrationId()
                         throws SecurityProviderException

Unique id required for registration

Specified by:

getRegistrationId in class SecurityProvider

Returns:

Returns the registration Id used needed for the service

Throws:

SecurityProviderException - If registration id with the underlying implementation could not be retrieved

getSSLContext

public SSLContext getSSLContext()
                         throws SecurityProviderException

Retrieves the SSL context loaded with trusted certs. In case of X509 SSL context shall be loaded with complete chain all the way till the leaf along with its private key.

Specified by:

getSSLContext in class SecurityProvider

Returns:

The SSLContext relevant to the flow

Throws:

SecurityProviderException - If ssl context could not be generated for any of the reason

HMACSignData

public byte[] HMACSignData(byte[] signature,
                           byte[] base64DecodedKey)
                    throws SecurityProviderException

Signs data using the provided base 64 decoded key using HMAC SHA 256

Parameters:

signature - Data to be signed

base64DecodedKey - Key used for signing

Returns:

Returns signed data

Throws:

SecurityProviderException - If signing was not successful