Skip to content

The Unified and Autonomous Development Platform

feat: Introduce Run Buildx Image Tools step with registry login support

Robin Sheneaa9b99ef44a
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/RunImagetoolsStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/RunImagetoolsStep.java
index 554c7948b0..b4b2887d16 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/RunImagetoolsStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/RunImagetoolsStep.java
@@ -1,31 +1,39 @@
package io.onedev.server.buildspec.step;
import static io.onedev.server.buildspec.step.StepGroup.DOCKER_IMAGE;
+import static java.util.stream.Collectors.toList;
+import java.util.ArrayList;
+import java.util.List;
+
+import jakarta.validation.Valid;
import jakarta.validation.constraints.NotEmpty;
+import io.onedev.commons.codeassist.InputSuggestion;
+import io.onedev.k8shelper.RunImagetoolsFacade;
+import io.onedev.k8shelper.StepFacade;
import io.onedev.server.annotation.Editable;
import io.onedev.server.annotation.Interpolative;
+import io.onedev.server.buildspec.BuildSpec;
+import io.onedev.server.buildspec.param.ParamCombination;
+import io.onedev.server.model.Build;
+import io.onedev.server.model.support.administration.DockerAware;
+import io.onedev.server.model.support.administration.jobexecutor.JobExecutor;
+import io.onedev.server.model.support.administration.jobexecutor.KubernetesAware;
@Editable(order=230, name="Run Buildx Image Tools", group = DOCKER_IMAGE, description="Run docker buildx imagetools " +
- "inside a container with specified arguments. This step can be executed by server docker executor, " +
- "remote docker executor, or Kubernetes executor")
-public class RunImagetoolsStep extends RegistryToolStep {
+ "command with specified arguments. This step can only be executed by server docker executor " +
+ "or remote docker executor")
+public class RunImagetoolsStep extends Step {
private static final long serialVersionUID = 1L;
private String arguments;
- @Editable
- @Override
- public String getImage() {
- return "1dev/buildx:1.0.0";
- }
+ private List<RegistryLogin> registryLogins = new ArrayList<>();
@Editable(order=100, description="Specify arguments for imagetools. For instance " +
- "<code>create -t myorg/myrepo:1.0.0 myorg/myrepo@&lt;arm64 manifest digest&gt; myorg/myrepo@&lt;amd64 manifest digest&gt;</code>. " +
- "Local OCI layout paths and file options are relative to the job working directory inside the container. " +
- "Host builder configurations are not available")
+ "<code>create -t myorg/myrepo:1.0.0 myorg/myrepo@&lt;arm64 manifest digest&gt; myorg/myrepo@&lt;amd64 manifest digest&gt;</code>")
@Interpolative(variableSuggester="suggestVariables")
@NotEmpty
public String getArguments() {
@@ -36,9 +44,30 @@ public class RunImagetoolsStep extends RegistryToolStep {
this.arguments = arguments;
}
+ @Editable(order=200, group="More Settings", description="Optionally specify registry logins to override " +
+ "those defined in job executor. For built-in registry, use <code>@server_url@</code> for registry url, " +
+ "<code>@job_token@</code> for user name, and access token secret for password secret")
+ public List<@Valid RegistryLogin> getRegistryLogins() {
+ return registryLogins;
+ }
+
+ public void setRegistryLogins(List<RegistryLogin> registryLogins) {
+ this.registryLogins = registryLogins;
+ }
+
+ static List<InputSuggestion> suggestVariables(String matchWith) {
+ return BuildSpec.suggestVariables(matchWith, true, true, false);
+ }
+
+ @Override
+ public StepFacade getFacade(Build build, JobExecutor jobExecutor, String jobToken, ParamCombination paramCombination) {
+ var registryLogins = getRegistryLogins().stream().map(it->it.getFacade(build)).collect(toList());
+ return new RunImagetoolsFacade(getArguments(), registryLogins);
+ }
+
@Override
- public String getCommand() {
- return "docker buildx imagetools " + getArguments();
+ public boolean isApplicable(Build build, JobExecutor executor) {
+ return executor instanceof DockerAware && !(executor instanceof KubernetesAware);
}
}
diff --git a/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java b/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java
index 84b43bad7c..573c30d704 100644
--- a/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java
+++ b/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java
@@ -9542,6 +9542,7 @@ public class DataMigrator {
|| executorElement.getName().endsWith(".RemoteDockerExecutor")) {
executorElement.addElement("imageBuildEnabled").setText("false");
executorElement.addElement("builderCachePruneEnabled").setText("false");
+ executorElement.addElement("imagetoolsEnabled").setText("false");
}
}
}
diff --git a/server-core/src/test/java/io/onedev/server/buildspec/step/RunImagetoolsStepTest.java b/server-core/src/test/java/io/onedev/server/buildspec/step/RunImagetoolsStepTest.java
deleted file mode 100644
index ce684ebbc1..0000000000
--- a/server-core/src/test/java/io/onedev/server/buildspec/step/RunImagetoolsStepTest.java
+++ /dev/null
@@ -1,124 +0,0 @@
-package io.onedev.server.buildspec.step;
-
-import static java.nio.charset.StandardCharsets.UTF_8;
-import static org.junit.jupiter.api.Assertions.*;
-import static org.mockito.Mockito.*;
-
-import java.util.ArrayList;
-import java.util.Base64;
-import java.util.Collection;
-import java.util.List;
-import java.util.Map;
-
-import org.junit.jupiter.api.Test;
-
-import com.fasterxml.jackson.databind.ObjectMapper;
-
-import io.onedev.commons.loader.AppLoader;
-import io.onedev.commons.loader.AppLoaderMocker;
-import io.onedev.commons.loader.ImplementationRegistry;
-import io.onedev.k8shelper.CommandFacade;
-import io.onedev.k8shelper.RegistryLoginFacade;
-import io.onedev.server.buildspec.BuildSpec;
-import io.onedev.server.data.migration.MigrationHelper;
-import io.onedev.server.data.migration.VersionedYamlDoc;
-import io.onedev.server.model.support.administration.DockerAware;
-import io.onedev.server.model.support.administration.jobexecutor.JobExecutor;
-import io.onedev.server.model.support.administration.jobexecutor.KubernetesAware;
-
-class RunImagetoolsStepTest extends AppLoaderMocker {
-
- @Override
- protected void setup() {
- when(AppLoader.getInstance(ImplementationRegistry.class)).thenReturn(new ImplementationRegistry() {
- @Override
- public <T> Collection<Class<? extends T>> getImplementations(Class<T> type) {
- var implementations = new ArrayList<Class<? extends T>>();
- if (type.isAssignableFrom(RunImagetoolsStep.class))
- implementations.add(RunImagetoolsStep.class.asSubclass(type));
- return implementations;
- }
- });
- }
-
- @Override
- protected void teardown() {
- }
-
- @Test
- void usesContainerCommandForLocalOciAndFileOptions() {
- var step = new RunImagetoolsStep();
- step.setArguments("create -f 'descriptor file.json' --metadata-file metadata.json "
- + "-t oci-layout://combined:latest oci-layout://amd64:latest oci-layout://arm64:latest");
- // Inherited command settings cannot turn this into host execution.
- step.setRunInContainer(false);
- step.setImage("another-image");
- var facade = assertInstanceOf(CommandFacade.class, step.getFacade(null, null, "token", null));
- assertEquals("1dev/buildx:1.0.0", facade.getImage());
- assertEquals("sh", facade.getExecutable());
- assertEquals("docker buildx imagetools " + step.getArguments(), facade.getCommands());
- assertTrue(step.isApplicable(null, mock(JobExecutor.class, withSettings().extraInterfaces(DockerAware.class))));
- assertTrue(step.isApplicable(null, mock(JobExecutor.class, withSettings().extraInterfaces(KubernetesAware.class))));
- assertFalse(step.isApplicable(null, mock(JobExecutor.class)));
- }
-
- @Test
- void sharesRegistryOverridesAndTrustCertificatesWithCrane() throws Exception {
- var executor = mock(JobExecutor.class, withSettings().extraInterfaces(DockerAware.class));
- when(((DockerAware) executor).getRegistryLogins("token")).thenReturn(List.of(
- new RegistryLoginFacade("registry.example", "executor", "executor-password"),
- new RegistryLoginFacade("other.example", "other", "other-password")));
- var logins = List.of(new RegistryLoginFacade("registry.example", "job", "$literal-password"));
- var imagetools = new RunImagetoolsStep();
- imagetools.setArguments("inspect oci-layout://image:latest");
- var pull = new PullImageStep();
- pull.setSrcImage("registry.example/image:latest");
- pull.setDestPath("image");
- var push = new PushImageStep();
- push.setSrcPath("image");
- push.setDestImage("registry.example/image:latest");
- for (var step : List.of(imagetools, pull, push)) {
- step.setTrustCertificates("-----BEGIN CERTIFICATE-----\r\ncertificate\r\n-----END CERTIFICATE-----");
- var facade = (CommandFacade) step.getFacade(null, executor, "token", null, logins, Map.of("EXAMPLE", "value"));
- var commands = facade.getCommands();
- var configPrefix = "cat <<'EOF' > /root/.docker/config.json\n";
- var configStart = commands.indexOf(configPrefix) + configPrefix.length();
- assertTrue(commands.contains(configPrefix));
- var auths = new ObjectMapper().readTree(commands.substring(configStart, commands.indexOf("\nEOF", configStart))).get("auths");
- assertEquals(2, auths.size());
- assertEquals("job:$literal-password", new String(Base64.getDecoder().decode(auths.get("registry.example").get("auth").asText()), UTF_8));
- assertEquals("other:other-password", new String(Base64.getDecoder().decode(auths.get("other.example").get("auth").asText()), UTF_8));
- assertTrue(commands.contains("cat <<'EOF' > /root/trust-certs.crt\n-----BEGIN CERTIFICATE-----\ncertificate\n-----END CERTIFICATE-----\nEOF\nexport SSL_CERT_FILE=/root/trust-certs.crt\n"));
- assertTrue(commands.endsWith(step.getCommand()));
- assertEquals(logins, facade.getRegistryLogins());
- assertEquals(Map.of("EXAMPLE", "value"), facade.getEnvMap());
- assertEquals(step instanceof CraneStep ? "1dev/crane:1.0.0" : "1dev/buildx:1.0.0", facade.getImage());
- }
- }
-
- @Test
- void preservesExistingBuildSpecArgumentsAndRegistryLogins() {
- var yaml = """
- version: %s
- jobs:
- - name: image
- steps:
- - type: RunImagetoolsStep
- name: manifest
- arguments: create -t registry.example/image:latest registry.example/image:amd64
- registryLogins:
- - registryUrl: registry.example
- userName: job
- passwordSecret: registry-password
- """.formatted(MigrationHelper.getVersion(BuildSpec.class));
- BuildSpec spec = VersionedYamlDoc.fromYaml(yaml).toBean(BuildSpec.class);
- BuildSpec restored = VersionedYamlDoc.fromYaml(VersionedYamlDoc.fromBean(spec).toYaml()).toBean(BuildSpec.class);
- var step = assertInstanceOf(RunImagetoolsStep.class, restored.getJobs().get(0).getSteps().get(0));
- assertEquals("create -t registry.example/image:latest registry.example/image:amd64", step.getArguments());
- assertEquals("registry.example", step.getRegistryLogins().get(0).getRegistryUrl());
- assertEquals("job", step.getRegistryLogins().get(0).getUserName());
- assertEquals("registry-password", step.getRegistryLogins().get(0).getPasswordSecret());
- assertTrue(step.isRunInContainer());
- assertEquals("1dev/buildx:1.0.0", step.getImage());
- }
-}
diff --git a/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesExecutor.java b/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesExecutor.java
index 8a2e3d5e95..724308aa48 100644
--- a/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesExecutor.java
+++ b/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesExecutor.java
@@ -74,6 +74,7 @@ import io.onedev.k8shelper.LeafFacade;
import io.onedev.k8shelper.PruneBuilderCacheFacade;
import io.onedev.k8shelper.RegistryLoginFacade;
import io.onedev.k8shelper.RunContainerFacade;
+import io.onedev.k8shelper.RunImagetoolsFacade;
import io.onedev.k8shelper.ServiceFacade;
import io.onedev.k8shelper.SetupCacheFacade;
import io.onedev.server.OneDev;
@@ -800,7 +801,7 @@ public class KubernetesExecutor extends JobExecutor implements KubernetesAware,
} else if (facade instanceof BuildImageFacade) {
throw new ExplicitException("This step can only be executed by server docker executor or " +
"remote docker executor. Use kaniko step instead to build image in kubernetes cluster");
- } else if (facade instanceof RunContainerFacade
+ } else if (facade instanceof RunContainerFacade || facade instanceof RunImagetoolsFacade
|| facade instanceof PruneBuilderCacheFacade) {
throw new ExplicitException("This step can only be executed by server docker executor or " +
"remote docker executor");
diff --git a/server-plugin/server-plugin-executor-remotedocker/src/main/java/io/onedev/server/plugin/executor/remotedocker/RemoteDockerExecutor.java b/server-plugin/server-plugin-executor-remotedocker/src/main/java/io/onedev/server/plugin/executor/remotedocker/RemoteDockerExecutor.java
index 05db821850..9475e899b0 100644
--- a/server-plugin/server-plugin-executor-remotedocker/src/main/java/io/onedev/server/plugin/executor/remotedocker/RemoteDockerExecutor.java
+++ b/server-plugin/server-plugin-executor-remotedocker/src/main/java/io/onedev/server/plugin/executor/remotedocker/RemoteDockerExecutor.java
@@ -110,7 +110,7 @@ public class RemoteDockerExecutor extends ServerDockerExecutor {
var dockerSettings = new JobDockerSettings(isMountDockerSock(), getDockerSockPath(),
getCpuLimit(), getMemoryLimit(), getRunOptions(), registryLogins,
isAlwaysPullImage(), getDockerBuilder(), getNetworkOptions(),
- isImageBuildEnabled(), isBuilderCachePruneEnabled());
+ isImageBuildEnabled(), isBuilderCachePruneEnabled(), isImagetoolsEnabled());
DockerJobData jobData = new DockerJobData(jobToken, getName(), jobContext.getProjectPath(),
jobContext.getProjectId(), jobContext.getRefName(), jobContext.getCommitId().name(),
jobContext.getBuildNumber(), jobContext.getSubmitSequence(), jobContext.getActions(),
diff --git a/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java b/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java
index 0198de1a9d..de0df57682 100644
--- a/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java
+++ b/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java
@@ -51,6 +51,7 @@ import io.onedev.k8shelper.LeafHandler;
import io.onedev.k8shelper.PruneBuilderCacheFacade;
import io.onedev.k8shelper.RegistryLoginFacade;
import io.onedev.k8shelper.RunContainerFacade;
+import io.onedev.k8shelper.RunImagetoolsFacade;
import io.onedev.k8shelper.ServerSideFacade;
import io.onedev.k8shelper.ServerStepResult;
import io.onedev.k8shelper.SetupCacheFacade;
@@ -105,6 +106,8 @@ public class ServerDockerExecutor extends JobExecutor implements DockerAware, Te
private boolean imageBuildEnabled;
private boolean builderCachePruneEnabled;
+
+ private boolean imagetoolsEnabled;
private String dockerSockPath;
@@ -225,7 +228,7 @@ public class ServerDockerExecutor extends JobExecutor implements DockerAware, Te
}
@Editable(order=540, name="Enable Builder Cache Prune", group="Security Settings", description="Enable this to allow to run prune builder cache step<br>"
- + "<b class='text-danger'>WARNING</b>: Malicious jobs can read arbitrary host files by running this step. Make sure this executor can only be used by "
+ + "<b class='text-danger'>WARNING</b>: Clearing shared builder cache can affect other jobs using same builder. Make sure this executor can only be used by "
+ "trusted jobs if this option is enabled")
public boolean isBuilderCachePruneEnabled() {
return builderCachePruneEnabled;
@@ -235,6 +238,17 @@ public class ServerDockerExecutor extends JobExecutor implements DockerAware, Te
this.builderCachePruneEnabled = builderCachePruneEnabled;
}
+ @Editable(order=550, name="Enable Buildx Image Tools", group="Security Settings", description="Enable this to allow to run the buildx image tools step<br>"
+ + "<b class='text-danger'>WARNING</b>: Malicious jobs can read or write arbitrary host files by running this step. Make sure this executor can only be used by "
+ + "trusted jobs if this option is enabled")
+ public boolean isImagetoolsEnabled() {
+ return imagetoolsEnabled;
+ }
+
+ public void setImagetoolsEnabled(boolean imagetoolsEnabled) {
+ this.imagetoolsEnabled = imagetoolsEnabled;
+ }
+
@Editable(order=40, group="Resource Settings", placeholder = "No limit", description = "" +
"Optionally specify cpu limit of each job/service using this executor. This will be " +
"used as option <a href='https://docs.docker.com/config/containers/resource_constraints/#cpu' target='_blank'>--cpus</a> " +
@@ -460,6 +474,15 @@ public class ServerDockerExecutor extends JobExecutor implements DockerAware, Te
isAlwaysPullImage(), isImageBuildEnabled(), getName(), jobLogger);
return null;
});
+ } else if (facade instanceof RunImagetoolsFacade) {
+ var runImagetoolsFacade = (RunImagetoolsFacade) facade;
+ var docker = newDocker();
+ var registryLogins = merge(runImagetoolsFacade.getRegistryLogins(), getRegistryLogins(jobToken));
+ callWithRegistryLogins(docker, registryLogins, () -> {
+ JobUtils.runImagetools(docker, runImagetoolsFacade, buildDir,
+ isImagetoolsEnabled(), getName(), jobLogger);
+ return null;
+ });
} else if (facade instanceof PruneBuilderCacheFacade) {
var pruneBuilderCacheFacade = (PruneBuilderCacheFacade) facade;
var docker = newDocker();
diff --git a/server-plugin/server-plugin-executor-servershell/src/main/java/io/onedev/server/plugin/executor/servershell/ServerShellExecutor.java b/server-plugin/server-plugin-executor-servershell/src/main/java/io/onedev/server/plugin/executor/servershell/ServerShellExecutor.java
index 20bd0a9799..bcd7bf0320 100644
--- a/server-plugin/server-plugin-executor-servershell/src/main/java/io/onedev/server/plugin/executor/servershell/ServerShellExecutor.java
+++ b/server-plugin/server-plugin-executor-servershell/src/main/java/io/onedev/server/plugin/executor/servershell/ServerShellExecutor.java
@@ -45,6 +45,7 @@ import io.onedev.k8shelper.LeafFacade;
import io.onedev.k8shelper.LeafHandler;
import io.onedev.k8shelper.PruneBuilderCacheFacade;
import io.onedev.k8shelper.RunContainerFacade;
+import io.onedev.k8shelper.RunImagetoolsFacade;
import io.onedev.k8shelper.ServerSideFacade;
import io.onedev.k8shelper.ServerStepResult;
import io.onedev.k8shelper.SetupCacheFacade;
@@ -224,7 +225,7 @@ public class ServerShellExecutor extends JobExecutor implements Testable<Testabl
return false;
}
} else if (facade instanceof BuildImageFacade || facade instanceof RunContainerFacade
- || facade instanceof PruneBuilderCacheFacade) {
+ || facade instanceof RunImagetoolsFacade || facade instanceof PruneBuilderCacheFacade) {
throw new ExplicitException("This step can only be executed by server docker executor or "
+ "remote docker executor");
} else if (facade instanceof CheckoutFacade) {
diff --git a/server-product/system/incompatibilities/incompatibilities.md b/server-product/system/incompatibilities/incompatibilities.md
index 0f4ddad531..70eee6ae88 100644
--- a/server-product/system/incompatibilities/incompatibilities.md
+++ b/server-product/system/incompatibilities/incompatibilities.md
@@ -2,7 +2,7 @@
### CI/CD
-The `Build Image` and `Prune Builder Cache` steps are now disabled by default because malicious jobs can read arbitrary host files by running these steps. After upgrading, jobs using either step will fail unless the corresponding option (`Enable Image Build` or `Enable Builder Cache Prune`) is enabled under **Security Settings** of the relevant server or remote Docker executor. When enabling either option, make sure the executor can only be used by trusted projects.
+The `Build Image`, `Prune Builder Cache`, and `Run Buildx Image Tools` steps are now disabled by default because malicious jobs can access arbitrary host files by running these steps. After upgrading, jobs using these steps will fail unless the corresponding option (`Enable Buildx Image Build`, `Enable Builder Cache Prune`, or `Enable Buildx Image Tools`, respectively) is enabled under **Security Settings** of the relevant server or remote Docker executor. When enabling any of these options, make sure the executor can only be used by trusted projects. The build image step using kaniko remains available without enabling these options.
# 16.8.0