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

Adds documentation for permission that provides access to system indexes #4849

Merged
merged 25 commits into from
Sep 11, 2023
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
c77bac7
fix#4736 system index permission
cwillum Aug 22, 2023
f37d69e
fix#4736 system index permission
cwillum Aug 22, 2023
abc33d3
fix#4736 system index permission
cwillum Aug 22, 2023
f2b57de
fix#4736 system index permission
cwillum Aug 22, 2023
13b0589
fix#4736 system index permission
cwillum Aug 24, 2023
f75599c
fix#4736 system index permission
cwillum Aug 24, 2023
887ff13
fix#4736 system index permission
cwillum Aug 24, 2023
8cad753
Merge branch 'main' into fix#4736-permissionable-sys-indexes
cwillum Aug 29, 2023
4b1494a
fix#4736 system index permission
cwillum Aug 29, 2023
548c739
fix#4736 system index permission
cwillum Aug 29, 2023
4953ef5
fix#4736 system index permission
cwillum Aug 30, 2023
7662f64
fix#4736 system index permission
cwillum Aug 30, 2023
ec6972d
Fixes some wordings around system index permission access and usage (…
DarshitChanpura Aug 31, 2023
72e2cc1
fix#4736 system index permission
cwillum Sep 5, 2023
063c27c
fix#4736 system index permission
cwillum Sep 5, 2023
c76426a
Changes the feature flag key and updates some text (#4953)
DarshitChanpura Sep 6, 2023
c959b64
fix#4736 system index permission
cwillum Sep 7, 2023
ba37dc1
fix#4736 system index permission
cwillum Sep 7, 2023
771a8b0
fix#4736 system index permission
cwillum Sep 8, 2023
3e96bd9
fix#4736 system index permission
cwillum Sep 8, 2023
bcaee4f
fix#4736 system index permission
cwillum Sep 11, 2023
798eecb
fix#4736 system index permission
cwillum Sep 11, 2023
35268a2
fix#4736 system index permission
cwillum Sep 11, 2023
e7e7208
fix#4736 system index permission
cwillum Sep 11, 2023
0caa394
fix#4736 system index permission
cwillum Sep 11, 2023
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
12 changes: 12 additions & 0 deletions _security/access-control/permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,18 @@ Rather than individual permissions, you can often achieve your desired security
{: .tip }


## System permission

The system permission `system:admin/<system_index_name>` is unique among other permissions in that it extends some traditional admin-only accessibility to non-admin users. This permission gives normal users the ability to modify the system index specified in the permission name. For example, the permission `system:admin/.opendistro-alerting-config` gives a user permission to modify the system index that stores configurations for the Alerting plugin.

cwillum marked this conversation as resolved.
Show resolved Hide resolved
The system permission excludes, however, access to the security system index `.opendistro_security`, which is used to store Security's configuration YAML files and remains accessible only to admins with an admin certificate.
Copy link
Member

@DarshitChanpura DarshitChanpura Aug 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thoughts on: "The system permission, however, excludes access to the .opendistro_security system index, which stores the Security plugin's configuration, and is only accessible to admins with an admin certificate."


Admin users that have the permission [`restapi:admin/roles`]({{site.url}}{{site.baseurl}}/security/access-control/api/#access-control-for-the-api) are able to map the `system:admin/<system_index_name>` permission to users in the same way they would for a cluster or index permission. However, to preserve some control over this permission, the configuration setting `plugins.security.system_indices.additional_control.enabled` allows administrators to disable this feature by setting it to `false`. For more information about this setting, see [Enabling user access to system indexes]({{site.url}}{{site.baseurl}}/security/configuration/yaml/#enabling-user-access-to-system-indexes).

Keep in mind that an admin user who enables this feature necessarily accepts the risks involved with giving normal users access to system indexes, which may contain sensitive information and configurations essential to a cluster's health. An admin user should also take precautions when assigning the `restapi:admin/roles` to users because this permission gives a user not only the ability to assign the permission to modify a specified system index to another user but, equally, the ability to self-assign access to any system index.
{: .warning }


## Cluster permissions

These permissions are for the cluster and can't be applied granularly. For example, you either have permissions to take snapshots (`cluster:admin/snapshot/create`) or you don't. The cluster permission, therefore, cannot grant a user privileges to take snapshots of a select set of indexes while preventing the user from taking snapshots of others.
Expand Down
14 changes: 14 additions & 0 deletions _security/configuration/yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,20 @@ An authentication cache for the Security plugin exists to help speed up authenti
plugins.security.cache.ttl_minutes: 60
```

### Enabling user access to system indexes

Mapping the `system:admin/<system_index_name>` permission to a user allows that user to modify the system index specified in the permission name. The one exception is the Security plugin's [system index]({{site.url}}{{site.baseurl}}/security/configuration/system-indices/). The `plugins.security.system_indices.additional_control.enabled` setting provides a way for administrators to make this permission available for or hidden from role mapping.

When set to `true`, the feature is enabled and administrators can add the `system:admin/<system_index_name>` permission for a user.

```yml
plugins.security.system_indices.additional_control.enabled: true
```
When set to `false`, the permission is disabled and only admins with an admin certificate can make changes to system indexes. By default, the setting is `true` for a new cluster.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


To learn more about the `system:admin/<system_index_name>` permission, see [System permission]({{site.url}}{{site.baseurl}}/security/access-control/permissions/#system-permission).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thoughts on: To learn more about the System Index Permissions, see ..



### Password settings

If you want to run your users' passwords against some validation, specify a regular expression (regex) in this file. You can also include an error message that loads when passwords don't pass validation. The following example demonstrates how to include a regex so OpenSearch requires new passwords to be a minimum of eight characters with at least one uppercase, one lowercase, one digit, and one special character.
Expand Down