mirror of
https://github.com/CopilotKit/CopilotKit.git
synced 2026-09-14 16:26:20 +08:00
914dbc5855
bearer_for ended with a blanket `rescue StandardError => nil` plus `return nil if status >= 400`. Now that bearer_for ALWAYS performs the /token exchange (even when a token is present), that swallow masked real failures: a non-2xx /token response, a malformed JSON body, or a transport error all collapsed to nil, after which manifest_exists issued the manifest HEAD anonymously (no Authorization). That silently violated manifest_exists's documented raise-on-transport/5xx contract and conflated "no token supplied" with "supplied token failed to exchange". bearer_for now: - raises GHCR::Error on a >=400 /token response WHEN a token was supplied (token absent still returns nil — the legitimate anonymous-public fallback); - raises GHCR::Error on JSON::ParserError for an unparseable 200 body; - no longer swallows StandardError, so transport exceptions (Errno::ECONNREFUSED, Net::ReadTimeout, ...) propagate. Call-site enumeration (bearer_for is called only by manifest_exists and resolve_digest): - manifest_exists: documents "Raises GHCR::Error on 5xx or transport failure", so a raised exchange error is consistent with — and strengthens — its own contract. Assumption holds. - resolve_digest: already raises GHCR::Error on its own manifest HEAD >=400 and does not rescue bearer_for, so a raised exchange error propagates exactly as its other failures do. Assumption holds. Neither caller is broken by bearer_for raising; both already propagate GHCR::Error to their callers. Tests: add 3 red-green cases in test_ghcr_bearer.rb (token-present 401 raises; token-present malformed body raises; token-present exchange failure issues NO anonymous manifest HEAD). The existing manifest_exists/digest fakes were only green because the old swallow masked the fake's "no fake response" error — they never modeled the mandatory /token exchange; added a successful /token fake to each so they exercise the real path. Renumbered the snapshot-ivar-lint allowlist (+13 lines) to track the bin/railway line drift.
124 lines
5.7 KiB
Ruby
124 lines
5.7 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require_relative "spec_helper"
|
|
|
|
# Proves bearer_for ALWAYS performs the GHCR /token exchange instead of
|
|
# returning a raw GitHub token. GHCR's OCI manifest endpoint rejects a raw
|
|
# GitHub Actions token with HTTP 403 — only a bearer minted via the /token
|
|
# exchange is accepted. When a token is present the exchange MUST authenticate
|
|
# with Basic auth (base64("x-access-token:<token>")); for public packages the
|
|
# exchange also succeeds anonymously.
|
|
class GHCRBearerTest < Minitest::Test
|
|
# Recording fake HTTP layer: captures every (method, url, headers) call so
|
|
# tests can assert what was actually sent on the wire.
|
|
class RecordingHTTP
|
|
attr_reader :calls
|
|
|
|
def initialize(responses)
|
|
@responses = responses
|
|
@calls = []
|
|
end
|
|
|
|
def call(method:, url:, headers: {})
|
|
@calls << { method: method, url: url, headers: headers }
|
|
r = @responses[[method, url]] || @responses[url]
|
|
raise "no fake response for #{[method, url].inspect}" unless r
|
|
r
|
|
end
|
|
end
|
|
|
|
DIGEST = "sha256:cafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00d"
|
|
REF = "ghcr.io/copilotkit/showcase-shell@#{DIGEST}"
|
|
MANIFEST = "https://ghcr.io/v2/copilotkit/showcase-shell/manifests/#{DIGEST}"
|
|
TOKEN_URL = "https://ghcr.io/token?service=ghcr.io&scope=repository:copilotkit/showcase-shell:pull"
|
|
RAW_TOKEN = "ghs_rawGitHubActionsToken"
|
|
MINTED = "minted-bearer-from-exchange"
|
|
|
|
def fakes(extra = {})
|
|
RecordingHTTP.new({
|
|
TOKEN_URL => { status: 200, headers: {}, body: %({"token":"#{MINTED}"}) },
|
|
MANIFEST => { status: 200, headers: {}, body: "" },
|
|
}.merge(extra))
|
|
end
|
|
|
|
def test_token_present_performs_basic_auth_exchange
|
|
http = fakes
|
|
g = Railway::GHCR.new(token: RAW_TOKEN, http: http)
|
|
assert_equal :exists, g.manifest_exists(REF)
|
|
|
|
token_call = http.calls.find { |c| c[:method] == :get && c[:url] == TOKEN_URL }
|
|
refute_nil token_call, "bearer_for must hit the GHCR /token exchange even when a token is present"
|
|
|
|
expected_basic = "Basic " + ["x-access-token:#{RAW_TOKEN}"].pack("m0")
|
|
auth = token_call[:headers]["Authorization"]
|
|
assert_equal expected_basic, auth,
|
|
"token exchange must authenticate with Basic base64(x-access-token:<token>)"
|
|
end
|
|
|
|
def test_manifest_read_uses_minted_bearer_not_raw_token
|
|
http = fakes
|
|
g = Railway::GHCR.new(token: RAW_TOKEN, http: http)
|
|
g.manifest_exists(REF)
|
|
|
|
manifest_call = http.calls.find { |c| c[:method] == :head && c[:url] == MANIFEST }
|
|
refute_nil manifest_call
|
|
assert_equal "Bearer #{MINTED}", manifest_call[:headers]["Authorization"],
|
|
"manifest read must use the minted bearer, never the raw GitHub token"
|
|
refute_equal "Bearer #{RAW_TOKEN}", manifest_call[:headers]["Authorization"],
|
|
"sending the raw GitHub token as a Bearer is exactly the bug that 403s"
|
|
end
|
|
|
|
def test_anonymous_exchange_still_works_for_public_packages
|
|
# No token: the exchange must still run, anonymously (no Authorization
|
|
# header on the /token request), and the minted token used downstream.
|
|
http = fakes
|
|
g = Railway::GHCR.new(token: nil, http: http)
|
|
assert_equal :exists, g.manifest_exists(REF)
|
|
|
|
token_call = http.calls.find { |c| c[:method] == :get && c[:url] == TOKEN_URL }
|
|
refute_nil token_call, "anonymous path must still mint a bearer via /token"
|
|
assert_nil token_call[:headers]["Authorization"],
|
|
"anonymous exchange must not send an Authorization header"
|
|
|
|
manifest_call = http.calls.find { |c| c[:method] == :head && c[:url] == MANIFEST }
|
|
assert_equal "Bearer #{MINTED}", manifest_call[:headers]["Authorization"]
|
|
end
|
|
|
|
# When a token WAS supplied and the /token exchange returns a non-2xx,
|
|
# that is a real failure (bad/insufficient token), NOT a license to fall
|
|
# back to an anonymous manifest read. bearer_for must RAISE GHCR::Error so
|
|
# manifest_exists's documented raise-on-failure contract holds.
|
|
def test_token_present_exchange_401_raises
|
|
http = fakes(TOKEN_URL => { status: 401, headers: {}, body: "unauthorized" })
|
|
g = Railway::GHCR.new(token: RAW_TOKEN, http: http)
|
|
|
|
err = assert_raises(Railway::GHCR::Error) { g.manifest_exists(REF) }
|
|
assert_match(/token exchange failed/i, err.message)
|
|
end
|
|
|
|
# A 200 with a body that is not parseable JSON is a broken exchange, not a
|
|
# usable bearer. bearer_for must RAISE rather than swallow JSON::ParserError.
|
|
def test_token_present_malformed_body_raises
|
|
http = fakes(TOKEN_URL => { status: 200, headers: {}, body: "<html>not json</html>" })
|
|
g = Railway::GHCR.new(token: RAW_TOKEN, http: http)
|
|
|
|
err = assert_raises(Railway::GHCR::Error) { g.manifest_exists(REF) }
|
|
assert_match(/unparseable/i, err.message)
|
|
end
|
|
|
|
# Regression guard: when a token was supplied and the exchange failed, the
|
|
# manifest HEAD must NEVER be sent — and certainly never anonymously. The
|
|
# old swallow-to-nil behavior issued an anonymous HEAD, conflating "no
|
|
# token" with "supplied token failed to exchange".
|
|
def test_token_present_exchange_failure_never_does_anonymous_manifest_read
|
|
http = fakes(TOKEN_URL => { status: 403, headers: {}, body: "forbidden" })
|
|
g = Railway::GHCR.new(token: RAW_TOKEN, http: http)
|
|
|
|
assert_raises(Railway::GHCR::Error) { g.manifest_exists(REF) }
|
|
|
|
manifest_call = http.calls.find { |c| c[:method] == :head && c[:url] == MANIFEST }
|
|
assert_nil manifest_call,
|
|
"no manifest HEAD must be issued when a supplied token fails the /token exchange"
|
|
end
|
|
end
|