Cyble Vision collector

[ 1 Overview ] [ 2 Devo collector features ] [ 3 Data sources ] [ 4 Minimum configuration required for basic pulling ] [ 5 Accepted authentication methods ] [ 6 Run the collector ] [ 7 Collector services detail ] [ 8 Collector operations ] [ 9 Change log ]

Overview

Cyble Vision is a comprehensive cybersecurity platform designed to keep businesses a step ahead of cyber threats. Cyble Vision swiftly identifies incidents and provides advanced intelligence for rapid response, helping to mitigate attack damages. The Cyble Vision collector allows users to fetch and analyze incidents and fetch IOCs for further triage in the Devo platform.

Devo collector features

Feature	Details

Feature	Details
Allow parallel downloading (`multipod`)	`not allowed`
Running environments	`collector server` `on-premise`
Populated Devo events	`table` `lookups`
Flattening preprocessing	`no`
Allowed source events obfuscation	`yes`

Data sources

Data source	Description	API endpoint	Collector service name	Devo table / lookup	Available from release

Data source	Description	API endpoint	Collector service name	Devo table / lookup	Available from release
Alerts	Fetch alerts / incidents	`/apollo/api/v1/y/alerts`	`alerts`	`threatintel.cyble.vision.alert`	`v1.0.0`
IOCs	Fetch IOCs and store in a Devo lookup	`/engine/api/v2/y/iocs`	`iocs`	Lookup starting with `cyble_vision_iocs`	`v1.0.0`

For more information on how the events are parsed, visit our page.

Minimum configuration required for basic pulling

Although this collector supports advanced configuration, the fields required to retrieve data with basic configuration are defined below.

This minimum configuration refers exclusively to those specific parameters of this integration. There are more required parameters related to the generic behavior of the collector. Check setting sections for details.

Setting	Details

Setting	Details
`api_key`	API key

See the Accepted authentication methods section to verify what settings are required based on the desired authentication method.

Accepted authentication methods

Setting	Details

Setting	Details
`api_key`	Required

Run the collector

Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector).

Collector services detail

This section is intended to explain how to proceed with specific actions for services.

Internal process and deduplication method

All Cyble Vision alerts/incidents data are fetched utilizing the created_at attribute as the datetime key. A unique hash value is computed for each event and used for deduplication purposes to ensure events are not fetched multiple times in subsequent pulls.

Devo categorization and destination

All events of this service are ingested into the table threatintel.cyble.vision.alert

Setup output

A successful run has the following output messages for the setup module:

