Mandiant Advantage collector

[ 1 Overview ] [ 2 Devo collector features ] [ 3 Data sources ] [ 4 Minimum configuration required for basic pulling ] [ 5 Accepted authentication methods ] [ 6 Run the collector ] [ 7 Collector services detail ] [ 8 Collector operations ] [ 9 Change log ]

Overview

Mandiant takes an intelligence-led, multi-vendor approach to XDR, enhancing existing security controls and enabling the SOC to improve efficiency and efficacy in finding malicious security incidents quickly and at scale.

The Mandiant Advantage collector allows users to ingest alerts and create lookups based on Mandiant threat intelligence.

Devo collector features

Feature	Details

Feature	Details
Allow parallel downloading (`multipod`)	`not allowed`
Running environments	`collector server` `on-premise`
Populated Devo events	`table` `lookups`
Flattening preprocessing	`no`
Allowed source events obfuscation	`yes`

Data sources

Data source	Description	API endpoint	Collector service name	Devo table	Available from release

Data source

Description

API endpoint

Collector service name

Devo table

Available from release

Mandiant Advantage Digital Threat Monitoring

DTM Alerts

/v4/dtm/alerts

dtm_alert

xdr.mandiant.threatintel.dtm_alert

v0.0

Mandiant Threat Intelligence

Indicators

/v4/indicator

indicator

N/A

v0.0

For more information on how the events are parsed, visit our page.

Minimum configuration required for basic pulling

Although this collector supports advanced configuration, the fields required to retrieve data with basic configuration are defined below.

This minimum configuration refers exclusively to those specific parameters of this integration. There are more required parameters related to the generic behavior of the collector. Check setting sections for details.

Setting	Details

Setting	Details
`api_key_public`	The Mandiant public API key
`api_key_secret`	The Mandiant secret API key

See the Accepted authentication methods section to verify what settings are required based on the desired authentication method.

Accepted authentication methods

Authentication method	API key public / secret
API key	Required

Run the collector

Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector).

Collector services detail

This section is intended to explain how to proceed with specific actions for services.

Events service

dtm_alert

Internal process and deduplication method

All Mandiant Advantage DTM alert records are continuously pulled subject to the last_updated timestamp property.. A unique hash value is computed for each event and used for deduplication purposes to ensure events are not fetched multiple times in subsequent pulls.

Devo categorization and destination

All events of this service are ingested into the table xdr.mandiant.threatintel.dtm_alert

Setup output

A successful run has the following output messages for the setup module:

