@nsshunt/stsconfig 1.16.0 → 1.17.2

package/.env-default

@@ -104,7 +104,7 @@ AS_HOST_PORT=3002
 # Auth Server port (client port to access the service)
 AS_PORT=3002
 # Auth Server endpoint
-AS_APIROOT=/stsauth/v1
+AS_API_ROOT=/stsauth/v1
 # Auth Server Prometheus metric support
 AS_PROM_SUPPORT=true
 # Auth Prometheus Cluster Server port (port used for cluster prometheus scrapes)
@@ -220,3 +220,9 @@ SYSTEM_INFORMATION_INTERVAL=1000
 
 # Ignore socket.io REST api calls and/or WebSocket calls when collecting telemetry for instrumentation purposes.
 IGNORE_SOCKETIO=true
+
+# HTTPS server key path.
+HTTPS_SERVER_KEY_PATH=/var/lib/sts/stsglobalresources/keys/server.key
+
+# HTTPS server cert path.
+HTTPS_SERVER_CERT_PATH=/var/lib/sts/stsglobalresources/keys/server.cert

package/.env-test-file-2

@@ -70,7 +70,7 @@ TO_CLIENT_SECRET_FILE=testclientsecretfile
 AS_ENDPOINT=http://localhost-c
 AS_HOST_PORT=30020
 AS_PORT=30020
-AS_APIROOT=/stsauth/v1-c
+AS_API_ROOT=/stsauth/v1-c
 AS_API_IDENTIFIER=xyz
 AS_API_IDENTIFIER_FILE=testapiidentifierFile
 AS_PROM_SUPPORT=false
@@ -119,3 +119,5 @@ CHILD_PROCESS_EXIT_TIME=5000
 SYSTEM_INFORMATION_INTERVAL=10000
 IGNORE_SOCKETIO=false
 MODEL_PURGE_UPDATE_TIMEOUT=50000
+HTTPS_SERVER_KEY_PATH=/var/lib/sts/stsglobalresources/keys/server.key-c
+HTTPS_SERVER_CERT_PATH=/var/lib/sts/stsglobalresources/keys/server.cert-c

package/package.json

