Skip to content

fix: split authz view and manage permissions in ProctoredExamSettingsView - #39196

Merged
mariajgrimaldi merged 2 commits into
openedx:masterfrom
eduNEXT:bav/proctored-exam-settings-authz
Oct 13, 2026
Merged

mariajgrimaldi merged 2 commits into
openedx:masterfrom
eduNEXT:bav/proctored-exam-settings-authz

Conversation

@BryanttV

@BryanttV BryanttV commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

Description

Builds on #39153, which added the courses.manage_pages_and_resources AuthZ check to ProctoredExamSettingsView. That change stacked the AuthZ check on top of the legacy Studio read check and used the manage permission for both GET and POST. This PR makes AuthZ the only gate for the endpoint and splits read from write access:

  • GET requires courses.view_pages_and_resources; POST requires courses.manage_pages_and_resources.
  • When AuthZ course authoring is not enabled for the course, both fall back to legacy Studio read access, as before.
  • POST now checks access before validating the payload, so unauthorized users get a 403 instead of payload-dependent responses.
  • Fields reserved to edX staff can be edited by users with is_staff, or by users holding the manage permission when AuthZ is enabled for the course. Without AuthZ, they stay reserved to global staff.
  • The legacy get_course_and_check_access call is replaced by a direct modulestore().get_course(...) lookup after the permission check, so the AuthZ check is not stacked on top of the legacy one.

Impacted roles: Course Author / Course Staff managing proctoring settings in Studio, and Operators using the API directly.

Supporting information

Testing instructions

  1. With AuthZ course authoring enabled for a course:
    • A user with only a view role gets 200 on GET /api/contentstore/v1/proctored_exam_settings/<course_id> and 403 on POST.
    • A user with a role including courses.manage_pages_and_resources can GET and POST, including the staff-only fields.
    • A user with no role on the course gets 403 on both.
  2. With AuthZ disabled for the course, confirm the legacy behavior is unchanged: course staff with read access can GET/POST the limited fields, and only is_staff users can edit the staff-only fields.

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Oct 6, 2026
@openedx-webhooks

openedx-webhooks commented Oct 6, 2026 •

Copy link
Copy Markdown

Thanks for the pull request, @BryanttV!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform-oncall.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@rodmgwgu rodmgwgu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for this, tested in my local and works as described, code looks good, thanks!

@BryanttV
BryanttV requested a review from efortish October 13, 2026 17:11
efortish and others added 2 commits October 13, 2026 12:32
…ngsView

GET and POST on this endpoint only required studio read access, so a
user who could view a course in Studio could also read or overwrite
its proctored exam settings by calling the API directly, bypassing
the UI's staff-only enforcement. Add the same authz check used
elsewhere for pages-and-resources management, with a write-level
legacy fallback when authz is disabled.

Closes openedx-authz#443
Make the AuthZ check the only gate for the proctored exam settings
endpoint instead of stacking it on top of the legacy Studio read check:

- GET requires courses.view_pages_and_resources and POST requires
  courses.manage_pages_and_resources. Without AuthZ, both fall back to
  legacy Studio read access, as before.
- POST checks access before validating the payload.
- Users with is_staff, or with the manage permission when AuthZ is
  enabled, can edit the fields reserved to edX staff.

Replace the mocked AuthZ tests with tests that assign real roles.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@BryanttV
BryanttV force-pushed the bav/proctored-exam-settings-authz branch from ed0a557 to 0cb8eaf Compare October 13, 2026 17:33

@mariajgrimaldi mariajgrimaldi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM!

@mariajgrimaldi
mariajgrimaldi merged commit ce074d1 into openedx:master Oct 13, 2026
42 checks passed
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions Oct 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Add authz validation for courses.manage_pages_and_resources to ProctoredExamSettingsView

5 participants