Add Dockerfiles and instructions for using docker containers #60

HugoKlepsch · 2017-12-20T20:11:01Z

Dockerfile creates an image from the master branch of this repository.
Dockerfile.dev creates an image from the local repository tree.

Added instructions to README.md with how to use these containers in a simple use case.

HugoKlepsch · 2017-12-20T20:12:42Z

Continuing @Manouchehri 's PR with an additional development dockerfile. #3

s3rvac · 2017-12-22T08:25:40Z

Thank you for continuing the work on Docker support! I will review the changes and will let you know.

s3rvac

I have reviewed the PR. Apart from a few suggestions, the only issue that has to be resolved is with the use of the container to perform decompilations. After that, we will gladly accept the PR!

s3rvac · 2017-12-26T09:30:35Z

Dockerfile

+ENV HOME /home/retdec
+
+RUN apt-get -y update && \
+	DEBIAN_FRONTEND=noninteractive apt-get install -y build-essential git bc graphviz upx cmake python zlib1g-dev flex bison libtinfo-dev autoconf pkg-config m4 libtool wget


I suggest using the same dependencies as are given in the current README file:

build-essential cmake git perl python3 bash coreutils wget bc doxygen graphviz upx flex bison zlib1g-dev libtinfo-dev autoconf automake pkg-config m4 libtool

For example, RetDec requires Python 3, but the python package provides only Python 2. Also, having only a single package list for Debian-based distributions will simplify maintenance.

Agreed, done.

s3rvac · 2017-12-26T09:31:38Z

Dockerfile.dev

+ENV HOME /home/retdec
+
+RUN apt-get -y update && \
+    DEBIAN_FRONTEND=noninteractive apt-get install -y build-essential git bc graphviz upx cmake python zlib1g-dev flex bison libtinfo-dev autoconf pkg-config m4 libtool wget


The same comment as for Dockerfile:8.

s3rvac · 2017-12-26T09:34:19Z

Dockerfile.dev

@@ -0,0 +1,23 @@
+FROM ubuntu:bionic


Could you please unify the use of tabs vs spaces? Dockerfile uses tabs for indentation, but Dockerfile.dev uses spaces. I suggest converting spaces in Dockerfile.dev to tabs so both dockerfiles use the same indentation.

s3rvac · 2017-12-26T09:37:40Z

Dockerfile.dev

+RUN chown -R retdec:retdec retdec
+
+USER retdec
+


Nitpick: I would remove this empty line as there is no empty line between USER and RUN in Dockerfile.

s3rvac · 2017-12-26T09:54:21Z

Dockerfile.dev

+    DEBIAN_FRONTEND=noninteractive apt-get install -y build-essential git bc graphviz upx cmake python zlib1g-dev flex bison libtinfo-dev autoconf pkg-config m4 libtool wget
+
+COPY . retdec
+RUN chown -R retdec:retdec retdec


I would maybe suggest replacing

COPY . retdec RUN chown -R retdec:retdec retdec

with

COPY --chown=retdec:retdec . retdec

as the standalone recursive chown is very slow (there is a lot of files). On my system, this speeds up the image creation by about 3 minutes. The only problem may be that the --chown parameter of COPY is available only since v17.09.0-ce.

I was going to use the --chown flag, but my docker version didn't support it. I wasn't able to find out what docker version comes with Ubuntu. If you're comfortable with the docker version dependency I'll change this to the --chown flag.

The 17.x Docker release is pretty new, and ships only with the upcoming Ubuntu 18.04 (available in April next year). I guess that if we used the --chown flag, a lot of users would complain that they are unable to build the image. Therefore, at the end, I think we should keep the current version that uses a standalone chown. In this way, the Dockerfile can be used by a wider range of users.

Nevertheless, maybe we should add the COPY --chown version at least in a comment with a note? Or is there a way of writing a conditional based on the Docker version?

As far as I understand, you can't conditionally run different docker commands (RUN, COPY etc).
I'll add the --chown command as a comment, perhaps in the future it will be more reasonable to use that version.

s3rvac · 2017-12-26T09:54:52Z

Dockerfile.dev

+USER retdec
+
+RUN cd retdec && \
+    ls -alh && \


What is the purpose of this ls? Is it just for debugging?

Yes that was for debugging. Sorry, forgot to remove that. Removed.

s3rvac · 2017-12-26T10:04:13Z

README.md

