@continuoussecuritytooling/keycloak-reporter 0.8.3 → 0.8.5

package/CHANGELOG.md

@@ -1,9 +1,30 @@
-## [0.8.2](https://github.com/ContinuousSecurityTooling/keycloak-reporter/compare/v0.8.1...v0.8.2) (2023-12-15)
+## [0.8.5](https://github.com/ContinuousSecurityTooling/keycloak-reporter/compare/v0.8.4...v0.8.5) (2024-01-29)
 
 
 ### Bug Fixes
 
-* Fix GitHub pipeline
+* **Config:** Correcting TypeError on empty defaults ([c15a76a](https://github.com/ContinuousSecurityTooling/keycloak-reporter/commit/c15a76ade89cea682d56085c1bd789df67dc81e8))
+
+
+
+## [0.8.4](https://github.com/ContinuousSecurityTooling/keycloak-reporter/compare/0.8.4...v0.8.4) (2024-01-26)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @continuoussecuritytooling/keycloak-auditor to v1.1.5 ([003b858](https://github.com/ContinuousSecurityTooling/keycloak-reporter/commit/003b858aa36c34900fabe166ab318cd6d08399fe))
+* **deps:** update dependency @json2csv/node to v7.0.5 ([a391e73](https://github.com/ContinuousSecurityTooling/keycloak-reporter/commit/a391e73b10c0b89b2ab47b96967e7432cf1821a9))
+* **deps:** update dependency @keycloak/keycloak-admin-client to v23.0.3 ([e349e5b](https://github.com/ContinuousSecurityTooling/keycloak-reporter/commit/e349e5b291b133ee3c781be5237f13cd48c87b30))
+* **deps:** update dependency @keycloak/keycloak-admin-client to v23.0.4 ([025eca3](https://github.com/ContinuousSecurityTooling/keycloak-reporter/commit/025eca33069909a2897f28f52c948fb7a0aef039))
+* **deps:** update dependency @slack/webhook to v7.0.2 ([0a3519a](https://github.com/ContinuousSecurityTooling/keycloak-reporter/commit/0a3519ade828f9c05b963adf894c7ee22b2c6edd))
+* **deps:** update dependency npm to v10.3.0 ([371d62b](https://github.com/ContinuousSecurityTooling/keycloak-reporter/commit/371d62bcedc0aea9b878d1432642e9a5c4cfadf9))
+* **deps:** update dependency openid-client to v5.6.2 ([26809d4](https://github.com/ContinuousSecurityTooling/keycloak-reporter/commit/26809d4b8d2154bf3f38bb5d004d0d59f754ed7d))
+* **deps:** update dependency openid-client to v5.6.4 ([cf2e15f](https://github.com/ContinuousSecurityTooling/keycloak-reporter/commit/cf2e15f3bb85a70157acc2807947320dac5059f6))
+
+
+
+## [0.8.2](https://github.com/ContinuousSecurityTooling/keycloak-reporter/compare/v0.8.1...v0.8.2) (2023-12-15)
+
 
 
 ## [0.8.1](https://github.com/ContinuousSecurityTooling/keycloak-reporter/compare/v0.8.0...v0.8.1) (2023-12-15)
@@ -18,9 +39,6 @@
 
 # [0.8.0](https://github.com/ContinuousSecurityTooling/keycloak-reporter/compare/v0.7.2...v0.8.0) (2023-12-14)
 
-### Features
-
-* **Config:** Adding config validation and helm test hook ([c29e945](https://github.com/ContinuousSecurityTooling/keycloak-reporter/commit/c29e945567b4dfcdc9a10e710efa2b1a8c00f970))
 
 ### Bug Fixes
 
@@ -33,6 +51,12 @@
 * **deps:** update dependency npm to v10.2.5 ([52a3c8b](https://github.com/ContinuousSecurityTooling/keycloak-reporter/commit/52a3c8b48cbf0ee0d795aa00a9af36291025ae05))
 
 
+### Features
+
+* **Config:** Adding config validation and helm test hook ([c29e945](https://github.com/ContinuousSecurityTooling/keycloak-reporter/commit/c29e945567b4dfcdc9a10e710efa2b1a8c00f970))
+
+
+
 ## [0.7.2](https://github.com/ContinuousSecurityTooling/keycloak-reporter/compare/v0.7.1...v0.7.2) (2023-11-16)
 
 

package/charts/keycloak-reporter/Chart.yaml

@@ -15,14 +15,14 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 1.2.3
+version: 1.2.4
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
 # renovate: datasource=docker depName=ContinuousSecurityTooling/keycloak-reporter
-appVersion: '0.8.2'
+appVersion: '0.8.5'
 maintainers:
   # Martin Reinhardt
   - name: hypery2k

package/cli.ts

@@ -1,105 +1,11 @@
 #!/usr/bin/env node
 
-import { writeFileSync } from 'node:fs';
-import path from 'path';
 import yargs from 'yargs/yargs';
 import { hideBin } from 'yargs/helpers';
-import { configTest, listUsers, listClients, Options, convertJSON2CSV, post2Webhook } from './index.js';
+import { convert } from './lib/report.js';
+import { getConvertConfig, getKeycloakConfig } from './lib/utils.js';
+import { configTest, listUsers, listClients } from './index.js';
 import config from './src/config.js';
-class WebhookConfig {
-  type: string;
-  url: string;
-  title: string;
-  message?: string;
-  constructor(type: string, url: string, title: string, message?: string) {
-    this.type = type;
-    this.url = url;
-    this.title = title;
-    this.message = message;
-  }
-}
-
-class ReportConfig {
-  name: string;
-  directory: string;
-}
-
-function getKeycloakConfig(config, argv): Options {
-  return {
-    clientId: config.clientId ? config.clientId : (argv.clientId as string),
-    clientSecret: config.clientSecret ? config.clientSecret : (argv.clientSecret as string),
-    rootUrl: config.url ? config.url : (argv.url as string),
-    useAuditingEndpoint: argv.useAuditingEndpoint == true || config.useAuditingEndpoint.toLowerCase() == 'true',
-  };
-}
-
-function convertData(config, argv, name: string, title: string, json: object) {
-  convert(
-    config.format ? config.format : (argv.format as string),
-    config.output ? config.output : (argv.output as string),
-    {
-      name,
-      directory: argv.reports ? (argv.reports as string) : config.reports,
-    },
-    new WebhookConfig(
-      config.webhookType ? config.webhookType : (argv.webhookType as string),
-      config.webhookUrl ? config.webhookUrl : (argv.webhookUrl as string),
-      title,
-      config.webhookMessage ? config.webhookMessage : (argv.webhookMessage as string)
-    ),
-    json
-  );
-}
-
-async function convert(format: string, output: string, reports: ReportConfig, config: WebhookConfig, json: object) {
-  let outputContent: string;
-  switch (format) {
-    case 'csv':
-      outputContent = (await convertJSON2CSV(json)).toString();
-      break;
-    // defaulting to JSON
-    default:
-      outputContent = JSON.stringify(json);
-  }
-  if (reports.directory) {
-    const date = new Date();
-    writeFileSync(
-      path.join(
-        `${reports.directory}`,
-        `${reports.name}_${date.getFullYear()}-${date.getMonth() + 1}-${date.getDate()}.${format.toLowerCase()}`
-      ),
-      outputContent
-    );
-  }
-  switch (output) {
-    case 'webhook':
-      if (!config.url) {
-        console.error('No valid Webhook URL given');
-        throw new Error('Please provide a valid --webhookUrl parameter');
-      }
-      try {
-        console.log(`Sending report via webhook to ${config.type} ....`);
-        await post2Webhook(config.type, config.url, config.title, outputContent, config.message);
-        console.log('Done sending.');
-      } catch (e) {
-        switch (e.code || e.message) {
-          case 'Request failed with status code 400':
-            console.error('Invalid Teams Webhook Payload. Check your params.');
-            throw new Error('Invalid Teams Payload');
-          case 'slack_webhook_http_error':
-            console.error('Invalid Slack Webhook Payload. Check your params.');
-            throw new Error('Invalid Slack Payload');
-          default:
-            console.error(`Error during sending webhook.(${e?.code})`, e?.original);
-            throw e;
-        }
-      }
-      break;
-    // defaulting to standard out
-    default:
-      console.log(outputContent);
-  }
-}
 
 yargs(hideBin(process.argv))
   .env()
@@ -110,7 +16,7 @@ yargs(hideBin(process.argv))
     () => {},
     async (argv) => {
       const users = await listUsers(getKeycloakConfig(config, argv));
-      convertData(config, argv, 'user_listing', 'User Listing', users);
+      convert(getConvertConfig(config, argv, 'user_listing', 'User Listing', users));
     }
   )
   .command(
@@ -120,7 +26,7 @@ yargs(hideBin(process.argv))
     () => {},
     async (argv) => {
       const clients = await listClients(getKeycloakConfig(config, argv));
-      convertData(config, argv, 'client_listing', 'Client Listing', clients);
+      convert(getConvertConfig(config, argv, 'client_listing', 'Client Listing', clients));
     }
   )
   .option('format', {
@@ -167,6 +73,6 @@ yargs(hideBin(process.argv))
     'validates keycloak configuration by reading data via REST API',
     // eslint-disable-next-line @typescript-eslint/no-empty-function
     () => {},
-    async (argv) => configTest(getKeycloakConfig(config, argv)),
+    async (argv) => configTest(getKeycloakConfig(config, argv))
   )
   .parse();

package/dist/cli.js

@@ -1,91 +1,23 @@
 #!/usr/bin/env node
-import { writeFileSync } from 'node:fs';
-import path from 'path';
 import yargs from 'yargs/yargs';
 import { hideBin } from 'yargs/helpers';
-import { configTest, listUsers, listClients, convertJSON2CSV, post2Webhook } from './index.js';
+import { convert } from './lib/report.js';
+import { getConvertConfig, getKeycloakConfig } from './lib/utils.js';
+import { configTest, listUsers, listClients } from './index.js';
 import config from './src/config.js';
-class WebhookConfig {
-    constructor(type, url, title, message) {
-        this.type = type;
-        this.url = url;
-        this.title = title;
-        this.message = message;
-    }
-}
-class ReportConfig {
-}
-function getKeycloakConfig(config, argv) {
-    return {
-        clientId: config.clientId ? config.clientId : argv.clientId,
-        clientSecret: config.clientSecret ? config.clientSecret : argv.clientSecret,
-        rootUrl: config.url ? config.url : argv.url,
-        useAuditingEndpoint: argv.useAuditingEndpoint == true || config.useAuditingEndpoint.toLowerCase() == 'true',
-    };
-}
-function convertData(config, argv, name, title, json) {
-    convert(config.format ? config.format : argv.format, config.output ? config.output : argv.output, {
-        name,
-        directory: argv.reports ? argv.reports : config.reports,
-    }, new WebhookConfig(config.webhookType ? config.webhookType : argv.webhookType, config.webhookUrl ? config.webhookUrl : argv.webhookUrl, title, config.webhookMessage ? config.webhookMessage : argv.webhookMessage), json);
-}
-async function convert(format, output, reports, config, json) {
-    let outputContent;
-    switch (format) {
-        case 'csv':
-            outputContent = (await convertJSON2CSV(json)).toString();
-            break;
-        // defaulting to JSON
-        default:
-            outputContent = JSON.stringify(json);
-    }
-    if (reports.directory) {
-        const date = new Date();
-        writeFileSync(path.join(`${reports.directory}`, `${reports.name}_${date.getFullYear()}-${date.getMonth() + 1}-${date.getDate()}.${format.toLowerCase()}`), outputContent);
-    }
-    switch (output) {
-        case 'webhook':
-            if (!config.url) {
-                console.error('No valid Webhook URL given');
-                throw new Error('Please provide a valid --webhookUrl parameter');
-            }
-            try {
-                console.log(`Sending report via webhook to ${config.type} ....`);
-                await post2Webhook(config.type, config.url, config.title, outputContent, config.message);
-                console.log('Done sending.');
-            }
-            catch (e) {
-                switch (e.code || e.message) {
-                    case 'Request failed with status code 400':
-                        console.error('Invalid Teams Webhook Payload. Check your params.');
-                        throw new Error('Invalid Teams Payload');
-                    case 'slack_webhook_http_error':
-                        console.error('Invalid Slack Webhook Payload. Check your params.');
-                        throw new Error('Invalid Slack Payload');
-                    default:
-                        console.error(`Error during sending webhook.(${e === null || e === void 0 ? void 0 : e.code})`, e === null || e === void 0 ? void 0 : e.original);
-                        throw e;
-                }
-            }
-            break;
-        // defaulting to standard out
-        default:
-            console.log(outputContent);
-    }
-}
 yargs(hideBin(process.argv))
     .env()
     .command('listUsers [url] [clientId] [clientSecret]', 'fetches all users in the realms.', 
 // eslint-disable-next-line @typescript-eslint/no-empty-function
 () => { }, async (argv) => {
     const users = await listUsers(getKeycloakConfig(config, argv));
-    convertData(config, argv, 'user_listing', 'User Listing', users);
+    convert(getConvertConfig(config, argv, 'user_listing', 'User Listing', users));
 })
     .command('listClients [url] [clientId] [clientSecret]', 'fetches all clients in the realms.', 
 // eslint-disable-next-line @typescript-eslint/no-empty-function
 () => { }, async (argv) => {
     const clients = await listClients(getKeycloakConfig(config, argv));
-    convertData(config, argv, 'client_listing', 'Client Listing', clients);
+    convert(getConvertConfig(config, argv, 'client_listing', 'Client Listing', clients));
 })
     .option('format', {
     alias: 'f',

package/dist/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,MAAM,aAAa,CAAC;AAChC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,EAAW,eAAe,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACxG,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,MAAM,aAAa;IAKjB,YAAY,IAAY,EAAE,GAAW,EAAE,KAAa,EAAE,OAAgB;QACpE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAED,MAAM,YAAY;CAGjB;AAED,SAAS,iBAAiB,CAAC,MAAM,EAAE,IAAI;IACrC,OAAO;QACL,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAE,IAAI,CAAC,QAAmB;QACvE,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAE,IAAI,CAAC,YAAuB;QACvF,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAE,IAAI,CAAC,GAAc;QACvD,mBAAmB,EAAE,IAAI,CAAC,mBAAmB,IAAI,IAAI,IAAI,MAAM,CAAC,mBAAmB,CAAC,WAAW,EAAE,IAAI,MAAM;KAC5G,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,IAAY,EAAE,KAAa,EAAE,IAAY;IAC1E,OAAO,CACL,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAE,IAAI,CAAC,MAAiB,EACvD,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAE,IAAI,CAAC,MAAiB,EACvD;QACE,IAAI;QACJ,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAE,IAAI,CAAC,OAAkB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO;KACpE,EACD,IAAI,aAAa,CACf,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAE,IAAI,CAAC,WAAsB,EACtE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAE,IAAI,CAAC,UAAqB,EACnE,KAAK,EACL,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAE,IAAI,CAAC,cAAyB,CAChF,EACD,IAAI,CACL,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,OAAO,CAAC,MAAc,EAAE,MAAc,EAAE,OAAqB,EAAE,MAAqB,EAAE,IAAY;IAC/G,IAAI,aAAqB,CAAC;IAC1B,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,KAAK;YACR,aAAa,GAAG,CAAC,MAAM,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;YACzD,MAAM;QACR,qBAAqB;QACrB;YACE,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IACD,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACtB,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QACxB,aAAa,CACX,IAAI,CAAC,IAAI,CACP,GAAG,OAAO,CAAC,SAAS,EAAE,EACtB,GAAG,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,EAAE,IAAI,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,IAAI,MAAM,CAAC,WAAW,EAAE,EAAE,CACzG,EACD,aAAa,CACd,CAAC;IACJ,CAAC;IACD,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,SAAS;YACZ,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;gBAChB,OAAO,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;gBAC5C,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;YACnE,CAAC;YACD,IAAI,CAAC;gBACH,OAAO,CAAC,GAAG,CAAC,iCAAiC,MAAM,CAAC,IAAI,OAAO,CAAC,CAAC;gBACjE,MAAM,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;gBACzF,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YAC/B,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;oBAC5B,KAAK,qCAAqC;wBACxC,OAAO,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAC;wBACnE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;oBAC3C,KAAK,0BAA0B;wBAC7B,OAAO,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAC;wBACnE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;oBAC3C;wBACE,OAAO,CAAC,KAAK,CAAC,iCAAiC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,IAAI,GAAG,EAAE,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,QAAQ,CAAC,CAAC;wBACxE,MAAM,CAAC,CAAC;gBACZ,CAAC;YACH,CAAC;YACD,MAAM;QACR,6BAA6B;QAC7B;YACE,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAC/B,CAAC;AACH,CAAC;AAED,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;KACzB,GAAG,EAAE;KACL,OAAO,CACN,2CAA2C,EAC3C,kCAAkC;AAClC,gEAAgE;AAChE,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IAC/D,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC;AACnE,CAAC,CACF;KACA,OAAO,CACN,6CAA6C,EAC7C,oCAAoC;AACpC,gEAAgE;AAChE,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IACnE,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;AACzE,CAAC,CACF;KACA,MAAM,CAAC,QAAQ,EAAE;IAChB,KAAK,EAAE,GAAG;IACV,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,MAAM;IACf,WAAW,EAAE,8BAA8B;CAC5C,CAAC;KACD,MAAM,CAAC,QAAQ,EAAE;IAChB,KAAK,EAAE,GAAG;IACV,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,QAAQ;IACjB,WAAW,EAAE,gBAAgB;CAC9B,CAAC;KACD,MAAM,CAAC,aAAa,EAAE;IACrB,KAAK,EAAE,GAAG;IACV,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,OAAO;IAChB,WAAW,EAAE,cAAc;CAC5B,CAAC;KACD,MAAM,CAAC,gBAAgB,EAAE;IACxB,KAAK,EAAE,GAAG;IACV,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,iBAAiB;CAC/B,CAAC;KACD,MAAM,CAAC,YAAY,EAAE;IACpB,KAAK,EAAE,GAAG;IACV,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,aAAa;CAC3B,CAAC;KACD,MAAM,CAAC,SAAS,EAAE;IACjB,KAAK,EAAE,GAAG;IACV,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,mBAAmB;CACjC,CAAC;KACD,MAAM,CAAC,qBAAqB,EAAE;IAC7B,KAAK,EAAE,GAAG;IACV,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,KAAK;IACd,WAAW,EAAE,4BAA4B;CAC1C,CAAC;KACD,OAAO,CACN,4CAA4C,EAC5C,+DAA+D;AAC/D,gEAAgE;AAChE,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAC5D;KACA,KAAK,EAAE,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../cli.ts"],"names":[],"mappings":";AAEA,OAAO,KAAK,MAAM,aAAa,CAAC;AAChC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAChE,OAAO,MAAM,MAAM,iBAAiB,CAAC;AAErC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;KACzB,GAAG,EAAE;KACL,OAAO,CACN,2CAA2C,EAC3C,kCAAkC;AAClC,gEAAgE;AAChE,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IAC/D,OAAO,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC,CAAC;AACjF,CAAC,CACF;KACA,OAAO,CACN,6CAA6C,EAC7C,oCAAoC;AACpC,gEAAgE;AAChE,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IACnE,OAAO,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC,CAAC;AACvF,CAAC,CACF;KACA,MAAM,CAAC,QAAQ,EAAE;IAChB,KAAK,EAAE,GAAG;IACV,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,MAAM;IACf,WAAW,EAAE,8BAA8B;CAC5C,CAAC;KACD,MAAM,CAAC,QAAQ,EAAE;IAChB,KAAK,EAAE,GAAG;IACV,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,QAAQ;IACjB,WAAW,EAAE,gBAAgB;CAC9B,CAAC;KACD,MAAM,CAAC,aAAa,EAAE;IACrB,KAAK,EAAE,GAAG;IACV,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,OAAO;IAChB,WAAW,EAAE,cAAc;CAC5B,CAAC;KACD,MAAM,CAAC,gBAAgB,EAAE;IACxB,KAAK,EAAE,GAAG;IACV,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,iBAAiB;CAC/B,CAAC;KACD,MAAM,CAAC,YAAY,EAAE;IACpB,KAAK,EAAE,GAAG;IACV,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,aAAa;CAC3B,CAAC;KACD,MAAM,CAAC,SAAS,EAAE;IACjB,KAAK,EAAE,GAAG;IACV,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,mBAAmB;CACjC,CAAC;KACD,MAAM,CAAC,qBAAqB,EAAE;IAC7B,KAAK,EAAE,GAAG;IACV,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,KAAK;IACd,WAAW,EAAE,4BAA4B;CAC1C,CAAC;KACD,OAAO,CACN,4CAA4C,EAC5C,+DAA+D;AAC/D,gEAAgE;AAChE,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAC5D;KACA,KAAK,EAAE,CAAC"}

package/dist/lib/report.js

@@ -0,0 +1,49 @@
+import { writeFileSync } from 'node:fs';
+import path from 'path';
+import { convertJSON2CSV } from './convert.js';
+import { post2Webhook } from './output.js';
+export async function convert(cfg) {
+    let outputContent;
+    switch (cfg.format) {
+        case 'csv':
+            outputContent = (await convertJSON2CSV(cfg.json)).toString();
+            break;
+        // defaulting to JSON
+        default:
+            outputContent = JSON.stringify(cfg.json);
+    }
+    if (cfg.reports.directory) {
+        const date = new Date();
+        writeFileSync(path.join(`${cfg.reports.directory}`, `${cfg.reports.name}_${date.getFullYear()}-${date.getMonth() + 1}-${date.getDate()}.${cfg.format.toLowerCase()}`), outputContent);
+    }
+    switch (cfg.output) {
+        case 'webhook':
+            if (!cfg.config.url) {
+                console.error('No valid Webhook URL given');
+                throw new Error('Please provide a valid --webhookUrl parameter');
+            }
+            try {
+                console.log(`Sending report via webhook to ${cfg.config.type} ....`);
+                await post2Webhook(cfg.config.type, cfg.config.url, cfg.config.title, outputContent, cfg.config.message);
+                console.log('Done sending.');
+            }
+            catch (e) {
+                switch (e.code || e.message) {
+                    case 'Request failed with status code 400':
+                        console.error('Invalid Teams Webhook Payload. Check your params.');
+                        throw new Error('Invalid Teams Payload');
+                    case 'slack_webhook_http_error':
+                        console.error('Invalid Slack Webhook Payload. Check your params.');
+                        throw new Error('Invalid Slack Payload');
+                    default:
+                        console.error(`Error during sending webhook.(${e === null || e === void 0 ? void 0 : e.code})`, e === null || e === void 0 ? void 0 : e.original);
+                        throw e;
+                }
+            }
+            break;
+        // defaulting to standard out
+        default:
+            console.log(outputContent);
+    }
+}
+//# sourceMappingURL=report.js.map

package/dist/lib/report.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"report.js","sourceRoot":"","sources":["../../lib/report.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAG3C,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,GAAkB;IAC9C,IAAI,aAAqB,CAAC;IAC1B,QAAQ,GAAG,CAAC,MAAM,EAAE,CAAC;QACnB,KAAK,KAAK;YACR,aAAa,GAAG,CAAC,MAAM,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC7D,MAAM;QACR,qBAAqB;QACrB;YACE,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IACD,IAAI,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QACxB,aAAa,CACX,IAAI,CAAC,IAAI,CACP,GAAG,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,EAC1B,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,EAAE,IAAI,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,CACjH,EACD,aAAa,CACd,CAAC;IACJ,CAAC;IACD,QAAQ,GAAG,CAAC,MAAM,EAAE,CAAC;QACnB,KAAK,SAAS;YACZ,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;gBACpB,OAAO,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;gBAC5C,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;YACnE,CAAC;YACD,IAAI,CAAC;gBACH,OAAO,CAAC,GAAG,CAAC,iCAAiC,GAAG,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,CAAC;gBACrE,MAAM,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBACzG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YAC/B,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;oBAC5B,KAAK,qCAAqC;wBACxC,OAAO,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAC;wBACnE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;oBAC3C,KAAK,0BAA0B;wBAC7B,OAAO,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAC;wBACnE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;oBAC3C;wBACE,OAAO,CAAC,KAAK,CAAC,iCAAiC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,IAAI,GAAG,EAAE,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,QAAQ,CAAC,CAAC;wBACxE,MAAM,CAAC,CAAC;gBACZ,CAAC;YACH,CAAC;YACD,MAAM;QACR,6BAA6B;QAC7B;YACE,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAC/B,CAAC;AACH,CAAC"}

package/dist/lib/utils.js

@@ -0,0 +1,35 @@
+export class WebhookConfig {
+    constructor(type, url, title, message) {
+        this.type = type;
+        this.url = url;
+        this.title = title;
+        this.message = message;
+    }
+}
+class ReportConfig {
+}
+export class ConvertConfig {
+    constructor(format, output, reports, config, json) {
+        this.format = format;
+        this.output = output;
+        this.reports = reports;
+        this.config = config;
+        this.json = json;
+    }
+}
+export function getConvertConfig(config, argv, name, title, json) {
+    return new ConvertConfig(config.format ? config.format : argv.format, config.output ? config.output : argv.output, {
+        name,
+        directory: argv.reports ? argv.reports : config.reports,
+    }, new WebhookConfig(config.webhookType ? config.webhookType : argv.webhookType, config.webhookUrl ? config.webhookUrl : argv.webhookUrl, title, config.webhookMessage ? config.webhookMessage : argv.webhookMessage), json);
+}
+export function getKeycloakConfig(config, argv) {
+    var _a;
+    return {
+        clientId: config.clientId ? config.clientId : argv === null || argv === void 0 ? void 0 : argv.clientId,
+        clientSecret: config.clientSecret ? config.clientSecret : argv === null || argv === void 0 ? void 0 : argv.clientSecret,
+        rootUrl: config.url ? config.url : argv === null || argv === void 0 ? void 0 : argv.url,
+        useAuditingEndpoint: (argv === null || argv === void 0 ? void 0 : argv.useAuditingEndpoint) == true || ((_a = config.useAuditingEndpoint) === null || _a === void 0 ? void 0 : _a.toLowerCase()) == 'true',
+    };
+}
+//# sourceMappingURL=utils.js.map

package/dist/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../lib/utils.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,aAAa;IAKxB,YAAY,IAAY,EAAE,GAAW,EAAE,KAAa,EAAE,OAAgB;QACpE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAED,MAAM,YAAY;CAGjB;AAED,MAAM,OAAO,aAAa;IAMxB,YAAY,MAAc,EAAE,MAAc,EAAE,OAAqB,EAAE,MAAqB,EAAE,IAAY;QACpG,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AACD,MAAM,UAAU,gBAAgB,CAAC,MAAM,EAAE,IAAI,EAAE,IAAY,EAAE,KAAa,EAAE,IAAY;IACtF,OAAO,IAAI,aAAa,CACtB,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAE,IAAI,CAAC,MAAiB,EACvD,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAE,IAAI,CAAC,MAAiB,EACvD;QACE,IAAI;QACJ,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAE,IAAI,CAAC,OAAkB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO;KACpE,EACD,IAAI,aAAa,CACf,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAE,IAAI,CAAC,WAAsB,EACtE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAE,IAAI,CAAC,UAAqB,EACnE,KAAK,EACL,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAE,IAAI,CAAC,cAAyB,CAChF,EACD,IAAI,CACL,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,MAAM,EAAE,IAAI;;IAC5C,OAAO;QACL,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAmB;QACxE,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,YAAuB;QACxF,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,GAAc;QACxD,mBAAmB,EAAE,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,mBAAmB,KAAI,IAAI,IAAI,CAAA,MAAA,MAAM,CAAC,mBAAmB,0CAAE,WAAW,EAAE,KAAI,MAAM;KAC9G,CAAC;AACJ,CAAC"}

package/lib/report.ts

@@ -0,0 +1,55 @@
+import { writeFileSync } from 'node:fs';
+import path from 'path';
+import { convertJSON2CSV } from './convert.js';
+import { post2Webhook } from './output.js';
+import { ConvertConfig } from './utils.js';
+
+export async function convert(cfg: ConvertConfig) {
+  let outputContent: string;
+  switch (cfg.format) {
+    case 'csv':
+      outputContent = (await convertJSON2CSV(cfg.json)).toString();
+      break;
+    // defaulting to JSON
+    default:
+      outputContent = JSON.stringify(cfg.json);
+  }
+  if (cfg.reports.directory) {
+    const date = new Date();
+    writeFileSync(
+      path.join(
+        `${cfg.reports.directory}`,
+        `${cfg.reports.name}_${date.getFullYear()}-${date.getMonth() + 1}-${date.getDate()}.${cfg.format.toLowerCase()}`
+      ),
+      outputContent
+    );
+  }
+  switch (cfg.output) {
+    case 'webhook':
+      if (!cfg.config.url) {
+        console.error('No valid Webhook URL given');
+        throw new Error('Please provide a valid --webhookUrl parameter');
+      }
+      try {
+        console.log(`Sending report via webhook to ${cfg.config.type} ....`);
+        await post2Webhook(cfg.config.type, cfg.config.url, cfg.config.title, outputContent, cfg.config.message);
+        console.log('Done sending.');
+      } catch (e) {
+        switch (e.code || e.message) {
+          case 'Request failed with status code 400':
+            console.error('Invalid Teams Webhook Payload. Check your params.');
+            throw new Error('Invalid Teams Payload');
+          case 'slack_webhook_http_error':
+            console.error('Invalid Slack Webhook Payload. Check your params.');
+            throw new Error('Invalid Slack Payload');
+          default:
+            console.error(`Error during sending webhook.(${e?.code})`, e?.original);
+            throw e;
+        }
+      }
+      break;
+    // defaulting to standard out
+    default:
+      console.log(outputContent);
+  }
+}

package/lib/utils.ts

@@ -0,0 +1,60 @@
+import { Options } from './client.js';
+
+export class WebhookConfig {
+  type: string;
+  url: string;
+  title: string;
+  message?: string;
+  constructor(type: string, url: string, title: string, message?: string) {
+    this.type = type;
+    this.url = url;
+    this.title = title;
+    this.message = message;
+  }
+}
+
+class ReportConfig {
+  name: string;
+  directory: string;
+}
+
+export class ConvertConfig {
+  format: string;
+  output: string;
+  reports: ReportConfig;
+  config: WebhookConfig;
+  json: object;
+  constructor(format: string, output: string, reports: ReportConfig, config: WebhookConfig, json: object) {
+    this.format = format;
+    this.output = output;
+    this.reports = reports;
+    this.config = config;
+    this.json = json;
+  }
+}
+export function getConvertConfig(config, argv, name: string, title: string, json: object): ConvertConfig {
+  return new ConvertConfig(
+    config.format ? config.format : (argv.format as string),
+    config.output ? config.output : (argv.output as string),
+    {
+      name,
+      directory: argv.reports ? (argv.reports as string) : config.reports,
+    },
+    new WebhookConfig(
+      config.webhookType ? config.webhookType : (argv.webhookType as string),
+      config.webhookUrl ? config.webhookUrl : (argv.webhookUrl as string),
+      title,
+      config.webhookMessage ? config.webhookMessage : (argv.webhookMessage as string)
+    ),
+    json
+  );
+}
+
+export function getKeycloakConfig(config, argv): Options {
+  return {
+    clientId: config.clientId ? config.clientId : (argv?.clientId as string),
+    clientSecret: config.clientSecret ? config.clientSecret : (argv?.clientSecret as string),
+    rootUrl: config.url ? config.url : (argv?.url as string),
+    useAuditingEndpoint: argv?.useAuditingEndpoint == true || config.useAuditingEndpoint?.toLowerCase() == 'true',
+  };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@continuoussecuritytooling/keycloak-reporter",
-  "version": "0.8.3",
+  "version": "0.8.5",
   "description": "Reporting Tools for Keycloak",
   "main": "dist/index.js",
   "bin": {

package/test/utils.spec.ts

@@ -0,0 +1,10 @@
+/// <reference types="jest-extended" />
+import { getKeycloakConfig } from '../lib/utils';
+test('no config', async () => {
+  expect(getKeycloakConfig({}, null)).toEqual({
+    clientId: undefined,
+    clientSecret: undefined,
+    rootUrl: undefined,
+    useAuditingEndpoint: false,
+  });
+});