Adding OpenSSL Support for Android

The Qt installation package comes with OpenSSL support but the OpenSSL libraries are not part of the package due to legal restrictions in some countries. If your application depends on OpenSSL, consider packaging the SSL libraries with your Application Package (APK) as the target device may or may not have them. You can use the QSslSocket::supportsSsl() static function to check for SSL support on the target.

The following instructions guide you to build and add the OpenSSL libraries to the APK:

  1. Download the latest OpenSSL 1.1.x sources from http://www.openssl.org/source.
  2. Extract the sources to a folder and navigate to that folder using the CLI.

    Note: If your development platform is Windows, you need msys with perl v5.14 or later to build OpenSSL.

  3. Add android llvm toolchain to your path:
    export PATH="<android_ndk_path>/toolchains/llvm/prebuilt/<host>/bin":$PATH
  4. Configure the OpenSSL sources to build for Android using the following command:
    ./Configure shared android-<arch> -D__ANDROID_API__=21

    Note: You must consider enabling/disabling the SSL features based on the legal restrictions in the region where your application is available. See the SSL configure options for details about the configurable features.

  5. Run make SHLIB_VERSION_NUMBER= SHLIB_EXT=_1_1.so build_libs to build libcrypto and libssl shared libraries that are not versioned, but with a _1_1 suffix. If you want to use a different suffix, then you must set the ANDROID_OPENSSL_SUFFIX environment variable before you access the Qt Network API. Without a suffix, Android 5 (API 21) will load the system libraries libcrypto.so and libssl.so, which are OpenSSL 1.0, rather than your libraries.

    Note: Android does not load versioned libraries.

  6. Open your Qt project using Qt Creator and update the "Build Android APK" settings to add libcrypto and libssl as additional libraries for your project.
  7. Run your application to see it running on the device.

Note: here https://github.com/KDAB/android_openssl you can find a script which can be used to compile openssl for all android abis and also latest prebuilt libs.

Qt Creator builds your application and creates an application package (APK) with the OpenSSL libraries bundled in it. Once the APK is ready, it uses adb to deploy the APK on the target you chose and launch the application.

© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.