Skip to content

Latest commit

 

History

History
217 lines (175 loc) · 22 KB

plugin-guide.md

File metadata and controls

217 lines (175 loc) · 22 KB
layout documentation
title When to Use Each COPS Plugin
description A comprehensive guide to selecting, evaluating, and running each of the seventeen security plugins across defensive and offensive cybersecurity disciplines.

When to Use Each COPS Plugin

COPS packages seventeen specialized cybersecurity plugins across six core disciplines. Each plugin is self-contained under plugins/<category>/<plugin-id>/ and includes deterministic Python tools, reusable AI skills, and a practitioner playbook.

Use this guide to determine which plugin best matches your operational requirements. Follow plugin verification and maturity to run a complete qualification workflow and record evidence before proposing a status change.


Quick Decision Matrix

What are you trying to accomplish? Reach for this plugin Category Maturity Operational Mode Try it out
Audit code for logging gaps and credential leaks security-logging-advisor Logging & Telemetry Stable import python3 -m cops demo security-logging-advisor
Verify telemetry pipeline health (Cribl → SIEM) telemetry-proof-pack Logging & Telemetry Beta laboratory python3 -m cops check telemetry-proof-pack
Investigate complex alerts with rival hypotheses soc-investigation-workbench Detection & Hunting Beta laboratory python3 -m cops demo soc-investigation-workbench
Author, adapt, or stress-test Sentinel/Defender KQL sentinel-hunt-workbench Detection & Hunting Beta laboratory python3 -m cops demo sentinel-hunt-workbench
Trace multi-hop cloud lateral movement paths attack-path-workbench Detection & Hunting Experimental import python3 -m cops demo attack-path-workbench
Validate detection query syntax & regressions detection-quality-workbench Detection & Hunting Beta laboratory python3 -m cops check detection-quality-workbench
Enrich observables with threat intelligence feeds threat-intelligence-enrichment Detection & Hunting Experimental import python3 -m cops check threat-intelligence-enrichment
Audit Entra ID roles, apps, and credential hygiene entra-identity-workbench Identity & Access Beta import python3 -m cops check entra-identity-workbench
Map scoped Active Directory relationships and candidate paths ad-assessment-workbench Identity & Access Experimental import python3 -m cops demo ad-assessment-workbench
Prioritize vulnerability triage with SBOM reachability exposure-triage-workbench Vulnerability Management Beta import python3 -m cops check exposure-triage-workbench
Review code diffs and pull requests for security flaws patch-security-review Vulnerability Management Beta import python3 -m cops check patch-security-review
Plan an authorized, passive attack surface review attack-surface-planner Offensive Security Experimental planned python3 -m cops demo attack-surface-planner
Reconcile an approved Kubernetes context and namespace scope kubernetes-assessment-workbench Offensive Security Experimental import python3 -m cops demo kubernetes-assessment-workbench
Intake engagement scope and compile action plans offensive-engagement-workbench Offensive Security Experimental planned python3 -m cops demo offensive-engagement-workbench
Review Linux privilege-boundary exports host-assessment-workbench Offensive Security Experimental import python3 -m cops demo host-assessment-workbench
Rehearse synthetic agent tool authorization foundry-agent-harness Offensive Security Beta laboratory python3 -m cops check foundry-agent-harness
Rehearse containment with cryptographic receipts incident-response-sandbox Incident Response Experimental laboratory python3 -m cops check incident-response-sandbox

Detailed Plugin Guidance

1. Logging & Telemetry

Security Logging Advisor

  • Maturity: Stable | Operational Mode: import
  • When to use: During code reviews, CI security checks, or application onboarding when you need to detect missing security audit logging, unmasked PII or credentials in log streams, and identify whether vulnerable dependencies (CVEs) are reachable from application entry points.
  • Key Capabilities: Offline AST-based code analysis, regex credential detectors, CVE reachability correlation.
  • Boundaries: Static code and configuration inspection only; does not ingest live SIEM streams or connect to runtime clusters.
  • Playbook: plugins/logging-telemetry/security-logging-advisor/docs/PLAYBOOK.md
  • Verification: End-to-end playbook

