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

fix(security): fix RBAC access check for dashboards to properly bypass dataset-level permission checks #32289

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

imad-hl
Copy link

@imad-hl imad-hl commented Feb 17, 2025

SUMMARY

This PR addresses issue #31938 by fixing the RBAC access checks in the security manager. The changes:

  • Ensure that enabling DASHBOARD_RBAC and granting a role access to a dashboard properly bypasses dataset-level permission checks.
  • Refactor the logic for improved clarity.

Before this fix, enabling DASHBOARD_RBAC failed to bypass dataset-level checks for users who had dashboard access through their role, causing incorrect access control behavior.

fixes: #31938

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

BEFORE : The user, despite having the correct RBAC role, was incorrectly blocked by dataset-level checks.
image
AFTER: The fix ensures that the user’s RBAC role correctly bypasses dataset-level access checks.
image

TESTING INSTRUCTIONS

  1. Enable the DASHBOARD_RBAC feature flag.
  2. Assign a role to a user and grant that role access to a dashboard.
  3. Verify that the user, with the assigned role, can access the dashboard’s charts without being blocked by dataset-level permission checks.

ADDITIONAL INFORMATION

Copy link

korbit-ai bot commented Feb 17, 2025

Based on your review schedule, I'll hold off on reviewing this PR until it's marked as ready for review. If you'd like me to take a look now, comment /korbit-review.

Your admin can change your review schedule in the Korbit Console

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Congrats on making your first PR and thank you for contributing to Superset! 🎉 ❤️

We hope to see you in our Slack community too! Not signed up? Use our Slack App to self-register.

@imad-hl imad-hl marked this pull request as ready for review February 18, 2025 09:56
@dosubot dosubot bot added authentication:RBAC Related to RBAC dashboard:security:access Related to the security access of the Dashboard labels Feb 18, 2025
Copy link

@korbit-ai korbit-ai bot left a comment

Choose a reason for hiding this comment

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

Review by Korbit AI

Korbit automatically attempts to detect when you fix issues in new commits.
Category Issue Fix Detected
Logging Insufficient error logging context ▹ view
Readability Inconsistent variable grouping spacing ▹ view
Error Handling Unsafe Dashboard Fetch Exception Handling ▹ view
Files scanned
File Path Reviewed
superset/security/manager.py

Explore our documentation to understand the languages and file types we support and the files we ignore.

Need a new review? Comment /korbit-review on this PR and I'll review your latest changes.

Korbit Guide: Usage and Customization

Interacting with Korbit

  • You can manually ask Korbit to review your PR using the /korbit-review command in a comment at the root of your PR.
  • You can ask Korbit to generate a new PR description using the /korbit-generate-pr-description command in any comment on your PR.
  • Too many Korbit comments? I can resolve all my comment threads if you use the /korbit-resolve command in any comment on your PR.
  • Chat with Korbit on issues we post by tagging @korbit-ai in your reply.
  • Help train Korbit to improve your reviews by giving a 👍 or 👎 on the comments Korbit posts.

Customizing Korbit

  • Check out our docs on how you can make Korbit work best for you and your team.
  • Customize Korbit for your organization through the Korbit Console.

Feedback and Support

Comment on lines 2317 to 2318
except Exception as e:
logging.error(f"Error fetching dashboard {dashboard_id}: {e}")
Copy link

Choose a reason for hiding this comment

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

Insufficient error logging context category Logging

Tell me more
What is the issue?

The log message lacks context about the method and operation being performed. The exception traceback is not captured.

Why this matters

Without method context and stack trace, it will be difficult to debug production issues when dashboard fetching fails. The error log may not provide enough information to identify the root cause.

Suggested change ∙ Feature Preview
except Exception as e:
    logging.error(
        "Error in raise_for_access when fetching dashboard %s: %s", 
        dashboard_id,
        str(e),
        exc_info=True
    )

Report a problem with this comment

💬 Chat with Korbit by mentioning @korbit-ai.

Comment on lines 2315 to 2318
try:
dashboard_ = self.get_session.query(Dashboard).filter(Dashboard.id == dashboard_id).one_or_none()
except Exception as e:
logging.error(f"Error fetching dashboard {dashboard_id}: {e}")

This comment was marked as resolved.

@pull-request-size pull-request-size bot added size/M and removed size/L labels Feb 18, 2025
Copy link

@korbit-ai korbit-ai bot left a comment

Choose a reason for hiding this comment

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

Review by Korbit AI

Korbit automatically attempts to detect when you fix issues in new commits.
Category Issue Fix Detected
Functionality Redundant Data Source Initialization ▹ view
Files scanned
File Path Reviewed
superset/security/manager.py

Explore our documentation to understand the languages and file types we support and the files we ignore.

Need a new review? Comment /korbit-review on this PR and I'll review your latest changes.

Korbit Guide: Usage and Customization

