Repository navigation
RI-8400 Validate profiler log file ids - #6591
Open
pawelangelow wants to merge 1 commit into
Open
pawelangelow wants to merge 1 commit into
pawelangelow wants to merge 1 commit into
Conversation
The profiler used the client supplied log file id as a file name inside the temp directory without checking it. Accept only letters, digits, underscores and dashes (up to 128 characters), which covers the ids the UI generates, and refuse anything else before the profiler client is registered. References: #RI-8400
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The profiler turns the log file id it receives into a file name. This restricts the id to letters, digits,
_and-(up to 128 characters), which covers the ids the UI generates (_redis_<uuid>), and rejects anything else. The check lives inLogFile, so every caller goes through it, and it also runs before the profiler client is registered, so a rejected request leaves no half-created client behind.Testing
LogFile(rejected and accepted ids, file stays inside the temp directory) and for the client provider (rejected before registering the client)._redis_<uuid>format.Refs #RI-8400
Note
Medium Risk
Changes input validation on a filesystem path derived from user-supplied ids, which closes a path-traversal class of issues but could reject previously tolerated id formats if any clients sent them.
Overview
Adds strict validation for profiler
logFileIdvalues because they are used directly as file names under the temp directory. The API now accepts only 1–128 characters matching^[A-Za-z0-9_-]+$, which matches UI-generated ids like_redis_<uuid>and rejects path segments (..,/,\), empty strings, and overlong ids.Validation is centralized in
LogFile.assertValidId(called from theLogFileconstructor) andProfilerClientProvider.getOrCreateClientruns the same check before registering a profiler client or callingLogFileProvider.getOrCreate, so invalid ids returnBadRequestExceptionwith the newPROFILER_INVALID_LOG_FILE_IDmessage without leaving a partial client.Tests cover refused/accepted id shapes in unit specs, provider behavior on unsafe ids, and a monitor WebSocket integration case that confirms directory-escape ids are rejected and no file is written outside
tmpDir. The concurrent monitor test now uses the real_redis_${uuid}id format.Reviewed by Cursor Bugbot for commit 6f07542. Bugbot is set up for automated code reviews on this repo. Configure here.