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. OnShutdownRunner
  14. AutoCloseable
  15. SigningPrivateOps
  16. EncryptionPrivateOps
  17. AnyRef
  18. 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. abstract def defaultEncryptionKeyScheme: EncryptionKeyScheme
    Definition Classes
    EncryptionPrivateOps
  2. abstract def defaultSigningKeyScheme: SigningKeyScheme
    Definition Classes
    SigningPrivateOps
  3. implicit abstract val ec: ExecutionContext
    Definition Classes
    SigningPrivateStoreOps
  4. abstract val encryptionOps: EncryptionOps
    Attributes
    protected
    Definition Classes
    EncryptionPrivateStoreOps
  5. abstract def generateEncryptionKeypair(scheme: EncryptionKeyScheme)(implicit traceContext: TraceContext): EitherT[Future, 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(scheme: SigningKeyScheme)(implicit traceContext: TraceContext): EitherT[Future, 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 val signingOps: SigningOps
    Attributes
    protected
    Definition Classes
    SigningPrivateStoreOps
  11. abstract val store: CryptoPrivateStoreExtended
    Attributes
    protected
    Definition Classes
    SigningPrivateStoreOps
  12. 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. final def associatedOnShutdownRunner: FlagCloseable

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

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

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

    Attributes
    protected
    Definition Classes
    CloseableHealthElementHealthElement
  6. def cancelShutdownTask(token: Long): Unit

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Definition Classes
    OnShutdownRunner
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  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 associatedOnShutdownRunner closes

    The state set when the associatedOnShutdownRunner closes

    Definition Classes
    HealthComponentHealthQuasiComponentHealthElement
  10. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  11. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  12. def decrypt[M](encryptedMessage: AsymmetricEncrypted[M])(deserialize: (ByteString) => Either[DeserializationError, M])(implicit tc: TraceContext): EitherT[Future, 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
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def generateEncryptionKey(scheme: EncryptionKeyScheme = defaultEncryptionKeyScheme, name: Option[KeyName] = None)(implicit traceContext: TraceContext): EitherT[Future, 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
  16. def generateSigningKey(scheme: SigningKeyScheme, name: Option[KeyName])(implicit traceContext: TraceContext): EitherT[Future, 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
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  18. final def getState: State

    Returns the current state

    Returns the current state

    Definition Classes
    HealthElement
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  20. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  21. 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
    OnShutdownRunner
  22. def isDegrading: Boolean
    Definition Classes
    HealthQuasiComponent
  23. def isFailed: Boolean
    Definition Classes
    HealthQuasiComponent
  24. def isFatal: Boolean
    Definition Classes
    HealthQuasiComponent
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. def isOk: Boolean
    Definition Classes
    HealthQuasiComponent
  27. def keepTrackOfOpenFutures: Boolean

    track running futures on shutdown

    track running futures on shutdown

    set to true to get detailed information about all futures that did not complete during shutdown. if set to false, we don't do anything.

    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  28. def maxSleepMillis: Long

    How often to poll to check that all tasks have completed.

    How often to poll to check that all tasks have completed.

    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  32. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  33. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  34. 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
    Annotations
    @SuppressWarnings()
  35. def performUnlessClosing[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]

    Performs the task given by f unless a shutdown has been initiated.

    Performs the task given by f unless a shutdown has been initiated. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, if started using this function, or one of the other variants (performUnlessClosingF and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.

    DO NOT CALL this.close as part of f, because it will result in a deadlock.

    f

    The task to perform

    returns

    scala.None$ if a shutdown has been initiated. Otherwise the result of the task.

    Definition Classes
    PerformUnlessClosing
  36. def performUnlessClosingCheckedT[A, N, R](name: String, onClosing: => Checked[A, N, R])(etf: => CheckedT[Future, A, N, R])(implicit ec: ExecutionContext, traceContext: TraceContext): CheckedT[Future, A, N, R]
    Definition Classes
    PerformUnlessClosing
  37. def performUnlessClosingEitherT[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, R]

    Performs the EitherT[Future] given by etf unless a shutdown has been initiated, in which case the provided error is returned instead.

    Performs the EitherT[Future] given by etf unless a shutdown has been initiated, in which case the provided error is returned instead. Both etf and the error are lazy; etf is only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin after etf completes, but other tasks may execute concurrently with etf, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingF). The tasks are assumed to take less than closingTimeout to complete.

    DO NOT CALL this.close as part of etf, because it will result in a deadlock.

    etf

    The task to perform

    Definition Classes
    PerformUnlessClosing
  38. def performUnlessClosingEitherTF[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
    Definition Classes
    PerformUnlessClosing
  39. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  40. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  41. def performUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Performs the Future given by f unless a shutdown has been initiated.

    Performs the Future given by f unless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.

    DO NOT CALL this.close as part of f, because it will result in a deadlock.

    f

    The task to perform

    returns

    The future completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if a shutdown has been initiated. Otherwise the result of the task wrapped in com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome.

    Definition Classes
    PerformUnlessClosing
  42. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  43. def prettyState: Pretty[State]
    Attributes
    protected
    Definition Classes
    HealthQuasiComponentHealthElement
  44. 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
  45. def registerOnHealthChange(listener: HealthListener): 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.

    returns

    Whether the listener was not registered before

    Definition Classes
    HealthElement
  46. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Long

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Definition Classes
    OnShutdownRunner
  47. def runOnShutdown_[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit

    Register a task to run when shutdown is initiated.

    Register a task to run when shutdown is initiated.

    You can use this for example to register tasks that cancel long-running computations, whose termination you can then wait for in "closeAsync".

    Definition Classes
    OnShutdownRunner
  48. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  49. def sign(bytes: ByteString, signingKeyId: Fingerprint)(implicit tc: TraceContext): EitherT[Future, 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.

    Attributes
    protected[crypto]
    Definition Classes
    SigningPrivateStoreOpsSigningPrivateOps
  50. def sign(hash: Hash, signingKeyId: Fingerprint)(implicit tc: TraceContext): EitherT[Future, 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
  51. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  52. def toComponentStatus: ComponentStatus
    Definition Classes
    HealthQuasiComponent
  53. def toString(): String
    Definition Classes
    AnyRef → Any
  54. def unregisterOnHealthChange(listener: HealthListener): Boolean

    Unregisters a listener.

    Unregisters a listener.

    returns

    Whether the listener was registered before.

    Definition Classes
    HealthElement
  55. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  56. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  57. 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
    Deprecated

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 AutoCloseable

Inherited from SigningPrivateOps

Inherited from EncryptionPrivateOps

Inherited from AnyRef

Inherited from Any

Ungrouped