JD Auth

Authentication and Authorisation for JD Services and Synergy Portal.

Features

• Authenticate Users against the Active Directory
• Generate User Token using Secret/Private Key
• Verify Users Token for validity and expiration.

Installation

By default the Synergy Portal will contain the latest version of JD Auth. In order to validate users of a new/existing service you will need to install JD Auth as a dependency.

To install, run:

npm i @jdplc/jd-auth

This should add the latest version of the package to your package.json file and make the functions available for you to use.

Typical Use Case - VueJS

You will need to create/update your router.js file within the frontend of the service. Which will typically look like this:

import Vue from 'vue';
import Router from 'vue-router';

const router = new Router({
  // your options
});

export default router;

We will be using the Global Navigation Guards (Before) provided by Vue Router. Before each route we will pass the token and secret key (from wherever you have them stored eg config, cookie etc...) into the verifyUserToken method.

At the top of router.js under the existing imports add the following:

import { verifyUserToken } from '@jdplc/jd-auth';

This merely imports the function from the package.

Our verification process and function will look like this:

router.beforeEach((to, from, next) => {
  verifyUserToken(token, privateOrSecretKey)
    .then(response => {
      // do something on resolve
      next();
    })
    .catch(error => {
      // do something on reject
      next({
        path: // return to synergy portal login,
      });
    });
});

API Reference

Available Functions

authenticate(url, username, password) ⇒ object

Authenticates the user against the Active Directory

Kind: global function Returns: object - - Result of Authenication Throws:

• Error - The error message from GetAccountResult

| Param | Type | Description | | --- | --- | --- | | url | string | url for the active directory | | username | string | the employee email address | | password | string | varchar password for the employee |

createUserToken(id, secret) ⇒ string

Creates the Web Token using the Users ID and the Secret key from the env file and set the expiration to 24 hours.

Kind: global function Returns: string - The users web token string.

| Param | Type | Description | | --- | --- | --- | | id | string | The User ID from the DB. | | secret | string | The secret or private key. |

verifyUserToken(token, secret) ⇒ object

Takes the users web token and the secret/private key and verifies the validity of the token. Resolves to an object or rejects with an error message.

Kind: global function Returns: object - returns an object including matching token and expiration.

| Param | Type | Description | | --- | --- | --- | | token | string | The web token that required verification | | secret | string | The secret or private key |