Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
37cf543439 |
No files matched your search
@@ -71,8 +71,7 @@ The state directory (`state_dir`, `/var/lib/pixa` in the container) holds the
|
|||||||
database and the disk cache:
|
database and the disk cache:
|
||||||
|
|
||||||
- It needs a persistent volume: without one, every restart starts with an empty
|
- It needs a persistent volume: without one, every restart starts with an empty
|
||||||
cache. Losing the directory also ends every login session (see Encrypted
|
cache. In the container, the startup script gives the directory to the user
|
||||||
URLs). In the container, the startup script gives the directory to the user
|
|
||||||
pixa runs as (uid 65532) and sets its mode to `750`; outside it, that user
|
pixa runs as (uid 65532) and sets its mode to `750`; outside it, that user
|
||||||
must be able to write the directory.
|
must be able to write the directory.
|
||||||
- `cache_max_bytes` limits the source and transformed images together. The
|
- `cache_max_bytes` limits the source and transformed images together. The
|
||||||
@@ -197,11 +196,7 @@ path under `/v1/` answers 200, in maintenance mode too.
|
|||||||
session it answers 303 to `/`. Answers: 200 with the page showing the URL; 400
|
session it answers 303 to `/`. Answers: 200 with the page showing the URL; 400
|
||||||
with the page naming a field that is not valid; 500 when the URL cannot be
|
with the page naming a field that is not valid; 500 when the URL cannot be
|
||||||
made.
|
made.
|
||||||
- `POST /logout` — log out with the generator page's Logout button: end every
|
- `GET /logout` — end the login session. Needs: nothing. Answers: 303 to `/`.
|
||||||
login session, in every browser (see Encrypted URLs), and remove the session
|
|
||||||
cookie. Needs: a login session and the generator page's form (below); without
|
|
||||||
a login session it only removes the cookie. Answers: 303 to `/`; 500 when the
|
|
||||||
logout cannot be saved in the database.
|
|
||||||
- `GET` or `HEAD` `/v1/image/<host>/<path>/<size>.<format>`, or
|
- `GET` or `HEAD` `/v1/image/<host>/<path>/<size>.<format>`, or
|
||||||
`/v1/image/<host>/<path>/<size>` with no format — an image, fetched, resized
|
`/v1/image/<host>/<path>/<size>` with no format — an image, fetched, resized
|
||||||
and converted (below). Needs: a signature, unless the host is allowlisted (see
|
and converted (below). Needs: a signature, unless the host is allowlisted (see
|
||||||
@@ -249,7 +244,7 @@ the request carries the same ID as `request_id`, and so do the lines it logs
|
|||||||
when it fetches, converts and serves an image; the fetch sends it to the
|
when it fetches, converts and serves an image; the fetch sends it to the
|
||||||
upstream host as `X-Request-ID`.
|
upstream host as `X-Request-ID`.
|
||||||
|
|
||||||
The `POST` routes accept only a form that pixa's own page served: the page puts
|
Both `POST` routes accept only a form that pixa's own page served: the page puts
|
||||||
a token in the form and sets a cookie to match, and a request without both is
|
a token in the form and sets a cookie to match, and a request without both is
|
||||||
refused with 403, so another site cannot submit the form from a visitor's
|
refused with 403, so another site cannot submit the form from a visitor's
|
||||||
browser. The login and generator pages are meant to be opened over HTTPS: while
|
browser. The login and generator pages are meant to be opened over HTTPS: while
|
||||||
@@ -294,12 +289,6 @@ either side may be; so is a size with `fit=outside`, which scales the image to
|
|||||||
cover the size and so past it on one side, when that side would come out
|
cover the size and so past it on one side, when that side would come out
|
||||||
above 8192.
|
above 8192.
|
||||||
|
|
||||||
An AVIF image of more than 16,777,216 pixels, the number 4096x4096 and 8192x2048
|
|
||||||
have, is refused with 400 before anything is decoded, as its encode could take
|
|
||||||
more than 40 seconds (see below). That includes `orig` of an AVIF source, and
|
|
||||||
`auto` when it chooses AVIF, so a client whose `Accept` names `image/avif` but
|
|
||||||
not `image/jxl` is refused such a size.
|
|
||||||
|
|
||||||
The source image may be JPEG, PNG, GIF, WebP, AVIF or JPEG XL. The upstream's
|
The source image may be JPEG, PNG, GIF, WebP, AVIF or JPEG XL. The upstream's
|
||||||
`Content-Type` must name its format, and the image's first bytes must match it.
|
`Content-Type` must name its format, and the image's first bytes must match it.
|
||||||
An upstream answering with any other `Content-Type`, SVG included, is refused
|
An upstream answering with any other `Content-Type`, SVG included, is refused
|
||||||
@@ -349,17 +338,14 @@ transcode that stops this way is answered 503 with the error
|
|||||||
ended. govips gives pixa no way to stop libvips once an encode has begun, so an
|
ended. govips gives pixa no way to stop libvips once an encode has begun, so an
|
||||||
encode keeps its slot until it finishes, which can be after
|
encode keeps its slot until it finishes, which can be after
|
||||||
`downstream_timeout`. The limit of 8192 on each side of the source and of the
|
`downstream_timeout`. The limit of 8192 on each side of the source and of the
|
||||||
output, and for AVIF the limit of 16,777,216 pixels, bound how long that takes.
|
output bounds how long that takes. With one libvips thread, as pixad runs it,
|
||||||
With one libvips thread, as pixad runs it, encoding 8192x8192 random pixels
|
encoding 8192x8192 random pixels takes up to about 1 second as JPEG, 15 as PNG,
|
||||||
takes up to about 1 second as JPEG, 15 as PNG and 16 as GIF, the slowest of 8 or
|
16 as GIF, 63 as WebP, 110 as AVIF and 96 as JPEG XL, the slowest of 8 or 16
|
||||||
16 bits per sample, with or without an alpha channel. The WebP and JPEG XL
|
bits per sample, with or without an alpha channel. WebP, AVIF and JPEG XL are
|
||||||
encoders run below libvips' default effort, and AVIF at the lowest effort govips
|
that slow only with an alpha channel: 8-bit RGB takes about 44, 53 and 28
|
||||||
can set, so that no encode takes more than 40 seconds of the default
|
seconds. Decoding such a source adds up to about 11 seconds. A WebP, AVIF or
|
||||||
`downstream_timeout` of 60: at quality 85 or 100 and 8 or 16 bits per sample,
|
JPEG XL encode can therefore hold its slot past the default `downstream_timeout`
|
||||||
8192x8192 random pixels with an alpha channel take up to about 23 seconds as
|
of 60 seconds.
|
||||||
WebP and 27 as JPEG XL, and 4096x4096 or 8192x2048 up to about 25 as AVIF, which
|
|
||||||
would take about 99 at 8192x8192. Without an alpha channel they take up to about
|
|
||||||
16, 13 and 15 seconds. Decoding such a source adds up to about 11 seconds.
|
|
||||||
|
|
||||||
The login form (`POST /`) is limited to 5 attempts per minute per client
|
The login form (`POST /`) is limited to 5 attempts per minute per client
|
||||||
address, counting an IPv6 client by its /64; an attempt over the limit is
|
address, counting an IPv6 client by its /64; an attempt over the limit is
|
||||||
@@ -396,23 +382,14 @@ nor change what it asks for.
|
|||||||
|
|
||||||
1. Open `/` in a browser over HTTPS (or over plain HTTP while `debug` is on, see
|
1. Open `/` in a browser over HTTPS (or over plain HTTP while `debug` is on, see
|
||||||
Routes) and log in with the signing key (`signing_key`). The login session
|
Routes) and log in with the signing key (`signing_key`). The login session
|
||||||
lasts 30 days, or until someone logs out with the generator page's Logout
|
lasts 30 days, or until `/logout`.
|
||||||
button. Every login is made with the one signing key, so logging out ends
|
|
||||||
every login session, in every browser, a copy of the session cookie included.
|
|
||||||
pixa keeps a random value in its database, which it makes when the database
|
|
||||||
has none and replaces at each logout. A login session carries the value
|
|
||||||
current at its login and is refused once the value has changed, also after a
|
|
||||||
restart (see Deployment). The check for a logout compares no time, so a login
|
|
||||||
after a logout works whatever the host's clock says; the 30 days are still
|
|
||||||
measured by the host's clock.
|
|
||||||
2. On the generator page, give the source image's URL, the width and height, the
|
2. On the generator page, give the source image's URL, the width and height, the
|
||||||
format, quality and fit, and how long the URL lasts, then submit the form
|
format, quality and fit, and how long the URL lasts, then submit the form
|
||||||
(`POST /generate`). The format is JPEG XL unless another is chosen; a form
|
(`POST /generate`). The format is JPEG XL unless another is chosen; a form
|
||||||
sent with an empty format, or none, also makes a JPEG XL URL. Width and
|
sent with an empty format, or none, also makes a JPEG XL URL. Width and
|
||||||
height both empty or `0` keep the original size; if only one of them is empty
|
height both empty or `0` keep the original size; if only one of them is empty
|
||||||
or `0`, that side is scaled to keep the image's proportions. A URL whose
|
or `0`, that side is scaled to keep the image's proportions. A URL whose
|
||||||
scaled side would come out above 8192 answers 400, and so does an AVIF URL of
|
scaled side would come out above 8192 answers 400.
|
||||||
more than 16,777,216 pixels (see Routes).
|
|
||||||
3. The page shows the URL, `https://<host>/v1/e/<token>/img.<format>`, and when
|
3. The page shows the URL, `https://<host>/v1/e/<token>/img.<format>`, and when
|
||||||
it expires. `<host>` is the host the page was opened on, and the URL starts
|
it expires. `<host>` is the host the page was opened on, and the URL starts
|
||||||
with `http` instead while `debug` is on. The name after the token is ignored
|
with `http` instead while `debug` is on. The name after the token is ignored
|
||||||
@@ -695,9 +672,7 @@ See `configs/config.example.yml` for all options with defaults.
|
|||||||
`metrics.username` and `metrics.password` are set. A request's `handler` label
|
`metrics.username` and `metrics.password` are set. A request's `handler` label
|
||||||
is the pattern of the route it matches, such as `/v1/image/*`, never its path.
|
is the pattern of the route it matches, such as `/v1/image/*`, never its path.
|
||||||
Requests that match no route share the label `unmatched`: those the router
|
Requests that match no route share the label `unmatched`: those the router
|
||||||
answers 404 or 405, and CORS preflights. A request's `method` label is its
|
answers 404 or 405, and CORS preflights
|
||||||
method when that is `GET`, `HEAD`, `POST`, `PUT`, `PATCH`, `DELETE`,
|
|
||||||
`OPTIONS`, `CONNECT` or `TRACE`, and `other` for any other method
|
|
||||||
- **Logging**: stdlib slog
|
- **Logging**: stdlib slog
|
||||||
|
|
||||||
## Entrypoints
|
## Entrypoints
|
||||||
|
|||||||
@@ -30,43 +30,6 @@ P2: security: per-origin rate limiting
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-10-15 a WebP, AVIF or JPEG XL encode at the limits takes at most about 27
|
|
||||||
seconds (closes #272): with one libvips thread, 8192x8192 random pixels with
|
|
||||||
an alpha channel took about 61 seconds to encode as WebP, 99 as AVIF and 81 as
|
|
||||||
JPEG XL, so with the default `downstream_timeout` of 60 seconds such an image
|
|
||||||
was never delivered, yet its encode held a processing slot to the end. WebP is
|
|
||||||
now saved at effort 2 and JPEG XL at effort 4, which take up to about 23 and
|
|
||||||
27 seconds. AVIF was already at the lowest effort govips can set, so an AVIF
|
|
||||||
output of more than 16,777,216 pixels is refused with 400 before anything is
|
|
||||||
decoded; 4096x4096 or 8192x2048 takes up to about 25 seconds. Resizing with
|
|
||||||
`fit=cover` already decodes the input, so the output's dimensions are worked
|
|
||||||
out before resizing. `README.md` gives the limit and the new times.
|
|
||||||
- 2026-10-15 the request metrics record any method that is not a standard one as
|
|
||||||
`other` (closes #274): their `method` label was each request's method as sent,
|
|
||||||
and Go's HTTP server accepts any method name, so a client sending made-up
|
|
||||||
methods added series to the Prometheus registry that were never removed. The
|
|
||||||
label is now the request's method only for `GET`, `HEAD`, `POST`, `PUT`,
|
|
||||||
`PATCH`, `DELETE`, `OPTIONS`, `CONNECT` and `TRACE`. The metrics library reads
|
|
||||||
the method from the request it is handed, so the metrics middleware hands it a
|
|
||||||
copy of the request carrying the label; the handlers still see the method the
|
|
||||||
client sent.
|
|
||||||
- 2026-10-15 logging out ends every login session (closes #256): a login session
|
|
||||||
was a cookie with nothing kept on the server, so `/logout` removed it from one
|
|
||||||
browser and a copy of it kept working for its 30 days. Every login is made
|
|
||||||
with the one signing key, so logging out now ends them all: the session
|
|
||||||
manager keeps a random value, made with `crypto/rand` when the new `logout`
|
|
||||||
table has none and replaced by each logout, saves it there so that it outlasts
|
|
||||||
a restart, puts the value at login in each session, and refuses a session
|
|
||||||
carrying another value. The check for a logout compares no time, so a login
|
|
||||||
after a logout works whatever the host's clock does; a session's 30 days are
|
|
||||||
still checked against the clock. Losing the state directory ends every login
|
|
||||||
session, and no logout can make an ended one work again. Logging out is now
|
|
||||||
`POST /logout` from a form on the generator page, behind the CSRF check the
|
|
||||||
other forms have, so a link or image elsewhere on the same site cannot end the
|
|
||||||
sessions. A logout without a valid login session ends none and only removes
|
|
||||||
the cookie, as anyone can take a CSRF token from the login page. A logout that
|
|
||||||
cannot be saved answers 500. `session.NewManager`, which the tests use, keeps
|
|
||||||
the value in memory only; pixad uses `session.NewManagerWithDatabase`.
|
|
||||||
- 2026-10-15 a cached file left empty or partial is no longer served, or fetched
|
- 2026-10-15 a cached file left empty or partial is no longer served, or fetched
|
||||||
again on every request (closes #252). Source and transformed image files, and
|
again on every request (closes #252). Source and transformed image files, and
|
||||||
each transformed image's `.meta` file, are synced to disk before they are
|
each transformed image's `.meta` file, are synced to disk before they are
|
||||||
|
|||||||
@@ -176,11 +176,3 @@ CREATE TABLE IF NOT EXISTS cache_stats (
|
|||||||
last_updated_at DATETIME DEFAULT CURRENT_TIMESTAMP
|
last_updated_at DATETIME DEFAULT CURRENT_TIMESTAMP
|
||||||
);
|
);
|
||||||
INSERT OR IGNORE INTO cache_stats (id) VALUES (1);
|
INSERT OR IGNORE INTO cache_stats (id) VALUES (1);
|
||||||
|
|
||||||
-- A random value that a login session carries from its login. pixa makes it
|
|
||||||
-- when the table has no row, and each logout replaces it; a login session
|
|
||||||
-- carrying another value is refused, so logging out ends every login session.
|
|
||||||
CREATE TABLE IF NOT EXISTS logout (
|
|
||||||
id INTEGER PRIMARY KEY CHECK (id = 1),
|
|
||||||
logout_value TEXT NOT NULL
|
|
||||||
);
|
|
||||||
@@ -89,18 +89,10 @@ func (s *Handlers) handleLoginPost(w http.ResponseWriter, r *http.Request) {
|
|||||||
http.Redirect(w, r, "/", http.StatusSeeOther)
|
http.Redirect(w, r, "/", http.StatusSeeOther)
|
||||||
}
|
}
|
||||||
|
|
||||||
// HandleLogout logs out, which ends every login session (see
|
// HandleLogout clears the session and redirects to login.
|
||||||
// session.Manager.Logout), and redirects to login.
|
|
||||||
func (s *Handlers) HandleLogout() http.HandlerFunc {
|
func (s *Handlers) HandleLogout() http.HandlerFunc {
|
||||||
return func(w http.ResponseWriter, r *http.Request) {
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
err := s.sessMgr.Logout(w, r)
|
s.sessMgr.ClearSession(w)
|
||||||
if err != nil {
|
|
||||||
s.log.Error("failed to log out", "error", err)
|
|
||||||
http.Error(w, "Failed to log out", http.StatusInternalServerError)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
http.Redirect(w, r, "/", http.StatusSeeOther)
|
http.Redirect(w, r, "/", http.StatusSeeOther)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -185,98 +185,6 @@ func TestHandleLogout_ClearsSessionCookie(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestHandleLogout_EndsCopiedSession verifies that after POST /logout a copy
|
|
||||||
// of the session cookie taken before it shows the login page, not the
|
|
||||||
// generator page.
|
|
||||||
func TestHandleLogout_EndsCopiedSession(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
h, srv := newCSRFTestRouter(t)
|
|
||||||
|
|
||||||
copied := newSessionCookie(t, h)
|
|
||||||
|
|
||||||
req := httptest.NewRequestWithContext(
|
|
||||||
t.Context(), http.MethodPost, "/logout", nil)
|
|
||||||
req.AddCookie(copied)
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
h.HandleLogout().ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
if rec.Code != http.StatusSeeOther {
|
|
||||||
t.Fatalf("POST /logout status = %d, want %d",
|
|
||||||
rec.Code, http.StatusSeeOther)
|
|
||||||
}
|
|
||||||
|
|
||||||
req = httptest.NewRequestWithContext(t.Context(), http.MethodGet, "/", nil)
|
|
||||||
req.AddCookie(copied)
|
|
||||||
|
|
||||||
rec = httptest.NewRecorder()
|
|
||||||
srv.ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
body := rec.Body.String()
|
|
||||||
t.Logf("GET / with the copied cookie: status %d, login page %v",
|
|
||||||
rec.Code, strings.Contains(body, loginForm))
|
|
||||||
|
|
||||||
if !strings.Contains(body, loginForm) || strings.Contains(body, generatorForm) {
|
|
||||||
t.Error("a cookie copied before /logout still opens the generator page")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestHandleLogout_SaveFails_Answers500 verifies that when the logout cannot
|
|
||||||
// be saved in the database, POST /logout answers 500, leaves the session
|
|
||||||
// cookie in place and ends no session.
|
|
||||||
func TestHandleLogout_SaveFails_Answers500(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
h, srv := newCSRFTestRouter(t)
|
|
||||||
|
|
||||||
db := setupTestDB(t)
|
|
||||||
|
|
||||||
sessMgr, err := session.NewManagerWithDatabase(
|
|
||||||
t.Context(), testSigningKey, db)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("session.NewManagerWithDatabase() error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
h.sessMgr = sessMgr
|
|
||||||
cookie := newSessionCookie(t, h)
|
|
||||||
|
|
||||||
// Saving the logout fails on a closed database.
|
|
||||||
err = db.Close()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("closing the database: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
req := httptest.NewRequestWithContext(
|
|
||||||
t.Context(), http.MethodPost, "/logout", nil)
|
|
||||||
req.AddCookie(cookie)
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
h.HandleLogout().ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
t.Logf("POST /logout: status %d, Set-Cookie %q",
|
|
||||||
rec.Code, rec.Header().Get("Set-Cookie"))
|
|
||||||
|
|
||||||
if rec.Code != http.StatusInternalServerError {
|
|
||||||
t.Errorf("POST /logout status = %d, want %d",
|
|
||||||
rec.Code, http.StatusInternalServerError)
|
|
||||||
}
|
|
||||||
|
|
||||||
if c := findSessionCookie(rec); c != nil {
|
|
||||||
t.Errorf("a logout that failed set the session cookie: %s", c)
|
|
||||||
}
|
|
||||||
|
|
||||||
req = httptest.NewRequestWithContext(t.Context(), http.MethodGet, "/", nil)
|
|
||||||
req.AddCookie(cookie)
|
|
||||||
|
|
||||||
rec = httptest.NewRecorder()
|
|
||||||
srv.ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
if !strings.Contains(rec.Body.String(), generatorForm) {
|
|
||||||
t.Error("a logout that failed ended the session")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestGeneratePost_NoSession_RedirectsToLogin verifies that POST /generate
|
// TestGeneratePost_NoSession_RedirectsToLogin verifies that POST /generate
|
||||||
// with a valid CSRF token but no login session answers 303 to / and makes no
|
// with a valid CSRF token but no login session answers 303 to / and makes no
|
||||||
// URL.
|
// URL.
|
||||||
|
|||||||
@@ -164,10 +164,7 @@ func (s *Handlers) initImageService() error {
|
|||||||
|
|
||||||
// Initialize session manager (signing key is validated at config load
|
// Initialize session manager (signing key is validated at config load
|
||||||
// time). Session cookies are always Secure/HttpOnly/SameSite=Strict.
|
// time). Session cookies are always Secure/HttpOnly/SameSite=Strict.
|
||||||
// The random value that each logout replaces is saved in the database,
|
sessMgr, err := session.NewManager(s.config.SigningKey)
|
||||||
// so it outlasts a restart.
|
|
||||||
sessMgr, err := session.NewManagerWithDatabase(
|
|
||||||
context.Background(), s.config.SigningKey, s.db.DB())
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -264,14 +264,6 @@ func (s *Handlers) respondImageError(
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
if errors.Is(err, imageprocessor.ErrAVIFOutputTooLarge) {
|
|
||||||
s.respondError(w, fmt.Sprintf("size too large for AVIF: the output "+
|
|
||||||
"would be above %d pixels", imageprocessor.MaxAVIFOutputPixels),
|
|
||||||
http.StatusBadRequest)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
s.respondError(w, "internal error", http.StatusInternalServerError)
|
s.respondError(w, "internal error", http.StatusInternalServerError)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -170,10 +170,6 @@ func (s *Handlers) handleImageError(w http.ResponseWriter, err error) {
|
|||||||
s.respondError(w, fmt.Sprintf("size too large for the source: the side "+
|
s.respondError(w, fmt.Sprintf("size too large for the source: the side "+
|
||||||
"computed from its proportions is above %d",
|
"computed from its proportions is above %d",
|
||||||
imageprocessor.MaxOutputDimension), http.StatusBadRequest)
|
imageprocessor.MaxOutputDimension), http.StatusBadRequest)
|
||||||
case errors.Is(err, imageprocessor.ErrAVIFOutputTooLarge):
|
|
||||||
s.respondError(w, fmt.Sprintf("size too large for AVIF: the output "+
|
|
||||||
"would be above %d pixels", imageprocessor.MaxAVIFOutputPixels),
|
|
||||||
http.StatusBadRequest)
|
|
||||||
default:
|
default:
|
||||||
s.log.Error("image request failed", "error", err)
|
s.log.Error("image request failed", "error", err)
|
||||||
s.respondError(w, "internal error", http.StatusInternalServerError)
|
s.respondError(w, "internal error", http.StatusInternalServerError)
|
||||||
|
|||||||
@@ -143,18 +143,6 @@ const MaxOutputDimension = 8192
|
|||||||
// requested size.
|
// requested size.
|
||||||
var ErrOutputTooLarge = errors.New("output image dimensions exceed maximum")
|
var ErrOutputTooLarge = errors.New("output image dimensions exceed maximum")
|
||||||
|
|
||||||
// MaxAVIFOutputPixels is the most pixels an AVIF output may have, so that an
|
|
||||||
// encode takes at most 40 seconds of the default downstream_timeout of 60
|
|
||||||
// seconds; AVIF is already at the lowest effort govips can set (avifEffort).
|
|
||||||
// With one thread, as pixad runs libvips, saving 4096x4096 or 8192x2048
|
|
||||||
// random pixels with an alpha channel takes up to about 25 seconds, and
|
|
||||||
// 5120x4096 took 39.
|
|
||||||
const MaxAVIFOutputPixels = 4096 * 4096
|
|
||||||
|
|
||||||
// ErrAVIFOutputTooLarge is returned, before anything is decoded, when an AVIF
|
|
||||||
// output would have more than MaxAVIFOutputPixels pixels.
|
|
||||||
var ErrAVIFOutputTooLarge = errors.New("AVIF output has too many pixels")
|
|
||||||
|
|
||||||
// ErrUnsupportedOutputFormat is returned when the requested output format is
|
// ErrUnsupportedOutputFormat is returned when the requested output format is
|
||||||
// not supported.
|
// not supported.
|
||||||
var ErrUnsupportedOutputFormat = errors.New("unsupported output format")
|
var ErrUnsupportedOutputFormat = errors.New("unsupported output format")
|
||||||
@@ -223,8 +211,7 @@ func New(params Params) *ImageProcessor {
|
|||||||
// ErrTooManyImages. When ctx has ended once Process has a slot, or before it
|
// ErrTooManyImages. When ctx has ended once Process has a slot, or before it
|
||||||
// encodes, it returns ctx's error and gives the slot back. govips gives pixa
|
// encodes, it returns ctx's error and gives the slot back. govips gives pixa
|
||||||
// no way to stop libvips once an encode has begun, so an encode keeps its
|
// no way to stop libvips once an encode has begun, so an encode keeps its
|
||||||
// slot until it finishes. An AVIF output of more than MaxAVIFOutputPixels is
|
// slot until it finishes.
|
||||||
// refused with ErrAVIFOutputTooLarge before anything is decoded.
|
|
||||||
func (p *ImageProcessor) Process(
|
func (p *ImageProcessor) Process(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
input io.Reader,
|
input io.Reader,
|
||||||
@@ -237,9 +224,18 @@ func (p *ImageProcessor) Process(
|
|||||||
|
|
||||||
defer release()
|
defer release()
|
||||||
|
|
||||||
data, err := p.readInput(input)
|
// Read input with a size limit to prevent unbounded memory consumption.
|
||||||
|
// We read at most maxInputBytes+1 so we can detect if the input exceeds
|
||||||
|
// the limit without consuming additional memory.
|
||||||
|
limited := io.LimitReader(input, p.maxInputBytes+1)
|
||||||
|
|
||||||
|
data, err := io.ReadAll(limited)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, fmt.Errorf("failed to read input: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if int64(len(data)) > p.maxInputBytes {
|
||||||
|
return nil, ErrInputDataTooLarge
|
||||||
}
|
}
|
||||||
|
|
||||||
// govips picks the libvips loader from the input's first bytes with
|
// govips picks the libvips loader from the input's first bytes with
|
||||||
@@ -282,28 +278,20 @@ func (p *ImageProcessor) Process(
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Resize if needed
|
||||||
|
if targetWidth != origWidth || targetHeight != origHeight {
|
||||||
|
err := p.resize(img, targetWidth, targetHeight, req.FitMode)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("failed to resize: %w", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// orig is the source's own format; encode refuses an empty format
|
// orig is the source's own format; encode refuses an empty format
|
||||||
outputFormat := req.Format
|
outputFormat := req.Format
|
||||||
if outputFormat == FormatOriginal {
|
if outputFormat == FormatOriginal {
|
||||||
outputFormat = sourceFormat
|
outputFormat = sourceFormat
|
||||||
}
|
}
|
||||||
|
|
||||||
// Determine output dimensions; too large ones are refused before
|
|
||||||
// resizing, which with FitCover already decodes the input
|
|
||||||
outputWidth, outputHeight, err := outputDimensions(origWidth, origHeight,
|
|
||||||
targetWidth, targetHeight, req.FitMode, outputFormat)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Resize if needed
|
|
||||||
if targetWidth != origWidth || targetHeight != origHeight {
|
|
||||||
err := p.resize(img, outputWidth, outputHeight, req.FitMode)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("failed to resize: %w", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Encode to target format
|
// Encode to target format
|
||||||
output, err := p.encode(ctx, img, outputFormat, req.Quality)
|
output, err := p.encode(ctx, img, outputFormat, req.Quality)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -456,23 +444,6 @@ func (p *ImageProcessor) acquireSlot(ctx context.Context) (func(), error) {
|
|||||||
return release, nil
|
return release, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// readInput reads input with a size limit to prevent unbounded memory
|
|
||||||
// consumption, refusing more than maxInputBytes with ErrInputDataTooLarge. It
|
|
||||||
// reads at most maxInputBytes+1 so it can detect if the input exceeds the
|
|
||||||
// limit without consuming additional memory.
|
|
||||||
func (p *ImageProcessor) readInput(input io.Reader) ([]byte, error) {
|
|
||||||
data, err := io.ReadAll(io.LimitReader(input, p.maxInputBytes+1))
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("failed to read input: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if int64(len(data)) > p.maxInputBytes {
|
|
||||||
return nil, ErrInputDataTooLarge
|
|
||||||
}
|
|
||||||
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// detectFormat returns the format string for a govips image type.
|
// detectFormat returns the format string for a govips image type.
|
||||||
func (p *ImageProcessor) detectFormat(imageType vips.ImageType) string {
|
func (p *ImageProcessor) detectFormat(imageType vips.ImageType) string {
|
||||||
switch imageType {
|
switch imageType {
|
||||||
@@ -497,61 +468,9 @@ func (p *ImageProcessor) detectFormat(imageType vips.ImageType) string {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// outputDimensions returns the dimensions resize gives an image of imgWidth x
|
// resize resizes the image according to the fit mode. With FitOutside one
|
||||||
// imgHeight for the target dimensions and fit mode, without resizing it, and
|
// side can come out larger than requested; when it would be above
|
||||||
// refuses an output too large for format. With FitOutside one side can come
|
// MaxOutputDimension, resize returns ErrOutputTooLarge without resizing.
|
||||||
// out larger than the target; when it would be above MaxOutputDimension,
|
|
||||||
// outputDimensions returns ErrOutputTooLarge. An AVIF output of more than
|
|
||||||
// MaxAVIFOutputPixels is ErrAVIFOutputTooLarge.
|
|
||||||
func outputDimensions(
|
|
||||||
imgWidth, imgHeight, width, height int, fit FitMode, format Format,
|
|
||||||
) (int, int, error) {
|
|
||||||
scaleW := float64(width) / float64(imgWidth)
|
|
||||||
scaleH := float64(height) / float64(imgHeight)
|
|
||||||
outputWidth, outputHeight := width, height
|
|
||||||
|
|
||||||
switch fit {
|
|
||||||
case FitCover, FitFill, "":
|
|
||||||
// Cover crops, and fill stretches, to exactly the target dimensions
|
|
||||||
|
|
||||||
case FitContain:
|
|
||||||
// Fit within the target dimensions, maintaining aspect ratio
|
|
||||||
scale := min(scaleW, scaleH)
|
|
||||||
outputWidth = int(float64(imgWidth) * scale)
|
|
||||||
outputHeight = int(float64(imgHeight) * scale)
|
|
||||||
|
|
||||||
case FitInside:
|
|
||||||
// Same as contain, but only shrink
|
|
||||||
scale := min(scaleW, scaleH, 1)
|
|
||||||
outputWidth = int(float64(imgWidth) * scale)
|
|
||||||
outputHeight = int(float64(imgHeight) * scale)
|
|
||||||
|
|
||||||
case FitOutside:
|
|
||||||
// The smallest dimension fits, the other may exceed the target
|
|
||||||
scale := max(scaleW, scaleH)
|
|
||||||
outputWidth = int(float64(imgWidth) * scale)
|
|
||||||
outputHeight = int(float64(imgHeight) * scale)
|
|
||||||
|
|
||||||
default:
|
|
||||||
return 0, 0, fmt.Errorf("%w: %s", ErrInvalidFitMode, fit)
|
|
||||||
}
|
|
||||||
|
|
||||||
// The side FitOutside scales past the target is held to the maximum too
|
|
||||||
if max(outputWidth, outputHeight) > MaxOutputDimension {
|
|
||||||
return 0, 0, fmt.Errorf("%w: %dx%d is above %d", ErrOutputTooLarge,
|
|
||||||
outputWidth, outputHeight, MaxOutputDimension)
|
|
||||||
}
|
|
||||||
|
|
||||||
if format == FormatAVIF && outputWidth*outputHeight > MaxAVIFOutputPixels {
|
|
||||||
return 0, 0, fmt.Errorf("%w: %dx%d is above %d pixels",
|
|
||||||
ErrAVIFOutputTooLarge, outputWidth, outputHeight, MaxAVIFOutputPixels)
|
|
||||||
}
|
|
||||||
|
|
||||||
return outputWidth, outputHeight, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// resize resizes the image to width x height, the dimensions
|
|
||||||
// outputDimensions gives for the fit mode.
|
|
||||||
func (p *ImageProcessor) resize(
|
func (p *ImageProcessor) resize(
|
||||||
img *vips.ImageRef, width, height int, fit FitMode,
|
img *vips.ImageRef, width, height int, fit FitMode,
|
||||||
) error {
|
) error {
|
||||||
@@ -560,20 +479,52 @@ func (p *ImageProcessor) resize(
|
|||||||
// Resize and crop to fill exact dimensions (default)
|
// Resize and crop to fill exact dimensions (default)
|
||||||
return img.Thumbnail(width, height, vips.InterestingCentre)
|
return img.Thumbnail(width, height, vips.InterestingCentre)
|
||||||
|
|
||||||
|
case FitContain:
|
||||||
|
// Resize to fit within dimensions, maintaining aspect ratio
|
||||||
|
imgW, imgH := img.Width(), img.Height()
|
||||||
|
scaleW := float64(width) / float64(imgW)
|
||||||
|
scaleH := float64(height) / float64(imgH)
|
||||||
|
scale := min(scaleW, scaleH)
|
||||||
|
newW := int(float64(imgW) * scale)
|
||||||
|
newH := int(float64(imgH) * scale)
|
||||||
|
|
||||||
|
return img.Thumbnail(newW, newH, vips.InterestingNone)
|
||||||
|
|
||||||
case FitFill:
|
case FitFill:
|
||||||
// Resize to exact dimensions (may distort)
|
// Resize to exact dimensions (may distort)
|
||||||
return img.ThumbnailWithSize(width, height, vips.InterestingNone, vips.SizeForce)
|
return img.ThumbnailWithSize(width, height, vips.InterestingNone, vips.SizeForce)
|
||||||
|
|
||||||
case FitInside:
|
case FitInside:
|
||||||
// outputDimensions keeps the dimensions of an image that already fits
|
// Same as contain, but only shrink
|
||||||
if img.Width() == width && img.Height() == height {
|
if img.Width() <= width && img.Height() <= height {
|
||||||
return nil
|
return nil // Already fits
|
||||||
}
|
}
|
||||||
|
|
||||||
return img.Thumbnail(width, height, vips.InterestingNone)
|
imgW, imgH := img.Width(), img.Height()
|
||||||
|
scaleW := float64(width) / float64(imgW)
|
||||||
|
scaleH := float64(height) / float64(imgH)
|
||||||
|
scale := min(scaleW, scaleH)
|
||||||
|
newW := int(float64(imgW) * scale)
|
||||||
|
newH := int(float64(imgH) * scale)
|
||||||
|
|
||||||
case FitContain, FitOutside:
|
return img.Thumbnail(newW, newH, vips.InterestingNone)
|
||||||
return img.Thumbnail(width, height, vips.InterestingNone)
|
|
||||||
|
case FitOutside:
|
||||||
|
// Resize so smallest dimension fits, may exceed target on other dimension
|
||||||
|
imgW, imgH := img.Width(), img.Height()
|
||||||
|
scaleW := float64(width) / float64(imgW)
|
||||||
|
scaleH := float64(height) / float64(imgH)
|
||||||
|
scale := max(scaleW, scaleH)
|
||||||
|
newW := int(float64(imgW) * scale)
|
||||||
|
newH := int(float64(imgH) * scale)
|
||||||
|
|
||||||
|
// The dimension that exceeds the target is held to the maximum too
|
||||||
|
if newW > MaxOutputDimension || newH > MaxOutputDimension {
|
||||||
|
return fmt.Errorf("%w: %dx%d is above %d", ErrOutputTooLarge,
|
||||||
|
newW, newH, MaxOutputDimension)
|
||||||
|
}
|
||||||
|
|
||||||
|
return img.Thumbnail(newW, newH, vips.InterestingNone)
|
||||||
|
|
||||||
default:
|
default:
|
||||||
return fmt.Errorf("%w: %s", ErrInvalidFitMode, fit)
|
return fmt.Errorf("%w: %s", ErrInvalidFitMode, fit)
|
||||||
@@ -677,16 +628,11 @@ func exportGIF(img *vips.ImageRef) ([]byte, error) {
|
|||||||
return output, err
|
return output, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// webpEffort is the WebP effort, from 0 (fastest) to 6. It is below libvips'
|
// webpEffort is libvips' default WebP effort, from 0 (fastest) to 6.
|
||||||
// default of 4 so that an encode takes at most 40 seconds of the default
|
const webpEffort = 4
|
||||||
// downstream_timeout of 60 seconds. With one thread, as pixad runs libvips,
|
|
||||||
// saving an 8192x8192 image of random pixels with an alpha channel takes up
|
|
||||||
// to about 23 seconds at 2, and up to about 16 without one; with an alpha
|
|
||||||
// channel, 3 takes about 50 seconds and 4 about 61.
|
|
||||||
const webpEffort = 2
|
|
||||||
|
|
||||||
// exportWebP encodes img as lossy WebP at quality and webpEffort, without
|
// exportWebP encodes img as lossy WebP at quality and libvips' default
|
||||||
// metadata.
|
// effort, without metadata.
|
||||||
func exportWebP(img *vips.ImageRef, quality int) ([]byte, error) {
|
func exportWebP(img *vips.ImageRef, quality int) ([]byte, error) {
|
||||||
output, _, err := img.ExportWebp(&vips.WebpExportParams{
|
output, _, err := img.ExportWebp(&vips.WebpExportParams{
|
||||||
StripMetadata: true,
|
StripMetadata: true,
|
||||||
@@ -698,12 +644,12 @@ func exportWebP(img *vips.ImageRef, quality int) ([]byte, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// avifEffort is the AVIF effort, from 0 (fastest) to 9; 1 is the lowest
|
// avifEffort is the AVIF effort, from 0 (fastest) to 9; 1 is the lowest
|
||||||
// govips can set. With one thread, as pixad runs libvips, 1 takes about 58
|
// govips can set. With one thread, as pixad runs libvips, 1 takes about 51
|
||||||
// seconds to save an 8192x8192 RGB image of random pixels, and about 99
|
// seconds to save an 8192x8192 RGB image of random pixels, and about 110
|
||||||
// with an alpha channel, against the default downstream_timeout of 60
|
// with an alpha channel, the worst case, against the default
|
||||||
// seconds, so an AVIF output is held to MaxAVIFOutputPixels. On an image of
|
// downstream_timeout of 60 seconds. On an image of milder noise, which 1
|
||||||
// milder noise, which 1 saves in about 12 seconds, 2 takes nearly a minute
|
// saves in about 12 seconds, 2 takes nearly a minute and libvips' default,
|
||||||
// and libvips' default, 4, takes minutes.
|
// 4, takes minutes.
|
||||||
const avifEffort = 1
|
const avifEffort = 1
|
||||||
|
|
||||||
// avifBitdepth is the AVIF bit depth, 8 bits per sample for every image.
|
// avifBitdepth is the AVIF bit depth, 8 bits per sample for every image.
|
||||||
@@ -730,18 +676,10 @@ func exportAVIF(img *vips.ImageRef, quality int) ([]byte, error) {
|
|||||||
// JPEG that names none.
|
// JPEG that names none.
|
||||||
const jxlResolution = 72 / 25.4
|
const jxlResolution = 72 / 25.4
|
||||||
|
|
||||||
// jxlEffort is the JPEG XL effort, from 1 (fastest) to 9. It is below
|
// exportJXL encodes img as JPEG XL at quality, with libvips' default effort
|
||||||
// libvips' default of 7 so that an encode takes at most 40 seconds of the
|
// and without metadata. govips sends libvips a distance, the JPEG XL
|
||||||
// default downstream_timeout of 60 seconds. With one thread, as pixad runs
|
// encoder's own measure of quality, along with the quality, and libvips then
|
||||||
// libvips, saving an 8192x8192 image of random pixels with an alpha channel
|
// uses the distance alone, so the quality is also given as a distance.
|
||||||
// takes up to about 27 seconds at 4, and up to about 13 without one; with an
|
|
||||||
// alpha channel, 5 takes about 43 seconds and 7 about 81.
|
|
||||||
const jxlEffort = 4
|
|
||||||
|
|
||||||
// exportJXL encodes img as JPEG XL at quality and jxlEffort, without
|
|
||||||
// metadata. govips sends libvips a distance, the JPEG XL encoder's own
|
|
||||||
// measure of quality, along with the quality, and libvips then uses the
|
|
||||||
// distance alone, so the quality is also given as a distance.
|
|
||||||
func exportJXL(img *vips.ImageRef, quality int) ([]byte, error) {
|
func exportJXL(img *vips.ImageRef, quality int) ([]byte, error) {
|
||||||
// libvips converts a CMYK image to sRGB before it saves WebP, AVIF or
|
// libvips converts a CMYK image to sRGB before it saves WebP, AVIF or
|
||||||
// PNG, but cannot save one as JPEG XL. encode has already converted
|
// PNG, but cannot save one as JPEG XL. encode has already converted
|
||||||
@@ -780,7 +718,6 @@ func exportJXL(img *vips.ImageRef, quality int) ([]byte, error) {
|
|||||||
params := vips.NewJxlExportParams()
|
params := vips.NewJxlExportParams()
|
||||||
params.Quality = quality
|
params.Quality = quality
|
||||||
params.Distance = jxlDistance(quality)
|
params.Distance = jxlDistance(quality)
|
||||||
params.Effort = jxlEffort
|
|
||||||
|
|
||||||
output, _, err := toSave.ExportJxl(params)
|
output, _, err := toSave.ExportJxl(params)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -220,10 +220,7 @@ func (s *Middleware) CORS() func(http.Handler) http.Handler {
|
|||||||
// pattern of the chi route a request matches, such as /v1/image/*, or
|
// pattern of the chi route a request matches, such as /v1/image/*, or
|
||||||
// "unmatched" for a request that matches none, so the routes fix how many
|
// "unmatched" for a request that matches none, so the routes fix how many
|
||||||
// values the label has. It is never the path, with which any client could
|
// values the label has. It is never the path, with which any client could
|
||||||
// add series to the registry without limit. Its method label is the
|
// add series to the registry without limit.
|
||||||
// request's method when that is a standard one, such as GET, and "other"
|
|
||||||
// for any other: Go's HTTP server accepts any method name, so a label per
|
|
||||||
// method would let a client add series the same way.
|
|
||||||
func (s *Middleware) Metrics() func(http.Handler) http.Handler {
|
func (s *Middleware) Metrics() func(http.Handler) http.Handler {
|
||||||
mdlw := ghmm.New(ghmm.Config{
|
mdlw := ghmm.New(ghmm.Config{
|
||||||
Recorder: metrics.NewRecorder(metrics.Config{
|
Recorder: metrics.NewRecorder(metrics.Config{
|
||||||
@@ -233,19 +230,7 @@ func (s *Middleware) Metrics() func(http.Handler) http.Handler {
|
|||||||
|
|
||||||
return func(next http.Handler) http.Handler {
|
return func(next http.Handler) http.Handler {
|
||||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
// The metrics library takes the method label from the request
|
std.Handler(routePattern(r), mdlw, next).ServeHTTP(w, r)
|
||||||
// it is handed, so it is handed a shallow copy of r whose
|
|
||||||
// method is the label. next is served r itself, through the
|
|
||||||
// response writer the library wraps to see the status and size.
|
|
||||||
labelled := r.WithContext(r.Context())
|
|
||||||
labelled.Method = methodLabel(r.Method)
|
|
||||||
|
|
||||||
serveNext := http.HandlerFunc(
|
|
||||||
func(wrapped http.ResponseWriter, _ *http.Request) {
|
|
||||||
next.ServeHTTP(wrapped, r)
|
|
||||||
})
|
|
||||||
|
|
||||||
std.Handler(routePattern(r), mdlw, serveNext).ServeHTTP(w, labelled)
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -290,20 +275,6 @@ func routePattern(r *http.Request) string {
|
|||||||
return pattern
|
return pattern
|
||||||
}
|
}
|
||||||
|
|
||||||
// methodLabel returns method when it is one of the standard methods net/http
|
|
||||||
// names: GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, CONNECT and TRACE.
|
|
||||||
// For any other method it returns "other".
|
|
||||||
func methodLabel(method string) string {
|
|
||||||
switch method {
|
|
||||||
case http.MethodGet, http.MethodHead, http.MethodPost, http.MethodPut,
|
|
||||||
http.MethodPatch, http.MethodDelete, http.MethodOptions,
|
|
||||||
http.MethodConnect, http.MethodTrace:
|
|
||||||
return method
|
|
||||||
default:
|
|
||||||
return "other"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// MetricsAuth returns a basic auth middleware for the metrics endpoint.
|
// MetricsAuth returns a basic auth middleware for the metrics endpoint.
|
||||||
func (s *Middleware) MetricsAuth() func(http.Handler) http.Handler {
|
func (s *Middleware) MetricsAuth() func(http.Handler) http.Handler {
|
||||||
return basicauth.New(
|
return basicauth.New(
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ import (
|
|||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"net/url"
|
"net/url"
|
||||||
"slices"
|
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
@@ -315,58 +314,6 @@ func requestCountsByHandler(
|
|||||||
return counts
|
return counts
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestMetricsGivesMadeUpMethodsOneLabel checks that the metrics middleware
|
|
||||||
// gives requests with methods that are not standard ones a single method
|
|
||||||
// label, "other", and still serves each request with the method it was sent
|
|
||||||
// with. With a label per method, any client could add series to the
|
|
||||||
// registry without limit by making up a new method for each request.
|
|
||||||
func TestMetricsGivesMadeUpMethodsOneLabel(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
// The line /metrics shows once both made-up methods have been served.
|
|
||||||
const want = `http_request_duration_seconds_count{` +
|
|
||||||
`code="200",handler="unmatched",method="other",service=""} 2`
|
|
||||||
|
|
||||||
registry := prometheus.NewRegistry()
|
|
||||||
mw := &Middleware{
|
|
||||||
log: slog.Default(),
|
|
||||||
config: &config.Config{},
|
|
||||||
metricsRegistry: registry,
|
|
||||||
}
|
|
||||||
|
|
||||||
var served []string
|
|
||||||
|
|
||||||
handler := mw.Metrics()(http.HandlerFunc(
|
|
||||||
func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
served = append(served, r.Method)
|
|
||||||
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
}))
|
|
||||||
|
|
||||||
methods := []string{"FROBNICATE", "WIBBLE"}
|
|
||||||
for _, method := range methods {
|
|
||||||
handler.ServeHTTP(httptest.NewRecorder(), httptest.NewRequestWithContext(
|
|
||||||
t.Context(), method, "/", nil))
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Logf("methods the handler was served: %v", served)
|
|
||||||
|
|
||||||
if !slices.Equal(served, methods) {
|
|
||||||
t.Errorf("methods the handler was served = %v, want %v",
|
|
||||||
served, methods)
|
|
||||||
}
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
promhttp.HandlerFor(registry, promhttp.HandlerOpts{}).ServeHTTP(rec,
|
|
||||||
httptest.NewRequestWithContext(
|
|
||||||
t.Context(), http.MethodGet, "/metrics", nil))
|
|
||||||
|
|
||||||
if !strings.Contains(rec.Body.String(), want) {
|
|
||||||
t.Errorf("/metrics does not count both made-up methods as one; "+
|
|
||||||
"want the line %q in:\n%s", want, rec.Body.String())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestLoggingLeavesOutSubmittedSigningKey checks that a login, a POST /
|
// TestLoggingLeavesOutSubmittedSigningKey checks that a login, a POST /
|
||||||
// whose form carries the signing key, leaves no trace of the key in the
|
// whose form carries the signing key, leaves no trace of the key in the
|
||||||
// request's log line.
|
// request's log line.
|
||||||
|
|||||||
@@ -1,269 +0,0 @@
|
|||||||
package server
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"net/url"
|
|
||||||
"path/filepath"
|
|
||||||
"regexp"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"go.uber.org/fx"
|
|
||||||
"go.uber.org/fx/fxtest"
|
|
||||||
|
|
||||||
"sneak.berlin/go/pixa/internal/config"
|
|
||||||
"sneak.berlin/go/pixa/internal/database"
|
|
||||||
"sneak.berlin/go/pixa/internal/globals"
|
|
||||||
"sneak.berlin/go/pixa/internal/handlers"
|
|
||||||
"sneak.berlin/go/pixa/internal/healthcheck"
|
|
||||||
"sneak.berlin/go/pixa/internal/logger"
|
|
||||||
"sneak.berlin/go/pixa/internal/middleware"
|
|
||||||
"sneak.berlin/go/pixa/internal/session"
|
|
||||||
)
|
|
||||||
|
|
||||||
// logoutFormPattern extracts the CSRF token rendered into the generator
|
|
||||||
// page's logout form.
|
|
||||||
var logoutFormPattern = regexp.MustCompile(
|
|
||||||
`(?s)action="/logout".*?name="gorilla\.csrf\.Token" value="([^"]+)"`)
|
|
||||||
|
|
||||||
// startPixa starts the components pixad's fx app builds, from cfg, and
|
|
||||||
// returns the server with its routes, as newTestServer does.
|
|
||||||
func startPixa(t *testing.T, cfg *config.Config) *Server {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
var (
|
|
||||||
h *handlers.Handlers
|
|
||||||
mw *middleware.Middleware
|
|
||||||
)
|
|
||||||
|
|
||||||
app := fxtest.New(t,
|
|
||||||
fx.Supply(cfg),
|
|
||||||
fx.Provide(
|
|
||||||
globals.New,
|
|
||||||
logger.New,
|
|
||||||
database.New,
|
|
||||||
healthcheck.New,
|
|
||||||
handlers.New,
|
|
||||||
middleware.New,
|
|
||||||
),
|
|
||||||
fx.Populate(&h, &mw),
|
|
||||||
)
|
|
||||||
app.RequireStart()
|
|
||||||
t.Cleanup(app.RequireStop)
|
|
||||||
|
|
||||||
s := &Server{config: cfg, mw: mw, h: h}
|
|
||||||
s.SetupRoutes()
|
|
||||||
|
|
||||||
return s
|
|
||||||
}
|
|
||||||
|
|
||||||
// logIn logs in to s with the signing key, as postLogin does, and returns
|
|
||||||
// the session cookie it sets.
|
|
||||||
func logIn(t *testing.T, s *Server) *http.Cookie {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
rec := postLogin(t, s, firstClient, "", testSigningKey)
|
|
||||||
|
|
||||||
for _, c := range rec.Result().Cookies() {
|
|
||||||
if c.Name == session.CookieName {
|
|
||||||
return c
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Fatal("logging in set no session cookie")
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// opensGeneratorPage reports whether GET / with cookie shows s's generator
|
|
||||||
// page, which only a valid login session opens.
|
|
||||||
func opensGeneratorPage(t *testing.T, s *Server, cookie *http.Cookie) bool {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(), http.MethodGet, "/", nil)
|
|
||||||
req.AddCookie(cookie)
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
s.ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
return rec.Code == http.StatusOK &&
|
|
||||||
strings.Contains(rec.Body.String(), `action="/generate"`)
|
|
||||||
}
|
|
||||||
|
|
||||||
// postLogout loads the generator page with GET / and sessionCookie and
|
|
||||||
// submits its logout form with POST /logout, as a browser does.
|
|
||||||
func postLogout(
|
|
||||||
t *testing.T, s *Server, sessionCookie *http.Cookie,
|
|
||||||
) *httptest.ResponseRecorder {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(), http.MethodGet, "/", nil)
|
|
||||||
req.AddCookie(sessionCookie)
|
|
||||||
|
|
||||||
page := httptest.NewRecorder()
|
|
||||||
s.ServeHTTP(page, req)
|
|
||||||
|
|
||||||
match := logoutFormPattern.FindStringSubmatch(page.Body.String())
|
|
||||||
if match == nil {
|
|
||||||
t.Fatal("the generator page has no logout form with a CSRF token")
|
|
||||||
}
|
|
||||||
|
|
||||||
form := url.Values{"gorilla.csrf.Token": {match[1]}}
|
|
||||||
req = httptest.NewRequestWithContext(t.Context(), http.MethodPost,
|
|
||||||
"/logout", strings.NewReader(form.Encode()))
|
|
||||||
req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
|
|
||||||
req.AddCookie(sessionCookie)
|
|
||||||
|
|
||||||
for _, c := range page.Result().Cookies() {
|
|
||||||
req.AddCookie(c)
|
|
||||||
}
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
s.ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
return rec
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestLogoutWithoutCSRFTokenEndsNoSession verifies that a request to /logout
|
|
||||||
// carrying the session cookie but not the logout form's CSRF token ends no
|
|
||||||
// session: GET /logout, as an image on another page of the same site makes a
|
|
||||||
// browser send, answers 405, and POST /logout without the token answers 403.
|
|
||||||
func TestLogoutWithoutCSRFTokenEndsNoSession(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
method string
|
|
||||||
want int
|
|
||||||
}{
|
|
||||||
{http.MethodGet, http.StatusMethodNotAllowed},
|
|
||||||
{http.MethodPost, http.StatusForbidden},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tests {
|
|
||||||
t.Run(tc.method, func(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
s := newTestServer(t)
|
|
||||||
cookie := logIn(t, s)
|
|
||||||
|
|
||||||
req := httptest.NewRequestWithContext(
|
|
||||||
t.Context(), tc.method, "/logout", nil)
|
|
||||||
req.AddCookie(cookie)
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
s.ServeHTTP(rec, req)
|
|
||||||
t.Logf("%s /logout without the CSRF token: status %d",
|
|
||||||
tc.method, rec.Code)
|
|
||||||
|
|
||||||
if rec.Code != tc.want {
|
|
||||||
t.Errorf("%s /logout without the CSRF token status = %d, "+
|
|
||||||
"want %d", tc.method, rec.Code, tc.want)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !opensGeneratorPage(t, s, cookie) {
|
|
||||||
t.Errorf("%s /logout without the CSRF token ended the "+
|
|
||||||
"login session", tc.method)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestLoginAfterLogoutOpensGeneratorPage verifies that after a logout from
|
|
||||||
// the generator page a copy of the session cookie taken before it is
|
|
||||||
// refused, and that a login after it opens the generator page.
|
|
||||||
func TestLoginAfterLogoutOpensGeneratorPage(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
s := newTestServer(t)
|
|
||||||
|
|
||||||
copied := logIn(t, s)
|
|
||||||
if !opensGeneratorPage(t, s, copied) {
|
|
||||||
t.Fatal("logging in did not open the generator page")
|
|
||||||
}
|
|
||||||
|
|
||||||
logout := postLogout(t, s, copied)
|
|
||||||
if logout.Code != http.StatusSeeOther {
|
|
||||||
t.Fatalf("POST /logout status = %d, want %d",
|
|
||||||
logout.Code, http.StatusSeeOther)
|
|
||||||
}
|
|
||||||
|
|
||||||
if opensGeneratorPage(t, s, copied) {
|
|
||||||
t.Error("a cookie copied before the logout still opens the " +
|
|
||||||
"generator page")
|
|
||||||
}
|
|
||||||
|
|
||||||
opens := opensGeneratorPage(t, s, logIn(t, s))
|
|
||||||
t.Logf("a login after the logout opens the generator page: %v", opens)
|
|
||||||
|
|
||||||
if !opens {
|
|
||||||
t.Error("a login after the logout does not open the generator page")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestLogoutOutlastsRestart verifies that a copy of the session cookie taken
|
|
||||||
// before a logout is still refused by a pixa started again on the same state
|
|
||||||
// directory, as pixad is after a restart.
|
|
||||||
func TestLogoutOutlastsRestart(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
s := newTestServer(t)
|
|
||||||
|
|
||||||
copied := logIn(t, s)
|
|
||||||
if !opensGeneratorPage(t, s, copied) {
|
|
||||||
t.Fatal("logging in did not open the generator page")
|
|
||||||
}
|
|
||||||
|
|
||||||
logout := postLogout(t, s, copied)
|
|
||||||
if logout.Code != http.StatusSeeOther {
|
|
||||||
t.Fatalf("POST /logout status = %d, want %d",
|
|
||||||
logout.Code, http.StatusSeeOther)
|
|
||||||
}
|
|
||||||
|
|
||||||
restarted := startPixa(t, s.config)
|
|
||||||
|
|
||||||
opens := opensGeneratorPage(t, restarted, copied)
|
|
||||||
t.Logf("after the restart, the copied cookie opens the generator page: %v",
|
|
||||||
opens)
|
|
||||||
|
|
||||||
if opens {
|
|
||||||
t.Error("after a restart, a cookie copied before the logout " +
|
|
||||||
"still opens the generator page")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestLostStateDirectoryEndsEveryLoginSession verifies that a pixa started on
|
|
||||||
// an empty state directory, as pixad is after a restart that lost its state
|
|
||||||
// directory, refuses a session cookie from before, and that a login on it
|
|
||||||
// opens the generator page.
|
|
||||||
func TestLostStateDirectoryEndsEveryLoginSession(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
s := newTestServer(t)
|
|
||||||
|
|
||||||
before := logIn(t, s)
|
|
||||||
if !opensGeneratorPage(t, s, before) {
|
|
||||||
t.Fatal("logging in did not open the generator page")
|
|
||||||
}
|
|
||||||
|
|
||||||
emptyStateDir := *s.config
|
|
||||||
emptyStateDir.StateDir = t.TempDir()
|
|
||||||
emptyStateDir.DBURL = "file:" +
|
|
||||||
filepath.Join(emptyStateDir.StateDir, "state.sqlite3")
|
|
||||||
|
|
||||||
restarted := startPixa(t, &emptyStateDir)
|
|
||||||
|
|
||||||
opens := opensGeneratorPage(t, restarted, before)
|
|
||||||
t.Logf("on an empty state directory, the cookie from before opens the "+
|
|
||||||
"generator page: %v", opens)
|
|
||||||
|
|
||||||
if opens {
|
|
||||||
t.Error("on an empty state directory, a cookie from before still " +
|
|
||||||
"opens the generator page")
|
|
||||||
}
|
|
||||||
|
|
||||||
if !opensGeneratorPage(t, restarted, logIn(t, restarted)) {
|
|
||||||
t.Error("a login on an empty state directory does not open the " +
|
|
||||||
"generator page")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -69,9 +69,10 @@ func (s *Server) SetupRoutes() {
|
|||||||
r.With(s.mw.RateLimit(LoginAttemptsPerMinute, time.Minute, nil)).
|
r.With(s.mw.RateLimit(LoginAttemptsPerMinute, time.Minute, nil)).
|
||||||
Post("/", s.h.HandleRoot())
|
Post("/", s.h.HandleRoot())
|
||||||
r.Post("/generate", s.h.HandleGenerateURL())
|
r.Post("/generate", s.h.HandleGenerateURL())
|
||||||
r.Post("/logout", s.h.HandleLogout())
|
|
||||||
})
|
})
|
||||||
|
|
||||||
|
s.router.Get("/logout", s.h.HandleLogout())
|
||||||
|
|
||||||
// Image routes, the only ones that send CORS headers, as pages on other
|
// Image routes, the only ones that send CORS headers, as pages on other
|
||||||
// sites read them. They are a subrouter rather than a group: a group's
|
// sites read them. They are a subrouter rather than a group: a group's
|
||||||
// middleware runs only for a request that matches one of its routes,
|
// middleware runs only for a request that matches one of its routes,
|
||||||
|
|||||||
+2
-116
@@ -1,16 +1,9 @@
|
|||||||
// Package session provides encrypted session cookie management, and keeps in
|
// Package session provides encrypted session cookie management.
|
||||||
// the database a random value that each logout replaces, so that a logout
|
|
||||||
// ends every session made before it.
|
|
||||||
package session
|
package session
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
|
||||||
"crypto/rand"
|
|
||||||
"database/sql"
|
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
|
||||||
"net/http"
|
"net/http"
|
||||||
"sync"
|
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/gorilla/securecookie"
|
"github.com/gorilla/securecookie"
|
||||||
@@ -39,36 +32,14 @@ type Data struct {
|
|||||||
Authenticated bool `json:"auth"`
|
Authenticated bool `json:"auth"`
|
||||||
CreatedAt time.Time `json:"created"`
|
CreatedAt time.Time `json:"created"`
|
||||||
ExpiresAt time.Time `json:"expires"`
|
ExpiresAt time.Time `json:"expires"`
|
||||||
|
|
||||||
// LogoutValue is the Manager's random value, which each logout
|
|
||||||
// replaces, when the session was made.
|
|
||||||
LogoutValue string `json:"logoutValue"`
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Manager handles session creation and validation using encrypted cookies.
|
// Manager handles session creation and validation using encrypted cookies.
|
||||||
//
|
|
||||||
// Every login is made with the one signing key, so a logout ends every
|
|
||||||
// session made before it, in every browser. The Manager keeps a random
|
|
||||||
// value, which each logout replaces: a session carries the value current at
|
|
||||||
// its login, and a session carrying another value is refused. The check for
|
|
||||||
// a logout compares no time, so a login after a logout works whatever the
|
|
||||||
// host's clock does; the session's expiry is still checked against the
|
|
||||||
// clock. The Manager keeps the value in memory, so checking a session reads
|
|
||||||
// no database; a Manager from NewManagerWithDatabase also saves it in the
|
|
||||||
// database, so that it outlasts a restart.
|
|
||||||
type Manager struct {
|
type Manager struct {
|
||||||
sc *securecookie.SecureCookie
|
sc *securecookie.SecureCookie
|
||||||
db *sql.DB
|
|
||||||
|
|
||||||
// mu guards logoutValue, and is held while a logout is saved, so that
|
|
||||||
// the database and logoutValue agree.
|
|
||||||
mu sync.Mutex
|
|
||||||
logoutValue string
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewManager creates a session manager with keys derived from the signing key.
|
// NewManager creates a session manager with keys derived from the signing key.
|
||||||
// It makes a new random value and keeps it in memory only, so a restart ends
|
|
||||||
// every session; NewManagerWithDatabase keeps the value in the database.
|
|
||||||
//
|
//
|
||||||
// Session cookies always carry the Secure, HttpOnly, and SameSite=Strict
|
// Session cookies always carry the Secure, HttpOnly, and SameSite=Strict
|
||||||
// attributes; this cannot be configured. Browsers treat http://localhost as a
|
// attributes; this cannot be configured. Browsers treat http://localhost as a
|
||||||
@@ -92,44 +63,10 @@ func NewManager(signingKey string) (*Manager, error) {
|
|||||||
sc.MaxAge(int(SessionTTL.Seconds()))
|
sc.MaxAge(int(SessionTTL.Seconds()))
|
||||||
|
|
||||||
return &Manager{
|
return &Manager{
|
||||||
sc: sc,
|
sc: sc,
|
||||||
logoutValue: rand.Text(),
|
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewManagerWithDatabase creates a session manager like NewManager that keeps
|
|
||||||
// its random value in db, which must have pixa's schema: it saves the value
|
|
||||||
// NewManager made when db has none, and otherwise starts from the one saved
|
|
||||||
// there.
|
|
||||||
func NewManagerWithDatabase(
|
|
||||||
ctx context.Context, signingKey string, db *sql.DB,
|
|
||||||
) (*Manager, error) {
|
|
||||||
m, err := NewManager(signingKey)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = db.ExecContext(ctx,
|
|
||||||
"INSERT OR IGNORE INTO logout (id, logout_value) VALUES (1, ?)",
|
|
||||||
m.logoutValue)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf(
|
|
||||||
"failed to save the random value in the logout table: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = db.QueryRowContext(ctx,
|
|
||||||
"SELECT logout_value FROM logout WHERE id = 1",
|
|
||||||
).Scan(&m.logoutValue)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf(
|
|
||||||
"failed to read the random value in the logout table: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
m.db = db
|
|
||||||
|
|
||||||
return m, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// CreateSession creates a new authenticated session and sets the cookie.
|
// CreateSession creates a new authenticated session and sets the cookie.
|
||||||
func (m *Manager) CreateSession(w http.ResponseWriter) error {
|
func (m *Manager) CreateSession(w http.ResponseWriter) error {
|
||||||
now := time.Now()
|
now := time.Now()
|
||||||
@@ -137,7 +74,6 @@ func (m *Manager) CreateSession(w http.ResponseWriter) error {
|
|||||||
Authenticated: true,
|
Authenticated: true,
|
||||||
CreatedAt: now,
|
CreatedAt: now,
|
||||||
ExpiresAt: now.Add(SessionTTL),
|
ExpiresAt: now.Add(SessionTTL),
|
||||||
LogoutValue: m.currentLogoutValue(),
|
|
||||||
}
|
}
|
||||||
|
|
||||||
encoded, err := m.sc.Encode(CookieName, data)
|
encoded, err := m.sc.Encode(CookieName, data)
|
||||||
@@ -186,30 +122,9 @@ func (m *Manager) ValidateSession(r *http.Request) (*Data, error) {
|
|||||||
return nil, ErrInvalidSession
|
return nil, ErrInvalidSession
|
||||||
}
|
}
|
||||||
|
|
||||||
// A logout since the session was made has ended it.
|
|
||||||
if data.LogoutValue != m.currentLogoutValue() {
|
|
||||||
return nil, ErrInvalidSession
|
|
||||||
}
|
|
||||||
|
|
||||||
return &data, nil
|
return &data, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Logout removes the session cookie and, when r has a valid session, ends
|
|
||||||
// every session made until now. A request without one ends no session, so
|
|
||||||
// someone who has not logged in cannot end the sessions of those who have.
|
|
||||||
func (m *Manager) Logout(w http.ResponseWriter, r *http.Request) error {
|
|
||||||
if m.IsAuthenticated(r) {
|
|
||||||
err := m.saveLogout(r.Context())
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
m.ClearSession(w)
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ClearSession removes the session cookie.
|
// ClearSession removes the session cookie.
|
||||||
func (m *Manager) ClearSession(w http.ResponseWriter) {
|
func (m *Manager) ClearSession(w http.ResponseWriter) {
|
||||||
http.SetCookie(w, &http.Cookie{
|
http.SetCookie(w, &http.Cookie{
|
||||||
@@ -230,32 +145,3 @@ func (m *Manager) IsAuthenticated(r *http.Request) bool {
|
|||||||
|
|
||||||
return err == nil && data != nil && data.Authenticated
|
return err == nil && data != nil && data.Authenticated
|
||||||
}
|
}
|
||||||
|
|
||||||
// saveLogout replaces the random value with a new one, saving it in the
|
|
||||||
// database first when the Manager has one.
|
|
||||||
func (m *Manager) saveLogout(ctx context.Context) error {
|
|
||||||
value := rand.Text()
|
|
||||||
|
|
||||||
m.mu.Lock()
|
|
||||||
defer m.mu.Unlock()
|
|
||||||
|
|
||||||
if m.db != nil {
|
|
||||||
_, err := m.db.ExecContext(ctx,
|
|
||||||
"UPDATE logout SET logout_value = ? WHERE id = 1", value)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("failed to save the logout: %w", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
m.logoutValue = value
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// currentLogoutValue returns the Manager's random value.
|
|
||||||
func (m *Manager) currentLogoutValue() string {
|
|
||||||
m.mu.Lock()
|
|
||||||
defer m.mu.Unlock()
|
|
||||||
|
|
||||||
return m.logoutValue
|
|
||||||
}
|
|
||||||
@@ -1,148 +0,0 @@
|
|||||||
package session_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"database/sql"
|
|
||||||
"errors"
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"sneak.berlin/go/pixa/internal/database"
|
|
||||||
"sneak.berlin/go/pixa/internal/session"
|
|
||||||
)
|
|
||||||
|
|
||||||
const logoutTestSigningKey = "test-signing-key-12345"
|
|
||||||
|
|
||||||
// newTestDatabase opens an empty in-memory database with pixa's schema. It
|
|
||||||
// has one connection, as pixad's has: each connection to ":memory:" would
|
|
||||||
// open a database of its own.
|
|
||||||
func newTestDatabase(t *testing.T) *sql.DB {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
db, err := sql.Open("sqlite", ":memory:")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("sql.Open() error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
db.SetMaxOpenConns(1)
|
|
||||||
t.Cleanup(func() { _ = db.Close() })
|
|
||||||
|
|
||||||
err = database.ApplyMigrations(t.Context(), db, nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("ApplyMigrations() error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return db
|
|
||||||
}
|
|
||||||
|
|
||||||
// createSessionCookie logs in with mgr and returns the session cookie it
|
|
||||||
// sets.
|
|
||||||
func createSessionCookie(t *testing.T, mgr *session.Manager) *http.Cookie {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
|
|
||||||
err := mgr.CreateSession(rec)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("CreateSession() error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, c := range rec.Result().Cookies() {
|
|
||||||
if c.Name == session.CookieName {
|
|
||||||
return c
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Fatalf("CreateSession() did not set a %q cookie", session.CookieName)
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// requestWithCookie returns a GET request carrying cookie, or no cookie when
|
|
||||||
// cookie is nil.
|
|
||||||
func requestWithCookie(t *testing.T, cookie *http.Cookie) *http.Request {
|
|
||||||
t.Helper()
|
|
||||||
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(), http.MethodGet, "/", nil)
|
|
||||||
if cookie != nil {
|
|
||||||
req.AddCookie(cookie)
|
|
||||||
}
|
|
||||||
|
|
||||||
return req
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestLogout_EndsEverySessionMadeBeforeIt verifies that after a logout a
|
|
||||||
// copy of the session cookie taken before it is refused and a login after it
|
|
||||||
// works, and that both still hold for a new Manager on the same database, as
|
|
||||||
// after a restart.
|
|
||||||
func TestLogout_EndsEverySessionMadeBeforeIt(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
db := newTestDatabase(t)
|
|
||||||
|
|
||||||
mgr, err := session.NewManagerWithDatabase(
|
|
||||||
t.Context(), logoutTestSigningKey, db)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("NewManagerWithDatabase() error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
copied := createSessionCookie(t, mgr)
|
|
||||||
|
|
||||||
err = mgr.Logout(httptest.NewRecorder(), requestWithCookie(t, copied))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Logout() error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = mgr.ValidateSession(requestWithCookie(t, copied))
|
|
||||||
t.Logf("cookie copied before the logout: ValidateSession() error = %v", err)
|
|
||||||
|
|
||||||
if !errors.Is(err, session.ErrInvalidSession) {
|
|
||||||
t.Errorf("cookie copied before the logout: error = %v, want %v",
|
|
||||||
err, session.ErrInvalidSession)
|
|
||||||
}
|
|
||||||
|
|
||||||
loginAfter := createSessionCookie(t, mgr)
|
|
||||||
|
|
||||||
_, err = mgr.ValidateSession(requestWithCookie(t, loginAfter))
|
|
||||||
if err != nil {
|
|
||||||
t.Errorf("login after the logout: ValidateSession() error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
restarted, err := session.NewManagerWithDatabase(
|
|
||||||
t.Context(), logoutTestSigningKey, db)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("NewManagerWithDatabase() after restart error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if restarted.IsAuthenticated(requestWithCookie(t, copied)) {
|
|
||||||
t.Error("after a restart, a cookie copied before the logout is accepted")
|
|
||||||
}
|
|
||||||
|
|
||||||
if !restarted.IsAuthenticated(requestWithCookie(t, loginAfter)) {
|
|
||||||
t.Error("after a restart, a login made after the logout is refused")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestLogout_WithoutSession_EndsNoSession verifies that a logout from a
|
|
||||||
// request without a session cookie ends no session, so someone who has not
|
|
||||||
// logged in cannot end the sessions of those who have.
|
|
||||||
func TestLogout_WithoutSession_EndsNoSession(t *testing.T) {
|
|
||||||
t.Parallel()
|
|
||||||
|
|
||||||
mgr, err := session.NewManagerWithDatabase(
|
|
||||||
t.Context(), logoutTestSigningKey, newTestDatabase(t))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("NewManagerWithDatabase() error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
cookie := createSessionCookie(t, mgr)
|
|
||||||
|
|
||||||
err = mgr.Logout(httptest.NewRecorder(), requestWithCookie(t, nil))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Logout() error = %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !mgr.IsAuthenticated(requestWithCookie(t, cookie)) {
|
|
||||||
t.Error("a logout without a session cookie ended a session")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -122,20 +122,12 @@ header {
|
|||||||
margin-bottom: 2rem;
|
margin-bottom: 2rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* The logout button, drawn as a link. */
|
header a {
|
||||||
|
|
||||||
header button {
|
|
||||||
width: auto;
|
|
||||||
margin: 0;
|
|
||||||
padding: 0;
|
|
||||||
background: none;
|
|
||||||
font-size: 0.875rem;
|
font-size: 0.875rem;
|
||||||
color: #4b5563;
|
color: #4b5563;
|
||||||
text-decoration: underline;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
header button:hover {
|
header a:hover {
|
||||||
background: none;
|
|
||||||
color: #1f2937;
|
color: #1f2937;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -10,12 +10,9 @@
|
|||||||
<div class="page">
|
<div class="page">
|
||||||
<header>
|
<header>
|
||||||
<h1>Pixa URL Generator</h1>
|
<h1>Pixa URL Generator</h1>
|
||||||
<form method="POST" action="/logout">
|
<a href="/logout">
|
||||||
{{ .CSRFField }}
|
Logout
|
||||||
<button type="submit">
|
</a>
|
||||||
Logout
|
|
||||||
</button>
|
|
||||||
</form>
|
|
||||||
</header>
|
</header>
|
||||||
|
|
||||||
{{if .GeneratedURL}}
|
{{if .GeneratedURL}}
|
||||||
|
|||||||
Reference in new issue
Block a user