@continuoussecuritytooling/keycloak-reporter 0.2.0 → 0.4.0

package/charts/keycloak-reporter/values.yaml

@@ -0,0 +1,78 @@
+# Default values for keycloak-reporter.
+# This is a YAML-formatted file.
+# Declare variables to be passed into your templates.
+
+replicaCount: 1
+
+image:
+  repository: continuoussecuritytooling/keycloak-reporting-cli
+  pullPolicy: IfNotPresent
+  # Overrides the image tag whose default is the chart appVersion.
+  tag: "latest"
+
+imagePullSecrets: []
+nameOverride: ""
+fullnameOverride: ""
+
+serviceAccount:
+  # Specifies whether a service account should be created
+  create: true
+  # Annotations to add to the service account
+  annotations: {}
+  # The name of the service account to use.
+  # If not set and create is true, a name is generated using the fullname template
+  name: ""
+
+podAnnotations: {}
+
+podSecurityContext: {}
+  # fsGroup: 2000
+
+securityContext: {}
+
+env: {}
+  # capabilities:
+  #   drop:
+  #   - ALL
+  # readOnlyRootFilesystem: true
+  # runAsNonRoot: true
+  # runAsUser: 1000
+
+keycloak:
+  config:
+    url: ""
+    clientId: ""
+    clientSecret: ""
+    output: "webhook"
+    webhookType: ""
+    webhookUrl: ""
+    webhookMessage: ""
+  volumes:
+    reports: ""
+
+cronjobs:
+  - name: clients
+    script: /app/index.js listClients
+    schedule: 0 0 1 */3 *
+  - name: users
+    script: /app/index.js listUsers
+    schedule: 0 0 1 */3 *
+
+resources: {}
+  # We usually recommend not to specify default resources and to leave this as a conscious
+  # choice for the user. This also increases chances charts run on environments with little
+  # resources, such as Minikube. If you do want to specify resources, uncomment the following
+  # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
+  # limits:
+  #   cpu: 100m
+  #   memory: 128Mi
+  # requests:
+  #   cpu: 100m
+  #   memory: 128Mi
+
+
+nodeSelector: {}
+
+tolerations: []
+
+affinity: {}

package/cli.ts

@@ -1,5 +1,7 @@
 #!/usr/bin/env node
 
+import { writeFileSync } from 'node:fs';
+import path from 'path';
 import yargs from 'yargs/yargs';
 import { hideBin } from 'yargs/helpers';
 import {
@@ -16,16 +18,24 @@ class WebhookConfig {
   type: string;
   url: string;
   title: string;
-  constructor(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;
+}
+
 async function convert(
   format: string,
   output: string,
+  reports: ReportConfig,
   config: WebhookConfig,
   json: object
 ) {
@@ -38,6 +48,10 @@ async function convert(
     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':
       try {
@@ -45,10 +59,12 @@ async function convert(
           config.type,
           config.url,
           config.title,
-          outputContent
+          outputContent,
+          config.message,
         );
       } catch (e) {
         console.error('Error during sending webhook: ', e);
+        throw e;
       }
       break;
     // defaulting to standard out
@@ -72,10 +88,15 @@ yargs(hideBin(process.argv))
       await convert(
         argv.format as string,
         argv.output as string,
+        {
+          name: 'user_listing',
+          directory: argv.reports as string,
+        },
         new WebhookConfig(
           argv.webhookType as string,
           argv.webhookUrl as string,
-          'User Listing'
+          'User Listing',
+          argv.webhookMessage ? argv.webhookMessage as string: config.webhookMessage
         ),
         users
       );
@@ -95,10 +116,15 @@ yargs(hideBin(process.argv))
       await convert(
         argv.format as string,
         argv.output as string,
+        {
+          name: 'client_listing',
+          directory: argv.reports as string,
+        },
         new WebhookConfig(
           argv.webhookType as string,
           argv.webhookUrl as string,
-          'Client Listing'
+          'Client Listing',
+          argv.webhookMessage ? argv.webhookMessage as string: config.webhookMessage
         ),
         clients
       );
@@ -122,9 +148,19 @@ yargs(hideBin(process.argv))
     default: 'slack',
     description: 'Webhook Type',
   })
+  .option('webhookMessage', {
+    alias: 'm',
+    type: 'string',
+    description: 'Webhook Message',
+  })
   .option('webhookUrl', {
     alias: 't',
     type: 'string',
     description: 'Webhook URL',
   })
+  .option('reports', {
+    alias: 'r',
+    type: 'string',
+    description: 'Reports directory',
+  })
   .parse();

package/config/schema.json

@@ -49,9 +49,17 @@
       },
       "description": "Type of webhook"
     },
