The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Require Roles permission to mint API key tokens (#28201)
Charles Bochet9fc03e8d1562
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.resolver.ts b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.resolver.tsindex 529867ceebd..ad984471415 100644--- a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.resolver.ts+++ b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.resolver.ts@@ -320,8 +320,10 @@ export class ApplicationRegistrationResolver {oauthClient: true,application: false,}),- SettingsPermissionGuard(PermissionFlagType.API_KEYS_AND_WEBHOOKS),- SettingsPermissionGuard(PermissionFlagType.ROLES),+ SettingsPermissionGuard([+ PermissionFlagType.API_KEYS_AND_WEBHOOKS,+ PermissionFlagType.ROLES,+ ]),ApplicationTargetGuard,)@Mutation(() => RotateClientSecretDTO)diff --git a/packages/twenty-server/src/engine/core-modules/auth/auth.resolver.ts b/packages/twenty-server/src/engine/core-modules/auth/auth.resolver.tsindex dd19c581cc7..e1b99028c1e 100644--- a/packages/twenty-server/src/engine/core-modules/auth/auth.resolver.ts+++ b/packages/twenty-server/src/engine/core-modules/auth/auth.resolver.ts@@ -1218,7 +1218,10 @@ export class AuthResolver {oauthClient: false,application: false,}),- SettingsPermissionGuard(PermissionFlagType.API_KEYS_AND_WEBHOOKS),+ SettingsPermissionGuard([+ PermissionFlagType.API_KEYS_AND_WEBHOOKS,+ PermissionFlagType.ROLES,+ ]),)@Mutation(() => ApiKeyToken)async generateApiKeyToken(diff --git a/packages/twenty-server/src/engine/guards/settings-permission.guard.ts b/packages/twenty-server/src/engine/guards/settings-permission.guard.tsindex 6f45bf880ac..1e8385df896 100644--- a/packages/twenty-server/src/engine/guards/settings-permission.guard.ts+++ b/packages/twenty-server/src/engine/guards/settings-permission.guard.ts@@ -19,7 +19,7 @@ import {import { PermissionsService } from 'src/engine/metadata-modules/permissions/permissions.service';export const SettingsPermissionGuard = (- requiredPermission: PermissionFlagType,+ requiredPermissions: PermissionFlagType | PermissionFlagType[],): Type<CanActivate> => {@Injectable()class SettingsPermissionMixin implements CanActivate {@@ -41,27 +41,33 @@ export const SettingsPermissionGuard = (return true;}- const hasPermission =- await this.permissionsService.userHasWorkspaceSettingPermission({- userWorkspaceId,- setting: requiredPermission,- workspaceId,- apiKeyId: ctx.getContext().req.apiKey?.id,- applicationId: ctx.getContext().req.application?.id,- agentId: ctx.getContext().req.agentId,- });+ const settings = Array.isArray(requiredPermissions)+ ? requiredPermissions+ : [requiredPermissions];- if (hasPermission === true) {- return true;+ for (const setting of settings) {+ const hasPermission =+ await this.permissionsService.userHasWorkspaceSettingPermission({+ userWorkspaceId,+ setting,+ workspaceId,+ apiKeyId: ctx.getContext().req.apiKey?.id,+ applicationId: ctx.getContext().req.application?.id,+ agentId: ctx.getContext().req.agentId,+ });++ if (!hasPermission) {+ throw new PermissionsException(+ PermissionsExceptionMessage.PERMISSION_DENIED,+ PermissionsExceptionCode.PERMISSION_DENIED,+ {+ userFriendlyMessage: msg`You do not have permission to access this feature. Please contact your workspace administrator for access.`,+ },+ );+ }}- throw new PermissionsException(- PermissionsExceptionMessage.PERMISSION_DENIED,- PermissionsExceptionCode.PERMISSION_DENIED,- {- userFriendlyMessage: msg`You do not have permission to access this feature. Please contact your workspace administrator for access.`,- },- );+ return true;}}diff --git a/packages/twenty-server/test/integration/graphql/suites/settings-permissions/api-key-role-assignment-permission.integration-spec.ts b/packages/twenty-server/test/integration/graphql/suites/settings-permissions/api-key-role-assignment-permission.integration-spec.tsindex 24051893c51..7adddd4c854 100644--- a/packages/twenty-server/test/integration/graphql/suites/settings-permissions/api-key-role-assignment-permission.integration-spec.ts+++ b/packages/twenty-server/test/integration/graphql/suites/settings-permissions/api-key-role-assignment-permission.integration-spec.ts@@ -33,6 +33,21 @@ describe('API key role assignment permission', () => {token,);+ const generateApiKeyTokenAs = (token?: string) =>+ makeMetadataApiRequest(+ {+ query: gql`+ mutation GenerateApiKeyToken($apiKeyId: UUID!, $expiresAt: String!) {+ generateApiKeyToken(apiKeyId: $apiKeyId, expiresAt: $expiresAt) {+ token+ }+ }+ `,+ variables: { apiKeyId, expiresAt: '2099-01-01T00:00:00Z' },+ },+ token,+ );+const createApiKeyAsJony = (roleId: string) =>makeMetadataApiRequest({@@ -191,6 +206,25 @@ describe('API key role assignment permission', () => {expect(response.body.errors[0].extensions.code).toBe(ErrorCode.FORBIDDEN);});+ it('denies generating a token for an Admin API key when the caller lacks ROLES permission', async () => {+ const response = await generateApiKeyTokenAs(+ APPLE_JONY_MEMBER_ACCESS_TOKEN,+ );++ expect(response.body.data?.generateApiKeyToken ?? null).toBeNull();+ expect(response.body.errors).toBeDefined();+ expect(response.body.errors[0].extensions.code).toBe(ErrorCode.FORBIDDEN);+ });++ it('allows generating a token for an API key with ROLES permission', async () => {+ const response = await generateApiKeyTokenAs();++ expect(response.body.errors).toBeUndefined();+ expect(response.body.data.generateApiKeyToken.token).toEqual(+ expect.any(String),+ );+ });+// A rotated secret is redeemable at /oauth/token for the application's own// role, so rotating binds that role to the caller just as creating an API// key does.