ef-keycloak-connect 1.9.2 → 1.9.3-RC2

package/.vscode/settings.json

@@ -0,0 +1,2 @@
+{
+}

package/README.md

@@ -40,8 +40,8 @@ This adapter is extended from keycloak-connect and have functionalities of both
   - getRealmRoles
   - assignRoleToUser
   - authenticateFinesse
-  - createRealmAsTenant
   - externalServiceSso
+  - createRealmAsTenant
   
 ```
 ### Example
@@ -96,14 +96,14 @@ Sample `config` is given below:
   "bearer-only": true,
   "TWILIO_SID": "yourTwilioSID",
   "TWILIO_AUTH_TOKEN": "yourTwilioAuthToken",
+  "EXTERNAL_USER_PASSWORD": "external_service_user_password",
   "TWILIO_VERIFY_SID": "yourTwilioVerifySID",
   "ef-server-url": "https://<cx instance fqdn>/unified-admin/",
   "FINESSE_USERNAME_ADMIN": "<cisco admin username>",
   "FINESSE_PASSWORD_ADMIN": "<cisco admin username>",
   "SYNC_AGENT_PASSWORD": "<qm sync agent/supervisor password>",
   "MASTER_USERNAME": "master_admin_username",
-  "MASTER_PASSWORD": "master_admin_password",
-  "EXTERNAL_USER_PASSWORD": "external_service_user_password"
+  "MASTER_PASSWORD": "master_admin_password"
 }
 ```
 Here is the definition of each property defined in config file/object.
@@ -126,6 +126,7 @@ Here is the definition of each property defined in config file/object.
 - **SCOPE_NAME:** Keycloak Client App scope to use as default scope during Authorization.
 - **bearer-only:** Will keep its value as **true** (This should be set to true for services. If enabled the adapter will not attempt to authenticate users, but only verify bearer tokens. This is OPTIONAL. The default value is false.)
 - **TWILIO_SID:** Your Twilio Account SID.
+- **EXTERNAL_USER_PASSWORD**: While syncing external service user to keycloak, this password value will be assigned as password to it.
 - **TWILIO_AUTH_TOKEN:** Your Twilio account's Auth Token.
 - **TWILIO_VERIFY_SID:** Your Twilio account's Verify Service's SID.
 - *(Each property having TWILIO in its name is optional and is required only in the case of 2FA via SMS.)*
@@ -136,7 +137,6 @@ Here is the definition of each property defined in config file/object.
 - **SYNC_AGENT_PASSWORD**: Password for Users being synced to Keycloak/CX.
 - **MASTER_USERNAME**: Keycloak master admin username.
 - **MASTER_PASSWORD**: Keycloak master password username.
-- **EXTERNAL_USER_PASSWORD**: While syncing external service user to keycloak, this password value will be assigned as password to it.
 
 For using keycloak-connect features:
 ```js
@@ -448,9 +448,6 @@ It takes 5 arguments:
  - finesse_server_url: The url of finesse server (In case of normal keycloak auth, send this parameter as **' '**)
  - user_roles: The array containing user_roles, it will be used to assign roles to finesse user while synching it with Keycloak (for normal auth send it as [ ]).
  - finesse_token: acess token for finesse SSO authentication (It will be passed if Finesse SSO instance is connected, in case of non SSO will pass empty string **' '** as argument)
-
-
-
  
  ##### Example of SSO Finesse Auth:
  
@@ -459,7 +456,6 @@ It takes 5 arguments:
         
  ##### Example of non SSO Finesse Auth:
       
-      authenticateFinesse('johndoe', '12345', `https://${finesse_server_url}:${port}`, ['agent','supervisor'], '')
 
 ### externalServiceSso( userRolesArr, validationToken, externalServiceURL, type )
 
@@ -471,6 +467,30 @@ It takes 4 arguments:
  - externalServiceURL: The url of external service server e.g in case of dynamics365: **'https://{fqdn}/api/data/v9.0'** , in case of salesforce: **'https://{salesforce service fqdn}.com'**
  - type: Type of external service. In case of Dynamics365, the type is: **dynamics365**. In case of Salesforce, the type is: **salesforce**
 
