Table of Contents | ||||||
---|---|---|---|---|---|---|
|
Overview
Proofpoint Cloud App Security Broker (Proofpoint CASB) helps you secure applications such as Microsoft Office 365, Google Workspace, Box, and more. It gives you people-centric visibility and control over your cloud apps, so you can deploy cloud services with confidence.
Configuration requirements
...
Info |
---|
More information Refer to the Vendor setup section to know more about these configurations. |
Overview
Proofpoint Cloud App Security Broker (Proofpoint CASB) helps you secure applications such as Microsoft Office 365, Google Workspace, Box, and more. It gives you people-centric visibility and control over your cloud apps, so you can deploy cloud services with confidence.
Devo collector features
Feature | Details |
---|---|
Allow parallel downloading ( |
|
Running environments |
|
Populated Devo events |
|
Flattening preprocessing |
|
...
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).
Rw ui tabs macro | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Code Block |
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. StructureThe following directory structure should be created for being used when running the 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:
Editing the JSON configuration
Devo credentialsIn Devo, go to Administration → Credentials → X.509 Certificates, download the Certificate, Private key and Chain CA and save them in
Editing the config.yaml file
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 | |||||||||||||||||||||||||||||||||||||||||||||||||
|
|
| Minimum length: 1 | Use this param to give an unique id to this collector. | |||||||||||||||||||||||||||||||||||||||||||||||||
|
|
| Minimum length: 1 | Use this param to give a valid name to this collector. | |||||||||||||||||||||||||||||||||||||||||||||||||
|
|
|
| Use this param to identify the Devo Cloud where the events will be sent. | |||||||||||||||||||||||||||||||||||||||||||||||||
|
|
| Minimum length: 4 | Use this param to identify the chain.cert file downloaded from your Devo domain. Usually this file's name is: | |||||||||||||||||||||||||||||||||||||||||||||||||
|
|
| Minimum length: 4 | Use this param to identify the | |||||||||||||||||||||||||||||||||||||||||||||||||
|
|
| Minimum length: 4 | Use this param to identify the | |||||||||||||||||||||||||||||||||||||||||||||||||
|
|
| Minimum length: 1 | Use this param to give an unique id to this input service.
| |||||||||||||||||||||||||||||||||||||||||||||||||
|
|
| Minimum length: 1 | The | |||||||||||||||||||||||||||||||||||||||||||||||||
|
|
| Minimum length: 1 | The | |||||||||||||||||||||||||||||||||||||||||||||||||
|
|
| Minimum length: 1 | The | |||||||||||||||||||||||||||||||||||||||||||||||||
|
|
| UTC with 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. Please note that setting the
| |||||||||||||||||||||||||||||||||||||||||||||||||
Collector Docker image | SHA-256 hash | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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": {
"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>"
}
}
}
} |
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 | ||
|
|
| minimum length: 1 | Use this parameter to give a unique ID to this input service.
| ||
|
|
| minimum length: 1 | The | ||
|
|
| minimum length: 1 | The | ||
|
|
| minimum length: 1 | The | ||
|
|
| UTC with 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. Please note that setting the set in the commons level. This parameter should be removed if it is not used. |
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: 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>" |
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 | Details | ||
|
|
| Minimum length: 1 | Use this param to give an unique id to this collector. | ||
|
|
| Minimum length: 1 | Use this param to give a valid name to this collector. | ||
|
|
|
| Use this param to identify the Devo Cloud where the events will be sent. | ||
|
|
| Minimum length: 4 | Use this param to identify the chain.cert file downloaded from your Devo domain. Usually this file's name is: | ||
|
|
| Minimum length: 4 | Use this param to identify the | ||
|
|
| Minimum length: 4 | Use this param to identify the | ||
|
|
| Minimum length: 1 | Use this param to give an unique id to this input service.
| ||
|
|
| Minimum length: 1 | The | ||
|
|
| Minimum length: 1 | The | ||
|
|
| Minimum length: 1 | The | ||
|
|
| UTC with 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. Please note that setting the
|
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 |
---|---|
|
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 |
Collector services detail
...
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. | ||||
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. | ||||
ErrorType | Error Id | Error Message | Cause | Solution |
| 1
...
Release
...
Released on
...
Release type
...
Details
...
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.
|
Change log for v1.x.x
|
Change log
Release | Released on | Release type | Details | Recommendations | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Improvements
Bug fixing
|
| |||||||||||||
|
| Improvements
Bug Fixingfixing
|
| |||||||||||||
|
| New features:
|
|