README.md

ZKP gRPC Client/Server for Authentication

This project implements a gRPC server and client leveraging the Zero-Knowledge Proof (ZKP) Rust library for secure authentication. The integration of ZKP with gRPC ensures that users can be authenticated without revealing sensitive information, enhancing privacy and security. gRPC, a high-performance, universal RPC framework, is employed to handle the communication between the client and server.

Table of Contents

• Prerequisites
• Local Setup
  • Installation
  • Running the Server and Client
• Docker Deployment
  • Building the Docker Image
  • Running the Docker Container
  • Accessing the Running Container
  • Executing the Server and Client Inside the Container
• Contributing
• License

Prerequisites

• Rust programming language
• protobuf-compiler

Local Setup

Installation

If you're on a Linux system, you can install the required protobuf-compiler using the following command:

sudo apt install protobuf-compiler

Running the Server and Client

TODO: Provide steps for running the server and client locally if any.

Docker Deployment

The application can be containerized using Docker, which ensures a consistent environment for deployment.

Building the Docker Image

To build the Docker containers, use:

docker-compose build zkpserver

Running the Docker Container

Launch the container with:

Copy code
docker-compose run --rm zkpserver

Accessing the Running Container

To access the running container:

1. List the active containers:

docker container ls

2. Connect to the desired container using its CONTAINER ID:

docker exec -it [CONTAINER ID] /bin/bash

Executing the Server and Client Inside the Container

1. Start the server:

cargo run --bin server --release

2. In a separate terminal instance, run the client:

cargo run --bin client --release

Contributing

TODO: Provide guidelines on how contributors can help with the project, if applicable.