@theia/remote 1.52.0 → 1.53.0-next.55

package/src/electron-node/ssh/ssh-identity-file-collector.ts

@@ -1,137 +1,137 @@
-// *****************************************************************************
-// Copyright (C) 2023 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import * as fs from '@theia/core/shared/fs-extra';
-import * as os from 'os';
-import * as path from 'path';
-import * as crypto from 'crypto';
-import { ParsedKey } from 'ssh2';
-import * as ssh2 from 'ssh2';
-import { injectable } from '@theia/core/shared/inversify';
-
-export interface SSHKey {
-    filename: string;
-    parsedKey: ParsedKey;
-    fingerprint: string;
-    agentSupport?: boolean;
-    isPrivate?: boolean;
-}
-
-@injectable()
-export class SSHIdentityFileCollector {
-
-    protected getDefaultIdentityFiles(): string[] {
-        const homeDir = os.homedir();
-        const PATH_SSH_CLIENT_ID_DSA = path.join(homeDir, '.ssh', '/id_dsa');
-        const PATH_SSH_CLIENT_ID_ECDSA = path.join(homeDir, '.ssh', '/id_ecdsa');
-        const PATH_SSH_CLIENT_ID_RSA = path.join(homeDir, '.ssh', '/id_rsa');
-        const PATH_SSH_CLIENT_ID_ED25519 = path.join(homeDir, '.ssh', '/id_ed25519');
-        const PATH_SSH_CLIENT_ID_XMSS = path.join(homeDir, '.ssh', '/id_xmss');
-        const PATH_SSH_CLIENT_ID_ECDSA_SK = path.join(homeDir, '.ssh', '/id_ecdsa_sk');
-        const PATH_SSH_CLIENT_ID_ED25519_SK = path.join(homeDir, '.ssh', '/id_ed25519_sk');
-
-        return [
-            PATH_SSH_CLIENT_ID_DSA,
-            PATH_SSH_CLIENT_ID_ECDSA,
-            PATH_SSH_CLIENT_ID_ECDSA_SK,
-            PATH_SSH_CLIENT_ID_ED25519,
-            PATH_SSH_CLIENT_ID_ED25519_SK,
-            PATH_SSH_CLIENT_ID_RSA,
-            PATH_SSH_CLIENT_ID_XMSS
-        ];
-    }
-
-    async gatherIdentityFiles(sshAgentSock?: string): Promise<SSHKey[]> {
-        const identityFiles = this.getDefaultIdentityFiles();
-
-        const identityFileContentsResult = await Promise.allSettled(identityFiles.map(async keyPath => {
-            keyPath = await fs.pathExists(keyPath + '.pub') ? keyPath + '.pub' : keyPath;
-            return fs.promises.readFile(keyPath);
-        }));
-        const fileKeys: SSHKey[] = identityFileContentsResult.map((result, i) => {
-            if (result.status === 'rejected') {
-                return undefined;
-            }
-
-            const parsedResult = ssh2.utils.parseKey(result.value);
-            if (parsedResult instanceof Error || !parsedResult) {
-                console.log(`Error while parsing SSH public key ${identityFiles[i]}:`, parsedResult);
-                return undefined;
-            }
-
-            const parsedKey = Array.isArray(parsedResult) ? parsedResult[0] : parsedResult;
-            const fingerprint = crypto.createHash('sha256').update(parsedKey.getPublicSSH()).digest('base64');
-
-            return {
-                filename: identityFiles[i],
-                parsedKey,
-                fingerprint
-            };
-        }).filter(<T>(v: T | undefined): v is T => !!v);
-
-        let sshAgentParsedKeys: ParsedKey[] = [];
-        if (sshAgentSock) {
-            sshAgentParsedKeys = await new Promise<ParsedKey[]>((resolve, reject) => {
-                const sshAgent = new ssh2.OpenSSHAgent(sshAgentSock);
-                sshAgent.getIdentities((err, publicKeys) => {
-                    if (err) {
-                        reject(err);
-                    } else if (publicKeys) {
-                        resolve(publicKeys.map(key => {
-                            if ('pubKey' in key) {
-                                const pubKey = key.pubKey;
-                                if ('pubKey' in pubKey) {
-                                    return pubKey.pubKey as ParsedKey;
-                                }
-                                return pubKey;
-                            } else {
-                                return key;
-                            }
-                        }));
-                    } else {
-                        resolve([]);
-                    }
-                });
-            });
-        }
-
-        const sshAgentKeys: SSHKey[] = sshAgentParsedKeys.map(parsedKey => {
-            const fingerprint = crypto.createHash('sha256').update(parsedKey.getPublicSSH()).digest('base64');
-            return {
-                filename: parsedKey.comment,
-                parsedKey,
-                fingerprint,
-                agentSupport: true
-            };
-        });
-
-        const agentKeys: SSHKey[] = [];
-        const preferredIdentityKeys: SSHKey[] = [];
-        for (const agentKey of sshAgentKeys) {
-            const foundIdx = fileKeys.findIndex(k => agentKey.parsedKey.type === k.parsedKey.type && agentKey.fingerprint === k.fingerprint);
-            if (foundIdx >= 0) {
-                preferredIdentityKeys.push({ ...fileKeys[foundIdx], agentSupport: true });
-                fileKeys.splice(foundIdx, 1);
-            } else {
-                agentKeys.push(agentKey);
-            }
-        }
-        preferredIdentityKeys.push(...agentKeys);
-        preferredIdentityKeys.push(...fileKeys);
-
-        return preferredIdentityKeys;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2023 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import * as fs from '@theia/core/shared/fs-extra';
+import * as os from 'os';
+import * as path from 'path';
+import * as crypto from 'crypto';
+import { ParsedKey } from 'ssh2';
+import * as ssh2 from 'ssh2';
+import { injectable } from '@theia/core/shared/inversify';
+
+export interface SSHKey {
+    filename: string;
+    parsedKey: ParsedKey;
+    fingerprint: string;
+    agentSupport?: boolean;
+    isPrivate?: boolean;
+}
+
+@injectable()
+export class SSHIdentityFileCollector {
+
+    protected getDefaultIdentityFiles(): string[] {
+        const homeDir = os.homedir();
+        const PATH_SSH_CLIENT_ID_DSA = path.join(homeDir, '.ssh', '/id_dsa');
+        const PATH_SSH_CLIENT_ID_ECDSA = path.join(homeDir, '.ssh', '/id_ecdsa');
+        const PATH_SSH_CLIENT_ID_RSA = path.join(homeDir, '.ssh', '/id_rsa');
+        const PATH_SSH_CLIENT_ID_ED25519 = path.join(homeDir, '.ssh', '/id_ed25519');
+        const PATH_SSH_CLIENT_ID_XMSS = path.join(homeDir, '.ssh', '/id_xmss');
+        const PATH_SSH_CLIENT_ID_ECDSA_SK = path.join(homeDir, '.ssh', '/id_ecdsa_sk');
+        const PATH_SSH_CLIENT_ID_ED25519_SK = path.join(homeDir, '.ssh', '/id_ed25519_sk');
+
+        return [
+            PATH_SSH_CLIENT_ID_DSA,
+            PATH_SSH_CLIENT_ID_ECDSA,
+            PATH_SSH_CLIENT_ID_ECDSA_SK,
+            PATH_SSH_CLIENT_ID_ED25519,
+            PATH_SSH_CLIENT_ID_ED25519_SK,
+            PATH_SSH_CLIENT_ID_RSA,
+            PATH_SSH_CLIENT_ID_XMSS
+        ];
+    }
+
+    async gatherIdentityFiles(sshAgentSock?: string): Promise<SSHKey[]> {
+        const identityFiles = this.getDefaultIdentityFiles();
+
+        const identityFileContentsResult = await Promise.allSettled(identityFiles.map(async keyPath => {
+            keyPath = await fs.pathExists(keyPath + '.pub') ? keyPath + '.pub' : keyPath;
+            return fs.promises.readFile(keyPath);
+        }));
+        const fileKeys: SSHKey[] = identityFileContentsResult.map((result, i) => {
+            if (result.status === 'rejected') {
+                return undefined;
+            }
+
+            const parsedResult = ssh2.utils.parseKey(result.value);
+            if (parsedResult instanceof Error || !parsedResult) {
+                console.log(`Error while parsing SSH public key ${identityFiles[i]}:`, parsedResult);
+                return undefined;
+            }
+
+            const parsedKey = Array.isArray(parsedResult) ? parsedResult[0] : parsedResult;
+            const fingerprint = crypto.createHash('sha256').update(parsedKey.getPublicSSH()).digest('base64');
+
+            return {
+                filename: identityFiles[i],
+                parsedKey,
+                fingerprint
+            };
+        }).filter(<T>(v: T | undefined): v is T => !!v);
+
+        let sshAgentParsedKeys: ParsedKey[] = [];
+        if (sshAgentSock) {
+            sshAgentParsedKeys = await new Promise<ParsedKey[]>((resolve, reject) => {
+                const sshAgent = new ssh2.OpenSSHAgent(sshAgentSock);
+                sshAgent.getIdentities((err, publicKeys) => {
+                    if (err) {
+                        reject(err);
+                    } else if (publicKeys) {
+                        resolve(publicKeys.map(key => {
+                            if ('pubKey' in key) {
+                                const pubKey = key.pubKey;
+                                if ('pubKey' in pubKey) {
+                                    return pubKey.pubKey as ParsedKey;
+                                }
+                                return pubKey;
+                            } else {
+                                return key;
+                            }
+                        }));
+                    } else {
+                        resolve([]);
+                    }
+                });
+            });
+        }
+
+        const sshAgentKeys: SSHKey[] = sshAgentParsedKeys.map(parsedKey => {
+            const fingerprint = crypto.createHash('sha256').update(parsedKey.getPublicSSH()).digest('base64');
+            return {
+                filename: parsedKey.comment,
+                parsedKey,
+                fingerprint,
+                agentSupport: true
+            };
+        });
+
+        const agentKeys: SSHKey[] = [];
+        const preferredIdentityKeys: SSHKey[] = [];
+        for (const agentKey of sshAgentKeys) {
+            const foundIdx = fileKeys.findIndex(k => agentKey.parsedKey.type === k.parsedKey.type && agentKey.fingerprint === k.fingerprint);
+            if (foundIdx >= 0) {
+                preferredIdentityKeys.push({ ...fileKeys[foundIdx], agentSupport: true });
+                fileKeys.splice(foundIdx, 1);
+            } else {
+                agentKeys.push(agentKey);
+            }
+        }
+        preferredIdentityKeys.push(...agentKeys);
+        preferredIdentityKeys.push(...fileKeys);
+
+        return preferredIdentityKeys;
+    }
+}

package/src/package.spec.ts

@@ -1,29 +1,29 @@
-// *****************************************************************************
-// Copyright (C) 2023 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-/* note: this bogus test file is required so that
-   we are able to run mocha unit tests on this
-   package, without having any actual unit tests in it.
-   This way a coverage report will be generated,
-   showing 0% coverage, instead of no report.
-   This file can be removed once we have real unit
-   tests in place. */
-
-describe('remote package', () => {
-
-    it('support code coverage statistics', () => true);
-
-});
+// *****************************************************************************
+// Copyright (C) 2023 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+/* note: this bogus test file is required so that
+   we are able to run mocha unit tests on this
+   package, without having any actual unit tests in it.
+   This way a coverage report will be generated,
+   showing 0% coverage, instead of no report.
+   This file can be removed once we have real unit
+   tests in place. */
+
+describe('remote package', () => {
+
+    it('support code coverage statistics', () => true);
+
+});