walt.id did-lib - Kotlin multiplatform library
by walt.id - + [![CI/CD Workflow for walt.id did]()]()
@@ -17,14 +17,16 @@
_**walt.id did**_ library provides functionality for registering and resolving DIDs.
There are 2 options offered for each function:
+
- universal - relies on the universal DID registrar / resolver, e.g.:
- - uni-registrar - https://uniregistrar.io
- - uni-resolver - https://dev.uniresolver.io
+ - uni-registrar - https://uniregistrar.io
+ - uni-resolver - https://dev.uniresolver.io
- local - provides local implementations of DID methods
For the cryptographic part, _**walt.id did**_ library relies on _**walt.id crypto**_ library.
## Class diagram
+
The top-level interface to access the registrar / resolver functions is provided
@@ -33,7 +35,9 @@ by the `DidService` singleton.
## Usage examples
### Register DID
+
Create the key and register the Did:
+
```kotlin
val options = DidWebCreateOptions(
domain = "localhost:3000",
@@ -44,6 +48,7 @@ val didResult = DidService.register(options = options)
```
Register the Did with the given key:
+
```kotlin
val key = LocalKey.generate(KeyType.Ed25519)
val options = DidKeyCreateOptions(
@@ -57,14 +62,16 @@ val didResult = DidService.register(
```
Both calls return a `DidResult` object:
+
```kotlin
data class DidResult(
val did: String,
val didDocument: DidDocument
)
```
+
where `did` - is the Did url string, while `didDocument` is the corresponding
-DidDocument represented as a key-value pair, having the key as a `String` and
+DidDocument represented as a key-value pair, having the key as a `String` and
value as a `JsonElement`.
Currently available local did methods are:
@@ -96,5 +103,5 @@ Both calls return the result using the _operation result pattern_,
the data being wrapped by the `Result` object. This allows checking for
a successful operation and handling the result accordingly.
-The Did Document data is represented as `JsonObject`. The key data is
-represented as **_walt.id crypto_** `Key`.
\ No newline at end of file
+The Did Document data is represented as `JsonObject`. The key data is
+represented as **_walt.id crypto_** `Key`.
diff --git a/waltid-did/src/commonMain/kotlin/id/walt/did/dids/DidService.kt b/waltid-did/src/commonMain/kotlin/id/walt/did/dids/DidService.kt
index 1b0f65096..3ab2836b2 100644
--- a/waltid-did/src/commonMain/kotlin/id/walt/did/dids/DidService.kt
+++ b/waltid-did/src/commonMain/kotlin/id/walt/did/dids/DidService.kt
@@ -76,7 +76,11 @@ object DidService {
registerRegistrarForMethod(method, registrar)
}
- else -> log.warn { "DID Registrar ${registrar.name} cannot be used, error: ${methods.exceptionOrNull().let { it?.message ?: it.toString() }}" }
+ else -> log.warn {
+ "DID Registrar ${registrar.name} cannot be used, error: ${
+ methods.exceptionOrNull().let { it?.message ?: it.toString() }
+ }"
+ }
}
}
}
diff --git a/waltid-did/src/commonMain/kotlin/id/walt/did/dids/registrar/LocalRegistrar.kt b/waltid-did/src/commonMain/kotlin/id/walt/did/dids/registrar/LocalRegistrar.kt
index 9ad80c8f2..fcfa1b6cf 100644
--- a/waltid-did/src/commonMain/kotlin/id/walt/did/dids/registrar/LocalRegistrar.kt
+++ b/waltid-did/src/commonMain/kotlin/id/walt/did/dids/registrar/LocalRegistrar.kt
@@ -25,6 +25,7 @@ class LocalRegistrar : DidRegistrar {
override suspend fun create(options: DidCreateOptions): DidResult =
getRegistrarForMethod(options.method).register(options)
+
override suspend fun createByKey(key: Key, options: DidCreateOptions): DidResult =
getRegistrarForMethod(options.method).registerByKey(key, options)
diff --git a/waltid-did/src/commonMain/kotlin/id/walt/did/dids/registrar/dids/DidCreateOptions.kt b/waltid-did/src/commonMain/kotlin/id/walt/did/dids/registrar/dids/DidCreateOptions.kt
index 2ea1f951e..1e3882118 100644
--- a/waltid-did/src/commonMain/kotlin/id/walt/did/dids/registrar/dids/DidCreateOptions.kt
+++ b/waltid-did/src/commonMain/kotlin/id/walt/did/dids/registrar/dids/DidCreateOptions.kt
@@ -11,17 +11,18 @@ open class DidCreateOptions(val method: String, val options: JsonElement) {
constructor(method: String, options: Map
+
+
+## Getting Started
+
+* [Usage with Maven or Gradle (JVM)](#usage-with-maven-or-gradle-jvm)
+* [Usage with NPM/NodeJs (JavaScript)](#usage-with-npmnodejs-javascript)
+* [Sign SD-JWT tokens](#create-and-sign-an-sd-jwt-using-the-nimbusds-based-jwt-crypto-provider)
+* [Present SD-JWT tokens with selection of disclosed and undisclosed payload fields](#present-an-sd-jwt)
+* [Parse and verify SD-JWT tokens, resolving original payload with disclosed fields](#parse-and-verify-an-sd-jwt-using-the-nimbusds-based-jwt-crypto-provider)
+* [Integrate with your choice of framework or library, for cryptography and key management, on your platform](#integrate-with-custom-jwt-crypto-provider)
+
+### Further information
+
+Checkout the [documentation regarding SD-JWTs](https://docs.walt.id/v/ssikit/concepts/selective-disclosure), to find out more.
+
+## What is the SD-JWT library?
+
+This libary implements the **Selective Disclosure JWT (SD-JWT)**
+specification: [draft-ietf-oauth-selective-disclosure-jwt-04](https://datatracker.ietf.org/doc/draft-ietf-oauth-selective-disclosure-jwt/04/).
+
+### Features
+
+* **Create and sign** SD-JWT tokens
+ * Choose selectively disclosable payload fields (SD fields)
+ * Create digests for SD fields and insert into JWT body payload
+ * Create and append encoded disclosure strings for SD fields to JWT token
+ * Add random or fixed number of **decoy digests** on each nested object property
+* **Present** SD-JWT tokens
+ * Selection of fields to be disclosed
+ * Support for appending optional holder binding
+* Full support for **nested SD fields** and **recursive disclosures**
+* **Parse** SD-JWT tokens and restore original payload with disclosed fields
+* **Verify** SD-JWT token
+ * Signature verification
+ * Hash comparison and tamper check of the appended disclosures
+* Support for **integration** with various crypto libraries and frameworks, to perform the cryptographic operations and key management
+* **Multiplatform support**:
+ * Java/JVM
+ * JavaScript
+ * Native
+
+## Usage with Maven or Gradle (JVM)
+
+**Maven / Gradle repository**:
+
+`https://maven.walt.id/repository/waltid-ssi-kit/`
+
+**Maven**
+
+```xml
+[...]
+Kotlin Multiplatform SD-JWT library
+ by walt.id +Create JSON Web Tokens (JWTs) that support Selective Disclosure
+