Digital Green Certificate SDK

Read this in other languages: English.

Documenti

• 📄 Documentazione SDK dettagliata
• 📄 Documentazione Digital Green Certificate Revocation List (DRL)
• 📄 Digital Green Certificate descrizione ad alto livello

Indice

• Contesto
• Installazione
• Uso
• Contribuzione
• Licenza
  • Autori / Copyright
  • Dettaglio licenza

Contesto

Questo repository contiene un Software Development Kit (SDK), rilasciato dal Ministero della Salute italiano, che consente di integrare nei sistemi di controllo degli accessi, inclusi quelli di rilevazione delle presenze, le funzionalità di verifica della Certificazione verde COVID-19, mediante la lettura del QR code.

Trattamento dati personali

Il trattamento dei dati personali svolto dalle soluzioni applicative sviluppate a partire dalla presente SDK deve essere effettuato limitatamente alle informazioni pertinenti e alle operazioni strettamente necessarie alla verifica della validità delle Certificazioni verdi COVID-19. Inoltre è fatto esplicito divieto di conservare il codice a barre bidimensionale (QR code) delle Certificazioni verdi COVID-19 sottoposte a verifica, nonché di estrarre, consultare, registrare o comunque trattare per finalità ulteriori rispetto a quelle previste per la verifica della Certificazione verde COVID-19 o le informazioni rilevate dalla lettura dei QR code e le informazioni fornite in esito ai controlli, come indicato nel DPCM 12 ottobre 2021

Installazione

E' necessario clonare questo progetto insieme ai seguenti:

• dgca-app-core-android repo
• dgc-certlogic-android repo

nel seguente modo:

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

Step di installazione

Step 1

Contesto: Android (in Android Studio, selezionare la voce Android nel menu in alto a sinistra)

Aggiungere la dipendenza: implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.5.31" nel gradle (Module) dell'applicazione utente.

Step 2

Contesto: Project (in Android Studio, selezionare la voce Project nel menu in alto a sinistra)

• Creare una nuova directory nella root del progetto chiamata buildSrc;
• In buildSrc creare un file vuoto chiamato build.gradle.kts ed inizializzarlo con il contenuto del file build.gradle.kts

repositories {
    jcenter()
}

plugins {
    `kotlin-dsl`
}

• Subito dopo la creazione e l'inizializzazione del suddetto file, cliccare su Load Script Configuration e NON su Sync Now, poiché la sincronizzazione di questo gradle verrà effettuata automaticamente. Nel caso in cui questo non dovesse succedere, effettuare la sincronizzazione del file manualmente.
• Nella directory buildSrc creare le seguenti directory annidate: src/main/java;
• Nella cartella java copiare i tre file (AppConfig.kt, Dependencies.kt e Versions.kt) presenti nella posizione omonima del progetto https://github.com/ministero-salute/it-dgc-verificaC19-android (quindi i tre file in https://github.com/ministero-salute/it-dgc-verificaC19-android/tree/develop-networkmanager/buildSrc/src/main/java).

Step 3

Contesto: Android (in Android Studio, selezionare la voce Android nel menu in alto a sinistra)

⚠️ Attenzione: Effettuare la sincronizzazione del gradle solo dopo il completamento dei punti che seguono:

• Nel build.gradle (Module) dell'app utente inserire le dipendenze implementation project(':dgc-sdk') e implementation project(':decoder') come nel relativo file del progetto verificac19 https://github.com/ministero-salute/it-dgc-verificaC19-android/blob/2b42ac96d0219f82d8025a8e9fd4673a06671740/app/build.gradle#L145 e https://github.com/ministero-salute/it-dgc-verificaC19-android/blob/2b42ac96d0219f82d8025a8e9fd4673a06671740/app/build.gradle#L146;
• Inizializzare il settings.gradle dell'app utente come riportato nel README del repository dell'SDK; se il file è già stato popolato con del codice automaticamente, eliminare il codice presente e sostituire con le righe di codice riportate in quella sezione; il settings può essere poi modificato con ulteriore codice necessario per la app custom
• Copiare il contenuto dei file gradle Project e Module del progetto https://github.com/ministero-salute/it-dgc-verificaC19-android nei gradle dell'app utente;
• Effettuare la sincronizzazione dei file gradle.

Uso

L'applicazione di verifica dovrà importare la componente decoder e SDK. Nel file settings.gradle è necessario aggiungere le seguenti informazioni (da cambiare a seconda della struttura delle directory del progetto):

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")

A questo punto è possibile inizializzare il workmanager (LoadKeysWorker) posizionato in it.ministerodellasalute.verificaC19sdk.worker.LoadKeysWorker che consente di sincronizzare le regole di validazione e i certificati di firma prima di iniziare ad utilizzare l'applicazione.

Tra i parametri restituiti dalle API REST, c'è la Minimum SDK Version.
Questo valore è confrontato con la versione corrente dell'SDK presente in BuildConfig.SDK_VERSION, tramite il metodo it.ministerodellasalute.verificaC19sdk.model.FirstViewModel#isSDKVersionObsoleted, in modo da garantire che la versione di SDK utilizzata non sia obsoleta e potenzialmente non valida. Nel caso in cui la versione di SDK utilizzata sia inferiore a quella restituita dalle API REST, l'SDK lancerà una VerificaMinSDKVersionException che potrebbe causare un crash dell'applicazione se non gestita correttamente.

A questo punto è possibile utilizzare una libreria di scansione di QR Code a scelta che, dopo aver letto un QR Code di un EU DCC, passi la stringa estratta a
it.ministerodellasalute.verificaC19sdk.model.VerificationViewModel#init.

Esempio:

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

Osservando la risposta del metodo, un Certificate object è restituito it.ministerodellasalute.verificaC19sdk.model.CertificateSimple che contiene il risultato della verifica. Il data model contiene i dati relativi alla persona, la data di nascita, il timestamp di verifica e lo stato della verifica.

Basandosi su questi dati è possibile disegnare la UI e fornire all'operatore lo stato della verifica del DCC.

Contribuzione

Ogni contributo è ben accetto. Prima di procedere è buona norma consultare il Code of Conduct per ottenere una aiuto relativamente alle modalità di approccio alla community. Inoltre è possibile consultare il file CONTRIBUTING che contiene le informazioni pratiche per assicurare una contribuzione efficace e efficiente.

Contributori

Qui c'è una lista di contributori. Grazie per essere partecipi nel miglioramento del progetto giorno dopo giorno!

Licenza

Autori / Copyright

Copyright 2021 (c) Ministero della Salute.

Il file AUTHORS contiene le informazioni sugli autori.

Dettaglio Licenza

La licenza per questo repository è una Apache License 2.0. All'interno del file LICENSE sono presenti le informazioni specifiche.