fix: switch REST client auth to x-api-key header - #78
Closed
jscaltreto wants to merge 3 commits into
Closed
Conversation
QuickNode's API no longer accepts Authorization: Bearer tokens; it now requires the API key via the x-api-key header. The streams client already used this header correctly; align the main REST client to match. Also update ErrorResponse.Error from *string to json.RawMessage so non-200 error bodies (where "error" is an object, not a string) unmarshal cleanly and surface the real API message in diagnostics.
Upgrade dependencies to address CVEs surfaced by Trivy: - golang.org/x/net v0.55.0 → v0.56.0 (CVE-2026-46600) - golang.org/x/text v0.37.0 → v0.40.0 (CVE-2026-56852) - golang.org/x/crypto v0.52.0 → v0.54.0 (latest) - google.golang.org/grpc v1.79.3 → v1.82.1 (GHSA-hrxh-6v49-42gf) - github.com/oapi-codegen/oapi-codegen/v2 v2.4.1 → v2.7.1 (GHSA-rjwr-m7qx-3fjr) Add .trivyignore for GO-2026-5932 (golang.org/x/crypto/openpgp is unmaintained by design, no fixed version exists, and no package in our dependency tree imports it — it is flagged at the module level).
oapi-codegen/runtime v1.1.1 is missing StyleParamWithOptions and StyleParamOptions introduced in newer codegen output. Bump to v1.6.0 to match the v2.7.1 codegen upgrade. Regenerated api/quicknode/quicknode.gen.go and api/streams/streams.gen.go via make generate. Changes are additive: typed context keys for auth scopes and Valid() methods on all enum types.
Contributor
Author
|
Closing in favor of #79 |
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
1 participant
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
QuickNode's REST API no longer accepts
Authorization: Bearertokens — it now requires the API key via thex-api-keyheader. This causedterraform planto fail with a401 Unauthorizedduring provider configuration even when supplying a valid API key. This PR aligns the main REST client with the streams client, which was already usingx-api-keycorrectly.Also bumps several dependencies to address CVEs surfaced by the Trivy scan, and updates the generated API clients to match.
Detail
Auth fix:
internal/provider/provider.go: Replacedsecurityprovider.NewSecurityProviderBearerTokenwith an inlineRequestEditorFnthat setsx-api-key: <apiKey>on each request, matching the pattern already used for the streams client. Removed the now-unusedsecurityproviderimport.internal/utils/error.go: ChangedErrorResponse.Errorfrom*stringtojson.RawMessage. QuickNode returnserroras a JSON object (not a string) in non-200 responses, causing a silent unmarshal failure that swallowed the real API error message and replaced it with a misleading internal warning.Dependency upgrades:
golang.org/x/netv0.55.0 → v0.56.0 (CVE-2026-46600)golang.org/x/textv0.37.0 → v0.40.0 (CVE-2026-56852)golang.org/x/cryptov0.52.0 → v0.54.0 (latest)google.golang.org/grpcv1.79.3 → v1.82.1 (GHSA-hrxh-6v49-42gf)github.com/oapi-codegen/oapi-codegen/v2v2.4.1 → v2.7.1 (GHSA-rjwr-m7qx-3fjr)github.com/oapi-codegen/runtimev1.1.1 → v1.6.0 (required by regenerated code from v2.7.1 codegen).trivyignorefor GO-2026-5932 (golang.org/x/crypto/openpgpis unmaintained by design, has no fixed version, and is not imported by any package in our dependency tree — Trivy flags it at the module level)..licenseignoreentry forgo.yaml.in/yaml/v3(Apache-2.0 AND MIT dual-license; both are acceptable).Regenerated API clients (
api/quicknode/quicknode.gen.go,api/streams/streams.gen.go): changes are additive only — typed context keys for auth scopes andValid()methods on all enum types.Testing
Verified locally using
dev_overrideswith a valid QuickNode API key. Prior to this change,terraform planfailed with401 Unauthorizedand a JSON unmarshal warning. After this change, the provider configures successfully and plans complete.Trivy scan passes locally with 0 findings after the dependency upgrades. All unit tests pass.
Documentation
No documentation changes required.