@open-pioneer/authentication-keycloak 0.2.0 → 2.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/KeycloakAuthPlugin.js +2 -1
- package/KeycloakAuthPlugin.js.map +1 -1
- package/package.json +6 -6
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# @open-pioneer/authentication-keycloak
|
|
2
2
|
|
|
3
|
+
## 2.2.0
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 41f0c6f: Use error state to communicate keycloak exceptions
|
|
8
|
+
- 39dad46: Switch to a new versioning strategy.
|
|
9
|
+
From now on, packages released by this repository share a common version number.
|
|
10
|
+
- Updated dependencies [41f0c6f]
|
|
11
|
+
- Updated dependencies [39dad46]
|
|
12
|
+
- @open-pioneer/authentication@2.2.0
|
|
13
|
+
- @open-pioneer/core@2.2.0
|
|
14
|
+
- @open-pioneer/notifier@2.2.0
|
|
15
|
+
- @open-pioneer/runtime@2.2.0
|
|
16
|
+
|
|
3
17
|
## 0.2.0
|
|
4
18
|
|
|
5
19
|
### Minor Changes
|
package/KeycloakAuthPlugin.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"KeycloakAuthPlugin.js","sources":["KeycloakAuthPlugin.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { reactive, watch } from \"@conterra/reactivity-core\";\nimport {\n AuthPlugin,\n AuthPluginEvents,\n AuthState,\n LoginBehavior\n} from \"@open-pioneer/authentication\";\nimport { EventEmitter, Resource, createLogger, destroyResource } from \"@open-pioneer/core\";\nimport { NotificationService } from \"@open-pioneer/notifier\";\nimport {\n PackageIntl,\n Service,\n ServiceOptions,\n type DECLARE_SERVICE_INTERFACE\n} from \"@open-pioneer/runtime\";\nimport Keycloak, {\n type KeycloakConfig,\n type KeycloakInitOptions,\n type KeycloakLoginOptions,\n type KeycloakLogoutOptions\n} from \"keycloak-js\";\nimport { KeycloakOptions, KeycloakProperties, RefreshOptions } from \"./api\";\n\nconst LOG = createLogger(\"authentication-keycloak:KeycloakAuthPlugin\");\n\ninterface References {\n notifier: NotificationService;\n}\n\nexport class KeycloakAuthPlugin\n extends EventEmitter<AuthPluginEvents>\n implements Service, AuthPlugin\n{\n declare [DECLARE_SERVICE_INTERFACE]: \"authentication-keycloak.KeycloakAuthPlugin\";\n\n #notifier: NotificationService;\n #intl: PackageIntl;\n #keycloakOptions: KeycloakOptions;\n #keycloak: Keycloak;\n #logoutOptions: KeycloakLogoutOptions;\n #loginOptions: KeycloakLoginOptions;\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n #timerId: any;\n #watcher: Resource | undefined;\n\n #state = reactive<AuthState>({\n kind: \"pending\"\n });\n\n constructor(options: ServiceOptions<References>) {\n super();\n this.#notifier = options.references.notifier;\n this.#intl = options.intl;\n this.#logoutOptions = { redirectUri: undefined };\n this.#loginOptions = { redirectUri: undefined };\n\n // Backwards compatibility: emit \"changed\" event when the state changes\n this.#watcher = watch(\n () => [this.#state.value],\n () => {\n this.emit(\"changed\");\n }\n );\n\n try {\n this.#keycloakOptions = getKeycloakConfig(options.properties);\n } catch (e) {\n throw new Error(\"Invalid keycloak configuration\", { cause: e });\n }\n\n try {\n this.#keycloak = new Keycloak(this.#keycloakOptions.keycloakConfig);\n } catch (e) {\n throw new Error(\"Failed to construct keycloak instance\", { cause: e });\n }\n this.#init().catch((e) => {\n // TODO: Handle error\n //\n // Stay in pending state when an error happens.\n // There is currently no useful way to signal an error using the plugin API,\n // going into 'not-authenticated' could lead to unexpected behavior (e.g. redirect loops).\n // See https://github.com/open-pioneer/trails-core-packages/issues/47\n this.#updateState({\n kind: \"pending\"\n });\n this.#notifier.notify({\n level: \"error\",\n title: this.#intl.formatMessage({\n id: \"loginFailed.title\"\n }),\n message: this.#intl.formatMessage({\n id: \"loginFailed.message\"\n })\n });\n\n LOG.error(\"Failed to check if user is authenticated\", e);\n });\n }\n\n destroy() {\n clearInterval(this.#timerId);\n this.#watcher = destroyResource(this.#watcher);\n this.#timerId = undefined;\n }\n\n getAuthState(): AuthState {\n return this.#state.value;\n }\n\n getLoginBehavior(): LoginBehavior {\n const doLogin = () => {\n LOG.debug(\"Login with options\", this.#loginOptions);\n this.#keycloak.login(this.#loginOptions);\n };\n return {\n kind: \"effect\",\n login: doLogin\n };\n }\n\n logout() {\n LOG.debug(\"Logout with options\", this.#logoutOptions);\n this.#keycloak.logout(this.#logoutOptions);\n }\n\n async #init() {\n const keycloakOptions = this.#keycloakOptions;\n const initOptions = this.#keycloakOptions.keycloakInitOptions;\n const refreshOptions = keycloakOptions.refreshOptions;\n\n let isAuthenticated: boolean;\n try {\n isAuthenticated = await this.#keycloak.init(initOptions);\n } catch (e) {\n // Note: keycloak.init() can also throw an exception, in addition to a rejected promise.\n // It may also just throw a string..\n const error = typeof e === \"string\" ? new Error(e) : e;\n throw new Error(\"Failed to initialize keycloak session\", { cause: error });\n }\n\n if (isAuthenticated) {\n this.#updateState({\n kind: \"authenticated\",\n sessionInfo: {\n userId: this.#keycloak.subject ? this.#keycloak.subject : \"undefined\",\n userName: this.#keycloak.idTokenParsed?.preferred_username,\n attributes: {\n keycloak: this.#keycloak,\n familyName: this.#keycloak.idTokenParsed?.family_name,\n givenName: this.#keycloak.idTokenParsed?.given_name,\n userName: this.#keycloak.idTokenParsed?.preferred_username\n }\n }\n });\n\n LOG.debug(`User ${this.#keycloak.subject} is authenticated`);\n\n if (refreshOptions.autoRefresh) {\n LOG.debug(\"Starting auto-refresh\", refreshOptions);\n this.__refresh(refreshOptions.interval, refreshOptions.timeLeft);\n }\n } else {\n this.#updateState({\n kind: \"not-authenticated\"\n });\n LOG.debug(\"User is not authenticated\");\n }\n }\n\n // Mocked in test\n private __refresh(interval: number, timeLeft: number) {\n clearInterval(this.#timerId);\n this.#timerId = setInterval(() => {\n this.#keycloak.updateToken(timeLeft).catch((e) => {\n LOG.error(\"Failed to refresh token\", e);\n this.#updateState({\n kind: \"not-authenticated\"\n });\n this.emit(\"changed\");\n this.destroy();\n });\n }, interval);\n }\n\n #updateState(newState: AuthState) {\n this.#state.value = newState;\n }\n}\n\nconst DEFAULT_AUTO_REFRESH_OPT = {\n autoRefresh: true,\n interval: 6000,\n timeLeft: 70\n};\n\nconst DEFAULT_INIT_OPT = {\n onLoad: \"check-sso\",\n pkceMethod: \"S256\"\n};\n\nexport function getKeycloakConfig(properties: Partial<KeycloakProperties>): KeycloakOptions {\n const { keycloakOptions } = properties;\n\n const { refreshOptions, keycloakInitOptions, keycloakConfig } = keycloakOptions!;\n\n return {\n refreshOptions: { ...getRefreshOpt(refreshOptions) },\n keycloakInitOptions: { ...getInitOpt(keycloakInitOptions) },\n keycloakConfig: { ...getConfigOpt(keycloakConfig) }\n };\n}\n\nfunction getRefreshOpt(autoRefreshOptions: RefreshOptions | undefined): RefreshOptions {\n if (!autoRefreshOptions || isObjectEmpty(autoRefreshOptions)) {\n LOG.warn(\n `The autorefresh options of the Keycloak configuration should be set to ensure automatic refreshes at specified intervals.` +\n ` Defaulting to '${DEFAULT_AUTO_REFRESH_OPT}'.`\n );\n return Object.assign({}, { ...DEFAULT_AUTO_REFRESH_OPT });\n }\n return autoRefreshOptions;\n}\n\nfunction getInitOpt(keycloakInitOptions: KeycloakInitOptions | undefined): KeycloakInitOptions {\n if (!keycloakInitOptions || isObjectEmpty(keycloakInitOptions)) {\n LOG.warn(\n `The Keycloak init options of the keycloak configuration should be set.` +\n ` Defaulting to '${DEFAULT_INIT_OPT}'.`\n );\n return Object.assign({}, { ...DEFAULT_INIT_OPT }) as KeycloakInitOptions;\n }\n return keycloakInitOptions;\n}\n\nfunction getConfigOpt(keycloakConfig: KeycloakConfig | undefined): KeycloakConfig {\n if (!keycloakConfig || isObjectEmpty(keycloakConfig)) {\n throw new Error(\n `KeycloakConfig not found: The Keycloak configuration options are required by the plugin to perform login and logout operations`\n );\n }\n return keycloakConfig;\n}\n\nconst isObjectEmpty = (objectName: unknown) => {\n return objectName && Object.keys(objectName).length === 0 && objectName.constructor === Object;\n};\n"],"names":[],"mappings":";;;;AAyBA,MAAM,GAAA,GAAM,aAAa,4CAA4C,CAAA,CAAA;AAM9D,MAAM,2BACD,YAEZ,CAAA;AAAA,EAGI,SAAA,CAAA;AAAA,EACA,KAAA,CAAA;AAAA,EACA,gBAAA,CAAA;AAAA,EACA,SAAA,CAAA;AAAA,EACA,cAAA,CAAA;AAAA,EACA,aAAA,CAAA;AAAA;AAAA,EAEA,QAAA,CAAA;AAAA,EACA,QAAA,CAAA;AAAA,EAEA,SAAS,QAAoB,CAAA;AAAA,IACzB,IAAM,EAAA,SAAA;AAAA,GACT,CAAA,CAAA;AAAA,EAED,YAAY,OAAqC,EAAA;AAC7C,IAAM,KAAA,EAAA,CAAA;AACN,IAAK,IAAA,CAAA,SAAA,GAAY,QAAQ,UAAW,CAAA,QAAA,CAAA;AACpC,IAAA,IAAA,CAAK,QAAQ,OAAQ,CAAA,IAAA,CAAA;AACrB,IAAK,IAAA,CAAA,cAAA,GAAiB,EAAE,WAAA,EAAa,KAAU,CAAA,EAAA,CAAA;AAC/C,IAAK,IAAA,CAAA,aAAA,GAAgB,EAAE,WAAA,EAAa,KAAU,CAAA,EAAA,CAAA;AAG9C,IAAA,IAAA,CAAK,QAAW,GAAA,KAAA;AAAA,MACZ,MAAM,CAAC,IAAK,CAAA,MAAA,CAAO,KAAK,CAAA;AAAA,MACxB,MAAM;AACF,QAAA,IAAA,CAAK,KAAK,SAAS,CAAA,CAAA;AAAA,OACvB;AAAA,KACJ,CAAA;AAEA,IAAI,IAAA;AACA,MAAK,IAAA,CAAA,gBAAA,GAAmB,iBAAkB,CAAA,OAAA,CAAQ,UAAU,CAAA,CAAA;AAAA,aACvD,CAAG,EAAA;AACR,MAAA,MAAM,IAAI,KAAM,CAAA,gCAAA,EAAkC,EAAE,KAAA,EAAO,GAAG,CAAA,CAAA;AAAA,KAClE;AAEA,IAAI,IAAA;AACA,MAAA,IAAA,CAAK,SAAY,GAAA,IAAI,QAAS,CAAA,IAAA,CAAK,iBAAiB,cAAc,CAAA,CAAA;AAAA,aAC7D,CAAG,EAAA;AACR,MAAA,MAAM,IAAI,KAAM,CAAA,uCAAA,EAAyC,EAAE,KAAA,EAAO,GAAG,CAAA,CAAA;AAAA,KACzE;AACA,IAAA,IAAA,CAAK,KAAM,EAAA,CAAE,KAAM,CAAA,CAAC,CAAM,KAAA;AAOtB,MAAA,IAAA,CAAK,YAAa,CAAA;AAAA,QACd,IAAM,EAAA,SAAA;AAAA,OACT,CAAA,CAAA;AACD,MAAA,IAAA,CAAK,UAAU,MAAO,CAAA;AAAA,QAClB,KAAO,EAAA,OAAA;AAAA,QACP,KAAA,EAAO,IAAK,CAAA,KAAA,CAAM,aAAc,CAAA;AAAA,UAC5B,EAAI,EAAA,mBAAA;AAAA,SACP,CAAA;AAAA,QACD,OAAA,EAAS,IAAK,CAAA,KAAA,CAAM,aAAc,CAAA;AAAA,UAC9B,EAAI,EAAA,qBAAA;AAAA,SACP,CAAA;AAAA,OACJ,CAAA,CAAA;AAED,MAAI,GAAA,CAAA,KAAA,CAAM,4CAA4C,CAAC,CAAA,CAAA;AAAA,KAC1D,CAAA,CAAA;AAAA,GACL;AAAA,EAEA,OAAU,GAAA;AACN,IAAA,aAAA,CAAc,KAAK,QAAQ,CAAA,CAAA;AAC3B,IAAK,IAAA,CAAA,QAAA,GAAW,eAAgB,CAAA,IAAA,CAAK,QAAQ,CAAA,CAAA;AAC7C,IAAA,IAAA,CAAK,QAAW,GAAA,KAAA,CAAA,CAAA;AAAA,GACpB;AAAA,EAEA,YAA0B,GAAA;AACtB,IAAA,OAAO,KAAK,MAAO,CAAA,KAAA,CAAA;AAAA,GACvB;AAAA,EAEA,gBAAkC,GAAA;AAC9B,IAAA,MAAM,UAAU,MAAM;AAClB,MAAI,GAAA,CAAA,KAAA,CAAM,oBAAsB,EAAA,IAAA,CAAK,aAAa,CAAA,CAAA;AAClD,MAAK,IAAA,CAAA,SAAA,CAAU,KAAM,CAAA,IAAA,CAAK,aAAa,CAAA,CAAA;AAAA,KAC3C,CAAA;AACA,IAAO,OAAA;AAAA,MACH,IAAM,EAAA,QAAA;AAAA,MACN,KAAO,EAAA,OAAA;AAAA,KACX,CAAA;AAAA,GACJ;AAAA,EAEA,MAAS,GAAA;AACL,IAAI,GAAA,CAAA,KAAA,CAAM,qBAAuB,EAAA,IAAA,CAAK,cAAc,CAAA,CAAA;AACpD,IAAK,IAAA,CAAA,SAAA,CAAU,MAAO,CAAA,IAAA,CAAK,cAAc,CAAA,CAAA;AAAA,GAC7C;AAAA,EAEA,MAAM,KAAQ,GAAA;AACV,IAAA,MAAM,kBAAkB,IAAK,CAAA,gBAAA,CAAA;AAC7B,IAAM,MAAA,WAAA,GAAc,KAAK,gBAAiB,CAAA,mBAAA,CAAA;AAC1C,IAAA,MAAM,iBAAiB,eAAgB,CAAA,cAAA,CAAA;AAEvC,IAAI,IAAA,eAAA,CAAA;AACJ,IAAI,IAAA;AACA,MAAA,eAAA,GAAkB,MAAM,IAAA,CAAK,SAAU,CAAA,IAAA,CAAK,WAAW,CAAA,CAAA;AAAA,aAClD,CAAG,EAAA;AAGR,MAAA,MAAM,QAAQ,OAAO,CAAA,KAAM,WAAW,IAAI,KAAA,CAAM,CAAC,CAAI,GAAA,CAAA,CAAA;AACrD,MAAA,MAAM,IAAI,KAAM,CAAA,uCAAA,EAAyC,EAAE,KAAA,EAAO,OAAO,CAAA,CAAA;AAAA,KAC7E;AAEA,IAAA,IAAI,eAAiB,EAAA;AACjB,MAAA,IAAA,CAAK,YAAa,CAAA;AAAA,QACd,IAAM,EAAA,eAAA;AAAA,QACN,WAAa,EAAA;AAAA,UACT,QAAQ,IAAK,CAAA,SAAA,CAAU,OAAU,GAAA,IAAA,CAAK,UAAU,OAAU,GAAA,WAAA;AAAA,UAC1D,QAAA,EAAU,IAAK,CAAA,SAAA,CAAU,aAAe,EAAA,kBAAA;AAAA,UACxC,UAAY,EAAA;AAAA,YACR,UAAU,IAAK,CAAA,SAAA;AAAA,YACf,UAAA,EAAY,IAAK,CAAA,SAAA,CAAU,aAAe,EAAA,WAAA;AAAA,YAC1C,SAAA,EAAW,IAAK,CAAA,SAAA,CAAU,aAAe,EAAA,UAAA;AAAA,YACzC,QAAA,EAAU,IAAK,CAAA,SAAA,CAAU,aAAe,EAAA,kBAAA;AAAA,WAC5C;AAAA,SACJ;AAAA,OACH,CAAA,CAAA;AAED,MAAA,GAAA,CAAI,KAAM,CAAA,CAAA,KAAA,EAAQ,IAAK,CAAA,SAAA,CAAU,OAAO,CAAmB,iBAAA,CAAA,CAAA,CAAA;AAE3D,MAAA,IAAI,eAAe,WAAa,EAAA;AAC5B,QAAI,GAAA,CAAA,KAAA,CAAM,yBAAyB,cAAc,CAAA,CAAA;AACjD,QAAA,IAAA,CAAK,SAAU,CAAA,cAAA,CAAe,QAAU,EAAA,cAAA,CAAe,QAAQ,CAAA,CAAA;AAAA,OACnE;AAAA,KACG,MAAA;AACH,MAAA,IAAA,CAAK,YAAa,CAAA;AAAA,QACd,IAAM,EAAA,mBAAA;AAAA,OACT,CAAA,CAAA;AACD,MAAA,GAAA,CAAI,MAAM,2BAA2B,CAAA,CAAA;AAAA,KACzC;AAAA,GACJ;AAAA;AAAA,EAGQ,SAAA,CAAU,UAAkB,QAAkB,EAAA;AAClD,IAAA,aAAA,CAAc,KAAK,QAAQ,CAAA,CAAA;AAC3B,IAAK,IAAA,CAAA,QAAA,GAAW,YAAY,MAAM;AAC9B,MAAA,IAAA,CAAK,UAAU,WAAY,CAAA,QAAQ,CAAE,CAAA,KAAA,CAAM,CAAC,CAAM,KAAA;AAC9C,QAAI,GAAA,CAAA,KAAA,CAAM,2BAA2B,CAAC,CAAA,CAAA;AACtC,QAAA,IAAA,CAAK,YAAa,CAAA;AAAA,UACd,IAAM,EAAA,mBAAA;AAAA,SACT,CAAA,CAAA;AACD,QAAA,IAAA,CAAK,KAAK,SAAS,CAAA,CAAA;AACnB,QAAA,IAAA,CAAK,OAAQ,EAAA,CAAA;AAAA,OAChB,CAAA,CAAA;AAAA,OACF,QAAQ,CAAA,CAAA;AAAA,GACf;AAAA,EAEA,aAAa,QAAqB,EAAA;AAC9B,IAAA,IAAA,CAAK,OAAO,KAAQ,GAAA,QAAA,CAAA;AAAA,GACxB;AACJ,CAAA;AAEA,MAAM,wBAA2B,GAAA;AAAA,EAC7B,WAAa,EAAA,IAAA;AAAA,EACb,QAAU,EAAA,GAAA;AAAA,EACV,QAAU,EAAA,EAAA;AACd,CAAA,CAAA;AAEA,MAAM,gBAAmB,GAAA;AAAA,EACrB,MAAQ,EAAA,WAAA;AAAA,EACR,UAAY,EAAA,MAAA;AAChB,CAAA,CAAA;AAEO,SAAS,kBAAkB,UAA0D,EAAA;AACxF,EAAM,MAAA,EAAE,iBAAoB,GAAA,UAAA,CAAA;AAE5B,EAAA,MAAM,EAAE,cAAA,EAAgB,mBAAqB,EAAA,cAAA,EAAmB,GAAA,eAAA,CAAA;AAEhE,EAAO,OAAA;AAAA,IACH,cAAgB,EAAA,EAAE,GAAG,aAAA,CAAc,cAAc,CAAE,EAAA;AAAA,IACnD,mBAAqB,EAAA,EAAE,GAAG,UAAA,CAAW,mBAAmB,CAAE,EAAA;AAAA,IAC1D,cAAgB,EAAA,EAAE,GAAG,YAAA,CAAa,cAAc,CAAE,EAAA;AAAA,GACtD,CAAA;AACJ,CAAA;AAEA,SAAS,cAAc,kBAAgE,EAAA;AACnF,EAAA,IAAI,CAAC,kBAAA,IAAsB,aAAc,CAAA,kBAAkB,CAAG,EAAA;AAC1D,IAAI,GAAA,CAAA,IAAA;AAAA,MACA,4IACuB,wBAAwB,CAAA,EAAA,CAAA;AAAA,KACnD,CAAA;AACA,IAAA,OAAO,OAAO,MAAO,CAAA,IAAI,EAAE,GAAG,0BAA0B,CAAA,CAAA;AAAA,GAC5D;AACA,EAAO,OAAA,kBAAA,CAAA;AACX,CAAA;AAEA,SAAS,WAAW,mBAA2E,EAAA;AAC3F,EAAA,IAAI,CAAC,mBAAA,IAAuB,aAAc,CAAA,mBAAmB,CAAG,EAAA;AAC5D,IAAI,GAAA,CAAA,IAAA;AAAA,MACA,yFACuB,gBAAgB,CAAA,EAAA,CAAA;AAAA,KAC3C,CAAA;AACA,IAAA,OAAO,OAAO,MAAO,CAAA,IAAI,EAAE,GAAG,kBAAkB,CAAA,CAAA;AAAA,GACpD;AACA,EAAO,OAAA,mBAAA,CAAA;AACX,CAAA;AAEA,SAAS,aAAa,cAA4D,EAAA;AAC9E,EAAA,IAAI,CAAC,cAAA,IAAkB,aAAc,CAAA,cAAc,CAAG,EAAA;AAClD,IAAA,MAAM,IAAI,KAAA;AAAA,MACN,CAAA,8HAAA,CAAA;AAAA,KACJ,CAAA;AAAA,GACJ;AACA,EAAO,OAAA,cAAA,CAAA;AACX,CAAA;AAEA,MAAM,aAAA,GAAgB,CAAC,UAAwB,KAAA;AAC3C,EAAO,OAAA,UAAA,IAAc,OAAO,IAAK,CAAA,UAAU,EAAE,MAAW,KAAA,CAAA,IAAK,WAAW,WAAgB,KAAA,MAAA,CAAA;AAC5F,CAAA;;;;"}
|
|
1
|
+
{"version":3,"file":"KeycloakAuthPlugin.js","sources":["KeycloakAuthPlugin.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { reactive, watch } from \"@conterra/reactivity-core\";\nimport {\n AuthPlugin,\n AuthPluginEvents,\n AuthState,\n LoginBehavior\n} from \"@open-pioneer/authentication\";\nimport { EventEmitter, Resource, createLogger, destroyResource } from \"@open-pioneer/core\";\nimport { NotificationService } from \"@open-pioneer/notifier\";\nimport {\n PackageIntl,\n Service,\n ServiceOptions,\n type DECLARE_SERVICE_INTERFACE\n} from \"@open-pioneer/runtime\";\nimport Keycloak, {\n type KeycloakConfig,\n type KeycloakInitOptions,\n type KeycloakLoginOptions,\n type KeycloakLogoutOptions\n} from \"keycloak-js\";\nimport { KeycloakOptions, KeycloakProperties, RefreshOptions } from \"./api\";\n\nconst LOG = createLogger(\"authentication-keycloak:KeycloakAuthPlugin\");\n\ninterface References {\n notifier: NotificationService;\n}\n\nexport class KeycloakAuthPlugin\n extends EventEmitter<AuthPluginEvents>\n implements Service, AuthPlugin\n{\n declare [DECLARE_SERVICE_INTERFACE]: \"authentication-keycloak.KeycloakAuthPlugin\";\n\n #notifier: NotificationService;\n #intl: PackageIntl;\n #keycloakOptions: KeycloakOptions;\n #keycloak: Keycloak;\n #logoutOptions: KeycloakLogoutOptions;\n #loginOptions: KeycloakLoginOptions;\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n #timerId: any;\n #watcher: Resource | undefined;\n\n #state = reactive<AuthState>({\n kind: \"pending\"\n });\n\n constructor(options: ServiceOptions<References>) {\n super();\n this.#notifier = options.references.notifier;\n this.#intl = options.intl;\n this.#logoutOptions = { redirectUri: undefined };\n this.#loginOptions = { redirectUri: undefined };\n\n // Backwards compatibility: emit \"changed\" event when the state changes\n this.#watcher = watch(\n () => [this.#state.value],\n () => {\n this.emit(\"changed\");\n }\n );\n\n try {\n this.#keycloakOptions = getKeycloakConfig(options.properties);\n } catch (e) {\n throw new Error(\"Invalid keycloak configuration\", { cause: e });\n }\n\n try {\n this.#keycloak = new Keycloak(this.#keycloakOptions.keycloakConfig);\n } catch (e) {\n throw new Error(\"Failed to construct keycloak instance\", { cause: e });\n }\n this.#init().catch((e) => {\n this.#updateState({\n kind: \"error\",\n error: e\n });\n this.#notifier.notify({\n level: \"error\",\n title: this.#intl.formatMessage({\n id: \"loginFailed.title\"\n }),\n message: this.#intl.formatMessage({\n id: \"loginFailed.message\"\n })\n });\n\n LOG.error(\"Failed to check if user is authenticated\", e);\n });\n }\n\n destroy() {\n clearInterval(this.#timerId);\n this.#watcher = destroyResource(this.#watcher);\n this.#timerId = undefined;\n }\n\n getAuthState(): AuthState {\n return this.#state.value;\n }\n\n getLoginBehavior(): LoginBehavior {\n const doLogin = () => {\n LOG.debug(\"Login with options\", this.#loginOptions);\n this.#keycloak.login(this.#loginOptions);\n };\n return {\n kind: \"effect\",\n login: doLogin\n };\n }\n\n logout() {\n LOG.debug(\"Logout with options\", this.#logoutOptions);\n this.#keycloak.logout(this.#logoutOptions);\n }\n\n async #init() {\n const keycloakOptions = this.#keycloakOptions;\n const initOptions = this.#keycloakOptions.keycloakInitOptions;\n const refreshOptions = keycloakOptions.refreshOptions;\n\n let isAuthenticated: boolean;\n try {\n isAuthenticated = await this.#keycloak.init(initOptions);\n } catch (e) {\n // Note: keycloak.init() can also throw an exception, in addition to a rejected promise.\n // It may also just throw a string..\n const error = typeof e === \"string\" ? new Error(e) : e;\n throw new Error(\"Failed to initialize keycloak session\", { cause: error });\n }\n\n if (isAuthenticated) {\n this.#updateState({\n kind: \"authenticated\",\n sessionInfo: {\n userId: this.#keycloak.subject ? this.#keycloak.subject : \"undefined\",\n userName: this.#keycloak.idTokenParsed?.preferred_username,\n attributes: {\n keycloak: this.#keycloak,\n familyName: this.#keycloak.idTokenParsed?.family_name,\n givenName: this.#keycloak.idTokenParsed?.given_name,\n userName: this.#keycloak.idTokenParsed?.preferred_username\n }\n }\n });\n\n LOG.debug(`User ${this.#keycloak.subject} is authenticated`);\n\n if (refreshOptions.autoRefresh) {\n LOG.debug(\"Starting auto-refresh\", refreshOptions);\n this.__refresh(refreshOptions.interval, refreshOptions.timeLeft);\n }\n } else {\n this.#updateState({\n kind: \"not-authenticated\"\n });\n LOG.debug(\"User is not authenticated\");\n }\n }\n\n // Mocked in test\n private __refresh(interval: number, timeLeft: number) {\n clearInterval(this.#timerId);\n this.#timerId = setInterval(() => {\n this.#keycloak.updateToken(timeLeft).catch((e) => {\n LOG.error(\"Failed to refresh token\", e);\n this.#updateState({\n kind: \"not-authenticated\"\n });\n this.emit(\"changed\");\n this.destroy();\n });\n }, interval);\n }\n\n #updateState(newState: AuthState) {\n this.#state.value = newState;\n }\n}\n\nconst DEFAULT_AUTO_REFRESH_OPT = {\n autoRefresh: true,\n interval: 6000,\n timeLeft: 70\n};\n\nconst DEFAULT_INIT_OPT = {\n onLoad: \"check-sso\",\n pkceMethod: \"S256\"\n};\n\nexport function getKeycloakConfig(properties: Partial<KeycloakProperties>): KeycloakOptions {\n const { keycloakOptions } = properties;\n\n const { refreshOptions, keycloakInitOptions, keycloakConfig } = keycloakOptions!;\n\n return {\n refreshOptions: { ...getRefreshOpt(refreshOptions) },\n keycloakInitOptions: { ...getInitOpt(keycloakInitOptions) },\n keycloakConfig: { ...getConfigOpt(keycloakConfig) }\n };\n}\n\nfunction getRefreshOpt(autoRefreshOptions: RefreshOptions | undefined): RefreshOptions {\n if (!autoRefreshOptions || isObjectEmpty(autoRefreshOptions)) {\n LOG.warn(\n `The autorefresh options of the Keycloak configuration should be set to ensure automatic refreshes at specified intervals.` +\n ` Defaulting to '${DEFAULT_AUTO_REFRESH_OPT}'.`\n );\n return Object.assign({}, { ...DEFAULT_AUTO_REFRESH_OPT });\n }\n return autoRefreshOptions;\n}\n\nfunction getInitOpt(keycloakInitOptions: KeycloakInitOptions | undefined): KeycloakInitOptions {\n if (!keycloakInitOptions || isObjectEmpty(keycloakInitOptions)) {\n LOG.warn(\n `The Keycloak init options of the keycloak configuration should be set.` +\n ` Defaulting to '${DEFAULT_INIT_OPT}'.`\n );\n return Object.assign({}, { ...DEFAULT_INIT_OPT }) as KeycloakInitOptions;\n }\n return keycloakInitOptions;\n}\n\nfunction getConfigOpt(keycloakConfig: KeycloakConfig | undefined): KeycloakConfig {\n if (!keycloakConfig || isObjectEmpty(keycloakConfig)) {\n throw new Error(\n `KeycloakConfig not found: The Keycloak configuration options are required by the plugin to perform login and logout operations`\n );\n }\n return keycloakConfig;\n}\n\nconst isObjectEmpty = (objectName: unknown) => {\n return objectName && Object.keys(objectName).length === 0 && objectName.constructor === Object;\n};\n"],"names":[],"mappings":";;;;AAyBA,MAAM,GAAA,GAAM,aAAa,4CAA4C,CAAA,CAAA;AAM9D,MAAM,2BACD,YAEZ,CAAA;AAAA,EAGI,SAAA,CAAA;AAAA,EACA,KAAA,CAAA;AAAA,EACA,gBAAA,CAAA;AAAA,EACA,SAAA,CAAA;AAAA,EACA,cAAA,CAAA;AAAA,EACA,aAAA,CAAA;AAAA;AAAA,EAEA,QAAA,CAAA;AAAA,EACA,QAAA,CAAA;AAAA,EAEA,SAAS,QAAoB,CAAA;AAAA,IACzB,IAAM,EAAA,SAAA;AAAA,GACT,CAAA,CAAA;AAAA,EAED,YAAY,OAAqC,EAAA;AAC7C,IAAM,KAAA,EAAA,CAAA;AACN,IAAK,IAAA,CAAA,SAAA,GAAY,QAAQ,UAAW,CAAA,QAAA,CAAA;AACpC,IAAA,IAAA,CAAK,QAAQ,OAAQ,CAAA,IAAA,CAAA;AACrB,IAAK,IAAA,CAAA,cAAA,GAAiB,EAAE,WAAA,EAAa,KAAU,CAAA,EAAA,CAAA;AAC/C,IAAK,IAAA,CAAA,aAAA,GAAgB,EAAE,WAAA,EAAa,KAAU,CAAA,EAAA,CAAA;AAG9C,IAAA,IAAA,CAAK,QAAW,GAAA,KAAA;AAAA,MACZ,MAAM,CAAC,IAAK,CAAA,MAAA,CAAO,KAAK,CAAA;AAAA,MACxB,MAAM;AACF,QAAA,IAAA,CAAK,KAAK,SAAS,CAAA,CAAA;AAAA,OACvB;AAAA,KACJ,CAAA;AAEA,IAAI,IAAA;AACA,MAAK,IAAA,CAAA,gBAAA,GAAmB,iBAAkB,CAAA,OAAA,CAAQ,UAAU,CAAA,CAAA;AAAA,aACvD,CAAG,EAAA;AACR,MAAA,MAAM,IAAI,KAAM,CAAA,gCAAA,EAAkC,EAAE,KAAA,EAAO,GAAG,CAAA,CAAA;AAAA,KAClE;AAEA,IAAI,IAAA;AACA,MAAA,IAAA,CAAK,SAAY,GAAA,IAAI,QAAS,CAAA,IAAA,CAAK,iBAAiB,cAAc,CAAA,CAAA;AAAA,aAC7D,CAAG,EAAA;AACR,MAAA,MAAM,IAAI,KAAM,CAAA,uCAAA,EAAyC,EAAE,KAAA,EAAO,GAAG,CAAA,CAAA;AAAA,KACzE;AACA,IAAA,IAAA,CAAK,KAAM,EAAA,CAAE,KAAM,CAAA,CAAC,CAAM,KAAA;AACtB,MAAA,IAAA,CAAK,YAAa,CAAA;AAAA,QACd,IAAM,EAAA,OAAA;AAAA,QACN,KAAO,EAAA,CAAA;AAAA,OACV,CAAA,CAAA;AACD,MAAA,IAAA,CAAK,UAAU,MAAO,CAAA;AAAA,QAClB,KAAO,EAAA,OAAA;AAAA,QACP,KAAA,EAAO,IAAK,CAAA,KAAA,CAAM,aAAc,CAAA;AAAA,UAC5B,EAAI,EAAA,mBAAA;AAAA,SACP,CAAA;AAAA,QACD,OAAA,EAAS,IAAK,CAAA,KAAA,CAAM,aAAc,CAAA;AAAA,UAC9B,EAAI,EAAA,qBAAA;AAAA,SACP,CAAA;AAAA,OACJ,CAAA,CAAA;AAED,MAAI,GAAA,CAAA,KAAA,CAAM,4CAA4C,CAAC,CAAA,CAAA;AAAA,KAC1D,CAAA,CAAA;AAAA,GACL;AAAA,EAEA,OAAU,GAAA;AACN,IAAA,aAAA,CAAc,KAAK,QAAQ,CAAA,CAAA;AAC3B,IAAK,IAAA,CAAA,QAAA,GAAW,eAAgB,CAAA,IAAA,CAAK,QAAQ,CAAA,CAAA;AAC7C,IAAA,IAAA,CAAK,QAAW,GAAA,KAAA,CAAA,CAAA;AAAA,GACpB;AAAA,EAEA,YAA0B,GAAA;AACtB,IAAA,OAAO,KAAK,MAAO,CAAA,KAAA,CAAA;AAAA,GACvB;AAAA,EAEA,gBAAkC,GAAA;AAC9B,IAAA,MAAM,UAAU,MAAM;AAClB,MAAI,GAAA,CAAA,KAAA,CAAM,oBAAsB,EAAA,IAAA,CAAK,aAAa,CAAA,CAAA;AAClD,MAAK,IAAA,CAAA,SAAA,CAAU,KAAM,CAAA,IAAA,CAAK,aAAa,CAAA,CAAA;AAAA,KAC3C,CAAA;AACA,IAAO,OAAA;AAAA,MACH,IAAM,EAAA,QAAA;AAAA,MACN,KAAO,EAAA,OAAA;AAAA,KACX,CAAA;AAAA,GACJ;AAAA,EAEA,MAAS,GAAA;AACL,IAAI,GAAA,CAAA,KAAA,CAAM,qBAAuB,EAAA,IAAA,CAAK,cAAc,CAAA,CAAA;AACpD,IAAK,IAAA,CAAA,SAAA,CAAU,MAAO,CAAA,IAAA,CAAK,cAAc,CAAA,CAAA;AAAA,GAC7C;AAAA,EAEA,MAAM,KAAQ,GAAA;AACV,IAAA,MAAM,kBAAkB,IAAK,CAAA,gBAAA,CAAA;AAC7B,IAAM,MAAA,WAAA,GAAc,KAAK,gBAAiB,CAAA,mBAAA,CAAA;AAC1C,IAAA,MAAM,iBAAiB,eAAgB,CAAA,cAAA,CAAA;AAEvC,IAAI,IAAA,eAAA,CAAA;AACJ,IAAI,IAAA;AACA,MAAA,eAAA,GAAkB,MAAM,IAAA,CAAK,SAAU,CAAA,IAAA,CAAK,WAAW,CAAA,CAAA;AAAA,aAClD,CAAG,EAAA;AAGR,MAAA,MAAM,QAAQ,OAAO,CAAA,KAAM,WAAW,IAAI,KAAA,CAAM,CAAC,CAAI,GAAA,CAAA,CAAA;AACrD,MAAA,MAAM,IAAI,KAAM,CAAA,uCAAA,EAAyC,EAAE,KAAA,EAAO,OAAO,CAAA,CAAA;AAAA,KAC7E;AAEA,IAAA,IAAI,eAAiB,EAAA;AACjB,MAAA,IAAA,CAAK,YAAa,CAAA;AAAA,QACd,IAAM,EAAA,eAAA;AAAA,QACN,WAAa,EAAA;AAAA,UACT,QAAQ,IAAK,CAAA,SAAA,CAAU,OAAU,GAAA,IAAA,CAAK,UAAU,OAAU,GAAA,WAAA;AAAA,UAC1D,QAAA,EAAU,IAAK,CAAA,SAAA,CAAU,aAAe,EAAA,kBAAA;AAAA,UACxC,UAAY,EAAA;AAAA,YACR,UAAU,IAAK,CAAA,SAAA;AAAA,YACf,UAAA,EAAY,IAAK,CAAA,SAAA,CAAU,aAAe,EAAA,WAAA;AAAA,YAC1C,SAAA,EAAW,IAAK,CAAA,SAAA,CAAU,aAAe,EAAA,UAAA;AAAA,YACzC,QAAA,EAAU,IAAK,CAAA,SAAA,CAAU,aAAe,EAAA,kBAAA;AAAA,WAC5C;AAAA,SACJ;AAAA,OACH,CAAA,CAAA;AAED,MAAA,GAAA,CAAI,KAAM,CAAA,CAAA,KAAA,EAAQ,IAAK,CAAA,SAAA,CAAU,OAAO,CAAmB,iBAAA,CAAA,CAAA,CAAA;AAE3D,MAAA,IAAI,eAAe,WAAa,EAAA;AAC5B,QAAI,GAAA,CAAA,KAAA,CAAM,yBAAyB,cAAc,CAAA,CAAA;AACjD,QAAA,IAAA,CAAK,SAAU,CAAA,cAAA,CAAe,QAAU,EAAA,cAAA,CAAe,QAAQ,CAAA,CAAA;AAAA,OACnE;AAAA,KACG,MAAA;AACH,MAAA,IAAA,CAAK,YAAa,CAAA;AAAA,QACd,IAAM,EAAA,mBAAA;AAAA,OACT,CAAA,CAAA;AACD,MAAA,GAAA,CAAI,MAAM,2BAA2B,CAAA,CAAA;AAAA,KACzC;AAAA,GACJ;AAAA;AAAA,EAGQ,SAAA,CAAU,UAAkB,QAAkB,EAAA;AAClD,IAAA,aAAA,CAAc,KAAK,QAAQ,CAAA,CAAA;AAC3B,IAAK,IAAA,CAAA,QAAA,GAAW,YAAY,MAAM;AAC9B,MAAA,IAAA,CAAK,UAAU,WAAY,CAAA,QAAQ,CAAE,CAAA,KAAA,CAAM,CAAC,CAAM,KAAA;AAC9C,QAAI,GAAA,CAAA,KAAA,CAAM,2BAA2B,CAAC,CAAA,CAAA;AACtC,QAAA,IAAA,CAAK,YAAa,CAAA;AAAA,UACd,IAAM,EAAA,mBAAA;AAAA,SACT,CAAA,CAAA;AACD,QAAA,IAAA,CAAK,KAAK,SAAS,CAAA,CAAA;AACnB,QAAA,IAAA,CAAK,OAAQ,EAAA,CAAA;AAAA,OAChB,CAAA,CAAA;AAAA,OACF,QAAQ,CAAA,CAAA;AAAA,GACf;AAAA,EAEA,aAAa,QAAqB,EAAA;AAC9B,IAAA,IAAA,CAAK,OAAO,KAAQ,GAAA,QAAA,CAAA;AAAA,GACxB;AACJ,CAAA;AAEA,MAAM,wBAA2B,GAAA;AAAA,EAC7B,WAAa,EAAA,IAAA;AAAA,EACb,QAAU,EAAA,GAAA;AAAA,EACV,QAAU,EAAA,EAAA;AACd,CAAA,CAAA;AAEA,MAAM,gBAAmB,GAAA;AAAA,EACrB,MAAQ,EAAA,WAAA;AAAA,EACR,UAAY,EAAA,MAAA;AAChB,CAAA,CAAA;AAEO,SAAS,kBAAkB,UAA0D,EAAA;AACxF,EAAM,MAAA,EAAE,iBAAoB,GAAA,UAAA,CAAA;AAE5B,EAAA,MAAM,EAAE,cAAA,EAAgB,mBAAqB,EAAA,cAAA,EAAmB,GAAA,eAAA,CAAA;AAEhE,EAAO,OAAA;AAAA,IACH,cAAgB,EAAA,EAAE,GAAG,aAAA,CAAc,cAAc,CAAE,EAAA;AAAA,IACnD,mBAAqB,EAAA,EAAE,GAAG,UAAA,CAAW,mBAAmB,CAAE,EAAA;AAAA,IAC1D,cAAgB,EAAA,EAAE,GAAG,YAAA,CAAa,cAAc,CAAE,EAAA;AAAA,GACtD,CAAA;AACJ,CAAA;AAEA,SAAS,cAAc,kBAAgE,EAAA;AACnF,EAAA,IAAI,CAAC,kBAAA,IAAsB,aAAc,CAAA,kBAAkB,CAAG,EAAA;AAC1D,IAAI,GAAA,CAAA,IAAA;AAAA,MACA,4IACuB,wBAAwB,CAAA,EAAA,CAAA;AAAA,KACnD,CAAA;AACA,IAAA,OAAO,OAAO,MAAO,CAAA,IAAI,EAAE,GAAG,0BAA0B,CAAA,CAAA;AAAA,GAC5D;AACA,EAAO,OAAA,kBAAA,CAAA;AACX,CAAA;AAEA,SAAS,WAAW,mBAA2E,EAAA;AAC3F,EAAA,IAAI,CAAC,mBAAA,IAAuB,aAAc,CAAA,mBAAmB,CAAG,EAAA;AAC5D,IAAI,GAAA,CAAA,IAAA;AAAA,MACA,yFACuB,gBAAgB,CAAA,EAAA,CAAA;AAAA,KAC3C,CAAA;AACA,IAAA,OAAO,OAAO,MAAO,CAAA,IAAI,EAAE,GAAG,kBAAkB,CAAA,CAAA;AAAA,GACpD;AACA,EAAO,OAAA,mBAAA,CAAA;AACX,CAAA;AAEA,SAAS,aAAa,cAA4D,EAAA;AAC9E,EAAA,IAAI,CAAC,cAAA,IAAkB,aAAc,CAAA,cAAc,CAAG,EAAA;AAClD,IAAA,MAAM,IAAI,KAAA;AAAA,MACN,CAAA,8HAAA,CAAA;AAAA,KACJ,CAAA;AAAA,GACJ;AACA,EAAO,OAAA,cAAA,CAAA;AACX,CAAA;AAEA,MAAM,aAAA,GAAgB,CAAC,UAAwB,KAAA;AAC3C,EAAO,OAAA,UAAA,IAAc,OAAO,IAAK,CAAA,UAAU,EAAE,MAAW,KAAA,CAAA,IAAK,WAAW,WAAgB,KAAA,MAAA,CAAA;AAC5F,CAAA;;;;"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"type": "module",
|
|
3
3
|
"name": "@open-pioneer/authentication-keycloak",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "2.2.0",
|
|
5
5
|
"description": "Implements authentication against Keycloak servers.",
|
|
6
6
|
"keywords": [
|
|
7
7
|
"open-pioneer-trails"
|
|
@@ -14,12 +14,12 @@
|
|
|
14
14
|
"directory": "src/packages/authentication-keycloak"
|
|
15
15
|
},
|
|
16
16
|
"peerDependencies": {
|
|
17
|
-
"@conterra/reactivity-core": "^0.4.
|
|
17
|
+
"@conterra/reactivity-core": "^0.4.2",
|
|
18
18
|
"keycloak-js": "^25.0.2",
|
|
19
|
-
"@open-pioneer/
|
|
20
|
-
"@open-pioneer/runtime": "^2.
|
|
21
|
-
"@open-pioneer/
|
|
22
|
-
"@open-pioneer/
|
|
19
|
+
"@open-pioneer/notifier": "^2.2.0",
|
|
20
|
+
"@open-pioneer/runtime": "^2.2.0",
|
|
21
|
+
"@open-pioneer/authentication": "^2.2.0",
|
|
22
|
+
"@open-pioneer/core": "^2.2.0"
|
|
23
23
|
},
|
|
24
24
|
"exports": {
|
|
25
25
|
"./package.json": "./package.json",
|