| 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.  Image Removed Image Added| Note |
|---|
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
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:
socradar:
id: <input_id>
enabled: true
credentials:
api_key: <api_key>
company_id: <company_id>
requests_limits:
- period: 1m
number_of_requests: <request_per_minute>
services:
incidents:
tag: <tag>
initial_start_time_in_utc: <initial_start_time_in_utc>
audit_logs:
tag: <tag>
initial_start_time_in_utc: <initial_start_time_in_utc>
threat_feed:
initial_start_time_in_utc: <initial_start_time_in_utc>
collections:
- IP:
lookup_name: <socradar_custom_lookup_name>
include_collections: []
exclude_collections: []
- Domain:
lookup_name: <socradar_custom_lookup_name>
include_collections: [ ]
exclude_collections: [ ]
- URL:
lookup_name: <socradar_custom_lookup_name>
include_collections: [ ]
exclude_collections: [ ]
- Hash:
lookup_name: <socradar_custom_lookup_name>
include_collections: [ ]
exclude_collections: [ ] |
| 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 |
|---|
<debug_status>
| bool
| Mandatory
| false / true
| This will make the collector generate (or not) log messages with the DEBUG level. | collector_id
| int | mandatory | minimum length: 1 maximum length: 5 | Use this parameter to give a unique ID to this collector. | collector_name
| str | mandatory | minimum length: 1 maximum length: 10 | Use this parameter to give a valid name to this collector. | devo_address
| str | mandatory | 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. | input_id
| int | 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. | api_key
| str | mandatory | | The key obtained from SOCRadar for authentication. | company_id
| str | mandatory | | A company identification given by SOCRadar. | request_per_minute
| int | mandatory | | A rate limit value. A value of -1 means no restriction (not recommended). A typical value is 4 or 16, depending of the contracted plan with SOCRadar.
See “API limitations” section. | initial_start_time_in_utc
| str | optional | UTC datetime string | 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. | tag
| str | optional | Devo tag-friendly string (no special characters, spaces, etc.) | An optional tag that allows users to override the service default tags. (see predefined tag names above) | socradar_custom_lookup_name
| str | optional | Valid name for a lookup (no special characters, no spaces) | Optional name for the lookup.. See the predefinied list of names above. |
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 <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: 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. 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": false
},
"inputs": {
"socradar": {
"id": "<input_id>",
"enabled": true,
"credentials": {
"api_key": "<api_key>",
"company_id": "<company_id>"
},
"requests_limits": [
{
"period": "1m",
"number_of_requests": "<request_per_minute>"
}
],
"services": {
"incidents": {
"tag": "<tag>",
"initial_start_time_in_utc": "<initial_start_time_in_utc>"
},
"audit_logs": {
"tag": "<tag>",
"initial_start_time_in_utc": "<initial_start_time_in_utc>"
},
"threat_feed": {
"initial_start_time_in_utc": "<initial_start_time_in_utc>",
"collections": [
{
"IP": {
"lookup_name": "<socradar_custom_lookup_name>",
"include_collections": [],
"exclude_collections": []
}
},
{
"Domain": {
"lookup_name": "<socradar_custom_lookup_name>",
"include_collections": [],
"exclude_collections": []
}
},
{
"URL": {
"lookup_name": "<socradar_custom_lookup_name>",
"include_collections": [],
"exclude_collections": []
}
},
{
"Hash": {
"lookup_name": "<socradar_custom_lookup_name>",
"include_collections": [],
"exclude_collections": []
}
}
]
}
}
}
}
} |
| 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. | input_id
| int | 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. | api_key
| str | mandatory | | The key obtained from SOCRadar for authentication. | company_id
| str | mandatory | | A company identification given by SOCRadar. | request_per_minute
| int | mandatory | | A rate limit value. A value of -1 means no restriction (not recommended). A typical value is 4 or 16, depending of the contracted plan with SOCRadar.
See “API limitations” section. | initial_start_time_in_utc
| str | optional | UTC datetime string | 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. | tag
| str | optional | Devo tag-friendly string (no special characters, spaces, etc.) | An optional tag that allows users to override the service default tags. (see predefined tag names above) | socradar_custom_lookup_name
| str | optional | Valid name for a lookup (no special characters, no spaces) | Optional name for the lookup.. See the predefinied list of names above. |
 Image Added |
