@continuoussecuritytooling/keycloak-reporter 0.1.0

package/dist/lib/convert.js

@@ -0,0 +1,9 @@
+import { AsyncParser } from '@json2csv/node';
+export async function convertJSON2CSV(json) {
+    const opts = {};
+    const transformOpts = {};
+    const asyncOpts = {};
+    const parser = new AsyncParser(opts, transformOpts, asyncOpts);
+    return await parser.parse(json).promise();
+}
+//# sourceMappingURL=convert.js.map

package/dist/lib/convert.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert.js","sourceRoot":"","sources":["../../lib/convert.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,IAAY;IAChD,MAAM,IAAI,GAAG,EAAE,CAAC;IAChB,MAAM,aAAa,GAAG,EAAE,CAAC;IACzB,MAAM,SAAS,GAAG,EAAE,CAAC;IACrB,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,IAAI,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;IAC/D,OAAO,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;AAC5C,CAAC"}

package/dist/lib/output.js

@@ -0,0 +1,98 @@
+import { IncomingWebhook as TeamsWebhook } from 'ms-teams-webhook';
+import { IncomingWebhook as SlackWebhook } from '@slack/webhook';
+var WebhookType;
+(function (WebhookType) {
+    WebhookType["SLACK"] = "slack";
+    WebhookType["TEAMS"] = "teams";
+})(WebhookType || (WebhookType = {}));
+export async function post2Webhook(type, url, title, reportContent) {
+    //const title= 'Keycloak Reporting';
+    const date = new Date();
+    switch (type) {
+        case WebhookType.TEAMS.toString():
+            return new TeamsWebhook(url).send({
+                type: 'message',
+                attachments: [
+                    {
+                        contentType: 'application/vnd.microsoft.card.adaptive',
+                        content: {
+                            $schema: 'http://adaptivecards.io/schemas/adaptive-card.json',
+                            type: 'AdaptiveCard',
+                            version: '1.2',
+                            body: [
+                                {
+                                    type: 'FactSet',
+                                    facts: [
+                                        {
+                                            title: 'Type',
+                                            value: title,
+                                        },
+                                        {
+                                            title: 'Date',
+                                            value: `${date.getDate()}-${date.getMonth() + 1}-${date.getFullYear()}`,
+                                        },
+                                    ],
+                                },
+                            ],
+                            actions: [
+                                {
+                                    type: 'Action.ShowCard',
+                                    title: 'Show raw report data',
+                                    card: {
+                                        type: 'AdaptiveCard',
+                                        body: [
+                                            {
+                                                type: 'TextBlock',
+                                                text: reportContent,
+                                                wrap: true,
+                                            },
+                                        ],
+                                        $schema: 'http://adaptivecards.io/schemas/adaptive-card.json',
+                                    },
+                                },
+                            ],
+                        },
+                    },
+                ],
+            });
+        // defaulting to Slack
+        default:
+            return new SlackWebhook(url).send({
+                blocks: [
+                    {
+                        type: 'section',
+                        fields: [
+                            { type: 'mrkdwn', text: `*Type*: ${title}` },
+                            {
+                                type: 'mrkdwn',
+                                text: `*Date*: ${date.getDate()}-${date.getMonth() + 1}-${date.getFullYear()}`,
+                            },
+                        ],
+                    },
+                    {
+                        type: 'divider',
+                    },
+                    {
+                        type: 'context',
+                        elements: [
+                            {
+                                type: 'mrkdwn',
+                                text: `
+\`\`\`
+${reportContent}
+\`\`\`
+`
+                            },
+                        ],
+                    },
+                    {
+                        type: 'context',
+                        elements: [{ type: 'plain_text', text: 'Raw report data' }],
+                    },
+                ],
+            });
+    }
+}
+/*
+ */
+//# sourceMappingURL=output.js.map

package/dist/lib/output.js.map

@@ -0,0 +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"}

package/dist/lib/user.js

