release 0.22.0 (#294)

package.json

@@ -1,13 +1,13 @@
 {
   "name": "rules-templates",
-  "version": "0.21.0",
+  "version": "0.22.0",
   "description": "Auth0 Rules Repository",
   "main": "./rules",
   "scripts": {
     "validate": "node validator.js",
     "build": "node build && npm run validate",
     "format": "prettier --write src/rules",
-    "release": "npm run format && npm test && npm run build",
+    "release": "npm run format && npm test && npm run build && npm run validate",
     "deploy": "node deploy.js",
     "test": "jest"
   },

rules.json

@@ -519,7 +519,7 @@
           "marketplace"
         ],
         "description": "<p>Please see the <a href=\"https://marketplace.auth0.com/integrations/incognia-authentication\">Incognia Authentication integration</a> for more information and detailed installation instructions.</p>\n<p><strong>Required configuration</strong> (this Rule will be skipped if any of the below are not defined):</p>\n<ul>\n<li><code>INCOGNIA_CLIENT_ID</code>: The client ID obtained from Incognia's dashboard (My Apps &gt; API Credentials)</li>\n<li><code>INCOGNIA_CLIENT_SECRET</code>: The client secret obtained from Incognia's dashboard (My Apps &gt; API Credentials)</li>\n</ul>",
-        "code": "async function incogniaAuthenticationRule(user, context, callback) {\n  const _ = require('[email protected]');\n\n  const { IncogniaAPI } = require('@incognia/[email protected]');\n\n  const { INCOGNIA_CLIENT_ID, INCOGNIA_CLIENT_SECRET } = configuration;\n\n  if (!INCOGNIA_CLIENT_ID || !INCOGNIA_CLIENT_SECRET) {\n    console.log('Missing required configuration. Skipping.');\n    return callback(null, user, context);\n  }\n\n  const installationId = _.get(\n    context,\n    'request.query.incognia_installation_id'\n  );\n  if (!installationId) {\n    console.log('Missing installation_id. Skipping.');\n    return callback(null, user, context);\n  }\n\n  const accountId = _.get(user, 'user_id');\n  if (!accountId) {\n    console.log('Missing user_id. Skipping.');\n    return callback(null, user, context);\n  }\n\n  let incogniaAPI;\n  if (global.incogniaAPI) {\n    incogniaAPI = global.incogniaAPI;\n  } else {\n    incogniaAPI = new IncogniaAPI({\n      clientId: INCOGNIA_CLIENT_ID,\n      clientSecret: INCOGNIA_CLIENT_SECRET\n    });\n    global.incogniaAPI = incogniaAPI;\n  }\n\n  try {\n    const loginAssessment = await incogniaAPI.registerLoginAssessment({\n      installationId: installationId,\n      accountId: accountId\n    });\n\n    // Incognia's risk assessment will be in a namespaced claim so it can be used in other rules\n    // for skipping/prompting MFA or in the mobile app itself to decide whether the user should be\n    // redirected to step-up auth for example.\n    context.idToken['https://www.incognia.com/assessment'] =\n      loginAssessment.riskAssessment;\n  } catch (error) {\n    console.log('Error calling Incognia API for a new login.');\n    return callback(error);\n  }\n\n  return callback(null, user, context);\n}"
+        "code": "async function incogniaAuthenticationRule(user, context, callback) {\n  const _ = require('[email protected]');\n\n  const { IncogniaAPI } = require('@incognia/[email protected]');\n\n  const {\n    INCOGNIA_CLIENT_ID,\n    INCOGNIA_CLIENT_SECRET,\n    INCOGNIA_REGION\n  } = configuration;\n\n  if (!INCOGNIA_CLIENT_ID || !INCOGNIA_CLIENT_SECRET) {\n    console.log('Missing required configuration. Skipping.');\n    return callback(null, user, context);\n  }\n\n  const installationId = _.get(\n    context,\n    'request.query.incognia_installation_id'\n  );\n  if (!installationId) {\n    console.log('Missing installation_id. Skipping.');\n    return callback(null, user, context);\n  }\n\n  const accountId = _.get(user, 'user_id');\n  if (!accountId) {\n    console.log('Missing user_id. Skipping.');\n    return callback(null, user, context);\n  }\n\n  let incogniaAPI;\n  if (global.incogniaAPI) {\n    incogniaAPI = global.incogniaAPI;\n  } else {\n    incogniaAPI = new IncogniaAPI({\n      clientId: INCOGNIA_CLIENT_ID,\n      clientSecret: INCOGNIA_CLIENT_SECRET,\n      region: INCOGNIA_REGION\n    });\n    global.incogniaAPI = incogniaAPI;\n  }\n\n  try {\n    const loginAssessment = await incogniaAPI.registerLoginAssessment({\n      installationId: installationId,\n      accountId: accountId\n    });\n\n    // Incognia's risk assessment will be in a namespaced claim so it can be used in other rules\n    // for skipping/prompting MFA or in the mobile app itself to decide whether the user should be\n    // redirected to step-up auth for example.\n    context.idToken['https://www.incognia.com/assessment'] =\n      loginAssessment.riskAssessment;\n  } catch (error) {\n    console.log('Error calling Incognia API for a new login.');\n    return callback(error);\n  }\n\n  return callback(null, user, context);\n}"
       },
       {
         "id": "incognia-onboarding",
@@ -529,7 +529,7 @@
           "marketplace"
         ],
         "description": "<p>Please see the <a href=\"https://marketplace.auth0.com/integrations/incognia-onboarding\">Incognia Onboarding integration</a> for more information and detailed installation instructions.</p>\n<p><strong>Required configuration</strong> (this Rule will be skipped if any of the below are not defined):</p>\n<ul>\n<li><code>INCOGNIA_CLIENT_ID</code>: The client ID obtained from Incognia's dashboard (My Apps &gt; API Credentials)</li>\n<li><code>INCOGNIA_CLIENT_SECRET</code>: The client secret obtained from Incognia's dashboard (My Apps &gt; API Credentials)</li>\n</ul>",
