Page Comparison

...

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

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": {
   "alienvault_otx": {
      "id": <short_unique_id>,
      "enabled": true,
      "requests_per_second": <requests_per_second>,
      "override_base_url":  <override_base_url>,
      "credentials": {
         "api_key": <creds_api_key>
      },
      "services": {
         "alienvault_otx": {
            "request_period_in_seconds": <period_in_seconds>,
            "start_date": <start_date>
         }
      }
   }
  }
}

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

short_unique_id

int

Mandatory

Minimum length: 1
Maximum length: 5

Use this param to give an unique id to this input service.

requests_per_second

int

Optional

Minimum value: 1

Customize the maximum number of API requests per second. If not used, the default setting will be used: 100000 requests/sec

This parameter can be left blank, removed or commented.

override_base_url

str

Optional

By default, this RegEx:

^(https?:\/\/)?([\da-z\.-]+)\.([a-z\.])([\/\w \.-]*)*([a-z])$

URL of the AlientVault OTX API, provided by AlienVault. Usually it is not necessary to set this parameter, the default value should be adequate.

This parameter can be left blank, removed or commented.

creds_api_key

str

Mandatory

Any

API Key downloaded from AlienVault tenant.

period_in_seconds

int

Optional

Minimum length: 1

By default, this service will run every 300 seconds. This parameter allows you to customize this behavior.

This parameter can be left blank, removed or commented.

start_date

str

Optional

Format expected: YYYY-MM-DD HH:MM:SS

Parameter used by the collector as the starting UTC point when it first pulls data. An example value can be 2022-03-25 18:00:00

This parameter can be left blank, removed or commented.

Note
Updating this value will produce the lost of all persisted data.

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/
    └── devo-collector-alienvault-otx/
          ├── certs/
          │   ├── chain.crt
          │   ├── <your_domain>.key
          │   └── <your_domain>.crt
          └── config/
              └── config.yaml

Devo credentials

In Devo, go to Administration → Credentials → X.509 Certificates, download the Certificate, Private key and Chain CA and save them in devo-collector-alienvault-otx/certs. Learn more about security credentials in Devo here.

Editing the config.yaml file

Code Block

globals:
  debug: false
  id: not_used
  name: alienvault_collector
  persistence:
    type: filesystem
    config:
      directory_name: state

outputs:
  devo_1:
    type: devo_platform
    config:
      address: <devo_address>
      #address: collector-us.devo.io
      #address: collector-eu.devo.io
      port: 443
      type: SSL
      chain: <chain_filename>
      cert: <cert_filename>.crt
      key: <key_filename>.key
inputs:
  alienvault_otx:
    id: <shor_unique_id>
    enabled: true
    requests_per_second: <requests_per_second>
    override_base_url: <override_base_url>
    credentials:
      api_key: <creds_api_key>
    services:
      alienvault_otx:
        request_period_in_seconds: <period_in_seconds>
        start_date: <start_date>

Replace the placeholders with the required values:

Parameter	Data type	Type	Value range	Details
`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.
`shor_unique_id`	`int`	`Mandatory`	Minimum length: 1 Maximum length: 5	Use this param to give a unique ID to this input service.
`requests_per_second`	`int`	`Optional`	Minimum value: 1	Customize the maximum number of API requests per second. If not used, the default setting will be used: 100000 requests/sec This parameter can be left blank, removed or commented.
`override_base_url`	`str`	`Optional`	By default, this RegEx: `^(https?:\/\/)?([\da-z\.-]+)\.([a-z\.])([\/\w \.-])([a-z])$`	URL of the AlientVault OTX API, provided by AlienVault. Usually, it is not necessary to set this parameter, the default value should be adequate. This parameter can be left blank, removed, or commented.
`creds_api_key`	`str`	`Mandatory`	Any	API Key downloaded from AlienVault tenant.
`period_in_seconds`	`int`	`Optional`	Minimum length: 1	By default, this service will run every 300 seconds. This parameter allows you to customize this behavior. This parameter can be left blank, removed or commented.
`start_date`	`str`	`Optional`	Format expected: YYYY-MM-DD HH:MM:SS	Parameter used by the collector as the starting UTC point when it first pulls data. An example value can be `2022-03-25 18:00:00` This parameter can be left blank, removed, or commented. Updating this value will produce the loss of all persisted data.

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-alienvault-otx-docker-image-1.1.0.tgz	`8e2fe5117df3a65b62e1b8205c90f31c2cca5eeacdff3ff5c278d47da56660e0`

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

Code Block
gunzip -c collector-alienvault-otx-docker-image-<version>.tgz \| docker load

Info
Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace "`<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/devo-collector-alienvault-otx/

Code Block

docker run \
--name collector-alienvault-otx\
--volume $PWD/certs:/devo-collector/certs \
--volume $PWD/config:/devo-collector/config \
--volume $PWD/state:/devo-collector/state \
--env CONFIG_FILE=config.yaml \
--rm -it devo.com/collectors/alientvault_otx_collector_if:<version>

Note
Replace `<version>` with a proper value.

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/devo-collector-alienvault-otx/ directory.

Code Block

version: '3'
services:
  collector-alienvault-otx:
    image: devo.com/collectors/alientvault_otx_collector_if:${IMAGE_VERSION:-latest}
    volumes:
      - ./certs:/devo-collector/certs
      - ./config:/devo-collector/config
      - ./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/devo-collector-alienvault-otx/ directory:

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

Note
Replace `<version>` with a proper value.

...

Versions Compared

Old Version 5

New Version 6

Key

Editing the JSON configuration

Structure

Devo credentials

Editing the config.yaml file

Download the Docker image

Docker

Docker Compose