Mozilla VPN

See: https://vpn.mozilla.org

Dev instructions

After checking out the code:

Install the git pre-commit hook (./scripts/git-pre-commit-format install)
Build the source (See below)
Run the tests ./scripts/test_coverage.sh or ./scripts/test_function.sh

How to build from the source code

Linux

On linux, the compilation of MozillaVPN is relative easy. You need the following dependencies:

Qt5 >= 5.15.0
libpolkit-gobject-1-dev >=0.105
wireguard >=1.0.20200513
wireguard-tools >=1.0.20200513
resolvconf >= 1.82

Python3 (pip) depedencies:

glean_parser
pyhumps
pyyaml

QT5

Qt5 can be installed in a number of ways:

download a binary package or the installer from the official QT website: https://www.qt.io/download
use a linux package manager
compile Qt5 (dinamically or statically).

To build QT5 statically on Ubuntu/Debian, go to the root directory of this project and follow these steps:

curl -L https://download.qt.io/archive/qt/5.15/5.15.1/single/qt-everywhere-src-5.15.1.tar.xz --output qt-everywhere-src-5.15.1.tar.xz
tar xvf qt-everywhere-src-5.15.1.tar.xz
mv qt-everywhere-src-5.15.1 qt
sudo apt build-dep qt5-default
sudo apt install libxcb-xinerama0-dev
bash scripts/qt5_compile.sh qt qt

See https://wiki.qt.io/Building_Qt_5_from_Git#Linux.2FX11 if you get stuck or are on another distro.

Finally, add $(pwd)/qt/qt/bin to PATH.

Initialization

# submodules
git submodule init
git submodule update
# glean
./scripts/generate_clean.py
# translations
python scripts/importLanguages.py

Build

To build next to source:

qmake CONFIG+=production
make -j8 # replace 8 with the number of cores. Or use: make -j$(nproc)
sudo make install

For local dev builds, the following qmake command may be more helpful qmake CONFIG+=debug CONFIG+=inspector.

If you prefer to not install at /usr or /etc, you can specify alternate prefixes. Using no prefixes is equivalent to:

qmake USRPATH=/usr ETCPATH=/etc CONFIG+=production

Run

If you have built into /usr, simply run

mozillavpn

Alternatively, you can use two terminals to run the daemon manually and seperately e.g.

sudo mozillavpn linuxdaemon
mozillavpn

mozillavpn linuxdaemon needs privileged access and so if you do not run as root, you will get an authentication prompt every time you try to reconnect the vpn.

MacOS

On macOS, we strongly suggest to compile Qt5 statically. To do that, follow these steps:

curl -L https://download.qt.io/archive/qt/5.15/5.15.1/single/qt-everywhere-src-5.15.1.tar.xz --output qt-everywhere-src-5.15.1.tar.xz
tar vxf qt-everywhere-src-5.15.1.tar.xz
mv qt-everywhere-src-5.15.1 qt
bash scripts/qt5_compile.sh `pwd`/qt qt
export QT_MACOS_BIN=`pwd`/qt/qt/bin

The procedure to compile MozillaVPN for macOS is the following:

Install XCodeProj: $ [sudo] gem install xcodeproj
Install go if you haven't done it before: https://golang.org/dl/
Update the submodules: $ git submodule init $ git submodule update --remote
Install python3 dependencies: $ pip3 install glean_parser $ pip3 install pyhumps $ pip3 install pyyaml
Run the script (use QT_MACOS_BIN env to set the path for the Qt5 macos build bin folder): $ ./scripts/apple_compile.sh macos
Copy xcode.xconfig.template to xcode.xconfig $ cp xcode.xconfig.template xcode.xconfig
Modify xcode.xconfig to something like:

DEVELOPMENT_TEAM = 43AQ936H96

# MacOS configuration
GROUP_ID_MACOS = <>
APP_ID_MACOS = org.mozilla.macos.FirefoxVPN
NETEXT_ID_MACOS = org.mozilla.macos.FirefoxVPN.network-extension
LOGIN_ID_MACOS = org.mozilla.macos.FirefoxVPN.login
NATIVEMESSAGING_ID_MACOS = org.mozilla.macos.FirefoxVPN.native-messaging

# IOS configuration
GROUP_ID_IOS = <>
APP_ID_IOS = <>
NETEXT_ID_IOS = <>

Open Xcode and run/test/archive/ship the app

To build a Release style build (ready for signing), use:

cd MozillaVPN.xcodeproj
xcodebuild -scheme MozillaVPN -workspace project.xcworkspace -configuration Release clean build CODE_SIGNING_ALLOWED=NO

The built up will show up in Release/Mozilla VPN.app (relative to the root of the repo).

IOS

The IOS procedure is similar to the macOS one:

Install XCodeProj: $ [sudo] gem install xcodeproj
Update the submodules: $ git submodule init $ git submodule update --remote
Install python3 dependencies: $ pip install glean_parser $ pip3 install pyhumps $ pip3 install pyyaml
Copy xcode.xconfig.template to xcode.xconfig $ cp xcode.xconfig.template xcode.xconfig
Modify xcode.xconfig to something like:

DEVELOPMENT_TEAM = 43AQ936H96

# MacOS configuration
GROUP_ID_MACOS = <>
APP_ID_IOS = <>
NETEXT_ID_IOS = <>
LOGIN_ID_IOS = <>
NATIVEMESSAGING_ID_MACOS = <>

# IOS configuration
GROUP_ID_IOS = <>
APP_ID_IOS = org.mozilla.ios.FirefoxVPN
NETEXT_ID_IOS = org.mozilla.ios.FirefoxVPN.network-extension

Run the script (use QT_IOS_BIN env to set the path for the Qt5 ios build bin folder): $ ./scripts/apple_compile.sh ios
Open Xcode and run/test/archive/ship the app

Android

Install go if you haven't done it before: https://golang.org/dl/
Install Android SDK/NDK + JDK - https://doc.qt.io/qt-5/android-getting-started.html
We currently require NDK r20b and SDK >=21
Update the submodules:

  $ git submodule init
  $ git submodule update --remote

Install python3 dependencies:

  $ pip3 install glean_parser
  $ pip3 install pyhumps
  $ pip3 install pyyaml

Build the apk

  $  ./scripts/android_package.sh /path/to/Qt/5.15.x/ (debug|release)

The apk will be located in .tmp/src/android-build//build/outputs/apk/debug/android-build-debug.apk
Install with adb on device/emulator

  $ adb install .tmp/src/android-build//build/outputs/apk/debug/android-build-debug.apk

Windows

We use a statically-compiled QT5.15 version to deploy the app. There are many tutorials about to how to compile QT5 on windows, but to make this task easier for everyone, there is a batch script to execute into a visual-studio x86 context: $ scripts\qt5_compile.bat

The dependencies are: