How to Encrypt Java Class Files (.dex) in Android Apps

Last updated March 7, 2024 by Appdome

Learn to Encrypt Dex Files in Android apps, in mobile CI/CD with a Data-Driven DevSecOps™ build system.

What is DEX File Encryption?

In Android, compiled Java/Kotlin code resides in classes.dex files (see structure of Android applications). The common tools to reverse engineer DEX files are disassemblers such as baksmali and dex2jar and decompilers such as jadx and jdgui. Appdome’s DEX File Encryption is a security feature uses Appdome’s APPCode Packer, the industry’s first no-code Android App Packer, to hide and encrypt all Java code of an Android app when the app is built by using Appdome. Using code packing with Appdome APPCode Packer makes the disasembling tools ineffective and even unusable. For details see White Hat Android Packer from Appdome.

Why Encrypt DEX Files (Java Classes) in Android apps?

Appdome encrypts all DEX files not needed for app initialization, making it impossible for disassemblers to find the original code. At run-time, Appdome’s code will decrypt the encrypted DEX files and allow the app to continue working as usual.

This obfuscation technique provides the following benefits:

Trying to use offline reversing techniques on the application will fail as most classes will not be found in the APK or in the AAB.
Decryption overhead is only incurred during the app’s first run, and even then has minimal impact.
Since the DEX files are encrypted, they are protected by Appdome’s Anti-Tampering.
In addition, any attempt to force this information out of the application using run-time methods will be thwarted by Appdome’s Anti-Debugging and other features in ONEShield.

Prerequisites for Using Dex File Encryption:

To use Appdome’s mobile app security build system to Encrypt Dex Files , you’ll need:

Appdome account (create a free Appdome account here)
A license for Dex File Encryption
Mobile App (.apk or .aab for Android)
Signing Credentials (see Signing Secure Android apps and Signing Secure iOS apps)

Encrypt Dex Files on Android apps using Appdome

On Appdome, follow these 3 simple steps to create self-defending Android Apps that Encrypt Dex Files without an SDK or gateway:

Upload the Mobile App to Appdome.
1. Upload an app to Appdome’s Mobile App Security Build System
2. Upload Method: Appdome Console or DEV-API
3. Android Formats: .apk or .aab
4. Dex File Encryption Compatible With: Java, JS, C++, C#, Kotlin, Flutter, React Native, Unity, Xamarin, Cordova and other Android apps
Build the feature: Dex File Encryption.
1. Building Dex File Encryption by using Appdome’s DEV-API:
  1. Create and name the Fusion Set (security template) that will contain the Dex File Encryption feature as shown below:
  2. Follow the steps in Sections 2.2.1-2.2.2 of this article, Building the Dex File Encryption feature via Appdome Console, to add the Dex File Encryption feature to this Fusion Set.
  3. Open the Fusion Set Detail Summary by clicking the “...” symbol on the far-right corner of the Fusion Set. Copy the Fusion Set ID from the Fusion Set Detail Summary (as shown below):”
    
    Figure 2: Fusion Set Detail Summary
    Note: Annotating the Fusion Set to identify the protection(s) selected is optional only (not mandatory).
  4. Follow the instructions below to use the Fusion Set ID inside any standard mobile DevOps or CI/CD toolkit like Bitrise, App Center, Jenkins, Travis, Team City, Circle CI or other system:
    
    Build an API for the app – for instructions, see the tasks under Appdome API Reference Guide
    
    Look for sample APIs in Appdome’s GitHub Repository
2. Building the Dex File Encryption feature via Appdome Console
  
  To build the Dex File Encryption protection by using Appdome Console, follow the instructions below.
  1. Where: Inside the Appdome Console, go to Build > Security Tab > TOTALData™ Encryption section.
    Like all other options in ONEShield™, Dex File Encryption is turned on by default, as shown below:
    Figure 3: Dex File Encryption option
    Note: The App Compromise Notification contains an easy to follow default remediation path for the mobile app end user. You can customize this message as required to achieve brand specific support, workflow or other messaging.
  2. How: Toggle (turn ON) Dex File Encryption, as shown below.
    If needed, Customize the Threat Notification to be displayed to the mobile end-user in a standard OS dialog notification when Appdome Encrypts Dex Files.
    
    Figure 3: Encrypt Dex Files option
    Note: The App Compromise Notification contains an easy to follow default remediation path for the mobile app end user. You can customize this message as required to achieve brand specific support, workflow or other messaging.
  3. When you select the Dex File Encryption you'll notice that your Fusion Set you created in step 2.1.1 now bears the icon of the protection category that contains Dex File Encryption
    
    Figure 4: Fusion Set that displays the newly added Dex File Encryption protection
  4. Optional Configuration with Dex File Encryption:
    Favor Loading Time
    Automatically detect and optimize obfuscation of publicly available components in order to preserve application loading time.
  5. Click Build My App at the bottom of the Build Workflow (shown in Figure 3).
