Compare commits

..
Author SHA1 Message Date
Dmitry VerkhoturovandGitHub 3286f028e3 Document what each browser actually does with cross-domain auth (#2222)
Measured on real domains over real certificates, Remark42 on one registrable
domain and the host page on another, with a control cookie behind every
blocked column so a run that blocks nothing cannot report a pass.

Three results the manual did not carry. Safari blocks third-party cookies out
of the box, so AUTH_SAME_SITE=none on its own has already stopped working
there, which makes the old recipe broken today and not deprecated later.
Firefox reaches a working session by a weaker route than Chrome and Safari do:
it accepts the server's attribute-less cookie, and because that cookie is
HttpOnly the browser then forbids the widget's script from replacing it, so the
session rides on an ordinary unpartitioned third-party cookie even with the
header flag on. And Firefox's block-all setting discards partitioned cookies
too, so no configuration survives it.

Two parameter descriptions were wrong in ways that matter here. AUTH_SAME_SITE
default emits no SameSite attribute rather than Lax, which is precisely what
lets the widget's own cookie land on Chrome and Safari. And AUTH_TTL_COOKIE
does not govern the cookie that carries the session under the header flag,
since the frontend hardcodes 200h to mirror the default.
2026-08-23 18:03:49 -05:00
UmputunandGitHub c947a06d48 Release the response before tearing the test server down (#2212)
TestRest_securityHeaders and TestRest_frameAncestors both start a server, read
one response, and then call teardown() partway through the test to start a
second server with different options. The first response body is only closed by
a defer, which does not run until the test returns.

httptest.Server.Close waits on connections still in use, so it blocks on a body
that will not be closed until after it returns. The tests deadlock and the whole
rest/api package dies on the timeout rather than on an assertion.

CI pins go 1.25, where the responses are small enough that the connection goes
back to the pool on its own and nothing hangs. On go 1.27 both tests hang, which
is how this surfaced.

Close the body and the client's idle connections before teardown() in both.
2026-08-23 17:51:52 -05:00
UmputunandGitHub 5f439cf1d5 Qualify what works off-domain, and fix two typos beside it (#2221)
The opening summary said Telegram, Email and anonymous auth "would work
everywhere". That holds only with AUTH_SEND_JWT_HEADER set, and the widget's
own cookie is Secure, so the path is HTTPS-only and bounded by ALLOWED_HOSTS
besides. The sentence now states those conditions. What happens without the
flag is two separate things, whether sign-in succeeds in the frame and whether
it survives a reload, and the body below already separates them.

The other two are older: a stray backtick after "work on any domain", and
"expect" for "except" in a bullet whose neighbour already says except.

Related to #2218
2026-08-23 17:51:47 -05:00
Dmitry VerkhoturovandGitHub 7de51ad2ef Document what actually keeps a cross-domain reader signed in (#2218)
* Document what actually keeps a cross-domain reader signed in

The separate-domain manual tells operators to set ALLOWED_HOSTS and
AUTH_SAME_SITE and says authorisation then works anywhere. That stopped being
true as browsers began blocking third-party cookies: the server-set auth
cookies carry no Partitioned attribute, so a browser enforcing the block drops
them whatever their SameSite value. What survives is AUTH_SEND_JWT_HEADER,
where the token returns in a header and the widget writes its own partitioned
cookie from inside the frame, and the manual never mentioned it. It now does,
with the XSS trade-off and a pointer to the parameter page, and it says plainly
that this rescues Email, Telegram and anonymous but not oAuth.

The parameter page's own mitigation list was left wrong by #2197. It promised
SameSite=Strict cookies and a __Host- prefix on HTTPS; authCookieOptions drops
the prefix entirely and uses SameSite=None; Secure; Partitioned whenever the
widget is embedded on another domain, which is the case the flag exists for.

* Say that the JWT header is sent in addition to the cookies, not instead

Both the flag's own help and the parameter table said the header replaces the
server-set cookie. Service.Set does neither: it writes the header and then
falls through to set both cookies, with a comment saying the cookies are needed
because headers do not survive the OAuth redirect. An operator reading either
description would expect the server to stop setting cookies once the flag is
on, and would misjudge what the flag changes about their exposure.

* Correct three details in the cross-domain documentation

The link to the parameter page used Zola's @/ syntax, which Hugo emits
literally as a relative href since there is no render-link hook. It was the
only such link under site/content; the other manuals use the relative form and
this now does too.

The CHIPS description claimed Partitioned makes the cookie unreadable from any
other page the browser visits. The partition key is the top-level site, so a
different site gets a separate cookie while pages and subdomains under the same
site share it. Overstating isolation on the page an operator reads to weigh
risk is the wrong direction to be wrong in.

And Chrome does not block third-party cookies by default: Google's April 2025
position keeps ordinary Chrome on user choice and names Incognito as the mode
that blocks. Naming Safari, Chrome Incognito and browsers configured to block
them says the same thing and stays true.

* Drop AUTH_SAME_SITE from the recommended cross-domain recipe

Measured rather than reasoned, because it reverses guidance this page has
carried for years. With only the remark42-https service taken back to the
default, both reload cases pass for anonymous and email, under a permissive
browser and under one enforcing partitioning.

The cookie jar after an anonymous sign-in says why. With the setting there are
four cookies: the server's unpartitioned JWT and XSRF-TOKEN, and the widget's
own partitioned pair. Without it there are two, the widget's pair alone, and
the session behaves identically. So the setting is doing something real, which
is what makes the passing run meaningful, and what it does is add an
unpartitioned HttpOnly JWT delivered as a third-party cookie to every listed
domain wherever the browser still permits that. Nothing needs it.

It stays documented for the configuration that does need it, which is one
without AUTH_SEND_JWT_HEADER, where the server's cookies are the only ones
there are.

One prediction the experiment falsified: the attribute case was expected to
fail on the default server-set pair. It passes, because a cross-site Set-Cookie
lacking SameSite=None is refused outright, so that pair is absent from the jar
instead of present with the wrong attribute. The manual now says so.
2026-08-23 15:49:06 -05:00
Dmitry VerkhoturovandGitHub 389189afcf Give each import request in TestMigrator_ImportDouble its own reader (#2220)
The test passed one strings.Reader as the body of both POSTs. client.Do
returns once the response headers arrive, and the import answers 202 before
the transport has finished copying the body, so the second http.NewRequest
reads the reader's Len to set ContentLength while the first request's
writeLoop is still advancing it. The race detector caught it on CI as a write
in strings.(*Reader).WriteTo against a read in NewRequestWithContext, failing
a test nothing had touched.

Reproduced in isolation to confirm the mechanism rather than infer it from the
trace: a handler that answers 202 without draining an 8 MiB body, two requests
sharing one reader, and -race reports strings.(*Reader).Len in
NewRequestWithContext against strings.(*Reader).Read on every run. It does not
reproduce in this package locally, which is why it reads as a flake.

Both requests now build their own reader over the same content. The second one
carries a full body where before it inherited a consumed one, which is closer
to what the case is about: a second import arriving while the first is running
still has to be refused.
2026-08-23 14:58:31 -05:00
Dmitry VerkhoturovandGitHub 6f40926241 Drop the origin-anchored public path from the delete-me bundle (#2219)
deleteme.ts set __webpack_public_path__ to window.location.origin plus /web/,
which discards any path prefix the instance is served under. It is inert today
because that bundle references no asset and loads no chunk, so the value is
assigned and never read, but it is wrong by construction and would resolve at
the domain root the moment anyone adds an image to that page. Removing it
leaves webpack's own publicPath: 'auto', which derives the base from the
script's URL and is right in both arrangements.
2026-08-23 14:58:27 -05:00
Dmitry VerkhoturovandGitHub 2640aaee9e Reach what http cannot: the widget over TLS, embedded cross-origin (#2214)
Every service in the suite spoke http, and the browser gates a whole class
of behaviour on the page protocol: Secure cookies, SameSite=None,
Partitioned, and any code reading location.protocol. None of it was
executed, which is how setAuthCookie came to decorate its cookies with
__Host- on https pages and survive for years.

A TLS pair joins the stack: remark42 with SSL_TYPE=static on 8443, and an
nginx serving a host page on its own name on 8444, both on a self-signed
certificate that e2e/tls/generate.sh makes and .gitignore keeps out. Every
context accepts it, and so does the readiness client, since those are the
only servers either talks to. The instance also runs with
AUTH_SEND_JWT_HEADER, which is what makes the widget write cookies of its
own: without it the client-side writer never runs on any https page here
and every assertion about the attributes it chooses is vacuous.

Three cases. Signing in across origins and then reloading, which is the one
the http cross-origin case cannot make: the widget holds its token in
memory for the life of a page, so signing in and posting says nothing about
persistence and only the reload asks whether the cookie was delivered,
stored under a name the backend reads and sent back from a third-party
frame. The cookies themselves, read out of the browser store while the
widget is embedded elsewhere, since a cookie the browser refused is absent
from that list entirely and one it kept but will not send is worse than
useless: every copy of both names has to be Secure and SameSite=None, at
least one has to be partitioned, and none may carry a __Host- prefix
nothing on either side reads. And the same reload under a browser that
blocks third-party cookies, which the widget's own partitioned pair is the
only reason to survive.

That last one needs a browser playwright does not offer: its default
arguments disable ThirdPartyStoragePartitioning outright, so a run
configured wrongly keeps every third-party cookie and the case would pass
while asserting nothing. IgnoreDefaultArgs drops that list and re-supplies
it without the one feature, and a control cookie set from inside the frame
has to be refused before anything else is read, so a playwright release
that changes the list fails as itself instead of going quietly vacuous.

All three pass against master. What TLS still cannot reach, the OAuth popup
above all, is written down in the README.
2026-08-23 14:58:23 -05:00
19 changed files with 611 additions and 72 deletions
+1
View File
@@ -94,6 +94,7 @@ jobs:
# has to carry the same value `make e2e-up` and the suite itself would give it # has to carry the same value `make e2e-up` and the suite itself would give it
- name: Build & start the stack - name: Build & start the stack
run: | run: |
./e2e/tls/generate.sh
COMPOSE_DOCKER_CLI_BUILD=1 DOCKER_BUILDKIT=1 E2E_STAMP=$(./e2e/stamp.sh) \ COMPOSE_DOCKER_CLI_BUILD=1 DOCKER_BUILDKIT=1 E2E_STAMP=$(./e2e/stamp.sh) \
docker compose -f compose-e2e-test.yml up -d --build --quiet-pull --wait docker compose -f compose-e2e-test.yml up -d --build --quiet-pull --wait
+3
View File
@@ -32,3 +32,6 @@ http-client.env.json
# traces from failed e2e runs # traces from failed e2e runs
/e2e/traces/ /e2e/traces/
# self-signed certificate for the e2e https services, made by e2e/tls/generate.sh
/e2e/tls/*.pem
+1
View File
@@ -42,6 +42,7 @@ rundev:
# stamped the same way the suite stamps a stack it starts itself, so one brought up here is # stamped the same way the suite stamps a stack it starts itself, so one brought up here is
# accepted instead of rejected as belonging to another checkout # accepted instead of rejected as belonging to another checkout
e2e-up: e2e-up:
./e2e/tls/generate.sh
E2E_STAMP=$$(./e2e/stamp.sh) docker compose -f compose-e2e-test.yml up -d --build --quiet-pull --wait E2E_STAMP=$$(./e2e/stamp.sh) docker compose -f compose-e2e-test.yml up -d --build --quiet-pull --wait
e2e-down: e2e-down:
+1 -1
View File
@@ -102,7 +102,7 @@ type ServerCommand struct {
Cookie time.Duration `long:"cookie" env:"COOKIE" default:"200h" description:"auth cookie TTL"` Cookie time.Duration `long:"cookie" env:"COOKIE" default:"200h" description:"auth cookie TTL"`
} `group:"ttl" namespace:"ttl" env-namespace:"TTL"` } `group:"ttl" namespace:"ttl" env-namespace:"TTL"`
SendJWTHeader bool `long:"send-jwt-header" env:"SEND_JWT_HEADER" description:"send JWT as a header instead of server-set cookie; with this enabled, frontend stores the JWT in a client-side cookie (note: increases vulnerability to XSS attacks)"` SendJWTHeader bool `long:"send-jwt-header" env:"SEND_JWT_HEADER" description:"also send JWT as a header, so the frontend can store it in a client-side cookie that survives third-party cookie blocking; server-set cookies are still sent (note: increases vulnerability to XSS attacks)"`
SameSite string `long:"same-site" env:"SAME_SITE" description:"set same site policy for cookies" choice:"default" choice:"none" choice:"lax" choice:"strict" default:"default"` // nolint SameSite string `long:"same-site" env:"SAME_SITE" description:"set same site policy for cookies" choice:"default" choice:"none" choice:"lax" choice:"strict" default:"default"` // nolint
Apple AppleGroup `group:"apple" namespace:"apple" env-namespace:"APPLE" description:"Apple OAuth"` Apple AppleGroup `group:"apple" namespace:"apple" env-namespace:"APPLE" description:"Apple OAuth"`
+4 -1
View File
@@ -271,11 +271,14 @@ func TestRest_securityHeaders(t *testing.T) {
client := http.Client{} client := http.Client{}
resp, err := client.Get(ts.URL + "/web/index.html") resp, err := client.Get(ts.URL + "/web/index.html")
require.NoError(t, err) require.NoError(t, err)
defer resp.Body.Close()
assert.Equal(t, http.StatusOK, resp.StatusCode) assert.Equal(t, http.StatusOK, resp.StatusCode)
assert.Contains(t, resp.Header.Get("Content-Security-Policy"), "img-src *;") assert.Contains(t, resp.Header.Get("Content-Security-Policy"), "img-src *;")
assert.Equal(t, "nosniff", resp.Header.Get("X-Content-Type-Options")) assert.Equal(t, "nosniff", resp.Header.Get("X-Content-Type-Options"))
assert.Equal(t, "strict-origin-when-cross-origin", resp.Header.Get("Referrer-Policy")) assert.Equal(t, "strict-origin-when-cross-origin", resp.Header.Get("Referrer-Policy"))
// httptest.Server.Close waits on connections still in use, and a deferred close does not run
// until the test ends, so the body has to be released before the server is torn down here
require.NoError(t, resp.Body.Close())
client.CloseIdleConnections()
teardown() teardown()
// check CSP with proxy enabled // check CSP with proxy enabled
+7 -3
View File
@@ -280,10 +280,14 @@ func TestMigrator_ImportDouble(t *testing.T) {
for i := range 50 { for i := range 50 {
recs = append(recs, fmt.Sprintf(tmpl, i)) recs = append(recs, fmt.Sprintf(tmpl, i))
} }
r := strings.NewReader(`{"version":1}` + strings.Join(recs, "\n")) // reader with 10k records // each request needs its own reader. client.Do returns once the response headers are in, which
// for an accepted import is before the transport's writeLoop has finished copying the body, so
// handing the same strings.Reader to the second NewRequest races that copy: NewRequest reads
// Len() to set ContentLength while WriteTo is still advancing it
body := `{"version":1}` + strings.Join(recs, "\n")
client := &http.Client{Timeout: waitTimeout} client := &http.Client{Timeout: waitTimeout}
defer client.CloseIdleConnections() defer client.CloseIdleConnections()
req, err := http.NewRequest("POST", ts.URL+"/api/v1/admin/import?site=remark42&provider=native", r) req, err := http.NewRequest("POST", ts.URL+"/api/v1/admin/import?site=remark42&provider=native", strings.NewReader(body))
require.NoError(t, err) require.NoError(t, err)
req.SetBasicAuth("admin", "password") req.SetBasicAuth("admin", "password")
assert.NoError(t, err) assert.NoError(t, err)
@@ -294,7 +298,7 @@ func TestMigrator_ImportDouble(t *testing.T) {
client = &http.Client{Timeout: 5 * time.Second} client = &http.Client{Timeout: 5 * time.Second}
defer client.CloseIdleConnections() defer client.CloseIdleConnections()
req, err = http.NewRequest("POST", ts.URL+"/api/v1/admin/import?site=remark42&provider=native", r) req, err = http.NewRequest("POST", ts.URL+"/api/v1/admin/import?site=remark42&provider=native", strings.NewReader(body))
require.NoError(t, err) require.NoError(t, err)
req.SetBasicAuth("admin", "password") req.SetBasicAuth("admin", "password")
assert.NoError(t, err) assert.NoError(t, err)
+4 -1
View File
@@ -573,9 +573,12 @@ func TestRest_frameAncestors(t *testing.T) {
client := http.Client{} client := http.Client{}
resp, err := client.Get(ts.URL + "/web/index.html") resp, err := client.Get(ts.URL + "/web/index.html")
require.NoError(t, err) require.NoError(t, err)
defer resp.Body.Close()
assert.Equal(t, http.StatusOK, resp.StatusCode) assert.Equal(t, http.StatusOK, resp.StatusCode)
assert.Contains(t, resp.Header.Get("Content-Security-Policy"), "frame-ancestors 'self' https://example.com;") assert.Contains(t, resp.Header.Get("Content-Security-Policy"), "frame-ancestors 'self' https://example.com;")
// httptest.Server.Close waits on connections still in use, and a deferred close does not run
// until the test ends, so the body has to be released before the server is torn down here
require.NoError(t, resp.Body.Close())
client.CloseIdleConnections()
teardown() teardown()
// test case without frame-ancestors // test case without frame-ancestors
+66
View File
@@ -245,6 +245,71 @@ services:
timeout: 3s timeout: 3s
retries: 30 retries: 30
# the same widget over TLS, which is the only way to reach anything the browser gates on the
# page protocol: Secure cookies, SameSite=None, Partitioned, and any code reading
# location.protocol. The certificate is self-signed and the suite passes IgnoreHTTPSErrors
remark42-https:
image: ghcr.io/umputun/remark42:dev
container_name: "remark42-e2e-https"
pull_policy: never
depends_on:
remark42:
condition: service_started
mailpit:
condition: service_started
ports:
- "127.0.0.1:8443:8443"
environment:
- REMARK_URL=https://remark42-https:8443
- SECRET=12345
- AUTH_ANON=true
- SSL_TYPE=static
- SSL_PORT=8443
- SSL_CERT=/srv/tls/cert.pem
- SSL_KEY=/srv/tls/key.pem
# the widget is embedded from another origin here, so its cookies have to survive a
# third-party frame; this is the setting that decides whether they do
- AUTH_SAME_SITE=none
# and the token arrives in a header, so the widget writes the cookies itself through
# setAuthCookie. Without this the client-side writer never runs on any https page in the
# stack, and every assertion about the attributes it chooses is vacuous
- AUTH_SEND_JWT_HEADER=true
# email as well as anonymous, so the flow most operators run off-domain is measured here
# and not inferred from the anonymous one. the writer keys off the X-JWT header rather than
# off the provider, which is exactly the assumption a case signing in by email checks
- AUTH_EMAIL_ENABLE=true
- AUTH_EMAIL_FROM=remark42@example.com
- SMTP_HOST=mailpit
- SMTP_PORT=1025
- UPDATE_LIMIT=100
volumes:
- remark42-e2e-https-var:/srv/var
- ./e2e/tls:/srv/tls:ro
healthcheck:
test: ["CMD", "curl", "--fail", "--insecure", "https://localhost:8443/ping"]
interval: 2s
timeout: 3s
retries: 30
# and a host page for it, on its own name, so the embed is genuinely cross-site over TLS
host-site-https:
image: nginx:1.29-alpine
container_name: "remark42-e2e-hostsite-https"
ports:
- "127.0.0.1:8444:443"
volumes:
- ./e2e/hostsite:/usr/share/nginx/html:ro
- ./e2e/tls:/etc/nginx/tls:ro
- ./e2e/tls/nginx-tls.conf:/etc/nginx/conf.d/default.conf:ro
healthcheck:
# 127.0.0.1 and not localhost: nginx listens on IPv4 only and busybox wget tries ::1 first
test: ["CMD", "wget", "-q", "-O", "/dev/null", "http://127.0.0.1/post-https.html"]
interval: 2s
timeout: 3s
retries: 30
# catches the email-auth verification message; the suite reads it back over the HTTP API # catches the email-auth verification message; the suite reads it back over the HTTP API
mailpit: mailpit:
image: axllent/mailpit:v1.30.7 image: axllent/mailpit:v1.30.7
@@ -268,3 +333,4 @@ volumes:
remark42-e2e-jwtheader-var: remark42-e2e-jwtheader-var:
remark42-e2e-noauth-var: remark42-e2e-noauth-var:
remark42-e2e-anonvote-var: remark42-e2e-anonvote-var:
remark42-e2e-https-var:
+12 -8
View File
@@ -61,7 +61,7 @@ Before pushing, `cd e2e && go vet -tags=e2e ./...` and `golangci-lint run --buil
## The stack ## The stack
`compose-e2e-test.yml` at the repository root runs six services, each bound to the loopback interface since it holds a known secret and an admin shared id: `compose-e2e-test.yml` at the repository root runs ten services, each bound to the loopback interface since it holds a known secret and an admin shared id:
- **remark42** on `:8080`, with the dev oauth2 provider on `:8084`, anonymous and email sign-in - **remark42** on `:8080`, with the dev oauth2 provider on `:8084`, anonymous and email sign-in
- **remark42-shortedit** on `:8081`, with `EDIT_TIME=15s` and anonymous sign-in only, since the dev oauth2 provider's port is fixed at 8084 and cannot be published twice. It exists so the expired-edit path is observable without holding a test open for the default five minutes - **remark42-shortedit** on `:8081`, with `EDIT_TIME=15s` and anonymous sign-in only, since the dev oauth2 provider's port is fixed at 8084 and cannot be published twice. It exists so the expired-edit path is observable without holding a test open for the default five minutes
@@ -70,11 +70,15 @@ Before pushing, `cd e2e && go vet -tags=e2e ./...` and `golangci-lint run --buil
- **remark42-noauth** on `:8085`, with no auth provider at all, which the widget has to say something about, and with `ALLOWED_HOSTS` set to its own address so it doubles as the instance that refuses to be framed elsewhere - **remark42-noauth** on `:8085`, with no auth provider at all, which the widget has to say something about, and with `ALLOWED_HOSTS` set to its own address so it doubles as the instance that refuses to be framed elsewhere
- **remark42-anonvote** on `:8086`, with `ANON_VOTE` and the `VOTES_IP` it depends on, since the default configuration turns an anonymous vote down - **remark42-anonvote** on `:8086`, with `ANON_VOTE` and the `VOTES_IP` it depends on, since the default configuration turns an anonymous vote down
- **host-site** on `:8090`, an nginx serving `e2e/hostsite/`, which is a page on an origin the widget is not served from. Every other host page here is served by remark42 itself, so without it the separate-domain setup the manuals describe is never exercised. `post.html` embeds the main instance; `restricted.html` embeds the one whose `ALLOWED_HOSTS` names only itself, which is the refusal case - **host-site** on `:8090`, an nginx serving `e2e/hostsite/`, which is a page on an origin the widget is not served from. Every other host page here is served by remark42 itself, so without it the separate-domain setup the manuals describe is never exercised. `post.html` embeds the main instance; `restricted.html` embeds the one whose `ALLOWED_HOSTS` names only itself, which is the refusal case
- **remark42-https** on `:8443`, the widget over TLS with `AUTH_SAME_SITE=none` and `AUTH_SEND_JWT_HEADER=true`. The header mode is what makes the widget write its own cookies through `setAuthCookie`, so the attributes it chooses are observable at all. Anonymous and email sign-in are both enabled, since the third-party cases run each flow: the writer keys off the `X-JWT` header rather than off the provider, and that is an assumption worth measuring rather than asserting
- **host-site-https** on `:8444`, an nginx serving the same `e2e/hostsite/` over TLS, so the embed is cross-site *and* secure. `post-https.html` is its page
- **mailpit** on `:8025`, which catches the email-auth verification message and the subscription token for the suite to read back - **mailpit** on `:8025`, which catches the email-auth verification message and the subscription token for the suite to read back
Both TLS services read a self-signed certificate from `e2e/tls/`, which `e2e/tls/generate.sh` writes and `.gitignore` keeps out of the tree. `make e2e-up`, the workflow and `ensureStack` all run it before compose, so bringing the stack up by hand with a bare `docker compose up` is the one path that needs it run first. Every browser context and the readiness client accept that certificate, and they talk to nothing else.
The main instance enables the notify module (`NOTIFY_USERS=email`). Without it `email_notifications` is false in the config, the widget never renders the subscribe control, and the whole subscribe, confirm and unsubscribe flow is unreachable from a browser. The main instance enables the notify module (`NOTIFY_USERS=email`). Without it `email_notifications` is false in the config, the widget never renders the subscribe control, and the whole subscribe, confirm and unsubscribe flow is unreachable from a browser.
The four remark42 instances beyond the first offer anonymous sign-in only, for the reason `remark42-shortedit` does: the dev oauth2 provider binds a port fixed at 8084 and cannot be published twice. `remark42-adminedit` gets its admin from `ADMIN_SHARED_ID`, since the anonymous provider derives the user id from the name and the id for a chosen name can be written into the compose file ahead of time. The remark42 instances beyond the first offer anonymous sign-in only, for the reason `remark42-shortedit` does: the dev oauth2 provider binds a port fixed at 8084 and cannot be published twice. `remark42-adminedit` gets its admin from `ADMIN_SHARED_ID`, since the anonymous provider derives the user id from the name and the id for a chosen name can be written into the compose file ahead of time.
Three settings exist for the tests and not for realism, and each is there for a reason: Three settings exist for the tests and not for realism, and each is there for a reason:
@@ -84,22 +88,22 @@ Three settings exist for the tests and not for realism, and each is there for a
## What this suite cannot reach ## What this suite cannot reach
Every service here speaks http, and nothing in it holds a certificate. Any behaviour the browser gates on the page protocol is therefore invisible: a cookie the widget writes with `Secure`, anything keyed on `window.location.protocol`, and the whole third-party cookie form of `SameSite=None; Secure; Partitioned`, which is the only one browsers still accept from an embedded frame. The stack now carries TLS on two services, so behaviour the browser gates on the page protocol is reachable: `Secure` cookies, `SameSite=None`, `Partitioned`, and anything keyed on `window.location.protocol`. `https_test.go` is where those cases live. What is still out of reach is a browser engine other than Chromium for them, since the resolver rules the hostnames need are a Chromium flag.
That is not hypothetical. `setAuthCookie` prefixed its cookies with `__Host-` on any https page, so a real deployment stored `__Host-JWT` while the backend looked for `JWT`; it survived because the prefix comes from the page protocol and every test and the dev server run on http. Fixed in #2197, under a second suite pinned to an https page, because this one cannot show it. The trap that remains is which cookie policy a run is under. Playwright's own default `--disable-features` argument carries `ThirdPartyStoragePartitioning`, and it beats both `--test-third-party-cookie-phaseout` and `--block-third-party-cookies` passed through `Args`. A run configured that way keeps an ordinary third-party cookie exactly as it would with no flags at all, so it proves nothing while looking like it proved something. The lever is `IgnoreDefaultArgs` on the launch options: drop that default entry and re-supply `--disable-features` without that one feature, which is what `TestHTTPS_SessionSurvivesThirdPartyCookieBlocking` does. Measured on a cross-site https embed:
There is a second trap waiting for whoever gives the stack TLS and then tries to prove the third-party case. Playwright's own default `--disable-features` argument carries `ThirdPartyStoragePartitioning`, and it beats both `--test-third-party-cookie-phaseout` and `--block-third-party-cookies` passed through `Args`. A run configured that way keeps an ordinary third-party cookie exactly as it would with no flags at all, so it proves nothing while looking like it proved something. The lever is `IgnoreDefaultArgs` on the launch options: drop that default entry and re-supply `--disable-features` without that one feature. Measured on a cross-site https embed:
| | ordinary third-party cookie | `Partitioned` cookie | | | ordinary third-party cookie | `Partitioned` cookie |
|---|---|---| |---|---|---|
| Playwright defaults | kept | kept | | Playwright defaults | kept | kept |
| partitioning left enabled | dropped | stored, with its partition key | | partitioning left enabled | dropped | stored, with its partition key |
So a blocking run has to assert a control before anything it reports can be believed: set an ordinary `SameSite=None` cookie from inside the widget frame and require the browser to drop it. If it survives, the run is not blocking anything. So a blocking run has to assert a control before anything it reports can be believed: set an ordinary `SameSite=None` cookie from inside the widget frame and require the browser to drop it. If it survives, the run is not blocking anything. The argument list is Playwright's own and version-specific, so that control is what keeps it from rotting silently.
That control has to read the cookie back through `document.cookie` in the same frame evaluate that writes it, never through `page.Context().Cookies()`. The two are separate channels with no ordering between them: in the Chromium that Playwright 1.62.1 ships, `CookieJar::SetCookie` queues the write and returns, and the renderer's own `document.cookie` getter is the barrier that forces it to settle, while Playwright's context read is a browser-session `Storage.getCookies` that never touches that frame's jar. A control read that way can find the name absent because the write has not landed, which is the one outcome it exists to rule out. It also writes a valid `Secure; SameSite=None; Partitioned` sentinel and requires that one to be present, so "the browser refused the control" is distinguishable from "nothing was written at all".
None of that reaches the widget's own storage fallback, which the auth panel offers as `comments.html` when `IS_THIRD_PARTY && !IS_STORAGE_AVAILABLE`. `IS_STORAGE_AVAILABLE` stays true even with partitioning properly enforced, because Chromium partitions `localStorage` instead of denying it, so the probe behind that constant never throws and the condition cannot fire. That case needs WebKit, not a Chromium flag. None of that reaches the widget's own storage fallback, which the auth panel offers as `comments.html` when `IS_THIRD_PARTY && !IS_STORAGE_AVAILABLE`. `IS_STORAGE_AVAILABLE` stays true even with partitioning properly enforced, because Chromium partitions `localStorage` instead of denying it, so the probe behind that constant never throws and the condition cannot fire. That case needs WebKit, not a Chromium flag.
The practical consequence is for the cross-origin case in `crossorigin_test.go`, which asserts rendering and deliberately not signing in. Give the stack TLS and signing in there becomes testable, and the assertion that matters is **the reload**: the widget holds its token in memory for the life of a page, so a case that signs in and posts without reloading passes while persistence is entirely broken. Partitioned cookies do not make cross-domain OAuth work, whatever the plan once implied. The partition key is the top-level site at the moment the cookie is set, and `oauthSignin` opens a popup, which is its own top-level context: the callback cookie is keyed to the auth host while the frame is keyed to the embedder, and the two never match. The forms that do work embedded are the ones whose cookie is written inside the frame, which is anonymous, email and telegram. A case asserting OAuth works cross-domain would be asserting something untrue.
## Isolation ## Isolation
+5 -5
View File
@@ -22,11 +22,11 @@ import (
// which means its document loaded and reported itself inited through postMessage across origins, // which means its document loaded and reported itself inited through postMessage across origins,
// and that the thread it renders is the one the page's own address names. // and that the thread it renders is the one the page's own address names.
// //
// Signing in is deliberately not asserted. An embedded cookie needs SameSite=None, which browsers // Signing in is deliberately not asserted here. An embedded cookie needs SameSite=None, which
// only accept as Secure, and this stack speaks http, so the form cannot be delivered here at all; // browsers only accept as Secure, and this page is served over http, so the form cannot be
// see "What this suite cannot reach" in the README. Give the stack TLS and the case to add is // delivered at all. That half is covered over TLS in https_test.go, where the assertion that
// signing in and then reloading, since the widget holds its token in memory for the life of a // matters is the reload: the widget holds its token in memory for the life of a page, so a
// page and a sign-in that never reloads passes while persistence is broken // sign-in that never reloads passes while persistence is broken
func TestCrossOrigin_WidgetRendersOnAnotherOrigin(t *testing.T) { func TestCrossOrigin_WidgetRendersOnAnotherOrigin(t *testing.T) {
thread := fmt.Sprintf("%s/post.html?e2e=%s-%s", hostSiteURL, "crossorigin", runID) thread := fmt.Sprintf("%s/post.html?e2e=%s-%s", hostSiteURL, "crossorigin", runID)
text := "cross origin " + runID text := "cross origin " + runID
+27 -2
View File
@@ -16,6 +16,7 @@
// - embed_test.go: the surface the host page holds, placeholder to destroy // - embed_test.go: the surface the host page holds, placeholder to destroy
// - config_test.go: the remark_config surface an integrator sets // - config_test.go: the remark_config surface an integrator sets
// - crossorigin_test.go: a host page on an origin the widget is not served from // - crossorigin_test.go: a host page on an origin the widget is not served from
// - https_test.go: the widget over TLS, where the browser's protocol gates apply
// - deployment_test.go: the instances whose configuration is the thing under test // - deployment_test.go: the instances whose configuration is the thing under test
// - subscribe_test.go: the email subscription round trip // - subscribe_test.go: the email subscription round trip
// - webfiles_test.go: the published /web surface // - webfiles_test.go: the published /web surface
@@ -24,6 +25,7 @@ package e2e
import ( import (
"context" "context"
"crypto/tls"
"encoding/json" "encoding/json"
"fmt" "fmt"
"log" "log"
@@ -59,6 +61,10 @@ const (
// a page on an origin the widget is not served from, see compose-e2e-test.yml // a page on an origin the widget is not served from, see compose-e2e-test.yml
hostSiteURL = "http://host-site:8090" hostSiteURL = "http://host-site:8090"
// the host page over TLS, which is the only way to reach what the browser gates on the page
// protocol. the certificate is self-signed, so every context passes IgnoreHTTPSErrors
httpsHostSiteURL = "https://host-site-https:8444"
// what this process asks for, since it is not the browser and has no resolver rules // what this process asks for, since it is not the browser and has no resolver rules
probeURL = "http://127.0.0.1:8080" probeURL = "http://127.0.0.1:8080"
shortEditProbeURL = "http://127.0.0.1:8081" shortEditProbeURL = "http://127.0.0.1:8081"
@@ -67,6 +73,8 @@ const (
noAuthProbeURL = "http://127.0.0.1:8085" noAuthProbeURL = "http://127.0.0.1:8085"
anonVoteProbeURL = "http://127.0.0.1:8086" anonVoteProbeURL = "http://127.0.0.1:8086"
hostSiteProbeURL = "http://127.0.0.1:8090" hostSiteProbeURL = "http://127.0.0.1:8090"
httpsProbeURL = "https://127.0.0.1:8443"
httpsHostProbeURL = "https://127.0.0.1:8444"
mailpitURL = "http://127.0.0.1:8025" mailpitURL = "http://127.0.0.1:8025"
composeFile = "../compose-e2e-test.yml" composeFile = "../compose-e2e-test.yml"
@@ -112,7 +120,12 @@ var (
// the default client has no timeout, so a port that accepts and then stalls would block // the default client has no timeout, so a port that accepts and then stalls would block
// a probe well past its own deadline and leave TestMain looking hung // a probe well past its own deadline and leave TestMain looking hung
probeClient = &http.Client{Timeout: 5 * time.Second} probeClient = &http.Client{
Timeout: 5 * time.Second,
// the https services in the stack are self-signed, and this client only ever talks to
// them, so refusing the certificate would only stop the readiness probe
Transport: &http.Transport{TLSClientConfig: &tls.Config{InsecureSkipVerify: true}}, //nolint:gosec // test stack
}
) )
// everything under /auth/ is rate limited to 2 requests a second, and that figure is a bare // everything under /auth/ is rate limited to 2 requests a second, and that figure is a bare
@@ -164,7 +177,8 @@ func TestMain(m *testing.M) {
"--host-resolver-rules=MAP remark42 127.0.0.1, MAP remark42-shortedit 127.0.0.1, " + "--host-resolver-rules=MAP remark42 127.0.0.1, MAP remark42-shortedit 127.0.0.1, " +
"MAP remark42-adminedit 127.0.0.1, MAP remark42-jwtheader 127.0.0.1, " + "MAP remark42-adminedit 127.0.0.1, MAP remark42-jwtheader 127.0.0.1, " +
"MAP remark42-noauth 127.0.0.1, MAP remark42-anonvote 127.0.0.1, " + "MAP remark42-noauth 127.0.0.1, MAP remark42-anonvote 127.0.0.1, " +
"MAP host-site 127.0.0.1", "MAP host-site 127.0.0.1, " +
"MAP remark42-https 127.0.0.1, MAP host-site-https 127.0.0.1",
}, },
}) })
if err != nil { if err != nil {
@@ -203,6 +217,11 @@ func ensureStack() error {
return assertStackMatches(stamp, true) return assertStackMatches(stamp, true)
} }
// the https services will not start without one, and compose cannot make it itself
if out, gerr := exec.Command("./tls/generate.sh").CombinedOutput(); gerr != nil {
return fmt.Errorf("generating the test certificate: %w\n%s", gerr, out)
}
log.Printf("[INFO] no complete stack on 127.0.0.1, bringing one up from %s", composeFile) log.Printf("[INFO] no complete stack on 127.0.0.1, bringing one up from %s", composeFile)
ctx, cancel := context.WithTimeout(context.Background(), 15*time.Minute) ctx, cancel := context.WithTimeout(context.Background(), 15*time.Minute)
defer cancel() defer cancel()
@@ -245,6 +264,8 @@ func stackReady(timeout time.Duration) bool {
noAuthProbeURL + "/ping", noAuthProbeURL + "/ping",
anonVoteProbeURL + "/ping", anonVoteProbeURL + "/ping",
hostSiteProbeURL + "/post.html", hostSiteProbeURL + "/post.html",
httpsProbeURL + "/ping",
httpsHostProbeURL + "/post-https.html",
mailpitURL + "/api/v1/messages", mailpitURL + "/api/v1/messages",
} { } {
if err := serverReady(url, timeout); err != nil { if err := serverReady(url, timeout); err != nil {
@@ -306,6 +327,10 @@ func newPageOn(t *testing.T, b playwright.Browser) playwright.Page {
// says about itself is the thing under test // says about itself is the thing under test
func newPageInContext(t *testing.T, b playwright.Browser, opts playwright.BrowserNewContextOptions) playwright.Page { func newPageInContext(t *testing.T, b playwright.Browser, opts playwright.BrowserNewContextOptions) playwright.Page {
t.Helper() t.Helper()
// the https services carry a self-signed certificate, and a context that refuses it cannot
// reach them at all. harmless for the http ones
opts.IgnoreHttpsErrors = playwright.Bool(true)
ctx, err := b.NewContext(opts) ctx, err := b.NewContext(opts)
require.NoError(t, err) require.NoError(t, err)
+34
View File
@@ -0,0 +1,34 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>A page on somebody else's site, over TLS</title>
</head>
<body>
<h1>A page on somebody else's site, over TLS</h1>
<p>
Served from a different origin than the comments it embeds, and over https, which is the only
way the widget's cookies can carry Secure, SameSite=None and Partitioned.
</p>
<div id="remark42"></div>
<script>
var remark_config = {
host: 'https://remark42-https:8443',
site_id: 'remark',
components: ['embed'],
url: window.location.href,
};
(function (c, d) {
for (var i = 0; i < c.length; i++) {
var s = d.createElement('script');
s.type = 'module';
s.async = true;
s.defer = true;
s.src = remark_config.host + '/web/' + c[i] + '.mjs';
(d.head || d.body).appendChild(s);
}
})(remark_config.components, document);
</script>
</body>
</html>
+324
View File
@@ -0,0 +1,324 @@
//go:build e2e
package e2e
import (
"fmt"
"os"
"slices"
"strings"
"testing"
"github.com/mxschmitt/playwright-go"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
// Everything else in this suite speaks http, which hides an entire class of defect: the browser
// gates Secure cookies, SameSite=None, Partitioned and anything reading location.protocol on the
// page protocol, so code taking those paths is never executed. setAuthCookie decorating its
// cookies with __Host- on https pages survived for exactly that reason.
//
// These run against the TLS pair in compose-e2e-test.yml, which carries a self-signed certificate
// every context here accepts. That instance also runs with AUTH_SEND_JWT_HEADER, so the widget
// writes its own cookies through setAuthCookie: without it the client-side writer never runs on
// any https page in the stack and every assertion about the attributes it chooses is vacuous.
// An unpartitioned third-party cookie is refused only when storage partitioning is enforced, and
// playwright's own default arguments disable it. Dropping that default and re-supplying it without
// the one feature is the only lever; see "What this suite cannot reach" in the README.
//
// The list is playwright's own and therefore version-specific. It is not trusted on its own: the
// case using it asserts a control first, so a list that stops matching fails as itself.
const (
playwrightDisabledFeatures = "--disable-features=AvoidUnnecessaryBeforeUnloadCheckSync," +
"BoundaryEventDispatchTracksNodeRemoval,DestroyProfileOnBrowserClose,DialMediaRouteProvider," +
"GlobalMediaControls,HttpsUpgrades,LensOverlay,MediaRouter,PaintHolding," +
"ThirdPartyStoragePartitioning,BlockOriginHeaderModificationOnRedirect,Translate,AutoDeElevate," +
"OptimizationHints,msForceBrowserSignIn,msEdgeUpdateLaunchServicesPreferredVersion"
// the one entry that has to go, named once
partitioningFeature = "ThirdPartyStoragePartitioning,"
)
// withPartitioningEnabled is playwright's own list with the one feature removed, derived rather
// than written out again: the two differ by a single entry in three hundred characters, and a
// second copy is a thing to forget on the next playwright bump
func withPartitioningEnabled(t *testing.T) string {
t.Helper()
out := strings.Replace(playwrightDisabledFeatures, partitioningFeature, "", 1)
require.NotEqual(t, playwrightDisabledFeatures, out,
"%q is no longer in playwright's default argument list, so removing it enables nothing and "+
"this browser would block no cookie at all", partitioningFeature)
return out
}
// The flows worth measuring in a third-party frame. OAuth is absent on purpose: the provider
// callback lands in a popup, which is a top-level context of its own, so the cookie set there is
// keyed to the auth host and never reaches the frame. Telegram is absent because the stack cannot
// answer as Telegram, see #2208.
//
// Email as well as anonymous because the widget's writer keys off the X-JWT header rather than off
// the provider, so the two are expected to behave alike. Expected is not measured, and email is the
// flow an operator running off-domain actually reaches for
var httpsFlows = []struct {
name string
signIn func(t *testing.T, page playwright.Page, frame playwright.FrameLocator)
}{
{"anonymous", func(t *testing.T, page playwright.Page, frame playwright.FrameLocator) {
signInAnon(t, page, frame, anonName("httpsreader"))
}},
{"email", func(t *testing.T, page playwright.Page, frame playwright.FrameLocator) {
// the address decides the user id and the mailbox this reads back, so it carries the run
// id and the case: mailpit keeps everything, and a shared address would let one case read
// the token another asked for
signInEmail(t, page, frame, "httpsemail",
fmt.Sprintf("https-email-%s-%s@example.com", strings.ReplaceAll(t.Name(), "/", "-"), runID))
}},
}
// httpsThread is a thread on the TLS host page, which is a different site from the widget's own
// origin, so the widget's cookies there are genuinely third-party
func httpsThread(t *testing.T, label string) string {
t.Helper()
return fmt.Sprintf("%s/post-https.html?e2e=%s-%s", httpsHostSiteURL, label, runID)
}
// TestHTTPS_CrossOriginSignInSurvivesAReload is what the http cross-origin case cannot assert.
// The widget keeps its token in memory for the life of a page, so signing in and posting proves
// nothing about persistence: only a reload asks whether the cookie was delivered, stored under a
// name the backend reads, and sent back from a third-party frame. On http that cookie cannot even
// be written, since the third-party form requires Secure.
//
// This runs under the browser's default policy, where third-party cookies are allowed.
// TestHTTPS_SessionSurvivesThirdPartyCookieBlocking is the same question with them blocked.
func TestHTTPS_CrossOriginSignInSurvivesAReload(t *testing.T) {
for _, flow := range httpsFlows {
t.Run(flow.name, func(t *testing.T) {
page := newPage(t)
pauseForAuthLimit()
_, err := page.Goto(httpsThread(t, "https-signin-"+flow.name))
require.NoError(t, err)
frame := widget(t, page)
flow.signIn(t, page, frame)
text := "posted over tls by " + flow.name + " " + runID
postComment(t, frame, text)
// the assertion the whole file exists for
pauseForAuthLimit()
_, err = page.Reload()
require.NoError(t, err)
frame = widget(t, page)
assertSignedIn(t, page, frame)
waitVisible(t, comment(frame, text))
})
}
}
// TestHTTPS_AuthCookiesCarryTheThirdPartyForm reads the cookies the browser actually stored for
// the widget's origin while it is embedded elsewhere. A cookie the browser refused is not in this
// list at all, and one the browser kept but will not send from a frame is worse than useless, so
// the attributes are the assertion and not the sign-in they enable.
//
// Both cookies are checked and not the JWT alone: the fetcher reads XSRF-TOKEN and returns its
// value as a header, and go-pkgz/auth refuses a cookie-borne token whose header does not match, so
// a JWT arriving beside an XSRF cookie the frame cannot receive authenticates nobody.
func TestHTTPS_AuthCookiesCarryTheThirdPartyForm(t *testing.T) {
page := newPage(t)
pauseForAuthLimit()
_, err := page.Goto(httpsThread(t, "https-cookies"))
require.NoError(t, err)
frame := widget(t, page)
signInAnon(t, page, frame, anonName("httpscookies"))
cookies, err := page.Context().Cookies()
require.NoError(t, err)
// both writers are in play here: the backend sets its own pair, and the widget sets a
// partitioned pair of the same names through setAuthCookie. Every copy has to be usable from
// a third-party frame, and the partitioned one has to exist, or the assertions below would be
// reading the server's cookie and saying nothing about the client's
for _, name := range []string{"JWT", "XSRF-TOKEN"} {
var partitioned int
var seen int
for _, c := range cookies {
if c.Name != name {
continue
}
seen++
assert.True(t, c.Secure, "a %s cookie is not Secure, so a third-party frame can never receive it", name)
require.NotNil(t, c.SameSite, "a %s cookie carries no SameSite at all", name)
assert.Equal(t, *playwright.SameSiteAttributeNone, *c.SameSite,
"a %s cookie is not SameSite=None, and SameSite is judged against the top-level site, so "+
"anything stricter is never sent from an embedded widget", name)
if c.PartitionKey != nil {
partitioned++
}
}
require.NotZero(t, seen, "no %s cookie was stored at all, so the browser refused what was sent: %v",
name, cookieNames(cookies))
assert.NotZero(t, partitioned,
"no partitioned %s cookie was stored, so setAuthCookie either did not run or chose attributes "+
"a blocking browser will drop", name)
}
// the XSRF value has to be readable by the widget's own script, which is what puts it in the
// header the backend matches the token against
for _, c := range cookies {
if c.Name == "XSRF-TOKEN" {
assert.False(t, c.HttpOnly, "the XSRF cookie has to be readable by the widget's own script")
}
}
// no name the server does not read. A __Host- prefixed cookie is a perfectly valid cookie the
// browser stores happily, which is why writing one is a defect nothing rejects: the backend
// looks for JWT and the fetcher reads XSRF-TOKEN, and neither finds a decorated name.
//
// this can only fail because the instance runs with AUTH_SEND_JWT_HEADER, which is what makes
// the widget write cookies of its own instead of leaving the server's pair alone.
for _, c := range cookies {
assert.NotContains(t, c.Name, "__Host-",
"a __Host- prefixed cookie was stored, and nothing on either side reads that name")
}
}
// TestHTTPS_SessionSurvivesThirdPartyCookieBlocking is the reload question under the policy that
// makes it hard. With storage partitioning enforced an ordinary third-party cookie is dropped, so
// the session survives only because the widget's own cookies carry Partitioned; the server's pair
// does not, and vanishes.
//
// The control comes first and is not decoration: playwright's default arguments disable the policy
// outright, so a run configured wrongly keeps every third-party cookie and this case would pass
// while asserting nothing at all.
func TestHTTPS_SessionSurvivesThirdPartyCookieBlocking(t *testing.T) {
blocking, err := pw.Chromium.Launch(playwright.BrowserTypeLaunchOptions{
Headless: playwright.Bool(os.Getenv("E2E_HEADLESS") != "false"),
IgnoreDefaultArgs: []string{playwrightDisabledFeatures},
Args: []string{
withPartitioningEnabled(t),
"--test-third-party-cookie-phaseout",
"--host-resolver-rules=MAP remark42-https 127.0.0.1, MAP host-site-https 127.0.0.1",
},
})
require.NoError(t, err)
t.Cleanup(func() { _ = blocking.Close() })
for _, flow := range httpsFlows {
t.Run(flow.name, func(t *testing.T) {
// a context of its own, so neither case inherits what the other stored
page := newPageOn(t, blocking)
pauseForAuthLimit()
_, err := page.Goto(httpsThread(t, "https-blocked-"+flow.name))
require.NoError(t, err)
frame := widget(t, page)
assertPartitioningEnforced(t, page)
flow.signIn(t, page, frame)
// the chain this case rests on, asserted before the reload can fail on the end of it:
// the server sends X-JWT only under AUTH_SEND_JWT_HEADER, setAuthCookie writes its own
// pair only when the fetcher sees that header, and only that pair carries Partitioned,
// since the server's own cookies carry none. drop the flag from the service and the
// reload below signs nobody in, which reads as a defect in cookie handling instead of a
// stack that cannot test it
written, err := page.Context().Cookies()
require.NoError(t, err)
require.True(t, slices.ContainsFunc(written, func(c playwright.Cookie) bool {
return c.Name == "JWT" && c.PartitionKey != nil
}), "no partitioned JWT cookie was written before the reload, so the widget's own writer never ran: "+
"remark42-https is most likely no longer configured with AUTH_SEND_JWT_HEADER. stored: %v",
cookieNames(written))
pauseForAuthLimit()
_, err = page.Reload()
require.NoError(t, err)
frame = widget(t, page)
assertSignedIn(t, page, frame)
// and it survived because the widget's own cookies are partitioned, which is the only
// form a blocking browser keeps
cookies, err := page.Context().Cookies()
require.NoError(t, err)
for _, name := range []string{"JWT", "XSRF-TOKEN"} {
var stored *playwright.Cookie
for i, c := range cookies {
if c.Name == name {
stored = &cookies[i]
break
}
}
require.NotNil(t, stored, "no %s cookie survived the blocking browser: %v", name, cookieNames(cookies))
assert.NotNil(t, stored.PartitionKey,
"the %s cookie is not partitioned, so it only survived because the browser was not blocking", name)
}
})
}
}
// assertPartitioningEnforced proves the browser refuses an ordinary third-party cookie before any
// case leans on it. Both cookies are written and read back inside a single frame evaluate, and the
// read is `document.cookie` rather than the context's cookie list, because the two are different
// channels with no ordering between them.
//
// Pinned to a build rather than stated as a rule: playwright 1.62.1 ships chromium 151.0.7922.34,
// where Blink's CookieJar::SetCookie queues the write and returns without a completion callback,
// and the renderer's own document.cookie getter is the barrier that forces the pending write to
// settle. Playwright's Context().Cookies() is a browser-session Storage.getCookies that never
// touches that frame's jar, so reading the control through it can find the name absent because the
// write has not landed yet, which is precisely the outcome the control exists to rule out. An
// implementation is free to serialize both calls in the browser process, so this is what to
// re-check on a playwright bump.
//
// The sentinel is the positive half and it has to come first: a valid third-party cookie proves the
// write path and the partitioned path are both live, and only then does the control's absence mean
// the browser turned it down rather than that nothing was written at all
func assertPartitioningEnforced(t *testing.T, page playwright.Page) {
t.Helper()
const (
sentinel = "e2esentinel"
control = "e2econtrol"
)
// one evaluate: both writes, then the getter that settles them, returned as separate answers so
// a missing sentinel and a surviving control stay distinguishable
raw, err := page.FrameLocator("#remark42 iframe").Locator("body").Evaluate(`() => {
document.cookie = 'e2econtrol=1; Path=/; Secure; SameSite=None';
document.cookie = 'e2esentinel=1; Path=/; Secure; SameSite=None; Partitioned';
const names = document.cookie.split(';').map((c) => c.trim().split('=')[0]);
return { sentinel: names.includes('e2esentinel'), control: names.includes('e2econtrol'), all: names };
}`, nil)
require.NoError(t, err)
got, ok := raw.(map[string]any)
require.True(t, ok, "expected an object from the frame, got %T (%v)", raw, raw)
require.Equal(t, true, got["sentinel"],
"a %s cookie in the third-party form the browser still accepts was not stored, so nothing was "+
"written at all and the absence of %s below would mean nothing. cookies in the frame: %v",
sentinel, control, got["all"])
require.Equal(t, false, got["control"],
"an ordinary third-party %s cookie survived alongside the partitioned %s, so this browser is "+
"not partitioning storage and nothing here is being tested. playwright's default argument "+
"list has most likely changed: see playwrightDisabledFeatures. cookies in the frame: %v",
control, sentinel, got["all"])
}
func cookieNames(cookies []playwright.Cookie) []string {
out := make([]string, 0, len(cookies))
for _, c := range cookies {
out = append(out, c.Name)
}
return out
}
+28
View File
@@ -0,0 +1,28 @@
#!/bin/sh
# Self-signed certificate for the https services in the e2e stack.
#
# The suite passes IgnoreHTTPSErrors, so the certificate is never validated and its contents do
# not have to satisfy anything. It carries the right names anyway, which removes the name mismatch
# from the list of complaints when somebody looks at the stack by hand. The issuer is still unknown,
# so curl needs -k and a browser needs an exception either way.
#
# Regenerated only when missing: a fresh certificate on every stack-up would give the running
# services one the containers were not started with, since nginx and remark42 read it once.
set -eu
cd "$(dirname "$0")"
if [ -f cert.pem ] && [ -f key.pem ]; then
exit 0
fi
# stdout only. openssl writes its progress to stderr and its errors there too, and dropping both
# leaves every caller with a bare exit code: the CI step, `make e2e-up` and ensureStack all print
# nothing about why the certificate could not be made
openssl req -x509 -newkey rsa:2048 -nodes -days 3650 \
-keyout key.pem -out cert.pem \
-subj "/CN=remark42-e2e" \
-addext "subjectAltName=DNS:remark42-https,DNS:host-site-https,DNS:localhost,IP:127.0.0.1" \
>/dev/null
chmod 644 key.pem cert.pem
+22
View File
@@ -0,0 +1,22 @@
# the published listener, which is what the suite and the browser use
server {
listen 443 ssl;
server_name host-site-https;
ssl_certificate /etc/nginx/tls/cert.pem;
ssl_certificate_key /etc/nginx/tls/key.pem;
root /usr/share/nginx/html;
index post-https.html;
}
# for the container healthcheck only, and not published. busybox wget, which is all this image
# carries, has no TLS, so a check against the listener above cannot tell "not started yet" from
# "cannot speak https at all"
server {
listen 80;
server_name localhost;
root /usr/share/nginx/html;
index post-https.html;
}
-37
View File
@@ -11,7 +11,6 @@ import (
"net/http" "net/http"
"os" "os"
"os/exec" "os/exec"
"regexp"
"slices" "slices"
"strings" "strings"
"sync" "sync"
@@ -265,39 +264,3 @@ func pauseForWebLimit() {
} }
lastWebGet = time.Now() lastWebGet = time.Now()
} }
// TestWeb_NoBundleHardcodesTheWebRoot pins the fix for #2203, which shipped with no test at any
// level. The bundler used to bake a fixed public path into every entry, so an instance mounted
// under a prefix, which manuals/subdomain documents, asked the domain root for its provider icons
// and got nothing. The path is derived from the URL the bundle was loaded from now, which is
// correct for both arrangements.
//
// What separates the two builds is the assignment webpack emits for its runtime public path: a
// literal when the path is fixed, and a computed value when it is derived. Asset filenames appear
// bare either way, so a case looking for a rooted "/web/name.svg" string finds nothing in either
// build and proves nothing; this asserts the assignment instead.
//
// Every emitted bundle is checked rather than the obvious one: the original defect put fifteen
// icons in remark.mjs and one in last-comments.mjs, so a case reading a single entry would have
// gone green with half of it still live.
func TestWeb_NoBundleHardcodesTheWebRoot(t *testing.T) {
names := emittedBundles(t)
require.Contains(t, names, "remark.mjs", "listing is not the served web root: %v", names)
require.Contains(t, names, "last-comments.mjs",
"the entry carrying the second half of #2203 is missing from the listing: %v", names)
// webpack writes its public path to the `p` property of the runtime object. A baked-in path
// is a string literal there; a derived one is an expression
baked := regexp.MustCompile("\\.p\\s*=\\s*[\"'`]/web/[\"'`]")
for _, name := range names {
t.Run(name, func(t *testing.T) {
body := getWeb(t, "/web/"+name).body
require.NotEmpty(t, body, "%s serves nothing, so this asserts nothing", name)
assert.NotRegexp(t, baked, string(body),
"%s bakes the public path in rather than deriving it, so an instance mounted under "+
"a prefix fetches its assets from the domain root", name)
})
}
}
-2
View File
@@ -10,8 +10,6 @@ if (document.readyState === 'loading') {
} }
async function init(): Promise<void> { async function init(): Promise<void> {
__webpack_public_path__ = `${window.location.origin}/web/`;
const node = document.getElementById(NODE_ID); const node = document.getElementById(NODE_ID);
if (!node) { if (!node) {
@@ -78,9 +78,9 @@ services:
| image.resize-width | IMAGE_RESIZE_WIDTH | `2400` | width of a resized image | | image.resize-width | IMAGE_RESIZE_WIDTH | `2400` | width of a resized image |
| image.resize-height | IMAGE_RESIZE_HEIGHT | `900` | height of a resized image | | image.resize-height | IMAGE_RESIZE_HEIGHT | `900` | height of a resized image |
| auth.ttl.jwt | AUTH_TTL_JWT | `5m` | JWT TTL | | auth.ttl.jwt | AUTH_TTL_JWT | `5m` | JWT TTL |
| auth.ttl.cookie | AUTH_TTL_COOKIE | `200h` | cookie TTL | | auth.ttl.cookie | AUTH_TTL_COOKIE | `200h` | TTL of the server-set auth cookie. Note it does not govern the cookie the frontend writes under `auth.send-jwt-header`, which is fixed at 200h |
| auth.send-jwt-header | AUTH_SEND_JWT_HEADER | `false` | send JWT as a header instead of a server-set cookie; with this enabled, frontend stores the JWT in a client-side cookie. [See security considerations](#security-considerations-for-authsend-jwt-header). | | auth.send-jwt-header | AUTH_SEND_JWT_HEADER | `false` | also send JWT as a header, so the frontend can store it in a client-side cookie that survives third-party cookie blocking; the server-set cookies are still sent. [See security considerations](#security-considerations-for-authsend-jwt-header). |
| auth.same-site | AUTH_SAME_SITE | `default` | set same site policy for cookies (`default`, `none`, `lax` or `strict`) | | auth.same-site | AUTH_SAME_SITE | `default` | SameSite attribute for the server-set auth cookies (`default`, `none`, `lax` or `strict`). `default` emits no attribute at all and leaves the choice to the browser, which is not the same as `lax` |
| auth.apple.cid | AUTH_APPLE_CID | | Apple client ID (App ID or Services ID) | | auth.apple.cid | AUTH_APPLE_CID | | Apple client ID (App ID or Services ID) |
| auth.apple.tid | AUTH_APPLE_TID | | Apple service ID | | auth.apple.tid | AUTH_APPLE_TID | | Apple service ID |
| auth.apple.kid | AUTH_APPLE_KID | | Apple Private key ID | | auth.apple.kid | AUTH_APPLE_KID | | Apple Private key ID |
@@ -194,9 +194,14 @@ When `auth.send-jwt-header=true` is enabled:
- **Security Impact**: JWT tokens are stored in client-accessible cookies that can be accessed by JavaScript - **Security Impact**: JWT tokens are stored in client-accessible cookies that can be accessed by JavaScript
- **Vulnerability**: This increases vulnerability to XSS attacks compared to server-set HttpOnly cookies - **Vulnerability**: This increases vulnerability to XSS attacks compared to server-set HttpOnly cookies
- **Implementation Mitigations**: - **Implementation Mitigations**:
- SameSite=Strict cookies to prevent CSRF attacks - `SameSite=Strict` when the widget and the page share an origin, which is what prevents the
cookie being sent from another site
- `SameSite=None; Secure; Partitioned` when the widget is embedded on another domain, where
`Strict` would never be sent at all. `Partitioned` keys the cookie to the embedding top-level
site, so a different site gets a separate cookie and cannot reach this one. Pages and
subdomains under that same site do share it, since the partition key is the site rather than
the page
- Secure flag automatically added on HTTPS connections - Secure flag automatically added on HTTPS connections
- __Host- prefix added on HTTPS to prevent subdomain attacks
- Double Submit Cookie pattern with XSRF token matching the JWT ID - Double Submit Cookie pattern with XSRF token matching the JWT ID
This configuration should only be used when: This configuration should only be used when:
@@ -6,23 +6,78 @@ title: Configure Instance on a different domain
### What doesn't work so far? ### What doesn't work so far?
Unless discussion [#1139](https://github.com/umputun/remark42/discussions/1139) has a marked answer, authorisation using oAuth like GitHub or Google is impossible on domains other than the original one. Telegram, Email and anonymous auth would work everywhere. Unless discussion [#1139](https://github.com/umputun/remark42/discussions/1139) has a marked answer, authorisation using oAuth like GitHub or Google is impossible on domains other than the original one. Telegram, Email and anonymous auth work on allowed HTTPS embedding domains when `AUTH_SEND_JWT_HEADER=true`.
### Setup ### Setup
Set `ALLOWED_HOSTS="'self',https://example1.org,https://example2.org"` with your domain names and `AUTH_SAME_SITE=none`. Set `ALLOWED_HOSTS="'self',https://example1.org,https://example2.org"` with your domain names, and `AUTH_SEND_JWT_HEADER=true`.
`AUTH_SEND_JWT_HEADER` is what keeps a reader signed in across a page reload on Safari, in Chrome Incognito, and in any browser configured to block third-party cookies. Read [its security considerations](../../configuration/parameters/#security-considerations-for-authsend-jwt-header) before enabling it: it puts the token in a cookie JavaScript can read, which costs XSS exposure that a server-set `HttpOnly` cookie does not.
**`AUTH_SAME_SITE=none` is not needed alongside it**, which reverses what this page recommended for years, so it is worth showing the measurement instead of asserting it. Signing in anonymously from an embedded widget over https and dumping the browser's cookie jar gives, with the setting:
| name | httpOnly | partition key | written by |
| --- | --- | --- | --- |
| `JWT` | yes | none | the server |
| `XSRF-TOKEN` | no | none | the server |
| `JWT` | no | the embedding site | the widget |
| `XSRF-TOKEN` | no | the embedding site | the widget |
and without it, only the widget's own partitioned pair. Sign-in, posting and the reload all work either way, in a permissive browser and in one blocking third-party cookies. What the setting adds is the unpartitioned `HttpOnly` `JWT` in the first row, delivered as a third-party cookie to every listed domain wherever the browser still permits that. Nothing needs it, so leaving it at the default is the smaller exposure.
Keep `AUTH_SAME_SITE=none` if you are *not* setting `AUTH_SEND_JWT_HEADER`. Then the server's cookies are the only ones there are, and this is what allows them to be set off-domain at all, for as long as the reader's browser still accepts unpartitioned third-party cookies.
The `'self'` in `ALLOWED_HOSTS` value means "domain where Remark42 is installed on" and needed if you want `remark42.example.com/web/` to work in case you want to test something with it. The `'self'` in `ALLOWED_HOSTS` value means "domain where Remark42 is installed on" and needed if you want `remark42.example.com/web/` to work in case you want to test something with it.
### Technical details ### Technical details
`ALLOWED_HOSTS` sets CSP [frame-ancestors](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/frame-ancestors), which, once enabled, limits the domains where Remark42 would work. The default value is `*` so that it would work on any domain`. `ALLOWED_HOSTS` sets CSP [frame-ancestors](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/frame-ancestors), which, once enabled, limits the domains where Remark42 would work. The default value is `*` so that it would work on any domain.
`AUTH_SAME_SITE` sets the [SAME_SITE](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite) attribute for authorisation cookies, allowing Remark42 either on the original domain and subdomains there (default value, which equals to `Lax`) or allows setting authorisation cookies on any domain where remark42 is shown (`None` setting). `AUTH_SAME_SITE` sets the [SameSite](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite) attribute on the cookies the server sets. `none` lets those cookies be set on any domain where Remark42 is shown.
The `default` setting does not mean `Lax`. It means Remark42 emits no `SameSite` attribute at all and leaves the choice to the browser, and browsers differ: Chromium treats a missing attribute as `Lax` and so refuses the cookie cross-site, while Firefox accepts it. That difference is not a detail, because it decides which of the two cookie pairs below a reader actually ends up with.
`SameSite=None` is not sufficient on its own, and with `AUTH_SEND_JWT_HEADER` it is not necessary either. A browser that blocks third-party cookies drops a cookie set by Remark42 for a reader on another domain no matter what its `SameSite` value is, unless the cookie is explicitly marked [`Partitioned`](https://developer.mozilla.org/en-US/docs/Web/Privacy/Privacy_sandbox/Partitioned_cookies), and the server-set cookies are not. `AUTH_SEND_JWT_HEADER=true` is what closes that: the token comes back in an `X-JWT` response header and the widget stores it in its own cookie, written from inside the embedded frame and marked `SameSite=None; Secure; Partitioned`, so the browser keeps it for that embedding site and sends it back after a reload. That cookie is the widget's own doing and owes nothing to `AUTH_SAME_SITE`, which reaches only the pair the server sets.
A browser that refuses a cross-site `Set-Cookie` lacking `SameSite=None` refuses it outright, so with the setting left at its default the server's pair is absent from the jar, not present with a stricter attribute.
Note that this applies to Email, Telegram and anonymous authorisation, which the widget performs from inside the frame. It does not rescue oAuth, which completes in a popup that is a top-level page of its own, so the cookie set there belongs to the Remark42 domain and the embedded frame never sees it.
### What each browser actually does
Measured on real domains over real certificates, with Remark42 on one registrable domain and the
host page on another, signing in and then reloading. Every "blocked" column below was verified with
a control cookie: an ordinary third-party cookie written from inside the widget frame has to be
dropped, or the run is not blocking anything and proves nothing.
| configuration | Chrome, default | Chrome, third-party cookies blocked | Firefox, default | Firefox, "block all third-party" | Safari |
| --- | --- | --- | --- | --- | --- |
| `AUTH_SEND_JWT_HEADER` only | works | works | works | fails | works |
| `AUTH_SAME_SITE=none` only | works | fails | works | fails | fails |
| both | works | works | works | fails | works |
Three things in that table are worth spelling out.
**Safari needs no configuring to break the old recipe.** It blocks third-party cookies out of the
box, so `AUTH_SAME_SITE=none` on its own has already stopped working there for every reader. This
is not a future deprecation to plan for.
**Firefox reaches "works" by a different route, and a weaker one.** Chrome and Safari refuse the
server's cookie when it carries no `SameSite` attribute, which leaves the field clear for the
widget to write its own partitioned pair. Firefox accepts that cookie, and because the server's
`JWT` is `HttpOnly`, the browser then refuses to let the widget's script overwrite it: a cookie set
by JavaScript may not replace an `HttpOnly` one of the same name. So on Firefox the session rides
on an ordinary unpartitioned third-party cookie even with the header flag on, and it disappears the
moment the reader blocks those.
**No configuration survives Firefox's "block all third-party cookies" setting.** That mode discards
partitioned cookies too, so the `Partitioned` escape hatch does not apply. A reader who has turned
it on cannot stay signed in on an embedded widget, and nothing in Remark42 can change that.
Here are all possible combinations of these two: Here are all possible combinations of these two:
- Default setup with unaltered variables: comments are shown on any domain, but the authorisation wouldn't work anywhere, except on the same domain Remark42 is installed on and subdomains of it. - Default setup with unaltered variables: comments are shown on any domain, but the authorisation wouldn't work anywhere, except on the same domain Remark42 is installed on and subdomains of it.
- `ALLOWED_HOSTS` set to a set of domains: comments are shown only on listed domains, and authorisation wouldn't work anywhere, expect on the same domain Remark42 is installed on and subdomains of it. - `ALLOWED_HOSTS` set to a set of domains: comments are shown only on listed domains, and authorisation wouldn't work anywhere, except on the same domain Remark42 is installed on and subdomains of it.
- `AUTH_SAME_SITE` set to `None`: comments are shown on any domain. The authorisation would work anywhere. - `AUTH_SAME_SITE` set to `None`: comments are shown on any domain. Authorisation works on browsers that still permit third-party cookies, and stops working on the ones that block them.
- `ALLOWED_HOSTS` set to a set of domains and `AUTH_SAME_SITE` set to `None`: comments are shown on listed domains. The authorisation would work on all of them. - `ALLOWED_HOSTS` set to a set of domains and `AUTH_SAME_SITE` set to `None`: comments are shown on listed domains, with the same authorisation caveat.
- `ALLOWED_HOSTS` and `AUTH_SEND_JWT_HEADER=true`, with `AUTH_SAME_SITE` left alone: comments are shown on listed domains, and Email, Telegram and anonymous authorisation survives a reload whatever the browser's third-party cookie policy. This is the recommended arrangement. Adding `AUTH_SAME_SITE=none` on top changes nothing about whether a reader stays signed in; it only adds the server's unpartitioned cookies where the browser still takes them.