@thzero/library_server_koa 0.15.38 → 0.15.39

package/middleware/authentication.js

@@ -1,83 +1,83 @@
-import LibraryConstants from '@thzero/library_server/constants';
-import LibraryCommonServiceConstants from '@thzero/library_common_service/constants';
-
-import injector from '@thzero/library_common/utility/injector';
-
-const separator = ': ';
-
-function getAuthToken(context) {
-	if (!context)
-		return null;
-
-	const logger = injector.getService(LibraryCommonServiceConstants.InjectorKeys.SERVICE_LOGGER);
-	const token = context.get(LibraryConstants.Headers.AuthKeys.AUTH);
-	logger.debug('middleware', 'getAuthToken', 'token', token, context.correlationId);
-	if (!String.isNullOrEmpty(token)) {
-		const split = token.split(LibraryConstants.Headers.AuthKeys.AUTH_BEARER + separator);
-		logger.debug('middleware', 'getAuthToken', 'split', split, context.correlationId);
-		logger.debug('middleware', 'getAuthToken', 'split.length', split.length, context.correlationId);
-		if (split.length > 1)
-			return split[1];
-	}
-
-	logger.debug('middleware', 'getAuthToken', 'fail', null, context.correlationId);
-	return null;
-}
-
-const authentication = (required) => {
-	return async (ctx, next) => {
-		const logger = injector.getService(LibraryCommonServiceConstants.InjectorKeys.SERVICE_LOGGER);
-
-		const token = getAuthToken(ctx);
-		logger.debug('middleware', 'authentication', 'token', token, ctx.correlationId);
-		logger.debug('middleware', 'authentication', 'required', required, ctx.correlationId);
-		const valid = ((required && !String.isNullOrEmpty(token)) || !required);
-		logger.debug('middleware', 'authentication', 'valid1', (required && !String.isNullOrEmpty(token)), request.correlationId);
-		if (required && !String.isNullOrEmpty(token)) {
-			const service = injector.getService(LibraryConstants.InjectorKeys.SERVICE_AUTH);
-			const results = await service.verifyToken(ctx.correlationId, token);
-			logger.debug('middleware', 'authentication', 'results', results, ctx.correlationId);
-			if (!results || !results.success) {
-				logger.warn('middleware', 'authentication', 'Unauthenticated... invalid token', null, ctx.correlationId);
-				ctx.throw(401);
-				return;
-			}
-
-			ctx.state.token = token;
-			ctx.state.user = results.user;
-			ctx.state.claims = results.claims;
-
-			await next();
-			return;
-		}
-		logger.debug('middleware', 'authentication', 'valid2', !required, request.correlationId);
-		if (!required) {
-			await next();
-			return;
-		}
-
-		(async () => {
-			const usageMetrics = {
-				url: ctx.request.path,
-				correlationId: ctx.correlationId,
-				href: ctx.request.href,
-				headers: ctx.request.headers,
-				host: ctx.request.host,
-				hostname: ctx.request.hostname,
-				querystring: ctx.request.querystring,
-				type: ctx.request.type,
-				token: ctx.request.token
-			};
-			const serviceUsageMetrics = injector.getService(LibraryConstants.InjectorKeys.SERVICE_USAGE_METRIC);
-			await serviceUsageMetrics.register(usageMetrics).catch((err) => {
-				const logger = injector.getService(LibraryCommonServiceConstants.InjectorKeys.SERVICE_LOGGER);
-				logger.error('middleware', 'authentication', err, null, ctx.correlationId);
-			});
-		})();
-
-		logger.warn('middleware', 'authentication', 'Unauthorized... authentication unknown', null, ctx.correlationId);
-		ctx.throw(401);
-	}
-}
-
-export default authentication;
+import LibraryConstants from '@thzero/library_server/constants';
+import LibraryCommonServiceConstants from '@thzero/library_common_service/constants';
+
+import injector from '@thzero/library_common/utility/injector';
+
+const separator = ': ';
+
+function getAuthToken(context) {
+	if (!context)
+		return null;
+
+	const logger = injector.getService(LibraryCommonServiceConstants.InjectorKeys.SERVICE_LOGGER);
+	const token = context.get(LibraryConstants.Headers.AuthKeys.AUTH);
+	logger.debug('middleware', 'getAuthToken', 'token', token, context.correlationId);
+	if (!String.isNullOrEmpty(token)) {
+		const split = token.split(LibraryConstants.Headers.AuthKeys.AUTH_BEARER + separator);
+		logger.debug('middleware', 'getAuthToken', 'split', split, context.correlationId);
+		logger.debug('middleware', 'getAuthToken', 'split.length', split.length, context.correlationId);
+		if (split.length > 1)
+			return split[1];
+	}
+
+	logger.debug('middleware', 'getAuthToken', 'fail', null, context.correlationId);
+	return null;
+}
+
+const authentication = (required) => {
+	return async (ctx, next) => {
+		const logger = injector.getService(LibraryCommonServiceConstants.InjectorKeys.SERVICE_LOGGER);
+
+		const token = getAuthToken(ctx);
+		logger.debug('middleware', 'authentication', 'token', token, ctx.correlationId);
+		logger.debug('middleware', 'authentication', 'required', required, ctx.correlationId);
+		const valid = ((required && !String.isNullOrEmpty(token)) || !required);
+		logger.debug('middleware', 'authentication', 'valid1', (required && !String.isNullOrEmpty(token)), request.correlationId);
+		if (required && !String.isNullOrEmpty(token)) {
+			const service = injector.getService(LibraryConstants.InjectorKeys.SERVICE_AUTH);
+			const results = await service.verifyToken(ctx.correlationId, token);
+			logger.debug('middleware', 'authentication', 'results', results, ctx.correlationId);
+			if (!results || !results.success) {
+				logger.warn('middleware', 'authentication', 'Unauthenticated... invalid token', null, ctx.correlationId);
+				ctx.throw(401);
+				return;
+			}
+
+			ctx.state.token = token;
+			ctx.state.user = results.user;
+			ctx.state.claims = results.claims;
+
+			await next();
+			return;
+		}
+		logger.debug('middleware', 'authentication', 'valid2', !required, request.correlationId);
+		if (!required) {
+			await next();
+			return;
+		}
+
+		(async () => {
+			const usageMetrics = {
+				url: ctx.request.path,
+				correlationId: ctx.correlationId,
+				href: ctx.request.href,
+				headers: ctx.request.headers,
+				host: ctx.request.host,
+				hostname: ctx.request.hostname,
+				querystring: ctx.request.querystring,
+				type: ctx.request.type,
+				token: ctx.request.token
+			};
+			const serviceUsageMetrics = injector.getService(LibraryConstants.InjectorKeys.SERVICE_USAGE_METRIC);
+			await serviceUsageMetrics.register(usageMetrics).catch((err) => {
+				const logger = injector.getService(LibraryCommonServiceConstants.InjectorKeys.SERVICE_LOGGER);
+				logger.error('middleware', 'authentication', err, null, ctx.correlationId);
+			});
+		})();
+
+		logger.warn('middleware', 'authentication', 'Unauthorized... authentication unknown', null, ctx.correlationId);
+		ctx.throw(401);
+	}
+}
+
+export default authentication;