@@ -0,0 +1,75 @@
+export async function clientListing(client) {
+    const currentRealm = client.realmName;
+    let realms;
+    try {
+        // iterate over realms
+        realms = await client.realms.find();
+    }
+    catch (e) {
+        console.error('Check Client role:', e.response.statusText);
+        return Promise.reject();
+    }
+    let allClients = new Array();
+    for (const realm of realms) {
+        // switch realm
+        client.setConfig({
+            realmName: realm.realm,
+        });
+        const realmClients = new Array();
+        for (const user of await client.clients.find()) {
+            realmClients.push({
+                client: user.clientId,
+                id: user.id,
+                description: user.description,
+                realm: realm.realm,
+                enabled: user.enabled,
+                public: user.publicClient,
+                allowedOrigins: JSON.stringify(user.webOrigins),
+            });
+        }
+        allClients = [...allClients, ...realmClients];
+    }
+    // switch back to realm
+    client.setConfig({
+        realmName: currentRealm,
+    });
+    return new Promise((resolve) => resolve(allClients));
+}
+export async function userListing(client) {
+    const currentRealm = client.realmName;
+    let realms;
+    // iterate over realms
+    try {
+        realms = await client.realms.find();
+    }
+    catch (e) {
+        console.error('Check Client role:', e.response.statusText);
+        return Promise.reject();
+    }
+    let allUsers = new Array();
+    for (const realm of realms) {
+        // switch realm
+        client.setConfig({
+            realmName: realm.realm,
+        });
+        const realmUsers = new Array();
+        for (const user of await client.users.find()) {
+            realmUsers.push({
+                username: user.username,
+                id: user.id,
+                firstName: user.firstName,
+                lastName: user.lastName,
+                email: user.email,
+                realm: realm.realm,
+                enabled: user.enabled,
+            });
+        }
+        allUsers = [...allUsers, ...realmUsers];
+    }
+    // switch back to realm
+    client.setConfig({
+        realmName: currentRealm,
+    });
+    return new Promise((resolve) => resolve(allUsers));
+}
+//# sourceMappingURL=user.js.map

package/dist/lib/user.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.js","sourceRoot":"","sources":["../../lib/user.ts"],"names":[],"mappings":"AAsBA,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAqB;IAErB,MAAM,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC;IACtC,IAAI,MAAM,CAAC;IACX,IAAI;QACF,sBAAsB;QACtB,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;KACrC;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,CAAC,KAAK,CAAC,oBAAoB,EAAE,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC3D,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC;KACzB;IACD,IAAI,UAAU,GAAG,IAAI,KAAK,EAAU,CAAC;IACrC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;QAC1B,eAAe;QACf,MAAM,CAAC,SAAS,CAAC;YACf,SAAS,EAAE,KAAK,CAAC,KAAK;SACvB,CAAC,CAAC;QACH,MAAM,YAAY,GAAG,IAAI,KAAK,EAAU,CAAC;QACzC,KAAK,MAAM,IAAI,IAAI,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE;YAC9C,YAAY,CAAC,IAAI,CAAC;gBAChB,MAAM,EAAE,IAAI,CAAC,QAAQ;gBACrB,EAAE,EAAE,IAAI,CAAC,EAAE;gBACX,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,MAAM,EAAE,IAAI,CAAC,YAAY;gBACzB,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC;aAChD,CAAC,CAAC;SACJ;QACD,UAAU,GAAG,CAAC,GAAG,UAAU,EAAE,GAAG,YAAY,CAAC,CAAC;KAC/C;IACD,uBAAuB;IACvB,MAAM,CAAC,SAAS,CAAC;QACf,SAAS,EAAE,YAAY;KACxB,CAAC,CAAC;IAEH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,MAAqB;IACrD,MAAM,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC;IACtC,IAAI,MAAM,CAAC;IACX,sBAAsB;IACtB,IAAI;QACF,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;KACrC;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,CAAC,KAAK,CAAC,oBAAoB,EAAE,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC3D,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC;KACzB;IACD,IAAI,QAAQ,GAAG,IAAI,KAAK,EAAQ,CAAC;IACjC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;QAC1B,eAAe;QACf,MAAM,CAAC,SAAS,CAAC;YACf,SAAS,EAAE,KAAK,CAAC,KAAK;SACvB,CAAC,CAAC;QACH,MAAM,UAAU,GAAG,IAAI,KAAK,EAAQ,CAAC;QACrC,KAAK,MAAM,IAAI,IAAI,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE;YAC5C,UAAU,CAAC,IAAI,CAAC;gBACd,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,EAAE,EAAE,IAAI,CAAC,EAAE;gBACX,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC,CAAC;SACJ;QACD,QAAQ,GAAG,CAAC,GAAG,QAAQ,EAAE,GAAG,UAAU,CAAC,CAAC;KACzC;IACD,uBAAuB;IACvB,MAAM,CAAC,SAAS,CAAC;QACf,SAAS,EAAE,YAAY;KACxB,CAAC,CAAC;IAEH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;AACrD,CAAC"}

