Repackaging - CiscoSEG (MMA to AMA Migration)

.script/tests/detectionTemplateSchemaValidation/ValidConnectorIds.json

@@ -207,5 +207,6 @@
   "ClarotyAma",
   "illusiveAttackManagementSystemAma",
   "TrendMicroApexOneAma",
-  "PaloAltoCDLAma"
+  "PaloAltoCDLAma",
+  "CiscoSEGAma"
 ]

Solutions/CiscoSEG/Analytic Rules/CiscoSEGDLPViolation.yaml

@@ -8,6 +8,9 @@ requiredDataConnectors:
   - connectorId: CiscoSEG
     dataTypes:
       - CiscoSEGEvent
+  - connectorId: CiscoSEGAma
+    dataTypes:
+      - CiscoSEGEvent
 queryFrequency: 1h
 queryPeriod: 1h
 triggerOperator: gt
@@ -28,5 +31,5 @@ entityMappings:
     fieldMappings:
       - identifier: Name
         columnName: AccountCustomEntity
-version: 1.0.0
+version: 1.0.1
 kind: Scheduled

Solutions/CiscoSEG/Analytic Rules/CiscoSEGMaliciousAttachmentNotBlocked.yaml

@@ -8,6 +8,9 @@ requiredDataConnectors:
   - connectorId: CiscoSEG
     dataTypes:
       - CiscoSEGEvent
+  - connectorId: CiscoSEGAma
+    dataTypes:
+      - CiscoSEGEvent
 queryFrequency: 10m
 queryPeriod: 10m
 triggerOperator: gt
@@ -29,5 +32,5 @@ entityMappings:
     fieldMappings:
       - identifier: Name
         columnName: AccountCustomEntity
-version: 1.0.0
+version: 1.0.1
 kind: Scheduled

Solutions/CiscoSEG/Analytic Rules/CiscoSEGMultipleLargeEmails.yaml

@@ -8,6 +8,9 @@ requiredDataConnectors:
   - connectorId: CiscoSEG
     dataTypes:
       - CiscoSEGEvent
+  - connectorId: CiscoSEGAma
+    dataTypes:
+      - CiscoSEGEvent
 queryFrequency: 1h
 queryPeriod: 1h
 triggerOperator: gt
@@ -33,5 +36,5 @@ entityMappings:
     fieldMappings:
       - identifier: Name
         columnName: AccountCustomEntity
-version: 1.0.0
+version: 1.0.1
 kind: Scheduled

Solutions/CiscoSEG/Analytic Rules/CiscoSEGMultipleSuspiciousEmails.yaml

@@ -8,6 +8,9 @@ requiredDataConnectors:
   - connectorId: CiscoSEG
     dataTypes:
       - CiscoSEGEvent
+  - connectorId: CiscoSEGAma
+    dataTypes:
+      - CiscoSEGEvent
 queryFrequency: 1h
 queryPeriod: 1h
 triggerOperator: gt
@@ -30,5 +33,5 @@ entityMappings:
     fieldMappings:
       - identifier: Name
         columnName: AccountCustomEntity
-version: 1.0.0
+version: 1.0.1
 kind: Scheduled

Solutions/CiscoSEG/Analytic Rules/CiscoSEGPossibleOutbreak.yaml

@@ -8,6 +8,9 @@ requiredDataConnectors:
   - connectorId: CiscoSEG
     dataTypes:
       - CiscoSEGEvent
+  - connectorId: CiscoSEGAma
+    dataTypes:
+      - CiscoSEGEvent
 queryFrequency: 1h
 queryPeriod: 1h
 triggerOperator: gt
@@ -28,5 +31,5 @@ entityMappings:
     fieldMappings:
       - identifier: Name
         columnName: AccountCustomEntity
-version: 1.0.0
+version: 1.0.1
 kind: Scheduled

Solutions/CiscoSEG/Analytic Rules/CiscoSEGPotentialLinkToMalwareDownload.yaml

@@ -8,6 +8,9 @@ requiredDataConnectors:
   - connectorId: CiscoSEG
     dataTypes:
       - CiscoSEGEvent
+  - connectorId: CiscoSEGAma
+    dataTypes:
+      - CiscoSEGEvent
 queryFrequency: 1h
 queryPeriod: 1h
 triggerOperator: gt
@@ -29,5 +32,5 @@ entityMappings:
     fieldMappings:
       - identifier: Name
         columnName: AccountCustomEntity
-version: 1.0.0
+version: 1.0.1
 kind: Scheduled

Solutions/CiscoSEG/Analytic Rules/CiscoSEGSuspiciousLink.yaml