+    "webhookMessage": {
+      "type": "string",
+      "description": "Message added to the webhook post"
+    },
     "webhookUrl": {
       "type": "string",
       "description": "URL of the webhook"
+    },
+    "reports": {
+      "type": "string",
+      "description": "Reports directory"
     }
   }
 }

package/dist/cli.js

@@ -1,16 +1,21 @@
 #!/usr/bin/env node
+import { writeFileSync } from 'node:fs';
+import path from 'path';
 import yargs from 'yargs/yargs';
 import { hideBin } from 'yargs/helpers';
 import { listUsers, listClients, convertJSON2CSV, post2Webhook, } from './index.js';
 import config from './src/config.js';
 class WebhookConfig {
-    constructor(type, url, title) {
+    constructor(type, url, title, message) {
         this.type = type;
         this.url = url;
         this.title = title;
+        this.message = message;
     }
 }
-async function convert(format, output, config, json) {
+class ReportConfig {
+}
+async function convert(format, output, reports, config, json) {
     let outputContent;
     switch (format) {
         case 'csv':
@@ -20,13 +25,18 @@ async function convert(format, output, config, 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':
             try {
-                await post2Webhook(config.type, config.url, config.title, outputContent);
+                await post2Webhook(config.type, config.url, config.title, outputContent, config.message);
             }
             catch (e) {
                 console.error('Error during sending webhook: ', e);
+                throw e;
             }
             break;
         // defaulting to standard out
@@ -43,7 +53,10 @@ yargs(hideBin(process.argv))
         clientSecret: argv.clientSecret ? argv.clientSecret : config.clientSecret,
         rootUrl: argv.url ? argv.url : config.url,
     });
-    await convert(argv.format, argv.output, new WebhookConfig(argv.webhookType, argv.webhookUrl, 'User Listing'), users);
+    await convert(argv.format, argv.output, {
+        name: 'user_listing',
+        directory: argv.reports,
+    }, new WebhookConfig(argv.webhookType, argv.webhookUrl, 'User Listing', argv.webhookMessage ? argv.webhookMessage : config.webhookMessage), users);
 })
     .command('listClients [url] [clientId] [clientSecret]', 'fetches all clients in the realms.', 
 // eslint-disable-next-line @typescript-eslint/no-empty-function
@@ -53,7 +66,10 @@ yargs(hideBin(process.argv))
         clientSecret: argv.clientSecret ? argv.clientSecret : config.clientSecret,
         rootUrl: argv.url ? argv.url : config.url,
     });
-    await convert(argv.format, argv.output, new WebhookConfig(argv.webhookType, argv.webhookUrl, 'Client Listing'), clients);
+    await convert(argv.format, argv.output, {
+        name: 'client_listing',
+        directory: argv.reports,
+    }, new WebhookConfig(argv.webhookType, argv.webhookUrl, 'Client Listing', argv.webhookMessage ? argv.webhookMessage : config.webhookMessage), clients);
 })
     .option('format', {
     alias: 'f',
@@ -72,11 +88,21 @@ yargs(hideBin(process.argv))
     type: 'string',
     default: 'slack',
     description: 'Webhook Type',
+})
+    .option('webhookMessage', {
+    alias: 'm',
+    type: 'string',
+    description: 'Webhook Message',
 })
     .option('webhookUrl', {
     alias: 't',
     type: 'string',
     description: 'Webhook URL',
+})
+    .option('reports', {
+    alias: 'r',
+    type: 'string',
+    description: 'Reports directory',
 })
     .parse();
 //# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -1 +1 @@
