akka.persistence.gdpr.scaladsl

Interface KeyManagement

All Known Implementing Classes:

DelegatingKeyManagement, JCAKeyManagement

public interface KeyManagement

Manages keys for GDPR encryption. Should produce AES SecretKeys.

Implementations must be thread-safe.

Method Summary

Modifier and Type	Method and Description
scala.concurrent.Future<scala.Option<javax.crypto.SecretKey>>	getKey(java.lang.String dataSubjectId) Retrieve the key identified by dataSubjectId, returning None if the key has been shredded.
scala.concurrent.Future<javax.crypto.SecretKey>	getOrCreateKey(java.lang.String dataSubjectId) Create a SecretKey if it doesn't exist already.
scala.concurrent.Future<akka.Done>	shred(java.lang.String dataSubjectId) Remove the key identified by dataSubjectId permanently.

Method Detail

getKey

scala.concurrent.Future<scala.Option<javax.crypto.SecretKey>> getKey(java.lang.String dataSubjectId)

Retrieve the key identified by dataSubjectId, returning None if the key has been shredded.

Parameters:

dataSubjectId - (undocumented)

Returns:

(undocumented)

getOrCreateKey

scala.concurrent.Future<javax.crypto.SecretKey> getOrCreateKey(java.lang.String dataSubjectId)

Create a SecretKey if it doesn't exist already. Length of the key should be taken from akka.persistence.gdpr.key-size

If using AbstractGdprEncryption this must be an AES key.

Parameters:

dataSubjectId - (undocumented)

Returns:

(undocumented)

shred

scala.concurrent.Future<akka.Done> shred(java.lang.String dataSubjectId)

Remove the key identified by dataSubjectId permanently.

Parameters:

dataSubjectId - (undocumented)

Returns:

(undocumented)