Interacting with Korbit

  • You can manually ask Korbit to review your PR using the /korbit-review command in a comment at the root of your PR.
  • You can ask Korbit to generate a new PR description using the /korbit-generate-pr-description command in any comment on your PR.
  • Too many Korbit comments? I can resolve all my comment threads if you use the /korbit-resolve command in any comment on your PR.
  • Chat with Korbit on issues we post by tagging @korbit-ai in your reply.
  • Help train Korbit to improve your reviews by giving a 👍 or 👎 on the comments Korbit posts.

Customizing Korbit

  • Check out our docs on how you can make Korbit work best for you and your team.
  • Customize Korbit for your organization through the Korbit Console.

Feedback and Support

Comment on lines 2293 to 2301
if datasource or query_context or viz:
form_data = None

if query_context:
datasource = query_context.datasource
form_data = query_context.form_data
elif viz:
datasource = viz.datasource
form_data = viz.form_data

This comment was marked as resolved.

@imad-hl imad-hl changed the title Fix issue 31938 fix(security): fix RBAC access check for dashboards to bypass dataset-level checks Feb 18, 2025
@imad-hl imad-hl changed the title fix(security): fix RBAC access check for dashboards to bypass dataset-level checks fix(security): fix RBAC access check for dashboards to properly bypass dataset-level permission checks Feb 18, 2025
Copy link

@korbit-ai korbit-ai bot left a comment

Choose a reason for hiding this comment

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

Review by Korbit AI

Korbit automatically attempts to detect when you fix issues in new commits.
Category Issue Fix Detected
Readability Unclear variable assignment pattern ▹ view
Files scanned
File Path Reviewed
superset/security/manager.py

Explore our documentation to understand the languages and file types we support and the files we ignore.

Need a new review? Comment /korbit-review on this PR and I'll review your latest changes.

Korbit Guide: Usage and Customization

Interacting with Korbit

  • You can manually ask Korbit to review your PR using the /korbit-review command in a comment at the root of your PR.
  • You can ask Korbit to generate a new PR description using the /korbit-generate-pr-description command in any comment on your PR.
  • Too many Korbit comments? I can resolve all my comment threads if you use the /korbit-resolve command in any comment on your PR.
  • Chat with Korbit on issues we post by tagging @korbit-ai in your reply.
  • Help train Korbit to improve your reviews by giving a 👍 or 👎 on the comments Korbit posts.

Customizing Korbit

  • Check out our docs on how you can make Korbit work best for you and your team.
  • Customize Korbit for your organization through the Korbit Console.

Current Korbit Configuration

General Settings
Setting Value
Review Schedule Automatic excluding drafts
Max Issue Count 10
Automatic PR Descriptions
Issue Categories
Category Enabled
Documentation
Logging
Error Handling
Readability
Design
Performance
Security
Functionality

Feedback and Support

Note

Korbit Pro is free for open source projects 🎉

Looking to add Korbit to your team? Get started with a free 2 week trial here

Comment on lines +2303 to +2304
if form_data and (dashboard_id := form_data.get("dashboardId")):
dashboard_ = self.get_session.query(Dashboard).filter(Dashboard.id == dashboard_id).one_or_none()
Copy link

Choose a reason for hiding this comment

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

Unclear variable assignment pattern category Readability

Tell me more
What is the issue?

The use of walrus operator (:=) combined with underscore suffix naming makes the code less immediately readable.

Why this matters

While the walrus operator can be useful, combining it with underscore suffix naming reduces code clarity at first glance.

Suggested change ∙ Feature Preview
dashboard_id = form_data.get("dashboardId") if form_data else None
if dashboard_id:
    dashboard = self.get_session.query(Dashboard).filter(Dashboard.id == dashboard_id).one_or_none()

Report a problem with this comment

💬 Chat with Korbit by mentioning @korbit-ai.

@michael-s-molina michael-s-molina added the review:checkpoint Last PR reviewed during the daily review standup label Feb 18, 2025
@sadpandajoe sadpandajoe removed the review:checkpoint Last PR reviewed during the daily review standup label Feb 19, 2025
@u35253
Copy link

u35253 commented Feb 20, 2025

Thank you so much for giving DASHBOARD_RBAC this love!

It possible, can this please be tested (or otherwise checked) to tell if the change also resolves the special case that "a dataset included in a dataset as a subquery using the built-in dataset() Jinja macro does not get granted DASHBOARD_RBAC based accessibility even though such access is expected", as commented on previously at?: #31938 (comment)

(I looked through the file changes, and was not entirely certain if such DASHBOARD_RBAC-based nested/Jinja-included dataset accessibility is already fixed in this change -- to me, it looked like "maybe?").

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
authentication:RBAC Related to RBAC dashboard:security:access Related to the security access of the Dashboard size/M
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The DASHBOARD_RBAC feature flag doesn't seem to work as intended, even with the example dataset
4 participants