Skip to content

Never stop coding. Free MIT AI gateway: one endpoint, 375 providers (150+ free), 1,400+ models Kimi, Claude, GPT, Gemini, GLM, DeepSeek, MiniMax. Works with Claude Code, Codex, Cursor, OpenCode, Cline & Copilot. Quota-aware auto-fallback, RTK+Caveman compression saves 15-95% tokens, MCP/A2A, Desktop/PWA. Built by 900+ contributors

3.6 KB
Raw Blame
/**
 * Secret handling for destination configs.
 *
 * Which keys are secret is declared by the destination type (`secretFields`), so this
 * module stays generic: encrypt on write, decrypt only when a client is constructed,
 * and redact before anything reaches an API response.
 */

import { decrypt, encrypt, isEncryptionEnabled } from "@/lib/db/encryption";
import { getLogExportDestinationType } from "./registry";

/** Placeholder returned by the API in place of a stored secret. */
export const SECRET_PLACEHOLDER = "__stored__";

function secretKeysFor(type: string): readonly string[] {
  return getLogExportDestinationType(type)?.secretFields ?? [];
}

/**
 * True when this destination type stores a credential AND field encryption is off.
 *
 * `encrypt()` is a silent passthrough without STORAGE_ENCRYPTION_KEY, which is the
 * default for a fresh install — so writing a service-account key would land it in
 * SQLite as plaintext. Callers refuse the write instead (the same guard the Telegram
 * webhook uses).
 */
export function requiresEncryptionKey(type: string, config: Record<string, unknown>): boolean {
  if (isEncryptionEnabled()) return false;
  return secretKeysFor(type).some((key) => {
    const value = config[key];
    return typeof value === "string" && value.length > 0;
  });
}

/** Encrypt every declared secret key. Non-secret keys pass through untouched. */
export function encryptDestinationConfig(
  type: string,
  config: Record<string, unknown>
): Record<string, unknown> {
  const secretKeys = secretKeysFor(type);
  if (secretKeys.length === 0) return { ...config };
  const out: Record<string, unknown> = { ...config };
  for (const key of secretKeys) {
    const value = out[key];
    if (typeof value === "string" && value.length > 0) out[key] = encrypt(value);
  }
  return out;
}

/** Decrypt declared secret keys for runtime use. Never feed the result to a response. */
export function decryptDestinationConfig(
  type: string,
  config: Record<string, unknown>
): Record<string, unknown> {
  const secretKeys = secretKeysFor(type);
  if (secretKeys.length === 0) return { ...config };
  const out: Record<string, unknown> = { ...config };
  for (const key of secretKeys) {
    const value = out[key];
    if (typeof value === "string" && value.length > 0) out[key] = decrypt(value) ?? "";
  }
  return out;
}

/**
 * Replace declared secrets with a placeholder for API responses. A stored secret
 * becomes SECRET_PLACEHOLDER; an absent one stays absent, so the UI can tell
 * "configured" from "never set".
 */
export function redactDestinationConfig(
  type: string,
  config: Record<string, unknown>
): Record<string, unknown> {
  const secretKeys = secretKeysFor(type);
  const out: Record<string, unknown> = { ...config };
  for (const key of secretKeys) {
    const value = out[key];
    if (typeof value === "string" && value.length > 0) out[key] = SECRET_PLACEHOLDER;
    else delete out[key];
  }
  return out;
}

/**
 * Merge an incoming config over the stored one, keeping the stored ciphertext wherever
 * the caller sent back the placeholder (an edit that did not retype the secret).
 */
export function mergeDestinationConfig(
  type: string,
  storedConfig: Record<string, unknown>,
  incomingConfig: Record<string, unknown>
): Record<string, unknown> {
  const merged: Record<string, unknown> = { ...incomingConfig };
  for (const key of secretKeysFor(type)) {
    if (merged[key] === SECRET_PLACEHOLDER || merged[key] === undefined) {
      if (storedConfig[key] !== undefined) merged[key] = storedConfig[key];
      else delete merged[key];
    }
  }
  return merged;
}