Unverified Commit f840cb48 authored by Shu Ding's avatar Shu Ding Committed by GitHub

Rename encryption key generation code (#63730)

This PR renames the API to be not specifically related to Server
Actions, as in the future it might be used by other things. It also adds
the `__next_encryption_key_generation_promise` variable to avoid
double-generating of the key when it's called concurrently (e.g. by the
node server and edge server compilers).

Closes NEXT-2938
parent 4ee00d4f
...@@ -884,10 +884,7 @@ async fn insert_next_shared_aliases( ...@@ -884,10 +884,7 @@ async fn insert_next_shared_aliases(
); );
import_map.insert_exact_alias( import_map.insert_exact_alias(
"private-next-rsc-action-encryption", "private-next-rsc-action-encryption",
request_to_import_mapping( request_to_import_mapping(project_path, "next/dist/server/app-render/encryption"),
project_path,
"next/dist/server/app-render/action-encryption",
),
); );
insert_turbopack_dev_alias(import_map); insert_turbopack_dev_alias(import_map);
......
...@@ -150,8 +150,7 @@ export function createWebpackAliases({ ...@@ -150,8 +150,7 @@ export function createWebpackAliases({
[RSC_ACTION_PROXY_ALIAS]: [RSC_ACTION_PROXY_ALIAS]:
'next/dist/build/webpack/loaders/next-flight-loader/server-reference', 'next/dist/build/webpack/loaders/next-flight-loader/server-reference',
[RSC_ACTION_ENCRYPTION_ALIAS]: [RSC_ACTION_ENCRYPTION_ALIAS]: 'next/dist/server/app-render/encryption',
'next/dist/server/app-render/action-encryption',
...(isClient || isEdgeServer ...(isClient || isEdgeServer
? { ? {
......
...@@ -11,7 +11,7 @@ import type { BuildManifest } from '../../server/get-page-files' ...@@ -11,7 +11,7 @@ import type { BuildManifest } from '../../server/get-page-files'
import type { RequestData } from '../../server/web/types' import type { RequestData } from '../../server/web/types'
import type { NextConfigComplete } from '../../server/config-shared' import type { NextConfigComplete } from '../../server/config-shared'
import { PAGE_TYPES } from '../../lib/page-types' import { PAGE_TYPES } from '../../lib/page-types'
import { setReferenceManifestsSingleton } from '../../server/app-render/action-encryption-utils' import { setReferenceManifestsSingleton } from '../../server/app-render/encryption-utils'
import { createServerModuleMap } from '../../server/app-render/action-utils' import { createServerModuleMap } from '../../server/app-render/action-utils'
declare const incrementalCacheHandler: any declare const incrementalCacheHandler: any
......
...@@ -39,7 +39,7 @@ import { ...@@ -39,7 +39,7 @@ import {
} from '../utils' } 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 { generateRandomActionKeyRaw } from '../../../server/app-render/action-encryption-utils' import { generateEncryptionKeyBase64 } from '../../../server/app-render/encryption-utils'
import { PAGE_TYPES } from '../../../lib/page-types' import { PAGE_TYPES } from '../../../lib/page-types'
import { isWebpackServerOnlyLayer } from '../../utils' import { isWebpackServerOnlyLayer } from '../../utils'
...@@ -1002,7 +1002,7 @@ export class FlightClientEntryPlugin { ...@@ -1002,7 +1002,7 @@ export class FlightClientEntryPlugin {
edge: edgeServerActions, edge: edgeServerActions,
// Assign encryption // Assign encryption
encryptionKey: await generateRandomActionKeyRaw(this.dev), encryptionKey: await generateEncryptionKeyBase64(this.dev),
}, },
null, null,
this.dev ? 2 : undefined this.dev ? 2 : undefined
......
...@@ -79,7 +79,7 @@ import { makeGetServerInsertedHTML } from './make-get-server-inserted-html' ...@@ -79,7 +79,7 @@ import { makeGetServerInsertedHTML } from './make-get-server-inserted-html'
import { walkTreeWithFlightRouterState } from './walk-tree-with-flight-router-state' import { walkTreeWithFlightRouterState } from './walk-tree-with-flight-router-state'
import { createComponentTree } from './create-component-tree' import { createComponentTree } from './create-component-tree'
import { getAssetQueryString } from './get-asset-query-string' import { getAssetQueryString } from './get-asset-query-string'
import { setReferenceManifestsSingleton } from './action-encryption-utils' import { setReferenceManifestsSingleton } from './encryption-utils'
import { import {
createStaticRenderer, createStaticRenderer,
getDynamicDataPostponedState, getDynamicDataPostponedState,
......
...@@ -3,6 +3,9 @@ import type { ClientReferenceManifest } from '../../build/webpack/plugins/flight ...@@ -3,6 +3,9 @@ import type { ClientReferenceManifest } from '../../build/webpack/plugins/flight
// Keep the key in memory as it should never change during the lifetime of the server in // Keep the key in memory as it should never change during the lifetime of the server in
// both development and production. // both development and production.
let __next_encryption_key_generation_promise: Promise<
[CryptoKey, string]
> | null = null
let __next_loaded_action_key: CryptoKey let __next_loaded_action_key: CryptoKey
let __next_internal_development_raw_action_key: string let __next_internal_development_raw_action_key: string
...@@ -57,7 +60,7 @@ export function decrypt(key: CryptoKey, iv: Uint8Array, data: Uint8Array) { ...@@ -57,7 +60,7 @@ export function decrypt(key: CryptoKey, iv: Uint8Array, data: Uint8Array) {
) )
} }
export async function generateRandomActionKeyRaw(dev?: boolean) { export async function generateEncryptionKeyBase64(dev?: boolean) {
// For development, we just keep one key in memory for all actions. // For development, we just keep one key in memory for all actions.
// This makes things faster. // This makes things faster.
if (dev) { if (dev) {
...@@ -66,16 +69,31 @@ export async function generateRandomActionKeyRaw(dev?: boolean) { ...@@ -66,16 +69,31 @@ export async function generateRandomActionKeyRaw(dev?: boolean) {
} }
} }
const key = await crypto.subtle.generateKey( // This avoids it being generated multiple times in parallel.
{ if (!__next_encryption_key_generation_promise) {
name: 'AES-GCM', __next_encryption_key_generation_promise = new Promise(
length: 256, async (resolve, reject) => {
}, try {
true, const key = await crypto.subtle.generateKey(
['encrypt', 'decrypt'] {
) name: 'AES-GCM',
const exported = await crypto.subtle.exportKey('raw', key) length: 256,
const b64 = btoa(arrayBufferToString(exported)) },
true,
['encrypt', 'decrypt']
)
const exported = await crypto.subtle.exportKey('raw', key)
const b64 = btoa(arrayBufferToString(exported))
resolve([key, b64])
} catch (error) {
reject(error)
}
}
)
}
const [key, b64] = await __next_encryption_key_generation_promise
__next_loaded_action_key = key __next_loaded_action_key = key
if (dev) { if (dev) {
......
...@@ -21,7 +21,7 @@ import { ...@@ -21,7 +21,7 @@ import {
getClientReferenceManifestSingleton, getClientReferenceManifestSingleton,
getServerModuleMap, getServerModuleMap,
stringToUint8Array, stringToUint8Array,
} from './action-encryption-utils' } from './encryption-utils'
const textEncoder = new TextEncoder() const textEncoder = new TextEncoder()
const textDecoder = new TextDecoder() const textDecoder = new TextDecoder()
......
...@@ -7,7 +7,7 @@ import type { AppBuildManifest } from '../../../build/webpack/plugins/app-build- ...@@ -7,7 +7,7 @@ import type { AppBuildManifest } from '../../../build/webpack/plugins/app-build-
import type { PagesManifest } from '../../../build/webpack/plugins/pages-manifest-plugin' import type { PagesManifest } from '../../../build/webpack/plugins/pages-manifest-plugin'
import { pathToRegexp } from 'next/dist/compiled/path-to-regexp' import { pathToRegexp } from 'next/dist/compiled/path-to-regexp'
import type { ActionManifest } from '../../../build/webpack/plugins/flight-client-entry-plugin' import type { ActionManifest } from '../../../build/webpack/plugins/flight-client-entry-plugin'
import { generateRandomActionKeyRaw } from '../../app-render/action-encryption-utils' import { generateEncryptionKeyBase64 } from '../../app-render/encryption-utils'
import type { NextFontManifest } from '../../../build/webpack/plugins/next-font-manifest-plugin' import type { NextFontManifest } from '../../../build/webpack/plugins/next-font-manifest-plugin'
import type { LoadableManifest } from '../../load-components' import type { LoadableManifest } from '../../load-components'
import { import {
...@@ -123,7 +123,7 @@ export class TurbopackManifestLoader { ...@@ -123,7 +123,7 @@ export class TurbopackManifestLoader {
const manifest: ActionManifest = { const manifest: ActionManifest = {
node: {}, node: {},
edge: {}, edge: {},
encryptionKey: await generateRandomActionKeyRaw(true), encryptionKey: await generateEncryptionKeyBase64(true),
} }
function mergeActionIds( function mergeActionIds(
......
...@@ -28,7 +28,7 @@ import { getTracer } from './lib/trace/tracer' ...@@ -28,7 +28,7 @@ import { getTracer } from './lib/trace/tracer'
import { LoadComponentsSpan } from './lib/trace/constants' import { LoadComponentsSpan } from './lib/trace/constants'
import { evalManifest, loadManifest } from './load-manifest' import { evalManifest, loadManifest } from './load-manifest'
import { wait } from '../lib/wait' import { wait } from '../lib/wait'
import { setReferenceManifestsSingleton } from './app-render/action-encryption-utils' import { setReferenceManifestsSingleton } from './app-render/encryption-utils'
import { createServerModuleMap } from './app-render/action-utils' import { createServerModuleMap } from './app-render/action-utils'
export type ManifestItem = { export type ManifestItem = {
......
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