[5.x]: Session authorizations get lost with `yii\redis\Session`: "View" on a disabled element answers 403, then "Invalid token"
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 15/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- php, redis
- Domain
- authorization, backend
Research direction
Start with Session::authorize() called from ElementsController (around line 363) and SessionBehavior::authorize()/deauthorize(), which append to session data read when the session opened. Then read PreviewController::actionCreateToken() and createPreviewLink() in the element editor JS. Reproduce with the two overlapping curl requests in the issue, then check that B's authorization survives A's later session write.
Written by the indexing model from the issue text.
Description
What happened?
Description
With sessions on yii\redis\Session (the Redis example in the docs), a session authorization granted by one request is lost when another request of the same session was already running and finishes later. In the control panel it shows like this:
- Open the edit page of an element that is not live and click View:
preview/create-tokenanswers 403 "User is not authorized to perform this action" (requireAuthorization('previewElement:<id>')). - Click View again: the link now goes straight to the site with the pre-generated token, which was never saved, so the site answers 400 "Invalid token".
Cause, as far as I can tell:
- The edit page grants
previewElement:<id>(orpreviewDraft:,previewRevision:) throughSession::authorize()(ElementsController, around line 363 in 5.11.5). SessionBehavior::authorize()takes theauthAccessmutex, but appends to the session data that was read when the session was opened.yii\redis\Sessiondoes not lock and writes the whole session at the end of the request.- Request A reads the session. Request B (the edit page) grants its authorization and finishes. Then A finishes and writes its older copy, and B's authorization is gone. The mutex does not cover A's read and write.
- The second symptom comes from
createPreviewLink()in the element editor JS. Its click handler callsactivatePreviewToken()1 ms after the click, whether or notpreview/create-tokensucceeded, and rewrites the View links to the tokenized URL.
The other session authorizations go through the same method (editStructure:, reorderNestedElements::, saveAssets:, graphql-schema:), so I would expect them to be affected in the same way. I have not tested those.
Steps to reproduce
- Configure the
sessioncomponent withyii\redis\Sessionas in https://craftcms.com/docs/5.x/reference/config/app.html#session - Log in to the control panel and keep the session cookie (
jar.txt). Pick two elements with preview targets whose edit pages this session has not opened yet: A with the slower edit page, B with the faster one. - Load both edit pages so that A starts first and ends last:
curl -s -b jar.txt -o /dev/null "$CP/<edit page of A>" &
sleep 0.05
curl -s -b jar.txt -o b.html "$CP/<edit page of B>"
wait
- Take
elementType,canonicalId,siteIdandhashedPreviewTokenfrom the element editor settings inb.htmland request B's View link:
curl -s -b jar.txt -o /dev/null -w '%{http_code}\n' \
"$CP/actions/preview/create-token?elementType=<type>&canonicalId=<B>&siteId=<site>&previewToken=<hashedPreviewToken>&redirect=<url>"
Expected behavior
302 to the redirect URL, and the token is saved.
Actual behavior
403, in 3 of 3 runs. Without the request for A in step 3 it answers 302. Authorizations pile up in the session, so B has to be an element the session has not opened before; otherwise A's older copy already holds B's key.
I reproduced it with Commerce product edit pages. The code path is ElementsController, so I expect entries to behave the same. In production, editors hit it in the browser when edit pages or background requests of one session overlap.
Possible fixes
- In
PreviewController::actionCreateToken(), check the user's permission to view the element instead of, or in addition to, the session authorization. - In
authorize()anddeauthorize(), read the stored value again inside the lock and write it right away, or keep the authorizations in a store with atomic updates. - In the element editor JS, activate the preview token only after
preview/create-tokensucceeded. - Mention in the docs that
yii\redis\Sessiondoes not lock sessions.
Related: #5488 (same 403, closed in 2020 as a hosting session setup).
Craft CMS version
5.11.5
PHP version
8.4
Operating system and version
Linux (DDEV locally, Servd in production)
Database type and version
MySQL 8
Image driver and version
No response
Installed plugins and versions
Craft Commerce 5.7.6 (its product edit pages are what I used for the repro), yiisoft/yii2-redis 2.0.20
- Dominant language
- PHP
- Stars
- 3.6k
- Forks
- 706
- Avg merge
- 10h 12m
- Merged PRs (30d)
- 256
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from craftcms/cms
-
[6.x]: Text in some input fields is clipped at the bottom on WindowsPossibly taken @brianjhanson claimed this 1 day ago. Openbug repo:cms
craftcms/cms#19928 · 1 comment · 1 assignee ·
Maintainers usually reply within 1 day
-
[6.x]: AdminTable not available for plugin index and settings screensPossibly taken @brianjhanson claimed this 2 days ago. Openbug repo:cms
craftcms/cms#19912 · 1 comment · 1 assignee ·
Maintainers usually reply within 1 day
-
[6.x]: No way for custom element types to add top level buttons in toolbar or beside the Save menuPossibly taken @brianjhanson claimed this 2 days ago. Openbug repo:cms
Difficulty 5/5 Over a week Newbie friendliness 15/100
craftcms/cms#19910 · 1 comment · 1 assignee ·
Maintainers usually reply within 1 day
-
[6.x] Licence nag countdown never continues to the control panel, and there's no button to skip itPossibly taken @brandonkelly claimed this 2 days ago. Openbug repo:cms
Difficulty 3/5 1-2 days Newbie friendliness 55/100
craftcms/cms#19895 · 2 comments · 1 assignee ·
Maintainers usually reply within 1 day
-
Improve inner chip stylingPossibly taken @brianjhanson claimed this 3 days ago. Openrepo:cms
craftcms/cms#19885 · 1 comment · 1 assignee ·
Maintainers usually reply within 1 day
Similar issues
-
sync-en
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
sync-en
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 4 days
-
Перевод устарел
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
bug
Difficulty 2/5 Half a day Newbie friendliness 76/100
m3ue/m3u-editor#1604 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
femiwiki/docker-mediawiki#1497 ·
Maintainers usually reply within 1 day