-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[INTPLAT-467] DDS: Bitdefender Integration v1.0.0. (#19037)
* Initial commit of bitdefender integration. * Added images * Updated menifest.json file. * Updated test yaml * Update: readme and dashboard changes * Resolved PR Comments. * Bitdefender: Reverted one readme change. * Bitdefender: Reverted antiphishing and antiexploit descripion and overview changes as well as changelog.md file changes. * Added image * Bitdefender: Updated pipeline and readme. * BItdefender: Updated auto_install param in manifest.json file * Bitdefender: Resolved grammer issue. * Add: CODEOWNERS * Update CODEOWNER file --------- Co-authored-by: madhav.pandya <madhav.pandya@crestdatasys.com> Co-authored-by: ankitarajput-crest <ankita.rajput@crestdata.ai> Co-authored-by: manan-crest <manan.goria@crestdata.ai> Co-authored-by: shubhamvekariya-crest <157569826+shubhamvekariya-crest@users.noreply.github.com> Co-authored-by: tirthraj.chaudhari <tirthraj.chaudhari@crestdatasys.com> Co-authored-by: Kirolos Shahat <kashahat@gmail.com>
- Loading branch information
1 parent
9c80b4c
commit 21c58a3
Showing
29 changed files
with
10,710 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# CHANGELOG - bitdefender | ||
|
||
## 1.0.0 / 2024-11-12 | ||
|
||
***Added***: | ||
|
||
* Initial Release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
# Bitdefender integration for Datadog | ||
|
||
## Overview | ||
|
||
[Bitdefender][1] provides cybersecurity solutions with leading security efficacy, performance, and ease of use to small and medium businesses, mid-market enterprises, and consumers. Bitdefender EDR effectively stops ransomware and breaches with automated cross-endpoint correlation and seamlessly integrated prevention, protection, detection, and response. | ||
|
||
The Bitdefender integration uses a webhook to ingest Bitdefender EDR logs. The integration provides OOTB dashboards and detection rules for the following event types: | ||
|
||
| Event | Trigger | | ||
|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| Antiphishing | Endpoint agent detects a known phishing attempt when accessing a web page | | ||
| Antimalware | Bitdefender detects malware on an endpoint in your network | | ||
| Advanced Threat Control (ATC) | Potentially dangerous application is detected and blocked on an endpoint | | ||
| Data Protection | Data traffic is blocked on an endpoint, according to data protection rules | | ||
| Exchange Malware Detection | Bitdefender detects malware on an Exchange server in your network | | ||
| Firewall | Endpoint agent blocks a port scan or an application from accessing the network, according to the applied policy | | ||
| Hyper Detect event | Hyper Detect module detects malware | | ||
| Sandbox Analyzer Detection | Sandbox Analyzer detects a new threat among the submitted files | | ||
| Antiexploit Event | Advanced Anti-Exploit triggers a detection | | ||
| Network Attack Defense Event | Network Attack Defense module triggers a detection | | ||
| User Control/Content Control | User activity, such as web browsing of software application, is blocked on the endpoint according to the applied policy | | ||
| Storage Antimalware Event | SVA detects a new threat among the protected storage (NAS) | | ||
| Ransomware activity detection | Endpoint agent blocks ransomware attack | | ||
| New Incident | New Root Cause Analysis (RCA) is displayed under the Incidents section of Control Center. The event contains a list of relevant items extracted from the RCA JSON | | ||
|
||
## Setup | ||
|
||
### Create a Bitdefender API Key | ||
|
||
1. Log in to Bitdefender Business Security Enterprise Portal using an administrator account. Your account must have the following rights: | ||
- Manage Networks | ||
- Manage Users | ||
- Manage Company | ||
- View and analyze data | ||
2. Click **User Role**, then click **My Account**. | ||
3. Navigate to the **API keys** section. | ||
4. Click **Add**. The API Key Configuration window opens. | ||
5. Provide the following information: | ||
- **API Key Description**: A relevant name for your API key | ||
- **Enabled APIs**: Select all services. | ||
6. Click **Generate** and copy the generated API key. | ||
7. Perform Base64 encoding on the generated API key. You'll use the encoded API key for webhook configuration. | ||
1. Take your API key and append a colon (\:) to it, like this: `<api_key>:` | ||
2. Encode the resulting string using a Base64 encoder. | ||
|
||
For example, if your API key is abc123, the string to encode is `abc123:` After Base64 encoding, the result will be something | ||
like `YWJjMTIzOg==`. | ||
|
||
8. Navigate to the **Control Center API** section and note the Access URL. In the next section, you'll use this URL in the curl command as **\<control_center_apis_access_url>**. | ||
|
||
For more information, see the [API Key and Authentication Reference Document][3]. | ||
|
||
### Configure a webhook in Datadog | ||
1. In Datadog, navigate to the **Integrations** tab, and search for the Bitdefender integration. | ||
2. Click the **Bitdefender** integration. The integration window opens. On the **Configure** tab, select an existing API key, or create a new one. | ||
3. After selecting an API key, click **Add API key**, then click **Click Here to Copy URL**. | ||
4. Make a curl request. Use the template below, putting values into the following fields: | ||
- **\<control_center_apis_access_url>**: The URL from the previous section | ||
- **\<bitdefender-encoded-api-key>**: Your encoded API key | ||
- **\<dd-api-key>**: Your Datadog API key | ||
- **\<webhook_url>**: The URL you copied in step 3 | ||
```bash | ||
curl -X POST -k "<control_center_apis_access_url>/v1.0/jsonrpc/push" --header "Authorization: Basic <bitdefender-encoded-api-key>" --header "Content-Type: application/json" --data "{\"params\": {\"status\": 1,\"serviceType\": \"jsonRPC\",\"serviceSettings\": {\"url\": \"<webhook_url>\",\"requireValidSslCertificate\": false,\"authorization\": \"<dd-api-key>\"},\"subscribeToEventTypes\": {\"av\": true,\"aph\": true,\"fw\": true,\"avc\": true,\"uc\": true,\"dp\": true,\"hd\": true,\"exchange-malware\": true,\"network-sandboxing\": true,\"new-incident\": true,\"antiexploit\": true,\"network-monitor\": true,\"ransomware-mitigation\": true,\"storage-antimalware\": true}},\"jsonrpc\": \"2.0\",\"method\": \"setPushEventSettings\",\"id\": \"bitdefender_push\"}" | ||
``` | ||
**Note**: If you're using Windows, add `^` before `&ddsource` in the **webhook_url** parameter. | ||
Here's an example of a completed curl request: | ||
```bash | ||
curl -X POST -k "https://cloudap.gravityzone.bitdefender.com/api/v1.0/jsonrpc/push" --header "Authorization: Basic <bitdefender-encoded-api-key>" --header "Content-Type: application/json" --data "{\"params\": {\"status\": 1,\"serviceType\": \"jsonRPC\",\"serviceSettings\": {\"url\": \"https://http-intake.logs.datadoghq.com/api/v2/logs?dd-api-key=<dd-api-key>&ddsource=bitdefender\",\"requireValidSslCertificate\": false,\"authorization\": \"<dd-api-key>\"},\"subscribeToEventTypes\": {\"av\": true,\"aph\": true,\"fw\": true,\"avc\": true,\"uc\": true,\"dp\": true,\"hd\": true,\"exchange-malware\": true,\"network-sandboxing\": true\"new-incident\": true,\"antiexploit\": true,\"network-monitor\": true,\"ransomware-mitigation\": true,\"storage-antimalware\": true,}},\"jsonrpc\": \"2.0\",\"method\": \"setPushEventSettings\",\"id\": \"bitdefender_push\"}" | ||
``` | ||
|
||
After you make the curl request, you should receive a response indicating your connection has been established successfully. | ||
5. In Datadog, filter your logs in Log Explorer to ensure data is populating properly in your dashboard. | ||
|
||
## Data Collected | ||
|
||
### Logs | ||
|
||
The Bitdefender integration collects and forwards Bitdefender logs to Datadog. | ||
|
||
### Metrics | ||
|
||
The Bitdefender integration does not include any metrics. | ||
|
||
### Events | ||
|
||
The Bitdefender integration does not include any events. | ||
|
||
## Support | ||
|
||
For further assistance, contact [Datadog Support][2]. | ||
|
||
[1]: https://www.bitdefender.com/en-in/business/products/endpoint-detection-response | ||
[2]: https://docs.datadoghq.com/help/ | ||
[3]: https://www.bitdefender.com/business/support/en/77209-125277-public-api.html#UUID-2a74c3b5-6159-831d-4f8a-ca42797ce3b0_section-idm4640169987334432655171029621 |
Oops, something went wrong.