trait CryptoPrivateStore extends AutoCloseable

A store for cryptographic private material such as signing/encryption private keys and hmac secrets.

It encapsulates only existence checks/delete operations so it can be extendable to an external crypto private store (e.g. an AWS KMS store).

Linear Supertypes
AutoCloseable, AnyRef, Any
Known Subclasses
CryptoPrivateStoreExtended, EncryptedCryptoPrivateStore, KmsCryptoPrivateStore, DbCryptoPrivateStore, InMemoryCryptoPrivateStore
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CryptoPrivateStore
  2. AutoCloseable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def close(): Unit
    Definition Classes
    AutoCloseable
    Annotations
    @throws(classOf[java.lang.Exception])
  2. abstract def existsDecryptionKey(decryptionKeyId: Fingerprint)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, CryptoPrivateStoreError, Boolean]
  3. abstract def existsPrivateKey(keyId: Fingerprint, purpose: KeyPurpose)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, CryptoPrivateStoreError, Boolean]
  4. abstract def existsSigningKey(signingKeyId: Fingerprint)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, CryptoPrivateStoreError, Boolean]
  5. abstract def filterSigningKeys(signingKeyIds: NonEmpty[Seq[Fingerprint]], filterUsage: NonEmpty[Set[SigningKeyUsage]])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, CryptoPrivateStoreError, Seq[Fingerprint]]

    Filter signing keys by checking if their usage intersects with the provided 'filterUsage' set.

    Filter signing keys by checking if their usage intersects with the provided 'filterUsage' set. This ensures that only keys with one or more matching usages are retained.

    signingKeyIds

    the fingerprint of the keys to filter

    filterUsage

    the key usages to filter for

  6. abstract def queryKmsKeyId(keyId: Fingerprint)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, CryptoPrivateStoreError, Option[String300]]

    Returns the KMS key id that corresponds to a given private key fingerprint or None if the private key is not stored in a KMS.

    Returns the KMS key id that corresponds to a given private key fingerprint or None if the private key is not stored in a KMS.

    keyId

    the private key fingerprint

    returns

    the KMS key id that matches the fingerprint, or None if key is not stored in a KMS

  7. abstract def removePrivateKey(keyId: Fingerprint)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, CryptoPrivateStoreError, Unit]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toExtended: Option[CryptoPrivateStoreExtended]
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped