feat(token): added subtype in phone-island (#334)

Author: edospadoni

root/usr/lib/node/nethcti-server/plugins/authentication/authentication.js

@@ -1209,14 +1209,20 @@ function isAutoUpdateTokenExpires() {
         return true;
       }
     }
-    // Check the api persistent token
-    if (persistentTokens.has(`${username}_phone-island`)) {
-      const pTokenApi = persistentTokens.get(`${username}_phone-island`).token;
-      // Compare the given encrypted token with the api persistent token
-      if (pTokenApi === hashToken) {
-        return true;
+
+    // Check the api persistent tokens (both web and nethlink)
+    const subtypes = ['web', 'nethlink'];
+    for (const subtype of subtypes) {
+      const tokenKey = `${username}_phone-island_${subtype}`;
+      if (persistentTokens.has(tokenKey)) {
+        const pTokenApi = persistentTokens.get(tokenKey).token;
+        // Compare the given encrypted token with the api persistent token
+        if (pTokenApi === hashToken) {
+          return true;
+        }
       }
     }
+
     // Return false if there aren't matching tokens
     return false
   } catch (err) {
@@ -1268,7 +1274,11 @@ function verifyToken(username, token, isRemote) {
     }
 
     // check the grant presence
-    if (!grants[username] && !persistentTokens.has(username) && !persistentTokens.has(`${username}_phone-island`)) {
+    const phoneIslandTokenExists = ['web', 'nethlink'].some(subtype =>
+      persistentTokens.has(`${username}_phone-island_${subtype}`)
+    );
+
+    if (!grants[username] && !persistentTokens.has(username) && !phoneIslandTokenExists) {
       logger.log.warn(IDLOG, 'authentication failed for ' + (isRemote ? 'remote site ' : 'local ') + 'username: "' + username + '": no grant is present');
       return false;
     }

root/usr/lib/node/nethcti-server/plugins/com_authentication_rest/plugins_rest/authentication.js

@@ -221,7 +221,7 @@ function setCompUser(comp) {
       api: {
         'root': 'authentication',
         'get': [
-          'phone_island_token_check'
+          'phone_island_token_check/:subtype'
         ],
 
         /**
@@ -361,15 +361,22 @@ function setCompUser(comp) {
        */
        phone_island_token_login: async function(req, res) {
         try {
+          // Check parameters
+          if (req.params.subtype !== 'web' && req.params.subtype !== 'nethlink') {
+            throw new Error('wrong parameters: ' + JSON.stringify(arguments));
+          }
 
           // Get the username from the headers
           const username = req.headers.authorization_user;
           // Get the valid token from the request
           // The token validity is checked inside the authorization proxy
           const authToken = req.headers.authorization_token;
 
+          // Get token login subtype. Default: web. Can be 'web' or 'nethlink'
+          const subTypeToken = req.params.subtype || 'web';
+
           // Add _phone-island to the end of api username tokens
-          const apiUsername = `${username}_phone-island`;
+          const apiUsername = `${username}_phone-island_${subTypeToken}`;
 
           // Create the persistent token using username and a valid authentication token
           const apiToken = await compAuthe.getPersistentToken(apiUsername, authToken);
@@ -433,12 +440,19 @@ function setCompUser(comp) {
        */
        phone_island_token_check: async function(req, res) {
         try {
+          // Check parameters
+          if (req.params.subtype !== 'web' && req.params.subtype !== 'nethlink') {
+            throw new Error('wrong parameters: ' + JSON.stringify(arguments));
+          }
 
           // Get the username from the headers
           const username = req.headers.authorization_user;
 
+          // Get token login subtype. Default: web. Can be 'web' or 'nethlink'
+          const subTypeToken = req.params.subtype || 'web';
+
           // Add _phone-island to the end of api username tokens
-          const islandUsername = `${username}_phone-island`;
+          const islandUsername = `${username}_phone-island_${subTypeToken}`;
 
           // Check if the persistent token exists
           const exists = await compAuthe.persistentTokenExists(islandUsername);
@@ -455,19 +469,24 @@ function setCompUser(comp) {
 
       /**
        * Provides the api to revoke a persistent token
-       * 
+       *
        *    persistent_token_remove
-       * 
+       *
        * @param {object} req The client request
        * @param {object} res The client response
        */
       persistent_token_remove: async function(req, res) {
         try {
-          // Check parameters
+          // Check parameters type
           if (req.params.type !== 'phone-island' && req.params.type !== 'no-exp') {
             throw new Error('wrong parameters: ' + JSON.stringify(arguments));
           }
 
+          // Check parameters subtype
+          if (req.params.subtype !== 'web' && req.params.subtype !== 'nethlink') {
+            throw new Error('wrong parameters: ' + JSON.stringify(arguments));
+          }
+
           // Get the username from the headers
           const username = req.headers.authorization_user;
           // Get the token from the headers
@@ -478,7 +497,11 @@ function setCompUser(comp) {
 
           // Set target username to be revoked
           if (req.params.type === 'phone-island') {
-            userToRevoke = `${username}_phone-island`;
+            // Get token login subtype. Default: web. Can be 'web' or 'nethlink'
+            const subTypeToken = req.params.subtype || 'web';
+
+            // Compose token name to remove
+            userToRevoke = `${username}_phone-island_${subTypeToken}`;
           } else if (req.params.type === 'no-exp') {
             userToRevoke = username;
           }