Congratulations! The Dex File Encryption protection is now added to the mobile app
Certify the Dex File Encryption feature in Android Apps.

After building Dex File Encryption, Appdome generates a Certified Secure™ certificate to guarantee that the Dex File Encryption protection has been added and is protecting the app. To verify that the Dex File Encryption protection has been added to the mobile app, locate the protection in the Certified Secure™ certificate as shown below:

Figure 5: Certified Secure™ certificate

Each Certified Secure™ certificate provides DevOps and DevSecOps organizations the entire workflow summary, audit trail of each build, and proof of protection that Dex File Encryption has been added to each Android app. Certified Secure provides instant and in-line DevSecOps compliance certification that Dex File Encryption and other mobile app security features are in each build of the mobile app

Using Threat-Events™ for Dex Files Intelligence and Control in Android Apps

Appdome Threat-Events™ provides consumable in-app mobile app attack intelligence and defense control when Dex Files is detected. To consume and use Threat-Events™ for Dex Files in Android Apps, use registerReceiver in the Application OnCreate, and the code samples for Threat-Events™ for Dex Files shown below.

The specifications and options for Threat-Events™ for Dex Files are:

Threat-Event™ Elements	Encrypt Dex Files Method Detail
Appdome Feature Name	Dex File Encryption
Threat-Event Mode
OFF, IN-APP DEFENSE	Appdome detects, defends and notifies user (standard OS dialog) using customizable messaging.
ON, IN-APP DETECTION	Appdome detects the attack or threat and passes the event in a standard format to the app for processing (app chooses how and when to enforce).
ON, IN-APP DEFENSE	Uses Appdome Enforce mode for any attack or threat and passes the event in a standard format to the app for processing (gather intel on attacks and threats without losing any protection).
Certified Secure™ Threat Event Check	x
Visible in ThreatScope™	x
Developer Parameters for Encrypting Dex Files Threat-Event™
Threat-Event NAME
Threat-Event DATA	reasonData
Threat-Event CODE	reasonCode
Threat-Event REF
Threat-Event SCORE
currentThreatEventScore	Current Threat-Event score
threatEventsScore	Total Threat-events score

Threat-Event Context Keys
message	Message displayed for the user on event
externalID	The external ID of the event which can be listened via Threat Events
osVersion	OS version of the current device
deviceModel	Current device model
deviceManufacturer	The manufacturer of the current device
fusedAppToken	The task ID of the Appdome fusion of the currently running app
kernelInfo	Info about the kernel: system name, node name, release, version and machine.
carrierPlmn	PLMN of the device
deviceID	Current device ID
reasonCode	Reason code of the occured event
buildDate	Appdome fusion date of the current application
devicePlatform	OS name of the current device
carrierName	Carrier name of the current device
updatedOSVersion	Is the OS version up to date
deviceBrand	Brand of the device
deviceBoard	Board of the device
buildUser	Build user
buildHost	Build host
sdkVersion	Sdk version
timeZone	Time zone
deviceFaceDown	Is the device face down
locationLong	Location longitude conditioned by location permission
locationLat	Location latitude conditioned by location permission
locationState	Location state conditioned by location permission
wifiSsid	Wifi SSID
wifiSsidPermissionStatus	Wifi SSID permission status

With Threat-Events™ enabled (turned ON), Android developers can get detailed attack intelligence and granular defense control in Android applications and create amazing user experiences for all mobile end users when Dex Files is detected.

The following is a code sample for native Android apps, which uses all values in the specification above for Dex File Encryption:

                    IntentFilter intentFilter = new IntentFilter();
                    intentFilter.addAction("");
                    BroadcastReceiver threatEventReceiver = new BroadcastReceiver() {
                        @Override
                        public void onReceive(Context context, Intent intent) {
                            String message = intent.getStringExtra("message"); // Message shown to the user
                            String reasonData = intent.getStringExtra("reasonData"); // Threat detection cause
                            String reasonCode = intent.getStringExtra("reasonCode"); // Event reason code
                            String currentThreatEventScore = intent.getStringExtra("currentThreatEventScore"); // Current threat event score
                            String threatEventsScore = intent.getStringExtra("threatEventsScore"); // Total threat events score
                            String variable = intent.getStringExtra(""); // Any other event specific context key

                            // Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
                        }
                    };

                    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
                        registerReceiver(threatEventReceiver, intentFilter, Context.RECEIVER_NOT_EXPORTED);
                    } else {
                        registerReceiver(threatEventReceiver, intentFilter);
                    }

