@devries-cameron20 / t3code-1 / commits / 97e35bcf23
Fork 0

The best way to control Claude Code, Codex and more from any computer or phone

feat(settings): point provider environment variables at a secret provider (#27115)

Co-authored-by: Julius Marminge <51714798+juliusmarminge@users.noreply.github.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>

Yordis Prieto committed Oct 30, 2026 at 02:51 UTC 97e35bcf23e4dcf34c2dcffadd37c08db0e01e52
60 files changed +2094 -181
apps/mobile/src/features/settings/SettingsEnvironmentDetailRouteScreen.tsx
+4 -1
@@ -294,7 +294,10 @@ function EnvironmentDetail({ environmentId }: { readonly environmentId: Environm
294 void run("refresh", async () => {
295 if (!readEnvironmentScope(environmentId, AuthOrchestrationReadScope))
296 return;
297 - const result = await refreshProviders({ environmentId, input: {} });
297 + const result = await refreshProviders({
298 + environmentId,
299 + input: { reloadSecrets: true },
300 + });
301 if (AsyncResult.isFailure(result)) throw squashAtomCommandFailure(result);
302 setNotice("Provider status refreshed.");
303 });
apps/server/package.json
+3
@@ -78,6 +78,9 @@
78 "@opencode-ai/sdk": "^1.3.15",
79 "@t3tools/contracts": "workspace:*",
80 "@t3tools/provider-testing": "workspace:*",
81 + "@t3tools/secret-provider-core": "workspace:*",
82 + "@t3tools/secret-provider-definitions": "workspace:*",
83 + "@t3tools/secret-provider-onepassword": "workspace:*",
84 "@t3tools/shared": "workspace:*",
85 "@t3tools/source-control-testing": "workspace:*",
86 "@t3tools/ssh": "workspace:*",
apps/server/src/auth/RpcAuthorization.test.ts
+23 -1
@@ -5,6 +5,7 @@ import {
5 AuthProvidersManageScope,
6 AuthSettingsWriteScope,
7 DEFAULT_SERVER_SETTINGS,
8 + ProviderDriverKind,
9 ProviderInstanceId,
10 SecretProviderId,
11 ThreadId,
@@ -164,13 +165,34 @@ describe("settings mutation authorization", () => {
165 );
166 yield* client[WS_METHODS.serverUpdateSettings]({ patch: {}, providerInstanceMutation });
167 expect(handled).toBe(1);
168 + yield* client[WS_METHODS.serverUpdateSettings]({
169 + patch: {},
170 + providerInstanceMutation: {
171 + operation: "upsert",
172 + instanceId: ProviderInstanceId.make("codex_work"),
173 + instance: {
174 + driver: ProviderDriverKind.make("codex"),
175 + environment: [
176 + {
177 + name: "OPENAI_API_KEY",
178 + sensitive: true,
179 + value: {
180 + provider: SecretProviderId.make("personal"),
181 + reference: "op://Private/OpenAI/credential",
182 + },
183 + },
184 + ],
185 + },
186 + },
187 + });
188 + expect(handled).toBe(2);
189 expect(
190 yield* client[WS_METHODS.serverUpdateSettings]({
191 patch: { defaultRuntimeMode: "full-access" },
192 providerInstanceMutation,
193 }).pipe(Effect.flip),
194 ).toMatchObject({ requiredPermission: AuthSettingsWriteScope });
173 - expect(handled).toBe(1);
195 + expect(handled).toBe(2);
196 }).pipe(Effect.scoped),
197 );
198
apps/server/src/auth/RpcAuthorization.ts
+2 -1
@@ -228,7 +228,8 @@ const SettingsUpdate = Schema.Struct({
228 patch: ServerSettingsPatch,
229 providerInstanceMutation: Schema.optionalKey(ProviderInstanceMutation),
230 });
231 -const decodeSettingsUpdate = Schema.decodeUnknownSync(SettingsUpdate);
231 +// Middleware receives the payload already decoded, so it is checked against the decoded shape.
232 +const decodeSettingsUpdate = Schema.decodeUnknownSync(Schema.toType(SettingsUpdate));
233
234 const requiredScopesForSettingsUpdate = (payload: unknown) => {
235 const input = decodeSettingsUpdate(payload);
apps/server/src/orchestration-v2/Adapters/ClaudeAdapterV2.test.ts
+2 -2
@@ -40,7 +40,7 @@ import {
40 OrchestrationV2ProviderThread,
41 ProjectId,
42 ProviderInstanceId,
43 - type ProviderInstanceEnvironment,
43 + type ResolvedProviderInstanceEnvironment,
44 ProviderDriverKind,
45 type ProviderReplayTranscript,
46 type ProviderApprovalDecision,
@@ -1189,7 +1189,7 @@ describe("ClaudeAdapterV2 approval cancellation", () => {
1189
1190 const captureSdkExecutablePaths = Effect.fn("captureSdkExecutablePaths")(function* (
1191 binaryPath: string,
1192 - environment: ProviderInstanceEnvironment = [],
1192 + environment: ResolvedProviderInstanceEnvironment = [],
1193 ) {
1194 const executablePaths: Array<string | undefined> = [];
1195 const taskToolEnvironment: Array<string | undefined> = [];
apps/server/src/orchestration-v2/Adapters/PiAdapterV2.testkit.ts
+2 -2
@@ -2,7 +2,7 @@ import * as NodeServices from "@effect/platform-node/NodeServices";
2 import {
3 ProviderReplayEntry,
4 ProviderInstanceId,
5 - type ProviderInstanceEnvironment,
5 + type ResolvedProviderInstanceEnvironment,
6 type ProviderReplayTranscript,
7 type ProviderReplayEntry as ProviderReplayEntryType,
8 } from "@t3tools/contracts";
@@ -363,7 +363,7 @@ export function layer<E, R>(input: {
363 readonly spawner: Layer.Layer<ChildProcessSpawner.ChildProcessSpawner, E, R>;
364 readonly binaryPath: string;
365 readonly launchArgs: string;
366 - readonly environment?: ProviderInstanceEnvironment;
366 + readonly environment?: ResolvedProviderInstanceEnvironment;
367 }) {
368 return ProviderAdapterRegistry.layerFromAdaptersEffect(
369 PiAdapterV2Driver.create({
apps/server/src/project/AgentSessionScanner.ts
+4 -2
@@ -1112,9 +1112,11 @@ export const make = Effect.gen(function* () {
1112 const seenHomes = new Set<string>();
1113 for (const { instanceId, config: instance } of instances) {
1114 const homeVariable = source === "claudeAgent" ? "CLAUDE_CONFIG_DIR" : "CODEX_HOME";
1115 + const configuredHome = instance.environment?.findLast(
1116 + (variable) => variable.name === homeVariable,
1117 + )?.value;
1118 const environmentHome =
1116 - instance.environment?.findLast((variable) => variable.name === homeVariable)?.value ??
1117 - hostEnvironment[homeVariable];
1119 + typeof configuredHome === "string" ? configuredHome : hostEnvironment[homeVariable];
1120
1121 let homePath: string;
1122 if (source === "claudeAgent") {
apps/server/src/provider/ProviderInstanceRegistry.test.ts
+175
@@ -12,16 +12,22 @@ import {
12 type CodexSettings,
13 ProviderDriverKind,
14 type ProviderInstanceConfigMap,
15 + type ResolvedProviderInstanceEnvironment,
16 ProviderInstanceId,
17 + SecretProviderId,
18 + type SecretReference,
19 } from "@t3tools/contracts";
20 import * as ProviderLatestVersions from "@t3tools/provider-core/server/ProviderLatestVersions";
21 import * as McpProviderSessions from "@t3tools/provider-core/server/McpProviderSessions";
22 import * as HostProcess from "@t3tools/shared/HostProcess";
23 import * as DateTime from "effect/DateTime";
24 +import * as Deferred from "effect/Deferred";
25 import * as Effect from "effect/Effect";
26 import * as FileSystem from "effect/FileSystem";
27 import * as Layer from "effect/Layer";
28 import * as Path from "effect/Path";
29 +import * as PubSub from "effect/PubSub";
30 +import * as Schema from "effect/Schema";
31 import * as TestClock from "effect/testing/TestClock";
32 import { HttpClient, HttpClientResponse } from "effect/http";
33
@@ -37,6 +43,8 @@ import { makeProviderInstanceRegistry } from "./ProviderInstanceRegistry.ts";
43 import * as ProviderOrchestrationAdapterInfrastructure from "./ProviderOrchestrationAdapterInfrastructure.ts";
44 import * as PortScanner from "../preview/PortScanner.ts";
45 import * as ProviderHostLive from "./ProviderHostLive.ts";
46 +import * as SecretResolver from "@t3tools/secret-provider-core/server/SecretResolver";
47 +import type { AnyProviderDriver, ProviderInstance } from "@t3tools/provider-core/server/driver";
48
49 vi.mock("@anthropic-ai/claude-agent-sdk", { spy: true });
50
@@ -164,6 +172,7 @@ describe("ProviderInstanceRegistry — multi-instance codex slice", () => {
172 }),
173 ),
174 Layer.provideMerge(Layer.mock(ServerSecretStore.ServerSecretStore)({})),
175 + Layer.provideMerge(Layer.mock(SecretResolver.SecretResolver)({})),
176 Layer.provideMerge(
177 Layer.succeed(ServerEnvironment.ServerEnvironmentIdentity, {
178 getEnvironmentId: Effect.succeed(
@@ -643,3 +652,169 @@ describe("ProviderInstanceRegistry — multi-instance codex slice", () => {
652 }).pipe(Effect.provide(layerTest)),
653 );
654 });
655 +
656 +const DisabledByDefaultConfig = Schema.Struct({
657 + enabled: Schema.Boolean.pipe(Schema.withDecodingDefault(Effect.succeed(false))),
658 +});
659 +
660 +describe("ProviderInstanceRegistry secret environment", () => {
661 + const driverKind = ProviderDriverKind.make("fake");
662 + const instanceId = ProviderInstanceId.make("fake_main");
663 + const secret: SecretReference = {
664 + provider: SecretProviderId.make("personal"),
665 + reference: "op://Private/OpenAI/credential",
666 + };
667 +
668 + function setup(
669 + initial: Record<string, string>,
670 + configSchema: AnyProviderDriver["configSchema"] = Schema.Unknown,
671 + ) {
672 + const vault = new Map(Object.entries(initial));
673 + const reads: Array<ReadonlyArray<string>> = [];
674 + const invalidated: Array<ReadonlyArray<string>> = [];
675 + const created: Array<ResolvedProviderInstanceEnvironment> = [];
676 + const driver: AnyProviderDriver = {
677 + driverKind,
678 + metadata: { displayName: "Fake" },
679 + configSchema,
680 + defaultConfig: () => ({}),
681 + create: (input) =>
682 + Effect.sync(() => {
683 + created.push(input.environment);
684 + return { instanceId: input.instanceId, enabled: input.enabled } as ProviderInstance;
685 + }),
686 + };
687 + const gate = Deferred.makeUnsafe<void>();
688 + const resolver = Layer.succeed(SecretResolver.SecretResolver, {
689 + read: (references) =>
690 + Deferred.await(gate).pipe(
691 + Effect.andThen(
692 + Effect.sync(() => {
693 + reads.push(references.map((reference) => reference.reference));
694 + return references.map((reference) => vault.get(reference.reference));
695 + }),
696 + ),
697 + ),
698 + invalidate: (references = []) =>
699 + Effect.sync(() => {
700 + invalidated.push(references.map((reference) => reference.reference));
701 + }),
702 + });
703 + const configMap: ProviderInstanceConfigMap = {
704 + [instanceId]: {
705 + driver: driverKind,
706 + config: {},
707 + environment: [
708 + { name: "OPENAI_API_KEY", value: secret, sensitive: true },
709 + { name: "BASE_URL", value: "https://example.test", sensitive: false },
710 + ],
711 + },
712 + };
713 + const makeGated = makeProviderInstanceRegistry({ drivers: [driver], configMap }).pipe(
714 + Effect.provide(resolver),
715 + );
716 + // Secrets are read after startup, so wait for the change that applies them.
717 + const make = Effect.gen(function* () {
718 + const built = yield* makeGated;
719 + const changes = yield* built.registry.subscribeChanges;
720 + yield* Deferred.succeed(gate, undefined);
721 + yield* PubSub.take(changes);
722 + return built;
723 + });
724 + return { vault, reads, invalidated, created, make, makeGated, gate };
725 + }
726 +
727 + it.effect("starts an instance with the secret its environment points at", () => {
728 + const fixture = setup({ [secret.reference]: "sk-live" });
729 + return Effect.gen(function* () {
730 + const { registry } = yield* fixture.make;
731 +
732 + expect(yield* registry.getInstance(instanceId)).toBeDefined();
733 + expect(fixture.created).toEqual([
734 + [
735 + { name: "OPENAI_API_KEY", value: "sk-live", sensitive: true },
736 + { name: "BASE_URL", value: "https://example.test", sensitive: false },
737 + ],
738 + ]);
739 + }).pipe(Effect.scoped);
740 + });
741 +
742 + it.effect("marks an instance unavailable and names the variable it could not read", () => {
743 + const fixture = setup({});
744 + return Effect.gen(function* () {
745 + const { registry } = yield* fixture.make;
746 +
747 + expect(yield* registry.getInstance(instanceId)).toBeUndefined();
748 + expect(fixture.created).toEqual([]);
749 + const [unavailable] = yield* registry.listUnavailable;
750 + expect(unavailable?.instanceId).toBe(instanceId);
751 + expect(unavailable?.unavailableReason).toContain("OPENAI_API_KEY");
752 + }).pipe(Effect.scoped);
753 + });
754 +
755 + it.effect("does not read the secrets of an instance its config decodes as disabled", () => {
756 + const fixture = setup({ [secret.reference]: "sk-live" }, DisabledByDefaultConfig);
757 + return Effect.gen(function* () {
758 + const { mutator } = yield* fixture.makeGated;
759 + yield* mutator.reloadSecrets();
760 +
761 + expect(fixture.reads).toEqual([]);
762 + expect(fixture.invalidated).toEqual([]);
763 + expect(fixture.created).toHaveLength(1);
764 + }).pipe(Effect.scoped);
765 + });
766 +
767 + it.effect("re-reads secrets on reload and rebuilds only when they changed", () => {
768 + const fixture = setup({});
769 + return Effect.gen(function* () {
770 + const { registry, mutator } = yield* fixture.make;
771 +
772 + fixture.vault.set(secret.reference, "sk-live");
773 + yield* mutator.reloadSecrets();
774 + expect(fixture.invalidated).toEqual([[secret.reference]]);
775 + expect(yield* registry.getInstance(instanceId)).toBeDefined();
776 + expect(yield* registry.listUnavailable).toEqual([]);
777 +
778 + yield* mutator.reloadSecrets(instanceId);
779 + expect(fixture.created).toHaveLength(1);
780 +
781 + fixture.vault.set(secret.reference, "sk-rotated");
782 + yield* mutator.reloadSecrets(instanceId);
783 + expect(fixture.created.map((environment) => environment[0]?.value)).toEqual([
784 + "sk-live",
785 + "sk-rotated",
786 + ]);
787 + }).pipe(Effect.scoped);
788 + });
789 +
790 + it.effect("keeps a working instance live when a reload cannot read its secret", () => {
791 + const fixture = setup({ [secret.reference]: "sk-live" });
792 + return Effect.gen(function* () {
793 + const { registry, mutator } = yield* fixture.make;
794 +
795 + fixture.vault.delete(secret.reference);
796 + yield* mutator.reloadSecrets();
797 +
798 + expect(yield* registry.getInstance(instanceId)).toBeDefined();
799 + expect(yield* registry.listUnavailable).toEqual([]);
800 + expect(fixture.created).toHaveLength(1);
801 + }).pipe(Effect.scoped);
802 + });
803 +
804 + it.effect("starts without waiting for secrets to be read", () => {
805 + const fixture = setup({ [secret.reference]: "sk-live" });
806 + return Effect.gen(function* () {
807 + const { registry } = yield* fixture.makeGated;
808 + const changes = yield* registry.subscribeChanges;
809 +
810 + expect(yield* registry.getInstance(instanceId)).toBeUndefined();
811 + const [pending] = yield* registry.listUnavailable;
812 + expect(pending?.unavailableReason).toBe("Reading secrets…");
813 +
814 + yield* Deferred.succeed(fixture.gate, undefined);
815 + yield* PubSub.take(changes);
816 + expect(yield* registry.getInstance(instanceId)).toBeDefined();
817 + expect(yield* registry.listUnavailable).toEqual([]);
818 + }).pipe(Effect.scoped);
819 + });
820 +});
apps/server/src/provider/ProviderInstanceRegistry.ts
+188 -13
@@ -3,7 +3,10 @@ import {
3 ProviderInstanceId,
4 type ProviderInstanceConfig,
5 type ProviderInstanceConfigMap,
6 + type ProviderInstanceEnvironment,
7 type ProviderDriverKind,
8 + type ResolvedProviderInstanceEnvironment,
9 + type SecretReference,
10 type ServerProvider,
11 } from "@t3tools/contracts";
12 import * as Context from "effect/Context";
@@ -11,12 +14,16 @@ import * as Effect from "effect/Effect";
14 import * as Equal from "effect/Equal";
15 import * as Exit from "effect/Exit";
16 import * as Layer from "effect/Layer";
17 +import * as Option from "effect/Option";
18 import * as PubSub from "effect/PubSub";
19 import * as Ref from "effect/Ref";
20 import * as Schema from "effect/Schema";
21 import * as Scope from "effect/Scope";
22 +import * as Semaphore from "effect/Semaphore";
23 import * as Stream from "effect/Stream";
24
25 +import * as SecretResolver from "@t3tools/secret-provider-core/server/SecretResolver";
26 +
27 import { buildUnavailableProviderSnapshot } from "./unavailableProviderSnapshot.ts";
28 import * as ProviderInstanceRegistryMutator from "./ProviderInstanceRegistryMutator.ts";
29 import type { AnyProviderDriver, ProviderInstance } from "@t3tools/provider-core/server/driver";
@@ -39,6 +46,7 @@ interface LiveEntry {
46 readonly instance: ProviderInstance;
47 readonly scope: Scope.Closeable;
48 readonly entry: ProviderInstanceConfig;
49 + readonly environment: ResolvedProviderInstanceEnvironment;
50 }
51
52 interface RegistryState {
@@ -50,6 +58,39 @@ interface RegistryState {
58 const entryEqual = (a: ProviderInstanceConfig, b: ProviderInstanceConfig): boolean =>
59 Equal.equals(a, b);
60
61 +const secretReferencesIn = (environment: ProviderInstanceEnvironment): Array<SecretReference> =>
62 + environment.flatMap((variable) => (typeof variable.value === "string" ? [] : [variable.value]));
63 +
64 +const secretReferencesOf = (entry: ProviderInstanceConfig): ReadonlyArray<SecretReference> =>
65 + secretReferencesIn(entry.environment ?? []);
66 +
67 +const withoutSecretReferences = (
68 + environment: ProviderInstanceEnvironment,
69 +): ResolvedProviderInstanceEnvironment =>
70 + environment.flatMap((variable) =>
71 + typeof variable.value === "string" ? [{ ...variable, value: variable.value }] : [],
72 + );
73 +
74 +const readSecretEnvironment = Effect.fn("ProviderInstanceRegistry.readSecretEnvironment")(
75 + function* (environment: ProviderInstanceEnvironment) {
76 + const references = secretReferencesIn(environment);
77 + const values =
78 + references.length === 0 ? [] : yield* (yield* SecretResolver.SecretResolver).read(references);
79 + const unreadable: Array<string> = [];
80 + let index = 0;
81 + const resolved: ResolvedProviderInstanceEnvironment = environment.flatMap((variable) => {
82 + if (typeof variable.value === "string") return [{ ...variable, value: variable.value }];
83 + const secret = values[index++];
84 + if (secret === undefined) {
85 + unreadable.push(variable.name);
86 + return [];
87 + }
88 + return [{ ...variable, value: secret, sensitive: true }];
89 + });
90 + return { environment: resolved, unreadable };
91 + },
92 +);
93 +
94 /** Conflicting saved flags must preserve any explicit disable. */
95 const resolveEntryEnabled = (entry: ProviderInstanceConfig, typedConfig: unknown): boolean => {
96 const rawConfigEnabled = providerInstanceConfigEnabledFlag(entry.config);
@@ -59,19 +100,32 @@ const resolveEntryEnabled = (entry: ProviderInstanceConfig, typedConfig: unknown
100 return entry.enabled ?? providerInstanceConfigEnabledFlag(typedConfig) ?? true;
101 };
102
103 +// The enabled state `buildEntry` decodes, so a disabled instance never reads its secrets.
104 +const isEntryEnabled = Effect.fn("ProviderInstanceRegistry.isEntryEnabled")(function* <R>(
105 + driversById: ReadonlyMap<ProviderDriverKind, AnyProviderDriver<R>>,
106 + entry: ProviderInstanceConfig,
107 +) {
108 + const driver = driversById.get(entry.driver);
109 + if (!driver) return false;
110 + const decoder = Schema.decodeUnknownEffect(driver.configSchema);
111 + const decoded = yield* decoder(entry.config ?? driver.defaultConfig()).pipe(Effect.option);
112 + return Option.isSome(decoded) && resolveEntryEnabled(entry, decoded.value);
113 +});
114 +
115 const buildEntry = Effect.fn("ProviderInstanceRegistry.buildEntry")(function* <R>(input: {
116 readonly driversById: ReadonlyMap<ProviderDriverKind, AnyProviderDriver<R>>;
117 readonly parentScope: Scope.Scope;
118 readonly instanceId: ProviderInstanceId;
119 readonly rawInstanceId: string;
120 readonly entry: ProviderInstanceConfig;
121 + readonly deferSecrets: boolean;
122 }): Effect.fn.Return<
123 | { readonly kind: "live"; readonly live: LiveEntry }
124 | { readonly kind: "unavailable"; readonly snapshot: ServerProvider },
125 never,
72 - R
126 + R | SecretResolver.SecretResolver
127 > {
74 - const { driversById, parentScope, instanceId, rawInstanceId, entry } = input;
128 + const { driversById, parentScope, instanceId, rawInstanceId, entry, deferSecrets } = input;
129 const driver = driversById.get(entry.driver);
130 if (!driver) {
131 return {
@@ -109,6 +163,37 @@ const buildEntry = Effect.fn("ProviderInstanceRegistry.buildEntry")(function* <R
163 }
164
165 const typedConfig = decodeResult.success;
166 + const enabled = resolveEntryEnabled(entry, typedConfig);
167 + if (deferSecrets && enabled && secretReferencesOf(entry).length > 0) {
168 + return {
169 + kind: "unavailable" as const,
170 + snapshot: yield* buildUnavailableProviderSnapshot({
171 + driverKind: entry.driver,
172 + instanceId,
173 + displayName: entry.displayName,
174 + accentColor: entry.accentColor,
175 + reason: "Reading secrets…",
176 + }),
177 + };
178 + }
179 + const { environment, unreadable } = enabled
180 + ? yield* readSecretEnvironment(entry.environment ?? [])
181 + : { environment: withoutSecretReferences(entry.environment ?? []), unreadable: [] };
182 + // Starting with a blank credential would fail later with a less useful error, or fall back to
183 + // whatever the server inherited.
184 + if (unreadable.length > 0) {
185 + return {
186 + kind: "unavailable" as const,
187 + snapshot: yield* buildUnavailableProviderSnapshot({
188 + driverKind: entry.driver,
189 + instanceId,
190 + displayName: entry.displayName,
191 + accentColor: entry.accentColor,
192 + reason: `Could not read ${unreadable.join(", ")} from its secret provider. Unlock it, then refresh.`,
193 + }),
194 + };
195 + }
196 +
197 const childScope = yield* Scope.make();
198 yield* Scope.addFinalizer(parentScope, Scope.close(childScope, Exit.void).pipe(Effect.ignore));
199
@@ -117,8 +202,8 @@ const buildEntry = Effect.fn("ProviderInstanceRegistry.buildEntry")(function* <R
202 instanceId,
203 displayName: entry.displayName,
204 accentColor: entry.accentColor,
120 - environment: entry.environment ?? [],
121 - enabled: resolveEntryEnabled(entry, typedConfig),
205 + environment,
206 + enabled,
207 config: typedConfig,
208 })
209 .pipe(Effect.provideService(Scope.Scope, childScope), Effect.result);
@@ -147,6 +232,7 @@ const buildEntry = Effect.fn("ProviderInstanceRegistry.buildEntry")(function* <R
232 instance: createResult.success,
233 scope: childScope,
234 entry,
235 + environment,
236 },
237 };
238 });
@@ -155,9 +241,13 @@ const makeReconcile = <R>(input: {
241 readonly state: RegistryState;
242 readonly driversById: ReadonlyMap<ProviderDriverKind, AnyProviderDriver<R>>;
243 readonly parentScope: Scope.Scope;
158 -}): ((configMap: ProviderInstanceConfigMap) => Effect.Effect<void, never, R>) => {
244 +}): ((
245 + configMap: ProviderInstanceConfigMap,
246 + rebuild?: ReadonlySet<ProviderInstanceId>,
247 + deferSecrets?: boolean,
248 +) => Effect.Effect<void, never, R | SecretResolver.SecretResolver>) => {
249 const { state, driversById, parentScope } = input;
160 - return (configMap: ProviderInstanceConfigMap) =>
250 + return (configMap, rebuild = new Set(), deferSecrets = false) =>
251 Effect.gen(function* () {
252 const previousEntries = yield* Ref.get(state.entries);
253 const previousUnavailable = yield* Ref.get(state.unavailable);
@@ -175,7 +265,10 @@ const makeReconcile = <R>(input: {
265 continue;
266 }
267 const nextEntry = configMap[instanceId];
178 - if (nextEntry !== undefined && !entryEqual(live.entry, nextEntry)) {
268 + if (
269 + rebuild.has(instanceId) ||
270 + (nextEntry !== undefined && !entryEqual(live.entry, nextEntry))
271 + ) {
272 replacedIds.add(instanceId);
273 }
274 }
@@ -186,6 +279,20 @@ const makeReconcile = <R>(input: {
279 }
280 }
281
282 + // Read every secret the builds below need in one go, so a vault unlocks once.
283 + const references = yield* Effect.forEach(nextRaw, ([rawInstanceId, entry]) =>
284 + Effect.gen(function* () {
285 + const instanceId = ProviderInstanceId.make(rawInstanceId);
286 + const kept = previousEntries.has(instanceId) && !replacedIds.has(instanceId);
287 + return kept || !(yield* isEntryEnabled(driversById, entry))
288 + ? []
289 + : secretReferencesOf(entry);
290 + }),
291 + ).pipe(Effect.map((perEntry) => perEntry.flat()));
292 + if (references.length > 0 && !deferSecrets) {
293 + yield* (yield* SecretResolver.SecretResolver).read(references);
294 + }
295 +
296 const builtEntries = new Map<ProviderInstanceId, LiveEntry>();
297 const builtUnavailable = new Map<ProviderInstanceId, ServerProvider>();
298 let orderChanged = false;
@@ -208,6 +315,7 @@ const makeReconcile = <R>(input: {
315 instanceId,
316 rawInstanceId,
317 entry,
318 + deferSecrets,
319 });
320 if (result.kind === "live") {
321 builtEntries.set(instanceId, result.live);
@@ -260,7 +368,7 @@ export const makeProviderInstanceRegistry = Effect.fn(
368 readonly mutator: ProviderInstanceRegistryMutator.ProviderInstanceRegistryMutatorShape;
369 },
370 never,
263 - R | Scope.Scope
371 + R | SecretResolver.SecretResolver | Scope.Scope
372 > {
373 const driversById = new Map<ProviderDriverKind, AnyProviderDriver<R>>(
374 input.drivers.map((driver) => [driver.driverKind, driver]),
@@ -272,7 +380,7 @@ export const makeProviderInstanceRegistry = Effect.fn(
380 // scopes to the *caller's* scope instead of the registry's.
381 const parentScope = yield* Scope.Scope;
382
275 - const driverContext = yield* Effect.context<R>();
383 + const driverContext = yield* Effect.context<R | SecretResolver.SecretResolver>();
384
385 const entries = yield* Ref.make<ReadonlyMap<ProviderInstanceId, LiveEntry>>(new Map());
386 const unavailable = yield* Ref.make<ReadonlyMap<ProviderInstanceId, ServerProvider>>(new Map());
@@ -281,10 +389,76 @@ export const makeProviderInstanceRegistry = Effect.fn(
389
390 const state: RegistryState = { entries, unavailable, changes };
391 const reconcileWithR = makeReconcile({ state, driversById, parentScope });
392 + const configMapRef = yield* Ref.make(input.configMap);
393 + const semaphore = yield* Semaphore.make(1);
394 const reconcile: ProviderInstanceRegistryMutator.ProviderInstanceRegistryMutatorShape["reconcile"] =
285 - (configMap) => reconcileWithR(configMap).pipe(Effect.provideContext(driverContext));
395 + (configMap) =>
396 + semaphore.withPermits(1)(
397 + Ref.set(configMapRef, configMap).pipe(
398 + Effect.andThen(reconcileWithR(configMap)),
399 + Effect.provideContext(driverContext),
400 + ),
401 + );
402
287 - yield* reconcile(input.configMap);
403 + // Rebuilds an instance only when it was unavailable or its secrets changed, so a refresh does
404 + // not restart providers whose credentials are the same.
405 + const reloadSecrets: ProviderInstanceRegistryMutator.ProviderInstanceRegistryMutatorShape["reloadSecrets"] =
406 + Effect.fn("ProviderInstanceRegistry.reloadSecrets")(
407 + function* (instanceId) {
408 + const configMap = yield* Ref.get(configMapRef);
409 + const targets = yield* Effect.filter(Object.entries(configMap), ([rawInstanceId, entry]) =>
410 + (instanceId === undefined || rawInstanceId === instanceId) &&
411 + secretReferencesOf(entry).length > 0
412 + ? isEntryEnabled(driversById, entry)
413 + : Effect.succeed(false),
414 + );
415 + if (targets.length === 0) return;
416 + const resolver = yield* SecretResolver.SecretResolver;
417 + const references = targets.flatMap(([, entry]) => secretReferencesOf(entry));
418 + yield* resolver.invalidate(references);
419 + yield* resolver.read(references);
420 + const live = yield* Ref.get(entries);
421 + const rebuild = new Set<ProviderInstanceId>();
422 + for (const [rawInstanceId, entry] of targets) {
423 + const current = live.get(ProviderInstanceId.make(rawInstanceId));
424 + if (current === undefined) continue;
425 + const { environment, unreadable } = yield* readSecretEnvironment(entry.environment ?? []);
426 + // A failed re-read keeps the working instance and the value it already holds.
427 + if (unreadable.length === 0 && !Equal.equals(environment, current.environment)) {
428 + rebuild.add(current.instance.instanceId);
429 + }
430 + }
431 + yield* reconcileWithR(configMap, rebuild);
432 + },
433 + (effect) => semaphore.withPermits(1)(effect),
434 + Effect.provideContext(driverContext),
435 + );
436 +
437 + // Reading secrets can wait on a vault unlock, so the server does not wait for it to start.
438 + yield* semaphore.withPermits(1)(
439 + Ref.set(configMapRef, input.configMap).pipe(
440 + Effect.andThen(reconcileWithR(input.configMap, new Set(), true)),
441 + Effect.provideContext(driverContext),
442 + ),
443 + );
444 + const startupReferences = yield* Effect.filter(Object.entries(input.configMap), ([, entry]) =>
445 + secretReferencesOf(entry).length > 0
446 + ? isEntryEnabled(driversById, entry)
447 + : Effect.succeed(false),
448 + ).pipe(Effect.map((targets) => targets.flatMap(([, entry]) => secretReferencesOf(entry))));
449 + if (startupReferences.length > 0) {
450 + // The read waits outside the lock so other mutations are not held for a vault prompt; a
451 + // configuration saved meanwhile has already reconciled itself.
452 + yield* Effect.gen(function* () {
453 + yield* (yield* SecretResolver.SecretResolver).read(startupReferences);
454 + yield* semaphore.withPermits(1)(
455 + Effect.gen(function* () {
456 + const current = yield* Ref.get(configMapRef);
457 + if (current === input.configMap) yield* reconcileWithR(current);
458 + }),
459 + );
460 + }).pipe(Effect.provideContext(driverContext), Effect.forkScoped);
461 + }
462
463 const registry: ProviderInstanceRegistry["Service"] = {
464 getInstance: (id) => Ref.get(entries).pipe(Effect.map((map) => map.get(id)?.instance)),
@@ -307,6 +481,7 @@ export const makeProviderInstanceRegistry = Effect.fn(
481
482 const mutator: ProviderInstanceRegistryMutator.ProviderInstanceRegistryMutatorShape = {
483 reconcile,
484 + reloadSecrets,
485 };
486
487 return { registry, mutator };
@@ -318,7 +493,7 @@ export const layer = <R>(input: {
493 }): Layer.Layer<
494 ProviderInstanceRegistry | ProviderInstanceRegistryMutator.ProviderInstanceRegistryMutator,
495 never,
321 - R
496 + R | SecretResolver.SecretResolver
497 > =>
498 Layer.effectContext(
499 makeProviderInstanceRegistry(input).pipe(
@@ -331,5 +506,5 @@ export const layer = <R>(input: {
506 ) as Layer.Layer<
507 ProviderInstanceRegistry | ProviderInstanceRegistryMutator.ProviderInstanceRegistryMutator,
508 never,
334 - R
509 + R | SecretResolver.SecretResolver
510 >;
apps/server/src/provider/ProviderInstanceRegistryHydration.ts
+9 -2
@@ -9,6 +9,7 @@ import {
9 ServerSettings,
10 } from "@t3tools/contracts";
11 import * as HostProcess from "@t3tools/shared/HostProcess";
12 +import type * as Crypto from "effect/Crypto";
13 import * as Effect from "effect/Effect";
14 import * as FileSystem from "effect/FileSystem";
15 import * as Layer from "effect/Layer";
@@ -16,6 +17,7 @@ import * as Path from "effect/Path";
17 import * as Stream from "effect/Stream";
18
19 import * as Settings from "../serverSettings.ts";
20 +import * as SecretResolver from "../secrets/SecretResolver.ts";
21 import { BUILT_IN_DRIVERS, type BuiltInDriversEnv } from "./builtInDrivers.ts";
22 import * as ProviderInstanceRegistry from "./ProviderInstanceRegistry.ts";
23 import * as ProviderInstanceRegistryMutator from "./ProviderInstanceRegistryMutator.ts";
@@ -39,6 +41,8 @@ type ProviderInstanceRegistryHydrationEnv =
41 | ServerConfig.ServerConfig
42 | Path.Path
43 | FileSystem.FileSystem
44 + // Secret provider reads.
45 + | Crypto.Crypto
46 // The Claude runner counts its CLIs as running agents for port discovery.
47 | PortScanner.PortDiscovery;
48
@@ -141,7 +145,8 @@ const layerSettingsWatcher = (settingsChanges: Stream.Stream<ServerSettings>) =>
145 );
146
147 export const layer: Layer.Layer<
144 - ProviderInstanceRegistry.ProviderInstanceRegistry,
148 + | ProviderInstanceRegistry.ProviderInstanceRegistry
149 + | ProviderInstanceRegistryMutator.ProviderInstanceRegistryMutator,
150 never,
151 ProviderInstanceRegistryHydrationEnv
152 > = Layer.unwrap(
@@ -167,12 +172,14 @@ export const layer: Layer.Layer<
172 Layer.provide(ProviderOrchestrationAdapterInfrastructure.layer),
173 Layer.provide(AcpRegistrySupport.layerFromHost),
174 Layer.provide(ProviderHostLive.layer),
175 + Layer.provide(SecretResolver.layer),
176 );
177
178 return layerSettingsWatcher(settingsChanges).pipe(Layer.provideMerge(layerMutable));
179 }),
180 ) as Layer.Layer<
175 - ProviderInstanceRegistry.ProviderInstanceRegistry,
181 + | ProviderInstanceRegistry.ProviderInstanceRegistry
182 + | ProviderInstanceRegistryMutator.ProviderInstanceRegistryMutator,
183 never,
184 ProviderInstanceRegistryHydrationEnv
185 >;
apps/server/src/provider/ProviderInstanceRegistryMutator.ts
+3 -1
@@ -1,10 +1,12 @@
1 /** Reconcile closes removed/replaced scopes before creating replacements: at most one live instance per id. */
2 -import type { ProviderInstanceConfigMap } from "@t3tools/contracts";
2 +import type { ProviderInstanceConfigMap, ProviderInstanceId } from "@t3tools/contracts";
3 import * as Context from "effect/Context";
4 import type * as Effect from "effect/Effect";
5
6 export interface ProviderInstanceRegistryMutatorShape {
7 readonly reconcile: (configMap: ProviderInstanceConfigMap) => Effect.Effect<void>;
8 + /** Re-reads the secrets of every instance, or one, and rebuilds those whose secrets changed. */
9 + readonly reloadSecrets: (instanceId?: ProviderInstanceId) => Effect.Effect<void>;
10 }
11
12 export class ProviderInstanceRegistryMutator extends Context.Service<
apps/server/src/provider/ProviderRegistry.test.ts
+24 -3
@@ -65,6 +65,7 @@ import type {
65 ProviderWorkspaceSnapshot,
66 } from "@t3tools/provider-core/server/driver";
67 import * as ProviderInstanceRegistry from "./ProviderInstanceRegistry.ts";
68 +import * as ProviderInstanceRegistryMutator from "./ProviderInstanceRegistryMutator.ts";
69 import * as ProviderRegistry from "./ProviderRegistry.ts";
70 import { mergeProviderInstanceEnvironment } from "@t3tools/provider-core/server/instanceEnvironment";
71 import { makeManualOnlyProviderMaintenanceCapabilities } from "@t3tools/provider-core/server/maintenanceResolver";
@@ -100,6 +101,10 @@ const withBundledCompatibility = (snapshot: ServerProvider) =>
101 ModelManifest.BUNDLED_MODEL_MANIFEST.compatibility,
102 );
103
104 +const layerUnusedMutator = Layer.mock(
105 + ProviderInstanceRegistryMutator.ProviderInstanceRegistryMutator,
106 +)({});
107 +
108 const layerTestHttpClient = Layer.succeed(
109 HttpClient.HttpClient,
110 HttpClient.make((request) =>
@@ -944,7 +949,12 @@ it.layer(
949 retainedModels,
950 );
951 }).pipe(
947 - Effect.provide(ProviderRegistry.layer.pipe(Layer.provide(layerInstanceRegistry))),
952 + Effect.provide(
953 + ProviderRegistry.layer.pipe(
954 + Layer.provide(layerInstanceRegistry),
955 + Layer.provide(layerUnusedMutator),
956 + ),
957 + ),
958 Effect.scoped,
959 );
960 }
@@ -1075,7 +1085,12 @@ it.layer(
1085 retainedModels,
1086 );
1087 }).pipe(
1078 - Effect.provide(ProviderRegistry.layer.pipe(Layer.provide(layerInstanceRegistry))),
1088 + Effect.provide(
1089 + ProviderRegistry.layer.pipe(
1090 + Layer.provide(layerInstanceRegistry),
1091 + Layer.provide(layerUnusedMutator),
1092 + ),
1093 + ),
1094 Effect.scoped,
1095 );
1096 }
@@ -1347,6 +1362,7 @@ it.layer(
1362 yield* Effect.addFinalizer(() => Scope.close(scope, Exit.void));
1363 const runtimeServices = yield* Layer.build(
1364 ProviderRegistry.layer.pipe(
1365 + Layer.provide(layerUnusedMutator),
1366 Layer.provideMerge(layerInstanceRegistry),
1367 Layer.provideMerge(
1368 ServerConfig.layerTest(process.cwd(), {
@@ -1442,6 +1458,7 @@ it.layer(
1458 yield* Effect.addFinalizer(() => Scope.close(scope, Exit.void));
1459 const runtimeServices = yield* Layer.build(
1460 ProviderRegistry.layer.pipe(
1461 + Layer.provide(layerUnusedMutator),
1462 Layer.provideMerge(layerInstanceRegistry),
1463 Layer.provideMerge(
1464 ServerConfig.layerTest(process.cwd(), {
@@ -1562,6 +1579,7 @@ it.layer(
1579 yield* Effect.addFinalizer(() => Scope.close(scope, Exit.void));
1580 const runtimeServices = yield* Layer.build(
1581 ProviderRegistry.layer.pipe(
1582 + Layer.provide(layerUnusedMutator),
1583 Layer.provideMerge(instanceRegistryLayer),
1584 Layer.provideMerge(
1585 ServerConfig.layerTest(process.cwd(), {
@@ -1668,6 +1686,7 @@ it.layer(
1686 yield* Effect.addFinalizer(() => Scope.close(scope, Exit.void));
1687 const runtimeServices = yield* Layer.build(
1688 ProviderRegistry.layer.pipe(
1689 + Layer.provide(layerUnusedMutator),
1690 Layer.provideMerge(layerInstanceRegistry),
1691 Layer.provideMerge(
1692 ServerConfig.layerTest(process.cwd(), {
@@ -1796,6 +1815,7 @@ it.layer(
1815 yield* Effect.addFinalizer(() => Scope.close(scope, Exit.void));
1816 const runtimeServices = yield* Layer.build(
1817 ProviderRegistry.layer.pipe(
1818 + Layer.provide(layerUnusedMutator),
1819 Layer.provideMerge(layerInstanceRegistry),
1820 Layer.provideMerge(
1821 ServerConfig.layerTest(process.cwd(), {
@@ -1899,6 +1919,7 @@ it.layer(
1919 yield* Effect.addFinalizer(() => Scope.close(scope, Exit.void));
1920 const runtimeServices = yield* Layer.build(
1921 ProviderRegistry.layer.pipe(
1922 + Layer.provide(layerUnusedMutator),
1923 Layer.provideMerge(layerInstanceRegistry),
1924 Layer.provideMerge(
1925 ServerConfig.layerTest(process.cwd(), {
@@ -2070,7 +2091,7 @@ it.layer(
2091 enabled: false,
2092 config: { arbitrary: "payload" },
2093 },
2073 - } as unknown as ContractServerSettings["providerInstances"],
2094 + } as unknown as (typeof ServerSettings.Encoded)["providerInstances"],
2095 }),
2096 ),
2097 );
apps/server/src/provider/ProviderRegistry.ts
+23 -1
@@ -19,6 +19,7 @@ import * as Option from "effect/Option";
19 import * as Path from "effect/Path";
20 import * as PubSub from "effect/PubSub";
21 import * as Ref from "effect/Ref";
22 +import * as Scope from "effect/Scope";
23 import * as Stream from "effect/Stream";
24 import * as Semaphore from "effect/Semaphore";
25
@@ -27,6 +28,7 @@ import * as ModelManifest from "./ModelManifest.ts";
28 import { applyProviderCompatibility } from "./providerCompatibility.ts";
29 import * as ServerConfig from "../config.ts";
30 import * as ProviderInstanceRegistry from "./ProviderInstanceRegistry.ts";
31 +import * as ProviderInstanceRegistryMutator from "./ProviderInstanceRegistryMutator.ts";
32 import {
33 hydrateCachedProvider,
34 isCachedProviderCorrelated,
@@ -61,6 +63,11 @@ export class ProviderRegistry extends Context.Service<
63 instanceId: ProviderInstanceId,
64 ) => Effect.Effect<ReadonlyArray<ServerProvider>>;
65
66 + /** Re-reads secret-backed environments first, so a fixed secret applies without a restart. */
67 + readonly reloadSecretsAndRefresh: (
68 + instanceId?: ProviderInstanceId,
69 + ) => Effect.Effect<ReadonlyArray<ServerProvider>>;
70 +
71 /** Only refreshed instances can verify an update; the published list still includes every row. */
72 readonly refreshAfterUpdate: (
73 provider: ProviderDriverKind,
@@ -330,6 +337,8 @@ export const layer = Layer.effect(
337 ProviderRegistry,
338 Effect.gen(function* () {
339 const instanceRegistry = yield* ProviderInstanceRegistry.ProviderInstanceRegistry;
340 + const instanceRegistryMutator =
341 + yield* ProviderInstanceRegistryMutator.ProviderInstanceRegistryMutator;
342 const manifestService = yield* ModelManifest.ModelManifest;
343 const latestVersions = yield* ProviderLatestVersions.ProviderLatestVersions;
344 const serviceScope = yield* Effect.scope;
@@ -614,7 +623,9 @@ export const layer = Layer.effect(
623 );
624 if (claimed.owner) {
625 // Detach shared passes so the first caller's interruption cannot cancel other callers' work.
617 - yield* getLiveSources.pipe(
626 + // Syncing first keeps a refresh right after a rebuild from probing the replaced instance.
627 + yield* syncLiveSourcesAndContinue.pipe(
628 + Effect.andThen(getLiveSources),
629 Effect.flatMap((sources) =>
630 Effect.forEach(sources, (source) => refreshOneSource(source), {
631 concurrency: "unbounded",
@@ -651,6 +662,7 @@ export const layer = Layer.effect(
662 const refreshInstance = Effect.fn("refreshInstance")(function* (
663 instanceId: ProviderInstanceId,
664 ) {
665 + yield* syncLiveSourcesAndContinue;
666 const sources = yield* getLiveSources;
667 const providerSource = sources.find((candidate) => candidate.instanceId === instanceId);
668 if (!providerSource) {
@@ -659,6 +671,13 @@ export const layer = Layer.effect(
671 return yield* refreshOneSource(providerSource);
672 });
673
674 + const reloadSecretsAndRefresh = Effect.fn("reloadSecretsAndRefresh")(function* (
675 + instanceId?: ProviderInstanceId,
676 + ) {
677 + yield* instanceRegistryMutator.reloadSecrets(instanceId);
678 + return yield* instanceId === undefined ? refresh() : refreshInstance(instanceId);
679 + });
680 +
681 const refreshAfterUpdate = Effect.fn("refreshAfterUpdate")(function* (
682 provider: ProviderDriverKind,
683 selectedInstanceId: ProviderInstanceId,
@@ -858,6 +877,7 @@ export const layer = Layer.effect(
877 },
878 );
879 }),
880 + Scope.provide(serviceScope),
881 );
882
883 yield* upsertProviders(fallbackProviders, { publish: false });
@@ -1008,6 +1028,8 @@ export const layer = Layer.effect(
1028 refresh(provider).pipe(Effect.catchCause(recoverRefreshFailure)),
1029 refreshInstance: (instanceId: ProviderInstanceId) =>
1030 refreshInstance(instanceId).pipe(Effect.catchCause(recoverRefreshFailure)),
1031 + reloadSecretsAndRefresh: (instanceId?: ProviderInstanceId) =>
1032 + reloadSecretsAndRefresh(instanceId).pipe(Effect.catchCause(recoverRefreshFailure)),
1033 refreshWorkspaceSnapshot: (input) =>
1034 refreshWorkspaceSnapshot(input).pipe(Effect.catchCause(recoverRefreshFailure)),
1035 refreshAfterUpdate,
apps/server/src/provider/providerCompatibility.test.ts
+11 -1
@@ -13,6 +13,7 @@ import * as ModelManifest from "./ModelManifest.ts";
13 import * as ProviderRegistry from "./ProviderRegistry.ts";
14 import * as ProviderLatestVersions from "@t3tools/provider-core/server/ProviderLatestVersions";
15 import * as ProviderInstanceRegistry from "./ProviderInstanceRegistry.ts";
16 +import * as ProviderInstanceRegistryMutator from "./ProviderInstanceRegistryMutator.ts";
17 import type { ProviderInstance } from "@t3tools/provider-core/server/driver";
18 import { makeManualOnlyProviderMaintenanceCapabilities } from "@t3tools/provider-core/server/maintenanceResolver";
19 import * as Schema from "effect/Schema";
@@ -312,6 +313,15 @@ it.effect("a remote policy refresh preserves a newer health result on the regist
313 assert.strictEqual(updated?.compatibilityAdvisory?.status, "supported");
314 assert.strictEqual(updated?.status, "error");
315 assert.strictEqual(updated?.message, "Authentication failed");
315 - }).pipe(Effect.provide(ProviderRegistry.layer.pipe(Layer.provide(layerDependencies))));
316 + }).pipe(
317 + Effect.provide(
318 + ProviderRegistry.layer.pipe(
319 + Layer.provide(layerDependencies),
320 + Layer.provide(
321 + Layer.mock(ProviderInstanceRegistryMutator.ProviderInstanceRegistryMutator)({}),
322 + ),
323 + ),
324 + ),
325 + );
326 }).pipe(Effect.scoped),
327 );
apps/server/src/provider/providerMaintenanceRunner.test.ts
+1
@@ -192,6 +192,7 @@ function makeRegistry(
192 getProviders: Ref.get(providersRef),
193 refresh: () => Ref.get(providersRef),
194 refreshInstance: () => Ref.get(providersRef),
195 + reloadSecretsAndRefresh: () => Ref.get(providersRef),
196 refreshAfterUpdate: () => Ref.get(providersRef),
197 refreshWorkspaceSnapshot: () => Ref.get(providersRef),
198 getProviderMaintenanceCapabilitiesForInstance: (_instanceId, provider) =>
apps/server/src/provider/testUtils/providerRegistryMock.ts
+1
@@ -11,6 +11,7 @@ const makeProviderRegistryMock = (
11 getProviders: Effect.succeed(providers),
12 refresh: () => Effect.succeed(providers),
13 refreshInstance: () => Effect.succeed(providers),
14 + reloadSecretsAndRefresh: () => Effect.succeed(providers),
15 refreshAfterUpdate: () => Effect.succeed(providers),
16 refreshWorkspaceSnapshot: () => Effect.succeed(providers),
17 getProviderMaintenanceCapabilitiesForInstance: (_instanceId, provider) =>
apps/server/src/secrets/SecretResolver.ts new
+20
@@ -0,0 +1,20 @@
1 +import * as SecretResolverCore from "@t3tools/secret-provider-core/server/SecretResolver";
2 +import type { ServerSettings } from "@t3tools/contracts";
3 +import * as Effect from "effect/Effect";
4 +import * as Layer from "effect/Layer";
5 +
6 +import { BUILT_IN_SECRET_PROVIDER_DRIVER_LIST } from "./secretProviderDefinitions.ts";
7 +import * as Settings from "../serverSettings.ts";
8 +
9 +export const layer = Layer.unwrap(
10 + Effect.gen(function* () {
11 + const serverSettings = yield* Settings.ServerSettingsService;
12 + return SecretResolverCore.layer({
13 + drivers: BUILT_IN_SECRET_PROVIDER_DRIVER_LIST,
14 + secretProviders: serverSettings.getSettings.pipe(
15 + Effect.map((settings) => settings.secretProviders),
16 + Effect.orElseSucceed((): ServerSettings["secretProviders"] => ({})),
17 + ),
18 + });
19 + }),
20 +);
apps/server/src/secrets/secretProviderDefinitions.test.ts new
+12
@@ -0,0 +1,12 @@
1 +import { expect, it } from "@effect/vitest";
2 +
3 +import {
4 + BUILT_IN_SECRET_PROVIDER_DRIVER_LIST,
5 + secretProviderDefinitions,
6 +} from "./secretProviderDefinitions.ts";
7 +
8 +it("runs a driver for every secret provider the server and clients read, in their order", () => {
9 + expect(BUILT_IN_SECRET_PROVIDER_DRIVER_LIST.map((driver) => driver.definition)).toEqual(
10 + secretProviderDefinitions.definitions,
11 + );
12 +});
apps/server/src/secrets/secretProviderDefinitions.ts new
+7
@@ -0,0 +1,7 @@
1 +import { builtInSecretProviderDefinitions } from "@t3tools/secret-provider-definitions/registry";
2 +import * as OnePasswordDriver from "@t3tools/secret-provider-onepassword/server/driver";
3 +
4 +/** In the shared registry's order. */
5 +export const BUILT_IN_SECRET_PROVIDER_DRIVER_LIST = [OnePasswordDriver.driver] as const;
6 +
7 +export const secretProviderDefinitions = builtInSecretProviderDefinitions;
apps/server/src/serverSettings.test.ts
+43
@@ -7,7 +7,9 @@ import {
7 ProviderDriverKind,
8 ProviderInstanceId,
9 resolveProviderInstanceEnabled,
10 + SecretProviderId,
11 ServerSettings,
12 + ServerSettingsPatch,
13 UsageLimitSourceId,
14 } from "@t3tools/contracts";
15 import { createModelSelection } from "@t3tools/shared/model";
@@ -33,6 +35,7 @@ import { resolveProviderInstanceTerminalEnvironment } from "./terminal/Manager.t
35
36 const decodeServerSettings = Schema.decodeUnknownEffect(ServerSettings);
37 const decodeServerSettingsJson = Schema.decodeUnknownEffect(Schema.fromJsonString(ServerSettings));
38 +const decodeServerSettingsPatch = Schema.decodeUnknownEffect(ServerSettingsPatch);
39
40 const layerServerSettings = () =>
41 ServerSettingsModule.layer.pipe(
@@ -278,6 +281,25 @@ it.layer(NodeServices.layer)("server settings", (it) => {
281 }),
282 );
283
284 + it.effect("stores no secret provider of an unloaded kind or with a config its kind rejects", () =>
285 + Effect.gen(function* () {
286 + const service = yield* ServerSettingsModule.ServerSettingsService;
287 + const write = (entry: unknown) =>
288 + decodeServerSettingsPatch({ secretProviders: { personal: entry } }).pipe(
289 + Effect.flatMap(service.updateSettings),
290 + Effect.flip,
291 + );
292 + for (const entry of [
293 + { kind: "one_password", label: "Personal", config: { account: "--help" } },
294 + { kind: "one_password", label: "Personal" },
295 + { kind: "openbao", label: "Vault", config: { address: "https://x" } },
296 + ]) {
297 + assert.deepInclude(yield* write(entry), { operation: "write-secret-provider" });
298 + }
299 + assert.deepStrictEqual((yield* service.getSettings).secretProviders, {});
300 + }).pipe(Effect.provide(layerServerSettings())),
301 + );
302 +
303 it.effect("saves through a symlinked settings file without replacing the link", () =>
304 Effect.gen(function* () {
305 const config = yield* ServerConfig.ServerConfig;
@@ -1366,6 +1388,27 @@ it.layer(NodeServices.layer)("server settings", (it) => {
1388 for (const name of secretNames) {
1389 assert.isTrue(Option.isSome(yield* store.get(name)), name);
1390 }
1391 + const secret = {
1392 + provider: SecretProviderId.make("personal"),
1393 + reference: "op://Private/Antigravity/token",
1394 + };
1395 + const referenced = yield* service.updateProviderInstance({
1396 + operation: "upsert",
1397 + instanceId,
1398 + instance: {
1399 + ...client.providerInstances[instanceId]!,
1400 + environment: [
1401 + { name: "API_TOKEN", value: secret, sensitive: true, valueRedacted: true },
1402 + ],
1403 + },
1404 + });
1405 + assert.isTrue(Option.isNone(yield* store.get(secretNames[1]!)));
1406 + assert.deepEqual(
1407 + ServerSettingsModule.redactServerSettingsForClient(referenced).providerInstances[
1408 + instanceId
1409 + ]?.environment,
1410 + [{ name: "API_TOKEN", value: secret, sensitive: true }],
1411 + );
1412 yield* service.updateSettings({
1413 providerInstances: {},
1414 sourceControlHosts: {
apps/server/src/serverSettings.ts
+40 -3
@@ -8,7 +8,6 @@ import {
8 type ProviderInstanceConfig,
9 type ProviderInstanceMutation,
10 defaultInstanceIdForDriver,
11 - isKnownSecretProviderKind,
11 isProviderDriverKind,
12 ProviderDriverKind,
13 ProviderInstanceId,
@@ -53,6 +52,7 @@ import {
52 isModelSelectionProviderEnabled,
53 } from "@t3tools/shared/serverSettings";
54 import * as ServerSecretStore from "./auth/ServerSecretStore.ts";
55 +import { secretProviderDefinitions } from "./secrets/secretProviderDefinitions.ts";
56 import {
57 readSecretFieldValues,
58 sourceControlHostSecretName,
@@ -144,7 +144,7 @@ function withoutUnknownSecretProviderConfigs(
144 ): ServerSettings["secretProviders"] {
145 return Object.fromEntries(
146 Object.entries(settings.secretProviders).map(([id, entry]) => {
147 - if (isKnownSecretProviderKind(entry.kind)) return [id, entry];
147 + if (secretProviderConfigGuards.has(entry.kind)) return [id, entry];
148 const { config: _config, ...envelope } = entry;
149 return [id, envelope];
150 }),
@@ -164,6 +164,40 @@ export function applyProviderInstanceMutation(
164 return { ...settings, providerInstances };
165 }
166
167 +const secretProviderConfigGuards = new Map(
168 + secretProviderDefinitions.definitions.map((definition) => [
169 + definition.kind as string,
170 + Schema.is(definition.configSchema),
171 + ]),
172 +);
173 +
174 +// Rejects a kind this server has not loaded rather than storing a config it cannot check.
175 +function ensureSecretProviderWritesAllowed(
176 + patch: ServerSettingsPatch,
177 + settingsPath: string,
178 +): Effect.Effect<void, ServerSettingsError> {
179 + for (const [id, entry] of Object.entries(patch.secretProviders ?? {})) {
180 + if (entry === null) continue;
181 + const isConfig = secretProviderConfigGuards.get(entry.kind);
182 + const problem =
183 + isConfig === undefined
184 + ? `Unsupported secret provider kind: ${entry.kind}.`
185 + : isConfig(entry.config)
186 + ? undefined
187 + : `Invalid ${entry.kind} config for secret provider ${id}.`;
188 + if (problem !== undefined) {
189 + return Effect.fail(
190 + new ServerSettingsError({
191 + settingsPath,
192 + operation: "write-secret-provider",
193 + cause: new Error(problem),
194 + }),
195 + );
196 + }
197 + }
198 + return Effect.void;
199 +}
200 +
201 function ensureProviderInstanceMutationAllowed(
202 settings: ServerSettings,
203 mutation: ProviderInstanceMutation,
@@ -1185,11 +1219,14 @@ const make = Effect.gen(function* () {
1219 getSettings: getMaterializedSettings,
1220 updateSettings: (patch) =>
1221 updateAndPersistSettings((current) =>
1188 - Effect.succeed(applyServerSettingsPatch(current, patch)),
1222 + ensureSecretProviderWritesAllowed(patch, settingsPath).pipe(
1223 + Effect.as(applyServerSettingsPatch(current, patch)),
1224 + ),
1225 ),
1226 updateProviderInstance: (mutation, patch = {}) =>
1227 updateAndPersistSettings((current) =>
1228 Effect.gen(function* () {
1229 + yield* ensureSecretProviderWritesAllowed(patch, settingsPath);
1230 yield* ensureProviderInstanceMutationAllowed(current, mutation, settingsPath);
1231 const patched = applyServerSettingsPatch(current, patch);
1232 return applyProviderInstanceMutation(patched, mutation);
apps/server/src/settingsSecrets.ts
+6 -3
@@ -99,16 +99,19 @@ export function mapSettingsSecrets(
99 ...(instance.environment
100 ? {
101 environment: instance.environment.map((variable) => {
102 + const { valueRedacted: _omit, ...rest } = variable;
103 + // A secret reference is not itself secret; storage sees the value cleared.
104 + const reference = typeof variable.value === "string" ? undefined : variable.value;
105 const result = map({
106 secretName: `provider-env-${encode(instanceId)}-${encode(variable.name)}`,
107 kind: "environment",
105 - value: variable.value,
106 - redacted: variable.valueRedacted === true,
108 + value: typeof variable.value === "string" ? variable.value : "",
109 + redacted: reference === undefined && variable.valueRedacted === true,
110 sensitive: variable.sensitive,
111 providerInstanceId: instanceId,
112 environmentVariable: variable.name,
113 });
111 - const { valueRedacted: _omit, ...rest } = variable;
114 + if (reference !== undefined) return { ...rest, value: reference };
115 return {
116 ...rest,
117 value: result.value,
apps/server/src/ws.ts
+6 -3
@@ -1793,6 +1793,7 @@ export const layerWsRpc = (
1793 threadFind: true,
1794 threadFindProgressive: true,
1795 secretProviderSettings: true,
1796 + secretReferences: true,
1797 ...Option.match(scratchWorkspaceRoot, {
1798 onNone: () => ({}),
1799 onSome: (root) => ({ scratchWorkspaceRoot: root }),
@@ -2314,9 +2315,11 @@ export const layerWsRpc = (
2315 cwd: input.cwd,
2316 fresh: input.fresh === true,
2317 })
2317 - : input.instanceId !== undefined
2318 - ? providerRegistry.refreshInstance(input.instanceId)
2319 - : providerRegistry.refresh();
2318 + : input.reloadSecrets === true
2319 + ? providerRegistry.reloadSecretsAndRefresh(input.instanceId)
2320 + : input.instanceId !== undefined
2321 + ? providerRegistry.refreshInstance(input.instanceId)
2322 + : providerRegistry.refresh();
2323 if (input.refreshModels) {
2324 const instances = yield* providerInstances.listInstances;
2325 for (const instance of instances) {
apps/web/package.json
+2
@@ -34,6 +34,8 @@
34 "@t3tools/client-runtime": "workspace:*",
35 "@t3tools/contracts": "workspace:*",
36 "@t3tools/provider-core": "workspace:*",
37 + "@t3tools/secret-provider-definitions": "workspace:*",
38 + "@t3tools/secret-provider-onepassword": "workspace:*",
39 "@t3tools/shared": "workspace:*",
40 "@tanstack/react-pacer": "^0.19.4",
41 "@tanstack/react-router": "^1.160.2",
apps/web/src/components/settings/AddProviderInstanceDialog.tsx
+3
@@ -55,6 +55,7 @@ import { resolveOfficialAcpRegistryIconUrl } from "./AcpRegistryIcon";
55 import { AddManagedCodexAccountDialog } from "./CodexSetupSection";
56 import { MultipleAccountsNote } from "./MultipleAccountsNote";
57 import { ProviderEnvironmentSection } from "./ProviderInstanceCard";
58 +import { useSecretSources } from "./SecretSourceInput";
59
60 /** Limit the slug to 48 chars so the composed ProviderInstanceId fits its 64-char cap. */
61 function slugifyLabel(value: string): string {
@@ -160,6 +161,7 @@ export function AddProviderInstanceDialog({
161 onCreated,
162 }: AddProviderInstanceDialogProps) {
163 const settings = useEnvironmentSettings(environmentId);
164 + const secretSources = useSecretSources(environmentId);
165 const persistProviderInstance = usePersistEnvironmentProviderInstanceMutation(environmentId);
166 const canManageProviders = useEnvironmentScope(environmentId, AuthProvidersManageScope);
167
@@ -536,6 +538,7 @@ export function AddProviderInstanceDialog({
538 <ProviderEnvironmentSection
539 environment={localEnvironment}
540 onChange={setLocalEnvironment}
541 + secretSources={secretSources}
542 />
543 ) : null}
544 </SettingsGroup>
apps/web/src/components/settings/ProviderInstanceCard.test.ts
+16 -1
@@ -1,8 +1,9 @@
1 import { describe, expect, it } from "vite-plus/test";
2 -import type { ServerProviderModel } from "@t3tools/contracts";
2 +import { SecretProviderId, type ServerProviderModel } from "@t3tools/contracts";
3
4 import {
5 deriveProviderModelsForDisplay,
6 + nextProviderEnvironmentWithFieldSecret,
7 nextProviderEnvironmentWithFieldValue,
8 } from "./ProviderInstanceCard";
9
@@ -75,6 +76,20 @@ describe("provider environment helpers", () => {
76 ).toEqual([{ name: "CURSOR_API_KEY", value: "new-key", sensitive: true }]);
77 });
78
79 + it("points a stored provider secret at a secret provider and drops the stored value", () => {
80 + const secret = {
81 + provider: SecretProviderId.make("personal"),
82 + reference: "op://Private/Cursor/credential",
83 + };
84 + const stored = [{ name: "CURSOR_API_KEY", value: "", sensitive: true, valueRedacted: true }];
85 + const referenced = nextProviderEnvironmentWithFieldSecret(stored, cursorApiKeyField, secret);
86 +
87 + expect(referenced).toEqual([{ name: "CURSOR_API_KEY", value: secret, sensitive: true }]);
88 + expect(
89 + nextProviderEnvironmentWithFieldSecret(referenced, cursorApiKeyField, undefined),
90 + ).toEqual([]);
91 + });
92 +
93 it("applies the secure field default when replacing an existing non-sensitive value", () => {
94 expect(
95 nextProviderEnvironmentWithFieldValue(
apps/web/src/components/settings/ProviderInstanceCard.tsx
+151 -70
@@ -15,7 +15,7 @@ import {
15 import { Lock as LockGlyph, LockOpen } from "lucide";
16 import * as Arr from "effect/Array";
17 import * as Result from "effect/Result";
18 -import { useState, type ReactElement, type ReactNode } from "react";
18 +import { Fragment, useState, type ReactElement, type ReactNode } from "react";
19 import {
20 isProviderDriverKind,
21 resolveProviderInstanceEnabled,
@@ -26,6 +26,7 @@ import {
26 type EnvironmentId,
27 type ProjectId,
28 type ProviderDriverKind,
29 + type SecretReference,
30 type ServerProvider,
31 type ServerProviderModel,
32 } from "@t3tools/contracts";
@@ -43,7 +44,7 @@ import { Badge } from "../ui/badge";
44 import { Button } from "../ui/button";
45 import { MorphIcon } from "~/components/MorphIcon";
46 import { DraftInput } from "../ui/draft-input";
46 -import { SecretInput } from "./SecretInput";
47 +import { SecretSourceInput, type SecretSource } from "./SecretSourceInput";
48 import { Popover, PopoverPopup, PopoverTrigger } from "../ui/popover";
49 import { Switch } from "../ui/switch";
50 import { stackedThreadToast, toastManager } from "../ui/toast";
@@ -98,7 +99,7 @@ const nextEnvironmentVariableDraftId = () => `provider-env-${environmentVariable
99 type EnvironmentDraftRow = {
100 readonly id: string;
101 readonly name: string;
101 - readonly value: string;
102 + readonly value: ProviderInstanceEnvironmentVariable["value"];
103 readonly sensitive: boolean;
104 readonly valueRedacted?: boolean;
105 };
@@ -119,6 +120,14 @@ function makeEnvironmentDraftRow(
120 const toEnvironmentDraftRows = (environment: ReadonlyArray<ProviderInstanceEnvironmentVariable>) =>
121 environment.map(makeEnvironmentDraftRow);
122
123 +function environmentValuesEqual(
124 + left: ProviderInstanceEnvironmentVariable["value"],
125 + right: ProviderInstanceEnvironmentVariable["value"],
126 +): boolean {
127 + if (typeof left === "string" || typeof right === "string") return left === right;
128 + return left.provider === right.provider && left.reference === right.reference;
129 +}
130 +
131 function providerEnvironmentsEqual(
132 left: ReadonlyArray<ProviderInstanceEnvironmentVariable>,
133 right: ReadonlyArray<ProviderInstanceEnvironmentVariable>,
@@ -130,7 +139,7 @@ function providerEnvironmentsEqual(
139 return (
140 other !== undefined &&
141 variable.name === other.name &&
133 - variable.value === other.value &&
142 + environmentValuesEqual(variable.value, other.value) &&
143 variable.sensitive === other.sensitive &&
144 variable.valueRedacted === other.valueRedacted
145 );
@@ -247,12 +256,28 @@ export function nextProviderEnvironmentWithFieldValue(
256 return next;
257 }
258
259 +export function nextProviderEnvironmentWithFieldSecret(
260 + environment: ReadonlyArray<ProviderInstanceEnvironmentVariable> | undefined,
261 + field: ProviderEnvironmentField,
262 + secret: SecretReference | undefined,
263 +): ReadonlyArray<ProviderInstanceEnvironmentVariable> {
264 + const others = providerEnvironmentWithoutNames(environment, new Set([field.name]));
265 + return secret === undefined
266 + ? others
267 + : [...others, { name: field.name, value: secret, sensitive: true }];
268 +}
269 +
270 function ProviderEnvironmentFieldRow(props: {
271 readonly field: ProviderEnvironmentField;
272 readonly variable: ProviderInstanceEnvironmentVariable | undefined;
273 readonly idPrefix: string;
274 readonly onCommit: (field: ProviderEnvironmentField, value: string) => void;
275 + readonly onSecretChange: (
276 + field: ProviderEnvironmentField,
277 + secret: SecretReference | undefined,
278 + ) => void;
279 readonly onRemove: (field: ProviderEnvironmentField) => void;
280 + readonly secretSources: ReadonlyArray<SecretSource>;
281 }) {
282 const inputId = `${props.idPrefix}-environment-${props.field.name}`;
283 const value = props.variable?.valueRedacted ? "" : (props.variable?.value ?? "");
@@ -269,13 +294,13 @@ function ProviderEnvironmentFieldRow(props: {
294 size="sm"
295 className="min-w-0 flex-1"
296 autoComplete="off"
272 - value={value}
297 + value={typeof value === "string" ? value : ""}
298 onCommit={(next) => props.onCommit(props.field, next)}
299 placeholder={props.field.placeholder}
300 spellCheck={false}
301 />
302 ) : (
278 - <SecretInput
303 + <SecretSourceInput
304 id={inputId}
305 size="sm"
306 className="min-w-0 flex-1"
@@ -284,6 +309,9 @@ function ProviderEnvironmentFieldRow(props: {
309 placeholder={props.field.placeholder}
310 configured={props.variable?.valueRedacted === true}
311 spellCheck={false}
312 + aria-label={props.field.label}
313 + sources={props.secretSources}
314 + onSecretChange={(secret) => props.onSecretChange(props.field, secret)}
315 />
316 )}
317 {props.variable ? (
@@ -306,6 +334,7 @@ function ProviderEnvironmentFieldRow(props: {
334 export function ProviderEnvironmentSection(props: {
335 readonly environment: ReadonlyArray<ProviderInstanceEnvironmentVariable>;
336 readonly onChange: (environment: ReadonlyArray<ProviderInstanceEnvironmentVariable>) => void;
337 + readonly secretSources?: ReadonlyArray<SecretSource>;
338 }) {
339 const [storedDraft, setDraft] = useState(() =>
340 seedRowsDraft(props.environment, toEnvironmentDraftRows),
@@ -328,7 +357,7 @@ export function ProviderEnvironmentSection(props: {
357 if (!ENVIRONMENT_VARIABLE_NAME_PATTERN.test(name)) {
358 if (
359 name.length > 0 ||
331 - row.value.length > 0 ||
360 + row.value !== "" ||
361 row.sensitive !== true ||
362 row.valueRedacted !== undefined
363 ) {
@@ -357,6 +386,16 @@ export function ProviderEnvironmentSection(props: {
386 publishRows(nextRows);
387 };
388
389 + const setVariableSecret = (id: string, secret: SecretReference | undefined) => {
390 + const nextRows = rows.map((row) => {
391 + if (row.id !== id) return row;
392 + const { valueRedacted: _valueRedacted, ...rest } = row;
393 + return { ...rest, value: secret ?? "" };
394 + });
395 + setRows(nextRows);
396 + publishRows(nextRows);
397 + };
398 +
399 const removeVariable = (id: string) => {
400 const nextRows = rows.filter((row) => row.id !== id);
401 setRows(nextRows);
@@ -387,76 +426,20 @@ export function ProviderEnvironmentSection(props: {
426 >
427 {rows.length > 0 ? (
428 <div className="mt-3 min-w-0 space-y-2 pb-2">
390 - {rows.map((variable, index) => (
391 - <div key={variable.id} className="flex min-w-0 flex-wrap items-center gap-1.5">
429 + {rows.map((variable, index) => {
430 + const nameInput = (
431 <DraftInput
432 size="sm"
433 font="mono"
395 - className="w-full min-w-0 sm:w-44 sm:shrink-0"
434 + className="min-w-0 flex-1"
435 value={variable.name}
436 onCommit={(name) => updateVariable(variable.id, { name: name.trim() })}
437 placeholder="VARIABLE_NAME"
438 spellCheck={false}
439 aria-label={`Environment variable name ${index + 1}`}
440 />
402 - <span className="hidden text-xs text-muted-foreground sm:inline" aria-hidden>
403 - =
404 - </span>
405 - {variable.sensitive ? (
406 - <SecretInput
407 - size="sm"
408 - font="mono"
409 - className="min-w-0 flex-1"
410 - value={variable.valueRedacted ? "" : variable.value}
411 - onCommit={(value) => updateVariable(variable.id, { value })}
412 - placeholder="value"
413 - configured={variable.valueRedacted === true}
414 - spellCheck={false}
415 - aria-label={`Environment variable value ${index + 1}`}
416 - />
417 - ) : (
418 - <DraftInput
419 - size="sm"
420 - font="mono"
421 - className="min-w-0 flex-1"
422 - value={variable.valueRedacted ? "" : variable.value}
423 - onCommit={(value) => updateVariable(variable.id, { value })}
424 - autoComplete="off"
425 - placeholder="value"
426 - spellCheck={false}
427 - aria-label={`Environment variable value ${index + 1}`}
428 - />
429 - )}
430 - <Tooltip>
431 - <TooltipTrigger
432 - render={
433 - <Button
434 - type="button"
435 - size="icon-micro"
436 - variant="ghost-muted"
437 - onClick={() => {
438 - const sensitive = !variable.sensitive;
439 - updateVariable(variable.id, {
440 - sensitive,
441 - ...(sensitive && variable.valueRedacted === undefined
442 - ? {}
443 - : { valueRedacted: sensitive ? variable.valueRedacted : false }),
444 - });
445 - }}
446 - aria-pressed={variable.sensitive}
447 - aria-label={`Mark environment variable ${variable.name || index + 1} as sensitive`}
448 - >
449 - <MorphIcon
450 - className="size-3"
451 - icon={variable.sensitive ? LockGlyph : LockOpen}
452 - />
453 - </Button>
454 - }
455 - />
456 - <TooltipPopup side="top">
457 - {variable.sensitive ? "Sensitive, stored separately" : "Plain text"}
458 - </TooltipPopup>
459 - </Tooltip>
441 + );
442 + const removeButton = (
443 <Button
444 type="button"
445 size="icon-micro"
@@ -466,8 +449,94 @@ export function ProviderEnvironmentSection(props: {
449 >
450 <XIcon className="size-3" />
451 </Button>
469 - </div>
470 - ))}
452 + );
453 + const sensitiveToggle =
454 + typeof variable.value === "string" ? (
455 + <Tooltip>
456 + <TooltipTrigger
457 + render={
458 + <Button
459 + type="button"
460 + size="icon-micro"
461 + variant="ghost-muted"
462 + onClick={() => {
463 + const sensitive = !variable.sensitive;
464 + updateVariable(variable.id, {
465 + sensitive,
466 + ...(sensitive && variable.valueRedacted === undefined
467 + ? {}
468 + : { valueRedacted: sensitive ? variable.valueRedacted : false }),
469 + });
470 + }}
471 + aria-pressed={variable.sensitive}
472 + aria-label={`Mark environment variable ${variable.name || index + 1} as sensitive`}
473 + >
474 + <MorphIcon
475 + className="size-3"
476 + icon={variable.sensitive ? LockGlyph : LockOpen}
477 + />
478 + </Button>
479 + }
480 + />
481 + <TooltipPopup side="top">
482 + {variable.sensitive ? "Sensitive, stored separately" : "Plain text"}
483 + </TooltipPopup>
484 + </Tooltip>
485 + ) : null;
486 + const layout = (source: ReactNode, value: ReactNode) => (
487 + <div className="flex min-w-0 flex-col gap-1.5 rounded-lg border p-2">
488 + <div className="flex min-w-0 items-center gap-1.5">
489 + {nameInput}
490 + {source === null ? null : <div className="w-48 shrink-0">{source}</div>}
491 + {removeButton}
492 + </div>
493 + <div className="flex min-w-0 items-start gap-1.5">
494 + {value}
495 + {sensitiveToggle}
496 + </div>
497 + </div>
498 + );
499 + return (
500 + <Fragment key={variable.id}>
501 + {variable.sensitive ? (
502 + <SecretSourceInput
503 + size="sm"
504 + font="mono"
505 + className="min-w-0 flex-1"
506 + value={variable.valueRedacted ? "" : variable.value}
507 + onCommit={(value) => updateVariable(variable.id, { value })}
508 + placeholder="value"
509 + configured={variable.valueRedacted === true}
510 + spellCheck={false}
511 + aria-label={`Environment variable value ${index + 1}`}
512 + sources={props.secretSources ?? []}
513 + onSecretChange={(secret) => setVariableSecret(variable.id, secret)}
514 + >
515 + {(parts) => layout(parts.source, parts.value)}
516 + </SecretSourceInput>
517 + ) : (
518 + layout(
519 + null,
520 + <DraftInput
521 + size="sm"
522 + font="mono"
523 + className="min-w-0 flex-1"
524 + value={
525 + variable.valueRedacted || typeof variable.value !== "string"
526 + ? ""
527 + : variable.value
528 + }
529 + onCommit={(value) => updateVariable(variable.id, { value })}
530 + autoComplete="off"
531 + placeholder="value"
532 + spellCheck={false}
533 + aria-label={`Environment variable value ${index + 1}`}
534 + />,
535 + )
536 + )}
537 + </Fragment>
538 + );
539 + })}
540 <p className="text-xs text-muted-foreground">
541 Sensitive values are stored separately and never returned to the app.
542 </p>
@@ -584,6 +653,7 @@ interface ProviderInstanceCardProps {
653 readonly isUpdating?: boolean | undefined;
654 readonly onAcceptUrlAuth?: ((action: AcpRegistryUrlAuthAction) => void) | undefined;
655 readonly environmentId?: EnvironmentId | undefined;
656 + readonly secretSources?: ReadonlyArray<SecretSource>;
657 readonly projectOverride?: ProjectOverrideControl | undefined;
658 readonly acpProjects?:
659 | ReadonlyArray<{
@@ -595,6 +665,7 @@ interface ProviderInstanceCardProps {
665 }
666
667 const EMPTY_ACP_PROJECTS: NonNullable<ProviderInstanceCardProps["acpProjects"]> = [];
668 +const NO_SECRET_SOURCES: ReadonlyArray<SecretSource> = [];
669 const NO_CUSTOM_MODELS: ReadonlyArray<CustomModelDefinition> = [];
670
671 /** Unknown drivers stay read-only to preserve fork config. projectOverride switches affect only the
@@ -627,6 +698,7 @@ export function ProviderInstanceCard({
698 onAcceptUrlAuth,
699 environmentId,
700 acpProjects = EMPTY_ACP_PROJECTS,
701 + secretSources = NO_SECRET_SOURCES,
702 projectOverride,
703 }: ProviderInstanceCardProps) {
704 const enabled = projectOverride?.effectiveEnabled ?? resolveProviderInstanceEnabled(instance);
@@ -781,6 +853,12 @@ export function ProviderInstanceCard({
853 const updateEnvironmentField = (field: ProviderEnvironmentField, value: string) => {
854 updateEnvironment(nextProviderEnvironmentWithFieldValue(instance.environment, field, value));
855 };
856 + const updateEnvironmentFieldSecret = (
857 + field: ProviderEnvironmentField,
858 + secret: SecretReference | undefined,
859 + ) => {
860 + updateEnvironment(nextProviderEnvironmentWithFieldSecret(instance.environment, field, secret));
861 + };
862 const removeEnvironmentField = (field: ProviderEnvironmentField) => {
863 updateEnvironment(providerEnvironmentWithoutNames(instance.environment, new Set([field.name])));
864 };
@@ -1182,7 +1260,9 @@ export function ProviderInstanceCard({
1260 variable={readProviderEnvironmentVariable(instance.environment, field.name)}
1261 idPrefix={`provider-instance-${instanceId}`}
1262 onCommit={updateEnvironmentField}
1263 + onSecretChange={updateEnvironmentFieldSecret}
1264 onRemove={removeEnvironmentField}
1265 + secretSources={secretSources}
1266 />
1267 ))}
1268 </div>
@@ -1225,6 +1305,7 @@ export function ProviderInstanceCard({
1305 <ProviderEnvironmentSection
1306 environment={genericEnvironment}
1307 onChange={updateGenericEnvironment}
1308 + secretSources={secretSources}
1309 />
1310 </SettingsSection>
1311 {environmentId !== undefined && liveProvider?.driver === "acpRegistry" ? (
apps/web/src/components/settings/ProviderSettingsPanel.tsx
+4 -1
@@ -98,6 +98,7 @@ import { stackedThreadToast, toastManager } from "../ui/toast";
98 import { AddProviderInstanceDialog } from "./AddProviderInstanceDialog";
99 import { ExpandableText } from "./ExpandableText";
100 import { ProviderInstanceCard } from "./ProviderInstanceCard";
101 +import { useSecretSources } from "./SecretSourceInput";
102 import { UsageProviderSettings } from "./UsageProviderSettings";
103 import { ProviderSetupSection, readAntigravityAuthMethod } from "./ProviderSetupSection";
104 import { ProviderAuthenticationSection } from "./ProviderAuthenticationSection";
@@ -635,7 +636,7 @@ export function EnvironmentProviderSettings({
636 void (async () => {
637 const result = await refreshServerProviders({
638 environmentId,
638 - input: { refreshModels: true },
639 + input: { refreshModels: true, reloadSecrets: true },
640 });
641 refreshingRef.current = false;
642 setIsRefreshingProviders(false);
@@ -1247,6 +1248,7 @@ function ProviderInstanceRow({
1248 readonly actions: ProviderInstanceRowActions;
1249 }) {
1250 const allProjects = useProjects();
1251 + const secretSources = useSecretSources(environmentId);
1252 const acpProjects =
1253 mode === "editor" && liveProvider?.driver === "acpRegistry"
1254 ? allProjects.filter((project) => project.environmentId === environmentId)
@@ -1285,6 +1287,7 @@ function ProviderInstanceRow({
1287 return (
1288 <ProviderInstanceCard
1289 environmentId={environmentId}
1290 + secretSources={secretSources}
1291 acpProjects={acpProjects}
1292 projectOverride={projectOverride}
1293 onAcceptUrlAuth={
apps/web/src/components/settings/SecretProviderDialog.logic.ts
+4 -2
@@ -1,11 +1,13 @@
1 import {
2 - OnePasswordSecretProviderConfig,
2 SecretProviderId,
3 SecretProviderKind,
4 SecretProviderLabel,
6 - type OnePasswordAccount,
5 type SecretProviderConfig,
6 } from "@t3tools/contracts";
7 +import {
8 + OnePasswordSecretProviderConfig,
9 + type OnePasswordAccount,
10 +} from "@t3tools/secret-provider-onepassword/shared/definition";
11 import * as Option from "effect/Option";
12 import * as Result from "effect/Result";
13 import * as Schema from "effect/Schema";
apps/web/src/components/settings/SecretSourceInput.browser.test.tsx new
+82
@@ -0,0 +1,82 @@
1 +import { SecretProviderId, SecretProviderKind } from "@t3tools/contracts";
2 +import { describe, expect, it, vi } from "vite-plus/test";
3 +import { userEvent } from "vite-plus/test/browser";
4 +
5 +import { render, type Screen } from "../../../test/render";
6 +import { SecretSourceInput } from "./SecretSourceInput";
7 +
8 +const personal = SecretProviderId.make("personal");
9 +const work = SecretProviderId.make("work");
10 +const sources = [
11 + { id: personal, kind: SecretProviderKind.make("one_password"), label: "Personal" },
12 + { id: work, kind: SecretProviderKind.make("one_password"), label: "Work" },
13 +];
14 +
15 +const reference = (screen: Screen) => screen.getByRole("textbox", { name: "API key reference" });
16 +
17 +async function commitReference(screen: Screen, value: string) {
18 + await userEvent.clear(reference(screen));
19 + await userEvent.type(reference(screen), value);
20 + await userEvent.keyboard("{Enter}");
21 +}
22 +
23 +describe("SecretSourceInput", () => {
24 + it("moves a reference to another provider only once one is committed for it", async () => {
25 + const onSecretChange = vi.fn();
26 + await using screen = await render(
27 + <SecretSourceInput
28 + aria-label="API key"
29 + value={{ provider: personal, reference: "op://Private/OpenAI/credential" }}
30 + sources={sources}
31 + onCommit={() => {}}
32 + onSecretChange={onSecretChange}
33 + />,
34 + );
35 +
36 + await userEvent.click(screen.getByRole("combobox", { name: "API key source" }));
37 + await userEvent.click(screen.getByRole("option", { name: "Work" }));
38 + expect(onSecretChange).not.toHaveBeenCalled();
39 + await expect.element(reference(screen)).toHaveValue("");
40 +
41 + await commitReference(screen, "op://Shared/OpenAI/credential");
42 + expect(onSecretChange).toHaveBeenCalledExactlyOnceWith({
43 + provider: work,
44 + reference: "op://Shared/OpenAI/credential",
45 + });
46 + });
47 +
48 + it("removes the reference when its field is cleared", async () => {
49 + const onSecretChange = vi.fn();
50 + await using screen = await render(
51 + <SecretSourceInput
52 + aria-label="API key"
53 + value={{ provider: personal, reference: "op://Private/OpenAI/credential" }}
54 + sources={sources}
55 + onCommit={() => {}}
56 + onSecretChange={onSecretChange}
57 + />,
58 + );
59 +
60 + await userEvent.clear(reference(screen));
61 + await userEvent.keyboard("{Enter}");
62 + expect(onSecretChange).toHaveBeenCalledExactlyOnceWith(undefined);
63 + });
64 +
65 + it("rejects a reference 1Password cannot read", async () => {
66 + const onSecretChange = vi.fn();
67 + await using screen = await render(
68 + <SecretSourceInput
69 + aria-label="API key"
70 + value={{ provider: personal, reference: "op://Private/OpenAI/credential" }}
71 + sources={sources}
72 + onCommit={() => {}}
73 + onSecretChange={onSecretChange}
74 + />,
75 + );
76 +
77 + await commitReference(screen, "Private/OpenAI/credential");
78 + expect(onSecretChange).not.toHaveBeenCalled();
79 + await expect.element(reference(screen)).toHaveAttribute("aria-invalid", "true");
80 + await expect.element(reference(screen)).toHaveValue("Private/OpenAI/credential");
81 + });
82 +});
apps/web/src/components/settings/SecretSourceInput.tsx new
+185
@@ -0,0 +1,185 @@
1 +import {
2 + SecretReference,
3 + type EnvironmentId,
4 + type SecretProviderConfig,
5 + type SecretProviderId,
6 + type SecretProviderKind,
7 +} from "@t3tools/contracts";
8 +import { builtInSecretProviderDefinitions } from "@t3tools/secret-provider-definitions/registry";
9 +import { useAtomValue } from "@effect/atom-react";
10 +import * as Option from "effect/Option";
11 +import * as Schema from "effect/Schema";
12 +import { KeyRoundIcon, TypeIcon } from "lucide-react";
13 +import { useState, type ComponentProps, type ComponentType, type ReactNode } from "react";
14 +
15 +import { isSecretsFeatureEnabled } from "../../env";
16 +import { useEnvironmentSettings } from "../../hooks/useSettings";
17 +import { OnePasswordIcon } from "../Icons";
18 +import { serverEnvironment } from "../../state/server";
19 +import { DraftInput } from "../ui/draft-input";
20 +import { Select, SelectItem, SelectPopup, SelectTrigger, SelectValue } from "../ui/select";
21 +import { SecretInput } from "./SecretInput";
22 +import { classifySecretProvider } from "./SecretProviderDialog.logic";
23 +
24 +export interface SecretSource {
25 + readonly id: SecretProviderId;
26 + readonly kind: SecretProviderKind;
27 + readonly label: string;
28 +}
29 +
30 +const NO_SECRET_SOURCES: ReadonlyArray<SecretSource> = [];
31 +const STORED_VALUE = "__stored__";
32 +const decodeSecretReference = Schema.decodeUnknownOption(SecretReference);
33 +
34 +/** Secret providers a setting can point at; empty when the environment cannot read references. */
35 +export function useSecretSources(environmentId: EnvironmentId): ReadonlyArray<SecretSource> {
36 + const providers = useEnvironmentSettings(environmentId, (settings) => settings.secretProviders);
37 + const supported = useAtomValue(
38 + serverEnvironment.configValueAtom(environmentId),
39 + (config) => config?.secretReferences === true,
40 + );
41 + if (!isSecretsFeatureEnabled || !supported) return NO_SECRET_SOURCES;
42 + return (Object.entries(providers) as Array<[SecretProviderId, SecretProviderConfig]>)
43 + .filter(([, config]) => classifySecretProvider(config).kind !== "unsupported")
44 + .map(([id, config]) => ({ id, kind: config.kind, label: config.label }));
45 +}
46 +
47 +function SourceLabel(props: {
48 + readonly icon: ComponentType<{ readonly className?: string }>;
49 + readonly label: string;
50 +}) {
51 + return (
52 + <span className="flex min-w-0 items-center gap-1.5">
53 + <props.icon className="size-3.5 shrink-0" />
54 + <span className="truncate">{props.label}</span>
55 + </span>
56 + );
57 +}
58 +
59 +type SecretSourceInputProps = Omit<ComponentProps<typeof SecretInput>, "value" | "children"> & {
60 + readonly value: string | SecretReference;
61 + readonly sources: ReadonlyArray<SecretSource>;
62 + readonly onSecretChange: (secret: SecretReference | undefined) => void;
63 + /** Places the parts in the caller's layout; `source` is null when there is nothing to pick. */
64 + readonly children?: (parts: {
65 + readonly source: ReactNode;
66 + readonly value: ReactNode;
67 + }) => ReactNode;
68 +};
69 +
70 +/** A secret entered here, or read from a secret provider when one is configured. */
71 +export function SecretSourceInput({
72 + value,
73 + sources,
74 + onSecretChange,
75 + children,
76 + ...rest
77 +}: SecretSourceInputProps) {
78 + // A provider picked here applies once a reference for it is committed.
79 + const [pendingProvider, setPendingProvider] = useState<SecretProviderId | null>(null);
80 + const [rejectedReference, setRejectedReference] = useState<string | null>(null);
81 + const secret = typeof value === "string" ? undefined : value;
82 + const input = { ...rest, value: typeof value === "string" ? value : "" };
83 + const provider = pendingProvider ?? secret?.provider ?? null;
84 + const reference = secret !== undefined && secret.provider === provider ? secret.reference : "";
85 + const providerSource = sources.find((source) => source.id === provider);
86 + const definition = providerSource && builtInSecretProviderDefinitions.find(providerSource.kind);
87 + const label = input["aria-label"] ?? "Secret";
88 + const providerLabel = (id: SecretProviderId) =>
89 + sources.find((source) => source.id === id)?.label ?? id;
90 + const providerIcon = (id: SecretProviderId) =>
91 + sources.some((source) => source.id === id) ? OnePasswordIcon : KeyRoundIcon;
92 +
93 + const source =
94 + sources.length === 0 && provider === null ? null : (
95 + <Select
96 + value={provider ?? STORED_VALUE}
97 + onValueChange={(value) => {
98 + setRejectedReference(null);
99 + if (value === STORED_VALUE || value === null) {
100 + setPendingProvider(null);
101 + if (secret !== undefined) onSecretChange(undefined);
102 + return;
103 + }
104 + const next = value as SecretProviderId;
105 + setPendingProvider(next === secret?.provider ? null : next);
106 + }}
107 + >
108 + <SelectTrigger size="sm" className="w-full min-w-0" aria-label={`${label} source`}>
109 + <SelectValue>
110 + {provider === null ? (
111 + <SourceLabel icon={TypeIcon} label="Value" />
112 + ) : (
113 + <SourceLabel icon={providerIcon(provider)} label={providerLabel(provider)} />
114 + )}
115 + </SelectValue>
116 + </SelectTrigger>
117 + <SelectPopup align="start" alignItemWithTrigger={false}>
118 + <SelectItem value={STORED_VALUE}>
119 + <SourceLabel icon={TypeIcon} label="Value" />
120 + </SelectItem>
121 + {sources.map((source) => (
122 + <SelectItem key={source.id} value={source.id}>
123 + <SourceLabel icon={OnePasswordIcon} label={source.label} />
124 + </SelectItem>
125 + ))}
126 + {provider !== null && !sources.some((source) => source.id === provider) ? (
127 + <SelectItem value={provider}>
128 + <SourceLabel icon={KeyRoundIcon} label={provider} />
129 + </SelectItem>
130 + ) : null}
131 + </SelectPopup>
132 + </Select>
133 + );
134 +
135 + const valueField =
136 + provider === null ? (
137 + <SecretInput {...input} />
138 + ) : (
139 + <div className="flex min-w-0 flex-1 flex-col gap-1">
140 + <DraftInput
141 + {...(input.id !== undefined ? { id: input.id } : {})}
142 + size="sm"
143 + font="mono"
144 + value={rejectedReference ?? reference}
145 + onCommit={(next) => {
146 + if (next.trim().length === 0) {
147 + setRejectedReference(null);
148 + if (pendingProvider === null && secret !== undefined) onSecretChange(undefined);
149 + return;
150 + }
151 + const decoded = decodeSecretReference({ provider, reference: next });
152 + if (
153 + Option.isNone(decoded) ||
154 + definition?.isReference(decoded.value.reference) === false
155 + ) {
156 + setRejectedReference(next);
157 + return;
158 + }
159 + setRejectedReference(null);
160 + setPendingProvider(null);
161 + onSecretChange(decoded.value);
162 + }}
163 + autoComplete="off"
164 + placeholder={definition?.referencePlaceholder}
165 + spellCheck={false}
166 + aria-label={`${label} reference`}
167 + aria-invalid={rejectedReference !== null}
168 + />
169 + {rejectedReference !== null ? (
170 + <p className="text-2xs text-destructive">
171 + {definition?.invalidReferenceMessage ?? "Enter a valid secret reference."}
172 + </p>
173 + ) : null}
174 + </div>
175 + );
176 +
177 + if (children !== undefined) return children({ source, value: valueField });
178 + if (source === null) return valueField;
179 + return (
180 + <div className="flex min-w-0 flex-1 items-start gap-1.5">
181 + <div className="w-28 shrink-0">{source}</div>
182 + {valueField}
183 + </div>
184 + );
185 +}
package.json
+1 -1
@@ -30,7 +30,7 @@
30 "report:renders": "node scripts/render-metrics.ts",
31 "lint": "vp lint --report-unused-disable-directives",
32 "knip": "knip --preprocessor ./scripts/knip-schemas.ts",
33 - "knip:check": "knip --include files,dependencies --no-config-hints && knip --workspace apps/server --workspace apps/desktop --workspace apps/web --workspace packages/client-runtime --workspace packages/contracts --workspace packages/effect-acp --workspace packages/effect-codex-app-server --workspace packages/shared --workspace packages/ssh --workspace packages/tailscale --workspace packages/provider-core --workspace packages/provider-acp --workspace packages/provider-acp-registry --workspace packages/provider-testing --workspace packages/provider-pi --workspace packages/provider-muse --workspace packages/provider-opencode --workspace packages/provider-cursor --workspace packages/provider-fx --workspace packages/provider-grok --workspace packages/source-control-core --workspace packages/source-control-definitions --workspace packages/source-control-azure-devops --workspace packages/source-control-bitbucket --workspace packages/source-control-forgejo --workspace packages/source-control-gitcafe --workspace packages/source-control-github --workspace packages/source-control-gitlab --workspace packages/source-control-testing --exports --preprocessor ./scripts/knip-schemas.ts --no-config-hints",
33 + "knip:check": "knip --include files,dependencies --no-config-hints && knip --workspace apps/server --workspace apps/desktop --workspace apps/web --workspace packages/client-runtime --workspace packages/contracts --workspace packages/effect-acp --workspace packages/effect-codex-app-server --workspace packages/shared --workspace packages/ssh --workspace packages/tailscale --workspace packages/provider-core --workspace packages/provider-acp --workspace packages/provider-acp-registry --workspace packages/provider-testing --workspace packages/provider-pi --workspace packages/provider-muse --workspace packages/provider-opencode --workspace packages/provider-cursor --workspace packages/provider-fx --workspace packages/provider-grok --workspace packages/secret-provider-core --workspace packages/secret-provider-definitions --workspace packages/secret-provider-onepassword --workspace packages/source-control-core --workspace packages/source-control-definitions --workspace packages/source-control-azure-devops --workspace packages/source-control-bitbucket --workspace packages/source-control-forgejo --workspace packages/source-control-gitcafe --workspace packages/source-control-github --workspace packages/source-control-gitlab --workspace packages/source-control-testing --exports --preprocessor ./scripts/knip-schemas.ts --no-config-hints",
34 "knip:production": "knip --production --preprocessor ./scripts/knip-schemas.ts",
35 "lint:mobile": "node scripts/mobile-native-static-check.ts",
36 "mobile:install": "node scripts/mobile-native-client.ts ensure",
packages/contracts/src/index.ts
+1
@@ -67,4 +67,5 @@ export * from "./resourceTelemetry.ts";
67 export * from "./rpc.ts";
68 export * from "./worktreeSetup.ts";
69 export * from "./secretRequest.ts";
70 +export * from "./secretReference.ts";
71 export * from "./clientRpcPermissions.ts";
packages/contracts/src/providerInstance.ts
+34 -1
@@ -1,6 +1,8 @@
1 import * as Effect from "effect/Effect";
2 import * as Schema from "effect/Schema";
3 +import * as SchemaTransformation from "effect/SchemaTransformation";
4 import { TrimmedNonEmptyString } from "./baseSchemas.ts";
5 +import { SecretReference } from "./secretReference.ts";
6
7 const PROVIDER_SLUG_MAX_CHARS = 64;
8 const PROVIDER_SLUG_PATTERN = /^[a-zA-Z][a-zA-Z0-9_-]*$/;
@@ -27,17 +29,48 @@ export const ProviderInstanceEnvironmentVariableName = TrimmedNonEmptyString.che
29 export type ProviderInstanceEnvironmentVariableName =
30 typeof ProviderInstanceEnvironmentVariableName.Type;
31
30 -export const ProviderInstanceEnvironmentVariable = Schema.Struct({
32 +const ProviderInstanceEnvironmentVariableValue = Schema.Struct({
33 + name: ProviderInstanceEnvironmentVariableName,
34 + value: Schema.Union([Schema.String, SecretReference]),
35 + sensitive: Schema.Boolean,
36 + valueRedacted: Schema.optionalKey(Schema.Boolean),
37 +});
38 +
39 +// A reference is encoded beside an empty value so older servers and clients still decode it.
40 +const StoredProviderInstanceEnvironmentVariable = Schema.Struct({
41 name: ProviderInstanceEnvironmentVariableName,
42 value: Schema.String.pipe(Schema.withDecodingDefault(Effect.succeed(""))),
43 sensitive: Schema.Boolean.pipe(Schema.withDecodingDefault(Effect.succeed(false))),
44 valueRedacted: Schema.optionalKey(Schema.Boolean),
45 + secret: Schema.optionalKey(SecretReference),
46 });
47 +
48 +export const ProviderInstanceEnvironmentVariable = StoredProviderInstanceEnvironmentVariable.pipe(
49 + Schema.decodeTo(
50 + Schema.toType(ProviderInstanceEnvironmentVariableValue),
51 + SchemaTransformation.transform<
52 + typeof ProviderInstanceEnvironmentVariableValue.Type,
53 + typeof StoredProviderInstanceEnvironmentVariable.Type
54 + >({
55 + decode: ({ secret, ...variable }) =>
56 + secret === undefined ? variable : { ...variable, value: secret },
57 + encode: ({ value, ...variable }) =>
58 + typeof value === "string"
59 + ? { ...variable, value }
60 + : { ...variable, value: "", secret: value },
61 + }),
62 + ),
63 +);
64 export type ProviderInstanceEnvironmentVariable = typeof ProviderInstanceEnvironmentVariable.Type;
65
66 export const ProviderInstanceEnvironment = Schema.Array(ProviderInstanceEnvironmentVariable);
67 export type ProviderInstanceEnvironment = typeof ProviderInstanceEnvironment.Type;
68
69 +/** What drivers receive: every secret reference has been read into a plain value. */
70 +export type ResolvedProviderInstanceEnvironment = ReadonlyArray<
71 + Omit<ProviderInstanceEnvironmentVariable, "value"> & { readonly value: string }
72 +>;
73 +
74 /** Drivers decode their own config; unknown-driver envelopes round-trip verbatim across versions. */
75 export const ProviderInstanceConfig = Schema.Struct({
76 driver: ProviderDriverKind,
packages/contracts/src/rpc.ts
+2
@@ -634,6 +634,8 @@ export const WsServerRefreshProvidersRpc = Rpc.make(WS_METHODS.serverRefreshProv
634 fresh: Schema.optional(Schema.Boolean),
635 /** Bypass model caches; explicit rediscovery may open sessions, background refreshes must not. */
636 refreshModels: Schema.optional(Schema.Boolean),
637 + /** Read secret references again; unlocking a vault can prompt on the host, so only explicit user refreshes ask. */
638 + reloadSecrets: Schema.optional(Schema.Boolean),
639 /**
640 * Reply without snapshots, or with only the requested instance's cwd snapshot. Snapshots then
641 * reach the client only through these replies, so another client's scan shows on its next
packages/contracts/src/secretReference.ts new
+27
@@ -0,0 +1,27 @@
1 +import * as Schema from "effect/Schema";
2 +
3 +import { TrimmedNonEmptyString } from "./baseSchemas.ts";
4 +
5 +// Separate module avoids an import cycle between settings and provider instance contracts.
6 +// Final once shipped: older builds drop entries whose key fails here, and erase them on their next save.
7 +// Unlike provider slugs it may start with a digit, so a provider named "1Password" fits.
8 +export const SecretProviderSlug = TrimmedNonEmptyString.check(
9 + Schema.isMaxLength(64),
10 + Schema.isPattern(/^[a-zA-Z0-9][a-zA-Z0-9_-]*$/),
11 +);
12 +
13 +export const SecretProviderId = SecretProviderSlug.pipe(Schema.brand("SecretProviderId"));
14 +export type SecretProviderId = typeof SecretProviderId.Type;
15 +
16 +// Provider-specific syntax is the secret provider driver's to check.
17 +export const SecretReferencePath = TrimmedNonEmptyString.check(
18 + Schema.isMaxLength(1024),
19 + Schema.isPattern(/^[^\r\n]+$/),
20 +);
21 +
22 +/** Points at a secret held by a configured secret provider; the secret itself is never stored. */
23 +export const SecretReference = Schema.Struct({
24 + provider: SecretProviderId,
25 + reference: SecretReferencePath,
26 +});
27 +export type SecretReference = typeof SecretReference.Type;
packages/contracts/src/server.ts
+2
@@ -640,6 +640,8 @@ export const ServerConfig = Schema.Struct({
640 threadFindProgressive: Schema.optionalKey(Schema.Boolean),
641 /** Settings patches may carry `secretProviders`; older servers drop the key without an error. */
642 secretProviderSettings: Schema.optionalKey(Schema.Boolean),
643 + /** Secret settings may point at a secret provider; older servers drop the reference. */
644 + secretReferences: Schema.optionalKey(Schema.Boolean),
645 scratchWorkspaceRoot: Schema.optionalKey(TrimmedNonEmptyString),
646 newProjectsRoot: Schema.optionalKey(TrimmedNonEmptyString),
647 /**
packages/contracts/src/settings.test.ts
+51 -8
@@ -2,7 +2,11 @@ import { describe, expect, it } from "vite-plus/test";
2 import * as Schema from "effect/Schema";
3
4 import { type CommandId, ProjectId } from "./baseSchemas.ts";
5 -import { ProviderDriverKind, ProviderInstanceId } from "./providerInstance.ts";
5 +import {
6 + ProviderDriverKind,
7 + ProviderInstanceEnvironment,
8 + ProviderInstanceId,
9 +} from "./providerInstance.ts";
10 import {
11 ClientSettingsSchema,
12 ClientSettingsPatch,
@@ -23,6 +27,14 @@ const decodeClientSettings = Schema.decodeUnknownSync(ClientSettingsSchema);
27 const decodeClientSettingsPatch = Schema.decodeUnknownSync(ClientSettingsPatch);
28 const encodeClientSettings = Schema.encodeSync(ClientSettingsSchema);
29 const decodeServerSettings = Schema.decodeUnknownSync(ServerSettings);
30 +const encodeProviderInstanceEnvironment = Schema.encodeSync(ProviderInstanceEnvironment);
31 +const decodeProviderInstanceEnvironment = Schema.decodeSync(ProviderInstanceEnvironment);
32 +// The environment variable shape builds released before secret references decode.
33 +const decodeStringOnlyEnvironment = Schema.decodeUnknownSync(
34 + Schema.Array(
35 + Schema.Struct({ name: Schema.String, value: Schema.String, sensitive: Schema.Boolean }),
36 + ),
37 +);
38 const decodeServerSettingsPatch = Schema.decodeUnknownSync(ServerSettingsPatch);
39 const encodeServerSettings = Schema.encodeSync(ServerSettings);
40 const encodeServerSettingsPatch = Schema.encodeSync(ServerSettingsPatch);
@@ -154,14 +166,45 @@ describe("ServerSettings secret providers", () => {
166 ).toThrow();
167 });
168
157 - it("rejects writes of an unknown kind or an account op could misread", () => {
158 - const write = (entry: unknown) => () =>
159 - decodeServerSettingsPatch({ secretProviders: { personal: entry } });
160 - for (const account of ["", "my account", "--help"]) {
161 - expect(write(onePassword(account))).toThrow();
169 + it("stores a provider environment secret reference in a layout older builds still decode", () => {
170 + const providerInstances = (secret: unknown) => ({
171 + codex: {
172 + driver: "codex",
173 + environment: [
174 + { name: "OPENAI_API_KEY", sensitive: true, value: "", secret },
175 + { name: "BASE_URL", value: "https://example.test" },
176 + ],
177 + },
178 + });
179 + const secret = { provider: "personal", reference: "op://Private/OpenAI/credential" };
180 + const environment = decodeServerSettings({ providerInstances: providerInstances(secret) })
181 + .providerInstances[ProviderInstanceId.make("codex")]?.environment;
182 + expect(environment).toEqual([
183 + { name: "OPENAI_API_KEY", value: secret, sensitive: true },
184 + { name: "BASE_URL", value: "https://example.test", sensitive: false },
185 + ]);
186 +
187 + const encoded = encodeProviderInstanceEnvironment(environment ?? []);
188 + expect(encoded).toEqual([
189 + { name: "OPENAI_API_KEY", value: "", sensitive: true, secret },
190 + { name: "BASE_URL", value: "https://example.test", sensitive: false },
191 + ]);
192 + expect(decodeProviderInstanceEnvironment(encoded)).toEqual(environment);
193 + expect(decodeStringOnlyEnvironment(encoded)).toEqual([
194 + { name: "OPENAI_API_KEY", value: "", sensitive: true },
195 + { name: "BASE_URL", value: "https://example.test", sensitive: false },
196 + ]);
197 +
198 + for (const invalid of [
199 + { provider: "My Vault", reference: "op://a/b/c" },
200 + { provider: "personal", reference: " " },
201 + { provider: "personal", reference: "op://Private/OpenAI\n/credential" },
202 + { provider: "personal", reference: "x".repeat(1025) },
203 + ]) {
204 + expect(() =>
205 + decodeServerSettings({ providerInstances: providerInstances(invalid) }),
206 + ).toThrow();
207 }
163 - expect(write({ kind: "one_password", label: "Personal" })).toThrow();
164 - expect(write({ kind: "openbao", label: "Vault", config: { address: "https://x" } })).toThrow();
208 });
209 });
210
packages/contracts/src/settings.ts
+5 -53
@@ -20,6 +20,7 @@ import {
20 TrimmedString,
21 } from "./baseSchemas.ts";
22 import { UsageLimitSourceId } from "./usageLimitSourceId.ts";
23 +import { SecretProviderId, SecretProviderSlug } from "./secretReference.ts";
24 import { EnvironmentMachineKind, ThreadEnvMode, WorktreeSubmodules } from "./environment.ts";
25 import { KeybindingShortcut } from "./keybindings.ts";
26 import {
@@ -859,42 +860,11 @@ export const UsageLimitSourceConfig = Schema.Struct({
860 });
861 export type UsageLimitSourceConfig = typeof UsageLimitSourceConfig.Type;
862
862 -// Final once shipped: older builds drop entries whose key fails here, and erase them on their next save.
863 -// Unlike provider slugs it may start with a digit, so a provider named "1Password" fits.
864 -const SecretProviderSlug = TrimmedNonEmptyString.check(
865 - Schema.isMaxLength(64),
866 - Schema.isPattern(/^[a-zA-Z0-9][a-zA-Z0-9_-]*$/),
867 -);
868 -
869 -export const SecretProviderId = SecretProviderSlug.pipe(Schema.brand("SecretProviderId"));
870 -export type SecretProviderId = typeof SecretProviderId.Type;
871 -
863 export const SecretProviderKind = SecretProviderSlug.pipe(Schema.brand("SecretProviderKind"));
864 export type SecretProviderKind = typeof SecretProviderKind.Type;
865
875 -const ONE_PASSWORD_ACCOUNT_PATTERN = /^[A-Za-z0-9][A-Za-z0-9._-]*$/;
876 -
877 -/**
878 - * Any value `op --account` accepts: shorthand, sign-in address, account ID, or user ID.
879 - * It is passed to the CLI as an argument, so it can never start with `-`.
880 - */
881 -export const OnePasswordAccount = Schema.String.check(
882 - Schema.isMaxLength(253),
883 - Schema.makeFilter((value: string) =>
884 - ONE_PASSWORD_ACCOUNT_PATTERN.test(value)
885 - ? true
886 - : "1Password account must be a shorthand, sign-in address, or ID with no spaces.",
887 - ),
888 -).pipe(Schema.brand("OnePasswordAccount"));
889 -export type OnePasswordAccount = typeof OnePasswordAccount.Type;
890 -
866 export const SecretProviderLabel = TrimmedNonEmptyString.check(Schema.isMaxLength(64));
867
893 -export const OnePasswordSecretProviderConfig = Schema.Struct({
894 - account: OnePasswordAccount,
895 -});
896 -export type OnePasswordSecretProviderConfig = typeof OnePasswordSecretProviderConfig.Type;
897 -
868 /** Kinds decode their own config; unknown-kind envelopes round-trip verbatim across versions. */
869 export const SecretProviderConfig = Schema.Struct({
870 kind: SecretProviderKind,
@@ -903,31 +873,12 @@ export const SecretProviderConfig = Schema.Struct({
873 });
874 export type SecretProviderConfig = typeof SecretProviderConfig.Type;
875
906 -/** Kinds this build can resolve. Their `config` holds no credentials, so clients may read it. */
907 -const SECRET_PROVIDER_KIND_CONFIG_GUARDS: Readonly<Record<string, (config: unknown) => boolean>> = {
908 - one_password: Schema.is(OnePasswordSecretProviderConfig),
909 -};
910 -
911 -export function isKnownSecretProviderKind(kind: string): boolean {
912 - return Object.hasOwn(SECRET_PROVIDER_KIND_CONFIG_GUARDS, kind);
913 -}
914 -
915 -// Limits that may change later are enforced on writes only, never on the stored envelope.
916 -// Writes must be a kind this build knows with a config it accepts, so an older server
917 -// rejects a newer kind instead of storing what it cannot check.
876 +// Limits that may change later are enforced on writes only, never on the stored envelope. The
877 +// server also checks the kind and its config against the secret providers it has loaded.
878 const SecretProviderConfigWrite = Schema.Struct({
879 ...SecretProviderConfig.fields,
880 label: SecretProviderLabel,
921 -}).check(
922 - Schema.makeFilter((entry) => {
923 - if (!isKnownSecretProviderKind(entry.kind)) {
924 - return `Unsupported secret provider kind: ${entry.kind}.`;
925 - }
926 - return SECRET_PROVIDER_KIND_CONFIG_GUARDS[entry.kind]!(entry.config)
927 - ? true
928 - : `Invalid ${entry.kind} secret provider config.`;
929 - }),
930 -);
881 +});
882
883 export const SourceControlHostSettings = Schema.Record(Schema.String, Schema.Unknown);
884 export type SourceControlHostSettings = typeof SourceControlHostSettings.Type;
@@ -1526,6 +1477,7 @@ export const ServerSettingsOperation = Schema.Literals([
1477 "remove-secret",
1478 "remove-stale-secret",
1479 "write-secret",
1480 + "write-secret-provider",
1481 "write-file",
1482 "prepare-directory",
1483 ]);
packages/provider-core/src/server/driver.ts
+2 -2
@@ -6,7 +6,7 @@ import type {
6 AcpRegistryOperationError,
7 AcpRegistrySetProviderInput,
8 ProviderDriverKind,
9 - ProviderInstanceEnvironment,
9 + ResolvedProviderInstanceEnvironment,
10 ProviderInstanceId,
11 ServerProvider,
12 ServerProviderWorkspaceSnapshot,
@@ -96,7 +96,7 @@ export interface ProviderDriverCreateInput<Config> {
96 readonly instanceId: ProviderInstanceId;
97 readonly displayName: string | undefined;
98 readonly accentColor?: string | undefined;
99 - readonly environment: ProviderInstanceEnvironment;
99 + readonly environment: ResolvedProviderInstanceEnvironment;
100 readonly enabled: boolean;
101 readonly config: Config;
102 }
packages/provider-core/src/server/instanceEnvironment.test.ts
+11 -1
@@ -1,5 +1,6 @@
1 import * as NodeServices from "@effect/platform-node/NodeServices";
2 import { describe, expect, it } from "@effect/vitest";
3 +import { SecretProviderId } from "@t3tools/contracts";
4 import * as Effect from "effect/Effect";
5 import * as Path from "effect/Path";
6 import * as HostProcess from "@t3tools/shared/HostProcess";
@@ -61,12 +62,21 @@ describe("mergeProviderInstanceEnvironment", () => {
62 [
63 { name: "OPENROUTER_API_KEY", value: "sk-or-test", sensitive: true },
64 { name: "ANTHROPIC_API_KEY", value: "", sensitive: false },
65 + {
66 + name: "OPENAI_API_KEY",
67 + value: {
68 + provider: SecretProviderId.make("personal"),
69 + reference: "op://Private/OpenAI/credential",
70 + },
71 + sensitive: true,
72 + },
73 ],
65 - { ANTHROPIC_API_KEY: "inherited", PATH: "/bin" },
74 + { ANTHROPIC_API_KEY: "inherited", OPENAI_API_KEY: "inherited", PATH: "/bin" },
75 ),
76 ).toMatchObject({
77 OPENROUTER_API_KEY: "sk-or-test",
78 ANTHROPIC_API_KEY: "",
79 + OPENAI_API_KEY: "inherited",
80 PATH: "/bin",
81 });
82 }),
packages/provider-core/src/server/instanceEnvironment.ts
+2
@@ -15,6 +15,8 @@ export const mergeProviderInstanceEnvironment = Effect.fn(function* (
15 const home = yield* HostProcess.HomeDirectory;
16 const next: NodeJS.ProcessEnv = { ...baseEnv };
17 for (const variable of environment) {
18 + // An unresolved secret reference carries no value; the registry resolves it for the provider.
19 + if (typeof variable.value !== "string") continue;
20 next[variable.name] =
21 variable.name === "CODEX_HOME" || variable.name === "CLAUDE_CONFIG_DIR"
22 ? expandHomePath(variable.value, home)
packages/secret-provider-core/package.json new
+33
@@ -0,0 +1,33 @@
1 +{
2 + "name": "@t3tools/secret-provider-core",
3 + "private": true,
4 + "type": "module",
5 + "exports": {
6 + "./shared/definition": {
7 + "types": "./src/shared/definition.ts",
8 + "import": "./src/shared/definition.ts"
9 + },
10 + "./server/driver": {
11 + "types": "./src/server/driver.ts",
12 + "import": "./src/server/driver.ts"
13 + },
14 + "./server/SecretResolver": {
15 + "types": "./src/server/SecretResolver.ts",
16 + "import": "./src/server/SecretResolver.ts"
17 + }
18 + },
19 + "scripts": {
20 + "typecheck": "tsc --noEmit",
21 + "test": "vp test run --config ../../vite.config.ts --dir ."
22 + },
23 + "dependencies": {
24 + "@t3tools/contracts": "workspace:*",
25 + "effect": "catalog:"
26 + },
27 + "devDependencies": {
28 + "@effect/platform-node": "catalog:",
29 + "@effect/vitest": "catalog:",
30 + "@types/node": "catalog:",
31 + "vite-plus": "catalog:"
32 + }
33 +}
packages/secret-provider-core/src/server/SecretResolver.test.ts new
+170
@@ -0,0 +1,170 @@
1 +import * as NodeServices from "@effect/platform-node/NodeServices";
2 +import { assert, describe, it } from "@effect/vitest";
3 +import {
4 + SecretProviderId,
5 + SecretProviderKind,
6 + type SecretReference,
7 + type ServerSettings,
8 +} from "@t3tools/contracts";
9 +import * as Effect from "effect/Effect";
10 +import * as Layer from "effect/Layer";
11 +import * as Schema from "effect/Schema";
12 +
13 +import { defineSecretProviderDriver } from "./driver.ts";
14 +import * as SecretResolver from "./SecretResolver.ts";
15 +import { defineSecretProvider } from "../shared/definition.ts";
16 +
17 +const FAKE_KIND = SecretProviderKind.make("fake");
18 +const FakeConfig = Schema.Struct({ account: Schema.String });
19 +
20 +const personal = SecretProviderId.make("personal");
21 +const work = SecretProviderId.make("work");
22 +const fake = (account: string) => ({
23 + kind: FAKE_KIND,
24 + label: account,
25 + config: { account },
26 +});
27 +const ref = (reference: string, provider = personal): SecretReference => ({ provider, reference });
28 +
29 +function fakeDriver(answer: (account: string, reference: string) => string | undefined) {
30 + const reads: Array<{ readonly account: string; readonly references: ReadonlyArray<string> }> = [];
31 + const driver = defineSecretProviderDriver({
32 + kind: FAKE_KIND,
33 + definition: defineSecretProvider({
34 + kind: FAKE_KIND,
35 + label: "Fake",
36 + configSchema: FakeConfig,
37 + isReference: (reference) => reference.startsWith("fake://"),
38 + referencePlaceholder: "fake://item",
39 + invalidReferenceMessage: "Use fake://item.",
40 + }),
41 + read: ({ account }, references) =>
42 + Effect.sync(() => {
43 + reads.push({ account, references });
44 + return references.map((reference) => answer(account, reference));
45 + }),
46 + });
47 + return { driver, reads };
48 +}
49 +
50 +const resolverLayer = (
51 + driver: ReturnType<typeof fakeDriver>["driver"],
52 + secretProviders: () => ServerSettings["secretProviders"] = () => ({ [personal]: fake("a") }),
53 +) =>
54 + SecretResolver.layer({
55 + drivers: [driver],
56 + secretProviders: Effect.sync(secretProviders),
57 + }).pipe(Layer.provide(NodeServices.layer));
58 +
59 +describe("SecretResolver", () => {
60 + it.effect("reads a reference once and holds it", () => {
61 + const { driver, reads } = fakeDriver(() => "sk-live");
62 + return Effect.gen(function* () {
63 + const resolver = yield* SecretResolver.SecretResolver;
64 + const token = ref("fake://openai");
65 +
66 + assert.deepStrictEqual(yield* resolver.read([token]), ["sk-live"]);
67 + assert.deepStrictEqual(yield* resolver.read([token]), ["sk-live"]);
68 + assert.deepStrictEqual(reads, [{ account: "a", references: ["fake://openai"] }]);
69 + }).pipe(Effect.provide(resolverLayer(driver)));
70 + });
71 +
72 + it.effect("holds a failed read until invalidated, then reads again", () => {
73 + let locked = true;
74 + const { driver, reads } = fakeDriver(() => (locked ? undefined : "sk-live"));
75 + return Effect.gen(function* () {
76 + const resolver = yield* SecretResolver.SecretResolver;
77 + const token = ref("fake://openai");
78 +
79 + assert.deepStrictEqual(yield* resolver.read([token]), [undefined]);
80 + locked = false;
81 + assert.deepStrictEqual(yield* resolver.read([token]), [undefined]);
82 + assert.strictEqual(reads.length, 1);
83 +
84 + yield* resolver.invalidate([token]);
85 + assert.deepStrictEqual(yield* resolver.read([token]), ["sk-live"]);
86 + assert.strictEqual(reads.length, 2);
87 + }).pipe(Effect.provide(resolverLayer(driver)));
88 + });
89 +
90 + it.effect("invalidates every reference when none are named", () => {
91 + const { driver, reads } = fakeDriver(() => "sk-live");
92 + return Effect.gen(function* () {
93 + const resolver = yield* SecretResolver.SecretResolver;
94 + const token = ref("fake://openai");
95 +
96 + yield* resolver.read([token]);
97 + yield* resolver.invalidate();
98 + yield* resolver.read([token]);
99 + assert.strictEqual(reads.length, 2);
100 + }).pipe(Effect.provide(resolverLayer(driver)));
101 + });
102 +
103 + it.effect("reads each distinct reference of a provider in one call, in input order", () => {
104 + const { driver, reads } = fakeDriver((_, reference) => reference.toUpperCase());
105 + return Effect.gen(function* () {
106 + const resolver = yield* SecretResolver.SecretResolver;
107 +
108 + const values = yield* resolver.read([ref("fake://a"), ref("fake://b"), ref("fake://a")]);
109 +
110 + assert.deepStrictEqual(values, ["FAKE://A", "FAKE://B", "FAKE://A"]);
111 + assert.deepStrictEqual(reads, [{ account: "a", references: ["fake://a", "fake://b"] }]);
112 + }).pipe(Effect.provide(resolverLayer(driver)));
113 + });
114 +
115 + it.effect("reads each provider separately", () => {
116 + const { driver, reads } = fakeDriver((account, reference) => `${account}:${reference}`);
117 + return Effect.gen(function* () {
118 + const resolver = yield* SecretResolver.SecretResolver;
119 +
120 + const values = yield* resolver.read([ref("fake://a"), ref("fake://a", work)]);
121 +
122 + assert.deepStrictEqual(values, ["a:fake://a", "b:fake://a"]);
123 + assert.strictEqual(reads.length, 2);
124 + }).pipe(
125 + Effect.provide(resolverLayer(driver, () => ({ [personal]: fake("a"), [work]: fake("b") }))),
126 + );
127 + });
128 +
129 + it.effect("reads again when the provider's config changes", () => {
130 + let account = "a";
131 + const { driver, reads } = fakeDriver((account, reference) => `${account}:${reference}`);
132 + return Effect.gen(function* () {
133 + const resolver = yield* SecretResolver.SecretResolver;
134 + const token = ref("fake://openai");
135 +
136 + assert.deepStrictEqual(yield* resolver.read([token]), ["a:fake://openai"]);
137 + account = "b";
138 + assert.deepStrictEqual(yield* resolver.read([token]), ["b:fake://openai"]);
139 + assert.deepStrictEqual(
140 + reads.map((read) => read.account),
141 + ["a", "b"],
142 + );
143 + }).pipe(Effect.provide(resolverLayer(driver, () => ({ [personal]: fake(account) }))));
144 + });
145 +
146 + it.effect("does not call a driver for what it cannot read, and reads it later", () => {
147 + const { driver, reads } = fakeDriver(() => "sk-live");
148 + const providers: ServerSettings["secretProviders"] = {
149 + [personal]: fake("a"),
150 + [SecretProviderId.make("vault")]: {
151 + kind: SecretProviderKind.make("openbao"),
152 + label: "Vault",
153 + },
154 + [SecretProviderId.make("broken")]: { kind: FAKE_KIND, label: "Broken", config: {} },
155 + };
156 + return Effect.gen(function* () {
157 + const resolver = yield* SecretResolver.SecretResolver;
158 +
159 + const values = yield* resolver.read([
160 + ref("fake://openai", SecretProviderId.make("missing")),
161 + ref("fake://openai", SecretProviderId.make("vault")),
162 + ref("fake://openai", SecretProviderId.make("broken")),
163 + ref("openai"),
164 + ]);
165 +
166 + assert.deepStrictEqual(values, [undefined, undefined, undefined, undefined]);
167 + assert.strictEqual(reads.length, 0);
168 + }).pipe(Effect.provide(resolverLayer(driver, () => providers)));
169 + });
170 +});
packages/secret-provider-core/src/server/SecretResolver.ts new
+125
@@ -0,0 +1,125 @@
1 +// Reads secrets that settings point at through a configured secret provider. Each read, including
2 +// a failed one, is held for the server's life so rebuilds never re-prompt an unlock; `invalidate`
3 +// (the Settings refresh) is the only way to read again.
4 +import type { SecretReference, ServerSettings } from "@t3tools/contracts";
5 +import * as Context from "effect/Context";
6 +import * as Effect from "effect/Effect";
7 +import * as Layer from "effect/Layer";
8 +import * as Option from "effect/Option";
9 +import * as Schema from "effect/Schema";
10 +import * as Semaphore from "effect/Semaphore";
11 +
12 +import type { SecretProviderDriver, SecretProviderDriverServices } from "./driver.ts";
13 +
14 +export class SecretResolver extends Context.Service<
15 + SecretResolver,
16 + {
17 + /** Values in input order; `undefined` marks a reference that could not be read. */
18 + readonly read: (
19 + references: ReadonlyArray<SecretReference>,
20 + ) => Effect.Effect<ReadonlyArray<string | undefined>>;
21 + /** Forgets the given references, or every reference, so the next read asks the provider again. */
22 + readonly invalidate: (references?: ReadonlyArray<SecretReference>) => Effect.Effect<void>;
23 + }
24 +>()("@t3tools/secret-provider-core/server/SecretResolver") {}
25 +
26 +const cacheKey = (reference: SecretReference) =>
27 + `${reference.provider}\u0000${reference.reference}`;
28 +
29 +interface CachedSecret {
30 + // A provider whose config changed, such as another account, reads again.
31 + readonly config: string;
32 + readonly value: string | undefined;
33 +}
34 +
35 +const decodeConfigWith = Schema.decodeUnknownOption<Schema.Codec<unknown, unknown>>;
36 +
37 +interface ReadablePlan {
38 + readonly driver: SecretProviderDriver;
39 + readonly config: unknown;
40 + readonly configKey: string;
41 +}
42 +
43 +export const make = Effect.fn("SecretResolver.make")(function* (options: {
44 + readonly drivers: ReadonlyArray<SecretProviderDriver>;
45 + readonly secretProviders: Effect.Effect<ServerSettings["secretProviders"]>;
46 +}) {
47 + const context = yield* Effect.context<SecretProviderDriverServices>();
48 + const driversByKind = new Map(
49 + options.drivers.map((driver) => [
50 + driver.kind,
51 + { driver, decodeConfig: decodeConfigWith(driver.definition.configSchema) },
52 + ]),
53 + );
54 + const cache = new Map<string, CachedSecret>();
55 + const semaphore = yield* Semaphore.make(1);
56 +
57 + // Only a provider this build can read is cached; anything else fails fast and is checked again
58 + // on the next read.
59 + const planFor = (
60 + providers: ServerSettings["secretProviders"],
61 + reference: SecretReference,
62 + ): ReadablePlan | undefined => {
63 + const provider = providers[reference.provider];
64 + const entry = provider === undefined ? undefined : driversByKind.get(provider.kind);
65 + if (provider === undefined || entry === undefined) return undefined;
66 + const { driver, decodeConfig } = entry;
67 + if (!driver.definition.isReference(reference.reference)) return undefined;
68 + const config = decodeConfig(provider.config);
69 + return Option.isNone(config)
70 + ? undefined
71 + : { driver, config: config.value, configKey: JSON.stringify(config.value) };
72 + };
73 +
74 + const read: SecretResolver["Service"]["read"] = Effect.fn("SecretResolver.read")(
75 + function* (references) {
76 + const providers = yield* options.secretProviders;
77 + const plans = references.map((reference) => planFor(providers, reference));
78 +
79 + const wanted = new Map<
80 + string,
81 + { readonly plan: ReadablePlan; readonly byReference: Map<string, Array<SecretReference>> }
82 + >();
83 + references.forEach((reference, index) => {
84 + const plan = plans[index];
85 + if (plan === undefined || cache.get(cacheKey(reference))?.config === plan.configKey) return;
86 + const group = wanted.get(reference.provider) ?? { plan, byReference: new Map() };
87 + group.byReference.set(reference.reference, [
88 + ...(group.byReference.get(reference.reference) ?? []),
89 + reference,
90 + ]);
91 + wanted.set(reference.provider, group);
92 + });
93 + for (const { plan, byReference } of wanted.values()) {
94 + const values = yield* plan.driver.read(plan.config, [...byReference.keys()]);
95 + [...byReference.values()].forEach((sameReference, index) => {
96 + for (const reference of sameReference) {
97 + cache.set(cacheKey(reference), { config: plan.configKey, value: values[index] });
98 + }
99 + });
100 + }
101 +
102 + return references.map((reference, index) => {
103 + const cached = cache.get(cacheKey(reference));
104 + return plans[index] !== undefined && cached?.config === plans[index].configKey
105 + ? cached.value
106 + : undefined;
107 + });
108 + },
109 + (effect) => semaphore.withPermits(1)(effect),
110 + Effect.provideContext(context),
111 + );
112 +
113 + const invalidate: SecretResolver["Service"]["invalidate"] = (references) =>
114 + semaphore.withPermits(1)(
115 + Effect.sync(() => {
116 + if (references === undefined) cache.clear();
117 + else for (const reference of references) cache.delete(cacheKey(reference));
118 + }),
119 + );
120 +
121 + return SecretResolver.of({ read, invalidate });
122 +});
123 +
124 +export const layer = (options: Parameters<typeof make>[0]) =>
125 + Layer.effect(SecretResolver, make(options));
packages/secret-provider-core/src/server/driver.ts new
+46
@@ -0,0 +1,46 @@
1 +import type { SecretProviderKind } from "@t3tools/contracts";
2 +import type * as Crypto from "effect/Crypto";
3 +import * as Effect from "effect/Effect";
4 +import type * as FileSystem from "effect/FileSystem";
5 +import * as Schema from "effect/Schema";
6 +import type { ChildProcessSpawner } from "effect/process";
7 +
8 +import type { SecretProviderDefinition } from "../shared/definition.ts";
9 +
10 +/** What the server gives every driver. A driver builds anything else it needs itself. */
11 +export type SecretProviderDriverServices =
12 + | ChildProcessSpawner.ChildProcessSpawner
13 + | FileSystem.FileSystem
14 + | Crypto.Crypto;
15 +
16 +export interface SecretProviderDriver {
17 + readonly kind: SecretProviderKind;
18 + readonly definition: SecretProviderDefinition;
19 + /**
20 + * Values in input order; `undefined` marks a reference that could not be read. `config` has
21 + * decoded with the definition's `configSchema` and every reference passed its `isReference`.
22 + */
23 + readonly read: (
24 + config: unknown,
25 + references: ReadonlyArray<string>,
26 + ) => Effect.Effect<ReadonlyArray<string | undefined>, never, SecretProviderDriverServices>;
27 +}
28 +
29 +export const defineSecretProviderDriver = <Config>(driver: {
30 + readonly kind: SecretProviderKind;
31 + readonly definition: SecretProviderDefinition<Config>;
32 + readonly read: (
33 + config: Config,
34 + references: ReadonlyArray<string>,
35 + ) => Effect.Effect<ReadonlyArray<string | undefined>, never, SecretProviderDriverServices>;
36 +}): SecretProviderDriver => {
37 + const isConfig = Schema.is(driver.definition.configSchema);
38 + return {
39 + kind: driver.kind,
40 + definition: driver.definition,
41 + read: (config, references) =>
42 + isConfig(config)
43 + ? driver.read(config, references)
44 + : Effect.succeed(references.map(() => undefined)),
45 + };
46 +};
packages/secret-provider-core/src/shared/definition.ts new
+35
@@ -0,0 +1,35 @@
1 +import type { SecretProviderKind } from "@t3tools/contracts";
2 +import type * as Schema from "effect/Schema";
3 +
4 +/** What clients and the server both need to know about one kind of secret provider. */
5 +export interface SecretProviderDefinition<Config = unknown> {
6 + readonly kind: SecretProviderKind;
7 + readonly label: string;
8 + readonly configSchema: Schema.Codec<Config, unknown>;
9 + /** Whether `reference` is syntax this kind can read. */
10 + readonly isReference: (reference: string) => boolean;
11 + readonly referencePlaceholder: string;
12 + readonly invalidReferenceMessage: string;
13 +}
14 +
15 +export const defineSecretProvider = <Config>(
16 + definition: SecretProviderDefinition<Config>,
17 +): SecretProviderDefinition<Config> => definition;
18 +
19 +export interface SecretProviderDefinitionRegistry {
20 + readonly definitions: ReadonlyArray<SecretProviderDefinition>;
21 + readonly find: (kind: string) => SecretProviderDefinition | undefined;
22 +}
23 +
24 +export function makeSecretProviderDefinitionRegistry(
25 + definitions: ReadonlyArray<SecretProviderDefinition>,
26 +): SecretProviderDefinitionRegistry {
27 + const byKind = new Map<string, SecretProviderDefinition>();
28 + for (const definition of definitions) {
29 + if (byKind.has(definition.kind)) {
30 + throw new Error(`Secret provider '${definition.kind}' is defined more than once.`);
31 + }
32 + byKind.set(definition.kind, definition);
33 + }
34 + return { definitions, find: (kind) => byKind.get(kind) };
35 +}
packages/secret-provider-core/tsconfig.json new
+7
@@ -0,0 +1,7 @@
1 +{
2 + "extends": "../../tsconfig.base.json",
3 + "compilerOptions": {
4 + "types": ["node"]
5 + },
6 + "include": ["src"]
7 +}
packages/secret-provider-definitions/package.json new
+18
@@ -0,0 +1,18 @@
1 +{
2 + "name": "@t3tools/secret-provider-definitions",
3 + "private": true,
4 + "type": "module",
5 + "exports": {
6 + "./registry": {
7 + "types": "./src/registry.ts",
8 + "import": "./src/registry.ts"
9 + }
10 + },
11 + "scripts": {
12 + "typecheck": "tsc --noEmit"
13 + },
14 + "dependencies": {
15 + "@t3tools/secret-provider-core": "workspace:*",
16 + "@t3tools/secret-provider-onepassword": "workspace:*"
17 + }
18 +}
packages/secret-provider-definitions/src/registry.ts new
+6
@@ -0,0 +1,6 @@
1 +import { makeSecretProviderDefinitionRegistry } from "@t3tools/secret-provider-core/shared/definition";
2 +import * as OnePassword from "@t3tools/secret-provider-onepassword/shared/definition";
3 +
4 +export const builtInSecretProviderDefinitions = makeSecretProviderDefinitionRegistry([
5 + OnePassword.definition,
6 +]);
packages/secret-provider-definitions/tsconfig.json new
+4
@@ -0,0 +1,4 @@
1 +{
2 + "extends": "../../tsconfig.base.json",
3 + "include": ["src"]
4 +}
packages/secret-provider-onepassword/package.json new
+32
@@ -0,0 +1,32 @@
1 +{
2 + "name": "@t3tools/secret-provider-onepassword",
3 + "private": true,
4 + "type": "module",
5 + "exports": {
6 + "./shared/definition": {
7 + "types": "./src/shared/definition.ts",
8 + "import": "./src/shared/definition.ts"
9 + },
10 + "./server/driver": {
11 + "types": "./src/server/driver.ts",
12 + "import": "./src/server/driver.ts"
13 + }
14 + },
15 + "scripts": {
16 + "typecheck": "tsc --noEmit",
17 + "test": "vp test run --config ../../vite.config.ts --dir ."
18 + },
19 + "dependencies": {
20 + "@t3tools/contracts": "workspace:*",
21 + "@t3tools/provider-core": "workspace:*",
22 + "@t3tools/secret-provider-core": "workspace:*",
23 + "@t3tools/shared": "workspace:*",
24 + "effect": "catalog:"
25 + },
26 + "devDependencies": {
27 + "@effect/platform-node": "catalog:",
28 + "@effect/vitest": "catalog:",
29 + "@types/node": "catalog:",
30 + "vite-plus": "catalog:"
31 + }
32 +}
packages/secret-provider-onepassword/src/server/driver.test.ts new
+155
@@ -0,0 +1,155 @@
1 +// @effect-diagnostics nodeBuiltinImport:off -- the fake `op` reads the template the driver wrote.
2 +import * as NodeCrypto from "@effect/platform-node/NodeCrypto";
3 +import * as NodeFileSystem from "@effect/platform-node/NodeFileSystem";
4 +import { assert, describe, it } from "@effect/vitest";
5 +import * as Deferred from "effect/Deferred";
6 +import * as Effect from "effect/Effect";
7 +import * as Fiber from "effect/Fiber";
8 +import * as Layer from "effect/Layer";
9 +import * as Sink from "effect/Sink";
10 +import * as Stream from "effect/Stream";
11 +import * as TestClock from "effect/testing/TestClock";
12 +import { ChildProcessSpawner } from "effect/process";
13 +import * as NodeFS from "node:fs";
14 +
15 +import { OnePasswordAccount } from "../shared/definition.ts";
16 +import { driver } from "./driver.ts";
17 +
18 +const encoder = new TextEncoder();
19 +const account = OnePasswordAccount.make("my.1password.com");
20 +
21 +type OpResult = {
22 + readonly stdout?: string;
23 + readonly stderr?: string;
24 + readonly code?: number;
25 + readonly hang?: boolean;
26 +};
27 +
28 +function fakeOp(answer: (args: ReadonlyArray<string>) => OpResult) {
29 + const invocations: Array<ReadonlyArray<string>> = [];
30 + const spawned = Deferred.makeUnsafe<void>();
31 + const layer = Layer.mergeAll(
32 + Layer.succeed(
33 + ChildProcessSpawner.ChildProcessSpawner,
34 + ChildProcessSpawner.make((command) =>
35 + Effect.sync(() => {
36 + const { args } = command as unknown as { readonly args: ReadonlyArray<string> };
37 + invocations.push(args);
38 + Deferred.doneUnsafe(spawned, Effect.void);
39 + const result = answer(args);
40 + return ChildProcessSpawner.makeHandle({
41 + pid: ChildProcessSpawner.ProcessId(1),
42 + exitCode: result.hang
43 + ? Effect.never
44 + : Effect.succeed(ChildProcessSpawner.ExitCode(result.code ?? 0)),
45 + isRunning: Effect.succeed(false),
46 + kill: () => Effect.void,
47 + unref: Effect.succeed(Effect.void),
48 + stdin: Sink.drain,
49 + stdout: Stream.make(encoder.encode(result.stdout ?? "")),
50 + stderr: Stream.make(encoder.encode(result.stderr ?? "")),
51 + all: Stream.empty,
52 + getInputFd: () => Sink.drain,
53 + getOutputFd: () => Stream.empty,
54 + });
55 + }),
56 + ),
57 + ),
58 + NodeFileSystem.layer,
59 + NodeCrypto.layer,
60 + );
61 + return { layer, invocations, spawned };
62 +}
63 +
64 +// Answers `op inject` by substituting each `{{ reference }}` in the template file it was handed.
65 +const injectFrom =
66 + (secrets: Readonly<Record<string, string>>) =>
67 + (args: ReadonlyArray<string>): OpResult => {
68 + const template = NodeFS.readFileSync(args[args.indexOf("-i") + 1]!, "utf8");
69 + return { stdout: template.replace(/\{\{ (\S+) \}\}/g, (_, reference) => secrets[reference]!) };
70 + };
71 +
72 +describe("1Password driver", () => {
73 + it.effect("reads one reference from the account", () => {
74 + const op = fakeOp(() => ({ stdout: "sk-live" }));
75 + return Effect.gen(function* () {
76 + assert.deepStrictEqual(yield* driver.read({ account }, ["op://Private/OpenAI/credential"]), [
77 + "sk-live",
78 + ]);
79 + assert.deepStrictEqual(op.invocations, [
80 + [
81 + "--cache=false",
82 + "read",
83 + "--account=my.1password.com",
84 + "--no-newline",
85 + "op://Private/OpenAI/credential",
86 + ],
87 + ]);
88 + }).pipe(Effect.provide(op.layer));
89 + });
90 +
91 + it.effect("reads a failed reference as undefined", () => {
92 + const op = fakeOp(() => ({ code: 1, stderr: "[ERROR] account is locked" }));
93 + return Effect.gen(function* () {
94 + assert.deepStrictEqual(yield* driver.read({ account }, ["op://Private/OpenAI/credential"]), [
95 + undefined,
96 + ]);
97 + }).pipe(Effect.provide(op.layer));
98 + });
99 +
100 + it.effect("reads every reference in a single call", () => {
101 + const op = fakeOp(
102 + injectFrom({
103 + "op://Private/OpenAI/credential": "sk-a",
104 + "op://Private/Anthropic/key": " sk-b\n",
105 + }),
106 + );
107 + return Effect.gen(function* () {
108 + const values = yield* driver.read({ account }, [
109 + "op://Private/OpenAI/credential",
110 + "op://Private/Anthropic/key",
111 + ]);
112 +
113 + assert.deepStrictEqual(values, ["sk-a", " sk-b\n"]);
114 + assert.strictEqual(op.invocations.length, 1);
115 + assert.deepStrictEqual(op.invocations[0]?.slice(0, 3), [
116 + "--cache=false",
117 + "inject",
118 + "--account=my.1password.com",
119 + ]);
120 + }).pipe(Effect.provide(op.layer));
121 + });
122 +
123 + it.effect("falls back to one read at a time when the batch fails", () => {
124 + const op = fakeOp((args) =>
125 + args.includes("inject")
126 + ? { code: 1, stderr: '[ERROR] could not resolve "op://Private/Gone/key"' }
127 + : args.at(-1) === "op://Private/Gone/key"
128 + ? { code: 1, stderr: "[ERROR] item not found" }
129 + : { stdout: "sk-a" },
130 + );
131 + return Effect.gen(function* () {
132 + const values = yield* driver.read({ account }, [
133 + "op://Private/OpenAI/credential",
134 + "op://Private/Gone/key",
135 + ]);
136 +
137 + assert.deepStrictEqual(values, ["sk-a", undefined]);
138 + assert.strictEqual(op.invocations.length, 3);
139 + }).pipe(Effect.provide(op.layer));
140 + });
141 +
142 + it.effect("does not read one at a time after the batch times out", () => {
143 + const op = fakeOp(() => ({ hang: true }));
144 + return Effect.gen(function* () {
145 + const reading = yield* driver
146 + .read({ account }, ["op://Private/OpenAI/credential", "op://Private/Anthropic/key"])
147 + .pipe(Effect.forkChild);
148 + yield* Deferred.await(op.spawned);
149 + yield* TestClock.adjust("1 minute");
150 +
151 + assert.deepStrictEqual(yield* Fiber.join(reading), [undefined, undefined]);
152 + assert.strictEqual(op.invocations.length, 1);
153 + }).pipe(Effect.provide(op.layer));
154 + });
155 +});
packages/secret-provider-onepassword/src/server/driver.ts new
+112
@@ -0,0 +1,112 @@
1 +import { spawnAndCollect } from "@t3tools/provider-core/server/snapshotProbe";
2 +import { defineSecretProviderDriver } from "@t3tools/secret-provider-core/server/driver";
3 +import { resolveSpawnCommand } from "@t3tools/shared/shell";
4 +import * as Crypto from "effect/Crypto";
5 +import * as Duration from "effect/Duration";
6 +import * as Effect from "effect/Effect";
7 +import * as FileSystem from "effect/FileSystem";
8 +import * as Option from "effect/Option";
9 +import { ChildProcess } from "effect/process";
10 +
11 +import { definition, type OnePasswordAccount } from "../shared/definition.ts";
12 +
13 +const ONE_PASSWORD_BINARY = "op";
14 +// Bounds a read long enough to reach for a fingerprint reader, short enough not to wedge a rebuild.
15 +const READ_TIMEOUT = Duration.seconds(45);
16 +
17 +// `--cache=false` skips the `op daemon`, which hangs on prompts a background server cannot show.
18 +const runOnePassword = Effect.fn("OnePasswordDriver.runOnePassword")(function* (
19 + args: ReadonlyArray<string>,
20 +) {
21 + const spawnCommand = yield* resolveSpawnCommand(ONE_PASSWORD_BINARY, ["--cache=false", ...args]);
22 + return yield* spawnAndCollect(
23 + ONE_PASSWORD_BINARY,
24 + ChildProcess.make(spawnCommand.command, spawnCommand.args, { shell: spawnCommand.shell }),
25 + );
26 +});
27 +
28 +// A secret is passed on verbatim; surrounding whitespace can be part of it.
29 +const nonEmpty = (value: string) => (value.trim().length > 0 ? value : undefined);
30 +
31 +const readOne = Effect.fn("OnePasswordDriver.readOne")(function* (
32 + account: OnePasswordAccount,
33 + reference: string,
34 +) {
35 + const result = yield* runOnePassword(["read", `--account=${account}`, "--no-newline", reference]);
36 + if (result.code !== 0) {
37 + yield* Effect.logWarning("Could not read secret from 1Password", {
38 + stage: "read",
39 + exitCode: result.code,
40 + });
41 + return undefined;
42 + }
43 + return nonEmpty(result.stdout);
44 +});
45 +
46 +// One `op inject` costs one unlock for every reference in the template. `op` ignores piped stdin
47 +// from Node, so the template goes through a temp file. A random separator after every reference
48 +// keeps one secret from shifting the others, and leaves any trailing newline outside the values.
49 +const readTogether = Effect.fn("OnePasswordDriver.readTogether")(function* (
50 + account: OnePasswordAccount,
51 + references: ReadonlyArray<string>,
52 +) {
53 + const fileSystem = yield* FileSystem.FileSystem;
54 + const separator = `__t3-secret-${yield* (yield* Crypto.Crypto).randomUUIDv4()}__`;
55 + const templatePath = yield* fileSystem.makeTempFileScoped({ prefix: "t3code-op-inject-" });
56 + yield* fileSystem.writeFileString(
57 + templatePath,
58 + references.map((reference) => `{{ ${reference} }}${separator}`).join(""),
59 + );
60 + const result = yield* runOnePassword(["inject", `--account=${account}`, "-i", templatePath]);
61 + const values = result.stdout.split(separator);
62 + const trailing = values.pop();
63 + if (
64 + result.code !== 0 ||
65 + values.length !== references.length ||
66 + trailing === undefined ||
67 + trailing.trim().length > 0
68 + ) {
69 + yield* Effect.logWarning("Could not batch-read secrets from 1Password", {
70 + stage: "inject",
71 + exitCode: result.code,
72 + references: references.length,
73 + });
74 + return undefined;
75 + }
76 + return values.map(nonEmpty);
77 +}, Effect.scoped);
78 +
79 +/** `None` when 1Password did not answer in time; a failed run reads as `Some(undefined)`. */
80 +const bounded = <A, E extends { readonly _tag: string }, R>(
81 + stage: "read" | "inject",
82 + effect: Effect.Effect<A | undefined, E, R>,
83 +) =>
84 + effect.pipe(
85 + Effect.timeoutOption(READ_TIMEOUT),
86 + Effect.tap((outcome) =>
87 + Option.isNone(outcome)
88 + ? Effect.logWarning("1Password did not answer in time", { stage })
89 + : Effect.void,
90 + ),
91 + Effect.catch((error) =>
92 + Effect.logWarning("Could not run 1Password", { stage, error: error._tag }).pipe(
93 + Effect.as(Option.some(undefined)),
94 + ),
95 + ),
96 + );
97 +
98 +export const driver = defineSecretProviderDriver({
99 + kind: definition.kind,
100 + definition,
101 + read: Effect.fn("OnePasswordDriver.read")(function* ({ account }, references) {
102 + if (references.length > 1) {
103 + const together = yield* bounded("inject", readTogether(account, references));
104 + // Reading one by one after a timeout would only wait that long again for each reference.
105 + if (Option.isNone(together)) return references.map(() => undefined);
106 + if (together.value !== undefined) return together.value;
107 + }
108 + return yield* Effect.forEach(references, (reference) =>
109 + bounded("read", readOne(account, reference)).pipe(Effect.map(Option.getOrUndefined)),
110 + );
111 + }),
112 +});
packages/secret-provider-onepassword/src/shared/definition.test.ts new
+28
@@ -0,0 +1,28 @@
1 +import { describe, expect, it } from "@effect/vitest";
2 +
3 +import { definition } from "./definition.ts";
4 +
5 +describe("1Password definition", () => {
6 + it("accepts vault, item, optional section, and field references", () => {
7 + for (const reference of [
8 + "op://Private/OpenAI/credential",
9 + "op://Private/OpenAI/Section 1/credential",
10 + "op://Private/OpenAI/credential?attribute=otp",
11 + ]) {
12 + expect(definition.isReference(reference), reference).toBe(true);
13 + }
14 + });
15 +
16 + it("rejects anything that is not a plain reference", () => {
17 + for (const reference of [
18 + "--help",
19 + "Private/OpenAI/credential",
20 + "op://Private/OpenAI",
21 + "op://Private/OpenAI/credential }} {{ op://Private/B/c",
22 + "op://Private/OpenAI\n/credential",
23 + `op://Private/OpenAI/${"x".repeat(1024)}`,
24 + ]) {
25 + expect(definition.isReference(reference), reference).toBe(false);
26 + }
27 + });
28 +});
packages/secret-provider-onepassword/src/shared/definition.ts new
+41
@@ -0,0 +1,41 @@
1 +import { SecretProviderKind } from "@t3tools/contracts";
2 +import { defineSecretProvider } from "@t3tools/secret-provider-core/shared/definition";
3 +import * as Schema from "effect/Schema";
4 +
5 +const ACCOUNT_PATTERN = /^[A-Za-z0-9][A-Za-z0-9._-]*$/;
6 +
7 +/**
8 + * Any value `op --account` accepts: shorthand, sign-in address, account ID, or user ID.
9 + * It is passed to the CLI as an argument, so it can never start with `-`.
10 + */
11 +export const OnePasswordAccount = Schema.String.check(
12 + Schema.isMaxLength(253),
13 + Schema.makeFilter((value: string) =>
14 + ACCOUNT_PATTERN.test(value)
15 + ? true
16 + : "1Password account must be a shorthand, sign-in address, or ID with no spaces.",
17 + ),
18 +).pipe(Schema.brand("OnePasswordAccount"));
19 +export type OnePasswordAccount = typeof OnePasswordAccount.Type;
20 +
21 +export const OnePasswordSecretProviderConfig = Schema.Struct({
22 + account: OnePasswordAccount,
23 +});
24 +export type OnePasswordSecretProviderConfig = typeof OnePasswordSecretProviderConfig.Type;
25 +
26 +// 1Password secret reference syntax: names outside this charset must be written as item ids.
27 +// It also keeps `{{`, `}}`, and line breaks out of the `op inject` template the server builds.
28 +const NAME = String.raw`[A-Za-z0-9._-](?:[A-Za-z0-9 ._-]*[A-Za-z0-9._-])?`;
29 +const REFERENCE = new RegExp(
30 + String.raw`^op://${NAME}(?:/${NAME}){2,3}(?:\?[a-z-]+=[A-Za-z0-9_-]+)?$`,
31 +);
32 +const MAX_REFERENCE_LENGTH = 1024;
33 +
34 +export const definition = defineSecretProvider({
35 + kind: SecretProviderKind.make("one_password"),
36 + label: "1Password",
37 + configSchema: OnePasswordSecretProviderConfig,
38 + isReference: (reference) => reference.length <= MAX_REFERENCE_LENGTH && REFERENCE.test(reference),
39 + referencePlaceholder: "op://vault/item/field",
40 + invalidReferenceMessage: "Use a 1Password reference like op://vault/item/field.",
41 +});
packages/secret-provider-onepassword/tsconfig.json new
+7
@@ -0,0 +1,7 @@
1 +{
2 + "extends": "../../tsconfig.base.json",
3 + "compilerOptions": {
4 + "types": ["node"]
5 + },
6 + "include": ["src"]
7 +}
packages/shared/src/serverSettings.test.ts
+1 -2
@@ -1,6 +1,5 @@
1 import {
2 DEFAULT_SERVER_SETTINGS,
3 - OnePasswordAccount,
3 ProjectId,
4 ProviderDriverKind,
5 ProviderInstanceId,
@@ -590,7 +589,7 @@ describe("serverSettings helpers", () => {
589 const onePassword = (label: string, account: string) => ({
590 kind: SecretProviderKind.make("one_password"),
591 label,
593 - config: { account: OnePasswordAccount.make(account) },
592 + config: { account },
593 });
594 const current = {
595 ...DEFAULT_SERVER_SETTINGS,
pnpm-lock.yaml
+77
@@ -955,6 +955,15 @@ importers:
955 '@t3tools/provider-testing':
956 specifier: workspace:*
957 version: link:../../packages/provider-testing
958 + '@t3tools/secret-provider-core':
959 + specifier: workspace:*
960 + version: link:../../packages/secret-provider-core
961 + '@t3tools/secret-provider-definitions':
962 + specifier: workspace:*
963 + version: link:../../packages/secret-provider-definitions
964 + '@t3tools/secret-provider-onepassword':
965 + specifier: workspace:*
966 + version: link:../../packages/secret-provider-onepassword
967 '@t3tools/shared':
968 specifier: workspace:*
969 version: link:../../packages/shared
@@ -1060,6 +1069,12 @@ importers:
1069 '@t3tools/provider-core':
1070 specifier: workspace:*
1071 version: link:../../packages/provider-core
1072 + '@t3tools/secret-provider-definitions':
1073 + specifier: workspace:*
1074 + version: link:../../packages/secret-provider-definitions
1075 + '@t3tools/secret-provider-onepassword':
1076 + specifier: workspace:*
1077 + version: link:../../packages/secret-provider-onepassword
1078 '@t3tools/shared':
1079 specifier: workspace:*
1080 version: link:../../packages/shared
@@ -1890,6 +1905,68 @@ importers:
1905 specifier: 24.12.4
1906 version: 24.12.4
1907
1908 + packages/secret-provider-core:
1909 + dependencies:
1910 + '@t3tools/contracts':
1911 + specifier: workspace:*
1912 + version: link:../contracts
1913 + effect:
1914 + specifier: 4.0.5
1915 + version: 4.0.5
1916 + devDependencies:
1917 + '@effect/platform-node':
1918 + specifier: 4.0.5
1919 + version: 4.0.5(bufferutil@4.1.0)(effect@4.0.5)(redis@6.2.1)(utf-8-validate@6.0.6)
1920 + '@effect/vitest':
1921 + specifier: 4.0.5
1922 + version: 4.0.5(patch_hash=2731c9c3761c595f25ddc625a7d61ca376b389d5b3049ecb837c8940f21cfa02)(@astrojs/compiler-rs@0.5.1)(@tsc-rs/typescript@0.8.0)(@types/node@24.12.4)(@vitest/browser-playwright@5.0.5)(@vitest/ui@5.0.5)(@volar/typescript@2.4.28(@tsc-rs/typescript@0.8.0))(bufferutil@4.1.0)(effect@4.0.5)(esbuild@0.28.2)(jiti@2.7.0)(jsdom@30.1.0(@noble/hashes@1.8.0))(playwright@1.60.0)(terser@5.48.0)(unrun@0.2.39)(utf-8-validate@6.0.6)(yaml@2.9.0)
1923 + '@types/node':
1924 + specifier: 24.12.4
1925 + version: 24.12.4
1926 + vite-plus:
1927 + specifier: 1.4.0
1928 + version: 1.4.0(@astrojs/compiler-rs@0.5.1)(@tsc-rs/typescript@0.8.0)(@types/node@24.12.4)(@vitest/browser-playwright@5.0.5)(@vitest/ui@5.0.5)(@volar/typescript@2.4.28(@tsc-rs/typescript@0.8.0))(bufferutil@4.1.0)(esbuild@0.28.2)(jiti@2.7.0)(jsdom@30.1.0(@noble/hashes@1.8.0))(playwright@1.60.0)(terser@5.48.0)(unrun@0.2.39)(utf-8-validate@6.0.6)(yaml@2.9.0)
1929 +
1930 + packages/secret-provider-definitions:
1931 + dependencies:
1932 + '@t3tools/secret-provider-core':
1933 + specifier: workspace:*
1934 + version: link:../secret-provider-core
1935 + '@t3tools/secret-provider-onepassword':
1936 + specifier: workspace:*
1937 + version: link:../secret-provider-onepassword
1938 +
1939 + packages/secret-provider-onepassword:
1940 + dependencies:
1941 + '@t3tools/contracts':
1942 + specifier: workspace:*
1943 + version: link:../contracts
1944 + '@t3tools/provider-core':
1945 + specifier: workspace:*
1946 + version: link:../provider-core
1947 + '@t3tools/secret-provider-core':
1948 + specifier: workspace:*
1949 + version: link:../secret-provider-core
1950 + '@t3tools/shared':
1951 + specifier: workspace:*
1952 + version: link:../shared
1953 + effect:
1954 + specifier: 4.0.5
1955 + version: 4.0.5
1956 + devDependencies:
1957 + '@effect/platform-node':
1958 + specifier: 4.0.5
1959 + version: 4.0.5(bufferutil@4.1.0)(effect@4.0.5)(redis@6.2.1)(utf-8-validate@6.0.6)
1960 + '@effect/vitest':
1961 + specifier: 4.0.5
1962 + version: 4.0.5(patch_hash=2731c9c3761c595f25ddc625a7d61ca376b389d5b3049ecb837c8940f21cfa02)(@astrojs/compiler-rs@0.5.1)(@tsc-rs/typescript@0.8.0)(@types/node@24.12.4)(@vitest/browser-playwright@5.0.5)(@vitest/ui@5.0.5)(@volar/typescript@2.4.28(@tsc-rs/typescript@0.8.0))(bufferutil@4.1.0)(effect@4.0.5)(esbuild@0.28.2)(jiti@2.7.0)(jsdom@30.1.0(@noble/hashes@1.8.0))(playwright@1.60.0)(terser@5.48.0)(unrun@0.2.39)(utf-8-validate@6.0.6)(yaml@2.9.0)
1963 + '@types/node':
1964 + specifier: 24.12.4
1965 + version: 24.12.4
1966 + vite-plus:
1967 + specifier: 1.4.0
1968 + version: 1.4.0(@astrojs/compiler-rs@0.5.1)(@tsc-rs/typescript@0.8.0)(@types/node@24.12.4)(@vitest/browser-playwright@5.0.5)(@vitest/ui@5.0.5)(@volar/typescript@2.4.28(@tsc-rs/typescript@0.8.0))(bufferutil@4.1.0)(esbuild@0.28.2)(jiti@2.7.0)(jsdom@30.1.0(@noble/hashes@1.8.0))(playwright@1.60.0)(terser@5.48.0)(unrun@0.2.39)(utf-8-validate@6.0.6)(yaml@2.9.0)
1969 +
1970 packages/shared:
1971 dependencies:
1972 '@noble/curves':
scripts/release-smoke.ts
+3
@@ -39,6 +39,9 @@ const workspaceFiles = [
39 "packages/provider-grok/package.json",
40 "packages/provider-muse/package.json",
41 "packages/provider-opencode/package.json",
42 + "packages/secret-provider-core/package.json",
43 + "packages/secret-provider-definitions/package.json",
44 + "packages/secret-provider-onepassword/package.json",
45 "packages/source-control-azure-devops/package.json",
46 "packages/source-control-bitbucket/package.json",
47 "packages/source-control-core/package.json",