@villedemontreal/jwt-validator 5.7.7

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@villedemontreal/jwt-validator",
+  "version": "5.7.7",
+  "description": "Module to validate JWT (JSON Web Tokens)",
+  "main": "dist/src/index.js",
+  "typings": "dist/src",
+  "files": [
+    "src",
+    "dist"
+  ],
+  "scripts": {
+    "start": "node run test",
+    "test": "node run test",
+    "compile": "node run compile",
+    "prepare": "node run compile",
+    "prepublishOnly": "node run test",
+    "lint": "node run lint",
+    "lint-fix": "node run lint-fix",
+    "tslint": "node run tslint",
+    "tslint-fix": "node run tslint-fix",
+    "prettier": "node run prettier",
+    "prettier-fix": "node run prettier-fix",
+    "watch": "node run watch"
+  },
+  "keywords": [
+    "mtl",
+    "jwt",
+    "jwt-verification",
+    "security",
+    "authentication"
+  ],
+  "author": "Ville de Montréal",
+  "license": "MIT",
+  "dependencies": {
+    "@types/app-root-path": "1.2.4",
+    "@types/express": "4.17.13",
+    "@types/http-status-codes": "1.2.0",
+    "@types/jsonwebtoken": "8.5.9",
+    "@types/lodash": "4.14.184",
+    "@types/nock": "10.0.3",
+    "@types/node": "18.7.14",
+    "@types/request": "2.48.8",
+    "@types/request-promise-native": "1.0.18",
+    "@types/superagent": "4.1.15",
+    "@typescript-eslint/eslint-plugin": "5.36.1",
+    "@typescript-eslint/parser": "5.36.1",
+    "@villedemontreal/general-utils": "5.16.7",
+    "@villedemontreal/http-request": "7.4.5",
+    "@villedemontreal/logger": "6.5.7",
+    "app-root-path": "3.1.0",
+    "http-header-fields-typed": "1.3.0",
+    "http-status-codes": "2.2.0",
+    "jsonwebtoken": "8.5.1",
+    "lodash": "4.17.21",
+    "moment": "2.29.4",
+    "nock": "13.2.9",
+    "superagent": "7.1.6"
+  },
+  "devDependencies": {
+    "@types/chai": "4.3.3",
+    "@types/fs-extra": "9.0.13",
+    "@types/mocha": "9.1.1",
+    "@types/sinon": "10.0.13",
+    "@types/validator": "13.7.6",
+    "@villedemontreal/scripting": "2.1.6",
+    "chai": "4.3.6",
+    "eslint": "8.23.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "fs-extra": "10.1.0",
+    "mocha": "9.2.2",
+    "mocha-jenkins-reporter": "0.4.7",
+    "mock-express-request": "0.2.2",
+    "node-mocks-http": "1.11.0",
+    "node-notifier": "10.0.1",
+    "nyc": "15.1.0",
+    "sinon": "14.0.0",
+    "superagent-mocker": "0.5.2",
+    "typescript": "4.8.2",
+    "validator": "13.7.0"
+  }
+}

package/src/config/configs.ts

