Page Comparison

Table of Contents
[ Overview ] [ Devo collector features ] [ Data sources ] [ Flattening preprocessing ] [ Vendor setup ] [ Minimum configuration required for basic pulling ] [ Accepted authentication methods ] [ Run the collector ] [ Collector services detail ] [ Collector operations ] [ Change log ]

Overview

Darktrace RESPOND works autonomously to disarm attacks whenever they occur. Reacts to threats in seconds, working 24/7 as it frees up security teams and resources.

...

Rw ui tabs macro

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.
Editing the JSON configuration:

Code Block

{
  "global_overrides": {
    "debug": false
  },
  "inputs": {
    "darktrace": {
      "id": "<short_unique_id>",
      "enabled": "<input_status>",
      "credentials": {
        "public_token": "<public_token>",
        "private_token": "<private_token>",
        "instance": "<instance>"
      },
      "services": {
        "antigena": {
          "start_time_in_utc_format": "<start_time_in_utc_format>",
          "request_period_in_seconds": "<request_period_in_seconds>",
          "override_devo_tag": "<override_devo_tag>",
          "override_time_window_interval_in_minutes": "<override_time_window_interval_in_minutes>"
        },
        "aianalyst_incidentevents": {
          "start_time_in_utc_format": "<start_time_in_utc_format>",
          "request_period_in_seconds": "<request_period_in_seconds>",
          "override_devo_tag": "<override_devo_tag>",
          "override_time_window_interval_in_minutes": "<override_time_window_interval_in_minutes>"
        },
        "summarystatistics": {
          "start_time_in_utc_format": "<start_time_in_utc_format>",
          "request_period_in_seconds": "<request_period_in_seconds>",
          "override_devo_tag": "<override_devo_tag>", 
          "override_time_window_interval_in_minutes": "<override_time_window_interval_in_minutes>"
        },
        "status": {
          "start_time_in_utc_format": "<start_time_in_utc_format>",
          "request_period_in_seconds": "<request_period_in_seconds>",
          "override_devo_tag": "<override_devo_tag>",
          "override_time_window_interval_in_minutes": "<override_time_window_interval_in_minutes>"
        },
        "modelbreaches": {
          "start_time_in_utc_format": "<start_time_in_utc_format>",
          "request_period_in_seconds": "<request_period_in_seconds>",
          "override_devo_tag": "<override_devo_tag>",
          "override_time_window_interval_in_minutes": "<override_time_window_interval_in_minutes>"
        }
      }
    }
  }
}

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	Details
`<short_unique_id>`	`int`	`Mandatory`	Minimum 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`	false / true	Use this param 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.
`<public_token>`	`str`	`Mandatory`	Minimum Length 1	public_token for accessing Darktrace API.
`<private_token>`	`str`	`Mandatory`	Minimum Length 1	private_token for accessing Darktrace API.
`<instance>`	`str`	`Mandatory`	Minimum Length 1	instance Instance value for accessing Darktrace API.the Darktrace server. Suppose the base URL is `https://azeus1-75836-01.cloud.darktrace.com/` , so `instance` value will be `azeus1-75836-01.cloud.darktrace.com`
`<start_time_in_utc_format>`	`int`	`Mandatory`	UTC format	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. Ex: 2022-05-14T00:00:0
`<override_devo_tag>`	`str`	`Optional`	A devo tag	This parameter allows defining a custom devo tag which overrides the default devo tag
`<override_time_window_interval_in_minutes>`	`int`	`Optional`	Minimum length: 1	This value allows you to set the intervals in which the data pulling will be divided, starting from the start date. This will overwrite the default value (60 minutes)
`<request_period_in_seconds>`	`int`	`Optional`	Minimum Length 1	Period in seconds used between each data pulling, this value will overwrite the default value (60 seconds).

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: false
  id: not_used
  name: example_collector
  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:
  darktrace:
    id: <short_unique_id>
    enabled: <input_status>
    credentials:
      public_token: <public_token>
      private_token: <private_token>
      instance: <instance>
    services:
       antigena:
         start_time_in_utc_format: <start_time_in_utc_format> # example 2022-05-14T00:00:00
         request_period_in_seconds: <request_period_in_seconds> #otional
         override_devo_tag: <override_devo_tag> #optional
         override_time_window_interval_in_minutes: <override_time_window_interval_in_minutes> #optional
       aianalyst_incidentevents:
         start_time_in_utc_format: <start_time_in_utc_format> # example 2022-05-14T00:00:00
         request_period_in_seconds: <request_period_in_seconds> #otional
         override_devo_tag: <override_devo_tag> #optional
         override_time_window_interval_in_minutes: <override_time_window_interval_in_minutes> #optional
       summarystatistics:
         start_time_in_utc_format: <start_time_in_utc_format> # example 2022-05-14T00:00:00
         request_period_in_seconds: <request_period_in_seconds> #otional
         override_devo_tag: <override_devo_tag> #optional
         override_time_window_interval_in_minutes: <override_time_window_interval_in_minutes> #optional
       status:
         start_time_in_utc_format: <start_time_in_utc_format> # example 2022-05-14T00:00:00
         request_period_in_seconds: <request_period_in_seconds> #otional
         override_devo_tag: <override_devo_tag> #optional
         override_time_window_interval_in_minutes: <override_time_window_interval_in_minutes> #optional        
       modelbreaches:
         start_time_in_utc_format: <start_time_in_utc_format> # example 2022-05-14T00:00:00
         request_period_in_seconds: <request_period_in_seconds> #otional
         override_devo_tag: <override_devo_tag> #optional
         override_time_window_interval_in_minutes: <override_time_window_interval_in_minutes> #optional

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	Details
`<collector_id>`	`int`	`Mandatory`	Minimum length: 1 Maximum length: 5	Use this param to give an unique id to this collector.
`<collector_name>`	`str`	`Mandatory`	Minimum length: 1 Maximum length: 10	Use this param to give a valid name to this collector.
`<devo_address>`	`str`	`Mandatory`	collector-us.devo.io collector-eu.devo.io	Use this param to identify the Devo Cloud where the events will be sent.
`<chain_filename>`	`str`	`Mandatory`	Minimum length: 4 Maximum length: 20	Use this param 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 param to identify the file.cert downloaded from your Devo domain.
`<key_filename>`	`str`	`Mandatory`	Minimum length: 4 Maximum length: 20	Use this param to identify the file.key downloaded from your Devo domain.
`<short_unique_id>`	`int`	`Mandatory`	Minimum length: 1 Maximum length: 5	Use this param to give an 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`	false / true	If the value is true, the input definition will be executed. If the value is false, the service will be ignored.
`<public_token>`	`str`	`Mandatory`	Minimum length: 1	Public Token of the Darktrace server
`<private_token>`	`str`	`Mandatory`	Minimum length: 1	Private Token of the Darktrace server
`<instance>`	`str`	`Mandatory`	Minimum length: 1	Instance value for the Darktrace server. Suppose the base URL is `https://azeus1-75836-01.cloud.darktrace.com/` , so `instance` value will be `azeus1-75836-01.cloud.darktrace.com`
`<request_period_in_seconds>`	`int`	`Optional`	Minimum length: 1	Period in seconds used between each data pulling, this value will overwrite the default value (60 seconds)
`<override_devo_tag>`	`str`	`Optional`	A devo tag	This parameter allows to define a custom devo tag.
`<start_time_in_utc_format>`	`str`	`Optional`	Minimum length: 1	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.
`<override_time_window_interval_in_minutes>`	`int`	`Optional`	Minimum length: 1	This value allows you to set the intervals in which the data pulling will be divided, starting from the start date. This will overwrite the default value (60 minutes)

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-darktrace_respond-docker-image-1.1.0	`e840667b136af17faea4f0984f607b77cf24bed4ec7fff903008ec9cb9c79e7a`

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.

...

Versions Compared

Old Version 5

New Version Current

Key

Overview

Structure

Devo credentials

Editing the config.yaml file

Download the Docker image

Docker

Docker Compose