CompositeKey

A tree data structure that enables the representation of composite public keys, which are used to represent the signing requirements for multi-signature scenarios such as RAFT notary services. A composite key is a list of leaf keys and their contributing weight, and each leaf can be a conventional single key or a composite key. Keys contribute their weight to the total if they are matched by the signature.

For complex scenarios, such as "Both Alice and Bob need to sign to consume a state S", we can represent the requirement by creating a tree with a root CompositeKey, and Alice and Bob as children. The root node would specify weights for each of its children and a threshold – the minimum total weight required (e.g. the minimum number of child signatures required) to satisfy the tree signature requirement.

Using these constructs we can express e.g. 1 of N (OR) or N of N (AND) signature requirements. By nesting we can create multi-level requirements such as "either the CEO or 3 of 5 of his assistants need to sign".

Types

Link copied to clipboard
class Builder

A helper class for building a CompositeKey.

Link copied to clipboard
object Companion
Link copied to clipboard
data class NodeAndWeight(val node: PublicKey, val weight: Int) : Comparable<CompositeKey.NodeAndWeight>

Holds node - weight pairs for a CompositeKey. Ordered first by weight, then by node's hashCode. Each node should be assigned with a positive weight to avoid certain types of weight underflow attacks.

Properties

Link copied to clipboard

Τhe order of the children may not be the same to what was provided in the builder.

Link copied to clipboard
Link copied to clipboard

Return a Set of the contained leaf keys if this is a CompositeKey. Otherwise, return a Set with a single element (this PublicKey). Note that leaf keys cannot be of type CompositeKey.

Link copied to clipboard

Set of all leaf keys of that CompositeKey.

Link copied to clipboard

specifies the minimum total weight required (in the simple case – the minimum number of child signatures required) to satisfy the sub-tree rooted at this node.

Functions

Link copied to clipboard

This method will detect graph cycles in the full composite key structure to protect against infinite loops when traversing the graph and key duplicates in the each layer. It also checks if the threshold and weight constraint requirements are met, while it tests for aggregated-weight integer overflow. In practice, this method should be always invoked on the root CompositeKey, as it inherently validates the child nodes (all the way till the leaves).

Link copied to clipboard

Checks whether any of the given keys matches a leaf on the CompositeKey tree or a single PublicKey.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun getAlgorithm(): String
Link copied to clipboard
open override fun getEncoded(): ByteArray
Link copied to clipboard
open override fun getFormat(): <Error class: unknown class>
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
fun isFulfilledBy(key: PublicKey): <Error class: unknown class>

Takes single PublicKey and checks if CompositeKey requirements hold for that key.

Function checks if the public keys corresponding to the signatures are matched against the leaves of the composite key tree in question, and the total combined weight of all children is calculated for every intermediary node. If all thresholds are satisfied, the composite key requirement is considered to be met.

Link copied to clipboard

Return true if otherKey fulfils the requirements of this PublicKey.

Return true if otherKeys fulfil the requirements of this PublicKey.

Link copied to clipboard

Utility to simplify the act of verifying a signature. In comparison to verify if the key and signature do not match it returns false rather than throwing an exception. Normally you should use the function which throws, as it avoids the risk of failing to test the result, but this is for uses such as java.security.Signature.verify implementations.

Link copied to clipboard

Return the Base58 representation of the serialised public key.

Link copied to clipboard

Return the bytes of the SHA-256 output for this public key.

Link copied to clipboard
open override fun toString(): String
Link copied to clipboard

Render a public key to its hash (in Base58) of its serialised form using the DL prefix.

Link copied to clipboard
fun PublicKey.verify(signatureData: ByteArray, clearData: ByteArray): Boolean

Helper function to verify a signature.

Utility to simplify the act of verifying a signature.