de.adorsys.datasafe.directory.api.profile.keys

Interface PrivateKeyService

public interface PrivateKeyService

Acts as a private and secret keys database.

Method Summary

Modifier and Type	Method and Description
SecretKeyIDWithKey	documentEncryptionSecretKey(UserIDAuth forUser) Get document-encryption key.
Map<String,Key>	keysByIds(UserIDAuth forUser, Set<String> keyIds) Raw access to get key by its ID specialized for getting multiple keys at a time.
AuthPathEncryptionSecretKey	pathEncryptionSecretKey(UserIDAuth forUser) Get path-encryption key that will be used to encrypt URI paths.
void	validateUserHasAccessOrThrow(UserIDAuth forUser) Validates that user has access to his keystore.

Method Detail

pathEncryptionSecretKey

AuthPathEncryptionSecretKey pathEncryptionSecretKey(UserIDAuth forUser)

Get path-encryption key that will be used to encrypt URI paths. Access validation is not necessary - done by this function implicitly.

Parameters:

forUser - Key owner

Returns:

Path encryption entity which contain secret keys and key ID.

documentEncryptionSecretKey

SecretKeyIDWithKey documentEncryptionSecretKey(UserIDAuth forUser)

Get document-encryption key. Access validation is not necessary - done by this function implicitly.

Parameters:

forUser - Key owner

Returns:

Document encryption secret key.

validateUserHasAccessOrThrow

void validateUserHasAccessOrThrow(UserIDAuth forUser)

Validates that user has access to his keystore. Should ignore any storage access exceptions to cover cases if keystore does not exist.

Parameters:

forUser - User to validate.

keysByIds

Map<String,Key> keysByIds(UserIDAuth forUser,
                          Set<String> keyIds)

Raw access to get key by its ID specialized for getting multiple keys at a time. Access validation is not necessary - done by this function implicitly (but empty result set may indicate some problem).

Parameters:

forUser - Key owner

keyIds - Key IDs to receive keys for

Returns:

Map (key id - Key) from database/storage associated with keyId, those key ids from keyIds that are missing - they are silently ignored and not returned in result.