Telemetry Proof Pack

  • Maturity: Beta | Operational Mode: laboratory
  • When to use: When validating complex log pipelines between Cribl Stream, Splunk, and Microsoft Sentinel to detect ingestion bottlenecks, broken routing rules, or cross-tenant event collisions before pushing pipeline changes to production.
  • Key Capabilities: Pipeline topology validation, synthetic health proofs, edge-case failure mode verification.
  • Boundaries: Operates on simulated pipeline topologies; does not connect to live streaming buffers.
  • Playbook: plugins/logging-telemetry/telemetry-proof-pack/docs/PLAYBOOK.md
  • Verification: End-to-end playbook

2. Detection & Hunting

SOC Investigation Workbench

  • Maturity: Beta | Operational Mode: laboratory
  • When to use: When investigating an alert that has multiple plausible explanations (e.g. administrator maintenance vs. attacker living-off-the-land) and you need structured guidance to avoid confirmation bias.
  • Key Capabilities: Analysis of Competing Hypotheses (ACH), inquiry question ranking, evidence dependency graphs.
  • Boundaries: Decision-support framework; does not execute autonomous containment actions.
  • Playbook: plugins/detection-hunting/soc-investigation-workbench/docs/PLAYBOOK.md
  • Verification: End-to-end playbook

Sentinel Hunt Workbench

  • Maturity: Beta | Operational Mode: laboratory
  • When to use: When authoring, adapting, or testing Microsoft Sentinel and Defender XDR KQL queries against synthetic event streams before deployment to live workspaces.
  • Key Capabilities: 12 defensive threat hunts, multi-surface syntax adaptation (Sentinel vs Defender vs Data Lake), offline mutation stress-testing.
  • Boundaries: Synthetic event evaluation; does not authenticate to customer cloud tenants.
  • Playbook: plugins/detection-hunting/sentinel-hunt-workbench/docs/PLAYBOOK.md
  • Verification: End-to-end playbook

Attack Path Workbench

  • Maturity: Experimental | Operational Mode: import
  • When to use: When analyzing cloud IAM trust topologies and lateral movement pathways from offline asset exports to identify critical remediation choke points.
  • Key Capabilities: Multi-hop directed graph traversal, blast radius calculation, choke-point identification.
  • Boundaries: Operates strictly on offline JSON exports; does not perform active network scanning.
  • Playbook: plugins/detection-hunting/attack-path-workbench/docs/PLAYBOOK.md
  • Verification: End-to-end playbook

Detection Quality Workbench

  • Maturity: Beta | Operational Mode: laboratory
  • When to use: When running detection-as-code CI/CD pipelines to catch syntax errors, deprecated operators, and performance regressions in Sentinel KQL and Splunk SPL queries.
  • Key Capabilities: Offline syntax validation, query regression testing, normalization checks.
  • Boundaries: Syntax and regression parser; does not query live search clusters.
  • Playbook: plugins/detection-hunting/detection-quality-workbench/docs/PLAYBOOK.md
  • Verification: End-to-end playbook

Threat Intelligence Enrichment

  • Maturity: Experimental | Operational Mode: import
  • When to use: When enriching indicators of compromise (IPs, hashes, domains) with threat intelligence metadata while preserving provenance and avoiding external data leaks.
  • Key Capabilities: Offline feed correlation (MISP/TAXII cached formats), confidence weighting, tamper-evident provenance stamps.
  • Boundaries: Operates against cached local feeds; external API lookups require explicit operator opt-in.
  • Playbook: plugins/detection-hunting/threat-intelligence-enrichment/skills/threat-intelligence-enrichment/SKILL.md
  • Verification: End-to-end playbook

3. Identity & Access

Entra Identity Workbench

  • Maturity: Beta | Operational Mode: import
  • When to use: When conducting an identity governance review of Microsoft Entra ID (Azure AD) tenants to uncover over-privileged role assignments, stale service principals, high-risk OAuth consent grants, or expiring credentials.
  • Key Capabilities: Offline tenant JSON parsing, privilege escalation graph analysis, credential hygiene scoring.
  • Boundaries: Ingests offline JSON exports; makes zero Microsoft Graph mutations.
  • Playbook: plugins/identity-access/entra-identity-workbench/docs/PLAYBOOK.md
  • Verification: End-to-end playbook

