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

[standardization] Sentinel Watchlist, FetchIncidentCommentsfromSentinel #170

Merged
merged 6 commits into from
Feb 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
Descriptor:
Name: fetch sentinel incident comments
DisplayName: "fetch sentinel incident comments"
Description: pullback sentinel incident comments
Name: Fetch Sentinel incident comments
DisplayName: Fetch Sentinel incident comments
Description: Pullback Sentinel incident comments
SkillGroups:
- Format: KQL
Skills:
- Name: fetch sentinel incident comments
DisplayName: fetch sentinel incident comments
Description: fetch sentinel incident comments
- Name: SentinelIncidentComments
DisplayName: Fetch Sentinel incident comments
Description: Fetch Sentinel incident comments
Inputs:
- Name: incidentNumber
Description: incident number
Required: true
Settings:
Target: Sentinel
TenantId: xxxxx
SubscriptionId: xxxxx
ResourceGroupName: xxxxx
WorkspaceName: xxxxx
TenantId: <your_tenant_ID>
SubscriptionId: <your_subscription_ID>
ResourceGroupName: <your_RG_name>
WorkspaceName: <your_WS_name>
Template: |-
SecurityIncident
| where TimeGenerated > ago(14d)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Fetch Sentinel incident comments

## DESCRIPTION
This plugin shows how to retrieve comments associated with a Sentinel Incident to add context to an investigation performed with Security Copilot.

---

## TYPE AND REQUIREMENTS
**TYPE**: KQL (Sentinel) <br>
**SOURCE**: _SecurityIncident_ table <br>
**REQUIREMENTS**: Log Analytics Workspace with Sentinel enabled

---

## SKILLS

<table>
<tbody>
<tr>
<th>SkillName</th>
<th align="center">Description</th>
<th align="center">Parameters</th>
</tr>
<tr>
<td><b>SentinelIncidentComments</b></td>
<td align="center">Fetch Sentinel incident comments</td>
<td>
<ul>
<li>
<i>incidentNumber</i> <br>
</li>
</ul>
</td>
</tr>
</tbody>
</table>


---

## SAMPLE PROMPTS

- `« Fetch Sentinel comments for incident <INCIDENT-NUMBER> and infer what was performed to investigate it »`

---

## SCREENSHOTS
<div align="center">
<img src="https://github.com/mariocuomo/Security-Copilot/blob/main/Images/Community%20Plugins/SentinelIncidentComments/SentinelIncidentComments.png" width="700"> </img>
</div>
Original file line number Diff line number Diff line change
@@ -1,21 +1,53 @@
# Creating a Security Copilot KQL Plugin to Query Sentinel Watchlists
# Sentinel Watchlist integration in Security Copilot

## Utilize the information you maintain in Microsoft Sentinel Watchlists in Security Copilot.
## DESCRIPTION
This plugin demonstrates the possibility of integrating data from a Microsoft Sentinel Watchlist with Security Copilot. <br>
The manifest refers to a watchlist containing trusted users (**TrustedUsers**), but it can easily be adapted to different watchlists.

### Pre-requisites
``` kql
Template: |-
_GetWatchlist('TrustedUsers') | distinct TrustedUsers
```
---

- [Security Copilot Enabled](https://learn.microsoft.com/en-us/security-copilot/get-started-security-copilot#onboarding-to-microsoft-security-copilot)
- [Access to upload custom plugins](https://learn.microsoft.com/en-us/security-copilot/manage-plugins?tabs=securitycopilotplugin#managing-custom-plugins)
- [Microsoft Sentinel Workspace](https://learn.microsoft.com/en-us/azure/sentinel/quickstart-onboard) created.
- Parameters for KQL Plugin - Microsoft Sentinel Workspace Name, Subscription ID, Resource Group Name and Entra Tenant ID
## TYPE AND REQUIREMENTS
**TYPE**: KQL (Sentinel) <br>
**SOURCE**: any watchlist in Sentinel <br>
**REQUIREMENTS**: Log Analytics Workspace with Sentinel enabled

### Instructions
---

#### Upload the Custom Plugin
## SKILLS

1. Obtain the file KQL_Plugin_Watchlist.yaml from this directory.
2. Modify the yaml file to specify your specific Entra TentantId, SubscriptionId, ResourceGroupName and WorkspaceName for your Sentinel instance.
3. Modify the KQL query to reference the Microsoft Sentinel Watchlist for which you want Security Copilot to access.
4. Upload the custom plugin
<table>
<tbody>
<tr>
<th>SkillName</th>
<th align="center">Description</th>
<th align="center">Parameters</th>
</tr>
<tr>
<td><b>GetTrustedUsers</b></td>
<td align="center">Fetches the list of trusted users that is being maintained as a Microsoft Sentinel watchlist</td>
<td>
<ul>
</ul>
</td>
</tr>
</tbody>
</table>


---

## SAMPLE PROMPTS

- `« Fetch the trusted users in Sentinel »`
---

## SCREENSHOTS
<div align="center">
<img src="https://github.com/mariocuomo/Security-Copilot/blob/main/Images/Community%20Plugins/WatchlistKQL/TrustedUserWatchlist.png" width="700"> </img>
</div>

For more information, see: [Creating a Security Copilot KQL Plugin to Query Sentinel Watchlists](https://rodtrent.substack.com/p/creating-a-copilot-for-security-kql)