akka.persistence.gdpr.scaladsl

Class AbstractGdprEncryption

java.lang.Object

akka.persistence.gdpr.scaladsl.AbstractGdprEncryption

All Implemented Interfaces:

akka.actor.Extension, GdprEncryption

Direct Known Subclasses:

JavaKeyStoreGdprEncryption, TestGdprEncryption

public abstract class AbstractGdprEncryption
extends java.lang.Object
implements GdprEncryption

Extension point for creating a GdprEncryption by only providing the KeyManagement facilities.

This uses AES/GCM/NoPadding with an initialization vector created from a SecureRandom.

Implementations must be thread-safe.

Constructor Summary

Constructors

Constructor and Description
AbstractGdprEncryption(akka.actor.ExtendedActorSystem system)

Method Summary

Modifier and Type	Method and Description
scala.concurrent.Future<scala.Option<byte[]>>	decrypt(byte[] payload, java.lang.String dataSubjectId) Decrypt the given payload with the key identified by dataSubjectId.
scala.concurrent.Future<byte[]>	encrypt(byte[] payload, java.lang.String dataSubjectId) Encrypt the given payload with the key identified by dataSubjectId.
static java.lang.String	EncryptionMethod()
GdprSettings	gdprSettings()
protected abstract KeyManagement	keyManagement() A KeyManagement for creating and retrieving keys.
protected java.security.SecureRandom	secureRandom() The SecureRandom that is used for the initialization vectors of the encryption.
scala.concurrent.Future<akka.Done>	shred(java.lang.String dataSubjectId) Remove the key identified by dataSubjectId from KeyManagement.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractGdprEncryption

public AbstractGdprEncryption(akka.actor.ExtendedActorSystem system)

Method Detail

EncryptionMethod

public static java.lang.String EncryptionMethod()

gdprSettings

public GdprSettings gdprSettings()

secureRandom

protected java.security.SecureRandom secureRandom()

The SecureRandom that is used for the initialization vectors of the encryption. Subclass may override to define another implementation than the default.

Returns:

(undocumented)

keyManagement

protected abstract KeyManagement keyManagement()

A KeyManagement for creating and retrieving keys.

Returns:

(undocumented)

encrypt

public scala.concurrent.Future<byte[]> encrypt(byte[] payload,
                                               java.lang.String dataSubjectId)

Encrypt the given payload with the key identified by dataSubjectId.

The key will be either created or retrieved using the KeyManagement

Specified by:

encrypt in interface GdprEncryption

Parameters:

payload - (undocumented)

dataSubjectId - (undocumented)

Returns:

(undocumented)

decrypt

public scala.concurrent.Future<scala.Option<byte[]>> decrypt(byte[] payload,
                                                             java.lang.String dataSubjectId)

Decrypt the given payload with the key identified by dataSubjectId.

The key will be retrieved using the KeyManagement

Specified by:

decrypt in interface GdprEncryption

Parameters:

payload - (undocumented)

dataSubjectId - (undocumented)

Returns:

None if the key has been deleted

shred

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

Remove the key identified by dataSubjectId from KeyManagement.

Specified by:

shred in interface GdprEncryption

Parameters:

dataSubjectId - (undocumented)

Returns:

(undocumented)