Java
x
 
IntentFilter intentFilter = new IntentFilter();
intentFilter.addAction("");
BroadcastReceiver threatEventReceiver = new BroadcastReceiver() {
    @Override
    public void onReceive(Context context, Intent intent) {
        String message = intent.getStringExtra("message"); // Message shown to the user
        String reasonData = intent.getStringExtra("reasonData"); // Threat detection cause
        String reasonCode = intent.getStringExtra("reasonCode"); // Event reason code
        String currentThreatEventScore = intent.getStringExtra("currentThreatEventScore"); // Current threat event score
        String threatEventsScore = intent.getStringExtra("threatEventsScore"); // Total threat events score
        String variable = intent.getStringExtra("<Context Key>"); // Any other event specific context key
​
        // Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
    }
};
​
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
    registerReceiver(threatEventReceiver, intentFilter, Context.RECEIVER_NOT_EXPORTED);
} else {
    registerReceiver(threatEventReceiver, intentFilter);
}

                    val intentFilter = IntentFilter()
                    intentFilter.addAction("")
                    val threatEventReceiver = object : BroadcastReceiver() {
                        override fun onReceive(context: Context?, intent: Intent?) {
                            var message = intent?.getStringExtra("message") // Message shown to the user
                            var reasonData = intent?.getStringExtra("reasonData") // Threat detection cause
                            var reasonCode = intent?.getStringExtra("reasonCode") // Event reason code
                            var currentThreatEventScore = intent?.getStringExtra("currentThreatEventScore") // Current threat event score
                            var threatEventsScore = intent?.getStringExtra("threatEventsScore") // Total threat events score
                            var variable = intent?.getStringExtra("") // Any other event specific context key

                            // Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
                        }
                    }

                    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
                        registerReceiver(threatEventReceiver, intentFilter, Context.RECEIVER_NOT_EXPORTED)
                    } else {
                        registerReceiver(threatEventReceiver, intentFilter)
                    }

                         
                        Kotlin
                    
x
 
val intentFilter = IntentFilter()
intentFilter.addAction("")
val threatEventReceiver = object : BroadcastReceiver() {
    override fun onReceive(context: Context?, intent: Intent?) {
        var message = intent?.getStringExtra("message") // Message shown to the user
        var reasonData = intent?.getStringExtra("reasonData") // Threat detection cause
        var reasonCode = intent?.getStringExtra("reasonCode") // Event reason code
        var currentThreatEventScore = intent?.getStringExtra("currentThreatEventScore") // Current threat event score
        var threatEventsScore = intent?.getStringExtra("threatEventsScore") // Total threat events score
        var variable = intent?.getStringExtra("<Context Key>") // Any other event specific context key
​
        // Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
    }
}
​
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
    registerReceiver(threatEventReceiver, intentFilter, Context.RECEIVER_NOT_EXPORTED)
} else {
    registerReceiver(threatEventReceiver, intentFilter)
}

const { ADDevEvents } = NativeModules;
                const aDDevEvents = new NativeEventEmitter(ADDevEvents);

                function registerToDevEvent(action, callback) {
                    NativeModules.ADDevEvents.registerForDevEvent(action);
                    aDDevEvents.addListener(action, callback);
                }

                export function registerToAllEvents() {
                    registerToDevEvent(
                        "",
                        (userinfo) => Alert.alert(JSON.stringify(userinfo))

                        var message = userinfo["message"] // Message shown to the user
                        var reasonData = userinfo["reasonData"] // Threat detection cause
                        var reasonCode = userinfo["reasonCode"] // Event reason code
                        var currentThreatEventScore = userinfo["currentThreatEventScore"] // Current threat event score
                        var threatEventsScore = userinfo["threatEventsScore"] // Total threat events score
                        var variable = userinfo["<Context Key>"] // Any other event specific context key

                        // Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
                    );
                }

                     
                    React Native
                
​x
 
const { ADDevEvents } = NativeModules;
const aDDevEvents = new NativeEventEmitter(ADDevEvents);
​
function registerToDevEvent(action, callback) {
    NativeModules.ADDevEvents.registerForDevEvent(action);
    aDDevEvents.addListener(action, callback);
}
​
export function registerToAllEvents() {
    registerToDevEvent(
        "",
        (userinfo) => Alert.alert(JSON.stringify(userinfo))
​
        var message = userinfo["message"] // Message shown to the user
        var reasonData = userinfo["reasonData"] // Threat detection cause
        var reasonCode = userinfo["reasonCode"] // Event reason code
        var currentThreatEventScore = userinfo["currentThreatEventScore"] // Current threat event score
        var threatEventsScore = userinfo["threatEventsScore"] // Total threat events score
        var variable = userinfo["<Context Key>"] // Any other event specific context key
​
        // Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
    );
}
​

