Skip to content

Commit ea19cc1

Browse files
authored
Create README.md
1 parent 55b1a8c commit ea19cc1

File tree

1 file changed

+102
-0
lines changed

1 file changed

+102
-0
lines changed

README.md

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# VeriDoc
2+
3+
## Team Members:<br>
4+
5+
1.Satyam Rathor(22bec042)<br>
6+
7+
2.Aditya Roushan(22bec003)<br>
8+
9+
3.Pratush Rai(22bec035)<br>
10+
11+
4.Ansh Goyal(22bcs014)<br>
12+
13+
14+
## Introduction
15+
16+
**VeriDoc** is a secure, scalable document verification system designed to verify the integrity of files using advanced cryptographic algorithms. It employs digital signatures, SHA-256, and RSA algorithms to ensure data authenticity and integrity.
17+
18+
- **Backend**: Built with Python for cryptographic operations and API management.
19+
- **Frontend**: Developed using Next.js with Tailwind CSS and Redux Toolkit for state management.
20+
- **Storage and Authentication**: Utilizes Firebase for file storage and user authentication.
21+
- **Deployment**: Docker ensures seamless scalability and deployment.
22+
23+
---
24+
25+
## Tech Stack
26+
27+
- **Frontend**:
28+
- Next.js
29+
- Tailwind CSS
30+
- Redux Toolkit
31+
- Firebase Authentication
32+
33+
- **Backend**:
34+
- Python
35+
36+
- **Cryptography**:
37+
- SHA-256 (Hashing)
38+
- RSA (Key Generation & Digital Signatures)
39+
40+
- **Storage**:
41+
- Firebase
42+
43+
- **Containerization**:
44+
- Docker
45+
46+
---
47+
48+
## Features
49+
50+
### **Core Features**
51+
- **Secure File Upload**: Users can upload files securely to Firebase.
52+
- **Cryptographic Verification**: Ensures document integrity using SHA-256 hashing and RSA-based digital signatures.
53+
- **File Integrity Check**: Compares uploaded files to detect any alterations.
54+
- **File Reference and Comparison**: Allows users to upload a new file and compare it against previously stored versions.
55+
- **User Authentication**: Secure login and registration via Firebase Authentication.
56+
57+
### **Cryptographic Operations**
58+
- **Signing**: Creates a digital signature for the provided message.
59+
- **Hashing**: Generates a SHA-256 hash of the data.
60+
- **Verification**: Validates data integrity using the hash and digital signature.
61+
62+
### **Deployment**
63+
- **Dockerized Deployment**: Streamlined deployment and enhanced scalability using Docker.
64+
65+
---
66+
67+
## API Endpoints
68+
69+
- **POST `/api/extract-text-from-pdf`**
70+
Extracts text from a PDF file.
71+
72+
- **POST `/api/sign`**
73+
Signs a message. Takes an input message and returns:
74+
- Message
75+
- Message Hash
76+
- Public Key
77+
- Digital Signature
78+
79+
- **POST `/api/verify`**
80+
Verifies the integrity of a message by comparing its hash with the digital signature.
81+
- Returns: `true` if valid, otherwise `false`.
82+
83+
- **POST `/api/hash`**
84+
Hashes the provided data using SHA-256 and returns the hash value.
85+
86+
---
87+
88+
## Source Code
89+
90+
Access the source code on GitHub:
91+
[VeriDoc Repository](https://github.com/dotdot0/crypto)
92+
93+
## Live Demo
94+
95+
Try it live:
96+
[VeriDoc Live Application](https://crypto-zeta-dun.vercel.app/)
97+
98+
---
99+
100+
## License
101+
102+
This project is licensed under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)