Skip to content

Latest commit

 

History

History
194 lines (128 loc) · 5.51 KB

README.md

File metadata and controls

194 lines (128 loc) · 5.51 KB
Raw

Revolutionizing Data Security: Embracing SSI, ZKPs, and Polygon ID in Modern Systems

In an era dominated by online interactions, our digital identities are at the forefront of our concerns. The constant fear of data breaches and unauthorized access to personal information has underscored the vulnerabilities inherent in traditional digital identity systems. The need for a secure and user-centric solution has never been more pressing.

Table of Contents

Project Description

Our project aims to address the vulnerabilities in traditional digital identity systems by leveraging Self-Sovereign Identity (SSI), Zero-Knowledge Proofs (ZKPs), and the Polygon ID platform. This initiative is driven by the urgent need for a more secure and user-centric approach to digital identity in the face of increasing cyber threats and data breaches.

Verifiable Credentials

The application issues four verifiable credentials using the Polygon ID issuer node:

  1. National ID Card:

    • Required by the employer to issue employee salary credentials & laboratory to issue lab reports.

  2. Employee Schema:

    • Required by the insurance company to issue insurance credentials.

  3. Lab Schema:

    • Required by the insurance company to issue insurance credentials.

  4. Insurance Schema:

    • Issued after verifying both employee and lab verifiable credentials.

Schema Links

Quick Start

Prerequisites

To successfully run this project, ensure you have the following:

  • Polygon ID: Download the Polygon ID Wallet App and create an Identity: Polygon ID on Google Play or on App Store
    • Change the Default network to Polygon Mumbai
    • Make sure you have enabled notifications for this app(if explicitly denied on your phone)
  • NGROK: For NGROK setup instructions, refer to ngrok.readme.md.
  • RPC_URL: To obtain the RPC_URL from Alchemy, follow the steps in alchemy.readme.md.
  • Docker or Node.js: To run the application locally on your system, you can either run using Docker or by starting the project locally using node.js

Setup

  • Run Ngrok to expose your local port

    ngrok http --domain=your-static-domain.ngrok-free.app 4007
    • Keep this terminal process running

  • Clone the repository:

    • Open a second Terminal
    git clone https://github.com/virajpatva/ethindia-ssi.git
cd ethindia-ssi/

Run using Docker

  1. Copy .env.example to .env:

    cp .env.example .env

  2. Update the .env file as below:

    RPC_URL_MUMBAI=<Your RPC Url>
NGROK_URL=<Ngrok URL of you static domain>
    • Example:
    RPC_URL_MUMBAI=https://polygon-mumbai.g.alchemy.com/v2/xxxxxx-xxxxxxxxxx-xxx
NGROK_URL=https://your-static-domain.ngrok-free.app

  3. Run the Application using Docker

    docker compose up --build

  4. Access the Application on port 8000:

  5. To Stop the Application

  • Press Ctrl+C on the Terminal to stop the containers, and run the below command to remove the containers.

    docker compose down

Run Locally

Backend

  1. Change Directory:

    cd backend

  2. Copy .env.example to .env:

    cp .env.example .env

  3. Set the required environment variables in .env:

    RPC_URL_MUMBAI=<Your RPC Url>
NGROK_URL=<Ngrok URL of you static domain>
    • Example:
    RPC_URL_MUMBAI=https://polygon-mumbai.g.alchemy.com/v2/xxxxxx-xxxxxxxxxx-xxx
NGROK_URL=https://your-static-domain.ngrok-free.app

  4. Install packages:

    npm install

  5. Run the backend application:

    npm run start

Frontend

  1. Open new terminal in cloned repo:

    cd frontend/

  2. Copy .env.example to .env:

    cp .env.example .env

  3. Install dependencies:

    npm ci --legacy-peer-deps

  4. Start the project on localhost:5173:

    npm run dev

  5. Access the frontend on port 5173:

License

This project is licensed under the MIT License.