RegisterReceiver(new ThreatEventReceiver(), new IntentFilter(""));
                class ThreatEventReceiver : BroadcastReceiver
                {
                public override void OnReceive(Context context, Intent intent)
                {
                    String message = intent.GetStringExtra("message"); // Message shown to the user
                    String reasonData = intent.GetStringExtra("reasonData"); // Threat detection cause
                    String reasonCode = intent.GetStringExtra("reasonCode"); // Event reason code
                    String currentThreatEventScore = intent.GetStringExtra("currentThreatEventScore"); // Current threat event score
                    String threatEventsScore = intent.GetStringExtra("threatEventsScore"); // Total threat events score
                    String variable = intent.GetStringExtra("<Context Key>"); // Any other event specific context key

                    // Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
                }
                }

                    
                    Xamarin/MAUI Android
                
​x
 
RegisterReceiver(new ThreatEventReceiver(), new IntentFilter(""));
​
class ThreatEventReceiver : BroadcastReceiver
{
  public override void OnReceive(Context context, Intent intent)
  {
    String message = intent.GetStringExtra("message"); // Message shown to the user
    String reasonData = intent.GetStringExtra("reasonData"); // Threat detection cause
    String reasonCode = intent.GetStringExtra("reasonCode"); // Event reason code
    String currentThreatEventScore = intent.GetStringExtra("currentThreatEventScore"); // Current threat event score
    String threatEventsScore = intent.GetStringExtra("threatEventsScore"); // Total threat events score
    String variable = intent.GetStringExtra("<Context Key>"); // Any other event specific context key
​
    // Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
  }
}

                NSNotificationCenter.DefaultCenter.AddObserver(
                    (NSString)"JailbrokenDevice", // Threat-Event Identifier
                    delegate (NSNotification notification)
                    {
                        var message = notification.UserInfo.ObjectForKey("message"); // Message shown to the user
                        var reasonData = notification.UserInfo.ObjectForKey("reasonData"); // Threat detection cause
                        var reasonCode = notification.UserInfo.ObjectForKey("reasonCode"); // Event reason code
                        var currentThreatEventScore = notification.UserInfo.ObjectForKey("currentThreatEventScore"); // Current threat event score
                        var threatEventsScore = notification.UserInfo.ObjectForKey("threatEventsScore"); // Total threat events score
                        var variable = notification.UserInfo.ObjectForKey(""); // Any other event specific context key
                        // Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
                    });

                    
                    Xamarin/MAUI iOS
                
 
NSNotificationCenter.DefaultCenter.AddObserver(
  (NSString)"", // Threat-Event Identifier
  delegate (NSNotification notification)
  {
    var message = notification.UserInfo.ObjectForKey("message"); // Message shown to the user
    var reasonData = notification.UserInfo.ObjectForKey("reasonData"); // Threat detection cause
    var reasonCode = notification.UserInfo.ObjectForKey("reasonCode"); // Event reason code
    var currentThreatEventScore = notification.UserInfo.ObjectForKey("currentThreatEventScore"); // Current threat event score
    var threatEventsScore = notification.UserInfo.ObjectForKey("threatEventsScore"); // Total threat events score
    var variable = notification.UserInfo.ObjectForKey("<Context Keys>"); // Any other event specific context key
    // Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
  });

window.broadcaster.addEventListener("", function(userInfo) {
        var message = userInfo.message // Message shown to the user
        var reasonData = userInfo.reasonData // Threat detection cause
        var reasonCode = userInfo.reasonCode // Event reason code
        var currentThreatEventScore = userInfo.currentThreatEventScore // Current threat event score
        var threatEventsScore = userInfo.threatEventsScore // Total threat events score
        var variable = userInfo.<Context Key> // Any other event specific context key

        // Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
            });

                    
                    Cordova
                
​x
 
