Packages

object KmsConfig

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KmsConfig
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class Aws(region: String, multiRegionKey: Boolean = false, auditLogging: Boolean = false, retries: RetryConfig = RetryConfig(), disableSslVerification: Boolean = false, endpointOverride: Option[String] = None) extends KmsConfig with Product with Serializable

    Stores the configuration for AWS KMS.

    Stores the configuration for AWS KMS. This configuration is mandatory if we want to protect Canton's private keys using an AWS KMS.

    region

    defines the AWS region to be use (e.g. us-east-1)

    multiRegionKey

    flag to enable multiRegion keys (Canton will generate single region keys by default)

    auditLogging

    when enabled, all calls to KMS will be logged. Defaults to false.

    retries

    retry configuration

    disableSslVerification

    When set to true, SSL verification is disabled. Mostly for testing purposes. Can only be used if non-standard-config is enabled.

    endpointOverride

    the [optional] endpoint for a proxy to be used by the KMS client.

  2. final case class CreateKeyRetriesConfig(interval: NonNegativeDuration = waitCreateIntervalDefault, timeout: NonNegativeDuration = waitCreateTimeoutDefault) extends Product with Serializable

    Retry configuration when waiting for a newly created key to exist

    Retry configuration when waiting for a newly created key to exist

    interval

    interval between retries

    timeout

    maximum amount of time to wait for the key to be created

  3. final case class ExponentialBackoffConfig(initialDelay: NonNegativeFiniteDuration = initialDelayDefault, maxDelay: NonNegativeDuration = maxDelayDefault, maxRetries: Int = retry.Forever) extends Product with Serializable

    Exponential backoff configuration for retries of network failures

    Exponential backoff configuration for retries of network failures

    initialDelay

    initial delay before the first retry

    maxDelay

    max delay between retries

    maxRetries

    max number of retries

  4. final case class Gcp(locationId: String, projectId: String, keyRingId: String, retries: RetryConfig = RetryConfig()) extends KmsConfig with Product with Serializable

    Stores the configuration for GCP KMS.

    Stores the configuration for GCP KMS. This configuration is mandatory if we want to protect Canton's private keys using a GCP KMS.

    locationId

    defines the GCP region to use (e.g. us-east1)

    projectId

    defines a GCP project to use (e.g. gcp-kms-testing)

    keyRingId

    defines a key-ring to where keys will be added. This can be created as a multi-region key-ring, which enables multi-region keys

    retries

    retry configuration

  5. final case class RetryConfig(failures: ExponentialBackoffConfig = ExponentialBackoffConfig(), createKey: CreateKeyRetriesConfig = CreateKeyRetriesConfig()) extends Product with Serializable

    Retry configuration for KMS operations

    Retry configuration for KMS operations

    failures

    exponential backoff retry configuration for retryable failures

    createKey

    fixed rate retry configuration when waiting for a newly created key to exist in the KMS

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]) @native() @HotSpotIntrinsicCandidate()
  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
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  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
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. object Aws extends Serializable
  20. object Gcp extends Serializable

Deprecated Value Members

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

Inherited from AnyRef

Inherited from Any

Ungrouped