+#### Example (Dynamics365)
+
+```js
+await keycloak.externalServiceSso( 
+  ['agent', 'supervisor'], 
+  'eyJ0eXAiOiJKV1QiLCJhbGci...', 
+  'https://yourcrm.dynamics.com/api/data/v9.0', 
+  'dynamics365' 
+);
+```
+
+#### Example (Salesforce)
+
+```js
+await keycloak.externalServiceSso( 
+  ['agent'], 
+  'eyJ0eXAiOiJKV1QiLCJhbGci...', 
+  'https://yourorg.salesforce.com', 
+  'salesforce' 
+);
+```
+
+      authenticateFinesse('johndoe', '12345', `https://${finesse_server_url}:${port}`, ['agent','supervisor'], '')
+
 ### generateAccessTokenFromRefreshToken(refreshToken)
 
 This function generates a new access_token by using the refreshToken received in parameter.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ef-keycloak-connect",
-  "version": "1.9.2",
+  "version": "1.9.3-RC2",
   "description": "Node JS keycloak adapter for authentication and authorization.",
   "main": "index.js",
   "scripts": {
@@ -20,7 +20,6 @@
     "keycloak-connect": "^26.0.7",
     "qrcode": "^1.5.4",
     "speakeasy": "^2.0.0",
-    "twilio": "^5.2.2",
     "xml2js": "^0.6.2"
   }
 }

package/services/ciscoSyncService.js

@@ -3,7 +3,7 @@ const https = require( 'https' );
 
 let requestController = require( "../controller/requestController.js" );
 const ErrorService = require( './errorService.js' );
-const { copyFileSync } = require( 'fs' );
+
 
 const errorService = new ErrorService();
 let realmRoles = [];
@@ -227,8 +227,8 @@ class CiscoSyncService {
                 credentials: [
                     {
                         type: "password",
-                        value: "Expertflow464",
-                        temporary: false,
+                        value: keycloakConfig[ "DEFAULT_USER_PASSWORD" ] || "Expertflow464",
+                        temporary: true,
                     },
                 ],
                 attributes: {
@@ -263,7 +263,7 @@ class CiscoSyncService {
                 //Get list of all the roles in keycloak realm
                 /* Storing all the realm roles in Global realmRoles list.If some role come from finesse which doesn't
                 exist in realmRoles list then we call keycloak roles api again to update realmRoles list. */
-                if ( ciscoUser.roles != [] ) {
+                if ( Array.isArray( ciscoUser.roles ) && ciscoUser.roles.length > 0 ) {
 
                     if ( realmRoles.length > 0 ) {
 
@@ -572,8 +572,8 @@ class CiscoSyncService {
                 let cxTeams = await this.fetchCXTeams( keycloakConfig[ "ef-server-url" ] );
 
                 // Fetch Keycloak users
-                let keycloakUsers = await this.fetchKeycloakUsers( keycloakConfig[ "auth-server-url" ], adminToken );
-                const keycloakUsersByRole = await this.fetchKeycloakUsersByRole( keycloakConfig[ "auth-server-url" ], adminToken );
+                let keycloakUsers = await this.fetchKeycloakUsers( keycloakConfig, adminToken );
+                const keycloakUsersByRole = await this.fetchKeycloakUsersByRole( keycloakConfig, adminToken );
                 const keycloakUsersByPermissionGroups = await this.fetchKeycloakUsersByPermissionGroups( keycloakConfig, adminToken );
 
                 if ( ciscoUsers.length > 0 && ciscoTeams.length > 0 ) {
@@ -585,7 +585,7 @@ class CiscoSyncService {
                     await this.syncUsersToCX( ciscoUsers, keycloakUsers, keycloakUsersByRole, keycloakUsersByPermissionGroups, keycloakConfig, adminToken );
 
                     //Once users are synced, we fetch updated keycloak users list.
-                    keycloakUsers = await this.fetchKeycloakUsers( keycloakConfig[ "auth-server-url" ], adminToken );
+                    keycloakUsers = await this.fetchKeycloakUsers( keycloakConfig, adminToken );
 
                     let userSyncedToMongo = await this.syncKeycloakUsersToCXMongo( keycloakConfig[ "USERNAME_ADMIN" ], keycloakConfig[ "PASSWORD_ADMIN" ], keycloakConfig[ "ef-server-url" ] );
 
@@ -739,6 +739,9 @@ class CiscoSyncService {
                         }
                     } )
 
+                } else {
+
+                    reject( er );
                 }
 
             }
@@ -912,6 +915,9 @@ class CiscoSyncService {
                         }
                     } )
 
+                } else {
+
+                    reject( er );
                 }
 
             }
@@ -919,11 +925,11 @@ class CiscoSyncService {
         } );
     }
 
