构建声明

构建证明描述了镜像的构建方式及其包含的内容。证明在构建时由 BuildKit 创建,并作为元数据附加到最终镜像。

证明的目的是使检查镜像并查看其来源、创建者和方式以及包含的内容成为可能。这使您可以根据您定义的策略规则对镜像进行验证,从而对镜像如何影响应用程序的供应链安全做出明智的决策。它还支持使用策略引擎。

提供两种类型的构建注释

  • 软件物料清单 (SBOM):镜像包含的软件工件列表,或用于构建镜像的软件工件列表。
  • 来源:镜像的构建方式。

证明的目的

开源和第三方软件包的使用比以往任何时候都更加广泛。开发人员共享和重用代码,因为它有助于提高生产力,使团队能够更快地创建更好的产品。

在未经审核的情况下导入和使用其他地方创建的代码会带来严重的安全性风险。即使您确实审核了使用的软件,也经常会发现新的零日漏洞,这要求开发团队采取行动对其进行修复。

构建证明使查看镜像的内容及其来源变得更容易。使用证明来分析和决定是否使用镜像,或者查看您正在使用的镜像是否容易受到漏洞攻击。

创建证明

使用docker buildx build构建镜像时,可以使用--provenance--sbom选项向生成的镜像添加证明记录。您可以选择添加 SBOM 或来源证明类型,或同时添加两者。

$ docker buildx build --sbom=true --provenance=true .

注意

默认镜像存储不支持证明。如果您使用默认镜像存储并使用默认docker驱动程序或使用带有--load标志的不同驱动程序构建镜像,则证明将丢失。

为确保保留证明,您可以

  • 使用带有--push标志的docker-container驱动程序直接将镜像推送到注册表。
  • 启用containerd 镜像存储

注意

默认情况下启用来源证明,选项为mode=min。您可以使用--provenance=false标志或设置BUILDX_NO_DEFAULT_ATTESTATIONS环境变量来禁用来源证明。

使用--provenance=true标志默认情况下会附加具有mode=max的来源证明。有关更多详细信息,请参阅来源证明

构建镜像时,BuildKit 会生成证明。证明记录使用 in-toto JSON 格式包装,并附加到最终镜像的清单中的镜像索引。

存储

BuildKit 使用in-toto 格式生成证明,如in-toto 框架Linux 基金会支持的标准所定义的。

证明作为镜像索引中的清单附加到镜像。证明的数据记录存储为 JSON Blob。

由于证明作为清单附加到镜像,这意味着您可以检查注册表中任何镜像的证明,而无需拉取整个镜像。

所有 BuildKit 导出器都支持证明。localtar无法将证明保存到镜像清单中,因为它输出的是文件目录或 tarball,而不是镜像。相反,这些导出器会将证明写入导出根目录中的一个或多个 JSON 文件中。

以下示例显示了 SBOM 证明的截断 in-toto JSON 表示形式。

{
  "_type": "https://in-toto.io/Statement/v0.1",
  "predicateType": "https://spdx.dev/Document",
  "subject": [
    {
      "name": "pkg:docker/<registry>/<image>@<tag/digest>?platform=<platform>",
      "digest": {
        "sha256": "e8275b2b76280af67e26f068e5d585eb905f8dfd2f1918b3229db98133cb4862"
      }
    }
  ],
  "predicate": {
    "SPDXID": "SPDXRef-DOCUMENT",
    "creationInfo": {
      "created": "2022-12-15T11:47:54.546747383Z",
      "creators": ["Organization: Anchore, Inc", "Tool: syft-v0.60.3"],
      "licenseListVersion": "3.18"
    },
    "dataLicense": "CC0-1.0",
    "documentNamespace": "https://anchore.com/syft/dir/run/src/core-da0f600b-7f0a-4de0-8432-f83703e6bc4f",
    "name": "/run/src/core",
    // list of files that the image contains, e.g.:
    "files": [
      {
        "SPDXID": "SPDXRef-1ac501c94e2f9f81",
        "comment": "layerID: sha256:9b18e9b68314027565b90ff6189d65942c0f7986da80df008b8431276885218e",
        "fileName": "/bin/busybox",
        "licenseConcluded": "NOASSERTION"
      }
    ],
    // list of packages that were identified for this image:
    "packages": [
      {
        "name": "busybox",
        "originator": "Person: Sören Tempel <soeren+alpine@soeren-tempel.net>",
        "sourceInfo": "acquired package info from APK DB: lib/apk/db/installed",
        "versionInfo": "1.35.0-r17",
        "SPDXID": "SPDXRef-980737451f148c56",
        "description": "Size optimized toolbox of many common UNIX utilities",
        "downloadLocation": "https://busybox.net/",
        "licenseConcluded": "GPL-2.0-only",
        "licenseDeclared": "GPL-2.0-only"
        // ...
      }
    ],
    // files-packages relationship
    "relationships": [
      {
        "relatedSpdxElement": "SPDXRef-1ac501c94e2f9f81",
        "relationshipType": "CONTAINS",
        "spdxElementId": "SPDXRef-980737451f148c56"
      },
      ...
    ],
    "spdxVersion": "SPDX-2.2"
  }
}

要深入了解认证的存储方式,请参阅镜像认证存储 (BuildKit)

后续步骤

了解更多可用的认证类型以及如何使用它们