https://github.com/adorsys/didcomm-mediator-rs
Simple mediator for DIDComm Messaging v2
https://github.com/adorsys/didcomm-mediator-rs
Last synced: 6 months ago
JSON representation
Simple mediator for DIDComm Messaging v2
- Host: GitHub
- URL: https://github.com/adorsys/didcomm-mediator-rs
- Owner: adorsys
- License: apache-2.0
- Created: 2023-07-20T19:14:16.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-08T10:45:28.000Z (11 months ago)
- Last Synced: 2024-11-08T11:31:56.581Z (11 months ago)
- Language: Rust
- Size: 2.09 MB
- Stars: 3
- Watchers: 6
- Forks: 0
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/adorsys/didcomm-mediator-rs/actions/workflows/rust.yml)
[](https://github.com/adorsys/didcomm-messaging-clients-utilities)
[](https://identity.foundation/didcomm-messaging/spec/)
[](https://github.com/adorsys/didcomm-mediator-rs/blob/main/LICENSE)
# DIDComm-Mediator
A DIDComm mediator is a cloud agent that facilitates secure, decentralized communication between mobile agents in the self-sovereign identity (SSI) ecosystem. This mediator acts as a cloud-based intermediary, enabling mobile agents to communicate without reliance on centralized infrastructures like Facebook, Signal, or Telegram.
For further understanding checkout the [docs](docs/mediator-doc.md)
## Project Feature Implementation Tracker
|Message types | Spec Status | Implementation Status|
|---------------|-------------|----------------------|
|[Mediator Coordination Protocol](https://didcomm.org/coordinate-mediation/2.0/)| ADOPTED| ✅|
|[Pickup Protocol](https://didcomm.org/messagepickup/3.0/)| ADOPTED | ✅ |
|[DID Rotation](https://didcomm.org/book/v2/didrotation) | ACCEPTED | ✅ |
|[Cross-Domain Messaging/ Routing Protocol](https://identity.foundation/didcomm-messaging/spec/#routing-protocol-20) | ADOPTED | ✅|
|[Trust Ping Ptotocol](https://identity.foundation/didcomm-messaging/spec/#trust-ping-protocol-20) | ADOPTED|✅|
|[Discover Features Protocol](https://didcomm.org/discover-features/2.0/) | ADOPTED | ✅ |
|[Out of band Messaging](https://identity.foundation/didcomm-messaging/spec/#out-of-band-messages) | ADOPTED | ✅
|[Basic Message Protocol](https://didcomm.org/basicmessage/2.0/#:~:text=The%20BasicMessage%20protocol%20describes%20a,message%20type%20used%20to%20communicate.) | ADOPTED|⚪|
|[Acks](https://github.com/hyperledger/aries-rfcs/tree/main/features/0015-acks)| ADOPTED |❌ |
|[Present Proof Protocol](https://didcomm.org/present-proof/3.0/)| ADOPTED | ❌|
## Building and testing
To build and test the project, ensure that **libssl-dev** and **pkg-config** are installed on your system.
### Ubuntu Setup
Install the necessary packages with:
```sh
sudo apt update
sudo apt install -y libssl-dev pkg-config
```
### Prerequisites
Ensure you have [Rust & Cargo](https://www.rust-lang.org/tools/install) installed.
## Setup
1. Optionally, create a working directory and navigate into it.
2. Clone the repository:
```sh
git clone git@github.com:adorsys/didcomm-mediator-rs.git
```
## Running the Project
### Mongo DB
This project uses MongoDB as the database. You need to have [MongoDB](https://www.mongodb.com) installed and running on your system.
Another option is to use [Docker](https://www.docker.com):
```sh
docker pull mongo
docker run --name mongodb -d mongo
```
### Environmental variables
You need to create a **`.env`** file in the root directory of the project and add the following variables:
```sh
SERVER_PUBLIC_DOMAIN="http://localhost:8080"
STORAGE_DIRPATH="./storage"
MONGO_DBN="DIDComm_DB"
MONGO_URI="mongodb://localhost:27017"
```
> The values can be changed according to your needs.
You can now start the mediator server:
```sh
cargo run
```
### Running with Docker Compose
You can run the project with Docker Compose.
* First change the `MONGO_URI` variable in the `.env` file to `mongodb://mongodb:27017`
* Then run the following command:
```sh
docker-compose up
```
This will build the docker image of the mediator server with all its prerequisites and run it.
The output should look like this:
## License
This project is licensed under the Apache License. See the [LICENSE](https://github.com/adorsys/didcomm-mediator-rs/blob/main/LICENSE) file for details.