@theia/core 1.53.0-next.55 → 1.53.0-next.64

package/src/electron-node/token/electron-token-validator.ts

@@ -1,93 +1,93 @@
-// *****************************************************************************
-// Copyright (C) 2020 Ericsson 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 http from 'http';
-import * as cookie from 'cookie';
-import * as crypto from 'crypto';
-import { injectable, postConstruct } from 'inversify';
-import { isObject, isString, MaybePromise } from '../../common';
-import { ElectronSecurityToken } from '../../electron-common/electron-token';
-import { WsRequestValidatorContribution } from '../../node/ws-request-validators';
-
-/**
- * On Electron, we want to make sure that only Electron's browser-windows access the backend services.
- */
-@injectable()
-export class ElectronTokenValidator implements WsRequestValidatorContribution {
-
-    protected electronSecurityToken?: ElectronSecurityToken;
-
-    @postConstruct()
-    protected init(): void {
-        this.electronSecurityToken = this.getToken();
-    }
-
-    allowWsUpgrade(request: http.IncomingMessage): MaybePromise<boolean> {
-        return this.allowRequest(request);
-    }
-
-    /**
-     * Expects the token to be passed via cookies by default.
-     */
-    allowRequest(request: http.IncomingMessage): boolean {
-        if (!this.electronSecurityToken) {
-            return true;
-        }
-        const cookieHeader = request.headers.cookie;
-        if (isString(cookieHeader)) {
-            const token = cookie.parse(cookieHeader)[ElectronSecurityToken];
-            if (isString(token)) {
-                return this.isTokenValid(JSON.parse(token));
-            }
-        }
-        return false;
-    }
-
-    /**
-     * Validates a token.
-     *
-     * This method both checks the shape of the parsed token data and its actual value.
-     *
-     * @param token Parsed object sent by the client as the token.
-     */
-    isTokenValid(token: unknown): boolean {
-        if (isObject(token) && isString(token.value)) {
-            try {
-                const received = Buffer.from(token.value, 'utf8');
-                const expected = Buffer.from(this.electronSecurityToken!.value, 'utf8');
-                return received.byteLength === expected.byteLength && crypto.timingSafeEqual(received, expected);
-            } catch (error) {
-                console.error(error);
-            }
-        }
-        return false;
-    }
-
-    /**
-     * Returns the token to compare to when authorizing requests.
-     */
-    protected getToken(): ElectronSecurityToken | undefined {
-        const token = process.env[ElectronSecurityToken];
-        if (token) {
-            return JSON.parse(token);
-        } else {
-            // No token has been passed to the backend server
-            // That indicates we're running without a local frontend
-            return undefined;
-        }
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2020 Ericsson 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 http from 'http';
+import * as cookie from 'cookie';
+import * as crypto from 'crypto';
+import { injectable, postConstruct } from 'inversify';
+import { isObject, isString, MaybePromise } from '../../common';
+import { ElectronSecurityToken } from '../../electron-common/electron-token';
+import { WsRequestValidatorContribution } from '../../node/ws-request-validators';
+
+/**
+ * On Electron, we want to make sure that only Electron's browser-windows access the backend services.
+ */
+@injectable()
+export class ElectronTokenValidator implements WsRequestValidatorContribution {
+
+    protected electronSecurityToken?: ElectronSecurityToken;
+
+    @postConstruct()
+    protected init(): void {
+        this.electronSecurityToken = this.getToken();
+    }
+
+    allowWsUpgrade(request: http.IncomingMessage): MaybePromise<boolean> {
+        return this.allowRequest(request);
+    }
+
+    /**
+     * Expects the token to be passed via cookies by default.
+     */
+    allowRequest(request: http.IncomingMessage): boolean {
+        if (!this.electronSecurityToken) {
+            return true;
+        }
+        const cookieHeader = request.headers.cookie;
+        if (isString(cookieHeader)) {
+            const token = cookie.parse(cookieHeader)[ElectronSecurityToken];
+            if (isString(token)) {
+                return this.isTokenValid(JSON.parse(token));
+            }
+        }
+        return false;
+    }
+
+    /**
+     * Validates a token.
+     *
+     * This method both checks the shape of the parsed token data and its actual value.
+     *
+     * @param token Parsed object sent by the client as the token.
+     */
+    isTokenValid(token: unknown): boolean {
+        if (isObject(token) && isString(token.value)) {
+            try {
+                const received = Buffer.from(token.value, 'utf8');
+                const expected = Buffer.from(this.electronSecurityToken!.value, 'utf8');
+                return received.byteLength === expected.byteLength && crypto.timingSafeEqual(received, expected);
+            } catch (error) {
+                console.error(error);
+            }
+        }
+        return false;
+    }
+
+    /**
+     * Returns the token to compare to when authorizing requests.
+     */
+    protected getToken(): ElectronSecurityToken | undefined {
+        const token = process.env[ElectronSecurityToken];
+        if (token) {
+            return JSON.parse(token);
+        } else {
+            // No token has been passed to the backend server
+            // That indicates we're running without a local frontend
+            return undefined;
+        }
+    }
+
+}

package/src/node/application-server.ts

@@ -1,59 +1,59 @@
-// *****************************************************************************
-// Copyright (C) 2018 Ericsson 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 { injectable, inject } from 'inversify';
-import { ApplicationServer, ExtensionInfo, ApplicationInfo } from '../common/application-protocol';
-import { ApplicationPackage } from '@theia/application-package';
-import { OS } from '../common/os';
-
-@injectable()
-export class ApplicationServerImpl implements ApplicationServer {
-
-    @inject(ApplicationPackage)
-    protected readonly applicationPackage: ApplicationPackage;
-
-    getExtensionsInfos(): Promise<ExtensionInfo[]> {
-        // @ts-expect-error
-        const appInfo: ExtensionInfo[] = globalThis.extensionInfo;
-        return Promise.resolve(appInfo);
-    }
-
-    getApplicationInfo(): Promise<ApplicationInfo | undefined> {
-        const pck = this.applicationPackage.pck;
-        if (pck.name && pck.version) {
-            const name = pck.name;
-            const version = pck.version;
-
-            return Promise.resolve({
-                name,
-                version
-            });
-        }
-        return Promise.resolve(undefined);
-    }
-
-    getApplicationRoot(): Promise<string> {
-        return Promise.resolve(this.applicationPackage.projectPath);
-    }
-
-    getApplicationPlatform(): Promise<string> {
-        return Promise.resolve(`${process.platform}-${process.arch}`);
-    }
-
-    async getBackendOS(): Promise<OS.Type> {
-        return OS.type();
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2018 Ericsson 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 { injectable, inject } from 'inversify';
+import { ApplicationServer, ExtensionInfo, ApplicationInfo } from '../common/application-protocol';
+import { ApplicationPackage } from '@theia/application-package';
+import { OS } from '../common/os';
+
+@injectable()
+export class ApplicationServerImpl implements ApplicationServer {
+
+    @inject(ApplicationPackage)
+    protected readonly applicationPackage: ApplicationPackage;
+
+    getExtensionsInfos(): Promise<ExtensionInfo[]> {
+        // @ts-expect-error
+        const appInfo: ExtensionInfo[] = globalThis.extensionInfo;
+        return Promise.resolve(appInfo);
+    }
+
+    getApplicationInfo(): Promise<ApplicationInfo | undefined> {
+        const pck = this.applicationPackage.pck;
+        if (pck.name && pck.version) {
+            const name = pck.name;
+            const version = pck.version;
+
+            return Promise.resolve({
+                name,
+                version
+            });
+        }
+        return Promise.resolve(undefined);
+    }
+
+    getApplicationRoot(): Promise<string> {
+        return Promise.resolve(this.applicationPackage.projectPath);
+    }
+
+    getApplicationPlatform(): Promise<string> {
+        return Promise.resolve(`${process.platform}-${process.arch}`);
+    }
+
+    async getBackendOS(): Promise<OS.Type> {
+        return OS.type();
+    }
+}

package/src/node/backend-application-config-provider.spec.ts

@@ -1,29 +1,29 @@
-// *****************************************************************************
-// Copyright (C) 2021 Ericsson 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 { BackendApplicationConfig } from '@theia/application-package/lib/';
-import { expect } from 'chai';
-import { BackendApplicationConfigProvider } from './backend-application-config-provider';
-
-const { DEFAULT } = BackendApplicationConfig;
-
-describe('BackendApplicationConfigProvider', function (): void {
-    it('should use defaults when calling `set`', function (): void {
-        BackendApplicationConfigProvider.set({});
-        const config = BackendApplicationConfigProvider.get();
-        expect(config.singleInstance).equal(DEFAULT.singleInstance);
-    });
-});
+// *****************************************************************************
+// Copyright (C) 2021 Ericsson 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 { BackendApplicationConfig } from '@theia/application-package/lib/';
+import { expect } from 'chai';
+import { BackendApplicationConfigProvider } from './backend-application-config-provider';
+
+const { DEFAULT } = BackendApplicationConfig;
+
+describe('BackendApplicationConfigProvider', function (): void {
+    it('should use defaults when calling `set`', function (): void {
+        BackendApplicationConfigProvider.set({});
+        const config = BackendApplicationConfigProvider.get();
+        expect(config.singleInstance).equal(DEFAULT.singleInstance);
+    });
+});

package/src/node/backend-application-config-provider.ts

@@ -1,48 +1,48 @@
-// *****************************************************************************
-// Copyright (C) 2018 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 { BackendApplicationConfig, deepmerge } from '@theia/application-package/lib/application-props';
-
-export class BackendApplicationConfigProvider {
-
-    private static KEY = Symbol('BackendApplicationConfigProvider');
-
-    static get(): BackendApplicationConfig {
-        const config = BackendApplicationConfigProvider.doGet();
-        if (config === undefined) {
-            throw new Error('The configuration is not set. Did you call BackendApplicationConfigProvider#set?');
-        }
-        return config;
-    }
-
-    static set(config: BackendApplicationConfig.Partial): void {
-        if (BackendApplicationConfigProvider.doGet() !== undefined) {
-            throw new Error('The configuration is already set.');
-        }
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const globalObject = global as any;
-        const key = BackendApplicationConfigProvider.KEY;
-        globalObject[key] = deepmerge(BackendApplicationConfig.DEFAULT, config);
-    }
-
-    private static doGet(): BackendApplicationConfig | undefined {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const globalObject = global as any;
-        const key = BackendApplicationConfigProvider.KEY;
-        return globalObject[key];
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2018 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 { BackendApplicationConfig, deepmerge } from '@theia/application-package/lib/application-props';
+
+export class BackendApplicationConfigProvider {
+
+    private static KEY = Symbol('BackendApplicationConfigProvider');
+
+    static get(): BackendApplicationConfig {
+        const config = BackendApplicationConfigProvider.doGet();
+        if (config === undefined) {
+            throw new Error('The configuration is not set. Did you call BackendApplicationConfigProvider#set?');
+        }
+        return config;
+    }
+
+    static set(config: BackendApplicationConfig.Partial): void {
+        if (BackendApplicationConfigProvider.doGet() !== undefined) {
+            throw new Error('The configuration is already set.');
+        }
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const globalObject = global as any;
+        const key = BackendApplicationConfigProvider.KEY;
+        globalObject[key] = deepmerge(BackendApplicationConfig.DEFAULT, config);
+    }
+
+    private static doGet(): BackendApplicationConfig | undefined {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const globalObject = global as any;
+        const key = BackendApplicationConfigProvider.KEY;
+        return globalObject[key];
+    }
+
+}