Merge branch 'master' into DXCDT-1261-bot-detection-support

Author: kushalshit27

src/tools/auth0/handlers/clients.ts

@@ -160,6 +160,15 @@ export const schema = {
           enum: ['email', 'organization_name'],
         },
       },
+      async_approval_notification_channels: {
+        type: ['array', 'null'],
+        description:
+          'An ordered array of notification channels enabled for CIBA (Client-Initiated Backchannel Authentication) requests. Channels are evaluated in the order specified.',
+        items: {
+          type: 'string',
+          enum: ['guardian-push', 'email'],
+        },
+      },
       skip_non_verifiable_callback_uri_confirmation_prompt: {
         type: ['boolean', 'null'],
         description: 'Whether to skip the confirmation prompt for non-verifiable callback URIs',

test/context/directory/clients.test.js

@@ -153,4 +153,72 @@ describe('#directory context clients', () => {
       context.assets.clients[1]
     );
   });
+
+  it('should process clients with async_approval_notification_channels', async () => {
+    const files = {
+      [constants.CLIENTS_DIRECTORY]: {
+        'cibaClient.json':
+          '{ "app_type": "spa", "name": "cibaClient", "async_approval_notification_channels": ["email", "guardian-push"] }',
+        'channelClient.json':
+          '{ "app_type": "native", "name": "channelClient", "async_approval_notification_channels": @@channels@@ }',
+      },
+    };
+
+    const repoDir = path.join(testDataDir, 'directory', 'clientsWithChannels');
+    createDir(repoDir, files);
+
+    const config = {
+      AUTH0_INPUT_FILE: repoDir,
+      AUTH0_KEYWORD_REPLACE_MAPPINGS: { channels: ['guardian-push'] },
+    };
+    const context = new Context(config, mockMgmtClient());
+    await context.loadAssetsFromLocal();
+
+    const target = [
+      {
+        app_type: 'native',
+        name: 'channelClient',
+        async_approval_notification_channels: ['guardian-push'],
+      },
+      {
+        app_type: 'spa',
+        name: 'cibaClient',
+        async_approval_notification_channels: ['email', 'guardian-push'],
+      },
+    ];
+
+    expect(context.assets.clients).to.deep.equal(target);
+  });
+
+  it('should dump clients with async_approval_notification_channels', async () => {
+    const dir = path.join(testDataDir, 'directory', 'clientsChannelsDump');
+    cleanThenMkdir(dir);
+    const context = new Context({ AUTH0_INPUT_FILE: dir }, mockMgmtClient());
+
+    context.assets.clients = [
+      {
+        app_type: 'spa',
+        name: 'cibaClient',
+        async_approval_notification_channels: ['guardian-push', 'email'],
+      },
+      {
+        app_type: 'native',
+        name: 'standardClient',
+      },
+    ];
+
+    await handler.dump(context);
+    const clientFolder = path.join(dir, constants.CLIENTS_DIRECTORY);
+
+    expect(loadJSON(path.join(clientFolder, 'cibaClient.json'))).to.deep.equal({
+      app_type: 'spa',
+      name: 'cibaClient',
+      async_approval_notification_channels: ['guardian-push', 'email'],
+    });
+
+    expect(loadJSON(path.join(clientFolder, 'standardClient.json'))).to.deep.equal({
+      app_type: 'native',
+      name: 'standardClient',
+    });
+  });
 });

test/context/yaml/clients.test.js

@@ -110,4 +110,85 @@ describe('#YAML context clients', () => {
       fs.readFileSync(path.join(clientsFolder, 'customLoginClient_custom_login_page.html'), 'utf8')
     ).to.deep.equal('html code');
   });
