Packages

c

com.digitalasset.canton.console.commands

EnterpriseSecretKeyAdministration

class EnterpriseSecretKeyAdministration extends SecretKeyAdministration with EnterpriseSecretKeyAdministrationBase

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EnterpriseSecretKeyAdministration
  2. EnterpriseSecretKeyAdministrationBase
  3. SecretKeyAdministration
  4. FeatureFlagFilter
  5. NamedLogging
  6. Helpful
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new EnterpriseSecretKeyAdministration(instance: InstanceReferenceCommon, runner: AdminCommandRunner, environment: ConsoleEnvironment, loggerFactory: NamedLoggerFactory)

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 cantonConfig: CantonConfig
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  6. def check[T](flag: FeatureFlag)(command: => T): T
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  8. val consoleEnvironment: ConsoleEnvironment
    Attributes
    protected
    Definition Classes
    SecretKeyAdministrationFeatureFlagFilter
  9. def delete(fingerprint: Fingerprint, force: Boolean = false): Unit
    Definition Classes
    SecretKeyAdministration
    Annotations
    @Summary(s = "Delete private key", flag = console.this.Help.Summary.<init>$default$2)
  10. def download(fingerprint: Fingerprint, protocolVersion: ProtocolVersion = ProtocolVersion.latestStable): ByteString
    Definition Classes
    SecretKeyAdministration
    Annotations
    @Summary(s = "Download key pair", flag = FeatureFlag.Preview) @Description(s = """Download the key pair with the private and public key in its binary representation.
    |fingerprint: The identifier of the key pair to download
    |protocolVersion: The (optional) protocol version that defines the serialization of the key pair"""
    )
  11. def download_to(fingerprint: Fingerprint, outputFile: String, protocolVersion: ProtocolVersion = ProtocolVersion.latestStable): Unit
    Definition Classes
    SecretKeyAdministration
    Annotations
    @Summary(s = "Download key pair and save it to a file", flag = console.this.Help.Summary.<init>$default$2)
  12. val environment: ConsoleEnvironment
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  16. def findPublicKeys(topologyAdmin: TopologyAdministrationGroupCommon, owner: KeyOwner): Seq[PublicKey]

    Helper to find public keys for topology/x shared between community and enterprise

    Helper to find public keys for topology/x shared between community and enterprise

    Attributes
    protected
    Definition Classes
    SecretKeyAdministration
  17. def generateNewNameForRotatedKey(currentKeyId: String, clock: Clock): Option[String]

    Helper to name new keys generated during a rotation with a ...-rotated-<timestamp> tag to better identify the new keys after a rotation

    Helper to name new keys generated during a rotation with a ...-rotated-<timestamp> tag to better identify the new keys after a rotation

    Attributes
    protected
    Definition Classes
    SecretKeyAdministration
  18. def generate_encryption_key(name: String = "", scheme: Option[EncryptionKeyScheme] = None): EncryptionPublicKey
    Definition Classes
    SecretKeyAdministration
    Annotations
    @Summary(s = "Generate new public/private key pair for encryption and store it in the vault", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """
    |The optional name argument allows you to store an associated string for your convenience.
    |The scheme can be used to select a key scheme and the default scheme is used if left unspecified."""
    )
  19. def generate_signing_key(name: String = "", scheme: Option[SigningKeyScheme] = None): SigningPublicKey
    Definition Classes
    SecretKeyAdministration
    Annotations
    @Summary(s = "Generate new public/private key pair for signing and store it in the vault", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """
    |The optional name argument allows you to store an associated string for your convenience.
    |The scheme can be used to select a key scheme and the default scheme is used if left unspecified."""
    )
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  21. def get_wrapper_key_id(): String
    Definition Classes
    SecretKeyAdministration
    Annotations
    @Summary(s = "Get the wrapper key id that is used for the encrypted private keys store", flag = console.this.Help.Summary.<init>$default$2)
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  23. def help(methodName: String)(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
    Annotations
    @Summary(s = "Help for specific commands (use help() or help(\"method\") for more information)", flag = console.this.Help.Summary.<init>$default$2) @Topic(t = Seq("Top-level Commands"))
  24. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  25. val instance: InstanceReferenceCommon
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def list(filterFingerprint: String = "", filterName: String = "", purpose: Set[KeyPurpose] = Set.empty): Seq[PrivateKeyMetadata]
    Definition Classes
    SecretKeyAdministration
    Annotations
    @Summary(s = "List keys in private vault", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Returns all public keys to the corresponding private keys in the key vault.
    |Optional arguments can be used for filtering."""
    )
  28. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  29. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    SecretKeyAdministrationNamedLogging
  30. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  35. def regenerateKey(currentKey: PublicKey, name: Option[String]): PublicKey
    Attributes
    protected
    Definition Classes
    SecretKeyAdministration
  36. def register_kms_encryption_key(kmsKeyId: String, name: String = ""): EncryptionPublicKey
    Definition Classes
    SecretKeyAdministration
    Annotations
    @Summary(s = "Register the specified KMS encryption key in canton storing its public information in the vault", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """
    |The id for the KMS encryption key.
    |The optional name argument allows you to store an associated string for your convenience."""
    )
  37. def register_kms_signing_key(kmsKeyId: String, name: String = ""): SigningPublicKey
    Definition Classes
    SecretKeyAdministration
    Annotations
    @Summary(s = "Register the specified KMS signing key in canton storing its public information in the vault", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """
    |The id for the KMS signing key.
    |The optional name argument allows you to store an associated string for your convenience."""
    )
  38. def rotate_kms_node_key(fingerprint: String, newKmsKeyId: String): PublicKey
    Definition Classes
    SecretKeyAdministration
    Annotations
    @Summary(s = "Rotate a given node's keypair with a new pre-generated KMS keypair", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Rotates an existing encryption or signing key stored externally in a KMS with a pre-generated
    key.
    |The fingerprint of the key we want to rotate.
    |The id of the new KMS key (e.g. Resource Name)."""
    )
  39. def rotate_node_key(fingerprint: String, name: Option[String] = None): PublicKey
    Definition Classes
    SecretKeyAdministration
    Annotations
    @Summary(s = "Rotate a node's public/private key pair", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Rotates an existing encryption or signing key. NOTE: A namespace root or intermediate
    signing key CANNOT be rotated by this command.
    |The fingerprint of the key we want to rotate."""
    )
  40. def rotate_node_keys(domainTopologyManager: DomainManagerNodeReference): Unit
    Definition Classes
    EnterpriseSecretKeyAdministrationBase
    Annotations
    @Summary(s = "Rotate the node's public/private key pairs", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """
    |For a sequencer or mediator node it rotates the signing key pair.
    |NOTE: Namespace root or intermediate signing keys are NOT rotated by this command."""
    )
  41. def rotate_node_keys(): Unit
  42. def rotate_wrapper_key(newWrapperKeyId: String = ""): Unit
    Definition Classes
    SecretKeyAdministration
    Annotations
    @Summary(s = "Change the wrapper key for encrypted private keys store", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Change the wrapper key (e.g. AWS KMS key) being used to encrypt the private keys in the store.
    |newWrapperKeyId: The optional new wrapper key id to be used. If the wrapper key id is empty Canton will generate a new key based on the current configuration."""
    )
  43. val runner: AdminCommandRunner
  44. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  45. def toString(): String
    Definition Classes
    AnyRef → Any
  46. def upload(pairBytes: ByteString, name: Option[String]): Unit
    Definition Classes
    SecretKeyAdministration
    Annotations
    @Summary(s = "Upload a key pair", flag = console.this.Help.Summary.<init>$default$2)
  47. def upload(filename: String, name: Option[String]): Unit
    Definition Classes
    SecretKeyAdministration
    Annotations
    @Summary(s = "Upload (load and import) a key pair from file", flag = console.this.Help.Summary.<init>$default$2)
  48. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  50. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. def writeToFile(outputFile: String, bytes: ByteString): Unit
    Attributes
    protected
    Definition Classes
    SecretKeyAdministration

Deprecated Value Members

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

Inherited from FeatureFlagFilter

Inherited from NamedLogging

Inherited from Helpful

Inherited from AnyRef

Inherited from Any

Ungrouped