Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fabiopinheiro/scala-did
A Scala & Scala.js implementation of DID and DID Comm messaging spec
https://github.com/fabiopinheiro/scala-did
decentralized-identities did did-comm didcomm
Last synced: 2 months ago
JSON representation
A Scala & Scala.js implementation of DID and DID Comm messaging spec
- Host: GitHub
- URL: https://github.com/fabiopinheiro/scala-did
- Owner: FabioPinheiro
- License: other
- Created: 2022-07-03T21:49:36.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T21:39:19.000Z (8 months ago)
- Last Synced: 2024-05-22T22:32:59.707Z (8 months ago)
- Topics: decentralized-identities, did, did-comm, didcomm
- Language: Scala
- Homepage:
- Size: 9.78 MB
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SCALA DID
A Scala/ScalaJS library for DID and DIDcomm.
The one of the main goals of this library is to make DID Comm v2 **type safety** and easy to use.
Made for developers by developers.
[**LIVE DEMO (DIDComm's Sandbox)**](https://did.fmgp.app/)
[**Scala-DID Documentation**](./docs/readme.md)
[](https://github.com/FabioPinheiro/scala-did/actions/workflows/ci.yml)
[](https://github.com/FabioPinheiro/scala-did/actions/workflows/scala-steward.yml)
[](https://index.scala-lang.org/fabiopinheiro/scala-did/did)
[](https://index.scala-lang.org/fabiopinheiro/scala-did/did)
- **CI** automate builds and tests all pushes to the master branch also as all PRs created.
- **Scala Steward** automate the creation of pull requests for libraries with updated dependencies, saving maintainers time and effort. It can also help ensure that libraries are kept up-to-date, improving their reliability and performance.
The future version of [**DID Comm v2.1**](https://identity.foundation/didcomm-messaging/spec/v2.1/) is been track&develop in the branch [`didcomm-v2.1`](https://github.com/FabioPinheiro/scala-did/tree/didcomm-v2.1)
**More documentation:**
- [LICENSE](LICENSE) - Apache License, Version 2.0
- [did implementations](did-imp/README.md) = Notes and TODO list
- [example](did-example/README.md) - just a set of DIDs for experiments.
- [demo](demo/README.md) - How to build, test and deploy the Demo. The Demo is a server with (webapp) client.
- [webapp module](webapp/README.md) - How to build, develop and run localy.
- [multiformats module](multiformats/README.md) - Implemente notes and an considerations (of TODOs) if we want to use as the independent Library.
- [docs](docs/) - Base folder of the library documentation website.
- [docs/readme.md - **Scala-DID Documentation**](docs/readme.md)
## Adopters
Following is a partial list of companies and project using DID Comm to craft applications.
Want to see your project here? [Submit a PR]
- [DID Comm - Playground](https://did.fmgp.app/)
- [DID Comm Action - Send messages from Github jobs](https://github.com/fabiopinheiro/did-comm-action)
- [Atala PRISM](https://atalaprism.io/)
- [DID Comm Mediator](https://github.com/input-output-hk/atala-prism-mediator)
## Protocols
- [DONE] `Action Menu 2.0` - https://didcomm.org/action-menu/2.0
- [DONE] `BasicMessage 2.0` - https://didcomm.org/basicmessage/2.0
- [DONE] `DiscoverFeatures 2.0` - https://didcomm.org/discover-features/2.0
- [TODO] `MediaSharing 1.0` - https://didcomm.org/media-sharing/1.0
- [DONE] `MediatorCoordination 2.0` - https://didcomm.org/mediator-coordination/2.0
- [DONE] `MediatorCoordination 3.0` - https://didcomm.org/mediator-coordination/3.0
- Compare [specs](https://github.com/decentralized-identity/didcomm.org/tree/main) with previous version
- `diff site/content/protocols/mediator-coordination/3.0 site/content/protocols/mediator-coordination/2.0/`
- Compare code with previous version
- `diff did/shared/src/main/scala/fmgp/did/comm/protocol/mediatorcoordination3/MediatorCoordination.scala did/shared/src/main/scala/fmgp/did/comm/protocol/mediatorcoordination2/MediatorCoordination.scala`
- `diff did/shared/src/main/scala/fmgp/did/comm/protocol/mediatorcoordination3/Recipient.scala did/shared/src/main/scala/fmgp/did/comm/protocol/mediatorcoordination2/Keylist.scala`
- [DONE] `OutOfBand 2.0` - https://didcomm.org/out-of-band/2.0
- [DONE] `Pickup 3.0` - https://didcomm.org/pickup/3.0
- [TODO] `QuestionAnswer 1.0` - https://didcomm.org/question-answer/1.0
- [TODO] `Receipts 1.0` - https://didcomm.org/receipts/1.0
- [DONE] `ReportProblem 2.0` - https://didcomm.org/report-problem/2.0 - See [specs](https://identity.foundation/didcomm-messaging/spec/#problem-reports)
- [NOT_ATM] `Routing 2.0`- https://didcomm.org/routing/2.0
- Also see https://didcomm.org/book/v2/routing
- [DONE] `TrustPing 2.0` - https://didcomm.org/trust-ping/2.0/
- [TODO] `UserProfile 1.0` - https://didcomm.org/user-profile/1.0
- [NOT_ATM] `Data-agreement 1.0`:
- [NOT_TODO_(DIDCommV1?)] `data-agreement-context-decorator` - https://didcomm.org/data-agreement-context-decorator/1.0/
- [NOT_ATM] `data-agreement-negotiation` - https://didcomm.org/data-agreement-negotiation/1.0/
- [NOT_TODO_(+-DIDCommV1?)]`data-agreement-proofs` - https://didcomm.org/data-agreement-proofs/1.0/
- [NOT_ATM] `data-agreement-termination` - https://didcomm.org/data-agreement-termination/1.0/
- [NOT_ATM] `data-disclosure-agreement` - https://didcomm.org/data-disclosure-agreement/1.0/
- Create new protocol `DidResolver`
- Create new protocol `PreSetValue`
- Create new protocol `PseudoRandom`
- https://www.stat.berkeley.edu/~stark/Java/Html/sha256Rand.htm
- https://www.rfc-editor.org/rfc/rfc3797
## TODO/WIP
- UNDO commit that mitigate limitations on other libraries
- We are still working on core API.
- decrypting a file MUST be one of the following combinations: [See this like](https://identity.foundation/didcomm-messaging/spec/#iana-media-types)
- [TODO!] [Message Layer Addressing Consistency](https://identity.foundation/didcomm-messaging/spec/#message-layer-addressing-consistency)
- did-rotation: https://identity.foundation/didcomm-messaging/spec/#did-rotation
- support `from_prior`
- support `sub` `iss` on JWT https://datatracker.ietf.org/doc/html/rfc7519
- maybe implement method `did:peer.3` and `did:peer.4`
- [TODO] method `did:key`
- maybe implement method `did:jwk` https://github.com/quartzjer/did-jwk
- maybe implement methods ["KERI lite"](https://docs.google.com/presentation/d/1ksqVxeCAvqLjr67htWZ4JYaSnI8TUZIO7tDMF5npHTo/edit#slide=id.g1ca1fd90f33_0_0)
- be part of the Adopters in https://github.com/sbt/sbt-ci-release/
- Remove field `kty` from `ECPublicKey` and `OKPPublicKey`. Make custom json encoder/decoder
- FIXME The encoder for ProtectedHeader MUST not have the field "className"
## Benefits of type safety
- It would help prevent errors by ensuring that only valid DIDs are used, and that the library does not attempt to perform any invalid operations on them. This could help ensure that the library functions correctly and reliably.
- It would make the code easier to read and understand, by making it clear what types of values are being used and what operations are being performed on them. This could make it easier for developers to work with the library and understand its functionality. **Speeding up the development of applications**
- It could make the library more efficient, by allowing the compiler to optimize the code for working with DIDs. This could make the library run faster and more efficiently.
- It could improve the reliability and correctness of the library, by catching any errors or bugs related to invalid DIDs or invalid operations at compile time. This could save time and effort in the development process and help prevent potential issues in the final library.
I usually say if it compiles it probably also works!
## Project Structure and Dependencies Graph
```mermaid
flowchart BT
zhttp --> zio
did --> zio
zio-json --> zio
did --> zio-json
did-resolver-web ----> zhttp:::JVM
subgraph fmgp libraries
did-resolver-peer --> multibase
subgraph platform specific
did-imp
did-imp-hw:::Others -.-> did-imp
did-imp_js:::JS ==>|compiles together| did-imp
did-imp_jvm:::JVM ==>|compiles together| did-imp
end
did-resolver-peer --> did
did-resolver-web --> did
did-comm-protocols --> did
did-framework --> did
did-framework --> did-comm-protocols
did-imp --> did
end
did-example ----> did
did-example --> did-imp
demo --> did-imp
did-imp_jvm:::JVM ----> nimbus-jose-jwt:::JVM --> google-tink:::JVM
did-imp_jvm:::JVM ---> google-tink
did-imp_js ----> jose:::JS
%% subgraph demo/docs
webapp:::JS --> did-framework
demo --> did-framework
demo --> did-resolver-web
demo --> did-resolver-peer
webapp:::JS --> did-imp_js
webapp:::JS --> did-resolver-web
webapp:::JS --> did-resolver-peer
webapp:::JS --> did-example
demo --> did-example
demo -.->|uses\serves| webapp
demo_jvm(demo_jvm\nA server):::JVM ==>|compiles together| demo
did-example --> did-resolver-peer
did-example --> did-resolver-web
%% end
classDef JVM fill:#141,stroke:#444,stroke-width:2px;
classDef JS fill:#05a,stroke:#444,stroke-width:2px;
classDef Others fill:#222,stroke:#444,stroke-width:2px,stroke-dasharray: 5 5;
```
NOTES:
- The things inside the group box (fmgp) are implemented on this repository and that are intended to be published as a library.
- Green boxes is JVM's platform specific.
- Blue boxes is JavaScript's platform specific.
- Other boxes are not platform specific.
- The `did-imp-hw` is a idea how to extend for other implementation. Like a hardware/platform specific or with hardware wallet support.
- `did-resolver-web` & `did-resolver-peer` are implementations of the respective did methods.