Unverified Commit 937254ed authored by Shu Ding's avatar Shu Ding Committed by GitHub

Add `serverActions.allowedForwardedHosts` option (#57529)

This new option specifies a list of host names that are considered safe, to accept as Server Action requests if they're different from the initial request origin. It can be very helpful when the hosted app has many layers of reverse proxies ahead.

Closes #57397.
parent 1caa5808
...@@ -155,13 +155,7 @@ async fn wrap_edge_page( ...@@ -155,13 +155,7 @@ async fn wrap_edge_page(
// TODO(timneutkens): remove this // TODO(timneutkens): remove this
let is_server_component = true; let is_server_component = true;
// let server_actions_body_size_limit = let server_actions = next_config.experimental.server_actions.as_ref();
// &next_config.experimental.server_actions.body_size_limit;
let server_actions_body_size_limit = next_config
.experimental
.server_actions
.as_ref()
.and_then(|sa| sa.body_size_limit.as_ref());
let sri_enabled = !dev let sri_enabled = !dev
&& next_config && next_config
...@@ -184,7 +178,7 @@ async fn wrap_edge_page( ...@@ -184,7 +178,7 @@ async fn wrap_edge_page(
"nextConfig" => serde_json::to_string(next_config)?, "nextConfig" => serde_json::to_string(next_config)?,
"isServerComponent" => serde_json::Value::Bool(is_server_component).to_string(), "isServerComponent" => serde_json::Value::Bool(is_server_component).to_string(),
"dev" => serde_json::Value::Bool(dev).to_string(), "dev" => serde_json::Value::Bool(dev).to_string(),
"serverActionsBodySizeLimit" => serde_json::to_string(&server_actions_body_size_limit)? "serverActions" => serde_json::to_string(&server_actions)?
}, },
indexmap! { indexmap! {
"incrementalCacheHandler" => None, "incrementalCacheHandler" => None,
......
...@@ -417,8 +417,7 @@ export function getEdgeServerEntry(opts: { ...@@ -417,8 +417,7 @@ export function getEdgeServerEntry(opts: {
middlewareConfig: Buffer.from( middlewareConfig: Buffer.from(
JSON.stringify(opts.middlewareConfig || {}) JSON.stringify(opts.middlewareConfig || {})
).toString('base64'), ).toString('base64'),
serverActionsBodySizeLimit: serverActions: opts.config.experimental.serverActions,
opts.config.experimental.serverActions?.bodySizeLimit,
} }
return { return {
......
...@@ -23,12 +23,12 @@ const error500Mod = null ...@@ -23,12 +23,12 @@ const error500Mod = null
declare const sriEnabled: boolean declare const sriEnabled: boolean
declare const isServerComponent: boolean declare const isServerComponent: boolean
declare const dev: boolean declare const dev: boolean
declare const serverActionsBodySizeLimit: any declare const serverActions: any
declare const nextConfig: NextConfigComplete declare const nextConfig: NextConfigComplete
// INJECT:sriEnabled // INJECT:sriEnabled
// INJECT:isServerComponent // INJECT:isServerComponent
// INJECT:dev // INJECT:dev
// INJECT:serverActionsBodySizeLimit // INJECT:serverActions
// INJECT:nextConfig // INJECT:nextConfig
const maybeJSONParse = (str?: string) => (str ? JSON.parse(str) : undefined) const maybeJSONParse = (str?: string) => (str ? JSON.parse(str) : undefined)
...@@ -58,9 +58,7 @@ const render = getRender({ ...@@ -58,9 +58,7 @@ const render = getRender({
reactLoadableManifest, reactLoadableManifest,
clientReferenceManifest: isServerComponent ? rscManifest : null, clientReferenceManifest: isServerComponent ? rscManifest : null,
serverActionsManifest: isServerComponent ? rscServerManifest : null, serverActionsManifest: isServerComponent ? rscServerManifest : null,
serverActionsBodySizeLimit: isServerComponent serverActions: isServerComponent ? serverActions : undefined,
? serverActionsBodySizeLimit
: undefined,
subresourceIntegrityManifest, subresourceIntegrityManifest,
config: nextConfig, config: nextConfig,
buildId: 'VAR_BUILD_ID', buildId: 'VAR_BUILD_ID',
......
...@@ -26,7 +26,10 @@ export type EdgeSSRLoaderQuery = { ...@@ -26,7 +26,10 @@ export type EdgeSSRLoaderQuery = {
incrementalCacheHandlerPath?: string incrementalCacheHandlerPath?: string
preferredRegion: string | string[] | undefined preferredRegion: string | string[] | undefined
middlewareConfig: string middlewareConfig: string
serverActionsBodySizeLimit?: SizeLimit serverActions?: {
bodySizeLimit?: SizeLimit
allowedForwardedHosts?: string[]
}
} }
/* /*
...@@ -75,7 +78,7 @@ const edgeSSRLoader: webpack.LoaderDefinitionFunction<EdgeSSRLoaderQuery> = ...@@ -75,7 +78,7 @@ const edgeSSRLoader: webpack.LoaderDefinitionFunction<EdgeSSRLoaderQuery> =
incrementalCacheHandlerPath, incrementalCacheHandlerPath,
preferredRegion, preferredRegion,
middlewareConfig: middlewareConfigBase64, middlewareConfig: middlewareConfigBase64,
serverActionsBodySizeLimit, serverActions,
} = this.getOptions() } = this.getOptions()
const middlewareConfig: MiddlewareConfig = JSON.parse( const middlewareConfig: MiddlewareConfig = JSON.parse(
...@@ -148,10 +151,10 @@ const edgeSSRLoader: webpack.LoaderDefinitionFunction<EdgeSSRLoaderQuery> = ...@@ -148,10 +151,10 @@ const edgeSSRLoader: webpack.LoaderDefinitionFunction<EdgeSSRLoaderQuery> =
nextConfig: stringifiedConfig, nextConfig: stringifiedConfig,
isServerComponent: JSON.stringify(isServerComponent), isServerComponent: JSON.stringify(isServerComponent),
dev: JSON.stringify(dev), dev: JSON.stringify(dev),
serverActionsBodySizeLimit: serverActions:
typeof serverActionsBodySizeLimit === 'undefined' typeof serverActions === 'undefined'
? 'undefined' ? 'undefined'
: JSON.stringify(serverActionsBodySizeLimit), : JSON.stringify(serverActions),
}, },
{ {
incrementalCacheHandler: incrementalCacheHandlerPath ?? null, incrementalCacheHandler: incrementalCacheHandlerPath ?? null,
......
...@@ -34,7 +34,7 @@ export function getRender({ ...@@ -34,7 +34,7 @@ export function getRender({
clientReferenceManifest, clientReferenceManifest,
subresourceIntegrityManifest, subresourceIntegrityManifest,
serverActionsManifest, serverActionsManifest,
serverActionsBodySizeLimit, serverActions,
config, config,
buildId, buildId,
nextFontManifest, nextFontManifest,
...@@ -55,7 +55,10 @@ export function getRender({ ...@@ -55,7 +55,10 @@ export function getRender({
subresourceIntegrityManifest?: Record<string, string> subresourceIntegrityManifest?: Record<string, string>
clientReferenceManifest?: ClientReferenceManifest clientReferenceManifest?: ClientReferenceManifest
serverActionsManifest?: any serverActionsManifest?: any
serverActionsBodySizeLimit?: SizeLimit serverActions?: {
bodySizeLimit?: SizeLimit
allowedForwardedHosts?: string[]
}
config: NextConfigComplete config: NextConfigComplete
buildId: string buildId: string
nextFontManifest: NextFontManifest nextFontManifest: NextFontManifest
...@@ -87,7 +90,7 @@ export function getRender({ ...@@ -87,7 +90,7 @@ export function getRender({
supportsDynamicHTML: true, supportsDynamicHTML: true,
disableOptimizedLoading: true, disableOptimizedLoading: true,
serverActionsManifest, serverActionsManifest,
serverActionsBodySizeLimit, serverActions,
nextFontManifest, nextFontManifest,
}, },
renderToHTML, renderToHTML,
......
...@@ -32,7 +32,6 @@ import { ...@@ -32,7 +32,6 @@ import {
import { traverseModules, forEachEntryModule } from '../utils' import { traverseModules, forEachEntryModule } from '../utils'
import { normalizePathSep } from '../../../shared/lib/page-path/normalize-path-sep' import { normalizePathSep } from '../../../shared/lib/page-path/normalize-path-sep'
import { getProxiedPluginState } from '../../build-context' import { getProxiedPluginState } from '../../build-context'
import type { SizeLimit } from '../../../../types'
import semver from 'next/dist/compiled/semver' import semver from 'next/dist/compiled/semver'
import { generateRandomActionKeyRaw } from '../../../server/app-render/action-encryption-utils' import { generateRandomActionKeyRaw } from '../../../server/app-render/action-encryption-utils'
...@@ -40,7 +39,6 @@ interface Options { ...@@ -40,7 +39,6 @@ interface Options {
dev: boolean dev: boolean
appDir: string appDir: string
isEdgeServer: boolean isEdgeServer: boolean
serverActionsBodySizeLimit?: SizeLimit
} }
const PLUGIN_NAME = 'FlightClientEntryPlugin' const PLUGIN_NAME = 'FlightClientEntryPlugin'
...@@ -160,14 +158,12 @@ export class FlightClientEntryPlugin { ...@@ -160,14 +158,12 @@ export class FlightClientEntryPlugin {
dev: boolean dev: boolean
appDir: string appDir: string
isEdgeServer: boolean isEdgeServer: boolean
serverActionsBodySizeLimit?: SizeLimit
assetPrefix: string assetPrefix: string
constructor(options: Options) { constructor(options: Options) {
this.dev = options.dev this.dev = options.dev
this.appDir = options.appDir this.appDir = options.appDir
this.isEdgeServer = options.isEdgeServer this.isEdgeServer = options.isEdgeServer
this.serverActionsBodySizeLimit = options.serverActionsBodySizeLimit
this.assetPrefix = !this.dev && !this.isEdgeServer ? '../' : '' this.assetPrefix = !this.dev && !this.isEdgeServer ? '../' : ''
} }
......
...@@ -488,8 +488,7 @@ export async function exportAppImpl( ...@@ -488,8 +488,7 @@ export async function exportAppImpl(
optimizeFonts: nextConfig.optimizeFonts as FontConfig, optimizeFonts: nextConfig.optimizeFonts as FontConfig,
largePageDataBytes: nextConfig.experimental.largePageDataBytes, largePageDataBytes: nextConfig.experimental.largePageDataBytes,
serverComponents: options.hasAppDir, serverComponents: options.hasAppDir,
serverActionsBodySizeLimit: serverActions: nextConfig.experimental.serverActions,
nextConfig.experimental.serverActions?.bodySizeLimit,
nextFontManifest: require(join( nextFontManifest: require(join(
distDir, distDir,
'server', 'server',
......
...@@ -79,6 +79,7 @@ const supportedTurbopackNextConfigOptions = [ ...@@ -79,6 +79,7 @@ const supportedTurbopackNextConfigOptions = [
'experimental.scrollRestoration', 'experimental.scrollRestoration',
'experimental.forceSwcTransforms', 'experimental.forceSwcTransforms',
'experimental.serverActions.bodySizeLimit', 'experimental.serverActions.bodySizeLimit',
'experimental.serverActions.allowedForwardedHosts',
'experimental.memoryBasedWorkersCount', 'experimental.memoryBasedWorkersCount',
'experimental.clientRouterFilterRedirects', 'experimental.clientRouterFilterRedirects',
'experimental.webpackBuildWorker', 'experimental.webpackBuildWorker',
......
...@@ -216,7 +216,7 @@ export async function handleAction({ ...@@ -216,7 +216,7 @@ export async function handleAction({
generateFlight, generateFlight,
staticGenerationStore, staticGenerationStore,
requestStore, requestStore,
serverActionsBodySizeLimit, serverActions,
ctx, ctx,
}: { }: {
req: IncomingMessage req: IncomingMessage
...@@ -232,7 +232,10 @@ export async function handleAction({ ...@@ -232,7 +232,10 @@ export async function handleAction({
generateFlight: GenerateFlight generateFlight: GenerateFlight
staticGenerationStore: StaticGenerationStore staticGenerationStore: StaticGenerationStore
requestStore: RequestStore requestStore: RequestStore
serverActionsBodySizeLimit?: SizeLimit serverActions?: {
bodySizeLimit?: SizeLimit
allowedForwardedHosts?: string[]
}
ctx: AppRenderContext ctx: AppRenderContext
}): Promise< }): Promise<
| undefined | undefined
...@@ -277,6 +280,14 @@ export async function handleAction({ ...@@ -277,6 +280,14 @@ export async function handleAction({
'Missing `origin` header from a forwarded Server Actions request.' 'Missing `origin` header from a forwarded Server Actions request.'
) )
} else if (!host || originHostname !== host) { } else if (!host || originHostname !== host) {
// If the customer sets a list of allowed hosts, we'll allow the request.
// These can be their reverse proxies or other safe hosts.
if (
typeof host === 'string' &&
serverActions?.allowedForwardedHosts?.includes(host)
) {
// Ignore it
} else {
// This is an attack. We should not proceed the action. // This is an attack. We should not proceed the action.
console.error( console.error(
'`x-forwarded-host` and `host` headers do not match `origin` header from a forwarded Server Actions request. Aborting the action.' '`x-forwarded-host` and `host` headers do not match `origin` header from a forwarded Server Actions request. Aborting the action.'
...@@ -304,6 +315,7 @@ export async function handleAction({ ...@@ -304,6 +315,7 @@ export async function handleAction({
throw error throw error
} }
}
// ensure we avoid caching server actions unexpectedly // ensure we avoid caching server actions unexpectedly
res.setHeader( res.setHeader(
...@@ -421,15 +433,14 @@ export async function handleAction({ ...@@ -421,15 +433,14 @@ export async function handleAction({
const actionData = Buffer.concat(chunks).toString('utf-8') const actionData = Buffer.concat(chunks).toString('utf-8')
const limit = require('next/dist/compiled/bytes').parse( const readableLimit = serverActions?.bodySizeLimit ?? '1 MB'
serverActionsBodySizeLimit ?? '1mb' const limit = require('next/dist/compiled/bytes').parse(readableLimit)
)
if (actionData.length > limit) { if (actionData.length > limit) {
const { ApiError } = require('../api-utils') const { ApiError } = require('../api-utils')
throw new ApiError( throw new ApiError(
413, 413,
`Body exceeded ${serverActionsBodySizeLimit} limit. `Body exceeded ${readableLimit} limit.
To configure the body size limit for Server Actions, see: https://nextjs.org/docs/app/api-reference/server-actions#size-limitation` To configure the body size limit for Server Actions, see: https://nextjs.org/docs/app/api-reference/server-actions#size-limitation`
) )
} }
......
...@@ -409,7 +409,7 @@ async function renderToHTMLOrFlightImpl( ...@@ -409,7 +409,7 @@ async function renderToHTMLOrFlightImpl(
dev, dev,
nextFontManifest, nextFontManifest,
supportsDynamicHTML, supportsDynamicHTML,
serverActionsBodySizeLimit, serverActions,
buildId, buildId,
appDirDevErrorLogger, appDirDevErrorLogger,
assetPrefix = '', assetPrefix = '',
...@@ -955,7 +955,7 @@ async function renderToHTMLOrFlightImpl( ...@@ -955,7 +955,7 @@ async function renderToHTMLOrFlightImpl(
generateFlight, generateFlight,
staticGenerationStore: staticGenerationStore, staticGenerationStore: staticGenerationStore,
requestStore: requestStore, requestStore: requestStore,
serverActionsBodySizeLimit, serverActions,
ctx, ctx,
}) })
......
...@@ -132,7 +132,11 @@ export interface RenderOptsPartial { ...@@ -132,7 +132,11 @@ export interface RenderOptsPartial {
rawConfig?: boolean, rawConfig?: boolean,
silent?: boolean silent?: boolean
) => Promise<NextConfigComplete> ) => Promise<NextConfigComplete>
serverActionsBodySizeLimit?: SizeLimit serverActions?: {
bodySizeLimit?: SizeLimit
allowedForwardedHosts?: string[]
}
allowedForwardedHosts?: string[]
params?: ParsedUrlQuery params?: ParsedUrlQuery
isPrefetch?: boolean isPrefetch?: boolean
ppr: boolean ppr: boolean
......
...@@ -245,7 +245,10 @@ type BaseRenderOpts = { ...@@ -245,7 +245,10 @@ type BaseRenderOpts = {
supportsDynamicHTML?: boolean supportsDynamicHTML?: boolean
isBot?: boolean isBot?: boolean
clientReferenceManifest?: ClientReferenceManifest clientReferenceManifest?: ClientReferenceManifest
serverActionsBodySizeLimit?: SizeLimit serverActions?: {
bodySizeLimit?: SizeLimit
allowedForwardedHosts?: string[]
}
serverActionsManifest?: any serverActionsManifest?: any
nextFontManifest?: NextFontManifest nextFontManifest?: NextFontManifest
renderServerComponentData?: boolean renderServerComponentData?: boolean
...@@ -2106,8 +2109,7 @@ export default abstract class Server<ServerOptions extends Options = Options> { ...@@ -2106,8 +2109,7 @@ export default abstract class Server<ServerOptions extends Options = Options> {
incrementalCache, incrementalCache,
isRevalidate: isSSG, isRevalidate: isSSG,
originalPathname: components.ComponentMod.originalPathname, originalPathname: components.ComponentMod.originalPathname,
serverActionsBodySizeLimit: serverActions: this.nextConfig.experimental.serverActions,
this.nextConfig.experimental.serverActions?.bodySizeLimit,
} }
: {}), : {}),
isDataReq, isDataReq,
......
...@@ -251,7 +251,13 @@ export const configSchema: zod.ZodType<NextConfig> = z.lazy(() => ...@@ -251,7 +251,13 @@ export const configSchema: zod.ZodType<NextConfig> = z.lazy(() =>
disableOptimizedLoading: z.boolean().optional(), disableOptimizedLoading: z.boolean().optional(),
disablePostcssPresetEnv: z.boolean().optional(), disablePostcssPresetEnv: z.boolean().optional(),
esmExternals: z.union([z.boolean(), z.literal('loose')]).optional(), esmExternals: z.union([z.boolean(), z.literal('loose')]).optional(),
serverActionsBodySizeLimit: zSizeLimit.optional(), serverActions: z
.object({
bodySizeLimit: zSizeLimit.optional(),
allowedForwardedHosts: z.array(z.string()).optional(),
})
.optional(),
allowedForwardedHosts: z.array(z.string()).optional(),
// The original type was Record<string, any> // The original type was Record<string, any>
extensionAlias: z.record(z.string(), z.any()).optional(), extensionAlias: z.record(z.string(), z.any()).optional(),
externalDir: z.boolean().optional(), externalDir: z.boolean().optional(),
......
...@@ -307,6 +307,13 @@ export interface ExperimentalConfig { ...@@ -307,6 +307,13 @@ export interface ExperimentalConfig {
* Allows adjusting body parser size limit for server actions. * Allows adjusting body parser size limit for server actions.
*/ */
bodySizeLimit?: SizeLimit bodySizeLimit?: SizeLimit
/**
* Allowed domains that can bypass CSRF check.
* @example
* ["my-reverse-proxy.com"]
*/
allowedForwardedHosts?: string[]
} }
/** /**
......
...@@ -417,6 +417,7 @@ function assignDefaults( ...@@ -417,6 +417,7 @@ function assignDefaults(
} }
} }
if (typeof result.experimental?.serverActions === 'boolean') {
// TODO: Remove this warning in Next.js 15 // TODO: Remove this warning in Next.js 15
warnOptionHasBeenDeprecated( warnOptionHasBeenDeprecated(
result, result,
...@@ -424,6 +425,7 @@ function assignDefaults( ...@@ -424,6 +425,7 @@ function assignDefaults(
'Server Actions are available by default now, `experimental.serverActions` option can be safely removed.', 'Server Actions are available by default now, `experimental.serverActions` option can be safely removed.',
silent silent
) )
}
if (result.swcMinify === false) { if (result.swcMinify === false) {
// TODO: Remove this warning in Next.js 15 // TODO: Remove this warning in Next.js 15
......
...@@ -273,7 +273,11 @@ export type RenderOptsPartial = { ...@@ -273,7 +273,11 @@ export type RenderOptsPartial = {
isBot?: boolean isBot?: boolean
runtime?: ServerRuntime runtime?: ServerRuntime
serverComponents?: boolean serverComponents?: boolean
serverActionsBodySizeLimit?: SizeLimit serverActions?: {
bodySizeLimit?: SizeLimit
allowedForwardedHosts?: string[]
}
allowedForwardedHosts?: string[]
customServer?: boolean customServer?: boolean
crossOrigin?: 'anonymous' | 'use-credentials' | '' | undefined crossOrigin?: 'anonymous' | 'use-credentials' | '' | undefined
images: ImageConfigComplete images: ImageConfigComplete
......
import { createNextDescribe } from 'e2e-utils'
import { check } from 'next-test-utils'
createNextDescribe(
'app-dir action allowed fowarding hosts',
{
files: __dirname,
skipDeployment: true,
dependencies: {
react: 'latest',
'react-dom': 'latest',
'server-only': 'latest',
},
},
({ next }) => {
it('should error if setting an invalid x-forwarded-host header', async function () {
const browser = await next.browser('/safe-hosts')
await browser.eval(`window.__override_forwarded_host = 'bad.com'`)
await browser.elementByCss('button').click()
await check(async () => {
const t = await browser.elementByCss('#res').text()
return t.includes('Invalid Server Actions request.') ||
// In prod the message is hidden
t.includes('An error occurred in the Server Components render.')
? 'yes'
: 'no'
}, 'yes')
})
it('should pass if using an allowed host', async function () {
const browser = await next.browser('/safe-hosts')
await browser.eval(`window.__override_forwarded_host = 'safe.com'`)
await browser.elementByCss('button').click()
await check(() => {
return browser.elementByCss('#res').text()
}, 'hi')
})
}
)
'use server'
export async function log() {
return 'hi'
}
'use client'
import { useState } from 'react'
import { log } from './action'
if (typeof window !== 'undefined') {
// hijack fetch
const originalFetch = window.fetch
window.fetch = function (url, init) {
if (window.__override_forwarded_host && init?.method === 'POST') {
console.log('fetch', url, init)
// override forwarded host
init.headers = init.headers || {}
init.headers['x-forwarded-host'] = window.__override_forwarded_host
}
return originalFetch(url, init)
}
}
export default function Page() {
const [res, setRes] = useState(null)
return (
<div>
<div id="res">{res}</div>
<button
onClick={async () => {
try {
setRes(await log())
} catch (err) {
setRes(err.message)
}
}}
>
fetch
</button>
</div>
)
}
...@@ -4,4 +4,9 @@ module.exports = { ...@@ -4,4 +4,9 @@ module.exports = {
logging: { logging: {
fetches: {}, fetches: {},
}, },
experimental: {
serverActions: {
allowedForwardedHosts: ['safe.com'],
},
},
} }
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment