feat(api): organization access tokens (#6493)

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Author: n1ru4l

integration-tests/tests/api/organization-access-tokens.spec.ts

@@ -132,7 +132,8 @@
       "countup.js": "patches/countup.js.patch",
       "@oclif/[email protected]": "patches/@[email protected]",
       "@fastify/vite": "patches/@fastify__vite.patch",
-      "[email protected]": "patches/[email protected]"
+      "[email protected]": "patches/[email protected]",
+      "bentocache": "patches/bentocache.patch"
     }
   }
 }

package.json

@@ -0,0 +1,24 @@
+import { type MigrationExecutor } from '../pg-migrator';
+
+export default {
+  name: '2025.02.20T00-00-00.organization-access-tokens.ts',
+  run: ({ sql }) => sql`
+    CREATE TABLE IF NOT EXISTS "organization_access_tokens" (
+      "id" UUID PRIMARY KEY NOT NULL DEFAULT uuid_generate_v4()
+      , "organization_id" UUID NOT NULL REFERENCES "organizations" ("id") ON DELETE CASCADE
+      , "created_at" timestamptz NOT NULL DEFAULT now()
+      , "title" text NOT NULL
+      , "description" text NOT NULL
+      , "permissions" text[] NOT NULL
+      , "assigned_resources" jsonb
+      , "hash" text NOT NULL
+      , "first_characters" text NOT NULL
+    );
+
+    CREATE INDEX IF NOT EXISTS "organization_access_tokens_organization_id" ON "organization_access_tokens" (
+      "organization_id"
+      , "created_at" DESC
+      , "id" DESC
+    );
+  `,
+} satisfies MigrationExecutor;

packages/migrations/src/actions/2025.02.20T00-00-00.organization-access-tokens.ts

@@ -158,5 +158,6 @@ export const runPGMigrations = async (args: { slonik: DatabasePool; runTo?: stri
       await import('./actions/2025.01.17T10-08-00.drop-activities'),
       await import('./actions/2025.01.20T00-00-00.legacy-registry-model-removal'),
       await import('./actions/2025.01.30T00-00-00.granular-member-role-permissions'),
+      await import('./actions/2025.02.20T00-00-00.organization-access-tokens'),
     ],
   });

packages/migrations/src/run-pg-migrations.ts

@@ -13,6 +13,7 @@
   "devDependencies": {
     "@aws-sdk/client-s3": "3.723.0",
     "@aws-sdk/s3-request-presigner": "3.723.0",
+    "@bentocache/plugin-prometheus": "0.2.0",
     "@date-fns/utc": "2.1.0",
     "@graphql-hive/core": "workspace:*",
     "@graphql-inspector/core": "5.1.0-alpha-20231208113249-34700c8a",
@@ -44,6 +45,7 @@
     "@types/object-hash": "3.0.6",
     "agentkeepalive": "4.6.0",
     "bcryptjs": "2.4.3",
+    "bentocache": "1.1.0",
     "csv-stringify": "6.5.2",
     "dataloader": "2.2.3",
     "date-fns": "4.1.0",

packages/services/api/package.json

@@ -56,6 +56,7 @@ import {
 import { Logger } from './modules/shared/providers/logger';
 import { Mutex } from './modules/shared/providers/mutex';
 import { PG_POOL_CONFIG } from './modules/shared/providers/pg-pool';
+import { PrometheusConfig } from './modules/shared/providers/prometheus-config';
 import { HivePubSub, PUB_SUB_CONFIG } from './modules/shared/providers/pub-sub';
 import { REDIS_INSTANCE } from './modules/shared/providers/redis';
 import { S3_CONFIG, type S3Config } from './modules/shared/providers/s3-config';
@@ -112,6 +113,7 @@ export function createRegistry({
   organizationOIDC,
   pubSub,
   appDeploymentsEnabled,
+  prometheus,
 }: {
   logger: Logger;
   storage: Storage;
@@ -155,6 +157,7 @@ export function createRegistry({
   organizationOIDC: boolean;
   pubSub: HivePubSub;
   appDeploymentsEnabled: boolean;
+  prometheus: null | Record<string, unknown>;
 }) {
   const s3Config: S3Config = [
     {
@@ -303,6 +306,12 @@ export function createRegistry({
       scope: Scope.Operation,
       deps: [CONTEXT],
     },
+    {
+      provide: PrometheusConfig,
+      useFactory() {
+        return new PrometheusConfig(!!prometheus);
+      },
+    },
   ];
 
   if (emailsEndpoint) {

packages/services/api/src/create.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { ResourceAssignmentModel } from '../../organization/lib/resource-assignment-model';
 
 export const AuditLogModel = z.union([
   z.object({
@@ -327,6 +328,20 @@ export const AuditLogModel = z.union([
       scriptContents: z.string(),
     }),
   }),
+  z.object({
+    eventType: z.literal('ORGANIZATION_ACCESS_TOKEN_CREATED'),
+    metadata: z.object({
+      organizationAccessTokenId: z.string().uuid(),
+      permissions: z.array(z.string()),
+      assignedResources: ResourceAssignmentModel,
+    }),
+  }),
+  z.object({
+    eventType: z.literal('ORGANIZATION_ACCESS_TOKEN_DELETED'),
+    metadata: z.object({
+      organizationAccessTokenId: z.string().uuid(),
+    }),
+  }),
 ]);
 
 export type AuditLogSchemaEvent = z.infer<typeof AuditLogModel>;

packages/services/api/src/modules/audit-logs/providers/audit-logs-types.ts

@@ -2,6 +2,7 @@ import { createModule } from 'graphql-modules';
 import { AuditLogManager } from '../audit-logs/providers/audit-logs-manager';
 import { AuthManager } from './providers/auth-manager';
 import { OrganizationAccess } from './providers/organization-access';
+import { OrganizationAccessTokenValidationCache } from './providers/organization-access-token-validation-cache';
 import { ProjectAccess } from './providers/project-access';
 import { TargetAccess } from './providers/target-access';
 import { UserManager } from './providers/user-manager';
@@ -20,5 +21,6 @@ export const authModule = createModule({
     ProjectAccess,
     TargetAccess,
     AuditLogManager,
+    OrganizationAccessTokenValidationCache,
   ],
 });

packages/services/api/src/modules/auth/index.ts

@@ -349,6 +349,7 @@ const permissionsByLevel = {
     z.literal('project:create'),
     z.literal('schemaLinting:modifyOrganizationRules'),
     z.literal('auditLog:export'),
+    z.literal('accessToken:modify'),
   ],
   project: [
     z.literal('project:describe'),
@@ -366,7 +367,6 @@ const permissionsByLevel = {
     z.literal('laboratory:describe'),
     z.literal('laboratory:modify'),
     z.literal('laboratory:modifyPreflightScript'),
-    z.literal('schema:loadFromRegistry'),
     z.literal('schema:compose'),
   ],
   service: [

packages/services/api/src/modules/auth/lib/authz.ts

@@ -0,0 +1,116 @@
+import * as crypto from 'node:crypto';
+import { type FastifyReply, type FastifyRequest } from '@hive/service-common';
+import * as OrganizationAccessKey from '../../organization/lib/organization-access-key';
+import { OrganizationAccessTokensCache } from '../../organization/providers/organization-access-tokens-cache';
+import { Logger } from '../../shared/providers/logger';
+import { OrganizationAccessTokenValidationCache } from '../providers/organization-access-token-validation-cache';
+import { AuthNStrategy, AuthorizationPolicyStatement, Session } from './authz';
+
+function hashToken(token: string) {
+  return crypto.createHash('sha256').update(token).digest('hex');
+}
+
+export class OrganizationAccessTokenSession extends Session {
+  public readonly organizationId: string;
+  private policies: Array<AuthorizationPolicyStatement>;
+
+  constructor(
+    args: {
+      organizationId: string;
+      policies: Array<AuthorizationPolicyStatement>;
+    },
+    deps: {
+      logger: Logger;
+    },
+  ) {
+    super({ logger: deps.logger });
+    this.organizationId = args.organizationId;
+    this.policies = args.policies;
+  }
+
+  protected loadPolicyStatementsForOrganization(
+    _: string,
+  ): Promise<Array<AuthorizationPolicyStatement>> | Array<AuthorizationPolicyStatement> {
+    return this.policies;
+  }
+}
+
+export class OrganizationAccessTokenStrategy extends AuthNStrategy<OrganizationAccessTokenSession> {
+  private logger: Logger;
+
+  private organizationAccessTokenCache: OrganizationAccessTokensCache;
+  private organizationAccessTokenValidationCache: OrganizationAccessTokenValidationCache;
+
+  constructor(deps: {
+    logger: Logger;
+    organizationAccessTokensCache: OrganizationAccessTokensCache;
+    organizationAccessTokenValidationCache: OrganizationAccessTokenValidationCache;
+  }) {
+    super();
+    this.logger = deps.logger.child({ module: 'OrganizationAccessTokenStrategy' });
+    this.organizationAccessTokenCache = deps.organizationAccessTokensCache;
+    this.organizationAccessTokenValidationCache = deps.organizationAccessTokenValidationCache;
+  }
+
+  async parse(args: {
+    req: FastifyRequest;
+    reply: FastifyReply;
+  }): Promise<OrganizationAccessTokenSession | null> {
+    this.logger.debug('Attempt to resolve an API token from headers');
+    let value: string | null = null;
+    for (const headerName in args.req.headers) {
+      if (headerName.toLowerCase() !== 'authorization') {
+        continue;
+      }
+      const values = args.req.headers[headerName];
+      value = (Array.isArray(values) ? values.at(0) : values) ?? null;
+    }
+
+    if (!value) {
+      this.logger.debug('No access token header found.');
+      return null;
+    }
+
+    if (!value.startsWith('Bearer ')) {
+      this.logger.debug('Access token does not start with "Bearer ".');
+      return null;
+    }
+
+    const accessToken = value.replace('Bearer ', '');
+    const result = OrganizationAccessKey.decode(accessToken);
+    if (result.type === 'error') {
+      this.logger.debug(result.reason);
+      return null;
+    }
+
+    const organizationAccessToken = await this.organizationAccessTokenCache.get(
+      result.accessKey.id,
+    );
+    if (!organizationAccessToken) {
+      return null;
+    }
+
+    // let's hash it so we do not store the plain private key in memory
+    const key = hashToken(accessToken);
+    const isHashMatch = await this.organizationAccessTokenValidationCache.getOrSetForever({
+      factory: () =>
+        OrganizationAccessKey.verify(result.accessKey.privateKey, organizationAccessToken.hash),
+      key,
+    });
+
+    if (!isHashMatch) {
+      this.logger.debug('Provided private key does not match hash.');
+      return null;
+    }
+
+    return new OrganizationAccessTokenSession(
+      {
+        organizationId: organizationAccessToken.organizationId,
+        policies: organizationAccessToken.authorizationPolicyStatements,
+      },
+      {
+        logger: args.req.log,
+      },
+    );
+  }
+}