id: cuckoo
name: Cuckoo Sandbox
version: 1.0.0
description: "Cuckoo Sandbox (REST API) — dynamic malware analysis: submit files and URLs for detonation, read task status and reports, list tasks, and delete a task. Optional token authentication; stdlib-only, no extra Python dependencies."
changelog: "1.0.0 — Initial release: submit file/URL, get task, get report, list tasks, delete task."
category: enrichment

# Per-instance configuration. If the Cuckoo API server requires a token it is
# sent as 'Authorization: Bearer <api_token>'.
config_schema:
  properties:
    base_url:
      type: string
      description: "Cuckoo API URL (e.g. http://cuckoo.example.com:8090)"
    api_token:
      type: string
      description: "API token (leave empty if the API server is unauthenticated)"
      x-soar-sensitive: true
    insecure:
      type: boolean
      description: "Trust any TLS certificate (not secure)"
      default: false
  required:
    - base_url

commands:
  - id: submit_file
    name: cuckoo-submit-file
    description: "Submit a file (base64) for analysis."
    inputs_schema:
      properties:
        file_name: { type: string, description: "File name" }
        content_base64: { type: string, description: "File content, base64-encoded" }
      required: [file_name, content_base64]
    outputs_schema: { properties: {} }
  - id: submit_url
    name: cuckoo-submit-url
    description: "Submit a URL for analysis."
    inputs_schema:
      properties:
        url: { type: string, description: "URL to detonate" }
      required: [url]
    outputs_schema: { properties: {} }
  - id: get_task
    name: cuckoo-get-task
    description: "Get a task's status and metadata."
    risk: read
    inputs_schema:
      properties:
        task_id: { type: string, description: "Task ID" }
      required: [task_id]
    outputs_schema: { properties: {} }
  - id: get_report
    name: cuckoo-get-report
    description: "Get a task's full analysis report (JSON)."
    risk: read
    inputs_schema:
      properties:
        task_id: { type: string, description: "Task ID" }
      required: [task_id]
    outputs_schema: { properties: {} }
  - id: list_tasks
    name: cuckoo-list-tasks
    description: "List recent tasks."
    risk: read
    inputs_schema:
      properties:
        limit: { type: number, description: "Max tasks (default 50)" }
      required: []
    outputs_schema: { properties: {} }
  - id: delete_task
    name: cuckoo-delete-task
    description: "Delete a task and its data."
    inputs_schema:
      properties:
        task_id: { type: string, description: "Task ID" }
      required: [task_id]
    outputs_schema: { properties: {} }

  - id: test_connection
    name: cuckoo-test-connection
    description: "Verify connectivity (used by the Test button)."
    risk: read
    inputs_schema:
      properties: {}
      required: []
    outputs_schema: { properties: {} }
