From 1eb121149e180d3bcea3eba5f88b08b9035e4307 Mon Sep 17 00:00:00 2001 From: Paul Dorsch <107068277+pauld-msft@users.noreply.github.com> Date: Wed, 4 Dec 2024 11:26:07 -0500 Subject: [PATCH] Revert "Revert "Update syft image and doc - use docker commands (#1307)" (#1318)" This reverts commit e7239ead6b07a726d382e5ea2df2d0f644858979. --- docs/update-syft.md | 39 ++- .../linux/Contracts/SyftOutput.cs | 252 +++++++++++++++--- .../linux/LinuxContainerDetector.cs | 2 +- .../linux/LinuxScanner.cs | 2 +- 4 files changed, 254 insertions(+), 41 deletions(-) diff --git a/docs/update-syft.md b/docs/update-syft.md index b2ce0b771..6ca4b6301 100644 --- a/docs/update-syft.md +++ b/docs/update-syft.md @@ -12,19 +12,40 @@ To do this: ``` 2. Find the [latest version of Syft][2] -3. Install [Skopeo][3] -4. Use [`skopeo`][4] to copy the manifest and images to our Azure Container Registry: +3. Pull the latest container image ``` - skopeo copy --all docker://docker.io/anchore/syft:{LATEST} docker://governancecontainerregistry.azurecr.io/syft:{LATEST} + $ docker pull docker.io/anchore/syft:v{LATEST} + v0.53.4: Pulling from anchore/syft + 0d60d5ab2113: Pull complete + 26136f3e3dd3: Pull complete + 497aa7f04842: Pull complete + Digest: sha256:37e85e8efdeaabb1b6f65c5bc175b664cb05d1aaddd0d922130b8e25d6e49726 + Status: Downloaded newer image for anchore/syft:v{LATEST} + docker.io/anchore/syft:v{LATEST} ``` -5. Update the container reference in [`LinuxScanner`][5] -6. Update [the models][6] that map the Syft output +4. Retag the container image + + ``` + $ docker tag docker.io/anchore/syft:v{LATEST} governancecontainerregistry.azurecr.io/syft:v{LATEST} + ``` + +5. Push the new image to the registry + + ``` + $ docker push governancecontainerregistry.azurecr.io/syft:v{LATEST} + The push refers to repository [governancecontainerregistry.azurecr.io/syft] + 9c858c120b14: Pushed + 840f3b941d62: Pushed + 21ce82bb7448: Pushed + v{LATEST}: digest: sha256:04ed9c717a814fdccf52758b67333632a0ff16840fc393f5fba5864285eaebbe size: 945 + ``` + +6. Update the container reference in [`LinuxScanner`][3] +7. Update [the models][4] that map the Syft output [1]: https://github.com/anchore/syft [2]: https://github.com/anchore/syft/releases/latest -[3]: https://github.com/containers/skopeo/blob/main/install.md -[4]: https://github.com/containers/skopeo -[5]: https://github.com/microsoft/component-detection/blob/aaf865e38112fb2448f5866ab06d5898358403f6/src/Microsoft.ComponentDetection.Detectors/linux/LinuxScanner.cs#L20 -[6]: https://github.com/microsoft/component-detection/blob/main/src/Microsoft.ComponentDetection.Detectors/linux/Contracts/SyftOutput.cs +[3]: https://github.com/microsoft/component-detection/blob/aaf865e38112fb2448f5866ab06d5898358403f6/src/Microsoft.ComponentDetection.Detectors/linux/LinuxScanner.cs#L20 +[4]: https://github.com/microsoft/component-detection/blob/main/src/Microsoft.ComponentDetection.Detectors/linux/Contracts/SyftOutput.cs diff --git a/src/Microsoft.ComponentDetection.Detectors/linux/Contracts/SyftOutput.cs b/src/Microsoft.ComponentDetection.Detectors/linux/Contracts/SyftOutput.cs index 5a2d93e11..c57168d18 100644 --- a/src/Microsoft.ComponentDetection.Detectors/linux/Contracts/SyftOutput.cs +++ b/src/Microsoft.ComponentDetection.Detectors/linux/Contracts/SyftOutput.cs @@ -30,7 +30,7 @@ public partial class ArtifactRelationshipElement public partial class ArtifactElement { - public string[] Cpes { get; set; } + public CpeElement[] Cpes { get; set; } public string FoundBy { get; set; } public string Id { get; set; } public string Language { get; set; } @@ -44,6 +44,12 @@ public partial class ArtifactElement public string Version { get; set; } } +public partial class CpeElement +{ + public string Cpe { get; set; } + public string Source { get; set; } +} + public partial class ArtifactLicense { public LocationElement[] Locations { get; set; } @@ -66,33 +72,40 @@ public partial class MetadataClass public string Architecture { get; set; } public BackupElement[] Backup { get; set; } public string Basepackage { get; set; } + public string[] Depends { get; set; } public string Description { get; set; } public File[] Files { get; set; } public string Package { get; set; } public string Packager { get; set; } + public string[] Provides { get; set; } public long? Reason { get; set; } public long? Size { get; set; } - public License? Url { get; set; } + public Checksum? Url { get; set; } public string Validation { get; set; } public string Version { get; set; } public string GitCommitOfApkPort { get; set; } public long? InstalledSize { get; set; } public string Maintainer { get; set; } public string OriginPackage { get; set; } - public string[] Provides { get; set; } public string PullChecksum { get; set; } public string[] PullDependencies { get; set; } public MatchElement[] Matches { get; set; } public string Ref { get; set; } - public string PackageId { get; set; } + public string SyftOutpuPackageId { get; set; } public string[] BuildRequires { get; set; } public string Context { get; set; } - public Dictionary Options { get; set; } + public GoBuildSettingElement[] Options { get; set; } public string Path { get; set; } public string Prev { get; set; } public string[] PyRequires { get; set; } public string[] Requires { get; set; } - public string Checksum { get; set; } + public string Channel { get; set; } + public string PackageId { get; set; } + public string PackageRevision { get; set; } + public string RecipeRevision { get; set; } + public string Timestamp { get; set; } + public string Username { get; set; } + public Checksum? Checksum { get; set; } public string HostedUrl { get; set; } public string Name { get; set; } public string VcsUrl { get; set; } @@ -105,15 +118,23 @@ public partial class MetadataClass public string LegalCopyright { get; set; } public string ProductName { get; set; } public string ProductVersion { get; set; } - public string[] Depends { get; set; } public string[] PreDepends { get; set; } public SourceUnion? Source { get; set; } public string SourceVersion { get; set; } + public string Commit { get; set; } + public string Os { get; set; } + public string OsCpe { get; set; } + public string OsVersion { get; set; } + public string SourceRepo { get; set; } + public string System { get; set; } + public string Type { get; set; } + public string Vendor { get; set; } public string PkgHash { get; set; } public string PkgHashExt { get; set; } - public Dictionary GoBuildSettings { get; set; } + public GoBuildSettingElement[] GoBuildSettings { get; set; } public string GoCompiledVersion { get; set; } public string[] GoCryptoSettings { get; set; } + public string[] GoExperiments { get; set; } public string H1Digest { get; set; } public string MainModule { get; set; } public string SnapshotUrl { get; set; } @@ -122,6 +143,7 @@ public partial class MetadataClass public PomProject PomProject { get; set; } public PomProperties PomProperties { get; set; } public string VirtualPath { get; set; } + public ReleaseUnion? Release { get; set; } public string Author { get; set; } public string Homepage { get; set; } public bool? Private { get; set; } @@ -135,13 +157,15 @@ public partial class MetadataClass public long? SwapDevice { get; set; } public string VideoMode { get; set; } public string KernelVersion { get; set; } - public License? License { get; set; } + public Checksum? License { get; set; } public Dictionary Parameters { get; set; } public string VersionMagic { get; set; } + public Dependencies? Dependencies { get; set; } public string Kb { get; set; } public string ProductId { get; set; } public string Output { get; set; } public string OutputHash { get; set; } + public string[] Licenses { get; set; } public Author[] Authors { get; set; } public string[] Bin { get; set; } public Dist Dist { get; set; } @@ -152,13 +176,15 @@ public partial class MetadataClass public Dictionary RequireDev { get; set; } public Dictionary Suggest { get; set; } public string Time { get; set; } - public string Type { get; set; } public string AuthorEmail { get; set; } public DirectUrlOrigin DirectUrlOrigin { get; set; } public string Platform { get; set; } + public string[] ProvidesExtra { get; set; } + public string[] RequiresDist { get; set; } + public string RequiresPython { get; set; } public string SitePackagesRootPath { get; set; } public string[] TopLevelPackages { get; set; } - public string[] Extras { get; set; } + public Extra[] Extras { get; set; } public string Markers { get; set; } public string VersionConstraint { get; set; } public string[] Hashes { get; set; } @@ -171,11 +197,11 @@ public partial class MetadataClass public string Title { get; set; } public long? Epoch { get; set; } public string ModularityLabel { get; set; } - public string Release { get; set; } public string SourceRpm { get; set; } - public string Vendor { get; set; } - public string[] Dependencies { get; set; } public string Revision { get; set; } + public string PackagerEmail { get; set; } + public string AuthorUri { get; set; } + public string PluginInstallDirectory { get; set; } } public partial class AuthorClass @@ -203,6 +229,15 @@ public partial class DigestElement public string Value { get; set; } } +public partial class DependencyClass +{ + public string[] Extras { get; set; } + public string Markers { get; set; } + public string Name { get; set; } + public bool Optional { get; set; } + public string Version { get; set; } +} + public partial class DirectUrlOrigin { public string CommitId { get; set; } @@ -218,6 +253,12 @@ public partial class Dist public string Url { get; set; } } +public partial class ExtraClass +{ + public string[] Dependencies { get; set; } + public string Name { get; set; } +} + public partial class FileFile { public Digest? Digest { get; set; } @@ -244,10 +285,16 @@ public partial class PurpleSyftOutpu public string Value { get; set; } } +public partial class GoBuildSettingElement +{ + public string Key { get; set; } + public string Value { get; set; } +} + public partial class Manifest { - public Dictionary Main { get; set; } - public Dictionary> NamedSections { get; set; } + public GoBuildSettingElement[] Main { get; set; } + public GoBuildSettingElement[][] Sections { get; set; } } public partial class MatchElement @@ -292,6 +339,31 @@ public partial class PomProperties public string Version { get; set; } } +public partial class ReleaseClass +{ + public string BuildInfo { get; set; } + public string BuildSource { get; set; } + public string BuildSourceRepo { get; set; } + public string BuildType { get; set; } + public string FullVersion { get; set; } + public string ImageType { get; set; } + public string Implementor { get; set; } + public string ImplementorVersion { get; set; } + public string JavaRuntimeVersion { get; set; } + public string JavaVersion { get; set; } + public string JavaVersionDate { get; set; } + public string JvmVariant { get; set; } + public string JvmVersion { get; set; } + public string Libc { get; set; } + public string[] Modules { get; set; } + public string OsArch { get; set; } + public string OsName { get; set; } + public string OsVersion { get; set; } + public string SemanticVersion { get; set; } + public string Source { get; set; } + public string SourceRepo { get; set; } +} + public partial class Descriptor { public object Configuration { get; set; } @@ -325,10 +397,34 @@ public partial class FileElement { public string Contents { get; set; } public DigestElement[] Digests { get; set; } + public Executable Executable { get; set; } public string Id { get; set; } public FileLicense[] Licenses { get; set; } public Location Location { get; set; } public Metadata Metadata { get; set; } + public string[] Unknowns { get; set; } +} + +public partial class Executable +{ + public ElfSecurityFeatures ElfSecurityFeatures { get; set; } + public string Format { get; set; } + public bool HasEntrypoint { get; set; } + public bool HasExports { get; set; } + public string[] ImportedLibraries { get; set; } +} + +public partial class ElfSecurityFeatures +{ + public bool? Cfi { get; set; } + public bool Dso { get; set; } + public bool? Fortify { get; set; } + public bool Nx { get; set; } + public bool Pie { get; set; } + public string RelRo { get; set; } + public bool? SafeStack { get; set; } + public bool? StackCanary { get; set; } + public bool SymbolTableStripped { get; set; } } public partial class FileLicense @@ -383,8 +479,74 @@ public partial struct Author public AuthorClass AuthorClass; public string String; - public static implicit operator Author(AuthorClass AuthorClass) => new Author { AuthorClass = AuthorClass }; - public static implicit operator Author(string String) => new Author { String = String }; + public static implicit operator Author(AuthorClass AuthorClass) + { + return new Author { AuthorClass = AuthorClass }; + } + public static implicit operator Author(string String) + { + return new Author { String = String }; + } +} + +public partial struct Checksum +{ + public string String; + public string[] StringArray; + + public static implicit operator Checksum(string String) + { + return new Checksum { String = String }; + } + public static implicit operator Checksum(string[] StringArray) + { + return new Checksum { StringArray = StringArray }; + } +} + +public partial struct Dependency +{ + public DependencyClass DependencyClass; + public string String; + + public static implicit operator Dependency(DependencyClass DependencyClass) + { + return new Dependency { DependencyClass = DependencyClass }; + } + public static implicit operator Dependency(string String) + { + return new Dependency { String = String }; + } +} + +public partial struct Dependencies +{ + public Dependency[] AnythingArray; + public Dictionary StringMap; + + public static implicit operator Dependencies(Dependency[] AnythingArray) + { + return new Dependencies { AnythingArray = AnythingArray }; + } + public static implicit operator Dependencies(Dictionary StringMap) + { + return new Dependencies { StringMap = StringMap }; + } +} + +public partial struct Extra +{ + public ExtraClass ExtraClass; + public string String; + + public static implicit operator Extra(ExtraClass ExtraClass) + { + return new Extra { ExtraClass = ExtraClass }; + } + public static implicit operator Extra(string String) + { + return new Extra { String = String }; + } } public partial struct Digest @@ -392,8 +554,14 @@ public partial struct Digest public DigestElement[] DigestElementArray; public PurpleSyftOutpu PurpleSyftOutpu; - public static implicit operator Digest(DigestElement[] DigestElementArray) => new Digest { DigestElementArray = DigestElementArray }; - public static implicit operator Digest(PurpleSyftOutpu PurpleSyftOutpu) => new Digest { PurpleSyftOutpu = PurpleSyftOutpu }; + public static implicit operator Digest(DigestElement[] DigestElementArray) + { + return new Digest { DigestElementArray = DigestElementArray }; + } + public static implicit operator Digest(PurpleSyftOutpu PurpleSyftOutpu) + { + return new Digest { PurpleSyftOutpu = PurpleSyftOutpu }; + } } public partial struct Size @@ -401,8 +569,14 @@ public partial struct Size public long? Integer; public string String; - public static implicit operator Size(long Integer) => new Size { Integer = Integer }; - public static implicit operator Size(string String) => new Size { String = String }; + public static implicit operator Size(long Integer) + { + return new Size { Integer = Integer }; + } + public static implicit operator Size(string String) + { + return new Size { String = String }; + } } public partial struct File @@ -410,17 +584,29 @@ public partial struct File public FileFile FileFile; public string String; - public static implicit operator File(FileFile FileFile) => new File { FileFile = FileFile }; - public static implicit operator File(string String) => new File { String = String }; + public static implicit operator File(FileFile FileFile) + { + return new File { FileFile = FileFile }; + } + public static implicit operator File(string String) + { + return new File { String = String }; + } } -public partial struct License +public partial struct ReleaseUnion { + public ReleaseClass ReleaseClass; public string String; - public string[] StringArray; - public static implicit operator License(string String) => new License { String = String }; - public static implicit operator License(string[] StringArray) => new License { StringArray = StringArray }; + public static implicit operator ReleaseUnion(ReleaseClass ReleaseClass) + { + return new ReleaseUnion { ReleaseClass = ReleaseClass }; + } + public static implicit operator ReleaseUnion(string String) + { + return new ReleaseUnion { String = String }; + } } public partial struct SourceUnion @@ -428,6 +614,12 @@ public partial struct SourceUnion public Dist Dist; public string String; - public static implicit operator SourceUnion(Dist Dist) => new SourceUnion { Dist = Dist }; - public static implicit operator SourceUnion(string String) => new SourceUnion { String = String }; + public static implicit operator SourceUnion(Dist Dist) + { + return new SourceUnion { Dist = Dist }; + } + public static implicit operator SourceUnion(string String) + { + return new SourceUnion { String = String }; + } } diff --git a/src/Microsoft.ComponentDetection.Detectors/linux/LinuxContainerDetector.cs b/src/Microsoft.ComponentDetection.Detectors/linux/LinuxContainerDetector.cs index fcd655ba2..5822cfa54 100644 --- a/src/Microsoft.ComponentDetection.Detectors/linux/LinuxContainerDetector.cs +++ b/src/Microsoft.ComponentDetection.Detectors/linux/LinuxContainerDetector.cs @@ -35,7 +35,7 @@ public LinuxContainerDetector(ILinuxScanner linuxScanner, IDockerService dockerS public IEnumerable SupportedComponentTypes => [ComponentType.Linux]; - public int Version => 4; + public int Version => 5; public bool NeedsAutomaticRootDependencyCalculation => false; diff --git a/src/Microsoft.ComponentDetection.Detectors/linux/LinuxScanner.cs b/src/Microsoft.ComponentDetection.Detectors/linux/LinuxScanner.cs index e49cfc038..2c9b1fd23 100644 --- a/src/Microsoft.ComponentDetection.Detectors/linux/LinuxScanner.cs +++ b/src/Microsoft.ComponentDetection.Detectors/linux/LinuxScanner.cs @@ -15,7 +15,7 @@ namespace Microsoft.ComponentDetection.Detectors.Linux; public class LinuxScanner : ILinuxScanner { - private const string ScannerImage = "governancecontainerregistry.azurecr.io/syft:v0.100.0@sha256:df7b07bfadff45e0135d74f22478f47b16ac6aff4e8dbd93133fcae3bbbb790d"; + private const string ScannerImage = "governancecontainerregistry.azurecr.io/syft:v1.16.0@sha256:12774e791a2b2bc48935c73da15180eee7f31815bc978b14f8f85cc408ec960b"; private static readonly IList CmdParameters = [