feat(backend): Limit handshake to document requests#2352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SokratisVidros merged 6 commits into from
Dec 15, 2023
Merged

feat(backend): Limit handshake to document requests #2352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
99c6620
feat(backend): Support dev handshake where the redirect ends up tainted
brkalow Dec 14, 2023
b103ec7
feat(backend): Fix tests, only check sec-fetch-dest for handshake elg…
brkalow Dec 14, 2023
412c5f5
chore(repo): Add changeset
brkalow Dec 14, 2023
841b0eb
fix(backend): Update request unit tests
brkalow Dec 14, 2023
0759578
fix(fastify): Update snapshot tests
brkalow Dec 14, 2023
df9aba8
Merge branch 'main' into brk.feat/handshake-fetch
brkalow Dec 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/itchy-papayas-dress.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Update the handshake flow to only trigger for document requests.
35 changes: 35 additions & 0 deletions integration/tests/handshake.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test.describe('Client handshake @generic', () => {
Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -101,6 +102,7 @@ test.describe('Client handshake @generic', () => {
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
Authorization: `Bearer ${token}`,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -118,6 +120,7 @@ test.describe('Client handshake @generic', () => {
Cookie: `__client_uat=${clientUat}; __session=${token}`,
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand DownExpand Up@@ -153,6 +156,7 @@ test.describe('Client handshake @generic', () => {
Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -175,6 +179,7 @@ test.describe('Client handshake @generic', () => {
Cookie: `__client_uat=${clientUat}; __session=${token}`,
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -196,6 +201,7 @@ test.describe('Client handshake @generic', () => {
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
Authorization: `Bearer ${token}`,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -216,6 +222,7 @@ test.describe('Client handshake @generic', () => {
Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -239,6 +246,7 @@ test.describe('Client handshake @generic', () => {
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
Authorization: `Bearer ${token}`,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -262,6 +270,7 @@ test.describe('Client handshake @generic', () => {
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'X-Proxy-Url': 'https://example.com/clerk',
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -285,6 +294,7 @@ test.describe('Client handshake @generic', () => {
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'X-Proxy-Url': 'https://example.com/clerk',
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -306,6 +316,7 @@ test.describe('Client handshake @generic', () => {
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'X-Domain': 'localhost:3000',
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -329,6 +340,7 @@ test.describe('Client handshake @generic', () => {
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'X-Domain': 'example.com',
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -347,6 +359,7 @@ test.describe('Client handshake @generic', () => {
Cookie: `${devBrowserCookie} __client_uat=1`,
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -367,6 +380,7 @@ test.describe('Client handshake @generic', () => {
Cookie: `__client_uat=1`,
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -385,6 +399,7 @@ test.describe('Client handshake @generic', () => {
Cookie: `${devBrowserCookie} __client_uat=0`,
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -400,6 +415,7 @@ test.describe('Client handshake @generic', () => {
Cookie: `__client_uat=0`,
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -415,6 +431,7 @@ test.describe('Client handshake @generic', () => {
Cookie: `${devBrowserCookie}`,
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -429,6 +446,7 @@ test.describe('Client handshake @generic', () => {
headers: new Headers({
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand DownExpand Up@@ -496,6 +514,7 @@ test.describe('Client handshake @generic', () => {
headers: new Headers({
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -513,6 +532,7 @@ test.describe('Client handshake @generic', () => {
Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -535,6 +555,7 @@ test.describe('Client handshake @generic', () => {
Cookie: `__client_uat=${clientUat}; __session=${token}`,
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -559,6 +580,7 @@ test.describe('Client handshake @generic', () => {
'X-Secret-Key': config.sk,
'X-Forwarded-Host': 'example.com',
'X-Forwarded-Proto': 'https',
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -581,6 +603,7 @@ test.describe('Client handshake @generic', () => {
'X-Secret-Key': config.sk,
'X-Forwarded-Host': 'example.com',
'X-Forwarded-Proto': 'https',
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -603,6 +626,7 @@ test.describe('Client handshake @generic', () => {
'X-Secret-Key': config.sk,
'X-Forwarded-Host': 'example.com:3213',
'X-Forwarded-Proto': 'https',
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -625,6 +649,7 @@ test.describe('Client handshake @generic', () => {
'X-Secret-Key': config.sk,
'X-Forwarded-Host': 'example.com:3213',
'X-Forwarded-Proto': 'https',
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -646,6 +671,7 @@ test.describe('Client handshake @generic', () => {
Cookie: `${devBrowserCookie}`,
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -669,6 +695,7 @@ test.describe('Client handshake @generic', () => {
Cookie: `${devBrowserCookie}`,
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -688,6 +715,7 @@ test.describe('Client handshake @generic', () => {
Cookie: `${devBrowserCookie}`,
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -707,6 +735,7 @@ test.describe('Client handshake @generic', () => {
Cookie: `${devBrowserCookie}`,
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -726,6 +755,7 @@ test.describe('Client handshake @generic', () => {
Cookie: `${devBrowserCookie}`,
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -746,6 +776,7 @@ test.describe('Client handshake @generic', () => {
Cookie: `${devBrowserCookie}`,
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -769,6 +800,7 @@ test.describe('Client handshake @generic', () => {
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
Cookie: `__clerk_handshake=${handshake}`,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -791,6 +823,7 @@ test.describe('Client handshake @generic', () => {
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
Cookie: `__clerk_handshake=${handshake}`,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -809,6 +842,7 @@ test.describe('Client handshake @generic', () => {
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
Cookie: `__clerk_handshake=${handshake}`,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand All@@ -828,6 +862,7 @@ test.describe('Client handshake @generic', () => {
'X-Publishable-Key': config.pk,
'X-Secret-Key': config.sk,
Cookie: `__clerk_handshake=${handshake}`,
'Sec-Fetch-Dest': 'document',
}),
redirect: 'manual',
});
Expand Down
1 change: 1 addition & 0 deletions packages/backend/src/constants.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ const Headers = {
ForwardedPort: 'x-forwarded-port',
ForwardedProto: 'x-forwarded-proto',
ForwardedHost: 'x-forwarded-host',
Accept: 'accept',
Referrer: 'referer',
UserAgent: 'user-agent',
Origin: 'origin',
Expand Down
9 changes: 5 additions & 4 deletions packages/backend/src/tokens/__tests__/request.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,7 @@ export default (QUnit: QUnit) => {
const defaultHeaders: Record<string, string> = {
host: 'example.com',
'user-agent': 'Mozilla/TestAgent',
'sec-fetch-dest': 'document',
};

const mockRequest = (headers = {}, requestUrl = 'http://clerk.com/path') => {
Expand DownExpand Up@@ -268,9 +269,7 @@ export default (QUnit: QUnit) => {
test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite and not is synced [11y]', async assert => {
const requestState = await authenticateRequest(
mockRequestWithCookies(
{
'Sec-Fetch-Dest': 'document',
},
{},
{
__client_uat: '0',
},
Expand DownExpand Up@@ -299,6 +298,7 @@ export default (QUnit: QUnit) => {
mockRequestWithCookies(
{
...defaultHeaders,
'sec-fetch-dest': 'empty',

@brkalowbrkalowDec 15, 2023

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that we're defaulting to sec-fetch-dest: document, we need to explicitly set it to empty for this test case

'user-agent': '[some-agent]',
},
{ __client_uat: '0' },
Expand DownExpand Up@@ -388,12 +388,13 @@ export default (QUnit: QUnit) => {
assert.strictEqual(requestState.toAuth(), null);
});

test('cookieToken: returns undefined when crossOriginReferrer in development and is satellite [6n]', async assert => {
test('cookieToken: returns signedIn when satellite but valid token and clientUat', async assert => {

@brkalowbrkalowDec 15, 2023

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test name was inaccurate 🧐

// Scenario: after auth action on Clerk-hosted UIs
const requestState = await authenticateRequest(
mockRequestWithCookies(
{
...defaultHeaders,
'sec-fetch-dest': 'empty',
// this is not a typo, it's intentional to be `referer` to match HTTP header key
referer: 'https://clerk.com',
},
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(backend): Limit handshake to document requests#2352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

SokratisVidros
merged 6 commits into

from

Dec 15, 2023
 Merged


feat(backend): Limit handshake to document requests
#2352
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
99c6620

feat(backend): Support dev handshake where the redirect ends up tainted


brkalow Dec 14, 2023
b103ec7

feat(backend): Fix tests, only check sec-fetch-dest for handshake elg…


brkalow Dec 14, 2023
412c5f5

chore(repo): Add changeset


brkalow Dec 14, 2023
841b0eb

fix(backend): Update request unit tests


brkalow Dec 14, 2023
0759578

fix(fastify): Update snapshot tests


brkalow Dec 14, 2023
df9aba8

Merge branch 'main' into brk.feat/handshake-fetch


brkalow Dec 15, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/itchy-papayas-dress.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Update the handshake flow to only trigger for document requests.

35 changes: 35 additions & 0 deletions
integration/tests/handshake.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -101,6 +102,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -118,6 +120,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand DownExpand Up@@ -153,6 +156,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -175,6 +179,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -196,6 +201,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -216,6 +222,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -239,6 +246,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -262,6 +270,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Proxy-Url': 'https://example.com/clerk',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -285,6 +294,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Proxy-Url': 'https://example.com/clerk',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -306,6 +316,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Domain': 'localhost:3000',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -329,6 +340,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Domain': 'example.com',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -347,6 +359,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=1`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -367,6 +380,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=1`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -385,6 +399,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=0`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -400,6 +415,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=0`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -415,6 +431,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -429,6 +446,7 @@ test.describe('Client handshake @generic', () => {
 headers: new Headers({
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand DownExpand Up@@ -496,6 +514,7 @@ test.describe('Client handshake @generic', () => {
 headers: new Headers({
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -513,6 +532,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -535,6 +555,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -559,6 +580,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -581,6 +603,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -603,6 +626,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com:3213',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -625,6 +649,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com:3213',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -646,6 +671,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -669,6 +695,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -688,6 +715,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -707,6 +735,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -726,6 +755,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -746,6 +776,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -769,6 +800,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -791,6 +823,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -809,6 +842,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -828,6 +862,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ const Headers = {
 ForwardedPort: 'x-forwarded-port',
 ForwardedProto: 'x-forwarded-proto',
 ForwardedHost: 'x-forwarded-host',
 Accept: 'accept',
 Referrer: 'referer',
 UserAgent: 'user-agent',
 Origin: 'origin',
Expand Down

9 changes: 5 additions & 4 deletions
packages/backend/src/tokens/__tests__/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,7 @@ export default (QUnit: QUnit) => {
 const defaultHeaders: Record<string, string> = {
 host: 'example.com',
 'user-agent': 'Mozilla/TestAgent',
 'sec-fetch-dest': 'document',
 };

 const mockRequest = (headers = {}, requestUrl = 'http://clerk.com/path') => {
Expand DownExpand Up@@ -268,9 +269,7 @@ export default (QUnit: QUnit) => {
 test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite and not is synced [11y]', async assert => {
 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 'Sec-Fetch-Dest': 'document',
 },
 {},
 {
 __client_uat: '0',
 },
Expand DownExpand Up@@ -299,6 +298,7 @@ export default (QUnit: QUnit) => {
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 'sec-fetch-dest': 'empty',
@brkalowbrkalowDec 15, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that we're defaulting to sec-fetch-dest: document, we need to explicitly set it to empty for this test case
 'user-agent': '[some-agent]',
 },
 { __client_uat: '0' },
Expand DownExpand Up@@ -388,12 +388,13 @@ export default (QUnit: QUnit) => {
 assert.strictEqual(requestState.toAuth(), null);
 });

 test('cookieToken: returns undefined when crossOriginReferrer in development and is satellite [6n]', async assert => {
 test('cookieToken: returns signedIn when satellite but valid token and clientUat', async assert => {
@brkalowbrkalowDec 15, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test name was inaccurate 🧐
 // Scenario: after auth action on Clerk-hosted UIs
 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 'sec-fetch-dest': 'empty',
 // this is not a typo, it's intentional to be `referer` to match HTTP header key
 referer: 'https://clerk.com',
 },
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(backend): Limit handshake to document requests#2352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

SokratisVidros
merged 6 commits into

from

Dec 15, 2023
 Merged


feat(backend): Limit handshake to document requests
#2352
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
99c6620

feat(backend): Support dev handshake where the redirect ends up tainted


brkalow Dec 14, 2023
b103ec7

feat(backend): Fix tests, only check sec-fetch-dest for handshake elg…


brkalow Dec 14, 2023
412c5f5

chore(repo): Add changeset


brkalow Dec 14, 2023
841b0eb

fix(backend): Update request unit tests


brkalow Dec 14, 2023
0759578

fix(fastify): Update snapshot tests


brkalow Dec 14, 2023
df9aba8

Merge branch 'main' into brk.feat/handshake-fetch


brkalow Dec 15, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/itchy-papayas-dress.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Update the handshake flow to only trigger for document requests.

35 changes: 35 additions & 0 deletions
integration/tests/handshake.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -101,6 +102,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -118,6 +120,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand DownExpand Up@@ -153,6 +156,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -175,6 +179,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -196,6 +201,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -216,6 +222,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -239,6 +246,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -262,6 +270,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Proxy-Url': 'https://example.com/clerk',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -285,6 +294,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Proxy-Url': 'https://example.com/clerk',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -306,6 +316,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Domain': 'localhost:3000',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -329,6 +340,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Domain': 'example.com',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -347,6 +359,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=1`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -367,6 +380,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=1`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -385,6 +399,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=0`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -400,6 +415,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=0`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -415,6 +431,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -429,6 +446,7 @@ test.describe('Client handshake @generic', () => {
 headers: new Headers({
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand DownExpand Up@@ -496,6 +514,7 @@ test.describe('Client handshake @generic', () => {
 headers: new Headers({
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -513,6 +532,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -535,6 +555,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -559,6 +580,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -581,6 +603,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -603,6 +626,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com:3213',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -625,6 +649,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com:3213',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -646,6 +671,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -669,6 +695,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -688,6 +715,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -707,6 +735,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -726,6 +755,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -746,6 +776,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -769,6 +800,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -791,6 +823,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -809,6 +842,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -828,6 +862,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ const Headers = {
 ForwardedPort: 'x-forwarded-port',
 ForwardedProto: 'x-forwarded-proto',
 ForwardedHost: 'x-forwarded-host',
 Accept: 'accept',
 Referrer: 'referer',
 UserAgent: 'user-agent',
 Origin: 'origin',
Expand Down

9 changes: 5 additions & 4 deletions
packages/backend/src/tokens/__tests__/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,7 @@ export default (QUnit: QUnit) => {
 const defaultHeaders: Record<string, string> = {
 host: 'example.com',
 'user-agent': 'Mozilla/TestAgent',
 'sec-fetch-dest': 'document',
 };

 const mockRequest = (headers = {}, requestUrl = 'http://clerk.com/path') => {
Expand DownExpand Up@@ -268,9 +269,7 @@ export default (QUnit: QUnit) => {
 test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite and not is synced [11y]', async assert => {
 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 'Sec-Fetch-Dest': 'document',
 },
 {},
 {
 __client_uat: '0',
 },
Expand DownExpand Up@@ -299,6 +298,7 @@ export default (QUnit: QUnit) => {
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 'sec-fetch-dest': 'empty',
@brkalowbrkalowDec 15, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that we're defaulting to sec-fetch-dest: document, we need to explicitly set it to empty for this test case
 'user-agent': '[some-agent]',
 },
 { __client_uat: '0' },
Expand DownExpand Up@@ -388,12 +388,13 @@ export default (QUnit: QUnit) => {
 assert.strictEqual(requestState.toAuth(), null);
 });

 test('cookieToken: returns undefined when crossOriginReferrer in development and is satellite [6n]', async assert => {
 test('cookieToken: returns signedIn when satellite but valid token and clientUat', async assert => {
@brkalowbrkalowDec 15, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test name was inaccurate 🧐
 // Scenario: after auth action on Clerk-hosted UIs
 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 'sec-fetch-dest': 'empty',
 // this is not a typo, it's intentional to be `referer` to match HTTP header key
 referer: 'https://clerk.com',
 },
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(backend): Limit handshake to document requests#2352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

SokratisVidros
merged 6 commits into

from

Dec 15, 2023
 Merged


feat(backend): Limit handshake to document requests
#2352
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
99c6620

feat(backend): Support dev handshake where the redirect ends up tainted


brkalow Dec 14, 2023
b103ec7

feat(backend): Fix tests, only check sec-fetch-dest for handshake elg…


brkalow Dec 14, 2023
412c5f5

chore(repo): Add changeset


brkalow Dec 14, 2023
841b0eb

fix(backend): Update request unit tests


brkalow Dec 14, 2023
0759578

fix(fastify): Update snapshot tests


brkalow Dec 14, 2023
df9aba8

Merge branch 'main' into brk.feat/handshake-fetch


brkalow Dec 15, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/itchy-papayas-dress.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Update the handshake flow to only trigger for document requests.

35 changes: 35 additions & 0 deletions
integration/tests/handshake.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -101,6 +102,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -118,6 +120,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand DownExpand Up@@ -153,6 +156,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -175,6 +179,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -196,6 +201,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -216,6 +222,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -239,6 +246,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -262,6 +270,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Proxy-Url': 'https://example.com/clerk',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -285,6 +294,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Proxy-Url': 'https://example.com/clerk',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -306,6 +316,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Domain': 'localhost:3000',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -329,6 +340,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Domain': 'example.com',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -347,6 +359,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=1`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -367,6 +380,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=1`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -385,6 +399,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=0`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -400,6 +415,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=0`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -415,6 +431,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -429,6 +446,7 @@ test.describe('Client handshake @generic', () => {
 headers: new Headers({
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand DownExpand Up@@ -496,6 +514,7 @@ test.describe('Client handshake @generic', () => {
 headers: new Headers({
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -513,6 +532,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -535,6 +555,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -559,6 +580,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -581,6 +603,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -603,6 +626,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com:3213',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -625,6 +649,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com:3213',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -646,6 +671,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -669,6 +695,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -688,6 +715,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -707,6 +735,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -726,6 +755,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -746,6 +776,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -769,6 +800,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -791,6 +823,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -809,6 +842,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -828,6 +862,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ const Headers = {
 ForwardedPort: 'x-forwarded-port',
 ForwardedProto: 'x-forwarded-proto',
 ForwardedHost: 'x-forwarded-host',
 Accept: 'accept',
 Referrer: 'referer',
 UserAgent: 'user-agent',
 Origin: 'origin',
Expand Down

9 changes: 5 additions & 4 deletions
packages/backend/src/tokens/__tests__/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,7 @@ export default (QUnit: QUnit) => {
 const defaultHeaders: Record<string, string> = {
 host: 'example.com',
 'user-agent': 'Mozilla/TestAgent',
 'sec-fetch-dest': 'document',
 };

 const mockRequest = (headers = {}, requestUrl = 'http://clerk.com/path') => {
Expand DownExpand Up@@ -268,9 +269,7 @@ export default (QUnit: QUnit) => {
 test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite and not is synced [11y]', async assert => {
 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 'Sec-Fetch-Dest': 'document',
 },
 {},
 {
 __client_uat: '0',
 },
Expand DownExpand Up@@ -299,6 +298,7 @@ export default (QUnit: QUnit) => {
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 'sec-fetch-dest': 'empty',
@brkalowbrkalowDec 15, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that we're defaulting to sec-fetch-dest: document, we need to explicitly set it to empty for this test case
 'user-agent': '[some-agent]',
 },
 { __client_uat: '0' },
Expand DownExpand Up@@ -388,12 +388,13 @@ export default (QUnit: QUnit) => {
 assert.strictEqual(requestState.toAuth(), null);
 });

 test('cookieToken: returns undefined when crossOriginReferrer in development and is satellite [6n]', async assert => {
 test('cookieToken: returns signedIn when satellite but valid token and clientUat', async assert => {
@brkalowbrkalowDec 15, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test name was inaccurate 🧐
 // Scenario: after auth action on Clerk-hosted UIs
 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 'sec-fetch-dest': 'empty',
 // this is not a typo, it's intentional to be `referer` to match HTTP header key
 referer: 'https://clerk.com',
 },
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(backend): Limit handshake to document requests#2352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

SokratisVidros
merged 6 commits into

from

Dec 15, 2023
 Merged


feat(backend): Limit handshake to document requests
#2352
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
99c6620

feat(backend): Support dev handshake where the redirect ends up tainted


brkalow Dec 14, 2023
b103ec7

feat(backend): Fix tests, only check sec-fetch-dest for handshake elg…


brkalow Dec 14, 2023
412c5f5

chore(repo): Add changeset


brkalow Dec 14, 2023
841b0eb

fix(backend): Update request unit tests


brkalow Dec 14, 2023
0759578

fix(fastify): Update snapshot tests


brkalow Dec 14, 2023
df9aba8

Merge branch 'main' into brk.feat/handshake-fetch


brkalow Dec 15, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/itchy-papayas-dress.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Update the handshake flow to only trigger for document requests.

35 changes: 35 additions & 0 deletions
integration/tests/handshake.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -101,6 +102,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -118,6 +120,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand DownExpand Up@@ -153,6 +156,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -175,6 +179,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -196,6 +201,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -216,6 +222,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -239,6 +246,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -262,6 +270,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Proxy-Url': 'https://example.com/clerk',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -285,6 +294,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Proxy-Url': 'https://example.com/clerk',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -306,6 +316,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Domain': 'localhost:3000',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -329,6 +340,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Domain': 'example.com',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -347,6 +359,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=1`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -367,6 +380,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=1`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -385,6 +399,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=0`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -400,6 +415,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=0`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -415,6 +431,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -429,6 +446,7 @@ test.describe('Client handshake @generic', () => {
 headers: new Headers({
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand DownExpand Up@@ -496,6 +514,7 @@ test.describe('Client handshake @generic', () => {
 headers: new Headers({
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -513,6 +532,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -535,6 +555,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -559,6 +580,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -581,6 +603,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -603,6 +626,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com:3213',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -625,6 +649,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com:3213',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -646,6 +671,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -669,6 +695,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -688,6 +715,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -707,6 +735,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -726,6 +755,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -746,6 +776,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -769,6 +800,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -791,6 +823,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -809,6 +842,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -828,6 +862,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ const Headers = {
 ForwardedPort: 'x-forwarded-port',
 ForwardedProto: 'x-forwarded-proto',
 ForwardedHost: 'x-forwarded-host',
 Accept: 'accept',
 Referrer: 'referer',
 UserAgent: 'user-agent',
 Origin: 'origin',
Expand Down

9 changes: 5 additions & 4 deletions
packages/backend/src/tokens/__tests__/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,7 @@ export default (QUnit: QUnit) => {
 const defaultHeaders: Record<string, string> = {
 host: 'example.com',
 'user-agent': 'Mozilla/TestAgent',
 'sec-fetch-dest': 'document',
 };

 const mockRequest = (headers = {}, requestUrl = 'http://clerk.com/path') => {
Expand DownExpand Up@@ -268,9 +269,7 @@ export default (QUnit: QUnit) => {
 test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite and not is synced [11y]', async assert => {
 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 'Sec-Fetch-Dest': 'document',
 },
 {},
 {
 __client_uat: '0',
 },
Expand DownExpand Up@@ -299,6 +298,7 @@ export default (QUnit: QUnit) => {
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 'sec-fetch-dest': 'empty',
@brkalowbrkalowDec 15, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that we're defaulting to sec-fetch-dest: document, we need to explicitly set it to empty for this test case
 'user-agent': '[some-agent]',
 },
 { __client_uat: '0' },
Expand DownExpand Up@@ -388,12 +388,13 @@ export default (QUnit: QUnit) => {
 assert.strictEqual(requestState.toAuth(), null);
 });

 test('cookieToken: returns undefined when crossOriginReferrer in development and is satellite [6n]', async assert => {
 test('cookieToken: returns signedIn when satellite but valid token and clientUat', async assert => {
@brkalowbrkalowDec 15, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test name was inaccurate 🧐
 // Scenario: after auth action on Clerk-hosted UIs
 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 'sec-fetch-dest': 'empty',
 // this is not a typo, it's intentional to be `referer` to match HTTP header key
 referer: 'https://clerk.com',
 },
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(backend): Limit handshake to document requests#2352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

SokratisVidros
merged 6 commits into

from

Dec 15, 2023
 Merged


feat(backend): Limit handshake to document requests
#2352
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
99c6620

feat(backend): Support dev handshake where the redirect ends up tainted


brkalow Dec 14, 2023
b103ec7

feat(backend): Fix tests, only check sec-fetch-dest for handshake elg…


brkalow Dec 14, 2023
412c5f5

chore(repo): Add changeset


brkalow Dec 14, 2023
841b0eb

fix(backend): Update request unit tests


brkalow Dec 14, 2023
0759578

fix(fastify): Update snapshot tests


brkalow Dec 14, 2023
df9aba8

Merge branch 'main' into brk.feat/handshake-fetch


brkalow Dec 15, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/itchy-papayas-dress.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Update the handshake flow to only trigger for document requests.

35 changes: 35 additions & 0 deletions
integration/tests/handshake.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -101,6 +102,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -118,6 +120,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand DownExpand Up@@ -153,6 +156,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -175,6 +179,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -196,6 +201,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -216,6 +222,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -239,6 +246,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -262,6 +270,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Proxy-Url': 'https://example.com/clerk',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -285,6 +294,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Proxy-Url': 'https://example.com/clerk',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -306,6 +316,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Domain': 'localhost:3000',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -329,6 +340,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Domain': 'example.com',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -347,6 +359,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=1`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -367,6 +380,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=1`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -385,6 +399,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=0`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -400,6 +415,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=0`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -415,6 +431,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -429,6 +446,7 @@ test.describe('Client handshake @generic', () => {
 headers: new Headers({
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand DownExpand Up@@ -496,6 +514,7 @@ test.describe('Client handshake @generic', () => {
 headers: new Headers({
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -513,6 +532,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -535,6 +555,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -559,6 +580,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -581,6 +603,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -603,6 +626,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com:3213',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -625,6 +649,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com:3213',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -646,6 +671,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -669,6 +695,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -688,6 +715,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -707,6 +735,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -726,6 +755,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -746,6 +776,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -769,6 +800,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -791,6 +823,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -809,6 +842,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -828,6 +862,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ const Headers = {
 ForwardedPort: 'x-forwarded-port',
 ForwardedProto: 'x-forwarded-proto',
 ForwardedHost: 'x-forwarded-host',
 Accept: 'accept',
 Referrer: 'referer',
 UserAgent: 'user-agent',
 Origin: 'origin',
Expand Down

9 changes: 5 additions & 4 deletions
packages/backend/src/tokens/__tests__/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,7 @@ export default (QUnit: QUnit) => {
 const defaultHeaders: Record<string, string> = {
 host: 'example.com',
 'user-agent': 'Mozilla/TestAgent',
 'sec-fetch-dest': 'document',
 };

 const mockRequest = (headers = {}, requestUrl = 'http://clerk.com/path') => {
Expand DownExpand Up@@ -268,9 +269,7 @@ export default (QUnit: QUnit) => {
 test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite and not is synced [11y]', async assert => {
 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 'Sec-Fetch-Dest': 'document',
 },
 {},
 {
 __client_uat: '0',
 },
Expand DownExpand Up@@ -299,6 +298,7 @@ export default (QUnit: QUnit) => {
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 'sec-fetch-dest': 'empty',
@brkalowbrkalowDec 15, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that we're defaulting to sec-fetch-dest: document, we need to explicitly set it to empty for this test case
 'user-agent': '[some-agent]',
 },
 { __client_uat: '0' },
Expand DownExpand Up@@ -388,12 +388,13 @@ export default (QUnit: QUnit) => {
 assert.strictEqual(requestState.toAuth(), null);
 });

 test('cookieToken: returns undefined when crossOriginReferrer in development and is satellite [6n]', async assert => {
 test('cookieToken: returns signedIn when satellite but valid token and clientUat', async assert => {
@brkalowbrkalowDec 15, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test name was inaccurate 🧐
 // Scenario: after auth action on Clerk-hosted UIs
 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 'sec-fetch-dest': 'empty',
 // this is not a typo, it's intentional to be `referer` to match HTTP header key
 referer: 'https://clerk.com',
 },
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(backend): Limit handshake to document requests#2352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

SokratisVidros
merged 6 commits into

from

Dec 15, 2023
 Merged


feat(backend): Limit handshake to document requests
#2352
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
99c6620

feat(backend): Support dev handshake where the redirect ends up tainted


brkalow Dec 14, 2023
b103ec7

feat(backend): Fix tests, only check sec-fetch-dest for handshake elg…


brkalow Dec 14, 2023
412c5f5

chore(repo): Add changeset


brkalow Dec 14, 2023
841b0eb

fix(backend): Update request unit tests


brkalow Dec 14, 2023
0759578

fix(fastify): Update snapshot tests


brkalow Dec 14, 2023
df9aba8

Merge branch 'main' into brk.feat/handshake-fetch


brkalow Dec 15, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/itchy-papayas-dress.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Update the handshake flow to only trigger for document requests.

35 changes: 35 additions & 0 deletions
integration/tests/handshake.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -101,6 +102,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -118,6 +120,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand DownExpand Up@@ -153,6 +156,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -175,6 +179,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -196,6 +201,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -216,6 +222,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -239,6 +246,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -262,6 +270,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Proxy-Url': 'https://example.com/clerk',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -285,6 +294,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Proxy-Url': 'https://example.com/clerk',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -306,6 +316,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Domain': 'localhost:3000',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -329,6 +340,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Domain': 'example.com',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -347,6 +359,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=1`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -367,6 +380,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=1`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -385,6 +399,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=0`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -400,6 +415,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=0`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -415,6 +431,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -429,6 +446,7 @@ test.describe('Client handshake @generic', () => {
 headers: new Headers({
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand DownExpand Up@@ -496,6 +514,7 @@ test.describe('Client handshake @generic', () => {
 headers: new Headers({
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -513,6 +532,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -535,6 +555,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -559,6 +580,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -581,6 +603,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -603,6 +626,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com:3213',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -625,6 +649,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com:3213',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -646,6 +671,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -669,6 +695,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -688,6 +715,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -707,6 +735,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -726,6 +755,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -746,6 +776,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -769,6 +800,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -791,6 +823,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -809,6 +842,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -828,6 +862,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ const Headers = {
 ForwardedPort: 'x-forwarded-port',
 ForwardedProto: 'x-forwarded-proto',
 ForwardedHost: 'x-forwarded-host',
 Accept: 'accept',
 Referrer: 'referer',
 UserAgent: 'user-agent',
 Origin: 'origin',
Expand Down

9 changes: 5 additions & 4 deletions
packages/backend/src/tokens/__tests__/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,7 @@ export default (QUnit: QUnit) => {
 const defaultHeaders: Record<string, string> = {
 host: 'example.com',
 'user-agent': 'Mozilla/TestAgent',
 'sec-fetch-dest': 'document',
 };

 const mockRequest = (headers = {}, requestUrl = 'http://clerk.com/path') => {
Expand DownExpand Up@@ -268,9 +269,7 @@ export default (QUnit: QUnit) => {
 test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite and not is synced [11y]', async assert => {
 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 'Sec-Fetch-Dest': 'document',
 },
 {},
 {
 __client_uat: '0',
 },
Expand DownExpand Up@@ -299,6 +298,7 @@ export default (QUnit: QUnit) => {
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 'sec-fetch-dest': 'empty',
@brkalowbrkalowDec 15, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that we're defaulting to sec-fetch-dest: document, we need to explicitly set it to empty for this test case
 'user-agent': '[some-agent]',
 },
 { __client_uat: '0' },
Expand DownExpand Up@@ -388,12 +388,13 @@ export default (QUnit: QUnit) => {
 assert.strictEqual(requestState.toAuth(), null);
 });

 test('cookieToken: returns undefined when crossOriginReferrer in development and is satellite [6n]', async assert => {
 test('cookieToken: returns signedIn when satellite but valid token and clientUat', async assert => {
@brkalowbrkalowDec 15, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test name was inaccurate 🧐
 // Scenario: after auth action on Clerk-hosted UIs
 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 'sec-fetch-dest': 'empty',
 // this is not a typo, it's intentional to be `referer` to match HTTP header key
 referer: 'https://clerk.com',
 },
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(backend): Limit handshake to document requests#2352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

SokratisVidros
merged 6 commits into

from

Dec 15, 2023
 Merged


feat(backend): Limit handshake to document requests
#2352
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
99c6620

feat(backend): Support dev handshake where the redirect ends up tainted


brkalow Dec 14, 2023
b103ec7

feat(backend): Fix tests, only check sec-fetch-dest for handshake elg…


brkalow Dec 14, 2023
412c5f5

chore(repo): Add changeset


brkalow Dec 14, 2023
841b0eb

fix(backend): Update request unit tests


brkalow Dec 14, 2023
0759578

fix(fastify): Update snapshot tests


brkalow Dec 14, 2023
df9aba8

Merge branch 'main' into brk.feat/handshake-fetch


brkalow Dec 15, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/itchy-papayas-dress.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Update the handshake flow to only trigger for document requests.

35 changes: 35 additions & 0 deletions
integration/tests/handshake.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -101,6 +102,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -118,6 +120,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand DownExpand Up@@ -153,6 +156,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -175,6 +179,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -196,6 +201,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -216,6 +222,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -239,6 +246,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Authorization: `Bearer ${token}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -262,6 +270,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Proxy-Url': 'https://example.com/clerk',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -285,6 +294,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Proxy-Url': 'https://example.com/clerk',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -306,6 +316,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Domain': 'localhost:3000',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -329,6 +340,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'X-Domain': 'example.com',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -347,6 +359,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=1`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -367,6 +380,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=1`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -385,6 +399,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=0`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -400,6 +415,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=0`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -415,6 +431,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -429,6 +446,7 @@ test.describe('Client handshake @generic', () => {
 headers: new Headers({
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand DownExpand Up@@ -496,6 +514,7 @@ test.describe('Client handshake @generic', () => {
 headers: new Headers({
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -513,6 +532,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie} __client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -535,6 +555,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `__client_uat=${clientUat}; __session=${token}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -559,6 +580,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -581,6 +603,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -603,6 +626,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com:3213',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -625,6 +649,7 @@ test.describe('Client handshake @generic', () => {
 'X-Secret-Key': config.sk,
 'X-Forwarded-Host': 'example.com:3213',
 'X-Forwarded-Proto': 'https',
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -646,6 +671,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -669,6 +695,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -688,6 +715,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -707,6 +735,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -726,6 +755,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -746,6 +776,7 @@ test.describe('Client handshake @generic', () => {
 Cookie: `${devBrowserCookie}`,
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -769,6 +800,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -791,6 +823,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -809,6 +842,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand All@@ -828,6 +862,7 @@ test.describe('Client handshake @generic', () => {
 'X-Publishable-Key': config.pk,
 'X-Secret-Key': config.sk,
 Cookie: `__clerk_handshake=${handshake}`,
 'Sec-Fetch-Dest': 'document',
 }),
 redirect: 'manual',
 });
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ const Headers = {
 ForwardedPort: 'x-forwarded-port',
 ForwardedProto: 'x-forwarded-proto',
 ForwardedHost: 'x-forwarded-host',
 Accept: 'accept',
 Referrer: 'referer',
 UserAgent: 'user-agent',
 Origin: 'origin',
Expand Down

9 changes: 5 additions & 4 deletions
packages/backend/src/tokens/__tests__/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -123,6 +123,7 @@ export default (QUnit: QUnit) => {
 const defaultHeaders: Record<string, string> = {
 host: 'example.com',
 'user-agent': 'Mozilla/TestAgent',
 'sec-fetch-dest': 'document',
 };

 const mockRequest = (headers = {}, requestUrl = 'http://clerk.com/path') => {
Expand DownExpand Up@@ -268,9 +269,7 @@ export default (QUnit: QUnit) => {
 test('cookieToken: returns handshake when clientUat is missing or equals to 0 and is satellite and not is synced [11y]', async assert => {
 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 'Sec-Fetch-Dest': 'document',
 },
 {},
 {
 __client_uat: '0',
 },
Expand DownExpand Up@@ -299,6 +298,7 @@ export default (QUnit: QUnit) => {
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 'sec-fetch-dest': 'empty',
@brkalowbrkalowDec 15, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that we're defaulting to sec-fetch-dest: document, we need to explicitly set it to empty for this test case
 'user-agent': '[some-agent]',
 },
 { __client_uat: '0' },
Expand DownExpand Up@@ -388,12 +388,13 @@ export default (QUnit: QUnit) => {
 assert.strictEqual(requestState.toAuth(), null);
 });

 test('cookieToken: returns undefined when crossOriginReferrer in development and is satellite [6n]', async assert => {
 test('cookieToken: returns signedIn when satellite but valid token and clientUat', async assert => {
@brkalowbrkalowDec 15, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test name was inaccurate 🧐
 // Scenario: after auth action on Clerk-hosted UIs
 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 'sec-fetch-dest': 'empty',
 // this is not a typo, it's intentional to be `referer` to match HTTP header key
 referer: 'https://clerk.com',
 },
Expand Down
Loading