@@ -8,6 +8,9 @@ requiredDataConnectors:
   - connectorId: CiscoSEG
     dataTypes:
       - CiscoSEGEvent
+  - connectorId: CiscoSEGAma
+    dataTypes:
+      - CiscoSEGEvent
 queryFrequency: 15m
 queryPeriod: 15m
 triggerOperator: gt
@@ -29,5 +32,5 @@ entityMappings:
     fieldMappings:
       - identifier: Name
         columnName: AccountCustomEntity
-version: 1.0.0
+version: 1.0.1
 kind: Scheduled

Solutions/CiscoSEG/Analytic Rules/CiscoSEGSuspiciousSenderDomain.yaml

@@ -8,6 +8,9 @@ requiredDataConnectors:
   - connectorId: CiscoSEG
     dataTypes:
       - CiscoSEGEvent
+  - connectorId: CiscoSEGAma
+    dataTypes:
+      - CiscoSEGEvent
 queryFrequency: 1h
 queryPeriod: 1h
 triggerOperator: gt
@@ -35,5 +38,5 @@ entityMappings:
     fieldMappings:
       - identifier: Name
         columnName: AccountCustomEntity
-version: 1.0.0
+version: 1.0.1
 kind: Scheduled

Solutions/CiscoSEG/Analytic Rules/CiscoSEGUnclassifiedLink.yaml

@@ -8,6 +8,9 @@ requiredDataConnectors:
   - connectorId: CiscoSEG
     dataTypes:
       - CiscoSEGEvent
+  - connectorId: CiscoSEGAma
+    dataTypes:
+      - CiscoSEGEvent
 queryFrequency: 1h
 queryPeriod: 1h
 triggerOperator: gt
@@ -29,5 +32,5 @@ entityMappings:
     fieldMappings:
       - identifier: Name
         columnName: AccountCustomEntity
-version: 1.0.0
+version: 1.0.1
 kind: Scheduled

Solutions/CiscoSEG/Analytic Rules/CiscoSEGUnexpextedAttachment.yaml

@@ -8,6 +8,9 @@ requiredDataConnectors:
   - connectorId: CiscoSEG
     dataTypes:
       - CiscoSEGEvent
+  - connectorId: CiscoSEGAma
+    dataTypes:
+      - CiscoSEGEvent
 queryFrequency: 1h
 queryPeriod: 1h
 triggerOperator: gt
@@ -28,5 +31,5 @@ entityMappings:
     fieldMappings:
       - identifier: Name
         columnName: AccountCustomEntity
-version: 1.0.0
+version: 1.0.1
 kind: Scheduled

Solutions/CiscoSEG/Analytic Rules/CiscoSEGUnscannableAttachment.yaml

@@ -8,6 +8,9 @@ requiredDataConnectors:
   - connectorId: CiscoSEG
     dataTypes:
       - CiscoSEGEvent
+  - connectorId: CiscoSEGAma
+    dataTypes:
+      - CiscoSEGEvent
 queryFrequency: 1h
 queryPeriod: 1h
 triggerOperator: gt
@@ -28,5 +31,5 @@ entityMappings:
     fieldMappings:
       - identifier: Name
         columnName: AccountCustomEntity
-version: 1.0.0
+version: 1.0.1
 kind: Scheduled

Solutions/CiscoSEG/Data Connectors/Connector_Cisco_SEG_CEF.json

