Files
riposte-marketplace/integrations/vault/manifest.yaml
T
f3nris 45e9cbd269 feat: declare a risk tier on every command in the catalog
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>
2026-09-08 12:55:20 +02:00

94 lines
3.3 KiB
YAML

id: vault
name: HashiCorp Vault
version: 1.1.0
description: "HashiCorp Vault (KV v2 + sys API) — secrets management for playbooks: read, write, delete and list secrets, list mounts, and look up the current token. Vault-token authentication; stdlib-only, no extra Python dependencies."
changelog: "1.1.0 — Declare the risk tier on the 3 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: read/write/delete/list secrets, list mounts, lookup token."
category: cloud
# Per-instance configuration. The token is sent as the 'X-Vault-Token' header.
# kv_mount is the KV v2 mount point used by the secret commands.
config_schema:
properties:
base_url:
type: string
description: "Vault URL (e.g. https://vault.example.com:8200)"
token:
type: string
description: "Vault token"
x-soar-sensitive: true
kv_mount:
type: string
description: "KV v2 mount point (default 'secret')"
default: "secret"
insecure:
type: boolean
description: "Trust any TLS certificate (not secure)"
default: false
required:
- base_url
- token
commands:
- id: read_secret
name: vault-read-secret
description: "Read a secret from the KV v2 store."
risk: destructive
inputs_schema:
properties:
path: { type: string, description: "Secret path within the KV mount (e.g. app/db)" }
required: [path]
outputs_schema: { properties: {} }
- id: write_secret
name: vault-write-secret
description: "Write (create/update) a secret in the KV v2 store."
risk: destructive
inputs_schema:
properties:
path: { type: string, description: "Secret path" }
data_json: { type: string, description: "Secret key/values as a JSON object" }
required: [path, data_json]
outputs_schema: { properties: {} }
- id: delete_secret
name: vault-delete-secret
description: "Delete a secret (all versions/metadata) from the KV v2 store."
risk: destructive
inputs_schema:
properties:
path: { type: string, description: "Secret path" }
required: [path]
outputs_schema: { properties: {} }
- id: list_secrets
name: vault-list-secrets
description: "List secret keys under a path."
risk: read
inputs_schema:
properties:
path: { type: string, description: "Path to list (empty for the mount root)" }
required: []
outputs_schema: { properties: {} }
- id: list_mounts
name: vault-list-mounts
description: "List secret engine mounts."
risk: read
inputs_schema:
properties: {}
required: []
outputs_schema: { properties: {} }
- id: lookup_token
name: vault-lookup-token
description: "Look up the current token's metadata and policies."
risk: read
inputs_schema:
properties: {}
required: []
outputs_schema: { properties: {} }
- id: test_connection
name: vault-test-connection
description: "Verify connectivity and the token (used by the Test button)."
risk: read
inputs_schema:
properties: {}
required: []
outputs_schema: { properties: {} }