Merge pull request #2758 from polarathene/patch-2

ci: `Dockerfile` - Support local and git builds with the openSUSE Leap image

Author: drwetter

Dockerfile

@@ -6,41 +6,57 @@ ARG INSTALL_ROOT=/rootfs
 FROM opensuse/leap:${LEAP_VERSION} AS builder
 ARG CACHE_ZYPPER=/tmp/cache/zypper
 ARG INSTALL_ROOT
-
-
-# /etc/os-release provides $VERSION_ID below.
-# We don't need the openh264.repo and the non-oss repos, just costs build time (repo caches).
-
-RUN source /etc/os-release \
+RUN \
+  # /etc/os-release provides ${VERSION_ID} for usage in ZYPPER_OPTIONS:
+  source /etc/os-release \
+  # We don't need the openh264.repo and the non-oss repos, just costs build time (repo caches).
   && zypper removerepo repo-openh264 repo-non-oss repo-update-non-oss \
   && export ZYPPER_OPTIONS=( --releasever "${VERSION_ID}" --installroot "${INSTALL_ROOT}" --cache-dir "${CACHE_ZYPPER}" ) \
   && zypper "${ZYPPER_OPTIONS[@]}" --gpg-auto-import-keys refresh \
   && zypper "${ZYPPER_OPTIONS[@]}" --non-interactive install --download-in-advance --no-recommends \
        bash procps grep gawk sed coreutils busybox ldns libidn2-0 socat openssl curl \
-  && zypper "${ZYPPER_OPTIONS[@]}" clean --all
-## Cleanup (reclaim approx 13 MiB):
-# None of this content should be relevant to the container:
-RUN  rm -r "${INSTALL_ROOT}/usr/share/"{licenses,man,locale,doc,help,info}
-# Functionality that the container doesn't need:
-RUN  rm    "${INSTALL_ROOT}/usr/share/misc/termcap" \
-  && rm -r "${INSTALL_ROOT}/usr/lib/sysimage/rpm"
+  && zypper "${ZYPPER_OPTIONS[@]}" clean --all \
+  ## Cleanup (reclaim approx 13 MiB):
+  # None of this content should be relevant to the container:
+  && rm -r "${INSTALL_ROOT}/usr/share/"{licenses,man,locale,doc,help,info} \
+           "${INSTALL_ROOT}/usr/share/misc/termcap" \
+           "${INSTALL_ROOT}/usr/lib/sysimage/rpm"
 
 
-# Create a new image with the contents of $INSTALL_ROOT
-FROM scratch
+# Create a new image with the contents of ${INSTALL_ROOT}
+FROM scratch AS base-leap
 ARG INSTALL_ROOT
 COPY --link --from=builder ${INSTALL_ROOT} /
-# Link busybox to tar, see #2403. Create user + (home with SGID set):
-RUN  ln -s /usr/bin/busybox /usr/bin/tar \
+RUN \
+  # Creates symlinks for any other commands that busybox can provide that
+  # aren't already provided by coreutils (notably hexdump + tar, see #2403):
+  # NOTE: `busybox --install -s` is not supported via the leap package, manually symlink commands.
+  ln -s /usr/bin/busybox /usr/bin/tar \
   && ln -s /usr/bin/busybox /usr/bin/hexdump \
+  && ln -s /usr/bin/busybox /usr/bin/xxd \
+  # Add a non-root user `testssl`, this is roughly equivalent to the `useradd` command:
+  # useradd --uid 1000 --user-group --create-home --shell /bin/bash testssl
   && echo 'testssl:x:1000:1000::/home/testssl:/bin/bash' >> /etc/passwd \
   && echo 'testssl:x:1000:' >> /etc/group \
   && echo 'testssl:!::0:::::' >> /etc/shadow \
   && install --mode 2755 --owner testssl --group testssl --directory /home/testssl \
-  && ln -s /home/testssl/testssl.sh /usr/local/bin/
+  # The home directory will install a copy of `testssl.sh`, symlink the script to be used as a command:
+  && ln -s /home/testssl/testssl.sh /usr/local/bin/testssl.sh
 
-# Copy over build context (after filtered by .dockerignore): bin/ etc/ testssl.sh
-COPY --chown=testssl:testssl . /home/testssl/
+# Runtime config:
 USER testssl
 ENTRYPOINT ["testssl.sh"]
 CMD ["--help"]
+
+# Final image stage (add `testssl.sh` project files)
+# Choose either one as the final stage (defaults to last stage, `dist-local`)
+
+# 62MB Image (Remote repo clone, cannot filter content through `.dockerignore`):
+FROM base-leap AS dist-git
+ARG GIT_URL=https://github.com/testssl/testssl.sh.git
+ARG GIT_BRANCH
+ADD --chown=testssl:testssl ${GIT_URL}#${GIT_BRANCH?branch-required} /home/testssl
+
+# 54MB Image (Local repo copy from build context, uses `.dockerignore`):
+FROM base-leap AS dist-local
+COPY --chown=testssl:testssl . /home/testssl/

Dockerfile-alpine

@@ -4,18 +4,19 @@ RUN apk add --no-cache bash procps drill coreutils libidn curl socat openssl xxd
     && adduser -G testssl -g "testssl user" -s /bin/bash -D testssl \
     && ln -s /home/testssl/testssl.sh /usr/local/bin/testssl.sh
 
+# Runtime config:
 USER testssl
 ENTRYPOINT ["testssl.sh"]
 CMD ["--help"]
 
