Skip to content

Commit af1ba4d

Browse files
Update README.md
Update README with revised Security Report and Screen Protection usage.
1 parent 8dcc647 commit af1ba4d

1 file changed

Lines changed: 15 additions & 16 deletions

File tree

README.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -771,7 +771,7 @@ String myPin = DeviceInfo.generateDigiPin(12.9716, 77.5946);
771771

772772
---
773773

774-
## 5. DeviceGuard - Device seccurity class
774+
## 5. DeviceGuard - Device security class
775775

776776
**DeviceGuard** is a security engine designed for Banking, Insurance, and Enterprise apps. It prevents fraud by detecting environment tampering (Rooting, Emulators, GPS Spoofing) before a document is captured.
777777

@@ -799,42 +799,41 @@ if ((boolean) report.get("isRooted")) {
799799
// Block User
800800
}
801801

802+
if ((boolean) report.get("isLocationSpoofed")) {
803+
// Reject the capture - User is faking location
804+
}
805+
802806
```
803807

804808
#### 📋 Response Data (Security Map)
805809

806810
| Key | Data Type | Description | Severity |
807811
| --- | --- | --- | --- |
808812
| **`isRooted`** | `boolean` | `true` if device is Rooted (Su/Magisk). | 🔴 Critical |
813+
| **`isLocationSpoofed`**| `boolean` | `true` if device is using Mock/Fake GPS location. | 🔴 Critical|
814+
| **`locationMessage`**| `String`| Diagnostic message for the location spoofing check.| 🔴 Critical|
809815
| **`isEmulator`** | `boolean` | `true` if running on a Simulator. | 🔴 Critical |
810816
| **`isDevOptionsEnabled`** | `boolean` | `true` if Developer Options are ON. | 🟠 High |
811817
| **`isAdbEnabled`** | `boolean` | `true` if USB Debugging is ON. | 🟠 High |
812818
| **`isVpnActive`** | `boolean` | `true` if VPN is masking the IP. | 🟡 Medium |
813819

814-
### B. Anti-Spoofing (Mock Location)
820+
### B. Screen Protection (Privacy)
815821

816-
Detect if the GPS coordinates provided by the device are fake (Mock Location).
822+
Prevents the QuickCapture screen from being recorded or captured via screenshots. Video recordings will result in a **black screen**.
817823

818824
```java
819-
// Pass the location object received from DeviceInfo or LocationManager
820-
boolean isFake = guard.isLocationSpoofed(locationObject);
821-
if (isFake) {
822-
// Reject the capture - User is faking location
823-
}
825+
// Enable screen protection (call in onCreate() of your Activity)
826+
guard.enableScreenProtection(this);
824827

825828
```
826-
827-
### C. Screen Protection (Privacy)
828-
829-
Prevents the QuickCapture screen from being recorded or captured via screenshots. Video recordings will result in a **black screen**.
830-
829+
To turn off screen protection when it’s no longer needed:
831830
```java
832-
// Call in onCreate() of your Activity
833-
guard.enableScreenProtection(this);
831+
// Disable screen protection
832+
guard.disableScreenProtection(this);
834833

835834
```
836835

837-
### D. Real-Time Monitoring
836+
### C. Real-Time Monitoring
838837

839838
Listen for threats while the app is running (e.g., user toggles VPN or Developer settings during a session).
840839

0 commit comments

Comments
 (0)