Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6a753f14c4 | ||
|
|
5f88dc5cfa |
+4
-8
@@ -13,12 +13,9 @@ RUN go mod download
|
|||||||
# Copy source code
|
# Copy source code
|
||||||
COPY . .
|
COPY . .
|
||||||
|
|
||||||
# Run formatting check and linter. The linter is invoked directly, not
|
# Run formatting check and linter
|
||||||
# via `make lint`: `make lint` now builds Dockerfile.lint, and there is
|
|
||||||
# no Docker inside a Docker build. This is the same linter, image, and
|
|
||||||
# config that Dockerfile.lint and script/lint run.
|
|
||||||
RUN make fmt-check
|
RUN make fmt-check
|
||||||
RUN golangci-lint run --config .golangci.yml ./...
|
RUN make lint
|
||||||
|
|
||||||
# Build stage
|
# Build stage
|
||||||
# golang:1.25.4-alpine, 2026-02-25
|
# golang:1.25.4-alpine, 2026-02-25
|
||||||
@@ -70,9 +67,8 @@ RUN adduser -D -H -s /sbin/nologin pixad && \
|
|||||||
mkdir -p /var/lib/pixa /etc/pixa && \
|
mkdir -p /var/lib/pixa /etc/pixa && \
|
||||||
chown pixad:pixad /var/lib/pixa
|
chown pixad:pixad /var/lib/pixa
|
||||||
|
|
||||||
# Copy the image config; signing_key comes from PIXA_SIGNING_KEY.
|
# Copy default config (edit signing_key before use)
|
||||||
# Mount a file over /etc/pixa/config.yml to override anything else.
|
COPY config.example.yml /etc/pixa/config.yml
|
||||||
COPY config.docker.yml /etc/pixa/config.yml
|
|
||||||
|
|
||||||
USER pixad
|
USER pixad
|
||||||
WORKDIR /var/lib/pixa
|
WORKDIR /var/lib/pixa
|
||||||
|
|||||||
@@ -1,41 +0,0 @@
|
|||||||
# Dockerfile.lint: the one and only path that runs golangci-lint.
|
|
||||||
#
|
|
||||||
# golangci-lint is never installed on the host; it runs only inside this
|
|
||||||
# build. A clean build of this file therefore IS a clean lint over the
|
|
||||||
# whole tree. It runs the same linter and config as Dockerfile's lint
|
|
||||||
# stage, pinned to the same image so the two cannot drift to different
|
|
||||||
# linter versions.
|
|
||||||
#
|
|
||||||
# golangci/golangci-lint:v2.12.2-alpine, 2026-08-07
|
|
||||||
FROM golangci/golangci-lint:v2.12.2-alpine@sha256:91b27804074a0bacea298707f016911e60cf0cdbc6c7bf5ccacb5f0606d18d60
|
|
||||||
|
|
||||||
# pixa is CGO/libvips: the type-aware linters compile every package, so
|
|
||||||
# this image needs the same C libraries the build does.
|
|
||||||
RUN apk add --no-cache build-base vips-dev libheif-dev pkgconfig
|
|
||||||
|
|
||||||
WORKDIR /src
|
|
||||||
|
|
||||||
# Modules first for layer caching; go.mod/go.sum settle this layer's
|
|
||||||
# result, so it may safely be reused between runs.
|
|
||||||
COPY go.mod go.sum ./
|
|
||||||
RUN go mod download
|
|
||||||
|
|
||||||
COPY . .
|
|
||||||
|
|
||||||
# Caching is deliberately waived for the lint step: an unchanged tree
|
|
||||||
# must still run the linter, not return a cached success in well under a
|
|
||||||
# second having linted nothing. CACHEBUST carries a value that differs
|
|
||||||
# on every run (script/lint supplies it and refuses to build without
|
|
||||||
# one). The lint RUN below references it, so BuildKit cannot serve that
|
|
||||||
# step from cache. Keep the ${CACHEBUST} reference on that step: dropping
|
|
||||||
# it lets the linter cache again and report a green that linted nothing.
|
|
||||||
ARG CACHEBUST
|
|
||||||
RUN test -n "${CACHEBUST}" || { \
|
|
||||||
echo "Dockerfile.lint requires the CACHEBUST build-arg; build it via script/lint." >&2; \
|
|
||||||
exit 1; }
|
|
||||||
|
|
||||||
# `golangci-lint config verify` is deliberately not run: it fetches its
|
|
||||||
# JSON schema over an unpinned live HTTPS call, which REPO_POLICIES.md
|
|
||||||
# forbids for external references.
|
|
||||||
RUN echo "pixa-lint: running golangci-lint (${CACHEBUST})" && \
|
|
||||||
golangci-lint run --config .golangci.yml ./...
|
|
||||||
@@ -15,25 +15,14 @@ git clone https://git.eeqj.de/sneak/pixa.git
|
|||||||
cd pixa
|
cd pixa
|
||||||
make build
|
make build
|
||||||
|
|
||||||
# run with a config file: copy the example and set a real signing key
|
# run with a config file
|
||||||
# (the example placeholder is refused at startup), e.g. with
|
./bin/pixad --config config.example.yml
|
||||||
# openssl rand -base64 32
|
|
||||||
cp config.example.yml config.yml
|
|
||||||
$EDITOR config.yml # replace the signing_key placeholder
|
|
||||||
./bin/pixad --config config.yml
|
|
||||||
|
|
||||||
# or build and run via Docker
|
# or build and run via Docker
|
||||||
make docker
|
make docker
|
||||||
docker run -p 8080:8080 -e PIXA_SIGNING_KEY="$(openssl rand -base64 32)" pixa:latest
|
docker run -p 8080:8080 pixad:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
A container is configured two ways. The signing key comes from the
|
|
||||||
`PIXA_SIGNING_KEY` environment variable, which the baked-in config
|
|
||||||
reads; if it is unset the container exits at startup naming the
|
|
||||||
variable. Everything else uses built-in defaults, so to change any
|
|
||||||
other setting mount your own file over `/etc/pixa/config.yml` (see
|
|
||||||
`config.example.yml` for the full set of keys).
|
|
||||||
|
|
||||||
## Rationale
|
## Rationale
|
||||||
|
|
||||||
Image-heavy web applications need a fast, caching reverse proxy that
|
Image-heavy web applications need a fast, caching reverse proxy that
|
||||||
|
|||||||
@@ -1,27 +1,21 @@
|
|||||||
# Workflow
|
# Workflow
|
||||||
|
|
||||||
* branch per issue from `next`
|
* branch (from `main`)
|
||||||
* do the work in Next Step
|
* do the work in Next Step
|
||||||
* move Next Step to the top of Completed Steps
|
* move Next Step to the top of Completed Steps
|
||||||
* move the top item of Future Steps into Next Step
|
* move the top item of Future Steps into Next Step
|
||||||
* commit (`TODO.md` changes in the same commit as the work)
|
* commit (`TODO.md` changes in the same commit as the work)
|
||||||
* open a PR based on `next`
|
* merge to `main` if the branch is not protected, otherwise open a PR
|
||||||
* an independent reviewer who did not write the change gates it
|
|
||||||
* the manager squash-merges the PR into `next` once review passes
|
|
||||||
* `next` stays green and mergeable to `main` at any time; only the owner
|
|
||||||
merges `next` into `main`, via the single milestone PR
|
|
||||||
* push
|
* push
|
||||||
|
|
||||||
# Status
|
# Status
|
||||||
|
|
||||||
pre-1.0. No git tags exist. The `1.0.0` milestone is in progress; work
|
pre-1.0. No git tags exist. Recent work extracted the internal/magic,
|
||||||
lands on `next`, and `main` receives only the milestone PR that the
|
|
||||||
owner merges. `next` is at the canonical `golangci-lint` v2.12.2 config
|
|
||||||
and is green. Recent work extracted the internal/magic,
|
|
||||||
internal/allowlist, internal/httpfetcher, and internal/signature
|
internal/allowlist, internal/httpfetcher, and internal/signature
|
||||||
packages. The gosec findings from the 2026-07-06 survey are resolved.
|
packages. The gosec findings from the 2026-07-06 survey are resolved
|
||||||
The disk cache is now size-bounded with LRU eviction
|
and `make check` is green on main. The disk cache is now size-bounded
|
||||||
(`cache_max_bytes`), closing the unbounded disk growth DoS vector.
|
with LRU eviction (`cache_max_bytes`), closing the unbounded disk
|
||||||
|
growth DoS vector.
|
||||||
|
|
||||||
# Next Step
|
# Next Step
|
||||||
|
|
||||||
@@ -29,23 +23,6 @@ P1: implement blocked networks configuration to extend SSRF protection
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-09-21 run all linting in Docker via `Dockerfile.lint` +
|
|
||||||
`script/lint` (closes #104): `script/lint` builds a hash-pinned root
|
|
||||||
`Dockerfile.lint`, and no host or nix-shell `golangci-lint` path
|
|
||||||
remains; a per-run `CACHEBUST` build-arg forces the lint step to
|
|
||||||
execute every run, so an unchanged tree cannot return a cached green
|
|
||||||
that linted nothing; `Dockerfile`'s lint stage runs `golangci-lint`
|
|
||||||
directly, since `make lint` now builds a container and there is no
|
|
||||||
Docker inside a build; `golangci-lint config verify` stays out, as it
|
|
||||||
fetches its schema over an unpinned live HTTPS call
|
|
||||||
- 2026-09-21 http.Server hardening (closes #92): added
|
|
||||||
`HTTPReadHeaderTimeout` (10s, bounds the slowloris header dribble) and
|
|
||||||
`HTTPIdleTimeout` (120s, bounds keep-alive reuse) alongside the
|
|
||||||
existing timeouts and wired them onto the server; added a `LimitBody`
|
|
||||||
middleware capping the two form POST bodies (`POST /`, `POST /generate`)
|
|
||||||
at `MaxFormBytes` (1 MiB) and returning 413, applied ahead of the CSRF
|
|
||||||
middleware so an oversized body is refused as 413 rather than being read
|
|
||||||
as a missing CSRF token (403); left `WriteTimeout` at 60s unchanged
|
|
||||||
- 2026-08-07 update golangci-lint to v2.12.2 with the canonical
|
- 2026-08-07 update golangci-lint to v2.12.2 with the canonical
|
||||||
`.golangci.yml` (v2 schema, `default: all` minus six disabled
|
`.golangci.yml` (v2 schema, `default: all` minus six disabled
|
||||||
linters, `lll` 88, tests included): bumped the pinned
|
linters, `lll` 88, tests included): bumped the pinned
|
||||||
|
|||||||
@@ -1,11 +0,0 @@
|
|||||||
# Pixa configuration baked into the Docker image.
|
|
||||||
#
|
|
||||||
# The signing key is read from the PIXA_SIGNING_KEY environment
|
|
||||||
# variable; startup aborts naming it when it is unset. Every other key
|
|
||||||
# is omitted so its default applies. Operators who need more (an
|
|
||||||
# allowlist, metrics, and so on) mount their own file over
|
|
||||||
# /etc/pixa/config.yml.
|
|
||||||
|
|
||||||
signing_key: "${ENV:PIXA_SIGNING_KEY}"
|
|
||||||
state_dir: /var/lib/pixa
|
|
||||||
port: 8080
|
|
||||||
@@ -44,12 +44,6 @@ const (
|
|||||||
keyCacheMaxBytes = "cache_max_bytes"
|
keyCacheMaxBytes = "cache_max_bytes"
|
||||||
)
|
)
|
||||||
|
|
||||||
// placeholderSigningKey is the dummy signing_key shipped in
|
|
||||||
// config.example.yml. It is 45 characters, so it passes the length
|
|
||||||
// check, but it is public in this repository and must be rejected at
|
|
||||||
// startup so no deployment ever signs URLs with it.
|
|
||||||
const placeholderSigningKey = "CHANGE_ME_generate_with_openssl_rand_base64_32"
|
|
||||||
|
|
||||||
// Static validation errors. Each use site attaches the offending key
|
// Static validation errors. Each use site attaches the offending key
|
||||||
// and value by wrapping these with fmt.Errorf and %w.
|
// and value by wrapping these with fmt.Errorf and %w.
|
||||||
var (
|
var (
|
||||||
@@ -67,9 +61,6 @@ var (
|
|||||||
errPortOutOfRange = errors.New("outside the valid port range")
|
errPortOutOfRange = errors.New("outside the valid port range")
|
||||||
errTooFewConnections = errors.New("must be at least 1")
|
errTooFewConnections = errors.New("must be at least 1")
|
||||||
errValueTooShort = errors.New("value too short")
|
errValueTooShort = errors.New("value too short")
|
||||||
errPlaceholderKey = errors.New(
|
|
||||||
"is the placeholder from config.example.yml; " +
|
|
||||||
"generate a real key with: openssl rand -base64 32")
|
|
||||||
errMustBeSetTogether = errors.New("must be set together")
|
errMustBeSetTogether = errors.New("must be set together")
|
||||||
errMustNotBeNegative = errors.New("must not be negative")
|
errMustNotBeNegative = errors.New("must not be negative")
|
||||||
errOverflowsInt64 = errors.New("overflows a 64-bit integer")
|
errOverflowsInt64 = errors.New("overflows a 64-bit integer")
|
||||||
@@ -350,10 +341,10 @@ func (c *Config) ensureStateDirWritable() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// validateSigningKey checks that the signing key is present, long
|
// validate checks that all required configuration values are set and
|
||||||
// enough, and not the public placeholder from config.example.yml. The
|
// that every value is within its valid range.
|
||||||
// key value itself is never echoed in error messages.
|
func (c *Config) validate() error {
|
||||||
func (c *Config) validateSigningKey() error {
|
// The signing key value is never echoed in error messages.
|
||||||
if c.SigningKey == "" {
|
if c.SigningKey == "" {
|
||||||
return fmt.Errorf("config key %q: %w", keySigningKey, errValueRequired)
|
return fmt.Errorf("config key %q: %w", keySigningKey, errValueRequired)
|
||||||
}
|
}
|
||||||
@@ -365,21 +356,6 @@ func (c *Config) validateSigningKey() error {
|
|||||||
keySigningKey, errValueTooShort, minKeyLength, len(c.SigningKey))
|
keySigningKey, errValueTooShort, minKeyLength, len(c.SigningKey))
|
||||||
}
|
}
|
||||||
|
|
||||||
if c.SigningKey == placeholderSigningKey {
|
|
||||||
return fmt.Errorf("config key %q: %w", keySigningKey, errPlaceholderKey)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// validate checks that all required configuration values are set and
|
|
||||||
// that every value is within its valid range.
|
|
||||||
func (c *Config) validate() error {
|
|
||||||
err := c.validateSigningKey()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
const maxPort = 65535
|
const maxPort = 65535
|
||||||
if c.Port < 1 || c.Port > maxPort {
|
if c.Port < 1 || c.Port > maxPort {
|
||||||
return fmt.Errorf("config key %q: value %d is %w 1-%d",
|
return fmt.Errorf("config key %q: value %d is %w 1-%d",
|
||||||
|
|||||||
@@ -303,11 +303,6 @@ func invalidHostAndCredentialCases() []abortCase {
|
|||||||
yaml: "signing_key: short\n",
|
yaml: "signing_key: short\n",
|
||||||
wantErrSubstrings: []string{keySigningKey},
|
wantErrSubstrings: []string{keySigningKey},
|
||||||
},
|
},
|
||||||
{
|
|
||||||
name: "signing_key is the documented placeholder",
|
|
||||||
yaml: "signing_key: " + placeholderSigningKey + "\n",
|
|
||||||
wantErrSubstrings: []string{keySigningKey},
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
name: "signing_key missing",
|
name: "signing_key missing",
|
||||||
yaml: "port: 8080\n",
|
yaml: "port: 8080\n",
|
||||||
|
|||||||
@@ -1,45 +0,0 @@
|
|||||||
package handlers
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"net/http"
|
|
||||||
)
|
|
||||||
|
|
||||||
// MaxFormBytes bounds the request body accepted on the HTML form POST
|
|
||||||
// routes (POST / and POST /generate). The forms carry a handful of short
|
|
||||||
// fields, so 1 MiB is generous while making the bound explicit rather than
|
|
||||||
// resting on ParseForm's incidental 10 MB cap.
|
|
||||||
const MaxFormBytes = 1 << 20 // 1 MiB
|
|
||||||
|
|
||||||
// LimitBody returns middleware that caps the request body on POST requests
|
|
||||||
// at maxBytes and rejects an oversized body with 413 Request Entity Too
|
|
||||||
// Large.
|
|
||||||
//
|
|
||||||
// It parses the form here, before the CSRF middleware reads the token from
|
|
||||||
// it. The CSRF middleware reads the token with PostFormValue, which
|
|
||||||
// swallows a parse error, so if the body were only capped there an
|
|
||||||
// oversized body would read as a missing token and be refused as 403. By
|
|
||||||
// parsing under the cap first, an oversized body is refused as 413. A
|
|
||||||
// successful parse is cached on the request, so the CSRF check and the
|
|
||||||
// handler reuse it rather than reading the body again.
|
|
||||||
func (s *Handlers) LimitBody(maxBytes int64) func(http.Handler) http.Handler {
|
|
||||||
return func(next http.Handler) http.Handler {
|
|
||||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if r.Method == http.MethodPost {
|
|
||||||
r.Body = http.MaxBytesReader(w, r.Body, maxBytes)
|
|
||||||
|
|
||||||
err := r.ParseForm()
|
|
||||||
|
|
||||||
var tooLarge *http.MaxBytesError
|
|
||||||
if errors.As(err, &tooLarge) {
|
|
||||||
http.Error(w, "Request body too large",
|
|
||||||
http.StatusRequestEntityTooLarge)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
next.ServeHTTP(w, r)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,177 +0,0 @@
|
|||||||
package handlers
|
|
||||||
|
|
||||||
import (
|
|
||||||
"log/slog"
|
|
||||||
"net/http"
|
|
||||||
"net/url"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/go-chi/chi/v5"
|
|
||||||
|
|
||||||
"sneak.berlin/go/pixa/internal/config"
|
|
||||||
"sneak.berlin/go/pixa/internal/encurl"
|
|
||||||
"sneak.berlin/go/pixa/internal/session"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Form field names and a throwaway source image URL for the body-limit
|
|
||||||
// tests.
|
|
||||||
const (
|
|
||||||
sourceURLField = "url"
|
|
||||||
testSourceURL = "https://example.com/a.jpg"
|
|
||||||
)
|
|
||||||
|
|
||||||
// newBodyLimitTestRouter mirrors the production wiring for the form POST
|
|
||||||
// routes (see server.SetupRoutes): LimitBody sits in front of the CSRF
|
|
||||||
// middleware, which sits in front of the handlers. maxBytes is the body
|
|
||||||
// cap under test, so a test can trip the limit with a small body.
|
|
||||||
func newBodyLimitTestRouter(
|
|
||||||
t *testing.T, maxBytes int64,
|
|
||||||
) (*Handlers, http.Handler) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
cfg := &config.Config{SigningKey: testSigningKey, Debug: true}
|
|
||||||
|
|
||||||
sessMgr, err := session.NewManager(testSigningKey)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("session.NewManager() error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
encGen, err := encurl.NewGenerator(testSigningKey)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("encurl.NewGenerator() error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
protect, err := newCSRFProtect(testSigningKey, cfg.Debug)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("newCSRFProtect() error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
h := &Handlers{
|
|
||||||
log: slog.New(slog.DiscardHandler),
|
|
||||||
config: cfg,
|
|
||||||
sessMgr: sessMgr,
|
|
||||||
encGen: encGen,
|
|
||||||
csrfProtect: protect,
|
|
||||||
}
|
|
||||||
|
|
||||||
r := chi.NewRouter()
|
|
||||||
r.Group(func(r chi.Router) {
|
|
||||||
r.Use(h.LimitBody(maxBytes))
|
|
||||||
r.Use(h.CSRF())
|
|
||||||
r.Get("/", h.HandleRoot())
|
|
||||||
r.Post("/", h.HandleRoot())
|
|
||||||
r.Post("/generate", h.HandleGenerateURL())
|
|
||||||
})
|
|
||||||
|
|
||||||
return h, r
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestOversizedLoginPostRejectedBeforeCSRF is the core regression: an
|
|
||||||
// oversized POST / carrying an otherwise valid CSRF cookie and token must
|
|
||||||
// be rejected with 413. If the body limit ran after CSRF, the truncated
|
|
||||||
// body would read as a missing token and return 403; if it ran after the
|
|
||||||
// handler, a valid token would return 303. Getting 413 proves the limit
|
|
||||||
// fires before CSRF parses the form.
|
|
||||||
func TestOversizedLoginPostRejectedBeforeCSRF(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
_, srv := newBodyLimitTestRouter(t, 16)
|
|
||||||
|
|
||||||
cookies, token := csrfCredentials(t, srv, nil)
|
|
||||||
|
|
||||||
rec := postForm(srv, "/", cookies, url.Values{
|
|
||||||
loginKeyField: {testSigningKey},
|
|
||||||
csrfTokenField: {token},
|
|
||||||
})
|
|
||||||
|
|
||||||
if rec.Code != http.StatusRequestEntityTooLarge {
|
|
||||||
t.Errorf("oversized POST / status = %d, want %d",
|
|
||||||
rec.Code, http.StatusRequestEntityTooLarge)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestOversizedGeneratePostRejectedBeforeCSRF is the same regression for
|
|
||||||
// POST /generate, which also parses a form behind CSRF.
|
|
||||||
func TestOversizedGeneratePostRejectedBeforeCSRF(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
h, srv := newBodyLimitTestRouter(t, 16)
|
|
||||||
|
|
||||||
sessionCookie := newSessionCookie(t, h)
|
|
||||||
|
|
||||||
cookies, token := csrfCredentials(t, srv, []*http.Cookie{sessionCookie})
|
|
||||||
cookies = append(cookies, sessionCookie)
|
|
||||||
|
|
||||||
rec := postForm(srv, "/generate", cookies, url.Values{
|
|
||||||
sourceURLField: {testSourceURL},
|
|
||||||
csrfTokenField: {token},
|
|
||||||
})
|
|
||||||
|
|
||||||
if rec.Code != http.StatusRequestEntityTooLarge {
|
|
||||||
t.Errorf("oversized POST /generate status = %d, want %d",
|
|
||||||
rec.Code, http.StatusRequestEntityTooLarge)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestWithinLimitLoginPostSucceeds verifies the limit does not disturb a
|
|
||||||
// normal request: under the production cap, a valid login still parses and
|
|
||||||
// establishes a session (303). This guards against the body limit
|
|
||||||
// consuming or corrupting the form the CSRF check and handler depend on.
|
|
||||||
func TestWithinLimitLoginPostSucceeds(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
_, srv := newBodyLimitTestRouter(t, MaxFormBytes)
|
|
||||||
|
|
||||||
cookies, token := csrfCredentials(t, srv, nil)
|
|
||||||
|
|
||||||
rec := postForm(srv, "/", cookies, url.Values{
|
|
||||||
loginKeyField: {testSigningKey},
|
|
||||||
csrfTokenField: {token},
|
|
||||||
})
|
|
||||||
|
|
||||||
if rec.Code != http.StatusSeeOther {
|
|
||||||
t.Fatalf("within-limit POST / status = %d, want %d",
|
|
||||||
rec.Code, http.StatusSeeOther)
|
|
||||||
}
|
|
||||||
|
|
||||||
var authed bool
|
|
||||||
|
|
||||||
for _, c := range rec.Result().Cookies() {
|
|
||||||
if c.Name == session.CookieName && c.Value != "" {
|
|
||||||
authed = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if !authed {
|
|
||||||
t.Error("within-limit valid login did not set a session cookie")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestWithinLimitGeneratePostSucceeds is the same non-regression check for
|
|
||||||
// POST /generate.
|
|
||||||
func TestWithinLimitGeneratePostSucceeds(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
h, srv := newBodyLimitTestRouter(t, MaxFormBytes)
|
|
||||||
|
|
||||||
sessionCookie := newSessionCookie(t, h)
|
|
||||||
|
|
||||||
cookies, token := csrfCredentials(t, srv, []*http.Cookie{sessionCookie})
|
|
||||||
cookies = append(cookies, sessionCookie)
|
|
||||||
|
|
||||||
rec := postForm(srv, "/generate", cookies, url.Values{
|
|
||||||
sourceURLField: {testSourceURL},
|
|
||||||
"format": {"jpeg"},
|
|
||||||
csrfTokenField: {token},
|
|
||||||
})
|
|
||||||
|
|
||||||
if rec.Code != http.StatusOK {
|
|
||||||
t.Fatalf("within-limit POST /generate status = %d, want %d",
|
|
||||||
rec.Code, http.StatusOK)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !strings.Contains(rec.Body.String(), "/v1/e/") {
|
|
||||||
t.Error("within-limit generate response did not contain a generated URL")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,421 +0,0 @@
|
|||||||
package httpfetcher
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"net"
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"slices"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// testPublicHost is a TEST-NET-1 (RFC 5737) literal. isPrivateIP treats it as
|
|
||||||
// public, so validateURL and the redirect check accept it with no DNS lookup,
|
|
||||||
// while the recording dialer routes it to the local httptest server. The
|
|
||||||
// address is reserved for documentation and is never routed on the network.
|
|
||||||
const testPublicHost = "192.0.2.10"
|
|
||||||
|
|
||||||
// imagePayload is the body served by the fake upstream's image route.
|
|
||||||
const imagePayload = "fake-jpeg-bytes"
|
|
||||||
|
|
||||||
// errUnexpectedDial reports a dial to any host other than testPublicHost, which
|
|
||||||
// would mean SSRF protection let a forbidden target reach the transport.
|
|
||||||
var errUnexpectedDial = errors.New("unexpected dial target")
|
|
||||||
|
|
||||||
// upstreamURL builds a fetch URL on the fake public host for the given path.
|
|
||||||
func upstreamURL(path string) string {
|
|
||||||
return "http://" + testPublicHost + path
|
|
||||||
}
|
|
||||||
|
|
||||||
// recordingDialer records every address the transport asks it to dial and
|
|
||||||
// routes connections for testPublicHost to a real local server, so the SSRF
|
|
||||||
// checks run against a public-looking host while bytes go to httptest.
|
|
||||||
type recordingDialer struct {
|
|
||||||
target string
|
|
||||||
|
|
||||||
mu sync.Mutex
|
|
||||||
dialed []string
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *recordingDialer) dialContext(
|
|
||||||
ctx context.Context,
|
|
||||||
network, addr string,
|
|
||||||
) (net.Conn, error) {
|
|
||||||
d.mu.Lock()
|
|
||||||
d.dialed = append(d.dialed, addr)
|
|
||||||
d.mu.Unlock()
|
|
||||||
|
|
||||||
host, _, err := net.SplitHostPort(addr)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if host != testPublicHost {
|
|
||||||
return nil, fmt.Errorf("%w: %s", errUnexpectedDial, addr)
|
|
||||||
}
|
|
||||||
|
|
||||||
var dialer net.Dialer
|
|
||||||
|
|
||||||
return dialer.DialContext(ctx, network, d.target)
|
|
||||||
}
|
|
||||||
|
|
||||||
// dialedAddrs returns a copy of the addresses the dialer was asked to reach.
|
|
||||||
func (d *recordingDialer) dialedAddrs() []string {
|
|
||||||
d.mu.Lock()
|
|
||||||
defer d.mu.Unlock()
|
|
||||||
|
|
||||||
return slices.Clone(d.dialed)
|
|
||||||
}
|
|
||||||
|
|
||||||
// startUpstream launches a fake upstream with the routes the fetch tests
|
|
||||||
// exercise and stops it when the test finishes.
|
|
||||||
func startUpstream(t *testing.T) *httptest.Server {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
mux := http.NewServeMux()
|
|
||||||
mux.HandleFunc("/image", func(w http.ResponseWriter, _ *http.Request) {
|
|
||||||
w.Header().Set("Content-Type", contentTypeJPEG)
|
|
||||||
_, _ = io.WriteString(w, imagePayload)
|
|
||||||
})
|
|
||||||
mux.HandleFunc("/status/500", func(w http.ResponseWriter, _ *http.Request) {
|
|
||||||
w.WriteHeader(http.StatusInternalServerError)
|
|
||||||
})
|
|
||||||
mux.HandleFunc("/html", func(w http.ResponseWriter, _ *http.Request) {
|
|
||||||
w.Header().Set("Content-Type", "text/html; charset=utf-8")
|
|
||||||
_, _ = io.WriteString(w, "<html></html>")
|
|
||||||
})
|
|
||||||
mux.HandleFunc("/redirect/private", func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
http.Redirect(w, r, "http://169.254.169.254/latest/meta-data/", http.StatusFound)
|
|
||||||
})
|
|
||||||
mux.HandleFunc("/redirect/public", func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
http.Redirect(w, r, "/image", http.StatusFound)
|
|
||||||
})
|
|
||||||
mux.HandleFunc("/redirect/chain", func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
http.Redirect(w, r, "/redirect/hop", http.StatusFound)
|
|
||||||
})
|
|
||||||
mux.HandleFunc("/redirect/hop", func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
http.Redirect(w, r, "/image", http.StatusFound)
|
|
||||||
})
|
|
||||||
|
|
||||||
srv := httptest.NewServer(mux)
|
|
||||||
t.Cleanup(srv.Close)
|
|
||||||
|
|
||||||
return srv
|
|
||||||
}
|
|
||||||
|
|
||||||
// newServerFetcher builds a fetcher whose transport routes testPublicHost to
|
|
||||||
// srv, leaving the real SSRF validation and redirect checks in place.
|
|
||||||
func newServerFetcher(
|
|
||||||
t *testing.T,
|
|
||||||
srv *httptest.Server,
|
|
||||||
cfg *Config,
|
|
||||||
) (*HTTPFetcher, *recordingDialer) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
if cfg == nil {
|
|
||||||
cfg = DefaultConfig()
|
|
||||||
}
|
|
||||||
|
|
||||||
cfg.AllowHTTP = true
|
|
||||||
|
|
||||||
f := New(cfg)
|
|
||||||
|
|
||||||
transport, ok := f.client.Transport.(*http.Transport)
|
|
||||||
if !ok {
|
|
||||||
t.Fatalf("transport is %T, want *http.Transport", f.client.Transport)
|
|
||||||
}
|
|
||||||
|
|
||||||
dialer := &recordingDialer{target: srv.Listener.Addr().String()}
|
|
||||||
transport.DialContext = dialer.dialContext
|
|
||||||
|
|
||||||
return f, dialer
|
|
||||||
}
|
|
||||||
|
|
||||||
// testContext returns a context cancelled when the test ends, bounding any
|
|
||||||
// fetch that would otherwise block on a leaked semaphore slot.
|
|
||||||
func testContext(t *testing.T) context.Context {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
|
||||||
t.Cleanup(cancel)
|
|
||||||
|
|
||||||
return ctx
|
|
||||||
}
|
|
||||||
|
|
||||||
// fetchImage fetches path from the fake upstream and fails on error.
|
|
||||||
func fetchImage(t *testing.T, f *HTTPFetcher, path string) *FetchResult {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
res, err := f.Fetch(testContext(t), upstreamURL(path))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Fetch(%s) error = %v", path, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return res
|
|
||||||
}
|
|
||||||
|
|
||||||
// fetchExpectError fetches path and fails unless Fetch returns an error.
|
|
||||||
func fetchExpectError(t *testing.T, f *HTTPFetcher, path string) error {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
res, err := f.Fetch(testContext(t), upstreamURL(path))
|
|
||||||
if err == nil {
|
|
||||||
_ = res.Content.Close()
|
|
||||||
|
|
||||||
t.Fatalf("Fetch(%s) = nil error, want an error", path)
|
|
||||||
}
|
|
||||||
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// fetchBody fetches path and returns the fully read, closed response body.
|
|
||||||
func fetchBody(t *testing.T, f *HTTPFetcher, path string) string {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
res := fetchImage(t, f, path)
|
|
||||||
defer func() { _ = res.Content.Close() }()
|
|
||||||
|
|
||||||
data, err := io.ReadAll(res.Content)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("read body: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return string(data)
|
|
||||||
}
|
|
||||||
|
|
||||||
// semLen reports how many per-host semaphore slots are currently held.
|
|
||||||
func semLen(f *HTTPFetcher, host string) int {
|
|
||||||
return len(f.getHostSemaphore(host))
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestFetchRedirectToPrivateIPBlocked(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
srv := startUpstream(t)
|
|
||||||
f, dialer := newServerFetcher(t, srv, nil)
|
|
||||||
|
|
||||||
_, err := f.Fetch(testContext(t), upstreamURL("/redirect/private"))
|
|
||||||
if !errors.Is(err, ErrSSRFBlocked) {
|
|
||||||
t.Fatalf("Fetch() error = %v, want ErrSSRFBlocked", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, addr := range dialer.dialedAddrs() {
|
|
||||||
if strings.Contains(addr, "169.254.169.254") {
|
|
||||||
t.Errorf("dialer connected to the private redirect target: %s", addr)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestFetchRedirectToPublicSucceeds(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
srv := startUpstream(t)
|
|
||||||
f, _ := newServerFetcher(t, srv, nil)
|
|
||||||
|
|
||||||
if body := fetchBody(t, f, "/redirect/public"); body != imagePayload {
|
|
||||||
t.Errorf("body = %q, want %q", body, imagePayload)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestFetchRedirectChainSucceeds(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
srv := startUpstream(t)
|
|
||||||
f, _ := newServerFetcher(t, srv, nil)
|
|
||||||
|
|
||||||
if body := fetchBody(t, f, "/redirect/chain"); body != imagePayload {
|
|
||||||
t.Errorf("body = %q, want %q", body, imagePayload)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestFetchRejectsNon2xx(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
srv := startUpstream(t)
|
|
||||||
f, _ := newServerFetcher(t, srv, nil)
|
|
||||||
|
|
||||||
err := fetchExpectError(t, f, "/status/500")
|
|
||||||
if !errors.Is(err, ErrUpstreamError) {
|
|
||||||
t.Fatalf("Fetch() error = %v, want ErrUpstreamError", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestFetchRejectsDisallowedContentType(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
srv := startUpstream(t)
|
|
||||||
f, _ := newServerFetcher(t, srv, nil)
|
|
||||||
|
|
||||||
err := fetchExpectError(t, f, "/html")
|
|
||||||
if !errors.Is(err, ErrInvalidContentType) {
|
|
||||||
t.Fatalf("Fetch() error = %v, want ErrInvalidContentType", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestFetchMaxResponseSizeEnforced(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
srv := startUpstream(t)
|
|
||||||
|
|
||||||
cfg := DefaultConfig()
|
|
||||||
cfg.MaxResponseSize = 8
|
|
||||||
|
|
||||||
f, _ := newServerFetcher(t, srv, cfg)
|
|
||||||
|
|
||||||
res := fetchImage(t, f, "/image")
|
|
||||||
defer func() { _ = res.Content.Close() }()
|
|
||||||
|
|
||||||
data, err := io.ReadAll(res.Content)
|
|
||||||
if !errors.Is(err, ErrResponseTooLarge) {
|
|
||||||
t.Fatalf("read error = %v, want ErrResponseTooLarge", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if int64(len(data)) > cfg.MaxResponseSize {
|
|
||||||
t.Errorf("read %d bytes, exceeds limit %d", len(data), cfg.MaxResponseSize)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestFetchSemaphoreReleasedOnError(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
srv := startUpstream(t)
|
|
||||||
|
|
||||||
cfg := DefaultConfig()
|
|
||||||
cfg.MaxConnectionsPerHost = 1
|
|
||||||
|
|
||||||
f, _ := newServerFetcher(t, srv, cfg)
|
|
||||||
|
|
||||||
err := fetchExpectError(t, f, "/status/500")
|
|
||||||
if !errors.Is(err, ErrUpstreamError) {
|
|
||||||
t.Fatalf("Fetch() error = %v, want ErrUpstreamError", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if held := semLen(f, testPublicHost); held != 0 {
|
|
||||||
t.Fatalf("semaphore slot leaked after error: %d held", held)
|
|
||||||
}
|
|
||||||
|
|
||||||
// One slot per host: this fetch proceeds only if the slot was released.
|
|
||||||
res := fetchImage(t, f, "/image")
|
|
||||||
_ = res.Content.Close()
|
|
||||||
}
|
|
||||||
|
|
||||||
// assertSlotReleasedByClose fetches an image over a one-slot host, hands the
|
|
||||||
// open result to consume, and asserts the slot is held before and freed after,
|
|
||||||
// then that a follow-up fetch can still acquire it.
|
|
||||||
func assertSlotReleasedByClose(
|
|
||||||
t *testing.T,
|
|
||||||
consume func(*testing.T, *FetchResult),
|
|
||||||
) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
srv := startUpstream(t)
|
|
||||||
|
|
||||||
cfg := DefaultConfig()
|
|
||||||
cfg.MaxConnectionsPerHost = 1
|
|
||||||
|
|
||||||
f, _ := newServerFetcher(t, srv, cfg)
|
|
||||||
|
|
||||||
res := fetchImage(t, f, "/image")
|
|
||||||
if held := semLen(f, testPublicHost); held != 1 {
|
|
||||||
t.Fatalf("slot not held while body is open: %d held", held)
|
|
||||||
}
|
|
||||||
|
|
||||||
consume(t, res)
|
|
||||||
|
|
||||||
if held := semLen(f, testPublicHost); held != 0 {
|
|
||||||
t.Fatalf("slot not released after close: %d held", held)
|
|
||||||
}
|
|
||||||
|
|
||||||
next := fetchImage(t, f, "/image")
|
|
||||||
_ = next.Content.Close()
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestFetchSemaphoreReleasedOnBodyClose(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
assertSlotReleasedByClose(t, func(t *testing.T, res *FetchResult) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
_, err := io.ReadAll(res.Content)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("read body: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = res.Content.Close()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("close body: %v", err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestFetchSemaphoreReleasedOnPartialReadClose(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
assertSlotReleasedByClose(t, func(t *testing.T, res *FetchResult) {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
buf := make([]byte, 1)
|
|
||||||
|
|
||||||
_, err := res.Content.Read(buf)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("partial read: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = res.Content.Close()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("close body: %v", err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// The dial-time re-resolution in ssrfSafeDialer is what closes the DNS
|
|
||||||
// rebinding window: even if validateURL saw a public answer earlier, the
|
|
||||||
// dialer independently re-checks the address it is about to connect to. A full
|
|
||||||
// rebinding simulation (a resolver returning public, then private) would mean
|
|
||||||
// replacing the global net.DefaultResolver with a fake DNS server, which is
|
|
||||||
// heavyweight and unsafe to mutate under parallel -race tests. The property is
|
|
||||||
// proven directly here instead: the dialer rejects a private target outright,
|
|
||||||
// which is exactly the check that fires when a validated host later resolves
|
|
||||||
// to a private address.
|
|
||||||
func TestSSRFSafeDialerBlocksPrivateTarget(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
for _, addr := range []string{
|
|
||||||
"169.254.169.254:80", // link-local (cloud metadata)
|
|
||||||
"127.0.0.1:80", // loopback
|
|
||||||
"10.0.0.5:80", // RFC 1918 private
|
|
||||||
} {
|
|
||||||
t.Run(addr, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
_, err := ssrfSafeDialer(context.Background(), "tcp", addr)
|
|
||||||
if !errors.Is(err, ErrSSRFBlocked) {
|
|
||||||
t.Errorf("ssrfSafeDialer(%q) = %v, want ErrSSRFBlocked", addr, err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestSSRFSafeDialerAllowsPublicTarget(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
// A cancelled context makes the dial fail immediately without touching the
|
|
||||||
// network; the point is only that a public literal is not SSRF-blocked.
|
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
|
||||||
cancel()
|
|
||||||
|
|
||||||
_, err := ssrfSafeDialer(ctx, "tcp", testPublicHost+":80")
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected a dial error for an unreachable public target")
|
|
||||||
}
|
|
||||||
|
|
||||||
if errors.Is(err, ErrSSRFBlocked) {
|
|
||||||
t.Errorf("public target was SSRF-blocked: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -21,33 +21,6 @@ import (
|
|||||||
// CORSMaxAgeSeconds is the max age for CORS preflight cache (24 hours).
|
// CORSMaxAgeSeconds is the max age for CORS preflight cache (24 hours).
|
||||||
const CORSMaxAgeSeconds = 86400
|
const CORSMaxAgeSeconds = 86400
|
||||||
|
|
||||||
// HSTSValue is the Strict-Transport-Security header value: one year with
|
|
||||||
// includeSubDomains. Emitted unconditionally even though pixa listens plain
|
|
||||||
// HTTP behind a TLS-terminating proxy; browsers ignore an HSTS header received
|
|
||||||
// over plaintext (RFC 6797 section 8.1), so it never lies about the connection,
|
|
||||||
// and emitting it here avoids trusting a forwarded-proto header.
|
|
||||||
const HSTSValue = "max-age=31536000; includeSubDomains"
|
|
||||||
|
|
||||||
// ContentSecurityPolicyValue is the Content-Security-Policy header value.
|
|
||||||
// default-src 'self' is the baseline and frame-ancestors 'none' is the primary
|
|
||||||
// clickjacking control. 'unsafe-inline' is required in script-src and style-src
|
|
||||||
// because the served templates carry inline onclick handlers (generator page)
|
|
||||||
// and the bundled Tailwind asset injects a runtime <style> element; dropping it
|
|
||||||
// needs template changes outside this issue's scope.
|
|
||||||
const ContentSecurityPolicyValue = "default-src 'self'; " +
|
|
||||||
"script-src 'self' 'unsafe-inline'; " +
|
|
||||||
"style-src 'self' 'unsafe-inline'; " +
|
|
||||||
"object-src 'none'; " +
|
|
||||||
"base-uri 'self'; " +
|
|
||||||
"form-action 'self'; " +
|
|
||||||
"frame-ancestors 'none'"
|
|
||||||
|
|
||||||
// PermissionsPolicyValue is the Permissions-Policy header value. Every listed
|
|
||||||
// feature is denied because pixa uses none of them.
|
|
||||||
const PermissionsPolicyValue = "accelerometer=(), autoplay=(), camera=(), " +
|
|
||||||
"display-capture=(), geolocation=(), gyroscope=(), magnetometer=(), " +
|
|
||||||
"microphone=(), payment=(), usb=()"
|
|
||||||
|
|
||||||
// Params defines dependencies for Middleware.
|
// Params defines dependencies for Middleware.
|
||||||
type Params struct {
|
type Params struct {
|
||||||
fx.In
|
fx.In
|
||||||
@@ -191,16 +164,6 @@ func (s *Middleware) SecurityHeaders() func(http.Handler) http.Handler {
|
|||||||
// Disable XSS filtering (modern browsers don't need it, can cause issues)
|
// Disable XSS filtering (modern browsers don't need it, can cause issues)
|
||||||
w.Header().Set("X-XSS-Protection", "0")
|
w.Header().Set("X-XSS-Protection", "0")
|
||||||
|
|
||||||
// Force HTTPS on future visits (ignored by browsers over plaintext)
|
|
||||||
w.Header().Set("Strict-Transport-Security", HSTSValue)
|
|
||||||
|
|
||||||
// Restrict content sources; frame-ancestors is the primary
|
|
||||||
// clickjacking control, X-Frame-Options the legacy fallback
|
|
||||||
w.Header().Set("Content-Security-Policy", ContentSecurityPolicyValue)
|
|
||||||
|
|
||||||
// Deny browser features pixa does not use
|
|
||||||
w.Header().Set("Permissions-Policy", PermissionsPolicyValue)
|
|
||||||
|
|
||||||
next.ServeHTTP(w, r)
|
next.ServeHTTP(w, r)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -56,61 +56,6 @@ func TestSecurityHeaders(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSecurityHeaders_PolicyHeaders(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
cfg := &config.Config{}
|
|
||||||
mw := &Middleware{
|
|
||||||
log: slog.Default(),
|
|
||||||
config: cfg,
|
|
||||||
}
|
|
||||||
|
|
||||||
testHandler := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
})
|
|
||||||
|
|
||||||
handler := mw.SecurityHeaders()(testHandler)
|
|
||||||
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(), http.MethodGet, "/test", nil)
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
|
|
||||||
handler.ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
header string
|
|
||||||
want string
|
|
||||||
}{
|
|
||||||
{"Strict-Transport-Security", "max-age=31536000; includeSubDomains"},
|
|
||||||
{
|
|
||||||
"Content-Security-Policy",
|
|
||||||
"default-src 'self'; " +
|
|
||||||
"script-src 'self' 'unsafe-inline'; " +
|
|
||||||
"style-src 'self' 'unsafe-inline'; " +
|
|
||||||
"object-src 'none'; " +
|
|
||||||
"base-uri 'self'; " +
|
|
||||||
"form-action 'self'; " +
|
|
||||||
"frame-ancestors 'none'",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"Permissions-Policy",
|
|
||||||
"accelerometer=(), autoplay=(), camera=(), " +
|
|
||||||
"display-capture=(), geolocation=(), gyroscope=(), " +
|
|
||||||
"magnetometer=(), microphone=(), payment=(), usb=()",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tt := range tests {
|
|
||||||
t.Run(tt.header, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
got := rec.Header().Get(tt.header)
|
|
||||||
if got != tt.want {
|
|
||||||
t.Errorf("%s = %q, want %q", tt.header, got, tt.want)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestSecurityHeaders_PreservesExistingHeaders(t *testing.T) {
|
func TestSecurityHeaders_PreservesExistingHeaders(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
|
|||||||
+11
-27
@@ -9,40 +9,24 @@ import (
|
|||||||
|
|
||||||
// HTTP server configuration constants.
|
// HTTP server configuration constants.
|
||||||
const (
|
const (
|
||||||
HTTPReadTimeout = 30 * time.Second
|
HTTPReadTimeout = 30 * time.Second
|
||||||
// HTTPReadHeaderTimeout bounds the request-header read on its own,
|
HTTPWriteTimeout = 60 * time.Second
|
||||||
// short, so a slowloris client dribbling headers is dropped well
|
|
||||||
// before it ties up a connection for the whole ReadTimeout window.
|
|
||||||
HTTPReadHeaderTimeout = 10 * time.Second
|
|
||||||
HTTPWriteTimeout = 60 * time.Second
|
|
||||||
// HTTPIdleTimeout bounds how long an idle keep-alive connection is
|
|
||||||
// held open, so idle connections cannot accumulate without limit on a
|
|
||||||
// service targeting high concurrency.
|
|
||||||
HTTPIdleTimeout = 120 * time.Second
|
|
||||||
HTTPMaxHeaderBytes = 8 << 10 // 8KB
|
HTTPMaxHeaderBytes = 8 << 10 // 8KB
|
||||||
)
|
)
|
||||||
|
|
||||||
// newHTTPServer builds the http.Server with the hardening timeouts and
|
|
||||||
// limits applied. It is separate from serveUntilShutdown so the
|
|
||||||
// configuration can be asserted in a test without binding a listener.
|
|
||||||
func (s *Server) newHTTPServer() *http.Server {
|
|
||||||
return &http.Server{
|
|
||||||
Addr: fmt.Sprintf(":%d", s.config.Port),
|
|
||||||
ReadTimeout: HTTPReadTimeout,
|
|
||||||
ReadHeaderTimeout: HTTPReadHeaderTimeout,
|
|
||||||
WriteTimeout: HTTPWriteTimeout,
|
|
||||||
IdleTimeout: HTTPIdleTimeout,
|
|
||||||
MaxHeaderBytes: HTTPMaxHeaderBytes,
|
|
||||||
Handler: s,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *Server) serveUntilShutdown() {
|
func (s *Server) serveUntilShutdown() {
|
||||||
s.httpServer = s.newHTTPServer()
|
listenAddr := fmt.Sprintf(":%d", s.config.Port)
|
||||||
|
s.httpServer = &http.Server{
|
||||||
|
Addr: listenAddr,
|
||||||
|
ReadTimeout: HTTPReadTimeout,
|
||||||
|
WriteTimeout: HTTPWriteTimeout,
|
||||||
|
MaxHeaderBytes: HTTPMaxHeaderBytes,
|
||||||
|
Handler: s,
|
||||||
|
}
|
||||||
|
|
||||||
s.SetupRoutes()
|
s.SetupRoutes()
|
||||||
|
|
||||||
s.log.Info("http begin listen", "listenaddr", s.httpServer.Addr)
|
s.log.Info("http begin listen", "listenaddr", listenAddr)
|
||||||
|
|
||||||
err := s.httpServer.ListenAndServe()
|
err := s.httpServer.ListenAndServe()
|
||||||
if err != nil && !errors.Is(err, http.ErrServerClosed) {
|
if err != nil && !errors.Is(err, http.ErrServerClosed) {
|
||||||
|
|||||||
@@ -1,65 +0,0 @@
|
|||||||
package server
|
|
||||||
|
|
||||||
import (
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"sneak.berlin/go/pixa/internal/config"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestNewHTTPServerTimeouts verifies that the constructed http.Server
|
|
||||||
// carries every hardening timeout wired onto it, including the slowloris
|
|
||||||
// defense (ReadHeaderTimeout) and the keep-alive bound (IdleTimeout). This
|
|
||||||
// guards against a field being defined but never set on the server, so
|
|
||||||
// each assertion compares the server field to its constant.
|
|
||||||
func TestNewHTTPServerTimeouts(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
s := &Server{config: &config.Config{Port: 8080}}
|
|
||||||
|
|
||||||
srv := s.newHTTPServer()
|
|
||||||
|
|
||||||
fields := []struct {
|
|
||||||
name string
|
|
||||||
got time.Duration
|
|
||||||
want time.Duration
|
|
||||||
}{
|
|
||||||
{"ReadTimeout", srv.ReadTimeout, HTTPReadTimeout},
|
|
||||||
{"ReadHeaderTimeout", srv.ReadHeaderTimeout, HTTPReadHeaderTimeout},
|
|
||||||
{"WriteTimeout", srv.WriteTimeout, HTTPWriteTimeout},
|
|
||||||
{"IdleTimeout", srv.IdleTimeout, HTTPIdleTimeout},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, f := range fields {
|
|
||||||
if f.got != f.want {
|
|
||||||
t.Errorf("%s = %v, want %v", f.name, f.got, f.want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if srv.MaxHeaderBytes != HTTPMaxHeaderBytes {
|
|
||||||
t.Errorf("MaxHeaderBytes = %d, want %d",
|
|
||||||
srv.MaxHeaderBytes, HTTPMaxHeaderBytes)
|
|
||||||
}
|
|
||||||
|
|
||||||
if srv.Handler != s {
|
|
||||||
t.Error("Handler is not the server")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestHardeningTimeoutValues pins the intent behind the two new timeouts
|
|
||||||
// without hard-coding brittle exact durations: the header-read phase is
|
|
||||||
// bounded strictly shorter than the whole-request read (the slowloris
|
|
||||||
// dribble), and idle keep-alive connections are bounded rather than held
|
|
||||||
// open forever.
|
|
||||||
func TestHardeningTimeoutValues(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
if HTTPReadHeaderTimeout <= 0 || HTTPReadHeaderTimeout > HTTPReadTimeout {
|
|
||||||
t.Errorf("ReadHeaderTimeout = %v, want positive and <= ReadTimeout %v",
|
|
||||||
HTTPReadHeaderTimeout, HTTPReadTimeout)
|
|
||||||
}
|
|
||||||
|
|
||||||
if HTTPIdleTimeout <= 0 {
|
|
||||||
t.Errorf("IdleTimeout = %v, want positive bound", HTTPIdleTimeout)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -8,7 +8,6 @@ import (
|
|||||||
"github.com/go-chi/chi/v5/middleware"
|
"github.com/go-chi/chi/v5/middleware"
|
||||||
"github.com/prometheus/client_golang/prometheus/promhttp"
|
"github.com/prometheus/client_golang/prometheus/promhttp"
|
||||||
|
|
||||||
"sneak.berlin/go/pixa/internal/handlers"
|
|
||||||
"sneak.berlin/go/pixa/internal/static"
|
"sneak.berlin/go/pixa/internal/static"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -47,10 +46,8 @@ func (s *Server) SetupRoutes() {
|
|||||||
|
|
||||||
// Login/generator UI. The form routes carry CSRF protection; the
|
// Login/generator UI. The form routes carry CSRF protection; the
|
||||||
// token cookie is independent of the session cookie, so it also
|
// token cookie is independent of the session cookie, so it also
|
||||||
// covers the login POST, where no session exists yet. LimitBody caps
|
// covers the login POST, where no session exists yet.
|
||||||
// the POST body ahead of CSRF, which reads its token from that body.
|
|
||||||
s.router.Group(func(r chi.Router) {
|
s.router.Group(func(r chi.Router) {
|
||||||
r.Use(s.h.LimitBody(handlers.MaxFormBytes))
|
|
||||||
r.Use(s.h.CSRF())
|
r.Use(s.h.CSRF())
|
||||||
r.Get("/", s.h.HandleRoot())
|
r.Get("/", s.h.HandleRoot())
|
||||||
r.Post("/", s.h.HandleRoot())
|
r.Post("/", s.h.HandleRoot())
|
||||||
|
|||||||
+14
-46
@@ -1,55 +1,23 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/lint: run golangci-lint over the whole tree.
|
# script/lint: run the linter. CGO dependencies (pkg-config, vips,
|
||||||
#
|
# libheif) come from nix-shell when not already available (e.g. inside
|
||||||
# The linter is never installed on the host: it runs only inside the
|
# a Docker build or an existing nix-shell).
|
||||||
# Dockerfile.lint build, one way, everywhere. A clean build is a clean
|
|
||||||
# lint. See Dockerfile.lint for why the lint step cannot be cached.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
main() {
|
run_with_cgo_deps() {
|
||||||
cd "$ROOT"
|
if command -v pkg-config >/dev/null 2>&1; then
|
||||||
|
sh -c "$1"
|
||||||
# A value no other run repeats. Dockerfile.lint folds it into the
|
else
|
||||||
# lint step's cache key, so the linter re-executes every run instead
|
nix-shell -p pkg-config vips libheif golangci-lint git --run "$1"
|
||||||
# of an unchanged tree returning a cached success having linted
|
|
||||||
# nothing.
|
|
||||||
cachebust="$(date +%s)-$$"
|
|
||||||
|
|
||||||
tmp="$(mktemp -d "${TMPDIR:-/tmp}/pixa-lint.XXXXXX")"
|
|
||||||
trap 'rm -rf "$tmp"' EXIT INT TERM
|
|
||||||
|
|
||||||
# --progress=plain so the lint step's own output reaches the log we
|
|
||||||
# check below; --output=type=cacheonly because we want the linter's
|
|
||||||
# verdict, not an image left in the local store. The build status
|
|
||||||
# travels through a file: a pipeline's exit status is tee's, not the
|
|
||||||
# build's.
|
|
||||||
(
|
|
||||||
set +e
|
|
||||||
docker build \
|
|
||||||
--progress=plain \
|
|
||||||
--build-arg CACHEBUST="$cachebust" \
|
|
||||||
--output=type=cacheonly \
|
|
||||||
-f Dockerfile.lint . 2>&1
|
|
||||||
echo "$?" >"$tmp/status"
|
|
||||||
) | tee "$tmp/build.log"
|
|
||||||
|
|
||||||
status="$(cat "$tmp/status" 2>/dev/null || echo 1)"
|
|
||||||
[ "${status:-1}" -eq 0 ] || exit "${status:-1}"
|
|
||||||
|
|
||||||
# The linter's start line must appear as build output, not only in
|
|
||||||
# the build's echo of the RUN instruction. A step served from cache
|
|
||||||
# prints the instruction and none of its output; a step that runs
|
|
||||||
# prints a "#<n> <elapsed> ..." output line. Requiring that output
|
|
||||||
# line means a future edit dropping the CACHEBUST reference from
|
|
||||||
# Dockerfile.lint fails here rather than passing having linted
|
|
||||||
# nothing.
|
|
||||||
if ! grep -Eq '^#[0-9]+ +[0-9]+\.[0-9]+ +pixa-lint: running golangci-lint' \
|
|
||||||
"$tmp/build.log"; then
|
|
||||||
echo "script/lint: golangci-lint did not execute (cached step?)." >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
|
main() {
|
||||||
|
cd "$ROOT"
|
||||||
|
echo "Running linter..."
|
||||||
|
run_with_cgo_deps "golangci-lint run"
|
||||||
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
+1
-5
@@ -17,11 +17,7 @@ run_with_cgo_deps() {
|
|||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
echo "Running tests..."
|
echo "Running tests..."
|
||||||
# Run without -v first for clean output on success; on failure rerun
|
run_with_cgo_deps "CGO_ENABLED=1 go test -timeout 30s -race -v ./..."
|
||||||
# with -v for full diagnostics, then exit non-zero (REPO_POLICIES.md
|
|
||||||
# conditional-verbose-rerun pattern). The first run already proved the
|
|
||||||
# tests broken, so the build fails even if the rerun happens to pass.
|
|
||||||
run_with_cgo_deps "CGO_ENABLED=1 go test -timeout 30s -race -cover ./... || { echo '--- Rerunning with -v for details ---'; CGO_ENABLED=1 go test -timeout 30s -race -v ./...; exit 1; }"
|
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
Reference in New Issue
Block a user