+Run the decompiler:
+
+```
+docker run retdec decompile.sh /destination/path/of/binary


This process does not work:

$ docker create --name retdec retdec 464c16d576d6acda87caed2e1143460a958dcc57571be51b0328be7c39f3a6fd $ docker cp test.exe retdec:/home/retdec/test.exe $ docker run retdec decompile.sh /home/retdec/test.exe Error: The input file '/home/retdec/test.exe' does not exist or is not readable

I believe that the problem is that docker cp copies the file into the retdec image but docker run runs the command in the retdec container, which does not have the file. Only after I committed the image via docker commit, I was able to decompile the file in the container that the commit produced.

What should be the correct process of using the container?

Full disclosure: I am a Docker beginner, so feel free to correct me when I did something wrong. However, I followed the instructions that are provided in the README.

I must have omitted the docker commit step in the readme.
Fixed and tested.
I think you have terminology backwards; docker cp copies into the created container, but docker run runs images. docker commit turns the container into an image.
I am also a Docker beginner, using little projects like this to become more comfortable.

HugoKlepsch · 2017-12-28T04:32:34Z

Dockerfile

+
+RUN apt-get -y update && \
+	DEBIAN_FRONTEND=noninteractive apt-get install -y 	\
+	build-essential 									\


This looks 'normal' with 4 wide tabs :\

Here, I would either keep the original form (all packages on a single line), or use tabs only for the initial indentation from the beginning of lines (and then use spaces after package names), or use spaces throughout the entire file (I don't know what is the generally preferred style when indenting Dockerfiles).

HugoKlepsch · 2017-12-28T04:34:29Z

Sorry for submitting that PR with obvious errors. I'm still getting used to the github workflow.

s3rvac · 2017-12-28T07:00:55Z

No problem ;-).

* Development dockerfile builds from the current source directory * Add instructions to build and use docker container

HugoKlepsch · 2017-12-28T16:31:38Z

Responded to indentation comments. :)

s3rvac · 2018-01-01T12:26:00Z

Thank you, merged!

s3rvac self-requested a review December 22, 2017 08:25

s3rvac self-assigned this Dec 22, 2017

s3rvac added C-build-system new-feature labels Dec 22, 2017

s3rvac requested changes Dec 26, 2017

View reviewed changes

Manouchehri added 2 commits December 27, 2017 11:52

Added Dockerfile.

06bb0cc

Removed maintainer name.

68ec007

HugoKlepsch force-pushed the docker_rebased branch from 8c4497c to f72cd56 Compare December 28, 2017 04:29

HugoKlepsch commented Dec 28, 2017

View reviewed changes

Add development Dockerfile

6c44324

* Development dockerfile builds from the current source directory * Add instructions to build and use docker container

HugoKlepsch force-pushed the docker_rebased branch from f72cd56 to 6c44324 Compare December 28, 2017 16:29

Manouchehri approved these changes Jan 1, 2018

View reviewed changes

s3rvac approved these changes Jan 1, 2018

View reviewed changes

s3rvac merged commit a546498 into avast:master Jan 1, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Dockerfiles and instructions for using docker containers #60

Add Dockerfiles and instructions for using docker containers #60

HugoKlepsch commented Dec 20, 2017

HugoKlepsch commented Dec 20, 2017

s3rvac commented Dec 22, 2017

s3rvac left a comment

s3rvac Dec 26, 2017

HugoKlepsch Dec 28, 2017

s3rvac Dec 26, 2017

HugoKlepsch Dec 28, 2017

s3rvac Dec 26, 2017

HugoKlepsch Dec 28, 2017

s3rvac Dec 26, 2017

HugoKlepsch Dec 28, 2017

s3rvac Dec 26, 2017 •

edited

Loading

HugoKlepsch Dec 27, 2017

s3rvac Dec 27, 2017

HugoKlepsch Dec 27, 2017

s3rvac Dec 26, 2017

HugoKlepsch Dec 27, 2017

s3rvac Dec 26, 2017

HugoKlepsch Dec 28, 2017

HugoKlepsch Dec 28, 2017

s3rvac Dec 28, 2017

HugoKlepsch commented Dec 28, 2017

s3rvac commented Dec 28, 2017

HugoKlepsch commented Dec 28, 2017

s3rvac commented Jan 1, 2018

Add Dockerfiles and instructions for using docker containers #60

Add Dockerfiles and instructions for using docker containers #60

Conversation

HugoKlepsch commented Dec 20, 2017

HugoKlepsch commented Dec 20, 2017

s3rvac commented Dec 22, 2017

s3rvac left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

s3rvac Dec 26, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HugoKlepsch commented Dec 28, 2017

s3rvac commented Dec 28, 2017

HugoKlepsch commented Dec 28, 2017

s3rvac commented Jan 1, 2018

s3rvac Dec 26, 2017 •

edited

Loading