-{"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,EACL,SAAS,EACT,WAAW,EAEX,eAAe,EACf,YAAY,GACb,MAAM,YAAY,CAAC;AACpB,OAAO,MAAM,MAAM,iBAAiB,CAAC;AAGrC,MAAM,aAAa;IAIjB,YAAY,IAAY,EAAE,GAAW,EAAE,KAAa;QAClD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED,KAAK,UAAU,OAAO,CACpB,MAAc,EACd,MAAc,EACd,MAAqB,EACrB,IAAY;IAEZ,IAAI,aAAqB,CAAC;IAC1B,QAAQ,MAAM,EAAE;QACd,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;KACxC;IACD,QAAQ,MAAM,EAAE;QACd,KAAK,SAAS;YACZ,IAAI;gBACF,MAAM,YAAY,CAChB,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,GAAG,EACV,MAAM,CAAC,KAAK,EACZ,aAAa,CACd,CAAC;aACH;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,CAAC,KAAK,CAAC,gCAAgC,EAAE,CAAC,CAAC,CAAC;aACpD;YACD,MAAM;QACR,6BAA6B;QAC7B;YACE,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;KAC9B;AACH,CAAC;AAED,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;KACzB,OAAO,CACN,2CAA2C,EAC3C,kCAAkC;AAClC,gEAAgE;AAChE,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,KAAK,GAAG,MAAM,SAAS,CAAU;QACrC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAkB,CAAA,CAAC,CAAC,MAAM,CAAC,QAAQ;QAClE,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAsB,CAAA,CAAC,CAAC,MAAM,CAAC,YAAY;QAClF,OAAO,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAa,CAAA,CAAC,CAAC,MAAM,CAAC,GAAG;KAClD,CAAC,CAAC;IACH,MAAM,OAAO,CACX,IAAI,CAAC,MAAgB,EACrB,IAAI,CAAC,MAAgB,EACrB,IAAI,aAAa,CACf,IAAI,CAAC,WAAqB,EAC1B,IAAI,CAAC,UAAoB,EACzB,cAAc,CACf,EACD,KAAK,CACN,CAAC;AACJ,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,CAAU;QACzC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAkB,CAAA,CAAC,CAAC,MAAM,CAAC,QAAQ;QAClE,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAsB,CAAA,CAAC,CAAC,MAAM,CAAC,YAAY;QAClF,OAAO,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAa,CAAA,CAAC,CAAC,MAAM,CAAC,GAAG;KAClD,CAAC,CAAC;IACH,MAAM,OAAO,CACX,IAAI,CAAC,MAAgB,EACrB,IAAI,CAAC,MAAgB,EACrB,IAAI,aAAa,CACf,IAAI,CAAC,WAAqB,EAC1B,IAAI,CAAC,UAAoB,EACzB,gBAAgB,CACjB,EACD,OAAO,CACR,CAAC;AACJ,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,YAAY,EAAE;IACpB,KAAK,EAAE,GAAG;IACV,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,aAAa;CAC3B,CAAC;KACD,KAAK,EAAE,CAAC"}
+{"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,EACL,SAAS,EACT,WAAW,EAEX,eAAe,EACf,YAAY,GACb,MAAM,YAAY,CAAC;AACpB,OAAO,MAAM,MAAM,iBAAiB,CAAC;AAGrC,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,KAAK,UAAU,OAAO,CACpB,MAAc,EACd,MAAc,EACd,OAAqB,EACrB,MAAqB,EACrB,IAAY;IAEZ,IAAI,aAAqB,CAAC;IAC1B,QAAQ,MAAM,EAAE;QACd,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;KACxC;IACD,IAAI,OAAO,CAAC,SAAS,EAAE;QACrB,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QACxB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,SAAS,EAAE,EAAC,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,CAAC,EAAE,aAAa,CAAC,CAAC;KAC1K;IACD,QAAQ,MAAM,EAAE;QACd,KAAK,SAAS;YACZ,IAAI;gBACF,MAAM,YAAY,CAChB,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,GAAG,EACV,MAAM,CAAC,KAAK,EACZ,aAAa,EACb,MAAM,CAAC,OAAO,CACf,CAAC;aACH;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,CAAC,KAAK,CAAC,gCAAgC,EAAE,CAAC,CAAC,CAAC;gBACnD,MAAM,CAAC,CAAC;aACT;YACD,MAAM;QACR,6BAA6B;QAC7B;YACE,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;KAC9B;AACH,CAAC;AAED,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;KACzB,OAAO,CACN,2CAA2C,EAC3C,kCAAkC;AAClC,gEAAgE;AAChE,GAAG,EAAE,GAAE,CAAC,EACR,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,KAAK,GAAG,MAAM,SAAS,CAAU;QACrC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAkB,CAAA,CAAC,CAAC,MAAM,CAAC,QAAQ;QAClE,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAsB,CAAA,CAAC,CAAC,MAAM,CAAC,YAAY;QAClF,OAAO,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAa,CAAA,CAAC,CAAC,MAAM,CAAC,GAAG;KAClD,CAAC,CAAC;IACH,MAAM,OAAO,CACX,IAAI,CAAC,MAAgB,EACrB,IAAI,CAAC,MAAgB,EACrB;QACE,IAAI,EAAE,cAAc;QACpB,SAAS,EAAE,IAAI,CAAC,OAAiB;KAClC,EACD,IAAI,aAAa,CACf,IAAI,CAAC,WAAqB,EAC1B,IAAI,CAAC,UAAoB,EACzB,cAAc,EACd,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,cAAwB,CAAA,CAAC,CAAC,MAAM,CAAC,cAAc,CAC3E,EACD,KAAK,CACN,CAAC;AACJ,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,CAAU;QACzC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAkB,CAAA,CAAC,CAAC,MAAM,CAAC,QAAQ;QAClE,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAsB,CAAA,CAAC,CAAC,MAAM,CAAC,YAAY;QAClF,OAAO,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAa,CAAA,CAAC,CAAC,MAAM,CAAC,GAAG;KAClD,CAAC,CAAC;IACH,MAAM,OAAO,CACX,IAAI,CAAC,MAAgB,EACrB,IAAI,CAAC,MAAgB,EACrB;QACE,IAAI,EAAE,gBAAgB;QACtB,SAAS,EAAE,IAAI,CAAC,OAAiB;KAClC,EACD,IAAI,aAAa,CACf,IAAI,CAAC,WAAqB,EAC1B,IAAI,CAAC,UAAoB,EACzB,gBAAgB,EAChB,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,cAAwB,CAAA,CAAC,CAAC,MAAM,CAAC,cAAc,CAC3E,EACD,OAAO,CACR,CAAC;AACJ,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,KAAK,EAAE,CAAC"}

