-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci: add manual trigger for docs update
Signed-off-by: Ahmed Moussa <ahmed.moussa@iohk.io>
- Loading branch information
Showing
4 changed files
with
228 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| # kics-scan ignore | ||
| name: "Release Documentation" | ||
|
|
||
| defaults: | ||
| run: | ||
| shell: bash | ||
|
|
||
| env: | ||
| JAVA_VERSION: 11 | ||
| NODEJS_VERSION: 16.17.0 | ||
| ATALA_GITHUB_ACTOR: ${{ secrets.ATALA_GITHUB_ACTOR }} | ||
| ATALA_GITHUB_TOKEN: ${{ secrets.ATALA_GITHUB_TOKEN }} | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| push: | ||
| tags: | ||
| - "*" | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: "Checkout the repo" | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: "Validate Gradle Wrapper" | ||
| uses: gradle/wrapper-validation-action@v1 | ||
|
|
||
| - name: "Cache gradle" | ||
| uses: actions/cache@v3 | ||
| with: | ||
| path: | | ||
| ~/.gradle/caches | ||
| ~/.gradle/wrapper | ||
| ~/.konan | ||
| key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-gradle- | ||
| - name: "Install Java ${{ env.JAVA_VERSION }}" | ||
| uses: actions/setup-java@v3 | ||
| with: | ||
| java-version: ${{ env.JAVA_VERSION }} | ||
| distribution: "zulu" | ||
|
|
||
| - name: "Dokka Documentation Generation" | ||
| run: | | ||
| ./gradlew dokkaHtml | ||
| - name: "Push" | ||
| uses: s0/git-publish-subdir-action@develop | ||
| env: | ||
| REPO: self | ||
| BRANCH: gh-pages # The branch name where you want to push the assets | ||
| FOLDER: "didpeer/build/dokka/html/" # The directory where your assets are generated | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # GitHub will automatically add this - you don't need to bother getting a token | ||
| MESSAGE: "feat(docs): ({sha}) {msg}" # The commit message |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| # Module DIDCommDIDPeer | ||
|
|
||
| [](http://kotlinlang.org) | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
|  | ||
|
|
||
| Implementation of the [Peer DID method specification](https://identity.foundation/peer-did-method-spec/) in Kotlin MultiPlatform with support for the following targets: | ||
|
|
||
| - JS | ||
| - iOS | ||
| - Android | ||
| - JVM | ||
|
|
||
| This implementation is a re-implementation of this repo but for Kotlin Multiplatform | ||
|
|
||
| - [peer-did-jvm](https://github.com/sicpa-dlab/peer-did-jvm) | ||
|
|
||
| ## Example | ||
|
|
||
| Example code: | ||
|
|
||
| ```kotlin | ||
| val encryptionKeys = listOf( | ||
| VerificationMaterialAgreement( | ||
| type = VerificationMethodTypeAgreement.X25519_KEY_AGREEMENT_KEY_2019, | ||
| format = VerificationMaterialFormatPeerDID.BASE58, | ||
| value = "DmgBSHMqaZiYqwNMEJJuxWzsGGC8jUYADrfSdBrC6L8s", | ||
| ) | ||
| ) | ||
| val signingKeys = listOf( | ||
| VerificationMaterialAuthentication( | ||
| type = VerificationMethodTypeAuthentication.ED25519_VERIFICATION_KEY_2018, | ||
| format = VerificationMaterialFormatPeerDID.BASE58, | ||
| value = "ByHnpUCFb1vAfh9CFZ8ZkmUZguURW8nSw889hy6rD8L7", | ||
| ) | ||
| ) | ||
| val service = | ||
| """ | ||
| { | ||
| "type": "DIDCommMessaging", | ||
| "serviceEndpoint": "https://example.com/endpoint1", | ||
| "routingKeys": ["did:example:somemediator#somekey1"], | ||
| "accept": ["didcomm/v2", "didcomm/aip2;env=rfc587"] | ||
| } | ||
| """ | ||
|
|
||
| val peerDIDAlgo0 = createPeerDIDNumalgo0(signingKeys[0]) | ||
| val peerDIDAlgo2 = createPeerDIDNumalgo2( | ||
| encryptionKeys, signingKeys, service | ||
| ) | ||
|
|
||
| val didDocAlgo0Json = resolvePeerDID(peerDIDAlgo0) | ||
| val didDocAlgo2Json = resolvePeerDID(peerDIDAlgo2) | ||
|
|
||
| val didDocAlgo0 = DIDDocPeerDID.fromJson(didDocAlgo0Json) | ||
| val didDocAlgo2 = DIDDocPeerDID.fromJson(didDocAlgo2Json) | ||
| ``` | ||
|
|
||
| Example of DID documents: | ||
|
|
||
| ### DIDDoc algo 0: | ||
| ```json | ||
| { | ||
| "id": "did:peer:0z6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V", | ||
| "authentication": [ | ||
| { | ||
| "id": "did:peer:0z6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V#6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V", | ||
| "type": "Ed25519VerificationKey2020", | ||
| "controller": "did:peer:0z6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V", | ||
| "publicKeyMultibase": "ByHnpUCFb1vAfh9CFZ8ZkmUZguURW8nSw889hy6rD8L7" | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
| ### did_doc_algo_2 | ||
| ```json | ||
| { | ||
| "id": "did:peer:2.Ez6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.Vz6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludCIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkiXSwiYSI6WyJkaWRjb21tL3YyIiwiZGlkY29tbS9haXAyO2Vudj1yZmM1ODciXX0", | ||
| "authentication": [ | ||
| { | ||
| "id": "did:peer:2.Ez6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.Vz6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludCIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkiXSwiYSI6WyJkaWRjb21tL3YyIiwiZGlkY29tbS9haXAyO2Vudj1yZmM1ODciXX0#6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V", | ||
| "type": "Ed25519VerificationKey2020", | ||
| "controller": "did:peer:2.Ez6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.Vz6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludCIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkiXSwiYSI6WyJkaWRjb21tL3YyIiwiZGlkY29tbS9haXAyO2Vudj1yZmM1ODciXX0", | ||
| "publicKeyMultibase": "z6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V" | ||
| }, | ||
| { | ||
| "id": "did:peer:2.Ez6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.Vz6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludCIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkiXSwiYSI6WyJkaWRjb21tL3YyIiwiZGlkY29tbS9haXAyO2Vudj1yZmM1ODciXX0#6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg", | ||
| "type": "Ed25519VerificationKey2020", | ||
| "controller": "did:peer:2.Ez6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.Vz6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludCIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkiXSwiYSI6WyJkaWRjb21tL3YyIiwiZGlkY29tbS9haXAyO2Vudj1yZmM1ODciXX0", | ||
| "publicKeyMultibase": "z6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg" | ||
| } | ||
| ], | ||
| "keyAgreement": [ | ||
| { | ||
| "id": "did:peer:2.Ez6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.Vz6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludCIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkiXSwiYSI6WyJkaWRjb21tL3YyIiwiZGlkY29tbS9haXAyO2Vudj1yZmM1ODciXX0#6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc", | ||
| "type": "X25519KeyAgreementKey2020", | ||
| "controller": "did:peer:2.Ez6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.Vz6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludCIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkiXSwiYSI6WyJkaWRjb21tL3YyIiwiZGlkY29tbS9haXAyO2Vudj1yZmM1ODciXX0", | ||
| "publicKeyMultibase": "z6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc" | ||
| } | ||
| ], | ||
| "service": [ | ||
| { | ||
| "id": "did:peer:2.Ez6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.Vz6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludCIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkiXSwiYSI6WyJkaWRjb21tL3YyIiwiZGlkY29tbS9haXAyO2Vudj1yZmM1ODciXX0#didcommmessaging-0", | ||
| "type": "DIDCommMessaging", | ||
| "serviceEndpoint": "https://example.com/endpoint", | ||
| "routingKeys": [ | ||
| "did:example:somemediator#somekey" | ||
| ], | ||
| "accept": [ | ||
| "didcomm/v2", "didcomm/aip2;env=rfc587" | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| ## Assumptions and limitations | ||
| - Only static layers [1, 2a, 2b](https://identity.foundation/peer-did-method-spec/#layers-of-support) are supported | ||
| - Only `X25519` keys are support for key agreement | ||
| - Only `Ed25519` keys are support for authentication | ||
| - Supported verification materials (input and in the resolved DID DOC): | ||
| - [Default] 2020 verification materials (`Ed25519VerificationKey2020` and `X25519KeyAgreementKey2020`) with multibase base58 (`publicKeyMultibase`) public key encoding. | ||
| - JWK (`JsonWebKey2020`) using JWK (`publicKeyJwk`) public key encoding | ||
| - 2018/2019 verification materials (`Ed25519VerificationKey2018` and `X25519KeyAgreementKey2019`) using base58 (`publicKeyBase58`) public key encoding. |