The Internet Encryption Toolkit: Encrypted Internet Proxy and Encrypted Mail.
Your internet encryption toolkit
Bitmask is the client for the services offered by the LEAP Platform. It contains a command-line interface and a multiplatform desktop client. It can be also used as a set of libraries to communicate with the different services from third party applications.
Package under development!
This is a unified repo that has merged the following packages, previously isolated, under the leap namespace:
bonafide, mail, keymanager, bitmask.
The previous Qt client has been deprecated (bitmask version 0.8.2, still available at the http://github.com/leapcode/bitmask_client repo).
Note that this repo still doesn’t have support for VPN: its porting will follow soon.
Read the Docs!
The latest documentation about Bitmask is available at LEAP.
Please report any bugs in our bug tracker.
You need tox to run the tests. If you don’t have it in your system yet:
pip install tox
And then run all the tests:
In order to run bitmask in a development environment, you must activate a virtualenv and install the various packages using ‘pip install -e’. This installs python packages as links to the source code, so that your code changes are immediately reflected in the packages installed in the virtualenv.
The various make dev-* commands will run the appropriate pip install commands for you.
Run headless backend in development mode
sudo apt install build-essential python-dev python-virtualenv \ libsqlcipher-dev libssl-dev libffi-dev
Install and activate a virtualenv:
cd bitmask-dev virtualenv venv source venv/bin/activate
All the subsequent commands assume that you have activated the virtualenv.
Install all the python dependencies:
Run user interface frontend
If you want to run the Bitmask user interface, you additionally need the following:
sudo apt install python-pyqt5 python-pyqt5.qtwebkit
Install python dependencies:
Run user interface:
The command bitmask should be in your path if you have activated the virtual environment.
Install Bitmask user interface in development mode
sudo apt install nodejs npm nodejs-legacy
Next, run dev-install:
cd ui make dev-install # install JS code as a python package in "develop" mode.
Now you should be able to run the user interface with debugging tools:
bitmaskd chromium-browser http://localhost:7070
Firefox does not work as well, because the UI is only tested with webkit-based browsers.
Chromium is not the best for this, however, because it uses a newer webkit. Instead, try qupzilla:
sudo apt install qupzilla bitmaskd qupzilla -ow http://localhost:7070
cd ui node run watch
For more information, see ui/README.md.
Bitmask is released under the terms of the GNU GPL version 3 or later.