DIDCommDIDPeer/io.iohk.atala.prism.didcomm.didpeer

Package-level declarations

Types

data class DIDCommServicePeerDID(val id: String, val type: String, val serviceEndpoint: ServiceEndpoint) : Service

Represents a DIDComm service peer DID.

data class DIDDocPeerDID @JvmOverloads constructor(val did: String, val authentication: List<VerificationMethodPeerDID>, val keyAgreement: List<VerificationMethodPeerDID> = emptyList(), val service: List<Service>? = null)

Represents a PeerDID DID Document.

JSON

typealias JSON = String

Type alias for JSON strings.

MalformedPeerDIDDOcException

class MalformedPeerDIDDOcException @JvmOverloads constructor(cause: Throwable? = null) : PeerDIDException

Raised if the resolved peer DID Doc to be resolved in not a valid peer DID.

MalformedPeerDIDException

class MalformedPeerDIDException @JvmOverloads constructor(message: String, cause: Throwable? = null) : PeerDIDException

Raised if the peer DID to be resolved in not a valid peer DID.

OtherService

data class OtherService(val data: Map<String, Any>) : Service

Represents a service provided by a DID document.

PeerDID

typealias PeerDID = String

Defines the type PeerDID, which is an alias for a String.

PeerDIDException

open class PeerDIDException @JvmOverloads constructor(message: String, cause: Throwable? = null) : Throwable

The base class for all PeerDID errors and exceptions.

PublicKeyField

enum PublicKeyField : Enum<PublicKeyField>

Represents the different types of public key fields.

Service

interface Service

Represents a service.

ServiceEndpoint

data class ServiceEndpoint(val uri: String, val routingKeys: List<String>, val accept: List<String>)

Represents a service endpoint.

VerificationMaterialAgreement

typealias VerificationMaterialAgreement = VerificationMaterialPeerDID<VerificationMethodTypeAgreement>

Alias for VerificationMaterialPeerDID with VerificationMethodTypeAgreement type parameter.

VerificationMaterialAuthentication

typealias VerificationMaterialAuthentication = VerificationMaterialPeerDID<VerificationMethodTypeAuthentication>

Alias for VerificationMaterialPeerDID with VerificationMethodTypeAuthentication type parameter.

VerificationMaterialFormatPeerDID

enum VerificationMaterialFormatPeerDID : Enum<VerificationMaterialFormatPeerDID>

An enumeration that represents the format of verification material in a PeerDID.

VerificationMaterialPeerDID

@Serializable

data class VerificationMaterialPeerDID<T : VerificationMethodTypePeerDID>(val format: VerificationMaterialFormatPeerDID, val value: Any, val type: T)

Represents the verification material used in a PeerDID.

VerificationMethodPeerDID

@Serializable

data class VerificationMethodPeerDID(val id: String, val controller: String, val verMaterial: VerificationMaterialPeerDID<out VerificationMethodTypePeerDID>)

Represents a verification method used in PeerDID.

VerificationMethodTypeAgreement

sealed class VerificationMethodTypeAgreement : VerificationMethodTypePeerDID

A sealed class representing the types of verification methods for agreements.

VerificationMethodTypeAuthentication

sealed class VerificationMethodTypeAuthentication : VerificationMethodTypePeerDID

Represents the different types of authentication methods for verification.

VerificationMethodTypePeerDID

@Serializable

sealed class VerificationMethodTypePeerDID

Represents the types of verification methods for PeerDID.

Properties

SERVICE_ACCEPT

const val SERVICE_ACCEPT: String

SERVICE_DIDCOMM_MESSAGING

const val SERVICE_DIDCOMM_MESSAGING: String

SERVICE_ENDPOINT

const val SERVICE_ENDPOINT: String

SERVICE_ID

const val SERVICE_ID: String

SERVICE_ROUTING_KEYS

const val SERVICE_ROUTING_KEYS: String

SERVICE_TYPE

const val SERVICE_TYPE: String

SERVICE_URI

const val SERVICE_URI: String

Functions

createPeerDIDNumalgo0

fun createPeerDIDNumalgo0(inceptionKey: VerificationMaterialAuthentication): PeerDID

Generates PeerDID according to the zero algorithm For this type of algorithm DIDDoc can be obtained from PeerDID

createPeerDIDNumalgo2

fun createPeerDIDNumalgo2(encryptionKeys: List<VerificationMaterialAgreement>, signingKeys: List<VerificationMaterialAuthentication>, service: JSON?): PeerDID

Generates PeerDID according to the second algorithm For this type of algorithm DIDDoc can be obtained from PeerDID

isPeerDID

fun isPeerDID(peerDID: String): Boolean

Checks if peerDID param matches PeerDID spec

resolvePeerDID

@JvmOverloads

fun resolvePeerDID(peerDID: PeerDID, format: VerificationMaterialFormatPeerDID = VerificationMaterialFormatPeerDID.MULTIBASE): String

Resolves DIDDocPeerDID from PeerDID