AD Assessment Workbench

  • Maturity: Experimental | Operational Mode: import
  • When to use: When reviewing an approved, scoped Active Directory relationship export and the declared forest and host collection coverage.
  • Key Capabilities: Bounded offline graph validation, provenance-linked candidate paths, and explicit complete, partial, or unknown coverage.
  • Boundaries: Candidate paths require analyst validation. The package neither queries a domain controller nor verifies live privileges or missing relationships outside the collected graph.
  • Playbook: plugins/identity-access/ad-assessment-workbench/skills/ad-inventory-and-paths/SKILL.md
  • Verification: End-to-end playbook

4. Vulnerability Management

Exposure Triage Workbench

  • Maturity: Beta | Operational Mode: import
  • When to use: When prioritizing thousands of open CVEs across container images or repositories by filtering for components that are actually reachable from code entry points or exposed to network boundaries.
  • Key Capabilities: SBOM ingestion (CycloneDX / SPDX), advisory CVE matching, static call-graph reachability.
  • Boundaries: Offline reachability analysis indicates exposure potential, not confirmed live exploitability.
  • Playbook: plugins/vulnerability-management/exposure-triage-workbench/docs/PLAYBOOK.md
  • Verification: End-to-end playbook

Patch Security Review

  • Maturity: Beta | Operational Mode: import
  • When to use: During code reviews and pull request approvals to automatically detect whether a proposed change introduces security regressions, bypasses authorization, or weakens defensive controls.
  • Key Capabilities: Static patch diff inspection, AST security pattern matching, regression risk classification.
  • Boundaries: Static diff inspection; does not execute dynamic application security or runtime exploit payloads.
  • Playbook: plugins/vulnerability-management/patch-security-review/skills/patch-review/SKILL.md
  • Verification: End-to-end playbook

5. Offensive Security

Attack Surface Planner

  • Maturity: Experimental | Operational Mode: planned
  • When to use: Prior to an authorized penetration test or red team engagement to reconcile rules of engagement, partition in-scope vs out-of-scope targets, normalize multi-source passive discovery telemetry, execute bounded active discovery and service identification, assess infrastructure and identity-facing services, evaluate remote administration, file sharing, and printing services, assess databases, caches, and search engines, evaluate mail, chat, and message brokers, assess developer and runtime interfaces, evaluate legacy enterprise, management, and proxy services, and generate bounded test plans.
  • Key Capabilities: Scope boundary enforcement, rule-of-engagement parsing, passive review plan generation, multi-source telemetry normalization (DNS, certificate, IP, endpoint, cloud exports), evidence provenance preservation, scope quarantine reconciliation, bounded active service identification with resumable checkpoints and visible uncertainty, protocol-specific infrastructure assessment (DNS, SNMP, NTP, RPC, LDAP, Kerberos), remote administration, file sharing, and printing assessment (SSH, Telnet, RDP, VNC, WinRM, X11, SMB, NFS, FTP/TFTP, rsync, AFP, LPD, IPP, Raw/JetDirect), database, cache, and search assessment (MySQL, Postgres, MSSQL, Oracle, MongoDB, CouchDB, Cassandra, Redis, Memcached, Elasticsearch, InfluxDB, Kibana, Splunk) with bounded query budgets and zero bulk extraction, mail, messaging, and broker assessment (SMTP, POP3, IMAP, IRC, RabbitMQ, NATS, IBM MQ, Kafka, MQTT) with bounded message budgets and zero mass outbound relaying, developer and runtime interfaces assessment (Docker API, Docker Registry, Java RMI, JDWP, Erlang EPMD, ADB, distcc, SVN, AJP, FastCGI), nine legacy enterprise, management, VPN, and proxy offline fixture models (NDMP, iSCSI, IPMI 2.0, Cisco Smart Install, TACACS+, IKEv1, PPTP, SOCKS, Squid), with socket reachability reported as unconfirmed and no live proxy egress, canary, cleanup, or privilege validation.
  • Boundaries: Strictly an authorized planning and scoping tool; operates offline or within bounded authorized parameters without executing uncoordinated exploits.
  • Playbook: plugins/offensive-security/attack-surface-planner/docs/PLAYBOOK.md
  • Verification: End-to-end playbook

