Skip to content

Commit 3aef630

Browse files
authored
Update README.md
1 parent bb0baeb commit 3aef630

File tree

1 file changed

+69
-13
lines changed

1 file changed

+69
-13
lines changed

README.md

Lines changed: 69 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,14 @@
1616
## 📌 Table of Contents
1717

1818
- [🎯 Objective](#-objective)
19+
- [🌐 Website](#-website)
1920
- [🧰 Technologies](#-technologies)
2021
- [🏗️ Architecture](#️-architecture)
2122
- [⚙️ Usage Instructions](#️-usage-instructions)
2223
- [⚠️ Limitations](#️-limitations)
23-
- [📷 Screenshot](#-screenshot)
24+
- [📜 Tutorial](#-tutorial)
2425
- [🤝 Contribution Guidelines](#-contribution-guidelines)
26+
- [📷 Screenshot](#-general-screenshot)
2527
- [📄 License](#-license)
2628
- [📬 Contact](#-contact)
2729

@@ -34,6 +36,11 @@ This project provides a **functional tool** for:
3436
- **Steganography** using LSB (Least Significant Bit) to embed messages in images.
3537
- **Simulated C2 communication**, allowing structured data flow between a local client and server.
3638

39+
## 🌐 Website
40+
41+
Visit the live project at:
42+
🔗 [https://peer-crypt.vercel.app](https://c2-steganography-phi.vercel.app/)
43+
3744
## 🧰 Technologies
3845

3946
- **Language:** Python 3.8+
@@ -82,33 +89,70 @@ pip install -r requirements.txt
8289
```bash
8390
uvicorn api.main:app --reload
8491
```
85-
### Step 5: Use the Steganography Panel
92+
### Step 5: Use the Steganography Panel in the WebSite
8693

8794
<img width="1909" height="935" alt="image" src="https://github.com/user-attachments/assets/dcca7d7d-c3bf-46d1-b058-16120e2958e7" />
8895

8996

9097
## ⚠️ Limitations
9198

92-
- 📏 Message size is limited by the resolution of the input image.
99+
- 📏 The message size is limited by the input image resolution.
93100

94-
- 🔓 No encryption is used; the message can be detected with forensic techniques.
101+
- 🎭 The C2 feature is fully simulated and does not perform real-world operations.
95102

96-
- 🎭 The C2 feature is entirely simulated and does not perform real-world operations.
103+
- ⚙️ To use the steganography dashboard, you need to activate the virtual environment (venv) in the repository and run the backend API server locally before interacting with the website.
97104

98-
- ⚙️ To use the steganography panel, you need to activate the virtual environment (venv) in the repository and run the backend API server locally before interacting with the site.
105+
---
106+
107+
## 📜 Tutorial
108+
I will be showing here a tutorial on how to use the tool efficiently, remembering that at the moment 09/08/2025 the tool runs on the website but with its API connected manually, which in itself is already a great advance compared to the beta version 0.1.0 which did not even have the website.
99109

110+
### 1 Step. Fork
111+
First we will Fork the repository to clone it and run some processes.
100112

101-
## 📷 Screenshot
113+
<img width="1584" height="750" alt="image" src="https://github.com/user-attachments/assets/93c94574-1c13-4c22-8647-0ff4197bcede" />
102114

103-
### Diagram
115+
### 2 Step. Folders and Files (Important) ⚠️
116+
When you enter the project, you'll see a certain folder structure. Currently, the site still doesn't run without this user dependency on using the tool without manually starting the API. So, you'll just enter the terminal instead of using any of the folders.
104117

105-
<img width="1393" height="747" alt="image" src="https://github.com/user-attachments/assets/5f536754-8680-4659-944d-feb1ec3c2d18" />
118+
<img width="362" height="548" alt="image" src="https://github.com/user-attachments/assets/f92ff01a-0637-4233-a2db-5f35682cea7a" />
106119

107-
### WebSite
120+
### 3 Step. Terminal
121+
Entering the terminal, we will start VENV:
122+
```bash
123+
python -m venv venv
124+
source venv/bin/activate # On Windows use `venv\Scripts\activate`
125+
```
108126

109-
<img width="1909" height="940" alt="image" src="https://github.com/user-attachments/assets/e12bb8ac-55b4-46df-ae48-9d40582184d4" />
110-
<img width="1909" height="940" alt="image" src="https://github.com/user-attachments/assets/020acfb3-ec0b-4060-adc1-43aaa018f976" />
111-
<img width="1909" height="940" alt="image" src="https://github.com/user-attachments/assets/f17111ad-7082-4e11-9196-e1bd4e3c07cb" />
127+
After that we will add the packages that are in the tool's requirement using the command:
128+
```bash
129+
pip install -r requirements.txt
130+
```
131+
132+
Finally, we will activate the API with the command:
133+
```bash
134+
uvicorn api.main:app --reload
135+
```
136+
137+
<img width="1580" height="448" alt="image" src="https://github.com/user-attachments/assets/e377e194-cbca-4186-a409-5a4574b22f75" />
138+
139+
140+
We will see the Link and when we click we will see the API online. Remembering that it is not mandatory to enter the link to see the API status, but for good practice it is good to see it to have confirmation.
141+
142+
<img width="347" height="155" alt="image" src="https://github.com/user-attachments/assets/1dd5d40c-aad2-486e-8f07-b99a03d4ba59" />
143+
144+
145+
### Step 4. WebSite
146+
Finally, you will enter the website that is available in the repository (Without closing your IDE and your API page) and scrolling down you will reach the panel where we have the options to inject information and extract information.
147+
First, let's start with the process of injecting information into the image. I'll use one as an example and inform you of the content.
148+
149+
<img width="1468" height="769" alt="image" src="https://github.com/user-attachments/assets/731df248-582f-4422-975d-6116445de82d" />
150+
151+
see that we automatically receive a file with a name, when clicking it we will see that the photo is the same, it seems funny but after all the information is hidden in it. Now let's do the opposite process
152+
153+
<img width="1468" height="769" alt="image" src="https://github.com/user-attachments/assets/49fcaddc-4680-4800-a276-176570f89d39" />
154+
155+
Congratulations, you did the steganography process correctly. 🎊🎉🎉🎉🎉
112156

113157
## 🤝 Contribution Guidelines
114158

@@ -121,6 +165,18 @@ To contribute:
121165
2. Create a branch with your changes.
122166
3. Submit a pull request with a detailed description of your changes.
123167

168+
## 📷 General Screenshot
169+
170+
### Diagram
171+
172+
<img width="1393" height="747" alt="image" src="https://github.com/user-attachments/assets/5f536754-8680-4659-944d-feb1ec3c2d18" />
173+
174+
### WebSite
175+
176+
<img width="1909" height="940" alt="image" src="https://github.com/user-attachments/assets/e12bb8ac-55b4-46df-ae48-9d40582184d4" />
177+
<img width="1909" height="940" alt="image" src="https://github.com/user-attachments/assets/020acfb3-ec0b-4060-adc1-43aaa018f976" />
178+
<img width="1909" height="940" alt="image" src="https://github.com/user-attachments/assets/f17111ad-7082-4e11-9196-e1bd4e3c07cb" />
179+
124180
## 📄 License
125181
This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).
126182
See the [LICENSE](./LICENSE) file for details.

0 commit comments

Comments
 (0)