Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
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
8 changes: 8 additions & 0 deletions .changeset/normalize-path-matcher.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': patch
'@clerk/nextjs': patch
'@clerk/astro': patch
'@clerk/nuxt': patch
---

Normalize URL paths in `createPathMatcher` to prevent route protection bypass
255 changes: 255 additions & 0 deletions integration/tests/astro/middleware.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,255 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';

const middlewareFile = () => `import { clerkMiddleware, createRouteMatcher } from '@clerk/astro/server';

const isProtectedRoute = createRouteMatcher(['/api/admin(.*)']);

export const onRequest = clerkMiddleware((auth, context, next) => {
if (isProtectedRoute(context.request) && !auth().userId) {
return new Response(null, { status: 401, statusText: 'Unauthorized' });
}
return next();
});
`;

const apiRouteFile = () => `import type { APIRoute } from 'astro';

export const GET: APIRoute = () => {
return Response.json({ status: 'ok' });
};
`;

test.describe('custom middleware @astro', () => {
test.describe.configure({ mode: 'serial' });
let app: Application;

test.beforeAll(async () => {
test.setTimeout(90_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-custom-middleware')
.addFile('src/middleware.ts', middlewareFile)
.addFile('src/pages/api/admin/[...action].ts', apiRouteFile)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
await app.dev();
});

test.afterAll(async () => {
await app.teardown();
});

test('baseline: unauthenticated request to protected route returns 401', async () => {
const res = await fetch(app.serverUrl + '/api/admin/users');
expect(res.status).toBe(401);
});

test('handle percent-encoded URL on protected routes', async () => {
// %61 = 'a': /api/%61dmin/users decodes to /api/admin/users
// Note: Astro's dev server normalizes percent-encoded URLs before
// the middleware runs, so this test validates the full pipeline.
// The decodeURIComponent in createPathMatcher provides defense-in-depth
// for environments that don't normalize (e.g., raw Node.js, Edge).
const encodedRes = await fetch(app.serverUrl + '/api/%61dmin/users');
expect(encodedRes.status).toBe(401);

// %64 = 'd': /api/a%64min/users decodes to /api/admin/users
const encodedRes2 = await fetch(app.serverUrl + '/api/a%64min/users');
expect(encodedRes2.status).toBe(401);
});

test('double-encoded URLs do not match route (Astro router rejects)', async () => {
// %2561 decodes one layer to %61 — Astro's file-based router does not
// match %2561dmin to the admin/ directory, returning 404
const res = await fetch(app.serverUrl + '/api/%2561dmin/users');
expect(res.status).toBe(404);
});

test('encoded slash is not decoded into a path separator', async () => {
// %2F is a reserved delimiter — decodeURI preserves it, so the matcher
// sees /api%2Fadmin/users which does not match /api/admin(.*).
// The router also treats %2F as a literal segment char, not a separator.
const res = await fetch(app.serverUrl + '/api%2Fadmin/users');
expect(res.status).not.toBe(200);
});

test('null byte in path is caught by middleware as protected route', async () => {
// %00 decodes to a null char — /api/admin\0/users still matches
// /api/admin(.*) so our middleware correctly blocks it with 401
const res = await fetch(app.serverUrl + '/api/admin%00/users');
expect(res.status).toBe(401);
});

test('malformed percent-encoding is rejected (Astro dev server rejects before middleware)', async () => {
// %zz is not valid percent-encoding — Astro's Vite dev server crashes
// on decodeURI() in the trailing-slash plugin before our middleware runs,
// returning 500
const res = await fetch(app.serverUrl + '/api/%zz/users');
expect(res.status).toBe(500);
});

test('encoded dot-current segment is caught by middleware', async () => {
// %2e = '.' — /api/%2e/admin/users resolves to /api/./admin/users → /api/admin/users
// Our middleware matches the resolved path as protected
const res = await fetch(app.serverUrl + '/api/%2e/admin/users');
expect(res.status).toBe(401);
});

test('encoded dot-parent segment does not reach protected route', async () => {
// %2e%2e = '..' — /api/%2e%2e/admin/users resolves to /api/../admin/users → /admin/users
// This doesn't match any route, returning 404
const res = await fetch(app.serverUrl + '/api/%2e%2e/admin/users');
expect(res.status).toBe(404);
});

test('encoded dot-parent traversal through fake segment is caught by middleware', async () => {
// /api/foo/%2e%2e/admin/users resolves to /api/foo/../admin/users → /api/admin/users
// Our middleware matches the resolved path as protected, returning 401
const res = await fetch(app.serverUrl + '/api/foo/%2e%2e/admin/users');
expect(res.status).toBe(401);
});

test('fully encoded dot segments with encoded slash are rejected', async () => {
// %2e%2f = './', %2e%2e%2f = '../' — when the slash is also encoded,
// the entire sequence is treated as a single path segment by the router
const dotSlashCurrent = await fetch(app.serverUrl + '/api%2f%2e%2fadmin/users');
expect(dotSlashCurrent.status).toBe(404);

const dotSlashParent = await fetch(app.serverUrl + '/api%2f%2e%2e%2fadmin/users');
expect(dotSlashParent.status).toBe(404);

const dotSlashTraversal = await fetch(app.serverUrl + '/api/foo%2f%2e%2e%2fadmin/users');
expect(dotSlashTraversal.status).toBe(404);
});

test('double slashes cannot bypass protected route', async () => {
// Double slashes before the protected segment
const res1 = await fetch(app.serverUrl + '//api/admin/users');
expect(res1.status).not.toBe(200);

// Double slashes in the middle of the path
const res2 = await fetch(app.serverUrl + '/api//admin/users');
expect(res2.status).not.toBe(200);
});
});

test.describe('custom middleware @astro (production build)', () => {
test.describe.configure({ mode: 'serial' });
let app: Application;

test.beforeAll(async () => {
test.setTimeout(120_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-custom-middleware-prod')
.addScript('build', 'pnpm astro build')
.addFile('src/middleware.ts', middlewareFile)
.addFile('src/pages/api/admin/[...action].ts', apiRouteFile)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
await app.build();
await app.serve();
});

test.afterAll(async () => {
await app.teardown();
});

test('baseline: unauthenticated request to protected route returns 401', async () => {
const res = await fetch(app.serverUrl + '/api/admin/users');
expect(res.status).toBe(401);
});

test('handle percent-encoded URL on protected routes', async () => {
// Unlike the dev server (Vite), the production Node adapter does NOT
// normalize percent-encoded URLs — this test relies on our
// decodeURIComponent fix in createPathMatcher (verified to fail without it)
const encodedRes = await fetch(app.serverUrl + '/api/%61dmin/users');
expect(encodedRes.status).toBe(401);

const encodedRes2 = await fetch(app.serverUrl + '/api/a%64min/users');
expect(encodedRes2.status).toBe(401);
});

test('double-encoded URLs do not match route (Astro router rejects)', async () => {
// %2561 decodes one layer to %61 — Astro's file-based router does not
// match %2561dmin to the admin/ directory, returning 404
const res = await fetch(app.serverUrl + '/api/%2561dmin/users');
expect(res.status).toBe(404);
});

test('encoded slash is not decoded into a path separator', async () => {
// %2F is a reserved delimiter — decodeURI preserves it, so the matcher
// sees /api%2Fadmin/users which does not match /api/admin(.*).
// The router also treats %2F as a literal segment char, not a separator.
const res = await fetch(app.serverUrl + '/api%2Fadmin/users');
expect(res.status).not.toBe(200);
});

test('null byte in path is caught by middleware as protected route', async () => {
// %00 decodes to a null char — /api/admin\0/users still matches
// /api/admin(.*) so our middleware correctly blocks it with 401
const res = await fetch(app.serverUrl + '/api/admin%00/users');
expect(res.status).toBe(401);
});

test('malformed percent-encoding returns 400 (clerkMiddleware catches MalformedURLError)', async () => {
// %zz is not valid percent-encoding — createPathMatcher throws
// MalformedURLError, which handleControlFlowErrors catches and returns 400
const res = await fetch(app.serverUrl + '/api/%zz/users');
expect(res.status).toBe(400);
});

test('encoded dot-current segment is caught by middleware', async () => {
// %2e = '.' — /api/%2e/admin/users resolves to /api/./admin/users → /api/admin/users
// Our middleware matches the resolved path as protected
const res = await fetch(app.serverUrl + '/api/%2e/admin/users');
expect(res.status).toBe(401);
});

test('encoded dot-parent segment does not reach protected route', async () => {
// %2e%2e = '..' — /api/%2e%2e/admin/users resolves to /api/../admin/users → /admin/users
// This doesn't match any route, returning 404
const res = await fetch(app.serverUrl + '/api/%2e%2e/admin/users');
expect(res.status).toBe(404);
});

test('encoded dot-parent traversal through fake segment is caught by middleware', async () => {
// /api/foo/%2e%2e/admin/users resolves to /api/foo/../admin/users → /api/admin/users
// Our middleware matches the resolved path as protected, returning 401
const res = await fetch(app.serverUrl + '/api/foo/%2e%2e/admin/users');
expect(res.status).toBe(401);
});

test('fully encoded dot segments with encoded slash are rejected', async () => {
// %2e%2f = './', %2e%2e%2f = '../' — when the slash is also encoded,
// the entire sequence is treated as a single path segment by the router
const dotSlashCurrent = await fetch(app.serverUrl + '/api%2f%2e%2fadmin/users');
expect(dotSlashCurrent.status).toBe(404);

const dotSlashParent = await fetch(app.serverUrl + '/api%2f%2e%2e%2fadmin/users');
expect(dotSlashParent.status).toBe(404);

const dotSlashTraversal = await fetch(app.serverUrl + '/api/foo%2f%2e%2e%2fadmin/users');
expect(dotSlashTraversal.status).toBe(404);
});

test('double slashes cannot bypass protected route', async () => {
// Double slashes before the protected segment
const res1 = await fetch(app.serverUrl + '//api/admin/users');
expect(res1.status).not.toBe(200);

// Double slashes in the middle of the path
const res2 = await fetch(app.serverUrl + '/api//admin/users');
expect(res2.status).not.toBe(200);
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix(shared,nextjs,astro,nuxt): normalize URL paths in createPathMatcher by nikosdouvlis · Pull Request #8310 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
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
8 changes: 8 additions & 0 deletions .changeset/normalize-path-matcher.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': patch
'@clerk/nextjs': patch
'@clerk/astro': patch
'@clerk/nuxt': patch
---

Normalize URL paths in `createPathMatcher` to prevent route protection bypass
255 changes: 255 additions & 0 deletions integration/tests/astro/middleware.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,255 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';

const middlewareFile = () => `import { clerkMiddleware, createRouteMatcher } from '@clerk/astro/server';

const isProtectedRoute = createRouteMatcher(['/api/admin(.*)']);

export const onRequest = clerkMiddleware((auth, context, next) => {
if (isProtectedRoute(context.request) && !auth().userId) {
return new Response(null, { status: 401, statusText: 'Unauthorized' });
}
return next();
});
`;

const apiRouteFile = () => `import type { APIRoute } from 'astro';

export const GET: APIRoute = () => {
return Response.json({ status: 'ok' });
};
`;

test.describe('custom middleware @astro', () => {
test.describe.configure({ mode: 'serial' });
let app: Application;

test.beforeAll(async () => {
test.setTimeout(90_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-custom-middleware')
.addFile('src/middleware.ts', middlewareFile)
.addFile('src/pages/api/admin/[...action].ts', apiRouteFile)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
await app.dev();
});

test.afterAll(async () => {
await app.teardown();
});

test('baseline: unauthenticated request to protected route returns 401', async () => {
const res = await fetch(app.serverUrl + '/api/admin/users');
expect(res.status).toBe(401);
});

test('handle percent-encoded URL on protected routes', async () => {
// %61 = 'a': /api/%61dmin/users decodes to /api/admin/users
// Note: Astro's dev server normalizes percent-encoded URLs before
// the middleware runs, so this test validates the full pipeline.
// The decodeURIComponent in createPathMatcher provides defense-in-depth
// for environments that don't normalize (e.g., raw Node.js, Edge).
const encodedRes = await fetch(app.serverUrl + '/api/%61dmin/users');
expect(encodedRes.status).toBe(401);

// %64 = 'd': /api/a%64min/users decodes to /api/admin/users
const encodedRes2 = await fetch(app.serverUrl + '/api/a%64min/users');
expect(encodedRes2.status).toBe(401);
});

test('double-encoded URLs do not match route (Astro router rejects)', async () => {
// %2561 decodes one layer to %61 — Astro's file-based router does not
// match %2561dmin to the admin/ directory, returning 404
const res = await fetch(app.serverUrl + '/api/%2561dmin/users');
expect(res.status).toBe(404);
});

test('encoded slash is not decoded into a path separator', async () => {
// %2F is a reserved delimiter — decodeURI preserves it, so the matcher
// sees /api%2Fadmin/users which does not match /api/admin(.*).
// The router also treats %2F as a literal segment char, not a separator.
const res = await fetch(app.serverUrl + '/api%2Fadmin/users');
expect(res.status).not.toBe(200);
});

test('null byte in path is caught by middleware as protected route', async () => {
// %00 decodes to a null char — /api/admin\0/users still matches
// /api/admin(.*) so our middleware correctly blocks it with 401
const res = await fetch(app.serverUrl + '/api/admin%00/users');
expect(res.status).toBe(401);
});

test('malformed percent-encoding is rejected (Astro dev server rejects before middleware)', async () => {
// %zz is not valid percent-encoding — Astro's Vite dev server crashes
// on decodeURI() in the trailing-slash plugin before our middleware runs,
// returning 500
const res = await fetch(app.serverUrl + '/api/%zz/users');
expect(res.status).toBe(500);
});

test('encoded dot-current segment is caught by middleware', async () => {
// %2e = '.' — /api/%2e/admin/users resolves to /api/./admin/users → /api/admin/users
// Our middleware matches the resolved path as protected
const res = await fetch(app.serverUrl + '/api/%2e/admin/users');
expect(res.status).toBe(401);
});

test('encoded dot-parent segment does not reach protected route', async () => {
// %2e%2e = '..' — /api/%2e%2e/admin/users resolves to /api/../admin/users → /admin/users
// This doesn't match any route, returning 404
const res = await fetch(app.serverUrl + '/api/%2e%2e/admin/users');
expect(res.status).toBe(404);
});

test('encoded dot-parent traversal through fake segment is caught by middleware', async () => {
// /api/foo/%2e%2e/admin/users resolves to /api/foo/../admin/users → /api/admin/users
// Our middleware matches the resolved path as protected, returning 401
const res = await fetch(app.serverUrl + '/api/foo/%2e%2e/admin/users');
expect(res.status).toBe(401);
});

test('fully encoded dot segments with encoded slash are rejected', async () => {
// %2e%2f = './', %2e%2e%2f = '../' — when the slash is also encoded,
// the entire sequence is treated as a single path segment by the router
const dotSlashCurrent = await fetch(app.serverUrl + '/api%2f%2e%2fadmin/users');
expect(dotSlashCurrent.status).toBe(404);

const dotSlashParent = await fetch(app.serverUrl + '/api%2f%2e%2e%2fadmin/users');
expect(dotSlashParent.status).toBe(404);

const dotSlashTraversal = await fetch(app.serverUrl + '/api/foo%2f%2e%2e%2fadmin/users');
expect(dotSlashTraversal.status).toBe(404);
});

test('double slashes cannot bypass protected route', async () => {
// Double slashes before the protected segment
const res1 = await fetch(app.serverUrl + '//api/admin/users');
expect(res1.status).not.toBe(200);

// Double slashes in the middle of the path
const res2 = await fetch(app.serverUrl + '/api//admin/users');
expect(res2.status).not.toBe(200);
});
});

test.describe('custom middleware @astro (production build)', () => {
test.describe.configure({ mode: 'serial' });
let app: Application;

test.beforeAll(async () => {
test.setTimeout(120_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-custom-middleware-prod')
.addScript('build', 'pnpm astro build')
.addFile('src/middleware.ts', middlewareFile)
.addFile('src/pages/api/admin/[...action].ts', apiRouteFile)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
await app.build();
await app.serve();
});

test.afterAll(async () => {
await app.teardown();
});

test('baseline: unauthenticated request to protected route returns 401', async () => {
const res = await fetch(app.serverUrl + '/api/admin/users');
expect(res.status).toBe(401);
});

test('handle percent-encoded URL on protected routes', async () => {
// Unlike the dev server (Vite), the production Node adapter does NOT
// normalize percent-encoded URLs — this test relies on our
// decodeURIComponent fix in createPathMatcher (verified to fail without it)
const encodedRes = await fetch(app.serverUrl + '/api/%61dmin/users');
expect(encodedRes.status).toBe(401);

const encodedRes2 = await fetch(app.serverUrl + '/api/a%64min/users');
expect(encodedRes2.status).toBe(401);
});

test('double-encoded URLs do not match route (Astro router rejects)', async () => {
// %2561 decodes one layer to %61 — Astro's file-based router does not
// match %2561dmin to the admin/ directory, returning 404
const res = await fetch(app.serverUrl + '/api/%2561dmin/users');
expect(res.status).toBe(404);
});

test('encoded slash is not decoded into a path separator', async () => {
// %2F is a reserved delimiter — decodeURI preserves it, so the matcher
// sees /api%2Fadmin/users which does not match /api/admin(.*).
// The router also treats %2F as a literal segment char, not a separator.
const res = await fetch(app.serverUrl + '/api%2Fadmin/users');
expect(res.status).not.toBe(200);
});

test('null byte in path is caught by middleware as protected route', async () => {
// %00 decodes to a null char — /api/admin\0/users still matches
// /api/admin(.*) so our middleware correctly blocks it with 401
const res = await fetch(app.serverUrl + '/api/admin%00/users');
expect(res.status).toBe(401);
});

test('malformed percent-encoding returns 400 (clerkMiddleware catches MalformedURLError)', async () => {
// %zz is not valid percent-encoding — createPathMatcher throws
// MalformedURLError, which handleControlFlowErrors catches and returns 400
const res = await fetch(app.serverUrl + '/api/%zz/users');
expect(res.status).toBe(400);
});

test('encoded dot-current segment is caught by middleware', async () => {
// %2e = '.' — /api/%2e/admin/users resolves to /api/./admin/users → /api/admin/users
// Our middleware matches the resolved path as protected
const res = await fetch(app.serverUrl + '/api/%2e/admin/users');
expect(res.status).toBe(401);
});

test('encoded dot-parent segment does not reach protected route', async () => {
// %2e%2e = '..' — /api/%2e%2e/admin/users resolves to /api/../admin/users → /admin/users
// This doesn't match any route, returning 404
const res = await fetch(app.serverUrl + '/api/%2e%2e/admin/users');
expect(res.status).toBe(404);
});

test('encoded dot-parent traversal through fake segment is caught by middleware', async () => {
// /api/foo/%2e%2e/admin/users resolves to /api/foo/../admin/users → /api/admin/users
// Our middleware matches the resolved path as protected, returning 401
const res = await fetch(app.serverUrl + '/api/foo/%2e%2e/admin/users');
expect(res.status).toBe(401);
});

test('fully encoded dot segments with encoded slash are rejected', async () => {
// %2e%2f = './', %2e%2e%2f = '../' — when the slash is also encoded,
// the entire sequence is treated as a single path segment by the router
const dotSlashCurrent = await fetch(app.serverUrl + '/api%2f%2e%2fadmin/users');
expect(dotSlashCurrent.status).toBe(404);

const dotSlashParent = await fetch(app.serverUrl + '/api%2f%2e%2e%2fadmin/users');
expect(dotSlashParent.status).toBe(404);

const dotSlashTraversal = await fetch(app.serverUrl + '/api/foo%2f%2e%2e%2fadmin/users');
expect(dotSlashTraversal.status).toBe(404);
});

test('double slashes cannot bypass protected route', async () => {
// Double slashes before the protected segment
const res1 = await fetch(app.serverUrl + '//api/admin/users');
expect(res1.status).not.toBe(200);

// Double slashes in the middle of the path
const res2 = await fetch(app.serverUrl + '/api//admin/users');
expect(res2.status).not.toBe(200);
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(shared,nextjs,astro,nuxt): normalize URL paths in createPathMatcher by nikosdouvlis · Pull Request #8310 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
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
8 changes: 8 additions & 0 deletions .changeset/normalize-path-matcher.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': patch
'@clerk/nextjs': patch
'@clerk/astro': patch
'@clerk/nuxt': patch
---

Normalize URL paths in `createPathMatcher` to prevent route protection bypass
255 changes: 255 additions & 0 deletions integration/tests/astro/middleware.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,255 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';

const middlewareFile = () => `import { clerkMiddleware, createRouteMatcher } from '@clerk/astro/server';

const isProtectedRoute = createRouteMatcher(['/api/admin(.*)']);

export const onRequest = clerkMiddleware((auth, context, next) => {
if (isProtectedRoute(context.request) && !auth().userId) {
return new Response(null, { status: 401, statusText: 'Unauthorized' });
}
return next();
});
`;

const apiRouteFile = () => `import type { APIRoute } from 'astro';

export const GET: APIRoute = () => {
return Response.json({ status: 'ok' });
};
`;

test.describe('custom middleware @astro', () => {
test.describe.configure({ mode: 'serial' });
let app: Application;

test.beforeAll(async () => {
test.setTimeout(90_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-custom-middleware')
.addFile('src/middleware.ts', middlewareFile)
.addFile('src/pages/api/admin/[...action].ts', apiRouteFile)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
await app.dev();
});

test.afterAll(async () => {
await app.teardown();
});

test('baseline: unauthenticated request to protected route returns 401', async () => {
const res = await fetch(app.serverUrl + '/api/admin/users');
expect(res.status).toBe(401);
});

test('handle percent-encoded URL on protected routes', async () => {
// %61 = 'a': /api/%61dmin/users decodes to /api/admin/users
// Note: Astro's dev server normalizes percent-encoded URLs before
// the middleware runs, so this test validates the full pipeline.
// The decodeURIComponent in createPathMatcher provides defense-in-depth
// for environments that don't normalize (e.g., raw Node.js, Edge).
const encodedRes = await fetch(app.serverUrl + '/api/%61dmin/users');
expect(encodedRes.status).toBe(401);

// %64 = 'd': /api/a%64min/users decodes to /api/admin/users
const encodedRes2 = await fetch(app.serverUrl + '/api/a%64min/users');
expect(encodedRes2.status).toBe(401);
});

test('double-encoded URLs do not match route (Astro router rejects)', async () => {
// %2561 decodes one layer to %61 — Astro's file-based router does not
// match %2561dmin to the admin/ directory, returning 404
const res = await fetch(app.serverUrl + '/api/%2561dmin/users');
expect(res.status).toBe(404);
});

test('encoded slash is not decoded into a path separator', async () => {
// %2F is a reserved delimiter — decodeURI preserves it, so the matcher
// sees /api%2Fadmin/users which does not match /api/admin(.*).
// The router also treats %2F as a literal segment char, not a separator.
const res = await fetch(app.serverUrl + '/api%2Fadmin/users');
expect(res.status).not.toBe(200);
});

test('null byte in path is caught by middleware as protected route', async () => {
// %00 decodes to a null char — /api/admin\0/users still matches
// /api/admin(.*) so our middleware correctly blocks it with 401
const res = await fetch(app.serverUrl + '/api/admin%00/users');
expect(res.status).toBe(401);
});

test('malformed percent-encoding is rejected (Astro dev server rejects before middleware)', async () => {
// %zz is not valid percent-encoding — Astro's Vite dev server crashes
// on decodeURI() in the trailing-slash plugin before our middleware runs,
// returning 500
const res = await fetch(app.serverUrl + '/api/%zz/users');
expect(res.status).toBe(500);
});

test('encoded dot-current segment is caught by middleware', async () => {
// %2e = '.' — /api/%2e/admin/users resolves to /api/./admin/users → /api/admin/users
// Our middleware matches the resolved path as protected
const res = await fetch(app.serverUrl + '/api/%2e/admin/users');
expect(res.status).toBe(401);
});

test('encoded dot-parent segment does not reach protected route', async () => {
// %2e%2e = '..' — /api/%2e%2e/admin/users resolves to /api/../admin/users → /admin/users
// This doesn't match any route, returning 404
const res = await fetch(app.serverUrl + '/api/%2e%2e/admin/users');
expect(res.status).toBe(404);
});

test('encoded dot-parent traversal through fake segment is caught by middleware', async () => {
// /api/foo/%2e%2e/admin/users resolves to /api/foo/../admin/users → /api/admin/users
// Our middleware matches the resolved path as protected, returning 401
const res = await fetch(app.serverUrl + '/api/foo/%2e%2e/admin/users');
expect(res.status).toBe(401);
});

test('fully encoded dot segments with encoded slash are rejected', async () => {
// %2e%2f = './', %2e%2e%2f = '../' — when the slash is also encoded,
// the entire sequence is treated as a single path segment by the router
const dotSlashCurrent = await fetch(app.serverUrl + '/api%2f%2e%2fadmin/users');
expect(dotSlashCurrent.status).toBe(404);

const dotSlashParent = await fetch(app.serverUrl + '/api%2f%2e%2e%2fadmin/users');
expect(dotSlashParent.status).toBe(404);

const dotSlashTraversal = await fetch(app.serverUrl + '/api/foo%2f%2e%2e%2fadmin/users');
expect(dotSlashTraversal.status).toBe(404);
});

test('double slashes cannot bypass protected route', async () => {
// Double slashes before the protected segment
const res1 = await fetch(app.serverUrl + '//api/admin/users');
expect(res1.status).not.toBe(200);

// Double slashes in the middle of the path
const res2 = await fetch(app.serverUrl + '/api//admin/users');
expect(res2.status).not.toBe(200);
});
});

test.describe('custom middleware @astro (production build)', () => {
test.describe.configure({ mode: 'serial' });
let app: Application;

test.beforeAll(async () => {
test.setTimeout(120_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-custom-middleware-prod')
.addScript('build', 'pnpm astro build')
.addFile('src/middleware.ts', middlewareFile)
.addFile('src/pages/api/admin/[...action].ts', apiRouteFile)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
await app.build();
await app.serve();
});

test.afterAll(async () => {
await app.teardown();
});

test('baseline: unauthenticated request to protected route returns 401', async () => {
const res = await fetch(app.serverUrl + '/api/admin/users');
expect(res.status).toBe(401);
});

test('handle percent-encoded URL on protected routes', async () => {
// Unlike the dev server (Vite), the production Node adapter does NOT
// normalize percent-encoded URLs — this test relies on our
// decodeURIComponent fix in createPathMatcher (verified to fail without it)
const encodedRes = await fetch(app.serverUrl + '/api/%61dmin/users');
expect(encodedRes.status).toBe(401);

const encodedRes2 = await fetch(app.serverUrl + '/api/a%64min/users');
expect(encodedRes2.status).toBe(401);
});

test('double-encoded URLs do not match route (Astro router rejects)', async () => {
// %2561 decodes one layer to %61 — Astro's file-based router does not
// match %2561dmin to the admin/ directory, returning 404
const res = await fetch(app.serverUrl + '/api/%2561dmin/users');
expect(res.status).toBe(404);
});

test('encoded slash is not decoded into a path separator', async () => {
// %2F is a reserved delimiter — decodeURI preserves it, so the matcher
// sees /api%2Fadmin/users which does not match /api/admin(.*).
// The router also treats %2F as a literal segment char, not a separator.
const res = await fetch(app.serverUrl + '/api%2Fadmin/users');
expect(res.status).not.toBe(200);
});

test('null byte in path is caught by middleware as protected route', async () => {
// %00 decodes to a null char — /api/admin\0/users still matches
// /api/admin(.*) so our middleware correctly blocks it with 401
const res = await fetch(app.serverUrl + '/api/admin%00/users');
expect(res.status).toBe(401);
});

test('malformed percent-encoding returns 400 (clerkMiddleware catches MalformedURLError)', async () => {
// %zz is not valid percent-encoding — createPathMatcher throws
// MalformedURLError, which handleControlFlowErrors catches and returns 400
const res = await fetch(app.serverUrl + '/api/%zz/users');
expect(res.status).toBe(400);
});

test('encoded dot-current segment is caught by middleware', async () => {
// %2e = '.' — /api/%2e/admin/users resolves to /api/./admin/users → /api/admin/users
// Our middleware matches the resolved path as protected
const res = await fetch(app.serverUrl + '/api/%2e/admin/users');
expect(res.status).toBe(401);
});

test('encoded dot-parent segment does not reach protected route', async () => {
// %2e%2e = '..' — /api/%2e%2e/admin/users resolves to /api/../admin/users → /admin/users
// This doesn't match any route, returning 404
const res = await fetch(app.serverUrl + '/api/%2e%2e/admin/users');
expect(res.status).toBe(404);
});

test('encoded dot-parent traversal through fake segment is caught by middleware', async () => {
// /api/foo/%2e%2e/admin/users resolves to /api/foo/../admin/users → /api/admin/users
// Our middleware matches the resolved path as protected, returning 401
const res = await fetch(app.serverUrl + '/api/foo/%2e%2e/admin/users');
expect(res.status).toBe(401);
});

test('fully encoded dot segments with encoded slash are rejected', async () => {
// %2e%2f = './', %2e%2e%2f = '../' — when the slash is also encoded,
// the entire sequence is treated as a single path segment by the router
const dotSlashCurrent = await fetch(app.serverUrl + '/api%2f%2e%2fadmin/users');
expect(dotSlashCurrent.status).toBe(404);

const dotSlashParent = await fetch(app.serverUrl + '/api%2f%2e%2e%2fadmin/users');
expect(dotSlashParent.status).toBe(404);

const dotSlashTraversal = await fetch(app.serverUrl + '/api/foo%2f%2e%2e%2fadmin/users');
expect(dotSlashTraversal.status).toBe(404);
});

test('double slashes cannot bypass protected route', async () => {
// Double slashes before the protected segment
const res1 = await fetch(app.serverUrl + '//api/admin/users');
expect(res1.status).not.toBe(200);

// Double slashes in the middle of the path
const res2 = await fetch(app.serverUrl + '/api//admin/users');
expect(res2.status).not.toBe(200);
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(shared,nextjs,astro,nuxt): normalize URL paths in createPathMatcher by nikosdouvlis · Pull Request #8310 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
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
8 changes: 8 additions & 0 deletions .changeset/normalize-path-matcher.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': patch
'@clerk/nextjs': patch
'@clerk/astro': patch
'@clerk/nuxt': patch
---

Normalize URL paths in `createPathMatcher` to prevent route protection bypass
255 changes: 255 additions & 0 deletions integration/tests/astro/middleware.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,255 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';

const middlewareFile = () => `import { clerkMiddleware, createRouteMatcher } from '@clerk/astro/server';

const isProtectedRoute = createRouteMatcher(['/api/admin(.*)']);

export const onRequest = clerkMiddleware((auth, context, next) => {
if (isProtectedRoute(context.request) && !auth().userId) {
return new Response(null, { status: 401, statusText: 'Unauthorized' });
}
return next();
});
`;

const apiRouteFile = () => `import type { APIRoute } from 'astro';

export const GET: APIRoute = () => {
return Response.json({ status: 'ok' });
};
`;

test.describe('custom middleware @astro', () => {
test.describe.configure({ mode: 'serial' });
let app: Application;

test.beforeAll(async () => {
test.setTimeout(90_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-custom-middleware')
.addFile('src/middleware.ts', middlewareFile)
.addFile('src/pages/api/admin/[...action].ts', apiRouteFile)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
await app.dev();
});

test.afterAll(async () => {
await app.teardown();
});

test('baseline: unauthenticated request to protected route returns 401', async () => {
const res = await fetch(app.serverUrl + '/api/admin/users');
expect(res.status).toBe(401);
});

test('handle percent-encoded URL on protected routes', async () => {
// %61 = 'a': /api/%61dmin/users decodes to /api/admin/users
// Note: Astro's dev server normalizes percent-encoded URLs before
// the middleware runs, so this test validates the full pipeline.
// The decodeURIComponent in createPathMatcher provides defense-in-depth
// for environments that don't normalize (e.g., raw Node.js, Edge).
const encodedRes = await fetch(app.serverUrl + '/api/%61dmin/users');
expect(encodedRes.status).toBe(401);

// %64 = 'd': /api/a%64min/users decodes to /api/admin/users
const encodedRes2 = await fetch(app.serverUrl + '/api/a%64min/users');
expect(encodedRes2.status).toBe(401);
});

test('double-encoded URLs do not match route (Astro router rejects)', async () => {
// %2561 decodes one layer to %61 — Astro's file-based router does not
// match %2561dmin to the admin/ directory, returning 404
const res = await fetch(app.serverUrl + '/api/%2561dmin/users');
expect(res.status).toBe(404);
});

test('encoded slash is not decoded into a path separator', async () => {
// %2F is a reserved delimiter — decodeURI preserves it, so the matcher
// sees /api%2Fadmin/users which does not match /api/admin(.*).
// The router also treats %2F as a literal segment char, not a separator.
const res = await fetch(app.serverUrl + '/api%2Fadmin/users');
expect(res.status).not.toBe(200);
});

test('null byte in path is caught by middleware as protected route', async () => {
// %00 decodes to a null char — /api/admin\0/users still matches
// /api/admin(.*) so our middleware correctly blocks it with 401
const res = await fetch(app.serverUrl + '/api/admin%00/users');
expect(res.status).toBe(401);
});

test('malformed percent-encoding is rejected (Astro dev server rejects before middleware)', async () => {
// %zz is not valid percent-encoding — Astro's Vite dev server crashes
// on decodeURI() in the trailing-slash plugin before our middleware runs,
// returning 500
const res = await fetch(app.serverUrl + '/api/%zz/users');
expect(res.status).toBe(500);
});

test('encoded dot-current segment is caught by middleware', async () => {
// %2e = '.' — /api/%2e/admin/users resolves to /api/./admin/users → /api/admin/users
// Our middleware matches the resolved path as protected
const res = await fetch(app.serverUrl + '/api/%2e/admin/users');
expect(res.status).toBe(401);
});

test('encoded dot-parent segment does not reach protected route', async () => {
// %2e%2e = '..' — /api/%2e%2e/admin/users resolves to /api/../admin/users → /admin/users
// This doesn't match any route, returning 404
const res = await fetch(app.serverUrl + '/api/%2e%2e/admin/users');
expect(res.status).toBe(404);
});

test('encoded dot-parent traversal through fake segment is caught by middleware', async () => {
// /api/foo/%2e%2e/admin/users resolves to /api/foo/../admin/users → /api/admin/users
// Our middleware matches the resolved path as protected, returning 401
const res = await fetch(app.serverUrl + '/api/foo/%2e%2e/admin/users');
expect(res.status).toBe(401);
});

test('fully encoded dot segments with encoded slash are rejected', async () => {
// %2e%2f = './', %2e%2e%2f = '../' — when the slash is also encoded,
// the entire sequence is treated as a single path segment by the router
const dotSlashCurrent = await fetch(app.serverUrl + '/api%2f%2e%2fadmin/users');
expect(dotSlashCurrent.status).toBe(404);

const dotSlashParent = await fetch(app.serverUrl + '/api%2f%2e%2e%2fadmin/users');
expect(dotSlashParent.status).toBe(404);

const dotSlashTraversal = await fetch(app.serverUrl + '/api/foo%2f%2e%2e%2fadmin/users');
expect(dotSlashTraversal.status).toBe(404);
});

test('double slashes cannot bypass protected route', async () => {
// Double slashes before the protected segment
const res1 = await fetch(app.serverUrl + '//api/admin/users');
expect(res1.status).not.toBe(200);

// Double slashes in the middle of the path
const res2 = await fetch(app.serverUrl + '/api//admin/users');
expect(res2.status).not.toBe(200);
});
});

test.describe('custom middleware @astro (production build)', () => {
test.describe.configure({ mode: 'serial' });
let app: Application;

test.beforeAll(async () => {
test.setTimeout(120_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-custom-middleware-prod')
.addScript('build', 'pnpm astro build')
.addFile('src/middleware.ts', middlewareFile)
.addFile('src/pages/api/admin/[...action].ts', apiRouteFile)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
await app.build();
await app.serve();
});

test.afterAll(async () => {
await app.teardown();
});

test('baseline: unauthenticated request to protected route returns 401', async () => {
const res = await fetch(app.serverUrl + '/api/admin/users');
expect(res.status).toBe(401);
});

test('handle percent-encoded URL on protected routes', async () => {
// Unlike the dev server (Vite), the production Node adapter does NOT
// normalize percent-encoded URLs — this test relies on our
// decodeURIComponent fix in createPathMatcher (verified to fail without it)
const encodedRes = await fetch(app.serverUrl + '/api/%61dmin/users');
expect(encodedRes.status).toBe(401);

const encodedRes2 = await fetch(app.serverUrl + '/api/a%64min/users');
expect(encodedRes2.status).toBe(401);
});

test('double-encoded URLs do not match route (Astro router rejects)', async () => {
// %2561 decodes one layer to %61 — Astro's file-based router does not
// match %2561dmin to the admin/ directory, returning 404
const res = await fetch(app.serverUrl + '/api/%2561dmin/users');
expect(res.status).toBe(404);
});

test('encoded slash is not decoded into a path separator', async () => {
// %2F is a reserved delimiter — decodeURI preserves it, so the matcher
// sees /api%2Fadmin/users which does not match /api/admin(.*).
// The router also treats %2F as a literal segment char, not a separator.
const res = await fetch(app.serverUrl + '/api%2Fadmin/users');
expect(res.status).not.toBe(200);
});

test('null byte in path is caught by middleware as protected route', async () => {
// %00 decodes to a null char — /api/admin\0/users still matches
// /api/admin(.*) so our middleware correctly blocks it with 401
const res = await fetch(app.serverUrl + '/api/admin%00/users');
expect(res.status).toBe(401);
});

test('malformed percent-encoding returns 400 (clerkMiddleware catches MalformedURLError)', async () => {
// %zz is not valid percent-encoding — createPathMatcher throws
// MalformedURLError, which handleControlFlowErrors catches and returns 400
const res = await fetch(app.serverUrl + '/api/%zz/users');
expect(res.status).toBe(400);
});

test('encoded dot-current segment is caught by middleware', async () => {
// %2e = '.' — /api/%2e/admin/users resolves to /api/./admin/users → /api/admin/users
// Our middleware matches the resolved path as protected
const res = await fetch(app.serverUrl + '/api/%2e/admin/users');
expect(res.status).toBe(401);
});

test('encoded dot-parent segment does not reach protected route', async () => {
// %2e%2e = '..' — /api/%2e%2e/admin/users resolves to /api/../admin/users → /admin/users
// This doesn't match any route, returning 404
const res = await fetch(app.serverUrl + '/api/%2e%2e/admin/users');
expect(res.status).toBe(404);
});

test('encoded dot-parent traversal through fake segment is caught by middleware', async () => {
// /api/foo/%2e%2e/admin/users resolves to /api/foo/../admin/users → /api/admin/users
// Our middleware matches the resolved path as protected, returning 401
const res = await fetch(app.serverUrl + '/api/foo/%2e%2e/admin/users');
expect(res.status).toBe(401);
});

test('fully encoded dot segments with encoded slash are rejected', async () => {
// %2e%2f = './', %2e%2e%2f = '../' — when the slash is also encoded,
// the entire sequence is treated as a single path segment by the router
const dotSlashCurrent = await fetch(app.serverUrl + '/api%2f%2e%2fadmin/users');
expect(dotSlashCurrent.status).toBe(404);

const dotSlashParent = await fetch(app.serverUrl + '/api%2f%2e%2e%2fadmin/users');
expect(dotSlashParent.status).toBe(404);

const dotSlashTraversal = await fetch(app.serverUrl + '/api/foo%2f%2e%2e%2fadmin/users');
expect(dotSlashTraversal.status).toBe(404);
});

test('double slashes cannot bypass protected route', async () => {
// Double slashes before the protected segment
const res1 = await fetch(app.serverUrl + '//api/admin/users');
expect(res1.status).not.toBe(200);

// Double slashes in the middle of the path
const res2 = await fetch(app.serverUrl + '/api//admin/users');
expect(res2.status).not.toBe(200);
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' fix(shared,nextjs,astro,nuxt): normalize URL paths in createPathMatcher by nikosdouvlis · Pull Request #8310 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
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
8 changes: 8 additions & 0 deletions .changeset/normalize-path-matcher.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': patch
'@clerk/nextjs': patch
'@clerk/astro': patch
'@clerk/nuxt': patch
---

Normalize URL paths in `createPathMatcher` to prevent route protection bypass
255 changes: 255 additions & 0 deletions integration/tests/astro/middleware.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,255 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';

const middlewareFile = () => `import { clerkMiddleware, createRouteMatcher } from '@clerk/astro/server';

const isProtectedRoute = createRouteMatcher(['/api/admin(.*)']);

export const onRequest = clerkMiddleware((auth, context, next) => {
if (isProtectedRoute(context.request) && !auth().userId) {
return new Response(null, { status: 401, statusText: 'Unauthorized' });
}
return next();
});
`;

const apiRouteFile = () => `import type { APIRoute } from 'astro';

export const GET: APIRoute = () => {
return Response.json({ status: 'ok' });
};
`;

test.describe('custom middleware @astro', () => {
test.describe.configure({ mode: 'serial' });
let app: Application;

test.beforeAll(async () => {
test.setTimeout(90_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-custom-middleware')
.addFile('src/middleware.ts', middlewareFile)
.addFile('src/pages/api/admin/[...action].ts', apiRouteFile)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
await app.dev();
});

test.afterAll(async () => {
await app.teardown();
});

test('baseline: unauthenticated request to protected route returns 401', async () => {
const res = await fetch(app.serverUrl + '/api/admin/users');
expect(res.status).toBe(401);
});

test('handle percent-encoded URL on protected routes', async () => {
// %61 = 'a': /api/%61dmin/users decodes to /api/admin/users
// Note: Astro's dev server normalizes percent-encoded URLs before
// the middleware runs, so this test validates the full pipeline.
// The decodeURIComponent in createPathMatcher provides defense-in-depth
// for environments that don't normalize (e.g., raw Node.js, Edge).
const encodedRes = await fetch(app.serverUrl + '/api/%61dmin/users');
expect(encodedRes.status).toBe(401);

// %64 = 'd': /api/a%64min/users decodes to /api/admin/users
const encodedRes2 = await fetch(app.serverUrl + '/api/a%64min/users');
expect(encodedRes2.status).toBe(401);
});

test('double-encoded URLs do not match route (Astro router rejects)', async () => {
// %2561 decodes one layer to %61 — Astro's file-based router does not
// match %2561dmin to the admin/ directory, returning 404
const res = await fetch(app.serverUrl + '/api/%2561dmin/users');
expect(res.status).toBe(404);
});

test('encoded slash is not decoded into a path separator', async () => {
// %2F is a reserved delimiter — decodeURI preserves it, so the matcher
// sees /api%2Fadmin/users which does not match /api/admin(.*).
// The router also treats %2F as a literal segment char, not a separator.
const res = await fetch(app.serverUrl + '/api%2Fadmin/users');
expect(res.status).not.toBe(200);
});

test('null byte in path is caught by middleware as protected route', async () => {
// %00 decodes to a null char — /api/admin\0/users still matches
// /api/admin(.*) so our middleware correctly blocks it with 401
const res = await fetch(app.serverUrl + '/api/admin%00/users');
expect(res.status).toBe(401);
});

test('malformed percent-encoding is rejected (Astro dev server rejects before middleware)', async () => {
// %zz is not valid percent-encoding — Astro's Vite dev server crashes
// on decodeURI() in the trailing-slash plugin before our middleware runs,
// returning 500
const res = await fetch(app.serverUrl + '/api/%zz/users');
expect(res.status).toBe(500);
});

test('encoded dot-current segment is caught by middleware', async () => {
// %2e = '.' — /api/%2e/admin/users resolves to /api/./admin/users → /api/admin/users
// Our middleware matches the resolved path as protected
const res = await fetch(app.serverUrl + '/api/%2e/admin/users');
expect(res.status).toBe(401);
});

test('encoded dot-parent segment does not reach protected route', async () => {
// %2e%2e = '..' — /api/%2e%2e/admin/users resolves to /api/../admin/users → /admin/users
// This doesn't match any route, returning 404
const res = await fetch(app.serverUrl + '/api/%2e%2e/admin/users');
expect(res.status).toBe(404);
});

test('encoded dot-parent traversal through fake segment is caught by middleware', async () => {
// /api/foo/%2e%2e/admin/users resolves to /api/foo/../admin/users → /api/admin/users
// Our middleware matches the resolved path as protected, returning 401
const res = await fetch(app.serverUrl + '/api/foo/%2e%2e/admin/users');
expect(res.status).toBe(401);
});

test('fully encoded dot segments with encoded slash are rejected', async () => {
// %2e%2f = './', %2e%2e%2f = '../' — when the slash is also encoded,
// the entire sequence is treated as a single path segment by the router
const dotSlashCurrent = await fetch(app.serverUrl + '/api%2f%2e%2fadmin/users');
expect(dotSlashCurrent.status).toBe(404);

const dotSlashParent = await fetch(app.serverUrl + '/api%2f%2e%2e%2fadmin/users');
expect(dotSlashParent.status).toBe(404);

const dotSlashTraversal = await fetch(app.serverUrl + '/api/foo%2f%2e%2e%2fadmin/users');
expect(dotSlashTraversal.status).toBe(404);
});

test('double slashes cannot bypass protected route', async () => {
// Double slashes before the protected segment
const res1 = await fetch(app.serverUrl + '//api/admin/users');
expect(res1.status).not.toBe(200);

// Double slashes in the middle of the path
const res2 = await fetch(app.serverUrl + '/api//admin/users');
expect(res2.status).not.toBe(200);
});
});

test.describe('custom middleware @astro (production build)', () => {
test.describe.configure({ mode: 'serial' });
let app: Application;

test.beforeAll(async () => {
test.setTimeout(120_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-custom-middleware-prod')
.addScript('build', 'pnpm astro build')
.addFile('src/middleware.ts', middlewareFile)
.addFile('src/pages/api/admin/[...action].ts', apiRouteFile)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
await app.build();
await app.serve();
});

test.afterAll(async () => {
await app.teardown();
});

test('baseline: unauthenticated request to protected route returns 401', async () => {
const res = await fetch(app.serverUrl + '/api/admin/users');
expect(res.status).toBe(401);
});

test('handle percent-encoded URL on protected routes', async () => {
// Unlike the dev server (Vite), the production Node adapter does NOT
// normalize percent-encoded URLs — this test relies on our
// decodeURIComponent fix in createPathMatcher (verified to fail without it)
const encodedRes = await fetch(app.serverUrl + '/api/%61dmin/users');
expect(encodedRes.status).toBe(401);

const encodedRes2 = await fetch(app.serverUrl + '/api/a%64min/users');
expect(encodedRes2.status).toBe(401);
});

test('double-encoded URLs do not match route (Astro router rejects)', async () => {
// %2561 decodes one layer to %61 — Astro's file-based router does not
// match %2561dmin to the admin/ directory, returning 404
const res = await fetch(app.serverUrl + '/api/%2561dmin/users');
expect(res.status).toBe(404);
});

test('encoded slash is not decoded into a path separator', async () => {
// %2F is a reserved delimiter — decodeURI preserves it, so the matcher
// sees /api%2Fadmin/users which does not match /api/admin(.*).
// The router also treats %2F as a literal segment char, not a separator.
const res = await fetch(app.serverUrl + '/api%2Fadmin/users');
expect(res.status).not.toBe(200);
});

test('null byte in path is caught by middleware as protected route', async () => {
// %00 decodes to a null char — /api/admin\0/users still matches
// /api/admin(.*) so our middleware correctly blocks it with 401
const res = await fetch(app.serverUrl + '/api/admin%00/users');
expect(res.status).toBe(401);
});

test('malformed percent-encoding returns 400 (clerkMiddleware catches MalformedURLError)', async () => {
// %zz is not valid percent-encoding — createPathMatcher throws
// MalformedURLError, which handleControlFlowErrors catches and returns 400
const res = await fetch(app.serverUrl + '/api/%zz/users');
expect(res.status).toBe(400);
});

test('encoded dot-current segment is caught by middleware', async () => {
// %2e = '.' — /api/%2e/admin/users resolves to /api/./admin/users → /api/admin/users
// Our middleware matches the resolved path as protected
const res = await fetch(app.serverUrl + '/api/%2e/admin/users');
expect(res.status).toBe(401);
});

test('encoded dot-parent segment does not reach protected route', async () => {
// %2e%2e = '..' — /api/%2e%2e/admin/users resolves to /api/../admin/users → /admin/users
// This doesn't match any route, returning 404
const res = await fetch(app.serverUrl + '/api/%2e%2e/admin/users');
expect(res.status).toBe(404);
});

test('encoded dot-parent traversal through fake segment is caught by middleware', async () => {
// /api/foo/%2e%2e/admin/users resolves to /api/foo/../admin/users → /api/admin/users
// Our middleware matches the resolved path as protected, returning 401
const res = await fetch(app.serverUrl + '/api/foo/%2e%2e/admin/users');
expect(res.status).toBe(401);
});

test('fully encoded dot segments with encoded slash are rejected', async () => {
// %2e%2f = './', %2e%2e%2f = '../' — when the slash is also encoded,
// the entire sequence is treated as a single path segment by the router
const dotSlashCurrent = await fetch(app.serverUrl + '/api%2f%2e%2fadmin/users');
expect(dotSlashCurrent.status).toBe(404);

const dotSlashParent = await fetch(app.serverUrl + '/api%2f%2e%2e%2fadmin/users');
expect(dotSlashParent.status).toBe(404);

const dotSlashTraversal = await fetch(app.serverUrl + '/api/foo%2f%2e%2e%2fadmin/users');
expect(dotSlashTraversal.status).toBe(404);
});

test('double slashes cannot bypass protected route', async () => {
// Double slashes before the protected segment
const res1 = await fetch(app.serverUrl + '//api/admin/users');
expect(res1.status).not.toBe(200);

// Double slashes in the middle of the path
const res2 = await fetch(app.serverUrl + '/api//admin/users');
expect(res2.status).not.toBe(200);
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(shared,nextjs,astro,nuxt): normalize URL paths in createPathMatcher by nikosdouvlis · Pull Request #8310 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
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
8 changes: 8 additions & 0 deletions .changeset/normalize-path-matcher.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': patch
'@clerk/nextjs': patch
'@clerk/astro': patch
'@clerk/nuxt': patch
---

Normalize URL paths in `createPathMatcher` to prevent route protection bypass
255 changes: 255 additions & 0 deletions integration/tests/astro/middleware.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,255 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';

const middlewareFile = () => `import { clerkMiddleware, createRouteMatcher } from '@clerk/astro/server';

const isProtectedRoute = createRouteMatcher(['/api/admin(.*)']);

export const onRequest = clerkMiddleware((auth, context, next) => {
if (isProtectedRoute(context.request) && !auth().userId) {
return new Response(null, { status: 401, statusText: 'Unauthorized' });
}
return next();
});
`;

const apiRouteFile = () => `import type { APIRoute } from 'astro';

export const GET: APIRoute = () => {
return Response.json({ status: 'ok' });
};
`;

test.describe('custom middleware @astro', () => {
test.describe.configure({ mode: 'serial' });
let app: Application;

test.beforeAll(async () => {
test.setTimeout(90_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-custom-middleware')
.addFile('src/middleware.ts', middlewareFile)
.addFile('src/pages/api/admin/[...action].ts', apiRouteFile)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
await app.dev();
});

test.afterAll(async () => {
await app.teardown();
});

test('baseline: unauthenticated request to protected route returns 401', async () => {
const res = await fetch(app.serverUrl + '/api/admin/users');
expect(res.status).toBe(401);
});

test('handle percent-encoded URL on protected routes', async () => {
// %61 = 'a': /api/%61dmin/users decodes to /api/admin/users
// Note: Astro's dev server normalizes percent-encoded URLs before
// the middleware runs, so this test validates the full pipeline.
// The decodeURIComponent in createPathMatcher provides defense-in-depth
// for environments that don't normalize (e.g., raw Node.js, Edge).
const encodedRes = await fetch(app.serverUrl + '/api/%61dmin/users');
expect(encodedRes.status).toBe(401);

// %64 = 'd': /api/a%64min/users decodes to /api/admin/users
const encodedRes2 = await fetch(app.serverUrl + '/api/a%64min/users');
expect(encodedRes2.status).toBe(401);
});

test('double-encoded URLs do not match route (Astro router rejects)', async () => {
// %2561 decodes one layer to %61 — Astro's file-based router does not
// match %2561dmin to the admin/ directory, returning 404
const res = await fetch(app.serverUrl + '/api/%2561dmin/users');
expect(res.status).toBe(404);
});

test('encoded slash is not decoded into a path separator', async () => {
// %2F is a reserved delimiter — decodeURI preserves it, so the matcher
// sees /api%2Fadmin/users which does not match /api/admin(.*).
// The router also treats %2F as a literal segment char, not a separator.
const res = await fetch(app.serverUrl + '/api%2Fadmin/users');
expect(res.status).not.toBe(200);
});

test('null byte in path is caught by middleware as protected route', async () => {
// %00 decodes to a null char — /api/admin\0/users still matches
// /api/admin(.*) so our middleware correctly blocks it with 401
const res = await fetch(app.serverUrl + '/api/admin%00/users');
expect(res.status).toBe(401);
});

test('malformed percent-encoding is rejected (Astro dev server rejects before middleware)', async () => {
// %zz is not valid percent-encoding — Astro's Vite dev server crashes
// on decodeURI() in the trailing-slash plugin before our middleware runs,
// returning 500
const res = await fetch(app.serverUrl + '/api/%zz/users');
expect(res.status).toBe(500);
});

test('encoded dot-current segment is caught by middleware', async () => {
// %2e = '.' — /api/%2e/admin/users resolves to /api/./admin/users → /api/admin/users
// Our middleware matches the resolved path as protected
const res = await fetch(app.serverUrl + '/api/%2e/admin/users');
expect(res.status).toBe(401);
});

test('encoded dot-parent segment does not reach protected route', async () => {
// %2e%2e = '..' — /api/%2e%2e/admin/users resolves to /api/../admin/users → /admin/users
// This doesn't match any route, returning 404
const res = await fetch(app.serverUrl + '/api/%2e%2e/admin/users');
expect(res.status).toBe(404);
});

test('encoded dot-parent traversal through fake segment is caught by middleware', async () => {
// /api/foo/%2e%2e/admin/users resolves to /api/foo/../admin/users → /api/admin/users
// Our middleware matches the resolved path as protected, returning 401
const res = await fetch(app.serverUrl + '/api/foo/%2e%2e/admin/users');
expect(res.status).toBe(401);
});

test('fully encoded dot segments with encoded slash are rejected', async () => {
// %2e%2f = './', %2e%2e%2f = '../' — when the slash is also encoded,
// the entire sequence is treated as a single path segment by the router
const dotSlashCurrent = await fetch(app.serverUrl + '/api%2f%2e%2fadmin/users');
expect(dotSlashCurrent.status).toBe(404);

const dotSlashParent = await fetch(app.serverUrl + '/api%2f%2e%2e%2fadmin/users');
expect(dotSlashParent.status).toBe(404);

const dotSlashTraversal = await fetch(app.serverUrl + '/api/foo%2f%2e%2e%2fadmin/users');
expect(dotSlashTraversal.status).toBe(404);
});

test('double slashes cannot bypass protected route', async () => {
// Double slashes before the protected segment
const res1 = await fetch(app.serverUrl + '//api/admin/users');
expect(res1.status).not.toBe(200);

// Double slashes in the middle of the path
const res2 = await fetch(app.serverUrl + '/api//admin/users');
expect(res2.status).not.toBe(200);
});
});

test.describe('custom middleware @astro (production build)', () => {
test.describe.configure({ mode: 'serial' });
let app: Application;

test.beforeAll(async () => {
test.setTimeout(120_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-custom-middleware-prod')
.addScript('build', 'pnpm astro build')
.addFile('src/middleware.ts', middlewareFile)
.addFile('src/pages/api/admin/[...action].ts', apiRouteFile)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
await app.build();
await app.serve();
});

test.afterAll(async () => {
await app.teardown();
});

test('baseline: unauthenticated request to protected route returns 401', async () => {
const res = await fetch(app.serverUrl + '/api/admin/users');
expect(res.status).toBe(401);
});

test('handle percent-encoded URL on protected routes', async () => {
// Unlike the dev server (Vite), the production Node adapter does NOT
// normalize percent-encoded URLs — this test relies on our
// decodeURIComponent fix in createPathMatcher (verified to fail without it)
const encodedRes = await fetch(app.serverUrl + '/api/%61dmin/users');
expect(encodedRes.status).toBe(401);

const encodedRes2 = await fetch(app.serverUrl + '/api/a%64min/users');
expect(encodedRes2.status).toBe(401);
});

test('double-encoded URLs do not match route (Astro router rejects)', async () => {
// %2561 decodes one layer to %61 — Astro's file-based router does not
// match %2561dmin to the admin/ directory, returning 404
const res = await fetch(app.serverUrl + '/api/%2561dmin/users');
expect(res.status).toBe(404);
});

test('encoded slash is not decoded into a path separator', async () => {
// %2F is a reserved delimiter — decodeURI preserves it, so the matcher
// sees /api%2Fadmin/users which does not match /api/admin(.*).
// The router also treats %2F as a literal segment char, not a separator.
const res = await fetch(app.serverUrl + '/api%2Fadmin/users');
expect(res.status).not.toBe(200);
});

test('null byte in path is caught by middleware as protected route', async () => {
// %00 decodes to a null char — /api/admin\0/users still matches
// /api/admin(.*) so our middleware correctly blocks it with 401
const res = await fetch(app.serverUrl + '/api/admin%00/users');
expect(res.status).toBe(401);
});

test('malformed percent-encoding returns 400 (clerkMiddleware catches MalformedURLError)', async () => {
// %zz is not valid percent-encoding — createPathMatcher throws
// MalformedURLError, which handleControlFlowErrors catches and returns 400
const res = await fetch(app.serverUrl + '/api/%zz/users');
expect(res.status).toBe(400);
});

test('encoded dot-current segment is caught by middleware', async () => {
// %2e = '.' — /api/%2e/admin/users resolves to /api/./admin/users → /api/admin/users
// Our middleware matches the resolved path as protected
const res = await fetch(app.serverUrl + '/api/%2e/admin/users');
expect(res.status).toBe(401);
});

test('encoded dot-parent segment does not reach protected route', async () => {
// %2e%2e = '..' — /api/%2e%2e/admin/users resolves to /api/../admin/users → /admin/users
// This doesn't match any route, returning 404
const res = await fetch(app.serverUrl + '/api/%2e%2e/admin/users');
expect(res.status).toBe(404);
});

test('encoded dot-parent traversal through fake segment is caught by middleware', async () => {
// /api/foo/%2e%2e/admin/users resolves to /api/foo/../admin/users → /api/admin/users
// Our middleware matches the resolved path as protected, returning 401
const res = await fetch(app.serverUrl + '/api/foo/%2e%2e/admin/users');
expect(res.status).toBe(401);
});

test('fully encoded dot segments with encoded slash are rejected', async () => {
// %2e%2f = './', %2e%2e%2f = '../' — when the slash is also encoded,
// the entire sequence is treated as a single path segment by the router
const dotSlashCurrent = await fetch(app.serverUrl + '/api%2f%2e%2fadmin/users');
expect(dotSlashCurrent.status).toBe(404);

const dotSlashParent = await fetch(app.serverUrl + '/api%2f%2e%2e%2fadmin/users');
expect(dotSlashParent.status).toBe(404);

const dotSlashTraversal = await fetch(app.serverUrl + '/api/foo%2f%2e%2e%2fadmin/users');
expect(dotSlashTraversal.status).toBe(404);
});

test('double slashes cannot bypass protected route', async () => {
// Double slashes before the protected segment
const res1 = await fetch(app.serverUrl + '//api/admin/users');
expect(res1.status).not.toBe(200);

// Double slashes in the middle of the path
const res2 = await fetch(app.serverUrl + '/api//admin/users');
expect(res2.status).not.toBe(200);
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(shared,nextjs,astro,nuxt): normalize URL paths in createPathMatcher by nikosdouvlis · Pull Request #8310 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
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
8 changes: 8 additions & 0 deletions .changeset/normalize-path-matcher.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': patch
'@clerk/nextjs': patch
'@clerk/astro': patch
'@clerk/nuxt': patch
---

Normalize URL paths in `createPathMatcher` to prevent route protection bypass
255 changes: 255 additions & 0 deletions integration/tests/astro/middleware.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,255 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';

const middlewareFile = () => `import { clerkMiddleware, createRouteMatcher } from '@clerk/astro/server';

const isProtectedRoute = createRouteMatcher(['/api/admin(.*)']);

export const onRequest = clerkMiddleware((auth, context, next) => {
if (isProtectedRoute(context.request) && !auth().userId) {
return new Response(null, { status: 401, statusText: 'Unauthorized' });
}
return next();
});
`;

const apiRouteFile = () => `import type { APIRoute } from 'astro';

export const GET: APIRoute = () => {
return Response.json({ status: 'ok' });
};
`;

test.describe('custom middleware @astro', () => {
test.describe.configure({ mode: 'serial' });
let app: Application;

test.beforeAll(async () => {
test.setTimeout(90_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-custom-middleware')
.addFile('src/middleware.ts', middlewareFile)
.addFile('src/pages/api/admin/[...action].ts', apiRouteFile)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
await app.dev();
});

test.afterAll(async () => {
await app.teardown();
});

test('baseline: unauthenticated request to protected route returns 401', async () => {
const res = await fetch(app.serverUrl + '/api/admin/users');
expect(res.status).toBe(401);
});

test('handle percent-encoded URL on protected routes', async () => {
// %61 = 'a': /api/%61dmin/users decodes to /api/admin/users
// Note: Astro's dev server normalizes percent-encoded URLs before
// the middleware runs, so this test validates the full pipeline.
// The decodeURIComponent in createPathMatcher provides defense-in-depth
// for environments that don't normalize (e.g., raw Node.js, Edge).
const encodedRes = await fetch(app.serverUrl + '/api/%61dmin/users');
expect(encodedRes.status).toBe(401);

// %64 = 'd': /api/a%64min/users decodes to /api/admin/users
const encodedRes2 = await fetch(app.serverUrl + '/api/a%64min/users');
expect(encodedRes2.status).toBe(401);
});

test('double-encoded URLs do not match route (Astro router rejects)', async () => {
// %2561 decodes one layer to %61 — Astro's file-based router does not
// match %2561dmin to the admin/ directory, returning 404
const res = await fetch(app.serverUrl + '/api/%2561dmin/users');
expect(res.status).toBe(404);
});

test('encoded slash is not decoded into a path separator', async () => {
// %2F is a reserved delimiter — decodeURI preserves it, so the matcher
// sees /api%2Fadmin/users which does not match /api/admin(.*).
// The router also treats %2F as a literal segment char, not a separator.
const res = await fetch(app.serverUrl + '/api%2Fadmin/users');
expect(res.status).not.toBe(200);
});

test('null byte in path is caught by middleware as protected route', async () => {
// %00 decodes to a null char — /api/admin\0/users still matches
// /api/admin(.*) so our middleware correctly blocks it with 401
const res = await fetch(app.serverUrl + '/api/admin%00/users');
expect(res.status).toBe(401);
});

test('malformed percent-encoding is rejected (Astro dev server rejects before middleware)', async () => {
// %zz is not valid percent-encoding — Astro's Vite dev server crashes
// on decodeURI() in the trailing-slash plugin before our middleware runs,
// returning 500
const res = await fetch(app.serverUrl + '/api/%zz/users');
expect(res.status).toBe(500);
});

test('encoded dot-current segment is caught by middleware', async () => {
// %2e = '.' — /api/%2e/admin/users resolves to /api/./admin/users → /api/admin/users
// Our middleware matches the resolved path as protected
const res = await fetch(app.serverUrl + '/api/%2e/admin/users');
expect(res.status).toBe(401);
});

test('encoded dot-parent segment does not reach protected route', async () => {
// %2e%2e = '..' — /api/%2e%2e/admin/users resolves to /api/../admin/users → /admin/users
// This doesn't match any route, returning 404
const res = await fetch(app.serverUrl + '/api/%2e%2e/admin/users');
expect(res.status).toBe(404);
});

test('encoded dot-parent traversal through fake segment is caught by middleware', async () => {
// /api/foo/%2e%2e/admin/users resolves to /api/foo/../admin/users → /api/admin/users
// Our middleware matches the resolved path as protected, returning 401
const res = await fetch(app.serverUrl + '/api/foo/%2e%2e/admin/users');
expect(res.status).toBe(401);
});

test('fully encoded dot segments with encoded slash are rejected', async () => {
// %2e%2f = './', %2e%2e%2f = '../' — when the slash is also encoded,
// the entire sequence is treated as a single path segment by the router
const dotSlashCurrent = await fetch(app.serverUrl + '/api%2f%2e%2fadmin/users');
expect(dotSlashCurrent.status).toBe(404);

const dotSlashParent = await fetch(app.serverUrl + '/api%2f%2e%2e%2fadmin/users');
expect(dotSlashParent.status).toBe(404);

const dotSlashTraversal = await fetch(app.serverUrl + '/api/foo%2f%2e%2e%2fadmin/users');
expect(dotSlashTraversal.status).toBe(404);
});

test('double slashes cannot bypass protected route', async () => {
// Double slashes before the protected segment
const res1 = await fetch(app.serverUrl + '//api/admin/users');
expect(res1.status).not.toBe(200);

// Double slashes in the middle of the path
const res2 = await fetch(app.serverUrl + '/api//admin/users');
expect(res2.status).not.toBe(200);
});
});

test.describe('custom middleware @astro (production build)', () => {
test.describe.configure({ mode: 'serial' });
let app: Application;

test.beforeAll(async () => {
test.setTimeout(120_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-custom-middleware-prod')
.addScript('build', 'pnpm astro build')
.addFile('src/middleware.ts', middlewareFile)
.addFile('src/pages/api/admin/[...action].ts', apiRouteFile)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
await app.build();
await app.serve();
});

test.afterAll(async () => {
await app.teardown();
});

test('baseline: unauthenticated request to protected route returns 401', async () => {
const res = await fetch(app.serverUrl + '/api/admin/users');
expect(res.status).toBe(401);
});

test('handle percent-encoded URL on protected routes', async () => {
// Unlike the dev server (Vite), the production Node adapter does NOT
// normalize percent-encoded URLs — this test relies on our
// decodeURIComponent fix in createPathMatcher (verified to fail without it)
const encodedRes = await fetch(app.serverUrl + '/api/%61dmin/users');
expect(encodedRes.status).toBe(401);

const encodedRes2 = await fetch(app.serverUrl + '/api/a%64min/users');
expect(encodedRes2.status).toBe(401);
});

test('double-encoded URLs do not match route (Astro router rejects)', async () => {
// %2561 decodes one layer to %61 — Astro's file-based router does not
// match %2561dmin to the admin/ directory, returning 404
const res = await fetch(app.serverUrl + '/api/%2561dmin/users');
expect(res.status).toBe(404);
});

test('encoded slash is not decoded into a path separator', async () => {
// %2F is a reserved delimiter — decodeURI preserves it, so the matcher
// sees /api%2Fadmin/users which does not match /api/admin(.*).
// The router also treats %2F as a literal segment char, not a separator.
const res = await fetch(app.serverUrl + '/api%2Fadmin/users');
expect(res.status).not.toBe(200);
});

test('null byte in path is caught by middleware as protected route', async () => {
// %00 decodes to a null char — /api/admin\0/users still matches
// /api/admin(.*) so our middleware correctly blocks it with 401
const res = await fetch(app.serverUrl + '/api/admin%00/users');
expect(res.status).toBe(401);
});

test('malformed percent-encoding returns 400 (clerkMiddleware catches MalformedURLError)', async () => {
// %zz is not valid percent-encoding — createPathMatcher throws
// MalformedURLError, which handleControlFlowErrors catches and returns 400
const res = await fetch(app.serverUrl + '/api/%zz/users');
expect(res.status).toBe(400);
});

test('encoded dot-current segment is caught by middleware', async () => {
// %2e = '.' — /api/%2e/admin/users resolves to /api/./admin/users → /api/admin/users
// Our middleware matches the resolved path as protected
const res = await fetch(app.serverUrl + '/api/%2e/admin/users');
expect(res.status).toBe(401);
});

test('encoded dot-parent segment does not reach protected route', async () => {
// %2e%2e = '..' — /api/%2e%2e/admin/users resolves to /api/../admin/users → /admin/users
// This doesn't match any route, returning 404
const res = await fetch(app.serverUrl + '/api/%2e%2e/admin/users');
expect(res.status).toBe(404);
});

test('encoded dot-parent traversal through fake segment is caught by middleware', async () => {
// /api/foo/%2e%2e/admin/users resolves to /api/foo/../admin/users → /api/admin/users
// Our middleware matches the resolved path as protected, returning 401
const res = await fetch(app.serverUrl + '/api/foo/%2e%2e/admin/users');
expect(res.status).toBe(401);
});

test('fully encoded dot segments with encoded slash are rejected', async () => {
// %2e%2f = './', %2e%2e%2f = '../' — when the slash is also encoded,
// the entire sequence is treated as a single path segment by the router
const dotSlashCurrent = await fetch(app.serverUrl + '/api%2f%2e%2fadmin/users');
expect(dotSlashCurrent.status).toBe(404);

const dotSlashParent = await fetch(app.serverUrl + '/api%2f%2e%2e%2fadmin/users');
expect(dotSlashParent.status).toBe(404);

const dotSlashTraversal = await fetch(app.serverUrl + '/api/foo%2f%2e%2e%2fadmin/users');
expect(dotSlashTraversal.status).toBe(404);
});

test('double slashes cannot bypass protected route', async () => {
// Double slashes before the protected segment
const res1 = await fetch(app.serverUrl + '//api/admin/users');
expect(res1.status).not.toBe(200);

// Double slashes in the middle of the path
const res2 = await fetch(app.serverUrl + '/api//admin/users');
expect(res2.status).not.toBe(200);
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); fix(shared,nextjs,astro,nuxt): normalize URL paths in createPathMatcher by nikosdouvlis · Pull Request #8310 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
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
8 changes: 8 additions & 0 deletions .changeset/normalize-path-matcher.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': patch
'@clerk/nextjs': patch
'@clerk/astro': patch
'@clerk/nuxt': patch
---

Normalize URL paths in `createPathMatcher` to prevent route protection bypass
255 changes: 255 additions & 0 deletions integration/tests/astro/middleware.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,255 @@
import { expect, test } from '@playwright/test';

import type { Application } from '../../models/application';
import { appConfigs } from '../../presets';

const middlewareFile = () => `import { clerkMiddleware, createRouteMatcher } from '@clerk/astro/server';

const isProtectedRoute = createRouteMatcher(['/api/admin(.*)']);

export const onRequest = clerkMiddleware((auth, context, next) => {
if (isProtectedRoute(context.request) && !auth().userId) {
return new Response(null, { status: 401, statusText: 'Unauthorized' });
}
return next();
});
`;

const apiRouteFile = () => `import type { APIRoute } from 'astro';

export const GET: APIRoute = () => {
return Response.json({ status: 'ok' });
};
`;

test.describe('custom middleware @astro', () => {
test.describe.configure({ mode: 'serial' });
let app: Application;

test.beforeAll(async () => {
test.setTimeout(90_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-custom-middleware')
.addFile('src/middleware.ts', middlewareFile)
.addFile('src/pages/api/admin/[...action].ts', apiRouteFile)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
await app.dev();
});

test.afterAll(async () => {
await app.teardown();
});

test('baseline: unauthenticated request to protected route returns 401', async () => {
const res = await fetch(app.serverUrl + '/api/admin/users');
expect(res.status).toBe(401);
});

test('handle percent-encoded URL on protected routes', async () => {
// %61 = 'a': /api/%61dmin/users decodes to /api/admin/users
// Note: Astro's dev server normalizes percent-encoded URLs before
// the middleware runs, so this test validates the full pipeline.
// The decodeURIComponent in createPathMatcher provides defense-in-depth
// for environments that don't normalize (e.g., raw Node.js, Edge).
const encodedRes = await fetch(app.serverUrl + '/api/%61dmin/users');
expect(encodedRes.status).toBe(401);

// %64 = 'd': /api/a%64min/users decodes to /api/admin/users
const encodedRes2 = await fetch(app.serverUrl + '/api/a%64min/users');
expect(encodedRes2.status).toBe(401);
});

test('double-encoded URLs do not match route (Astro router rejects)', async () => {
// %2561 decodes one layer to %61 — Astro's file-based router does not
// match %2561dmin to the admin/ directory, returning 404
const res = await fetch(app.serverUrl + '/api/%2561dmin/users');
expect(res.status).toBe(404);
});

test('encoded slash is not decoded into a path separator', async () => {
// %2F is a reserved delimiter — decodeURI preserves it, so the matcher
// sees /api%2Fadmin/users which does not match /api/admin(.*).
// The router also treats %2F as a literal segment char, not a separator.
const res = await fetch(app.serverUrl + '/api%2Fadmin/users');
expect(res.status).not.toBe(200);
});

test('null byte in path is caught by middleware as protected route', async () => {
// %00 decodes to a null char — /api/admin\0/users still matches
// /api/admin(.*) so our middleware correctly blocks it with 401
const res = await fetch(app.serverUrl + '/api/admin%00/users');
expect(res.status).toBe(401);
});

test('malformed percent-encoding is rejected (Astro dev server rejects before middleware)', async () => {
// %zz is not valid percent-encoding — Astro's Vite dev server crashes
// on decodeURI() in the trailing-slash plugin before our middleware runs,
// returning 500
const res = await fetch(app.serverUrl + '/api/%zz/users');
expect(res.status).toBe(500);
});

test('encoded dot-current segment is caught by middleware', async () => {
// %2e = '.' — /api/%2e/admin/users resolves to /api/./admin/users → /api/admin/users
// Our middleware matches the resolved path as protected
const res = await fetch(app.serverUrl + '/api/%2e/admin/users');
expect(res.status).toBe(401);
});

test('encoded dot-parent segment does not reach protected route', async () => {
// %2e%2e = '..' — /api/%2e%2e/admin/users resolves to /api/../admin/users → /admin/users
// This doesn't match any route, returning 404
const res = await fetch(app.serverUrl + '/api/%2e%2e/admin/users');
expect(res.status).toBe(404);
});

test('encoded dot-parent traversal through fake segment is caught by middleware', async () => {
// /api/foo/%2e%2e/admin/users resolves to /api/foo/../admin/users → /api/admin/users
// Our middleware matches the resolved path as protected, returning 401
const res = await fetch(app.serverUrl + '/api/foo/%2e%2e/admin/users');
expect(res.status).toBe(401);
});

test('fully encoded dot segments with encoded slash are rejected', async () => {
// %2e%2f = './', %2e%2e%2f = '../' — when the slash is also encoded,
// the entire sequence is treated as a single path segment by the router
const dotSlashCurrent = await fetch(app.serverUrl + '/api%2f%2e%2fadmin/users');
expect(dotSlashCurrent.status).toBe(404);

const dotSlashParent = await fetch(app.serverUrl + '/api%2f%2e%2e%2fadmin/users');
expect(dotSlashParent.status).toBe(404);

const dotSlashTraversal = await fetch(app.serverUrl + '/api/foo%2f%2e%2e%2fadmin/users');
expect(dotSlashTraversal.status).toBe(404);
});

test('double slashes cannot bypass protected route', async () => {
// Double slashes before the protected segment
const res1 = await fetch(app.serverUrl + '//api/admin/users');
expect(res1.status).not.toBe(200);

// Double slashes in the middle of the path
const res2 = await fetch(app.serverUrl + '/api//admin/users');
expect(res2.status).not.toBe(200);
});
});

test.describe('custom middleware @astro (production build)', () => {
test.describe.configure({ mode: 'serial' });
let app: Application;

test.beforeAll(async () => {
test.setTimeout(120_000);

app = await appConfigs.astro.node
.clone()
.setName('astro-custom-middleware-prod')
.addScript('build', 'pnpm astro build')
.addFile('src/middleware.ts', middlewareFile)
.addFile('src/pages/api/admin/[...action].ts', apiRouteFile)
.commit();

await app.setup();
await app.withEnv(appConfigs.envs.withCustomRoles);
await app.build();
await app.serve();
});

test.afterAll(async () => {
await app.teardown();
});

test('baseline: unauthenticated request to protected route returns 401', async () => {
const res = await fetch(app.serverUrl + '/api/admin/users');
expect(res.status).toBe(401);
});

test('handle percent-encoded URL on protected routes', async () => {
// Unlike the dev server (Vite), the production Node adapter does NOT
// normalize percent-encoded URLs — this test relies on our
// decodeURIComponent fix in createPathMatcher (verified to fail without it)
const encodedRes = await fetch(app.serverUrl + '/api/%61dmin/users');
expect(encodedRes.status).toBe(401);

const encodedRes2 = await fetch(app.serverUrl + '/api/a%64min/users');
expect(encodedRes2.status).toBe(401);
});

test('double-encoded URLs do not match route (Astro router rejects)', async () => {
// %2561 decodes one layer to %61 — Astro's file-based router does not
// match %2561dmin to the admin/ directory, returning 404
const res = await fetch(app.serverUrl + '/api/%2561dmin/users');
expect(res.status).toBe(404);
});

test('encoded slash is not decoded into a path separator', async () => {
// %2F is a reserved delimiter — decodeURI preserves it, so the matcher
// sees /api%2Fadmin/users which does not match /api/admin(.*).
// The router also treats %2F as a literal segment char, not a separator.
const res = await fetch(app.serverUrl + '/api%2Fadmin/users');
expect(res.status).not.toBe(200);
});

test('null byte in path is caught by middleware as protected route', async () => {
// %00 decodes to a null char — /api/admin\0/users still matches
// /api/admin(.*) so our middleware correctly blocks it with 401
const res = await fetch(app.serverUrl + '/api/admin%00/users');
expect(res.status).toBe(401);
});

test('malformed percent-encoding returns 400 (clerkMiddleware catches MalformedURLError)', async () => {
// %zz is not valid percent-encoding — createPathMatcher throws
// MalformedURLError, which handleControlFlowErrors catches and returns 400
const res = await fetch(app.serverUrl + '/api/%zz/users');
expect(res.status).toBe(400);
});

test('encoded dot-current segment is caught by middleware', async () => {
// %2e = '.' — /api/%2e/admin/users resolves to /api/./admin/users → /api/admin/users
// Our middleware matches the resolved path as protected
const res = await fetch(app.serverUrl + '/api/%2e/admin/users');
expect(res.status).toBe(401);
});

test('encoded dot-parent segment does not reach protected route', async () => {
// %2e%2e = '..' — /api/%2e%2e/admin/users resolves to /api/../admin/users → /admin/users
// This doesn't match any route, returning 404
const res = await fetch(app.serverUrl + '/api/%2e%2e/admin/users');
expect(res.status).toBe(404);
});

test('encoded dot-parent traversal through fake segment is caught by middleware', async () => {
// /api/foo/%2e%2e/admin/users resolves to /api/foo/../admin/users → /api/admin/users
// Our middleware matches the resolved path as protected, returning 401
const res = await fetch(app.serverUrl + '/api/foo/%2e%2e/admin/users');
expect(res.status).toBe(401);
});

test('fully encoded dot segments with encoded slash are rejected', async () => {
// %2e%2f = './', %2e%2e%2f = '../' — when the slash is also encoded,
// the entire sequence is treated as a single path segment by the router
const dotSlashCurrent = await fetch(app.serverUrl + '/api%2f%2e%2fadmin/users');
expect(dotSlashCurrent.status).toBe(404);

const dotSlashParent = await fetch(app.serverUrl + '/api%2f%2e%2e%2fadmin/users');
expect(dotSlashParent.status).toBe(404);

const dotSlashTraversal = await fetch(app.serverUrl + '/api/foo%2f%2e%2e%2fadmin/users');
expect(dotSlashTraversal.status).toBe(404);
});

test('double slashes cannot bypass protected route', async () => {
// Double slashes before the protected segment
const res1 = await fetch(app.serverUrl + '//api/admin/users');
expect(res1.status).not.toBe(200);

// Double slashes in the middle of the path
const res2 = await fetch(app.serverUrl + '/api//admin/users');
expect(res2.status).not.toBe(200);
});
});
Loading
Loading