Add end-to-end encryption for workflow user data#950

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.

Sign up for GitHub

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

Closed
TooTallNate wants to merge 7 commits into from
Closed

Add end-to-end encryption for workflow user data #950

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ec9e00d
Add end-to-end encryption for workflow user data
TooTallNate Feb 5, 2026
73ea363
Fix serialization function signatures for E2E encryption
TooTallNate Feb 5, 2026
8f7941d
Fix world implementations to accept client-provided runId
TooTallNate Feb 5, 2026
5ab78f8
Pass client-generated runId as first parameter to events.create()
TooTallNate Feb 5, 2026
9dd15a6
Fix E2E test dehydrateWorkflowArguments call signature
TooTallNate Feb 5, 2026
c41706e
Fix serialization test to await async wrapper functions
TooTallNate Feb 5, 2026
f95f584
Add deployment key length validation for AES-256
TooTallNate Feb 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .changeset/e2e-encryption.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
"@workflow/cli": patch
"@workflow/core": patch
"@workflow/web-shared": patch
"@workflow/world-vercel": patch
"@workflow/world": patch
"@workflow/world-testing": patch
---

Add end-to-end encryption for workflow user data

This implements AES-256-GCM encryption with per-run key derivation via HKDF-SHA256 for workflow user data.

Key changes:
- Add encryption module with `createEncryptor()` and `createEncryptorFromEnv()` functions
- Add `Encryptor`, `EncryptionContext`, `KeyMaterial` interfaces to `@workflow/world`
- Make all (de)hydrate serialization functions async and accept encryptor parameter
- Update `runWorkflow()` to take world as 4th parameter
- Update `WorkflowOrchestratorContext` to include `runId` and `world`
30 changes: 21 additions & 9 deletions packages/cli/src/lib/inspect/output.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -534,7 +534,9 @@ export const listRuns = async (world: World, opts: InspectCLIOptions = {}) => {
},
resolveData,
});
const runsWithHydratedIO = runs.data.map(hydrateResourceIO);
const runsWithHydratedIO = await Promise.all(
runs.data.map((run) => hydrateResourceIO(run, world))
);
showJson({ ...runs, data: runsWithHydratedIO });
return;
} catch (error) {
Expand DownExpand Up@@ -572,7 +574,9 @@ export const listRuns = async (world: World, opts: InspectCLIOptions = {}) => {
}
},
displayPage: async (runs) => {
const runsWithHydratedIO = runs.map(hydrateResourceIO);
const runsWithHydratedIO = await Promise.all(
runs.map((run) => hydrateResourceIO(run, world))
);
logger.log(showTable(runsWithHydratedIO, props, opts));
},
});
Expand All@@ -588,7 +592,9 @@ export const getRecentRun = async (
pagination: { limit: 1, sortOrder: opts.sort || 'desc' },
resolveData: 'none', // Don't need data for just getting the ID
});
runs.data = runs.data.map(hydrateResourceIO);
runs.data = await Promise.all(
runs.data.map((run) => hydrateResourceIO(run, world))
);
return runs.data[0];
} catch (error) {
if (handleApiError(error, opts.backend)) {
Expand All@@ -608,7 +614,7 @@ export const showRun = async (
}
try {
const run = await world.runs.get(runId, { resolveData: 'all' });
const runWithHydratedIO = hydrateResourceIO(run);
const runWithHydratedIO = await hydrateResourceIO(run, world);
if (opts.json) {
showJson(runWithHydratedIO);
return;
Expand DownExpand Up@@ -711,7 +717,9 @@ export const listSteps = async (
}
},
displayPage: async (steps) => {
const stepsWithHydratedIO = steps.map(hydrateResourceIO);
const stepsWithHydratedIO = await Promise.all(
steps.map((step) => hydrateResourceIO(step, world))
);
logger.log(showTable(stepsWithHydratedIO, props, opts));
showInspectInfoBox('step');
},
Expand All@@ -735,7 +743,7 @@ export const showStep = async (
const step = await world.steps.get(opts.runId, stepId, {
resolveData: 'all',
});
const stepWithHydratedIO = hydrateResourceIO(step);
const stepWithHydratedIO = await hydrateResourceIO(step, world);
if (opts.json) {
showJson(stepWithHydratedIO);
return;
Expand DownExpand Up@@ -950,7 +958,9 @@ export const listHooks = async (world: World, opts: InspectCLIOptions = {}) => {
},
resolveData,
});
const hydratedHooks = hooks.data.map(hydrateResourceIO);
const hydratedHooks = await Promise.all(
hooks.data.map((hook) => hydrateResourceIO(hook, world))
);
showJson({ ...hooks, data: hydratedHooks });
return;
} catch (error) {
Expand DownExpand Up@@ -994,7 +1004,9 @@ export const listHooks = async (world: World, opts: InspectCLIOptions = {}) => {
}
},
displayPage: async (hooks) => {
const hydratedHooks = hooks.map(hydrateResourceIO);
const hydratedHooks = await Promise.all(
hooks.map((hook) => hydrateResourceIO(hook, world))
);
logger.log(showTable(hydratedHooks, HOOK_LISTED_PROPS, opts));
showInspectInfoBox('hook');
},
Expand All@@ -1013,7 +1025,7 @@ export const showHook = async (
const hook = await world.hooks.get(hookId, {
resolveData: 'all',
});
const hydratedHook = hydrateResourceIO(hook);
const hydratedHook = await hydrateResourceIO(hook, world);
if (opts.json) {
showJson(hydratedHook);
return;
Expand Down
15 changes: 9 additions & 6 deletions packages/core/e2e/bench.bench.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { withResolvers } from '@workflow/utils';
import fs from 'fs';
import path from 'path';
import { bench, describe } from 'vitest';
Expand DownExpand Up@@ -46,17 +45,22 @@ async function triggerWorkflow(
url.searchParams.set('workflowFn', workflowFn);

const ops: Promise<void>[] = [];
const { promise: runIdPromise, resolve: resolveRunId } =
withResolvers<string>();
const dehydratedArgs = dehydrateWorkflowArguments(args, ops, runIdPromise);
// Dehydrate args for transport - no encryption needed for test setup
// The server will re-serialize with the real runId when calling start()
const dehydratedArgs = await dehydrateWorkflowArguments(
args,
'', // No runId needed for unencrypted transport
{}, // No encryptor
ops
);

const res = await fetch(url, {
method: 'POST',
headers: {
...getProtectionBypassHeaders(),
'Content-Type': 'application/octet-stream',
},
body: dehydratedArgs.buffer as BodyInit,
body: dehydratedArgs as Uint8Array,
});
if (!res.ok) {
throw new Error(
Expand All@@ -66,7 +70,6 @@ async function triggerWorkflow(
);
}
const run = await res.json();
resolveRunId(run.runId);

// Resolve and wait for any stream operations
await Promise.all(ops);
Expand Down
15 changes: 9 additions & 6 deletions packages/core/e2e/e2e.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { withResolvers } from '@workflow/utils';
import fs from 'fs';
import path from 'path';
import { afterAll, assert, describe, expect, test } from 'vitest';
Expand DownExpand Up@@ -67,17 +66,22 @@ async function triggerWorkflow(
url.searchParams.set('workflowFn', workflowFn);

const ops: Promise<void>[] = [];
const { promise: runIdPromise, resolve: resolveRunId } =
withResolvers<string>();
const dehydratedArgs = dehydrateWorkflowArguments(args, ops, runIdPromise);
// Dehydrate args for transport - no encryption needed for test setup
// The server will re-serialize with the real runId when calling start()
const dehydratedArgs = await dehydrateWorkflowArguments(
args,
'', // No runId needed for unencrypted transport
{}, // No encryptor
ops
);

const res = await fetch(url, {
method: 'POST',
headers: {
...getProtectionBypassHeaders(),
'Content-Type': 'application/octet-stream',
},
body: dehydratedArgs.buffer as BodyInit,
body: dehydratedArgs as Uint8Array,
});
if (!res.ok) {
throw new Error(
Expand All@@ -87,7 +91,6 @@ async function triggerWorkflow(
);
}
const run = await res.json();
resolveRunId(run.runId);

// Collect runId for observability links (Vercel world only)
if (process.env.WORKFLOW_VERCEL_ENV) {
Expand Down
41 changes: 37 additions & 4 deletions packages/core/src/observability.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { inspect } from 'node:util';
import { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from '@workflow/serde';
import type { Encryptor, World } from '@workflow/world';
import { describe, expect, it } from 'vitest';
import { registerSerializationClass } from './class-serialization.js';
import {
Expand All@@ -13,7 +14,39 @@ import {
STREAM_REF_TYPE,
truncateId,
} from './observability.js';
import { dehydrateStepReturnValue } from './serialization.js';
import { dehydrateStepReturnValue as _dehydrateStepReturnValue } from './serialization.js';

// Mock encryptor without encryption for tests
const mockEncryptor: Encryptor = {};

// Mock world for tests
const mockWorld = {
queue: async () => ({ messageId: 'msg_test' }),
createQueueHandler: () => async () => new Response(),
readFromStorage: async () => new Uint8Array(),
writeToStorage: async () => {},
deleteFromStorage: async () => {},
readFromStream: async () => new ReadableStream(),
writeToStream: async () => {},
writeToStreamMulti: async () => {},
closeStream: async () => {},
getDeploymentId: async () => 'test-deployment',
events: {
create: async () => ({ run: null }),
list: async () => ({ data: [], cursor: null, hasMore: false, run: null }),
},
} as unknown as World;

const mockRunId = 'wrun_test123';

// Wrapper for dehydrateStepReturnValue to use in tests
async function dehydrateStepReturnValue(
value: unknown,
ops: Promise<any>[] = [],
runId: string = mockRunId
): Promise<Uint8Array | unknown> {
return _dehydrateStepReturnValue(value, runId, mockEncryptor, ops);
}

describe('ClassInstanceRef', () => {
describe('constructor and properties', () => {
Expand DownExpand Up@@ -332,10 +365,10 @@ describe('hydrateResourceIO with custom class instances', () => {
(TestPoint as any).classId = 'test//TestPoint';
registerSerializationClass('test//TestPoint', TestPoint);

it('should convert Instance type to ClassInstanceRef in step output', () => {
it('should convert Instance type to ClassInstanceRef in step output', async () => {
// Simulate serialized step data with a custom class instance
const point = new TestPoint(3, 4);
const serialized = dehydrateStepReturnValue(point, [], 'wrun_test');
const serialized = await dehydrateStepReturnValue(point, [], 'wrun_test');

// Create a step resource with serialized output
const step = {
Expand All@@ -346,7 +379,7 @@ describe('hydrateResourceIO with custom class instances', () => {

// Hydrate the step - this should convert Instance to ClassInstanceRef
// because the class is not registered in the o11y context (streamPrintRevivers)
const hydrated = hydrateResourceIO(step);
const hydrated = await hydrateResourceIO(step, mockWorld);

// The output should be a ClassInstanceRef
expect(isClassInstanceRef(hydrated.output)).toBe(true);
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Add end-to-end encryption for workflow user data#950

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.

 Sign up for GitHub

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

 Closed

TooTallNate
wants to merge
7
commits into

from

 Closed


Add end-to-end encryption for workflow user data
#950
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
ec9e00d

Add end-to-end encryption for workflow user data


TooTallNate Feb 5, 2026
73ea363

Fix serialization function signatures for E2E encryption


TooTallNate Feb 5, 2026
8f7941d

Fix world implementations to accept client-provided runId


TooTallNate Feb 5, 2026
5ab78f8

Pass client-generated runId as first parameter to events.create()


TooTallNate Feb 5, 2026
9dd15a6

Fix E2E test dehydrateWorkflowArguments call signature


TooTallNate Feb 5, 2026
c41706e

Fix serialization test to await async wrapper functions


TooTallNate Feb 5, 2026
f95f584

Add deployment key length validation for AES-256


TooTallNate Feb 5, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


19 changes: 19 additions & 0 deletions
.changeset/e2e-encryption.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
"@workflow/cli": patch
"@workflow/core": patch
"@workflow/web-shared": patch
"@workflow/world-vercel": patch
"@workflow/world": patch
"@workflow/world-testing": patch
---

Add end-to-end encryption for workflow user data

This implements AES-256-GCM encryption with per-run key derivation via HKDF-SHA256 for workflow user data.

Key changes:
- Add encryption module with `createEncryptor()` and `createEncryptorFromEnv()` functions
- Add `Encryptor`, `EncryptionContext`, `KeyMaterial` interfaces to `@workflow/world`
- Make all (de)hydrate serialization functions async and accept encryptor parameter
- Update `runWorkflow()` to take world as 4th parameter
- Update `WorkflowOrchestratorContext` to include `runId` and `world`

30 changes: 21 additions & 9 deletions
packages/cli/src/lib/inspect/output.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -534,7 +534,9 @@ export const listRuns = async (world: World, opts: InspectCLIOptions = {}) => {
 },
 resolveData,
 });
 const runsWithHydratedIO = runs.data.map(hydrateResourceIO);
 const runsWithHydratedIO = await Promise.all(
 runs.data.map((run) => hydrateResourceIO(run, world))
 );
 showJson({ ...runs, data: runsWithHydratedIO });
 return;
 } catch (error) {
Expand DownExpand Up@@ -572,7 +574,9 @@ export const listRuns = async (world: World, opts: InspectCLIOptions = {}) => {
 }
 },
 displayPage: async (runs) => {
 const runsWithHydratedIO = runs.map(hydrateResourceIO);
 const runsWithHydratedIO = await Promise.all(
 runs.map((run) => hydrateResourceIO(run, world))
 );
 logger.log(showTable(runsWithHydratedIO, props, opts));
 },
 });
Expand All@@ -588,7 +592,9 @@ export const getRecentRun = async (
 pagination: { limit: 1, sortOrder: opts.sort || 'desc' },
 resolveData: 'none', // Don't need data for just getting the ID
 });
 runs.data = runs.data.map(hydrateResourceIO);
 runs.data = await Promise.all(
 runs.data.map((run) => hydrateResourceIO(run, world))
 );
 return runs.data[0];
 } catch (error) {
 if (handleApiError(error, opts.backend)) {
Expand All@@ -608,7 +614,7 @@ export const showRun = async (
 }
 try {
 const run = await world.runs.get(runId, { resolveData: 'all' });
 const runWithHydratedIO = hydrateResourceIO(run);
 const runWithHydratedIO = await hydrateResourceIO(run, world);
 if (opts.json) {
 showJson(runWithHydratedIO);
 return;
Expand DownExpand Up@@ -711,7 +717,9 @@ export const listSteps = async (
 }
 },
 displayPage: async (steps) => {
 const stepsWithHydratedIO = steps.map(hydrateResourceIO);
 const stepsWithHydratedIO = await Promise.all(
 steps.map((step) => hydrateResourceIO(step, world))
 );
 logger.log(showTable(stepsWithHydratedIO, props, opts));
 showInspectInfoBox('step');
 },
Expand All@@ -735,7 +743,7 @@ export const showStep = async (
 const step = await world.steps.get(opts.runId, stepId, {
 resolveData: 'all',
 });
 const stepWithHydratedIO = hydrateResourceIO(step);
 const stepWithHydratedIO = await hydrateResourceIO(step, world);
 if (opts.json) {
 showJson(stepWithHydratedIO);
 return;
Expand DownExpand Up@@ -950,7 +958,9 @@ export const listHooks = async (world: World, opts: InspectCLIOptions = {}) => {
 },
 resolveData,
 });
 const hydratedHooks = hooks.data.map(hydrateResourceIO);
 const hydratedHooks = await Promise.all(
 hooks.data.map((hook) => hydrateResourceIO(hook, world))
 );
 showJson({ ...hooks, data: hydratedHooks });
 return;
 } catch (error) {
Expand DownExpand Up@@ -994,7 +1004,9 @@ export const listHooks = async (world: World, opts: InspectCLIOptions = {}) => {
 }
 },
 displayPage: async (hooks) => {
 const hydratedHooks = hooks.map(hydrateResourceIO);
 const hydratedHooks = await Promise.all(
 hooks.map((hook) => hydrateResourceIO(hook, world))
 );
 logger.log(showTable(hydratedHooks, HOOK_LISTED_PROPS, opts));
 showInspectInfoBox('hook');
 },
Expand All@@ -1013,7 +1025,7 @@ export const showHook = async (
 const hook = await world.hooks.get(hookId, {
 resolveData: 'all',
 });
 const hydratedHook = hydrateResourceIO(hook);
 const hydratedHook = await hydrateResourceIO(hook, world);
 if (opts.json) {
 showJson(hydratedHook);
 return;
Expand Down

15 changes: 9 additions & 6 deletions
packages/core/e2e/bench.bench.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { withResolvers } from '@workflow/utils';
import fs from 'fs';
import path from 'path';
import { bench, describe } from 'vitest';
Expand DownExpand Up@@ -46,17 +45,22 @@ async function triggerWorkflow(
 url.searchParams.set('workflowFn', workflowFn);

 const ops: Promise<void>[] = [];
 const { promise: runIdPromise, resolve: resolveRunId } =
 withResolvers<string>();
 const dehydratedArgs = dehydrateWorkflowArguments(args, ops, runIdPromise);
 // Dehydrate args for transport - no encryption needed for test setup
 // The server will re-serialize with the real runId when calling start()
 const dehydratedArgs = await dehydrateWorkflowArguments(
 args,
 '', // No runId needed for unencrypted transport
 {}, // No encryptor
 ops
 );

 const res = await fetch(url, {
 method: 'POST',
 headers: {
 ...getProtectionBypassHeaders(),
 'Content-Type': 'application/octet-stream',
 },
 body: dehydratedArgs.buffer as BodyInit,
 body: dehydratedArgs as Uint8Array,
 });
 if (!res.ok) {
 throw new Error(
Expand All@@ -66,7 +70,6 @@ async function triggerWorkflow(
 );
 }
 const run = await res.json();
 resolveRunId(run.runId);

 // Resolve and wait for any stream operations
 await Promise.all(ops);
Expand Down

15 changes: 9 additions & 6 deletions
packages/core/e2e/e2e.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { withResolvers } from '@workflow/utils';
import fs from 'fs';
import path from 'path';
import { afterAll, assert, describe, expect, test } from 'vitest';
Expand DownExpand Up@@ -67,17 +66,22 @@ async function triggerWorkflow(
 url.searchParams.set('workflowFn', workflowFn);

 const ops: Promise<void>[] = [];
 const { promise: runIdPromise, resolve: resolveRunId } =
 withResolvers<string>();
 const dehydratedArgs = dehydrateWorkflowArguments(args, ops, runIdPromise);
 // Dehydrate args for transport - no encryption needed for test setup
 // The server will re-serialize with the real runId when calling start()
 const dehydratedArgs = await dehydrateWorkflowArguments(
 args,
 '', // No runId needed for unencrypted transport
 {}, // No encryptor
 ops
 );

 const res = await fetch(url, {
 method: 'POST',
 headers: {
 ...getProtectionBypassHeaders(),
 'Content-Type': 'application/octet-stream',
 },
 body: dehydratedArgs.buffer as BodyInit,
 body: dehydratedArgs as Uint8Array,
 });
 if (!res.ok) {
 throw new Error(
Expand All@@ -87,7 +91,6 @@ async function triggerWorkflow(
 );
 }
 const run = await res.json();
 resolveRunId(run.runId);

 // Collect runId for observability links (Vercel world only)
 if (process.env.WORKFLOW_VERCEL_ENV) {
Expand Down

41 changes: 37 additions & 4 deletions
packages/core/src/observability.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { inspect } from 'node:util';
import { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from '@workflow/serde';
import type { Encryptor, World } from '@workflow/world';
import { describe, expect, it } from 'vitest';
import { registerSerializationClass } from './class-serialization.js';
import {
Expand All@@ -13,7 +14,39 @@ import {
 STREAM_REF_TYPE,
 truncateId,
} from './observability.js';
import { dehydrateStepReturnValue } from './serialization.js';
import { dehydrateStepReturnValue as _dehydrateStepReturnValue } from './serialization.js';

// Mock encryptor without encryption for tests
const mockEncryptor: Encryptor = {};

// Mock world for tests
const mockWorld = {
 queue: async () => ({ messageId: 'msg_test' }),
 createQueueHandler: () => async () => new Response(),
 readFromStorage: async () => new Uint8Array(),
 writeToStorage: async () => {},
 deleteFromStorage: async () => {},
 readFromStream: async () => new ReadableStream(),
 writeToStream: async () => {},
 writeToStreamMulti: async () => {},
 closeStream: async () => {},
 getDeploymentId: async () => 'test-deployment',
 events: {
 create: async () => ({ run: null }),
 list: async () => ({ data: [], cursor: null, hasMore: false, run: null }),
 },
} as unknown as World;

const mockRunId = 'wrun_test123';

// Wrapper for dehydrateStepReturnValue to use in tests
async function dehydrateStepReturnValue(
 value: unknown,
 ops: Promise<any>[] = [],
 runId: string = mockRunId
): Promise<Uint8Array | unknown> {
 return _dehydrateStepReturnValue(value, runId, mockEncryptor, ops);
}

describe('ClassInstanceRef', () => {
 describe('constructor and properties', () => {
Expand DownExpand Up@@ -332,10 +365,10 @@ describe('hydrateResourceIO with custom class instances', () => {
 (TestPoint as any).classId = 'test//TestPoint';
 registerSerializationClass('test//TestPoint', TestPoint);

 it('should convert Instance type to ClassInstanceRef in step output', () => {
 it('should convert Instance type to ClassInstanceRef in step output', async () => {
 // Simulate serialized step data with a custom class instance
 const point = new TestPoint(3, 4);
 const serialized = dehydrateStepReturnValue(point, [], 'wrun_test');
 const serialized = await dehydrateStepReturnValue(point, [], 'wrun_test');

 // Create a step resource with serialized output
 const step = {
Expand All@@ -346,7 +379,7 @@ describe('hydrateResourceIO with custom class instances', () => {

 // Hydrate the step - this should convert Instance to ClassInstanceRef
 // because the class is not registered in the o11y context (streamPrintRevivers)
 const hydrated = hydrateResourceIO(step);
 const hydrated = await hydrateResourceIO(step, mockWorld);

 // The output should be a ClassInstanceRef
 expect(isClassInstanceRef(hydrated.output)).toBe(true);
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add end-to-end encryption for workflow user data#950

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.

 Sign up for GitHub

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

 Closed

TooTallNate
wants to merge
7
commits into

from

 Closed


Add end-to-end encryption for workflow user data
#950
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
ec9e00d

Add end-to-end encryption for workflow user data


TooTallNate Feb 5, 2026
73ea363

Fix serialization function signatures for E2E encryption


TooTallNate Feb 5, 2026
8f7941d

Fix world implementations to accept client-provided runId


TooTallNate Feb 5, 2026
5ab78f8

Pass client-generated runId as first parameter to events.create()


TooTallNate Feb 5, 2026
9dd15a6

Fix E2E test dehydrateWorkflowArguments call signature


TooTallNate Feb 5, 2026
c41706e

Fix serialization test to await async wrapper functions


TooTallNate Feb 5, 2026
f95f584

Add deployment key length validation for AES-256


TooTallNate Feb 5, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


19 changes: 19 additions & 0 deletions
.changeset/e2e-encryption.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
"@workflow/cli": patch
"@workflow/core": patch
"@workflow/web-shared": patch
"@workflow/world-vercel": patch
"@workflow/world": patch
"@workflow/world-testing": patch
---

Add end-to-end encryption for workflow user data

This implements AES-256-GCM encryption with per-run key derivation via HKDF-SHA256 for workflow user data.

Key changes:
- Add encryption module with `createEncryptor()` and `createEncryptorFromEnv()` functions
- Add `Encryptor`, `EncryptionContext`, `KeyMaterial` interfaces to `@workflow/world`
- Make all (de)hydrate serialization functions async and accept encryptor parameter
- Update `runWorkflow()` to take world as 4th parameter
- Update `WorkflowOrchestratorContext` to include `runId` and `world`

30 changes: 21 additions & 9 deletions
packages/cli/src/lib/inspect/output.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -534,7 +534,9 @@ export const listRuns = async (world: World, opts: InspectCLIOptions = {}) => {
 },
 resolveData,
 });
 const runsWithHydratedIO = runs.data.map(hydrateResourceIO);
 const runsWithHydratedIO = await Promise.all(
 runs.data.map((run) => hydrateResourceIO(run, world))
 );
 showJson({ ...runs, data: runsWithHydratedIO });
 return;
 } catch (error) {
Expand DownExpand Up@@ -572,7 +574,9 @@ export const listRuns = async (world: World, opts: InspectCLIOptions = {}) => {
 }
 },
 displayPage: async (runs) => {
 const runsWithHydratedIO = runs.map(hydrateResourceIO);
 const runsWithHydratedIO = await Promise.all(
 runs.map((run) => hydrateResourceIO(run, world))
 );
 logger.log(showTable(runsWithHydratedIO, props, opts));
 },
 });
Expand All@@ -588,7 +592,9 @@ export const getRecentRun = async (
 pagination: { limit: 1, sortOrder: opts.sort || 'desc' },
 resolveData: 'none', // Don't need data for just getting the ID
 });
 runs.data = runs.data.map(hydrateResourceIO);
 runs.data = await Promise.all(
 runs.data.map((run) => hydrateResourceIO(run, world))
 );
 return runs.data[0];
 } catch (error) {
 if (handleApiError(error, opts.backend)) {
Expand All@@ -608,7 +614,7 @@ export const showRun = async (
 }
 try {
 const run = await world.runs.get(runId, { resolveData: 'all' });
 const runWithHydratedIO = hydrateResourceIO(run);
 const runWithHydratedIO = await hydrateResourceIO(run, world);
 if (opts.json) {
 showJson(runWithHydratedIO);
 return;
Expand DownExpand Up@@ -711,7 +717,9 @@ export const listSteps = async (
 }
 },
 displayPage: async (steps) => {
 const stepsWithHydratedIO = steps.map(hydrateResourceIO);
 const stepsWithHydratedIO = await Promise.all(
 steps.map((step) => hydrateResourceIO(step, world))
 );
 logger.log(showTable(stepsWithHydratedIO, props, opts));
 showInspectInfoBox('step');
 },
Expand All@@ -735,7 +743,7 @@ export const showStep = async (
 const step = await world.steps.get(opts.runId, stepId, {
 resolveData: 'all',
 });
 const stepWithHydratedIO = hydrateResourceIO(step);
 const stepWithHydratedIO = await hydrateResourceIO(step, world);
 if (opts.json) {
 showJson(stepWithHydratedIO);
 return;
Expand DownExpand Up@@ -950,7 +958,9 @@ export const listHooks = async (world: World, opts: InspectCLIOptions = {}) => {
 },
 resolveData,
 });
 const hydratedHooks = hooks.data.map(hydrateResourceIO);
 const hydratedHooks = await Promise.all(
 hooks.data.map((hook) => hydrateResourceIO(hook, world))
 );
 showJson({ ...hooks, data: hydratedHooks });
 return;
 } catch (error) {
Expand DownExpand Up@@ -994,7 +1004,9 @@ export const listHooks = async (world: World, opts: InspectCLIOptions = {}) => {
 }
 },
 displayPage: async (hooks) => {
 const hydratedHooks = hooks.map(hydrateResourceIO);
 const hydratedHooks = await Promise.all(
 hooks.map((hook) => hydrateResourceIO(hook, world))
 );
 logger.log(showTable(hydratedHooks, HOOK_LISTED_PROPS, opts));
 showInspectInfoBox('hook');
 },
Expand All@@ -1013,7 +1025,7 @@ export const showHook = async (
 const hook = await world.hooks.get(hookId, {
 resolveData: 'all',
 });
 const hydratedHook = hydrateResourceIO(hook);
 const hydratedHook = await hydrateResourceIO(hook, world);
 if (opts.json) {
 showJson(hydratedHook);
 return;
Expand Down

15 changes: 9 additions & 6 deletions
packages/core/e2e/bench.bench.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { withResolvers } from '@workflow/utils';
import fs from 'fs';
import path from 'path';
import { bench, describe } from 'vitest';
Expand DownExpand Up@@ -46,17 +45,22 @@ async function triggerWorkflow(
 url.searchParams.set('workflowFn', workflowFn);

 const ops: Promise<void>[] = [];
 const { promise: runIdPromise, resolve: resolveRunId } =
 withResolvers<string>();
 const dehydratedArgs = dehydrateWorkflowArguments(args, ops, runIdPromise);
 // Dehydrate args for transport - no encryption needed for test setup
 // The server will re-serialize with the real runId when calling start()
 const dehydratedArgs = await dehydrateWorkflowArguments(
 args,
 '', // No runId needed for unencrypted transport
 {}, // No encryptor
 ops
 );

 const res = await fetch(url, {
 method: 'POST',
 headers: {
 ...getProtectionBypassHeaders(),
 'Content-Type': 'application/octet-stream',
 },
 body: dehydratedArgs.buffer as BodyInit,
 body: dehydratedArgs as Uint8Array,
 });
 if (!res.ok) {
 throw new Error(
Expand All@@ -66,7 +70,6 @@ async function triggerWorkflow(
 );
 }
 const run = await res.json();
 resolveRunId(run.runId);

 // Resolve and wait for any stream operations
 await Promise.all(ops);
Expand Down

15 changes: 9 additions & 6 deletions
packages/core/e2e/e2e.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { withResolvers } from '@workflow/utils';
import fs from 'fs';
import path from 'path';
import { afterAll, assert, describe, expect, test } from 'vitest';
Expand DownExpand Up@@ -67,17 +66,22 @@ async function triggerWorkflow(
 url.searchParams.set('workflowFn', workflowFn);

 const ops: Promise<void>[] = [];
 const { promise: runIdPromise, resolve: resolveRunId } =
 withResolvers<string>();
 const dehydratedArgs = dehydrateWorkflowArguments(args, ops, runIdPromise);
 // Dehydrate args for transport - no encryption needed for test setup
 // The server will re-serialize with the real runId when calling start()
 const dehydratedArgs = await dehydrateWorkflowArguments(
 args,
 '', // No runId needed for unencrypted transport
 {}, // No encryptor
 ops
 );

 const res = await fetch(url, {
 method: 'POST',
 headers: {
 ...getProtectionBypassHeaders(),
 'Content-Type': 'application/octet-stream',
 },
 body: dehydratedArgs.buffer as BodyInit,
 body: dehydratedArgs as Uint8Array,
 });
 if (!res.ok) {
 throw new Error(
Expand All@@ -87,7 +91,6 @@ async function triggerWorkflow(
 );
 }
 const run = await res.json();
 resolveRunId(run.runId);

 // Collect runId for observability links (Vercel world only)
 if (process.env.WORKFLOW_VERCEL_ENV) {
Expand Down

41 changes: 37 additions & 4 deletions
packages/core/src/observability.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { inspect } from 'node:util';
import { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from '@workflow/serde';
import type { Encryptor, World } from '@workflow/world';
import { describe, expect, it } from 'vitest';
import { registerSerializationClass } from './class-serialization.js';
import {
Expand All@@ -13,7 +14,39 @@ import {
 STREAM_REF_TYPE,
 truncateId,
} from './observability.js';
import { dehydrateStepReturnValue } from './serialization.js';
import { dehydrateStepReturnValue as _dehydrateStepReturnValue } from './serialization.js';

// Mock encryptor without encryption for tests
const mockEncryptor: Encryptor = {};

// Mock world for tests
const mockWorld = {
 queue: async () => ({ messageId: 'msg_test' }),
 createQueueHandler: () => async () => new Response(),
 readFromStorage: async () => new Uint8Array(),
 writeToStorage: async () => {},
 deleteFromStorage: async () => {},
 readFromStream: async () => new ReadableStream(),
 writeToStream: async () => {},
 writeToStreamMulti: async () => {},
 closeStream: async () => {},
 getDeploymentId: async () => 'test-deployment',
 events: {
 create: async () => ({ run: null }),
 list: async () => ({ data: [], cursor: null, hasMore: false, run: null }),
 },
} as unknown as World;

const mockRunId = 'wrun_test123';

// Wrapper for dehydrateStepReturnValue to use in tests
async function dehydrateStepReturnValue(
 value: unknown,
 ops: Promise<any>[] = [],
 runId: string = mockRunId
): Promise<Uint8Array | unknown> {
 return _dehydrateStepReturnValue(value, runId, mockEncryptor, ops);
}

describe('ClassInstanceRef', () => {
 describe('constructor and properties', () => {
Expand DownExpand Up@@ -332,10 +365,10 @@ describe('hydrateResourceIO with custom class instances', () => {
 (TestPoint as any).classId = 'test//TestPoint';
 registerSerializationClass('test//TestPoint', TestPoint);

 it('should convert Instance type to ClassInstanceRef in step output', () => {
 it('should convert Instance type to ClassInstanceRef in step output', async () => {
 // Simulate serialized step data with a custom class instance
 const point = new TestPoint(3, 4);
 const serialized = dehydrateStepReturnValue(point, [], 'wrun_test');
 const serialized = await dehydrateStepReturnValue(point, [], 'wrun_test');

 // Create a step resource with serialized output
 const step = {
Expand All@@ -346,7 +379,7 @@ describe('hydrateResourceIO with custom class instances', () => {

 // Hydrate the step - this should convert Instance to ClassInstanceRef
 // because the class is not registered in the o11y context (streamPrintRevivers)
 const hydrated = hydrateResourceIO(step);
 const hydrated = await hydrateResourceIO(step, mockWorld);

 // The output should be a ClassInstanceRef
 expect(isClassInstanceRef(hydrated.output)).toBe(true);
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add end-to-end encryption for workflow user data#950

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.

 Sign up for GitHub

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

 Closed

TooTallNate
wants to merge
7
commits into

from

 Closed


Add end-to-end encryption for workflow user data
#950
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
ec9e00d

Add end-to-end encryption for workflow user data


TooTallNate Feb 5, 2026
73ea363

Fix serialization function signatures for E2E encryption


TooTallNate Feb 5, 2026
8f7941d

Fix world implementations to accept client-provided runId


TooTallNate Feb 5, 2026
5ab78f8

Pass client-generated runId as first parameter to events.create()


TooTallNate Feb 5, 2026
9dd15a6

Fix E2E test dehydrateWorkflowArguments call signature


TooTallNate Feb 5, 2026
c41706e

Fix serialization test to await async wrapper functions


TooTallNate Feb 5, 2026
f95f584

Add deployment key length validation for AES-256


TooTallNate Feb 5, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


19 changes: 19 additions & 0 deletions
.changeset/e2e-encryption.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
"@workflow/cli": patch
"@workflow/core": patch
"@workflow/web-shared": patch
"@workflow/world-vercel": patch
"@workflow/world": patch
"@workflow/world-testing": patch
---

Add end-to-end encryption for workflow user data

This implements AES-256-GCM encryption with per-run key derivation via HKDF-SHA256 for workflow user data.

Key changes:
- Add encryption module with `createEncryptor()` and `createEncryptorFromEnv()` functions
- Add `Encryptor`, `EncryptionContext`, `KeyMaterial` interfaces to `@workflow/world`
- Make all (de)hydrate serialization functions async and accept encryptor parameter
- Update `runWorkflow()` to take world as 4th parameter
- Update `WorkflowOrchestratorContext` to include `runId` and `world`

30 changes: 21 additions & 9 deletions
packages/cli/src/lib/inspect/output.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -534,7 +534,9 @@ export const listRuns = async (world: World, opts: InspectCLIOptions = {}) => {
 },
 resolveData,
 });
 const runsWithHydratedIO = runs.data.map(hydrateResourceIO);
 const runsWithHydratedIO = await Promise.all(
 runs.data.map((run) => hydrateResourceIO(run, world))
 );
 showJson({ ...runs, data: runsWithHydratedIO });
 return;
 } catch (error) {
Expand DownExpand Up@@ -572,7 +574,9 @@ export const listRuns = async (world: World, opts: InspectCLIOptions = {}) => {
 }
 },
 displayPage: async (runs) => {
 const runsWithHydratedIO = runs.map(hydrateResourceIO);
 const runsWithHydratedIO = await Promise.all(
 runs.map((run) => hydrateResourceIO(run, world))
 );
 logger.log(showTable(runsWithHydratedIO, props, opts));
 },
 });
Expand All@@ -588,7 +592,9 @@ export const getRecentRun = async (
 pagination: { limit: 1, sortOrder: opts.sort || 'desc' },
 resolveData: 'none', // Don't need data for just getting the ID
 });
 runs.data = runs.data.map(hydrateResourceIO);
 runs.data = await Promise.all(
 runs.data.map((run) => hydrateResourceIO(run, world))
 );
 return runs.data[0];
 } catch (error) {
 if (handleApiError(error, opts.backend)) {
Expand All@@ -608,7 +614,7 @@ export const showRun = async (
 }
 try {
 const run = await world.runs.get(runId, { resolveData: 'all' });
 const runWithHydratedIO = hydrateResourceIO(run);
 const runWithHydratedIO = await hydrateResourceIO(run, world);
 if (opts.json) {
 showJson(runWithHydratedIO);
 return;
Expand DownExpand Up@@ -711,7 +717,9 @@ export const listSteps = async (
 }
 },
 displayPage: async (steps) => {
 const stepsWithHydratedIO = steps.map(hydrateResourceIO);
 const stepsWithHydratedIO = await Promise.all(
 steps.map((step) => hydrateResourceIO(step, world))
 );
 logger.log(showTable(stepsWithHydratedIO, props, opts));
 showInspectInfoBox('step');
 },
Expand All@@ -735,7 +743,7 @@ export const showStep = async (
 const step = await world.steps.get(opts.runId, stepId, {
 resolveData: 'all',
 });
 const stepWithHydratedIO = hydrateResourceIO(step);
 const stepWithHydratedIO = await hydrateResourceIO(step, world);
 if (opts.json) {
 showJson(stepWithHydratedIO);
 return;
Expand DownExpand Up@@ -950,7 +958,9 @@ export const listHooks = async (world: World, opts: InspectCLIOptions = {}) => {
 },
 resolveData,
 });
 const hydratedHooks = hooks.data.map(hydrateResourceIO);
 const hydratedHooks = await Promise.all(
 hooks.data.map((hook) => hydrateResourceIO(hook, world))
 );
 showJson({ ...hooks, data: hydratedHooks });
 return;
 } catch (error) {
Expand DownExpand Up@@ -994,7 +1004,9 @@ export const listHooks = async (world: World, opts: InspectCLIOptions = {}) => {
 }
 },
 displayPage: async (hooks) => {
 const hydratedHooks = hooks.map(hydrateResourceIO);
 const hydratedHooks = await Promise.all(
 hooks.map((hook) => hydrateResourceIO(hook, world))
 );
 logger.log(showTable(hydratedHooks, HOOK_LISTED_PROPS, opts));
 showInspectInfoBox('hook');
 },
Expand All@@ -1013,7 +1025,7 @@ export const showHook = async (
 const hook = await world.hooks.get(hookId, {
 resolveData: 'all',
 });
 const hydratedHook = hydrateResourceIO(hook);
 const hydratedHook = await hydrateResourceIO(hook, world);
 if (opts.json) {
 showJson(hydratedHook);
 return;
Expand Down

15 changes: 9 additions & 6 deletions
packages/core/e2e/bench.bench.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { withResolvers } from '@workflow/utils';
import fs from 'fs';
import path from 'path';
import { bench, describe } from 'vitest';
Expand DownExpand Up@@ -46,17 +45,22 @@ async function triggerWorkflow(
 url.searchParams.set('workflowFn', workflowFn);

 const ops: Promise<void>[] = [];
 const { promise: runIdPromise, resolve: resolveRunId } =
 withResolvers<string>();
 const dehydratedArgs = dehydrateWorkflowArguments(args, ops, runIdPromise);
 // Dehydrate args for transport - no encryption needed for test setup
 // The server will re-serialize with the real runId when calling start()
 const dehydratedArgs = await dehydrateWorkflowArguments(
 args,
 '', // No runId needed for unencrypted transport
 {}, // No encryptor
 ops
 );

 const res = await fetch(url, {
 method: 'POST',
 headers: {
 ...getProtectionBypassHeaders(),
 'Content-Type': 'application/octet-stream',
 },
 body: dehydratedArgs.buffer as BodyInit,
 body: dehydratedArgs as Uint8Array,
 });
 if (!res.ok) {
 throw new Error(
Expand All@@ -66,7 +70,6 @@ async function triggerWorkflow(
 );
 }
 const run = await res.json();
 resolveRunId(run.runId);

 // Resolve and wait for any stream operations
 await Promise.all(ops);
Expand Down

15 changes: 9 additions & 6 deletions
packages/core/e2e/e2e.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { withResolvers } from '@workflow/utils';
import fs from 'fs';
import path from 'path';
import { afterAll, assert, describe, expect, test } from 'vitest';
Expand DownExpand Up@@ -67,17 +66,22 @@ async function triggerWorkflow(
 url.searchParams.set('workflowFn', workflowFn);

 const ops: Promise<void>[] = [];
 const { promise: runIdPromise, resolve: resolveRunId } =
 withResolvers<string>();
 const dehydratedArgs = dehydrateWorkflowArguments(args, ops, runIdPromise);
 // Dehydrate args for transport - no encryption needed for test setup
 // The server will re-serialize with the real runId when calling start()
 const dehydratedArgs = await dehydrateWorkflowArguments(
 args,
 '', // No runId needed for unencrypted transport
 {}, // No encryptor
 ops
 );

 const res = await fetch(url, {
 method: 'POST',
 headers: {
 ...getProtectionBypassHeaders(),
 'Content-Type': 'application/octet-stream',
 },
 body: dehydratedArgs.buffer as BodyInit,
 body: dehydratedArgs as Uint8Array,
 });
 if (!res.ok) {
 throw new Error(
Expand All@@ -87,7 +91,6 @@ async function triggerWorkflow(
 );
 }
 const run = await res.json();
 resolveRunId(run.runId);

 // Collect runId for observability links (Vercel world only)
 if (process.env.WORKFLOW_VERCEL_ENV) {
Expand Down

41 changes: 37 additions & 4 deletions
packages/core/src/observability.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { inspect } from 'node:util';
import { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from '@workflow/serde';
import type { Encryptor, World } from '@workflow/world';
import { describe, expect, it } from 'vitest';
import { registerSerializationClass } from './class-serialization.js';
import {
Expand All@@ -13,7 +14,39 @@ import {
 STREAM_REF_TYPE,
 truncateId,
} from './observability.js';
import { dehydrateStepReturnValue } from './serialization.js';
import { dehydrateStepReturnValue as _dehydrateStepReturnValue } from './serialization.js';

// Mock encryptor without encryption for tests
const mockEncryptor: Encryptor = {};

// Mock world for tests
const mockWorld = {
 queue: async () => ({ messageId: 'msg_test' }),
 createQueueHandler: () => async () => new Response(),
 readFromStorage: async () => new Uint8Array(),
 writeToStorage: async () => {},
 deleteFromStorage: async () => {},
 readFromStream: async () => new ReadableStream(),
 writeToStream: async () => {},
 writeToStreamMulti: async () => {},
 closeStream: async () => {},
 getDeploymentId: async () => 'test-deployment',
 events: {
 create: async () => ({ run: null }),
 list: async () => ({ data: [], cursor: null, hasMore: false, run: null }),
 },
} as unknown as World;

const mockRunId = 'wrun_test123';

// Wrapper for dehydrateStepReturnValue to use in tests
async function dehydrateStepReturnValue(
 value: unknown,
 ops: Promise<any>[] = [],
 runId: string = mockRunId
): Promise<Uint8Array | unknown> {
 return _dehydrateStepReturnValue(value, runId, mockEncryptor, ops);
}

describe('ClassInstanceRef', () => {
 describe('constructor and properties', () => {
Expand DownExpand Up@@ -332,10 +365,10 @@ describe('hydrateResourceIO with custom class instances', () => {
 (TestPoint as any).classId = 'test//TestPoint';
 registerSerializationClass('test//TestPoint', TestPoint);

 it('should convert Instance type to ClassInstanceRef in step output', () => {
 it('should convert Instance type to ClassInstanceRef in step output', async () => {
 // Simulate serialized step data with a custom class instance
 const point = new TestPoint(3, 4);
 const serialized = dehydrateStepReturnValue(point, [], 'wrun_test');
 const serialized = await dehydrateStepReturnValue(point, [], 'wrun_test');

 // Create a step resource with serialized output
 const step = {
Expand All@@ -346,7 +379,7 @@ describe('hydrateResourceIO with custom class instances', () => {

 // Hydrate the step - this should convert Instance to ClassInstanceRef
 // because the class is not registered in the o11y context (streamPrintRevivers)
 const hydrated = hydrateResourceIO(step);
 const hydrated = await hydrateResourceIO(step, mockWorld);

 // The output should be a ClassInstanceRef
 expect(isClassInstanceRef(hydrated.output)).toBe(true);
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Add end-to-end encryption for workflow user data#950

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.

 Sign up for GitHub

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

 Closed

TooTallNate
wants to merge
7
commits into

from

 Closed


Add end-to-end encryption for workflow user data
#950
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
ec9e00d

Add end-to-end encryption for workflow user data


TooTallNate Feb 5, 2026
73ea363

Fix serialization function signatures for E2E encryption


TooTallNate Feb 5, 2026
8f7941d

Fix world implementations to accept client-provided runId


TooTallNate Feb 5, 2026
5ab78f8

Pass client-generated runId as first parameter to events.create()


TooTallNate Feb 5, 2026
9dd15a6

Fix E2E test dehydrateWorkflowArguments call signature


TooTallNate Feb 5, 2026
c41706e

Fix serialization test to await async wrapper functions


TooTallNate Feb 5, 2026
f95f584

Add deployment key length validation for AES-256


TooTallNate Feb 5, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


19 changes: 19 additions & 0 deletions
.changeset/e2e-encryption.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
"@workflow/cli": patch
"@workflow/core": patch
"@workflow/web-shared": patch
"@workflow/world-vercel": patch
"@workflow/world": patch
"@workflow/world-testing": patch
---

Add end-to-end encryption for workflow user data

This implements AES-256-GCM encryption with per-run key derivation via HKDF-SHA256 for workflow user data.

Key changes:
- Add encryption module with `createEncryptor()` and `createEncryptorFromEnv()` functions
- Add `Encryptor`, `EncryptionContext`, `KeyMaterial` interfaces to `@workflow/world`
- Make all (de)hydrate serialization functions async and accept encryptor parameter
- Update `runWorkflow()` to take world as 4th parameter
- Update `WorkflowOrchestratorContext` to include `runId` and `world`

30 changes: 21 additions & 9 deletions
packages/cli/src/lib/inspect/output.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -534,7 +534,9 @@ export const listRuns = async (world: World, opts: InspectCLIOptions = {}) => {
 },
 resolveData,
 });
 const runsWithHydratedIO = runs.data.map(hydrateResourceIO);
 const runsWithHydratedIO = await Promise.all(
 runs.data.map((run) => hydrateResourceIO(run, world))
 );
 showJson({ ...runs, data: runsWithHydratedIO });
 return;
 } catch (error) {
Expand DownExpand Up@@ -572,7 +574,9 @@ export const listRuns = async (world: World, opts: InspectCLIOptions = {}) => {
 }
 },
 displayPage: async (runs) => {
 const runsWithHydratedIO = runs.map(hydrateResourceIO);
 const runsWithHydratedIO = await Promise.all(
 runs.map((run) => hydrateResourceIO(run, world))
 );
 logger.log(showTable(runsWithHydratedIO, props, opts));
 },
 });
Expand All@@ -588,7 +592,9 @@ export const getRecentRun = async (
 pagination: { limit: 1, sortOrder: opts.sort || 'desc' },
 resolveData: 'none', // Don't need data for just getting the ID
 });
 runs.data = runs.data.map(hydrateResourceIO);
 runs.data = await Promise.all(
 runs.data.map((run) => hydrateResourceIO(run, world))
 );
 return runs.data[0];
 } catch (error) {
 if (handleApiError(error, opts.backend)) {
Expand All@@ -608,7 +614,7 @@ export const showRun = async (
 }
 try {
 const run = await world.runs.get(runId, { resolveData: 'all' });
 const runWithHydratedIO = hydrateResourceIO(run);
 const runWithHydratedIO = await hydrateResourceIO(run, world);
 if (opts.json) {
 showJson(runWithHydratedIO);
 return;
Expand DownExpand Up@@ -711,7 +717,9 @@ export const listSteps = async (
 }
 },
 displayPage: async (steps) => {
 const stepsWithHydratedIO = steps.map(hydrateResourceIO);
 const stepsWithHydratedIO = await Promise.all(
 steps.map((step) => hydrateResourceIO(step, world))
 );
 logger.log(showTable(stepsWithHydratedIO, props, opts));
 showInspectInfoBox('step');
 },
Expand All@@ -735,7 +743,7 @@ export const showStep = async (
 const step = await world.steps.get(opts.runId, stepId, {
 resolveData: 'all',
 });
 const stepWithHydratedIO = hydrateResourceIO(step);
 const stepWithHydratedIO = await hydrateResourceIO(step, world);
 if (opts.json) {
 showJson(stepWithHydratedIO);
 return;
Expand DownExpand Up@@ -950,7 +958,9 @@ export const listHooks = async (world: World, opts: InspectCLIOptions = {}) => {
 },
 resolveData,
 });
 const hydratedHooks = hooks.data.map(hydrateResourceIO);
 const hydratedHooks = await Promise.all(
 hooks.data.map((hook) => hydrateResourceIO(hook, world))
 );
 showJson({ ...hooks, data: hydratedHooks });
 return;
 } catch (error) {
Expand DownExpand Up@@ -994,7 +1004,9 @@ export const listHooks = async (world: World, opts: InspectCLIOptions = {}) => {
 }
 },
 displayPage: async (hooks) => {
 const hydratedHooks = hooks.map(hydrateResourceIO);
 const hydratedHooks = await Promise.all(
 hooks.map((hook) => hydrateResourceIO(hook, world))
 );
 logger.log(showTable(hydratedHooks, HOOK_LISTED_PROPS, opts));
 showInspectInfoBox('hook');
 },
Expand All@@ -1013,7 +1025,7 @@ export const showHook = async (
 const hook = await world.hooks.get(hookId, {
 resolveData: 'all',
 });
 const hydratedHook = hydrateResourceIO(hook);
 const hydratedHook = await hydrateResourceIO(hook, world);
 if (opts.json) {
 showJson(hydratedHook);
 return;
Expand Down

15 changes: 9 additions & 6 deletions
packages/core/e2e/bench.bench.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { withResolvers } from '@workflow/utils';
import fs from 'fs';
import path from 'path';
import { bench, describe } from 'vitest';
Expand DownExpand Up@@ -46,17 +45,22 @@ async function triggerWorkflow(
 url.searchParams.set('workflowFn', workflowFn);

 const ops: Promise<void>[] = [];
 const { promise: runIdPromise, resolve: resolveRunId } =
 withResolvers<string>();
 const dehydratedArgs = dehydrateWorkflowArguments(args, ops, runIdPromise);
 // Dehydrate args for transport - no encryption needed for test setup
 // The server will re-serialize with the real runId when calling start()
 const dehydratedArgs = await dehydrateWorkflowArguments(
 args,
 '', // No runId needed for unencrypted transport
 {}, // No encryptor
 ops
 );

 const res = await fetch(url, {
 method: 'POST',
 headers: {
 ...getProtectionBypassHeaders(),
 'Content-Type': 'application/octet-stream',
 },
 body: dehydratedArgs.buffer as BodyInit,
 body: dehydratedArgs as Uint8Array,
 });
 if (!res.ok) {
 throw new Error(
Expand All@@ -66,7 +70,6 @@ async function triggerWorkflow(
 );
 }
 const run = await res.json();
 resolveRunId(run.runId);

 // Resolve and wait for any stream operations
 await Promise.all(ops);
Expand Down

15 changes: 9 additions & 6 deletions
packages/core/e2e/e2e.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { withResolvers } from '@workflow/utils';
import fs from 'fs';
import path from 'path';
import { afterAll, assert, describe, expect, test } from 'vitest';
Expand DownExpand Up@@ -67,17 +66,22 @@ async function triggerWorkflow(
 url.searchParams.set('workflowFn', workflowFn);

 const ops: Promise<void>[] = [];
 const { promise: runIdPromise, resolve: resolveRunId } =
 withResolvers<string>();
 const dehydratedArgs = dehydrateWorkflowArguments(args, ops, runIdPromise);
 // Dehydrate args for transport - no encryption needed for test setup
 // The server will re-serialize with the real runId when calling start()
 const dehydratedArgs = await dehydrateWorkflowArguments(
 args,
 '', // No runId needed for unencrypted transport
 {}, // No encryptor
 ops
 );

 const res = await fetch(url, {
 method: 'POST',
 headers: {
 ...getProtectionBypassHeaders(),
 'Content-Type': 'application/octet-stream',
 },
 body: dehydratedArgs.buffer as BodyInit,
 body: dehydratedArgs as Uint8Array,
 });
 if (!res.ok) {
 throw new Error(
Expand All@@ -87,7 +91,6 @@ async function triggerWorkflow(
 );
 }
 const run = await res.json();
 resolveRunId(run.runId);

 // Collect runId for observability links (Vercel world only)
 if (process.env.WORKFLOW_VERCEL_ENV) {
Expand Down

41 changes: 37 additions & 4 deletions
packages/core/src/observability.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { inspect } from 'node:util';
import { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from '@workflow/serde';
import type { Encryptor, World } from '@workflow/world';
import { describe, expect, it } from 'vitest';
import { registerSerializationClass } from './class-serialization.js';
import {
Expand All@@ -13,7 +14,39 @@ import {
 STREAM_REF_TYPE,
 truncateId,
} from './observability.js';
import { dehydrateStepReturnValue } from './serialization.js';
import { dehydrateStepReturnValue as _dehydrateStepReturnValue } from './serialization.js';

// Mock encryptor without encryption for tests
const mockEncryptor: Encryptor = {};

// Mock world for tests
const mockWorld = {
 queue: async () => ({ messageId: 'msg_test' }),
 createQueueHandler: () => async () => new Response(),
 readFromStorage: async () => new Uint8Array(),
 writeToStorage: async () => {},
 deleteFromStorage: async () => {},
 readFromStream: async () => new ReadableStream(),
 writeToStream: async () => {},
 writeToStreamMulti: async () => {},
 closeStream: async () => {},
 getDeploymentId: async () => 'test-deployment',
 events: {
 create: async () => ({ run: null }),
 list: async () => ({ data: [], cursor: null, hasMore: false, run: null }),
 },
} as unknown as World;

const mockRunId = 'wrun_test123';

// Wrapper for dehydrateStepReturnValue to use in tests
async function dehydrateStepReturnValue(
 value: unknown,
 ops: Promise<any>[] = [],
 runId: string = mockRunId
): Promise<Uint8Array | unknown> {
 return _dehydrateStepReturnValue(value, runId, mockEncryptor, ops);
}

describe('ClassInstanceRef', () => {
 describe('constructor and properties', () => {
Expand DownExpand Up@@ -332,10 +365,10 @@ describe('hydrateResourceIO with custom class instances', () => {
 (TestPoint as any).classId = 'test//TestPoint';
 registerSerializationClass('test//TestPoint', TestPoint);

 it('should convert Instance type to ClassInstanceRef in step output', () => {
 it('should convert Instance type to ClassInstanceRef in step output', async () => {
 // Simulate serialized step data with a custom class instance
 const point = new TestPoint(3, 4);
 const serialized = dehydrateStepReturnValue(point, [], 'wrun_test');
 const serialized = await dehydrateStepReturnValue(point, [], 'wrun_test');

 // Create a step resource with serialized output
 const step = {
Expand All@@ -346,7 +379,7 @@ describe('hydrateResourceIO with custom class instances', () => {

 // Hydrate the step - this should convert Instance to ClassInstanceRef
 // because the class is not registered in the o11y context (streamPrintRevivers)
 const hydrated = hydrateResourceIO(step);
 const hydrated = await hydrateResourceIO(step, mockWorld);

 // The output should be a ClassInstanceRef
 expect(isClassInstanceRef(hydrated.output)).toBe(true);
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add end-to-end encryption for workflow user data#950

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.

 Sign up for GitHub

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

 Closed

TooTallNate
wants to merge
7
commits into

from

 Closed


Add end-to-end encryption for workflow user data
#950
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
ec9e00d

Add end-to-end encryption for workflow user data


TooTallNate Feb 5, 2026
73ea363

Fix serialization function signatures for E2E encryption


TooTallNate Feb 5, 2026
8f7941d

Fix world implementations to accept client-provided runId


TooTallNate Feb 5, 2026
5ab78f8

Pass client-generated runId as first parameter to events.create()


TooTallNate Feb 5, 2026
9dd15a6

Fix E2E test dehydrateWorkflowArguments call signature


TooTallNate Feb 5, 2026
c41706e

Fix serialization test to await async wrapper functions


TooTallNate Feb 5, 2026
f95f584

Add deployment key length validation for AES-256


TooTallNate Feb 5, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


19 changes: 19 additions & 0 deletions
.changeset/e2e-encryption.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
"@workflow/cli": patch
"@workflow/core": patch
"@workflow/web-shared": patch
"@workflow/world-vercel": patch
"@workflow/world": patch
"@workflow/world-testing": patch
---

Add end-to-end encryption for workflow user data

This implements AES-256-GCM encryption with per-run key derivation via HKDF-SHA256 for workflow user data.

Key changes:
- Add encryption module with `createEncryptor()` and `createEncryptorFromEnv()` functions
- Add `Encryptor`, `EncryptionContext`, `KeyMaterial` interfaces to `@workflow/world`
- Make all (de)hydrate serialization functions async and accept encryptor parameter
- Update `runWorkflow()` to take world as 4th parameter
- Update `WorkflowOrchestratorContext` to include `runId` and `world`

30 changes: 21 additions & 9 deletions
packages/cli/src/lib/inspect/output.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -534,7 +534,9 @@ export const listRuns = async (world: World, opts: InspectCLIOptions = {}) => {
 },
 resolveData,
 });
 const runsWithHydratedIO = runs.data.map(hydrateResourceIO);
 const runsWithHydratedIO = await Promise.all(
 runs.data.map((run) => hydrateResourceIO(run, world))
 );
 showJson({ ...runs, data: runsWithHydratedIO });
 return;
 } catch (error) {
Expand DownExpand Up@@ -572,7 +574,9 @@ export const listRuns = async (world: World, opts: InspectCLIOptions = {}) => {
 }
 },
 displayPage: async (runs) => {
 const runsWithHydratedIO = runs.map(hydrateResourceIO);
 const runsWithHydratedIO = await Promise.all(
 runs.map((run) => hydrateResourceIO(run, world))
 );
 logger.log(showTable(runsWithHydratedIO, props, opts));
 },
 });
Expand All@@ -588,7 +592,9 @@ export const getRecentRun = async (
 pagination: { limit: 1, sortOrder: opts.sort || 'desc' },
 resolveData: 'none', // Don't need data for just getting the ID
 });
 runs.data = runs.data.map(hydrateResourceIO);
 runs.data = await Promise.all(
 runs.data.map((run) => hydrateResourceIO(run, world))
 );
 return runs.data[0];
 } catch (error) {
 if (handleApiError(error, opts.backend)) {
Expand All@@ -608,7 +614,7 @@ export const showRun = async (
 }
 try {
 const run = await world.runs.get(runId, { resolveData: 'all' });
 const runWithHydratedIO = hydrateResourceIO(run);
 const runWithHydratedIO = await hydrateResourceIO(run, world);
 if (opts.json) {
 showJson(runWithHydratedIO);
 return;
Expand DownExpand Up@@ -711,7 +717,9 @@ export const listSteps = async (
 }
 },
 displayPage: async (steps) => {
 const stepsWithHydratedIO = steps.map(hydrateResourceIO);
 const stepsWithHydratedIO = await Promise.all(
 steps.map((step) => hydrateResourceIO(step, world))
 );
 logger.log(showTable(stepsWithHydratedIO, props, opts));
 showInspectInfoBox('step');
 },
Expand All@@ -735,7 +743,7 @@ export const showStep = async (
 const step = await world.steps.get(opts.runId, stepId, {
 resolveData: 'all',
 });
 const stepWithHydratedIO = hydrateResourceIO(step);
 const stepWithHydratedIO = await hydrateResourceIO(step, world);
 if (opts.json) {
 showJson(stepWithHydratedIO);
 return;
Expand DownExpand Up@@ -950,7 +958,9 @@ export const listHooks = async (world: World, opts: InspectCLIOptions = {}) => {
 },
 resolveData,
 });
 const hydratedHooks = hooks.data.map(hydrateResourceIO);
 const hydratedHooks = await Promise.all(
 hooks.data.map((hook) => hydrateResourceIO(hook, world))
 );
 showJson({ ...hooks, data: hydratedHooks });
 return;
 } catch (error) {
Expand DownExpand Up@@ -994,7 +1004,9 @@ export const listHooks = async (world: World, opts: InspectCLIOptions = {}) => {
 }
 },
 displayPage: async (hooks) => {
 const hydratedHooks = hooks.map(hydrateResourceIO);
 const hydratedHooks = await Promise.all(
 hooks.map((hook) => hydrateResourceIO(hook, world))
 );
 logger.log(showTable(hydratedHooks, HOOK_LISTED_PROPS, opts));
 showInspectInfoBox('hook');
 },
Expand All@@ -1013,7 +1025,7 @@ export const showHook = async (
 const hook = await world.hooks.get(hookId, {
 resolveData: 'all',
 });
 const hydratedHook = hydrateResourceIO(hook);
 const hydratedHook = await hydrateResourceIO(hook, world);
 if (opts.json) {
 showJson(hydratedHook);
 return;
Expand Down

15 changes: 9 additions & 6 deletions
packages/core/e2e/bench.bench.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { withResolvers } from '@workflow/utils';
import fs from 'fs';
import path from 'path';
import { bench, describe } from 'vitest';
Expand DownExpand Up@@ -46,17 +45,22 @@ async function triggerWorkflow(
 url.searchParams.set('workflowFn', workflowFn);

 const ops: Promise<void>[] = [];
 const { promise: runIdPromise, resolve: resolveRunId } =
 withResolvers<string>();
 const dehydratedArgs = dehydrateWorkflowArguments(args, ops, runIdPromise);
 // Dehydrate args for transport - no encryption needed for test setup
 // The server will re-serialize with the real runId when calling start()
 const dehydratedArgs = await dehydrateWorkflowArguments(
 args,
 '', // No runId needed for unencrypted transport
 {}, // No encryptor
 ops
 );

 const res = await fetch(url, {
 method: 'POST',
 headers: {
 ...getProtectionBypassHeaders(),
 'Content-Type': 'application/octet-stream',
 },
 body: dehydratedArgs.buffer as BodyInit,
 body: dehydratedArgs as Uint8Array,
 });
 if (!res.ok) {
 throw new Error(
Expand All@@ -66,7 +70,6 @@ async function triggerWorkflow(
 );
 }
 const run = await res.json();
 resolveRunId(run.runId);

 // Resolve and wait for any stream operations
 await Promise.all(ops);
Expand Down

15 changes: 9 additions & 6 deletions
packages/core/e2e/e2e.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { withResolvers } from '@workflow/utils';
import fs from 'fs';
import path from 'path';
import { afterAll, assert, describe, expect, test } from 'vitest';
Expand DownExpand Up@@ -67,17 +66,22 @@ async function triggerWorkflow(
 url.searchParams.set('workflowFn', workflowFn);

 const ops: Promise<void>[] = [];
 const { promise: runIdPromise, resolve: resolveRunId } =
 withResolvers<string>();
 const dehydratedArgs = dehydrateWorkflowArguments(args, ops, runIdPromise);
 // Dehydrate args for transport - no encryption needed for test setup
 // The server will re-serialize with the real runId when calling start()
 const dehydratedArgs = await dehydrateWorkflowArguments(
 args,
 '', // No runId needed for unencrypted transport
 {}, // No encryptor
 ops
 );

 const res = await fetch(url, {
 method: 'POST',
 headers: {
 ...getProtectionBypassHeaders(),
 'Content-Type': 'application/octet-stream',
 },
 body: dehydratedArgs.buffer as BodyInit,
 body: dehydratedArgs as Uint8Array,
 });
 if (!res.ok) {
 throw new Error(
Expand All@@ -87,7 +91,6 @@ async function triggerWorkflow(
 );
 }
 const run = await res.json();
 resolveRunId(run.runId);

 // Collect runId for observability links (Vercel world only)
 if (process.env.WORKFLOW_VERCEL_ENV) {
Expand Down

41 changes: 37 additions & 4 deletions
packages/core/src/observability.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { inspect } from 'node:util';
import { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from '@workflow/serde';
import type { Encryptor, World } from '@workflow/world';
import { describe, expect, it } from 'vitest';
import { registerSerializationClass } from './class-serialization.js';
import {
Expand All@@ -13,7 +14,39 @@ import {
 STREAM_REF_TYPE,
 truncateId,
} from './observability.js';
import { dehydrateStepReturnValue } from './serialization.js';
import { dehydrateStepReturnValue as _dehydrateStepReturnValue } from './serialization.js';

// Mock encryptor without encryption for tests
const mockEncryptor: Encryptor = {};

// Mock world for tests
const mockWorld = {
 queue: async () => ({ messageId: 'msg_test' }),
 createQueueHandler: () => async () => new Response(),
 readFromStorage: async () => new Uint8Array(),
 writeToStorage: async () => {},
 deleteFromStorage: async () => {},
 readFromStream: async () => new ReadableStream(),
 writeToStream: async () => {},
 writeToStreamMulti: async () => {},
 closeStream: async () => {},
 getDeploymentId: async () => 'test-deployment',
 events: {
 create: async () => ({ run: null }),
 list: async () => ({ data: [], cursor: null, hasMore: false, run: null }),
 },
} as unknown as World;

const mockRunId = 'wrun_test123';

// Wrapper for dehydrateStepReturnValue to use in tests
async function dehydrateStepReturnValue(
 value: unknown,
 ops: Promise<any>[] = [],
 runId: string = mockRunId
): Promise<Uint8Array | unknown> {
 return _dehydrateStepReturnValue(value, runId, mockEncryptor, ops);
}

describe('ClassInstanceRef', () => {
 describe('constructor and properties', () => {
Expand DownExpand Up@@ -332,10 +365,10 @@ describe('hydrateResourceIO with custom class instances', () => {
 (TestPoint as any).classId = 'test//TestPoint';
 registerSerializationClass('test//TestPoint', TestPoint);

 it('should convert Instance type to ClassInstanceRef in step output', () => {
 it('should convert Instance type to ClassInstanceRef in step output', async () => {
 // Simulate serialized step data with a custom class instance
 const point = new TestPoint(3, 4);
 const serialized = dehydrateStepReturnValue(point, [], 'wrun_test');
 const serialized = await dehydrateStepReturnValue(point, [], 'wrun_test');

 // Create a step resource with serialized output
 const step = {
Expand All@@ -346,7 +379,7 @@ describe('hydrateResourceIO with custom class instances', () => {

 // Hydrate the step - this should convert Instance to ClassInstanceRef
 // because the class is not registered in the o11y context (streamPrintRevivers)
 const hydrated = hydrateResourceIO(step);
 const hydrated = await hydrateResourceIO(step, mockWorld);

 // The output should be a ClassInstanceRef
 expect(isClassInstanceRef(hydrated.output)).toBe(true);
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add end-to-end encryption for workflow user data#950

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.

 Sign up for GitHub

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

 Closed

TooTallNate
wants to merge
7
commits into

from

 Closed


Add end-to-end encryption for workflow user data
#950
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
ec9e00d

Add end-to-end encryption for workflow user data


TooTallNate Feb 5, 2026
73ea363

Fix serialization function signatures for E2E encryption


TooTallNate Feb 5, 2026
8f7941d

Fix world implementations to accept client-provided runId


TooTallNate Feb 5, 2026
5ab78f8

Pass client-generated runId as first parameter to events.create()


TooTallNate Feb 5, 2026
9dd15a6

Fix E2E test dehydrateWorkflowArguments call signature


TooTallNate Feb 5, 2026
c41706e

Fix serialization test to await async wrapper functions


TooTallNate Feb 5, 2026
f95f584

Add deployment key length validation for AES-256


TooTallNate Feb 5, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


19 changes: 19 additions & 0 deletions
.changeset/e2e-encryption.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
"@workflow/cli": patch
"@workflow/core": patch
"@workflow/web-shared": patch
"@workflow/world-vercel": patch
"@workflow/world": patch
"@workflow/world-testing": patch
---

Add end-to-end encryption for workflow user data

This implements AES-256-GCM encryption with per-run key derivation via HKDF-SHA256 for workflow user data.

Key changes:
- Add encryption module with `createEncryptor()` and `createEncryptorFromEnv()` functions
- Add `Encryptor`, `EncryptionContext`, `KeyMaterial` interfaces to `@workflow/world`
- Make all (de)hydrate serialization functions async and accept encryptor parameter
- Update `runWorkflow()` to take world as 4th parameter
- Update `WorkflowOrchestratorContext` to include `runId` and `world`

30 changes: 21 additions & 9 deletions
packages/cli/src/lib/inspect/output.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -534,7 +534,9 @@ export const listRuns = async (world: World, opts: InspectCLIOptions = {}) => {
 },
 resolveData,
 });
 const runsWithHydratedIO = runs.data.map(hydrateResourceIO);
 const runsWithHydratedIO = await Promise.all(
 runs.data.map((run) => hydrateResourceIO(run, world))
 );
 showJson({ ...runs, data: runsWithHydratedIO });
 return;
 } catch (error) {
Expand DownExpand Up@@ -572,7 +574,9 @@ export const listRuns = async (world: World, opts: InspectCLIOptions = {}) => {
 }
 },
 displayPage: async (runs) => {
 const runsWithHydratedIO = runs.map(hydrateResourceIO);
 const runsWithHydratedIO = await Promise.all(
 runs.map((run) => hydrateResourceIO(run, world))
 );
 logger.log(showTable(runsWithHydratedIO, props, opts));
 },
 });
Expand All@@ -588,7 +592,9 @@ export const getRecentRun = async (
 pagination: { limit: 1, sortOrder: opts.sort || 'desc' },
 resolveData: 'none', // Don't need data for just getting the ID
 });
 runs.data = runs.data.map(hydrateResourceIO);
 runs.data = await Promise.all(
 runs.data.map((run) => hydrateResourceIO(run, world))
 );
 return runs.data[0];
 } catch (error) {
 if (handleApiError(error, opts.backend)) {
Expand All@@ -608,7 +614,7 @@ export const showRun = async (
 }
 try {
 const run = await world.runs.get(runId, { resolveData: 'all' });
 const runWithHydratedIO = hydrateResourceIO(run);
 const runWithHydratedIO = await hydrateResourceIO(run, world);
 if (opts.json) {
 showJson(runWithHydratedIO);
 return;
Expand DownExpand Up@@ -711,7 +717,9 @@ export const listSteps = async (
 }
 },
 displayPage: async (steps) => {
 const stepsWithHydratedIO = steps.map(hydrateResourceIO);
 const stepsWithHydratedIO = await Promise.all(
 steps.map((step) => hydrateResourceIO(step, world))
 );
 logger.log(showTable(stepsWithHydratedIO, props, opts));
 showInspectInfoBox('step');
 },
Expand All@@ -735,7 +743,7 @@ export const showStep = async (
 const step = await world.steps.get(opts.runId, stepId, {
 resolveData: 'all',
 });
 const stepWithHydratedIO = hydrateResourceIO(step);
 const stepWithHydratedIO = await hydrateResourceIO(step, world);
 if (opts.json) {
 showJson(stepWithHydratedIO);
 return;
Expand DownExpand Up@@ -950,7 +958,9 @@ export const listHooks = async (world: World, opts: InspectCLIOptions = {}) => {
 },
 resolveData,
 });
 const hydratedHooks = hooks.data.map(hydrateResourceIO);
 const hydratedHooks = await Promise.all(
 hooks.data.map((hook) => hydrateResourceIO(hook, world))
 );
 showJson({ ...hooks, data: hydratedHooks });
 return;
 } catch (error) {
Expand DownExpand Up@@ -994,7 +1004,9 @@ export const listHooks = async (world: World, opts: InspectCLIOptions = {}) => {
 }
 },
 displayPage: async (hooks) => {
 const hydratedHooks = hooks.map(hydrateResourceIO);
 const hydratedHooks = await Promise.all(
 hooks.map((hook) => hydrateResourceIO(hook, world))
 );
 logger.log(showTable(hydratedHooks, HOOK_LISTED_PROPS, opts));
 showInspectInfoBox('hook');
 },
Expand All@@ -1013,7 +1025,7 @@ export const showHook = async (
 const hook = await world.hooks.get(hookId, {
 resolveData: 'all',
 });
 const hydratedHook = hydrateResourceIO(hook);
 const hydratedHook = await hydrateResourceIO(hook, world);
 if (opts.json) {
 showJson(hydratedHook);
 return;
Expand Down

15 changes: 9 additions & 6 deletions
packages/core/e2e/bench.bench.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { withResolvers } from '@workflow/utils';
import fs from 'fs';
import path from 'path';
import { bench, describe } from 'vitest';
Expand DownExpand Up@@ -46,17 +45,22 @@ async function triggerWorkflow(
 url.searchParams.set('workflowFn', workflowFn);

 const ops: Promise<void>[] = [];
 const { promise: runIdPromise, resolve: resolveRunId } =
 withResolvers<string>();
 const dehydratedArgs = dehydrateWorkflowArguments(args, ops, runIdPromise);
 // Dehydrate args for transport - no encryption needed for test setup
 // The server will re-serialize with the real runId when calling start()
 const dehydratedArgs = await dehydrateWorkflowArguments(
 args,
 '', // No runId needed for unencrypted transport
 {}, // No encryptor
 ops
 );

 const res = await fetch(url, {
 method: 'POST',
 headers: {
 ...getProtectionBypassHeaders(),
 'Content-Type': 'application/octet-stream',
 },
 body: dehydratedArgs.buffer as BodyInit,
 body: dehydratedArgs as Uint8Array,
 });
 if (!res.ok) {
 throw new Error(
Expand All@@ -66,7 +70,6 @@ async function triggerWorkflow(
 );
 }
 const run = await res.json();
 resolveRunId(run.runId);

 // Resolve and wait for any stream operations
 await Promise.all(ops);
Expand Down

15 changes: 9 additions & 6 deletions
packages/core/e2e/e2e.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { withResolvers } from '@workflow/utils';
import fs from 'fs';
import path from 'path';
import { afterAll, assert, describe, expect, test } from 'vitest';
Expand DownExpand Up@@ -67,17 +66,22 @@ async function triggerWorkflow(
 url.searchParams.set('workflowFn', workflowFn);

 const ops: Promise<void>[] = [];
 const { promise: runIdPromise, resolve: resolveRunId } =
 withResolvers<string>();
 const dehydratedArgs = dehydrateWorkflowArguments(args, ops, runIdPromise);
 // Dehydrate args for transport - no encryption needed for test setup
 // The server will re-serialize with the real runId when calling start()
 const dehydratedArgs = await dehydrateWorkflowArguments(
 args,
 '', // No runId needed for unencrypted transport
 {}, // No encryptor
 ops
 );

 const res = await fetch(url, {
 method: 'POST',
 headers: {
 ...getProtectionBypassHeaders(),
 'Content-Type': 'application/octet-stream',
 },
 body: dehydratedArgs.buffer as BodyInit,
 body: dehydratedArgs as Uint8Array,
 });
 if (!res.ok) {
 throw new Error(
Expand All@@ -87,7 +91,6 @@ async function triggerWorkflow(
 );
 }
 const run = await res.json();
 resolveRunId(run.runId);

 // Collect runId for observability links (Vercel world only)
 if (process.env.WORKFLOW_VERCEL_ENV) {
Expand Down

41 changes: 37 additions & 4 deletions
packages/core/src/observability.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { inspect } from 'node:util';
import { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from '@workflow/serde';
import type { Encryptor, World } from '@workflow/world';
import { describe, expect, it } from 'vitest';
import { registerSerializationClass } from './class-serialization.js';
import {
Expand All@@ -13,7 +14,39 @@ import {
 STREAM_REF_TYPE,
 truncateId,
} from './observability.js';
import { dehydrateStepReturnValue } from './serialization.js';
import { dehydrateStepReturnValue as _dehydrateStepReturnValue } from './serialization.js';

// Mock encryptor without encryption for tests
const mockEncryptor: Encryptor = {};

// Mock world for tests
const mockWorld = {
 queue: async () => ({ messageId: 'msg_test' }),
 createQueueHandler: () => async () => new Response(),
 readFromStorage: async () => new Uint8Array(),
 writeToStorage: async () => {},
 deleteFromStorage: async () => {},
 readFromStream: async () => new ReadableStream(),
 writeToStream: async () => {},
 writeToStreamMulti: async () => {},
 closeStream: async () => {},
 getDeploymentId: async () => 'test-deployment',
 events: {
 create: async () => ({ run: null }),
 list: async () => ({ data: [], cursor: null, hasMore: false, run: null }),
 },
} as unknown as World;

const mockRunId = 'wrun_test123';

// Wrapper for dehydrateStepReturnValue to use in tests
async function dehydrateStepReturnValue(
 value: unknown,
 ops: Promise<any>[] = [],
 runId: string = mockRunId
): Promise<Uint8Array | unknown> {
 return _dehydrateStepReturnValue(value, runId, mockEncryptor, ops);
}

describe('ClassInstanceRef', () => {
 describe('constructor and properties', () => {
Expand DownExpand Up@@ -332,10 +365,10 @@ describe('hydrateResourceIO with custom class instances', () => {
 (TestPoint as any).classId = 'test//TestPoint';
 registerSerializationClass('test//TestPoint', TestPoint);

 it('should convert Instance type to ClassInstanceRef in step output', () => {
 it('should convert Instance type to ClassInstanceRef in step output', async () => {
 // Simulate serialized step data with a custom class instance
 const point = new TestPoint(3, 4);
 const serialized = dehydrateStepReturnValue(point, [], 'wrun_test');
 const serialized = await dehydrateStepReturnValue(point, [], 'wrun_test');

 // Create a step resource with serialized output
 const step = {
Expand All@@ -346,7 +379,7 @@ describe('hydrateResourceIO with custom class instances', () => {

 // Hydrate the step - this should convert Instance to ClassInstanceRef
 // because the class is not registered in the o11y context (streamPrintRevivers)
 const hydrated = hydrateResourceIO(step);
 const hydrated = await hydrateResourceIO(step, mockWorld);

 // The output should be a ClassInstanceRef
 expect(isClassInstanceRef(hydrated.output)).toBe(true);
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Add end-to-end encryption for workflow user data#950

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.

 Sign up for GitHub

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

 Closed

TooTallNate
wants to merge
7
commits into

from

 Closed


Add end-to-end encryption for workflow user data
#950
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
ec9e00d

Add end-to-end encryption for workflow user data


TooTallNate Feb 5, 2026
73ea363

Fix serialization function signatures for E2E encryption


TooTallNate Feb 5, 2026
8f7941d

Fix world implementations to accept client-provided runId


TooTallNate Feb 5, 2026
5ab78f8

Pass client-generated runId as first parameter to events.create()


TooTallNate Feb 5, 2026
9dd15a6

Fix E2E test dehydrateWorkflowArguments call signature


TooTallNate Feb 5, 2026
c41706e

Fix serialization test to await async wrapper functions


TooTallNate Feb 5, 2026
f95f584

Add deployment key length validation for AES-256


TooTallNate Feb 5, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


19 changes: 19 additions & 0 deletions
.changeset/e2e-encryption.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
"@workflow/cli": patch
"@workflow/core": patch
"@workflow/web-shared": patch
"@workflow/world-vercel": patch
"@workflow/world": patch
"@workflow/world-testing": patch
---

Add end-to-end encryption for workflow user data

This implements AES-256-GCM encryption with per-run key derivation via HKDF-SHA256 for workflow user data.

Key changes:
- Add encryption module with `createEncryptor()` and `createEncryptorFromEnv()` functions
- Add `Encryptor`, `EncryptionContext`, `KeyMaterial` interfaces to `@workflow/world`
- Make all (de)hydrate serialization functions async and accept encryptor parameter
- Update `runWorkflow()` to take world as 4th parameter
- Update `WorkflowOrchestratorContext` to include `runId` and `world`

30 changes: 21 additions & 9 deletions
packages/cli/src/lib/inspect/output.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -534,7 +534,9 @@ export const listRuns = async (world: World, opts: InspectCLIOptions = {}) => {
 },
 resolveData,
 });
 const runsWithHydratedIO = runs.data.map(hydrateResourceIO);
 const runsWithHydratedIO = await Promise.all(
 runs.data.map((run) => hydrateResourceIO(run, world))
 );
 showJson({ ...runs, data: runsWithHydratedIO });
 return;
 } catch (error) {
Expand DownExpand Up@@ -572,7 +574,9 @@ export const listRuns = async (world: World, opts: InspectCLIOptions = {}) => {
 }
 },
 displayPage: async (runs) => {
 const runsWithHydratedIO = runs.map(hydrateResourceIO);
 const runsWithHydratedIO = await Promise.all(
 runs.map((run) => hydrateResourceIO(run, world))
 );
 logger.log(showTable(runsWithHydratedIO, props, opts));
 },
 });
Expand All@@ -588,7 +592,9 @@ export const getRecentRun = async (
 pagination: { limit: 1, sortOrder: opts.sort || 'desc' },
 resolveData: 'none', // Don't need data for just getting the ID
 });
 runs.data = runs.data.map(hydrateResourceIO);
 runs.data = await Promise.all(
 runs.data.map((run) => hydrateResourceIO(run, world))
 );
 return runs.data[0];
 } catch (error) {
 if (handleApiError(error, opts.backend)) {
Expand All@@ -608,7 +614,7 @@ export const showRun = async (
 }
 try {
 const run = await world.runs.get(runId, { resolveData: 'all' });
 const runWithHydratedIO = hydrateResourceIO(run);
 const runWithHydratedIO = await hydrateResourceIO(run, world);
 if (opts.json) {
 showJson(runWithHydratedIO);
 return;
Expand DownExpand Up@@ -711,7 +717,9 @@ export const listSteps = async (
 }
 },
 displayPage: async (steps) => {
 const stepsWithHydratedIO = steps.map(hydrateResourceIO);
 const stepsWithHydratedIO = await Promise.all(
 steps.map((step) => hydrateResourceIO(step, world))
 );
 logger.log(showTable(stepsWithHydratedIO, props, opts));
 showInspectInfoBox('step');
 },
Expand All@@ -735,7 +743,7 @@ export const showStep = async (
 const step = await world.steps.get(opts.runId, stepId, {
 resolveData: 'all',
 });
 const stepWithHydratedIO = hydrateResourceIO(step);
 const stepWithHydratedIO = await hydrateResourceIO(step, world);
 if (opts.json) {
 showJson(stepWithHydratedIO);
 return;
Expand DownExpand Up@@ -950,7 +958,9 @@ export const listHooks = async (world: World, opts: InspectCLIOptions = {}) => {
 },
 resolveData,
 });
 const hydratedHooks = hooks.data.map(hydrateResourceIO);
 const hydratedHooks = await Promise.all(
 hooks.data.map((hook) => hydrateResourceIO(hook, world))
 );
 showJson({ ...hooks, data: hydratedHooks });
 return;
 } catch (error) {
Expand DownExpand Up@@ -994,7 +1004,9 @@ export const listHooks = async (world: World, opts: InspectCLIOptions = {}) => {
 }
 },
 displayPage: async (hooks) => {
 const hydratedHooks = hooks.map(hydrateResourceIO);
 const hydratedHooks = await Promise.all(
 hooks.map((hook) => hydrateResourceIO(hook, world))
 );
 logger.log(showTable(hydratedHooks, HOOK_LISTED_PROPS, opts));
 showInspectInfoBox('hook');
 },
Expand All@@ -1013,7 +1025,7 @@ export const showHook = async (
 const hook = await world.hooks.get(hookId, {
 resolveData: 'all',
 });
 const hydratedHook = hydrateResourceIO(hook);
 const hydratedHook = await hydrateResourceIO(hook, world);
 if (opts.json) {
 showJson(hydratedHook);
 return;
Expand Down

15 changes: 9 additions & 6 deletions
packages/core/e2e/bench.bench.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { withResolvers } from '@workflow/utils';
import fs from 'fs';
import path from 'path';
import { bench, describe } from 'vitest';
Expand DownExpand Up@@ -46,17 +45,22 @@ async function triggerWorkflow(
 url.searchParams.set('workflowFn', workflowFn);

 const ops: Promise<void>[] = [];
 const { promise: runIdPromise, resolve: resolveRunId } =
 withResolvers<string>();
 const dehydratedArgs = dehydrateWorkflowArguments(args, ops, runIdPromise);
 // Dehydrate args for transport - no encryption needed for test setup
 // The server will re-serialize with the real runId when calling start()
 const dehydratedArgs = await dehydrateWorkflowArguments(
 args,
 '', // No runId needed for unencrypted transport
 {}, // No encryptor
 ops
 );

 const res = await fetch(url, {
 method: 'POST',
 headers: {
 ...getProtectionBypassHeaders(),
 'Content-Type': 'application/octet-stream',
 },
 body: dehydratedArgs.buffer as BodyInit,
 body: dehydratedArgs as Uint8Array,
 });
 if (!res.ok) {
 throw new Error(
Expand All@@ -66,7 +70,6 @@ async function triggerWorkflow(
 );
 }
 const run = await res.json();
 resolveRunId(run.runId);

 // Resolve and wait for any stream operations
 await Promise.all(ops);
Expand Down

15 changes: 9 additions & 6 deletions
packages/core/e2e/e2e.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { withResolvers } from '@workflow/utils';
import fs from 'fs';
import path from 'path';
import { afterAll, assert, describe, expect, test } from 'vitest';
Expand DownExpand Up@@ -67,17 +66,22 @@ async function triggerWorkflow(
 url.searchParams.set('workflowFn', workflowFn);

 const ops: Promise<void>[] = [];
 const { promise: runIdPromise, resolve: resolveRunId } =
 withResolvers<string>();
 const dehydratedArgs = dehydrateWorkflowArguments(args, ops, runIdPromise);
 // Dehydrate args for transport - no encryption needed for test setup
 // The server will re-serialize with the real runId when calling start()
 const dehydratedArgs = await dehydrateWorkflowArguments(
 args,
 '', // No runId needed for unencrypted transport
 {}, // No encryptor
 ops
 );

 const res = await fetch(url, {
 method: 'POST',
 headers: {
 ...getProtectionBypassHeaders(),
 'Content-Type': 'application/octet-stream',
 },
 body: dehydratedArgs.buffer as BodyInit,
 body: dehydratedArgs as Uint8Array,
 });
 if (!res.ok) {
 throw new Error(
Expand All@@ -87,7 +91,6 @@ async function triggerWorkflow(
 );
 }
 const run = await res.json();
 resolveRunId(run.runId);

 // Collect runId for observability links (Vercel world only)
 if (process.env.WORKFLOW_VERCEL_ENV) {
Expand Down

41 changes: 37 additions & 4 deletions
packages/core/src/observability.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { inspect } from 'node:util';
import { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from '@workflow/serde';
import type { Encryptor, World } from '@workflow/world';
import { describe, expect, it } from 'vitest';
import { registerSerializationClass } from './class-serialization.js';
import {
Expand All@@ -13,7 +14,39 @@ import {
 STREAM_REF_TYPE,
 truncateId,
} from './observability.js';
import { dehydrateStepReturnValue } from './serialization.js';
import { dehydrateStepReturnValue as _dehydrateStepReturnValue } from './serialization.js';

// Mock encryptor without encryption for tests
const mockEncryptor: Encryptor = {};

// Mock world for tests
const mockWorld = {
 queue: async () => ({ messageId: 'msg_test' }),
 createQueueHandler: () => async () => new Response(),
 readFromStorage: async () => new Uint8Array(),
 writeToStorage: async () => {},
 deleteFromStorage: async () => {},
 readFromStream: async () => new ReadableStream(),
 writeToStream: async () => {},
 writeToStreamMulti: async () => {},
 closeStream: async () => {},
 getDeploymentId: async () => 'test-deployment',
 events: {
 create: async () => ({ run: null }),
 list: async () => ({ data: [], cursor: null, hasMore: false, run: null }),
 },
} as unknown as World;

const mockRunId = 'wrun_test123';

// Wrapper for dehydrateStepReturnValue to use in tests
async function dehydrateStepReturnValue(
 value: unknown,
 ops: Promise<any>[] = [],
 runId: string = mockRunId
): Promise<Uint8Array | unknown> {
 return _dehydrateStepReturnValue(value, runId, mockEncryptor, ops);
}

describe('ClassInstanceRef', () => {
 describe('constructor and properties', () => {
Expand DownExpand Up@@ -332,10 +365,10 @@ describe('hydrateResourceIO with custom class instances', () => {
 (TestPoint as any).classId = 'test//TestPoint';
 registerSerializationClass('test//TestPoint', TestPoint);

 it('should convert Instance type to ClassInstanceRef in step output', () => {
 it('should convert Instance type to ClassInstanceRef in step output', async () => {
 // Simulate serialized step data with a custom class instance
 const point = new TestPoint(3, 4);
 const serialized = dehydrateStepReturnValue(point, [], 'wrun_test');
 const serialized = await dehydrateStepReturnValue(point, [], 'wrun_test');

 // Create a step resource with serialized output
 const step = {
Expand All@@ -346,7 +379,7 @@ describe('hydrateResourceIO with custom class instances', () => {

 // Hydrate the step - this should convert Instance to ClassInstanceRef
 // because the class is not registered in the o11y context (streamPrintRevivers)
 const hydrated = hydrateResourceIO(step);
 const hydrated = await hydrateResourceIO(step, mockWorld);

 // The output should be a ClassInstanceRef
 expect(isClassInstanceRef(hydrated.output)).toBe(true);
Expand Down
Loading
Loading