cz.ues.platform.security.vault

Interface UESVaultService

@UESComponent
public interface UESVaultService

UESVaultService can be used to persist sensitive information in an encrypted form. Multi-tenancy is supported by SecuredContainers that can be associated with some user. Each SecuredContainer has its unique ID and associated MasterKeyProvider to obtain the master-key used for data encryption in the container. Unlimited number of SecuredObjects can be put into the container. Each SecuredObject can contain many key-value entries.

Also note that SecuredObject is only intended to store relatively small size data, such as passwords. If you need to store large objects securely, consider encrypting such objects in a symmetric way using randomly generated password and use secure preferences to store the password.

Since:

UES6-06

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_KEY_PROVIDER_ID ID of default key provider to be used with secured container.

Method Summary

Methods

Modifier and Type	Method and Description
void	createContainer(java.lang.String containerId, java.lang.String containerName, java.lang.String keyProvider) Creates a new secured container.
void	deleteContainer(java.lang.String containerId) Deletes the secured container (container must be empty in order to be deleted).
void	deleteSecuredObject(java.lang.String containerId, java.lang.String objectID) Deletes a secured object from container with the given ID.
SecuredObject	getSecuredObject(java.lang.String containerID, java.lang.String objectID) Reads a secured object from container with the given ID.
SecuredObject	putSecuredObject(java.lang.String containerID, SecuredObject secObject) Stores the secured object in container with the given ID.
SecuredObject	updateSecuredObject(java.lang.String containerID, SecuredObject secObject) Updates existing secured object in container with given ID.

Field Detail

DEFAULT_KEY_PROVIDER_ID

static final DEFAULT_KEY_PROVIDER_ID

ID of default key provider to be used with secured container.

See Also:

Constant Field Values

Method Detail

createContainer

void createContainer(java.lang.String containerId,
java.lang.String containerName,
java.lang.String keyProvider)
throws UESVaultServiceRTException

Creates a new secured container.

Parameters:

containerId - ID of the new container (must be unique in the scope of the vault). If the given value is not unique or the value is empty, UESVaultServiceRTException is thrown.

containerName - Name of the new container

keyProvider - ID of key provider to be used with the created container. If null, default key provider defined in constant UESVaultService.DEFAULT_KEY_PROVIDER_ID is used. If the given provider is not defined, UESVaultServiceRTException is thrown.

Throws:

UESVaultServiceRTException - In case the creation of the container is not possible.

Since:

UES6-06

deleteContainer

void deleteContainer(java.lang.String containerId)
throws UESVaultServiceRTException

Deletes the secured container (container must be empty in order to be deleted). Only owner of the container is allowed to delete the container, otherwise UESVaultServiceRTException is thrown.

Parameters:

containerId - ID of the container to be deleted.

Throws:

UESVaultServiceRTException - If the deleted container is not empty or the container is not deleted by its owner.

Since:

UES6-06

putSecuredObject

SecuredObject putSecuredObject(java.lang.String containerID,
SecuredObject secObject)
throws UESVaultServiceRTException

Stores the secured object in container with the given ID. Only owner of container with the given ID is allowed to store the secured object in the container, otherwise UESVaultServiceRTException is thrown.

Parameters:

containerID - ID of the container where to store the secured object. If the ID is empty or container with the given ID does not exist, UESVaultServiceRTException is thrown.

secObject - The secured object to be stored in the container. ID of the secured object must be unique in the scope of the container, otherwise UESVaultServiceRTException is thrown.

Throws:

UESVaultServiceRTException - If the secured object cannot be stored.

Since:

UES6-06

getSecuredObject

SecuredObject getSecuredObject(java.lang.String containerID,
java.lang.String objectID)
throws UESVaultServiceRTException

Reads a secured object from container with the given ID. Only owner of container with the given ID is allowed to read the secured object from the container, otherwise UESVaultServiceRTException is thrown. (Unlike other operations, only directly logged owner is allowed to read the data. It is not possible to read data as owner logged via cz.ues.platform.security.authn.UESAuthenticationService#executeAs(String, cz.ues.platform.commons.lang.UESCallable).

Parameters:

containerID - ID of the container where to look for the secured object. In case no container with the given ID exists, null is returned.

objectID - ID of the secured object to be read. In case no secured object with the given ID exists in the given container, null is returned.

Returns:

The secured object or null if no such object exists.

Throws:

UESVaultServiceRTException - If the secured object cannot be read.

Since:

UES6-06

updateSecuredObject

SecuredObject updateSecuredObject(java.lang.String containerID,
SecuredObject secObject)
throws UESVaultServiceRTException

Updates existing secured object in container with given ID. Given secured object entries are merged with existing entries. It is not possible to remove secured object entry using update method, only change its value or create new secured object entry.

Parameters:

containerID - ID of container where to update secured object. If the ID is empty or container with the given ID does not exist, UESVaultServiceRTException is thrown.

secObject - The secured object to be updated in container. ID of the secured object must be set and exists in the scope of the container, otherwise UESVaultServiceRTException is thrown.

Returns:

The updated secured object

Throws:

UESVaultServiceRTException - If the secured object cannot be updated.

Since:

UES6-06

deleteSecuredObject

void deleteSecuredObject(java.lang.String containerId,
java.lang.String objectID)
throws UESVaultServiceRTException

Deletes a secured object from container with the given ID. Only owner of container with the given ID is allowed to delete secured objects from the container, otherwise UESVaultServiceRTException is thrown.

Parameters:

containerId - ID of container from which to delete the secured object.

objectID - ID of the secured object to delete.

Throws:

UESVaultServiceRTException - If the secured object cannot be deleted.

Since:

UES6-06