Merge pull request #526 from ReFirmLabs/525-Publish-binwalk-as-a-Docker-image

525 publish binwalk as a docker image

.dockerignore

+build
+dist
+.coverage
+*.extracted
+*.pyc
+.editorconfig
+.gitignore
+images
+Dockerfile
+.dockerignore
+.git

.travis.yml

@@ -13,19 +13,31 @@ script: ./setup.py test
 cache: pip
 jobs:
   include:
-   - dist: bionic
+   - stage: test
+     services: docker
+     install: echo "No install for this job"
+     script: docker build .
+   - stage: test
+     dist: bionic
      python: 3.6
-   - dist: bionic
+   - stage: test
+     dist: bionic
      python: 3.7
-   - dist: bionic
+   - stage: test
+     dist: bionic
      python: 3.8
-   - dist: bionic
+   - stage: test
+     dist: bionic
      python: 3.9
-   - dist: focal
+   - stage: test
+     dist: focal
      python: 3.6
-   - dist: focal
+   - stage: test
+     dist: focal
      python: 3.7
-   - dist: focal
+   - stage: test
+     dist: focal
      python: 3.8
-   - dist: focal
+   - stage: test
+     dist: focal
      python: 3.9

Dockerfile

+FROM python:3-buster AS build-and-install
+
+ENV PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/src/app/bin \
+    DEBIAN_FRONTEND=noninteractive
+
+COPY . /tmp
+WORKDIR /tmp
+
+### Took out the deps.sh from binwalk's installation script, baked in the dependencies into the main prereqs installation
+### The prereqs that dont come from system's repo, are taken care of later
+RUN set -xue \
+    && apt-get update -qy \
+    && apt-get -t buster dist-upgrade -yq --no-install-recommends -o Dpkg::Options::="--force-confold" \
+    && ./deps.sh --yes \
+    && python3 setup.py install && binwalk -h > /dev/null \
+    && apt-get -yq purge *-dev git build-essential gcc g++ \
+    && apt-get -y autoremove \
+    && apt-get -y autoclean \
+    && echo "en_US.UTF-8 UTF-8" >> /etc/locale.gen \
+    && echo "LANG=en_US.UTF-8" >> /etc/default/locale \
+    && echo "LANGUAGE=en_US:en" >> /etc/default/locale \
+    && echo "LC_ALL=en_US.UTF-8" >> /etc/default/locale \
+    && locale-gen
+
+FROM build-and-install AS unit-tests
+RUN pip install coverage nose \
+    && python3 setup.py test \
+    && dd if=/dev/urandom of=/tmp/random.bin bs=1M count=1 && binwalk -J -E /tmp/random.bin
+
+FROM build-and-install AS cleanup-and-release
+RUN useradd -m -u 1000 -s /sbin/nologin appuser \
+    && rm -rf -- \
+        /var/lib/apt/lists/* \
+        /tmp/* /var/tmp/* \
+        /root/.cache/pip
+
+# Setup locale. This prevents Python 3 IO encoding issues.
+ENV DEBIAN_FRONTEND=teletype \
+    LANG=en_US.UTF-8 \
+    LANGUAGE=en_US:en \
+    LC_ALL=en_US.UTF-8 \
+    PYTHONUTF8="1" \
+    PYTHONHASHSEED="random"
+
+WORKDIR /home/appuser
+USER appuser
+
+ENTRYPOINT ["binwalk"]

deps.sh

@@ -41,23 +41,23 @@ APTGETCMD="apt-get"
 YUMCMD="yum"
 if [ $distro = "Kali" ]
 then
-    APT_CANDIDATES="git build-essential qt5base-dev mtd-utils gzip bzip2 tar arj lhasa p7zip p7zip-full cabextract util-linux firmware-mod-kit cramfsswap squashfs-tools zlib1g-dev liblzma-dev liblzo2-dev sleuthkit default-jdk lzop cpio"
+    APT_CANDIDATES="git locales build-essential qt5base-dev mtd-utils gzip bzip2 tar arj lhasa p7zip p7zip-full cabextract util-linux firmware-mod-kit cramfsswap squashfs-tools zlib1g-dev liblzma-dev liblzo2-dev sleuthkit default-jdk lzop cpio"
 elif [ $distro_version = "14" ]
 then
-    APT_CANDIDATES="git build-essential libqt4-opengl mtd-utils gzip bzip2 tar arj lhasa p7zip p7zip-full cabextract cramfsprogs cramfsswap squashfs-tools zlib1g-dev liblzma-dev liblzo2-dev sleuthkit default-jdk lzop srecord cpio"
+    APT_CANDIDATES="git locales build-essential libqt4-opengl mtd-utils gzip bzip2 tar arj lhasa p7zip p7zip-full cabextract cramfsprogs cramfsswap squashfs-tools zlib1g-dev liblzma-dev liblzo2-dev sleuthkit default-jdk lzop srecord cpio"
 elif [ $distro_version = "15" ]
 then
-    APT_CANDIDATES="git build-essential libqt4-opengl mtd-utils gzip bzip2 tar arj lhasa p7zip p7zip-full cabextract cramfsprogs cramfsswap squashfs-tools zlib1g-dev liblzma-dev liblzo2-dev sleuthkit default-jdk lzop srecord cpio"
+    APT_CANDIDATES="git locales build-essential libqt4-opengl mtd-utils gzip bzip2 tar arj lhasa p7zip p7zip-full cabextract cramfsprogs cramfsswap squashfs-tools zlib1g-dev liblzma-dev liblzo2-dev sleuthkit default-jdk lzop srecord cpio"
 elif [ $distro_version = "16" ]
 then
-    APT_CANDIDATES="git build-essential libqt4-opengl mtd-utils gzip bzip2 tar arj lhasa p7zip p7zip-full cabextract cramfsprogs cramfsswap squashfs-tools zlib1g-dev liblzma-dev liblzo2-dev sleuthkit default-jdk lzop srecord cpio"
+    APT_CANDIDATES="git locales build-essential libqt4-opengl mtd-utils gzip bzip2 tar arj lhasa p7zip p7zip-full cabextract cramfsprogs cramfsswap squashfs-tools zlib1g-dev liblzma-dev liblzo2-dev sleuthkit default-jdk lzop srecord cpio"
 elif [ $distro_version = "18" ]
 then
-    APT_CANDIDATES="git build-essential libqt4-opengl mtd-utils gzip bzip2 tar arj lhasa p7zip p7zip-full cabextract cramfsswap squashfs-tools zlib1g-dev liblzma-dev liblzo2-dev sleuthkit default-jdk lzop srecord cpio"
+    APT_CANDIDATES="git locales build-essential libqt4-opengl mtd-utils gzip bzip2 tar arj lhasa p7zip p7zip-full cabextract cramfsswap squashfs-tools zlib1g-dev liblzma-dev liblzo2-dev sleuthkit default-jdk lzop srecord cpio"
 else
-    APT_CANDIDATES="git build-essential qtbase5-dev mtd-utils gzip bzip2 tar arj lhasa p7zip p7zip-full cabextract cramfsswap squashfs-tools zlib1g-dev liblzma-dev liblzo2-dev sleuthkit default-jdk lzop srecord cpio"
+    APT_CANDIDATES="git locales build-essential qtbase5-dev mtd-utils gzip bzip2 tar arj lhasa p7zip p7zip-full cabextract cramfsswap squashfs-tools zlib1g-dev liblzma-dev liblzo2-dev sleuthkit default-jdk lzop srecord cpio"
 fi
-PYTHON3_APT_CANDIDATES="python3-crypto python3-gnupg python3-pip python3-tk"
+PYTHON3_APT_CANDIDATES=""
 PYTHON3_YUM_CANDIDATES=""
 YUM_CANDIDATES="git gcc gcc-c++ make openssl-devel qtwebkit-devel qt-devel gzip bzip2 tar arj p7zip p7zip-plugins cabextract squashfs-tools zlib zlib-devel lzo lzo-devel xz xz-compat-libs xz-libs xz-devel xz-lzma-compat python-backports-lzma lzip pyliblzma perl-Compress-Raw-Lzma lzop srecord"
 PIP_COMMANDS="pip3"
@@ -256,9 +256,7 @@ if [ $? -ne 0 ]
     echo "Package installation failed: $PKG_CANDIDATES"
     exit 1
 fi
-install_pip_package setuptools
-install_pip_package matplotlib
-install_pip_package capstone
+install_pip_package "setuptools matplotlib capstone pycryptodome gnupg tk"
 install_sasquatch
 install_yaffshiv
 install_jefferson