GrypeAliases Class

Summary

Contains functionality for running Anchore Grype, a vulnerability scanner for SBOMs, container images and file systems. Grype must be installed (for example winget install Anchore.Grype) or ToolPath must be set.
Assembly
Cake.Grype.dll
Namespace
Cake.Grype
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["GrypeAliases"] class Type type-node

Syntax

public static class GrypeAliases

Attributes

Type Description
CakeAliasCategoryAttribute

Methods

Name Value Summary
GrypeDbCheck(ICakeContext, GrypeDbCheckSettings) GrypeDbCheckResult
Checks whether a newer Grype vulnerability database is available using the specified settings.
static
GrypeDbCheck(ICakeContext) GrypeDbCheckResult
Checks whether a newer Grype vulnerability database is available.
static
GrypeDbDelete(ICakeContext, GrypeDbDeleteSettings) void
Deletes the local Grype vulnerability database using the specified settings.
static
GrypeDbDelete(ICakeContext) void
Deletes the local Grype vulnerability database, for example to start a test from a clean cache.
static
GrypeDbImport(ICakeContext, FilePath, GrypeDbImportSettings) void
Imports a Grype vulnerability database archive from disk using the specified settings.
static
GrypeDbImport(ICakeContext, FilePath) void
Imports a Grype vulnerability database archive from disk, for offline or air-gapped builds.
static
GrypeDbImport(ICakeContext, Uri, GrypeDbImportSettings) void
Imports a Grype vulnerability database archive from a URL using the specified settings.
static
GrypeDbImport(ICakeContext, Uri) void
Imports a Grype vulnerability database archive from a URL. A checksum=sha256:… query parameter is verified by Grype.
static
GrypeDbStatus(ICakeContext, GrypeDbStatusSettings) GrypeDbStatus
Gets the status of the local Grype vulnerability database using the specified settings.
static
GrypeDbStatus(ICakeContext) GrypeDbStatus
Gets the status of the local Grype vulnerability database. A missing database returns Valid == false with an Error instead of throwing.
static
GrypeDbUpdate(ICakeContext, GrypeDbUpdateSettings) void
Downloads and installs the latest Grype vulnerability database using the specified settings.
static
GrypeDbUpdate(ICakeContext) void
Downloads and installs the latest Grype vulnerability database.
static
GrypeReadJson(ICakeContext, FilePath) GrypeReport
Reads a Grype JSON report (written with GrypeOutput.Json(file)) for inspection in C#.
static
GrypeScan(ICakeContext, GrypeSource, GrypeScanSettings) void
Scans a source for vulnerabilities with Grype using the specified settings.
static
GrypeScan(ICakeContext, GrypeSource) void
Scans a source for vulnerabilities with Grype. A string is passed to Grype unchanged, for example "registry:alpine:3.20".
static
GrypeScanDirectory(ICakeContext, DirectoryPath, GrypeScanSettings) void
Scans a directory for vulnerabilities with Grype using the specified settings.
static
GrypeScanDirectory(ICakeContext, DirectoryPath) void
Scans a directory for vulnerabilities with Grype.
static
GrypeScanFile(ICakeContext, FilePath, GrypeScanSettings) void
Scans a single file for vulnerabilities with Grype using the specified settings.
static
GrypeScanFile(ICakeContext, FilePath) void
Scans a single file for vulnerabilities with Grype.
static
GrypeScanImage(ICakeContext, string, GrypeScanSettings) void
Scans a container image for vulnerabilities with Grype using the specified settings.
static
GrypeScanImage(ICakeContext, string) void
Scans a container image for vulnerabilities with Grype, using Grype's default image lookup.
static
GrypeScanRegistry(ICakeContext, string, GrypeScanSettings) void
Scans a container image pulled directly from a registry with Grype using the specified settings.
static
GrypeScanRegistry(ICakeContext, string) void
Scans a container image pulled directly from a registry (no container runtime required) with Grype.
static
GrypeScanSbom(ICakeContext, FilePath, GrypeScanSettings) void
Scans an SBOM (Syft JSON, CycloneDX or SPDX) for vulnerabilities with Grype using the specified settings.
static
GrypeScanSbom(ICakeContext, FilePath) void
Scans an SBOM (Syft JSON, CycloneDX or SPDX) for vulnerabilities with Grype.
static
GrypeVersion(ICakeContext, GrypeVersionSettings) GrypeVersion
Gets Grype's version information using the specified settings.
static
GrypeVersion(ICakeContext) GrypeVersion
Gets Grype's version information.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Requires the Cake.Issues addin