Fix issue in validating scopes for secondary userstore users

[msm1992]

Fixes wso2/api-manager#3836

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request updates the scope validation logic in the BasicAuthAuthenticator class. It replaces the plain username with a domainQualifiedUserName when invoking the validateScopes method. Additionally, it adjusts the declaration order of domainQualifiedUserName to ensure it is defined before its use in the scope validation logic. The error handling via the try-catch block remains unchanged.

Changes

File	Change Summary
components/apimgt/.../BasicAuthAuthenticator.java	Replaced username with domainQualifiedUserName in the validateScopes method call; moved its declaration to precede its usage.

Sequence Diagram(s)

sequenceDiagram
  participant Client
  participant Authenticator as BasicAuthAuthenticator
  participant Validator as BasicAuthCredentialValidator

  Client->>Authenticator: Initiate authentication request
  Authenticator->>Validator: validateScopes(domainQualifiedUserName)
  Validator-->>Authenticator: Return validation result
  Authenticator->>Client: Send response (success/error)

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Ensure accurate scope validation for users from multiple user stores (#3836)	✅

Suggested reviewers

• tgtshanika
• chamilaadhi
• dushaniw
• Arshardh
• AnuGayan

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3ac8150 and 83210d5.

📒 Files selected for processing (1)

• components/apimgt/org.wso2.carbon.apimgt.gateway/src/main/java/org/wso2/carbon/apimgt/gateway/handlers/security/basicauth/BasicAuthAuthenticator.java (1 hunks)

🔇 Additional comments (1)

components/apimgt/org.wso2.carbon.apimgt.gateway/src/main/java/org/wso2/carbon/apimgt/gateway/handlers/security/basicauth/BasicAuthAuthenticator.java (1)

209-214: Good fix for the secondary userstore scope validation issue.

The change correctly leverages the domain-qualified username for scope validation instead of the plain username. This ensures that users from secondary userstores are properly identified during scope validation.

Previously, the code was using the regular username for scope validation, which might not correctly identify users from secondary userstores. By using the domain-qualified username from the validation info object, the code now properly handles userstore domain information during scope validation.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.