Files
gohoarder/pkg/proxy/pypi/pypi_test.go
T
lukaszraczylo 171386f7a7 fix: remediate severity-ordered review findings across cache, scanners, and proxies
- H2: gormstore soft-delete + storage_key UNIQUE collision; re-save after eviction succeeds
- H1: cache getOrFetch cache-hit branch no longer runs CheckVulnerabilities on metadata entries
- M2: cache store() streams upstream body to temp file + SHA256 instead of double-buffering
- H3/L3: FetchResult/FetchFunc plumbing (+RequiresAuth/AuthProvider); proxy closures adapted;
        goproxy strips git+ prefix from UpstreamURL
- H4: scanner normalizes bypass package names; CheckVulnerabilities builds normalized packageKey
- M4: requireAdmin routes through extractAPIKey -> ValidateAPIKey -> admin role check
- M5: network client keeps only final RecordFailure (one count per attempt cycle)
- M3: normalizeOriginHost + buildCheckOrigin rewrite; origin_test.go added
- M1: app lifecycle cancel func; Run -> Shutdown on listen error (sole cache owner); JoinHostPort
- M6: VulnerabilityThresholds defaults all -1 so BlockOnSeverity governs
- L4: metadata.NormalizeSeverity at 4 severity-count sites (MEDIUM->MODERATE consistency)
- L1: handleDeleteBypass uses structured *errors.Error + ErrCodeNotFound
- L2: pypi extractVersionFromFilename (wheel/2nd segment, non-wheel/last digit segment);
      cacheVersion uses full unique basename; regression tests added
- L5: document per-instance ValidationCache key scoping; rename packageURL param to resource

All: go build ./... && go vet ./... && go test ./... pass; golangci-lint clean.
2026-09-04 14:24:13 +01:00

210 lines
7.2 KiB
Go