Kubernetes Assessment Workbench

  • Maturity: Experimental | Operational Mode: import
  • When to use: Before planning a Kubernetes assessment, compare an explicitly approved context, namespaces, and surfaces with a sanitized local observation.
  • Key Capabilities: Exact context tuple checks, local Namespace name and UID anchor comparison, namespace access and environment fact reporting.
  • Boundaries: Reads a local JSON record only. Matching local assertions do not establish live cluster identity or readiness; missing or denied access stays visible, and the report never grants execution.
  • Playbook: plugins/offensive-security/kubernetes-assessment-workbench/README.md
  • Verification: End-to-end playbook

Offensive Engagement Workbench

  • Maturity: Experimental | Operational Mode: planned
  • When to use: When intaking authorized adversary engagements, enforcing target scope and boundary exclusions, compiling immutable action plans, orchestrating Triad specialist handoffs, and managing scenario laboratory environments.
  • Key Capabilities: Scope intake validation, CIDR collision checks, immutable action plan generation, Triad specialist handoffs, capability verification, scenario laboratory environment verification, reproducible reset, and controlled case execution.
  • Boundaries: Scoping, planning, and isolated laboratory execution only; refuses incomplete live requests and does not execute network payloads outside verified lab boundaries.
  • Playbook: plugins/offensive-security/offensive-engagement-workbench/docs/PLAYBOOK.md
  • Verification: End-to-end playbook

Host Assessment Workbench

  • Maturity: Experimental | Operational Mode: import
  • When to use: When reviewing a bounded local export of Linux host configuration, prerequisite context, coverage, and canary outcomes.
  • Key Capabilities: Strict versioned import, eight privilege-boundary surfaces, prerequisite selection, and distinct configuration versus reported-canary classifications.
  • Boundaries: No host collection or execution; imported canary assertions are not independent proof of privilege crossing or cleanup.
  • Playbook: plugins/offensive-security/host-assessment-workbench/README.md
  • Verification: End-to-end playbook

Foundry Agent Harness

  • Maturity: Beta | Operational Mode: laboratory
  • When to use: When rehearsing how an independent authorization gate handles synthetic agent tool proposals from untrusted content.
  • Key Capabilities: Versioned local agent and MCP fixture cases, observed gate denials and mock effects, paired permissive and strict controls.
  • Boundaries: No hosted model, deployed agent, or live MCP integration. Fixture subprocesses are not an operating-system network sandbox.
  • Playbook: plugins/offensive-security/foundry-agent-harness/docs/PLAYBOOK.md
  • Verification: End-to-end playbook

6. Incident Response

Incident Response Sandbox

  • Maturity: Experimental | Operational Mode: laboratory
  • When to use: When preparing an incident response containment plan and needing to rehearse actions, calculate blast radius (e.g. affected dependent services), and obtain interactive operator sign-off with cryptographic receipts.
  • Key Capabilities: Blast radius calculation, approval-gated containment rehearsal, cryptographic execution receipts.
  • Boundaries: Approval-gated rehearsal only; does not execute destructive actions on live infrastructure.
  • Playbook: plugins/incident-response/incident-response-sandbox/skills/incident-response-sandbox/SKILL.md
  • Verification: End-to-end playbook

Operational Readiness Modes & Truth-in-Advertising

To maintain absolute integrity and avoid capability over-claiming, COPS reconciles all capabilities into four explicit operational readiness modes:

  • planned: Specification, routing persona, or scoping defined; no autonomous runtime execution.
  • import: Offline static file, code AST, git diff, or export manifest ingestion only; zero live service mutation.
  • laboratory: Controlled offline simulation, synthetic event replay, or sandbox rehearsal; zero external egress.
  • live-validated: Fully authorized, live-tested execution path against an authorized environment with cryptographic evidence receipt. Currently 0 capabilities claim live-validated, ensuring zero false claims.

To audit all 75 capabilities across plugins, specialist profiles, and scenarios:

python3 -m cops capabilities audit --check
python3 -m cops capabilities list