Skip to content
BETAGuardrails are in beta. The library, the configuration format and the CLI command can still change.

Guardrails / iac

Dockerfile base images are pinned

iac/dockerfile-base-pinned@v1

Every image a Dockerfile builds from is pinned to a digest, so a rebuild of the same commit starts from the same bytes.

Idiac/dockerfile-base-pinned
Versionv1
Categoryiac
Default severityerror
Interpreterpython3
Timeout30 seconds
Violations tolerated0
Collectsdocker

Collectors

This guardrail gathers nothing itself. It depends on the collectors below, which the CLI runs once per build before any check, and reads what they found out of GUARDRAIL_FACTS. A collector that collects nothing skips this guardrail rather than failing it.

CollectorGathersInputs it is given
dockerEvery Dockerfile in the tree, parsed without a tool: the stages it builds, the image each one starts from and how that image is pinned, the user the image ends as, the ports it exposes, the paths it copies in and the names of the build arguments and environment variables it declares, enriched with the findings of a hadolint report when the build already left one behind.none

The inputs above are this guardrail's own, passed straight through. Configuring one in buildnote.json changes what is collected, and two guardrails configured the same way share the one collection.

Configuration

json
{
  "guardrails": {
      "failOn": "error",
      "comment": true,
      "checks": [
          {
              "use": "iac/dockerfile-base-pinned@v1",
              "severity": "error",
              "with": {
                  "allowTags": "false",
                  "registries": ""
              },
              "exemptions": []
          }
      ]
  }
}

Inputs

InputDescriptionDefaultEnvironment variable
allowTagsWhether a tag other than latest counts as a pin. false requires a digest, which is the only reference that resolves to the same image twice.falseGUARDRAIL_INPUT_ALLOWTAGS
registriesComma separated registries an image may come from, such as docker.io,ghcr.io. Empty means any registry. An image naming no registry comes from Docker Hub, so name docker.io to allow those.``GUARDRAIL_INPUT_REGISTRIES

How to fix

Pin the image to the digest its tag resolves to today, so the base cannot change under a rebuild:

dockerfile
FROM node:20.11.1-alpine@sha256:e4b0d6d6b1a2c2a58e8dd8a0e0b1f0d0c2c9f9c5b3a1e0d9c8b7a6f5e4d3c2b1 AS build

docker buildx imagetools inspect node:20.11.1-alpine prints the digest to paste in, and Renovate and Dependabot both raise pull requests against a pinned digest, so the pin is maintained rather than frozen.

A tag moves whenever the publisher pushes. Two builds of the same commit then produce different images, and the one an auditor asks about is not the one that ran.

More in iac

All 11 iac guardrails

Buildnote Limited
Registered in England and Wales, Reg: 16140412