Package com.azure.security.keyvault.jca

Class KeyVaultKeyStore

java.lang.Object

java.security.KeyStoreSpi

com.azure.security.keyvault.jca.KeyVaultKeyStore

public final class KeyVaultKeyStore
extends KeyStoreSpi

The Azure Key Vault implementation of the KeyStoreSpi.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALGORITHM_NAME	Stores the algorithm name.
static String	KEY_STORE_TYPE	Stores the key-store name.

Constructor Summary

Constructors

Constructor	Description
KeyVaultKeyStore()	Constructor.

Method Summary

Modifier and Type	Method	Description
Enumeration<String>	engineAliases()
boolean	engineContainsAlias(String alias)
void	engineDeleteEntry(String alias)
boolean	engineEntryInstanceOf(String alias, Class<? extends KeyStore.Entry> entryClass)
Certificate	engineGetCertificate(String alias)
String	engineGetCertificateAlias(Certificate cert)
Certificate[]	engineGetCertificateChain(String alias)
Date	engineGetCreationDate(String alias)
KeyStore.Entry	engineGetEntry(String alias, KeyStore.ProtectionParameter protParam)
Key	engineGetKey(String alias, char[] password)
boolean	engineIsCertificateEntry(String alias)
boolean	engineIsKeyEntry(String alias)
void	engineLoad(InputStream stream, char[] password)
void	engineLoad(KeyStore.LoadStoreParameter param)
void	engineSetCertificateEntry(String alias, Certificate certificate)
void	engineSetEntry(String alias, KeyStore.Entry entry, KeyStore.ProtectionParameter protParam)
void	engineSetKeyEntry(String alias, byte[] key, Certificate[] chain)
void	engineSetKeyEntry(String alias, Key key, char[] password, Certificate[] chain)
int	engineSize()
void	engineStore(OutputStream stream, char[] password)
void	engineStore(KeyStore.LoadStoreParameter param)
static KeyStore	getKeyVaultKeyStoreBySystemProperty()	get key vault key store by system property

Methods inherited from class java.security.KeyStoreSpi

engineProbe

Methods inherited from class java.lang.Object

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

Field Detail

KEY_STORE_TYPE

public static final String KEY_STORE_TYPE

Stores the key-store name.

See Also:

Constant Field Values

ALGORITHM_NAME

public static final String ALGORITHM_NAME

Stores the algorithm name.

See Also:

Constant Field Values

Constructor Detail

KeyVaultKeyStore

public KeyVaultKeyStore()

Constructor.

The constructor uses System.getProperty for azure.keyvault.uri, azure.keyvault.aadAuthenticationUrl, azure.keyvault.tenantId, azure.keyvault.clientId, azure.keyvault.clientSecret and azure.keyvault.managedIdentity to initialize the Key Vault client.

Method Detail

getKeyVaultKeyStoreBySystemProperty

public static KeyStore getKeyVaultKeyStoreBySystemProperty()
                                                    throws CertificateException,
                                                           NoSuchAlgorithmException,
                                                           KeyStoreException,
                                                           IOException

get key vault key store by system property

Returns:

KeyVault key store

Throws:

CertificateException - if any of the certificates in the keystore could not be loaded

NoSuchAlgorithmException - when algorithm is unavailable.

KeyStoreException - when no Provider supports a KeyStoreSpi implementation for the specified type

IOException - when an I/O error occurs.

engineAliases

public Enumeration<String> engineAliases()

Specified by:

engineAliases in class KeyStoreSpi

engineContainsAlias

public boolean engineContainsAlias(String alias)

Specified by:

engineContainsAlias in class KeyStoreSpi

engineDeleteEntry

public void engineDeleteEntry(String alias)

Specified by:

engineDeleteEntry in class KeyStoreSpi

engineEntryInstanceOf

public boolean engineEntryInstanceOf(String alias,
                                     Class<? extends KeyStore.Entry> entryClass)

Overrides:

engineEntryInstanceOf in class KeyStoreSpi

engineGetCertificate

public Certificate engineGetCertificate(String alias)

Specified by:

engineGetCertificate in class KeyStoreSpi

engineGetCertificateAlias

public String engineGetCertificateAlias(Certificate cert)

Specified by:

engineGetCertificateAlias in class KeyStoreSpi

engineGetCertificateChain

public Certificate[] engineGetCertificateChain(String alias)

Specified by:

engineGetCertificateChain in class KeyStoreSpi

engineGetCreationDate

public Date engineGetCreationDate(String alias)

Specified by:

engineGetCreationDate in class KeyStoreSpi

engineGetEntry

public KeyStore.Entry engineGetEntry(String alias,
                                     KeyStore.ProtectionParameter protParam)
                              throws KeyStoreException,
                                     NoSuchAlgorithmException,
                                     UnrecoverableEntryException

Overrides:

engineGetEntry in class KeyStoreSpi

Throws:

KeyStoreException

NoSuchAlgorithmException

UnrecoverableEntryException

engineGetKey

public Key engineGetKey(String alias,
                        char[] password)

Specified by:

engineGetKey in class KeyStoreSpi

engineIsCertificateEntry

public boolean engineIsCertificateEntry(String alias)

Specified by:

engineIsCertificateEntry in class KeyStoreSpi

engineIsKeyEntry

public boolean engineIsKeyEntry(String alias)

Specified by:

engineIsKeyEntry in class KeyStoreSpi

engineLoad

public void engineLoad(KeyStore.LoadStoreParameter param)

Overrides:

engineLoad in class KeyStoreSpi

engineLoad

public void engineLoad(InputStream stream,
                       char[] password)

Specified by:

engineLoad in class KeyStoreSpi

engineSetCertificateEntry

public void engineSetCertificateEntry(String alias,
                                      Certificate certificate)

Specified by:

engineSetCertificateEntry in class KeyStoreSpi

engineSetEntry

public void engineSetEntry(String alias,
                           KeyStore.Entry entry,
                           KeyStore.ProtectionParameter protParam)
                    throws KeyStoreException

Overrides:

engineSetEntry in class KeyStoreSpi

Throws:

KeyStoreException

engineSetKeyEntry

public void engineSetKeyEntry(String alias,
                              Key key,
                              char[] password,
                              Certificate[] chain)

Specified by:

engineSetKeyEntry in class KeyStoreSpi

engineSetKeyEntry

public void engineSetKeyEntry(String alias,
                              byte[] key,
                              Certificate[] chain)

Specified by:

engineSetKeyEntry in class KeyStoreSpi

engineSize

public int engineSize()

Specified by:

engineSize in class KeyStoreSpi

engineStore

public void engineStore(OutputStream stream,
                        char[] password)

Specified by:

engineStore in class KeyStoreSpi

engineStore

public void engineStore(KeyStore.LoadStoreParameter param)

Overrides:

engineStore in class KeyStoreSpi