Skip to content

Commit b9a83f3

Browse files
authored
Add cross-origin guard to community-cli-plugin dev server (#59661)
1 parent 072a5b8 commit b9a83f3

12 files changed

Lines changed: 256 additions & 111 deletions
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
/**
2+
* Copyright (c) Meta Platforms, Inc. and affiliates.
3+
*
4+
* This source code is licensed under the MIT license found in the
5+
* LICENSE file in the root directory of this source tree.
6+
*
7+
* @flow strict
8+
* @format
9+
*/
10+
11+
declare module 'compression' {
12+
import type {NextHandleFunction} from 'connect';
13+
14+
declare module.exports: () => NextHandleFunction;
15+
}

‎flow-typed/npm/nocache_v3.x.x.js‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
/**
2+
* Copyright (c) Meta Platforms, Inc. and affiliates.
3+
*
4+
* This source code is licensed under the MIT license found in the
5+
* LICENSE file in the root directory of this source tree.
6+
*
7+
* @flow strict
8+
* @format
9+
*/
10+
11+
declare module 'nocache' {
12+
import type {NextHandleFunction} from 'connect';
13+
14+
declare module.exports: () => NextHandleFunction;
15+
}

‎packages/community-cli-plugin/package.json‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,13 @@
3535
"@react-native/asset-utils": "0.87.0-main",
3636
"@react-native/dev-middleware": "0.87.0-main",
3737
"commander": "^12.0.0",
38+
"compression": "^1.7.1",
3839
"connect": "^3.6.5",
3940
"debug": "^4.4.0",
4041
"invariant": "^2.2.4",
4142
"metro": "^0.88.0",
4243
"launch-editor": "^2.9.1",
44+
"nocache": "^3.0.1",
4345
"open": "^8.4.2",
4446
"semver": "^7.1.3"
4547
},
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
/**
2+
* Copyright (c) Meta Platforms, Inc. and affiliates.
3+
*
4+
* This source code is licensed under the MIT license found in the
5+
* LICENSE file in the root directory of this source tree.
6+
*
7+
* @flow strict-local
8+
* @format
9+
*/
10+
11+
import http from 'node:http';
12+
13+
jest.useRealTimers();
14+
15+
let server: http$Server;
16+
let baseUrl: string;
17+
18+
beforeEach(async () => {
19+
const connect = require('connect');
20+
const createDevServerMiddleware =
21+
require('../createDevServerMiddleware').default;
22+
const app = connect();
23+
server = http.createServer(app);
24+
await new Promise(resolve => server.listen(0, 'localhost', resolve));
25+
const address = server.address();
26+
if (address == null || typeof address === 'string') {
27+
throw new Error('Expected the server to listen on a TCP port');
28+
}
29+
baseUrl = `http://localhost:${address.port}`;
30+
app
31+
.use(
32+
createDevServerMiddleware({
33+
serverBaseUrl: new URL(baseUrl),
34+
watchFolders: ['/project'],
35+
}),
36+
)
37+
.use((req, res) => {
38+
res.writeHead(404);
39+
res.end();
40+
});
41+
});
42+
43+
afterEach(() => {
44+
server.closeAllConnections();
45+
return new Promise(resolve => server.close(() => resolve()));
46+
});
47+
48+
describe('createDevServerMiddleware', () => {
49+
test('refuses a cross-origin request before any route', async () => {
50+
const resp = await fetch(baseUrl + '/open-url', {
51+
headers: {Origin: 'https://example.com'},
52+
});
53+
54+
expect(resp.status).toBe(403);
55+
});
56+
});

‎packages/community-cli-plugin/src/dev-server/__tests__/openStackFrameMiddleware-test.js‎

Lines changed: 5 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ beforeEach(() => {
5252
});
5353

5454
async function startServer(
55-
mount: (app: Server, serverBaseUrl: URL) => void,
55+
mount: (app: Server) => void,
5656
): Promise<{server: http$Server, baseUrl: string}> {
5757
const app = connect();
5858
const server = http.createServer(app);
@@ -62,19 +62,18 @@ async function startServer(
6262
throw new Error('Expected the server to listen on a TCP port');
6363
}
6464
const baseUrl = `http://localhost:${address.port}`;
65-
mount(app, new URL(baseUrl));
65+
mount(app);
6666
app.use((req, res) => {
6767
res.writeHead(404);
6868
res.end();
6969
});
7070
return {server, baseUrl};
7171
}
7272

