Skip to content

Commit c392f33

Browse files
dimav78dimav78
authored
Merge pull request #151 from dimav78/feature/10.8/azure-files-and-OMBA
Feature/10.8/azure files and omba
2 parents 1631d86 + 036be6b commit c392f33

File tree

952 files changed

+37324
-127
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

952 files changed

+37324
-127
lines changed

‎.claude/settings.local.json

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"permissions": {
3+
"allow": [
4+
"WebFetch(domain:community.netwrix.com)",
5+
"WebFetch(domain:community.netwrix.com)",
6+
"Bash(git checkout:*)",
7+
"Bash(cp:*)",
8+
"Bash(npm install)",
9+
"Bash(npm start)",
10+
"Bash(npm run start:*)",
11+
"Bash(npx docusaurus start:*)",
12+
"Bash(mkdir:*)",
13+
"Bash(rm:*)",
14+
"Bash(git add:*)",
15+
"Bash(git commit:*)",
16+
"Bash(find:*)",
17+
"Bash(ls:*)"
18+
],
19+
"deny": []
20+
}
21+
}

‎.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ packages
1818
.env.test.local
1919
.env.production.local
2020

21+
# Claude settings
22+
.claude/settings.local.json
23+
2124
npm-debug.log*
2225
yarn-debug.log*
2326
yarn-error.log*

‎docs/auditor/10.8/accessreviews/_category_.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"label": "Access Reviews",
3+
"position": 100,
4+
"collapsed": true,
5+
"collapsible": true,
6+
"link": {
7+
"type": "doc",
8+
"id": "accessreviews"
9+
}
10+
}

