Skip to main content

Use Huntbase Hub hunts in Vertex Synapse

The Huntbase Hub publishes reviewed, open threat hunts. A Storm package, huntbase-hub, writes each of them into your Synapse Cortex as a procedure you can pivot from: its steps, its queries, the ATT&CK techniques and CVEs it covers, and the research it came from. You can then link the hunts to your own intelligence, such as the threats and techniques your analysts already track.

This works in your Cortex on its own. It doesn't need a Huntbase account or a Vertex Synapse connection, and Huntbase doesn't write to your Cortex. The package reads the Hub; your Cortex does the writing.

Install the package​

Run this in Storm as an admin, or as a user who can add packages and write to the view. The Cortex needs to reach hub.huntbase.io over HTTPS.

pkg.load https://hub.huntbase.io/synapse/huntbase-hub.json

Run the same line again to update the package. The package isn't code-signed, so leave out --verify.

The package needs Synapse 3.x.

Sync the hunts​

huntbase.hub.sync

The first run pulls every hunt, which takes a few minutes. Each run after that pulls only the hunts published or changed since the last one: the package follows each hunt's updated time on the Hub and keeps its place in the :ingest:latest property of the Hub's meta:source node. Running it twice does no harm. Every node has a fixed identity derived from the hunt and step, so a changed hunt is updated in place rather than copied.

Hunts are written to the current view.

OptionWhat it does
--size 10Stop after ten hunts, oldest first. The next run carries on from there.
--allIgnore where the last run stopped and pull every hunt again.
--urlRead a different copy of the Hub. Defaults to https://hub.huntbase.io.

Take one hunt​

To take one hunt, give its slug, the last part of its address on the Hub:

huntbase.hub.import activemq-lateral-movement-lockbit

You can give several slugs at once. The command yields the procedures it wrote.

Keep it up to date​

New hunts are published on the Hub once a day. A cron job keeps your Cortex in step. Once a day:

cron.add --name "Huntbase Hub sync" daily@10:30 { huntbase.hub.sync }

Or every hour, at quarter past:

cron.add --name "Huntbase Hub sync" hourly@:15 { huntbase.hub.sync }

A sync with nothing new finishes quickly, so the hourly job costs little. Cron jobs run in UTC, as the user who created them. Use cron.list to check the job and cron.del to remove it.

What lands in the graph​

Each hunt becomes a plan:procedure. Its hunt.md source is kept in full on :body.

On the HubIn Synapse
Huntplan:procedure, with :id set to the slug, :title, :desc set to the hypothesis, :url set to its page on the Hub and :system set to the hunt.md format
Each stepplan:procedure:step, with :title and :desc, tagged #rep.huntbase.step.<type>. The hypothesis is the procedure's :firststep
Order of steps and decision branchesplan:procedure:link on the parent step's :links. A branch taken when the evidence supports the hypothesis has :condition=true, the other false
Query stepmeta:rule holding the query text in :text, with :type set to huntbase.query.<language>. The step -(uses)> the rule
Parametersplan:procedure:variable nodes in the procedure's :inputs
ATT&CK techniquesmeta:technique, linked from the procedure with -(refs)>
CVEsrisk:vuln, linked with -(refs)>
The research it came fromdoc:report, linked with -(refs)>
Severity, TLP, tactics, products, seriesTags under #rep.huntbase on the procedure, such as #rep.huntbase.severity.high
The Hub itselfmeta:source named huntbase hub, which -(seen)> every procedure

Every hunt also carries #rep.huntbase.hunt. The Hub's index entry and the hunt's native definition are stored as node data on each procedure, under huntbase:hub:entry and huntbase:hub:definition.

Example queries​

Critical hunts:

plan:procedure#rep.huntbase.severity.critical

Hunts that cover a technique:

meta:technique:id=T1021.001 <(refs)- plan:procedure

The queries in one hunt:

plan:procedure:id=activemq-lateral-movement-lockbit -> plan:procedure:step -(uses)> meta:rule

The CVEs the hunts cover:

plan:procedure#rep.huntbase.hunt -(refs)> risk:vuln | uniq

With a Vertex Synapse connection, the Huntbase Hub hunts in Synapse query template lists the hunts in your Cortex for a technique, from Huntbase.

Run the hunts in Huntbase​

In Synapse the hunts are knowledge you can link to your own intelligence. To run one against your data, open it on the Hub and click Run hunt: it opens in your Huntbase Library as a playbook. See Import a hunt from the Huntbase Hub.

Next steps​