Keycloak realm graphical representation

The main goal of this project is to generate quick representation of realm configuration based on plantuml. This service would make easier understanding and conception of authentication process with Keycloak.

Table of Contents

• Keycloak realm graphical representation
  • Table of Contents
  • Prerequisites
  • Installing
  • Usage
  • Versioning
  • Changelog
    • 0.4.0
    • 0.3.3
    • 0.3.0
    • 0.2.0
    • 0.1.0
  • TODO
  • Limitations
    • I want to generate huge diagrams!
  • Authors

Prerequisites

• Node >=12
• Keycloak
• Plantuml viewer (vscode)

Installing

npm install @malysus/krepresentation -g

Usage

krepresentation -h
or
npx @malysus/krepresentation -h

example:

docker run --rm -d  -p 8180:8080 -e KEYCLOAK_USER=keycloak -e KEYCLOAK_PASSWORD=keycloak jboss/keycloak
krepresentation -u keycloak -p keycloak -s http://localhost:8180 -r master -o example/master.puml -o example/master.png -f "(test|test1)"
code master.puml

Versioning

We use SemVer for versioning.

Changelog

0.4.0

• Display roles
• Add legend -k to skip roles generation
• Group service accounts

0.3.3

• Update plantuml dependency

0.3.0

• Support plantuml export (svg|png)
• fix bugs

0.2.0

• Add template override -t
• Add legend -l

0.1.0

• Manage roles, realm, client
• Filter default clients and roles
• Convert description to notes using -n option
• Add help command
• Add regexp filter
• Create a standalone version
• Add options to filter default clients and roles

TODO

• Improve roles representation

Limitations

I want to generate huge diagrams!

I want to generate huge diagrams!Back to topEdit using Dokuwiki syntaxEdit using Asciidoc syntaxEdit using Markdown syntax PlantUML limits image width and height to 4096. There is a environment variable that you can set to override this limit: PLANTUML_LIMIT_SIZE. You have to define this variable before launching PlantUML, something like:

set PLANTUML_LIMIT_SIZE=8192 or

setenv PLANTUML_LIMIT_SIZE 8192 Another way is an option in the command line:

java -DPLANTUML_LIMIT_SIZE=8192 -jar /path/to/plantuml.jar ... Note that if you generate very big diagrams, (for example, something like 20 000 x 10 000 pixels), you can have some memory issues. The solution is to add this parameter to the java vm : -Xmx1024m.

Authors

Malys