@@ -1,6 +1,6 @@
 {
     "id": "CiscoSEG",
-    "title": "Cisco Secure Email Gateway",
+    "title": "[Deprecated] Cisco Secure Email Gateway via Legacy Agent",
     "publisher": "Cisco",
     "descriptionMarkdown": "The [Cisco Secure Email Gateway (SEG)](https://www.cisco.com/c/en/us/products/security/email-security/index.html) data connector provides the capability to ingest [Cisco SEG Consolidated Event Logs](https://www.cisco.com/c/en/us/td/docs/security/esa/esa14-0/user_guide/b_ESA_Admin_Guide_14-0/b_ESA_Admin_Guide_12_1_chapter_0100111.html#con_1061902) into Microsoft Sentinel.",
     "additionalRequirementBanner": "This data connector depends on a parser based on a Kusto Function to work as expected [**CiscoSEGEvent**](https://aka.ms/sentinel-CiscoSEG-parser) which is deployed with the Microsoft Sentinel Solution.",

Solutions/CiscoSEG/Data Connectors/template_CiscoSEGAMA.json

@@ -0,0 +1,116 @@
+{
+    "id": "CiscoSEGAma",
+    "title": "[Recommended] Cisco Secure Email Gateway via AMA",
+    "publisher": "Cisco",
+    "descriptionMarkdown": "The [Cisco Secure Email Gateway (SEG)](https://www.cisco.com/c/en/us/products/security/email-security/index.html) data connector provides the capability to ingest [Cisco SEG Consolidated Event Logs](https://www.cisco.com/c/en/us/td/docs/security/esa/esa14-0/user_guide/b_ESA_Admin_Guide_14-0/b_ESA_Admin_Guide_12_1_chapter_0100111.html#con_1061902) into Microsoft Sentinel.",
+    "additionalRequirementBanner": "This data connector depends on a parser based on a Kusto Function to work as expected [**CiscoSEGEvent**](https://aka.ms/sentinel-CiscoSEG-parser) which is deployed with the Microsoft Sentinel Solution.",
+    "graphQueries": [
+        {
+            "metricName": "Total data received",
+            "legend": "CiscoSEG",
+            "baseQuery": "CommonSecurityLog\n |where DeviceVendor =~ 'Cisco'\n |where DeviceProduct =~ 'ESA_CONSOLIDATED_LOG_EVENT'\n |extend sent_by_ama = column_ifexists('CollectorHostName','')\n |where isnotempty(sent_by_ama)"
+        }
+    ],
+    "sampleQueries": [
+        {
+            "description" : "Top 10 Senders",
+            "query": "CiscoSEGEvent\n | where isnotempty(SrcUserName)\n    | summarize count() by SrcUserName\n | top 10 by count_"
+        }
+    ],
+    "dataTypes": [
+        {
+            "name": "CommonSecurityLog (CiscoSEG)",
+            "lastDataReceivedQuery": "CommonSecurityLog\n |where DeviceVendor =~ 'Cisco'\n |where DeviceProduct =~ 'ESA_CONSOLIDATED_LOG_EVENT'\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 =~ 'Cisco'\n |where DeviceProduct =~ 'ESA_CONSOLIDATED_LOG_EVENT'\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 [**CiscoSEGEvent**](https://aka.ms/sentinel-CiscoSEG-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 to configure Cisco Secure Email Gateway to forward logs via syslog:\n\n Configure [Log Subscription](https://www.cisco.com/c/en/us/td/docs/security/esa/esa14-0/user_guide/b_ESA_Admin_Guide_14-0/b_ESA_Admin_Guide_12_1_chapter_0100111.html#con_1134718)\n\n>**NOTE:** Select **Consolidated Event Logs** in Log Type field.",
+                                "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": "2Make sure to configure the machine's security according to your organization's security policy\n\n\n[Learn more >](https://aka.ms/SecureCEF)"
+        }
+    ]
+}

Solutions/CiscoSEG/Data/Solution_CiscoSEG.json

@@ -2,7 +2,7 @@
     "Name": "CiscoSEG",
     "Author": "Microsoft - support@microsoft.com",
     "Logo": "<img src=\"https://raw.githubusercontent.com/Azure/Azure-Sentinel/master/Logos/cisco-logo-72px.svg\" width=\"75px\" height=\"75px\">",
-    "Description": "The [Cisco Secure Email Gateway (SEG)](https://www.cisco.com/c/en/us/products/security/email-security/index.html) solution provides the capability to ingest [Cisco SEG Consolidated Event Logs](https://www.cisco.com/c/en/us/td/docs/security/esa/esa14-0/user_guide/b_ESA_Admin_Guide_14-0/b_ESA_Admin_Guide_12_1_chapter_0100111.html#con_1061902) into Microsoft Sentinel.  \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\n a. [Agent-based log collection (CEF over Syslog)](https://docs.microsoft.com/azure/sentinel/connect-common-event-format)",
+    "Description": "The [Cisco Secure Email Gateway (SEG)](https://www.cisco.com/c/en/us/products/security/email-security/index.html) solution provides the capability to ingest [Cisco SEG Consolidated Event Logs](https://www.cisco.com/c/en/us/td/docs/security/esa/esa14-0/user_guide/b_ESA_Admin_Guide_14-0/b_ESA_Admin_Guide_12_1_chapter_0100111.html#con_1061902) into Microsoft Sentinel.\n\r\n1. **CiscoSEG via AMA** - This data connector helps in ingesting CiscoSEG 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. **CiscoSEG via Legacy Agent** - This data connector helps in ingesting CiscoSEG logs into your Log Analytics Workspace using the legacy Log Analytics agent.\n\n**NOTE:** Microsoft recommends installation of CiscoSEG 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).",
 	"Analytic Rules" : [
 		"Analytic Rules/CiscoSEGDLPViolation.yaml",
 		"Analytic Rules/CiscoSEGMaliciousAttachmentNotBlocked.yaml",
@@ -29,17 +29,18 @@
 		"Hunting Queries/CiscoSEGUsersReceivedSpam.yaml"
 	],
     "Parsers": [
-		"Parsers/CiscoSEGEvent.txt"
+		"Parsers/CiscoSEGEvent.yaml"
     ],
     "Data Connectors": [
-		"Data Connectors/Connector_Cisco_SEG_CEF.json"
+		"Data Connectors/Connector_Cisco_SEG_CEF.json",
+		"Data Connectors/template_CiscoSEGAMA.json"
     ],
 	"Workbooks" : [
 		"Workbooks/CiscoSEG.json"
 	],
 	"Metadata": "SolutionMetadata.json",
     "BasePath": "C:\\GitHub\\azure-sentinel\\Solutions\\CiscoSEG",
-    "Version": "2.0.1",
+    "Version": "3.0.0",
 	"TemplateSpec": true,
     "Is1PConnector": false
 }

