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
Tableevents, but mandatory for those that createLookups.In the Parameters section, establish the Collector Parameters as follows below:
Editing the JSON configuration
{
"global_overrides": {
"debug": false
},
"inputs": {
"akamai_siem": {
"id": "<short_unique_id>",
"enabled": true,
"credentials": {
"access_token": "<access_token_value>",
"client_secret": "<client_secret_value>",
"client_token": "<client_token_value>"
},
"environment": "<environment_value>",
"services": {
"security_events": {
"host": "<host_value>",
"configs_id": "<configs_id_value>",
"override_base_tag": "<override_base_tag_value>",
"override_logs_limit": "<override_logs_limit_value>",
"override_decode_attack_data_rules": "<override_decode_attack_data_rules_value>",
"request_period_in_seconds": "<request_period_in_seconds_value>"
}
}
}
}
} |
Example:
{
"global_overrides": {
"debug": false
},
"inputs": {
"example_input": {
"id": "123456",
"enabled": true,
"credentials": {
"access_token": "your_access_token",
"client_secret": "your_client_secret",
"client_token": "your_client_token"
},
"environment": "prod",
"services": {
"security_events": {
"host": "apiakamai.net",
"configs_id": "1234;5678;91011"
}
}
}
}
} |
The following table outlines the parameters available for configuring the collector. Each parameter is categorized by its necessity (mandatory or optional), data type, acceptable values or formats, and a brief description.
Parameter | Data Type | Requirement | Value Range / Format | Description |
|---|---|---|---|---|
|
| Mandatory | Min length: 1 | Unique identifier for the collector instance. |
|
| Mandatory | true, false | Indicates whether the collector is active. |
|
| Mandatory | Min length: 1 | API access token for Akamai SIEM authentication. |
|
| Mandatory | Min length: 1 | Secret key used for secure API requests. |
|
| Mandatory | Min length: 1 | Token used to identify the client in API requests. |
|
| Optional | Example: dev, prod | Specifies the environment. Use |
|
| Mandatory | Host URL when making endpoint requests. | Host URL when making endpoint requests. |
|
| Mandatory | Example: 1111 or 1111;2222;3333 | List of security configuration IDs provided by the vendor. |
|
| Optional | Example: my.app.test.1 | Overrides the default collector tag ( |
|
| Optional | Default: 10000 | Maximum number of logs to retrieve in one API request. |
|
| Optional | true, false | Boolean flag to decode attackData.rule fields. Defaults to |
|
| Optional | Default: 60 | Frequency of requests in seconds. |
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 |
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.
Replace |
Editing the config.yaml file
globals:
debug: false
id: not used
name: akamai_siem
persistence:
type: filesystem
config:
directory_name: state
outputs:
devo_1:
type: devo_platform
config:
address: <devo_address>
chain: <chain_filename>
cert: <cert_filename>
key: <key_filename>
inputs:
akamai_siem:
id: <short_unique_id>
enabled: true
credentials:
access_token: <access_token_value>
client_secret: <client_secret_value>
client_token: <client_token_value>
environment: <environment_value>
services:
security_events:
host: <host_value>
configs_id: <configs_id_value>
override_base_tag: <override_base_tag_value>
override_logs_limit: <override_logs_limit_value>
override_decode_attack_data_rules: <override_decode_attack_data_rules_value>
request_period_in_seconds: <request_period_in_seconds_value> |
Example:
globals:
debug: false
id: not_used
name: akamai-siem-collector
persistence:
type: filesystem
config:
directory_name: state
outputs:
devo_1:
type: devo_platform
config:
address: collector-eu.devo.io
port: 443
type: SSL
chain: chain.crt
cert: example.crt
key: example.key
inputs:
akamai-siem:
id: "123456"
enabled: true
environment: "prod"
credentials:
access_token: "your_access_token"
client_secret: "your_client_secret"
client_token: "your_client_token"
services:
security_events:
host: "apiakamai.net"
configs_id: "1234;5678;91011" |
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 | Requirement | Value Range / Format | Description |
|---|---|---|---|---|
|
|
| Example: logs.example.devo.com | The Devo address where logs will be sent. |
|
|
| Min length: | The filename of the chain certificate downloaded from Devo. Example: chain.crt. |
|
|
| Min length: | The filename of your certificate downloaded from Devo. Example: your_domain.crt. |
|
|
| Min length: | The filename of your private key downloaded from Devo. Example: your_domain.key. |
|
|
| Min length: | Unique identifier for the collector instance. |
|
|
|
| Indicates whether the collector is active. |
|
|
| Min length: | API access token for Akamai SIEM authentication. |
|
|
| Min length: | Secret key used for secure API requests. |
|
|
| Min length: | Token used to identify the client in API requests. |
|
|
| Example: | Specifies the environment. Use |
|
|
| Host URL when making endpoint requests. | Host URL when making endpoint requests. |
|
|
| Example: | List of security configuration IDs provided by the vendor. |
|
|
| Example: | Overrides the default collector tag ( |
|
|
| Default: | Maximum number of logs to retrieve in one API request. |
|
|
|
| Boolean flag to decode attackData.rule fields. Defaults to |
|
|
| Default: | Frequency of requests in seconds. |
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:
gunzip -c <image_file>-<version>.tgz | docker load |
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>/
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> |
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.
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 |
Replace |