@@ -0,0 +1,145 @@
+import { ILogger } from '@villedemontreal/logger';
+import * as os from 'os';
+import * as path from 'path';
+import { constants } from './constants';
+
+/**
+ * Lib configs
+ */
+export class Configs {
+  public isWindows: boolean;
+  public libRoot: string;
+  /**
+   * The host to query the public keys
+   */
+  private _host: string;
+  /**
+   * The endpoint to query the public keys
+   */
+  private _endpoint: string = constants.default.endpoint;
+  /**
+   * The parameters to query the public keys
+   */
+  private _fetchKeysParameters: string = constants.default.fetchKeysParameters;
+  /**
+   * Cache duration
+   */
+  private _cacheDuration: number = constants.default.cacheDuration;
+
+  private _loggerCreator: (name: string) => ILogger;
+  private _correlationIdProvider: () => string;
+
+  constructor() {
+    this.libRoot = path.normalize(__dirname + '/../../..');
+    this.isWindows = os.platform() === 'win32';
+  }
+
+  /**
+   * Get the host to query the public keys
+   * @return {string} host
+   */
+  public getHost() {
+    if (!this._host) {
+      throw new Error(`The "host" must be set!`);
+    }
+    return this._host;
+  }
+
+  /**
+   * Get the endpoint to query the public keys
+   * @return {string} endpoint
+   */
+  public getEndpoint() {
+    return this._endpoint;
+  }
+
+  /**
+   * Get the parameters to query the public keys
+   * @return {string} fetchKeysParameters
+   */
+  public getFetchKeysParameters() {
+    return this._fetchKeysParameters;
+  }
+
+  /**
+   * Get the cache duration in seconds
+   * @return {number} cacheDuration
+   */
+  public getCacheDuration() {
+    return this._cacheDuration;
+  }
+
+  /**
+   * Set the host to query the public keys
+   * @param {string} host
+   * @return
+   */
+  public setHost(host: string) {
+    this._host = host;
+  }
+
+  /**
+   * Set the endpoint to query the public keys
+   * @param {string} endpoint
+   * @return
+   */
+  public setEndpoint(endpoint: string) {
+    this._endpoint = endpoint;
+  }
+
+  /**
+   * Set the paramters to query the public keys
+   * @param {string} fetchKeysParameters
+   * @return
+   */
+  public setFetchKeysParameters(fetchKeysParameters: string) {
+    this._fetchKeysParameters = fetchKeysParameters;
+  }
+
+  /**
+   * Get the cache duration in seconds
+   * @param {number} cacheDuration
+   * @return
+   */
+  public setCacheDuration(cacheDuration: number) {
+    this._cacheDuration = cacheDuration;
+  }
+
+  /**
+   * The Logger creator
+   */
+  get loggerCreator(): (name: string) => ILogger {
+    if (!this._loggerCreator) {
+      throw new Error(`The Logger Creator HAS to be set as a configuration`);
+    }
+    return this._loggerCreator;
+  }
+
+  /**
+   * Sets the Logger creator.
+   */
+  public setLoggerCreator(loggerCreator: (name: string) => ILogger) {
+    this._loggerCreator = loggerCreator;
+  }
+
+  /**
+   * Sets the Correlation Id provider.
+   */
+  public setCorrelationIdProvider(correlationIdProvider: () => string) {
+    this._correlationIdProvider = correlationIdProvider;
+  }
+
+  /**
+   * The Correlation Id provider
+   */
+  get correlationIdProvider(): () => string {
+    if (!this._correlationIdProvider) {
+      throw new Error(
+        `The Correlation Id provider HAS to be set as a configuration! Please call the init(...) fonction first.`
+      );
+    }
+    return this._correlationIdProvider;
+  }
+}
+
+export const configs = new Configs();

package/src/config/constants.ts

