com.digitalasset.canton.crypto.store
EncryptedCryptoPrivateStore
Companion object EncryptedCryptoPrivateStore
class EncryptedCryptoPrivateStore extends CryptoPrivateStoreExtended with FlagCloseable with NamedLogging with EncryptedCryptoPrivateStoreHelper
This class wraps a CryptoPrivateStore and implements an encrypted version that stores the private keys in encrypted form using a KMS
- Alphabetic
- By Inheritance
- EncryptedCryptoPrivateStore
- EncryptedCryptoPrivateStoreHelper
- NamedLogging
- FlagCloseable
- PerformUnlessClosing
- HasSynchronizeWithReaders
- HasSynchronizeWithClosing
- OnShutdownRunner
- HasRunOnClosing
- HasUnlessClosing
- CryptoPrivateStoreExtended
- CryptoPrivateStore
- AutoCloseable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new EncryptedCryptoPrivateStore(store: DbCryptoPrivateStore, kms: Kms, initialWrapperKeyId: KmsKeyId, releaseProtocolVersion: ReleaseProtocolVersion, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addReader(reader: String)(implicit traceContext: TraceContext): UnlessShutdown[ReaderHandle]
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def close(): Unit
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
- Definition Classes
- FlagCloseable → OnShutdownRunner → AutoCloseable
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable → PerformUnlessClosing
- def decryptStoredKey(kms: Kms, storedKey: StoredPrivateKey)(implicit ec: ExecutionContext, tc: TraceContext): EitherT[FutureUnlessShutdown, CryptoPrivateStoreError, StoredPrivateKey]
- Attributes
- protected
- Definition Classes
- EncryptedCryptoPrivateStoreHelper
- implicit val ec: ExecutionContext
- Definition Classes
- EncryptedCryptoPrivateStore → CryptoPrivateStoreExtended
- def encryptStoredKey(kms: Kms, wrapperKeyId: KmsKeyId, storedKey: StoredPrivateKey)(implicit ec: ExecutionContext, tc: TraceContext): EitherT[FutureUnlessShutdown, CryptoPrivateStoreError, StoredPrivateKey]
- Attributes
- protected
- Definition Classes
- EncryptedCryptoPrivateStoreHelper
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- def existsDecryptionKey(decryptionKeyId: Fingerprint)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, CryptoPrivateStoreError, Boolean]
- Definition Classes
- CryptoPrivateStoreExtended → CryptoPrivateStore
- def existsPrivateKey(keyId: Fingerprint, keyPurpose: KeyPurpose)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, CryptoPrivateStoreError, Boolean]
- Definition Classes
- CryptoPrivateStoreExtended → CryptoPrivateStore
- def existsSigningKey(signingKeyId: Fingerprint)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, CryptoPrivateStoreError, Boolean]
- Definition Classes
- CryptoPrivateStoreExtended → CryptoPrivateStore
- def exportPrivateKey(keyId: Fingerprint)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, CryptoPrivateStoreError, Option[PrivateKey]]
- Definition Classes
- CryptoPrivateStoreExtended
- 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
- Definition Classes
- CryptoPrivateStoreExtended → CryptoPrivateStore
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def isClosing: Boolean
Check whether we're closing.
Check whether we're closing. Susceptible to race conditions; unless you're using this as a flag to the retry lib or you really know what you're doing, prefer
performUnlessClosingand friends.- Definition Classes
- OnShutdownRunner → HasUnlessClosing
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def keepTrackOfReaderCallStack: Boolean
Set this to true to get detailed information about all futures that did not complete during shutdown.
Set this to true to get detailed information about all futures that did not complete during shutdown.
- Attributes
- protected[this]
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithReaders
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- EncryptedCryptoPrivateStore → NamedLogging
- def migratePrivateKeys(isActive: Boolean, timeouts: ProcessingTimeout)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, CryptoPrivateStoreError, Unit]
- Definition Classes
- CryptoPrivateStoreExtended
- def nameInternal: String
- Attributes
- protected[this]
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithReaders
- implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def onCloseFailure(e: Throwable): Unit
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def onClosed(): Unit
- Definition Classes
- EncryptedCryptoPrivateStore → PerformUnlessClosing
- final def onFirstClose(): Unit
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
- Definition Classes
- PerformUnlessClosing → OnShutdownRunner
- 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
- Definition Classes
- CryptoPrivateStoreExtended → CryptoPrivateStore
- val releaseProtocolVersion: ReleaseProtocolVersion
- Attributes
- protected
- Definition Classes
- EncryptedCryptoPrivateStore → CryptoPrivateStoreExtended
- def remainingReaders(): Seq[String]
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- def removePrivateKey(keyId: Fingerprint)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, CryptoPrivateStoreError, Unit]
- Definition Classes
- CryptoPrivateStoreExtended → CryptoPrivateStore
- def removeReader(handle: ReaderHandle): Unit
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- def runOnClose(task: RunOnClosing): UnlessShutdown[LifeCycleRegistrationHandle]
Schedules the given task to be run upon closing.
Schedules the given task to be run upon closing.
- returns
An com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome indicates that the task will have been run when the
LifeCycleManager'scloseAsyncmethod completes or whenAutoCloseable'sclosemethod returns, unless the returnedLifeCycleRegistrationHandlewas used to cancel the task or the task has been done beforehand. com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if the task is not run due to closing. This always happens if isClosing returns true.
- Definition Classes
- OnShutdownRunner → HasRunOnClosing
- def runOnOrAfterClose(task: RunOnClosing)(implicit traceContext: TraceContext): LifeCycleRegistrationHandle
Register a task to run when closing is initiated, or run it immediately if closing is already ongoing.
Register a task to run when closing is initiated, or run it immediately if closing is already ongoing. Unlike runOnClose, this method does not guarantee that this task will have run by the time the
LifeCycleManager'scloseAsyncmethod completes orAutoCloseable'sclosereturns. This is because the task is run immediately if the component has already been closed.- Definition Classes
- HasRunOnClosing
- final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.
Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.
- Definition Classes
- HasRunOnClosing
- def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
- Attributes
- protected[this]
- Definition Classes
- OnShutdownRunner → HasRunOnClosing
- val signingKeyMap: TrieMap[Fingerprint, SigningPrivateKeyWithName]
- Attributes
- protected
- Definition Classes
- CryptoPrivateStoreExtended
- def storePrivateKey(key: PrivateKey, name: Option[KeyName])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, CryptoPrivateStoreError, Unit]
- Definition Classes
- CryptoPrivateStoreExtended
- def synchronizeWithClosing[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F], A: CanAbortDueToShutdown[F]): F[A]
Runs the computation
fonly if the component is not yet closing.Runs the computation
fonly if the component is not yet closing. If so, the component will delay releasing its resources untilfhas completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or thesynchronizeWithClosingPatiencehas elapsed.DO NOT CALL
this.closeas part off, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef.- returns
The computation completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
fhas not run. Otherwise it is the result of runningf.
- Definition Classes
- HasSynchronizeWithClosing
- See also
HasRunOnClosing.isClosing
- def synchronizeWithClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Convenience method for synchronizing on
Futures instead ofFutureUnlessShutdowns.Convenience method for synchronizing on
Futures instead ofFutureUnlessShutdowns. Equivalent tosynchronizeWithClosing(name)(FutureUnlessShutdown.outcomeF(f))
- Definition Classes
- PerformUnlessClosing
- def synchronizeWithClosingPatience: FiniteDuration
- Attributes
- protected[this]
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithReaders
- def synchronizeWithClosingSync[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Runs the computation
fonly if the component is not yet closing.Runs the computation
fonly if the component is not yet closing. If so, the component will delay releasing its resources untilfhas finished or thesynchronizeWithClosingPatiencehas elapsed.DO NOT CALL
this.closeas part off, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef.- returns
com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
fhas not run.
- Definition Classes
- HasSynchronizeWithClosing
- Annotations
- @SuppressWarnings()
- See also
HasRunOnClosing.isClosing
- def synchronizeWithClosingUS[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
Runs the computation
fonly if the component is not yet closing.Runs the computation
fonly if the component is not yet closing. If so, the component will delay releasing its resources untilfhas completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or thesynchronizeWithClosingPatiencehas elapsed.DO NOT CALL
this.closeas part off, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef.- returns
com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
fhas not run. Otherwise the result of runningf.
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithClosing
- See also
HasRunOnClosing.isClosing
- def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- EncryptedCryptoPrivateStore → FlagCloseable
- def toExtended: Option[CryptoPrivateStoreExtended]
- Definition Classes
- CryptoPrivateStore
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def unlessClosing[F[_], A](fa: => F[A])(implicit F: CanAbortDueToShutdown[F]): F[A]
Runs the computation
faunless isClosing returns true.Runs the computation
faunless isClosing returns true.This method does not delay the closing while
fais running, unlike the methods inHasSynchronizeWithClosing. Accordingly, this method is useful for intermittent checks whether the result of the computation is still relevant.- returns
The result of
faor com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if isClosing is true
- Definition Classes
- HasUnlessClosing
- Annotations
- @inline()
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders