Merge pull request #28 from lucadentella/feat/official-sdk

Feat/official sdk

README.md

@@ -9,18 +9,20 @@ Raspberry appliance to verify EU [Digital Green Certificates](https://ec.europa.
 
 ## What's new :tada:
 
+ - 18/12/2021, new major version, with **official SDK**, **Super DGC** and **scheduled updates**
  - 07/11/2021, check italian **UVCI blacklist**  
  - 07/11/2021, accept Sputnik-V for **San Marino** citizens
 
 ## Features :trophy:
 
+ - Fully **compliant to italian law** (Offical SDK used)
  - Performs a **complete** validation (signature and business rules)
  - Automatically **downloads** the list of valid keys and rules
  - Supports the **official** Raspberry Pi camera
  - Has a **modular** architecture (client/server)
  - Can run on **any** recent Raspberry Pi boards
  - Can **display** the video captured by the camera
- - A browser-based client is also included
+ - A **browser-based** client is also included
 
 ![](https://github.com/lucadentella/raspberry-dgc/raw/main/images/architecture.png)
 

documentation/businessrules.md

@@ -2,40 +2,20 @@
 
 The validatorServer included in this project applies **italian** business rules.
 
-Depending on the content of the green code, 3 checks are performed (in [app.js](https://github.com/lucadentella/raspberry-dgc/tree/main/validatorServer/app.js)):
+To make this project compliant with italian law, the [Official SDK](https://github.com/italia/verificac19-sdk) is now used.
 
-    // 1. vaccination
-    if(dcc.payload.v) validate = vaccination.validateVaccination(settings, dcc);
-
-    // 2. test
-    if(dcc.payload.t) validate = test.validateTest(settings, dcc);
-
-    // 3. recovery
-    if(dcc.payload.r) validate = recovery.validateRecovery(settings, dcc);
-
-The *validate* functions are defined in specific js files, included in the main program:
-
-    const vaccination = require("./vaccination.js")
-    const test = require("./test.js")
-    const recovery = require("./recovery.js")
-
-The parameters used to apply the business rules are downloaded from the italian Ministry of Health website in JSON format:
-
-	const urlSettings = "https://get.dgc.gov.it/v1/dgc/settings";
-
-The name of each parameter is defined as constant:
+Validation is performed by SDK, using the `Validator` object:
 
-	const VACCINE_START_DAY_NOT_COMPLETE = "vaccine_start_day_not_complete";
-	const VACCINE_END_DAY_NOT_COMPLETE = "vaccine_end_day_not_complete";
+    let validationResult;
+    if(scanMode == "2G") validationResult = await Validator.validate(dcc, Validator.mode.SUPER_DGP); 
+    else validationResult = await Validator.validate(dcc); 
 
-Depending on the format used by the single European country, it may therefore be necessary to:
-
- - change the URL
- - change the name of the parameters
+If you want to change the server behavior, you have to replace the code with your country's specific rules.
 
 ## Rules API :information_source:
 
 Some countries publish the **rules**, not the parameters.
 
-The dcc-utils library does support the rule format defined by the EU, check [the example](https://github.com/ministero-salute/dcc-utils/blob/master/examples/check_rules_from_api.js) provided. 
+The Italian SDK is based on [dcc-utils] library, that is a more generic library to decode and validate DGCs.
 
+The dcc-utils library does support the rule format defined by the EU, check [the example](https://github.com/ministero-salute/dcc-utils/blob/master/examples/check_rules_from_api.js) provided. 

documentation/faq.md

@@ -40,6 +40,32 @@ When true, validatorServer returns holder details in the response:
 
 ![](https://github.com/lucadentella/raspberry-dgc/raw/main/images/holder-details.png)
 
+**How can I get the detailed information about the result?**
+
+In `app.js` set this constant to **true**:
+
+    const ADD_DETAILED_MESSAGE = true;
+
+When true, validatorServer returns detailed information about the scan result:
+
+![](https://github.com/lucadentella/raspberry-dgc/raw/main/images/scan-details.png)
+
+**How can I ask for "Super DGC" scan?**
+
+"Super DGC" means a green pass issued for vaccine or recovery only (not after a Covid test).
+
+In the query string, add `scanMode=2G`:
+
+![](https://github.com/lucadentella/raspberry-dgc/raw/main/images/scan-mode.png)
+
+**How can I change the update frequency?**
+
+In `app.js` change the default schedule - every 1 hour (in a cron-like form):
+
+    cron.schedule('0 * * * *', async () => {
+
+You can use [Crontab Generator](https://crontab-generator.org/) to obtain the correct syntax.
+
 **How can I use test DGCs?**
 
 This Github repository ([dgc-testdata](https://github.com/eu-digital-green-certificates/dgc-testdata)) collects test data of different member states. 

validatorServer/.cache/signatureslist.json

@@ -0,0 +1,269 @@
+[
+ "25QCxBrBJvA=",
+ "NAyCKly+hCg=",
+ "ODqaG8mnbro=",
+ "e4lH6I4iMIM=",
+ "vvYa1vaWkGg=",
+ "NJpCsMLQco4=",
+ "/IcqIBnnZzc=",
+ "3IsdmTYkAAM=",
+ "4Qmniw7B0gc=",
+ "6ag2wJkSHtk=",
+ "ARrNkCRtprY=",
+ "BEnvMVnNFK8=",
+ "FDNJjaSCWi0=",
+ "GMFMBu1RlCg=",
+ "GuQPQRxbMsU=",
+ "IaGR283U1jA=",
+ "JHd4CkNzadI=",
+ "Jjql9rBrjHI=",
+ "L7XIA2gi2ps=",
+ "MtI93IMknMk=",
+ "NCc6YSsVioM=",
+ "YRYidQ+wetg=",
+ "YU9+X9nepqU=",
+ "ZcfkloEvfGQ=",
+ "dhSzPDr4G2M=",
+ "e9SH8dtWwdY=",
+ "hgpHHrTb4ws=",
+ "nPKEYm3gXzU=",
+ "qFNF2dC+mjQ=",
+ "tCM87WnaaQE=",
+ "ub6Qmv9xtAo=",
+ "x3ch4ml934I=",
+ "02vdAOY/+gI=",
+ "0kAwFy+vLpg=",
+ "1+da8dKEjlE=",
+ "2BGoyFIyYPs=",
+ "3LCRmucB9kU=",
+ "3jqajzfHpKE=",
+ "3lrBUHc4iQE=",
+ "5xtSr6KkAGA=",
+ "6FNkACSMLEc=",
+ "7XLhQx1KXdQ=",
+ "8AnF/hcilSo=",
+ "AQCGDydsS1Q=",
+ "CvktK3hdjeY=",
+ "DusseXrzqO8=",
+ "EzYR1uk/E0I=",
+ "IZftFLRmKGY=",
+ "Is2JtrOJhik=",
+ "MxhfdcoHinc=",
+ "NCdyt3s+cak=",
+ "OKpEjMo/2MY=",
+ "R7q7yd90ZPU=",
+ "TpQIkAHAym4=",
+ "Uj77p+qIQNs=",
+ "XuCERkHu8kY=",
+ "Yr8a8Rd+zqI=",
+ "ZDoFfkn+yhY=",
+ "bBnmkeVMV6A=",
+ "bKmas9wa5tc=",
+ "fNf883wPIEg=",
+ "hFpY/ySOrwI=",
+ "i5SVuCsR5TA=",
+ "izUDZjGtHWY=",
+ "juskqrNQf6k=",
+ "kjEx2H7huNE=",
+ "ln8K+9SqfuA=",
+ "lshLbYfCWRg=",
+ "nTrG8glLUls=",
+ "npo0ZWgdQSY=",
+ "sYXcYixrOGA=",
+ "vjm0I2ATJ+Y=",
+ "yWCRdph8XJs=",
+ "Pbydc1LscXo=",
+ "2JelGO/ymxQ=",
+ "3oYtiEZ9wp4=",
+ "M8bcnysCMj4=",
+ "TGjTR+Re+yk=",
+ "XkVWZqUeeFc=",
+ "r9YkEJZgi9k=",
+ "JkFekJel6/o=",
+ "e/YRqyv++qY=",
+ "jYpr5GHCDiQ=",
+ "90CNG8dcdn0=",
+ "7z8+6oww2a8=",
+ "Er5OTMwLd78=",
+ "cdm9Ymfwn2I=",
+ "KG9lzdohSY0=",
+ "2Yv0kajsIlA=",
+ "AX/m4PDDCXE=",
+ "BKBFhNFXWAU=",
+ "CvmI4xOoMj4=",
+ "G3jDFQ1oK0Q=",
+ "IMgNr10pfPQ=",
+ "Qe8D6lfZ5/Y=",
+ "Xo78qgBEx8k=",
+ "YDAy+yvD5lU=",
+ "YVpBYnLh1Hs=",
+ "Z7k1XpIWZOE=",
+ "e+bFdywyJQE=",
+ "eQOY6BDp+vM=",
+ "eUVY16rD2Kc=",
+ "fGLuvg6n5wk=",
+ "lrxgMs2Duac=",
+ "mo/w8S8rZ0Q=",
+ "pe6raiG2dWE=",
+ "rLMiGt6uB3U=",
+ "hA1+pwEOxCI=",
+ "7rZbUrXNlLk=",
+ "0L7AaIwu+EY=",
+ "6VdOPLF8/Fg=",
+ "9IZVOkJRZPQ=",
+ "9v3FozjKAUo=",
+ "c1XrnEBoj/c=",
+ "nHmZ5K96UY4=",
+ "rKMDA66RiLE=",
+ "rXP9L7xddL8=",
+ "vq08l/LTxhk=",
+ "wb/2450PPrc=",
+ "wtYpyAmNmdk=",
+ "6CDB1hL+uKU=",
+ "QacbC7DdD4U=",
+ "UZ1cSMaPcaQ=",
+ "3lTmAZX19GQ=",
+ "f+4yAPIGTWg=",
+ "pSEfhlMubh4=",
+ "4GkJs9YsYS4=",
+ "MrT00mhDxLQ=",
+ "7AfAwcpWOv0=",
+ "eNNsg2jd4wA=",
+ "HeWuzGwEM5c=",
+ "GvVR3e6VJIM=",
+ "bfoj2trt6bE=",
+ "ccgQ13tmkU8=",
+ "f6J92LRKpj0=",
+ "AN1EeLIMAmo=",
+ "PBpDVqnJ7Us=",
+ "Ll3NP03zOxY=",
+ "crm1HLAeaTo=",
+ "r9RtWK9x7dM=",
+ "2Bh+2HrOg0c=",
+ "lzGYCpOBQsU=",
+ "ryvXsisPPeU=",
+ "0JzyumjttZU=",
+ "H6b6bQ8qij4=",
+ "T8kbYovQlYU=",
+ "S2V5MVJF",
+ "S2V5MlJF",
+ "S2V5M1JF",
+ "S2V5NFJF",
+ "S2V5NVJF",
+ "S2V5MVBSTw==",
+ "S2V5MlBSTw==",
+ "S2V5M1BSTw==",
+ "S2V5NFBSTw==",
+ "S2V5NVBSTw==",
+ "4Ss2raOqhTw=",
+ "JsReuAsmza8=",
+ "ypEjzbYNqEw=",
+ "1J9pb87ndV0=",
+ "FhciF/j3plg=",
+ "gEIK4Q/lAG0=",
+ "26Fcjnjuf2s=",
+ "3aGO1ni4qKA=",
+ "Amn7EaBy1ag=",
+ "Cj0KwOpRFvQ=",
+ "LkrphwJykEw=",
+ "M+R7JFFk6G8=",
+ "MJuQDybecd4=",
+ "o11W81MgYYg=",
+ "qrdfSzqcjRc=",
+ "hHffSLS1AIU=",
+ "ZpnsokK1DgM=",
+ "fNstNUxgGSI=",
+ "l8W4rhh9nTs=",
+ "Ui7DXQikstE=",
+ "72XVTQ2A9Jw=",
+ "7byt9scureM=",
+ "EDSWY8Hnul4=",
+ "IKMstf8yj/4=",
+ "hWoyHrtJs+E=",
+ "cS/wou0g/po=",
+ "2eCjZcuOoEo=",
+ "d+WbDD8Gr5g=",
+ "hGUS4Zj9fLM=",
+ "l+UqotarLJc=",
+ "mqWkXpNR0Rk=",
+ "ohI9KlFR2P8=",
+ "rVPuf3yKLBg=",
+ "c3ByZGtleTE=",
+ "c3ByZGtleTI=",
+ "d3ByZGtleTE=",
+ "d3ByZGtleTI=",
+ "FtUwA9uHJoo=",
+ "Pcl7yBWEQ7c=",
+ "0oCvyNKB210=",
+ "14QQ1b6JFLk=",
+ "5IJmAxfUwrM=",
+ "768E5xdq4Eg=",
+ "Of6ltPMXuJo=",
+ "UcuKeuV1sys=",
+ "oGix7vDtlq4=",
+ "1MTFjluEWHU=",
+ "JZhMLV9Gyck=",
+ "TQeqi04M2ek=",
+ "oVKwwScGxuY=",
+ "rTEJEs6D1ik=",
+ "53FOjX/4aJs=",
+ "HhkeqvrtQ0U=",
+ "KBPNEuXUvrY=",
+ "1PtilTAMiyk=",
+ "I0+qkOLr2e0=",
+ "lYkujLws7SE=",
+ "osFRFyFIWdU=",
+ "1J9pb87ndV0=",
+ "26YSc5g0nG8=",
+ "W0NjksmJMm0=",
+ "udrotE0n7i0=",
+ "+cDVEVtFWME=",
+ "2YrkPPOntQQ=",
+ "2uMhJx5tEEU=",
+ "696cpdD4YGw=",
+ "UnanmcgtfUA=",
+ "V2i/L/Yb0Mo=",
+ "Yb1a+1WV/1Y=",
+ "ZsDoB5l3ETw=",
+ "eOvGe2r9RbA=",
+ "j95whXY9F8Y=",
+ "uy59WoRKBUg=",
+ "CGFUps8kh3M=",
+ "J8p9pf+5/9M=",
+ "IoybU6axZJE=",
+ "8hilYZIP6uI=",
+ "zrMytIH40Rk=",
+ "0NQWnxTv90c=",
+ "ZqPYe26eEEk=",
+ "dy8HnMQYOrE=",
+ "jIF6MH+OYkI=",
+ "oMpN3FsJYsQ=",
+ "p64sutu48UA=",
+ "YgBnrpZDGXk=",
+ "aCU0KJl+gMg=",
+ "SiEt1ct5otQ=",
+ "gcZRP1ogHyU=",
+ "AcOmDWpm7kI=",
+ "6ptpKJA1J90=",
+ "sG0xboj/6v0=",
+ "3PjDrYgWm+s=",
+ "Pp2KBZWzfPI=",
+ "kom9zby5Hiw=",
+ "gNhlvKFJfEE=",
+ "+vl/c99Cv/8=",
+ "5mk4KIRSvlM=",
+ "9ZM955dYrd0=",
+ "EZpzoO2Syjs=",
+ "GAv21gzmBiA=",
+ "LZ4Ck5tRT6c=",
+ "TZOsCFsE2pM=",
+ "Y55zlUWHDAA=",
+ "jpwzcM43mR4=",
+ "mMUibqGOjas=",
+ "4vUVzV7f6kg=",
+ "ltgfqrs8IdI=",
+ "CiIlK77HFz0=",
+ "b6DvtaUKH6Y=",
+ "WhTtEgoip/Q=",
+ "MelIsUdzjbY="
+]