PoC SSO - Keycloak integration by foxriver76 · Pull Request #3105 · ioBroker/ioBroker.admin

foxriver76 · 2025-05-14T11:17:09Z

- next step move to webserver module

foxriver76 · 2025-05-14T11:25:34Z

        commonjs(),
    ],
    server: {
+        host: '0.0.0.0',


This allows dev-server to listen also to 127.0.0.1 instead of only localhost else local testing with SSO is not possible.

foxriver76 · 2025-05-14T11:26:39Z

@@ -1,3 +1,4 @@
+/// <reference types="vite/client" />


Gives us types for import.meta.env.DEV etc

foxriver76 · 2025-05-14T11:28:27Z

-        "@iobroker/types": "^7.0.7",
+        "@alcalzone/release-script-plugin-license": "^3.7.0",
        "@iobroker/dm-utils": "^1.0.10",
+        "@iobroker/eslint-config": "^2.0.1",


moved eslint config to the package root (was only present in adapter-react-v5), else the backend had no ESLint support at least for my setup.

Copilot

Pull Request Overview

This PR introduces a proof-of-concept SSO integration with Keycloak, adding proxy support, UI controls, and callback handling.

Exposes a /sso proxy in the dev server and adds an SSO button on the login page
Implements OIDC connect/disconnect buttons in the user edit dialog and updates related type signatures
Handles SSO callback parameters in the main App component and adds translation keys for Single-Sign On

Reviewed Changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
packages/admin/src-admin/vite.config.ts	Enabled host `0.0.0.0` and added `/sso` proxy
packages/admin/src-admin/src/login/Login.tsx	Adjusted avatar rendering logic and added SSO login button
packages/admin/src-admin/src/i18n/*	Added “Single-Sign On” and “Disconnect Single-Sign On” keys
packages/admin/src-admin/src/components/Users/UserEditDialog.tsx	Added OIDC connect/disconnect buttons; updated `saveData` to return a promise
packages/admin/src-admin/src/App.tsx	Added `componentDidUpdate` to process SSO callback params
packages/adapter-react-v5/package.json	Removed unused `@iobroker/eslint-config` dev dependency
package.json	Reordered and added `@iobroker/adapter-react-v5` dependency

Copilot · 2025-05-19T06:22:42Z

+                            window.loginHideLogo === 'false' ||
+                            (window.loginHideLogo === '@@loginHideLogo@@' && (
                                <Avatar
                                    sx={styles.avatar}
                                    src="img/admin.svg"
                                />
-                            )
+                            ))


Using logical OR here can render true in the JSX when loginHideLogo is 'false'. Replace with (cond1 || cond2) && <Avatar> so only the <Avatar> is rendered when either condition is met.

Copilot · 2025-05-19T06:22:43Z

+  "Discard": "Discard",
+  "Discard unsaved changes?": "Discard unsaved changes?",
+  "Discard?": "Discard?",
+  "Disconnect Single-Sign On'": "Disconnect Single-Sign On'",


Translation key has an extra trailing apostrophe. Remove the apostrophe so it matches your lookup string Disconnect Single-Sign On.

Suggested change

"Disconnect Single-Sign On'": "Disconnect Single-Sign On'",

"Disconnect Single-Sign On": "Disconnect Single-Sign On",

Copilot · 2025-05-19T06:22:43Z

+     */
+    renderOidcButton(): JSX.Element {
+        /* @ts-expect-error needs to be added to types */
+        return this.props.user.common?.externalAuthentication?.oidc ? (


The branches appear inverted: when oidc exists you render 'Add Single-Sign On', but it should likely render the disconnect button. Swap the branches or correct the labels.

Copilot · 2025-05-19T06:22:44Z

+    componentDidUpdate(): void {
+        // Due to the fact that the SSO process can only provide is parameters via a callback uri, we need to extract from the search parameters
+        // However, there might be a better place for this instead of using a side effect on every re-render


[nitpick] Parsing URL search parameters on every update can be inefficient. Consider moving this logic to componentDidMount or using a one-time effect.

Suggested change

componentDidUpdate(): void {

// Due to the fact that the SSO process can only provide is parameters via a callback uri, we need to extract from the search parameters

// However, there might be a better place for this instead of using a side effect on every re-render

componentDidMount(): void {

// Due to the fact that the SSO process can only provide its parameters via a callback URI, we need to extract them from the search parameters

@foxriver76 Why not in componentDidMount ?

- can only be turned on by editing the JSON right now as it is only for testing

GermanBluefox

LGTM

GermanBluefox · 2025-06-16T10:00:44Z

+    componentDidUpdate(): void {
+        // Due to the fact that the SSO process can only provide is parameters via a callback uri, we need to extract from the search parameters
+        // However, there might be a better place for this instead of using a side effect on every re-render


@foxriver76 Why not in componentDidMount ?

GermanBluefox · 2025-06-16T10:29:30Z

    }

+    componentDidUpdate(): void {
+        // Due to the fact that the SSO process can only provide is parameters via a callback uri, we need to extract from the search parameters


is parameters => its parameters ?

…ycloak

foxriver76 added 9 commits May 9, 2025 08:57

first implementation with adding two factor to user

f558d70

merge master

99f4ebb

prepared login page

9edc0ea

allow login, move all keycloak logic to backend

fda3628

- next step move to webserver module

also save the corrent iob_tokens and remove the search param afterwards

e7c8ff8

store correctly in ui visuals that sso is disconnected

49ecc7f

render oidc button only for edit user not creation

dcf1154

moved server code to webserver module

7386a02

some cleanup

1baf541

foxriver76 commented May 14, 2025

View reviewed changes

rm unused dev mode detection

beb7220

foxriver76 commented May 14, 2025

View reviewed changes

foxriver76 mentioned this pull request May 14, 2025

PoC SSO - Keycloak integration ioBroker/webserver#7

Merged

added translations

2bf4ab8

GermanBluefox requested a review from Copilot May 19, 2025 06:19

Copilot AI reviewed May 19, 2025

View reviewed changes

foxriver76 added 4 commits May 19, 2025 11:14

correct refactoring issues

02f5fc8

correct translations

4d177ee

clean reinstall

f1fd416

clarify on type level that icon selector also accepts strings as icon

641bd4e

github-advanced-security AI found potential problems May 19, 2025

View reviewed changes

Comment thread packages/admin/src-admin/public/lib/js/ace/ext-searchbox.js Fixed

foxriver76 added 2 commits June 16, 2025 10:46

default is to have SSO disabled

332f970

- can only be turned on by editing the JSON right now as it is only for testing

resolve conflicts

826dff6

foxriver76 marked this pull request as ready for review June 16, 2025 08:56

foxriver76 requested a review from GermanBluefox June 16, 2025 08:56

foxriver76 and others added 4 commits June 16, 2025 11:13

add ts-expect-err

6939626

clean reinstall

2daaf1e

Formatting of translations

0689544

Merge branch 'master' into keycloak

90301d6

GermanBluefox approved these changes Jun 16, 2025

View reviewed changes

foxriver76 and others added 7 commits June 17, 2025 09:37

upgrade webserver dep to 1.3.0

02e8c6a

Merge branch 'keycloak' of github.com:ioBroker/ioBroker.admin into ke…

4482692

…ycloak

Merge branch 'master' into keycloak

aa862d2

move to mount

292fafd

Merge branch 'keycloak' of github.com:ioBroker/ioBroker.admin into ke…

e7d00cd

…ycloak

Updated package.json

1b3467d

Merge branch 'master' into keycloak

8c7011c

GermanBluefox merged commit 2499d8b into master Jun 17, 2025
18 checks passed

GermanBluefox deleted the keycloak branch June 17, 2025 11:13

	"Disconnect Single-Sign On'": "Disconnect Single-Sign On'",
	"Disconnect Single-Sign On": "Disconnect Single-Sign On",

Conversation

foxriver76 commented May 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

foxriver76 May 14, 2025

Choose a reason for hiding this comment

Uh oh!

foxriver76 May 14, 2025

Choose a reason for hiding this comment

Uh oh!

foxriver76 May 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 19, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI May 19, 2025

Choose a reason for hiding this comment

Uh oh!

GermanBluefox Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

GermanBluefox left a comment

Choose a reason for hiding this comment

Uh oh!

GermanBluefox Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

GermanBluefox Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

foxriver76 commented May 14, 2025 •

edited

Loading