Class

akka.persistence.gdpr

JavaKeyStoreGdprEncryption

Related Doc: package gdpr

Permalink

final class JavaKeyStoreGdprEncryption extends AbstractGdprEncryption

Implementation of GdprEncryption that has support for PKCS12 and JCEKS keystores.

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. If your application is distributed you'll need to create a KeyManagement implementation for your distributed secret store e.g. Vault and use that with AbstractGdprEncryption.

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

It can be enabled in configuration with:

akka.persistence.gdpr.encryption-provider = "akka.persistence.gdpr.jca-provider"
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JavaKeyStoreGdprEncryption
  2. AbstractGdprEncryption
  3. GdprEncryption
  4. Extension
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new JavaKeyStoreGdprEncryption(system: ExtendedActorSystem, configPath: String)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from JavaKeyStoreGdprEncryption to any2stringadd[JavaKeyStoreGdprEncryption] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (JavaKeyStoreGdprEncryption, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from JavaKeyStoreGdprEncryption to ArrowAssoc[JavaKeyStoreGdprEncryption] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def decrypt(payload: Array[Byte], dataSubjectId: String): Future[Option[Array[Byte]]]

    Permalink

    Decrypt the given payload with the key identified by dataSubjectId.

    Decrypt the given payload with the key identified by dataSubjectId.

    The key will be retrieved using the KeyManagement

    returns

    None if the key has been deleted

    Definition Classes
    AbstractGdprEncryptionGdprEncryption
  9. def encrypt(payload: Array[Byte], dataSubjectId: String): Future[Array[Byte]]

    Permalink

    Encrypt the given payload with the key identified by dataSubjectId.

    Encrypt the given payload with the key identified by dataSubjectId.

    The key will be either created or retrieved using the KeyManagement

    Definition Classes
    AbstractGdprEncryptionGdprEncryption
  10. def ensuring(cond: (JavaKeyStoreGdprEncryption) ⇒ Boolean, msg: ⇒ Any): JavaKeyStoreGdprEncryption

    Permalink
    Implicit information
    This member is added by an implicit conversion from JavaKeyStoreGdprEncryption to Ensuring[JavaKeyStoreGdprEncryption] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (JavaKeyStoreGdprEncryption) ⇒ Boolean): JavaKeyStoreGdprEncryption

    Permalink
    Implicit information
    This member is added by an implicit conversion from JavaKeyStoreGdprEncryption to Ensuring[JavaKeyStoreGdprEncryption] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): JavaKeyStoreGdprEncryption

    Permalink
    Implicit information
    This member is added by an implicit conversion from JavaKeyStoreGdprEncryption to Ensuring[JavaKeyStoreGdprEncryption] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): JavaKeyStoreGdprEncryption

    Permalink
    Implicit information
    This member is added by an implicit conversion from JavaKeyStoreGdprEncryption to Ensuring[JavaKeyStoreGdprEncryption] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from JavaKeyStoreGdprEncryption to StringFormat[JavaKeyStoreGdprEncryption] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. def gdprSettings: GdprSettings

    Permalink
    Definition Classes
    AbstractGdprEncryption
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. def keyManagement(): KeyManagement

    Permalink

    A KeyManagement for creating and retrieving keys.

    A KeyManagement for creating and retrieving keys.

    Definition Classes
    JavaKeyStoreGdprEncryptionAbstractGdprEncryption
  23. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. def secureRandom: SecureRandom

    Permalink

    The SecureRandom that is used for the initialization vectors of the encryption.

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

    Attributes
    protected
    Definition Classes
    AbstractGdprEncryption
  27. def shred(dataSubjectId: String): Future[Done]

    Permalink

    Remove the key identified by dataSubjectId from KeyManagement.

    Remove the key identified by dataSubjectId from KeyManagement.

    Definition Classes
    AbstractGdprEncryptionGdprEncryption
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  29. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  30. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. def [B](y: B): (JavaKeyStoreGdprEncryption, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from JavaKeyStoreGdprEncryption to ArrowAssoc[JavaKeyStoreGdprEncryption] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AbstractGdprEncryption

Inherited from GdprEncryption

Inherited from Extension

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from JavaKeyStoreGdprEncryption to any2stringadd[JavaKeyStoreGdprEncryption]

Inherited by implicit conversion StringFormat from JavaKeyStoreGdprEncryption to StringFormat[JavaKeyStoreGdprEncryption]

Inherited by implicit conversion Ensuring from JavaKeyStoreGdprEncryption to Ensuring[JavaKeyStoreGdprEncryption]

Inherited by implicit conversion ArrowAssoc from JavaKeyStoreGdprEncryption to ArrowAssoc[JavaKeyStoreGdprEncryption]

Ungrouped