This Knowledge Base article describes how to use Appdome’s AI/ML in your CI/CD pipeline to continuously
deliver plugins that Use Appdome AppID™ in Mobile apps.
What is Appdome AppID?
Appdome’s AppID serves as a unique identifier, functioning like a fingerprint for the app token and build ID within the Appdome system. This identifier makes it possible to distinguish between different fusion sets or versions of apps built using Appdome.
Why is Appdome AppID Important?
Appdome’s AppID is a crucial feature for the security and management of mobile applications, especially when it comes to distinguishing between authentic users, legitimate apps, and malicious bots—a key aspect of Mobile Bot Defense. The AppID acts as a unique identifier for each version of an app fused with Appdome’s services, allowing customers to track a request back to the specific Appdome version in use. This precise level of tracking is essential for the effective operation of Mobile Bot Defense, as it uses AppID in its suite of app fingerprinting techniques to accurately separate legitimate app traffic from malicious bots. In addition to its role in bot detection and defense, the AppID allows customers to customize various shared secrets for distinct app versions. As the app evolves and undergoes multiple build integrations over its lifecycle, each version can have unique configurations, enhancing security and ensuring optimal performance.
Moreover, the method of transmitting Appdome’s AppID via the session header contributes an additional layer of defense. This acts as a robust method of identification that safeguards against unauthorized access in client-server communication, ensuring that each interaction with the server is legitimate and secure. The integration of Appdome AppID within Mobile Bot Defense exemplifies a strategic approach to mobile app protection, reinforcing the infrastructure against sophisticated bot threats and unauthorized access attempts.
Note: The “Appdome AppID” is integrated within the “Session Headers” feature. For your convenience, there’s no need to construct separate fusion sets—simply build one comprehensive set for “Session Headers” to include the Appdome AppID functionality.
Prerequisites for Using Appdome's Appdome AppID™ Plugins:
To use Appdome’s mobile app security build system to Use Appdome AppID™ , you’ll need:
Upload an app via the Appdome Mobile Defense platform GUI or via Appdome’s DEV-API or CI/CD Plugins.
Mobile App Formats: .ipa for iOS, or .apk or .aab for Android
Appdome AppID™ is compatible with:
Obj-C, Java, JS, C#, C++, Swift, Kotlin, Flutter, React Native, Unity, Xamarin, and more.
Select the defense: Appdome AppID™.
Create and name the Fusion Set (security template) that will contain the Appdome AppID™ feature as shown below:
Figure 1: Fusion Set that will contain the Appdome AppID™ feature
Follow the steps in Sections 2.2-2.2.2 of this article to add the Appdome AppID™ feature to your Fusion Set via the Appdome Console.
When you select the Appdome AppID™ you'll notice that the Fusion Set you created in step 2.1 now bears the icon of the protection category that contains Appdome AppID™.
Figure 2: Fusion Set that displays the newly added Appdome AppID™ 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 Appdome AppID™ feature to your security template.
Navigate to Build > Anti Bot tab > Secure Communication section in the Appdome Console.
Like all other options in ONEShield™, Appdome AppID™ is turned on by default, as shown below:
Figure 4: Selecting Appdome AppID™
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 > Appdome AppID™.
Figure 4: Selecting Use Appdome AppID™
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 Appdome AppID™ protection is now added to the mobile app
Certify the Appdome AppID™ feature in Mobile Apps
After building Appdome AppID™, Appdome generates a Certified Secure™ certificate to guarantee that the Appdome AppID™ protection has been added and is protecting the app. To verify that the Appdome AppID™ 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 Appdome AppID™ has been added to each Mobile app. Certified Secure provides instant and in-line DevSecOps compliance certification that Appdome AppID™ and other mobile app security features are in each build of the mobile app.
Using Threat-Events™ for Appdome AppID™ Intelligence and Control in Mobile Apps
Appdome Threat-Events™ provides consumable in-app mobile app attack intelligence and defense control when Appdome AppID™ is detected. To consume and use Threat-Events™ for
Appdome AppID™ in Mobile Apps, use AddObserverForName in Notification Center, and the code samples for Threat-Events™ for Appdome AppID™ shown below.
The specifications and options for Threat-Events™ for Appdome AppID™ are:
Threat-Event™ Elements
Use Appdome AppID™ Method Detail
Appdome Feature Name
Appdome AppID™
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 Using Appdome AppID™ 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 Appdome AppID™ is detected.
The following is a code sample for native Mobile apps, which uses all values in the specification above for Appdome AppID™:
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.
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
// Current threat event score
String currentThreatEventScore = intent.getStringExtra("currentThreatEventScore");
// Total threat events score
String threatEventsScore = intent.getStringExtra("threatEventsScore");
// Replace '' with your specific event context key
// String variable = intent.getStringExtra("");
// 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
// Current threat event score
var currentThreatEventScore = intent?.getStringExtra("currentThreatEventScore")
// Total threat events score
var threatEventsScore = intent?.getStringExtra("threatEventsScore")
// Replace '' with your specific event context key
// var variable = intent?.getStringExtra("")
// 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)
}
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 Mobile Apps by using Appdome AppID™. 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 Appdome AppID™
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 Bot Defense
AlanWe're here to help
We'll get back to you in 24 hours to schedule your demo.
