refactor: extract signature package from imgcache
All checks were successful
check / check (push) Successful in 1m46s

Move HMAC-SHA256 request signing out of internal/imgcache/ into its own
internal/signature/ package, per the plan in issue #39. This is one of the
remaining "easily separable" extractions; only the signer is moved here so
the diff stays reviewable.

What moved (from internal/imgcache/signature.go):

- Signer type, its New constructor, Sign, Verify, GenerateSignedURL
- ParseParams (query-string signature/expiration parsing)
- Signature error sentinels

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 helper.

Renames (no stuttering):

- NewSigner -> signature.New
- ParseSignatureParams -> signature.ParseParams
- ErrSignatureRequired/Invalid/Expired -> signature.ErrRequired/Invalid/Expired

The "non-whitelisted host" error message is updated to "non-allowlisted"
for inclusive terminology, consistent with the allowlist rename.

Pure refactor. The bytes fed to the HMAC are unchanged, so signatures remain
compatible. All existing tests move with the package; docker build passes
(fmt-check, lint, test, build).

refs #39
This commit is contained in:
2026-07-25 17:51:30 +07:00
parent b6e9ac2a93
commit 6526b717dd
5 changed files with 223 additions and 168 deletions

View File

@@ -15,6 +15,7 @@ import (
"sneak.berlin/go/pixa/internal/httpfetcher" "sneak.berlin/go/pixa/internal/httpfetcher"
"sneak.berlin/go/pixa/internal/imageprocessor" "sneak.berlin/go/pixa/internal/imageprocessor"
"sneak.berlin/go/pixa/internal/magic" "sneak.berlin/go/pixa/internal/magic"
"sneak.berlin/go/pixa/internal/signature"
) )
// Service implements the ImageCache interface, orchestrating cache, fetcher, and processor. // Service implements the ImageCache interface, orchestrating cache, fetcher, and processor.
@@ -22,7 +23,7 @@ type Service struct {
cache *Cache cache *Cache
fetcher httpfetcher.Fetcher fetcher httpfetcher.Fetcher
processor *imageprocessor.ImageProcessor processor *imageprocessor.ImageProcessor
signer *Signer signer *signature.Signer
allowlist *allowlist.HostAllowList allowlist *allowlist.HostAllowList
log *slog.Logger log *slog.Logger
allowHTTP bool allowHTTP bool
@@ -69,7 +70,7 @@ func NewService(cfg *ServiceConfig) (*Service, error) {
fetcher = httpfetcher.New(fetcherCfg) fetcher = httpfetcher.New(fetcherCfg)
} }
signer := NewSigner(cfg.SigningKey) signer := signature.New(cfg.SigningKey)
log := cfg.Logger log := cfg.Logger
if log == nil { if log == nil {
@@ -397,7 +398,7 @@ func (s *Service) ValidateRequest(req *ImageRequest) error {
} }
// Signature required for non-allowed hosts // Signature required for non-allowed hosts
return s.signer.Verify(req) return s.signer.Verify(signatureRequest(req))
} }
// GenerateSignedURL generates a signed URL for the given request. // GenerateSignedURL generates a signed URL for the given request.
@@ -406,11 +407,32 @@ func (s *Service) GenerateSignedURL(
req *ImageRequest, req *ImageRequest,
ttl time.Duration, ttl time.Duration,
) (string, error) { ) (string, error) {
path, sig, exp := s.signer.GenerateSignedURL(req, ttl) sigReq := signatureRequest(req)
path, sig, exp := s.signer.GenerateSignedURL(sigReq, ttl)
// Propagate the generated signature and expiration back onto the request.
req.Expires = sigReq.Expires
req.Signature = sigReq.Signature
return fmt.Sprintf("%s%s?sig=%s&exp=%d", baseURL, path, sig, exp), nil return fmt.Sprintf("%s%s?sig=%s&exp=%d", baseURL, path, sig, exp), nil
} }
// signatureRequest projects an ImageRequest onto the standalone
// signature.Request type used by the signature package. This keeps the
// import edge one-way: imgcache depends on signature, never the reverse.
func signatureRequest(req *ImageRequest) *signature.Request {
return &signature.Request{
SourceHost: req.SourceHost,
SourcePath: req.SourcePath,
SourceQuery: req.SourceQuery,
Width: req.Size.Width,
Height: req.Size.Height,
Format: string(req.Format),
Signature: req.Signature,
Expires: req.Expires,
}
}
// HTTP status codes for error responses. // HTTP status codes for error responses.
const ( const (
httpStatusBadGateway = 502 httpStatusBadGateway = 502

View File

@@ -7,6 +7,7 @@ import (
"time" "time"
"sneak.berlin/go/pixa/internal/magic" "sneak.berlin/go/pixa/internal/magic"
"sneak.berlin/go/pixa/internal/signature"
) )
func TestService_Get_WhitelistedHost(t *testing.T) { func TestService_Get_WhitelistedHost(t *testing.T) {
@@ -77,9 +78,9 @@ func TestService_Get_NonWhitelistedHost_ValidSignature(t *testing.T) {
} }
// Generate a valid signature // Generate a valid signature
signer := NewSigner(signingKey) signer := signature.New(signingKey)
req.Expires = time.Now().Add(time.Hour) req.Expires = time.Now().Add(time.Hour)
req.Signature = signer.Sign(req) req.Signature = signer.Sign(signatureRequest(req))
// Should pass validation // Should pass validation
err := svc.ValidateRequest(req) err := svc.ValidateRequest(req)
@@ -118,9 +119,9 @@ func TestService_Get_NonWhitelistedHost_ExpiredSignature(t *testing.T) {
} }
// Generate an expired signature // Generate an expired signature
signer := NewSigner(signingKey) signer := signature.New(signingKey)
req.Expires = time.Now().Add(-time.Hour) // Already expired req.Expires = time.Now().Add(-time.Hour) // Already expired
req.Signature = signer.Sign(req) req.Signature = signer.Sign(signatureRequest(req))
// Should fail validation // Should fail validation
err := svc.ValidateRequest(req) err := svc.ValidateRequest(req)
@@ -164,7 +165,7 @@ func TestService_ValidateRequest_SignatureExactHostMatch(t *testing.T) {
WithNoWhitelist(), WithNoWhitelist(),
) )
signer := NewSigner(signingKey) signer := signature.New(signingKey)
// Sign a request for "cdn.example.com" // Sign a request for "cdn.example.com"
signedReq := &ImageRequest{ signedReq := &ImageRequest{
@@ -176,7 +177,7 @@ func TestService_ValidateRequest_SignatureExactHostMatch(t *testing.T) {
FitMode: FitCover, FitMode: FitCover,
Expires: time.Now().Add(time.Hour), Expires: time.Now().Add(time.Hour),
} }
signedReq.Signature = signer.Sign(signedReq) signedReq.Signature = signer.Sign(signatureRequest(signedReq))
// The original request should pass validation // The original request should pass validation
t.Run("exact host passes", func(t *testing.T) { t.Run("exact host passes", func(t *testing.T) {

View File

@@ -1,55 +0,0 @@
package imgcache
import (
"strings"
"testing"
"time"
)
func TestGenerateSignedURL_WithQueryString(t *testing.T) {
signer := NewSigner("test-secret-key-for-testing!")
req := &ImageRequest{
SourceHost: "cdn.example.com",
SourcePath: "/photos/cat.jpg",
SourceQuery: "token=abc&v=2",
Size: Size{Width: 800, Height: 600},
Format: FormatWebP,
}
path, _, _ := signer.GenerateSignedURL(req, time.Hour)
// The path must NOT contain a bare "?" that would be interpreted as a query string delimiter.
// The size segment must appear as the last path component.
if strings.Contains(path, "?token=abc") {
t.Errorf("GenerateSignedURL() produced bare query string in path: %q", path)
}
// The size segment must be present in the path
if !strings.Contains(path, "/800x600.webp") {
t.Errorf("GenerateSignedURL() missing size segment in path: %q", path)
}
// Path should end with the size.format, not with query params
if !strings.HasSuffix(path, "/800x600.webp") {
t.Errorf("GenerateSignedURL() path should end with size.format: %q", path)
}
}
func TestGenerateSignedURL_WithoutQueryString(t *testing.T) {
signer := NewSigner("test-secret-key-for-testing!")
req := &ImageRequest{
SourceHost: "cdn.example.com",
SourcePath: "/photos/cat.jpg",
Size: Size{Width: 800, Height: 600},
Format: FormatWebP,
}
path, _, _ := signer.GenerateSignedURL(req, time.Hour)
expected := "/v1/image/cdn.example.com/photos/cat.jpg/800x600.webp"
if path != expected {
t.Errorf("GenerateSignedURL() path = %q, want %q", path, expected)
}
}

View File

@@ -1,4 +1,6 @@
package imgcache // Package signature provides HMAC-SHA256 signing and verification of image
// requests.
package signature
import ( import (
"crypto/hmac" "crypto/hmac"
@@ -13,27 +15,49 @@ import (
// Signature errors. // Signature errors.
var ( var (
ErrSignatureRequired = errors.New("signature required for non-whitelisted host") ErrRequired = errors.New("signature required for non-allowlisted host")
ErrSignatureInvalid = errors.New("invalid signature") ErrInvalid = errors.New("invalid signature")
ErrSignatureExpired = errors.New("signature has expired") ErrExpired = errors.New("signature has expired")
ErrMissingExpiration = errors.New("signature expiration is required") ErrMissingExpiration = errors.New("signature expiration is required")
) )
// Request carries the components an image request signature covers. It is a
// standalone type so that this package does not depend on imgcache, keeping
// the import edge one-way (imgcache depends on signature, never the reverse).
type Request struct {
// SourceHost is the origin host (e.g. "cdn.example.com").
SourceHost string
// SourcePath is the path on the origin (e.g. "/photos/cat.jpg").
SourcePath string
// SourceQuery is the optional query string for the origin URL.
SourceQuery string
// Width is the requested output width in pixels.
Width int
// Height is the requested output height in pixels.
Height int
// Format is the requested output format (e.g. "webp").
Format string
// Signature is the HMAC signature to verify.
Signature string
// Expires is the signature expiration timestamp.
Expires time.Time
}
// Signer handles HMAC-SHA256 signature generation and verification. // Signer handles HMAC-SHA256 signature generation and verification.
type Signer struct { type Signer struct {
secretKey []byte secretKey []byte
} }
// NewSigner creates a new Signer with the given secret key. // New creates a new Signer with the given secret key.
func NewSigner(secretKey string) *Signer { func New(secretKey string) *Signer {
return &Signer{ return &Signer{
secretKey: []byte(secretKey), secretKey: []byte(secretKey),
} }
} }
// Sign generates an HMAC-SHA256 signature for the given image request. // Sign generates an HMAC-SHA256 signature for the given request.
// The signature covers: host + path + query + width + height + format + expiration. // The signature covers: host + path + query + width + height + format + expiration.
func (s *Signer) Sign(req *ImageRequest) string { func (s *Signer) Sign(req *Request) string {
data := s.buildSignatureData(req) data := s.buildSignatureData(req)
mac := hmac.New(sha256.New, s.secretKey) mac := hmac.New(sha256.New, s.secretKey)
mac.Write([]byte(data)) mac.Write([]byte(data))
@@ -48,14 +72,14 @@ func (s *Signer) Sign(req *ImageRequest) string {
// No suffix matching, wildcard matching, or partial matching is supported. // No suffix matching, wildcard matching, or partial matching is supported.
// A signature for "cdn.example.com" will NOT verify for "example.com" or // A signature for "cdn.example.com" will NOT verify for "example.com" or
// "other.cdn.example.com", and vice versa. // "other.cdn.example.com", and vice versa.
func (s *Signer) Verify(req *ImageRequest) error { func (s *Signer) Verify(req *Request) error {
// Check expiration first // Check expiration first
if req.Expires.IsZero() { if req.Expires.IsZero() {
return ErrMissingExpiration return ErrMissingExpiration
} }
if time.Now().After(req.Expires) { if time.Now().After(req.Expires) {
return ErrSignatureExpired return ErrExpired
} }
// Compute expected signature // Compute expected signature
@@ -63,7 +87,7 @@ func (s *Signer) Verify(req *ImageRequest) error {
// Constant-time comparison to prevent timing attacks // Constant-time comparison to prevent timing attacks
if !hmac.Equal([]byte(req.Signature), []byte(expected)) { if !hmac.Equal([]byte(req.Signature), []byte(expected)) {
return ErrSignatureInvalid return ErrInvalid
} }
return nil return nil
@@ -73,13 +97,13 @@ func (s *Signer) Verify(req *ImageRequest) error {
// Format: "host:path:query:width:height:format:expiration" // Format: "host:path:query:width:height:format:expiration"
// All components are used verbatim (exact match). No normalization, // All components are used verbatim (exact match). No normalization,
// suffix matching, or wildcard expansion is performed. // suffix matching, or wildcard expansion is performed.
func (s *Signer) buildSignatureData(req *ImageRequest) string { func (s *Signer) buildSignatureData(req *Request) string {
return fmt.Sprintf("%s:%s:%s:%d:%d:%s:%d", return fmt.Sprintf("%s:%s:%s:%d:%d:%s:%d",
req.SourceHost, req.SourceHost,
req.SourcePath, req.SourcePath,
req.SourceQuery, req.SourceQuery,
req.Size.Width, req.Width,
req.Size.Height, req.Height,
req.Format, req.Format,
req.Expires.Unix(), req.Expires.Unix(),
) )
@@ -87,7 +111,7 @@ func (s *Signer) buildSignatureData(req *ImageRequest) string {
// GenerateSignedURL creates a complete URL with signature and expiration. // GenerateSignedURL creates a complete URL with signature and expiration.
// Returns the path portion that should be appended to the base URL. // Returns the path portion that should be appended to the base URL.
func (s *Signer) GenerateSignedURL(req *ImageRequest, ttl time.Duration) (path string, sig string, exp int64) { func (s *Signer) GenerateSignedURL(req *Request, ttl time.Duration) (path string, sig string, exp int64) {
// Set expiration // Set expiration
req.Expires = time.Now().Add(ttl) req.Expires = time.Now().Add(ttl)
exp = req.Expires.Unix() exp = req.Expires.Unix()
@@ -98,15 +122,15 @@ func (s *Signer) GenerateSignedURL(req *ImageRequest, ttl time.Duration) (path s
// Build the size component // Build the size component
var sizeStr string var sizeStr string
if req.Size.OriginalSize() { if req.Width == 0 && req.Height == 0 {
sizeStr = "orig" sizeStr = "orig"
} else { } else {
sizeStr = fmt.Sprintf("%dx%d", req.Size.Width, req.Size.Height) sizeStr = fmt.Sprintf("%dx%d", req.Width, req.Height)
} }
// Build the path. // Build the path.
// When a source query is present, it is embedded as a path segment // When a source query is present, it is embedded as a path segment
// (e.g. /host/path?query/size.fmt) so that ParseImagePath can extract // (e.g. /host/path?query/size.fmt) so that the URL parser can extract
// it from the last-slash split. The "?" inside a path segment is // it from the last-slash split. The "?" inside a path segment is
// percent-encoded by clients but chi delivers it decoded, which is // percent-encoded by clients but chi delivers it decoded, which is
// exactly what the URL parser expects. // exactly what the URL parser expects.
@@ -130,12 +154,12 @@ func (s *Signer) GenerateSignedURL(req *ImageRequest, ttl time.Duration) (path s
return path, sig, exp return path, sig, exp
} }
// ParseSignatureParams extracts signature and expiration from query parameters. // ParseParams extracts signature and expiration from query parameters.
func ParseSignatureParams(sig, expStr string) (signature string, expires time.Time, err error) { func ParseParams(sig, expStr string) (parsed string, expires time.Time, err error) {
signature = sig parsed = sig
if expStr == "" { if expStr == "" {
return signature, time.Time{}, nil return parsed, time.Time{}, nil
} }
expUnix, err := strconv.ParseInt(expStr, 10, 64) expUnix, err := strconv.ParseInt(expStr, 10, 64)
@@ -145,5 +169,5 @@ func ParseSignatureParams(sig, expStr string) (signature string, expires time.Ti
expires = time.Unix(expUnix, 0) expires = time.Unix(expUnix, 0)
return signature, expires, nil return parsed, expires, nil
} }

View File

@@ -1,19 +1,21 @@
package imgcache package signature
import ( import (
"strings"
"testing" "testing"
"time" "time"
) )
func TestSigner_Sign(t *testing.T) { func TestSigner_Sign(t *testing.T) {
signer := NewSigner("test-secret-key") signer := New("test-secret-key")
req := &ImageRequest{ req := &Request{
SourceHost: "cdn.example.com", SourceHost: "cdn.example.com",
SourcePath: "/photos/cat.jpg", SourcePath: "/photos/cat.jpg",
SourceQuery: "", SourceQuery: "",
Size: Size{Width: 800, Height: 600}, Width: 800,
Format: FormatWebP, Height: 600,
Format: "webp",
Expires: time.Unix(1704067200, 0), // Fixed timestamp for reproducibility Expires: time.Unix(1704067200, 0), // Fixed timestamp for reproducibility
} }
@@ -31,12 +33,13 @@ func TestSigner_Sign(t *testing.T) {
} }
// Different input should produce different signature // Different input should produce different signature
req2 := &ImageRequest{ req2 := &Request{
SourceHost: "cdn.example.com", SourceHost: "cdn.example.com",
SourcePath: "/photos/dog.jpg", // Different path SourcePath: "/photos/dog.jpg", // Different path
SourceQuery: "", SourceQuery: "",
Size: Size{Width: 800, Height: 600}, Width: 800,
Format: FormatWebP, Height: 600,
Format: "webp",
Expires: time.Unix(1704067200, 0), Expires: time.Unix(1704067200, 0),
} }
@@ -47,21 +50,22 @@ func TestSigner_Sign(t *testing.T) {
} }
func TestSigner_Verify(t *testing.T) { func TestSigner_Verify(t *testing.T) {
signer := NewSigner("test-secret-key") signer := New("test-secret-key")
tests := []struct { tests := []struct {
name string name string
setup func() *ImageRequest setup func() *Request
wantErr error wantErr error
}{ }{
{ {
name: "valid signature", name: "valid signature",
setup: func() *ImageRequest { setup: func() *Request {
req := &ImageRequest{ req := &Request{
SourceHost: "cdn.example.com", SourceHost: "cdn.example.com",
SourcePath: "/photos/cat.jpg", SourcePath: "/photos/cat.jpg",
Size: Size{Width: 800, Height: 600}, Width: 800,
Format: FormatWebP, Height: 600,
Format: "webp",
Expires: time.Now().Add(1 * time.Hour), Expires: time.Now().Add(1 * time.Hour),
} }
req.Signature = signer.Sign(req) req.Signature = signer.Sign(req)
@@ -72,42 +76,45 @@ func TestSigner_Verify(t *testing.T) {
}, },
{ {
name: "expired signature", name: "expired signature",
setup: func() *ImageRequest { setup: func() *Request {
req := &ImageRequest{ req := &Request{
SourceHost: "cdn.example.com", SourceHost: "cdn.example.com",
SourcePath: "/photos/cat.jpg", SourcePath: "/photos/cat.jpg",
Size: Size{Width: 800, Height: 600}, Width: 800,
Format: FormatWebP, Height: 600,
Format: "webp",
Expires: time.Now().Add(-1 * time.Hour), // Expired Expires: time.Now().Add(-1 * time.Hour), // Expired
} }
req.Signature = signer.Sign(req) req.Signature = signer.Sign(req)
return req return req
}, },
wantErr: ErrSignatureExpired, wantErr: ErrExpired,
}, },
{ {
name: "invalid signature", name: "invalid signature",
setup: func() *ImageRequest { setup: func() *Request {
return &ImageRequest{ return &Request{
SourceHost: "cdn.example.com", SourceHost: "cdn.example.com",
SourcePath: "/photos/cat.jpg", SourcePath: "/photos/cat.jpg",
Size: Size{Width: 800, Height: 600}, Width: 800,
Format: FormatWebP, Height: 600,
Format: "webp",
Expires: time.Now().Add(1 * time.Hour), Expires: time.Now().Add(1 * time.Hour),
Signature: "invalid-signature", Signature: "invalid-signature",
} }
}, },
wantErr: ErrSignatureInvalid, wantErr: ErrInvalid,
}, },
{ {
name: "missing expiration", name: "missing expiration",
setup: func() *ImageRequest { setup: func() *Request {
return &ImageRequest{ return &Request{
SourceHost: "cdn.example.com", SourceHost: "cdn.example.com",
SourcePath: "/photos/cat.jpg", SourcePath: "/photos/cat.jpg",
Size: Size{Width: 800, Height: 600}, Width: 800,
Format: FormatWebP, Height: 600,
Format: "webp",
Signature: "some-signature", Signature: "some-signature",
// Expires is zero // Expires is zero
} }
@@ -116,12 +123,13 @@ func TestSigner_Verify(t *testing.T) {
}, },
{ {
name: "tampered request", name: "tampered request",
setup: func() *ImageRequest { setup: func() *Request {
req := &ImageRequest{ req := &Request{
SourceHost: "cdn.example.com", SourceHost: "cdn.example.com",
SourcePath: "/photos/cat.jpg", SourcePath: "/photos/cat.jpg",
Size: Size{Width: 800, Height: 600}, Width: 800,
Format: FormatWebP, Height: 600,
Format: "webp",
Expires: time.Now().Add(1 * time.Hour), Expires: time.Now().Add(1 * time.Hour),
} }
req.Signature = signer.Sign(req) req.Signature = signer.Sign(req)
@@ -130,7 +138,7 @@ func TestSigner_Verify(t *testing.T) {
return req return req
}, },
wantErr: ErrSignatureInvalid, wantErr: ErrInvalid,
}, },
} }
@@ -156,16 +164,17 @@ func TestSigner_Verify(t *testing.T) {
// matching on every URL component. No suffix matching, wildcard matching, // matching on every URL component. No suffix matching, wildcard matching,
// or partial matching is supported. // or partial matching is supported.
func TestSigner_Verify_ExactMatchOnly(t *testing.T) { func TestSigner_Verify_ExactMatchOnly(t *testing.T) {
signer := NewSigner("test-secret-key") signer := New("test-secret-key")
// Base request that we'll sign, then tamper with individual fields. // Base request that we'll sign, then tamper with individual fields.
baseReq := func() *ImageRequest { baseReq := func() *Request {
req := &ImageRequest{ req := &Request{
SourceHost: "cdn.example.com", SourceHost: "cdn.example.com",
SourcePath: "/photos/cat.jpg", SourcePath: "/photos/cat.jpg",
SourceQuery: "token=abc", SourceQuery: "token=abc",
Size: Size{Width: 800, Height: 600}, Width: 800,
Format: FormatWebP, Height: 600,
Format: "webp",
Expires: time.Now().Add(1 * time.Hour), Expires: time.Now().Add(1 * time.Hour),
} }
req.Signature = signer.Sign(req) req.Signature = signer.Sign(req)
@@ -175,95 +184,95 @@ func TestSigner_Verify_ExactMatchOnly(t *testing.T) {
tests := []struct { tests := []struct {
name string name string
tamper func(req *ImageRequest) tamper func(req *Request)
}{ }{
{ {
name: "parent domain does not match subdomain", name: "parent domain does not match subdomain",
tamper: func(req *ImageRequest) { tamper: func(req *Request) {
// Signed for cdn.example.com, try example.com // Signed for cdn.example.com, try example.com
req.SourceHost = "example.com" req.SourceHost = "example.com"
}, },
}, },
{ {
name: "subdomain does not match parent domain", name: "subdomain does not match parent domain",
tamper: func(req *ImageRequest) { tamper: func(req *Request) {
// Signed for cdn.example.com, try images.cdn.example.com // Signed for cdn.example.com, try images.cdn.example.com
req.SourceHost = "images.cdn.example.com" req.SourceHost = "images.cdn.example.com"
}, },
}, },
{ {
name: "sibling subdomain does not match", name: "sibling subdomain does not match",
tamper: func(req *ImageRequest) { tamper: func(req *Request) {
// Signed for cdn.example.com, try images.example.com // Signed for cdn.example.com, try images.example.com
req.SourceHost = "images.example.com" req.SourceHost = "images.example.com"
}, },
}, },
{ {
name: "host with suffix appended does not match", name: "host with suffix appended does not match",
tamper: func(req *ImageRequest) { tamper: func(req *Request) {
// Signed for cdn.example.com, try cdn.example.com.evil.com // Signed for cdn.example.com, try cdn.example.com.evil.com
req.SourceHost = "cdn.example.com.evil.com" req.SourceHost = "cdn.example.com.evil.com"
}, },
}, },
{ {
name: "host with prefix does not match", name: "host with prefix does not match",
tamper: func(req *ImageRequest) { tamper: func(req *Request) {
// Signed for cdn.example.com, try evilcdn.example.com // Signed for cdn.example.com, try evilcdn.example.com
req.SourceHost = "evilcdn.example.com" req.SourceHost = "evilcdn.example.com"
}, },
}, },
{ {
name: "different path does not match", name: "different path does not match",
tamper: func(req *ImageRequest) { tamper: func(req *Request) {
req.SourcePath = "/photos/dog.jpg" req.SourcePath = "/photos/dog.jpg"
}, },
}, },
{ {
name: "path suffix does not match", name: "path suffix does not match",
tamper: func(req *ImageRequest) { tamper: func(req *Request) {
req.SourcePath = "/photos/cat.jpg/extra" req.SourcePath = "/photos/cat.jpg/extra"
}, },
}, },
{ {
name: "path prefix does not match", name: "path prefix does not match",
tamper: func(req *ImageRequest) { tamper: func(req *Request) {
req.SourcePath = "/other/photos/cat.jpg" req.SourcePath = "/other/photos/cat.jpg"
}, },
}, },
{ {
name: "different query does not match", name: "different query does not match",
tamper: func(req *ImageRequest) { tamper: func(req *Request) {
req.SourceQuery = "token=xyz" req.SourceQuery = "token=xyz"
}, },
}, },
{ {
name: "added query does not match empty query", name: "added query does not match empty query",
tamper: func(req *ImageRequest) { tamper: func(req *Request) {
req.SourceQuery = "extra=1" req.SourceQuery = "extra=1"
}, },
}, },
{ {
name: "removed query does not match", name: "removed query does not match",
tamper: func(req *ImageRequest) { tamper: func(req *Request) {
req.SourceQuery = "" req.SourceQuery = ""
}, },
}, },
{ {
name: "different width does not match", name: "different width does not match",
tamper: func(req *ImageRequest) { tamper: func(req *Request) {
req.Size.Width = 801 req.Width = 801
}, },
}, },
{ {
name: "different height does not match", name: "different height does not match",
tamper: func(req *ImageRequest) { tamper: func(req *Request) {
req.Size.Height = 601 req.Height = 601
}, },
}, },
{ {
name: "different format does not match", name: "different format does not match",
tamper: func(req *ImageRequest) { tamper: func(req *Request) {
req.Format = FormatPNG req.Format = "png"
}, },
}, },
} }
@@ -274,8 +283,8 @@ func TestSigner_Verify_ExactMatchOnly(t *testing.T) {
tt.tamper(req) tt.tamper(req)
err := signer.Verify(req) err := signer.Verify(req)
if err != ErrSignatureInvalid { if err != ErrInvalid {
t.Errorf("Verify() = %v, want %v", err, ErrSignatureInvalid) t.Errorf("Verify() = %v, want %v", err, ErrInvalid)
} }
}) })
} }
@@ -293,7 +302,7 @@ func TestSigner_Verify_ExactMatchOnly(t *testing.T) {
// string in the signature data, producing different signatures for // string in the signature data, producing different signatures for
// suffix-related hosts. // suffix-related hosts.
func TestSigner_Sign_ExactHostInData(t *testing.T) { func TestSigner_Sign_ExactHostInData(t *testing.T) {
signer := NewSigner("test-secret-key") signer := New("test-secret-key")
hosts := []string{ hosts := []string{
"cdn.example.com", "cdn.example.com",
@@ -306,12 +315,13 @@ func TestSigner_Sign_ExactHostInData(t *testing.T) {
sigs := make(map[string]string) sigs := make(map[string]string)
for _, host := range hosts { for _, host := range hosts {
req := &ImageRequest{ req := &Request{
SourceHost: host, SourceHost: host,
SourcePath: "/photos/cat.jpg", SourcePath: "/photos/cat.jpg",
SourceQuery: "", SourceQuery: "",
Size: Size{Width: 800, Height: 600}, Width: 800,
Format: FormatWebP, Height: 600,
Format: "webp",
Expires: time.Unix(1704067200, 0), Expires: time.Unix(1704067200, 0),
} }
@@ -325,14 +335,15 @@ func TestSigner_Sign_ExactHostInData(t *testing.T) {
} }
func TestSigner_DifferentKeys(t *testing.T) { func TestSigner_DifferentKeys(t *testing.T) {
signer1 := NewSigner("secret-key-1") signer1 := New("secret-key-1")
signer2 := NewSigner("secret-key-2") signer2 := New("secret-key-2")
req := &ImageRequest{ req := &Request{
SourceHost: "cdn.example.com", SourceHost: "cdn.example.com",
SourcePath: "/photos/cat.jpg", SourcePath: "/photos/cat.jpg",
Size: Size{Width: 800, Height: 600}, Width: 800,
Format: FormatWebP, Height: 600,
Format: "webp",
Expires: time.Now().Add(1 * time.Hour), Expires: time.Now().Add(1 * time.Hour),
} }
@@ -345,20 +356,21 @@ func TestSigner_DifferentKeys(t *testing.T) {
} }
// Verify with key 2 should fail // Verify with key 2 should fail
if err := signer2.Verify(req); err != ErrSignatureInvalid { if err := signer2.Verify(req); err != ErrInvalid {
t.Errorf("Verify() with different key should fail, got: %v", err) t.Errorf("Verify() with different key should fail, got: %v", err)
} }
} }
func TestGenerateSignedURL(t *testing.T) { func TestGenerateSignedURL(t *testing.T) {
signer := NewSigner("test-secret-key") signer := New("test-secret-key")
req := &ImageRequest{ req := &Request{
SourceHost: "cdn.example.com", SourceHost: "cdn.example.com",
SourcePath: "/photos/cat.jpg", SourcePath: "/photos/cat.jpg",
SourceQuery: "", SourceQuery: "",
Size: Size{Width: 800, Height: 600}, Width: 800,
Format: FormatWebP, Height: 600,
Format: "webp",
} }
ttl := 1 * time.Hour ttl := 1 * time.Hour
@@ -389,13 +401,14 @@ func TestGenerateSignedURL(t *testing.T) {
} }
func TestGenerateSignedURL_OrigSize(t *testing.T) { func TestGenerateSignedURL_OrigSize(t *testing.T) {
signer := NewSigner("test-secret-key") signer := New("test-secret-key")
req := &ImageRequest{ req := &Request{
SourceHost: "cdn.example.com", SourceHost: "cdn.example.com",
SourcePath: "/photos/cat.jpg", SourcePath: "/photos/cat.jpg",
Size: Size{Width: 0, Height: 0}, // Original size Width: 0, // Original size
Format: FormatPNG, Height: 0,
Format: "png",
} }
path, _, _ := signer.GenerateSignedURL(req, time.Hour) path, _, _ := signer.GenerateSignedURL(req, time.Hour)
@@ -406,7 +419,57 @@ func TestGenerateSignedURL_OrigSize(t *testing.T) {
} }
} }
func TestParseSignatureParams(t *testing.T) { func TestGenerateSignedURL_WithQueryString(t *testing.T) {
signer := New("test-secret-key-for-testing!")
req := &Request{
SourceHost: "cdn.example.com",
SourcePath: "/photos/cat.jpg",
SourceQuery: "token=abc&v=2",
Width: 800,
Height: 600,
Format: "webp",
}
path, _, _ := signer.GenerateSignedURL(req, time.Hour)
// The path must NOT contain a bare "?" that would be interpreted as a query string delimiter.
// The size segment must appear as the last path component.
if strings.Contains(path, "?token=abc") {
t.Errorf("GenerateSignedURL() produced bare query string in path: %q", path)
}
// The size segment must be present in the path
if !strings.Contains(path, "/800x600.webp") {
t.Errorf("GenerateSignedURL() missing size segment in path: %q", path)
}
// Path should end with the size.format, not with query params
if !strings.HasSuffix(path, "/800x600.webp") {
t.Errorf("GenerateSignedURL() path should end with size.format: %q", path)
}
}
func TestGenerateSignedURL_WithoutQueryString(t *testing.T) {
signer := New("test-secret-key-for-testing!")
req := &Request{
SourceHost: "cdn.example.com",
SourcePath: "/photos/cat.jpg",
Width: 800,
Height: 600,
Format: "webp",
}
path, _, _ := signer.GenerateSignedURL(req, time.Hour)
expected := "/v1/image/cdn.example.com/photos/cat.jpg/800x600.webp"
if path != expected {
t.Errorf("GenerateSignedURL() path = %q, want %q", path, expected)
}
}
func TestParseParams(t *testing.T) {
tests := []struct { tests := []struct {
name string name string
sig string sig string
@@ -439,18 +502,18 @@ func TestParseSignatureParams(t *testing.T) {
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) { t.Run(tt.name, func(t *testing.T) {
sig, exp, err := ParseSignatureParams(tt.sig, tt.expStr) sig, exp, err := ParseParams(tt.sig, tt.expStr)
if tt.wantErr { if tt.wantErr {
if err == nil { if err == nil {
t.Error("ParseSignatureParams() expected error, got nil") t.Error("ParseParams() expected error, got nil")
} }
return return
} }
if err != nil { if err != nil {
t.Errorf("ParseSignatureParams() unexpected error = %v", err) t.Errorf("ParseParams() unexpected error = %v", err)
return return
} }