Skip to content

Latest commit

 

History

History
50 lines (28 loc) · 2.91 KB

README.md

File metadata and controls

50 lines (28 loc) · 2.91 KB
Raw

Affinidi Messaging

Overview

A secure, private and trusted messaging framework based on DIDComm Messaging protocol.

DIDComm Messaging protocol is built on top of the decentralised design of a Decentralised Identifier (DID) for secure and privacy-preserving digital communication. By following the DID design, it utilities public key cryptography to ensure the secure and private transport of messages to the intended recipient, establishing trust.

This messaging framework is built using Rust language.

IMPORTANT: Affinidi Messaging is provided "as is" without any warranties or guarantees, and by using this framework, users agree to assume all risks associated with its deployment and use including implementing security, and privacy measures in their applications. Affinidi assumes no liability for any issues arising from the use or modification of the project.

Crate Structure

affinidi-messaging is the overall crate. It currently has the following sub-crates embedded in it:

  • affinidi-messaging-sdk - a Software Development Kit (SDK) to simplify the implementation of Affinidi Messaging into your application.
  • affinidi-messaging-mediator - Affinidi Messaging Mediator Service is used for message handling and relaying.
  • affinidi-messaging-processor - Affinidi Messaging Processor and Management Service.
  • affinidi-messaging-didcomm - Affinidi Messaging DIDComm implementation, a modified version of didcomm-rust project.

It also depends on external Affinidi crates:

both sourced here.

Prerequisites

Refer to affinidi-messaging-mediator - Prerequisites.

Running affinidi-messaging-mediator service

Refer to affinidi-messaging-mediator - Running affinidi-messaging-mediator service.

Examples

Go to the affinidi-messaging-sdk example crate to run the available sample codes and learn more about Affinidi Messaging.

Support & Feedback

If you face any issues or have suggestions, please don't hesitate to contact us using this link.

Reporting Technical Issues

If you have a technical issue with the Affinidi Messaging GitHub repo, you can also create an issue directly in GitHub.

If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.