SIEMs
IBM QRadar
Prerequisites
IBM QRadar On-premises version 7.3.3 (Patch 6).
Bitdefender GravityZone On-premises minimum version 6.23.x with Syslog protocol enabled using either TCP or UDP.
GravityZone Integration with IBM QRadar
This integration provides you with the possibility to better monitor GravityZone events using IBM QRadar. Bitdefender App for QRadar is a device support module (DSM) that provides the categorization of events according to QRadar high and low level threat categories allowing a QRadar administrator to perform complex searches, cross-correlations across multiple event types and sources and perform threat-hunting activities that include in-depth information reported by GravityZone technology layers.
To allow GravityZone to send notifications to the QRadar instance using the Syslog protocol:
Connect to the GravityZone Control Center.
Go to the Configuration page and click Miscellaneous.
Select the Enable Syslog check box.
Enter the IP address of the QRadar instance, the preferred protocol and the port Syslog listens to.
Select the format Common Event Format (CEF) to send the data to the Syslog server.
Click the Add button from the Action column.
Enable Syslog
To select the events you want to receive on the QRadar instance:
Connect to the GravityZone Control Center.
Click the Notification button at the right side of the menu bar and then click the Settings icon.
Under Enable Notification section, choose the type of notifications you want to receive from GravityZone and select the Log to server checkbox.
For more information, refer to Notification Types.
Application Deployment in QRadar
To install the Bitdefender App for QRadar in IBM QRadar:
Log in to IBM QRadar.
QRadar login
Click the Admin tab.
Under the System Configuration section, click Extensions Management. A new window will open.
Click the Add button from the right side and then Browsefor the installation kit.
Select Install immediately, and then click Add.
Click Install.
You can find the application in the Extensions Management window after the installation is complete.
Bitdefender App for QRadar
Log Sources Configuration
To receive the security events in the QRadar instance follow these steps:
Click the Admin tab.
Under the Data Sources > Events section, click Log Sources.
Double click the Bitdefender CEF Syslog log source. A configuration window will open.
In the Log Source Identifier field, type the hostname of the GravityZone appliance. The default hostname is: gzva
Log Source Configuration
Click Save and close the window.
Click Deploy Changes on the upper left side of the page to activate your new log source.
Saved Searches
To help you in identifying the security events Bitdefender App for QRadar stores two saved searches:
Bitdefender “Malware - Still Infected Hosts” centralizes events from Antimalware and HyperDetect modules. You can view the events in which the item scanned by the corresponding technology is ignored, restored, or still present. The events provide you with details like the IP address, username, computer name, malware type, malware name, and action state.
Bitdefender “Threats Overview” centralizes events from the following modules: Antimalware, Antiphishing, Advanced Threat Control, Security for Exchange, HyperDetect, Hypervisor Memory Introspection (HVI), Sandbox Analyzer, Advanced Anti-Exploit, Content Control, Security for Storage and Ransomware Mitigation. The events provide you with details such as IP address, username, computer name and action state.
To use these searches follow the steps below:
Click the Log Activity tab.
Click Quick Searches from the upper left side of the page. You should see a list with all the saved searches, custom and predefined.
Bitdefender Saved Searches
If the two searches are unlisted, follow these steps:
Click the Search button from the upper left side of the page and select New Search.
Type the name of the search in the text box or select it from the Available Saved Searches.
Click the Load button.
Once loaded, select the Include in my Quick Searches checkbox.
Click the Search button from the lower right side of the page. Once completed you can view the search in the Quick Searches list.
Select the search of interest to list out all the matching events.
View Events and Explore Data
The integration provides you with the possibility to view events in real-time and investigate them properly using customizable queries.
To investigate an event:
Access the Log Activity tab.
Click Quick Searches.
Select Bitdefender “Malware - Still infected hosts” or Bitdefender “Threats Overview”.
Customize or use the default query.
Default query for Bitdefender “Malware - Still infected hosts”
SELECT QIDNAME(qid) FROM events WHERE LOGSOURCETYPENAME(devicetype) = 'Bitdefender CEF Syslog' and QIDNAME(qid) IN('AntiMalware','HyperDetect Activity') and "Malware Type" IN ('file', 'http', 'cookie', 'pop3', 'smtp', 'process', 'boot', 'registry', 'stream') and "Action State" IN('still present', 'ignored', 'restored')Default query for Bitdefender “Threats Overview”:
SELECT QIDNAME(qid) FROM events WHERE LOGSOURCETYPENAME(devicetype) = 'Bitdefender CEF Syslog' and QIDNAME(qid) IN('Antiphishing','AntiMalware','Behavioral scanning','Exchange Malware Detected', 'HyperDetect Activity', 'HVI', 'Sandbox Analyzer Detection', 'Exploit Mitigation', 'Web Control', 'Storage Antimalware', 'Ransomware Detection') and ("Event Type" NOT IN (NULL,'N/A','None') OR "Malware Type" NOT IN (NULL,'N/A','None') OR "Exploit Type" NOT IN (NULL,'N/A','None') OR "Threat Name" NOT IN (NULL,'N/A','None') OR "Attack Type" NOT IN (NULL,'N/A','None') OR "Application Control Block Type" NOT IN (NULL,'N/A','None'))Click Search.
View Events
Double click the event of your interest. You can view the details in the Event Information widow.
Event Information
In the same window, you can also view the event in CEF format.
CEF events
Splunk
To set up the link between Splunk and GravityZone follow the steps below.
The following software needs to be installed:
The Bitdefender Gravityzone for Splunk App provides a Dashboard where you can view all the information received from GravityZone, organized into multiple sections and widgets. Using the app you can also search for information or generate reports.
To install the app, follow these steps:
Download the Bitdefender Gravityzone for Splunk App installation package from here.
Log in to Splunk Enterprise.
From the home page, click the Manage Apps button on the upper left side of the screen:
Click the Install app from file button on the right side of the screen.
Click Browse....
Select the package downloaded from step 1.
Click Upload.
The Bitdefender Gravityzone Add-on for Splunk supports the Bitdefender Gravityzone App for Splunk by providing source mapping, data extractions and transformations. It acts like a parser, converting all data gathered from various Bitdefender sources into a CIM format, which is compatible with Splunk.
To install the app, follow these steps:
Download the Bitdefender Gravityzone Add-on for Splunk installation package from here.
Log in to Splunk Enterprise.
From the home page, click the Manage Apps button on the upper left side of the screen:
Click the Install app from file button on the right side of the screen.
Click Browse....
Select the package downloaded from step 1.
Click Upload.
Connect to the GravityZone Control Center.
Go to the Configuration page and click Miscellaneous.
Select the Enable Syslog check box.
Enter the IP address of the Splunk instance, the preferred protocol and the port Syslog listens to.
Select the format json to send the data to the Syslog server.
Click the Add button from the Action column.
To select the events you want to receive on the Splunk instance:
Connect to the GravityZone Control Center.
Click the Notification button at the right side of the menu bar and then click the Settings icon.
Under Enable Notification section, choose the type of notifications you want to receive from GravityZone and select the Log to server checkbox.
Log in to Splunk Enterprise.
On the upper right side of the screen click Settings and select Data Inputs.
Select TCP or UDP under the Local inputs section.
Click the New local TCP or the New local TCP button from the upper right side of the screen.
Select either a TCP or a UDP port.
Fill in the Port field and, optionally, the Source name overwrite and Only accept connection from fields.
Click Next.
Under Source type, click Select, and choose the
bitdefender:gzoption.Under App context, select
TA-bitdefender-gravityzone.Under Host, enter the appropriate IP, DNS or type in a custom host value.
Under Index, select the one where you want to store your data.
Click the Review button on the upper side of the screen and verify the information.
Click Submit.
Log in to GravityZoneControl Center.
Go to My Account.
Under API keys section, click Add.
Select the Event Push Service API check box and click Save. The new key appears in the API Keys table.
Click Save to preserve the changes made in My Account page.
Log in to Splunk.
Go to Settings > Data Inputs > HTTP Event Colector.
Click New Token.
In the Add Data screen, fill in the Name field, as suggested in the image below, and click Next.
For Source type, click Select and choose choose
bitdefender:gzas the source.
At Index, select a default index or create a new one. The events received by HTTP Event Collector will be inserted in the selected index.
Click Review.
Verify the data you entered and click Submit.
The token has been created successfully. Copy the token value and save it. You will need it later to enable the integration.
Go to Settings > Data Inputs > HTTP Event Collector and click Global Settings.
In the new window, under All Tokens section, select Enabled.
Click Save.
After you created the Event Push Service key in GravityZoneControl Center and enabled HTTP Event Collector in Splunk, you need to enable the integration. That means you have to start sending events from GravityZone to Splunk.
Get the information needed to configure Event Push Service settings from your favorite terminal emulator on Linux or Mac:
GravityZone API URL.
You find it in MyAccount > Control Center API and it should be similar to
https://cloudgz.gravityzone.bitdefender.com/api.The authorization header of the API key generated in GravityZone.
The header value is Basic base64 encode. To obtain the authorization header, run the
echocommand followed by API key with colon (":").> echo –n '604821e87e4c7de3aa15d0e6a97f5ab362281dbf0763746671da2caf4b5cccd1:' | base64 –w 0
The result should be something like this:
NjA0ODIxZTg3ZTRjN2RlM2FhMTVkMGU2YTk3ZjVhYjM2MjI4MWRiZjA3NjM3NDY2NzFkYTJjYWY0YjVjY2NkMTo=
Splunk URL.
You find it in your Splunk Cloud platform and it should be something like this:
https://prd-p-xlpxkqpw84k2.cloud.splunk.com. If you use Splunk on-premises, the URL is already in place.HTTP Event Collector token.
Run this command (the settings you have to edit are underlined):
> curl -k -X POST \ https://cloudgz.gravityzone.bitdefender.com/api/v1.0/jsonrpc/push \ -H 'authorization: Basic NjA0ODIxZTg3ZTRjN2RlM2FhMTVkMGU2YTk3ZjVhYjM2MjI4MWRiZjA3NjM3NDY2NzFkYTJjYWY0YjVjY2NkMTo=' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json' \ -d '{"params": {"status": 1, "serviceType": "splunk", "serviceSettings": {"url": "https://input-prd-p-r2rmnllpzv4n.cloud.splunk.com:8088/services/collector", "requireValidSslCertificate": false, "splunkAuthorization": "Splunk EA900DEB-22C8-402B-A7F9-A926C1633E7A"}, "subscribeToEventTypes": {"hwid-change": true,"modules": true,"sva": true,"registration": true,"supa-update-status": true,"av": true,"aph": true,"fw": true,"avc": true,"uc": true,"dp": true,"device-control": true,"sva-load": true,"task-status": true,"exchange-malware": true,"network-sandboxing": true,"malware-outbreak": true,"adcloud": true,"exchange-user-credentials": true,"exchange-organization-info": true,"hd": true,"antiexploit": true,}, "jsonrpc": "2.0", "method":"setPushEventSettings", "id": "1"}'
Note
GravityZone starts sending events to Splunk after the Event Push Service settings are reloaded. This happens every 10 minutes.
To start sending events immediately, run this command (the settings you have to edit are underlined):
> curl -k -X POST \ https://cloudgz.gravityzone.bitdefender.com/api/v1.0/jsonrpc/push \ -H 'authorization: Basic R2U5SENZcWRVN2pJRFI5MHdOMGVFMXpiQjVTbmM1SE46' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json' \ -d '{"params": {}, "jsonrpc": "2.0", "method": "getPushEventSettings", "id": "2"}'
The return should be similar to:
{"id":"1","jsonrpc":"2.0","result":true}Test the Splunk integration
To test the integration, run this command (the settings you have to edit are underlined):
> curl -k -X POST \ https://cloudgz.gravityzone.bitdefender.com/api/v1.0/jsonrpc/push \ -H 'authorization: Basic R2U5SENZcWRVN2pJRFI5MHdOMGVFMXpiQjVTbmM1SE46' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json' \ -d '{"params": {"eventType": "av"}, "jsonrpc": "2.0", "method": "sendTestPushEvent", "id": "3"}'
You can also start sending events from GravityZone to Splunk by running a script created by Bitdefender. You can do this in your favorite terminal emulator on Linux or Mac.
Download the script from here.
Make the script executable by running the command:
chmod +x bdpusheventconfig.sh
Run the script with the command:
./bdpusheventconfig.sh -g [console_url] -k [api_key] -t [service_type] -u [service_url] -a [splunk_auth_token] -v -d [events]
The script includes the following options:
Option | Description |
| GravityZone API url |
| GravityZone API key |
| Service type: splunk or jsonRPC |
| Splunk or RPC url |
| Splunk authorization token |
| Verify service SSL certificate |
| Connect to Splunk Cloud free trials. Adds 'input-' to the service host and uses port 8088 (if port is not specified). |
| Connect to Splunk Cloud instances. Adds 'http-inputs-' to the service host and uses port 443 (if port is not specified). |
| Help |
These options are similar to the ones used when enabling the integration manually.
The [events] list refers to one or more space-separated events that are to be sent from GravityZone to Splunk. These events are described in the table below:
Event type identifier | Description |
| Product Modules event |
| Security Server Status event |
| Product Registration event |
| Outdated Update Server event (where the Update Server is a Relay) |
| Antimalware event |
| Antiphishing event |
| Firewall event |
| ATC/IDS event |
| User Control event |
| Data Protection event |
| HyperDetect event |
| Overloaded Security Server event |
| Task Status event |
| Exchange Malware Detection event |
| Sandbox Analyzer Detection |
| Active Directory Integration Issue |
| Exchange User Credentials |
| Antiexploit Event |
| Network Attack Defense Event |
| Endpoint moved in (used for moving endpoints from one company to another) |
| Endpoint moved out (used for moving endpoints from one company to another) |
| Hardware ID change |
| Install agent |
| New incident |
| Ransomware activity detection |
| Security Container update available |
| Troubleshooting activity |
| Uninstall agent |
To subscribe to all events, use the value all or specify each one of them. If the events list is empty (no event types specified) then the integration is disabled.
Examples
Enable the Splunk integration
./bdpusheventconfig.sh -g https://gz.example.com/api/v1.0/jsonrpc/push -k abcdefghijklmnopqrstuvwxyz123456 -t splunk -u https://splunk.example.com -a 11111111-2222-3333-4444-555555555555 -d modules sva registration supa-update-status av aph fw avc uc dp sva-load task-status exchange-malware network-sandboxing adcloud exchange-user-credentials
./bdpusheventconfig.sh -g https://gz.example.com/api/v1.0/jsonrpc/push -k abcdefghijklmnopqrstuvwxyz123456 -t splunk -u https://splunk.example.com -a 11111111-2222-3333-4444-555555555555 -c all
Configure a json RPC service
./bdpusheventconfig.sh -g https://gz.example.com/api/v1.0/jsonrpc/push -k abcdefghijklmnopqrstuvwxyz123456 -t jsonRPC -u https://rpc.example.com modules sva registration supa-update-status av aph fw avc uc dp sva-load task-status exchange-malware network-sandboxing adcloud exchange-user-credentials
Disable the Splunk integration
./bdpusheventconfig.sh -g https://gz.example.com/api/v1.0/jsonrpc/push -k abcdefghijklmnopqrstuvwxyz123456 -t splunk -u https://splunk.example.com -a 11111111-2222-3333-4444-555555555555 –c
For details about Push Events Service, refer to the Push section.
For details about creating reports based on data from GravityZone in Splunk, refer to Create reports in Splunk based on GravityZone data.
Sumo Logic
Configure Bitdefender GravityZone source for Sumo Logic
You can view Bitdefender GravityZone data in Sumo Logic. To collect this type of data, you need to add a source to a Hosted Collector in Sumo Logic and configure the Bitdefender GravityZone APIs.
Prerequisites
Sumo Logic account
Bitdefender GravityZone (cloud) account
Hosted Collector set up on a machine in your Sumo Logic environment
To collect Bitdefender GravityZone data via its APIs, follow these steps:
Add source to a Hosted Collector
Log in to Sumo Logic.
Navigate to Manage Data > Collection.
Click Add Source next to a Hosted Collector.
Select HTTP Logs & Metrics.
Enter a Name for the source.
Configure Source details and advanced options for logs.
For more information, refer to the following Sumo Logic help article.
Click Save to add the source.
This source has a unique URL. Bitdefender GravityZone will send its data to this URL after you configure Event Push Service API.
Access source URL
Navigate to Manage Data > Collection.
Find the Hosted Collector by name and click Show URL.
Copy the HTTP source address.
Generate Bitdefender GravityZone API key
Log in to GravityZone Control Center.
Click the username at the upper-right corner and choose My Account.
Go to the API keys section and click Add at in this table.
Enable Event Push Service API.
You can enable other APIs to source more information from Bitdefender GravityZone.
Click Save.
To prevent the leaking of sensitive information, do not share or distribute your own generated API keys.
Copy the Access URL from the Control Center API section.
You need this key to configure Event Push Service API.
Configure Event Push Service API
Follow this procedure to set up the subscription for GravityZone Control Center events that you want to see in Sumo Logic.
Open a MAC or Linux terminal.
Run the echo command followed by the Bitdefender GravityZone API key with a colon (":")
For Linux terminal:
> echo –n 'Ge9HCYqdU7jIDR90wN0eE1zbB5Snc5HN:' | base64 –w 0
For MAC terminal:
> echo –n 'Ge9HCYqdU7jIDR90wN0eE1zbB5Snc5HN:' | base64 –b 0
This encodes the API key in a base64 string.
Return value example:
R2U5SENZcWRVN2pJRFI5MHdOMGVFMXpiQjVTbmM1SE46
4oCTbiBhY2M1ZGY2ODU2YTdiZWUwODE3MmJlM2I2NDQ3YjMyNTg2OWIzM2M2ZjU2ZGJjNGNjMmRkYjJmZmM0OWFkYzRjOgo=
You will use this encoded string as a token for POST authorization.
Note
Sumo Logic does not currently support authentication via the authentication header used in
setPushEventSettingsmethod. The header is still needed for the event push forwarding mechanism to work but the header itself can contain any random string as the Sumo Logic https collector will ignore it.Run the following curl commands and edit the bolded settings:
curl -k -X POST \ https://cloudgz.gravityzone.bitdefender.com/api/v1.0/jsonrpc/push \ -H 'authorization: Basic R2U5SENZcWRVN2pJRFI5QndOMGVFMXpiQjVTbmNISE46' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json' \ -d '{"params": {"status": 1,"serviceType": "jsonRPC","serviceSettings": {"url": "SumoLogic URL","requireValidSslCertificate": false, "authorization":"auth header value"},"subscribeToEventTypes": {"modules": true,"sva": true,"registration": true,"supa-update-status": true,"av": true,"aph": true,"fw": true,"avc": true,"uc": true,"dp": true,"hd": true,"sva-load": true,"task-status": true,"exchange-malware": true,"network-sandboxing": true,"adcloud": true,"exchange-user-credentials": true}},"jsonrpc": "2.0","method": "setPushEventSettings","id": "1"}'
Return value example:
{"id":"1","jsonrpc":"2.0","result":true}GravityZone starts sending events to Sumo Logic after the Event Push Service settings are reloaded. This happens every 10 minutes.
This table indicates the event types that GravityZone can send to Sumo Logic.
Event type identifier
Description
modulesProduct Modules event
svaSecurity Server Status event
registrationProduct Registration event
supa-update-statusOutdated Update Server event (where the Update Server is a Relay)
avAntimalware event
aphAntiphishing event
fwFirewall event
avcATC/IDS event
ucUser Control event
dpData Protection event
hdHyperDetect event
sva-loadOverloaded Security Server event
task-statusTask Status event
exchange-malwareExchange Malware Detection event
network-sandboxingSandbox Analyzer Detection
adcloudActive Directory Integration Issue
exchange-user-credentialsExchange User Credentials
To start sending events immediately, run the following command and edit the emphasized settings:
curl -k -X POST \ https://cloudgz.gravityzone.bitdefender.com/api/v1.0/jsonrpc/push \ -H 'authorization: Basic R2U5SENZcWRVN2pJRFI5QndOMGVFMXpiQjVTbmNISE46' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json' \ -d '{"params": {}, "jsonrpc": "2.0", "method": "getPushEventSettings", "id": "2"}'To test the integration, run the following command and edit the emphasized settings:
curl -k -X POST \ https://cloudgz.gravityzone.bitdefender.com/api/v1.0/jsonrpc/push \ -H 'authorization: Basic R2U5SENZcWRVN2pJRFI5QndOMGVFMXpiQjVTbmNISE46' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json' \ -d '{"params": {"eventType": "av"}, "jsonrpc": "2.0", "method": "sendTestPushEvent", "id": "3"}'You can now see Bitdefender GravityZone data in Manage Data > Collection.
For details about Push Events Service, refer to the GravityZone Cloud API Documentation guide, the chapter "Push".