Apply Docker security best practices

org.openrewrite.docker.DockerSecurityBestPractices

Apply security-focused Docker best practices to Dockerfiles. This includes running as a non-root user (CIS 4.1) and using COPY instead of ADD where appropriate (CIS 4.9).

Tags

• security
• docker

Recipe source

GitHub: docker.yml, Issue Tracker, Maven Central

This recipe is composed of more than one recipe. If you want to customize the set of recipes this is composed of, you can find and copy the GitHub source for the recipe from the link above.

This recipe is available under the Apache License Version 2.0.

Definition

Recipe List

• Add USER instruction
  • userName: appuser
• Replace ADD with COPY
• Find containers running as root
• Find unpinned base images
• Find end-of-life Docker base images
• Find missing HEALTHCHECK

Yaml Recipe List

---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.docker.DockerSecurityBestPractices
displayName: Apply Docker security best practices
description: |
  Apply security-focused Docker best practices to Dockerfiles. This includes running as a non-root user (CIS 4.1) and using COPY instead of ADD where appropriate (CIS 4.9).
tags:
  - security
  - docker
recipeList:
  - org.openrewrite.docker.AddUserInstruction:
      userName: appuser
  - org.openrewrite.docker.ReplaceAddWithCopy
  - org.openrewrite.docker.search.FindRootUser
  - org.openrewrite.docker.search.FindUnpinnedBaseImages
  - org.openrewrite.docker.search.FindEndOfLifeImages
  - org.openrewrite.docker.search.FindMissingHealthcheck

Used by

This recipe is used as part of the following composite recipes:

• Apply Docker best practices

Usage

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe DockerSecurityBestPractices

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite:rewrite-docker:8.84.0

See how this recipe works across multiple open-source repositories

Run this recipe on OSS repos at scale with the Moderne SaaS.

Run this recipe here

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables

EolDockerImages

End-of-life Docker images

org.openrewrite.docker.table.EolDockerImages

Records Docker base images that have reached end-of-life.

Column Name	Description
Source file	The Dockerfile containing the EOL base image.
Stage name	The build stage name (from AS clause), if specified.
Image name	The name of the base image.
Tag	The image tag.
EOL date	The date when the image reached end-of-life.
Suggested replacement	Recommended newer version to migrate to.

SourcesFileResults

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column Name	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

SearchResults

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column Name	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

SourcesFileErrors

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column Name	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

RecipeRunStats

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column Name	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.