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 - Claroty (MMA to AMA Migration) #8980

Merged
merged 3 commits into from
Sep 13, 2023
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
Original file line number Diff line number Diff line change
Expand Up @@ -199,5 +199,6 @@
"CortexXDR",
"PingFederateAma",
"vArmourACAma",
"ContrastProtectAma"
"ContrastProtectAma",
"ClarotyAma"
]
5 changes: 4 additions & 1 deletion Solutions/Claroty/Analytic Rules/ClarotyAssetDown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ requiredDataConnectors:
- connectorId: Claroty
dataTypes:
- ClarotyEvent
- connectorId: ClarotyAma
dataTypes:
- ClarotyEvent
queryFrequency: 1h
queryPeriod: 1h
triggerOperator: gt
Expand All @@ -26,5 +29,5 @@ entityMappings:
fieldMappings:
- identifier: Address
columnName: IPCustomEntity
version: 1.0.0
version: 1.0.1
kind: Scheduled
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ requiredDataConnectors:
- connectorId: Claroty
dataTypes:
- ClarotyEvent
- connectorId: ClarotyAma
dataTypes:
- ClarotyEvent
queryFrequency: 1h
queryPeriod: 1h
triggerOperator: gt
Expand All @@ -27,5 +30,5 @@ entityMappings:
fieldMappings:
- identifier: Address
columnName: IPCustomEntity
version: 1.0.0
version: 1.0.1
kind: Scheduled
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ requiredDataConnectors:
- connectorId: Claroty
dataTypes:
- ClarotyEvent
- connectorId: ClarotyAma
dataTypes:
- ClarotyEvent
queryFrequency: 1h
queryPeriod: 14d
triggerOperator: gt
Expand Down Expand Up @@ -40,5 +43,5 @@ entityMappings:
fieldMappings:
- identifier: Address
columnName: SrcIpAddr
version: 1.0.0
version: 1.0.1
kind: Scheduled
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ requiredDataConnectors:
- connectorId: Claroty
dataTypes:
- ClarotyEvent
- connectorId: ClarotyAma
dataTypes:
- ClarotyEvent
queryFrequency: 1h
queryPeriod: 1h
triggerOperator: gt
Expand All @@ -31,5 +34,5 @@ entityMappings:
fieldMappings:
- identifier: Name
columnName: AccountCustomEntity
version: 1.0.0
version: 1.0.1
kind: Scheduled
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ requiredDataConnectors:
- connectorId: Claroty
dataTypes:
- ClarotyEvent
- connectorId: ClarotyAma
dataTypes:
- ClarotyEvent
queryFrequency: 1h
queryPeriod: 1h
triggerOperator: gt
Expand All @@ -33,5 +36,5 @@ entityMappings:
fieldMappings:
- identifier: DistinguishedName
columnName: SGCustomEntity
version: 1.0.0
version: 1.0.1
kind: Scheduled
5 changes: 4 additions & 1 deletion Solutions/Claroty/Analytic Rules/ClarotyNewAsset.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ requiredDataConnectors:
- connectorId: Claroty
dataTypes:
- ClarotyEvent
- connectorId: ClarotyAma
dataTypes:
- ClarotyEvent
queryFrequency: 1h
queryPeriod: 1h
triggerOperator: gt
Expand All @@ -26,5 +29,5 @@ entityMappings:
fieldMappings:
- identifier: Address
columnName: IPCustomEntity
version: 1.0.0
version: 1.0.1
kind: Scheduled
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ requiredDataConnectors:
- connectorId: Claroty
dataTypes:
- ClarotyEvent
- connectorId: ClarotyAma
dataTypes:
- ClarotyEvent
queryFrequency: 1h
queryPeriod: 1h
triggerOperator: gt
Expand All @@ -26,5 +29,5 @@ entityMappings:
fieldMappings:
- identifier: Address
columnName: IPCustomEntity
version: 1.0.0
version: 1.0.1
kind: Scheduled
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ requiredDataConnectors:
- connectorId: Claroty
dataTypes:
- ClarotyEvent
- connectorId: ClarotyAma
dataTypes:
- ClarotyEvent
queryFrequency: 1h
queryPeriod: 1h
triggerOperator: gt
Expand All @@ -26,5 +29,5 @@ entityMappings:
fieldMappings:
- identifier: Address
columnName: IPCustomEntity
version: 1.0.0
version: 1.0.1
kind: Scheduled
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ requiredDataConnectors:
- connectorId: Claroty
dataTypes:
- ClarotyEvent
- connectorId: ClarotyAma
dataTypes:
- ClarotyEvent
queryFrequency: 1h
queryPeriod: 1h
triggerOperator: gt
Expand All @@ -26,5 +29,5 @@ entityMappings:
fieldMappings:
- identifier: Address
columnName: IPCustomEntity
version: 1.0.0
version: 1.0.1
kind: Scheduled
5 changes: 4 additions & 1 deletion Solutions/Claroty/Analytic Rules/ClarotyTreat.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ requiredDataConnectors:
- connectorId: Claroty
dataTypes:
- ClarotyEvent
- connectorId: ClarotyAma
dataTypes:
- ClarotyEvent
queryFrequency: 1h
queryPeriod: 1h
triggerOperator: gt
Expand All @@ -26,5 +29,5 @@ entityMappings:
fieldMappings:
- identifier: Address
columnName: IPCustomEntity
version: 1.0.0
version: 1.0.1
kind: Scheduled
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"id": "Claroty",
"title": "Claroty",
"title": "[Deprecated] Claroty via Legacy Agent",
"publisher": "Claroty",
"descriptionMarkdown": "The [Claroty](https://claroty.com/) data connector provides the capability to ingest [Continuous Threat Detection](https://claroty.com/resources/datasheets/continuous-threat-detection) and [Secure Remote Access](https://claroty.com/secure-remote-access/) events into Microsoft Sentinel.",
"additionalRequirementBanner": "This data connector depends on a parser based on a Kusto Function to work as expected [**ClarotyEvent**](https://aka.ms/sentinel-claroty-parser) which is deployed with the Microsoft Sentinel Solution.",
Expand Down
116 changes: 116 additions & 0 deletions Solutions/Claroty/Data Connectors/template_ClarotyAMA.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
{
"id": "ClarotyAma",
"title": "[Recommended] Claroty via AMA",
"publisher": "Claroty",
"descriptionMarkdown": "The [Claroty](https://claroty.com/) data connector provides the capability to ingest [Continuous Threat Detection](https://claroty.com/resources/datasheets/continuous-threat-detection) and [Secure Remote Access](https://claroty.com/secure-remote-access/) events into Microsoft Sentinel.",
"additionalRequirementBanner": "This data connector depends on a parser based on a Kusto Function to work as expected [**ClarotyEvent**](https://aka.ms/sentinel-claroty-parser) which is deployed with the Microsoft Sentinel Solution.",
"graphQueries": [
{
"metricName": "Total data received",
"legend": "Claroty",
"baseQuery": "CommonSecurityLog\n |where DeviceVendor =~ 'Claroty'\n |extend sent_by_ama = column_ifexists('CollectorHostName','')\n |where isnotempty(sent_by_ama)"
}
],
"sampleQueries": [
{
"description" : "Top 10 Destinations",
"query": "ClarotyEvent\n | where isnotempty(DstIpAddr)\n | summarize count() by DstIpAddr\n | top 10 by count_"
}
],
"dataTypes": [
{
"name": "CommonSecurityLog (Claroty)",
"lastDataReceivedQuery": "CommonSecurityLog\n |where DeviceVendor =~ 'Claroty'\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 =~ 'Claroty'\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": {
"write": true,
"read": 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": ">**NOTE:** This data connector depends on a parser based on a Kusto Function to work as expected [**ClarotyEvent**](https://aka.ms/sentinel-claroty-parser) which is deployed with the Microsoft Sentinel Solution.",
"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. Configure Claroty to send logs using CEF",
"description": "Configure log forwarding using CEF:\n\n1. Navigate to the **Syslog** section of the Configuration menu.\n\n2. Select **+Add**.\n\n3. In the **Add New Syslog Dialog** specify Remote Server **IP**, **Port**, **Protocol** and select **Message Format** - **CEF**.\n\n4. Choose **Save** to exit the **Add Syslog dialog**.",
"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)"
}
]
}
9 changes: 5 additions & 4 deletions Solutions/Claroty/Data/Solution_Claroty.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
"Name": "Claroty",
"Author": "Microsoft - support@microsoft.com",
"Logo": "<img src=\"https://raw.githubusercontent.com/Azure/Azure-Sentinel/master/Logos/Azure_Sentinel.svg\" width=\"75px\" height=\"75px\">",
"Description": "The [Claroty](https://claroty.com/) solution for Microsoft Sentinel enables ingestion of  [Continuous Threat Detection](https://claroty.com/resources/datasheets/continuous-threat-detection-ctd) and [Secure Remote Access](https://claroty.com/industrial-cybersecurity/sra) events into Microsoft Sentinel.\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 [Claroty](https://claroty.com/) solution for Microsoft Sentinel enables ingestion of  [Continuous Threat Detection](https://claroty.com/resources/datasheets/continuous-threat-detection-ctd) and [Secure Remote Access](https://claroty.com/industrial-cybersecurity/sra) events into Microsoft Sentinel.\n\r\n1. **Claroty via AMA** - This data connector helps in ingesting Claroty 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. **Claroty via Legacy Agent** - This data connector helps in ingesting Claroty logs into your Log Analytics Workspace using the legacy Log Analytics agent.\n\n**NOTE:** Microsoft recommends installation of Claroty 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).",
"Workbooks": [
"Workbooks/ClarotyOverview.json"
],
"Parsers": [
"Parsers/ClarotyEvent.txt"
"Parsers/ClarotyEvent.yaml"
],
"Hunting Queries": [
"Hunting Queries/ClarotyBaselineDeviation.yaml",
Expand All @@ -22,7 +22,8 @@
"Hunting Queries/ClarotyWriteExecuteOperations.yaml"
],
"Data Connectors": [
"Data Connectors/Connector_Claroty_CEF.json"
"Data Connectors/Connector_Claroty_CEF.json",
"Data Connectors/template_ClarotyAMA.json"
],
"Analytic Rules": [
"Analytic Rules/ClarotyAssetDown.yaml",
Expand All @@ -39,7 +40,7 @@
],
"Metadata": "SolutionMetadata.json",
"BasePath": "C:\\GitHub\\Azure-Sentinel\\Solutions\\Claroty",
"Version": "3.0.0",
"Version": "3.0.1",
"TemplateSpec": true,
"Is1PConnector": false
}
34 changes: 34 additions & 0 deletions Solutions/Claroty/Data/system_generated_metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"Name": "Claroty",
"Author": "Microsoft - support@microsoft.com",
"Logo": "<img src=\"https://raw.githubusercontent.com/Azure/Azure-Sentinel/master/Logos/Azure_Sentinel.svg\" width=\"75px\" height=\"75px\">",
"Description": "The [Claroty](https://claroty.com/) solution for Microsoft Sentinel enables ingestion of  [Continuous Threat Detection](https://claroty.com/resources/datasheets/continuous-threat-detection-ctd) and [Secure Remote Access](https://claroty.com/industrial-cybersecurity/sra) events into Microsoft Sentinel.\n\r\n1. **Claroty via AMA** - This data connector helps in ingesting Claroty 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. **Claroty via Legacy Agent** - This data connector helps in ingesting Claroty logs into your Log Analytics Workspace using the legacy Log Analytics agent.\n\n**NOTE:** Microsoft recommends installation of Claroty 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).",
"Metadata": "SolutionMetadata.json",
"BasePath": "C:\\GitHub\\Azure-Sentinel\\Solutions\\Claroty",
"Version": "3.0.1",
"TemplateSpec": true,
"Is1PConnector": false,
"publisherId": "azuresentinel",
"offerId": "azure-sentinel-solution-claroty",
"providers": [
"Claroty"
],
"categories": {
"domains": [
"Internet of Things (IoT)",
"Security - Others"
]
},
"firstPublishDate": "2021-10-23",
"support": {
"name": "Microsoft Corporation",
"email": "support@microsoft.com",
"tier": "Microsoft",
"link": "https://support.microsoft.com"
},
"Data Connectors": "[\n \"Data Connectors/Connector_Claroty_CEF.json\",\n \"Data Connectors/template_ClarotyAMA.json\"\n]",
"Parsers": "[\n \"ClarotyEvent.yaml\"\n]",
"Workbooks": "[\n \"Workbooks/ClarotyOverview.json\"\n]",
"Analytic Rules": "[\n \"ClarotyAssetDown.yaml\",\n \"ClarotyCriticalBaselineDeviation.yaml\",\n \"ClarotyLoginToUncommonSite.yaml\",\n \"ClarotyMultipleFailedLogin.yaml\",\n \"ClarotyMultipleFailedLoginsSameDst.yaml\",\n \"ClarotyNewAsset.yaml\",\n \"ClarotyPolicyViolation.yaml\",\n \"ClarotySuspiciousActivity.yaml\",\n \"ClarotySuspiciousFileTransfer.yaml\",\n \"ClarotyTreat.yaml\"\n]",
"Hunting Queries": "[\n \"ClarotyBaselineDeviation.yaml\",\n \"ClarotyConflictAssets.yaml\",\n \"ClarotyCriticalEvents.yaml\",\n \"ClarotyPLCLogins.yaml\",\n \"ClarotySRAFailedLogins.yaml\",\n \"ClarotyScanSources.yaml\",\n \"ClarotyScantargets.yaml\",\n \"ClarotyUnapprovedAccess.yaml\",\n \"ClarotyUnresolvedAlerts.yaml\",\n \"ClarotyWriteExecuteOperations.yaml\"\n]"
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ requiredDataConnectors:
- connectorId: Claroty
dataTypes:
- ClarotyEvent
- connectorId: ClarotyAma
dataTypes:
- ClarotyEvent
tactics:
- InitialAccess
relevantTechniques:
Expand Down
Loading
Loading