f3nris
45e9cbd269
467 of the 1592 commands carried no `risk:`. An unset risk is read as
destructive by the agent approval gate, so half the catalog's write side sat
behind the same prompt — and, in HarfangLab's case, 39 pure lookups did too.
A gate that stops everything stops being read as a signal, which is the
argument already made for the toolkit and for sentinelone (df27876).
The catalog is now 1027 read, 261 safe_write, 304 destructive, with nothing
defaulted. The line follows the one sentinelone drew: impact on the estate,
not reversibility — isolate-agent is reversible and is the canonical
destructive example.
read only queries; changes nothing outside Riposte
safe_write additive or reversible inside the tool's own case/enrichment
plane: comments, tickets, tags, alert statuses, threat-intel
records, sandbox submissions, collection jobs, outbound messages
destructive changes the estate or weakens a control: containment, blocklists
and allowlists, exclusions and detection rules, every delete,
identity and credential operations, code on a host, generic
API escape hatches
Three calls that were not obvious, and are now applied throughout:
- Undoing a containment is tiered like the containment it lifts. Un-isolating
a host or un-banning an IP mid-incident is its own decision, not a return to
a neutral state. The catalog contradicted itself here — crowdstrike's
lift_containment was destructive while harfanglab's deisolate_from_threat
was safe_write — so deisolate_from_threat and unquarantine_file are
re-tiered to destructive, the only two existing tiers this pass changes.
- Retrieving a live secret is destructive: cyberark get_password, delinea
get_secret, vault read_secret, beyondtrust get_credential. It is a GET, but
the tier describes the stake, not the HTTP verb.
- Sending outward to humans stays safe_write — slack, teams, twilio, telegram,
mail. Irreversible, but it is the collaboration plane, not the estate.
An object created but not yet referenced by a rule is safe_write; editing one
a rule already reads is destructive. That is why fortigate create_address and
panos create_custom_url_category are safe_write while update_address_group and
edit_custom_url_category are not.
The template and README never documented the field, which is how 467 commands
came to omit it. Both now carry the tier table and these rules, so the next
integration declares a tier instead of inheriting one.
111 packages get a MINOR bump and a changelog entry: an instance compares
versions to offer an update, so an unbumped manifest would leave the tiers
sitting in the catalog and never reaching the estates that need them.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
85 lines
3.5 KiB
YAML
85 lines
3.5 KiB
YAML
id: hybrid_analysis
|
|
name: Hybrid Analysis
|
|
version: 1.1.0
|
|
description: "Hybrid Analysis / CrowdStrike Falcon Sandbox (API v2) — detonate files and URLs, poll analysis state, retrieve report summaries, search by hash, and list sandbox environments. API-key authentication; stdlib-only, no extra Python dependencies."
|
|
changelog: "1.1.0 — Declare the risk tier on the 2 commands that carried none: 2 safe_write. An unset risk is read as destructive by the agent approval gate, so the 2 that only annotate sat behind the same prompt as the ones that change the estate. | 1.0.0 — Initial release: file/URL submission, report summary and state, hash search and environment listing."
|
|
category: enrichment
|
|
|
|
# The API key is sent in the 'api-key' header; Hybrid Analysis also requires a
|
|
# 'User-Agent: Falcon Sandbox' header (the scripts set it).
|
|
config_schema:
|
|
properties:
|
|
api_key:
|
|
type: string
|
|
description: "Hybrid Analysis API key"
|
|
x-soar-sensitive: true
|
|
required:
|
|
- api_key
|
|
|
|
commands:
|
|
- id: submit_file
|
|
name: hybrid-analysis-submit-file
|
|
description: "Submit a file (base64) for analysis in a sandbox environment. Returns a job/sha256; poll with hybrid-analysis-get-state."
|
|
risk: safe_write
|
|
inputs_schema:
|
|
properties:
|
|
file_name: { type: string, description: "File name" }
|
|
content_base64: { type: string, description: "File content, base64-encoded" }
|
|
environment_id: { type: number, description: "Sandbox environment ID (see hybrid-analysis-get-environments)" }
|
|
required: [file_name, content_base64, environment_id]
|
|
outputs_schema: { properties: {} }
|
|
- id: submit_url
|
|
name: hybrid-analysis-submit-url
|
|
description: "Submit a URL for analysis in a sandbox environment."
|
|
risk: safe_write
|
|
inputs_schema:
|
|
properties:
|
|
url: { type: string, description: "URL to detonate" }
|
|
environment_id: { type: number, description: "Sandbox environment ID" }
|
|
required: [url, environment_id]
|
|
outputs_schema: { properties: {} }
|
|
- id: get_result
|
|
name: hybrid-analysis-get-result
|
|
description: "Get the analysis report summary (verdict, threat score, signatures) by job/sha256 ID."
|
|
risk: read
|
|
inputs_schema:
|
|
properties:
|
|
job_id: { type: string, description: "Job ID or sha256:environment_id identifier" }
|
|
required: [job_id]
|
|
outputs_schema: { properties: {} }
|
|
- id: get_state
|
|
name: hybrid-analysis-get-state
|
|
description: "Get the current state of an analysis (IN_QUEUE, IN_PROGRESS, SUCCESS, ERROR)."
|
|
risk: read
|
|
inputs_schema:
|
|
properties:
|
|
job_id: { type: string, description: "Job ID or sha256:environment_id identifier" }
|
|
required: [job_id]
|
|
outputs_schema: { properties: {} }
|
|
- id: search_hash
|
|
name: hybrid-analysis-search-hash
|
|
description: "Look up existing analyses for a file hash (MD5, SHA1 or SHA256)."
|
|
risk: read
|
|
inputs_schema:
|
|
properties:
|
|
hash: { type: string, description: "File hash" }
|
|
required: [hash]
|
|
outputs_schema: { properties: {} }
|
|
- id: get_environments
|
|
name: hybrid-analysis-get-environments
|
|
description: "List the available sandbox environments and their IDs."
|
|
risk: read
|
|
inputs_schema:
|
|
properties: {}
|
|
required: []
|
|
outputs_schema: { properties: {} }
|
|
|
|
- id: test_connection
|
|
name: hybrid-analysis-test-connection
|
|
description: "Verify the API key (used by the Test button)."
|
|
risk: read
|
|
inputs_schema:
|
|
properties: {}
|
|
required: []
|
|
outputs_schema: { properties: {} }
|