Added constructor for pre-selected image (#89)

Author: mmaehren

src/main/java/de/rub/nds/tls/subject/docker/DockerTlsClientInstance.java

@@ -13,6 +13,7 @@
 import com.github.dockerjava.api.model.Bind;
 import com.github.dockerjava.api.model.ContainerConfig;
 import com.github.dockerjava.api.model.HostConfig;
+import com.github.dockerjava.api.model.Image;
 import com.github.dockerjava.api.model.Volume;
 import de.rub.nds.tls.subject.ConnectionRole;
 import de.rub.nds.tls.subject.HostInfo;
@@ -39,6 +40,7 @@ public class DockerTlsClientInstance extends DockerTlsInstance {
 
     // TODO move away from HostInfo for client...
     public DockerTlsClientInstance(
+            Image image,
             String containerName,
             ParameterProfile profile,
             ImageProperties imageProperties,
@@ -51,6 +53,7 @@ public DockerTlsClientInstance(
             boolean connectOnStartup,
             UnaryOperator<HostConfig> hostConfigHook) {
         super(
+                image,
                 containerName,
                 profile,
                 imageProperties,

src/main/java/de/rub/nds/tls/subject/docker/DockerTlsInstance.java

@@ -42,6 +42,7 @@ public abstract class DockerTlsInstance {
     private final UnaryOperator<HostConfig> hostConfigHook;
 
     public DockerTlsInstance(
+            Image image,
             String containerName,
             ParameterProfile profile,
             ImageProperties imageProperties,
@@ -66,10 +67,14 @@ public DockerTlsInstance(
                 profile.getType().name().toLowerCase());
         labels.put(TlsImageLabels.VERSION.getLabelName(), version);
         labels.put(TlsImageLabels.CONNECTION_ROLE.getLabelName(), role.toString().toLowerCase());
-        this.image =
-                DOCKER.listImagesCmd().withLabelFilter(labels).exec().stream()
-                        .findFirst()
-                        .orElseThrow(TlsVersionNotFoundException::new);
+        if (image == null) {
+            this.image =
+                    DOCKER.listImagesCmd().withLabelFilter(labels).exec().stream()
+                            .findFirst()
+                            .orElseThrow(TlsVersionNotFoundException::new);
+        } else {
+            this.image = image;
+        }
     }
 
     protected HostConfig prepareHostConfig(HostConfig cfg) {

src/main/java/de/rub/nds/tls/subject/docker/DockerTlsManagerFactory.java

@@ -60,6 +60,7 @@ public abstract static class TlsInstanceBuilder<T extends TlsInstanceBuilder<T>>
         protected final ParameterProfile profile;
         protected final ImageProperties imageProperties;
         protected final String version;
+        protected Image image;
         protected boolean autoRemove = true;
         // shared constructor parameters
         // Host Info:
@@ -90,6 +91,21 @@ public TlsInstanceBuilder(
             this.transportType = transportType;
         }
 
+        public TlsInstanceBuilder(Image image, TransportType transportType) {
+            this.version = image.getLabels().get(TlsImageLabels.VERSION.getLabelName());
+            TlsImplementationType type =
+                    TlsImplementationType.fromString(
+                            image.getLabels().get(TlsImageLabels.IMPLEMENTATION.getLabelName()));
+            ConnectionRole role =
+                    ConnectionRole.valueOf(
+                            image.getLabels()
+                                    .get(TlsImageLabels.CONNECTION_ROLE.getLabelName())
+                                    .toUpperCase());
+            this.profile = retrieveParameterProfile(type, version, role);
+            this.imageProperties = retrieveImageProperties(role, type);
+            this.transportType = transportType;
+        }
+
         public T autoRemove(boolean value) {
             autoRemove = value;
             return (T) this;
@@ -206,6 +222,10 @@ public TlsClientInstanceBuilder(
             super(type, version, ConnectionRole.CLIENT, transportType);
         }
 
+        public TlsClientInstanceBuilder(Image image, TransportType transportType) {
+            super(image, transportType);
+        }
+
         public TlsClientInstanceBuilder pull() {
             super.pull(ConnectionRole.CLIENT);
             return this;
@@ -214,6 +234,7 @@ public TlsClientInstanceBuilder pull() {
         @Override
         public DockerTlsClientInstance build() throws DockerException, InterruptedException {
             return new DockerTlsClientInstance(
+                    image,
                     containerName,
                     profile,
                     imageProperties,
@@ -241,6 +262,10 @@ public TlsServerInstanceBuilder(
             super(type, version, ConnectionRole.SERVER, transportType);
         }
 
+        public TlsServerInstanceBuilder(Image image, TransportType transportType) {
+            super(image, transportType);
+        }
+
         public TlsServerInstanceBuilder pull() {
             super.pull(ConnectionRole.SERVER);
             return this;
@@ -249,6 +274,7 @@ public TlsServerInstanceBuilder pull() {
         @Override
         public DockerTlsServerInstance build() throws DockerException, InterruptedException {
             return new DockerTlsServerInstance(
+                    image,
                     containerName,
                     profile,
                     imageProperties,
@@ -349,6 +375,28 @@ public static List<Image> getAllImages() {
                 .exec();
     }
 
+    public static Image getMatchingImage(
+            List<Image> images, TlsImplementationType type, String version, ConnectionRole role) {
+        return images.stream()
+                .filter(
+                        image ->
+                                image.getLabels()
+                                        .get(TlsImageLabels.VERSION.getLabelName())
+                                        .equals(version))
+                .filter(
+                        image ->
+                                image.getLabels()
+                                        .get(TlsImageLabels.IMPLEMENTATION.getLabelName())
+                                        .equals(type.name().toLowerCase()))
+                .filter(
+                        image ->
+                                image.getLabels()
+                                        .get(TlsImageLabels.CONNECTION_ROLE.getLabelName())
+                                        .equals(role.name().toLowerCase()))
+                .findFirst()
+                .orElse(null);
+    }
+
     private static void executeCommand(Runtime runtime, String command, int timeout)
             throws InterruptedException, IOException {
         Process process = runtime.exec(command);

src/main/java/de/rub/nds/tls/subject/docker/DockerTlsServerInstance.java

@@ -12,6 +12,7 @@
 import com.github.dockerjava.api.command.InspectContainerResponse;
 import com.github.dockerjava.api.model.ExposedPort;
 import com.github.dockerjava.api.model.HostConfig;
+import com.github.dockerjava.api.model.Image;
 import com.github.dockerjava.api.model.NetworkSettings;
 import com.github.dockerjava.api.model.PortBinding;
 import com.github.dockerjava.api.model.Ports.Binding;
@@ -31,6 +32,7 @@ public class DockerTlsServerInstance extends DockerTlsInstance {
     private ExposedPort exposedImplementationPort;
 
     public DockerTlsServerInstance(
+            Image image,
             String containerName,
             ParameterProfile profile,
             ImageProperties imageProperties,
@@ -42,6 +44,7 @@ public DockerTlsServerInstance(
             boolean insecureConnection,
             UnaryOperator<HostConfig> hostConfigHook) {
         super(
+                image,
                 containerName,
                 profile,
                 imageProperties,