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": <debug_status>
  },
  "inputs": {
    "wiz_data_puller": {
      "id": "<short_unique_id>",
      "enabled": <input_status>,
      "override_api_base_url": <base_url>,
      "credentials": {
        "client_id": "<client_id>",
        "client_secret": "<client_secret>"
      },
      "services": {
        "issues": {
          "request_period_in_seconds": <request_period_in_seconds>,
          "historic_date_utc": <historic_date_utc>,
          "filters": {
            "type": <type_list>
          }
        }
      }
    }
  }
}

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_unique_id

int

Mandatory

Minimum length: 1
Maximum length: 5

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

Note
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.

base_url

str

Optional

Valid URL following this regex:
^https:\/\/([a-z0-9]+[.]{1})([a-z0-9]+[.]{1})*[a-z]{2,}(:[0-9]{2,5})?$

By default, the base url is https://api.us1.app.wiz.io. This parameter allows you to customize the base url.

This parameter should be removed if it is not used.

historic_date_utc

str

Optional

UTC with format:
YYYY-mm-ddTHH:MM:SS.sssZ

This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (1 month back for example) before downloading new events.

If this setting is not set, the default value is the current time.

This parameter should be removed if it is not used.

client_id

str

Mandatory

Any

User Client ID to authenticate to the service.

client_secret

str

Mandatory

Any

User Secret Key to authenticate to the service.

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)

This parameter should be removed if it is not used.

type_list

list

Optional

Possible values:

"TOXIC_COMBINATION"
"THREAT_DETECTION",
"CLOUD_CONFIGURATION"

Filter by Issue type. You can specify multiple values in an array.

Example 1:

Code Block
"type": ["THREAT_DETECTION"]

Example 2 (multiple values):

Code Block
"type": ["TOXIC_COMBINATION", "THREAT_DETECTION"]

This parameter should be removed if it is not used.

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-<product_name>.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.

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
  multiprocessing: false
  queue_max_size_in_mb: 1024
  queue_max_size_in_messages: 1000
  queue_max_elapsed_time_in_sec: 60
  queue_wrap_max_size_in_messages: 100

outputs:
  devo_1:
    type: devo_platform
    config:
      address: <devo_address>
      port: 443
      type: SSL
      chain: <chain_filename>
      cert: <cert_filename>
      key: <key_filename>

inputs:
  wiz_data_puller:
    id: <short_unique_id>
    enabled: <input_status>
    override_api_base_url: <base_url>
    credentials:
      client_id: <client_id>
      client_secret: <client_secret>
    services:
      issues:
        request_period_in_seconds: <request_period_in_seconds>
        historic_date_utc: <historic_date_utc>
        filters:
          type: <type_list>

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

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.

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.

Note
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.

requests_per_seconds

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.

Info
This parameter can be left blank, removed or commented.

base_url

str

Optional

Valid URL following this regex:
^https:\/\/([a-z0-9]+[.]{1})([a-z0-9]+[.]{1})*[a-z]{2,}(:[0-9]{2,5})?$

By default, the base url is https://api.us1.app.wiz.io. This parameter allows you to customize the base url.

Info
This parameter can be left blank, removed or commented.

historic_date_utc

str

Optional

UTC with format:
YYYY-mm-ddTHH:MM:SS.sssZ

This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (1 month back for example) before downloading new events.

If this setting is not set, the default value is the current time.

Note
Note that update this value triggers the clearing of the Collector’s persistence and cannot be recovered in any way. Resetting persistence could result in duplicate or lost events.

Info
This parameter can be removed or commented.

client_id

str

Mandatory

Any

User Client ID to authenticate to the service.

client_secret

str

Mandatory

Any

User Secret Key to authenticate to the service.

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)

Info
This parameter can be removed or commented.

type_list

list

Optional

Possible values:

"TOXIC_COMBINATION"
"THREAT_DETECTION",
"CLOUD_CONFIGURATION"

Filter by Issue type. You can specify multiple values in an array.

Example 1:

Code Block
type: - THREAT_DETECTION

Example 2 (multiple values):

Code Block
type: - TOXIC_COMBINATION - THREAT_DETECTION

This parameter should be removed if it is not used.

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
collecto-wiz-docker-image-1.4.0.tgz	`b9e82a00676ade05561e403f5ccaa7561b66dd384c74de76d29680c93a3262ce`

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 15

New Version 16

Key

Editing the JSON configuration

Structure

Devo credentials

Editing the config.yaml file

Download the Docker image

Docker

Docker Compose