Skip to content

Commit cd1a640

Browse files
authored
Merge pull request #12310 from jpkeepersecurity/master
Add Keeper Security integration for Microsoft Sentinel
2 parents 1d2af15 + 5a4d781 commit cd1a640

File tree

12 files changed

+1283
-0
lines changed

12 files changed

+1283
-0
lines changed

Logos/keeper_security.svg

Lines changed: 14 additions & 0 deletions
Loading
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
{
2+
"name": "KeeperSecurityEventLogs_DCR",
3+
"apiVersion": "2023-02-01-preview",
4+
"type": "Microsoft.Insights/dataCollectionRules",
5+
"location": "{{location}}",
6+
"properties": {
7+
"dataCollectionEndpointId": "{{dataCollectionEndpointId}}",
8+
"streamDeclarations": {
9+
"Custom-KeeperSecurityEventNewLogs": {
10+
"columns": [
11+
{
12+
"name": "TimeGenerated",
13+
"type": "datetime"
14+
},
15+
{
16+
"name": "audit_event",
17+
"type": "string"
18+
},
19+
{
20+
"name": "remote_address",
21+
"type": "string"
22+
},
23+
{
24+
"name": "category",
25+
"type": "string"
26+
},
27+
{
28+
"name": "client_version",
29+
"type": "string"
30+
},
31+
{
32+
"name": "enterprise_id",
33+
"type": "int"
34+
},
35+
{
36+
"name": "username",
37+
"type": "string"
38+
},
39+
{
40+
"name": "timestamp",
41+
"type": "datetime"
42+
},
43+
{
44+
"name": "data",
45+
"type": "dynamic"
46+
}
47+
]
48+
}
49+
},
50+
"destinations": {
51+
"logAnalytics": [
52+
{
53+
"workspaceResourceId": "{{workspaceResourceId}}",
54+
"name": "clv2ws1"
55+
}
56+
]
57+
},
58+
"dataFlows": [
59+
{
60+
"streams": [
61+
"Custom-KeeperSecurityEventNewLogs"
62+
],
63+
"destinations": [
64+
"clv2ws1"
65+
],
66+
"transformKql": "source | extend TimeGenerated = now() | project-rename AuditEvent = audit_event, RemoteAddress = remote_address, Category = category, ClientVersion = client_version, EnterpriseId = enterprise_id, Username = username, Timestamp = timestamp, Data = data",
67+
"outputStream": "Custom-KeeperSecurityEventNewLogs_CL"
68+
}
69+
]
70+
}
71+
}
Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
{
2+
"name": "KeeperSecurityPush2",
3+
"apiVersion": "2022-09-01-preview",
4+
"type": "Microsoft.SecurityInsights/dataConnectorDefinitions",
5+
"location": "{{location}}",
6+
"kind": "Customizable",
7+
"properties": {
8+
"connectorUiConfig": {
9+
"id": "KeeperSecurityPush2",
10+
"title": "Keeper Security Push Connector",
11+
"publisher": "Keeper Security",
12+
"descriptionMarkdown": "The [Keeper Security](https://keepersecurity.com) connector provides the capability to read raw event data from Keeper Security in Microsoft Sentinel.",
13+
"graphQueries": [
14+
{
15+
"metricName": "Events Logs",
16+
"legend": "KeeperSecurityEventNewLogs_CL",
17+
"baseQuery": "KeeperSecurityEventNewLogs_CL"
18+
}
19+
],
20+
"sampleQueries": [
21+
{
22+
"description": "Keeper Security - All Events Logs",
23+
"query": "KeeperSecurityEventNewLogs_CL\n | sort by TimeGenerated desc"
24+
}
25+
],
26+
"dataTypes": [
27+
{
28+
"name": "KeeperSecurityEventNewLogs_CL",
29+
"lastDataReceivedQuery": "KeeperSecurityEventNewLogs_CL\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)"
30+
}
31+
],
32+
"connectivityCriteria": [
33+
{
34+
"type": "IsConnectedQuery",
35+
"value": [
36+
"KeeperSecurityEventNewLogs_CL\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(7d)"
37+
]
38+
}
39+
],
40+
"availability": {
41+
"status": 1
42+
},
43+
"permissions": {
44+
"resourceProvider": [
45+
{
46+
"provider": "Microsoft.OperationalInsights/workspaces",
47+
"permissionsDisplayText": "read and write permissions are required.",
48+
"providerDisplayName": "Workspace",
49+
"scope": "Workspace",
50+
"requiredPermissions": {
51+
"write": true,
52+
"read": true,
53+
"delete": true
54+
}
55+
}
56+
],
57+
"customs": [
58+
{
59+
"name": "Microsoft Entra",
60+
"description": "Permission to create an app registration in Microsoft Entra ID. Typically requires Entra ID Application Developer role or higher."
61+
},
62+
{
63+
"name": "Microsoft Azure",
64+
"description": "Permission to assign Monitoring Metrics Publisher role on data collection rule (DCR). Typically requires Azure RBAC Owner or User Access Administrator role"
65+
}
66+
]
67+
},
68+
"instructionSteps": [
69+
{
70+
"title": "1. Create ARM Resources and Provide the Required Permissions",
71+
"description": "This connector reads data from the tables that Keeper Security uses in a Microsoft Analytics Workspace, if the [data forwarding](https://docs.keepersecurity.com/docs/data-forwarding) option is enabled in Keeper Security then raw event data is sent to the Microsoft Sentinel Ingestion API.",
72+
"instructions": [
73+
{
74+
"type": "Markdown",
75+
"parameters": {
76+
"content": "#### Automated Configuration and Secure Data Ingestion with Entra Application \nClicking on \"Deploy\" will trigger the creation of Log Analytics tables and a Data Collection Rule (DCR). \nIt will then create an Entra application, link the DCR to it, and set the entered secret in the application. This setup enables data to be sent securely to the DCR using an Entra token."
77+
}
78+
},
79+
{
80+
"parameters": {
81+
"label": "Keeper Security connector resources",
82+
"applicationDisplayName": "Keeper Security Connector Application"
83+
},
84+
"type": "DeployPushConnectorButton"
85+
}
86+
]
87+
},
88+
{
89+
"title": "2. Push your logs into the workspace",
90+
"description": "Use the following parameters to configure the your machine to send the logs to the workspace.",
91+
"instructions": [
92+
{
93+
"parameters": {
94+
"label": "Tenant ID (Directory ID)",
95+
"fillWith": [
96+
"TenantId"
97+
]
98+
},
99+
"type": "CopyableLabel"
100+
},
101+
{
102+
"parameters": {
103+
"label": "Entra App Registration Application ID",
104+
"fillWith": [
105+
"ApplicationId"
106+
],
107+
"placeholder": "Deploy push connector to get the App Registration Application ID"
108+
},
109+
"type": "CopyableLabel"
110+
},
111+
{
112+
"parameters": {
113+
"label": "Entra App Registration Secret",
114+
"fillWith": [
115+
"ApplicationSecret"
116+
],
117+
"placeholder": "Deploy push connector to get the App Registration Secret"
118+
},
119+
"type": "CopyableLabel"
120+
},
121+
{
122+
"parameters": {
123+
"label": "Data Collection Endpoint Uri",
124+
"fillWith": [
125+
"DataCollectionEndpoint"
126+
],
127+
"placeholder": "Deploy push connector to get the Data Collection Endpoint Uri"
128+
},
129+
"type": "CopyableLabel"
130+
},
131+
{
132+
"parameters": {
133+
"label": "Data Collection Rule Immutable ID",
134+
"fillWith": [
135+
"DataCollectionRuleId"
136+
],
137+
"placeholder": "Deploy push connector to get the Data Collection Rule Immutable ID"
138+
},
139+
"type": "CopyableLabel"
140+
},
141+
{
142+
"parameters": {
143+
"label": "Events Logs Stream Name",
144+
"value": "Custom-KeeperSecurityEventNewLogs"
145+
},
146+
"type": "CopyableLabel"
147+
}
148+
]
149+
},
150+
{
151+
"title": "3. Update Keeper Admin Console",
152+
"description": "Configure the Keeper Admin Console with the Azure connection details to enable data forwarding to Microsoft Sentinel.",
153+
"instructions": [
154+
{
155+
"type": "Markdown",
156+
"parameters": {
157+
"content": "#### Configure Azure Monitor Logs in Keeper Admin Console\n\nIn the [Keeper Admin Console](https://keepersecurity.com/console/), login as the Keeper Administrator. Then go to **Reporting & Alerts** and select **Azure Monitor Logs**.\n\nProvide the following information from Step 2 above into the Admin Console:\n\n- **Azure Tenant ID**: You can find this from Azure's \"Subscriptions\" area.\n- **Application (client) ID**: This is located in the App registration (KeeperLogging) overview screen\n- **Client Secret Value**: This is the Client Secret Value from the app registration secrets.\n- **Endpoint URL**: This is a URL that is created in the following specific format:\n `https://<collection_url>/dataCollectionRules/<dcr_id>/streams/<table>?api-version=2023-01-01`\n\nTo assemble the Endpoint URL:\n\n- **<Collection URL>** This comes from Step 2 above\n- **<DCR_ID>** From the Data Collector Rule, copy the \"Immutable Id\" value, e.g. `dcr-xxxxxxx`\n- **<TABLE>** This is the table name created by Azure, e.g. `Custom-KeeperSecurityEventNewLogs`\n\nExample: `https://<Collection_URL>/dataCollectionRules/<DCR_ID>/streams/Custom-KeeperSecurityEventNewLogs?api-version=2023-01-01`"
158+
}
159+
}
160+
]
161+
}
162+
]
163+
}
164+
}
165+
}
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
{
3+
"id": "b608e714-b3ec-4380-b666-1aa781513ab4",
4+
"name": "KeeperSecurityPushConnectorPolling",
5+
"apiVersion": "2023-02-01-preview",
6+
"type": "Microsoft.SecurityInsights/dataConnectors",
7+
"kind": "Push",
8+
"properties": {
9+
"connectorDefinitionName": "KeeperSecurityPush2",
10+
"dcrConfig": {
11+
"streamName": "Custom-KeeperSecurityEventNewLogs",
12+
"dataCollectionEndpoint": "{{dataCollectionEndpoint}}",
13+
"dataCollectionRuleImmutableId": "{{dataCollectionRuleImmutableId}}"
14+
},
15+
"auth": {
16+
"type": "Push",
17+
"AppId": "{{appId}}",
18+
"ServicePrincipalId": "{{servicePrincipalId}}"
19+
},
20+
"request": {
21+
"RetryCount":1
22+
},
23+
"response": {
24+
"eventsJsonPaths": [
25+
"$.messages"
26+
]
27+
}
28+
}
29+
}
30+
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
{
2+
"name": "KeeperSecurityEventNewLogs_CL",
3+
"type": "Microsoft.OperationalInsights/workspaces/tables",
4+
"apiVersion": "2021-03-01-privatepreview",
5+
"tags": {},
6+
"properties": {
7+
"plan": "Analytics",
8+
"schema": {
9+
"name": "KeeperSecurityEventNewLogs_CL",
10+
"columns": [
11+
{
12+
"name": "TimeGenerated",
13+
"type": "datetime"
14+
},
15+
{
16+
"name": "AuditEvent",
17+
"type": "string"
18+
},
19+
{
20+
"name": "RemoteAddress",
21+
"type": "string"
22+
},
23+
{
24+
"name": "Category",
25+
"type": "string"
26+
},
27+
{
28+
"name": "ClientVersion",
29+
"type": "string"
30+
},
31+
{
32+
"name": "EnterpriseId",
33+
"type": "int"
34+
},
35+
{
36+
"name": "Username",
37+
"type": "string"
38+
},
39+
{
40+
"name": "Timestamp",
41+
"type": "datetime"
42+
},
43+
{
44+
"name": "Data",
45+
"type": "dynamic"
46+
}
47+
]
48+
}
49+
}
50+
}
51+
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"Name": "KeeperSecurity",
3+
"Author": "Joao Paulo Oliveira Santos - jsantos@keepersecurity.com",
4+
"Logo": "<img src=\"https://raw.githubusercontent.com/Azure/Azure-Sentinel/master/Logos/keeper_security.svg\" width=\"75px\" height=\"75px\">",
5+
"Description": "The [Keeper Security](https://keepersecurity.com/) solution for Microsoft Sentinel enables you to ingest [Keeper Security](https://keepersecurity.com/) forwarded into Microsoft Sentinel using the Microsoft Sentinel Analytics Workspace.",
6+
"Data Connectors": [
7+
"Data Connectors/KeeperSecurity_ccp/KepperSecurity_Definition.json"
8+
],
9+
"BasePath": "/Users/joaopaulooliveriasantos/Projects/Azure-Sentinel/Solutions/KeeperSecurity",
10+
"Version": "3.0.0",
11+
"Metadata": "SolutionMetadata.json",
12+
"TemplateSpec": true,
13+
"Is1PConnector": false
14+
}
6.98 KB
Binary file not shown.

0 commit comments

Comments
 (0)