🔒 [security fix] Fix Path Traversal in Document Provider

[Asutorufa]

This PR fixes a path traversal vulnerability in YuhaiinDocumentProvider.

🎯 What: The vulnerability fixed is a path traversal in the Document Provider.
⚠️ Risk: Without this fix, an attacker or a malicious app could potentially access or delete sensitive files outside of the intended directory by providing a manipulated docId containing .. or absolute paths.
🛡️ Solution: The fix introduces a secure isChild helper that uses canonicalPath to resolve all path components and ensures that the requested file is strictly within the allowed baseDir. It also correctly handles directory boundary checks to prevent partial name match attacks.

A new unit test PathTraversalTest.kt was added to verify the fix.

---

PR created automatically by Jules for task 16491326315817938800 started by @Asutorufa

[google-labs-jules]

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.

---

For security, I will only act on instructions from the user who triggered this task.

[gemini-code-assist]

Summary of Changes

Hello @Asutorufa, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request delivers a critical security enhancement by resolving a path traversal vulnerability within the YuhaiinDocumentProvider. The core of the solution involves a new, robust path validation mechanism that ensures all file access requests are strictly confined to their intended directories, thereby safeguarding against malicious file system manipulation.

Highlights

• Security Vulnerability Fix: Addressed a path traversal vulnerability in YuhaiinDocumentProvider that could allow access or deletion of sensitive files outside intended directories.
• Secure Path Validation: Implemented a new isChild helper function that uses canonicalPath to robustly verify if a file is strictly within a base directory, preventing .. and partial name match attacks.
• Unit Testing: Introduced PathTraversalTest.kt with comprehensive unit tests to validate the isChild function's effectiveness against various path traversal exploits.

Changelog

• app/src/main/kotlin/io/github/asutorufa/yuhaiin/docuemntprovider/YuhaiinDocumentProvider.kt
  • Refactored isChildDocument to delegate path validation to a new isChild helper function.
  • Introduced internal fun isChild(parent: File, child: File): Boolean which uses canonicalPath to prevent path traversal and partial name matching.
  • Replaced the startsWith check with the new isChild function in querySearchDocuments for secure directory traversal.
  • Added a security check using isChild in getFileForDocId to throw FileNotFoundException for invalid document IDs that attempt to access files outside the base directory.
• app/src/test/kotlin/io/github/asutorufa/yuhaiin/docuemntprovider/PathTraversalTest.kt
  • Added a new test file PathTraversalTest.kt.
  • Implemented testIsChild to thoroughly test the isChild function, covering cases like valid children, non-children, .. traversal attempts, and partial name matches.

Activity

• The pull request was automatically created by Jules for a task started by @Asutorufa.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request effectively addresses a critical path traversal vulnerability in YuhaiinDocumentProvider. The introduction of the isChild helper function, which uses canonical paths for validation, is a robust solution that correctly centralizes the security check. The changes applied in isChildDocument, querySearchDocuments, and getFileForDocId properly utilize this new helper to secure all relevant file access points. The addition of PathTraversalTest.kt is excellent, providing thorough test coverage for the fix, including edge cases like path traversal attempts and partial name matches. I've suggested a minor improvement to the test file to ensure resource cleanup is always performed, making the tests even more robust.