Packages

t

com.digitalasset.canton.crypto

CryptoPrivateStoreApi

trait CryptoPrivateStoreApi extends CryptoPrivateApi with EncryptionPrivateStoreOps with SigningPrivateStoreOps

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CryptoPrivateStoreApi
  2. SigningPrivateStoreOps
  3. EncryptionPrivateStoreOps
  4. CryptoPrivateApi
  5. CloseableHealthComponent
  6. HealthComponent
  7. CloseableHealthQuasiComponent
  8. HealthQuasiComponent
  9. CloseableHealthElement
  10. HealthElement
  11. FlagCloseable
  12. PerformUnlessClosing
  13. HasSynchronizeWithReaders
  14. HasSynchronizeWithClosing
  15. OnShutdownRunner
  16. HasRunOnClosing
  17. HasUnlessClosing
  18. AutoCloseable
  19. SigningPrivateOps
  20. EncryptionPrivateOps
  21. AnyRef
  22. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type State = ComponentHealthState

    The type of health states exposed by this component

    The type of health states exposed by this component

    Definition Classes
    HealthComponentHealthQuasiComponentHealthElement

Abstract Value Members

  1. implicit abstract val ec: ExecutionContext
    Definition Classes
    SigningPrivateStoreOps
  2. abstract def encryptionAlgorithmSpecs: CryptoScheme[EncryptionAlgorithmSpec]
    Definition Classes
    EncryptionPrivateOps
  3. abstract def encryptionKeySpecs: CryptoScheme[EncryptionKeySpec]
    Definition Classes
    EncryptionPrivateOps
  4. abstract val encryptionOps: EncryptionOps
    Attributes
    protected
    Definition Classes
    EncryptionPrivateStoreOps
  5. abstract def generateEncryptionKeypair(keySpec: EncryptionKeySpec)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, EncryptionKeyGenerationError, EncryptionKeyPair]

    Internal method to generate and return the entire encryption key pair

    Internal method to generate and return the entire encryption key pair

    Attributes
    protected[crypto]
    Definition Classes
    EncryptionPrivateStoreOps
  6. abstract def generateSigningKeypair(keySpec: SigningKeySpec, usage: NonEmpty[Set[SigningKeyUsage]])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, SigningKeyGenerationError, SigningKeyPair]

    Internal method to generate and return the entire signing key pair

    Internal method to generate and return the entire signing key pair

    Attributes
    protected[crypto]
    Definition Classes
    SigningPrivateStoreOps
  7. abstract def initialHealthState: State

    The initial state upon creation

    The initial state upon creation

    Attributes
    protected
    Definition Classes
    HealthElement
  8. abstract def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    HealthElement
  9. abstract def name: String

    Name of the health element.

    Name of the health element. Used for logging.

    Definition Classes
    HealthElement
  10. abstract def signingAlgorithmSpecs: CryptoScheme[SigningAlgorithmSpec]
    Definition Classes
    SigningPrivateOps
  11. abstract def signingKeySpecs: CryptoScheme[SigningKeySpec]
    Definition Classes
    SigningPrivateOps
  12. abstract val signingOps: SigningOps
    Attributes
    protected
    Definition Classes
    SigningPrivateStoreOps
  13. abstract val store: CryptoPrivateStoreExtended
    Attributes
    protected
    Definition Classes
    SigningPrivateStoreOps
  14. abstract def timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    FlagCloseable

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. 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
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. final def associatedHasRunOnClosing: FlagCloseable

    The com.digitalasset.canton.lifecycle.HasRunOnClosing associated with this object.

    The com.digitalasset.canton.lifecycle.HasRunOnClosing associated with this object.

    When this com.digitalasset.canton.lifecycle.HasRunOnClosing closes, the health state permanently becomes closingState and all listeners are notified about this.

    Attributes
    protected
    Definition Classes
    CloseableHealthElementHealthElement
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. 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
    FlagCloseableOnShutdownRunner → AutoCloseable
  9. def closingState: ComponentHealthState

    The state set when the associatedHasRunOnClosing closes

    The state set when the associatedHasRunOnClosing closes

    Definition Classes
    HealthComponentHealthQuasiComponentHealthElement
  10. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  11. def decrypt[M](encryptedMessage: AsymmetricEncrypted[M])(deserialize: (ByteString) => Either[DeserializationError, M])(implicit tc: TraceContext): EitherT[FutureUnlessShutdown, DecryptionError, M]

    Decrypts an encrypted message using the referenced private encryption key

    Decrypts an encrypted message using the referenced private encryption key

    Definition Classes
    EncryptionPrivateStoreOpsEncryptionPrivateOps
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def generateEncryptionKey(keySpec: EncryptionKeySpec = encryptionKeySpecs.default, name: Option[KeyName] = None)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, EncryptionKeyGenerationError, EncryptionPublicKey]

    Generates a new encryption key pair with the given scheme and optional name, stores the private key and returns the public key.

    Generates a new encryption key pair with the given scheme and optional name, stores the private key and returns the public key.

    Definition Classes
    EncryptionPrivateStoreOpsEncryptionPrivateOps
  15. def generateSigningKey(keySpec: SigningKeySpec, usage: NonEmpty[Set[SigningKeyUsage]], name: Option[KeyName])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, SigningKeyGenerationError, SigningPublicKey]

    Generates a new signing key pair with the given scheme and optional name, stores the private key and returns the public key.

    Generates a new signing key pair with the given scheme and optional name, stores the private key and returns the public key.

    Definition Classes
    SigningPrivateStoreOpsSigningPrivateOps
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  17. final def getState: State

    Returns the current state

    Returns the current state

    Definition Classes
    HealthElement
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  19. 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 performUnlessClosing and friends.

    Definition Classes
    OnShutdownRunnerHasUnlessClosing
  20. def isDegraded: Boolean
    Definition Classes
    HealthQuasiComponent
  21. def isFailed: Boolean
    Definition Classes
    HealthQuasiComponent
  22. def isFatal: Boolean
    Definition Classes
    HealthQuasiComponent
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def isOk: Boolean
    Definition Classes
    HealthQuasiComponent
  25. 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
    PerformUnlessClosingHasSynchronizeWithReaders
  26. def nameInternal: String
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  30. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  31. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  32. 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
    PerformUnlessClosingOnShutdownRunner
  33. def prettyState: Pretty[State]
    Attributes
    protected
    Definition Classes
    HealthQuasiComponentHealthElement
  34. def refreshState(newState: Eval[State])(implicit traceContext: TraceContext): Unit

    Triggers a refresh of the component's state, using newState to determine the new state.

    Triggers a refresh of the component's state, using newState to determine the new state. May return before the newState has been evaluated and the listeners have been poked.

    Note that listeners need not be poked about every state change; it suffices that they are poked eventually after each state change. So if there are frequent updates to the state, possibly from concurrent calls, then the listeners may never see some intermediate states.

    Attributes
    protected
    Definition Classes
    HealthElement
  35. def registerHighPriorityOnHealthChange(listener: HealthListener): Boolean

    Registers a high priority listener that gets poked upon each change of this element's health state.

    Registers a high priority listener that gets poked upon each change of this element's health state. This listener will be run before listeners registered via registerOnHealthChange

    returns

    Whether the listener was not registered before

    Definition Classes
    HealthElement
  36. def registerOnHealthChange(listener: HealthListener, pokeIfNew: Boolean = true): Boolean

    Registers a listener that gets poked upon each change of this element's health state.

    Registers a listener that gets poked upon each change of this element's health state.

    pokeIfNew

    if true (default), poke the listener if it's new

    returns

    Whether the listener was not registered before

    Definition Classes
    HealthElement
  37. def remainingReaders(): Seq[String]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  38. 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
  39. 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's closeAsync method completes or when AutoCloseable's close method returns, unless the returned LifeCycleRegistrationHandle was 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
    OnShutdownRunnerHasRunOnClosing
  40. 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's closeAsync method completes or AutoCloseable's close returns. This is because the task is run immediately if the component has already been closed.

    Definition Classes
    HasRunOnClosing
  41. final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit

    Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.

  42. def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
    Attributes
    protected[this]
    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  43. def sign(hash: Hash, signingKeyId: Fingerprint, usage: NonEmpty[Set[SigningKeyUsage]], signingAlgorithmSpec: SigningAlgorithmSpec = signingAlgorithmSpecs.default)(implicit tc: TraceContext): EitherT[FutureUnlessShutdown, SigningError, Signature]

    Signs the given hash using the referenced private signing key.

    Signs the given hash using the referenced private signing key.

    Definition Classes
    SigningPrivateOps
  44. def signBytes(bytes: ByteString, signingKeyId: Fingerprint, usage: NonEmpty[Set[SigningKeyUsage]], signingAlgorithmSpec: SigningAlgorithmSpec)(implicit tc: TraceContext): EitherT[FutureUnlessShutdown, SigningError, Signature]

    Signs the byte string directly, however it is encouraged to sign a hash.

    Signs the byte string directly, however it is encouraged to sign a hash.

    Definition Classes
    SigningPrivateStoreOpsSigningPrivateOps
  45. def stateLoggingLevel(state: ComponentHealthState): Level
    Attributes
    protected
    Definition Classes
    HealthComponentHealthElement
  46. def synchronizeWithClosing[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F], A: CanAbortDueToShutdown[F]): F[A]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    The computation completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise it is the result of running f.

    Definition Classes
    HasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  47. def synchronizeWithClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns.

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns. Equivalent to

    synchronizeWithClosing(name)(FutureUnlessShutdown.outcomeF(f))
    Definition Classes
    PerformUnlessClosing
  48. def synchronizeWithClosingPatience: FiniteDuration
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  49. def synchronizeWithClosingSync[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has finished or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run.

    Definition Classes
    HasSynchronizeWithClosing
    Annotations
    @SuppressWarnings()
    See also

    HasRunOnClosing.isClosing

  50. def synchronizeWithClosingUS[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise the result of running f.

    Definition Classes
    PerformUnlessClosingHasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  51. def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  52. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  53. def toComponentStatus: ComponentStatus
    Definition Classes
    HealthQuasiComponent
  54. def toString(): String
    Definition Classes
    AnyRef → Any
  55. final def unlessClosing[F[_], A](fa: => F[A])(implicit F: CanAbortDueToShutdown[F]): F[A]

    Runs the computation fa unless isClosing returns true.

    Runs the computation fa unless isClosing returns true.

    This method does not delay the closing while fa is running, unlike the methods in HasSynchronizeWithClosing. Accordingly, this method is useful for intermittent checks whether the result of the computation is still relevant.

    returns

    The result of fa or com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if isClosing is true

    Definition Classes
    HasUnlessClosing
    Annotations
    @inline()
  56. def unregisterOnHealthChange(listener: HealthListener): Boolean

    Unregisters a listener.

    Unregisters a listener.

    returns

    Whether the listener was registered before.

    Definition Classes
    HealthElement
  57. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  58. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  59. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  60. def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders

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 SigningPrivateStoreOps

Inherited from CryptoPrivateApi

Inherited from HealthComponent

Inherited from HealthQuasiComponent

Inherited from CloseableHealthElement

Inherited from HealthElement

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from HasRunOnClosing

Inherited from HasUnlessClosing

Inherited from AutoCloseable

Inherited from SigningPrivateOps

Inherited from EncryptionPrivateOps

Inherited from AnyRef

Inherited from Any

Ungrouped