| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667 |
- /**
- * Policy Limits Service
- *
- * Fetches organization-level policy restrictions from the API and uses them
- * to disable CLI features. Follows the same patterns as remote managed settings
- * (fail open, ETag caching, background polling, retry logic).
- *
- * Eligibility:
- * - Console users (API key): All eligible
- * - OAuth users (Claude.ai): Only Team and Enterprise/C4E subscribers are eligible
- * - API fails open (non-blocking) - if fetch fails, continues without restrictions
- * - API returns empty restrictions for users without policy limits
- */
- import axios from 'axios'
- import { createHash } from 'crypto'
- import { readFileSync as fsReadFileSync } from 'fs'
- import { unlink, writeFile } from 'fs/promises'
- import { join } from 'path'
- import {
- CLAUDE_AI_INFERENCE_SCOPE,
- getOauthConfig,
- OAUTH_BETA_HEADER,
- } from '../../constants/oauth.js'
- import {
- checkAndRefreshOAuthTokenIfNeeded,
- getAnthropicApiKeyWithSource,
- getClaudeAIOAuthTokens,
- } from '../../utils/auth.js'
- import { registerCleanup } from '../../utils/cleanupRegistry.js'
- import { logForDebugging } from '../../utils/debug.js'
- import { getClaudeConfigHomeDir } from '../../utils/envUtils.js'
- import { classifyAxiosError } from '../../utils/errors.js'
- import { safeParseJSON } from '../../utils/json.js'
- import {
- getAPIProvider,
- isFirstPartyAnthropicBaseUrl,
- } from '../../utils/model/providers.js'
- import { isEssentialTrafficOnly } from '../../utils/privacyLevel.js'
- import { sleep } from '../../utils/sleep.js'
- import { jsonStringify } from '../../utils/slowOperations.js'
- import { getClaudeCodeUserAgent } from '../../utils/userAgent.js'
- import { getRetryDelay } from '../api/withRetry.js'
- import {
- type PolicyLimitsFetchResult,
- type PolicyLimitsResponse,
- PolicyLimitsResponseSchema,
- } from './types.js'
- function isNodeError(e: unknown): e is NodeJS.ErrnoException {
- return e instanceof Error
- }
- // Constants
- const CACHE_FILENAME = 'policy-limits.json'
- const FETCH_TIMEOUT_MS = 10000 // 10 seconds
- const DEFAULT_MAX_RETRIES = 5
- const POLLING_INTERVAL_MS = 60 * 60 * 1000 // 1 hour
- // Background polling state
- let pollingIntervalId: ReturnType<typeof setInterval> | null = null
- let cleanupRegistered = false
- // Promise that resolves when initial policy limits loading completes
- let loadingCompletePromise: Promise<void> | null = null
- let loadingCompleteResolve: (() => void) | null = null
- // Timeout for the loading promise to prevent deadlocks
- const LOADING_PROMISE_TIMEOUT_MS = 30000 // 30 seconds
- // Session-level cache for policy restrictions
- let sessionCache: PolicyLimitsResponse['restrictions'] | null = null
- /**
- * Test-only sync reset. clearPolicyLimitsCache() does file I/O and is too
- * expensive for preload beforeEach; this only clears the module-level
- * singleton so downstream tests in the same shard see a clean slate.
- */
- export function _resetPolicyLimitsForTesting(): void {
- stopBackgroundPolling()
- sessionCache = null
- loadingCompletePromise = null
- loadingCompleteResolve = null
- }
- /**
- * Initialize the loading promise for policy limits
- * This should be called early (e.g., in init.ts) to allow other systems
- * to await policy limits loading even if loadPolicyLimits() hasn't been called yet.
- *
- * Only creates the promise if the user is eligible for policy limits.
- * Includes a timeout to prevent deadlocks if loadPolicyLimits() is never called.
- */
- export function initializePolicyLimitsLoadingPromise(): void {
- if (loadingCompletePromise) {
- return
- }
- if (isPolicyLimitsEligible()) {
- loadingCompletePromise = new Promise(resolve => {
- loadingCompleteResolve = resolve
- setTimeout(() => {
- if (loadingCompleteResolve) {
- logForDebugging(
- 'Policy limits: Loading promise timed out, resolving anyway',
- )
- loadingCompleteResolve()
- loadingCompleteResolve = null
- }
- }, LOADING_PROMISE_TIMEOUT_MS)
- })
- }
- }
- /**
- * Get the path to the policy limits cache file
- */
- function getCachePath(): string {
- return join(getClaudeConfigHomeDir(), CACHE_FILENAME)
- }
- /**
- * Get the policy limits API endpoint
- */
- function getPolicyLimitsEndpoint(): string {
- return `${getOauthConfig().BASE_API_URL}/api/claude_code/policy_limits`
- }
- /**
- * Recursively sort all keys in an object for consistent hashing
- */
- function sortKeysDeep(obj: unknown): unknown {
- if (Array.isArray(obj)) {
- return obj.map(sortKeysDeep)
- }
- if (obj !== null && typeof obj === 'object') {
- const sorted: Record<string, unknown> = {}
- for (const [key, value] of Object.entries(obj).sort(([a], [b]) =>
- a.localeCompare(b),
- )) {
- sorted[key] = sortKeysDeep(value)
- }
- return sorted
- }
- return obj
- }
- /**
- * Compute a checksum from restrictions content for HTTP caching
- */
- function computeChecksum(
- restrictions: PolicyLimitsResponse['restrictions'],
- ): string {
- const sorted = sortKeysDeep(restrictions)
- const normalized = jsonStringify(sorted)
- const hash = createHash('sha256').update(normalized).digest('hex')
- return `sha256:${hash}`
- }
- /**
- * Check if the current user is eligible for policy limits.
- *
- * IMPORTANT: This function must NOT call getSettings() or any function that calls
- * getSettings() to avoid circular dependencies during settings loading.
- */
- export function isPolicyLimitsEligible(): boolean {
- if (process.env.CLAUDE_CODE_LOCAL_SKIP_REMOTE_PREFETCH === '1') {
- return false
- }
- // 3p provider users should not hit the policy limits endpoint
- if (getAPIProvider() !== 'firstParty') {
- return false
- }
- // Custom base URL users should not hit the policy limits endpoint
- if (!isFirstPartyAnthropicBaseUrl()) {
- return false
- }
- // Console users (API key) are eligible if we can get the actual key
- try {
- const { key: apiKey } = getAnthropicApiKeyWithSource({
- skipRetrievingKeyFromApiKeyHelper: true,
- })
- if (apiKey) {
- return true
- }
- } catch {
- // No API key available - continue to check OAuth
- }
- // For OAuth users, check if they have Claude.ai tokens
- const tokens = getClaudeAIOAuthTokens()
- if (!tokens?.accessToken) {
- return false
- }
- // Must have Claude.ai inference scope
- if (!tokens.scopes?.includes(CLAUDE_AI_INFERENCE_SCOPE)) {
- return false
- }
- // Only Team and Enterprise OAuth users are eligible — these orgs have
- // admin-configurable policy restrictions (e.g. allow_remote_sessions)
- if (
- tokens.subscriptionType !== 'enterprise' &&
- tokens.subscriptionType !== 'team'
- ) {
- return false
- }
- return true
- }
- /**
- * Wait for the initial policy limits loading to complete
- * Returns immediately if user is not eligible or loading has already completed
- */
- export async function waitForPolicyLimitsToLoad(): Promise<void> {
- if (loadingCompletePromise) {
- await loadingCompletePromise
- }
- }
- /**
- * Get auth headers for policy limits without calling getSettings()
- * Supports both API key and OAuth authentication
- */
- function getAuthHeaders(): {
- headers: Record<string, string>
- error?: string
- } {
- // Try API key first (for Console users)
- try {
- const { key: apiKey } = getAnthropicApiKeyWithSource({
- skipRetrievingKeyFromApiKeyHelper: true,
- })
- if (apiKey) {
- return {
- headers: {
- 'x-api-key': apiKey,
- },
- }
- }
- } catch {
- // No API key available - continue to check OAuth
- }
- // Fall back to OAuth tokens (for Claude.ai users)
- const oauthTokens = getClaudeAIOAuthTokens()
- if (oauthTokens?.accessToken) {
- return {
- headers: {
- Authorization: `Bearer ${oauthTokens.accessToken}`,
- 'anthropic-beta': OAUTH_BETA_HEADER,
- },
- }
- }
- return {
- headers: {},
- error: 'No authentication available',
- }
- }
- /**
- * Fetch policy limits with retry logic and exponential backoff
- */
- async function fetchWithRetry(
- cachedChecksum?: string,
- ): Promise<PolicyLimitsFetchResult> {
- let lastResult: PolicyLimitsFetchResult | null = null
- for (let attempt = 1; attempt <= DEFAULT_MAX_RETRIES + 1; attempt++) {
- lastResult = await fetchPolicyLimits(cachedChecksum)
- if (lastResult.success) {
- return lastResult
- }
- if (lastResult.skipRetry) {
- return lastResult
- }
- if (attempt > DEFAULT_MAX_RETRIES) {
- return lastResult
- }
- const delayMs = getRetryDelay(attempt)
- logForDebugging(
- `Policy limits: Retry ${attempt}/${DEFAULT_MAX_RETRIES} after ${delayMs}ms`,
- )
- await sleep(delayMs)
- }
- return lastResult!
- }
- /**
- * Fetch policy limits (single attempt, no retries)
- */
- async function fetchPolicyLimits(
- cachedChecksum?: string,
- ): Promise<PolicyLimitsFetchResult> {
- try {
- await checkAndRefreshOAuthTokenIfNeeded()
- const authHeaders = getAuthHeaders()
- if (authHeaders.error) {
- return {
- success: false,
- error: 'Authentication required for policy limits',
- skipRetry: true,
- }
- }
- const endpoint = getPolicyLimitsEndpoint()
- const headers: Record<string, string> = {
- ...authHeaders.headers,
- 'User-Agent': getClaudeCodeUserAgent(),
- }
- if (cachedChecksum) {
- headers['If-None-Match'] = `"${cachedChecksum}"`
- }
- const response = await axios.get(endpoint, {
- headers,
- timeout: FETCH_TIMEOUT_MS,
- validateStatus: status =>
- status === 200 || status === 304 || status === 404,
- })
- // Handle 304 Not Modified - cached version is still valid
- if (response.status === 304) {
- logForDebugging('Policy limits: Using cached restrictions (304)')
- return {
- success: true,
- restrictions: null, // Signal that cache is valid
- etag: cachedChecksum,
- }
- }
- // Handle 404 Not Found - no policy limits exist or feature not enabled
- if (response.status === 404) {
- logForDebugging('Policy limits: No restrictions found (404)')
- return {
- success: true,
- restrictions: {},
- etag: undefined,
- }
- }
- const parsed = PolicyLimitsResponseSchema().safeParse(response.data)
- if (!parsed.success) {
- logForDebugging(
- `Policy limits: Invalid response format - ${parsed.error.message}`,
- )
- return {
- success: false,
- error: 'Invalid policy limits format',
- }
- }
- logForDebugging('Policy limits: Fetched successfully')
- return {
- success: true,
- restrictions: parsed.data.restrictions,
- }
- } catch (error) {
- // 404 is handled above via validateStatus, so it won't reach here
- const { kind, message } = classifyAxiosError(error)
- switch (kind) {
- case 'auth':
- return {
- success: false,
- error: 'Not authorized for policy limits',
- skipRetry: true,
- }
- case 'timeout':
- return { success: false, error: 'Policy limits request timeout' }
- case 'network':
- return { success: false, error: 'Cannot connect to server' }
- default:
- return { success: false, error: message }
- }
- }
- }
- /**
- * Load restrictions from cache file
- */
- // sync IO: called from sync context (getRestrictionsFromCache -> isPolicyAllowed)
- function loadCachedRestrictions(): PolicyLimitsResponse['restrictions'] | null {
- try {
- const content = fsReadFileSync(getCachePath(), 'utf-8')
- const data = safeParseJSON(content, false)
- const parsed = PolicyLimitsResponseSchema().safeParse(data)
- if (!parsed.success) {
- return null
- }
- return parsed.data.restrictions
- } catch {
- return null
- }
- }
- /**
- * Save restrictions to cache file
- */
- async function saveCachedRestrictions(
- restrictions: PolicyLimitsResponse['restrictions'],
- ): Promise<void> {
- try {
- const path = getCachePath()
- const data: PolicyLimitsResponse = { restrictions }
- await writeFile(path, jsonStringify(data, null, 2), {
- encoding: 'utf-8',
- mode: 0o600,
- })
- logForDebugging(`Policy limits: Saved to ${path}`)
- } catch (error) {
- logForDebugging(
- `Policy limits: Failed to save - ${error instanceof Error ? error.message : 'unknown error'}`,
- )
- }
- }
- /**
- * Fetch and load policy limits with file caching
- * Fails open - returns null if fetch fails and no cache exists
- */
- async function fetchAndLoadPolicyLimits(): Promise<
- PolicyLimitsResponse['restrictions'] | null
- > {
- if (!isPolicyLimitsEligible()) {
- return null
- }
- const cachedRestrictions = loadCachedRestrictions()
- const cachedChecksum = cachedRestrictions
- ? computeChecksum(cachedRestrictions)
- : undefined
- try {
- const result = await fetchWithRetry(cachedChecksum)
- if (!result.success) {
- if (cachedRestrictions) {
- logForDebugging('Policy limits: Using stale cache after fetch failure')
- sessionCache = cachedRestrictions
- return cachedRestrictions
- }
- return null
- }
- // Handle 304 Not Modified
- if (result.restrictions === null && cachedRestrictions) {
- logForDebugging('Policy limits: Cache still valid (304 Not Modified)')
- sessionCache = cachedRestrictions
- return cachedRestrictions
- }
- const newRestrictions = result.restrictions || {}
- const hasContent = Object.keys(newRestrictions).length > 0
- if (hasContent) {
- sessionCache = newRestrictions
- await saveCachedRestrictions(newRestrictions)
- logForDebugging('Policy limits: Applied new restrictions successfully')
- return newRestrictions
- }
- // Empty restrictions (404 response) - delete cached file if it exists
- sessionCache = newRestrictions
- try {
- await unlink(getCachePath())
- logForDebugging('Policy limits: Deleted cached file (404 response)')
- } catch (e) {
- if (isNodeError(e) && e.code !== 'ENOENT') {
- logForDebugging(
- `Policy limits: Failed to delete cached file - ${e.message}`,
- )
- }
- }
- return newRestrictions
- } catch {
- if (cachedRestrictions) {
- logForDebugging('Policy limits: Using stale cache after error')
- sessionCache = cachedRestrictions
- return cachedRestrictions
- }
- return null
- }
- }
- /**
- * Policies that default to denied when essential-traffic-only mode is active
- * and the policy cache is unavailable. Without this, a cache miss or network
- * timeout would silently re-enable these features for HIPAA orgs.
- */
- const ESSENTIAL_TRAFFIC_DENY_ON_MISS = new Set(['allow_product_feedback'])
- /**
- * Check if a specific policy is allowed
- * Returns true if the policy is unknown, unavailable, or explicitly allowed (fail open).
- * Exception: policies in ESSENTIAL_TRAFFIC_DENY_ON_MISS fail closed when
- * essential-traffic-only mode is active and the cache is unavailable.
- */
- export function isPolicyAllowed(policy: string): boolean {
- const restrictions = getRestrictionsFromCache()
- if (!restrictions) {
- if (
- isEssentialTrafficOnly() &&
- ESSENTIAL_TRAFFIC_DENY_ON_MISS.has(policy)
- ) {
- return false
- }
- return true // fail open
- }
- const restriction = restrictions[policy]
- if (!restriction) {
- return true // unknown policy = allowed
- }
- return restriction.allowed
- }
- /**
- * Get restrictions synchronously from session cache or file
- */
- function getRestrictionsFromCache():
- | PolicyLimitsResponse['restrictions']
- | null {
- if (!isPolicyLimitsEligible()) {
- return null
- }
- if (sessionCache) {
- return sessionCache
- }
- const cachedRestrictions = loadCachedRestrictions()
- if (cachedRestrictions) {
- sessionCache = cachedRestrictions
- return cachedRestrictions
- }
- return null
- }
- /**
- * Load policy limits during CLI initialization
- * Fails open - if fetch fails, continues without restrictions
- * Also starts background polling to pick up changes mid-session
- */
- export async function loadPolicyLimits(): Promise<void> {
- if (isPolicyLimitsEligible() && !loadingCompletePromise) {
- loadingCompletePromise = new Promise(resolve => {
- loadingCompleteResolve = resolve
- })
- }
- try {
- await fetchAndLoadPolicyLimits()
- if (isPolicyLimitsEligible()) {
- startBackgroundPolling()
- }
- } finally {
- if (loadingCompleteResolve) {
- loadingCompleteResolve()
- loadingCompleteResolve = null
- }
- }
- }
- /**
- * Refresh policy limits asynchronously (for auth state changes)
- * Used when login occurs
- */
- export async function refreshPolicyLimits(): Promise<void> {
- await clearPolicyLimitsCache()
- if (!isPolicyLimitsEligible()) {
- return
- }
- await fetchAndLoadPolicyLimits()
- logForDebugging('Policy limits: Refreshed after auth change')
- }
- /**
- * Clear all policy limits (session, persistent, and stop polling)
- */
- export async function clearPolicyLimitsCache(): Promise<void> {
- stopBackgroundPolling()
- sessionCache = null
- loadingCompletePromise = null
- loadingCompleteResolve = null
- try {
- await unlink(getCachePath())
- } catch {
- // Ignore errors (including ENOENT when file doesn't exist)
- }
- }
- /**
- * Background polling callback
- */
- async function pollPolicyLimits(): Promise<void> {
- if (!isPolicyLimitsEligible()) {
- return
- }
- const previousCache = sessionCache ? jsonStringify(sessionCache) : null
- try {
- await fetchAndLoadPolicyLimits()
- const newCache = sessionCache ? jsonStringify(sessionCache) : null
- if (newCache !== previousCache) {
- logForDebugging('Policy limits: Changed during background poll')
- }
- } catch {
- // Don't fail closed for background polling
- }
- }
- /**
- * Start background polling for policy limits
- */
- export function startBackgroundPolling(): void {
- if (pollingIntervalId !== null) {
- return
- }
- if (!isPolicyLimitsEligible()) {
- return
- }
- pollingIntervalId = setInterval(() => {
- void pollPolicyLimits()
- }, POLLING_INTERVAL_MS)
- pollingIntervalId.unref()
- if (!cleanupRegistered) {
- cleanupRegistered = true
- registerCleanup(async () => stopBackgroundPolling())
- }
- }
- /**
- * Stop background polling for policy limits
- */
- export function stopBackgroundPolling(): void {
- if (pollingIntervalId !== null) {
- clearInterval(pollingIntervalId)
- pollingIntervalId = null
- }
- }
|