@nsshunt/stsconfig 1.19.0 → 1.20.0

package/.env-default

@@ -141,6 +141,23 @@ AS_PRIVATE_KEY_PATH=/var/lib/sts/stsglobalresources/keys/private.key
 # Auth Server - Public Key (when using JWT)
 AS_PUBLIC_KEY_PATH=/var/lib/sts/stsglobalresources/keys/public.key
 
+# STSBroker Server endpoint
+BROKER_ENDPOINT=http://localhost
+# STSBroker Server port (listen port for the service)
+BROKER_HOST_PORT=3006
+# STSBroker Server port (client port to access the service)
+BROKER_PORT=3006
+# STSBroker Server endpoint
+BROKER_APIROOT=/stsbroker/v1.0
+# STSBroker Prometheus metric support
+BROKER_PROM_SUPPORT=true
+# STSBroker Cluster Server port (port used for cluster prometheus scrapes). Service will listen on this port at mount point /metrics
+BROKER_PROM_CLUSTER_PORT=3016
+# STSBroker Service Name
+BROKER_SERVICE_NAME=STSBroker
+# STSBroker Service Version
+BROKER_SERVICE_VERSION=1.0.0
+
 # STS Test Runner Prometheus metric support
 TR_PROM_SUPPORT=true
 # STS Test Runner Cluster Server port (port used for cluster prometheus scrapes)

package/.env-test-file-2

@@ -95,6 +95,21 @@ AS_ACCESS_TOKEN_EXPIRE=432000
 AS_PRIVATE_KEY_PATH=/var/lib/sts/stsglobalresources/keys/private.key-c
 AS_PUBLIC_KEY_PATH=/var/lib/sts/stsglobalresources/keys/public.key-c
 
+BROKER_ENDPOINT=http://localhost-c
+BROKER_HOST_PORT=3006-c
+BROKER_PORT=3006-c
+BROKER_APIROOT=/stsbroker/v1.0-c
+BROKER_PROM_SUPPORT=false
+BROKER_PROM_CLUSTER_PORT=3016-c
+BROKER_SERVICE_NAME=STSBroker-c
+BROKER_SERVICE_VERSION=1.0.0-c
+BROKER_API_IDENTIFIER=xyz
+BROKER_API_IDENTIFIER_FILE=testapiidentifierFile
+BROKER_CLIENT_ID=xyz
+BROKER_CLIENT_ID_FILE=testclientidfile
+BROKER_CLIENT_SECRET=xyz
+BROKER_CLIENT_SECRET_FILE=testclientsecretfile
+
 TR_PROM_SUPPORT=false
 TR_PROM_CLUSTER_PORT=30150
 TR_SERVICE_NAME=STSRestRunner-c

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nsshunt/stsconfig",
-  "version": "1.19.0",
+  "version": "1.20.0",
   "description": "",
   "main": "stsconfig.js",
   "dependencies": {

package/stsconfig-01.test.js

@@ -165,6 +165,29 @@ describe("Test implicit config settings", () =>
 		expect(goptions.trclientsecretfile).toEqual(undefined);
 	});
 