-        "code": "async function incogniaOnboardingRule(user, context, callback) {\n  const _ = require('[email protected]');\n\n  const { IncogniaAPI } = require('@incognia/[email protected]');\n  const { Auth0UserUpdateUtilities } = require('@auth0/[email protected]');\n\n  const {\n    INCOGNIA_CLIENT_ID,\n    INCOGNIA_CLIENT_SECRET,\n    INCOGNIA_HOME_ADDRESS_PROP\n  } = configuration;\n\n  if (!INCOGNIA_CLIENT_ID || !INCOGNIA_CLIENT_SECRET) {\n    console.log('Missing required configuration. Skipping.');\n    return callback(null, user, context);\n  }\n\n  const installationId = _.get(\n    context,\n    'request.query.incognia_installation_id'\n  );\n  if (!installationId) {\n    console.log('Missing installation_id. Skipping.');\n    return callback(null, user, context);\n  }\n\n  // User home address should be set using Auth0's Signup API for example. If the home address is\n  // not in 'user_metadata.home_address', please specify the path of the field inside the user\n  // object where the home address is through the INCOGNIA_HOME_ADDRESS_PROP configuration.\n  const homeAddressProp =\n    INCOGNIA_HOME_ADDRESS_PROP || 'user_metadata.home_address';\n  const homeAddress = _.get(user, homeAddressProp);\n  if (!homeAddress) {\n    console.log('Missing user home address. Skipping.');\n    return callback(null, user, context);\n  }\n\n  const userUtils = new Auth0UserUpdateUtilities(user, auth0, 'incognia');\n\n  const status = userUtils.getAppMeta('status');\n  // This rule was previously run and calculated the assessment successfully.\n  if (status && status !== 'pending') {\n    console.log(\n      'Assessment is already calculated or is unevaluable. Skipping.'\n    );\n    return callback(null, user, context);\n  }\n\n  let incogniaAPI;\n  if (global.incogniaAPI) {\n    incogniaAPI = global.incogniaAPI;\n  } else {\n    incogniaAPI = new IncogniaAPI({\n      clientId: INCOGNIA_CLIENT_ID,\n      clientSecret: INCOGNIA_CLIENT_SECRET\n    });\n    global.incogniaAPI = incogniaAPI;\n  }\n\n  let onboardingAssessment;\n  const signupId = userUtils.getAppMeta('signup_id');\n  // The rule was previously run, but Incognia could not assess the signup.\n  if (signupId) {\n    try {\n      onboardingAssessment = await incogniaAPI.getOnboardingAssessment(\n        signupId\n      );\n    } catch (error) {\n      console.log('Error calling Incognia API for signup previously submitted');\n      return callback(error);\n    }\n    // This is the first time the rule is being run with all necessary arguments.\n  } else {\n    try {\n      onboardingAssessment = await incogniaAPI.registerOnboardingAssessment({\n        installationId: installationId,\n        addressLine: homeAddress\n      });\n    } catch (error) {\n      console.log('Error calling Incognia API for new signup submission');\n      return callback(error);\n    }\n  }\n\n  /*\n   * Updates the status in the metadata now that the assessment was calculated. If the new\n   * assessment is valid, the status will go to evaluated and this rule won't be executed again.\n   * If Incognia still doesn't know how to assess the signup, it will try to calculate it again up\n   * to 48 hours after the first try.\n   */\n  const firstAssessmentAt = userUtils.getAppMeta('first_assessment_at');\n  let newStatus;\n  if (onboardingAssessment.riskAssessment !== 'unknown_risk') {\n    newStatus = 'evaluated';\n  } else if (!firstAssessmentAt) {\n    newStatus = 'pending';\n  } else {\n    const firstAssessmentAge =\n      Math.round(Date.now() / 1000) - firstAssessmentAt;\n    // 48 hours limit.\n    if (firstAssessmentAge > 172800) {\n      newStatus = 'unevaluable';\n    } else {\n      newStatus = 'pending';\n    }\n  }\n\n  const updatedMetadata = {\n    status: newStatus,\n    first_assessment_at: firstAssessmentAt || Math.round(Date.now() / 1000),\n    signup_id: onboardingAssessment.id,\n    assessment: onboardingAssessment\n  };\n\n  try {\n    userUtils.setAppMeta('incognia', updatedMetadata);\n    await userUtils.updateAppMeta();\n  } catch (error) {\n    console.log('Error calling Auth0 management API');\n    return callback(error);\n  }\n\n  return callback(null, user, context);\n}"
+        "code": "async function incogniaOnboardingRule(user, context, callback) {\n  const _ = require('[email protected]');\n\n  const { IncogniaAPI } = require('@incognia/[email protected]');\n  const { Auth0UserUpdateUtilities } = require('@auth0/[email protected]');\n\n  const {\n    INCOGNIA_CLIENT_ID,\n    INCOGNIA_CLIENT_SECRET,\n    INCOGNIA_REGION,\n    INCOGNIA_HOME_ADDRESS_PROP\n  } = configuration;\n\n  if (!INCOGNIA_CLIENT_ID || !INCOGNIA_CLIENT_SECRET) {\n    console.log('Missing required configuration. Skipping.');\n    return callback(null, user, context);\n  }\n\n  const installationId = _.get(\n    context,\n    'request.query.incognia_installation_id'\n  );\n  if (!installationId) {\n    console.log('Missing installation_id. Skipping.');\n    return callback(null, user, context);\n  }\n\n  // User home address should be set using Auth0's Signup API for example. If the home address is\n  // not in 'user_metadata.home_address', please specify the path of the field inside the user\n  // object where the home address is through the INCOGNIA_HOME_ADDRESS_PROP configuration.\n  const homeAddressProp =\n    INCOGNIA_HOME_ADDRESS_PROP || 'user_metadata.home_address';\n  const homeAddress = _.get(user, homeAddressProp);\n  if (!homeAddress) {\n    console.log('Missing user home address. Skipping.');\n    return callback(null, user, context);\n  }\n\n  const userUtils = new Auth0UserUpdateUtilities(user, auth0, 'incognia');\n\n  const status = userUtils.getAppMeta('status');\n  // This rule was previously run and calculated the assessment successfully.\n  if (status && status !== 'pending') {\n    console.log(\n      'Assessment is already calculated or is unevaluable. Skipping.'\n    );\n    return callback(null, user, context);\n  }\n\n  let incogniaAPI;\n  if (global.incogniaAPI) {\n    incogniaAPI = global.incogniaAPI;\n  } else {\n    incogniaAPI = new IncogniaAPI({\n      clientId: INCOGNIA_CLIENT_ID,\n      clientSecret: INCOGNIA_CLIENT_SECRET,\n      region: INCOGNIA_REGION\n    });\n    global.incogniaAPI = incogniaAPI;\n  }\n\n  let onboardingAssessment;\n  const signupId = userUtils.getAppMeta('signup_id');\n  // The rule was previously run, but Incognia could not assess the signup.\n  if (signupId) {\n    try {\n      onboardingAssessment = await incogniaAPI.getOnboardingAssessment(\n        signupId\n      );\n    } catch (error) {\n      console.log('Error calling Incognia API for signup previously submitted');\n      return callback(error);\n    }\n    // This is the first time the rule is being run with all necessary arguments.\n  } else {\n    try {\n      onboardingAssessment = await incogniaAPI.registerOnboardingAssessment({\n        installationId: installationId,\n        addressLine: homeAddress\n      });\n    } catch (error) {\n      console.log('Error calling Incognia API for new signup submission');\n      return callback(error);\n    }\n  }\n\n  /*\n   * Updates the status in the metadata now that the assessment was calculated. If the new\n   * assessment is valid, the status will go to evaluated and this rule won't be executed again.\n   * If Incognia still doesn't know how to assess the signup, it will try to calculate it again up\n   * to 48 hours after the first try.\n   */\n  const firstAssessmentAt = userUtils.getAppMeta('first_assessment_at');\n  let newStatus;\n  if (onboardingAssessment.riskAssessment !== 'unknown_risk') {\n    newStatus = 'evaluated';\n  } else if (!firstAssessmentAt) {\n    newStatus = 'pending';\n  } else {\n    const firstAssessmentAge =\n      Math.round(Date.now() / 1000) - firstAssessmentAt;\n    // 48 hours limit.\n    if (firstAssessmentAge > 172800) {\n      newStatus = 'unevaluable';\n    } else {\n      newStatus = 'pending';\n    }\n  }\n\n  const updatedMetadata = {\n    status: newStatus,\n    first_assessment_at: firstAssessmentAt || Math.round(Date.now() / 1000),\n    signup_id: onboardingAssessment.id,\n    assessment: onboardingAssessment\n  };\n\n  try {\n    userUtils.setAppMeta('incognia', updatedMetadata);\n    await userUtils.updateAppMeta();\n  } catch (error) {\n    console.log('Error calling Auth0 management API');\n    return callback(error);\n  }\n\n  return callback(null, user, context);\n}"
       },
       {
         "id": "mylife-digital-progressive-consent",

src/rules/incognia-authentication.js

@@ -17,7 +17,11 @@ async function incogniaAuthenticationRule(user, context, callback) {
 
   const { IncogniaAPI } = require('@incognia/[email protected]');
 
-  const { INCOGNIA_CLIENT_ID, INCOGNIA_CLIENT_SECRET, INCOGNIA_REGION } = configuration;
+  const {
+    INCOGNIA_CLIENT_ID,
+    INCOGNIA_CLIENT_SECRET,
+    INCOGNIA_REGION
+  } = configuration;
 
   if (!INCOGNIA_CLIENT_ID || !INCOGNIA_CLIENT_SECRET) {
     console.log('Missing required configuration. Skipping.');