Skip to content

Fix/allow ip headers #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TymekGluch merged 2 commits into from
Nov 8, 2026
Merged

Fix/allow ip headers #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d66e65c
fix: Allow ip headers
TymekGluch Nov 8, 2026
2ee730d
chore: Update tag
TymekGluch Nov 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/api-service/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import (
)

// @title TrustPkg API
// @version 2.0.0
// @version 2.0.1
// @description API for searching npm packages and their vulnerability data.
// @BasePath /api
// @schemes http https
Expand Down
12 changes: 12 additions & 0 deletions internal/packages-api/headers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,22 @@ var allowedSearchHeaders = map[string]struct{}{
"upgrade-insecure-requests": {},
"user-agent": {},
"cf-connecting-ip": {},
"cf-connecting-ipv6": {},
"cf-pseudo-ipv4": {},
"cf-ipcountry": {},
"cf-ray": {},
"cf-visitor": {},
"cdn-loop": {},
"forwarded": {},
"true-client-ip": {},
"x-client-ip": {},
"x-cluster-client-ip": {},
"x-forwarded-for": {},
"x-forwarded-host": {},
"x-forwarded-port": {},
"x-forwarded-proto": {},
"x-original-forwarded-for": {},
"x-real-ip": {},
}

var developmentSearchHeaders = map[string]struct{}{
Expand Down
32 changes: 32 additions & 0 deletions internal/packages-api/headers_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,35 @@ func TestIsAllowedSearchHeaderAcceptsStandardHeaders(t *testing.T) {
t.Fatal("expected standard Accept header to be allowed")
}
}

func TestIsAllowedSearchHeaderAcceptsProxyIPHeaders(t *testing.T) {
t.Setenv("ENVIRONMENT", "production")
for _, header := range []string{
"Forwarded",
"True-Client-IP",
"X-Client-IP",
"X-Cluster-Client-IP",
"X-Forwarded-For",
"X-Forwarded-Host",
"X-Forwarded-Port",
"X-Forwarded-Proto",
"X-Original-Forwarded-For",
"X-Real-IP",
"CF-Connecting-IP",
"CF-Connecting-IPv6",
"CF-Pseudo-IPv4",
"CF-IPCountry",
"CF-Ray",
"CF-Visitor",
"CDN-Loop",
} {
t.Run(header, func(t *testing.T) {
if !isAllowedSearchHeader(header) {
t.Fatalf("expected %s header to be allowed", header)
}
})
}
if isAllowedSearchHeader("X-Unrecognized-Header") {
t.Fatal("expected unrecognized header to be rejected")
}
}
Loading