ARES - authorized red-team engagement automation with dashboard, campaign scope, module orchestration, OPSEC controls, encrypted vault, and reporting.
Python active-directorycloud-securitydefensive-validationfastapigood-first-issuemitre-attackopsecreactred-teamreportingsecurity
docs(sdk): elevate SDK nomenclature to Next-Gen Sovereign Autonomous Architecture
Mafifrizieb10e4192db6
diff --git a/QUICKSTART.md b/QUICKSTART.mdindex a1df480..9594b24 100644--- a/QUICKSTART.md+++ b/QUICKSTART.md@@ -393,7 +393,7 @@ export OPENAI_API_KEY="..."Use Strategy only after a campaign exists, scope is correct, authorizationnotes are clear, and the selected LLM backend is configured.-### Public SDK (v2 Modern Standard)+### Public SDK (Next-Gen Autonomous Architecture)Use the modern, type-safe SDK import path for custom modules, unit testing, and automation:diff --git a/README.md b/README.mdindex 1258dbb..2f1ee61 100644--- a/README.md+++ b/README.md@@ -404,7 +404,7 @@ ARES enforces strict RBAC permissions across all API endpoints and UI controls:----## 🛠️ Extensible Developer SDK (v2 Modern Standard)+## 🛠️ Extensible Developer SDK (Next-Gen Autonomous Architecture)ARES provides a first-class, type-safe Python SDK (`ares.sdk`) to build custom adversary modules, simulate techniques in isolated test harnesses, and automate engagements programmatically:@@ -479,7 +479,7 @@ Comprehensive documentation is available in the [`docs/`](docs/) directory:- [**Documentation Portal & Subsystem Index**](docs/README.md)- [**Quickstart Engagement Guide**](QUICKSTART.md)-- [**Modern Module SDK Specification (v2)**](docs/module_sdk.md)+- [**Next-Gen Module SDK Specification (v2)**](docs/module_sdk.md)- [**Step-by-Step Module Development Guide**](docs/module-development.md)- [**Dashboard Surface-by-Surface Manual**](docs/dashboard-guide.md)- [**Adversary Module Catalog & Schemas**](docs/modules.md)diff --git a/ares/sdk/__init__.py b/ares/sdk/__init__.pyindex d4bd0d1..343cfac 100644--- a/ares/sdk/__init__.py+++ b/ares/sdk/__init__.py@@ -1,4 +1,4 @@-"""Public ARES SDK import surface (v2 Modern Standard).+"""Public ARES SDK import surface (Next-Gen Autonomous Architecture).Provides everything needed for module authoring, testing, and programmatic automation:diff --git a/ares/sdk/module.py b/ares/sdk/module.pyindex fb980f4..9914ea0 100644--- a/ares/sdk/module.py+++ b/ares/sdk/module.py@@ -1,4 +1,4 @@-"""Modern ARES Module Authoring Contracts (v2 Standard).+"""Next-Gen ARES Module Authoring Contracts (v2 Sovereign Tier).Provides:- BaseModule[P, R]: Type-safe generic base class for class-based modules.diff --git a/docs/module-development.md b/docs/module-development.mdindex c6435b3..5442931 100644--- a/docs/module-development.md+++ b/docs/module-development.md@@ -43,7 +43,7 @@ or that current outcomes and retries are authoritative.----## Quick Start (v2 Modern Standard)+## Quick Start (Next-Gen Architecture)The modern ARES SDK (`ares.sdk`) introduces type-safe parameter schemas with Pydantic v2, generic `BaseModule[P, R]`, fluent execution helpers, and isolated simulation testing.@@ -344,7 +344,7 @@ The `ExecutionContext` object represents the execution runtime environment for actx.params # P (when ExecutionContext[P] is used) or dictctx.typed_params(Model) # Parses and returns an instance of Model-# Fluent Helpers (v2 Standard)+# Fluent Helpers (Next-Gen Architecture)ctx.emit_finding(title, severity, ...) # Appends to ctx.findings and returns Findingctx.store_artifact(key, value) # Stores to ctx.artifactsctx.record_credential(username, secret, ..) # Stores to vault and tracks new credential@@ -431,7 +431,7 @@ async def test_mssql_enum_finding_emission():assert "MSSQL instance" in finding.title```-### 2. Legacy `ExecutionContext.for_test()` (v1 Standard)+### 2. Legacy `ExecutionContext.for_test()` (v1 Legacy Interface)Legacy test cases using direct `ExecutionContext.for_test()` continue to function seamlessly:diff --git a/docs/module_sdk.md b/docs/module_sdk.mdindex 3f31d59..78dafe1 100644--- a/docs/module_sdk.md+++ b/docs/module_sdk.md@@ -1,6 +1,6 @@# ARES Module & Developer SDK-**Version:** 2.0.0 (Modern Type-Safe Standard) | **Backward Compatible with v1.0.0**+**Version:** 2.0.0 (Next-Gen Sovereign Architecture) | **Backward Compatible with v1.0.0**> Complete guide for ARES module authors and automation engineers.> Everything needed to build type-safe modules, simulate attacks in isolation, and automate ARES via Python.@@ -16,7 +16,7 @@----## Modern Quick Start (v2 Standard)+## Quick Start (Next-Gen Architecture)```python# my_module.pydiff --git a/example_modules/example_modern_v2_module.py b/example_modules/example_modern_v2_module.pyindex 44fee1d..2a5e5d3 100644--- a/example_modules/example_modern_v2_module.py+++ b/example_modules/example_modern_v2_module.py@@ -1,4 +1,4 @@-"""ARES Example Module (Enterprise Security & Governance SDK Standard).+"""ARES Example Module (Next-Gen Autonomous Architecture & Sovereign Security).Demonstrates:- Declarative @module_contract with Capability-Based Permissions (NetworkPermission, VaultPermission)diff --git a/tests/unit/test_modern_sdk_v2.py b/tests/unit/test_modern_sdk_v2.pyindex 22d13a4..1c7f7f4 100644--- a/tests/unit/test_modern_sdk_v2.py+++ b/tests/unit/test_modern_sdk_v2.py@@ -1,4 +1,4 @@-"""Unit tests for ARES SDK v2 Modern Standard.+"""Unit tests for ARES SDK v2 Next-Gen Autonomous Architecture.Tests:1. Pydantic v2 parameter models (ModuleParams, param, SecretParam, validate_params).