Skip to content

Convert IndexPrivilege and ClusterPrivilege to non-exhaustive enums #2084

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

Merged
merged 1 commit into from
Apr 26, 2023

Conversation

sethmlarson
Copy link
Contributor

@sethmlarson sethmlarson commented Apr 19, 2023

Our current set of index privileges is an enum, but misses out on many of the fine-grained privileges like indices:admin/aliases. We have application privileges as a string, so this PR converts the enum into a non-exhaustive enum in order to accept arbitrary values like a string.

@sethmlarson sethmlarson force-pushed the index-privilege-non-exhaustive branch from daffed1 to 65e3539 Compare April 19, 2023 21:37
@github-actions
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
security.activate_user_profile 🟢 8/8 8/8
security.authenticate 🟢 19/19 19/19
security.bulk_update_api_keys 🟠 Missing type Missing type
security.change_password 🟢 9/9 9/9
security.clear_api_key_cache 🟢 12/12 12/12
security.clear_cached_privileges 🟢 3/3 3/3
security.clear_cached_realms 🟢 1/1 1/1
security.clear_cached_roles 🟢 2/2 2/2
security.clear_cached_service_tokens 🟢 4/4 4/4
security.create_api_key 🟢 44/44 35/35
security.create_service_token 🟢 3/3 3/3
security.delete_privileges 🟢 6/6 6/6
security.delete_role_mapping 🟢 9/9 9/9
security.delete_role 🟢 8/8 8/8
security.delete_service_token Missing test Missing test
security.delete_user 🟢 9/9 9/9
security.disable_user_profile 🟢 1/1 1/1
security.disable_user 🟢 3/3 3/3
security.enable_user_profile 🟢 1/1 1/1
security.enable_user 🟢 4/4 4/4
security.enroll_kibana Missing test Missing test
security.enroll_node Missing test Missing test
security.get_api_key 🟢 28/28 28/28
security.get_builtin_privileges 🟢 2/2 2/2
security.get_privileges 🟢 12/12 12/12
security.get_role_mapping 🟢 18/18 18/18
security.get_role 🟢 20/20 20/20
security.get_service_accounts Missing test Missing test
security.get_service_credentials 🟢 1/1 1/1
security.get_token 🟢 23/23 22/22
security.get_user_privileges 🟢 7/7 7/7
security.get_user_profile 🟢 8/8 8/8
security.get_user 🟢 25/25 25/25
security.grant_api_key 🟢 7/7 7/7
security.has_privileges_user_profile 🟢 3/3 3/3
security.has_privileges 🟢 21/21 21/21
security.invalidate_api_key 🟢 10/10 10/10
security.invalidate_token 🟢 11/11 11/11
security.oidc_authenticate 🟠 Missing type Missing type
security.oidc_logout 🟠 Missing type Missing type
security.oidc_prepare_authentication 🟠 Missing type Missing type
security.put_privileges 🟢 10/10 10/10
security.put_role_mapping 🟢 11/11 11/11
security.put_role 🟢 39/39 38/38
security.put_user 🟢 48/48 47/47
security.query_api_keys 🟢 9/9 9/9
security.saml_authenticate Missing test Missing test
security.saml_complete_logout Missing test Missing test
security.saml_invalidate Missing test Missing test
security.saml_logout Missing test Missing test
security.saml_prepare_authentication Missing test Missing test
security.saml_service_provider_metadata Missing test Missing test
security.suggest_user_profiles 🟢 1/1 1/1
security.update_api_key 🟢 4/4 4/4
security.update_user_profile_data 🟢 1/1 1/1

You can validate these APIs yourself by using the make validate target.

@sethmlarson sethmlarson requested a review from a team April 20, 2023 01:16
@sethmlarson sethmlarson changed the title Convert IndexPrivilege to a non-exhaustive enum Convert IndexPrivilege and ClusterPrivilege to non-exhaustive enums Apr 20, 2023
@swallez swallez merged commit 899364a into main Apr 26, 2023
@swallez swallez deleted the index-privilege-non-exhaustive branch April 26, 2023 17:10
@github-actions
Copy link
Contributor

The backport to 7.17 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-7.17 7.17
# Navigate to the new working tree
cd .worktrees/backport-7.17
# Create a new branch
git switch --create backport-2084-to-7.17
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick --mainline 1 899364a63e7415b60033ddd49d50a30369da26d7
# Push it to GitHub
git push --set-upstream origin backport-2084-to-7.17
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-7.17

Then, create a pull request where the base branch is 7.17 and the compare/head branch is backport-2084-to-7.17.

@github-actions
Copy link
Contributor

The backport to 8.8 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-8.8 8.8
# Navigate to the new working tree
cd .worktrees/backport-8.8
# Create a new branch
git switch --create backport-2084-to-8.8
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick --mainline 1 899364a63e7415b60033ddd49d50a30369da26d7
# Push it to GitHub
git push --set-upstream origin backport-2084-to-8.8
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.8

Then, create a pull request where the base branch is 8.8 and the compare/head branch is backport-2084-to-8.8.

swallez added a commit that referenced this pull request Apr 26, 2023
swallez added a commit that referenced this pull request Apr 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants