Skip to content

fix(plugin): run the CLI on a safe sys.path and write temp files without following symlinks - #261

Open
Kevin Veen-Birkenbach (kevinveenbirkenbach) wants to merge 1 commit into
microsoft:mainfrom
kevinveenbirkenbach:fix/260-safe-path-and-tmp-symlink
Open

Kevin Veen-Birkenbach (kevinveenbirkenbach) wants to merge 1 commit into
microsoft:mainfrom
kevinveenbirkenbach:fix/260-safe-path-and-tmp-symlink

Conversation

@kevinveenbirkenbach

Copy link
Copy Markdown

Summary

Plugin hooks run outside the coding agent's sandbox, while the agent, or a cloned
repository, may write the repository itself. Three paths let content placed in the
repository act with the plugin's rights. This change closes them.

Fixes #260

Issue 1: the background te imports modules from the repository

LiveContext.spawn started python -m tokeneconomizer.plugin.cli with
cwd=self.repo.root. With -m, Python puts the working directory first on
sys.path, so a tokeneconomizer/ package or a module such as json.py in the
repository root was imported in place of the plugin's own code. Inherited
PYTHONPATH elements that are empty, . or relative do the same, and they also
let a repository sitecustomize.py run at interpreter startup. Session folds, the
loop-guard judge, pending applies and the repository map all take this path.

Fix: the child now starts as python -E -s -X utf8 -c <bootstrap> <core> ....

  • -E ignores every PYTHON* variable, so an inherited PYTHONPATH no longer
    matters. UTF-8 mode, which came from PYTHONUTF8, now comes from -X utf8.
  • -s skips the user site.
  • The bootstrap drops the empty entry that -c adds. It then puts the plugin's own
    directory, passed as the first argument, in front of sys.path, before anything
    else is imported, and starts the CLI through runpy.run_module.

The working directory stays the repository root, so the CLI behaves as before.
PYTHONPATH and PYTHONUTF8 stay in the environment for the processes te
starts, as before. -P or PYTHONSAFEPATH alone would cover only Python 3.11 and
later, and neither ignores PYTHONPATH.

Issue 2: the aider probe imports aider from the repository

repomap._has_aider ran python -c "import aider.repomap" with no cwd. The
background te repomap refresh runs in the repository, so an aider/ package
there was imported and run. The probe now runs in a fresh empty temporary
directory. -I was not used because it would also hide an aider installed in the
user site.

Issue 3: settings writes and reads follow a symlink

write_json and _write_text in denylist.py opened <path>.te.tmp with
open(tmp, "w"). _guard_target checks only the final path, so a symlink placed
at .claude/settings.local.json.te.tmp sent the write to its target, for example
the user-wide ~/.claude/settings.json. With toolprune=auto this happens
without any user action.

Fix:

  • A new helper _open_tmp removes any entry at the temporary name, then creates
    the file with O_CREAT | O_EXCL | O_NOFOLLOW (O_BINARY where defined, so
    newline handling matches open(..., "w")).
  • A new helper _read_text reads the settings file with O_NOFOLLOW. A file that
    is swapped for a link after _guard_target checked it is refused instead of
    read and written back. _read_settings and both Codex config reads use it.

Tests

The new tests are in tests/test_live_safety.py:

  • test_a_symlink_at_the_temporary_name_is_not_written_through[write_json|_write_text]:
    the symlink's target stays unchanged, the settings file is written, and no
    temporary entry is left behind.
  • test_a_settings_file_swapped_for_a_symlink_after_the_guard_is_not_read.
  • test_the_background_te_imports_nothing_the_repository_carries, run with no
    PYTHONPATH, with a PYTHONPATH that has an empty element, and with
    PYTHONPATH=.. It places json.py, runpy.py, sitecustomize.py and a
    tokeneconomizer/ package in the repository, runs the exact command line
    spawn builds, from the repository, and checks that none of them ran.
  • test_the_aider_probe_imports_no_aider_the_repository_carries.

Results on Python 3.14 (python -I -m pytest):

File Result
tests/test_live_safety.py 16 passed
tests/test_live_hooks.py 97 passed, 2 skipped
tests/test_live_repomap.py 7 passed, 1 skipped
tests/test_microskills_forget.py 12 passed

Negative controls:

  • On unpatched main, every new test fails.
  • On a first version of this fix, which only dropped the empty sys.path entry,
    the PYTHONPATH cases, the aider probe and the swapped-file read fail.

I could not run a Python 3.10 interpreter locally. -E, -s, -X utf8 and the
bootstrap all exist in 3.10, and the 3.10 jobs of the CI matrix are the check
there.

Not addressed

  • Directory swap race: _guard_target resolves the settings directory
    (.claude, .codex, .github) before the write. A concurrent swap of that
    directory for a symlink between the check and os.replace would still carry
    the write elsewhere. Closing it needs directory-relative opens and renames
    (dir_fd), which Windows lacks, so it is left for a separate change.
  • .git/info/exclude: _exclude_from_git checks for symlinks and then
    appends, which leaves the same kind of window.

🤖 Generated with Claude Code

…out following symlinks

The background te ran as python -m with the repository as cwd, so a json.py, runpy.py, sitecustomize.py or tokeneconomizer/ in the checkout, or an inherited PYTHONPATH with an empty, . or relative element, ran with the plugin's rights outside the agent's sandbox. It now starts as python -E -s -X utf8 -c with a bootstrap that puts the plugin's own directory first and drops the empty entry; the aider probe runs in an empty temp dir. write_json and _write_text create their temp file with O_CREAT|O_EXCL|O_NOFOLLOW after removing any stale entry, and settings files are read with O_NOFOLLOW, so a symlink planted at the temp or settings name no longer redirects the write or the read. Regression tests in tests/test_live_safety.py fail without the fix.

Fixes microsoft#260

🎯 Fix: 90 %
💥 Break: 5 %
💸 Tokens: –
⏱️ Velocity: –
🛡️ Security: 100 %
🏆 Score: 86
🚦 Gate: ✅ 90/5, tokens and velocity <= 100, security 100 %

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@SakshamUboweja

Copy link
Copy Markdown
Collaborator

Kevin Veen-Birkenbach (@kevinveenbirkenbach) please sign the CLA.

@kevinveenbirkenbach

Copy link
Copy Markdown
Author

@microsoft-github-policy-service agree [company="Kevin Veen-Birkenbach"]
@microsoft-github-policy-service agree
@microsoft-github-policy-service agree company="Microsoft"

@kevinveenbirkenbach

Copy link
Copy Markdown
Author

@microsoft-github-policy-service agree

@microsoft-github-policy-service

Copy link
Copy Markdown

Kevin Veen-Birkenbach (@kevinveenbirkenbach) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@kevinveenbirkenbach

Copy link
Copy Markdown
Author

@microsoft-github-policy-service agree

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.

TokenEconomizer: repository-planted code runs in the plugin process; tmp writes follow symlinks

2 participants