Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion apps/dashboard/src/app/global-error.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export default function GlobalError({ error }: any) {

return (
<html>
<body>
<body className="flex items-center justify-center min-h-screen">
{isProdLike ? (
<Spinner />
) : (
Expand Down
2 changes: 1 addition & 1 deletion packages/stack-shared/src/apps/apps-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ export const ALL_APPS = {
displayName: "Payments",
subtitle: "Payment processing and subscription management",
tags: ["operations", "gtm"],
stage: "stable",
stage: "beta",
Copy link

Choose a reason for hiding this comment

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

Bug: Payments stage downgraded from stable to beta unexpectedly

The payments feature stage is changed from stable to beta, which is a downgrade that appears unrelated to the PR's stated purpose of "Partitioned cookie support". Downgrading a feature from stable to beta is unusual and could affect users relying on the stable payments feature. This change may have been accidentally committed from a development or testing branch, as it doesn't align with the PR's scope.

Fix in Cursor Fix in Web

},
"emails": {
displayName: "Emails",
Expand Down
165 changes: 139 additions & 26 deletions packages/template/src/lib/cookie.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,67 @@ import { StackAssertionError } from '@stackframe/stack-shared/dist/utils/errors'
import Cookies from "js-cookie";
import { calculatePKCECodeChallenge, generateRandomCodeVerifier, generateRandomState } from "oauth4webapi";

type SetCookieOptions = { maxAge?: number, noOpIfServerComponent?: boolean, domain?: string, secure?: boolean };

// INFO: This file is used to manage cookies. It also sets some cookie flags automatically, see this description.
//
// It provides asynchronous setCookie, getCookie, deleteCookie, etc. functions that can be used in various environments
// (browser + Next.js for now). Under the hood, they just get a CookieHelper object and then set the cookies there.
//
// The CookieHelper object is a simple object that lets you set, get and delete cookies synchronously. Acquiring one
// is asynchronous (except for browser environments, where they can be acquired synchronously), but once you have it,
// you can use it synchronously. This function is useful if you cannot await in the calling code, but otherwise you
// should prefer to await the functions directly.
//
// Some cookie flags are set automatically by the CookieHelper (and hence also the <xyz>Cookie functions).
// In particular:
// - SameSite is set to `Lax` by default, which is already true in Chromium-based browsers, so this creates
// compatibility with other browsers that use either Strict or None (particularly Safari and Firefox, and older
// versions of Chrome). If Partitioned is automatically set (as described below), then this value is set to `None`
// instead.
// - Secure is set depending on whether we could successfully determine that the client is on HTTPS. For this, we use a
// set of heuristics:
// - In a browser environment, we check window.location.protocol which is always accurate
// - In a Next.js server environment:
// - First we check the `stack-is-https` cookie, which is set in various places on the
// client with a Secure attribute. If that one is passed on to the server, we know that the client is on HTTPS
// and we can set the Secure flag on the cookie. TODO: Should we also do this with a second cookie with a
// __Host- prefix, so a malicious subdomain of the current domain cannot forcibly enable HTTPS mode and
// therefore prevent new cookies from being set?
// - Otherwise, we check the X-Forwarded-Proto header. If that one is `https`, we know that the client is
// (pretending to be) on HTTPS and we can set the Secure flag on the cookie. Note that this header is
// spoofable by malicious clients (so is the cookie actually), but since setting this value can only *increase*
// security (and therefore prevent setting of a cookie), and requires a malicious client, this is still safe.
// - If neither of the above is true, we don't set the Secure flag on the cookie.
// - Partitioned is set depending on whether it is needed & supported. Unfortunately, the fact that Partitioned
// cookies require SameSite=None, browsers that don't support it will still set them as normal third-party cookies,
// which are fundamentally unsafe. Therefore, we need to take extra care that we only ever set Partitioned cookies
// if we know for sure that the browser supports it.
// - In a browser environment, we check:
// - Whether `Secure` is set. If it's not, we don't set Partitioned.
// - Whether we can set & retrieve cookies without Partitioned being set. If this is the case, we are likely in a
// top-level context or a browser that partitions cookies by default (eg. Firefox). In this case, we don't need
// Partitioned and can just proceed as normal.
// - Whether CHIPS is supported. To prevent the case where CHIPS is not supported but third-party cookies are (in
// which we would accidentally set SameSite=None without Partitioned as the latter requires the former), we
// check this by running a simple test with document.cookie.
// - Whether the browser supports Partitioned cookies. If yes, set Partitioned. Otherwise, don't set Partitioned.
// Since there's no easy cross-compat way to do this (CookieStore and document.cookie do not return whether a
// cookie is partitioned on some/all versions of Safari and Firefox), we use a heuristic; we run this test by
// creating two cookies with the same name: One with Partitioned and one without. If there are two resulting
// cookies, that means they were put into different jars, implying that the browser supports Partitioned cookies
// (but doesn't partition cookies by default). If they result in just one cookie, that could mean that the
// browser doesn't support Partitioned cookies, or that the browser doesn't put partitioned cookies into
// different jars by default, in which case we still don't know. This heuristic works on Chrome, but may
// incorrectly conclude that some other browsers don't support Partitioned. But from a security perspective,
// that is better than accidentally setting SameSite=None without Partitioned. TODO: Find a better heuristic to
// to determine whether the browser supports Partitioned cookies or not.
// - In a Next.js server environment, right now we do nothing because of the complexity involved :( TODO: In the
// future, we could improve this for example by setting hint cookies from the client, but we need to make sure that
// no malicious actor (eg. on a malicious subdomain) can forcefully enable Partitioned cookies on a browser that
// does not support it.


type SetCookieOptions = { maxAge: number | "session", noOpIfServerComponent?: boolean, domain?: string, secure?: boolean };
type DeleteCookieOptions = { noOpIfServerComponent?: boolean, domain?: string };

function ensureClient() {
Expand Down Expand Up @@ -85,7 +145,7 @@ function createNextCookieHelper(
getAll: () => {
// set a helper cookie, see comment in `NextCookieHelper.set` below
try {
rscCookiesAwaited.set("stack-is-https", "true", { secure: true });
rscCookiesAwaited.set("stack-is-https", "true", { secure: true, expires: new Date(Date.now() + 1000 * 60 * 60 * 24 * 365) });
} catch (e) {
if (
typeof e === 'object'
Expand All @@ -108,13 +168,7 @@ function createNextCookieHelper(
set: (name: string, value: string, options: SetCookieOptions) => {
// Whenever the client is on HTTPS, we want to set the Secure flag on the cookie.
//
// This is not easy to find out on a Next.js server, so we use the following steps:
//
// 1. If we're on the client, we can check window.location.protocol which is the ground-truth
// 2. Check whether the stack-is-https cookie exists. This cookie is set in various places on
// the client if the protocol is known to be HTTPS
// 3. Check the X-Forwarded-Proto header
// 4. Otherwise, assume HTTP without the S
// This is not easy to find out on a Next.js server, so see the algorithm at the top of this file.
//
// Note that malicious clients could theoretically manipulate the `stack-is-https` cookie or
// the `X-Forwarded-Proto` header; that wouldn't cause any trouble except for themselves,
Expand All @@ -124,21 +178,22 @@ function createNextCookieHelper(
try {
rscCookiesAwaited.set(name, value, {
secure: isSecureCookie,
maxAge: options.maxAge,
maxAge: options.maxAge === "session" ? undefined : options.maxAge,
domain: options.domain,
sameSite: "lax",
});
} catch (e) {
handleCookieError(e, options);
}
},
setOrDelete(name: string, value: string | null, options: SetCookieOptions & DeleteCookieOptions = {}) {
setOrDelete(name: string, value: string | null, options: SetCookieOptions & DeleteCookieOptions) {
if (value === null) {
this.delete(name, options);
} else {
this.set(name, value, options);
}
},
delete(name: string, options: DeleteCookieOptions = {}) {
delete(name: string, options: DeleteCookieOptions) {
try {
if (options.domain !== undefined) {
rscCookiesAwaited.delete({ name, domain: options.domain });
Expand All @@ -162,7 +217,7 @@ export function getCookieClient(name: string): string | null {
export function getAllCookiesClient(): Record<string, string> {
ensureClient();
// set a helper cookie, see comment in `NextCookieHelper.set` above
Cookies.set("stack-is-https", "true", { secure: true });
Cookies.set("stack-is-https", "true", { secure: true, expires: new Date(Date.now() + 1000 * 60 * 60 * 24 * 365) });
return Cookies.get();
}

Expand All @@ -189,27 +244,85 @@ function determineSecureFromServerContext(
cookies: Awaited<ReturnType<typeof rscCookies>>,
headers: Awaited<ReturnType<typeof rscHeaders>>,
): boolean {
// see the algorithm at the top of this file
// TODO: We should probably also check that the stack-is-https cookie has a Secure attribute itself,
// TODO: We should consider adding another cookie __Host-stack-is-https, see the comment in the algorithm at the top of this file
return cookies.has("stack-is-https") || headers.get("x-forwarded-proto") === "https";
}
// END_PLATFORM

function setCookieClientInternal(name: string, value: string, options: SetCookieOptions = {}) {

let _shouldSetPartitionedClientCache: boolean | undefined = undefined;
function shouldSetPartitionedClient() {
return _shouldSetPartitionedClientCache ??= _internalShouldSetPartitionedClient();
}
function _internalShouldSetPartitionedClient() {
ensureClient();

if (!(determineSecureFromClientContext())) {
return false;
}

// check whether we can set & retrieve normal cookies (either because we're on a top-level/same-origin context or the browser partitions cookies by default)
const cookie1Name = "__Host-stack-temporary-chips-test-" + Math.random().toString(36).substring(2, 15);
document.cookie = `${cookie1Name}=value1; Secure; path=/`;
const cookies1 = document.cookie.split("; ");
document.cookie = `${cookie1Name}=delete1; Secure; path=/; expires=Thu, 01 Jan 1970 00:00:00 UTC;`;
if (cookies1.some((c) => c.startsWith(cookie1Name + "="))) {
return false;
}


// check whether Partitioned cookies are supported by the browser
// TODO: See comment at the top. Feels like we should find a better way to do this
const cookie2Name = "__Host-stack-temporary-chips-test-" + Math.random().toString(36).substring(2, 15);

// just to be safe, delete the cookie first to avoid weird RNG-prediction attacks
// I don't know what they look like (since this is a host cookie) but better safe than sorry
// (this function should be 100% bulletproof so we don't accidentally fall back to non-partitioned third party cookies on unsupported browsers)
document.cookie = `${cookie2Name}=delete1; Secure; SameSite=None; Partitioned; expires=Thu, 01 Jan 1970 00:00:00 UTC; path=/`;
document.cookie = `${cookie2Name}=delete2; Secure; SameSite=None; expires=Thu, 01 Jan 1970 00:00:00 UTC; path=/`;

// set the cookie, once partitioned and once not partitioned
document.cookie = `${cookie2Name}=set1; Secure; SameSite=None; Partitioned; path=/`;
document.cookie = `${cookie2Name}=set2; Secure; SameSite=None; path=/`;

// check if there are two cookies
const cookies2 = document.cookie.split("; ");
const numberOfCookiesWithThisName = cookies2.filter((c) => c.startsWith(cookie2Name + "=")).length;

// clean up
document.cookie = `${cookie2Name}=delete3; Secure; SameSite=None; Partitioned; expires=Thu, 01 Jan 1970 00:00:00 UTC; path=/`;
document.cookie = `${cookie2Name}=delete4; Secure; SameSite=None; expires=Thu, 01 Jan 1970 00:00:00 UTC; path=/`;

return numberOfCookiesWithThisName === 2;
}

function setCookieClientInternal(name: string, value: string, options: SetCookieOptions) {
const secure = options.secure ?? determineSecureFromClientContext();
const partitioned = shouldSetPartitionedClient();
Cookies.set(name, value, {
expires: options.maxAge === undefined ? undefined : new Date(Date.now() + (options.maxAge) * 1000),
expires: options.maxAge === "session" ? undefined : new Date(Date.now() + (options.maxAge) * 1000),
domain: options.domain,
secure,
sameSite: "Lax",
...(partitioned ? {
partitioned,
sameSite: "None",
} : {}),
});
}

function deleteCookieClientInternal(name: string, options: DeleteCookieOptions = {}) {
if (options.domain !== undefined) {
Cookies.remove(name, { domain: options.domain, secure: determineSecureFromClientContext() });
function deleteCookieClientInternal(name: string, options: DeleteCookieOptions) {
for (const partitioned of [true, false]) {
if (options.domain !== undefined) {
Cookies.remove(name, { domain: options.domain, secure: determineSecureFromClientContext(), partitioned });
}
Cookies.remove(name, { secure: determineSecureFromClientContext(), partitioned });
}
Cookies.remove(name, { secure: determineSecureFromClientContext() });
}

export function setOrDeleteCookieClient(name: string, value: string | null, options: SetCookieOptions & DeleteCookieOptions = {}) {
export function setOrDeleteCookieClient(name: string, value: string | null, options: SetCookieOptions & DeleteCookieOptions) {
ensureClient();
if (value === null) {
deleteCookieClientInternal(name, options);
Expand All @@ -218,27 +331,27 @@ export function setOrDeleteCookieClient(name: string, value: string | null, opti
}
}

export async function setOrDeleteCookie(name: string, value: string | null, options: SetCookieOptions & DeleteCookieOptions = {}) {
export async function setOrDeleteCookie(name: string, value: string | null, options: SetCookieOptions & DeleteCookieOptions) {
const cookieHelper = await createCookieHelper();
cookieHelper.setOrDelete(name, value, options);
}

export function deleteCookieClient(name: string, options: DeleteCookieOptions = {}) {
export function deleteCookieClient(name: string, options: DeleteCookieOptions) {
ensureClient();
deleteCookieClientInternal(name, options);
}

export async function deleteCookie(name: string, options: DeleteCookieOptions = {}) {
export async function deleteCookie(name: string, options: DeleteCookieOptions) {
const cookieHelper = await createCookieHelper();
cookieHelper.delete(name, options);
}

export function setCookieClient(name: string, value: string, options: SetCookieOptions = {}) {
export function setCookieClient(name: string, value: string, options: SetCookieOptions) {
ensureClient();
setCookieClientInternal(name, value, options);
}

export async function setCookie(name: string, value: string, options: SetCookieOptions = {}) {
export async function setCookie(name: string, value: string, options: SetCookieOptions) {
const cookieHelper = await createCookieHelper();
cookieHelper.set(name, value, options);
}
Expand All @@ -263,7 +376,7 @@ export function consumeVerifierAndStateCookie(state: string) {
if (!codeVerifier) {
return null;
}
deleteCookieClient(cookieName);
deleteCookieClient(cookieName, {});
return {
codeVerifier,
};
Expand Down
Loading