Page Comparison

...

To run this collector, there are some configurations detailed below that you need to consider.

Configuration	Details
Administrative access to the Trend Micro XDR portal.	You will need to have administrative access to the Trend Micro XDR portal in order to retrieve the data.
API key	Create an API key associated with an administrative user to authenticate the collector.

Info
Refer to the Vendor setup section to know more about these configurations.

...

Trend Micro Vision One is a purpose-built threat defense platform that provides added value and new benefits beyond XDR solutions, allowing you to see more and respond faster. Providing deep and broad extended detection and response (XDR) capabilities that collect and automatically correlate data across multiple security layers —email, endpoints, servers, cloud workloads, and networks— Trend Micro Vision One prevents the majority of attacks with automated protection.

Devo collector features

Feature	Details
Allow parallel downloading	`Not allowed`
Running environments	`Collector server` `On-premise`
Populated Devo events	`Table`
Flattening preprocessing	`Yes`

Data sources

Data source

Description

API endpoint

Collector service name

Devo table

Available from release

Audit logs

Audit log entries

/v3.0/audit/logs

audit

xdr.trend_micro.vision_one.audit

v1.0

Alerts

Displays information about workbench alerts (users can provide a TMV1-Filter to pull a subset)

/v3.0/workbench/al

alerts

xdr.trend_micro.vision_one.alerts

v1.0

Observed attack techniques (OATs)

Displays information about OATs (users can provide a TMV1-Filter to pull a subset)

/v3.0/oat/detections

observed_attack_techniques

xdr.trend_micro.vision_one.observed_attack_techniques

v1.0

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

Flattening preprocessing

Data source	Collector service	Optional	Flattening details
Alerts	alerts	`no`	-
Observed attack techniques	observed_attack_techniques	`no`	-

Anchor

	vendorsetup
	vendorsetup

...

Info
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
token	The token obtained from Trend Micro Vision One for authentication.

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

Accepted authentication methods

Authentication method

token

token

Status

colour	Green
title	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).

Rw ui tabs macro

Rw tab

title	On-premise collector

This data collector can be run in any machine that has the Docker service available because it should be executed as a docker container. The following sections explain how to prepare all the required setup for having the data collector running.

Structure

The following directory structure should be created for being used when running the collector:

Code Block

<any_directory>
└── devo-collectors/
    └── <product_name>/
        ├── certs/
        │   ├── chain.crt
        │   ├── <your_domain>.key
        │   └── <your_domain>.crt
        ├── state/
        └── config/ 
            └── config.yaml

Note
Replace `<product_name>` with the proper value.

Devo credentials

In Devo, go to Administration → Credentials → X.509 Certificates, download the Certificate, Private key and Chain CA and save them in <product_name>/certs/. Learn more about security credentials in Devo here.

Note
Replace `<product_name>` with the proper value.

Editing the config.yaml file

Code Block

globals:
  debug: <debug_status>
  id: <collector_id>
  name: <collector_name>
  persistence:
    type: filesystem
    config:
      directory_name: state
outputs:
  devo_us_1:
    type: devo_platform
    config:
      address: <devo_address>
      port: 443
      type: SSL
      chain: <chain_filename>
      cert: <cert_filename>
      key: <key_filename>
inputs:
  trend_micro_vision_one:
    id: <short_id>
    enabled: <input_status>
    credentials:
      token: <token_string>
    commons:
      base_url: <base_url>
    services:
      audit:
        tag: <tag>
        initial_start_time_in_utc: <initial_start_time_in_utc>
        tmv1_filter: <tmv1_filter_string>
      alerts:
        tag: <tag>
        initial_start_time_in_utc: <initial_start_time_in_utc>
        tmv1_filter: <tmv1_filter_string>
      observed_attack_techniques:
        tag: <tag>
        initial_start_time_in_utc: <initial_start_time_in_utc>
        tmv1_filter: <tmv1_filter_string>

Info
All defined service entities will be executed by the collector. If you do not want to run any of them, just remove the entity from the `services` object.

Replace the placeholders with your required values following the description table below:

Parameter	Data type	Type	Value range / Format	Details
`<debug_status>`	`bool`	`Mandatory`	`false` / `true`	This will make the collector generate (or not) log messages with the DEBUG level.
`collector_id`	`int`	`mandatory`	minimum length: 1 maximum length: 5	Use this parameter to give a unique ID to this collector.
`collector_name`	`str`	`mandatory`	minimum length: 1 maximum length: 10	Use this parameter to give a valid name to this collector.
`devo_address`	`str`	`mandatory`	`collector-us.devo.io` `collector-eu.devo.io`	Use this parameter to identify the Devo Cloud where the events will be sent.
`chain_filename`	`str`	`mandatory`	minimum length: 4 maximum length: 20	Use this parameter to identify the chain.cert file downloaded from your Devo domain. Usually this file's name is: `chain.crt`.
`cert_filename`	`str`	`mandatory`	minimum length: 4 maximum length: 20	Use this parameter to identify the file.cert downloaded from your Devo domain.
`key_filename`	`str`	`mandatory`	minimum length: 4 maximum length: 20	Use this parameter to identify the file.key downloaded from your Devo domain.
`short_id`	`int`	`mandatory`	minimum length: 1 maximum length: 5	Use this parameter to give a unique ID to this input service. This parameter is used to build the persistence address; do not use the same value for multiple collectors. It could cause a collision.
`input_status`	`bool`	`mandatory`	`true / false`	Use this parameter to enable or disable the given input logic when running the collector. If the value is `true`, the input will be run. If the value is `false`, it will be ignored.
`token_string`	`str`	`mandatory`		The token obtained from Trend Micro Vision One for authentication.
`base_url`	`str`	`optional`		Base URL for Trend Micro instance.
`initial_start_time_in_utc`	`str`	`optional`	UTC datetime string	This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (one month back for example) before downloading new events.
`tag`	`str`	`optional`	Devo tag-friendly string (no special characters, spaces, etc.)	An optional tag that allows users to override the service default tags.
`tmv1_filter`	`str`	`optional`	Please see API documentation on alerts and OATs (linked above) for information regarding the various fields and operators one may use for the respective TMV1-Filters.	Statement that allows you to retrieve a subset of the indicated service type events. Please refer to the API guide related to the service for a detailed list of parameters and operators.