@@ -1,22 +1,22 @@
 {
   "name": "@nsshunt/stsconfig",
-  "version": "1.16.0",
+  "version": "1.17.2",
   "description": "",
   "main": "stsconfig.js",
   "dependencies": {
     "colors": "^1.4.0",
-    "debug": "^4.3.3",
+    "debug": "^4.3.4",
     "dotenv": "^16.0.0"
   },
   "standard": {
     "parser": "@babel/eslint-parser"
   },
   "devDependencies": {
-    "@babel/core": "^7.17.5",
+    "@babel/core": "^7.17.8",
     "@babel/eslint-parser": "^7.17.0",
     "@babel/plugin-proposal-class-properties": "^7.16.7",
     "@babel/plugin-proposal-private-methods": "^7.16.11",
-    "eslint": "^8.10.0",
+    "eslint": "^8.11.0",
     "jest": "^27.5.1"
   },
   "scripts": {

package/stsconfig-01.test.js

@@ -122,14 +122,14 @@ describe("Test implicit config settings", () =>
 		expect(goptions.asendpoint).toEqual('http://localhost');
 		expect(goptions.ashostport).toEqual('3002');
 		expect(goptions.asport).toEqual('3002');
-		expect(goptions.asapiroot).toEqual('/stsauth/v1');
+		expect(goptions.asapiroot).toEqual('/stsauth/v1.0');
 		expect(goptions.asprometheussupport).toEqual(true);
 		expect(goptions.asprometheusclusterport).toEqual('3012');
 		expect(goptions.asservicename).toEqual('STSAuth');
 		expect(goptions.asserviceversion).toEqual('1.0.0');
 		expect(goptions.asprivatekeypath).toEqual('/var/lib/sts/stsglobalresources/keys/private.key');
 		expect(goptions.aspublickeypath).toEqual('/var/lib/sts/stsglobalresources/keys/public.key');
-		expect(goptions.asapiidentifier).toEqual(undefined);
+		expect(goptions.asapiidentifier).toEqual('https://stsmda.com.au/stsauthapi/v1.0/');
 		expect(goptions.asapiidentifierfile).toEqual(undefined);
 		expect(goptions.asclientid).toEqual(undefined);
 		expect(goptions.asclientidfile).toEqual(undefined);
@@ -161,7 +161,7 @@ describe("Test implicit config settings", () =>
 
 	test('Checking default additional config items', async () => 
 	{
-		expect.assertions(20);
+		expect.assertions(22);
 
 		process.env.STSENVFILE = './.env-test-file-1'; // Empty environment file
 		let goptions = require('./stsconfig.js').$options;
@@ -186,6 +186,8 @@ describe("Test implicit config settings", () =>
 		expect(goptions.childProcessExitTime).toEqual(500);
 		expect(goptions.systemInformationInterval).toEqual(1000);
 		expect(goptions.ignoresocketio).toEqual(true);
+		expect(goptions.httpsserverkeypath).toEqual('/var/lib/sts/stsglobalresources/keys/server.key');
+		expect(goptions.httpsservercertpath).toEqual('/var/lib/sts/stsglobalresources/keys/server.cert');
 	});
 });
 

package/stsconfig-02.test.js

@@ -161,7 +161,7 @@ describe("Test configured settings", () =>
 
 	test('Checking default additional config items', async () => 
 	{
-		expect.assertions(20);
+		expect.assertions(22);
 
 		process.env.STSENVFILE = './.env-test-file-1'; // Empty environment file
 		let goptions = require('./stsconfig.js').$options;
@@ -186,6 +186,8 @@ describe("Test configured settings", () =>
 		expect(goptions.childProcessExitTime).toEqual(5000);
 		expect(goptions.systemInformationInterval).toEqual(10000);
 		expect(goptions.ignoresocketio).toEqual(false);
+		expect(goptions.httpsserverkeypath).toEqual('/var/lib/sts/stsglobalresources/keys/server.key-c');
+		expect(goptions.httpsservercertpath).toEqual('/var/lib/sts/stsglobalresources/keys/server.cert-c');
 	});
 });
 

package/stsconfig-default.test.js

@@ -129,7 +129,7 @@ describe("Test explicit default config settings", () =>
 		expect(goptions.asserviceversion).toEqual('1.0.0');
 		expect(goptions.asprivatekeypath).toEqual('/var/lib/sts/stsglobalresources/keys/private.key');
 		expect(goptions.aspublickeypath).toEqual('/var/lib/sts/stsglobalresources/keys/public.key');
-		expect(goptions.asapiidentifier).toEqual(undefined);
+		expect(goptions.asapiidentifier).toEqual('https://stsmda.com.au/stsauthapi/v1.0/');
 		expect(goptions.asapiidentifierfile).toEqual(undefined);
 		expect(goptions.asclientid).toEqual(undefined);
 		expect(goptions.asclientidfile).toEqual(undefined);
@@ -161,7 +161,7 @@ describe("Test explicit default config settings", () =>
 
 	test('Checking default additional config items', async () => 
 	{
-		expect.assertions(20);
+		expect.assertions(22);
 
 		process.env.STSENVFILE = './.env-default'; // Empty environment file
 		let goptions = require('./stsconfig.js').$options;
@@ -186,6 +186,8 @@ describe("Test explicit default config settings", () =>
 		expect(goptions.childProcessExitTime).toEqual(500);
 		expect(goptions.systemInformationInterval).toEqual(1000);
 		expect(goptions.ignoresocketio).toEqual(true);
+		expect(goptions.httpsserverkeypath).toEqual('/var/lib/sts/stsglobalresources/keys/server.key');
+		expect(goptions.httpsservercertpath).toEqual('/var/lib/sts/stsglobalresources/keys/server.cert');
 	});
 });
 

package/stsconfig.js

@@ -164,11 +164,23 @@ const defconfig =
 	// Auth Server port (client port to access the service)
 	,asport: (process.env.AS_PORT === undefined ? "3002" : process.env.AS_PORT)
 	// Auth Server endpoint
-	,asapiroot: (process.env.AS_APIROOT === undefined ? "/stsauth/v1" : process.env.AS_APIROOT)
-	// Auth Server API Identifier. This value will be used as the audience parameter on authorization calls (OAuth2 client credentials flow).
-	,asapiidentifier: process.env.AS_API_IDENTIFIER
-	// Auth Server API Identifier file. This value will be used as the audience parameter on authorization calls (OAuth2 client credentials flow).
+	,asapiroot: (process.env.AS_API_ROOT === undefined ? "/stsauth/v1.0" : process.env.AS_API_ROOT)
+	// Auth Server API Identifier.
+	,asoauthapiroot: (process.env.AS_OAUTH_API_ROOT === undefined ? "/oauth2/v2.0" : process.env.AS_OAUTH_API_ROOT)
+	// Auth Server Admin API Identifier.
+	,asadminapiroot: (process.env.AS_ADMIN_API_ROOT === undefined ? "/admin/v1.0" : process.env.AS_ADMIN_API_ROOT)
+	// Auth Server API Identifier.
+	,asapiidentifier: (process.env.AS_API_IDENTIFIER === undefined ? 'https://stsmda.com.au/stsauthapi/v1.0/' : process.env.AS_API_IDENTIFIER)
+	// Auth Server API Identifier file.
 	,asapiidentifierfile: process.env.AS_API_IDENTIFIER_FILE
+	// Auth Server OAuth API Identifier.
+	,asoauthapiidentifier: (process.env.AS_OAUTH_API_IDENTIFIER === undefined ? 'https://stsmda.com.au/stsauthoauthapi/v2.0/' : process.env.AS_OAUTH_API_IDENTIFIER)
+	// Auth Server OAuth API Identifier file.
+	,asoauthapiidentifierfile: process.env.AS_OAUTH_API_IDENTIFIER_FILE
+	// Auth Server Administration API Identifier.
+	,asadminapiidentifier: (process.env.AS_ADMIN_API_IDENTIFIER === undefined ? 'https://stsmda.com.au/stsauthadminapi/v1.0/' : process.env.AS_ADMIN_API_IDENTIFIER)
+	// Auth Server Administration API Identifier file.
+	,asadminapiidentifierfile: process.env.AS_ADMIN_API_IDENTIFIER_FILE
 	// Auth Server Prometheus metric support
 	,asprometheussupport: (process.env.AS_PROM_SUPPORT === undefined ? true : (process.env.AS_PROM_SUPPORT === "true" ? true : false ))
 	// Auth Prometheus Cluster Server port (port used for cluster prometheus scrapes)
@@ -323,6 +335,26 @@ const defconfig =
 	// activity has been detected. Default 5 seconds.
 	,modelPurgeUpdateTimeout: (process.env.MODEL_PURGE_UPDATE_TIMEOUT === undefined ? 5000 : parseInt(process.env.MODEL_PURGE_UPDATE_TIMEOUT))
 	*/
+
+	// Use command below to create self signed cert;
+	// openssl req -nodes -new -x509 -keyout server.key -out server.cert
+	// Ref: https://www.geeksforgeeks.org/how-to-create-https-server-with-node-js/
+	// HTTPS server key path.
+	,httpsserverkeypath: (process.env.HTTPS_SERVER_KEY_PATH === undefined ? "/var/lib/sts/stsglobalresources/keys/server.key" : process.env.HTTPS_SERVER_KEY_PATH)
+	// HTTPS server cert path.
+	,httpsservercertpath: (process.env.HTTPS_SERVER_CERT_PATH === undefined ? "/var/lib/sts/stsglobalresources/keys/server.cert" : process.env.HTTPS_SERVER_CERT_PATH)
+
+	// Token Service Settings
+	// ----------------------
+	// Maximum number of RSA keys in the JWKS store
+	,tsjwkskeys: (process.env.TS_JWKS_KEYS === undefined ? 3 : parseInt(process.env.TS_JWKS_KEYS))
+
+	// File path for JWKS store data. This file will contain the public and private keys for the JWKS store.
+	,tsjwksstorepath: (process.env.TS_JWKS_STORE_PATH === undefined ? "/var/lib/sts/stsglobalresources/.stsauthprivate/jwks-private.json" : process.env.TS_JWKS_STORE_PATH)
+	// File path for JWKS store path config setting (tsjwksstorepath). Use this config item with Docker/Kubernetes secrets.
+	,tsjwksstorepathfile: process.env.TS_JWKS_STORE_PATH_FILE
+	// File path for JWKS public store data. This file will contain only the public signing keys for the JWKS store.
+	,tsjwksstorepublicpath: (process.env.TS_JWKS_STORE_PUBLIC_PATH === undefined ? "/var/lib/sts/stsglobalresources/.well-known/jwks.json" : process.env.TS_JWKS_STORE_PUBLIC_PATH)
 }
 
 const ReadFile = (passwordFile) => {
@@ -357,6 +389,8 @@ const fileconfig = [
 	{ fileprop: 'toclientsecretfile', prop: 'toclientsecret' },
 	{ fileprop: 'imclientsecretfile', prop: 'imclientsecret' },
 	{ fileprop: 'trclientsecretfile', prop: 'trclientsecret' },
+	// JWKS secret file processing
+	{ fileprop: 'tsjwksstorepathfile', prop: 'tsjwksstorepath' },
 ]
 
 fileconfig.forEach((v) => {