2023-06-25T15:17:28.020    INFO InputProcess::MainThread -> AlertsPuller(cyble_vision,10001,alerts,predefined) - Starting thread
2023-06-25T15:17:28.020 WARNING InputProcess::AlertsPuller(cyble_vision,10001,alerts,predefined) -> Waiting until setup will be executed
2023-06-25T15:17:28.021 WARNING InputProcess::VisionPullerSetup(unknown,cyble_vision#10001,alerts#predefined) -> The token/header/authentication has not been created yet
2023-06-25T15:17:28.021    INFO InputProcess::VisionPullerSetup(unknown,cyble_vision#10001,alerts#predefined) -> Making sample request to test authentication.
2023-06-25T15:17:28.032    INFO InputProcess::MainThread -> [GC] global: 39.6% -> 39.5%, process: RSS(55.02MiB -> 55.02MiB), VMS(390.52GiB -> 390.52GiB)
2023-06-25T15:17:28.879    INFO InputProcess::VisionPullerSetup(unknown,cyble_vision#10001,alerts#predefined) -> Authentication successful.
2023-06-25T15:17:28.879    INFO InputProcess::VisionPullerSetup(unknown,cyble_vision#10001,alerts#predefined) -> Setup for module <AlertsPuller> has been successfully executed

Puller output

A successful initial run has the following output messages for the puller module:

023-06-25T15:17:29.021    INFO InputProcess::AlertsPuller(cyble_vision,10001,alerts,predefined) -> AlertsPuller(cyble_vision,10001,alerts,predefined) Starting the execution of pre_pull()
2023-06-25T15:17:29.022    INFO InputProcess::AlertsPuller(cyble_vision,10001,alerts,predefined) -> Reading persisted data
2023-06-25T15:17:29.022    INFO InputProcess::AlertsPuller(cyble_vision,10001,alerts,predefined) -> Data retrieved from the persistence: {'@persistence_version': 1, 'start_time_in_utc': '2023-06-22T04:23:01Z', 'last_event_time_in_utc': '2023-06-25T16:18:31Z', 'last_ids': ['4aa6ac9c-4ba4-568f-a021-f97baceb0f2b'], 'next_offset': 0}
2023-06-25T15:17:29.023    INFO InputProcess::AlertsPuller(cyble_vision,10001,alerts,predefined) -> Running the persistence upgrade steps
2023-06-25T15:17:29.024    INFO InputProcess::AlertsPuller(cyble_vision,10001,alerts,predefined) -> Running the persistence corrections steps
2023-06-25T15:17:29.024    INFO InputProcess::AlertsPuller(cyble_vision,10001,alerts,predefined) -> Running the persistence corrections steps
2023-06-25T15:17:29.025    INFO InputProcess::AlertsPuller(cyble_vision,10001,alerts,predefined) -> No changes were detected in the persistence
2023-06-25T15:17:29.025    INFO InputProcess::AlertsPuller(cyble_vision,10001,alerts,predefined) -> AlertsPuller(cyble_vision,10001,alerts,predefined) Finalizing the execution of pre_pull()
2023-06-25T15:17:29.026    INFO InputProcess::AlertsPuller(cyble_vision,10001,alerts,predefined) -> Starting data collection every 60 seconds
2023-06-25T15:17:29.026    INFO InputProcess::AlertsPuller(cyble_vision,10001,alerts,predefined) -> Pull Started
2023-06-25T15:17:29.027    INFO InputProcess::AlertsPuller(cyble_vision,10001,alerts,predefined) -> Fetching all alerts subject to the following parameters: {'orderBy': [{'created_at': 'asc'}], 'skip': 0, 'take': 1000, 'withDataMessage': True, 'where': {'created_at': {'gte': '2023-06-25T16:18:31Z', 'lte': '2023-06-25T22:17:29Z'}}}
2023-06-25T15:17:32.550    INFO InputProcess::AlertsPuller(cyble_vision,10001,alerts,predefined) -> 61 record(s) returned for last batch which is less than limit of 1000. No new records remaining. Finishing pull.
2023-06-25T15:17:32.551    INFO InputProcess::AlertsPuller(cyble_vision,10001,alerts,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1687731449021):Number of requests made: 1; Number of events received: 61; Number of duplicated events filtered out: 1; Number of events generated and sent: 60; Average of events per second: 17.025.

After a successful collector’s execution (that is, no error logs found), you will see the following log message:

2023-06-25T15:17:32.551    INFO InputProcess::AlertsPuller(cyble_vision,10001,alerts,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1687731449021):Number of requests made: 1; Number of events received: 61; Number of duplicated events filtered out: 1; Number of events generated and sent: 60; Average of events per second: 17.022.
2023-06-25T15:17:32.552    INFO InputProcess::AlertsPuller(cyble_vision,10001,alerts,predefined) -> The data is up to date!
2023-06-25T15:17:32.552    INFO InputProcess::AlertsPuller(cyble_vision,10001,alerts,predefined) -> Data collection completed. Elapsed time: 3.531 seconds. Waiting for 56.469 second(s) until the next one

This collector uses persistent storage to download events in an orderly fashion and avoid duplicates. In case you want to re-ingest historical data or recreate the persistence, you can restart the persistence of this collector by following these steps:

Edit the configuration file.
Change the value of the start_time_in_utc parameter to a different one.
Save the changes.
Restart the collector.

The collector will detect this change and will restart the persistence using the parameters of the configuration file or the default configuration in case it has not been provided.

Note that this action clears the persistence and cannot be recovered in any way. Resetting persistence could result in duplicate or lost events.

Internal process and deduplication method

All Cyble Vision IOCs are fetched using the standard start/end date querying method via the API and sorted by the last_seen field. By default, the following fields are extracted for each indicator and stored in Devo as a lookup table (default name: cyble_vision_iocs):

ioc
first_seen
last_seen
risk_rating
confident_rating
ioc_type
Attack_id

The ioc field acts as the key. When an indicator is fetched again (for example, the indicator was observed occurring on a newer date, an indicator was updated, etc.), the indicator will be updated in the lookup table.

Devo categorization and destination

All events of this service are ingested into the lookup table. By default, the lookup name is cyble_vision_iocs.

This collector has different security layers that detect both an invalid configuration and abnormal operation. This table will help you detect and resolve the most common errors.

Error Type	Error Id	Error Message	Cause	Solution
`SetupError`	`102`	Failed to fetch data from `{endpoint}`. Source is not pullable.	The provided credentials are incorrect.	Revisit the configuration steps and ensure that the correct values were specified in the config file.

Collector operations

This section is intended to explain how to proceed with specific operations of this collector.

Initialization

The initialization module is in charge of setup and running the input (pulling logic) and output (delivering logic) services and validating the given configuration.

A successful run has the following output messages for the initializer module:

Events delivery and Devo ingestion

The event delivery module is in charge of receiving the events from the internal queues where all events are injected by the pullers and delivering them using the selected compatible delivery method.

A successful run has the following output messages for the initializer module:

Sender services

The Integrations Factory Collector SDK has 3 different senders services depending on the event type to delivery (internal, standard, and lookup). This collector uses the following Sender Services:

Sender services	Description

Sender services	Description
`internal_senders`	In charge of delivering internal metrics to Devo such as logging traces or metrics.
`standard_senders`	In charge of delivering pulled events to Devo.

Sender statistics

Each service displays its own performance statistics that allow checking how many events have been delivered to Devo by type:

Logging trace	Description

Logging trace

Description

Number of available senders: 1

Displays the number of concurrent senders available for the given Sender Service.

sender manager internal queue size: 0

Displays the items available in the internal sender queue.

Standard - Total number of messages sent: 57, messages sent since "2023-01-10 16:09:16.116750+00:00": 0 (elapsed 0.000 seconds

Displayes the number of events from the last time and following the given example, the following conclusions can be obtained:

44 events were sent to Devo since the collector started.
The last checkpoint timestamp was 2023-01-10 16:09:16.116750+00:00.
21 events where sent to Devo between the last UTC checkpoint and now.
Those 21 events required 0.007 seconds to be delivered.

Change log

Release	Released on	Release type	Details	Recommendations

Release	Released on	Release type	Details	Recommendations
`v1.0.0`	Sep 11, 2023	INITIAL RELEASE	-	`Recommended version`