ef-keycloak-connect 1.3.0 → 1.3.2

package/README.md

@@ -332,5 +332,31 @@ It takes 5 arguments:
  ##### Example of non SSO Finesse Auth:
       
       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.
+
+It takes a signle argument:
+
+   - refreshToken: Refresh Token is used to generate the new access token.
+
+Response:
+
+  - If the refresh token is valid then a new access token is returned in reponse along with status code 200. 
+    
+    ``` 
+    {
+      "status": 200,
+      "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJqeEMzZDV5VVZRS1ktY3MwSmhQd29DVzllNjB0VkFPQXBIUDlWUlhsejdBIn0.eyJleHAiOjE2NzgyNzIzNDEsImlhdCI6MTY3ODI3MjEwNSwianRpIjoiNWVkMDBiYzgtNDM1MC00MjQ2LTllOTEtYjE4ZGIyMzc5YTI2IiwiaXNzIjoiaHR0cDovLzE5Mi4xNjguMS4yMDQ6ODA4MC9hdXRoL3JlYWxtcy9EZW1vLUtleWNsb2FrLVJlYWxtIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjY5OGRkYWFkLTZkZTYtNDY1YS04Mjg1LTQ4MWI5NjZjMmYxNiIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRlbW8ta2V5Y2xvYWstY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6ImM2NTNmNDk5LWJlNzMtNDIyNS05MGU4LThkYjBjNDkwYTc5MCIsImFjciI6IjEiLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsiZGVmYXVsdC1yb2xlcy1kZW1vLWtleWNsb2FrLXJlYWxtIiwib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiIsImFnZW50LXJvbGUiXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJhdXRob3JpemF0aW9uIjp7InBlcm1pc3Npb25zIjpbeyJyc2lkIjoiNDBhNzg1MjYtNjNiNy00NDcwLThkZWEtZjRlZDViNTUwOTUzIiwicnNuYW1lIjoiRGVmYXVsdCBSZXNvdXJjZSJ9XX0sInNjb3BlIjoiZW1haWwgcHJvZmlsZSIsInNpZCI6ImM2NTNmNDk5LWJlNzMtNDIyNS05MGU4LThkYjBjNDkwYTc5MCIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwibmFtZSI6InphcnlhYiByYXphIiwiYWdlbnRFeHRlbnNpb24iOiI4MDgxLDYwMDEiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ6YXJ5YWIgcmF6YSIsImdpdmVuX25hbWUiOiJ6YXJ5YWIiLCJmYW1pbHlfbmFtZSI6InJhemEiLCJlbWFpbCI6InphcnlhYkBlbWFpbC5jb20ifQ.Y8NVa0OzAPBwtb6cGyhZxMEyv-o_nTA9ZcvXNcmcEMivqTT0dTE95yNKXYxUQuhTAWE6mPJDwuZ0GuEco7hhxQ6IjjH2j0QwjvqEFFi7KNNdIi-yS4q0elNCjxar8zkHY3Gy8a2d7C_9CQuBN-ernV-JYcmGHENlpmJJpyHfZ5aNkzrcHN5b9qDx2-YZm8pkgFuUv8bwogFFeECzclOlrSGHmaiOI1gp2jkUIw8q23LB8YvzdVg5aHgSDcTKD4gXRrG7C_OQRbCmycOtW4iECLlURnlbbF5Rq4vxzrHjRtBAQmVZ86ITP7yDqEPOWfIxHjODDWWHNL2r7dK8OhNK_g"
+    }
+
+ - If the refresh token is invalid then an error message is returned in reponse along with status code 400.
+ 
+ ```
+   {
+     "status": 400,
+     "message": "Refresh Token expired, please login again"
+   }
       
        

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ef-keycloak-connect",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "Node JS keycloak adapter for authentication and authorization.",
   "main": "index.js",
   "scripts": {

package/services/keycloakService.js

@@ -81,6 +81,7 @@ class KeycloakService extends Keycloak {
 
         return new Promise(async (resolve, reject) => {
             let token;
+            let refresh_token;
             var URL = keycloakConfig["auth-server-url"] + 'realms/' + realm_name + '/protocol/openid-connect/token'
             //keycloakConfig["auth-server-url"] +'realms
             let config = {
@@ -114,6 +115,8 @@ class KeycloakService extends Keycloak {
                         var rptResponse = await requestController.httpRequest(config, true);
                         if (rptResponse.data.access_token) {
                             token = rptResponse.data.access_token;
+                            refresh_token = rptResponse.data.refresh_token;
+
                             var userToken = token;
                             config.data.grant_type = keycloakConfig.GRANT_TYPE;
                             config.data.token = token;
@@ -158,6 +161,8 @@ class KeycloakService extends Keycloak {
                                             //Adding user custom attribute to our token object data.
                                             if (getuserDetails.data[0].attributes) {
                                                 responseObject.attributes = getuserDetails.data[0].attributes;
+                                            } else {
+                                                responseObject.attributes = {};
                                             }
 
                                             delete config.headers.Authorization;
@@ -172,6 +177,7 @@ class KeycloakService extends Keycloak {
 
                                                 let finalObject = {
                                                     'token': userToken,
+                                                    'refresh_token': refresh_token,
                                                     'keycloak_User': responseObject
                                                 }
                                                 resolve(finalObject);
@@ -1061,9 +1067,42 @@ class KeycloakService extends Keycloak {
     async createUser(username, password, token, userRoles) {
 
         let assignRole = [];
+        let assignGroups = ['agents', 'default'];
 
         return new Promise(async (resolve, reject) => {
 
+
+            for (let group of assignGroups) {
+
+                let URL2 = keycloakConfig["auth-server-url"] + 'admin/realms/' + keycloakConfig.realm + '/groups?search=' + group;
+
+                let config1 = {
+                    method: 'get',
+                    url: URL2,
+                    headers: {
+                        'Content-Type': 'application/json',
+                        'Authorization': `Bearer ${token}`
+                    }
+                };
+
+                try {
+                    let groupData = await requestController.httpRequest(config1, true);
+
+                    if (groupData.data.length == 0) {
+
+                        let createdGroup = await this.createGroup(token, group);
+
+                    }
+                } catch (err) {
+                    reject({
+                        "status": err.response.status,
+                        "message": err.response.data.error_description
+                    });
+                }
+
+            }
+
+
             let URL = `${keycloakConfig["auth-server-url"]}${keycloakConfig["USERNAME_ADMIN"]}/realms/${keycloakConfig["realm"]}/users`;
 
             let data = {
@@ -1075,11 +1114,10 @@ class KeycloakService extends Keycloak {
                         value: password,
                         temporary: false
                     }
-                ]
+                ],
+                groups: ["agents", "default"]
             }
 
-
-
             let config = {
                 method: 'post',
                 url: URL,
@@ -1145,6 +1183,43 @@ class KeycloakService extends Keycloak {
         });
     }
 
+    async createGroup(adminToken, groupName) {
+
+        return new Promise(async (resolve, reject) => {
+
+            let URL = `${keycloakConfig["auth-server-url"]}${keycloakConfig["USERNAME_ADMIN"]}/realms/${keycloakConfig["realm"]}/groups`;
+
+            let data = {
+                name: groupName
+            }
+
+
+            let config = {
+                method: 'post',
+                url: URL,
+                headers: {
+                    'Authorization': `Bearer ${adminToken}`
+                },
+                data: data
+            };
+
+            try {
+
+                let createdGroup = await requestController.httpRequest(config, false);
+                resolve(createdGroup.data);
+
+            }
+            catch (err) {
+                reject({
+                    "status": err.response.status,
+                    "message": err.response.data.error_description
+                });
+            }
+
+        });
+
+    }
+
     //Authenticating Finesse User
     async authenticateFinesse(username, password, finesseUrl, userRoles, finesseToken) {
 
@@ -1272,6 +1347,56 @@ class KeycloakService extends Keycloak {
         }
     }
 
+    async generateAccessTokenFromRefreshToken(refreshToken) {
+
+        return new Promise(async (resolve, reject) => {
+            let accessToken;
+            var URL = keycloakConfig["auth-server-url"] + 'realms/' + keycloakConfig.realm + '/protocol/openid-connect/token'
+
+            var config = {
+                method: 'post',
+                url: URL,
+                headers: {
+                    'Content-Type': 'application/x-www-form-urlencoded'
+                },
+                data: {
+                    client_id: keycloakConfig.CLIENT_ID,
+                    client_secret: keycloakConfig.credentials.secret,
+                    grant_type: 'refresh_token',
+                    refresh_token: refreshToken
+                }
+            };
+
+            try {
+                let refreshTokenResponse = await requestController.httpRequest(config, true);
+
+                let accessToken = refreshTokenResponse.data.access_token;
+                resolve({
+                    'status': 200,
+                    'access_token': accessToken
+                });
+
+            } catch (error) {
+
+                if (error.response) {
+
+                    if (error.response.data.error_description == 'Token is not active') {
+                        error.response.data.error_description = 'Refresh Token expired, please login again';
+                    }
+
+                    reject({
+                        'status': error.response.status,
+                        'message': `${error.response.data.error_description}`
+                    });
+
+                } else {
+                    reject({ 'message': error.message });
+                }
+            }
+
+        });
+    }
+
     async checkErrorType(err) {
 
         if (err.code == "ETIMEDOUT") {

package/services/teamsService.js

@@ -116,7 +116,8 @@ class TeamsService {
                                         'team': {
                                             'teamId': id,
                                             'teamName': name
-                                        }
+                                        },
+                                        'attributes': (user.attributes) ? user.attributes : {}
                                     });
                                 }