Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Fix storefrontRedirect and discount redirects #1399

Merged
merged 4 commits into from
Oct 10, 2023
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/twelve-pens-hope.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'demo-store': patch
---

Ensure that the `/discount?redirect=...` route only redirects to relative URLs.
5 changes: 5 additions & 0 deletions .changeset/wise-adults-sin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@shopify/hydrogen': patch
---

Ensure `storefrontRedirect` fallback only redirects to relative URLs.
171 changes: 171 additions & 0 deletions packages/hydrogen/src/routing/redirect.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
import {describe, it, expect, vi} from 'vitest';
import type {Storefront} from '../storefront';
import {storefrontRedirect} from './redirect';

describe('storefrontRedirect', () => {
const shopifyDomain = 'https://domain.myshopify.com';
const queryMock = vi.fn();
const storefrontMock = {
getShopifyDomain: () => shopifyDomain,
query: queryMock,
} as unknown as Storefront;

it('redirects to Shopify admin ', async () => {
await expect(
storefrontRedirect({
storefront: storefrontMock,
request: new Request('https://domain.com/admin'),
}),
).resolves.toEqual(
new Response(null, {
status: 302,
headers: {location: shopifyDomain + '/admin'},
}),
);
});

it('queries the SFAPI and redirects on match', async () => {
queryMock.mockResolvedValueOnce({
urlRedirects: {edges: [{node: {target: shopifyDomain + '/some-page'}}]},
});

await expect(
storefrontRedirect({
storefront: storefrontMock,
request: new Request('https://domain.com/some-page'),
}),
).resolves.toEqual(
new Response(null, {
status: 301,
headers: {location: shopifyDomain + '/some-page'},
}),
);

expect(queryMock).toHaveBeenCalledWith(expect.anything(), {
variables: {query: 'path:/some-page'},
});
});

it('queries the SFAPI and returns 404 on mismatch', async () => {
queryMock.mockResolvedValueOnce({
urlRedirects: {edges: []},
});

const response = new Response('Not Found', {status: 404});

await expect(
storefrontRedirect({
response,
storefront: storefrontMock,
request: new Request('https://domain.com/some-page'),
}),
).resolves.toEqual(response);

expect(queryMock).toHaveBeenCalledWith(expect.anything(), {
variables: {query: 'path:/some-page'},
});
});

it('queries the SFAPI and returns 404 on mismatch', async () => {
queryMock.mockResolvedValueOnce({urlRedirects: {edges: []}});
const response = new Response('Not Found', {status: 404});

await expect(
storefrontRedirect({
response,
storefront: storefrontMock,
request: new Request('https://domain.com/some-page'),
}),
).resolves.toEqual(response);

expect(queryMock).toHaveBeenCalledWith(expect.anything(), {
variables: {query: 'path:/some-page'},
});
});

describe('redirect fallback with search params', () => {
it('uses the "redirect" serach param as a fallback', async () => {
queryMock.mockResolvedValueOnce({urlRedirects: {edges: []}});
const response = new Response('Not Found', {status: 404});

await expect(
storefrontRedirect({
response,
storefront: storefrontMock,
request: new Request(
'https://domain.com/missing?redirect=/some-page',
),
}),
).resolves.toEqual(
new Response(null, {status: 302, headers: {location: '/some-page'}}),
);
});

it('uses the "return_to" serach param as a fallback', async () => {
queryMock.mockResolvedValueOnce({urlRedirects: {edges: []}});
const response = new Response('Not Found', {status: 404});

await expect(
storefrontRedirect({
response,
storefront: storefrontMock,
request: new Request(
'https://domain.com/missing?return_to=/some-page',
),
}),
).resolves.toEqual(
new Response(null, {status: 302, headers: {location: '/some-page'}}),
);
});

it('does not redirect to absolute URLs', async () => {
queryMock.mockResolvedValue({urlRedirects: {edges: []}});
const response = new Response('Not Found', {status: 404});

await expect(
storefrontRedirect({
response,
storefront: storefrontMock,
request: new Request(
'https://domain.com/missing?redirect=https://some-page.com',
),
}),
).resolves.toEqual(response);

await expect(
storefrontRedirect({
response,
storefront: storefrontMock,
request: new Request(
'https://domain.com/missing?redirect=//some-page.com',
),
}),
).resolves.toEqual(response);

await expect(
storefrontRedirect({
response,
storefront: storefrontMock,
request: new Request(
'https://domain.com/missing?redirect=javascript:alert(1)',
),
}),
).resolves.toEqual(response);

await expect(
storefrontRedirect({
response,
storefront: storefrontMock,
request: new Request(
'https://domain.com/missing?redirect=/some-page?param=https://another.com',
),
}),
).resolves.toEqual(
new Response(null, {
status: 302,
headers: {location: '/some-page?param=https://another.com'},
}),
);
});
});
});
17 changes: 5 additions & 12 deletions packages/hydrogen/src/routing/redirect.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,18 +75,11 @@ export async function storefrontRedirect(
}

function isLocalPath(url: string) {
try {
// We don't want to redirect cross domain,
// doing so could create fishing vulnerability
// If `new URL()` succeeds, it's a fully qualified
// url which is cross domain. If it fails, it's just
// a path, which will be the current domain.
new URL(url);
} catch (e) {
return true;
}

return false;
// We don't want to redirect cross domain,
// doing so could create phishing vulnerability
// Test for protocols, e.g. https://, http://, //
// and uris: mailto:, tel:, javascript:, etc.
return !/^(([a-z+-]+:)?\/\/|[a-z+-]+:)/i.test(url.trim());
}

const REDIRECT_QUERY = `#graphql
Expand Down
7 changes: 6 additions & 1 deletion templates/demo-store/app/routes/($locale).discount.$code.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,14 @@ export async function loader({request, context, params}: LoaderArgs) {

const url = new URL(request.url);
const searchParams = new URLSearchParams(url.search);
const redirectParam =
let redirectParam =
searchParams.get('redirect') || searchParams.get('return_to') || '/';

if (redirectParam.includes('//')) {
// Avoid redirecting to external URLs to prevent phishing attacks
redirectParam = '/';
}

searchParams.delete('redirect');
searchParams.delete('return_to');

Expand Down
7 changes: 6 additions & 1 deletion templates/skeleton/app/routes/discount.$code.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,14 @@ export async function loader({request, context, params}: LoaderArgs) {

const url = new URL(request.url);
const searchParams = new URLSearchParams(url.search);
const redirectParam =
let redirectParam =
searchParams.get('redirect') || searchParams.get('return_to') || '/';

if (redirectParam.includes('//')) {
// Avoid redirecting to external URLs to prevent phishing attacks
redirectParam = '/';
}

searchParams.delete('redirect');
searchParams.delete('return_to');

Expand Down