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. | 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. 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. |
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. |
| Code Block |
|---|
globals:
debug: True # <- Setup as True or False for debugging mode
id: not_used
name: gsuite
persistence: # <- Persistence setup filesystem
type: filesystem
config:
directory_name: state # <- Persistence directory
outputs:
devo_1:
type: devo_platform
config:
address: eu.elb.relay.logtrust.net # <- Devo platform address EU/US
port: 443
type: SSL
chain: chain.crt
cert: <your_domain>.crt # <- Please, replace with the certificate from your Devo domain (Administration>Credentials>x.509)
key: <your_domain>.key # <- Please, replace with the certificate from your Devo domain (Administration>Credentials>x.509)
inputs:
gsuite_alerts:
id: <short_unique_identifier> # <- "input_id", used for internal identifications
enabled: true # <- G Suite alerts service enabled
requests_per_second: 5 # <- Setting up requests per second. 5 recommended.
autoconfig: # <- "autoconfiguration" will be executed (connector doesn't support this attribute, set is "true" by default).
enabled: true # <- Autocofig setting up - True or False
refresh_interval_in_seconds: 180 # <- Time wait in second between requests - 180s recommended.
credentials:
filename: credentials-gsuite-alerts.json # <- Service Account credentials json file that you named on the getting credentials section
delegated_email: <delegated_email_value> # <- Email that will be used to delegate G Suite Alerts Viewer permissions to the Service Account
source_id: <source_id_value> # <- This value will be used for adding to message "tag" as fourth level
services: # <- List with the Alerts that you want to collect
customer_takeout_initiated:
request_period_in_seconds: 60 # <- Controls waiting time for to the next request
start_time: "9999-12-31T23:59:59.999Z"
malware_reclassification:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z"
misconfigured_whitelist:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z"
phishing_reclassification:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z"
suspicious_message_reported:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z"
user_reported_phishing:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z"
user_reported_spam_spike:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z"
leaked_password:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z"
suspicious_login:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z"
suspicious_login_less_secure_app:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z"
suspicious_programmatic_login:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z"
user_suspended:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z"
user_suspended_spam:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z"
user_suspended_spam_through_relay:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z"
user_suspended_suspicious_activity:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z"
google_operations:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z"
government_attack_warning:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z"
device_compromised:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z"
suspicious_activity:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z"
appmaker_default_cloud_sql_setup:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z"
activity_rule:
request_period_in_seconds: 60
start_time: "9999-12-31T23:59:59.999Z" |
| Note |
|---|
The start_time fields are optional. If you would like to establish any value, the required format is 0000-00-00T00:00:00.000Z. |
| Note |
|---|
delegated_email field should contain the email of an real user (you cannot use a Service Account here) with enough access to display the alerts in the Google WorkSpace Admin Console >> Alert Center (https://admin.google.com/ac/ac).
|
| 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. |
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: | 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: 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. |
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. |
| 
