diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 363 |
1 files changed, 42 insertions, 321 deletions
@@ -23,15 +23,7 @@ Please see the [issues](https://0xacab.org/leap/bitmask_android/issues) section * [Debug APKs](#debug-apks) * [Release APKs](#release-apks) * [Signed Release APKs](#signed-release-apks) -* [Running Tests](#running-tests) -* [Debugging in an Emulator](#debugging-in-an-emulator) - * [From Android Studio](#from-android-studio) - * [From The Shell](#from-the-shell) - * [Debian Gotchas](#debian-gotchas) - * [Virtualization Not Enabled](#virtualization-not-enabled) - * [Unpatched Filepaths Bug](#unpatched-filepaths-bug) - * [Outdated GL Libraries](#outdated-gl-libraries) -* [Updating Submodules](#updating-submodules) +* [Supported Versions](#supported-versions) * [Acknowledgments](#acknowledgments) * [Contributing](#contributing) @@ -46,19 +38,20 @@ We will assume for convenience that you are installing on a Debian- or Ubuntu-ba The Bitmask Android Client has the following system-level dependencies: -* JDK v. 1.8 -* Assorted 32-bit C libraries -* Android SDK Tools, v. 27.0.3, with these packages: - * Platform-Tools, v. 27.0.3 - * Build-Tools, API v. 23-27 - * Platforms 23-27 +* JDK 11 +* Android SDK Tools, v. 30.0.3, with these packages: + * Platform-Tools, v. 30.0.3 + * Build-Tools, API v. 30 + * Platforms 30 * Android Support Repository * Google Support Repository - * NDK v. r16b (enables C code in Android) + * NDK v. r21e (enables C code in Android) * For running the app in an emulator, you will also need these packages: * Android Emulator - * System Images for Android APIs 23-27 -* The ICS-OpenVpn submodule + * System Images for Android APIs 30 +* ics-openvpn submodule +* tor-android submodule +* bitmaskcore submodule You can install them as follows: @@ -67,15 +60,16 @@ You can install them as follows: Install with: ```bash -sudo apt install default-jdk +sudo apt-get update -qq && \ + apt-get install -y openjdk-11-jdk ``` ### C Libraries <a name="c-libraries"></a> -These are necessary to make sure the program cross-compiles to 32-bit architectures successfully from 64-bit GNU/Linux machines. If you don't have the lib32stdc++, try for example lib32stdc++-8-dev-x32-cross or whatever version is current on your system. +These are necessary to make sure the program cross-compiles openssl, openvpn, tor etc. for Bitmask Android. ``` -sudo apt install make gcc file lib32stdc++ lib32z1 +sudo apt-get -y install make gcc swig file lib32stdc++6 lib32z1 autoconf autogen automake autopoint autotools-dev gettext-base libtool patch pkg-config mesa-utils ``` ### Android SDK <a name="android-sdk"></a> @@ -92,50 +86,7 @@ Once you've got it installed, use the `SDK Manager` tool (Android figure Icon wi #### With Bash <a name="with-bash"></a> -Alternatively (eg: for build machines), you may download and unzip the `android-sdk` bundle from Google as follows (assuming an install location of `/opt/android-sdk-linux`: - -``` -curl -L https://dl.google.com/android/repository/sdk-tools-linux-3859397.zip -o sdk-tools.zip \ - && unzip -q sdk-tools.zip -d /opt/android-sdk-linux \ - && rm -f sdk-tools.zip -``` - -To download the NDK (for cross-compiling and running the C code used in `ics-openvpn`), use: - -``` -curl -L http://dl.google.com/android/repository/android-ndk-r16b-linux-x86_64.zip -o ndk.zip \ - && unzip ndk.zip -d /opt/android-sdk-linux/android-ndk-r16b \ - && rm -rf ndk.zip -``` - -After updating your PATH (see next step), you may now use the `sdkmanager` tool bundled with `android-sdk` to browse and install new sdk packages from Google. - -To browse all available packages, run: - -```shell -sdkmanager --list -``` - -To search for available packages of a certain type (eg: `tools`), run: - -```shell -sdkmanager --list | grep tools -``` - -To install all of the dependencies listed above (targetting SDK versions 23 - 26), run: - -```shell -sdkmanager tools -sdkmanager platform-tools -sdkmanager extras;android;m2repository -sdkmanager extras;google;m2repository -sdkmanager build-tools;27.0.3 -sdkmanager build-tools;25.0.2 -sdkmanager build-tools;23.0.3 -sdkmanager platforms;android-27 -sdkmanager platforms;android-25 -sdkmanager platforms;android-23 -``` +Alternatively (eg: for build machines), you may have a look at our docker build files in [the docker directory](/docker/) #### Updating Your Path <a name="updating-your-path"></a> @@ -143,44 +94,44 @@ Once you've installed Android SDK & NDK packages, you need to modify your PATH s ```shell export ANDROID_HOME=<path/where/you/installed/android/sdk> -export ANDROID_NDK_HOME=$ANDROID_HOME/ndk-bundle +export ANDROID_NDK_HOME=$ANDROID_HOME/ndk/21.4.7075529 export PATH=$ANDROID_NDK_HOME:$PATH export PATH=$ANDROID_HOME/platform-tools:$PATH export PATH=$ANDROID_HOME/tools/bin:$PATH ``` -NOTE: On GNU/Linux machines, Android Studio installs the Android SDK in `~/Android/Sdk/`. Our dockerfile installs it in `/opt/android-sdk-linux`. You can install it wherever you want! Just be sure to remember where so you can add it to your PATH! :) - #### With Docker <a name="with-docker"></a> Geesh! If all that above seems like a lot, it is! -To keep ourselves from messing it up all the time everyone someone new joins the project, we made a Dockerfile that creates the above environment with one line. You can pull the image and run builds from inside it, or consult the [Dockerfile](/docker/android-sdk.dockerfile) itself for requirements that your system might need but be missing. +To keep ourselves from messing it up all the time someone new joins the project, we made a Dockerfile that creates the above environment with one line. You can pull the image and run builds from inside it, or consult the [Dockerfile](/docker/android-sdk.dockerfile) itself for requirements that your system might need but be missing. Assuming you've already [installed docker](https://docs.docker.com/engine/installation/), you can pull the image with: ``` shell -docker pull 0xacab.org:4567/leap/bitmask_android/android-ndk:latest +docker pull registry.0xacab.org/leap/bitmask_android/android-ndk:latest ``` Run the image with: ``` shell -docker run --rm -it 0xacab.org:4567/leap/bitmask_android/android-ndk:latest +docker run --rm -it registry.0xacab.org/leap/bitmask_android/android-ndk:latest ``` More likely than not, you'll want to run the image with the source code mounted. You can do that with: ``` shell cd <path/to/bitmask_android> -docker run --rm -it -v`pwd`:/bitmask_android -t 0xacab.org:4567/leap/bitmask_android/android-ndk:latest +docker run --rm -it -v`pwd`:/bitmask_android -t registry.0xacab.org/leap/bitmask_android/android-ndk:latest ``` ### Submodules <a name="submodules"></a> -We depend on [ics-openvpn](https://github.com/schwabe/ics-openvpn) as an interface to Android's OpenVPN implementation. We include it as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) in our project, which requires that we initialize and update it (and its respective upstream submodule dependencies) in order to compile and run Bitmask Android. - -We do so with: +We depend on several [git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to build Bitmask Android: +* [ics-openvpn](https://github.com/schwabe/ics-openvpn) as an interface to Android's OpenVPN implementation. +* [bitmaskcore](https://0xacab.org/leap/android_libs/bitmaskcore.git) mainly as a library for Pluggable Transports (censorship circumvention functionality), +* [tor-android](https://0xacab.org/leap/android_libs/tor-android.git) to protect the communication to configuration servers from being blocked. +In order to initialize and update these submodules run: ```bash cd <path/to/bitmask_android> @@ -190,14 +141,12 @@ git submodule update --init --recursive ## Compiling <a name="compiling"></a> -You have lots of options for compiling, all of which will output Android-executable `apk` packages to `/bitmask_android/app/build/outputs/apk/`. - ### Just Build It! <a name="just-build-it"></a> If you compile the project for the first time you'll have to compile the dependencies. This can be done with: ``` -./build_deps.sh +./scripts/build_deps.sh ``` This command will create all libs we need for Bitmask. @@ -207,264 +156,36 @@ If you want to to have a clean build of all submodules run ``` before you call `./build_deps.sh`. That script removes all build files and does the git submodule init and update job for you. -You are then welcome to run: - -``` -./gradlew build -``` - -This will compile the code and run the tests, but not output any `apk` packages. As such, it's not all that useful. :) - ### Debug APKs <a name="debug-apks"></a> -To assemble debug packages for running locally or testing in CI, run: - +After having run `./build_deps.sh`, you can assemble debug packages for running locally or testing in CI: ```bash -./build_deps.sh -./gradlew assembleDebug +./gradlew assembleNormalProductionFatDebug ``` -This will output `app-insecure-debug.apk` and `app-production-debug.apk` to `/bitmask_android/app/build/outputs/apk/`. - -### Release APKs <a name="release-apks"></a> - -To assemble release packages, run: - +In order to build a custom branded version of Bitmask you can run: ```bash -./build_deps.sh -./gradlew assembleRelease -``` - -This will output `app-insecure-release.apk` and `app-production-release.apk` to `/bitmask_android/app/build/outputs/apk/`. - -### Signed Release APKs <a name="signed-release-apks"></a> - -If you want to release a signed APK (which you *must* do to publish the app to the Google Play store), you'll have to create a gradle.properties file in the project root with the following structure: - -```properties -storeFileProperty=<fullPath> -storePasswordProperty=<store password without quotation marks> -keyAliasProperty=<key alias without quotation marks> -keyPasswordProperty=<key password without quotation marks> -``` - -### Building In Docker <a name="building-in-docker"></a> - -If you want to make sure the environment you use to build APKs matches exactly the environment that Gitlab will use to build and publish artifacts, you can run any of the above build commands from inside Docker. To assemble a release build this way, run the following commands: - -``` shell -$ cd <path/to/bitmask_android> -$ sudo docker run --rm -it -v `pwd`:/bitmask_android 0xacab.org:4567/leap/bitmask_android/android-ndk:latest -# cd /bitmask_android -# ./cleanProject.sh -# ./build_deps.sh -# ./gradlew assembleRelease -``` - -## Running Tests <a name="running-tests"></a> - -To run the automated tests: - - 1. Run an emulator - 2. Unlock Android - 3. Issue the command ./gradlew connectedCheck - 4. Pay attention and check the "Trust this app" checkbox, if you don't do so tests won't run. - - -## Debugging in an Emulator <a name="debugging-in-an-emulator"></a> - -You can run the app in an emulator running any version of Android and simulating (almost) any device. To run it you'll have to create an emulator, run the emulator, and then load an assembled APK of the app onto the emulator. (You can then use all sort of nifty tools in [Anroid Debug Bridge](https://developer.android.com/studio/command-line/adb.html) to tail the logs and debug the app.) - -Assuming you've already tackled (or don't need to tackle) the [Debian Gotchas](#debian-gotchas) listed below, you can do that using either Android Studio or a bash shell as follows: - -### From Android Studio <a name="from-android-studio"></a> - -To create an emulator: - -* Select `Tools/Android/AVD Manager` from the application menu -* Follow the instructions - -To run a pre-existing emulator: - -* Open the `AVD Manager` as above -* Press the "Play" button next to the emulator you want to run - -To run the app: - -* Ensure you have an emulator running -* Open the left-hand project pane (Meta-1 or Cmd-1, depending on your keybindings) -* Navigate to `bitmask_android/app/src/main/java/se/leap/bitmaskclient/StartActivity` -* Right-click over the `StartActivity` filename and click the `Run 'StartActivity'` option (or use Shift-Ctl-F10 or Shift-Ctl-R, depending on your keybindings) -* After you have done this once, you should be able to simply select `StartActivity` from the dropdown menu next to the big green arrow in the toolbar, then click the green arrow to run the app. - -### From the Shell <a name="from-the-shell"></a> - -To list the available avd images for creating an emulator: - -``` shell -avdmanager list -``` - -To create an emulator: - -``` shell -avdmanager create avd -``` - -To list the emulators you have already created: - -``` shell -avdmanager list avd +./gradlew assembleCustomProductionFatDebug ``` -To run a pre-existing emulator called `Nexus_5_API_25`: +If everything went fine, you will find the debug apks in `/bitmask_android/app/build/outputs/apk/`. -``` shell -emulator @Nexus_5_API_15 -``` - -Verify the device is running with: - -``` shell -adb devices -``` - -You should see something like: - -``` shell -List of devices attached -emulator-5554 device -``` -Install APK with: - -``` shell -abd install <path/to/your>.apk -``` - -Uninstall with: - -``` shell -abd uninstall se.leap.bitmaskclient -``` -Install with option to reinstall: - -``` shell -abd install -r <path/to/your/apk> -``` - -### Debian Gotchas <a name="debian-gotchas"></a> - -If you are running Debian on a 64-bit machine, your emulator will likely not work out of the gate. Test to see if this is the case by: - -* first creating an emulator in Android Studio (with name, eg, `Nexus_5_API_25`) -* then running: - ```shell - cd ~/ - emulator @<name_of_your_emulator> - ``` -If you can launch an emulator, HUZZAH! If not, you likely have one of 3 problems: - -#### 1. Virtualization Not Enabled <a name="virtualization-not-enabled"></a> - -Boo! Try turning it on. The second half of [this article](https://docs.fedoraproject.org/en-US/Fedora/13/html/Virtualization_Guide/sect-Virtualization-Troubleshooting-Enabling_Intel_VT_and_AMD_V_virtualization_hardware_extensions_in_BIOS.html) is a decent enough guide. - -#### 2. Unpatched Filepaths Bug <a name="unpatched-filepaths-bug"></a> - -**Symptoms:** If you have this bug, you will see something like the following when you try to spin up an emulator: - -``` shell -[140500439390016]:ERROR:./android/qt/qt_setup.cpp:28:Qt library not found at ../emulator/lib64/qt/lib -Could not launch '../emulator/qemu/linux-x86_64/qemu-system-i386': No such file or directory -``` -As [documented here](https://stackoverflow.com/questions/42554337/cannot-launch-avd-in-emulatorqt-library-not-found), there is a standing bug in the version of `emulator` packaged for emulator that assumes it always runs from within the `$ANDROID_HOME/emulator` directory, and can thus safely use relative filepaths, when in fact this is almost never the case. (Cool bug!) - -**Fixes:** - -You have a couple options. The second is more robust: - -1. Always run emulator from within its own directory (clunky!): - -``` shell - cd "$(dirname "$(which emulator)")" - emulator <name_of_your_emulator> -``` - -2. Insert a line in your `~/.bashrc` to automatically navigate to the correct directory (and back) whenever you invoke `emulator`: - - ```shell -function emulator { pushd `pwd`; cd "$(dirname "$(which emulator)")" && ./emulator "$@"; popd;} -``` - -#### 3. Outdated GL Libraries <a name="outdated-gl-libraries"></a> - -**Symptoms:** If you have this bug, you will see something like the following: - -``` shell -libGL error: failed to load driver: swrast -X Error of failed request: BadValue (integer parameter out of range for operation) -# redacted incredibly long stack trace -``` - -As documented [here](http://stackoverflow.com/questions/36554322/cannot-start-emulator-in-android-studio-2-0), the current emulator package ships without outdated versions of LibGL libraries. To work around this: - -1. Install modern GL libriaries with: - -``` shell -sudo apt-get install mesa-utils -``` - -2. Ensure that `emulator` always uses the correct libraries by either: - - a. always calling `emulator` with the `-use-system-libs` flag, like so: - - ``` shell - emulator -use-system-libs -avd Nexus_5_API_25 - ``` - b. adding the following line to your ~/.bashrc or ~/.bash_profile: - - ```shell - export ANDROID_EMULATOR_USE_SYSTEM_LIBS=1 - ``` - -**Special Android Studio Debian Bonus Gotcha:** - -Assuming you have made all the above fixes (great job!), to be able to launch emulators from Android Studio, you must either: - -1. Use the environment variable solution above (option a), then *always* launch Android Studio from a bash shell with: - -``` shell -studio -``` - -This means never using the desktop launcher. :( - -2. If you want to use the desktop launcher: - - * You must *always* launch emulators from the terminal. :( - * But: you can quickly access a terminal inside of Android Studio with `OPTION-F12` +### Release APKs <a name="release-apks"></a> -## Updating Submodules <a name="updating-submodules"></a> +To build releases, a script comes to the rescue: [prepareForDistribution.sh](/scripts/prepareForDistribution.sh) ` -If you need to refresh of our upstream dependency on ics-openvpn, you may do so with: +Before you can actually build a release make sure you have setup a keystore with your Android signing key. Additionally you can sign your software with your PGP key using this script. -``` shell -cd <path/to/bitmask_android> -./gradlew updateIcsOpenVpn +If you want to build and sign apks and aab bundles for the current commit, run: +```bash + ./scripts/prepareForDistribution.sh build sign -ks ~/path/to/bitmask-android.keystore -ka <yourKeystoreKeyAlias> ``` -Alternately: +Please check `./prepareFordistribution.sh -h` for all options! -```shell -cd <path/to/bitmask_android> -cd ics-openvpn -git remote add upstream https://github.com/schwabe/ics-openvpn.git -git pull --rebase upstream master -``` -A bunch of conflicts may arise. The guidelines are: +## Supported Versions <a name="supported-versions"></a> - 1. Methods in HEAD (upstream) completely removed from Bitmask should be removed again (e.g. askPW) - 2. Sometimes, Dashboard.class is in Bitmask while in ics-openvpn it is replaced by MainActivity.class and other classes. Keep removing them to keep Dashboard.class in there. - 3. Some resources files are stripped from several entries. Remove them if possible (check the code we compile is not using anything else new). +Currently API 16 (Android 4.1) - API 30 (Android 11) are officially supported. Keep backwards compatibility in mind if you plan to contribute new features. ## Acknowledgments <a name="acknowledgments"></a> @@ -477,6 +198,6 @@ Please file bug tickets on our main [development platform](https://0xacab.org/le Please fork this repository and contribute back using [pull requests](https://0xacab.org/leap/bitmask_android/merge_requests). -Our preferred method for receiving translations is our [Transifex project](https://www.transifex.com/projects/p/bitmask). +Our preferred method for receiving translations is our [Transifex project](https://www.transifex.com/otf/bitmask). Localization Lab helps us with on-boarding volunteers. If you are new to translations and Transifex we've got a [short how-to](https://wiki.localizationlab.org/index.php/Bitmask). Any contributions, large or small, major features, bug fixes, additional language translations, unit/integration tests are welcomed and appreciated but will be thoroughly reviewed and discussed. |