Merge pull request #2742 from akshita31/validate_integrity

Validate integrity of the downloaded packages using the downloaded zip checksum

Author: akshita31

package-lock.json

@@ -81,6 +81,7 @@
     "request-light": "0.2.4",
     "rxjs": "5.5.6",
     "semver": "*",
+    "stream": "0.0.2",
     "strip-bom": "3.0.0",
     "tmp": "0.0.33",
     "vscode-debugprotocol": "1.6.1",
@@ -172,7 +173,8 @@
         "x86_64"
       ],
       "installTestPath": "./.omnisharp/1.32.8/OmniSharp.exe",
-      "platformId": "win-x64"
+      "platformId": "win-x64",
+      "integrity": "74accabc25766f02c4cb0f8ea49abb447428ed86fc103fd549a5b778a39de82c"
     },
     {
       "id": "OmniSharp",

package.json

@@ -42,6 +42,7 @@ import { AbsolutePathPackage } from './packageManager/AbsolutePathPackage';
 import { downloadAndInstallPackages } from './packageManager/downloadAndInstallPackages';
 import IInstallDependencies from './packageManager/IInstallDependencies';
 import { installRuntimeDependencies } from './InstallRuntimeDependencies';
+import { isValidDownload } from './packageManager/isValidDownload';
 
 export async function activate(context: vscode.ExtensionContext): Promise<CSharpExtensionExports> {
 
@@ -119,7 +120,7 @@ export async function activate(context: vscode.ExtensionContext): Promise<CSharp
     eventStream.subscribe(telemetryObserver.post);
 
     let networkSettingsProvider = vscodeNetworkSettingsProvider(vscode);
-    let installDependencies: IInstallDependencies = (dependencies: AbsolutePathPackage[]) => downloadAndInstallPackages(dependencies, networkSettingsProvider, eventStream);
+    let installDependencies: IInstallDependencies = (dependencies: AbsolutePathPackage[]) => downloadAndInstallPackages(dependencies, networkSettingsProvider, eventStream, isValidDownload);
     let runtimeDependenciesExist = await ensureRuntimeDependencies(extension, eventStream, platformInfo, installDependencies);
 
     // activate language services

src/main.ts

@@ -4,12 +4,13 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { BaseChannelObserver } from "./BaseChannelObserver";
-import { BaseEvent, InstallationFailure, DebuggerNotInstalledFailure, DebuggerPrerequisiteFailure, ProjectJsonDeprecatedWarning, PackageInstallStart } from "../omnisharp/loggingEvents";
+import { BaseEvent, InstallationFailure, DebuggerNotInstalledFailure, DebuggerPrerequisiteFailure, ProjectJsonDeprecatedWarning, PackageInstallStart, IntegrityCheckFailure } from "../omnisharp/loggingEvents";
 
 export class CsharpChannelObserver extends BaseChannelObserver {
     public post = (event: BaseEvent) => {
         switch (event.constructor.name) {
             case PackageInstallStart.name:
+            case IntegrityCheckFailure.name:
                 this.showChannel(true);
                 break;
             case InstallationFailure.name:

src/observers/CsharpChannelObserver.ts

@@ -58,6 +58,32 @@ export class CsharpLoggerObserver extends BaseLoggerObserver {
             case Event.LatestBuildDownloadStart.name:
                 this.logger.appendLine("Getting latest OmniSharp version information");
                 break;
+            case Event.IntegrityCheckFailure.name:
+                this.handleIntegrityCheckFailure(<Event.IntegrityCheckFailure>event);
+                break;
+            case Event.DownloadValidation.name:
+                this.handleDownloadValidation(<Event.DownloadValidation>event);
+                break;
+            case Event.IntegrityCheckSuccess.name:
+                this.handleIntegrityCheckSuccess(<Event.IntegrityCheckSuccess>event);
+                break;
+        }
+    }
+
+    private handleDownloadValidation(event: Event.DownloadValidation) {
+        this.logger.appendLine("Validating download...");
+    }
+
+    private handleIntegrityCheckSuccess(event: Event.IntegrityCheckSuccess) {
+        this.logger.appendLine("Integrity Check succeeded.");
+    }
+
+    private handleIntegrityCheckFailure(event: Event.IntegrityCheckFailure) {
+        if (event.retry) {
+            this.logger.appendLine(`Package ${event.packageDescription} failed integrity check. Retrying..`);
+        }
+        else {
+            this.logger.appendLine(`Package ${event.packageDescription} download from ${event.url} failed integrity check. Some features may not work as expected. Please restart Visual Studio Code to retrigger the download.`); 
         }
     }
 

src/observers/CsharpLoggerObserver.ts

@@ -3,12 +3,11 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { BaseEvent, ZipError, DotNetTestRunFailure, DotNetTestDebugStartFailure } from "../omnisharp/loggingEvents";
+import { BaseEvent, ZipError, DotNetTestRunFailure, DotNetTestDebugStartFailure, IntegrityCheckFailure } from "../omnisharp/loggingEvents";
 import { vscode } from "../vscodeAdapter";
 import showErrorMessage from "./utils/ShowErrorMessage";
 
 export class ErrorMessageObserver {
-
     constructor(private vscode: vscode) {
     }
 
@@ -23,6 +22,14 @@ export class ErrorMessageObserver {
             case DotNetTestDebugStartFailure.name:
                 this.handleDotNetTestDebugStartFailure(<DotNetTestDebugStartFailure>event);
                 break;
+            case IntegrityCheckFailure.name:
+                this.handleIntegrityCheckFailure(<IntegrityCheckFailure> event);
+        }
+    }
+
+    handleIntegrityCheckFailure(event: IntegrityCheckFailure) {
+        if (!event.retry) {
+            showErrorMessage(this.vscode, `Package ${event.packageDescription} download from ${event.url} failed integrity check. Some features may not work as expected. Please restart Visual Studio Code to retrigger the download`);
         }
     }
 

src/observers/ErrorMessageObserver.ts

@@ -12,6 +12,7 @@ import { downloadAndInstallPackages } from '../packageManager/downloadAndInstall
 import { DownloadFile } from '../packageManager/FileDownloader';
 import { getRuntimeDependenciesPackages } from '../tools/RuntimeDependencyPackageUtils';
 import { getAbsolutePathPackagesToInstall } from '../packageManager/getAbsolutePathPackagesToInstall';
+import { isValidDownload } from '../packageManager/isValidDownload';
 
 export class OmnisharpDownloader {
 
@@ -30,7 +31,7 @@ export class OmnisharpDownloader {
         if (packagesToInstall && packagesToInstall.length > 0) {
             this.eventStream.post(new PackageInstallation(`OmniSharp Version = ${version}`));
             this.eventStream.post(new LogPlatformInfo(this.platformInfo));
-            await downloadAndInstallPackages(packagesToInstall, this.networkSettingsProvider, this.eventStream);
+            await downloadAndInstallPackages(packagesToInstall, this.networkSettingsProvider, this.eventStream, isValidDownload);
             this.eventStream.post(new InstallationSuccess());
         }
     }

src/omnisharp/OmnisharpDownloader.ts

@@ -37,12 +37,16 @@ function GetPackage(inputPackage: Package, serverUrl: string, version: string, i
         throw new Error('Invalid version');
     }
 
-    let versionPackage = {...inputPackage,
-        "description": `${inputPackage.description}, Version = ${version}`,
-        "url": `${serverUrl}/releases/${version}/omnisharp-${inputPackage.platformId}.zip`,
-        "installPath": `${installPath}/${version}`,
-        "installTestPath": `./${installPath}/${version}/${installBinary}`,
-        "fallbackUrl": "" //setting to empty so that we dont use the fallback url of the default packages
+    let versionPackage: Package = {
+        id: inputPackage.id,
+        description: `${inputPackage.description}, Version = ${version}`,
+        url: `${serverUrl}/releases/${version}/omnisharp-${inputPackage.platformId}.zip`,
+        installPath: `${installPath}/${version}`,
+        installTestPath: `./${installPath}/${version}/${installBinary}`,
+        platforms: inputPackage.platforms,
+        architectures: inputPackage.architectures,
+        binaries: inputPackage.binaries,
+        platformId: inputPackage.platformId
     };
 
     return versionPackage;

src/omnisharp/OmnisharpPackageCreator.ts

@@ -162,6 +162,14 @@ export class OpenURL {
     constructor(public url: string) { }
 }
 
+export class IntegrityCheckFailure {
+    constructor(public packageDescription: string, public url: string, public retry: boolean){ }
+}
+
+export class IntegrityCheckSuccess {
+    constructor() { }
+}
+
 export class RazorPluginPathSpecified implements BaseEvent {
     constructor(public path: string) {}
 }
@@ -201,4 +209,5 @@ export class OmnisharpServerOnStop implements BaseEvent { }
 export class OmnisharpServerOnStart implements BaseEvent { }
 export class LatestBuildDownloadStart implements BaseEvent { }
 export class OmnisharpRestart implements BaseEvent { }
-export class DotNetTestDebugComplete implements BaseEvent { }
+export class DotNetTestDebugComplete implements BaseEvent { }
+export class DownloadValidation implements BaseEvent { }

src/omnisharp/loggingEvents.ts

@@ -17,7 +17,8 @@ export class AbsolutePathPackage implements IPackage{
         public installPath?: AbsolutePath,
         public installTestPath?: AbsolutePath, 
         public fallbackUrl?: string,
-        public platformId?: string) {
+        public platformId?: string,
+        public integrity?: string) {
     }
 
     public static getAbsolutePathPackage(pkg: Package, extensionPath: string) {
@@ -31,7 +32,8 @@ export class AbsolutePathPackage implements IPackage{
             getAbsoluteInstallPath(pkg, extensionPath),
             getAbsoluteInstallTestPath(pkg, extensionPath),
             pkg.fallbackUrl,
-            pkg.platformId
+            pkg.platformId,
+            pkg.integrity
         );
     }
 }