keycloak-api-manager 2.0.5 → 2.0.7

package/.idea/workspace.xml

@@ -79,7 +79,7 @@
       <option name="presentableId" value="Default" />
       <updated>1759849149064</updated>
       <workItem from="1759849150239" duration="1214000" />
-      <workItem from="1759917554117" duration="56831000" />
+      <workItem from="1759917554117" duration="63852000" />
     </task>
     <servers />
   </component>

package/Handlers/usersHandler.js

@@ -557,3 +557,4 @@ exports.updateCredentialLabel=function(){
 }
 
 
+

package/README.md

@@ -100,7 +100,7 @@ await KeycloakManager.configure({
     username: 'admin',                  // Admin username
     password: 'admin',                  // Admin password
     grantType: 'password',              // Type of authentication
-    tokenLifeSpan: 120                   // access_token Lifetime in seconds 
+    tokenLifeSpan: 120                  // access_token Lifetime in seconds 
 });
 
 
@@ -185,13 +185,13 @@ Parameters:
   If this parameter is not provided, it will not be possible to use the administrative functions of Keycloak
   exposed by this adapter, so any attempt to call KeycloakManager.{function} will result in a runtime error due to access on an undefined object
   Main supported options:
+  - baseUrl: [required] Keycloak base Url
+  - realmName: [required] A String that specifies the realm to authenticate against, if different from the "keyCloakConfig.realm" parameter.  If you intend to use Keycloak administrator credentials, this should be set to 'master'.
   - grantType: [required] The OAuth2 grant type used for authentication. example "password". Possible values: 'password', 'client_credentials', 'refresh_token', etc.
   - clientId: [required] string containing the client ID configured in Keycloak. Required for all grant types.
-  - tokenLifeSpan: [required] Lifetime of an access token expressed in seconds. It indicates how often the access token should be renewed. If set incorrectly and the Keycloak token expires before the renewal interval defined by this parameter, errors and exceptions may occur
+  - tokenLifeSpan: [required] Numeric Lifetime of an access token expressed in seconds. It indicates how often the access token should be renewed. If set incorrectly and the Keycloak token expires before the renewal interval defined by this parameter, errors and exceptions may occur
   - username: [optional] string username. Required when using the password grant type. 
   - password: [optional] string password. Required when using the password grant type.
-  - baseUrl: [Optional] Keycloak base Url 
-  - realmName: [Optional] A String that specifies the realm to authenticate against, if different from the "keyCloakConfig.realm" parameter.  If you intend to use Keycloak administrator credentials, this should be set to 'master'.
   - scope: [Optional] A string that specifies The OAuth2 scope requested during authentication (optional). Typically, not required for administrative clients. example:openid profile
   - requestOptions: [Optional] JSON parameters to configure HTTP requests (such as custom headers, timeouts, etc.). It is compatible with the Fetch API standard. Fetch request options https://developer.mozilla.org/en-US/docs/Web/API/fetch#options
   - clientSecret: [Optional] string containing the client secret of the client. Required for client_credentials or confidential clients.

package/index.js

@@ -1,13 +1,5 @@
 var express = require('express');
-var conf=require('./config').conf;
-var responseinterceptor = require('responseinterceptor');
-var Keycloak =require('keycloak-connect');
-var session=require('express-session');
-//const {default: KcAdminClient} = require("@keycloak/keycloak-admin-client");
 var keycloakAdminClient=require('@keycloak/keycloak-admin-client').default;
-var keycloak = null;
-var ready=false;
-var readyQueue=[];
 var kcAdminClient=null;
 var realmHandler=require('./Handlers/realmsHandler');
 var usersHandler=require('./Handlers/usersHandler');
@@ -18,7 +10,9 @@ var groupsHandler=require('./Handlers/groupsHandler');
 var rolesHandler=require('./Handlers/rolesHandler');
 var componentsHandler=require('./Handlers/componentsHandler');
 var authenticationManagementHandler=require('./Handlers/authenticationManagementHandler');
+var request=require('request');
 
+let configAdminclient=null;
 
 /**
  * ***************************** - ENGLISH - *******************************
@@ -44,12 +38,13 @@ var authenticationManagementHandler=require('./Handlers/authenticationManagement
  *    - refreshToken: [Optional] string containing a valid refresh token to request a new access token when using the refresh_token grant type.
  */
 exports.configure=async function(adminClientCredentials){
-        let configAdminclient={
+        configAdminclient={
             baseUrl:adminClientCredentials.baseUrl,
             realmName:adminClientCredentials.realmName
         }
+
         kcAdminClient=  new keycloakAdminClient(configAdminclient);
-        let  tokenLifeSpan= adminClientCredentials.tokenLifeSpan *1000;
+        let  tokenLifeSpan= (adminClientCredentials.tokenLifeSpan *1000)/2;
         delete adminClientCredentials.baseUrl;
         delete adminClientCredentials.realmName;
         delete adminClientCredentials.tokenLifeSpan;
@@ -96,6 +91,7 @@ exports.setConfig=function(configToOverride){
         return(kcAdminClient.setConfig(configToOverride));
 }
 //TODO: Remove da documentare
+// restituisce il token utilizzato dalla libreria per comunicare con la keycloak API
 exports.getToken=function(configToOverride){
         return({
                 accessToken:kcAdminClient.accessToken,
@@ -103,6 +99,27 @@ exports.getToken=function(configToOverride){
         });
 }
 
+//TODO: Remove da documentare
+//permette ad un utente o un client di autenticarsi su keycloack ed oottenere un token
+exports.auth=async function(credentials){
+        let options={
+                url: `${configAdminclient.baseUrl}/realms/${configAdminclient.realmName}/protocol/openid-connect/token` ,
+                headers: {'Authorization': 'Bearer ' + kcAdminClient.accessToken},
+                contentType: 'application/www-form-urlencoded',
+                body: credentials
+        }
+
+        request.post(options, function (error, response, body) {
+                if(error){
+                        console.log("Internal Server Error:", error);
+                }else{
+                        return(body);
+                }
+        });
+}
+
+
+
 
 /*
  <table><tbody>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keycloak-api-manager",
-  "version": "2.0.5",
+  "version": "2.0.7",
   "description": "Keycloak-api-manager is a lightweight Node.js wrapper for the Keycloak Admin REST API. It provides an easy-to-use functional methods and functions to manage realms, users, roles, clients, groups, and permissions directly from your application code — just like you would from the Keycloak admin console.",
   "main": "index.js",
   "scripts": {
@@ -43,7 +43,6 @@
   ],
   "author": "aromanino (Crs4)",
   "license": "MIT",
-  "devDependencies": {},
   "repository": {
     "type": "git",
     "url": "git+https://github.com/smartenv-crs4/keycloak-api-manager.git"