object owner_to_key_mappings extends Helpful
- Annotations
- @Summary(s = "Manage owner to key mappings", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Owner to key mappings")
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- owner_to_key_mappings
- Helpful
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
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
- def add_key(key: Fingerprint, purpose: KeyPurpose, keyOwner: Member = instance.id.member, signedBy: Seq[Fingerprint] = Seq.empty, synchronize: Option[NonNegativeDuration] = Some(
consoleEnvironment.commandTimeouts.bounded
), mustFullyAuthorize: Boolean = true): Unit
- Annotations
- @Summary(s = "Add a key to an owner to key mapping", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Add a key to an owner to key mapping. A key owner is anyone in the system that needs a key-pair known
|to all members (participants, mediators, sequencers) of a synchronizer. If no owner to key mapping exists for the
|specified key owner, create a new mapping with the specified key. The specified key needs to have
|been created previously via the `keys.secret` api.
key: Fingerprint of the key
purpose: The key purpose, i.e. whether the key is for signing or encryption
keyOwner: The member that owns the key
signedBy: Optional fingerprint of the authorizing key which in turn refers to a specific, locally existing certificate.
synchronize: Synchronize timeout can be used to ensure that the state has been propagated into the node
mustFullyAuthorize: Whether to only add the key if the member is in the position to authorize the change.
""")
- def add_keys(keys: Seq[(Fingerprint, KeyPurpose)], keyOwner: Member = instance.id.member, signedBy: Seq[Fingerprint] = Seq.empty, synchronize: Option[NonNegativeDuration] = Some(
consoleEnvironment.commandTimeouts.bounded
), mustFullyAuthorize: Boolean = true): Unit
- Annotations
- @Summary(s = "Add a set of keys to an owner to key mapping", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Add a set of keys to an owner to key mapping. A key owner is anyone in the system that needs a key-pair known
|to all members (participants, mediators, sequencers) of a synchronizer. If no owner to key mapping exists for the
|specified key owner, create a new mapping with the specified keys. The specified keys needs to have
|been created previously via the `keys.secret` api.
keys: Fingerprint and key purpose of the keys
keyOwner: The member that owns the key
signedBy: Optional fingerprint of the authorizing key which in turn refers to a specific, locally existing certificate.
synchronize: Synchronize timeout can be used to ensure that the state has been propagated into the node
mustFullyAuthorize: Whether to only add the key if the member is in the position to authorize the change.
""")
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- 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(store: Option[TopologyStoreId] = None, proposals: Boolean = false, timeQuery: TimeQuery = TimeQuery.HeadState, operation: Option[TopologyChangeOp] = Some(TopologyChangeOp.Replace), filterKeyOwnerType: Option[MemberCode] = None, filterKeyOwnerUid: String = "", filterSigningKey: String = "", protocolVersion: Option[String] = None): Seq[ListOwnerToKeyMappingResult]
- Annotations
- @Summary(s = "List owner to key mapping transactions", flag = console.this.Help.Summary.<init>$default$2)
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def propose(proposedMapping: OwnerToKeyMapping, serial: Option[PositiveInt] = None, ops: TopologyChangeOp = TopologyChangeOp.Replace, signedBy: Seq[Fingerprint] = Seq.empty, store: TopologyStoreId = TopologyStoreId.Authorized, synchronize: Option[NonNegativeDuration] = Some( consoleEnvironment.commandTimeouts.bounded ), mustFullyAuthorize: Boolean = true, force: ForceFlags = ForceFlags.none): SignedTopologyTransaction[TopologyChangeOp, OwnerToKeyMapping]
- def remove_key(key: Fingerprint, purpose: KeyPurpose, keyOwner: Member = instance.id.member, signedBy: Seq[Fingerprint] = Seq.empty, synchronize: Option[NonNegativeDuration] = Some(
consoleEnvironment.commandTimeouts.bounded
), mustFullyAuthorize: Boolean = true, force: ForceFlags = ForceFlags.none): Unit
- Annotations
- @Summary(s = "Remove a key from an owner to key mapping", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Remove a key from an owner to key mapping. A key owner is anyone in the system that needs a key-pair known
|to all members (participants, mediators, sequencers) of a synchronizer. If the specified key is the last key in the
|owner to key mapping (which requires the force to be true), the owner to key mapping will be removed.
|The specified key needs to have been created previously via the `keys.secret` api.
key: Fingerprint of the key
purpose: The key purpose, i.e. whether the key is for signing or encryption
keyOwner: The member that owns the key
signedBy: Optional fingerprint of the authorizing key which in turn refers to a specific, locally existing certificate.
synchronize: Synchronize timeout can be used to ensure that the state has been propagated into the node
mustFullyAuthorize: Whether to only add the key if the member is in the position to authorize the change.
force: removing the last key is dangerous and must therefore be manually forced
""")
- def rotate_key(member: Member, currentKey: PublicKey, newKey: PublicKey, synchronize: Option[NonNegativeDuration] = Some(
consoleEnvironment.commandTimeouts.bounded
)): Unit
- Annotations
- @Summary(s = "Rotate the key for an owner to key mapping", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Rotates an existing key of the owner's owner to key mapping by adding the new key and removing the previous
|key.
nodeInstance: The node instance that is used to verify that both the current and new key pertain to this node.
This avoids conflicts when there are different nodes with the same uuid (i.e., multiple sequencers).
owner: The member that owns the owner to key mapping
currentKey: The current public key that will be rotated
newKey: The new public key that has been generated
""")
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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])