Solutions/CiscoSEG/Data/system_generated_metadata.json

@@ -0,0 +1,33 @@
+{
+  "Name": "CiscoSEG",
+  "Author": "Microsoft - support@microsoft.com",
+  "Logo": "<img src=\"https://raw.githubusercontent.com/Azure/Azure-Sentinel/master/Logos/cisco-logo-72px.svg\" width=\"75px\" height=\"75px\">",
+  "Description": "The [Cisco Secure Email Gateway (SEG)](https://www.cisco.com/c/en/us/products/security/email-security/index.html) solution provides the capability to ingest [Cisco SEG Consolidated Event Logs](https://www.cisco.com/c/en/us/td/docs/security/esa/esa14-0/user_guide/b_ESA_Admin_Guide_14-0/b_ESA_Admin_Guide_12_1_chapter_0100111.html#con_1061902) into Microsoft Sentinel.\n\r\n1. **CiscoSEG via AMA** - This data connector helps in ingesting CiscoSEG 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. **CiscoSEG via Legacy Agent** - This data connector helps in ingesting CiscoSEG logs into your Log Analytics Workspace using the legacy Log Analytics agent.\n\n**NOTE:** Microsoft recommends installation of CiscoSEG 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\\CiscoSEG",
+  "Version": "3.0.0",
+  "TemplateSpec": true,
+  "Is1PConnector": false,
+  "publisherId": "azuresentinel",
+  "offerId": "azure-sentinel-solution-ciscoseg",
+  "providers": [
+    "Cisco"
+  ],
+  "categories": {
+    "domains": [
+      "Security - Threat Protection"
+    ]
+  },
+  "firstPublishDate": "2021-06-23",
+  "support": {
+    "name": "Microsoft Corporation",
+    "email": "support@microsoft.com",
+    "tier": "Microsoft",
+    "link": "https://support.microsoft.com"
+  },
+  "Data Connectors": "[\n  \"Data Connectors/Connector_Cisco_SEG_CEF.json\",\n  \"Data Connectors/template_CiscoSEGAMA.json\"\n]",
+  "Parsers": "[\n  \"CiscoSEGEvent.yaml\"\n]",
+  "Workbooks": "[\n  \"Workbooks/CiscoSEG.json\"\n]",
+  "Analytic Rules": "[\n  \"CiscoSEGDLPViolation.yaml\",\n  \"CiscoSEGMaliciousAttachmentNotBlocked.yaml\",\n  \"CiscoSEGMultipleLargeEmails.yaml\",\n  \"CiscoSEGMultipleSuspiciousEmails.yaml\",\n  \"CiscoSEGPossibleOutbreak.yaml\",\n  \"CiscoSEGPotentialLinkToMalwareDownload.yaml\",\n  \"CiscoSEGSuspiciousLink.yaml\",\n  \"CiscoSEGSuspiciousSenderDomain.yaml\",\n  \"CiscoSEGUnclassifiedLink.yaml\",\n  \"CiscoSEGUnexpextedAttachment.yaml\",\n  \"CiscoSEGUnscannableAttachment.yaml\"\n]",
+  "Hunting Queries": "[\n  \"CiscoSEGDroppedInMails.yaml\",\n  \"CiscoSEGDroppedOutMails.yaml\",\n  \"CiscoSEGFailedDKIMFailure.yaml\",\n  \"CiscoSEGFailedDMARKFailure.yaml\",\n  \"CiscoSEGFailedSPFFailure.yaml\",\n  \"CiscoSEGFailedTLSIn.yaml\",\n  \"CiscoSEGFailedTLSOut.yaml\",\n  \"CiscoSEGInsecureProtocol.yaml\",\n  \"CiscoSEGSpamMails.yaml\",\n  \"CiscoSEGUsersReceivedSpam.yaml\"\n]"
+}