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
export type Role = "team_lead" | "operator" | "recon" | "reporter" | string;
export interface TokenResponse {
access_token: string;
token_type: string;
expires_in: number;
role: Role;
refresh_generation: number;
session_coordination_key: string;
}
export interface UserProfile {
username: string;
role: Role;
}
export interface WebSocketTicketResponse {
ticket: string;
expires_in: 30;
}
export interface LiveSubmissionOptions {
idempotencyKey?: string;
startNewSubmission?: boolean;
}
export interface LiveExecutionResponse {
idempotency_key: string;
[key: string]: unknown;
}
export interface Campaign {
id: string;
name: string;
client?: string;
operator?: string;
targets?: string[];
scope_cidrs?: string[];
scope_json?: string;
noise_profile?: string;
status?: string;
created_at?: string;
[key: string]: unknown;
}
export interface Finding {
id?: string;
title?: string;
severity?: string;
module_id?: string;
host?: string;
mitre_technique?: string;
confidence?: number;
validated?: boolean;
[key: string]: unknown;
}
export interface ParamField {
type: string;
description: string;
required: boolean;
secret: boolean;
default?: unknown;
items?: {
type?: string;
};
min?: number;
max?: number;
min_len?: number;
max_len?: number;
pattern?: string;
}
export type ParamSchema = Record<string, ParamField>;
export interface ModuleMeta {
id: string;
name?: string;
category?: string;
description?: string;
opsec_level?: string;
mitre?: string;
mitre_list?: string[];
required_params?: string[];
optional_params?: string[];
defaults?: Record<string, unknown>;
capability_flags?: string[];
dry_run_supported?: boolean;
supported_modes?: string[];
dependency_notes?: string[];
outcome_semantics?: string[];
safe_error_categories?: string[];
param_schema: ParamSchema;
[key: string]: unknown;
}
export interface ExecutionChainStage {
order: number;
title: string;
module_ids: string[];
purpose: string;
required_inputs: string[];
uses_previous_output: boolean;
produces: string[];
next_action: string;
final_goal: boolean;
}
export interface ExecutionChain {
id: string;
title: string;
category: string;
description: string;
stages: ExecutionChainStage[];
}
export interface MonthlyFindingStats {
period: string;
label: string;
total: number;
confirmed_findings?: number;
series: Array<{ date: string; count: number }>;
}
export interface ReportItem {
filename: string;
format: string;
size_bytes: number;
modified_at: number;
}
export interface TemplateMeta {
name?: string;
description?: string;
stages?: number;
modules?: number;
[key: string]: unknown;
}
export interface ApiKeyMeta {
id: string;
name?: string;
prefix?: string;
key_prefix?: string;
scopes?: string;
created_at?: string;
expires_at?: string;
[key: string]: unknown;
}
export interface ApiKeyCreateResponse extends ApiKeyMeta {
key: string;
note?: string;
}
export type SafeGraphValue = boolean | number | string | null | SafeGraphValue[] | { [key: string]: SafeGraphValue };
export interface GraphNodePayload {
id: string;
type: string;
label: string;
color?: string;
data?: Record<string, SafeGraphValue>;
style?: {
color?: string;
shape?: string;
size?: number;
};
}
export interface GraphEdgePayload {
source: string;
target: string;
type?: string;
label?: string;
weight?: number;
data?: Record<string, SafeGraphValue>;
style?: {
color?: string;
dashed?: boolean;
};
}
export interface CampaignGraph {
nodes: GraphNodePayload[];
edges: GraphEdgePayload[];
stats?: Record<string, SafeGraphValue>;
data_sources?: Record<string, SafeGraphValue>;
}
export interface AttackPathStep {
from: string;
to: string;
edge?: string;
attack?: string;
weight?: number;
}
export interface AttackPath {
path_length?: number;
total_score?: number;
steps: AttackPathStep[];
attack_modules?: string[];
start?: string;
end?: string;
}
export interface AttackPathsResponse {
paths?: AttackPath[];
path?: AttackPath | null;
paths_found?: number;
message?: string;
stats?: Record<string, SafeGraphValue>;
}
export interface FeasibilityReportData {
feasible: boolean;
score: number;
risk_level: string;
blockers: string[];
recommended_alternatives: string[];
opsec_tuning: Record<string, unknown>;
details: Record<string, unknown>;
}
export interface FeasibilityResponse {
module_id: string;
campaign_id: string;
report: FeasibilityReportData;
}
export interface LiveWebSocketEvent {
id?: string;
campaign_id?: string;
timestamp?: number;
event?: string;
type?: string;
module_id?: string;
status?: string;
detail?: string;
data?: Record<string, unknown>;
[key: string]: unknown;
}
export interface VaultRestoreResult {
restored: number;
campaign_id?: string;
message?: string;
status?: string;
total_credentials?: number;
}
export interface TemplatePlanSummary {
ready_to_run?: boolean;
total_stages?: number;
total_modules?: number;
estimated_duration_sec?: number;
}
export interface TemplatePlanResult {
plan?: unknown[];
summary?: TemplatePlanSummary;
}
export interface ApiErrorPayload {
detail?: string;
message?: string;
}