Detection

Important Update - Harmony App Protect End of Support

 

Check Point’s Harmony App Protect will be end of support soon.

For more information on key actions and timelines, see Harmony App Protect End-of-Life - Check Point CheckMates.

When the Harmony App Protect is authorized and ready, it runs background detections and monitors changes, such as when a new app is installed, to inform the hosting app of any supported risk. You can query the SBMClient at any time for the current status of the device risk or to perform a scan for a specific detection type.

When the Harmony App Protect completes the first-time scan of the device, it broadcasts an ACTION_FIRST_SCAN action so the hosting app can rely on the results. Afterward, whenever the Harmony App Protect finds any risk changes, it broadcasts ACTION_STATUS_CHANGED to inform the hosting app about the changes. When the hosting app receives any of these broadcasts, it must ask the Harmony App Protect for the new status and decide what to do.

Copy 
/** * Get all the threats that were found on the device aggregated into groups. * * @return Current device risk status aggregated into groups with summaries. 
                * If the first scan was not completed, this result is not fully reliable. * You should wait for the first scan to complete or to run scan on the 
                * detections  you need. * Only after the detection finished, query the status using this method. * @throws IllegalStateException If tried to be executed before the client 
                * is authorized */
                public Map<String,String> getCurrentStatus() throws IllegalStateException;
            

getCurrentStatus returns the current risk assessment of the device. The returned Map object contains the relevant aggregated group names as keys and additional text information of why it was found as values. The additional information should NOT be used by the developer for any reason except for logging.

 

Copy 
/** * Get all the threats that were found on the device with full details. * * @return Current device risk status with full details as a JSONArray of findings
                            * and metadata. If the first scan was not completed, this result is not fully
                            * reliable. * You should wait for the first scan to complete or to run scan on the detections
                            * you need, * and only after the detection finished, query the status using this method. * @throws IllegalStateException If tried to be executed before the client is 
                        * authorized */public JSONArray getDetails()

getDetails is similar to the getCurrentStatus but returns additional details on the actual threat.

Copy 
/*** On Android OS versions greater or equal to 8 (Android O, api level 26) we need * a foreground service running in order to use services in the background and to * receive events in our broadcast receivers to provide the best security coverage.** @param running boolean state of the foreground services that is managed by the * hosted app. Set to true when the service is running and to false when destroyed.*/
                             
                        public void setForegroundServiceRunning(boolean running)

setForegroundServiceRunning is used to run in the foreground. Needed in Android O and higher.

Copy 
/**
                            * Get the client identifier (available after initialization)
                            *
                            * @return the client device id generated by the sdk
                            */
                             
                        public String getDeviceId()

getDeviceId returns the client identifier, a random UUIDClosed Universal Unique Identifier. A UUID is a 128-bit value used to uniquely identify an object or entity on the internet. for this device used in the Harmony App Protect. This is the only identifier used to identify Harmony App Protect in the Harmony App Protect server backend. We recommend that the hosting app save or print this identifier to include it when you report issues with the Harmony App Protect.

Copy 
/**
                            * Get the  version identifier
                            *
                            * @return  version number
                            */
                             
                        public String getVersion()

getVersion returns the Harmony App Protect version number. For example, 3.4.0.266.