Skip to content
Draft
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
1 change: 1 addition & 0 deletions muchie/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
__pycache__/
21 changes: 21 additions & 0 deletions muchie/ETHICS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Ethics Disclaimer for Muchie

## 1. Our Commitment to Ethical Use

Muchie is a tool designed for **educational and ethical purposes only**. It is intended to be used by security professionals, students, and enthusiasts to learn about common attack vectors in a safe and controlled environment.

## 2. Prohibited Uses

The following uses of Muchie are strictly prohibited:

* **Real-world attacks:** Using Muchie to generate payloads or simulate attacks against any system you do not have explicit permission to test.
* **Malicious activities:** Using Muchie for any malicious purpose, including but not limited to phishing, social engineering, or any other form of cybercrime.
* **Illegal activities:** Using Muchie in any way that violates local, state, or federal laws.

## 3. Our Stance on Misuse

We, the developers of Muchie, do not condone the use of our tool for any illegal or unethical activities. We are not responsible for any misuse of this tool.

## 4. Reporting Misuse

If you believe that Muchie is being used for malicious purposes, please contact us at [email protected]
16 changes: 16 additions & 0 deletions muchie/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Muchie - Ethical Offensive Security Toolkit

Muchie is a command-line red-teaming simulator that safely demonstrates common attack vectors in controlled environments.

## Demo

To run a phishing simulation, use the following command:

```bash
python3 muchie.py --simulate phishing
```

## Documents

* [Threat Model](./THREAT_MODEL.md)
* [Ethics Disclaimer](./ETHICS.md)
33 changes: 33 additions & 0 deletions muchie/THREAT_MODEL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Threat Model for Muchie

## 1. Introduction

This document outlines the threat model for Muchie, an ethical offensive security toolkit. The purpose of this model is to identify potential security risks and define mitigation strategies to ensure the tool is used safely and responsibly.

## 2. Potential Threats

### 2.1. Misuse of the Tool

* **Threat:** A malicious actor could use Muchie to generate phishing payloads or other simulated attack vectors for real-world attacks.
* **Mitigation:**
* The tool includes a clear ethics disclaimer (`ETHICS.md`).
* The tool is designed for controlled environments and educational purposes only.
* The tool does not include features for sending emails or other forms of communication.

### 2.2. Insecure Payload Generation

* **Threat:** The generated payloads could contain vulnerabilities that could be exploited by a third party.
* **Mitigation:**
* The payload generation logic is kept simple and does not include any complex or dynamic code.
* The payloads are intended to be samples and should not be used in production environments.

### 2.3. Unintended System Impact

* **Threat:** The tool could have unintended consequences on the system it is run on.
* **Mitigation:**
* The tool is designed to be self-contained and does not interact with the underlying system in a harmful way.
* The tool's functionality is limited to generating text-based payloads.

## 3. Conclusion

The threat model for Muchie is focused on preventing misuse and ensuring the tool is used for its intended purpose of education and ethical red-teaming. The mitigations outlined in this document are designed to minimize the risk of the tool being used for malicious purposes.
17 changes: 17 additions & 0 deletions muchie/muchie.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import argparse
import phishing

def main():
parser = argparse.ArgumentParser(description="Ethical Offensive Security Toolkit")
parser.add_argument("--simulate", type=str, required=True, help="Simulation type")
args = parser.parse_args()

if args.simulate == "phishing":
print("Simulating phishing attack...")
payload = phishing.generate_payload()
print(f"Generated payload: {payload}")
else:
print("Unknown simulation type")

if __name__ == "__main__":
main()
3 changes: 3 additions & 0 deletions muchie/phishing.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
def generate_payload():
"""Generates a sample phishing payload."""
return "This is a sample phishing payload."
8 changes: 8 additions & 0 deletions muchie/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[tool.poetry]
name = "muchie"
version = "0.1.0"
description = "Ethical Offensive Security Toolkit"
authors = ["Jules"]

[tool.poetry.dependencies]
python = "^3.9"