Make the REST API flow and WebSocket flow consistent for IS 7 client credentials opaque tokens

[HeshanSudarshana]

This PR makes the REST API flow and WebSocket flow consistent for IS 7 client credentials opaque tokens.

Fixes wso2/api-manager#3829

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request updates two gateway components that process WebSocket API requests. In the first update, the user identifier in the WebSocket utility is modified by introducing a new variable that appends the tenant domain if it is missing. In the second update, the OAuth authenticator now checks if the end user name is null and explicitly sets it to an anonymous value. Both changes are intended to ensure that a consistent and non-null user identity is used during authentication and request blocking checks.

Changes

File(s)	Change Summary
components/apimgt/.../handlers/WebsocketUtil.java	Introduced a new variable authorizedUser derived from infoDTO.getEndUserName(). Added a check to append @apiTenantDomain if missing before calling isRequestBlocked.
components/apimgt/.../inbound/websocket/Authentication/OAuthAuthenticator.java	Added a conditional in the authenticate method to set endUserName to a constant anonymous value when it is null, ensuring consistent user identification.

Sequence Diagram(s)

sequenceDiagram
    participant Handler as WebsocketUtil:validateDenyPolicies
    participant InfoDTO as infoDTO
    participant BlockCheck as isRequestBlocked
    Handler->>InfoDTO: Retrieve endUserName
    alt Tenant domain not appended to user
         Handler->>Handler: Append tenant domain (authorizedUser@apiTenantDomain)
    else Tenant domain already appended
         Note over Handler: No modification needed
    end
    Handler->>BlockCheck: Call isRequestBlocked with authorizedUser

Loading

sequenceDiagram
    participant Auth as OAuthAuthenticator:authenticate
    participant APIKey as APIKeyValidationInfoDTO
    Auth->>APIKey: Validate API key and populate info DTO
    alt endUserName is null
         Auth->>Auth: Set endUserName to anonymous constant
    else endUserName is present
         Note over Auth: Use the provided endUserName
    end
    Auth->>...: Continue authentication flow

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Proper endUserName handling for connection establishment with opaque tokens [#3829]	✅

---

📜 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 70b2410 and e825357.

📒 Files selected for processing (2)

• components/apimgt/org.wso2.carbon.apimgt.gateway/src/main/java/org/wso2/carbon/apimgt/gateway/handlers/WebsocketUtil.java (2 hunks)
• components/apimgt/org.wso2.carbon.apimgt.gateway/src/main/java/org/wso2/carbon/apimgt/gateway/inbound/websocket/Authentication/OAuthAuthenticator.java (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: run-benchmark-test
• GitHub Check: build-product (3, group3)
• GitHub Check: build-product (1, group1)
• GitHub Check: build-product (2, group2)
• GitHub Check: build-carbon
• GitHub Check: build-product (4, group4)

🔇 Additional comments (4)

components/apimgt/org.wso2.carbon.apimgt.gateway/src/main/java/org/wso2/carbon/apimgt/gateway/handlers/WebsocketUtil.java (3)

26-26: Added import for StringUtils.

The import is necessary for using StringUtils.contains() method in the new tenant domain validation logic.

---

268-272: Improved user identification for multi-tenant environments.

This change ensures consistent user identification by always appending the tenant domain to the username if it's missing. This is important for blocking conditions that need to be checked against the fully qualified username.

This approach aligns the WebSocket flow with the REST API flow, ensuring that blocking conditions are consistently applied across both flows.

---

279-280: Updated isRequestBlocked call to use the properly formatted username.

The method now uses the properly formatted username (with tenant domain) when checking if the request should be blocked.

components/apimgt/org.wso2.carbon.apimgt.gateway/src/main/java/org/wso2/carbon/apimgt/gateway/inbound/websocket/Authentication/OAuthAuthenticator.java (1)

197-200: Added null check for end user name.

This change ensures that the end user name is never null by setting it to APIConstants.END_USER_ANONYMOUS when needed. This is important for client credentials flow where no end user might be present.

This modification prevents potential NullPointerExceptions in downstream code that expects a non-null username, including the WebsocketUtil.validateDenyPolicies method.

✨ 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.