Rw tab |
---|
title | On-premise collector |
---|
|
This data collector can be run on any machine with the Docker service available because it should be executed as a Docker container. The following sections explain how to prepare all the required setup to have 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: not_used
name: <collector_name>
persistence:
type: filesystem
config:
directory_name: state
outputs:
devo_1:
type: devo_platform
config:
address: <devo_address>
port: 443
type: SSL
chain: <chain_filename>
cert: <cert_filename>
key: <key_filename>
inputs:
qualys:
id: <short_unique_id>
enabled: true
environment: <environment_value>
credentials:
hostname: <hostname_value>
username: <username_value>
password: <password_value>
services:
vm_scans::
request_period_in_seconds: <request_period_in_seconds_value>
override_tag: <override_tag_value>
start_time_utc: <start_time_in_utc_value>
user_activity::
request_period_in_seconds: <request_period_in_seconds_value>
override_tag: <override_tag_value>
start_time_utc: <start_time_in_utc_value>
host_list::
request_period_in_seconds: <request_period_in_seconds_value>
override_tag: <override_tag_value>
start_time_utc: <start_time_in_utc_value>
filters: <host_filters_value>
host_list_detection::
request_period_in_seconds: <request_period_in_seconds_value>
override_tag: <override_tag_value>
start_time_utc: <start_time_in_utc_value>
filters: <host_filters_detection_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 | Details | collector_name
| str
| Mandatory | Minimum length: 1 | Use this param to give a 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. | short_unique_id
| int
| Mandatory | Minimum length: 1 Maximum length: 5 | Use this param to give an unique id to this input service. Note |
---|
This parameter is used to build the persistence address, do not use the same value for multiple collectors. It could cause a collision. |
| environment_value
| str
| Optional | Minimum length: 1 | This is an optional control parameter that is injected into the events and allows to differentiate the environment. For example: dev and prod. Info |
---|
This parameter should be removed if it is not used. |
| hostname_value
| str
| Mandatory | Minimum length: 1 | The Qualys hostname. This must be supplied by every customer that wants to use this collector. For the "hostname", you can identify it in https://www.qualys.com/platform-identification/ Please, note that the hostname should not include the https:// protocol prefix. | username_value
| str
| Mandatory | Minimum length: 1 | The Qualys username. To find out how to get it, see the Vendor Setup guide. | password_value
| str
| Mandatory | Minimum length: 1 | The Qualys password. To find out how to get it, see the Vendor Setup guide. | 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 can be removed or commented. |
| start_time_utc_value
| str
| Optional | UTC datetime string having datetime string format %Y-%m-%dT%H:%M:%SZ (e.g., “2023-07-11T01:23: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. |
| request_period_in_seconds_value
| int
| Optional | minimum length: 1 | Period in seconds used between each data pulling. This value will overwrite the default value (60 seconds). Info |
---|
This parameter can be removed or commented. |
| host_filters_value
| dict
| Optional | Filter values:: details={All|All/AGs} show_asset_id={0|1} show_tags={0|1} show_cloud_tags={0|1} For more information check: https://cdn2.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#page=641 | Example of use: Code Block |
---|
filters:
details: All
show_asset_id: “1”,
show_cloud_tags: “0” |
Info |
---|
This parameter can be removed or commented. |
| host_detection_filters_value
| dict
| Optional | show_asset_id={0|1} show_tags={0|1} show_reopened_info={0|1} status={New|Fixed|Active|Re-Opened} For more information check: https://cdn2.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#page=641 | Example of use: Code Block |
---|
filters:
details: All ,
show_tags: “1”
show_reopened_info: “0”,
status:
- New
- Fixed |
Info |
---|
This parameter can be removed or commented. |
|
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: Collector Docker image | SHA-256 hash |
---|
collector-qualys-docker-image-2.12.0.tgz | c39bd58279b9f43f340489f9a1e792eaeab35a09e8074433b05c8ce44c7b1e46 37fa4bdb912875575e9c4ef037c77019d6b82ce98e79d8e95b3d558c37c7c83d
|
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. 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": {
"qualys": {
"id": "<short_unique_id>",
"enabled": true,
“environment”: “<environment_value>”,
"credentials": {
"hostname": "<hostname_value>",
"username": "<username_value>",
"password": "<password_value>"
},
"services": {
"vm_scans": {
"request_period_in_seconds": <request_period_in_seconds_value>,
"override_tag": <override_tag_value>,
"start_time_utc": <start_time_in_utc_value>
},
"user_activity": {
"request_period_in_seconds": <request_period_in_seconds_value>,
"override_tag": <override_tag_value>,
"start_time_utc": <start_time_in_utc_value>
},
"host_list": {
"request_period_in_seconds": <request_period_in_seconds_value>,
"override_tag": <override_tag_value>,
"start_time_utc": <start_time_in_utc_value>,
"filters": <host_filters_value>
},
"host_list_detection": {
"request_period_in_seconds": <request_period_in_seconds_value>,
"override_tag": <override_tag_value>,
"start_time_utc": <start_time_in_utc_value>,
"filters": <host_detection_filters_value>
}
}
}
}
} |
Please replace the placeholders with real world values following the description table below: Parameter | Data type | Type | Value range | Details | collector_name
| str
| Mandatory | Minimum length: 1 | Use this param to give a 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. | short_unique_id
| int
| Mandatory | Minimum length: 1 Maximum length: 5 | Use this param to give an unique id to this input service. Note |
---|
This parameter is used to build the persistence address, do not use the same value for multiple collectors. It could cause a collision. |
| environment_value
| str
| Optional | Minimum length: 1 | This is an optional control parameter that is injected into the events and allows to differentiate the environment. For example: dev and prod. Info |
---|
This parameter should be removed if it is not used. |
| hostname_value
| str
| Mandatory | Minimum length: 1 | The Qualys hostname. This must be supplied by every customer that wants to use this collector. For the "hostname", you can identify it in https://www.qualys.com/platform-identification/ Please, note that the hostname should not include the https:// protocol prefix. | username_value
| str
| Mandatory | Minimum length: 1 | The Qualys username. To find out how to get it, see the Vendor Setup guide. | password_value
| str
| Mandatory | Minimum length: 1 | The Qualys password. To find out how to get it, see the Vendor Setup guide. | 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 can be removed or commented. |
| start_time_utc_value
| str
| Optional | UTC datetime string having datetime string format %Y-%m-%dT%H:%M:%SZ (e.g., “2023-07-11T01:23: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. |
| request_period_in_seconds_value
| int
| Optional | minimum length: 1 | Period in seconds used between each data pulling. This value will overwrite the default value (60 seconds). Info |
---|
This parameter can be removed or commented. |
| host_filters_value
| dict
| Optional | Filter values:: details={All|All/AGs} show_asset_id={0|1} show_tags={0|1} show_cloud_tags={0|1} For more information check: https://cdn2.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#page=641 | Example of use: Code Block |
---|
filters:
details: All
show_asset_id: “1”,
show_cloud_tags: “0” |
Info |
---|
This parameter can be removed or commented. |
| host_detection_filters_value
| dict
| Optional | show_asset_id={0|1} show_tags={0|1} show_reopened_info={0|1} status={New|Fixed|Active|Re-Opened} For more information check: https://cdn2.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#page=641 | Example of use: Code Block |
---|
filters:
details: All ,
show_tags: “1”
show_reopened_info: “0”,
status:
- New
- Fixed |
Info |
---|
This parameter can be removed or commented. |
|
|