{"id":19530995,"url":"https://github.com/giri-aayush/zkp-authentication","last_synced_at":"2025-04-26T13:31:14.550Z","repository":{"id":233253429,"uuid":"707406656","full_name":"Giri-Aayush/zkp-authentication","owner":"Giri-Aayush","description":"Implementing robust authentication via a gRPC interface utilizing Zero-Knowledge Proof (ZKP) protocols in Rust.","archived":false,"fork":false,"pushed_at":"2024-04-14T08:52:51.000Z","size":17,"stargazers_count":9,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-15T07:26:01.616Z","etag":null,"topics":["grpc","rust","zkp"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Giri-Aayush.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-10-19T20:42:59.000Z","updated_at":"2024-04-15T07:26:06.965Z","dependencies_parsed_at":"2024-04-15T07:26:05.831Z","dependency_job_id":"614958f7-7bca-4eca-8851-631127cf9150","html_url":"https://github.com/Giri-Aayush/zkp-authentication","commit_stats":null,"previous_names":["giri-aayush/zkp-authentication"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Giri-Aayush%2Fzkp-authentication","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Giri-Aayush%2Fzkp-authentication/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Giri-Aayush%2Fzkp-authentication/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Giri-Aayush%2Fzkp-authentication/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Giri-Aayush","download_url":"https://codeload.github.com/Giri-Aayush/zkp-authentication/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224036438,"owners_count":17245033,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["grpc","rust","zkp"],"created_at":"2024-11-11T01:38:08.746Z","updated_at":"2024-11-11T01:38:10.091Z","avatar_url":"https://github.com/Giri-Aayush.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ZKP gRPC Client/Server for Authentication\n\nThis 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.\n\n## Table of Contents\n- [Prerequisites](#prerequisites)\n- [Local Setup](#local-setup)\n  - [Installation](#installation)\n  - [Running the Server and Client](#running-the-server-and-client)\n- [Docker Deployment](#docker-deployment)\n  - [Building the Docker Image](#building-the-docker-image)\n  - [Running the Docker Container](#running-the-docker-container)\n  - [Accessing the Running Container](#accessing-the-running-container)\n  - [Executing the Server and Client Inside the Container](#executing-the-server-and-client-inside-the-container)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Prerequisites\n- Rust programming language\n- `protobuf-compiler`\n- Docker (for containerized deployment)\n\n## Local Setup\n\n### Installation\n\n1. Ensure you have Rust installed on your system. If not, you can download and install Rust from the official website: https://www.rust-lang.org/tools/install\n\n2. Install the required `protobuf-compiler`. On Linux systems, you can use the following command:\n      ```bash\n      sudo apt install protobuf-compiler\n      ```\n\n### Running the Server and Client\n\n1. Clone the project repository:\n    ```bash\n    git clone https://github.com/your-username/zkp-grpc-authentication.git\n    ```\n\n2. Navigate to the project directory:\n      ```bash\n      cd zkp-grpc-authentication\n      ```\n\n## Docker Deployment\n\nThe application can be containerized using Docker, which ensures a consistent environment for deployment.\n\n### Building the Docker Image\n\nTo build the Docker containers, use:\n\n```bash\ndocker-compose build zkpserver\n```\n\n### Running the Docker Container\n\nLaunch the container with:\n\n```bash\ndocker-compose run --rm zkpserver\n```\n\n### Accessing the Running Container\n\nTo access the running container:\n\n1. List the active containers:\n\n```bash\ndocker container ls\n```\n\n2. Connect to the desired container using its CONTAINER ID:\n\n```bash\ndocker exec -it [CONTAINER ID] /bin/bash\n```\n\n### Executing the Server and Client Inside the Container\n\n1. Start the server:\n\n    ```bash\n    cargo run --bin server --release\n    ```\n\n2. In a separate terminal instance, run the client:\n\n    ```bash\n    cargo run --bin client --release\n    ```\n\n3. Build the project:\n\n      ```bash\n      cargo build --release\n      ```\n4. Start the server:\n\n    ```bash\n    cargo run --bin server --release\n    ```\n5. In a separate terminal instance, run the client:\n\n    ```bash\n    cargo run --bin client --release\n    ```\n6. Follow the prompts to enter the username and password (in hexadecimal format).\n\n7. Use the provided password to log in and obtain the session ID.\n\n## Docker Deployment\n1. Building the Docker Image\nTo build the Docker image, use the following command:\n\n    ```bash\n    docker-compose build zkpserver\n    ```\n2. Running the Docker Container\nLaunch the Docker container with the following command:\n\n    ```bash\n    docker-compose run --rm zkpserver\n    ```\n3. Accessing the Running Container\nList the active containers:\n\n    ```bash\n    docker container ls\n    ```\n4. Connect to the desired container using its CONTAINER ID:\n\n    ```bash\n    docker exec -it [CONTAINER ID] /bin/bash\n    ```\n5. Executing the Server and Client Inside the Container\nStart the server:\n    ```bash\n    cargo run --bin server --release\n    ```\n6. In a separate terminal instance, run the client:\n    ```bash\n    cargo run --bin client --release\n    ```\n7. Follow the prompts to enter the username and password (in hexadecimal format).\n\n8. Use the provided password to log in and obtain the session ID.\n\n## Contributing\nWe welcome contributions to enhance the functionality and usability of this project. If you'd like to contribute, please follow these steps:\n\nFork the repository.\n1. Create a new branch for your feature or bug fix.\n2. Make your changes and commit them with descriptive commit messages.\n3. Push your changes to your forked repository.\n4. Submit a pull request to the main repository, clearly describing your changes and their benefits.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgiri-aayush%2Fzkp-authentication","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgiri-aayush%2Fzkp-authentication","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgiri-aayush%2Fzkp-authentication/lists"}