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

Repackaging - Illusive Platform (MMA to AMA Migration) #9002

Merged
merged 6 commits into from
Sep 19, 2023
Merged
Show file tree
Hide file tree
Changes from 4 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
Original file line number Diff line number Diff line change
Expand Up @@ -202,5 +202,6 @@
"PingFederateAma",
"vArmourACAma",
"ContrastProtectAma",
"ClarotyAma"
"ClarotyAma",
"illusiveAttackManagementSystemAma"
]
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ requiredDataConnectors:
- connectorId: Illusive
dataTypes:
- CommonSecurityLog
- connectorId: illusiveAttackManagementSystemAma
dataTypes:
- CommonSecurityLog
queryFrequency: 5m
queryPeriod: 5m
triggerOperator: gt
Expand Down Expand Up @@ -46,5 +49,5 @@ alertDetailsOverride:
Illusive Incident: {{IncidentId}}
alertDescriptionFormat: |
Illusive Incident {{IncidentId}} generated at {{TimeGenerated}}
version: 1.0.2
version: 1.0.3
kind: Scheduled
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"id": "illusiveAttackManagementSystem",
"title": "Illusive Platform",
"title": "[Deprecated] Illusive Platform via Legacy Agent",
"publisher": "illusive",
"descriptionMarkdown": "The Illusive Platform Connector allows you to share Illusive's attack surface analysis data and incident logs with Microsoft Sentinel and view this information in dedicated dashboards that offer insight into your organization's attack surface risk (ASM Dashboard) and track unauthorized lateral movement in your organization's network (ADS Dashboard).",
"graphQueries": [
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
{
"id": "illusiveAttackManagementSystemAma",
"title": "[Recommended] Illusive Platform via AMA",
"publisher": "illusive",
"descriptionMarkdown": "The Illusive Platform Connector allows you to share Illusive's attack surface analysis data and incident logs with Microsoft Sentinel and view this information in dedicated dashboards that offer insight into your organization's attack surface risk (ASM Dashboard) and track unauthorized lateral movement in your organization's network (ADS Dashboard).",
"graphQueries": [
{
"metricName": "Total data received",
"legend": "illusive",
"baseQuery": "CommonSecurityLog\n |where DeviceVendor =~ 'illusive'\n |where DeviceProduct =~ 'illusive'\n |extend sent_by_ama = column_ifexists('CollectorHostName','')\n |where isnotempty(sent_by_ama)"
}
],
"sampleQueries": [
{
"description": "Number of Incidents in in the last 30 days in which Trigger Type is found",
"query": "union CommonSecurityLog\r\n| where (DeviceEventClassID == \"illusive:login\" or DeviceEventClassID == \"illusive:access\" or DeviceEventClassID == \"illusive:suspicious\")\r\n| where Message !contains \"hasForensics\" \r\n| where TimeGenerated > ago(30d) \r\n| extend DeviceCustomNumber2 = coalesce(column_ifexists(\"FieldDeviceCustomNumber2\", long(null)), DeviceCustomNumber2, long(null))\r\n| summarize by DestinationServiceName, DeviceCustomNumber2 \r\n| summarize incident_count=count() by DestinationServiceName"
},
{
"description": "Top 10 alerting hosts in the last 30 days",
"query": "union CommonSecurityLog \r\n| where (DeviceEventClassID == \"illusive:login\" or DeviceEventClassID == \"illusive:access\" or DeviceEventClassID == \"illusive:suspicious\")\r\n| where Message !contains \"hasForensics\" \r\n| where TimeGenerated > ago(30d) \r\n| extend DeviceCustomNumber2 = coalesce(column_ifexists(\"FieldDeviceCustomNumber2\", long(null)), DeviceCustomNumber2, long(null)) \r\n| summarize by AlertingHost=iff(SourceHostName != \"\" and SourceHostName != \"Failed to obtain\", SourceHostName, SourceIP) ,DeviceCustomNumber2 \r\n| where AlertingHost != \"\" and AlertingHost != \"Failed to obtain\" \r\n| summarize incident_count=count() by AlertingHost \r\n| order by incident_count \r\n| limit 10"
}
],
"dataTypes": [
{
"name": "CommonSecurityLog (illusive)",
"lastDataReceivedQuery": "CommonSecurityLog\n |where DeviceVendor =~ 'illusive'\n |where DeviceProduct =~ 'illusive'\n |extend sent_by_ama = column_ifexists('CollectorHostName','')\n |where isnotempty(sent_by_ama)\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)"
}
],
"connectivityCriterias": [
{
"type": "IsConnectedQuery",
"value": [
"CommonSecurityLog\n |where DeviceVendor =~ 'illusive'\n |where DeviceProduct =~ 'illusive'\n |extend sent_by_ama = column_ifexists('CollectorHostName','')\n |where isnotempty(sent_by_ama)\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)"
]
}
],
"availability": {
"status": 1,
"isPreview": false
},
"permissions": {
"resourceProvider": [
{
"provider": "Microsoft.OperationalInsights/workspaces",
"permissionsDisplayText": "read and write permissions are required.",
"providerDisplayName": "Workspace",
"scope": "Workspace",
"requiredPermissions": {
"read": true,
"write": true,
"delete": true
}
},
{
"provider": "Microsoft.OperationalInsights/workspaces/sharedKeys",
"permissionsDisplayText": "read permissions to shared keys for the workspace are required. [See the documentation to learn more about workspace keys](https://docs.microsoft.com/azure/azure-monitor/platform/agent-windows#obtain-workspace-id-and-key).",
"providerDisplayName": "Keys",
"scope": "Workspace",
"requiredPermissions": {
"action": true
}
}
],
"customs": [
{
"description": "To collect data from non-Azure VMs, they must have Azure Arc installed and enabled. [Learn more](https://docs.microsoft.com/azure/azure-monitor/agents/azure-monitor-agent-install?tabs=ARMAgentPowerShell,PowerShellWindows,PowerShellWindowsArc,CLIWindows,CLIWindowsArc)"
},
{
"description": "Common Event Format (CEF) via AMA and Syslog via AMA data connectors must be installed [Learn more](https://learn.microsoft.com/azure/sentinel/connect-cef-ama#open-the-connector-page-and-create-the-dcr)"
}
]
},
"instructionSteps": [
{
"title": "",
"description": "",
"instructions": [
{
"parameters": {
"title": "1. Kindly follow the steps to configure the data connector",
"instructionSteps": [
{
"title": "Step A. Configure the Common Event Format (CEF) via AMA data connector",
"description": "_Note:- CEF logs are collected only from Linux Agents_\n\n1. Navigate to Microsoft Sentinel workspace ---> configuration ---> Data connector blade .\n\n2. Search for 'Common Event Format (CEF) via AMA' data connector and open it.\n\n3. Check If there is no existing DCR configured to collect required facility of logs, Create a new DCR (Data Collection Rule)\n\n\t_Note:- It is recommended to install minimum 1.27 version of AMA agent [Learn more](https://learn.microsoft.com/azure/azure-monitor/agents/azure-monitor-agent-manage?tabs=azure-portal ) and ensure there is no duplicate DCR as it can cause log duplicacy_\n\n4. Run the command provided in the CEF via AMA data connector page to configure the CEF collector on the machine",
"instructions": [
]
},
{
"title": "Step B. Forward Illusive Common Event Format (CEF) logs to Syslog agent",
"description": "1. Set your security solution to send Syslog messages in CEF format to the proxy machine. Make sure you to send the logs to port 514 TCP on the machine's IP address.\n> 2. Log onto the Illusive Console, and navigate to Settings->Reporting.\n> 3. Find Syslog Servers\n> 4. Supply the following information:\n>> 1. Host name: Linux Syslog agent IP address or FQDN host name\n>> 2. Port: 514\n>> 3. Protocol: TCP\n>> 4. Audit messages: Send audit messages to server\n> 5. To add the syslog server, click Add.\n> 6. For more information about how to add a new syslog server in the Illusive platform, please find the Illusive Networks Admin Guide in here: https://support.illusivenetworks.com/hc/en-us/sections/360002292119-Documentation-by-Version",
"instructions": [
]
},
{
"title": "Step C. Validate connection",
"description": "Follow the instructions to validate your connectivity:\n\nOpen Log Analytics to check if the logs are received using the CommonSecurityLog schema.\n\nIt may take about 20 minutes until the connection streams data to your workspace.\n\nIf the logs are not received, run the following connectivity validation script:\n\n 1. Make sure that you have Python on your machine using the following command: python -version\n\n2. You must have elevated permissions (sudo) on your machine",
"instructions": [
{
"parameters": {
"label": "Run the following command to validate your connectivity:",
"value": "sudo wget -O Sentinel_AMA_troubleshoot.py https://raw.githubusercontent.com/Azure/Azure-Sentinel/master/DataConnectors/Syslog/Sentinel_AMA_troubleshoot.py&&sudo python Sentinel_AMA_troubleshoot.py --cef"
},
"type": "CopyableLabel"
}
]
}
]
},
"type": "InstructionStepsGroup"
}
]
},


{
"title": "2. Secure your machine ",
"description": "Make sure to configure the machine's security according to your organization's security policy\n\n\n[Learn more >](https://aka.ms/SecureCEF)"
}
],
"metadata": {
"id": "aa770f1e-4d05-477a-8dc1-b893772f3a46",
"version": "1.0.0",
"kind": "dataConnector",
"source": {
"kind": "community"
},
"author": {
"name": "Illusive Networks"
},
"support": {
"name": "Illusive Networks",
"link": "https://www.illusivenetworks.com/technical-support/",
"tier": "developer"
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@
"Name": "Illusive Platform",
"Author": "Illusive Networks",
"Logo": "<img src=\"https://raw.githubusercontent.com/Azure/Azure-Sentinel/master/Logos/illusiveAttackManagementSystem.svg\" width=\"75px\" height=\"75px\">",
"Description": "The Illusive Platform solution for Microsoft Sentinel enables you to ingest Illusive Platform’s attack surface analysis data and incident logs into Microsoft Sentinel and view this information in dedicated dashboards that offer insight into your organization's attack surface risk (ASM Dashboard) and track unauthorized lateral movement in your organization's network (ADS Dashboard). \r\n\r\n **Underlying Microsoft Technologies used:**\r\n\r\n This solution takes a dependency on the following technologies, and some of these dependencies either may be in [Preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) state or might result in additional ingestion or operational costs:\r\n\n a. [Agent-based log collection (CEF over Syslog)](https://docs.microsoft.com/azure/sentinel/connect-common-event-format)\r\n\n",
"Description": "The Illusive Platform solution for Microsoft Sentinel enables you to ingest Illusive Platform’s attack surface analysis data and incident logs into Microsoft Sentinel and view this information in dedicated dashboards that offer insight into your organization's attack surface risk (ASM Dashboard) and track unauthorized lateral movement in your organization's network (ADS Dashboard).\n\r\n1. **Illusive Platform via AMA** - This data connector helps in ingesting Illusive Platform logs into your Log Analytics Workspace using the new Azure Monitor Agent. Learn more about ingesting using the new Azure Monitor Agent [here](https://learn.microsoft.com/azure/sentinel/connect-cef-ama). **Microsoft recommends using this Data Connector**.\n\r\n2. **Illusive Platform via Legacy Agent** - This data connector helps in ingesting Illusive Platform logs into your Log Analytics Workspace using the legacy Log Analytics agent.\n\n**NOTE:** Microsoft recommends installation of Illusive Platform via AMA Connector. Legacy connector uses the Log Analytics agent which is about to be deprecated by **Aug 31, 2024,** and thus should only be installed where AMA is not supported. Using MMA and AMA on same machine can cause log duplication and extra ingestion cost [more details](https://learn.microsoft.com/en-us/azure/sentinel/ama-migrate).",

"Data Connectors": [
"Data Connectors/illusive Attack Management System.json"
"Data Connectors/illusive Attack Management System.json",
"Data Connectors/template_IllusivePlatformAMA.json"
],
"Workbooks": [
"Workbooks/IllusiveADS.json",
Expand All @@ -15,7 +16,7 @@
"Analytic Rules/Illusive_Detection_Query.yaml"
],
"BasePath": "C:\\GitHub\\Azure-Sentinel\\Solutions\\Illusive Platform",
"Version": "2.0.1",
"Version": "3.0.0",
"Metadata": "SolutionMetadata.json",
"TemplateSpec": true,
"Is1PConnector": false
Expand Down
31 changes: 31 additions & 0 deletions Solutions/Illusive Platform/Data/system_generated_metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"Name": "Illusive Platform",
"Author": "Illusive Networks",
"Logo": "<img src=\"https://raw.githubusercontent.com/Azure/Azure-Sentinel/master/Logos/illusiveAttackManagementSystem.svg\" width=\"75px\" height=\"75px\">",
"Description": "The Illusive Platform solution for Microsoft Sentinel enables you to ingest Illusive Platform’s attack surface analysis data and incident logs into Microsoft Sentinel and view this information in dedicated dashboards that offer insight into your organization's attack surface risk (ASM Dashboard) and track unauthorized lateral movement in your organization's network (ADS Dashboard).\n\r\n1. **Illusive Platform via AMA** - This data connector helps in ingesting Illusive Platform logs into your Log Analytics Workspace using the new Azure Monitor Agent. Learn more about ingesting using the new Azure Monitor Agent [here](https://learn.microsoft.com/azure/sentinel/connect-cef-ama). **Microsoft recommends using this Data Connector**.\n\r\n2. **Illusive Platform via Legacy Agent** - This data connector helps in ingesting Illusive Platform logs into your Log Analytics Workspace using the legacy Log Analytics agent.\n\n**NOTE:** Microsoft recommends installation of Illusive Platform via AMA Connector. Legacy connector uses the Log Analytics agent which is about to be deprecated by **Aug 31, 2024,** and thus should only be installed where AMA is not supported. Using MMA and AMA on same machine can cause log duplication and extra ingestion cost [more details](https://learn.microsoft.com/en-us/azure/sentinel/ama-migrate).",
"BasePath": "C:\\GitHub\\Azure-Sentinel\\Solutions\\Illusive Platform",
"Version": "3.0.0",
"Metadata": "SolutionMetadata.json",
"TemplateSpec": true,
"Is1PConnector": false,
"publisherId": "illusivenetworks",
"offerId": "illusive_platform_mss",
"providers": [
"Illusive"
],
"categories": {
"domains": [
"Security - Threat Protection",
"Security - Others"
]
},
"firstPublishDate": "2022-05-25",
"support": {
"name": "Illusive Networks",
"tier": "Partner",
"link": "https://illusive.com/support"
},
"Data Connectors": "[\n \"Data Connectors/illusive Attack Management System.json\",\n \"Data Connectors/template_IllusivePlatformAMA.json\"\n]",
"Workbooks": "[\n \"Workbooks/IllusiveADS.json\",\n \"Workbooks/IllusiveASM.json\"\n]",
"Analytic Rules": "[\n \"Illusive_Detection_Query.yaml\"\n]"
}
Binary file added Solutions/Illusive Platform/Package/3.0.0.zip
Binary file not shown.
Loading
Loading