de.adorsys.datasafe.encrypiton.api.keystore

Interface KeyStoreService

public interface KeyStoreService

This class is responsible for creating,serializing keystores as well as reading keys from keystores.

Method Summary

Modifier and Type	Method and Description
KeyStore	createKeyStore(KeyStoreAuth keyStoreAuth, KeyStoreType keyStoreType, KeyStoreCreationConfig config) Creates keystore.
KeyStore	createKeyStore(KeyStoreAuth keyStoreAuth, KeyStoreType keyStoreType, KeyStoreCreationConfig config, Map<KeyID,Optional<SecretKeyEntry>> secretKeys) Creates keystore that has additional secret keys in it.
KeyStore	deserialize(byte[] payload, String storeId, ReadStorePassword password) Reads encrypted keystore from its byte representation - decryption is done using KeyStoreAuth.getReadStorePassword()
PrivateKey	getPrivateKey(KeyStoreAccess keyStoreAccess, KeyID keyID) Reads private key from the keystore.
List<PublicKeyIDWithPublicKey>	getPublicKeys(KeyStoreAccess keyStoreAccess) Reads public keys from the keystore.
SecretKeySpec	getSecretKey(KeyStoreAccess keyStoreAccess, KeyID keyID) Reads secret key from the keystore.
byte[]	serialize(KeyStore store, String storeId, ReadStorePassword password) Converts keystore into bytes, they are safe to be store/transferred because of encryption using KeyStoreAuth.getReadStorePassword()

Method Detail

createKeyStore

KeyStore createKeyStore(KeyStoreAuth keyStoreAuth,
                        KeyStoreType keyStoreType,
                        KeyStoreCreationConfig config)

Creates keystore.

Parameters:

keyStoreAuth - Keys for opening keystore and reading key from it

keyStoreType - Keystore type, example: PKCS or PKCS12 or JKS

config - Keystore will be pre-populated with keys according to it

Returns:

Built keystore that is ready to use

createKeyStore

KeyStore createKeyStore(KeyStoreAuth keyStoreAuth,
                        KeyStoreType keyStoreType,
                        KeyStoreCreationConfig config,
                        Map<KeyID,Optional<SecretKeyEntry>> secretKeys)

Creates keystore that has additional secret keys in it.

Parameters:

keyStoreAuth - Keys for opening keystore and reading key from it

keyStoreType - Keystore type, example: PKCS12 or UBER or JKS

config - Keystore will be pre-populated with keys according to it

secretKeys - Secret keys to store in keystore, if value is empty - key will be generated

Returns:

Built keystore that is ready to use

getPublicKeys

List<PublicKeyIDWithPublicKey> getPublicKeys(KeyStoreAccess keyStoreAccess)

Reads public keys from the keystore.

Parameters:

keyStoreAccess - Key to open keystore (only KeyStoreAuth.getReadStorePassword() is used)

Returns:

List of public keys within the keystore

getPrivateKey

PrivateKey getPrivateKey(KeyStoreAccess keyStoreAccess,
                         KeyID keyID)

Reads private key from the keystore.

Parameters:

keyStoreAccess - Key to open keystore and read key, (both KeyStoreAuth.getReadStorePassword() and KeyStoreAuth.getReadKeyPassword() are used)

keyID - Private key ID to read

Returns:

Private key associated with given ID

getSecretKey

SecretKeySpec getSecretKey(KeyStoreAccess keyStoreAccess,
                           KeyID keyID)

Reads secret key from the keystore.

Parameters:

keyStoreAccess - Key to open keystore and read key, (both KeyStoreAuth.getReadStorePassword() and KeyStoreAuth.getReadKeyPassword() are used)

keyID - Secret key ID to read

Returns:

Secret key associated with given ID

serialize

byte[] serialize(KeyStore store,
                 String storeId,
                 ReadStorePassword password)

Converts keystore into bytes, they are safe to be store/transferred because of encryption using KeyStoreAuth.getReadStorePassword()

Parameters:

store - Keystore that will be serialized

storeId - Assign ID to serialized keystore

password - Encrypts byte sequence

Returns:

Encrypted serialized keystore

deserialize

KeyStore deserialize(byte[] payload,
                     String storeId,
                     ReadStorePassword password)

Reads encrypted keystore from its byte representation - decryption is done using KeyStoreAuth.getReadStorePassword()

Parameters:

payload - Bytes to read from

storeId - Specifies which keystore to read from bytes

password - Decrypts byte sequence

Returns:

Decrypted keystore