Skip to content

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

fix(pki): tidy issuance failure metadata and ACM final-attempt message

bernie-g7230e216e619
diff --git a/backend/src/ee/services/pki-acme/pki-acme-service.ts b/backend/src/ee/services/pki-acme/pki-acme-service.ts
index d459e9631d..ad47553799 100644
--- a/backend/src/ee/services/pki-acme/pki-acme-service.ts
+++ b/backend/src/ee/services/pki-acme/pki-acme-service.ts
@@ -1249,8 +1249,8 @@ export const pkiAcmeServiceFactory = ({
profileName: profile.slug,
caId: ca.id,
caName: ca.name,
- ...(certificateRequest.commonName && { commonName: certificateRequest.commonName }),
- ...(accountApplicationId && { applicationId: accountApplicationId })
+ commonName: certificateRequest.commonName,
+ applicationId: accountApplicationId
}
}
);
diff --git a/backend/src/ee/services/pki-scep/pki-scep-service.ts b/backend/src/ee/services/pki-scep/pki-scep-service.ts
index 720e36e5bb..d16471a58f 100644
--- a/backend/src/ee/services/pki-scep/pki-scep-service.ts
+++ b/backend/src/ee/services/pki-scep/pki-scep-service.ts
@@ -1074,9 +1074,9 @@ export const pkiScepServiceFactory = ({
enrollmentType: EnrollmentType.SCEP,
certificateProfileId: params.profile.id,
profileName: params.profile.slug,
- ...(params.profile.caId && { caId: params.profile.caId }),
- ...(commonName && { commonName }),
- ...(params.applicationId && { applicationId: params.applicationId })
+ caId: params.profile.caId,
+ commonName,
+ applicationId: params.applicationId
}
}
);
diff --git a/backend/src/services/certificate-authority/certificate-issuance-queue.ts b/backend/src/services/certificate-authority/certificate-issuance-queue.ts
index 1990f11f12..e55637e31c 100644
--- a/backend/src/services/certificate-authority/certificate-issuance-queue.ts
+++ b/backend/src/services/certificate-authority/certificate-issuance-queue.ts
@@ -1321,14 +1321,15 @@ export const certificateIssuanceQueueFactory = ({
const isFinalAttempt = attemptsMade + 1 >= maxAttempts;
const { certificateRequestId, certificateId, caId } = job.data;
if (isFinalAttempt && certificateRequestId && certificateRequestService) {
+ const finalMessage = `AWS ACM DNS validation did not complete after ${maxAttempts} attempts: ${error.message}`;
try {
await certificateRequestService.updateCertificateRequestStatus({
certificateRequestId,
status: CertificateRequestStatus.FAILED,
operation: job.data.isRenewal ? CertificateIssuanceOperation.RENEW : CertificateIssuanceOperation.ORDER,
originalCertificateId: job.data.originalCertificateId,
- error,
- errorMessage: `AWS ACM DNS validation did not complete after ${maxAttempts} attempts: ${error.message}`
+ error: new AcmPendingError(finalMessage),
+ errorMessage: finalMessage
});
logger.info(
`Marked certificate request FAILED after exhausted ACM validation retries [certificateRequestId=${certificateRequestId}] [certificateId=${certificateId}] [caId=${caId}]`
diff --git a/backend/src/services/certificate-common/certificate-issuance-audit-fns.test.ts b/backend/src/services/certificate-common/certificate-issuance-audit-fns.test.ts
index cb37438801..87298559bd 100644
--- a/backend/src/services/certificate-common/certificate-issuance-audit-fns.test.ts
+++ b/backend/src/services/certificate-common/certificate-issuance-audit-fns.test.ts
@@ -74,6 +74,21 @@ describe("recordCertificateIssuanceFailure", () => {
});
});
+ it("drops empty metadata fields", async () => {
+ const { deps, record } = setup();
+
+ await record(new Error("x"), { commonName: "", applicationId: null, caId: undefined });
+
+ const [call] = deps.auditLogService.createCollapsedAuditLog.mock.calls[0] as [
+ { event: { metadata: Record<string, unknown> } }
+ ];
+ expect(call.event.metadata).toEqual({
+ operation: CertificateIssuanceOperation.ISSUE,
+ errorName: "Error",
+ error: "x"
+ });
+ });
+
it("does not look up names it was already given", async () => {
const { deps, record } = setup();
diff --git a/backend/src/services/certificate-common/certificate-issuance-audit-fns.ts b/backend/src/services/certificate-common/certificate-issuance-audit-fns.ts
index ab34cabe96..9f6e245632 100644
--- a/backend/src/services/certificate-common/certificate-issuance-audit-fns.ts
+++ b/backend/src/services/certificate-common/certificate-issuance-audit-fns.ts
@@ -20,6 +20,16 @@ type TCertificateIssuanceFailedMetadata = Omit<
"errorName" | "error" | keyof TAuditLogCollapseSummary
>;
+// Callers pass whatever they have; empty values are dropped before the event is written.
+type TCertificateIssuanceFailedMetadataInput = Pick<TCertificateIssuanceFailedMetadata, "operation"> & {
+ [K in Exclude<keyof TCertificateIssuanceFailedMetadata, "operation">]?: TCertificateIssuanceFailedMetadata[K] | null;
+};
+
+const withoutEmptyFields = <T extends Record<string, unknown>>(fields: T) =>
+ Object.fromEntries(
+ Object.entries(fields).filter(([, value]) => value !== undefined && value !== null && value !== "")
+ ) as { [K in keyof T]: Exclude<T[K], null> };
+
export type TRecordCertificateIssuanceFailureDeps = {
auditLogService: Pick<TAuditLogServiceFactory, "createCollapsedAuditLog">;
certificateAuthorityDAL?: Pick<TCertificateAuthorityDALFactory, "findById">;
@@ -30,7 +40,7 @@ export type TRecordCertificateIssuanceFailureDTO = {
auditLogInfo: AuditLogInfo;
projectId: string;
error: unknown;
- metadata: TCertificateIssuanceFailedMetadata;
+ metadata: TCertificateIssuanceFailedMetadataInput;
};
// Lets the code that created a certificate request attach its id to the error it rethrows, so the
@@ -73,10 +83,13 @@ export const recordCertificateIssuanceFailure = async (
event: {
type: EventType.CERTIFICATE_ISSUANCE_FAILED,
metadata: {
- ...metadata,
- ...(certificateRequestId && { certificateRequestId }),
- ...(ca?.name && { caName: ca.name }),
- ...(application?.name && { applicationName: application.name }),
+ ...withoutEmptyFields({
+ ...metadata,
+ certificateRequestId,
+ caName: metadata.caName ?? ca?.name,
+ applicationName: metadata.applicationName ?? application?.name
+ }),
+ operation: metadata.operation,
errorName,
error: errorMessage
}
diff --git a/backend/src/services/certificate-request/certificate-request-fns.ts b/backend/src/services/certificate-request/certificate-request-fns.ts
index f2d91ee5a8..eea3c1d5ff 100644
--- a/backend/src/services/certificate-request/certificate-request-fns.ts
+++ b/backend/src/services/certificate-request/certificate-request-fns.ts
@@ -131,16 +131,14 @@ export const recordCertificateRequestFailure = async (
error: error ?? new Error(certificateRequest.errorMessage || "Certificate issuance failed"),
metadata: {
operation: resolvedOperation,
- ...(certificateRequest.enrollmentType && {
- enrollmentType: certificateRequest.enrollmentType as EnrollmentType
- }),
+ enrollmentType: certificateRequest.enrollmentType as EnrollmentType | null,
certificateRequestId: certificateRequest.id,
- ...(certificateRequest.profileId && { certificateProfileId: certificateRequest.profileId }),
- ...(profile && { profileName: profile.slug }),
- ...(certificateRequest.caId && { caId: certificateRequest.caId }),
- ...(commonName && { commonName }),
- ...(originalCertificateId && { originalCertificateId }),
- ...(certificateRequest.applicationId && { applicationId: certificateRequest.applicationId })
+ certificateProfileId: certificateRequest.profileId,
+ profileName: profile?.slug,
+ caId: certificateRequest.caId,
+ commonName,
+ originalCertificateId,
+ applicationId: certificateRequest.applicationId
}
});
} catch (auditError) {
diff --git a/backend/src/services/certificate-v3/certificate-v3-service.ts b/backend/src/services/certificate-v3/certificate-v3-service.ts
index 351eb8cf99..e94aac1c2a 100644
--- a/backend/src/services/certificate-v3/certificate-v3-service.ts
+++ b/backend/src/services/certificate-v3/certificate-v3-service.ts
@@ -594,8 +594,9 @@ export const certificateV3ServiceFactory = ({
error,
metadata: {
...metadata,
- ...(profile && { certificateProfileId: profile.id, profileName: profile.slug }),
- ...(!metadata.caId && profile?.caId && { caId: profile.caId })
+ certificateProfileId: profile?.id,
+ profileName: profile?.slug,
+ caId: metadata.caId ?? profile?.caId
}
}
);
@@ -2391,8 +2392,8 @@ export const certificateV3ServiceFactory = ({
metadata: {
operation: CertificateIssuanceOperation.ISSUE,
enrollmentType: EnrollmentType.API,
- ...(dto.certificateRequest.commonName && { commonName: dto.certificateRequest.commonName }),
- ...(dto.applicationId && { applicationId: dto.applicationId })
+ commonName: dto.certificateRequest.commonName,
+ applicationId: dto.applicationId
}
});
throw error;
@@ -2403,7 +2404,6 @@ export const certificateV3ServiceFactory = ({
try {
return await $signCertificateFromProfile(dto);
} catch (error) {
- const commonName = $commonNameFromCsr(dto.csr);
await $recordIssuanceFailure({
auditLogInfo: dto.auditLogInfo,
actorOrgId: dto.actorOrgId,
@@ -2412,8 +2412,8 @@ export const certificateV3ServiceFactory = ({
metadata: {
operation: dto.issuanceOperation ?? CertificateIssuanceOperation.SIGN,
enrollmentType: dto.enrollmentType,
- ...(commonName && { commonName }),
- ...(dto.applicationId && { applicationId: dto.applicationId })
+ commonName: $commonNameFromCsr(dto.csr),
+ applicationId: dto.applicationId
}
});
throw error;
@@ -2424,7 +2424,6 @@ export const certificateV3ServiceFactory = ({
try {
return await $orderCertificate(dto);
} catch (error) {
- const commonName = dto.certificateOrder.commonName || $commonNameFromCsr(dto.certificateOrder.csr);
await $recordIssuanceFailure({
auditLogInfo: dto.auditLogInfo,
actorOrgId: dto.actorOrgId,
@@ -2433,8 +2432,8 @@ export const certificateV3ServiceFactory = ({
metadata: {
operation: CertificateIssuanceOperation.ORDER,
enrollmentType: EnrollmentType.API,
- ...(commonName && { commonName }),
- ...(dto.applicationId && { applicationId: dto.applicationId })
+ commonName: dto.certificateOrder.commonName || $commonNameFromCsr(dto.certificateOrder.csr),
+ applicationId: dto.applicationId
}
});
throw error;
@@ -2460,8 +2459,8 @@ export const certificateV3ServiceFactory = ({
enrollmentType: EnrollmentType.API,
originalCertificateId: certificate.id,
commonName: certificate.commonName,
- ...(certificate.caId && { caId: certificate.caId }),
- ...(certificate.applicationId && { applicationId: certificate.applicationId })
+ caId: certificate.caId,
+ applicationId: certificate.applicationId
}
});
}
diff --git a/docs/documentation/platform/audit-logs.mdx b/docs/documentation/platform/audit-logs.mdx
index 78ec47887b..20a521d52f 100644
--- a/docs/documentation/platform/audit-logs.mdx
+++ b/docs/documentation/platform/audit-logs.mdx
@@ -305,9 +305,9 @@ To keep a misconfigured client from filling the log, Infisical records the first
### Certificate issuance failures
-If Infisical can't issue a certificate, it records a `certificate-issuance-failed` event with the reason. Infisical records the event for certificates requested from a certificate profile through the API or the Infisical UI, ACME, EST, and SCEP, including manual renewals and certificates issued after an approval. The event is in the `management` class, so it's always recorded.
+If Infisical can't issue a certificate, it records a `certificate-issuance-failed` event with the reason. Infisical records the event for certificates requested from a certificate profile through the API or the Infisical UI, ACME, EST, and SCEP, including renewals and certificates issued after an approval. The event is in the `management` class, so it's always recorded.
-Infisical doesn't record the event for automatic renewals, for EST enrollment through a certificate template, or for EST requests rejected before Infisical reads the CSR, such as a failed sign-in.
+If an automatic renewal fails before Infisical sends it to an external CA, Infisical records an `automated-renew-certificate-failed` event instead. Infisical doesn't record the event for EST enrollment through a certificate template, or for EST requests rejected before Infisical reads the CSR, such as a failed sign-in.
The event records which certificate failed and why: