Skip to content

Commit

Permalink
Explaining Checker and adding view of the project structure
Browse files Browse the repository at this point in the history
  • Loading branch information
SirGankalot committed Jul 31, 2024
1 parent 4e60fba commit f9eab8f
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 0 deletions.
62 changes: 62 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,65 @@ docker-compose up
```

The service listens to port: `*:9696`

# Project structure

This is the Project structure the main parts are the service, checker and the documentation.

```js
tree .
.
├── LICENSE
├── README.md
├── checker
│ ├── Dockerfile
│ ├── docker-compose.yaml
│ ├── requirements.txt
│ └── src
│ ├── checker.py
│ ├── checker_util_func.py
│ ├── gunicorn.conf.py
│ └── scam_messages.py
├── documentation
│ ├── README.md
│ ├── fix.py
│ ├── issues
│ │ └── issues.txt
│ └── key_gen.c
└── service
├── Dockerfile
├── docker-compose.yml
├── entrypoint.sh
├── gunicorn.conf.py
├── instance
│ └── database.db
├── main.py
├── requirements.txt
└── src
├── __init__.py
├── aes_encryption.py
├── auth.py
├── call_c.py
├── cleanup.py
├── key_gen
├── models.py
├── rsa_encryption.py
├── static
│ ├── Logo.PNG
│ ├── index.js
│ └── style.css
├── templates
│ ├── add_friend.html
│ ├── backup.html
│ ├── base.html
│ ├── flag.html
│ ├── group_page.html
│ ├── group_page_unauthorized.html
│ ├── groups.html
│ ├── home.html
│ ├── login.html
│ ├── profil.html
│ ├── sign_up.html
│ └── userlist.html
└── views.py
```
7 changes: 7 additions & 0 deletions documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -376,3 +376,10 @@ Easy fixes are blocked via the checker which checks for missing flags and missin
The Fixes are listed inside the documentation/fix.py . You will have to switch the lines of code to fix the service.
The Fixes listed are only part of all possible ways to fix the exploits.
# Checker
The Checker is a tool that checks the features of the service for its behavior.
For Whatsscam it sends http requests that try out a feature for example if you can text or add a certain person as a friend. It is used to prevent unintentional fixes or that someone turns off the service or any features. It is also used to simulate traffic for testing and to simulate regular traffic as usual for a real service. For details please look into the "checker/src/checker.py" for functions or the "checker/src/checker_util_func.py".
If you wanna start the checker you use "docker compose up --build" inside the checker folder.
Than you can use the enochecker to activate the checker via "enochecker_test -a YOUR_IP -p 19696 -A YOUR_IP" (checker listens to port 19696).

0 comments on commit f9eab8f

Please sign in to comment.