feat(config): support modern ECDH/AES-GCM encryption

lib/config/__fixtures__/private-ec.json

@@ -0,0 +1,7 @@
+{
+  "kty":"EC",
+  "x":"pqwOZwVa3iiV1gnmsnHWYSYZgc37xH_FO_Ja0_F9SjFPiHUg-WLl6HEYzjIvls13",
+  "y":"fs_xLEuA1S3p47GY3GG2S_0YW7RTitKTOEbAnpXDaATzdbiA0RRvpRT_L5tt_qxG",
+  "crv":"P-384",
+  "d":"yDnv6FhAi5PXE2IRBh6UunGGkFTkJvbOJCXBh9A5rHon8VthWxh7QLEw9n7Wq539"
+}

lib/config/decrypt.spec.ts

@@ -1,11 +1,19 @@
+import crypto from 'node:crypto';
 import { Fixtures } from '../../test/fixtures';
 import { CONFIG_VALIDATION } from '../constants/error-messages';
-import { decryptConfig } from './decrypt';
+import { Json } from '../util/schema-utils';
+import { toBase64 } from '../util/string';
+import { decryptConfig, tryDecryptEcdhAesGcm } from './decrypt';
 import { GlobalConfig } from './global';
+import { EcJwkPriv } from './schema';
 import type { RenovateConfig } from './types';
 
 const privateKey = Fixtures.get('private.pem');
 const privateKeyPgp = Fixtures.get('private-pgp.pem');
+// renovate private key
+const privateEc = Fixtures.get('private-ec.json');
+const renovatePrivKey = Json.pipe(EcJwkPriv).parse(privateEc);
+
 const repository = 'abc/def';
 
 describe('config/decrypt', () => {
@@ -208,5 +216,90 @@ describe('config/decrypt', () => {
         CONFIG_VALIDATION,
       );
     });
+
+    it('handles EC/AES-GCM encryption', async () => {
+      GlobalConfig.set({ privateKey: toBase64(privateEc) });
+      config.encrypted = {
+        token:
+          'eyJrIjp7Imt0eSI6IkVDIiwieCI6IlM0TFhnVUJHMUNlSXVUU1ZiZEg3MHZpSjV6dUxaRFNydFJ2ZUhVTHBBYnBMTXAwQ0tyeVozWm5RN1lKQjh3N2MiLCJ5IjoiZVpQNFZzT1hXZGxRYkNWYWxSakVWNEFzTFBxYmpKdW1mR1dfTzlZbG9HM2dqbzd5enJfUXQtbXl2SG5LdkZheiIsImNydiI6IlAtMzg0In0sImkiOiJNRDVMb2hUMmh2VS9SYXA3IiwibSI6IkptMERpUmNtbEFEU2JjeVdnWmJlUXl4QkdUbU55aVlkV2NDa0tyVnhQZStTdEdMMlBwWT0ifQ==',
+      };
+
+      const res = await decryptConfig(config, 'some/def');
+      expect(res.encrypted).toBeUndefined();
+      expect(res.token).toBe('123');
+      await expect(decryptConfig(config, 'abc/defg')).rejects.toThrow(
+        CONFIG_VALIDATION,
+      );
+    });
+  });
+
+  describe('tryDecryptEc', () => {
+    it('decrypts', async () => {
+      // generate a new key pair in browser for each encryption
+      // private key will be thrown away after encryption,
+      // so only renovate can decrypt with private key
+      const browserKeyPair = await crypto.subtle.generateKey(
+        { name: 'ECDH', namedCurve: 'P-384' },
+        false,
+        ['deriveKey'],
+      );
+
+      // `d` is the private key, `x` and `y` are the public key
+      const { d, ...renovatrePublicKey } = { ...renovatePrivKey };
+
+      // import renovate public key
+      const svrPubKey = await crypto.subtle.importKey(
+        'jwk',
+        renovatrePublicKey,
+        { name: 'ECDH', namedCurve: 'P-384' },
+        false,
+        [],
+      );
+
+      // derive shared secret from our private key and renovate public key
+      const pw = await crypto.subtle.deriveKey(
+        { name: 'ECDH', public: svrPubKey },
+        browserKeyPair.privateKey,
+        { name: 'AES-GCM', length: 256 },
+        false,
+        ['encrypt'],
+      );
+
+      // always use a new IV, should always be 12 bytes
+      const iv = crypto.getRandomValues(new Uint8Array(12));
+
+      // encrypt the message
+      const message = await crypto.subtle.encrypt(
+        { name: 'AES-GCM', iv },
+        pw,
+        new TextEncoder().encode('{"o":"some","v":"123"}'), // Use TextEncoder for utf-8 support
+      );
+
+      // prepare the encrypted object
+      const encrypted = {
+        // send our public key
+        k: await crypto.subtle.exportKey('jwk', browserKeyPair.publicKey),
+        // send the IV
+        i: Buffer.from(iv).toString('base64'),
+        // send the encrypted message
+        m: Buffer.from(message).toString('base64'),
+      };
+
+      // encode the encrypted object for easier transport
+      const encCfg = toBase64(JSON.stringify(encrypted));
+
+      // print to update test case above
+      // console.error('encCfg', encCfg);
+
+      // decrypt the message with renovate private key
+      const res = await tryDecryptEcdhAesGcm(renovatePrivKey, encCfg);
+      expect(res).toBe('{"o":"some","v":"123"}');
+    });
+
+    it('throws for invalid config', async () => {
+      await expect(
+        tryDecryptEcdhAesGcm(renovatePrivKey, ''),
+      ).resolves.toBeNull();
+    });
   });
 });

