OIDC: persist refresh token #11249

kerryarchibald · 2023-07-12T23:54:32Z

For element-hq/element-web#25708

With element-hq/element-web#25783

Persist refresh token beside accessToken when it is present in credentials.

Checklist

Tests written for new code (and old code if feasible)
Linter and other CI checks pass
Sign-off given on the changes (see CONTRIBUTING.md)

Here's what your changelog entry will look like:

✨ Features

OIDC: persist refresh token (#11249). Contributed by @kerryarchibald.

…save-refresh-token

…atrix-org/matrix-react-sdk into kerry/25708/save-refresh-token

src/Lifecycle.ts

src/utils/oidc/authorize.ts

src/Lifecycle.ts

richvdh

some more nitpicking about comments and documentation. Let's be nice to future maintainers when we/they have to understand this code in a few months' time.

src/Lifecycle.ts

richvdh · 2023-07-25T12:20:47Z

src/Lifecycle.ts

@@ -780,16 +790,18 @@ class AbortLoginAndRebuildStorage extends Error {}
 *
 * @param storageKey key used to store the token
 * @param name eg "access_token" used as initialization vector during encryption
- * @param token
+ *              only used when pickleKey is present to encrypt with
+ * @param token the token to store, when undefined any existing token at the storageKey is removed from storage


Suggested change

* @param token the token to store, when undefined any existing token at the storageKey is removed from storage

* @param token The token to store. When undefined, any existing token at the `storageKey` is removed from storage.

src/Lifecycle.ts

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

kerryarchibald · 2023-09-18T00:12:19Z

@richvdh back after a long hiatus, thanks for your review!

richvdh · 2023-09-18T12:19:27Z

src/Lifecycle.ts

@@ -869,17 +869,16 @@ class AbortLoginAndRebuildStorage extends Error {}
 * Stores in idb, falling back to localStorage
 *
 * @param storageKey key used to store the token
- * @param name eg "access_token" used as initialization vector during encryption
- *              only used when pickleKey is present to encrypt with
+ * @param initializationVector Initialization vector for encrypting the token. Only used when `pickleKey` is present
 * @param token the token to store, when undefined any existing token at the storageKey is removed from storage


this could still use clarification

richvdh

lgtm otherwise, thanks!

@kerryarchibald

Changes in [1.11.45](https://github.com/vector-im/element-web/releases/tag/v1.11.45) (2023-09-29) ================================================================================================= ## 🐛 Bug Fixes * Fix Emoji font on Safari 17 ([\#11673](matrix-org/matrix-react-sdk#11673)). Changes in [1.11.44](https://github.com/vector-im/element-web/releases/tag/v1.11.44) (2023-09-26) ================================================================================================= ## ✨ Features * Make video & voice call buttons pin conference widget if unpinned ([\#11576](matrix-org/matrix-react-sdk#11576)). Fixes vector-im/customer-retainer#72. * OIDC: persist refresh token ([\#11249](matrix-org/matrix-react-sdk#11249)). Contributed by @kerryarchibald. * ElementR: Cross user verification ([\#11364](matrix-org/matrix-react-sdk#11364)). Fixes #25752. Contributed by @florianduros. * Default intentional mentions ([\#11602](matrix-org/matrix-react-sdk#11602)). * Notify users about denied access on ask-to-join rooms ([\#11480](matrix-org/matrix-react-sdk#11480)). Contributed by @nurjinjafar. * Allow setting knock room directory visibility ([\#11529](matrix-org/matrix-react-sdk#11529)). Contributed by @charlynguyen. ## 🐛 Bug Fixes * Revert "Fix regression around FacePile with overflow (#11527)" ([\#11634](matrix-org/matrix-react-sdk#11634)). Fixes #26209. * Escape placeholder before injecting it into the style ([\#11607](matrix-org/matrix-react-sdk#11607)). * Move ViewUser action callback to RoomView ([\#11495](matrix-org/matrix-react-sdk#11495)). Fixes #26040. * Fix room timeline search toggling behaviour edge case ([\#11605](matrix-org/matrix-react-sdk#11605)). Fixes #26105. * Avoid rendering view-message link in RoomKnocksBar unnecessarily ([\#11598](matrix-org/matrix-react-sdk#11598)). Contributed by @charlynguyen. * Use knock rooms sync to reflect the knock state ([\#11596](matrix-org/matrix-react-sdk#11596)). Fixes #26043 and #26044. Contributed by @charlynguyen. * Fix avatar in right panel not using the correct font ([\#11593](matrix-org/matrix-react-sdk#11593)). Fixes #26061. Contributed by @MidhunSureshR. * Add waits in Spotlight Cypress tests, hoping this unflakes them ([\#11590](matrix-org/matrix-react-sdk#11590)). Fixes #26053, #26140 #26139 and #26138. Contributed by @andybalaam. * Fix vertical alignment of default avatar font ([\#11582](matrix-org/matrix-react-sdk#11582)). Fixes #26081. * Fix avatars in public room & space search being flex shrunk ([\#11580](matrix-org/matrix-react-sdk#11580)). Fixes #26133. * Fix EventTile avatars being rendered with a size of 0 instead of hidden ([\#11558](matrix-org/matrix-react-sdk#11558)). Fixes #26075. Changes in [1.11.43](https://github.com/vector-im/element-web/releases/tag/v1.11.43) (2023-09-15) ================================================================================================= (No changes - bumping the version number for an element-desktop release.) Changes in [1.11.42](https://github.com/vector-im/element-web/releases/tag/v1.11.42) (2023-09-13) ================================================================================================= ## 🐛 Bug Fixes * Update Compound to fix Firefox-specific avatar regression ([\#11604](matrix-org/matrix-react-sdk#11604)). Fixes #26155. Changes in [1.11.41](https://github.com/vector-im/element-web/releases/tag/v1.11.41) (2023-09-12) ================================================================================================= ## 🦖 Deprecations * Deprecate customisations in favour of Module API ([\#25736](element-hq/element-web#25736)). Fixes #25733. ## ✨ Features * Make SVGR icons use forward ref ([\#26082](element-hq/element-web#26082)). * Add support for rendering a custom wrapper around Element ([\#25537](element-hq/element-web#25537)). Contributed by @maheichyk. * Allow creating public knock rooms ([\#11481](matrix-org/matrix-react-sdk#11481)). Contributed by @charlynguyen. * Render custom images in reactions according to MSC4027 ([\#11087](matrix-org/matrix-react-sdk#11087)). Contributed by @sumnerevans. * Introduce room knocks bar ([\#11475](matrix-org/matrix-react-sdk#11475)). Contributed by @charlynguyen. * Room header UI updates ([\#11507](matrix-org/matrix-react-sdk#11507)). Fixes #25892. * Remove green "verified" bar for encrypted events ([\#11496](matrix-org/matrix-react-sdk#11496)). * Update member count on room summary update ([\#11488](matrix-org/matrix-react-sdk#11488)). * Support for E2EE in Element Call ([\#11492](matrix-org/matrix-react-sdk#11492)). * Allow requesting to join knock rooms via spotlight ([\#11482](matrix-org/matrix-react-sdk#11482)). Contributed by @charlynguyen. * Lock out the first tab if Element is opened in a second tab. ([\#11425](matrix-org/matrix-react-sdk#11425)). Fixes #25157. * Change avatar to use Compound implementation ([\#11448](matrix-org/matrix-react-sdk#11448)). ## 🐛 Bug Fixes * Fix vertical alignment of default avatar font ([\#11582](matrix-org/matrix-react-sdk#11582)). Fixes #26081. * Fix avatars in public room & space search being flex shrunk ([\#11580](matrix-org/matrix-react-sdk#11580)). Fixes #26133. * Fix EventTile avatars being rendered with a size of 0 instead of hidden ([\#11558](matrix-org/matrix-react-sdk#11558)). Fixes #26075. * Fix compound external assets path in bundle ([\#26069](element-hq/element-web#26069)). * Use RoomStateEvent.Update for knocks ([\#11516](matrix-org/matrix-react-sdk#11516)). Contributed by @charlynguyen. * Prevent event propagation when clicking icon buttons ([\#11515](matrix-org/matrix-react-sdk#11515)). * Only display RoomKnocksBar when feature flag is enabled ([\#11513](matrix-org/matrix-react-sdk#11513)). Contributed by @andybalaam. * Fix avatars of knock members for people tab of room settings ([\#11506](matrix-org/matrix-react-sdk#11506)). Fixes #26083. Contributed by @charlynguyen. * Fixes read receipt avatar offset ([\#11483](matrix-org/matrix-react-sdk#11483)). Fixes #26067, #26064 #26059 and #26061. * Fix avatar defects ([\#11473](matrix-org/matrix-react-sdk#11473)). Fixes #26051 and #26046. * Fix consistent avatar output for Percy ([\#11472](matrix-org/matrix-react-sdk#11472)). Fixes #26049 and #26052. * Fix colour of avatar and colour matching with username ([\#11470](matrix-org/matrix-react-sdk#11470)). Fixes #26042. * Fix incompatibility of Soft Logout with Element-R ([\#11468](matrix-org/matrix-react-sdk#11468)). * Fix instances of double translation and guard translation calls using typescript ([\#11443](matrix-org/matrix-react-sdk#11443)).

@kerryarchibald

…xed, not tried running yet * Make video & voice call buttons pin conference widget if unpinned ([\#11576](matrix-org/matrix-react-sdk#11576)). Fixes vector-im/customer-retainer#72. * OIDC: persist refresh token ([\#11249](matrix-org/matrix-react-sdk#11249)). Contributed by @kerryarchibald. * ElementR: Cross user verification ([\#11364](matrix-org/matrix-react-sdk#11364)). Fixes #25752. Contributed by @florianduros. * Default intentional mentions ([\#11602](matrix-org/matrix-react-sdk#11602)). * Notify users about denied access on ask-to-join rooms ([\#11480](matrix-org/matrix-react-sdk#11480)). Contributed by @nurjinjafar. * Allow setting knock room directory visibility ([\#11529](matrix-org/matrix-react-sdk#11529)). Contributed by @charlynguyen. * Revert "Fix regression around FacePile with overflow (#11527)" ([\#11634](matrix-org/matrix-react-sdk#11634)). Fixes #26209. * Escape placeholder before injecting it into the style ([\#11607](matrix-org/matrix-react-sdk#11607)). * Move ViewUser action callback to RoomView ([\#11495](matrix-org/matrix-react-sdk#11495)). Fixes #26040. * Fix room timeline search toggling behaviour edge case ([\#11605](matrix-org/matrix-react-sdk#11605)). Fixes #26105. * Avoid rendering view-message link in RoomKnocksBar unnecessarily ([\#11598](matrix-org/matrix-react-sdk#11598)). Contributed by @charlynguyen. * Use knock rooms sync to reflect the knock state ([\#11596](matrix-org/matrix-react-sdk#11596)). Fixes #26043 and #26044. Contributed by @charlynguyen. * Fix avatar in right panel not using the correct font ([\#11593](matrix-org/matrix-react-sdk#11593)). Fixes #26061. Contributed by @MidhunSureshR. * Add waits in Spotlight Cypress tests, hoping this unflakes them ([\#11590](matrix-org/matrix-react-sdk#11590)). Fixes #26053, #26140 #26139 and #26138. Contributed by @andybalaam. * Fix vertical alignment of default avatar font ([\#11582](matrix-org/matrix-react-sdk#11582)). Fixes #26081. * Fix avatars in public room & space search being flex shrunk ([\#11580](matrix-org/matrix-react-sdk#11580)). Fixes #26133. * Fix EventTile avatars being rendered with a size of 0 instead of hidden ([\#11558](matrix-org/matrix-react-sdk#11558)). Fixes #26075.

Kerry Archibald added 8 commits July 11, 2023 19:27

test persistCredentials without a pickle key

2607997

Merge branch 'develop' into kerry/25708/test-persist-credentials

3506c06

test setLoggedIn with pickle key

609f790

lint

f3092c7

type error

fad7f33

extract token persisting code into function, persist refresh token

32d5fb0

store has_refresh_token too

e6529f1

pass refreshToken from oidcAuthGrant into credentials

66d57e5

kerryarchibald added the T-Enhancement New features, changes in functionality, performance boosts, user-facing improvements label Jul 12, 2023

github-actions bot deployed to Netlify July 13, 2023 00:00 View deployment

Kerry Archibald added 2 commits July 13, 2023 13:02

rest restore session with pickle key

b33e347

Merge branch 'kerry/25708/test-persist-credentials' into kerry/25708/…

823ba2e

…save-refresh-token

github-actions bot deployed to Netlify July 13, 2023 01:08 View deployment

Kerry added 2 commits July 13, 2023 13:32

Merge branch 'develop' into kerry/25708/test-persist-credentials

b7e0603

Merge branch 'kerry/25708/test-persist-credentials' into kerry/25708/…

b8b0c86

…save-refresh-token

github-actions bot deployed to Netlify July 13, 2023 01:37 View deployment

Kerry added 2 commits July 17, 2023 08:50

Merge branch 'develop' into kerry/25708/test-persist-credentials

f059642

Merge branch 'kerry/25708/test-persist-credentials' into kerry/25708/…

9272110

…save-refresh-token

github-actions bot deployed to Netlify July 17, 2023 00:35 View deployment

Base automatically changed from kerry/25708/test-persist-credentials to develop July 19, 2023 08:04

Kerry Archibald added 3 commits July 19, 2023 21:15

Merge branch 'develop' into kerry/25708/save-refresh-token

d24fbd0

Merge branch 'kerry/25708/save-refresh-token' of https://github.com/m…

880c258

…atrix-org/matrix-react-sdk into kerry/25708/save-refresh-token

Merge branch 'develop' into kerry/25708/save-refresh-token

65c0734

kerryarchibald marked this pull request as ready for review July 19, 2023 09:31

kerryarchibald requested a review from a team as a code owner July 19, 2023 09:31

kerryarchibald requested review from richvdh and t3chguy July 19, 2023 09:31

kerryarchibald changed the title ~~[WIP] OIDC: persist refresh token~~ OIDC: persist refresh token Jul 19, 2023

github-advanced-security bot found potential problems Jul 19, 2023

View reviewed changes

github-actions bot deployed to Netlify July 19, 2023 09:37 View deployment

richvdh suggested changes Jul 20, 2023

View reviewed changes

comments

70ddb4a

kerryarchibald requested a review from richvdh July 20, 2023 21:25

github-actions bot deployed to Netlify July 20, 2023 21:29 View deployment

Kerry Archibald added 2 commits July 21, 2023 11:33

Merge branch 'develop' into kerry/25708/save-refresh-token

56441dc

prettier

af481b2

github-actions bot deployed to Netlify July 20, 2023 23:45 View deployment

richvdh suggested changes Jul 25, 2023

View reviewed changes

Kerry and others added 3 commits September 18, 2023 11:51

Update src/Lifecycle.ts

e2d2d33

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

Merge branch 'develop' into kerry/25708/save-refresh-token

678815d

comments

1f903c9

kerryarchibald requested a review from richvdh September 18, 2023 00:12

github-actions bot deployed to Netlify September 18, 2023 00:17 View deployment

richvdh reviewed Sep 18, 2023

View reviewed changes

richvdh approved these changes Sep 18, 2023

View reviewed changes

Merge branch 'develop' into kerry/25708/save-refresh-token

777dbba

kerryarchibald enabled auto-merge September 18, 2023 23:33

github-actions bot deployed to Netlify September 18, 2023 23:37 View deployment

kerryarchibald added this pull request to the merge queue Sep 19, 2023

Merged via the queue into develop with commit 46072ca Sep 19, 2023
19 checks passed

kerryarchibald deleted the kerry/25708/save-refresh-token branch September 19, 2023 00:41

kerryarchibald mentioned this pull request Oct 3, 2023

OIDC: Store the refresh token element-hq/element-web#25708

Closed

richvdh mentioned this pull request Nov 15, 2023

Console warning on startup: Could not encrypt access token Error: No token: not attempting encryption element-hq/element-web#26589

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OIDC: persist refresh token #11249

OIDC: persist refresh token #11249

kerryarchibald commented Jul 12, 2023 •

edited by github-actions bot

Loading

richvdh left a comment

richvdh Jul 25, 2023

kerryarchibald commented Sep 18, 2023

richvdh Sep 18, 2023

richvdh left a comment

	* @param token the token to store, when undefined any existing token at the storageKey is removed from storage
	* @param token The token to store. When undefined, any existing token at the `storageKey` is removed from storage.

OIDC: persist refresh token #11249

OIDC: persist refresh token #11249

Conversation

kerryarchibald commented Jul 12, 2023 • edited by github-actions bot Loading

Checklist

✨ Features

richvdh left a comment

Choose a reason for hiding this comment

richvdh Jul 25, 2023

Choose a reason for hiding this comment

kerryarchibald commented Sep 18, 2023

richvdh Sep 18, 2023

Choose a reason for hiding this comment

richvdh left a comment

Choose a reason for hiding this comment

kerryarchibald commented Jul 12, 2023 •

edited by github-actions bot

Loading