This Knowledge Base article describes how to use Appdome’s AI/ML in your CI/CD pipeline to continuously
deliver plugins that Encrypt In-App Preferences in iOS apps.
What Is Encrypting Preferences in iOS Apps?
In iOS app development, NSUserDefaults is used to store user preferences, such as measurement units or playback speed, as key-value pairs. While this enhances user experience by maintaining customizations across app launches, NSUserDefaults stores data in plain text, leaving sensitive information like payment preferences or personal settings vulnerable to unauthorized access. Attackers or other apps can exploit this exposure to extract sensitive data, posing risks to user security. Encrypting in-app preferences is essential to protect sensitive information, comply with data protection standards like GDPR and CCPA, and ensure app security against unauthorized access.
How Appdome Protects iOS Apps With Encrypting Preferences?
Appdome’s Encrypt In-App Preferences plugin for iOS secures NSUserDefaults data by encrypting user preferences stored as key-value pairs. This encryption ensures that sensitive information, such as payment preferences, is inaccessible to unauthorized apps or systems. By dynamically encrypting preferences at runtime, Appdome protects against data exposure without requiring manual coding or app redesign, ensuring compliance with data protection regulations.
Prerequisites for Using Appdome's Encrypt In-App Preferences Plugins:
To use Appdome’s mobile app security build system to Encrypt In-App Preferences , you’ll need:
Upload an app via the Appdome Mobile Defense platform GUI or via Appdome’s DEV-API or CI/CD Plugins.
iOS Formats: .ipa
Encrypt In-App Preferences is compatible with:
Obj-C, Java, Swift, Flutter, React Native, Unity, Xamarin, Cordova and other iOS apps.
Select the defense: Encrypt In-App Preferences.
Create and name the Fusion Set (security template) that will contain the Encrypt In-App Preferences feature as shown below:
Figure 1: Fusion Set that will contain the Encrypt In-App Preferences feature
Follow the steps in Sections 2.2-2.2.2 of this article to add the Encrypt In-App Preferences feature to your Fusion Set via the Appdome Console.
When you select the Encrypt In-App Preferences you'll notice that the Fusion Set you created in step 2.1 now bears the icon of the protection category that contains Encrypt In-App Preferences.
Figure 2: Fusion Set that displays the newly added Encrypt In-App Preferences protection
Note: Annotating the Fusion Set to identify the protection(s) selected is optional only (not mandatory).
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 3: Fusion Set Detail Summary
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:
Add the Encrypt In-App Preferences feature to your security template.
Navigate to Build > Security tab > TOTALData™ Encryption section in the Appdome Console.
Like all other options in ONEShield™, Encrypt In-App Preferences is turned on by default, as shown below:
Figure 4: Selecting Encrypt In-App Preferences
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.
Toggle On > Encrypt In-App Preferences.
Figure 4: Selecting Encrypt In-App Preferences
Note: The Appdome Platform displays the Mobile Operation Systems supported by each defense in real-time.
For more details, see our OS Support Policy KB.
Configure the User Experience Options for Encrypt In-App Preferences:
With Threat-Events™ OFF, Appdome provides several user experience options for mobile brands and developers.
App Compromise Notification: Customize the pop-up or toast Appdome uses to notify the user when a threat is present while using the protected mobile app.
Short message Option. This is available for mobile devices that allow a banner notification for security events.
Localized Message Option. Allows Appdome users to support global languages in security notifications.
Figure 5: Default User Experience Options for Appdome’s In-App Preferences
Encrypt In-App Preferences Threat Code™. Appdome uses AI/ML to generate a unique code each time
Encrypt In-App Preferences is triggered by an active threat on the mobile device.
Use the code in Appdome Threat Resolution Center™ to help end users identify, find and resolve active threats on the personal mobile devices.
Extra Configuration with Encrypt In-App Preferences:
Encrypt In-App Preferences
Encrypt NSUserDefaults.
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 Encrypt In-App Preferences protection is now added to the mobile app
Certify the Encrypt In-App Preferences feature in iOS Apps
After building Encrypt In-App Preferences, Appdome generates a Certified Secure™ certificate to guarantee that the Encrypt In-App Preferences protection has been added and is protecting the app. To verify that the Encrypt In-App Preferences protection has been added to the mobile app, locate the protection in the Certified Secure™ certificate as shown below:
Figure 6: 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 Encrypt In-App Preferences has been added to each iOS app. Certified Secure provides instant and in-line DevSecOps compliance certification that Encrypt In-App Preferences and other mobile app security features are in each build of the mobile app.
Using Threat-Events™ for In-App Preferences Intelligence and Control in iOS Apps
Appdome Threat-Events™ provides consumable in-app mobile app attack intelligence and defense control when In-App Preferences are detected. To consume and use Threat-Events™ for
In-App Preferences in iOS Apps, use AddObserverForName in Notification Center, and the code samples for Threat-Events™ for In-App Preferences shown below.
The specifications and options for Threat-Events™ for In-App Preferences are:
Threat-Event™ Elements
Encrypt In-App Preferences Method Detail
Appdome Feature Name
Encrypt In-App Preferences
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 In-App Preferences 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.
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
updatedOSVersion
Is the OS version up to date
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), iOS developers can get detailed attack intelligence and granular defense control in iOS applications and create amazing user experiences for all mobile end users when In-App Preferences are detected.
The following is a code sample for native iOS apps, which uses all values in the specification above for Encrypt In-App Preferences:
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.
let center = NotificationCenter.default
center.addObserver(forName: Notification.Name(""), object: nil, queue: nil) { (note) in
guard let usrInf = note.userInfo else {
return
}
let message = usrInf["message"]; // Message shown to the user
let reasonData = usrInf["reasonData"]; // Threat detection cause
let reasonCode = usrInf["reasonCode"]; // Event reason code
// Current threat event score
let currentThreatEventScore = usrInf["currentThreatEventScore"];
// Total threat events score
let threatEventsScore = usrInf["threatEventsScore"];
// Replace '' with your specific event context key
// let variable = usrInf[""];
// Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
}
// Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
24
});
25
}];
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
// Current threat event score
var currentThreatEventScore = userinfo["currentThreatEventScore"]
// Total threat events score
var threatEventsScore = userinfo["threatEventsScore"]
// Replace '' with your specific event context key
// var variable = userinfo[""]
// Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
);
}
// Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
26
}
27
}
NSNotificationCenter.DefaultCenter.AddObserver(
(NSString)"", // Threat-Event Identifier
delegate (NSNotification notification)
{
// Message shown to the user
var message = notification.UserInfo.ObjectForKey("message");
// Threat detection cause
var reasonData = notification.UserInfo.ObjectForKey("reasonData");
// Event reason code
var reasonCode = notification.UserInfo.ObjectForKey("reasonCode");
// Current threat event score
var currentThreatEventScore = notification.UserInfo.ObjectForKey("currentThreatEventScore");
// Total threat events score
var threatEventsScore = notification.UserInfo.ObjectForKey("threatEventsScore");
// Replace '' with your specific event context key
// var variable = notification.UserInfo.ObjectForKey("");
// Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
}
);
// Replace '<Context Key>' with your specific event context key
21
// var variable = notification.UserInfo.ObjectForKey("<Context Keys>");
22
23
// Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
24
}
25
);
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
// Current threat event score
var currentThreatEventScore = userInfo.currentThreatEventScore
// Total threat events score
var threatEventsScore = userInfo.threatEventsScore
// Replace '' with your specific event context key
// var variable = userInfo.
// Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
});
// Replace '<Context Key>' with your specific event context key
13
// var variable = userInfo.<Context Keys>
14
15
// Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
16
});
import 'dart:async';
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
class PlatformChannel extends StatefulWidget {
const PlatformChannel({super.key});
@override
State createState() => _PlatformChannelState();
}
class _PlatformChannelState extends State {
// Replace with your EventChannel name
static const String _eventChannelName = "";
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
// Current threat event score
String currentThreatEventScore = eventData['currentThreatEventScore'];
// Total threat events score
String threatEventsScore = eventData['threatEventsScore'];
// Replace '' with your specific event context key
// String variable = eventData[''];
});
}
// Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
}
// Replace '<Context Key>' with your specific event context key
43
// String variable = eventData['<Context Keys>'];
44
});
45
}
46
47
// Your logic goes here (Send data to Splunk/Dynatrace/Show Popup...)
48
}
Using Appdome, there are no development or coding prerequisites to build secured iOS Apps by using Encrypt In-App Preferences. 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 Encrypt In-App Preferences
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:
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
GilWe're here to help
We'll get back to you in 24 hours to schedule your demo.