-    async fetchKeycloakUsers( keycloakURL, adminToken ) {
+    async fetchKeycloakUsers( keycloakConfig, adminToken ) {
 
         return new Promise( async ( resolve, reject ) => {
 
-            let URL = keycloakURL + 'admin/realms/expertflow/users?max=100000';
+            let URL = keycloakConfig[ "auth-server-url" ] + `admin/realms/${keycloakConfig[ "realm" ]}/users?max=100000`;
 
             let config = {
 
@@ -933,8 +939,6 @@ class CiscoSyncService {
                     Accept: "application/json",
                     "cache-control": "no-cache",
                     "Content-Type": "application/x-www-form-urlencoded",
-                },
-                headers: {
                     Authorization: "Bearer " + adminToken,
                 },
 
@@ -952,7 +956,7 @@ class CiscoSyncService {
         } )
     }
 
-    async fetchKeycloakUsersByRole( keycloakURL, adminToken ) {
+    async fetchKeycloakUsersByRole( keycloakConfig, adminToken ) {
 
         return new Promise( async ( resolve, reject ) => {
 
@@ -963,7 +967,7 @@ class CiscoSyncService {
             // Use Promise.all to handle multiple role requests concurrently
             for ( let role of roles ) {
 
-                const URL = `${keycloakURL}admin/realms/expertflow/roles/${role}/users?max=1000000`;
+                const URL = `${keycloakConfig[ "auth-server-url" ]}admin/realms/${keycloakConfig[ "realm" ]}/roles/${role}/users?max=1000000`;
 
                 const config = {
                     method: "get",
@@ -1023,7 +1027,7 @@ class CiscoSyncService {
                 // Use Promise.all to handle multiple role requests concurrently
                 for ( let group of permissionGroupsObj ) {
 
-                    const URL = `${keycloakConfig[ "auth-server-url" ]}admin/realms/expertflow/groups/${group.id}/members?max=1000000`;
+                    const URL = `${keycloakConfig[ "auth-server-url" ]}admin/realms/${keycloakConfig[ "realm" ]}/groups/${group.id}/members?max=1000000`;
 
                     const config = {
 

package/services/dynamics365Service.js

@@ -15,12 +15,12 @@ class Dynamics365Service {
 
             let config = {
                 method: 'get',
-                'Content-Type': 'application/json',
-                'Accept': 'application/json',
-                'OData-MaxVersion': '4.0',
-                'OData-Version': '4.0',
                 url: URL,
                 headers: {
+                    'Content-Type': 'application/json',
+                    'Accept': 'application/json',
+                    'OData-MaxVersion': '4.0',
+                    'OData-Version': '4.0',
                     'Authorization': `Bearer ${validationToken}`
                 },
                 //disable ssl
@@ -106,4 +106,4 @@ class Dynamics365Service {
     }
 }
 
-module.exports = Dynamics365Service;
+module.exports = Dynamics365Service;

package/services/errorService.js

@@ -82,10 +82,20 @@ class ErrorService {
                                 };
                             case 'invalid_grant':
 
+                                let reasonToReturn
+                                if ( err.response.status === 400 ) {
+                                    if(errorData.error_description.includes('Account disabled')){
+                                        reasonToReturn = "Account Disabled: User account has been disabled in Keycloak."
+                                    }
+                                    else 
+                                        reasonToReturn = 'Password Update Required: Please update your password, as it was set temporarily by the admin or has expired.'
+                                }
+                                else reasonToReturn = 'Invalid User Credentials: The provided credentials are not valid. Please enter valid user credentials.'
                                 return {
                                     status: err.response.status,
-                                    reason: 'Invalid User Credentials: The provided credentials are not valid. Please enter valid user credentials.',
+                                    reason: reasonToReturn,
                                 };
+
                             default:
 
                                 if ( typeof ( err.response.data ) === "object" ) {
@@ -115,7 +125,7 @@ class ErrorService {
                     } else {
 
                         if ( typeof ( err.response.data ) === "object" ) {
-
+                            
                             return {
                                 status: err.response.status,
                                 reason: err.response.data.error

package/services/finesseService.js

@@ -97,6 +97,9 @@ class FinesseService {
                         }
                     } )
 
+                } else {
+
+                    reject( er );
                 }
 
             }
@@ -189,6 +192,9 @@ class FinesseService {
                         }
                     } )
 
+                } else {
+
+                    reject( er );
                 }
             }