@regulaforensics/cordova-plugin-document-reader-api 7.4.620 → 7.5.78-rc

package/.gitlab/report.yaml

@@ -0,0 +1,75 @@
+spec:
+  inputs:
+    stage:
+      default: reports
+    image:
+      default: ubuntu:22.04
+    ignore_vulnerabilities:
+      default: "false"
+    sast_report_file:
+      default: gl-sast-report.json
+    secret_detection_report_file:
+      default: gl-secret-detection-report.json
+    dependency_scanning_report_file:
+      default: gl-dependency-scanning-report.json
+---
+
+view reports:
+  image: $[[ inputs.image ]]
+  stage: $[[ inputs.stage ]]
+  variables:
+    IGNORE_VULNERABILITIES: $[[ inputs.ignore_vulnerabilities ]]
+    SAST_REPORT_FILE: $[[ inputs.sast_report_file ]]
+    SECRET_DETECTION_REPORT_FILE: $[[ inputs.secret_detection_report_file ]]
+    DEPENDENCY_SCANNING_REPORT_FILE: $[[ inputs.dependency_scanning_report_file ]]
+    RED: \033[0;31m
+    YELLOW: \033[1;33m
+    GREEN: \033[0;32m
+    NC: \033[0m
+  needs:
+    - job: semgrep-sast
+      artifacts: true
+    - job: secret_detection
+      artifacts: true
+    - job: gemnasium-dependency_scanning
+      artifacts: true
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+  script:
+    - ls -la
+    - apt update && apt install -y jq
+    - |
+      for f in SAST_REPORT_FILE SECRET_DETECTION_REPORT_FILE DEPENDENCY_SCANNING_REPORT_FILE
+      do
+        if [[ -f "${!f}" ]]
+        then
+          echo -e "${GREEN}File ${!f} exists, adding report${NC}"
+          r=${f/%_FILE}
+          declare $r="$(cat ${!f} | jq 'select(.vulnerabilities != []).vulnerabilities')"
+          if [[ ! -z "${!r}" ]]
+          then
+            VULNERABILITIES_FOUND=true
+            echo -e "${RED}Found $r vulnerabilities${NC}"
+            echo "${!r}"
+            echo
+          fi
+        else
+          echo -e "${YELLOW}File ${!f} doesn't exist, skipping${NC}"
+        fi
+      done
+
+      if [[ "$VULNERABILITIES_FOUND" == true ]]
+      then
+        if [[ "$IGNORE_VULNERABILITIES" == true ]]
+        then
+          echo -e "${GREEN}All found vulnerabilities were ignored due to IGNORE_VULNERABILITIES=true${NC}"
+          exit 0
+        else
+          echo -e "${RED}Vulnerabilities found, please see reports above${NC}"
+          exit 1
+        fi
+      fi
+
+      echo -e "${GREEN}No vulnerabilities found${NC}"
+
+      exit 0

package/.gitlab-ci.yml

@@ -0,0 +1,49 @@
+stages:
+  - test
+  - reports
+
+include:
+  - template: Jobs/SAST.gitlab-ci.yml
+  - template: Jobs/Secret-Detection.gitlab-ci.yml
+  - template: Jobs/Dependency-Scanning.gitlab-ci.yml
+  - local: .gitlab/report.yaml
+    rules:
+      - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    inputs:
+      stage: reports
+      image: ubuntu:22.04
+      ignore_vulnerabilities: "false"
+      sast_report_file: gl-sast-report.json
+      secret_detection_report_file: gl-secret-detection-report.json
+      dependency_scanning_report_file: gl-dependency-scanning-report.json
+
+trivy scan:
+  stage: test
+  image: aquasec/trivy
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+  script:
+    - trivy fs --severity CRITICAL,HIGH,MEDIUM,LOW --ignore-unfixed --db-repository container-registry.regula.local:80/aquasecurity/trivy-db:2 --exit-code 1 .
+
+semgrep-sast:
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+  artifacts:
+    paths:
+      - gl-sast-report.json
+
+secret_detection:
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+  artifacts:
+    paths:
+      - gl-secret-detection-report.json
+
+gemnasium-dependency_scanning:
+  variables:
+    DS_MAX_DEPTH: -1
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+  artifacts:
+    paths:
+      - gl-dependency-scanning-report.json

package/README.md

@@ -8,7 +8,7 @@ This repository contains the source code of the Document Reader API, and the sam
 
 ## Documentation
 
-You can find documentation [here](https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile/cordova).
+You can find documentation [here](https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile).
 
 ## License
 

package/example/config.xml

@@ -16,7 +16,7 @@
     <allow-intent href="mailto:*" />
     <allow-intent href="geo:*" />
     <platform name="android">
-        <resource-file src="www/db.dat" target="app/src/main/assets/Regula/db.dat"/>
+        <resource-file src="www/db.dat" target="app/src/main/assets/Regula/db.dat" />
         <preference name="android-minSdkVersion" value="23" />
         <preference name="android-targetSdkVersion" value="34" />
         <allow-intent href="market:*" />
@@ -26,11 +26,13 @@
             <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
             <uses-permission android:name="android.permission.BLUETOOTH_SCAN" />
         </config-file>
+        <preference name="orientation" value="portrait" />
     </platform>
     <platform name="ios">
         <resource-file src="www/db.dat" />
         <allow-intent href="itms:*" />
         <allow-intent href="itms-apps:*" />
+        <preference name="orientation" value="portrait" />
         <config-file target="*-Info.plist" parent="NSCameraUsageDescription">
             <string>To use camera</string>
         </config-file>
@@ -42,26 +44,26 @@
         </config-file>
         <config-file target="*-Info.plist" parent="com.apple.developer.nfc.readersession.iso7816.select-identifiers">
             <array>
-		        <string>A0000002471001</string>
-		        <string>E80704007F00070302</string>
-		        <string>A000000167455349474E</string>
-		        <string>A0000002480100</string>
-		        <string>A0000002480200</string>
-		        <string>A0000002480300</string>
-		        <string>A00000045645444C2D3031</string>
-	        </array>
+                <string>A0000002471001</string>
+                <string>E80704007F00070302</string>
+                <string>A000000167455349474E</string>
+                <string>A0000002480100</string>
+                <string>A0000002480200</string>
+                <string>A0000002480300</string>
+                <string>A00000045645444C2D3031</string>
+            </array>
         </config-file>
         <config-file target="*-Debug.plist" parent="com.apple.developer.nfc.readersession.formats">
             <array>
                 <string>NDEF</string>
-		        <string>TAG</string>
+                <string>TAG</string>
             </array>
         </config-file>
         <config-file target="*-Release.plist" parent="com.apple.developer.nfc.readersession.formats">
             <array>
                 <string>NDEF</string>
-		        <string>TAG</string>
+                <string>TAG</string>
             </array>
         </config-file>
     </platform>
-</widget>
+</widget>

package/example/package.json

@@ -13,10 +13,10 @@
   "author": "Regula Forensics Inc.",
   "license": "commercial",
   "dependencies": {
-    "@regulaforensics/cordova-plugin-document-reader-api": "7.4.620",
-    "@regulaforensics/cordova-plugin-document-reader-core-fullauthrfid": "7.4.623",
-    "cordova-android": "12.0.1",
-    "cordova-ios": "7.0.1",
+    "@regulaforensics/cordova-plugin-document-reader-api": "7.5.78-rc",
+    "@regulaforensics/cordova-plugin-document-reader-core-fullauthrfid": "7.7.168-rc",
+    "cordova-android": "13.0.0",
+    "cordova-ios": "7.1.1",
     "cordova-plugin-add-swift-support": "2.0.2",
     "cordova-plugin-advanced-http": "3.3.1",
     "cordova-plugin-camera": "7.0.0",

package/example/www/js/index.js

@@ -238,6 +238,11 @@ var app = {
                 if (value != null)
                     document.getElementById("portraitImage").src = "data:image/png;base64," + value
             }, function (error) { console.log(error) })
+
+            DocumentReader.graphicFieldImageByTypeSource(results, Enum.eGraphicFieldType.GF_PORTRAIT, Enum.eRPRM_ResultType.RFID_RESULT_TYPE_RFID_IMAGE_DATA, function (value) {
+                if (value != null)
+                    document.getElementById("portraitImage").src = "data:image/png;base64," + value
+            }, function (error) { console.log(error) })
         }
 
         function clearResults() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@regulaforensics/cordova-plugin-document-reader-api",
-  "version": "7.4.620",
+  "version": "7.5.78-rc",
   "description": "Cordova plugin for reading and validation of identification documents (API framework)",
   "cordova": {
     "id": "@regulaforensics/cordova-plugin-document-reader-api",
@@ -11,17 +11,13 @@
   },
   "max_body_size": "1000mb",
   "keywords": [
-    "cordova",
-    "documentreader",
-    "reader",
-    "scanner",
-    "regula"
+    "cordova", "documentreader", "reader", "scanner", "regula"
   ],
   "author": "RegulaForensics",
   "license": "commercial",
   "repository": {
-    "type": "git",
-    "url": "https://github.com/regulaforensics/DocumentReader-Cordova-Plugin.git"
+      "type": "git",
+      "url": "https://github.com/regulaforensics/DocumentReader-Cordova-Plugin.git"
   },
   "homepage": "https://mobile.regulaforensics.com",
   "publishConfig": {

package/plugin.xml

@@ -1,6 +1,5 @@
 <?xml version='1.0' encoding='utf-8'?>
-<plugin id="cordova-plugin-document-reader-api" version="7.4.620"
-  xmlns="http://apache.org/cordova/ns/plugins/1.0">
+<plugin id="@regulaforensics/cordova-plugin-document-reader-api" version="7.5.78-rc" xmlns="http://apache.org/cordova/ns/plugins/1.0">
   <name>DocumentReaderApi</name>
   <description>Cordova plugin Document reader api</description>
   <license>commercial</license>
@@ -15,6 +14,7 @@
       <feature name="DocumentReader">
         <param name="ios-package" value="RGLWDocumentReader" />
       </feature>
+      <preference name="deployment-target" value="13.0" />
     </config-file>
     <header-file src="src/ios/RGLWDocumentReader.h" />
     <source-file src="src/ios/RGLWDocumentReader.m" />
@@ -23,16 +23,18 @@
     <header-file src="src/ios/RGLWConfig.h" />
     <source-file src="src/ios/RGLWConfig.m" />
     <podspec>
-        <config>
-        </config>
+      <config>
+        <source url="https://github.com/CocoaPods/Specs.git"/>
+      </config>
       <pods>
-        <pod name="DocumentReader" spec="7.4.3900" />
+        <pod name="DocumentReaderStage" spec="7.7.4492" />
       </pods>
     </podspec>
   </platform>
 
   <platform name="android">
     <config-file parent="/*" target="res/xml/config.xml">
+      <preference name="GradlePluginKotlinEnabled" value="true" />
       <feature name="DocumentReader">
         <param name="android-package" value="cordova.plugin.documentreader.DocumentReader" />
       </feature>

package/src/android/BluetoothUtil.kt

@@ -5,10 +5,13 @@
 //  Created by Pavel Masiuk on 21.09.2023.
 //  Copyright © 2023 Regula. All rights reserved.
 //
+@file:SuppressLint("MissingPermission")
 
 package cordova.plugin.documentreader
 
-import android.Manifest.permission.*
+import android.Manifest.permission.ACCESS_FINE_LOCATION
+import android.Manifest.permission.BLUETOOTH_CONNECT
+import android.Manifest.permission.BLUETOOTH_SCAN
 import android.annotation.SuppressLint
 import android.app.Activity
 import android.bluetooth.BluetoothAdapter
@@ -19,94 +22,137 @@ import android.content.pm.PackageManager.PERMISSION_GRANTED
 import android.os.Build
 import android.os.IBinder
 import android.provider.Settings
-import androidx.annotation.RequiresPermission
-import androidx.core.app.ActivityCompat.requestPermissions
 import androidx.core.content.ContextCompat.checkSelfPermission
-import com.regula.documentreader.api.ble.BLEWrapper
-import com.regula.documentreader.api.ble.BleWrapperCallback
-import com.regula.documentreader.api.ble.RegulaBleService
+import com.regula.common.ble.BLEWrapper
+import com.regula.common.ble.BleWrapperCallback
+import com.regula.common.ble.RegulaBleService
 import com.regula.documentreader.api.internal.permission.BluetoothPermissionHelper.BLE_ACCESS_PERMISSION
 import com.regula.documentreader.api.internal.permission.BluetoothSettingsHelper.isBluetoothEnabled
 import com.regula.documentreader.api.internal.permission.BluetoothSettingsHelper.isLocationServiceEnabled
+import java.util.Timer
+import java.util.TimerTask
 
-const val REQUEST_ENABLE_LOCATION = 196
-const val REQUEST_ENABLE_BT = 197
+const val SEARCHING_TIMEOUT: Long = 7000
+
+const val INTENT_REQUEST_ENABLE_LOCATION = 196
+const val INTENT_REQUEST_ENABLE_BLUETOOTH = 197
 
 @SuppressLint("StaticFieldLeak")
-var bleManager: BLEWrapper? = null
+lateinit var bluetooth: BLEWrapper
+lateinit var savedCallbackForPermissionResult: Callback
+var deviceConnected = false
 
-@RequiresPermission("android.permission.BLUETOOTH_CONNECT")
-fun requestEnableBle(activity: Activity) {
-    val enableIntent = Intent(BluetoothAdapter.ACTION_REQUEST_ENABLE)
-    activity.startActivityForResult(enableIntent, REQUEST_ENABLE_BT)
+fun connectBluetoothDevice(callback: Callback) {
+    // return if already connected
+    if (deviceConnected) return
+
+    // If some of the bluetooth permissions/settings don't match the requirements,
+    // save callback for later and request the permissions/settings.
+    // Callback will then be used in onRequestPermissionsResult for permission requests
+    // and in onActivityResult for settings change requests.
+    if (!isBluetoothSettingsReady(activity)) {
+        savedCallbackForPermissionResult = callback
+        return
+    }
+
+    // set searching timeout
+    val timer = object : TimerTask() {
+        override fun run() {
+            callback.success(false)
+            bluetooth.stopDeviceScan()
+            bluetooth.disconnect()
+        }
+    }
+    Timer().schedule(timer, SEARCHING_TIMEOUT)
+
+    // start searching devices
+    val bleIntent = Intent(context, RegulaBleService::class.java)
+    context.startService(bleIntent)
+    context.bindService(bleIntent, object : ServiceConnection {
+        override fun onServiceConnected(name: ComponentName, service: IBinder) {
+            bluetooth = (service as RegulaBleService.LocalBinder).service.bleManager
+            bluetooth.addCallback(object : BleWrapperCallback() {
+                override fun onDeviceReady() {
+                    timer.cancel()
+                    bluetooth.removeCallback(this)
+                    deviceConnected = true
+                    callback.success(true)
+                }
+            })
+        }
+
+        override fun onServiceDisconnected(name: ComponentName) {}
+    }, 0)
 }
 
-fun requestEnableLocationService(activity: Activity) {
-    val myIntent = Intent(Settings.ACTION_LOCATION_SOURCE_SETTINGS)
-    activity.startActivityForResult(myIntent, REQUEST_ENABLE_LOCATION)
+fun onRequestPermissionsResult(
+    requestCode: Int,
+    permissions: Array<String>,
+    grantResults: IntArray
+): Boolean {
+    if (requestCode != BLE_ACCESS_PERMISSION || permissions.isEmpty()) return false
+    if (grantResults.isEmpty() || grantResults[0] != PERMISSION_GRANTED) {
+        savedCallbackForPermissionResult.success(false)
+        return true
+    }
+    connectBluetoothDevice(savedCallbackForPermissionResult)
+    return true
 }
 
-// requestEnableBle() is called after a check for permission
-@SuppressLint("MissingPermission")
-fun isBlePermissionsGranted(activity: Activity): Boolean {
-    if (!isLocationServiceEnabled(activity)) {
-        requestEnableLocationService(activity)
-        return false
+fun onActivityResult(requestCode: Int, rc: Int, @Suppress("UNUSED_PARAMETER") data: Intent?): Boolean {
+    var resultCode = rc
+    if (requestCode == INTENT_REQUEST_ENABLE_LOCATION)
+        resultCode = if (isLocationServiceEnabled(activity)) Activity.RESULT_OK
+        else requestCode
+
+    if (requestCode == INTENT_REQUEST_ENABLE_BLUETOOTH || requestCode == INTENT_REQUEST_ENABLE_LOCATION) {
+        if (resultCode == Activity.RESULT_OK)
+            connectBluetoothDevice(savedCallbackForPermissionResult)
+        else
+            savedCallbackForPermissionResult.success(false)
+        return true
     }
-    deniedBluetoothPermissions(activity)?.let {
+    return false
+}
+
+fun isBluetoothSettingsReady(activity: Activity): Boolean {
+    deniedBluetoothPermissions()?.let {
         requestPermissions(activity, it, BLE_ACCESS_PERMISSION)
         return false
     }
     if (!isBluetoothEnabled(activity)) {
-        requestEnableBle(activity)
+        requestEnableBluetooth(activity)
+        return false
+    }
+    if (!isLocationServiceEnabled(activity)) {
+        requestEnableLocationService(activity)
         return false
     }
     return true
 }
 
-fun deniedBluetoothPermissions(activity: Activity): Array<String>? {
+fun deniedBluetoothPermissions(): Array<String>? {
     val result = mutableListOf<String>()
     if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
-        result.addAll(deniedBluetoothPermission(activity, BLUETOOTH_SCAN))
-        result.addAll(deniedBluetoothPermission(activity, BLUETOOTH_CONNECT))
+        result.addAll(deniedBluetoothPermission(BLUETOOTH_SCAN))
+        result.addAll(deniedBluetoothPermission(BLUETOOTH_CONNECT))
     } else
-        result.addAll(deniedBluetoothPermission(activity, ACCESS_FINE_LOCATION))
+        result.addAll(deniedBluetoothPermission(ACCESS_FINE_LOCATION))
     return result.let { if (it.size > 0) it.toTypedArray() else null }
 }
 
-fun deniedBluetoothPermission(
-    activity: Activity,
-    permission: String
-): Array<String> {
-    if (checkSelfPermission(activity, permission) != PERMISSION_GRANTED)
+fun deniedBluetoothPermission(permission: String): Array<String> {
+    if (checkSelfPermission(context, permission) != PERMISSION_GRANTED)
         return arrayOf(permission)
     return arrayOf()
 }
 
-fun startBluetoothService(
-    activity: Activity,
-    onConnected: (Boolean) -> Unit,
-    onDisconnected: () -> Unit,
-    onReady: () -> Unit
-) {
-    val bleIntent = Intent(activity, RegulaBleService::class.java)
-    activity.startService(bleIntent)
-
-    activity.bindService(bleIntent, object : ServiceConnection {
-        override fun onServiceConnected(name: ComponentName, service: IBinder) {
-            bleManager = (service as RegulaBleService.LocalBinder).service.bleManager
-            val isBleManagerConnected = bleManager?.isConnected == true
-            onConnected(isBleManagerConnected)
-            if (!isBleManagerConnected) {
-                bleManager?.addCallback(object : BleWrapperCallback() {
-                    override fun onDeviceReady() {
-                        bleManager!!.removeCallback(this)
-                        onReady()
-                    }
-                })
-            }
-        }
+fun requestEnableBluetooth(activity: Activity) {
+    val enableIntent = Intent(BluetoothAdapter.ACTION_REQUEST_ENABLE)
+    startActivityForResult(activity, enableIntent, INTENT_REQUEST_ENABLE_BLUETOOTH)
+}
 
-        override fun onServiceDisconnected(name: ComponentName) = onDisconnected()
-    }, 0)
-}
+fun requestEnableLocationService(activity: Activity) {
+    val myIntent = Intent(Settings.ACTION_LOCATION_SOURCE_SETTINGS)
+    startActivityForResult(activity, myIntent, INTENT_REQUEST_ENABLE_LOCATION)
+}