Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.
TypeScript acmeagentsai-agentscertificate-managementdevsecopsenvironment-variableskubernetesopen-sourcepampkipostgresprivate-caprivileged-access-managementsecret-managementsecret-managersecretssecrets-managementsecuritysecurity-toolsvault
feat: add new service to add external approval request
adilsonf768d4be783c
diff --git a/backend/src/@types/fastify.d.ts b/backend/src/@types/fastify.d.tsindex 6f8564ca03..ad94870ff1 100644--- a/backend/src/@types/fastify.d.ts+++ b/backend/src/@types/fastify.d.ts@@ -112,6 +112,7 @@ import { TCertificateV3ServiceFactory } from "@app/services/certificate-v3/certiimport { TCmekServiceFactory } from "@app/services/cmek/cmek-service";import { TConvertorServiceFactory } from "@app/services/convertor/convertor-service";import { TEncryptionKeyRotationServiceFactory } from "@app/services/encryption-key-rotation/encryption-key-rotation-service";+import { TExternalApprovalServiceFactory } from "@app/services/external-approval/external-approval-service";import { TExternalGroupOrgRoleMappingServiceFactory } from "@app/services/external-group-org-role-mapping/external-group-org-role-mapping-service";import { TExternalMigrationServiceFactory } from "@app/services/external-migration/external-migration-service";import { TFolderCommitServiceFactory } from "@app/services/folder-commit/folder-commit-service";@@ -489,6 +490,7 @@ declare module "fastify" {subOrganization: TSubOrgServiceFactory;pkiAlertV2: TPkiAlertV2ServiceFactory;approvalPolicy: TApprovalPolicyServiceFactory;+ externalApproval: TExternalApprovalServiceFactory;appConnectionCredentialRotation: TAppConnectionCredentialRotationServiceFactory;caSigningConfig: TCaSigningConfigServiceFactory;caAutoRenewalQueue: TCaAutoRenewalQueueFactory;diff --git a/backend/src/server/routes/index.ts b/backend/src/server/routes/index.tsindex 11545fa4ef..d81731cf2d 100644--- a/backend/src/server/routes/index.ts+++ b/backend/src/server/routes/index.ts@@ -361,6 +361,9 @@ import { eventOutboxDALFactory } from "@app/services/event-outbox/event-outbox-dimport { eventOutboxQueueFactory } from "@app/services/event-outbox/event-outbox-queue";import { eventOutboxRegistryFactory } from "@app/services/event-outbox/event-outbox-registry";import { eventOutboxServiceFactory } from "@app/services/event-outbox/event-outbox-service";+import { externalApprovalPolicyDALFactory } from "@app/services/external-approval/external-approval-policy-dal";+import { externalApprovalRequestDALFactory } from "@app/services/external-approval/external-approval-request-dal";+import { externalApprovalServiceFactory } from "@app/services/external-approval/external-approval-service";import { externalGroupOrgRoleMappingDALFactory } from "@app/services/external-group-org-role-mapping/external-group-org-role-mapping-dal";import { externalGroupOrgRoleMappingServiceFactory } from "@app/services/external-group-org-role-mapping/external-group-org-role-mapping-service";import { externalMigrationQueueFactory } from "@app/services/external-migration/external-migration-queue";@@ -857,6 +860,8 @@ export const registerRoutes = async (const approvalPolicyBypassersDAL = approvalPolicyBypassersDALFactory(db);const approvalPolicySecretEnvironmentDAL = approvalPolicySecretEnvironmentDALFactory(db);const approvalRequestDAL = approvalRequestDALFactory(db);+ const externalApprovalPolicyDAL = externalApprovalPolicyDALFactory(db);+ const externalApprovalRequestDAL = externalApprovalRequestDALFactory(db);const secretChangeGlobalPolicyBridgeDAL = secretChangeGlobalPolicyBridgeDALFactory(db);const roleDAL = roleDALFactory(db);const pkiAlertHistoryDAL = pkiAlertHistoryDALFactory(db);@@ -3319,6 +3324,15 @@ export const registerRoutes = async (keyStore});+ const externalApprovalService = externalApprovalServiceFactory({+ externalApprovalPolicyDAL,+ externalApprovalRequestDAL,+ approvalPolicyDAL,+ approvalRequestDAL,+ appConnectionDAL,+ appConnectionService+ });+const agentVaultSessionLogService = agentVaultSessionLogServiceFactory({agentVaultSessionLogConfigDAL,agentVaultSessionDAL,@@ -4776,6 +4790,7 @@ export const registerRoutes = async (convertor: convertorService,pkiAlertV2: pkiAlertV2Service,approvalPolicy: approvalPolicyService,+ externalApproval: externalApprovalService,appConnectionCredentialRotation: appConnectionCredentialRotationService,caAutoRenewalQueue});diff --git a/backend/src/services/app-connection/app-connection-fns.ts b/backend/src/services/app-connection/app-connection-fns.tsindex 499027e92c..d7bb94f57a 100644--- a/backend/src/services/app-connection/app-connection-fns.ts+++ b/backend/src/services/app-connection/app-connection-fns.ts@@ -23,6 +23,7 @@ import {transferSqlConnectionCredentialsToPlatform,validateSqlConnectionCredentials} from "@app/services/app-connection/shared/sql";+import { EXTERNAL_APPROVAL_CONNECTION_MAP } from "@app/services/external-approval/external-approval-maps";import { EXTERNAL_MIGRATION_APP_CONNECTIONS } from "@app/services/external-migration/external-migration-map";import { TGitHubAppDALFactory } from "@app/services/github-app/github-app-dal";import { TIdentityUaDALFactory } from "@app/services/identity-ua/identity-ua-dal";@@ -369,9 +370,9 @@ const PKI_APP_CONNECTIONS = [AppConnection.MicrosoftIntune];-// Secret Manager connections that are not reached through a sync, rotation or external migration,-// so none of the maps above surface them.-const SECRET_MANAGER_APP_CONNECTIONS = [AppConnection.ServiceNow];+const EXTERNAL_APPROVAL_POLICY_APP_CONNECTION_MAP = Object.fromEntries(+ Object.entries(EXTERNAL_APPROVAL_CONNECTION_MAP).map(([key, value]) => [value, key])+);const AGENT_VAULT_APP_CONNECTIONS = [AppConnection.AWS];@@ -382,7 +383,7 @@ export const isAppConnectionAllowedInProject = (app: AppConnection, projectType?Boolean(SECRET_SYNC_APP_CONNECTION_MAP[app]) ||Boolean(SECRET_ROTATION_APP_CONNECTION_MAP[app]) ||EXTERNAL_MIGRATION_APP_CONNECTIONS.includes(app) ||- SECRET_MANAGER_APP_CONNECTIONS.includes(app)+ Boolean(EXTERNAL_APPROVAL_POLICY_APP_CONNECTION_MAP[app]));case ProjectType.SecretScanning:return Boolean(SECRET_SCANNING_APP_CONNECTION_MAP[app]);diff --git a/backend/src/services/external-approval/external-approval-fns.ts b/backend/src/services/external-approval/external-approval-fns.tsnew file mode 100644index 0000000000..cc2876de2d--- /dev/null+++ b/backend/src/services/external-approval/external-approval-fns.ts@@ -0,0 +1,12 @@+import { ExternalApprovalPolicyType } from "./external-approval-enums";+import { EXTERNAL_APPROVAL_CONNECTION_MAP, EXTERNAL_APPROVAL_NAME_MAP } from "./external-approval-maps";+import { TExternalApprovalListItem } from "./external-approval-types";++export const listExternalApprovalOptions = (): TExternalApprovalListItem[] =>+ Object.values(ExternalApprovalPolicyType)+ .map((type) => ({+ name: EXTERNAL_APPROVAL_NAME_MAP[type],+ type,+ connection: EXTERNAL_APPROVAL_CONNECTION_MAP[type]+ }))+ .sort((a, b) => a.name.localeCompare(b.name));diff --git a/backend/src/services/external-approval/external-approval-maps.ts b/backend/src/services/external-approval/external-approval-maps.tsnew file mode 100644index 0000000000..0666391eb8--- /dev/null+++ b/backend/src/services/external-approval/external-approval-maps.ts@@ -0,0 +1,11 @@+import { AppConnection } from "@app/services/app-connection/app-connection-enums";++import { ExternalApprovalPolicyType } from "./external-approval-enums";++export const EXTERNAL_APPROVAL_NAME_MAP: Record<ExternalApprovalPolicyType, string> = {+ [ExternalApprovalPolicyType.ServiceNow]: "ServiceNow"+};++export const EXTERNAL_APPROVAL_CONNECTION_MAP: Record<ExternalApprovalPolicyType, AppConnection> = {+ [ExternalApprovalPolicyType.ServiceNow]: AppConnection.ServiceNow+};diff --git a/backend/src/services/external-approval/external-approval-policy-dal.ts b/backend/src/services/external-approval/external-approval-policy-dal.tsnew file mode 100644index 0000000000..0b746fd85a--- /dev/null+++ b/backend/src/services/external-approval/external-approval-policy-dal.ts@@ -0,0 +1,7 @@+import { TDbClient } from "@app/db";+import { TableName } from "@app/db/schemas";+import { ormify } from "@app/lib/knex";++export type TExternalApprovalPolicyDALFactory = ReturnType<typeof externalApprovalPolicyDALFactory>;++export const externalApprovalPolicyDALFactory = (db: TDbClient) => ormify(db, TableName.ExternalApprovalPolicies);diff --git a/backend/src/services/external-approval/external-approval-request-dal.ts b/backend/src/services/external-approval/external-approval-request-dal.tsnew file mode 100644index 0000000000..43e673e310--- /dev/null+++ b/backend/src/services/external-approval/external-approval-request-dal.ts@@ -0,0 +1,7 @@+import { TDbClient } from "@app/db";+import { TableName } from "@app/db/schemas";+import { ormify } from "@app/lib/knex";++export type TExternalApprovalRequestDALFactory = ReturnType<typeof externalApprovalRequestDALFactory>;++export const externalApprovalRequestDALFactory = (db: TDbClient) => ormify(db, TableName.ExternalApprovalRequests);diff --git a/backend/src/services/external-approval/external-approval-service.ts b/backend/src/services/external-approval/external-approval-service.tsnew file mode 100644index 0000000000..90299a3d11--- /dev/null+++ b/backend/src/services/external-approval/external-approval-service.ts@@ -0,0 +1,218 @@+import { Knex } from "knex";++import { DatabaseErrorCode } from "@app/lib/error-codes";+import { BadRequestError, DatabaseError, NotFoundError } from "@app/lib/errors";+import { OrgServiceActor } from "@app/lib/types";+import { TAppConnectionDALFactory } from "@app/services/app-connection/app-connection-dal";+import { AppConnection } from "@app/services/app-connection/app-connection-enums";+import { APP_CONNECTION_NAME_MAP } from "@app/services/app-connection/app-connection-maps";+import { TAppConnectionServiceFactory } from "@app/services/app-connection/app-connection-service";+import { TApprovalPolicyDALFactory } from "@app/services/approval-policy/approval-policy-dal";+import { TApprovalRequestDALFactory } from "@app/services/approval-policy/approval-request-dal";++import { ExternalApprovalPolicyType, ExternalApprovalRequestStatus } from "./external-approval-enums";+import { listExternalApprovalOptions } from "./external-approval-fns";+import { EXTERNAL_APPROVAL_CONNECTION_MAP, EXTERNAL_APPROVAL_NAME_MAP } from "./external-approval-maps";+import { TExternalApprovalPolicyDALFactory } from "./external-approval-policy-dal";+import { TExternalApprovalRequestDALFactory } from "./external-approval-request-dal";+import {+ TCreateExternalApprovalPolicyDTO,+ TCreateExternalApprovalRequestDTO,+ TExternalApprovalPolicy,+ TExternalApprovalRequest,+ TUpdateExternalApprovalPolicyDTO,+ TUpdateExternalApprovalRequestDTO,+ TValidateExternalApprovalConnectionDTO+} from "./external-approval-types";++type TExternalApprovalServiceFactoryDep = {+ externalApprovalPolicyDAL: TExternalApprovalPolicyDALFactory;+ externalApprovalRequestDAL: TExternalApprovalRequestDALFactory;+ approvalPolicyDAL: Pick<TApprovalPolicyDALFactory, "findById">;+ approvalRequestDAL: Pick<TApprovalRequestDALFactory, "findById">;+ appConnectionDAL: Pick<TAppConnectionDALFactory, "findById">;+ appConnectionService: Pick<TAppConnectionServiceFactory, "validateAppConnectionUsageById">;+};++export type TExternalApprovalServiceFactory = ReturnType<typeof externalApprovalServiceFactory>;++const isUniqueViolation = (err: unknown) =>+ err instanceof DatabaseError && (err.error as { code?: string })?.code === DatabaseErrorCode.UniqueViolation;++export const externalApprovalServiceFactory = ({+ externalApprovalPolicyDAL,+ externalApprovalRequestDAL,+ approvalPolicyDAL,+ approvalRequestDAL,+ appConnectionDAL,+ appConnectionService+}: TExternalApprovalServiceFactoryDep) => {+ const $assertConnectionMatches = async (+ {+ type,+ connectionId,+ organizationId+ }: { type: ExternalApprovalPolicyType; connectionId: string; organizationId: string },+ tx?: Knex+ ) => {+ const appConnection = await appConnectionDAL.findById(connectionId, tx);++ if (!appConnection || appConnection.orgId !== organizationId) {+ throw new NotFoundError({ message: `App Connection with ID '${connectionId}' not found` });+ }++ const expectedApp = EXTERNAL_APPROVAL_CONNECTION_MAP[type];+ const connectionApp = appConnection.app as AppConnection;++ if (connectionApp !== expectedApp) {+ throw new BadRequestError({+ message: `${APP_CONNECTION_NAME_MAP[connectionApp]} Connection with ID '${connectionId}' cannot be used as a ${EXTERNAL_APPROVAL_NAME_MAP[type]} external approver. Select a ${APP_CONNECTION_NAME_MAP[expectedApp]} Connection instead.`+ });+ }+ };++ const validateConnection = async (+ { type, connectionId, projectId }: TValidateExternalApprovalConnectionDTO,+ actor: OrgServiceActor+ ) => {+ return appConnectionService.validateAppConnectionUsageById(+ EXTERNAL_APPROVAL_CONNECTION_MAP[type],+ { connectionId, projectId },+ actor+ );+ };++ const createPolicy = async ({ policyId, type, connectionId }: TCreateExternalApprovalPolicyDTO, tx?: Knex) => {+ const approvalPolicy = await approvalPolicyDAL.findById(policyId, tx);+ if (!approvalPolicy) {+ throw new NotFoundError({ message: `Approval policy with ID '${policyId}' not found` });+ }++ await $assertConnectionMatches({ type, connectionId, organizationId: approvalPolicy.organizationId }, tx);++ try {+ const policy = await externalApprovalPolicyDAL.create({ policyId, type, connectionId }, tx);+ return policy as TExternalApprovalPolicy;+ } catch (err) {+ if (isUniqueViolation(err)) {+ throw new BadRequestError({+ message: `Approval policy with ID '${policyId}' already has an external approver configured`+ });+ }+ throw err;+ }+ };++ const getPolicyByPolicyId = async (policyId: string, tx?: Knex) => {+ const policy = await externalApprovalPolicyDAL.findOne({ policyId }, tx);+ return (policy as TExternalApprovalPolicy | undefined) ?? null;+ };++ const updatePolicy = async ({ policyId, type, connectionId }: TUpdateExternalApprovalPolicyDTO, tx?: Knex) => {+ const existing = await externalApprovalPolicyDAL.findOne({ policyId }, tx);+ if (!existing) {+ throw new NotFoundError({ message: `Approval policy with ID '${policyId}' has no external approver configured` });+ }++ const newType = type ?? (existing.type as ExternalApprovalPolicyType);+ const newConnectionId = connectionId ?? existing.connectionId;++ if (newType === existing.type && newConnectionId === existing.connectionId) {+ return existing as TExternalApprovalPolicy;+ }++ const approvalPolicy = await approvalPolicyDAL.findById(policyId, tx);+ if (!approvalPolicy) {+ throw new NotFoundError({ message: `Approval policy with ID '${policyId}' not found` });+ }++ await $assertConnectionMatches(+ { type: newType, connectionId: newConnectionId, organizationId: approvalPolicy.organizationId },+ tx+ );++ const [policy] = await externalApprovalPolicyDAL.update(+ { policyId },+ { type: newType, connectionId: newConnectionId },+ tx+ );+ return policy as TExternalApprovalPolicy;+ };++ const deletePolicyByPolicyId = async (policyId: string, tx?: Knex) => {+ const [policy] = await externalApprovalPolicyDAL.delete({ policyId }, tx);+ return (policy as TExternalApprovalPolicy | undefined) ?? null;+ };++ const createRequest = async (+ {+ requestId,+ status = ExternalApprovalRequestStatus.PendingDispatch,+ statusReason+ }: TCreateExternalApprovalRequestDTO,+ tx?: Knex+ ) => {+ const approvalRequest = await approvalRequestDAL.findById(requestId, tx);+ if (!approvalRequest) {+ throw new NotFoundError({ message: `Approval request with ID '${requestId}' not found` });+ }++ try {+ const request = await externalApprovalRequestDAL.create({ requestId, status, statusReason }, tx);+ return request as TExternalApprovalRequest;+ } catch (err) {+ if (isUniqueViolation(err)) {+ throw new BadRequestError({+ message: `Approval request with ID '${requestId}' already has an external approval request`+ });+ }+ throw err;+ }+ };++ const getRequestByRequestId = async (requestId: string, tx?: Knex) => {+ const request = await externalApprovalRequestDAL.findOne({ requestId }, tx);+ return (request as TExternalApprovalRequest | undefined) ?? null;+ };++ const updateRequest = async ({ requestId, status, statusReason }: TUpdateExternalApprovalRequestDTO, tx?: Knex) => {+ const patch = {+ ...(status !== undefined && { status }),+ ...(statusReason !== undefined && { statusReason })+ };++ if (Object.keys(patch).length === 0) {+ const existing = await externalApprovalRequestDAL.findOne({ requestId }, tx);+ if (!existing) {+ throw new NotFoundError({+ message: `Approval request with ID '${requestId}' has no external approval request`+ });+ }+ return existing as TExternalApprovalRequest;+ }++ const [request] = await externalApprovalRequestDAL.update({ requestId }, patch, tx);+ if (!request) {+ throw new NotFoundError({ message: `Approval request with ID '${requestId}' has no external approval request` });+ }+ return request as TExternalApprovalRequest;+ };++ const deleteRequestByRequestId = async (requestId: string, tx?: Knex) => {+ const [request] = await externalApprovalRequestDAL.delete({ requestId }, tx);+ return (request as TExternalApprovalRequest | undefined) ?? null;+ };++ return {+ listExternalApprovalOptions,+ validateConnection,+ createPolicy,+ getPolicyByPolicyId,+ updatePolicy,+ deletePolicyByPolicyId,+ createRequest,+ getRequestByRequestId,+ updateRequest,+ deleteRequestByRequestId+ };+};diff --git a/backend/src/services/external-approval/external-approval-types.ts b/backend/src/services/external-approval/external-approval-types.tsnew file mode 100644index 0000000000..84394fef93--- /dev/null+++ b/backend/src/services/external-approval/external-approval-types.ts@@ -0,0 +1,48 @@+import { TExternalApprovalPolicies, TExternalApprovalRequests } from "@app/db/schemas";+import { AppConnection } from "@app/services/app-connection/app-connection-enums";++import { ExternalApprovalPolicyType, ExternalApprovalRequestStatus } from "./external-approval-enums";++export type TExternalApprovalListItem = {+ name: string;+ type: ExternalApprovalPolicyType;+ connection: AppConnection;+};++export type TExternalApprovalPolicy = Omit<TExternalApprovalPolicies, "type"> & {+ type: ExternalApprovalPolicyType;+};++export type TExternalApprovalRequest = Omit<TExternalApprovalRequests, "status"> & {+ status: ExternalApprovalRequestStatus;+};++export type TValidateExternalApprovalConnectionDTO = {+ type: ExternalApprovalPolicyType;+ connectionId: string;+ projectId: string;+};++export type TCreateExternalApprovalPolicyDTO = {+ policyId: string;+ type: ExternalApprovalPolicyType;+ connectionId: string;+};++export type TUpdateExternalApprovalPolicyDTO = {+ policyId: string;+ type?: ExternalApprovalPolicyType;+ connectionId?: string;+};++export type TCreateExternalApprovalRequestDTO = {+ requestId: string;+ status?: ExternalApprovalRequestStatus;+ statusReason?: string | null;+};++export type TUpdateExternalApprovalRequestDTO = {+ requestId: string;+ status?: ExternalApprovalRequestStatus;+ statusReason?: string | null;+};