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

Allow non-URL-safe characters in email addresses #22

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

Conversation

livan2r
Copy link

@livan2r livan2r commented Nov 18, 2024

Fix redirection error when impersonating a tenant with an email containing non-URL-safe characters, such as the + sign used in emails like [email protected]

Summary by CodeRabbit

  • Bug Fixes
    • Improved the login functionality by ensuring email addresses are properly encoded in the redirect URL, preventing potential issues with special characters.

…n used in emails like [email protected]

Fix redirection error when impersonating a tenant with an email containing non-URL-safe characters
Allow non-URL-safe characters in email addresses
Copy link

coderabbitai bot commented Nov 18, 2024

Walkthrough

The changes in this pull request involve a modification to the TenantResource class, specifically the 'login' action. The update ensures that the email parameter is URL-encoded using urlencode() when generating a redirect URL after impersonating a tenant. This adjustment addresses potential issues with special characters in email addresses while preserving the existing structure and functionality of the class.

Changes

File Change Summary
src/Filament/Resources/TenantResource.php Modified the 'login' action to use urlencode() for the email parameter in the redirect URL.

Poem

In the land of code, where bunnies hop,
A change was made, and we won't stop!
Encoding emails, so sweet and bright,
No more worries, everything's right!
With a hop and a skip, we celebrate,
A smoother login, oh, isn't it great? 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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 resolve resolve all the CodeRabbit review comments.
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
src/Filament/Resources/TenantResource.php (1)

142-144: Consider improving URL construction robustness.

While the current implementation works, consider these improvements for better maintainability and reliability:

  1. Use Laravel's URL builder instead of string concatenation
  2. Add null check for domains array access
  3. Consider centralizing the URL construction logic

Here's a suggested refactor:

- return redirect()->to(request()->getScheme()."://".$record->domains[0]->domain.'.'. config('filament-tenancy.central_domain') . '/login/url?token='.$token->token .'&email='. urlencode($record->email));
+ $domain = $record->domains->first()?->domain ?? throw new \RuntimeException('Tenant has no domain');
+ return redirect()->to(
+     URL::format(
+         '%s://%s.%s/login/url',
+         request()->getScheme(),
+         $domain,
+         config('filament-tenancy.central_domain')
+     ) . '?' . http_build_query([
+         'token' => $token->token,
+         'email' => $record->email,
+     ])
+ );
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between adda44b and 45abc8c.

📒 Files selected for processing (1)
  • src/Filament/Resources/TenantResource.php (1 hunks)
🔇 Additional comments (1)
src/Filament/Resources/TenantResource.php (1)

141-144: Verify security measures for impersonation.

The impersonation feature has good security controls but consider these additional safeguards:

  1. Add explicit token expiration time
  2. Consider rate limiting impersonation attempts
  3. Add audit logging for impersonation events

Let's check for existing security measures:

#!/bin/bash
# Description: Verify security measures around impersonation

# Check for rate limiting implementations
rg -g '*.php' "throttle|RateLimiter" 

# Look for audit logging implementations
rg -g '*.php' "activity|audit|log" 

# Check token expiration settings
rg -g '*.php' "impersonate.*expire|expire.*token"

@@ -140,7 +140,7 @@ public static function table(Table $table): Table
->action(function ($record){
$token = tenancy()->impersonate($record, 1, '/app', 'web');

return redirect()->to(request()->getScheme()."://".$record->domains[0]->domain.'.'. config('filament-tenancy.central_domain') . '/login/url?token='.$token->token .'&email='. $record->email);
return redirect()->to(request()->getScheme()."://".$record->domains[0]->domain.'.'. config('filament-tenancy.central_domain') . '/login/url?token='.$token->token .'&email='. urlencode($record->email));
Copy link

Choose a reason for hiding this comment

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

💡 Codebase verification

Similar email parameters in other files need URL encoding

The verification revealed three other files with the same URL construction pattern that don't URL encode the email parameter:

  • src/Livewire/RegisterOtp.php
  • src/Livewire/RegisterDemo.php
  • src/Http/Controllers/AuthController.php

These locations should also apply urlencode() to the email parameter to maintain consistency and prevent potential issues with special characters.

🔗 Analysis chain

LGTM! URL encoding fix properly handles special characters.

The addition of urlencode() correctly addresses the issue with non-URL-safe characters in email addresses during tenant impersonation.

Let's verify the complete URL handling:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for other potential URL encoding issues in the codebase
# Look for direct email concatenation in URLs that might need encoding

# Search for URL patterns with potential email concatenation
rg -g '*.php' "(\?|&)email=[^&'\"]+" 

# Search for other URL parameters that might need encoding
rg -g '*.php' "->to\([^)]+\+" 

Length of output: 9523


Script:

#!/bin/bash
# Let's try a more specific search for URL construction patterns
# Search for URL construction with email parameters
rg -g '*.php' -A 2 -B 2 'login/url\?.*email'

# Search for similar redirect patterns in the codebase
rg -g '*.php' -A 2 -B 2 'redirect\(\)->to\(.*token.*email'

Length of output: 4085

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant