How to Enable Restore from Backup on Android & iOS Apps

Last updated November 30, 2023 by Appdome

This Knowledge Base article describes how to use Appdome’s AI/ML in your CI/CD pipeline to continuously deliver plugins that Add a common encryption key that is shared by all devices in Mobile apps.

What is the Restore from Backup Option?

When the option Enable Restore from Backup is toogled on, a common encryption key is shared by all devices. This option allows accessing encrypted data if the device is migrated or restored. Appdome has several encryption features, and each feature requires an encryption key in order to encrypt and decrypt your data.

Enabling the option Enable Restore from Backup sets a shared encryption key to all devices, making the access to encrypted data independent from a specific device. When the encryption key is shared by all devices, the access to the encrypted data is available even after a device is restored or migrated. If this option is disabled, each encryption feature will use a randomly generated encryption key for each device and data access will be lost if the device ID will change.

Why Should I Enable Restore from Backup?

Using the Enable Restore from Backup feature can benefit developers who want their encrypted data to be handled by Appdome during app migration or device restorations. Rather than handling the task of writing certain files to the file system again, this feature enables using the same encryption key in order to decrypt the previous files.

Prerequisites for Using Appdome's Enable Restore from Backup Plugins:

To use Appdome’s mobile app security build system to Add a common encryption key that is shared by all devices , you’ll need:

How to Implement Add a common encryption key that is shared by all devices in Mobile Apps Using Appdome

On Appdome, follow these 3 simple steps to create self-defending Mobile Apps that Add a common encryption key that is shared by all devices without an SDK or gateway:

  1. Designate the Mobile App to be protected.

    1. Upload an app via the Appdome Mobile Defense platform GUI or via Appdome’s DEV-API or CI/CD Plugins.

    2. Mobile App Formats: .ipa for iOS, or .apk or .aab for Android
    3. Enable Restore from Backup is compatible with: Obj-C, Java, JS, C#, C++, Swift, Kotlin, Flutter, React Native, Unity, Xamarin, and more.
  2. Select the defense: Enable Restore from Backup.

      1. Create and name the Fusion Set (security template) that will contain the Enable Restore from Backup feature as shown below:
        fusion set that contains Enable Restore from Backup

        Figure 1: Fusion Set that will contain the Enable Restore from Backup feature

      2. Follow the steps in Sections 2.2-2.2.2 of this article to add the Enable Restore from Backup feature to your Fusion Set via the Appdome Console.

      3. When you select the Enable Restore from Backup you'll notice that the Fusion Set you created in step 2.1 now bears the icon of the protection category that contains Enable Restore from Backup.

        Fusion Set applied Enable Restore from Backup

        Figure 2: Fusion Set that displays the newly added Enable Restore from Backup protection
        Note: Annotating the Fusion Set to identify the protection(s) selected is optional only (not mandatory).

      4. 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): fusion Set Detail Summary image

        Figure 3: Fusion Set Detail Summary

      5. Follow the instructions below to use the Fusion Set ID inside any standard mobile DevOps or CI/CD toolkit like Bitrise, Jenkins, Travis, Team City, Circle CI or other system:
        1. Refer to the Appdome API Reference Guide for API building instructions.
        2. Look for sample APIs in Appdome’s GitHub Repository.
    1. Add the Enable Restore from Backup feature to your security template.

      1. Navigate to Build > Security tab > TOTALData™ Encryption section in the Appdome Console.
      2. Toggle On > Enable Restore from Backup.
        Enable Restore from Backup option

        Figure 4: Selecting Add a common encryption key that is shared by all devices

    2. Initiate the build command either by clicking Build My App at the bottom of the Build Workflow (shown in Figure 4) or via your CI/CD as described in Section 2.1.4.
    Congratulations!  The Enable Restore from Backup protection is now added to the mobile app
  3. Certify the Enable Restore from Backup feature in Mobile Apps

    After building Enable Restore from Backup, Appdome generates a Certified Secure™ certificate to guarantee that the Enable Restore from Backup protection has been added and is protecting the app. To verify that the Enable Restore from Backup protection has been added to the mobile app, locate the protection in the Certified Secure™ certificate as shown below: Enable Restore from Backup shown in Certificate secure

    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 Enable Restore from Backup has been added to each Mobile app. Certified Secure provides instant and in-line DevSecOps compliance certification that Enable Restore from Backup and other mobile app security features are in each build of the mobile app.

Using Threat-Events™ for a common encryption key that is shared by all devices Intelligence and Control in Mobile Apps

Appdome Threat-Events™ provides consumable in-app mobile app attack intelligence and defense control when a common encryption key that is shared by all devices is detected. To consume and use Threat-Events™ for a common encryption key that is shared by all devices in Mobile Apps, use AddObserverForName in Notification Center, and the code samples for Threat-Events™ for a common encryption key that is shared by all devices shown below.

The specifications and options for Threat-Events™ for a common encryption key that is shared by all devices are:

Threat-Event™ Elements Add a common encryption key that is shared by all devices Method Detail
Appdome Feature Name Enable Restore from Backup
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 Adding a common encryption key that is shared by all devices 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
failSafeEnforce Timed enforcement against the identified threat
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. Only available for Android devices.
deviceID Current device ID
reasonCode Reason code of the occurred event
buildDate Appdome fusion date of the current application
devicePlatform OS name of the current device
carrierName Carrier name of the current device. Only available for Android.
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
threatCode The last six characters of the threat code specify the OS, allowing the Threat Resolution Center to address the attack on the affected device.

With Threat-Events™ enabled (turned ON), Mobile developers can get detailed attack intelligence and granular defense control in Mobile applications and create amazing user experiences for all mobile end users when a common encryption key that is shared by all devices is detected.


The following is a code sample for native Mobile apps, which uses all values in the specification above for Enable Restore from Backup:


Important! Replace all placeholder instances of <Context Key> with the specific name of your threat event context key across all language examples. This is crucial to ensure your code functions correctly with the intended event data. For example, The <Context Key> could be the message, externalID, OS Version, reason code, etc.



Using Appdome, there are no development or coding prerequisites to build secured Mobile Apps by using Enable Restore from Backup. 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 Enable Restore from Backup

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:

Related Articles:

How Do I Learn More?

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.

Want a Demo?

Mobile Data Encryption

AlanWe're here to help
We'll get back to you in 24 hours to schedule your demo.

Search Appdome Solutions

Search
Supercharge The Experience In Mobile App Defense

Supercharge the Experience in Mobile App Defense

Appdome revolutionizes mobile app defense by integrating security seamlessly, enhancing the user experience for developers, cyber teams, and end-users without disruption.

Better User Experience In Mobile Defense

Better User Experience in Mobile Defense

This blog show how Appdome’s Intelligent Defense helps mobile brands and users resolve threats with the user experience as a central priority.