diff --git a/muchie/.gitignore b/muchie/.gitignore new file mode 100644 index 0000000000..c18dd8d83c --- /dev/null +++ b/muchie/.gitignore @@ -0,0 +1 @@ +__pycache__/ diff --git a/muchie/ETHICS.md b/muchie/ETHICS.md new file mode 100644 index 0000000000..06506f2dd1 --- /dev/null +++ b/muchie/ETHICS.md @@ -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] diff --git a/muchie/README.md b/muchie/README.md new file mode 100644 index 0000000000..428eccc27b --- /dev/null +++ b/muchie/README.md @@ -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) diff --git a/muchie/THREAT_MODEL.md b/muchie/THREAT_MODEL.md new file mode 100644 index 0000000000..1019769d54 --- /dev/null +++ b/muchie/THREAT_MODEL.md @@ -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. diff --git a/muchie/muchie.py b/muchie/muchie.py new file mode 100644 index 0000000000..5c50f1fc1c --- /dev/null +++ b/muchie/muchie.py @@ -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() diff --git a/muchie/phishing.py b/muchie/phishing.py new file mode 100644 index 0000000000..cc4c4ba13b --- /dev/null +++ b/muchie/phishing.py @@ -0,0 +1,3 @@ +def generate_payload(): + """Generates a sample phishing payload.""" + return "This is a sample phishing payload." diff --git a/muchie/pyproject.toml b/muchie/pyproject.toml new file mode 100644 index 0000000000..777bc8a35a --- /dev/null +++ b/muchie/pyproject.toml @@ -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"