Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #21

Merged
merged 8 commits into from
Sep 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -160,4 +160,7 @@ cython_debug/
.idea/

# txt files
sha256_names.txt
sha256_names.txt

# Vscode cache
.vscode/
50 changes: 33 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Your Daily Dose of Malware
Tool to Harvest Fresh Malware Samples for Security Research.
<div align="center">
<p>
<a href="#"><img src="readme_media\daily_dose_malware.webp" width="800" height="340" alt="aba-run help image" /></a>
</p>

</div>

[![Super-Linter](https://github.com/Anti-Malware-Alliance/your-daily-dose-malware/actions/workflows/pre-commit-actions.yml/badge.svg)](https://github.com/marketplace/actions/super-linter)

Expand All @@ -25,39 +31,49 @@ For this a recurrently refreshed Dataset is needed. Most Research on this topic
cd your-daily-dose-malware/
```

3. **Create a virtual environment:**
```bash
python3 -m venv daily-dose
or
python -m venv daily-dose
```

4. **Activate the virtual environment:**
3. **Activate the virtual environment:**
```bash
poetry shell
```

5. **Install dependencies:**
4. **Install dependencies:**
```bash
poetry install
```

# OSINT Sources Supported

We gathering malwares samples from multiple osint sources and we currently support bellow source

- [Malshare](https://malshare.com/)
- [MalwareBazaar](https://bazaar.abuse.ch/)

we are working to add many mores support to provides mores samples

# Using CLI Interface
If you want to download fresh malware samples uploaded since 48 hours
- `dd-run:`(stand for `daily-dose run`) is the base command means all other commands that will be introduce bellow are sub-commands and should always be preceded by `dd-run`.

base on the osint source you want to get samples from, you have different subcommands.

## malshare
malshare subcommand will fetching around ten thousand and more samples you can set a treshold with `--limit` option. if this option is not provided all available samples will be download

```bash
cd your-daily-dose-malware/
python main.py -s256
dd-run malshare --limit 10
```
if you want to define where to download your samples use `--path` followed by the path wanted. by default your malwares will be downloaded in the current directory inside al folder named: `Downloaded-Malwares`


```bash
dd-run malshare --limit 10 --path "My-daily-dose"
```
this could be an amount of 300 samples or more.

But if you're not that hungry, maybe 100 samples will satisfy your hunger.
## malware bazaar
malware bazaar subcommand, will fetching either `one hundred samples` or the `most_recent` you can choose which one you want to use basesd on your hungry level, by providing `--hundred` or `-h` to get the latest one hundred samples or `--most-recent` or `-mr` to get the most recent samples.

```bash
cd your-daily-dose-malware/
python main.py -hr
dd-run m-bazaar --hundred
```
this will always download 100 samples. uploaded since 1 hour.

# Solution

Expand Down
43 changes: 41 additions & 2 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 7 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,18 @@ description = "Downloads and aggregates fresh malware samples collected from OSI
authors = ["Robert Thomas", "Prashant Shubham", "Mboula Penda Paul O’neal"]
readme = "README.md"


[tool.poetry.scripts]
dd-run = "your_daily_dose_malware.commands:app"



[tool.poetry.dependencies]
python = "^3.9"
requests = "^2.32.2"
click = "^8.1.7"
python-dotenv = "^1.0.1"
rich = "^13.7.1"
typer = "^0.12.5"

[build-system]
requires = ["poetry-core"]
Expand Down
Binary file added readme_media/daily_dose_malware.webp
Binary file not shown.
3 changes: 3 additions & 0 deletions your_daily_dose_malware/__main__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
from your_daily_dose_malware.commands import app

app(prog_name="dd-run")
Empty file.
Empty file.
1 change: 0 additions & 1 deletion your_daily_dose_malware/app/utils/constants.py

This file was deleted.

93 changes: 0 additions & 93 deletions your_daily_dose_malware/app/utils/http_utils.py

This file was deleted.

Loading