Unauthorized route migration for routes owned by kibana-visualizations,kibana-data-discovery #198331
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
…ibana-data-discovery
kibanamachine
added
Team:Visualizations
|
Pinging @elastic/kibana-visualizations (Team:Visualizations) |
|
Pinging @elastic/kibana-data-discovery (Team:DataDiscovery) |
|
I guess search sessions shouldn't be excluded from authorization? |
…a-visualizations_kibana-data-discovery
jloleysens
approved these changes
Nov 18, 2024
…a-visualizations_kibana-data-discovery
davismcphee
approved these changes
Nov 21, 2024
| security: { | ||
| authz: { | ||
| enabled: false, | ||
| reason: 'This route is opted out from authorization', |
There was a problem hiding this comment.
Could we please elaborate on the reasoning there?
There was a problem hiding this comment.
@lukasolson Maybe something along the lines of "It should be possible to collect KQL usage telemetry for all users regardless of their privileges"?
There was a problem hiding this comment.
but not all users are able to call this endpoint right?
There was a problem hiding this comment.
I don't want to mislead so maybe @lukasolson can confirm, but I believe they can. It's called whenever a user changes their filter language preference in Unified Search from anywhere in Kibana, which doesn't have any privileges around it:
There was a problem hiding this comment.
This endpoint needs to be removed. This is the sort of thing I think we were trying to catch with this PR to begin with - we are using the internal Kibana user to create a saved object when any user invokes this endpoint, which is not ideal. I'll open up a follow-up issue for this
elena-shostak
approved these changes
Nov 26, 2024
…a-visualizations_kibana-data-discovery
nreese
reviewed
Dec 3, 2024
| @@ -197,6 +198,7 @@ export class MapsPlugin implements Plugin { | |||
| read: [MAP_SAVED_OBJECT_TYPE, 'index-pattern', 'query', 'tag'], | |||
| }, | |||
| ui: ['show'], | |||
| api: ['savedQuery:read'], | |||
There was a problem hiding this comment.
Does this mean you can only access maps application if you have the role 'savedQuery:read'? I am not sure that restriction makes sense.
There was a problem hiding this comment.
No, it means that by having access to the maps application you are automatically granted access to APIs that require savedQuery:read privileges.
nreese
approved these changes
Dec 3, 2024
mbondyra
approved these changes
Dec 4, 2024
…a-visualizations_kibana-data-discovery
…a-visualizations_kibana-data-discovery
…a-visualizations_kibana-data-discovery
janmonschke
approved these changes
Dec 4, 2024
TattdCodeMonkey
approved these changes
Dec 4, 2024
…a-visualizations_kibana-data-discovery
💚 Build Succeeded
Metrics [docs]
History
cc @lukasolson |
lukasolson
deleted the
authz-migration/unauthorized-routes-by-kibana-visualizations_kibana-data-discovery
branch
|
Starting backport for target branches: 8.x https://github.com/elastic/kibana/actions/runs/12169460505 |
kibanamachine
added a commit
to kibanamachine/kibana
that referenced
this pull request
Dec 4, 2024
…s,kibana-data-discovery (elastic#198331) ### Authz API migration for unauthorized routes This PR migrates unauthorized routes owned by your team to a 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) --- EDIT --- This PR also adds two privileges related to saved query APIs: `savedQuery:read` and `savedQuery:manage`. These are given by default to the same roles that already have access to the `query`-type saved objects. ### **Before migration:** ```ts router.get({ path: '/api/path', ... }, handler); ``` ### **After migration:** ```ts router.get({ path: '/api/path', security: { authz: { enabled: false, reason: 'This route is opted out from authorization because ...', }, }, ... }, handler); ``` ### What to do next? 1. Review the changes in this PR. 2. Elaborate on the reasoning to opt-out of authorization. 3. Routes without a compelling reason to opt-out of authorization should plan to introduce them as soon as possible. 2. You might need to update your tests to reflect the new security configuration: - If you have snapshot tests that include the route definition. ## 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: Lukas Olson <[email protected]> Co-authored-by: Matthias Wilhelm <[email protected]> Co-authored-by: Marta Bondyra <[email protected]> Co-authored-by: Davis McPhee <[email protected]> (cherry picked from commit 56c38bc)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Dec 5, 2024
…zations,kibana-data-discovery (#198331) (#203031) # Backport This will backport the following commits from `main` to `8.x`: - [Unauthorized route migration for routes owned by kibana-visualizations,kibana-data-discovery (#198331)](#198331) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Kibana Machine","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-12-04T22:29:15Z","message":"Unauthorized route migration for routes owned by kibana-visualizations,kibana-data-discovery (#198331)\n\n### Authz API migration for unauthorized routes\r\n\r\nThis PR migrates unauthorized routes owned by your team to a new\r\nsecurity configuration.\r\nPlease refer to the documentation for more information: [Authorization\r\nAPI](https://docs.elastic.dev/kibana-dev-docs/key-concepts/security-api-authorization)\r\n\r\n--- EDIT ---\r\n\r\nThis PR also adds two privileges related to saved query APIs:\r\n`savedQuery:read` and `savedQuery:manage`. These are given by default to\r\nthe same roles that already have access to the `query`-type saved\r\nobjects.\r\n\r\n### **Before migration:**\r\n```ts\r\nrouter.get({\r\n path: '/api/path',\r\n ...\r\n}, handler);\r\n```\r\n\r\n### **After migration:**\r\n```ts\r\nrouter.get({\r\n path: '/api/path',\r\n security: {\r\n authz: {\r\n enabled: false,\r\n reason: 'This route is opted out from authorization because ...',\r\n },\r\n },\r\n ...\r\n}, handler);\r\n```\r\n\r\n### What to do next?\r\n1. Review the changes in this PR.\r\n2. Elaborate on the reasoning to opt-out of authorization.\r\n3. Routes without a compelling reason to opt-out of authorization should\r\nplan to introduce them as soon as possible.\r\n2. You might need to update your tests to reflect the new security\r\nconfiguration:\r\n - If you have snapshot tests that include the route definition.\r\n\r\n## Any questions?\r\nIf you have any questions or need help with API authorization, please\r\nreach out to the `@elastic/kibana-security` team.\r\n\r\n---------\r\n\r\nCo-authored-by: Lukas Olson <[email protected]>\r\nCo-authored-by: Matthias Wilhelm <[email protected]>\r\nCo-authored-by: Marta Bondyra <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","sha":"56c38bca201ee453ee14c5eaf10baba87d6c2d8c","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["enhancement","Team:Visualizations","release_note:skip","Feature:Security/Authorization","v9.0.0","Team:DataDiscovery","backport:prev-minor","Authz: API migration"],"title":"Unauthorized route migration for routes owned by kibana-visualizations,kibana-data-discovery","number":198331,"url":"https://github.com/elastic/kibana/pull/198331","mergeCommit":{"message":"Unauthorized route migration for routes owned by kibana-visualizations,kibana-data-discovery (#198331)\n\n### Authz API migration for unauthorized routes\r\n\r\nThis PR migrates unauthorized routes owned by your team to a new\r\nsecurity configuration.\r\nPlease refer to the documentation for more information: [Authorization\r\nAPI](https://docs.elastic.dev/kibana-dev-docs/key-concepts/security-api-authorization)\r\n\r\n--- EDIT ---\r\n\r\nThis PR also adds two privileges related to saved query APIs:\r\n`savedQuery:read` and `savedQuery:manage`. These are given by default to\r\nthe same roles that already have access to the `query`-type saved\r\nobjects.\r\n\r\n### **Before migration:**\r\n```ts\r\nrouter.get({\r\n path: '/api/path',\r\n ...\r\n}, handler);\r\n```\r\n\r\n### **After migration:**\r\n```ts\r\nrouter.get({\r\n path: '/api/path',\r\n security: {\r\n authz: {\r\n enabled: false,\r\n reason: 'This route is opted out from authorization because ...',\r\n },\r\n },\r\n ...\r\n}, handler);\r\n```\r\n\r\n### What to do next?\r\n1. Review the changes in this PR.\r\n2. Elaborate on the reasoning to opt-out of authorization.\r\n3. Routes without a compelling reason to opt-out of authorization should\r\nplan to introduce them as soon as possible.\r\n2. You might need to update your tests to reflect the new security\r\nconfiguration:\r\n - If you have snapshot tests that include the route definition.\r\n\r\n## Any questions?\r\nIf you have any questions or need help with API authorization, please\r\nreach out to the `@elastic/kibana-security` team.\r\n\r\n---------\r\n\r\nCo-authored-by: Lukas Olson <[email protected]>\r\nCo-authored-by: Matthias Wilhelm <[email protected]>\r\nCo-authored-by: Marta Bondyra <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","sha":"56c38bca201ee453ee14c5eaf10baba87d6c2d8c"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/198331","number":198331,"mergeCommit":{"message":"Unauthorized route migration for routes owned by kibana-visualizations,kibana-data-discovery (#198331)\n\n### Authz API migration for unauthorized routes\r\n\r\nThis PR migrates unauthorized routes owned by your team to a new\r\nsecurity configuration.\r\nPlease refer to the documentation for more information: [Authorization\r\nAPI](https://docs.elastic.dev/kibana-dev-docs/key-concepts/security-api-authorization)\r\n\r\n--- EDIT ---\r\n\r\nThis PR also adds two privileges related to saved query APIs:\r\n`savedQuery:read` and `savedQuery:manage`. These are given by default to\r\nthe same roles that already have access to the `query`-type saved\r\nobjects.\r\n\r\n### **Before migration:**\r\n```ts\r\nrouter.get({\r\n path: '/api/path',\r\n ...\r\n}, handler);\r\n```\r\n\r\n### **After migration:**\r\n```ts\r\nrouter.get({\r\n path: '/api/path',\r\n security: {\r\n authz: {\r\n enabled: false,\r\n reason: 'This route is opted out from authorization because ...',\r\n },\r\n },\r\n ...\r\n}, handler);\r\n```\r\n\r\n### What to do next?\r\n1. Review the changes in this PR.\r\n2. Elaborate on the reasoning to opt-out of authorization.\r\n3. Routes without a compelling reason to opt-out of authorization should\r\nplan to introduce them as soon as possible.\r\n2. You might need to update your tests to reflect the new security\r\nconfiguration:\r\n - If you have snapshot tests that include the route definition.\r\n\r\n## Any questions?\r\nIf you have any questions or need help with API authorization, please\r\nreach out to the `@elastic/kibana-security` team.\r\n\r\n---------\r\n\r\nCo-authored-by: Lukas Olson <[email protected]>\r\nCo-authored-by: Matthias Wilhelm <[email protected]>\r\nCo-authored-by: Marta Bondyra <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","sha":"56c38bca201ee453ee14c5eaf10baba87d6c2d8c"}}]}] BACKPORT-->
SoniaSanzV
pushed a commit
to SoniaSanzV/kibana
that referenced
this pull request
Dec 9, 2024
…s,kibana-data-discovery (elastic#198331) ### Authz API migration for unauthorized routes This PR migrates unauthorized routes owned by your team to a 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) --- EDIT --- This PR also adds two privileges related to saved query APIs: `savedQuery:read` and `savedQuery:manage`. These are given by default to the same roles that already have access to the `query`-type saved objects. ### **Before migration:** ```ts router.get({ path: '/api/path', ... }, handler); ``` ### **After migration:** ```ts router.get({ path: '/api/path', security: { authz: { enabled: false, reason: 'This route is opted out from authorization because ...', }, }, ... }, handler); ``` ### What to do next? 1. Review the changes in this PR. 2. Elaborate on the reasoning to opt-out of authorization. 3. Routes without a compelling reason to opt-out of authorization should plan to introduce them as soon as possible. 2. You might need to update your tests to reflect the new security configuration: - If you have snapshot tests that include the route definition. ## 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: Lukas Olson <[email protected]> Co-authored-by: Matthias Wilhelm <[email protected]> Co-authored-by: Marta Bondyra <[email protected]> Co-authored-by: Davis McPhee <[email protected]>
SoniaSanzV
pushed a commit
to SoniaSanzV/kibana
that referenced
this pull request
Dec 9, 2024
…s,kibana-data-discovery (elastic#198331) ### Authz API migration for unauthorized routes This PR migrates unauthorized routes owned by your team to a 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) --- EDIT --- This PR also adds two privileges related to saved query APIs: `savedQuery:read` and `savedQuery:manage`. These are given by default to the same roles that already have access to the `query`-type saved objects. ### **Before migration:** ```ts router.get({ path: '/api/path', ... }, handler); ``` ### **After migration:** ```ts router.get({ path: '/api/path', security: { authz: { enabled: false, reason: 'This route is opted out from authorization because ...', }, }, ... }, handler); ``` ### What to do next? 1. Review the changes in this PR. 2. Elaborate on the reasoning to opt-out of authorization. 3. Routes without a compelling reason to opt-out of authorization should plan to introduce them as soon as possible. 2. You might need to update your tests to reflect the new security configuration: - If you have snapshot tests that include the route definition. ## 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: Lukas Olson <[email protected]> Co-authored-by: Matthias Wilhelm <[email protected]> Co-authored-by: Marta Bondyra <[email protected]> Co-authored-by: Davis McPhee <[email protected]>
CAWilson94
pushed a commit
to CAWilson94/kibana
that referenced
this pull request
Dec 9, 2024
…s,kibana-data-discovery (elastic#198331) ### Authz API migration for unauthorized routes This PR migrates unauthorized routes owned by your team to a 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) --- EDIT --- This PR also adds two privileges related to saved query APIs: `savedQuery:read` and `savedQuery:manage`. These are given by default to the same roles that already have access to the `query`-type saved objects. ### **Before migration:** ```ts router.get({ path: '/api/path', ... }, handler); ``` ### **After migration:** ```ts router.get({ path: '/api/path', security: { authz: { enabled: false, reason: 'This route is opted out from authorization because ...', }, }, ... }, handler); ``` ### What to do next? 1. Review the changes in this PR. 2. Elaborate on the reasoning to opt-out of authorization. 3. Routes without a compelling reason to opt-out of authorization should plan to introduce them as soon as possible. 2. You might need to update your tests to reflect the new security configuration: - If you have snapshot tests that include the route definition. ## 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: Lukas Olson <[email protected]> Co-authored-by: Matthias Wilhelm <[email protected]> Co-authored-by: Marta Bondyra <[email protected]> Co-authored-by: Davis McPhee <[email protected]>
Samiul-TheSoccerFan
pushed a commit
to Samiul-TheSoccerFan/kibana
that referenced
this pull request
Dec 10, 2024
…s,kibana-data-discovery (elastic#198331) ### Authz API migration for unauthorized routes This PR migrates unauthorized routes owned by your team to a 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) --- EDIT --- This PR also adds two privileges related to saved query APIs: `savedQuery:read` and `savedQuery:manage`. These are given by default to the same roles that already have access to the `query`-type saved objects. ### **Before migration:** ```ts router.get({ path: '/api/path', ... }, handler); ``` ### **After migration:** ```ts router.get({ path: '/api/path', security: { authz: { enabled: false, reason: 'This route is opted out from authorization because ...', }, }, ... }, handler); ``` ### What to do next? 1. Review the changes in this PR. 2. Elaborate on the reasoning to opt-out of authorization. 3. Routes without a compelling reason to opt-out of authorization should plan to introduce them as soon as possible. 2. You might need to update your tests to reflect the new security configuration: - If you have snapshot tests that include the route definition. ## 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: Lukas Olson <[email protected]> Co-authored-by: Matthias Wilhelm <[email protected]> Co-authored-by: Marta Bondyra <[email protected]> Co-authored-by: Davis McPhee <[email protected]>
CAWilson94
pushed a commit
to CAWilson94/kibana
that referenced
this pull request
Dec 12, 2024
…s,kibana-data-discovery (elastic#198331) ### Authz API migration for unauthorized routes This PR migrates unauthorized routes owned by your team to a 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) --- EDIT --- This PR also adds two privileges related to saved query APIs: `savedQuery:read` and `savedQuery:manage`. These are given by default to the same roles that already have access to the `query`-type saved objects. ### **Before migration:** ```ts router.get({ path: '/api/path', ... }, handler); ``` ### **After migration:** ```ts router.get({ path: '/api/path', security: { authz: { enabled: false, reason: 'This route is opted out from authorization because ...', }, }, ... }, handler); ``` ### What to do next? 1. Review the changes in this PR. 2. Elaborate on the reasoning to opt-out of authorization. 3. Routes without a compelling reason to opt-out of authorization should plan to introduce them as soon as possible. 2. You might need to update your tests to reflect the new security configuration: - If you have snapshot tests that include the route definition. ## 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: Lukas Olson <[email protected]> Co-authored-by: Matthias Wilhelm <[email protected]> Co-authored-by: Marta Bondyra <[email protected]> Co-authored-by: Davis McPhee <[email protected]>
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.
Authz API migration for unauthorized routes
This PR migrates unauthorized routes owned by your team to a new security configuration.
Please refer to the documentation for more information: Authorization API
--- EDIT ---
This PR also adds two privileges related to saved query APIs:
savedQuery:readandsavedQuery:manage. These are given by default to the same roles that already have access to thequery-type saved objects.Before migration:
After migration:
What to do next?
Any questions?
If you have any questions or need help with API authorization, please reach out to the
@elastic/kibana-securityteam.