The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Let server routes forward the authorization header (#27934)
Abdul Rahmane282e962e338
diff --git a/packages/twenty-docs/developers/extend/apps/logic/logic-functions.mdx b/packages/twenty-docs/developers/extend/apps/logic/logic-functions.mdxindex a6aec94dd80..e9b8ae1b818 100644--- a/packages/twenty-docs/developers/extend/apps/logic/logic-functions.mdx+++ b/packages/twenty-docs/developers/extend/apps/logic/logic-functions.mdx@@ -338,6 +338,8 @@ const handler = async (event: RoutePayload) => {**Signature verification is your responsibility — verify in the resolver.** The platform does not verify request signatures. The resolver is the recommended place to do it: it runs first, with access to `event.rawBody` and the headers you listed in `forwardedRequestHeaders`, and a thrown error (or any non-matching `workspaceId`) stops the dispatch before the target is invoked. If you instead push verification down into the target, the target must be careful not to lose `rawBody` and headers — i.e. the resolver must not return a `payload`. Always verify **before** any side effect and use a constant-time comparison.</Warning>+**Bearer tokens.** Some providers, such as Microsoft Bot Framework, sign each request with a JWT in the `Authorization` header instead of a signature header. A server route can list `authorization` in `forwardedRequestHeaders` to receive it, and the resolver verifies it like any other signature. The platform removes the header if it carries a token issued by Twenty, so a server route never receives a Twenty session. `cookie` and `proxy-authorization` are never forwarded, and HTTP routes cannot forward any of these three headers.+For request signatures, most providers sign with HMAC-SHA256; the parts that differ are the header name, the digest encoding, and the signed-payload string. A few examples:| Provider | Headers to forward | Signed string | Digest |diff --git a/packages/twenty-server/src/engine/core-modules/logic-function/logic-function-trigger/triggers/route/utils/build-logic-function-event.util.ts b/packages/twenty-server/src/engine/core-modules/logic-function/logic-function-trigger/triggers/route/utils/build-logic-function-event.util.tsindex 15ab17f3bc7..a5e976894bb 100644--- a/packages/twenty-server/src/engine/core-modules/logic-function/logic-function-trigger/triggers/route/utils/build-logic-function-event.util.ts+++ b/packages/twenty-server/src/engine/core-modules/logic-function/logic-function-trigger/triggers/route/utils/build-logic-function-event.util.ts@@ -4,6 +4,7 @@ import { type LogicFunctionEvent } from 'twenty-shared/types';import { isDefined } from 'twenty-shared/utils';import { isObject, isString } from '@sniptt/guards';+import { type SERVER_ROUTE_FORWARDABLE_CREDENTIAL_HEADER_NAME } from 'src/engine/metadata-modules/logic-function/constants/server-route-forwardable-credential-header-name.constant';import { isCredentialRequestHeaderName } from 'src/engine/metadata-modules/logic-function/utils/is-credential-request-header-name.util';const normalizeHeaderValue = (@@ -15,10 +16,12 @@ export const filterRequestHeaders = ({requestHeaders,forwardedRequestHeaders,forwardAllHeaders = false,+ forwardableCredentialHeaderName,}: {requestHeaders: Request['headers'];forwardedRequestHeaders: string[];forwardAllHeaders?: boolean;+ forwardableCredentialHeaderName?: typeof SERVER_ROUTE_FORWARDABLE_CREDENTIAL_HEADER_NAME;}): Record<string, string | undefined> => {if (forwardAllHeaders) {const allHeaders: Record<string, string | undefined> = {};@@ -39,7 +42,11 @@ export const filterRequestHeaders = ({const lowercaseForwardedHeaders = forwardedRequestHeaders.map((headerName) => headerName.toLowerCase())- .filter((headerName) => !isCredentialRequestHeaderName(headerName));+ .filter(+ (headerName) =>+ !isCredentialRequestHeaderName(headerName) ||+ headerName === forwardableCredentialHeaderName,+ );const filteredHeaders: Record<string, string | undefined> = {};@@ -143,12 +150,14 @@ export const buildLogicFunctionEvent = ({pathParameters,forwardedRequestHeaders,forwardAllHeaders = false,+ forwardableCredentialHeaderName,userWorkspaceId,}: {request: Request;pathParameters: Record<string, string | string[] | undefined>;forwardedRequestHeaders: string[];forwardAllHeaders?: boolean;+ forwardableCredentialHeaderName?: typeof SERVER_ROUTE_FORWARDABLE_CREDENTIAL_HEADER_NAME;userWorkspaceId: string | null;}): LogicFunctionEvent => {const rawBody = extractRawBody(request);@@ -158,6 +167,7 @@ export const buildLogicFunctionEvent = ({requestHeaders: request.headers,forwardedRequestHeaders,forwardAllHeaders,+ forwardableCredentialHeaderName,}),queryStringParameters: normalizeQueryStringParameters(request.query),pathParameters: normalizePathParameters(pathParameters),diff --git a/packages/twenty-server/src/engine/core-modules/server-route-trigger/server-route-authorization-header.service.ts b/packages/twenty-server/src/engine/core-modules/server-route-trigger/server-route-authorization-header.service.tsnew file mode 100644index 00000000000..927743d9e06--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/server-route-trigger/server-route-authorization-header.service.ts@@ -0,0 +1,54 @@+import { Injectable } from '@nestjs/common';++import { isNonEmptyString } from '@sniptt/guards';++import { AuthException } from 'src/engine/core-modules/auth/auth.exception';+import { JwtWrapperService } from 'src/engine/core-modules/jwt/services/jwt-wrapper.service';+import { isUserSessionToken } from 'src/engine/core-modules/user-session/utils/is-user-session-token.util';++const MAX_AUTHORIZATION_TOKEN_CANDIDATES = 3;++@Injectable()+export class ServerRouteAuthorizationHeaderService {+ constructor(private readonly jwtWrapperService: JwtWrapperService) {}++ async isForwardable(+ authorizationHeaderValue: string | undefined,+ ): Promise<boolean> {+ if (!isNonEmptyString(authorizationHeaderValue)) {+ return true;+ }++ const tokenCandidates = authorizationHeaderValue+ .split(/[\s,]+/)+ .filter(isNonEmptyString);++ if (tokenCandidates.length > MAX_AUTHORIZATION_TOKEN_CANDIDATES) {+ return false;+ }++ for (const tokenCandidate of tokenCandidates) {+ if (await this.isTwentyCredential(tokenCandidate)) {+ return false;+ }+ }++ return true;+ }++ private async isTwentyCredential(token: string): Promise<boolean> {+ if (isUserSessionToken(token)) {+ return true;+ }++ try {+ await this.jwtWrapperService.verifyJwtToken(token, {+ ignoreExpiration: true,+ });++ return true;+ } catch (error) {+ return !(error instanceof AuthException);+ }+ }+}diff --git a/packages/twenty-server/src/engine/core-modules/server-route-trigger/server-route-trigger.module.ts b/packages/twenty-server/src/engine/core-modules/server-route-trigger/server-route-trigger.module.tsindex f815ebd88b2..4414602ce30 100644--- a/packages/twenty-server/src/engine/core-modules/server-route-trigger/server-route-trigger.module.ts+++ b/packages/twenty-server/src/engine/core-modules/server-route-trigger/server-route-trigger.module.ts@@ -1,7 +1,9 @@import { Module } from '@nestjs/common';import { TypeOrmModule } from '@nestjs/typeorm';+import { JwtModule } from 'src/engine/core-modules/jwt/jwt.module';import { MetricsModule } from 'src/engine/core-modules/metrics/metrics.module';+import { ServerRouteAuthorizationHeaderService } from 'src/engine/core-modules/server-route-trigger/server-route-authorization-header.service';import { ServerRouteReachabilityService } from 'src/engine/core-modules/server-route-trigger/server-route-reachability.service';import { ServerRouteTriggerController } from 'src/engine/core-modules/server-route-trigger/server-route-trigger.controller';import { ServerRouteTriggerGaugeService } from 'src/engine/core-modules/server-route-trigger/server-route-trigger-gauge.service';@@ -10,11 +12,16 @@ import { LogicFunctionEntity } from 'src/engine/metadata-modules/logic-function/import { provideWorkspaceScopedRepository } from 'src/engine/twenty-orm/workspace-scoped-repository/provide-workspace-scoped-repository';@Module({- imports: [TypeOrmModule.forFeature([LogicFunctionEntity]), MetricsModule],+ imports: [+ TypeOrmModule.forFeature([LogicFunctionEntity]),+ MetricsModule,+ JwtModule,+ ],controllers: [ServerRouteTriggerController],providers: [provideWorkspaceScopedRepository(LogicFunctionEntity),ServerRouteTriggerService,+ ServerRouteAuthorizationHeaderService,ServerRouteReachabilityService,ServerRouteTriggerGaugeService,],diff --git a/packages/twenty-server/src/engine/core-modules/server-route-trigger/server-route-trigger.service.ts b/packages/twenty-server/src/engine/core-modules/server-route-trigger/server-route-trigger.service.tsindex f73f389d309..1aedaa03dac 100644--- a/packages/twenty-server/src/engine/core-modules/server-route-trigger/server-route-trigger.service.ts+++ b/packages/twenty-server/src/engine/core-modules/server-route-trigger/server-route-trigger.service.ts@@ -30,7 +30,9 @@ import {ServerRouteTriggerException,ServerRouteTriggerExceptionCode,} from 'src/engine/core-modules/server-route-trigger/exceptions/server-route-trigger.exception';+import { ServerRouteAuthorizationHeaderService } from 'src/engine/core-modules/server-route-trigger/server-route-authorization-header.service';import { parseResolverDispatchResultOrThrow } from 'src/engine/core-modules/server-route-trigger/utils/parse-resolver-dispatch-result-or-throw.util';+import { SERVER_ROUTE_FORWARDABLE_CREDENTIAL_HEADER_NAME } from 'src/engine/metadata-modules/logic-function/constants/server-route-forwardable-credential-header-name.constant';import { LogicFunctionEntity } from 'src/engine/metadata-modules/logic-function/logic-function.entity';import {LogicFunctionException,@@ -61,6 +63,7 @@ export class ServerRouteTriggerService {private readonly logicFunctionExecutorService: LogicFunctionExecutorService,@InjectMessageQueue(MessageQueue.logicFunctionQueue)private readonly messageQueueService: MessageQueueService,+ private readonly serverRouteAuthorizationHeaderService: ServerRouteAuthorizationHeaderService,) {}async handle({@@ -103,11 +106,26 @@ export class ServerRouteTriggerService {);}+ const forwardedRequestHeaders =+ resolver.serverRouteTriggerSettings?.forwardedRequestHeaders ?? [];++ const isAuthorizationHeaderForwardable =+ forwardedRequestHeaders.some(+ (headerName) =>+ headerName.toLowerCase() ===+ SERVER_ROUTE_FORWARDABLE_CREDENTIAL_HEADER_NAME,+ ) &&+ (await this.serverRouteAuthorizationHeaderService.isForwardable(+ request.headers[SERVER_ROUTE_FORWARDABLE_CREDENTIAL_HEADER_NAME],+ ));+const event = buildLogicFunctionEvent({request,pathParameters: {},- forwardedRequestHeaders:- resolver.serverRouteTriggerSettings?.forwardedRequestHeaders ?? [],+ forwardedRequestHeaders,+ forwardableCredentialHeaderName: isAuthorizationHeaderForwardable+ ? SERVER_ROUTE_FORWARDABLE_CREDENTIAL_HEADER_NAME+ : undefined,userWorkspaceId: null,});diff --git a/packages/twenty-server/src/engine/metadata-modules/logic-function/constants/credential-request-header-names.constant.ts b/packages/twenty-server/src/engine/metadata-modules/logic-function/constants/credential-request-header-names.constant.tsindex 3ab1eaec67c..c73d204a231 100644--- a/packages/twenty-server/src/engine/metadata-modules/logic-function/constants/credential-request-header-names.constant.ts+++ b/packages/twenty-server/src/engine/metadata-modules/logic-function/constants/credential-request-header-names.constant.ts@@ -1,5 +1,3 @@-// App code gets a scoped token from the executor, so the caller's own-// credentials must never reach it, whatever the manifest forwards.export const CREDENTIAL_REQUEST_HEADER_NAMES = new Set(['authorization','cookie',diff --git a/packages/twenty-server/src/engine/metadata-modules/logic-function/constants/server-route-forwardable-credential-header-name.constant.ts b/packages/twenty-server/src/engine/metadata-modules/logic-function/constants/server-route-forwardable-credential-header-name.constant.tsnew file mode 100644index 00000000000..28eafa4a243--- /dev/null+++ b/packages/twenty-server/src/engine/metadata-modules/logic-function/constants/server-route-forwardable-credential-header-name.constant.ts@@ -0,0 +1 @@+export const SERVER_ROUTE_FORWARDABLE_CREDENTIAL_HEADER_NAME = 'authorization';diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/__tests__/validate-logic-function-forwarded-request-headers.util.spec.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/__tests__/validate-logic-function-forwarded-request-headers.util.spec.tsindex 9e6e96c9959..dea35087614 100644--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/__tests__/validate-logic-function-forwarded-request-headers.util.spec.ts+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/__tests__/validate-logic-function-forwarded-request-headers.util.spec.ts@@ -64,14 +64,18 @@ describe('validateLogicFunctionForwardedRequestHeaders', () => {);});- it('should return an error when a server route forwards a credential header', () => {+ it('should return an error when a server route forwards cookie or proxy-authorization', () => {const errors = validateLogicFunctionForwardedRequestHeaders({- serverRouteTriggerSettings: buildServerRouteTriggerSettings(['cookie']),+ serverRouteTriggerSettings: buildServerRouteTriggerSettings([+ 'authorization',+ 'cookie',+ 'proxy-authorization',+ ]),});expect(errors).toHaveLength(1);expect(errors[0].message).toBe(- 'forwardedRequestHeaders cannot include credential headers: cookie',+ 'forwardedRequestHeaders cannot include credential headers: cookie, proxy-authorization',);});diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/validate-logic-function-forwarded-request-headers.util.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/validate-logic-function-forwarded-request-headers.util.tsindex 4fbc92e1a66..3e7b52ac983 100644--- a/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/validate-logic-function-forwarded-request-headers.util.ts+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/validators/utils/validate-logic-function-forwarded-request-headers.util.ts@@ -1,7 +1,8 @@import { msg, t } from '@lingui/core/macro';import { isString } from '@sniptt/guards';-import { isDefined, isNonEmptyArray } from 'twenty-shared/utils';+import { isNonEmptyArray } from 'twenty-shared/utils';+import { SERVER_ROUTE_FORWARDABLE_CREDENTIAL_HEADER_NAME } from 'src/engine/metadata-modules/logic-function/constants/server-route-forwardable-credential-header-name.constant';import { LogicFunctionExceptionCode } from 'src/engine/metadata-modules/logic-function/logic-function.exception';import { isCredentialRequestHeaderName } from 'src/engine/metadata-modules/logic-function/utils/is-credential-request-header-name.util';import { type UniversalFlatLogicFunction } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-logic-function.type';@@ -21,12 +22,15 @@ export const validateLogicFunctionForwardedRequestHeaders = ({httpRouteTriggerSettings,serverRouteTriggerSettings,}: ValidateLogicFunctionForwardedRequestHeadersArgs): FlatEntityValidationError<LogicFunctionExceptionCode>[] => {- const forwardedRequestHeaderLists: unknown[] = [- httpRouteTriggerSettings?.forwardedRequestHeaders,- serverRouteTriggerSettings?.forwardedRequestHeaders,- ].filter(isDefined);+ const httpRouteForwardedRequestHeaders: unknown =+ httpRouteTriggerSettings?.forwardedRequestHeaders ?? [];+ const serverRouteForwardedRequestHeaders: unknown =+ serverRouteTriggerSettings?.forwardedRequestHeaders ?? [];- if (!forwardedRequestHeaderLists.every(isArrayOfStrings)) {+ if (+ !isArrayOfStrings(httpRouteForwardedRequestHeaders) ||+ !isArrayOfStrings(serverRouteForwardedRequestHeaders)+ ) {return [{code: LogicFunctionExceptionCode.INVALID_LOGIC_FUNCTION_INPUT,@@ -36,9 +40,15 @@ export const validateLogicFunctionForwardedRequestHeaders = ({];}- const forwardedCredentialHeaderNames = forwardedRequestHeaderLists- .flat()- .filter(isCredentialRequestHeaderName);+ const forwardedCredentialHeaderNames = [+ ...httpRouteForwardedRequestHeaders.filter(isCredentialRequestHeaderName),+ ...serverRouteForwardedRequestHeaders.filter(+ (headerName) =>+ isCredentialRequestHeaderName(headerName) &&+ headerName.toLowerCase() !==+ SERVER_ROUTE_FORWARDABLE_CREDENTIAL_HEADER_NAME,+ ),+ ];if (!isNonEmptyArray(forwardedCredentialHeaderNames)) {return [];diff --git a/packages/twenty-server/test/integration/server-route-trigger/suites/server-route-trigger-authorization.integration-spec.ts b/packages/twenty-server/test/integration/server-route-trigger/suites/server-route-trigger-authorization.integration-spec.tsindex bc5fd0b448b..c2bc259924b 100644--- a/packages/twenty-server/test/integration/server-route-trigger/suites/server-route-trigger-authorization.integration-spec.ts+++ b/packages/twenty-server/test/integration/server-route-trigger/suites/server-route-trigger-authorization.integration-spec.ts@@ -1,3 +1,4 @@+import * as jwt from 'jsonwebtoken';import request from 'supertest';import { buildBaseManifest } from 'test/integration/metadata/suites/application/utils/build-base-manifest.util';import { cleanupApplicationAndAppRegistration } from 'test/integration/metadata/suites/application/utils/cleanup-application-and-app-registration.util';@@ -34,6 +35,8 @@ const HANDSHAKE_RESOLVER_UNIVERSAL_IDENTIFIER ='5e5f983f-5c1a-4c60-a3c8-7d0e2a4a55e5';const GET_HANDSHAKE_RESOLVER_UNIVERSAL_IDENTIFIER ='6f6f983f-5c1a-4c60-a3c8-7d0e2a4a66f6';+const AUTHORIZATION_ECHO_RESOLVER_UNIVERSAL_IDENTIFIER =+ '7a7f983f-5c1a-4c60-a3c8-7d0e2a4a77a7';const TARGET_FUNCTION_RESPONSE = { greeting: 'hello from target function' };@@ -62,6 +65,13 @@ const GET_HANDSHAKE_RESOLVER_BUILT_HANDLER_CODE = `export const main = async (ev});`;+const AUTHORIZATION_ECHO_RESOLVER_BUILT_HANDLER_CODE = `export const main = async (event) => ({+ ${LOGIC_FUNCTION_HTTP_RESPONSE_MARKER}: true,+ status: 200,+ body: { authorization: event.headers.authorization ?? null },+});+`;+const TARGET_BUILT_HANDLER_CODE = `export const main = async () => (${JSON.stringify(TARGET_FUNCTION_RESPONSE,)});@@ -73,12 +83,14 @@ const buildLogicFunctionManifest = ({serverRouteExposed,authRequired,httpMethods,+ forwardedRequestHeaders = [],}: {universalIdentifier: string;name: string;serverRouteExposed: boolean;authRequired: boolean;httpMethods?: ServerRouteTriggerSettings['httpMethods'];+ forwardedRequestHeaders?: string[];}): LogicFunctionManifest => ({universalIdentifier,name,@@ -98,7 +110,7 @@ const buildLogicFunctionManifest = ({...(serverRouteExposed? {serverRouteTriggerSettings: {- forwardedRequestHeaders: [],+ forwardedRequestHeaders,...(isDefined(httpMethods) ? { httpMethods } : {}),},}@@ -153,6 +165,11 @@ describe('ServerRouteTrigger authorization (integration)', () => {builtHandlerCode: GET_HANDSHAKE_RESOLVER_BUILT_HANDLER_CODE,});+ await uploadBuiltHandlerFile({+ builtHandlerPath: 'dist/authorization-echo-resolver.mjs',+ builtHandlerCode: AUTHORIZATION_ECHO_RESOLVER_BUILT_HANDLER_CODE,+ });+await uploadBuiltHandlerFile({builtHandlerPath: 'dist/target-function.mjs',builtHandlerCode: TARGET_BUILT_HANDLER_CODE,@@ -195,6 +212,14 @@ describe('ServerRouteTrigger authorization (integration)', () => {authRequired: false,httpMethods: [HTTPMethod.GET, HTTPMethod.POST],}),+ buildLogicFunctionManifest({+ universalIdentifier:+ AUTHORIZATION_ECHO_RESOLVER_UNIVERSAL_IDENTIFIER,+ name: 'authorization-echo-resolver',+ serverRouteExposed: true,+ authRequired: false,+ forwardedRequestHeaders: ['authorization'],+ }),buildLogicFunctionManifest({universalIdentifier: TARGET_FUNCTION_UNIVERSAL_IDENTIFIER,name: 'target-function',@@ -245,6 +270,50 @@ describe('ServerRouteTrigger authorization (integration)', () => {expect(response.body).toEqual({ challenge: 'abc123' });}, 60000);+ it('forwards a third-party JWT to a resolver that asked for it', async () => {+ const thirdPartyToken = jwt.sign(+ {+ iss: 'https://api.botframework.com',+ aud: 'bot-app-id',+ type: 'ACCESS',+ },+ 'third-party-signing-key',+ );++ const response = await request(baseUrl)+ .post(+ `/webhooks/server/${AUTHORIZATION_ECHO_RESOLVER_UNIVERSAL_IDENTIFIER}`,+ )+ .set('Authorization', `Bearer ${thirdPartyToken}`)+ .send({ any: 'payload' });++ expect(response.status).toBe(200);+ expect(response.body).toEqual({+ authorization: `Bearer ${thirdPartyToken}`,+ });+ }, 60000);++ it.each([+ ['as a bearer token', `Bearer ${APPLE_JANE_ADMIN_ACCESS_TOKEN}`],+ ['with trailing content', `Bearer ${APPLE_JANE_ADMIN_ACCESS_TOKEN} x`],+ ['without a scheme', APPLE_JANE_ADMIN_ACCESS_TOKEN],+ ['as a session token', 'Bearer sess_abc123'],+ ])(+ 'never forwards a Twenty credential %s',+ async (_, authorization) => {+ const response = await request(baseUrl)+ .post(+ `/webhooks/server/${AUTHORIZATION_ECHO_RESOLVER_UNIVERSAL_IDENTIFIER}`,+ )+ .set('Authorization', authorization)+ .send({ any: 'payload' });++ expect(response.status).toBe(200);+ expect(response.body).toEqual({ authorization: null });+ },+ 60000,+ );+it('rejects a server-route-exposed resolver that requires authentication before executing it', async () => {const response = await request(baseUrl).post(`/webhooks/server/${AUTH_REQUIRED_RESOLVER_UNIVERSAL_IDENTIFIER}`)