π A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!
Vue awesomedashboarddockerhomelabhomepagemitnodejsorganizationproductivitypwaself-hostedstartpagevue
:sparkle: added keycloak logout button
Leonardo Covarrubiasdd30099ad8d7
diff --git a/src/components/Settings/AuthButtons.vue b/src/components/Settings/AuthButtons.vueindex ddacc2c1..ad355d6c 100644--- a/src/components/Settings/AuthButtons.vue+++ b/src/components/Settings/AuthButtons.vue@@ -1,7 +1,7 @@<template><div><!-- If auth configured, show status text -->- <span class="user-type-note">{{ makeText() }}</span>+ <span class="user-type-note">{{ makeUserGreeting() }}</span><div class="display-options"><!-- If user logged in, show logout button --><IconLogout@@ -17,6 +17,13 @@v-tooltip="tooltip($t('settings.sign-in-tooltip'))"class="layout-icon" tabindex="-2"/>+ <!-- If user logged in via keycloak, show keycloak logout button -->+ <IconLogout+ v-if="userType == userStateEnum.keycloakEnabled"+ @click="keycloakLogout()"+ v-tooltip="tooltip($t('settings.sign-out-tooltip'))"+ class="layout-icon" tabindex="-2"+ /></div></div></template>@@ -24,6 +31,7 @@<script>import router from '@/router';import { logout as registerLogout } from '@/utils/Auth';+import { getKeycloakAuth } from '@/utils/KeycloakAuth';import { localStorageKeys, userStateEnum } from '@/utils/defaults';import IconLogout from '@/assets/interface-icons/user-logout.svg';@@ -48,14 +56,22 @@ export default {router.push({ path: '/login' });}, 500);},+ keycloakLogout() {+ const keycloak = getKeycloakAuth();+ this.$toasted.show(this.$t('login.logout-message'));+ setTimeout(() => {+ keycloak.logout();+ }, 500);+ },goToLogin() {router.push({ path: '/login' });},tooltip(content) {return { content, trigger: 'hover focus', delay: 250 };},- makeText() {- if (this.userType === userStateEnum.loggedIn) {+ makeUserGreeting() {+ if (this.userType === userStateEnum.loggedIn+ || this.userType === userStateEnum.keycloakEnabled) {const username = localStorage[localStorageKeys.USERNAME];return username ? this.$t('settings.sign-in-welcome', { username }) : '';}@@ -73,7 +89,6 @@ export default {span.user-type-note {color: var(--settings-text-color);- text-transform: capitalize;margin-right: 0.5rem;}diff --git a/src/components/Settings/SettingsContainer.vue b/src/components/Settings/SettingsContainer.vueindex e81f17b9..19e93e34 100644--- a/src/components/Settings/SettingsContainer.vue+++ b/src/components/Settings/SettingsContainer.vue@@ -10,7 +10,7 @@<LayoutSelector :displayLayout="displayLayout" /><ItemSizeSelector :iconSize="iconSize" /><ConfigLauncher />- <AuthButtons v-if="userState != 'noone'" :userType="userState" />+ <AuthButtons v-if="userState !== 0" :userType="userState" /></div><div :class="`show-hide-container ${settingsVisible? 'hide-btn' : 'show-btn'}`"><button @click="toggleSettingsVisibility()"@@ -80,7 +80,7 @@ export default {/*** Determines which button should display, based on the user type* 0 = Auth not configured, don't show anything- * 1 = Auth condifured, and user logged in, show logout button+ * 1 = Auth configured, and user logged in, show logout button* 2 = Auth configured, guest access enabled, and not logged in, show login* Note that if auth is enabled, but not guest access, and user not logged in,* then they will never be able to view the homepage, so no button neededdiff --git a/src/main.js b/src/main.jsindex d71d46ee..b212e6ab 100644--- a/src/main.js+++ b/src/main.js@@ -20,7 +20,7 @@ import clickOutside from '@/utils/ClickOutside'; // Directive for closing pimport { messages } from '@/utils/languages'; // Language textsimport ErrorReporting from '@/utils/ErrorReporting'; // Error reporting initializer (off)import { toastedOptions, tooltipOptions, language as defaultLanguage } from '@/utils/defaults';-import { isKeycloakEnabled, cleanupKeycloakInfo, initKeycloak } from '@/utils/Auth'; // Keycloak auth config+import { initKeycloakAuth, isKeycloakEnabled } from '@/utils/KeycloakAuth';// Initialize global Vue componentsVue.use(VueI18n);@@ -58,13 +58,11 @@ const mount = () => new Vue({store, router, render, i18n,}).$mount('#app');-// every page reload removes keycloak user data-cleanupKeycloakInfo();// If Keycloak not enabled, then proceed straight to the appif (!isKeycloakEnabled()) {mount();} else { // Keycloak is enabled, redirect to KC login page- initKeycloak()+ initKeycloakAuth().then(() => mount()).catch(() => window.location.reload());}diff --git a/src/utils/Auth.js b/src/utils/Auth.jsindex 7e49f2b5..fb0eab2c 100644--- a/src/utils/Auth.js+++ b/src/utils/Auth.js@@ -1,8 +1,8 @@import sha256 from 'crypto-js/sha256';-import Keycloak from 'keycloak-js';import ConfigAccumulator from '@/utils/ConfigAccumalator';import ErrorHandler from '@/utils/ErrorHandler';import { cookieKeys, localStorageKeys, userStateEnum } from '@/utils/defaults';+import { isKeycloakEnabled } from '@/utils/KeycloakAuth';/* Uses config accumulator to get and return app config */const getAppConfig = () => {@@ -20,82 +20,6 @@ const printWarning = () => {ErrorHandler('From V 1.6.5 onwards, the structure of the users object has changed.');};-/* Returns true if keycloak is enabled */-export const isKeycloakEnabled = () => {- const appConfig = getAppConfig();- if (!appConfig.auth) return false;- return appConfig.auth.enableKeycloak || false;-};--/* Returns the users keycloak config */-export const getKeycloakConfig = () => {- const appConfig = getAppConfig();- if (!isKeycloakEnabled()) return false;- const { keycloak } = appConfig.auth;- const { serverUrl, realm, clientId } = keycloak;- if (!serverUrl || !realm || !clientId) {- ErrorHandler('Keycloak config missing- please ensure you specify: serverUrl, realm, clientId');- return false;- }- return keycloak;-};--/**- * helper that persists keycloak user data in browser local storage- * @param {Keycloak.KeycloakInstance} keycloak The username of user- */-const storeKeycloakInfo = (keycloak) => {- if (keycloak.tokenParsed && typeof keycloak.tokenParsed === 'object') {- const {- groups,- realm_access: realmAccess,- resource_access: resourceAccess,- azp: clientId,- } = keycloak.tokenParsed;-- const realmRoles = realmAccess.roles || [];-- let clientRoles = [];- if (Object.hasOwn(resourceAccess, clientId)) {- clientRoles = resourceAccess[clientId].roles || [];- }-- const roles = [...realmRoles, ...clientRoles];-- const info = {- groups,- roles,- };-- localStorage.setItem(localStorageKeys.KEYCLOAK_INFO, JSON.stringify(info));- }-};--/* remove keycloak local storage */-export const cleanupKeycloakInfo = () => localStorage.removeItem(localStorageKeys.KEYCLOAK_INFO);--/* starts the keycloak login process and gathers user data */-export const initKeycloak = () => {- const { serverUrl, realm, clientId } = getKeycloakConfig();- const initOptions = {- url: `${serverUrl}/auth`, realm, clientId, onLoad: 'login-required',- };- const keycloak = Keycloak(initOptions);-- return new Promise((resolve, reject) => {- keycloak.init({ onLoad: initOptions.onLoad })- .then((auth) => {- if (auth) {- storeKeycloakInfo(keycloak);- return resolve();- } else {- return reject(new Error('Not authenticated'));- }- })- .catch((reason) => reject(reason));- });-};-/* Returns array of users from appConfig.auth, if available, else an empty array */const getUsers = () => {const appConfig = getAppConfig();@@ -268,7 +192,13 @@ export const isUserAdmin = () => {* then they will never be able to view the homepage, so no button needed*/export const getUserState = () => {- const { notConfigured, loggedIn, guestAccess } = userStateEnum; // Numeric enum options+ const {+ notConfigured,+ loggedIn,+ guestAccess,+ keycloakEnabled,+ } = userStateEnum; // Numeric enum options+ if (isKeycloakEnabled()) return keycloakEnabled; // Keycloak auth configuredif (!isAuthEnabled()) return notConfigured; // No auth enabledif (isLoggedIn()) return loggedIn; // User is logged inif (isGuestAccessEnabled()) return guestAccess; // Guest is viewingdiff --git a/src/utils/KeycloakAuth.js b/src/utils/KeycloakAuth.jsnew file mode 100644index 00000000..47d62329--- /dev/null+++ b/src/utils/KeycloakAuth.js@@ -0,0 +1,92 @@+import Keycloak from 'keycloak-js';+import ConfigAccumulator from '@/utils/ConfigAccumalator';+import { localStorageKeys } from '@/utils/defaults';+import ErrorHandler from '@/utils/ErrorHandler';++const getAppConfig = () => {+ const Accumulator = new ConfigAccumulator();+ const config = Accumulator.config();+ return config.appConfig || {};+};++class KeycloakAuth {+ constructor() {+ const { auth } = getAppConfig();+ const { serverUrl, realm, clientId } = auth.keycloak;+ const initOptions = {+ url: `${serverUrl}/auth`, realm, clientId, onLoad: 'login-required',+ };++ this.keycloakClient = Keycloak(initOptions);+ }++ login() {+ return new Promise((resolve, reject) => {+ this.keycloakClient.init({ onLoad: 'login-required' })+ .then((auth) => {+ if (auth) {+ this.storeKeycloakInfo();+ return resolve();+ } else {+ return reject(new Error('Not authenticated'));+ }+ })+ .catch((reason) => reject(reason));+ });+ }++ logout() {+ localStorage.removeItem(localStorageKeys.USERNAME);+ localStorage.removeItem(localStorageKeys.KEYCLOAK_INFO);+ this.keycloakClient.logout();+ }++ storeKeycloakInfo() {+ if (this.keycloakClient.tokenParsed && typeof this.keycloakClient.tokenParsed === 'object') {+ const {+ groups,+ realm_access: realmAccess,+ resource_access: resourceAccess,+ azp: clientId,+ preferred_username: preferredUsername,+ } = this.keycloakClient.tokenParsed;++ const realmRoles = realmAccess.roles || [];++ let clientRoles = [];+ if (Object.hasOwn(resourceAccess, clientId)) {+ clientRoles = resourceAccess[clientId].roles || [];+ }++ const roles = [...realmRoles, ...clientRoles];++ const info = {+ groups,+ roles,+ };++ localStorage.setItem(localStorageKeys.KEYCLOAK_INFO, JSON.stringify(info));+ localStorage.setItem(localStorageKeys.USERNAME, preferredUsername);+ }+ }+}++export const isKeycloakEnabled = () => {+ const { auth } = getAppConfig();+ if (!auth) return false;+ return auth.enableKeycloak || false;+};++let keycloak;++export const initKeycloakAuth = () => {+ keycloak = new KeycloakAuth();+ return keycloak.login();+};++export const getKeycloakAuth = () => {+ if (!keycloak) {+ ErrorHandler("Keycloak not initialized, can't get instance of class");+ }+ return keycloak;+};diff --git a/src/utils/defaults.js b/src/utils/defaults.jsindex 7a05d047..0754c99d 100644--- a/src/utils/defaults.js+++ b/src/utils/defaults.js@@ -279,6 +279,7 @@ module.exports = {loggedIn: 1,guestAccess: 2,notLoggedIn: 3,+ keycloakEnabled: 4,},/* Progressive Web App settings, used by Vue Config */pwa: {