Stricter checks for explicit local mag paths

[fm3]

There are some changes coming up for explicit mag paths, as we want to get rid of symlinks wherever we can, and move more datasets to the cloud. Then this code may change again. However I think it makes sense to be strict about explicit mag paths already now.

--

• Removed dev-only changes like prints and application.conf edits
• Considered common edge cases
• Needs datastore update after deployment

[coderabbitai]

Note

Reviews paused

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

📝 Walkthrough

Walkthrough

The changes update the DataSourceService class by modifying the validateDataSource method to accept an additional organizationDir parameter. This enables a new validation step that ensures explicit mag paths are either remote or contained within the specified organization directory. The updateDataSource method is also updated to compute and pass the appropriate directory to the validation method. These changes introduce a path containment check to enhance security for mag path handling.

Changes

File(s)	Change Summary
webknossos-datastore/app/com/scalableminds/webknossos/datastore/services/DataSourceService.scala	Updated validateDataSource to accept organizationDir and added a helper for mag path validation. Modified updateDataSource to compute and pass the directory, and wrapped its body in braces.

Suggested labels

backend

Suggested reviewers

• frcroth

Poem

A rabbit hopped through code so neat,
Checking paths where data meet.
Now mag paths stay where they belong,
Secure and safe, both right and strong.
With every hop, the checks are tight—
Organization’s path is locked up right!
🐇✨

---

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

[fm3]

@coderabbitai pause

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

webknossos-datastore/app/com/scalableminds/webknossos/datastore/services/DataSourceService.scala (1)

225-233: New validation helper improves security

This helper function effectively prevents directory traversal by ensuring explicit mag paths stay within the organization directory or are remote URIs.

Consider these minor improvements:

1. The function name pathOk is very generic - a more descriptive name like isValidMagPath would better communicate its purpose
2. The return statement could be simplified:

- if (path.startsWith(allowedParent)) true else false
+ path.startsWith(allowedParent)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cbe28a0 and 41d9252.

📒 Files selected for processing (1)

• webknossos-datastore/app/com/scalableminds/webknossos/datastore/services/DataSourceService.scala (4 hunks)

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

• GitHub Check: frontend-tests
• GitHub Check: backend-tests
• GitHub Check: build-smoketest-push

🔇 Additional comments (4)

webknossos-datastore/app/com/scalableminds/webknossos/datastore/services/DataSourceService.scala (4)

215-215: Signature update to enhance validation

The method signature now accepts an organizationDir parameter, which is essential for validating that mag paths remain within allowed boundaries.

---

256-259: Strong security enhancement for mag path validation

This validation check is crucial for preventing directory traversal attacks by ensuring all explicit mag paths either use remote storage or stay within the organization's directory.

---

269-272: Improved method organization

Computing paths upfront improves readability and makes the code easier to understand.

---

273-273: Updated validation call with security parameter

The validation call now correctly passes the organization directory, enabling path containment checks.

[coderabbitai]

✅ Actions performed

Reviews paused.