+	test('Checking default broker service config', async () => 
+	{
+		expect.assertions(14);
+
+		process.env.STSENVFILE = './.env-default'; // Empty environment file
+		let goptions = require('./stsconfig.js').$options;
+
+		expect(goptions.brokerendpoint).toEqual('http://localhost');
+		expect(goptions.brokerhostport).toEqual('3006');
+		expect(goptions.brokerport).toEqual('3006');
+		expect(goptions.brokerapiroot).toEqual('/stsbroker/v1.0');
+		expect(goptions.brokerprometheussupport).toEqual(true);
+		expect(goptions.brokerprometheusclusterport).toEqual('3016');
+		expect(goptions.brokerservicename).toEqual('STSBroker');
+		expect(goptions.brokerserviceversion).toEqual('1.0.0');
+		expect(goptions.brokerapiidentifier).toEqual(undefined);
+		expect(goptions.brokerapiidentifierfile).toEqual(undefined);
+		expect(goptions.brokerclientid).toEqual(undefined);
+		expect(goptions.brokerclientidfile).toEqual(undefined);
+		expect(goptions.brokerclientsecret).toEqual(undefined);
+		expect(goptions.brokerclientsecretfile).toEqual(undefined);
+	});
+
 	test('Checking default additional config items', async () => 
 	{
 		expect.assertions(22);

package/stsconfig-02.test.js

@@ -165,6 +165,29 @@ describe("Test configured settings", () =>
 		expect(goptions.trclientsecretfile).toEqual('testclientsecretfile');
 	});
 
+	test('Checking default broker service config', async () => 
+	{
+		expect.assertions(14);
+
+		process.env.STSENVFILE = './.env-default'; // Empty environment file
+		let goptions = require('./stsconfig.js').$options;
+
+		expect(goptions.brokerendpoint).toEqual('http://localhost-c');
+		expect(goptions.brokerhostport).toEqual('3006-c');
+		expect(goptions.brokerport).toEqual('3006-c');
+		expect(goptions.brokerapiroot).toEqual('/stsbroker/v1.0-c');
+		expect(goptions.brokerprometheussupport).toEqual(false);
+		expect(goptions.brokerprometheusclusterport).toEqual('3016-c');
+		expect(goptions.brokerservicename).toEqual('STSBroker-c');
+		expect(goptions.brokerserviceversion).toEqual('1.0.0-c');
+		expect(goptions.brokerapiidentifier).toEqual('testapiidentifierfilecontents');
+		expect(goptions.brokerapiidentifierfile).toEqual('testapiidentifierFile');
+		expect(goptions.brokerclientid).toEqual('testclientidfilecontents');
+		expect(goptions.brokerclientidfile).toEqual('testclientidfile'); // testclientidfile
+		expect(goptions.brokerclientsecret).toEqual('testclientsecretfilecontents');
+		expect(goptions.brokerclientsecretfile).toEqual('testclientsecretfile');
+	});
+
 	test('Checking default additional config items', async () => 
 	{
 		expect.assertions(22);

package/stsconfig-default.test.js

@@ -165,6 +165,29 @@ describe("Test explicit default config settings", () =>
 		expect(goptions.trclientsecretfile).toEqual(undefined);
 	});
 
+	test('Checking default broker service config', async () => 
+	{
+		expect.assertions(14);
+
+		process.env.STSENVFILE = './.env-default'; // Empty environment file
+		let goptions = require('./stsconfig.js').$options;
+
+		expect(goptions.brokerendpoint).toEqual('http://localhost');
+		expect(goptions.brokerhostport).toEqual('3006');
+		expect(goptions.brokerport).toEqual('3006');
+		expect(goptions.brokerapiroot).toEqual('/stsbroker/v1.0');
+		expect(goptions.brokerprometheussupport).toEqual(true);
+		expect(goptions.brokerprometheusclusterport).toEqual('3016');
+		expect(goptions.brokerservicename).toEqual('STSBroker');
+		expect(goptions.brokerserviceversion).toEqual('1.0.0');
+		expect(goptions.brokerapiidentifier).toEqual(undefined);
+		expect(goptions.brokerapiidentifierfile).toEqual(undefined);
+		expect(goptions.brokerclientid).toEqual(undefined);
+		expect(goptions.brokerclientidfile).toEqual(undefined);
+		expect(goptions.brokerclientsecret).toEqual(undefined);
+		expect(goptions.brokerclientsecretfile).toEqual(undefined);
+	});
+
 	test('Checking default additional config items', async () => 
 	{
 		expect.assertions(22);

package/stsconfig.js

@@ -214,7 +214,41 @@ const defconfig =
 	,asprivatekeypath: (process.env.AS_PRIVATE_KEY_PATH === undefined ? "/var/lib/sts/stsglobalresources/keys/private.key" : process.env.AS_PRIVATE_KEY_PATH)
 	// Auth Server - [DEPRECATED] Public Key (when using JWT)
 	,aspublickeypath: (process.env.AS_PUBLIC_KEY_PATH === undefined ? "/var/lib/sts/stsglobalresources/keys/public.key" : process.env.AS_PUBLIC_KEY_PATH)
-	
+
+	// STS Broker Server
+	// ---------------
+	// The STS broker server is a BFF service used for STS SPAs. The service will use 1st party secured cookies for session management.
+	// The service also provides proxy API access to other STS and/or external services.
+	//
+	// STSBroker Server endpoint
+	,brokerendpoint: (process.env.BROKER_ENDPOINT === undefined ? "http://localhost" : process.env.BROKER_ENDPOINT)
+	// STSBroker Server port (listen port for the service)
+	,brokerhostport: (process.env.BROKER_HOST_PORT === undefined ? "3006" : process.env.BROKER_HOST_PORT)
+	// STSBroker Server port (client port to access the service)
+	,brokerport: (process.env.BROKER_PORT === undefined ? "3006" : process.env.BROKER_PORT)
+	// STSBroker Server endpoint
+	,brokerapiroot: (process.env.BROKER_APIROOT === undefined ? "/stsbroker/v1.0" : process.env.BROKER_APIROOT)
+	// STSBroker API Identifier. This value will be used as the audience parameter on authorization calls (OAuth2 client credentials flow).
+	,brokerapiidentifier: process.env.BROKER_API_IDENTIFIER
+	// STSBroker API Identifier file. This value will be used as the audience parameter on authorization calls (OAuth2 client credentials flow).
+	,brokerapiidentifierfile: process.env.BROKER_API_IDENTIFIER_FILE
+	// STSBroker Prometheus metric support
+	,brokerprometheussupport: (process.env.BROKER_PROM_SUPPORT === undefined ? true : (process.env.BROKER_PROM_SUPPORT === "true" ? true : false))
+	// STSBroker Cluster Server port (port used for cluster prometheus scrapes). Service will listen on this port at mount point /metrics
+	,brokerprometheusclusterport: (process.env.BROKER_PROM_CLUSTER_PORT === undefined ? "3016" : process.env.BROKER_PROM_CLUSTER_PORT)
+	// STSBroker Service Name
+	,brokerservicename: (process.env.BROKER_SERVICE_NAME === undefined ? "STSBroker" : process.env.BROKER_SERVICE_NAME)
+	// STSBroker Service Version
+	,brokerserviceversion: (process.env.BROKER_SERVICE_VERSION === undefined ? "1.0.0" : process.env.BROKER_SERVICE_VERSION)
+	// STSBroker Server client ID. Used for oauth2 client credentials flow.
+	,brokerclientid: process.env.BROKER_CLIENT_ID
+	// STSBroker Server client ID file. Used for oauth2 client credentials flow.
+	,brokerclientidfile: process.env.BROKER_CLIENT_ID_FILE
+	// STSBroker Server client secret. Used for oauth2 client credentials flow.
+	,brokerclientsecret: process.env.BROKER_CLIENT_SECRET
+	// STSBroker Server client secret file. Used for oauth2 client credentials flow.
+	,brokerclientsecretfile: process.env.BROKER_CLIENT_SECRET_FILE
+
 	// STS Test Runner Prometheus metric support
 	,trprometheussupport: (process.env.TR_PROM_SUPPORT === undefined ? true : (process.env.TR_PROM_SUPPORT === "true" ? true : false ))
 	// STS Test Runner Cluster Server port (port used for cluster prometheus scrapes)
@@ -397,17 +431,20 @@ const fileconfig = [
 	{ fileprop: 'asoauthapiidentifierfile', prop: 'asoauthapiidentifier' },
 	{ fileprop: 'asadminapiidentifierfile', prop: 'asadminapiidentifier' },
 	{ fileprop: 'rest01apiidentifierfile', prop: 'rest01apiidentifier' },
+	{ fileprop: 'brokerapiidentifierfile', prop: 'brokerapiidentifier' },
 	{ fileprop: 'toapiidentifierfile', prop: 'toapiidentifier' },
 	{ fileprop: 'imapiidentifierfile', prop: 'imapiidentifier' },
 	// Client ID file processing
 	{ fileprop: 'asclientidfile', prop: 'asclientid' },
 	{ fileprop: 'rest01clientidfile', prop: 'rest01clientid' },
+	{ fileprop: 'brokerclientidfile', prop: 'brokerclientid' },
 	{ fileprop: 'toclientidfile', prop: 'toclientid' },
 	{ fileprop: 'imclientidfile', prop: 'imclientid' },
 	{ fileprop: 'trclientidfile', prop: 'trclientid' },
 	// Client secret file processing
 	{ fileprop: 'asclientsecretfile', prop: 'asclientsecret' },
 	{ fileprop: 'rest01clientsecretfile', prop: 'rest01clientsecret' },
+	{ fileprop: 'brokerclientsecretfile', prop: 'brokerclientsecret' },
 	{ fileprop: 'toclientsecretfile', prop: 'toclientsecret' },
 	{ fileprop: 'imclientsecretfile', prop: 'imclientsecret' },
 	{ fileprop: 'trclientsecretfile', prop: 'trclientsecret' },