Skip to content
TypeScript

feat(secrets): answer a secret request with a secret provider reference (#31670)

Julius Marminge7462b16f369d
diff --git a/apps/mobile/src/features/threads/SecretRequestCard.tsx b/apps/mobile/src/features/threads/SecretRequestCard.tsx
index 19bf52ccd48..bc1272d6847 100644
--- a/apps/mobile/src/features/threads/SecretRequestCard.tsx
+++ b/apps/mobile/src/features/threads/SecretRequestCard.tsx
@@ -5,13 +5,21 @@ import {
secretRequestDisplay,
secretRequestFailureMessage,
secretRequestPrivacyNote,
+ secretRequestReference,
+ secretRequestSources,
type SecretRequestItem,
+ type SecretRequestReply,
} from "@t3tools/client-runtime/secret-request";
import {
isAtomCommandInterrupted,
squashAtomCommandFailure,
} from "@t3tools/client-runtime/state/runtime";
-import type { EnvironmentId, OrchestrationV2ProjectedTurnItem } from "@t3tools/contracts";
+import type {
+ EnvironmentId,
+ OrchestrationV2ProjectedTurnItem,
+ SecretProviderId,
+} from "@t3tools/contracts";
+import { useAtomValue } from "@effect/atom-react";
import { useRef, useState } from "react";
import { View, type ColorValue } from "react-native";
@@ -20,6 +28,7 @@ import { AppText as Text, AppTextInput as TextInput } from "../../components/ui/
import { serverEnvironment } from "../../state/server";
import { useAtomCommand } from "../../state/use-atom-command";
import { Button } from "../../components/ui/Button";
+import { Chip } from "../../components/ui/Chip";
const LOCK_SYMBOL: AppSymbolName = { ios: "lock", android: "lock" };
const PRIVATE_SYMBOL: AppSymbolName = { ios: "checkmark.shield", android: "lock" };
@@ -69,15 +78,18 @@ function PendingSecretRequestForm(props: {
reportFailure: false,
reportDefect: false,
});
+ const config = useAtomValue(serverEnvironment.configValueAtom(props.environmentId));
+ const sources = secretRequestSources(config, config?.settings.secretProviders ?? {});
+ const [sourceId, setSourceId] = useState<SecretProviderId | null>(null);
+ const source = sources.find((candidate) => candidate.id === sourceId) ?? null;
const [secret, setSecret] = useState("");
+ const [reference, setReference] = useState("");
const [submitting, setSubmitting] = useState(false);
const [error, setError] = useState<string | null>(null);
// Submit then a tap can both run before a re-render; this guard is synchronous.
const inFlight = useRef(false);
- const send = async (
- reply: { readonly type: "save"; readonly secret: string } | { readonly type: "decline" },
- ) => {
+ const send = async (reply: SecretRequestReply) => {
const input = secretRequestAnswerInput(item, reply);
if (input === null || inFlight.current) return;
inFlight.current = true;
@@ -89,12 +101,23 @@ function PendingSecretRequestForm(props: {
});
if (result._tag === "Success") {
setSecret("");
+ setReference("");
return;
}
if (!isAtomCommandInterrupted(result)) {
pipe(squashAtomCommandFailure(result), secretRequestFailureMessage, setError);
}
};
+ const save = () => {
+ if (source === null) {
+ void send({ type: "save", secret });
+ } else if (secretRequestReference(source, reference) === undefined) {
+ setError(source.invalidReferenceMessage);
+ } else {
+ void send({ type: "reference", source, reference });
+ }
+ };
+ const draft = source === null ? secret : reference;
return (
<View className="mb-3 gap-3 rounded-[20px] border border-border bg-card-alt p-4">
@@ -106,22 +129,71 @@ function PendingSecretRequestForm(props: {
</Text>
) : null}
</View>
- <TextInput
- accessibilityLabel={item.label}
- placeholder={item.placeholder ?? SECRET_REQUEST_DEFAULT_PLACEHOLDER}
- value={secret}
- onChangeText={setSecret}
- editable={!submitting}
- secureTextEntry
- autoCorrect={false}
- autoCapitalize="none"
- autoComplete="off"
- textContentType="none"
- importantForAutofill="no"
- spellCheck={false}
- returnKeyType="done"
- onSubmitEditing={() => void send({ type: "save", secret })}
- />
+ {sources.length > 0 ? (
+ <View className="flex-row flex-wrap gap-2">
+ <Chip
+ label="Value"
+ size="small"
+ selected={source === null}
+ disabled={submitting}
+ onPress={() => {
+ setSourceId(null);
+ setError(null);
+ }}
+ />
+ {sources.map((candidate) => (
+ <Chip
+ key={candidate.id}
+ label={candidate.label}
+ size="small"
+ selected={candidate.id === source?.id}
+ disabled={submitting}
+ onPress={() => {
+ setSourceId(candidate.id);
+ setError(null);
+ }}
+ />
+ ))}
+ </View>
+ ) : null}
+ {source === null ? (
+ <TextInput
+ accessibilityLabel={item.label}
+ placeholder={item.placeholder ?? SECRET_REQUEST_DEFAULT_PLACEHOLDER}
+ value={secret}
+ onChangeText={setSecret}
+ editable={!submitting}
+ secureTextEntry
+ autoCorrect={false}
+ autoCapitalize="none"
+ autoComplete="off"
+ textContentType="none"
+ importantForAutofill="no"
+ spellCheck={false}
+ returnKeyType="done"
+ onSubmitEditing={save}
+ />
+ ) : (
+ <TextInput
+ key={source.id}
+ accessibilityLabel={`${item.label} reference in ${source.label}`}
+ placeholder={source.referencePlaceholder}
+ value={reference}
+ onChangeText={(next) => {
+ setReference(next);
+ setError(null);
+ }}
+ editable={!submitting}
+ autoCorrect={false}
+ autoCapitalize="none"
+ autoComplete="off"
+ textContentType="none"
+ importantForAutofill="no"
+ spellCheck={false}
+ returnKeyType="done"
+ onSubmitEditing={save}
+ />
+ )}
{error !== null ? (
<Text
accessibilityRole="alert"
@@ -135,8 +207,8 @@ function PendingSecretRequestForm(props: {
label="Save securely"
tone="primary"
fullWidth
- disabled={submitting || secret.trim().length === 0}
- onPress={() => void send({ type: "save", secret })}
+ disabled={submitting || draft.trim().length === 0}
+ onPress={save}
/>
<View className="flex-row items-center justify-between gap-2">
<View className="flex-1 flex-row items-center gap-1.5">
diff --git a/apps/server/src/device/DeviceService.test.ts b/apps/server/src/device/DeviceService.test.ts
index 7e719806c17..9f972cd87bd 100644
--- a/apps/server/src/device/DeviceService.test.ts
+++ b/apps/server/src/device/DeviceService.test.ts
@@ -595,6 +595,7 @@ describe("device setup consent", () => {
});
const layerSecretResolver = Layer.succeed(SecretResolver.SecretResolver, {
+ label: (provider) => Effect.succeed(provider),
read: (references) => Effect.succeed(references.map(() => undefined)),
invalidate: () => Effect.void,
});
diff --git a/apps/server/src/device/EasDeviceHost.test.ts b/apps/server/src/device/EasDeviceHost.test.ts
index 47d74e65b47..3c083cdcbb7 100644
--- a/apps/server/src/device/EasDeviceHost.test.ts
+++ b/apps/server/src/device/EasDeviceHost.test.ts
@@ -231,6 +231,7 @@ const fakeExpo = (
const makeSecretResolver = (values: Record<string, string> = {}) =>
Layer.succeed(SecretResolver.SecretResolver, {
+ label: (provider) => Effect.succeed(provider),
read: (references) =>
Effect.succeed(references.map((reference) => values[reference.reference])),
invalidate: () => Effect.void,
@@ -364,6 +365,7 @@ describe("EAS Simulator host", () => {
Effect.provide(
layerWith(
Layer.succeed(SecretResolver.SecretResolver, {
+ label: (provider) => Effect.succeed(provider),
read: (references) =>
Effect.succeed(references.map(() => (readable.value ? "expo-token" : undefined))),
invalidate: () => Effect.void,
diff --git a/apps/server/src/device/SimlockDeviceHost.test.ts b/apps/server/src/device/SimlockDeviceHost.test.ts
index 6fc5df3e562..cbe494f750a 100644
--- a/apps/server/src/device/SimlockDeviceHost.test.ts
+++ b/apps/server/src/device/SimlockDeviceHost.test.ts
@@ -149,6 +149,7 @@ const makeSecretResolver = (values: Record<string, string> = {}) =>
read: (references) =>
Effect.succeed(references.map((reference) => values[reference.reference])),
invalidate: () => Effect.void,
+ label: (provider) => Effect.succeed(provider),
});
const layerWith = (secrets: Layer.Layer<SecretResolver.SecretResolver>) =>
diff --git a/apps/server/src/mcp/OrchestratorMcpToolkit.integration.test.ts b/apps/server/src/mcp/OrchestratorMcpToolkit.integration.test.ts
index 10a6f3c30c6..5ec8dfd49a1 100644
--- a/apps/server/src/mcp/OrchestratorMcpToolkit.integration.test.ts
+++ b/apps/server/src/mcp/OrchestratorMcpToolkit.integration.test.ts
@@ -36,6 +36,7 @@ import * as ThreadManagementService from "../orchestration-v2/ThreadManagementSe
import * as ServerSettings from "../serverSettings.ts";
import * as SqlitePersistence from "../persistence/Sqlite.ts";
import * as McpProviderSessions from "@t3tools/provider-core/server/McpProviderSessions";
+import * as SecretResolver from "@t3tools/secret-provider-core/server/SecretResolver";
import { checkpointWorkspace } from "@t3tools/provider-testing/replayWorkspace";
import * as ProviderReplayHarness from "../orchestration-v2/testkit/ProviderReplayHarness.ts";
import {
@@ -250,6 +251,7 @@ describe("orchestrator MCP toolkit", () => {
Layer.provideMerge(
SecretRequests.layer.pipe(
Layer.provide(layerMemorySecretStore),
+ Layer.provide(Layer.mock(SecretResolver.SecretResolver)({})),
Layer.provide(layerOrchestration),
),
),
diff --git a/apps/server/src/provider/ProviderInstanceRegistry.test.ts b/apps/server/src/provider/ProviderInstanceRegistry.test.ts
index 14f58c9ffe1..e998332d3e9 100644
--- a/apps/server/src/provider/ProviderInstanceRegistry.test.ts
+++ b/apps/server/src/provider/ProviderInstanceRegistry.test.ts
@@ -845,6 +845,7 @@ describe("ProviderInstanceRegistry secret environment", () => {
};
const gate = Deferred.makeUnsafe<void>();
const resolver = Layer.succeed(SecretResolver.SecretResolver, {
+ label: (provider) => Effect.succeed(provider),
read: (references) =>
Deferred.await(gate).pipe(
Effect.andThen(
diff --git a/apps/server/src/secrets/SecretRequests.test.ts b/apps/server/src/secrets/SecretRequests.test.ts
index c362a1b0ed7..f5f50c5a09a 100644
--- a/apps/server/src/secrets/SecretRequests.test.ts
+++ b/apps/server/src/secrets/SecretRequests.test.ts
@@ -6,10 +6,15 @@ import {
OrchestratorMcpRequestSecretInput,
ProjectId,
type OrchestrationV2ServerCommand,
+ SecretProviderId,
+ SecretProviderKind,
SecretRef,
ThreadId,
TurnItemId,
} from "@t3tools/contracts";
+import { defineSecretProviderDriver } from "@t3tools/secret-provider-core/server/driver";
+import * as SecretResolver from "@t3tools/secret-provider-core/server/SecretResolver";
+import { defineSecretProvider } from "@t3tools/secret-provider-core/shared/definition";
import * as Effect from "effect/Effect";
import * as Exit from "effect/Exit";
import * as FileSystem from "effect/FileSystem";
@@ -32,6 +37,35 @@ const projectId = ProjectId.make("project-1");
const decodeSecretInput = Schema.decodeUnknownEffect(OrchestratorMcpRequestSecretInput);
const decodeSecretInputExit = Schema.decodeUnknownExit(OrchestratorMcpRequestSecretInput);
+const FAKE_KIND = SecretProviderKind.make("fake");
+const vault = SecretProviderId.make("vault");
+/** Reads `fake://` references from `values` while unlocked, as a password manager would. */
+const fakeVault = () => {
+ const state = { unlocked: true, values: new Map([["fake://github/token", "ghp_from_vault"]]) };
+ const driver = defineSecretProviderDriver({
+ kind: FAKE_KIND,
+ definition: defineSecretProvider({
+ kind: FAKE_KIND,
+ label: "Fake",
+ configSchema: Schema.Struct({}),
+ isReference: (reference) => reference.startsWith("fake://"),
+ referencePlaceholder: "fake://item",
+ invalidReferenceMessage: "Use fake://item.",
+ }),
+ read: (_config, references) =>
+ Effect.sync(() =>
+ references.map((reference) => (state.unlocked ? state.values.get(reference) : undefined)),
+ ),
+ });
+ return {
+ state,
+ layer: SecretResolver.layer({
+ drivers: [driver],
+ secretProviders: Effect.succeed({ [vault]: { kind: FAKE_KIND, label: "Vault", config: {} } }),
+ }).pipe(Layer.provide(Layer.merge(NodeServices.layer, NodeCrypto.layer))),
+ };
+};
+
const withService = <A, E>(
body: (input: {
readonly service: SecretRequests.SecretRequests["Service"];
@@ -46,6 +80,7 @@ const withService = <A, E>(
readonly removeFails?: boolean;
readonly closedFirst?: boolean;
readonly failedRecords?: number;
+ readonly resolver?: Layer.Layer<SecretResolver.SecretResolver>;
} = {},
) =>
Effect.gen(function* () {
@@ -57,6 +92,7 @@ const withService = <A, E>(
const layerDependencies = Layer.mergeAll(
NodeCrypto.layer,
NodeServices.layer,
+ options.resolver ?? fakeVault().layer,
Layer.succeed(
ServerSecretStore.ServerSecretStore,
ServerSecretStore.ServerSecretStore.of({
@@ -168,6 +204,76 @@ it.effect("a saved answer becomes a one-use ref, and the thread only learns it w
),
);
+it.effect("a secret provider reference is read once and saved like a typed value", () =>
+ withService(({ service, dispatched }) =>
+ Effect.gen(function* () {
+ yield* service.answer({
+ threadId,
+ turnItemId,
+ answer: {
+ type: "reference",
+ reference: { provider: vault, reference: "fake://github/token" },
+ },
+ });
+ assert.include(dispatched[0] as object, { secretStatus: "saved" });
+ assert.notInclude(JSON.stringify(dispatched), "fake://");
+ const ref = Option.getOrThrow(yield* service.savedRef({ threadId, turnItemId }));
+ assert.equal(yield* service.consume({ ref, projectId }), "ghp_from_vault");
+ }),
+ ),
+);
+
+it.effect(
+ "an unreadable reference leaves the request pending, and a retry after unlocking works",
+ () => {
+ const { state, layer } = fakeVault();
+ state.unlocked = false;
+ return withService(
+ ({ service, stored, dispatched }) =>
+ Effect.gen(function* () {
+ const reference = { provider: vault, reference: "fake://github/token" };
+ const locked = yield* service
+ .answer({ threadId, turnItemId, answer: { type: "reference", reference } })
+ .pipe(Effect.flip);
+ assert.equal(locked.reason, "reference_unreadable");
+ assert.include(locked.message, '"Vault"');
+ assert.deepEqual(dispatched, []);
+ assert.deepEqual(valuesOf(stored), []);
+
+ state.unlocked = true;
+ yield* service.answer({ threadId, turnItemId, answer: { type: "reference", reference } });
+ const ref = Option.getOrThrow(yield* service.savedRef({ threadId, turnItemId }));
+ assert.equal(yield* service.consume({ ref, projectId }), "ghp_from_vault");
+ }),
+ { resolver: layer },
+ );
+ },
+);
+
+it.effect("a reference to a secret provider that is not configured fails", () =>
+ withService(({ service, dispatched }) =>
+ Effect.gen(function* () {
+ const error = yield* service
+ .answer({
+ threadId,
+ turnItemId,
+ answer: {
+ type: "reference",
+ reference: {
+ // Also an Object.prototype key, which must not pass for a configured provider.
+ provider: SecretProviderId.make("constructor"),
+ reference: "fake://github/token",
+ },
+ },
+ })
+ .pipe(Effect.flip);
+ assert.equal(error.reason, "reference_unreadable");
+ assert.include(error.message, '"constructor"');
+ assert.deepEqual(dispatched, []);
+ }),
+ ),
+);
+
it.effect("two concurrent uses of one ref hand the value out once", () =>
withService(({ service }) =>
Effect.gen(function* () {
diff --git a/apps/server/src/secrets/SecretRequests.ts b/apps/server/src/secrets/SecretRequests.ts
index af216a746c0..8fcea230856 100644
--- a/apps/server/src/secrets/SecretRequests.ts
+++ b/apps/server/src/secrets/SecretRequests.ts
@@ -7,9 +7,11 @@ import {
SecretRef,
SecretRequestError,
type ProjectId,
+ type SecretReference,
type SecretRequestAnswerInput,
type ThreadId,
} from "@t3tools/contracts";
+import * as SecretResolver from "@t3tools/secret-provider-core/server/SecretResolver";
import * as Clock from "effect/Clock";
import * as Context from "effect/Context";
@@ -74,6 +76,7 @@ const make = Effect.gen(function* () {
const fileSystem = yield* FileSystem.FileSystem;
const path = yield* Path.Path;
const threadManagement = yield* ThreadManagementService.ThreadManagementService;
+ const resolver = yield* SecretResolver.SecretResolver;
// Beside the store's own files so the same owner-only directory and cleanup rules apply.
const filesDir = store.directory === undefined ? undefined : path.join(store.directory, "files");
@@ -91,6 +94,21 @@ const make = Effect.gen(function* () {
Effect.map((tag) => SecretRef.make(`${SECRET_REF_PREFIX}${Hex.encode(tag).slice(0, 32)}`)),
);
+ const readReference = Effect.fn("SecretRequests.readReference")(function* (
+ reference: SecretReference,
+ ) {
+ // The resolver keeps failed reads for the server's life; a retry after unlocking must re-read.
+ yield* resolver.invalidate([reference]);
+ const [value] = yield* resolver.read([reference]);
+ if (value === undefined || value.trim() === "") {
+ return yield* new SecretRequestError({
+ reason: "reference_unreadable",
+ provider: yield* resolver.label(reference.provider),
+ });
+ }
+ return value;
+ });
+
const answer: SecretRequests["Service"]["answer"] = Effect.fn("SecretRequests.answer")(
function* (input) {
yield* Effect.annotateCurrentSpan({
@@ -114,12 +132,18 @@ const make = Effect.gen(function* () {
if (run === undefined || ThreadManagementService.isTerminalRunStatus(run.status)) {
return yield* new SecretRequestError({ reason: "agent_stopped" });
}
+ const secret =
+ input.answer.type === "save"
+ ? input.answer.secret
+ : input.answer.type === "reference"
+ ? yield* readReference(input.answer.reference)
+ : undefined;
// Create before recording so racing answers cannot overwrite values or show saved before storage.
// Existing values on pending cards finish earlier saves whose recording failed.
- if (input.answer.type === "save") {
+ if (secret !== undefined) {
const encoded = yield* encodeStored({
projectId: records.thread.projectId,
- value: input.answer.secret,
+ value: secret,
savedAt: yield* Clock.currentTimeMillis,
}).pipe(Effect.orDie);
yield* store
@@ -134,7 +158,7 @@ const make = Effect.gen(function* () {
),
);
}
- const secretStatus = input.answer.type === "save" ? "saved" : "declined";
+ const secretStatus = secret === undefined ? "declined" : "saved";
yield* threadManagement
.dispatch({
type: "secret_request.record",
@@ -153,14 +177,14 @@ const make = Effect.gen(function* () {
Effect.mapError((cause) => new SecretRequestError({ reason: "record_failed", cause })),
// Clear failed saves so the pending card can be answered again.
Effect.tapError(() =>
- input.answer.type === "save"
+ secret !== undefined
? refFor(input.threadId, item.id).pipe(
Effect.flatMap((ref) => removeLogged(storeName(ref))),
)
: Effect.void,
),
);
- if (input.answer.type !== "save") return;
+ if (secret === undefined) return;
// The wait may have closed the card; delete unrecorded answers because no one receives their refs.
const recorded = yield* threadManagement
.getThreadRecords(input.threadId, ["turnItems"], {
diff --git a/apps/server/src/secrets/settingsSecretValue.ts b/apps/server/src/secrets/settingsSecretValue.ts
index 6f869531eae..9567ae6ce61 100644
--- a/apps/server/src/secrets/settingsSecretValue.ts
+++ b/apps/server/src/secrets/settingsSecretValue.ts
@@ -41,7 +41,9 @@ export const requireSettingsSecret = Effect.fn("SettingsSecrets.require")(functi
if (!isSecretReference(value)) return value;
const [secret] = yield* resolver.read([value]);
if (secret === undefined || secret.trim() === "") {
- return yield* new SettingsSecretUnresolvedError({ provider: value.provider });
+ return yield* new SettingsSecretUnresolvedError({
+ provider: yield* resolver.label(value.provider),
+ });
}
return secret;
});
diff --git a/apps/server/src/sourceControl/sourceControlHostSecrets.test.ts b/apps/server/src/sourceControl/sourceControlHostSecrets.test.ts
index c3ff7a880de..10a37b631ec 100644
--- a/apps/server/src/sourceControl/sourceControlHostSecrets.test.ts
+++ b/apps/server/src/sourceControl/sourceControlHostSecrets.test.ts
@@ -32,6 +32,7 @@ const hosts = {
function countingResolver() {
const reads: Array<string> = [];
const resolver = SecretResolver.SecretResolver.of({
+ label: (provider) => Effect.succeed(provider),
read: (references) =>
Effect.sync(() =>
references.map((reference) => {
@@ -109,6 +110,7 @@ it.effect("reads a collected reference again once it is invalidated", () =>
let current = "stale";
const cache = new Map<string, string>();
const resolver = SecretResolver.SecretResolver.of({
+ label: (provider) => Effect.succeed(provider),
read: (references) =>
Effect.sync(() =>
references.map((reference) => {
diff --git a/apps/server/src/usage/UsageLimitSources.test.ts b/apps/server/src/usage/UsageLimitSources.test.ts
index 7b078b7b612..274e63b46c9 100644
--- a/apps/server/src/usage/UsageLimitSources.test.ts
+++ b/apps/server/src/usage/UsageLimitSources.test.ts
@@ -39,6 +39,7 @@ it.effect("keeps malformed source URLs encodable for config subscribers", () =>
}).pipe(
Effect.provide([
Layer.succeed(SecretResolver.SecretResolver, {
+ label: (provider) => Effect.succeed(provider),
read: (references) => Effect.succeed(references.map(() => undefined)),
invalidate: () => Effect.void,
}),
@@ -133,6 +134,7 @@ it.effect("reads a management key from its secret provider", () => {
shouldRunScopeWork: () => Effect.succeed(false),
}),
Layer.succeed(SecretResolver.SecretResolver, {
+ label: (provider) => Effect.succeed(provider),
read: (references) =>
Effect.succeed(
references.map((reference) =>
diff --git a/apps/server/src/ws.ts b/apps/server/src/ws.ts
index 98c14b4861d..9816f6c6008 100644
--- a/apps/server/src/ws.ts
+++ b/apps/server/src/ws.ts
@@ -1938,6 +1938,7 @@ export const layerWsRpc = (
threadFindProgressive: true,
secretProviderSettings: true,
secretReferences: true,
+ secretRequestReferences: true,
...Option.match(scratchWorkspaceRoot, {
onNone: () => ({}),
onSome: (root) => ({ scratchWorkspaceRoot: root }),
diff --git a/apps/web/src/components/chat/SecretRequestCard.tsx b/apps/web/src/components/chat/SecretRequestCard.tsx
index bb705f7b1cc..6a78a741557 100644
--- a/apps/web/src/components/chat/SecretRequestCard.tsx
+++ b/apps/web/src/components/chat/SecretRequestCard.tsx
@@ -5,20 +5,31 @@ import {
secretRequestDisplay,
secretRequestFailureMessage,
secretRequestPrivacyNote,
+ secretRequestReference,
+ secretRequestSources,
type SecretRequestItem,
+ type SecretRequestReply,
+ type SecretRequestSource,
} from "@t3tools/client-runtime/secret-request";
import {
isAtomCommandInterrupted,
squashAtomCommandFailure,
} from "@t3tools/client-runtime/state/runtime";
-import type { EnvironmentId, OrchestrationV2ProjectedTurnItem } from "@t3tools/contracts";
+import type {
+ EnvironmentId,
+ OrchestrationV2ProjectedTurnItem,
+ SecretProviderId,
+} from "@t3tools/contracts";
+import { useAtomValue } from "@effect/atom-react";
import { CheckIcon, LockIcon, MinusIcon, ShieldCheckIcon } from "lucide-react";
import { useId, useRef, useState, type FormEvent } from "react";
+import { isSecretsFeatureEnabled } from "../../env";
import { serverEnvironment } from "../../state/server";
import { useAtomCommand } from "../../state/use-atom-command";
import { Button } from "../ui/button";
import { Input } from "../ui/input";
+import { SecretSourceSelect } from "../settings/SecretSourceInput";
import { WorkLogRow } from "./WorkLog";
export function SecretRequestCard(props: {
@@ -50,6 +61,15 @@ export function SecretRequestCard(props: {
return <PendingSecretRequestForm environmentId={props.environmentId} item={item} />;
}
+const NO_SOURCES: ReadonlyArray<SecretRequestSource> = [];
+
+function useSecretRequestSources(environmentId: EnvironmentId) {
+ const config = useAtomValue(serverEnvironment.configValueAtom(environmentId));
+ return isSecretsFeatureEnabled
+ ? secretRequestSources(config, config?.settings.secretProviders ?? {})
+ : NO_SOURCES;
+}
+
function PendingSecretRequestForm(props: {
readonly environmentId: EnvironmentId;
readonly item: SecretRequestItem;
@@ -64,15 +84,17 @@ function PendingSecretRequestForm(props: {
reportFailure: false,
reportDefect: false,
});
+ const sources = useSecretRequestSources(props.environmentId);
+ const [sourceId, setSourceId] = useState<SecretProviderId | null>(null);
+ const source = sources.find((candidate) => candidate.id === sourceId) ?? null;
const [secret, setSecret] = useState("");
+ const [reference, setReference] = useState("");
const [submitting, setSubmitting] = useState(false);
const [error, setError] = useState<string | null>(null);
// Enter and click can both submit before a render.
const inFlight = useRef(false);
- const send = async (
- reply: { readonly type: "save"; readonly secret: string } | { readonly type: "decline" },
- ) => {
+ const send = async (reply: SecretRequestReply) => {
const input = secretRequestAnswerInput(item, reply);
if (input === null || inFlight.current) return;
inFlight.current = true;
@@ -84,6 +106,7 @@ function PendingSecretRequestForm(props: {
});
if (result._tag === "Success") {
setSecret("");
+ setReference("");
return;
}
if (!isAtomCommandInterrupted(result)) {
@@ -93,8 +116,16 @@ function PendingSecretRequestForm(props: {
const onSubmit = (event: FormEvent<HTMLFormElement>) => {
event.preventDefault();
- void send({ type: "save", secret });
+ if (source === null) {
+ void send({ type: "save", secret });
+ } else if (secretRequestReference(source, reference) === undefined) {
+ setError(source.invalidReferenceMessage);
+ } else {
+ void send({ type: "reference", source, reference });
+ }
};
+ const draft = source === null ? secret : reference;
+ const describedBy = error !== null ? `${privacyId} ${errorId}` : privacyId;
return (
<form
@@ -121,27 +152,59 @@ function PendingSecretRequestForm(props: {
) : null}
</div>
<div className="flex min-w-0 items-center gap-2">
- <div className="min-w-0 flex-1">
- <Input
- id={inputId}
- // A CSS-masked text field still exposes its value to screen readers.
- type="password"
- autoComplete="off"
- autoCorrect="off"
- autoCapitalize="off"
- spellCheck={false}
- data-1p-ignore
- data-lpignore="true"
- data-bwignore
- placeholder={item.placeholder ?? SECRET_REQUEST_DEFAULT_PLACEHOLDER}
- value={secret}
+ {sources.length > 0 ? (
+ <SecretSourceSelect
+ value={source?.id ?? null}
+ sources={sources}
+ label={item.label}
disabled={submitting}
- aria-invalid={error !== null || undefined}
- aria-describedby={error !== null ? `${privacyId} ${errorId}` : privacyId}
- onChange={(event) => setSecret(event.currentTarget.value)}
+ onValueChange={(next) => {
+ setSourceId(next);
+ setError(null);
+ }}
/>
+ ) : null}
+ <div className="min-w-0 flex-1">
+ {source === null ? (
+ <Input
+ id={inputId}
+ // A CSS-masked text field still exposes its value to screen readers.
+ type="password"
+ autoComplete="off"
+ autoCorrect="off"
+ autoCapitalize="off"
+ spellCheck={false}
+ data-1p-ignore
+ data-lpignore="true"
+ data-bwignore
+ placeholder={item.placeholder ?? SECRET_REQUEST_DEFAULT_PLACEHOLDER}
+ value={secret}
+ disabled={submitting}
+ aria-invalid={error !== null || undefined}
+ aria-describedby={describedBy}
+ onChange={(event) => setSecret(event.currentTarget.value)}
+ />
+ ) : (
+ <Input
+ id={inputId}
+ font="mono"
+ autoComplete="off"
+ autoCorrect="off"
+ autoCapitalize="off"
+ spellCheck={false}
+ placeholder={source.referencePlaceholder}
+ value={reference}
+ disabled={submitting}
+ aria-invalid={error !== null || undefined}
+ aria-describedby={describedBy}
+ onChange={(event) => {
+ setReference(event.currentTarget.value);
+ setError(null);
+ }}
+ />
+ )}
</div>
- <Button type="submit" disabled={submitting || secret.trim().length === 0}>
+ <Button type="submit" disabled={submitting || draft.trim().length === 0}>
Save securely
</Button>
</div>
diff --git a/apps/web/src/components/settings/SecretSourceInput.tsx b/apps/web/src/components/settings/SecretSourceInput.tsx
index 67053a054db..56723508c85 100644
--- a/apps/web/src/components/settings/SecretSourceInput.tsx
+++ b/apps/web/src/components/settings/SecretSourceInput.tsx
@@ -60,6 +60,57 @@ function SourceLabel(props: {
);
}
+/** Picks Value (`null`) or one of `sources`; a `value` no longer among them stays listed. */
+export function SecretSourceSelect(props: {
+ readonly value: SecretProviderId | null;
+ readonly sources: ReadonlyArray<Pick<SecretSource, "id" | "label">>;
+ readonly label: string;
+ readonly disabled?: boolean;
+ readonly onValueChange: (provider: SecretProviderId | null) => void;
+}) {
+ const { value, sources } = props;
+ const known = value === null || sources.some((source) => source.id === value);
+ const title =
+ value === null ? "Value" : (sources.find((source) => source.id === value)?.label ?? value);
+ return (
+ <Select
+ value={value ?? STORED_VALUE}
+ onValueChange={(next) =>
+ props.onValueChange(
+ next === STORED_VALUE || next === null ? null : (next as SecretProviderId),
+ )
+ }
+ {...(props.disabled === undefined ? {} : { disabled: props.disabled })}
+ >
+ <SelectTrigger
+ size="sm"
+ className="w-auto min-w-0 shrink-0"
+ aria-label={`${props.label} source`}
+ title={title}
+ >
+ <SelectValue>
+ <SourceIcon icon={value === null ? TypeIcon : known ? OnePasswordIcon : KeyRoundIcon} />
+ </SelectValue>
+ </SelectTrigger>
+ <SelectPopup align="start" alignItemWithTrigger={false}>
+ <SelectItem value={STORED_VALUE}>
+ <SourceLabel icon={TypeIcon} label="Value" />
+ </SelectItem>
+ {sources.map((source) => (
+ <SelectItem key={source.id} value={source.id}>
+ <SourceLabel icon={OnePasswordIcon} label={source.label} />
+ </SelectItem>
+ ))}
+ {known ? null : (
+ <SelectItem value={value}>
+ <SourceLabel icon={KeyRoundIcon} label={value} />
+ </SelectItem>
+ )}
+ </SelectPopup>
+ </Select>
+ );
+}
+
type SecretSourceInputProps = Omit<ComponentProps<typeof SecretInput>, "value" | "children"> & {
readonly value: string | SecretReference;
readonly sources: ReadonlyArray<SecretSource>;
@@ -92,54 +143,24 @@ export function SecretSourceInput({
const providerSource = sources.find((source) => source.id === provider);
const definition = providerSource && builtInSecretProviderDefinitions.find(providerSource.kind);
const label = input["aria-label"] ?? "Secret";
- const providerLabel = (id: SecretProviderId) =>
- sources.find((source) => source.id === id)?.label ?? id;
- const providerIcon = (id: SecretProviderId) =>
- sources.some((source) => source.id === id) ? OnePasswordIcon : KeyRoundIcon;
-
const source =
sources.length === 0 && provider === null ? null : (
- <Select
- value={provider ?? STORED_VALUE}
- onValueChange={(value) => {
+ <SecretSourceSelect
+ value={provider}
+ sources={sources}
+ label={label}
+ onValueChange={(next) => {
setRejectedReference(null);
- if (value === STORED_VALUE || value === null) {
+ if (next === null) {
setPendingProvider(null);
onValidityChange?.(true);
if (secret !== undefined) onSecretChange(undefined);
return;
}
- const next = value as SecretProviderId;
onValidityChange?.(next === secret?.provider);
setPendingProvider(next === secret?.provider ? null : next);
}}
- >
- <SelectTrigger
- size="sm"
- className="w-auto min-w-0 shrink-0"
- aria-label={`${label} source`}
- title={provider === null ? "Value" : providerLabel(provider)}
- >
- <SelectValue>
- <SourceIcon icon={provider === null ? TypeIcon : providerIcon(provider)} />
- </SelectValue>
- </SelectTrigger>
- <SelectPopup align="start" alignItemWithTrigger={false}>
- <SelectItem value={STORED_VALUE}>
- <SourceLabel icon={TypeIcon} label="Value" />
- </SelectItem>
- {sources.map((source) => (
- <SelectItem key={source.id} value={source.id}>
- <SourceLabel icon={OnePasswordIcon} label={source.label} />
- </SelectItem>
- ))}
- {provider !== null && !sources.some((source) => source.id === provider) ? (
- <SelectItem value={provider}>
- <SourceLabel icon={KeyRoundIcon} label={provider} />
- </SelectItem>
- ) : null}
- </SelectPopup>
- </Select>
+ />
);
const valueField =
diff --git a/packages/client-runtime/package.json b/packages/client-runtime/package.json
index 851972ce80c..2161dc69c86 100644
--- a/packages/client-runtime/package.json
+++ b/packages/client-runtime/package.json
@@ -552,6 +552,7 @@
"@t3tools/provider-muse": "workspace:*",
"@t3tools/provider-opencode": "workspace:*",
"@t3tools/provider-pi": "workspace:*",
+ "@t3tools/secret-provider-definitions": "workspace:*",
"@t3tools/shared": "workspace:*",
"@t3tools/source-control-core": "workspace:*",
"@t3tools/source-control-definitions": "workspace:*",
diff --git a/packages/client-runtime/src/secretRequest.test.ts b/packages/client-runtime/src/secretRequest.test.ts
index 57d4c4f49a8..6dbe2d2cf22 100644
--- a/packages/client-runtime/src/secretRequest.test.ts
+++ b/packages/client-runtime/src/secretRequest.test.ts
@@ -1,10 +1,18 @@
-import { SecretRequestError } from "@t3tools/contracts";
+import {
+ SecretProviderId,
+ SecretProviderKind,
+ SecretRequestError,
+ ThreadId,
+ TurnItemId,
+} from "@t3tools/contracts";
import { describe, expect, it } from "vite-plus/test";
import {
+ secretRequestAnswerInput,
secretRequestDisplay,
secretRequestFailureMessage,
secretRequestPrivacyNote,
+ secretRequestSources,
} from "./secretRequest.ts";
describe("secretRequestDisplay", () => {
@@ -37,3 +45,46 @@ describe("secretRequestFailureMessage", () => {
expect(secretRequestFailureMessage(undefined)).toBe("Could not answer the request. Try again.");
});
});
+
+describe("secretRequestSources", () => {
+ const onePassword = SecretProviderId.make("1password");
+ const providers = {
+ [onePassword]: {
+ kind: SecretProviderKind.make("one_password"),
+ label: "1Password",
+ config: { account: "my" },
+ },
+ [SecretProviderId.make("later")]: {
+ kind: SecretProviderKind.make("from_a_newer_build"),
+ label: "Later",
+ config: {},
+ },
+ };
+
+ it("offers configured providers only when the server accepts reference answers", () => {
+ expect(secretRequestSources({ secretRequestReferences: true }, providers)).toMatchObject([
+ { id: onePassword, label: "1Password" },
+ ]);
+ expect(secretRequestSources({}, providers)).toEqual([]);
+ expect(secretRequestSources({ secretRequestReferences: true }, {})).toEqual([]);
+ });
+
+ it("answers with a reference only in the provider's syntax", () => {
+ const [source] = secretRequestSources({ secretRequestReferences: true }, providers);
+ if (source === undefined) throw new Error("expected a source");
+ const item = { id: TurnItemId.make("item-1"), threadId: ThreadId.make("thread-1") };
+ expect(
+ secretRequestAnswerInput(item, {
+ type: "reference",
+ source,
+ reference: " op://vault/item/field ",
+ })?.answer,
+ ).toEqual({
+ type: "reference",
+ reference: { provider: onePassword, reference: "op://vault/item/field" },
+ });
+ expect(
+ secretRequestAnswerInput(item, { type: "reference", source, reference: "vault/item" }),
+ ).toBeNull();
+ });
+});
diff --git a/packages/client-runtime/src/secretRequest.ts b/packages/client-runtime/src/secretRequest.ts
index c6ec7ce95f2..d9612411db0 100644
--- a/packages/client-runtime/src/secretRequest.ts
+++ b/packages/client-runtime/src/secretRequest.ts
@@ -1,4 +1,14 @@
-import type { OrchestrationV2TurnItem, SecretRequestAnswerInput } from "@t3tools/contracts";
+import {
+ SecretReference,
+ type OrchestrationV2TurnItem,
+ type SecretProviderId,
+ type SecretRequestAnswerInput,
+ type ServerConfig,
+ type ServerSettings,
+} from "@t3tools/contracts";
+import { builtInSecretProviderDefinitions } from "@t3tools/secret-provider-definitions/registry";
+import * as Option from "effect/Option";
+import * as Schema from "effect/Schema";
export type SecretRequestItem = Extract<
OrchestrationV2TurnItem,
@@ -62,13 +72,83 @@ export function secretRequestDisplay(
}
}
+/** A configured secret provider a pending card can read its answer from. */
+export interface SecretRequestSource {
+ readonly id: SecretProviderId;
+ readonly label: string;
+ readonly isReference: (reference: string) => boolean;
+ readonly referencePlaceholder: string;
+ readonly invalidReferenceMessage: string;
+}
+
+const NO_SOURCES: ReadonlyArray<SecretRequestSource> = [];
+const decodeConfigByKind = new Map(
+ builtInSecretProviderDefinitions.definitions.map((definition) => [
+ definition.kind,
+ Schema.decodeUnknownOption(definition.configSchema),
+ ]),
+);
+
+/** Empty unless the server accepts reference answers; providers this build cannot read are left out. */
+export function secretRequestSources(
+ config: Pick<ServerConfig, "secretRequestReferences"> | null | undefined,
+ providers: ServerSettings["secretProviders"],
+): ReadonlyArray<SecretRequestSource> {
+ if (config?.secretRequestReferences !== true) return NO_SOURCES;
+ return (Object.keys(providers) as Array<SecretProviderId>).flatMap((id) => {
+ const provider = providers[id];
+ const definition =
+ provider === undefined ? undefined : builtInSecretProviderDefinitions.find(provider.kind);
+ if (
+ provider === undefined ||
+ definition === undefined ||
+ decodeConfigByKind.get(definition.kind)?.(provider.config)._tag !== "Some"
+ ) {
+ return [];
+ }
+ return [
+ {
+ id,
+ label: provider.label,
+ isReference: definition.isReference,
+ referencePlaceholder: definition.referencePlaceholder,
+ invalidReferenceMessage: definition.invalidReferenceMessage,
+ },
+ ];
+ });
+}
+
+const decodeSecretReference = Schema.decodeUnknownOption(SecretReference);
+
+/** The reference `text` names, or undefined when it is not `source`'s syntax. */
+export function secretRequestReference(
+ source: SecretRequestSource,
+ text: string,
+): SecretReference | undefined {
+ const decoded = decodeSecretReference({ provider: source.id, reference: text.trim() });
+ return Option.isSome(decoded) && source.isReference(decoded.value.reference)
+ ? decoded.value
+ : undefined;
+}
+
+export type SecretRequestReply =
+ | { readonly type: "save"; readonly secret: string }
+ | { readonly type: "reference"; readonly source: SecretRequestSource; readonly reference: string }
+ | { readonly type: "decline" };
+
export function secretRequestAnswerInput(
item: Pick<SecretRequestItem, "id" | "threadId">,
- answer: { readonly type: "save"; readonly secret: string } | { readonly type: "decline" },
+ answer: SecretRequestReply,
): SecretRequestAnswerInput | null {
if (answer.type === "decline") {
return { threadId: item.threadId, turnItemId: item.id, answer: { type: "decline" } };
}
+ if (answer.type === "reference") {
+ const reference = secretRequestReference(answer.source, answer.reference);
+ return reference === undefined
+ ? null
+ : { threadId: item.threadId, turnItemId: item.id, answer: { type: "reference", reference } };
+ }
const secret = answer.secret.trim();
if (secret.length === 0) return null;
return { threadId: item.threadId, turnItemId: item.id, answer: { type: "save", secret } };
diff --git a/packages/contracts/src/secretRequest.ts b/packages/contracts/src/secretRequest.ts
index b449a17643d..4c74e9fcca3 100644
--- a/packages/contracts/src/secretRequest.ts
+++ b/packages/contracts/src/secretRequest.ts
@@ -1,6 +1,7 @@
import * as Schema from "effect/Schema";
import { ThreadId, TrimmedNonEmptyString, TurnItemId } from "./baseSchemas.ts";
+import { SecretReference } from "./secretReference.ts";
/** Server stores the value under a one-use SecretRef; the thread learns only status. */
export const SecretRequestAnswerInput = Schema.Struct({
@@ -9,6 +10,8 @@ export const SecretRequestAnswerInput = Schema.Struct({
answer: Schema.Union([
Schema.Struct({ type: Schema.Literal("save"), secret: TrimmedNonEmptyString }),
Schema.Struct({ type: Schema.Literal("decline") }),
+ /** Read once through a configured secret provider; only servers advertising `secretRequestReferences` accept it. */
+ Schema.Struct({ type: Schema.Literal("reference"), reference: SecretReference }),
]),
});
export type SecretRequestAnswerInput = typeof SecretRequestAnswerInput.Type;
@@ -29,6 +32,7 @@ const SECRET_REQUEST_FAILURE_MESSAGES = {
already_answered: "This secret request was already answered.",
agent_stopped: "The agent that asked has stopped, so this secret can't be used.",
store_failed: "Could not store the secret.",
+ reference_unreadable: "Could not read the secret from the secret provider.",
record_failed: "Saved the secret, but could not update the request.",
invalid_ref: "That secretRef is not valid.",
read_failed: "Could not read the secret.",
@@ -51,10 +55,15 @@ export class SecretRequestError extends Schema.TaggedError<SecretRequestError>()
"SecretRequestError",
{
reason: SecretRequestFailureReason,
+ /** The secret provider a `reference_unreadable` answer named. */
+ provider: Schema.optionalKey(Schema.String),
cause: Schema.optionalKey(Schema.Defect()),
},
) {
override get message(): string {
+ if (this.reason === "reference_unreadable" && this.provider !== undefined) {
+ return `Could not read the secret from the secret provider "${this.provider}". Unlock it and try again, or enter the value.`;
+ }
return SECRET_REQUEST_FAILURE_MESSAGES[this.reason];
}
}
diff --git a/packages/contracts/src/server.ts b/packages/contracts/src/server.ts
index e027930c116..3d45dfb8731 100644
--- a/packages/contracts/src/server.ts
+++ b/packages/contracts/src/server.ts
@@ -645,6 +645,8 @@ export const ServerConfig = Schema.Struct({
secretProviderSettings: Schema.optionalKey(Schema.Boolean),
/** Secret settings may point at a secret provider; older servers drop the reference. */
secretReferences: Schema.optionalKey(Schema.Boolean),
+ /** A secret request card may be answered with a secret provider reference. */
+ secretRequestReferences: Schema.optionalKey(Schema.Boolean),
scratchWorkspaceRoot: Schema.optionalKey(TrimmedNonEmptyString),
newProjectsRoot: Schema.optionalKey(TrimmedNonEmptyString),
/**
diff --git a/packages/secret-provider-core/src/server/SecretResolver.ts b/packages/secret-provider-core/src/server/SecretResolver.ts
index d7b68c316a8..e3f64dbb010 100644
--- a/packages/secret-provider-core/src/server/SecretResolver.ts
+++ b/packages/secret-provider-core/src/server/SecretResolver.ts
@@ -20,6 +20,8 @@ export class SecretResolver extends Context.Service<
) => Effect.Effect<ReadonlyArray<string | undefined>>;
/** Forgets the given references, or every reference, so the next read asks the provider again. */
readonly invalidate: (references?: ReadonlyArray<SecretReference>) => Effect.Effect<void>;
+ /** The name the user gave a secret provider, or its id when it has none or is gone. */
+ readonly label: (provider: SecretReference["provider"]) => Effect.Effect<string>;
}
>()("@t3tools/secret-provider-core/server/SecretResolver") {}
@@ -137,7 +139,16 @@ export const make = Effect.fn("SecretResolver.make")(function* (options: {
}),
);
- return SecretResolver.of({ read, invalidate });
+ const label: SecretResolver["Service"]["label"] = (provider) =>
+ options.secretProviders.pipe(
+ Effect.map(
+ (providers) =>
+ (Object.hasOwn(providers, provider) ? providers[provider]?.label.trim() : undefined) ||
+ provider,
+ ),
+ );
+
+ return SecretResolver.of({ read, invalidate, label });
});
export const layer = (options: Parameters<typeof make>[0]) =>
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index d1af39291d7..54ba5a504c3 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -1506,6 +1506,9 @@ importers:
'@t3tools/provider-pi':
specifier: workspace:*
version: link:../provider-pi
+ '@t3tools/secret-provider-definitions':
+ specifier: workspace:*
+ version: link:../secret-provider-definitions
'@t3tools/shared':
specifier: workspace:*
version: link:../shared