akka.persistence.gdpr

Class JCAKeyManagement

java.lang.Object

akka.persistence.gdpr.JCAKeyManagement

All Implemented Interfaces:

KeyManagement

public class JCAKeyManagement
extends java.lang.Object
implements KeyManagement

Supports JCEKS, PKSC12

JKS is only for certificates/public key encryption.

Not intended for production use other than possibly for single node applications as it saves to a local file so won't be available for all other nodes in the cluster.

The Java Keystore API is blocking so it's important to use this from a dedicated dispatcher.

Constructor Summary

Constructors

Constructor and Description
JCAKeyManagement(akka.actor.ExtendedActorSystem system, GdprSettings gdprSettings, JcaSettings jcaSettings)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

JCAKeyManagement

public JCAKeyManagement(akka.actor.ExtendedActorSystem system,
                        GdprSettings gdprSettings,
                        JcaSettings jcaSettings)

Method Detail

getKey

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

Description copied from interface: KeyManagement

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

Specified by:

getKey in interface KeyManagement

Parameters:

dataSubjectId - (undocumented)

Returns:

(undocumented)

getOrCreateKey

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

Description copied from interface: KeyManagement

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.

Specified by:

getOrCreateKey in interface KeyManagement

Parameters:

dataSubjectId - (undocumented)

Returns:

(undocumented)

shred

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

Description copied from interface: KeyManagement

Remove the key identified by dataSubjectId permanently.

Specified by:

shred in interface KeyManagement

Parameters:

dataSubjectId - (undocumented)

Returns:

(undocumented)