EdgeAgentSDK/org.hyperledger.identus.walletsdk.domain.buildingblocks/Castor

Castor

Castor is a powerful and flexible library for working with DIDs. Whether you are building a decentralised application or a more traditional system requiring secure and private identity management, Castor provides the tools and features you need to easily create, manage, and resolve DIDs.

Inheritors

CastorImpl

Functions

createPeerDID

abstract fun createPeerDID(keyPairs: Array<KeyPair>, services: Array<DIDDocument.Service>): DID

Creates a DID for a peer (a device or server that acts as a DID subject) using given key agreement and authentication key pairs and a list of services.

createPrismDID

abstract fun createPrismDID(masterPublicKey: PublicKey, services: Array<DIDDocument.Service>?): DID

Creates a DID for a prism (a device or server that acts as a DID owner and controller) using a given master public key and list of services.

getPublicKeysFromCoreProperties

abstract fun getPublicKeysFromCoreProperties(coreProperties: Array<DIDDocumentCoreProperty>): List<PublicKey>

Extract list of PublicKey from a list of DIDDocumentCoreProperty.

parseDID

abstract fun parseDID(did: String): DID

Parses a string representation of a Decentralized Identifier (DID) into a DID object.

resolveDID

abstract suspend fun resolveDID(did: String): DIDDocument

Asynchronously resolves a DID to its corresponding DID Document. This function may throw an error if the DID is invalid or the document cannot be retrieved.

verifySignature

abstract suspend fun verifySignature(did: DID, challenge: ByteArray, signature: ByteArray): Boolean

Verifies the authenticity of a signature using the corresponding DID Document, challenge, and signature data. This function returns a boolean value indicating whether the signature is valid or not. This function may throw an error if the DID Document or signature data are invalid.