class LocalSecretKeyAdministration extends SecretKeyAdministration
Linear Supertypes
Known Subclasses
Ordering
- Alphabetic
- By Inheritance
Inherited
- LocalSecretKeyAdministration
- SecretKeyAdministration
- Helpful
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new LocalSecretKeyAdministration(instance: InstanceReference, runner: AdminCommandRunner, consoleEnvironment: ConsoleEnvironment, crypto: => Crypto)
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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def delete(fingerprint: Fingerprint, force: Boolean = false): Unit
- Annotations
- @Summary(s = "Delete private key", flag = console.this.Help.Summary.<init>$default$2)
- def download(fingerprint: Fingerprint, protocolVersion: ProtocolVersion = ProtocolVersion.latest): ByteString
- Annotations
- @Summary(s = "Download key pair", flag = console.this.Help.Summary.<init>$default$2)
- def download_to(fingerprint: Fingerprint, outputFile: String, protocolVersion: ProtocolVersion = ProtocolVersion.latest): Unit
- Annotations
- @Summary(s = "Download key pair and save it to a file", flag = console.this.Help.Summary.<init>$default$2)
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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.""")
- 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.""")
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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)
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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"))
- def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
- Definition Classes
- Helpful
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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.""")
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def regenerateKey(currentKey: PublicKey): PublicKey
- Attributes
- protected
- Definition Classes
- SecretKeyAdministration
- def rotate_node_keys(): Unit
- Definition Classes
- SecretKeyAdministration
- Annotations
- @Summary(s = "Rotate the node's public/private key pairs", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """
|For a participant node it rotates the signing and encryption key pair.
|For a domain or domain manager node it rotates the signing key pair as those nodes do not have an encryption key pair.
|For a sequencer or mediator node use `rotate_node_keys` with a domain manager reference as an argument.
|NOTE: Namespace root or intermediate signing keys are NOT rotated by this command.""")
- 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.""")
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def upload(pairBytes: ByteString, name: Option[String]): Unit
- Annotations
- @Summary(s = "Upload a key pair", flag = console.this.Help.Summary.<init>$default$2)
- def upload(filename: String, name: Option[String]): Unit
- Annotations
- @Summary(s = "Upload (load and import) a key pair from file", flag = console.this.Help.Summary.<init>$default$2)
- 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]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])