@nsshunt/stsutils 1.7.6 → 1.8.2

package/errorhandling.js

@@ -0,0 +1,12 @@
+const GetErrorPayload = (errorCode, details = null) => {
+	return {
+		error: errorCode.code,
+		error_description: errorCode.description,
+		timestamp: Date.now(),
+		//trace_id: "255d1aef-8c98-452f-ac51-23d051240864", //@@
+		//correlation_id: "fb3d2015-bc17-4bb9-bb85-30c5cf1aaaa7", //@@
+		details: details
+	}
+}
+
+module.exports = GetErrorPayload;

package/index.js

@@ -3,5 +3,10 @@ let status = require('./status.js');
 const AuthUtilsBrowser = require('./authutilsbrowser.js');
 const STSOptionsBase = require('./stsoptionsbase.js');
 const { AddSchema, Validate } = require('./validate.js');
+const GetErrorPayload = require('./errorhandling.js');
+const { OAuth2ParameterType, OIDCStandardClaim, OIDCAddressClaim, compareParameterTypes } = require('./oauth2terms.js');
 
-module.exports = { sleep, status, STSOptionsBase, AuthUtilsBrowser, AddSchema, Validate };
+module.exports = {
+	sleep, status, STSOptionsBase, AuthUtilsBrowser, AddSchema, Validate, GetErrorPayload,
+	OAuth2ParameterType, OIDCStandardClaim, OIDCAddressClaim, compareParameterTypes
+};

package/oauth2terms.js

@@ -0,0 +1,95 @@
+// Ref: https://datatracker.ietf.org/doc/html/rfc6749#appendix-A
+const OAuth2ParameterType = Object.freeze({
+	AUDIENCE: 'AUDIENCE', // STS Extension
+	CLIENT_ID: 'client_id',
+	CLIENT_SECRET: 'client_secret',
+	RESPONSE_TYPE: 'response_type',
+	SCOPE: 'scope',
+	STATE: 'state',
+	REDIRECT_URI: 'redirect_uri',
+	ERROR: 'error',
+	ERROR_DESCRIPTION: 'error_description',
+	ERROR_CODES: 'error_codes', // STS Extension
+	ERROR_URI: 'error_uri',
+	GRANT_TYPE: 'grant_type',
+	CODE: 'code',
+	ACCESS_TOKEN: 'access_token',
+	TOKEN_TYPE: 'token_type',
+	EXPIRES_IN: 'expires_in',
+	USERNAME: 'username',
+	PASSWORD: 'password',
+	REFRESH_TOKEN: 'refresh_token',
+	RESPONSE_MODE: 'response_mode', // STS Extension
+	TIMESTAMP: 'timestamp', // STS Extension
+	TRACE_ID: 'trace_id', // STS Extension
+	CORRELATION_ID: 'correlation_id' // STS Extension
+});
+
+const OAuth2ParameterErrorType = Object.freeze({
+	NOT_EQUAL: {
+		code: 'STS_OAUTH2_ERR_0001',
+		description: 'Parameter values not equal.'
+	},
+	NOT_PRESENT: {
+		code: 'STS_OAUTH2_ERR_0002',
+		description: 'Parameter not provided.'
+	},
+	INVALID_FORMAT: {
+		code: 'STS_OAUTH2_ERR_0003',
+		description: 'Parameter value format invalid.'
+	},
+	EXPIRED: {
+		code: 'STS_OAUTH2_ERR_0004',
+		description: 'Parameter value expired.'
+	}
+});
+
+// OIDC Standard Claims
+// Ref: https://openid.net/specs/openid-connect-core-1_0.html#Claims
+const OIDCStandardClaim = Object.freeze({
+	SUB: 'sub',
+	NAME: 'name',
+	GIVEN_NAME: 'given_name',
+	FAMILY_NAME: 'family_name',
+	MIDDLE_NAME: 'middle_name',
+	NICKNAME: 'nickname',
+	PREFERRED_USERNAME: 'preferred_username',
+	PROFILE: 'profile',
+	PICTURE: 'picture',
+	WEBSITE: 'website',
+	EMAIL: 'email',
+	EMAIL_VERIFIED: 'email_verified',
+	GENDER: 'gender',
+	BIRTHDATE: 'birthdate',
+	ZONEINFO: 'zoneinfo',
+	LOCALE: 'locale',
+	PHONE_NUMBER: 'phone_number',
+	PHONE_NUMBER_VERIFIED: 'phone_number_verified',
+	ADDRESS: 'address',
+	CLIENT_SECRET: 'updated_at'
+});
+
+const OIDCAddressClaim = Object.freeze({
+	FORMATTED: 'formatted',
+	STREET_ADDRESS: 'street_address',
+	LOCALITY: 'locality',
+	REGION: 'region',
+	COUNTRY: 'country'
+});
+
+const compareParameterTypes = (source1, source2, authParameterTypes) => {
+	let errors = [ ];
+	authParameterTypes.forEach(authParameterType => {
+		if (source1[authParameterType.paramaterType].localeCompare(source2[authParameterType]) !== 0) {
+			errors.push({
+				[OAuth2ParameterType.ERROR]: OAuth2ParameterErrorType.NOT_EQUAL.description,
+				[OAuth2ParameterType.ERROR_DESCRIPTION]: `${OAuth2ParameterErrorType.NOT_EQUAL.description}: Parameter: [${authParameterType}]`,
+				[OAuth2ParameterType.ERROR_CODES]: OAuth2ParameterErrorType.NOT_EQUAL.code,
+				[OAuth2ParameterType.TIMESTAMP]: Date.now(),
+			})
+		}
+	});
+	return errors;
+}
+
+module.exports = { OAuth2ParameterType, OIDCStandardClaim, OIDCAddressClaim, OAuth2ParameterErrorType, compareParameterTypes }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nsshunt/stsutils",
-  "version": "1.7.6",
+  "version": "1.8.2",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -30,7 +30,7 @@
     "jest": "^27.5.1"
   },
   "dependencies": {
-    "ajv": "^8.10.0",
+    "ajv": "^8.11.0",
     "axios": "^0.26.1",
     "colors": "^1.4.0",
     "debug": "^4.3.4"