Skip to content

armgit / ARES

Public Imported from GitHub
0

ARES - authorized red-team engagement automation with dashboard, campaign scope, module orchestration, OPSEC controls, encrypted vault, and reporting.

docs: add Code of Conduct, Discussion templates, and community guidelines

Mafifrizidbb4ffc14288
diff --git a/.github/DISCUSSION_TEMPLATE/bug-reports.yml b/.github/DISCUSSION_TEMPLATE/bug-reports.yml
new file mode 100644
index 0000000..361991f
--- /dev/null
+++ b/.github/DISCUSSION_TEMPLATE/bug-reports.yml
@@ -0,0 +1,128 @@
+title: "[Bug] "
+labels: []
+body:
+ - type: markdown
+ attributes:
+ value: |
+ ## πŸ› Bug Report
+
+ Use this template to report bugs, unexpected behavior, or regressions.
+
+ > **⚠️ Security Vulnerabilities**: If this bug has security implications (auth bypass, credential exposure, scope guard bypass, injection), **DO NOT** report it here. Follow [SECURITY.md](https://github.com/Mafifrizi/ARES/blob/main/SECURITY.md) for responsible disclosure.
+
+ > **⚠️ Redaction Reminder**: Remove ALL real credentials, tokens, API keys, target hostnames, and IP addresses from your report. Use `[REDACTED]` placeholders.
+
+ - type: input
+ id: ares-version
+ attributes:
+ label: ARES Version
+ description: "Run `ares --version` or `pip show ares-redteam`"
+ placeholder: "e.g., 6.0.0"
+ validations:
+ required: true
+
+ - type: input
+ id: python-version
+ attributes:
+ label: Python Version
+ description: "Run `python --version`"
+ placeholder: "e.g., 3.12.4"
+ validations:
+ required: true
+
+ - type: dropdown
+ id: operating-system
+ attributes:
+ label: Operating System
+ options:
+ - Windows 10/11
+ - Ubuntu / Debian
+ - Kali Linux
+ - Fedora / RHEL / CentOS
+ - macOS
+ - Docker container
+ - WSL2
+ - Other (specify in description)
+ validations:
+ required: true
+
+ - type: dropdown
+ id: component
+ attributes:
+ label: Affected Component
+ description: "Which part of ARES is affected?"
+ options:
+ - Module execution
+ - CLI (`ares` command)
+ - API / Backend
+ - Frontend / Dashboard
+ - Campaign management
+ - Scope Guard / Firewall
+ - Vault / Encryption
+ - Reporting / PDF generation
+ - MCP Server
+ - Installation / Setup
+ - Other
+ validations:
+ required: true
+
+ - type: textarea
+ id: description
+ attributes:
+ label: Bug Description
+ description: "Clear, concise description of the bug."
+ placeholder: "When I run [command/action], I expect [expected behavior], but instead [actual behavior]."
+ validations:
+ required: true
+
+ - type: textarea
+ id: reproduction
+ attributes:
+ label: Steps to Reproduce
+ description: "Minimal steps to reproduce the bug."
+ placeholder: |
+ 1. Install ARES v6.x with `pip install -e ".[dev]"`
+ 2. Run `ares campaign create --name test --targets 10.0.0.0/24`
+ 3. Run `ares module run ad.enum_users --target [REDACTED]`
+ 4. Observe error: [error message]
+ validations:
+ required: true
+
+ - type: textarea
+ id: expected
+ attributes:
+ label: Expected Behavior
+ description: "What should have happened?"
+ validations:
+ required: true
+
+ - type: textarea
+ id: actual
+ attributes:
+ label: Actual Behavior
+ description: "What actually happened? Include the full error message if applicable."
+ validations:
+ required: true
+
+ - type: textarea
+ id: logs
+ attributes:
+ label: Logs / Stack Trace
+ description: "Paste relevant logs or stack traces. Run with `--verbose` for detailed output. **Redact all sensitive data.**"
+ render: shell
+ validations:
+ required: false
+
+ - type: checkboxes
+ id: checklist
+ attributes:
+ label: Pre-submission Checklist
+ options:
+ - label: This is NOT a security vulnerability (those go to SECURITY.md)
+ required: true
+ - label: I have searched existing issues and discussions for duplicates
+ required: true
+ - label: I have redacted all sensitive information from this report
+ required: true
+ - label: I can reproduce this bug consistently
+ required: false
diff --git a/.github/DISCUSSION_TEMPLATE/ideas-and-proposals.yml b/.github/DISCUSSION_TEMPLATE/ideas-and-proposals.yml
new file mode 100644
index 0000000..f1da28a
--- /dev/null
+++ b/.github/DISCUSSION_TEMPLATE/ideas-and-proposals.yml
@@ -0,0 +1,91 @@
+title: "[Proposal] "
+labels: []
+body:
+ - type: markdown
+ attributes:
+ value: |
+ ## πŸ’‘ Feature Proposals & Ideas
+
+ Use this template to propose new features, modules, architectural improvements, or integration ideas for ARES.
+
+ Before submitting, please:
+ - Search [existing proposals](https://github.com/Mafifrizi/ARES/discussions/categories/ideas-proposals) to avoid duplicates.
+ - Check the [CONTRIBUTING guide](https://github.com/Mafifrizi/ARES/blob/main/CONTRIBUTING.md) for the module development process.
+ - For new module ideas, also check the [RFC: Linux AD Tradecraft](https://github.com/Mafifrizi/ARES/blob/main/docs/research/linux-active-directory-tradecraft.md) for already-planned modules.
+
+ - type: textarea
+ id: summary
+ attributes:
+ label: Proposal Summary
+ description: "One-paragraph summary of what you're proposing."
+ placeholder: "I propose adding [feature/module] that would allow operators to [capability]."
+ validations:
+ required: true
+
+ - type: textarea
+ id: problem
+ attributes:
+ label: Problem / Motivation
+ description: "What problem does this solve? What gap does it fill? Why is this needed?"
+ placeholder: |
+ Currently, ARES cannot [limitation].
+ This is a problem because [impact on operators/engagements].
+ validations:
+ required: true
+
+ - type: textarea
+ id: solution
+ attributes:
+ label: Proposed Solution
+ description: "Describe your proposed solution in detail. Include technical approach, MITRE ATT&CK mapping (if applicable), and any relevant references."
+ placeholder: |
+ ## Technical Approach
+ - Implement a new module `category.module_name` that...
+
+ ## MITRE ATT&CK
+ - T1234 β€” Technique Name
+
+ ## References
+ - [Blog post / research paper / tool that inspired this]
+ validations:
+ required: true
+
+ - type: textarea
+ id: alternatives
+ attributes:
+ label: Alternatives Considered
+ description: "What other approaches did you consider? Why is your proposal better?"
+ placeholder: |
+ 1. Alternative A: [description] β€” rejected because [reason]
+ 2. Alternative B: [description] β€” partially viable but [limitation]
+ validations:
+ required: false
+
+ - type: dropdown
+ id: category
+ attributes:
+ label: Category
+ description: "What area of ARES does this proposal affect?"
+ options:
+ - New Module
+ - Core Engine
+ - API / Backend
+ - Frontend / Dashboard
+ - CLI
+ - Documentation
+ - DevOps / CI/CD
+ - Security Model
+ - MCP / Integration
+ - Other
+ validations:
+ required: true
+
+ - type: checkboxes
+ id: implementation
+ attributes:
+ label: Implementation
+ options:
+ - label: I am willing to implement this proposal and submit a PR
+ required: false
+ - label: I have read the CONTRIBUTING.md guide
+ required: true
diff --git a/.github/DISCUSSION_TEMPLATE/module-development.yml b/.github/DISCUSSION_TEMPLATE/module-development.yml
new file mode 100644
index 0000000..3884d32
--- /dev/null
+++ b/.github/DISCUSSION_TEMPLATE/module-development.yml
@@ -0,0 +1,128 @@
+title: "[Module] "
+labels: []
+body:
+ - type: markdown
+ attributes:
+ value: |
+ ## πŸ”¬ Module Development Discussion
+
+ Use this template to discuss module implementation, research tradecraft, MITRE technique coverage, and integration patterns.
+
+ **Before starting:**
+ - Read the [CONTRIBUTING guide](https://github.com/Mafifrizi/ARES/blob/main/CONTRIBUTING.md), especially the "Writing a New Module" section.
+ - Check [MODULE_AUDIT_INVENTORY.md](https://github.com/Mafifrizi/ARES/blob/main/MODULE_AUDIT_INVENTORY.md) to see existing modules.
+ - Review [KEY_CONVENTION_STANDARD.md](https://github.com/Mafifrizi/ARES/blob/main/KEY_CONVENTION_STANDARD.md) for output key conventions.
+ - For Linux AD modules, see the [RFC: Linux AD Tradecraft](https://github.com/Mafifrizi/ARES/blob/main/docs/research/linux-active-directory-tradecraft.md).
+
+ - type: input
+ id: module-id
+ attributes:
+ label: Module ID
+ description: "Proposed MODULE_ID in `category.module_name` format."
+ placeholder: "e.g., ad.delegation_abuse, linux.sssd_harvest, cloud.azure_token_theft"
+ validations:
+ required: true
+
+ - type: dropdown
+ id: category
+ attributes:
+ label: Module Category
+ options:
+ - ad (Active Directory)
+ - credential (Credential Access)
+ - lateral (Lateral Movement)
+ - windows (Windows Post-Exploitation)
+ - linux (Linux Post-Exploitation)
+ - cloud (Cloud Security)
+ - network (Network Operations)
+ - recon (Reconnaissance)
+ - exfil (Data Exfiltration)
+ - persistence (Persistence)
+ - Other
+ validations:
+ required: true
+
+ - type: input
+ id: mitre-technique
+ attributes:
+ label: MITRE ATT&CK Technique(s)
+ description: "Technique IDs this module maps to."
+ placeholder: "e.g., T1558.003, T1003.006"
+ validations:
+ required: true
+
+ - type: dropdown
+ id: opsec-level
+ attributes:
+ label: OPSEC Level
+ description: "Expected noise level of this module."
+ options:
+ - STEALTH (passive / no network artifacts)
+ - LOW (minimal footprint)
+ - MEDIUM (moderate detection risk)
+ - HIGH_NOISE (high detection risk, blocked in STEALTH mode)
+ validations:
+ required: true
+
+ - type: textarea
+ id: description
+ attributes:
+ label: Module Description
+ description: "What does this module do? What attack technique does it implement?"
+ placeholder: |
+ This module implements [technique] against [target type].
+
+ It works by:
+ 1. [Step 1]
+ 2. [Step 2]
+ 3. [Step 3]
+
+ Prerequisites: [what access/credentials are needed]
+ Output: [what artifacts/findings it produces]
+ validations:
+ required: true
+
+ - type: textarea
+ id: technical-approach
+ attributes:
+ label: Technical Approach
+ description: "How will this be implemented? Include libraries, protocols, and relevant code references."
+ placeholder: |
+ ## Implementation Plan
+ - Use [library] for [protocol] communication
+ - Parse [data format] from [source]
+ - Follow BaseModule contract with validate() β†’ execute() β†’ run()
+
+ ## Dependencies
+ - [New dependency if needed, with justification]
+
+ ## Key Considerations
+ - [Error handling approach]
+ - [Cleanup / teardown requirements]
+ validations:
+ required: true
+
+ - type: textarea
+ id: references
+ attributes:
+ label: References & Prior Art
+ description: "Link to research papers, blog posts, existing tools, or CVEs that inform this module."
+ placeholder: |
+ - [Tool/Blog name](https://example.com) β€” description
+ - [Research paper](https://example.com) β€” key findings
+ validations:
+ required: false
+
+ - type: checkboxes
+ id: checklist
+ attributes:
+ label: Pre-submission Checklist
+ options:
+ - label: I have read CONTRIBUTING.md and understand the module contract
+ required: true
+ - label: I have checked MODULE_AUDIT_INVENTORY.md for existing coverage
+ required: true
+ - label: This module does NOT duplicate existing functionality
+ required: true
+ - label: I am willing to implement this module and submit a PR
+ required: false
diff --git a/.github/DISCUSSION_TEMPLATE/q-and-a.yml b/.github/DISCUSSION_TEMPLATE/q-and-a.yml
new file mode 100644
index 0000000..f6ea8ac
--- /dev/null
+++ b/.github/DISCUSSION_TEMPLATE/q-and-a.yml
@@ -0,0 +1,95 @@
+title: "[Q&A] "
+labels: []
+body:
+ - type: markdown
+ attributes:
+ value: |
+ ## πŸ” Before You Ask
+
+ - Search [existing discussions](https://github.com/Mafifrizi/ARES/discussions/categories/q-a) β€” your question may already be answered.
+ - Check the [QUICKSTART guide](https://github.com/Mafifrizi/ARES/blob/main/QUICKSTART.md) and [documentation](https://github.com/Mafifrizi/ARES/tree/main/docs).
+ - **DO NOT** post security vulnerabilities here. Use [SECURITY.md](https://github.com/Mafifrizi/ARES/blob/main/SECURITY.md) for responsible disclosure.
+
+ - type: input
+ id: ares-version
+ attributes:
+ label: ARES Version
+ description: "Run `ares --version` or `pip show ares-redteam`"
+ placeholder: "e.g., 6.0.0"
+ validations:
+ required: true
+
+ - type: input
+ id: python-version
+ attributes:
+ label: Python Version
+ description: "Run `python --version`"
+ placeholder: "e.g., 3.12.4"
+ validations:
+ required: true
+
+ - type: dropdown
+ id: operating-system
+ attributes:
+ label: Operating System
+ options:
+ - Windows 10/11
+ - Ubuntu / Debian
+ - Kali Linux
+ - Fedora / RHEL / CentOS
+ - macOS
+ - Docker container
+ - WSL2
+ - Other (specify in description)
+ validations:
+ required: true
+
+ - type: textarea
+ id: question
+ attributes:
+ label: Your Question
+ description: "Describe your question clearly. Include context about what you're trying to achieve."
+ placeholder: |
+ I'm trying to [goal] using [module/feature].
+
+ I expected [expected behavior], but [what actually happened].
+
+ Here's the relevant configuration / command I'm running:
+ ```
+ ares campaign run ...
+ ```
+ validations:
+ required: true
+
+ - type: textarea
+ id: what-tried
+ attributes:
+ label: What I Already Tried
+ description: "List what you've already attempted. This helps us avoid suggesting things you've already done."
+ placeholder: |
+ 1. Checked the docs at [link]
+ 2. Tried running with --verbose flag
+ 3. Searched discussions for [keywords]
+ validations:
+ required: false
+
+ - type: textarea
+ id: logs
+ attributes:
+ label: Relevant Logs or Output
+ description: "Paste any relevant logs or error output. **Redact all credentials, tokens, and target information.**"
+ render: shell
+ validations:
+ required: false
+
+ - type: checkboxes
+ id: checklist
+ attributes:
+ label: Pre-submission Checklist
+ options:
+ - label: I have searched existing discussions and did not find an answer
+ required: true
+ - label: I have checked the documentation (QUICKSTART.md, docs/)
+ required: true
+ - label: I have redacted all sensitive information (credentials, tokens, real target IPs/hostnames)
+ required: true
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..3ade8dd
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,161 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+ and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+ community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+ any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+ without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+### Security-Specific Standards
+
+ARES is an offensive security framework. The following additional standards
+apply to all community interactions:
+
+* **DO NOT** post actual security vulnerabilities, zero-day exploits, or
+ unpatched weaknesses in public discussions, issues, or pull requests.
+ Report them privately via [SECURITY.md](SECURITY.md).
+* **DO NOT** share real credentials, hashes, tokens, API keys, or session
+ data in any public channel β€” even as "examples." Use synthetic or redacted
+ placeholders.
+* **DO NOT** post engagement artifacts (reports, findings, target data) from
+ real-world assessments. Use lab environments and sanitized examples only.
+* **DO** follow responsible disclosure practices as defined in our
+ [Security Policy](SECURITY.md).
+* **DO** redact all sensitive data from logs, screenshots, and code snippets
+ before sharing.
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at:
+
+**Email:** [email protected]
+
+All complaints will be reviewed and investigated promptly and fairly. All
+community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+### Security Incident Handling
+
+If a community member posts sensitive security information (vulnerabilities,
+credentials, exploit code) in a public channel:
+
+1. A maintainer will **immediately** remove or redact the content
+2. The poster will be contacted privately with guidance on proper disclosure
+3. No punitive action will be taken for good-faith mistakes on a first
+ occurrence, provided the poster cooperates with remediation
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 04049fe..a87776d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -7,14 +7,40 @@ to get started - from dev environment setup to submitting a pull request.
## Table of Contents
-1. [Development Environment](#development-environment)
-2. [Branching Strategy](#branching-strategy)
-3. [Commit Conventions](#commit-conventions)
-4. [Priority Research Track: Linux Active Directory](#priority-research-track-linux-active-directory)
-5. [Writing a New Module](#writing-a-new-module)
-6. [Testing Requirements](#testing-requirements)
-7. [Pull Request Process](#pull-request-process)
-8. [Code Guidelines & Conventions](#code-guidelines--conventions)
+1. [Community & Discussions](#community--discussions)
+2. [Development Environment](#development-environment)
+3. [Branching Strategy](#branching-strategy)
+4. [Commit Conventions](#commit-conventions)
+5. [Priority Research Track: Linux Active Directory](#priority-research-track-linux-active-directory)
+6. [Writing a New Module](#writing-a-new-module)
+7. [Testing Requirements](#testing-requirements)
+8. [Pull Request Process](#pull-request-process)
+9. [Code Guidelines & Conventions](#code-guidelines--conventions)
+
+---
+
+## Community & Discussions
+
+ARES uses [GitHub Discussions](https://github.com/Mafifrizi/ARES/discussions) for community interaction. Before opening a new issue or PR, consider whether a Discussion is more appropriate:
+
+| Channel | Use for |
+|---------|---------|
+| **[Discussions β†’ Q&A](https://github.com/Mafifrizi/ARES/discussions/categories/q-a)** | Help with installation, configuration, module usage, troubleshooting |
+| **[Discussions β†’ Ideas & Proposals](https://github.com/Mafifrizi/ARES/discussions/categories/ideas-proposals)** | Feature requests, new module ideas, architectural suggestions |
+| **[Discussions β†’ Bug Reports](https://github.com/Mafifrizi/ARES/discussions/categories/bug-reports)** | Bug reports that need discussion before becoming issues |
+| **[Discussions β†’ Module Development](https://github.com/Mafifrizi/ARES/discussions/categories/module-development)** | Module design, research tradecraft, MITRE technique coverage |
+| **GitHub Issues** | Confirmed bugs, tracked tasks, accepted feature work |
+| **Pull Requests** | Code contributions ready for review |
+| **[SECURITY.md](SECURITY.md)** | Security vulnerabilities β€” **never** in public Discussions or Issues |
+
+### Code of Conduct
+
+All participants must follow our [Code of Conduct](CODE_OF_CONDUCT.md). In particular:
+
+- **DO NOT** post real credentials, hashes, tokens, or target data in any public channel
+- **DO NOT** disclose security vulnerabilities publicly β€” use [SECURITY.md](SECURITY.md)
+- **DO** redact all sensitive data from logs, screenshots, and code snippets
+- **DO** be respectful, constructive, and technically honest
---
@@ -282,4 +308,4 @@ pytest tests/unit/ --cov=ares --cov-fail-under=82 -v # with coverage
- **ruff** for linting (replaces flake8, isort, pyupgrade)
- **No hardcoded secrets** - everything via `.env` or env vars
-Questions? Open an issue or ping `@ares-framework/maintainers` on GitHub.
+Questions? Start a [Discussion](https://github.com/Mafifrizi/ARES/discussions) or open an issue on GitHub.