window.broadcaster.addEventListener("", function(userInfo) {
        var message = userInfo.message // Message shown to the user
        var reasonData = userInfo.reasonData // Threat detection cause
        var reasonCode = userInfo.reasonCode // Event reason code
        var currentThreatEventScore = userInfo.currentThreatEventScore // Current threat event score
        var threatEventsScore = userInfo.threatEventsScore // Total threat events score
        var variable = userInfo.<Context Key> // Any other event specific context key
​
        // Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
});

                import 'dart:async';
                import 'package:flutter/material.dart';
                import 'package:flutter/services.dart';

                class PlatformChannel extends StatefulWidget {
                  const PlatformChannel({super.key});

                  @override
                  State<PlatformChannel> createState() => _PlatformChannelState();
                }

                class _PlatformChannelState extends State<PlatformChannel> {
                  static const String _eventChannelName = ""; // Replace with your EventChannel name
                  static const EventChannel _eventChannel = EventChannel(_eventChannelName);

                  @override
                  void initState() {
                    super.initState();
                    _eventChannel.receiveBroadcastStream().listen(_onEvent, onError: _onError);
                  }

                  void _onEvent(Object? event) {
                    setState(() {
                      // Adapt this section based on your specific event data structure
                      var eventData = event as Map;

                      // Example: Accessing 'externalID' field from the event
                      var externalID = eventData['externalID'];

                      // Customize the rest of the fields based on your event structure
                      String message = eventData['message']; // Message shown to the user
                      String reasonData = eventData['reasonData']; // Threat detection cause
                      String reasonCode = eventData['reasonCode']; // Event reason code
                      String currentThreatEventScore = eventData['currentThreatEventScore']; // Current threat event score
                      String threatEventsScore = eventData['threatEventsScore']; // Total threat events score

                      // Any other event specific context key
                      String variable = eventData['<Context Key>'];
                    });
                  }

                  // Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
                }

                    
                    Flutter
                
xxxxxxxxxx
 
import 'dart:async';
​
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
​
class PlatformChannel extends StatefulWidget {
  const PlatformChannel({super.key});
​
  @override
  State<PlatformChannel> createState() => _PlatformChannelState();
}
​
class _PlatformChannelState extends State<PlatformChannel> {
  static const String _eventChannelName = ''; // Replace with your EventChannel name
  static const EventChannel _eventChannel = EventChannel(_eventChannelName);
​
  @override
  void initState() {
    super.initState();
    _eventChannel.receiveBroadcastStream().listen(_onEvent, onError: _onError);
  }
​
  void _onEvent(Object? event) {
    setState(() {
      // Adapt this section based on your specific event data structure
      var eventData = event as Map;
​
      // Example: Accessing 'externalID' field from the event
      var externalID = eventData['externalID'];
​
      // Customize the rest of the fields based on your event structure
      String message = eventData['message']; // Message shown to the user
      String reasonData = eventData['reasonData']; // Threat detection cause
      String reasonCode = eventData['reasonCode']; // Event reason code
      String currentThreatEventScore = eventData['currentThreatEventScore']; // Current threat event score
      String threatEventsScore = eventData['threatEventsScore']; // Total threat events score
​
      // Any other event specific context key
      String variable = eventData['<Context Key>'];
    });
  }
​
  // Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
}

Using Appdome, there are no development or coding prerequisites to build secured Android Apps by using Dex File Encryption. There is no SDK and no library to code or implement in the app and no gateway to deploy in your network. All protections are built into each app and the resulting app is self-defending and self-protecting.

Releasing and Publishing Mobile Apps with Dex File Encryption

After successfully securing your app by using Appdome, there are several available options to complete your project, depending on your app lifecycle or workflow. These include:

Customizing, Configuring & Branding Secure Mobile Apps
Deploying/Publishing Secure mobile apps to Public or Private app stores
Releasing Secured Android & iOS Apps built on Appdome.

If you have any questions, please send them our way at support.appdome.com or via the chat window on the Appdome platform.

Thank you!

Thanks for visiting Appdome! Our mission is to secure every app on the planet by making mobile app security easy. We hope we’re living up to the mission with your project.

How to Encrypt Java Class Files (.dex) in Android Apps

What is DEX File Encryption?

Why Encrypt DEX Files (Java Classes) in Android apps?

Prerequisites for Using Dex File Encryption:

Encrypt Dex Files on Android apps using Appdome

Upload the Mobile App to Appdome.

Upload an app to Appdome’s Mobile App Security Build System

Build the feature: Dex File Encryption.

Building Dex File Encryption by using Appdome’s DEV-API:

Building the Dex File Encryption feature via Appdome Console

Certify the Dex File Encryption feature in Android Apps.

Using Threat-Events™ for Dex Files Intelligence and Control in Android Apps

Thank you!

How to Comply with the OWASP MASVS Standard

Flipping the Economics of Cybersecurity with “Policy as Code”

AI Has Democratized Spear Phishing Attacks, Now What?

Democratizing Mobile Attack and Threat Data to Defeat Fraud