lib/config/decrypt.ts

@@ -7,9 +7,65 @@ import { regEx } from '../util/regex';
 import { addSecretForSanitizing } from '../util/sanitize';
 import { ensureTrailingSlash } from '../util/url';
 import { GlobalConfig } from './global';
-import { DecryptedObject } from './schema';
+import {
+  DecryptedObject,
+  type EcJwkPriv,
+  EncodedEcJwkPriv,
+  EncryptedConfigString,
+} from './schema';
 import type { RenovateConfig } from './types';
 
+const dec = new TextDecoder();
+
+export async function tryDecryptEcdhAesGcm(
+  privateKey: EcJwkPriv,
+  encryptedStr: string,
+): Promise<string | null> {
+  try {
+    const privKey = await crypto.subtle.importKey(
+      'jwk',
+      privateKey,
+      { name: 'ECDH', namedCurve: privateKey.crv },
+      false,
+      ['deriveKey'],
+    );
+
+    const parsed = await EncryptedConfigString.safeParseAsync(encryptedStr);
+
+    if (!parsed.success) {
+      const error = new Error('config-validation');
+      error.validationError = `Could not parse encrypted config.`;
+      throw error;
+    }
+
+    const pubKey = await crypto.subtle.importKey(
+      'jwk',
+      parsed.data.k,
+      { name: 'ECDH', namedCurve: parsed.data.k.crv },
+      false,
+      [],
+    );
+
+    const pw = await crypto.subtle.deriveKey(
+      { name: 'ECDH', public: pubKey },
+      privKey,
+      { name: 'AES-GCM', length: 256 },
+      false,
+      ['decrypt'],
+    );
+    const buff = await crypto.subtle.decrypt(
+      { name: 'AES-GCM', iv: parsed.data.i },
+      pw,
+      parsed.data.m,
+    );
+    return dec.decode(buff);
+  } catch (err) {
+    logger.debug({ err }, 'Could not decrypt using openpgp');
+  }
+
+  return null;
+}
+
 export async function tryDecryptPgp(
   privateKey: string,
   encryptedStr: string,
@@ -90,7 +146,13 @@ export async function tryDecrypt(
   repository: string,
 ): Promise<string | null> {
   let decryptedStr: string | null = null;
-  if (privateKey?.startsWith('-----BEGIN PGP PRIVATE KEY BLOCK-----')) {
+  const pk = await EncodedEcJwkPriv.safeParseAsync(privateKey);
+  if (pk.success) {
+    const decryptedObjStr = await tryDecryptEcdhAesGcm(pk.data, encryptedStr);
+    if (decryptedObjStr) {
+      decryptedStr = validateDecryptedValue(decryptedObjStr, repository);
+    }
+  } else if (privateKey?.startsWith('-----BEGIN PGP PRIVATE KEY BLOCK-----')) {
     const decryptedObjStr = await tryDecryptPgp(privateKey, encryptedStr);
     if (decryptedObjStr) {
       decryptedStr = validateDecryptedValue(decryptedObjStr, repository);

lib/config/schema.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { Json } from '../util/schema-utils';
+import { Base64, Json } from '../util/schema-utils';
 
 export const DecryptedObject = Json.pipe(
   z.object({
@@ -8,3 +8,35 @@ export const DecryptedObject = Json.pipe(
     v: z.string().optional(),
   }),
 );
+
+/**
+ * EC JSON Web Key (public key)
+ * https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#json_web_key
+ */
+export const EcJwkPub = z.object({
+  kty: z.literal('EC'),
+  crv: z.enum(['P-256', 'P-384', 'P-521']),
+  x: z.string(),
+  y: z.string(),
+});
+
+/**
+ * EC JSON Web Key (private key)
+ * https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#json_web_key
+ */
+export const EcJwkPriv = EcJwkPub.extend({
+  d: z.string(),
+});
+
+export type EcJwkPriv = z.infer<typeof EcJwkPriv>;
+
+export const EncodedEcJwkPriv = Base64.pipe(Json.pipe(EcJwkPriv));
+
+export const EncryptedConfig = z.object({
+  k: EcJwkPub,
+  i: z.string().transform((v) => new Uint8Array(Buffer.from(v, 'base64'))),
+  m: z.string().transform((v) => new Uint8Array(Buffer.from(v, 'base64'))),
+});
+export type EncryptedConfig = z.infer<typeof EncryptedConfig>;
+
+export const EncryptedConfigString = Base64.pipe(Json.pipe(EncryptedConfig));

lib/util/schema-utils.ts

@@ -2,6 +2,7 @@ import JSON5 from 'json5';
 import { DateTime } from 'luxon';
 import type { JsonArray, JsonValue } from 'type-fest';
 import { z } from 'zod';
+import { fromBase64 } from './string';
 import { parse as parseToml } from './toml';
 import { parseSingleYaml, parseYaml } from './yaml';
 
@@ -252,3 +253,16 @@ export const Toml = z.string().transform((str, ctx) => {
     return z.NEVER;
   }
 });
+
+/**
+ * decode a base64 string
+ */
+export const Base64 = z.string().transform((str, ctx): string => {
+  try {
+    return fromBase64(str);
+  } catch (e) {
+    ctx.addIssue({ code: 'custom', message: 'Invalid Base64' });
+    return z.NEVER;
+  }
+});
+type Base64 = z.infer<typeof Base64>;