feat: helper function to decide whether to validate client.sector_ide…

…ntifier_uri See `sectorIdentifierUriValidate`
panva · Feb 28, 2021 · 72058a5 · 72058a5
1 parent 202e4c5
commit 72058a5
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 4 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -468,6 +468,7 @@ location / {
 - [revokeGrantPolicy](#revokegrantpolicy)
 - [rotateRefreshToken](#rotaterefreshtoken)
 - [routes](#routes)
+- [sectorIdentifierUriValidate](#sectoridentifierurivalidate)
 - [scopes](#scopes)
 - [subjectTypes](#subjecttypes)
 - [tokenEndpointAuthMethods](#tokenendpointauthmethods)
@@ -2384,7 +2385,7 @@ new Prompt(
       return Check.REQUEST_PROMPT;
     }
 
-    if (oidc.client.sectorIdentifier) {
+    if (oidc.client.subjectType === 'pairwise') {
       sub = await instance(oidc.provider).configuration('pairwiseIdentifier')(ctx, sub, oidc.client);
     }
 
@@ -2407,7 +2408,7 @@ new Prompt(
       return Check.REQUEST_PROMPT;
     }
 
-    if (oidc.client.sectorIdentifier) {
+    if (oidc.client.subjectType === 'pairwise') {
       sub = await instance(oidc.provider).configuration('pairwiseIdentifier')(ctx, sub, oidc.client);
     }
 
@@ -2862,6 +2863,19 @@ _**default value**_:
 ]
 ```
 
+### sectorIdentifierUriValidate
+
+Function called to make a decision about whether sectorIdentifierUri of a client being loaded, registered, or updated should be fetched and its contents validated against the client metadata.  
+
+
+_**default value**_:
+```js
+function sectorIdentifierUriValidate(client) {
+  // @param client - the Client instance
+  return true;
+}
+```
+
 ### subjectTypes
 
 Array of the Subject Identifier types that this OP supports. When only `pairwise` is supported it becomes the default `subject_type` client metadata value. Valid types are

diff --git a/lib/helpers/defaults.js b/lib/helpers/defaults.js
@@ -464,6 +464,11 @@ function revokeGrantPolicy(ctx) {
   return true;
 }
 
+function sectorIdentifierUriValidate(client) {
+  // @param client - the Client instance
+  return true;
+}
+
 function getDefaults() {
   const defaults = {
 
@@ -2144,6 +2149,15 @@ function getDefaults() {
      */
     revokeGrantPolicy,
 
+    /*
+     * sectorIdentifierUriValidate
+     *
+     * description: Function called to make a decision about whether sectorIdentifierUri of
+     * a client being loaded, registered, or updated should be fetched and its contents
+     * validated against the client metadata.
+     */
+    sectorIdentifierUriValidate,
+
     /*
      * interactions
      *

diff --git a/lib/models/client.js b/lib/models/client.js
@@ -225,6 +225,9 @@ module.exports = function getClient(provider) {
   }
 
   async function sectorValidate(client) {
+    if (!instance(provider).configuration('sectorIdentifierUriValidate')(client)) {
+      return;
+    }
     const { statusCode, body } = await request.call(provider, {
       method: 'GET',
       url: client.sectorIdentifierUri,
@@ -247,8 +250,6 @@ module.exports = function getClient(provider) {
     } catch (err) {
       throw new InvalidClientMetadata(err.message);
     }
-
-    return client;
   }
 
   function buildKeyStore(client) {