-# Final image stage (add testssl.sh project files)
+# Final image stage (add `testssl.sh` project files)
 # Choose either one as the final stage (defaults to last stage, `dist-git`)
 
-# 30MB Image (Local repo copy from build context, uses `.dockerignore`):
+# 27MB Image (Local repo copy from build context, uses `.dockerignore`):
 FROM base-alpine AS dist-local
 COPY --chown=testssl:testssl . /home/testssl/
 
-# 38MB Image (Remote repo clone, cannot filter content through `.dockerignore`):
+# 35MB Image (Remote repo clone, cannot filter content through `.dockerignore`):
 FROM base-alpine AS dist-git
 ARG GIT_URL=https://github.com/testssl/testssl.sh.git
 ARG GIT_BRANCH

Dockerfile.md

@@ -1,47 +1,66 @@
 ## Usage
 
-### From git directory
+Run the image with `testssl.sh` options appended (default is `--help`). The container entrypoint is already set to `testsl.sh` as the command for convenience.
 
-```
-docker build .
+```bash
+docker run --rm -it ghcr.io/testssl/testssl.sh:3.2 --fs github.com
 ```
 
-Catch is when you run without image tags you need to catch the ID when building
+### Output files
 
-```
-[..]
----> 889fa2f99933
-Successfully built 889fa2f99933
-```
+Keep in mind that any output file (_`--log`, `--html`, `--json`, etc._) will be created within the container.
 
-More comfortable is
+Use a volume bind mount to a local host directory to access the files outside of the container. Set a working directory for the container and any options output prefix can then use a relative path, like this example for `--htmfile`:
 
-```
-docker build -t mytestssl .
-docker run --rm -t mytestssl example.com
+```bash
+# Writes the HTML output to the host path: /tmp/example.com_p443-<date>-<time>.html
+docker run --rm -it -v /tmp:/data --workdir /data ghcr.io/testssl/testssl.sh:3.2 --htmlfile ./ example.com
 ```
 
-You can also supply command line options like:
+**NOTE:**
+- The UID/GID ownership of the file will be created by the container user `testssl` (`1000:1000`), with permissions `644`.
+- Your host directory must permit the `testssl` container user or group to write to that host volume. You could alternatively use [`docker cp`](https://docs.docker.com/reference/cli/docker/container/cp/).
 
-```
-docker run -t mytestssl --help
-docker run --rm -t mytestssl -p --header example.com
-```
+### From DockerHub or GHCR
 
-### From dockerhub or GHCR
+You can pull the image from either of these registries:
+- DockerHub: [`drwetter/testssl.sh`](https://hub.docker.com/r/drwetter/testssl.sh)
+- GHCR: [`ghcr.io/testssl/testssl.sh`](https://github.com/testssl/testssl.sh/pkgs/container/testssl.sh)
 
-You can pull the image from dockerhub or ghcr.io and run:
+Supported tags:
+- `3.2` / `latest`
+- `3.0` is the old stable version ([soon to become EOL](https://github.com/testssl/testssl.sh/tree/3.0#status))
 
-``docker run --rm -t drwetter/testssl.sh --fs example.com`` or ``docker run --rm -t ghcr.io/testssl/testssl.sh --fs example.com``
+### Building
 
-Supported tags are: ``3.2`` and ``latest``, which are the same. ``3.0`` is the old stable version which will be retired soon.
+You can build with a standard `git clone` + `docker build`. Tagging the image will make it easier to reference.
 
-``docker run --rm -t drwetter/testssl.sh:stable example.com`` or ``docker run --rm -t ghcr.io/testssl/testssl.sh:stable example.com``
+```bash
+mkdir /tmp/testssl && cd /tmp/testssl
+git clone --branch 3.2 --depth 1 https://github.com/testssl/testssl.sh .
+docker build --tag localhost/testssl.sh:3.2 .
+```
 
-Keep in mind that any output file (--log, --html, --json etc.) will be created within the container. If you wish to have this created in a local directory on your host you can mount a volume into the container and change the output prefix where the container user has write access to, e.g.:
+There are two base images available:
+- `Dockerfile` (openSUSE Leap), glibc-based + faster.
+- `Dockerfile-alpine` (Alpine), musl-based + half the size.
 
-```
-docker run --rm -t -v /tmp:/data drwetter/testssl.sh --htmlfile /data/ example.com
+Alpine is made available if you need broarder platform support or an image about 30MB smaller at the expense of speed.
+
+#### Remote build context + `Dockerfile`
+You can build with a single command instead via:
+
+```bash
+docker build --tag localhost/testssl.sh:3.2 https://github.com/testssl/testssl.sh.git#3.2
 ```
 
-which writes the HTML output to ``/tmp/example.com_p443-<date>-<time>.html.`` The uid/gid is the one from the docker user. Normally the file is 644. testssl.sh's docker container uses a non-root user (usually with user/groupid 1000:1000).
+This will produce a slightly larger image however as `.dockerignore` is not supported with remote build contexts.
+
+If you would like to build the Alpine image instead this way, just provide the alternative `Dockerfile` via `--file`:
+
+```bash
+docker build \
+  --tag localhost/testssl.sh:3.2-alpine \
+  --file https://raw.githubusercontent.com/testssl/testssl.sh/3.2/Dockerfile-alpine \
+  https://github.com/testssl/testssl.sh.git#3.2
+```