Skip to content

fix(git-env): skip the HTTP header probe for non-HTTP effective URLs - #2906

Draft
Arnaud (arnaudoisel) wants to merge 2 commits into
microsoft:mainfrom
arnaudoisel:fix/insteadof-urlmatch-probe
Draft

fix(git-env): skip the HTTP header probe for non-HTTP effective URLs#2906
Arnaud (arnaudoisel) wants to merge 2 commits into
microsoft:mainfrom
arnaudoisel:fix/insteadof-urlmatch-probe

Conversation

@arnaudoisel

Copy link
Copy Markdown

Description

Since 0.30.0, apm install cannot download a private Git dependency when the user's Git config holds an insteadOf rule that rewrites the fetched URL to SSH:

url."git@github.com:".insteadOf = https://github.com/

The install fails with Unable to verify Git URL rewrite safety (Git URL-match probe failed) and tells the user to remove a legitimate, very common rule.

Root cause. _validated_git_url_rewrite_policy resolves the rewrite, then asks _has_applicable_http_authorization whether an HTTP extraHeader applies to the effective URL. On the authenticated retry APM has injected http.extraheader = Authorization: ... in the command scope, so the header group is non-empty and _urlmatched_header_group runs:

git config --null --get-urlmatch http.extraHeader git@github.com:owner/repo

Git rejects SCP-style syntax there with fatal: invalid URL scheme name or missing '://' suffix and exit status 128 -- neither 0 nor 1 -- so the probe raises GitUrlRewriteProbeError. Measured with git 2.55.0 and an injected GIT_CONFIG_KEY_0=http.extraheader:

URL passed to --get-urlmatch exit status
https://github.com/o/r 0
ssh://git@github.com/o/r 0
git@github.com:o/r 128

That explains the three conditions needed to trigger it: only the authenticated retry (a public dependency never injects a header), only a rule that matches the fetched URL, and only when something must actually be downloaded.

Fix. An HTTP header can never reach a non-HTTP transport, so the answer is already known without asking Git. _has_applicable_http_authorization now returns False for any effective URL that is not HTTP(S), before spawning the probe. The single guard covers both callers, including GitConfigInsteadOfResolver.resolve in deps/transport_selection.py. _build_git_auth_fence already had the equivalent scheme guard.

The credential-origin rules in validate_resolved_git_url_rewrite only apply to http/https targets, so no rewrite that was rejected before is accepted now. Cross-host, HTTPS-downgrade, remote-helper and credential-bearing rewrites are all still rejected, as their existing tests confirm.

Secondary: the remaining non-zero branch of the probe now names the exit status instead of only saying the probe failed, so a genuine failure is diagnosable. No raw Git output is rendered.

Fixes #2898

Type of change

  • Bug fix
  • New feature
  • Documentation
  • Maintenance / refactor

Testing

  • Tested locally
  • All existing tests pass
  • Added tests for new functionality (if applicable)

Two regression tests in tests/unit/cache/test_git_env.py, both under the existing windows_compat marker:

  • test_clone_allows_scp_ssh_rewrite_while_a_header_is_injected drives clone_git_worktree through the real git config with an Authorization header and url.git@git.example.com:.insteadOf. On main it fails with the exact error from the issue; with the fix the clone proceeds.
  • test_scp_ssh_url_reports_no_http_authorization_without_probing_git asserts the probe subprocess is never spawned for an SCP-style URL.

Verified green: tests/unit/cache/test_git_env.py (87), plus test_git_transport_policy.py, test_transport_selection.py, test_public_github_anonymous_first.py, test_validation_strict_transport.py, test_proxy_compat.py (244 total). ruff check and ruff format --check clean on the changed files, and lint_architecture_boundaries.py passes.

Also reproduced end to end on Windows 11 with git 2.55.0 and the rule set globally: installing a private dependency with an empty cache logs the probe failure on 0.30.0 and no longer does with this change.

Spec conformance (OpenAPM v0.1)

  • N/A -- this PR does not change OpenAPM-observable behaviour.

An `insteadOf` rule that rewrites the fetched HTTPS URL to SSH, such as
`url."git@github.com:".insteadOf = https://github.com/`, made every private
dependency download fail on the authenticated retry.

`_validated_git_url_rewrite_policy` asked whether an HTTP `extraHeader`
applied to the effective URL. With an SCP-style target that probe ran
`git config --get-urlmatch http.extraHeader git@github.com:owner/repo`,
which git rejects with `invalid URL scheme name or missing '://' suffix`
and exit status 128, so the probe raised `GitUrlRewriteProbeError`.

An HTTP header can never reach a non-HTTP transport, so the answer is
already known: report no authorization and do not spawn the probe. The
remaining non-zero branch now names the exit status instead of only
saying the probe failed.

Fixes microsoft#2898
@microsoft-github-policy-service

Copy link
Copy Markdown

Arnaud (@arnaudoisel) 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.

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.

[BUG] insteadOf rewrite matching the fetched URL blocks private installs since 0.30.0

1 participant