Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cybersixgill Actionable Alerts #1576

Merged
merged 75 commits into from
Apr 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
75 commits
Select commit Hold shift + click to select a range
add9b4f
Cybersixgill Actionable Alerts
fshaik3494 Oct 19, 2022
aa3a546
Cybersixgill Actionable Alerts
fshaik3494 Oct 19, 2022
046c203
Cybersixgill Actionable Alerts
fshaik3494 Oct 20, 2022
a0a0470
Cybersixgill Actionable Alerts
fshaik3494 Oct 21, 2022
7ce22af
Cybersixgill Actionable Alerts
fshaik3494 Oct 21, 2022
9a3d5a6
Cybersixgill Actionable Alerts
fshaik3494 Oct 25, 2022
653cb78
Cybersixgill Actionable Alerts
fshaik3494 Oct 31, 2022
c0b62f3
Cybersixgill Actionable Alerts
fshaik3494 Oct 31, 2022
8aaa3f5
Cybersixgill Actionable Alerts
fshaik3494 Nov 2, 2022
227e662
Cybersixgill Actionable Alerts
fshaik3494 Nov 3, 2022
8fd052a
Cybersixgill Actionable Alerts
fshaik3494 Nov 10, 2022
1b6a508
Cybersixgill Actionable Alerts
fshaik3494 Nov 16, 2022
9c8e1f0
Cybersixgill Actionable Alerts
fshaik3494 Nov 16, 2022
738fc46
Cybersixgill Actionable Alerts
fshaik3494 Nov 16, 2022
82579f4
Cybersixgill Actionable Alerts
fshaik3494 Nov 18, 2022
cb5e6b3
Submitted with changes requested in check.py
fshaik3494 Dec 5, 2022
a33cd6e
Cybersixgill Actionable Alerts Validate command fix
fshaik3494 Dec 13, 2022
7d83770
Cybersixgill Actionable Alerts
fshaik3494 Dec 14, 2022
97d43cc
Cybersixgill Actionable Alerts
fshaik3494 Dec 14, 2022
2abe032
Cybersixgill Actionable Alerts
fshaik3494 Dec 16, 2022
9cf3ccc
Cybersixgill Actionable Alerts
fshaik3494 Dec 20, 2022
1210926
Cybersixgill Actionable Alerts
fshaik3494 Dec 21, 2022
2cde9be
Cybersixgill Actionable Alerts
fshaik3494 Dec 22, 2022
1859088
Cybersixgill Actionable Alerts
fshaik3494 Jan 4, 2023
a79f71e
Cybersixgill Actionable Alerts
fshaik3494 Jan 4, 2023
91ece12
Cybersixgill Actionable Alerts
fshaik3494 Jan 11, 2023
5cffccd
Cybersixgill Actionable Alerts
fshaik3494 Jan 11, 2023
7fa9605
Cybersixgill Actionable Alerts
fshaik3494 Feb 6, 2023
e7bf653
Cybersixgill Actionable Alerts
fshaik3494 Feb 7, 2023
3d6d43d
Cybersixgill Actionable Alerts
fshaik3494 Feb 9, 2023
dbfc6e4
Cybersixgill Actionable Alerts
fshaik3494 Feb 9, 2023
2fbf24f
Cybersixgill Actionable Alerts
fshaik3494 Feb 9, 2023
0d91737
Cybersixgill Actionable Alerts
fshaik3494 Feb 14, 2023
126a1dd
Cybersixgill Actionable Alerts
fshaik3494 Feb 14, 2023
0496911
Cybersixgill Actionable Alerts
fshaik3494 Feb 15, 2023
7851fc3
Cybersixgill Actionable Alerts
fshaik3494 Feb 15, 2023
20cdd9a
Cybersixgill Actionable Alerts
fshaik3494 Feb 20, 2023
6e5f5e7
Merge remote-tracking branch 'origin/Cybersixgill-Alerts' into Cybers…
fshaik3494 Feb 20, 2023
2d30e1e
Cybersixgill Actionable Alerts
fshaik3494 Feb 22, 2023
03d9e89
Cybersixgill Actionable Alerts
fshaik3494 Feb 22, 2023
4b843a9
Cybersixgill Actionable Alerts
fshaik3494 Feb 22, 2023
fd1730b
Cybersixgill Actionable Alerts
fshaik3494 Feb 22, 2023
840bdd3
Cybersixgill Actionable Alerts
fshaik3494 Feb 22, 2023
36f4809
Cybersixgill Actionable Alerts
fshaik3494 Feb 23, 2023
e2b6b73
Cybersixgill Actionable Alerts
fshaik3494 Feb 23, 2023
cb24c9f
Cybersixgill Actionable Alerts
fshaik3494 Feb 23, 2023
2ebd929
Cybersixgill Actionable Alerts
fshaik3494 Feb 24, 2023
6c194c0
Cybersixgill Actionable Alerts
fshaik3494 Feb 25, 2023
a06c606
Cybersixgill Actionable Alerts
fshaik3494 Feb 25, 2023
099c9f0
Cybersixgill Actionable Alerts
fshaik3494 Feb 28, 2023
6bda536
resolved review comments
shahul-loginsoft Mar 17, 2023
d1b3049
resolved review comments
shahul-loginsoft Mar 17, 2023
fc78164
CyberSixgill Actionable Alerts
shahul-loginsoft Mar 17, 2023
6260d2f
Cybersixgill Actionable Alerts
shahul-loginsoft Mar 28, 2023
b4e739b
changelog date updated
shahul-loginsoft Mar 30, 2023
15494ac
comments are addressed
shahul-loginsoft Mar 31, 2023
4b1824b
addressed review comments
shahul-loginsoft Apr 7, 2023
d8d4572
review comments are addressed
shahul-loginsoft Apr 7, 2023
1ff3554
review comments addressed
shahul-loginsoft Apr 7, 2023
f3a0bf0
review comments are reverted
shahul-loginsoft Apr 7, 2023
8d96971
review comments are addressed
shahul-loginsoft Apr 7, 2023
e33f9fa
Cybersixgill Actionable Alerts
shahul-loginsoft Apr 7, 2023
ba5478a
cybersixgill actionable alerts
shahul-loginsoft Apr 7, 2023
61bf61d
conflicts resolved
shahul-loginsoft Apr 8, 2023
ca86bba
Merge branch 'master' into Cybersixgill-Alerts
shahul-loginsoft Apr 12, 2023
3fc853e
updated codeowners file
shahul-loginsoft Apr 13, 2023
3184398
updated code owner file
shahul-loginsoft Apr 17, 2023
4b1c62b
Merge branch 'master' into Cybersixgill-Alerts
bgoldberg122 Apr 18, 2023
1ac2d50
added test case
shahul-loginsoft Apr 21, 2023
78ef4f2
test cases updated for test coverage
shahul-loginsoft Apr 24, 2023
39e1465
fixed test coverage
shahul-loginsoft Apr 24, 2023
ff482e7
added test case for test coverage
shahul-loginsoft Apr 25, 2023
a3b668a
json file formatted
shahul-loginsoft Apr 26, 2023
7cb090c
json formatted
shahul-loginsoft Apr 26, 2023
7ab9b8f
added test cases for test coverage
shahul-loginsoft Apr 26, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .azure-pipelines/all.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ jobs:
- checkName: cloudsmith
displayName: Cloudsmith
os: linux
- checkName: cybersixgill_actionable_alerts
displayName: cybersixgill_actionable_alerts
os: linux
- checkName: cyral
displayName: Cyral
os: linux
Expand Down
9 changes: 9 additions & 0 deletions .codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,10 @@ coverage:
target: 75
flags:
- cfssl
cybersixgill_actionable_alerts:
target: 75
flags:
- cybersixgill_actionable_alerts
exim:
target: 75
flags:
Expand Down Expand Up @@ -285,6 +289,11 @@ flags:
paths:
- cloudsmith/datadog_checks/cloudsmith
- cloudsmith/tests
cybersixgill_actionable_alerts:
carryforward: true
paths:
- cybersixgill_actionable_alerts/datadog_checks/cybersixgill_actionable_alerts
- cybersixgill_actionable_alerts/tests
cyral:
carryforward: true
paths:
Expand Down
7 changes: 4 additions & 3 deletions .github/CODEOWNERS
bgoldberg122 marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
/contrastsecurity/ @kristianamitchellcontrastsecurity [email protected]
/convox/ @DataDog/agent-integrations
/cortex/ @cortexapps/engineering [email protected] @DataDog/marketplace-review
/cybersixgill_actionable_alerts/ @shahul-loginsoft [email protected] @DataDog/marketplace-review
/cyral/ @tyrannosaurus-becks [email protected] @DataDog/marketplace-review
/data_runner/ @DataDog/apps-sdk @DataDog/marketplace-review
/datazoom/ @DataDog/web-integrations
Expand Down Expand Up @@ -267,6 +268,9 @@
/cortex/*metadata.csv @cortexapps/engineering [email protected] @DataDog/documentation
/cortex/manifest.json @cortexapps/engineering [email protected] @DataDog/documentation
/cortex/README.md @cortexapps/engineering [email protected] @DataDog/documentation
/cybersixgill_actionable_alerts/*metadata.csv @shahul-loginsoft [email protected] @DataDog/documentation @DataDog/marketplace-review
/cybersixgill_actionable_alerts/manifest.json @shahul-loginsoft [email protected] @DataDog/documentation @DataDog/marketplace-review
/cybersixgill_actionable_alerts/README.md @shahul-loginsoft [email protected] @DataDog/documentation @DataDog/marketplace-review
/cyral/*metadata.csv @tyrannosaurus-becks [email protected] @DataDog/documentation
/cyral/manifest.json @tyrannosaurus-becks [email protected] @DataDog/documentation
/cyral/README.md @tyrannosaurus-becks [email protected] @DataDog/documentation
Expand Down Expand Up @@ -363,14 +367,11 @@
/logzio/*metadata.csv @DataDog/agent-integrations @DataDog/documentation
/logzio/manifest.json @DataDog/agent-integrations @DataDog/documentation
/logzio/README.md @DataDog/agent-integrations @DataDog/documentation
<<<<<<< HEAD
/mendix/README.md @mendix/cloud @DataDog/agent-integrations @DataDog/documentation
/mendix/manifest.json @mendix/cloud @DataDog/agent-integrations @DataDog/documentation
=======
/mergify/*metadata.csv @Mergifyio/oss-integrations @DataDog/documentation
/mergify/manifest.json @Mergifyio/oss-integrations @DataDog/documentation
/mergify/README.md @Mergifyio/oss-integrations @DataDog/documentation
>>>>>>> bfce30e1 (feat: add mergify integration)
/n2ws/*metadata.csv @eliadeini [email protected] @DataDog/documentation
/n2ws/manifest.json @eliadeini [email protected] @DataDog/documentation
/n2ws/README.md @eliadeini [email protected] @DataDog/documentation
Expand Down
19 changes: 19 additions & 0 deletions .github/workflows/test-all.yml
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,25 @@ jobs:
test-py3: ${{ inputs.test-py3 }}
setup-env-vars: "${{ inputs.setup-env-vars }}"
secrets: inherit
ja669dc6:
uses: DataDog/integrations-core/.github/workflows/test-target.yml@master
with:
job-name: cybersixgill_actionable_alerts
target: cybersixgill_actionable_alerts
platform: linux
runner: '["ubuntu-22.04"]'
repo: "${{ inputs.repo }}"
python-version: "${{ inputs.python-version }}"
standard: ${{ inputs.standard }}
latest: ${{ inputs.latest }}
agent-image: "${{ inputs.agent-image }}"
agent-image-py2: "${{ inputs.agent-image-py2 }}"
agent-image-windows: "${{ inputs.agent-image-windows }}"
agent-image-windows-py2: "${{ inputs.agent-image-windows-py2 }}"
test-py2: ${{ inputs.test-py2 }}
test-py3: ${{ inputs.test-py3 }}
setup-env-vars: "${{ inputs.setup-env-vars }}"
secrets: inherit
j3263e78:
uses: DataDog/integrations-core/.github/workflows/test-target.yml@master
with:
Expand Down
5 changes: 5 additions & 0 deletions cybersixgill_actionable_alerts/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# CHANGELOG - cybersixgill_actionable_alerts

eho1307 marked this conversation as resolved.
Show resolved Hide resolved
## 1.0.0 / 2023-04-04

[FEATURE] Initial Cybersixgill Integration
46 changes: 46 additions & 0 deletions cybersixgill_actionable_alerts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Agent Check: cybersixgill_actionable_alerts

## Overview
The Cybersixgill actionable alerts check monitors critical assets across the deep, dark, and surface web such as IP addresses, domains, vulnerabilities, and VIPs. Receive alerts with context including severity, threat type, description, post snippet, recommendations, and assessments. This integration provides an out-of-the-box dashboard to prioritize and respond to threats.

## Setup

emarsha94 marked this conversation as resolved.
Show resolved Hide resolved

### Installation

To install the Cybersixgill actionable alerts check on your host:
1. Install the [developer tool][2] on any machine.
2. To build the package, run the command: `ddev release build cybersixgill_actionable_alerts`.
3. [Install the Datadog Agent][1] on your host.
4. Once the Agent is installed, run the following command to install the integration:
```
datadog-agent integration install -t datadog-Cybersixgill Actionable Alerts==1.0.0
```

### Configuration
5. Reach out to [Cybersixgill Support][4] and request access to the Cybersixgill Developer Platform.
6. Receive the welcome email with access to the Cybersixgill developer platform.
7. Within the Cybersixgill developer platform, create the Client ID and Client secret.
8. Copy the Client ID and Client secret and paste them into the Configuration.yaml file.
9. Provide the minimum collection interval in seconds. For example, `min_collection_interval: 3600`

### Validation
Verify that Cybersixgill events are generated in the [Datadog Events Explorer][3].

## Data Collected

### Service Checks
eho1307 marked this conversation as resolved.
Show resolved Hide resolved
See [service_checks.json][5] for a list of service checks provided by this integration.

### Events
This integration sends API-type events to Datadog.

## Troubleshooting
Need help? Contact [Cybersixgill support][4].

[1]: https://app.datadoghq.com/account/settings#agent
[2]: https://docs.datadoghq.com/developers/integrations/new_check_howto/?tab=configurationtemplate#configure-the-developer-tool
[3]: https://app.datadoghq.com/event/explorer
[4]: mailto:[email protected]
[5]: https://github.com/DataDog/integrations-extras/blob/master/cybersixgill_actionable_alerts/assets/service_checks.json

71 changes: 71 additions & 0 deletions cybersixgill_actionable_alerts/assets/configuration/spec.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: cybersixgill_actionable_alerts
files:
- name: cybersixgill_actionable_alerts.yaml
options:
- template: init_config
options:
- template: init_config/default
- template: instances
options:
- name: cl_id
required: true
description: The Client Id given by Cybersixgill
enabled: true
value:
type: string
example: clientid
display_default: null
- name: cl_secret
required: true
description: The Client Secret given by Cybersixgill
enabled: true
value:
type: string
display_default: null
secret: true
- name: alerts_limit
required: false
description: The number of alerts to fetch on a single request default is 50
enabled: false
value:
type: integer
example: 50
display_default: null
- name: threat_type
required: false
description: Predefined types of threats alerts you would like to see like fraud, malware
enabled: false
value:
type: string
example: compromised accounts, fraud
display_default: null
enum:
- Brand Protection
- Data Leak
- Malware
- Phishing
- Fraud
- Vulnerability Exploit
- Insider Threat
- Defacement
- Compromised Accounts
- DDoS Attack
- Web Attack
- Trend Anomaly
- name: threat_level
required: false
description: Type of alerts which are either imminent or emerging
enabled: false
value:
type: string
example: imminent
display_default: null
- name: organization_id
required: false
description: The Organization Id provided by Cybersixgill
enabled: false
value:
type: string
example: orgidexample
display_default: null
- template: instances/default
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
{
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am unable to review the dashboard. Can you re-copy the dashboard json from your account and upload it here? Thanks!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fshaik3494 Can you update the title on the dashboard and export it to replace the output in this file? Thanks!

"title": "Cybersixgill Actionable Alerts - Overview",
"description": "This Dashboard helps you to understand the Actionable alerts of your assets like the count of alerts, alert titles and count of imminent and emerging alerts.",
"widgets": [
{
"id": 8775317340528879,
"definition": {
"title": "Alerts Count",
"title_size": "16",
"title_align": "left",
"show_legend": false,
"legend_layout": "auto",
"legend_columns": [
"avg",
"min",
"max",
"value",
"sum"
],
"time": {},
"type": "timeseries",
"requests": [
{
"formulas": [
{
"formula": "query1"
}
],
"response_format": "timeseries",
"queries": [
{
"search": {
"query": "source:my_apps"
},
"data_source": "events",
"compute": {
"aggregation": "count"
},
"name": "query1",
"indexes": [
"*"
],
"group_by": []
}
],
"style": {
"palette": "dog_classic"
},
"display_type": "bars"
}
]
},
"layout": {
"x": 0,
"y": 0,
"width": 11,
"height": 3
}
},
{
"id": 6080537854801146,
"definition": {
"title": "Alerts Title",
"title_size": "16",
"title_align": "left",
"time": {},
"type": "event_stream",
"query": "source: my_apps",
"event_size": "s"
},
"layout": {
"x": 0,
"y": 3,
"width": 11,
"height": 5
}
},
{
"id": 2249705270211652,
"definition": {
"title": "Imminent Alerts",
"title_size": "16",
"title_align": "left",
"requests": [
{
"formulas": [
{
"formula": "query2",
"limit": {
"order": "desc"
}
}
],
"response_format": "scalar",
"queries": [
{
"search": {
"query": "source:my_apps message:\"Threat Level: imminent\""
},
"data_source": "events",
"compute": {
"aggregation": "count"
},
"name": "query2",
"indexes": [
"*"
],
"group_by": []
}
]
}
],
"type": "sunburst",
"legend": {
"type": "automatic"
}
},
"layout": {
"x": 0,
"y": 8,
"width": 4,
"height": 4
}
},
{
"id": 1434403194670864,
"definition": {
"title": "Emerging Alerts",
"title_size": "16",
"title_align": "left",
"requests": [
{
"formulas": [
{
"formula": "query2",
"limit": {
"order": "desc"
}
}
],
"response_format": "scalar",
"queries": [
{
"search": {
"query": "source:my_apps message:\"Threat Level: emerging\""
},
"data_source": "events",
"compute": {
"aggregation": "count"
},
"name": "query2",
"indexes": [
"*"
],
"group_by": []
}
]
}
],
"type": "sunburst",
"legend": {
"type": "automatic"
}
},
"layout": {
"x": 4,
"y": 8,
"width": 4,
"height": 4
}
}
],
"template_variables": [],
"layout_type": "ordered",
"is_read_only": false,
"notify_list": [],
"reflow_type": "fixed",
"id": "tz2-pyd-932"
}

Loading