Table of Contents | ||||||
---|---|---|---|---|---|---|
|
Configuration requirements
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. |
Overview
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 |
|
Running environmentsCollector |
|
Populated Devo events |
|
Flattening preprocessing |
|
Data sources
Data source | Description | API endpoint | Collector service name | Devo table | Available from release |
---|---|---|---|---|---|
Audit logs | Audit log entries |
| audit |
|
|
Alerts | Displays information about workbench alerts (users can provide a TMV1-Filter to pull a subset) |
| alerts |
|
|
Observed attack techniques (OATs) | Displays information about OATs (users can provide a TMV1-Filter to pull a subset) | observed_attack_techniques |
|
|
For more information on how the events are parsed, visit our page.
Flattening preprocessing
Data source | Collector service | Optional | Flattening details |
---|---|---|---|
Alerts |
|
| - |
Observed attack techniques |
|
| - |
Anchor | ||||
---|---|---|---|---|
|
Vendor setup
There are some requirements to set up this collector:
...
Rw ui steps macro | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Log into the Trend Micro Vision One console using an account with the Master Administrator role and go to Account → User Accounts.
Select the account that you use for API access. The Account Details panel opens.
Generate a new authentication token by selecting Generate new authentication token.
Assing to it the necessary access roles:
|
Minimum configuration required for basic pulling
Although this collector supports advanced configuration, the fields required to retrieve data with basic configuration are defined below.
...
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 | ||||
---|---|---|---|---|
|
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 tab | ||
---|---|---|
|
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 |
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 |
Editing the config.yaml file
...
Token creation (using Trend Micro)
Rw ui steps macro | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Log in to the Trend Micro Vision One console using an account with the Master Administrator role and go to Account → User Accounts.
Select the account that you use for API access. The Account Details panel opens.
Generate a new authentication token. To do it, select Generate new authentication token.
Assign the necessary access roles:
Copy the authentication token.
Select Save. |
Accepted authentication methods
Authentication method | token | ||||||
---|---|---|---|---|---|---|---|
token |
|
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
We use a piece of software called Collector Server to host and manage all our available collectors. To enable the collector for a customer:
Editing the JSON configuration
Replace Please replace the placeholders with your required real world values following the description table below:
This will make the collector generate (or not) log messages with the DEBUG level.
minimum length: 1 maximum length: 10 Use this parameter to give a valid name to this collector. devo_address
Use this parameter to identify the Devo Cloud where the events will be sent.
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:
minimum length: 4 maximum length: 20 Use this parameter to identify the file.cert downloaded from your Devo domain.
minimum length: 4 maximum length: 20 Use this parameter to identify the file.key downloaded from your Devo domain.
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.
Use this parameter to enable or disable the given input logic when running the collector. If the value is
The token obtained from Trend Micro Vision One for authentication.
Base URL for Trend Micro instance.
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.
Devo tag-friendly string (no special characters, spaces, etc.) An optional tag that allows users to override the service default tags.
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 imageThe 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 |
|
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 |
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 |
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 |
Rw tab | ||
---|---|---|
|
We use a piece of software called Collector Server to host and manage all our available collectors.
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 createLookups
.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 |
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.
| The token obtained from Trend Micro Vision One for authentication. | |||
| str | optional |
| The Trend Micro API base URL (for example |
| str | optional | Devo tag-friendly string (no special characters, spaces, etc.) | An optional tag that allows users to override the service default tags. |
| 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. |
| 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. |
Rw tab | ||
---|---|---|
|
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 |
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 |
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 |
Replace the placeholders with your required values following the description table below:
Parameter | Data type | Type | Value range / Format | Details |
---|---|---|---|---|
|
|
|
| This will make the collector generate (or not) log messages with the DEBUG level. |
|
|
| minimum length: 1 maximum length: 5 | Use this parameter to give a unique ID to this collector. |
|
|
| minimum length: 1 maximum length: 10 | Use this parameter to give a valid name to this collector. |
|
|
|
| Use this parameter to identify the Devo Cloud where the events will be sent. |
|
|
| 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: |
|
|
| minimum length: 4 maximum length: 20 | Use this parameter to identify the file.cert downloaded from your Devo domain. |
|
|
| minimum length: 4 maximum length: 20 | Use this parameter to identify the file.key downloaded from your Devo domain. |
|
|
| 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. |
|
|
|
| Use this parameter to enable or disable the given input logic when running the collector. If the value is |
|
|
|
| The token obtained from Trend Micro Vision One for authentication. |
|
|
|
| Base URL for Trend Micro instance. |
|
|
| 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. |
|
|
| Devo tag-friendly string (no special characters, spaces, etc.) | An optional tag that allows users to override the service default tags. |
|
|
| 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.2.1 |
|
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 |
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 |
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 |
API limitations
The Trend Micro API is subject to rate limiting (see Trend Micro’s API Request Limits for details). In the event the collector encounters a 429
(that is, the requests hit a rate limit), the collector will attempt to gracefully respect the 429
rate limit and re-attempt the request three times before failing.
Authentication tokens expire after one year. You must create another token before expiration and reconfigure the collector to avoid downtime.
The Observed Attack Techniques endpoint is very slow (around 15 seconds to resolve a request). The requests are paginated, so we send one page at a time to Devo but take into account that if there is any delay with the current date, it may take time to reach the current up-to-date info.
The services only allow pulling data from 5 days in the past and it will fail to start if the configuration does not comply with this limitation.
Collector services detail
This section is intended to explain how to proceed with specific actions for services.
Events service
Expand | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Once the collector has been launched, it is important to check if the ingestion is performed in a proper way. To do so, go to the collector’s logs console. This service has the following components:
Setup outputA successful run has the following output messages for the setup module:
Puller outputA successful initial run has the following output messages for the puller module:
After a successful collector’s execution (that is, no error logs found), you will see the following log message:
|
...
Expand | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||
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.
|
Collector operations
This section is intended to explain how to proceed with specific operations of this collector.
Expand | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
InitializationThe 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 ingestionThe 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 servicesThe Integrations Factory Collector SDK has 3 different senders services depending on the event type to delivery (
Sender statisticsEach service displays its own performance statistics that allow checking how many events have been delivered to Devo by type:
|
...
Expand | ||
---|---|---|
| ||
Sometimes it is necessary to activate the debug mode of the collector's logging. This debug mode increases the verbosity of the log and allows you to print execution traces that are very helpful in resolving incidents or detecting bottlenecks in heavy download processes.
For more information, visit the configuration and parameterization section corresponding to the chosen deployment mode. |
Change log
...
Release
...
Released on
...
Release type
...
Details
...
For more information, visit the configuration and parameterization section corresponding to the chosen deployment mode. |
Change log
Release | Released on | Release type | Details | Recommendations | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Bug fixing
|
| |||||||||||||
|
| Improvements
Bug fixing
|
| |||||||||||||
|
| Improvements:
Bugs fixing:
|
|