Problem/Motivation

By default, when enabling JSON:API Extras and Varbase API recipe, all resource types are available for public API access unless explicitly disabled or restricted.

This can unintentionally expose entity data - such as user profiles, configuration entities, and unpublished content - when the API module is enabled without prior configuration.

To enhance security, privacy, and compliance, Varbase should ship with a safer default configuration for JSON:API resources - disabling all unspecified resources by default. This allows developers to explicitly enable only what they need.

Proposed resolution

  • Enhance the Varbase API recipe to use secure defaults that disable all resource types by default and require explicit activation.
  • All JSON:API resources are disabled by default.
  • Only explicitly enabled resources can be queried.
  • The JSON:API configuration is validated for integrity and consistency.
  • Reduces surface area for potential data exposure.

Remaining tasks

  • ✅ File an issue about this project
  • ✅ Addition/Change/Update/Fix to this project
  • ✅ Testing to ensure no regression
  • ➖ Automated unit/functional testing coverage
  • ➖ Developer Documentation support on feature change/addition
  • ➖ User Guide Documentation support on feature change/addition
  • ➖ UX/UI designer responsibilities
  • ➖ Accessibility and Readability
  • ✅ Code review from 1 Varbase core team member
  • ✅ Full testing and approval
  • ✅ Credit contributors
  • ✅ Review with the product owner
  • ✅ Update Release Notes and Update Helper on new feature change/addition
  • ✅ Release varbase-10.1.0-beta1, varbase_api-10.1.0-beta2, varbase-10.0.8, varbase_api-10.0.11, varbase-9.1.12, varbase_api-9.1.11

Varbase update type

  • ✅ No Update
  • ➖ Optional Update
  • ➖ Forced Update
  • ➖ Forced Update if Unchanged

User interface changes

  • N/A

API changes

  • N/A

Data model changes

  • N/A

Release notes snippet

  • [#3553624] fix(api): Improve Default JSON:API Resource Overrides to Limit Vulnerabilities in Varbase API

Comments

rajab natshah created an issue. See original summary.

  • rajab natshah committed bebc8d0d on 10.1.x
    [#3553624] fix(api): Improve Default JSON:API Resource Overrides to...

  • rajab natshah committed 5cab571e on 10.0.x
    [#3553624] fix(api): Improve Default JSON:API Resource Overrides to...

  • rajab natshah committed b1e72801 on 9.1.x
    [#3553624] fix(api): Improve Default JSON:API Resource Overrides to...
rajab natshah’s picture

rajab natshah’s picture

Issue summary: View changes

  • rajab natshah committed c0b43684 on 9.1.x
    [#3553624] fix(api): Improve Default JSON:API Resource Overrides to...

  • rajab natshah committed 27073097 on 10.0.x
    [#3553624] fix(api): Improve Default JSON:API Resource Overrides to...

  • rajab natshah committed e5d45978 on 10.0.x
    [#3553624] fix(api): Improve Default JSON:API Resource Overrides to...
rajab natshah’s picture

Issue summary: View changes
rajab natshah’s picture

Assigned: s.halawani » Unassigned
Status: Needs review » Fixed

Now that this issue is closed, please review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, please credit people who helped resolve this issue.

rajab natshah’s picture

Issue summary: View changes
rajab natshah’s picture

Issue summary: View changes

✅ Released varbase_api-9.1.11

rajab natshah’s picture

✅ Released varbase_api-10.0.11

rajab natshah’s picture

Issue summary: View changes

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

rajab natshah’s picture

Issue summary: View changes

✅ Released varbase-10.0.8

rajab natshah’s picture

Issue summary: View changes

✅ Released varbase-9.1.12