package pypi
import (
"net/http"
"net/http/httptest"
"net/url"
"strings"
"testing"
"github.com/lukaszraczylo/gohoarder/pkg/auth"
)
func TestIsAllowedPyPIHost(t *testing.T) {
tests := []struct {
name string
host string
allowed []string
want bool
}{
{"pypi.org allowed", "pypi.org", defaultAllowedPyPIHosts, true},
{"files.pythonhosted.org allowed", "files.pythonhosted.org", defaultAllowedPyPIHosts, true},
{"subdomain of pythonhosted.org allowed", "cdn.pythonhosted.org", defaultAllowedPyPIHosts, true},
{"case insensitive", "PyPI.ORG", defaultAllowedPyPIHosts, true},
{"with port", "pypi.org:443", defaultAllowedPyPIHosts, true},
{"AWS metadata blocked", "169.254.169.254", defaultAllowedPyPIHosts, false},
{"GCP metadata blocked", "metadata.google.internal", defaultAllowedPyPIHosts, false},
{"localhost blocked", "localhost", defaultAllowedPyPIHosts, false},
{"loopback blocked", "127.0.0.1", defaultAllowedPyPIHosts, false},
{"private RFC1918 blocked", "10.0.0.1", defaultAllowedPyPIHosts, false},
{"attacker domain blocked", "evil.example.com", defaultAllowedPyPIHosts, false},
{"empty host blocked", "", defaultAllowedPyPIHosts, false},
{"trailing-substring attack blocked", "evilpythonhosted.org", defaultAllowedPyPIHosts, false},
{"prefix attack blocked", "pypi.org.evil.com", defaultAllowedPyPIHosts, false},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := isAllowedPyPIHost(tt.host, tt.allowed)
if got != tt.want {
t.Errorf("isAllowedPyPIHost(%q) = %v, want %v", tt.host, got, tt.want)
}
})
}
}
// newHandlerForSSRFTest builds a Handler with only the fields needed to reach
// the SSRF guard. cache is nil intentionally — the guard rejects before any
// cache call.
func newHandlerForSSRFTest() *Handler {
return &Handler{
credExtractor: auth.NewCredentialExtractor(),
credHasher: auth.NewCredentialHasher(),
upstream: "https://pypi.org/simple",
allowedHosts: defaultAllowedPyPIHosts,
}
}
func TestHandlePackageFile_SSRFRejected(t *testing.T) {
tests := []struct {
name string
originalURL string
}{
{"AWS metadata IP", "http://169.254.169.254/"},
{"GCP metadata host", "http://metadata.google.internal/computeMetadata/v1/"},
{"localhost", "http://localhost:8080/secret"},
{"private network", "http://10.0.0.5/"},
{"file scheme", "file:///etc/passwd"},
{"gopher scheme", "gopher://internal/"},
{"unrelated public host", "https://evil.example.com/payload.whl"},
}
h := newHandlerForSSRFTest()
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
path := "/example/example-1.0.0.whl"
q := url.Values{}
q.Set("original_url", tt.originalURL)
req := httptest.NewRequest(http.MethodGet, path+"?"+q.Encode(), nil)
w := httptest.NewRecorder()
h.handlePackageFile(req.Context(), w, req, path)
if w.Code != http.StatusBadRequest {
t.Errorf("expected 400 for SSRF target %q, got %d (body=%q)", tt.originalURL, w.Code, w.Body.String())
}
})
}
}
func TestHandlePackageFile_AllowedHostNotRejected(t *testing.T) {
// Sanity check: an allowlisted host should NOT be rejected at the SSRF
// guard. We don't have a real cache so the call will fail later with a
// non-400 status — that's fine, we only assert the SSRF guard didn't
// fire.
h := newHandlerForSSRFTest()
path := "/example/example-1.0.0.whl"
q := url.Values{}
q.Set("original_url", "https://files.pythonhosted.org/packages/abc/example-1.0.0.whl")
req := httptest.NewRequest(http.MethodGet, path+"?"+q.Encode(), nil)
w := httptest.NewRecorder()
defer func() {
// nil cache will panic when reached — recover and treat as "guard
// did not block", which is the property we care about.
_ = recover()
}()
h.handlePackageFile(req.Context(), w, req, path)
if w.Code == http.StatusBadRequest {
t.Errorf("allowlisted host wrongly rejected with 400: %s", w.Body.String())
}
}
func TestRewritePackagePageURLs_QueryEscape(t *testing.T) {
// Original URL contains characters that strings.ReplaceAll(&,=) would miss:
// '?', '#', '+'. Verify url.QueryEscape handles them.
html := `<a href="https://files.pythonhosted.org/packages/x/y+z/foo-1.0.whl?token=abc#frag">link</a>`
out := rewritePackagePageURLs(html, "foo", "http://proxy/pypi")
// '+' must be encoded (otherwise PyPI would interpret as space)
if !contains(out, "original_url=https%3A%2F%2Ffiles.pythonhosted.org%2Fpackages%2Fx%2Fy%2Bz%2Ffoo-1.0.whl%3Ftoken%3Dabc%23frag") {
t.Errorf("expected fully URL-encoded original_url, got: %s", out)
}
}
func contains(s, sub string) bool {
return len(s) >= len(sub) && (indexOf(s, sub) >= 0)
}
func indexOf(s, sub string) int {
for i := 0; i+len(sub) <= len(s); i++ {
if s[i:i+len(sub)] == sub {
return i
}
}
return -1
}
func TestExtractPackageFileInfo(t *testing.T) {
tests := []struct {
name string
path string
wantName string
wantVer string
}{
{"numpy wheel", "/numpy/numpy-1.26.0rc1-cp312-cp312-manylinux.whl", "numpy", "1.26.0rc1"},
{"underscore wheel name", "/typing_extensions/typing_extensions-4.8.0-py3-none-any.whl", "typing_extensions", "4.8.0"},
{"hyphenated sdist", "/my-pkg/my-pkg-2.0.1.tar.gz", "my-pkg", "2.0.1"},
{"hyphen name underscore file", "/typed-ast/typed_ast-1.5.4.tar.gz", "typed-ast", "1.5.4"},
{"digit-embedded name", "/2captcha/2captcha-1.0.0.tar.gz", "2captcha", "1.0.0"},
{"digit intermediate segment", "/foo/foo-2019bar-1.0.zip", "foo", "1.0"},
{"egg file", "/foo/foo-1.0.egg", "foo", "1.0"},
{"metadata file", "/foo/foo-1.0.metadata", "foo", "1.0"},
{"no version", "/foo", "foo", "foo"},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
gotName, gotVer := extractPackageFileInfo(tt.path)
if gotName != tt.wantName {
t.Errorf("extractPackageFileInfo(%q) name = %q, want %q", tt.path, gotName, tt.wantName)
}
if gotVer != tt.wantVer {
t.Errorf("extractPackageFileInfo(%q) version = %q, want %q", tt.path, gotVer, tt.wantVer)
}
})
}
}
// TestCacheVersionUniquePerArtifact asserts that distinct PyPI artifacts of
// the same logical version produce distinct cache keys, and that the bare
// version returned for logging stays stable.
func TestCacheVersionUniquePerArtifact(t *testing.T) {
// Three wheels of the same version differing only in build/tag, plus a
// .zip and a .metadata file for the same version. The cache key uses the
// full unique basename, so keys must all differ; the extracted version
// must remain the bare stable version for logging/bypass logic.
paths := []string{
"/foo/foo-1.0.0-cp312-cp312-manylinux.whl",
"/foo/foo-1.0.0-cp311-cp311-manylinux.whl",
"/foo/foo-1.0.0-py3-none-any.whl",
"/foo/foo-1.0.0.zip",
"/foo/foo-1.0.0.metadata",
}
seenKeys := make(map[string]bool)
for _, path := range paths {
_, ver := extractPackageFileInfo(path)
if ver != "1.0.0" {
t.Errorf("extractPackageFileInfo(%q) version = %q, want stable %q", path, ver, "1.0.0")
}
filename := path
if i := strings.LastIndex(filename, "/"); i >= 0 {
filename = filename[i+1:]
}
if seenKeys[filename] {
t.Errorf("cache key %q duplicated across artifacts", filename)
}
seenKeys[filename] = true
}
if len(seenKeys) != len(paths) {
t.Errorf("expected %d distinct cache keys, got %d", len(paths), len(seenKeys))
}
}