2023-08-30T00:07:08.594    INFO InputProcess::MainThread -> AdvantagePullerSetup(unknown,mandiant_advantage#10001,indicator#predefined) -> Starting thread
2023-08-30T00:07:08.595    INFO InputProcess::MainThread -> IndicatorPuller(mandiant_advantage,10001,indicator,predefined) - Starting thread
InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Waiting until setup will be executed
2023-08-30T00:07:08.595 WARNING InputProcess::AdvantagePullerSetup(unknown,mandiant_advantage#10001,indicator#predefined) -> The token/header/authentication has not been created yet
InputProcess::AdvantagePullerSetup(unknown,mandiant_advantage#10001,indicator#predefined) -> Testing fetch from /v4/indicator
2023-08-30T00:07:09.188    INFO InputProcess::AdvantagePullerSetup(unknown,mandiant_advantage#10001,indicator#predefined) -> Successfully tested fetch from /v4/indicator. Source is pullable.
2023-08-30T00:07:09.189    INFO InputProcess::AdvantagePullerSetup(unknown,mandiant_advantage#10001,indicator#predefined) -> Setup for module <IndicatorPuller> has been successfully executed

Puller output

2023-09-16T22:04:48.698    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> IndicatorPuller(mandiant_advantage,10001,indicator,predefined) Starting the execution of pre_pull()
2023-09-16T22:04:48.698    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Reading persisted data
2023-09-16T22:04:48.698    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Data retrieved from the persistence: {'@persistence_version': 1, 'start_time_in_utc': '2023-08-25T00:00:00Z', 'last_event_time_in_utc': '2023-08-25T00:00:00Z', 'last_ids': [], 'next_page': None, 'lookups_created': [], 'base_lookup_name': 'mandiant_threat_intelligence', 'params_gte_mscore': 90}
2023-09-16T22:04:48.699    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Running the persistence upgrade steps
2023-09-16T22:04:48.699    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Running the persistence corrections steps
2023-09-16T22:04:48.699    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Running the persistence corrections steps
2023-09-16T22:04:48.699 WARNING InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> The persistence version value is <ZERO>, so no persistence will be allocated
2023-09-16T22:04:48.699    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> IndicatorPuller(mandiant_advantage,10001,indicator,predefined) Finalizing the execution of pre_pull()
2023-09-16T22:04:48.699    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Starting data collection every 86400 seconds
2023-09-16T22:04:48.699    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Pull Started
2023-09-16T22:04:48.701    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Fetching indicator records from /v4/indicator subject to params={'start_epoch': 1694829888, 'end_epoch': 1694916288, 'limit': 1000, 'gte_mscore': 80, 'include_campaigns': True, 'include_reports': True, 'exclude_osint': False, 'last_seen': 'asc'}
2023-09-16T22:04:49.686    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Received 1000 indicator record(s) from /v4/indicator.
2023-09-16T22:04:49.726    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Upserting data from 102 record(s) and sending to Devo lookup mandiant_threat_intelligence_ipv4
2023-09-16T22:04:49.737    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Lookup mandiant_threat_intelligence_ipv4 creation not yet started. Instantiating factory...
2023-09-16T22:04:49.746    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Upserting data from 148 record(s) and sending to Devo lookup mandiant_threat_intelligence_fqdn
2023-09-16T22:04:49.760    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Lookup mandiant_threat_intelligence_fqdn creation not yet started. Instantiating factory...
2023-09-16T22:04:49.772    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Upserting data from 292 record(s) and sending to Devo lookup mandiant_threat_intelligence_url
2023-09-16T22:04:49.801    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Lookup mandiant_threat_intelligence_url creation not yet started. Instantiating factory...
2023-09-16T22:04:49.824    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Upserting data from 458 record(s) and sending to Devo lookup mandiant_threat_intelligence_md5
2023-09-16T22:04:49.826    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Lookup mandiant_threat_intelligence_md5 creation not yet started. Instantiating factory...
2023-09-16T22:04:49.902    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1694916288698):Number of requests made: 1; Number of events received: 1000; Number of duplicated events filtered out: 0; Number of events generated and sent: 1000; Average of events per second: 831.756.
...
2023-09-16T22:05:00.963    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Received 0 indicator record(s) from /v4/indicator.
2023-09-16T22:05:00.963    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Reached the last page of results for /v4/indicator. Flushing lookup jobs and setting pull_completed to True.
2023-09-16T22:05:00.964    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Flushing and closing pre-existing lookup jobs
2023-09-16T22:05:00.964    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Flushing mandiant_threat_intelligence_ipv4 lookup job and closing buffer
2023-09-16T22:05:00.964    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Flushing mandiant_threat_intelligence_fqdn lookup job and closing buffer
2023-09-16T22:05:00.964    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Flushing mandiant_threat_intelligence_url lookup job and closing buffer
2023-09-16T22:05:00.965    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Flushing mandiant_threat_intelligence_md5 lookup job and closing buffer
2023-09-16T22:05:00.965    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1694916288698):Number of requests made: 19; Number of events received: 17029; Number of duplicated events filtered out: 0; Number of events generated and sent: 17029; Average of events per second: 1388.361.
2023-09-16T22:05:00.965    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1694916288698):Number of requests made: 19; Number of events received: 17029; Number of duplicated events filtered out: 0; Number of events generated and sent: 17029; Average of events per second: 1388.337.
2023-09-16T22:05:00.965    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> The data is up to date!

After a successful collector’s execution (that is, no error logs found), you will see the following log message:

2023-09-16T22:05:00.966    INFO InputProcess::IndicatorPuller(mandiant_advantage,10001,indicator,predefined) -> Data collection completed. Elapsed time: 12.268 seconds. Waiting for 86387.732 second(s) until the next one

This collector is snapshot based (all events are fetched on each pull) and thus does not facilitate persistence management. To send data to a new lookup table, you only need to change the override lookup base table name in the user config; the new tables will be created on the next pull.

This collector has different security layers that detect both an invalid configuration and abnormal operation. This table will help you detect and resolve the most common errors.

Common logic

Error type	Error ID	Error message	Cause	Solution
InitVariablesError	1	Invalid `start_time_in_utc: {ini_start_str}`. Must be in parseable datetime format.	The configured `start_time_in_utc` parameter is a non-parseable format.	Update the `start_time_in_utc` value to have the recommended format as indicated in the guide.
InitVariablesError	2	Invalid `start_time_in_utc: {ini_start_str}`. Must be in the past.	The configured `start_time_in_utc` parameter is a future date.	Update the `start_time_in_utc` value to a past datetime.
SetupError	101	Failed to fetch OAuth token from `{token_endpoint}`. Exception: `{e}`.	The provided credentials, base URL, and/or token endpoint is incorrect.	Revisit the configuration steps and ensure that the correct values were specified in the config file.
SetupError	102	Failed to fetch data from `{endpoint}`. Source is not pullable.	The provided credentials, base URL, and/or token endpoint is incorrect.	Revisit the configuration steps and ensure that the correct values were specified in the config file.

Custom troubleshooting for indicator service

The following errors are related to a specific service.

Error type	Error ID	Error message	Cause	Solution

Error type	Error ID	Error message	Cause	Solution
LookupJobError	500	Couldn't send the `lookup_message` of the table `{lookup_name}` cause `{rejected}` number of rows have been rejected.	The Devo Lookups’ service is having issues processing your request.	Contact Devo support to check the status of the service.
LookupJobError	501	Detected `{duplicate_count}` duplicate key(s) `({key})` in the lookup data: `{duplicate_key_str}`.	The server returned entries with similar `value` properties for multiple indicators of the same type.	Contact Devo support.

Collector operations

This section is intended to explain how to proceed with specific operations of this collector.

Initialization

The initialization module is in charge of setup and running the input (pulling logic) and output (delivering logic) services and validating the given configuration.

A successful run has the following output messages for the initializer module:

Events delivery and Devo ingestion

The event delivery module is in charge of receiving the events from the internal queues where all events are injected by the pullers and delivering them using the selected compatible delivery method.

A successful run has the following output messages for the initializer module:

Sender services

The Integrations Factory Collector SDK has 3 different senders services depending on the event type to delivery (internal, standard, and lookup). This collector uses the following Sender Services:

Sender services	Description

Sender services	Description
`internal_senders`	In charge of delivering internal metrics to Devo such as logging traces or metrics.
`standard_senders`	In charge of delivering pulled events to Devo.

Sender statistics

Each service displays its own performance statistics that allow checking how many events have been delivered to Devo by type:

Logging trace	Description

Logging trace

Description

Number of available senders: 1

Displays the number of concurrent senders available for the given Sender Service.

sender manager internal queue size: 0

Displays the items available in the internal sender queue.

Total number of messages sent: 57, messages sent since "2023-01-10 16:09:16.116750+00:00": 0 (elapsed 0.000 seconds

Displays the number of events from the last time and following the given example, the following conclusions can be obtained:

44 events were sent to Devo since the collector started.
The last checkpoint timestamp was 2023-01-10 16:09:16.116750+00:00.
21 events where sent to Devo between the last UTC checkpoint and now.
Those 21 events required 0.007 seconds to be delivered.

To check the memory usage of this collector, look for the following log records in the collector which are displayed every 5 minutes by default, always after running the memory-free process.

The used memory is displayed by running processes and the sum of both values will give the total used memory for the collector.
The global pressure of the available memory is displayed in the global value.
All metrics (Global, RSS, VMS) include the value before freeing and after previous -> after freeing memory

Differences between RSS and VMS memory usage:

RSS is the Resident Set Size, which is the actual physical memory the process is using
VMS is the Virtual Memory Size which is the virtual memory that process is using

Change log

Release	Released on	Release type	Details	Recommendations

Release	Released on	Release type	Details	Recommendations
`v1.0.0`	Sep 25, 2023	INITIAL VERSION	New collector	`Recommended version`