Skip to content

Evenfire is an intelligence layer platform for running LLM agents that take real actions, on your infrastructure

TypeScript

fix(control-api): meter admin workflow grants for cookie sessions (F4)

Alfredo Lopez649e4e10772e
diff --git a/control-api/package-lock.json b/control-api/package-lock.json
index 9797df431..104651ab7 100644
--- a/control-api/package-lock.json
+++ b/control-api/package-lock.json
@@ -1,12 +1,12 @@
{
"name": "clerum-control-api",
- "version": "0.1.479",
+ "version": "0.1.480",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "clerum-control-api",
- "version": "0.1.479",
+ "version": "0.1.480",
"dependencies": {
"@clerum/display-field": "file:../packages/display-field",
"@clerum/image-policy": "file:../packages/image-policy",
diff --git a/control-api/package.json b/control-api/package.json
index 4ab6c5546..7c512ae5c 100644
--- a/control-api/package.json
+++ b/control-api/package.json
@@ -1,6 +1,6 @@
{
"name": "clerum-control-api",
- "version": "0.1.479",
+ "version": "0.1.480",
"description": "Internal Clerum control plane REST API + UI for managing CRDs and secrets",
"main": "dist/main.js",
"engines": {
diff --git a/control-api/src/routes/admin/workflows/grants.routes.ts b/control-api/src/routes/admin/workflows/grants.routes.ts
index 3e9eb8cd6..fa3b8602b 100644
--- a/control-api/src/routes/admin/workflows/grants.routes.ts
+++ b/control-api/src/routes/admin/workflows/grants.routes.ts
@@ -15,8 +15,8 @@ import {
} from '../../../services/workflows/workflowGrantManagementService.js'
import { requireAdminWorkflowCaller } from '../../workflows/shared/auth.js'
import {
- workflowGrantReadRateLimit,
- workflowGrantWriteRateLimit,
+ WORKFLOW_GRANT_READ_RATE_LIMITS,
+ WORKFLOW_GRANT_WRITE_RATE_LIMITS,
} from '../../workflows/shared/rateLimit.js'
const BASE = '/admin/workflows'
@@ -39,7 +39,7 @@ export function createAdminWorkflowGrantRoutes(gateway: K8sGateway): Router {
router.get(
`${BASE}/:ns/:name/grants`,
- workflowGrantReadRateLimit(),
+ ...WORKFLOW_GRANT_READ_RATE_LIMITS,
asyncHandler(async (req: Request, res: Response) => {
const caller = await requireAdminWorkflowCaller(req, res)
if (!caller) return
@@ -59,7 +59,7 @@ export function createAdminWorkflowGrantRoutes(gateway: K8sGateway): Router {
router.put(
`${BASE}/:ns/:name/grants`,
- workflowGrantWriteRateLimit(),
+ ...WORKFLOW_GRANT_WRITE_RATE_LIMITS,
asyncHandler(async (req: Request, res: Response) => {
const caller = await requireAdminWorkflowCaller(req, res)
if (!caller) return
@@ -104,7 +104,7 @@ export function createAdminWorkflowGrantRoutes(gateway: K8sGateway): Router {
router.get(
`${BASE}/:ns/:name/team-grants`,
- workflowGrantReadRateLimit(),
+ ...WORKFLOW_GRANT_READ_RATE_LIMITS,
asyncHandler(async (req: Request, res: Response) => {
const caller = await requireAdminWorkflowCaller(req, res)
if (!caller) return
@@ -124,7 +124,7 @@ export function createAdminWorkflowGrantRoutes(gateway: K8sGateway): Router {
router.put(
`${BASE}/:ns/:name/team-grants`,
- workflowGrantWriteRateLimit(),
+ ...WORKFLOW_GRANT_WRITE_RATE_LIMITS,
asyncHandler(async (req: Request, res: Response) => {
const caller = await requireAdminWorkflowCaller(req, res)
if (!caller) return
@@ -169,7 +169,7 @@ export function createAdminWorkflowGrantRoutes(gateway: K8sGateway): Router {
router.get(
`/admin/workflow-recipes/:ns/:name/allowed-teams`,
- workflowGrantReadRateLimit(),
+ ...WORKFLOW_GRANT_READ_RATE_LIMITS,
asyncHandler(async (req: Request, res: Response) => {
const caller = await requireAdminWorkflowCaller(req, res)
if (!caller) return
@@ -193,7 +193,7 @@ export function createAdminWorkflowGrantRoutes(gateway: K8sGateway): Router {
router.put(
`/admin/workflow-recipes/:ns/:name/allowed-teams/:teamId`,
- workflowGrantWriteRateLimit(),
+ ...WORKFLOW_GRANT_WRITE_RATE_LIMITS,
asyncHandler(async (req: Request, res: Response) => {
const caller = await requireAdminWorkflowCaller(req, res)
if (!caller) return
@@ -232,7 +232,7 @@ export function createAdminWorkflowGrantRoutes(gateway: K8sGateway): Router {
router.delete(
`/admin/workflow-recipes/:ns/:name/allowed-teams/:teamId`,
- workflowGrantWriteRateLimit(),
+ ...WORKFLOW_GRANT_WRITE_RATE_LIMITS,
asyncHandler(async (req: Request, res: Response) => {
const caller = await requireAdminWorkflowCaller(req, res)
if (!caller) return
diff --git a/control-api/src/routes/workflows/shared/rateLimit.ts b/control-api/src/routes/workflows/shared/rateLimit.ts
index 82c76a606..ba8c8b8de 100644
--- a/control-api/src/routes/workflows/shared/rateLimit.ts
+++ b/control-api/src/routes/workflows/shared/rateLimit.ts
@@ -1,8 +1,89 @@
-import { Request } from 'express'
+import type { Request, Response } from 'express'
+import { ipKeyGenerator, rateLimit } from 'express-rate-limit'
import { createHash } from 'node:crypto'
import { rateLimitMiddleware } from '../../../middleware/rateLimitMiddleware.js'
+import { CONTROL_UI_ADMIN_SESSION_COOKIE, readCookie } from '../../../utils/auth/sessionCookies.js'
import { extractBearerToken } from '../../../utils/extractBearerToken.js'
+const WORKFLOW_GRANT_READ_PER_MINUTE = 60
+const WORKFLOW_GRANT_WRITE_PER_MINUTE = 20
+
+/**
+ * Credential surface matched by requireAdminWorkflowCaller: bearer for automation,
+ * HttpOnly session cookie for Control UI browsers.
+ */
+export function adminWorkflowRateLimitCredential(req: Request): string | null {
+ const bearer = extractBearerToken(req)
+ if (bearer) return bearer
+ const cookie = readCookie(req, CONTROL_UI_ADMIN_SESSION_COOKIE)
+ return cookie || null
+}
+
+function hashedAdminWorkflowCredentialBucket(prefix: string) {
+ return (req: Request): string | null => {
+ const credential = adminWorkflowRateLimitCredential(req)
+ if (!credential) return null
+ const hash = createHash('sha256').update(credential).digest('hex').slice(0, 32)
+ return `${prefix}:${hash}`
+ }
+}
+
+function workflowGrantEdgeRateKey(prefix: string) {
+ return (req: Request): string => {
+ const bucket = hashedAdminWorkflowCredentialBucket(prefix)(req)
+ if (bucket) return bucket
+ return `${prefix}:ip:${ipKeyGenerator(req.ip ?? 'unknown')}`
+ }
+}
+
+function workflowGrantEdgeRateLimitHandler(_req: Request, res: Response): void {
+ const raw = res.getHeader('Retry-After')
+ const retryAfterSeconds =
+ typeof raw === 'number' && Number.isSafeInteger(raw) && raw > 0
+ ? raw
+ : typeof raw === 'string' && /^\d+$/.test(raw)
+ ? Math.max(1, Number(raw))
+ : 60
+ res.status(429).json({ error: 'Too Many Requests', retryAfterSeconds })
+}
+
+/**
+ * CodeQL-visible edge backstop for admin workflow grant reads. The PG-backed
+ * workflowGrantReadRateLimit() remains the cross-replica source of truth.
+ */
+export function workflowGrantReadEdgeRateLimit() {
+ return rateLimit({
+ windowMs: 60_000,
+ limit: WORKFLOW_GRANT_READ_PER_MINUTE,
+ standardHeaders: 'draft-7',
+ legacyHeaders: false,
+ keyGenerator: workflowGrantEdgeRateKey('workflow_grants_read_edge'),
+ handler: workflowGrantEdgeRateLimitHandler,
+ })
+}
+
+/** CodeQL-visible edge backstop paired with workflowGrantWriteRateLimit(). */
+export function workflowGrantWriteEdgeRateLimit() {
+ return rateLimit({
+ windowMs: 60_000,
+ limit: WORKFLOW_GRANT_WRITE_PER_MINUTE,
+ standardHeaders: 'draft-7',
+ legacyHeaders: false,
+ keyGenerator: workflowGrantEdgeRateKey('workflow_grants_write_edge'),
+ handler: workflowGrantEdgeRateLimitHandler,
+ })
+}
+
+export const WORKFLOW_GRANT_READ_RATE_LIMITS = [
+ workflowGrantReadEdgeRateLimit(),
+ workflowGrantReadRateLimit(),
+] as const
+
+export const WORKFLOW_GRANT_WRITE_RATE_LIMITS = [
+ workflowGrantWriteEdgeRateLimit(),
+ workflowGrantWriteRateLimit(),
+] as const
+
export function workflowTriggerRateLimit() {
return rateLimitMiddleware({
bucketType: 'workflow_trigger',
@@ -21,24 +102,15 @@ export function workflowTriggerRateLimit() {
export function workflowGrantReadRateLimit() {
return rateLimitMiddleware({
bucketType: 'workflow_grants_read',
- maxPerMinute: 60,
- getBucketKey: hashedBearerBucket('workflow_grants_read'),
+ maxPerMinute: WORKFLOW_GRANT_READ_PER_MINUTE,
+ getBucketKey: hashedAdminWorkflowCredentialBucket('workflow_grants_read'),
})
}
export function workflowGrantWriteRateLimit() {
return rateLimitMiddleware({
bucketType: 'workflow_grants_write',
- maxPerMinute: 20,
- getBucketKey: hashedBearerBucket('workflow_grants_write'),
+ maxPerMinute: WORKFLOW_GRANT_WRITE_PER_MINUTE,
+ getBucketKey: hashedAdminWorkflowCredentialBucket('workflow_grants_write'),
})
}
-
-function hashedBearerBucket(prefix: string) {
- return (req: Request): string | null => {
- const bearer = extractBearerToken(req)
- if (!bearer) return null
- const hash = createHash('sha256').update(bearer).digest('hex').slice(0, 32)
- return `${prefix}:${hash}`
- }
-}
diff --git a/control-api/test/workflows.shared.rateLimit.test.ts b/control-api/test/workflows.shared.rateLimit.test.ts
new file mode 100644
index 000000000..e1f03d306
--- /dev/null
+++ b/control-api/test/workflows.shared.rateLimit.test.ts
@@ -0,0 +1,55 @@
+import { describe, expect, it, vi } from 'vitest'
+import express from 'express'
+import request from 'supertest'
+import {
+ adminWorkflowRateLimitCredential,
+ workflowGrantReadRateLimit,
+} from '../src/routes/workflows/shared/rateLimit.js'
+
+const mockCheckAndIncrement = vi.hoisted(() => vi.fn())
+
+vi.mock('../src/services/rateLimiterService.js', () => ({
+ checkAndIncrement: (...args: unknown[]) => mockCheckAndIncrement(...args),
+}))
+vi.mock('../src/observability/metrics.js', () => ({
+ rateLimitHitsTotal: { inc: vi.fn() },
+}))
+
+describe('routes/workflows/shared/rateLimit', () => {
+ it('adminWorkflowRateLimitCredential accepts HttpOnly admin session cookies', () => {
+ const req = {
+ header(name: string) {
+ if (name.toLowerCase() === 'cookie') {
+ return 'control_ui_admin_session=admin-cookie-token'
+ }
+ return undefined
+ },
+ } as express.Request
+
+ expect(adminWorkflowRateLimitCredential(req)).toBe('admin-cookie-token')
+ })
+
+ it('workflowGrantReadRateLimit meters cookie-only admin workflow callers', async () => {
+ mockCheckAndIncrement.mockReset()
+ mockCheckAndIncrement.mockResolvedValue({
+ allowed: true,
+ remaining: 59,
+ resetMs: Date.now() + 60_000,
+ windowStartMs: Date.now(),
+ count: 1,
+ })
+
+ const app = express()
+ app.get('/grants', workflowGrantReadRateLimit(), (_req, res) => {
+ res.status(200).json({ ok: true })
+ })
+
+ await request(app)
+ .get('/grants')
+ .set('Cookie', 'control_ui_admin_session=admin-cookie-token')
+ .expect(200)
+
+ expect(mockCheckAndIncrement).toHaveBeenCalledOnce()
+ expect(mockCheckAndIncrement.mock.calls[0]?.[0]).toMatch(/^workflow_grants_read:[0-9a-f]{32}$/)
+ })
+})