Skip to content

Commit 4cc0d5d

Browse files
Merge remote-tracking branch 'origin/main' into fix/issue-30358
2 parents 9ae795d + a104909 commit 4cc0d5d

18 files changed

Lines changed: 462 additions & 96 deletions

‎apps/server/src/serverSettings.test.ts‎

Lines changed: 94 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,15 @@ import * as Path from "effect/Path";
2727
import * as PlatformError from "effect/PlatformError";
2828
import * as Schema from "effect/Schema";
2929
import * as Stream from "effect/Stream";
30+
import * as SchemaAST from "effect/SchemaAST";
3031
import * as SqlClient from "effect/sql/SqlClient";
3132
import * as ServerSecretStore from "./auth/ServerSecretStore.ts";
3233
import { sourceControlHostSecretName } from "./sourceControl/sourceControlHostSecrets.ts";
3334
import * as ServerConfig from "./config.ts";
3435
import * as SqlitePersistence from "./persistence/Sqlite.ts";
3536
import { writeFileStringAtomically } from "@t3tools/shared/atomicWrite";
3637
import * as ServerSettingsModule from "./serverSettings.ts";
38+
import { SECRET_REDACTED } from "./settingsSecrets.ts";
3739
import * as ManagedPolicy from "./policy/ManagedPolicy.ts";
3840
import { resolveProviderInstanceTerminalEnvironment } from "./terminal/Manager.ts";
3941

