Repository navigation
fix(adb): reject unsafe host file names when pulling one device file - #1962
Merged
Merged
Conversation
pull_adb_file derived its host file name from the last path segment of a caller-supplied device path and joined it to the output directory without checking that the name is usable on the host. A device path ending in a separator, a dot segment, a control character, a Windows reserved device name, a trailing dot or space, or a ':' alternate-data-stream marker could resolve to an unexpected host path or fail opaquely after the transfer. The single-file path now derives the name with POSIX semantics and refuses any non-portable segment as invalid_request before creating a directory or running adb pull. This matches the package path's pending host-name policy and never renames a device-reported file.
Codex Review SummaryThis 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. |
3 tasks done
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.
Summary
pull_adb_fileis the one ADB pull that takes a caller-supplied device path instead of enumerating one frompm path, and it built the host file name from the last/-separated segment of that path and joined it straight to the output directory. Nothing checked that the resulting name can actually be stored and addressed on the host, so a device path whose final segment is a Windows reserved device name, ends in a dot or space, carries a:alternate-data-stream marker, holds a control character, or is a./..segment either fails opaquely after the transfer or lands under a host name that differs from thefile_nameandlocal_paththe result records.This change derives the host name with POSIX semantics and refuses any non-portable segment as a caller input error before REA creates a directory or runs
adb pull. REA never renames a device-reported file; a name it cannot store portably is refused, not adjusted.Problem and expected behavior
The smallest trigger is a single-file pull whose
device_pathends in a name the host cannot keep./data/local/tmp/report.and/data/local/tmp/reportlose the trailing character on Windows, so the file on disk no longer matches thelocal_pathREA returns./data/local/tmp/CONand/data/local/tmp/nul.txtname Win32 devices on Windows, not files./data/local/tmp/report:2024becomes an NTFS alternate data stream./data/local/tmp/a\band a control-character name produce a file name that is not portable or not printable./data/local/tmp/..resolves to the output directory's parent.The violated invariant is that REA writes a pulled file only inside the output directory the caller selected, under a name the caller can read back and match against the recorded evidence. On the base revision these paths are not refused up front: the pull proceeds to
adb pull, and the outcome depends on the host and the device.The new behavior is a refusal. The provider derives the host name from the device path, and when the name is not portable it returns an input error before any filesystem or process effect. The refusal names the device path and the exact reason, and no output directory is created.
Change and scope
src/adb/AdbHostFileName.tsaddsadbHostFileName(devicePath), which returns either the accepted name or a reason. It takes the last segment withposix.basename, because the device path is a POSIX path on the device filesystem and the hostbasenamewould disagree between POSIX and Windows hosts. A name is accepted only when every supported host can store and address it: no/or\, no control character (\p{Cc}), no:, none of* ? " < > |, not a Windows reserved basename (CON,PRN,AUX,NUL,COM1-COM9,LPT1-LPT9, with or without an extension), no trailing dot or space, and not.or...src/adb/AdbProvider.tscalls that helper at the top ofpullFileand, on refusal, returns anAnalysisInputErrorcarrying aninvalid_valueissue ondevice_path. Because the check runs beforeprepareOutputDirectory, a refused pull creates no host directory and starts no process. The existingbasenameimport is dropped, and the derived name replaces the inline derivation.docs/adb-device-analysis.mdrecords the rule next to the existing "device paths are not host paths" note.Not included:
pull_adb_packagekeeps its own host-name policy, the device-path schema is unchanged, andpush_adb_file,capture_adb_screen, andcollect_adb_bugreportare untouched because they use fixed or caller-selected local paths rather than a device-derived name.Contract and boundary impact
invalid_requestprojection and theAnalysisInputErrorissue shape.notes.txt,app.db,My Notes.txt,split_config.arm64_v8a.apk) pull exactly as before on every host. The new rule only removes names that were already unreliable on at least one supported host.file_nameandlocal_pathcannot silently diverge from what is on disk. A refusal keeps the raw device path and the reason in the issue.adb pulland creates no directory, so there is nothing to clean up. A successful pull is unchanged.Evidence and regression coverage
src/adb/AdbHostFileName.test.tsis a new module test with 23 cases: seven portable device paths accepted with their exact last segment, and sixteen unsafe paths refused with their exact reason.src/adb/AdbProvider.test.tsgains a table-driven provider test over five representative unsafe paths. It asserts the projectedinvalid_requestcode, thedevice_pathissue with the matching reason, and that neither the adb stub marker nor the output directory exists afterward, which proves noadb pullran.Base reproduction: on the base revision the five unsafe paths are not refused; the pull reaches
adb pulland the result depends on the host, which the provider test shows by the stub marker being written. After the change the same five are refused before the stub is reached. The parser-level policy is covered directly, so the boundary is proven without a device.Remaining proof gaps: no real Android device or emulator was used, and the specific Windows-host failure for a reserved name is not reproduced against a real transfer.
Validation performed
Executed on a Windows 11 host, with the POSIX-only provider tests run under WSL Ubuntu (Node 22.22.2) because
src/adb/AdbProvider.test.tsskips on Windows:npm run test:local -- src/adb/AdbHostFileName.test.ts src/adb/AdbProvider.test.ts— 65 tests passed.vitest run src/adb— 4 files, 83 tests passed.vitest run tests/boundary/cli/adbCli.test.ts— 28 tests passed.vitest run --project adapters— 155 files, 1685 tests passed.tsc --noEmit— clean.oxlinton the changed files — 0 errors.oxfmt --checkon the changed files — clean.npm run verify:module-boundaries— 1525 source files checked, passed.npm run verify:test-discovery— all 866 test files discovered exactly once.npm run docs:check— six tasks passed.Compatibility, safety, and release
Breaking changes or migration steps: none for well-formed device paths. A caller that today passes a non-portable device path will now get a clear
invalid_requestinstead of an opaque transfer failure or a mismatched host name, which is the intended correction.Real Hopper/Ghidra, browser, or OS coverage: none required. This is the ADB adapter over a controlled stub; no licensed engine or real device is involved.
Package or release metadata impact: none.
Security, privacy, process, or containment review: the device path is caller-supplied, and the host file name stays inside the caller's chosen output directory, so this is a portability and provenance correctness fix rather than a boundary escalation. It closes the class of names that could land under an unexpected host path or diverge from the recorded evidence. No authentication, authorization, or logging behavior changes.
Review checklist
type(scope): outcome.