mirror of
https://github.com/git-pkgs/proxy.git
synced 2026-09-16 15:52:05 -04:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5e88758852 |
178 changed files with 3800 additions and 25450 deletions
41
.github/workflows/ci.yml
vendored
41
.github/workflows/ci.yml
vendored
|
|
@ -13,17 +13,18 @@ jobs:
|
|||
strategy:
|
||||
matrix:
|
||||
os: [ubuntu-latest, macos-latest, windows-latest]
|
||||
go-version: ['1.25']
|
||||
runs-on: ${{ matrix.os }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
|
||||
uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6.4.0
|
||||
with:
|
||||
go-version-file: go.mod
|
||||
go-version: ${{ matrix.go-version }}
|
||||
|
||||
- name: Build
|
||||
run: go build -v ./...
|
||||
|
|
@ -34,42 +35,14 @@ jobs:
|
|||
lint:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
|
||||
uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6.4.0
|
||||
with:
|
||||
go-version-file: go.mod
|
||||
go-version: '1.25'
|
||||
|
||||
- name: golangci-lint
|
||||
run: go tool golangci-lint run ./...
|
||||
|
||||
helm:
|
||||
name: Helm chart
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- uses: azure/setup-helm@9bc31f4ebc9c6b171d7bfbaa5d006ae7abdb4310 # v5.0.1
|
||||
with:
|
||||
version: v3.18.6
|
||||
|
||||
- name: Lint chart
|
||||
run: helm lint deploy/charts/proxy
|
||||
|
||||
- name: Render chart variants
|
||||
run: |
|
||||
set -euo pipefail
|
||||
helm template proxy deploy/charts/proxy >/dev/null
|
||||
helm template proxy deploy/charts/proxy \
|
||||
--set persistence.enabled=false \
|
||||
--set config.existingConfigMap=proxy-config \
|
||||
--set ingress.enabled=true \
|
||||
--set 'ingress.hosts[0].host=proxy.example.com' \
|
||||
--set 'ingress.hosts[0].paths[0].path=/' \
|
||||
--set 'ingress.hosts[0].paths[0].pathType=Prefix' \
|
||||
>/dev/null
|
||||
|
|
|
|||
123
.github/workflows/publish.yml
vendored
123
.github/workflows/publish.yml
vendored
|
|
@ -18,23 +18,14 @@ jobs:
|
|||
permissions:
|
||||
packages: write
|
||||
contents: read
|
||||
id-token: write
|
||||
steps:
|
||||
- name: Check out the repo
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
|
||||
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Set up QEMU
|
||||
uses: docker/setup-qemu-action@1f40c72289eff860ee54a304f1438e3cff362e0a # v4.3.0
|
||||
with:
|
||||
platforms: linux/amd64,linux/arm64
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@37fe631027851001ddb9b187196cc803df7f5f0e # v4.3.0
|
||||
|
||||
- name: Log in to the Container registry
|
||||
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f
|
||||
uses: docker/login-action@4907a6ddec9925e35a0a9e82d7399ccc52663121
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.actor }}
|
||||
|
|
@ -42,120 +33,14 @@ jobs:
|
|||
|
||||
- name: Extract metadata (tags, labels) for Docker
|
||||
id: meta
|
||||
uses: docker/metadata-action@dc802804100637a589fabce1cb79ff13a1411302
|
||||
uses: docker/metadata-action@030e881283bb7a6894de51c315a6bfe6a94e05cf
|
||||
with:
|
||||
images: ghcr.io/${{ github.repository }}
|
||||
|
||||
- uses: sigstore/cosign-installer@6f9f17788090df1f26f669e9d70d6ae9567deba6 # v4.1.2
|
||||
|
||||
- name: Build and push Docker image
|
||||
id: build
|
||||
uses: docker/build-push-action@53b7df96c91f9c12dcc8a07bcb9ccacbed38856a
|
||||
uses: docker/build-push-action@bcafcacb16a39f128d818304e6c9c0c18556b85f
|
||||
with:
|
||||
context: .
|
||||
platforms: linux/amd64,linux/arm64
|
||||
push: true
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
provenance: mode=max
|
||||
sbom: true
|
||||
|
||||
- name: Sign image by digest
|
||||
env:
|
||||
DIGEST: ${{ steps.build.outputs.digest }}
|
||||
IMAGE: ghcr.io/${{ github.repository }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
[[ "$DIGEST" =~ ^sha256:[0-9a-f]{64}$ ]]
|
||||
cosign sign --yes "${IMAGE}@${DIGEST}"
|
||||
|
||||
- name: Verify BuildKit attestations and extract SPDX predicates
|
||||
env:
|
||||
DIGEST: ${{ steps.build.outputs.digest }}
|
||||
IMAGE: ghcr.io/${{ github.repository }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
reference="${IMAGE}@${DIGEST}"
|
||||
docker buildx imagetools inspect "$reference" --format '{{ json .Provenance }}' > provenance.json
|
||||
docker buildx imagetools inspect "$reference" --format '{{ json .SBOM }}' > sbom.json
|
||||
|
||||
for platform in linux/amd64 linux/arm64; do
|
||||
jq -e --arg p "$platform" '.[$p].SLSA | type == "object" and length > 0' \
|
||||
provenance.json >/dev/null
|
||||
jq -e --arg p "$platform" '.[$p].SPDX' sbom.json > "sbom-${platform//\//-}.spdx.json"
|
||||
done
|
||||
|
||||
- name: Attest platform SBOMs by digest
|
||||
env:
|
||||
DIGEST: ${{ steps.build.outputs.digest }}
|
||||
IMAGE: ghcr.io/${{ github.repository }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
[[ "$DIGEST" =~ ^sha256:[0-9a-f]{64}$ ]]
|
||||
reference="${IMAGE}@${DIGEST}"
|
||||
for predicate in sbom-linux-amd64.spdx.json sbom-linux-arm64.spdx.json; do
|
||||
cosign attest --yes --type spdxjson --predicate "$predicate" "$reference"
|
||||
done
|
||||
|
||||
publish_chart:
|
||||
name: Push Helm chart to GHCR
|
||||
if: github.ref_type == 'tag'
|
||||
needs: push_to_registry
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
steps:
|
||||
- name: Check out the repo
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
|
||||
with:
|
||||
persist-credentials: false
|
||||
ref: ${{ github.sha }}
|
||||
|
||||
- uses: azure/setup-helm@9bc31f4ebc9c6b171d7bfbaa5d006ae7abdb4310 # v5.0.1
|
||||
with:
|
||||
version: v3.18.6
|
||||
|
||||
- name: Validate and normalize release version
|
||||
id: version
|
||||
env:
|
||||
TAG: ${{ github.ref_name }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
semver='^v(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-((0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*)(\.(0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*))*))?$'
|
||||
[[ "$TAG" =~ $semver ]] || {
|
||||
echo "Tag must be strict SemVer of the form vMAJOR.MINOR.PATCH[-PRERELEASE]: $TAG" >&2
|
||||
exit 1
|
||||
}
|
||||
version="${TAG#v}"
|
||||
[[ "$version" != "0.0.0" ]] || {
|
||||
echo "0.0.0 is a development placeholder and must not be published" >&2
|
||||
exit 1
|
||||
}
|
||||
echo "version=$version" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Log in to GHCR
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: printf '%s' "$GH_TOKEN" | helm registry login ghcr.io --username "$GITHUB_ACTOR" --password-stdin
|
||||
|
||||
- name: Lint and package chart
|
||||
env:
|
||||
VERSION: ${{ steps.version.outputs.version }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
helm lint deploy/charts/proxy
|
||||
mkdir -p build
|
||||
helm package \
|
||||
--destination build \
|
||||
--version "$VERSION" \
|
||||
--app-version "$VERSION" \
|
||||
deploy/charts/proxy
|
||||
metadata="$(helm show chart "build/proxy-${VERSION}.tgz")"
|
||||
[[ "$(awk '$1 == "version:" {print $2}' <<<"$metadata")" == "$VERSION" ]]
|
||||
[[ "$(awk '$1 == "appVersion:" {gsub(/\"/, "", $2); print $2}' <<<"$metadata")" == "$VERSION" ]]
|
||||
|
||||
- name: Push chart
|
||||
env:
|
||||
VERSION: ${{ steps.version.outputs.version }}
|
||||
run: helm push "build/proxy-${VERSION}.tgz" oci://ghcr.io/git-pkgs/charts
|
||||
|
|
|
|||
8
.github/workflows/release.yml
vendored
8
.github/workflows/release.yml
vendored
|
|
@ -14,20 +14,20 @@ jobs:
|
|||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
persist-credentials: false
|
||||
|
||||
- uses: sigstore/cosign-installer@6f9f17788090df1f26f669e9d70d6ae9567deba6 # v4.1.2
|
||||
- uses: sigstore/cosign-installer@cad07c2e89fa2edd6e2d7bab4c1aa38e53f76003 # v4.1.1
|
||||
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
|
||||
uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6.4.0
|
||||
with:
|
||||
go-version-file: go.mod
|
||||
cache: false
|
||||
|
||||
- uses: goreleaser/goreleaser-action@f06c13b6b1a9625abc9e6e439d9c05a8f2190e94 # v7.2.3
|
||||
- uses: goreleaser/goreleaser-action@e24998b8b67b290c2fa8b7c14fcfa7de2c5c9b8c # v7.1.0
|
||||
with:
|
||||
version: "~> v2"
|
||||
args: release --clean
|
||||
|
|
|
|||
6
.github/workflows/swagger.yml
vendored
6
.github/workflows/swagger.yml
vendored
|
|
@ -12,14 +12,14 @@ jobs:
|
|||
swagger:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
|
||||
uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6.4.0
|
||||
with:
|
||||
go-version-file: go.mod
|
||||
go-version: '1.25'
|
||||
|
||||
- name: Install swag
|
||||
run: go install github.com/swaggo/swag/cmd/swag@latest
|
||||
|
|
|
|||
4
.github/workflows/zizmor.yml
vendored
4
.github/workflows/zizmor.yml
vendored
|
|
@ -21,9 +21,9 @@ jobs:
|
|||
security-events: write
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Run zizmor
|
||||
uses: zizmorcore/zizmor-action@70fb788f84895a7701f5643d103d587e460b5c99 # v0.6.3
|
||||
uses: zizmorcore/zizmor-action@b1d7e1fb5de872772f31590499237e7cce841e8e # v0.5.3
|
||||
|
|
|
|||
6
.gitignore
vendored
6
.gitignore
vendored
|
|
@ -4,7 +4,7 @@
|
|||
*.dll
|
||||
*.so
|
||||
*.dylib
|
||||
/proxy
|
||||
proxy
|
||||
|
||||
# Test binary, built with `go test -c`
|
||||
*.test
|
||||
|
|
@ -14,8 +14,8 @@
|
|||
coverage.html
|
||||
coverage.txt
|
||||
|
||||
# Go vendor directory (repo root only; embedded UI vendor dirs are tracked)
|
||||
/vendor/
|
||||
# Dependency directories
|
||||
vendor/
|
||||
|
||||
# Go workspace file
|
||||
go.work
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ proxy/
|
|||
│ │ └── queries.go # CRUD operations
|
||||
│ ├── storage/ # Artifact file storage
|
||||
│ │ ├── storage.go # Storage interface
|
||||
│ │ └── blob.go # gocloud.dev/blob backends (file, S3, Azure)
|
||||
│ │ └── filesystem.go # Local filesystem impl
|
||||
│ ├── upstream/ # Upstream registry clients
|
||||
│ │ ├── fetcher.go # HTTP artifact fetching
|
||||
│ │ └── resolver.go # Download URL resolution
|
||||
|
|
@ -72,7 +72,7 @@ Key types:
|
|||
|
||||
### `internal/storage`
|
||||
|
||||
Artifact file storage abstraction backed by `gocloud.dev/blob`. Supports local filesystem (`file://`), S3 (`s3://`), and Azure (`azblob://`) URLs.
|
||||
Artifact file storage abstraction. Currently implements local filesystem storage. Designed to allow future backends (S3, GCS).
|
||||
|
||||
Interface:
|
||||
```go
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
FROM --platform=$BUILDPLATFORM golang:1.26.7-alpine AS builder
|
||||
FROM golang:1.25-alpine AS builder
|
||||
|
||||
WORKDIR /src
|
||||
|
||||
|
|
@ -12,11 +12,10 @@ RUN go mod download
|
|||
# Copy source code
|
||||
COPY . .
|
||||
|
||||
# Build the binary for the target platform
|
||||
ARG TARGETARCH
|
||||
RUN CGO_ENABLED=0 GOOS=linux GOARCH=${TARGETARCH} go build -ldflags="-s -w" -o /proxy ./cmd/proxy
|
||||
# Build the binary
|
||||
RUN CGO_ENABLED=0 GOOS=linux go build -ldflags="-s -w" -o /proxy ./cmd/proxy
|
||||
|
||||
FROM alpine:3.24.1
|
||||
FROM alpine:3.21
|
||||
|
||||
RUN apk add --no-cache ca-certificates
|
||||
|
||||
|
|
|
|||
389
README.md
389
README.md
|
|
@ -20,26 +20,6 @@ A 3-day cooldown means that when `lodash` publishes version `4.18.0`, your build
|
|||
|
||||
Resolution order: package override, then ecosystem override, then global default. This lets you set a conservative default and carve out exceptions for packages where you need faster updates. See [docs/configuration.md](docs/configuration.md) for the full config reference.
|
||||
|
||||
## Artifact Scanning
|
||||
|
||||
Cooldown only looks at a version's publish timestamp — it never inspects the actual bytes. Artifact scanning closes that gap: when enabled, every artifact is staged into storage and scanned by one or more external services (trivy, ClamAV, Wiz, or anything else that speaks a small HTTP/JSON contract) before it's committed to the cache and served to clients.
|
||||
|
||||
```yaml
|
||||
scanning:
|
||||
enabled: true
|
||||
signing_key: ${PROXY_SCANNING_SIGNING_KEY}
|
||||
scanners:
|
||||
- name: clamav
|
||||
url: http://clamav-adapter:8080/scan
|
||||
mode: block # a block verdict deletes the artifact and returns 403
|
||||
- name: trivy
|
||||
url: http://trivy-adapter:8081/scan
|
||||
mode: monitor # findings are logged, never gate caching
|
||||
ecosystems: [npm, pypi]
|
||||
```
|
||||
|
||||
The proxy never uploads artifact bytes to a scanner. Each scanner is notified with package metadata plus a short-lived signed URL; the scanner pulls the bytes itself from the proxy's own storage. Scanners run concurrently, and the first `block`-mode scanner to report a verdict of not-allowed wins immediately, canceling the rest. See [docs/configuration.md](docs/configuration.md) for the full config reference and the scanner HTTP contract.
|
||||
|
||||
## Supported Registries
|
||||
|
||||
| Registry | Language/Platform | Cooldown | Completed |
|
||||
|
|
@ -58,17 +38,15 @@ The proxy never uploads artifact bytes to a scanner. Each scanner is notified wi
|
|||
| Conan | C/C++ | | ✓ |
|
||||
| Conda | Python/R | Yes | ✓ |
|
||||
| CRAN | R | | ✓ |
|
||||
| Julia | Julia | | ✓ |
|
||||
| Swift | Swift | | ✓ |
|
||||
| Container | Docker/OCI | | ✓ |
|
||||
| Homebrew | macOS/Linux | | ✓ |
|
||||
| Debian | Debian/Ubuntu | | ✓ |
|
||||
| RPM | RHEL/Fedora | | ✓ |
|
||||
| Alpine | Alpine Linux | | ✓ |
|
||||
| Alpine | Alpine Linux | | ✗ |
|
||||
| Arch | Arch Linux | | ✗ |
|
||||
| Chef | Chef | | ✗ |
|
||||
| Generic | Any | | ✓ |
|
||||
| Helm | Kubernetes | | ✓ |
|
||||
| Generic | Any | | ✗ |
|
||||
| Helm | Kubernetes | | ✗ |
|
||||
| Swift | Swift | | ✗ |
|
||||
| Vagrant | Vagrant | | ✗ |
|
||||
|
||||
Cooldown requires publish timestamps in metadata. Registries without a "Yes" in the cooldown column either don't expose timestamps or haven't been wired up yet.
|
||||
|
|
@ -83,21 +61,6 @@ brew install git-pkgs/git-pkgs/proxy
|
|||
|
||||
Or download a binary from the [releases page](https://github.com/git-pkgs/proxy/releases).
|
||||
|
||||
### Helm
|
||||
|
||||
Install the chart from GHCR, setting the public URL that package-manager clients
|
||||
will use to reach the proxy:
|
||||
|
||||
```bash
|
||||
helm install proxy oci://ghcr.io/git-pkgs/charts/proxy \
|
||||
--set config.data.base_url=https://proxy.example.com
|
||||
```
|
||||
|
||||
The default chart deploys one replica backed by a 10 GiB persistent volume,
|
||||
using SQLite and filesystem artifact storage under `/data`. See
|
||||
[`deploy/charts/proxy/values.yaml`](deploy/charts/proxy/values.yaml) for ingress,
|
||||
external database and object-storage configuration options.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
|
|
@ -193,29 +156,6 @@ export GOPROXY=http://localhost:8080/go,direct
|
|||
|
||||
Or in your shell profile for persistence.
|
||||
|
||||
### Homebrew
|
||||
|
||||
Point Homebrew's JSON API and artifact domain at the proxy:
|
||||
|
||||
```bash
|
||||
export HOMEBREW_API_DOMAIN=http://localhost:8080/homebrew
|
||||
export HOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080
|
||||
```
|
||||
|
||||
The artifact domain proxies manifests and bottle blobs under `/v2/homebrew/core/`. GHCR routing is limited to that repository. Source archives, cask application downloads, custom tap artifacts, and legacy flat-file bottle mirrors use Homebrew's normal fallback URLs. Keep fallback enabled by leaving `HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK` unset.
|
||||
|
||||
Enable `cache_metadata` or set `PROXY_CACHE_METADATA=true` to retain Homebrew JSON API responses for offline fallback. Bottle blobs and their OCI manifests are cached without this setting.
|
||||
|
||||
The upstreams default to `https://formulae.brew.sh/api` for the JSON API and `https://ghcr.io` for artifacts. To chain this proxy to another proxy, configure its Homebrew endpoints as the upstreams:
|
||||
|
||||
```yaml
|
||||
upstream:
|
||||
homebrew_api: "https://upstream-proxy.example.com/homebrew"
|
||||
homebrew_artifact: "https://upstream-proxy.example.com"
|
||||
```
|
||||
|
||||
The equivalent environment variables are `PROXY_UPSTREAM_HOMEBREW_API` and `PROXY_UPSTREAM_HOMEBREW_ARTIFACT`.
|
||||
|
||||
### Hex (Elixir)
|
||||
|
||||
Configure in `~/.hex/hex.config`:
|
||||
|
|
@ -269,18 +209,6 @@ Add to your `~/.m2/settings.xml`:
|
|||
</settings>
|
||||
```
|
||||
|
||||
The `/maven/` endpoint uses Maven Central as primary upstream and falls back to the Gradle Plugin Portal for Gradle plugin marker metadata and related artifacts when the primary upstream returns not found.
|
||||
|
||||
For Gradle plugin resolution via the same proxy endpoint:
|
||||
|
||||
```kotlin
|
||||
pluginManagement {
|
||||
repositories {
|
||||
maven(url = "http://localhost:8080/maven/")
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Gradle HTTP Build Cache
|
||||
|
||||
Configure in `settings.gradle(.kts)`:
|
||||
|
|
@ -384,40 +312,6 @@ local({
|
|||
})
|
||||
```
|
||||
|
||||
### Julia
|
||||
|
||||
Set the Pkg server before starting Julia:
|
||||
|
||||
```bash
|
||||
export JULIA_PKG_SERVER=http://localhost:8080/julia
|
||||
```
|
||||
|
||||
Or inside a running session:
|
||||
|
||||
```julia
|
||||
ENV["JULIA_PKG_SERVER"] = "http://localhost:8080/julia"
|
||||
using Pkg; Pkg.update()
|
||||
```
|
||||
|
||||
### Swift
|
||||
|
||||
Configure the proxy as the default registry for the current Swift package:
|
||||
|
||||
```bash
|
||||
swift package-registry set --allow-insecure-http http://localhost:8080/swift
|
||||
```
|
||||
|
||||
Registry dependencies use their scoped package identifier in `Package.swift`:
|
||||
|
||||
```swift
|
||||
dependencies: [
|
||||
.package(id: "apple.swift-argument-parser", from: "1.2.0")
|
||||
]
|
||||
```
|
||||
|
||||
The proxy supports dependency resolution and source downloads. Publishing with
|
||||
`swift package-registry publish` is not supported.
|
||||
|
||||
### Docker / Container Registry
|
||||
|
||||
Configure Docker to use the proxy as a registry mirror in `/etc/docker/daemon.json`:
|
||||
|
|
@ -440,39 +334,6 @@ Or pull images directly:
|
|||
docker pull localhost:8080/library/nginx:latest
|
||||
```
|
||||
|
||||
### Helm
|
||||
|
||||
Configure each HTTP chart repository with a name, then add the matching proxy
|
||||
URL to Helm:
|
||||
|
||||
```yaml
|
||||
upstream:
|
||||
helm:
|
||||
bitnami: "https://charts.bitnami.com/bitnami"
|
||||
```
|
||||
|
||||
```bash
|
||||
helm repo add bitnami http://localhost:8080/helm/bitnami
|
||||
helm repo update
|
||||
helm pull bitnami/nginx
|
||||
```
|
||||
|
||||
The proxy caches `index.yaml` using the normal metadata-cache settings and
|
||||
caches chart archives after verifying their SHA-256 digest from the index.
|
||||
|
||||
For charts stored in an OCI registry, configure a named OCI upstream and add
|
||||
the reserved `upstream/{name}` prefix to the chart reference:
|
||||
|
||||
```yaml
|
||||
upstream:
|
||||
oci:
|
||||
ghcr: "https://ghcr.io"
|
||||
```
|
||||
|
||||
```bash
|
||||
helm pull oci://localhost:8080/upstream/ghcr/owner/charts/mychart --version 1.0.0 --plain-http
|
||||
```
|
||||
|
||||
### Debian / APT
|
||||
|
||||
Configure APT to use the proxy in `/etc/apt/sources.list.d/proxy.list`:
|
||||
|
|
@ -487,13 +348,6 @@ Replace your existing sources.list entries, then:
|
|||
sudo apt update
|
||||
```
|
||||
|
||||
The upstream defaults to `http://deb.debian.org/debian`. To proxy a different APT repository (e.g. Ubuntu), set `upstream.debian` in the config file or `PROXY_UPSTREAM_DEBIAN` in the environment:
|
||||
|
||||
```yaml
|
||||
upstream:
|
||||
debian: "http://archive.ubuntu.com/ubuntu"
|
||||
```
|
||||
|
||||
### RPM / Yum / DNF
|
||||
|
||||
Configure yum/dnf to use the proxy in `/etc/yum.repos.d/proxy.repo`:
|
||||
|
|
@ -513,76 +367,9 @@ sudo dnf clean all
|
|||
sudo dnf update
|
||||
```
|
||||
|
||||
### Alpine / apk
|
||||
|
||||
Point `/etc/apk/repositories` at the proxy. The default repository name
|
||||
`alpine` proxies the official mirror (`https://dl-cdn.alpinelinux.org/alpine`):
|
||||
|
||||
```
|
||||
http://localhost:8080/apk/alpine/v3.22/main
|
||||
http://localhost:8080/apk/alpine/v3.22/community
|
||||
```
|
||||
|
||||
Then:
|
||||
|
||||
```bash
|
||||
apk update
|
||||
```
|
||||
|
||||
Repository indexes (v2 `APKINDEX.tar.gz` and v3 `Packages.adb`), detached
|
||||
signatures, and packages are served byte-for-byte unchanged, so apk's normal
|
||||
signature verification keeps working. Indexes use the metadata cache
|
||||
(`metadata_ttl`, stale fallback); `.apk` packages are stored in the shared
|
||||
artifact cache and remain available when the upstream is unreachable.
|
||||
|
||||
To proxy other mirrors or private repositories, configure named upstreams
|
||||
under `upstream.apk` (this replaces the built-in default; re-add `alpine` if
|
||||
you still want it):
|
||||
|
||||
```yaml
|
||||
upstream:
|
||||
apk:
|
||||
alpine: "https://dl-cdn.alpinelinux.org/alpine"
|
||||
private: "https://apk.example.com"
|
||||
```
|
||||
|
||||
```
|
||||
http://localhost:8080/apk/private
|
||||
```
|
||||
|
||||
apk appends the architecture and index filename to each repository line
|
||||
itself.
|
||||
|
||||
### GitHub Releases / mise (aqua backend)
|
||||
|
||||
Configure named generic upstreams:
|
||||
|
||||
```yaml
|
||||
upstream:
|
||||
generic:
|
||||
github: "https://github.com"
|
||||
github-api: "https://api.github.com"
|
||||
```
|
||||
|
||||
Then rewrite GitHub URLs in mise's settings (`~/.config/mise/config.toml`, mise ≥ 2025.9.3):
|
||||
|
||||
```toml
|
||||
[settings.url_replacements]
|
||||
"regex:^https://github\\.com/([^/]+)/([^/]+)/releases/download/(.+)" = "http://localhost:8080/generic/github/$1/$2/releases/download/$3"
|
||||
"regex:^https://api\\.github\\.com/(.*)" = "http://localhost:8080/generic/github-api/$1"
|
||||
```
|
||||
|
||||
Release assets are cached permanently after the first download and keep
|
||||
installing while GitHub is down. Tag lookups through `api.github.com` are
|
||||
cached for `metadata_ttl` and served stale during an outage or rate limit.
|
||||
Commit a `mise.lock` and install with `mise install --locked` so pinned
|
||||
installs need no API call at all. Add a bearer token for `https://api.github.com`
|
||||
under `upstream.auth` if the fleet exceeds GitHub's anonymous rate limit.
|
||||
|
||||
## Configuration
|
||||
|
||||
The proxy can be configured via:
|
||||
|
||||
1. Command line flags (highest priority)
|
||||
2. Environment variables
|
||||
3. Configuration file (YAML or JSON)
|
||||
|
|
@ -593,14 +380,13 @@ The proxy can be configured via:
|
|||
-config string Path to configuration file
|
||||
-listen string Address to listen on (default ":8080")
|
||||
-base-url string Public URL of this proxy (default "http://localhost:8080")
|
||||
-storage-url string Storage URL (file://, s3://, gs://, azblob://)
|
||||
-storage-url string Storage URL (file:// or s3://)
|
||||
-storage-path string Path to artifact storage directory (deprecated, use -storage-url)
|
||||
-database-driver string Database driver: sqlite or postgres (default "sqlite")
|
||||
-database-path string Path to SQLite database file (default "./cache/proxy.db")
|
||||
-database-url string PostgreSQL connection URL
|
||||
-log-level string Log level: debug, info, warn, error (default "info")
|
||||
-log-format string Log format: text, json (default "text")
|
||||
-access-log string Path to the JSONL access log
|
||||
-version Print version and exit
|
||||
```
|
||||
|
||||
|
|
@ -609,15 +395,12 @@ The proxy can be configured via:
|
|||
```bash
|
||||
PROXY_LISTEN=:8080
|
||||
PROXY_BASE_URL=http://localhost:8080
|
||||
PROXY_UI_URL=http://localhost:8080 # Optional; defaults to PROXY_BASE_URL
|
||||
PROXY_STORAGE_URL=file:///var/cache/proxy/artifacts
|
||||
PROXY_DATABASE_DRIVER=sqlite
|
||||
PROXY_DATABASE_PATH=./cache/proxy.db
|
||||
PROXY_DATABASE_URL=postgres://user:pass@localhost/proxy?sslmode=disable
|
||||
PROXY_LOG_LEVEL=info
|
||||
PROXY_LOG_FORMAT=text
|
||||
PROXY_ACCESS_LOG_PATH=/var/log/proxy/access.jsonl
|
||||
PROXY_UPSTREAM_SWIFT=https://tuist.dev/api/registry/swift
|
||||
```
|
||||
|
||||
### Configuration File
|
||||
|
|
@ -638,22 +421,16 @@ log:
|
|||
level: "info"
|
||||
format: "text"
|
||||
|
||||
access_log:
|
||||
path: "/var/log/proxy/access.jsonl" # Optional JSONL activity log
|
||||
|
||||
# Optional: override upstream URLs
|
||||
upstream:
|
||||
npm: "https://registry.npmjs.org"
|
||||
cargo: "https://index.crates.io"
|
||||
swift: "https://tuist.dev/api/registry/swift"
|
||||
|
||||
# Optional: version cooldown (see above)
|
||||
cooldown:
|
||||
default: "3d"
|
||||
```
|
||||
|
||||
See the [configuration reference](docs/configuration.md#upstream-registries) for every upstream key, environment variable, and default URL.
|
||||
|
||||
Run with config file:
|
||||
|
||||
```bash
|
||||
|
|
@ -697,57 +474,6 @@ storage:
|
|||
|
||||
Set credentials via standard AWS environment variables (`AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_REGION`).
|
||||
|
||||
### Google Cloud Storage
|
||||
|
||||
The proxy can store cached artifacts in a GCS bucket using the `gs://` URL scheme.
|
||||
|
||||
```yaml
|
||||
storage:
|
||||
url: "gs://my-bucket-name"
|
||||
```
|
||||
|
||||
Authentication uses [Application Default Credentials](https://docs.cloud.google.com/docs/authentication/application-default-credentials), which means no credentials need to be embedded in the config or environment. Supported sources, in order:
|
||||
|
||||
- **GKE Workload Identity** — bind the Kubernetes service account running the proxy to a Google service account that has `roles/storage.objectAdmin` on the bucket. The proxy will use the workload's token automatically.
|
||||
- **Attached service account** on GCE, Cloud Run, Cloud Functions, etc.
|
||||
- **`GOOGLE_APPLICATION_CREDENTIALS`** environment variable pointing at a service account JSON key file.
|
||||
- **`gcloud auth application-default login`** for local development.
|
||||
|
||||
#### GKE Workload Identity setup
|
||||
|
||||
```bash
|
||||
# 1. Create a Google service account
|
||||
gcloud iam service-accounts create git-pkgs-proxy \
|
||||
--project=PROJECT_ID
|
||||
|
||||
# 2. Grant it access to the bucket
|
||||
gsutil iam ch \
|
||||
serviceAccount:git-pkgs-proxy@PROJECT_ID.iam.gserviceaccount.com:objectAdmin \
|
||||
gs://my-bucket-name
|
||||
|
||||
# 3. Bind the Kubernetes service account to it
|
||||
gcloud iam service-accounts add-iam-policy-binding \
|
||||
git-pkgs-proxy@PROJECT_ID.iam.gserviceaccount.com \
|
||||
--role=roles/iam.workloadIdentityUser \
|
||||
--member="serviceAccount:PROJECT_ID.svc.id.goog[NAMESPACE/KSA_NAME]"
|
||||
|
||||
# 4. Annotate the Kubernetes service account
|
||||
kubectl annotate serviceaccount KSA_NAME \
|
||||
--namespace=NAMESPACE \
|
||||
iam.gke.io/gcp-service-account=git-pkgs-proxy@PROJECT_ID.iam.gserviceaccount.com
|
||||
```
|
||||
|
||||
#### Direct serve (signed URLs) with Workload Identity
|
||||
|
||||
When `direct_serve: true` is enabled, the proxy issues HTTP 302 redirects to presigned GCS URLs. Workload Identity provides no private key, so the GCS backend calls the [IAM Credentials `signBlob` API](https://docs.cloud.google.com/iam/docs/reference/credentials/rest/v1/projects.serviceAccounts/signBlob). Grant the service account the token-creator role on itself:
|
||||
|
||||
```bash
|
||||
gcloud iam service-accounts add-iam-policy-binding \
|
||||
git-pkgs-proxy@PROJECT_ID.iam.gserviceaccount.com \
|
||||
--role=roles/iam.serviceAccountTokenCreator \
|
||||
--member="serviceAccount:git-pkgs-proxy@PROJECT_ID.iam.gserviceaccount.com"
|
||||
```
|
||||
|
||||
## CLI Commands
|
||||
|
||||
### serve (default)
|
||||
|
|
@ -790,11 +516,6 @@ curl -X POST http://localhost:8080/api/mirror \
|
|||
-H "Content-Type: application/json" \
|
||||
-d '{"purls": ["pkg:npm/lodash@4.17.21"]}'
|
||||
|
||||
# Start a mirror job from an inline CycloneDX or SPDX JSON SBOM
|
||||
curl -X POST http://localhost:8080/api/mirror \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"sbom":{"bomFormat":"CycloneDX","components":[{"purl":"pkg:npm/lodash@4.17.21"}]}}'
|
||||
|
||||
# Check job status
|
||||
curl http://localhost:8080/api/mirror/mirror-1
|
||||
|
||||
|
|
@ -856,7 +577,7 @@ Recently cached:
|
|||
| Endpoint | Description |
|
||||
|----------|-------------|
|
||||
| `GET /` | Dashboard (web UI) |
|
||||
| `GET /health` | Health check and upstream circuit breaker state (JSON; HTTP 200 healthy, 503 unhealthy) |
|
||||
| `GET /health` | Health check (returns "ok" if healthy) |
|
||||
| `GET /stats` | Cache statistics (JSON) |
|
||||
| `GET /metrics` | Prometheus metrics |
|
||||
| `GET /npm/*` | npm registry protocol |
|
||||
|
|
@ -872,14 +593,7 @@ Recently cached:
|
|||
| `GET /conan/*` | Conan C/C++ protocol |
|
||||
| `GET /conda/*` | Conda/Anaconda protocol |
|
||||
| `GET /cran/*` | CRAN (R) protocol |
|
||||
| `GET /julia/*` | Julia Pkg server protocol |
|
||||
| `GET /swift/*` | Swift Package Registry v1 protocol |
|
||||
| `GET /helm/{repository}/*` | HTTP Helm chart repository protocol |
|
||||
| `GET /homebrew/*` | Homebrew JSON API |
|
||||
| `GET /v2/*` | OCI/Docker registry protocol |
|
||||
| `GET /v2/homebrew/core/*` | Homebrew core bottle manifests and blobs from GHCR |
|
||||
| `GET /apk/{repository}/*` | Alpine APK repository protocol |
|
||||
| `GET /generic/{name}/*` | Generic HTTP download proxy (GitHub release assets, mise/aqua) |
|
||||
| `GET /debian/*` | Debian/APT repository protocol |
|
||||
| `GET /rpm/*` | RPM/Yum repository protocol |
|
||||
|
||||
|
|
@ -887,7 +601,7 @@ Recently cached:
|
|||
|
||||
| Endpoint | Description |
|
||||
|----------|-------------|
|
||||
| `POST /api/mirror` | Start a mirror job (JSON body with `purls` or an inline `sbom`) |
|
||||
| `POST /api/mirror` | Start a mirror job (JSON body with `purls`) |
|
||||
| `GET /api/mirror/{id}` | Get job status and progress |
|
||||
| `DELETE /api/mirror/{id}` | Cancel a running job |
|
||||
|
||||
|
|
@ -1075,16 +789,16 @@ Response:
|
|||
|
||||
## Web Interface
|
||||
|
||||
The proxy serves a web UI under `/ui`. No separate frontend build is needed -- templates and assets are embedded in the binary. `GET /` redirects to `/ui/`. The UI is mounted under its own prefix so a reverse proxy can apply different access rules to it than to the package endpoints (for example, requiring auth for `PathPrefix(/ui)` while leaving `/npm`, `/pypi` etc. open to build machines).
|
||||
The proxy serves a web UI at the root URL. No separate frontend build is needed -- templates and assets are embedded in the binary.
|
||||
|
||||
- **Dashboard** (`/ui/`) -- cache stats, popular packages, recently cached artifacts, and vulnerability overview.
|
||||
- **Install guide** (`/ui/install`) -- per-ecosystem configuration instructions, so you don't have to look them up here.
|
||||
- **Package browser** (`/ui/packages`) -- browse all cached packages with filtering by ecosystem and sorting by hits, size, name, or vulnerability count.
|
||||
- **Search** (`/ui/search?q=...`) -- search cached packages by name.
|
||||
- **Package detail** (`/ui/package/{ecosystem}/{name}`) -- metadata, license, vulnerabilities, and version list for a package. You can select two versions to compare.
|
||||
- **Version detail** (`/ui/package/{ecosystem}/{name}/{version}`) -- per-version metadata, integrity hash, artifact cache status, and hit counts.
|
||||
- **Source browser** (`/ui/package/{ecosystem}/{name}/{version}/browse`) -- browse files inside cached archives with syntax highlighting for text files and image previews.
|
||||
- **Version diff** (`/ui/package/{ecosystem}/{name}/compare/{v1}...{v2}`) -- side-by-side diff of two cached versions showing added, removed, and changed files.
|
||||
- **Dashboard** (`/`) -- cache stats, popular packages, recently cached artifacts, and vulnerability overview.
|
||||
- **Install guide** (`/install`) -- per-ecosystem configuration instructions, so you don't have to look them up here.
|
||||
- **Package browser** (`/packages`) -- browse all cached packages with filtering by ecosystem and sorting by hits, size, name, or vulnerability count.
|
||||
- **Search** (`/search?q=...`) -- search cached packages by name.
|
||||
- **Package detail** (`/package/{ecosystem}/{name}`) -- metadata, license, vulnerabilities, and version list for a package. You can select two versions to compare.
|
||||
- **Version detail** (`/package/{ecosystem}/{name}/{version}`) -- per-version metadata, integrity hash, artifact cache status, and hit counts.
|
||||
- **Source browser** (`/package/{ecosystem}/{name}/{version}/browse`) -- browse files inside cached archives with syntax highlighting for text files and image previews.
|
||||
- **Version diff** (`/package/{ecosystem}/{name}/compare/{v1}...{v2}`) -- side-by-side diff of two cached versions showing added, removed, and changed files.
|
||||
|
||||
## Monitoring
|
||||
|
||||
|
|
@ -1092,8 +806,6 @@ The proxy exposes Prometheus metrics at `GET /metrics`. All metric names are pre
|
|||
|
||||
| Metric | Type | Labels | Description |
|
||||
|--------|------|--------|-------------|
|
||||
| `proxy_requests_total` | counter | `ecosystem`, `status` | Proxy responses by package ecosystem and HTTP status |
|
||||
| `proxy_request_duration_seconds` | histogram | `ecosystem`, `status` | Proxy request duration |
|
||||
| `proxy_cache_hits_total` | counter | `ecosystem` | Cache hits |
|
||||
| `proxy_cache_misses_total` | counter | `ecosystem` | Cache misses |
|
||||
| `proxy_cache_size_bytes` | gauge | | Total size of cached artifacts |
|
||||
|
|
@ -1103,43 +815,8 @@ The proxy exposes Prometheus metrics at `GET /metrics`. All metric names are pre
|
|||
| `proxy_storage_operation_duration_seconds` | histogram | `operation` | Storage read/write latency |
|
||||
| `proxy_storage_errors_total` | counter | `operation` | Storage read/write failures |
|
||||
| `proxy_active_requests` | gauge | | In-flight requests |
|
||||
| `proxy_health_probe_failures_total` | counter | `step` | Storage health probe failures by failing step (`write`, `size`, `read`, `verify`, `delete`). |
|
||||
| `proxy_circuit_breaker_state` | gauge | `registry` | Artifact-fetch circuit breaker state per upstream registry (0 closed, 2 open). Published once that registry's breaker has tripped. |
|
||||
| `proxy_circuit_breaker_trips_total` | counter | `registry` | Circuit breaker trips per upstream registry. |
|
||||
|
||||
Cache size and artifact count are refreshed every 60 seconds. Circuit breaker state is read from the fetcher on each scrape of `/metrics` and each `/health` request, so `proxy_circuit_breaker_trips_total` counts the trips visible between those reads — a breaker that opens and recovers entirely between two scrapes is not counted. The remaining metrics update on each request.
|
||||
|
||||
The breaker metrics carry one series per upstream host, but only for hosts whose breaker has tripped at least once since startup. A breaker is created per host the proxy fetches artifacts from, and for some ecosystems that host comes from upstream metadata rather than from configuration (composer takes it from a package's `dist.url`, helm from the chart URLs in `index.yaml`), so publishing every host would let upstream content grow the series count for the lifetime of the process. Once a host has tripped it keeps reporting, so a recovery still shows up as a transition to 0 rather than as a series that vanishes. `/health` is not a persistent time series and lists every breaker, tripped or not.
|
||||
|
||||
The `registry` label is the host of the URL the artifact was fetched from. Because that URL can come from upstream metadata, it is not always one a host can be read off — a signed `dist.url` that fails to parse, for instance — and such a breaker is labelled `hostless-url-<digest>` instead, where the digest is keyed by a value drawn fresh at startup. Neither `/metrics` nor `/health` requires authentication, so a fetch URL is never published as a label or a key; the digest identifies the breaker for as long as the process runs without revealing the URL behind it or letting a chosen URL be matched against it.
|
||||
|
||||
Alert on `proxy_circuit_breaker_state == 2` sustained for more than a few minutes: while a breaker is open, artifact downloads for that upstream fail with HTTP 502 on every cache miss, and only a single probe request per backoff interval reaches the upstream. Cached artifacts keep serving, and so does metadata for the same ecosystem (metadata does not go through the circuit breaker), so installs fail in a way that looks like a partial upstream outage.
|
||||
|
||||
### Health Check
|
||||
|
||||
`/health` returns a structured JSON report of subsystem health. HTTP 200 if all checks pass; 503 if any fail.
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"checks": {
|
||||
"database": {"status": "ok"},
|
||||
"storage": {"status": "ok"}
|
||||
},
|
||||
"circuit_breakers": {
|
||||
"registry.npmjs.org": "closed",
|
||||
"static.crates.io": "open"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Failing checks include an `"error"` field. Storage failures also include a `"step"` field identifying which probe step failed (`write`, `size`, `read`, `verify`, `delete`). When the database check fails, the storage entry reports `{"status": "skipped"}` so the response always carries the same key set.
|
||||
|
||||
`circuit_breakers` reports the state of each upstream's artifact-fetch circuit breaker (`"open"` or `"closed"`), keyed by upstream host — or by the `hostless-url-<digest>` placeholder described under [Monitoring](#monitoring) where the fetch URL has no host to read. The key is omitted until the proxy has fetched an artifact from at least one upstream, and a host appears only once a breaker has been created for it. Breakers trip after repeated upstream failures and retry the upstream after an exponential backoff. While one is open, artifact downloads for that host return HTTP 502 on a cache miss without contacting the upstream; already-cached artifacts are still served from storage, since the cache is checked before the fetcher. A breaker is reported as `"open"` throughout its backoff, including the half-open window in which it admits one probe request to test recovery. Breaker state is per process and in memory, so a restart clears it, but a restart is not needed for recovery: the backoff keeps retrying for as long as the breaker is open, so it closes on its own once the upstream serves again.
|
||||
|
||||
An open breaker does **not** set `status` to `"error"` or change the HTTP status code: it reports a specific upstream refusing to serve, not this proxy being unfit to receive traffic, and failing the readiness probe over one unhealthy upstream would pull the pod out of rotation for every other ecosystem too. Use `proxy_circuit_breaker_state` for alerting on it.
|
||||
|
||||
Storage probe results are cached for `health.storage_probe_interval` (default 30s) to bound the cost of probing remote backends. A probe holds an internal mutex for up to 10 seconds (the hardcoded per-probe timeout), so `/health` is intended as a Kubernetes **readiness** probe rather than a liveness probe — a slow S3 round-trip should pull the pod from rotation, not restart it.
|
||||
Cache size and artifact count are refreshed every 60 seconds. The remaining metrics update on each request.
|
||||
|
||||
Scrape config for Prometheus:
|
||||
|
||||
|
|
@ -1208,45 +885,20 @@ When running behind nginx, Apache, or another reverse proxy, set `base_url` to y
|
|||
base_url: "https://proxy.example.com"
|
||||
```
|
||||
|
||||
If the UI is reached on a different hostname than the package endpoints — for example, the UI exposed publicly on a domain while build machines hit a Docker network alias — set `ui_base_url` separately. `base_url` is the URL package managers and metadata rewriting use; `ui_base_url` is the URL advertised to humans visiting the web UI (canonical/`og:url` tags and the install guide banner):
|
||||
|
||||
```yaml
|
||||
base_url: "http://pkg-proxy:8080" # internal alias for build machines
|
||||
ui_base_url: "https://proxy.example.com/ui" # public UI URL
|
||||
```
|
||||
|
||||
When unset, `ui_base_url` defaults to `base_url`.
|
||||
|
||||
> **Warning:** the proxy serves the UI and package endpoints on the same listener. Setting `ui_base_url` only changes what URL the UI advertises to humans; it does not stop package endpoints from being reachable on the same hostname and port. When fronting the proxy with a public reverse proxy, restrict the public route to `PathPrefix(/ui)` (or your proxy's equivalent), otherwise `/npm`, `/pypi`, and the other package endpoints stay exposed alongside the UI.
|
||||
|
||||
nginx example, restricting the public host to the UI while leaving package endpoints reachable only on the internal listener:
|
||||
nginx example:
|
||||
|
||||
```nginx
|
||||
server {
|
||||
listen 443 ssl;
|
||||
server_name proxy.example.com;
|
||||
|
||||
location /ui/ {
|
||||
location / {
|
||||
proxy_pass http://127.0.0.1:8080;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_buffering off;
|
||||
}
|
||||
|
||||
location / {
|
||||
return 404;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Traefik example using `PathPrefix(/ui)` so the public router only matches UI traffic:
|
||||
|
||||
```yaml
|
||||
labels:
|
||||
traefik.enable: "true"
|
||||
traefik.http.services.pkg-proxy.loadbalancer.server.port: "8080"
|
||||
traefik.http.routers.pkg-proxy.rule: "Host(`proxy.example.com`) && PathPrefix(`/ui`)"
|
||||
traefik.http.routers.pkg-proxy.entrypoints: "websecure"
|
||||
```
|
||||
|
||||
## Cache Management
|
||||
|
|
@ -1289,8 +941,7 @@ The proxy will recreate the database on next start.
|
|||
## Building from Source
|
||||
|
||||
Requirements:
|
||||
|
||||
- Go (the project version is declared in `go.mod`)
|
||||
- Go 1.25 or later
|
||||
|
||||
```bash
|
||||
git clone https://github.com/git-pkgs/proxy.git
|
||||
|
|
|
|||
|
|
@ -40,8 +40,6 @@
|
|||
// Log level: debug, info, warn, error (default "info")
|
||||
// -log-format string
|
||||
// Log format: text, json (default "text")
|
||||
// -access-log string
|
||||
// Path to the JSONL access log (disabled by default)
|
||||
//
|
||||
// Stats Flags:
|
||||
//
|
||||
|
|
@ -74,14 +72,11 @@
|
|||
// PROXY_DATABASE_URL - PostgreSQL connection URL
|
||||
// PROXY_LOG_LEVEL - Log level
|
||||
// PROXY_LOG_FORMAT - Log format
|
||||
// PROXY_ACCESS_LOG_PATH - JSONL access log path
|
||||
// PROXY_UPSTREAM_* - Upstream URLs and network access controls
|
||||
// PROXY_GRADLE_BUILD_CACHE_READ_ONLY - Disable Gradle PUT uploads
|
||||
// PROXY_GRADLE_BUILD_CACHE_MAX_UPLOAD_SIZE - Max Gradle PUT request body size
|
||||
// PROXY_GRADLE_BUILD_CACHE_MAX_AGE - Gradle cache max age eviction
|
||||
// PROXY_GRADLE_BUILD_CACHE_MAX_SIZE - Gradle cache max total size
|
||||
// PROXY_GRADLE_BUILD_CACHE_SWEEP_INTERVAL - Gradle cache eviction sweep interval
|
||||
// PROXY_HEALTH_STORAGE_PROBE_INTERVAL - Storage health probe cache interval (default "30s")
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
|
|
@ -106,7 +101,6 @@ import (
|
|||
"log/slog"
|
||||
"os"
|
||||
"os/signal"
|
||||
"runtime/debug"
|
||||
"strings"
|
||||
"syscall"
|
||||
|
||||
|
|
@ -129,15 +123,6 @@ var (
|
|||
Commit = "unknown"
|
||||
)
|
||||
|
||||
func init() {
|
||||
if Version != "dev" {
|
||||
return
|
||||
}
|
||||
if bi, ok := debug.ReadBuildInfo(); ok && bi.Main.Version != "" && bi.Main.Version != "(devel)" {
|
||||
Version = bi.Main.Version
|
||||
}
|
||||
}
|
||||
|
||||
func main() {
|
||||
if len(os.Args) > 1 {
|
||||
switch os.Args[1] {
|
||||
|
|
@ -196,7 +181,6 @@ func runServe() {
|
|||
databaseURL := fs.String("database-url", "", "PostgreSQL connection URL")
|
||||
logLevel := fs.String("log-level", "", "Log level: debug, info, warn, error")
|
||||
logFormat := fs.String("log-format", "", "Log format: text, json")
|
||||
accessLogPath := fs.String("access-log", "", "Path to the JSONL access log")
|
||||
version := fs.Bool("version", false, "Print version and exit")
|
||||
|
||||
fs.Usage = func() {
|
||||
|
|
@ -214,39 +198,11 @@ func runServe() {
|
|||
fmt.Fprintf(os.Stderr, " PROXY_DATABASE_URL PostgreSQL connection URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_LOG_LEVEL Log level\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_LOG_FORMAT Log format\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_ACCESS_LOG_PATH JSONL access log path\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_ALLOW_PRIVATE_HOSTS Comma-separated private upstream hosts\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_ALLOW_LOOPBACK Permit loopback upstreams and redirects\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_NPM npm registry upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_CARGO Cargo index upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_CARGO_DOWNLOAD Cargo download upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_GEM RubyGems upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_GO Go module proxy upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_HEX Hex repository upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_HEX_API Hex API upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_PUB pub registry upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_PYPI PyPI index and API upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_PYPI_DOWNLOAD PyPI download upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_MAVEN Maven repository upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_GRADLE_PLUGIN_PORTAL Gradle Plugin Portal upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_NUGET NuGet API upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_NUGET_SEARCH NuGet search upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_COMPOSER Packagist API upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_COMPOSER_REPOSITORY Packagist repository upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_CONAN Conan registry upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_CONDA Conda channel upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_CRAN CRAN mirror upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_JULIA Julia package server upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_SWIFT Swift Package Registry upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_OCI_DEFAULT Default OCI registry upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_DEBIAN Debian repository upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_UPSTREAM_RPM RPM repository upstream URL\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_GRADLE_BUILD_CACHE_READ_ONLY Disable Gradle PUT uploads\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_GRADLE_BUILD_CACHE_MAX_UPLOAD_SIZE Max Gradle PUT request body size\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_GRADLE_BUILD_CACHE_MAX_AGE Gradle cache max age eviction\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_GRADLE_BUILD_CACHE_MAX_SIZE Gradle cache max total size\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_GRADLE_BUILD_CACHE_SWEEP_INTERVAL Gradle cache eviction sweep interval\n")
|
||||
fmt.Fprintf(os.Stderr, " PROXY_HEALTH_STORAGE_PROBE_INTERVAL Storage health probe cache interval\n")
|
||||
}
|
||||
|
||||
_ = fs.Parse(os.Args[1:])
|
||||
|
|
@ -294,9 +250,6 @@ func runServe() {
|
|||
if *logFormat != "" {
|
||||
cfg.Log.Format = *logFormat
|
||||
}
|
||||
if *accessLogPath != "" {
|
||||
cfg.AccessLog.Path = *accessLogPath
|
||||
}
|
||||
|
||||
// Validate configuration
|
||||
if err := cfg.Validate(); err != nil {
|
||||
|
|
@ -308,10 +261,7 @@ func runServe() {
|
|||
logger := setupLogger(cfg.Log.Level, cfg.Log.Format)
|
||||
|
||||
// Create and start server
|
||||
srv, err := server.New(cfg, logger, server.BuildInfo{
|
||||
Version: Version,
|
||||
Commit: Commit,
|
||||
})
|
||||
srv, err := server.New(cfg, logger)
|
||||
if err != nil {
|
||||
logger.Error("failed to create server", "error", err)
|
||||
os.Exit(1)
|
||||
|
|
@ -439,12 +389,7 @@ func runMirror() {
|
|||
var source mirror.Source
|
||||
switch {
|
||||
case *sbomPath != "":
|
||||
data, err := os.ReadFile(*sbomPath)
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "error reading SBOM %s: %v\n", *sbomPath, err)
|
||||
os.Exit(1)
|
||||
}
|
||||
source = &mirror.SBOMSource{Data: data, Name: *sbomPath}
|
||||
source = &mirror.SBOMSource{Path: *sbomPath}
|
||||
case len(purls) > 0:
|
||||
source = &mirror.PURLSource{PURLs: purls}
|
||||
default:
|
||||
|
|
@ -519,7 +464,6 @@ func runMirror() {
|
|||
proxy := handler.NewProxy(db, store, fetcher, resolver, logger)
|
||||
proxy.CacheMetadata = true // mirror always caches metadata
|
||||
proxy.MetadataTTL = cfg.ParseMetadataTTL()
|
||||
proxy.MetadataMaxSize = cfg.ParseMetadataMaxSize()
|
||||
|
||||
m := mirror.New(proxy, db, store, logger, *concurrency)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,58 +0,0 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"os"
|
||||
"os/exec"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestServeHelpListsUpstreamEnvironmentVariables(t *testing.T) {
|
||||
cmd := exec.Command(os.Args[0], "-test.run=^TestServeHelpProcess$")
|
||||
cmd.Env = append(os.Environ(), "PROXY_TEST_SERVE_HELP=1")
|
||||
output, err := cmd.CombinedOutput()
|
||||
if err != nil {
|
||||
t.Fatalf("serve help failed: %v\n%s", err, output)
|
||||
}
|
||||
|
||||
variables := []string{
|
||||
"PROXY_UPSTREAM_ALLOW_PRIVATE_HOSTS",
|
||||
"PROXY_UPSTREAM_ALLOW_LOOPBACK",
|
||||
"PROXY_UPSTREAM_NPM",
|
||||
"PROXY_UPSTREAM_CARGO",
|
||||
"PROXY_UPSTREAM_CARGO_DOWNLOAD",
|
||||
"PROXY_UPSTREAM_GEM",
|
||||
"PROXY_UPSTREAM_GO",
|
||||
"PROXY_UPSTREAM_HEX",
|
||||
"PROXY_UPSTREAM_HEX_API",
|
||||
"PROXY_UPSTREAM_PUB",
|
||||
"PROXY_UPSTREAM_PYPI",
|
||||
"PROXY_UPSTREAM_PYPI_DOWNLOAD",
|
||||
"PROXY_UPSTREAM_MAVEN",
|
||||
"PROXY_UPSTREAM_GRADLE_PLUGIN_PORTAL",
|
||||
"PROXY_UPSTREAM_NUGET",
|
||||
"PROXY_UPSTREAM_NUGET_SEARCH",
|
||||
"PROXY_UPSTREAM_COMPOSER",
|
||||
"PROXY_UPSTREAM_COMPOSER_REPOSITORY",
|
||||
"PROXY_UPSTREAM_CONAN",
|
||||
"PROXY_UPSTREAM_CONDA",
|
||||
"PROXY_UPSTREAM_CRAN",
|
||||
"PROXY_UPSTREAM_JULIA",
|
||||
"PROXY_UPSTREAM_OCI_DEFAULT",
|
||||
"PROXY_UPSTREAM_DEBIAN",
|
||||
"PROXY_UPSTREAM_RPM",
|
||||
}
|
||||
for _, variable := range variables {
|
||||
if !strings.Contains(string(output), variable) {
|
||||
t.Errorf("serve help omitted %s", variable)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestServeHelpProcess(*testing.T) {
|
||||
if os.Getenv("PROXY_TEST_SERVE_HELP") != "1" {
|
||||
return
|
||||
}
|
||||
os.Args = []string{"proxy", "serve", "-help"}
|
||||
main()
|
||||
}
|
||||
|
|
@ -4,22 +4,10 @@
|
|||
# Server listen address
|
||||
listen: ":8080"
|
||||
|
||||
# Public URL where package endpoints are reachable.
|
||||
# Used for rewriting package metadata URLs and shown in install guide snippets
|
||||
# so users know what to point their package manager at.
|
||||
# Public URL where this proxy is accessible
|
||||
# Used for rewriting package metadata URLs
|
||||
base_url: "http://localhost:8080"
|
||||
|
||||
# Timeout for individual upstream HTTP requests made by protocol handlers
|
||||
# (metadata fetches, pass-through file requests). Uses Go duration syntax.
|
||||
# Set to "0" to disable the timeout. Default: "30s".
|
||||
# http_timeout: "30s"
|
||||
|
||||
# Public URL where the web UI is reached. Defaults to base_url when unset.
|
||||
# Set this separately when the UI is served on a different hostname than the
|
||||
# package endpoints — for example, the UI on a public domain behind auth while
|
||||
# build machines hit a Docker network alias for the package endpoints.
|
||||
# ui_base_url: "https://proxy.example.com/ui"
|
||||
|
||||
# Artifact storage configuration
|
||||
storage:
|
||||
# Storage backend URL
|
||||
|
|
@ -27,20 +15,9 @@ storage:
|
|||
# - file:///path/to/dir - Local filesystem (default)
|
||||
# - s3://bucket-name - Amazon S3
|
||||
# - s3://bucket?endpoint=http://localhost:9000 - S3-compatible (MinIO)
|
||||
# - gs://bucket-name - Google Cloud Storage
|
||||
# - azblob://container-name - Azure Blob Storage
|
||||
#
|
||||
# For S3, configure credentials via environment variables:
|
||||
# AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION
|
||||
#
|
||||
# For GCS, authentication uses Application Default Credentials. On GKE with
|
||||
# Workload Identity, bind the Kubernetes service account to a Google service
|
||||
# account that has roles/storage.objectAdmin on the bucket. No extra config
|
||||
# is needed in this file. For local development, run:
|
||||
# gcloud auth application-default login
|
||||
# If direct_serve is enabled, the service account also needs
|
||||
# roles/iam.serviceAccountTokenCreator on itself so the IAM Credentials
|
||||
# signBlob API can sign URLs without a private key.
|
||||
url: ""
|
||||
|
||||
# Local filesystem path (used when url is empty)
|
||||
|
|
@ -53,7 +30,7 @@ storage:
|
|||
max_size: ""
|
||||
|
||||
# Redirect cached artifact downloads to presigned storage URLs (HTTP 302)
|
||||
# instead of streaming through the proxy. Only effective for S3, GCS, and Azure.
|
||||
# instead of streaming through the proxy. Only effective for S3 and Azure.
|
||||
# Leave disabled if clients reach the proxy through an authenticating gateway,
|
||||
# since presigned URLs bypass it.
|
||||
direct_serve: false
|
||||
|
|
@ -89,24 +66,10 @@ log:
|
|||
# Log format: "text" or "json"
|
||||
format: "text"
|
||||
|
||||
# JSONL access log. Leave path empty to disable it.
|
||||
access_log:
|
||||
path: ""
|
||||
|
||||
# Upstream URLs for built-in routes and authentication
|
||||
# Upstream registry URLs and authentication
|
||||
upstream:
|
||||
# Hosts allowed to resolve to private, ULA, or CGNAT addresses
|
||||
allow_private_hosts: []
|
||||
|
||||
# Permit upstream requests and redirects to loopback addresses
|
||||
allow_loopback: false
|
||||
|
||||
# npm registry URL
|
||||
npm: "https://registry.npmjs.org"
|
||||
# Always request full npm packuments so served metadata carries publish
|
||||
# times ("time" map) even when cooldown is disabled. Needed by clients that
|
||||
# gate on publish age, e.g. Yarn's npmMinimalAgeGate. Default: false.
|
||||
# npm_full_metadata: true
|
||||
|
||||
# Cargo sparse index URL
|
||||
cargo: "https://index.crates.io"
|
||||
|
|
@ -114,109 +77,14 @@ upstream:
|
|||
# Cargo crate download URL
|
||||
cargo_download: "https://static.crates.io/crates"
|
||||
|
||||
# RubyGems registry URL
|
||||
gem: "https://rubygems.org"
|
||||
|
||||
# Go module proxy URL
|
||||
go: "https://proxy.golang.org"
|
||||
|
||||
# Hex repository URL
|
||||
hex: "https://repo.hex.pm"
|
||||
|
||||
# Hex API URL used for package timestamps
|
||||
hex_api: "https://hex.pm"
|
||||
|
||||
# pub registry URL
|
||||
pub: "https://pub.dev"
|
||||
|
||||
# PyPI index and API URL
|
||||
pypi: "https://pypi.org"
|
||||
|
||||
# PyPI package download URL
|
||||
pypi_download: "https://files.pythonhosted.org"
|
||||
|
||||
# Maven repository URL (used by /maven endpoint)
|
||||
maven: "https://repo1.maven.org/maven2"
|
||||
|
||||
# Gradle Plugin Portal Maven URL (fallback for plugin marker artifacts)
|
||||
gradle_plugin_portal: "https://plugins.gradle.org/m2"
|
||||
|
||||
# NuGet API URL
|
||||
nuget: "https://api.nuget.org"
|
||||
|
||||
# NuGet search API URL
|
||||
nuget_search: "https://azuresearch-usnc.nuget.org"
|
||||
|
||||
# Packagist API URL
|
||||
composer: "https://packagist.org"
|
||||
|
||||
# Packagist repository URL
|
||||
composer_repository: "https://repo.packagist.org"
|
||||
|
||||
# Conan registry URL
|
||||
conan: "https://center.conan.io"
|
||||
|
||||
# Conda channel base URL
|
||||
conda: "https://conda.anaconda.org"
|
||||
|
||||
# CRAN mirror URL
|
||||
cran: "https://cloud.r-project.org"
|
||||
|
||||
# Julia package server URL
|
||||
julia: "https://pkg.julialang.org"
|
||||
|
||||
# Swift Package Registry URL (used by /swift endpoint)
|
||||
swift: "https://tuist.dev/api/registry/swift"
|
||||
|
||||
# Default OCI registry URL for unprefixed /v2 requests
|
||||
oci_default: "https://registry-1.docker.io"
|
||||
|
||||
# Debian/APT repository URL (used by /debian endpoint)
|
||||
debian: "http://deb.debian.org/debian"
|
||||
|
||||
# RPM repository URL (used by /rpm endpoint)
|
||||
rpm: "https://dl.fedoraproject.org/pub/fedora/linux"
|
||||
|
||||
# Homebrew JSON API URL (used by /homebrew endpoint)
|
||||
homebrew_api: "https://formulae.brew.sh/api"
|
||||
|
||||
# Homebrew artifact registry URL (used for /v2/homebrew/core requests)
|
||||
homebrew_artifact: "https://ghcr.io"
|
||||
|
||||
# Named HTTP Helm chart repositories (used by /helm/{name}/)
|
||||
# helm:
|
||||
# bitnami: "https://charts.bitnami.com/bitnami"
|
||||
|
||||
# Named OCI registries. Use the upstream/{name}/ repository prefix, e.g.
|
||||
# oci://proxy.example.com/upstream/ghcr/owner/chart.
|
||||
# oci:
|
||||
# ghcr: "https://ghcr.io"
|
||||
|
||||
# Named Alpine APK repositories (used by /apk/{name}/).
|
||||
# Defaults to {"alpine": "https://dl-cdn.alpinelinux.org/alpine"} when empty;
|
||||
# configuring any entry replaces that default.
|
||||
# apk:
|
||||
# alpine: "https://dl-cdn.alpinelinux.org/alpine"
|
||||
# private: "https://apk.example.com"
|
||||
|
||||
# Named generic HTTP upstreams (used by /generic/{name}/). The remaining
|
||||
# request path and query are appended to the upstream URL. GitHub release
|
||||
# assets ({owner}/{repo}/releases/download/{tag}/{asset}) are cached
|
||||
# immutably; other paths use the metadata cache with stale-on-error.
|
||||
# generic:
|
||||
# github: "https://github.com"
|
||||
# github-api: "https://api.github.com"
|
||||
|
||||
# Authentication for upstream registries
|
||||
# Keys are absolute URL scopes. Scheme, host, effective port, and path
|
||||
# segment boundaries must match; the longest matching scope wins.
|
||||
# Keys are URL prefixes matched against request URLs.
|
||||
# Values can reference environment variables using ${VAR_NAME} syntax.
|
||||
#
|
||||
# Supported auth types:
|
||||
# - bearer: Authorization header with Bearer token
|
||||
# - basic: Authorization header with Basic auth (username:password)
|
||||
# - header: Custom header name and value
|
||||
# - ecr: AWS ECR auto-refreshing token via the AWS SDK credential chain
|
||||
auth:
|
||||
# Example: npm with bearer token
|
||||
# "https://registry.npmjs.org":
|
||||
|
|
@ -240,13 +108,6 @@ upstream:
|
|||
# header_name: "X-Auth-Token"
|
||||
# header_value: "${MAVEN_TOKEN}"
|
||||
|
||||
# Example: private AWS ECR registry (12h tokens auto-refreshed via
|
||||
# ecr:GetAuthorizationToken; credentials come from the AWS SDK default
|
||||
# chain, so IRSA / instance profiles / AWS_* env vars all work; the region
|
||||
# is inferred from the private ECR hostname)
|
||||
# "https://123456789012.dkr.ecr.eu-west-1.amazonaws.com":
|
||||
# type: ecr
|
||||
|
||||
# Gradle HttpBuildCache configuration
|
||||
gradle:
|
||||
build_cache:
|
||||
|
|
@ -267,15 +128,6 @@ gradle:
|
|||
# How often eviction runs when max_age or max_size is set
|
||||
sweep_interval: "10m"
|
||||
|
||||
# Health endpoint configuration.
|
||||
health:
|
||||
# Minimum time between storage backend probes.
|
||||
# The /health endpoint runs a write/read/verify/delete round-trip
|
||||
# against the configured storage backend and caches the result for
|
||||
# this interval. Set to "0" to probe on every request.
|
||||
# Default: "30s".
|
||||
storage_probe_interval: "30s"
|
||||
|
||||
# Version cooldown configuration
|
||||
# Hides package versions published too recently, giving the community time
|
||||
# to spot malicious releases before they're pulled into projects.
|
||||
|
|
@ -289,37 +141,7 @@ cooldown:
|
|||
# npm: "7d"
|
||||
# cargo: "0"
|
||||
|
||||
# Per-package overrides (keyed by PURL). Keys are normalized, so npm scopes
|
||||
# may use either @scope or the canonical %40scope form.
|
||||
# Per-package overrides (keyed by PURL)
|
||||
# packages:
|
||||
# "pkg:npm/lodash": "0"
|
||||
# "pkg:npm/@babel/core": "14d"
|
||||
|
||||
# Pre-cache artifact scanning. When enabled, every artifact is staged into
|
||||
# storage and scanned by the configured scanners before it is committed to
|
||||
# the cache and served to clients. Scanners never receive artifact bytes
|
||||
# directly — each notify call includes a short-lived signed URL that the
|
||||
# scanner fetches itself, so the proxy stays agnostic to trivy/ClamAV/Wiz/
|
||||
# any custom service. Scanners run concurrently; the first "block" verdict
|
||||
# wins and cancels the rest.
|
||||
# scanning:
|
||||
# enabled: true
|
||||
# fail_open: false
|
||||
# timeout: 30s
|
||||
#
|
||||
# # Authenticates pull requests to the internal scan-fetch route.
|
||||
# # Required whenever enabled is true. Supports ${VAR_NAME} expansion.
|
||||
# signing_key: ${PROXY_SCANNING_SIGNING_KEY}
|
||||
#
|
||||
# # Address scanners use to reach this proxy to pull staged artifacts.
|
||||
# # Defaults to base_url.
|
||||
# # fetch_base_url: http://proxy.internal:8080
|
||||
#
|
||||
# scanners:
|
||||
# - name: clamav
|
||||
# url: http://clamav-adapter:8080/scan
|
||||
# mode: block
|
||||
# - name: trivy
|
||||
# url: http://trivy-adapter:8081/scan
|
||||
# mode: monitor
|
||||
# ecosystems: [npm, pypi]
|
||||
|
|
|
|||
|
|
@ -1,6 +0,0 @@
|
|||
.DS_Store
|
||||
.git/
|
||||
.github/
|
||||
*.swp
|
||||
*.tmp
|
||||
*.tgz
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
apiVersion: v2
|
||||
name: proxy
|
||||
description: A caching proxy for package registries
|
||||
type: application
|
||||
version: 0.0.0
|
||||
appVersion: "0.0.0"
|
||||
home: https://github.com/git-pkgs/proxy
|
||||
sources:
|
||||
- https://github.com/git-pkgs/proxy
|
||||
annotations:
|
||||
artifacthub.io/license: MIT
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
git-pkgs proxy has been installed.
|
||||
|
||||
The default base URL is intended for local port forwarding. Before exposing the
|
||||
proxy, set config.data.base_url to the URL used by package-manager clients.
|
||||
|
||||
To access the proxy locally:
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} port-forward service/{{ include "proxy.fullname" . }} {{ .Values.service.port }}:{{ .Values.service.port }}
|
||||
|
||||
Then visit http://localhost:{{ .Values.service.port }}/.
|
||||
|
||||
{{- if not .Values.persistence.enabled }}
|
||||
WARNING: persistence is disabled. Cached artifacts and the default SQLite
|
||||
database will be lost when the pod is replaced.
|
||||
{{- end }}
|
||||
|
|
@ -1,46 +0,0 @@
|
|||
{{/* Expand the chart name. */}}
|
||||
{{- define "proxy.name" -}}
|
||||
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
|
||||
{{/* Create a release-specific, DNS-safe resource name. */}}
|
||||
{{- define "proxy.fullname" -}}
|
||||
{{- if .Values.fullnameOverride }}
|
||||
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
|
||||
{{- else }}
|
||||
{{- $name := include "proxy.name" . }}
|
||||
{{- if contains $name .Release.Name }}
|
||||
{{- .Release.Name | trunc 63 | trimSuffix "-" }}
|
||||
{{- else }}
|
||||
{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{- define "proxy.labels" -}}
|
||||
helm.sh/chart: {{ printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
|
||||
{{ include "proxy.selectorLabels" . }}
|
||||
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
|
||||
app.kubernetes.io/managed-by: {{ .Release.Service }}
|
||||
{{- end }}
|
||||
|
||||
{{- define "proxy.selectorLabels" -}}
|
||||
app.kubernetes.io/name: {{ include "proxy.name" . }}
|
||||
app.kubernetes.io/instance: {{ .Release.Name }}
|
||||
{{- end }}
|
||||
|
||||
{{- define "proxy.configMapName" -}}
|
||||
{{- default (include "proxy.fullname" .) .Values.config.existingConfigMap }}
|
||||
{{- end }}
|
||||
|
||||
{{- define "proxy.claimName" -}}
|
||||
{{- default (include "proxy.fullname" .) .Values.persistence.existingClaim }}
|
||||
{{- end }}
|
||||
|
||||
{{- define "proxy.image" -}}
|
||||
{{- if .Values.image.digest -}}
|
||||
{{- printf "%s@%s" .Values.image.repository .Values.image.digest -}}
|
||||
{{- else -}}
|
||||
{{- printf "%s:%s" .Values.image.repository (default .Chart.AppVersion .Values.image.tag) -}}
|
||||
{{- end -}}
|
||||
{{- end }}
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
{{- if not .Values.config.existingConfigMap }}
|
||||
apiVersion: v1
|
||||
kind: ConfigMap
|
||||
metadata:
|
||||
name: {{ include "proxy.fullname" . }}
|
||||
namespace: {{ .Release.Namespace }}
|
||||
labels:
|
||||
{{- include "proxy.labels" . | nindent 4 }}
|
||||
data:
|
||||
{{ required "config.existingConfigMapKey is required" .Values.config.existingConfigMapKey }}: |
|
||||
{{- toYaml .Values.config.data | nindent 4 }}
|
||||
{{- end }}
|
||||
|
|
@ -1,102 +0,0 @@
|
|||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: {{ include "proxy.fullname" . }}
|
||||
namespace: {{ .Release.Namespace }}
|
||||
labels:
|
||||
{{- include "proxy.labels" . | nindent 4 }}
|
||||
spec:
|
||||
replicas: {{ .Values.replicaCount }}
|
||||
strategy:
|
||||
{{- toYaml .Values.deploymentStrategy | nindent 4 }}
|
||||
selector:
|
||||
matchLabels:
|
||||
{{- include "proxy.selectorLabels" . | nindent 6 }}
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
{{- include "proxy.selectorLabels" . | nindent 8 }}
|
||||
{{- with .Values.podLabels }}
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
annotations:
|
||||
checksum/config: {{ include (print $.Template.BasePath "/configmap.yaml") . | sha256sum }}
|
||||
{{- with .Values.podAnnotations }}
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
automountServiceAccountToken: false
|
||||
terminationGracePeriodSeconds: {{ .Values.terminationGracePeriodSeconds }}
|
||||
securityContext:
|
||||
{{- toYaml .Values.podSecurityContext | nindent 8 }}
|
||||
{{- with .Values.imagePullSecrets }}
|
||||
imagePullSecrets:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
containers:
|
||||
- name: {{ .Chart.Name }}
|
||||
image: {{ include "proxy.image" . | quote }}
|
||||
imagePullPolicy: {{ .Values.image.pullPolicy }}
|
||||
securityContext:
|
||||
{{- toYaml .Values.containerSecurityContext | nindent 12 }}
|
||||
args:
|
||||
- serve
|
||||
- -config
|
||||
- /etc/proxy/{{ .Values.config.existingConfigMapKey }}
|
||||
{{- with .Values.extraEnv }}
|
||||
env:
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
{{- with .Values.extraEnvFrom }}
|
||||
envFrom:
|
||||
{{- toYaml . | nindent 12 }}
|
||||
{{- end }}
|
||||
ports:
|
||||
- name: http
|
||||
containerPort: {{ .Values.service.containerPort }}
|
||||
protocol: TCP
|
||||
startupProbe:
|
||||
{{- toYaml .Values.startupProbe | nindent 12 }}
|
||||
readinessProbe:
|
||||
{{- toYaml .Values.readinessProbe | nindent 12 }}
|
||||
livenessProbe:
|
||||
{{- toYaml .Values.livenessProbe | nindent 12 }}
|
||||
resources:
|
||||
{{- toYaml .Values.resources | nindent 12 }}
|
||||
volumeMounts:
|
||||
- name: config
|
||||
mountPath: /etc/proxy/{{ .Values.config.existingConfigMapKey }}
|
||||
subPath: {{ .Values.config.existingConfigMapKey }}
|
||||
readOnly: true
|
||||
- name: data
|
||||
mountPath: {{ .Values.persistence.mountPath }}
|
||||
volumes:
|
||||
- name: config
|
||||
configMap:
|
||||
name: {{ include "proxy.configMapName" . }}
|
||||
items:
|
||||
- key: {{ required "config.existingConfigMapKey is required" .Values.config.existingConfigMapKey }}
|
||||
path: {{ .Values.config.existingConfigMapKey }}
|
||||
- name: data
|
||||
{{- if .Values.persistence.enabled }}
|
||||
persistentVolumeClaim:
|
||||
claimName: {{ include "proxy.claimName" . }}
|
||||
{{- else }}
|
||||
emptyDir: {}
|
||||
{{- end }}
|
||||
{{- with .Values.nodeSelector }}
|
||||
nodeSelector:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.affinity }}
|
||||
affinity:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.tolerations }}
|
||||
tolerations:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
{{- with .Values.topologySpreadConstraints }}
|
||||
topologySpreadConstraints:
|
||||
{{- toYaml . | nindent 8 }}
|
||||
{{- end }}
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
{{- if .Values.ingress.enabled }}
|
||||
{{- if not .Values.ingress.hosts }}
|
||||
{{- fail "ingress.hosts must be set when ingress.enabled=true" }}
|
||||
{{- end }}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: Ingress
|
||||
metadata:
|
||||
name: {{ include "proxy.fullname" . }}
|
||||
namespace: {{ .Release.Namespace }}
|
||||
labels:
|
||||
{{- include "proxy.labels" . | nindent 4 }}
|
||||
{{- with .Values.ingress.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
{{- with .Values.ingress.className }}
|
||||
ingressClassName: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- with .Values.ingress.tls }}
|
||||
tls:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
rules:
|
||||
{{- range .Values.ingress.hosts }}
|
||||
- host: {{ .host | quote }}
|
||||
http:
|
||||
paths:
|
||||
{{- range .paths }}
|
||||
- path: {{ .path | quote }}
|
||||
pathType: {{ .pathType }}
|
||||
backend:
|
||||
service:
|
||||
name: {{ include "proxy.fullname" $ }}
|
||||
port:
|
||||
number: {{ $.Values.service.port }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
{{- if and .Values.persistence.enabled (not .Values.persistence.existingClaim) }}
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: {{ include "proxy.fullname" . }}
|
||||
namespace: {{ .Release.Namespace }}
|
||||
labels:
|
||||
{{- include "proxy.labels" . | nindent 4 }}
|
||||
{{- with .Values.persistence.annotations }}
|
||||
annotations:
|
||||
{{- toYaml . | nindent 4 }}
|
||||
{{- end }}
|
||||
spec:
|
||||
accessModes:
|
||||
{{- toYaml .Values.persistence.accessModes | nindent 4 }}
|
||||
{{- with .Values.persistence.storageClass }}
|
||||
storageClassName: {{ . | quote }}
|
||||
{{- end }}
|
||||
resources:
|
||||
requests:
|
||||
storage: {{ .Values.persistence.size }}
|
||||
{{- end }}
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: {{ include "proxy.fullname" . }}
|
||||
namespace: {{ .Release.Namespace }}
|
||||
labels:
|
||||
{{- include "proxy.labels" . | nindent 4 }}
|
||||
spec:
|
||||
type: {{ .Values.service.type }}
|
||||
ports:
|
||||
- name: http
|
||||
port: {{ .Values.service.port }}
|
||||
targetPort: http
|
||||
protocol: TCP
|
||||
selector:
|
||||
{{- include "proxy.selectorLabels" . | nindent 4 }}
|
||||
|
|
@ -1,138 +0,0 @@
|
|||
# More than one replica requires config.data.database on Postgres,
|
||||
# config.data.storage on object storage, deploymentStrategy: RollingUpdate,
|
||||
# and a PVC access mode other than ReadWriteOnce (or persistence disabled).
|
||||
replicaCount: 1
|
||||
|
||||
nameOverride: ""
|
||||
fullnameOverride: ""
|
||||
|
||||
image:
|
||||
repository: ghcr.io/git-pkgs/proxy
|
||||
# An empty tag uses the chart appVersion.
|
||||
tag: ""
|
||||
# When set, digest takes precedence over tag.
|
||||
digest: ""
|
||||
pullPolicy: IfNotPresent
|
||||
|
||||
imagePullSecrets: []
|
||||
|
||||
service:
|
||||
type: ClusterIP
|
||||
port: 8080
|
||||
# Keep this aligned with config.data.listen (or the listen address in an
|
||||
# existing ConfigMap).
|
||||
containerPort: 8080
|
||||
|
||||
# The generated configuration is ignored when existingConfigMap is set.
|
||||
config:
|
||||
existingConfigMap: ""
|
||||
existingConfigMapKey: config.yaml
|
||||
data:
|
||||
listen: ":8080"
|
||||
# Set this to the URL package-manager clients use to reach the proxy.
|
||||
base_url: "http://localhost:8080"
|
||||
storage:
|
||||
url: "file:///data/artifacts"
|
||||
database:
|
||||
driver: sqlite
|
||||
path: "/data/proxy.db"
|
||||
log:
|
||||
level: info
|
||||
format: json
|
||||
|
||||
# Environment variables override values from the configuration file. This is
|
||||
# also the recommended way to supply secret values such as database passwords
|
||||
# and object-storage credentials.
|
||||
extraEnv: []
|
||||
# - name: PROXY_DATABASE_URL
|
||||
# valueFrom:
|
||||
# secretKeyRef:
|
||||
# name: proxy-database
|
||||
# key: url
|
||||
|
||||
extraEnvFrom: []
|
||||
# - secretRef:
|
||||
# name: proxy-object-storage
|
||||
|
||||
persistence:
|
||||
enabled: true
|
||||
# Keep this aligned with config.data.storage.url and config.data.database.path
|
||||
# (or the equivalent paths in an existing ConfigMap).
|
||||
mountPath: /data
|
||||
existingClaim: ""
|
||||
annotations: {}
|
||||
accessModes:
|
||||
- ReadWriteOnce
|
||||
size: 10Gi
|
||||
storageClass: ""
|
||||
|
||||
deploymentStrategy:
|
||||
type: Recreate
|
||||
|
||||
ingress:
|
||||
enabled: false
|
||||
className: ""
|
||||
annotations: {}
|
||||
hosts: []
|
||||
# - host: proxy.example.com
|
||||
# paths:
|
||||
# - path: /
|
||||
# pathType: Prefix
|
||||
tls: []
|
||||
# - secretName: proxy-tls
|
||||
# hosts:
|
||||
# - proxy.example.com
|
||||
|
||||
podAnnotations: {}
|
||||
podLabels: {}
|
||||
|
||||
podSecurityContext:
|
||||
runAsNonRoot: true
|
||||
runAsUser: 1000
|
||||
runAsGroup: 1000
|
||||
fsGroup: 1000
|
||||
seccompProfile:
|
||||
type: RuntimeDefault
|
||||
|
||||
containerSecurityContext:
|
||||
allowPrivilegeEscalation: false
|
||||
readOnlyRootFilesystem: true
|
||||
capabilities:
|
||||
drop:
|
||||
- ALL
|
||||
|
||||
resources: {}
|
||||
# requests:
|
||||
# cpu: 100m
|
||||
# memory: 128Mi
|
||||
# limits:
|
||||
# memory: 512Mi
|
||||
|
||||
startupProbe:
|
||||
tcpSocket:
|
||||
port: http
|
||||
failureThreshold: 30
|
||||
periodSeconds: 2
|
||||
|
||||
# /health checks both the database and storage backends and can take up to ten
|
||||
# seconds. It is intentionally a readiness check rather than a liveness check.
|
||||
readinessProbe:
|
||||
httpGet:
|
||||
path: /health
|
||||
port: http
|
||||
timeoutSeconds: 11
|
||||
periodSeconds: 15
|
||||
failureThreshold: 2
|
||||
|
||||
livenessProbe:
|
||||
tcpSocket:
|
||||
port: http
|
||||
periodSeconds: 20
|
||||
failureThreshold: 3
|
||||
|
||||
terminationGracePeriodSeconds: 30
|
||||
|
||||
nodeSelector: {}
|
||||
tolerations: []
|
||||
affinity: {}
|
||||
topologySpreadConstraints: []
|
||||
|
|
@ -14,8 +14,8 @@ The proxy is a caching HTTP server that sits between package manager clients and
|
|||
│ │ /npm/* -> NPMHandler /health -> healthHandler │ │
|
||||
│ │ /cargo/* -> CargoHandler /stats -> statsHandler │ │
|
||||
│ │ /gem/* -> GemHandler /metrics -> prometheus │ │
|
||||
│ │ ...17 ecosystems /api/* -> APIHandler │ │
|
||||
│ │ /ui/* -> Web UI │ │
|
||||
│ │ ...16 ecosystems /api/* -> APIHandler │ │
|
||||
│ │ / -> Web UI │ │
|
||||
│ └──────────────────────────────────────────────────────────┘ │
|
||||
│ │ │ │ │
|
||||
│ ▼ ▼ ▼ │
|
||||
|
|
@ -169,7 +169,6 @@ metadata_cache (
|
|||
storage_path TEXT NOT NULL,
|
||||
etag TEXT,
|
||||
content_type TEXT,
|
||||
content_encoding TEXT, -- replayed on serve so signed bytes stay verbatim
|
||||
size INTEGER, -- BIGINT on Postgres
|
||||
fetched_at DATETIME,
|
||||
created_at DATETIME,
|
||||
|
|
@ -241,8 +240,6 @@ Fetches artifacts from upstream registries.
|
|||
- Exponential backoff retry on 429 (rate limit) and 5xx errors
|
||||
- Returns streaming reader (doesn't load into memory)
|
||||
- Configurable user-agent
|
||||
- Shares an authentication-aware transport with metadata requests so URL-scoped credentials apply consistently
|
||||
- Discovers and caches scoped OCI Bearer tokens from registry challenges
|
||||
|
||||
**Resolver:**
|
||||
- Determines download URL for a package/version
|
||||
|
|
@ -270,10 +267,6 @@ HTTP protocol handlers for each registry type.
|
|||
- `handleIndex()` - Proxy sparse index
|
||||
- `handleDownload()` - Serve cached crate
|
||||
|
||||
**SwiftHandler:**
|
||||
- Proxies the Swift Package Registry v1 read endpoints
|
||||
- Rewrites release URLs and caches source archives
|
||||
|
||||
### `internal/server`
|
||||
|
||||
HTTP server setup, web UI, and API handlers.
|
||||
|
|
@ -281,18 +274,18 @@ HTTP server setup, web UI, and API handlers.
|
|||
- Creates and wires together all components
|
||||
- Mounts protocol handlers at ecosystem-specific paths
|
||||
- Middleware: request ID, real IP, logging, panic recovery, active request tracking
|
||||
- Web UI under `/ui`: dashboard, package browser, source browser, version comparison
|
||||
- Web UI: dashboard, package browser, source browser, version comparison
|
||||
- Templates are embedded in the binary via `//go:embed`
|
||||
- Enrichment API for package metadata, vulnerability scanning, and outdated detection
|
||||
- Health, stats, and Prometheus metrics endpoints. `/health` runs an active write → size-check → read → verify → delete probe against the storage backend and returns a structured JSON response (`HealthResponse`) with `"ok"` / `"error"` status per subsystem. Probe results are cached (default 30 s, configurable via `health.storage_probe_interval`) to avoid overwhelming remote backends. The response also carries a `circuit_breakers` map reporting each upstream's artifact-fetch breaker as `"open"` or `"closed"`, keyed by the host fetched from (or an opaque placeholder where the fetch URL has no host to read); the same state is published as the `proxy_circuit_breaker_state` gauge on each `/metrics` scrape. An open breaker leaves the overall status `"ok"` — it describes an upstream, not this proxy.
|
||||
- Health, stats, and Prometheus metrics endpoints
|
||||
|
||||
### `internal/metrics`
|
||||
|
||||
Prometheus metrics for cache performance, upstream latency, storage operations, and active requests. See the Monitoring section of the README for the full metric list.
|
||||
|
||||
### Cooldown
|
||||
### `internal/cooldown`
|
||||
|
||||
Version age filtering for supply chain attack mitigation, provided by [github.com/git-pkgs/cooldown](https://github.com/git-pkgs/cooldown). Configurable at global, ecosystem, and per-package levels. Supported by npm, PyPI, pub.dev, and Composer handlers.
|
||||
Version age filtering for supply chain attack mitigation. Configurable at global, ecosystem, and per-package levels. Supported by npm, PyPI, pub.dev, and Composer handlers.
|
||||
|
||||
### `internal/enrichment`
|
||||
|
||||
|
|
@ -358,7 +351,6 @@ Eviction can be implemented as:
|
|||
- Fresh data - new versions visible immediately
|
||||
- Metadata is small, upstream fetch is fast
|
||||
- Set `cache_metadata: true` or use the mirror command to enable metadata caching for offline use via the `metadata_cache` table
|
||||
- OCI manifests and tag lists are exceptions: they are cached automatically so previously fetched images remain pullable and tag resolution works when the registry or token service is unavailable
|
||||
|
||||
**Why stream artifacts?**
|
||||
- Memory efficient - don't load large files into RAM
|
||||
|
|
|
|||
|
|
@ -17,8 +17,7 @@ See `config.example.yaml` in the repository root for a complete example.
|
|||
| Config | Environment | Flag | Default | Description |
|
||||
|--------|-------------|------|---------|-------------|
|
||||
| `listen` | `PROXY_LISTEN` | `-listen` | `:8080` | Address to listen on |
|
||||
| `base_url` | `PROXY_BASE_URL` | `-base-url` | `http://localhost:8080` | Public URL package managers use to reach this proxy |
|
||||
| `ui_base_url` | `PROXY_UI_URL` | - | (defaults to `base_url`) | Public URL where the web UI is reached. Set separately when the UI lives behind a different hostname than package endpoints (e.g. public domain vs Docker network alias). Used for canonical/og:url tags and the install guide banner. The proxy still serves package endpoints on the same listener, so any reverse proxy fronting the UI publicly should restrict the public route to `PathPrefix(/ui)` to avoid exposing package endpoints. |
|
||||
| `base_url` | `PROXY_BASE_URL` | `-base-url` | `http://localhost:8080` | Public URL for the proxy |
|
||||
|
||||
## Storage
|
||||
|
||||
|
|
@ -108,168 +107,20 @@ log:
|
|||
| `log.level` | `PROXY_LOG_LEVEL` | `-log-level` | `debug`, `info`, `warn`, `error` |
|
||||
| `log.format` | `PROXY_LOG_FORMAT` | `-log-format` | `text`, `json` |
|
||||
|
||||
## Access Log
|
||||
|
||||
The optional access log records client requests and each HTTP exchange with an upstream registry. It is always written as JSONL, with one JSON object per line. Records for the same client request share a `request_id`.
|
||||
|
||||
```yaml
|
||||
access_log:
|
||||
path: "/var/log/proxy/access.jsonl"
|
||||
```
|
||||
|
||||
| Config | Environment | Flag | Description |
|
||||
|--------|-------------|------|-------------|
|
||||
| `access_log.path` | `PROXY_ACCESS_LOG_PATH` | `-access-log` | File to append JSONL records to; empty disables the log |
|
||||
|
||||
The parent directory must exist and be writable when the proxy starts. A newly created log file is readable and writable only by the proxy process owner.
|
||||
|
||||
A request that receives a rate limit response from an upstream can produce records like these:
|
||||
|
||||
```json
|
||||
{"time":"2026-08-16T12:00:00Z","event":"upstream","request_id":"host/example-000001","method":"GET","url":"https://registry.example/packages/example","status_code":429,"duration_ms":42}
|
||||
{"time":"2026-08-16T12:00:00Z","event":"request","request_id":"host/example-000001","method":"GET","path":"/npm/example","status_code":502,"duration_ms":43,"remote_addr":"192.0.2.10:41234"}
|
||||
```
|
||||
|
||||
Upstream retries and OCI authentication calls are separate `upstream` records, so the log preserves every status returned over the wire. Network failures have an `error` field and no `status_code`. URL credentials, query strings, and fragments are omitted from both upstream URLs and client paths.
|
||||
|
||||
## Upstream Registries
|
||||
|
||||
Each upstream used by a built-in package route can be set in YAML or JSON under `upstream`, or with its matching environment variable. Existing installations keep the same public upstreams by default. Trailing slashes are ignored.
|
||||
|
||||
| Config | Environment | Default |
|
||||
|--------|-------------|---------|
|
||||
| `upstream.allow_private_hosts` | `PROXY_UPSTREAM_ALLOW_PRIVATE_HOSTS` | `[]` |
|
||||
| `upstream.allow_loopback` | `PROXY_UPSTREAM_ALLOW_LOOPBACK` | `false` |
|
||||
| `upstream.npm` | `PROXY_UPSTREAM_NPM` | `https://registry.npmjs.org` |
|
||||
| `upstream.npm_full_metadata` | `PROXY_UPSTREAM_NPM_FULL_METADATA` | `false` |
|
||||
| `upstream.cargo` | `PROXY_UPSTREAM_CARGO` | `https://index.crates.io` |
|
||||
| `upstream.cargo_download` | `PROXY_UPSTREAM_CARGO_DOWNLOAD` | `https://static.crates.io/crates` |
|
||||
| `upstream.gem` | `PROXY_UPSTREAM_GEM` | `https://rubygems.org` |
|
||||
| `upstream.go` | `PROXY_UPSTREAM_GO` | `https://proxy.golang.org` |
|
||||
| `upstream.hex` | `PROXY_UPSTREAM_HEX` | `https://repo.hex.pm` |
|
||||
| `upstream.hex_api` | `PROXY_UPSTREAM_HEX_API` | `https://hex.pm` |
|
||||
| `upstream.pub` | `PROXY_UPSTREAM_PUB` | `https://pub.dev` |
|
||||
| `upstream.pypi` | `PROXY_UPSTREAM_PYPI` | `https://pypi.org` |
|
||||
| `upstream.pypi_download` | `PROXY_UPSTREAM_PYPI_DOWNLOAD` | `https://files.pythonhosted.org` |
|
||||
| `upstream.maven` | `PROXY_UPSTREAM_MAVEN` | `https://repo1.maven.org/maven2` |
|
||||
| `upstream.gradle_plugin_portal` | `PROXY_UPSTREAM_GRADLE_PLUGIN_PORTAL` | `https://plugins.gradle.org/m2` |
|
||||
| `upstream.nuget` | `PROXY_UPSTREAM_NUGET` | `https://api.nuget.org` |
|
||||
| `upstream.nuget_search` | `PROXY_UPSTREAM_NUGET_SEARCH` | `https://azuresearch-usnc.nuget.org` |
|
||||
| `upstream.composer` | `PROXY_UPSTREAM_COMPOSER` | `https://packagist.org` |
|
||||
| `upstream.composer_repository` | `PROXY_UPSTREAM_COMPOSER_REPOSITORY` | `https://repo.packagist.org` |
|
||||
| `upstream.conan` | `PROXY_UPSTREAM_CONAN` | `https://center.conan.io` |
|
||||
| `upstream.conda` | `PROXY_UPSTREAM_CONDA` | `https://conda.anaconda.org` |
|
||||
| `upstream.cran` | `PROXY_UPSTREAM_CRAN` | `https://cloud.r-project.org` |
|
||||
| `upstream.julia` | `PROXY_UPSTREAM_JULIA` | `https://pkg.julialang.org` |
|
||||
| `upstream.swift` | `PROXY_UPSTREAM_SWIFT` | `https://tuist.dev/api/registry/swift` |
|
||||
| `upstream.oci_default` | `PROXY_UPSTREAM_OCI_DEFAULT` | `https://registry-1.docker.io` |
|
||||
| `upstream.debian` | `PROXY_UPSTREAM_DEBIAN` | `http://deb.debian.org/debian` |
|
||||
| `upstream.rpm` | `PROXY_UPSTREAM_RPM` | `https://dl.fedoraproject.org/pub/fedora/linux` |
|
||||
| `upstream.homebrew_api` | `PROXY_UPSTREAM_HOMEBREW_API` | `https://formulae.brew.sh/api` |
|
||||
| `upstream.homebrew_artifact` | `PROXY_UPSTREAM_HOMEBREW_ARTIFACT` | `https://ghcr.io` |
|
||||
|
||||
Private, ULA, CGNAT, and loopback addresses are rejected by default. Add each private upstream hostname or IP address to `upstream.allow_private_hosts`. The matching environment variable accepts a comma-separated list. Loopback upstreams also require `upstream.allow_loopback: true`. That setting permits upstream requests and redirects to reach any loopback address.
|
||||
Override default upstream registry URLs:
|
||||
|
||||
```yaml
|
||||
upstream:
|
||||
allow_private_hosts:
|
||||
- "upstream-proxy.internal"
|
||||
pypi: "http://upstream-proxy.internal/pypi"
|
||||
pypi_download: "http://upstream-proxy.internal/pypi"
|
||||
npm: "https://registry.npmjs.org"
|
||||
cargo: "https://index.crates.io"
|
||||
cargo_download: "https://static.crates.io/crates"
|
||||
```
|
||||
|
||||
For protocols that use separate metadata and download services, configure both values. They may point to the same endpoint when chaining proxies:
|
||||
|
||||
```yaml
|
||||
upstream:
|
||||
pypi: "https://upstream-proxy.example.com/pypi"
|
||||
pypi_download: "https://upstream-proxy.example.com/pypi"
|
||||
nuget: "https://upstream-proxy.example.com/nuget"
|
||||
nuget_search: "https://upstream-proxy.example.com/nuget"
|
||||
composer: "https://upstream-proxy.example.com/composer"
|
||||
composer_repository: "https://upstream-proxy.example.com/composer"
|
||||
```
|
||||
|
||||
`upstream.hex_api` is used for cooldown timestamps and must expose Hex's `/api/packages/{name}` JSON endpoint.
|
||||
|
||||
Helm HTTP repositories and additional OCI registries are configured as named maps:
|
||||
|
||||
```yaml
|
||||
upstream:
|
||||
# Named HTTP Helm chart repositories, served at /helm/{name}/.
|
||||
helm:
|
||||
bitnami: "https://charts.bitnami.com/bitnami"
|
||||
|
||||
# Named OCI registries. Select one with the repository prefix
|
||||
# upstream/{name}/, e.g. oci://proxy.example.com/upstream/ghcr/owner/chart.
|
||||
oci:
|
||||
ghcr: "https://ghcr.io"
|
||||
```
|
||||
|
||||
Helm HTTP repositories are read-only. The proxy fetches and rewrites each
|
||||
repository's `index.yaml` so chart archives are downloaded through the proxy.
|
||||
Chart archives are retained only when their SHA-256 digest matches the digest
|
||||
listed in the index. Relative and absolute chart URLs are both supported.
|
||||
|
||||
Generic HTTP upstreams proxy plain downloads from fixed base URLs:
|
||||
|
||||
```yaml
|
||||
upstream:
|
||||
# Named HTTP upstreams, served at /generic/{name}/. The rest of the
|
||||
# request path and the query string are appended to the upstream URL.
|
||||
generic:
|
||||
github: "https://github.com"
|
||||
github-api: "https://api.github.com"
|
||||
auth:
|
||||
# Optional: raise the GitHub API rate limit. Scoped to this host only,
|
||||
# so the token is never sent to the object store GitHub redirects to.
|
||||
"https://api.github.com":
|
||||
type: bearer
|
||||
token: "${GITHUB_TOKEN}"
|
||||
```
|
||||
|
||||
Only configured upstreams are reachable, so this is not an open HTTP proxy.
|
||||
Paths shaped like `{owner}/{repo}/releases/download/{tag}/{asset}` are
|
||||
version-pinned GitHub release assets: they are stored in the artifact cache
|
||||
and served from it without revalidation, including while the upstream is
|
||||
down. Every other path is served through the metadata cache (`cache_metadata`
|
||||
must be enabled for offline fallback): fresh within `metadata_ttl`, then
|
||||
revalidated with the upstream's `ETag`/`Last-Modified`, and served stale with
|
||||
a `Warning: 110` header when the upstream fails, refuses or rate-limits the
|
||||
request. Metadata responses are buffered up to `metadata_max_size`, so keep
|
||||
large mutable downloads (`releases/latest/download/...`) off this route.
|
||||
|
||||
This is the cache behind [mise](https://mise.jdx.dev)'s aqua backend; see the
|
||||
mise section in the README for the client-side `url_replacements`.
|
||||
|
||||
`upstream.oci_default` sets the registry used by unprefixed `/v2` requests,
|
||||
while `upstream.oci` selects named registries through the `upstream/{name}/`
|
||||
repository prefix. For example, `oci://proxy.example.com/upstream/ghcr/owner/chart`
|
||||
uses the `ghcr` registry with `owner/chart` as its repository.
|
||||
When the proxy uses plain HTTP (for example `localhost:8080`), pass
|
||||
`--plain-http` to Helm OCI commands.
|
||||
|
||||
```yaml
|
||||
upstream:
|
||||
|
||||
# Named Alpine APK repositories, served at /apk/{name}/.
|
||||
apk:
|
||||
alpine: "https://dl-cdn.alpinelinux.org/alpine"
|
||||
```
|
||||
|
||||
Alpine APK repositories are read-only. Requests to `/apk/{name}/…` mirror the
|
||||
upstream layout, e.g. `/apk/alpine/v3.22/main/x86_64/APKINDEX.tar.gz`. Indexes
|
||||
(v2 `APKINDEX.tar.gz`, v3 `Packages.adb`) and detached signatures are cached
|
||||
with the metadata TTL and served byte-for-byte unchanged so apk signature
|
||||
verification keeps working; `.apk` packages use the shared artifact cache.
|
||||
When `upstream.apk` is empty, a single repository named `alpine` pointing at
|
||||
the official mirror is available; configuring any entry replaces that default.
|
||||
|
||||
## Authentication
|
||||
|
||||
Configure authentication for private upstream registries. The same authentication-aware client is used for metadata and artifact downloads, and credentials can reference environment variables using `${VAR_NAME}` syntax.
|
||||
|
||||
OCI registries that return a Bearer challenge from a `/v2/{repository}/…` endpoint are handled automatically. The proxy discovers the token realm from `WWW-Authenticate`, applies any configured credentials for the token URL, and reuses the scoped token until shortly before it expires.
|
||||
Configure authentication for private upstream registries. Auth is matched by URL prefix, and credentials can reference environment variables using `${VAR_NAME}` syntax.
|
||||
|
||||
### Bearer Token
|
||||
|
||||
|
|
@ -316,24 +167,9 @@ upstream:
|
|||
header_value: "${MAVEN_TOKEN}"
|
||||
```
|
||||
|
||||
### AWS ECR
|
||||
|
||||
Private ECR registries issue authorization tokens that expire after 12 hours. The `ecr` auth type calls `ecr:GetAuthorizationToken` on demand, caches the result, and refreshes it shortly before expiry, so no static credential appears in the config file:
|
||||
|
||||
```yaml
|
||||
upstream:
|
||||
oci:
|
||||
ecr: "https://123456789012.dkr.ecr.eu-west-1.amazonaws.com"
|
||||
auth:
|
||||
"https://123456789012.dkr.ecr.eu-west-1.amazonaws.com":
|
||||
type: ecr
|
||||
```
|
||||
|
||||
AWS credentials are resolved by the SDK's default chain, which covers EKS IAM Roles for Service Accounts (IRSA), EC2/ECS instance profiles, `AWS_ACCESS_KEY_ID` / `AWS_SECRET_ACCESS_KEY` environment variables, and `~/.aws/credentials`. The IAM identity needs the `ecr:GetAuthorizationToken` action plus the usual `ecr:BatchGetImage` / `ecr:GetDownloadUrlForLayer` permissions on the target repositories. The region is inferred from private ECR IPv4, dual-stack, and FIPS hostnames. For other endpoint formats, set `region` explicitly or configure a default region for the SDK.
|
||||
|
||||
### URL Matching
|
||||
|
||||
Auth keys must be absolute URLs. Matching compares the scheme, host, effective port, and path-segment prefix, preventing credentials for `registry.example.com` from being sent to a lookalike host such as `registry.example.com.evil.test`. The longest matching scope wins, so you can configure different credentials for different paths:
|
||||
Auth configs are matched by URL prefix. The longest matching prefix wins, so you can configure different credentials for different paths:
|
||||
|
||||
```yaml
|
||||
upstream:
|
||||
|
|
@ -395,117 +231,16 @@ cooldown:
|
|||
|
||||
Durations support days (`7d`), hours (`48h`), and minutes (`30m`). Set to `0` to disable.
|
||||
|
||||
Package PURL keys are normalized to canonical form before matching, so `pkg:npm/@babel/core` and `pkg:npm/%40babel/core` are equivalent, as are `pkg:pypi/Django` and `pkg:pypi/django`. If both forms configure the same package, the canonical entry wins.
|
||||
|
||||
Resolution order: package override, then ecosystem override, then global default. This lets you set a conservative default while exempting trusted packages.
|
||||
|
||||
Currently supported for npm, PyPI, pub.dev, Composer, Cargo, NuGet, Conda, RubyGems, and Hex. These ecosystems include publish timestamps in their metadata.
|
||||
|
||||
Note: Hex cooldown requires disabling registry signature verification since the proxy re-encodes the protobuf payload without the original signature. Set `HEX_NO_VERIFY_REPO_ORIGIN=1` or configure your repo with `no_verify: true`.
|
||||
|
||||
## Artifact Scanning
|
||||
|
||||
Cooldown only ever looks at a version's *publish timestamp* — it never inspects the actual bytes of an artifact. Artifact scanning runs after a fetched artifact is staged into storage but before it becomes visible from cache, so an external scanner (trivy, ClamAV, Wiz, or any custom service) can block a bad verdict from ever reaching a client.
|
||||
|
||||
```yaml
|
||||
scanning:
|
||||
enabled: true
|
||||
fail_open: false
|
||||
timeout: 30s
|
||||
signing_key: ${PROXY_SCANNING_SIGNING_KEY}
|
||||
fetch_base_url: http://proxy.internal:8080
|
||||
scanners:
|
||||
- name: clamav
|
||||
url: http://clamav-adapter:8080/scan
|
||||
mode: block
|
||||
- name: trivy
|
||||
url: http://trivy-adapter:8081/scan
|
||||
mode: monitor
|
||||
ecosystems: [npm, pypi]
|
||||
```
|
||||
|
||||
| Config | Environment | Description |
|
||||
|--------|-------------|-------------|
|
||||
| `scanning.enabled` | `PROXY_SCANNING_ENABLED` | Turn on the scan gate. When false (default), artifacts are cached exactly as if scanning didn't exist |
|
||||
| `scanning.fail_open` | `PROXY_SCANNING_FAIL_OPEN` | Treat scanner errors/timeouts as allow instead of block. Default is fail-closed |
|
||||
| `scanning.timeout` | `PROXY_SCANNING_TIMEOUT` | Per-scan-call timeout, Go duration syntax (default `30s`) |
|
||||
| `scanning.signing_key` | `PROXY_SCANNING_SIGNING_KEY` | Signs pull requests to the internal scan-fetch route. Required whenever `enabled` is true |
|
||||
| `scanning.fetch_base_url` | `PROXY_SCANNING_FETCH_BASE_URL` | Address scanners use to reach this proxy to pull staged artifacts. Defaults to `base_url` |
|
||||
| `scanning.scanners` | - | List of external scanning services (YAML only) |
|
||||
| `scanning.scanners[].name` | - | Identifies this scanner in logs and metrics |
|
||||
| `scanning.scanners[].url` | - | Endpoint the proxy POSTs scan notifications to |
|
||||
| `scanning.scanners[].mode` | - | `block` (default) or `monitor` |
|
||||
| `scanning.scanners[].ecosystems` | - | Restricts this scanner to specific ecosystems (e.g. `npm`, `pypi`). Empty means all ecosystems |
|
||||
| `scanning.scanners[].headers` | - | Extra HTTP headers sent with every scan request (e.g. for authenticating to the scanner service). Values support `${VAR_NAME}` expansion |
|
||||
|
||||
### How caching defers to a scan verdict
|
||||
|
||||
The proxy never uploads artifact bytes to a scanner. When an artifact is fetched from upstream, it's stored to the configured storage backend first, exactly as without scanning. If scanning is enabled for the artifact's ecosystem, the proxy then notifies each applicable scanner with package metadata and a short-lived, HMAC-signed URL pointing at the internal `/_internal/scan-fetch` route; each scanner GETs that URL itself to pull the exact bytes staged in storage and runs its own scan against them.
|
||||
|
||||
Scanners configured for the same ecosystem all run concurrently, never sequentially. The moment any `block`-mode scanner reports a not-allowed verdict (or errors, unless `fail_open` is set), the proxy cancels the in-flight calls to the other scanners and deletes the staged artifact — it's never committed to the cache database, so it was never visible to a client. If nothing blocks, the proxy waits for every `block`-mode scanner to finish before caching the artifact and serving it. A `monitor`-mode scanner's findings are logged and never gate the wait or the caching decision, even when it reports not-allowed.
|
||||
|
||||
A blocked download surfaces to the client as `403 Forbidden` with the scanner's reason, across every ecosystem handler.
|
||||
|
||||
### Scanner HTTP contract
|
||||
|
||||
Any external service that implements this contract can act as a scanner — a trivy wrapper, a clamav-rest bridge, a Wiz connector, or an in-house service. The proxy POSTs a notify request to `scanning.scanners[].url` and waits for a JSON verdict.
|
||||
|
||||
**Request**
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| `ecosystem` | string | e.g. `npm`, `pypi`, `cargo` |
|
||||
| `name` | string | Package name |
|
||||
| `version` | string | Package version |
|
||||
| `filename` | string | Artifact filename |
|
||||
| `purl` | string | Package URL (PURL) identifying this exact version |
|
||||
| `content_type` | string | Artifact content type |
|
||||
| `size` | integer | Artifact size in bytes |
|
||||
| `fetch_url` | string | Short-lived signed URL; GET this to retrieve the exact staged bytes |
|
||||
|
||||
```json
|
||||
{
|
||||
"ecosystem": "npm", "name": "left-pad", "version": "1.0.0",
|
||||
"filename": "left-pad-1.0.0.tgz", "purl": "pkg:npm/left-pad@1.0.0",
|
||||
"content_type": "application/octet-stream", "size": 1234,
|
||||
"fetch_url": "https://proxy.internal/_internal/scan-fetch?path=...&exp=...&sig=..."
|
||||
}
|
||||
```
|
||||
|
||||
**Response**
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| `allowed` | boolean | Whether the artifact may be cached and served |
|
||||
| `reason` | string | Human-readable reason, surfaced to the client when `allowed` is false |
|
||||
| `findings` | array | Optional list of `{"severity", "title", "description"}` objects |
|
||||
|
||||
```json
|
||||
{
|
||||
"allowed": false,
|
||||
"reason": "malware detected",
|
||||
"findings": [
|
||||
{"severity": "critical", "title": "Trojan.GenericKD", "description": "..."}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
The scanner must respond within `scanning.timeout` (default `30s`); a timeout is treated the same as a `block` verdict unless `fail_open` is set.
|
||||
|
||||
### The `/_internal/scan-fetch` route
|
||||
|
||||
`fetch_url` points at an internal route, `/_internal/scan-fetch`, that streams a staged object straight from the proxy's storage backend via a short-lived HMAC-signed token (`path`, `exp`, `sig` query parameters). This works identically across every storage backend — local filesystem, S3, GCS, Azure — since it never depends on a backend-specific presigned URL, only on the one storage operation every backend already implements.
|
||||
|
||||
This route is not part of the public API. It's meant only for scanners to pull artifacts they've been notified about, and should be restricted to internal-network access at the ingress/network-policy layer — the HMAC scoping (one object, a short TTL) limits what a leaked token can do, but isn't a substitute for network restriction. Its query parameters are also documented in the generated [OpenAPI spec](../README.md#openapi-swagger).
|
||||
|
||||
The route only exists when scanning is actually configured: it's not mounted at all unless at least one scanner is enabled and `scanning.signing_key` is set, and it also refuses every request with `404` if either condition somehow isn't met at request time. There is no way to reach it, even with a forged token, when scanning is disabled.
|
||||
|
||||
## Metadata Caching
|
||||
|
||||
By default the proxy fetches metadata fresh from upstream on every request. Enable `cache_metadata` to store metadata responses in the database and storage backend for offline fallback. When upstream is unreachable, the proxy serves the last cached copy. ETag-based revalidation avoids re-downloading unchanged metadata.
|
||||
|
||||
OCI manifests and tag lists are always cached because cached image blobs cannot be pulled without their manifests and offline clients may need tag resolution. Digest-addressed manifests are immutable and served directly from cache. Tag-addressed manifests and tag lists follow `metadata_ttl`, revalidate when stale, and fall back to the last cached response when the registry is unavailable.
|
||||
|
||||
```yaml
|
||||
cache_metadata: true
|
||||
```
|
||||
|
|
@ -528,28 +263,6 @@ Set to `"0"` to always revalidate with upstream (ETag-based conditional requests
|
|||
|
||||
When upstream is unreachable and the cached entry is past its TTL, the proxy serves the stale cached copy with a `Warning: 110 - "Response is Stale"` header so clients can tell the data may be outdated.
|
||||
|
||||
### Metadata size limit
|
||||
|
||||
Upstream metadata responses are buffered in memory before being rewritten and served. `metadata_max_size` caps that buffer to protect against OOM from a misbehaving upstream. Some npm packages with thousands of versions (for example `renovate`) exceed the 100 MB default, so raise this if you see `metadata response exceeds size limit` in the logs.
|
||||
|
||||
```yaml
|
||||
metadata_max_size: "100MB" # default
|
||||
```
|
||||
|
||||
Or via environment variable: `PROXY_METADATA_MAX_SIZE=250MB`.
|
||||
|
||||
## Upstream HTTP timeout
|
||||
|
||||
Protocol handlers use a shared HTTP client for upstream requests such as metadata fetches and pass-through file downloads. `http_timeout` sets that client's per-request timeout. Raise it if slow upstreams or large metadata responses cause `context deadline exceeded` errors.
|
||||
|
||||
```yaml
|
||||
http_timeout: "30s" # default
|
||||
```
|
||||
|
||||
Or via environment variable: `PROXY_HTTP_TIMEOUT=2m`.
|
||||
|
||||
Set to `"0"` to disable the timeout entirely (requests then rely only on the server's write timeout). Independently of this setting, the shared transport gives up on an upstream that has not sent response headers within 60 seconds.
|
||||
|
||||
## Mirror API
|
||||
|
||||
The `/api/mirror` endpoints are disabled by default. Enable them to allow starting mirror jobs via HTTP:
|
||||
|
|
@ -562,14 +275,6 @@ Or via environment variable: `PROXY_MIRROR_API=true`.
|
|||
|
||||
When disabled, the endpoints are not registered and return 404.
|
||||
|
||||
Start a mirror job with either PURLs or an inline CycloneDX or SPDX JSON document:
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:8080/api/mirror \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"sbom":{"bomFormat":"CycloneDX","components":[{"purl":"pkg:npm/lodash@4.17.21"}]}}'
|
||||
```
|
||||
|
||||
## Mirror Command
|
||||
|
||||
The `proxy mirror` command pre-populates the cache from various sources. It accepts the same storage and database flags as `serve`.
|
||||
|
|
|
|||
|
|
@ -15,36 +15,104 @@ const docTemplate = `{
|
|||
"host": "{{.Host}}",
|
||||
"basePath": "{{.BasePath}}",
|
||||
"paths": {
|
||||
"/_internal/scan-fetch": {
|
||||
"/api/browse/{ecosystem}/{name}/{version}": {
|
||||
"get": {
|
||||
"description": "Streams the exact bytes staged in storage for a pre-cache security scan.\nRequires a short-lived HMAC-signed token minted by the proxy itself and\ndelivered via the fetch_url field of the scan notify request (see the\nArtifact Scanning section of docs/configuration.md). Not part of the\npublic API; restrict access to the scanner network at the ingress layer.",
|
||||
"description": "Lists files from the first cached artifact for a package version.",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"browse"
|
||||
],
|
||||
"summary": "List files inside a cached artifact",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Ecosystem",
|
||||
"name": "ecosystem",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Package name",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Version",
|
||||
"name": "version",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Directory path inside the archive",
|
||||
"name": "path",
|
||||
"in": "query"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.BrowseListResponse"
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not Found",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/browse/{ecosystem}/{name}/{version}/file/{filepath}": {
|
||||
"get": {
|
||||
"description": "Streams a single file from the cached artifact. The file path may contain slashes.",
|
||||
"produces": [
|
||||
"application/octet-stream"
|
||||
],
|
||||
"tags": [
|
||||
"scanning"
|
||||
"browse"
|
||||
],
|
||||
"summary": "Fetch a staged artifact for scanning",
|
||||
"summary": "Fetch a file inside a cached artifact",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Storage path of the staged artifact",
|
||||
"name": "path",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "Token expiry, Unix seconds",
|
||||
"name": "exp",
|
||||
"in": "query",
|
||||
"description": "Ecosystem",
|
||||
"name": "ecosystem",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "HMAC-SHA256 signature over the string path|exp",
|
||||
"name": "sig",
|
||||
"in": "query",
|
||||
"description": "Package name",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Version",
|
||||
"name": "version",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "File path inside the archive",
|
||||
"name": "filepath",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
|
|
@ -55,16 +123,22 @@ const docTemplate = `{
|
|||
"type": "file"
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "invalid, expired, or tampered token",
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "object not found in storage, or scanning is not configured",
|
||||
"description": "Not Found",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -115,6 +189,69 @@ const docTemplate = `{
|
|||
}
|
||||
}
|
||||
},
|
||||
"/api/compare/{ecosystem}/{name}/{fromVersion}/{toVersion}": {
|
||||
"get": {
|
||||
"description": "Returns a structured diff for two cached versions.",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"browse"
|
||||
],
|
||||
"summary": "Compare two cached versions",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Ecosystem",
|
||||
"name": "ecosystem",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Package name",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "From version",
|
||||
"name": "fromVersion",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "To version",
|
||||
"name": "toVersion",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not Found",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/outdated": {
|
||||
"post": {
|
||||
"consumes": [
|
||||
|
|
@ -262,7 +399,7 @@ const docTemplate = `{
|
|||
"/health": {
|
||||
"get": {
|
||||
"produces": [
|
||||
"application/json"
|
||||
"text/plain"
|
||||
],
|
||||
"tags": [
|
||||
"meta"
|
||||
|
|
@ -272,13 +409,13 @@ const docTemplate = `{
|
|||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.HealthResponse"
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"503": {
|
||||
"description": "Service Unavailable",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.HealthResponse"
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -308,198 +445,6 @@ const docTemplate = `{
|
|||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ui/api/browse/{ecosystem}/{name}/{version}": {
|
||||
"get": {
|
||||
"description": "Lists files from the first cached artifact for a package version.",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"browse"
|
||||
],
|
||||
"summary": "List files inside a cached artifact",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Ecosystem",
|
||||
"name": "ecosystem",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Package name",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Version",
|
||||
"name": "version",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Directory path inside the archive",
|
||||
"name": "path",
|
||||
"in": "query"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.BrowseListResponse"
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not Found",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ui/api/browse/{ecosystem}/{name}/{version}/file/{filepath}": {
|
||||
"get": {
|
||||
"description": "Streams a single file from the cached artifact. The file path may contain slashes.",
|
||||
"produces": [
|
||||
"application/octet-stream"
|
||||
],
|
||||
"tags": [
|
||||
"browse"
|
||||
],
|
||||
"summary": "Fetch a file inside a cached artifact",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Ecosystem",
|
||||
"name": "ecosystem",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Package name",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Version",
|
||||
"name": "version",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "File path inside the archive",
|
||||
"name": "filepath",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"type": "file"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not Found",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ui/api/compare/{ecosystem}/{name}/{fromVersion}/{toVersion}": {
|
||||
"get": {
|
||||
"description": "Returns a structured diff for two cached versions.",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"browse"
|
||||
],
|
||||
"summary": "Compare two cached versions",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Ecosystem",
|
||||
"name": "ecosystem",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Package name",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "From version",
|
||||
"name": "fromVersion",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "To version",
|
||||
"name": "toVersion",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not Found",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
|
|
@ -570,41 +515,6 @@ const docTemplate = `{
|
|||
}
|
||||
}
|
||||
},
|
||||
"server.HealthCheck": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"error": {
|
||||
"type": "string"
|
||||
},
|
||||
"status": {
|
||||
"type": "string"
|
||||
},
|
||||
"step": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"server.HealthResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"checks": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"$ref": "#/definitions/server.HealthCheck"
|
||||
}
|
||||
},
|
||||
"circuit_breakers": {
|
||||
"description": "CircuitBreakers reports the state (\"open\" or \"closed\") of each upstream\nregistry's artifact-fetch circuit breaker, keyed by the host fetched from\nor, where the fetch URL has none to read, by an opaque placeholder\nstanding in for it. It is omitted when no breaker has been created yet.\nAn open breaker fails every artifact fetch it covers without contacting\nthe upstream, but says nothing about this proxy's own health, so it does\nnot change Status.",
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"status": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"server.OutdatedPackage": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
|
|
|||
|
|
@ -8,36 +8,104 @@
|
|||
},
|
||||
"basePath": "/",
|
||||
"paths": {
|
||||
"/_internal/scan-fetch": {
|
||||
"/api/browse/{ecosystem}/{name}/{version}": {
|
||||
"get": {
|
||||
"description": "Streams the exact bytes staged in storage for a pre-cache security scan.\nRequires a short-lived HMAC-signed token minted by the proxy itself and\ndelivered via the fetch_url field of the scan notify request (see the\nArtifact Scanning section of docs/configuration.md). Not part of the\npublic API; restrict access to the scanner network at the ingress layer.",
|
||||
"description": "Lists files from the first cached artifact for a package version.",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"browse"
|
||||
],
|
||||
"summary": "List files inside a cached artifact",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Ecosystem",
|
||||
"name": "ecosystem",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Package name",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Version",
|
||||
"name": "version",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Directory path inside the archive",
|
||||
"name": "path",
|
||||
"in": "query"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.BrowseListResponse"
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not Found",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/browse/{ecosystem}/{name}/{version}/file/{filepath}": {
|
||||
"get": {
|
||||
"description": "Streams a single file from the cached artifact. The file path may contain slashes.",
|
||||
"produces": [
|
||||
"application/octet-stream"
|
||||
],
|
||||
"tags": [
|
||||
"scanning"
|
||||
"browse"
|
||||
],
|
||||
"summary": "Fetch a staged artifact for scanning",
|
||||
"summary": "Fetch a file inside a cached artifact",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Storage path of the staged artifact",
|
||||
"name": "path",
|
||||
"in": "query",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "Token expiry, Unix seconds",
|
||||
"name": "exp",
|
||||
"in": "query",
|
||||
"description": "Ecosystem",
|
||||
"name": "ecosystem",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "HMAC-SHA256 signature over the string path|exp",
|
||||
"name": "sig",
|
||||
"in": "query",
|
||||
"description": "Package name",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Version",
|
||||
"name": "version",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "File path inside the archive",
|
||||
"name": "filepath",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
|
|
@ -48,16 +116,22 @@
|
|||
"type": "file"
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "invalid, expired, or tampered token",
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "object not found in storage, or scanning is not configured",
|
||||
"description": "Not Found",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -108,6 +182,69 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"/api/compare/{ecosystem}/{name}/{fromVersion}/{toVersion}": {
|
||||
"get": {
|
||||
"description": "Returns a structured diff for two cached versions.",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"browse"
|
||||
],
|
||||
"summary": "Compare two cached versions",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Ecosystem",
|
||||
"name": "ecosystem",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Package name",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "From version",
|
||||
"name": "fromVersion",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "To version",
|
||||
"name": "toVersion",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not Found",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/outdated": {
|
||||
"post": {
|
||||
"consumes": [
|
||||
|
|
@ -255,7 +392,7 @@
|
|||
"/health": {
|
||||
"get": {
|
||||
"produces": [
|
||||
"application/json"
|
||||
"text/plain"
|
||||
],
|
||||
"tags": [
|
||||
"meta"
|
||||
|
|
@ -265,13 +402,13 @@
|
|||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.HealthResponse"
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"503": {
|
||||
"description": "Service Unavailable",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.HealthResponse"
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -301,198 +438,6 @@
|
|||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ui/api/browse/{ecosystem}/{name}/{version}": {
|
||||
"get": {
|
||||
"description": "Lists files from the first cached artifact for a package version.",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"browse"
|
||||
],
|
||||
"summary": "List files inside a cached artifact",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Ecosystem",
|
||||
"name": "ecosystem",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Package name",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Version",
|
||||
"name": "version",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Directory path inside the archive",
|
||||
"name": "path",
|
||||
"in": "query"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.BrowseListResponse"
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not Found",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ui/api/browse/{ecosystem}/{name}/{version}/file/{filepath}": {
|
||||
"get": {
|
||||
"description": "Streams a single file from the cached artifact. The file path may contain slashes.",
|
||||
"produces": [
|
||||
"application/octet-stream"
|
||||
],
|
||||
"tags": [
|
||||
"browse"
|
||||
],
|
||||
"summary": "Fetch a file inside a cached artifact",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Ecosystem",
|
||||
"name": "ecosystem",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Package name",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Version",
|
||||
"name": "version",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "File path inside the archive",
|
||||
"name": "filepath",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"type": "file"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not Found",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/ui/api/compare/{ecosystem}/{name}/{fromVersion}/{toVersion}": {
|
||||
"get": {
|
||||
"description": "Returns a structured diff for two cached versions.",
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"browse"
|
||||
],
|
||||
"summary": "Compare two cached versions",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Ecosystem",
|
||||
"name": "ecosystem",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Package name",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "From version",
|
||||
"name": "fromVersion",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "To version",
|
||||
"name": "toVersion",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not Found",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal Server Error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/server.ErrorResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
|
|
@ -563,41 +508,6 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"server.HealthCheck": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"error": {
|
||||
"type": "string"
|
||||
},
|
||||
"status": {
|
||||
"type": "string"
|
||||
},
|
||||
"step": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"server.HealthResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"checks": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"$ref": "#/definitions/server.HealthCheck"
|
||||
}
|
||||
},
|
||||
"circuit_breakers": {
|
||||
"description": "CircuitBreakers reports the state (\"open\" or \"closed\") of each upstream\nregistry's artifact-fetch circuit breaker, keyed by the host fetched from\nor, where the fetch URL has none to read, by an opaque placeholder\nstanding in for it. It is omitted when no breaker has been created yet.\nAn open breaker fails every artifact fetch it covers without contacting\nthe upstream, but says nothing about this proxy's own health, so it does\nnot change Status.",
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"status": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"server.OutdatedPackage": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
|
|
|||
288
go.mod
288
go.mod
|
|
@ -1,143 +1,135 @@
|
|||
module github.com/git-pkgs/proxy
|
||||
|
||||
go 1.26.7
|
||||
go 1.25.6
|
||||
|
||||
require (
|
||||
github.com/BurntSushi/toml v1.6.0
|
||||
github.com/CycloneDX/cyclonedx-go v0.12.0
|
||||
github.com/aws/aws-sdk-go-v2/config v1.33.2
|
||||
github.com/aws/aws-sdk-go-v2/service/ecr v1.64.0
|
||||
github.com/git-pkgs/archives v0.7.0
|
||||
github.com/git-pkgs/artifacts v0.2.1
|
||||
github.com/git-pkgs/cooldown v0.2.0
|
||||
github.com/git-pkgs/enrichment v0.7.1
|
||||
github.com/git-pkgs/gcs v0.1.0
|
||||
github.com/git-pkgs/integrity v0.1.1
|
||||
github.com/git-pkgs/magic v0.3.1
|
||||
github.com/git-pkgs/purl v0.1.20
|
||||
github.com/git-pkgs/registries v0.9.1
|
||||
github.com/git-pkgs/spdx v0.3.1
|
||||
github.com/git-pkgs/vers v0.7.0
|
||||
github.com/git-pkgs/vulns v0.2.3
|
||||
github.com/go-chi/chi/v5 v5.3.2
|
||||
github.com/CycloneDX/cyclonedx-go v0.10.0
|
||||
github.com/git-pkgs/archives v0.3.0
|
||||
github.com/git-pkgs/enrichment v0.2.2
|
||||
github.com/git-pkgs/purl v0.1.12
|
||||
github.com/git-pkgs/registries v0.5.1
|
||||
github.com/git-pkgs/spdx v0.1.3
|
||||
github.com/git-pkgs/vers v0.2.5
|
||||
github.com/git-pkgs/vulns v0.1.5
|
||||
github.com/go-chi/chi/v5 v5.2.5
|
||||
github.com/jmoiron/sqlx v1.4.0
|
||||
github.com/lib/pq v1.12.3
|
||||
github.com/opencontainers/go-digest v1.0.0
|
||||
github.com/prometheus/client_golang v1.24.1
|
||||
github.com/prometheus/client_model v0.6.3
|
||||
github.com/prometheus/client_golang v1.23.2
|
||||
github.com/prometheus/client_model v0.6.2
|
||||
github.com/spdx/tools-golang v0.5.7
|
||||
github.com/swaggo/swag v1.16.6
|
||||
gocloud.dev v0.46.0
|
||||
golang.org/x/sync v0.23.0
|
||||
google.golang.org/protobuf v1.36.12
|
||||
gocloud.dev v0.45.0
|
||||
golang.org/x/sync v0.20.0
|
||||
google.golang.org/protobuf v1.36.11
|
||||
gopkg.in/yaml.v3 v3.0.1
|
||||
modernc.org/sqlite v1.58.0
|
||||
modernc.org/sqlite v1.50.0
|
||||
)
|
||||
|
||||
require (
|
||||
4d63.com/gocheckcompilerdirectives v1.4.0 // indirect
|
||||
4d63.com/gocheckcompilerdirectives v1.3.0 // indirect
|
||||
4d63.com/gochecknoglobals v0.2.2 // indirect
|
||||
charm.land/lipgloss/v2 v2.0.6 // indirect
|
||||
cloud.google.com/go/auth v0.21.0 // indirect
|
||||
cloud.google.com/go/auth v0.18.2 // indirect
|
||||
cloud.google.com/go/auth/oauth2adapt v0.2.8 // indirect
|
||||
cloud.google.com/go/compute/metadata v0.9.0 // indirect
|
||||
codeberg.org/chavacava/garif v0.2.0 // indirect
|
||||
codeberg.org/polyfloyd/go-errorlint v1.9.0 // indirect
|
||||
dev.gaijin.team/go/exhaustruct/v4 v4.0.0 // indirect
|
||||
dev.gaijin.team/go/exhaustruct/v5 v5.0.3 // indirect
|
||||
dev.gaijin.team/go/golib v0.8.1 // indirect
|
||||
dev.gaijin.team/go/golib v0.6.0 // indirect
|
||||
github.com/4meepo/tagalign v1.4.3 // indirect
|
||||
github.com/Abirdcfly/dupword v0.1.8 // indirect
|
||||
github.com/Abirdcfly/dupword v0.1.7 // indirect
|
||||
github.com/AdminBenni/iota-mixing v1.0.0 // indirect
|
||||
github.com/AlwxSin/noinlineerr v1.0.6 // indirect
|
||||
github.com/Antonboom/errname v1.1.2 // indirect
|
||||
github.com/Antonboom/nilnil v1.1.2 // indirect
|
||||
github.com/AlwxSin/noinlineerr v1.0.5 // indirect
|
||||
github.com/Antonboom/errname v1.1.1 // indirect
|
||||
github.com/Antonboom/nilnil v1.1.1 // indirect
|
||||
github.com/Antonboom/testifylint v1.6.4 // indirect
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azcore v1.21.0 // indirect
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azcore v1.20.0 // indirect
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azidentity v1.13.1 // indirect
|
||||
github.com/Azure/azure-sdk-for-go/sdk/internal v1.11.2 // indirect
|
||||
github.com/Azure/azure-sdk-for-go/sdk/storage/azblob v1.6.4 // indirect
|
||||
github.com/AzureAD/microsoft-authentication-library-for-go v1.7.0 // indirect
|
||||
github.com/ClickHouse/clickhouse-go-linter v1.2.1 // indirect
|
||||
github.com/Azure/azure-sdk-for-go/sdk/storage/azblob v1.6.3 // indirect
|
||||
github.com/Azure/go-autorest v14.2.0+incompatible // indirect
|
||||
github.com/Azure/go-autorest/autorest/to v0.4.1 // indirect
|
||||
github.com/AzureAD/microsoft-authentication-library-for-go v1.6.0 // indirect
|
||||
github.com/BurntSushi/toml v1.6.0 // indirect
|
||||
github.com/Djarvur/go-err113 v0.1.1 // indirect
|
||||
github.com/KyleBanks/depth v1.2.1 // indirect
|
||||
github.com/Masterminds/semver/v3 v3.5.0 // indirect
|
||||
github.com/MirrexOne/unqueryvet v1.5.4 // indirect
|
||||
github.com/Masterminds/semver/v3 v3.4.0 // indirect
|
||||
github.com/MirrexOne/unqueryvet v1.5.3 // indirect
|
||||
github.com/OpenPeeDeeP/depguard/v2 v2.2.1 // indirect
|
||||
github.com/PuerkitoBio/purell v1.1.1 // indirect
|
||||
github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 // indirect
|
||||
github.com/alecthomas/chroma/v2 v2.27.0 // indirect
|
||||
github.com/alecthomas/chroma/v2 v2.23.1 // indirect
|
||||
github.com/alecthomas/go-check-sumtype v0.3.1 // indirect
|
||||
github.com/alexkohler/nakedret/v2 v2.0.6 // indirect
|
||||
github.com/alexkohler/prealloc v1.1.0 // indirect
|
||||
github.com/alexkohler/prealloc v1.0.2 // indirect
|
||||
github.com/alfatraining/structtag v1.0.0 // indirect
|
||||
github.com/alingse/asasalint v0.0.11 // indirect
|
||||
github.com/alingse/nilnesserr v0.2.0 // indirect
|
||||
github.com/anchore/go-struct-converter v0.1.0 // indirect
|
||||
github.com/apapsch/go-jsonmerge/v2 v2.0.0 // indirect
|
||||
github.com/ashanbrown/forbidigo/v2 v2.3.1 // indirect
|
||||
github.com/ashanbrown/makezero/v2 v2.2.1 // indirect
|
||||
github.com/aws/aws-sdk-go-v2 v1.46.0 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.7.11 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/credentials v1.20.2 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.19.1 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/feature/s3/transfermanager v0.2.3 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/internal/configsources v1.5.2 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.8.2 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/internal/v4a v1.5.1 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.13.19 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.9.18 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.14.1 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.19.25 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/s3 v1.102.2 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/signin v1.8.0 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/sso v1.36.0 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/ssooidc v1.41.0 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/sts v1.48.0 // indirect
|
||||
github.com/aws/smithy-go v1.28.1 // indirect
|
||||
github.com/ashanbrown/forbidigo/v2 v2.3.0 // indirect
|
||||
github.com/ashanbrown/makezero/v2 v2.1.0 // indirect
|
||||
github.com/aws/aws-sdk-go-v2 v1.41.3 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.7.6 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/config v1.32.11 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/credentials v1.19.11 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.18.19 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/feature/s3/manager v1.22.5 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/internal/configsources v1.4.19 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.7.19 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/internal/ini v1.8.5 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/internal/v4a v1.4.19 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.13.6 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.9.11 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.13.19 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.19.19 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/s3 v1.96.3 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/signin v1.0.7 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/sso v1.30.12 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/ssooidc v1.35.16 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/service/sts v1.41.8 // indirect
|
||||
github.com/aws/smithy-go v1.24.2 // indirect
|
||||
github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
|
||||
github.com/beorn7/perks v1.0.1 // indirect
|
||||
github.com/bkielbasa/cyclop v1.2.3 // indirect
|
||||
github.com/blizzy78/varnamelen v0.8.0 // indirect
|
||||
github.com/bombsimon/wsl/v4 v4.7.0 // indirect
|
||||
github.com/bombsimon/wsl/v5 v5.9.0 // indirect
|
||||
github.com/bombsimon/wsl/v5 v5.6.0 // indirect
|
||||
github.com/breml/bidichk v0.3.3 // indirect
|
||||
github.com/breml/errchkjson v0.4.1 // indirect
|
||||
github.com/butuzov/ireturn v0.4.1 // indirect
|
||||
github.com/butuzov/mirror v1.3.3 // indirect
|
||||
github.com/butuzov/ireturn v0.4.0 // indirect
|
||||
github.com/butuzov/mirror v1.3.0 // indirect
|
||||
github.com/catenacyber/perfsprint v0.10.1 // indirect
|
||||
github.com/ccojocar/zxcvbn-go v1.0.4 // indirect
|
||||
github.com/cenk/backoff v2.2.1+incompatible // indirect
|
||||
github.com/cespare/xxhash/v2 v2.3.0 // indirect
|
||||
github.com/charithe/durationcheck v0.0.11 // indirect
|
||||
github.com/charmbracelet/colorprofile v0.4.3 // indirect
|
||||
github.com/charmbracelet/ultraviolet v0.0.0-20260811164956-006e29f97886 // indirect
|
||||
github.com/charmbracelet/x/ansi v0.11.8 // indirect
|
||||
github.com/charmbracelet/x/term v0.2.2 // indirect
|
||||
github.com/charmbracelet/x/termios v0.1.1 // indirect
|
||||
github.com/charmbracelet/x/windows v0.2.2 // indirect
|
||||
github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc // indirect
|
||||
github.com/charmbracelet/lipgloss v1.1.0 // indirect
|
||||
github.com/charmbracelet/x/ansi v0.10.1 // indirect
|
||||
github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd // indirect
|
||||
github.com/charmbracelet/x/term v0.2.1 // indirect
|
||||
github.com/ckaznocha/intrange v0.3.1 // indirect
|
||||
github.com/clipperhouse/displaywidth v0.11.0 // indirect
|
||||
github.com/clipperhouse/uax29/v2 v2.7.0 // indirect
|
||||
github.com/cpuguy83/go-md2man/v2 v2.0.6 // indirect
|
||||
github.com/curioswitch/go-reassign v0.3.0 // indirect
|
||||
github.com/daixiang0/gci v0.13.7 // indirect
|
||||
github.com/dave/dst v0.27.3 // indirect
|
||||
github.com/davecgh/go-spew v1.1.1 // indirect
|
||||
github.com/denis-tingaikin/go-header v0.5.0 // indirect
|
||||
github.com/dlclark/regexp2/v2 v2.2.1 // indirect
|
||||
github.com/dlclark/regexp2 v1.11.5 // indirect
|
||||
github.com/dustin/go-humanize v1.0.1 // indirect
|
||||
github.com/ecosyste-ms/ecosystems-go v0.4.0 // indirect
|
||||
github.com/ecosyste-ms/ecosystems-go v0.1.1 // indirect
|
||||
github.com/ettle/strcase v0.2.0 // indirect
|
||||
github.com/facebookgo/clock v0.0.0-20150410010913-600d898af40a // indirect
|
||||
github.com/fatih/color v1.19.0 // indirect
|
||||
github.com/fatih/color v1.18.0 // indirect
|
||||
github.com/fatih/structtag v1.2.0 // indirect
|
||||
github.com/firefart/nonamedreturns v1.0.8 // indirect
|
||||
github.com/firefart/nonamedreturns v1.0.6 // indirect
|
||||
github.com/fsnotify/fsnotify v1.9.0 // indirect
|
||||
github.com/fzipp/gocyclo v0.6.0 // indirect
|
||||
github.com/ghostiam/protogetter v0.3.21 // indirect
|
||||
github.com/ghostiam/protogetter v0.3.20 // indirect
|
||||
github.com/git-pkgs/packageurl-go v0.3.1 // indirect
|
||||
github.com/git-pkgs/pom v0.1.7 // indirect
|
||||
github.com/github/go-spdx/v2 v2.7.0 // indirect
|
||||
github.com/go-critic/go-critic v0.14.4 // indirect
|
||||
github.com/git-pkgs/pom v0.1.4 // indirect
|
||||
github.com/github/go-spdx/v2 v2.6.0 // indirect
|
||||
github.com/go-critic/go-critic v0.14.3 // indirect
|
||||
github.com/go-logr/logr v1.4.3 // indirect
|
||||
github.com/go-logr/stdr v1.2.2 // indirect
|
||||
github.com/go-openapi/jsonpointer v0.19.5 // indirect
|
||||
|
|
@ -156,111 +148,109 @@ require (
|
|||
github.com/gobwas/glob v0.2.3 // indirect
|
||||
github.com/godoc-lint/godoc-lint v0.11.2 // indirect
|
||||
github.com/gofrs/flock v0.13.0 // indirect
|
||||
github.com/golang-jwt/jwt/v5 v5.3.1 // indirect
|
||||
github.com/golang-jwt/jwt/v5 v5.3.0 // indirect
|
||||
github.com/golangci/asciicheck v0.5.0 // indirect
|
||||
github.com/golangci/dupl v0.0.0-20260401084720-c99c5cf5c202 // indirect
|
||||
github.com/golangci/dupl v0.0.0-20250308024227-f665c8d69b32 // indirect
|
||||
github.com/golangci/go-printf-func-name v0.1.1 // indirect
|
||||
github.com/golangci/gofmt v0.0.0-20260820135601-e84e05053792 // indirect
|
||||
github.com/golangci/golangci-lint/v2 v2.13.1 // indirect
|
||||
github.com/golangci/gofmt v0.0.0-20250106114630-d62b90e6713d // indirect
|
||||
github.com/golangci/golangci-lint/v2 v2.10.1 // indirect
|
||||
github.com/golangci/golines v0.15.0 // indirect
|
||||
github.com/golangci/misspell v0.8.0 // indirect
|
||||
github.com/golangci/plugin-module-register v0.1.2 // indirect
|
||||
github.com/golangci/revgrep v0.8.0 // indirect
|
||||
github.com/golangci/rowserrcheck v0.0.0-20260419091836-c5f79b8a11ba // indirect
|
||||
github.com/golangci/swaggoswag v0.0.0-20250504205917-77f2aca3143e // indirect
|
||||
github.com/golangci/unconvert v0.0.0-20250410112200-a129a6e6413e // indirect
|
||||
github.com/google/go-cmp v0.7.0 // indirect
|
||||
github.com/google/s2a-go v0.1.9 // indirect
|
||||
github.com/google/uuid v1.6.0 // indirect
|
||||
github.com/google/wire v0.7.0 // indirect
|
||||
github.com/googleapis/enterprise-certificate-proxy v0.3.18 // indirect
|
||||
github.com/googleapis/gax-go/v2 v2.23.0 // indirect
|
||||
github.com/googleapis/enterprise-certificate-proxy v0.3.12 // indirect
|
||||
github.com/googleapis/gax-go/v2 v2.17.0 // indirect
|
||||
github.com/gordonklaus/ineffassign v0.2.0 // indirect
|
||||
github.com/gostaticanalysis/analysisutil v0.7.1 // indirect
|
||||
github.com/gostaticanalysis/comment v1.5.0 // indirect
|
||||
github.com/gostaticanalysis/forcetypeassert v0.2.0 // indirect
|
||||
github.com/gostaticanalysis/nilerr v0.1.2 // indirect
|
||||
github.com/hashicorp/go-immutable-radix/v2 v2.1.0 // indirect
|
||||
github.com/hashicorp/go-version v1.9.0 // indirect
|
||||
github.com/hashicorp/go-version v1.8.0 // indirect
|
||||
github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect
|
||||
github.com/hashicorp/hcl v1.0.0 // indirect
|
||||
github.com/hexops/gotextdiff v1.0.3 // indirect
|
||||
github.com/inconshreveable/mousetrap v1.1.0 // indirect
|
||||
github.com/jgautheron/goconst v1.11.0 // indirect
|
||||
github.com/jgautheron/goconst v1.8.2 // indirect
|
||||
github.com/jingyugao/rowserrcheck v1.1.1 // indirect
|
||||
github.com/jjti/go-spancheck v0.6.5 // indirect
|
||||
github.com/josharian/intern v1.0.0 // indirect
|
||||
github.com/julz/importas v0.2.0 // indirect
|
||||
github.com/karamaru-alpha/copyloopvar v1.2.2 // indirect
|
||||
github.com/kisielk/errcheck v1.20.0 // indirect
|
||||
github.com/kisielk/errcheck v1.9.0 // indirect
|
||||
github.com/kkHAIKE/contextcheck v1.1.6 // indirect
|
||||
github.com/klauspost/compress v1.19.2 // indirect
|
||||
github.com/kulti/thelper v0.7.1 // indirect
|
||||
github.com/kunwardeep/paralleltest v1.0.15 // indirect
|
||||
github.com/kylelemons/godebug v1.1.0 // indirect
|
||||
github.com/lasiar/canonicalheader v1.1.2 // indirect
|
||||
github.com/ldez/exptostd v0.4.5 // indirect
|
||||
github.com/ldez/gomoddirectives v0.9.0 // indirect
|
||||
github.com/ldez/gomoddirectives v0.8.0 // indirect
|
||||
github.com/ldez/grignotin v0.10.1 // indirect
|
||||
github.com/ldez/structtags v0.6.1 // indirect
|
||||
github.com/ldez/tagliatelle v0.7.2 // indirect
|
||||
github.com/ldez/usetesting v0.5.0 // indirect
|
||||
github.com/leonklingele/grouper v1.1.2 // indirect
|
||||
github.com/lucasb-eyer/go-colorful v1.4.1 // indirect
|
||||
github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
|
||||
github.com/macabu/inamedparam v0.2.0 // indirect
|
||||
github.com/magiconair/properties v1.8.6 // indirect
|
||||
github.com/mailru/easyjson v0.7.7 // indirect
|
||||
github.com/manuelarte/embeddedstructfieldcheck v0.4.0 // indirect
|
||||
github.com/manuelarte/funcorder v0.6.0 // indirect
|
||||
github.com/manuelarte/funcorder v0.5.0 // indirect
|
||||
github.com/maratori/testableexamples v1.0.1 // indirect
|
||||
github.com/maratori/testpackage v1.1.2 // indirect
|
||||
github.com/matoous/godox v1.1.0 // indirect
|
||||
github.com/mattn/go-colorable v0.1.15 // indirect
|
||||
github.com/mattn/go-isatty v0.0.24 // indirect
|
||||
github.com/mattn/go-runewidth v0.0.24 // indirect
|
||||
github.com/mgechev/revive v1.15.0 // indirect
|
||||
github.com/mattn/go-colorable v0.1.14 // indirect
|
||||
github.com/mattn/go-isatty v0.0.20 // indirect
|
||||
github.com/mattn/go-runewidth v0.0.16 // indirect
|
||||
github.com/mgechev/revive v1.14.0 // indirect
|
||||
github.com/mitchellh/go-homedir v1.1.0 // indirect
|
||||
github.com/mitchellh/mapstructure v1.5.0 // indirect
|
||||
github.com/moricho/tparallel v0.3.2 // indirect
|
||||
github.com/muesli/cancelreader v0.2.2 // indirect
|
||||
github.com/muesli/termenv v0.16.0 // indirect
|
||||
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
|
||||
github.com/nakabonne/nestif v0.3.1 // indirect
|
||||
github.com/ncruces/go-strftime v1.0.0 // indirect
|
||||
github.com/nishanths/exhaustive v0.12.0 // indirect
|
||||
github.com/nishanths/predeclared v0.2.2 // indirect
|
||||
github.com/nunnatsa/ginkgolinter v0.24.0 // indirect
|
||||
github.com/oapi-codegen/nullable v1.2.0 // indirect
|
||||
github.com/oapi-codegen/runtime v1.6.0 // indirect
|
||||
github.com/package-url/packageurl-go v0.1.7 // indirect
|
||||
github.com/pandatix/go-cvss v0.6.4 // indirect
|
||||
github.com/nunnatsa/ginkgolinter v0.23.0 // indirect
|
||||
github.com/oapi-codegen/runtime v1.2.0 // indirect
|
||||
github.com/package-url/packageurl-go v0.1.6 // indirect
|
||||
github.com/pandatix/go-cvss v0.6.2 // indirect
|
||||
github.com/pelletier/go-toml v1.9.5 // indirect
|
||||
github.com/pelletier/go-toml/v2 v2.4.3 // indirect
|
||||
github.com/pelletier/go-toml/v2 v2.2.4 // indirect
|
||||
github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c // indirect
|
||||
github.com/prometheus/common v0.70.1 // indirect
|
||||
github.com/prometheus/procfs v0.21.1 // indirect
|
||||
github.com/pmezard/go-difflib v1.0.0 // indirect
|
||||
github.com/prometheus/common v0.67.5 // indirect
|
||||
github.com/prometheus/procfs v0.20.1 // indirect
|
||||
github.com/quasilyte/go-ruleguard v0.4.5 // indirect
|
||||
github.com/quasilyte/go-ruleguard/dsl v0.3.23 // indirect
|
||||
github.com/quasilyte/gogrep v0.5.0 // indirect
|
||||
github.com/quasilyte/regex/syntax v0.0.0-20210819130434-b3f0c404a727 // indirect
|
||||
github.com/quasilyte/stdinfo v0.0.0-20220114132959-f7386bf02567 // indirect
|
||||
github.com/raeperd/recvcheck v0.3.0 // indirect
|
||||
github.com/raeperd/recvcheck v0.2.0 // indirect
|
||||
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
|
||||
github.com/rivo/uniseg v0.4.7 // indirect
|
||||
github.com/rogpeppe/go-internal v1.16.0 // indirect
|
||||
github.com/rogpeppe/go-internal v1.14.1 // indirect
|
||||
github.com/rs/dnscache v0.0.0-20230804202142-fc85eb664529 // indirect
|
||||
github.com/rubyist/circuitbreaker v2.2.1+incompatible // indirect
|
||||
github.com/russross/blackfriday/v2 v2.1.0 // indirect
|
||||
github.com/ryancurrah/gomodguard v1.4.1 // indirect
|
||||
github.com/ryancurrah/gomodguard/v2 v2.1.3 // indirect
|
||||
github.com/ryanrolds/sqlclosecheck v0.6.0 // indirect
|
||||
github.com/ryanrolds/sqlclosecheck v0.5.1 // indirect
|
||||
github.com/sanposhiho/wastedassign/v2 v2.1.0 // indirect
|
||||
github.com/santhosh-tekuri/jsonschema/v6 v6.0.3 // indirect
|
||||
github.com/santhosh-tekuri/jsonschema/v6 v6.0.2 // indirect
|
||||
github.com/sashamelentyev/interfacebloat v1.1.0 // indirect
|
||||
github.com/sashamelentyev/usestdlibvars v1.29.0 // indirect
|
||||
github.com/securego/gosec/v2 v2.28.0 // indirect
|
||||
github.com/sirupsen/logrus v1.10.1 // indirect
|
||||
github.com/securego/gosec/v2 v2.23.0 // indirect
|
||||
github.com/sirupsen/logrus v1.9.4 // indirect
|
||||
github.com/sivchari/containedctx v1.0.3 // indirect
|
||||
github.com/sonatard/noctx v0.5.1 // indirect
|
||||
github.com/sourcegraph/go-diff v0.8.0 // indirect
|
||||
github.com/sonatard/noctx v0.4.0 // indirect
|
||||
github.com/sourcegraph/go-diff v0.7.0 // indirect
|
||||
github.com/spf13/afero v1.15.0 // indirect
|
||||
github.com/spf13/cast v1.5.0 // indirect
|
||||
github.com/spf13/cobra v1.10.2 // indirect
|
||||
|
|
@ -269,20 +259,20 @@ require (
|
|||
github.com/spf13/viper v1.12.0 // indirect
|
||||
github.com/ssgreg/nlreturn/v2 v2.2.1 // indirect
|
||||
github.com/stbenjam/no-sprintf-host-port v0.3.1 // indirect
|
||||
github.com/stretchr/objx v0.5.3 // indirect
|
||||
github.com/stretchr/testify v1.12.1 // indirect
|
||||
github.com/stretchr/objx v0.5.2 // indirect
|
||||
github.com/stretchr/testify v1.11.1 // indirect
|
||||
github.com/subosito/gotenv v1.4.1 // indirect
|
||||
github.com/tetafro/godot v1.5.6 // indirect
|
||||
github.com/timakin/bodyclose v0.0.0-20260129054331-73d1f95b84b4 // indirect
|
||||
github.com/tetafro/godot v1.5.4 // indirect
|
||||
github.com/timakin/bodyclose v0.0.0-20241222091800-1db5c5ca4d67 // indirect
|
||||
github.com/timonwong/loggercheck v0.11.0 // indirect
|
||||
github.com/tomarrell/wrapcheck/v2 v2.12.0 // indirect
|
||||
github.com/tommy-muehle/go-mnd/v2 v2.5.1 // indirect
|
||||
github.com/ulikunitz/xz v0.5.16 // indirect
|
||||
github.com/ulikunitz/xz v0.5.15 // indirect
|
||||
github.com/ultraware/funlen v0.2.0 // indirect
|
||||
github.com/ultraware/whitespace v0.2.0 // indirect
|
||||
github.com/urfave/cli/v2 v2.3.0 // indirect
|
||||
github.com/uudashr/gocognit v1.2.1 // indirect
|
||||
github.com/uudashr/iface v1.5.0 // indirect
|
||||
github.com/uudashr/gocognit v1.2.0 // indirect
|
||||
github.com/uudashr/iface v1.4.1 // indirect
|
||||
github.com/xen0n/gosmopolitan v1.3.0 // indirect
|
||||
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
|
||||
github.com/yagipy/maintidx v1.0.0 // indirect
|
||||
|
|
@ -290,40 +280,40 @@ require (
|
|||
github.com/ykadowak/zerologlint v0.1.5 // indirect
|
||||
gitlab.com/bosi/decorder v0.4.2 // indirect
|
||||
go-simpler.org/musttag v0.14.0 // indirect
|
||||
go-simpler.org/sloglint v0.12.0 // indirect
|
||||
go-simpler.org/sloglint v0.11.1 // indirect
|
||||
go.augendre.info/arangolint v0.4.0 // indirect
|
||||
go.augendre.info/fatcontext v0.10.0 // indirect
|
||||
go.augendre.info/fatcontext v0.9.0 // indirect
|
||||
go.opentelemetry.io/auto/sdk v1.2.1 // indirect
|
||||
go.opentelemetry.io/otel v1.44.0 // indirect
|
||||
go.opentelemetry.io/otel/metric v1.44.0 // indirect
|
||||
go.opentelemetry.io/otel/sdk v1.44.0 // indirect
|
||||
go.opentelemetry.io/otel/sdk/metric v1.44.0 // indirect
|
||||
go.opentelemetry.io/otel/trace v1.44.0 // indirect
|
||||
go.opentelemetry.io/otel v1.41.0 // indirect
|
||||
go.opentelemetry.io/otel/metric v1.41.0 // indirect
|
||||
go.opentelemetry.io/otel/sdk v1.41.0 // indirect
|
||||
go.opentelemetry.io/otel/sdk/metric v1.41.0 // indirect
|
||||
go.opentelemetry.io/otel/trace v1.41.0 // indirect
|
||||
go.uber.org/multierr v1.11.0 // indirect
|
||||
go.uber.org/zap v1.27.1 // indirect
|
||||
go.yaml.in/yaml/v2 v2.4.4 // indirect
|
||||
go.yaml.in/yaml/v3 v3.0.5 // indirect
|
||||
golang.org/x/crypto v0.55.0 // indirect
|
||||
go.yaml.in/yaml/v2 v2.4.3 // indirect
|
||||
go.yaml.in/yaml/v3 v3.0.4 // indirect
|
||||
golang.org/x/crypto v0.48.0 // indirect
|
||||
golang.org/x/exp v0.0.0-20260218203240-3dfff04db8fa // indirect
|
||||
golang.org/x/exp/typeparams v0.0.0-20260811152304-ee035b5b010f // indirect
|
||||
golang.org/x/mod v0.40.0 // indirect
|
||||
golang.org/x/net v0.58.0 // indirect
|
||||
golang.org/x/oauth2 v0.36.0 // indirect
|
||||
golang.org/x/sys v0.47.0 // indirect
|
||||
golang.org/x/text v0.41.0 // indirect
|
||||
golang.org/x/tools v0.49.0 // indirect
|
||||
golang.org/x/exp/typeparams v0.0.0-20260209203927-2842357ff358 // indirect
|
||||
golang.org/x/mod v0.33.0 // indirect
|
||||
golang.org/x/net v0.51.0 // indirect
|
||||
golang.org/x/oauth2 v0.35.0 // indirect
|
||||
golang.org/x/sys v0.42.0 // indirect
|
||||
golang.org/x/text v0.34.0 // indirect
|
||||
golang.org/x/tools v0.42.0 // indirect
|
||||
golang.org/x/xerrors v0.0.0-20240903120638-7835f813f4da // indirect
|
||||
google.golang.org/api v0.288.0 // indirect
|
||||
google.golang.org/genproto/googleapis/rpc v0.0.0-20260706201446-f0a921348800 // indirect
|
||||
google.golang.org/grpc v1.83.2 // indirect
|
||||
google.golang.org/api v0.269.0 // indirect
|
||||
google.golang.org/genproto/googleapis/rpc v0.0.0-20260226221140-a57be14db171 // indirect
|
||||
google.golang.org/grpc v1.79.1 // indirect
|
||||
gopkg.in/ini.v1 v1.67.0 // indirect
|
||||
gopkg.in/yaml.v2 v2.4.0 // indirect
|
||||
honnef.co/go/tools v0.8.0 // indirect
|
||||
modernc.org/libc v1.75.6 // indirect
|
||||
honnef.co/go/tools v0.7.0 // indirect
|
||||
modernc.org/libc v1.72.0 // indirect
|
||||
modernc.org/mathutil v1.7.1 // indirect
|
||||
modernc.org/memory v1.12.1 // indirect
|
||||
mvdan.cc/gofumpt v0.11.0 // indirect
|
||||
mvdan.cc/unparam v0.0.0-20260818115549-3f964bcb5673 // indirect
|
||||
modernc.org/memory v1.11.0 // indirect
|
||||
mvdan.cc/gofumpt v0.9.2 // indirect
|
||||
mvdan.cc/unparam v0.0.0-20251027182757-5beb8c8f8f15 // indirect
|
||||
sigs.k8s.io/yaml v1.6.0 // indirect
|
||||
)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,109 +0,0 @@
|
|||
// Package accesslog writes proxy activity as JSON Lines.
|
||||
package accesslog
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net/url"
|
||||
"os"
|
||||
"sync"
|
||||
"time"
|
||||
)
|
||||
|
||||
const (
|
||||
accessLogFileMode os.FileMode = 0o600
|
||||
|
||||
// EventRequest identifies the response sent by the proxy to a client.
|
||||
EventRequest = "request"
|
||||
// EventUpstream identifies one HTTP exchange with an upstream service.
|
||||
EventUpstream = "upstream"
|
||||
)
|
||||
|
||||
type requestIDKey struct{}
|
||||
|
||||
// Entry is one proxy activity record.
|
||||
type Entry struct {
|
||||
Time time.Time `json:"time"`
|
||||
Event string `json:"event"`
|
||||
RequestID string `json:"request_id,omitempty"`
|
||||
Method string `json:"method"`
|
||||
Path string `json:"path,omitempty"`
|
||||
URL string `json:"url,omitempty"`
|
||||
StatusCode int `json:"status_code,omitempty"`
|
||||
DurationMS int64 `json:"duration_ms"`
|
||||
RemoteAddr string `json:"remote_addr,omitempty"`
|
||||
Error string `json:"error,omitempty"`
|
||||
}
|
||||
|
||||
// Logger appends complete JSON objects to a file, one per line.
|
||||
type Logger struct {
|
||||
mu sync.Mutex
|
||||
file *os.File
|
||||
encoder *json.Encoder
|
||||
}
|
||||
|
||||
// Open opens path for append, creating it with owner-only permissions when needed.
|
||||
func Open(path string) (*Logger, error) {
|
||||
file, err := os.OpenFile(path, os.O_APPEND|os.O_CREATE|os.O_WRONLY, accessLogFileMode)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("opening access log: %w", err)
|
||||
}
|
||||
|
||||
return &Logger{
|
||||
file: file,
|
||||
encoder: json.NewEncoder(file),
|
||||
}, nil
|
||||
}
|
||||
|
||||
// Write appends an entry to the log.
|
||||
func (l *Logger) Write(entry Entry) error {
|
||||
if entry.Time.IsZero() {
|
||||
entry.Time = time.Now().UTC()
|
||||
}
|
||||
|
||||
l.mu.Lock()
|
||||
defer l.mu.Unlock()
|
||||
|
||||
if err := l.encoder.Encode(entry); err != nil {
|
||||
return fmt.Errorf("writing access log: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// Close closes the log file after any active writer finishes.
|
||||
func (l *Logger) Close() error {
|
||||
l.mu.Lock()
|
||||
defer l.mu.Unlock()
|
||||
|
||||
if err := l.file.Close(); err != nil {
|
||||
return fmt.Errorf("closing access log: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// WithRequestID stores a proxy request ID in ctx.
|
||||
func WithRequestID(ctx context.Context, requestID string) context.Context {
|
||||
return context.WithValue(ctx, requestIDKey{}, requestID)
|
||||
}
|
||||
|
||||
// RequestID returns the proxy request ID stored in ctx.
|
||||
func RequestID(ctx context.Context) string {
|
||||
requestID, _ := ctx.Value(requestIDKey{}).(string)
|
||||
return requestID
|
||||
}
|
||||
|
||||
// URLWithoutSecrets returns a URL without user information, query values, or fragments.
|
||||
func URLWithoutSecrets(value *url.URL) string {
|
||||
if value == nil {
|
||||
return ""
|
||||
}
|
||||
|
||||
clean := *value
|
||||
clean.User = nil
|
||||
clean.RawQuery = ""
|
||||
clean.ForceQuery = false
|
||||
clean.Fragment = ""
|
||||
clean.RawFragment = ""
|
||||
return clean.String()
|
||||
}
|
||||
|
|
@ -1,91 +0,0 @@
|
|||
package accesslog
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"net/url"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"sync"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestLoggerWritesJSONLines(t *testing.T) {
|
||||
path := filepath.Join(t.TempDir(), "access.jsonl")
|
||||
logger, err := Open(path)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
const entries = 20
|
||||
var wg sync.WaitGroup
|
||||
for range entries {
|
||||
wg.Add(1)
|
||||
go func() {
|
||||
defer wg.Done()
|
||||
if err := logger.Write(Entry{
|
||||
Event: EventUpstream,
|
||||
RequestID: "request-id",
|
||||
Method: "GET",
|
||||
URL: "https://registry.example/packages/example",
|
||||
StatusCode: 429,
|
||||
}); err != nil {
|
||||
t.Errorf("Write: %v", err)
|
||||
}
|
||||
}()
|
||||
}
|
||||
wg.Wait()
|
||||
|
||||
if err := logger.Close(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
file, err := os.Open(path)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer func() { _ = file.Close() }()
|
||||
|
||||
scanner := bufio.NewScanner(file)
|
||||
count := 0
|
||||
for scanner.Scan() {
|
||||
var entry Entry
|
||||
if err := json.Unmarshal(scanner.Bytes(), &entry); err != nil {
|
||||
t.Fatalf("line %d is not JSON: %v", count+1, err)
|
||||
}
|
||||
if entry.Time.IsZero() {
|
||||
t.Errorf("line %d has no time", count+1)
|
||||
}
|
||||
if entry.StatusCode != 429 {
|
||||
t.Errorf("line %d status_code = %d, want 429", count+1, entry.StatusCode)
|
||||
}
|
||||
count++
|
||||
}
|
||||
if err := scanner.Err(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if count != entries {
|
||||
t.Errorf("lines = %d, want %d", count, entries)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRequestID(t *testing.T) {
|
||||
ctx := WithRequestID(context.Background(), "abc-123")
|
||||
if got := RequestID(ctx); got != "abc-123" {
|
||||
t.Errorf("RequestID = %q, want %q", got, "abc-123")
|
||||
}
|
||||
}
|
||||
|
||||
func TestURLWithoutSecrets(t *testing.T) {
|
||||
value, err := url.Parse("https://user:password@registry.example/package.tgz?token=secret#fragment")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
got := URLWithoutSecrets(value)
|
||||
want := "https://registry.example/package.tgz"
|
||||
if got != want {
|
||||
t.Errorf("URLWithoutSecrets = %q, want %q", got, want)
|
||||
}
|
||||
}
|
||||
|
|
@ -24,22 +24,10 @@
|
|||
// storage:
|
||||
// url: "s3://bucket?endpoint=http://localhost:9000"
|
||||
//
|
||||
// Google Cloud Storage:
|
||||
//
|
||||
// storage:
|
||||
// url: "gs://bucket-name"
|
||||
//
|
||||
// For S3, configure credentials via AWS environment variables:
|
||||
//
|
||||
// AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION
|
||||
//
|
||||
// For GCS, authentication uses Application Default Credentials. This supports
|
||||
// GKE Workload Identity, attached service accounts on GCE and Cloud Run, and
|
||||
// local credentials created by `gcloud auth application-default login`.
|
||||
// When direct_serve is enabled without a private key, the GCS backend uses the
|
||||
// IAM Credentials signBlob API. The service account must hold
|
||||
// roles/iam.serviceAccountTokenCreator on itself.
|
||||
//
|
||||
// Database Configuration:
|
||||
//
|
||||
// The proxy supports two database backends:
|
||||
|
|
@ -66,37 +54,23 @@ import (
|
|||
"net/url"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"sort"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/purl"
|
||||
"gopkg.in/yaml.v3"
|
||||
)
|
||||
|
||||
// DefaultSwiftUpstream is the Swift Package Registry used when none is configured.
|
||||
const DefaultSwiftUpstream = "https://tuist.dev/api/registry/swift"
|
||||
|
||||
// Config holds all configuration for the proxy server.
|
||||
type Config struct {
|
||||
// Listen is the address to listen on (e.g., ":8080", "127.0.0.1:8080").
|
||||
Listen string `json:"listen" yaml:"listen"`
|
||||
|
||||
// BaseURL is the public URL where package endpoints are reachable.
|
||||
// Used for rewriting package metadata URLs and shown to humans on the
|
||||
// install guide so they know what to point their package manager at.
|
||||
// BaseURL is the public URL where this proxy is accessible.
|
||||
// Used for rewriting package metadata URLs.
|
||||
// Example: "https://proxy.example.com" or "http://localhost:8080"
|
||||
BaseURL string `json:"base_url" yaml:"base_url"`
|
||||
|
||||
// UIBaseURL is the public URL where the web UI is reachable. Defaults to
|
||||
// BaseURL when unset. Set this separately when the UI is served on a
|
||||
// different hostname than the package endpoints — for example, the UI on a
|
||||
// public domain behind auth while build machines hit a Docker network alias
|
||||
// for the package endpoints.
|
||||
// Example: "https://proxy.example.com/ui"
|
||||
UIBaseURL string `json:"ui_base_url" yaml:"ui_base_url"`
|
||||
|
||||
// Storage configures artifact storage.
|
||||
Storage StorageConfig `json:"storage" yaml:"storage"`
|
||||
|
||||
|
|
@ -106,19 +80,12 @@ type Config struct {
|
|||
// Log configures logging.
|
||||
Log LogConfig `json:"log" yaml:"log"`
|
||||
|
||||
// AccessLog configures the JSONL activity log.
|
||||
AccessLog AccessLogConfig `json:"access_log" yaml:"access_log"`
|
||||
|
||||
// Upstream configures upstream registry URLs (optional overrides).
|
||||
Upstream UpstreamConfig `json:"upstream" yaml:"upstream"`
|
||||
|
||||
// Cooldown configures version age filtering to mitigate supply chain attacks.
|
||||
Cooldown CooldownConfig `json:"cooldown" yaml:"cooldown"`
|
||||
|
||||
// Scanning configures pre-cache artifact scanning (trivy, ClamAV, Wiz,
|
||||
// or a custom service) to mitigate supply chain attacks.
|
||||
Scanning ScanningConfig `json:"scanning" yaml:"scanning"`
|
||||
|
||||
// CacheMetadata enables caching of upstream metadata responses for offline fallback.
|
||||
// When enabled, metadata is stored in the database and storage backend.
|
||||
// The mirror command always enables this regardless of this setting.
|
||||
|
|
@ -129,28 +96,12 @@ type Config struct {
|
|||
// Default: "5m". Set to "0" to always revalidate.
|
||||
MetadataTTL string `json:"metadata_ttl" yaml:"metadata_ttl"`
|
||||
|
||||
// MetadataMaxSize is the maximum size of an upstream metadata response
|
||||
// the proxy will buffer (e.g. "100MB", "250MB"). Responses over this
|
||||
// size return ErrMetadataTooLarge. Default: "100MB".
|
||||
MetadataMaxSize string `json:"metadata_max_size" yaml:"metadata_max_size"`
|
||||
|
||||
// HTTPTimeout is the timeout for individual upstream HTTP requests made
|
||||
// by protocol handlers (metadata fetches, pass-through file requests).
|
||||
// Uses Go duration syntax (e.g. "30s", "2m"). Default: "30s".
|
||||
// Set to "0" to disable the timeout entirely. Independently of this
|
||||
// setting, the shared transport gives up on an upstream that has not sent
|
||||
// response headers within 60 seconds.
|
||||
HTTPTimeout string `json:"http_timeout" yaml:"http_timeout"`
|
||||
|
||||
// MirrorAPI enables the /api/mirror endpoints for starting mirror jobs via HTTP.
|
||||
// Disabled by default to prevent unauthenticated users from triggering downloads.
|
||||
MirrorAPI bool `json:"mirror_api" yaml:"mirror_api"`
|
||||
|
||||
// Gradle configures Gradle HttpBuildCache behavior.
|
||||
Gradle GradleConfig `json:"gradle" yaml:"gradle"`
|
||||
|
||||
// Health configures the /health endpoint behavior.
|
||||
Health HealthConfig `json:"health" yaml:"health"`
|
||||
}
|
||||
|
||||
// CooldownConfig configures version cooldown periods.
|
||||
|
|
@ -163,172 +114,9 @@ type CooldownConfig struct {
|
|||
Ecosystems map[string]string `json:"ecosystems" yaml:"ecosystems"`
|
||||
|
||||
// Packages overrides the cooldown for specific packages (keyed by PURL).
|
||||
// Valid PURL keys are normalized to canonical form before use.
|
||||
Packages map[string]string `json:"packages" yaml:"packages"`
|
||||
}
|
||||
|
||||
// NormalizedPackages returns a copy of the package overrides with valid PURL
|
||||
// keys in canonical form. An explicitly canonical key wins over an equivalent
|
||||
// noncanonical key, and invalid keys are preserved unchanged.
|
||||
func (c *CooldownConfig) NormalizedPackages() map[string]string {
|
||||
if c == nil || c.Packages == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
keys := make([]string, 0, len(c.Packages))
|
||||
for key := range c.Packages {
|
||||
keys = append(keys, key)
|
||||
}
|
||||
sort.Strings(keys)
|
||||
|
||||
normalized := make(map[string]string, len(c.Packages))
|
||||
for _, key := range keys {
|
||||
canonical := key
|
||||
if parsed, err := purl.Parse(key); err == nil {
|
||||
canonical = parsed.String()
|
||||
}
|
||||
if _, exists := normalized[canonical]; exists && key != canonical {
|
||||
continue
|
||||
}
|
||||
normalized[canonical] = c.Packages[key]
|
||||
}
|
||||
return normalized
|
||||
}
|
||||
|
||||
// ScanningConfig configures pre-cache artifact scanning (e.g. trivy,
|
||||
// ClamAV, Wiz, or a custom service) to mitigate supply chain attacks.
|
||||
// Unlike Cooldown, which only looks at a version's publish timestamp,
|
||||
// scanning inspects the actual artifact bytes before they become
|
||||
// servable from cache.
|
||||
type ScanningConfig struct {
|
||||
// Enabled turns on the scan gate. When false (default), artifacts are
|
||||
// cached exactly as if scanning didn't exist.
|
||||
Enabled bool `json:"enabled" yaml:"enabled"`
|
||||
|
||||
// FailOpen treats scanner errors and timeouts as an allow verdict
|
||||
// instead of a block. Default is fail-closed, since the default
|
||||
// posture for a security gate should block on infrastructure failure.
|
||||
FailOpen bool `json:"fail_open" yaml:"fail_open"`
|
||||
|
||||
// Timeout bounds each scan call. Uses Go duration syntax (e.g. "30s").
|
||||
// Default: "30s".
|
||||
Timeout string `json:"timeout" yaml:"timeout"`
|
||||
|
||||
// SigningKey authenticates pull requests to the internal scan-fetch
|
||||
// route used by every storage backend. Required whenever Enabled is
|
||||
// true. Supports ${VAR_NAME} expansion like AuthConfig fields.
|
||||
SigningKey string `json:"signing_key" yaml:"signing_key"`
|
||||
|
||||
// FetchBaseURL is the address scanners use to reach this proxy to pull
|
||||
// staged artifacts. Defaults to BaseURL. Set this separately when
|
||||
// scanners reach the proxy over an internal address different from the
|
||||
// public-facing BaseURL (mirrors DirectServeBaseURL/UIBaseURL).
|
||||
FetchBaseURL string `json:"fetch_base_url" yaml:"fetch_base_url"`
|
||||
|
||||
// Scanners is the list of external scanning services to call.
|
||||
Scanners []ScannerConfig `json:"scanners" yaml:"scanners"`
|
||||
}
|
||||
|
||||
// ScannerConfig configures a single external scanning service.
|
||||
type ScannerConfig struct {
|
||||
// Name identifies this scanner in logs and metrics.
|
||||
Name string `json:"name" yaml:"name"`
|
||||
|
||||
// URL is the endpoint the proxy POSTs scan notifications to.
|
||||
URL string `json:"url" yaml:"url"`
|
||||
|
||||
// Mode is "block" (default) or "monitor". A "block" scanner's verdict
|
||||
// can prevent caching; a "monitor" scanner's findings are logged but
|
||||
// never gate caching.
|
||||
Mode string `json:"mode" yaml:"mode"`
|
||||
|
||||
// Ecosystems restricts this scanner to specific ecosystems (e.g.
|
||||
// "npm", "pypi"). Empty means all ecosystems.
|
||||
Ecosystems []string `json:"ecosystems" yaml:"ecosystems"`
|
||||
|
||||
// Headers are additional HTTP headers sent with every scan request
|
||||
// (e.g. for authenticating to the scanner service). Values support
|
||||
// ${VAR_NAME} expansion like AuthConfig fields.
|
||||
Headers map[string]string `json:"headers" yaml:"headers"`
|
||||
}
|
||||
|
||||
// SigningKeyExpanded returns SigningKey with ${VAR_NAME} references expanded.
|
||||
func (s *ScanningConfig) SigningKeyExpanded() string {
|
||||
return expandEnv(s.SigningKey)
|
||||
}
|
||||
|
||||
// HeadersExpanded returns Headers with ${VAR_NAME} references expanded in
|
||||
// each value.
|
||||
func (s *ScannerConfig) HeadersExpanded() map[string]string {
|
||||
if len(s.Headers) == 0 {
|
||||
return nil
|
||||
}
|
||||
expanded := make(map[string]string, len(s.Headers))
|
||||
for k, v := range s.Headers {
|
||||
expanded[k] = expandEnv(v)
|
||||
}
|
||||
return expanded
|
||||
}
|
||||
|
||||
// Validate checks the scanning configuration for errors, applying the
|
||||
// default timeout if unset.
|
||||
func (s *ScanningConfig) Validate() error {
|
||||
if !s.Enabled {
|
||||
return nil
|
||||
}
|
||||
|
||||
if s.SigningKeyExpanded() == "" {
|
||||
return fmt.Errorf("scanning.signing_key is required when scanning.enabled is true")
|
||||
}
|
||||
|
||||
if len(s.Scanners) == 0 {
|
||||
return fmt.Errorf("scanning.scanners must not be empty when scanning.enabled is true")
|
||||
}
|
||||
|
||||
if s.FetchBaseURL != "" {
|
||||
if err := validateAbsoluteURL("scanning.fetch_base_url", s.FetchBaseURL); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
if s.Timeout == "" {
|
||||
s.Timeout = defaultScanningTimeoutStr
|
||||
}
|
||||
if d, err := time.ParseDuration(s.Timeout); err != nil {
|
||||
return fmt.Errorf("invalid scanning.timeout %q: %w", s.Timeout, err)
|
||||
} else if d <= 0 {
|
||||
return fmt.Errorf("invalid scanning.timeout %q: must be > 0", s.Timeout)
|
||||
}
|
||||
|
||||
for i := range s.Scanners {
|
||||
if err := s.Scanners[i].Validate(); err != nil {
|
||||
return fmt.Errorf("scanning.scanners[%d]: %w", i, err)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Validate checks a single scanner's configuration, applying the default
|
||||
// mode ("block") if unset.
|
||||
func (s *ScannerConfig) Validate() error {
|
||||
if s.Name == "" {
|
||||
return fmt.Errorf("name is required")
|
||||
}
|
||||
if err := validateAbsoluteURL("url", s.URL); err != nil {
|
||||
return err
|
||||
}
|
||||
if s.Mode == "" {
|
||||
s.Mode = "block"
|
||||
}
|
||||
switch s.Mode {
|
||||
case "block", "monitor":
|
||||
default:
|
||||
return fmt.Errorf("invalid mode %q (must be block or monitor)", s.Mode)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// StorageConfig configures artifact storage.
|
||||
type StorageConfig struct {
|
||||
// URL is the storage backend URL.
|
||||
|
|
@ -336,8 +124,6 @@ type StorageConfig struct {
|
|||
// - file:///path/to/dir - Local filesystem (default)
|
||||
// - s3://bucket-name - Amazon S3
|
||||
// - s3://bucket?endpoint=http://localhost:9000 - S3-compatible (MinIO)
|
||||
// - gs://bucket-name - Google Cloud Storage (Workload Identity supported)
|
||||
// - azblob://container-name - Azure Blob Storage
|
||||
// If empty, defaults to file:// with the Path value.
|
||||
URL string `json:"url" yaml:"url"`
|
||||
|
||||
|
|
@ -354,7 +140,7 @@ type StorageConfig struct {
|
|||
|
||||
// DirectServe enables redirecting cached artifact downloads to presigned
|
||||
// storage URLs (HTTP 302) instead of streaming bytes through the proxy.
|
||||
// Only effective for backends that support URL signing (S3, GCS, Azure).
|
||||
// Only effective for backends that support URL signing (S3, Azure).
|
||||
DirectServe bool `json:"direct_serve" yaml:"direct_serve"`
|
||||
|
||||
// DirectServeTTL is how long presigned URLs remain valid.
|
||||
|
|
@ -396,14 +182,6 @@ type GradleBuildCacheConfig struct {
|
|||
SweepInterval string `json:"sweep_interval" yaml:"sweep_interval"`
|
||||
}
|
||||
|
||||
// HealthConfig configures the /health endpoint.
|
||||
type HealthConfig struct {
|
||||
// StorageProbeInterval is the minimum time between storage backend probes.
|
||||
// Uses Go duration syntax (e.g. "30s", "1m"). Default: "30s".
|
||||
// Set to "0" to probe on every /health request (useful for low-traffic deployments).
|
||||
StorageProbeInterval string `json:"storage_probe_interval" yaml:"storage_probe_interval"`
|
||||
}
|
||||
|
||||
// DatabaseConfig configures the cache database.
|
||||
type DatabaseConfig struct {
|
||||
// Driver is the database driver: "sqlite" or "postgres".
|
||||
|
|
@ -416,21 +194,6 @@ type DatabaseConfig struct {
|
|||
URL string `json:"url" yaml:"url"`
|
||||
}
|
||||
|
||||
// String returns a human-readable description of the configured database
|
||||
// suitable for logging. For postgres the password in the connection URL is
|
||||
// redacted; if the URL cannot be parsed only the driver name is returned to
|
||||
// avoid leaking credentials.
|
||||
func (d DatabaseConfig) String() string {
|
||||
if d.Driver == "postgres" {
|
||||
u, err := url.Parse(d.URL)
|
||||
if err != nil || u.Host == "" {
|
||||
return "postgres"
|
||||
}
|
||||
return u.Redacted()
|
||||
}
|
||||
return d.Path
|
||||
}
|
||||
|
||||
// LogConfig configures logging.
|
||||
type LogConfig struct {
|
||||
// Level is the minimum log level: "debug", "info", "warn", "error".
|
||||
|
|
@ -440,32 +203,13 @@ type LogConfig struct {
|
|||
Format string `json:"format" yaml:"format"`
|
||||
}
|
||||
|
||||
// AccessLogConfig configures the JSONL activity log.
|
||||
type AccessLogConfig struct {
|
||||
// Path is the file to append activity records to. Empty disables the access log.
|
||||
Path string `json:"path" yaml:"path"`
|
||||
}
|
||||
|
||||
// UpstreamConfig configures upstream URLs for built-in routes and authentication.
|
||||
// UpstreamConfig configures upstream registry URLs and authentication.
|
||||
// Leave empty to use defaults.
|
||||
type UpstreamConfig struct {
|
||||
// AllowPrivateHosts permits listed upstream hosts to resolve to private addresses.
|
||||
AllowPrivateHosts []string `json:"allow_private_hosts" yaml:"allow_private_hosts"`
|
||||
|
||||
// AllowLoopback permits upstream requests and redirects to loopback addresses.
|
||||
AllowLoopback bool `json:"allow_loopback" yaml:"allow_loopback"`
|
||||
|
||||
// NPM is the upstream npm registry URL.
|
||||
// Default: https://registry.npmjs.org
|
||||
NPM string `json:"npm" yaml:"npm"`
|
||||
|
||||
// NPMFullMetadata always requests the full packument (application/json)
|
||||
// from the npm upstream, so served metadata carries the "time" map even
|
||||
// when cooldown is disabled. Clients that gate on publish age (for
|
||||
// example Yarn's npmMinimalAgeGate) need this.
|
||||
// Default: false (the abbreviated format is preferred).
|
||||
NPMFullMetadata bool `json:"npm_full_metadata" yaml:"npm_full_metadata"`
|
||||
|
||||
// Cargo is the upstream cargo index URL.
|
||||
// Default: https://index.crates.io
|
||||
Cargo string `json:"cargo" yaml:"cargo"`
|
||||
|
|
@ -474,148 +218,24 @@ type UpstreamConfig struct {
|
|||
// Default: https://static.crates.io/crates
|
||||
CargoDownload string `json:"cargo_download" yaml:"cargo_download"`
|
||||
|
||||
// Gem is the upstream RubyGems registry URL.
|
||||
// Default: https://rubygems.org
|
||||
Gem string `json:"gem" yaml:"gem"`
|
||||
|
||||
// Go is the upstream Go module proxy URL.
|
||||
// Default: https://proxy.golang.org
|
||||
Go string `json:"go" yaml:"go"`
|
||||
|
||||
// Hex is the upstream Hex repository URL.
|
||||
// Default: https://repo.hex.pm
|
||||
Hex string `json:"hex" yaml:"hex"`
|
||||
|
||||
// HexAPI is the upstream Hex API URL used for package timestamps.
|
||||
// Default: https://hex.pm
|
||||
HexAPI string `json:"hex_api" yaml:"hex_api"`
|
||||
|
||||
// Pub is the upstream pub registry URL.
|
||||
// Default: https://pub.dev
|
||||
Pub string `json:"pub" yaml:"pub"`
|
||||
|
||||
// PyPI is the upstream PyPI index and API URL.
|
||||
// Default: https://pypi.org
|
||||
PyPI string `json:"pypi" yaml:"pypi"`
|
||||
|
||||
// PyPIDownload is the upstream PyPI package download URL.
|
||||
// Default: https://files.pythonhosted.org
|
||||
PyPIDownload string `json:"pypi_download" yaml:"pypi_download"`
|
||||
|
||||
// Maven is the upstream Maven repository URL.
|
||||
// Default: https://repo1.maven.org/maven2
|
||||
Maven string `json:"maven" yaml:"maven"`
|
||||
|
||||
// GradlePluginPortal is the upstream Gradle Plugin Portal Maven URL.
|
||||
// Used to resolve Gradle plugin marker artifacts.
|
||||
// Default: https://plugins.gradle.org/m2
|
||||
GradlePluginPortal string `json:"gradle_plugin_portal" yaml:"gradle_plugin_portal"`
|
||||
|
||||
// NuGet is the upstream NuGet API URL.
|
||||
// Default: https://api.nuget.org
|
||||
NuGet string `json:"nuget" yaml:"nuget"`
|
||||
|
||||
// NuGetSearch is the upstream NuGet search API URL.
|
||||
// Default: https://azuresearch-usnc.nuget.org
|
||||
NuGetSearch string `json:"nuget_search" yaml:"nuget_search"`
|
||||
|
||||
// Composer is the upstream Packagist API URL.
|
||||
// Default: https://packagist.org
|
||||
Composer string `json:"composer" yaml:"composer"`
|
||||
|
||||
// ComposerRepository is the upstream Packagist repository URL.
|
||||
// Default: https://repo.packagist.org
|
||||
ComposerRepository string `json:"composer_repository" yaml:"composer_repository"`
|
||||
|
||||
// Conan is the upstream Conan registry URL.
|
||||
// Default: https://center.conan.io
|
||||
Conan string `json:"conan" yaml:"conan"`
|
||||
|
||||
// Conda is the upstream Conda channel base URL.
|
||||
// Default: https://conda.anaconda.org
|
||||
Conda string `json:"conda" yaml:"conda"`
|
||||
|
||||
// CRAN is the upstream CRAN mirror URL.
|
||||
// Default: https://cloud.r-project.org
|
||||
CRAN string `json:"cran" yaml:"cran"`
|
||||
|
||||
// Julia is the upstream Julia package server URL.
|
||||
// Default: https://pkg.julialang.org
|
||||
Julia string `json:"julia" yaml:"julia"`
|
||||
|
||||
// OCIDefault is the default upstream OCI registry URL.
|
||||
// Default: https://registry-1.docker.io
|
||||
OCIDefault string `json:"oci_default" yaml:"oci_default"`
|
||||
|
||||
// Swift is the upstream Swift Package Registry URL.
|
||||
// Default: https://tuist.dev/api/registry/swift
|
||||
Swift string `json:"swift" yaml:"swift"`
|
||||
|
||||
// Debian is the upstream APT repository base URL.
|
||||
// Example: http://archive.ubuntu.com/ubuntu would get Ubuntu.
|
||||
// Default: http://deb.debian.org/debian
|
||||
Debian string `json:"debian" yaml:"debian"`
|
||||
|
||||
// RPM is the upstream RPM repository base URL.
|
||||
// Default: https://dl.fedoraproject.org/pub/fedora/linux
|
||||
RPM string `json:"rpm" yaml:"rpm"`
|
||||
|
||||
// HomebrewAPI is the upstream Homebrew JSON API URL.
|
||||
// Default: https://formulae.brew.sh/api
|
||||
HomebrewAPI string `json:"homebrew_api" yaml:"homebrew_api"`
|
||||
|
||||
// HomebrewArtifact is the upstream registry URL for Homebrew artifacts.
|
||||
// Default: https://ghcr.io
|
||||
HomebrewArtifact string `json:"homebrew_artifact" yaml:"homebrew_artifact"`
|
||||
|
||||
// Helm maps repository names to HTTP Helm chart repository URLs.
|
||||
// Requests use /helm/{name}/index.yaml and chart URLs in the index are
|
||||
// rewritten to the same named proxy endpoint.
|
||||
Helm map[string]string `json:"helm" yaml:"helm"`
|
||||
|
||||
// APK maps repository names to Alpine APK repository base URLs, served
|
||||
// at /apk/{name}/. The remaining request path mirrors the upstream
|
||||
// layout, e.g. /apk/alpine/v3.22/main/x86_64/APKINDEX.tar.gz.
|
||||
// Default when empty: {"alpine": "https://dl-cdn.alpinelinux.org/alpine"}.
|
||||
APK map[string]string `json:"apk" yaml:"apk"`
|
||||
|
||||
// OCI maps names to OCI registry URLs. Requests to a named registry use
|
||||
// the repository prefix upstream/{name}/, for example
|
||||
// oci://proxy.example.com/upstream/ghcr/owner/chart.
|
||||
OCI map[string]string `json:"oci" yaml:"oci"`
|
||||
|
||||
// Generic maps names to plain HTTP upstream base URLs, served at
|
||||
// /generic/{name}/. The remaining request path and query string are
|
||||
// appended to the upstream URL. GitHub release asset paths
|
||||
// ({owner}/{repo}/releases/download/{tag}/{asset}) are cached in the
|
||||
// artifact cache; everything else goes through the metadata cache.
|
||||
// Example: {"github": "https://github.com", "github-api": "https://api.github.com"}.
|
||||
Generic map[string]string `json:"generic" yaml:"generic"`
|
||||
|
||||
// Auth configures authentication for upstream registries.
|
||||
// Keys are absolute URL scopes matched by scheme, host, effective port,
|
||||
// and path-segment prefix.
|
||||
// Keys are URL prefixes that are matched against request URLs.
|
||||
// Example: "https://npm.pkg.github.com" matches all requests to that host.
|
||||
Auth map[string]AuthConfig `json:"auth" yaml:"auth"`
|
||||
}
|
||||
|
||||
// AuthForURL returns the auth config that matches the given URL.
|
||||
// The longest matching URL scope wins.
|
||||
// Matches are based on URL prefix - the longest matching prefix wins.
|
||||
func (u *UpstreamConfig) AuthForURL(url string) *AuthConfig {
|
||||
if u.Auth == nil {
|
||||
return nil
|
||||
}
|
||||
target, err := parseAuthURL(url)
|
||||
if err != nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
var bestMatch *AuthConfig
|
||||
var bestLen int
|
||||
|
||||
for pattern, auth := range u.Auth {
|
||||
configured, err := parseAuthURL(pattern)
|
||||
if err == nil && authURLMatches(configured, target) && len(pattern) > bestLen {
|
||||
if strings.HasPrefix(url, pattern) && len(pattern) > bestLen {
|
||||
a := auth // copy to avoid loop variable capture
|
||||
bestMatch = &a
|
||||
bestLen = len(pattern)
|
||||
|
|
@ -625,82 +245,9 @@ func (u *UpstreamConfig) AuthForURL(url string) *AuthConfig {
|
|||
return bestMatch
|
||||
}
|
||||
|
||||
// Validate checks upstream authentication URL scopes.
|
||||
func (u *UpstreamConfig) Validate() error {
|
||||
for pattern := range u.Auth {
|
||||
if _, err := parseAuthURL(pattern); err != nil {
|
||||
return fmt.Errorf("invalid upstream.auth URL %q: %w", pattern, err)
|
||||
}
|
||||
}
|
||||
if err := validateNamedUpstreams("upstream.helm", u.Helm); err != nil {
|
||||
return err
|
||||
}
|
||||
if err := validateNamedUpstreams("upstream.apk", u.APK); err != nil {
|
||||
return err
|
||||
}
|
||||
if err := validateNamedUpstreams("upstream.oci", u.OCI); err != nil {
|
||||
return err
|
||||
}
|
||||
if err := validateNamedUpstreams("upstream.generic", u.Generic); err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func validateNamedUpstreams(field string, upstreams map[string]string) error {
|
||||
for name, upstreamURL := range upstreams {
|
||||
if name == "" || name == "." || name == ".." || strings.ContainsAny(name, `/\\`) {
|
||||
return fmt.Errorf("invalid %s name %q", field, name)
|
||||
}
|
||||
if err := validateAbsoluteURL(field+"."+name, upstreamURL); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func parseAuthURL(value string) (*url.URL, error) {
|
||||
parsed, err := url.Parse(value)
|
||||
if err != nil || !parsed.IsAbs() || parsed.Hostname() == "" || parsed.Opaque != "" {
|
||||
return nil, fmt.Errorf("invalid authentication URL")
|
||||
}
|
||||
return parsed, nil
|
||||
}
|
||||
|
||||
func authURLMatches(configured, target *url.URL) bool {
|
||||
if !strings.EqualFold(configured.Scheme, target.Scheme) ||
|
||||
!strings.EqualFold(configured.Hostname(), target.Hostname()) ||
|
||||
authURLPort(configured) != authURLPort(target) {
|
||||
return false
|
||||
}
|
||||
if configured.RawQuery != "" && configured.RawQuery != target.RawQuery {
|
||||
return false
|
||||
}
|
||||
|
||||
configuredPath := strings.TrimSuffix(configured.EscapedPath(), "/")
|
||||
if configuredPath == "" {
|
||||
return true
|
||||
}
|
||||
targetPath := strings.TrimSuffix(target.EscapedPath(), "/")
|
||||
return targetPath == configuredPath || strings.HasPrefix(targetPath, configuredPath+"/")
|
||||
}
|
||||
|
||||
func authURLPort(value *url.URL) string {
|
||||
if port := value.Port(); port != "" {
|
||||
return port
|
||||
}
|
||||
if strings.EqualFold(value.Scheme, "https") {
|
||||
return "443"
|
||||
}
|
||||
if strings.EqualFold(value.Scheme, "http") {
|
||||
return "80"
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
// AuthConfig configures authentication for an upstream registry.
|
||||
type AuthConfig struct {
|
||||
// Type is the authentication type: "bearer", "basic", "header", or "ecr".
|
||||
// Type is the authentication type: "bearer", "basic", or "header".
|
||||
Type string `json:"type" yaml:"type"`
|
||||
|
||||
// Token is used for bearer authentication.
|
||||
|
|
@ -720,11 +267,6 @@ type AuthConfig struct {
|
|||
// HeaderValue is the custom header value (for type "header").
|
||||
// Can reference environment variables with ${VAR_NAME} syntax.
|
||||
HeaderValue string `json:"header_value" yaml:"header_value"`
|
||||
|
||||
// Region is the AWS region for ECR authentication (for type "ecr").
|
||||
// If empty, the region is inferred from private ECR registry URLs before
|
||||
// falling back to the AWS SDK default region chain.
|
||||
Region string `json:"region" yaml:"region"`
|
||||
}
|
||||
|
||||
// Default returns a Config with sensible defaults.
|
||||
|
|
@ -748,29 +290,6 @@ func Default() *Config {
|
|||
NPM: "https://registry.npmjs.org",
|
||||
Cargo: "https://index.crates.io",
|
||||
CargoDownload: "https://static.crates.io/crates",
|
||||
Gem: "https://rubygems.org",
|
||||
Go: "https://proxy.golang.org",
|
||||
Hex: "https://repo.hex.pm",
|
||||
HexAPI: "https://hex.pm",
|
||||
Pub: "https://pub.dev",
|
||||
PyPI: "https://pypi.org",
|
||||
PyPIDownload: "https://files.pythonhosted.org",
|
||||
Maven: "https://repo1.maven.org/maven2",
|
||||
GradlePluginPortal: "https://plugins.gradle.org/m2",
|
||||
NuGet: "https://api.nuget.org",
|
||||
NuGetSearch: "https://azuresearch-usnc.nuget.org",
|
||||
Composer: "https://packagist.org",
|
||||
ComposerRepository: "https://repo.packagist.org",
|
||||
Conan: "https://center.conan.io",
|
||||
Conda: "https://conda.anaconda.org",
|
||||
CRAN: "https://cloud.r-project.org",
|
||||
Julia: "https://pkg.julialang.org",
|
||||
Swift: DefaultSwiftUpstream,
|
||||
OCIDefault: "https://registry-1.docker.io",
|
||||
Debian: "http://deb.debian.org/debian",
|
||||
RPM: "https://dl.fedoraproject.org/pub/fedora/linux",
|
||||
HomebrewAPI: "https://formulae.brew.sh/api",
|
||||
HomebrewArtifact: "https://ghcr.io",
|
||||
},
|
||||
Gradle: GradleConfig{
|
||||
BuildCache: GradleBuildCacheConfig{
|
||||
|
|
@ -815,122 +334,82 @@ func Load(path string) (*Config, error) {
|
|||
return cfg, nil
|
||||
}
|
||||
|
||||
// setEnvString sets *dst from the named environment variable, leaving it
|
||||
// untouched if the variable is unset or empty.
|
||||
func setEnvString(dst *string, key string) {
|
||||
if v := os.Getenv(key); v != "" {
|
||||
*dst = v
|
||||
}
|
||||
}
|
||||
|
||||
// setEnvBool is setEnvString for boolean fields, parsed via envBool.
|
||||
func setEnvBool(dst *bool, key string) {
|
||||
if v := os.Getenv(key); v != "" {
|
||||
*dst = envBool(v)
|
||||
}
|
||||
}
|
||||
|
||||
func setEnvStringSlice(dst *[]string, key string) {
|
||||
value := os.Getenv(key)
|
||||
if value == "" {
|
||||
return
|
||||
}
|
||||
var items []string
|
||||
for item := range strings.SplitSeq(value, ",") {
|
||||
if item = strings.TrimSpace(item); item != "" {
|
||||
items = append(items, item)
|
||||
}
|
||||
}
|
||||
if len(items) > 0 {
|
||||
*dst = items
|
||||
}
|
||||
}
|
||||
|
||||
// LoadFromEnv applies environment variable overrides to a Config.
|
||||
// Environment variables use the PROXY_ prefix:
|
||||
// - PROXY_LISTEN
|
||||
// - PROXY_BASE_URL
|
||||
// - PROXY_UI_URL
|
||||
// - PROXY_STORAGE_PATH
|
||||
// - PROXY_STORAGE_MAX_SIZE
|
||||
// - PROXY_DATABASE_PATH
|
||||
// - PROXY_LOG_LEVEL
|
||||
// - PROXY_LOG_FORMAT
|
||||
// - PROXY_ACCESS_LOG_PATH
|
||||
// - PROXY_UPSTREAM_SWIFT
|
||||
// - PROXY_HEALTH_STORAGE_PROBE_INTERVAL
|
||||
func (c *Config) LoadFromEnv() {
|
||||
setEnvString(&c.Listen, "PROXY_LISTEN")
|
||||
setEnvString(&c.BaseURL, "PROXY_BASE_URL")
|
||||
setEnvString(&c.UIBaseURL, "PROXY_UI_URL")
|
||||
setEnvString(&c.Storage.URL, "PROXY_STORAGE_URL")
|
||||
setEnvString(&c.Storage.Path, "PROXY_STORAGE_PATH")
|
||||
setEnvString(&c.Storage.MaxSize, "PROXY_STORAGE_MAX_SIZE")
|
||||
setEnvBool(&c.Storage.DirectServe, "PROXY_STORAGE_DIRECT_SERVE")
|
||||
setEnvString(&c.Storage.DirectServeTTL, "PROXY_STORAGE_DIRECT_SERVE_TTL")
|
||||
setEnvString(&c.Storage.DirectServeBaseURL, "PROXY_STORAGE_DIRECT_SERVE_BASE_URL")
|
||||
setEnvString(&c.Database.Driver, "PROXY_DATABASE_DRIVER")
|
||||
setEnvString(&c.Database.Path, "PROXY_DATABASE_PATH")
|
||||
setEnvString(&c.Database.URL, "PROXY_DATABASE_URL")
|
||||
setEnvString(&c.Log.Level, "PROXY_LOG_LEVEL")
|
||||
setEnvString(&c.Log.Format, "PROXY_LOG_FORMAT")
|
||||
setEnvString(&c.AccessLog.Path, "PROXY_ACCESS_LOG_PATH")
|
||||
setEnvStringSlice(&c.Upstream.AllowPrivateHosts, "PROXY_UPSTREAM_ALLOW_PRIVATE_HOSTS")
|
||||
setEnvBool(&c.Upstream.AllowLoopback, "PROXY_UPSTREAM_ALLOW_LOOPBACK")
|
||||
setEnvString(&c.Upstream.NPM, "PROXY_UPSTREAM_NPM")
|
||||
setEnvBool(&c.Upstream.NPMFullMetadata, "PROXY_UPSTREAM_NPM_FULL_METADATA")
|
||||
setEnvString(&c.Upstream.Cargo, "PROXY_UPSTREAM_CARGO")
|
||||
setEnvString(&c.Upstream.CargoDownload, "PROXY_UPSTREAM_CARGO_DOWNLOAD")
|
||||
setEnvString(&c.Upstream.Gem, "PROXY_UPSTREAM_GEM")
|
||||
setEnvString(&c.Upstream.Go, "PROXY_UPSTREAM_GO")
|
||||
setEnvString(&c.Upstream.Hex, "PROXY_UPSTREAM_HEX")
|
||||
setEnvString(&c.Upstream.HexAPI, "PROXY_UPSTREAM_HEX_API")
|
||||
setEnvString(&c.Upstream.Pub, "PROXY_UPSTREAM_PUB")
|
||||
setEnvString(&c.Upstream.PyPI, "PROXY_UPSTREAM_PYPI")
|
||||
setEnvString(&c.Upstream.PyPIDownload, "PROXY_UPSTREAM_PYPI_DOWNLOAD")
|
||||
setEnvString(&c.Upstream.Maven, "PROXY_UPSTREAM_MAVEN")
|
||||
setEnvString(&c.Upstream.GradlePluginPortal, "PROXY_UPSTREAM_GRADLE_PLUGIN_PORTAL")
|
||||
setEnvString(&c.Upstream.NuGet, "PROXY_UPSTREAM_NUGET")
|
||||
setEnvString(&c.Upstream.NuGetSearch, "PROXY_UPSTREAM_NUGET_SEARCH")
|
||||
setEnvString(&c.Upstream.Composer, "PROXY_UPSTREAM_COMPOSER")
|
||||
setEnvString(&c.Upstream.ComposerRepository, "PROXY_UPSTREAM_COMPOSER_REPOSITORY")
|
||||
setEnvString(&c.Upstream.Conan, "PROXY_UPSTREAM_CONAN")
|
||||
setEnvString(&c.Upstream.Conda, "PROXY_UPSTREAM_CONDA")
|
||||
setEnvString(&c.Upstream.CRAN, "PROXY_UPSTREAM_CRAN")
|
||||
setEnvString(&c.Upstream.Julia, "PROXY_UPSTREAM_JULIA")
|
||||
setEnvString(&c.Upstream.Swift, "PROXY_UPSTREAM_SWIFT")
|
||||
setEnvString(&c.Upstream.OCIDefault, "PROXY_UPSTREAM_OCI_DEFAULT")
|
||||
setEnvString(&c.Upstream.Debian, "PROXY_UPSTREAM_DEBIAN")
|
||||
setEnvString(&c.Upstream.RPM, "PROXY_UPSTREAM_RPM")
|
||||
setEnvString(&c.Upstream.HomebrewAPI, "PROXY_UPSTREAM_HOMEBREW_API")
|
||||
setEnvString(&c.Upstream.HomebrewArtifact, "PROXY_UPSTREAM_HOMEBREW_ARTIFACT")
|
||||
setEnvString(&c.Cooldown.Default, "PROXY_COOLDOWN_DEFAULT")
|
||||
setEnvBool(&c.Scanning.Enabled, "PROXY_SCANNING_ENABLED")
|
||||
setEnvBool(&c.Scanning.FailOpen, "PROXY_SCANNING_FAIL_OPEN")
|
||||
setEnvString(&c.Scanning.Timeout, "PROXY_SCANNING_TIMEOUT")
|
||||
setEnvString(&c.Scanning.SigningKey, "PROXY_SCANNING_SIGNING_KEY")
|
||||
setEnvString(&c.Scanning.FetchBaseURL, "PROXY_SCANNING_FETCH_BASE_URL")
|
||||
setEnvBool(&c.CacheMetadata, "PROXY_CACHE_METADATA")
|
||||
setEnvBool(&c.MirrorAPI, "PROXY_MIRROR_API")
|
||||
setEnvString(&c.MetadataTTL, "PROXY_METADATA_TTL")
|
||||
setEnvString(&c.MetadataMaxSize, "PROXY_METADATA_MAX_SIZE")
|
||||
setEnvString(&c.HTTPTimeout, "PROXY_HTTP_TIMEOUT")
|
||||
setEnvBool(&c.Gradle.BuildCache.ReadOnly, "PROXY_GRADLE_BUILD_CACHE_READ_ONLY")
|
||||
setEnvString(&c.Gradle.BuildCache.MaxUploadSize, "PROXY_GRADLE_BUILD_CACHE_MAX_UPLOAD_SIZE")
|
||||
setEnvString(&c.Gradle.BuildCache.MaxAge, "PROXY_GRADLE_BUILD_CACHE_MAX_AGE")
|
||||
setEnvString(&c.Gradle.BuildCache.MaxSize, "PROXY_GRADLE_BUILD_CACHE_MAX_SIZE")
|
||||
setEnvString(&c.Gradle.BuildCache.SweepInterval, "PROXY_GRADLE_BUILD_CACHE_SWEEP_INTERVAL")
|
||||
setEnvString(&c.Health.StorageProbeInterval, "PROXY_HEALTH_STORAGE_PROBE_INTERVAL")
|
||||
if v := os.Getenv("PROXY_LISTEN"); v != "" {
|
||||
c.Listen = v
|
||||
}
|
||||
|
||||
// validateAbsoluteURL returns an error if value is not a parseable URL with
|
||||
// both a scheme and host. fieldName is used in the error message.
|
||||
func validateAbsoluteURL(fieldName, value string) error {
|
||||
u, err := url.Parse(value)
|
||||
if err != nil || u.Scheme == "" || u.Host == "" {
|
||||
return fmt.Errorf("invalid %s %q: must be an absolute URL", fieldName, value)
|
||||
if v := os.Getenv("PROXY_BASE_URL"); v != "" {
|
||||
c.BaseURL = v
|
||||
}
|
||||
if v := os.Getenv("PROXY_STORAGE_URL"); v != "" {
|
||||
c.Storage.URL = v
|
||||
}
|
||||
if v := os.Getenv("PROXY_STORAGE_PATH"); v != "" {
|
||||
c.Storage.Path = v
|
||||
}
|
||||
if v := os.Getenv("PROXY_STORAGE_MAX_SIZE"); v != "" {
|
||||
c.Storage.MaxSize = v
|
||||
}
|
||||
if v := os.Getenv("PROXY_STORAGE_DIRECT_SERVE"); v != "" {
|
||||
c.Storage.DirectServe = envBool(v)
|
||||
}
|
||||
if v := os.Getenv("PROXY_STORAGE_DIRECT_SERVE_TTL"); v != "" {
|
||||
c.Storage.DirectServeTTL = v
|
||||
}
|
||||
if v := os.Getenv("PROXY_STORAGE_DIRECT_SERVE_BASE_URL"); v != "" {
|
||||
c.Storage.DirectServeBaseURL = v
|
||||
}
|
||||
if v := os.Getenv("PROXY_DATABASE_DRIVER"); v != "" {
|
||||
c.Database.Driver = v
|
||||
}
|
||||
if v := os.Getenv("PROXY_DATABASE_PATH"); v != "" {
|
||||
c.Database.Path = v
|
||||
}
|
||||
if v := os.Getenv("PROXY_DATABASE_URL"); v != "" {
|
||||
c.Database.URL = v
|
||||
}
|
||||
if v := os.Getenv("PROXY_LOG_LEVEL"); v != "" {
|
||||
c.Log.Level = v
|
||||
}
|
||||
if v := os.Getenv("PROXY_LOG_FORMAT"); v != "" {
|
||||
c.Log.Format = v
|
||||
}
|
||||
if v := os.Getenv("PROXY_COOLDOWN_DEFAULT"); v != "" {
|
||||
c.Cooldown.Default = v
|
||||
}
|
||||
if v := os.Getenv("PROXY_CACHE_METADATA"); v != "" {
|
||||
c.CacheMetadata = envBool(v)
|
||||
}
|
||||
if v := os.Getenv("PROXY_MIRROR_API"); v != "" {
|
||||
c.MirrorAPI = envBool(v)
|
||||
}
|
||||
if v := os.Getenv("PROXY_METADATA_TTL"); v != "" {
|
||||
c.MetadataTTL = v
|
||||
}
|
||||
if v := os.Getenv("PROXY_GRADLE_BUILD_CACHE_READ_ONLY"); v != "" {
|
||||
c.Gradle.BuildCache.ReadOnly = v == "true" || v == "1"
|
||||
}
|
||||
if v := os.Getenv("PROXY_GRADLE_BUILD_CACHE_MAX_UPLOAD_SIZE"); v != "" {
|
||||
c.Gradle.BuildCache.MaxUploadSize = v
|
||||
}
|
||||
if v := os.Getenv("PROXY_GRADLE_BUILD_CACHE_MAX_AGE"); v != "" {
|
||||
c.Gradle.BuildCache.MaxAge = v
|
||||
}
|
||||
if v := os.Getenv("PROXY_GRADLE_BUILD_CACHE_MAX_SIZE"); v != "" {
|
||||
c.Gradle.BuildCache.MaxSize = v
|
||||
}
|
||||
if v := os.Getenv("PROXY_GRADLE_BUILD_CACHE_SWEEP_INTERVAL"); v != "" {
|
||||
c.Gradle.BuildCache.SweepInterval = v
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// Validate checks the configuration for errors.
|
||||
|
|
@ -941,11 +420,6 @@ func (c *Config) Validate() error {
|
|||
if c.BaseURL == "" {
|
||||
return fmt.Errorf("base_url is required")
|
||||
}
|
||||
if c.UIBaseURL == "" {
|
||||
c.UIBaseURL = c.BaseURL
|
||||
} else if err := validateAbsoluteURL("ui_base_url", c.UIBaseURL); err != nil {
|
||||
return err
|
||||
}
|
||||
if c.Storage.URL == "" && c.Storage.Path == "" {
|
||||
return fmt.Errorf("storage.url or storage.path is required")
|
||||
}
|
||||
|
|
@ -994,8 +468,9 @@ func (c *Config) Validate() error {
|
|||
|
||||
// Validate direct serve base URL if specified
|
||||
if c.Storage.DirectServeBaseURL != "" {
|
||||
if err := validateAbsoluteURL("storage.direct_serve_base_url", c.Storage.DirectServeBaseURL); err != nil {
|
||||
return err
|
||||
u, err := url.Parse(c.Storage.DirectServeBaseURL)
|
||||
if err != nil || u.Scheme == "" || u.Host == "" {
|
||||
return fmt.Errorf("invalid storage.direct_serve_base_url %q: must be an absolute URL", c.Storage.DirectServeBaseURL)
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -1006,46 +481,10 @@ func (c *Config) Validate() error {
|
|||
}
|
||||
}
|
||||
|
||||
if err := validateMetadataMaxSize(c.MetadataMaxSize); err != nil {
|
||||
if err := c.Gradle.BuildCache.Validate(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if err := validateHTTPTimeout(c.HTTPTimeout); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return c.validateComponents()
|
||||
}
|
||||
|
||||
func (c *Config) validateComponents() error {
|
||||
if err := c.Upstream.Validate(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if err := c.Health.Validate(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if err := c.Scanning.Validate(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return c.Gradle.BuildCache.Validate()
|
||||
}
|
||||
|
||||
// Validate checks the /health configuration. An unset interval is allowed
|
||||
// (the cache uses its default); explicit values must parse and be non-negative.
|
||||
func (h *HealthConfig) Validate() error {
|
||||
if h.StorageProbeInterval == "" || h.StorageProbeInterval == "0" {
|
||||
return nil
|
||||
}
|
||||
d, err := time.ParseDuration(h.StorageProbeInterval)
|
||||
if err != nil {
|
||||
return fmt.Errorf("invalid health.storage_probe_interval %q: %w", h.StorageProbeInterval, err)
|
||||
}
|
||||
if d < 0 {
|
||||
return fmt.Errorf("invalid health.storage_probe_interval %q: must be non-negative", h.StorageProbeInterval)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
|
|
@ -1091,13 +530,10 @@ func (g *GradleBuildCacheConfig) Validate() error {
|
|||
const (
|
||||
defaultMetadataTTL = 5 * time.Minute //nolint:mnd // sensible default
|
||||
defaultDirectServeTTL = 15 * time.Minute //nolint:mnd // sensible default
|
||||
defaultHTTPTimeout = 30 * time.Second //nolint:mnd // sensible default
|
||||
defaultMetadataMaxSize = 100 << 20
|
||||
defaultGradleBuildCacheMaxUploadSize = 100 << 20
|
||||
defaultGradleBuildCacheSweepInterval = 10 * time.Minute
|
||||
defaultGradleMaxUploadSizeStr = "100MB"
|
||||
defaultGradleSweepIntervalStr = "10m"
|
||||
defaultScanningTimeoutStr = "30s"
|
||||
)
|
||||
|
||||
// ParseMaxSize returns the maximum cache size in bytes.
|
||||
|
|
@ -1113,63 +549,6 @@ func (c *Config) ParseMaxSize() int64 {
|
|||
return size
|
||||
}
|
||||
|
||||
func validateHTTPTimeout(s string) error {
|
||||
if s == "" || s == "0" {
|
||||
return nil
|
||||
}
|
||||
d, err := time.ParseDuration(s)
|
||||
if err != nil {
|
||||
return fmt.Errorf("invalid http_timeout %q: %w", s, err)
|
||||
}
|
||||
if d < 0 {
|
||||
return fmt.Errorf("invalid http_timeout %q: must be non-negative", s)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func validateMetadataMaxSize(s string) error {
|
||||
if s == "" {
|
||||
return nil
|
||||
}
|
||||
size, err := ParseSize(s)
|
||||
if err != nil {
|
||||
return fmt.Errorf("invalid metadata_max_size: %w", err)
|
||||
}
|
||||
if size <= 0 {
|
||||
return fmt.Errorf("invalid metadata_max_size %q: must be positive", s)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// ParseMetadataMaxSize returns the maximum metadata response size in bytes.
|
||||
// Returns 100MB if unset or invalid.
|
||||
func (c *Config) ParseMetadataMaxSize() int64 {
|
||||
if c.MetadataMaxSize == "" {
|
||||
return defaultMetadataMaxSize
|
||||
}
|
||||
size, err := ParseSize(c.MetadataMaxSize)
|
||||
if err != nil || size <= 0 {
|
||||
return defaultMetadataMaxSize
|
||||
}
|
||||
return size
|
||||
}
|
||||
|
||||
// ParseHTTPTimeout returns the upstream HTTP client timeout.
|
||||
// Returns 30s if unset, 0 (no timeout) if explicitly set to "0".
|
||||
func (c *Config) ParseHTTPTimeout() time.Duration {
|
||||
if c.HTTPTimeout == "" {
|
||||
return defaultHTTPTimeout
|
||||
}
|
||||
if c.HTTPTimeout == "0" {
|
||||
return 0
|
||||
}
|
||||
d, err := time.ParseDuration(c.HTTPTimeout)
|
||||
if err != nil || d < 0 {
|
||||
return defaultHTTPTimeout
|
||||
}
|
||||
return d
|
||||
}
|
||||
|
||||
// ParseMetadataTTL returns the metadata TTL duration.
|
||||
// Returns 5 minutes if unset, 0 if explicitly disabled.
|
||||
func (c *Config) ParseMetadataTTL() time.Duration {
|
||||
|
|
@ -1276,7 +655,8 @@ func ParseSize(s string) (int64, error) {
|
|||
}
|
||||
|
||||
for _, s2 := range suffixes {
|
||||
if numStr, ok := strings.CutSuffix(s, s2.suffix); ok {
|
||||
if strings.HasSuffix(s, s2.suffix) {
|
||||
numStr := strings.TrimSuffix(s, s2.suffix)
|
||||
num, err := strconv.ParseFloat(numStr, 64)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("invalid number %q", numStr)
|
||||
|
|
|
|||
|
|
@ -3,7 +3,6 @@ package config
|
|||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
|
@ -14,109 +13,6 @@ const (
|
|||
testLevelDebug = "debug"
|
||||
)
|
||||
|
||||
func upstreamConfigValues(upstream UpstreamConfig) map[string]string {
|
||||
return map[string]string{
|
||||
"npm": upstream.NPM,
|
||||
"cargo": upstream.Cargo,
|
||||
"cargo_download": upstream.CargoDownload,
|
||||
"gem": upstream.Gem,
|
||||
"go": upstream.Go,
|
||||
"hex": upstream.Hex,
|
||||
"hex_api": upstream.HexAPI,
|
||||
"pub": upstream.Pub,
|
||||
"pypi": upstream.PyPI,
|
||||
"pypi_download": upstream.PyPIDownload,
|
||||
"maven": upstream.Maven,
|
||||
"gradle_plugin_portal": upstream.GradlePluginPortal,
|
||||
"nuget": upstream.NuGet,
|
||||
"nuget_search": upstream.NuGetSearch,
|
||||
"composer": upstream.Composer,
|
||||
"composer_repository": upstream.ComposerRepository,
|
||||
"conan": upstream.Conan,
|
||||
"conda": upstream.Conda,
|
||||
"cran": upstream.CRAN,
|
||||
"julia": upstream.Julia,
|
||||
"swift": upstream.Swift,
|
||||
"oci_default": upstream.OCIDefault,
|
||||
"debian": upstream.Debian,
|
||||
"rpm": upstream.RPM,
|
||||
"homebrew_api": upstream.HomebrewAPI,
|
||||
"homebrew_artifact": upstream.HomebrewArtifact,
|
||||
}
|
||||
}
|
||||
|
||||
func defaultUpstreamValues() map[string]string {
|
||||
return map[string]string{
|
||||
"npm": "https://registry.npmjs.org",
|
||||
"cargo": "https://index.crates.io",
|
||||
"cargo_download": "https://static.crates.io/crates",
|
||||
"gem": "https://rubygems.org",
|
||||
"go": "https://proxy.golang.org",
|
||||
"hex": "https://repo.hex.pm",
|
||||
"hex_api": "https://hex.pm",
|
||||
"pub": "https://pub.dev",
|
||||
"pypi": "https://pypi.org",
|
||||
"pypi_download": "https://files.pythonhosted.org",
|
||||
"maven": "https://repo1.maven.org/maven2",
|
||||
"gradle_plugin_portal": "https://plugins.gradle.org/m2",
|
||||
"nuget": "https://api.nuget.org",
|
||||
"nuget_search": "https://azuresearch-usnc.nuget.org",
|
||||
"composer": "https://packagist.org",
|
||||
"composer_repository": "https://repo.packagist.org",
|
||||
"conan": "https://center.conan.io",
|
||||
"conda": "https://conda.anaconda.org",
|
||||
"cran": "https://cloud.r-project.org",
|
||||
"julia": "https://pkg.julialang.org",
|
||||
"swift": "https://tuist.dev/api/registry/swift",
|
||||
"oci_default": "https://registry-1.docker.io",
|
||||
"debian": "http://deb.debian.org/debian",
|
||||
"rpm": "https://dl.fedoraproject.org/pub/fedora/linux",
|
||||
"homebrew_api": "https://formulae.brew.sh/api",
|
||||
"homebrew_artifact": "https://ghcr.io",
|
||||
}
|
||||
}
|
||||
|
||||
func upstreamEnvironmentVariables() map[string]string {
|
||||
return map[string]string{
|
||||
"npm": "PROXY_UPSTREAM_NPM",
|
||||
"cargo": "PROXY_UPSTREAM_CARGO",
|
||||
"cargo_download": "PROXY_UPSTREAM_CARGO_DOWNLOAD",
|
||||
"gem": "PROXY_UPSTREAM_GEM",
|
||||
"go": "PROXY_UPSTREAM_GO",
|
||||
"hex": "PROXY_UPSTREAM_HEX",
|
||||
"hex_api": "PROXY_UPSTREAM_HEX_API",
|
||||
"pub": "PROXY_UPSTREAM_PUB",
|
||||
"pypi": "PROXY_UPSTREAM_PYPI",
|
||||
"pypi_download": "PROXY_UPSTREAM_PYPI_DOWNLOAD",
|
||||
"maven": "PROXY_UPSTREAM_MAVEN",
|
||||
"gradle_plugin_portal": "PROXY_UPSTREAM_GRADLE_PLUGIN_PORTAL",
|
||||
"nuget": "PROXY_UPSTREAM_NUGET",
|
||||
"nuget_search": "PROXY_UPSTREAM_NUGET_SEARCH",
|
||||
"composer": "PROXY_UPSTREAM_COMPOSER",
|
||||
"composer_repository": "PROXY_UPSTREAM_COMPOSER_REPOSITORY",
|
||||
"conan": "PROXY_UPSTREAM_CONAN",
|
||||
"conda": "PROXY_UPSTREAM_CONDA",
|
||||
"cran": "PROXY_UPSTREAM_CRAN",
|
||||
"julia": "PROXY_UPSTREAM_JULIA",
|
||||
"swift": "PROXY_UPSTREAM_SWIFT",
|
||||
"oci_default": "PROXY_UPSTREAM_OCI_DEFAULT",
|
||||
"debian": "PROXY_UPSTREAM_DEBIAN",
|
||||
"rpm": "PROXY_UPSTREAM_RPM",
|
||||
"homebrew_api": "PROXY_UPSTREAM_HOMEBREW_API",
|
||||
"homebrew_artifact": "PROXY_UPSTREAM_HOMEBREW_ARTIFACT",
|
||||
}
|
||||
}
|
||||
|
||||
func assertUpstreamValues(t *testing.T, cfg *Config, want map[string]string) {
|
||||
t.Helper()
|
||||
got := upstreamConfigValues(cfg.Upstream)
|
||||
for name, wantValue := range want {
|
||||
if gotValue := got[name]; gotValue != wantValue {
|
||||
t.Errorf("Upstream %s = %q, want %q", name, gotValue, wantValue)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestDefault(t *testing.T) {
|
||||
cfg := Default()
|
||||
|
||||
|
|
@ -129,22 +25,12 @@ func TestDefault(t *testing.T) {
|
|||
if cfg.Database.Path == "" {
|
||||
t.Error("Database.Path should not be empty")
|
||||
}
|
||||
if cfg.AccessLog.Path != "" {
|
||||
t.Errorf("AccessLog.Path = %q, want disabled by default", cfg.AccessLog.Path)
|
||||
}
|
||||
if cfg.Gradle.BuildCache.MaxUploadSize != "100MB" {
|
||||
t.Errorf("Gradle.BuildCache.MaxUploadSize = %q, want %q", cfg.Gradle.BuildCache.MaxUploadSize, "100MB")
|
||||
}
|
||||
if cfg.Gradle.BuildCache.MaxAge != "168h" {
|
||||
t.Errorf("Gradle.BuildCache.MaxAge = %q, want %q", cfg.Gradle.BuildCache.MaxAge, "168h")
|
||||
}
|
||||
if len(cfg.Upstream.AllowPrivateHosts) != 0 {
|
||||
t.Errorf("Upstream.AllowPrivateHosts = %v, want empty", cfg.Upstream.AllowPrivateHosts)
|
||||
}
|
||||
if cfg.Upstream.AllowLoopback {
|
||||
t.Error("Upstream.AllowLoopback = true, want false")
|
||||
}
|
||||
assertUpstreamValues(t, cfg, defaultUpstreamValues())
|
||||
}
|
||||
|
||||
func TestValidate(t *testing.T) {
|
||||
|
|
@ -316,11 +202,6 @@ database:
|
|||
log:
|
||||
level: "debug"
|
||||
format: "json"
|
||||
access_log:
|
||||
path: "/var/log/proxy/access.jsonl"
|
||||
upstream:
|
||||
homebrew_api: "https://homebrew-api.example.com"
|
||||
homebrew_artifact: "https://homebrew-artifact.example.com"
|
||||
`
|
||||
if err := os.WriteFile(path, []byte(content), 0644); err != nil {
|
||||
t.Fatalf("writing config file: %v", err)
|
||||
|
|
@ -349,72 +230,6 @@ upstream:
|
|||
if cfg.Log.Format != "json" {
|
||||
t.Errorf("Log.Format = %q, want %q", cfg.Log.Format, "json")
|
||||
}
|
||||
if cfg.AccessLog.Path != "/var/log/proxy/access.jsonl" {
|
||||
t.Errorf("AccessLog.Path = %q, want %q", cfg.AccessLog.Path, "/var/log/proxy/access.jsonl")
|
||||
}
|
||||
if cfg.Upstream.HomebrewAPI != "https://homebrew-api.example.com" {
|
||||
t.Errorf("Upstream.HomebrewAPI = %q, want %q", cfg.Upstream.HomebrewAPI, "https://homebrew-api.example.com")
|
||||
}
|
||||
if cfg.Upstream.HomebrewArtifact != "https://homebrew-artifact.example.com" {
|
||||
t.Errorf("Upstream.HomebrewArtifact = %q, want %q", cfg.Upstream.HomebrewArtifact, "https://homebrew-artifact.example.com")
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadYAMLUpstreams(t *testing.T) {
|
||||
path := filepath.Join(t.TempDir(), "config.yaml")
|
||||
content := `
|
||||
upstream:
|
||||
allow_private_hosts:
|
||||
- "registry.internal"
|
||||
- "10.0.0.12"
|
||||
allow_loopback: true
|
||||
npm: "https://upstream.example.com/npm"
|
||||
cargo: "https://upstream.example.com/cargo"
|
||||
cargo_download: "https://upstream.example.com/cargo_download"
|
||||
gem: "https://upstream.example.com/gem"
|
||||
go: "https://upstream.example.com/go"
|
||||
hex: "https://upstream.example.com/hex"
|
||||
hex_api: "https://upstream.example.com/hex_api"
|
||||
pub: "https://upstream.example.com/pub"
|
||||
pypi: "https://upstream.example.com/pypi"
|
||||
pypi_download: "https://upstream.example.com/pypi_download"
|
||||
maven: "https://upstream.example.com/maven"
|
||||
gradle_plugin_portal: "https://upstream.example.com/gradle_plugin_portal"
|
||||
nuget: "https://upstream.example.com/nuget"
|
||||
nuget_search: "https://upstream.example.com/nuget_search"
|
||||
composer: "https://upstream.example.com/composer"
|
||||
composer_repository: "https://upstream.example.com/composer_repository"
|
||||
conan: "https://upstream.example.com/conan"
|
||||
conda: "https://upstream.example.com/conda"
|
||||
cran: "https://upstream.example.com/cran"
|
||||
julia: "https://upstream.example.com/julia"
|
||||
swift: "https://upstream.example.com/swift"
|
||||
oci_default: "https://upstream.example.com/oci_default"
|
||||
debian: "https://upstream.example.com/debian"
|
||||
rpm: "https://upstream.example.com/rpm"
|
||||
homebrew_api: "https://upstream.example.com/homebrew_api"
|
||||
homebrew_artifact: "https://upstream.example.com/homebrew_artifact"
|
||||
`
|
||||
if err := os.WriteFile(path, []byte(content), 0644); err != nil {
|
||||
t.Fatalf("writing config file: %v", err)
|
||||
}
|
||||
|
||||
cfg, err := Load(path)
|
||||
if err != nil {
|
||||
t.Fatalf("Load failed: %v", err)
|
||||
}
|
||||
|
||||
want := make(map[string]string)
|
||||
for name := range defaultUpstreamValues() {
|
||||
want[name] = "https://upstream.example.com/" + name
|
||||
}
|
||||
assertUpstreamValues(t, cfg, want)
|
||||
if got := strings.Join(cfg.Upstream.AllowPrivateHosts, ","); got != "registry.internal,10.0.0.12" {
|
||||
t.Errorf("Upstream.AllowPrivateHosts = %q, want %q", got, "registry.internal,10.0.0.12")
|
||||
}
|
||||
if !cfg.Upstream.AllowLoopback {
|
||||
t.Error("Upstream.AllowLoopback = false, want true")
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadJSON(t *testing.T) {
|
||||
|
|
@ -423,11 +238,7 @@ func TestLoadJSON(t *testing.T) {
|
|||
|
||||
content := `{
|
||||
"listen": ":4000",
|
||||
"base_url": "https://json.example.com",
|
||||
"upstream": {
|
||||
"gem": "https://json.example.com/gem",
|
||||
"rpm": "https://json.example.com/rpm"
|
||||
}
|
||||
"base_url": "https://json.example.com"
|
||||
}`
|
||||
if err := os.WriteFile(path, []byte(content), 0644); err != nil {
|
||||
t.Fatalf("writing config file: %v", err)
|
||||
|
|
@ -444,12 +255,6 @@ func TestLoadJSON(t *testing.T) {
|
|||
if cfg.BaseURL != "https://json.example.com" {
|
||||
t.Errorf("BaseURL = %q, want %q", cfg.BaseURL, "https://json.example.com")
|
||||
}
|
||||
if cfg.Upstream.Gem != "https://json.example.com/gem" {
|
||||
t.Errorf("Upstream.Gem = %q, want %q", cfg.Upstream.Gem, "https://json.example.com/gem")
|
||||
}
|
||||
if cfg.Upstream.RPM != "https://json.example.com/rpm" {
|
||||
t.Errorf("Upstream.RPM = %q, want %q", cfg.Upstream.RPM, "https://json.example.com/rpm")
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadFromEnv(t *testing.T) {
|
||||
|
|
@ -457,12 +262,8 @@ func TestLoadFromEnv(t *testing.T) {
|
|||
|
||||
t.Setenv("PROXY_LISTEN", ":9000")
|
||||
t.Setenv("PROXY_BASE_URL", "https://env.example.com")
|
||||
t.Setenv("PROXY_UI_URL", "https://ui.env.example.com/ui")
|
||||
t.Setenv("PROXY_STORAGE_PATH", "/env/cache")
|
||||
t.Setenv("PROXY_LOG_LEVEL", testLevelDebug)
|
||||
t.Setenv("PROXY_ACCESS_LOG_PATH", "/tmp/proxy-access.jsonl")
|
||||
t.Setenv("PROXY_UPSTREAM_ALLOW_PRIVATE_HOSTS", "registry.internal, 10.0.0.12")
|
||||
t.Setenv("PROXY_UPSTREAM_ALLOW_LOOPBACK", "true")
|
||||
t.Setenv("PROXY_GRADLE_BUILD_CACHE_READ_ONLY", "true")
|
||||
t.Setenv("PROXY_GRADLE_BUILD_CACHE_MAX_UPLOAD_SIZE", "32MB")
|
||||
t.Setenv("PROXY_GRADLE_BUILD_CACHE_MAX_AGE", "12h")
|
||||
|
|
@ -477,31 +278,12 @@ func TestLoadFromEnv(t *testing.T) {
|
|||
if cfg.BaseURL != "https://env.example.com" {
|
||||
t.Errorf("BaseURL = %q, want %q", cfg.BaseURL, "https://env.example.com")
|
||||
}
|
||||
if cfg.UIBaseURL != "https://ui.env.example.com/ui" {
|
||||
t.Errorf("UIBaseURL = %q, want %q", cfg.UIBaseURL, "https://ui.env.example.com/ui")
|
||||
}
|
||||
if cfg.Storage.Path != "/env/cache" {
|
||||
t.Errorf("Storage.Path = %q, want %q", cfg.Storage.Path, "/env/cache")
|
||||
}
|
||||
if cfg.Log.Level != testLevelDebug {
|
||||
t.Errorf("Log.Level = %q, want %q", cfg.Log.Level, testLevelDebug)
|
||||
}
|
||||
if cfg.AccessLog.Path != "/tmp/proxy-access.jsonl" {
|
||||
t.Errorf("AccessLog.Path = %q, want %q", cfg.AccessLog.Path, "/tmp/proxy-access.jsonl")
|
||||
}
|
||||
if got := strings.Join(cfg.Upstream.AllowPrivateHosts, ","); got != "registry.internal,10.0.0.12" {
|
||||
t.Errorf("Upstream.AllowPrivateHosts = %q, want %q", got, "registry.internal,10.0.0.12")
|
||||
}
|
||||
if !cfg.Upstream.AllowLoopback {
|
||||
t.Error("Upstream.AllowLoopback = false, want true")
|
||||
}
|
||||
|
||||
t.Setenv("PROXY_UPSTREAM_ALLOW_PRIVATE_HOSTS", " , ")
|
||||
cfg.LoadFromEnv()
|
||||
if got := strings.Join(cfg.Upstream.AllowPrivateHosts, ","); got != "registry.internal,10.0.0.12" {
|
||||
t.Errorf("Upstream.AllowPrivateHosts after empty env = %q, want unchanged", got)
|
||||
}
|
||||
|
||||
if !cfg.Gradle.BuildCache.ReadOnly {
|
||||
t.Error("Gradle.BuildCache.ReadOnly = false, want true")
|
||||
}
|
||||
|
|
@ -519,19 +301,6 @@ func TestLoadFromEnv(t *testing.T) {
|
|||
}
|
||||
}
|
||||
|
||||
func TestLoadFromEnvUpstreams(t *testing.T) {
|
||||
cfg := Default()
|
||||
want := make(map[string]string)
|
||||
for name, envName := range upstreamEnvironmentVariables() {
|
||||
value := "https://env.example.com/" + name
|
||||
t.Setenv(envName, value)
|
||||
want[name] = value
|
||||
}
|
||||
|
||||
cfg.LoadFromEnv()
|
||||
assertUpstreamValues(t, cfg, want)
|
||||
}
|
||||
|
||||
func TestLoadCooldownConfig(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
path := filepath.Join(dir, "config.yaml")
|
||||
|
|
@ -576,34 +345,6 @@ cooldown:
|
|||
if cfg.Cooldown.Packages["pkg:npm/@babel/core"] != "14d" {
|
||||
t.Errorf("Cooldown.Packages[@babel/core] = %q, want %q", cfg.Cooldown.Packages["pkg:npm/@babel/core"], "14d")
|
||||
}
|
||||
if got := cfg.Cooldown.NormalizedPackages()["pkg:npm/%40babel/core"]; got != "14d" {
|
||||
t.Errorf("normalized Cooldown.Packages[@babel/core] = %q, want %q", got, "14d")
|
||||
}
|
||||
}
|
||||
|
||||
func TestCooldownConfigNormalizedPackages(t *testing.T) {
|
||||
rawScoped := "pkg:npm/@typescript/typescript-darwin-arm64"
|
||||
canonicalScoped := "pkg:npm/%40typescript/typescript-darwin-arm64"
|
||||
cfg := CooldownConfig{Packages: map[string]string{
|
||||
rawScoped: "2d",
|
||||
canonicalScoped: "3d",
|
||||
"not-a-purl": "4d",
|
||||
}}
|
||||
|
||||
got := cfg.NormalizedPackages()
|
||||
|
||||
if got[canonicalScoped] != "3d" {
|
||||
t.Errorf("canonical scoped package duration = %q, want %q", got[canonicalScoped], "3d")
|
||||
}
|
||||
if _, exists := got[rawScoped]; exists {
|
||||
t.Errorf("raw scoped package key %q was not canonicalized", rawScoped)
|
||||
}
|
||||
if got["not-a-purl"] != "4d" {
|
||||
t.Errorf("invalid PURL duration = %q, want preserved value %q", got["not-a-purl"], "4d")
|
||||
}
|
||||
if cfg.Packages[rawScoped] != "2d" {
|
||||
t.Error("NormalizedPackages mutated the source map")
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadCooldownFromEnv(t *testing.T) {
|
||||
|
|
@ -673,52 +414,6 @@ func TestParseMetadataTTL(t *testing.T) {
|
|||
}
|
||||
}
|
||||
|
||||
func TestParseMetadataMaxSize(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
size string
|
||||
want int64
|
||||
}{
|
||||
{"unset uses default", "", defaultMetadataMaxSize},
|
||||
{"explicit value", "250MB", 250 << 20},
|
||||
{"bytes", "1024", 1024},
|
||||
{"invalid uses default", "lots", defaultMetadataMaxSize},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
cfg := Default()
|
||||
cfg.MetadataMaxSize = tt.size
|
||||
got := cfg.ParseMetadataMaxSize()
|
||||
if got != tt.want {
|
||||
t.Errorf("ParseMetadataMaxSize() = %d, want %d", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidateMetadataMaxSize(t *testing.T) {
|
||||
cfg := Default()
|
||||
cfg.MetadataMaxSize = "not-a-size"
|
||||
if err := cfg.Validate(); err == nil {
|
||||
t.Error("expected validation error for invalid metadata_max_size")
|
||||
}
|
||||
|
||||
cfg.MetadataMaxSize = "0"
|
||||
if err := cfg.Validate(); err == nil {
|
||||
t.Error("expected validation error for zero metadata_max_size")
|
||||
}
|
||||
|
||||
cfg.MetadataMaxSize = "250MB"
|
||||
if err := cfg.Validate(); err != nil {
|
||||
t.Errorf("unexpected error for valid metadata_max_size: %v", err)
|
||||
}
|
||||
|
||||
cfg.MetadataMaxSize = ""
|
||||
if err := cfg.Validate(); err != nil {
|
||||
t.Errorf("unexpected error for unset metadata_max_size: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidateMetadataTTL(t *testing.T) {
|
||||
cfg := Default()
|
||||
cfg.MetadataTTL = "invalid"
|
||||
|
|
@ -737,208 +432,6 @@ func TestValidateMetadataTTL(t *testing.T) {
|
|||
}
|
||||
}
|
||||
|
||||
func TestValidateHealthStorageProbeInterval(t *testing.T) {
|
||||
cfg := Default()
|
||||
cfg.Health.StorageProbeInterval = "not-a-duration"
|
||||
if err := cfg.Validate(); err == nil {
|
||||
t.Error("expected validation error for invalid health.storage_probe_interval")
|
||||
}
|
||||
|
||||
cfg.Health.StorageProbeInterval = "30s"
|
||||
if err := cfg.Validate(); err != nil {
|
||||
t.Errorf("unexpected error for valid health.storage_probe_interval: %v", err)
|
||||
}
|
||||
|
||||
cfg.Health.StorageProbeInterval = "0"
|
||||
if err := cfg.Validate(); err != nil {
|
||||
t.Errorf("unexpected error for zero health.storage_probe_interval: %v", err)
|
||||
}
|
||||
|
||||
cfg.Health.StorageProbeInterval = ""
|
||||
if err := cfg.Validate(); err != nil {
|
||||
t.Errorf("unexpected error for empty health.storage_probe_interval: %v", err)
|
||||
}
|
||||
|
||||
cfg.Health.StorageProbeInterval = "-5s"
|
||||
if err := cfg.Validate(); err == nil {
|
||||
t.Error("expected validation error for negative health.storage_probe_interval")
|
||||
}
|
||||
}
|
||||
|
||||
func TestScanningConfigValidate(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
cfg ScanningConfig
|
||||
wantErr bool
|
||||
}{
|
||||
{
|
||||
name: "disabled skips validation entirely",
|
||||
cfg: ScanningConfig{Enabled: false, Timeout: "not-a-duration"},
|
||||
},
|
||||
{
|
||||
name: "enabled without signing key fails",
|
||||
cfg: ScanningConfig{Enabled: true},
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "enabled with signing key and no scanners fails",
|
||||
cfg: ScanningConfig{Enabled: true, SigningKey: "s3cret"},
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "invalid fetch_base_url fails",
|
||||
cfg: ScanningConfig{
|
||||
Enabled: true,
|
||||
SigningKey: "s3cret",
|
||||
FetchBaseURL: "not-a-url",
|
||||
Scanners: []ScannerConfig{{Name: "clamav", URL: "http://scanner.invalid/scan"}},
|
||||
},
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "invalid timeout fails",
|
||||
cfg: ScanningConfig{
|
||||
Enabled: true,
|
||||
SigningKey: "s3cret",
|
||||
Timeout: "not-a-duration",
|
||||
Scanners: []ScannerConfig{{Name: "clamav", URL: "http://scanner.invalid/scan"}},
|
||||
},
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "zero timeout fails",
|
||||
cfg: ScanningConfig{
|
||||
Enabled: true,
|
||||
SigningKey: "s3cret",
|
||||
Timeout: "0",
|
||||
Scanners: []ScannerConfig{{Name: "clamav", URL: "http://scanner.invalid/scan"}},
|
||||
},
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "empty timeout defaults and is valid",
|
||||
cfg: ScanningConfig{
|
||||
Enabled: true,
|
||||
SigningKey: "s3cret",
|
||||
Timeout: "",
|
||||
Scanners: []ScannerConfig{{Name: "clamav", URL: "http://scanner.invalid/scan"}},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "scanner missing name fails",
|
||||
cfg: ScanningConfig{
|
||||
Enabled: true,
|
||||
SigningKey: "s3cret",
|
||||
Scanners: []ScannerConfig{{URL: "http://scanner.invalid/scan"}},
|
||||
},
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "scanner with invalid url fails",
|
||||
cfg: ScanningConfig{
|
||||
Enabled: true,
|
||||
SigningKey: "s3cret",
|
||||
Scanners: []ScannerConfig{{Name: "clamav", URL: "not-a-url"}},
|
||||
},
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "scanner with invalid mode fails",
|
||||
cfg: ScanningConfig{
|
||||
Enabled: true,
|
||||
SigningKey: "s3cret",
|
||||
Scanners: []ScannerConfig{
|
||||
{Name: "clamav", URL: "http://scanner.invalid/scan", Mode: "quarantine"},
|
||||
},
|
||||
},
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "scanner with default mode is valid",
|
||||
cfg: ScanningConfig{
|
||||
Enabled: true,
|
||||
SigningKey: "s3cret",
|
||||
Scanners: []ScannerConfig{{Name: "clamav", URL: "http://scanner.invalid/scan"}},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
err := tt.cfg.Validate()
|
||||
if tt.wantErr && err == nil {
|
||||
t.Error("Validate() error = nil, want error")
|
||||
}
|
||||
if !tt.wantErr && err != nil {
|
||||
t.Errorf("Validate() unexpected error: %v", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseHTTPTimeout(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
timeout string
|
||||
want time.Duration
|
||||
}{
|
||||
{"empty defaults to 30s", "", 30 * time.Second},
|
||||
{"explicit zero disables", "0", 0},
|
||||
{"2 minutes", "2m", 2 * time.Minute},
|
||||
{"90 seconds", "90s", 90 * time.Second},
|
||||
{"invalid defaults to 30s", "not-a-duration", 30 * time.Second},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
cfg := Default()
|
||||
cfg.HTTPTimeout = tt.timeout
|
||||
got := cfg.ParseHTTPTimeout()
|
||||
if got != tt.want {
|
||||
t.Errorf("ParseHTTPTimeout() = %v, want %v", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidateHTTPTimeout(t *testing.T) {
|
||||
cfg := Default()
|
||||
cfg.HTTPTimeout = "not-a-duration"
|
||||
if err := cfg.Validate(); err == nil {
|
||||
t.Error("expected validation error for invalid http_timeout")
|
||||
}
|
||||
|
||||
cfg.HTTPTimeout = "-5s"
|
||||
if err := cfg.Validate(); err == nil {
|
||||
t.Error("expected validation error for negative http_timeout")
|
||||
}
|
||||
|
||||
cfg.HTTPTimeout = "2m"
|
||||
if err := cfg.Validate(); err != nil {
|
||||
t.Errorf("unexpected error for valid http_timeout: %v", err)
|
||||
}
|
||||
|
||||
cfg.HTTPTimeout = "0"
|
||||
if err := cfg.Validate(); err != nil {
|
||||
t.Errorf("unexpected error for zero http_timeout: %v", err)
|
||||
}
|
||||
|
||||
cfg.HTTPTimeout = ""
|
||||
if err := cfg.Validate(); err != nil {
|
||||
t.Errorf("unexpected error for empty http_timeout: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadHTTPTimeoutFromEnv(t *testing.T) {
|
||||
cfg := Default()
|
||||
t.Setenv("PROXY_HTTP_TIMEOUT", "90s")
|
||||
cfg.LoadFromEnv()
|
||||
|
||||
if cfg.HTTPTimeout != "90s" {
|
||||
t.Errorf("HTTPTimeout = %q, want %q", cfg.HTTPTimeout, "90s")
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadMetadataTTLFromEnv(t *testing.T) {
|
||||
cfg := Default()
|
||||
t.Setenv("PROXY_METADATA_TTL", "10m")
|
||||
|
|
@ -1039,40 +532,6 @@ func TestLoadDirectServeFromEnv(t *testing.T) {
|
|||
}
|
||||
}
|
||||
|
||||
func TestValidateUIBaseURLDefaultsToBaseURL(t *testing.T) {
|
||||
cfg := Default()
|
||||
cfg.BaseURL = "https://proxy.example.com"
|
||||
cfg.UIBaseURL = ""
|
||||
|
||||
if err := cfg.Validate(); err != nil {
|
||||
t.Fatalf("unexpected validation error: %v", err)
|
||||
}
|
||||
if cfg.UIBaseURL != "https://proxy.example.com" {
|
||||
t.Errorf("UIBaseURL = %q, want it to default to BaseURL %q", cfg.UIBaseURL, "https://proxy.example.com")
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidateUIBaseURL(t *testing.T) {
|
||||
cfg := Default()
|
||||
|
||||
cfg.UIBaseURL = "not a url"
|
||||
if err := cfg.Validate(); err == nil {
|
||||
t.Error("expected validation error for relative ui_base_url")
|
||||
}
|
||||
|
||||
cfg = Default()
|
||||
cfg.UIBaseURL = "://bad"
|
||||
if err := cfg.Validate(); err == nil {
|
||||
t.Error("expected validation error for unparseable ui_base_url")
|
||||
}
|
||||
|
||||
cfg = Default()
|
||||
cfg.UIBaseURL = "https://ui.example.com/ui"
|
||||
if err := cfg.Validate(); err != nil {
|
||||
t.Errorf("unexpected error for valid ui_base_url: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidateDirectServeBaseURL(t *testing.T) {
|
||||
cfg := Default()
|
||||
|
||||
|
|
@ -1091,168 +550,3 @@ func TestValidateDirectServeBaseURL(t *testing.T) {
|
|||
t.Errorf("unexpected error for valid direct_serve_base_url: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDatabaseConfigString(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
cfg DatabaseConfig
|
||||
want string
|
||||
}{
|
||||
{"sqlite", DatabaseConfig{Driver: "sqlite", Path: "./cache/proxy.db"}, "./cache/proxy.db"},
|
||||
{"default driver", DatabaseConfig{Path: "/var/lib/proxy.db"}, "/var/lib/proxy.db"},
|
||||
{"postgres no password", DatabaseConfig{Driver: "postgres", URL: "postgres://user@localhost:5432/proxy"}, "postgres://user@localhost:5432/proxy"},
|
||||
{"postgres redacts password", DatabaseConfig{Driver: "postgres", URL: "postgres://user:secret@localhost:5432/proxy?sslmode=disable"}, "postgres://user:xxxxx@localhost:5432/proxy?sslmode=disable"},
|
||||
{"postgres unparseable url", DatabaseConfig{Driver: "postgres", URL: "host=localhost user=foo password=bar"}, "postgres"},
|
||||
{"postgres ignores sqlite path", DatabaseConfig{Driver: "postgres", URL: "postgres://localhost/db", Path: "./cache/proxy.db"}, "postgres://localhost/db"},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
if got := tt.cfg.String(); got != tt.want {
|
||||
t.Errorf("%s: String() = %q, want %q", tt.name, got, tt.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestUpstreamAuthForURLMatchesURLComponents(t *testing.T) {
|
||||
registryAuth := AuthConfig{Type: "bearer", Token: "registry-token"}
|
||||
privateAuth := AuthConfig{Type: "bearer", Token: "private-token"}
|
||||
config := UpstreamConfig{Auth: map[string]AuthConfig{
|
||||
"https://registry.example.com": registryAuth,
|
||||
"https://registry.example.com/private": privateAuth,
|
||||
}}
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
url string
|
||||
wantToken string
|
||||
}{
|
||||
{name: "registry root", url: "https://registry.example.com/package", wantToken: "registry-token"},
|
||||
{name: "host is case insensitive", url: "https://REGISTRY.EXAMPLE.COM/package", wantToken: "registry-token"},
|
||||
{name: "longest path match", url: "https://registry.example.com/private/package", wantToken: "private-token"},
|
||||
{name: "exact path match", url: "https://registry.example.com/private", wantToken: "private-token"},
|
||||
{name: "path segment boundary", url: "https://registry.example.com/private-other/package", wantToken: "registry-token"},
|
||||
{name: "lookalike host rejected", url: "https://registry.example.com.evil.test/package"},
|
||||
{name: "different scheme rejected", url: "http://registry.example.com/package"},
|
||||
{name: "different port rejected", url: "https://registry.example.com:8443/package"},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
auth := config.AuthForURL(tt.url)
|
||||
if tt.wantToken == "" {
|
||||
if auth != nil {
|
||||
t.Fatalf("AuthForURL() = %+v, want nil", auth)
|
||||
}
|
||||
return
|
||||
}
|
||||
if auth == nil {
|
||||
t.Fatal("AuthForURL() = nil, want authentication")
|
||||
}
|
||||
if auth.Token != tt.wantToken {
|
||||
t.Errorf("token = %q, want %q", auth.Token, tt.wantToken)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidateUpstreamAuthURLs(t *testing.T) {
|
||||
t.Run("valid absolute URL", func(t *testing.T) {
|
||||
cfg := Default()
|
||||
cfg.Upstream.Auth = map[string]AuthConfig{
|
||||
"https://registry.example.com/private": {Type: "bearer", Token: "token"},
|
||||
}
|
||||
|
||||
if err := cfg.Validate(); err != nil {
|
||||
t.Fatalf("Validate() error = %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("invalid URL", func(t *testing.T) {
|
||||
cfg := Default()
|
||||
cfg.Upstream.Auth = map[string]AuthConfig{
|
||||
"registry.example.com": {Type: "bearer", Token: "token"},
|
||||
}
|
||||
|
||||
err := cfg.Validate()
|
||||
if err == nil {
|
||||
t.Fatal("Validate() error = nil, want invalid upstream.auth URL error")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "upstream.auth") || !strings.Contains(err.Error(), "registry.example.com") {
|
||||
t.Errorf("Validate() error = %q, want field and URL", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestValidateNamedUpstreams(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
modify func(*Config)
|
||||
wantErr bool
|
||||
}{
|
||||
{
|
||||
name: "valid Helm, OCI, APK, and generic upstreams",
|
||||
modify: func(cfg *Config) {
|
||||
cfg.Upstream.Helm = map[string]string{"bitnami": "https://charts.bitnami.com/bitnami"}
|
||||
cfg.Upstream.OCI = map[string]string{"ghcr": "https://ghcr.io"}
|
||||
cfg.Upstream.APK = map[string]string{"alpine": "https://dl-cdn.alpinelinux.org/alpine"}
|
||||
cfg.Upstream.Generic = map[string]string{
|
||||
"github": "https://github.com",
|
||||
"github-api": "https://api.github.com",
|
||||
}
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "generic upstream name contains path separator",
|
||||
modify: func(cfg *Config) {
|
||||
cfg.Upstream.Generic = map[string]string{"github/releases": "https://github.com"}
|
||||
},
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "generic upstream URL is not absolute",
|
||||
modify: func(cfg *Config) {
|
||||
cfg.Upstream.Generic = map[string]string{"github": "github.com"}
|
||||
},
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "Helm upstream name contains path separator",
|
||||
modify: func(cfg *Config) {
|
||||
cfg.Upstream.Helm = map[string]string{"team/charts": "https://charts.example.com"}
|
||||
},
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "OCI upstream URL is not absolute",
|
||||
modify: func(cfg *Config) {
|
||||
cfg.Upstream.OCI = map[string]string{"private": "registry.example.com"}
|
||||
},
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "APK upstream name contains path separator",
|
||||
modify: func(cfg *Config) {
|
||||
cfg.Upstream.APK = map[string]string{"alpine/edge": "https://dl-cdn.alpinelinux.org/alpine"}
|
||||
},
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "APK upstream URL is not absolute",
|
||||
modify: func(cfg *Config) {
|
||||
cfg.Upstream.APK = map[string]string{"private": "apk.example.com"}
|
||||
},
|
||||
wantErr: true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
cfg := Default()
|
||||
tt.modify(cfg)
|
||||
err := cfg.Validate()
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("Validate() error = %v, wantErr %t", err, tt.wantErr)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
|
|
|||
125
internal/cooldown/cooldown.go
Normal file
125
internal/cooldown/cooldown.go
Normal file
|
|
@ -0,0 +1,125 @@
|
|||
package cooldown
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
const hoursPerDay = 24
|
||||
|
||||
// Config holds cooldown settings for version filtering.
|
||||
// Cooldown hides package versions published too recently, giving the community
|
||||
// time to spot malicious releases before they're pulled into projects.
|
||||
type Config struct {
|
||||
// Default is the global default cooldown duration (e.g., "3d", "48h").
|
||||
Default string `json:"default" yaml:"default"`
|
||||
|
||||
// Ecosystems overrides the default for specific ecosystems.
|
||||
// Keys are ecosystem names (e.g., "npm", "pypi").
|
||||
Ecosystems map[string]string `json:"ecosystems" yaml:"ecosystems"`
|
||||
|
||||
// Packages overrides the cooldown for specific packages.
|
||||
// Keys are PURLs (e.g., "pkg:npm/lodash", "pkg:npm/@babel/core").
|
||||
Packages map[string]string `json:"packages" yaml:"packages"`
|
||||
|
||||
defaultDuration time.Duration
|
||||
ecosystemDurations map[string]time.Duration
|
||||
packageDurations map[string]time.Duration
|
||||
parsed bool
|
||||
}
|
||||
|
||||
// parse resolves all string durations into time.Duration values.
|
||||
// Called lazily on first use.
|
||||
func (c *Config) parse() {
|
||||
if c.parsed {
|
||||
return
|
||||
}
|
||||
c.parsed = true
|
||||
|
||||
c.defaultDuration, _ = ParseDuration(c.Default)
|
||||
|
||||
c.ecosystemDurations = make(map[string]time.Duration, len(c.Ecosystems))
|
||||
for k, v := range c.Ecosystems {
|
||||
d, _ := ParseDuration(v)
|
||||
c.ecosystemDurations[k] = d
|
||||
}
|
||||
|
||||
c.packageDurations = make(map[string]time.Duration, len(c.Packages))
|
||||
for k, v := range c.Packages {
|
||||
d, _ := ParseDuration(v)
|
||||
c.packageDurations[k] = d
|
||||
}
|
||||
}
|
||||
|
||||
// For returns the effective cooldown duration for a given ecosystem and package PURL.
|
||||
// Resolution order: package override > ecosystem override > global default.
|
||||
func (c *Config) For(ecosystem, packagePURL string) time.Duration {
|
||||
c.parse()
|
||||
|
||||
if d, ok := c.packageDurations[packagePURL]; ok {
|
||||
return d
|
||||
}
|
||||
if d, ok := c.ecosystemDurations[ecosystem]; ok {
|
||||
return d
|
||||
}
|
||||
return c.defaultDuration
|
||||
}
|
||||
|
||||
// IsAllowed returns true if a version with the given publish time has passed
|
||||
// the cooldown period for this ecosystem/package.
|
||||
func (c *Config) IsAllowed(ecosystem, packagePURL string, publishedAt time.Time) bool {
|
||||
d := c.For(ecosystem, packagePURL)
|
||||
if d == 0 {
|
||||
return true
|
||||
}
|
||||
if publishedAt.IsZero() {
|
||||
return true
|
||||
}
|
||||
return time.Since(publishedAt) >= d
|
||||
}
|
||||
|
||||
// Enabled returns true if any cooldown is configured.
|
||||
func (c *Config) Enabled() bool {
|
||||
c.parse()
|
||||
if c.defaultDuration > 0 {
|
||||
return true
|
||||
}
|
||||
for _, d := range c.ecosystemDurations {
|
||||
if d > 0 {
|
||||
return true
|
||||
}
|
||||
}
|
||||
for _, d := range c.packageDurations {
|
||||
if d > 0 {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// ParseDuration parses a duration string supporting days (e.g., "3d"),
|
||||
// in addition to Go's standard time.ParseDuration formats ("48h", "30m").
|
||||
// "0" means disabled (returns 0).
|
||||
func ParseDuration(s string) (time.Duration, error) {
|
||||
s = strings.TrimSpace(s)
|
||||
if s == "" || s == "0" {
|
||||
return 0, nil
|
||||
}
|
||||
|
||||
// Handle day suffix
|
||||
if numStr, ok := strings.CutSuffix(s, "d"); ok {
|
||||
days, err := strconv.ParseFloat(numStr, 64)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("invalid duration %q: %w", s, err)
|
||||
}
|
||||
return time.Duration(days * float64(hoursPerDay*time.Hour)), nil
|
||||
}
|
||||
|
||||
d, err := time.ParseDuration(s)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("invalid duration %q: %w", s, err)
|
||||
}
|
||||
return d, nil
|
||||
}
|
||||
133
internal/cooldown/cooldown_test.go
Normal file
133
internal/cooldown/cooldown_test.go
Normal file
|
|
@ -0,0 +1,133 @@
|
|||
package cooldown
|
||||
|
||||
import (
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
func TestParseDuration(t *testing.T) {
|
||||
tests := []struct {
|
||||
input string
|
||||
want time.Duration
|
||||
wantErr bool
|
||||
}{
|
||||
{"", 0, false},
|
||||
{"0", 0, false},
|
||||
{"3d", 3 * 24 * time.Hour, false},
|
||||
{"7d", 7 * 24 * time.Hour, false},
|
||||
{"14d", 14 * 24 * time.Hour, false},
|
||||
{"1.5d", 36 * time.Hour, false},
|
||||
{"48h", 48 * time.Hour, false},
|
||||
{"30m", 30 * time.Minute, false},
|
||||
{"1h30m", 90 * time.Minute, false},
|
||||
{"invalid", 0, true},
|
||||
{"d", 0, true},
|
||||
{"xd", 0, true},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
got, err := ParseDuration(tt.input)
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("ParseDuration(%q) error = %v, wantErr %v", tt.input, err, tt.wantErr)
|
||||
continue
|
||||
}
|
||||
if got != tt.want {
|
||||
t.Errorf("ParseDuration(%q) = %v, want %v", tt.input, got, tt.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestConfigFor(t *testing.T) {
|
||||
c := &Config{
|
||||
Default: "3d",
|
||||
Ecosystems: map[string]string{
|
||||
"npm": "7d",
|
||||
"cargo": "0",
|
||||
},
|
||||
Packages: map[string]string{
|
||||
"pkg:npm/lodash": "0",
|
||||
"pkg:npm/@babel/core": "14d",
|
||||
},
|
||||
}
|
||||
|
||||
tests := []struct {
|
||||
ecosystem string
|
||||
packagePURL string
|
||||
want time.Duration
|
||||
}{
|
||||
// Package override takes priority
|
||||
{"npm", "pkg:npm/lodash", 0},
|
||||
{"npm", "pkg:npm/@babel/core", 14 * 24 * time.Hour},
|
||||
// Ecosystem override
|
||||
{"npm", "pkg:npm/express", 7 * 24 * time.Hour},
|
||||
{"cargo", "pkg:cargo/serde", 0},
|
||||
// Global default
|
||||
{"pypi", "pkg:pypi/requests", 3 * 24 * time.Hour},
|
||||
{"pub", "pkg:pub/flutter", 3 * 24 * time.Hour},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
got := c.For(tt.ecosystem, tt.packagePURL)
|
||||
if got != tt.want {
|
||||
t.Errorf("For(%q, %q) = %v, want %v", tt.ecosystem, tt.packagePURL, got, tt.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestConfigIsAllowed(t *testing.T) {
|
||||
c := &Config{
|
||||
Default: "3d",
|
||||
Packages: map[string]string{
|
||||
"pkg:npm/lodash": "0",
|
||||
},
|
||||
}
|
||||
|
||||
now := time.Now()
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
ecosystem string
|
||||
packagePURL string
|
||||
publishedAt time.Time
|
||||
want bool
|
||||
}{
|
||||
{"old enough", "npm", "pkg:npm/express", now.Add(-4 * 24 * time.Hour), true},
|
||||
{"too recent", "npm", "pkg:npm/express", now.Add(-1 * 24 * time.Hour), false},
|
||||
{"exactly at boundary", "npm", "pkg:npm/express", now.Add(-3 * 24 * time.Hour), true},
|
||||
{"exempt package", "npm", "pkg:npm/lodash", now.Add(-1 * time.Minute), true},
|
||||
{"zero time", "npm", "pkg:npm/express", time.Time{}, true},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got := c.IsAllowed(tt.ecosystem, tt.packagePURL, tt.publishedAt)
|
||||
if got != tt.want {
|
||||
t.Errorf("IsAllowed(%q, %q, %v) = %v, want %v",
|
||||
tt.ecosystem, tt.packagePURL, tt.publishedAt, got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestConfigEnabled(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
cfg Config
|
||||
want bool
|
||||
}{
|
||||
{"empty config", Config{}, false},
|
||||
{"default only", Config{Default: "3d"}, true},
|
||||
{"ecosystem only", Config{Ecosystems: map[string]string{"npm": "7d"}}, true},
|
||||
{"package only", Config{Packages: map[string]string{"pkg:npm/x": "1d"}}, true},
|
||||
{"all zero", Config{Default: "0", Ecosystems: map[string]string{"npm": "0"}}, false},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got := tt.cfg.Enabled()
|
||||
if got != tt.want {
|
||||
t.Errorf("Enabled() = %v, want %v", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
|
@ -4,7 +4,6 @@ import (
|
|||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"time"
|
||||
|
||||
"github.com/jmoiron/sqlx"
|
||||
_ "github.com/lib/pq"
|
||||
|
|
@ -15,16 +14,6 @@ const SchemaVersion = 1
|
|||
|
||||
const dirPermissions = 0755
|
||||
|
||||
// Postgres connection pool limits. database/sql keeps only two idle
|
||||
// connections by default, which opens a new Postgres session for almost every
|
||||
// request under load.
|
||||
const (
|
||||
postgresMaxOpenConns = 32
|
||||
postgresMaxIdleConns = 32
|
||||
postgresConnMaxIdleTime = 5 * time.Minute
|
||||
postgresConnMaxLifetime = 30 * time.Minute
|
||||
)
|
||||
|
||||
type Dialect string
|
||||
|
||||
const (
|
||||
|
|
@ -105,11 +94,6 @@ func OpenPostgres(url string) (*DB, error) {
|
|||
return nil, fmt.Errorf("opening postgres database: %w", err)
|
||||
}
|
||||
|
||||
sqlDB.SetMaxOpenConns(postgresMaxOpenConns)
|
||||
sqlDB.SetMaxIdleConns(postgresMaxIdleConns)
|
||||
sqlDB.SetConnMaxIdleTime(postgresConnMaxIdleTime)
|
||||
sqlDB.SetConnMaxLifetime(postgresConnMaxLifetime)
|
||||
|
||||
if err := sqlDB.Ping(); err != nil {
|
||||
_ = sqlDB.Close()
|
||||
return nil, fmt.Errorf("connecting to postgres: %w", err)
|
||||
|
|
|
|||
|
|
@ -8,11 +8,6 @@ import (
|
|||
"time"
|
||||
)
|
||||
|
||||
const (
|
||||
testContentHash = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
|
||||
testIntegrity = "sha512-z4PhNX7vuL3xVChQ1m2AB9Yg5AULVxXcg/SpIdNs6c5H0NE8XYXysP+DGNKHfuwvY7kxvUdBeoGlODJ6+SfaPg=="
|
||||
)
|
||||
|
||||
func TestCreateAndOpen(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
dbPath := filepath.Join(dir, "test.db")
|
||||
|
|
@ -137,7 +132,7 @@ func TestVersionCRUD(t *testing.T) {
|
|||
v := &Version{
|
||||
PURL: "pkg:npm/lodash@4.17.21",
|
||||
PackagePURL: "pkg:npm/lodash",
|
||||
Integrity: sql.NullString{String: testIntegrity, Valid: true},
|
||||
Integrity: sql.NullString{String: "sha512-abc123", Valid: true},
|
||||
}
|
||||
|
||||
err = db.UpsertVersion(v)
|
||||
|
|
@ -205,7 +200,7 @@ func TestArtifactCRUD(t *testing.T) {
|
|||
t.Error("expected artifact to not be cached yet")
|
||||
}
|
||||
|
||||
err = db.MarkArtifactCached(versionPURL, "lodash-4.17.21.tgz", "/cache/npm/lodash-4.17.21.tgz", testContentHash, 12345, "application/gzip")
|
||||
err = db.MarkArtifactCached(versionPURL, "lodash-4.17.21.tgz", "/cache/npm/lodash-4.17.21.tgz", "sha256-abc", 12345, "application/gzip")
|
||||
if err != nil {
|
||||
t.Fatalf("MarkArtifactCached failed: %v", err)
|
||||
}
|
||||
|
|
@ -244,92 +239,6 @@ func TestArtifactCRUD(t *testing.T) {
|
|||
})
|
||||
}
|
||||
|
||||
func TestGetCachedArtifact(t *testing.T) {
|
||||
runWithBothDatabases(t, func(t *testing.T, db *DB) {
|
||||
const (
|
||||
packagePURL = "pkg:npm/lodash"
|
||||
versionPURL = "pkg:npm/lodash@4.17.21"
|
||||
filename = "lodash-4.17.21.tgz"
|
||||
)
|
||||
seedCachedArtifactTestData(t, db, packagePURL, versionPURL, filename)
|
||||
|
||||
cached, err := db.GetCachedArtifact(packagePURL, versionPURL, filename)
|
||||
if err != nil {
|
||||
t.Fatalf("GetCachedArtifact before cache failed: %v", err)
|
||||
}
|
||||
if cached != nil {
|
||||
t.Fatalf("expected no cached artifact, got %+v", cached)
|
||||
}
|
||||
|
||||
if err := db.MarkArtifactCached(versionPURL, filename, "/cache/npm/"+filename,
|
||||
testContentHash, 12345, "application/gzip"); err != nil {
|
||||
t.Fatalf("MarkArtifactCached failed: %v", err)
|
||||
}
|
||||
|
||||
cached, err = db.GetCachedArtifact(packagePURL, versionPURL, filename)
|
||||
if err != nil {
|
||||
t.Fatalf("GetCachedArtifact failed: %v", err)
|
||||
}
|
||||
if cached == nil {
|
||||
t.Fatal("expected cached artifact, got nil")
|
||||
}
|
||||
if cached.Ecosystem != "npm" {
|
||||
t.Errorf("expected npm ecosystem, got %q", cached.Ecosystem)
|
||||
}
|
||||
if cached.StoragePath != "/cache/npm/"+filename {
|
||||
t.Errorf("expected cached storage path, got %q", cached.StoragePath)
|
||||
}
|
||||
if cached.Artifact.PURL != versionPURL {
|
||||
t.Errorf("expected cached PURL %q, got %q", versionPURL, cached.Artifact.PURL)
|
||||
}
|
||||
if cached.Artifact.Digest.String() != "sha256:"+testContentHash {
|
||||
t.Errorf("expected cached digest, got %q", cached.Artifact.Digest)
|
||||
}
|
||||
if cached.Artifact.Size != 12345 {
|
||||
t.Errorf("expected cached size 12345, got %d", cached.Artifact.Size)
|
||||
}
|
||||
if cached.Artifact.Filename != filename {
|
||||
t.Errorf("expected cached filename %q, got %q", filename, cached.Artifact.Filename)
|
||||
}
|
||||
if cached.Artifact.MediaType != "application/gzip" {
|
||||
t.Errorf("expected cached content type, got %q", cached.Artifact.MediaType)
|
||||
}
|
||||
if cached.Integrity.String != testIntegrity {
|
||||
t.Errorf("expected cached integrity, got %q", cached.Integrity.String)
|
||||
}
|
||||
|
||||
cached, err = db.GetCachedArtifact("pkg:npm/other", versionPURL, filename)
|
||||
if err != nil {
|
||||
t.Fatalf("GetCachedArtifact with wrong package failed: %v", err)
|
||||
}
|
||||
if cached != nil {
|
||||
t.Fatalf("expected package mismatch to miss cache, got %+v", cached)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func seedCachedArtifactTestData(t *testing.T, db *DB, packagePURL, versionPURL, filename string) {
|
||||
t.Helper()
|
||||
|
||||
if err := db.UpsertPackage(&Package{PURL: packagePURL, Ecosystem: "npm", Name: "lodash"}); err != nil {
|
||||
t.Fatalf("UpsertPackage failed: %v", err)
|
||||
}
|
||||
if err := db.UpsertVersion(&Version{
|
||||
PURL: versionPURL,
|
||||
PackagePURL: packagePURL,
|
||||
Integrity: sql.NullString{String: testIntegrity, Valid: true},
|
||||
}); err != nil {
|
||||
t.Fatalf("UpsertVersion failed: %v", err)
|
||||
}
|
||||
if err := db.UpsertArtifact(&Artifact{
|
||||
VersionPURL: versionPURL,
|
||||
Filename: filename,
|
||||
UpstreamURL: "https://registry.npmjs.org/lodash/-/" + filename,
|
||||
}); err != nil {
|
||||
t.Fatalf("UpsertArtifact failed: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCacheManagement(t *testing.T) {
|
||||
runWithBothDatabases(t, func(t *testing.T, db *DB) {
|
||||
pkg := &Package{
|
||||
|
|
@ -610,10 +519,8 @@ func createTestPostgresDB(t *testing.T) *DB {
|
|||
t.Fatalf("OpenPostgres failed: %v", err)
|
||||
}
|
||||
|
||||
// Drop and recreate every table CreateSchema creates for clean test state;
|
||||
// leftover migration records make the next CreateSchema fail on the
|
||||
// migrations primary key.
|
||||
tables := []string{"artifacts", "versions", "packages", "vulnerabilities", "metadata_cache", "migrations", "schema_info"}
|
||||
// Drop and recreate tables for clean test state
|
||||
tables := []string{"artifacts", "versions", "packages", "schema_info"}
|
||||
for _, table := range tables {
|
||||
_, _ = db.Exec("DROP TABLE IF EXISTS " + table + " CASCADE")
|
||||
}
|
||||
|
|
@ -1107,56 +1014,3 @@ func BenchmarkMigrateSchemaFullyMigrated(b *testing.B) {
|
|||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestVersionPublishedAtPreserved(t *testing.T) {
|
||||
runWithBothDatabases(t, func(t *testing.T, db *DB) {
|
||||
publishedAt := time.Date(2020, 1, 2, 3, 4, 5, 0, time.UTC)
|
||||
|
||||
if err := db.SetVersionPublishedAt("pkg:npm/leftpad@1.0.0", "pkg:npm/leftpad", publishedAt); err != nil {
|
||||
t.Fatalf("SetVersionPublishedAt failed: %v", err)
|
||||
}
|
||||
|
||||
got, err := db.GetVersionByPURL("pkg:npm/leftpad@1.0.0")
|
||||
if err != nil || got == nil {
|
||||
t.Fatalf("GetVersionByPURL failed: %v", err)
|
||||
}
|
||||
if !got.PublishedAt.Valid || !got.PublishedAt.Time.Equal(publishedAt) {
|
||||
t.Fatalf("PublishedAt = %v, want %v", got.PublishedAt, publishedAt)
|
||||
}
|
||||
|
||||
// An upsert that carries no publish time (the artifact cache path)
|
||||
// must not erase the stored value.
|
||||
if err := db.UpsertVersion(&Version{
|
||||
PURL: "pkg:npm/leftpad@1.0.0",
|
||||
PackagePURL: "pkg:npm/leftpad",
|
||||
}); err != nil {
|
||||
t.Fatalf("UpsertVersion failed: %v", err)
|
||||
}
|
||||
|
||||
got, err = db.GetVersionByPURL("pkg:npm/leftpad@1.0.0")
|
||||
if err != nil || got == nil {
|
||||
t.Fatalf("GetVersionByPURL after upsert failed: %v", err)
|
||||
}
|
||||
if !got.PublishedAt.Valid || !got.PublishedAt.Time.Equal(publishedAt) {
|
||||
t.Fatalf("PublishedAt after null upsert = %v, want %v preserved", got.PublishedAt, publishedAt)
|
||||
}
|
||||
|
||||
// An upsert that does carry a publish time still updates it.
|
||||
later := publishedAt.Add(24 * time.Hour)
|
||||
if err := db.UpsertVersion(&Version{
|
||||
PURL: "pkg:npm/leftpad@1.0.0",
|
||||
PackagePURL: "pkg:npm/leftpad",
|
||||
PublishedAt: sql.NullTime{Time: later, Valid: true},
|
||||
}); err != nil {
|
||||
t.Fatalf("UpsertVersion with publish time failed: %v", err)
|
||||
}
|
||||
|
||||
got, err = db.GetVersionByPURL("pkg:npm/leftpad@1.0.0")
|
||||
if err != nil || got == nil {
|
||||
t.Fatalf("GetVersionByPURL after second upsert failed: %v", err)
|
||||
}
|
||||
if !got.PublishedAt.Valid || !got.PublishedAt.Time.Equal(later) {
|
||||
t.Fatalf("PublishedAt after valued upsert = %v, want %v", got.PublishedAt, later)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
|
|
|||
|
|
@ -29,12 +29,7 @@ func TestUpsertAndGetMetadataCache(t *testing.T) {
|
|||
Name: "lodash",
|
||||
StoragePath: "_metadata/npm/lodash/metadata",
|
||||
ETag: sql.NullString{String: `"abc123"`, Valid: true},
|
||||
Link: sql.NullString{String: `<https://registry.example.test/next>; rel="next"`, Valid: true},
|
||||
ContentType: sql.NullString{String: "application/json", Valid: true},
|
||||
ContentDigest: sql.NullString{
|
||||
String: "sha256:0123456789abcdef",
|
||||
Valid: true,
|
||||
},
|
||||
Size: sql.NullInt64{Int64: 1024, Valid: true},
|
||||
FetchedAt: sql.NullTime{Time: time.Now(), Valid: true},
|
||||
}
|
||||
|
|
@ -64,15 +59,9 @@ func TestUpsertAndGetMetadataCache(t *testing.T) {
|
|||
if !got.ETag.Valid || got.ETag.String != `"abc123"` {
|
||||
t.Errorf("etag = %v, want %q", got.ETag, `"abc123"`)
|
||||
}
|
||||
if !got.Link.Valid || got.Link.String != `<https://registry.example.test/next>; rel="next"` {
|
||||
t.Errorf("link = %v, want next link", got.Link)
|
||||
}
|
||||
if !got.ContentType.Valid || got.ContentType.String != "application/json" {
|
||||
t.Errorf("content_type = %v, want %q", got.ContentType, "application/json")
|
||||
}
|
||||
if !got.ContentDigest.Valid || got.ContentDigest.String != "sha256:0123456789abcdef" {
|
||||
t.Errorf("content_digest = %v, want %q", got.ContentDigest, "sha256:0123456789abcdef")
|
||||
}
|
||||
if !got.Size.Valid || got.Size.Int64 != 1024 {
|
||||
t.Errorf("size = %v, want 1024", got.Size)
|
||||
}
|
||||
|
|
@ -162,9 +151,6 @@ func TestUpsertMetadataCacheNullableFields(t *testing.T) {
|
|||
if got.ContentType.Valid {
|
||||
t.Error("expected null content_type")
|
||||
}
|
||||
if got.Link.Valid {
|
||||
t.Error("expected null link")
|
||||
}
|
||||
if got.Size.Valid {
|
||||
t.Error("expected null size")
|
||||
}
|
||||
|
|
@ -192,173 +178,3 @@ func TestMetadataCacheTableCreatedByMigration(t *testing.T) {
|
|||
t.Error("metadata_cache table should exist after migration")
|
||||
}
|
||||
}
|
||||
|
||||
func TestMetadataCacheContentDigestMigrationPreservesExistingRows(t *testing.T) {
|
||||
dbPath := filepath.Join(t.TempDir(), "test.db")
|
||||
db, err := Create(dbPath)
|
||||
if err != nil {
|
||||
t.Fatalf("Create failed: %v", err)
|
||||
}
|
||||
defer func() { _ = db.Close() }()
|
||||
|
||||
if _, err := db.Exec("ALTER TABLE metadata_cache DROP COLUMN content_digest"); err != nil {
|
||||
t.Fatalf("dropping content_digest: %v", err)
|
||||
}
|
||||
if _, err := db.Exec("DELETE FROM migrations WHERE name = ?", "006_add_metadata_content_digest"); err != nil {
|
||||
t.Fatalf("resetting digest migration: %v", err)
|
||||
}
|
||||
if _, err := db.Exec(`
|
||||
INSERT INTO metadata_cache (ecosystem, name, storage_path, content_type, size, fetched_at, created_at, updated_at)
|
||||
VALUES (?, ?, ?, ?, ?, ?, ?, ?)
|
||||
`, "oci-manifest", "cache-key", "_metadata/oci-manifest/cache-key/metadata", "application/json", 2, time.Now(), time.Now(), time.Now()); err != nil {
|
||||
t.Fatalf("inserting legacy cache row: %v", err)
|
||||
}
|
||||
|
||||
if err := db.MigrateSchema(); err != nil {
|
||||
t.Fatalf("MigrateSchema() error = %v", err)
|
||||
}
|
||||
hasDigest, err := db.HasColumn("metadata_cache", "content_digest")
|
||||
if err != nil {
|
||||
t.Fatalf("HasColumn() error = %v", err)
|
||||
}
|
||||
if !hasDigest {
|
||||
t.Fatal("metadata_cache.content_digest was not added")
|
||||
}
|
||||
|
||||
entry, err := db.GetMetadataCache("oci-manifest", "cache-key")
|
||||
if err != nil {
|
||||
t.Fatalf("GetMetadataCache() error = %v", err)
|
||||
}
|
||||
if entry == nil || entry.StoragePath != "_metadata/oci-manifest/cache-key/metadata" {
|
||||
t.Fatalf("existing metadata cache row was not preserved: %#v", entry)
|
||||
}
|
||||
if entry.ContentDigest.Valid {
|
||||
t.Errorf("legacy content digest = %q, want NULL", entry.ContentDigest.String)
|
||||
}
|
||||
}
|
||||
|
||||
func TestMetadataCacheLinkMigrationPreservesExistingRows(t *testing.T) {
|
||||
dbPath := filepath.Join(t.TempDir(), "test.db")
|
||||
db, err := Create(dbPath)
|
||||
if err != nil {
|
||||
t.Fatalf("Create failed: %v", err)
|
||||
}
|
||||
defer func() { _ = db.Close() }()
|
||||
|
||||
if _, err := db.Exec("ALTER TABLE metadata_cache DROP COLUMN link"); err != nil {
|
||||
t.Fatalf("dropping link: %v", err)
|
||||
}
|
||||
if _, err := db.Exec("DELETE FROM migrations WHERE name = ?", "007_add_metadata_link"); err != nil {
|
||||
t.Fatalf("resetting link migration: %v", err)
|
||||
}
|
||||
if _, err := db.Exec(`
|
||||
INSERT INTO metadata_cache (ecosystem, name, storage_path, content_type, size, fetched_at, created_at, updated_at)
|
||||
VALUES (?, ?, ?, ?, ?, ?, ?, ?)
|
||||
`, "oci-tags", "cache-key", "_metadata/oci-tags/cache-key/metadata", "application/json", 2, time.Now(), time.Now(), time.Now()); err != nil {
|
||||
t.Fatalf("inserting legacy cache row: %v", err)
|
||||
}
|
||||
|
||||
if err := db.MigrateSchema(); err != nil {
|
||||
t.Fatalf("MigrateSchema() error = %v", err)
|
||||
}
|
||||
hasLink, err := db.HasColumn("metadata_cache", "link")
|
||||
if err != nil {
|
||||
t.Fatalf("HasColumn() error = %v", err)
|
||||
}
|
||||
if !hasLink {
|
||||
t.Fatal("metadata_cache.link was not added")
|
||||
}
|
||||
|
||||
entry, err := db.GetMetadataCache("oci-tags", "cache-key")
|
||||
if err != nil {
|
||||
t.Fatalf("GetMetadataCache() error = %v", err)
|
||||
}
|
||||
if entry == nil || entry.StoragePath != "_metadata/oci-tags/cache-key/metadata" {
|
||||
t.Fatalf("existing metadata cache row was not preserved: %#v", entry)
|
||||
}
|
||||
if entry.Link.Valid {
|
||||
t.Errorf("legacy link = %q, want NULL", entry.Link.String)
|
||||
}
|
||||
}
|
||||
|
||||
func TestMetadataCacheContentEncodingMigrationPreservesExistingRows(t *testing.T) {
|
||||
dbPath := filepath.Join(t.TempDir(), "test.db")
|
||||
db, err := Create(dbPath)
|
||||
if err != nil {
|
||||
t.Fatalf("Create failed: %v", err)
|
||||
}
|
||||
defer func() { _ = db.Close() }()
|
||||
|
||||
if _, err := db.Exec("ALTER TABLE metadata_cache DROP COLUMN content_encoding"); err != nil {
|
||||
t.Fatalf("dropping content_encoding: %v", err)
|
||||
}
|
||||
if _, err := db.Exec("DELETE FROM migrations WHERE name = ?", "008_add_metadata_content_encoding"); err != nil {
|
||||
t.Fatalf("resetting content_encoding migration: %v", err)
|
||||
}
|
||||
if _, err := db.Exec(`
|
||||
INSERT INTO metadata_cache (ecosystem, name, storage_path, etag, content_type, size, fetched_at, created_at, updated_at)
|
||||
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)
|
||||
`, "apk", "cache-key", "_metadata/apk/cache-key/metadata", "\"legacy-etag\"", "application/octet-stream", 2, time.Now(), time.Now(), time.Now()); err != nil {
|
||||
t.Fatalf("inserting legacy cache row: %v", err)
|
||||
}
|
||||
|
||||
if err := db.MigrateSchema(); err != nil {
|
||||
t.Fatalf("MigrateSchema() error = %v", err)
|
||||
}
|
||||
hasEncoding, err := db.HasColumn("metadata_cache", "content_encoding")
|
||||
if err != nil {
|
||||
t.Fatalf("HasColumn() error = %v", err)
|
||||
}
|
||||
if !hasEncoding {
|
||||
t.Fatal("metadata_cache.content_encoding was not added")
|
||||
}
|
||||
|
||||
entry, err := db.GetMetadataCache("apk", "cache-key")
|
||||
if err != nil {
|
||||
t.Fatalf("GetMetadataCache() error = %v", err)
|
||||
}
|
||||
if entry == nil || entry.StoragePath != "_metadata/apk/cache-key/metadata" {
|
||||
t.Fatalf("existing metadata cache row was not preserved: %#v", entry)
|
||||
}
|
||||
if entry.ContentEncoding.Valid {
|
||||
t.Errorf("legacy content encoding = %q, want NULL", entry.ContentEncoding.String)
|
||||
}
|
||||
// The migration must clear the pre-fix validators so the row is refetched
|
||||
// once with identity instead of a 304 re-serving the decompressed copy.
|
||||
if entry.ETag.Valid {
|
||||
t.Errorf("legacy etag = %q, want cleared", entry.ETag.String)
|
||||
}
|
||||
if entry.FetchedAt.Valid {
|
||||
t.Errorf("legacy fetched_at = %v, want cleared", entry.FetchedAt.Time)
|
||||
}
|
||||
}
|
||||
|
||||
func TestMetadataCacheRoundTripsContentEncoding(t *testing.T) {
|
||||
dbPath := filepath.Join(t.TempDir(), "test.db")
|
||||
db, err := Create(dbPath)
|
||||
if err != nil {
|
||||
t.Fatalf("Create failed: %v", err)
|
||||
}
|
||||
defer func() { _ = db.Close() }()
|
||||
|
||||
entry := &MetadataCacheEntry{
|
||||
Ecosystem: "apk",
|
||||
Name: "index-key",
|
||||
StoragePath: "_metadata/apk/index-key/metadata",
|
||||
ContentType: sql.NullString{String: "application/octet-stream", Valid: true},
|
||||
ContentEncoding: sql.NullString{String: "gzip", Valid: true},
|
||||
Size: sql.NullInt64{Int64: 10, Valid: true},
|
||||
FetchedAt: sql.NullTime{Time: time.Now(), Valid: true},
|
||||
}
|
||||
if err := db.UpsertMetadataCache(entry); err != nil {
|
||||
t.Fatalf("UpsertMetadataCache() error = %v", err)
|
||||
}
|
||||
|
||||
got, err := db.GetMetadataCache("apk", "index-key")
|
||||
if err != nil {
|
||||
t.Fatalf("GetMetadataCache() error = %v", err)
|
||||
}
|
||||
if got == nil || !got.ContentEncoding.Valid || got.ContentEncoding.String != "gzip" {
|
||||
t.Fatalf("content encoding round-trip failed: %#v", got)
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,57 +0,0 @@
|
|||
package database
|
||||
|
||||
import (
|
||||
"context"
|
||||
"database/sql"
|
||||
"os"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// TestOpenPostgresKeepsConnectionsIdle checks the connection-count limits
|
||||
// OpenPostgres sets: the open cap admits a burst of postgresMaxIdleConns
|
||||
// connections, and releasing them again leaves all of them idle in the pool.
|
||||
// database/sql's default keeps only two, so the next burst would open a new
|
||||
// Postgres session for almost every request. The idle-time and lifetime
|
||||
// settings are not exercised here.
|
||||
func TestOpenPostgresKeepsConnectionsIdle(t *testing.T) {
|
||||
url := os.Getenv("PROXY_DATABASE_URL")
|
||||
if url == "" {
|
||||
t.Skip("PROXY_DATABASE_URL not set, skipping postgres pool test")
|
||||
}
|
||||
|
||||
db, err := OpenPostgres(url)
|
||||
if err != nil {
|
||||
t.Fatalf("OpenPostgres failed: %v", err)
|
||||
}
|
||||
defer func() { _ = db.Close() }()
|
||||
|
||||
const burst = postgresMaxIdleConns
|
||||
// database/sql keeps two idle connections by default; a burst that small
|
||||
// could not tell the tuned pool from the default one.
|
||||
if burst <= 2 {
|
||||
t.Fatalf("postgresMaxIdleConns = %d, want more than database/sql's default of 2", burst)
|
||||
}
|
||||
if got := db.Stats().MaxOpenConnections; got <= 0 || got < burst {
|
||||
t.Fatalf("MaxOpenConnections = %d, want a cap of at least %d", got, burst)
|
||||
}
|
||||
|
||||
conns := make([]*sql.Conn, 0, burst)
|
||||
for range burst {
|
||||
conn, err := db.Conn(context.Background())
|
||||
if err != nil {
|
||||
t.Fatalf("taking connection %d: %v", len(conns)+1, err)
|
||||
}
|
||||
t.Cleanup(func() { _ = conn.Close() }) // release the session if an assertion below fails
|
||||
conns = append(conns, conn)
|
||||
}
|
||||
if got := db.Stats().InUse; got != burst {
|
||||
t.Fatalf("InUse = %d while holding %d connections", got, burst)
|
||||
}
|
||||
|
||||
for _, conn := range conns {
|
||||
_ = conn.Close()
|
||||
}
|
||||
if got := db.Stats().Idle; got != burst {
|
||||
t.Errorf("Idle = %d after releasing %d connections, want all of them kept", got, burst)
|
||||
}
|
||||
}
|
||||
|
|
@ -4,9 +4,6 @@ import (
|
|||
"database/sql"
|
||||
"fmt"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/artifacts"
|
||||
"github.com/opencontainers/go-digest"
|
||||
)
|
||||
|
||||
// Package queries
|
||||
|
|
@ -144,7 +141,7 @@ func (db *DB) UpsertVersion(v *Version) error {
|
|||
ON CONFLICT(purl) DO UPDATE SET
|
||||
license = EXCLUDED.license,
|
||||
integrity = EXCLUDED.integrity,
|
||||
published_at = COALESCE(EXCLUDED.published_at, versions.published_at),
|
||||
published_at = EXCLUDED.published_at,
|
||||
yanked = EXCLUDED.yanked,
|
||||
enriched_at = EXCLUDED.enriched_at,
|
||||
updated_at = EXCLUDED.updated_at
|
||||
|
|
@ -157,7 +154,7 @@ func (db *DB) UpsertVersion(v *Version) error {
|
|||
ON CONFLICT(purl) DO UPDATE SET
|
||||
license = excluded.license,
|
||||
integrity = excluded.integrity,
|
||||
published_at = COALESCE(excluded.published_at, published_at),
|
||||
published_at = excluded.published_at,
|
||||
yanked = excluded.yanked,
|
||||
enriched_at = excluded.enriched_at,
|
||||
updated_at = excluded.updated_at
|
||||
|
|
@ -174,38 +171,6 @@ func (db *DB) UpsertVersion(v *Version) error {
|
|||
return nil
|
||||
}
|
||||
|
||||
// SetVersionPublishedAt records a version's publish time, creating the
|
||||
// versions row if the proxy has not seen the version yet. It only writes
|
||||
// published_at, so it never disturbs enrichment data on an existing row.
|
||||
func (db *DB) SetVersionPublishedAt(versionPURL, packagePURL string, publishedAt time.Time) error {
|
||||
now := time.Now()
|
||||
var query string
|
||||
|
||||
if db.dialect == DialectPostgres {
|
||||
query = `
|
||||
INSERT INTO versions (purl, package_purl, published_at, created_at, updated_at)
|
||||
VALUES ($1, $2, $3, $4, $5)
|
||||
ON CONFLICT(purl) DO UPDATE SET
|
||||
published_at = EXCLUDED.published_at,
|
||||
updated_at = EXCLUDED.updated_at
|
||||
`
|
||||
} else {
|
||||
query = `
|
||||
INSERT INTO versions (purl, package_purl, published_at, created_at, updated_at)
|
||||
VALUES (?, ?, ?, ?, ?)
|
||||
ON CONFLICT(purl) DO UPDATE SET
|
||||
published_at = excluded.published_at,
|
||||
updated_at = excluded.updated_at
|
||||
`
|
||||
}
|
||||
|
||||
_, err := db.Exec(query, versionPURL, packagePURL, publishedAt, now, now)
|
||||
if err != nil {
|
||||
return fmt.Errorf("setting version publish time: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// Artifact queries
|
||||
|
||||
func (db *DB) GetArtifact(versionPURL, filename string) (*Artifact, error) {
|
||||
|
|
@ -226,56 +191,6 @@ func (db *DB) GetArtifact(versionPURL, filename string) (*Artifact, error) {
|
|||
return &a, nil
|
||||
}
|
||||
|
||||
// GetCachedArtifact returns the fields needed to serve a cached artifact.
|
||||
func (db *DB) GetCachedArtifact(packagePURL, versionPURL, filename string) (*CachedArtifact, error) {
|
||||
var row cachedArtifactRow
|
||||
query := db.Rebind(`
|
||||
SELECT packages.ecosystem, artifacts.storage_path, artifacts.content_hash, artifacts.size,
|
||||
artifacts.content_type, versions.integrity
|
||||
FROM artifacts
|
||||
JOIN versions ON versions.purl = artifacts.version_purl
|
||||
JOIN packages ON packages.purl = versions.package_purl
|
||||
WHERE packages.purl = ? AND artifacts.version_purl = ? AND artifacts.filename = ?
|
||||
AND artifacts.storage_path IS NOT NULL AND artifacts.fetched_at IS NOT NULL
|
||||
`)
|
||||
err := db.Get(&row, query, packagePURL, versionPURL, filename)
|
||||
if err == sql.ErrNoRows {
|
||||
return nil, nil
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return row.artifact(versionPURL, filename), nil
|
||||
}
|
||||
|
||||
type cachedArtifactRow struct {
|
||||
Ecosystem string `db:"ecosystem"`
|
||||
StoragePath string `db:"storage_path"`
|
||||
ContentHash sql.NullString `db:"content_hash"`
|
||||
Size sql.NullInt64 `db:"size"`
|
||||
ContentType sql.NullString `db:"content_type"`
|
||||
Integrity sql.NullString `db:"integrity"`
|
||||
}
|
||||
|
||||
// artifact converts a cached artifact row to a CachedArtifact without
|
||||
// validation. A malformed hash or integrity value is handled by
|
||||
// checkCache, which clears the record and treats the request as a cache
|
||||
// miss so the client is served a fresh fetch instead of an error.
|
||||
func (row cachedArtifactRow) artifact(versionPURL, filename string) *CachedArtifact {
|
||||
return &CachedArtifact{
|
||||
Ecosystem: row.Ecosystem,
|
||||
StoragePath: row.StoragePath,
|
||||
Integrity: row.Integrity,
|
||||
Artifact: artifacts.Artifact{
|
||||
PURL: versionPURL,
|
||||
Digest: digest.Digest("sha256:" + row.ContentHash.String),
|
||||
Size: row.Size.Int64,
|
||||
Filename: filename,
|
||||
MediaType: row.ContentType.String,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func (db *DB) GetArtifactByPath(storagePath string) (*Artifact, error) {
|
||||
var a Artifact
|
||||
query := db.Rebind(`
|
||||
|
|
@ -530,12 +445,9 @@ func (db *DB) GetMostPopularPackages(limit int) ([]PopularPackage, error) {
|
|||
type RecentPackage struct {
|
||||
Ecosystem string `db:"ecosystem"`
|
||||
Name string `db:"name"`
|
||||
VersionPURL string `db:"version_purl"`
|
||||
Version string `db:"version"`
|
||||
CachedAt time.Time `db:"fetched_at"`
|
||||
Size int64 `db:"size"`
|
||||
// Version is derived from VersionPURL rather than selected, so that the
|
||||
// PURL percent-encoding is decoded (e.g. "%2B" back to "+").
|
||||
Version string `db:"-"`
|
||||
}
|
||||
|
||||
func (db *DB) GetRecentlyCachedPackages(limit int) ([]RecentPackage, error) {
|
||||
|
|
@ -549,10 +461,10 @@ func (db *DB) GetRecentlyCachedPackages(limit int) ([]RecentPackage, error) {
|
|||
}
|
||||
|
||||
var packages []RecentPackage
|
||||
// There is no separate version column, so the full version PURL is selected
|
||||
// and the version is decoded from it in Go.
|
||||
// We need to extract version from the purl since there's no separate version column
|
||||
query := db.Rebind(`
|
||||
SELECT p.ecosystem, p.name, v.purl as version_purl,
|
||||
SELECT p.ecosystem, p.name,
|
||||
SUBSTR(v.purl, INSTR(v.purl, '@') + 1) as version,
|
||||
a.fetched_at, COALESCE(a.size, 0) as size
|
||||
FROM artifacts a
|
||||
JOIN versions v ON v.purl = a.version_purl
|
||||
|
|
@ -562,13 +474,25 @@ func (db *DB) GetRecentlyCachedPackages(limit int) ([]RecentPackage, error) {
|
|||
LIMIT ?
|
||||
`)
|
||||
|
||||
// For postgres, use different string function
|
||||
if db.dialect == DialectPostgres {
|
||||
query = db.Rebind(`
|
||||
SELECT p.ecosystem, p.name,
|
||||
SUBSTRING(v.purl FROM POSITION('@' IN v.purl) + 1) as version,
|
||||
a.fetched_at, COALESCE(a.size, 0) as size
|
||||
FROM artifacts a
|
||||
JOIN versions v ON v.purl = a.version_purl
|
||||
JOIN packages p ON p.purl = v.package_purl
|
||||
WHERE a.storage_path IS NOT NULL AND a.fetched_at IS NOT NULL
|
||||
ORDER BY a.fetched_at DESC
|
||||
LIMIT ?
|
||||
`)
|
||||
}
|
||||
|
||||
err = db.Select(&packages, query, limit)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
for i := range packages {
|
||||
packages[i].Version = VersionFromPURL(packages[i].VersionPURL)
|
||||
}
|
||||
return packages, nil
|
||||
}
|
||||
|
||||
|
|
@ -969,8 +893,8 @@ func (db *DB) CountCachedPackages(ecosystem string) (int64, error) {
|
|||
func (db *DB) GetMetadataCache(ecosystem, name string) (*MetadataCacheEntry, error) {
|
||||
var entry MetadataCacheEntry
|
||||
query := db.Rebind(`
|
||||
SELECT id, ecosystem, name, storage_path, etag, link, content_type, content_encoding,
|
||||
content_digest, size, last_modified, fetched_at, created_at, updated_at
|
||||
SELECT id, ecosystem, name, storage_path, etag, content_type,
|
||||
size, last_modified, fetched_at, created_at, updated_at
|
||||
FROM metadata_cache WHERE ecosystem = ? AND name = ?
|
||||
`)
|
||||
err := db.Get(&entry, query, ecosystem, name)
|
||||
|
|
@ -989,16 +913,13 @@ func (db *DB) UpsertMetadataCache(entry *MetadataCacheEntry) error {
|
|||
|
||||
if db.dialect == DialectPostgres {
|
||||
query = `
|
||||
INSERT INTO metadata_cache (ecosystem, name, storage_path, etag, link, content_type, content_encoding,
|
||||
content_digest, size, last_modified, fetched_at, created_at, updated_at)
|
||||
VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13)
|
||||
INSERT INTO metadata_cache (ecosystem, name, storage_path, etag, content_type,
|
||||
size, last_modified, fetched_at, created_at, updated_at)
|
||||
VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10)
|
||||
ON CONFLICT(ecosystem, name) DO UPDATE SET
|
||||
storage_path = EXCLUDED.storage_path,
|
||||
etag = EXCLUDED.etag,
|
||||
link = EXCLUDED.link,
|
||||
content_type = EXCLUDED.content_type,
|
||||
content_encoding = EXCLUDED.content_encoding,
|
||||
content_digest = EXCLUDED.content_digest,
|
||||
size = EXCLUDED.size,
|
||||
last_modified = EXCLUDED.last_modified,
|
||||
fetched_at = EXCLUDED.fetched_at,
|
||||
|
|
@ -1006,16 +927,13 @@ func (db *DB) UpsertMetadataCache(entry *MetadataCacheEntry) error {
|
|||
`
|
||||
} else {
|
||||
query = `
|
||||
INSERT INTO metadata_cache (ecosystem, name, storage_path, etag, link, content_type, content_encoding,
|
||||
content_digest, size, last_modified, fetched_at, created_at, updated_at)
|
||||
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
|
||||
INSERT INTO metadata_cache (ecosystem, name, storage_path, etag, content_type,
|
||||
size, last_modified, fetched_at, created_at, updated_at)
|
||||
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
|
||||
ON CONFLICT(ecosystem, name) DO UPDATE SET
|
||||
storage_path = excluded.storage_path,
|
||||
etag = excluded.etag,
|
||||
link = excluded.link,
|
||||
content_type = excluded.content_type,
|
||||
content_encoding = excluded.content_encoding,
|
||||
content_digest = excluded.content_digest,
|
||||
size = excluded.size,
|
||||
last_modified = excluded.last_modified,
|
||||
fetched_at = excluded.fetched_at,
|
||||
|
|
@ -1024,8 +942,8 @@ func (db *DB) UpsertMetadataCache(entry *MetadataCacheEntry) error {
|
|||
}
|
||||
|
||||
_, err := db.Exec(query,
|
||||
entry.Ecosystem, entry.Name, entry.StoragePath, entry.ETag, entry.Link,
|
||||
entry.ContentType, entry.ContentEncoding, entry.ContentDigest, entry.Size, entry.LastModified, entry.FetchedAt, now, now,
|
||||
entry.Ecosystem, entry.Name, entry.StoragePath, entry.ETag,
|
||||
entry.ContentType, entry.Size, entry.LastModified, entry.FetchedAt, now, now,
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("upserting metadata cache: %w", err)
|
||||
|
|
|
|||
|
|
@ -101,10 +101,7 @@ CREATE TABLE IF NOT EXISTS metadata_cache (
|
|||
name TEXT NOT NULL,
|
||||
storage_path TEXT NOT NULL,
|
||||
etag TEXT,
|
||||
link TEXT,
|
||||
content_type TEXT,
|
||||
content_encoding TEXT,
|
||||
content_digest TEXT,
|
||||
size INTEGER,
|
||||
last_modified DATETIME,
|
||||
fetched_at DATETIME,
|
||||
|
|
@ -204,10 +201,7 @@ CREATE TABLE IF NOT EXISTS metadata_cache (
|
|||
name TEXT NOT NULL,
|
||||
storage_path TEXT NOT NULL,
|
||||
etag TEXT,
|
||||
link TEXT,
|
||||
content_type TEXT,
|
||||
content_encoding TEXT,
|
||||
content_digest TEXT,
|
||||
size BIGINT,
|
||||
last_modified TIMESTAMP,
|
||||
fetched_at TIMESTAMP,
|
||||
|
|
@ -365,9 +359,6 @@ var migrations = []migration{
|
|||
{"003_ensure_artifacts_table", migrateEnsureArtifactsTable},
|
||||
{"004_ensure_vulnerabilities_table", migrateEnsureVulnerabilitiesTable},
|
||||
{"005_ensure_metadata_cache_table", migrateEnsureMetadataCacheTable},
|
||||
{"006_add_metadata_content_digest", migrateAddMetadataContentDigest},
|
||||
{"007_add_metadata_link", migrateAddMetadataLink},
|
||||
{"008_add_metadata_content_encoding", migrateAddMetadataContentEncoding},
|
||||
}
|
||||
|
||||
// isTableNotFound returns true if the error indicates a missing table.
|
||||
|
|
@ -590,56 +581,6 @@ func migrateEnsureMetadataCacheTable(db *DB) error {
|
|||
return db.EnsureMetadataCacheTable()
|
||||
}
|
||||
|
||||
func migrateAddMetadataContentDigest(db *DB) error {
|
||||
hasColumn, err := db.HasColumn("metadata_cache", "content_digest")
|
||||
if err != nil {
|
||||
return fmt.Errorf("checking metadata_cache content_digest column: %w", err)
|
||||
}
|
||||
if hasColumn {
|
||||
return nil
|
||||
}
|
||||
if _, err := db.Exec("ALTER TABLE metadata_cache ADD COLUMN content_digest TEXT"); err != nil {
|
||||
return fmt.Errorf("adding metadata_cache content_digest column: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func migrateAddMetadataLink(db *DB) error {
|
||||
hasColumn, err := db.HasColumn("metadata_cache", "link")
|
||||
if err != nil {
|
||||
return fmt.Errorf("checking metadata_cache link column: %w", err)
|
||||
}
|
||||
if hasColumn {
|
||||
return nil
|
||||
}
|
||||
if _, err := db.Exec("ALTER TABLE metadata_cache ADD COLUMN link TEXT"); err != nil {
|
||||
return fmt.Errorf("adding metadata_cache link column: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func migrateAddMetadataContentEncoding(db *DB) error {
|
||||
hasColumn, err := db.HasColumn("metadata_cache", "content_encoding")
|
||||
if err != nil {
|
||||
return fmt.Errorf("checking metadata_cache content_encoding column: %w", err)
|
||||
}
|
||||
if hasColumn {
|
||||
return nil
|
||||
}
|
||||
if _, err := db.Exec("ALTER TABLE metadata_cache ADD COLUMN content_encoding TEXT"); err != nil {
|
||||
return fmt.Errorf("adding metadata_cache content_encoding column: %w", err)
|
||||
}
|
||||
// Rows cached before this column existed hold transport-decompressed bytes
|
||||
// with no recorded encoding and the upstream ETag captured under Go's
|
||||
// auto-added Accept-Encoding: gzip. Clearing the validators forces one fresh
|
||||
// fetch per key so the encoding is recorded and verbatim bytes are restored,
|
||||
// instead of an If-None-Match 304 re-serving the stale decompressed copy.
|
||||
if _, err := db.Exec("UPDATE metadata_cache SET etag = NULL, fetched_at = NULL"); err != nil {
|
||||
return fmt.Errorf("invalidating metadata_cache validators: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// EnsureMetadataCacheTable creates the metadata_cache table if it doesn't exist.
|
||||
func (db *DB) EnsureMetadataCacheTable() error {
|
||||
has, err := db.HasTable("metadata_cache")
|
||||
|
|
@ -659,10 +600,7 @@ func (db *DB) EnsureMetadataCacheTable() error {
|
|||
name TEXT NOT NULL,
|
||||
storage_path TEXT NOT NULL,
|
||||
etag TEXT,
|
||||
link TEXT,
|
||||
content_type TEXT,
|
||||
content_encoding TEXT,
|
||||
content_digest TEXT,
|
||||
size BIGINT,
|
||||
last_modified TIMESTAMP,
|
||||
fetched_at TIMESTAMP,
|
||||
|
|
@ -679,10 +617,7 @@ func (db *DB) EnsureMetadataCacheTable() error {
|
|||
name TEXT NOT NULL,
|
||||
storage_path TEXT NOT NULL,
|
||||
etag TEXT,
|
||||
link TEXT,
|
||||
content_type TEXT,
|
||||
content_encoding TEXT,
|
||||
content_digest TEXT,
|
||||
size INTEGER,
|
||||
last_modified DATETIME,
|
||||
fetched_at DATETIME,
|
||||
|
|
|
|||
|
|
@ -2,11 +2,8 @@ package database
|
|||
|
||||
import (
|
||||
"database/sql"
|
||||
"net/url"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/artifacts"
|
||||
)
|
||||
|
||||
// Package represents a package in the database.
|
||||
|
|
@ -50,80 +47,11 @@ type Version struct {
|
|||
// Version extracts the version string from the PURL.
|
||||
// e.g., "pkg:npm/lodash@4.17.21" -> "4.17.21"
|
||||
func (v *Version) Version() string {
|
||||
return VersionFromPURL(v.PURL)
|
||||
if idx := strings.LastIndex(v.PURL, "@"); idx >= 0 {
|
||||
return v.PURL[idx+1:]
|
||||
}
|
||||
|
||||
// EscapedVersion returns the version escaped for use as a single URL path
|
||||
// segment.
|
||||
//
|
||||
// Version returns decoded text, which is what should be shown to a user but is
|
||||
// not safe to drop into a link: html/template preserves reserved characters and
|
||||
// existing escapes in a URL, so "release/1" would split into two path segments,
|
||||
// "v1?build" would start a query string, and a literal "%2B" would be read back
|
||||
// as "+". Escaping here and decoding in splitWildcardPath round-trips the value,
|
||||
// so the link resolves to the version that was stored.
|
||||
func (v *Version) EscapedVersion() string {
|
||||
return url.PathEscape(v.Version())
|
||||
}
|
||||
|
||||
// DisplayPURL returns the PURL with its path components percent-decoded, for
|
||||
// showing in the UI. The stored PURL keeps the canonical encoding (which is
|
||||
// what the API and all lookups use); this is only a readable rendering, so that
|
||||
// a version like "7.91+dfsg1-2ubuntu0.1" is not shown as "7.91%2Bdfsg1-2ubuntu0.1"
|
||||
// and an npm scope is shown as "@babel" rather than "%40babel". Qualifiers and
|
||||
// subpath keep their encoding, since decoding those would be ambiguous.
|
||||
func (v *Version) DisplayPURL() string {
|
||||
base, suffix := v.PURL, ""
|
||||
if i := strings.IndexAny(base, "?#"); i >= 0 {
|
||||
base, suffix = base[:i], base[i:]
|
||||
}
|
||||
|
||||
name, version := base, ""
|
||||
if idx := strings.LastIndex(base, "@"); idx >= 0 {
|
||||
name, version = base[:idx], "@"+decodePURLComponent(base[idx+1:])
|
||||
}
|
||||
|
||||
parts := strings.Split(name, "/")
|
||||
for i, part := range parts {
|
||||
parts[i] = decodePURLComponent(part)
|
||||
}
|
||||
return strings.Join(parts, "/") + version + suffix
|
||||
}
|
||||
|
||||
// VersionFromPURL extracts the decoded version string from a PURL.
|
||||
//
|
||||
// PURL percent-encodes characters that are not safe in a path component, so a
|
||||
// Debian version like "7.91+dfsg1-2ubuntu0.1" is stored as
|
||||
// "pkg:deb/nmap@7.91%2Bdfsg1-2ubuntu0.1". The raw substring after "@" is
|
||||
// therefore not the version: it must be percent-decoded before being displayed
|
||||
// or used to build a URL, otherwise "%2B" leaks into the UI and round-tripping
|
||||
// the value back into a PURL double-encodes it.
|
||||
//
|
||||
// e.g., "pkg:npm/lodash@4.17.21" -> "4.17.21"
|
||||
func VersionFromPURL(p string) string {
|
||||
// Qualifiers ("?key=value") and subpath ("#path") follow the version.
|
||||
if i := strings.IndexAny(p, "?#"); i >= 0 {
|
||||
p = p[:i]
|
||||
}
|
||||
idx := strings.LastIndex(p, "@")
|
||||
if idx < 0 {
|
||||
return ""
|
||||
}
|
||||
return decodePURLComponent(p[idx+1:])
|
||||
}
|
||||
|
||||
// decodePURLComponent percent-decodes a single PURL path component, returning
|
||||
// the input unchanged if it is not valid percent-encoding.
|
||||
func decodePURLComponent(s string) string {
|
||||
if !strings.Contains(s, "%") {
|
||||
return s
|
||||
}
|
||||
decoded, err := url.PathUnescape(s)
|
||||
if err != nil {
|
||||
return s
|
||||
}
|
||||
return decoded
|
||||
}
|
||||
|
||||
// Artifact represents a cached artifact in the database.
|
||||
// This table is proxy-specific and not part of git-pkgs.
|
||||
|
|
@ -148,14 +76,6 @@ func (a *Artifact) IsCached() bool {
|
|||
return a.StoragePath.Valid && a.FetchedAt.Valid
|
||||
}
|
||||
|
||||
// CachedArtifact contains the fields needed to serve a cached artifact.
|
||||
type CachedArtifact struct {
|
||||
Ecosystem string
|
||||
StoragePath string
|
||||
Artifact artifacts.Artifact
|
||||
Integrity sql.NullString
|
||||
}
|
||||
|
||||
// MetadataCacheEntry represents a cached metadata blob for offline serving.
|
||||
type MetadataCacheEntry struct {
|
||||
ID int64 `db:"id" json:"id"`
|
||||
|
|
@ -163,10 +83,7 @@ type MetadataCacheEntry struct {
|
|||
Name string `db:"name" json:"name"`
|
||||
StoragePath string `db:"storage_path" json:"storage_path"`
|
||||
ETag sql.NullString `db:"etag" json:"etag,omitempty"`
|
||||
Link sql.NullString `db:"link" json:"link,omitempty"`
|
||||
ContentType sql.NullString `db:"content_type" json:"content_type,omitempty"`
|
||||
ContentEncoding sql.NullString `db:"content_encoding" json:"content_encoding,omitempty"`
|
||||
ContentDigest sql.NullString `db:"content_digest" json:"content_digest,omitempty"`
|
||||
Size sql.NullInt64 `db:"size" json:"size,omitempty"`
|
||||
LastModified sql.NullTime `db:"last_modified" json:"last_modified,omitempty"`
|
||||
FetchedAt sql.NullTime `db:"fetched_at" json:"fetched_at,omitempty"`
|
||||
|
|
|
|||
|
|
@ -1,159 +0,0 @@
|
|||
package database
|
||||
|
||||
import (
|
||||
"database/sql"
|
||||
"net/url"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
func TestVersionFromPURL(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
purl string
|
||||
want string
|
||||
}{
|
||||
{"simple", "pkg:npm/lodash@4.17.21", "4.17.21"},
|
||||
{"namespaced", "pkg:composer/symfony/console@6.0.0", "6.0.0"},
|
||||
// Debian/Ubuntu versions routinely contain "+", which PURL encodes.
|
||||
{"encoded plus", "pkg:deb/nmap@7.91%2Bdfsg1%2Breally7.80%2Bdfsg1-2ubuntu0.1", "7.91+dfsg1+really7.80+dfsg1-2ubuntu0.1"},
|
||||
{"encoded epoch", "pkg:deb/curl@1%3A7.81.0-1", "1:7.81.0-1"},
|
||||
{"encoded plus with qualifier", "pkg:deb/nmap@7.91%2Bdfsg1?repository_url=http%3A%2F%2Fexample.com", "7.91+dfsg1"},
|
||||
{"tilde is not encoded", "pkg:deb/foo@1.0~rc1", "1.0~rc1"},
|
||||
{"no version", "pkg:npm/lodash", ""},
|
||||
{"invalid escape passed through", "pkg:npm/lodash@1.0%zz", "1.0%zz"},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
if got := VersionFromPURL(tt.purl); got != tt.want {
|
||||
t.Errorf("VersionFromPURL(%q) = %q, want %q", tt.purl, got, tt.want)
|
||||
}
|
||||
v := &Version{PURL: tt.purl}
|
||||
if got := v.Version(); got != tt.want {
|
||||
t.Errorf("Version.Version() for %q = %q, want %q", tt.purl, got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestVersionEscapedVersion checks the value the templates put in a URL. It
|
||||
// must survive the round trip back through the router: escaping here and
|
||||
// decoding per path segment on the way in has to yield the original version.
|
||||
func TestVersionEscapedVersion(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
purl string
|
||||
want string
|
||||
}{
|
||||
{"simple", "pkg:npm/lodash@4.17.21", "4.17.21"},
|
||||
// "+" is legal in a path segment, so it stays literal and the UI keeps
|
||||
// showing the version the way Debian writes it.
|
||||
{"plus stays literal", "pkg:deb/nmap@7.91%2Bdfsg1-2ubuntu0.1", "7.91+dfsg1-2ubuntu0.1"},
|
||||
// A slash would otherwise split the version into two path segments.
|
||||
{"slash", "pkg:golang/example@release%2F1", "release%2F1"},
|
||||
// A question mark would otherwise start the query string.
|
||||
{"question mark", "pkg:npm/example@v1%3Fbuild", "v1%3Fbuild"},
|
||||
// A version containing a literal "%2B" is stored double-encoded; the
|
||||
// link must re-encode it or it decodes back to "+" instead.
|
||||
{"literal percent escape", "pkg:npm/example@1.0%252B", "1.0%252B"},
|
||||
{"space", "pkg:npm/example@1.0%20beta", "1.0%20beta"},
|
||||
{"no version", "pkg:npm/lodash", ""},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
v := &Version{PURL: tt.purl}
|
||||
got := v.EscapedVersion()
|
||||
if got != tt.want {
|
||||
t.Errorf("EscapedVersion() for %q = %q, want %q", tt.purl, got, tt.want)
|
||||
}
|
||||
// The router decodes each path segment, which must give back the
|
||||
// version the page displays.
|
||||
decoded, err := url.PathUnescape(got)
|
||||
if err != nil {
|
||||
t.Fatalf("PathUnescape(%q) failed: %v", got, err)
|
||||
}
|
||||
if decoded != v.Version() {
|
||||
t.Errorf("round trip for %q = %q, want %q", tt.purl, decoded, v.Version())
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestVersionDisplayPURL(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
purl string
|
||||
want string
|
||||
}{
|
||||
{"simple", "pkg:npm/lodash@4.17.21", "pkg:npm/lodash@4.17.21"},
|
||||
{
|
||||
"encoded plus",
|
||||
"pkg:deb/nmap@7.91%2Bdfsg1%2Breally7.80%2Bdfsg1-2ubuntu0.1",
|
||||
"pkg:deb/nmap@7.91+dfsg1+really7.80+dfsg1-2ubuntu0.1",
|
||||
},
|
||||
{
|
||||
"qualifier preserved",
|
||||
"pkg:deb/nmap@7.91%2Bdfsg1?repository_url=http%3A%2F%2Fexample.com",
|
||||
"pkg:deb/nmap@7.91+dfsg1?repository_url=http%3A%2F%2Fexample.com",
|
||||
},
|
||||
// The namespace is encoded too: MakePURLString("npm", "@babel/core", …)
|
||||
// produces "pkg:npm/%40babel/core@…".
|
||||
{"encoded npm scope", "pkg:npm/%40babel/core@7.0.0", "pkg:npm/@babel/core@7.0.0"},
|
||||
{"encoded scope without version", "pkg:npm/%40babel/core", "pkg:npm/@babel/core"},
|
||||
{"no version", "pkg:npm/lodash", "pkg:npm/lodash"},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
v := &Version{PURL: tt.purl}
|
||||
if got := v.DisplayPURL(); got != tt.want {
|
||||
t.Errorf("DisplayPURL() for %q = %q, want %q", tt.purl, got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestGetRecentlyCachedPackagesDecodesVersion guards the dashboard's "recently
|
||||
// cached" list, which derives the version from the version PURL.
|
||||
func TestGetRecentlyCachedPackagesDecodesVersion(t *testing.T) {
|
||||
runWithBothDatabases(t, func(t *testing.T, db *DB) {
|
||||
const versionPURL = "pkg:deb/nmap@7.91%2Bdfsg1%2Breally7.80%2Bdfsg1-2ubuntu0.1"
|
||||
|
||||
if err := db.UpsertPackage(&Package{
|
||||
PURL: "pkg:deb/nmap", Ecosystem: "deb", Name: "nmap",
|
||||
}); err != nil {
|
||||
t.Fatalf("UpsertPackage failed: %v", err)
|
||||
}
|
||||
if err := db.UpsertVersion(&Version{
|
||||
PURL: versionPURL, PackagePURL: "pkg:deb/nmap",
|
||||
}); err != nil {
|
||||
t.Fatalf("UpsertVersion failed: %v", err)
|
||||
}
|
||||
if err := db.UpsertArtifact(&Artifact{
|
||||
VersionPURL: versionPURL,
|
||||
Filename: "nmap_7.91+dfsg1+really7.80+dfsg1-2ubuntu0.1_amd64.deb",
|
||||
UpstreamURL: "http://archive.ubuntu.com/ubuntu/pool/universe/n/nmap/nmap.deb",
|
||||
StoragePath: sql.NullString{String: "/cache/nmap.deb", Valid: true},
|
||||
FetchedAt: sql.NullTime{Time: time.Now(), Valid: true},
|
||||
}); err != nil {
|
||||
t.Fatalf("UpsertArtifact failed: %v", err)
|
||||
}
|
||||
|
||||
recent, err := db.GetRecentlyCachedPackages(10)
|
||||
if err != nil {
|
||||
t.Fatalf("GetRecentlyCachedPackages failed: %v", err)
|
||||
}
|
||||
if len(recent) != 1 {
|
||||
t.Fatalf("expected 1 recent package, got %d", len(recent))
|
||||
}
|
||||
const want = "7.91+dfsg1+really7.80+dfsg1-2ubuntu0.1"
|
||||
if recent[0].Version != want {
|
||||
t.Errorf("Version = %q, want %q", recent[0].Version, want)
|
||||
}
|
||||
if recent[0].VersionPURL != versionPURL {
|
||||
t.Errorf("VersionPURL = %q, want %q", recent[0].VersionPURL, versionPURL)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
|
@ -9,7 +9,6 @@ import (
|
|||
"sync"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/proxy/internal/packageurl"
|
||||
"github.com/git-pkgs/purl"
|
||||
"github.com/git-pkgs/registries"
|
||||
_ "github.com/git-pkgs/registries/all" // Import all registry implementations
|
||||
|
|
@ -68,10 +67,7 @@ type VulnInfo struct {
|
|||
|
||||
// EnrichPackage fetches metadata for a package from registry APIs.
|
||||
func (s *Service) EnrichPackage(ctx context.Context, ecosystem, name string) (*PackageInfo, error) {
|
||||
purlStr := packageurl.MakeString(ecosystem, name, "")
|
||||
if purlStr == "" {
|
||||
return nil, nil
|
||||
}
|
||||
purlStr := purl.MakePURLString(ecosystem, name, "")
|
||||
|
||||
pkg, err := registries.FetchPackageFromPURL(ctx, purlStr, s.regClient)
|
||||
if err != nil {
|
||||
|
|
@ -106,10 +102,7 @@ func (s *Service) EnrichPackage(ctx context.Context, ecosystem, name string) (*P
|
|||
|
||||
// EnrichVersion fetches metadata for a specific package version.
|
||||
func (s *Service) EnrichVersion(ctx context.Context, ecosystem, name, version string) (*VersionInfo, error) {
|
||||
purlStr := packageurl.MakeString(ecosystem, name, version)
|
||||
if purlStr == "" {
|
||||
return nil, nil
|
||||
}
|
||||
purlStr := purl.MakePURLString(ecosystem, name, version)
|
||||
|
||||
ver, err := registries.FetchVersionFromPURL(ctx, purlStr, s.regClient)
|
||||
if err != nil {
|
||||
|
|
@ -141,14 +134,9 @@ func (s *Service) EnrichVersion(ctx context.Context, ecosystem, name, version st
|
|||
|
||||
// BulkEnrichPackages fetches metadata for multiple packages in parallel.
|
||||
func (s *Service) BulkEnrichPackages(ctx context.Context, packages []struct{ Ecosystem, Name string }) map[string]*PackageInfo {
|
||||
purls := make([]string, 0, len(packages))
|
||||
for _, pkg := range packages {
|
||||
if purlStr := packageurl.MakeString(pkg.Ecosystem, pkg.Name, ""); purlStr != "" {
|
||||
purls = append(purls, purlStr)
|
||||
}
|
||||
}
|
||||
if len(purls) == 0 {
|
||||
return map[string]*PackageInfo{}
|
||||
purls := make([]string, len(packages))
|
||||
for i, pkg := range packages {
|
||||
purls[i] = purl.MakePURLString(pkg.Ecosystem, pkg.Name, "")
|
||||
}
|
||||
|
||||
pkgData := registries.BulkFetchPackages(ctx, purls, s.regClient)
|
||||
|
|
@ -159,10 +147,7 @@ func (s *Service) BulkEnrichPackages(ctx context.Context, packages []struct{ Eco
|
|||
continue
|
||||
}
|
||||
|
||||
p, err := purl.Parse(purlStr)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
p, _ := purl.Parse(purlStr)
|
||||
info := &PackageInfo{
|
||||
Ecosystem: p.Type,
|
||||
Name: pkg.Name,
|
||||
|
|
@ -189,10 +174,7 @@ func (s *Service) BulkEnrichPackages(ctx context.Context, packages []struct{ Eco
|
|||
|
||||
// CheckVulnerabilities queries for vulnerabilities affecting a package version.
|
||||
func (s *Service) CheckVulnerabilities(ctx context.Context, ecosystem, name, version string) ([]VulnInfo, error) {
|
||||
p := packageurl.Make(ecosystem, name, version)
|
||||
if p == nil {
|
||||
return nil, nil
|
||||
}
|
||||
p := purl.MakePURL(ecosystem, name, version)
|
||||
|
||||
vulnList, err := s.vulnSource.Query(ctx, p)
|
||||
if err != nil {
|
||||
|
|
@ -219,6 +201,43 @@ func (s *Service) CheckVulnerabilities(ctx context.Context, ecosystem, name, ver
|
|||
return results, nil
|
||||
}
|
||||
|
||||
// BulkCheckVulnerabilities queries vulnerabilities for multiple package versions.
|
||||
func (s *Service) BulkCheckVulnerabilities(ctx context.Context, packages []struct{ Ecosystem, Name, Version string }) (map[string][]VulnInfo, error) {
|
||||
purls := make([]*purl.PURL, len(packages))
|
||||
for i, pkg := range packages {
|
||||
purls[i] = purl.MakePURL(pkg.Ecosystem, pkg.Name, pkg.Version)
|
||||
}
|
||||
|
||||
vulnResults, err := s.vulnSource.QueryBatch(ctx, purls)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
result := make(map[string][]VulnInfo, len(packages))
|
||||
for i, vulnList := range vulnResults {
|
||||
pkg := packages[i]
|
||||
key := purl.MakePURLString(pkg.Ecosystem, pkg.Name, pkg.Version)
|
||||
|
||||
var infos []VulnInfo
|
||||
for _, v := range vulnList {
|
||||
info := VulnInfo{
|
||||
ID: v.ID,
|
||||
Summary: v.Summary,
|
||||
Severity: v.SeverityLevel(),
|
||||
CVSSScore: v.CVSSScore(),
|
||||
FixedVersion: v.FixedVersion(pkg.Ecosystem, pkg.Name),
|
||||
}
|
||||
for _, ref := range v.References {
|
||||
info.References = append(info.References, ref.URL)
|
||||
}
|
||||
infos = append(infos, info)
|
||||
}
|
||||
result[key] = infos
|
||||
}
|
||||
|
||||
return result, nil
|
||||
}
|
||||
|
||||
// IsOutdated checks if a version is older than the latest version.
|
||||
func (s *Service) IsOutdated(currentVersion, latestVersion string) bool {
|
||||
if latestVersion == "" || currentVersion == "" {
|
||||
|
|
@ -229,10 +248,7 @@ func (s *Service) IsOutdated(currentVersion, latestVersion string) bool {
|
|||
|
||||
// GetLatestVersion fetches the latest version for a package.
|
||||
func (s *Service) GetLatestVersion(ctx context.Context, ecosystem, name string) (string, error) {
|
||||
purlStr := packageurl.MakeString(ecosystem, name, "")
|
||||
if purlStr == "" {
|
||||
return "", nil
|
||||
}
|
||||
purlStr := purl.MakePURLString(ecosystem, name, "")
|
||||
|
||||
latest, err := registries.FetchLatestVersionFromPURL(ctx, purlStr, s.regClient)
|
||||
if err != nil {
|
||||
|
|
@ -272,6 +288,19 @@ func (s *Service) CategorizeLicense(license string) LicenseCategory {
|
|||
return LicenseUnknown
|
||||
}
|
||||
|
||||
// NormalizeLicense normalizes a license string to SPDX format.
|
||||
func (s *Service) NormalizeLicense(license string) string {
|
||||
if license == "" {
|
||||
return ""
|
||||
}
|
||||
|
||||
if normalized, err := spdx.NormalizeExpressionLax(license); err == nil {
|
||||
return normalized
|
||||
}
|
||||
|
||||
return license
|
||||
}
|
||||
|
||||
// EnrichmentResult contains all enrichment data for a package version.
|
||||
type EnrichmentResult struct {
|
||||
Package *PackageInfo
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
package enrichment
|
||||
|
||||
import (
|
||||
"context"
|
||||
"log/slog"
|
||||
"os"
|
||||
"testing"
|
||||
|
|
@ -24,36 +23,6 @@ func TestNew(t *testing.T) {
|
|||
}
|
||||
}
|
||||
|
||||
func TestSwiftRegistryIdentitySkipsPURLDependentLookups(t *testing.T) {
|
||||
svc := New(slog.New(slog.NewTextHandler(os.Stdout, nil)))
|
||||
ctx := context.Background()
|
||||
|
||||
packageInfo, err := svc.EnrichPackage(ctx, "swift", "apple/example")
|
||||
if err != nil || packageInfo != nil {
|
||||
t.Errorf("EnrichPackage() = %#v, %v; want nil, nil", packageInfo, err)
|
||||
}
|
||||
|
||||
versionInfo, err := svc.EnrichVersion(ctx, "swift", "apple/example", "1.2.3")
|
||||
if err != nil || versionInfo != nil {
|
||||
t.Errorf("EnrichVersion() = %#v, %v; want nil, nil", versionInfo, err)
|
||||
}
|
||||
|
||||
vulnerabilities, err := svc.CheckVulnerabilities(ctx, "swift", "apple/example", "1.2.3")
|
||||
if err != nil || vulnerabilities != nil {
|
||||
t.Errorf("CheckVulnerabilities() = %#v, %v; want nil, nil", vulnerabilities, err)
|
||||
}
|
||||
|
||||
latest, err := svc.GetLatestVersion(ctx, "swift", "apple/example")
|
||||
if err != nil || latest != "" {
|
||||
t.Errorf("GetLatestVersion() = %q, %v; want empty string, nil", latest, err)
|
||||
}
|
||||
|
||||
packages := []struct{ Ecosystem, Name string }{{Ecosystem: "swift", Name: "apple/example"}}
|
||||
if got := svc.BulkEnrichPackages(ctx, packages); len(got) != 0 {
|
||||
t.Errorf("BulkEnrichPackages() = %#v, want empty result", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestIsOutdated(t *testing.T) {
|
||||
logger := slog.New(slog.NewTextHandler(os.Stdout, nil))
|
||||
svc := New(logger)
|
||||
|
|
@ -105,3 +74,25 @@ func TestCategorizeLicense(t *testing.T) {
|
|||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestNormalizeLicense(t *testing.T) {
|
||||
logger := slog.New(slog.NewTextHandler(os.Stdout, nil))
|
||||
svc := New(logger)
|
||||
|
||||
tests := []struct {
|
||||
input string
|
||||
expected string
|
||||
}{
|
||||
{"MIT", "MIT"},
|
||||
{"Apache 2", "Apache-2.0"},
|
||||
{"Apache-2.0", "Apache-2.0"},
|
||||
{"", ""},
|
||||
}
|
||||
|
||||
for _, tc := range tests {
|
||||
result := svc.NormalizeLicense(tc.input)
|
||||
if result != tc.expected {
|
||||
t.Errorf("NormalizeLicense(%q) = %q, want %q", tc.input, result, tc.expected)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,186 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"crypto/sha256"
|
||||
"encoding/hex"
|
||||
"net/http"
|
||||
"regexp"
|
||||
"strings"
|
||||
)
|
||||
|
||||
const (
|
||||
apkEcosystem = "alpine"
|
||||
// defaultAPKRepositoryName is the repository name used when no
|
||||
// upstream.apk repositories are configured.
|
||||
defaultAPKRepositoryName = "alpine"
|
||||
// defaultAPKUpstream is the official Alpine Linux mirror.
|
||||
defaultAPKUpstream = "https://dl-cdn.alpinelinux.org/alpine"
|
||||
apkMatchCount = 3 // full match + name + version
|
||||
)
|
||||
|
||||
// APKHandler handles Alpine APK repository protocol requests. Each configured
|
||||
// upstream repository is mounted at /apk/{repository}/ and the remaining path
|
||||
// mirrors the upstream layout ({release}/{repo}/{arch}/{file}).
|
||||
//
|
||||
// Repository indexes (v2 APKINDEX.tar.gz, v3 Packages.adb) and detached
|
||||
// signatures are served byte-for-byte unchanged through the metadata cache so
|
||||
// apk signature verification keeps working. Package files are cached in the
|
||||
// shared artifact cache and stay available when the upstream is unreachable.
|
||||
type APKHandler struct {
|
||||
proxy *Proxy
|
||||
proxyURL string
|
||||
repositories map[string]string
|
||||
}
|
||||
|
||||
// NewAPKHandler creates an Alpine APK repository protocol handler.
|
||||
// When repositories is empty, a single repository named "alpine" pointing at
|
||||
// the official Alpine mirror is used.
|
||||
func NewAPKHandler(proxy *Proxy, proxyURL string, repositories map[string]string) *APKHandler {
|
||||
h := &APKHandler{
|
||||
proxy: proxy,
|
||||
proxyURL: strings.TrimSuffix(proxyURL, "/"),
|
||||
repositories: make(map[string]string, len(repositories)),
|
||||
}
|
||||
for name, repositoryURL := range repositories {
|
||||
h.repositories[name] = strings.TrimSuffix(repositoryURL, "/")
|
||||
}
|
||||
if len(h.repositories) == 0 {
|
||||
h.repositories[defaultAPKRepositoryName] = defaultAPKUpstream
|
||||
}
|
||||
return h
|
||||
}
|
||||
|
||||
// Routes returns the HTTP handler for APK requests.
|
||||
// Mount this at /apk on your router.
|
||||
func (h *APKHandler) Routes() http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.Method != http.MethodGet && r.Method != http.MethodHead {
|
||||
http.Error(w, "method not allowed", http.StatusMethodNotAllowed)
|
||||
return
|
||||
}
|
||||
|
||||
path := strings.TrimPrefix(r.URL.Path, "/")
|
||||
|
||||
if containsPathTraversal(path) {
|
||||
http.Error(w, "invalid path", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
repository, rest, ok := strings.Cut(path, "/")
|
||||
upstreamURL, found := h.repositories[repository]
|
||||
if !ok || rest == "" || !found {
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
|
||||
switch {
|
||||
case isAPKIndex(rest) || isAPKSignature(rest):
|
||||
// Indexes and detached signatures are signed upstream metadata.
|
||||
// Cache them with the metadata TTL and serve the stored bytes
|
||||
// unchanged so apk verification continues to work.
|
||||
h.handleMetadata(w, r, repository, upstreamURL, rest)
|
||||
case strings.HasSuffix(rest, ".apk"):
|
||||
// Package downloads - cache these in the artifact cache.
|
||||
h.handlePackageDownload(w, r, repository, upstreamURL, rest)
|
||||
default:
|
||||
// Other files - proxy directly.
|
||||
h.proxyFile(w, r, upstreamURL, rest)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// isAPKIndex reports whether the path names a repository index:
|
||||
// APKINDEX.tar.gz (apk v2) or Packages.adb (apk v3).
|
||||
func isAPKIndex(path string) bool {
|
||||
base := path[strings.LastIndex(path, "/")+1:]
|
||||
return base == "APKINDEX.tar.gz" || base == "Packages.adb"
|
||||
}
|
||||
|
||||
// isAPKSignature reports whether the path names a detached signature file.
|
||||
func isAPKSignature(path string) bool {
|
||||
return strings.HasSuffix(path, ".sig") || strings.HasSuffix(path, ".rsa.pub")
|
||||
}
|
||||
|
||||
// handlePackageDownload fetches and caches .apk packages.
|
||||
// Path format: {release}/{repo}/{arch}/{name}-{version}-r{rel}.apk
|
||||
// Example: v3.22/main/x86_64/busybox-1.37.0-r12.apk
|
||||
//
|
||||
// APK filenames do not include the architecture, so the same filename can hold
|
||||
// different bytes per architecture (and per release). The full request path is
|
||||
// therefore part of the cache identity.
|
||||
func (h *APKHandler) handlePackageDownload(w http.ResponseWriter, r *http.Request, repository, upstreamURL, path string) {
|
||||
name, version, arch := h.parseAPKPath(path)
|
||||
if name == "" {
|
||||
// Can't parse, just proxy directly
|
||||
h.proxyFile(w, r, upstreamURL, path)
|
||||
return
|
||||
}
|
||||
|
||||
downloadURL := upstreamURL + "/" + path
|
||||
cacheFilename := repository + "/" + path
|
||||
|
||||
h.proxy.Logger.Info("apk package download",
|
||||
"repository", repository, "name", name, "version", version, "arch", arch)
|
||||
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURL(
|
||||
r.Context(), apkEcosystem, name, version, cacheFilename, downloadURL)
|
||||
if err != nil {
|
||||
h.proxy.serveArtifactError(w, err, "failed to fetch package")
|
||||
return
|
||||
}
|
||||
|
||||
if result.Artifact.MediaType == "" {
|
||||
result.Artifact.MediaType = "application/octet-stream"
|
||||
}
|
||||
serveArtifact(w, r.Method, result)
|
||||
}
|
||||
|
||||
// handleMetadata serves repository indexes and signatures through the
|
||||
// metadata cache. Stored bytes are re-served verbatim, which keeps embedded
|
||||
// and detached signatures valid.
|
||||
func (h *APKHandler) handleMetadata(w http.ResponseWriter, r *http.Request, repository, upstreamURL, path string) {
|
||||
h.proxy.ProxyCached(w, r, upstreamURL+"/"+path, apkEcosystem,
|
||||
h.metadataCacheKey(repository, upstreamURL, path), "*/*")
|
||||
}
|
||||
|
||||
// metadataCacheKey derives the metadata cache key from the repository name,
|
||||
// its upstream URL, and the request path. Hashing the identity keeps distinct
|
||||
// repositories from sharing cache entries (repository names may contain '_'
|
||||
// and a separator-based key would be ambiguous) and drops cached entries when
|
||||
// a repository is repointed at a different upstream, mirroring
|
||||
// HelmHandler.indexCacheKey.
|
||||
func (h *APKHandler) metadataCacheKey(repository, upstreamURL, path string) string {
|
||||
identity := repository + "\x00" + upstreamURL + "\x00" + path
|
||||
digest := sha256.Sum256([]byte(identity))
|
||||
return hex.EncodeToString(digest[:])
|
||||
}
|
||||
|
||||
// proxyFile proxies any file directly without caching.
|
||||
func (h *APKHandler) proxyFile(w http.ResponseWriter, r *http.Request, upstreamURL, path string) {
|
||||
h.proxy.ProxyFile(w, r, upstreamURL+"/"+path)
|
||||
}
|
||||
|
||||
// apkPackagePattern matches .apk filenames to extract name and version.
|
||||
// Format: {name}-{version}-r{rel}.apk where version starts with a digit.
|
||||
// Examples:
|
||||
// - busybox-1.37.0-r12.apk
|
||||
// - alpine-baselayout-data-3.7.0-r0.apk
|
||||
var apkPackagePattern = regexp.MustCompile(`^(.+)-(\d[^-]*-r\d+)\.apk$`)
|
||||
|
||||
// parseAPKPath extracts package info from a path containing an APK filename.
|
||||
// The architecture is taken from the parent directory since APK filenames do
|
||||
// not include it.
|
||||
func (h *APKHandler) parseAPKPath(path string) (name, version, arch string) {
|
||||
segments := strings.Split(path, "/")
|
||||
filename := segments[len(segments)-1]
|
||||
if len(segments) > 1 {
|
||||
arch = segments[len(segments)-2]
|
||||
}
|
||||
|
||||
matches := apkPackagePattern.FindStringSubmatch(filename)
|
||||
if len(matches) != apkMatchCount {
|
||||
return "", "", ""
|
||||
}
|
||||
|
||||
return matches[1], matches[2], arch
|
||||
}
|
||||
|
|
@ -1,362 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/registries/fetch"
|
||||
)
|
||||
|
||||
func TestAPKHandler_parseAPKPath(t *testing.T) {
|
||||
h := &APKHandler{}
|
||||
|
||||
assertPathParser(t, "parseAPKPath", h.parseAPKPath, []pathParseCase{
|
||||
{"v3.22/main/x86_64/busybox-1.37.0-r12.apk", "busybox", "1.37.0-r12", "x86_64"},
|
||||
{"v3.22/main/aarch64/alpine-baselayout-data-3.7.0-r0.apk", "alpine-baselayout-data", "3.7.0-r0", "aarch64"},
|
||||
{"edge/community/x86_64/openjdk21-jre-21.0.2_p13-r1.apk", "openjdk21-jre", "21.0.2_p13-r1", "x86_64"},
|
||||
{"busybox-1.37.0-r12.apk", "busybox", "1.37.0-r12", ""},
|
||||
{"v3.22/main/x86_64/invalid.apk", "", "", ""},
|
||||
{"v3.22/main/x86_64/not-an-apk-file", "", "", ""},
|
||||
})
|
||||
}
|
||||
|
||||
func TestAPKHandler_Routes(t *testing.T) {
|
||||
h := NewAPKHandler(nil, "http://localhost:8080", nil)
|
||||
assertRoutesBasics(t, h.Routes(), "/alpine/v3.22/main/x86_64/APKINDEX.tar.gz", "/alpine/v3.22/../../../etc/passwd")
|
||||
}
|
||||
|
||||
func TestAPKHandler_DefaultsToOfficialMirror(t *testing.T) {
|
||||
h := NewAPKHandler(nil, "http://localhost:8080", nil)
|
||||
if got := h.repositories[defaultAPKRepositoryName]; got != defaultAPKUpstream {
|
||||
t.Errorf("default repository = %q, want %q", got, defaultAPKUpstream)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAPKHandler_UnknownRepositoryReturns404(t *testing.T) {
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
h := NewAPKHandler(proxy, "http://localhost:8080", map[string]string{"alpine": "https://example.test"})
|
||||
|
||||
for _, target := range []string{
|
||||
"/unknown/v3.22/main/x86_64/APKINDEX.tar.gz",
|
||||
"/alpine",
|
||||
"/",
|
||||
} {
|
||||
w := serveAPKRequest(h, target)
|
||||
if w.Code != http.StatusNotFound {
|
||||
t.Errorf("%s: status = %d, want 404", target, w.Code)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestAPKHandler_MetadataCacheKeysDoNotCollideAcrossRepositories guards the
|
||||
// hashed metadata cache key: with a separator-based key, repositories named
|
||||
// "alpine" and "alpine_edge" would share cache entries for
|
||||
// /alpine/edge/main/x86_64/APKINDEX.tar.gz and
|
||||
// /alpine_edge/main/x86_64/APKINDEX.tar.gz, serving one repository's signed
|
||||
// index to clients of the other.
|
||||
func TestAPKHandler_MetadataCacheKeysDoNotCollideAcrossRepositories(t *testing.T) {
|
||||
indexA := "signed index of repository A"
|
||||
upstreamA := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.URL.Path != "/edge/main/x86_64/APKINDEX.tar.gz" {
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
_, _ = fmt.Fprint(w, indexA)
|
||||
}))
|
||||
defer upstreamA.Close()
|
||||
|
||||
indexB := "signed index of repository B"
|
||||
upstreamB := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.URL.Path != "/main/x86_64/APKINDEX.tar.gz" {
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
_, _ = fmt.Fprint(w, indexB)
|
||||
}))
|
||||
defer upstreamB.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = true
|
||||
proxy.MetadataTTL = time.Hour
|
||||
proxy.HTTPClient = http.DefaultClient
|
||||
|
||||
h := NewAPKHandler(proxy, "http://proxy.example", map[string]string{
|
||||
"alpine": upstreamA.URL,
|
||||
"alpine_edge": upstreamB.URL,
|
||||
})
|
||||
|
||||
first := serveAPKRequest(h, "/alpine/edge/main/x86_64/APKINDEX.tar.gz")
|
||||
if first.Code != http.StatusOK || first.Body.String() != indexA {
|
||||
t.Fatalf("repository A: status = %d, body = %q, want 200 %q", first.Code, first.Body.String(), indexA)
|
||||
}
|
||||
|
||||
// Served within the metadata TTL: a colliding key would return indexA here.
|
||||
second := serveAPKRequest(h, "/alpine_edge/main/x86_64/APKINDEX.tar.gz")
|
||||
if second.Code != http.StatusOK {
|
||||
t.Fatalf("repository B: status = %d, want 200: %s", second.Code, second.Body.String())
|
||||
}
|
||||
if second.Body.String() != indexB {
|
||||
t.Errorf("repository B served %q, want %q (cache key collision)", second.Body.String(), indexB)
|
||||
}
|
||||
}
|
||||
|
||||
// TestAPKHandler_IndexesServedUnchanged covers v2 (APKINDEX.tar.gz) and v3
|
||||
// (Packages.adb) indexes plus detached signatures: bytes must be served
|
||||
// unchanged so apk signature verification keeps working, and within the
|
||||
// metadata TTL cached copies must be served without contacting the upstream
|
||||
// (the stale-after-TTL fallback itself is covered by the shared ProxyCached
|
||||
// tests).
|
||||
func TestAPKHandler_IndexesServedUnchanged(t *testing.T) {
|
||||
files := map[string][]byte{
|
||||
"/v3.22/main/x86_64/APKINDEX.tar.gz": []byte("\x1f\x8b\x08v2-index-with-embedded-signature"),
|
||||
"/v3.22/main/x86_64/Packages.adb": []byte("ADB.v3-index-binary\x00payload"),
|
||||
"/v3.22/main/x86_64/Packages.adb.sig": []byte("detached-signature-bytes"),
|
||||
}
|
||||
|
||||
var available atomic.Bool
|
||||
available.Store(true)
|
||||
var upstreamRequests atomic.Int32
|
||||
var authHeader string
|
||||
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if !available.Load() {
|
||||
http.Error(w, "unavailable", http.StatusServiceUnavailable)
|
||||
return
|
||||
}
|
||||
authHeader = r.Header.Get("Authorization")
|
||||
data, ok := files[r.URL.Path]
|
||||
if !ok {
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
upstreamRequests.Add(1)
|
||||
w.Header().Set("Content-Type", "application/octet-stream")
|
||||
_, _ = w.Write(data)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = true
|
||||
proxy.MetadataTTL = time.Hour
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
proxy.AuthForURL = func(string) (string, string) {
|
||||
return "Authorization", "Bearer apk-token"
|
||||
}
|
||||
|
||||
h := NewAPKHandler(proxy, "http://proxy.example", map[string]string{"alpine": upstream.URL})
|
||||
|
||||
for path, want := range files {
|
||||
w := serveAPKRequest(h, "/alpine"+path)
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("%s: status = %d, want 200: %s", path, w.Code, w.Body.String())
|
||||
}
|
||||
if got := w.Body.Bytes(); string(got) != string(want) {
|
||||
t.Errorf("%s: body altered:\ngot %q\nwant %q", path, got, want)
|
||||
}
|
||||
}
|
||||
if authHeader != "Bearer apk-token" {
|
||||
t.Errorf("Authorization = %q, want %q", authHeader, "Bearer apk-token")
|
||||
}
|
||||
|
||||
// Upstream goes away: cached indexes must still be served, unchanged.
|
||||
available.Store(false)
|
||||
requestsBefore := upstreamRequests.Load()
|
||||
for path, want := range files {
|
||||
w := serveAPKRequest(h, "/alpine"+path)
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("%s offline: status = %d, want 200: %s", path, w.Code, w.Body.String())
|
||||
}
|
||||
if got := w.Body.Bytes(); string(got) != string(want) {
|
||||
t.Errorf("%s offline: body altered:\ngot %q\nwant %q", path, got, want)
|
||||
}
|
||||
}
|
||||
if got := upstreamRequests.Load(); got != requestsBefore {
|
||||
t.Errorf("upstream requests during offline reads = %d, want %d", got, requestsBefore)
|
||||
}
|
||||
}
|
||||
|
||||
// TestAPKHandler_PackageDownloadCachesPerArch covers package downloads, cache
|
||||
// hits, offline reads, and that identically named packages for different
|
||||
// architectures are cached separately.
|
||||
func TestAPKHandler_PackageDownloadCachesPerArch(t *testing.T) {
|
||||
packages := map[string][]byte{
|
||||
"/v3.22/main/x86_64/busybox-1.37.0-r12.apk": []byte("x86_64 package bytes"),
|
||||
"/v3.22/main/aarch64/busybox-1.37.0-r12.apk": []byte("aarch64 package bytes"),
|
||||
}
|
||||
|
||||
var available atomic.Bool
|
||||
available.Store(true)
|
||||
var packageRequests atomic.Int32
|
||||
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if !available.Load() {
|
||||
http.Error(w, "unavailable", http.StatusServiceUnavailable)
|
||||
return
|
||||
}
|
||||
data, ok := packages[r.URL.Path]
|
||||
if !ok {
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
packageRequests.Add(1)
|
||||
w.Header().Set("Content-Type", "application/octet-stream")
|
||||
_, _ = w.Write(data)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
fetcher := fetch.NewFetcher(fetch.WithHTTPClient(upstream.Client()), fetch.WithMaxRetries(0))
|
||||
proxy.Fetcher = fetcher
|
||||
t.Cleanup(func() { _ = fetcher.Close() })
|
||||
|
||||
h := NewAPKHandler(proxy, "http://proxy.example", map[string]string{"alpine": upstream.URL})
|
||||
|
||||
for path, want := range packages {
|
||||
w := serveAPKRequest(h, "/alpine"+path)
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("%s: status = %d, want 200: %s", path, w.Code, w.Body.String())
|
||||
}
|
||||
if got := w.Body.String(); got != string(want) {
|
||||
t.Errorf("%s: body = %q, want %q", path, got, want)
|
||||
}
|
||||
}
|
||||
if got := packageRequests.Load(); got != 2 {
|
||||
t.Fatalf("upstream package requests = %d, want 2 (one per architecture)", got)
|
||||
}
|
||||
|
||||
// Second round must be served from cache, even with the upstream down.
|
||||
available.Store(false)
|
||||
for path, want := range packages {
|
||||
w := serveAPKRequest(h, "/alpine"+path)
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("%s cached: status = %d, want 200: %s", path, w.Code, w.Body.String())
|
||||
}
|
||||
if got := w.Body.String(); got != string(want) {
|
||||
t.Errorf("%s cached: body = %q, want %q", path, got, want)
|
||||
}
|
||||
}
|
||||
if got := packageRequests.Load(); got != 2 {
|
||||
t.Errorf("upstream package requests after cache hits = %d, want 2", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAPKHandler_PackageDownloadSendsUpstreamAuth(t *testing.T) {
|
||||
var authHeader string
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
authHeader = r.Header.Get("Authorization")
|
||||
if authHeader != "Bearer apk-token" {
|
||||
w.WriteHeader(http.StatusUnauthorized)
|
||||
return
|
||||
}
|
||||
_, _ = fmt.Fprint(w, "private package")
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
client := upstream.Client()
|
||||
client.Transport = &authRoundTripper{base: client.Transport, header: "Authorization", value: "Bearer apk-token"}
|
||||
fetcher := fetch.NewFetcher(fetch.WithHTTPClient(client), fetch.WithMaxRetries(0))
|
||||
proxy.Fetcher = fetcher
|
||||
t.Cleanup(func() { _ = fetcher.Close() })
|
||||
|
||||
h := NewAPKHandler(proxy, "http://proxy.example", map[string]string{"private": upstream.URL})
|
||||
|
||||
w := serveAPKRequest(h, "/private/v3.22/main/x86_64/busybox-1.37.0-r12.apk")
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, want 200: %s", w.Code, w.Body.String())
|
||||
}
|
||||
if w.Body.String() != "private package" {
|
||||
t.Errorf("body = %q, want %q", w.Body.String(), "private package")
|
||||
}
|
||||
if authHeader != "Bearer apk-token" {
|
||||
t.Errorf("Authorization = %q, want %q", authHeader, "Bearer apk-token")
|
||||
}
|
||||
}
|
||||
|
||||
func TestAPKHandler_UnparseablePackageProxiedDirectly(t *testing.T) {
|
||||
var requested string
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
requested = r.URL.Path
|
||||
_, _ = fmt.Fprint(w, "raw bytes")
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
|
||||
h := NewAPKHandler(proxy, "http://proxy.example", map[string]string{"alpine": upstream.URL})
|
||||
|
||||
w := serveAPKRequest(h, "/alpine/v3.22/main/x86_64/no-version.apk")
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, want 200: %s", w.Code, w.Body.String())
|
||||
}
|
||||
if requested != "/v3.22/main/x86_64/no-version.apk" {
|
||||
t.Errorf("upstream path = %q, want %q", requested, "/v3.22/main/x86_64/no-version.apk")
|
||||
}
|
||||
if w.Body.String() != "raw bytes" {
|
||||
t.Errorf("body = %q, want %q", w.Body.String(), "raw bytes")
|
||||
}
|
||||
}
|
||||
|
||||
// authRoundTripper adds a static auth header, mimicking the server's
|
||||
// authentication-aware upstream transport.
|
||||
type authRoundTripper struct {
|
||||
base http.RoundTripper
|
||||
header string
|
||||
value string
|
||||
}
|
||||
|
||||
func (a *authRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
|
||||
req = req.Clone(req.Context())
|
||||
req.Header.Set(a.header, a.value)
|
||||
base := a.base
|
||||
if base == nil {
|
||||
base = http.DefaultTransport
|
||||
}
|
||||
return base.RoundTrip(req)
|
||||
}
|
||||
|
||||
// TestAPKHandler_PackageHeadOmitsBody verifies that HEAD requests for cached
|
||||
// packages return headers (including Content-Length) without a body.
|
||||
func TestAPKHandler_PackageHeadOmitsBody(t *testing.T) {
|
||||
pkg := []byte("package bytes")
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "application/octet-stream")
|
||||
_, _ = w.Write(pkg)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
fetcher := fetch.NewFetcher(fetch.WithHTTPClient(upstream.Client()), fetch.WithMaxRetries(0))
|
||||
proxy.Fetcher = fetcher
|
||||
t.Cleanup(func() { _ = fetcher.Close() })
|
||||
|
||||
h := NewAPKHandler(proxy, "http://proxy.example", map[string]string{"alpine": upstream.URL})
|
||||
|
||||
target := "/alpine/v3.22/main/x86_64/busybox-1.37.0-r12.apk"
|
||||
if w := serveAPKRequest(h, target); w.Code != http.StatusOK {
|
||||
t.Fatalf("seeding GET: status = %d, want 200: %s", w.Code, w.Body.String())
|
||||
}
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
h.Routes().ServeHTTP(w, httptest.NewRequest(http.MethodHead, target, nil))
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("HEAD: status = %d, want 200: %s", w.Code, w.Body.String())
|
||||
}
|
||||
if got := w.Body.Len(); got != 0 {
|
||||
t.Errorf("HEAD body length = %d, want 0", got)
|
||||
}
|
||||
if got := w.Header().Get("Content-Length"); got != fmt.Sprint(len(pkg)) {
|
||||
t.Errorf("HEAD Content-Length = %q, want %d", got, len(pkg))
|
||||
}
|
||||
}
|
||||
|
||||
func serveAPKRequest(h *APKHandler, target string) *httptest.ResponseRecorder {
|
||||
w := httptest.NewRecorder()
|
||||
h.Routes().ServeHTTP(w, httptest.NewRequest(http.MethodGet, target, nil))
|
||||
return w
|
||||
}
|
||||
|
|
@ -6,9 +6,10 @@ import (
|
|||
"errors"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/purl"
|
||||
)
|
||||
|
||||
const (
|
||||
|
|
@ -29,18 +30,11 @@ type CargoHandler struct {
|
|||
}
|
||||
|
||||
// NewCargoHandler creates a new cargo protocol handler.
|
||||
func NewCargoHandler(proxy *Proxy, proxyURL, indexURL, downloadURL string) *CargoHandler {
|
||||
if strings.TrimSpace(indexURL) == "" {
|
||||
indexURL = cargoUpstream
|
||||
}
|
||||
if strings.TrimSpace(downloadURL) == "" {
|
||||
downloadURL = cargoDownloadBase
|
||||
}
|
||||
|
||||
func NewCargoHandler(proxy *Proxy, proxyURL string) *CargoHandler {
|
||||
return &CargoHandler{
|
||||
proxy: proxy,
|
||||
indexURL: strings.TrimSuffix(indexURL, "/"),
|
||||
downloadURL: strings.TrimSuffix(downloadURL, "/"),
|
||||
indexURL: cargoUpstream,
|
||||
downloadURL: cargoDownloadBase,
|
||||
proxyURL: strings.TrimSuffix(proxyURL, "/"),
|
||||
}
|
||||
}
|
||||
|
|
@ -80,7 +74,7 @@ func (h *CargoHandler) handleConfig(w http.ResponseWriter, r *http.Request) {
|
|||
DL: h.proxyURL + "/cargo/crates/{crate}/{version}/download",
|
||||
}
|
||||
|
||||
w.Header().Set(headerContentType, "application/json")
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_ = json.NewEncoder(w).Encode(config)
|
||||
}
|
||||
|
||||
|
|
@ -112,7 +106,7 @@ func (h *CargoHandler) handleIndex(w http.ResponseWriter, r *http.Request) {
|
|||
contentType = "text/plain; charset=utf-8"
|
||||
}
|
||||
|
||||
w.Header().Set(headerContentType, contentType)
|
||||
w.Header().Set("Content-Type", contentType)
|
||||
w.WriteHeader(http.StatusOK)
|
||||
h.applyCooldownFiltering(w, body)
|
||||
}
|
||||
|
|
@ -149,7 +143,7 @@ func (h *CargoHandler) applyCooldownFiltering(downstreamResponse http.ResponseWr
|
|||
continue
|
||||
}
|
||||
|
||||
cratePURL := canonicalPackagePURL("cargo", crate.Name)
|
||||
cratePURL := purl.MakePURLString("cargo", crate.Name, "")
|
||||
|
||||
if !h.proxy.Cooldown.IsAllowed("cargo", cratePURL, publishedAt) {
|
||||
h.proxy.Logger.Info("cooldown: filtering cargo version",
|
||||
|
|
@ -197,17 +191,10 @@ func (h *CargoHandler) handleDownload(w http.ResponseWriter, r *http.Request) {
|
|||
h.proxy.Logger.Info("cargo download request",
|
||||
"crate", name, "version", version, "filename", filename)
|
||||
|
||||
downloadURL := fmt.Sprintf(
|
||||
"%s/%s/%s",
|
||||
h.downloadURL,
|
||||
url.PathEscape(name),
|
||||
url.PathEscape(filename),
|
||||
)
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURL(
|
||||
r.Context(), "cargo", name, version, filename, downloadURL,
|
||||
)
|
||||
result, err := h.proxy.GetOrFetchArtifact(r.Context(), "cargo", name, version, filename)
|
||||
if err != nil {
|
||||
h.proxy.serveArtifactError(w, err, "failed to fetch crate")
|
||||
h.proxy.Logger.Error("failed to get artifact", "error", err)
|
||||
http.Error(w, "failed to fetch crate", http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,6 @@ package handler
|
|||
|
||||
import (
|
||||
"encoding/json"
|
||||
"io"
|
||||
"log/slog"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
|
|
@ -10,8 +9,7 @@ import (
|
|||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/cooldown"
|
||||
"github.com/git-pkgs/registries/fetch"
|
||||
"github.com/git-pkgs/proxy/internal/cooldown"
|
||||
)
|
||||
|
||||
func cargoTestProxy() *Proxy {
|
||||
|
|
@ -72,75 +70,6 @@ func TestCargoConfigEndpoint(t *testing.T) {
|
|||
}
|
||||
}
|
||||
|
||||
func TestCargoHandlerUsesConfiguredUpstreams(t *testing.T) {
|
||||
t.Run("index", func(t *testing.T) {
|
||||
var requestPath, authHeader string
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
requestPath = r.URL.Path
|
||||
authHeader = r.Header.Get("Authorization")
|
||||
if authHeader != "Bearer cargo-token" {
|
||||
w.WriteHeader(http.StatusUnauthorized)
|
||||
return
|
||||
}
|
||||
w.Header().Set("Content-Type", "text/plain")
|
||||
_, _ = io.WriteString(w, `{"name":"serde","vers":"1.0.0"}`)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
proxy.AuthForURL = func(string) (string, string) {
|
||||
return "Authorization", "Bearer cargo-token"
|
||||
}
|
||||
h := NewCargoHandler(
|
||||
proxy,
|
||||
"http://proxy.test",
|
||||
upstream.URL+"/index/",
|
||||
"https://crates.example.test/files/",
|
||||
)
|
||||
|
||||
req := httptest.NewRequest(http.MethodGet, "/se/rd/serde", nil)
|
||||
w := httptest.NewRecorder()
|
||||
h.Routes().ServeHTTP(w, req)
|
||||
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, want %d; body: %s", w.Code, http.StatusOK, w.Body.String())
|
||||
}
|
||||
if requestPath != "/index/se/rd/serde" {
|
||||
t.Errorf("upstream path = %q, want %q", requestPath, "/index/se/rd/serde")
|
||||
}
|
||||
if authHeader != "Bearer cargo-token" {
|
||||
t.Errorf("Authorization = %q, want %q", authHeader, "Bearer cargo-token")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("download", func(t *testing.T) {
|
||||
proxy, _, _, artifactFetcher := setupTestProxy(t)
|
||||
artifactFetcher.artifact = &fetch.Artifact{
|
||||
Body: io.NopCloser(strings.NewReader("crate")),
|
||||
ContentType: "application/gzip",
|
||||
}
|
||||
h := NewCargoHandler(
|
||||
proxy,
|
||||
"http://proxy.test",
|
||||
"https://index.example.test/root/",
|
||||
"https://crates.example.test/files/",
|
||||
)
|
||||
|
||||
req := httptest.NewRequest(http.MethodGet, "/crates/serde/1.0.0/download", nil)
|
||||
w := httptest.NewRecorder()
|
||||
h.Routes().ServeHTTP(w, req)
|
||||
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, want %d; body: %s", w.Code, http.StatusOK, w.Body.String())
|
||||
}
|
||||
want := "https://crates.example.test/files/serde/serde-1.0.0.crate"
|
||||
if artifactFetcher.fetchedURL != want {
|
||||
t.Errorf("fetched URL = %q, want %q", artifactFetcher.fetchedURL, want)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestCargoIndexProxy(t *testing.T) {
|
||||
// Create a mock upstream index server
|
||||
indexContent := `{"name":"serde","vers":"1.0.0","deps":[],"cksum":"abc123"}
|
||||
|
|
|
|||
|
|
@ -1,615 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"io"
|
||||
"strings"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/artifacts"
|
||||
"github.com/git-pkgs/registries/fetch"
|
||||
)
|
||||
|
||||
// runConcurrent runs fn in n goroutines released together and returns their errors.
|
||||
func runConcurrent(n int, fn func(i int) error) []error {
|
||||
errs := make([]error, n)
|
||||
start := make(chan struct{})
|
||||
var wg sync.WaitGroup
|
||||
for i := 0; i < n; i++ {
|
||||
wg.Add(1)
|
||||
go func(i int) {
|
||||
defer wg.Done()
|
||||
<-start
|
||||
errs[i] = fn(i)
|
||||
}(i)
|
||||
}
|
||||
close(start)
|
||||
wg.Wait()
|
||||
return errs
|
||||
}
|
||||
|
||||
// artifactBody builds a one-shot upstream artifact carrying the given bytes.
|
||||
func artifactBody(content string) *fetch.Artifact {
|
||||
return &fetch.Artifact{
|
||||
Body: io.NopCloser(strings.NewReader(content)),
|
||||
ContentType: "application/gzip",
|
||||
}
|
||||
}
|
||||
|
||||
// drain consumes and closes a CacheResult reader, if there is one.
|
||||
func drain(res *CacheResult) {
|
||||
if res != nil && res.Reader != nil {
|
||||
_, _ = io.Copy(io.Discard, res.Reader)
|
||||
_ = res.Reader.Close()
|
||||
}
|
||||
}
|
||||
|
||||
// TestCoalesceKey_DifferentUpstreamHashDoesNotShare is the safety property that
|
||||
// makes coalescing sound: callers expecting different bytes must never share a
|
||||
// fetch, so a re-published version cannot serve stale bytes to a caller that
|
||||
// asked for the new digest.
|
||||
func TestCoalesceKey_DifferentUpstreamHashDoesNotShare(t *testing.T) {
|
||||
const content = "artifact bytes"
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
fetcher := &countingFetcher{content: content, delay: fetchHoldTime}
|
||||
proxy.Fetcher = fetcher
|
||||
|
||||
// The digest must carry the "sha256:" prefix; without it the API treats the
|
||||
// value as unverifiable and clears the hash, which would legitimately let
|
||||
// the two callers share one fetch.
|
||||
hashes := []string{
|
||||
"sha256:" + sha256Hex(content),
|
||||
"sha256:" + sha256Hex("something else entirely"),
|
||||
}
|
||||
|
||||
_ = runConcurrent(2, func(i int) error {
|
||||
res, err := proxy.GetOrFetchArtifactFromURLWithDigest(context.Background(),
|
||||
"npm", "pkg", "1.0.0", "pkg-1.0.0.tgz",
|
||||
"https://registry.npmjs.org/pkg/-/pkg-1.0.0.tgz", hashes[i])
|
||||
drain(res)
|
||||
return err
|
||||
})
|
||||
|
||||
if got := fetcher.calls.Load(); got != 2 {
|
||||
t.Errorf("upstream fetches = %d, want 2: callers expecting different digests must not share a fetch", got)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCoalesceKey_HashCasingSharesOneFetch is the other half of that property.
|
||||
// artifactHashMatches compares digests case-insensitively, so one digest in two
|
||||
// casings describes one artifact and must not split into two fetches.
|
||||
func TestCoalesceKey_HashCasingSharesOneFetch(t *testing.T) {
|
||||
const content = "artifact bytes"
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
fetcher := &countingFetcher{content: content, delay: fetchHoldTime}
|
||||
proxy.Fetcher = fetcher
|
||||
|
||||
hex := sha256Hex(content)
|
||||
digests := []string{"sha256:" + hex, "sha256:" + strings.ToUpper(hex)}
|
||||
|
||||
for i, err := range runConcurrent(2, func(i int) error {
|
||||
res, err := proxy.GetOrFetchArtifactFromURLWithDigest(context.Background(),
|
||||
"npm", "pkg", "1.0.0", "pkg-1.0.0.tgz",
|
||||
"https://registry.npmjs.org/pkg/-/pkg-1.0.0.tgz", digests[i])
|
||||
drain(res)
|
||||
return err
|
||||
}) {
|
||||
if err != nil {
|
||||
t.Fatalf("caller %d failed: %v", i, err)
|
||||
}
|
||||
}
|
||||
|
||||
if got := fetcher.calls.Load(); got != 1 {
|
||||
t.Errorf("upstream fetches = %d, want 1: one digest in two casings is one artifact", got)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCoalesceKey_DifferentDownloadURLDoesNotShare covers the other half of the
|
||||
// key: same package, different upstream URL, must not collapse into one fetch.
|
||||
func TestCoalesceKey_DifferentDownloadURLDoesNotShare(t *testing.T) {
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
fetcher := &countingFetcher{content: "artifact bytes", delay: fetchHoldTime}
|
||||
proxy.Fetcher = fetcher
|
||||
|
||||
urls := []string{
|
||||
"https://registry.npmjs.org/pkg/-/pkg-1.0.0.tgz",
|
||||
"https://mirror.example.com/pkg/-/pkg-1.0.0.tgz",
|
||||
}
|
||||
|
||||
_ = runConcurrent(2, func(i int) error {
|
||||
res, err := proxy.GetOrFetchArtifactFromURL(context.Background(),
|
||||
"npm", "pkg", "1.0.0", "pkg-1.0.0.tgz", urls[i])
|
||||
drain(res)
|
||||
return err
|
||||
})
|
||||
|
||||
if got := fetcher.calls.Load(); got != 2 {
|
||||
t.Errorf("upstream fetches = %d, want 2: different upstream URLs must not share a fetch", got)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCoalesceKey_DistinctArtifactsDoNotSerialize guards against an over-broad
|
||||
// key: four packages fetched at once must still produce four fetches.
|
||||
func TestCoalesceKey_DistinctArtifactsDoNotSerialize(t *testing.T) {
|
||||
const n = 4
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
fetcher := &countingFetcher{content: "artifact bytes", delay: fetchHoldTime}
|
||||
proxy.Fetcher = fetcher
|
||||
|
||||
names := []string{"alpha", "beta", "gamma", "delta"}
|
||||
errs := runConcurrent(n, func(i int) error {
|
||||
res, err := proxy.GetOrFetchArtifactFromURL(context.Background(),
|
||||
"npm", names[i], "1.0.0", names[i]+"-1.0.0.tgz",
|
||||
"https://registry.npmjs.org/"+names[i]+"/-/"+names[i]+"-1.0.0.tgz")
|
||||
drain(res)
|
||||
return err
|
||||
})
|
||||
for i, err := range errs {
|
||||
if err != nil {
|
||||
t.Errorf("caller %d (%s): %v", i, names[i], err)
|
||||
}
|
||||
}
|
||||
if got := fetcher.calls.Load(); got != n {
|
||||
t.Errorf("upstream fetches = %d, want %d: distinct artifacts must not share a fetch", got, n)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCoalesce_FailedFetchReachesEveryCallerAndIsRetriable verifies both claims
|
||||
// in coalesceFetch's doc comment: a failed fetch reaches every caller sharing
|
||||
// it, and the key is released so a later request retries.
|
||||
func TestCoalesce_FailedFetchReachesEveryCallerAndIsRetriable(t *testing.T) {
|
||||
const callers = 8
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
boom := errors.New("upstream unavailable")
|
||||
fetcher.fetchErr = boom
|
||||
|
||||
errs := runConcurrent(callers, func(int) error {
|
||||
res, err := proxy.GetOrFetchArtifactFromURL(context.Background(),
|
||||
"npm", "pkg", "1.0.0", "pkg-1.0.0.tgz",
|
||||
"https://registry.npmjs.org/pkg/-/pkg-1.0.0.tgz")
|
||||
drain(res)
|
||||
return err
|
||||
})
|
||||
for i, err := range errs {
|
||||
if err == nil {
|
||||
t.Errorf("caller %d: got nil error, want the shared fetch's failure", i)
|
||||
} else if !errors.Is(err, boom) {
|
||||
t.Errorf("caller %d: got %v, want it to wrap %v", i, err, boom)
|
||||
}
|
||||
}
|
||||
|
||||
// The key must be released: a later request retries rather than inheriting
|
||||
// the failure.
|
||||
fetcher.fetchErr = nil
|
||||
fetcher.artifact = artifactBody("recovered bytes")
|
||||
res, err := proxy.GetOrFetchArtifactFromURL(context.Background(),
|
||||
"npm", "pkg", "1.0.0", "pkg-1.0.0.tgz",
|
||||
"https://registry.npmjs.org/pkg/-/pkg-1.0.0.tgz")
|
||||
if err != nil {
|
||||
t.Fatalf("retry after failed coalesced fetch: %v", err)
|
||||
}
|
||||
body, _ := io.ReadAll(res.Reader)
|
||||
_ = res.Reader.Close()
|
||||
if string(body) != "recovered bytes" {
|
||||
t.Errorf("retry body = %q, want %q", body, "recovered bytes")
|
||||
}
|
||||
}
|
||||
|
||||
// TestCoalesce_ResolverPath covers the other entry point: GetOrFetchArtifact
|
||||
// resolves the URL itself, so it is keyed without one.
|
||||
func TestCoalesce_ResolverPath(t *testing.T) {
|
||||
const callers = 8
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
fetcher := &countingFetcher{content: "resolved artifact bytes", delay: fetchHoldTime}
|
||||
proxy.Fetcher = fetcher
|
||||
|
||||
errs := runConcurrent(callers, func(int) error {
|
||||
res, err := proxy.GetOrFetchArtifact(context.Background(),
|
||||
"npm", "left-pad", "1.3.0", "left-pad-1.3.0.tgz")
|
||||
drain(res)
|
||||
return err
|
||||
})
|
||||
for i, err := range errs {
|
||||
if err != nil {
|
||||
t.Errorf("caller %d: %v", i, err)
|
||||
}
|
||||
}
|
||||
if got := fetcher.calls.Load(); got != 1 {
|
||||
t.Errorf("upstream fetches = %d, want 1", got)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCoalesce_ResolverPathEmptyFilename exercises that path when the filename
|
||||
// is left to be resolved, which the key cannot know up front.
|
||||
func TestCoalesce_ResolverPathEmptyFilename(t *testing.T) {
|
||||
const callers = 8
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
fetcher := &countingFetcher{content: "resolved artifact bytes", delay: fetchHoldTime}
|
||||
proxy.Fetcher = fetcher
|
||||
|
||||
errs := runConcurrent(callers, func(int) error {
|
||||
res, err := proxy.GetOrFetchArtifact(context.Background(), "npm", "left-pad", "1.3.0", "")
|
||||
drain(res)
|
||||
return err
|
||||
})
|
||||
for i, err := range errs {
|
||||
if err != nil {
|
||||
t.Errorf("caller %d: %v", i, err)
|
||||
}
|
||||
}
|
||||
if got := fetcher.calls.Load(); got != 1 {
|
||||
t.Errorf("upstream fetches = %d, want 1", got)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCoalesce_SubsequentRequestIsACacheHit confirms the coalesced fetch was
|
||||
// committed and is visible later, not just streamed to the waiting callers.
|
||||
func TestCoalesce_SubsequentRequestIsACacheHit(t *testing.T) {
|
||||
const callers = 8
|
||||
const url = "https://registry.npmjs.org/pkg/-/pkg-1.0.0.tgz"
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
fetcher := &countingFetcher{content: "artifact bytes", delay: fetchHoldTime}
|
||||
proxy.Fetcher = fetcher
|
||||
|
||||
_ = runConcurrent(callers, func(int) error {
|
||||
res, err := proxy.GetOrFetchArtifactFromURL(context.Background(),
|
||||
"npm", "pkg", "1.0.0", "pkg-1.0.0.tgz", url)
|
||||
drain(res)
|
||||
return err
|
||||
})
|
||||
|
||||
res, err := proxy.GetOrFetchArtifactFromURL(context.Background(),
|
||||
"npm", "pkg", "1.0.0", "pkg-1.0.0.tgz", url)
|
||||
if err != nil {
|
||||
t.Fatalf("follow-up request: %v", err)
|
||||
}
|
||||
defer func() { _ = res.Reader.Close() }()
|
||||
if !res.Cached {
|
||||
t.Error("follow-up request should be served from cache")
|
||||
}
|
||||
if got := fetcher.calls.Load(); got != 1 {
|
||||
t.Errorf("upstream fetches = %d, want 1 after a follow-up cache hit", got)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCoalesce_ReadersAreIndependent guards openStoredArtifact: callers sharing
|
||||
// a fetch each need their own reader, or one closing early breaks the rest.
|
||||
func TestCoalesce_ReadersAreIndependent(t *testing.T) {
|
||||
const callers = 8
|
||||
const content = "artifact bytes that every caller must receive intact"
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
fetcher := &countingFetcher{content: content, delay: fetchHoldTime}
|
||||
proxy.Fetcher = fetcher
|
||||
|
||||
results := make([]*CacheResult, callers)
|
||||
errs := runConcurrent(callers, func(i int) error {
|
||||
res, err := proxy.GetOrFetchArtifactFromURL(context.Background(),
|
||||
"npm", "pkg", "1.0.0", "pkg-1.0.0.tgz",
|
||||
"https://registry.npmjs.org/pkg/-/pkg-1.0.0.tgz")
|
||||
results[i] = res
|
||||
return err
|
||||
})
|
||||
for i, err := range errs {
|
||||
if err != nil {
|
||||
t.Fatalf("caller %d: %v", i, err)
|
||||
}
|
||||
}
|
||||
|
||||
// Close the first caller's reader before anyone else has read a byte.
|
||||
_ = results[0].Reader.Close()
|
||||
|
||||
for i := 1; i < callers; i++ {
|
||||
body, err := io.ReadAll(results[i].Reader)
|
||||
_ = results[i].Reader.Close()
|
||||
if err != nil {
|
||||
t.Errorf("caller %d read after another caller closed: %v", i, err)
|
||||
continue
|
||||
}
|
||||
if string(body) != content {
|
||||
t.Errorf("caller %d got %q, want %q", i, body, content)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestCoalesce_CanceledWaiterDoesNotWaitForTheSharedFetch checks that joining a
|
||||
// coalesced fetch does not cost a caller its own cancellation. Without the
|
||||
// leader/waiter split a waiter is pinned until the shared fetch resolves,
|
||||
// bounded only by the artifact client timeout, so clients that have already
|
||||
// gone away keep handler goroutines alive for minutes.
|
||||
func TestCoalesce_CanceledWaiterDoesNotWaitForTheSharedFetch(t *testing.T) {
|
||||
const leaderFetch = 2 * time.Second
|
||||
const url = "https://registry.npmjs.org/pkg/-/pkg-1.0.0.tgz"
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
fetcher := &countingFetcher{content: "artifact bytes", delay: leaderFetch, entered: make(chan struct{})}
|
||||
proxy.Fetcher = fetcher
|
||||
|
||||
leaderDone := make(chan error, 1)
|
||||
go func() {
|
||||
res, err := proxy.GetOrFetchArtifactFromURL(context.Background(),
|
||||
"npm", "pkg", "1.0.0", "pkg-1.0.0.tgz", url)
|
||||
drain(res)
|
||||
leaderDone <- err
|
||||
}()
|
||||
|
||||
select {
|
||||
case <-fetcher.entered: // the leader holds the key and is inside its fetch
|
||||
case <-time.After(5 * time.Second):
|
||||
t.Fatal("leader never started its fetch")
|
||||
}
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
cancel()
|
||||
|
||||
start := time.Now()
|
||||
_, err := proxy.GetOrFetchArtifactFromURL(ctx, "npm", "pkg", "1.0.0", "pkg-1.0.0.tgz", url)
|
||||
blocked := time.Since(start)
|
||||
|
||||
if !errors.Is(err, context.Canceled) {
|
||||
t.Errorf("waiter error = %v, want context.Canceled", err)
|
||||
}
|
||||
if blocked > leaderFetch/4 {
|
||||
t.Errorf("canceled waiter blocked %v, want well under %v: it is pinned to the shared fetch",
|
||||
blocked, leaderFetch/4)
|
||||
}
|
||||
|
||||
// A waiter leaving must not disturb the fetch the others share.
|
||||
if err := <-leaderDone; err != nil {
|
||||
t.Fatalf("leader failed after a waiter canceled: %v", err)
|
||||
}
|
||||
res, err := proxy.GetOrFetchArtifactFromURL(context.Background(),
|
||||
"npm", "pkg", "1.0.0", "pkg-1.0.0.tgz", url)
|
||||
if err != nil {
|
||||
t.Fatalf("follow-up after leader completed: %v", err)
|
||||
}
|
||||
defer func() { _ = res.Reader.Close() }()
|
||||
if !res.Cached {
|
||||
t.Error("leader's fetch should have been committed to the cache")
|
||||
}
|
||||
if got := fetcher.calls.Load(); got != 1 {
|
||||
t.Errorf("upstream fetches = %d, want 1", got)
|
||||
}
|
||||
}
|
||||
|
||||
// inFlightLen reports how many coalesced fetches are currently registered.
|
||||
func inFlightLen(p *Proxy) int {
|
||||
p.fetchMu.Lock()
|
||||
defer p.fetchMu.Unlock()
|
||||
return len(p.inFlight)
|
||||
}
|
||||
|
||||
// TestCoalesce_KeyIsReleasedAfterFetch guards the bug this hand-rolled map can
|
||||
// have that singleflight could not: a key left behind means later callers join
|
||||
// a finished entry, see its closed done channel, and are served that stale
|
||||
// result forever, while the map grows without bound.
|
||||
func TestCoalesce_KeyIsReleasedAfterFetch(t *testing.T) {
|
||||
const url = "https://registry.npmjs.org/pkg/-/pkg-1.0.0.tgz"
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
fetcher := &countingFetcher{content: "artifact bytes", delay: fetchHoldTime}
|
||||
proxy.Fetcher = fetcher
|
||||
|
||||
_ = runConcurrent(8, func(int) error {
|
||||
res, err := proxy.GetOrFetchArtifactFromURL(context.Background(),
|
||||
"npm", "pkg", "1.0.0", "pkg-1.0.0.tgz", url)
|
||||
drain(res)
|
||||
return err
|
||||
})
|
||||
if n := inFlightLen(proxy); n != 0 {
|
||||
t.Errorf("in-flight entries after a successful fetch = %d, want 0", n)
|
||||
}
|
||||
|
||||
// A fresh miss for the same key must start a new fetch, not rejoin the old
|
||||
// entry. Clearing the cache record forces the miss path again.
|
||||
if err := proxy.ClearCachedArtifact(context.Background(), "npm", "pkg", "1.0.0", "pkg-1.0.0.tgz"); err != nil {
|
||||
t.Fatalf("clear cached artifact: %v", err)
|
||||
}
|
||||
res, err := proxy.GetOrFetchArtifactFromURL(context.Background(),
|
||||
"npm", "pkg", "1.0.0", "pkg-1.0.0.tgz", url)
|
||||
if err != nil {
|
||||
t.Fatalf("second miss for the same key: %v", err)
|
||||
}
|
||||
drain(res)
|
||||
if got := fetcher.calls.Load(); got != 2 {
|
||||
t.Errorf("upstream fetches = %d, want 2: the second miss must not reuse the finished entry", got)
|
||||
}
|
||||
if n := inFlightLen(proxy); n != 0 {
|
||||
t.Errorf("in-flight entries at end = %d, want 0", n)
|
||||
}
|
||||
}
|
||||
|
||||
// missingFromCache is a recheck that always reports a miss, so the shared fetch
|
||||
// runs.
|
||||
func missingFromCache() (artifacts.Artifact, string, bool) {
|
||||
return artifacts.Artifact{}, "", false
|
||||
}
|
||||
|
||||
// TestCoalesce_LeaderRechecksCacheBeforeFetching covers the window between a
|
||||
// caller's own cache lookup and it becoming the leader: a concurrent fetch can
|
||||
// commit the artifact in that gap, and the leader must serve that rather than
|
||||
// fetch it a second time.
|
||||
func TestCoalesce_LeaderRechecksCacheBeforeFetching(t *testing.T) {
|
||||
const content = "artifact bytes"
|
||||
proxy, _, store, _ := setupTestProxy(t)
|
||||
|
||||
const storagePath = "npm/pkg/1.0.0/pkg-1.0.0.tgz"
|
||||
if _, _, err := store.Store(context.Background(), storagePath, strings.NewReader(content)); err != nil {
|
||||
t.Fatalf("seeding storage: %v", err)
|
||||
}
|
||||
committed := artifacts.Artifact{
|
||||
PURL: "pkg:npm/pkg@1.0.0",
|
||||
Filename: "pkg-1.0.0.tgz",
|
||||
Size: int64(len(content)),
|
||||
}
|
||||
|
||||
res, err := proxy.coalesceFetch(context.Background(), "any-key",
|
||||
func() (artifacts.Artifact, string, bool) { return committed, storagePath, true },
|
||||
func(context.Context) (artifacts.Artifact, string, error) {
|
||||
t.Error("fetched an artifact that was already in the cache")
|
||||
return artifacts.Artifact{}, "", errors.New("commit must not run")
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("coalesceFetch failed: %v", err)
|
||||
}
|
||||
defer drain(res)
|
||||
got, err := io.ReadAll(res.Reader)
|
||||
if err != nil {
|
||||
t.Fatalf("reading result: %v", err)
|
||||
}
|
||||
if string(got) != content {
|
||||
t.Errorf("got %q, want %q", got, content)
|
||||
}
|
||||
if n := inFlightLen(proxy); n != 0 {
|
||||
t.Errorf("in-flight entries = %d, want 0", n)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCachedArtifactRecord covers the recheck itself: it must report the row a
|
||||
// concurrent fetch committed, match its digest the way artifactHashMatches
|
||||
// does, and report a miss for anything else.
|
||||
func TestCachedArtifactRecord(t *testing.T) {
|
||||
const (
|
||||
content = "artifact bytes"
|
||||
pkgPURL = "pkg:npm/pkg"
|
||||
versionPURL = "pkg:npm/pkg@1.0.0"
|
||||
filename = "pkg-1.0.0.tgz"
|
||||
storagePath = "npm/pkg/1.0.0/pkg-1.0.0.tgz"
|
||||
)
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
|
||||
hex := sha256Hex(content)
|
||||
committed := testArtifact(content, versionPURL, filename, "application/gzip")
|
||||
if err := proxy.updateCacheDB("npm", "pkg", pkgPURL,
|
||||
"https://registry.npmjs.org/pkg/-/pkg-1.0.0.tgz", storagePath, committed); err != nil {
|
||||
t.Fatalf("seeding cache record: %v", err)
|
||||
}
|
||||
|
||||
for _, tc := range []struct {
|
||||
name, filename, hash string
|
||||
want bool
|
||||
}{
|
||||
{"no upstream hash", filename, "", true},
|
||||
{"matching hash", filename, hex, true},
|
||||
{"matching hash in upper case", filename, strings.ToUpper(hex), true},
|
||||
{"different hash", filename, sha256Hex("something else entirely"), false},
|
||||
{"unknown filename", "pkg-1.0.0.zip", hex, false},
|
||||
} {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
got, path, ok := proxy.cachedArtifactRecord(pkgPURL, versionPURL, tc.filename, tc.hash)
|
||||
if ok != tc.want {
|
||||
t.Fatalf("ok = %v, want %v", ok, tc.want)
|
||||
}
|
||||
if !ok {
|
||||
return
|
||||
}
|
||||
if path != storagePath {
|
||||
t.Errorf("storage path = %q, want %q", path, storagePath)
|
||||
}
|
||||
if got.Digest.Encoded() != hex {
|
||||
t.Errorf("digest = %q, want %q", got.Digest.Encoded(), hex)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestCoalesce_LeaderFetchesWhenRecheckedBytesAreGone covers the other branch
|
||||
// of the recheck: a record whose bytes no longer open is not served, and the
|
||||
// shared fetch runs instead, the same recovery the cache lookup makes.
|
||||
func TestCoalesce_LeaderFetchesWhenRecheckedBytesAreGone(t *testing.T) {
|
||||
const content = "fetched bytes"
|
||||
const storagePath = "npm/pkg/1.0.0/pkg-1.0.0.tgz"
|
||||
proxy, _, store, _ := setupTestProxy(t)
|
||||
|
||||
stale := artifacts.Artifact{PURL: "pkg:npm/pkg@1.0.0", Filename: "pkg-1.0.0.tgz"}
|
||||
if _, err := store.Open(context.Background(), storagePath); err == nil {
|
||||
t.Fatal("stale bytes were present, so the test proves nothing")
|
||||
}
|
||||
|
||||
// The leader runs commit on its own goroutine, so a plain counter is safe.
|
||||
fetches := 0
|
||||
res, err := proxy.coalesceFetch(context.Background(), "any-key",
|
||||
func() (artifacts.Artifact, string, bool) { return stale, storagePath, true },
|
||||
func(ctx context.Context) (artifacts.Artifact, string, error) {
|
||||
fetches++
|
||||
if _, _, err := store.Store(ctx, storagePath, strings.NewReader(content)); err != nil {
|
||||
return artifacts.Artifact{}, "", err
|
||||
}
|
||||
return testArtifact(content, stale.PURL, stale.Filename, "application/gzip"), storagePath, nil
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("coalesceFetch failed: %v", err)
|
||||
}
|
||||
defer drain(res)
|
||||
if fetches != 1 {
|
||||
t.Errorf("shared fetches = %d, want 1: a record without bytes must be refetched", fetches)
|
||||
}
|
||||
got, err := io.ReadAll(res.Reader)
|
||||
if err != nil {
|
||||
t.Fatalf("reading result: %v", err)
|
||||
}
|
||||
if string(got) != content {
|
||||
t.Errorf("got %q, want %q", got, content)
|
||||
}
|
||||
if n := inFlightLen(proxy); n != 0 {
|
||||
t.Errorf("in-flight entries = %d, want 0", n)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCoalesce_PanicInSharedFetchDoesNotStrandWaiters checks the failure mode
|
||||
// that matters most: a caller parked on a shared fetch must never be left
|
||||
// blocked forever when that fetch dies.
|
||||
//
|
||||
// This drives coalesceFetch directly and holds the shared entry itself, because
|
||||
// whether a second caller has reached the wait is not observable from outside:
|
||||
// it runs a cache lookup against the database first, so releasing the leader on
|
||||
// a timer races that query. Losing the race made a second caller the leader
|
||||
// instead of a waiter, and its panic was unrecovered, killing the test binary
|
||||
// rather than failing the test.
|
||||
func TestCoalesce_PanicInSharedFetchDoesNotStrandWaiters(t *testing.T) {
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
const key = "pkg:npm/pkg@1.0.0\x00pkg-1.0.0.tgz"
|
||||
|
||||
inCommit := make(chan struct{})
|
||||
release := make(chan struct{})
|
||||
leaderPanicked := make(chan struct{})
|
||||
|
||||
go func() {
|
||||
defer func() {
|
||||
_ = recover() // the panic surfaces in the leader, as it would in a handler
|
||||
close(leaderPanicked)
|
||||
}()
|
||||
_, _ = proxy.coalesceFetch(context.Background(), key, missingFromCache,
|
||||
func(context.Context) (artifacts.Artifact, string, error) {
|
||||
close(inCommit)
|
||||
<-release
|
||||
panic("upstream fetch exploded")
|
||||
})
|
||||
}()
|
||||
|
||||
<-inCommit // the leader holds the key and is inside the fetch
|
||||
|
||||
// Take the entry a waiter would park on, while the leader is still held.
|
||||
proxy.fetchMu.Lock()
|
||||
shared := proxy.inFlight[key]
|
||||
proxy.fetchMu.Unlock()
|
||||
if shared == nil {
|
||||
t.Fatal("no in-flight entry registered for a running fetch")
|
||||
}
|
||||
|
||||
close(release)
|
||||
|
||||
select {
|
||||
case <-shared.done:
|
||||
case <-time.After(5 * time.Second):
|
||||
t.Fatal("waiter stranded: a panicking shared fetch never released its waiters")
|
||||
}
|
||||
if !errors.Is(shared.err, errSharedFetchAbandoned) {
|
||||
t.Errorf("waiter error = %v, want errSharedFetchAbandoned", shared.err)
|
||||
}
|
||||
|
||||
<-leaderPanicked
|
||||
if n := inFlightLen(proxy); n != 0 {
|
||||
t.Errorf("in-flight entries after a panic = %d, want 0", n)
|
||||
}
|
||||
}
|
||||
|
|
@ -1,185 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"io"
|
||||
"log/slog"
|
||||
"net/http"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"sync"
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/proxy/internal/database"
|
||||
"github.com/git-pkgs/proxy/internal/storage"
|
||||
"github.com/git-pkgs/registries/fetch"
|
||||
)
|
||||
|
||||
// fetchHoldTime holds each stub fetch open long enough that concurrent callers
|
||||
// reliably overlap inside it. The exact value is not significant.
|
||||
const fetchHoldTime = 50 * time.Millisecond
|
||||
|
||||
// countingFetcher counts upstream fetches and holds each one open.
|
||||
type countingFetcher struct {
|
||||
calls atomic.Int64
|
||||
content string
|
||||
delay time.Duration
|
||||
|
||||
// entered, if set, is closed when the first fetch begins. A test can wait
|
||||
// on it to know the leader holds the key, rather than guessing with a
|
||||
// sleep.
|
||||
entered chan struct{}
|
||||
enterOnce sync.Once
|
||||
}
|
||||
|
||||
func (f *countingFetcher) Fetch(ctx context.Context, url string) (*fetch.Artifact, error) {
|
||||
return f.FetchWithHeaders(ctx, url, nil)
|
||||
}
|
||||
|
||||
func (f *countingFetcher) FetchWithHeaders(_ context.Context, _ string, _ http.Header) (*fetch.Artifact, error) {
|
||||
f.calls.Add(1)
|
||||
if f.entered != nil {
|
||||
f.enterOnce.Do(func() { close(f.entered) })
|
||||
}
|
||||
time.Sleep(f.delay)
|
||||
return &fetch.Artifact{
|
||||
Body: io.NopCloser(strings.NewReader(f.content)),
|
||||
ContentType: "application/gzip",
|
||||
}, nil
|
||||
}
|
||||
|
||||
func (f *countingFetcher) Head(context.Context, string) (int64, string, error) {
|
||||
return 0, "", nil
|
||||
}
|
||||
|
||||
// TestGetOrFetchArtifactFromURL_ConcurrentMissesCoalesce asserts that N
|
||||
// simultaneous misses for one artifact produce a single upstream fetch. That is
|
||||
// the CI shape: parallel jobs installing overlapping dependencies cold.
|
||||
func TestGetOrFetchArtifactFromURL_ConcurrentMissesCoalesce(t *testing.T) {
|
||||
const goroutines = 8
|
||||
const content = "left-pad tarball bytes"
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
fetcher := &countingFetcher{content: content, delay: fetchHoldTime}
|
||||
proxy.Fetcher = fetcher
|
||||
|
||||
start := make(chan struct{})
|
||||
var wg sync.WaitGroup
|
||||
errs := make([]error, goroutines)
|
||||
bodies := make([]string, goroutines)
|
||||
|
||||
for i := 0; i < goroutines; i++ {
|
||||
wg.Add(1)
|
||||
go func(i int) {
|
||||
defer wg.Done()
|
||||
<-start
|
||||
res, err := proxy.GetOrFetchArtifactFromURL(context.Background(),
|
||||
"npm", "left-pad", "1.3.0", "left-pad-1.3.0.tgz",
|
||||
"https://registry.npmjs.org/left-pad/-/left-pad-1.3.0.tgz")
|
||||
if err != nil {
|
||||
errs[i] = err
|
||||
return
|
||||
}
|
||||
defer func() { _ = res.Reader.Close() }()
|
||||
b, err := io.ReadAll(res.Reader)
|
||||
errs[i] = err
|
||||
bodies[i] = string(b)
|
||||
}(i)
|
||||
}
|
||||
|
||||
close(start)
|
||||
wg.Wait()
|
||||
|
||||
for i, err := range errs {
|
||||
if err != nil {
|
||||
t.Errorf("goroutine %d: unexpected error: %v", i, err)
|
||||
}
|
||||
}
|
||||
// Every caller must get its own intact copy of the bytes.
|
||||
for i, b := range bodies {
|
||||
if b != content {
|
||||
t.Errorf("goroutine %d: body = %q, want %q", i, b, content)
|
||||
}
|
||||
}
|
||||
if got := fetcher.calls.Load(); got != 1 {
|
||||
t.Errorf("upstream fetches = %d, want 1 (%d concurrent callers stampeded the upstream)", got, goroutines)
|
||||
}
|
||||
}
|
||||
|
||||
// TestGetOrFetchArtifactFromURL_ConcurrentMissesFileStorage runs the same
|
||||
// scenario against the real file:// backend, the default in production.
|
||||
//
|
||||
// Uncoalesced this fails outright, not merely wastefully. Every caller stores
|
||||
// to one key, and fileblob rewrites a ".attrs" sidecar per key with os.Create,
|
||||
// truncating in place outside the rename that protects the blob. Decoding that
|
||||
// sidecar mid-truncate gives "opening reader: EOF", served as a 502.
|
||||
//
|
||||
// Only the fetcher is stubbed, because the real one refuses loopback so an
|
||||
// httptest upstream is unreachable. The storage, where this fails, is real.
|
||||
func TestGetOrFetchArtifactFromURL_ConcurrentMissesFileStorage(t *testing.T) {
|
||||
const goroutines = 16
|
||||
content := bytes.Repeat([]byte("tarball-bytes-"), 512)
|
||||
|
||||
ctx := context.Background()
|
||||
dir := t.TempDir()
|
||||
|
||||
db, err := database.Create(filepath.Join(dir, "test.db"))
|
||||
if err != nil {
|
||||
t.Fatalf("create database: %v", err)
|
||||
}
|
||||
t.Cleanup(func() { _ = db.Close() })
|
||||
|
||||
store, err := storage.OpenBucket(ctx, "file://"+filepath.Join(dir, "cache"))
|
||||
if err != nil {
|
||||
t.Fatalf("open storage: %v", err)
|
||||
}
|
||||
t.Cleanup(func() { _ = store.Close() })
|
||||
|
||||
fetcher := &countingFetcher{content: string(content), delay: fetchHoldTime}
|
||||
proxy := NewProxy(db, store, fetcher, fetch.NewResolver(),
|
||||
slog.New(slog.NewTextHandler(io.Discard, nil)))
|
||||
|
||||
start := make(chan struct{})
|
||||
var wg sync.WaitGroup
|
||||
errs := make([]error, goroutines)
|
||||
bodies := make([][]byte, goroutines)
|
||||
|
||||
for i := 0; i < goroutines; i++ {
|
||||
wg.Add(1)
|
||||
go func(i int) {
|
||||
defer wg.Done()
|
||||
<-start
|
||||
res, err := proxy.GetOrFetchArtifactFromURL(ctx,
|
||||
"npm", "left-pad", "1.3.0", "left-pad-1.3.0.tgz",
|
||||
"https://registry.npmjs.org/left-pad/-/left-pad-1.3.0.tgz")
|
||||
if err != nil {
|
||||
errs[i] = err
|
||||
return
|
||||
}
|
||||
defer func() { _ = res.Reader.Close() }()
|
||||
body, readErr := io.ReadAll(res.Reader)
|
||||
errs[i] = readErr
|
||||
bodies[i] = body
|
||||
}(i)
|
||||
}
|
||||
|
||||
close(start)
|
||||
wg.Wait()
|
||||
|
||||
for i, err := range errs {
|
||||
if err != nil {
|
||||
t.Errorf("caller %d failed: %v", i, err)
|
||||
}
|
||||
}
|
||||
for i, body := range bodies {
|
||||
if !bytes.Equal(body, content) {
|
||||
t.Errorf("caller %d got %d bytes, want %d", i, len(body), len(content))
|
||||
}
|
||||
}
|
||||
if got := fetcher.calls.Load(); got != 1 {
|
||||
t.Errorf("upstream fetches = %d, want 1", got)
|
||||
}
|
||||
}
|
||||
|
|
@ -1,7 +1,6 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
|
|
@ -10,12 +9,13 @@ import (
|
|||
"path"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/purl"
|
||||
)
|
||||
|
||||
const (
|
||||
composerUpstream = "https://packagist.org"
|
||||
composerRepo = "https://repo.packagist.org"
|
||||
composerUnset = "__unset"
|
||||
vendorPackageParts = 2
|
||||
)
|
||||
|
||||
|
|
@ -37,15 +37,6 @@ func NewComposerHandler(proxy *Proxy, proxyURL string) *ComposerHandler {
|
|||
}
|
||||
}
|
||||
|
||||
// NewComposerHandlerWithUpstreams creates a Composer handler with custom API
|
||||
// and repository upstreams.
|
||||
func NewComposerHandlerWithUpstreams(proxy *Proxy, proxyURL, upstreamURL, repoURL string) *ComposerHandler {
|
||||
h := NewComposerHandler(proxy, proxyURL)
|
||||
h.upstreamURL = configuredUpstreamURL(upstreamURL, composerUpstream)
|
||||
h.repoURL = configuredUpstreamURL(repoURL, composerRepo)
|
||||
return h
|
||||
}
|
||||
|
||||
// Routes returns the HTTP handler for Composer requests.
|
||||
func (h *ComposerHandler) Routes() http.Handler {
|
||||
mux := http.NewServeMux()
|
||||
|
|
@ -77,7 +68,7 @@ func (h *ComposerHandler) handleServiceIndex(w http.ResponseWriter, r *http.Requ
|
|||
"providers-lazy-url": h.proxyURL + "/composer/p2/%package%.json",
|
||||
}
|
||||
|
||||
w.Header().Set(headerContentType, "application/json")
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_ = json.NewEncoder(w).Encode(index)
|
||||
}
|
||||
|
||||
|
|
@ -113,12 +104,12 @@ func (h *ComposerHandler) handlePackageMetadata(w http.ResponseWriter, r *http.R
|
|||
rewritten, err := h.rewriteMetadata(body)
|
||||
if err != nil {
|
||||
h.proxy.Logger.Warn("failed to rewrite metadata, proxying original", "error", err)
|
||||
w.Header().Set(headerContentType, "application/json")
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = w.Write(body)
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set(headerContentType, "application/json")
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = w.Write(rewritten)
|
||||
}
|
||||
|
||||
|
|
@ -159,8 +150,7 @@ func (h *ComposerHandler) rewriteMetadata(body []byte) ([]byte, error) {
|
|||
|
||||
// expandMinifiedVersions expands the Composer v2 minified format where each
|
||||
// version entry only contains fields that differ from the previous entry.
|
||||
// The "~dev" sentinel string resets the inheritance chain, and the "__unset"
|
||||
// value removes a field from the inherited state.
|
||||
// The "~dev" sentinel string resets the inheritance chain.
|
||||
func expandMinifiedVersions(versionList []any) []any {
|
||||
expanded := make([]any, 0, len(versionList))
|
||||
inherited := map[string]any{}
|
||||
|
|
@ -184,10 +174,6 @@ func expandMinifiedVersions(versionList []any) []any {
|
|||
merged[k] = deepCopyValue(val)
|
||||
}
|
||||
for k, val := range vmap {
|
||||
if val == composerUnset {
|
||||
delete(merged, k)
|
||||
continue
|
||||
}
|
||||
merged[k] = val
|
||||
}
|
||||
|
||||
|
|
@ -223,7 +209,7 @@ func deepCopyValue(v any) any {
|
|||
// filterAndRewriteVersions applies cooldown filtering and rewrites dist URLs
|
||||
// for a single package's version list.
|
||||
func (h *ComposerHandler) filterAndRewriteVersions(packageName string, versionList []any) []any {
|
||||
packagePURL := canonicalPackagePURL("composer", packageName)
|
||||
packagePURL := purl.MakePURLString("composer", packageName, "")
|
||||
|
||||
filtered := versionList[:0]
|
||||
for _, v := range versionList {
|
||||
|
|
@ -315,127 +301,50 @@ func (h *ComposerHandler) handleDownload(w http.ResponseWriter, r *http.Request)
|
|||
h.proxy.Logger.Info("composer download request",
|
||||
"package", packageName, "version", version, "filename", filename)
|
||||
|
||||
// We need to fetch the metadata to get the actual download URL since
|
||||
// Packagist URLs include a hash. Packagist serves dev versions (e.g.
|
||||
// "3.x-dev", "dev-master") from a separate "~dev" metadata file, while
|
||||
// tagged releases live in the regular file. Try the file most likely to
|
||||
// contain this version first, then fall back to the other so that both
|
||||
// stable and dev versions resolve correctly.
|
||||
metaURLs := h.metadataURLsForVersion(vendor, pkg, version)
|
||||
// We need to fetch the metadata to get the actual download URL
|
||||
// since Packagist URLs include a hash
|
||||
metaURL := fmt.Sprintf("%s/p2/%s/%s.json", h.repoURL, vendor, pkg)
|
||||
|
||||
h.proxy.Logger.Debug("resolving download URL",
|
||||
"package", packageName, "version", version,
|
||||
"metadata_urls", metaURLs)
|
||||
|
||||
var downloadURL string
|
||||
for _, metaURL := range metaURLs {
|
||||
url, err := h.findDownloadURLFromMetadata(r.Context(), metaURL, packageName, version)
|
||||
req, err := http.NewRequestWithContext(r.Context(), http.MethodGet, metaURL, nil)
|
||||
if err != nil {
|
||||
h.proxy.Logger.Error("failed to fetch metadata", "error", err, "url", metaURL)
|
||||
http.Error(w, "failed to fetch metadata", http.StatusBadGateway)
|
||||
http.Error(w, "failed to create request", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
if url != "" {
|
||||
downloadURL = url
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if downloadURL == "" {
|
||||
h.proxy.Logger.Debug("version not found in any metadata source",
|
||||
"package", packageName, "version", version,
|
||||
"tried_urls", metaURLs)
|
||||
http.Error(w, "version not found", http.StatusNotFound)
|
||||
return
|
||||
}
|
||||
|
||||
h.proxy.Logger.Debug("resolved download URL",
|
||||
"package", packageName, "version", version,
|
||||
"download_url", downloadURL)
|
||||
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURL(r.Context(), "composer", packageName, version, filename, downloadURL)
|
||||
if err != nil {
|
||||
h.proxy.serveArtifactError(w, err, "failed to fetch package")
|
||||
return
|
||||
}
|
||||
|
||||
ServeArtifact(w, result)
|
||||
}
|
||||
|
||||
// isDevVersion reports whether a Composer version string refers to a
|
||||
// development (unstable, branch) version rather than a tagged release.
|
||||
// Composer formats these as either "dev-<branch>" (e.g. "dev-master") or
|
||||
// "<alias>-dev" (e.g. "3.x-dev").
|
||||
func isDevVersion(version string) bool {
|
||||
return strings.HasPrefix(version, "dev-") || strings.HasSuffix(version, "-dev")
|
||||
}
|
||||
|
||||
// metadataURLsForVersion returns the upstream metadata URLs to consult for a
|
||||
// given version, in priority order. Dev versions are served from the "~dev"
|
||||
// file, tagged releases from the regular file; the other file is included as a
|
||||
// fallback so an unexpected classification still resolves.
|
||||
func (h *ComposerHandler) metadataURLsForVersion(vendor, pkg, version string) []string {
|
||||
stable := fmt.Sprintf("%s/p2/%s/%s.json", h.repoURL, vendor, pkg)
|
||||
dev := fmt.Sprintf("%s/p2/%s/%s~dev.json", h.repoURL, vendor, pkg)
|
||||
|
||||
if isDevVersion(version) {
|
||||
return []string{dev, stable}
|
||||
}
|
||||
return []string{stable, dev}
|
||||
}
|
||||
|
||||
// findDownloadURLFromMetadata fetches a metadata document and returns the dist
|
||||
// URL for the given version, or an empty string if the version is not present.
|
||||
// An error is returned only on transport failure; a missing document (non-200)
|
||||
// or a missing version both yield an empty string so the caller can fall back.
|
||||
func (h *ComposerHandler) findDownloadURLFromMetadata(ctx context.Context, metaURL, packageName, version string) (string, error) {
|
||||
h.proxy.Logger.Debug("fetching upstream metadata for download lookup",
|
||||
"url", metaURL, "package", packageName, "version", version)
|
||||
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodGet, metaURL, nil)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
resp, err := h.proxy.HTTPClient.Do(req)
|
||||
if err != nil {
|
||||
return "", err
|
||||
h.proxy.Logger.Error("failed to fetch metadata", "error", err)
|
||||
http.Error(w, "failed to fetch metadata", http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
h.proxy.Logger.Debug("upstream metadata response",
|
||||
"url", metaURL, "status", resp.StatusCode)
|
||||
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return "", nil
|
||||
http.Error(w, "package not found", http.StatusNotFound)
|
||||
return
|
||||
}
|
||||
|
||||
var metadata map[string]any
|
||||
if err := json.NewDecoder(resp.Body).Decode(&metadata); err != nil {
|
||||
return "", err
|
||||
http.Error(w, "failed to parse metadata", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
|
||||
// Expand minified Composer v2 format so that inherited fields (including
|
||||
// dist) are present on every version entry. Without this, versions that
|
||||
// inherit dist from a previous entry will appear to have no download URL.
|
||||
if metadata["minified"] == "composer/2.0" {
|
||||
h.proxy.Logger.Debug("expanding minified metadata", "url", metaURL)
|
||||
if packages, ok := metadata["packages"].(map[string]any); ok {
|
||||
for pkgName, versions := range packages {
|
||||
versionList, ok := versions.([]any)
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
packages[pkgName] = expandMinifiedVersions(versionList)
|
||||
}
|
||||
}
|
||||
// Find the download URL for this version
|
||||
downloadURL := h.findDownloadURL(metadata, packageName, version)
|
||||
if downloadURL == "" {
|
||||
http.Error(w, "version not found", http.StatusNotFound)
|
||||
return
|
||||
}
|
||||
|
||||
url := h.findDownloadURL(metadata, packageName, version)
|
||||
h.proxy.Logger.Debug("download URL lookup result",
|
||||
"url", metaURL, "package", packageName, "version", version,
|
||||
"download_url", url)
|
||||
return url, nil
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURL(r.Context(), "composer", packageName, version, filename, downloadURL)
|
||||
if err != nil {
|
||||
h.proxy.Logger.Error("failed to get artifact", "error", err)
|
||||
http.Error(w, "failed to fetch package", http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
|
||||
ServeArtifact(w, result)
|
||||
}
|
||||
|
||||
// findDownloadURL finds the dist URL for a specific version in metadata.
|
||||
|
|
|
|||
|
|
@ -1,16 +1,13 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"log/slog"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/cooldown"
|
||||
"github.com/git-pkgs/proxy/internal/cooldown"
|
||||
)
|
||||
|
||||
func TestComposerRewriteMetadata(t *testing.T) {
|
||||
|
|
@ -180,80 +177,6 @@ func TestComposerRewriteMetadataMinifiedDevReset(t *testing.T) {
|
|||
}
|
||||
}
|
||||
|
||||
func TestComposerRewriteMetadataUnset(t *testing.T) {
|
||||
h := &ComposerHandler{
|
||||
proxy: &Proxy{Logger: slog.Default()},
|
||||
proxyURL: "http://localhost:8080",
|
||||
}
|
||||
|
||||
// In the minified format, "__unset" removes a field from the inherited
|
||||
// state. v1.29.0 has require-dev, v1.28.0 unsets it, v1.27.0 inherits the
|
||||
// unset state. Composer rejects metadata where require-dev (or any link
|
||||
// field) is the literal string "__unset" rather than an object.
|
||||
input := `{
|
||||
"minified": "composer/2.0",
|
||||
"packages": {
|
||||
"venturecraft/revisionable": [
|
||||
{
|
||||
"name": "venturecraft/revisionable",
|
||||
"version": "1.29.0",
|
||||
"require": {"php": ">=5.4"},
|
||||
"require-dev": {"orchestra/testbench": "~3.0"},
|
||||
"dist": {"url": "https://example.com/a.zip", "type": "zip"}
|
||||
},
|
||||
{
|
||||
"version": "1.28.0",
|
||||
"require-dev": "__unset"
|
||||
},
|
||||
{
|
||||
"version": "1.27.0"
|
||||
},
|
||||
{
|
||||
"version": "1.26.0",
|
||||
"require-dev": {"foo/bar": "1.0"}
|
||||
}
|
||||
]
|
||||
}
|
||||
}`
|
||||
|
||||
output, err := h.rewriteMetadata([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("rewriteMetadata failed: %v", err)
|
||||
}
|
||||
|
||||
var result map[string]any
|
||||
if err := json.Unmarshal(output, &result); err != nil {
|
||||
t.Fatalf("failed to parse output: %v", err)
|
||||
}
|
||||
|
||||
versions := result["packages"].(map[string]any)["venturecraft/revisionable"].([]any)
|
||||
if len(versions) != 4 {
|
||||
t.Fatalf("expected 4 versions, got %d", len(versions))
|
||||
}
|
||||
|
||||
byVersion := map[string]map[string]any{}
|
||||
for _, v := range versions {
|
||||
vmap := v.(map[string]any)
|
||||
byVersion[vmap["version"].(string)] = vmap
|
||||
}
|
||||
|
||||
if _, ok := byVersion["1.29.0"]["require-dev"].(map[string]any); !ok {
|
||||
t.Errorf("1.29.0 require-dev should be an object, got %T", byVersion["1.29.0"]["require-dev"])
|
||||
}
|
||||
if rd, ok := byVersion["1.28.0"]["require-dev"]; ok {
|
||||
t.Errorf("1.28.0 require-dev should be absent, got %v", rd)
|
||||
}
|
||||
if rd, ok := byVersion["1.27.0"]["require-dev"]; ok {
|
||||
t.Errorf("1.27.0 require-dev should be absent (inherited unset), got %v", rd)
|
||||
}
|
||||
if _, ok := byVersion["1.26.0"]["require-dev"].(map[string]any); !ok {
|
||||
t.Errorf("1.26.0 require-dev should be an object, got %T", byVersion["1.26.0"]["require-dev"])
|
||||
}
|
||||
if _, ok := byVersion["1.27.0"]["require"].(map[string]any); !ok {
|
||||
t.Error("1.27.0 should still inherit require from 1.29.0")
|
||||
}
|
||||
}
|
||||
|
||||
func TestComposerRewriteMetadataCooldownPreservesNames(t *testing.T) {
|
||||
now := time.Now()
|
||||
old := now.Add(-10 * 24 * time.Hour).Format(time.RFC3339)
|
||||
|
|
@ -468,100 +391,6 @@ func TestComposerExpandMinifiedSharedDistReferences(t *testing.T) {
|
|||
}
|
||||
}
|
||||
|
||||
// TestComposerDownloadDevVersionUsesDevMetadata is a regression test for the
|
||||
// bug that made it impossible to install a *-dev dependency from dist.
|
||||
//
|
||||
// Packagist serves development versions (e.g. "3.x-dev", "dev-master") from a
|
||||
// separate "{package}~dev.json" metadata file; the regular "{package}.json"
|
||||
// file contains only tagged releases. The download handler used to fetch only
|
||||
// the regular file, so it could never find the dist URL for a dev version and
|
||||
// returned 404 — causing Composer to silently fall back to a git clone.
|
||||
//
|
||||
// This test serves both files from a mock upstream and asserts that:
|
||||
// - the OLD behavior (regular file only) cannot resolve the dev version, and
|
||||
// - the FIXED behavior (consulting the ~dev file) does.
|
||||
func TestComposerDownloadDevVersionUsesDevMetadata(t *testing.T) {
|
||||
const (
|
||||
pkg = "phpmd/phpmd"
|
||||
vendor = "phpmd"
|
||||
name = "phpmd"
|
||||
version = "3.x-dev"
|
||||
distURL = "https://api.github.com/repos/phpmd/phpmd/zipball/2a9217f60aaf27bf6ddad9188f254d020ab70745"
|
||||
)
|
||||
|
||||
// Regular metadata: tagged releases only — no dev versions.
|
||||
stableBody := `{
|
||||
"packages": {
|
||||
"phpmd/phpmd": [
|
||||
{"version": "2.15.0", "dist": {"url": "https://example.com/2.15.0.zip", "type": "zip"}}
|
||||
]
|
||||
}
|
||||
}`
|
||||
|
||||
// ~dev metadata: where the 3.x-dev version actually lives.
|
||||
devBody := `{
|
||||
"packages": {
|
||||
"phpmd/phpmd": [
|
||||
{"version": "3.x-dev", "dist": {"url": "` + distURL + `", "type": "zip"}}
|
||||
]
|
||||
}
|
||||
}`
|
||||
|
||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
switch r.URL.Path {
|
||||
case "/p2/phpmd/phpmd.json":
|
||||
_, _ = w.Write([]byte(stableBody))
|
||||
case "/p2/phpmd/phpmd~dev.json":
|
||||
_, _ = w.Write([]byte(devBody))
|
||||
default:
|
||||
http.NotFound(w, r)
|
||||
}
|
||||
}))
|
||||
defer srv.Close()
|
||||
|
||||
h := &ComposerHandler{
|
||||
proxy: testProxy(),
|
||||
repoURL: srv.URL,
|
||||
proxyURL: "http://localhost:8080",
|
||||
}
|
||||
|
||||
ctx := context.Background()
|
||||
|
||||
// OLD behavior: fetching only the regular file fails to resolve the dev
|
||||
// version, which is what produced the 404 before the fix.
|
||||
stableURL := srv.URL + "/p2/phpmd/phpmd.json"
|
||||
got, err := h.findDownloadURLFromMetadata(ctx, stableURL, pkg, version)
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error fetching regular metadata: %v", err)
|
||||
}
|
||||
if got != "" {
|
||||
t.Fatalf("regular metadata unexpectedly contained dev version %q (got %q); "+
|
||||
"the test no longer reproduces the original bug", version, got)
|
||||
}
|
||||
|
||||
// FIXED behavior: the handler consults the ~dev file (it is first in the
|
||||
// candidate list for dev versions) and resolves the dist URL.
|
||||
urls := h.metadataURLsForVersion(vendor, name, version)
|
||||
if len(urls) == 0 || !strings.HasSuffix(urls[0], "/p2/phpmd/phpmd~dev.json") {
|
||||
t.Fatalf("dev version should consult the ~dev metadata file first, got %v", urls)
|
||||
}
|
||||
|
||||
var resolved string
|
||||
for _, u := range urls {
|
||||
resolved, err = h.findDownloadURLFromMetadata(ctx, u, pkg, version)
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error fetching metadata %q: %v", u, err)
|
||||
}
|
||||
if resolved != "" {
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if resolved != distURL {
|
||||
t.Errorf("dev version dist URL = %q, want %q", resolved, distURL)
|
||||
}
|
||||
}
|
||||
|
||||
func TestComposerRewriteMetadataCooldown(t *testing.T) {
|
||||
now := time.Now()
|
||||
old := now.Add(-10 * 24 * time.Hour).Format(time.RFC3339)
|
||||
|
|
|
|||
|
|
@ -27,13 +27,6 @@ func NewConanHandler(proxy *Proxy, proxyURL string) *ConanHandler {
|
|||
}
|
||||
}
|
||||
|
||||
// NewConanHandlerWithUpstream creates a Conan handler with a custom upstream.
|
||||
func NewConanHandlerWithUpstream(proxy *Proxy, proxyURL, upstreamURL string) *ConanHandler {
|
||||
h := NewConanHandler(proxy, proxyURL)
|
||||
h.upstreamURL = configuredUpstreamURL(upstreamURL, conanUpstream)
|
||||
return h
|
||||
}
|
||||
|
||||
// Routes returns the HTTP handler for Conan requests.
|
||||
func (h *ConanHandler) Routes() http.Handler {
|
||||
mux := http.NewServeMux()
|
||||
|
|
@ -91,7 +84,8 @@ func (h *ConanHandler) handleRecipeFile(w http.ResponseWriter, r *http.Request)
|
|||
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURL(r.Context(), "conan", packageName, storageVersion, storageFilename, upstreamURL)
|
||||
if err != nil {
|
||||
h.proxy.serveArtifactError(w, err, "failed to fetch file")
|
||||
h.proxy.Logger.Error("failed to get artifact", "error", err)
|
||||
http.Error(w, "failed to fetch file", http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
|
||||
|
|
@ -128,7 +122,8 @@ func (h *ConanHandler) handlePackageFile(w http.ResponseWriter, r *http.Request)
|
|||
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURL(r.Context(), "conan", packageName, storageVersion, storageFilename, upstreamURL)
|
||||
if err != nil {
|
||||
h.proxy.serveArtifactError(w, err, "failed to fetch file")
|
||||
h.proxy.Logger.Error("failed to get artifact", "error", err)
|
||||
http.Error(w, "failed to fetch file", http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ import (
|
|||
"net/http"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/purl"
|
||||
)
|
||||
|
||||
const (
|
||||
|
|
@ -29,13 +31,6 @@ func NewCondaHandler(proxy *Proxy, proxyURL string) *CondaHandler {
|
|||
}
|
||||
}
|
||||
|
||||
// NewCondaHandlerWithUpstream creates a Conda handler with a custom upstream.
|
||||
func NewCondaHandlerWithUpstream(proxy *Proxy, proxyURL, upstreamURL string) *CondaHandler {
|
||||
h := NewCondaHandler(proxy, proxyURL)
|
||||
h.upstreamURL = configuredUpstreamURL(upstreamURL, condaUpstream)
|
||||
return h
|
||||
}
|
||||
|
||||
// Routes returns the HTTP handler for Conda requests.
|
||||
func (h *CondaHandler) Routes() http.Handler {
|
||||
mux := http.NewServeMux()
|
||||
|
|
@ -79,7 +74,8 @@ func (h *CondaHandler) handleDownload(w http.ResponseWriter, r *http.Request) {
|
|||
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURL(r.Context(), "conda", packageName, version, filename, upstreamURL)
|
||||
if err != nil {
|
||||
h.proxy.serveArtifactError(w, err, "failed to fetch package")
|
||||
h.proxy.Logger.Error("failed to get artifact", "error", err)
|
||||
http.Error(w, "failed to fetch package", http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
|
||||
|
|
@ -165,7 +161,7 @@ func (h *CondaHandler) handleRepodata(w http.ResponseWriter, r *http.Request) {
|
|||
return
|
||||
}
|
||||
|
||||
body, err := h.proxy.ReadMetadata(resp.Body)
|
||||
body, err := ReadMetadata(resp.Body)
|
||||
if err != nil {
|
||||
http.Error(w, "failed to read response", http.StatusInternalServerError)
|
||||
return
|
||||
|
|
@ -174,12 +170,12 @@ func (h *CondaHandler) handleRepodata(w http.ResponseWriter, r *http.Request) {
|
|||
filtered, err := h.applyCooldownFiltering(body)
|
||||
if err != nil {
|
||||
h.proxy.Logger.Warn("failed to filter repodata, proxying original", "error", err)
|
||||
w.Header().Set(headerContentType, "application/json")
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = w.Write(body)
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set(headerContentType, "application/json")
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = w.Write(filtered)
|
||||
}
|
||||
|
||||
|
|
@ -222,7 +218,7 @@ func (h *CondaHandler) applyCooldownFiltering(body []byte) ([]byte, error) {
|
|||
continue
|
||||
}
|
||||
|
||||
packagePURL := canonicalPackagePURL("conda", name)
|
||||
packagePURL := purl.MakePURLString("conda", name, "")
|
||||
|
||||
if !h.proxy.Cooldown.IsAllowed("conda", packagePURL, publishedAt) {
|
||||
version, _ := entryMap["version"].(string)
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ import (
|
|||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/cooldown"
|
||||
"github.com/git-pkgs/proxy/internal/cooldown"
|
||||
)
|
||||
|
||||
func TestCondaParseFilename(t *testing.T) {
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@ package handler
|
|||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"regexp"
|
||||
"strings"
|
||||
|
|
@ -11,10 +11,10 @@ import (
|
|||
|
||||
const (
|
||||
dockerHubRegistry = "https://registry-1.docker.io"
|
||||
dockerHubAuth = "https://auth.docker.io"
|
||||
blobMatchCount = 3 // full match + name + digest
|
||||
manifestMatchCount = 3 // full match + name + reference
|
||||
tagsListMatchCount = 2 // full match + name
|
||||
registrySelectorParts = 3 // upstream + name + repository
|
||||
)
|
||||
|
||||
// ContainerHandler handles OCI/Docker container registry protocol requests.
|
||||
|
|
@ -23,75 +23,18 @@ const (
|
|||
type ContainerHandler struct {
|
||||
proxy *Proxy
|
||||
registryURL string
|
||||
authURL string
|
||||
proxyURL string
|
||||
namedRegistries map[string]string
|
||||
registries []containerRegistry
|
||||
}
|
||||
|
||||
type containerRegistry struct {
|
||||
repositoryPrefix string
|
||||
registryURL string
|
||||
}
|
||||
|
||||
// NewContainerHandler creates a new container registry protocol handler.
|
||||
// Named registries are selected with the repository prefix
|
||||
// upstream/{name}/, leaving unprefixed requests compatible with the Docker Hub
|
||||
// mirror behavior.
|
||||
func NewContainerHandler(proxy *Proxy, proxyURL string, namedRegistries ...map[string]string) *ContainerHandler {
|
||||
h := &ContainerHandler{
|
||||
func NewContainerHandler(proxy *Proxy, proxyURL string) *ContainerHandler {
|
||||
return &ContainerHandler{
|
||||
proxy: proxy,
|
||||
registryURL: dockerHubRegistry,
|
||||
authURL: dockerHubAuth,
|
||||
proxyURL: strings.TrimSuffix(proxyURL, "/"),
|
||||
}
|
||||
if len(namedRegistries) > 0 {
|
||||
h.namedRegistries = make(map[string]string, len(namedRegistries[0]))
|
||||
for name, registryURL := range namedRegistries[0] {
|
||||
h.namedRegistries[name] = strings.TrimSuffix(registryURL, "/")
|
||||
}
|
||||
}
|
||||
return h
|
||||
}
|
||||
|
||||
// NewContainerHandlerWithRegistry creates a container handler with a custom
|
||||
// default registry and optional named registries.
|
||||
func NewContainerHandlerWithRegistry(
|
||||
proxy *Proxy,
|
||||
proxyURL, registryURL string,
|
||||
namedRegistries ...map[string]string,
|
||||
) *ContainerHandler {
|
||||
h := NewContainerHandler(proxy, proxyURL, namedRegistries...)
|
||||
h.registryURL = configuredUpstreamURL(registryURL, dockerHubRegistry)
|
||||
return h
|
||||
}
|
||||
|
||||
// RegisterRegistry routes a repository and its descendants to a specific OCI
|
||||
// registry. The longest matching repository prefix wins.
|
||||
func (h *ContainerHandler) RegisterRegistry(repositoryPrefix, registryURL string) {
|
||||
h.registries = append(h.registries, containerRegistry{
|
||||
repositoryPrefix: strings.Trim(repositoryPrefix, "/"),
|
||||
registryURL: strings.TrimSuffix(registryURL, "/"),
|
||||
})
|
||||
}
|
||||
|
||||
// BlockRegistry prevents a repository and its descendants from falling back to
|
||||
// the default OCI registry. A more specific registered repository still wins.
|
||||
func (h *ContainerHandler) BlockRegistry(repositoryPrefix string) {
|
||||
h.RegisterRegistry(repositoryPrefix, "")
|
||||
}
|
||||
|
||||
func (h *ContainerHandler) registryURLFor(name string) string {
|
||||
registryURL := h.registryURL
|
||||
matchLength := 0
|
||||
for _, registry := range h.registries {
|
||||
if name != registry.repositoryPrefix && !strings.HasPrefix(name, registry.repositoryPrefix+"/") {
|
||||
continue
|
||||
}
|
||||
if len(registry.repositoryPrefix) > matchLength {
|
||||
registryURL = registry.registryURL
|
||||
matchLength = len(registry.repositoryPrefix)
|
||||
}
|
||||
}
|
||||
return registryURL
|
||||
}
|
||||
|
||||
// Routes returns the HTTP handler for container registry requests.
|
||||
|
|
@ -144,74 +87,48 @@ func (h *ContainerHandler) handleBlobDownload(w http.ResponseWriter, r *http.Req
|
|||
return
|
||||
}
|
||||
|
||||
registryURL, upstreamName, cacheName, ok := h.registryForName(name)
|
||||
if !ok {
|
||||
h.containerError(w, http.StatusNotFound, "NAME_UNKNOWN", "unknown upstream registry")
|
||||
return
|
||||
}
|
||||
h.proxy.Logger.Info("container blob request", "name", name, "digest", digest)
|
||||
|
||||
h.proxy.Logger.Info("container blob request", "name", upstreamName, "digest", digest)
|
||||
|
||||
filename := digest
|
||||
cached, err := h.proxy.GetCachedArtifact(r.Context(), "oci", cacheName, digest, filename)
|
||||
// Get auth token for upstream
|
||||
token, err := h.getAuthToken(r.Context(), name, "pull")
|
||||
if err != nil {
|
||||
h.proxy.Logger.Error("failed to check blob cache", "error", err)
|
||||
h.containerError(w, http.StatusInternalServerError, "INTERNAL_ERROR", "failed to check blob cache")
|
||||
return
|
||||
}
|
||||
if cached != nil {
|
||||
w.Header().Set("Docker-Content-Digest", digest)
|
||||
if cached.Artifact.MediaType == "" {
|
||||
cached.Artifact.MediaType = "application/octet-stream"
|
||||
}
|
||||
serveArtifact(w, r.Method, cached)
|
||||
h.proxy.Logger.Error("failed to get auth token", "error", err)
|
||||
h.containerError(w, http.StatusUnauthorized, "UNAUTHORIZED", "failed to authenticate")
|
||||
return
|
||||
}
|
||||
|
||||
// For HEAD requests, just proxy to upstream
|
||||
if r.Method == http.MethodHead {
|
||||
h.proxyBlobHead(w, r, registryURL, upstreamName, digest)
|
||||
h.proxyBlobHead(w, r, name, digest, token)
|
||||
return
|
||||
}
|
||||
|
||||
// Try to get from cache, or fetch from the authentication-aware upstream client.
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURLWithDigest(
|
||||
// Try to get from cache, or fetch from upstream with auth
|
||||
filename := digest
|
||||
headers := http.Header{"Authorization": {"Bearer " + token}}
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURLWithHeaders(
|
||||
r.Context(),
|
||||
"oci",
|
||||
cacheName,
|
||||
name,
|
||||
digest, // use digest as version
|
||||
filename,
|
||||
fmt.Sprintf("%s/v2/%s/blobs/%s", registryURL, upstreamName, digest),
|
||||
digest,
|
||||
fmt.Sprintf("%s/v2/%s/blobs/%s", h.registryURL, name, digest),
|
||||
headers,
|
||||
)
|
||||
|
||||
if err != nil {
|
||||
if errors.Is(err, ErrUpstreamNotFound) {
|
||||
h.containerError(w, http.StatusNotFound, "BLOB_UNKNOWN", "blob unknown to registry")
|
||||
return
|
||||
}
|
||||
if errors.Is(err, ErrArtifactBlocked) {
|
||||
h.containerError(w, http.StatusForbidden, "DENIED", err.Error())
|
||||
return
|
||||
}
|
||||
if errors.Is(err, ErrArtifactDigestMismatch) {
|
||||
h.proxy.Logger.Error("upstream blob failed digest verification", "error", err)
|
||||
h.containerError(w, http.StatusBadGateway, "DIGEST_INVALID", "blob digest verification failed")
|
||||
return
|
||||
}
|
||||
h.proxy.Logger.Error("failed to fetch blob", "error", err)
|
||||
h.containerError(w, http.StatusBadGateway, "INTERNAL_ERROR", "failed to fetch blob")
|
||||
h.containerError(w, http.StatusBadGateway, "BLOB_UNKNOWN", "failed to fetch blob")
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set("Docker-Content-Digest", digest)
|
||||
if result.Artifact.MediaType == "" {
|
||||
result.Artifact.MediaType = "application/octet-stream"
|
||||
}
|
||||
w.Header().Set("Content-Type", "application/octet-stream")
|
||||
ServeArtifact(w, result)
|
||||
}
|
||||
|
||||
// handleManifest serves immutable manifests from cache and revalidates mutable tags.
|
||||
// handleManifest proxies manifest requests to upstream.
|
||||
// Manifests change when tags are updated, so we proxy these directly.
|
||||
// Path format: {name}/manifests/{reference}
|
||||
func (h *ContainerHandler) handleManifest(w http.ResponseWriter, r *http.Request, path string) {
|
||||
if r.Method != http.MethodGet && r.Method != http.MethodHead {
|
||||
|
|
@ -225,17 +142,61 @@ func (h *ContainerHandler) handleManifest(w http.ResponseWriter, r *http.Request
|
|||
return
|
||||
}
|
||||
|
||||
registryURL, upstreamName, _, ok := h.registryForName(name)
|
||||
if !ok {
|
||||
h.containerError(w, http.StatusNotFound, "NAME_UNKNOWN", "unknown upstream registry")
|
||||
h.proxy.Logger.Info("container manifest request", "name", name, "reference", reference)
|
||||
|
||||
// Get auth token
|
||||
token, err := h.getAuthToken(r.Context(), name, "pull")
|
||||
if err != nil {
|
||||
h.proxy.Logger.Error("failed to get auth token", "error", err)
|
||||
h.containerError(w, http.StatusUnauthorized, "UNAUTHORIZED", "failed to authenticate")
|
||||
return
|
||||
}
|
||||
|
||||
h.proxy.Logger.Info("container manifest request", "name", upstreamName, "reference", reference)
|
||||
h.serveManifest(w, r, registryURL, upstreamName, reference)
|
||||
// Proxy to upstream
|
||||
upstreamURL := fmt.Sprintf("%s/v2/%s/manifests/%s", h.registryURL, name, reference)
|
||||
|
||||
req, err := http.NewRequestWithContext(r.Context(), r.Method, upstreamURL, nil)
|
||||
if err != nil {
|
||||
h.containerError(w, http.StatusInternalServerError, "INTERNAL_ERROR", "failed to create request")
|
||||
return
|
||||
}
|
||||
|
||||
// handleTagsList caches tag list responses for offline OCI pulls.
|
||||
req.Header.Set("Authorization", "Bearer "+token)
|
||||
|
||||
// Forward Accept header for content negotiation
|
||||
if accept := r.Header.Get("Accept"); accept != "" {
|
||||
req.Header.Set("Accept", accept)
|
||||
} else {
|
||||
// Default accept headers for manifests
|
||||
req.Header.Set("Accept", strings.Join([]string{
|
||||
"application/vnd.oci.image.manifest.v1+json",
|
||||
"application/vnd.oci.image.index.v1+json",
|
||||
"application/vnd.docker.distribution.manifest.v2+json",
|
||||
"application/vnd.docker.distribution.manifest.list.v2+json",
|
||||
"application/vnd.docker.distribution.manifest.v1+prettyjws",
|
||||
}, ", "))
|
||||
}
|
||||
|
||||
resp, err := h.proxy.HTTPClient.Do(req)
|
||||
if err != nil {
|
||||
h.proxy.Logger.Error("failed to fetch manifest", "error", err)
|
||||
h.containerError(w, http.StatusBadGateway, "INTERNAL_ERROR", "failed to fetch from upstream")
|
||||
return
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
// Copy relevant headers
|
||||
for _, header := range []string{"Content-Type", "Content-Length", "Docker-Content-Digest", "ETag"} {
|
||||
if v := resp.Header.Get(header); v != "" {
|
||||
w.Header().Set(header, v)
|
||||
}
|
||||
}
|
||||
|
||||
w.WriteHeader(resp.StatusCode)
|
||||
_, _ = io.Copy(w, resp.Body)
|
||||
}
|
||||
|
||||
// handleTagsList proxies tag list requests to upstream.
|
||||
func (h *ContainerHandler) handleTagsList(w http.ResponseWriter, r *http.Request, path string) {
|
||||
if r.Method != http.MethodGet {
|
||||
http.Error(w, "method not allowed", http.StatusMethodNotAllowed)
|
||||
|
|
@ -248,25 +209,26 @@ func (h *ContainerHandler) handleTagsList(w http.ResponseWriter, r *http.Request
|
|||
return
|
||||
}
|
||||
|
||||
registryURL, upstreamName, _, ok := h.registryForName(name)
|
||||
if !ok {
|
||||
h.containerError(w, http.StatusNotFound, "NAME_UNKNOWN", "unknown upstream registry")
|
||||
// Get auth token
|
||||
token, err := h.getAuthToken(r.Context(), name, "pull")
|
||||
if err != nil {
|
||||
h.containerError(w, http.StatusUnauthorized, "UNAUTHORIZED", "failed to authenticate")
|
||||
return
|
||||
}
|
||||
|
||||
h.serveTagsList(w, r, registryURL, upstreamName)
|
||||
upstreamURL := fmt.Sprintf("%s/v2/%s/tags/list", h.registryURL, name)
|
||||
if r.URL.RawQuery != "" {
|
||||
upstreamURL += "?" + r.URL.RawQuery
|
||||
}
|
||||
|
||||
// proxyBlobHead handles HEAD requests for blobs.
|
||||
func (h *ContainerHandler) proxyBlobHead(w http.ResponseWriter, r *http.Request, registryURL, name, digest string) {
|
||||
upstreamURL := fmt.Sprintf("%s/v2/%s/blobs/%s", registryURL, name, digest)
|
||||
|
||||
req, err := http.NewRequestWithContext(r.Context(), http.MethodHead, upstreamURL, nil)
|
||||
req, err := http.NewRequestWithContext(r.Context(), http.MethodGet, upstreamURL, nil)
|
||||
if err != nil {
|
||||
h.containerError(w, http.StatusInternalServerError, "INTERNAL_ERROR", "failed to create request")
|
||||
return
|
||||
}
|
||||
|
||||
req.Header.Set("Authorization", "Bearer "+token)
|
||||
|
||||
resp, err := h.proxy.HTTPClient.Do(req)
|
||||
if err != nil {
|
||||
h.containerError(w, http.StatusBadGateway, "INTERNAL_ERROR", "failed to fetch from upstream")
|
||||
|
|
@ -274,44 +236,79 @@ func (h *ContainerHandler) proxyBlobHead(w http.ResponseWriter, r *http.Request,
|
|||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
for _, header := range []string{headerContentType, headerContentLength, "Docker-Content-Digest", headerETag, headerLastModified} {
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
w.WriteHeader(resp.StatusCode)
|
||||
_, _ = io.Copy(w, resp.Body)
|
||||
}
|
||||
|
||||
// getAuthToken gets a bearer token for the specified repository.
|
||||
// Docker Hub requires auth even for public images.
|
||||
func (h *ContainerHandler) getAuthToken(_ interface{ Done() <-chan struct{} }, repository, action string) (string, error) {
|
||||
// For Docker Hub: https://auth.docker.io/token?service=registry.docker.io&scope=repository:{repo}:pull
|
||||
authURL := fmt.Sprintf("%s/token?service=registry.docker.io&scope=repository:%s:%s",
|
||||
h.authURL, repository, action)
|
||||
|
||||
req, err := http.NewRequest(http.MethodGet, authURL, nil)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
resp, err := h.proxy.HTTPClient.Do(req)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return "", fmt.Errorf("auth failed with status %d", resp.StatusCode)
|
||||
}
|
||||
|
||||
var tokenResp struct {
|
||||
Token string `json:"token"`
|
||||
AccessToken string `json:"access_token"`
|
||||
}
|
||||
|
||||
if err := json.NewDecoder(resp.Body).Decode(&tokenResp); err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
if tokenResp.Token != "" {
|
||||
return tokenResp.Token, nil
|
||||
}
|
||||
return tokenResp.AccessToken, nil
|
||||
}
|
||||
|
||||
// proxyBlobHead handles HEAD requests for blobs.
|
||||
func (h *ContainerHandler) proxyBlobHead(w http.ResponseWriter, r *http.Request, name, digest, token string) {
|
||||
upstreamURL := fmt.Sprintf("%s/v2/%s/blobs/%s", h.registryURL, name, digest)
|
||||
|
||||
req, err := http.NewRequestWithContext(r.Context(), http.MethodHead, upstreamURL, nil)
|
||||
if err != nil {
|
||||
h.containerError(w, http.StatusInternalServerError, "INTERNAL_ERROR", "failed to create request")
|
||||
return
|
||||
}
|
||||
|
||||
req.Header.Set("Authorization", "Bearer "+token)
|
||||
|
||||
resp, err := h.proxy.HTTPClient.Do(req)
|
||||
if err != nil {
|
||||
h.containerError(w, http.StatusBadGateway, "INTERNAL_ERROR", "failed to fetch from upstream")
|
||||
return
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
for _, header := range []string{"Content-Type", "Content-Length", "Docker-Content-Digest"} {
|
||||
if v := resp.Header.Get(header); v != "" {
|
||||
w.Header().Set(header, v)
|
||||
}
|
||||
}
|
||||
if resp.StatusCode >= http.StatusOK && resp.StatusCode < http.StatusMultipleChoices && w.Header().Get("Docker-Content-Digest") == "" {
|
||||
w.Header().Set("Docker-Content-Digest", digest)
|
||||
}
|
||||
|
||||
w.WriteHeader(resp.StatusCode)
|
||||
}
|
||||
|
||||
// registryForName resolves a client-visible OCI repository name to an upstream
|
||||
// registry and its repository name. Named upstreams use upstream/{name}/ as a
|
||||
// reserved prefix. Other names are matched against registered repository
|
||||
// prefixes, falling back to Docker Hub when no prefix matches.
|
||||
func (h *ContainerHandler) registryForName(name string) (registryURL, upstreamName, cacheName string, ok bool) {
|
||||
parts := strings.SplitN(name, "/", registrySelectorParts)
|
||||
if len(parts) >= 2 && parts[0] == "upstream" {
|
||||
if len(parts) != registrySelectorParts || parts[2] == "" {
|
||||
return "", "", "", false
|
||||
}
|
||||
registryURL, ok = h.namedRegistries[parts[1]]
|
||||
if !ok || registryURL == "" {
|
||||
return "", "", "", false
|
||||
}
|
||||
return registryURL, parts[2], name, true
|
||||
}
|
||||
registryURL = h.registryURLFor(name)
|
||||
if registryURL == "" {
|
||||
return "", "", "", false
|
||||
}
|
||||
return registryURL, name, name, true
|
||||
}
|
||||
|
||||
// containerError writes an OCI-compliant error response.
|
||||
func (h *ContainerHandler) containerError(w http.ResponseWriter, status int, code, message string) {
|
||||
w.Header().Set(headerContentType, "application/json")
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
w.WriteHeader(status)
|
||||
_ = json.NewEncoder(w).Encode(map[string]any{
|
||||
"errors": []map[string]string{
|
||||
|
|
|
|||
|
|
@ -1,434 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/sha256"
|
||||
"encoding/hex"
|
||||
"fmt"
|
||||
"io"
|
||||
"mime"
|
||||
"net/http"
|
||||
"regexp"
|
||||
"sort"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
const (
|
||||
containerManifestCacheEcosystem = "oci-manifest"
|
||||
containerStaleWarning = `110 - "Response is Stale"`
|
||||
|
||||
containerAcceptWildcardSpecificity = iota
|
||||
containerAcceptTypeWildcardSpecificity
|
||||
containerAcceptExactSpecificity
|
||||
)
|
||||
|
||||
var manifestDigestReferencePattern = regexp.MustCompile(`^[a-z0-9]+:[a-f0-9]+$`)
|
||||
|
||||
type cachedContainerManifest struct {
|
||||
body []byte
|
||||
contentType string
|
||||
contentDigest string
|
||||
etag string
|
||||
size int64
|
||||
lastModified time.Time
|
||||
fetchedAt time.Time
|
||||
}
|
||||
|
||||
func (h *ContainerHandler) serveManifest(w http.ResponseWriter, r *http.Request, registryURL, name, reference string) {
|
||||
accept := containerManifestAccept(r)
|
||||
cacheAccept := normalizeContainerManifestAccept(accept)
|
||||
cacheKey := h.containerManifestCacheKey(registryURL, name, reference, cacheAccept)
|
||||
cached := h.loadContainerManifestForAccept(r.Context(), registryURL, name, reference, accept, cacheKey)
|
||||
|
||||
immutable := manifestDigestReferencePattern.MatchString(reference)
|
||||
if cached != nil && (immutable || h.containerManifestFresh(cached)) {
|
||||
writeContainerManifest(w, r, cached, false)
|
||||
return
|
||||
}
|
||||
|
||||
upstreamURL := fmt.Sprintf("%s/v2/%s/manifests/%s", registryURL, name, reference)
|
||||
req, err := http.NewRequestWithContext(r.Context(), r.Method, upstreamURL, nil)
|
||||
if err != nil {
|
||||
h.containerError(w, http.StatusInternalServerError, "INTERNAL_ERROR", "failed to create request")
|
||||
return
|
||||
}
|
||||
req.Header.Set("Accept", accept)
|
||||
if cached != nil && cached.etag != "" {
|
||||
req.Header.Set("If-None-Match", cached.etag)
|
||||
}
|
||||
|
||||
resp, err := h.proxy.HTTPClient.Do(req)
|
||||
if err != nil {
|
||||
h.serveStaleManifestOrError(w, r, cached, err)
|
||||
return
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode == http.StatusNotModified && cached != nil {
|
||||
cached.fetchedAt = time.Now()
|
||||
h.storeContainerManifestForAccept(r.Context(), registryURL, name, reference, accept, cacheAccept, cached)
|
||||
writeContainerManifest(w, r, cached, false)
|
||||
return
|
||||
}
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
if cached != nil && shouldServeStaleManifest(resp.StatusCode) {
|
||||
writeContainerManifest(w, r, cached, true)
|
||||
return
|
||||
}
|
||||
copyContainerManifestHeaders(w.Header(), resp.Header)
|
||||
w.WriteHeader(resp.StatusCode)
|
||||
_, _ = io.Copy(w, resp.Body)
|
||||
return
|
||||
}
|
||||
|
||||
if r.Method == http.MethodHead {
|
||||
copyContainerManifestHeaders(w.Header(), resp.Header)
|
||||
w.WriteHeader(http.StatusOK)
|
||||
return
|
||||
}
|
||||
|
||||
body, err := h.proxy.ReadMetadata(resp.Body)
|
||||
if err != nil {
|
||||
h.serveStaleManifestOrError(w, r, cached, fmt.Errorf("reading manifest: %w", err))
|
||||
return
|
||||
}
|
||||
computedDigest := sha256Digest(body)
|
||||
contentDigest := resp.Header.Get("Docker-Content-Digest")
|
||||
for _, expected := range []string{reference, contentDigest} {
|
||||
if strings.HasPrefix(expected, "sha256:") && expected != computedDigest {
|
||||
h.proxy.Logger.Error("upstream manifest failed digest verification",
|
||||
"name", name, "reference", reference, "expected", expected, "actual", computedDigest)
|
||||
h.containerError(w, http.StatusBadGateway, "DIGEST_INVALID", "manifest digest verification failed")
|
||||
return
|
||||
}
|
||||
}
|
||||
if contentDigest == "" {
|
||||
contentDigest = computedDigest
|
||||
}
|
||||
|
||||
manifest := &cachedContainerManifest{
|
||||
body: body,
|
||||
contentType: resp.Header.Get(headerContentType),
|
||||
contentDigest: contentDigest,
|
||||
etag: resp.Header.Get(headerETag),
|
||||
size: int64(len(body)),
|
||||
lastModified: parseHTTPTime(resp.Header.Get(headerLastModified)),
|
||||
fetchedAt: time.Now(),
|
||||
}
|
||||
h.storeContainerManifestForAccept(r.Context(), registryURL, name, reference, accept, cacheAccept, manifest)
|
||||
if manifest.contentDigest != reference && manifestDigestReferencePattern.MatchString(manifest.contentDigest) {
|
||||
h.storeContainerManifestForAccept(r.Context(), registryURL, name, manifest.contentDigest, accept, cacheAccept, manifest)
|
||||
}
|
||||
writeContainerManifest(w, r, manifest, false)
|
||||
}
|
||||
|
||||
func (h *ContainerHandler) serveStaleManifestOrError(w http.ResponseWriter, r *http.Request, cached *cachedContainerManifest, err error) {
|
||||
if cached != nil {
|
||||
h.proxy.Logger.Warn("upstream manifest fetch failed, serving stale cache", "error", err)
|
||||
writeContainerManifest(w, r, cached, true)
|
||||
return
|
||||
}
|
||||
h.proxy.Logger.Error("failed to fetch manifest", "error", err)
|
||||
h.containerError(w, http.StatusBadGateway, "INTERNAL_ERROR", "failed to fetch from upstream")
|
||||
}
|
||||
|
||||
func (h *ContainerHandler) containerManifestFresh(manifest *cachedContainerManifest) bool {
|
||||
return h.proxy.MetadataTTL > 0 && !manifest.fetchedAt.IsZero() && time.Since(manifest.fetchedAt) < h.proxy.MetadataTTL
|
||||
}
|
||||
|
||||
func (h *ContainerHandler) containerManifestCacheKey(registryURL, name, reference, accept string) string {
|
||||
identity := strings.Join([]string{registryURL, name, reference, accept}, "\x00")
|
||||
sum := sha256.Sum256([]byte(identity))
|
||||
return hex.EncodeToString(sum[:])
|
||||
}
|
||||
|
||||
func (h *ContainerHandler) loadContainerManifestForAccept(ctx context.Context, registryURL, name, reference, accept, cacheKey string) *cachedContainerManifest {
|
||||
cached, err := h.loadContainerManifest(ctx, cacheKey)
|
||||
if err != nil {
|
||||
h.proxy.Logger.Warn("failed to read cached container manifest", "error", err)
|
||||
return nil
|
||||
}
|
||||
if cached != nil {
|
||||
if containerManifestCacheCompatible(accept, cached) {
|
||||
return cached
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
legacyCacheKey := h.containerManifestCacheKey(registryURL, name, reference, accept)
|
||||
if legacyCacheKey == cacheKey {
|
||||
return nil
|
||||
}
|
||||
cached, err = h.loadContainerManifest(ctx, legacyCacheKey)
|
||||
if err != nil {
|
||||
h.proxy.Logger.Warn("failed to read legacy cached container manifest", "error", err)
|
||||
return nil
|
||||
}
|
||||
if cached == nil || !containerManifestCacheCompatible(accept, cached) {
|
||||
return nil
|
||||
}
|
||||
if err := h.storeContainerManifest(ctx, cacheKey, cached); err != nil {
|
||||
h.proxy.Logger.Warn("failed to migrate cached container manifest", "error", err)
|
||||
}
|
||||
return cached
|
||||
}
|
||||
|
||||
func (h *ContainerHandler) storeContainerManifestForAccept(ctx context.Context, registryURL, name, reference, accept, cacheAccept string, manifest *cachedContainerManifest) {
|
||||
cacheKey := h.containerManifestCacheKey(registryURL, name, reference, cacheAccept)
|
||||
if err := h.storeContainerManifest(ctx, cacheKey, manifest); err != nil {
|
||||
h.proxy.Logger.Warn("failed to cache container manifest", "error", err)
|
||||
}
|
||||
|
||||
legacyCacheKey := h.containerManifestCacheKey(registryURL, name, reference, accept)
|
||||
if legacyCacheKey == cacheKey {
|
||||
return
|
||||
}
|
||||
if err := h.storeContainerManifest(ctx, legacyCacheKey, manifest); err != nil {
|
||||
h.proxy.Logger.Warn("failed to cache legacy container manifest", "error", err)
|
||||
}
|
||||
}
|
||||
|
||||
func (h *ContainerHandler) loadContainerManifest(ctx context.Context, cacheKey string) (*cachedContainerManifest, error) {
|
||||
if h.proxy.DB == nil || h.proxy.Storage == nil {
|
||||
return nil, nil
|
||||
}
|
||||
entry, err := h.proxy.DB.GetMetadataCache(containerManifestCacheEcosystem, cacheKey)
|
||||
if err != nil || entry == nil {
|
||||
return nil, err
|
||||
}
|
||||
reader, err := h.proxy.Storage.Open(ctx, entry.StoragePath)
|
||||
if err != nil {
|
||||
return nil, nil
|
||||
}
|
||||
defer func() { _ = reader.Close() }()
|
||||
body, err := h.proxy.ReadMetadata(reader)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
manifest := &cachedContainerManifest{body: body, size: int64(len(body))}
|
||||
if entry.ContentType.Valid {
|
||||
manifest.contentType = entry.ContentType.String
|
||||
}
|
||||
if entry.ContentDigest.Valid {
|
||||
manifest.contentDigest = entry.ContentDigest.String
|
||||
} else {
|
||||
manifest.contentDigest = sha256Digest(body)
|
||||
}
|
||||
if entry.ETag.Valid {
|
||||
manifest.etag = entry.ETag.String
|
||||
}
|
||||
if entry.Size.Valid {
|
||||
manifest.size = entry.Size.Int64
|
||||
}
|
||||
if entry.LastModified.Valid {
|
||||
manifest.lastModified = entry.LastModified.Time
|
||||
}
|
||||
if entry.FetchedAt.Valid {
|
||||
manifest.fetchedAt = entry.FetchedAt.Time
|
||||
}
|
||||
return manifest, nil
|
||||
}
|
||||
|
||||
func (h *ContainerHandler) storeContainerManifest(ctx context.Context, cacheKey string, manifest *cachedContainerManifest) error {
|
||||
size, err := h.storeContainerMetadata(ctx, containerManifestCacheEcosystem, cacheKey, manifest.body,
|
||||
manifest.etag, "", manifest.contentType, manifest.contentDigest, manifest.lastModified, manifest.fetchedAt)
|
||||
if err != nil {
|
||||
return fmt.Errorf("storing manifest: %w", err)
|
||||
}
|
||||
manifest.size = size
|
||||
return nil
|
||||
}
|
||||
|
||||
func writeContainerManifest(w http.ResponseWriter, r *http.Request, manifest *cachedContainerManifest, stale bool) {
|
||||
if manifest.contentType != "" {
|
||||
w.Header().Set(headerContentType, manifest.contentType)
|
||||
}
|
||||
w.Header().Set(headerContentLength, strconv.FormatInt(manifest.size, 10))
|
||||
if manifest.contentDigest != "" {
|
||||
w.Header().Set("Docker-Content-Digest", manifest.contentDigest)
|
||||
}
|
||||
if manifest.etag != "" {
|
||||
w.Header().Set(headerETag, manifest.etag)
|
||||
}
|
||||
if !manifest.lastModified.IsZero() {
|
||||
w.Header().Set(headerLastModified, manifest.lastModified.UTC().Format(http.TimeFormat))
|
||||
}
|
||||
if stale {
|
||||
w.Header().Set("Warning", containerStaleWarning)
|
||||
}
|
||||
if ifNoneMatchHits(r.Header.Get("If-None-Match"), manifest.etag) {
|
||||
w.WriteHeader(http.StatusNotModified)
|
||||
return
|
||||
}
|
||||
if !manifest.lastModified.IsZero() {
|
||||
if modifiedSince, err := http.ParseTime(r.Header.Get("If-Modified-Since")); err == nil && !manifest.lastModified.After(modifiedSince) {
|
||||
w.WriteHeader(http.StatusNotModified)
|
||||
return
|
||||
}
|
||||
}
|
||||
w.WriteHeader(http.StatusOK)
|
||||
if r.Method != http.MethodHead {
|
||||
_, _ = w.Write(manifest.body)
|
||||
}
|
||||
}
|
||||
|
||||
func containerManifestAccept(r *http.Request) string {
|
||||
if accept := r.Header.Get("Accept"); accept != "" {
|
||||
return accept
|
||||
}
|
||||
return strings.Join([]string{
|
||||
"application/vnd.oci.image.manifest.v1+json",
|
||||
"application/vnd.oci.image.index.v1+json",
|
||||
"application/vnd.docker.distribution.manifest.v2+json",
|
||||
"application/vnd.docker.distribution.manifest.list.v2+json",
|
||||
"application/vnd.docker.distribution.manifest.v1+prettyjws",
|
||||
}, ", ")
|
||||
}
|
||||
|
||||
func normalizeContainerManifestAccept(accept string) string {
|
||||
mediaTypes := make(map[string]struct{})
|
||||
for _, value := range strings.Split(accept, ",") {
|
||||
value = strings.TrimSpace(value)
|
||||
if value == "" {
|
||||
continue
|
||||
}
|
||||
mediaType, params, err := mime.ParseMediaType(value)
|
||||
if err != nil {
|
||||
mediaTypes[strings.ToLower(value)] = struct{}{}
|
||||
continue
|
||||
}
|
||||
paramKeys := make([]string, 0, len(params))
|
||||
for key := range params {
|
||||
paramKeys = append(paramKeys, key)
|
||||
}
|
||||
sort.Strings(paramKeys)
|
||||
canonical := strings.ToLower(mediaType)
|
||||
for _, key := range paramKeys {
|
||||
value := params[key]
|
||||
if strings.EqualFold(key, "q") {
|
||||
if quality, err := strconv.ParseFloat(value, 64); err == nil {
|
||||
if quality == 1 {
|
||||
continue
|
||||
}
|
||||
value = strconv.FormatFloat(quality, 'g', -1, 64)
|
||||
}
|
||||
}
|
||||
canonical += ";" + strings.ToLower(key) + "=" + value
|
||||
}
|
||||
mediaTypes[canonical] = struct{}{}
|
||||
}
|
||||
canonicalMediaTypes := make([]string, 0, len(mediaTypes))
|
||||
for mediaType := range mediaTypes {
|
||||
canonicalMediaTypes = append(canonicalMediaTypes, mediaType)
|
||||
}
|
||||
sort.Strings(canonicalMediaTypes)
|
||||
return strings.Join(canonicalMediaTypes, ",")
|
||||
}
|
||||
|
||||
func containerManifestAccepts(accept, contentType string) bool {
|
||||
contentType, contentParams, err := mime.ParseMediaType(contentType)
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
contentType = strings.ToLower(contentType)
|
||||
contentMajor, contentMinor, found := strings.Cut(contentType, "/")
|
||||
if !found {
|
||||
return false
|
||||
}
|
||||
|
||||
bestMediaTypeSpecificity := -1
|
||||
bestParameterSpecificity := 0
|
||||
bestQuality := 0.0
|
||||
for _, value := range strings.Split(accept, ",") {
|
||||
mediaType, params, err := mime.ParseMediaType(strings.TrimSpace(value))
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
mediaType = strings.ToLower(mediaType)
|
||||
major, minor, found := strings.Cut(mediaType, "/")
|
||||
if found && containerAcceptRangeMatches(major, minor, params, contentMajor, contentMinor, contentParams) {
|
||||
mediaTypeSpecificity, parameterSpecificity := containerAcceptSpecificity(major, minor, params)
|
||||
if mediaTypeSpecificity > bestMediaTypeSpecificity ||
|
||||
(mediaTypeSpecificity == bestMediaTypeSpecificity && parameterSpecificity > bestParameterSpecificity) {
|
||||
bestMediaTypeSpecificity = mediaTypeSpecificity
|
||||
bestParameterSpecificity = parameterSpecificity
|
||||
bestQuality = containerAcceptQuality(params)
|
||||
}
|
||||
}
|
||||
}
|
||||
return bestQuality > 0
|
||||
}
|
||||
|
||||
func containerManifestCacheCompatible(accept string, manifest *cachedContainerManifest) bool {
|
||||
return manifest.contentType == "" || containerManifestAccepts(accept, manifest.contentType)
|
||||
}
|
||||
|
||||
func containerAcceptRangeMatches(major, minor string, params map[string]string, contentMajor, contentMinor string, contentParams map[string]string) bool {
|
||||
if (major != "*" && major != contentMajor) || (minor != "*" && minor != contentMinor) {
|
||||
return false
|
||||
}
|
||||
for key, value := range params {
|
||||
if strings.EqualFold(key, "q") {
|
||||
continue
|
||||
}
|
||||
if contentParams[key] != value {
|
||||
return false
|
||||
}
|
||||
}
|
||||
return true
|
||||
}
|
||||
|
||||
func containerAcceptSpecificity(major, minor string, params map[string]string) (int, int) {
|
||||
parameterSpecificity := 0
|
||||
for key := range params {
|
||||
if !strings.EqualFold(key, "q") {
|
||||
parameterSpecificity++
|
||||
}
|
||||
}
|
||||
|
||||
switch {
|
||||
case major == "*" && minor == "*":
|
||||
return containerAcceptWildcardSpecificity, parameterSpecificity
|
||||
case major == "*" || minor == "*":
|
||||
return containerAcceptTypeWildcardSpecificity, parameterSpecificity
|
||||
default:
|
||||
return containerAcceptExactSpecificity, parameterSpecificity
|
||||
}
|
||||
}
|
||||
|
||||
func containerAcceptQuality(params map[string]string) float64 {
|
||||
value, ok := params["q"]
|
||||
if !ok {
|
||||
return 1
|
||||
}
|
||||
quality, err := strconv.ParseFloat(value, 64)
|
||||
if err != nil || quality < 0 || quality > 1 {
|
||||
return 0
|
||||
}
|
||||
return quality
|
||||
}
|
||||
|
||||
func copyContainerManifestHeaders(destination, source http.Header) {
|
||||
for _, header := range []string{headerContentType, headerContentLength, "Docker-Content-Digest", headerETag, headerLastModified, "WWW-Authenticate"} {
|
||||
if value := source.Get(header); value != "" {
|
||||
destination.Set(header, value)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func parseHTTPTime(value string) time.Time {
|
||||
parsed, _ := http.ParseTime(value)
|
||||
return parsed
|
||||
}
|
||||
|
||||
func shouldServeStaleManifest(status int) bool {
|
||||
return status == http.StatusTooManyRequests || status >= http.StatusInternalServerError
|
||||
}
|
||||
|
||||
func sha256Digest(body []byte) string {
|
||||
digest := sha256.Sum256(body)
|
||||
return "sha256:" + hex.EncodeToString(digest[:])
|
||||
}
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"database/sql"
|
||||
"fmt"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/proxy/internal/database"
|
||||
)
|
||||
|
||||
func (h *ContainerHandler) storeContainerMetadata(ctx context.Context, ecosystem, cacheKey string, body []byte, etag, link, contentType, contentDigest string, lastModified, fetchedAt time.Time) (int64, error) {
|
||||
if h.proxy.DB == nil || h.proxy.Storage == nil {
|
||||
return int64(len(body)), nil
|
||||
}
|
||||
|
||||
storagePath := metadataStoragePath(ecosystem, cacheKey)
|
||||
size, _, err := h.proxy.Storage.Store(ctx, storagePath, bytes.NewReader(body))
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("storing metadata: %w", err)
|
||||
}
|
||||
err = h.proxy.DB.UpsertMetadataCache(&database.MetadataCacheEntry{
|
||||
Ecosystem: ecosystem,
|
||||
Name: cacheKey,
|
||||
StoragePath: storagePath,
|
||||
ETag: sql.NullString{String: etag, Valid: etag != ""},
|
||||
Link: sql.NullString{String: link, Valid: link != ""},
|
||||
ContentType: sql.NullString{String: contentType, Valid: contentType != ""},
|
||||
ContentDigest: sql.NullString{String: contentDigest, Valid: contentDigest != ""},
|
||||
Size: sql.NullInt64{Int64: size, Valid: true},
|
||||
LastModified: sql.NullTime{Time: lastModified, Valid: !lastModified.IsZero()},
|
||||
FetchedAt: sql.NullTime{Time: fetchedAt, Valid: !fetchedAt.IsZero()},
|
||||
})
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
return size, nil
|
||||
}
|
||||
|
|
@ -1,229 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/sha256"
|
||||
"encoding/hex"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"regexp"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
const containerTagsCacheEcosystem = "oci-tags"
|
||||
|
||||
var containerLinkTargetPattern = regexp.MustCompile(`<([^>]*)>`)
|
||||
|
||||
type cachedContainerTags struct {
|
||||
body []byte
|
||||
contentType string
|
||||
etag string
|
||||
link string
|
||||
size int64
|
||||
fetchedAt time.Time
|
||||
}
|
||||
|
||||
func (h *ContainerHandler) serveTagsList(w http.ResponseWriter, r *http.Request, registryURL, name string) {
|
||||
cacheKey := h.containerTagsCacheKey(registryURL, name, r.URL.Query())
|
||||
cached, err := h.loadContainerTags(r.Context(), cacheKey)
|
||||
if err != nil {
|
||||
h.proxy.Logger.Warn("failed to read cached container tag list", "error", err)
|
||||
cached = nil
|
||||
}
|
||||
if cached != nil && h.containerTagsFresh(cached) {
|
||||
writeContainerTags(w, cached, false)
|
||||
return
|
||||
}
|
||||
|
||||
upstreamURL := fmt.Sprintf("%s/v2/%s/tags/list", registryURL, name)
|
||||
if query := r.URL.Query().Encode(); query != "" {
|
||||
upstreamURL += "?" + query
|
||||
}
|
||||
req, err := http.NewRequestWithContext(r.Context(), http.MethodGet, upstreamURL, nil)
|
||||
if err != nil {
|
||||
h.containerError(w, http.StatusInternalServerError, "INTERNAL_ERROR", "failed to create request")
|
||||
return
|
||||
}
|
||||
req.Header.Set("Accept", "application/json")
|
||||
if cached != nil && cached.etag != "" {
|
||||
req.Header.Set("If-None-Match", cached.etag)
|
||||
}
|
||||
|
||||
resp, err := h.proxy.HTTPClient.Do(req)
|
||||
if err != nil {
|
||||
h.serveStaleTagsOrError(w, cached, err)
|
||||
return
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode == http.StatusNotModified && cached != nil {
|
||||
cached.fetchedAt = time.Now()
|
||||
if err := h.storeContainerTags(r.Context(), cacheKey, cached); err != nil {
|
||||
h.proxy.Logger.Warn("failed to refresh cached container tag list", "error", err)
|
||||
}
|
||||
writeContainerTags(w, cached, false)
|
||||
return
|
||||
}
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
if cached != nil && shouldServeStaleManifest(resp.StatusCode) {
|
||||
writeContainerTags(w, cached, true)
|
||||
return
|
||||
}
|
||||
copyContainerTagsHeaders(w.Header(), resp.Header)
|
||||
w.WriteHeader(resp.StatusCode)
|
||||
_, _ = io.Copy(w, resp.Body)
|
||||
return
|
||||
}
|
||||
|
||||
body, err := h.proxy.ReadMetadata(resp.Body)
|
||||
if err != nil {
|
||||
h.serveStaleTagsOrError(w, cached, fmt.Errorf("reading tag list: %w", err))
|
||||
return
|
||||
}
|
||||
tags := &cachedContainerTags{
|
||||
body: body,
|
||||
contentType: resp.Header.Get(headerContentType),
|
||||
etag: resp.Header.Get(headerETag),
|
||||
link: h.rewriteContainerTagsLink(strings.Join(resp.Header.Values("Link"), ", "), registryURL, r.URL.Path),
|
||||
size: int64(len(body)),
|
||||
fetchedAt: time.Now(),
|
||||
}
|
||||
if tags.contentType == "" {
|
||||
tags.contentType = contentTypeJSON
|
||||
}
|
||||
if err := h.storeContainerTags(r.Context(), cacheKey, tags); err != nil {
|
||||
h.proxy.Logger.Warn("failed to cache container tag list", "error", err)
|
||||
}
|
||||
writeContainerTags(w, tags, false)
|
||||
}
|
||||
|
||||
func (h *ContainerHandler) serveStaleTagsOrError(w http.ResponseWriter, cached *cachedContainerTags, err error) {
|
||||
if cached != nil {
|
||||
h.proxy.Logger.Warn("upstream tag list fetch failed, serving stale cache", "error", err)
|
||||
writeContainerTags(w, cached, true)
|
||||
return
|
||||
}
|
||||
h.proxy.Logger.Error("failed to fetch container tag list", "error", err)
|
||||
h.containerError(w, http.StatusBadGateway, "INTERNAL_ERROR", "failed to fetch from upstream")
|
||||
}
|
||||
|
||||
func (h *ContainerHandler) containerTagsCacheKey(registryURL, name string, query url.Values) string {
|
||||
identity := registryURL + "\x00" + name + "\x00" + query.Encode()
|
||||
sum := sha256.Sum256([]byte(identity))
|
||||
return hex.EncodeToString(sum[:])
|
||||
}
|
||||
|
||||
func (h *ContainerHandler) containerTagsFresh(tags *cachedContainerTags) bool {
|
||||
return h.proxy.MetadataTTL > 0 && !tags.fetchedAt.IsZero() && time.Since(tags.fetchedAt) < h.proxy.MetadataTTL
|
||||
}
|
||||
|
||||
func (h *ContainerHandler) loadContainerTags(ctx context.Context, cacheKey string) (*cachedContainerTags, error) {
|
||||
if h.proxy.DB == nil || h.proxy.Storage == nil {
|
||||
return nil, nil
|
||||
}
|
||||
entry, err := h.proxy.DB.GetMetadataCache(containerTagsCacheEcosystem, cacheKey)
|
||||
if err != nil || entry == nil {
|
||||
return nil, err
|
||||
}
|
||||
reader, err := h.proxy.Storage.Open(ctx, entry.StoragePath)
|
||||
if err != nil {
|
||||
return nil, nil
|
||||
}
|
||||
defer func() { _ = reader.Close() }()
|
||||
body, err := h.proxy.ReadMetadata(reader)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
tags := &cachedContainerTags{body: body, contentType: contentTypeJSON, size: int64(len(body))}
|
||||
if entry.ContentType.Valid {
|
||||
tags.contentType = entry.ContentType.String
|
||||
}
|
||||
if entry.ETag.Valid {
|
||||
tags.etag = entry.ETag.String
|
||||
}
|
||||
if entry.Link.Valid {
|
||||
tags.link = entry.Link.String
|
||||
}
|
||||
if entry.Size.Valid {
|
||||
tags.size = entry.Size.Int64
|
||||
}
|
||||
if entry.FetchedAt.Valid {
|
||||
tags.fetchedAt = entry.FetchedAt.Time
|
||||
}
|
||||
return tags, nil
|
||||
}
|
||||
|
||||
func (h *ContainerHandler) storeContainerTags(ctx context.Context, cacheKey string, tags *cachedContainerTags) error {
|
||||
size, err := h.storeContainerMetadata(ctx, containerTagsCacheEcosystem, cacheKey, tags.body,
|
||||
tags.etag, tags.link, tags.contentType, "", time.Time{}, tags.fetchedAt)
|
||||
if err != nil {
|
||||
return fmt.Errorf("storing tag list: %w", err)
|
||||
}
|
||||
tags.size = size
|
||||
return nil
|
||||
}
|
||||
|
||||
func writeContainerTags(w http.ResponseWriter, tags *cachedContainerTags, stale bool) {
|
||||
w.Header().Set(headerContentType, tags.contentType)
|
||||
w.Header().Set(headerContentLength, strconv.FormatInt(tags.size, 10))
|
||||
if tags.etag != "" {
|
||||
w.Header().Set(headerETag, tags.etag)
|
||||
}
|
||||
if tags.link != "" {
|
||||
w.Header().Set("Link", tags.link)
|
||||
}
|
||||
if stale {
|
||||
w.Header().Set("Warning", containerStaleWarning)
|
||||
}
|
||||
w.WriteHeader(http.StatusOK)
|
||||
_, _ = w.Write(tags.body)
|
||||
}
|
||||
|
||||
func copyContainerTagsHeaders(destination, source http.Header) {
|
||||
for _, header := range []string{headerContentType, headerContentLength, headerETag, "Link", "WWW-Authenticate"} {
|
||||
if value := source.Get(header); value != "" {
|
||||
destination.Set(header, value)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (h *ContainerHandler) rewriteContainerTagsLink(link, registryURL, requestPath string) string {
|
||||
if link == "" {
|
||||
return ""
|
||||
}
|
||||
upstreamURL, err := url.Parse(registryURL)
|
||||
if err != nil {
|
||||
return link
|
||||
}
|
||||
proxyURL, err := url.Parse(h.proxyURL)
|
||||
if err != nil {
|
||||
return link
|
||||
}
|
||||
|
||||
return containerLinkTargetPattern.ReplaceAllStringFunc(link, func(target string) string {
|
||||
linkURL, err := url.Parse(target[1 : len(target)-1])
|
||||
if err != nil {
|
||||
return target
|
||||
}
|
||||
if linkURL.IsAbs() {
|
||||
if linkURL.Scheme != upstreamURL.Scheme || linkURL.Host != upstreamURL.Host {
|
||||
return target
|
||||
}
|
||||
} else if linkURL.Host != "" || (linkURL.Path != "" && !strings.HasPrefix(linkURL.Path, "/v2/")) {
|
||||
return target
|
||||
}
|
||||
// Relative registry API links resolve against the current tag-list
|
||||
// endpoint. Rebuild them below so named-registry selectors are kept.
|
||||
linkURL.Scheme = proxyURL.Scheme
|
||||
linkURL.Host = proxyURL.Host
|
||||
linkURL.User = proxyURL.User
|
||||
linkURL.Path = strings.TrimSuffix(proxyURL.Path, "/") + "/v2" + requestPath
|
||||
linkURL.RawPath = ""
|
||||
return "<" + linkURL.String() + ">"
|
||||
})
|
||||
}
|
||||
File diff suppressed because it is too large
Load diff
|
|
@ -25,13 +25,6 @@ func NewCRANHandler(proxy *Proxy, proxyURL string) *CRANHandler {
|
|||
}
|
||||
}
|
||||
|
||||
// NewCRANHandlerWithUpstream creates a CRAN handler with a custom upstream.
|
||||
func NewCRANHandlerWithUpstream(proxy *Proxy, proxyURL, upstreamURL string) *CRANHandler {
|
||||
h := NewCRANHandler(proxy, proxyURL)
|
||||
h.upstreamURL = configuredUpstreamURL(upstreamURL, cranUpstream)
|
||||
return h
|
||||
}
|
||||
|
||||
// Routes returns the HTTP handler for CRAN requests.
|
||||
func (h *CRANHandler) Routes() http.Handler {
|
||||
mux := http.NewServeMux()
|
||||
|
|
@ -79,7 +72,8 @@ func (h *CRANHandler) handleSourceDownload(w http.ResponseWriter, r *http.Reques
|
|||
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURL(r.Context(), "cran", name, version, filename, upstreamURL)
|
||||
if err != nil {
|
||||
h.proxy.serveArtifactError(w, err, "failed to fetch package")
|
||||
h.proxy.Logger.Error("failed to get artifact", "error", err)
|
||||
http.Error(w, "failed to fetch package", http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
|
||||
|
|
@ -113,7 +107,8 @@ func (h *CRANHandler) handleBinaryDownload(w http.ResponseWriter, r *http.Reques
|
|||
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURL(r.Context(), "cran", name, storageVersion, filename, upstreamURL)
|
||||
if err != nil {
|
||||
h.proxy.serveArtifactError(w, err, "failed to fetch package")
|
||||
h.proxy.Logger.Error("failed to get artifact", "error", err)
|
||||
http.Error(w, "failed to fetch package", http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -21,13 +21,10 @@ type DebianHandler struct {
|
|||
}
|
||||
|
||||
// NewDebianHandler creates a new Debian/APT protocol handler.
|
||||
func NewDebianHandler(proxy *Proxy, proxyURL string, upstreamURL string) *DebianHandler {
|
||||
if upstreamURL == "" {
|
||||
upstreamURL = debianUpstream
|
||||
}
|
||||
func NewDebianHandler(proxy *Proxy, proxyURL string) *DebianHandler {
|
||||
return &DebianHandler{
|
||||
proxy: proxy,
|
||||
upstreamURL: strings.TrimSuffix(upstreamURL, "/"),
|
||||
upstreamURL: debianUpstream,
|
||||
proxyURL: strings.TrimSuffix(proxyURL, "/"),
|
||||
}
|
||||
}
|
||||
|
|
@ -84,11 +81,12 @@ func (h *DebianHandler) handlePackageDownload(w http.ResponseWriter, r *http.Req
|
|||
result, err := h.proxy.GetOrFetchArtifactFromURL(
|
||||
r.Context(), "deb", name, version, filename, downloadURL)
|
||||
if err != nil {
|
||||
h.proxy.serveArtifactError(w, err, "failed to fetch package")
|
||||
h.proxy.Logger.Error("failed to get debian package", "error", err)
|
||||
http.Error(w, "failed to fetch package", http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set(headerContentType, "application/vnd.debian.binary-package")
|
||||
w.Header().Set("Content-Type", "application/vnd.debian.binary-package")
|
||||
ServeArtifact(w, result)
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -12,17 +12,12 @@ func TestDebianHandler_parsePoolPath(t *testing.T) {
|
|||
{"pool/main/libn/libncurses/libncurses6_6.2-1_amd64.deb", "libncurses6", "6.2-1", "amd64"},
|
||||
{"pool/contrib/v/virtualbox/virtualbox_6.1.38-1_amd64.deb", "virtualbox", "6.1.38-1", "amd64"},
|
||||
{"pool/main/g/git/git_2.39.2-1_arm64.deb", "git", "2.39.2-1", "arm64"},
|
||||
{
|
||||
"pool/universe/n/nmap/nmap_7.91+dfsg1+really7.80+dfsg1-2ubuntu0.1_amd64.deb",
|
||||
"nmap", "7.91+dfsg1+really7.80+dfsg1-2ubuntu0.1", "amd64",
|
||||
},
|
||||
{"pool/main/o/openssl/openssl_3.0.2-0ubuntu1.15~build1_amd64.deb", "openssl", "3.0.2-0ubuntu1.15~build1", "amd64"},
|
||||
{"invalid/path", "", "", ""},
|
||||
{"pool/main/n/nginx/nginx.deb", "", "", ""},
|
||||
})
|
||||
}
|
||||
|
||||
func TestDebianHandler_Routes(t *testing.T) {
|
||||
h := NewDebianHandler(nil, "http://localhost:8080", "")
|
||||
h := NewDebianHandler(nil, "http://localhost:8080")
|
||||
assertRoutesBasics(t, h.Routes(), "/dists/stable/Release", "/pool/../../../etc/passwd")
|
||||
}
|
||||
|
|
|
|||
|
|
@ -11,7 +11,6 @@ import (
|
|||
"time"
|
||||
|
||||
"github.com/git-pkgs/proxy/internal/database"
|
||||
"github.com/git-pkgs/proxy/internal/metrics"
|
||||
"github.com/git-pkgs/proxy/internal/storage"
|
||||
"github.com/git-pkgs/purl"
|
||||
"github.com/git-pkgs/registries/fetch"
|
||||
|
|
@ -44,14 +43,13 @@ func seedPackageWithPURL(t *testing.T, db *database.DB, store *mockStorage, ecos
|
|||
|
||||
storagePath := storage.ArtifactPath(ecosystem, "", name, version, filename)
|
||||
store.files[storagePath] = []byte(content)
|
||||
sharedArtifact := testArtifact(content, versionPURL, filename, "application/octet-stream")
|
||||
|
||||
art := &database.Artifact{
|
||||
VersionPURL: versionPURL,
|
||||
Filename: filename,
|
||||
UpstreamURL: "https://example.com/" + filename,
|
||||
StoragePath: sql.NullString{String: storagePath, Valid: true},
|
||||
ContentHash: sql.NullString{String: sharedArtifact.Digest.Encoded(), Valid: true},
|
||||
ContentHash: sql.NullString{String: "abc123", Valid: true},
|
||||
Size: sql.NullInt64{Int64: int64(len(content)), Valid: true},
|
||||
ContentType: sql.NullString{String: "application/octet-stream", Valid: true},
|
||||
FetchedAt: sql.NullTime{Time: time.Now(), Valid: true},
|
||||
|
|
@ -205,19 +203,16 @@ func TestGemHandler_UpstreamProxy(t *testing.T) {
|
|||
|
||||
func TestGemHandler_CacheMiss(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
fetchesBefore := histogramSampleCount(t, metrics.UpstreamFetchDuration.WithLabelValues("gem"))
|
||||
fetcher.artifact = &fetch.Artifact{
|
||||
Body: io.NopCloser(strings.NewReader("fetched gem")),
|
||||
ContentType: "application/octet-stream",
|
||||
}
|
||||
|
||||
upstreamURL := "https://packages.example.com/gem"
|
||||
h := NewGemHandlerWithUpstream(proxy, "http://localhost", upstreamURL)
|
||||
h := NewGemHandler(proxy, "http://localhost")
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
path := "/gems/sinatra-3.0.0.gem"
|
||||
resp, err := http.Get(srv.URL + path)
|
||||
resp, err := http.Get(srv.URL + "/gems/sinatra-3.0.0.gem")
|
||||
if err != nil {
|
||||
t.Fatalf("request failed: %v", err)
|
||||
}
|
||||
|
|
@ -226,12 +221,6 @@ func TestGemHandler_CacheMiss(t *testing.T) {
|
|||
if !fetcher.fetchCalled {
|
||||
t.Error("expected fetcher to be called on cache miss")
|
||||
}
|
||||
if want := upstreamURL + path; fetcher.fetchedURL != want {
|
||||
t.Errorf("upstream URL = %q, want %q", fetcher.fetchedURL, want)
|
||||
}
|
||||
if diff := histogramSampleCount(t, metrics.UpstreamFetchDuration.WithLabelValues("gem")) - fetchesBefore; diff != 1 {
|
||||
t.Errorf("upstream fetch observations delta = %d, want 1", diff)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGoHandler_DownloadCacheHit(t *testing.T) {
|
||||
|
|
@ -353,13 +342,11 @@ func TestGoHandler_CacheMiss(t *testing.T) {
|
|||
ContentType: "application/zip",
|
||||
}
|
||||
|
||||
upstreamURL := "https://packages.example.com/go"
|
||||
h := NewGoHandlerWithUpstream(proxy, "http://localhost", upstreamURL)
|
||||
h := NewGoHandler(proxy, "http://localhost")
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
path := "/example.com/mod/@v/v1.0.0.zip"
|
||||
resp, err := http.Get(srv.URL + path)
|
||||
resp, err := http.Get(srv.URL + "/example.com/mod/@v/v1.0.0.zip")
|
||||
if err != nil {
|
||||
t.Fatalf("request failed: %v", err)
|
||||
}
|
||||
|
|
@ -368,9 +355,6 @@ func TestGoHandler_CacheMiss(t *testing.T) {
|
|||
if !fetcher.fetchCalled {
|
||||
t.Error("expected fetcher to be called on cache miss")
|
||||
}
|
||||
if want := upstreamURL + path; fetcher.fetchedURL != want {
|
||||
t.Errorf("upstream URL = %q, want %q", fetcher.fetchedURL, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHexHandler_DownloadCacheHit(t *testing.T) {
|
||||
|
|
@ -439,13 +423,11 @@ func TestHexHandler_CacheMiss(t *testing.T) {
|
|||
ContentType: "application/x-tar",
|
||||
}
|
||||
|
||||
upstreamURL := "https://packages.example.com/hex"
|
||||
h := NewHexHandlerWithUpstreams(proxy, "http://localhost", upstreamURL, "https://packages.example.com/hex-api")
|
||||
h := NewHexHandler(proxy, "http://localhost")
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
path := "/tarballs/plug-1.15.0.tar"
|
||||
resp, err := http.Get(srv.URL + path)
|
||||
resp, err := http.Get(srv.URL + "/tarballs/plug-1.15.0.tar")
|
||||
if err != nil {
|
||||
t.Fatalf("request failed: %v", err)
|
||||
}
|
||||
|
|
@ -454,36 +436,6 @@ func TestHexHandler_CacheMiss(t *testing.T) {
|
|||
if !fetcher.fetchCalled {
|
||||
t.Error("expected fetcher to be called on cache miss")
|
||||
}
|
||||
if want := upstreamURL + path; fetcher.fetchedURL != want {
|
||||
t.Errorf("upstream URL = %q, want %q", fetcher.fetchedURL, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestPubHandler_CacheMiss(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
fetcher.artifact = &fetch.Artifact{
|
||||
Body: io.NopCloser(strings.NewReader("fetched pub package")),
|
||||
ContentType: "application/gzip",
|
||||
}
|
||||
|
||||
upstreamURL := "https://packages.example.com/pub"
|
||||
h := NewPubHandlerWithUpstream(proxy, "http://localhost", upstreamURL)
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
path := "/packages/flutter_bloc/versions/8.1.6.tar.gz"
|
||||
resp, err := http.Get(srv.URL + path)
|
||||
if err != nil {
|
||||
t.Fatalf("request failed: %v", err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if !fetcher.fetchCalled {
|
||||
t.Error("expected fetcher to be called on cache miss")
|
||||
}
|
||||
if want := upstreamURL + path; fetcher.fetchedURL != want {
|
||||
t.Errorf("upstream URL = %q, want %q", fetcher.fetchedURL, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCondaHandler_DownloadCacheHit(t *testing.T) {
|
||||
|
|
@ -721,7 +673,7 @@ func TestMavenHandler_DownloadCacheHit(t *testing.T) {
|
|||
proxy, db, store, _ := setupTestProxy(t)
|
||||
seedPackageWithPURL(t, db, store, "maven", "com.google.guava:guava", "32.1.3-jre", "guava-32.1.3-jre.jar", "jar content")
|
||||
|
||||
h := NewMavenHandler(proxy, "http://localhost", "", "")
|
||||
h := NewMavenHandler(proxy, "http://localhost")
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
|
|
@ -778,7 +730,7 @@ func TestMavenHandler_MetadataProxied(t *testing.T) {
|
|||
|
||||
func TestMavenHandler_EmptyPathNotFound(t *testing.T) {
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
h := NewMavenHandler(proxy, "http://localhost", "", "")
|
||||
h := NewMavenHandler(proxy, "http://localhost")
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
|
|
@ -796,7 +748,7 @@ func TestMavenHandler_EmptyPathNotFound(t *testing.T) {
|
|||
func TestMavenHandler_ArtifactExtensions(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
|
||||
extensions := []string{".jar", ".war", ".ear", ".pom", ".aar", ".klib", ".module"}
|
||||
extensions := []string{".jar", ".war", ".ear", ".pom", ".aar", ".klib"}
|
||||
for _, ext := range extensions {
|
||||
fetcher.artifact = &fetch.Artifact{
|
||||
Body: io.NopCloser(strings.NewReader("artifact")),
|
||||
|
|
@ -804,7 +756,7 @@ func TestMavenHandler_ArtifactExtensions(t *testing.T) {
|
|||
}
|
||||
fetcher.fetchCalled = false
|
||||
|
||||
h := NewMavenHandler(proxy, "http://localhost", "", "")
|
||||
h := NewMavenHandler(proxy, "http://localhost")
|
||||
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
t.Errorf("should not proxy artifact file %s to upstream", ext)
|
||||
|
|
@ -837,7 +789,7 @@ func TestMavenHandler_CacheMiss(t *testing.T) {
|
|||
ContentType: "application/java-archive",
|
||||
}
|
||||
|
||||
h := NewMavenHandler(proxy, "http://localhost", "", "")
|
||||
h := NewMavenHandler(proxy, "http://localhost")
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
|
|
@ -857,274 +809,6 @@ func TestMavenHandler_CacheMiss(t *testing.T) {
|
|||
}
|
||||
}
|
||||
|
||||
func TestMavenHandler_GradlePluginMarkerFallbackAndCache(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
markerPath string
|
||||
}{
|
||||
{
|
||||
name: "Spotless",
|
||||
markerPath: "/com/diffplug/spotless/com.diffplug.spotless.gradle.plugin/8.4.0/com.diffplug.spotless.gradle.plugin-8.4.0.pom",
|
||||
},
|
||||
{
|
||||
name: "BenManes",
|
||||
markerPath: "/com/github/ben-manes/versions/com.github.ben-manes.versions.gradle.plugin/0.54.0/com.github.ben-manes.versions.gradle.plugin-0.54.0.pom",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
|
||||
primaryUpstream := "https://repo1.maven.org/maven2"
|
||||
pluginPortalUpstream := "https://plugins.gradle.org/m2"
|
||||
primaryURL := primaryUpstream + tt.markerPath
|
||||
|
||||
fetcher.fetchErrByURL = map[string]error{
|
||||
primaryURL: ErrUpstreamNotFound,
|
||||
}
|
||||
fetcher.artifact = &fetch.Artifact{
|
||||
Body: io.NopCloser(strings.NewReader("<project/>")),
|
||||
ContentType: "application/xml",
|
||||
}
|
||||
|
||||
h := NewMavenHandler(proxy, "http://localhost", primaryUpstream, pluginPortalUpstream)
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
resp, err := http.Get(srv.URL + tt.markerPath)
|
||||
if err != nil {
|
||||
t.Fatalf("request failed: %v", err)
|
||||
}
|
||||
body, _ := io.ReadAll(resp.Body)
|
||||
_ = resp.Body.Close()
|
||||
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
t.Fatalf("status = %d, want %d", resp.StatusCode, http.StatusOK)
|
||||
}
|
||||
if string(body) != "<project/>" {
|
||||
t.Fatalf("body = %q, want %q", body, "<project/>")
|
||||
}
|
||||
|
||||
wantFallbackURL := pluginPortalUpstream + tt.markerPath
|
||||
if fetcher.fetchedURL != wantFallbackURL {
|
||||
t.Fatalf("fallback URL = %q, want %q", fetcher.fetchedURL, wantFallbackURL)
|
||||
}
|
||||
|
||||
fetcher.fetchCalled = false
|
||||
resp, err = http.Get(srv.URL + tt.markerPath)
|
||||
if err != nil {
|
||||
t.Fatalf("second request failed: %v", err)
|
||||
}
|
||||
_ = resp.Body.Close()
|
||||
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
t.Fatalf("second status = %d, want %d", resp.StatusCode, http.StatusOK)
|
||||
}
|
||||
if fetcher.fetchCalled {
|
||||
t.Fatal("expected plugin marker POM to be served from cache on second request")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestMavenHandler_GradlePluginMarkerMetadataFallback(t *testing.T) {
|
||||
paths := map[string]string{
|
||||
"/com/diffplug/spotless/com.diffplug.spotless.gradle.plugin/8.4.0/com.diffplug.spotless.gradle.plugin-8.4.0.pom.sha1": "sha1",
|
||||
"/com/diffplug/spotless/com.diffplug.spotless.gradle.plugin/8.4.0/com.diffplug.spotless.gradle.plugin-8.4.0.pom.sha256": "sha256",
|
||||
"/com/diffplug/spotless/com.diffplug.spotless.gradle.plugin/8.4.0/com.diffplug.spotless.gradle.plugin-8.4.0.pom.md5": "md5",
|
||||
"/com/diffplug/spotless/com.diffplug.spotless.gradle.plugin/maven-metadata.xml": "<metadata/>",
|
||||
}
|
||||
|
||||
primaryHits := map[string]int{}
|
||||
pluginHits := map[string]int{}
|
||||
|
||||
primary := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
primaryHits[r.URL.Path]++
|
||||
if _, ok := paths[r.URL.Path]; ok {
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
t.Fatalf("unexpected path to primary upstream: %s", r.URL.Path)
|
||||
}))
|
||||
defer primary.Close()
|
||||
|
||||
pluginPortal := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
pluginHits[r.URL.Path]++
|
||||
body, ok := paths[r.URL.Path]
|
||||
if !ok {
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
_, _ = io.WriteString(w, body)
|
||||
}))
|
||||
defer pluginPortal.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.HTTPClient = primary.Client()
|
||||
|
||||
h := NewMavenHandler(proxy, "http://localhost", primary.URL, pluginPortal.URL)
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
for reqPath, wantBody := range paths {
|
||||
resp, err := http.Get(srv.URL + reqPath)
|
||||
if err != nil {
|
||||
t.Fatalf("GET %s failed: %v", reqPath, err)
|
||||
}
|
||||
body, _ := io.ReadAll(resp.Body)
|
||||
_ = resp.Body.Close()
|
||||
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
t.Fatalf("GET %s: status = %d, want %d", reqPath, resp.StatusCode, http.StatusOK)
|
||||
}
|
||||
if string(body) != wantBody {
|
||||
t.Fatalf("GET %s: body = %q, want %q", reqPath, body, wantBody)
|
||||
}
|
||||
|
||||
if primaryHits[reqPath] == 0 {
|
||||
t.Fatalf("GET %s did not hit primary upstream", reqPath)
|
||||
}
|
||||
if pluginHits[reqPath] == 0 {
|
||||
t.Fatalf("GET %s did not hit plugin portal fallback", reqPath)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestMavenHandler_GradlePluginImplementationMetadataFallback(t *testing.T) {
|
||||
paths := map[string]string{
|
||||
"/com/diffplug/spotless/spotless-plugin-gradle/8.4.0/spotless-plugin-gradle-8.4.0.jar.sha1": "impl-sha1",
|
||||
"/com/diffplug/spotless/spotless-plugin-gradle/8.4.0/spotless-plugin-gradle-8.4.0.jar.sha256": "impl-sha256",
|
||||
}
|
||||
|
||||
primaryHits := map[string]int{}
|
||||
pluginHits := map[string]int{}
|
||||
|
||||
primary := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
primaryHits[r.URL.Path]++
|
||||
if _, ok := paths[r.URL.Path]; ok {
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
t.Fatalf("unexpected path to primary upstream: %s", r.URL.Path)
|
||||
}))
|
||||
defer primary.Close()
|
||||
|
||||
pluginPortal := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
pluginHits[r.URL.Path]++
|
||||
body, ok := paths[r.URL.Path]
|
||||
if !ok {
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
_, _ = io.WriteString(w, body)
|
||||
}))
|
||||
defer pluginPortal.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.HTTPClient = primary.Client()
|
||||
|
||||
h := NewMavenHandler(proxy, "http://localhost", primary.URL, pluginPortal.URL)
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
for reqPath, wantBody := range paths {
|
||||
resp, err := http.Get(srv.URL + reqPath)
|
||||
if err != nil {
|
||||
t.Fatalf("GET %s failed: %v", reqPath, err)
|
||||
}
|
||||
body, _ := io.ReadAll(resp.Body)
|
||||
_ = resp.Body.Close()
|
||||
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
t.Fatalf("GET %s: status = %d, want %d", reqPath, resp.StatusCode, http.StatusOK)
|
||||
}
|
||||
if string(body) != wantBody {
|
||||
t.Fatalf("GET %s: body = %q, want %q", reqPath, body, wantBody)
|
||||
}
|
||||
|
||||
if primaryHits[reqPath] == 0 {
|
||||
t.Fatalf("GET %s did not hit primary upstream", reqPath)
|
||||
}
|
||||
if pluginHits[reqPath] == 0 {
|
||||
t.Fatalf("GET %s did not hit plugin portal fallback", reqPath)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestMavenHandler_GradlePluginImplementation_FallbackToPluginPortal(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
|
||||
primaryUpstream := "https://repo1.maven.org/maven2"
|
||||
pluginPortalUpstream := "https://plugins.gradle.org/m2"
|
||||
implPath := "/com/diffplug/spotless/spotless-plugin-gradle/8.4.0/spotless-plugin-gradle-8.4.0.jar"
|
||||
primaryURL := primaryUpstream + implPath
|
||||
pluginPortalURL := pluginPortalUpstream + implPath
|
||||
|
||||
fetcher.fetchErrByURL = map[string]error{
|
||||
primaryURL: ErrUpstreamNotFound,
|
||||
}
|
||||
fetcher.artifact = &fetch.Artifact{
|
||||
Body: io.NopCloser(strings.NewReader("plugin impl jar")),
|
||||
ContentType: "application/java-archive",
|
||||
}
|
||||
|
||||
h := NewMavenHandler(proxy, "http://localhost", primaryUpstream, pluginPortalUpstream)
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
resp, err := http.Get(srv.URL + implPath)
|
||||
if err != nil {
|
||||
t.Fatalf("request failed: %v", err)
|
||||
}
|
||||
body, _ := io.ReadAll(resp.Body)
|
||||
_ = resp.Body.Close()
|
||||
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
t.Fatalf("status = %d, want %d", resp.StatusCode, http.StatusOK)
|
||||
}
|
||||
if string(body) != "plugin impl jar" {
|
||||
t.Fatalf("body = %q, want %q", body, "plugin impl jar")
|
||||
}
|
||||
|
||||
if fetcher.fetchedURL != pluginPortalURL {
|
||||
t.Fatalf("implementation artifact should fallback to plugin portal; fetched URL = %q, want %q", fetcher.fetchedURL, pluginPortalURL)
|
||||
}
|
||||
}
|
||||
|
||||
func TestMavenHandler_GradlePluginImplementation_NotFoundInBothUpstreams(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
|
||||
primaryUpstream := "https://repo1.maven.org/maven2"
|
||||
pluginPortalUpstream := "https://plugins.gradle.org/m2"
|
||||
implPath := "/com/diffplug/spotless/spotless-plugin-gradle/8.4.0/spotless-plugin-gradle-8.4.0.jar"
|
||||
primaryURL := primaryUpstream + implPath
|
||||
pluginPortalURL := pluginPortalUpstream + implPath
|
||||
|
||||
fetcher.fetchErrByURL = map[string]error{
|
||||
primaryURL: ErrUpstreamNotFound,
|
||||
pluginPortalURL: ErrUpstreamNotFound,
|
||||
}
|
||||
|
||||
h := NewMavenHandler(proxy, "http://localhost", primaryUpstream, pluginPortalUpstream)
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
resp, err := http.Get(srv.URL + implPath)
|
||||
if err != nil {
|
||||
t.Fatalf("request failed: %v", err)
|
||||
}
|
||||
_ = resp.Body.Close()
|
||||
|
||||
if resp.StatusCode != http.StatusNotFound {
|
||||
t.Fatalf("status = %d, want %d", resp.StatusCode, http.StatusNotFound)
|
||||
}
|
||||
|
||||
if fetcher.fetchedURL != pluginPortalURL {
|
||||
t.Fatalf("expected fallback attempt to plugin portal; fetched URL = %q, want %q", fetcher.fetchedURL, pluginPortalURL)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNuGetHandler_DownloadCacheMiss(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
fetcher.artifact = &fetch.Artifact{
|
||||
|
|
@ -1213,7 +897,7 @@ func TestDebianHandler_DownloadCacheMiss(t *testing.T) {
|
|||
ContentType: "application/vnd.debian.binary-package",
|
||||
}
|
||||
|
||||
h := NewDebianHandler(proxy, "http://localhost", "")
|
||||
h := NewDebianHandler(proxy, "http://localhost")
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
|
|
|
|||
|
|
@ -1,43 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"strings"
|
||||
)
|
||||
|
||||
type filenameDownload struct {
|
||||
ecosystem string
|
||||
upstreamURL string
|
||||
suffix string
|
||||
parseErr string
|
||||
fetchErr string
|
||||
parse func(string) (name, version string)
|
||||
}
|
||||
|
||||
func (p *Proxy) handleFilenameDownload(w http.ResponseWriter, r *http.Request, d filenameDownload) {
|
||||
filename := r.PathValue("filename")
|
||||
if filename == "" || !strings.HasSuffix(filename, d.suffix) {
|
||||
http.Error(w, "invalid filename", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
name, version := d.parse(filename)
|
||||
if name == "" || version == "" {
|
||||
http.Error(w, d.parseErr, http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
p.Logger.Info(d.ecosystem+" download request",
|
||||
"name", name, "version", version, "filename", filename)
|
||||
|
||||
downloadURL := d.upstreamURL + r.URL.Path
|
||||
result, err := p.GetOrFetchArtifactFromURL(
|
||||
r.Context(), d.ecosystem, name, version, filename, downloadURL,
|
||||
)
|
||||
if err != nil {
|
||||
p.serveArtifactError(w, err, d.fetchErr)
|
||||
return
|
||||
}
|
||||
|
||||
ServeArtifact(w, result)
|
||||
}
|
||||
|
|
@ -8,6 +8,8 @@ import (
|
|||
"net/http"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/purl"
|
||||
)
|
||||
|
||||
const (
|
||||
|
|
@ -30,13 +32,6 @@ func NewGemHandler(proxy *Proxy, proxyURL string) *GemHandler {
|
|||
}
|
||||
}
|
||||
|
||||
// NewGemHandlerWithUpstream creates a RubyGems handler with a custom upstream.
|
||||
func NewGemHandlerWithUpstream(proxy *Proxy, proxyURL, upstreamURL string) *GemHandler {
|
||||
h := NewGemHandler(proxy, proxyURL)
|
||||
h.upstreamURL = configuredUpstreamURL(upstreamURL, gemUpstream)
|
||||
return h
|
||||
}
|
||||
|
||||
// Routes returns the HTTP handler for RubyGems requests.
|
||||
func (h *GemHandler) Routes() http.Handler {
|
||||
mux := http.NewServeMux()
|
||||
|
|
@ -65,14 +60,30 @@ func (h *GemHandler) Routes() http.Handler {
|
|||
|
||||
// handleDownload serves a gem file, fetching and caching from upstream if needed.
|
||||
func (h *GemHandler) handleDownload(w http.ResponseWriter, r *http.Request) {
|
||||
h.proxy.handleFilenameDownload(w, r, filenameDownload{
|
||||
ecosystem: "gem",
|
||||
upstreamURL: h.upstreamURL,
|
||||
suffix: ".gem",
|
||||
parseErr: "could not parse gem filename",
|
||||
fetchErr: "failed to fetch gem",
|
||||
parse: h.parseGemFilename,
|
||||
})
|
||||
filename := r.PathValue("filename")
|
||||
if filename == "" || !strings.HasSuffix(filename, ".gem") {
|
||||
http.Error(w, "invalid filename", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
// Extract name and version from filename (e.g., "rails-7.1.0.gem")
|
||||
name, version := h.parseGemFilename(filename)
|
||||
if name == "" || version == "" {
|
||||
http.Error(w, "could not parse gem filename", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
h.proxy.Logger.Info("gem download request",
|
||||
"name", name, "version", version, "filename", filename)
|
||||
|
||||
result, err := h.proxy.GetOrFetchArtifact(r.Context(), "gem", name, version, filename)
|
||||
if err != nil {
|
||||
h.proxy.Logger.Error("failed to get artifact", "error", err)
|
||||
http.Error(w, "failed to fetch gem", http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
|
||||
ServeArtifact(w, result)
|
||||
}
|
||||
|
||||
// parseGemFilename extracts name and version from a gem filename.
|
||||
|
|
@ -182,7 +193,7 @@ func (h *GemHandler) fetchCompactIndex(r *http.Request, name string) (*http.Resp
|
|||
// writeFilteredIndex writes the compact index response with cooldown-filtered versions removed.
|
||||
func (h *GemHandler) writeFilteredIndex(w http.ResponseWriter, resp *http.Response, name string, filtered map[string]bool) {
|
||||
for k, vv := range resp.Header {
|
||||
if strings.EqualFold(k, headerContentLength) {
|
||||
if strings.EqualFold(k, "Content-Length") {
|
||||
continue // length will change after filtering
|
||||
}
|
||||
for _, v := range vv {
|
||||
|
|
@ -255,7 +266,7 @@ func (h *GemHandler) fetchFilteredVersions(r *http.Request, name string) (map[st
|
|||
return nil, err
|
||||
}
|
||||
|
||||
packagePURL := canonicalPackagePURL("gem", name)
|
||||
packagePURL := purl.MakePURLString("gem", name, "")
|
||||
filtered := make(map[string]bool)
|
||||
|
||||
for _, v := range versions {
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ import (
|
|||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/cooldown"
|
||||
"github.com/git-pkgs/proxy/internal/cooldown"
|
||||
)
|
||||
|
||||
func TestGemParseFilename(t *testing.T) {
|
||||
|
|
|
|||
|
|
@ -1,160 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"crypto/sha256"
|
||||
"encoding/hex"
|
||||
"net/http"
|
||||
"regexp"
|
||||
"strings"
|
||||
)
|
||||
|
||||
const (
|
||||
genericEcosystem = "generic"
|
||||
// genericAcceptAny is always sent for metadata so every client shares the
|
||||
// same cached representation, regardless of its Accept header.
|
||||
genericAcceptAny = "*/*"
|
||||
// githubReleaseAssetMatchCount is the full match plus owner, repository,
|
||||
// tag and asset filename.
|
||||
githubReleaseAssetMatchCount = 5
|
||||
)
|
||||
|
||||
// githubReleaseAssetPattern matches the path of a GitHub release asset
|
||||
// download, {owner}/{repo}/releases/download/{tag}/{asset}. A tag pins the
|
||||
// asset to one release, so these downloads are cached in the artifact cache
|
||||
// and served without revalidation once fetched.
|
||||
var githubReleaseAssetPattern = regexp.MustCompile(`^([^/]+)/([^/]+)/releases/download/([^/]+)/([^/]+)$`)
|
||||
|
||||
// GenericHandler proxies plain HTTP downloads from configured upstream base
|
||||
// URLs. Each configured upstream is mounted at /generic/{name}/ and the
|
||||
// remaining request path (and query string) is appended to the upstream URL.
|
||||
//
|
||||
// Only configured upstreams are reachable, so the proxy is not an open HTTP
|
||||
// proxy. The handler is the caching layer behind tools that download from
|
||||
// fixed URL shapes, such as mise's aqua backend fetching GitHub release
|
||||
// assets, and is pointed at by URL-rewriting settings on the client.
|
||||
//
|
||||
// Release-asset paths ({owner}/{repo}/releases/download/{tag}/{asset}) are
|
||||
// version-pinned and cached in the shared artifact cache, so they keep being
|
||||
// served when the upstream is unreachable. Every other path is served through
|
||||
// the metadata cache: fresh within the metadata TTL, revalidated with the
|
||||
// upstream's validators after that, and served stale when the upstream fails
|
||||
// or refuses the request. That covers API responses such as
|
||||
// api.github.com/repos/{owner}/{repo}/releases/tags/{tag}.
|
||||
type GenericHandler struct {
|
||||
proxy *Proxy
|
||||
repositories map[string]string
|
||||
}
|
||||
|
||||
// NewGenericHandler creates a generic HTTP download proxy handler.
|
||||
func NewGenericHandler(proxy *Proxy, repositories map[string]string) *GenericHandler {
|
||||
h := &GenericHandler{
|
||||
proxy: proxy,
|
||||
repositories: make(map[string]string, len(repositories)),
|
||||
}
|
||||
for name, upstreamURL := range repositories {
|
||||
h.repositories[name] = strings.TrimSuffix(upstreamURL, "/")
|
||||
}
|
||||
return h
|
||||
}
|
||||
|
||||
// Routes returns the HTTP handler for generic download requests.
|
||||
// Mount this at /generic on your router.
|
||||
func (h *GenericHandler) Routes() http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.Method != http.MethodGet && r.Method != http.MethodHead {
|
||||
http.Error(w, "method not allowed", http.StatusMethodNotAllowed)
|
||||
return
|
||||
}
|
||||
|
||||
path := strings.TrimPrefix(r.URL.Path, "/")
|
||||
|
||||
if containsPathTraversal(path) {
|
||||
http.Error(w, "invalid path", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
repository, rest, ok := strings.Cut(path, "/")
|
||||
upstreamURL, found := h.repositories[repository]
|
||||
if !ok || rest == "" || !found {
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
|
||||
if asset, ok := parseGitHubReleaseAsset(rest); ok {
|
||||
h.handleReleaseAsset(w, r, repository, upstreamURL, rest, asset)
|
||||
return
|
||||
}
|
||||
|
||||
h.handleMetadata(w, r, repository, upstreamURL, rest)
|
||||
})
|
||||
}
|
||||
|
||||
// githubReleaseAsset is the identity of a version-pinned release download.
|
||||
type githubReleaseAsset struct {
|
||||
owner string
|
||||
repo string
|
||||
tag string
|
||||
filename string
|
||||
}
|
||||
|
||||
// parseGitHubReleaseAsset extracts the release identity from a path shaped
|
||||
// like {owner}/{repo}/releases/download/{tag}/{asset}.
|
||||
func parseGitHubReleaseAsset(path string) (githubReleaseAsset, bool) {
|
||||
matches := githubReleaseAssetPattern.FindStringSubmatch(path)
|
||||
if len(matches) != githubReleaseAssetMatchCount {
|
||||
return githubReleaseAsset{}, false
|
||||
}
|
||||
return githubReleaseAsset{
|
||||
owner: matches[1],
|
||||
repo: matches[2],
|
||||
tag: matches[3],
|
||||
filename: matches[4],
|
||||
}, true
|
||||
}
|
||||
|
||||
// handleReleaseAsset fetches and caches a version-pinned release asset in the
|
||||
// artifact cache. The configured upstream name is part of the cache identity
|
||||
// so two upstreams serving the same path never share bytes.
|
||||
func (h *GenericHandler) handleReleaseAsset(w http.ResponseWriter, r *http.Request, repository, upstreamURL, path string, asset githubReleaseAsset) {
|
||||
name := asset.owner + "/" + asset.repo
|
||||
downloadURL := upstreamURL + "/" + path
|
||||
cacheFilename := repository + "/" + asset.filename
|
||||
|
||||
h.proxy.Logger.Info("generic release asset download",
|
||||
"repository", repository, "name", name, "version", asset.tag, "filename", asset.filename)
|
||||
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURL(
|
||||
r.Context(), genericEcosystem, name, asset.tag, cacheFilename, downloadURL)
|
||||
if err != nil {
|
||||
h.proxy.serveArtifactError(w, err, "failed to fetch release asset")
|
||||
return
|
||||
}
|
||||
|
||||
if result.Artifact.MediaType == "" {
|
||||
result.Artifact.MediaType = "application/octet-stream"
|
||||
}
|
||||
serveArtifact(w, r.Method, result)
|
||||
}
|
||||
|
||||
// handleMetadata serves any other path through the metadata cache. The query
|
||||
// string is forwarded and is part of the cache identity. A fixed Accept header
|
||||
// keeps all clients on one cached representation.
|
||||
func (h *GenericHandler) handleMetadata(w http.ResponseWriter, r *http.Request, repository, upstreamURL, path string) {
|
||||
target := upstreamURL + "/" + path
|
||||
if r.URL.RawQuery != "" {
|
||||
target += "?" + r.URL.RawQuery
|
||||
}
|
||||
|
||||
h.proxy.ProxyCached(w, r, target, genericEcosystem,
|
||||
h.metadataCacheKey(repository, upstreamURL, path, r.URL.RawQuery), genericAcceptAny)
|
||||
}
|
||||
|
||||
// metadataCacheKey derives the metadata cache key from the upstream name, its
|
||||
// URL, the request path and query. Hashing the identity keeps distinct
|
||||
// upstreams from sharing entries and drops cached entries when an upstream is
|
||||
// repointed, mirroring APKHandler.metadataCacheKey.
|
||||
func (h *GenericHandler) metadataCacheKey(repository, upstreamURL, path, query string) string {
|
||||
identity := repository + "\x00" + upstreamURL + "\x00" + path + "\x00" + query
|
||||
digest := sha256.Sum256([]byte(identity))
|
||||
return hex.EncodeToString(digest[:])
|
||||
}
|
||||
|
|
@ -1,311 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
upstreamhttp "github.com/git-pkgs/proxy/internal/httpclient"
|
||||
"github.com/git-pkgs/registries/fetch"
|
||||
)
|
||||
|
||||
const testReleaseAssetPath = "/jqlang/jq/releases/download/jq-1.7.1/jq-linux-amd64"
|
||||
|
||||
func TestParseGitHubReleaseAsset(t *testing.T) {
|
||||
tests := []struct {
|
||||
path string
|
||||
want githubReleaseAsset
|
||||
ok bool
|
||||
}{
|
||||
{
|
||||
"jqlang/jq/releases/download/jq-1.7.1/jq-linux-amd64",
|
||||
githubReleaseAsset{owner: "jqlang", repo: "jq", tag: "jq-1.7.1", filename: "jq-linux-amd64"},
|
||||
true,
|
||||
},
|
||||
{
|
||||
"cli/cli/releases/download/v2.63.2/gh_2.63.2_linux_amd64.tar.gz",
|
||||
githubReleaseAsset{owner: "cli", repo: "cli", tag: "v2.63.2", filename: "gh_2.63.2_linux_amd64.tar.gz"},
|
||||
true,
|
||||
},
|
||||
// Mutable: resolves to whatever is latest today.
|
||||
{"jqlang/jq/releases/latest/download/jq-linux-amd64", githubReleaseAsset{}, false},
|
||||
// API lookups and tag listings are not assets.
|
||||
{"repos/jqlang/jq/releases/tags/jq-1.7.1", githubReleaseAsset{}, false},
|
||||
{"jqlang/jq/releases/tag/jq-1.7.1", githubReleaseAsset{}, false},
|
||||
// Source archives are a different shape.
|
||||
{"jqlang/jq/archive/refs/tags/jq-1.7.1.tar.gz", githubReleaseAsset{}, false},
|
||||
// Extra or missing segments.
|
||||
{"jqlang/jq/releases/download/jq-1.7.1", githubReleaseAsset{}, false},
|
||||
{"jqlang/jq/releases/download/jq-1.7.1/dir/asset", githubReleaseAsset{}, false},
|
||||
{"", githubReleaseAsset{}, false},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
got, ok := parseGitHubReleaseAsset(tt.path)
|
||||
if ok != tt.ok || got != tt.want {
|
||||
t.Errorf("parseGitHubReleaseAsset(%q) = (%+v, %v), want (%+v, %v)", tt.path, got, ok, tt.want, tt.ok)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestGenericHandler_RejectsUnknownUpstreamAndBadPaths(t *testing.T) {
|
||||
h := NewGenericHandler(testProxy(), map[string]string{"github": "https://github.com"})
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
method string
|
||||
target string
|
||||
want int
|
||||
}{
|
||||
{"unknown upstream", http.MethodGet, "/gitlab/owner/repo/releases/download/v1/asset", http.StatusNotFound},
|
||||
{"missing path", http.MethodGet, "/github", http.StatusNotFound},
|
||||
{"missing path with slash", http.MethodGet, "/github/", http.StatusNotFound},
|
||||
{"traversal", http.MethodGet, "/github/../etc/passwd", http.StatusBadRequest},
|
||||
{"encoded traversal", http.MethodGet, "/github/%2e%2e/etc/passwd", http.StatusBadRequest},
|
||||
{"post", http.MethodPost, "/github/owner/repo/releases/download/v1/asset", http.StatusMethodNotAllowed},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
w := httptest.NewRecorder()
|
||||
h.Routes().ServeHTTP(w, httptest.NewRequest(tt.method, tt.target, nil))
|
||||
if w.Code != tt.want {
|
||||
t.Errorf("status = %d, want %d", w.Code, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestGenericHandler_ReleaseAssetIsCachedAndServedWhenUpstreamDown(t *testing.T) {
|
||||
asset := []byte("jq binary bytes")
|
||||
var available atomic.Bool
|
||||
available.Store(true)
|
||||
var upstreamRequests atomic.Int32
|
||||
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if !available.Load() {
|
||||
http.Error(w, "unavailable", http.StatusServiceUnavailable)
|
||||
return
|
||||
}
|
||||
if r.URL.Path != testReleaseAssetPath {
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
upstreamRequests.Add(1)
|
||||
w.Header().Set("Content-Type", "application/octet-stream")
|
||||
_, _ = w.Write(asset)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
fetcher := fetch.NewFetcher(fetch.WithHTTPClient(upstream.Client()), fetch.WithMaxRetries(0))
|
||||
proxy.Fetcher = fetcher
|
||||
t.Cleanup(func() { _ = fetcher.Close() })
|
||||
|
||||
h := NewGenericHandler(proxy, map[string]string{"github": upstream.URL})
|
||||
|
||||
w := serveGenericRequest(h, "/github"+testReleaseAssetPath)
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, want 200: %s", w.Code, w.Body.String())
|
||||
}
|
||||
if got := w.Body.String(); got != string(asset) {
|
||||
t.Errorf("body = %q, want %q", got, asset)
|
||||
}
|
||||
if got := upstreamRequests.Load(); got != 1 {
|
||||
t.Fatalf("upstream requests = %d, want 1", got)
|
||||
}
|
||||
|
||||
// Second request must be served from cache, even with the upstream down.
|
||||
available.Store(false)
|
||||
w = serveGenericRequest(h, "/github"+testReleaseAssetPath)
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("cached: status = %d, want 200: %s", w.Code, w.Body.String())
|
||||
}
|
||||
if got := w.Body.String(); got != string(asset) {
|
||||
t.Errorf("cached: body = %q, want %q", got, asset)
|
||||
}
|
||||
if got := upstreamRequests.Load(); got != 1 {
|
||||
t.Errorf("upstream requests after cache hit = %d, want 1", got)
|
||||
}
|
||||
|
||||
// HEAD is answered from the same cache entry without a body.
|
||||
w = httptest.NewRecorder()
|
||||
h.Routes().ServeHTTP(w, httptest.NewRequest(http.MethodHead, "/github"+testReleaseAssetPath, nil))
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("HEAD: status = %d, want 200", w.Code)
|
||||
}
|
||||
if w.Body.Len() != 0 {
|
||||
t.Errorf("HEAD: body length = %d, want 0", w.Body.Len())
|
||||
}
|
||||
}
|
||||
|
||||
func TestGenericHandler_ReleaseAssetNotFoundIsNotCached(t *testing.T) {
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
http.NotFound(w, r)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
fetcher := fetch.NewFetcher(fetch.WithHTTPClient(upstream.Client()), fetch.WithMaxRetries(0))
|
||||
proxy.Fetcher = fetcher
|
||||
t.Cleanup(func() { _ = fetcher.Close() })
|
||||
|
||||
h := NewGenericHandler(proxy, map[string]string{"github": upstream.URL})
|
||||
w := serveGenericRequest(h, "/github"+testReleaseAssetPath)
|
||||
if w.Code != http.StatusNotFound {
|
||||
t.Fatalf("status = %d, want 404: %s", w.Code, w.Body.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestGenericHandler_MetadataForwardsQueryAndServesStaleOnThrottle(t *testing.T) {
|
||||
const apiPath = "/repos/jqlang/jq/releases/tags/jq-1.7.1"
|
||||
body := `{"tag_name":"jq-1.7.1"}`
|
||||
var throttled atomic.Bool
|
||||
var gotQuery string
|
||||
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.URL.Path != apiPath {
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
gotQuery = r.URL.RawQuery
|
||||
if throttled.Load() {
|
||||
w.Header().Set("Retry-After", "60")
|
||||
http.Error(w, `{"message":"API rate limit exceeded"}`, http.StatusTooManyRequests)
|
||||
return
|
||||
}
|
||||
w.Header().Set("Content-Type", "application/vnd.github+json")
|
||||
w.Header().Set("ETag", `"v1"`)
|
||||
_, _ = w.Write([]byte(body))
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
proxy.CacheMetadata = true
|
||||
// A tiny TTL so the second request is past freshness and has to consult
|
||||
// the upstream, and the served copy is marked stale.
|
||||
proxy.MetadataTTL = time.Millisecond
|
||||
|
||||
h := NewGenericHandler(proxy, map[string]string{"github-api": upstream.URL})
|
||||
|
||||
req := httptest.NewRequest(http.MethodGet, "/github-api"+apiPath+"?per_page=1", nil)
|
||||
w := httptest.NewRecorder()
|
||||
h.Routes().ServeHTTP(w, req)
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, want 200: %s", w.Code, w.Body.String())
|
||||
}
|
||||
if got := w.Body.String(); got != body {
|
||||
t.Errorf("body = %q, want %q", got, body)
|
||||
}
|
||||
if gotQuery != "per_page=1" {
|
||||
t.Errorf("upstream query = %q, want %q", gotQuery, "per_page=1")
|
||||
}
|
||||
if ct := w.Header().Get("Content-Type"); ct != "application/vnd.github+json" {
|
||||
t.Errorf("Content-Type = %q, want upstream's", ct)
|
||||
}
|
||||
|
||||
// The upstream now throttles us: the cached body must be served stale
|
||||
// rather than the 429 being passed through.
|
||||
throttled.Store(true)
|
||||
time.Sleep(5 * time.Millisecond)
|
||||
w = httptest.NewRecorder()
|
||||
h.Routes().ServeHTTP(w, req)
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("throttled: status = %d, want 200 stale: %s", w.Code, w.Body.String())
|
||||
}
|
||||
if got := w.Body.String(); got != body {
|
||||
t.Errorf("throttled: body = %q, want cached %q", got, body)
|
||||
}
|
||||
if warning := w.Header().Get("Warning"); !strings.Contains(warning, "110") {
|
||||
t.Errorf("throttled: Warning = %q, want a 110 stale warning", warning)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGenericHandler_DistinctUpstreamsDoNotShareCache(t *testing.T) {
|
||||
first := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = w.Write([]byte("from first"))
|
||||
}))
|
||||
defer first.Close()
|
||||
second := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = w.Write([]byte("from second"))
|
||||
}))
|
||||
defer second.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
fetcher := fetch.NewFetcher(fetch.WithHTTPClient(first.Client()), fetch.WithMaxRetries(0))
|
||||
proxy.Fetcher = fetcher
|
||||
t.Cleanup(func() { _ = fetcher.Close() })
|
||||
|
||||
h := NewGenericHandler(proxy, map[string]string{"one": first.URL, "two": second.URL})
|
||||
|
||||
w := serveGenericRequest(h, "/one"+testReleaseAssetPath)
|
||||
if got := w.Body.String(); got != "from first" {
|
||||
t.Fatalf("one: body = %q, want %q", got, "from first")
|
||||
}
|
||||
w = serveGenericRequest(h, "/two"+testReleaseAssetPath)
|
||||
if got := w.Body.String(); got != "from second" {
|
||||
t.Fatalf("two: body = %q, want %q (must not reuse the first upstream's cache entry)", got, "from second")
|
||||
}
|
||||
}
|
||||
|
||||
func TestGenericHandler_UpstreamAuthIsScopedToTheConfiguredHost(t *testing.T) {
|
||||
asset := []byte("private asset")
|
||||
var storageAuth atomic.Value
|
||||
storageAuth.Store("unset")
|
||||
|
||||
// The object store the release host redirects to must never see the
|
||||
// token configured for the release host.
|
||||
objectStore := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
storageAuth.Store(r.Header.Get("Authorization"))
|
||||
_, _ = w.Write(asset)
|
||||
}))
|
||||
defer objectStore.Close()
|
||||
|
||||
var releaseAuth string
|
||||
releaseHost := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
releaseAuth = r.Header.Get("Authorization")
|
||||
if releaseAuth != "Bearer github-token" {
|
||||
http.Error(w, "unauthorized", http.StatusUnauthorized)
|
||||
return
|
||||
}
|
||||
http.Redirect(w, r, objectStore.URL+"/signed"+r.URL.Path, http.StatusFound)
|
||||
}))
|
||||
defer releaseHost.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
authClient := &http.Client{Transport: upstreamhttp.NewTransport(http.DefaultTransport,
|
||||
upstreamhttp.AuthFunc(func(url string) (string, string) {
|
||||
if strings.HasPrefix(url, releaseHost.URL) {
|
||||
return "Authorization", "Bearer github-token"
|
||||
}
|
||||
return "", ""
|
||||
}))}
|
||||
fetcher := fetch.NewFetcher(fetch.WithHTTPClient(authClient), fetch.WithMaxRetries(0))
|
||||
proxy.Fetcher = fetcher
|
||||
t.Cleanup(func() { _ = fetcher.Close() })
|
||||
|
||||
h := NewGenericHandler(proxy, map[string]string{"github": releaseHost.URL})
|
||||
w := serveGenericRequest(h, "/github"+testReleaseAssetPath)
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, want 200: %s", w.Code, w.Body.String())
|
||||
}
|
||||
if got := w.Body.String(); got != string(asset) {
|
||||
t.Errorf("body = %q, want %q", got, asset)
|
||||
}
|
||||
if releaseAuth != "Bearer github-token" {
|
||||
t.Errorf("release host Authorization = %q, want the configured token", releaseAuth)
|
||||
}
|
||||
if got := storageAuth.Load(); got != "" {
|
||||
t.Errorf("object store Authorization = %q, want none after the cross-host redirect", got)
|
||||
}
|
||||
}
|
||||
|
||||
func serveGenericRequest(h *GenericHandler, target string) *httptest.ResponseRecorder {
|
||||
w := httptest.NewRecorder()
|
||||
h.Routes().ServeHTTP(w, httptest.NewRequest(http.MethodGet, target, nil))
|
||||
return w
|
||||
}
|
||||
|
|
@ -1,12 +1,9 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"github.com/git-pkgs/registries/fetch"
|
||||
)
|
||||
|
||||
const (
|
||||
|
|
@ -30,13 +27,6 @@ func NewGoHandler(proxy *Proxy, proxyURL string) *GoHandler {
|
|||
}
|
||||
}
|
||||
|
||||
// NewGoHandlerWithUpstream creates a Go module handler with a custom upstream.
|
||||
func NewGoHandlerWithUpstream(proxy *Proxy, proxyURL, upstreamURL string) *GoHandler {
|
||||
h := NewGoHandler(proxy, proxyURL)
|
||||
h.upstreamURL = configuredUpstreamURL(upstreamURL, goUpstream)
|
||||
return h
|
||||
}
|
||||
|
||||
// Routes returns the HTTP handler for Go proxy requests.
|
||||
func (h *GoHandler) Routes() http.Handler {
|
||||
// Go module paths can contain slashes, so just use the handler directly
|
||||
|
|
@ -108,19 +98,8 @@ func (h *GoHandler) handleDownload(w http.ResponseWriter, r *http.Request, modul
|
|||
h.proxy.Logger.Info("go module download request",
|
||||
"module", decodedModule, "version", version)
|
||||
|
||||
downloadURL := h.upstreamURL + r.URL.Path
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURL(
|
||||
r.Context(), "golang", decodedModule, version, filename, downloadURL,
|
||||
)
|
||||
result, err := h.proxy.GetOrFetchArtifact(r.Context(), "golang", decodedModule, version, filename)
|
||||
if err != nil {
|
||||
if errors.Is(err, fetch.ErrNotFound) {
|
||||
http.Error(w, "not found", http.StatusNotFound)
|
||||
return
|
||||
}
|
||||
if errors.Is(err, ErrArtifactBlocked) {
|
||||
http.Error(w, err.Error(), http.StatusForbidden)
|
||||
return
|
||||
}
|
||||
h.proxy.Logger.Error("failed to get artifact", "error", err)
|
||||
http.Error(w, "failed to fetch module", http.StatusBadGateway)
|
||||
return
|
||||
|
|
|
|||
|
|
@ -1,49 +1,9 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
|
||||
"github.com/git-pkgs/registries/fetch"
|
||||
)
|
||||
|
||||
func TestGoModuleDownloadUpstreamErrors(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
fetchErr error
|
||||
wantStatus int
|
||||
}{
|
||||
{
|
||||
name: "module not found",
|
||||
fetchErr: fetch.ErrNotFound,
|
||||
wantStatus: http.StatusNotFound,
|
||||
},
|
||||
{
|
||||
name: "upstream failure",
|
||||
fetchErr: errors.New("connection refused"),
|
||||
wantStatus: http.StatusBadGateway,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
fetcher.fetchErr = tt.fetchErr
|
||||
handler := NewGoHandler(proxy, "http://localhost:8080")
|
||||
|
||||
req := httptest.NewRequest(http.MethodGet, "/example.com/mod/@v/v1.0.0.zip", nil)
|
||||
resp := httptest.NewRecorder()
|
||||
handler.Routes().ServeHTTP(resp, req)
|
||||
|
||||
if resp.Code != tt.wantStatus {
|
||||
t.Fatalf("status = %d, want %d", resp.Code, tt.wantStatus)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestDecodeGoModule(t *testing.T) {
|
||||
tests := []struct {
|
||||
encoded string
|
||||
|
|
|
|||
|
|
@ -7,9 +7,7 @@ import (
|
|||
"regexp"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/proxy/internal/metrics"
|
||||
"github.com/git-pkgs/proxy/internal/storage"
|
||||
)
|
||||
|
||||
|
|
@ -93,54 +91,39 @@ func (h *GradleBuildCacheHandler) cacheStoragePath(key string) string {
|
|||
|
||||
func (h *GradleBuildCacheHandler) handleGetOrHead(w http.ResponseWriter, r *http.Request, key string) {
|
||||
storagePath := h.cacheStoragePath(key)
|
||||
w.Header().Set(headerContentType, gradleBuildCacheContentType)
|
||||
w.Header().Set("Content-Type", gradleBuildCacheContentType)
|
||||
|
||||
if r.Method == http.MethodHead {
|
||||
existsStart := time.Now()
|
||||
exists, err := h.proxy.Storage.Exists(r.Context(), storagePath)
|
||||
metrics.RecordStorageOperation("read", time.Since(existsStart))
|
||||
if err != nil {
|
||||
metrics.RecordStorageError("read")
|
||||
h.proxy.Logger.Error("failed to check gradle build cache entry", "key", key, "error", err)
|
||||
http.Error(w, "failed to read cache entry", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
if !exists {
|
||||
metrics.RecordCacheMiss("gradle")
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
metrics.RecordCacheHit("gradle")
|
||||
|
||||
sizeStart := time.Now()
|
||||
size, err := h.proxy.Storage.Size(r.Context(), storagePath)
|
||||
metrics.RecordStorageOperation("read", time.Since(sizeStart))
|
||||
if err != nil {
|
||||
metrics.RecordStorageError("read")
|
||||
} else if size >= 0 {
|
||||
w.Header().Set(headerContentLength, strconv.FormatInt(size, 10))
|
||||
if size, err := h.proxy.Storage.Size(r.Context(), storagePath); err == nil && size >= 0 {
|
||||
w.Header().Set("Content-Length", strconv.FormatInt(size, 10))
|
||||
}
|
||||
|
||||
w.WriteHeader(http.StatusOK)
|
||||
return
|
||||
}
|
||||
|
||||
readStart := time.Now()
|
||||
reader, err := h.proxy.Storage.Open(r.Context(), storagePath)
|
||||
metrics.RecordStorageOperation("read", time.Since(readStart))
|
||||
if err != nil {
|
||||
if errors.Is(err, storage.ErrNotFound) {
|
||||
metrics.RecordCacheMiss("gradle")
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
metrics.RecordStorageError("read")
|
||||
h.proxy.Logger.Error("failed to open gradle build cache entry", "key", key, "error", err)
|
||||
http.Error(w, "failed to read cache entry", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
defer func() { _ = reader.Close() }()
|
||||
metrics.RecordCacheHit("gradle")
|
||||
|
||||
w.WriteHeader(http.StatusOK)
|
||||
_, _ = io.Copy(w, reader)
|
||||
|
|
@ -155,9 +138,7 @@ func (h *GradleBuildCacheHandler) handlePut(w http.ResponseWriter, r *http.Reque
|
|||
|
||||
r.Body = http.MaxBytesReader(w, r.Body, maxUploadSize)
|
||||
|
||||
storeStart := time.Now()
|
||||
_, hash, err := h.proxy.Storage.Store(r.Context(), storagePath, r.Body)
|
||||
metrics.RecordStorageOperation("write", time.Since(storeStart))
|
||||
if err != nil {
|
||||
var maxBytesErr *http.MaxBytesError
|
||||
if errors.As(err, &maxBytesErr) {
|
||||
|
|
@ -165,14 +146,13 @@ func (h *GradleBuildCacheHandler) handlePut(w http.ResponseWriter, r *http.Reque
|
|||
return
|
||||
}
|
||||
|
||||
metrics.RecordStorageError("write")
|
||||
h.proxy.Logger.Error("failed to store gradle build cache entry", "key", key, "error", err)
|
||||
http.Error(w, "failed to write cache entry", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set(headerContentLength, "0")
|
||||
w.Header().Set(headerETag, `"`+hash+`"`)
|
||||
w.Header().Set("Content-Length", "0")
|
||||
w.Header().Set("ETag", `"`+hash+`"`)
|
||||
|
||||
w.WriteHeader(http.StatusCreated)
|
||||
}
|
||||
|
|
|
|||
|
|
@ -6,9 +6,6 @@ import (
|
|||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/git-pkgs/proxy/internal/metrics"
|
||||
"github.com/prometheus/client_golang/prometheus/testutil"
|
||||
)
|
||||
|
||||
func TestGradleBuildCacheHandler_PutGetHead(t *testing.T) {
|
||||
|
|
@ -230,56 +227,3 @@ func TestGradleBuildCacheHandler_PutTooLarge(t *testing.T) {
|
|||
t.Fatalf("PUT status = %d, want %d", resp.StatusCode, http.StatusRequestEntityTooLarge)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGradleBuildCacheHandler_RecordsMetrics(t *testing.T) {
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
h := NewGradleBuildCacheHandler(proxy)
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
hitsBefore := testutil.ToFloat64(metrics.CacheHits.WithLabelValues("gradle"))
|
||||
missesBefore := testutil.ToFloat64(metrics.CacheMisses.WithLabelValues("gradle"))
|
||||
|
||||
key := "metrics-key"
|
||||
putReq, err := http.NewRequest(http.MethodPut, srv.URL+"/"+key, strings.NewReader("payload"))
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create PUT request: %v", err)
|
||||
}
|
||||
putResp, err := http.DefaultClient.Do(putReq)
|
||||
if err != nil {
|
||||
t.Fatalf("PUT request failed: %v", err)
|
||||
}
|
||||
_ = putResp.Body.Close()
|
||||
|
||||
getResp, err := http.Get(srv.URL + "/" + key)
|
||||
if err != nil {
|
||||
t.Fatalf("GET request failed: %v", err)
|
||||
}
|
||||
_ = getResp.Body.Close()
|
||||
|
||||
headReq, err := http.NewRequest(http.MethodHead, srv.URL+"/"+key, nil)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create HEAD request: %v", err)
|
||||
}
|
||||
headResp, err := http.DefaultClient.Do(headReq)
|
||||
if err != nil {
|
||||
t.Fatalf("HEAD request failed: %v", err)
|
||||
}
|
||||
_ = headResp.Body.Close()
|
||||
|
||||
missResp, err := http.Get(srv.URL + "/missing-key")
|
||||
if err != nil {
|
||||
t.Fatalf("GET miss request failed: %v", err)
|
||||
}
|
||||
_ = missResp.Body.Close()
|
||||
|
||||
hitsAfter := testutil.ToFloat64(metrics.CacheHits.WithLabelValues("gradle"))
|
||||
missesAfter := testutil.ToFloat64(metrics.CacheMisses.WithLabelValues("gradle"))
|
||||
|
||||
if diff := hitsAfter - hitsBefore; diff != 2 {
|
||||
t.Fatalf("cache hits delta = %.0f, want 2", diff)
|
||||
}
|
||||
if diff := missesAfter - missesBefore; diff != 1 {
|
||||
t.Fatalf("cache misses delta = %.0f, want 1", diff)
|
||||
}
|
||||
}
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -1,300 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"crypto/sha256"
|
||||
"database/sql"
|
||||
"encoding/hex"
|
||||
"fmt"
|
||||
"io"
|
||||
"log/slog"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/proxy/internal/database"
|
||||
"github.com/git-pkgs/proxy/internal/storage"
|
||||
"github.com/git-pkgs/purl"
|
||||
"github.com/git-pkgs/registries/fetch"
|
||||
)
|
||||
|
||||
const benchmarkArtifactSize = 64 << 10
|
||||
|
||||
const benchmarkMetadataSize = 1 << 20
|
||||
|
||||
type benchmarkResponseWriter struct {
|
||||
header http.Header
|
||||
}
|
||||
|
||||
func (w *benchmarkResponseWriter) Header() http.Header {
|
||||
return w.header
|
||||
}
|
||||
|
||||
func (w *benchmarkResponseWriter) Write(p []byte) (int, error) {
|
||||
return len(p), nil
|
||||
}
|
||||
|
||||
func (w *benchmarkResponseWriter) WriteHeader(_ int) {}
|
||||
|
||||
func benchmarkCachedProxy(b *testing.B) (*Proxy, *mockStorage) {
|
||||
b.Helper()
|
||||
|
||||
proxy, db, store, _ := setupTestProxy(b)
|
||||
content := strings.Repeat("x", benchmarkArtifactSize)
|
||||
seedPackage(b, db, store, "npm", "lodash", "4.17.21", "lodash-4.17.21.tgz", content)
|
||||
|
||||
artifact, err := db.GetArtifact("pkg:npm/lodash@4.17.21", "lodash-4.17.21.tgz")
|
||||
if err != nil {
|
||||
b.Fatalf("get seeded artifact: %v", err)
|
||||
}
|
||||
sum := sha256.Sum256([]byte(content))
|
||||
artifact.ContentHash.String = hex.EncodeToString(sum[:])
|
||||
if err := db.UpsertArtifact(artifact); err != nil {
|
||||
b.Fatalf("update seeded artifact hash: %v", err)
|
||||
}
|
||||
|
||||
return proxy, store
|
||||
}
|
||||
|
||||
func BenchmarkArtifactCacheHit(b *testing.B) {
|
||||
ctx := context.Background()
|
||||
|
||||
b.Run("stream-64KiB", func(b *testing.B) {
|
||||
proxy, _ := benchmarkCachedProxy(b)
|
||||
w := &benchmarkResponseWriter{header: make(http.Header)}
|
||||
b.SetBytes(benchmarkArtifactSize)
|
||||
b.ReportAllocs()
|
||||
b.ResetTimer()
|
||||
|
||||
for b.Loop() {
|
||||
result, err := proxy.GetOrFetchArtifact(ctx, "npm", "lodash", "4.17.21", "lodash-4.17.21.tgz")
|
||||
if err != nil {
|
||||
b.Fatal(err)
|
||||
}
|
||||
ServeArtifact(w, result)
|
||||
}
|
||||
})
|
||||
|
||||
b.Run("direct-serve", func(b *testing.B) {
|
||||
proxy, store := benchmarkCachedProxy(b)
|
||||
proxy.DirectServe = true
|
||||
store.signedURL = "https://storage.example/npm/lodash-4.17.21.tgz?signature=abc"
|
||||
w := &benchmarkResponseWriter{header: make(http.Header)}
|
||||
b.ReportAllocs()
|
||||
b.ResetTimer()
|
||||
|
||||
for b.Loop() {
|
||||
result, err := proxy.GetOrFetchArtifact(ctx, "npm", "lodash", "4.17.21", "lodash-4.17.21.tgz")
|
||||
if err != nil {
|
||||
b.Fatal(err)
|
||||
}
|
||||
ServeArtifact(w, result)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func BenchmarkArtifactCacheHitParallel(b *testing.B) {
|
||||
proxy, _ := benchmarkCachedProxy(b)
|
||||
ctx := context.Background()
|
||||
b.SetBytes(benchmarkArtifactSize)
|
||||
b.ReportAllocs()
|
||||
b.ResetTimer()
|
||||
|
||||
b.RunParallel(func(pb *testing.PB) {
|
||||
w := &benchmarkResponseWriter{header: make(http.Header)}
|
||||
for pb.Next() {
|
||||
result, err := proxy.GetOrFetchArtifact(ctx, "npm", "lodash", "4.17.21", "lodash-4.17.21.tgz")
|
||||
if err != nil {
|
||||
b.Error(err)
|
||||
return
|
||||
}
|
||||
ServeArtifact(w, result)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func BenchmarkReadMetadata(b *testing.B) {
|
||||
payload := bytes.Repeat([]byte("x"), benchmarkMetadataSize)
|
||||
proxy := &Proxy{MetadataMaxSize: benchmarkMetadataSize}
|
||||
b.SetBytes(benchmarkMetadataSize)
|
||||
b.ReportAllocs()
|
||||
|
||||
var data []byte
|
||||
for b.Loop() {
|
||||
var err error
|
||||
data, err = proxy.ReadMetadata(bytes.NewReader(payload))
|
||||
if err != nil {
|
||||
b.Fatal(err)
|
||||
}
|
||||
}
|
||||
if len(data) != len(payload) {
|
||||
b.Fatalf("metadata size = %d, want %d", len(data), len(payload))
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkArtifactPURLConstruction(b *testing.B) {
|
||||
for _, tc := range []struct {
|
||||
name string
|
||||
ecosystem string
|
||||
packageID string
|
||||
}{
|
||||
{"npm", "npm", "lodash"},
|
||||
{"scoped-npm", "npm", "@scope/package"},
|
||||
{"go", "golang", "github.com/git-pkgs/proxy"},
|
||||
} {
|
||||
b.Run(tc.name, func(b *testing.B) {
|
||||
b.ReportAllocs()
|
||||
var packagePURL, versionPURL string
|
||||
for b.Loop() {
|
||||
packagePURL = purl.MakePURLString(tc.ecosystem, tc.packageID, "")
|
||||
versionPURL = purl.MakePURLString(tc.ecosystem, tc.packageID, "1.2.3")
|
||||
}
|
||||
if packagePURL == "" || versionPURL == "" {
|
||||
b.Fatal("empty PURL")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
type benchmarkNPMServer struct {
|
||||
client *http.Client
|
||||
requestURL string
|
||||
db *database.DB
|
||||
versionPURL string
|
||||
filename string
|
||||
}
|
||||
|
||||
func newBenchmarkNPMServer(b *testing.B) *benchmarkNPMServer {
|
||||
b.Helper()
|
||||
|
||||
ctx := context.Background()
|
||||
dir := b.TempDir()
|
||||
db, err := database.Create(filepath.Join(dir, "benchmark.db"))
|
||||
if err != nil {
|
||||
b.Fatalf("create database: %v", err)
|
||||
}
|
||||
b.Cleanup(func() { _ = db.Close() })
|
||||
|
||||
store, err := storage.OpenBucket(ctx, "file://"+filepath.Join(dir, "cache"))
|
||||
if err != nil {
|
||||
b.Fatalf("open storage: %v", err)
|
||||
}
|
||||
b.Cleanup(func() { _ = store.Close() })
|
||||
|
||||
content := bytes.Repeat([]byte("x"), benchmarkArtifactSize)
|
||||
storagePath := storage.ArtifactPath("npm", "", "lodash", "4.17.21", "lodash-4.17.21.tgz")
|
||||
size, hash, err := store.Store(ctx, storagePath, bytes.NewReader(content))
|
||||
if err != nil {
|
||||
b.Fatalf("store artifact: %v", err)
|
||||
}
|
||||
|
||||
pkg := &database.Package{PURL: "pkg:npm/lodash", Ecosystem: "npm", Name: "lodash"}
|
||||
if err := db.UpsertPackage(pkg); err != nil {
|
||||
b.Fatalf("seed package: %v", err)
|
||||
}
|
||||
version := &database.Version{PURL: "pkg:npm/lodash@4.17.21", PackagePURL: pkg.PURL}
|
||||
if err := db.UpsertVersion(version); err != nil {
|
||||
b.Fatalf("seed version: %v", err)
|
||||
}
|
||||
artifact := &database.Artifact{
|
||||
VersionPURL: version.PURL,
|
||||
Filename: "lodash-4.17.21.tgz",
|
||||
UpstreamURL: "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
|
||||
StoragePath: sql.NullString{String: storagePath, Valid: true},
|
||||
ContentHash: sql.NullString{String: hash, Valid: true},
|
||||
Size: sql.NullInt64{Int64: size, Valid: true},
|
||||
ContentType: sql.NullString{String: "application/gzip", Valid: true},
|
||||
FetchedAt: sql.NullTime{Time: time.Now(), Valid: true},
|
||||
}
|
||||
if err := db.UpsertArtifact(artifact); err != nil {
|
||||
b.Fatalf("seed artifact: %v", err)
|
||||
}
|
||||
|
||||
logger := slog.New(slog.NewTextHandler(io.Discard, nil))
|
||||
proxy := NewProxy(db, store, &mockFetcher{}, fetch.NewResolver(), logger)
|
||||
handler := NewNPMHandler(proxy, "http://proxy.example", "https://registry.npmjs.org")
|
||||
server := httptest.NewServer(handler.Routes())
|
||||
b.Cleanup(server.Close)
|
||||
client := server.Client()
|
||||
return &benchmarkNPMServer{
|
||||
client: client,
|
||||
requestURL: server.URL + "/lodash/-/lodash-4.17.21.tgz",
|
||||
db: db,
|
||||
versionPURL: version.PURL,
|
||||
filename: artifact.Filename,
|
||||
}
|
||||
}
|
||||
|
||||
func (s *benchmarkNPMServer) request() error {
|
||||
resp, err := s.client.Get(s.requestURL)
|
||||
if err != nil {
|
||||
return fmt.Errorf("GET cached artifact: %w", err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return fmt.Errorf("GET cached artifact status = %d, want %d", resp.StatusCode, http.StatusOK)
|
||||
}
|
||||
n, err := io.Copy(io.Discard, resp.Body)
|
||||
if err != nil {
|
||||
return fmt.Errorf("read cached artifact: %w", err)
|
||||
}
|
||||
if n != benchmarkArtifactSize {
|
||||
return fmt.Errorf("cached artifact size = %d, want %d", n, benchmarkArtifactSize)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *benchmarkNPMServer) hitCount(b *testing.B) int64 {
|
||||
b.Helper()
|
||||
artifact, err := s.db.GetArtifact(s.versionPURL, s.filename)
|
||||
if err != nil {
|
||||
b.Fatalf("get artifact hit count: %v", err)
|
||||
}
|
||||
return artifact.HitCount
|
||||
}
|
||||
|
||||
func benchmarkNPMArtifactCacheHitHTTP(b *testing.B, parallel bool) {
|
||||
server := newBenchmarkNPMServer(b)
|
||||
if err := server.request(); err != nil {
|
||||
b.Fatal(err)
|
||||
}
|
||||
startHits := server.hitCount(b)
|
||||
|
||||
b.SetBytes(benchmarkArtifactSize)
|
||||
b.ReportAllocs()
|
||||
b.ResetTimer()
|
||||
if parallel {
|
||||
b.RunParallel(func(pb *testing.PB) {
|
||||
for pb.Next() {
|
||||
if err := server.request(); err != nil {
|
||||
b.Error(err)
|
||||
return
|
||||
}
|
||||
}
|
||||
})
|
||||
} else {
|
||||
for b.Loop() {
|
||||
if err := server.request(); err != nil {
|
||||
b.Fatal(err)
|
||||
}
|
||||
}
|
||||
}
|
||||
b.StopTimer()
|
||||
|
||||
if hitCount := server.hitCount(b) - startHits; hitCount != int64(b.N) {
|
||||
b.Fatalf("new artifact hits = %d, want %d", hitCount, b.N)
|
||||
}
|
||||
b.ReportMetric(float64(b.N)/b.Elapsed().Seconds(), "requests/s")
|
||||
}
|
||||
|
||||
func BenchmarkNPMArtifactCacheHitHTTP(b *testing.B) {
|
||||
benchmarkNPMArtifactCacheHitHTTP(b, false)
|
||||
}
|
||||
|
||||
func BenchmarkNPMArtifactCacheHitHTTPParallel(b *testing.B) {
|
||||
benchmarkNPMArtifactCacheHitHTTP(b, true)
|
||||
}
|
||||
|
|
@ -3,34 +3,24 @@ package handler
|
|||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"crypto/sha256"
|
||||
"database/sql"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"log/slog"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/artifacts"
|
||||
"github.com/git-pkgs/proxy/internal/config"
|
||||
"github.com/git-pkgs/proxy/internal/database"
|
||||
"github.com/git-pkgs/proxy/internal/metrics"
|
||||
"github.com/git-pkgs/proxy/internal/storage"
|
||||
"github.com/git-pkgs/purl"
|
||||
"github.com/git-pkgs/registries/fetch"
|
||||
"github.com/opencontainers/go-digest"
|
||||
"github.com/prometheus/client_golang/prometheus"
|
||||
"github.com/prometheus/client_golang/prometheus/testutil"
|
||||
dto "github.com/prometheus/client_model/go"
|
||||
)
|
||||
|
||||
// mockStorage implements storage.Storage for testing.
|
||||
type mockStorage struct {
|
||||
mu sync.Mutex
|
||||
files map[string][]byte
|
||||
storeErr error
|
||||
openErr error
|
||||
|
|
@ -43,8 +33,6 @@ func newMockStorage() *mockStorage {
|
|||
}
|
||||
|
||||
func (s *mockStorage) Store(_ context.Context, path string, r io.Reader) (int64, string, error) {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
if s.storeErr != nil {
|
||||
return 0, "", s.storeErr
|
||||
}
|
||||
|
|
@ -53,12 +41,10 @@ func (s *mockStorage) Store(_ context.Context, path string, r io.Reader) (int64,
|
|||
return 0, "", err
|
||||
}
|
||||
s.files[path] = data
|
||||
return int64(len(data)), sha256Hex(string(data)), nil
|
||||
return int64(len(data)), "fakehash123", nil
|
||||
}
|
||||
|
||||
func (s *mockStorage) Open(_ context.Context, path string) (io.ReadCloser, error) {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
if s.openErr != nil {
|
||||
return nil, s.openErr
|
||||
}
|
||||
|
|
@ -70,28 +56,16 @@ func (s *mockStorage) Open(_ context.Context, path string) (io.ReadCloser, error
|
|||
}
|
||||
|
||||
func (s *mockStorage) Exists(_ context.Context, path string) (bool, error) {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
_, ok := s.files[path]
|
||||
return ok, nil
|
||||
}
|
||||
|
||||
func (s *mockStorage) Delete(ctx context.Context, path string) error {
|
||||
// Real backends (S3/GCS SDKs) fail fast on an already-cancelled
|
||||
// context; mirror that here so tests can catch cleanup calls that
|
||||
// forgot to detach from a cancelled client context.
|
||||
if err := ctx.Err(); err != nil {
|
||||
return err
|
||||
}
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
func (s *mockStorage) Delete(_ context.Context, path string) error {
|
||||
delete(s.files, path)
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *mockStorage) Size(_ context.Context, path string) (int64, error) {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
data, ok := s.files[path]
|
||||
if !ok {
|
||||
return 0, storage.ErrNotFound
|
||||
|
|
@ -100,8 +74,6 @@ func (s *mockStorage) Size(_ context.Context, path string) (int64, error) {
|
|||
}
|
||||
|
||||
func (s *mockStorage) UsedSpace(_ context.Context) (int64, error) {
|
||||
s.mu.Lock()
|
||||
defer s.mu.Unlock()
|
||||
var total int64
|
||||
for _, data := range s.files {
|
||||
total += int64(len(data))
|
||||
|
|
@ -123,35 +95,21 @@ func (s *mockStorage) URL() string { return "mem://" }
|
|||
|
||||
func (s *mockStorage) Close() error { return nil }
|
||||
|
||||
// mockFetcher implements fetch.FetcherInterface for testing. Recording is
|
||||
// locked because coalescing tests call the handler from many goroutines; tests
|
||||
// read the recorded fields only after those calls have returned.
|
||||
// mockFetcher implements fetch.FetcherInterface for testing.
|
||||
type mockFetcher struct {
|
||||
artifact *fetch.Artifact
|
||||
fetchErr error
|
||||
fetchErrByURL map[string]error
|
||||
|
||||
mu sync.Mutex
|
||||
fetchCalled bool
|
||||
fetchedURL string
|
||||
fetchedHeader http.Header
|
||||
}
|
||||
|
||||
func (f *mockFetcher) Fetch(ctx context.Context, url string) (*fetch.Artifact, error) {
|
||||
return f.FetchWithHeaders(ctx, url, nil)
|
||||
}
|
||||
|
||||
func (f *mockFetcher) FetchWithHeaders(_ context.Context, url string, headers http.Header) (*fetch.Artifact, error) {
|
||||
f.mu.Lock()
|
||||
func (f *mockFetcher) FetchWithHeaders(_ context.Context, url string, _ http.Header) (*fetch.Artifact, error) {
|
||||
f.fetchCalled = true
|
||||
f.fetchedURL = url
|
||||
f.fetchedHeader = headers.Clone()
|
||||
f.mu.Unlock()
|
||||
if f.fetchErrByURL != nil {
|
||||
if err, ok := f.fetchErrByURL[url]; ok {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
if f.fetchErr != nil {
|
||||
return nil, f.fetchErr
|
||||
}
|
||||
|
|
@ -163,7 +121,7 @@ func (f *mockFetcher) Head(_ context.Context, _ string) (int64, string, error) {
|
|||
}
|
||||
|
||||
// setupTestProxy creates a Proxy with a real DB (SQLite in temp dir) and mock storage/fetcher.
|
||||
func setupTestProxy(t testing.TB) (*Proxy, *database.DB, *mockStorage, *mockFetcher) {
|
||||
func setupTestProxy(t *testing.T) (*Proxy, *database.DB, *mockStorage, *mockFetcher) {
|
||||
t.Helper()
|
||||
|
||||
dir := t.TempDir()
|
||||
|
|
@ -182,35 +140,12 @@ func setupTestProxy(t testing.TB) (*Proxy, *database.DB, *mockStorage, *mockFetc
|
|||
return proxy, db, store, fetcher
|
||||
}
|
||||
|
||||
func histogramSampleCount(t testing.TB, observer prometheus.Observer) uint64 {
|
||||
t.Helper()
|
||||
metric, ok := observer.(prometheus.Metric)
|
||||
if !ok {
|
||||
t.Fatal("observer does not implement prometheus.Metric")
|
||||
}
|
||||
value := &dto.Metric{}
|
||||
if err := metric.Write(value); err != nil {
|
||||
t.Fatalf("writing Prometheus metric: %v", err)
|
||||
}
|
||||
return value.GetHistogram().GetSampleCount()
|
||||
}
|
||||
|
||||
func testArtifact(content, packageURL, filename, mediaType string) artifacts.Artifact {
|
||||
return artifacts.Artifact{
|
||||
PURL: packageURL,
|
||||
Digest: digest.Digest("sha256:" + sha256Hex(content)),
|
||||
Size: int64(len(content)),
|
||||
Filename: filename,
|
||||
MediaType: mediaType,
|
||||
}
|
||||
}
|
||||
|
||||
// seedPackage creates a package, version, and cached artifact in the test DB and storage.
|
||||
func seedPackage(t testing.TB, db *database.DB, store *mockStorage, ecosystem, name, version, filename, content string) {
|
||||
func seedPackage(t *testing.T, db *database.DB, store *mockStorage, ecosystem, name, version, filename, content string) {
|
||||
t.Helper()
|
||||
|
||||
pkg := &database.Package{
|
||||
PURL: purl.MakePURLString(ecosystem, name, ""),
|
||||
PURL: fmt.Sprintf("pkg:%s/%s", ecosystem, name),
|
||||
Ecosystem: ecosystem,
|
||||
Name: name,
|
||||
}
|
||||
|
|
@ -218,7 +153,7 @@ func seedPackage(t testing.TB, db *database.DB, store *mockStorage, ecosystem, n
|
|||
t.Fatalf("failed to upsert package: %v", err)
|
||||
}
|
||||
|
||||
versionPURL := purl.MakePURLString(ecosystem, name, version)
|
||||
versionPURL := fmt.Sprintf("pkg:%s/%s@%s", ecosystem, name, version)
|
||||
ver := &database.Version{
|
||||
PURL: versionPURL,
|
||||
PackagePURL: pkg.PURL,
|
||||
|
|
@ -229,14 +164,13 @@ func seedPackage(t testing.TB, db *database.DB, store *mockStorage, ecosystem, n
|
|||
|
||||
storagePath := storage.ArtifactPath(ecosystem, "", name, version, filename)
|
||||
store.files[storagePath] = []byte(content)
|
||||
sharedArtifact := testArtifact(content, versionPURL, filename, "application/octet-stream")
|
||||
|
||||
art := &database.Artifact{
|
||||
VersionPURL: versionPURL,
|
||||
Filename: filename,
|
||||
UpstreamURL: "https://example.com/" + filename,
|
||||
StoragePath: sql.NullString{String: storagePath, Valid: true},
|
||||
ContentHash: sql.NullString{String: sharedArtifact.Digest.Encoded(), Valid: true},
|
||||
ContentHash: sql.NullString{String: "abc123", Valid: true},
|
||||
Size: sql.NullInt64{Int64: int64(len(content)), Valid: true},
|
||||
ContentType: sql.NullString{String: "application/octet-stream", Valid: true},
|
||||
FetchedAt: sql.NullTime{Time: time.Now(), Valid: true},
|
||||
|
|
@ -322,83 +256,16 @@ func TestGetOrFetchArtifact_CacheHit(t *testing.T) {
|
|||
if string(body) != "cached content" {
|
||||
t.Errorf("got body %q, want %q", body, "cached content")
|
||||
}
|
||||
if result.Artifact.MediaType != "application/octet-stream" {
|
||||
t.Errorf("got content type %q, want %q", result.Artifact.MediaType, "application/octet-stream")
|
||||
if result.ContentType != "application/octet-stream" {
|
||||
t.Errorf("got content type %q, want %q", result.ContentType, "application/octet-stream")
|
||||
}
|
||||
if result.Artifact.Digest.Encoded() != sha256Hex("cached content") {
|
||||
t.Errorf("got digest %q, want %q", result.Artifact.Digest.Encoded(), sha256Hex("cached content"))
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetCachedArtifactRejectsMalformedIntegrityMetadata(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
malformedHash string
|
||||
malformedIntegrity string
|
||||
}{
|
||||
{name: "content hash", malformedHash: "abc123"},
|
||||
{name: "native integrity", malformedIntegrity: "sha512-abc123"},
|
||||
}
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
assertMalformedCacheRejected(t, test.malformedHash, test.malformedIntegrity)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func assertMalformedCacheRejected(t *testing.T, malformedHash, malformedIntegrity string) {
|
||||
t.Helper()
|
||||
proxy, db, store, _ := setupTestProxy(t)
|
||||
const (
|
||||
packageName = "broken"
|
||||
version = "1.0.0"
|
||||
filename = "broken-1.0.0.tgz"
|
||||
)
|
||||
seedPackage(t, db, store, "npm", packageName, version, filename, "cached content")
|
||||
versionPURL := purl.MakePURLString("npm", packageName, version)
|
||||
|
||||
if malformedHash != "" {
|
||||
artifact, err := db.GetArtifact(versionPURL, filename)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
artifact.ContentHash = sql.NullString{String: malformedHash, Valid: true}
|
||||
if err := db.UpsertArtifact(artifact); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
if malformedIntegrity != "" {
|
||||
versionRecord := &database.Version{
|
||||
PURL: versionPURL,
|
||||
PackagePURL: purl.MakePURLString("npm", packageName, ""),
|
||||
Integrity: sql.NullString{String: malformedIntegrity, Valid: true},
|
||||
}
|
||||
if err := db.UpsertVersion(versionRecord); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
|
||||
proxy.DirectServe = true
|
||||
store.signedURL = "https://cache.example/broken"
|
||||
result, err := proxy.GetCachedArtifact(context.Background(), "npm", packageName, version, filename)
|
||||
if err != nil {
|
||||
t.Fatalf("GetCachedArtifact: %v", err)
|
||||
}
|
||||
if result != nil {
|
||||
t.Errorf("GetCachedArtifact = %+v, want nil", result)
|
||||
}
|
||||
artifact, err := db.GetArtifact(versionPURL, filename)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if artifact.StoragePath.Valid {
|
||||
t.Error("unusable cache record retained its storage path")
|
||||
if result.Hash != "abc123" {
|
||||
t.Errorf("got hash %q, want %q", result.Hash, "abc123")
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetOrFetchArtifact_CacheMiss_NoPackage(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
missesBefore := testutil.ToFloat64(metrics.CacheMisses.WithLabelValues("npm"))
|
||||
|
||||
// The resolver will fail because "nonexistent" isn't a real package,
|
||||
// but we're testing that it tries to fetch (doesn't return from cache).
|
||||
|
|
@ -408,10 +275,6 @@ func TestGetOrFetchArtifact_CacheMiss_NoPackage(t *testing.T) {
|
|||
if err == nil {
|
||||
t.Fatal("expected error for uncached package")
|
||||
}
|
||||
missesAfter := testutil.ToFloat64(metrics.CacheMisses.WithLabelValues("npm"))
|
||||
if diff := missesAfter - missesBefore; diff != 1 {
|
||||
t.Errorf("cache misses delta = %.0f, want 1", diff)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetOrFetchArtifactFromURL_CacheMiss_StorageMissing(t *testing.T) {
|
||||
|
|
@ -427,7 +290,7 @@ func TestGetOrFetchArtifactFromURL_CacheMiss_StorageMissing(t *testing.T) {
|
|||
Filename: "missing-1.0.0.tgz",
|
||||
UpstreamURL: "https://example.com/missing.tgz",
|
||||
StoragePath: sql.NullString{String: "nonexistent/path.tgz", Valid: true},
|
||||
ContentHash: sql.NullString{String: sha256Hex("missing content"), Valid: true},
|
||||
ContentHash: sql.NullString{String: "hash", Valid: true},
|
||||
Size: sql.NullInt64{Int64: 100, Valid: true},
|
||||
ContentType: sql.NullString{String: "application/octet-stream", Valid: true},
|
||||
FetchedAt: sql.NullTime{Time: time.Now(), Valid: true},
|
||||
|
|
@ -460,28 +323,6 @@ func TestGetOrFetchArtifactFromURL_CacheMiss_StorageMissing(t *testing.T) {
|
|||
}
|
||||
}
|
||||
|
||||
func TestArtifactCacheRejectsUnsupportedPackageIdentity(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
|
||||
_, err := proxy.GetCachedArtifact(
|
||||
context.Background(), "swift", "apple/example", "1.2.3", "example-1.2.3.zip",
|
||||
)
|
||||
if !errors.Is(err, errUnsupportedPackageIdentity) {
|
||||
t.Fatalf("GetCachedArtifact() error = %v, want unsupported package identity", err)
|
||||
}
|
||||
|
||||
_, err = proxy.GetOrFetchArtifactFromURL(
|
||||
context.Background(), "swift", "apple/example", "1.2.3", "example-1.2.3.zip",
|
||||
"https://registry.example/apple/example/1.2.3.zip",
|
||||
)
|
||||
if !errors.Is(err, errUnsupportedPackageIdentity) {
|
||||
t.Fatalf("GetOrFetchArtifactFromURL() error = %v, want unsupported package identity", err)
|
||||
}
|
||||
if fetcher.fetchCalled {
|
||||
t.Error("unsupported package identity reached the artifact fetcher")
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetOrFetchArtifact_DirectServe_Redirect(t *testing.T) {
|
||||
proxy, db, store, fetcher := setupTestProxy(t)
|
||||
seedPackage(t, db, store, "npm", "lodash", "4.17.21", "lodash-4.17.21.tgz", "cached content")
|
||||
|
|
@ -651,9 +492,7 @@ func TestServeArtifact_Redirect(t *testing.T) {
|
|||
w := httptest.NewRecorder()
|
||||
ServeArtifact(w, &CacheResult{
|
||||
RedirectURL: "https://bucket.s3.amazonaws.com/file?sig=abc",
|
||||
Artifact: artifacts.Artifact{
|
||||
Digest: digest.Digest("sha256:" + strings.Repeat("a", sha256.Size*2)),
|
||||
},
|
||||
Hash: "abc123",
|
||||
Cached: true,
|
||||
})
|
||||
|
||||
|
|
@ -663,8 +502,8 @@ func TestServeArtifact_Redirect(t *testing.T) {
|
|||
if loc := w.Header().Get("Location"); loc != "https://bucket.s3.amazonaws.com/file?sig=abc" {
|
||||
t.Errorf("Location = %q", loc)
|
||||
}
|
||||
if etag := w.Header().Get("ETag"); etag != `"`+strings.Repeat("a", sha256.Size*2)+`"` {
|
||||
t.Errorf("ETag = %q", etag)
|
||||
if etag := w.Header().Get("ETag"); etag != `"abc123"` {
|
||||
t.Errorf("ETag = %q, want %q", etag, `"abc123"`)
|
||||
}
|
||||
if cl := w.Header().Get("Content-Length"); cl != "" {
|
||||
t.Errorf("Content-Length should not be set on redirect, got %q", cl)
|
||||
|
|
@ -675,12 +514,9 @@ func TestServeArtifact_Stream(t *testing.T) {
|
|||
w := httptest.NewRecorder()
|
||||
ServeArtifact(w, &CacheResult{
|
||||
Reader: io.NopCloser(strings.NewReader("payload")),
|
||||
Artifact: testArtifact(
|
||||
"payload",
|
||||
"pkg:npm/example@1.0.0",
|
||||
"example.tgz",
|
||||
"application/octet-stream",
|
||||
),
|
||||
Size: 7,
|
||||
ContentType: "application/octet-stream",
|
||||
Hash: "abc123",
|
||||
})
|
||||
|
||||
if w.Code != http.StatusOK {
|
||||
|
|
@ -697,7 +533,6 @@ func TestServeArtifact_Stream(t *testing.T) {
|
|||
func TestGetOrFetchArtifactFromURL_CacheHit(t *testing.T) {
|
||||
proxy, db, store, fetcher := setupTestProxy(t)
|
||||
seedPackage(t, db, store, "pypi", "requests", "2.28.0", "requests-2.28.0.tar.gz", "pypi content")
|
||||
missesBefore := testutil.ToFloat64(metrics.CacheMisses.WithLabelValues("pypi"))
|
||||
|
||||
result, err := proxy.GetOrFetchArtifactFromURL(context.Background(), "pypi", "requests", "2.28.0", "requests-2.28.0.tar.gz", "https://pypi.org/files/requests-2.28.0.tar.gz")
|
||||
if err != nil {
|
||||
|
|
@ -711,18 +546,10 @@ func TestGetOrFetchArtifactFromURL_CacheHit(t *testing.T) {
|
|||
if fetcher.fetchCalled {
|
||||
t.Error("fetcher should not be called on cache hit")
|
||||
}
|
||||
missesAfter := testutil.ToFloat64(metrics.CacheMisses.WithLabelValues("pypi"))
|
||||
if diff := missesAfter - missesBefore; diff != 0 {
|
||||
t.Errorf("cache misses delta = %.0f, want 0", diff)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetOrFetchArtifactFromURL_CacheMiss(t *testing.T) {
|
||||
proxy, _, store, fetcher := setupTestProxy(t)
|
||||
missesBefore := testutil.ToFloat64(metrics.CacheMisses.WithLabelValues("pypi"))
|
||||
fetchesBefore := histogramSampleCount(t, metrics.UpstreamFetchDuration.WithLabelValues("pypi"))
|
||||
writesBefore := histogramSampleCount(t, metrics.StorageOperationDuration.WithLabelValues("write"))
|
||||
readsBefore := histogramSampleCount(t, metrics.StorageOperationDuration.WithLabelValues("read"))
|
||||
|
||||
fetcher.artifact = &fetch.Artifact{
|
||||
Body: io.NopCloser(strings.NewReader("fetched content")),
|
||||
|
|
@ -749,43 +576,17 @@ func TestGetOrFetchArtifactFromURL_CacheMiss(t *testing.T) {
|
|||
if string(body) != "fetched content" {
|
||||
t.Errorf("got body %q, want %q", body, "fetched content")
|
||||
}
|
||||
if err := result.Artifact.Validate(); err != nil {
|
||||
t.Errorf("Artifact.Validate() error = %v", err)
|
||||
}
|
||||
if result.Artifact.PURL != "pkg:pypi/newpkg@1.0.0" {
|
||||
t.Errorf("PURL = %q", result.Artifact.PURL)
|
||||
}
|
||||
if result.Artifact.Size != int64(len("fetched content")) {
|
||||
t.Errorf("Size = %d", result.Artifact.Size)
|
||||
}
|
||||
if result.Artifact.MediaType != "application/gzip" {
|
||||
t.Errorf("MediaType = %q", result.Artifact.MediaType)
|
||||
}
|
||||
|
||||
// Verify it was stored
|
||||
storagePath := storage.ArtifactPath("pypi", "", "newpkg", "1.0.0", "newpkg-1.0.0.tar.gz")
|
||||
if _, ok := store.files[storagePath]; !ok {
|
||||
t.Error("artifact was not stored in storage")
|
||||
}
|
||||
missesAfter := testutil.ToFloat64(metrics.CacheMisses.WithLabelValues("pypi"))
|
||||
if diff := missesAfter - missesBefore; diff != 1 {
|
||||
t.Errorf("cache misses delta = %.0f, want 1", diff)
|
||||
}
|
||||
if diff := histogramSampleCount(t, metrics.UpstreamFetchDuration.WithLabelValues("pypi")) - fetchesBefore; diff != 1 {
|
||||
t.Errorf("upstream fetch observations delta = %d, want 1", diff)
|
||||
}
|
||||
if diff := histogramSampleCount(t, metrics.StorageOperationDuration.WithLabelValues("write")) - writesBefore; diff != 1 {
|
||||
t.Errorf("storage write observations delta = %d, want 1", diff)
|
||||
}
|
||||
if diff := histogramSampleCount(t, metrics.StorageOperationDuration.WithLabelValues("read")) - readsBefore; diff != 1 {
|
||||
t.Errorf("storage read observations delta = %d, want 1", diff)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetOrFetchArtifactFromURL_FetchError(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
fetcher.fetchErr = errors.New("connection refused")
|
||||
errorsBefore := testutil.ToFloat64(metrics.UpstreamErrors.WithLabelValues("pypi", "fetch_failed"))
|
||||
|
||||
_, err := proxy.GetOrFetchArtifactFromURL(context.Background(), "pypi", "fail", "1.0.0", "fail-1.0.0.tar.gz", "https://pypi.org/files/fail-1.0.0.tar.gz")
|
||||
if err == nil {
|
||||
|
|
@ -794,15 +595,11 @@ func TestGetOrFetchArtifactFromURL_FetchError(t *testing.T) {
|
|||
if !strings.Contains(err.Error(), "fetching from upstream") {
|
||||
t.Errorf("expected upstream error, got: %v", err)
|
||||
}
|
||||
if diff := testutil.ToFloat64(metrics.UpstreamErrors.WithLabelValues("pypi", "fetch_failed")) - errorsBefore; diff != 1 {
|
||||
t.Errorf("upstream errors delta = %.0f, want 1", diff)
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetOrFetchArtifactFromURL_StoreError(t *testing.T) {
|
||||
proxy, _, store, fetcher := setupTestProxy(t)
|
||||
store.storeErr = errors.New("disk full")
|
||||
errorsBefore := testutil.ToFloat64(metrics.StorageErrors.WithLabelValues("write"))
|
||||
fetcher.artifact = &fetch.Artifact{
|
||||
Body: io.NopCloser(strings.NewReader("data")),
|
||||
ContentType: "application/gzip",
|
||||
|
|
@ -815,15 +612,14 @@ func TestGetOrFetchArtifactFromURL_StoreError(t *testing.T) {
|
|||
if !strings.Contains(err.Error(), "storing artifact") {
|
||||
t.Errorf("expected storage error, got: %v", err)
|
||||
}
|
||||
if diff := testutil.ToFloat64(metrics.StorageErrors.WithLabelValues("write")) - errorsBefore; diff != 1 {
|
||||
t.Errorf("storage errors delta = %.0f, want 1", diff)
|
||||
}
|
||||
}
|
||||
|
||||
func TestServeArtifact(t *testing.T) {
|
||||
result := &CacheResult{
|
||||
Reader: io.NopCloser(strings.NewReader("file contents")),
|
||||
Artifact: testArtifact("file contents", "pkg:npm/example@1.0.0", "example.tgz", "application/gzip"),
|
||||
Size: 13,
|
||||
ContentType: "application/gzip",
|
||||
Hash: "sha256abc",
|
||||
Cached: true,
|
||||
}
|
||||
|
||||
|
|
@ -839,9 +635,8 @@ func TestServeArtifact(t *testing.T) {
|
|||
if w.Header().Get("Content-Length") != "13" {
|
||||
t.Errorf("Content-Length = %q, want %q", w.Header().Get("Content-Length"), "13")
|
||||
}
|
||||
wantETag := `"` + result.Artifact.Digest.Encoded() + `"`
|
||||
if w.Header().Get("ETag") != wantETag {
|
||||
t.Errorf("ETag = %q, want %q", w.Header().Get("ETag"), wantETag)
|
||||
if w.Header().Get("ETag") != `"sha256abc"` {
|
||||
t.Errorf("ETag = %q, want %q", w.Header().Get("ETag"), `"sha256abc"`)
|
||||
}
|
||||
if w.Body.String() != "file contents" {
|
||||
t.Errorf("body = %q, want %q", w.Body.String(), "file contents")
|
||||
|
|
@ -1076,8 +871,6 @@ func TestProxyCached_NoValidators_OmitsHeaders(t *testing.T) {
|
|||
}
|
||||
|
||||
func TestFetchOrCacheMetadata_TTL_ServesFreshFromCache(t *testing.T) {
|
||||
hitsBefore := testutil.ToFloat64(metrics.CacheHits.WithLabelValues("test"))
|
||||
missesBefore := testutil.ToFloat64(metrics.CacheMisses.WithLabelValues("test"))
|
||||
upstreamHits := 0
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
upstreamHits++
|
||||
|
|
@ -1104,12 +897,6 @@ func TestFetchOrCacheMetadata_TTL_ServesFreshFromCache(t *testing.T) {
|
|||
if upstreamHits != 1 {
|
||||
t.Fatalf("expected 1 upstream hit, got %d", upstreamHits)
|
||||
}
|
||||
if diff := testutil.ToFloat64(metrics.CacheMisses.WithLabelValues("test")) - missesBefore; diff != 1 {
|
||||
t.Errorf("cache misses delta after first request = %.0f, want 1", diff)
|
||||
}
|
||||
if diff := testutil.ToFloat64(metrics.CacheHits.WithLabelValues("test")) - hitsBefore; diff != 0 {
|
||||
t.Errorf("cache hits delta after first request = %.0f, want 0", diff)
|
||||
}
|
||||
|
||||
// Second request within TTL should serve from cache without hitting upstream
|
||||
body, _, err = proxy.FetchOrCacheMetadata(ctx, "test", "ttl-pkg", upstream.URL+"/pkg")
|
||||
|
|
@ -1122,16 +909,9 @@ func TestFetchOrCacheMetadata_TTL_ServesFreshFromCache(t *testing.T) {
|
|||
if upstreamHits != 1 {
|
||||
t.Errorf("expected upstream to still be hit only once, got %d", upstreamHits)
|
||||
}
|
||||
if diff := testutil.ToFloat64(metrics.CacheHits.WithLabelValues("test")) - hitsBefore; diff != 1 {
|
||||
t.Errorf("cache hits delta after second request = %.0f, want 1", diff)
|
||||
}
|
||||
if diff := testutil.ToFloat64(metrics.CacheMisses.WithLabelValues("test")) - missesBefore; diff != 1 {
|
||||
t.Errorf("cache misses delta after second request = %.0f, want 1", diff)
|
||||
}
|
||||
}
|
||||
|
||||
func TestFetchOrCacheMetadata_TTL_Zero_AlwaysRevalidates(t *testing.T) {
|
||||
missesBefore := testutil.ToFloat64(metrics.CacheMisses.WithLabelValues("test"))
|
||||
upstreamHits := 0
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
upstreamHits++
|
||||
|
|
@ -1160,40 +940,6 @@ func TestFetchOrCacheMetadata_TTL_Zero_AlwaysRevalidates(t *testing.T) {
|
|||
if upstreamHits != 2 {
|
||||
t.Errorf("expected 2 upstream hits with TTL=0, got %d", upstreamHits)
|
||||
}
|
||||
missesAfter := testutil.ToFloat64(metrics.CacheMisses.WithLabelValues("test"))
|
||||
if diff := missesAfter - missesBefore; diff != 2 {
|
||||
t.Errorf("cache misses delta = %.0f, want 2", diff)
|
||||
}
|
||||
}
|
||||
|
||||
func TestFetchOrCacheMetadata_CacheDisabledDoesNotRecordMetrics(t *testing.T) {
|
||||
const ecosystem = "metadata-disabled"
|
||||
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = w.Write([]byte(`{"v":1}`))
|
||||
}))
|
||||
t.Cleanup(upstream.Close)
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
|
||||
hitsBefore := testutil.ToFloat64(metrics.CacheHits.WithLabelValues(ecosystem))
|
||||
missesBefore := testutil.ToFloat64(metrics.CacheMisses.WithLabelValues(ecosystem))
|
||||
|
||||
_, _, err := proxy.FetchOrCacheMetadata(context.Background(), ecosystem, "pkg", upstream.URL+"/pkg")
|
||||
if err != nil {
|
||||
t.Fatalf("fetch metadata: %v", err)
|
||||
}
|
||||
|
||||
hitsAfter := testutil.ToFloat64(metrics.CacheHits.WithLabelValues(ecosystem))
|
||||
missesAfter := testutil.ToFloat64(metrics.CacheMisses.WithLabelValues(ecosystem))
|
||||
if diff := hitsAfter - hitsBefore; diff != 0 {
|
||||
t.Errorf("cache hits delta = %.0f, want 0", diff)
|
||||
}
|
||||
if diff := missesAfter - missesBefore; diff != 0 {
|
||||
t.Errorf("cache misses delta = %.0f, want 0", diff)
|
||||
}
|
||||
}
|
||||
|
||||
func TestProxyCached_StaleWarningHeader(t *testing.T) {
|
||||
|
|
@ -1258,33 +1004,3 @@ func TestProxyCached_FreshResponse_NoWarningHeader(t *testing.T) {
|
|||
t.Errorf("Warning should be empty for fresh response, got %q", got)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCanonicalPackagePURLMatchesConfig ensures the runtime cooldown lookup key
|
||||
// agrees with config.CooldownConfig.NormalizedPackages for the same package,
|
||||
// so a configured override is actually found regardless of how the user wrote it.
|
||||
func TestCanonicalPackagePURLMatchesConfig(t *testing.T) {
|
||||
tests := []struct {
|
||||
ecosystem string
|
||||
requestName string
|
||||
configKey string
|
||||
}{
|
||||
{"npm", "@babel/core", "pkg:npm/@babel/core"},
|
||||
{"npm", "@babel/core", "pkg:npm/%40babel/core"},
|
||||
{"npm", "@typescript/typescript-darwin-arm64", "pkg:npm/@typescript/typescript-darwin-arm64"},
|
||||
{"pypi", "Django", "pkg:pypi/Django"},
|
||||
{"pypi", "django", "pkg:pypi/Django"},
|
||||
{"composer", "symfony/console", "pkg:composer/Symfony/Console"},
|
||||
{"cargo", "serde", "pkg:cargo/serde"},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.ecosystem+"/"+tt.requestName+"<="+tt.configKey, func(t *testing.T) {
|
||||
cfg := config.CooldownConfig{Packages: map[string]string{tt.configKey: "1d"}}
|
||||
normalized := cfg.NormalizedPackages()
|
||||
|
||||
lookup := canonicalPackagePURL(tt.ecosystem, tt.requestName)
|
||||
if _, ok := normalized[lookup]; !ok {
|
||||
t.Errorf("lookup key %q not found in normalized config %v", lookup, normalized)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,364 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"crypto/sha256"
|
||||
"encoding/hex"
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"path"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"gopkg.in/yaml.v3"
|
||||
)
|
||||
|
||||
const (
|
||||
helmMetadataEcosystem = "helm"
|
||||
helmIndexFilename = "index.yaml"
|
||||
sha256HexLength = 64
|
||||
)
|
||||
|
||||
// HelmHandler serves read-only HTTP Helm chart repositories. Each configured
|
||||
// repository is mounted at /helm/{repository}/.
|
||||
type HelmHandler struct {
|
||||
proxy *Proxy
|
||||
proxyURL string
|
||||
repositories map[string]string
|
||||
}
|
||||
|
||||
// NewHelmHandler creates a Helm chart repository protocol handler.
|
||||
func NewHelmHandler(proxy *Proxy, proxyURL string, repositories map[string]string) *HelmHandler {
|
||||
h := &HelmHandler{
|
||||
proxyURL: strings.TrimSuffix(proxyURL, "/"),
|
||||
repositories: make(map[string]string, len(repositories)),
|
||||
proxy: proxy,
|
||||
}
|
||||
for name, repositoryURL := range repositories {
|
||||
h.repositories[name] = strings.TrimSuffix(repositoryURL, "/")
|
||||
}
|
||||
return h
|
||||
}
|
||||
|
||||
// Routes returns the HTTP handler for Helm chart repository requests.
|
||||
func (h *HelmHandler) Routes() http.Handler {
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("GET /{repository}/index.yaml", h.handleIndex)
|
||||
mux.HandleFunc("GET /{repository}/charts/{digest}/{filename}", h.handleChart)
|
||||
return mux
|
||||
}
|
||||
|
||||
func (h *HelmHandler) handleIndex(w http.ResponseWriter, r *http.Request) {
|
||||
repository, upstreamURL, ok := h.repositoryForRequest(r)
|
||||
if !ok {
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
|
||||
body, contentType, err := h.fetchIndex(r, repository, upstreamURL)
|
||||
if err != nil {
|
||||
h.serveIndexError(w, err)
|
||||
return
|
||||
}
|
||||
|
||||
rewritten, err := h.rewriteIndex(repository, upstreamURL, body)
|
||||
if err != nil {
|
||||
h.proxy.Logger.Warn("failed to rewrite Helm index", "repository", repository, "error", err)
|
||||
http.Error(w, "invalid Helm repository index", http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
|
||||
h.proxy.writeMetadataCachedResponse(w, r, helmMetadataEcosystem, h.indexCacheKey(repository, upstreamURL), rewritten, contentType)
|
||||
}
|
||||
|
||||
func (h *HelmHandler) handleChart(w http.ResponseWriter, r *http.Request) {
|
||||
repository, upstreamURL, ok := h.repositoryForRequest(r)
|
||||
if !ok {
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
|
||||
digest, ok := normalizeHelmDigest(r.PathValue("digest"))
|
||||
filename := r.PathValue("filename")
|
||||
if !ok || filename == "" || strings.Contains(filename, "/") || containsPathTraversal(filename) {
|
||||
http.Error(w, "invalid chart request", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
cached, err := h.proxy.GetCachedArtifact(r.Context(), helmMetadataEcosystem, repository, digest, filename)
|
||||
if err != nil {
|
||||
h.proxy.Logger.Error("failed to check Helm chart cache", "error", err)
|
||||
http.Error(w, "failed to check chart cache", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
if cached != nil {
|
||||
h.serveChart(w, r, repository, digest, filename, cached)
|
||||
return
|
||||
}
|
||||
|
||||
body, _, err := h.fetchIndex(r, repository, upstreamURL)
|
||||
if err != nil {
|
||||
h.serveIndexError(w, err)
|
||||
return
|
||||
}
|
||||
|
||||
downloadURL, err := h.findChartDownload(upstreamURL, body, digest, filename)
|
||||
if err != nil {
|
||||
if errors.Is(err, errHelmChartNotFound) {
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
h.proxy.Logger.Warn("failed to read Helm index", "repository", repository, "error", err)
|
||||
http.Error(w, "invalid Helm repository index", http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURL(
|
||||
r.Context(), helmMetadataEcosystem, repository, digest, filename, downloadURL)
|
||||
if err != nil {
|
||||
h.proxy.serveArtifactError(w, err, "failed to fetch chart")
|
||||
return
|
||||
}
|
||||
h.serveChart(w, r, repository, digest, filename, result)
|
||||
}
|
||||
|
||||
func (h *HelmHandler) serveChart(w http.ResponseWriter, r *http.Request, repository, digest, filename string, result *CacheResult) {
|
||||
if !strings.EqualFold(result.Artifact.Digest.Encoded(), digest) {
|
||||
if result.Reader != nil {
|
||||
_ = result.Reader.Close()
|
||||
}
|
||||
if clearErr := h.proxy.ClearCachedArtifact(r.Context(), helmMetadataEcosystem, repository, digest, filename); clearErr != nil {
|
||||
h.proxy.Logger.Warn("failed to clear Helm chart with invalid digest", "error", clearErr)
|
||||
}
|
||||
http.Error(w, "chart digest verification failed", http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
|
||||
if result.Artifact.MediaType == "" {
|
||||
w.Header().Set(headerContentType, "application/gzip")
|
||||
}
|
||||
ServeArtifact(w, result)
|
||||
}
|
||||
|
||||
func (h *HelmHandler) repositoryForRequest(r *http.Request) (name, upstreamURL string, ok bool) {
|
||||
name = r.PathValue("repository")
|
||||
upstreamURL, ok = h.repositories[name]
|
||||
return name, upstreamURL, ok
|
||||
}
|
||||
|
||||
func (h *HelmHandler) fetchIndex(r *http.Request, repository, upstreamURL string) ([]byte, string, error) {
|
||||
return h.proxy.FetchOrCacheMetadata(
|
||||
r.Context(),
|
||||
helmMetadataEcosystem,
|
||||
h.indexCacheKey(repository, upstreamURL),
|
||||
upstreamURL+"/"+helmIndexFilename,
|
||||
"application/x-yaml, text/yaml;q=0.9, */*;q=0.1",
|
||||
)
|
||||
}
|
||||
|
||||
func (h *HelmHandler) indexCacheKey(repository, upstreamURL string) string {
|
||||
identity := repository + "\x00" + upstreamURL
|
||||
digest := sha256.Sum256([]byte(identity))
|
||||
return hex.EncodeToString(digest[:])
|
||||
}
|
||||
|
||||
func (h *HelmHandler) serveIndexError(w http.ResponseWriter, err error) {
|
||||
if errors.Is(err, ErrUpstreamNotFound) {
|
||||
http.Error(w, "Helm repository not found", http.StatusNotFound)
|
||||
return
|
||||
}
|
||||
h.proxy.Logger.Error("failed to fetch Helm index", "error", err)
|
||||
http.Error(w, "failed to fetch Helm repository index", http.StatusBadGateway)
|
||||
}
|
||||
|
||||
func (h *HelmHandler) rewriteIndex(repository, upstreamURL string, body []byte) ([]byte, error) {
|
||||
document, entries, err := parseHelmIndex(body)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
for i := 0; i < len(entries.Content); i += 2 {
|
||||
chartName := entries.Content[i].Value
|
||||
releases := entries.Content[i+1]
|
||||
if releases.Kind != yaml.SequenceNode {
|
||||
return nil, fmt.Errorf("chart %q releases must be a sequence", chartName)
|
||||
}
|
||||
|
||||
filtered := make([]*yaml.Node, 0, len(releases.Content))
|
||||
for _, release := range releases.Content {
|
||||
chart, err := h.parseChartRelease(chartName, upstreamURL, release)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if h.chartOnCooldown(chartName, chart.created) {
|
||||
continue
|
||||
}
|
||||
for _, download := range chart.downloads {
|
||||
download.node.Value = h.chartProxyURL(repository, chart.digest, download.filename)
|
||||
}
|
||||
filtered = append(filtered, release)
|
||||
}
|
||||
releases.Content = filtered
|
||||
}
|
||||
|
||||
return yaml.Marshal(document)
|
||||
}
|
||||
|
||||
func (h *HelmHandler) findChartDownload(upstreamURL string, body []byte, digest, filename string) (string, error) {
|
||||
_, entries, err := parseHelmIndex(body)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
for i := 0; i < len(entries.Content); i += 2 {
|
||||
chartName := entries.Content[i].Value
|
||||
releases := entries.Content[i+1]
|
||||
if releases.Kind != yaml.SequenceNode {
|
||||
return "", fmt.Errorf("chart %q releases must be a sequence", chartName)
|
||||
}
|
||||
for _, release := range releases.Content {
|
||||
chart, err := h.parseChartRelease(chartName, upstreamURL, release)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
if chart.digest != digest || h.chartOnCooldown(chartName, chart.created) {
|
||||
continue
|
||||
}
|
||||
for _, download := range chart.downloads {
|
||||
if download.filename == filename {
|
||||
return download.url, nil
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return "", errHelmChartNotFound
|
||||
}
|
||||
|
||||
func (h *HelmHandler) chartOnCooldown(chartName string, created time.Time) bool {
|
||||
return !created.IsZero() && h.proxy.Cooldown != nil && h.proxy.Cooldown.Enabled() &&
|
||||
!h.proxy.Cooldown.IsAllowed(helmMetadataEcosystem, canonicalPackagePURL(helmMetadataEcosystem, chartName), created)
|
||||
}
|
||||
|
||||
type helmChartDownload struct {
|
||||
node *yaml.Node
|
||||
url string
|
||||
filename string
|
||||
}
|
||||
|
||||
type helmChartRelease struct {
|
||||
created time.Time
|
||||
digest string
|
||||
downloads []helmChartDownload
|
||||
}
|
||||
|
||||
var errHelmChartNotFound = errors.New("chart not found in Helm index")
|
||||
|
||||
func (h *HelmHandler) parseChartRelease(chartName, upstreamURL string, release *yaml.Node) (helmChartRelease, error) {
|
||||
digestNode := helmMappingValue(release, "digest")
|
||||
urlsNode := helmMappingValue(release, "urls")
|
||||
if digestNode == nil || urlsNode == nil || urlsNode.Kind != yaml.SequenceNode || len(urlsNode.Content) == 0 {
|
||||
return helmChartRelease{}, fmt.Errorf("chart %q has no digest or URLs", chartName)
|
||||
}
|
||||
digest, ok := normalizeHelmDigest(digestNode.Value)
|
||||
if !ok {
|
||||
return helmChartRelease{}, fmt.Errorf("chart %q has invalid digest", chartName)
|
||||
}
|
||||
|
||||
baseURL, err := url.Parse(upstreamURL + "/" + helmIndexFilename)
|
||||
if err != nil {
|
||||
return helmChartRelease{}, fmt.Errorf("parsing Helm repository URL: %w", err)
|
||||
}
|
||||
|
||||
chart := helmChartRelease{digest: digest}
|
||||
if createdNode := helmMappingValue(release, "created"); createdNode != nil && createdNode.Value != "" {
|
||||
chart.created, err = time.Parse(time.RFC3339Nano, createdNode.Value)
|
||||
if err != nil {
|
||||
return helmChartRelease{}, fmt.Errorf("chart %q has invalid creation time: %w", chartName, err)
|
||||
}
|
||||
}
|
||||
|
||||
for _, urlNode := range urlsNode.Content {
|
||||
if urlNode.Kind != yaml.ScalarNode {
|
||||
return helmChartRelease{}, fmt.Errorf("chart %q has invalid URL", chartName)
|
||||
}
|
||||
reference, err := url.Parse(urlNode.Value)
|
||||
if err != nil {
|
||||
return helmChartRelease{}, fmt.Errorf("parsing chart %q URL: %w", chartName, err)
|
||||
}
|
||||
downloadURL := baseURL.ResolveReference(reference)
|
||||
if (downloadURL.Scheme != "http" && downloadURL.Scheme != "https") || downloadURL.Host == "" {
|
||||
return helmChartRelease{}, fmt.Errorf("chart %q URL must be HTTP(S)", chartName)
|
||||
}
|
||||
filename := path.Base(downloadURL.Path)
|
||||
if filename == "." || filename == "/" || filename == "" || !strings.HasSuffix(filename, ".tgz") {
|
||||
return helmChartRelease{}, fmt.Errorf("chart %q URL must point to a .tgz file", chartName)
|
||||
}
|
||||
chart.downloads = append(chart.downloads, helmChartDownload{
|
||||
node: urlNode,
|
||||
url: downloadURL.String(),
|
||||
filename: filename,
|
||||
})
|
||||
}
|
||||
return chart, nil
|
||||
}
|
||||
|
||||
func (h *HelmHandler) chartProxyURL(repository, digest, filename string) string {
|
||||
return fmt.Sprintf("%s/helm/%s/charts/%s/%s", h.proxyURL,
|
||||
url.PathEscape(repository), digest, url.PathEscape(filename))
|
||||
}
|
||||
|
||||
func parseHelmIndex(body []byte) (*yaml.Node, *yaml.Node, error) {
|
||||
var document yaml.Node
|
||||
if err := yaml.Unmarshal(body, &document); err != nil {
|
||||
return nil, nil, fmt.Errorf("parsing Helm index: %w", err)
|
||||
}
|
||||
entries, err := helmIndexEntries(&document)
|
||||
if err != nil {
|
||||
return nil, nil, err
|
||||
}
|
||||
return &document, entries, nil
|
||||
}
|
||||
|
||||
func helmIndexEntries(document *yaml.Node) (*yaml.Node, error) {
|
||||
if document == nil {
|
||||
return nil, errors.New("helm index is empty")
|
||||
}
|
||||
if len(document.Content) != 1 || document.Content[0].Kind != yaml.MappingNode {
|
||||
return nil, errors.New("helm index must be a mapping")
|
||||
}
|
||||
entries := helmMappingValue(document.Content[0], "entries")
|
||||
if entries == nil || entries.Kind != yaml.MappingNode {
|
||||
return nil, errors.New("helm index has no entries mapping")
|
||||
}
|
||||
if len(entries.Content)%2 != 0 {
|
||||
return nil, errors.New("helm index entries mapping has an incomplete key-value pair")
|
||||
}
|
||||
return entries, nil
|
||||
}
|
||||
|
||||
func helmMappingValue(mapping *yaml.Node, key string) *yaml.Node {
|
||||
if mapping == nil || mapping.Kind != yaml.MappingNode {
|
||||
return nil
|
||||
}
|
||||
for i := 0; i+1 < len(mapping.Content); i += 2 {
|
||||
if mapping.Content[i].Value == key {
|
||||
return mapping.Content[i+1]
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func normalizeHelmDigest(value string) (string, bool) {
|
||||
digest := strings.TrimPrefix(strings.ToLower(value), "sha256:")
|
||||
if len(digest) != sha256HexLength {
|
||||
return "", false
|
||||
}
|
||||
for _, char := range digest {
|
||||
if (char < '0' || char > '9') && (char < 'a' || char > 'f') {
|
||||
return "", false
|
||||
}
|
||||
}
|
||||
return digest, true
|
||||
}
|
||||
|
|
@ -1,337 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"crypto/sha256"
|
||||
"encoding/hex"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/cooldown"
|
||||
upstreamhttp "github.com/git-pkgs/proxy/internal/httpclient"
|
||||
"github.com/git-pkgs/proxy/internal/storage"
|
||||
"github.com/git-pkgs/registries/fetch"
|
||||
"gopkg.in/yaml.v3"
|
||||
)
|
||||
|
||||
func TestHelmHandler_RewritesIndexAndCachesChart(t *testing.T) {
|
||||
chart := []byte("a Helm chart")
|
||||
digest := helmSHA256Hex(chart)
|
||||
var available atomic.Bool
|
||||
available.Store(true)
|
||||
var indexRequests atomic.Int32
|
||||
var chartRequests atomic.Int32
|
||||
|
||||
var upstream *httptest.Server
|
||||
upstream = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if !available.Load() {
|
||||
http.Error(w, "unavailable", http.StatusServiceUnavailable)
|
||||
return
|
||||
}
|
||||
switch r.URL.Path {
|
||||
case "/charts/index.yaml":
|
||||
indexRequests.Add(1)
|
||||
w.Header().Set("Content-Type", "application/x-yaml")
|
||||
_, _ = fmt.Fprintf(w, `apiVersion: v1
|
||||
entries:
|
||||
demo:
|
||||
- annotations:
|
||||
example.com/retained: "true"
|
||||
created: 2020-01-02T03:04:05Z
|
||||
digest: %s
|
||||
name: demo
|
||||
urls:
|
||||
- demo-1.0.0.tgz
|
||||
- %s/charts/mirror/demo-1.0.0.tgz
|
||||
version: 1.0.0
|
||||
generated: 2020-01-02T03:04:05Z
|
||||
`, digest, upstream.URL)
|
||||
case "/charts/demo-1.0.0.tgz", "/charts/mirror/demo-1.0.0.tgz":
|
||||
chartRequests.Add(1)
|
||||
w.Header().Set("Content-Type", "application/gzip")
|
||||
_, _ = w.Write(chart)
|
||||
default:
|
||||
http.NotFound(w, r)
|
||||
}
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = true
|
||||
proxy.MetadataTTL = time.Hour
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
fetcher := fetch.NewFetcher(fetch.WithHTTPClient(upstream.Client()), fetch.WithMaxRetries(0))
|
||||
proxy.Fetcher = fetcher
|
||||
t.Cleanup(func() { _ = fetcher.Close() })
|
||||
|
||||
h := NewHelmHandler(proxy, "http://proxy.example", map[string]string{"stable": upstream.URL + "/charts"})
|
||||
|
||||
indexResponse := serveHelmRequest(h, "/stable/index.yaml")
|
||||
if indexResponse.Code != http.StatusOK {
|
||||
t.Fatalf("index status = %d, want 200: %s", indexResponse.Code, indexResponse.Body.String())
|
||||
}
|
||||
if got := indexResponse.Header().Get("Content-Type"); got != "application/x-yaml" {
|
||||
t.Errorf("index Content-Type = %q, want application/x-yaml", got)
|
||||
}
|
||||
if strings.Contains(indexResponse.Body.String(), upstream.URL) {
|
||||
t.Errorf("rewritten index contains upstream URL: %s", indexResponse.Body.String())
|
||||
}
|
||||
if !strings.Contains(indexResponse.Body.String(), "example.com/retained") {
|
||||
t.Errorf("rewritten index lost an unrelated field: %s", indexResponse.Body.String())
|
||||
}
|
||||
|
||||
var index map[string]any
|
||||
if err := yaml.Unmarshal(indexResponse.Body.Bytes(), &index); err != nil {
|
||||
t.Fatalf("parse rewritten index: %v", err)
|
||||
}
|
||||
entries := index["entries"].(map[string]any)
|
||||
release := entries["demo"].([]any)[0].(map[string]any)
|
||||
urls := release["urls"].([]any)
|
||||
wantURL := "http://proxy.example/helm/stable/charts/" + digest + "/demo-1.0.0.tgz"
|
||||
for _, rawURL := range urls {
|
||||
if rawURL != wantURL {
|
||||
t.Errorf("rewritten URL = %q, want %q", rawURL, wantURL)
|
||||
}
|
||||
}
|
||||
|
||||
firstChart := serveHelmRequest(h, "/stable/charts/"+digest+"/demo-1.0.0.tgz")
|
||||
if firstChart.Code != http.StatusOK {
|
||||
t.Fatalf("chart status = %d, want 200: %s", firstChart.Code, firstChart.Body.String())
|
||||
}
|
||||
if got := firstChart.Body.String(); got != string(chart) {
|
||||
t.Errorf("chart body = %q, want %q", got, chart)
|
||||
}
|
||||
if got := firstChart.Header().Get("Content-Type"); got != "application/gzip" {
|
||||
t.Errorf("chart Content-Type = %q, want application/gzip", got)
|
||||
}
|
||||
|
||||
// Artifact cache availability must not depend on metadata caching or a
|
||||
// reachable index upstream.
|
||||
proxy.CacheMetadata = false
|
||||
available.Store(false)
|
||||
cachedChart := serveHelmRequest(h, "/stable/charts/"+digest+"/demo-1.0.0.tgz")
|
||||
if cachedChart.Code != http.StatusOK {
|
||||
t.Fatalf("cached chart status = %d, want 200: %s", cachedChart.Code, cachedChart.Body.String())
|
||||
}
|
||||
if got := cachedChart.Body.String(); got != string(chart) {
|
||||
t.Errorf("cached chart body = %q, want %q", got, chart)
|
||||
}
|
||||
if got := indexRequests.Load(); got != 1 {
|
||||
t.Errorf("index requests = %d, want 1", got)
|
||||
}
|
||||
if got := chartRequests.Load(); got != 1 {
|
||||
t.Errorf("chart requests = %d, want 1", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHelmHandler_RejectsChartDigestMismatch(t *testing.T) {
|
||||
chart := []byte("tampered chart")
|
||||
digest := helmSHA256Hex([]byte("expected chart"))
|
||||
requests := 0
|
||||
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
switch r.URL.Path {
|
||||
case "/index.yaml":
|
||||
_, _ = fmt.Fprintf(w, "apiVersion: v1\nentries:\n demo:\n - digest: %s\n urls: [demo.tgz]\n", digest)
|
||||
case "/demo.tgz":
|
||||
requests++
|
||||
_, _ = w.Write(chart)
|
||||
default:
|
||||
http.NotFound(w, r)
|
||||
}
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, store, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = true
|
||||
proxy.MetadataTTL = time.Hour
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
fetcher := fetch.NewFetcher(fetch.WithHTTPClient(upstream.Client()), fetch.WithMaxRetries(0))
|
||||
proxy.Fetcher = fetcher
|
||||
t.Cleanup(func() { _ = fetcher.Close() })
|
||||
h := NewHelmHandler(proxy, "http://proxy.example", map[string]string{"test": upstream.URL})
|
||||
|
||||
for range 2 {
|
||||
response := serveHelmRequest(h, "/test/charts/"+digest+"/demo.tgz")
|
||||
if response.Code != http.StatusBadGateway {
|
||||
t.Errorf("status = %d, want 502: %s", response.Code, response.Body.String())
|
||||
}
|
||||
}
|
||||
if requests != 2 {
|
||||
t.Errorf("chart requests = %d, want 2 after invalid cache entry is cleared", requests)
|
||||
}
|
||||
storagePath := storage.ArtifactPath(helmMetadataEcosystem, "", "test", digest, "demo.tgz")
|
||||
if exists, err := store.Exists(t.Context(), storagePath); err != nil {
|
||||
t.Fatalf("checking rejected chart storage: %v", err)
|
||||
} else if exists {
|
||||
t.Errorf("rejected chart remains in storage at %q", storagePath)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHelmHandler_IndexCacheChangesWithUpstreamURL(t *testing.T) {
|
||||
firstDigest := strings.Repeat("a", sha256HexLength)
|
||||
secondDigest := strings.Repeat("b", sha256HexLength)
|
||||
firstRequests := 0
|
||||
secondRequests := 0
|
||||
first := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
firstRequests++
|
||||
_, _ = fmt.Fprintf(w, "apiVersion: v1\nentries:\n demo:\n - digest: %s\n urls: [demo.tgz]\n", firstDigest)
|
||||
}))
|
||||
defer first.Close()
|
||||
second := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
secondRequests++
|
||||
_, _ = fmt.Fprintf(w, "apiVersion: v1\nentries:\n demo:\n - digest: %s\n urls: [demo.tgz]\n", secondDigest)
|
||||
}))
|
||||
defer second.Close()
|
||||
|
||||
proxy, db, store, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = true
|
||||
proxy.MetadataTTL = time.Hour
|
||||
proxy.HTTPClient = first.Client()
|
||||
firstHandler := NewHelmHandler(proxy, "http://proxy.example", map[string]string{"stable": first.URL})
|
||||
if response := serveHelmRequest(firstHandler, "/stable/index.yaml"); response.Code != http.StatusOK {
|
||||
t.Fatalf("first index status = %d, want 200: %s", response.Code, response.Body.String())
|
||||
}
|
||||
|
||||
// Model a restarted server with the same database and storage but a changed
|
||||
// repository URL. Its cache key must not reuse the previous index or ETag.
|
||||
restartedProxy := NewProxy(db, store, &mockFetcher{}, fetch.NewResolver(), nil)
|
||||
restartedProxy.CacheMetadata = true
|
||||
restartedProxy.MetadataTTL = time.Hour
|
||||
restartedProxy.HTTPClient = second.Client()
|
||||
secondHandler := NewHelmHandler(restartedProxy, "http://proxy.example", map[string]string{"stable": second.URL})
|
||||
response := serveHelmRequest(secondHandler, "/stable/index.yaml")
|
||||
if response.Code != http.StatusOK {
|
||||
t.Fatalf("second index status = %d, want 200: %s", response.Code, response.Body.String())
|
||||
}
|
||||
if !strings.Contains(response.Body.String(), secondDigest) {
|
||||
t.Errorf("second index did not use the new upstream: %s", response.Body.String())
|
||||
}
|
||||
if firstRequests != 1 {
|
||||
t.Errorf("first upstream requests = %d, want 1", firstRequests)
|
||||
}
|
||||
if secondRequests != 1 {
|
||||
t.Errorf("second upstream requests = %d, want 1", secondRequests)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHelmHandler_UsesConfiguredUpstreamAuthentication(t *testing.T) {
|
||||
chart := []byte("private Helm chart")
|
||||
digest := helmSHA256Hex(chart)
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.Header.Get("Authorization") != "Bearer private-token" {
|
||||
http.Error(w, "unauthorized", http.StatusUnauthorized)
|
||||
return
|
||||
}
|
||||
switch r.URL.Path {
|
||||
case "/index.yaml":
|
||||
_, _ = fmt.Fprintf(w, "apiVersion: v1\nentries:\n demo:\n - digest: %s\n urls: [demo.tgz]\n", digest)
|
||||
case "/demo.tgz":
|
||||
_, _ = w.Write(chart)
|
||||
default:
|
||||
http.NotFound(w, r)
|
||||
}
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = true
|
||||
proxy.MetadataTTL = time.Hour
|
||||
authClient := &http.Client{Transport: upstreamhttp.NewTransport(http.DefaultTransport,
|
||||
upstreamhttp.AuthFunc(func(string) (string, string) {
|
||||
return "Authorization", "Bearer private-token"
|
||||
}))}
|
||||
proxy.HTTPClient = authClient
|
||||
fetcher := fetch.NewFetcher(fetch.WithHTTPClient(authClient), fetch.WithMaxRetries(0))
|
||||
proxy.Fetcher = fetcher
|
||||
t.Cleanup(func() { _ = fetcher.Close() })
|
||||
h := NewHelmHandler(proxy, "http://proxy.example", map[string]string{"private": upstream.URL})
|
||||
|
||||
response := serveHelmRequest(h, "/private/charts/"+digest+"/demo.tgz")
|
||||
if response.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, want 200: %s", response.Code, response.Body.String())
|
||||
}
|
||||
if got := response.Body.String(); got != string(chart) {
|
||||
t.Errorf("body = %q, want %q", got, chart)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHelmHandler_FiltersNewChartsFromIndex(t *testing.T) {
|
||||
oldDigest := strings.Repeat("a", 64)
|
||||
newDigest := strings.Repeat("b", 64)
|
||||
proxy := &Proxy{Cooldown: &cooldown.Config{Default: "3d"}}
|
||||
h := NewHelmHandler(proxy, "http://proxy.example", map[string]string{"test": "https://charts.example"})
|
||||
|
||||
body := fmt.Sprintf(`apiVersion: v1
|
||||
entries:
|
||||
demo:
|
||||
- created: %s
|
||||
digest: %s
|
||||
urls: [demo-old.tgz]
|
||||
- created: %s
|
||||
digest: %s
|
||||
urls: [demo-new.tgz]
|
||||
`, time.Now().Add(-10*24*time.Hour).Format(time.RFC3339), oldDigest,
|
||||
time.Now().Add(-time.Hour).Format(time.RFC3339), newDigest)
|
||||
|
||||
rewritten, err := h.rewriteIndex("test", "https://charts.example", []byte(body))
|
||||
if err != nil {
|
||||
t.Fatalf("rewriteIndex() error = %v", err)
|
||||
}
|
||||
if strings.Contains(string(rewritten), newDigest) {
|
||||
t.Errorf("rewritten index includes a chart still in cooldown: %s", rewritten)
|
||||
}
|
||||
if !strings.Contains(string(rewritten), oldDigest) {
|
||||
t.Errorf("rewritten index omitted an old chart: %s", rewritten)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNormalizeHelmDigest(t *testing.T) {
|
||||
digest := strings.Repeat("a", 64)
|
||||
for _, input := range []string{digest, "sha256:" + digest, "SHA256:" + strings.ToUpper(digest)} {
|
||||
if got, ok := normalizeHelmDigest(input); !ok || got != digest {
|
||||
t.Errorf("normalizeHelmDigest(%q) = %q, %t; want %q, true", input, got, ok, digest)
|
||||
}
|
||||
}
|
||||
if _, ok := normalizeHelmDigest("bad"); ok {
|
||||
t.Error("normalizeHelmDigest accepted an invalid digest")
|
||||
}
|
||||
}
|
||||
|
||||
func TestHelmIndexEntriesRejectsIncompleteMapping(t *testing.T) {
|
||||
entries := &yaml.Node{
|
||||
Kind: yaml.MappingNode,
|
||||
Content: []*yaml.Node{
|
||||
{Kind: yaml.ScalarNode, Value: "demo"},
|
||||
},
|
||||
}
|
||||
document := &yaml.Node{
|
||||
Kind: yaml.DocumentNode,
|
||||
Content: []*yaml.Node{{
|
||||
Kind: yaml.MappingNode,
|
||||
Content: []*yaml.Node{
|
||||
{Kind: yaml.ScalarNode, Value: "entries"},
|
||||
entries,
|
||||
},
|
||||
}},
|
||||
}
|
||||
|
||||
if _, err := helmIndexEntries(document); err == nil {
|
||||
t.Fatal("helmIndexEntries() error = nil, want incomplete mapping error")
|
||||
}
|
||||
}
|
||||
|
||||
func serveHelmRequest(h *HelmHandler, target string) *httptest.ResponseRecorder {
|
||||
w := httptest.NewRecorder()
|
||||
h.Routes().ServeHTTP(w, httptest.NewRequest(http.MethodGet, target, nil))
|
||||
return w
|
||||
}
|
||||
|
||||
func helmSHA256Hex(data []byte) string {
|
||||
digest := sha256.Sum256(data)
|
||||
return hex.EncodeToString(digest[:])
|
||||
}
|
||||
|
|
@ -10,6 +10,7 @@ import (
|
|||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/purl"
|
||||
"google.golang.org/protobuf/encoding/protowire"
|
||||
)
|
||||
|
||||
|
|
@ -21,7 +22,6 @@ const (
|
|||
type HexHandler struct {
|
||||
proxy *Proxy
|
||||
upstreamURL string
|
||||
apiURL string
|
||||
proxyURL string
|
||||
}
|
||||
|
||||
|
|
@ -30,20 +30,10 @@ func NewHexHandler(proxy *Proxy, proxyURL string) *HexHandler {
|
|||
return &HexHandler{
|
||||
proxy: proxy,
|
||||
upstreamURL: hexUpstream,
|
||||
apiURL: hexAPIURL,
|
||||
proxyURL: strings.TrimSuffix(proxyURL, "/"),
|
||||
}
|
||||
}
|
||||
|
||||
// NewHexHandlerWithUpstreams creates a Hex handler with custom repository and
|
||||
// API upstreams.
|
||||
func NewHexHandlerWithUpstreams(proxy *Proxy, proxyURL, upstreamURL, apiURL string) *HexHandler {
|
||||
h := NewHexHandler(proxy, proxyURL)
|
||||
h.upstreamURL = configuredUpstreamURL(upstreamURL, hexUpstream)
|
||||
h.apiURL = configuredUpstreamURL(apiURL, hexAPIURL)
|
||||
return h
|
||||
}
|
||||
|
||||
// Routes returns the HTTP handler for Hex requests.
|
||||
func (h *HexHandler) Routes() http.Handler {
|
||||
mux := http.NewServeMux()
|
||||
|
|
@ -64,14 +54,30 @@ func (h *HexHandler) Routes() http.Handler {
|
|||
|
||||
// handleDownload serves a package tarball, fetching and caching from upstream if needed.
|
||||
func (h *HexHandler) handleDownload(w http.ResponseWriter, r *http.Request) {
|
||||
h.proxy.handleFilenameDownload(w, r, filenameDownload{
|
||||
ecosystem: "hex",
|
||||
upstreamURL: h.upstreamURL,
|
||||
suffix: ".tar",
|
||||
parseErr: "could not parse tarball filename",
|
||||
fetchErr: "failed to fetch package",
|
||||
parse: h.parseTarballFilename,
|
||||
})
|
||||
filename := r.PathValue("filename")
|
||||
if filename == "" || !strings.HasSuffix(filename, ".tar") {
|
||||
http.Error(w, "invalid filename", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
// Extract name and version from filename (e.g., "phoenix-1.7.10.tar")
|
||||
name, version := h.parseTarballFilename(filename)
|
||||
if name == "" || version == "" {
|
||||
http.Error(w, "could not parse tarball filename", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
h.proxy.Logger.Info("hex download request",
|
||||
"name", name, "version", version, "filename", filename)
|
||||
|
||||
result, err := h.proxy.GetOrFetchArtifact(r.Context(), "hex", name, version, filename)
|
||||
if err != nil {
|
||||
h.proxy.Logger.Error("failed to get artifact", "error", err)
|
||||
http.Error(w, "failed to fetch package", http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
|
||||
ServeArtifact(w, result)
|
||||
}
|
||||
|
||||
// parseTarballFilename extracts name and version from a hex tarball filename.
|
||||
|
|
@ -135,7 +141,7 @@ func (h *HexHandler) handlePackages(w http.ResponseWriter, r *http.Request) {
|
|||
|
||||
if len(filteredVersions) == 0 {
|
||||
// No versions to filter or couldn't get timestamps, pass through
|
||||
w.Header().Set(headerContentType, protoResp.Header.Get(headerContentType))
|
||||
w.Header().Set("Content-Type", protoResp.Header.Get("Content-Type"))
|
||||
w.Header().Set("Content-Encoding", "gzip")
|
||||
_, _ = w.Write(body)
|
||||
return
|
||||
|
|
@ -144,13 +150,13 @@ func (h *HexHandler) handlePackages(w http.ResponseWriter, r *http.Request) {
|
|||
filtered, err := h.filterSignedPackage(body, filteredVersions)
|
||||
if err != nil {
|
||||
h.proxy.Logger.Warn("failed to filter hex package, proxying original", "error", err)
|
||||
w.Header().Set(headerContentType, protoResp.Header.Get(headerContentType))
|
||||
w.Header().Set("Content-Type", protoResp.Header.Get("Content-Type"))
|
||||
w.Header().Set("Content-Encoding", "gzip")
|
||||
_, _ = w.Write(body)
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set(headerContentType, "application/octet-stream")
|
||||
w.Header().Set("Content-Type", "application/octet-stream")
|
||||
w.Header().Set("Content-Encoding", "gzip")
|
||||
_, _ = w.Write(filtered)
|
||||
}
|
||||
|
|
@ -209,7 +215,7 @@ type hexPackageAPI struct {
|
|||
// fetchFilteredVersions fetches the Hex API and returns a set of version
|
||||
// strings that should be filtered out by cooldown.
|
||||
func (h *HexHandler) fetchFilteredVersions(r *http.Request, name string) (map[string]bool, error) {
|
||||
apiURL := fmt.Sprintf("%s/api/packages/%s", h.apiURL, name)
|
||||
apiURL := fmt.Sprintf("%s/api/packages/%s", hexAPIURL, name)
|
||||
req, err := http.NewRequestWithContext(r.Context(), http.MethodGet, apiURL, nil)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
|
|
@ -231,7 +237,7 @@ func (h *HexHandler) fetchFilteredVersions(r *http.Request, name string) (map[st
|
|||
return nil, err
|
||||
}
|
||||
|
||||
packagePURL := canonicalPackagePURL("hex", name)
|
||||
packagePURL := purl.MakePURLString("hex", name, "")
|
||||
filtered := make(map[string]bool)
|
||||
|
||||
for _, release := range pkg.Releases {
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ import (
|
|||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/cooldown"
|
||||
"github.com/git-pkgs/proxy/internal/cooldown"
|
||||
"google.golang.org/protobuf/encoding/protowire"
|
||||
)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,74 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"crypto/sha256"
|
||||
"encoding/hex"
|
||||
"net/http"
|
||||
"strings"
|
||||
)
|
||||
|
||||
const (
|
||||
homebrewArtifactNamespace = "homebrew"
|
||||
homebrewArtifactRepository = "homebrew/core"
|
||||
homebrewMetadataEcosystem = "homebrew"
|
||||
)
|
||||
|
||||
// HomebrewHandler proxies Homebrew's JSON API without modifying signed files.
|
||||
type HomebrewHandler struct {
|
||||
proxy *Proxy
|
||||
apiUpstream string
|
||||
}
|
||||
|
||||
// NewHomebrewHandler creates a Homebrew JSON API handler.
|
||||
func NewHomebrewHandler(proxy *Proxy, apiUpstream string) *HomebrewHandler {
|
||||
return &HomebrewHandler{
|
||||
proxy: proxy,
|
||||
apiUpstream: strings.TrimSuffix(apiUpstream, "/"),
|
||||
}
|
||||
}
|
||||
|
||||
// RegisterHomebrewArtifacts routes homebrew/core OCI requests to its configured
|
||||
// registry and blocks other homebrew repositories from reaching the default
|
||||
// OCI registry.
|
||||
func RegisterHomebrewArtifacts(container *ContainerHandler, artifactUpstream string) {
|
||||
container.BlockRegistry(homebrewArtifactNamespace)
|
||||
container.RegisterRegistry(homebrewArtifactRepository, artifactUpstream)
|
||||
}
|
||||
|
||||
// Routes returns the Homebrew JSON API handler. Mount this at /homebrew.
|
||||
func (h *HomebrewHandler) Routes() http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.Method != http.MethodGet && r.Method != http.MethodHead {
|
||||
w.Header().Set("Allow", "GET, HEAD")
|
||||
http.Error(w, "method not allowed", http.StatusMethodNotAllowed)
|
||||
return
|
||||
}
|
||||
|
||||
requestPath := strings.TrimPrefix(r.URL.EscapedPath(), "/")
|
||||
if requestPath == "" || containsPathTraversal(requestPath) {
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
|
||||
upstreamURL := h.apiUpstream + "/" + requestPath
|
||||
if r.URL.RawQuery != "" {
|
||||
upstreamURL += "?" + r.URL.RawQuery
|
||||
}
|
||||
|
||||
// brew fetches every JSON API download with `curl --compressed` and
|
||||
// decodes Content-Encoding itself, and formula.jws.json is ~33 MB plain
|
||||
// versus ~5 MB gzip, so keep both hops compressed. The analytics
|
||||
// endpoints are the one consumer brew fetches without --compressed;
|
||||
// they stay identity.
|
||||
acceptEncoding := "gzip"
|
||||
if strings.HasPrefix(requestPath, "analytics/") {
|
||||
acceptEncoding = "identity"
|
||||
}
|
||||
h.proxy.proxyCachedWithEncoding(w, r, upstreamURL, homebrewMetadataEcosystem, homebrewMetadataCacheKey(requestPath, r.URL.RawQuery), acceptEncoding, "*/*")
|
||||
})
|
||||
}
|
||||
|
||||
func homebrewMetadataCacheKey(requestPath, rawQuery string) string {
|
||||
sum := sha256.Sum256([]byte(requestPath + "\x00" + rawQuery))
|
||||
return hex.EncodeToString(sum[:])
|
||||
}
|
||||
|
|
@ -1,458 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strconv"
|
||||
"strings"
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/registries/fetch"
|
||||
)
|
||||
|
||||
func TestHomebrewHandler_PreservesSignedResponseAndClientValidators(t *testing.T) {
|
||||
body := " {\n \"payload\": \"signed bytes\",\n \"signatures\": []\n}\n"
|
||||
etag := `"homebrew-api-etag"`
|
||||
lastModified := time.Date(2026, time.August, 14, 9, 30, 0, 0, time.UTC)
|
||||
requests := 0
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
requests++
|
||||
if r.Method != http.MethodGet {
|
||||
t.Errorf("upstream method = %s, want GET", r.Method)
|
||||
}
|
||||
if r.URL.Path != "/api/internal/packages.arm64_tahoe.jws.json" {
|
||||
t.Errorf("upstream path = %q", r.URL.Path)
|
||||
}
|
||||
if got := r.Header.Get("Authorization"); got != "" {
|
||||
t.Errorf("upstream Authorization = %q, want empty", got)
|
||||
}
|
||||
if got := r.Header.Get("Cookie"); got != "" {
|
||||
t.Errorf("upstream Cookie = %q, want empty", got)
|
||||
}
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
w.Header().Set("ETag", etag)
|
||||
w.Header().Set("Last-Modified", lastModified.Format(http.TimeFormat))
|
||||
_, _ = io.WriteString(w, body)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = true
|
||||
proxy.MetadataTTL = time.Hour
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
h := NewHomebrewHandler(proxy, upstream.URL+"/api").Routes()
|
||||
|
||||
req := httptest.NewRequest(http.MethodGet, "/internal/packages.arm64_tahoe.jws.json", nil)
|
||||
req.Header.Set("Authorization", "Bearer client-secret")
|
||||
req.Header.Set("Cookie", "session=client-secret")
|
||||
w := httptest.NewRecorder()
|
||||
h.ServeHTTP(w, req)
|
||||
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, want %d; body: %s", w.Code, http.StatusOK, w.Body.String())
|
||||
}
|
||||
if got := w.Body.String(); got != body {
|
||||
t.Errorf("body = %q, want byte-for-byte %q", got, body)
|
||||
}
|
||||
if got := w.Header().Get("Content-Type"); got != "application/json" {
|
||||
t.Errorf("Content-Type = %q, want application/json", got)
|
||||
}
|
||||
wantContentLength := strconv.Itoa(len(body))
|
||||
if got := w.Header().Get("Content-Length"); got != wantContentLength {
|
||||
t.Errorf("Content-Length = %q, want %q", got, wantContentLength)
|
||||
}
|
||||
if got := w.Header().Get("ETag"); got != etag {
|
||||
t.Errorf("ETag = %q, want %q", got, etag)
|
||||
}
|
||||
if got := w.Header().Get("Last-Modified"); got != lastModified.Format(http.TimeFormat) {
|
||||
t.Errorf("Last-Modified = %q, want %q", got, lastModified.Format(http.TimeFormat))
|
||||
}
|
||||
|
||||
conditionalRequest := httptest.NewRequest(http.MethodGet, "/internal/packages.arm64_tahoe.jws.json", nil)
|
||||
conditionalRequest.Header.Set("If-None-Match", etag)
|
||||
conditional := httptest.NewRecorder()
|
||||
h.ServeHTTP(conditional, conditionalRequest)
|
||||
if conditional.Code != http.StatusNotModified {
|
||||
t.Fatalf("conditional status = %d, want %d", conditional.Code, http.StatusNotModified)
|
||||
}
|
||||
if got := conditional.Header().Get("ETag"); got != etag {
|
||||
t.Errorf("conditional ETag = %q, want %q", got, etag)
|
||||
}
|
||||
if conditional.Body.Len() != 0 {
|
||||
t.Errorf("conditional body length = %d, want 0", conditional.Body.Len())
|
||||
}
|
||||
|
||||
modifiedSinceRequest := httptest.NewRequest(http.MethodGet, "/internal/packages.arm64_tahoe.jws.json", nil)
|
||||
modifiedSinceRequest.Header.Set("If-Modified-Since", lastModified.Format(http.TimeFormat))
|
||||
modifiedSince := httptest.NewRecorder()
|
||||
h.ServeHTTP(modifiedSince, modifiedSinceRequest)
|
||||
if modifiedSince.Code != http.StatusNotModified {
|
||||
t.Fatalf("If-Modified-Since status = %d, want %d", modifiedSince.Code, http.StatusNotModified)
|
||||
}
|
||||
if got := modifiedSince.Header().Get("Last-Modified"); got != lastModified.Format(http.TimeFormat) {
|
||||
t.Errorf("conditional Last-Modified = %q, want %q", got, lastModified.Format(http.TimeFormat))
|
||||
}
|
||||
if requests != 1 {
|
||||
t.Errorf("upstream requests = %d, want 1", requests)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHomebrewHandler_HeadUsesMetadataCacheAndSurvivesOutage(t *testing.T) {
|
||||
body := `{"payload":"signed bytes","signatures":[]}`
|
||||
available := true
|
||||
requests := 0
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
requests++
|
||||
if got := r.Header.Get("Authorization"); got != "" {
|
||||
t.Errorf("upstream Authorization = %q, want empty", got)
|
||||
}
|
||||
if !available {
|
||||
http.Error(w, "unavailable", http.StatusServiceUnavailable)
|
||||
return
|
||||
}
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
w.Header().Set("ETag", `"head-etag"`)
|
||||
_, _ = io.WriteString(w, body)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = true
|
||||
proxy.MetadataTTL = time.Hour
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
h := NewHomebrewHandler(proxy, upstream.URL+"/api").Routes()
|
||||
|
||||
coldRequest := httptest.NewRequest(http.MethodHead, "/formula.jws.json", nil)
|
||||
coldRequest.Header.Set("Authorization", "Bearer client-secret")
|
||||
cold := httptest.NewRecorder()
|
||||
h.ServeHTTP(cold, coldRequest)
|
||||
if cold.Code != http.StatusOK {
|
||||
t.Fatalf("cold status = %d, want %d", cold.Code, http.StatusOK)
|
||||
}
|
||||
if cold.Body.Len() != 0 {
|
||||
t.Errorf("cold body length = %d, want 0", cold.Body.Len())
|
||||
}
|
||||
if got := cold.Header().Get("Content-Length"); got != strconv.Itoa(len(body)) {
|
||||
t.Errorf("Content-Length = %q, want %d", got, len(body))
|
||||
}
|
||||
if got := cold.Header().Get("ETag"); got != `"head-etag"` {
|
||||
t.Errorf("ETag = %q, want %q", got, `"head-etag"`)
|
||||
}
|
||||
if requests != 1 {
|
||||
t.Fatalf("cold upstream requests = %d, want 1", requests)
|
||||
}
|
||||
|
||||
warm := httptest.NewRecorder()
|
||||
h.ServeHTTP(warm, httptest.NewRequest(http.MethodHead, "/formula.jws.json", nil))
|
||||
if warm.Code != http.StatusOK {
|
||||
t.Fatalf("warm status = %d, want %d", warm.Code, http.StatusOK)
|
||||
}
|
||||
if warm.Body.Len() != 0 {
|
||||
t.Errorf("warm body length = %d, want 0", warm.Body.Len())
|
||||
}
|
||||
if requests != 1 {
|
||||
t.Errorf("warm upstream requests = %d, want 1", requests)
|
||||
}
|
||||
|
||||
proxy.MetadataTTL = time.Nanosecond
|
||||
available = false
|
||||
stale := httptest.NewRecorder()
|
||||
h.ServeHTTP(stale, httptest.NewRequest(http.MethodHead, "/formula.jws.json", nil))
|
||||
if stale.Code != http.StatusOK {
|
||||
t.Fatalf("stale status = %d, want %d; body: %s", stale.Code, http.StatusOK, stale.Body.String())
|
||||
}
|
||||
if stale.Body.Len() != 0 {
|
||||
t.Errorf("stale body length = %d, want 0", stale.Body.Len())
|
||||
}
|
||||
if got := stale.Header().Get("Warning"); got != containerStaleWarning {
|
||||
t.Errorf("Warning = %q, want %q", got, containerStaleWarning)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHomebrewHandler_HeadWithoutMetadataCachePreservesUpstreamMethod(t *testing.T) {
|
||||
upstreamMethod := ""
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
upstreamMethod = r.Method
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
w.Header().Set("Content-Length", "42")
|
||||
w.Header().Set("ETag", `"head-etag"`)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = false
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
h := NewHomebrewHandler(proxy, upstream.URL+"/api").Routes()
|
||||
|
||||
head := httptest.NewRecorder()
|
||||
h.ServeHTTP(head, httptest.NewRequest(http.MethodHead, "/formula.jws.json", nil))
|
||||
if head.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, want %d", head.Code, http.StatusOK)
|
||||
}
|
||||
if upstreamMethod != http.MethodHead {
|
||||
t.Errorf("upstream method = %q, want HEAD", upstreamMethod)
|
||||
}
|
||||
if head.Body.Len() != 0 {
|
||||
t.Errorf("body length = %d, want 0", head.Body.Len())
|
||||
}
|
||||
if got := head.Header().Get("Content-Length"); got != "42" {
|
||||
t.Errorf("Content-Length = %q, want 42", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHomebrewHandler_ServesStaleCachedResponseWhenUpstreamFails(t *testing.T) {
|
||||
body := `{"payload":"signed bytes","signatures":[]}`
|
||||
available := true
|
||||
requests := 0
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||
requests++
|
||||
if !available {
|
||||
http.Error(w, "unavailable", http.StatusServiceUnavailable)
|
||||
return
|
||||
}
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
w.Header().Set("ETag", `"stale-etag"`)
|
||||
_, _ = io.WriteString(w, body)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = true
|
||||
proxy.MetadataTTL = 5 * time.Millisecond
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
h := NewHomebrewHandler(proxy, upstream.URL+"/api").Routes()
|
||||
|
||||
first := httptest.NewRecorder()
|
||||
h.ServeHTTP(first, httptest.NewRequest(http.MethodGet, "/formula.jws.json", nil))
|
||||
if first.Code != http.StatusOK {
|
||||
t.Fatalf("warm status = %d, want %d", first.Code, http.StatusOK)
|
||||
}
|
||||
|
||||
time.Sleep(10 * time.Millisecond)
|
||||
available = false
|
||||
stale := httptest.NewRecorder()
|
||||
h.ServeHTTP(stale, httptest.NewRequest(http.MethodGet, "/formula.jws.json", nil))
|
||||
if stale.Code != http.StatusOK {
|
||||
t.Fatalf("stale status = %d, want %d; body: %s", stale.Code, http.StatusOK, stale.Body.String())
|
||||
}
|
||||
if got := stale.Body.String(); got != body {
|
||||
t.Errorf("stale body = %q, want %q", got, body)
|
||||
}
|
||||
if got := stale.Header().Get("Warning"); got != containerStaleWarning {
|
||||
t.Errorf("Warning = %q, want %q", got, containerStaleWarning)
|
||||
}
|
||||
if requests != 2 {
|
||||
t.Errorf("upstream requests = %d, want 2", requests)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHomebrewHandler_ProxiesSupportedAPIPaths(t *testing.T) {
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = io.WriteString(w, r.URL.RequestURI())
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
h := NewHomebrewHandler(proxy, upstream.URL+"/api").Routes()
|
||||
|
||||
paths := []string{
|
||||
"/formula.jws.json",
|
||||
"/cask.jws.json",
|
||||
"/formula/jq.json",
|
||||
"/cask/firefox.json",
|
||||
"/internal/packages.arm64_tahoe.jws.json?download=1",
|
||||
}
|
||||
for _, requestPath := range paths {
|
||||
t.Run(requestPath, func(t *testing.T) {
|
||||
w := httptest.NewRecorder()
|
||||
h.ServeHTTP(w, httptest.NewRequest(http.MethodGet, requestPath, nil))
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, want %d", w.Code, http.StatusOK)
|
||||
}
|
||||
if got, want := w.Body.String(), "/api"+requestPath; got != want {
|
||||
t.Errorf("upstream request = %q, want %q", got, want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestHomebrewHandler_RejectsUnsupportedRequests(t *testing.T) {
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
h := NewHomebrewHandler(proxy, "https://example.test/api").Routes()
|
||||
|
||||
method := httptest.NewRecorder()
|
||||
h.ServeHTTP(method, httptest.NewRequest(http.MethodPost, "/formula.jws.json", nil))
|
||||
if method.Code != http.StatusMethodNotAllowed {
|
||||
t.Errorf("POST status = %d, want %d", method.Code, http.StatusMethodNotAllowed)
|
||||
}
|
||||
if got := method.Header().Get("Allow"); got != "GET, HEAD" {
|
||||
t.Errorf("Allow = %q, want GET, HEAD", got)
|
||||
}
|
||||
|
||||
root := httptest.NewRecorder()
|
||||
h.ServeHTTP(root, httptest.NewRequest(http.MethodGet, "/", nil))
|
||||
if root.Code != http.StatusNotFound {
|
||||
t.Errorf("root status = %d, want %d", root.Code, http.StatusNotFound)
|
||||
}
|
||||
|
||||
traversal := httptest.NewRecorder()
|
||||
h.ServeHTTP(traversal, httptest.NewRequest(http.MethodGet, "/%2e%2e/secret", nil))
|
||||
if traversal.Code != http.StatusNotFound {
|
||||
t.Errorf("traversal status = %d, want %d", traversal.Code, http.StatusNotFound)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRegisterHomebrewArtifacts(t *testing.T) {
|
||||
h := &ContainerHandler{registryURL: dockerHubRegistry}
|
||||
artifactUpstream := "https://homebrew-proxy.example.com"
|
||||
RegisterHomebrewArtifacts(h, artifactUpstream+"/")
|
||||
|
||||
if got := h.registryURLFor("homebrew/core/jq"); got != artifactUpstream {
|
||||
t.Errorf("homebrew/core registry = %q, want %q", got, artifactUpstream)
|
||||
}
|
||||
if got := h.registryURLFor("homebrew/cask/firefox"); got != "" {
|
||||
t.Errorf("other Homebrew registry = %q, want blocked", got)
|
||||
}
|
||||
if got := h.registryURLFor("library/nginx"); got != dockerHubRegistry {
|
||||
t.Errorf("unrelated registry = %q, want %q", got, dockerHubRegistry)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRegisterHomebrewArtifactsRejectsOtherHomebrewRoutes(t *testing.T) {
|
||||
upstreamRequests := 0
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||
upstreamRequests++
|
||||
_, _ = io.WriteString(w, "unexpected upstream response")
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
fetcher.artifact = &fetch.Artifact{
|
||||
Body: io.NopCloser(strings.NewReader("unexpected upstream blob")),
|
||||
ContentType: "application/octet-stream",
|
||||
}
|
||||
h := &ContainerHandler{proxy: proxy, registryURL: upstream.URL}
|
||||
RegisterHomebrewArtifacts(h, "https://ghcr.io")
|
||||
|
||||
const digest = "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
|
||||
paths := []string{
|
||||
"/homebrew/cask/firefox/blobs/" + digest,
|
||||
"/homebrew/cask/firefox/manifests/latest",
|
||||
"/homebrew/cask/firefox/tags/list",
|
||||
}
|
||||
for _, path := range paths {
|
||||
t.Run(path, func(t *testing.T) {
|
||||
w := httptest.NewRecorder()
|
||||
h.Routes().ServeHTTP(w, httptest.NewRequest(http.MethodGet, path, nil))
|
||||
if w.Code != http.StatusNotFound {
|
||||
t.Errorf("status = %d, want %d; body: %s", w.Code, http.StatusNotFound, w.Body.String())
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
if fetcher.fetchCalled {
|
||||
t.Error("blocked Homebrew blob reached the artifact fetcher")
|
||||
}
|
||||
if upstreamRequests != 0 {
|
||||
t.Errorf("blocked Homebrew routes made %d upstream requests, want 0", upstreamRequests)
|
||||
}
|
||||
}
|
||||
|
||||
// TestHomebrewHandler_RequestsGzipForAPIPaths covers #305's motivating case:
|
||||
// the JSON API files are fetched, cached and served gzip-compressed with
|
||||
// Content-Encoding: gzip (brew fetches them with --compressed), while the
|
||||
// analytics endpoints, which brew fetches without --compressed, stay identity.
|
||||
func TestHomebrewHandler_RequestsGzipForAPIPaths(t *testing.T) {
|
||||
plain := []byte(`{"payload":"signed bytes","signatures":[]}`)
|
||||
compressed := gzipPayload(t, plain)
|
||||
|
||||
var available atomic.Bool
|
||||
available.Store(true)
|
||||
var requests atomic.Int32
|
||||
var sawAcceptEncoding atomic.Value // string
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
requests.Add(1)
|
||||
sawAcceptEncoding.Store(r.Header.Get(headerAcceptEncoding))
|
||||
if !available.Load() {
|
||||
http.Error(w, "unavailable", http.StatusServiceUnavailable)
|
||||
return
|
||||
}
|
||||
w.Header().Set(headerContentType, "application/json")
|
||||
if strings.Contains(r.Header.Get(headerAcceptEncoding), "gzip") {
|
||||
w.Header().Set(headerContentEncoding, "gzip")
|
||||
_, _ = w.Write(compressed)
|
||||
return
|
||||
}
|
||||
_, _ = w.Write(plain)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = true
|
||||
proxy.MetadataTTL = time.Hour
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
h := NewHomebrewHandler(proxy, upstream.URL+"/api").Routes()
|
||||
|
||||
get := func(path string) *httptest.ResponseRecorder {
|
||||
w := httptest.NewRecorder()
|
||||
h.ServeHTTP(w, httptest.NewRequest(http.MethodGet, path, nil))
|
||||
return w
|
||||
}
|
||||
lastAE := func() string {
|
||||
s, _ := sawAcceptEncoding.Load().(string)
|
||||
return s
|
||||
}
|
||||
|
||||
first := get("/formula.jws.json")
|
||||
if first.Code != http.StatusOK {
|
||||
t.Fatalf("formula.jws.json: status = %d, want 200: %s", first.Code, first.Body.String())
|
||||
}
|
||||
if got := lastAE(); got != "gzip" {
|
||||
t.Errorf("formula.jws.json: upstream Accept-Encoding = %q, want %q", got, "gzip")
|
||||
}
|
||||
if !bytes.Equal(first.Body.Bytes(), compressed) {
|
||||
t.Errorf("formula.jws.json: body is not the compressed bytes (got %d, want %d)", first.Body.Len(), len(compressed))
|
||||
}
|
||||
if got := first.Header().Get(headerContentEncoding); got != "gzip" {
|
||||
t.Errorf("formula.jws.json: Content-Encoding = %q, want %q", got, "gzip")
|
||||
}
|
||||
if got := first.Header().Get(headerContentLength); got != strconv.Itoa(len(compressed)) {
|
||||
t.Errorf("formula.jws.json: Content-Length = %q, want %d", got, len(compressed))
|
||||
}
|
||||
|
||||
// Replay from cache with the upstream down: same bytes and header, no refetch.
|
||||
before := requests.Load()
|
||||
available.Store(false)
|
||||
cached := get("/formula.jws.json")
|
||||
if cached.Code != http.StatusOK {
|
||||
t.Fatalf("cached formula.jws.json: status = %d, want 200: %s", cached.Code, cached.Body.String())
|
||||
}
|
||||
if !bytes.Equal(cached.Body.Bytes(), compressed) || cached.Header().Get(headerContentEncoding) != "gzip" {
|
||||
t.Errorf("cached formula.jws.json: body/header not replayed verbatim")
|
||||
}
|
||||
if requests.Load() != before {
|
||||
t.Errorf("cached formula.jws.json hit upstream: requests %d -> %d", before, requests.Load())
|
||||
}
|
||||
available.Store(true)
|
||||
|
||||
// Analytics is fetched by brew without --compressed: stays identity, no header.
|
||||
analytics := get("/analytics/install/30d.json")
|
||||
if analytics.Code != http.StatusOK {
|
||||
t.Fatalf("analytics: status = %d, want 200: %s", analytics.Code, analytics.Body.String())
|
||||
}
|
||||
if got := lastAE(); got != "identity" {
|
||||
t.Errorf("analytics: upstream Accept-Encoding = %q, want %q", got, "identity")
|
||||
}
|
||||
if !bytes.Equal(analytics.Body.Bytes(), plain) {
|
||||
t.Errorf("analytics: body = %q, want plain %q", analytics.Body.Bytes(), plain)
|
||||
}
|
||||
if got := analytics.Header().Get(headerContentEncoding); got != "" {
|
||||
t.Errorf("analytics: Content-Encoding = %q, want empty", got)
|
||||
}
|
||||
}
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
package handler
|
||||
|
||||
import "testing"
|
||||
|
||||
func TestIfNoneMatchHits(t *testing.T) {
|
||||
tests := []struct {
|
||||
header string
|
||||
etag string
|
||||
want bool
|
||||
}{
|
||||
{`"abc"`, `"abc"`, true},
|
||||
{`"abc"`, `"def"`, false},
|
||||
{"", `"abc"`, false},
|
||||
{`"abc"`, "", false},
|
||||
{"*", `"abc"`, true},
|
||||
{"*", "", false},
|
||||
{`W/"abc"`, `"abc"`, true},
|
||||
{`"abc"`, `W/"abc"`, true},
|
||||
{`W/"abc"`, `W/"abc"`, true},
|
||||
{`"abc", "def"`, `"def"`, true},
|
||||
{`"abc","def"`, `"def"`, true},
|
||||
{` "abc" , W/"def" `, `"def"`, true},
|
||||
{`"abc", "def"`, `"ghi"`, false},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
if got := ifNoneMatchHits(tt.header, tt.etag); got != tt.want {
|
||||
t.Errorf("ifNoneMatchHits(%q, %q) = %v, want %v", tt.header, tt.etag, got, tt.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,100 +1,140 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"crypto/sha256"
|
||||
"crypto/sha512"
|
||||
"crypto/subtle"
|
||||
"encoding/base64"
|
||||
"encoding/hex"
|
||||
"fmt"
|
||||
"hash"
|
||||
"io"
|
||||
|
||||
"github.com/git-pkgs/integrity"
|
||||
"strings"
|
||||
)
|
||||
|
||||
type integrityChecks struct {
|
||||
contentHash integrity.SRI
|
||||
native integrity.SRI
|
||||
algorithms []integrity.Algorithm
|
||||
// parseSRI parses a Subresource Integrity string (e.g. "sha512-abc==") into
|
||||
// an algorithm name and raw digest bytes. Returns ok=false for empty,
|
||||
// malformed, or unsupported entries. Only the first hash in a multi-hash
|
||||
// SRI string is considered.
|
||||
func parseSRI(s string) (algo string, digest []byte, ok bool) {
|
||||
s = strings.TrimSpace(s)
|
||||
if s == "" {
|
||||
return "", nil, false
|
||||
}
|
||||
|
||||
func newIntegrityChecks(contentHash, native string) (integrityChecks, error) {
|
||||
checks := integrityChecks{}
|
||||
|
||||
if contentHash != "" {
|
||||
digest, err := integrity.ParseHex(integrity.SHA256, contentHash)
|
||||
if i := strings.IndexByte(s, ' '); i >= 0 {
|
||||
s = s[:i]
|
||||
}
|
||||
algo, b64, found := strings.Cut(s, "-")
|
||||
if !found {
|
||||
return "", nil, false
|
||||
}
|
||||
d, err := base64.StdEncoding.DecodeString(b64)
|
||||
if err != nil {
|
||||
return integrityChecks{}, fmt.Errorf("parse content_hash: %w", err)
|
||||
return "", nil, false
|
||||
}
|
||||
checks.contentHash = integrity.SRI{digest}
|
||||
checks.algorithms = append(checks.algorithms, integrity.SHA256)
|
||||
}
|
||||
|
||||
if native != "" {
|
||||
digests, err := integrity.ParseSRI(native)
|
||||
if err != nil {
|
||||
return integrityChecks{}, fmt.Errorf("parse integrity: %w", err)
|
||||
}
|
||||
checks.native = digests
|
||||
for _, digest := range digests {
|
||||
checks.algorithms = append(checks.algorithms, digest.Algorithm())
|
||||
switch algo {
|
||||
case "sha256", "sha384", "sha512":
|
||||
return algo, d, true
|
||||
default:
|
||||
return "", nil, false
|
||||
}
|
||||
}
|
||||
|
||||
return checks, nil
|
||||
func newSRIHash(algo string) hash.Hash {
|
||||
switch algo {
|
||||
case "sha256":
|
||||
return sha256.New()
|
||||
case "sha384":
|
||||
return sha512.New384()
|
||||
case "sha512":
|
||||
return sha512.New()
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (c integrityChecks) wrap(source io.ReadCloser, onMismatch func(string)) (io.ReadCloser, error) {
|
||||
if len(c.algorithms) == 0 {
|
||||
return source, nil
|
||||
}
|
||||
reader, err := integrity.NewReader(source, c.algorithms...)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("create integrity reader: %w", err)
|
||||
}
|
||||
return &verifyingReader{
|
||||
source: source,
|
||||
reader: reader,
|
||||
checks: c,
|
||||
onMismatch: onMismatch,
|
||||
}, nil
|
||||
}
|
||||
|
||||
// verifyingReader forwards Close to its source and reports completed digest
|
||||
// mismatches after its shared integrity reader observes EOF.
|
||||
// verifyingReader wraps an io.ReadCloser and computes SHA256 (and optionally
|
||||
// a second SRI hash) as bytes are read. When the underlying reader reaches
|
||||
// EOF it compares the digests against the expected values and calls
|
||||
// onMismatch for each failure. Verification is skipped if the stream was
|
||||
// not fully consumed (e.g. client disconnect) to avoid false positives.
|
||||
type verifyingReader struct {
|
||||
source io.ReadCloser
|
||||
reader *integrity.Reader
|
||||
checks integrityChecks
|
||||
r io.ReadCloser
|
||||
sha256 hash.Hash
|
||||
wantSHA256 string
|
||||
sri hash.Hash
|
||||
sriAlgo string
|
||||
wantSRI []byte
|
||||
onMismatch func(reason string)
|
||||
eof bool
|
||||
verified bool
|
||||
}
|
||||
|
||||
func (r *verifyingReader) Read(p []byte) (int, error) {
|
||||
n, err := r.reader.Read(p)
|
||||
func newVerifyingReader(r io.ReadCloser, contentHash, sri string, onMismatch func(string)) io.ReadCloser {
|
||||
if contentHash == "" && sri == "" {
|
||||
return r
|
||||
}
|
||||
v := &verifyingReader{
|
||||
r: r,
|
||||
onMismatch: onMismatch,
|
||||
}
|
||||
if contentHash != "" {
|
||||
v.sha256 = sha256.New()
|
||||
v.wantSHA256 = contentHash
|
||||
}
|
||||
if algo, digest, ok := parseSRI(sri); ok {
|
||||
v.sri = newSRIHash(algo)
|
||||
v.sriAlgo = algo
|
||||
v.wantSRI = digest
|
||||
}
|
||||
if v.sha256 == nil && v.sri == nil {
|
||||
return r
|
||||
}
|
||||
return v
|
||||
}
|
||||
|
||||
func (v *verifyingReader) Read(p []byte) (int, error) {
|
||||
n, err := v.r.Read(p)
|
||||
if n > 0 {
|
||||
if v.sha256 != nil {
|
||||
v.sha256.Write(p[:n])
|
||||
}
|
||||
if v.sri != nil {
|
||||
v.sri.Write(p[:n])
|
||||
}
|
||||
}
|
||||
if err == io.EOF {
|
||||
r.verify()
|
||||
v.eof = true
|
||||
v.verify()
|
||||
}
|
||||
return n, err
|
||||
}
|
||||
|
||||
func (r *verifyingReader) Close() error {
|
||||
return r.source.Close()
|
||||
func (v *verifyingReader) Close() error {
|
||||
if v.eof {
|
||||
v.verify()
|
||||
}
|
||||
return v.r.Close()
|
||||
}
|
||||
|
||||
func (r *verifyingReader) verify() {
|
||||
if r.verified {
|
||||
return
|
||||
}
|
||||
r.verified = true
|
||||
result := r.reader.Result()
|
||||
if !result.Complete {
|
||||
func (v *verifyingReader) verify() {
|
||||
if v.verified {
|
||||
return
|
||||
}
|
||||
v.verified = true
|
||||
|
||||
if len(r.checks.contentHash) > 0 {
|
||||
if err := result.Verify(r.checks.contentHash); err != nil {
|
||||
r.onMismatch("content_hash: " + err.Error())
|
||||
if v.sha256 != nil {
|
||||
got := hex.EncodeToString(v.sha256.Sum(nil))
|
||||
if subtle.ConstantTimeCompare([]byte(got), []byte(v.wantSHA256)) != 1 {
|
||||
v.onMismatch(fmt.Sprintf("content_hash mismatch: stored=%s computed=%s", v.wantSHA256, got))
|
||||
}
|
||||
}
|
||||
if len(r.checks.native) > 0 {
|
||||
if err := result.Verify(r.checks.native); err != nil {
|
||||
r.onMismatch("integrity: " + err.Error())
|
||||
if v.sri != nil {
|
||||
got := v.sri.Sum(nil)
|
||||
if subtle.ConstantTimeCompare(got, v.wantSRI) != 1 {
|
||||
v.onMismatch(fmt.Sprintf("integrity mismatch: %s expected=%s computed=%s",
|
||||
v.sriAlgo,
|
||||
base64.StdEncoding.EncodeToString(v.wantSRI),
|
||||
base64.StdEncoding.EncodeToString(got)))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -5,7 +5,6 @@ import (
|
|||
"crypto/sha512"
|
||||
"encoding/base64"
|
||||
"encoding/hex"
|
||||
"errors"
|
||||
"io"
|
||||
"strings"
|
||||
"testing"
|
||||
|
|
@ -16,68 +15,42 @@ func sha256Hex(data string) string {
|
|||
return hex.EncodeToString(sum[:])
|
||||
}
|
||||
|
||||
func sha256SRI(data string) string {
|
||||
sum := sha256.Sum256([]byte(data))
|
||||
return "sha256-" + base64.StdEncoding.EncodeToString(sum[:])
|
||||
}
|
||||
|
||||
func sha384SRI(data string) string {
|
||||
sum := sha512.Sum384([]byte(data))
|
||||
return "sha384-" + base64.StdEncoding.EncodeToString(sum[:])
|
||||
}
|
||||
|
||||
func sha512SRI(data string) string {
|
||||
sum := sha512.Sum512([]byte(data))
|
||||
return "sha512-" + base64.StdEncoding.EncodeToString(sum[:])
|
||||
}
|
||||
|
||||
func wrapIntegrityReader(t *testing.T, source io.ReadCloser, contentHash, native string, onMismatch func(string)) io.ReadCloser {
|
||||
t.Helper()
|
||||
checks, err := newIntegrityChecks(contentHash, native)
|
||||
if err != nil {
|
||||
t.Fatalf("newIntegrityChecks: %v", err)
|
||||
}
|
||||
reader, err := checks.wrap(source, onMismatch)
|
||||
if err != nil {
|
||||
t.Fatalf("wrap: %v", err)
|
||||
}
|
||||
return reader
|
||||
}
|
||||
|
||||
func TestNewIntegrityChecksCollectsAlgorithms(t *testing.T) {
|
||||
checks, err := newIntegrityChecks(
|
||||
sha256Hex("hello"),
|
||||
strings.Join([]string{sha256SRI("first"), sha512SRI("second"), sha384SRI("third"), sha512SRI("alternative")}, " "),
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if len(checks.algorithms) != 5 {
|
||||
t.Fatalf("algorithms = %v, want 5 entries", checks.algorithms)
|
||||
}
|
||||
if len(checks.native) != 4 {
|
||||
t.Errorf("native digests = %d, want 4", len(checks.native))
|
||||
}
|
||||
}
|
||||
|
||||
func TestNewIntegrityChecksRejectsMalformedMetadata(t *testing.T) {
|
||||
func TestParseSRI(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
contentHash string
|
||||
native string
|
||||
input string
|
||||
algo string
|
||||
ok bool
|
||||
}{
|
||||
{name: "short content hash", contentHash: "abc123"},
|
||||
{name: "non-hex content hash", contentHash: strings.Repeat("z", sha256.Size*2)},
|
||||
{name: "missing SRI separator", native: "sha512"},
|
||||
{name: "malformed SRI base64", native: "sha512-not!base64"},
|
||||
{name: "wrong SRI length", native: "sha512-" + base64.StdEncoding.EncodeToString([]byte("short"))},
|
||||
{name: "unsupported SRI algorithm", native: "md5-1B2M2Y8AsgTpgAmY7PhCfg=="},
|
||||
{name: "invalid SRI alternative", native: sha512SRI("valid") + " sha384-nope"},
|
||||
{"sha512", sha512SRI("hello"), "sha512", true},
|
||||
{"sha256", "sha256-" + base64.StdEncoding.EncodeToString([]byte("0123456789012345678901234567890123456789")), "sha256", true},
|
||||
{"empty", "", "", false},
|
||||
{"no dash", "sha512abc", "", false},
|
||||
{"bad base64", "sha512-not!base64", "", false},
|
||||
{"unsupported algo", "md5-" + base64.StdEncoding.EncodeToString([]byte("x")), "", false},
|
||||
{"multi hash takes first", sha512SRI("a") + " " + sha512SRI("b"), "sha512", true},
|
||||
{"whitespace", " " + sha512SRI("x") + " ", "sha512", true},
|
||||
}
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
if _, err := newIntegrityChecks(test.contentHash, test.native); err == nil {
|
||||
t.Fatal("newIntegrityChecks returned nil error")
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
algo, digest, ok := parseSRI(tt.input)
|
||||
if ok != tt.ok {
|
||||
t.Fatalf("ok = %v, want %v", ok, tt.ok)
|
||||
}
|
||||
if !tt.ok {
|
||||
return
|
||||
}
|
||||
if algo != tt.algo {
|
||||
t.Errorf("algo = %q, want %q", algo, tt.algo)
|
||||
}
|
||||
if len(digest) == 0 {
|
||||
t.Error("digest is empty")
|
||||
}
|
||||
})
|
||||
}
|
||||
|
|
@ -94,156 +67,69 @@ func TestVerifyingReader(t *testing.T) {
|
|||
sri string
|
||||
wantCalls int
|
||||
}{
|
||||
{name: "both match", hash: goodSHA, sri: goodSRI},
|
||||
{name: "SHA-256 only match", hash: goodSHA},
|
||||
{name: "SRI only match", sri: goodSRI},
|
||||
{name: "SHA-256 mismatch", hash: sha256Hex("other"), wantCalls: 1},
|
||||
{name: "SRI mismatch", sri: sha512SRI("other"), wantCalls: 1},
|
||||
{name: "both mismatch", hash: sha256Hex("other"), sri: sha512SRI("other"), wantCalls: 2},
|
||||
{name: "no checks"},
|
||||
{"both match", goodSHA, goodSRI, 0},
|
||||
{"sha256 only match", goodSHA, "", 0},
|
||||
{"sri only match", "", goodSRI, 0},
|
||||
{"sha256 mismatch", sha256Hex("other"), "", 1},
|
||||
{"sri mismatch", "", sha512SRI("other"), 1},
|
||||
{"both mismatch", sha256Hex("other"), sha512SRI("other"), 2},
|
||||
{"no checks", "", "", 0},
|
||||
{"unparseable sri ignored", goodSHA, "garbage", 0},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
var calls []string
|
||||
reader := wrapIntegrityReader(t, io.NopCloser(strings.NewReader(data)), test.hash, test.sri,
|
||||
r := newVerifyingReader(io.NopCloser(strings.NewReader(data)), tt.hash, tt.sri,
|
||||
func(reason string) { calls = append(calls, reason) })
|
||||
|
||||
got, err := io.ReadAll(reader)
|
||||
got, err := io.ReadAll(r)
|
||||
if err != nil {
|
||||
t.Fatalf("ReadAll: %v", err)
|
||||
}
|
||||
if string(got) != data {
|
||||
t.Errorf("data corrupted: got %q", got)
|
||||
}
|
||||
if err := reader.Close(); err != nil {
|
||||
if err := r.Close(); err != nil {
|
||||
t.Fatalf("Close: %v", err)
|
||||
}
|
||||
if len(calls) != test.wantCalls {
|
||||
t.Errorf("onMismatch called %d times, want %d: %v", len(calls), test.wantCalls, calls)
|
||||
|
||||
if len(calls) != tt.wantCalls {
|
||||
t.Errorf("onMismatch called %d times, want %d: %v", len(calls), tt.wantCalls, calls)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestVerifyingReaderUsesStrongestNativeAlgorithm(t *testing.T) {
|
||||
const data = "artifact"
|
||||
tests := []struct {
|
||||
name string
|
||||
native string
|
||||
wantCalls int
|
||||
}{
|
||||
{
|
||||
name: "weaker match does not override stronger mismatch",
|
||||
native: sha256SRI(data) + " " + sha512SRI("other"),
|
||||
wantCalls: 1,
|
||||
},
|
||||
{
|
||||
name: "stronger match ignores weaker mismatch",
|
||||
native: sha256SRI("other") + " " + sha512SRI(data),
|
||||
},
|
||||
{
|
||||
name: "same algorithm alternative matches",
|
||||
native: sha512SRI("other") + " " + sha512SRI(data),
|
||||
},
|
||||
}
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
var calls int
|
||||
reader := wrapIntegrityReader(t, io.NopCloser(strings.NewReader(data)), "", test.native, func(string) { calls++ })
|
||||
if _, err := io.Copy(io.Discard, reader); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if calls != test.wantCalls {
|
||||
t.Errorf("onMismatch called %d times, want %d", calls, test.wantCalls)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestVerifyingReaderMismatchMessages(t *testing.T) {
|
||||
const data = "actual"
|
||||
wantHash := sha256Hex("expected")
|
||||
wantSRI := sha512SRI("expected")
|
||||
var reasons []string
|
||||
reader := wrapIntegrityReader(t, io.NopCloser(strings.NewReader(data)), wantHash, wantSRI,
|
||||
func(reason string) { reasons = append(reasons, reason) })
|
||||
if _, err := io.Copy(io.Discard, reader); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if len(reasons) != 2 {
|
||||
t.Fatalf("reasons = %v, want two", reasons)
|
||||
}
|
||||
wantContentReason := "content_hash: integrity mismatch: expected " + sha256SRI("expected") + ", calculated " + sha256SRI(data)
|
||||
if reasons[0] != wantContentReason {
|
||||
t.Errorf("content reason = %q, want %q", reasons[0], wantContentReason)
|
||||
}
|
||||
wantNativeReason := "integrity: integrity mismatch: expected " + wantSRI + ", calculated " + sha512SRI(data)
|
||||
if reasons[1] != wantNativeReason {
|
||||
t.Errorf("native reason = %q, want %q", reasons[1], wantNativeReason)
|
||||
}
|
||||
}
|
||||
|
||||
func TestVerifyingReaderPassthrough(t *testing.T) {
|
||||
source := io.NopCloser(strings.NewReader("x"))
|
||||
reader := wrapIntegrityReader(t, source, "", "", func(string) { t.Fatal("should not be called") })
|
||||
if reader != source {
|
||||
t.Error("expected passthrough when no hashes were provided")
|
||||
src := io.NopCloser(strings.NewReader("x"))
|
||||
r := newVerifyingReader(src, "", "", func(string) { t.Fatal("should not be called") })
|
||||
if r != src {
|
||||
t.Error("expected passthrough when no hashes provided")
|
||||
}
|
||||
}
|
||||
|
||||
type closeTrackingReader struct {
|
||||
io.Reader
|
||||
closed bool
|
||||
}
|
||||
|
||||
func (r *closeTrackingReader) Close() error {
|
||||
r.closed = true
|
||||
return nil
|
||||
}
|
||||
|
||||
func TestVerifyingReaderPartialRead(t *testing.T) {
|
||||
source := &closeTrackingReader{Reader: strings.NewReader("hello world")}
|
||||
var calls int
|
||||
reader := wrapIntegrityReader(t, source, sha256Hex("other"), "", func(string) { calls++ })
|
||||
r := newVerifyingReader(io.NopCloser(strings.NewReader("hello world")),
|
||||
sha256Hex("hello world"), "", func(string) { calls++ })
|
||||
|
||||
buffer := make([]byte, 5)
|
||||
_, _ = reader.Read(buffer)
|
||||
_ = reader.Close()
|
||||
buf := make([]byte, 5)
|
||||
_, _ = r.Read(buf)
|
||||
_ = r.Close()
|
||||
|
||||
if calls != 0 {
|
||||
t.Errorf("onMismatch called %d times for partial read, want 0", calls)
|
||||
}
|
||||
if !source.closed {
|
||||
t.Error("Close was not forwarded to the source")
|
||||
}
|
||||
}
|
||||
|
||||
func TestVerifyingReaderNonEOFError(t *testing.T) {
|
||||
var calls int
|
||||
reader := wrapIntegrityReader(t, io.NopCloser(errorFixtureReader{}), sha256Hex("data"), "", func(string) { calls++ })
|
||||
if _, err := io.ReadAll(reader); !errors.Is(err, errIntegrityReadFixture) {
|
||||
t.Fatalf("ReadAll error = %v", err)
|
||||
}
|
||||
if calls != 0 {
|
||||
t.Errorf("onMismatch called %d times after non-EOF error", calls)
|
||||
}
|
||||
}
|
||||
|
||||
var errIntegrityReadFixture = errors.New("integrity read fixture")
|
||||
|
||||
type errorFixtureReader struct{}
|
||||
|
||||
func (errorFixtureReader) Read(p []byte) (int, error) {
|
||||
return copy(p, "data"), errIntegrityReadFixture
|
||||
}
|
||||
|
||||
func TestVerifyingReaderVerifyOnce(t *testing.T) {
|
||||
var calls int
|
||||
reader := wrapIntegrityReader(t, io.NopCloser(strings.NewReader("x")), sha256Hex("y"), "", func(string) { calls++ })
|
||||
_, _ = io.ReadAll(reader)
|
||||
_ = reader.Close()
|
||||
_ = reader.Close()
|
||||
r := newVerifyingReader(io.NopCloser(strings.NewReader("x")), sha256Hex("y"), "",
|
||||
func(string) { calls++ })
|
||||
_, _ = io.ReadAll(r)
|
||||
_ = r.Close()
|
||||
_ = r.Close()
|
||||
if calls != 1 {
|
||||
t.Errorf("onMismatch called %d times, want 1", calls)
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,351 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"archive/tar"
|
||||
"bufio"
|
||||
"bytes"
|
||||
"compress/gzip"
|
||||
"context"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"regexp"
|
||||
"strings"
|
||||
"sync"
|
||||
|
||||
"github.com/BurntSushi/toml"
|
||||
)
|
||||
|
||||
const (
|
||||
juliaUpstream = "https://pkg.julialang.org"
|
||||
juliaGeneralRegistryUUID = "23338594-aafe-5451-b93e-139f81909106"
|
||||
juliaArtifactName = "_artifact"
|
||||
juliaRegistryName = "_registry"
|
||||
)
|
||||
|
||||
var (
|
||||
juliaHexPattern = regexp.MustCompile(`^[0-9a-f]{40,64}$`)
|
||||
juliaUUIDPattern = regexp.MustCompile(`^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`)
|
||||
)
|
||||
|
||||
// JuliaHandler handles Julia Pkg server protocol requests.
|
||||
//
|
||||
// See https://pkgdocs.julialang.org/v1/registries/ and the PkgServer.jl
|
||||
// reference implementation. The protocol is content-addressed: registry,
|
||||
// package and artifact resources are all identified by git tree hashes
|
||||
// and are immutable once published.
|
||||
type JuliaHandler struct {
|
||||
proxy *Proxy
|
||||
upstreamURL string
|
||||
|
||||
mu sync.RWMutex
|
||||
names map[string]string
|
||||
namesHash string
|
||||
loadMu sync.Mutex
|
||||
}
|
||||
|
||||
// NewJuliaHandler creates a new Julia Pkg server handler.
|
||||
func NewJuliaHandler(proxy *Proxy, _ string) *JuliaHandler {
|
||||
return &JuliaHandler{
|
||||
proxy: proxy,
|
||||
upstreamURL: juliaUpstream,
|
||||
names: make(map[string]string),
|
||||
}
|
||||
}
|
||||
|
||||
// NewJuliaHandlerWithUpstream creates a Julia handler with a custom upstream.
|
||||
func NewJuliaHandlerWithUpstream(proxy *Proxy, upstreamURL string) *JuliaHandler {
|
||||
h := NewJuliaHandler(proxy, "")
|
||||
h.upstreamURL = configuredUpstreamURL(upstreamURL, juliaUpstream)
|
||||
return h
|
||||
}
|
||||
|
||||
// Routes returns the HTTP handler for Julia requests.
|
||||
func (h *JuliaHandler) Routes() http.Handler {
|
||||
mux := http.NewServeMux()
|
||||
|
||||
mux.HandleFunc("GET /registries", h.handleRegistries)
|
||||
mux.HandleFunc("GET /registries.eager", h.handleRegistries)
|
||||
mux.HandleFunc("GET /registries.conservative", h.handleRegistries)
|
||||
mux.HandleFunc("GET /registry/{uuid}/{hash}", h.handleRegistry)
|
||||
mux.HandleFunc("GET /package/{uuid}/{hash}", h.handlePackage)
|
||||
mux.HandleFunc("GET /artifact/{hash}", h.handleArtifact)
|
||||
mux.HandleFunc("GET /meta", h.proxyUpstream)
|
||||
|
||||
return mux
|
||||
}
|
||||
|
||||
// handleRegistries serves the list of available registries. This is the only
|
||||
// mutable endpoint in the protocol so it goes through the metadata cache.
|
||||
func (h *JuliaHandler) handleRegistries(w http.ResponseWriter, r *http.Request) {
|
||||
cacheKey := strings.TrimPrefix(r.URL.Path, "/")
|
||||
h.proxy.ProxyCached(w, r, h.upstreamURL+r.URL.Path, "julia", cacheKey, "*/*")
|
||||
}
|
||||
|
||||
// handleRegistry serves an immutable registry tarball and refreshes the
|
||||
// UUID→name map from its Registry.toml.
|
||||
func (h *JuliaHandler) handleRegistry(w http.ResponseWriter, r *http.Request) {
|
||||
uuid := r.PathValue("uuid")
|
||||
hash := r.PathValue("hash")
|
||||
if !validJuliaUUID(uuid) || !juliaHexPattern.MatchString(hash) {
|
||||
http.Error(w, "invalid registry reference", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
h.proxy.Logger.Info("julia registry request", "uuid", uuid, "hash", hash)
|
||||
|
||||
upstreamURL := h.upstreamURL + r.URL.Path
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURL(r.Context(), "julia", juliaRegistryName, hash, hash+".tar.gz", upstreamURL)
|
||||
if err != nil {
|
||||
h.proxy.serveArtifactError(w, err, "failed to fetch registry")
|
||||
return
|
||||
}
|
||||
|
||||
go h.refreshNamesFromRegistry(uuid, hash)
|
||||
|
||||
ServeArtifact(w, result)
|
||||
}
|
||||
|
||||
// handlePackage serves an immutable package source tarball.
|
||||
func (h *JuliaHandler) handlePackage(w http.ResponseWriter, r *http.Request) {
|
||||
uuid := r.PathValue("uuid")
|
||||
hash := r.PathValue("hash")
|
||||
if !validJuliaUUID(uuid) || !juliaHexPattern.MatchString(hash) {
|
||||
http.Error(w, "invalid package reference", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
if err := h.ensureNames(r.Context()); err != nil {
|
||||
h.proxy.Logger.Warn("julia name map unavailable, using uuid", "error", err)
|
||||
}
|
||||
name := h.resolveName(uuid)
|
||||
|
||||
h.proxy.Logger.Info("julia package request", "name", name, "uuid", uuid, "hash", hash)
|
||||
|
||||
upstreamURL := h.upstreamURL + r.URL.Path
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURL(r.Context(), "julia", name, hash, hash+".tar.gz", upstreamURL)
|
||||
if err != nil {
|
||||
h.proxy.serveArtifactError(w, err, "failed to fetch package")
|
||||
return
|
||||
}
|
||||
|
||||
ServeArtifact(w, result)
|
||||
}
|
||||
|
||||
// handleArtifact serves an immutable binary artifact tarball. Artifacts are
|
||||
// anonymous content-addressed blobs with no associated package name.
|
||||
func (h *JuliaHandler) handleArtifact(w http.ResponseWriter, r *http.Request) {
|
||||
hash := r.PathValue("hash")
|
||||
if !juliaHexPattern.MatchString(hash) {
|
||||
http.Error(w, "invalid artifact hash", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
h.proxy.Logger.Info("julia artifact request", "hash", hash)
|
||||
|
||||
upstreamURL := h.upstreamURL + r.URL.Path
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURL(r.Context(), "julia", juliaArtifactName, hash, hash+".tar.gz", upstreamURL)
|
||||
if err != nil {
|
||||
h.proxy.serveArtifactError(w, err, "failed to fetch artifact")
|
||||
return
|
||||
}
|
||||
|
||||
ServeArtifact(w, result)
|
||||
}
|
||||
|
||||
// proxyUpstream forwards a request to the upstream Pkg server without caching.
|
||||
func (h *JuliaHandler) proxyUpstream(w http.ResponseWriter, r *http.Request) {
|
||||
h.proxy.ProxyUpstream(w, r, h.upstreamURL+r.URL.Path, nil)
|
||||
}
|
||||
|
||||
// resolveName returns the human-readable package name for a UUID, falling
|
||||
// back to the UUID itself if it is not present in the loaded registry.
|
||||
func (h *JuliaHandler) resolveName(uuid string) string {
|
||||
h.mu.RLock()
|
||||
defer h.mu.RUnlock()
|
||||
if name, ok := h.names[uuid]; ok {
|
||||
return name
|
||||
}
|
||||
return uuid
|
||||
}
|
||||
|
||||
// ensureNames lazily populates the UUID→name map from the General registry.
|
||||
// Returns immediately if the map is already populated; otherwise blocks until
|
||||
// a single in-flight load completes. Failed loads are retried on the next call.
|
||||
func (h *JuliaHandler) ensureNames(ctx context.Context) error {
|
||||
if h.namesLoaded() {
|
||||
return nil
|
||||
}
|
||||
|
||||
h.loadMu.Lock()
|
||||
defer h.loadMu.Unlock()
|
||||
|
||||
if h.namesLoaded() {
|
||||
return nil
|
||||
}
|
||||
return h.loadNamesFromUpstream(ctx)
|
||||
}
|
||||
|
||||
func (h *JuliaHandler) namesLoaded() bool {
|
||||
h.mu.RLock()
|
||||
defer h.mu.RUnlock()
|
||||
return len(h.names) > 0
|
||||
}
|
||||
|
||||
// loadNamesFromUpstream fetches the current /registries listing, downloads the
|
||||
// General registry tarball at its current hash, and parses Registry.toml.
|
||||
func (h *JuliaHandler) loadNamesFromUpstream(ctx context.Context) error {
|
||||
hash, err := h.fetchGeneralRegistryHash(ctx)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return h.loadRegistryTarball(ctx, juliaGeneralRegistryUUID, hash)
|
||||
}
|
||||
|
||||
// fetchGeneralRegistryHash reads /registries and returns the current tree hash
|
||||
// for the General registry.
|
||||
func (h *JuliaHandler) fetchGeneralRegistryHash(ctx context.Context) (string, error) {
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodGet, h.upstreamURL+"/registries", nil)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
resp, err := h.proxy.HTTPClient.Do(req)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return "", fmt.Errorf("upstream /registries returned %d", resp.StatusCode)
|
||||
}
|
||||
|
||||
scanner := bufio.NewScanner(resp.Body)
|
||||
for scanner.Scan() {
|
||||
uuid, hash, ok := parseRegistryLine(scanner.Text())
|
||||
if ok && uuid == juliaGeneralRegistryUUID {
|
||||
return hash, nil
|
||||
}
|
||||
}
|
||||
if err := scanner.Err(); err != nil {
|
||||
return "", err
|
||||
}
|
||||
return "", fmt.Errorf("general registry not listed in /registries")
|
||||
}
|
||||
|
||||
// refreshNamesFromRegistry reloads the UUID→name map from a registry tarball
|
||||
// that has just been cached. Errors are logged but do not affect the response.
|
||||
func (h *JuliaHandler) refreshNamesFromRegistry(uuid, hash string) {
|
||||
if uuid != juliaGeneralRegistryUUID {
|
||||
return
|
||||
}
|
||||
h.mu.RLock()
|
||||
current := h.namesHash
|
||||
h.mu.RUnlock()
|
||||
if current == hash {
|
||||
return
|
||||
}
|
||||
if err := h.loadRegistryTarball(context.Background(), uuid, hash); err != nil {
|
||||
h.proxy.Logger.Warn("failed to refresh julia name map", "error", err)
|
||||
}
|
||||
}
|
||||
|
||||
// loadRegistryTarball downloads a registry tarball and replaces the name map
|
||||
// with the contents of its Registry.toml.
|
||||
func (h *JuliaHandler) loadRegistryTarball(ctx context.Context, uuid, hash string) error {
|
||||
url := fmt.Sprintf("%s/registry/%s/%s", h.upstreamURL, uuid, hash)
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
resp, err := h.proxy.HTTPClient.Do(req)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return fmt.Errorf("upstream registry returned %d", resp.StatusCode)
|
||||
}
|
||||
|
||||
names, err := extractRegistryNames(resp.Body)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
h.mu.Lock()
|
||||
h.names = names
|
||||
h.namesHash = hash
|
||||
h.mu.Unlock()
|
||||
|
||||
h.proxy.Logger.Info("loaded julia registry name map", "packages", len(names), "hash", hash)
|
||||
return nil
|
||||
}
|
||||
|
||||
// extractRegistryNames reads a gzipped registry tarball, finds Registry.toml
|
||||
// at the root, and returns its [packages] table as a UUID→name map.
|
||||
func extractRegistryNames(r io.Reader) (map[string]string, error) {
|
||||
gz, err := gzip.NewReader(r)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("opening gzip stream: %w", err)
|
||||
}
|
||||
defer func() { _ = gz.Close() }()
|
||||
|
||||
tr := tar.NewReader(gz)
|
||||
for {
|
||||
hdr, err := tr.Next()
|
||||
if err == io.EOF {
|
||||
return nil, fmt.Errorf("no Registry.toml in tarball")
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if strings.TrimPrefix(hdr.Name, "./") != "Registry.toml" {
|
||||
continue
|
||||
}
|
||||
|
||||
data, err := io.ReadAll(tr)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return parseRegistryToml(data)
|
||||
}
|
||||
}
|
||||
|
||||
type juliaRegistryFile struct {
|
||||
Packages map[string]struct {
|
||||
Name string `toml:"name"`
|
||||
} `toml:"packages"`
|
||||
}
|
||||
|
||||
// parseRegistryToml decodes the [packages] table of a Registry.toml file.
|
||||
func parseRegistryToml(data []byte) (map[string]string, error) {
|
||||
var reg juliaRegistryFile
|
||||
if _, err := toml.NewDecoder(bytes.NewReader(data)).Decode(®); err != nil {
|
||||
return nil, fmt.Errorf("parsing Registry.toml: %w", err)
|
||||
}
|
||||
|
||||
names := make(map[string]string, len(reg.Packages))
|
||||
for uuid, pkg := range reg.Packages {
|
||||
if pkg.Name != "" {
|
||||
names[uuid] = pkg.Name
|
||||
}
|
||||
}
|
||||
return names, nil
|
||||
}
|
||||
|
||||
// parseRegistryLine parses a single line from /registries of the form
|
||||
// "/registry/{uuid}/{hash}" and returns the uuid and hash.
|
||||
func parseRegistryLine(line string) (uuid, hash string, ok bool) {
|
||||
line = strings.TrimSpace(line)
|
||||
line = strings.TrimPrefix(line, "/registry/")
|
||||
uuid, hash, found := strings.Cut(line, "/")
|
||||
if !found || !validJuliaUUID(uuid) || !juliaHexPattern.MatchString(hash) {
|
||||
return "", "", false
|
||||
}
|
||||
return uuid, hash, true
|
||||
}
|
||||
|
||||
// validJuliaUUID reports whether s looks like a lowercase RFC 4122 UUID.
|
||||
func validJuliaUUID(s string) bool {
|
||||
return juliaUUIDPattern.MatchString(s)
|
||||
}
|
||||
|
|
@ -1,167 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"archive/tar"
|
||||
"bytes"
|
||||
"compress/gzip"
|
||||
"log/slog"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestJuliaParseRegistryLine(t *testing.T) {
|
||||
tests := []struct {
|
||||
line string
|
||||
wantUUID string
|
||||
wantHash string
|
||||
wantOK bool
|
||||
}{
|
||||
{
|
||||
"/registry/23338594-aafe-5451-b93e-139f81909106/342327538ed6c1ec54c69fa145e7b6bf5934201e",
|
||||
"23338594-aafe-5451-b93e-139f81909106",
|
||||
"342327538ed6c1ec54c69fa145e7b6bf5934201e",
|
||||
true,
|
||||
},
|
||||
{
|
||||
" /registry/23338594-aafe-5451-b93e-139f81909106/342327538ed6c1ec54c69fa145e7b6bf5934201e\n",
|
||||
"23338594-aafe-5451-b93e-139f81909106",
|
||||
"342327538ed6c1ec54c69fa145e7b6bf5934201e",
|
||||
true,
|
||||
},
|
||||
{"/registry/not-a-uuid/0000", "", "", false},
|
||||
{"junk", "", "", false},
|
||||
{"", "", "", false},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
uuid, hash, ok := parseRegistryLine(tt.line)
|
||||
if uuid != tt.wantUUID || hash != tt.wantHash || ok != tt.wantOK {
|
||||
t.Errorf("parseRegistryLine(%q) = (%q, %q, %v), want (%q, %q, %v)",
|
||||
tt.line, uuid, hash, ok, tt.wantUUID, tt.wantHash, tt.wantOK)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestJuliaValidUUID(t *testing.T) {
|
||||
tests := []struct {
|
||||
s string
|
||||
want bool
|
||||
}{
|
||||
{"23338594-aafe-5451-b93e-139f81909106", true},
|
||||
{"295af30f-e4ad-537b-8983-00126c2a3abe", true},
|
||||
{"23338594-AAFE-5451-b93e-139f81909106", false},
|
||||
{"23338594aafe5451b93e139f81909106", false},
|
||||
{"23338594-aafe-5451-b93e-139f8190910", false},
|
||||
{"23338594-aafe-5451-b93e-139f81909106-", false},
|
||||
{"23338594-gafe-5451-b93e-139f81909106", false},
|
||||
{"", false},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
if got := validJuliaUUID(tt.s); got != tt.want {
|
||||
t.Errorf("validJuliaUUID(%q) = %v, want %v", tt.s, got, tt.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestJuliaParseRegistryToml(t *testing.T) {
|
||||
data := []byte(`name = "General"
|
||||
uuid = "23338594-aafe-5451-b93e-139f81909106"
|
||||
|
||||
[packages]
|
||||
295af30f-e4ad-537b-8983-00126c2a3abe = { name = "Revise", path = "R/Revise" }
|
||||
91a5bcdd-55d7-5caf-9e0b-520d859cae80 = { name = "Plots", path = "P/Plots" }
|
||||
`)
|
||||
|
||||
names, err := parseRegistryToml(data)
|
||||
if err != nil {
|
||||
t.Fatalf("parseRegistryToml: %v", err)
|
||||
}
|
||||
if got := names["295af30f-e4ad-537b-8983-00126c2a3abe"]; got != "Revise" {
|
||||
t.Errorf("names[Revise uuid] = %q, want Revise", got)
|
||||
}
|
||||
if got := names["91a5bcdd-55d7-5caf-9e0b-520d859cae80"]; got != "Plots" {
|
||||
t.Errorf("names[Plots uuid] = %q, want Plots", got)
|
||||
}
|
||||
if len(names) != 2 {
|
||||
t.Errorf("len(names) = %d, want 2", len(names))
|
||||
}
|
||||
}
|
||||
|
||||
func TestJuliaExtractRegistryNames(t *testing.T) {
|
||||
registryToml := `name = "General"
|
||||
[packages]
|
||||
295af30f-e4ad-537b-8983-00126c2a3abe = { name = "Revise", path = "R/Revise" }
|
||||
`
|
||||
var buf bytes.Buffer
|
||||
gw := gzip.NewWriter(&buf)
|
||||
tw := tar.NewWriter(gw)
|
||||
|
||||
for _, f := range []struct{ name, body string }{
|
||||
{"R/Revise/Package.toml", "name = \"Revise\"\n"},
|
||||
{"Registry.toml", registryToml},
|
||||
} {
|
||||
if err := tw.WriteHeader(&tar.Header{Name: f.name, Mode: 0o644, Size: int64(len(f.body))}); err != nil {
|
||||
t.Fatalf("WriteHeader: %v", err)
|
||||
}
|
||||
if _, err := tw.Write([]byte(f.body)); err != nil {
|
||||
t.Fatalf("Write: %v", err)
|
||||
}
|
||||
}
|
||||
if err := tw.Close(); err != nil {
|
||||
t.Fatalf("tar Close: %v", err)
|
||||
}
|
||||
if err := gw.Close(); err != nil {
|
||||
t.Fatalf("gzip Close: %v", err)
|
||||
}
|
||||
|
||||
names, err := extractRegistryNames(bytes.NewReader(buf.Bytes()))
|
||||
if err != nil {
|
||||
t.Fatalf("extractRegistryNames: %v", err)
|
||||
}
|
||||
if got := names["295af30f-e4ad-537b-8983-00126c2a3abe"]; got != "Revise" {
|
||||
t.Errorf("names[Revise uuid] = %q, want Revise", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestJuliaResolveName(t *testing.T) {
|
||||
h := &JuliaHandler{
|
||||
proxy: &Proxy{Logger: slog.Default()},
|
||||
names: map[string]string{
|
||||
"295af30f-e4ad-537b-8983-00126c2a3abe": "Revise",
|
||||
},
|
||||
}
|
||||
|
||||
if got := h.resolveName("295af30f-e4ad-537b-8983-00126c2a3abe"); got != "Revise" {
|
||||
t.Errorf("resolveName(known) = %q, want Revise", got)
|
||||
}
|
||||
if got := h.resolveName("00000000-0000-0000-0000-000000000000"); got != "00000000-0000-0000-0000-000000000000" {
|
||||
t.Errorf("resolveName(unknown) = %q, want uuid fallback", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestJuliaRoutesValidation(t *testing.T) {
|
||||
h := NewJuliaHandler(&Proxy{Logger: slog.Default()}, "")
|
||||
routes := h.Routes()
|
||||
|
||||
tests := []struct {
|
||||
path string
|
||||
want int
|
||||
}{
|
||||
{"/package/not-a-uuid/342327538ed6c1ec54c69fa145e7b6bf5934201e", http.StatusBadRequest},
|
||||
{"/package/295af30f-e4ad-537b-8983-00126c2a3abe/short", http.StatusBadRequest},
|
||||
{"/registry/295af30f-e4ad-537b-8983-00126c2a3abe/zzzz", http.StatusBadRequest},
|
||||
{"/artifact/nothex", http.StatusBadRequest},
|
||||
{"/nope", http.StatusNotFound},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
req := httptest.NewRequest(http.MethodGet, tt.path, nil)
|
||||
rr := httptest.NewRecorder()
|
||||
routes.ServeHTTP(rr, req)
|
||||
if rr.Code != tt.want {
|
||||
t.Errorf("GET %s = %d, want %d", tt.path, rr.Code, tt.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,7 +1,6 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"path"
|
||||
|
|
@ -9,8 +8,7 @@ import (
|
|||
)
|
||||
|
||||
const (
|
||||
mavenCentralUpstream = "https://repo1.maven.org/maven2"
|
||||
gradlePluginPortalUpstream = "https://plugins.gradle.org/m2"
|
||||
mavenUpstream = "https://repo1.maven.org/maven2"
|
||||
minMavenParts = 4 // group path segments + artifact + version + filename
|
||||
)
|
||||
|
||||
|
|
@ -18,23 +16,14 @@ const (
|
|||
type MavenHandler struct {
|
||||
proxy *Proxy
|
||||
upstreamURL string
|
||||
pluginPortalUpstreamURL string
|
||||
proxyURL string
|
||||
}
|
||||
|
||||
// NewMavenHandler creates a new Maven repository handler.
|
||||
func NewMavenHandler(proxy *Proxy, proxyURL, upstreamURL, pluginPortalUpstreamURL string) *MavenHandler {
|
||||
if strings.TrimSpace(upstreamURL) == "" {
|
||||
upstreamURL = mavenCentralUpstream
|
||||
}
|
||||
if strings.TrimSpace(pluginPortalUpstreamURL) == "" {
|
||||
pluginPortalUpstreamURL = gradlePluginPortalUpstream
|
||||
}
|
||||
|
||||
func NewMavenHandler(proxy *Proxy, proxyURL string) *MavenHandler {
|
||||
return &MavenHandler{
|
||||
proxy: proxy,
|
||||
upstreamURL: strings.TrimSuffix(upstreamURL, "/"),
|
||||
pluginPortalUpstreamURL: strings.TrimSuffix(pluginPortalUpstreamURL, "/"),
|
||||
upstreamURL: mavenUpstream,
|
||||
proxyURL: strings.TrimSuffix(proxyURL, "/"),
|
||||
}
|
||||
}
|
||||
|
|
@ -62,7 +51,8 @@ func (h *MavenHandler) handleRequest(w http.ResponseWriter, r *http.Request) {
|
|||
filename := path.Base(urlPath)
|
||||
|
||||
if h.isMetadataFile(filename) {
|
||||
h.handleMetadata(w, r, urlPath)
|
||||
cacheKey := strings.ReplaceAll(urlPath, "/", "_")
|
||||
h.proxy.ProxyCached(w, r, h.upstreamURL+r.URL.Path, "maven", cacheKey, "*/*")
|
||||
return
|
||||
}
|
||||
|
||||
|
|
@ -76,32 +66,6 @@ func (h *MavenHandler) handleRequest(w http.ResponseWriter, r *http.Request) {
|
|||
h.proxyUpstream(w, r)
|
||||
}
|
||||
|
||||
func (h *MavenHandler) handleMetadata(w http.ResponseWriter, r *http.Request, urlPath string) {
|
||||
cacheKey := strings.ReplaceAll(urlPath, "/", "_")
|
||||
upstreamURL := fmt.Sprintf("%s/%s", h.upstreamURL, urlPath)
|
||||
|
||||
body, contentType, err := h.proxy.FetchOrCacheMetadata(r.Context(), "maven", cacheKey, upstreamURL, "*/*")
|
||||
if err != nil {
|
||||
if errors.Is(err, ErrUpstreamNotFound) {
|
||||
pluginPortalURL := fmt.Sprintf("%s/%s", h.pluginPortalUpstreamURL, urlPath)
|
||||
h.proxy.Logger.Info("maven metadata unavailable in primary upstream, trying Gradle Plugin Portal",
|
||||
"path", urlPath)
|
||||
body, contentType, err = h.proxy.FetchOrCacheMetadata(r.Context(), "maven", cacheKey, pluginPortalURL, "*/*")
|
||||
}
|
||||
}
|
||||
if err != nil {
|
||||
if errors.Is(err, ErrUpstreamNotFound) {
|
||||
http.Error(w, "not found", http.StatusNotFound)
|
||||
return
|
||||
}
|
||||
h.proxy.Logger.Error("metadata fetch failed", "error", err)
|
||||
http.Error(w, "failed to fetch from upstream", http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
|
||||
h.proxy.writeMetadataCachedResponse(w, r, "maven", cacheKey, body, contentType)
|
||||
}
|
||||
|
||||
// handleDownload serves an artifact file, fetching and caching from upstream if needed.
|
||||
func (h *MavenHandler) handleDownload(w http.ResponseWriter, r *http.Request, urlPath string) {
|
||||
// Parse Maven path: group/artifact/version/filename
|
||||
|
|
@ -122,15 +86,8 @@ func (h *MavenHandler) handleDownload(w http.ResponseWriter, r *http.Request, ur
|
|||
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURL(r.Context(), "maven", name, version, filename, upstreamURL)
|
||||
if err != nil {
|
||||
if errors.Is(err, ErrUpstreamNotFound) {
|
||||
pluginPortalURL := fmt.Sprintf("%s/%s", h.pluginPortalUpstreamURL, urlPath)
|
||||
h.proxy.Logger.Info("maven artifact not found in primary upstream, trying Gradle Plugin Portal",
|
||||
"group", group, "artifact", artifact, "version", version, "filename", filename)
|
||||
result, err = h.proxy.GetOrFetchArtifactFromURL(r.Context(), "maven", name, version, filename, pluginPortalURL)
|
||||
}
|
||||
}
|
||||
if err != nil {
|
||||
h.proxy.serveArtifactError(w, err, "failed to fetch artifact")
|
||||
h.proxy.Logger.Error("failed to get artifact", "error", err)
|
||||
http.Error(w, "failed to fetch artifact", http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
|
||||
|
|
@ -158,7 +115,7 @@ func (h *MavenHandler) parsePath(urlPath string) (group, artifact, version, file
|
|||
// isArtifactFile returns true if the filename looks like a Maven artifact.
|
||||
func (h *MavenHandler) isArtifactFile(filename string) bool {
|
||||
// Common artifact extensions
|
||||
extensions := []string{".jar", ".war", ".ear", ".pom", ".aar", ".klib", ".module"}
|
||||
extensions := []string{".jar", ".war", ".ear", ".pom", ".aar", ".klib"}
|
||||
for _, ext := range extensions {
|
||||
if strings.HasSuffix(filename, ext) {
|
||||
return true
|
||||
|
|
|
|||
|
|
@ -52,7 +52,6 @@ func TestMavenIsArtifactFile(t *testing.T) {
|
|||
}{
|
||||
{"guava-32.1.3-jre.jar", true},
|
||||
{"guava-32.1.3-jre.pom", true},
|
||||
{"guava-32.1.3-jre.module", true},
|
||||
{"app-1.0.war", true},
|
||||
{"lib-1.0.aar", true},
|
||||
{"maven-metadata.xml", false},
|
||||
|
|
@ -66,63 +65,3 @@ func TestMavenIsArtifactFile(t *testing.T) {
|
|||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestMavenIsMetadataFile(t *testing.T) {
|
||||
h := &MavenHandler{}
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
filename string
|
||||
want bool
|
||||
}{
|
||||
{
|
||||
name: "pom is artifact, not metadata",
|
||||
filename: "com.diffplug.spotless.gradle.plugin-8.4.0.pom",
|
||||
want: false,
|
||||
},
|
||||
{
|
||||
name: "pom checksum is metadata",
|
||||
filename: "com.diffplug.spotless.gradle.plugin-8.4.0.pom.sha1",
|
||||
want: true,
|
||||
},
|
||||
{
|
||||
name: "metadata file",
|
||||
filename: "maven-metadata.xml",
|
||||
want: true,
|
||||
},
|
||||
{
|
||||
name: "metadata checksum",
|
||||
filename: "maven-metadata.xml.sha256",
|
||||
want: true,
|
||||
},
|
||||
{
|
||||
name: "jar checksum is metadata",
|
||||
filename: "guava-32.1.3-jre.jar.sha1",
|
||||
want: true,
|
||||
},
|
||||
{
|
||||
name: "asc signature is metadata",
|
||||
filename: "guava-32.1.3-jre.jar.asc",
|
||||
want: true,
|
||||
},
|
||||
{
|
||||
name: "regular jar is not metadata",
|
||||
filename: "guava-32.1.3-jre.jar",
|
||||
want: false,
|
||||
},
|
||||
{
|
||||
name: "pom checksum is metadata",
|
||||
filename: "guava-32.1.3-jre.pom.sha1",
|
||||
want: true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got := h.isMetadataFile(tt.filename)
|
||||
if got != tt.want {
|
||||
t.Errorf("isMetadataFile(%q) = %v, want %v", tt.filename, got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,200 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"compress/gzip"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
// gzipPayload returns a gzip-compressed copy of data, simulating an origin
|
||||
// that stores pre-compressed index files.
|
||||
func gzipPayload(t *testing.T, data []byte) []byte {
|
||||
t.Helper()
|
||||
var buf bytes.Buffer
|
||||
zw := gzip.NewWriter(&buf)
|
||||
if _, err := zw.Write(data); err != nil {
|
||||
t.Fatalf("compressing payload: %v", err)
|
||||
}
|
||||
if err := zw.Close(); err != nil {
|
||||
t.Fatalf("closing gzip writer: %v", err)
|
||||
}
|
||||
return buf.Bytes()
|
||||
}
|
||||
|
||||
// TestProxyCached_PreservesContentEncodedBytes covers issue #300: an upstream
|
||||
// that serves a signed index with Content-Encoding: gzip must have its bytes
|
||||
// cached and re-served verbatim, with the encoding header replayed, instead of
|
||||
// being transparently decompressed by the HTTP client.
|
||||
func TestProxyCached_PreservesContentEncodedBytes(t *testing.T) {
|
||||
raw := gzipPayload(t, []byte("signed index payload"))
|
||||
|
||||
var available atomic.Bool
|
||||
available.Store(true)
|
||||
var sawAcceptEncoding atomic.Value
|
||||
var upstreamRequests atomic.Int32
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if !available.Load() {
|
||||
http.Error(w, "unavailable", http.StatusServiceUnavailable)
|
||||
return
|
||||
}
|
||||
upstreamRequests.Add(1)
|
||||
sawAcceptEncoding.Store(r.Header.Get(headerAcceptEncoding))
|
||||
w.Header().Set(headerContentType, "application/octet-stream")
|
||||
w.Header().Set(headerContentEncoding, "gzip")
|
||||
_, _ = w.Write(raw)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = true
|
||||
proxy.MetadataTTL = time.Hour
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
|
||||
serve := func() *httptest.ResponseRecorder {
|
||||
w := httptest.NewRecorder()
|
||||
r := httptest.NewRequest(http.MethodGet, "/index", nil)
|
||||
proxy.ProxyCached(w, r, upstream.URL+"/index", "apk", "index-key", "*/*")
|
||||
return w
|
||||
}
|
||||
|
||||
first := serve()
|
||||
if first.Code != http.StatusOK {
|
||||
t.Fatalf("first response status = %d, want 200: %s", first.Code, first.Body.String())
|
||||
}
|
||||
if got, _ := sawAcceptEncoding.Load().(string); got != "identity" {
|
||||
t.Errorf("upstream saw Accept-Encoding %q, want %q", got, "identity")
|
||||
}
|
||||
if !bytes.Equal(first.Body.Bytes(), raw) {
|
||||
t.Errorf("first response altered the upstream bytes: got %d bytes, want %d", first.Body.Len(), len(raw))
|
||||
}
|
||||
if got := first.Header().Get(headerContentEncoding); got != "gzip" {
|
||||
t.Errorf("first response Content-Encoding = %q, want %q", got, "gzip")
|
||||
}
|
||||
|
||||
// Within the TTL and with the upstream down, the cached copy must be
|
||||
// served with the same bytes and encoding.
|
||||
available.Store(false)
|
||||
second := serve()
|
||||
if second.Code != http.StatusOK {
|
||||
t.Fatalf("cached response status = %d, want 200: %s", second.Code, second.Body.String())
|
||||
}
|
||||
if !bytes.Equal(second.Body.Bytes(), raw) {
|
||||
t.Errorf("cached response altered the stored bytes")
|
||||
}
|
||||
if got := second.Header().Get(headerContentEncoding); got != "gzip" {
|
||||
t.Errorf("cached response Content-Encoding = %q, want %q", got, "gzip")
|
||||
}
|
||||
if got := upstreamRequests.Load(); got != 1 {
|
||||
t.Errorf("upstream requests = %d, want 1", got)
|
||||
}
|
||||
}
|
||||
|
||||
// TestProxyCached_NoEncodingHeaderForIdentityResponses pins that ordinary
|
||||
// responses do not grow a spurious Content-Encoding header.
|
||||
func TestProxyCached_NoEncodingHeaderForIdentityResponses(t *testing.T) {
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||
w.Header().Set(headerContentType, contentTypeJSON)
|
||||
_, _ = w.Write([]byte(`{"ok":true}`))
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = true
|
||||
proxy.MetadataTTL = time.Hour
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
r := httptest.NewRequest(http.MethodGet, "/meta", nil)
|
||||
proxy.ProxyCached(w, r, upstream.URL+"/meta", "npm", "meta-key", contentTypeJSON)
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, want 200: %s", w.Code, w.Body.String())
|
||||
}
|
||||
if got := w.Header().Get(headerContentEncoding); got != "" {
|
||||
t.Errorf("Content-Encoding = %q, want empty", got)
|
||||
}
|
||||
}
|
||||
|
||||
// TestProxyMetadataStream_PreservesSignedBytesWithoutClientEncoding pins the
|
||||
// uncached streaming path (the default, since cache_metadata is off) for the
|
||||
// realistic client that sends no Accept-Encoding: the proxy must request
|
||||
// identity upstream so Go does not transparently decompress a signed index,
|
||||
// and the raw bytes plus the Content-Encoding header must reach the client.
|
||||
func TestProxyMetadataStream_PreservesSignedBytesWithoutClientEncoding(t *testing.T) {
|
||||
raw := gzipPayload(t, []byte("streamed index payload"))
|
||||
var sawAcceptEncoding string
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
sawAcceptEncoding = r.Header.Get(headerAcceptEncoding)
|
||||
w.Header().Set(headerContentType, "application/octet-stream")
|
||||
w.Header().Set(headerContentEncoding, "gzip")
|
||||
_, _ = w.Write(raw)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = false
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
// No Accept-Encoding on the client request -- the apk/apt/dnf case.
|
||||
r := httptest.NewRequest(http.MethodGet, "/index", nil)
|
||||
proxy.ProxyCached(w, r, upstream.URL+"/index", "apk", "stream-key", "*/*")
|
||||
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, want 200: %s", w.Code, w.Body.String())
|
||||
}
|
||||
if sawAcceptEncoding != "identity" {
|
||||
t.Errorf("upstream saw Accept-Encoding %q, want %q", sawAcceptEncoding, "identity")
|
||||
}
|
||||
if !bytes.Equal(w.Body.Bytes(), raw) {
|
||||
t.Errorf("streamed response altered the upstream bytes: got %d bytes, want %d", w.Body.Len(), len(raw))
|
||||
}
|
||||
if got := w.Header().Get(headerContentEncoding); got != "gzip" {
|
||||
t.Errorf("Content-Encoding = %q, want %q", got, "gzip")
|
||||
}
|
||||
}
|
||||
|
||||
// TestFetchOrCacheMetadata_DirectCallersKeepTransparentCompression pins that
|
||||
// the parsing/rewriting ecosystems (npm, pypi, cargo, helm, ...) that call
|
||||
// FetchOrCacheMetadata directly are NOT forced to identity: they keep Go's
|
||||
// transparent transfer compression and receive decoded bytes, so a gzip-only
|
||||
// upstream does not regress them (no wire-size blowup, no parse failures).
|
||||
func TestFetchOrCacheMetadata_DirectCallersKeepTransparentCompression(t *testing.T) {
|
||||
plaintext := []byte(`{"name":"demo","versions":{"1.0.0":{}}}`)
|
||||
var sawAcceptEncoding string
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
sawAcceptEncoding = r.Header.Get(headerAcceptEncoding)
|
||||
// Serve gzip only when the client accepts it, like a real CDN.
|
||||
if strings.Contains(r.Header.Get(headerAcceptEncoding), "gzip") {
|
||||
w.Header().Set(headerContentType, contentTypeJSON)
|
||||
w.Header().Set(headerContentEncoding, "gzip")
|
||||
_, _ = w.Write(gzipPayload(t, plaintext))
|
||||
return
|
||||
}
|
||||
w.Header().Set(headerContentType, contentTypeJSON)
|
||||
_, _ = w.Write(plaintext)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = true
|
||||
proxy.MetadataTTL = time.Hour
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
|
||||
body, _, err := proxy.FetchOrCacheMetadata(t.Context(), "npm", "demo", upstream.URL+"/demo", contentTypeJSON)
|
||||
if err != nil {
|
||||
t.Fatalf("FetchOrCacheMetadata() error = %v", err)
|
||||
}
|
||||
// The default transport adds Accept-Encoding: gzip and transparently
|
||||
// decompresses, so the caller sees decoded JSON regardless of the wire form.
|
||||
if sawAcceptEncoding == "identity" {
|
||||
t.Errorf("direct caller forced identity; want transparent compression")
|
||||
}
|
||||
if !bytes.Equal(body, plaintext) {
|
||||
t.Errorf("direct caller got %q, want decoded %q", body, plaintext)
|
||||
}
|
||||
}
|
||||
|
|
@ -1,143 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/git-pkgs/registries/fetch"
|
||||
)
|
||||
|
||||
func TestArtifactDownloadUpstreamNotFoundReturns404(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
path string
|
||||
handler func(p *Proxy) http.Handler
|
||||
}{
|
||||
{"debian", "/pool/main/n/nginx/nginx_1.18.0-6_amd64.deb",
|
||||
func(p *Proxy) http.Handler { return NewDebianHandler(p, "http://localhost", "").Routes() }},
|
||||
{"rpm", "/releases/39/Everything/x86_64/os/Packages/n/nginx-1.24.0-1.fc39.x86_64.rpm",
|
||||
func(p *Proxy) http.Handler { return NewRPMHandler(p, "http://localhost").Routes() }},
|
||||
{"apk", "/alpine/v3.22/main/x86_64/busybox-1.37.0-r12.apk",
|
||||
func(p *Proxy) http.Handler { return NewAPKHandler(p, "http://localhost", nil).Routes() }},
|
||||
{"nuget", "/v3-flatcontainer/newtonsoft.json/13.0.3/newtonsoft.json.13.0.3.nupkg",
|
||||
func(p *Proxy) http.Handler { return NewNuGetHandler(p, "http://localhost").Routes() }},
|
||||
{"pypi", "/packages/packages/ab/cd/ef0123456789/requests-2.31.0-py3-none-any.whl",
|
||||
func(p *Proxy) http.Handler {
|
||||
return NewPyPIHandlerWithUpstreams(p, "http://localhost", "", "").Routes()
|
||||
}},
|
||||
{"cran", "/src/contrib/ggplot2_3.4.4.tar.gz",
|
||||
func(p *Proxy) http.Handler { return NewCRANHandler(p, "http://localhost").Routes() }},
|
||||
{"conda", "/conda-forge/linux-64/numpy-1.26.0-py311_0.tar.bz2",
|
||||
func(p *Proxy) http.Handler { return NewCondaHandler(p, "http://localhost").Routes() }},
|
||||
{"conan", "/v1/files/zlib/1.3.1/_/_/0/recipe/conan_sources.tgz",
|
||||
func(p *Proxy) http.Handler { return NewConanHandler(p, "http://localhost").Routes() }},
|
||||
{"gem", "/gems/rails-7.1.0.gem",
|
||||
func(p *Proxy) http.Handler { return NewGemHandler(p, "http://localhost").Routes() }},
|
||||
{"hex", "/tarballs/phoenix-1.7.10.tar",
|
||||
func(p *Proxy) http.Handler { return NewHexHandler(p, "http://localhost").Routes() }},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
fetcher.fetchErr = fetch.ErrNotFound
|
||||
|
||||
srv := httptest.NewServer(tt.handler(proxy))
|
||||
defer srv.Close()
|
||||
|
||||
resp, err := http.Get(srv.URL + tt.path)
|
||||
if err != nil {
|
||||
t.Fatalf("request failed: %v", err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode != http.StatusNotFound {
|
||||
t.Errorf("want 404 for missing upstream artifact, got %d", resp.StatusCode)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestJuliaPackageUpstreamNotFoundReturns404(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
fetcher.fetchErr = fetch.ErrNotFound
|
||||
|
||||
dead := httptest.NewServer(http.NotFoundHandler())
|
||||
defer dead.Close()
|
||||
|
||||
h := NewJuliaHandler(proxy, "http://localhost")
|
||||
h.upstreamURL = dead.URL
|
||||
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
resp, err := http.Get(srv.URL +
|
||||
"/package/7876af07-990d-54b4-ab0e-23690620f79a/0123456789abcdef0123456789abcdef01234567")
|
||||
if err != nil {
|
||||
t.Fatalf("request failed: %v", err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode != http.StatusNotFound {
|
||||
t.Errorf("want 404 for missing upstream package, got %d", resp.StatusCode)
|
||||
}
|
||||
}
|
||||
|
||||
func TestComposerDownloadUpstreamNotFoundReturns404(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
fetcher.fetchErr = fetch.ErrNotFound
|
||||
|
||||
meta := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.URL.Path == "/p2/monolog/monolog.json" {
|
||||
_, _ = w.Write([]byte(`{
|
||||
"packages": {
|
||||
"monolog/monolog": [
|
||||
{"version": "2.9.1", "dist": {"url": "https://example.com/monolog-2.9.1.zip", "type": "zip"}}
|
||||
]
|
||||
}
|
||||
}`))
|
||||
return
|
||||
}
|
||||
http.NotFound(w, r)
|
||||
}))
|
||||
defer meta.Close()
|
||||
|
||||
h := &ComposerHandler{proxy: proxy, repoURL: meta.URL, proxyURL: "http://localhost"}
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
resp, err := http.Get(srv.URL + "/files/monolog/monolog/2.9.1/monolog-2.9.1.zip")
|
||||
if err != nil {
|
||||
t.Fatalf("request failed: %v", err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode != http.StatusNotFound {
|
||||
t.Errorf("want 404 for missing upstream dist, got %d", resp.StatusCode)
|
||||
}
|
||||
}
|
||||
|
||||
func TestContainerBlobUpstreamNotFoundReturns404(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
fetcher.fetchErr = fetch.ErrNotFound
|
||||
|
||||
h := &ContainerHandler{
|
||||
proxy: proxy,
|
||||
registryURL: "https://registry-1.docker.io",
|
||||
proxyURL: "http://localhost:8080",
|
||||
}
|
||||
|
||||
req := httptest.NewRequest(http.MethodGet,
|
||||
"/library/nginx/blobs/sha256:abc123def456abc123def456abc123def456abc123def456abc123def456abcd", nil)
|
||||
w := httptest.NewRecorder()
|
||||
h.Routes().ServeHTTP(w, req)
|
||||
|
||||
if w.Code != http.StatusNotFound {
|
||||
t.Errorf("want 404 for missing upstream blob, got %d; body: %s", w.Code, w.Body.String())
|
||||
}
|
||||
if !strings.Contains(w.Body.String(), "BLOB_UNKNOWN") {
|
||||
t.Errorf("want BLOB_UNKNOWN error code in body, got: %s", w.Body.String())
|
||||
}
|
||||
}
|
||||
|
|
@ -1,83 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/git-pkgs/registries/fetch"
|
||||
)
|
||||
|
||||
func TestErrUpstreamNotFoundWrapsFetchErrNotFound(t *testing.T) {
|
||||
if !errors.Is(ErrUpstreamNotFound, fetch.ErrNotFound) {
|
||||
t.Fatal("ErrUpstreamNotFound does not wrap fetch.ErrNotFound")
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetOrFetchArtifactFromURL_NotFound(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
fetcher.fetchErr = fetch.ErrNotFound
|
||||
|
||||
_, err := proxy.GetOrFetchArtifactFromURL(context.Background(),
|
||||
"maven", "org.example:missing", "1.0", "missing-1.0.jar",
|
||||
"http://upstream.test/org/example/missing/1.0/missing-1.0.jar")
|
||||
|
||||
if !errors.Is(err, ErrUpstreamNotFound) {
|
||||
t.Fatalf("want ErrUpstreamNotFound, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestMavenHandler_UpstreamNotFoundReturns404(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
fetcher.fetchErr = fetch.ErrNotFound
|
||||
|
||||
h := NewMavenHandler(proxy, "http://localhost", "http://upstream.test", "http://portal.test")
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
resp, err := http.Get(srv.URL + "/org/example/missing/1.0/missing-1.0.jar")
|
||||
if err != nil {
|
||||
t.Fatalf("request failed: %v", err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode != http.StatusNotFound {
|
||||
t.Errorf("want 404 for missing upstream artifact, got %d", resp.StatusCode)
|
||||
}
|
||||
}
|
||||
|
||||
func TestMavenHandler_PluginPortalFallback(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
fetcher.fetchErrByURL = map[string]error{
|
||||
"http://upstream.test/org/example/plugin/1.0/plugin-1.0.jar": fetch.ErrNotFound,
|
||||
}
|
||||
fetcher.artifact = &fetch.Artifact{
|
||||
Body: io.NopCloser(strings.NewReader("portal artifact")),
|
||||
ContentType: "application/java-archive",
|
||||
}
|
||||
|
||||
h := NewMavenHandler(proxy, "http://localhost", "http://upstream.test", "http://portal.test")
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
resp, err := http.Get(srv.URL + "/org/example/plugin/1.0/plugin-1.0.jar")
|
||||
if err != nil {
|
||||
t.Fatalf("request failed: %v", err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
t.Fatalf("want 200 via plugin portal fallback, got %d", resp.StatusCode)
|
||||
}
|
||||
body, _ := io.ReadAll(resp.Body)
|
||||
if string(body) != "portal artifact" {
|
||||
t.Errorf("want portal artifact body, got %q", body)
|
||||
}
|
||||
if fetcher.fetchedURL != "http://portal.test/org/example/plugin/1.0/plugin-1.0.jar" {
|
||||
t.Errorf("fallback did not hit plugin portal, last URL: %s", fetcher.fetchedURL)
|
||||
}
|
||||
}
|
||||
|
|
@ -9,11 +9,13 @@ import (
|
|||
"sort"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/purl"
|
||||
)
|
||||
|
||||
const (
|
||||
npmUpstream = "https://registry.npmjs.org"
|
||||
npmAcceptDefault = "application/vnd.npm.install-v1+json;q=1.0, application/json;q=0.8"
|
||||
npmAbbreviatedCT = "application/vnd.npm.install-v1+json"
|
||||
scopedParts = 2 // scope + name in scoped packages
|
||||
)
|
||||
|
||||
|
|
@ -25,14 +27,10 @@ type NPMHandler struct {
|
|||
}
|
||||
|
||||
// NewNPMHandler creates a new npm protocol handler.
|
||||
func NewNPMHandler(proxy *Proxy, proxyURL, upstreamURL string) *NPMHandler {
|
||||
if strings.TrimSpace(upstreamURL) == "" {
|
||||
upstreamURL = npmUpstream
|
||||
}
|
||||
|
||||
func NewNPMHandler(proxy *Proxy, proxyURL string) *NPMHandler {
|
||||
return &NPMHandler{
|
||||
proxy: proxy,
|
||||
upstreamURL: strings.TrimSuffix(upstreamURL, "/"),
|
||||
upstreamURL: npmUpstream,
|
||||
proxyURL: strings.TrimSuffix(proxyURL, "/"),
|
||||
}
|
||||
}
|
||||
|
|
@ -71,15 +69,10 @@ func (h *NPMHandler) handlePackageMetadata(w http.ResponseWriter, r *http.Reques
|
|||
|
||||
upstreamURL := fmt.Sprintf("%s/%s", h.upstreamURL, url.PathEscape(packageName))
|
||||
|
||||
// Prefer the smaller abbreviated packument format but include application/json
|
||||
// as a fallback so upstreams that reject the abbreviated type (e.g. JFrog
|
||||
// Artifactory, which returns 406) can still respond with full metadata.
|
||||
// When cooldown is enabled we must use full metadata exclusively because the
|
||||
// abbreviated format omits the "time" map required for version age filtering.
|
||||
// Operators can also force full metadata so clients that gate on publish
|
||||
// age (for example Yarn's npmMinimalAgeGate) keep working through the proxy.
|
||||
accept := npmAcceptDefault
|
||||
if h.proxy.NPMFullMetadata || (h.proxy.Cooldown != nil && h.proxy.Cooldown.Enabled()) {
|
||||
// Use abbreviated metadata when cooldown is disabled — it's much smaller
|
||||
// (e.g. drizzle-orm: 4MB vs 92MB) but lacks the time map needed for cooldown.
|
||||
accept := npmAbbreviatedCT
|
||||
if h.proxy.Cooldown != nil && h.proxy.Cooldown.Enabled() {
|
||||
accept = contentTypeJSON
|
||||
}
|
||||
|
||||
|
|
@ -98,13 +91,13 @@ func (h *NPMHandler) handlePackageMetadata(w http.ResponseWriter, r *http.Reques
|
|||
if err != nil {
|
||||
// If rewriting fails, just proxy the original
|
||||
h.proxy.Logger.Warn("failed to rewrite metadata, proxying original", "error", err)
|
||||
w.Header().Set(headerContentType, contentTypeJSON)
|
||||
w.Header().Set("Content-Type", contentTypeJSON)
|
||||
w.WriteHeader(http.StatusOK)
|
||||
_, _ = w.Write(body)
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set(headerContentType, contentTypeJSON)
|
||||
w.Header().Set("Content-Type", contentTypeJSON)
|
||||
w.WriteHeader(http.StatusOK)
|
||||
_, _ = w.Write(rewritten)
|
||||
}
|
||||
|
|
@ -141,7 +134,7 @@ func (h *NPMHandler) applyCooldownFiltering(metadata map[string]any, versions ma
|
|||
return
|
||||
}
|
||||
|
||||
packagePURL := canonicalPackagePURL("npm", packageName)
|
||||
packagePURL := purl.MakePURLString("npm", packageName, "")
|
||||
|
||||
for version := range versions {
|
||||
publishedStr, ok := timeMap[version].(string)
|
||||
|
|
@ -270,103 +263,16 @@ func (h *NPMHandler) handleDownload(w http.ResponseWriter, r *http.Request) {
|
|||
h.proxy.Logger.Info("npm download request",
|
||||
"package", packageName, "version", version, "filename", filename)
|
||||
|
||||
if h.versionInCooldown(r, packageName, version) {
|
||||
h.proxy.Logger.Info("cooldown: withholding npm tarball",
|
||||
"package", packageName, "version", version)
|
||||
JSONError(w, http.StatusNotFound, "version not found")
|
||||
return
|
||||
}
|
||||
|
||||
downloadURL := fmt.Sprintf(
|
||||
"%s/%s/-/%s",
|
||||
h.upstreamURL,
|
||||
escapeNPMDownloadPackage(packageName),
|
||||
url.PathEscape(filename),
|
||||
)
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURL(
|
||||
r.Context(), "npm", packageName, version, filename, downloadURL,
|
||||
)
|
||||
result, err := h.proxy.GetOrFetchArtifact(r.Context(), "npm", packageName, version, filename)
|
||||
if err != nil {
|
||||
switch {
|
||||
case errors.Is(err, ErrUpstreamNotFound):
|
||||
JSONError(w, http.StatusNotFound, "package not found")
|
||||
case errors.Is(err, ErrArtifactBlocked):
|
||||
JSONError(w, http.StatusForbidden, err.Error())
|
||||
default:
|
||||
h.proxy.Logger.Error("failed to get artifact", "error", err)
|
||||
JSONError(w, http.StatusBadGateway, "failed to fetch package")
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
ServeArtifact(w, result)
|
||||
}
|
||||
|
||||
// versionInCooldown reports whether a version is still inside the cooldown
|
||||
// window. Filtering the packument is not enough on its own: tarball URLs are
|
||||
// predictable and lockfiles record them directly, so `npm ci` reaches the
|
||||
// download path without ever requesting metadata.
|
||||
//
|
||||
// A version's publish time is immutable, so the check reads the stored
|
||||
// versions row first and only falls back to the packument for a version the
|
||||
// proxy has never seen, persisting the parsed time so the packument is
|
||||
// fetched and parsed at most once per version. A version with no usable
|
||||
// publish time is allowed through, matching how applyCooldownFiltering
|
||||
// treats it.
|
||||
func (h *NPMHandler) versionInCooldown(r *http.Request, packageName, version string) bool {
|
||||
if h.proxy.Cooldown == nil || !h.proxy.Cooldown.Enabled() {
|
||||
return false
|
||||
}
|
||||
|
||||
versionPURL := canonicalVersionPURL("npm", packageName, version)
|
||||
if ver, err := h.proxy.DB.GetVersionByPURL(versionPURL); err == nil && ver != nil && ver.PublishedAt.Valid {
|
||||
return !h.proxy.Cooldown.IsAllowed("npm", canonicalPackagePURL("npm", packageName), ver.PublishedAt.Time)
|
||||
}
|
||||
|
||||
upstreamURL := fmt.Sprintf("%s/%s", h.upstreamURL, url.PathEscape(packageName))
|
||||
|
||||
body, _, err := h.proxy.FetchOrCacheMetadata(r.Context(), "npm", packageName, upstreamURL, contentTypeJSON)
|
||||
if err != nil {
|
||||
h.proxy.Logger.Warn("cooldown: could not fetch npm metadata for download check",
|
||||
"package", packageName, "version", version, "error", err)
|
||||
return false
|
||||
}
|
||||
|
||||
var metadata struct {
|
||||
Time map[string]string `json:"time"`
|
||||
}
|
||||
if err := json.Unmarshal(body, &metadata); err != nil {
|
||||
h.proxy.Logger.Warn("cooldown: could not parse npm metadata for download check",
|
||||
"package", packageName, "version", version, "error", err)
|
||||
return false
|
||||
}
|
||||
|
||||
published, ok := metadata.Time[version]
|
||||
if !ok {
|
||||
return false
|
||||
}
|
||||
|
||||
publishedAt, err := time.Parse(time.RFC3339, published)
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
|
||||
if err := h.proxy.DB.SetVersionPublishedAt(versionPURL, canonicalPackagePURL("npm", packageName), publishedAt); err != nil {
|
||||
h.proxy.Logger.Warn("cooldown: could not store npm publish time",
|
||||
"package", packageName, "version", version, "error", err)
|
||||
}
|
||||
|
||||
return !h.proxy.Cooldown.IsAllowed("npm", canonicalPackagePURL("npm", packageName), publishedAt)
|
||||
}
|
||||
|
||||
func escapeNPMDownloadPackage(packageName string) string {
|
||||
scope, name, scoped := strings.Cut(packageName, "/")
|
||||
if scoped && strings.HasPrefix(scope, "@") && len(scope) > 1 && name != "" && !strings.Contains(name, "/") {
|
||||
return url.PathEscape(scope) + "/" + url.PathEscape(name)
|
||||
}
|
||||
return url.PathEscape(packageName)
|
||||
}
|
||||
|
||||
// extractPackageName extracts the package name from the request path.
|
||||
// Handles both scoped (@scope/name) and unscoped (name) packages.
|
||||
func (h *NPMHandler) extractPackageName(r *http.Request) string {
|
||||
|
|
|
|||
|
|
@ -2,18 +2,13 @@ package handler
|
|||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"io"
|
||||
"log/slog"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/cooldown"
|
||||
"github.com/git-pkgs/registries/fetch"
|
||||
"github.com/git-pkgs/proxy/internal/cooldown"
|
||||
)
|
||||
|
||||
const testVersion100 = "1.0.0"
|
||||
|
|
@ -51,86 +46,6 @@ func TestNPMExtractVersionFromFilename(t *testing.T) {
|
|||
}
|
||||
}
|
||||
|
||||
func TestNPMHandlerUsesConfiguredUpstream(t *testing.T) {
|
||||
t.Run("metadata", func(t *testing.T) {
|
||||
var requestPath, authHeader string
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
requestPath = r.URL.Path
|
||||
authHeader = r.Header.Get("Authorization")
|
||||
if authHeader != "Bearer npm-token" {
|
||||
w.WriteHeader(http.StatusUnauthorized)
|
||||
return
|
||||
}
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = io.WriteString(w, `{"versions":{}}`)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
proxy.AuthForURL = func(string) (string, string) {
|
||||
return "Authorization", "Bearer npm-token"
|
||||
}
|
||||
h := NewNPMHandler(proxy, "http://proxy.test", upstream.URL+"/root/")
|
||||
|
||||
req := httptest.NewRequest(http.MethodGet, "/testpkg", nil)
|
||||
w := httptest.NewRecorder()
|
||||
h.Routes().ServeHTTP(w, req)
|
||||
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, want %d; body: %s", w.Code, http.StatusOK, w.Body.String())
|
||||
}
|
||||
if requestPath != "/root/testpkg" {
|
||||
t.Errorf("upstream path = %q, want %q", requestPath, "/root/testpkg")
|
||||
}
|
||||
if authHeader != "Bearer npm-token" {
|
||||
t.Errorf("Authorization = %q, want %q", authHeader, "Bearer npm-token")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("download", func(t *testing.T) {
|
||||
proxy, _, _, artifactFetcher := setupTestProxy(t)
|
||||
artifactFetcher.artifact = &fetch.Artifact{
|
||||
Body: io.NopCloser(strings.NewReader("package")),
|
||||
ContentType: "application/gzip",
|
||||
}
|
||||
h := NewNPMHandler(proxy, "http://proxy.test", "https://npm.example.test/root/")
|
||||
|
||||
req := httptest.NewRequest(http.MethodGet, "/testpkg/-/testpkg-1.0.0.tgz", nil)
|
||||
w := httptest.NewRecorder()
|
||||
h.Routes().ServeHTTP(w, req)
|
||||
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, want %d; body: %s", w.Code, http.StatusOK, w.Body.String())
|
||||
}
|
||||
want := "https://npm.example.test/root/testpkg/-/testpkg-1.0.0.tgz"
|
||||
if artifactFetcher.fetchedURL != want {
|
||||
t.Errorf("fetched URL = %q, want %q", artifactFetcher.fetchedURL, want)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("scoped download", func(t *testing.T) {
|
||||
proxy, _, _, artifactFetcher := setupTestProxy(t)
|
||||
artifactFetcher.artifact = &fetch.Artifact{
|
||||
Body: io.NopCloser(strings.NewReader("package")),
|
||||
ContentType: "application/gzip",
|
||||
}
|
||||
h := NewNPMHandler(proxy, "http://proxy.test", "https://npm.example.test/root/")
|
||||
|
||||
req := httptest.NewRequest(http.MethodGet, "/@scope/name/-/name-1.0.0.tgz", nil)
|
||||
w := httptest.NewRecorder()
|
||||
h.Routes().ServeHTTP(w, req)
|
||||
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, want %d; body: %s", w.Code, http.StatusOK, w.Body.String())
|
||||
}
|
||||
want := "https://npm.example.test/root/@scope/name/-/name-1.0.0.tgz"
|
||||
if artifactFetcher.fetchedURL != want {
|
||||
t.Errorf("fetched URL = %q, want %q", artifactFetcher.fetchedURL, want)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestNPMRewriteMetadata(t *testing.T) {
|
||||
h := &NPMHandler{
|
||||
proxy: testProxy(),
|
||||
|
|
@ -398,7 +313,7 @@ func TestNPMHandlerUsesAbbreviatedMetadata(t *testing.T) {
|
|||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
t.Run("no cooldown uses combined accept header", func(t *testing.T) {
|
||||
t.Run("no cooldown uses abbreviated metadata", func(t *testing.T) {
|
||||
h := &NPMHandler{
|
||||
proxy: testProxy(),
|
||||
upstreamURL: upstream.URL,
|
||||
|
|
@ -409,12 +324,12 @@ func TestNPMHandlerUsesAbbreviatedMetadata(t *testing.T) {
|
|||
w := httptest.NewRecorder()
|
||||
h.handlePackageMetadata(w, req)
|
||||
|
||||
if gotAccept != npmAcceptDefault {
|
||||
t.Errorf("Accept = %q, want %q", gotAccept, npmAcceptDefault)
|
||||
if gotAccept != npmAbbreviatedCT {
|
||||
t.Errorf("Accept = %q, want abbreviated metadata header", gotAccept)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("cooldown enabled uses full metadata only", func(t *testing.T) {
|
||||
t.Run("cooldown enabled uses full metadata", func(t *testing.T) {
|
||||
proxy := testProxy()
|
||||
proxy.Cooldown = &cooldown.Config{Default: "3d"}
|
||||
|
||||
|
|
@ -428,27 +343,8 @@ func TestNPMHandlerUsesAbbreviatedMetadata(t *testing.T) {
|
|||
w := httptest.NewRecorder()
|
||||
h.handlePackageMetadata(w, req)
|
||||
|
||||
if gotAccept != contentTypeJSON {
|
||||
t.Errorf("Accept = %q, want %q (cooldown requires full metadata)", gotAccept, contentTypeJSON)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("full metadata option uses full metadata without cooldown", func(t *testing.T) {
|
||||
proxy := testProxy()
|
||||
proxy.NPMFullMetadata = true
|
||||
|
||||
h := &NPMHandler{
|
||||
proxy: proxy,
|
||||
upstreamURL: upstream.URL,
|
||||
proxyURL: "http://proxy.local",
|
||||
}
|
||||
|
||||
req := httptest.NewRequest(http.MethodGet, "/testpkg", nil)
|
||||
w := httptest.NewRecorder()
|
||||
h.handlePackageMetadata(w, req)
|
||||
|
||||
if gotAccept != contentTypeJSON {
|
||||
t.Errorf("Accept = %q, want %q (npm_full_metadata requires full metadata)", gotAccept, contentTypeJSON)
|
||||
if gotAccept == npmAbbreviatedCT {
|
||||
t.Error("cooldown enabled should use full metadata, not abbreviated")
|
||||
}
|
||||
})
|
||||
}
|
||||
|
|
@ -475,237 +371,3 @@ func TestNPMHandlerMetadataNotFound(t *testing.T) {
|
|||
t.Errorf("status = %d, want %d", w.Code, http.StatusNotFound)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNPMDownloadCooldown(t *testing.T) {
|
||||
now := time.Now()
|
||||
packument := `{
|
||||
"name": "leftpad",
|
||||
"dist-tags": {"latest": "2.0.0"},
|
||||
"time": {
|
||||
"1.0.0": "` + now.Add(-30*24*time.Hour).Format(time.RFC3339) + `",
|
||||
"2.0.0": "` + now.Add(-1*time.Hour).Format(time.RFC3339) + `"
|
||||
},
|
||||
"versions": {"1.0.0": {}, "2.0.0": {}}
|
||||
}`
|
||||
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||
w.Header().Set("Content-Type", contentTypeJSON)
|
||||
_, _ = io.WriteString(w, packument)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
version string
|
||||
wantStatus int
|
||||
}{
|
||||
{"published before the window serves the tarball", testVersion100, http.StatusOK},
|
||||
{"published inside the window is withheld", "2.0.0", http.StatusNotFound},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
proxy.Cooldown = &cooldown.Config{Default: "7d"}
|
||||
fetcher.artifact = &fetch.Artifact{
|
||||
Body: io.NopCloser(strings.NewReader("tarball data")),
|
||||
ContentType: "application/octet-stream",
|
||||
}
|
||||
|
||||
h := NewNPMHandler(proxy, "http://proxy.test", upstream.URL)
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
resp, err := http.Get(srv.URL + "/leftpad/-/leftpad-" + tt.version + ".tgz")
|
||||
if err != nil {
|
||||
t.Fatalf("request failed: %v", err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode != tt.wantStatus {
|
||||
t.Errorf("status = %d, want %d", resp.StatusCode, tt.wantStatus)
|
||||
}
|
||||
if tt.wantStatus == http.StatusNotFound && fetcher.fetchCalled {
|
||||
t.Error("fetched a version that is still inside the cooldown window")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestNPMDownloadCooldownDisabled(t *testing.T) {
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||
t.Error("metadata must not be fetched when cooldown is disabled")
|
||||
w.WriteHeader(http.StatusInternalServerError)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
fetcher.artifact = &fetch.Artifact{
|
||||
Body: io.NopCloser(strings.NewReader("tarball data")),
|
||||
ContentType: "application/octet-stream",
|
||||
}
|
||||
|
||||
h := NewNPMHandler(proxy, "http://proxy.test", upstream.URL)
|
||||
|
||||
if h.versionInCooldown(httptest.NewRequest(http.MethodGet, "/", nil), "leftpad", testVersion100) {
|
||||
t.Error("versionInCooldown = true, want false when cooldown is not configured")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNPMDownloadCooldownUsesStoredPublishTime(t *testing.T) {
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||
t.Error("metadata must not be fetched when the publish time is already stored")
|
||||
w.WriteHeader(http.StatusInternalServerError)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
version string
|
||||
publishedAt time.Time
|
||||
wantStatus int
|
||||
}{
|
||||
{"stored time before the window serves the tarball", testVersion100, time.Now().Add(-30 * 24 * time.Hour), http.StatusOK},
|
||||
{"stored time inside the window is withheld", "2.0.0", time.Now().Add(-1 * time.Hour), http.StatusNotFound},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
proxy, db, _, fetcher := setupTestProxy(t)
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
proxy.Cooldown = &cooldown.Config{Default: "7d"}
|
||||
fetcher.artifact = &fetch.Artifact{
|
||||
Body: io.NopCloser(strings.NewReader("tarball data")),
|
||||
ContentType: "application/octet-stream",
|
||||
}
|
||||
|
||||
if err := db.SetVersionPublishedAt("pkg:npm/leftpad@"+tt.version, "pkg:npm/leftpad", tt.publishedAt); err != nil {
|
||||
t.Fatalf("seeding publish time failed: %v", err)
|
||||
}
|
||||
|
||||
h := NewNPMHandler(proxy, "http://proxy.test", upstream.URL)
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
resp, err := http.Get(srv.URL + "/leftpad/-/leftpad-" + tt.version + ".tgz")
|
||||
if err != nil {
|
||||
t.Fatalf("request failed: %v", err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode != tt.wantStatus {
|
||||
t.Errorf("status = %d, want %d", resp.StatusCode, tt.wantStatus)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestNPMDownloadCooldownFetchesMetadataOnce(t *testing.T) {
|
||||
now := time.Now()
|
||||
packument := `{
|
||||
"name": "leftpad",
|
||||
"dist-tags": {"latest": "1.0.0"},
|
||||
"time": {
|
||||
"1.0.0": "` + now.Add(-30*24*time.Hour).Format(time.RFC3339) + `"
|
||||
},
|
||||
"versions": {"1.0.0": {}}
|
||||
}`
|
||||
|
||||
var metadataRequests atomic.Int64
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||
metadataRequests.Add(1)
|
||||
w.Header().Set("Content-Type", contentTypeJSON)
|
||||
_, _ = io.WriteString(w, packument)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
proxy.Cooldown = &cooldown.Config{Default: "7d"}
|
||||
|
||||
h := NewNPMHandler(proxy, "http://proxy.test", upstream.URL)
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
// The first download parses the packument once and persists the publish
|
||||
// time; caching the artifact afterwards upserts the versions row without a
|
||||
// publish time, which must not erase the stored value. The second download
|
||||
// must answer from the stored time alone.
|
||||
for i := 0; i < 2; i++ {
|
||||
fetcher.artifact = &fetch.Artifact{
|
||||
Body: io.NopCloser(strings.NewReader("tarball data")),
|
||||
ContentType: "application/octet-stream",
|
||||
}
|
||||
resp, err := http.Get(srv.URL + "/leftpad/-/leftpad-" + testVersion100 + ".tgz")
|
||||
if err != nil {
|
||||
t.Fatalf("request %d failed: %v", i+1, err)
|
||||
}
|
||||
_ = resp.Body.Close()
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
t.Fatalf("request %d status = %d, want %d", i+1, resp.StatusCode, http.StatusOK)
|
||||
}
|
||||
}
|
||||
|
||||
if got := metadataRequests.Load(); got != 1 {
|
||||
t.Errorf("metadata requests = %d, want 1", got)
|
||||
}
|
||||
}
|
||||
|
||||
// TestNPMDownloadErrorResponsesAreJSON guards against a regression where
|
||||
// routing handleDownload's error path through the shared serveArtifactError
|
||||
// helper silently switched npm's 404/502 tarball error bodies from JSON to
|
||||
// plain text; npm clients expect a JSON {"error": "..."} body on every
|
||||
// download failure, including the newer scan-blocked (403) case.
|
||||
func TestNPMDownloadErrorResponsesAreJSON(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
fetchErr error
|
||||
blocked bool
|
||||
wantStatus int
|
||||
}{
|
||||
{"upstream not found", fetch.ErrNotFound, false, http.StatusNotFound},
|
||||
{"upstream failure", errors.New("connection refused"), false, http.StatusBadGateway},
|
||||
{"blocked by scan", nil, true, http.StatusForbidden},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
proxy, _, _, fetcher := setupTestProxy(t)
|
||||
proxy.ScanSigningKey = []byte("test-signing-key")
|
||||
if tt.blocked {
|
||||
proxy.Scanners = newTestScanGroup(t, newTestScanServer(t, false, "malware detected").URL, false)
|
||||
}
|
||||
fetcher.fetchErr = tt.fetchErr
|
||||
fetcher.artifact = &fetch.Artifact{
|
||||
Body: io.NopCloser(strings.NewReader("tarball data")),
|
||||
ContentType: "application/octet-stream",
|
||||
}
|
||||
|
||||
h := NewNPMHandler(proxy, "http://proxy.test", "http://upstream.invalid")
|
||||
srv := httptest.NewServer(h.Routes())
|
||||
defer srv.Close()
|
||||
|
||||
resp, err := http.Get(srv.URL + "/leftpad/-/leftpad-1.0.0.tgz")
|
||||
if err != nil {
|
||||
t.Fatalf("request failed: %v", err)
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode != tt.wantStatus {
|
||||
t.Errorf("status = %d, want %d", resp.StatusCode, tt.wantStatus)
|
||||
}
|
||||
if ct := resp.Header.Get("Content-Type"); ct != contentTypeJSON {
|
||||
t.Errorf("Content-Type = %q, want %q", ct, contentTypeJSON)
|
||||
}
|
||||
var body map[string]any
|
||||
if err := json.NewDecoder(resp.Body).Decode(&body); err != nil {
|
||||
t.Fatalf("response body is not valid JSON: %v", err)
|
||||
}
|
||||
if _, ok := body["error"]; !ok {
|
||||
t.Errorf("response body %v missing \"error\" key", body)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -7,18 +7,19 @@ import (
|
|||
"io"
|
||||
"net/http"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/purl"
|
||||
)
|
||||
|
||||
const (
|
||||
nugetUpstream = "https://api.nuget.org"
|
||||
nugetSearchUpstream = "https://azuresearch-usnc.nuget.org"
|
||||
)
|
||||
|
||||
// NuGetHandler handles NuGet V3 API protocol requests.
|
||||
type NuGetHandler struct {
|
||||
proxy *Proxy
|
||||
upstreamURL string
|
||||
searchURL string
|
||||
proxyURL string
|
||||
}
|
||||
|
||||
|
|
@ -27,20 +28,10 @@ func NewNuGetHandler(proxy *Proxy, proxyURL string) *NuGetHandler {
|
|||
return &NuGetHandler{
|
||||
proxy: proxy,
|
||||
upstreamURL: nugetUpstream,
|
||||
searchURL: nugetSearchUpstream,
|
||||
proxyURL: strings.TrimSuffix(proxyURL, "/"),
|
||||
}
|
||||
}
|
||||
|
||||
// NewNuGetHandlerWithUpstreams creates a NuGet handler with custom API and
|
||||
// search upstreams.
|
||||
func NewNuGetHandlerWithUpstreams(proxy *Proxy, proxyURL, upstreamURL, searchURL string) *NuGetHandler {
|
||||
h := NewNuGetHandler(proxy, proxyURL)
|
||||
h.upstreamURL = configuredUpstreamURL(upstreamURL, nugetUpstream)
|
||||
h.searchURL = configuredUpstreamURL(searchURL, nugetSearchUpstream)
|
||||
return h
|
||||
}
|
||||
|
||||
// Routes returns the HTTP handler for NuGet requests.
|
||||
func (h *NuGetHandler) Routes() http.Handler {
|
||||
mux := http.NewServeMux()
|
||||
|
|
@ -50,12 +41,10 @@ func (h *NuGetHandler) Routes() http.Handler {
|
|||
|
||||
// Package content (downloads)
|
||||
mux.HandleFunc("GET /v3-flatcontainer/{id}/{version}/{filename}", h.handleDownload)
|
||||
mux.HandleFunc("GET /v3-flatcontainer/{id}/index.json", h.handleVersionList)
|
||||
mux.HandleFunc("GET /v3-flatcontainer/{id}/index.json", h.proxyUpstream)
|
||||
|
||||
// Registration (package metadata) - use prefix matching since {version}.json isn't allowed
|
||||
for _, prefix := range nugetRegistrationPrefixes {
|
||||
mux.HandleFunc("GET "+prefix, h.handleRegistration)
|
||||
}
|
||||
mux.HandleFunc("GET /v3/registration5-gz-semver2/", h.handleRegistration)
|
||||
|
||||
// Search
|
||||
mux.HandleFunc("GET /query", h.proxyUpstream)
|
||||
|
|
@ -85,17 +74,13 @@ func (h *NuGetHandler) handleServiceIndex(w http.ResponseWriter, r *http.Request
|
|||
|
||||
rewritten, err := h.rewriteServiceIndex(body)
|
||||
if err != nil {
|
||||
if h.cooldownEnabled() {
|
||||
h.nugetMetadataError(w, err)
|
||||
return
|
||||
}
|
||||
h.proxy.Logger.Warn("failed to rewrite service index, proxying original", "error", err)
|
||||
w.Header().Set(headerContentType, "application/json")
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = w.Write(body)
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set(headerContentType, "application/json")
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = w.Write(rewritten)
|
||||
}
|
||||
|
||||
|
|
@ -120,35 +105,189 @@ func (h *NuGetHandler) rewriteServiceIndex(body []byte) ([]byte, error) {
|
|||
id, _ := rmap["@id"].(string)
|
||||
rtype, _ := rmap["@type"].(string)
|
||||
|
||||
// Rewrite URLs for services we proxy. The service type determines the
|
||||
// local route because an upstream index may advertise a different host.
|
||||
if id != "" {
|
||||
rmap["@id"] = h.rewriteNuGetURL(id, rtype)
|
||||
// Rewrite URLs for services we proxy
|
||||
if id != "" && h.shouldRewriteService(rtype) {
|
||||
newURL := h.rewriteNuGetURL(id)
|
||||
rmap["@id"] = newURL
|
||||
}
|
||||
}
|
||||
|
||||
return json.Marshal(index)
|
||||
}
|
||||
|
||||
// rewriteNuGetURL rewrites a NuGet service URL based on its advertised type.
|
||||
// Service types the proxy does not handle are returned unchanged.
|
||||
func (h *NuGetHandler) rewriteNuGetURL(origURL, serviceType string) string {
|
||||
switch serviceType {
|
||||
case "PackageBaseAddress/3.0.0":
|
||||
return h.proxyURL + "/nuget/v3-flatcontainer/"
|
||||
case "RegistrationsBaseUrl", "RegistrationsBaseUrl/3.0.0-beta", "RegistrationsBaseUrl/3.0.0-rc":
|
||||
return h.proxyURL + "/nuget/v3/registration5-semver1/"
|
||||
case "RegistrationsBaseUrl/3.4.0":
|
||||
return h.proxyURL + "/nuget/v3/registration5-gz-semver1/"
|
||||
case "RegistrationsBaseUrl/3.6.0", "RegistrationsBaseUrl/Versioned":
|
||||
return h.proxyURL + "/nuget/v3/registration5-gz-semver2/"
|
||||
case "SearchQueryService", "SearchQueryService/3.0.0-rc", "SearchQueryService/3.5.0":
|
||||
return h.proxyURL + "/nuget/query"
|
||||
case "SearchAutocompleteService", "SearchAutocompleteService/3.5.0":
|
||||
return h.proxyURL + "/nuget/autocomplete"
|
||||
default:
|
||||
// shouldRewriteService returns true if the service type should be rewritten.
|
||||
func (h *NuGetHandler) shouldRewriteService(serviceType string) bool {
|
||||
// Rewrite package content and registration services
|
||||
rewriteTypes := []string{
|
||||
"PackageBaseAddress/3.0.0",
|
||||
"RegistrationsBaseUrl/3.6.0",
|
||||
"RegistrationsBaseUrl/Versioned",
|
||||
"SearchQueryService",
|
||||
"SearchQueryService/3.0.0-rc",
|
||||
"SearchQueryService/3.5.0",
|
||||
"SearchAutocompleteService",
|
||||
"SearchAutocompleteService/3.5.0",
|
||||
}
|
||||
|
||||
for _, t := range rewriteTypes {
|
||||
if serviceType == t {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// rewriteNuGetURL rewrites a NuGet API URL to point at this proxy.
|
||||
func (h *NuGetHandler) rewriteNuGetURL(origURL string) string {
|
||||
// Map known NuGet API endpoints to our proxy paths
|
||||
replacements := map[string]string{
|
||||
"https://api.nuget.org/v3-flatcontainer/": h.proxyURL + "/nuget/v3-flatcontainer/",
|
||||
"https://api.nuget.org/v3/registration5-gz-semver2/": h.proxyURL + "/nuget/v3/registration5-gz-semver2/",
|
||||
"https://azuresearch-usnc.nuget.org/query": h.proxyURL + "/nuget/query",
|
||||
"https://azuresearch-usnc.nuget.org/autocomplete": h.proxyURL + "/nuget/autocomplete",
|
||||
}
|
||||
|
||||
for old, new := range replacements {
|
||||
if strings.HasPrefix(origURL, old) {
|
||||
return strings.Replace(origURL, old, new, 1)
|
||||
}
|
||||
}
|
||||
|
||||
return origURL
|
||||
}
|
||||
|
||||
// handleRegistration proxies NuGet registration pages, applying cooldown filtering.
|
||||
func (h *NuGetHandler) handleRegistration(w http.ResponseWriter, r *http.Request) {
|
||||
if h.proxy.Cooldown == nil || !h.proxy.Cooldown.Enabled() {
|
||||
h.proxyUpstream(w, r)
|
||||
return
|
||||
}
|
||||
|
||||
upstreamURL := h.buildUpstreamURL(r)
|
||||
|
||||
h.proxy.Logger.Debug("fetching registration for cooldown filtering", "url", upstreamURL)
|
||||
|
||||
req, err := http.NewRequestWithContext(r.Context(), http.MethodGet, upstreamURL, nil)
|
||||
if err != nil {
|
||||
http.Error(w, "failed to create request", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
req.Header.Set(headerAcceptEncoding, "gzip")
|
||||
|
||||
resp, err := h.proxy.HTTPClient.Do(req)
|
||||
if err != nil {
|
||||
h.proxy.Logger.Error("upstream request failed", "error", err)
|
||||
http.Error(w, "upstream request failed", http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
defer func() { _ = resp.Body.Close() }()
|
||||
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
for k, vv := range resp.Header {
|
||||
for _, v := range vv {
|
||||
w.Header().Add(k, v)
|
||||
}
|
||||
}
|
||||
w.WriteHeader(resp.StatusCode)
|
||||
_, _ = io.Copy(w, resp.Body)
|
||||
return
|
||||
}
|
||||
|
||||
body, err := ReadMetadata(resp.Body)
|
||||
if err != nil {
|
||||
http.Error(w, "failed to read response", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
|
||||
filtered, err := h.applyCooldownFiltering(body)
|
||||
if err != nil {
|
||||
h.proxy.Logger.Warn("failed to filter registration, proxying original", "error", err)
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = w.Write(body)
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = w.Write(filtered)
|
||||
}
|
||||
|
||||
// applyCooldownFiltering filters versions from NuGet registration pages
|
||||
// that are too recently published.
|
||||
func (h *NuGetHandler) applyCooldownFiltering(body []byte) ([]byte, error) {
|
||||
if h.proxy.Cooldown == nil || !h.proxy.Cooldown.Enabled() {
|
||||
return body, nil
|
||||
}
|
||||
|
||||
var registration map[string]any
|
||||
if err := json.Unmarshal(body, ®istration); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
pages, ok := registration["items"].([]any)
|
||||
if !ok {
|
||||
return body, nil
|
||||
}
|
||||
|
||||
for _, page := range pages {
|
||||
pageMap, ok := page.(map[string]any)
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
|
||||
items, ok := pageMap["items"].([]any)
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
|
||||
filtered := items[:0]
|
||||
for _, item := range items {
|
||||
itemMap, ok := item.(map[string]any)
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
|
||||
catalogEntry, ok := itemMap["catalogEntry"].(map[string]any)
|
||||
if !ok {
|
||||
filtered = append(filtered, item)
|
||||
continue
|
||||
}
|
||||
|
||||
version, _ := catalogEntry["version"].(string)
|
||||
id, _ := catalogEntry["id"].(string)
|
||||
publishedStr, _ := catalogEntry["published"].(string)
|
||||
|
||||
if publishedStr == "" {
|
||||
filtered = append(filtered, item)
|
||||
continue
|
||||
}
|
||||
|
||||
publishedAt, err := time.Parse(time.RFC3339, publishedStr)
|
||||
if err != nil {
|
||||
// NuGet uses a slightly non-standard format, try parsing with fractional seconds
|
||||
publishedAt, err = time.Parse("2006-01-02T15:04:05.999-07:00", publishedStr)
|
||||
if err != nil {
|
||||
filtered = append(filtered, item)
|
||||
continue
|
||||
}
|
||||
}
|
||||
|
||||
packagePURL := purl.MakePURLString("nuget", strings.ToLower(id), "")
|
||||
|
||||
if !h.proxy.Cooldown.IsAllowed("nuget", packagePURL, publishedAt) {
|
||||
h.proxy.Logger.Info("cooldown: filtering nuget version",
|
||||
"package", id, "version", version,
|
||||
"published", publishedStr)
|
||||
continue
|
||||
}
|
||||
|
||||
filtered = append(filtered, item)
|
||||
}
|
||||
|
||||
pageMap["items"] = filtered
|
||||
pageMap["count"] = len(filtered)
|
||||
}
|
||||
|
||||
return json.Marshal(registration)
|
||||
}
|
||||
|
||||
// handleDownload serves a package file, fetching and caching from upstream if needed.
|
||||
|
|
@ -162,18 +301,6 @@ func (h *NuGetHandler) handleDownload(w http.ResponseWriter, r *http.Request) {
|
|||
return
|
||||
}
|
||||
|
||||
if h.cooldownEnabled() {
|
||||
allowed, err := h.nugetDownloadAllowed(r.Context(), id, version)
|
||||
if err != nil {
|
||||
h.nugetMetadataError(w, err)
|
||||
return
|
||||
}
|
||||
if !allowed {
|
||||
JSONError(w, http.StatusNotFound, "version not found")
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// Only cache .nupkg files
|
||||
if !strings.HasSuffix(filename, ".nupkg") {
|
||||
h.proxyUpstream(w, r)
|
||||
|
|
@ -189,7 +316,8 @@ func (h *NuGetHandler) handleDownload(w http.ResponseWriter, r *http.Request) {
|
|||
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURL(r.Context(), "nuget", name, version, filename, upstreamURL)
|
||||
if err != nil {
|
||||
h.proxy.serveArtifactError(w, err, "failed to fetch package")
|
||||
h.proxy.Logger.Error("failed to get artifact", "error", err)
|
||||
http.Error(w, "failed to fetch package", http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
|
||||
|
|
@ -238,7 +366,7 @@ func (h *NuGetHandler) buildUpstreamURL(r *http.Request) string {
|
|||
|
||||
// Handle query and autocomplete which go to azuresearch
|
||||
if strings.HasPrefix(path, "/query") || strings.HasPrefix(path, "/autocomplete") {
|
||||
return h.searchURL + path + "?" + r.URL.RawQuery
|
||||
return "https://azuresearch-usnc.nuget.org" + path + "?" + r.URL.RawQuery
|
||||
}
|
||||
|
||||
return h.upstreamURL + path
|
||||
|
|
|
|||
|
|
@ -1,374 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"compress/gzip"
|
||||
"context"
|
||||
"crypto/sha256"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"slices"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
var nugetRegistrationPrefixes = []string{
|
||||
"/v3/registration5-semver1/",
|
||||
"/v3/registration5-gz-semver1/",
|
||||
"/v3/registration5-gz-semver2/",
|
||||
}
|
||||
|
||||
var nugetArtifactPrefixes = append([]string{"/v3-flatcontainer/"}, nugetRegistrationPrefixes...)
|
||||
|
||||
const nugetRegistrationPath = "/v3/registration5-gz-semver2/"
|
||||
|
||||
func (h *NuGetHandler) cooldownEnabled() bool {
|
||||
return h.proxy.Cooldown != nil && h.proxy.Cooldown.Enabled()
|
||||
}
|
||||
|
||||
func (h *NuGetHandler) nugetCooldownApplies(id string) bool {
|
||||
return h.cooldownEnabled() && h.proxy.Cooldown.For("nuget", canonicalPackagePURL("nuget", strings.ToLower(id))) > 0
|
||||
}
|
||||
|
||||
// Cache upstream documents, not filtered results, so policy changes and elapsed
|
||||
// time take effect even while metadata is fresh. Include the upstream in the key.
|
||||
func (h *NuGetHandler) nugetMetadata(ctx context.Context, path string) (map[string]any, error) {
|
||||
target := h.upstreamURL + path
|
||||
key := fmt.Sprintf("_cooldown/%x", sha256.Sum256([]byte(target)))
|
||||
var document map[string]any
|
||||
validate := func(body []byte) error {
|
||||
var err error
|
||||
document, err = h.decodeNuGetMetadata(body)
|
||||
return err
|
||||
}
|
||||
_, _, _, err := h.proxy.fetchOrCacheMetadata(ctx, "nuget", key, target, "", validate)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return document, nil
|
||||
}
|
||||
|
||||
func (h *NuGetHandler) decodeNuGetMetadata(body []byte) (map[string]any, error) {
|
||||
// Normally the HTTP transport decodes gzip. Also support compressed cached
|
||||
// bytes and clients with transparent decompression disabled, with the same
|
||||
// metadata limit applied to the decompressed document.
|
||||
if bytes.HasPrefix(body, []byte{0x1f, 0x8b}) {
|
||||
reader, err := gzip.NewReader(bytes.NewReader(body))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer func() { _ = reader.Close() }()
|
||||
body, err = h.proxy.ReadMetadata(reader)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
var document map[string]any
|
||||
if err := json.Unmarshal(body, &document); err != nil {
|
||||
return nil, fmt.Errorf("parsing NuGet metadata: %w", err)
|
||||
}
|
||||
if document == nil {
|
||||
return nil, fmt.Errorf("empty NuGet metadata")
|
||||
}
|
||||
return document, nil
|
||||
}
|
||||
|
||||
// Prefer semver2, but a configured source may advertise only an older hive.
|
||||
// Retry only advertised aliases on 404; transport/validation errors must not
|
||||
// silently switch to a hive with less complete metadata. Keep requests on the
|
||||
// configured upstream, consistent with the service-index route rewriting.
|
||||
func (h *NuGetHandler) nugetRegistrationMetadata(ctx context.Context, suffix string) (map[string]any, string, error) {
|
||||
path := nugetRegistrationPath + suffix
|
||||
document, err := h.nugetMetadata(ctx, path)
|
||||
if !errors.Is(err, ErrUpstreamNotFound) {
|
||||
return document, path, err
|
||||
}
|
||||
index, indexErr := h.nugetMetadata(ctx, "/v3/index.json")
|
||||
if indexErr != nil {
|
||||
return nil, path, indexErr
|
||||
}
|
||||
resources, _ := index["resources"].([]any)
|
||||
seen := map[string]bool{nugetRegistrationPath: true}
|
||||
for _, resource := range resources {
|
||||
entry, _ := resource.(map[string]any)
|
||||
service, _ := entry["@type"].(string)
|
||||
id, _ := entry["@id"].(string)
|
||||
if id == "" || !strings.HasPrefix(service, "RegistrationsBaseUrl") {
|
||||
continue
|
||||
}
|
||||
prefix := strings.TrimPrefix(h.rewriteNuGetURL(id, service), h.proxyURL+"/nuget")
|
||||
if !slices.Contains(nugetRegistrationPrefixes, prefix) || seen[prefix] {
|
||||
continue
|
||||
}
|
||||
seen[prefix] = true
|
||||
path = prefix + suffix
|
||||
document, err = h.nugetMetadata(ctx, path)
|
||||
if !errors.Is(err, ErrUpstreamNotFound) {
|
||||
return document, path, err
|
||||
}
|
||||
}
|
||||
return nil, path, err
|
||||
}
|
||||
|
||||
func (h *NuGetHandler) nugetMetadataError(w http.ResponseWriter, err error) {
|
||||
if errors.Is(err, ErrUpstreamNotFound) {
|
||||
JSONError(w, http.StatusNotFound, "package metadata not found")
|
||||
return
|
||||
}
|
||||
h.proxy.Logger.Warn("failed to process NuGet metadata", "error", err)
|
||||
JSONError(w, http.StatusBadGateway, "failed to process package metadata")
|
||||
}
|
||||
|
||||
func (h *NuGetHandler) handleVersionList(w http.ResponseWriter, r *http.Request) {
|
||||
if !h.cooldownEnabled() {
|
||||
h.proxyUpstream(w, r)
|
||||
return
|
||||
}
|
||||
id := strings.ToLower(r.PathValue("id"))
|
||||
document, err := h.nugetMetadata(r.Context(), "/v3-flatcontainer/"+url.PathEscape(id)+"/index.json")
|
||||
if err != nil {
|
||||
h.nugetMetadataError(w, err)
|
||||
return
|
||||
}
|
||||
blocked := make(map[string]bool)
|
||||
// A globally enabled policy may still exempt this package or ecosystem.
|
||||
// Keep metadata caching, but do not require publication data in that case.
|
||||
if h.nugetCooldownApplies(id) {
|
||||
registration, registrationPath, err := h.nugetRegistrationMetadata(r.Context(), url.PathEscape(id)+"/index.json")
|
||||
if err == nil {
|
||||
err = h.expandNuGetPages(r.Context(), registration, registrationPath)
|
||||
}
|
||||
if err != nil {
|
||||
h.nugetMetadataError(w, err)
|
||||
return
|
||||
}
|
||||
h.collectNuGetBlockedVersions(registration, id, blocked)
|
||||
}
|
||||
versions, ok := document["versions"].([]any)
|
||||
if !ok {
|
||||
h.nugetMetadataError(w, fmt.Errorf("missing NuGet versions"))
|
||||
return
|
||||
}
|
||||
filtered := make([]any, 0, len(versions))
|
||||
for _, value := range versions {
|
||||
version, ok := value.(string)
|
||||
if !ok {
|
||||
h.nugetMetadataError(w, fmt.Errorf("invalid NuGet version"))
|
||||
return
|
||||
}
|
||||
if !blocked[nugetVersionKey(version)] {
|
||||
filtered = append(filtered, value)
|
||||
}
|
||||
}
|
||||
document["versions"] = filtered
|
||||
w.Header().Set(headerContentType, contentTypeJSON)
|
||||
_ = json.NewEncoder(w).Encode(document)
|
||||
}
|
||||
|
||||
func nugetVersionKey(version string) string {
|
||||
version, _, _ = strings.Cut(version, "+")
|
||||
return strings.ToLower(version)
|
||||
}
|
||||
|
||||
func (h *NuGetHandler) nugetDownloadAllowed(ctx context.Context, id, version string) (bool, error) {
|
||||
if !h.nugetCooldownApplies(id) {
|
||||
return true, nil
|
||||
}
|
||||
suffix := url.PathEscape(strings.ToLower(id)) + "/" + url.PathEscape(nugetVersionKey(version)) + ".json"
|
||||
leaf, _, err := h.nugetRegistrationMetadata(ctx, suffix)
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
return h.nugetLeafAllowed(leaf, id), nil
|
||||
}
|
||||
|
||||
// A standalone leaf has published at its root; leaves embedded in pages carry
|
||||
// it in catalogEntry. Missing/invalid timestamps retain the existing permissive
|
||||
// behavior, but fetch and JSON errors must not bypass the policy.
|
||||
func (h *NuGetHandler) nugetLeafAllowed(leaf map[string]any, id string) bool {
|
||||
if !h.cooldownEnabled() {
|
||||
return true
|
||||
}
|
||||
entry := nugetCatalogEntry(leaf)
|
||||
if id == "" {
|
||||
id, _ = entry["id"].(string)
|
||||
}
|
||||
published, _ := entry["published"].(string)
|
||||
when, err := time.Parse(time.RFC3339, published)
|
||||
if err != nil {
|
||||
return true
|
||||
}
|
||||
return h.proxy.Cooldown.IsAllowed("nuget", canonicalPackagePURL("nuget", strings.ToLower(id)), when)
|
||||
}
|
||||
|
||||
func nugetCatalogEntry(leaf map[string]any) map[string]any {
|
||||
if entry, ok := leaf["catalogEntry"].(map[string]any); ok {
|
||||
return entry
|
||||
}
|
||||
return leaf
|
||||
}
|
||||
|
||||
func (h *NuGetHandler) collectNuGetBlockedVersions(document map[string]any, id string, blocked map[string]bool) {
|
||||
entry := nugetCatalogEntry(document)
|
||||
if version, ok := entry["version"].(string); ok && !h.nugetLeafAllowed(document, id) {
|
||||
blocked[nugetVersionKey(version)] = true
|
||||
}
|
||||
items, _ := document["items"].([]any)
|
||||
for _, item := range items {
|
||||
if child, ok := item.(map[string]any); ok {
|
||||
h.collectNuGetBlockedVersions(child, id, blocked)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (h *NuGetHandler) handleRegistration(w http.ResponseWriter, r *http.Request) {
|
||||
if !h.cooldownEnabled() {
|
||||
h.proxyUpstream(w, r)
|
||||
return
|
||||
}
|
||||
id := nugetRegistrationID(r.URL.Path)
|
||||
applyCooldown := h.nugetCooldownApplies(id)
|
||||
document, err := h.nugetMetadata(r.Context(), r.URL.Path)
|
||||
if err == nil && applyCooldown {
|
||||
err = h.expandNuGetPages(r.Context(), document, r.URL.Path)
|
||||
}
|
||||
if err != nil {
|
||||
h.nugetMetadataError(w, err)
|
||||
return
|
||||
}
|
||||
_, hasItems := document["items"]
|
||||
if applyCooldown && !h.filterNuGetRegistration(document, id) && !hasItems {
|
||||
JSONError(w, http.StatusNotFound, "version not found")
|
||||
return
|
||||
}
|
||||
h.rewriteNuGetRegistrationLinks(document)
|
||||
w.Header().Set(headerContentType, contentTypeJSON)
|
||||
_ = json.NewEncoder(w).Encode(document)
|
||||
}
|
||||
|
||||
func nugetRegistrationID(path string) string {
|
||||
for _, prefix := range nugetRegistrationPrefixes {
|
||||
if rest, ok := strings.CutPrefix(path, prefix); ok {
|
||||
id, _, _ := strings.Cut(rest, "/")
|
||||
return id
|
||||
}
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
// Only expand index pages, never recursively follow arbitrary upstream links.
|
||||
// Pin requests to this configured upstream and the current package's page path.
|
||||
func (h *NuGetHandler) expandNuGetPages(ctx context.Context, document map[string]any, path string) error {
|
||||
if !strings.HasSuffix(path, "/index.json") {
|
||||
return nil
|
||||
}
|
||||
items, ok := document["items"].([]any)
|
||||
if !ok {
|
||||
return fmt.Errorf("missing registration pages")
|
||||
}
|
||||
base, err := url.Parse(h.upstreamURL + path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
pagePrefix := strings.TrimSuffix(base.Path, "index.json") + "page/"
|
||||
for _, item := range items {
|
||||
page, ok := item.(map[string]any)
|
||||
if !ok {
|
||||
return fmt.Errorf("invalid registration page")
|
||||
}
|
||||
if _, ok := page["items"].([]any); ok {
|
||||
continue
|
||||
}
|
||||
link, _ := page["@id"].(string)
|
||||
target, err := base.Parse(link)
|
||||
if err != nil || target.Scheme != base.Scheme || target.Host != base.Host ||
|
||||
!strings.HasPrefix(target.Path, pagePrefix) || containsPathTraversal(target.Path) || target.RawQuery != "" || target.Fragment != "" {
|
||||
return fmt.Errorf("invalid registration page URL: %q", link)
|
||||
}
|
||||
upstream, _ := url.Parse(h.upstreamURL)
|
||||
pageDocument, err := h.nugetMetadata(ctx, strings.TrimPrefix(target.Path, upstream.Path))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
leaves, ok := pageDocument["items"].([]any)
|
||||
if !ok {
|
||||
return fmt.Errorf("missing registration leaves")
|
||||
}
|
||||
page["items"] = leaves
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (h *NuGetHandler) filterNuGetRegistration(document map[string]any, id string) bool {
|
||||
items, ok := document["items"].([]any)
|
||||
if !ok {
|
||||
return h.nugetLeafAllowed(document, id)
|
||||
}
|
||||
filtered := make([]any, 0, len(items))
|
||||
for _, item := range items {
|
||||
child, ok := item.(map[string]any)
|
||||
if ok && h.filterNuGetRegistration(child, id) {
|
||||
filtered = append(filtered, child)
|
||||
}
|
||||
}
|
||||
document["items"] = filtered
|
||||
document["count"] = len(filtered)
|
||||
// Page bounds describe the retained leaves, not versions hidden by cooldown.
|
||||
if _, isPage := document["lower"]; isPage && len(filtered) > 0 {
|
||||
first, _ := filtered[0].(map[string]any)
|
||||
last, _ := filtered[len(filtered)-1].(map[string]any)
|
||||
document["lower"] = nugetCatalogEntry(first)["version"]
|
||||
document["upper"] = nugetCatalogEntry(last)["version"]
|
||||
}
|
||||
return len(filtered) > 0
|
||||
}
|
||||
|
||||
func (h *NuGetHandler) rewriteNuGetRegistrationLinks(value any) {
|
||||
switch node := value.(type) {
|
||||
case map[string]any:
|
||||
for key, child := range node {
|
||||
if link, ok := child.(string); ok {
|
||||
switch key {
|
||||
case "@id", "parent", "registration", "packageContent":
|
||||
node[key] = h.nugetProxyLink(link)
|
||||
}
|
||||
} else {
|
||||
h.rewriteNuGetRegistrationLinks(child)
|
||||
}
|
||||
}
|
||||
case []any:
|
||||
for _, child := range node {
|
||||
h.rewriteNuGetRegistrationLinks(child)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (h *NuGetHandler) nugetProxyLink(link string) string {
|
||||
u, err := url.Parse(link)
|
||||
if err != nil {
|
||||
return link
|
||||
}
|
||||
upstream, err := url.Parse(h.upstreamURL)
|
||||
if err != nil {
|
||||
return link
|
||||
}
|
||||
path := u.Path
|
||||
if u.Host == upstream.Host {
|
||||
path = strings.TrimPrefix(path, upstream.Path)
|
||||
}
|
||||
for _, prefix := range nugetArtifactPrefixes {
|
||||
if strings.HasPrefix(path, prefix) {
|
||||
proxy, err := url.Parse(h.proxyURL + "/nuget" + path)
|
||||
if err != nil {
|
||||
return link
|
||||
}
|
||||
proxy.RawQuery = u.RawQuery
|
||||
proxy.Fragment = u.Fragment
|
||||
return proxy.String()
|
||||
}
|
||||
}
|
||||
return link
|
||||
}
|
||||
|
|
@ -1,501 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"compress/gzip"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/cooldown"
|
||||
"github.com/git-pkgs/registries/fetch"
|
||||
)
|
||||
|
||||
func TestNuGetCooldownRoutes(t *testing.T) {
|
||||
for _, disableCompression := range []bool{false, true} {
|
||||
t.Run(map[bool]string{false: "transport gzip", true: "explicit gzip"}[disableCompression], func(t *testing.T) {
|
||||
proxy, db, store, fetcher := setupTestProxy(t)
|
||||
proxy.Cooldown = &cooldown.Config{Default: "14d"}
|
||||
proxy.CacheMetadata = true
|
||||
proxy.MetadataTTL = time.Hour
|
||||
seedPackage(t, db, store, "nuget", "testpkg", "2.0.0", "testpkg.2.0.0.nupkg", "cached package")
|
||||
seedPackage(t, db, store, "nuget", "testpkg", "1.0.0", "testpkg.1.0.0.nupkg", "old package")
|
||||
metadataRequests := 0
|
||||
upstream := newNuGetCooldownUpstream(t, &metadataRequests)
|
||||
defer upstream.Close()
|
||||
transport := http.DefaultTransport.(*http.Transport).Clone()
|
||||
transport.DisableCompression = disableCompression
|
||||
defer transport.CloseIdleConnections()
|
||||
proxy.HTTPClient = &http.Client{Transport: transport}
|
||||
h := NewNuGetHandlerWithUpstreams(proxy, "http://proxy.test", upstream.URL, upstream.URL)
|
||||
routes := http.StripPrefix("/nuget", h.Routes())
|
||||
get := func(path string, status int) *httptest.ResponseRecorder {
|
||||
t.Helper()
|
||||
return nugetGet(t, routes, path, status)
|
||||
}
|
||||
list := get("/nuget/v3-flatcontainer/testpkg/index.json", http.StatusOK)
|
||||
if got := strings.TrimSpace(list.Body.String()); got != `{"versions":["1.0.0"]}` {
|
||||
t.Fatalf("filtered list = %s", got)
|
||||
}
|
||||
index := get("/nuget"+nugetRegistrationPath+"testpkg/index.json", http.StatusOK)
|
||||
if strings.Contains(index.Body.String(), `"version":"2.0.0"`) || strings.Contains(index.Body.String(), upstream.URL) {
|
||||
t.Fatalf("registration leaks blocked leaf or upstream link: %s", index.Body.String())
|
||||
}
|
||||
if index.Header().Get("Content-Encoding") != "" || !json.Valid(index.Body.Bytes()) {
|
||||
t.Fatal("registration must be decoded JSON")
|
||||
}
|
||||
var doc struct {
|
||||
Items []struct {
|
||||
ID string `json:"@id"`
|
||||
Count int
|
||||
Lower, Upper string
|
||||
Items []struct {
|
||||
ID string `json:"@id"`
|
||||
PackageContent string
|
||||
}
|
||||
}
|
||||
}
|
||||
if err := json.Unmarshal(index.Body.Bytes(), &doc); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if len(doc.Items) != 1 || doc.Items[0].Count != 1 || doc.Items[0].Upper != "1.0.0" {
|
||||
t.Fatalf("incorrect page: %+v", doc)
|
||||
}
|
||||
get(doc.Items[0].ID, http.StatusOK)
|
||||
get(doc.Items[0].Items[0].ID, http.StatusOK)
|
||||
get(doc.Items[0].Items[0].PackageContent, http.StatusOK)
|
||||
get("/nuget"+nugetRegistrationPath+"testpkg/2.0.0.json", http.StatusNotFound)
|
||||
get("/nuget/v3-flatcontainer/TestPkg/2.0.0/testpkg.2.0.0.nupkg", http.StatusNotFound)
|
||||
get("/nuget/v3-flatcontainer/testpkg/2.0.0/testpkg.nuspec", http.StatusNotFound)
|
||||
if fetcher.fetchCalled {
|
||||
t.Fatal("blocked or cached downloads must not fetch artifacts")
|
||||
}
|
||||
|
||||
// Reevaluate fresh, unfiltered metadata under a changed package policy.
|
||||
requestsBefore := metadataRequests
|
||||
proxy.Cooldown = &cooldown.Config{Default: "14d", Packages: map[string]string{"pkg:nuget/testpkg": "1d"}}
|
||||
list = get("/nuget/v3-flatcontainer/testpkg/index.json", http.StatusOK)
|
||||
if !strings.Contains(list.Body.String(), "2.0.0") {
|
||||
t.Fatal("fresh metadata retained the previous policy")
|
||||
}
|
||||
get("/nuget/v3-flatcontainer/testpkg/2.0.0/testpkg.2.0.0.nupkg", http.StatusOK)
|
||||
if metadataRequests != requestsBefore {
|
||||
t.Fatal("fresh metadata should be reused")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func nugetGet(t *testing.T, routes http.Handler, path string, status int) *httptest.ResponseRecorder {
|
||||
t.Helper()
|
||||
w := httptest.NewRecorder()
|
||||
routes.ServeHTTP(w, httptest.NewRequest(http.MethodGet, path, nil))
|
||||
if w.Code != status {
|
||||
t.Fatalf("GET %s: status %d, want %d: %s", path, w.Code, status, w.Body.String())
|
||||
}
|
||||
return w
|
||||
}
|
||||
|
||||
func TestNuGetMetadataWithoutEffectiveCooldown(t *testing.T) {
|
||||
for _, tt := range []struct {
|
||||
name string
|
||||
policy *cooldown.Config
|
||||
}{
|
||||
{"package exemption", &cooldown.Config{Default: "14d", Packages: map[string]string{"pkg:nuget/testpkg": "0"}}},
|
||||
{"ecosystem exemption", &cooldown.Config{Default: "14d", Ecosystems: map[string]string{"nuget": "0"}}},
|
||||
{"other ecosystem only", &cooldown.Config{Ecosystems: map[string]string{"npm": "14d"}}},
|
||||
{"other package only", &cooldown.Config{Packages: map[string]string{"pkg:nuget/other": "14d"}}},
|
||||
} {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
const body = `{"versions":["1.0.0","2.0.0"]}`
|
||||
const pagePath = nugetRegistrationPath + "testpkg/page/1.0.0/2.0.0.json"
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
switch r.URL.Path {
|
||||
case "/v3-flatcontainer/testpkg/index.json":
|
||||
_, _ = io.WriteString(w, body)
|
||||
case nugetRegistrationPath + "testpkg/index.json":
|
||||
_, _ = io.WriteString(w, `{"count":1,"items":[{"@id":"`+pagePath+`","count":2,"lower":"1.0.0","upper":"2.0.0"}]}`)
|
||||
default:
|
||||
t.Errorf("unnecessary registration request: %s", r.URL.Path)
|
||||
http.Error(w, "registration unavailable", http.StatusServiceUnavailable)
|
||||
}
|
||||
}))
|
||||
defer upstream.Close()
|
||||
p := nugetTestProxy()
|
||||
p.Cooldown = tt.policy
|
||||
h := NewNuGetHandlerWithUpstreams(p, "http://proxy.test", upstream.URL, upstream.URL)
|
||||
w := nugetGet(t, h.Routes(), "/v3-flatcontainer/TestPkg/index.json", http.StatusOK)
|
||||
if got := strings.TrimSpace(w.Body.String()); got != body {
|
||||
t.Fatalf("version list = %s, want %s", got, body)
|
||||
}
|
||||
w = nugetGet(t, h.Routes(), nugetRegistrationPath+"testpkg/index.json", http.StatusOK)
|
||||
if !strings.Contains(w.Body.String(), `"@id":"http://proxy.test/nuget`+pagePath+`"`) {
|
||||
t.Fatalf("registration page link was not rewritten: %s", w.Body.String())
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestNuGetCooldownColdDownload(t *testing.T) {
|
||||
for _, tt := range []struct {
|
||||
name, published string
|
||||
policy *cooldown.Config
|
||||
want int
|
||||
}{
|
||||
{"recent", time.Now().Add(-time.Hour).Format(time.RFC3339), &cooldown.Config{Default: "14d"}, http.StatusNotFound},
|
||||
{"missing timestamp", "", &cooldown.Config{Default: "14d"}, http.StatusOK},
|
||||
{"package exemption", time.Now().Add(-time.Hour).Format(time.RFC3339), &cooldown.Config{Default: "14d", Packages: map[string]string{"pkg:nuget/testpkg": "0"}}, http.StatusOK},
|
||||
{"ecosystem override", time.Now().Add(-time.Hour).Format(time.RFC3339), &cooldown.Config{Ecosystems: map[string]string{"nuget": "14d"}}, http.StatusNotFound},
|
||||
} {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
p, _, _, fetcher := setupTestProxy(t)
|
||||
p.Cooldown = tt.policy
|
||||
fetcher.artifact = &fetch.Artifact{Body: io.NopCloser(strings.NewReader("package")), ContentType: "application/octet-stream"}
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
_ = json.NewEncoder(w).Encode(map[string]string{"published": tt.published})
|
||||
}))
|
||||
defer upstream.Close()
|
||||
h := NewNuGetHandlerWithUpstreams(p, "http://proxy.test", upstream.URL, upstream.URL)
|
||||
nugetGet(t, h.Routes(), "/v3-flatcontainer/testpkg/2.0.0/testpkg.2.0.0.nupkg", tt.want)
|
||||
if fetcher.fetchCalled != (tt.want == http.StatusOK) {
|
||||
t.Errorf("artifact fetch called = %v", fetcher.fetchCalled)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestNuGetRegistrationServiceAliases(t *testing.T) {
|
||||
h := NewNuGetHandler(nugetTestProxy(), "http://proxy.test")
|
||||
for _, tt := range []struct{ service, path string }{
|
||||
{"RegistrationsBaseUrl", "/v3/registration5-semver1/"},
|
||||
{"RegistrationsBaseUrl/3.0.0-beta", "/v3/registration5-semver1/"},
|
||||
{"RegistrationsBaseUrl/3.0.0-rc", "/v3/registration5-semver1/"},
|
||||
{"RegistrationsBaseUrl/3.4.0", "/v3/registration5-gz-semver1/"},
|
||||
{"RegistrationsBaseUrl/3.6.0", nugetRegistrationPath},
|
||||
{"RegistrationsBaseUrl/Versioned", nugetRegistrationPath},
|
||||
} {
|
||||
t.Run(tt.service, func(t *testing.T) {
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.URL.Path != tt.path+"testpkg/index.json" {
|
||||
t.Errorf("wrong hive: %s", r.URL.Path)
|
||||
}
|
||||
_, _ = io.WriteString(w, `{"count":0,"items":[]}`)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
h.upstreamURL = upstream.URL
|
||||
h.proxy.Cooldown = &cooldown.Config{Default: "14d"}
|
||||
body := []byte(`{"resources":[{"@id":"` + upstream.URL + tt.path + `","@type":"` + tt.service + `"}]}`)
|
||||
out, err := h.rewriteServiceIndex(body)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
var doc struct {
|
||||
Resources []struct {
|
||||
ID string `json:"@id"`
|
||||
}
|
||||
}
|
||||
if err := json.Unmarshal(out, &doc); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
w := httptest.NewRecorder()
|
||||
http.StripPrefix("/nuget", h.Routes()).ServeHTTP(w, httptest.NewRequest(http.MethodGet, doc.Resources[0].ID+"testpkg/index.json", nil))
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("alias route status = %d: %s", w.Code, w.Body.String())
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestNuGetCooldownMetadataErrors(t *testing.T) {
|
||||
for _, tt := range []struct {
|
||||
name, body string
|
||||
status int
|
||||
}{
|
||||
{"upstream failure", "unavailable", http.StatusServiceUnavailable},
|
||||
{"invalid JSON", "broken JSON", http.StatusOK},
|
||||
{"null", "null", http.StatusOK},
|
||||
} {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.WriteHeader(tt.status)
|
||||
_, _ = io.WriteString(w, tt.body)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
p := nugetTestProxy()
|
||||
p.Cooldown = &cooldown.Config{Default: "14d"}
|
||||
h := NewNuGetHandlerWithUpstreams(p, "http://proxy.test", upstream.URL, upstream.URL)
|
||||
for _, path := range []string{"/v3-flatcontainer/testpkg/index.json", "/v3-flatcontainer/testpkg/2.0.0/testpkg.2.0.0.nupkg", nugetRegistrationPath + "testpkg/index.json"} {
|
||||
w := httptest.NewRecorder()
|
||||
h.Routes().ServeHTTP(w, httptest.NewRequest(http.MethodGet, path, nil))
|
||||
if w.Code != http.StatusBadGateway {
|
||||
t.Errorf("GET %s: %d, want 502", path, w.Code)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestNuGetCooldownRejectsUnsafePageLinks(t *testing.T) {
|
||||
for _, link := range []string{"https://other.example/page.json", "/v3/registration5-gz-semver2/other/page/1/2.json", "page/../index.json", "index.json"} {
|
||||
t.Run(link, func(t *testing.T) {
|
||||
requests := 0
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
requests++
|
||||
_ = json.NewEncoder(w).Encode(map[string]any{"items": []any{map[string]any{"@id": link}}})
|
||||
}))
|
||||
defer upstream.Close()
|
||||
p := nugetTestProxy()
|
||||
p.Cooldown = &cooldown.Config{Default: "14d"}
|
||||
h := NewNuGetHandlerWithUpstreams(p, "http://proxy.test", upstream.URL, upstream.URL)
|
||||
nugetGet(t, h.Routes(), nugetRegistrationPath+"testpkg/index.json", http.StatusBadGateway)
|
||||
if requests != 1 {
|
||||
t.Fatalf("unsafe page link was followed (%d requests)", requests)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestNuGetCooldownDecompressedMetadataLimit(t *testing.T) {
|
||||
var compressed bytes.Buffer
|
||||
gz := gzip.NewWriter(&compressed)
|
||||
_, _ = io.WriteString(gz, `{"padding":"`+strings.Repeat("x", 2048)+`"}`)
|
||||
_ = gz.Close()
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Encoding", "gzip")
|
||||
_, _ = w.Write(compressed.Bytes())
|
||||
}))
|
||||
defer upstream.Close()
|
||||
p := nugetTestProxy()
|
||||
p.Cooldown = &cooldown.Config{Default: "14d"}
|
||||
p.MetadataMaxSize = 1024
|
||||
transport := http.DefaultTransport.(*http.Transport).Clone()
|
||||
transport.DisableCompression = true
|
||||
defer transport.CloseIdleConnections()
|
||||
p.HTTPClient = &http.Client{Transport: transport}
|
||||
h := NewNuGetHandlerWithUpstreams(p, "http://proxy.test", upstream.URL, upstream.URL)
|
||||
nugetGet(t, h.Routes(), nugetRegistrationPath+"testpkg/index.json", http.StatusBadGateway)
|
||||
}
|
||||
|
||||
func newNuGetCooldownUpstream(t *testing.T, metadataRequests *int) *httptest.Server {
|
||||
t.Helper()
|
||||
var upstream *httptest.Server
|
||||
upstream = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
(*metadataRequests)++
|
||||
base := upstream.URL + nugetRegistrationPath + "testpkg/"
|
||||
leaf := func(version string, age time.Duration) map[string]any {
|
||||
return map[string]any{
|
||||
"@id": base + version + ".json",
|
||||
"packageContent": upstream.URL + "/v3-flatcontainer/testpkg/" + version + "/testpkg." + version + ".nupkg",
|
||||
"catalogEntry": map[string]any{"id": "TestPkg", "version": version, "published": time.Now().Add(-age).Format(time.RFC3339)},
|
||||
}
|
||||
}
|
||||
page := map[string]any{"@id": base + "page/1.0.0/2.0.0.json", "lower": "1.0.0", "upper": "2.0.0", "count": 2,
|
||||
"parent": base + "index.json", "items": []any{leaf("1.0.0", 30*24*time.Hour), leaf("2.0.0", 2*24*time.Hour)}}
|
||||
var body any
|
||||
switch r.URL.Path {
|
||||
case "/v3-flatcontainer/testpkg/index.json":
|
||||
body = map[string]any{"versions": []string{"1.0.0", "2.0.0"}}
|
||||
case nugetRegistrationPath + "testpkg/index.json":
|
||||
// This index deliberately does not inline its leaves.
|
||||
body = map[string]any{"count": 1, "items": []any{map[string]any{
|
||||
"@id": page["@id"], "count": 2, "lower": "1.0.0", "upper": "2.0.0",
|
||||
}}}
|
||||
case nugetRegistrationPath + "testpkg/page/1.0.0/2.0.0.json":
|
||||
body = page
|
||||
case nugetRegistrationPath + "testpkg/1.0.0.json":
|
||||
body = map[string]any{"published": time.Now().Add(-30 * 24 * time.Hour).Format(time.RFC3339)}
|
||||
case nugetRegistrationPath + "testpkg/2.0.0.json":
|
||||
body = map[string]any{"published": time.Now().Add(-2 * 24 * time.Hour).Format(time.RFC3339)}
|
||||
default:
|
||||
t.Errorf("unexpected metadata request: %s", r.URL.Path)
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
w.Header().Set("Content-Encoding", "gzip")
|
||||
gz := gzip.NewWriter(w)
|
||||
_ = json.NewEncoder(gz).Encode(body)
|
||||
_ = gz.Close()
|
||||
}))
|
||||
|
||||
return upstream
|
||||
}
|
||||
|
||||
func TestNuGetCooldownLegacyRegistration(t *testing.T) {
|
||||
for _, service := range []string{"RegistrationsBaseUrl", "RegistrationsBaseUrl/3.0.0-beta", "RegistrationsBaseUrl/3.0.0-rc", "RegistrationsBaseUrl/3.4.0"} {
|
||||
t.Run(service, func(t *testing.T) {
|
||||
prefix := "/v3/registration5-semver1/"
|
||||
if service == "RegistrationsBaseUrl/3.4.0" {
|
||||
prefix = "/v3/registration5-gz-semver1/"
|
||||
}
|
||||
upstream := newNuGetLegacyUpstream(t, service, prefix)
|
||||
defer upstream.Close()
|
||||
p, db, store, fetcher := setupTestProxy(t)
|
||||
p.Cooldown = &cooldown.Config{Default: "14d"}
|
||||
seedPackage(t, db, store, "nuget", "testpkg", "1.0.0", "testpkg.1.0.0.nupkg", "cached old package")
|
||||
seedPackage(t, db, store, "nuget", "testpkg", "2.0.0", "testpkg.2.0.0.nupkg", "cached recent package")
|
||||
h := NewNuGetHandlerWithUpstreams(p, "http://proxy.test", upstream.URL+"/feed", upstream.URL)
|
||||
list := nugetGet(t, h.Routes(), "/v3-flatcontainer/testpkg/index.json", http.StatusOK)
|
||||
if strings.TrimSpace(list.Body.String()) != `{"versions":["1.0.0"]}` {
|
||||
t.Fatalf("incorrect version list: %s", list.Body.String())
|
||||
}
|
||||
nugetGet(t, h.Routes(), "/v3-flatcontainer/testpkg/1.0.0/testpkg.1.0.0.nupkg", http.StatusOK)
|
||||
nugetGet(t, h.Routes(), "/v3-flatcontainer/testpkg/2.0.0/testpkg.2.0.0.nupkg", http.StatusNotFound)
|
||||
if fetcher.fetchCalled {
|
||||
t.Fatal("cached or blocked package must not be fetched")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func newNuGetLegacyUpstream(t *testing.T, service, prefix string) *httptest.Server {
|
||||
t.Helper()
|
||||
var upstream *httptest.Server
|
||||
upstream = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
path := strings.TrimPrefix(r.URL.Path, "/feed")
|
||||
base := upstream.URL + "/feed" + prefix + "testpkg/"
|
||||
published := func(age time.Duration) string { return time.Now().Add(-age).Format(time.RFC3339) }
|
||||
var body any
|
||||
switch path {
|
||||
case "/v3/index.json":
|
||||
body = map[string]any{"resources": []any{map[string]string{"@id": upstream.URL + "/feed" + prefix, "@type": service}}}
|
||||
case "/v3-flatcontainer/testpkg/index.json":
|
||||
body = map[string]any{"versions": []string{"1.0.0", "2.0.0"}}
|
||||
case prefix + "testpkg/index.json":
|
||||
body = map[string]any{"items": []any{map[string]any{"@id": base + "page/1.0.0/2.0.0.json"}}}
|
||||
case prefix + "testpkg/page/1.0.0/2.0.0.json":
|
||||
body = map[string]any{"items": []any{
|
||||
map[string]any{"catalogEntry": map[string]string{"id": "testpkg", "version": "1.0.0", "published": published(30 * 24 * time.Hour)}},
|
||||
map[string]any{"catalogEntry": map[string]string{"id": "testpkg", "version": "2.0.0", "published": published(time.Hour)}},
|
||||
}}
|
||||
case prefix + "testpkg/1.0.0.json":
|
||||
body = map[string]string{"published": published(30 * 24 * time.Hour)}
|
||||
case prefix + "testpkg/2.0.0.json":
|
||||
body = map[string]string{"published": published(time.Hour)}
|
||||
default:
|
||||
if !strings.HasPrefix(path, nugetRegistrationPath) {
|
||||
t.Errorf("unexpected request: %s", r.URL.Path)
|
||||
}
|
||||
http.NotFound(w, r)
|
||||
return
|
||||
}
|
||||
_ = json.NewEncoder(w).Encode(body)
|
||||
}))
|
||||
return upstream
|
||||
}
|
||||
|
||||
func TestNuGetRegistrationDoesNotFallbackOnFailure(t *testing.T) {
|
||||
for _, status := range []int{http.StatusServiceUnavailable, http.StatusUnauthorized, http.StatusOK} {
|
||||
t.Run(http.StatusText(status), func(t *testing.T) {
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.URL.Path != nugetRegistrationPath+"testpkg/index.json" {
|
||||
t.Errorf("must not switch registration hive on failure: %s", r.URL.Path)
|
||||
}
|
||||
w.WriteHeader(status)
|
||||
_, _ = io.WriteString(w, "invalid metadata")
|
||||
}))
|
||||
defer upstream.Close()
|
||||
h := NewNuGetHandlerWithUpstreams(nugetTestProxy(), "http://proxy.test", upstream.URL, upstream.URL)
|
||||
if _, _, err := h.nugetRegistrationMetadata(t.Context(), "testpkg/index.json"); err == nil {
|
||||
t.Fatal("expected metadata error")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestNuGetMetadataPreservesValidCache(t *testing.T) {
|
||||
for _, invalid := range []string{"broken JSON", "null", "[]", string([]byte{0x1f, 0x8b, 0x00})} {
|
||||
t.Run(invalid, func(t *testing.T) {
|
||||
const good = `{"published":"2020-01-01T00:00:00Z"}`
|
||||
var response atomic.Value
|
||||
response.Store(good)
|
||||
var requests atomic.Int32
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if requests.Add(1) > 1 && r.Header.Get("If-None-Match") != `"good"` {
|
||||
t.Errorf("cached ETag was replaced: %s", r.Header.Get("If-None-Match"))
|
||||
}
|
||||
body := response.Load().(string)
|
||||
etag := `"good"`
|
||||
if body == invalid {
|
||||
etag = `"bad"`
|
||||
}
|
||||
w.Header().Set("ETag", etag)
|
||||
_, _ = io.WriteString(w, body)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
p, _, _, _ := setupTestProxy(t)
|
||||
p.CacheMetadata = true
|
||||
h := NewNuGetHandlerWithUpstreams(p, "http://proxy.test", upstream.URL, upstream.URL)
|
||||
check := func(want string) {
|
||||
t.Helper()
|
||||
doc, err := h.nugetMetadata(t.Context(), nugetRegistrationPath+"testpkg/1.0.0.json")
|
||||
if err != nil || doc["published"] != want {
|
||||
t.Fatalf("metadata = %v, err = %v, want publication %s", doc, err, want)
|
||||
}
|
||||
}
|
||||
check("2020-01-01T00:00:00Z")
|
||||
response.Store(invalid)
|
||||
check("2020-01-01T00:00:00Z") // Bad 200 must fall back without overwriting.
|
||||
p.MetadataTTL = time.Hour
|
||||
check("2020-01-01T00:00:00Z") // The on-disk cache must still be usable.
|
||||
if requests.Load() != 2 {
|
||||
t.Fatalf("requests = %d, want 2", requests.Load())
|
||||
}
|
||||
p.MetadataTTL = 0
|
||||
response.Store(`{"published":"2021-01-01T00:00:00Z"}`)
|
||||
check("2021-01-01T00:00:00Z") // A later valid response replaces the cache.
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestNuGetMetadataInvalidResponseNotCached(t *testing.T) {
|
||||
var requests atomic.Int32
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if requests.Add(1) == 1 {
|
||||
_, _ = io.WriteString(w, "invalid JSON")
|
||||
return
|
||||
}
|
||||
_, _ = io.WriteString(w, `{"published":"2020-01-01T00:00:00Z"}`)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
p, _, _, _ := setupTestProxy(t)
|
||||
p.CacheMetadata = true
|
||||
p.MetadataTTL = time.Hour
|
||||
h := NewNuGetHandlerWithUpstreams(p, "http://proxy.test", upstream.URL, upstream.URL)
|
||||
path := nugetRegistrationPath + "testpkg/1.0.0.json"
|
||||
if _, err := h.nugetMetadata(t.Context(), path); err == nil {
|
||||
t.Fatal("invalid response without a usable cache must fail")
|
||||
}
|
||||
if _, err := h.nugetMetadata(t.Context(), path); err != nil {
|
||||
t.Fatalf("invalid response was cached: %v", err)
|
||||
}
|
||||
if requests.Load() != 2 {
|
||||
t.Fatalf("requests = %d, want 2", requests.Load())
|
||||
}
|
||||
}
|
||||
|
||||
func TestNuGetRegistrationDoesNotGuessUnadvertisedAliases(t *testing.T) {
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
switch r.URL.Path {
|
||||
case nugetRegistrationPath + "testpkg/index.json":
|
||||
http.NotFound(w, r)
|
||||
case "/v3/index.json":
|
||||
_, _ = io.WriteString(w, `{"resources":[{"@type":"UnrelatedService","@id":"https://other.example/"}]}`)
|
||||
default:
|
||||
t.Errorf("unadvertised endpoint requested: %s", r.URL.Path)
|
||||
http.NotFound(w, r)
|
||||
}
|
||||
}))
|
||||
defer upstream.Close()
|
||||
h := NewNuGetHandlerWithUpstreams(nugetTestProxy(), "http://proxy.test", upstream.URL, upstream.URL)
|
||||
_, _, err := h.nugetRegistrationMetadata(t.Context(), "testpkg/index.json")
|
||||
if !errors.Is(err, ErrUpstreamNotFound) {
|
||||
t.Fatalf("error = %v, want metadata not found", err)
|
||||
}
|
||||
}
|
||||
|
|
@ -10,7 +10,7 @@ import (
|
|||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/cooldown"
|
||||
"github.com/git-pkgs/proxy/internal/cooldown"
|
||||
)
|
||||
|
||||
func nugetTestProxy() *Proxy {
|
||||
|
|
@ -91,6 +91,40 @@ func TestNuGetRewriteServiceIndex(t *testing.T) {
|
|||
}
|
||||
}
|
||||
|
||||
func TestNuGetShouldRewriteService(t *testing.T) {
|
||||
h := &NuGetHandler{}
|
||||
|
||||
rewriteTypes := []string{
|
||||
"PackageBaseAddress/3.0.0",
|
||||
"RegistrationsBaseUrl/3.6.0",
|
||||
"RegistrationsBaseUrl/Versioned",
|
||||
"SearchQueryService",
|
||||
"SearchQueryService/3.0.0-rc",
|
||||
"SearchQueryService/3.5.0",
|
||||
"SearchAutocompleteService",
|
||||
"SearchAutocompleteService/3.5.0",
|
||||
}
|
||||
|
||||
for _, stype := range rewriteTypes {
|
||||
if !h.shouldRewriteService(stype) {
|
||||
t.Errorf("shouldRewriteService(%q) = false, want true", stype)
|
||||
}
|
||||
}
|
||||
|
||||
noRewriteTypes := []string{
|
||||
"SomeOtherService/1.0.0",
|
||||
"PackagePublish/2.0.0",
|
||||
"",
|
||||
"SearchQueryService/99.0.0",
|
||||
}
|
||||
|
||||
for _, stype := range noRewriteTypes {
|
||||
if h.shouldRewriteService(stype) {
|
||||
t.Errorf("shouldRewriteService(%q) = true, want false", stype)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestNuGetRewriteURL(t *testing.T) {
|
||||
h := &NuGetHandler{
|
||||
proxyURL: "http://localhost:8080",
|
||||
|
|
@ -98,75 +132,34 @@ func TestNuGetRewriteURL(t *testing.T) {
|
|||
|
||||
tests := []struct {
|
||||
input string
|
||||
serviceType string
|
||||
want string
|
||||
}{
|
||||
{
|
||||
"https://api.nuget.org/v3-flatcontainer/",
|
||||
"PackageBaseAddress/3.0.0",
|
||||
"http://localhost:8080/nuget/v3-flatcontainer/",
|
||||
},
|
||||
{
|
||||
"https://api.nuget.org/v3/registration5-gz-semver2/",
|
||||
"RegistrationsBaseUrl/3.6.0",
|
||||
"http://localhost:8080/nuget/v3/registration5-gz-semver2/",
|
||||
},
|
||||
{
|
||||
"https://api.nuget.org/v3/registration5-gz-semver2/",
|
||||
"RegistrationsBaseUrl/Versioned",
|
||||
"http://localhost:8080/nuget/v3/registration5-gz-semver2/",
|
||||
},
|
||||
{
|
||||
"https://azuresearch-usnc.nuget.org/query",
|
||||
"SearchQueryService",
|
||||
"http://localhost:8080/nuget/query",
|
||||
},
|
||||
{
|
||||
"https://azuresearch-usnc.nuget.org/query",
|
||||
"SearchQueryService/3.0.0-rc",
|
||||
"http://localhost:8080/nuget/query",
|
||||
},
|
||||
{
|
||||
"https://azuresearch-usnc.nuget.org/query",
|
||||
"SearchQueryService/3.5.0",
|
||||
"http://localhost:8080/nuget/query",
|
||||
},
|
||||
{
|
||||
"https://azuresearch-usnc.nuget.org/autocomplete",
|
||||
"SearchAutocompleteService",
|
||||
"http://localhost:8080/nuget/autocomplete",
|
||||
},
|
||||
{
|
||||
"https://azuresearch-usnc.nuget.org/autocomplete",
|
||||
"SearchAutocompleteService/3.5.0",
|
||||
"http://localhost:8080/nuget/autocomplete",
|
||||
},
|
||||
{
|
||||
"https://example.com/unknown",
|
||||
"SomeOtherService/1.0.0",
|
||||
"https://example.com/unknown",
|
||||
},
|
||||
{
|
||||
"https://api.nuget.org/v2/package",
|
||||
"PackagePublish/2.0.0",
|
||||
"https://api.nuget.org/v2/package",
|
||||
},
|
||||
{
|
||||
"https://azuresearch-usnc.nuget.org/query",
|
||||
"SearchQueryService/99.0.0",
|
||||
"https://azuresearch-usnc.nuget.org/query",
|
||||
},
|
||||
{
|
||||
"https://example.com/resource",
|
||||
"",
|
||||
"https://example.com/resource",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
got := h.rewriteNuGetURL(tt.input, tt.serviceType)
|
||||
got := h.rewriteNuGetURL(tt.input)
|
||||
if got != tt.want {
|
||||
t.Errorf("rewriteNuGetURL(%q, %q) = %q, want %q", tt.input, tt.serviceType, got, tt.want)
|
||||
t.Errorf("rewriteNuGetURL(%q) = %q, want %q", tt.input, got, tt.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -465,7 +458,6 @@ func TestNuGetProxyUpstreamForwardsAcceptEncoding(t *testing.T) {
|
|||
func TestNuGetBuildUpstreamURL(t *testing.T) {
|
||||
h := &NuGetHandler{
|
||||
upstreamURL: "https://api.nuget.org",
|
||||
searchURL: "https://azuresearch-usnc.nuget.org",
|
||||
}
|
||||
|
||||
tests := []struct {
|
||||
|
|
@ -744,7 +736,6 @@ func TestNuGetHandleDownloadMissingFilename(t *testing.T) {
|
|||
func TestNuGetBuildUpstreamURLQueryPath(t *testing.T) {
|
||||
h := &NuGetHandler{
|
||||
upstreamURL: "https://api.nuget.org",
|
||||
searchURL: "https://azuresearch-usnc.nuget.org",
|
||||
}
|
||||
|
||||
// Query endpoint should go to azuresearch
|
||||
|
|
@ -759,7 +750,6 @@ func TestNuGetBuildUpstreamURLQueryPath(t *testing.T) {
|
|||
func TestNuGetBuildUpstreamURLAutocompletePath(t *testing.T) {
|
||||
h := &NuGetHandler{
|
||||
upstreamURL: "https://api.nuget.org",
|
||||
searchURL: "https://azuresearch-usnc.nuget.org",
|
||||
}
|
||||
|
||||
req := httptest.NewRequest(http.MethodGet, "/autocomplete?q=new&take=10", nil)
|
||||
|
|
@ -812,6 +802,11 @@ func TestNuGetCooldownFiltering(t *testing.T) {
|
|||
},
|
||||
}
|
||||
|
||||
body, err := json.Marshal(registration)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
proxy := testProxy()
|
||||
proxy.Cooldown = &cooldown.Config{
|
||||
Default: "3d",
|
||||
|
|
@ -822,11 +817,17 @@ func TestNuGetCooldownFiltering(t *testing.T) {
|
|||
proxyURL: "http://localhost:8080",
|
||||
}
|
||||
|
||||
if !h.filterNuGetRegistration(registration, "") {
|
||||
t.Fatal("expected registration items to be retained")
|
||||
filtered, err := h.applyCooldownFiltering(body)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
pages := registration["items"].([]any)
|
||||
var result map[string]any
|
||||
if err := json.Unmarshal(filtered, &result); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
pages := result["items"].([]any)
|
||||
page := pages[0].(map[string]any)
|
||||
items := page["items"].([]any)
|
||||
|
||||
|
|
@ -840,7 +841,7 @@ func TestNuGetCooldownFiltering(t *testing.T) {
|
|||
}
|
||||
|
||||
count := page["count"]
|
||||
if count != 1 {
|
||||
if count != float64(1) {
|
||||
t.Errorf("expected page count to be 1, got %v", count)
|
||||
}
|
||||
}
|
||||
|
|
@ -866,6 +867,11 @@ func TestNuGetCooldownFilteringWithPackageOverride(t *testing.T) {
|
|||
},
|
||||
}
|
||||
|
||||
body, err := json.Marshal(registration)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
proxy := testProxy()
|
||||
proxy.Cooldown = &cooldown.Config{
|
||||
Default: "3d",
|
||||
|
|
@ -877,11 +883,17 @@ func TestNuGetCooldownFilteringWithPackageOverride(t *testing.T) {
|
|||
proxyURL: "http://localhost:8080",
|
||||
}
|
||||
|
||||
if !h.filterNuGetRegistration(registration, "") {
|
||||
t.Fatal("expected registration items to be retained")
|
||||
filtered, err := h.applyCooldownFiltering(body)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
pages := registration["items"].([]any)
|
||||
var result map[string]any
|
||||
if err := json.Unmarshal(filtered, &result); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
pages := result["items"].([]any)
|
||||
page := pages[0].(map[string]any)
|
||||
items := page["items"].([]any)
|
||||
|
||||
|
|
@ -908,20 +920,36 @@ func TestNuGetCooldownNoCooldownConfig(t *testing.T) {
|
|||
},
|
||||
}
|
||||
|
||||
// No cooldown: all registration items are retained.
|
||||
body, err := json.Marshal(registration)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
// No cooldown - applyCooldownFiltering still works, just doesn't filter
|
||||
h := &NuGetHandler{
|
||||
proxy: testProxy(),
|
||||
proxyURL: "http://localhost:8080",
|
||||
}
|
||||
|
||||
if !h.filterNuGetRegistration(registration, "") {
|
||||
t.Fatal("expected registration items to be retained")
|
||||
filtered, err := h.applyCooldownFiltering(body)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
pages := registration["items"].([]any)
|
||||
var result map[string]any
|
||||
if err := json.Unmarshal(filtered, &result); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
pages := result["items"].([]any)
|
||||
page := pages[0].(map[string]any)
|
||||
items := page["items"].([]any)
|
||||
|
||||
// Without cooldown config on the handler, applyCooldownFiltering
|
||||
// is called but proxy.Cooldown is nil, so IsAllowed is never called
|
||||
// Actually, applyCooldownFiltering always runs the filter logic -
|
||||
// but the caller (handleRegistration) short-circuits when cooldown is disabled.
|
||||
// The function itself should still work fine with a nil Cooldown.
|
||||
if len(items) != 1 {
|
||||
t.Fatalf("expected 1 item, got %d", len(items))
|
||||
}
|
||||
|
|
@ -950,6 +978,11 @@ func TestNuGetCooldownFilteringNuGetTimestamp(t *testing.T) {
|
|||
},
|
||||
}
|
||||
|
||||
body, err := json.Marshal(registration)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
proxy := testProxy()
|
||||
proxy.Cooldown = &cooldown.Config{
|
||||
Default: "3d",
|
||||
|
|
@ -960,11 +993,17 @@ func TestNuGetCooldownFilteringNuGetTimestamp(t *testing.T) {
|
|||
proxyURL: "http://localhost:8080",
|
||||
}
|
||||
|
||||
if !h.filterNuGetRegistration(registration, "") {
|
||||
t.Fatal("expected registration items to be retained")
|
||||
filtered, err := h.applyCooldownFiltering(body)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
pages := registration["items"].([]any)
|
||||
var result map[string]any
|
||||
if err := json.Unmarshal(filtered, &result); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
pages := result["items"].([]any)
|
||||
page := pages[0].(map[string]any)
|
||||
items := page["items"].([]any)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,260 +0,0 @@
|
|||
package handler
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"errors"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strconv"
|
||||
"strings"
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
// gzipWhenAskedUpstream serves compressed bytes with Content-Encoding: gzip
|
||||
// when the request advertises gzip, plain bytes otherwise, like a CDN that
|
||||
// compresses on the fly. It records the last Accept-Encoding it saw and counts
|
||||
// every request before the availability gate so a cache-miss refetch during a
|
||||
// simulated outage is observable.
|
||||
type gzipWhenAskedUpstream struct {
|
||||
*httptest.Server
|
||||
available atomic.Bool
|
||||
requests atomic.Int32
|
||||
acceptEncoding atomic.Value // string
|
||||
}
|
||||
|
||||
func newGzipWhenAskedUpstream(plain, compressed []byte) *gzipWhenAskedUpstream {
|
||||
u := &gzipWhenAskedUpstream{}
|
||||
u.available.Store(true)
|
||||
u.Server = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
u.requests.Add(1)
|
||||
u.acceptEncoding.Store(r.Header.Get(headerAcceptEncoding))
|
||||
if !u.available.Load() {
|
||||
http.Error(w, "unavailable", http.StatusServiceUnavailable)
|
||||
return
|
||||
}
|
||||
w.Header().Set(headerContentType, contentTypeJSON)
|
||||
if strings.Contains(r.Header.Get(headerAcceptEncoding), "gzip") {
|
||||
w.Header().Set(headerContentEncoding, "gzip")
|
||||
_, _ = w.Write(compressed)
|
||||
return
|
||||
}
|
||||
_, _ = w.Write(plain)
|
||||
}))
|
||||
return u
|
||||
}
|
||||
|
||||
func (u *gzipWhenAskedUpstream) sawAcceptEncoding() string {
|
||||
s, _ := u.acceptEncoding.Load().(string)
|
||||
return s
|
||||
}
|
||||
|
||||
// serveGzip issues one request through proxyCachedWithEncoding asking the
|
||||
// upstream for gzip.
|
||||
func serveGzip(proxy *Proxy, upstreamURL string) *httptest.ResponseRecorder {
|
||||
w := httptest.NewRecorder()
|
||||
r := httptest.NewRequest(http.MethodGet, "/index.json", nil)
|
||||
proxy.proxyCachedWithEncoding(w, r, upstreamURL, "gzip-test", "index", "gzip", "*/*")
|
||||
return w
|
||||
}
|
||||
|
||||
func assertGzipResponse(t *testing.T, label string, w *httptest.ResponseRecorder, compressed []byte) {
|
||||
t.Helper()
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("%s: status = %d, want 200: %s", label, w.Code, w.Body.String())
|
||||
}
|
||||
if !bytes.Equal(w.Body.Bytes(), compressed) {
|
||||
t.Errorf("%s: body is not the compressed bytes (got %d, want %d)", label, w.Body.Len(), len(compressed))
|
||||
}
|
||||
if got := w.Header().Get(headerContentEncoding); got != "gzip" {
|
||||
t.Errorf("%s: Content-Encoding = %q, want %q", label, got, "gzip")
|
||||
}
|
||||
if got := w.Header().Get(headerContentLength); got != strconv.Itoa(len(compressed)) {
|
||||
t.Errorf("%s: Content-Length = %q, want %d", label, got, len(compressed))
|
||||
}
|
||||
}
|
||||
|
||||
// TestProxyCachedWithEncoding_GzipCachesAndReplays covers the cached path:
|
||||
// requesting gzip upstream stores the compressed bytes plus Content-Encoding
|
||||
// and replays both from cache without contacting the upstream again.
|
||||
func TestProxyCachedWithEncoding_GzipCachesAndReplays(t *testing.T) {
|
||||
plain := []byte(`{"packages":{}}`)
|
||||
compressed := gzipPayload(t, plain)
|
||||
upstream := newGzipWhenAskedUpstream(plain, compressed)
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = true
|
||||
proxy.MetadataTTL = time.Hour
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
|
||||
first := serveGzip(proxy, upstream.URL+"/index.json")
|
||||
assertGzipResponse(t, "first", first, compressed)
|
||||
if got := upstream.sawAcceptEncoding(); got != "gzip" {
|
||||
t.Errorf("upstream Accept-Encoding = %q, want %q", got, "gzip")
|
||||
}
|
||||
|
||||
before := upstream.requests.Load()
|
||||
upstream.available.Store(false)
|
||||
cached := serveGzip(proxy, upstream.URL+"/index.json")
|
||||
assertGzipResponse(t, "cached", cached, compressed)
|
||||
if upstream.requests.Load() != before {
|
||||
t.Errorf("cached replay hit upstream: requests %d -> %d", before, upstream.requests.Load())
|
||||
}
|
||||
}
|
||||
|
||||
// TestProxyCachedWithEncoding_GzipStreamPath covers the cache_metadata=false
|
||||
// branch: the streaming path must request gzip and forward Content-Encoding.
|
||||
func TestProxyCachedWithEncoding_GzipStreamPath(t *testing.T) {
|
||||
plain := []byte(`{"packages":{}}`)
|
||||
compressed := gzipPayload(t, plain)
|
||||
upstream := newGzipWhenAskedUpstream(plain, compressed)
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = false
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
|
||||
w := serveGzip(proxy, upstream.URL+"/index.json")
|
||||
assertGzipResponse(t, "stream", w, compressed)
|
||||
if got := upstream.sawAcceptEncoding(); got != "gzip" {
|
||||
t.Errorf("stream path upstream Accept-Encoding = %q, want %q", got, "gzip")
|
||||
}
|
||||
}
|
||||
|
||||
// TestProxyCachedWithEncoding_GzipSurvivesCacheWriteFailure covers the failure
|
||||
// the gzip mode makes reachable: when the metadata cache write fails the
|
||||
// freshly fetched body is still served, so its Content-Encoding must come from
|
||||
// the fetch and not from the (unwritten) cache row -- otherwise gzip bytes go
|
||||
// out labelled application/json with no Content-Encoding.
|
||||
func TestProxyCachedWithEncoding_GzipSurvivesCacheWriteFailure(t *testing.T) {
|
||||
plain := []byte(`{"packages":{}}`)
|
||||
compressed := gzipPayload(t, plain)
|
||||
upstream := newGzipWhenAskedUpstream(plain, compressed)
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, store, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = true
|
||||
proxy.MetadataTTL = time.Hour
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
store.storeErr = errors.New("disk full")
|
||||
|
||||
w := serveGzip(proxy, upstream.URL+"/index.json")
|
||||
assertGzipResponse(t, "store-failure", w, compressed)
|
||||
}
|
||||
|
||||
// TestProxyCachedWithEncoding_GzipStaleFallbackKeepsEncoding pins the
|
||||
// stale-fallback return: when the upstream fails after the entry has expired,
|
||||
// the stored gzip blob is served with its Content-Encoding taken from the
|
||||
// cache row.
|
||||
func TestProxyCachedWithEncoding_GzipStaleFallbackKeepsEncoding(t *testing.T) {
|
||||
plain := []byte(`{"packages":{}}`)
|
||||
compressed := gzipPayload(t, plain)
|
||||
upstream := newGzipWhenAskedUpstream(plain, compressed)
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = true
|
||||
proxy.MetadataTTL = 0 // every request revalidates; an upstream failure falls back to the stale row
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
|
||||
first := serveGzip(proxy, upstream.URL+"/index.json")
|
||||
assertGzipResponse(t, "first", first, compressed)
|
||||
|
||||
upstream.available.Store(false)
|
||||
stale := serveGzip(proxy, upstream.URL+"/index.json")
|
||||
assertGzipResponse(t, "stale", stale, compressed)
|
||||
}
|
||||
|
||||
// TestProxyCachedWithEncoding_UpsertFailureDiscardsBlob covers the row-write
|
||||
// failure: when the gzip blob is stored but the cache row cannot be updated,
|
||||
// the blob must be discarded so a later stale fallback cannot serve gzip
|
||||
// bytes with the previous row's encoding. The fresh response is still
|
||||
// correct because its encoding comes from the fetch.
|
||||
func TestProxyCachedWithEncoding_UpsertFailureDiscardsBlob(t *testing.T) {
|
||||
plain := []byte(`{"packages":{}}`)
|
||||
compressed := gzipPayload(t, plain)
|
||||
upstream := newGzipWhenAskedUpstream(plain, compressed)
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, db, store, _ := setupTestProxy(t)
|
||||
proxy.CacheMetadata = true
|
||||
proxy.MetadataTTL = 0 // every request revalidates
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
|
||||
// Seed an identity row + plain blob, as every key has before the gzip rollout.
|
||||
w := httptest.NewRecorder()
|
||||
proxy.proxyCachedWithEncoding(w, httptest.NewRequest(http.MethodGet, "/index.json", nil),
|
||||
upstream.URL+"/index.json", "gzip-test", "index", "identity", "*/*")
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("seed status = %d, want 200", w.Code)
|
||||
}
|
||||
|
||||
// Now DB writes fail while reads keep working.
|
||||
db.SetMaxOpenConns(1)
|
||||
if _, err := db.Exec("PRAGMA query_only=1"); err != nil {
|
||||
t.Fatalf("PRAGMA query_only=1: %v", err)
|
||||
}
|
||||
fresh := serveGzip(proxy, upstream.URL+"/index.json")
|
||||
assertGzipResponse(t, "fresh with failed row write", fresh, compressed)
|
||||
|
||||
storagePath := metadataStoragePath("gzip-test", "index")
|
||||
if exists, _ := store.Exists(context.Background(), storagePath); exists {
|
||||
t.Fatalf("blob %s still present after the row write failed", storagePath)
|
||||
}
|
||||
|
||||
// Upstream down: the stale fallback must not serve the orphaned gzip
|
||||
// blob under the old identity row.
|
||||
if _, err := db.Exec("PRAGMA query_only=0"); err != nil {
|
||||
t.Fatalf("PRAGMA query_only=0: %v", err)
|
||||
}
|
||||
upstream.available.Store(false)
|
||||
stale := serveGzip(proxy, upstream.URL+"/index.json")
|
||||
if stale.Code == http.StatusOK {
|
||||
t.Fatalf("stale fallback served status 200 (Content-Encoding=%q, %d bytes) from an orphaned blob; want an error",
|
||||
stale.Header().Get(headerContentEncoding), stale.Body.Len())
|
||||
}
|
||||
}
|
||||
|
||||
// TestProxyCachedWithEncoding_StaleFallbackRereadsRow covers the rollout race:
|
||||
// a request that read the identity row, lost the upstream race to a request
|
||||
// that stored the gzip blob, and then failed upstream must label the blob
|
||||
// with the row as it is now, not with the row it read at the start.
|
||||
func TestProxyCachedWithEncoding_StaleFallbackRereadsRow(t *testing.T) {
|
||||
plain := []byte(`{"packages":{}}`)
|
||||
compressed := gzipPayload(t, plain)
|
||||
|
||||
var proxy *Proxy
|
||||
var requests atomic.Int32
|
||||
upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if requests.Add(1) == 1 {
|
||||
w.Header().Set(headerContentType, contentTypeJSON)
|
||||
_, _ = w.Write(plain) // seed request: identity
|
||||
return
|
||||
}
|
||||
// Second request has already read the identity row. Simulate a
|
||||
// concurrent request finishing first: store the gzip blob and row,
|
||||
// then fail this request so it takes the stale fallback.
|
||||
proxy.cacheMetadataBlob(r.Context(), "gzip-test", "index", metadataStoragePath("gzip-test", "index"),
|
||||
&upstreamMetadata{body: compressed, contentType: contentTypeJSON, contentEncoding: "gzip"})
|
||||
http.Error(w, "unavailable", http.StatusServiceUnavailable)
|
||||
}))
|
||||
defer upstream.Close()
|
||||
|
||||
proxy, _, _, _ = setupTestProxy(t)
|
||||
proxy.CacheMetadata = true
|
||||
proxy.MetadataTTL = 0
|
||||
proxy.HTTPClient = upstream.Client()
|
||||
|
||||
w := httptest.NewRecorder()
|
||||
proxy.proxyCachedWithEncoding(w, httptest.NewRequest(http.MethodGet, "/index.json", nil),
|
||||
upstream.URL+"/index.json", "gzip-test", "index", "identity", "*/*")
|
||||
if w.Code != http.StatusOK {
|
||||
t.Fatalf("seed status = %d, want 200", w.Code)
|
||||
}
|
||||
|
||||
raced := serveGzip(proxy, upstream.URL+"/index.json")
|
||||
assertGzipResponse(t, "stale fallback after concurrent gzip store", raced, compressed)
|
||||
}
|
||||
|
|
@ -7,6 +7,8 @@ import (
|
|||
"net/http"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/git-pkgs/purl"
|
||||
)
|
||||
|
||||
const (
|
||||
|
|
@ -30,13 +32,6 @@ func NewPubHandler(proxy *Proxy, proxyURL string) *PubHandler {
|
|||
}
|
||||
}
|
||||
|
||||
// NewPubHandlerWithUpstream creates a pub handler with a custom upstream.
|
||||
func NewPubHandlerWithUpstream(proxy *Proxy, proxyURL, upstreamURL string) *PubHandler {
|
||||
h := NewPubHandler(proxy, proxyURL)
|
||||
h.upstreamURL = configuredUpstreamURL(upstreamURL, pubUpstream)
|
||||
return h
|
||||
}
|
||||
|
||||
// Routes returns the HTTP handler for pub requests.
|
||||
func (h *PubHandler) Routes() http.Handler {
|
||||
mux := http.NewServeMux()
|
||||
|
|
@ -72,12 +67,10 @@ func (h *PubHandler) handleDownload(w http.ResponseWriter, r *http.Request) {
|
|||
h.proxy.Logger.Info("pub download request",
|
||||
"name", name, "version", version)
|
||||
|
||||
downloadURL := h.upstreamURL + r.URL.Path
|
||||
result, err := h.proxy.GetOrFetchArtifactFromURL(
|
||||
r.Context(), "pub", name, version, filename, downloadURL,
|
||||
)
|
||||
result, err := h.proxy.GetOrFetchArtifact(r.Context(), "pub", name, version, filename)
|
||||
if err != nil {
|
||||
h.proxy.serveArtifactError(w, err, "failed to fetch package")
|
||||
h.proxy.Logger.Error("failed to get artifact", "error", err)
|
||||
http.Error(w, "failed to fetch package", http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
|
||||
|
|
@ -110,13 +103,13 @@ func (h *PubHandler) handlePackageMetadata(w http.ResponseWriter, r *http.Reques
|
|||
rewritten, err := h.rewriteMetadata(name, body)
|
||||
if err != nil {
|
||||
h.proxy.Logger.Warn("failed to rewrite metadata, proxying original", "error", err)
|
||||
w.Header().Set(headerContentType, "application/json")
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
w.WriteHeader(http.StatusOK)
|
||||
_, _ = w.Write(body)
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set(headerContentType, "application/json")
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
w.WriteHeader(http.StatusOK)
|
||||
_, _ = w.Write(rewritten)
|
||||
}
|
||||
|
|
@ -134,7 +127,7 @@ func (h *PubHandler) rewriteMetadata(name string, body []byte) ([]byte, error) {
|
|||
return body, nil
|
||||
}
|
||||
|
||||
packagePURL := canonicalPackagePURL("pub", name)
|
||||
packagePURL := purl.MakePURLString("pub", name, "")
|
||||
filtered := h.filterAndRewriteVersions(name, packagePURL, versions)
|
||||
metadata["versions"] = filtered
|
||||
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue