Skip to content

Conversation

@nsavinda
Copy link
Member

@nsavinda nsavinda commented Feb 4, 2025

Relate #15

Summary by CodeRabbit

  • New Features
    • Improved file request handling by automatically decoding percent-encoded URL characters.
    • Enhanced error responses: Users now receive a "Bad Request" alert when an invalid URL is encountered.

@coderabbitai
Copy link

coderabbitai bot commented Feb 4, 2025

Walkthrough

The changes add URL percent-decoding functionality in the file handling process. The net/url package is imported, and within the fileHandler function, the URL path (after stripping the "/files" prefix) is decoded using url.PathUnescape. If the decoding fails, the function now returns a 400 Bad Request response with the message "Invalid URL". There were no changes to any exported or public entities.

Changes

File Description
servefiles/main.go Added import for net/url. Updated fileHandler to decode percent-encoded URL paths and added error handling to return HTTP 400 on failure.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant FH as fileHandler
    participant U as url.PathUnescape

    C->>FH: GET /files/...
    FH->>U: Unescape URL path
    U-->>FH: Decoded path or error
    alt Decoding successful
        FH->>C: Serve corresponding file
    else Decoding error
        FH-->>C: Return HTTP 400 "Invalid URL"
    end
Loading

Poem

I'm a coding bunny on the hop,
Decoding paths with a clever swap.
Carrots of code unwrapped with care,
No errors allowed, just clean air.
Hopping smoothly through every file—
A rabbit's smile makes it all worthwhile!
🥕🐇

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@nsavinda
Copy link
Member Author

nsavinda commented Feb 4, 2025

close #15

@nsavinda nsavinda merged commit 05c50a0 into main Feb 4, 2025
1 of 2 checks passed
@nsavinda nsavinda deleted the fix/url branch February 4, 2025 11:53
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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9b21707 and efd2698.

📒 Files selected for processing (1)
  • servefiles/main.go (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build
🔇 Additional comments (1)
servefiles/main.go (1)

10-10: LGTM!

The addition of the net/url package is appropriate for implementing URL decoding functionality.

Comment on lines +66 to +71
// Decode percent-encoded characters
path, err := url.PathUnescape(path)
if err != nil {
http.Error(w, "Invalid URL", http.StatusBadRequest)
return
}
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Add path sanitization to prevent directory traversal.

While the URL decoding is implemented correctly, the decoded path needs to be sanitized before use to prevent potential directory traversal attacks.

Apply this diff to add path sanitization:

 	// Decode percent-encoded characters
 	path, err := url.PathUnescape(path)
 	if err != nil {
-		http.Error(w, "Invalid URL", http.StatusBadRequest)
+		http.Error(w, "Invalid URL encoding", http.StatusBadRequest)
 		return
 	}
+	// Clean the path to prevent directory traversal
+	path = filepath.Clean(path)
+	if strings.HasPrefix(path, "..") {
+		http.Error(w, "Invalid path", http.StatusBadRequest)
+		return
+	}

Don't forget to add the required import:

+	"strings"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// Decode percent-encoded characters
path, err := url.PathUnescape(path)
if err != nil {
http.Error(w, "Invalid URL", http.StatusBadRequest)
return
}
// Decode percent-encoded characters
path, err := url.PathUnescape(path)
if err != nil {
http.Error(w, "Invalid URL encoding", http.StatusBadRequest)
return
}
// Clean the path to prevent directory traversal
path = filepath.Clean(path)
if strings.HasPrefix(path, "..") {
http.Error(w, "Invalid path", http.StatusBadRequest)
return
}

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.

2 participants