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:
| Info |
|---|
Replace the placeholders <short_unique_identifier>, <access_key> and <x_api_secret_key> with the values obtained in previous sections of this document, except the <short_unique_identifier> that can have the value you choose. |
Editing the JSON configuration| Code Block |
|---|
{
"tenable_io": {
"id": "<short_unique_identifier>",
"enabled": true,
"autoconfig": {
"enabled": true,
"refresh_interval_in_seconds": 600
},
"credentials": {
"access_key": "<access_key>",
"secret_key": "<x_api_secret_key>"
},
"services": {
"agents": {
"request_period_in_seconds": 43200
},
"export_assets": {
"request_period_in_seconds": 86400
},
"audit_log": {
"request_period_in_seconds": 60,
"start_time": "2021-03-10"
},
"plugins": {
"request_period_in_seconds": 86400,
"start_time": "2021-03-10"
},
"scanners": {
"request_period_in_seconds": 43200
},
"scans": {
"request_period_in_seconds": 43200
},
"export_vulnerabilities": {
"request_period_in_seconds": 86400,
"since_epoch": 0,
"severities": [
"critical",
"high",
"medium"
],
"statuses": [
"open",
"reopened"
]
}
}
}
} |
| Info |
|---|
The value chosen for the id field will be used internally for having independent persistence areas. |
 | 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 Tenable.io collector: | Code Block |
|---|
<any_directory>
└── devo-collectors/
└── tenable/
├── certs/
│ ├── chain.crt
│ ├── <your_domain>.key
│ └── <your_domain>.crt
└── config/
└── config-tenable.yaml |
Devo credentialsIn Devo, go to Administration → Credentials → X.509 Certificates, download the Certificate, Private key and Chain CA and save them in <any directory>/devo-collectors/tenable/certs. Learn more about security credentials in Devo here.  Editing the config.yaml fileIn the config.yaml file, replace the <short_unique_identifier>, <x_api_key>.crt, and <secret_key> values and enter the ones that you got in the previous steps. In the <short_unique_identifier> placeholder, enter the value that you choose. | Code Block |
|---|
globals:
debug: false # Setup as True or False for debugging mode
id: not_used
name: tenable-io
persistence: # Persistence setup filesystem
type: filesystem
config:
directory_name: state # Persistence directory
outputs:
devo_1:
type: devo_platform
config:
address: collector-eu.devo.io # Devo platform address EU (for US use: collector-us.devo.io)
port: 443
type: SSL
chain: chain.crt
cert: <your_domain>.crt
key: <your_domain>.key
inputs:
tenable_io:
id: <1> # The value of this field will be used internally for having independent persistence areas
enabled: true
debug: true
credentials:
access_key: <access_key> # Tenable access key
secret_key: <secret_key> # Tenable secret key
services:
agents:
request_period_in_seconds: 43200 # 12 hours - Setting up request period in seconds.
export_assets:
request_period_in_seconds: 86400 # 24 hours
audit_log:
request_period_in_seconds: 60
start_time: "2021-03-10" # Start time for pulling data from - format date YYYY-MM-DD
plugins:
request_period_in_seconds: 86400 # 24 hours
start_time: "2021-03-15" # Start time for pulling data from
scanners:
request_period_in_seconds: 43200
scans:
request_period_in_seconds: 43200
export_vulnerabilities:
request_period_in_seconds: 43200 # 12 hours
since_epoch: 0
severities:
- critical
- high
- medium
#- low
#- info
statuses:
- open
- reopened |
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-tenable-docker-image-1.34.0.tgz | a5e6ff3846fd7f67f9c7b6e021282a3113650a001810173705c32757da720e6ef033e03e0dbd0f6be73794dd81cc897994f16fafdf501edf42c100681f437860
|
Use the following command to add the Docker image to the system: | Code Block |
|---|
$ gunzip -c collector-tenable-docker-image-<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 "<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/tenable/ | Code Block |
|---|
docker run \
--name collector-tenable-io \
--volume $PWD/certs:/devo-collector/certs \
--volume $PWD/config:/devo-collector/config \
--volume $PWD/state:/devo-collector/state \
--env CONFIG_FILE=config-tenable-io.yaml \
--rm -it docker.devo.internal/collector/tenable-io:<version> |
| Note |
|---|
Replace <version> with the required value. |
Docker ComposeThe following Docker Compose file can be used to execute the Docker container. It must be created in the <any_directory>/devo-collectors/tenable/ directory. | Code Block |
|---|
version: '3'
services:
collector-tenable-io:
build:
context: .
dockerfile: Dockerfile
image: docker.devo.internal/collector/tenable-io:${IMAGE_VERSION:-latest}
container_name: tenable-io-collector
volumes:
- ./certs:/devo-collector/certs
- ./config:/devo-collector/config
- ./state:/devo-collector/state
environment:
- CONFIG_FILE=${CONFIG_FILE:-config-tenable-io.yaml} |
To run the container using docker-compose, execute the following command from the <any_directory>/devo-collectors/tenable/ directory: | Code Block |
|---|
IMAGE_VERSION=<version> docker-compose up -d |
| Note |
|---|
Replace <version> with the required value. |
| 