package/middleware/authorization.js

@@ -1,191 +1,191 @@
-import LibraryConstants from '@thzero/library_server/constants';
-import LibraryCommonServiceConstants from '@thzero/library_common_service/constants';
-
-import injector from '@thzero/library_common/utility/injector';
-
-// require('../utility/string.cjs');
-String.isNullOrEmpty = function(value) {
-	//return !(typeof value === 'string' && value.length > 0)
-	return !value;
-}
-
-String.isString = function(value) {
-	return (typeof value === "string" || value instanceof String);
-}
-
-String.trim = function(value) {
-	if (!value || !String.isString(value))
-		return value;
-	return value.trim();
-}
-
-const logicalAnd = 'and';
-const logicalOr = 'or';
-
-const authorizationCheckClaims = async (ctx, success, logical, security, logger) => {
-	if (!ctx)
-		return false;
-	if (!(ctx.state.claims && Array.isArray(ctx.state.claims)))
-		return false;
-
-	let result;
-	let roleAct;
-	let roleObj;
-	let roleParts;
-	for (const claim of ctx.state.claims) {
-		logger.debug('middleware', 'authorization', 'authorization.claim', claim, ctx.correlationId);
-
-		for (const role of ctx.state.roles) {
-			logger.debug('middleware', 'authorization', 'role', role, ctx.correlationId);
-
-			roleParts = role.split('.');
-			if (roleParts && roleParts.length < 1)
-				success = false;
-
-			roleObj = roleParts[0];
-			roleAct = roleParts.length >= 2 ? roleParts[1] : null
-
-			result = await security.validate(claim, null, roleObj, roleAct);
-			logger.debug('middleware', 'authorization', 'result', result, ctx.correlationId);
-			if (logical === logicalOr)
-				success = success || result;
-			else
-				success = success && result;
-		}
-	}
-
-	return success;
-}
-
-const authorizationCheckRoles = async (ctx, success, logical, security, logger) => {
-	if (!ctx)
-		return false;
-
-	logger.debug('middleware', 'authorizationCheckRoles', 'user', ctx.state.user, ctx.correlationId);
-	if (!(ctx.state.user && ctx.state.user.roles && Array.isArray(ctx.state.user.roles)))
-		return false;
-
-	logger.debug('middleware', 'authorizationCheckRoles', 'logical', logical, ctx.correlationId);
-
-	let result;
-	let roleAct;
-	let roleObj;
-	let roleParts;
-	for (const userRole of ctx.state.user.roles) {
-		logger.debug('middleware', 'authorizationCheckRoles', 'userRole', userRole, ctx.correlationId);
-
-		for (const role of ctx.state.roles) {
-			logger.debug('middleware', 'authorizationCheckRoles', 'role', role, ctx.correlationId);
-
-			roleParts = role.split('.');
-			if (roleParts && roleParts.length < 1)
-				success = false;
-
-			roleObj = roleParts[0];
-			roleAct = roleParts.length >= 2 ? roleParts[1] : null
-
-			result = await security.validate(userRole, null, roleObj, roleAct);
-			logger.debug('middleware', 'authorizationCheckRoles', 'result', result, ctx.correlationId);
-			if (logical === logicalOr) {
-				if (result)
-					return result;
-
-				success = false;
-			}
-			else
-				success = success && result;
-		}
-	}
-
-	return success;
-}
-
-const initalizeRoles = (ctx, roles, logger) => {
-	if (Array.isArray(roles)) {
-		// logger.debug('middleware', 'initalizeRoles', 'roles1a', roles);
-		ctx.state.roles = roles;
-	}
-	else if ((typeof(roles) === 'string') || (roles instanceof String)) {
-		// logger.debug('middleware', 'initalizeRoles', 'roles1b', roles);
-		ctx.state.roles = roles.split(',');
-		ctx.state.roles.map(item => item ? item.trim() : item);
-	}
-}
-
-const authorization = (roles, logical) => {
-	if (String.isNullOrEmpty(logical) || (logical !== logicalAnd) || (logical !== logicalOr))
-		logical = logicalOr;
-
-	return async (ctx, next) => {
-		const config = injector.getService(LibraryCommonServiceConstants.InjectorKeys.SERVICE_CONFIG);
-		const logger = injector.getService(LibraryCommonServiceConstants.InjectorKeys.SERVICE_LOGGER);
-		const security = injector.getService(LibraryConstants.InjectorKeys.SERVICE_SECURITY);
-
-		// logger.debug('token', ctx.state.token);
-		logger.debug('middleware', 'authorization', 'user', ctx.state.user, ctx.correlationId);
-		logger.debug('middleware', 'authorization', 'claims', ctx.state.claims, ctx.correlationId);
-		logger.debug('middleware', 'authorization', 'roles1', roles, ctx.correlationId);
-		ctx.state.roles = [];
-		if (roles) {
-			// logger.debug('authorization.roles1', roles);
-			// logger.debug('authorization.roles1', (typeof roles));
-			// logger.debug('authorization.roles1', Array.isArray(roles));
-			// logger.debug('authorization.roles1', ((typeof(roles) === 'string') || (roles instanceof String)));
-			// if (Array.isArray(roles)) {
-			// 	// logger.debug('authorization.roles1a', roles);
-			// 	ctx.state.roles = roles;
-			// }
-			// else if ((typeof(roles) === 'string') || (roles instanceof String)) {
-			// 	// logger.debug('authorization.roles1b', roles);
-			// 	ctx.state.roles = roles.split(',');
-			// 	ctx.state.roles.map(item => item ? item.trim() : item);
-			// }
-			initalizeRoles(ctx, roles, logger);
-		}
-		logger.debug('middleware', 'authorization', 'roles2', ctx.state.roles, ctx.correlationId);
-
-		let success = false; //(logical === logicalOr ? false : true);
-		if (ctx.state.roles && Array.isArray(ctx.state.roles) && (ctx.state.roles.length > 0)) {
-			const auth = config.get('auth');
-			if (auth) {
-				logger.debug('middleware', 'authorization', 'auth.claims', auth.claims, ctx.correlationId);
-				logger.debug('middleware', 'authorization', 'auth.claims.check', auth.claims.check, ctx.correlationId);
-			}
-			if (auth && auth.claims && auth.claims.check)
-				success = await authorizationCheckClaims(ctx, (logical === logicalOr ? false : true), logical, security, logger);
-
-			if (!success)
-				success = await authorizationCheckRoles(ctx, (logical === logicalOr ? false : true), logical, security, logger);
-		}
-
-		logger.debug('middleware', 'authorization', 'success', null, ctx.state.success, ctx.correlationId);
-		if (success) {
-			await next();
-			return;
-		}
-
-		(async () => {
-			const serviceUsageMetrics = injector.getService(LibraryConstants.InjectorKeys.SERVICE_USAGE_METRIC);
-			const usageMetrics = {
-				url: ctx.request.path,
-				correlationId: ctx.correlationId,
-				href: ctx.request.href,
-				headers: ctx.request.headers,
-				host: ctx.request.host,
-				hostname: ctx.request.hostname,
-				querystring: ctx.request.querystring,
-				type: ctx.request.type,
-				token: ctx.request.token
-			};
-			await serviceUsageMetrics.register(usageMetrics).catch((err) => {
-				const logger = injector.getService(LibraryCommonServiceConstants.InjectorKeys.SERVICE_LOGGER);
-				logger.error(null, err);
-			});
-		})();
-
-		logger.warn('middleware', 'authorization', 'Unauthorized... authorization unknown', null, ctx.correlationId);
-		ctx.throw(401);
-	}
-}
-
-export default authorization;
+import LibraryConstants from '@thzero/library_server/constants';
+import LibraryCommonServiceConstants from '@thzero/library_common_service/constants';
+
+import injector from '@thzero/library_common/utility/injector';
+
+// require('../utility/string.cjs');
+String.isNullOrEmpty = function(value) {
+	//return !(typeof value === 'string' && value.length > 0)
+	return !value;
+}
+
+String.isString = function(value) {
+	return (typeof value === "string" || value instanceof String);
+}
+
+String.trim = function(value) {
+	if (!value || !String.isString(value))
+		return value;
+	return value.trim();
+}
+
+const logicalAnd = 'and';
+const logicalOr = 'or';
+
+const authorizationCheckClaims = async (ctx, success, logical, security, logger) => {
+	if (!ctx)
+		return false;
+	if (!(ctx.state.claims && Array.isArray(ctx.state.claims)))
+		return false;
+
+	let result;
+	let roleAct;
+	let roleObj;
+	let roleParts;
+	for (const claim of ctx.state.claims) {
+		logger.debug('middleware', 'authorization', 'authorization.claim', claim, ctx.correlationId);
+
+		for (const role of ctx.state.roles) {
+			logger.debug('middleware', 'authorization', 'role', role, ctx.correlationId);
+
+			roleParts = role.split('.');
+			if (roleParts && roleParts.length < 1)
+				success = false;
+
+			roleObj = roleParts[0];
+			roleAct = roleParts.length >= 2 ? roleParts[1] : null
+
+			result = await security.validate(claim, null, roleObj, roleAct);
+			logger.debug('middleware', 'authorization', 'result', result, ctx.correlationId);
+			if (logical === logicalOr)
+				success = success || result;
+			else
+				success = success && result;
+		}
+	}
+
+	return success;
+}
+
+const authorizationCheckRoles = async (ctx, success, logical, security, logger) => {
+	if (!ctx)
+		return false;
+
+	logger.debug('middleware', 'authorizationCheckRoles', 'user', ctx.state.user, ctx.correlationId);
+	if (!(ctx.state.user && ctx.state.user.roles && Array.isArray(ctx.state.user.roles)))
+		return false;
+
+	logger.debug('middleware', 'authorizationCheckRoles', 'logical', logical, ctx.correlationId);
+
+	let result;
+	let roleAct;
+	let roleObj;
+	let roleParts;
+	for (const userRole of ctx.state.user.roles) {
+		logger.debug('middleware', 'authorizationCheckRoles', 'userRole', userRole, ctx.correlationId);
+
+		for (const role of ctx.state.roles) {
+			logger.debug('middleware', 'authorizationCheckRoles', 'role', role, ctx.correlationId);
+
+			roleParts = role.split('.');
+			if (roleParts && roleParts.length < 1)
+				success = false;
+
+			roleObj = roleParts[0];
+			roleAct = roleParts.length >= 2 ? roleParts[1] : null
+
+			result = await security.validate(userRole, null, roleObj, roleAct);
+			logger.debug('middleware', 'authorizationCheckRoles', 'result', result, ctx.correlationId);
+			if (logical === logicalOr) {
+				if (result)
+					return result;
+
+				success = false;
+			}
+			else
+				success = success && result;
+		}
+	}
+
+	return success;
+}
+
+const initalizeRoles = (ctx, roles, logger) => {
+	if (Array.isArray(roles)) {
+		// logger.debug('middleware', 'initalizeRoles', 'roles1a', roles);
+		ctx.state.roles = roles;
+	}
+	else if ((typeof(roles) === 'string') || (roles instanceof String)) {
+		// logger.debug('middleware', 'initalizeRoles', 'roles1b', roles);
+		ctx.state.roles = roles.split(',');
+		ctx.state.roles.map(item => item ? item.trim() : item);
+	}
+}
+
+const authorization = (roles, logical) => {
+	if (String.isNullOrEmpty(logical) || (logical !== logicalAnd) || (logical !== logicalOr))
+		logical = logicalOr;
+
+	return async (ctx, next) => {
+		const config = injector.getService(LibraryCommonServiceConstants.InjectorKeys.SERVICE_CONFIG);
+		const logger = injector.getService(LibraryCommonServiceConstants.InjectorKeys.SERVICE_LOGGER);
+		const security = injector.getService(LibraryConstants.InjectorKeys.SERVICE_SECURITY);
+
+		// logger.debug('token', ctx.state.token);
+		logger.debug('middleware', 'authorization', 'user', ctx.state.user, ctx.correlationId);
+		logger.debug('middleware', 'authorization', 'claims', ctx.state.claims, ctx.correlationId);
+		logger.debug('middleware', 'authorization', 'roles1', roles, ctx.correlationId);
+		ctx.state.roles = [];
+		if (roles) {
+			// logger.debug('authorization.roles1', roles);
+			// logger.debug('authorization.roles1', (typeof roles));
+			// logger.debug('authorization.roles1', Array.isArray(roles));
+			// logger.debug('authorization.roles1', ((typeof(roles) === 'string') || (roles instanceof String)));
+			// if (Array.isArray(roles)) {
+			// 	// logger.debug('authorization.roles1a', roles);
+			// 	ctx.state.roles = roles;
+			// }
+			// else if ((typeof(roles) === 'string') || (roles instanceof String)) {
+			// 	// logger.debug('authorization.roles1b', roles);
+			// 	ctx.state.roles = roles.split(',');
+			// 	ctx.state.roles.map(item => item ? item.trim() : item);
+			// }
+			initalizeRoles(ctx, roles, logger);
+		}
+		logger.debug('middleware', 'authorization', 'roles2', ctx.state.roles, ctx.correlationId);
+
+		let success = false; //(logical === logicalOr ? false : true);
+		if (ctx.state.roles && Array.isArray(ctx.state.roles) && (ctx.state.roles.length > 0)) {
+			const auth = config.get('auth');
+			if (auth) {
+				logger.debug('middleware', 'authorization', 'auth.claims', auth.claims, ctx.correlationId);
+				logger.debug('middleware', 'authorization', 'auth.claims.check', auth.claims.check, ctx.correlationId);
+			}
+			if (auth && auth.claims && auth.claims.check)
+				success = await authorizationCheckClaims(ctx, (logical === logicalOr ? false : true), logical, security, logger);
+
+			if (!success)
+				success = await authorizationCheckRoles(ctx, (logical === logicalOr ? false : true), logical, security, logger);
+		}
+
+		logger.debug('middleware', 'authorization', 'success', null, ctx.state.success, ctx.correlationId);
+		if (success) {
+			await next();
+			return;
+		}
+
+		(async () => {
+			const serviceUsageMetrics = injector.getService(LibraryConstants.InjectorKeys.SERVICE_USAGE_METRIC);
+			const usageMetrics = {
+				url: ctx.request.path,
+				correlationId: ctx.correlationId,
+				href: ctx.request.href,
+				headers: ctx.request.headers,
+				host: ctx.request.host,
+				hostname: ctx.request.hostname,
+				querystring: ctx.request.querystring,
+				type: ctx.request.type,
+				token: ctx.request.token
+			};
+			await serviceUsageMetrics.register(usageMetrics).catch((err) => {
+				const logger = injector.getService(LibraryCommonServiceConstants.InjectorKeys.SERVICE_LOGGER);
+				logger.error(null, err);
+			});
+		})();
+
+		logger.warn('middleware', 'authorization', 'Unauthorized... authorization unknown', null, ctx.correlationId);
+		ctx.throw(401);
+	}
+}
+
+export default authorization;