‎docs/auditor/10.8/accessreviews/accessreviews.md

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
---
2+
title: "Access Reviews"
3+
description: "Access Reviews"
4+
sidebar_position: 100
5+
---
6+
7+
# Access Reviews
8+
9+
Netwrix Auditor supports integration with Netwrix Auditor Access Reviews, which enables business
10+
owners to conduct resource and group reviews and recommend changes. The integration is available for
11+
the following data sources:
12+
13+
- Active Directory
14+
- Dell Data Storage (only Unity family)
15+
- NetApp
16+
- Nutanix Files
17+
- Qumulo
18+
- SharePoint Online
19+
- Synology
20+
- Windows File Servers
21+
22+
## Getting Started
23+
24+
This workflow assumes you already have Netwrix Auditor installed with configured monitoring plans
25+
for a supported data source.
26+
27+
**NOTE:** Access Reviews is a separately licensed product and is not included with Netwrix Auditor.
28+
Make sure that you have the Access Reviews license enabled in Auditor.
29+
30+
See the [Licenses](/docs/auditor/10.8/admin/settings/licenses.md) topic for additional information.
31+
32+
_Remember,_ there is one single Access Review license for all data sources that can send data to the
33+
application.
34+
35+
Follow the steps to use Netwrix Auditor Access Reviews in conjuction with Auditor.
36+
37+
**Step 1 –** Install Access Reviews on the same computer where Netwrix Auditor is installed. See the
38+
[Installation Overview](/docs/auditor/10.8/accessreviews/installation/overview.md) topic for prerequisites and
39+
additional information.
40+
41+
**Step 2 –** Configure Access Reviews. The Configuration interface is only available to users with
42+
the Administrator role. See the [Administrator Overview](/docs/auditor/10.8/accessreviews/admin/overview.md) topic
43+
for configuration settings and enabling user access.
44+
45+
**Step 3 –** Use the Access reviews configuration tool to setup the data flow from the Auditor
46+
database to the Access Reviews database. See the
47+
[Select Data Sources](/docs/auditor/10.8/accessreviews/installation/accessreviewsconfiguration.md) topic for additional information.
48+
49+
**NOTE:** Data upload speed depends on the amount of collected data and Auditor collectors
50+
configuration.
51+
52+
**Step 4 –** Configure resource ownership through the Access Reviews Console. The Resource Owners
53+
interface is available to users with either the Security Team or Administrator role. Managing
54+
ownership is core component for the Access Reviews workflow. See the
55+
[Resource Owners Overview](/docs/auditor/10.8/accessreviews/resourceowners/overview.md) topic for additional
56+
information.
57+
58+
**NOTE:** The [Owners & Access Reviews](/docs/auditor/10.8/accessreviews/owneroverview/owneroverview.md) topic and
59+
subtopics are written for the assigned owners. You can distribute the URL to this topic or download
60+
a PDF to be distributed to your assigned resource owners.
61+
62+
**Step 5 –** Configure and run reviews. The Entitlement Reviews interface is available to users with
63+
either the Security Team or Administrator role. See the
64+
[Reviews Overview](/docs/auditor/10.8/accessreviews/entitlementreviews/overview.md) topic for additional
65+
information.
66+
67+
Netwrix Auditor Access Reviews is now configured and ready to use.
68+
69+
## Considerations & Limitations
70+
71+
Review the following considerations:
72+
73+
1. Enabling State-in-Time data collection for your monitoring plans option is not required for the
74+
integration works properly.
75+
2. The data collected by Auditor is updated at least once a day.
76+
3. If a monitoring plan or a data source with enabled integration is deleted, all collected data
77+
will be removed from the Access Reviews database.
78+
4. If there are errors in upload of data to the Access Reviews database, these errors are reflected
79+
in the Netwrix Auditor Health Log and text log files; status of items and data sources in Auditor
80+
is not affected by these errors.
81+
5. Permissions-related considerations:
82+
83+
- For Windows File Servers, permission data for all items in this data source is sent to the
84+
Access Reviews application;
85+
- Only effective top-level permissions are sent (share+NTFS);
86+
- Permission data is sent per file server (entirely for each server);
87+
- Transfer of permission data to the Access Reviews application is started when you enable the
88+
integration for a data source.
89+
90+
## Initial Configuration
91+
92+
Next, configure the Access Reviews for your environment:
93+
94+
- Console Users — Grant users access to the application starting with an Administrator account.
95+
There are two levels of access: Administrator and Security Team. See the
96+
[Console Access Page](/docs/auditor/10.8/accessreviews/admin/configuration/consoleaccess.md) topic for
97+
information.
98+
99+
- Optionally, disable the Builtin Administrator account. See the
100+
[Modify the Builtin Administrator Account](/docs/auditor/10.8/accessreviews/admin/configuration/consoleaccess.md#modify-the-builtin-administrator-account)
101+
topic for additional information.
102+
103+
- Notification — Configure the Notification settings required in order for the application to
104+
send email. See the
105+
[Notifications Page](/docs/auditor/10.8/accessreviews/admin/configuration/notifications.md) topic for
106+
information.
107+
108+
## Enable Console Users
109+
110+
Access Reviews Console users granted one of the available roles should be notified.
111+
112+
**_RECOMMENDED:_** The notification should include:
113+
114+
- Why your organization is using Netwrix Auditor Access Reviews.
115+
- What they will be doing in the Access Reviews Console.
116+
- How to log into the Access Reviews Console, specifically what URL and credentials to use.
117+
118+
You should also provide links to the appropriate topics based on the user's role:
119+
120+
- Security Team — Need topics that align to the work the will be doing in the Access Reviews
121+
Console:
122+
123+
- Ownership Administrator — Send the URL link for the
124+
[Resource Owners Overview](/docs/auditor/10.8/accessreviews/resourceowners/overview.md) topic.
125+
- Review Administrator — Send the URL link for the
126+
[Reviews Overview](/docs/auditor/10.8/accessreviews/entitlementreviews/overview.md) topic.
127+
128+
- Administrator — Send the URL link for the
129+
[Administrator Overview](/docs/auditor/10.8/accessreviews/admin/overview.md) topic.
130+
131+
## Resource Ownership Configuration
132+
133+
Ownership of resources must be assigned in order to use the Access Reviews workflow:
134+
135+
- Resource Ownership — Assign ownership for resources to be managed through the application. See
136+
the [Resource Owners Interface](/docs/auditor/10.8/accessreviews/resourceowners/interface/interface.md) topic for
137+
additional information.
138+
- Enable Owners — Send a notification to your owners about resource ownership with the
139+
application. See the
140+
[Notification to Owners](/docs/auditor/10.8/accessreviews/resourceowners/overview.md#notification-to-owners)
141+
topic for additional information.
142+
143+
## Access Reviews Workflow
144+
145+
The Access Reviews applicaton runs attestations on resources and groups with the assigned
146+
owners. The workflow consists of:
147+
148+
- Reviews — Configure reviews for resource Access or group Membership .
149+
- Owner Performs Review — Owners process the review, potentially recommending changes
150+
- Review Administrator Approval — Review and process owner recommended changes
151+
152+
**_RECOMMENDED:_** Set expectations for response time from owners.
153+
154+
Reviews can be run multiple times, maintaining a historical record for each instance. See the
155+
[Reviews Overview](/docs/auditor/10.8/accessreviews/entitlementreviews/overview.md) topic for additional
156+
information.

‎docs/auditor/10.8/accessreviews/admin/_category_.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"label": "Administrator Overview",
3+
"position": 20,
4+
"collapsed": true,
5+
"collapsible": true,
6+
"link": {
7+
"type": "doc",
8+
"id": "overview"
9+
}
10+
}

‎docs/auditor/10.8/accessreviews/admin/additionalconfig/_category_.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"label": "Additional Configuration Options",
3+
"position": 40,
4+
"collapsed": true,
5+
"collapsible": true,
6+
"link": {
7+
"type": "doc",
8+
"id": "overview"
9+
}
10+
}

‎docs/auditor/10.8/accessreviews/admin/additionalconfig/emailtemplates.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
title: "Email Templates"
3+
description: "Email Templates"
4+
sidebar_position: 10
5+
---
6+
7+
# Email Templates
8+
9+
The HTML templates used to format notification email can be customized. These templates are designed
10+
to make the message viewable within an email client. It is recommended to edit text and layout as
11+
desired, but NOT to embed new images or logos. The following table shows the notification email
12+
templates and describes the purpose of each.
13+
14+
| Template Name | Message Type Description |
15+
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
16+
| EntitlementReviewReminder | Reminds owners of pending reviews; manually sent by a Review Administrator from the Entitlement Reviews interface |
17+
| OwnershipChangeNotification | Sent to owners when assigned ownership is changed for a resource which already has pending reviews |
18+
| OwnershipConfirm | Sent to owners to confirm or decline ownership of a given resource; manually sent by an Ownership Administrator from the Resource Owners interface |
19+
| ReminderDigest | Weekly reminder configured by Administrators on the Notifications page of the Configuration interface to owners with pending reviews |
20+
21+
While customizing the template content, take note of the inline Substitution Tokens. These exist to
22+
provide the message with dynamic content, i.e. inserting values and strings from data in line with
23+
the static portion of the message body. These Substitution Tokens begin and end with the “@” symbol,
24+
e.g. @UserName@.
25+
26+
Substitution Tokens are only valid for certain Notification message templates. Below is a table of
27+
the Substitution Tokens, the value or string they represent, and the message templates in which they
28+
may be used.
29+
30+
| Substitution Token | Description | Applicable Template(s) |
31+
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
32+
| @LoginUrl@ | URL that allows a user to access the default (login) page | OwnershipChangeNotification ReminderDigest |
33+
| @ResourceDescription@ | Description of resource - To use the resource's description in emails instead of the path, replace @ResourcePath@ with @ResourceDescription@ | OwnershipConfirm ReminderDigest |
34+
| @ResourcePath@ | Path of the current resource - To use the resources’ description in emails instead of the path, replace @ResourcePath@ with @ResourceDescription@ | OwnershipConfirm ReminderDigest |
35+
| @ResourceType@ | Type of resource | OwnershipConfirm ReminderDigest |
36+
| @ResourceUrl@ | URL specifically created to respond to a request | EntitlementReviewReminder OwnershipConfirm |
37+
| @ResponseCount@ | Numerically formatted count of pending reviews | ReminderDigest |
38+
| @ReviewCount@ | Numerically formatted count of pending reviews | ReminderDigest |
39+
40+
## Customize Email Templates
41+
42+
Email templates are shipped in a ZIP file and stored in the Access Reviews installation directory:
43+
44+
...\Netwrix\Access Reviews
45+
46+
Follow the steps to customize the email templates.
47+
48+
**NOTE:** To successfully modify these Notifications email templates, a familiarity with basic HTML
49+
is necessary.
50+
51+
![Access Reviews installation directory showing the Templates zip file](/images/auditor/10.7/access/reviews/admin/additionalconfig/emailtemplates.webp)
52+
53+
**Step 1 –** Navigate to the Access Reviews installation directory.
54+
55+
**Step 2 –** Unzip the `Templates.zip` file and save the contents to a folder within this directory
56+
named `Templates`.
57+
58+
**CAUTION:** The customized email templates must be in the `Templates` folder within the
59+
installation directory to be preserved during future application upgrades.
60+
61+
![Templates folder showing email templates](/images/auditor/10.7/access/reviews/admin/additionalconfig/emailtemplatesfolder.webp)
62+
63+
**Step 3 –** Locate the desired HTML message template.
64+
65+
**Step 4 –** Open the file with a text editor, e.g. Notepad, and customize the email body.
66+
67+
**NOTE:** Using a tool other than a text editor to edit HTML files, such as a WYSIWYG web page
68+
editor which may drastically alter the underlying HTML code, is not supported.
69+
70+
**Step 5 –** Email subject lines can be edited by changing the text between the opening `<title>`
71+
tag and the closing `</title>` tag.
72+
73+
**Step 6 –** After making changes, save the file and view it within a web browser to see what the
74+
changes will look like. The Substitution Tokens will display without supplied values.
75+
76+
**Step 7 –** After making the desired changes, save and close the text editor. Then re-launch the
77+
application.
78+
79+
The modifications to the HTML email templates are in use by the notification emails.

