clawbot
6573b9d1ef
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>
114 lines
2.7 KiB
Go
114 lines
2.7 KiB
Go
package config
|
|
|
|
import (
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
|
|
"git.eeqj.de/sneak/smartconfig"
|
|
)
|
|
|
|
func TestGetStringSlice_YAMLList(t *testing.T) {
|
|
// Create a temp config file with YAML list format
|
|
tmpDir := t.TempDir()
|
|
configPath := filepath.Join(tmpDir, "config.yml")
|
|
|
|
yamlContent := `
|
|
allowlist_hosts:
|
|
- static.sneak.cloud
|
|
- sneak.berlin
|
|
- s3.sneak.cloud
|
|
`
|
|
err := os.WriteFile(configPath, []byte(yamlContent), 0644)
|
|
if err != nil {
|
|
t.Fatalf("failed to write test config: %v", err)
|
|
}
|
|
|
|
// Load config using smartconfig
|
|
sc, err := loadTestConfig(configPath)
|
|
if err != nil {
|
|
t.Fatalf("failed to load config: %v", err)
|
|
}
|
|
|
|
// Test that getStringSlice correctly parses YAML list
|
|
hosts := getStringSlice(sc, "allowlist_hosts")
|
|
|
|
if len(hosts) != 3 {
|
|
t.Errorf("expected 3 hosts, got %d: %v", len(hosts), hosts)
|
|
}
|
|
|
|
expected := []string{"static.sneak.cloud", "sneak.berlin", "s3.sneak.cloud"}
|
|
for i, want := range expected {
|
|
if i >= len(hosts) {
|
|
t.Errorf("missing host at index %d: want %q", i, want)
|
|
continue
|
|
}
|
|
if hosts[i] != want {
|
|
t.Errorf("host[%d] = %q, want %q", i, hosts[i], want)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestGetStringSlice_CommaSeparated(t *testing.T) {
|
|
// Test backwards compatibility with comma-separated string
|
|
tmpDir := t.TempDir()
|
|
configPath := filepath.Join(tmpDir, "config.yml")
|
|
|
|
yamlContent := `allowlist_hosts: "static.sneak.cloud, sneak.berlin, s3.sneak.cloud"`
|
|
|
|
err := os.WriteFile(configPath, []byte(yamlContent), 0644)
|
|
if err != nil {
|
|
t.Fatalf("failed to write test config: %v", err)
|
|
}
|
|
|
|
sc, err := loadTestConfig(configPath)
|
|
if err != nil {
|
|
t.Fatalf("failed to load config: %v", err)
|
|
}
|
|
|
|
hosts := getStringSlice(sc, "allowlist_hosts")
|
|
|
|
if len(hosts) != 3 {
|
|
t.Errorf("expected 3 hosts, got %d: %v", len(hosts), hosts)
|
|
}
|
|
|
|
expected := []string{"static.sneak.cloud", "sneak.berlin", "s3.sneak.cloud"}
|
|
for i, want := range expected {
|
|
if i >= len(hosts) {
|
|
t.Errorf("missing host at index %d: want %q", i, want)
|
|
continue
|
|
}
|
|
if hosts[i] != want {
|
|
t.Errorf("host[%d] = %q, want %q", i, hosts[i], want)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestGetStringSlice_Empty(t *testing.T) {
|
|
tmpDir := t.TempDir()
|
|
configPath := filepath.Join(tmpDir, "config.yml")
|
|
|
|
yamlContent := `port: 8080`
|
|
|
|
err := os.WriteFile(configPath, []byte(yamlContent), 0644)
|
|
if err != nil {
|
|
t.Fatalf("failed to write test config: %v", err)
|
|
}
|
|
|
|
sc, err := loadTestConfig(configPath)
|
|
if err != nil {
|
|
t.Fatalf("failed to load config: %v", err)
|
|
}
|
|
|
|
hosts := getStringSlice(sc, "allowlist_hosts")
|
|
|
|
if hosts != nil && len(hosts) != 0 {
|
|
t.Errorf("expected nil or empty slice, got %v", hosts)
|
|
}
|
|
}
|
|
|
|
// loadTestConfig is a helper to load a config file for testing
|
|
func loadTestConfig(path string) (*smartconfig.Config, error) {
|
|
return smartconfig.NewFromConfigPath(path)
|
|
}
|