package/dist/config/schema.json

@@ -49,9 +49,17 @@
       },
       "description": "Type of webhook"
     },
+    "webhookMessage": {
+      "type": "string",
+      "description": "Message added to the webhook post"
+    },
     "webhookUrl": {
       "type": "string",
       "description": "URL of the webhook"
+    },
+    "reports": {
+      "type": "string",
+      "description": "Reports directory"
     }
   }
 }

package/dist/lib/output.js

@@ -5,7 +5,7 @@ var WebhookType;
     WebhookType["SLACK"] = "slack";
     WebhookType["TEAMS"] = "teams";
 })(WebhookType || (WebhookType = {}));
-export async function post2Webhook(type, url, title, reportContent) {
+export async function post2Webhook(type, url, title, reportContent, text) {
     //const title= 'Keycloak Reporting';
     const date = new Date();
     switch (type) {
@@ -33,6 +33,11 @@ export async function post2Webhook(type, url, title, reportContent) {
                                         },
                                     ],
                                 },
+                                {
+                                    type: 'TextBlock',
+                                    text: text != null ? text : '',
+                                    wrap: true,
+                                },
                             ],
                             actions: [
                                 {
@@ -72,6 +77,13 @@ export async function post2Webhook(type, url, title, reportContent) {
                     {
                         type: 'divider',
                     },
+                    {
+                        type: 'context',
+                        elements: [{ type: 'plain_text', text: text != null ? text : '' }],
+                    },
+                    {
+                        type: 'divider',
+                    },
                     {
                         type: 'context',
                         elements: [

package/dist/lib/output.js.map

@@ -1 +1 @@
-{"version":3,"file":"output.js","sourceRoot":"","sources":["../../lib/output.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,IAAI,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEnE,OAAO,EAAE,eAAe,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEjE,IAAK,WAGJ;AAHD,WAAK,WAAW;IACd,8BAAe,CAAA;IACf,8BAAe,CAAA;AACjB,CAAC,EAHI,WAAW,KAAX,WAAW,QAGf;AAOD,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,IAAY,EACZ,GAAW,EACX,KAAa,EACb,aAAqB;IAErB,oCAAoC;IACpC,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IACxB,QAAQ,IAAI,EAAE;QACZ,KAAK,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE;YAC/B,OAAO,IAAI,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBAChC,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE;oBACX;wBACE,WAAW,EAAE,yCAAyC;wBACtD,OAAO,EAAE;4BACP,OAAO,EAAE,oDAAoD;4BAC7D,IAAI,EAAE,cAAc;4BACpB,OAAO,EAAE,KAAK;4BACd,IAAI,EAAE;gCACJ;oCACE,IAAI,EAAE,SAAS;oCACf,KAAK,EAAE;wCACL;4CACE,KAAK,EAAE,MAAM;4CACb,KAAK,EAAE,KAAK;yCACb;wCACD;4CACE,KAAK,EAAE,MAAM;4CACb,KAAK,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,IACtB,IAAI,CAAC,QAAQ,EAAE,GAAG,CACpB,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;yCACzB;qCACF;iCACF;6BACF;4BACD,OAAO,EAAE;gCACP;oCACE,IAAI,EAAE,iBAAiB;oCACvB,KAAK,EAAE,sBAAsB;oCAC7B,IAAI,EAAE;wCACJ,IAAI,EAAE,cAAc;wCACpB,IAAI,EAAE;4CACJ;gDACE,IAAI,EAAE,WAAW;gDACjB,IAAI,EAAE,aAAa;gDACnB,IAAI,EAAE,IAAI;6CACX;yCACF;wCACD,OAAO,EACL,oDAAoD;qCACvD;iCACF;6BACF;yBACF;qBACF;iBACF;aACF,CAAC,CAAC;QACL,sBAAsB;QACtB;YACE,OAAO,IAAI,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBAChC,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,SAAS;wBACf,MAAM,EAAE;4BACN,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,KAAK,EAAE,EAAE;4BAC5C;gCACE,IAAI,EAAE,QAAQ;gCACd,IAAI,EAAE,WAAW,IAAI,CAAC,OAAO,EAAE,IAC7B,IAAI,CAAC,QAAQ,EAAE,GAAG,CACpB,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;6BACzB;yBACF;qBACF;oBACD;wBACE,IAAI,EAAE,SAAS;qBAChB;oBACD;wBACE,IAAI,EAAE,SAAS;wBACf,QAAQ,EAAE;4BACR;gCACE,IAAI,EAAE,QAAQ;gCACd,IAAI,EAAE;;EAEpB,aAAa;;CAEd;6BACc;yBACF;qBACF;oBACD;wBACE,IAAI,EAAE,SAAS;wBACf,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC;qBAC5D;iBACF;aACF,CAAC,CAAC;KACN;AACH,CAAC;AAED;GACG"}
+{"version":3,"file":"output.js","sourceRoot":"","sources":["../../lib/output.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,IAAI,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEnE,OAAO,EAAE,eAAe,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEjE,IAAK,WAGJ;AAHD,WAAK,WAAW;IACd,8BAAe,CAAA;IACf,8BAAe,CAAA;AACjB,CAAC,EAHI,WAAW,KAAX,WAAW,QAGf;AAOD,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,IAAY,EACZ,GAAW,EACX,KAAa,EACb,aAAqB,EACrB,IAAa;IAEb,oCAAoC;IACpC,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IACxB,QAAQ,IAAI,EAAE;QACZ,KAAK,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE;YAC/B,OAAO,IAAI,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBAChC,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE;oBACX;wBACE,WAAW,EAAE,yCAAyC;wBACtD,OAAO,EAAE;4BACP,OAAO,EAAE,oDAAoD;4BAC7D,IAAI,EAAE,cAAc;4BACpB,OAAO,EAAE,KAAK;4BACd,IAAI,EAAE;gCACJ;oCACE,IAAI,EAAE,SAAS;oCACf,KAAK,EAAE;wCACL;4CACE,KAAK,EAAE,MAAM;4CACb,KAAK,EAAE,KAAK;yCACb;wCACD;4CACE,KAAK,EAAE,MAAM;4CACb,KAAK,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,IACtB,IAAI,CAAC,QAAQ,EAAE,GAAG,CACpB,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;yCACzB;qCACF;iCACF;gCACD;oCACE,IAAI,EAAE,WAAW;oCACjB,IAAI,EAAE,IAAI,IAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;oCAC5B,IAAI,EAAE,IAAI;iCACX;6BACF;4BACD,OAAO,EAAE;gCACP;oCACE,IAAI,EAAE,iBAAiB;oCACvB,KAAK,EAAE,sBAAsB;oCAC7B,IAAI,EAAE;wCACJ,IAAI,EAAE,cAAc;wCACpB,IAAI,EAAE;4CACJ;gDACE,IAAI,EAAE,WAAW;gDACjB,IAAI,EAAE,aAAa;gDACnB,IAAI,EAAE,IAAI;6CACX;yCACF;wCACD,OAAO,EACL,oDAAoD;qCACvD;iCACF;6BACF;yBACF;qBACF;iBACF;aACF,CAAC,CAAC;QACL,sBAAsB;QACtB;YACE,OAAO,IAAI,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBAChC,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,SAAS;wBACf,MAAM,EAAE;4BACN,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,KAAK,EAAE,EAAE;4BAC5C;gCACE,IAAI,EAAE,QAAQ;gCACd,IAAI,EAAE,WAAW,IAAI,CAAC,OAAO,EAAE,IAC7B,IAAI,CAAC,QAAQ,EAAE,GAAG,CACpB,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;6BACzB;yBACF;qBACF;oBACD;wBACE,IAAI,EAAE,SAAS;qBAChB;oBACD;wBACE,IAAI,EAAE,SAAS;wBACf,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAG,IAAI,IAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAC,CAAC;qBACjE;oBACD;wBACE,IAAI,EAAE,SAAS;qBAChB;oBACD;wBACE,IAAI,EAAE,SAAS;wBACf,QAAQ,EAAE;4BACR;gCACE,IAAI,EAAE,QAAQ;gCACd,IAAI,EAAE;;EAEpB,aAAa;;CAEd;6BACc;yBACF;qBACF;oBACD;wBACE,IAAI,EAAE,SAAS;wBACf,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC;qBAC5D;iBACF;aACF,CAAC,CAAC;KACN;AACH,CAAC;AAED;GACG"}

package/e2e/spec/clients.js

@@ -23,11 +23,9 @@ test('Should list clients as JSON', { timeout: 3000 }, (t) => {
   cli.stdout.on('data', (chunk) => {
     console.log(chunk.toString())
     t.equal(JSON.parse(chunk.toString()).length, 24);
+    t.end();
   });
   cli.stderr.on('data', (msg) => {
     t.fail(msg)
   });
-  cli.stdout.on('end', () => {
-    t.end();
-  });
 });

package/e2e/spec/config.js

@@ -21,11 +21,9 @@ test('Should use config file', { timeout: 3000 }, (t) => {
   cli.stdout.on('data', (chunk) => {
     console.log(chunk.toString())
     t.equal(JSON.parse(chunk.toString()).length, 24);
+    t.end();
   });
   cli.stderr.on('data', (msg) => {
     t.fail(msg)
   });
-  cli.stdout.on('end', () => {
-    t.end();
-  });
 });

package/e2e/spec/users.js

@@ -23,11 +23,9 @@ test('Should list users as JSON', { timeout: 3000 }, (t) => {
   cli.stdout.on('data', (chunk) => {
     console.log(chunk.toString())
     t.equal(JSON.parse(chunk.toString()).length, 3);
+    t.end();
   });
   cli.stderr.on('data', (msg) => {
     t.fail(msg)
   });
-  cli.stdout.on('end', () => {
-    t.end();
-  });
 });

package/e2e/spec/webhooks.js

@@ -4,7 +4,7 @@ import { test } from 'tape';
 import { spawn } from 'node:child_process';
 import path from 'node:path';
 
-test('Should post message to Teams',  { timeout: 3000 }, (t) => {
+test('Should post message to Teams',  { timeout: 10000 }, (t) => {
   const cli = spawn(
     path.join(path.dirname('.'), 'node'),
     [
@@ -24,7 +24,7 @@ test('Should post message to Teams',  { timeout: 3000 }, (t) => {
     }
   );
   cli.stdout.on('data', (chunk) => {
-    console.log(chunk.toString())
+    console.log(chunk.toString());
   });
   cli.stderr.on('data', (msg) => {
     t.fail(msg)
@@ -34,7 +34,7 @@ test('Should post message to Teams',  { timeout: 3000 }, (t) => {
   });
 });
 
-test('Should post message to Slack', { timeout: 3000 }, (t) => {
+test('Should post message to Slack', { timeout: 10000 }, (t) => {
     const cli = spawn(
       path.join(path.dirname('.'), 'node'),
       [
@@ -63,4 +63,3 @@ test('Should post message to Slack', { timeout: 3000 }, (t) => {
       t.end();
     });
   });
-  

package/jest.config.js

@@ -10,7 +10,6 @@ export default {
   collectCoverage: true,
   collectCoverageFrom: [
     'index.ts',
-    'src/**',
     'lib/**',
   ],
   setupFilesAfterEnv: [

package/lib/output.ts

@@ -16,7 +16,8 @@ export async function post2Webhook(
   type: string,
   url: string,
   title: string,
-  reportContent: string
+  reportContent: string,
+  text?: string,
 ): Promise<unknown> {
   //const title= 'Keycloak Reporting';
   const date = new Date();
@@ -47,6 +48,11 @@ export async function post2Webhook(
                     },
                   ],
                 },
+                {
+                  type: 'TextBlock',
+                  text: text!=null ? text : '',
+                  wrap: true,
+                },
               ],
               actions: [
                 {
@@ -89,6 +95,13 @@ export async function post2Webhook(
           {
             type: 'divider',
           },
+          {
+            type: 'context',
+            elements: [{ type: 'plain_text', text:  text!=null ? text : ''}],
+          },
+          {
+            type: 'divider',
+          },
           {
             type: 'context',
             elements: [

package/lintconf.yaml

@@ -0,0 +1,42 @@
+---
+rules:
+  braces:
+    min-spaces-inside: 0
+    max-spaces-inside: 0
+    min-spaces-inside-empty: -1
+    max-spaces-inside-empty: -1
+  brackets:
+    min-spaces-inside: 0
+    max-spaces-inside: 0
+    min-spaces-inside-empty: -1
+    max-spaces-inside-empty: -1
+  colons:
+    max-spaces-before: 0
+    max-spaces-after: 1
+  commas:
+    max-spaces-before: 0
+    min-spaces-after: 1
+    max-spaces-after: 1
+  comments:
+    require-starting-space: true
+    min-spaces-from-content: 2
+  document-end: disable
+  document-start: disable           # No --- to start a file
+  empty-lines:
+    max: 2
+    max-start: 0
+    max-end: 0
+  hyphens:
+    max-spaces-after: 1
+  indentation:
+    spaces: consistent
+    indent-sequences: whatever      # - list indentation will handle both indentation and without
+    check-multi-line-strings: false
+  key-duplicates: enable
+  line-length: disable              # Lines can be any length
+  new-line-at-end-of-file: disable
+  new-lines:
+    type: unix
+  trailing-spaces: enable
+  truthy:
+    level: warning

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@continuoussecuritytooling/keycloak-reporter",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Reporting Tools for Keycloak",
   "main": "dist/index.js",
   "bin": {
@@ -31,7 +31,7 @@
     "ajv": "^8.12.0",
     "install": "^0.13.0",
     "ms-teams-webhook": "^2.0.2",
-    "npm": "^9.6.7",
+    "npm": "^10.0.0",
     "openid-client": "^5.4.2",
     "ramda": "^0.29.0",
     "yargs": "^17.7.2"
@@ -46,11 +46,11 @@
     "eslint": "^8.40.0",
     "gunzip-maybe": "^1.4.2",
     "jest": "^29.5.0",
-    "jest-extended": "^3.2.4",
+    "jest-extended": "^4.0.0",
     "node-fetch": "^3.3.1",
     "tap-xunit": "^2.4.1",
     "tape": "^5.6.3",
-    "tar-fs": "^2.1.1",
+    "tar-fs": "^3.0.0",
     "ts-jest": "^29.1.0",
     "typescript": "^5.0.4"
   }

package/renovate.json

@@ -1,14 +1,16 @@
 {
-    "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-    "extends": [
-      "config:base"
-    ],
-    "packageRules": [
-      {
-        "matchDatasources": ["npm"],
-        "matchUpdateTypes": ["patch"],
-        "automerge": true
-      }
-    ],
-    "prHourlyLimit": 10
-  }
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base",":dependencyDashboard"
+  ],
+  "automerge": true,
+  "platformAutomerge": true,
+  "packageRules": [
+    {
+      "description": "Automerge non-major updates",
+      "matchUpdateTypes": ["minor", "patch"],
+      "automerge": true
+    }
+  ],
+  "prHourlyLimit": 10
+}