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(logger): enhance logging by adding redaction for outgoing request paths and improving error logging in authentication services
Victor Hugo dos Santos68d4341b78db
diff --git a/backend/src/lib/logger/logger.ts b/backend/src/lib/logger/logger.tsindex c21db2fb96..ed4da4d440 100644--- a/backend/src/lib/logger/logger.ts+++ b/backend/src/lib/logger/logger.ts@@ -86,6 +86,16 @@ const redactedKeys = ["X-VAULT-TOKEN"];+const outgoingRequestRedactPaths = [+ "_header",+ "*._header",+ "*.*._header",+ "*.*.*._header",+ "request.path",+ "*.request.path",+ "*.*.request.path"+];+const UNKNOWN_REQUEST_ID = "UNKNOWN_REQUEST_ID";const extractReqId = () => {@@ -163,13 +173,16 @@ export const initLogger = () => {},// redact until depth of three// Keys with special characters (hyphens) need bracket notation for fast-redact- redact: redactedKeys.flatMap((key) => {- if (key.includes("-")) {- const k = `["${key}"]`;- return [k, `*${k}`, `*.*${k}`];- }- return [key, `*.${key}`, `*.*.${key}`];- })+ redact: [+ ...redactedKeys.flatMap((key) => {+ if (key.includes("-")) {+ const k = `["${key}"]`;+ return [k, `*${k}`, `*.*${k}`];+ }+ return [key, `*.${key}`, `*.*.${key}`];+ }),+ ...outgoingRequestRedactPaths+ ]},// eslint-disable-next-line @typescript-eslint/no-unsafe-argumenttransportdiff --git a/backend/src/services/identity-alicloud-auth/identity-alicloud-auth-service.ts b/backend/src/services/identity-alicloud-auth/identity-alicloud-auth-service.tsindex cb7a5b0e60..c169c7f9eb 100644--- a/backend/src/services/identity-alicloud-auth/identity-alicloud-auth-service.ts+++ b/backend/src/services/identity-alicloud-auth/identity-alicloud-auth-service.ts@@ -118,7 +118,10 @@ export const identityAliCloudAuthServiceFactory = ({}const { data } = await request.get<TAliCloudGetUserResponse>(requestUrl.toString()).catch((err: AxiosError) => {- logger.error(err.response, "AliCloudIdentityLogin: Failed to authenticate with Alibaba Cloud");+ logger.error(+ { status: err.response?.status, code: err.code, message: err.message, responseData: err.response?.data },+ `AliCloudIdentityLogin: Failed to authenticate with Alibaba Cloud [identityId=${identity.id}] [status=${err.response?.status}]`+ );throw err;});diff --git a/backend/src/services/identity-kubernetes-auth/identity-kubernetes-auth-fns.test.ts b/backend/src/services/identity-kubernetes-auth/identity-kubernetes-auth-fns.test.tsindex 8ac82a5a41..7ca487273e 100644--- a/backend/src/services/identity-kubernetes-auth/identity-kubernetes-auth-fns.test.ts+++ b/backend/src/services/identity-kubernetes-auth/identity-kubernetes-auth-fns.test.ts@@ -2,11 +2,45 @@ import { describe, expect, it } from "vitest";import {extractK8sUsername,+ getJwtFingerprintForLog,getKubernetesHostname,getKubernetesServerName,+ getKubernetesStatusForLog,withKubernetesHostScheme} from "./identity-kubernetes-auth-fns";+describe("getJwtFingerprintForLog", () => {+ const jwt = "eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJzeXN0ZW06c2VydmljZWFjY291bnQifQ.c2lnbmF0dXJlLWJ5dGVz";++ it("returns a stable 12-char hex digest that shares no substring with the token", () => {+ const fingerprint = getJwtFingerprintForLog(jwt) as string;++ expect(fingerprint).toMatch(/^[0-9a-f]{12}$/);+ expect(getJwtFingerprintForLog(jwt)).toBe(fingerprint);+ expect(getJwtFingerprintForLog(`${jwt}x`)).not.toBe(fingerprint);+ expect(jwt).not.toContain(fingerprint);+ });++ it("returns undefined for a missing token", () => {+ expect(getJwtFingerprintForLog("")).toBeUndefined();+ expect(getJwtFingerprintForLog(undefined)).toBeUndefined();+ });+});++describe("getKubernetesStatusForLog", () => {+ it("keeps only reason and message from a Status body, bounded", () => {+ expect(+ getKubernetesStatusForLog({ kind: "Status", reason: "Forbidden", message: "m".repeat(5000), details: { x: 1 } })+ ).toEqual({ reason: "Forbidden", message: `${"m".repeat(1024)}...[truncated]` });+ });++ it("treats a string body as the message and ignores anything else", () => {+ expect(getKubernetesStatusForLog("upstream error")).toEqual({ message: "upstream error" });+ expect(getKubernetesStatusForLog(undefined)).toEqual({});+ expect(getKubernetesStatusForLog(401)).toEqual({});+ });+});+describe("withKubernetesHostScheme", () => {it("leaves an explicit scheme alone and defaults the rest to https", () => {expect(withKubernetesHostScheme("https://k8s.example.com:6443")).toBe("https://k8s.example.com:6443");diff --git a/backend/src/services/identity-kubernetes-auth/identity-kubernetes-auth-fns.ts b/backend/src/services/identity-kubernetes-auth/identity-kubernetes-auth-fns.tsindex 4f9c1200e0..3d925676a1 100644--- a/backend/src/services/identity-kubernetes-auth/identity-kubernetes-auth-fns.ts+++ b/backend/src/services/identity-kubernetes-auth/identity-kubernetes-auth-fns.ts@@ -2,9 +2,29 @@ import { isIP } from "node:net";import RE2 from "re2";+import { crypto } from "@app/lib/crypto/cryptography";import { BadRequestError } from "@app/lib/errors";const SCHEME_PREFIX = "^https?://";+const MAX_STATUS_FIELD_LOG_LENGTH = 1024;+const JWT_FINGERPRINT_LENGTH = 12;++export const getJwtFingerprintForLog = (jwt?: string) =>+ jwt ? crypto.nativeCrypto.createHash("sha256").update(jwt).digest("hex").slice(0, JWT_FINGERPRINT_LENGTH) : undefined;++const truncateStatusField = (value: unknown) => {+ if (typeof value !== "string") return undefined;+ return value.length > MAX_STATUS_FIELD_LOG_LENGTH+ ? `${value.slice(0, MAX_STATUS_FIELD_LOG_LENGTH)}...[truncated]`+ : value;+};++export const getKubernetesStatusForLog = (data: unknown): { reason?: string; message?: string } => {+ if (typeof data === "string") return { message: truncateStatusField(data) };+ if (!data || typeof data !== "object") return {};+ const { reason, message } = data as { reason?: unknown; message?: unknown };+ return { reason: truncateStatusField(reason), message: truncateStatusField(message) };+};// The stored host may omit a scheme. URL parsing, SSRF validation and Axios all need one.export const withKubernetesHostScheme = (kubernetesHost: string) =>diff --git a/backend/src/services/identity-kubernetes-auth/identity-kubernetes-auth-service.ts b/backend/src/services/identity-kubernetes-auth/identity-kubernetes-auth-service.tsindex 2c36ea6dff..55250a448f 100644--- a/backend/src/services/identity-kubernetes-auth/identity-kubernetes-auth-service.ts+++ b/backend/src/services/identity-kubernetes-auth/identity-kubernetes-auth-service.ts@@ -72,8 +72,10 @@ import { TIdentityKubernetesAuthDALFactory } from "./identity-kubernetes-auth-daimport { handleAxiosError, isKnownError, KubernetesAuthErrorContext } from "./identity-kubernetes-auth-error-handlers";import {extractK8sUsername,+ getJwtFingerprintForLog,getKubernetesHostname,getKubernetesServerName,+ getKubernetesStatusForLog,withKubernetesHostScheme} from "./identity-kubernetes-auth-fns";import {@@ -421,28 +423,29 @@ export const identityKubernetesAuthServiceFactory = ({servername})).catch((err) => {- const tokenReviewerJwtSnippet = `${tokenReviewerJwt?.substring?.(0, 10) || ""}...${tokenReviewerJwt?.substring?.(tokenReviewerJwt.length - 10) || ""}`;- const serviceAccountJwtSnippet = `${serviceAccountJwt?.substring?.(0, 10) || ""}...${serviceAccountJwt?.substring?.(serviceAccountJwt.length - 10) || ""}`;+ const tokenReviewerJwtFingerprint = getJwtFingerprintForLog(tokenReviewerJwt);+ const serviceAccountJwtFingerprint = getJwtFingerprintForLog(serviceAccountJwt);if (err instanceof AxiosError) {logger.error({- response: err.response,host,port,- tokenReviewerJwtSnippet,- serviceAccountJwtSnippet,- code: err.code+ status: err.response?.status,+ code: err.code,+ ...getKubernetesStatusForLog(err.response?.data),+ tokenReviewerJwtFingerprint,+ serviceAccountJwtFingerprint},- "tokenReviewCallbackRaw: Kubernetes token review request error (request error)"+ `tokenReviewCallbackRaw: Kubernetes token review request error (request error) [identityId=${identityKubernetesAuth.identityId}] [status=${err.response?.status}] [code=${err.code}]`);throw handleAxiosError(err, { host, port }, KubernetesAuthErrorContext.KubernetesApiServer);}logger.error(- { error: err as Error, host, port, tokenReviewerJwtSnippet, serviceAccountJwtSnippet },- "tokenReviewCallbackRaw: Kubernetes token review request error (non-request error)"+ { error: err as Error, host, port, tokenReviewerJwtFingerprint, serviceAccountJwtFingerprint },+ `tokenReviewCallbackRaw: Kubernetes token review request error (non-request error) [identityId=${identityKubernetesAuth.identityId}]`);if (isKnownError(err)) {diff --git a/backend/src/services/identity-oci-auth/identity-oci-auth-service.ts b/backend/src/services/identity-oci-auth/identity-oci-auth-service.tsindex 7fc289cf7d..3a11dad6e9 100644--- a/backend/src/services/identity-oci-auth/identity-oci-auth-service.ts+++ b/backend/src/services/identity-oci-auth/identity-oci-auth-service.ts@@ -140,7 +140,10 @@ export const identityOciAuthServiceFactory = ({headers}).catch((err: AxiosError) => {- logger.error(err.response, "OciIdentityLogin: Failed to authenticate with Oracle Cloud");+ logger.error(+ { status: err.response?.status, code: err.code, message: err.message, responseData: err.response?.data },+ `OciIdentityLogin: Failed to authenticate with Oracle Cloud [identityId=${identity.id}] [status=${err.response?.status}]`+ );throw err;});