User Guide

Vertex-Triage User Guide

Vertex-Triage adds new Storm commands and Workflows to manage queues and tasks.

Getting Started

Check with your Admin to enable permissions.

Examples

Create a new queue

Queues can also be created via the dedicated workflow.

> vertex.triage.queue.add alerts --desc "A queue for work items relating to alerts"
proj:project=ba758ae5f5d05a0c40ed81cccd98be74
        .created = 2024/12/20 18:21:45.739
        :created = 2024/12/20 18:21:45.740
        :creator = root
        :desc = A queue for work items relating to alerts
        :name = alerts

Create a new task within the “alerts” queue that references a risk:alert node

Tasks can also be created from a Node Action in the Research Tool.

> risk:alert#newalerts | vertex.triage.task.add alerts "alert investigation" --assignee visi --yield
proj:ticket=a6303f814f7d5741d07c658fe2585f70
        .created = 2024/12/20 18:21:45.971
        :assignee = visi
        :created = 2024/12/20 18:21:45.962
        :creator = root
        :name = alert investigation
        :priority = medium
        :project = ba758ae5f5d05a0c40ed81cccd98be74
        :status = new
        :type = task
        :updated = 2024/12/20 18:21:45.962

Create a trigger to add a task when media:news:title is set and contains a keyword

This example creates a new task when :title contains the keyword malware, and adds it to the malware queue. The title is used to populate the task name.

> trigger.add prop:set --prop media:news:title
--query { +:title~=malware | vertex.triage.task.add malware `triage "{:title}"` }
Added trigger: de3c0369c5445989db06d65a6e66bf01

> [ media:news=* :title="an article about malware" ]
media:news=3bb7e957f766f5922a0dc9c41c4765b3
        .created = 2024/12/20 18:21:46.277
        :title = an article about malware

> proj:project:name=malware -> proj:ticket
proj:ticket=fa3a3bcd60ed1e8c1ec3d2d69899c3f6
        .created = 2024/12/20 18:21:46.471
        :created = 2024/12/20 18:21:46.459
        :creator = root
        :name = triage "an article about malware"
        :priority = medium
        :project = 72b19e32a65c01f349c8cd312c896a82
        :status = new
        :type = task
        :updated = 2024/12/20 18:21:46.459

The task will also have a reference to the inbound node.

> proj:project:name=malware -> proj:ticket -(refs)> *
media:news=3bb7e957f766f5922a0dc9c41c4765b3
        .created = 2024/12/20 18:21:46.277
        :title = an article about malware

Create a cron to check an external system and create a task based on the results

This example calls a placeholder module, and creates tasks in the extsys queue. A similar ingest routine could be written for calling an HTTP API.

> cron.add --hour +8 {
    $mod = $lib.import(somemodule)
    $data = $mod.getData()
    for $item in $data {
      vertex.triage.task.add extsys $item.name --desc $item.details
    }
  }
Created cron job: d3fb7a6d2289c7ce4ef19d1c9bc890f4

Use of meta:source nodes

Vertex-Triage uses a meta:source node and -(seen)> light weight edges to track created nodes.

> meta:source=62cbf38be08a5fc8933790a68c41d103
meta:source=62cbf38be08a5fc8933790a68c41d103
        .created = 2024/12/20 18:21:45.713
        :name = vertex-triage