@@ -27,13 +27,15 @@ import * as Path from "effect/Path";
2727import * as PlatformError from "effect/PlatformError" ;
2828import * as Schema from "effect/Schema" ;
2929import * as Stream from "effect/Stream" ;
30+ import * as SchemaAST from "effect/SchemaAST" ;
3031import * as SqlClient from "effect/sql/SqlClient" ;
3132import * as ServerSecretStore from "./auth/ServerSecretStore.ts" ;
3233import { sourceControlHostSecretName } from "./sourceControl/sourceControlHostSecrets.ts" ;
3334import * as ServerConfig from "./config.ts" ;
3435import * as SqlitePersistence from "./persistence/Sqlite.ts" ;
3536import { writeFileStringAtomically } from "@t3tools/shared/atomicWrite" ;
3637import * as ServerSettingsModule from "./serverSettings.ts" ;
38+ import { SECRET_REDACTED } from "./settingsSecrets.ts" ;
3739import * as ManagedPolicy from "./policy/ManagedPolicy.ts" ;
3840import { 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+
105137it . 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" ,
0 commit comments