Merge pull request #464 from tls-attacker/docker-builds

Provide Prebuilt Docker Images

Author: ic0ns

Dockerfile

@@ -1,4 +1,4 @@
-FROM jelastic/maven:3.9.5-openjdk-21 AS build-image
+FROM maven:3.9.9-eclipse-temurin-21-jammy AS build-image
 WORKDIR /build
 RUN git clone https://github.com/RUB-NDS/TLS-Scanner.git
 
@@ -7,7 +7,7 @@ RUN git submodule update --init --recursive
 RUN mvn clean package
 
 #############
-FROM openjdk:21
+FROM eclipse-temurin:21
 
 COPY --from=build-image /build/TLS-Scanner/apps /apps
 

Dockerfile_Jenkins

@@ -0,0 +1,5 @@
+FROM eclipse-temurin:21
+
+COPY ./apps/ /apps/
+WORKDIR /apps
+ENTRYPOINT ["java", "-jar", "TLS-Server-Scanner.jar"]

Jenkinsfile

@@ -151,14 +151,44 @@ pipeline {
                     uploadGithubReleaseAsset(
                         credentialId: '1522a497-e78a-47ee-aac5-70f071fa6714',
                         repository: GIT_URL.tokenize("/.")[-3,-2].join("/"),
-                        tagName: draftRelease.htmlUrl.tokenize("/")[-1], 
+                        tagName: draftRelease.htmlUrl.tokenize("/")[-1],
                         uploadAssets: [
                             [filePath: "${env.WORKSPACE}/TLS-Scanner-${TAG_NAME}.zip"]
                         ]
                     )
                 }
             }
         }
+        stage('Public Docker Images') {
+            when {
+                tag 'v*'
+                environment name: 'GIT_URL', value: 'https://github.com/tls-attacker/TLS-Scanner.git'
+            }
+            steps {
+                script {
+                    docker.withRegistry('https://ghcr.io','github-docker-token') {
+                        def image = docker.build("ghcr.io/tls-attacker/tlsscanner:${TAG_NAME}", "-f Dockerfile_Jenkins .")
+                        image.push()
+                        image.push('latest')
+                    }
+                }
+            }
+        }
+        stage('Internal Docker Images') {
+                    when {
+                        tag 'v*'
+                        environment name: 'GIT_URL', value: 'https://github.com/tls-attacker/TLS-Scanner-Development.git'
+                    }
+                    steps {
+                        script {
+                            docker.withRegistry('https://hydrogen.cloud.nds.rub.de','Jenkins-User-Nexus-Repository') {
+                                def image = docker.build("hydrogen.cloud.nds.rub.de/tls-attacker/tlsscanner:${TAG_NAME}", "-f Dockerfile_Jenkins .")
+                                image.push()
+                                image.push('latest')
+                            }
+                        }
+                    }
+                }
     }
     post {
         always {

README.md

@@ -33,7 +33,9 @@ $ mvn clean install
 
 # Running
 
-In order to run TLS-Scanner you need to run the jar file in the apps/ folder.
+In order to run TLS-Scanner you need to run one of the jar files in the apps/ folder.
+These can be obtained by compiling the app yourself or by
+[downloading released jar files from GitHub](https://github.com/tls-attacker/TLS-Scanner/releases).
 
 ```bash
 $ java -jar apps/TLS-Server-Scanner.jar -connect localhost:4433
@@ -45,7 +47,20 @@ In order to see more details about the Guidelines, use "-reportDetail ALL".
 
 # Docker
 
-We provide you with a Dockerfile, which lets you run the scanner directly:
+We provide prebuilt docker images for easy use of the TLS-Server-Scanner.
+
+```bash
+$ docker run --network host ghcr.io/tls-attacker/tlsscanner -connect localhost:4433
+```
+
+The image is made to be used for server-scanning but also contains the other jar files.
+They can be accessed by altering the entrypoint.
+
+```bash
+$ docker run --network host --entrypoint "java" ghcr.io/tls-attacker/tlsscanner -jar TLS-Client-Scanner.jar
+```
+
+We also provide you with a Dockerfile, to build the container yourself:
 
 ```bash
 $ docker build . -t tlsscanner