Content Comparison

...

Once the data source is configured, you can 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).

We use a piece of software called Collector Server to host and manage all our available collectors.

To enable the collector for a customer:

1. In the Collector Server GUI, access the domain in which you want this instance to be created

2. Click Add Collector and find the one you wish to add.

3. In the Version field, select the latest value.

4. In the Collector Name field, set the value you prefer (this name must be unique inside the same Collector Server domain).

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

6. In the Parameters section, establish the Collector Parameters as follows below:

Editing the JSON configuration

{
  "global_overrides": {
    "debug": false
  },
  "inputs": {
    "proofpoint_casb": {
      "id": "<input_id>",
      "credentials": {
        "client_id": "<client_id>",
        "client_secret": "<client_secret>",
       ├── state/
 "api_key": "<api_key>"
      },
└── config/     "commons": {
       └── 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 <product_name>/certs/. Learn more about security credentials in Devo here.

Image Removed

Editing the config.yaml file

globals:
  debug: false
  id: "<collector_id>"
  name: "<collector_name>"
  persistence:
    type: filesystem
    config:
      directory_name: state
outputs:
  devo_us_1:
    type: devo_platform
    config:
 "initial_start_time_in_utc": "<initial_start_time_in_utc>"
      },
      "services": {
        "alerts": {
          "initial_start_time_in_utc": "<initial_start_time_in_utc>"
        }
      },
     address: "<devo_address>"
      port: 443
  events": {
   type: SSL       chain"initial_start_time_in_utc": "<chain_filename><initial_start_time_in_utc>"
      cert: "<cert_filename>"}
    }
  key: "<key_filename>"
inputs:
  proofpoint_casb:
    id: "<input_id>"
    credentials:
      client_id: "<client_id>"
      client_secret: "<client_secret>"
      api_key: "<api_key>"
    commons:
        }
}

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

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

Parameter

Data Type

Type

Value Range

Details

collector_id

str

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.

input_id

str

Mandatory

Minimum length: 1
Maximum length: 5

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

api_key

str

Mandatory

Minimum length: 1

The client_id obtained from Proofpoint for authentication.

client_id

str

Mandatory

Minimum length: 1

The client_id obtained from Proofpoint for authentication.

client_secret

str

Mandatory

Minimum length: 1

The client_secret obtained from Proofpoint for authentication.

initial_start_time_in_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 (one month back for example) before downloading new events.

Please note that setting the initial_start_time_in_utc for a particular service will override any initial_start_time_in_utc set in the commons level.

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-proofpoint_casb_if-docker-image-1.1.0

9e24c7d4b115e44d6f7f87fc1d206edf3d2aa36af2c16d4da171833ead56c331

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

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

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>/

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>

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.

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:

IMAGE_VERSION=<version> docker-compose up -d

We use a piece of software called Collector Server to host and manage all our available collectors.

To enable the collector for a customer:

1. In the Collector Server GUI, access the domain in which you want this instance to be created

2. Click Add Collector and find the one you wish to add.

3. In the Version field, select the latest value.

4. In the Collector Name field, set the value you prefer (this name must be unique inside the same Collector Server domain).

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

6. In the Parameters section, establish the Collector Parameters as follows below:

Editing the JSON configuration

{
  "global_overrides": {
    "debug": false
  },
  "inputs": {
    "proofpoint_casb": {
      "id": "<input_id>",
      "credentials": {
        "client_id": "<client_id>",
        "client_secret": "<client_secret>",
        "api_key": "<api_key>"
      },
      "commons": {
        "initial_start_time_in_utc": "<initial_start_time_in_utc>"
      },
      "services": {
        "alerts": {
          "initial_start_time_in_utc": "<initial_start_time_in_utc>"
        }
      },
      "events": {
        "initial_start_time_in_utc": "<initial_start_time_in_utc>"
      }
    }
  }
}

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

Parameter

Data Type

Type

Value Range / Format

Details

input_id

str

mandatory

minimum length: 1
maximum length: 20

Use this parameter to give a unique ID to this input service.

api_key

str

mandatory

minimum length: 1

The api_key obtained from Proofpoint for authentication.

client_id

str

mandatory

minimum length: 1

The client_id obtained from Proofpoint for authentication.

client_secret 

str

mandatory

minimum length: 1

The client_secret obtained from Proofpoint for authentication.

initial_start_time_in_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 (one month back for example) before downloading new events.

Please note that setting the initial_start_time_in_utc for a particular service will override any initial_start_time_in_utc set in the commons level.

Image Removed

Image Added

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:

<any_directory>
└── devo-collectors/
    └── <product_name>/
        ├── certs/
        │   ├── chain.crt
        │   ├── <your_domain>.key
        │   └── <your_domain>.crt
        ├── state/
        └── 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 <product_name>/certs/. Learn more about security credentials in Devo here.

Image Added

Editing the config.yaml file

globals:
  debug: false
  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:
  proofpoint_casb:
    id: "<input_id>"
    credentials:
      client_id: "<client_id>"
      client_secret: "<client_secret>"
      api_key: "<api_key>"
    commons:
        initial_start_time_in_utc: "<initial_start_time_in_utc>"
    services:
      alerts:
        initial_start_time_in_utc: "<initial_start_time_in_utc>"
      events:
        initial_start_time_in_utc: "<initial_start_time_in_utc>"

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

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:

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

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

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>/

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>

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.

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:

IMAGE_VERSION=<version> docker-compose up -d

Collector services detail

...

...