Skip to content

Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.

feat: add external approval policies into the approval policies service

adilson619a88451829
diff --git a/CLAUDE.md b/CLAUDE.md
index 3391f56ec8..4ffb9a64ca 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -148,6 +148,14 @@ for product vocabulary only: resolving the resource a request names, notificatio
Any rule about what is *allowed* belongs in the resource, or the product's own API and the shared API
stop agreeing.
+A policy on the global approval system can hand its requests to an external approval system (ServiceNow)
+through `backend/src/services/external-approval/`, which owns the `external_approval_policies` and
+`external_approval_requests` rows. Secret access policies opt in with `externalApproval: { type, connectionId }`
+on create and update (`secret-access-approval-global-policy-bridge-service.ts`). An external policy cannot use
+break glass (soft enforcement or bypassers) or self approval, cannot be updated while it has pending
+requests, and a policy on the legacy approval system can never be external. Keep those rules in
+`assertExternalApprovalPolicyConstraints` when another policy type opts in.
+
### API Layer (Frontend)
React Query + Axios with query key factories per domain. Each API domain in `frontend/src/hooks/api/` has `queries.tsx`, `mutations.tsx`, and `types.tsx` — see `frontend/CLAUDE.md` for conventions.
diff --git a/backend/src/ee/routes/v1/access-approval-policy-router.ts b/backend/src/ee/routes/v1/access-approval-policy-router.ts
index ca9baa5b22..c26ada7564 100644
--- a/backend/src/ee/routes/v1/access-approval-policy-router.ts
+++ b/backend/src/ee/routes/v1/access-approval-policy-router.ts
@@ -10,6 +10,7 @@ import { getTelemetryDistinctId } from "@app/server/lib/telemetry";
import { verifyAuth } from "@app/server/plugins/auth/verify-auth";
import { sapPubSchema } from "@app/server/routes/sanitizedSchemas";
import { AuthMode } from "@app/services/auth/auth-type";
+import { ExternalApprovalPolicyType } from "@app/services/external-approval/external-approval-enums";
import { PostHogEventTypes } from "@app/services/telemetry/telemetry-types";
const maxTimePeriodSchema = z
@@ -70,6 +71,17 @@ const requestExpirationTimeSchema = z
return val;
});
+const externalApprovalSchema = z.object({
+ type: z
+ .nativeEnum(ExternalApprovalPolicyType)
+ .describe("The external approval system that reviews requests made against this policy."),
+ connectionId: z.string().uuid().describe("The ID of the App Connection used to reach the external approval system.")
+});
+
+const accessApprovalPolicyPubSchema = sapPubSchema.extend({
+ externalApproval: externalApprovalSchema.nullable().optional()
+});
+
export const registerAccessApprovalPolicyRouter = async (server: FastifyZodProvider) => {
server.route({
url: "/",
@@ -105,12 +117,13 @@ export const registerAccessApprovalPolicyRouter = async (server: FastifyZodProvi
])
.array()
.max(100, "Cannot have more than 100 approvers")
- .min(1, { message: "At least one approver should be provided" })
.refine(
// @ts-expect-error this is ok
(el) => el.every((i) => Boolean(i?.id) || Boolean(i?.username)),
"Must provide either username or id"
- ),
+ )
+ .optional()
+ .describe("Required unless externalApproval is set; an external approval system reviews requests then."),
bypassers: z
.discriminatedUnion("type", [
z.object({ type: z.literal(BypasserType.Group), id: z.string() }),
@@ -134,15 +147,22 @@ export const registerAccessApprovalPolicyRouter = async (server: FastifyZodProvi
enforcementLevel: z.nativeEnum(EnforcementLevel).default(EnforcementLevel.Hard),
allowedSelfApprovals: z.boolean().default(true),
maxTimePeriod: maxTimePeriodSchema,
- requestExpirationTime: requestExpirationTimeSchema
+ requestExpirationTime: requestExpirationTimeSchema,
+ externalApproval: externalApprovalSchema
+ .optional()
+ .describe("Hand requests made against this policy to an external approval system.")
})
.refine(
(val) => Boolean(val.environment) || Boolean(val.environments),
"Must provide either environment or environments"
+ )
+ .refine(
+ (val) => Boolean(val.externalApproval) || Boolean(val.approvers?.length),
+ "At least one approver should be provided"
),
response: {
200: z.object({
- approval: sapPubSchema
+ approval: accessApprovalPolicyPubSchema
})
}
},
@@ -153,7 +173,9 @@ export const registerAccessApprovalPolicyRouter = async (server: FastifyZodProvi
actorId: req.permission.id,
actorAuthMethod: req.permission.authMethod,
actorOrgId: req.permission.orgId,
+ orgActor: req.permission,
...req.body,
+ approvers: req.body.approvers ?? [],
projectSlug: req.body.projectSlug,
name:
req.body.name ?? `${req.body.environment || req.body.environments?.join("-").substring(0, 250)}-${nanoid(3)}`,
@@ -193,7 +215,7 @@ export const registerAccessApprovalPolicyRouter = async (server: FastifyZodProvi
}),
response: {
200: z.object({
- approvals: sapPubSchema
+ approvals: accessApprovalPolicyPubSchema
.extend({
approvers: z
.object({
@@ -292,13 +314,14 @@ export const registerAccessApprovalPolicyRouter = async (server: FastifyZodProvi
})
])
.array()
- .min(1, { message: "At least one approver should be provided" })
.max(100, "Cannot have more than 100 approvers")
.refine(
// @ts-expect-error this is ok
(el) => el.every((i) => Boolean(i?.id) || Boolean(i?.username)),
"Must provide either username or id"
- ),
+ )
+ .optional()
+ .describe("Required unless the policy is handled by an external approval system."),
bypassers: z
.discriminatedUnion("type", [
z.object({ type: z.literal(BypasserType.Group), id: z.string() }),
@@ -319,11 +342,17 @@ export const registerAccessApprovalPolicyRouter = async (server: FastifyZodProvi
.array()
.optional(),
maxTimePeriod: maxTimePeriodSchema,
- requestExpirationTime: requestExpirationTimeSchema
+ requestExpirationTime: requestExpirationTimeSchema,
+ externalApproval: externalApprovalSchema
+ .nullable()
+ .optional()
+ .describe(
+ "Hand requests made against this policy to an external approval system. Send null to stop using one."
+ )
}),
response: {
200: z.object({
- approval: sapPubSchema
+ approval: accessApprovalPolicyPubSchema
})
}
},
@@ -335,7 +364,9 @@ export const registerAccessApprovalPolicyRouter = async (server: FastifyZodProvi
actorOrgId: req.permission.orgId,
actorId: req.permission.id,
actorAuthMethod: req.permission.authMethod,
- ...req.body
+ orgActor: req.permission,
+ ...req.body,
+ approvers: req.body.approvers ?? []
});
void server.services.telemetry
@@ -363,7 +394,7 @@ export const registerAccessApprovalPolicyRouter = async (server: FastifyZodProvi
}),
response: {
200: z.object({
- approval: sapPubSchema
+ approval: accessApprovalPolicyPubSchema
})
}
},
@@ -406,7 +437,7 @@ export const registerAccessApprovalPolicyRouter = async (server: FastifyZodProvi
}),
response: {
200: z.object({
- approval: sapPubSchema.extend({
+ approval: accessApprovalPolicyPubSchema.extend({
approvers: z
.object({
type: z.nativeEnum(ApproverType),
diff --git a/backend/src/ee/services/access-approval-policy/access-approval-policy-service.ts b/backend/src/ee/services/access-approval-policy/access-approval-policy-service.ts
index d0e77feef6..0e8fb0541d 100644
--- a/backend/src/ee/services/access-approval-policy/access-approval-policy-service.ts
+++ b/backend/src/ee/services/access-approval-policy/access-approval-policy-service.ts
@@ -380,7 +380,9 @@ export const accessApprovalPolicyServiceFactory = ({
approvalsRequired,
environments,
maxTimePeriod,
- requestExpirationTime
+ requestExpirationTime,
+ externalApproval,
+ orgActor
}: TUpdateAccessApprovalPolicy) => {
if (await $usesGlobalApprovalBridge(policyId)) {
return secretAccessApprovalGlobalPolicyBridge.updateAccessApprovalPolicy({
@@ -399,10 +401,21 @@ export const accessApprovalPolicyServiceFactory = ({
approvalsRequired,
environments,
maxTimePeriod,
- requestExpirationTime
+ requestExpirationTime,
+ externalApproval,
+ orgActor
});
}
+ if (externalApproval) {
+ throw new BadRequestError({
+ message: `Access approval policy with ID '${policyId}' is on the legacy approval system and cannot be handled by an external approval system.`
+ });
+ }
+ if (!approvers.length) {
+ throw new BadRequestError({ message: "At least one approver should be provided" });
+ }
+
const groupApprovers = approvers.filter((approver) => approver.type === ApproverType.Group);
const userApprovers = approvers.filter((approver) => approver.type === ApproverType.User && approver.id) as {
diff --git a/backend/src/ee/services/access-approval-policy/access-approval-policy-types.ts b/backend/src/ee/services/access-approval-policy/access-approval-policy-types.ts
index b5b08a8d87..c4ccfbee3e 100644
--- a/backend/src/ee/services/access-approval-policy/access-approval-policy-types.ts
+++ b/backend/src/ee/services/access-approval-policy/access-approval-policy-types.ts
@@ -1,5 +1,6 @@
-import { EnforcementLevel, TProjectPermission } from "@app/lib/types";
+import { EnforcementLevel, OrgServiceActor, TProjectPermission } from "@app/lib/types";
import { ActorAuthMethod } from "@app/services/auth/auth-type";
+import { TExternalApprovalPolicyInput } from "@app/services/external-approval/external-approval-types";
import { TPermissionServiceFactory } from "../permission/permission-service-types";
@@ -23,6 +24,8 @@ export enum BypasserType {
User = "user"
}
+export type TExternalApprovalPolicyOutput = TExternalApprovalPolicyInput;
+
export type TCreateAccessApprovalPolicy = {
approvals: number;
secretPath: string;
@@ -43,6 +46,8 @@ export type TCreateAccessApprovalPolicy = {
approvalsRequired?: { numberOfApprovals: number; stepNumber: number }[];
maxTimePeriod?: string | null;
requestExpirationTime?: string | null;
+ externalApproval?: TExternalApprovalPolicyInput;
+ orgActor: OrgServiceActor;
} & Omit<TProjectPermission, "projectId">;
export type TUpdateAccessApprovalPolicy = {
@@ -64,6 +69,8 @@ export type TUpdateAccessApprovalPolicy = {
environments?: string[];
maxTimePeriod?: string | null;
requestExpirationTime?: string | null;
+ externalApproval?: TExternalApprovalPolicyInput | null;
+ orgActor: OrgServiceActor;
} & Omit<TProjectPermission, "projectId">;
export type TDeleteAccessApprovalPolicy = {
@@ -142,6 +149,7 @@ export interface TAccessApprovalPolicyServiceFactory {
deletedAt?: Date | null | undefined;
maxTimePeriod?: string | null;
requestExpirationTime?: string | null;
+ externalApproval?: TExternalApprovalPolicyOutput | null;
}>;
deleteAccessApprovalPolicy: ({
policyId,
@@ -179,6 +187,7 @@ export interface TAccessApprovalPolicyServiceFactory {
slug: string;
}[];
projectId: string;
+ externalApproval?: TExternalApprovalPolicyOutput | null;
}>;
updateAccessApprovalPolicy: ({
policyId,
@@ -219,6 +228,7 @@ export interface TAccessApprovalPolicyServiceFactory {
secretPath: string;
deletedAt?: Date | null | undefined;
maxTimePeriod?: string | null;
+ externalApproval?: TExternalApprovalPolicyOutput | null;
}>;
getAccessApprovalPolicyByProjectSlug: ({
actorId,
@@ -276,6 +286,7 @@ export interface TAccessApprovalPolicyServiceFactory {
type: BypasserType;
}
)[];
+ externalApproval?: TExternalApprovalPolicyOutput | null;
}[]
>;
getAccessApprovalPolicyById: ({
@@ -334,5 +345,6 @@ export interface TAccessApprovalPolicyServiceFactory {
type: BypasserType.Group;
}
)[];
+ externalApproval?: TExternalApprovalPolicyOutput | null;
}>;
}
diff --git a/backend/src/server/routes/index.ts b/backend/src/server/routes/index.ts
index d81731cf2d..fb0e444814 100644
--- a/backend/src/server/routes/index.ts
+++ b/backend/src/server/routes/index.ts
@@ -2650,26 +2650,6 @@ export const registerRoutes = async (
additionalPrivilegeDAL
});
- const secretAccessApprovalGlobalPolicyBridgeService = secretAccessApprovalGlobalPolicyBridgeServiceFactory({
- projectDAL,
- permissionService,
- projectEnvDAL,
- userDAL,
- groupDAL,
- accessApprovalPolicyDAL,
- approvalPolicyDAL,
- approvalPolicyStepsDAL,
- approvalPolicyStepApproversDAL,
- approvalPolicyBypassersDAL,
- approvalPolicySecretEnvironmentDAL,
- secretAccessApprovalGlobalPolicyBridgeDAL,
- approvalRequestDAL,
- approvalRequestStepsDAL,
- approvalRequestStepEligibleApproversDAL,
- approvalRequestGrantsDAL,
- additionalPrivilegeDAL
- });
-
const secretAccessApprovalGlobalRequestBridgeService = secretAccessApprovalGlobalRequestBridgeServiceFactory({
projectDAL,
projectEnvDAL,
@@ -2694,24 +2674,6 @@ export const registerRoutes = async (
secretAccessApprovalGlobalResource
});
- const accessApprovalPolicyService = accessApprovalPolicyServiceFactory({
- accessApprovalPolicyDAL,
- accessApprovalPolicyApproverDAL,
- accessApprovalPolicyBypasserDAL,
- accessApprovalPolicyEnvironmentDAL,
- groupDAL,
- permissionService,
- projectEnvDAL,
- projectDAL,
- userDAL,
- accessApprovalRequestDAL,
- accessApprovalRequestReviewerDAL,
- additionalPrivilegeDAL,
- approvalPolicyDAL,
- approvalPolicySecretEnvironmentDAL,
- secretAccessApprovalGlobalPolicyBridge: secretAccessApprovalGlobalPolicyBridgeService
- });
-
const accessApprovalRequestService = accessApprovalRequestServiceFactory({
projectDAL,
permissionService,
@@ -3333,6 +3295,45 @@ export const registerRoutes = async (
appConnectionService
});
+ const secretAccessApprovalGlobalPolicyBridgeService = secretAccessApprovalGlobalPolicyBridgeServiceFactory({
+ projectDAL,
+ permissionService,
+ projectEnvDAL,
+ userDAL,
+ groupDAL,
+ accessApprovalPolicyDAL,
+ approvalPolicyDAL,
+ approvalPolicyStepsDAL,
+ approvalPolicyStepApproversDAL,
+ approvalPolicyBypassersDAL,
+ approvalPolicySecretEnvironmentDAL,
+ secretAccessApprovalGlobalPolicyBridgeDAL,
+ approvalRequestDAL,
+ approvalRequestStepsDAL,
+ approvalRequestStepEligibleApproversDAL,
+ approvalRequestGrantsDAL,
+ additionalPrivilegeDAL,
+ externalApprovalService
+ });
+
+ const accessApprovalPolicyService = accessApprovalPolicyServiceFactory({
+ accessApprovalPolicyDAL,
+ accessApprovalPolicyApproverDAL,
+ accessApprovalPolicyBypasserDAL,
+ accessApprovalPolicyEnvironmentDAL,
+ groupDAL,
+ permissionService,
+ projectEnvDAL,
+ projectDAL,
+ userDAL,
+ accessApprovalRequestDAL,
+ accessApprovalRequestReviewerDAL,
+ additionalPrivilegeDAL,
+ approvalPolicyDAL,
+ approvalPolicySecretEnvironmentDAL,
+ secretAccessApprovalGlobalPolicyBridge: secretAccessApprovalGlobalPolicyBridgeService
+ });
+
const agentVaultSessionLogService = agentVaultSessionLogServiceFactory({
agentVaultSessionLogConfigDAL,
agentVaultSessionDAL,
diff --git a/backend/src/services/external-approval/external-approval-fns.test.ts b/backend/src/services/external-approval/external-approval-fns.test.ts
new file mode 100644
index 0000000000..a245191fa1
--- /dev/null
+++ b/backend/src/services/external-approval/external-approval-fns.test.ts
@@ -0,0 +1,33 @@
+import { describe, expect, test } from "vitest";
+
+import { BadRequestError } from "@app/lib/errors";
+import { EnforcementLevel } from "@app/services/approval-policy/approval-policy-enums";
+
+import { assertExternalApprovalPolicyConstraints } from "./external-approval-fns";
+
+describe("assertExternalApprovalPolicyConstraints", () => {
+ const valid = { enforcementLevel: EnforcementLevel.Hard, bypassers: [], allowedSelfApprovals: false };
+
+ test("accepts a hard policy without bypassers or self approvals", () => {
+ expect(() => assertExternalApprovalPolicyConstraints(valid)).not.toThrow();
+ expect(() => assertExternalApprovalPolicyConstraints({ ...valid, bypassers: undefined })).not.toThrow();
+ });
+
+ test("rejects soft enforcement", () => {
+ expect(() =>
+ assertExternalApprovalPolicyConstraints({ ...valid, enforcementLevel: EnforcementLevel.Soft })
+ ).toThrow(BadRequestError);
+ });
+
+ test("rejects bypassers", () => {
+ expect(() =>
+ assertExternalApprovalPolicyConstraints({ ...valid, bypassers: [{ type: "user", id: "u1" }] })
+ ).toThrow(BadRequestError);
+ });
+
+ test("rejects self approvals", () => {
+ expect(() => assertExternalApprovalPolicyConstraints({ ...valid, allowedSelfApprovals: true })).toThrow(
+ BadRequestError
+ );
+ });
+});
diff --git a/backend/src/services/external-approval/external-approval-fns.ts b/backend/src/services/external-approval/external-approval-fns.ts
index cc2876de2d..641e686e8f 100644
--- a/backend/src/services/external-approval/external-approval-fns.ts
+++ b/backend/src/services/external-approval/external-approval-fns.ts
@@ -1,3 +1,6 @@
+import { BadRequestError } from "@app/lib/errors";
+import { EnforcementLevel } from "@app/services/approval-policy/approval-policy-enums";
+
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";
@@ -10,3 +13,32 @@ export const listExternalApprovalOptions = (): TExternalApprovalListItem[] =>
connection: EXTERNAL_APPROVAL_CONNECTION_MAP[type]
}))
.sort((a, b) => a.name.localeCompare(b.name));
+
+export const assertExternalApprovalPolicyConstraints = ({
+ enforcementLevel,
+ bypassers,
+ allowedSelfApprovals
+}: {
+ enforcementLevel: string;
+ bypassers?: unknown[];
+ allowedSelfApprovals: boolean;
+}) => {
+ if (enforcementLevel === EnforcementLevel.Soft) {
+ throw new BadRequestError({
+ message:
+ "Policies handled by an external approval system cannot use soft enforcement, since break glass is not available for them. Set enforcementLevel to 'hard'."
+ });
+ }
+ if (bypassers?.length) {
+ throw new BadRequestError({
+ message:
+ "Policies handled by an external approval system cannot have bypassers, since break glass is not available for them."
+ });
+ }
+ if (allowedSelfApprovals) {
+ throw new BadRequestError({
+ message:
+ "Policies handled by an external approval system cannot allow self approvals. Set allowedSelfApprovals to false."
+ });
+ }
+};
diff --git a/backend/src/services/external-approval/external-approval-types.ts b/backend/src/services/external-approval/external-approval-types.ts
index 84394fef93..7ddd29dfac 100644
--- a/backend/src/services/external-approval/external-approval-types.ts
+++ b/backend/src/services/external-approval/external-approval-types.ts
@@ -23,12 +23,15 @@ export type TValidateExternalApprovalConnectionDTO = {
projectId: string;
};
-export type TCreateExternalApprovalPolicyDTO = {
- policyId: string;
+export type TExternalApprovalPolicyInput = {
type: ExternalApprovalPolicyType;
connectionId: string;
};
+export type TCreateExternalApprovalPolicyDTO = TExternalApprovalPolicyInput & {
+ policyId: string;
+};
+
export type TUpdateExternalApprovalPolicyDTO = {
policyId: string;
type?: ExternalApprovalPolicyType;
diff --git a/backend/src/services/secret-access-approval-global-policy-bridge/secret-access-approval-global-policy-bridge-dal.ts b/backend/src/services/secret-access-approval-global-policy-bridge/secret-access-approval-global-policy-bridge-dal.ts
index 0148bd84d5..5d03b9da9c 100644
--- a/backend/src/services/secret-access-approval-global-policy-bridge/secret-access-approval-global-policy-bridge-dal.ts
+++ b/backend/src/services/secret-access-approval-global-policy-bridge/secret-access-approval-global-policy-bridge-dal.ts
@@ -8,6 +8,7 @@ import { DatabaseError } from "@app/lib/errors";
import { selectAllTableCols, sqlNestRelationships } from "@app/lib/knex";
import { ApprovalPolicyType } from "@app/services/approval-policy/approval-policy-enums";
import { SecretAccessPolicyConstraintsSchema } from "@app/services/approval-policy/secret-access/secret-access-policy-schemas";
+import { ExternalApprovalPolicyType } from "@app/services/external-approval/external-approval-enums";
const StoredConstraintsSchema = z.object({ version: z.literal(1), constraints: SecretAccessPolicyConstraintsSchema });
@@ -74,6 +75,11 @@ export const secretAccessApprovalGlobalPolicyBridgeDALFactory = (db: TDbClient)
`${TableName.ApprovalPolicyBypassers}.userId`,
"bypasserUsers.id"
)
+ .leftJoin(
+ TableName.ExternalApprovalPolicies,
+ `${TableName.ApprovalPolicies}.id`,
+ `${TableName.ExternalApprovalPolicies}.policyId`
+ )
.select(selectAllTableCols(TableName.ApprovalPolicies))
.select(
db.ref("secretPath").withSchema(TableName.ApprovalPolicySecretEnvironment),
@@ -89,7 +95,9 @@ export const secretAccessApprovalGlobalPolicyBridgeDALFactory = (db: TDbClient)
db.ref("username").withSchema(TableName.Users).as("approverUsername"),
db.ref("userId").withSchema(TableName.ApprovalPolicyBypassers).as("bypasserUserId"),
db.ref("groupId").withSchema(TableName.ApprovalPolicyBypassers).as("bypasserGroupId"),
- db.ref("username").withSchema("bypasserUsers").as("bypasserUsername")
+ db.ref("username").withSchema("bypasserUsers").as("bypasserUsername"),
+ db.ref("type").withSchema(TableName.ExternalApprovalPolicies).as("externalApprovalType"),
+ db.ref("connectionId").withSchema(TableName.ExternalApprovalPolicies).as("externalApprovalConnectionId")
)
.orderBy(`${TableName.ApprovalPolicySteps}.stepNumber`, "asc");
@@ -111,7 +119,13 @@ export const secretAccessApprovalGlobalPolicyBridgeDALFactory = (db: TDbClient)
envId: data.environmentId,
maxTimePeriod,
allowedSelfApprovals,
- requestExpirationTime
+ requestExpirationTime,
+ externalApproval: data.externalApprovalType
+ ? {
+ type: data.externalApprovalType as ExternalApprovalPolicyType,
+ connectionId: data.externalApprovalConnectionId as string
+ }
+ : null
};
},
childrenMapper: [
diff --git a/backend/src/services/secret-access-approval-global-policy-bridge/secret-access-approval-global-policy-bridge-service.ts b/backend/src/services/secret-access-approval-global-policy-bridge/secret-access-approval-global-policy-bridge-service.ts
index a8efdd26ec..9040678fa5 100644
--- a/backend/src/services/secret-access-approval-global-policy-bridge/secret-access-approval-global-policy-bridge-service.ts
+++ b/backend/src/services/secret-access-approval-global-policy-bridge/secret-access-approval-global-policy-bridge-service.ts
@@ -9,11 +9,13 @@ import {
TCreateAccessApprovalPolicy
} from "@app/ee/services/access-approval-policy/access-approval-policy-types";
import { ProjectPermissionActions, ProjectPermissionSub } from "@app/ee/services/permission/project-permission";
-import { BadRequestError, NotFoundError } from "@app/lib/errors";
+import { BadRequestError, ConflictError, NotFoundError } from "@app/lib/errors";
import { groupBy } from "@app/lib/fn";
import { ApprovalPolicyType, ApprovalRequestStatus } from "@app/services/approval-policy/approval-policy-enums";
import { insertApprovalRequestSteps } from "@app/services/approval-policy/approval-request-fns";
import { ActorType } from "@app/services/auth/auth-type";
+import { assertExternalApprovalPolicyConstraints } from "@app/services/external-approval/external-approval-fns";
+import { TExternalApprovalPolicyInput } from "@app/services/external-approval/external-approval-types";
import {
buildSecretAccessPolicySteps,
@@ -41,6 +43,15 @@ type TPolicyStep = {
requiredApprovals: number;
approvers: { type: ApproverType; id: string }[];
};
+type TPolicyReviewers = { steps: TPolicyStep[]; bypasserUserIds: string[]; groupBypassers: string[] };
+
+// defined for delegated approvals
+const NO_REVIEWERS: TPolicyReviewers = { steps: [], bypasserUserIds: [], groupBypassers: [] };
+
+const isExternalApprovalChanged = (
+ existing: TExternalApprovalPolicyInput | null,
+ incoming: TExternalApprovalPolicyInput
+) => existing?.type !== incoming.type || existing?.connectionId !== incoming.connectionId;
export const secretAccessApprovalGlobalPolicyBridgeServiceFactory = ({
projectDAL,
@@ -59,7 +70,8 @@ export const secretAccessApprovalGlobalPolicyBridgeServiceFactory = ({
approvalRequestStepsDAL,
approvalRequestStepEligibleApproversDAL,
approvalRequestGrantsDAL,
- additionalPrivilegeDAL
+ additionalPrivilegeDAL,
+ externalApprovalService
}: TSecretAccessApprovalGlobalPolicyBridgeServiceFactoryDep) => {
const { verifyProjectSubjectsMembership } = approvalPolicyMembershipVerifierFactory({ projectDAL });
@@ -250,6 +262,47 @@ export const secretAccessApprovalGlobalPolicyBridgeServiceFactory = ({
}
};
+ // An external policy delegates review entirely, so it carries no approver steps or bypassers of its own.
+ const $resolveReviewers = async (
+ {
+ externalApproval,
+ enforcementLevel,
+ allowedSelfApprovals,
+ approvers,
+ bypassers,
+ approvalsRequired,
+ approvals
+ }: {
+ externalApproval: TExternalApprovalPolicyInput | null;
+ enforcementLevel: string;
+ allowedSelfApprovals: boolean;
+ approvers: TApproverInput;
+ bypassers: TBypasserInput | undefined;
+ approvalsRequired?: { numberOfApprovals: number; stepNumber: number }[];
+ approvals?: number;
+ },
+ scope: { projectId: string; orgId: string }
+ ): Promise<TPolicyReviewers> => {
+ if (externalApproval) {
+ assertExternalApprovalPolicyConstraints({ enforcementLevel, bypassers, allowedSelfApprovals });
+ return NO_REVIEWERS;
+ }
+
+ if (!approvers.length) throw new BadRequestError({ message: "At least one approver should be provided" });
+ const { approverUserIds, groupApprovers } = await $resolveApprovers(approvers, scope);
+ const { bypasserUserIds, groupBypassers } = await $resolveBypassers(bypassers, scope);
+ const steps = $buildSteps({ approverUserIds, groupApprovers, approvalsRequired, approvals });
+ return { steps, bypasserUserIds, groupBypassers };
+ };
+
+ const $assertNoPendingRequests = async (policy: { id: string; name: string }, tx: Knex) => {
+ const pendingRequests = await approvalRequestDAL.findPendingByPolicyIdForUpdate(policy.id, tx);
+ if (!pendingRequests.length) return;
+ throw new ConflictError({
+ message: `Policy '${policy.name}' is handled by an external approval system and has ${pendingRequests.length} pending request(s). Resolve or cancel them before updating the policy.`
+ });
+ };
+
const $getProjectPermission = async ({
actor,
actorId,
@@ -325,6 +378,51 @@ export const secretAccessApprovalGlobalPolicyBridgeServiceFactory = ({
});
};
+ const $replacePolicyScope = async (
+ {
+ policyId,
+ envs,
+ secretPath,
+ steps
+ }: { policyId: string; envs: { id: string; slug: string }[]; secretPath: string; steps: TPolicyStep[] },
+ tx: Knex
+ ) => {
+ await approvalPolicySecretEnvironmentDAL.findByPolicyIdForUpdate(policyId, tx);
+ await $assertNoConflictingPolicy({ envs, secretPath, excludePolicyId: policyId }, tx);
+ await approvalPolicySecretEnvironmentDAL.delete({ policyId }, tx);
+ await approvalPolicySecretEnvironmentDAL.insertMany(
+ envs.map((env) => ({ policyId, envId: env.id, secretPath })),
+ tx
+ );
+ await $resetPendingRequestSteps({ policyId, steps }, tx);
+ };
+
+ const $applyExternalApprovalChange = async (
+ {
+ policyId,
+ existing,
+ incoming
+ }: {
+ policyId: string;
+ existing: TExternalApprovalPolicyInput | null;
+ incoming: TExternalApprovalPolicyInput | null | undefined;
+ },
+ tx: Knex
+ ) => {
+ if (incoming === undefined) return;
+ if (incoming === null) {
+ if (existing) await externalApprovalService.deletePolicyByPolicyId(policyId, tx);
+ return;
+ }
+ if (!existing) {
+ await externalApprovalService.createPolicy({ policyId, ...incoming }, tx);
+ return;
+ }
+ if (isExternalApprovalChanged(existing, incoming)) {
+ await externalApprovalService.updatePolicy({ policyId, ...incoming }, tx);
+ }
+ };
+
const createAccessApprovalPolicy = async ({
name,
actor,
@@ -342,7 +440,9 @@ export const secretAccessApprovalGlobalPolicyBridgeServiceFactory = ({
allowedSelfApprovals,
approvalsRequired,
maxTimePeriod,
- requestExpirationTime
+ requestExpirationTime,
+ externalApproval,
+ orgActor
}: TCreateSecretAccessApprovalGlobalPolicyDTO) => {
const project = await projectDAL.findProjectBySlug(projectSlug, actorOrgId);
if (!project) throw new NotFoundError({ message: `Project with slug '${projectSlug}' not found` });
@@ -369,10 +469,21 @@ export const secretAccessApprovalGlobalPolicyBridgeServiceFactory = ({
throw new NotFoundError({ message: `One or more environments not found: ${notFoundEnvs.join(", ")}` });
}
- const scope = { projectId: project.id, orgId: project.orgId };
- const { approverUserIds, groupApprovers } = await $resolveApprovers(approvers, scope);
- const { bypasserUserIds, groupBypassers } = await $resolveBypassers(bypassers, scope);
- const steps = $buildSteps({ approverUserIds, groupApprovers, approvalsRequired, approvals });
+ const reviewers = await $resolveReviewers(
+ {
+ externalApproval: externalApproval ?? null,
+ enforcementLevel,
+ allowedSelfApprovals,
+ approvers,
+ bypassers,
+ approvalsRequired,
+ approvals
+ },
+ { projectId: project.id, orgId: project.orgId }
+ );
+ if (externalApproval) {
+ await externalApprovalService.validateConnection({ ...externalApproval, projectId: project.id }, orgActor);
+ }
await $assertNoConflictingPolicy({ envs, secretPath });
@@ -405,7 +516,11 @@ export const secretAccessApprovalGlobalPolicyBridgeServiceFactory = ({
tx
);
- await $insertStepsAndBypassers({ policyId: doc.id, steps, bypasserUserIds, groupBypassers }, tx);
+ if (externalApproval) {
+ await externalApprovalService.createPolicy({ policyId: doc.id, ...externalApproval }, tx);
+ } else {
+ await $insertStepsAndBypassers({ policyId: doc.id, ...reviewers }, tx);
+ }
return doc;
});
@@ -414,7 +529,7 @@ export const secretAccessApprovalGlobalPolicyBridgeServiceFactory = ({
id: policy.id,
name: policy.name,
secretPath,
- approvals: steps[0]?.requiredApprovals ?? 1,
+ approvals: reviewers.steps[0]?.requiredApprovals ?? 1,
envId: envs[0].id,
createdAt: policy.createdAt,
updatedAt: policy.updatedAt,
@@ -426,7 +541,8 @@ export const secretAccessApprovalGlobalPolicyBridgeServiceFactory = ({
requestExpirationTime: requestExpirationTime ?? null,
environment: envs[0],
environments: envs,
- projectId: project.id
+ projectId: project.id,
+ externalApproval: externalApproval ?? null
};
};
@@ -446,7 +562,9 @@ export const secretAccessApprovalGlobalPolicyBridgeServiceFactory = ({
approvalsRequired,
environments,
maxTimePeriod,
- requestExpirationTime
+ requestExpirationTime,
+ externalApproval,
+ orgActor
}: TUpdateSecretAccessApprovalGlobalPolicyDTO) => {
const policy = await $findPolicyById(
policyId,
@@ -479,17 +597,29 @@ export const secretAccessApprovalGlobalPolicyBridgeServiceFactory = ({
(envs.length !== currentEnvSlugs.size || envs.some((env) => !currentEnvSlugs.has(env.slug)));
const scopeChanged = nextSecretPath !== policy.secretPath || environmentsChanged;
- const scope = { projectId: policy.projectId, orgId: actorOrgId };
- const { approverUserIds, groupApprovers } = await $resolveApprovers(approvers, scope);
- const { bypasserUserIds, groupBypassers } = await $resolveBypassers(bypassers, scope);
- const steps = $buildSteps({
- approverUserIds,
- groupApprovers,
- approvalsRequired,
- approvals: approvals ?? policy.approvals
- });
+ const existingExternalApproval = policy.externalApproval;
+ const externalApprovalAfterUpdate = externalApproval === undefined ? existingExternalApproval : externalApproval;
+ const involvesExternalApproval = Boolean(existingExternalApproval || externalApprovalAfterUpdate);
+
+ const reviewers = await $resolveReviewers(
+ {
+ externalApproval: externalApprovalAfterUpdate,
+ enforcementLevel: enforcementLevel ?? policy.enforcementLevel,
+ allowedSelfApprovals,
+ approvers,
+ bypassers,
+ approvalsRequired,
+ approvals: approvals ?? policy.approvals
+ },
+ { projectId: policy.projectId, orgId: actorOrgId }
+ );
+ if (externalApproval && isExternalApprovalChanged(existingExternalApproval, externalApproval)) {
+ await externalApprovalService.validateConnection({ ...externalApproval, projectId: policy.projectId }, orgActor);
+ }
return approvalPolicyDAL.transaction(async (tx) => {
+ if (involvesExternalApproval) await $assertNoPendingRequests(policy, tx);
+
await approvalPolicyDAL.updateById(
policy.id,
{
@@ -510,20 +640,20 @@ export const secretAccessApprovalGlobalPolicyBridgeServiceFactory = ({
await approvalPolicyStepsDAL.delete({ policyId: policy.id }, tx);
await approvalPolicyBypassersDAL.delete({ policyId: policy.id }, tx);
- await $insertStepsAndBypassers({ policyId: policy.id, steps, bypasserUserIds, groupBypassers }, tx);
+ if (!externalApprovalAfterUpdate) await $insertStepsAndBypassers({ policyId: policy.id, ...reviewers }, tx);
if (scopeChanged) {
- await approvalPolicySecretEnvironmentDAL.findByPolicyIdForUpdate(policy.id, tx);
- // make sure that the updated secret path is not conflicting with any other policy
- await $assertNoConflictingPolicy({ envs, secretPath: nextSecretPath, excludePolicyId: policy.id }, tx);
- await approvalPolicySecretEnvironmentDAL.delete({ policyId: policy.id }, tx);
- await approvalPolicySecretEnvironmentDAL.insertMany(
- envs.map((env) => ({ policyId: policy.id, envId: env.id, secretPath: nextSecretPath })),
+ await $replacePolicyScope(
+ { policyId: policy.id, envs, secretPath: nextSecretPath, steps: reviewers.steps },
tx
);
- await $resetPendingRequestSteps({ policyId: policy.id, steps }, tx);
}
+ await $applyExternalApprovalChange(
+ { policyId: policy.id, existing: existingExternalApproval, incoming: externalApproval },
+ tx
+ );
+
const [updatedPolicy] = await secretAccessApprovalGlobalPolicyBridgeDAL.findSecretAccessPolicies(
{ policyId: policy.id },
tx
diff --git a/backend/src/services/secret-access-approval-global-policy-bridge/secret-access-approval-global-policy-bridge-types.ts b/backend/src/services/secret-access-approval-global-policy-bridge/secret-access-approval-global-policy-bridge-types.ts
index 77baa3a211..03968d711e 100644
--- a/backend/src/services/secret-access-approval-global-policy-bridge/secret-access-approval-global-policy-bridge-types.ts
+++ b/backend/src/services/secret-access-approval-global-policy-bridge/secret-access-approval-global-policy-bridge-types.ts
@@ -21,6 +21,7 @@ import {
TApprovalRequestStepEligibleApproversDALFactory,
TApprovalRequestStepsDALFactory
} from "@app/services/approval-policy/approval-request-dal";
+import { TExternalApprovalServiceFactory } from "@app/services/external-approval/external-approval-service";
import { TProjectDALFactory } from "@app/services/project/project-dal";
import { TProjectEnvDALFactory } from "@app/services/project-env/project-env-dal";
import { TUserDALFactory } from "@app/services/user/user-dal";
@@ -51,6 +52,10 @@ export type TSecretAccessApprovalGlobalPolicyBridgeServiceFactoryDep = {
TSecretAccessApprovalGlobalPolicyBridgeDALFactory,
"findSecretAccessPolicies"
>;
+ externalApprovalService: Pick<
+ TExternalApprovalServiceFactory,
+ "validateConnection" | "createPolicy" | "updatePolicy" | "deletePolicyByPolicyId"
+ >;
};
export type TCreateSecretAccessApprovalGlobalPolicyDTO = TCreateAccessApprovalPolicy;