newlogic/smartscanner-core

ID scanning Android app and library. Supports MRZ, NFC, Barcodes, and ID PASS Lite cards.

smartscanner-core's Issues

Add a way to Scan a QR Code that contain a Gziped JSON

This would be available only through another app that calls using intent.
For QR Code scanning, we should be able to have those options:

• gzipped (true or false)
• json (true or false)
• Json path (to get 1 value in a json file)

return in the intent:

• qr_code_text
• qr_code_json_value (the target value of the json path)

Lib:
https://github.com/json-path/JsonPath

NFC noalgorithm and Security errors

Current Behaviour

NFC related Security errors and noalgorithm exceptions when minifyEnabled is set to true for build.gradle

Expected Behaviour

Fix NFC related Security errors and noalgorithm exceptions

Fix Image crop and path

TODOs:

• Fix the image resolution from the response via MRZ/Barcode scan
• Fix the image resolution from the response via Manual Capture
• Fix image path issues which make the image not properly loaded when used in plugins

Find the Iraq country signing certificate

Current Behaviour

Currently, the smartscanner app does not have the Iraq country signer certificate.

Expected Behaviour

We need to have the Iraq country signer certificate as a trust anchor of the epassport/ID certificate.

Steps to Reproduce the Problem

1. Use smartscanner-core app to scan an Iraqi Unified ID.
2. Notice that in the Authentication section, the CSCA is marked as x here

Context

The presence of the Iraq country signer certificate(s) in our csca.ks file shall serve as a trust anchor to verify the epassport/ID certificate content integrity.

• Version:

NameOfHolder and NFC Screen being null Issues

Current Behaviour

the name not display properly

Expected Behaviour

display in readable way without any empty values

Add deobfuscation file and debug symbols for Release build

Current Behaviour

No deobfuscation file and debug symbols and if added, ID PASS Lite crashes the app

Expected Behaviour

Add deobfuscation file and debug symbols and fix ID PASS Lite crash errors the app

Context

Errors encountered:

• ID PASS Lite crash
  
• Google play warnings
  

Add MRZ optional values to NFC Scan Result

Current Behaviour

No optional values like Unified ID or etc in NFC Scan result

Expected Behaviour

Add optional values like Unified ID or etc to NFC Scan result

Update new UI Design

Current Behaviour

the ui is not clear and not arrange

Fix bounding box for ID PASS Lite

When scanning ID PASS Lite QR Code, the bounding box does not correspond to where the QR code should be

Update intent call out

• Simplify callout extras
• Use bundle response

References:
https://github.com/idpass/idpass-mobile-api
https://github.com/BlinkID/blinkid-android

Add upper header and sub-header labels for SmartScanner

Current Behaviour

Only label that is located below are able to be used

Expected Behaviour

Add upper label for header and sub-header

Add Loading screen and labels for downloading OCR models

Current Behaviour

Screen lacks loading info for OCR models

Expected Behaviour

Add Loading screen for downloading OCR models

Failed to read Data Groups

Current Behaviour

I scan my passport with smartscanner and the UI showed check marks in the Authentication section. But the debug logs showed failure to verify the Data Group hashes:

W/PassportNFC: Skipping DG1 during HT verification because file could not be read.
W/PassportNFC: Skipping DG2 during HT verification because file could not be read.
W/PassportNFC: Skipping DG11 during HT verification because file could not be read.
W/PassportNFC: Skipping DG12 during HT verification because file could not be read.
W/PassportNFC: Skipping DG15 during HT verification because file could not be read.

Expected Behaviour

The above lines should not appear in the logcat debug messages.

When the above lines does not appear in the logcat debug messages, it means that the Data Group hashes got read successfully and its values re-computed and match. This is important because the correct values of these hashes is a check against content tampering.

Steps to Reproduce the Problem

1. Use smartscanner-core to scan a passport
2. Notice that under Authentication section claims passport is valid despite the Data Group hashes are not verified.

Context

The Data Group hashes are hashes of the passport content and is what the Document Signer certificate is certifying. This document signer certificate is further anchored to the country signing certificate present in the csca file.

This issue has dependency of another issue #48

• Version:

Find a way if NFC Passport have RTL/LTR embedded locale details

Current Behaviour

Force app to define if Scanner uses RTL/LTR via nfcLocale in ScannerOptions

Expected Behaviour

Find a way if NFC Passport have RTL/LTR embedded locale details

Investigate Raphael failed Chip Authentication

Current Behaviour

Use smartscanner to scan your passport/ID. If your passport/ID has Chip Auth feature, then Chip Authentication is performed and it should pass.

Background info: PH passports have no Chip Auth feature. Ken's passport have Chip Auth feature.

Expected Behaviour

In the Authentication section of smartscanner's result page, the Chip should have a checked marked if the passport/ID being scanned has Chip Auth feature. Otherwise, the Chip should not appear in cases where Chip Auth feature is not supported.

Steps to Reproduce the Problem

1. Raphael scanned his passport using smartscanner app
2. The page results here showed an x mark in Chip.

Context

The same smartscanner app is able to verify Ken's passport which has a Chip Auth feature as shown here

• Version:

Add CI for build checking

• Add CI via GH Actions
• Add encryption of google-services.json

Add an NFC intent to start the Scanning of a card when a passport is tapped on the phone

Current Behaviour

NFC scan is accessed via ODK, Plugin Integration or via App

Expected Behaviour

Add an NFC intent to start the Scanning of a card when a passport is tapped on the phone

Update app Icon, review texts

Remove the green border for now, it is more confusing than anything.

Add support to reading passports eMRTD

We should integrate JMRTD to read eMRTD enabled passports and cards.

Add a sharing button to share the scan result

Add font support for Scope Mobile

Face picture capture for ID PASS Lite

We should allow authenticating with the face biometrics and not just with the PIN code

Reorganize the different Analyzer

There are too many unnecessary branches in the code, we need to create an Analyser Interface that implement each of the AnalyzerType.

Compute Check digit for MRZ Result consistency

Current Behaviour

No check digit verification for MRZ

Expected Behaviour

Add Check digit verification

Context

It should not accept the wrong passport number. In my case the check digit is 2, and if my passport # was 18FVO3800, it would be 4.

Reorganize repos to main idpass-smart-scanner

• Reorganize all repos and add to a new repo named idpass-smart-scanner
• Separate core repo from plugin repos
• Delete plugin submodules references from core

Internationalization of the App to Arabic

Current Behavior

• now we have only English version

Expected Behavior

• English and Arabic app

Improve font support for label

• Add text style ( bold, italic..etc)
• Add font color
• Add Text size

Package refactoring

• refactor packages and names that are using mlkit to smartscanner

Add the missing fields in the App

Current Behaviour

• current one have a full name one after other

Expected Behaviour

Documentation

Start documenting the project

Publish smartscanner related repos to MavenCentral

Current Behaviour

Using aars to link multiple SmartScanner repos

Expected Behaviour

Publish following smartscanner repos to maven:

• smartscanner-core
• smartscanner-android-api
• smartscanner-mrz-parser

Steps to Reproduce the Problem

N/A

Context

N/A

name issue

Current Behaviour

showing names not in proper way

Expected Behaviour

show the current name as given name and surname only

• Version:

Add the Capacitor and Intent API for NFC

Current Behaviour

• No Support for Capacitor Plugin and Intent API for NFC

Expected Behaviour

Add support for capacitor plugin and Intent API

Add missing translations to SmartScanner app

Current Behaviour

not all translation display

Expected Behaviour

all app translate in one and same time

Fix support for MRZ Passport Scanning

• Currently, there are problems when scanning MRZ for passports. Which maybe is due to the Image cropping or processing of how the Image is analyzed from the reader
• Fix Skewed images upon capture

Improve the UI with better display of the data such as dates

Current Behaviour

• app shown the date as yymmdd

Expected Behaviour

• display date as readable date

Add the captured image to Intent result

Update Scanner camera UI

• Improve camera box UI when selected
• Update ID Pass branding
• Add and improve UI by having scan edges
• Add transparent overlay to camera

Extract photo when scanning passport

Add config for NFC Options

Current Behaviour

No dedicated config options for NFC

Expected Behaviour

Add dedicated config options for NFC for integration with plugin apis

Publish capacitor to npm

• Update plugin repos to latest idpass-smartscanner core apis

Add CSCA file for country certificates

Current Behaviour

At present, there is no CSCA file as a trust anchor of the document signer certificate. This results to CSCA marked with x as shown here

Expected Behaviour

There should be a CSCA file trust anchor to verify contents against tampering. Furthermore, a plan should be in place to update this file in a controlled manner.

Steps to Reproduce the Problem

1. Use smartscanner-core to scan your passport.
2. Notice that the CSCA is marked "x" as shown here. This means that the passport's certificate and the integrity of all its contents could not be verified.

Context

• Version:

Add encryption key to ID Pass Lite reader

Before starting this, discuss with @jeremi

• load a pkcs12
• Add customizable encryption key

Capture the PIN code before returning the intent values

Option for NFC Reader label to be configurable

Current Behaviour

Pre-defined labels for NFC only

Expected Behaviour

Add option for NFC Reader label to be configurable

Change readable date format return from MRZ result

Current Behaviour

6 digit date is sent as standard (YY/DD/MM)

Expected Behaviour

Return a readable date of birth (YYYY/DD/MM)

rename java package to `org.idpass.smartscanner`

Add flag to read e-passport photo

Current Behaviour

The reading of the photo content inside DG2 is the most time consuming portion during a read. Around 10 seconds is consumed to read this photo. If this photo is not needed, then it should be skipped.

Expected Behaviour

Use cases that does not need the ID photo should have a significantly faster NFC read. A flag should be used to control this read.

Steps to Reproduce the Problem

1. Scan an e-passport/unified ID
2. NFC scanning use case not needing a photo should be significantly faster than use case which need the photo.

Context

NFC scanning duration is an important usability and security feature.

• Version:

Add IRAQ_ID Mrz support

• Add IRAQ_ID Mrz support
• Refactor/Remove MrzFormat config call