package/dist/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@continuoussecuritytooling/keycloak-reporter",
+  "version": "0.1.0",
+  "description": "Reporting Tools for Keycloak",
+  "main": "dist/index.js",
+  "bin":  "dist/cli.js",
+  "type": "module",
+  "scripts": {
+    "clean": "rm -rf dist/* && npm i",
+    "build": "tsc && chmod +x dist/index.js && cp package.json dist/",
+    "test": "eslint . && jest",
+    "end2end:start-server": ".bin/start-server.mjs -Dkeycloak.profile.feature.account_api=disabled -Dkeycloak.profile.feature.account2=disabled -Dkeycloak.migration.action=import -Dkeycloak.migration.provider=singleFile -Dkeycloak.migration.file=e2e/fixtures/auth-utils/test-realm.json -Dkeycloak.migration.strategy=OVERWRITE_EXISTING",
+    "end2end:test": "./e2e/run-tests.sh"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ContinuousSecurityTooling/keycloak-reporter.git"
+  },
+  "author": "Martin Reinhardt",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ContinuousSecurityTooling/keycloak-reporter/issues"
+  },
+  "homepage": "https://github.com/ContinuousSecurityTooling/keycloak-reporter#readme",
+  "dependencies": {
+    "@json2csv/node": "^7.0.0",
+    "@keycloak/keycloak-admin-client": "^20.0.5",
+    "@slack/webhook": "^6.1.0",
+    "install": "^0.13.0",
+    "ms-teams-webhook": "^2.0.2",
+    "npm": "^9.6.7",
+    "openid-client": "^5.4.2",
+    "yargs": "^17.7.2"
+  },
+  "devDependencies": {
+    "@octokit/rest": "^19.0.11",
+    "@types/jest": "^29.5.1",
+    "@types/node": "^20.1.5",
+    "@types/yargs": "^17.0.24",
+    "@typescript-eslint/eslint-plugin": "^5.59.6",
+    "@typescript-eslint/parser": "^5.59.6",
+    "eslint": "^8.40.0",
+    "gunzip-maybe": "^1.4.2",
+    "jest": "^29.5.0",
+    "jest-extended": "^3.2.4",
+    "node-fetch": "^3.3.1",
+    "tap-xunit": "^2.4.1",
+    "tape": "^5.6.3",
+    "tar-fs": "^2.1.1",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.0.4"
+  }
+}

package/dist/src/cli.js

@@ -0,0 +1,19 @@
+import { createClient } from '../lib/client.js';
+import { userListing, clientListing } from '../lib/user.js';
+export async function listUsers(options) {
+    const users = await userListing(await createClient({
+        clientId: options.clientId,
+        clientSecret: options.clientSecret,
+        rootUrl: options.rootUrl,
+    }));
+    return new Promise((resolve) => resolve(users));
+}
+export async function listClients(options) {
+    const clients = await clientListing(await createClient({
+        clientId: options.clientId,
+        clientSecret: options.clientSecret,
+        rootUrl: options.rootUrl,
+    }));
+    return new Promise((resolve) => resolve(clients));
+}
+//# sourceMappingURL=cli.js.map

package/dist/src/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAQ,WAAW,EAAE,aAAa,EAAU,MAAM,gBAAgB,CAAC;AAE1E,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,OAAgB;IAC9C,MAAM,KAAK,GAAG,MAAM,WAAW,CAC7B,MAAM,YAAY,CAAC;QACjB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,OAAO,EAAE,OAAO,CAAC,OAAO;KACzB,CAAC,CACH,CAAC;IAEF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,OAAgB;IAChD,MAAM,OAAO,GAAG,MAAM,aAAa,CACjC,MAAM,YAAY,CAAC;QACjB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,OAAO,EAAE,OAAO,CAAC,OAAO;KACzB,CAAC,CACH,CAAC;IAEF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;AACpD,CAAC"}

package/docker_entrypoint.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+node index.js "$@"