@@ -102,6 +104,36 @@ const recordProviderUsage = (provider: string, instanceId: string | null = provi
102104
`;
103105
});
104106

107+
/** Paths of fields typed `SettingsSecretValue` that clients decode with the settings schema itself. */
108+
function strictSecretReferencePaths(
109+
ast: SchemaAST.AST,
110+
path = "",
111+
seen = new Set<SchemaAST.AST>(),
112+
): ReadonlyArray<string> {
113+
if (seen.has(ast)) return [];
114+
seen.add(ast);
115+
const walk = (type: SchemaAST.AST, at: string): ReadonlyArray<string> =>
116+
type.context?.annotations?.settingsSecretReference === true
117+
? [at]
118+
: strictSecretReferencePaths(type, `${at}.`, seen);
119+
if (SchemaAST.isObjects(ast)) {
120+
return [
121+
...ast.propertySignatures.flatMap((property) =>
122+
walk(property.type, `${path}${String(property.name)}`),
123+
),
124+
...ast.indexSignatures.flatMap((signature) => walk(signature.type, `${path}*`)),
125+
];
126+
}
127+
if (SchemaAST.isArrays(ast)) {
128+
return [...ast.elements, ...ast.rest].flatMap((element) => walk(element, `${path}[]`));
129+
}
130+
if (SchemaAST.isUnion(ast)) {
131+
return ast.types.flatMap((member) => strictSecretReferencePaths(member, path, seen));
132+
}
133+
if (SchemaAST.isSuspend(ast)) return strictSecretReferencePaths(ast.thunk(), path, seen);
134+
return [];
135+
}
136+
105137
it.layer(Layer.mergeAll(NodeServices.layer, NodeCrypto.layer))("server settings", (it) => {
106138
it.effect("serializes concurrent model preference edits without cancelling duplicate adds", () =>
107139
Effect.gen(function* () {
@@ -278,7 +310,8 @@ it.layer(Layer.mergeAll(NodeServices.layer, NodeCrypto.layer))("server settings"
278310
},
279311
});
280312
assert.deepStrictEqual<unknown>(
281-
ServerSettingsModule.redactServerSettingsForClient(settings).secretProviders,
313+
ServerSettingsModule.redactServerSettingsForClient(settings, { secretReferences: true })
314+
.secretProviders,
282315
{
283316
personal: { kind: "one_password", label: "Personal", config: { account: "my" } },
284317
vault: { kind: "openbao", label: "Vault" },
@@ -1331,7 +1364,9 @@ it.layer(Layer.mergeAll(NodeServices.layer, NodeCrypto.layer))("server settings"
13311364
"quota-secret",
13321365
"expo-secret",
13331366
];
1334-
const client = ServerSettingsModule.redactServerSettingsForClient(saved);
1367+
const client = ServerSettingsModule.redactServerSettingsForClient(saved, {
1368+
secretReferences: true,
1369+
});
13351370
const disk = yield* fs.readFileString(config.settingsPath);
13361371
for (const value of values) {
13371372
assert.include(JSON.stringify(saved), value);
@@ -1365,7 +1400,9 @@ it.layer(Layer.mergeAll(NodeServices.layer, NodeCrypto.layer))("server settings"
13651400
instance: { ...client.providerInstances[instanceId]!, config: { apiKey } },
13661401
});
13671402
assert.propertyVal(changed.providerInstances[instanceId]?.config, "apiKey", apiKey);
1368-
const redacted = ServerSettingsModule.redactServerSettingsForClient(changed);
1403+
const redacted = ServerSettingsModule.redactServerSettingsForClient(changed, {
1404+
secretReferences: true,
1405+
});
13691406
assert.propertyVal(
13701407
redacted.providerInstances[instanceId]?.config,
13711408
"apiKey",
@@ -1414,9 +1451,8 @@ it.layer(Layer.mergeAll(NodeServices.layer, NodeCrypto.layer))("server settings"
14141451
});
14151452
assert.isTrue(Option.isNone(yield* store.get(secretNames[1]!)));
14161453
assert.deepEqual(
1417-
ServerSettingsModule.redactServerSettingsForClient(referenced).providerInstances[
1418-
instanceId
1419-
]?.environment,
1454+
ServerSettingsModule.redactServerSettingsForClient(referenced, { secretReferences: true })
1455+
.providerInstances[instanceId]?.environment,
14201456
[{ name: "API_TOKEN", value: secret, sensitive: true }],
14211457
);
14221458
yield* service.updateSettings({
@@ -1463,7 +1499,9 @@ it.layer(Layer.mergeAll(NodeServices.layer, NodeCrypto.layer))("server settings"
14631499
"serverPassword",
14641500
"legacy-password",
14651501
);
1466-
const client = ServerSettingsModule.redactServerSettingsForClient(saved);
1502+
const client = ServerSettingsModule.redactServerSettingsForClient(saved, {
1503+
secretReferences: true,
1504+
});
14671505
for (const value of ["legacy-api-key", "legacy-password"]) {
14681506
assert.notInclude(yield* fs.readFileString(config.settingsPath), value);
14691507
assert.notInclude(JSON.stringify(client), value);
@@ -1507,8 +1545,9 @@ it.layer(Layer.mergeAll(NodeServices.layer, NodeCrypto.layer))("server settings"
15071545
for (const secret of ["bb-access", "ghp_dotcom", "ghp_ghe"]) assert.notInclude(raw, secret);
15081546
assert.include(raw, "[email protected]");
15091547

1510-
const forClient =
1511-
ServerSettingsModule.redactServerSettingsForClient(saved).sourceControlHosts;
1548+
const forClient = ServerSettingsModule.redactServerSettingsForClient(saved, {
1549+
secretReferences: true,
1550+
}).sourceControlHosts;
15121551
assert.equal(forClient.bitbucket?.email, "[email protected]");
15131552
assert.notInclude(String(forClient.bitbucket?.accessToken), "bb-access");
15141553
assert.isAbove(String(forClient.bitbucket?.accessToken).length, 0);
@@ -1570,15 +1609,59 @@ it.layer(Layer.mergeAll(NodeServices.layer, NodeCrypto.layer))("server settings"
15701609
assert.isTrue(Option.isNone(yield* stored("bitbucket", "accessToken", null)));
15711610
assert.isTrue(Option.isNone(yield* stored("github", "tokens", "github.com")));
15721611
assert.isTrue(Option.isSome(yield* stored("github", "tokens", "ghe.acme.test")));
1573-
const redacted =
1574-
ServerSettingsModule.redactServerSettingsForClient(referenced).sourceControlHosts;
1612+
const redacted = ServerSettingsModule.redactServerSettingsForClient(referenced, {
1613+
secretReferences: true,
1614+
}).sourceControlHosts;
15751615
assert.deepEqual(redacted.bitbucket?.accessToken, reference);
15761616
const tokens = redacted.github?.tokens as Record<string, unknown>;
15771617
assert.deepEqual(tokens["github.com"], gitHubReference);
15781618
assert.notEqual(tokens["ghe.acme.test"], "ghp_ghe");
1619+
1620+
// A client that cannot decode references sees saved secrets and can send them back.
1621+
const usageReference = {
1622+
provider: SecretProviderId.make("personal"),
1623+
reference: "op://Private/Hub/key",
1624+
};
1625+
const hub = UsageLimitSourceId.make("hub");
1626+
const withUsage = yield* serverSettings.updateSettings({
1627+
usageLimitSources: {
1628+
[hub]: {
1629+
kind: "cliproxy",
1630+
url: "https://hub.test",
1631+
managementKey: usageReference,
1632+
enabled: true,
1633+
},
1634+
},
1635+
});
1636+
const legacy = ServerSettingsModule.redactServerSettingsForClient(withUsage, {
1637+
secretReferences: false,
1638+
});
1639+
assert.notInclude(JSON.stringify(legacy), "op://");
1640+
assert.equal(legacy.sourceControlHosts.bitbucket?.accessToken, SECRET_REDACTED);
1641+
assert.equal(legacy.usageLimitSources[hub]?.managementKey, SECRET_REDACTED);
1642+
const echoed = yield* serverSettings.updateSettings({
1643+
sourceControlHosts: legacy.sourceControlHosts,
1644+
usageLimitSources: legacy.usageLimitSources,
1645+
});
1646+
assert.deepEqual(echoed.sourceControlHosts.bitbucket?.accessToken, reference);
1647+
assert.deepEqual(echoed.sourceControlHosts.github?.tokens, {
1648+
"github.com": gitHubReference,
1649+
"ghe.acme.test": "ghp_ghe",
1650+
});
1651+
assert.deepEqual(echoed.usageLimitSources[hub]?.managementKey, usageReference);
1652+
assert.isTrue(Option.isSome(yield* stored("github", "tokens", "ghe.acme.test")));
15791653
}).pipe(Effect.provide(layerServerSettingsWithSecrets())),
15801654
);
15811655

1656+
it.effect("knows every strictly decoded field that can hold a secret reference", () =>
1657+
Effect.sync(() => {
1658+
// Shipped clients decode these as strings. Each must be covered by the older-client case above.
1659+
assert.deepEqual(strictSecretReferencePaths(ServerSettings.ast), [
1660+
"usageLimitSources.*.managementKey",
1661+
]);
1662+
}),
1663+
);
1664+
15821665
it.effect("keeps the retired keys for another load when a token cannot be copied", () => {
15831666
const cause = new ServerSecretStore.SecretStoreReadError({
15841667
resource: "bitbucket-access-token",

‎apps/server/src/serverSettings.ts‎

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ import {
1818
type ServerSettingsPatch,
1919
type ManagedPolicySummary,
2020
globalIdleCompaction,
21+
isSecretReference,
22+
type SecretReference,
2123
withIdleCompaction,
2224
} from "@t3tools/contracts";
2325
import * as Cache from "effect/Cache";
@@ -60,7 +62,12 @@ import {
6062
sourceControlHostSecretName,
6163
} from "./sourceControl/sourceControlHostSecrets.ts";
6264

63-
import { mapSettingsSecrets, SECRET_REDACTED, type SettingsSecret } from "./settingsSecrets.ts";
65+
import {
66+
mapSettingsSecrets,
67+
mapSettingsSecretValues,
68+
SECRET_REDACTED,
69+
type SettingsSecret,
70+
} from "./settingsSecrets.ts";
6471

6572
export {
6673
resolveReviewGuideModelSelection,
@@ -131,13 +138,35 @@ const normalizeServerSettings = (
131138
),
132139
);
133140

134-
export function redactServerSettingsForClient(settings: ServerSettings): ServerSettings {
141+
export function redactServerSettingsForClient(
142+
settings: ServerSettings,
143+
client: { readonly secretReferences: boolean },
144+
): ServerSettings {
135145
const redacted = mapSettingsSecrets(settings, (secret) =>
136146
secret.sensitive
137147
? { value: "", redacted: secret.redacted || secret.value.length > 0 }
138148
: { value: secret.value, redacted: false },
139149
);
140-
return { ...redacted, secretProviders: withoutUnknownSecretProviderConfigs(redacted) };
150+
// Older clients decode secret fields as strings and fail on a reference, so they see a saved secret.
151+
const shaped = client.secretReferences
152+
? redacted
153+
: mapSettingsSecretValues(redacted, (value) =>
154+
isSecretReference(value) ? SECRET_REDACTED : value,
155+
);
156+
return { ...shaped, secretProviders: withoutUnknownSecretProviderConfigs(shaped) };
157+
}
158+
159+
/** A client shown a reference as a saved secret sends that marker back; it keeps the reference. */
160+
function withEchoedSecretReferences(current: ServerSettings, next: ServerSettings): ServerSettings {
161+
const references = new Map<string, SecretReference>();
162+
mapSettingsSecretValues(current, (value, secretName) => {
163+
if (isSecretReference(value)) references.set(secretName, value);
164+
return value;
165+
});
166+
if (references.size === 0) return next;
167+
return mapSettingsSecretValues(next, (value, secretName) =>
168+
value === SECRET_REDACTED ? (references.get(secretName) ?? value) : value,
169+
);
141170
}
142171

143172
// A newer kind's config may hold credentials this build cannot recognize, so it never leaves the server.
@@ -1004,7 +1033,7 @@ const make = Effect.gen(function* () {
10041033
});
10051034
const changes: SecretChange[] = [];
10061035
const nextSecretNames = new Set<string>();
1007-
const settings = mapSettingsSecrets(next, (secret) => {
1036+
const settings = mapSettingsSecrets(withEchoedSecretReferences(current, next), (secret) => {
10081037
const metadata = {
10091038
secretName: secret.secretName,
10101039
...(secret.providerInstanceId !== undefined

‎apps/server/src/settingsSecrets.ts‎

Lines changed: 75 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ import {
33
ClaudeSettings,
44
CodexSettings,
55
EasDeviceHostConfig,
6+
type ProviderInstanceConfig,
67
type ServerSettings,
8+
type SettingsSecretValue,
79
SimlockDeviceHostConfig,
810
UsageLimitSourceConfig,
911
isSecretReference,
@@ -58,16 +60,19 @@ export interface SettingsSecret {
5860
}
5961

6062
type SecretValue = Pick<SettingsSecret, "value" | "redacted">;
63+
type SecretSlotName = (field: string, serverHost: string | null) => string;
64+
type SecretFieldsMapper = (
65+
fields: Readonly<Record<string, unknown>>,
66+
secretFields: ReadonlyArray<string>,
67+
name: SecretSlotName,
68+
) => Record<string, unknown>;
69+
type ProviderEnvironment = NonNullable<ProviderInstanceConfig["environment"]>;
6170

6271
export function mapSettingsSecrets(
6372
settings: ServerSettings,
6473
map: (secret: SettingsSecret) => SecretValue,
6574
): ServerSettings {
66-
const mapFields = (
67-
fields: Readonly<Record<string, unknown>>,
68-
secretFields: ReadonlyArray<string>,
69-
name: (field: string, serverHost: string | null) => string,
70-
) => {
75+
const mapFields: SecretFieldsMapper = (fields, secretFields, name) => {
7176
const next = { ...fields };
7277
for (const field of secretFields) {
7378
if (!(field in next) || isSecretReference(next[field])) continue;
@@ -88,6 +93,70 @@ export function mapSettingsSecrets(
8893
return next;
8994
};
9095

96+
return mapSecretFieldGroups(settings, mapFields, (instanceId, environment) =>
97+
environment.map((variable) => {
98+
const { valueRedacted: _omit, ...rest } = variable;
99+
// A secret reference is not itself secret; storage sees the value cleared.
100+
const reference = typeof variable.value === "string" ? undefined : variable.value;
101+
const result = map({
102+
secretName: `provider-env-${encode(instanceId)}-${encode(variable.name)}`,
103+
kind: "environment",
104+
value: typeof variable.value === "string" ? variable.value : "",
105+
redacted: reference === undefined && variable.valueRedacted === true,
106+
sensitive: variable.sensitive,
107+
providerInstanceId: instanceId,
108+
environmentVariable: variable.name,
109+
});
110+
if (reference !== undefined) return { ...rest, value: reference };
111+
return {
112+
...rest,
113+
value: result.value,
114+
...(result.redacted ? { valueRedacted: true } : {}),
115+
};
116+
}),
117+
);
118+
}
119+
120+
/**
121+
* Maps each value a secret field holds, literal or reference, with the secret name of its slot.
122+
* Provider environment variables are left as they are.
123+
*/
124+
export function mapSettingsSecretValues(
125+
settings: ServerSettings,
126+
map: (value: SettingsSecretValue, secretName: string) => SettingsSecretValue,
127+
): ServerSettings {
128+
const mapValue = (value: unknown, secretName: string) =>
129+
typeof value === "string" || isSecretReference(value) ? map(value, secretName) : value;
130+
return mapSecretFieldGroups(settings, (fields, secretFields, name) => {
131+
const next = { ...fields };
132+
for (const field of secretFields) {
133+
if (!(field in next)) continue;
134+
const value = next[field];
135+
next[field] =
136+
value !== null &&
137+
typeof value === "object" &&
138+
!Array.isArray(value) &&
139+
!isSecretReference(value)
140+
? Object.fromEntries(
141+
Object.entries(value).map(([serverHost, entry]) => [
142+
serverHost,
143+
mapValue(entry, name(field, serverHost.trim().toLowerCase())),
144+
]),
145+
)
146+
: mapValue(value, name(field, null));
147+
}
148+
return next;
149+
});
150+
}
151+
152+
function mapSecretFieldGroups(
153+
settings: ServerSettings,
154+
mapFields: SecretFieldsMapper,
155+
mapEnvironment: (instanceId: string, environment: ProviderEnvironment) => ProviderEnvironment = (
156+
_instanceId,
157+
environment,
158+
) => environment,
159+
): ServerSettings {
91160
const providerInstances = Object.fromEntries(
92161
Object.entries(settings.providerInstances).map(([instanceId, instance]) => {
93162
const config = instance.config;
@@ -107,28 +176,7 @@ export function mapSettingsSecrets(
107176
}
108177
: {}),
109178
...(instance.environment
110-
? {
111-
environment: instance.environment.map((variable) => {
112-
const { valueRedacted: _omit, ...rest } = variable;
113-
// A secret reference is not itself secret; storage sees the value cleared.
114-
const reference = typeof variable.value === "string" ? undefined : variable.value;
115-
const result = map({
116-
secretName: `provider-env-${encode(instanceId)}-${encode(variable.name)}`,
117-
kind: "environment",
118-
value: typeof variable.value === "string" ? variable.value : "",
119-
redacted: reference === undefined && variable.valueRedacted === true,
120-
sensitive: variable.sensitive,
121-
providerInstanceId: instanceId,
122-
environmentVariable: variable.name,
123-
});
124-
if (reference !== undefined) return { ...rest, value: reference };
125-
return {
126-
...rest,
127-
value: result.value,
128-
...(result.redacted ? { valueRedacted: true } : {}),
129-
};
130-
}),
131-
}
179+
? { environment: mapEnvironment(instanceId, instance.environment) }
132180
: {}),
133181
},
134182
];

0 commit comments

Comments
 (0)