Skip to content

A local-first personal finance app

[AI] Fix newline conversion for HTTPS key and cert environment variables (#9265)

spa77k7cd04aaf0df7
diff --git a/packages/sync-server/src/app-https-config.test.ts b/packages/sync-server/src/app-https-config.test.ts
new file mode 100644
index 0000000000..6f0948cb8a
--- /dev/null
+++ b/packages/sync-server/src/app-https-config.test.ts
@@ -0,0 +1,34 @@
+import { fileURLToPath } from 'node:url';
+
+import { describe, expect, it } from 'vitest';
+
+import { parseHTTPSConfig } from './app';
+
+describe('parseHTTPSConfig', () => {
+ it('converts escaped newlines in PEM values to real newlines', () => {
+ const key =
+ '-----BEGIN PRIVATE KEY-----\\nMIIEvQIBADANBgkq\\n-----END PRIVATE KEY-----';
+ const cert =
+ '-----BEGIN CERTIFICATE-----\\nMIIDazCCAlOgAwIBAgIU\\n-----END CERTIFICATE-----';
+
+ expect(parseHTTPSConfig(key)).toBe(
+ '-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkq\n-----END PRIVATE KEY-----',
+ );
+ expect(parseHTTPSConfig(cert)).toBe(
+ '-----BEGIN CERTIFICATE-----\nMIIDazCCAlOgAwIBAgIU\n-----END CERTIFICATE-----',
+ );
+ });
+
+ it('leaves PEM values that already contain newlines unchanged', () => {
+ const cert =
+ '-----BEGIN CERTIFICATE-----\nMIIDazCCAlOgAwIBAgIU\n-----END CERTIFICATE-----';
+
+ expect(parseHTTPSConfig(cert)).toBe(cert);
+ });
+
+ it('still reads the value from a file path', () => {
+ const filePath = fileURLToPath(new URL('../package.json', import.meta.url));
+
+ expect(parseHTTPSConfig(filePath)).toBeInstanceOf(Buffer);
+ });
+});
diff --git a/packages/sync-server/src/app.ts b/packages/sync-server/src/app.ts
index 189a6b3fe1..88f1c1de25 100644
--- a/packages/sync-server/src/app.ts
+++ b/packages/sync-server/src/app.ts
@@ -181,9 +181,11 @@ if (isDev) {
);
}
-function parseHTTPSConfig(value: string) {
+export function parseHTTPSConfig(value: string) {
if (value.startsWith('-----BEGIN')) {
- return value;
+ // Values passed via environment variables may escape newlines as `\n`.
+ // Restore them so the PEM data is valid.
+ return value.replace(/\\n/g, '\n');
}
return fs.readFileSync(value);
}
diff --git a/upcoming-release-notes/https-env-newlines.md b/upcoming-release-notes/https-env-newlines.md
new file mode 100644
index 0000000000..f1041e3fdc
--- /dev/null
+++ b/upcoming-release-notes/https-env-newlines.md
@@ -0,0 +1,6 @@
+---
+category: Bugfix
+authors: [spa77k]
+---
+
+Fix HTTPS key and certificate environment variables when newlines are written as `\n`