Download the Docker image

The collector should be deployed as a Docker container. Download the Docker image of the collector as a .tgz file by clicking the link in the following table:

Collector Docker image	SHA-256 hash
collector-trend_micro_vision_one_collector_if-docker-image-1.1.0	`13827302ff86774559feaca2c03864090980b7264832e92462833dfea175d4e8`

Use the following command to add the Docker image to the system:

Code Block
gunzip -c <image_file>-<version>.tgz \| docker load

Note
Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace `<image_file>` and `<version>` with a proper value.

The Docker image can be deployed on the following services:

Docker

Execute the following command on the root directory <any_directory>/devo-collectors/<product_name>/

Code Block

docker run 
--name collector-<product_name> 
--volume $PWD/certs:/devo-collector/certs 
--volume $PWD/config:/devo-collector/config 
--volume $PWD/state:/devo-collector/state 
--env CONFIG_FILE=config.yaml 
--rm 
--interactive 
--tty 
<image_name>:<version>

Note
Replace `<product_name>`, `<image_name>` and `<version>` with the proper values.

Docker Compose

The following Docker Compose file can be used to execute the Docker container. It must be created in the <any_directory>/devo-collectors/<product_name>/ directory.

Code Block

version: '3'
services:
  collector-<product_name>:
    image: <image_name>:${IMAGE_VERSION:-latest}
    container_name: collector-<product_name>
    volumes:
      - ./certs:/devo-collector/certs
      - ./config:/devo-collector/config
      - ./credentials:/devo-collector/credentials
      - ./state:/devo-collector/state
    environment:
      - CONFIG_FILE=${CONFIG_FILE:-config.yaml}

To run the container using docker-compose, execute the following command from the <any_directory>/devo-collectors/<product_name>/ directory:

Code Block
IMAGE_VERSION=<version> docker-compose up -d

Note
Replace `<product_name>`, `<image_name>` and `<version>` with the proper values.

Rw tab

title	Cloud collector

We use a piece of software called Collector Server to host and manage all our available collectors. If you want us to host this collector for you, get in touch with us and we will guide you through the configuration.

To enable the collector for a customer:

In the Collector Server GUI, access the domain in which you want this instance to be created
Click Add Collector and find the one you wish to add.
In the Version field, select the latest value.
In the Collector Name field, set the value you prefer (this name must be unique inside the same Collector Server domain).
In the sending method select Direct Send. Direct Send configuration is optional for collectors that create Table events, but mandatory for those that create Lookups.
In the Parameters section, establish the Collector Parameters as follows below:

Editing the JSON configuration

Code Block

{
  "global_overrides": {
    "debug": false
  },
  "inputs": {
    "trend_micro_vision_one": {
      "id": "<short_id>",
      "enabled": true,
      "credentials": {
        "token": "<token_string>"
      },
      "commons": {
        "base_url": "<base_url>",
      },
      "services": {
        "audit": {
          "tag": "<tag>",
          "initial_start_time_in_utc": "<initial_start_time_in_utc>",
          "tmv1_filter": "<tmv1_filter_string>"
        },
        "alerts": {
          "tag": "<tag>",
          "initial_start_time_in_utc": "<initial_start_time_in_utc>",
          "tmv1_filter": "<tmv1_filter_string>"
        },
        "observed_attack_techniques": {
          "tag": "<tag>",
          "initial_start_time_in_utc": "<initial_start_time_in_utc>",
          "tmv1_filter": "<tmv1_filter_string>"
        }
      }
    }
  }
}

Info
All defined service entities will be executed by the collector. If you do not want to run any of them, just remove the entity from the `services` object.

Please replace the placeholders with real world values following the description table below:

Parameter	Data Type	Type	Value Range / Format	Details
`debug_status`	`bool`	`Mandatory`	`false` / `true`	If the value is `true`, the debug logging traces will be enabled when running the collector. If the value is `false`, only the `info`, `warning` and `error` logging levels will be printed.
`short_id`	int	mandatory	minimum length: 1 maximum length: 5	Use this parameter to give a unique ID to this input service. This parameter is used to build the persistence address; do not use the same value for multiple collectors. It could cause a collision.
`token_string`	str	mandatory		The token obtained from Trend Micro Vision One for authentication.
`base_url`	str	optional		The Trend Micro API base URL (for example `https://api.xdr.trendmicro.com`).
`tag`	str	optional	Devo tag-friendly string (no special characters, spaces, etc.)	An optional tag that allows users to override the service default tags.
`initial_start_time_in_utc`	str	optional	UTC datetime string	This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (one month back for example) before downloading new events.
`tmv1_filter_string`	str	optional	Please see API documentation on alerts and OATs (linked above) for information regarding the various fields and operators one may use for the respective TMV1-Filters.	Statement that allows you to retrieve a subset of the indicated service type events. Please refer to the API guide related to the service for a detailed list of parameters and operators.

Collector services detail

...

Versions Compared

Old Version 16

New Version 17

Key

Devo collector features

Data sources

Flattening preprocessing

Accepted authentication methods

Run the collector

Structure

Devo credentials

Editing the config.yaml file

Download the Docker image

Docker

Docker Compose

Editing the JSON configuration

Collector services detail