Admin Guide

Synapse-Mandiant Admin Guide

Configuration

Synapse-Mandiant requires a Mandiant Advantage API key ID and secret. For information on how to sign up, please visit the Mandiant Advantage API documentation.

Setting API key for global use

To set-up a global API key:

> mandiant.advantage.config.add default mykeyid myapisecret
Synapse-Mandiant config "default" added

Creating a configuration for role-based use

Add an unscoped configuration:

> mandiant.advantage.config.add myunscoped mykeyid myapisecret --scope unscoped
Synapse-Mandiant config "myunscoped" added

Grant another user admin permissions to the new configuration:

> mandiant.advantage.config.update myunscoped --perm user visi admin
Updated Synapse-Mandiant config "myunscoped"

Grant a role read permissions to the new configuration:

> mandiant.advantage.config.update myunscoped --perm role ninjas read
Updated Synapse-Mandiant config "myunscoped"

Users may select a configuration other than their default by passing --config <name> to the Synapse-Mandiant commands.

Setting the tag prefix

The tag prefix used when recording Mandiant Advantage tags defaults to rep.mandiant. It may be set per configuration using the --tag-prefix option to mandiant.advantage.config.add or mandiant.advantage.config.update, or for all configurations using mandiant.advantage.config.migrate:

> mandiant.advantage.config.migrate --tag-prefix my.tagpref
Updated Synapse-Mandiant config "synapse-mandiant:myunscoped"

Overriding the proxy configuration

In order to override the default proxy configuration in the Cortex the user must have the power-ups.mandiant.advantage.admin or storm.lib.inet.http.proxy permission.

When the proxy configuration is set to (false) or a URL the permission will be checked when a configuration is created/updated, and when it is used to make an HTTP request.

Dependencies

Synapse-Mandiant requires the following Power-Ups to be installed:

Name   : synapse-fileparser
Version: >=4.13.1,<5.0.0
Desc   : Synapse-FileParser is used to parse report PDFs and link extracted indicators to the media:news node.

Permissions

Package (synapse-mandiant) defines the following permissions:
power-ups.mandiant.advantage.user : Allows a user to issue queries to the Mandiant Advantage API. ( default: false )
power-ups.mandiant.advantage.admin : Controls access to Synapse-Mandiant admin options. ( default: false )

You may add rules to users/roles directly from storm:

> auth.user.addrule visi power-ups.mandiant.advantage.user
Added rule power-ups.mandiant.advantage.user to user visi.

or:

> auth.role.addrule ninjas power-ups.mandiant.advantage.user
Added rule power-ups.mandiant.advantage.user to role ninjas.

Exported APIs

Synapse-Mandiant does not currently export any APIs.

Workflows

Synapse-Mandiant provides the following workflows in Optic:

Title: Configuration

The Configuration workflow may be used to manage Synapse-Mandiant configurations from Optic.

Node Actions

Synapse-Mandiant provides the following node actions in Optic:

Name : actors
Desc : Ingest threat actor details from the Mandiant Advantage API.
Forms: ou:name, ou:org, risk:threat

Name : indicators
Desc : Ingest indicator details from the Mandiant Advantage API.
Forms: inet:ipv4, inet:ipv6, inet:fqdn, hash:sha256, hash:sha1, hash:md5, file:bytes, inet:email, inet:url

Name : malware
Desc : Ingest malware family details from the Mandiant Advantage API.
Forms: risk:tool:software, it:prod:softname

Name : vulns
Desc : Ingest vulnerability details from the Mandiant Advantage API.
Forms: risk:vuln, it:sec:cve

Ingesting CPE strings

The Mandiant Advantage API may sometimes return invalid CPE strings. Invalid CPE strings will be rejected by Synapse when attempting to ingest the API data. As a workaround, the Synapse-Mandiant Power-Up peforms the following transformations on CPE strings before attempting to ingest them:

Replace \- with -. Dashes (hyphens) should not be escaped according to the CPE 2.3 specification.

Synapse v2.187.0 migration

Synapse v2.187.0 added a model migration (v0.2.31) that removed all invalid it:sec:cpe nodes from the Cortex. The Synapse-Mandiant init migration uses the above transformations to attempt to automatically repair and restore invalid it:sec:cpe nodes that originated from the Synapse-Mandiant Power-Up.