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(
// TODO(timneutkens): remove this
let is_server_component = true;
// let server_actions_body_size_limit =
// &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 server_actions = next_config.experimental.server_actions.as_ref();
let sri_enabled = !dev
&& next_config
......@@ -184,7 +178,7 @@ async fn wrap_edge_page(
"nextConfig" => serde_json::to_string(next_config)?,
"isServerComponent" => serde_json::Value::Bool(is_server_component).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! {
"incrementalCacheHandler" => None,
......
......@@ -417,8 +417,7 @@ export function getEdgeServerEntry(opts: {
middlewareConfig: Buffer.from(
JSON.stringify(opts.middlewareConfig || {})
).toString('base64'),
serverActionsBodySizeLimit:
opts.config.experimental.serverActions?.bodySizeLimit,
serverActions: opts.config.experimental.serverActions,
}
return {
......
......@@ -23,12 +23,12 @@ const error500Mod = null
declare const sriEnabled: boolean
declare const isServerComponent: boolean
declare const dev: boolean
declare const serverActionsBodySizeLimit: any
declare const serverActions: any
declare const nextConfig: NextConfigComplete
// INJECT:sriEnabled
// INJECT:isServerComponent
// INJECT:dev
// INJECT:serverActionsBodySizeLimit
// INJECT:serverActions
// INJECT:nextConfig
const maybeJSONParse = (str?: string) => (str ? JSON.parse(str) : undefined)
......@@ -58,9 +58,7 @@ const render = getRender({
reactLoadableManifest,
clientReferenceManifest: isServerComponent ? rscManifest : null,
serverActionsManifest: isServerComponent ? rscServerManifest : null,
serverActionsBodySizeLimit: isServerComponent
? serverActionsBodySizeLimit
: undefined,
serverActions: isServerComponent ? serverActions : undefined,
subresourceIntegrityManifest,
config: nextConfig,
buildId: 'VAR_BUILD_ID',
......
......@@ -26,7 +26,10 @@ export type EdgeSSRLoaderQuery = {
incrementalCacheHandlerPath?: string
preferredRegion: string | string[] | undefined
middlewareConfig: string
serverActionsBodySizeLimit?: SizeLimit
serverActions?: {
bodySizeLimit?: SizeLimit
allowedForwardedHosts?: string[]
}
}
/*
......@@ -75,7 +78,7 @@ const edgeSSRLoader: webpack.LoaderDefinitionFunction<EdgeSSRLoaderQuery> =
incrementalCacheHandlerPath,
preferredRegion,
middlewareConfig: middlewareConfigBase64,
serverActionsBodySizeLimit,
serverActions,
} = this.getOptions()
const middlewareConfig: MiddlewareConfig = JSON.parse(
......@@ -148,10 +151,10 @@ const edgeSSRLoader: webpack.LoaderDefinitionFunction<EdgeSSRLoaderQuery> =
nextConfig: stringifiedConfig,
isServerComponent: JSON.stringify(isServerComponent),
dev: JSON.stringify(dev),
serverActionsBodySizeLimit:
typeof serverActionsBodySizeLimit === 'undefined'
serverActions:
typeof serverActions === 'undefined'
? 'undefined'
: JSON.stringify(serverActionsBodySizeLimit),
: JSON.stringify(serverActions),
},
{
incrementalCacheHandler: incrementalCacheHandlerPath ?? null,
......
......@@ -34,7 +34,7 @@ export function getRender({
clientReferenceManifest,
subresourceIntegrityManifest,
serverActionsManifest,
serverActionsBodySizeLimit,
serverActions,
config,
buildId,
nextFontManifest,
......@@ -55,7 +55,10 @@ export function getRender({
subresourceIntegrityManifest?: Record<string, string>
clientReferenceManifest?: ClientReferenceManifest
serverActionsManifest?: any
serverActionsBodySizeLimit?: SizeLimit
serverActions?: {
bodySizeLimit?: SizeLimit
allowedForwardedHosts?: string[]
}
config: NextConfigComplete
buildId: string
nextFontManifest: NextFontManifest
......@@ -87,7 +90,7 @@ export function getRender({
supportsDynamicHTML: true,
disableOptimizedLoading: true,
serverActionsManifest,
serverActionsBodySizeLimit,
serverActions,
nextFontManifest,
},
renderToHTML,
......
......@@ -32,7 +32,6 @@ import {
import { traverseModules, forEachEntryModule } from '../utils'
import { normalizePathSep } from '../../../shared/lib/page-path/normalize-path-sep'
import { getProxiedPluginState } from '../../build-context'
import type { SizeLimit } from '../../../../types'
import semver from 'next/dist/compiled/semver'
import { generateRandomActionKeyRaw } from '../../../server/app-render/action-encryption-utils'
......@@ -40,7 +39,6 @@ interface Options {
dev: boolean
appDir: string
isEdgeServer: boolean
serverActionsBodySizeLimit?: SizeLimit
}
const PLUGIN_NAME = 'FlightClientEntryPlugin'
......@@ -160,14 +158,12 @@ export class FlightClientEntryPlugin {
dev: boolean
appDir: string
isEdgeServer: boolean
serverActionsBodySizeLimit?: SizeLimit
assetPrefix: string
constructor(options: Options) {
this.dev = options.dev
this.appDir = options.appDir
this.isEdgeServer = options.isEdgeServer
this.serverActionsBodySizeLimit = options.serverActionsBodySizeLimit
this.assetPrefix = !this.dev && !this.isEdgeServer ? '../' : ''
}
......
......@@ -488,8 +488,7 @@ export async function exportAppImpl(
optimizeFonts: nextConfig.optimizeFonts as FontConfig,
largePageDataBytes: nextConfig.experimental.largePageDataBytes,
serverComponents: options.hasAppDir,
serverActionsBodySizeLimit:
nextConfig.experimental.serverActions?.bodySizeLimit,
serverActions: nextConfig.experimental.serverActions,
nextFontManifest: require(join(
distDir,
'server',
......
......@@ -79,6 +79,7 @@ const supportedTurbopackNextConfigOptions = [
'experimental.scrollRestoration',
'experimental.forceSwcTransforms',
'experimental.serverActions.bodySizeLimit',
'experimental.serverActions.allowedForwardedHosts',
'experimental.memoryBasedWorkersCount',
'experimental.clientRouterFilterRedirects',
'experimental.webpackBuildWorker',
......
......@@ -216,7 +216,7 @@ export async function handleAction({
generateFlight,
staticGenerationStore,
requestStore,
serverActionsBodySizeLimit,
serverActions,
ctx,
}: {
req: IncomingMessage
......@@ -232,7 +232,10 @@ export async function handleAction({
generateFlight: GenerateFlight
staticGenerationStore: StaticGenerationStore
requestStore: RequestStore
serverActionsBodySizeLimit?: SizeLimit
serverActions?: {
bodySizeLimit?: SizeLimit
allowedForwardedHosts?: string[]
}
ctx: AppRenderContext
}): Promise<
| undefined
......@@ -277,32 +280,41 @@ export async function handleAction({
'Missing `origin` header from a forwarded Server Actions request.'
)
} else if (!host || originHostname !== host) {
// This is an attack. We should not proceed the action.
console.error(
'`x-forwarded-host` and `host` headers do not match `origin` header from a forwarded Server Actions request. Aborting the action.'
)
// 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.
console.error(
'`x-forwarded-host` and `host` headers do not match `origin` header from a forwarded Server Actions request. Aborting the action.'
)
const error = new Error('Invalid Server Actions request.')
const error = new Error('Invalid Server Actions request.')
if (isFetchAction) {
res.statusCode = 500
await Promise.all(staticGenerationStore.pendingRevalidates || [])
const promise = Promise.reject(error)
try {
await promise
} catch {}
if (isFetchAction) {
res.statusCode = 500
await Promise.all(staticGenerationStore.pendingRevalidates || [])
const promise = Promise.reject(error)
try {
await promise
} catch {}
return {
type: 'done',
result: await generateFlight(ctx, {
actionResult: promise,
// if the page was not revalidated, we can skip the rendering the flight tree
skipFlight: !staticGenerationStore.pathWasRevalidated,
}),
return {
type: 'done',
result: await generateFlight(ctx, {
actionResult: promise,
// if the page was not revalidated, we can skip the rendering the flight tree
skipFlight: !staticGenerationStore.pathWasRevalidated,
}),
}
}
}
throw error
throw error
}
}
// ensure we avoid caching server actions unexpectedly
......@@ -421,15 +433,14 @@ export async function handleAction({
const actionData = Buffer.concat(chunks).toString('utf-8')
const limit = require('next/dist/compiled/bytes').parse(
serverActionsBodySizeLimit ?? '1mb'
)
const readableLimit = serverActions?.bodySizeLimit ?? '1 MB'
const limit = require('next/dist/compiled/bytes').parse(readableLimit)
if (actionData.length > limit) {
const { ApiError } = require('../api-utils')
throw new ApiError(
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`
)
}
......
......@@ -409,7 +409,7 @@ async function renderToHTMLOrFlightImpl(
dev,
nextFontManifest,
supportsDynamicHTML,
serverActionsBodySizeLimit,
serverActions,
buildId,
appDirDevErrorLogger,
assetPrefix = '',
......@@ -955,7 +955,7 @@ async function renderToHTMLOrFlightImpl(
generateFlight,
staticGenerationStore: staticGenerationStore,
requestStore: requestStore,
serverActionsBodySizeLimit,
serverActions,
ctx,
})
......
......@@ -132,7 +132,11 @@ export interface RenderOptsPartial {
rawConfig?: boolean,
silent?: boolean
) => Promise<NextConfigComplete>
serverActionsBodySizeLimit?: SizeLimit
serverActions?: {
bodySizeLimit?: SizeLimit
allowedForwardedHosts?: string[]
}
allowedForwardedHosts?: string[]
params?: ParsedUrlQuery
isPrefetch?: boolean
ppr: boolean
......
......@@ -245,7 +245,10 @@ type BaseRenderOpts = {
supportsDynamicHTML?: boolean
isBot?: boolean
clientReferenceManifest?: ClientReferenceManifest
serverActionsBodySizeLimit?: SizeLimit
serverActions?: {
bodySizeLimit?: SizeLimit
allowedForwardedHosts?: string[]
}
serverActionsManifest?: any
nextFontManifest?: NextFontManifest
renderServerComponentData?: boolean
......@@ -2106,8 +2109,7 @@ export default abstract class Server<ServerOptions extends Options = Options> {
incrementalCache,
isRevalidate: isSSG,
originalPathname: components.ComponentMod.originalPathname,
serverActionsBodySizeLimit:
this.nextConfig.experimental.serverActions?.bodySizeLimit,
serverActions: this.nextConfig.experimental.serverActions,
}
: {}),
isDataReq,
......
......@@ -251,7 +251,13 @@ export const configSchema: zod.ZodType<NextConfig> = z.lazy(() =>
disableOptimizedLoading: z.boolean().optional(),
disablePostcssPresetEnv: z.boolean().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>
extensionAlias: z.record(z.string(), z.any()).optional(),
externalDir: z.boolean().optional(),
......
......@@ -307,6 +307,13 @@ export interface ExperimentalConfig {
* Allows adjusting body parser size limit for server actions.
*/
bodySizeLimit?: SizeLimit
/**
* Allowed domains that can bypass CSRF check.
* @example
* ["my-reverse-proxy.com"]
*/
allowedForwardedHosts?: string[]
}
/**
......
......@@ -417,13 +417,15 @@ function assignDefaults(
}
}
// TODO: Remove this warning in Next.js 15
warnOptionHasBeenDeprecated(
result,
'experimental.serverActions',
'Server Actions are available by default now, `experimental.serverActions` option can be safely removed.',
silent
)
if (typeof result.experimental?.serverActions === 'boolean') {
// TODO: Remove this warning in Next.js 15
warnOptionHasBeenDeprecated(
result,
'experimental.serverActions',
'Server Actions are available by default now, `experimental.serverActions` option can be safely removed.',
silent
)
}
if (result.swcMinify === false) {
// TODO: Remove this warning in Next.js 15
......
......@@ -273,7 +273,11 @@ export type RenderOptsPartial = {
isBot?: boolean
runtime?: ServerRuntime
serverComponents?: boolean
serverActionsBodySizeLimit?: SizeLimit
serverActions?: {
bodySizeLimit?: SizeLimit
allowedForwardedHosts?: string[]
}
allowedForwardedHosts?: string[]
customServer?: boolean
crossOrigin?: 'anonymous' | 'use-credentials' | '' | undefined
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 = {
logging: {
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