README.md

CoLink

CoLink provides a unified interface for the user, storage, communication, and computation. Extending gRPC, CoLink simplifies the development of multi-party protocols and allow implementations in different programming languages to work together consistently. With a unified interface that increases potential data contributors, CoLink has the potential to enable larger-scale decentralized data collaboration and unlock the true value of data.

Preparations

Generate mTLS certificates (optional)

The CoLink server and the clients uses mTLS to communicate. In the repo, we included a set of example certificates. Please DO NOT use the example certificates in a production environment.

To generate the corresponding certificates for mTLS, you can use OpenSSL or CFSSL.

• OpenSSL
  • Use this script to generate.
• CFSSL - Links for some useful tutorials:
  • TLS
  • mTLS
  • GitHub repo

Set up RabbitMQ (optional)

• Download and Installation
• Enable Management API
• Example Configuration

Start CoLink server

CoLink server requires a message queue (RabbitMQ or Redis Stream) as its building block. When starting the CoLink server, we can specify MQ's URI and management API here (the default MQ is a built-in Redis). Note: The built-in Redis does not enable TLS. Please DO NOT use it in production environments.

Use the following command to start the CoLink server

cargo run -- --address <address> --port <port> --mq-uri <mq uri> --mq-api <mq api> --mq-prefix <mq prefix> \
 --core-uri <core uri> --cert <server certificate> --key <server key> --ca <client ca certificate> \
 --inter-core-ca <inter-core-ca> --inter-core-cert <inter-core-cert> --inter-core-key <inter-core-key>

For the details about the parameters, please check here.

Example

Minimal

cargo run

Without TLS

cargo run -- --address 127.0.0.1 --port 2021 --mq-uri amqp://guest:guest@localhost:5672 --mq-api http://guest:guest@localhost:15672/api --core-uri http://127.0.0.1:2021

TLS

cargo run -- --address 127.0.0.1 --port 2021 --mq-uri <mq uri> --mq-api <mq api> --cert <path to server-fullchain.pem> --key <path to server-key.pem> --inter-core-ca <path to ca.pem>

mTLS

cargo run -- --address 127.0.0.1 --port 2021 --mq-uri <mq uri> --mq-api <mq api> --cert <path to server-fullchain.pem> --key <path to server-key.pem> --ca <path to ca.pem> --inter-core-ca <path to ca.pem> --inter-core-cert <path to client.pem> --inter-core-key <path to client-key.pem>

Test the server

Use cargo test to run various tests. See tests/ for more details.

These tests require an MQ. Please refer to CoLink Server Setup