Skip to content

Commit

Permalink
Merge pull request #8937 from Azure/v-rusraut/PingFederate-MMAtoAMAMi…
Browse files Browse the repository at this point in the history
…gration

Repackaging - PingFederate (MMA to AMA Migration)
  • Loading branch information
v-atulyadav authored Sep 7, 2023
2 parents c63e9fb + b51da01 commit 9c25873
Show file tree
Hide file tree
Showing 31 changed files with 1,320 additions and 760 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -197,5 +197,7 @@
"DynatraceProblems",
"MicrosoftDefenderThreatIntelligence",
"CortexXDR",
"vArmourACAma"
"PingFederateAma",
"vArmourACAma",
"ContrastProtectAma"
]
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ requiredDataConnectors:
- connectorId: PingFederate
dataTypes:
- PingFederateEvent
- connectorId: PingFederateAma
dataTypes:
- PingFederateEvent
queryFrequency: 1d
queryPeriod: 1d
triggerOperator: gt
Expand All @@ -28,5 +31,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: PingFederate
dataTypes:
- PingFederateEvent
- connectorId: PingFederateAma
dataTypes:
- PingFederateEvent
queryFrequency: 1h
queryPeriod: 14d
triggerOperator: gt
Expand Down Expand Up @@ -38,5 +41,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: PingFederate
dataTypes:
- PingFederateEvent
- connectorId: PingFederateAma
dataTypes:
- PingFederateEvent
queryFrequency: 1h
queryPeriod: 1h
triggerOperator: gt
Expand All @@ -32,5 +35,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: PingFederate
dataTypes:
- PingFederateEvent
- connectorId: PingFederateAma
dataTypes:
- PingFederateEvent
queryFrequency: 1d
queryPeriod: 1d
triggerOperator: gt
Expand All @@ -32,5 +35,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: PingFederate
dataTypes:
- PingFederateEvent
- connectorId: PingFederateAma
dataTypes:
- PingFederateEvent
queryFrequency: 1h
queryPeriod: 14d
triggerOperator: gt
Expand All @@ -34,5 +37,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: PingFederate
dataTypes:
- PingFederateEvent
- connectorId: PingFederateAma
dataTypes:
- PingFederateEvent
queryFrequency: 1d
queryPeriod: 1d
triggerOperator: gt
Expand All @@ -34,5 +37,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: PingFederate
dataTypes:
- PingFederateEvent
- connectorId: PingFederateAma
dataTypes:
- PingFederateEvent
queryFrequency: 1h
queryPeriod: 14d
triggerOperator: gt
Expand Down Expand Up @@ -37,5 +40,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: PingFederate
dataTypes:
- PingFederateEvent
- connectorId: PingFederateAma
dataTypes:
- PingFederateEvent
queryFrequency: 1d
queryPeriod: 1d
triggerOperator: gt
Expand All @@ -34,5 +37,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: PingFederate
dataTypes:
- PingFederateEvent
- connectorId: PingFederateAma
dataTypes:
- PingFederateEvent
queryFrequency: 1h
queryPeriod: 14d
triggerOperator: gt
Expand Down Expand Up @@ -40,5 +43,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: PingFederate
dataTypes:
- PingFederateEvent
- connectorId: PingFederateAma
dataTypes:
- PingFederateEvent
queryFrequency: 1h
queryPeriod: 1d
triggerOperator: gt
Expand Down Expand Up @@ -36,5 +39,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: PingFederate
dataTypes:
- PingFederateEvent
- connectorId: PingFederateAma
dataTypes:
- PingFederateEvent
queryFrequency: 1h
queryPeriod: 14d
triggerOperator: gt
Expand Down Expand Up @@ -40,5 +43,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": "PingFederate",
"title": "PingFederate",
"title": "[Deprecated] PingFederate via Legacy Agent",
"publisher": "Ping Identity",
"descriptionMarkdown": "The [PingFederate](https://www.pingidentity.com/en/software/pingfederate.html) data connector provides the capability to ingest [PingFederate events](https://docs.pingidentity.com/bundle/pingfederate-102/page/lly1564002980532.html) into Microsoft Sentinel. Refer to [PingFederate documentation](https://docs.pingidentity.com/bundle/pingfederate-102/page/tle1564002955874.html) for more information.",
"additionalRequirementBanner": "This data connector depends on a parser based on Kusto Function to work as expected [**PingFederateEvent**](https://aka.ms/sentinel-PingFederate-parser) which is deployed with the Microsoft Sentinel Solution.",
Expand Down
117 changes: 117 additions & 0 deletions Solutions/PingFederate/Data Connectors/template_PingFederateAMA.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
{
"id": "PingFederateAma",
"title": "[Recommended] PingFederate via AMA",
"publisher": "Ping Identity",
"descriptionMarkdown": "The [PingFederate](https://www.pingidentity.com/en/software/pingfederate.html) data connector provides the capability to ingest [PingFederate events](https://docs.pingidentity.com/bundle/pingfederate-102/page/lly1564002980532.html) into Microsoft Sentinel. Refer to [PingFederate documentation](https://docs.pingidentity.com/bundle/pingfederate-102/page/tle1564002955874.html) for more information.",
"additionalRequirementBanner": "This data connector depends on a parser based on Kusto Function to work as expected [**PingFederateEvent**](https://aka.ms/sentinel-PingFederate-parser) which is deployed with the Microsoft Sentinel Solution.",
"graphQueries": [
{
"metricName": "Total data received",
"legend": "PingFederate",
"baseQuery": "CommonSecurityLog\n |where DeviceProduct has 'PingFederate'\n |extend sent_by_ama = column_ifexists('CollectorHostName','')\n |where isnotempty(sent_by_ama)"
}
],
"sampleQueries": [
{
"description" : "Top 10 Devices",
"query": "PingFederateEvent\n | summarize count() by DvcHostname\n | top 10 by count_"
}
],
"dataTypes": [
{
"name": "CommonSecurityLog (PingFederate)",
"lastDataReceivedQuery": "CommonSecurityLog\n |where DeviceProduct has 'PingFederate'\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 DeviceProduct has 'PingFederate'\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": ">**NOTE:** This data connector depends on a parser based on a Kusto Function to work as expected [**PingFederateEvent**](https://aka.ms/sentinel-PingFederate-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. Forward Common Event Format (CEF) logs to Syslog agent",
"description": "[Follow these steps](https://docs.pingidentity.com/bundle/pingfederate-102/page/gsn1564002980953.html) to configure PingFederate sending audit log via syslog in CEF format.",
"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)"
}
]
}
11 changes: 6 additions & 5 deletions Solutions/PingFederate/Data/Solution_PingFederate.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"Name": "PingFederate",
"Author": "Microsoft - support@microsoft.com",
"Logo": "<img src=\"https://raw.githubusercontent.com/Azure/Azure-Sentinel/master/Solutions/PingFederate/Data%20Connectors/Logo/PingIdentity.svg\" width=\"75px\" height=\"75px\">",
"Description": "The [PingFederate](https://www.pingidentity.com/en/pingone/pingfederate.html) solution provides the capability to ingest [PingFederate](https://docs.pingidentity.com/bundle/pingfederate-102/page/lly1564002980532.html) events into Microsoft Sentinel. Refer to [PingFederate documentation](https://docs.pingidentity.com/bundle/pingfederate-102/page/tle1564002955874.html) for more information.\n\n**Underlying Microsoft Technologies used:**\n\nThis 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\na. [Agent-based log collection (CEF over Syslog)](https://docs.microsoft.com/azure/sentinel/connect-common-event-format)",
"Description": "The [PingFederate](https://www.pingidentity.com/en/pingone/pingfederate.html) solution provides the capability to ingest [PingFederate](https://docs.pingidentity.com/bundle/pingfederate-102/page/lly1564002980532.html) events into Microsoft Sentinel. Refer to [PingFederate documentation](https://docs.pingidentity.com/bundle/pingfederate-102/page/tle1564002955874.html) for more information.\n\r\n1. **PingFederate via AMA** - This data connector helps in ingesting PingFederate 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. **PingFederate via Legacy Agent** - This data connector helps in ingesting PingFederate logs into your Log Analytics Workspace using the legacy Log Analytics agent.\n\n**NOTE:** Microsoft recommends installation of PingFederate 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/PingFederate.json"
],
Expand All @@ -19,8 +19,9 @@
"Hunting Queries/PingFederateUsersPaswordsReset.yaml"
],
"Data Connectors": [
"Data Connectors/Connector_CEF_PingFederate.json"
],
"Data Connectors/Connector_CEF_PingFederate.json",
"Data Connectors/template_PingFederateAMA.json"
],
"Analytic Rules": [
"Analytic Rules/PingFederateAbnormalPasswordResetsAttempts.yaml",
"Analytic Rules/PingFederateAuthFromNewSource.yaml",
Expand All @@ -35,10 +36,10 @@
"Analytic Rules/PingFederateUnusualMailDomain.yaml"
],
"Parsers": [
"Parsers/PingFederateEvent.txt"
"Parsers/PingFederateEvent.yaml"
],
"BasePath": "C:\\GitHub\\Azure-Sentinel\\Solutions\\PingFederate",
"Version": "2.0.0",
"Version": "3.0.0",
"Metadata": "SolutionMetadata.json",
"TemplateSpec": true,
"Is1Pconnector": false
Expand Down
Loading

0 comments on commit 9c25873

Please sign in to comment.