The best way to control Claude Code, Codex and more from any computer or phone
| 1 | import { |
| 2 | CLIENT_GUARDED_RPC_SCOPES, |
| 3 | type DeviceListInput, |
| 4 | clientRpcRequiredScopes, |
| 5 | containsSecretReference, |
| 6 | authScopeRequiredResponse, |
| 7 | AssetCreateUrlInput, |
| 8 | AuthAccessReadScope, |
| 9 | ServerSettingsPatch, |
| 10 | ProviderInstanceMutation, |
| 11 | requiredScopesForServerSettingsPatch, |
| 12 | requiredScopesForProjectMutation, |
| 13 | ProjectMutation, |
| 14 | AuthSettingsWriteScope, |
| 15 | AuthProvidersManageScope, |
| 16 | AuthEnvironmentMaintainScope, |
| 17 | AuthFilesystemReadScope, |
| 18 | AuthFilesystemWriteScope, |
| 19 | AuthDiagnosticsReadScope, |
| 20 | AuthOrchestrationOperateScope, |
| 21 | AuthOrchestrationReadScope, |
| 22 | AuthPreviewOperateScope, |
| 23 | AuthRelayReadScope, |
| 24 | AuthRelayWriteScope, |
| 25 | AuthTerminalOperateScope, |
| 26 | ORCHESTRATION_V2_WS_METHODS, |
| 27 | type OrchestrationV2Command, |
| 28 | type OrchestrationV2ThreadLaunchInput, |
| 29 | AuthTerminalReadScope, |
| 30 | type AuthEnvironmentScope, |
| 31 | EnvironmentAuthorizationError, |
| 32 | RpcScopeAuthorization, |
| 33 | WS_METHODS, |
| 34 | WsRpcGroup, |
| 35 | } from "@t3tools/contracts"; |
| 36 | import * as Effect from "effect/Effect"; |
| 37 | import * as Schema from "effect/Schema"; |
| 38 | import * as Layer from "effect/Layer"; |
| 39 | import type * as RpcGroup from "effect/rpc/RpcGroup"; |
| 40 | import { isProviderSignOutPrompt } from "../orchestration-v2/CommandPolicy.ts"; |
| 41 | |
| 42 | type WsRpcMethod = RpcGroup.Rpcs<typeof WsRpcGroup>["_tag"]; |
| 43 | |
| 44 | export const RPC_REQUIRED_SCOPES = { |
| 45 | ...CLIENT_GUARDED_RPC_SCOPES, |
| 46 | [ORCHESTRATION_V2_WS_METHODS.dispatchCommand]: AuthOrchestrationOperateScope, |
| 47 | [ORCHESTRATION_V2_WS_METHODS.getWorkflowScript]: AuthOrchestrationReadScope, |
| 48 | [ORCHESTRATION_V2_WS_METHODS.getNativeChildWork]: AuthOrchestrationReadScope, |
| 49 | [ORCHESTRATION_V2_WS_METHODS.stopWorkflow]: AuthOrchestrationOperateScope, |
| 50 | [ORCHESTRATION_V2_WS_METHODS.forceStopThread]: AuthOrchestrationOperateScope, |
| 51 | [ORCHESTRATION_V2_WS_METHODS.getTurnDiff]: AuthOrchestrationReadScope, |
| 52 | [ORCHESTRATION_V2_WS_METHODS.getFullThreadDiff]: AuthOrchestrationReadScope, |
| 53 | [ORCHESTRATION_V2_WS_METHODS.searchThreads]: AuthOrchestrationReadScope, |
| 54 | [ORCHESTRATION_V2_WS_METHODS.searchThread]: AuthOrchestrationReadScope, |
| 55 | [ORCHESTRATION_V2_WS_METHODS.searchThreadStream]: AuthOrchestrationReadScope, |
| 56 | [ORCHESTRATION_V2_WS_METHODS.getArchivedShellSnapshot]: AuthOrchestrationReadScope, |
| 57 | [ORCHESTRATION_V2_WS_METHODS.getThreadFamily]: AuthOrchestrationReadScope, |
| 58 | [ORCHESTRATION_V2_WS_METHODS.getThreadTitles]: AuthOrchestrationReadScope, |
| 59 | [ORCHESTRATION_V2_WS_METHODS.getThreadLinkMetadata]: AuthOrchestrationReadScope, |
| 60 | [ORCHESTRATION_V2_WS_METHODS.getWorktreeThreadIds]: AuthOrchestrationReadScope, |
| 61 | [ORCHESTRATION_V2_WS_METHODS.getOlderSettledThreads]: AuthOrchestrationReadScope, |
| 62 | [ORCHESTRATION_V2_WS_METHODS.getThreadProjection]: AuthOrchestrationReadScope, |
| 63 | [ORCHESTRATION_V2_WS_METHODS.getTurnItem]: AuthOrchestrationReadScope, |
| 64 | [ORCHESTRATION_V2_WS_METHODS.launchThread]: AuthOrchestrationOperateScope, |
| 65 | [ORCHESTRATION_V2_WS_METHODS.subscribeShell]: AuthOrchestrationReadScope, |
| 66 | [ORCHESTRATION_V2_WS_METHODS.subscribeThread]: AuthOrchestrationReadScope, |
| 67 | [ORCHESTRATION_V2_WS_METHODS.subscribeCommandOutput]: AuthOrchestrationReadScope, |
| 68 | [ORCHESTRATION_V2_WS_METHODS.subscribePromptSuggestion]: AuthOrchestrationReadScope, |
| 69 | [WS_METHODS.projectsMutate]: AuthOrchestrationOperateScope, |
| 70 | [WS_METHODS.serverProbe]: AuthOrchestrationReadScope, |
| 71 | [WS_METHODS.serverGetConfig]: AuthOrchestrationReadScope, |
| 72 | [WS_METHODS.serverGetNpmRelease]: AuthOrchestrationReadScope, |
| 73 | [WS_METHODS.serverRefreshProviders]: AuthOrchestrationReadScope, |
| 74 | [WS_METHODS.serverUpdateProvider]: AuthProvidersManageScope, |
| 75 | [WS_METHODS.providerAuthStart]: AuthProvidersManageScope, |
| 76 | [WS_METHODS.providerConsumeResetCredit]: AuthProvidersManageScope, |
| 77 | [WS_METHODS.providerAuthComplete]: AuthProvidersManageScope, |
| 78 | [WS_METHODS.providerMcpSignInStart]: AuthProvidersManageScope, |
| 79 | [WS_METHODS.providerMcpSignInComplete]: AuthProvidersManageScope, |
| 80 | [WS_METHODS.chatGptReconnectProfile]: AuthProvidersManageScope, |
| 81 | [WS_METHODS.chatGptImportProfile]: AuthProvidersManageScope, |
| 82 | [WS_METHODS.chatGptHandoffSubscribe]: AuthProvidersManageScope, |
| 83 | [WS_METHODS.providerAuthRespond]: AuthProvidersManageScope, |
| 84 | [WS_METHODS.providerAuthCancel]: AuthProvidersManageScope, |
| 85 | [WS_METHODS.providerAuthRemoveMethod]: AuthProvidersManageScope, |
| 86 | [WS_METHODS.providerAuthLogout]: AuthProvidersManageScope, |
| 87 | [WS_METHODS.providerAuthSubscribe]: AuthProvidersManageScope, |
| 88 | [WS_METHODS.providerInstallStart]: AuthProvidersManageScope, |
| 89 | [WS_METHODS.providerInstallCancel]: AuthProvidersManageScope, |
| 90 | [WS_METHODS.providerInstallSubscribe]: AuthOrchestrationReadScope, |
| 91 | [WS_METHODS.providerInstallRemove]: AuthProvidersManageScope, |
| 92 | [WS_METHODS.serverUpdateServer]: AuthEnvironmentMaintainScope, |
| 93 | [WS_METHODS.serverUpdateServerWithProgress]: AuthEnvironmentMaintainScope, |
| 94 | [WS_METHODS.serverCommitDesktopUpdate]: AuthEnvironmentMaintainScope, |
| 95 | [WS_METHODS.serverUpsertKeybinding]: AuthSettingsWriteScope, |
| 96 | [WS_METHODS.serverRemoveKeybinding]: AuthSettingsWriteScope, |
| 97 | [WS_METHODS.serverGetStorageCleanupReport]: AuthOrchestrationReadScope, |
| 98 | [WS_METHODS.serverGetDatabaseStorage]: AuthOrchestrationReadScope, |
| 99 | [WS_METHODS.serverGetSettings]: AuthOrchestrationReadScope, |
| 100 | [WS_METHODS.peerLinksList]: AuthAccessReadScope, |
| 101 | // Names only, so a client that reads threads can open a linked environment's. |
| 102 | [WS_METHODS.peerLinksNames]: AuthOrchestrationReadScope, |
| 103 | // A linked environment's thread is read as this one's own are. |
| 104 | [WS_METHODS.peerLinksSubscribeThread]: AuthOrchestrationReadScope, |
| 105 | [WS_METHODS.peerLinksThreadHistoryPage]: AuthOrchestrationReadScope, |
| 106 | [WS_METHODS.peerLinksThreadItem]: AuthOrchestrationReadScope, |
| 107 | [WS_METHODS.serverUpdateSettings]: AuthSettingsWriteScope, |
| 108 | [WS_METHODS.serverSearchAcpRegistry]: AuthOrchestrationReadScope, |
| 109 | [WS_METHODS.serverPrepareAcpRegistryAgent]: AuthProvidersManageScope, |
| 110 | [WS_METHODS.serverUninstallAcpRegistryManagedBinary]: AuthProvidersManageScope, |
| 111 | [WS_METHODS.serverAcceptAcpRegistryUrlAuth]: AuthProvidersManageScope, |
| 112 | [WS_METHODS.serverListAcpRegistrySessions]: AuthOrchestrationReadScope, |
| 113 | [WS_METHODS.serverImportAcpRegistrySession]: AuthOrchestrationOperateScope, |
| 114 | [WS_METHODS.serverDeleteAcpRegistrySession]: AuthOrchestrationOperateScope, |
| 115 | [WS_METHODS.serverListAcpRegistryProviders]: AuthOrchestrationReadScope, |
| 116 | [WS_METHODS.serverSetAcpRegistryProvider]: AuthProvidersManageScope, |
| 117 | [WS_METHODS.serverDisableAcpRegistryProvider]: AuthProvidersManageScope, |
| 118 | [WS_METHODS.serverLogoutAcpRegistry]: AuthProvidersManageScope, |
| 119 | [WS_METHODS.serverDiscoverSourceControl]: AuthOrchestrationReadScope, |
| 120 | [WS_METHODS.serverGetTraceDiagnostics]: AuthDiagnosticsReadScope, |
| 121 | [WS_METHODS.serverGetProcessDiagnostics]: AuthDiagnosticsReadScope, |
| 122 | // Thread load balancing reads host load, so it needs thread scope rather than diagnostics scope. |
| 123 | [WS_METHODS.serverGetHostResources]: AuthOrchestrationReadScope, |
| 124 | [WS_METHODS.serverGetProcessResourceHistory]: AuthDiagnosticsReadScope, |
| 125 | [WS_METHODS.serverGetResourceTelemetryHistory]: AuthDiagnosticsReadScope, |
| 126 | [WS_METHODS.serverRetryResourceTelemetry]: AuthDiagnosticsReadScope, |
| 127 | [WS_METHODS.serverGetUsageSummary]: AuthDiagnosticsReadScope, |
| 128 | [WS_METHODS.serverRefreshUsageRates]: AuthDiagnosticsReadScope, |
| 129 | [WS_METHODS.serverSignalProcess]: AuthEnvironmentMaintainScope, |
| 130 | [WS_METHODS.serverReportClientActivity]: AuthOrchestrationReadScope, |
| 131 | [WS_METHODS.scheduledTasksSubscribe]: AuthOrchestrationReadScope, |
| 132 | [WS_METHODS.secretsAnswerRequest]: AuthOrchestrationOperateScope, |
| 133 | // Delivery logs hold request bodies, so they need the same scope as the URL. |
| 134 | [WS_METHODS.scheduledTasksListWebhookDeliveries]: AuthOrchestrationOperateScope, |
| 135 | [WS_METHODS.scheduledTasksGetWebhookDelivery]: AuthOrchestrationOperateScope, |
| 136 | [WS_METHODS.cloudGetRelayClientStatus]: AuthRelayReadScope, |
| 137 | [WS_METHODS.cloudInstallRelayClient]: AuthRelayWriteScope, |
| 138 | [WS_METHODS.pullRequestsList]: AuthOrchestrationReadScope, |
| 139 | [WS_METHODS.pullRequestsListStats]: AuthOrchestrationReadScope, |
| 140 | [WS_METHODS.pullRequestsFilterOptions]: AuthOrchestrationReadScope, |
| 141 | [WS_METHODS.pullRequestsSummary]: AuthOrchestrationReadScope, |
| 142 | [WS_METHODS.pullRequestsRouting]: AuthOrchestrationReadScope, |
| 143 | [WS_METHODS.pullRequestsRoutingIdentity]: AuthOrchestrationReadScope, |
| 144 | [WS_METHODS.pullRequestsStack]: AuthOrchestrationReadScope, |
| 145 | [WS_METHODS.pullRequestsLinkedThreads]: AuthOrchestrationReadScope, |
| 146 | [WS_METHODS.pullRequestsDetail]: AuthOrchestrationReadScope, |
| 147 | [WS_METHODS.issuesList]: AuthOrchestrationReadScope, |
| 148 | [WS_METHODS.issuesDetail]: AuthOrchestrationReadScope, |
| 149 | [WS_METHODS.issuesComments]: AuthOrchestrationReadScope, |
| 150 | [WS_METHODS.issuesTemplates]: AuthOrchestrationReadScope, |
| 151 | [WS_METHODS.issuesCandidates]: AuthOrchestrationReadScope, |
| 152 | [WS_METHODS.issuesLinkedThreads]: AuthOrchestrationReadScope, |
| 153 | [WS_METHODS.issueTrackersList]: AuthOrchestrationReadScope, |
| 154 | [WS_METHODS.issueTrackersConnect]: AuthSettingsWriteScope, |
| 155 | [WS_METHODS.issueTrackersBindProject]: AuthSettingsWriteScope, |
| 156 | [WS_METHODS.pullRequestsPreview]: AuthOrchestrationReadScope, |
| 157 | [WS_METHODS.pullRequestsChecks]: AuthOrchestrationReadScope, |
| 158 | [WS_METHODS.pullRequestsActivity]: AuthOrchestrationReadScope, |
| 159 | [WS_METHODS.pullRequestsReviewGuide]: AuthOrchestrationReadScope, |
| 160 | [WS_METHODS.pullRequestsThreadComments]: AuthOrchestrationReadScope, |
| 161 | [WS_METHODS.pullRequestsDiffFileContents]: AuthOrchestrationReadScope, |
| 162 | [WS_METHODS.pullRequestsFilesViewed]: AuthOrchestrationReadScope, |
| 163 | [WS_METHODS.pullRequestsChangeBreakdown]: AuthOrchestrationReadScope, |
| 164 | [WS_METHODS.pullRequestsInvalidate]: AuthOrchestrationReadScope, |
| 165 | [WS_METHODS.pullRequestsReportState]: AuthOrchestrationReadScope, |
| 166 | [WS_METHODS.pullRequestsSubscribeRefreshes]: AuthOrchestrationReadScope, |
| 167 | [WS_METHODS.pullRequestsSubscribeLinkedThreadRefreshes]: AuthOrchestrationReadScope, |
| 168 | [WS_METHODS.pullRequestsReviewerCandidates]: AuthOrchestrationReadScope, |
| 169 | [WS_METHODS.pullRequestsLabelCandidates]: AuthOrchestrationReadScope, |
| 170 | [WS_METHODS.sourceControlLookupRepository]: AuthOrchestrationReadScope, |
| 171 | [WS_METHODS.sourceControlAppAccess]: AuthOrchestrationReadScope, |
| 172 | [WS_METHODS.sourceControlStarred]: AuthOrchestrationReadScope, |
| 173 | [WS_METHODS.subscribeProjectClones]: AuthOrchestrationReadScope, |
| 174 | [WS_METHODS.projectsListEntries]: AuthFilesystemReadScope, |
| 175 | [WS_METHODS.projectsListIgnoredFiles]: AuthFilesystemReadScope, |
| 176 | [WS_METHODS.projectsReadFile]: AuthFilesystemReadScope, |
| 177 | [WS_METHODS.projectsSearchContents]: AuthFilesystemReadScope, |
| 178 | [WS_METHODS.projectsSearchEntries]: AuthFilesystemReadScope, |
| 179 | [WS_METHODS.projectsWriteFile]: AuthFilesystemWriteScope, |
| 180 | [WS_METHODS.projectsEnsureScratch]: AuthOrchestrationOperateScope, |
| 181 | [WS_METHODS.projectsCreateNew]: AuthOrchestrationOperateScope, |
| 182 | [WS_METHODS.shellOpenInEditor]: AuthOrchestrationOperateScope, |
| 183 | [WS_METHODS.filesystemBrowse]: AuthFilesystemReadScope, |
| 184 | [WS_METHODS.filesystemGetMetadata]: AuthFilesystemReadScope, |
| 185 | [WS_METHODS.agentSessionsScan]: AuthOrchestrationReadScope, |
| 186 | [WS_METHODS.agentSessionsImport]: AuthOrchestrationOperateScope, |
| 187 | [WS_METHODS.assetsCreateUrl]: AuthOrchestrationReadScope, |
| 188 | [WS_METHODS.assetsPersistChatAttachments]: AuthOrchestrationOperateScope, |
| 189 | [WS_METHODS.attachmentsCreateUploadUrl]: AuthOrchestrationOperateScope, |
| 190 | [WS_METHODS.attachmentsDelete]: AuthOrchestrationOperateScope, |
| 191 | [WS_METHODS.providerUploadFeedback]: AuthOrchestrationOperateScope, |
| 192 | [WS_METHODS.mcpAppsCallTool]: AuthOrchestrationOperateScope, |
| 193 | [WS_METHODS.mcpAppsToolInfo]: AuthOrchestrationReadScope, |
| 194 | [WS_METHODS.mcpAppsReadResource]: AuthOrchestrationReadScope, |
| 195 | [WS_METHODS.mcpAppsUpdateModelContext]: AuthOrchestrationOperateScope, |
| 196 | [WS_METHODS.subscribeVcsStatus]: AuthOrchestrationReadScope, |
| 197 | [WS_METHODS.subscribeVcsBranch]: AuthOrchestrationReadScope, |
| 198 | [WS_METHODS.vcsRefreshBranch]: AuthOrchestrationReadScope, |
| 199 | [WS_METHODS.subscribeWorktreeSetup]: AuthOrchestrationReadScope, |
| 200 | [WS_METHODS.worktreeSetupCancel]: AuthOrchestrationOperateScope, |
| 201 | [WS_METHODS.subscribeResourceTelemetry]: AuthDiagnosticsReadScope, |
| 202 | [WS_METHODS.vcsRefreshStatus]: AuthOrchestrationReadScope, |
| 203 | [WS_METHODS.gitResolvePullRequest]: AuthOrchestrationReadScope, |
| 204 | [WS_METHODS.vcsListRefs]: AuthOrchestrationReadScope, |
| 205 | [WS_METHODS.reviewGetBranchCommits]: AuthFilesystemReadScope, |
| 206 | [WS_METHODS.reviewGetDiffPreview]: AuthFilesystemReadScope, |
| 207 | [WS_METHODS.reviewGetDiffFileContents]: AuthFilesystemReadScope, |
| 208 | [WS_METHODS.terminalOpen]: AuthTerminalOperateScope, |
| 209 | [WS_METHODS.terminalAttach]: AuthTerminalOperateScope, |
| 210 | [WS_METHODS.terminalObserve]: AuthTerminalReadScope, |
| 211 | [WS_METHODS.terminalWrite]: AuthTerminalOperateScope, |
| 212 | [WS_METHODS.terminalResize]: AuthTerminalOperateScope, |
| 213 | [WS_METHODS.terminalClear]: AuthTerminalOperateScope, |
| 214 | [WS_METHODS.terminalClose]: AuthTerminalOperateScope, |
| 215 | [WS_METHODS.subscribeTerminalMetadata]: AuthTerminalReadScope, |
| 216 | [WS_METHODS.previewOpen]: AuthPreviewOperateScope, |
| 217 | [WS_METHODS.previewResize]: AuthPreviewOperateScope, |
| 218 | [WS_METHODS.previewAdjust]: AuthPreviewOperateScope, |
| 219 | [WS_METHODS.previewClose]: AuthPreviewOperateScope, |
| 220 | [WS_METHODS.previewList]: AuthOrchestrationReadScope, |
| 221 | [WS_METHODS.previewClearProfile]: AuthPreviewOperateScope, |
| 222 | [WS_METHODS.previewReportProfiles]: AuthPreviewOperateScope, |
| 223 | [WS_METHODS.previewReportStatus]: AuthPreviewOperateScope, |
| 224 | [WS_METHODS.previewStopLocalServer]: AuthTerminalOperateScope, |
| 225 | [WS_METHODS.subscribePreviewEvents]: AuthOrchestrationReadScope, |
| 226 | [WS_METHODS.subscribeDiscoveredLocalServers]: AuthOrchestrationReadScope, |
| 227 | [WS_METHODS.deviceConfigure]: AuthSettingsWriteScope, |
| 228 | [WS_METHODS.deviceTestHost]: AuthSettingsWriteScope, |
| 229 | [WS_METHODS.deviceEasAccount]: AuthSettingsWriteScope, |
| 230 | [WS_METHODS.deviceSimlockIdentity]: AuthSettingsWriteScope, |
| 231 | [WS_METHODS.deviceList]: AuthOrchestrationReadScope, |
| 232 | [WS_METHODS.deviceOpen]: AuthOrchestrationOperateScope, |
| 233 | [WS_METHODS.deviceClose]: AuthOrchestrationOperateScope, |
| 234 | [WS_METHODS.deviceShutdown]: AuthOrchestrationOperateScope, |
| 235 | [WS_METHODS.deviceDetail]: AuthOrchestrationReadScope, |
| 236 | [WS_METHODS.deviceAction]: AuthOrchestrationOperateScope, |
| 237 | [WS_METHODS.subscribeDeviceState]: AuthOrchestrationReadScope, |
| 238 | [WS_METHODS.subscribeServerConfig]: AuthOrchestrationReadScope, |
| 239 | [WS_METHODS.subscribeServerLifecycle]: AuthOrchestrationReadScope, |
| 240 | [WS_METHODS.subscribeAuthAccess]: AuthAccessReadScope, |
| 241 | } as const satisfies Readonly<Record<WsRpcMethod, AuthEnvironmentScope>>; |
| 242 | |
| 243 | export function requiredScopeForRpcMethod(method: string): AuthEnvironmentScope { |
| 244 | if (!Object.hasOwn(RPC_REQUIRED_SCOPES, method)) { |
| 245 | throw new Error(`RPC method ${method} has no declared authorization scope.`); |
| 246 | } |
| 247 | const requiredScope = RPC_REQUIRED_SCOPES[method as WsRpcMethod]; |
| 248 | if (requiredScope === undefined) { |
| 249 | throw new Error(`RPC method ${method} has no declared authorization scope.`); |
| 250 | } |
| 251 | return requiredScope; |
| 252 | } |
| 253 | |
| 254 | export const rpcAuthorizationError = (requiredScope: AuthEnvironmentScope) => |
| 255 | new EnvironmentAuthorizationError({ |
| 256 | message: `The authenticated token is missing required scope: ${requiredScope}.`, |
| 257 | ...authScopeRequiredResponse(requiredScope), |
| 258 | }); |
| 259 | |
| 260 | const SettingsUpdate = Schema.Struct({ |
| 261 | patch: ServerSettingsPatch, |
| 262 | providerInstanceMutation: Schema.optionalKey(ProviderInstanceMutation), |
| 263 | }); |
| 264 | // Middleware receives the payload already decoded, so it is checked against the decoded shape. |
| 265 | const decodeSettingsUpdate = Schema.decodeUnknownSync(Schema.toType(SettingsUpdate)); |
| 266 | |
| 267 | const requiredScopesForSettingsUpdate = (payload: unknown) => { |
| 268 | const input = decodeSettingsUpdate(payload); |
| 269 | const scopes = requiredScopesForServerSettingsPatch(input.patch); |
| 270 | if (input.providerInstanceMutation === undefined) return scopes; |
| 271 | return Object.values(input.patch).every((value) => value === undefined) |
| 272 | ? [AuthProvidersManageScope] |
| 273 | : [...new Set([...scopes, AuthProvidersManageScope])]; |
| 274 | }; |
| 275 | |
| 276 | const decodeProjectMutation = Schema.decodeUnknownSync(ProjectMutation); |
| 277 | const decodeAssetCreateUrlInput = Schema.decodeUnknownSync(AssetCreateUrlInput); |
| 278 | |
| 279 | /** |
| 280 | * A queued edit that omits `attachments` keeps the queued ones, which a payload cannot show; |
| 281 | * ThreadMessageIntake.dispatchCommand decides that case. |
| 282 | */ |
| 283 | const sendsProviderSignOutPrompt = (method: string, payload: unknown): boolean => { |
| 284 | if (method === ORCHESTRATION_V2_WS_METHODS.launchThread) { |
| 285 | const message = (payload as OrchestrationV2ThreadLaunchInput).initialMessage; |
| 286 | return message !== undefined && isProviderSignOutPrompt(message); |
| 287 | } |
| 288 | if (method !== ORCHESTRATION_V2_WS_METHODS.dispatchCommand) return false; |
| 289 | const command = payload as OrchestrationV2Command; |
| 290 | switch (command.type) { |
| 291 | case "message.dispatch": |
| 292 | return isProviderSignOutPrompt(command); |
| 293 | case "queued-run.edit": |
| 294 | return ( |
| 295 | command.attachments !== undefined && |
| 296 | isProviderSignOutPrompt({ text: command.text, attachments: command.attachments }) |
| 297 | ); |
| 298 | case "delegated_task.request": |
| 299 | return isProviderSignOutPrompt({ text: command.task, attachments: [] }); |
| 300 | default: |
| 301 | return false; |
| 302 | } |
| 303 | }; |
| 304 | |
| 305 | const requiredScopesForRpcCall = ( |
| 306 | method: string, |
| 307 | payload: unknown, |
| 308 | ): ReadonlyArray<AuthEnvironmentScope> => { |
| 309 | if (method === WS_METHODS.serverRetryResourceTelemetry) { |
| 310 | return [AuthEnvironmentMaintainScope, AuthDiagnosticsReadScope]; |
| 311 | } |
| 312 | if (method === WS_METHODS.assetsCreateUrl) { |
| 313 | const { resource } = decodeAssetCreateUrlInput(payload); |
| 314 | return [ |
| 315 | resource._tag === "workspace-file" || |
| 316 | resource._tag === "media-file" || |
| 317 | resource._tag === "draft-workspace-file" || |
| 318 | (resource._tag === "native-app-icon" && resource.app._tag === "app-path") |
| 319 | ? AuthFilesystemReadScope |
| 320 | : AuthOrchestrationReadScope, |
| 321 | ]; |
| 322 | } |
| 323 | if (method === WS_METHODS.serverUpdateSettings) return requiredScopesForSettingsUpdate(payload); |
| 324 | // These send the credential they are given to a URL the caller names, as a saved setting would. |
| 325 | if ( |
| 326 | (method === WS_METHODS.deviceSimlockIdentity || |
| 327 | method === WS_METHODS.deviceEasAccount || |
| 328 | method === WS_METHODS.serverListTextGeneratorModels) && |
| 329 | containsSecretReference(payload) |
| 330 | ) { |
| 331 | return [AuthSettingsWriteScope, AuthProvidersManageScope]; |
| 332 | } |
| 333 | if (method === WS_METHODS.projectsMutate) { |
| 334 | return requiredScopesForProjectMutation(decodeProjectMutation(payload)); |
| 335 | } |
| 336 | const guarded = clientRpcRequiredScopes(method, payload); |
| 337 | const scopes = guarded.length > 0 ? guarded : [requiredScopeForRpcMethod(method)]; |
| 338 | return sendsProviderSignOutPrompt(method, payload) |
| 339 | ? [...scopes, AuthProvidersManageScope] |
| 340 | : scopes; |
| 341 | }; |
| 342 | |
| 343 | /** |
| 344 | * `onAuthorized` runs once after an authorized request succeeds; for a stream |
| 345 | * RPC, that is when the stream completes. Every RPC passes through here, so it |
| 346 | * is the one place to observe requests without wrapping each handler. |
| 347 | */ |
| 348 | export const layer = ( |
| 349 | scopes: ReadonlyArray<AuthEnvironmentScope>, |
| 350 | onAuthorized?: (method: string, payload: unknown) => Effect.Effect<void>, |
| 351 | ) => |
| 352 | Layer.succeed(RpcScopeAuthorization)((effect, { rpc, payload }) => { |
| 353 | const requiredScopes = requiredScopesForRpcCall(rpc._tag, payload); |
| 354 | const requiredScope = requiredScopes.find((scope) => !scopes.includes(scope)); |
| 355 | if (requiredScope !== undefined) return Effect.fail(rpcAuthorizationError(requiredScope)); |
| 356 | return onAuthorized === undefined |
| 357 | ? effect |
| 358 | : Effect.tap(effect, () => onAuthorized(rpc._tag, payload)); |
| 359 | }); |
| 360 | |
| 361 | /** Retrying can install or restart tools even though ordinary listing is readable. */ |
| 362 | export const requiredScopeForDeviceList = (input: DeviceListInput): AuthEnvironmentScope => |
| 363 | input.retryHostId || input.updateTool |
| 364 | ? AuthOrchestrationOperateScope |
| 365 | : AuthOrchestrationReadScope; |