fix(git): keep trailing newline in private SSH key (#31005)

renovatebot · Aug 25, 2024 · 0cfb182 · 0cfb182
1 parent 4ec7eae
commit 0cfb182
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/lib/util/git/private-key.spec.ts b/lib/util/git/private-key.spec.ts
@@ -89,7 +89,8 @@ describe('util/git/private-key', () => {
 -----BEGIN OPENSSH PRIVATE KEY-----
 some-private-key with-passphrase
 some-private-key with-passphrase
------END OPENSSH PRIVATE KEY-----`);
+-----END OPENSSH PRIVATE KEY-----
+`);
       await expect(writePrivateKey()).rejects.toThrow();
     });
 
@@ -98,7 +99,8 @@ some-private-key with-passphrase
 -----BEGIN OPENSSH PRIVATE KEY-----
 some-private-key
 some-private-key
------END OPENSSH PRIVATE KEY-----`;
+-----END OPENSSH PRIVATE KEY-----
+`;
       const privateKeyFile = upath.join(os.tmpdir() + '/git-private-ssh.key');
       const publicKeyFile = `${privateKeyFile}.pub`;
       const publicKey = 'some-public-key';

diff --git a/lib/util/git/private-key.ts b/lib/util/git/private-key.ts
@@ -24,7 +24,7 @@ abstract class PrivateKey {
   protected abstract readonly gpgFormat: string;
 
   constructor(key: string) {
-    this.key = key.trim();
+    this.key = key;
     addSecretForSanitizing(this.key, 'global');
     logger.debug(
       'gitPrivateKey: successfully set (but not yet written/configured)',
@@ -57,6 +57,10 @@ abstract class PrivateKey {
 class GPGKey extends PrivateKey {
   protected readonly gpgFormat = 'openpgp';
 
+  constructor(key: string) {
+    super(key.trim());
+  }
+
   protected async importKey(): Promise<string | undefined> {
     const keyFileName = upath.join(os.tmpdir() + '/git-private-gpg.key');
     await fs.outputFile(keyFileName, this.key);