All checks were successful
check / check (push) Successful in 5s
Extracts HMAC-SHA256 request signing out of `internal/imgcache/` into its own `internal/signature/` package, per the plan in [issue #39](#39). This is one of the remaining "easily separable" extractions (`imageprocessor`, `allowlist`, `magic`, and `httpfetcher` already landed). Only the signer is moved here so the diff stays reviewable. ## What moved From `internal/imgcache/signature.go` and its tests into `internal/signature/`: - `Signer` type, its `New` constructor, `Sign`, `Verify`, `GenerateSignedURL` - `ParseParams` (query-string signature/expiration parsing) - Signature error sentinels ## One-way import edge To keep the import edge one-way (`imgcache` depends on `signature`, never the reverse), the package defines a standalone `Request` type carrying just the fields the signature covers, instead of importing `imgcache.ImageRequest`. `imgcache` projects its `ImageRequest` onto `signature.Request` via a small unexported `signatureRequest` helper. This mirrors how the `magic` extraction defined its own `ImageFormat` type. ## Renames (no stuttering) - `NewSigner` -> `signature.New` - `ParseSignatureParams` -> `signature.ParseParams` - `ErrSignatureRequired`/`Invalid`/`Expired` -> `signature.ErrRequired`/`Invalid`/`Expired` The `ErrRequired` message is updated from "non-whitelisted host" to "non-allowlisted host" for inclusive terminology, consistent with the `allowlist` rename. ## Rework (post-review) Three commits added after review feedback: - `d69019b` — golden known-answer test pinning the exact HMAC signatures and signed URL paths for three fixed vectors (resized, resized+query, orig size), cross-validated against an independent HMAC implementation. Any change to the signed byte format now fails loudly. - `43b9f1c` — whitelist→allowlist rename completed across `internal/imgcache` and `internal/handlers` (`ServiceConfig.Allowlist`, `Allowlist` interface, `IsAllowlisted`, test helpers and test names). - `3dc1999` — one-pass config surface rename, no back-compat alias: YAML key `whitelist_hosts` → `allowlist_hosts`, `Config.WhitelistHosts` → `Config.AllowlistHosts`, `config.example.yml`, `scripts/manual-test.sh`, and `README.md` (which also documented a nonexistent `source_host_whitelist` key — now fixed to the real one). ## Behavior Pure refactor apart from the config key rename above. The bytes fed to the HMAC are unchanged (`host:path:query:width:height:format:expiration`), so previously issued signatures remain valid — now enforced by the golden test. All existing tests move with the package. `script/cibuild` passes at head `3dc1999` (fmt-check, lint, test, build). refs #39 Co-authored-by: sneak <sneak@sneak.berlin> Co-authored-by: Jeffrey Paul <sneak@noreply.example.org> Reviewed-on: #46 Co-authored-by: clawbot <clawbot@noreply.example.org> Co-committed-by: clawbot <clawbot@noreply.example.org>
233 lines
6.0 KiB
Go
233 lines
6.0 KiB
Go
package imgcache
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"database/sql"
|
|
"image"
|
|
"image/color"
|
|
"image/gif"
|
|
"image/jpeg"
|
|
"image/png"
|
|
"io/fs"
|
|
"testing"
|
|
"testing/fstest"
|
|
"time"
|
|
|
|
"sneak.berlin/go/pixa/internal/database"
|
|
"sneak.berlin/go/pixa/internal/httpfetcher"
|
|
)
|
|
|
|
// TestFixtures contains paths to test files in the mock filesystem.
|
|
type TestFixtures struct {
|
|
// Valid image files
|
|
GoodHostJPEG string // allowlisted host, valid JPEG
|
|
GoodHostPNG string // allowlisted host, valid PNG
|
|
GoodHostGIF string // allowlisted host, valid GIF
|
|
OtherHostJPEG string // non-allowlisted host, valid JPEG
|
|
OtherHostPNG string // non-allowlisted host, valid PNG
|
|
|
|
// Invalid/edge case files
|
|
InvalidFile string // file with wrong magic bytes
|
|
EmptyFile string // zero-byte file
|
|
TextFile string // text file masquerading as image
|
|
|
|
// Hostnames
|
|
GoodHost string // allowlisted hostname
|
|
OtherHost string // non-allowlisted hostname
|
|
}
|
|
|
|
// DefaultFixtures returns the standard test fixture paths.
|
|
func DefaultFixtures() *TestFixtures {
|
|
return &TestFixtures{
|
|
GoodHostJPEG: "goodhost.example.com/images/photo.jpg",
|
|
GoodHostPNG: "goodhost.example.com/images/logo.png",
|
|
GoodHostGIF: "goodhost.example.com/images/animation.gif",
|
|
OtherHostJPEG: "otherhost.example.com/uploads/image.jpg",
|
|
OtherHostPNG: "otherhost.example.com/uploads/icon.png",
|
|
InvalidFile: "goodhost.example.com/images/fake.jpg",
|
|
EmptyFile: "goodhost.example.com/images/empty.jpg",
|
|
TextFile: "goodhost.example.com/images/text.png",
|
|
GoodHost: "goodhost.example.com",
|
|
OtherHost: "otherhost.example.com",
|
|
}
|
|
}
|
|
|
|
// NewTestFS creates a mock filesystem with test images.
|
|
func NewTestFS(t *testing.T) (fs.FS, *TestFixtures) {
|
|
t.Helper()
|
|
|
|
fixtures := DefaultFixtures()
|
|
|
|
// Generate test images
|
|
jpegData := generateTestJPEG(t, 100, 100, color.RGBA{255, 0, 0, 255})
|
|
pngData := generateTestPNG(t, 100, 100, color.RGBA{0, 255, 0, 255})
|
|
gifData := generateTestGIF(t, 100, 100, color.RGBA{0, 0, 255, 255})
|
|
|
|
// Create the mock filesystem
|
|
mockFS := fstest.MapFS{
|
|
// Good host files
|
|
fixtures.GoodHostJPEG: &fstest.MapFile{Data: jpegData},
|
|
fixtures.GoodHostPNG: &fstest.MapFile{Data: pngData},
|
|
fixtures.GoodHostGIF: &fstest.MapFile{Data: gifData},
|
|
|
|
// Other host files
|
|
fixtures.OtherHostJPEG: &fstest.MapFile{Data: jpegData},
|
|
fixtures.OtherHostPNG: &fstest.MapFile{Data: pngData},
|
|
|
|
// Invalid files
|
|
fixtures.InvalidFile: &fstest.MapFile{Data: []byte("not a real image file content")},
|
|
fixtures.EmptyFile: &fstest.MapFile{Data: []byte{}},
|
|
fixtures.TextFile: &fstest.MapFile{Data: []byte("This is just text, not a PNG")},
|
|
}
|
|
|
|
return mockFS, fixtures
|
|
}
|
|
|
|
// generateTestJPEG creates a minimal valid JPEG image.
|
|
func generateTestJPEG(t *testing.T, width, height int, c color.Color) []byte {
|
|
t.Helper()
|
|
|
|
img := image.NewRGBA(image.Rect(0, 0, width, height))
|
|
for y := 0; y < height; y++ {
|
|
for x := 0; x < width; x++ {
|
|
img.Set(x, y, c)
|
|
}
|
|
}
|
|
|
|
var buf bytes.Buffer
|
|
if err := jpeg.Encode(&buf, img, &jpeg.Options{Quality: 85}); err != nil {
|
|
t.Fatalf("failed to encode test JPEG: %v", err)
|
|
}
|
|
|
|
return buf.Bytes()
|
|
}
|
|
|
|
// generateTestPNG creates a minimal valid PNG image.
|
|
func generateTestPNG(t *testing.T, width, height int, c color.Color) []byte {
|
|
t.Helper()
|
|
|
|
img := image.NewRGBA(image.Rect(0, 0, width, height))
|
|
for y := 0; y < height; y++ {
|
|
for x := 0; x < width; x++ {
|
|
img.Set(x, y, c)
|
|
}
|
|
}
|
|
|
|
var buf bytes.Buffer
|
|
if err := png.Encode(&buf, img); err != nil {
|
|
t.Fatalf("failed to encode test PNG: %v", err)
|
|
}
|
|
|
|
return buf.Bytes()
|
|
}
|
|
|
|
// generateTestGIF creates a minimal valid GIF image.
|
|
func generateTestGIF(t *testing.T, width, height int, c color.Color) []byte {
|
|
t.Helper()
|
|
|
|
img := image.NewPaletted(image.Rect(0, 0, width, height), []color.Color{c, color.White})
|
|
for y := 0; y < height; y++ {
|
|
for x := 0; x < width; x++ {
|
|
img.SetColorIndex(x, y, 0)
|
|
}
|
|
}
|
|
|
|
var buf bytes.Buffer
|
|
if err := gif.Encode(&buf, img, nil); err != nil {
|
|
t.Fatalf("failed to encode test GIF: %v", err)
|
|
}
|
|
|
|
return buf.Bytes()
|
|
}
|
|
|
|
// SetupTestService creates a Service with mock fetcher for testing.
|
|
func SetupTestService(t *testing.T, opts ...TestServiceOption) (*Service, *TestFixtures) {
|
|
t.Helper()
|
|
|
|
mockFS, fixtures := NewTestFS(t)
|
|
|
|
cfg := &testServiceConfig{
|
|
allowlist: []string{fixtures.GoodHost},
|
|
signingKey: "test-signing-key-must-be-32-chars",
|
|
}
|
|
|
|
for _, opt := range opts {
|
|
opt(cfg)
|
|
}
|
|
|
|
// Create temp directory for cache
|
|
tmpDir := t.TempDir()
|
|
|
|
// Create in-memory database
|
|
db := setupServiceTestDB(t)
|
|
|
|
cache, err := NewCache(db, CacheConfig{
|
|
StateDir: tmpDir,
|
|
CacheTTL: time.Hour,
|
|
NegativeTTL: 5 * time.Minute,
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("failed to create cache: %v", err)
|
|
}
|
|
|
|
svc, err := NewService(&ServiceConfig{
|
|
Cache: cache,
|
|
Fetcher: httpfetcher.NewMock(mockFS),
|
|
SigningKey: cfg.signingKey,
|
|
Allowlist: cfg.allowlist,
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("failed to create service: %v", err)
|
|
}
|
|
|
|
return svc, fixtures
|
|
}
|
|
|
|
// setupServiceTestDB creates an in-memory SQLite database for testing
|
|
// using the production schema.
|
|
func setupServiceTestDB(t *testing.T) *sql.DB {
|
|
t.Helper()
|
|
|
|
db, err := sql.Open("sqlite", ":memory:")
|
|
if err != nil {
|
|
t.Fatalf("failed to open test db: %v", err)
|
|
}
|
|
|
|
// Use the real production schema via migrations
|
|
if err := database.ApplyMigrations(context.Background(), db, nil); err != nil {
|
|
t.Fatalf("failed to apply migrations: %v", err)
|
|
}
|
|
|
|
return db
|
|
}
|
|
|
|
type testServiceConfig struct {
|
|
allowlist []string
|
|
signingKey string
|
|
}
|
|
|
|
// TestServiceOption configures the test service.
|
|
type TestServiceOption func(*testServiceConfig)
|
|
|
|
// WithAllowlist sets the allowlist for the test service.
|
|
func WithAllowlist(hosts ...string) TestServiceOption {
|
|
return func(c *testServiceConfig) {
|
|
c.allowlist = hosts
|
|
}
|
|
}
|
|
|
|
// WithSigningKey sets the signing key for the test service.
|
|
func WithSigningKey(key string) TestServiceOption {
|
|
return func(c *testServiceConfig) {
|
|
c.signingKey = key
|
|
}
|
|
}
|
|
|
|
// WithNoAllowlist removes all allowlisted hosts.
|
|
func WithNoAllowlist() TestServiceOption {
|
|
return func(c *testServiceConfig) {
|
|
c.allowlist = nil
|
|
}
|
|
}
|