‎docs/auditor/10.8/accessreviews/admin/additionalconfig/overview.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: "Additional Configuration Options"
3+
description: "Additional Configuration Options"
4+
sidebar_position: 40
5+
---
6+
7+
# Additional Configuration Options
8+
9+
In addition to the settings that are available on the Configuration interface, the following
10+
configurations and customizations can be done by Administrators:
11+
12+
- [Email Templates](/docs/auditor/10.8/accessreviews/admin/additionalconfig/emailtemplates.md)
13+
- [Timeout Parameter](/docs/auditor/10.8/accessreviews/admin/additionalconfig/timeoutparameter.md)

‎docs/auditor/10.8/accessreviews/admin/additionalconfig/timeoutparameter.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: "Timeout Parameter"
3+
description: "Timeout Parameter"
4+
sidebar_position: 20
5+
---
6+
7+
# Timeout Parameter
8+
9+
A user session will end when the timeout parameter for inactivity has been reached, and the user
10+
will be logged out. By default this is set to 15 minutes.
11+
12+
The timeout parameter is configured within the `AccessInformationCenter.Service.exe.Config` file in
13+
the Access Reviews installation directory:
14+
15+
...\Netwrix\Access Reviews
16+
17+
Follow the steps to modify the timeout parameter.
18+
19+
**Step 1 –** Open the `AccessInformationCenter.Service.exe.Config` file with a text editor, e.g.
20+
Notepad.
21+
22+
![Notepad showing the AccessInformationCenter.Service.exe.Config file](/images/auditor/10.7/access/reviews/admin/additionalconfig/timeout.webp)
23+
24+
**Step 2 –** Change the value for the `AuthSessionTimeout` parameter to the desired number of
25+
minutes. For example:
26+
27+
<add key="AuthSessionTimeout" value="20"/>
28+
29+
**Step 3 –** Save and close the file.
30+
31+
A user session times out after the number of minutes specified for inactivity, for example after 20
32+
minutes.

‎docs/auditor/10.8/accessreviews/admin/configuration/_category_.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"label": "Configuration Interface Overview",
3+
"position": 30,
4+
"collapsed": true,
5+
"collapsible": true,
6+
"link": {
7+
"type": "doc",
8+
"id": "overview"
9+
}
10+
}

0 commit comments

Comments
 (0)