Merge pull request #17 from smart-on-fhir/directory-filter-bad-issuers

omit issuer that fail validation from Directory

CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGE LOG
 
+## v1.1.1
+- Added option to omit malformed issuers from a Directory instead of failing the entire Directory (this is now the default)
+
 ## v1.1.0
 - Add revocation support
 - Add Directory class

package.json

@@ -1,6 +1,6 @@
 {
   "name": "smart-health-card-decoder",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "API for decoding a QR encoded SMART Health Card",
   "main": "esm/index.js",
   "types": "esm/index.d.ts",

src/directory.ts

@@ -268,7 +268,7 @@ async function createFromUrl(url: string, context: Context): Promise<[IDirectory
         return [undefDirectory, context];
     }
 
-    if (!(await validate(downloaded as IDirectory, context))) {
+    if ( (await validate(downloaded as IDirectory, context)) === false && context.options.validation?.directory?.ommitBadIssuers === false ) {
         return [undefDirectory, context];
     }
 

src/issuer.info.ts

@@ -22,8 +22,19 @@ export async function validate(issuerInfos: IssuerInfo[], context: Context): Pro
         return Promise.resolve(false);
     }
 
+    const badIssuers: IssuerInfo[] = [];
     for (const ii of issuerInfos) {
-        await validateSingle(ii, context);
+        const success = await validateSingle(ii, context);
+        if (!success && context.options.validation?.directory?.ommitBadIssuers !== false) {
+            badIssuers.push(ii);
+            log.error(`Issuer "${ii.issuer.name || ii.issuer.iss}" failed validation and was omitted from the Directory`);
+        }
+    }
+
+    if (badIssuers.length) {
+        badIssuers.forEach(ii => {
+            issuerInfos.splice(issuerInfos.indexOf(ii), 1);
+        })
     }
 
     if (context.options.validation?.directory?.allowDuplicates !== true) {
@@ -53,9 +64,9 @@ async function validateSingle(issuerInfo: IssuerInfo, context: Context): Promise
     await key.validate.keys(issuerInfo.keys, context);
 
     // rewrite the error labels adding the iss so the error output can be traced
-    if(context.errors?.length ?? 0 > (errorCount ?? 0) ) {
+    if (context.errors?.length ?? 0 > (errorCount ?? 0)) {
         for (let index = (errorCount ?? 0); index < (context.errors?.length ?? 0); index++) {
-            context.errors![index].label = `KEY:${issuerInfo.issuer.iss}`;            
+            context.errors![index].label = `KEY:${issuerInfo.issuer.iss}`;
         }
     }
 

src/types.ts

@@ -133,7 +133,8 @@ export interface DirectoryOptions {
         filterBadKeys?: boolean
     },
     directory?: {
-        allowDuplicates?: boolean
+        allowDuplicates?: boolean,
+        ommitBadIssuers?: boolean
     }
 }