+
+  it('should process clients with async_approval_notification_channels', async () => {
+    const dir = path.join(testDataDir, 'yaml', 'clientsWithChannels');
+    cleanThenMkdir(dir);
+
+    const yaml = `
+    clients:
+      -
+        name: "cibaClient"
+        app_type: "spa"
+        async_approval_notification_channels: ['guardian-push', 'email']
+      -
+        name: "emailOnlyClient"
+        app_type: "native"
+        async_approval_notification_channels: @@channels@@
+    `;
+
+    const target = [
+      {
+        name: 'cibaClient',
+        app_type: 'spa',
+        async_approval_notification_channels: ['guardian-push', 'email'],
+      },
+      {
+        name: 'emailOnlyClient',
+        app_type: 'native',
+        async_approval_notification_channels: ['email'],
+      },
+    ];
+
+    const yamlFile = path.join(dir, 'clients.yaml');
+    fs.writeFileSync(yamlFile, yaml);
+
+    const config = {
+      AUTH0_INPUT_FILE: yamlFile,
+      AUTH0_KEYWORD_REPLACE_MAPPINGS: { channels: ['email'] },
+    };
+    const context = new Context(config, mockMgmtClient());
+    await context.loadAssetsFromLocal();
+
+    expect(context.assets.clients).to.deep.equal(target);
+  });
+
+  it('should dump clients with async_approval_notification_channels', async () => {
+    const dir = path.join(testDataDir, 'yaml', 'clientsChannelsDump');
+    cleanThenMkdir(dir);
+    const context = new Context(
+      { AUTH0_INPUT_FILE: path.join(dir, './test.yml') },
+      mockMgmtClient()
+    );
+
+    const clients = [
+      {
+        name: 'cibaClient',
+        app_type: 'spa',
+        async_approval_notification_channels: ['email', 'guardian-push'],
+      },
+      {
+        name: 'standardClient',
+        app_type: 'native',
+      },
+    ];
+
+    const target = [
+      {
+        name: 'cibaClient',
+        app_type: 'spa',
+        async_approval_notification_channels: ['email', 'guardian-push'],
+      },
+      {
+        name: 'standardClient',
+        app_type: 'native',
+      },
+    ];
+
+    context.assets.clients = clients;
+
+    const dumped = await handler.dump(context);
+
+    expect(dumped).to.deep.equal({ clients: target });
+  });
 });

test/tools/auth0/handlers/clients.tests.js

@@ -635,6 +635,7 @@ describe('#clients handler', () => {
         organization_usage: 'require',
         organization_require_behavior: 'pre_login_prompt',
         organization_discovery_methods: ['email'],
+        async_approval_notification_channels: ['guardian-push'],
       };
 
       const auth0 = {
@@ -647,6 +648,7 @@ describe('#clients handler', () => {
             expect(data.organization_usage).to.equal('require');
             expect(data.organization_require_behavior).to.equal('pre_login_prompt');
             expect(data.organization_discovery_methods).to.deep.equal(['email']);
+            expect(data.async_approval_notification_channels).to.deep.equal(['guardian-push']);
             return Promise.resolve({ data });
           },
           update: () => Promise.resolve({ data: [] }),
@@ -668,6 +670,7 @@ describe('#clients handler', () => {
         organization_usage: 'require',
         organization_require_behavior: 'pre_login_prompt',
         organization_discovery_methods: ['organization_name', 'email'],
+        async_approval_notification_channels: ['email', 'guardian-push'],
       };
 
       const auth0 = {
@@ -678,6 +681,10 @@ describe('#clients handler', () => {
               'organization_name',
               'email',
             ]);
+            expect(data.async_approval_notification_channels).to.deep.equal([
+              'email',
+              'guardian-push',
+            ]);
             return Promise.resolve({ data });
           },
           update: () => Promise.resolve({ data: [] }),
@@ -745,6 +752,8 @@ describe('#clients handler', () => {
             expect(data.organization_require_behavior).to.equal('post_login_prompt');
             // eslint-disable-next-line no-unused-expressions
             expect(data.organization_discovery_methods).to.be.null;
+            // eslint-disable-next-line no-unused-expressions
+            expect(data.async_approval_notification_channels).to.be.null;
             return Promise.resolve({ data });
           },
           delete: () => Promise.resolve({ data: [] }),
@@ -756,6 +765,7 @@ describe('#clients handler', () => {
                 organization_usage: 'allow',
                 organization_require_behavior: 'pre_login_prompt',
                 organization_discovery_methods: ['email'],
+                async_approval_notification_channels: ['guardian-push', 'email'],
               },
             ]),
         },
@@ -772,6 +782,7 @@ describe('#clients handler', () => {
               name: 'My Client',
               organization_require_behavior: 'post_login_prompt',
               organization_discovery_methods: null,
+              async_approval_notification_channels: null,
             },
           ],
         },