com.microsoft.aad.adal4j

Class AsymmetricKeyCredential

java.lang.Object

com.microsoft.aad.adal4j.AsymmetricKeyCredential

public final class AsymmetricKeyCredential
extends Object

Credential type containing X509 public certificate and RSA private key.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MIN_KEYSIZE_IN_BITS

Method Summary

Modifier and Type	Method and Description
static AsymmetricKeyCredential	create(String clientId, InputStream pkcs12Certificate, String password) Static method to create KeyCredential instance.
static AsymmetricKeyCredential	create(String clientId, PrivateKey key, X509Certificate publicCertificate) Static method to create KeyCredential instance.
String	getClientId() Gets the identifier of the client requesting the token.
PrivateKey	getKey() Returns private key of the credential.
String	getPublicCertificate() Base64 encoded public certificate.
String	getPublicCertificateHash() Base64 encoded hash of the the public certificate.

Methods inherited from class java.lang.Object

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

Field Detail

MIN_KEYSIZE_IN_BITS

public static final int MIN_KEYSIZE_IN_BITS

See Also:

Constant Field Values

Method Detail

getClientId

public String getClientId()

Gets the identifier of the client requesting the token.

Returns:

string value

getPublicCertificateHash

public String getPublicCertificateHash()
                                throws CertificateEncodingException,
                                       NoSuchAlgorithmException

Base64 encoded hash of the the public certificate.

Returns:

base64 encoded string

Throws:

CertificateEncodingException - if an encoding error occurs

NoSuchAlgorithmException - if requested algorithm is not available in the environment

getPublicCertificate

public String getPublicCertificate()
                            throws CertificateEncodingException

Base64 encoded public certificate.

Returns:

base64 encoded string

Throws:

CertificateEncodingException - if an encoding error occurs

getKey

public PrivateKey getKey()

Returns private key of the credential.

Returns:

private key.

create

public static AsymmetricKeyCredential create(String clientId,
                                             InputStream pkcs12Certificate,
                                             String password)
                                      throws KeyStoreException,
                                             NoSuchProviderException,
                                             NoSuchAlgorithmException,
                                             CertificateException,
                                             IOException,
                                             UnrecoverableKeyException

Static method to create KeyCredential instance.

Parameters:

clientId - Identifier of the client requesting the token.

pkcs12Certificate - PKCS12 certificate stream containing public and private key. Caller is responsible for handling the input stream.

password - certificate password

Returns:

KeyCredential instance

Throws:

KeyStoreException - KeyStoreException

NoSuchProviderException - NoSuchProviderException

NoSuchAlgorithmException - NoSuchAlgorithmException

CertificateException - CertificateException

IOException - IOException

UnrecoverableKeyException - UnrecoverableKeyException

create

public static AsymmetricKeyCredential create(String clientId,
                                             PrivateKey key,
                                             X509Certificate publicCertificate)

Static method to create KeyCredential instance.

Parameters:

clientId - Identifier of the client requesting the token.

key - RSA private key to sign the assertion.

publicCertificate - Public certificate used for thumb print.

Returns:

KeyCredential instance