com.microsoft.azure.sdk.iot.deps.auth

Class IotHubSSLContext

java.lang.Object

com.microsoft.azure.sdk.iot.deps.auth.IotHubSSLContext

public class IotHubSSLContext
extends Object

Constructor Summary

Constructors

Constructor and Description
IotHubSSLContext() Creates a SSLContext for the IotHub.
IotHubSSLContext(SSLContext sslContext) Constructor that takes and saves an SSLContext object
IotHubSSLContext(String trustedCert, boolean isPath) Creates a default SSLContext for the IotHub with the specified certificate.
IotHubSSLContext(String publicKeyCertificateString, String privateKeyString) Constructor that takes a public key certificate and private key pair.
IotHubSSLContext(String publicKeyCertificateString, String privateKeyString, String cert, boolean isPath) Creates a default SSLContext for the IotHub with the specified certificate.

Method Summary

Modifier and Type	Method and Description
SSLContext	getSSLContext() Getter for the IotHubSSLContext

Methods inherited from class java.lang.Object

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

Constructor Detail

IotHubSSLContext

public IotHubSSLContext()
                 throws KeyStoreException,
                        KeyManagementException,
                        IOException,
                        CertificateException,
                        NoSuchAlgorithmException

Creates a SSLContext for the IotHub.

Throws:

KeyStoreException - if no Provider supports a KeyStoreSpi implementation for the specified type or if the keystore has not been initialized, or the given alias already exists and does not identify an entry containing a trusted certificate, or this operation fails for some other reason.

KeyManagementException - As per https://docs.oracle.com/javase/7/docs/api/java/security/KeyManagementException.html

IOException - If the certificate provided was null or invalid

CertificateException - As per https://docs.oracle.com/javase/7/docs/api/java/security/cert/CertificateException.html

NoSuchAlgorithmException - if the default SSL Context cannot be created

IotHubSSLContext

public IotHubSSLContext(SSLContext sslContext)

Constructor that takes and saves an SSLContext object

Parameters:

sslContext - the ssl context to save

IotHubSSLContext

public IotHubSSLContext(String trustedCert,
                        boolean isPath)
                 throws KeyStoreException,
                        KeyManagementException,
                        IOException,
                        CertificateException,
                        NoSuchAlgorithmException

Creates a default SSLContext for the IotHub with the specified certificate.

Parameters:

trustedCert - the certificate to be trusted

isPath - if the trustedCert is a path to the trusted cert, or if it is the certificate itself

Throws:

KeyStoreException - if no Provider supports a KeyStoreSpi implementation for the specified type or if the keystore has not been initialized, or the given alias already exists and does not identify an entry containing a trusted certificate, or this operation fails for some other reason.

KeyManagementException - As per https://docs.oracle.com/javase/7/docs/api/java/security/KeyManagementException.html

IOException - If the certificate provided was null or invalid

CertificateException - As per https://docs.oracle.com/javase/7/docs/api/java/security/cert/CertificateException.html

NoSuchAlgorithmException - if the default SSL Context cannot be created

IotHubSSLContext

public IotHubSSLContext(String publicKeyCertificateString,
                        String privateKeyString,
                        String cert,
                        boolean isPath)
                 throws KeyStoreException,
                        KeyManagementException,
                        IOException,
                        CertificateException,
                        NoSuchAlgorithmException,
                        UnrecoverableKeyException

Creates a default SSLContext for the IotHub with the specified certificate.

Parameters:

publicKeyCertificateString - the public key for x509 authentication

privateKeyString - the private key for x509 authentication

cert - the trusted certificate

isPath - If the provided cert is a path, or the actual certificate itself

Throws:

KeyStoreException - if no Provider supports a KeyStoreSpi implementation for the specified type or if the keystore has not been initialized, or the given alias already exists and does not identify an entry containing a trusted certificate, or this operation fails for some other reason.

KeyManagementException - As per https://docs.oracle.com/javase/7/docs/api/java/security/KeyManagementException.html

IOException - If the certificate provided was null or invalid

CertificateException - As per https://docs.oracle.com/javase/7/docs/api/java/security/cert/CertificateException.html

NoSuchAlgorithmException - if the default SSL Context cannot be created

UnrecoverableKeyException

IotHubSSLContext

public IotHubSSLContext(String publicKeyCertificateString,
                        String privateKeyString)
                 throws KeyManagementException,
                        IOException,
                        CertificateException,
                        KeyStoreException,
                        NoSuchAlgorithmException,
                        UnrecoverableKeyException

Constructor that takes a public key certificate and private key pair.

Parameters:

publicKeyCertificateString - The PEM formatted public key certificate string

privateKeyString - The PEM formatted private key string

Throws:

KeyManagementException - If the SSLContext could not be initialized

IOException - If an IO exception occurs

CertificateException - If a certificate cannot be loaded

KeyStoreException - If the provided certificates cannot be loaded into the JVM keystore

UnrecoverableKeyException - if accessing the passphrase protected keystore fails due to the key

NoSuchAlgorithmException - if the default SSLContext cannot be generated

Method Detail

getSSLContext

public SSLContext getSSLContext()

Getter for the IotHubSSLContext

Returns:

SSLContext defined for the IotHub.