Merge pull request #675 from docker-client/__engine

Merge the docker-engine repo and remove the obsolete OkDockerClient

Author: gesellix

api-client/build.gradle.kts

@@ -3,6 +3,7 @@ import java.util.*
 
 plugins {
   id("java")
+  id("groovy")
   id("org.jetbrains.kotlin.jvm")
   id("maven-publish")
   id("signing")
@@ -76,9 +77,10 @@ dependencies {
   implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.10.2")
   implementation(libs.moshi)
   implementation(libs.okhttp)
-//  implementation("com.squareup.okhttp3:logging-interceptor:[4.9,5)!!4.11.0")
+  implementation("org.bouncycastle:bcpkix-jdk18on:1.82")
+  implementation("org.apache.commons:commons-compress:1.28.0")
+//  implementation("com.squareup.okhttp3:logging-interceptor:${libs.versions.okhttpVersionrange.get()}!!${libs.versions.okhttp.get()}")
   implementation("de.gesellix:docker-remote-api-model-1-41:2025-10-31T17-49-00")
-  implementation("de.gesellix:docker-engine:2025-10-31T18-10-00")
   implementation("de.gesellix:docker-filesocket:2025-10-31T17-48-00")
 
   implementation(libs.slf4j)
@@ -91,8 +93,11 @@ dependencies {
   testImplementation(libs.junitPlatformLauncher)
   testImplementation(libs.junitPlatformCommons)
 
+  testImplementation("org.spockframework:spock-core:2.3-groovy-4.0")
+  testRuntimeOnly("net.bytebuddy:byte-buddy:1.17.8")
+
   testImplementation("org.apache.commons:commons-compress:1.28.0")
-  testImplementation("de.gesellix:testutil:[2024-01-01T01-01-01,)")
+  testImplementation("de.gesellix:testutil:[2025-01-01T01-01-01,)")
   testImplementation("de.gesellix:docker-registry:2025-10-31T17-45-00")
 }
 

api-client/src/main/java/de/gesellix/docker/authentication/AuthConfig.java

@@ -0,0 +1,106 @@
+package de.gesellix.docker.authentication;
+
+import java.util.Objects;
+
+public class AuthConfig {
+
+  public static final AuthConfig EMPTY_AUTH_CONFIG = new AuthConfig();
+
+  private String username;
+  private String password;
+  private String auth;
+  /**
+   * Email is an optional value associated with the username.
+   *
+   * @deprecated This field is deprecated and will be removed in a later version of docker.
+   */
+  @Deprecated
+  private String email;
+  private String serveraddress;
+  private String identitytoken;
+  private String registrytoken;
+
+  public String getUsername() {
+    return username;
+  }
+
+  public void setUsername(String username) {
+    this.username = username;
+  }
+
+  public String getPassword() {
+    return password;
+  }
+
+  public void setPassword(String password) {
+    this.password = password;
+  }
+
+  public String getAuth() {
+    return auth;
+  }
+
+  public void setAuth(String auth) {
+    this.auth = auth;
+  }
+
+  public String getEmail() {
+    return email;
+  }
+
+  public void setEmail(String email) {
+    this.email = email;
+  }
+
+  public String getServeraddress() {
+    return serveraddress;
+  }
+
+  public void setServeraddress(String serveraddress) {
+    this.serveraddress = serveraddress;
+  }
+
+  public String getIdentitytoken() {
+    return identitytoken;
+  }
+
+  public void setIdentitytoken(String identitytoken) {
+    this.identitytoken = identitytoken;
+  }
+
+  public String getRegistrytoken() {
+    return registrytoken;
+  }
+
+  public void setRegistrytoken(String registrytoken) {
+    this.registrytoken = registrytoken;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) {return true;}
+    if (o == null || getClass() != o.getClass()) {return false;}
+    AuthConfig that = (AuthConfig) o;
+    return Objects.equals(username, that.username) && Objects.equals(password, that.password) && Objects.equals(auth, that.auth) &&
+           Objects.equals(email, that.email) && Objects.equals(serveraddress, that.serveraddress) && Objects.equals(identitytoken, that.identitytoken) &&
+           Objects.equals(registrytoken, that.registrytoken);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(username, password, auth, email, serveraddress, identitytoken, registrytoken);
+  }
+
+  @Override
+  public String toString() {
+    return "AuthConfig{" +
+        "username='" + username + '\'' +
+        ", password=_redacted_'" + '\'' +
+        ", auth=_redacted_'" + '\'' +
+        ", email='" + email + '\'' +
+        ", serveraddress='" + serveraddress + '\'' +
+        ", identitytoken=_redacted_'" + '\'' +
+        ", registrytoken=_redacted_'" + '\'' +
+        '}';
+  }
+}

api-client/src/main/java/de/gesellix/docker/authentication/AuthConfigReader.java

@@ -0,0 +1,64 @@
+package de.gesellix.docker.authentication;
+
+import de.gesellix.docker.engine.DockerConfigReader;
+import de.gesellix.docker.engine.DockerEnv;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.File;
+import java.util.Map;
+
+import static de.gesellix.docker.authentication.AuthConfig.EMPTY_AUTH_CONFIG;
+
+public class AuthConfigReader {
+
+  private final static Logger log = LoggerFactory.getLogger(AuthConfigReader.class);
+
+  private final DockerEnv env;
+  private final DockerConfigReader dockerConfigReader;
+
+  public AuthConfigReader() {
+    this(new DockerEnv());
+  }
+
+  public AuthConfigReader(DockerEnv env) {
+    this.env = env;
+    this.dockerConfigReader = env.getDockerConfigReader();
+  }
+
+  //  @Override
+  public AuthConfig readDefaultAuthConfig() {
+    return readAuthConfig(null, dockerConfigReader.getDockerConfigFile());
+  }
+
+  //  @Override
+  public AuthConfig readAuthConfig(String hostname, File dockerCfg) {
+    log.debug("read authConfig");
+
+    if (hostname == null || hostname.trim().isEmpty()) {
+      hostname = env.getIndexUrl_v1();
+    }
+
+    Map parsedDockerCfg = dockerConfigReader.readDockerConfigFile(dockerCfg);
+    if (parsedDockerCfg == null || parsedDockerCfg.isEmpty()) {
+      return EMPTY_AUTH_CONFIG;
+    }
+
+    CredsStore credsStore = getCredentialsStore(parsedDockerCfg, hostname);
+    return credsStore.getAuthConfig(hostname);
+  }
+
+  public CredsStore getCredentialsStore(Map parsedDockerCfg) {
+    return getCredentialsStore(parsedDockerCfg, "");
+  }
+
+  public CredsStore getCredentialsStore(Map parsedDockerCfg, String hostname) {
+    if (parsedDockerCfg.containsKey("credHelpers") && hostname != null && !hostname.trim().isEmpty()) {
+      return new NativeStore((String) ((Map) parsedDockerCfg.get("credHelpers")).get(hostname));
+    }
+    if (parsedDockerCfg.containsKey("credsStore")) {
+      return new NativeStore((String) parsedDockerCfg.get("credsStore"));
+    }
+    return new FileStore(parsedDockerCfg);
+  }
+}

api-client/src/main/java/de/gesellix/docker/authentication/CredsStore.java

@@ -0,0 +1,12 @@
+package de.gesellix.docker.authentication;
+
+import java.util.Map;
+
+public interface CredsStore {
+
+  String TOKEN_USERNAME = "<token>";
+
+  AuthConfig getAuthConfig(String registry);
+
+  Map<String, AuthConfig> getAuthConfigs();
+}

api-client/src/main/java/de/gesellix/docker/authentication/CredsStoreHelper.java

@@ -0,0 +1,104 @@
+package de.gesellix.docker.authentication;
+
+import com.squareup.moshi.Moshi;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.text.MessageFormat;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+import java.util.stream.Collectors;
+
+public class CredsStoreHelper {
+
+  private static final Logger log = LoggerFactory.getLogger(CredsStoreHelper.class);
+  private final Moshi moshi = new Moshi.Builder().build();
+
+  public CredsStoreHelperResult getAuthentication(String credsStore, String hostname) {
+    Result result = execCredsHelper(credsStore, "get", hostname);
+    return toCredsStoreHelperResult(result, credsStore);
+  }
+
+  public CredsStoreHelperResult getAuthentication(String credsStore) {
+    return getAuthentication(credsStore, "https://index.docker.io/v1/");
+  }
+
+  public CredsStoreHelperResult getAllAuthentications(String credsStore) {
+    Result result = execCredsHelper(credsStore, "list", "unused");
+    return toCredsStoreHelperResult(result, credsStore);
+  }
+
+  public CredsStoreHelperResult toCredsStoreHelperResult(Result result, String credsStore) {
+    if (!result.getSuccess()) {
+      return new CredsStoreHelperResult(result.getMessage());
+    }
+
+    try {
+      return new CredsStoreHelperResult(moshi.adapter(Map.class).fromJson(result.getMessage()));
+    }
+    catch (IOException exc) {
+      log.error(MessageFormat.format("cannot parse docker-credential-{0} result", credsStore), exc);
+      return new CredsStoreHelperResult(exc.getMessage());
+    }
+    catch (Exception exc) {
+      log.error(MessageFormat.format("error trying to get credentials from docker-credential-{0}", credsStore), exc);
+      return new CredsStoreHelperResult(exc.getMessage());
+    }
+  }
+
+  private Result execCredsHelper(String credsStore, String command, String input) {
+    Process process;
+    try {
+      process = new ProcessBuilder(MessageFormat.format("docker-credential-{0}", credsStore), command).redirectErrorStream(true).redirectOutput(ProcessBuilder.Redirect.PIPE).start();
+    }
+    catch (Exception exc) {
+      log.error(MessageFormat.format("error trying to execute docker-credential-{0} {1}", credsStore, command), exc);
+      return new Result(false, exc.getMessage());
+    }
+
+    BufferedReader buffer = new BufferedReader(new InputStreamReader(process.getInputStream()));
+
+    try {
+      process.getOutputStream().write((input == null ? "".getBytes() : input.getBytes()));
+      process.getOutputStream().flush();
+      process.getOutputStream().close();
+
+      process.waitFor(10, TimeUnit.SECONDS);
+    }
+    catch (IOException | InterruptedException e) {
+      e.printStackTrace();
+    }
+
+    if (process.exitValue() != 0) {
+      log.error(MessageFormat.format("docker-credential-{0} {1} failed", credsStore, command));
+    }
+
+    return new Result(process.exitValue() == 0, buffer.lines().collect(Collectors.joining()));
+  }
+
+  public static class Result {
+
+    private final boolean success;
+    private final String message;
+
+    public Result(boolean success, String message) {
+      this.success = success;
+      this.message = message;
+    }
+
+    public boolean getSuccess() {
+      return success;
+    }
+
+    public boolean isSuccess() {
+      return success;
+    }
+
+    public String getMessage() {
+      return message;
+    }
+  }
+}

api-client/src/main/java/de/gesellix/docker/authentication/CredsStoreHelperResult.java

@@ -0,0 +1,39 @@
+package de.gesellix.docker.authentication;
+
+import java.util.Map;
+import java.util.Objects;
+
+public class CredsStoreHelperResult {
+
+  private String error;
+  private Map<String, Object> data;
+
+  public CredsStoreHelperResult(String error) {
+    this.error = error;
+  }
+
+  public CredsStoreHelperResult(Map<String, Object> data) {
+    this.data = data;
+  }
+
+  public String getError() {
+    return error;
+  }
+
+  public Map<String, Object> getData() {
+    return data;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) {return true;}
+    if (o == null || getClass() != o.getClass()) {return false;}
+    CredsStoreHelperResult that = (CredsStoreHelperResult) o;
+    return Objects.equals(error, that.error) && Objects.equals(data, that.data);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(error, data);
+  }
+}