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>
65 lines
2.9 KiB
YAML
65 lines
2.9 KiB
YAML
id: cisco_umbrella_enforcement
|
|
name: Cisco Umbrella Enforcement
|
|
version: 1.1.0
|
|
description: "Cisco Umbrella Enforcement API — DNS-layer containment: push malicious domains to the enforcement block list, list enforced domains, and remove them. Customer-key authentication; stdlib-only, no extra Python dependencies."
|
|
changelog: "1.1.0 — Declare the risk tier on the 2 commands that carried none, all of them destructive. An unset risk was already gated as destructive, so the approval prompt does not move; what changes is that the tier is a stated decision rather than a default, and a command added later cannot inherit it by omission. | 1.0.0 — Initial release: add domain event (block), list domains, delete domain."
|
|
category: network
|
|
|
|
# Per-instance configuration. The customer key is appended as the 'customerKey'
|
|
# query parameter on every request.
|
|
config_schema:
|
|
properties:
|
|
api_url:
|
|
type: string
|
|
description: "Enforcement API base URL"
|
|
default: "https://s-platform.api.opendns.com"
|
|
api_key:
|
|
type: string
|
|
description: "Umbrella Enforcement customer key"
|
|
x-soar-sensitive: true
|
|
required:
|
|
- api_key
|
|
|
|
commands:
|
|
- id: add_domain
|
|
name: umbrella-add-domain
|
|
description: "Submit a security event that adds a domain to the Umbrella enforcement block list."
|
|
risk: destructive
|
|
inputs_schema:
|
|
properties:
|
|
domain: { type: string, description: "Domain to block (e.g. malicious.example.com)" }
|
|
url: { type: string, description: "Destination URL (defaults to http://<domain>/)" }
|
|
device_id: { type: string, description: "Reporting device id (defaults to a fixed Riposte device id)" }
|
|
device_version: { type: string, description: "Reporting device version (default 1.0)" }
|
|
provider_name: { type: string, description: "Provider name (default 'Riposte SOAR')" }
|
|
required: [domain]
|
|
outputs_schema: { properties: {} }
|
|
- id: list_domains
|
|
name: umbrella-list-domains
|
|
description: "List the domains currently in the enforcement block list."
|
|
risk: read
|
|
inputs_schema:
|
|
properties:
|
|
page: { type: number, description: "Page number (default 1)" }
|
|
limit: { type: number, description: "Domains per page (default 200)" }
|
|
required: []
|
|
outputs_schema: { properties: {} }
|
|
- id: delete_domain
|
|
name: umbrella-delete-domain
|
|
description: "Remove a domain from the enforcement block list by its numeric id."
|
|
risk: destructive
|
|
inputs_schema:
|
|
properties:
|
|
domain_id: { type: string, description: "Numeric id of the domain to remove (from umbrella-list-domains)" }
|
|
required: [domain_id]
|
|
outputs_schema: { properties: {} }
|
|
|
|
- id: test_connection
|
|
name: umbrella-test-connection
|
|
description: "Verify connectivity and the customer key (used by the Test button)."
|
|
risk: read
|
|
inputs_schema:
|
|
properties: {}
|
|
required: []
|
|
outputs_schema: { properties: {} }
|