feat(backend): introduce handshake by brkalow · Pull Request #2300 · clerk/javascript

brkalow · 2023-12-08T21:37:52Z

Description

Remove issuer verification
Replace interstitial flow with handshake flow
Update existing interstitial related tests

Checklist

npm test runs as expected.
npm run build runs as expected.
(If applicable) JSDoc comments have been added or updated for any package exports
(If applicable) Documentation has been updated

Type of change

Packages affected

changeset-bot · 2023-12-08T21:37:56Z

🦋 Changeset detected

Latest commit: fb6e5c1

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages

Name	Type
@clerk/backend	Major
@clerk/fastify	Patch
gatsby-plugin-clerk	Patch
@clerk/nextjs	Patch
@clerk/remix	Patch
@clerk/clerk-sdk-node	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

SokratisVidros · 2023-12-11T17:27:02Z

+    let verifyResult: JwtPayload;
+
+    try {
+      verifyResult = await verifyToken(sessionToken, authenticateContext);


TODO: for a follow up PR: verifyToken should return result, error to avoid controlling the flow with via an exception. The code will read much better.

cc: @nikosdouvlis this affects the V5 API exports

github-actions · 2023-12-12T14:52:21Z

⚠️ Changes detected under the ClerkJS `ui` directory!

Don't forget to apply the same changes under the /ui.retheme directory:
packages/clerk-js/src/ui/** ➡️ packages/clerk-js/src/ui.retheme/**

Also, you may need to update the following files:

packages/localizations/src/en-US.retheme.ts
packages/localizations/src/index.retheme.ts
packages/types/src/appearance.retheme.ts
packages/types/src/clerk.retheme.ts
packages/types/src/index.retheme.ts
packages/types/src/localization.retheme.ts

SokratisVidros · 2023-12-12T20:50:43Z

-        return handleInterstitialCase(res, requestState, interstitial.data);
+
+      if (requestState.status === AuthStatus.Handshake) {
+        // TODO: Handle handshake


@nikosdouvlis Reminder for this ☝️

@SokratisVidros
Posting here for posterity - this will be handled with a 2nd PR once we've completed testing the nextjs integration.

…main handshake

* Test suite start * feat(backend,nextjs,utils): Fix jest * first test * Fix bug in jwks cache for multiple runtime keys * Add all the tests, including many failing * Add all the tests, including many failing * fix(shared): Correctly construct proxy URL --------- Co-authored-by: Nikos Douvlis <nikosdouvlis@gmail.com> Co-authored-by: Bryce Kalow <bryce@clerk.dev>

…sts to support additional URLs

…ng to authenticateRequest

* feat(backend): Remove interstitial endpoints * feat(backend,types): Remove local interstitial script * feat(types): Clean retheme types * feat(backend): Remove interstitial and interstitial rules * feat(clerk-js): Remove interstitial from clerk-js * feat(nextjs): Remove interstitial from authMiddleware * feat(fastify): Remove interstitial * feat(gatsby-plugin-clerk): Remove interstitial * feat(remix): Remove interstitial * feat(clerk-sdk-node): Remove interstitial * fix(nextjs): Always respect redirect header if found As it's possible that we trigger a redirect from authenticateRequest that isn't a handshake status (dev multi-domain sync, for example) * chore(repo): Fix sdk tests * fix(clerk-js): Fix tests related to db-jwt * fix(clerk-js): Keep hasJustSynced check

… from authenticateContext

@ts-expect-error

* feat(backend): Try the new Client Handshake mechanism * feat(backend): Update authenticateRequest handler to support multi-domain handshake * feat(repo): Introduce tests for client handshake (#2265) * Test suite start * feat(backend,nextjs,utils): Fix jest * first test * Fix bug in jwks cache for multiple runtime keys * Add all the tests, including many failing * Add all the tests, including many failing * fix(shared): Correctly construct proxy URL --------- Co-authored-by: Nikos Douvlis <nikosdouvlis@gmail.com> Co-authored-by: Bryce Kalow <bryce@clerk.dev> * chore(backend): Refactor authenticateRequest to clarify logic * fix(backend): Fix options passing to authenticateRequest * feat(backend): Add sec-fetch-dest check for satellite sync, adjust tests to support additional URLs * feat(backend): Account for clock skew in dev, but still log error * feat(backend): Refactor backend tests to account for recent refactoring to authenticateRequest * feat(backend): Treat handshake payload as a signed jwt * fix(backend): Add tests and adjust logic to ensure existing tests pass * chore(backend): Refactor tests to conform to new method signature * chore(repo): Add changeset * feat(*): Drop interstitial (#2304) * feat(backend): Remove interstitial endpoints * feat(backend,types): Remove local interstitial script * feat(types): Clean retheme types * feat(backend): Remove interstitial and interstitial rules * feat(clerk-js): Remove interstitial from clerk-js * feat(nextjs): Remove interstitial from authMiddleware * feat(fastify): Remove interstitial * feat(gatsby-plugin-clerk): Remove interstitial * feat(remix): Remove interstitial * feat(clerk-sdk-node): Remove interstitial * fix(nextjs): Always respect redirect header if found As it's possible that we trigger a redirect from authenticateRequest that isn't a handshake status (dev multi-domain sync, for example) * chore(repo): Fix sdk tests * fix(clerk-js): Fix tests related to db-jwt * fix(clerk-js): Keep hasJustSynced check * chore(*): Fix linter * chore(backend): Remove unused AuthErrorReason properties, destructure from authenticateContext * chore(clerk-js): Remove unused @ts-expect-error directive * fix: Address build issues in sdk-node * fix(remix): Correct Remix build issues * chore(repo): Apply linting fixes --------- Co-authored-by: Sokratis Vidros <sokratis.vidros@gmail.com> Co-authored-by: Colin Sidoti <51144033+colinclerk@users.noreply.github.com> Co-authored-by: Nikos Douvlis <nikosdouvlis@gmail.com> Co-authored-by: Colin Sidoti <colin@clerk.dev>

dimkl · 2023-12-15T00:56:14Z

-  const verifyToken = (token: string, verifyOpts?: VerifyTokenOptions) => {
-    const issuer = (iss: string) => iss.startsWith('https://clerk.') || iss.includes('.clerk.accounts');
-    return _verifyToken(token, { issuer, ...options, ...verifyOpts });
-  };


Before this change, we supported using the following:

import { clerkClient } from '@clerk/clerk-sdk-node'; clerkClient.verifyToken('token');

With the above change the customers using the @clerk/clerk-sdk-node and clerkClient.verifyToken
would have to pass an issuer and some options for the function to work.
Customers were using the previous one since we had a reported issue to fix this not a long time ago: #2280

Was this change intentional or accidental?

cc: @nikosdouvlis , @SokratisVidros

@dimkl the issuer check has been removed entirely

ooh. I see. thanks for the clarification 😄
What was the reasoning behind removing the issuer check? Do we think that the rest of the claims are sufficient?

clerk-cookie added clerk-js nextjs backend playground integration labels Dec 8, 2023

nikosdouvlis mentioned this pull request Dec 11, 2023

Drop interstitial #2304

Merged

24 tasks

SokratisVidros reviewed Dec 11, 2023

View reviewed changes

clerk-cookie added sdk-node types remix fastify gatsby labels Dec 11, 2023

nikosdouvlis marked this pull request as ready for review December 12, 2023 14:50

nikosdouvlis force-pushed the client_handshake_Refactor branch from 8210b4a to 1b6aed6 Compare December 12, 2023 16:16

SokratisVidros approved these changes Dec 12, 2023

View reviewed changes

brkalow force-pushed the client_handshake_Refactor branch from eb57432 to 073be40 Compare December 12, 2023 22:25

clerk-cookie added the react label Dec 12, 2023

brkalow force-pushed the client_handshake_Refactor branch from 073be40 to da79ae6 Compare December 12, 2023 22:28

clerk-cookie removed the react label Dec 12, 2023

SokratisVidros and others added 8 commits December 13, 2023 10:50

feat(backend): Try the new Client Handshake mechanism

23046d5

feat(backend): Update authenticateRequest handler to support multi-do…

88f877a

…main handshake

chore(backend): Refactor authenticateRequest to clarify logic

3b170f6

fix(backend): Fix options passing to authenticateRequest

caff87f

feat(backend): Add sec-fetch-dest check for satellite sync, adjust te…

bd83a61

…sts to support additional URLs

feat(backend): Account for clock skew in dev, but still log error

dbd36bf

feat(backend): Refactor backend tests to account for recent refactori…

4f2af5a

…ng to authenticateRequest

brkalow and others added 8 commits December 13, 2023 10:50

feat(backend): Treat handshake payload as a signed jwt

dc01001

fix(backend): Add tests and adjust logic to ensure existing tests pass

ae9cbf9

chore(backend): Refactor tests to conform to new method signature

9f1c428

chore(repo): Add changeset

25eeb3f

chore(*): Fix linter

9b76632

chore(backend): Remove unused AuthErrorReason properties, destructure…

7eed1b2

… from authenticateContext

chore(clerk-js): Remove unused @ts-expect-error directive

91404bc

SokratisVidros force-pushed the client_handshake_Refactor branch from 577b981 to 91404bc Compare December 13, 2023 08:53

fix: Address build issues in sdk-node

59943a5

SokratisVidros force-pushed the client_handshake_Refactor branch from c3ec485 to 59943a5 Compare December 13, 2023 09:04

SokratisVidros added 2 commits December 13, 2023 11:08

fix(remix): Correct Remix build issues

e4b8cf1

chore(repo): Apply linting fixes

fb6e5c1

clerk-cookie added the chrome-extension label Dec 13, 2023

SokratisVidros merged commit 86d52fb into main Dec 13, 2023

SokratisVidros deleted the client_handshake_Refactor branch December 13, 2023 09:27

clerk-cookie mentioned this pull request Dec 13, 2023

Version Packages (alpha-v5) #2308

Merged

dimkl reviewed Dec 15, 2023

View reviewed changes

Uh oh!

Conversation

brkalow commented Dec 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Type of change

Packages affected

Uh oh!

changeset-bot Bot commented Dec 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Uh oh!

Uh oh!

Uh oh!

SokratisVidros Dec 11, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Dec 12, 2023

⚠️ Changes detected under the ClerkJS ui directory!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

SokratisVidros Dec 12, 2023

Choose a reason for hiding this comment

Uh oh!

nikosdouvlis Dec 12, 2023

Choose a reason for hiding this comment

Uh oh!

dimkl Dec 15, 2023

Choose a reason for hiding this comment

Uh oh!

brkalow Dec 15, 2023

Choose a reason for hiding this comment

Uh oh!

dimkl Dec 15, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

brkalow commented Dec 8, 2023 •

edited

Loading

changeset-bot Bot commented Dec 8, 2023 •

edited

Loading

⚠️ Changes detected under the ClerkJS `ui` directory!