/// <summary> /// Tries to get information about the project policy. /// </summary> /// <param name="policy">Object that represents a project policy.</param> /// <returns></returns> private static bool TryGetPolicy(out ProjectPolicy policy) { string[] osdaFiles = Directory.GetFiles(projectPath, ".osda"); if (osdaFiles.Length == 0) { CommandLineUtils.PrintErrorMessage("This project does not contain a policy file (.osda)."); policy = null; return(false); } policy = JsonConvert.DeserializeObject <ProjectPolicy>(File.ReadAllText(osdaFiles[0])); if (policy.Id == "") { CommandLineUtils.PrintErrorMessage("Project id not specified in policy."); return(false); } if (policy.Name == "") { CommandLineUtils.PrintErrorMessage("Project name not specified in policy."); return(false); } if (policy.Admin == "") { CommandLineUtils.PrintErrorMessage("Project administrator name not specified in policy."); return(false); } return(true); }
/// <summary> /// Creates a report and stores it locally. /// </summary> /// <param name="dependenciesEvaluated">List of dependencies with its evaluation.</param> /// <param name="policy">Project policy.</param> /// <returns></returns> private static string GenerateReport(List <Dependency> dependenciesEvaluated, ProjectPolicy policy) { string dateTime = string.Concat(DateTime.UtcNow.ToString("s"), "Z"); string errorInfo = GetErrorInfo(); Report report = new Report(policy.Id, policy.Version, policy.Name, policy.Description, dateTime, policy.Organization, policy.Repo, policy.RepoOwner, policy.Admin, errorInfo) { Dependencies = dependenciesEvaluated }; string jsonReport = JsonConvert.SerializeObject(report); File.WriteAllText(Path.Combine(projectPath, "report.json"), jsonReport); return(jsonReport); }
/// <summary> /// Validates project dependencies according to their vulnerabilities and licenses. /// </summary> /// <param name="packages">List of packages of the project.</param> /// <param name="policy">Project policy.</param> /// <returns></returns> private static async Task <List <Dependency> > ValidateProjectDependencies(List <NuGetPackage> packages, ProjectPolicy policy) { List <Dependency> dependencies = new List <Dependency>(); VulnerabilityEvaluationResult[] vulnerabilityEvaluationResult = null; try { vulnerabilityEvaluationResult = await VulnerabilityEvaluation.EvaluatePackage(packages, policy.ApiCacheTime); } catch (Exception e) { CommandLineUtils.PrintWarningMessage($"An error occurred while trying to fetch dependencies vulnerabilities: {e.Message}"); vulnerabilitiesFetchError = true; } List <License>[] dependenciesLicenses = new List <License> [packages.Count]; int i = 0; foreach (NuGetPackage package in packages) { PackageInfo packageInfo = PackageManager.GetPackageInfo(packagesRootPath, package.Id, package.Version); string packageDescription = (packageInfo == null) ? "" : packageInfo.Description; dependencies.Add(new Dependency(package.Id, package.Version, packageDescription, package.Direct, package.Children)); dependenciesLicenses[i] = new List <License>(); // It is not necessary to analyze System libraries license, only vulnerabilities if (packageInfo != null && (packageInfo.ProjectUrl != "https://dot.net/" || !package.Id.StartsWith("System."))) { try { dependenciesLicenses[i] = await LicenseManager.TryGetLicenseName(packageInfo, policy.ApiCacheTime); } catch (Exception e) { CommandLineUtils.PrintWarningMessage($"An error occurred while trying to fetch {package.Id}.{package.Version} license: {e.Message}"); dependenciesLicenses[i] = new List <License>(); licensesFetchErrors.Add($"{package.Id}.{package.Version}"); } } ++i; } i = 0; foreach (List <License> licenses in dependenciesLicenses) { dependencies[i].Licenses = licenses.Select(license => { license.Valid = !policy.InvalidLicenses.Contains(license.Title); return(license); }) .ToList(); if (!vulnerabilitiesFetchError) { dependencies[i].VulnerabilitiesCount = vulnerabilityEvaluationResult[i].VulnerabilitiesNumber; dependencies[i].Vulnerabilities = vulnerabilityEvaluationResult[i].VulnerabilitiesFound; } ++i; } return(dependencies); }