@nsshunt/stsutils 1.5.0 → 1.5.6

package/authutilsbrowser.js

@@ -0,0 +1,87 @@
+const debug = require('debug')(`stsutils`);
+const colors = require('colors');
+const axios = require('axios');
+
+class AuthUtilsBrowser
+{
+	constructor()
+	{
+
+	}
+
+	#GetDurationColour(duration)
+	{
+		if (duration > 250) {
+			return colors.red;
+		} else if (duration > 150) {
+			return colors.magenta;
+		} else if (duration > 50) {
+			return colors.blue;
+		} else if (duration > 10) {
+			return colors.green;
+		} else {
+			return colors.black;
+		}
+	}
+
+	LoginBrowser = async (options) => {
+		const { authendpoint, authUserName, authUserEMail, authUserPassword, defaultTimeout, publishDebug } = options;
+		try {
+			let processStart = performance.now();
+			let duration = 0;
+			let accessToken = null;
+			let payload = { name: authUserName, password: authUserPassword, email: authUserEMail }
+			let retVal = await axios({
+				url: `${authendpoint}/login`
+				,method: 'post'
+				,data: payload
+				,timeout: defaultTimeout
+			});
+			duration = (performance.now() - processStart).toFixed(4);
+			if (publishDebug) debug(this.#GetDurationColour(duration)(`AuthUtilsBrowser.LoginBrowser request duration: [${duration}]`));
+			accessToken = retVal.data.detail.token;
+			return {
+				accessToken: accessToken,
+				duration: duration
+			}
+		} catch (error) {
+			if (publishDebug) debug(`Error (AuthUtilsBrowser:LoginBrowser): ${error}`.red);
+			throw error;
+		}
+	};
+
+	// https://stackoverflow.com/questions/43002444/make-axios-send-cookies-in-its-requests-automatically
+	// axios.get('some api url', {withCredentials: true});
+	// https://medium.com/@adityasrivast/handling-cookies-with-axios-872790241a9b
+	// https://www.codegrepper.com/code-examples/javascript/axios+send+cookies
+	// http only cookies
+	RefreshAuthTokenBrowser = async (options) => {
+		const { authendpoint, defaultTimeout, publishDebug } = options;
+		try {
+			let processStart = performance.now();
+			let duration = 0;
+			let accessToken = null;
+			// https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials
+			// https://stackoverflow.com/questions/43002444/make-axios-send-cookies-in-its-requests-automatically
+			// axios.get('some api url', {withCredentials: true});
+			let retVal = await axios({
+				url: `${authendpoint}/refreshtoken` 
+				,method: 'post'
+				,timeout: defaultTimeout
+				,withCredentials: true
+			});
+			duration = (performance.now() - processStart).toFixed(4);
+			if (publishDebug) debug(this.#GetDurationColour(duration)(`AuthUtilsBrowser.RefreshAuthTokenBrowser request duration: [${duration}]`));
+			accessToken = retVal.data.detail.token;
+			return {
+				accessToken: accessToken,
+				duration: duration
+			}
+		} catch (error) {
+			if (publishDebug) debug(`Error (AuthUtilsBrowser:RefreshAuthTokenBrowser): ${error}`.red);
+			throw error;
+		}
+	}
+}
+
+module.exports = AuthUtilsBrowser;

package/index.js

@@ -0,0 +1,6 @@
+let sleep = require('./sleep.js');
+let status = require('./status.js');
+const AuthUtilsBrowser = require('./authutilsbrowser.js');
+const STSOptionsBase = require('./stsoptionsbase.js');
+
+module.exports = { sleep, status, STSOptionsBase, AuthUtilsBrowser };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@nsshunt/stsutils",
-  "version": "1.5.0",
+  "version": "1.5.6",
   "description": "",
-  "main": "stsutils.js",
+  "main": "index.js",
   "scripts": {
     "lint": "eslint . --ext js,jsx,ts,tsx --fix",
     "test": "jest --detectOpenHandles --no-cache",

package/stsoptionsbase.js

@@ -21,4 +21,4 @@ class STSOptionsBase
 	}
 }
 
-module.exports = { STSOptionsBase };
+module.exports = STSOptionsBase;

package/authutils.js

@@ -1,293 +0,0 @@
-const debug = require('debug')(`stsutils`);
-const jwt = require('jsonwebtoken');
-const { status } = require('./status');
-const fs = require('fs');
-const goptions = require('@nsshunt/stsconfig').$options;
-const tough = require('tough-cookie');
-const Cookie = tough.Cookie;
-const cookiejar = new tough.CookieJar();
-const colors = require('colors');
-const axios = require('axios');
-const http = require('http');
-
-class AuthUtils
-{
-	#privateKey = null;
-	#publicKey = null;
-	#httpAgent  = null;
-
-	constructor()
-	{
-		// On-line key generators
-		// http://travistidwell.com/jsencrypt/demo/
-		// https://www.csfieldguide.org.nz/en/interactives/rsa-key-generator/
-		// https://jwt.io/
-
-		// This code is for development / non-prod purposes only.
-		// For production, the keys to come from a secrets store.
-		this.#privateKey = fs.readFileSync(goptions.asprivatekeypath, 'utf8');
-		this.#publicKey = fs.readFileSync(goptions.aspublickeypath, 'utf8');
-	}
-
-	get privateKey()
-	{
-		return this.#privateKey;
-	}
-
-	get publicKey()
-	{
-		return this.#publicKey;
-	}
-
-	/*
-	// Source;
-	// https://github.com/auth0/jwt-decode/issues/53
-	#assertAlive(decoded)
-	{
-		const now = Date.now().valueOf() / 1000
-		if (typeof decoded.exp !== 'undefined' && decoded.exp < now) {
-			throw new Error(`token expired: ${JSON.stringify(decoded)}`)
-		}
-		if (typeof decoded.nbf !== 'undefined' && decoded.nbf > now) {
-			throw new Error(`token not yet valid: ${JSON.stringify(decoded)}`)
-		}
-	}
-
-	#tokenTimeLeft(decoded)
-	{
-		const now = Date.now().valueOf() / 1000;
-		return now - decoded.exp;
-	}
-	*/
-
-	async verifyRequestMiddleware(req, res, next)
-	{
-		try
-		{
-			let authHeader = req.header('Authorization');
-			if (authHeader === undefined)
-			{
-				res.status(status.unauthorized).send( { status: status.unauthorized, error: 'Token not preset', detail: { message: 'The Authorization header not provided.' } } );
-				return;
-			}
-			let authType = authHeader.split(' ')[0];
-			let token = authHeader.split(' ')[1];
-
-			if (authType !== 'Bearer')
-			{
-				res.status(status.unauthorized).send( { status: status.unauthorized, error: 'Token not preset', detail: { message: 'The Authorization type provided is not Bearer.' } } );
-				return;
-			}
-
-			let i  = 'STS';
-			//let s  = user.id;
-			//let a  = user.email;
-
-			let verifyOptions = 
-            {
-            	issuer:  i,
-            	//subject:  s,
-            	//audience:  a,
-            	//expiresIn:  600, // 10 minutes
-            	algorithm:  ["RS256"]   // RSASSA [ "RS256", "RS384", "RS512" ]
-            };
-
-			let retVal = jwt.verify(token, this.#publicKey, verifyOptions);
-
-			req.stsuser = {
-				email: retVal.user.email,
-				userid: retVal.user.id,
-				isadmin: false,
-				firstname: retVal.user.name,
-				lastname: 'NA'
-			};
-        
-			next();
-		} catch (error)
-		{
-			if (error instanceof jwt.JsonWebTokenError)
-			{
-				res.status(status.unauthorized).send( { status: status.unauthorized, error: 'Invalid Token', detail: error } );
-			} else{
-				res.status(status.error).send( { status: status.error, error: 'Operation was not successful', detail: error } );
-			}
-		}
-	}
-
-	#GetDurationColour(duration)
-	{
-		if (duration > 250) {
-			return colors.red;
-		} else if (duration > 150) {
-			return colors.magenta;
-		} else if (duration > 50) {
-			return colors.blue;
-		} else if (duration > 10) {
-			return colors.green;
-		} else {
-			return colors.black;
-		}
-	}
-
-	LoginBrowser = async (options) => {
-		const { authendpoint, authUserName, authUserEMail, authUserPassword, defaultTimeout, publishDebug } = options;
-		try {
-			let processStart = performance.now();
-			let duration = 0;
-			let accessToken = null;
-			let payload = { name: authUserName, password: authUserPassword, email: authUserEMail }
-			let retVal = await axios({
-				url: `${authendpoint}/login`
-				,method: 'post'
-				,data: payload
-				,timeout: defaultTimeout
-			});
-			duration = (performance.now() - processStart).toFixed(4);
-			if (publishDebug) debug(this.#GetDurationColour(duration)(`AuthUtils.LoginBrowser request duration: [${duration}]`));
-			accessToken = retVal.data.detail.token;
-			return {
-				accessToken: accessToken,
-				duration: duration
-			}
-		} catch (error) {
-			if (publishDebug) debug(`Error (AuthUtils:LoginBrowser): ${error}`.red);
-			throw error;
-		}
-	};
-
-	// https://stackoverflow.com/questions/43002444/make-axios-send-cookies-in-its-requests-automatically
-	// axios.get('some api url', {withCredentials: true});
-	// https://medium.com/@adityasrivast/handling-cookies-with-axios-872790241a9b
-	// https://www.codegrepper.com/code-examples/javascript/axios+send+cookies
-	// http only cookies
-	RefreshAuthTokenBrowser = async (options) => {
-		const { authendpoint, defaultTimeout, publishDebug } = options;
-		try {
-			let processStart = performance.now();
-			let duration = 0;
-			let accessToken = null;
-			// https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials
-			// https://stackoverflow.com/questions/43002444/make-axios-send-cookies-in-its-requests-automatically
-			// axios.get('some api url', {withCredentials: true});
-			let retVal = await axios({
-				url: `${authendpoint}/refreshtoken` 
-				,method: 'post'
-				,timeout: defaultTimeout
-				,withCredentials: true
-			});
-			duration = (performance.now() - processStart).toFixed(4);
-			if (publishDebug) debug(this.#GetDurationColour(duration)(`AuthUtils.RefreshAuthTokenBrowser request duration: [${duration}]`));
-			accessToken = retVal.data.detail.token;
-			return {
-				accessToken: accessToken,
-				duration: duration
-			}
-		} catch (error) {
-			if (publishDebug) debug(`Error (AuthUtils:RefreshAuthTokenBrowser): ${error}`.red);
-			throw error;
-		}
-	}
-
-	#setCookiesToJar = (authendpoint, headers) =>
-	{
-		let cookies = null;
-		if (headers['set-cookie'] instanceof Array)
-			cookies = headers['set-cookie'].map(Cookie.parse);
-		else
-			cookies = [Cookie.parse(headers['set-cookie'])];
-	
-		return cookiejar.setCookie(cookies[0], `${authendpoint}`);
-	};
-
-	#getCookiesFromJar = (authendpoint) =>
-	{
-		return cookiejar.getCookies(`${authendpoint}`);
-	};
-
-	#getHttpAgent = () =>
-	{
-		if (this.#httpAgent === null) {
-			// https://nodejs.org/api/http.html#class-httpagent
-			this.#httpAgent = new http.Agent({ 
-				keepAlive: true,
-				maxSockets: 10,
-				maxTotalSockets: 10,
-				maxFreeSockets: 10,
-				timeout: 5000
-			});
-		}
-		return this.#httpAgent;
-	}
-
-	LoginNode = async (options) =>
-	{
-		const { authendpoint, authUserName, authUserEMail, authUserPassword, defaultTimeout, publishDebug } = options;
-		try {
-			let processStart = performance.now();
-			let duration = 0;
-			let accessToken = null;
-			let payload = { name: authUserName, password: authUserPassword, email: authUserEMail }
-			let retVal = await axios({
-				url: `${authendpoint}/login` 
-				,method: 'post'
-				,data: payload
-				,timeout: defaultTimeout
-				,httpAgent: this.#getHttpAgent()
-				// Use below if using a socket endpoint
-				//,socketPath: '/var/run/sts/stsrest01.sock'
-			});
-			duration = (performance.now() - processStart).toFixed(4);
-			if (publishDebug) debug(this.#GetDurationColour(duration)(`AuthUtils.LoginNode request duration: [${duration}]`));
-			accessToken = retVal.data.detail.token;
-			await this.#setCookiesToJar(authendpoint, retVal.headers);
-			return {
-				accessToken: accessToken,
-				duration: duration
-			}
-		} catch (error)
-		{
-			if (publishDebug) debug(`Error (AuthUtils:LoginNode): ${error}`.red);
-			throw error;
-		}
-	}
-
-	// https://stackoverflow.com/questions/43002444/make-axios-send-cookies-in-its-requests-automatically
-	// axios.get('some api url', {withCredentials: true});
-	// https://medium.com/@adityasrivast/handling-cookies-with-axios-872790241a9b
-	// https://www.codegrepper.com/code-examples/javascript/axios+send+cookies
-	// http only cookies
-	RefreshAuthTokenNode = async (options) =>
-	{
-		const { authendpoint, defaultTimeout, publishDebug } = options;
-		try {
-			let processStart = performance.now();
-			let duration = 0;
-			let accessToken = null;
-			let cookies = await this.#getCookiesFromJar(authendpoint);
-			let retVal = await axios({
-				url: `${authendpoint}/refreshtoken`
-				,method: 'post'
-				,headers: {
-					Cookie: cookies
-				}
-				,timeout: defaultTimeout
-				,httpAgent: this.#httpAgent,
-				// Use below for socket connections
-				//,socketPath: '/var/run/sts/stsrest01.sock'
-			});
-			duration = (performance.now() - processStart).toFixed(4);
-			if (publishDebug) debug(this.#GetDurationColour(duration)(`AuthUtils.RefreshAuthTokenBrowser request duration: [${duration}]`));
-			accessToken = retVal.data.detail.token;
-			await this.#setCookiesToJar(authendpoint, retVal.headers);
-			return {
-				accessToken: accessToken,
-				duration: duration
-			}
-		} catch (error) {
-			if (publishDebug) debug(`Error (AuthUtils:RefreshAuthTokenBrowser): ${error}`.red);
-			throw error;
-		}
-	}
-}
-
-module.exports = { AuthUtils };

package/log.js

@@ -1,33 +0,0 @@
-const cluster = require('cluster');
-const colors = require('colors');
-const debug = require('debug')(`proc:${process.pid}`);
-
-/**
- * Default styles :-
- * Worker messages - green
- * Master messages - cyan + bold
- * IPC Messages - grey. The message command itself will be bold.
- * Signals - yellow (e.g. SIGINT or SIGTERM etc.
- * @param {*} instruments 
- * @returns 
- */
-module.exports = (appName, instruments) =>
-{
-	return (msg) =>
-	{
-		let prefix = '';
-		let col = null;
-
-		if (cluster.isMaster)
-		{
-			prefix = 'M';
-			col = colors.bold.cyan;
-		} else {
-			prefix = 'W';
-			col = colors.green;
-		}
-		let msgEx = col(`${prefix}(${process.pid}) [${appName}]: ${msg}`);
-		debug(msgEx);
-		instruments.logger.LogMessage(msgEx);
-	};
-};

package/network.js

@@ -1,37 +0,0 @@
-const os = require('os');
-
-const GetNetworkInterfaces = () =>
-{
-	const nets = os.networkInterfaces();
-	let results = { };
-	for (const name of Object.keys(nets)) {
-		for (const net of nets[name]) {
-			// Skip over non-IPv4 and internal (i.e. 127.0.0.1) addresses
-			if (net.family === 'IPv4' && !net.internal) {
-				if (!results[name]) {
-					results[name] = [];
-				}
-				results[name].push(net.address);
-			}
-		}
-	}
-	return results;
-};
-
-const GetFirstNetworkInterface = () =>
-{
-	let nics = GetNetworkInterfaces();
-	let hostaddr = null;
-	for (let nic in nics)
-	{
-		let val = nics[nic];
-		if (val.length > 0)
-		{
-			hostaddr = val[0];
-			break;
-		}
-	}
-	return hostaddr;
-}
-
-module.exports = { GetNetworkInterfaces, GetFirstNetworkInterface }

package/stsrouterbase.js

@@ -1,21 +0,0 @@
-const express = require('express');
-
-const { STSOptionsBase } = require('./stsoptionsbase.js');
-
-class STSRouterBase extends STSOptionsBase
-{
-	#router = null;
-
-	constructor(options)
-	{
-    	super(options);
-    	this.#router = express.Router();
-	}
-
-	get Router()
-	{
-    	return this.#router;
-	}
-}
-
-module.exports = { STSRouterBase };

package/stsutils.js

@@ -1,9 +0,0 @@
-let sleep = require('./sleep.js');
-let status = require('./status.js');
-let network = require('./network.js');
-let authutils = require('./authutils.js');
-let stsoptionsbase = require('./stsoptionsbase.js');
-let stsrouterbase = require('./stsrouterbase.js');
-let log = require('./log.js');
-
-module.exports = { sleep, status, network, authutils, stsoptionsbase, stsrouterbase, log };