Skip to content

Commit

Permalink
Merge pull request #9084 from Azure/v-rusraut/PaloAltoCDL-MMAtoAMAMig…
Browse files Browse the repository at this point in the history
…ration

Repackaging - PaloAltoCDL (MMA to AMA Migration)
  • Loading branch information
v-atulyadav authored Sep 27, 2023
2 parents 5f02895 + a6f59d7 commit 9791afc
Show file tree
Hide file tree
Showing 30 changed files with 2,304 additions and 1,805 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -206,5 +206,6 @@
"ContrastProtectAma",
"ClarotyAma",
"illusiveAttackManagementSystemAma",
"TrendMicroApexOneAma"
"TrendMicroApexOneAma",
"PaloAltoCDLAma"
]
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ requiredDataConnectors:
- connectorId: PaloAltoCDL
dataTypes:
- PaloAltoCDLEvent
- connectorId: PaloAltoCDLAma
dataTypes:
- PaloAltoCDLEvent
queryFrequency: 1h
queryPeriod: 1h
triggerOperator: gt
Expand Down Expand Up @@ -35,5 +38,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: PaloAltoCDL
dataTypes:
- PaloAltoCDLEvent
- connectorId: PaloAltoCDLAma
dataTypes:
- PaloAltoCDLEvent
queryFrequency: 1h
queryPeriod: 1h
triggerOperator: gt
Expand Down Expand Up @@ -36,5 +39,5 @@ entityMappings:
fieldMappings:
- identifier: Address
columnName: IPCustomEntity
version: 1.0.1
version: 1.0.2
kind: Scheduled
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ requiredDataConnectors:
- connectorId: PaloAltoCDL
dataTypes:
- PaloAltoCDLEvent
- connectorId: PaloAltoCDLAma
dataTypes:
- PaloAltoCDLEvent
queryFrequency: 1h
queryPeriod: 1h
triggerOperator: gt
Expand All @@ -32,5 +35,5 @@ entityMappings:
fieldMappings:
- identifier: Name
columnName: FileCustomEntity
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: PaloAltoCDL
dataTypes:
- PaloAltoCDLEvent
- connectorId: PaloAltoCDLAma
dataTypes:
- PaloAltoCDLEvent
queryFrequency: 1h
queryPeriod: 1h
triggerOperator: gt
Expand All @@ -29,5 +32,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: PaloAltoCDL
dataTypes:
- PaloAltoCDLEvent
- connectorId: PaloAltoCDLAma
dataTypes:
- PaloAltoCDLEvent
queryFrequency: 1h
queryPeriod: 1h
triggerOperator: gt
Expand Down Expand Up @@ -35,5 +38,5 @@ entityMappings:
fieldMappings:
- identifier: Url
columnName: UrlCustomEntity
version: 1.0.1
version: 1.0.2
kind: Scheduled
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ requiredDataConnectors:
- connectorId: PaloAltoCDL
dataTypes:
- PaloAltoCDLEvent
- connectorId: PaloAltoCDLAma
dataTypes:
- PaloAltoCDLEvent
queryFrequency: 1h
queryPeriod: 1h
triggerOperator: gt
Expand All @@ -32,5 +35,5 @@ entityMappings:
fieldMappings:
- identifier: Address
columnName: IPCustomEntity
version: 1.0.1
version: 1.0.2
kind: Scheduled
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ requiredDataConnectors:
- connectorId: PaloAltoCDL
dataTypes:
- PaloAltoCDLEvent
- connectorId: PaloAltoCDLAma
dataTypes:
- PaloAltoCDLEvent
queryFrequency: 1h
queryPeriod: 1h
triggerOperator: gt
Expand All @@ -29,5 +32,5 @@ entityMappings:
fieldMappings:
- identifier: Address
columnName: IPCustomEntity
version: 1.0.1
version: 1.0.2
kind: Scheduled
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ requiredDataConnectors:
- connectorId: PaloAltoCDL
dataTypes:
- PaloAltoCDLEvent
- connectorId: PaloAltoCDLAma
dataTypes:
- PaloAltoCDLEvent
queryFrequency: 1h
queryPeriod: 14d
triggerOperator: gt
Expand All @@ -34,5 +37,5 @@ entityMappings:
fieldMappings:
- identifier: Name
columnName: AccountCustomEntity
version: 1.0.1
version: 1.0.2
kind: Scheduled
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ requiredDataConnectors:
- connectorId: PaloAltoCDL
dataTypes:
- PaloAltoCDLEvent
- connectorId: PaloAltoCDLAma
dataTypes:
- PaloAltoCDLEvent
queryFrequency: 10m
queryPeriod: 10m
triggerOperator: gt
Expand All @@ -30,5 +33,5 @@ entityMappings:
fieldMappings:
- identifier: Name
columnName: FileCustomEntity
version: 1.0.1
version: 1.0.2
kind: Scheduled
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ requiredDataConnectors:
- connectorId: PaloAltoCDL
dataTypes:
- PaloAltoCDLEvent
- connectorId: PaloAltoCDLAma
dataTypes:
- PaloAltoCDLEvent
queryFrequency: 1h
queryPeriod: 1h
triggerOperator: gt
Expand All @@ -33,5 +36,5 @@ entityMappings:
fieldMappings:
- identifier: Address
columnName: IPCustomEntity
version: 1.0.1
version: 1.0.2
kind: Scheduled
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"id": "PaloAltoCDL",
"title": "Palo Alto Networks Cortex Data Lake (CDL)",
"title": "[Deprecated] Palo Alto Networks Cortex Data Lake (CDL) via Legacy Agent",
"publisher": "Palo Alto Networks",
"descriptionMarkdown": "The [Palo Alto Networks CDL](https://www.paloaltonetworks.com/cortex/cortex-data-lake) data connector provides the capability to ingest [CDL logs](https://docs.paloaltonetworks.com/cortex/cortex-data-lake/log-forwarding-schema-reference/log-forwarding-schema-overview.html) into Microsoft Sentinel.",
"additionalRequirementBanner": "This data connector depends on a parser based on a Kusto Function to work as expected [**PaloAltoCDLEvent**](https://aka.ms/sentinel-paloaltocdl-parser) which is deployed with the Microsoft Sentinel Solution.",
Expand Down
115 changes: 115 additions & 0 deletions Solutions/PaloAltoCDL/Data Connectors/template_PaloAlto_CDLAMA.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
{
"id": "PaloAltoCDLAma",
"title": "[Recommended] Palo Alto Networks Cortex Data Lake (CDL) via AMA",
"publisher": "Palo Alto Networks",
"descriptionMarkdown": "The [Palo Alto Networks CDL](https://www.paloaltonetworks.com/cortex/cortex-data-lake) data connector provides the capability to ingest [CDL logs](https://docs.paloaltonetworks.com/cortex/cortex-data-lake/log-forwarding-schema-reference/log-forwarding-schema-overview.html) into Microsoft Sentinel.",
"additionalRequirementBanner": "This data connector depends on a parser based on a Kusto Function to work as expected [**PaloAltoCDLEvent**](https://aka.ms/sentinel-paloaltocdl-parser) which is deployed with the Microsoft Sentinel Solution.",
"graphQueries": [
{
"metricName": "Total data received",
"legend": "PaloAltoNetworksCDL",
"baseQuery": "CommonSecurityLog\n |where DeviceVendor =~ 'Palo Alto Networks'\n |where DeviceProduct =~ 'LF'\n |extend sent_by_ama = column_ifexists('CollectorHostName','')\n |where isnotempty(sent_by_ama)"
}
],
"sampleQueries": [
{
"description" : "Top 10 Destinations",
"query": "PaloAltoCDLEvent\n | where isnotempty(DstIpAddr)\n | summarize count() by DstIpAddr\n | top 10 by count_"
}
],
"dataTypes": [
{
"name": "CommonSecurityLog (PaloAltoNetworksCDL)",
"lastDataReceivedQuery": "CommonSecurityLog\n |where DeviceVendor =~ 'Palo Alto Networks'\n |where DeviceProduct =~ 'LF'\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 =~ 'Palo Alto Networks'\n |where DeviceProduct =~ 'LF'\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 [**PaloAltoCDLEvent**](https://aka.ms/sentinel-paloaltocdl-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 Cortex Data Lake to forward logs to a Syslog Server using CEF",
"description": "[Follow the instructions](https://docs.paloaltonetworks.com/cortex/cortex-data-lake/cortex-data-lake-getting-started/get-started-with-log-forwarding-app/forward-logs-from-logging-service-to-syslog-server.html) to configure logs forwarding from Cortex Data Lake to a Syslog Server.",
"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)"
}
]
}
7 changes: 4 additions & 3 deletions Solutions/PaloAltoCDL/Data/Solution_PaloAltoCDL.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
"Name": "PaloAltoCDL",
"Author": "Microsoft - support@microsoft.com",
"Logo": "<img src=\"https://raw.githubusercontent.com/Azure/Azure-Sentinel/master/Solutions/PaloAltoCDL/logo/Palo-alto-logo.png\" width=\"75px\" height=\"75px\">",
"Description": "The [Palo Alto Networks CDL](https://www.paloaltonetworks.com/cortex/cortex-data-lake) solution provides the capability to ingest [CDL logs](https://docs.paloaltonetworks.com/cortex/cortex-data-lake/log-forwarding-schema-reference/log-forwarding-schema-overview) into Microsoft Sentinel.\n\r**Underlying Microsoft Technologies used:**\n\rThis 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:\n\ra. [Agent-based log collection (CEF over Syslog)](https://docs.microsoft.com/azure/sentinel/connect-common-event-format)",
"Description": "The [Palo Alto Networks CDL](https://www.paloaltonetworks.com/cortex/cortex-data-lake) solution provides the capability to ingest [CDL logs](https://docs.paloaltonetworks.com/cortex/cortex-data-lake/log-forwarding-schema-reference/log-forwarding-schema-overview) into Microsoft Sentinel.\n\r\n1. **PaloAltoCDL via AMA** - This data connector helps in ingesting PaloAltoCDL 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. **PaloAltoCDL via Legacy Agent** - This data connector helps in ingesting PaloAltoCDL logs into your Log Analytics Workspace using the legacy Log Analytics agent.\n\n**NOTE:** Microsoft recommends installation of PaloAltoCDL 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/PaloAltoCDL.json"
],
"Parsers": [
"Parsers/PaloAltoCDLEvent.txt"
"Parsers/PaloAltoCDLEvent.yaml"
],
"Hunting Queries": [
"Hunting Queries/PaloAltoCDLCriticalEventResult.yaml",
Expand All @@ -22,7 +22,8 @@
"Hunting Queries/PaloAltoCDLRarePortsbyUser.yaml"
],
"Data Connectors": [
"Data Connectors/Connector_PaloAlto_CDL_CEF.json"
"Data Connectors/Connector_PaloAlto_CDL_CEF.json",
"Data Connectors/template_PaloAlto_CDLAMA.json"
],
"Analytic Rules": [
"Analytic Rules/PaloAltoCDLConflictingMacAddress.yaml",
Expand Down
33 changes: 33 additions & 0 deletions Solutions/PaloAltoCDL/Data/system_generated_metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"Name": "PaloAltoCDL",
"Author": "Microsoft - support@microsoft.com",
"Logo": "<img src=\"https://raw.githubusercontent.com/Azure/Azure-Sentinel/master/Solutions/PaloAltoCDL/logo/Palo-alto-logo.png\" width=\"75px\" height=\"75px\">",
"Description": "The [Palo Alto Networks CDL](https://www.paloaltonetworks.com/cortex/cortex-data-lake) solution provides the capability to ingest [CDL logs](https://docs.paloaltonetworks.com/cortex/cortex-data-lake/log-forwarding-schema-reference/log-forwarding-schema-overview) into Microsoft Sentinel.\n\r\n1. **PaloAltoCDL via AMA** - This data connector helps in ingesting PaloAltoCDL 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. **PaloAltoCDL via Legacy Agent** - This data connector helps in ingesting PaloAltoCDL logs into your Log Analytics Workspace using the legacy Log Analytics agent.\n\n**NOTE:** Microsoft recommends installation of PaloAltoCDL 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:\\One\\Azure\\Azure-Sentinel\\Solutions\\PaloAltoCDL",
"TemplateSpec": true,
"Is1PConnector": false,
"Version": "3.0.0",
"publisherId": "azuresentinel",
"offerId": "azure-sentinel-solution-paloaltocdl",
"providers": [
"Palo Alto Networks"
],
"categories": {
"domains": [
"Security - Cloud Security"
]
},
"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_PaloAlto_CDL_CEF.json\",\n \"Data Connectors/template_PaloAlto_CDLAMA.json\"\n]",
"Parsers": "[\n \"PaloAltoCDLEvent.yaml\"\n]",
"Workbooks": "[\n \"Workbooks/PaloAltoCDL.json\"\n]",
"Analytic Rules": "[\n \"PaloAltoCDLConflictingMacAddress.yaml\",\n \"PaloAltoCDLDroppingSessionWithSentTraffic.yaml\",\n \"PaloAltoCDLFileTypeWasChanged.yaml\",\n \"PaloAltoCDLInboundRiskPorts.yaml\",\n \"PaloAltoCDLPossibleAttackWithoutResponse.yaml\",\n \"PaloAltoCDLPossibleFlooding.yaml\",\n \"PaloAltoCDLPossiblePortScan.yaml\",\n \"PaloAltoCDLPrivilegesWasChanged.yaml\",\n \"PaloAltoCDLPutMethodInHighRiskFileType.yaml\",\n \"PaloAltoCDLUnexpectedCountries.yaml\"\n]",
"Hunting Queries": "[\n \"PaloAltoCDLCriticalEventResult.yaml\",\n \"PaloAltoCDLFilePermissionWithPutRequest.yaml\",\n \"PaloAltoCDLIPsByPorts.yaml\",\n \"PaloAltoCDLIncompleteApplicationProtocol.yaml\",\n \"PaloAltoCDLMultiDenyResultbyUser.yaml\",\n \"PaloAltoCDLOutdatedAgentVersions.yaml\",\n \"PaloAltoCDLOutdatedConfigVersions.yaml\",\n \"PaloAltoCDLRareApplicationLayerProtocol.yaml\",\n \"PaloAltoCDLRareFileRequests.yaml\",\n \"PaloAltoCDLRarePortsbyUser.yaml\"\n]"
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ requiredDataConnectors:
- connectorId: PaloAltoCDL
dataTypes:
- PaloAltoCDLEvent
- connectorId: PaloAltoCDLAma
dataTypes:
- PaloAltoCDLEvent
tactics:
- InitialAccess
relevantTechniques:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ requiredDataConnectors:
- connectorId: PaloAltoCDL
dataTypes:
- PaloAltoCDLEvent
- connectorId: PaloAltoCDLAma
dataTypes:
- PaloAltoCDLEvent
tactics:
- InitialAccess
relevantTechniques:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ requiredDataConnectors:
- connectorId: PaloAltoCDL
dataTypes:
- PaloAltoCDLEvent
- connectorId: PaloAltoCDLAma
dataTypes:
- PaloAltoCDLEvent
tactics:
- InitialAccess
relevantTechniques:
Expand Down
Loading

0 comments on commit 9791afc

Please sign in to comment.