[OGUI-1189] Improve errors returned from O2JsonWebToken and bump the library's version (#3411)

* Add more information on JWT errors usage from token within O2Token service
* Bump version of `jsonwebtoken` library
* Add tests

Author: graduta

Framework/Backend/http/server.js

@@ -516,19 +516,10 @@ class HttpServer {
     } catch ({ name, message }) {
       this.logger.errorMessage(`${name} : ${message}`);
 
-      const response = { error: '403 - Json Web Token Error' };
-
-      // Allow for a custom message for known error messages
-      switch (message) {
-        case 'jwt must be provided':
-          response.message = 'You must provide a JWT token';
-          break;
-        default:
-          response.message = 'Invalid JWT token provided';
-          break;
-      }
-
-      res.status(403).json(response);
+      res.status(403).json({
+        error: '403 - Json Web Token Error',
+        message,
+      });
       return;
     }
 

Framework/Backend/services/O2TokenService.js

@@ -56,7 +56,21 @@ class O2TokenService {
    * @throws {Error} - if token, secret or issuer are invalid
    */
   verify(token) {
-    return jwt.verify(token, this._secret, { issuer: this._issuer });
+    try {
+      return jwt.verify(token, this._secret, { issuer: this._issuer });
+    } catch (error) {
+      switch (error.name) {
+        case 'TokenExpiredError':
+          error.message = `Token expired at ${error.expiredAt}`;
+          break;
+        case 'JsonWebTokenError':
+          error.message = `Invalid token: ${error.message}`;
+          break;
+        default:
+          error.message = `Token verification failed: ${error.message}`;
+      }
+      throw new jwt.JsonWebTokenError(error.message);
+    }
   }
 }
 

Framework/Backend/test/mocha-http.js

@@ -139,7 +139,7 @@ describe('REST API', () => {
       .expect('Content-Type', /json/)
       .expect(403, {
         error: '403 - Json Web Token Error',
-        message: 'Invalid JWT token provided',
+        message: 'Invalid token: jwt malformed',
       }, done);
   });
 
@@ -149,7 +149,7 @@ describe('REST API', () => {
       .expect('Content-Type', /json/)
       .expect(403, {
         error: '403 - Json Web Token Error',
-        message: 'You must provide a JWT token',
+        message: 'Invalid token: jwt must be provided',
       }, done);
   });
 

Framework/Backend/test/mocha-o2web-token.js

@@ -80,7 +80,7 @@ describe('JSON Web Token', () => {
       const o2Token = new O2TokenService(jwt);
       const token = o2Token.generateToken(101, 'alice', 'Alice O2');
       o2Token._secret = 'changed';
-      assert.throws(() => o2Token.verify(token), new JsonWebTokenError('invalid signature'));
+      assert.throws(() => o2Token.verify(token), new JsonWebTokenError('Invalid token: invalid signature'));
     });
   });
 });

Framework/package-lock.json

@@ -33,7 +33,7 @@
   "dependencies": {
     "express": "^4.22.1",
     "helmet": "^8.1.0",
-    "jsonwebtoken": "^9.0.0",
+    "jsonwebtoken": "9.0.3",
     "kafkajs": "^2.2.0",
     "mithril": "1.1.7",
     "mysql": "^2.18.1",