Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding explanation for editing permissions 20230825 #6606

Merged
Changes from 2 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
b574c9e
adding explination for editing permissions
leanneeliatra Mar 6, 2024
3f32e80
changed to a h3 to see if review dog will accept
leanneeliatra Mar 6, 2024
289943a
Update _security/access-control/document-level-security.md
leanneeliatra Mar 7, 2024
7195c42
Update _security/access-control/document-level-security.md
leanneeliatra Mar 7, 2024
a918857
Update _security/access-control/document-level-security.md
leanneeliatra Mar 7, 2024
5c88efa
Update _security/access-control/document-level-security.md
leanneeliatra Mar 11, 2024
b05db06
Merge branch 'main' into 20230825-edit-document-level-permissions
leanneeliatra Mar 13, 2024
97ba3c9
Merge branch 'main' into 20230825-edit-document-level-permissions
leanneeliatra Mar 15, 2024
e839012
Merge branch 'main' into 20230825-edit-document-level-permissions
leanneeliatra Mar 19, 2024
9dde189
Updates to both the users roles and DLS sections to reflect need to a…
leanneeliatra Mar 19, 2024
7a29048
updating after reviewdog comments
leanneeliatra Mar 19, 2024
2864a8d
updating roles in OpenSearch updates
leanneeliatra Mar 19, 2024
7bfc487
Merge branch 'main' into 20230825-edit-document-level-permissions
leanneeliatra Mar 20, 2024
0340211
Merge branch 'main' into 20230825-edit-document-level-permissions
Naarcha-AWS Mar 21, 2024
a33218b
Apply suggestions from code review
leanneeliatra Mar 22, 2024
09a6e06
Merge branch 'main' into 20230825-edit-document-level-permissions
leanneeliatra Mar 22, 2024
c4cca6b
Merge branch 'main' into 20230825-edit-document-level-permissions
leanneeliatra Mar 26, 2024
c4f265e
Apply suggestions from code review
Naarcha-AWS Mar 26, 2024
cb681ae
Merge branch 'main' into 20230825-edit-document-level-permissions
leanneeliatra Mar 27, 2024
af79721
Apply suggestions from code review
Naarcha-AWS Mar 27, 2024
24afe20
Update document-level-security.md
Naarcha-AWS Mar 27, 2024
415786f
Update _security/access-control/document-level-security.md
leanneeliatra Mar 27, 2024
6afb195
Merge branch 'main' into 20230825-edit-document-level-permissions
leanneeliatra Mar 27, 2024
06065f6
Merge branch 'main' into 20230825-edit-document-level-permissions
Naarcha-AWS Mar 28, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions _security/access-control/document-level-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,3 +279,31 @@
When a user has both Role A and Role B permissions, the query results are filtered based on Role A's DLS, even though Role B doesn't use DLS. The DLS settings are retained, and the returned access is appropriately restricted.

When a user is assigned both Role A and Role B and the `plugins.security.dfm_empty_overrides_all` setting is enabled, Role B's permissions Role B's permissions will override Role A's restrictions, allowing that user to access all documents. This ensures that the role without DLS takes precedence in the search query response.

### Editing Document-Level Permissions

Check failure on line 283 in _security/access-control/document-level-security.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.HeadingCapitalization] 'Editing Document-Level Permissions' is a heading and should be in sentence case. Raw Output: {"message": "[OpenSearch.HeadingCapitalization] 'Editing Document-Level Permissions' is a heading and should be in sentence case.", "location": {"path": "_security/access-control/document-level-security.md", "range": {"start": {"line": 283, "column": 5}}}, "severity": "ERROR"}
leanneeliatra marked this conversation as resolved.
Show resolved Hide resolved
To adjust document-level permissions in OpenSearch, you can tailor existing roles or create new ones with customized configurations.
leanneeliatra marked this conversation as resolved.
Show resolved Hide resolved

To modifying an existing role, open OpenSearch Dashboards and choose Security and then choose Roles. Within the list of available roles locate the role to be changed, click on the role to inspect its current permissions and configurations.
leanneeliatra marked this conversation as resolved.
Show resolved Hide resolved

Within the role details, you can change index permissions in the specified index permissions section. Here, you can update index patterns, document-level security queries (DLS), and allowed actions associated with the role.
leanneeliatra marked this conversation as resolved.
Show resolved Hide resolved

Example of DLS Configuration in roles.yml:
leanneeliatra marked this conversation as resolved.
Show resolved Hide resolved
```
leanneeliatra marked this conversation as resolved.
Show resolved Hide resolved
{
"index_permissions": [
{
"index_patterns": [
"example-index"
],
"dls": "[.. some DLS here ..]",
"allowed_actions": [
"indices:data/read/search",
]
}
]
}
```

Edit and save the configuration files, to upload the changes into the security index execute `securityadmin.sh`
leanneeliatra marked this conversation as resolved.
Show resolved Hide resolved

Optionally you can create new roles if existing roles do not align with your requirements.
Loading