73-
function mountOpenStackFrame(app: Server, serverBaseUrl: URL) {
73+
function mountOpenStackFrame(app: Server) {
7474
app.use(
7575
'/open-stack-frame',
7676
require('../openStackFrameMiddleware').default({
77-
serverBaseUrl,
7877
watchFolders: [projectRoot],
7978
}),
8079
);
@@ -85,14 +84,10 @@ function stopServer(server: http$Server): Promise<void> {
8584
return new Promise(resolve => server.close(() => resolve()));
8685
}
8786

88-
function postFrame(
89-
baseUrl: string,
90-
body: string,
91-
headers?: {Origin?: string},
92-
): Promise<Response> {
87+
function postFrame(baseUrl: string, body: string): Promise<Response> {
9388
return fetch(baseUrl + '/open-stack-frame', {
9489
method: 'POST',
95-
headers: {...headers, 'Content-Type': 'application/json'},
90+
headers: {'Content-Type': 'application/json'},
9691
body,
9792
});
9893
}
@@ -129,17 +124,6 @@ describe('/open-stack-frame', () => {
129124
expect(launchEditor).toHaveBeenCalledTimes(1);
130125
});
131126

132-
test('refuses a cross-origin request', async () => {
133-
const resp = await postFrame(
134-
baseUrl,
135-
JSON.stringify({file: appFile, lineNumber: 12}),
136-
{Origin: 'https://example.com'},
137-
);
138-
139-
expect(resp.status).toBe(403);
140-
expect(launchEditor).not.toHaveBeenCalled();
141-
});
142-
143127
test('rejects a body that is not JSON', async () => {
144128
const resp = await postFrame(baseUrl, 'not json');
145129

@@ -188,30 +172,3 @@ describe('/open-stack-frame', () => {
188172
expect(launchEditor).not.toHaveBeenCalled();
189173
});
190174
});
191-
192-
describe('/open-stack-frame behind a middleware that serves it', () => {
193-
let server: http$Server;
194-
let baseUrl: string;
195-
196-
beforeEach(async () => {
197-
({server, baseUrl} = await startServer((app, serverBaseUrl) => {
198-
app.use('/open-stack-frame', (req, res, next) => {
199-
res.end('handled upstream');
200-
next();
201-
});
202-
mountOpenStackFrame(app, serverBaseUrl);
203-
}));
204-
});
205-
206-
afterEach(() => stopServer(server));
207-
208-
test('leaves the response to that middleware', async () => {
209-
const resp = await postFrame(
210-
baseUrl,
211-
JSON.stringify({file: appFile, lineNumber: 12}),
212-
);
213-
214-
expect(await resp.text()).toBe('handled upstream');
215-
expect(launchEditor).not.toHaveBeenCalled();
216-
});
217-
});

‎packages/community-cli-plugin/src/dev-server/__tests__/openURLMiddleware-test.js‎

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,7 @@ beforeEach(async () => {
3232
}
3333
baseUrl = `http://localhost:${address.port}`;
3434
app
35-
.use(
36-
'/open-url',
37-
require('../openURLMiddleware').default({
38-
serverBaseUrl: new URL(baseUrl),
39-
}),
40-
)
35+
.use('/open-url', require('../openURLMiddleware').default())
4136
.use((req, res) => {
4237
res.writeHead(404);
4338
res.end();
@@ -49,10 +44,10 @@ afterEach(() => {
4944
return new Promise(resolve => server.close(() => resolve()));
5045
});
5146

52-
function postURL(body: string, headers?: {Origin?: string}): Promise<Response> {
47+
function postURL(body: string): Promise<Response> {
5348
return fetch(baseUrl + '/open-url', {
5449
method: 'POST',
55-
headers: {...headers, 'Content-Type': 'application/json'},
50+
headers: {'Content-Type': 'application/json'},
5651
body,
5752
});
5853
}
@@ -80,16 +75,6 @@ describe('/open-url', () => {
8075
expect(open).toHaveBeenCalledTimes(1);
8176
});
8277

83-
test('refuses a cross-origin request', async () => {
84-
const resp = await postURL(
85-
JSON.stringify({url: 'https://reactnative.dev/'}),
86-
{Origin: 'https://example.com'},
87-
);
88-
89-
expect(resp.status).toBe(403);
90-
expect(open).not.toHaveBeenCalled();
91-
});
92-
9378
test('rejects a body that is not JSON', async () => {
9479
const resp = await postURL('not json');
9580

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
/**
2+
* Copyright (c) Meta Platforms, Inc. and affiliates.
3+
*
4+
* This source code is licensed under the MIT license found in the
5+
* LICENSE file in the root directory of this source tree.
6+
*
7+
* @flow strict-local
8+
* @format
9+
*/
10+
11+
import securityHeadersMiddleware from '../securityHeadersMiddleware';
12+
import connect from 'connect';
13+
import http from 'node:http';
14+
15+
jest.useRealTimers();
16+
17+
let server: http$Server;
18+
let baseUrl: string;
19+
let reached: JestMockFn<[], void>;
20+
21+
beforeEach(async () => {
22+
reached = jest.fn();
23+
const app = connect();
24+
server = http.createServer(app);
25+
await new Promise(resolve => server.listen(0, 'localhost', resolve));
26+
const address = server.address();
27+
if (address == null || typeof address === 'string') {
28+
throw new Error('Expected the server to listen on a TCP port');
29+
}
30+
baseUrl = `http://localhost:${address.port}`;
31+
app
32+
.use(securityHeadersMiddleware({serverBaseUrl: new URL(baseUrl)}))
33+
.use((req, res) => {
34+
reached();
35+
res.end('OK');
36+
});
37+
});
38+
39+
afterEach(() => {
40+
server.closeAllConnections();
41+
return new Promise(resolve => server.close(() => resolve()));
42+
});
43+
44+
describe('securityHeadersMiddleware', () => {
45+
test.each([
46+
['no origin', undefined],
47+
['the dev server origin', 'SERVER'],
48+
['a local origin on another port', 'http://localhost:3000'],
49+
['Chrome DevTools', 'devtools://devtools/bundled/inspector.html'],
50+
])('accepts a request from %s', async (_, origin) => {
51+
const resp = await fetch(baseUrl, {
52+
headers:
53+
origin == null ? {} : {Origin: origin === 'SERVER' ? baseUrl : origin},
54+
});
55+
56+
expect(resp.status).toBe(200);
57+
expect(resp.headers.get('X-Content-Type-Options')).toBe('nosniff');
58+
expect(reached).toHaveBeenCalledTimes(1);
59+
});
60+
61+
test.each([
62+
['another site', 'https://example.com'],
63+
['a malformed origin', 'not an origin'],
64+
])('refuses a request from %s', async (_, origin) => {
65+
const resp = await fetch(baseUrl, {headers: {Origin: origin}});
66+
67+
expect(resp.status).toBe(403);
68+
expect(reached).not.toHaveBeenCalled();
69+
});
70+
});
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
/**
2+
* Copyright (c) Meta Platforms, Inc. and affiliates.
3+
*
4+
* This source code is licensed under the MIT license found in the
5+
* LICENSE file in the root directory of this source tree.
6+
*
7+
* @flow strict-local
8+
* @format
9+
*/
10+
11+
import type {Server} from 'connect';
12+
13+
import openStackFrameMiddleware from './openStackFrameMiddleware';
14+
import openURLMiddleware from './openURLMiddleware';
15+
import securityHeadersMiddleware from './securityHeadersMiddleware';
16+
import compression from 'compression';
17+
import connect from 'connect';
18+
import nocache from 'nocache';
19+
20+
type Options = Readonly<{
21+
serverBaseUrl: URL,
22+
watchFolders: ReadonlyArray<string>,
23+
}>;
24+
25+
/**
26+
* The dev server routes that React Native tooling and apps call outside
27+
* Metro and `@react-native/dev-middleware`.
28+
*/
29+
export default function createDevServerMiddleware({
30+
serverBaseUrl,
31+
watchFolders,
32+
}: Options): Server {
33+
return connect()
34+
.use(securityHeadersMiddleware({serverBaseUrl}))
35+
.use(compression())
36+
.use(nocache())
37+
.use('/open-stack-frame', openStackFrameMiddleware({watchFolders}))
38+
.use('/open-url', openURLMiddleware());
39+
}

0 commit comments

Comments
 (0)