The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Refuse credential-less /graphql requests before validation (#27965)
Charles Bochet01f3b4373bdd
diff --git a/packages/twenty-server/src/engine/api/graphql/direct-execution/hooks/use-direct-execution.hook.ts b/packages/twenty-server/src/engine/api/graphql/direct-execution/hooks/use-direct-execution.hook.tsindex 1fdf64a5f11..abcfa5d2e2e 100644--- a/packages/twenty-server/src/engine/api/graphql/direct-execution/hooks/use-direct-execution.hook.ts+++ b/packages/twenty-server/src/engine/api/graphql/direct-execution/hooks/use-direct-execution.hook.ts@@ -3,19 +3,30 @@ import { type Request } from 'express';import { DocumentNode, parse } from 'graphql';import { type Plugin } from 'graphql-yoga';+import { msg } from '@lingui/core/macro';import { isNull } from '@sniptt/guards';-import { type DirectExecutionService } from 'src/engine/api/graphql/direct-execution/direct-execution.service';+import { isDefined } from 'twenty-shared/utils';+import {+ type DirectExecutionResult,+ type DirectExecutionService,+} from 'src/engine/api/graphql/direct-execution/direct-execution.service';import { classifyTopLevelFields } from 'src/engine/api/graphql/direct-execution/utils/classify-top-level-fields.util';import { captureExecutedRootResolvers } from 'src/engine/api/graphql/utils/capture-executed-root-resolvers.util';import { extractTopLevelFieldsSafely } from 'src/engine/api/graphql/utils/extract-top-level-fields-safely.util';import { findOperationDefinition } from 'src/engine/api/graphql/direct-execution/utils/find-operation-definition.util';+import { isDevelopmentToolingRequest } from 'src/engine/api/graphql/direct-execution/utils/is-development-tooling-request.util';import { isSubscriptionOperation } from 'src/engine/api/graphql/direct-execution/utils/is-subscription-operation.util';import { type FeatureFlagService } from 'src/engine/core-modules/feature-flag/services/feature-flag.service';-import { UserInputError } from 'src/engine/core-modules/graphql/utils/graphql-errors.util';+import { AuthExceptionCode } from 'src/engine/core-modules/auth/auth.exception';+import {+ AuthenticationError,+ UserInputError,+} from 'src/engine/core-modules/graphql/utils/graphql-errors.util';export type DirectExecutionPluginConfig = {directExecutionService: DirectExecutionService;featureFlagService: FeatureFlagService;+ isProductionEnvironment: boolean;};export function useDirectExecution(@@ -25,7 +36,29 @@ export function useDirectExecution(onRequest: async ({ endResponse, serverContext }) => {const req = (serverContext as unknown as { req: Request }).req;- if (!req.workspace?.id || !req.body?.query) {+ if (!isDefined(req.workspace)) {+ if (+ !config.isProductionEnvironment &&+ isDevelopmentToolingRequest(req)+ ) {+ return;+ }++ const result: DirectExecutionResult = {+ errors: [+ new AuthenticationError('Authentication required', {+ subCode: AuthExceptionCode.UNAUTHENTICATED,+ userFriendlyMessage: msg`You must be authenticated to perform this action.`,+ }).toJSON(),+ ],+ };++ config.directExecutionService.recordOperationMetrics(result);++ return endResponse(Response.json(result));+ }++ if (!req.body?.query) {return;}diff --git a/packages/twenty-server/src/engine/api/graphql/direct-execution/utils/is-development-tooling-request.util.ts b/packages/twenty-server/src/engine/api/graphql/direct-execution/utils/is-development-tooling-request.util.tsnew file mode 100644index 00000000000..cf2f028b4e6--- /dev/null+++ b/packages/twenty-server/src/engine/api/graphql/direct-execution/utils/is-development-tooling-request.util.ts@@ -0,0 +1,32 @@+import { isNonEmptyString } from '@sniptt/guards';+import { type Request } from 'express';+import { parse } from 'graphql';++import { classifyTopLevelFields } from 'src/engine/api/graphql/direct-execution/utils/classify-top-level-fields.util';+import { extractTopLevelFieldsSafely } from 'src/engine/api/graphql/utils/extract-top-level-fields-safely.util';++export const isDevelopmentToolingRequest = (+ request: Pick<Request, 'body' | 'query'>,+): boolean => {+ const query = request.body?.query ?? request.query?.query;+ const operationName =+ request.body?.operationName ?? request.query?.operationName;++ if (!isNonEmptyString(query)) {+ return true;+ }++ try {+ const { hasIntrospectionFields, hasCoreFields } = classifyTopLevelFields(+ extractTopLevelFieldsSafely(+ parse(query),+ isNonEmptyString(operationName) ? operationName : undefined,+ ),+ new Set(),+ );++ return hasIntrospectionFields && !hasCoreFields;+ } catch {+ return false;+ }+};diff --git a/packages/twenty-server/src/engine/api/graphql/graphql-config/graphql-config.service.ts b/packages/twenty-server/src/engine/api/graphql/graphql-config/graphql-config.service.tsindex a989fe227ea..53e7cf9b8d9 100644--- a/packages/twenty-server/src/engine/api/graphql/graphql-config/graphql-config.service.ts+++ b/packages/twenty-server/src/engine/api/graphql/graphql-config/graphql-config.service.ts@@ -19,7 +19,6 @@ import { CoreEngineModule } from 'src/engine/core-modules/core-engine.module';import { ExceptionHandlerService } from 'src/engine/core-modules/exception-handler/exception-handler.service';import { useSentryTracing } from 'src/engine/core-modules/exception-handler/hooks/use-sentry-tracing';import { FeatureFlagService } from 'src/engine/core-modules/feature-flag/services/feature-flag.service';-import { useDisableIntrospectionAndSuggestionsForUnauthenticatedUsers } from 'src/engine/core-modules/graphql/hooks/use-disable-introspection-and-suggestions-for-unauthenticated-users.hook';import { useGraphQLErrorHandlerHook } from 'src/engine/core-modules/graphql/hooks/use-graphql-error-handler.hook';import { useValidateGraphqlQueryComplexity } from 'src/engine/core-modules/graphql/hooks/use-validate-graphql-query-complexity.hook';import { I18nService } from 'src/engine/core-modules/i18n/i18n.service';@@ -57,6 +56,9 @@ export class GraphQLConfigService implements GqlOptionsFactory<useDirectExecution({directExecutionService: this.directExecutionService,featureFlagService: this.featureFlagService,+ isProductionEnvironment:+ this.twentyConfigService.get('NODE_ENV') ===+ NodeEnvironment.PRODUCTION,}),useGraphQLErrorHandlerHook({metricsService: this.metricsService,@@ -64,9 +66,6 @@ export class GraphQLConfigService implements GqlOptionsFactory<i18nService: this.i18nService,twentyConfigService: this.twentyConfigService,}),- useDisableIntrospectionAndSuggestionsForUnauthenticatedUsers(- this.twentyConfigService.get('NODE_ENV') === NodeEnvironment.PRODUCTION,- ),useValidateGraphqlQueryComplexity({maximumAllowedFields:this.twentyConfigService.get('GRAPHQL_MAX_FIELDS'),diff --git a/packages/twenty-server/test/integration/graphql/suites/auth/cookie-session/cookie-session.integration-spec.ts b/packages/twenty-server/test/integration/graphql/suites/auth/cookie-session/cookie-session.integration-spec.tsindex 3120dc36e54..aeb27a6c31d 100644--- a/packages/twenty-server/test/integration/graphql/suites/auth/cookie-session/cookie-session.integration-spec.ts+++ b/packages/twenty-server/test/integration/graphql/suites/auth/cookie-session/cookie-session.integration-spec.ts@@ -242,4 +242,32 @@ describe('Cookie sessions (integration)', () => {true,);});++ it('should answer a workspace query sent without credentials with an auth error rather than a schema error', async () => {+ const response = await asWorkspaceRequest(+ request(SERVER_URL).post('/graphql'),+ ).send({ query: FIND_COMPANIES_QUERY });++ expect(response.body.errors).toBeDefined();++ const messages = response.body.errors.map(+ (graphQLError: { message: string }) => graphQLError.message,+ );+ const codes = response.body.errors.map(+ (graphQLError: { extensions?: { code?: string } }) =>+ graphQLError.extensions?.code,+ );++ expect(messages.join(' ')).not.toContain('Cannot query field');+ expect(codes).toContain('UNAUTHENTICATED');+ });++ it('should keep serving introspection without credentials outside production for schema codegen', async () => {+ const response = await asWorkspaceRequest(+ request(SERVER_URL).post('/graphql'),+ ).send({ query: '{ __schema { queryType { name } } }' });++ expect(response.body.errors).toBeUndefined();+ expect(response.body.data.__schema.queryType.name).toBe('Query');+ });});