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. | 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 IntSights collector: | Code Block |
|---|
<any_directory>
└── devo-collectors/
└── devo-collector-intsights/
├── certs/
│ ├── chain.crt
│ ├── <your_domain>.key
│ └── <your_domain>.crt
└── config/
└── config-intsight.yaml |
Devo credentialsIn Devo, go to Administration → Credentials → X.509 Certificates, download the Certificate, Private key and Chain CA and save them in devo-collector-intsights/certs/. Learn more about security credentials in Devo here.  Editing the config.yaml file| Code Block |
|---|
globals:
debug: <debug_value>
id: not_used
name: <name_collector>
persistence:
type: filesystem
config:
directory_name: state
outputs:
devo_1:
type: devo_platform
config:
address: <devo_address>
port: 443
type: SSL
chain: <chain_filename.crt>
cert: <cert_filename.crt>
key: <key_filename.key>
inputs:
intsights:
id: <input_id>
enabled: <input_status>
credentials:
client_id: <client_id>
api_key: <key_id>
base_url: <base_url>
services:
iocs_list_ips:
request_period_in_seconds: <request_period_in_seconds_ips> # Optional
days_to_look_back: <days_to_look_back_ips>
iocs_list_domains:
request_period_in_seconds: <request_period_in_seconds_domains> # Optional
days_to_look_back: <days_to_look_back_domains>
iocs_list_hashes:
request_period_in_seconds: <request_period_in_seconds_hashes> # Optional
days_to_look_back: <days_to_look_back_hashes>
iocs_list_urls:
request_period_in_seconds: <request_period_in_seconds_urls> # Optional
days_to_look_back: <days_to_look_back_urls>
iocs_list_emails:
request_period_in_seconds: <request_period_in_seconds_emails> # Optional
days_to_look_back: <days_to_look_back_emails> |
Replace the placeholders with your corresponding values: Parameter | Data type | Type | Value range | Details |
|---|
id_collector
| int | Mandatory | Minimum length: 1
Maximum length: 5 | Use this param to give a unique ID to this collector (not used) | name_collector
| str | Mandatory | Minimum length: 1
Maximum length: 10 | Use this param to give a valid name to this collector. | debug_value
| bool | Mandatory | false / true | Use this param to enable or disable the debug logging level. | devo_address
| str | Mandatory | | Use this param to identify the Devo Cloud where the events will be sent. | chain_filename
| str | Mandatory | Minimum length: 4
Maximum length: 20 | Use this param 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 param to identify the file.cert downloaded from your Devo domain. | key_filename
| str | Mandatory | Minimum length: 4
Maximum length: 20 | Use this param to identify the file.key downloaded from your Devo domain. | input_id
| int | Mandatory | Minimum length: 1
Maximum length: 5 | Use this param to give an unique id to this input service, (for instance 147 or 456) | input_status
| bool | Mandatory | false / true | If the value is true, the input definition will be executed. If the value is false, the service will be ignored. | client_id
| str | Mandatory | Minimum length: 1 | This is the client_id given by Rapid7 IntSights | api_key
| str | Mandatory | Minimum length: 1 | This is the api_key given by Rapid7 IntSights | base_url
| str | Mandatory | Regex: ^(https?:\/\/)?([\da-z\.-]+)\.([a-z\.])([\/\w \.-]*)*([a-z])$ | The URL of endpoint for IntSights API access. This value is given by Rapid7 console. A common value for base_url is usually https://api.intsights.com | request_period_in_seconds
| int | Mandatory | Minimum value: 1800 | Period in seconds used between each IoC pulling related data source. Use the following periods as reference: Run every 30 min → 1800 sec Run every 1 hour → 3600 sec Run every 6 hours → 21600 sec Run every 12 hours → 43200 sec Run every 24 hours → 86400 sec
The IoC list changes very slowly, so it does not make sense to request it very frequently, in many installations it is enough to request it a few times a day. As the list is long, in any case a small request period (less than some minutes) is not advised. | days_to_look_back
| int | Mandatory | Minimum value: 1
Maximum value: 5 | The collector asks the API for all the IoCs from present moment to some days back, minimum in the last day (1 day back). Usual values for services: emails → 5 urls → 5 hashes → 5 domains → 5 ips → 2
|
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-rapid7-intsights-docker-image-<version>.tgz | docker load |
| Info |
|---|
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/devo-collector-intsights/ | Code Block |
|---|
docker run \
--name collector-rapid7-intsights\
--volume $PWD/certs:/devo-collector/certs \
--volume $PWD/config:/devo-collector/config \
--volume $PWD/state:/devo-collector/state \
--env CONFIG_FILE=config.yaml \
--rm -it docker.devo.internal/collectors/rapid7-intsights:<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/devo-collector-intsights/ directory. | Code Block |
|---|
version: '3'
services:
intsights:
build:
context: .
dockerfile: Dockerfile
image: docker.devo.internal/collectors/rapid7-intsights:${IMAGE_VERSION:-latest}
container_name: collector-rapid7-intsights
volumes:
- ./certs:/devo-collector/certs
- ./config:/devo-collector/config
- ./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/devo-collector-intsights/ directory: | Code Block |
|---|
IMAGE_VERSION=<version> docker-compose up -d |
| Note |
|---|
Replace <version> with the required value. |
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 | 
