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. StructureThe 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. |
Devo credentialsIn 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. |
Editing the config.yaml file Code Block |
---|
globals:
debug: false
id: <collector_id_value>
name: <collector_name_value>
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:
microsoft_graph_audit:
id: <short_unique_id>
enabled: true
credentials:
tenant_id: <tenant_id_value>
client_id: <client_id_value>
client_secret: <client_secret_value>
environment: <environment_value>
override_top_level_domain: <override_top_level_domain_value>
override_base_url: <override_base_url_value>
override_login_url: <override_login_url_value>
override_scope_value: <override_scope_value_value>
services:
directory_audits:
request_period_in_seconds: <request_period_in_seconds_value>
start_time_in_utc: <start_time_in_utc_value>
additional_filter: <additional_filter_value>
override_tag: <override_tag_value>
override_query_window_max_seconds: <override_query_window_max_seconds_value>
provisioning_audits:
request_period_in_seconds: <request_period_in_seconds_value>
start_time_in_utc: <start_time_in_utc_value>
additional_filter: <additional_filter_value>
override_tag: <override_tag_value>
override_query_window_max_seconds: <override_query_window_max_seconds_value>
signIns:
request_period_in_seconds: <request_period_in_seconds_value>
start_time_in_utc: <start_time_in_utc_value>
additional_filter: <additional_filter_value>
override_tag: <override_tag_value>
override_query_window_max_seconds: <override_query_window_max_seconds_value>
signIns_v2:
request_period_in_seconds: <request_period_in_seconds_value>
start_time_in_utc: <start_time_in_utc_value>
additional_filter: <additional_filter_value>
override_tag: <override_tag_value>
override_query_window_max_seconds: <override_query_window_max_seconds_value>
microsoft_graph_security:
id: <short_unique_id>
enabled: true
credentials:
tenant_id: <tenant_id_value>
client_id: <client_id_value>
client_secret: <client_secret_value>
environment: <environment_value>
override_top_level_domain: <override_top_level_domain_value>
override_base_url: <override_base_url_value>
override_login_url: <override_login_url_value>
override_scope_value: <override_scope_value_value>
services:
secure_score_control_profiles:
request_period_in_seconds: <request_period_in_seconds_value>
additional_filter: <additional_filter_value>
override_tag: <override_tag_value>
secure_scores:
request_period_in_seconds: <request_period_in_seconds_value>
start_time_in_utc: <start_time_in_utc_value>
additional_filter: <additional_filter_value>
override_tag: <override_tag_value>
override_query_window_max_seconds: <override_query_window_max_seconds_value>
alerts:
request_period_in_seconds: <request_period_in_seconds_value>
start_time_in_utc: <start_time_in_utc_value>
additional_filter: <additional_filter_value>
override_tag: <override_tag_value>
override_query_window_max_seconds: <override_query_window_max_seconds_value>
alerts_v2:
request_period_in_seconds: <request_period_in_seconds_value>
start_time_in_utc: <start_time_in_utc_value>
additional_filter: <additional_filter_value>
override_tag: <override_tag_value>
override_query_window_max_seconds: <override_query_window_max_seconds_value> |
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 / Format | Details |
---|
collector_id_value
| str
| mandatory | minimum length: 1 maximum length: 5 | Use this parameter to give a unique ID to this collector. | collector_name_value
| str
| mandatory | minimum length: 1 maximum length: 10 | Use this parameter to give a name to this collector. | devo_address
| str
| mandatory | One of: collector-us.devo.io
collector-eu.devo.io
| Use this parameter to identify the Devo Cloud where the events will be sent. | chain_filename
| str
| mandatory | minimum length: 4 maximum length: 20 | Use this parameter 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 parameter to identify the file.cert downloaded from your Devo domain. | key_filename
| str
| mandatory | minimum length: 4 maximum length: 20 | Use this parameter to identify the file.key downloaded from your Devo domain. | short_unique_id TODO from this point on, several parameters changed
| str
| mandatory | minimum length: 1 maximum length: 5 | Use this parameter to give a unique ID to this input service. This parameter is used to build the persistence address; do not use the same value for multiple collectors. It could cause a collision. | tenant_id_value
| str
| mandatory | minimum length: 1 | This is the Tenant’s ID you created in Azure AD. You can obtain it from the Overview page in your registered application. | client_id_value
| str
| mandatory | minimum length: 1 | This is the Application (client) ID you created in Azure AD. You can obtain it from the Overview page in your registered application. | client_secret_value
| str
| mandatory | minimum length: 1 | This is the client secret you created in Azure AD. You can obtain it from the Certificates & secrets page in your registered application. | environment_value
| str
| optional | minimum length: 1 | This is an optional control parameter that is injected into the events and allows you to differentiate the environment. For example: dev and prod. Info |
---|
This parameter should be removed if it is not used. |
| request_period_in_seconds_value
| int
| optional | minimum length: 60 | Period in seconds used between each data pulling. This value will overwrite the default value (300 seconds). | start_time_in_utc_value
| str
| optional | UTC datetime string having datetime string format %Y-%m-%dT%H-%M-%SZ (e.g., “2020-01-01T00:00:01Z”) | 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. Info |
---|
This parameter should be removed if it is not used. |
| additional_filter_value
| str
| optional | minimum length: 1 | This parameter allows you to add an additional Microsoft Graph OData query clause to the default filters. By default, the collector attempts to fetch all data possible for a given Microsoft Graph entity type. See OData query parameters documentation for more information on how to format filters for Microsoft Graph API. Info |
---|
This parameter should be removed if it is not used. |
| override_tag_value
| str
| optional | Devo tag-friendly string (no special characters, spaces, etc.) For more information see Devo Tags | An optional tag that allows users to override the service default tags. Info |
---|
This parameter should be removed if it is not used. |
| override_top_level_domain_value
| str
| optional | One of: Default value:com | This is an optional parameter that allows you to override the default top level domain. If you're working in a Microsoft 365 GCC environment, continue using the worldwide endpoints (com ). If you're working in a Microsoft 365 GCC High environment, use us . Info |
---|
This parameter should be removed if it is not used. |
| override_base_url_value
| str
| optional | default value: https://graph.microsoft.{top_level_domain} | A parameter that allows you to override the base URL. Info |
---|
This parameter should be removed if it is not used. |
| override_login_url_value
| str
| optional | default value: https://login.microsoftonline.com/ | A parameter that allows you to override the login URL. Info |
---|
This parameter should be removed if it is not used. |
| override_scope_value
| str
| optional | default value: https://graph.microsoft.com/.default | A parameter that allows you to override the scope value. Info |
---|
This parameter should be removed if it is not used. |
| override_query_window_max_seconds
| int
| optional | default value: None | A parameter that allows you to override the maximum query window. This is useful for any APIs that greatly restrict the amount of data one can fetch for a given datetime range (performance reasons). The collector will continuously fetch data but in smaller increments. Info |
---|
This parameter should be removed if it is not used. |
|
Download the Docker imageThe 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 <collector-ms-graph-collector-if-docker-image>-<1.2.0>.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: DockerExecute 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 ComposeThe 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. |
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 create Lookups . In the Parameters section, establish the Collector Parameters as follows below:
Editing the JSON configuration Code Block |
---|
{
"global_overrides": {
"debug": false
},
"inputs": {
"microsoft_graph_audit": {
"id": "<short_unique_id>",
"enabled": true,
"credentials": {
"tenant_id": "<tenant_id_value>",
"client_id": "<client_id_value>",
"client_secret": "<client_secret_value>"
},
"environment": "<environment_value>",
"override_top_level_domain": "<override_top_level_domain_value>",
"override_base_url": "<override_base_url_value>",
"override_login_url": "<override_login_url_value>",
"override_scope_value": "<override_scope_value_value>",
"services": {
"directory_audits": {
"request_period_in_seconds": "<request_period_in_seconds_value>",
"start_time_in_utc": "<start_time_in_utc_value>",
"additional_filter": "<additional_filter_value>",
"override_tag": "<override_tag_value>",
"override_query_window_max_seconds": "<override_query_window_max_seconds_value>"
},
"provisioning_audits": {
"request_period_in_seconds": "<request_period_in_seconds_value>",
"start_time_in_utc": "<start_time_in_utc_value>",
"additional_filter": "<additional_filter_value>",
"override_tag": "<override_tag_value>",
"override_query_window_max_seconds": "<override_query_window_max_seconds_value>"
},
"signIns": {
"request_period_in_seconds": "<request_period_in_seconds_value>",
"start_time_in_utc": "<start_time_in_utc_value>",
"additional_filter": "<additional_filter_value>",
"override_tag": "<override_tag_value>",
"override_query_window_max_seconds": "<override_query_window_max_seconds_value>"
},
"signIns_v2": {
"request_period_in_seconds": "<request_period_in_seconds_value>",
"start_time_in_utc": "<start_time_in_utc_value>",
"additional_filter": "<additional_filter_value>",
"override_tag": "<override_tag_value>",
"override_query_window_max_seconds": "<override_query_window_max_seconds_value>"
}
}
},
"microsoft_graph_security": {
"id": "<short_unique_id>",
"enabled": true,
"credentials": {
"tenant_id": "<tenant_id_value>",
"client_id": "<client_id_value>",
"client_secret": "<client_secret_value>"
},
"environment": "<environment_value>",
"override_top_level_domain": "<override_top_level_domain_value>",
"override_base_url": "<override_base_url_value>",
"override_login_url": "<override_login_url_value>",
"override_scope_value": "<override_scope_value_value>",
"services": {
"secure_score_control_profiles": {
"request_period_in_seconds": "<request_period_in_seconds_value>",
"additional_filter": "<additional_filter_value>",
"override_tag": "<override_tag_value>"
},
"secure_scores": {
"request_period_in_seconds": "<request_period_in_seconds_value>",
"start_time_in_utc": "<start_time_in_utc_value>",
"additional_filter": "<additional_filter_value>",
"override_tag": "<override_tag_value>",
"override_query_window_max_seconds": "<override_query_window_max_seconds_value>"
},
"alerts": {
"request_period_in_seconds": "<request_period_in_seconds_value>",
"start_time_in_utc": "<start_time_in_utc_value>",
"additional_filter": "<additional_filter_value>",
"override_tag": "<override_tag_value>",
"override_query_window_max_seconds": "<override_query_window_max_seconds_value>"
},
"alerts_v2": {
"request_period_in_seconds": "<request_period_in_seconds_value>",
"start_time_in_utc": "<start_time_in_utc_value>",
"additional_filter": "<additional_filter_value>",
"override_tag": "<override_tag_value>",
"override_query_window_max_seconds": "<override_query_window_max_seconds_value>"
}
}
}
}
} |
Parameter | Data type | Type | Value Range / Format | Details |
---|
short_unique_id
| str
| mandatory | minimum length: 1 maximum length: 5 | Use this parameter to give a unique ID to this input service. This parameter is used to build the persistence address; do not use the same value for multiple collectors. It could cause a collision. | tenant_id_value
| str
| mandatory | minimum length: 1 | This is the Tenant’s ID you created in Azure AD. You can obtain it from the Overview page in your registered application. | client_id_value
| str
| mandatory | minimum length: 1 | This is the Application (client) ID you created in Azure AD. You can obtain it from the Overview page in your registered application. | client_secret_value
| str
| mandatory | minimum length: 1 | This is the client secret you created in Azure AD. You can obtain it from the Certificates & secrets page in your registered application. | environment_value
| str
| optional | minimum length: 1 | This is an optional control parameter that is injected into the events and allows you to differentiate the environment. For example: dev and prod. Info |
---|
This parameter should be removed if it is not used. |
| request_period_in_seconds_value
| int
| optional | minimum length: 60 | Period in seconds used between each data pulling. This value will overwrite the default value (300 seconds). | start_time_in_utc_value
| str
| optional | UTC datetime string having datetime string format %Y-%m-%dT%H-%M-%SZ (e.g., “2020-01-01T00:00:01Z”) | 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. Info |
---|
This parameter should be removed if it is not used. |
| additional_filter_value
| str
| optional | minimum length: 1 | This parameter allows you to add an additional Microsoft Graph OData query clause to the default filters. By default, the collector attempts to fetch all data possible for a given Microsoft Graph entity type. See OData query parameters documentation for more information on how to format filters for Microsoft Graph API. Info |
---|
This parameter should be removed if it is not used. |
| override_tag_value
| str
| optional | Devo tag-friendly string (no special characters, spaces, etc.) For more information see Devo Tags | An optional tag that allows users to override the service default tags. Info |
---|
This parameter should be removed if it is not used. |
| override_top_level_domain_value
| str
| optional | One of: Default value:com | This is an optional parameter that allows you to override the default top level domain. If you're working in a Microsoft 365 GCC environment, continue using the worldwide endpoints (com ). If you're working in a Microsoft 365 GCC High environment, use us . Info |
---|
This parameter should be removed if it is not used. |
| override_base_url_value
| str
| optional | default value: https://graph.microsoft.{top_level_domain} | A parameter that allows you to override the base URL. Info |
---|
This parameter should be removed if it is not used. |
| override_login_url_value
| str
| optional | default value: https://login.microsoftonline.com/ | A parameter that allows you to override the login URL. Info |
---|
This parameter should be removed if it is not used. |
| override_scope_value
| str
| optional | default value: https://graph.microsoft.com/.default | A parameter that allows you to override the scope value. Info |
---|
This parameter should be removed if it is not used. |
| override_query_window_max_seconds
| int
| optional | default value: None | |
|