package/package.json

@@ -1,40 +1,40 @@
-{
-  "name": "@thzero/library_server_koa",
-  "type": "module",
-  "version": "0.15.38",
-  "version_major": 0,
-  "version_minor": 15,
-  "version_patch": 38,
-  "version_date": "11/25/2022",
-  "description": "An opinionated library of common functionality to bootstrap a Koa based API application.",
-  "author": "thZero",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/thzero/library_server_koa.git"
-  },
-  "bugs": {
-    "url": "https://github.com/thzero/library_server_koa/issues"
-  },
-  "homepage": "https://github.com/thzero/library_server_koa#readme",
-  "engines": {
-    "node": ">=12.8.3"
-  },
-  "scripts": {
-    "cli-update": "library-cli --updateversion --pi",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "dependencies": {
-    "@koa/cors": "^4.0.0",
-    "@koa/router": "^12.0.0",
-    "koa": "^2.13.4",
-    "koa-body": "^6.0.1",
-    "koa-helmet": "^6.1.0",
-    "koa-static": "^5.0.0"
-  },
-  "peerDependencies": {
-    "@thzero/library_common": "^0.15",
-    "@thzero/library_common_service": "^0.15",
-    "@thzero/library_server": "^0.15"
-  }
+{
+  "name": "@thzero/library_server_koa",
+  "type": "module",
+  "version": "0.15.39",
+  "version_major": 0,
+  "version_minor": 15,
+  "version_patch": 39,
+  "version_date": "12/11/2022",
+  "description": "An opinionated library of common functionality to bootstrap a Koa based API application.",
+  "author": "thZero",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thzero/library_server_koa.git"
+  },
+  "bugs": {
+    "url": "https://github.com/thzero/library_server_koa/issues"
+  },
+  "homepage": "https://github.com/thzero/library_server_koa#readme",
+  "engines": {
+    "node": ">=12.8.3"
+  },
+  "scripts": {
+    "cli-update": "library-cli --updateversion --pi",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "@koa/cors": "^4.0.0",
+    "@koa/router": "^12.0.0",
+    "koa": "^2.14.1",
+    "koa-body": "^6.0.1",
+    "koa-helmet": "^6.1.0",
+    "koa-static": "^5.0.0"
+  },
+  "peerDependencies": {
+    "@thzero/library_common": "^0.15",
+    "@thzero/library_common_service": "^0.15",
+    "@thzero/library_server": "^0.15"
+  }
 }