Skip to content

Latest commit

 

History

History
124 lines (95 loc) · 5.51 KB

README.en.md

File metadata and controls

124 lines (95 loc) · 5.51 KB
Raw

Digital Green Certificate SDK


Leggi in altre lingue: Italiano.

Documents

Table of contents

Context

Please take the time to read and consider the other repositories in full before digging into the source code or opening an Issue. They contain a lot of details that are fundamental to understanding the source code and this repository's documentation.

Installation

Clone this project alongside

your_project_folder
|___your_app
|___sdk_repo
|___dgca-app-core-android
|___dgc-certlogic-android

Verifier application VerificaC19 leverages on this SDK to work.

Usage

The application will need to import the decoder and the SDK.
In the settings.gradle file add the following lines (change according to your directory structure):

include ':app'  
include ':dgc-sdk'  
include ':decoder'  
rootProject.name = "dgp-whitelabel-android"  
project(':dgc-sdk').projectDir = new File("../it-dgc-verificac19-sdk-android/sdk")  
project(':decoder').projectDir = new File("../dgca-app-core-android/decoder")

Then start the workmanager (LoadKeysWorker) located in it.ministerodellasalute.verificaC19sdk.worker.LoadKeysWorker in order to sync the rules and key certificates upon app start.

Among the received parameters from the REST API, a Minimum App Version is received. Compare this value using it.ministerodellasalute.verificaC19sdk.model.FirstViewModel#getAppMinVersion, passing the SDK's current version present in BuildConfig.VERSION_NAME in order to guarantee a matching API response and SDK version in the UI level. In case these values don't match correctly, the SDK will throw a VerificaMinVersionException during the DGC verification which needs to be handled correctly (for example by redirecting the user to PlayStore).
Example:

override fun onResume() {  
    super.onResume()  
    viewModel.getAppMinVersion().let {  
        if (Utility.versionCompare(it, BuildConfig.VERSION_NAME) > 0) {  
            createForceUpdateDialog()  
        }  
    }
}

The method it.ministerodellasalute.verificaC19sdk.model.FirstViewModel#isSDKVersionObsoleted should be used to check if the min SDK version returned from the server is bigger than or equal to the current SDK version. In case this check isn't done correctly in UI level, the SDK will throw a VerificaMinSDKVersionException which might cause the application to crash if not handled correctly.

At this point it's possible to use a QrCodeScanner library of choice and pass the extracted string to it.ministerodellasalute.verificaC19sdk.model.VerificationViewModel#init.
Example:

try {  
    viewModel.init(args.qrCodeText)  
} catch (e: VerificaMinVersionException) {  
    Log.d("VerificationFragment", "Min Version Exception")  
    createForceUpdateDialog()  
}

Observing the LiveData response of the method, a Certificate object is returned it.ministerodellasalute.verificaC19sdk.model.CertificateSimple which contains the decoded and validated response of the verification. The data model contains person data, birthday, verification timestamp and the verification status.

Based on these data, it's possible to draw the UI and prompt the operator about the status of the DGC.

Contributing

Contributions are most welcome. Before proceeding, please read the Code of Conduct for guidance on how to approach the community and create a positive environment. Additionally, please read our CONTRIBUTING file, which contains guidance on ensuring a smooth contribution process.

Contributors

Here is a list of contributors. Thank you to everyone involved for improving this project, day by day.

License

Authors / Copyright

Copyright 2021 (c) Ministero della Salute.

Please check the AUTHORS file for extended reference.

License details

The license for this repository is Apache License 2.0. Please see the LICENSE file for full reference.