@@ -0,0 +1,83 @@
+// ==========================================
+// Application constants
+// ==========================================
+import { path as appRoot } from 'app-root-path';
+import * as path from 'path';
+
+/**
+ * Library constants
+ */
+export class Constants {
+  /**
+   * The library root. When this library is used
+   * as a dependency in a project, the "libRoot"
+   * will be the path to the dependency folder,
+   * inside the "node_modules".
+   */
+  public libRoot: string;
+
+  /**
+   * The app root. When this library is used
+   * as a dependency in a project, the "appRoot"
+   * will be the path to the root project!
+   */
+  public appRoot: string;
+
+  constructor() {
+    // From the "dist/src/config" folder
+    this.libRoot = path.normalize(__dirname + '/../../..');
+    this.appRoot = appRoot;
+  }
+
+  /**
+   * Errors related constants
+   */
+  get errors() {
+    return {
+      codes: {
+        // Main Code
+        INVALID_HEADER: 'invalidHeader',
+        ACCOUNT_ALREADY_EXISTS: 'accountAlreadyExists',
+        ACCOUNT_NOT_FOUND: 'accountNotFound',
+        ACCOUNT_ALREADY_VERIFIED: 'accountAlreadyVerified',
+        INVALID_AUTHORIZATION_HEADER: 'invalidAuthorizationHeader',
+        INVALID_JWT: 'invalidJWT',
+        CODE_NOT_FOUND: 'codeNotFound',
+        CODE_EXPIRED: 'codeExpired',
+        PHONE_NOT_FOUND: 'phoneNotFound',
+        UNABLE_TO_GET_PUBLIC_KEY: 'unableToGetPublicKey',
+
+        // Value Code
+        NULL_VALUE: 'nullValue',
+        INVALID_VALUE: 'invalidValue',
+        INVALID_EMAIL_VALUE: 'invalidEmailValue',
+        UNAUTHORIZED_ACCESS: 'unauthorizedAccess',
+
+        // Information Code
+        TEST_REMAINING: 'testRemaining',
+      },
+    };
+  }
+
+  /**
+   * Extra values that we can add to the original Express request.
+   */
+  get requestExtraVariables() {
+    return {
+      JWT: 'jwt',
+    };
+  }
+
+  /**
+   * Default values
+   */
+  get default() {
+    return {
+      endpoint: '/api/security/v1/keys',
+      fetchKeysParameters: 'state=active&state=revoked&offset=0&limit=25',
+      cacheDuration: 60 * 5,
+    };
+  }
+}
+
+export const constants: Constants = new Constants();

package/src/config/init.ts

@@ -0,0 +1,58 @@
+import { init as initHttpUtils } from '@villedemontreal/http-request';
+import { ILogger } from '@villedemontreal/logger';
+import { configs } from './configs';
+import { constants } from './constants';
+
+let libIsInited = false;
+
+/**
+ * Inits the library.
+ */
+export function init(
+  loggerCreator: (name: string) => ILogger,
+  correlationIdProvider: () => string,
+  host: string,
+  endpoint: string = constants.default.endpoint,
+  fetchKeysParameters: string = constants.default.fetchKeysParameters,
+  cacheDuration: number = constants.default.cacheDuration,
+  urlCaseSensitive = false
+): void {
+  if (!loggerCreator) {
+    throw new Error(`The Logger Creator is required.`);
+  }
+  configs.setLoggerCreator(loggerCreator);
+
+  if (!correlationIdProvider) {
+    throw new Error(`The Correlation Id provider is required.`);
+  }
+  configs.setCorrelationIdProvider(correlationIdProvider);
+
+  configs.setHost(host);
+  configs.setEndpoint(endpoint);
+  configs.setFetchKeysParameters(fetchKeysParameters);
+  configs.setCacheDuration(cacheDuration);
+
+  // ==========================================
+  // Inits the Http Utils library!
+  // ==========================================
+  initHttpUtils(loggerCreator, correlationIdProvider, urlCaseSensitive);
+
+  // ==========================================
+  // Set as being "properly initialized".
+  // At the very end of the "init()" function!
+  // ==========================================
+  libIsInited = true;
+}
+
+/**
+ * Is the library properly initialized?
+ *
+ * This function MUST be named "isInited()"!
+ * Code using this library may loop over all its "@villedemontreal"
+ * dependencies and, if one of those exports a "isInited" fonction,
+ * it will enforce that the lib has been properly initialized before
+ * starting...
+ */
+export function isInited(): boolean {
+  return libIsInited;
+}

package/src/index.ts

@@ -0,0 +1,15 @@
+export * from './config/constants';
+// ==========================================
+// We do not export the configs instance itself,
+// only the "init()" method, so we can define
+// which are the required parameters.
+// ==========================================
+export * from './config/init';
+export * from './jwtValidator';
+export * from './middleware/jwtMiddleware';
+export * from './models/expressRequest';
+export * from './models/gluuUserType';
+export * from './models/jwtPayload';
+export * from './models/publicKey';
+export * from './userValidator';
+export * from './utils/jwtMock';