Spaces:
Paused
Paused
File size: 8,209 Bytes
35743bd | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 | /**
* Field-Level Encryption — AES-256-GCM
*
* Encrypts/decrypts sensitive fields (API keys, tokens) stored in SQLite.
* Format: `enc:v1:<iv_hex>:<ciphertext_hex>:<authTag_hex>`
*
* If STORAGE_ENCRYPTION_KEY is not set, operates in passthrough mode
* (stores plaintext for development convenience).
*/
import { createCipheriv, createDecipheriv, randomBytes, scryptSync, createHash } from "crypto";
const ALGORITHM = "aes-256-gcm";
const IV_LENGTH = 16;
const KEY_LENGTH = 32;
const PREFIX = "enc:v1:";
let _derivedKey: Buffer | null = null;
let _legacyDerivedKey: Buffer | null = null;
/** Connection object with potentially encrypted credential fields. */
export interface ConnectionFields {
apiKey?: string | null;
accessToken?: string | null;
refreshToken?: string | null;
idToken?: string | null;
[key: string]: unknown;
}
/**
* Derive a 256-bit key from the env secret using scrypt.
* Returns null if no encryption key is configured.
*/
function getKey(): Buffer | null {
if (_derivedKey !== null) return _derivedKey;
const secret = process.env.STORAGE_ENCRYPTION_KEY;
if (!secret) return null;
if (typeof secret !== "string" || secret.trim().length === 0) {
console.error(
"[Encryption] STORAGE_ENCRYPTION_KEY is set but empty or invalid. " +
"Generate a valid key with: openssl rand -base64 32"
);
return null;
}
// Dynamic salt derived from key hash to prevent rainbow table attacks, while remaining deterministic
const salt = createHash("sha256").update(secret).digest().slice(0, 16);
try {
_derivedKey = scryptSync(secret, salt, KEY_LENGTH);
} catch (err: unknown) {
const message = err instanceof Error ? err.message : String(err);
console.error(
`[Encryption] Failed to derive key from STORAGE_ENCRYPTION_KEY: ${message}. ` +
`Generate a valid key with: openssl rand -base64 32`
);
return null;
}
return _derivedKey;
}
/**
* Derive legacy 256-bit key from the env secret using the old static salt.
* Used exclusively for fallback decryption.
*/
function getLegacyKey(): Buffer | null {
if (_legacyDerivedKey !== null) return _legacyDerivedKey;
const secret = process.env.STORAGE_ENCRYPTION_KEY;
if (!secret || typeof secret !== "string" || secret.trim().length === 0) return null;
const legacySalt = "omniroute-field-encryption-v1";
try {
_legacyDerivedKey = scryptSync(secret, legacySalt, KEY_LENGTH);
} catch {
return null;
}
return _legacyDerivedKey;
}
/** Check if encryption is enabled. */
export function isEncryptionEnabled(): boolean {
return !!process.env.STORAGE_ENCRYPTION_KEY;
}
/**
* Encrypt a plaintext string. Returns ciphertext with prefix.
* If encryption is not configured, returns plaintext unchanged.
*/
export function encrypt(plaintext: string | null | undefined): string | null | undefined {
if (!plaintext || typeof plaintext !== "string") return plaintext;
const key = getKey();
if (!key) {
console.warn(
"[Encryption] STORAGE_ENCRYPTION_KEY not set. Storing plaintext (passthrough mode)."
);
return plaintext; // passthrough mode
}
// Already encrypted — don't double-encrypt
if (plaintext.startsWith(PREFIX)) return plaintext;
try {
const iv = randomBytes(IV_LENGTH);
const cipher = createCipheriv(ALGORITHM, key, iv);
let encrypted = cipher.update(plaintext, "utf8", "hex");
encrypted += cipher.final("hex");
const authTag = cipher.getAuthTag().toString("hex");
return `${PREFIX}${iv.toString("hex")}:${encrypted}:${authTag}`;
} catch (err: unknown) {
const message = err instanceof Error ? err.message : String(err);
console.error(
`[Encryption] Encryption failed: ${message}. ` +
`Check your STORAGE_ENCRYPTION_KEY — generate one with: openssl rand -base64 32`
);
return plaintext; // fallback to plaintext rather than crashing
}
}
/**
* Decrypt a ciphertext string. If not encrypted (no prefix), returns as-is.
*/
export function decrypt(ciphertext: string | null | undefined): string | null | undefined {
if (!ciphertext || typeof ciphertext !== "string") return ciphertext;
// Not encrypted — return as-is (legacy plaintext or passthrough mode)
if (!ciphertext.startsWith(PREFIX)) return ciphertext;
const key = getKey();
if (!key) {
console.warn(
"[Encryption] Found encrypted data but STORAGE_ENCRYPTION_KEY is not set. Cannot decrypt."
);
// Return null instead of encrypted ciphertext to prevent sending encrypted tokens to providers
return null;
}
const body = ciphertext.slice(PREFIX.length);
const parts = body.split(":");
if (parts.length !== 3) {
console.error("[Encryption] Malformed encrypted value");
// Return null instead of encrypted ciphertext to prevent sending malformed encrypted tokens to providers
return null;
}
const [ivHex, encryptedHex, authTagHex] = parts;
const tryDecryptWithKey = (candidateKey: Buffer): string | null => {
try {
const iv = Buffer.from(ivHex, "hex");
const authTag = Buffer.from(authTagHex, "hex");
const decipher = createDecipheriv(ALGORITHM, candidateKey, iv);
decipher.setAuthTag(authTag);
let decrypted = decipher.update(encryptedHex, "hex", "utf8");
decrypted += decipher.final("utf8");
return decrypted;
} catch {
return null;
}
};
try {
const decrypted = tryDecryptWithKey(key);
if (decrypted !== null) {
return decrypted;
}
const legacyKey = getLegacyKey();
if (legacyKey) {
const legacyDecrypted = tryDecryptWithKey(legacyKey);
if (legacyDecrypted !== null) {
return legacyDecrypted;
}
}
console.error(
`[Encryption] Decryption failed. Ciphertext prefix: ${ciphertext.slice(0, 30)}... ` +
`Auth tag validation likely failed.`
);
return null;
} catch (err: unknown) {
const message = err instanceof Error ? err.message : String(err);
console.error("[Encryption] Decryption failed:", message);
// Return null instead of encrypted ciphertext to prevent sending encrypted tokens to providers
return null;
}
}
/**
* Encrypt sensitive fields in a connection object (mutates in-place).
*/
export function encryptConnectionFields<T extends ConnectionFields | null | undefined>(conn: T): T {
if (!isEncryptionEnabled()) return conn;
if (!conn) return conn;
if (conn.apiKey) conn.apiKey = encrypt(conn.apiKey);
if (conn.accessToken) conn.accessToken = encrypt(conn.accessToken);
if (conn.refreshToken) conn.refreshToken = encrypt(conn.refreshToken);
if (conn.idToken) conn.idToken = encrypt(conn.idToken);
return conn;
}
/**
* Decrypt sensitive fields in a connection row (returns new object).
*/
export function decryptConnectionFields<T extends ConnectionFields | null | undefined>(row: T): T {
if (!row) return row;
if (!isEncryptionEnabled()) return row;
return {
...row,
apiKey: decrypt(row.apiKey),
accessToken: decrypt(row.accessToken),
refreshToken: decrypt(row.refreshToken),
idToken: decrypt(row.idToken),
};
}
/**
* Validate encryption configuration at startup.
* Returns { valid: true } or { valid: false, error: string } with actionable guidance.
*/
export function validateEncryptionConfig(): { valid: boolean; error?: string } {
const secret = process.env.STORAGE_ENCRYPTION_KEY;
// No key set — passthrough mode is fine
if (!secret) return { valid: true };
if (typeof secret !== "string" || secret.trim().length === 0) {
return {
valid: false,
error:
"STORAGE_ENCRYPTION_KEY is set but empty. " +
"Either remove it (passthrough mode) or set a valid key: openssl rand -base64 32",
};
}
// Try deriving a key to verify it works
try {
scryptSync(secret, "omniroute-field-encryption-v1", KEY_LENGTH);
return { valid: true };
} catch (err: unknown) {
const message = err instanceof Error ? err.message : String(err);
return {
valid: false,
error:
`STORAGE_ENCRYPTION_KEY is invalid (${message}). ` +
`Generate a valid key with: openssl rand -base64 32`,
};
}
}
|