dangerzone/BUILD.md

Development environment

Debian/Ubuntu

Install dependencies:

sudo apt install -y podman dh-python python3 python3-stdeb python3-pyside2.qtcore python3-pyside2.qtgui python3-pyside2.qtwidgets python3-appdirs python3-click python3-xdg python3-requests python3-colorama

Run from source tree:

./dev_scripts/dangerzone

Create a .deb:

./install/linux/build_deb.py

Fedora

Install dependencies:

sudo dnf install -y rpm-build podman python3 python3-setuptools python3-pyside2 python3-appdirs python3-click python3-pyxdg python3-requests python3-colorama

Run from source tree:

./dev_scripts/dangerzone

Create a .rpm:

./install/linux/build_rpm.py

macOS

Install Docker Desktop.

Install python@3.9 from Homebrew:

brew install python@3.9 create-dmg

If you don't have it already, install poetry (pip3 install --user poetry). Then install dependencies:

poetry install

Run from source tree:

# start a shell in the virtual environment
poetry shell

# run the CLI
./dev_scripts/dangerzone-cli --help

# run the GUI
./dev_scripts/dangerzone

To create an app bundle, use the build_app.py script:

poetry run ./install/macos/build_app.py

If you want to build for distribution, you'll need a codesigning certificate, and then run:

poetry run ./install/macos/build_app.py --with-codesign

The output is in the dist folder.

Windows

Install Docker Desktop.

These instructions include adding folders to the path in Windows. To do this, go to Start and type "advanced system settings", and open "View advanced system settings" in the Control Panel. Click Environment Variables. Under "System variables" double-click on Path. From there you can add and remove folders that are available in the PATH.

Download Python 3.9.0, 32-bit (x86) from https://www.python.org/downloads/release/python-390/. I downloaded python-3.9.0.exe. When installing it, make sure to check the "Add Python 3.9 to PATH" checkbox on the first page of the installer.

Install poetry. Open PowerShell, and run:

(Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python

Change to the dangerzone folder, and install the poetry dependencies:

poetry install

After that you can launch dangerzone during development with:

.\dev_scripts\dangerzone.bat
.\dev_scripts\dangerzone-cli.bat --help

If you want to build a .exe

Download and install the Windows 10 SDK.

Add the following directories to the path:

• C:\Program Files (x86)\Windows Kits\10\bin\10.0.19041.0\x86
• C:\Program Files (x86)\Windows Kits\10\Redist\ucrt\DLLs\x86

If you want the .exe to not get falsely flagged as malicious by anti-virus software

Dangerzone uses PyInstaller to turn the python source code into Windows executable .exe file. Apparently, malware developers also use PyInstaller, and some anti-virus vendors have included snippets of PyInstaller code in their virus definitions. To avoid this, you have to compile the Windows PyInstaller bootloader yourself instead of using the pre-compiled one that comes with PyInstaller.

Here's how to compile the PyInstaller bootloader:

Download and install Microsoft Build Tools for Visual Studio 2019. I downloaded vs_buildtools__719988613.1603831511.exe. In the installer, check the box next to "C++ build tools". Click "Individual components", and under "Compilers, build tools and runtimes", check "Windows Universal CRT SDK". Then click install. When installation is done, you may have to reboot your computer.

Then, enable the 32-bit Visual C++ Toolset on the Command Line like this:

cd "C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\VC\Auxiliary\Build"
vcvars32.bat

Change to a folder where you keep source code, and clone the PyInstaller git repo and checkout the v4.3 tag:

git clone https://github.com/pyinstaller/pyinstaller.git
cd pyinstaller
git checkout v4.3

The next step is to compile the bootloader. We should do this all in dangerzone's poetry shell:

cd dangerzone
poetry shell
cd ..\pyinstaller

Then, compile the bootloader:

cd bootloader
python waf distclean all --target-arch=32bit --msvc_targets=x86
cd ..

Finally, install the PyInstaller module into your poetry environment:

python setup.py install
exit

Now the next time you use PyInstaller to build dangerzone, the .exe file should not be flagged as malicious by anti-virus.

If you want to build the installer

• Go to https://dotnet.microsoft.com/download/dotnet-framework and download and install .NET Framework 3.5 SP1 Runtime. I downloaded dotnetfx35.exe.
• Go to https://wixtoolset.org/releases/ and download and install WiX toolset. I downloaded wix311.exe.
• Add C:\Program Files (x86)\WiX Toolset v3.11\bin to the path.

If you want to sign binaries with Authenticode

• You'll need a code signing certificate. I got an open source code signing certificate from Certum.
• Once you get a code signing key and certificate and covert it to a pfx file, import it into your certificate store.

To make a .exe

Open a command prompt, cd into the dangerzone directory, and run:

poetry run pyinstaller install\pyinstaller\pyinstaller.spec

dangerzone.exe and all of their supporting files will get created inside the dist folder.

You then must create a symbolic link for dangerzone to run. To do this, open a command prompt as an administrator, cd to the dangerzone folder, and run:

cd dist\dangerzone
mklink dangerzone-container.exe dangerzone.exe

To build the installer

Note that you must have a codesigning certificate installed in order to use the install\windows\build.bat script, because it codesigns dangerzone.exe and Dangerzone.msi.

Open a command prompt, cd to the dangerzone directory, and run:

poetry run install\windows\step1-build-exe.bat

Open a second command prompt as an administratror, cd to the dangerzone directory, and run:

install\windows\step2-make-symlink.bat

Then back in the first command prompt, run:

poetry run install\windows\step3-build-installer.bat

When you're done you will have dist\Dangerzone.msi.