[8.x] Authorized route migration for routes owned by kibana-security (#198380) #198657
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ic#198380) ### Authz API migration for authorized routes This PR migrates `access:<privilege>` tags used in route definitions to new security configuration. Please refer to the documentation for more information: [Authorization API](https://docs.elastic.dev/kibana-dev-docs/key-concepts/security-api-authorization) ### **Before migration:** Access control tags were defined in the `options` object of the route: ```ts router.get({ path: '/api/path', options: { tags: ['access:<privilege_1>', 'access:<privilege_2>'], }, ... }, handler); ``` ### **After migration:** Tags have been replaced with the more robust `security.authz.requiredPrivileges` field under `security`: ```ts router.get({ path: '/api/path', security: { authz: { requiredPrivileges: ['<privilege_1>', '<privilege_2>'], }, }, ... }, handler); ``` ### What to do next? 1. Review the changes in this PR. 2. You might need to update your tests to reflect the new security configuration: - If you have tests that rely on checking `access` tags. - If you have snapshot tests that include the route definition. - If you have FTR tests that rely on checking unauthorized error message. The error message changed to also include missing privileges. ## Any questions? If you have any questions or need help with API authorization, please reach out to the `@elastic/kibana-security` team. --------- Co-authored-by: Elena Shostak <[email protected]> (cherry picked from commit 20989b6) # Conflicts: # x-pack/plugins/security/server/routes/authorization/roles/get_all_by_space.test.ts # x-pack/plugins/security/server/routes/authorization/roles/get_all_by_space.ts # x-pack/plugins/spaces/server/routes/api/internal/get_content_summary.test.ts # x-pack/plugins/spaces/server/routes/api/internal/get_content_summary.ts
💚 Build Succeeded
Metrics [docs]
|
azasypkin
approved these changes
Nov 1, 2024
| @@ -37,14 +37,19 @@ export function defineInvalidateSessionsRoutes({ | |||
| ), | |||
| }), | |||
| }, | |||
| security: { | |||
| authz: { | |||
| requiredPrivileges: ['sessionManagement'], | |||
There was a problem hiding this comment.
question: just for my understanding, I see we renamed access:manageSpaces to manage_spaces, but access:sessionManagement stayed as sessionManagement, is it intentional?
There was a problem hiding this comment.
Probably, we just forgot to rename it too, there should consistency between naming
There was a problem hiding this comment.
Created an issue for that #198716
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Backport
This will backport the following commits from
mainto8.x:Questions ?
Please refer to the Backport tool documentation