k2hr3-api 1.0.42 → 2.0.1

package/lib/basicipcheck.js

@@ -1,376 +0,0 @@
-/*
- * K2HR3 REST API
- *
- * Copyright 2017 Yahoo Japan Corporation.
- *
- * K2HR3 is K2hdkc based Resource and Roles and policy Rules, gathers 
- * common management information for the cloud.
- * K2HR3 can dynamically manage information as "who", "what", "operate".
- * These are stored as roles, resources, policies in K2hdkc, and the
- * client system can dynamically read and modify these information.
- *
- * For the full copyright and license information, please view
- * the license file that was distributed with this source code.
- *
- * AUTHOR:   Takeshi Nakatani
- * CREATE:   Tue Oct 23 2018
- * REVISION:
- *
- */
-
-'use strict';
-
-var dns			= require('dns');
-var childProcess= require('child_process');
-
-var	chkiptype	= require('./ipwatch').chkipType;
-var	apiutil		= require('./k2hr3apiutil');
-
-// Debug logging objects
-var r3logger	= require('./dbglogging');
-
-//---------------------------------------------------------
-// Ping & Set result checking IP Address
-//---------------------------------------------------------
-// ipdata:		IP address information
-//				{
-//					ip:			ip,		-> ip address string
-//					cuk:		cuk,	-> cuk string					(not use)
-//					port:		port,	-> port number or *				(not use)
-//					extra:		string	-> 'openstack-auto-v1' or etc	(not use)
-//					tag:		string	-> null or string				(not use)
-//					inboundip:	ip,		-> inbound ip address			(not use)
-//					outboundip:	ip,		-> outbound ip address			(not use)
-//					key:		string	-> this ip address yrn full path(not use)
-//					alive: 		boolean	-> true or false
-//				}
-//
-function checkAddressAliveByPing(ipdata, chkipconfig, callback)
-{
-	var	_callback	= callback;
-	var	_ipdata		= ipdata;								// reference
-	var	_chkipconfig= chkipconfig;
-	var	_timeoutms	= _chkipconfig.timeoutms;
-	var	_command	= null;
-
-	if(!apiutil.isSafeEntity(_callback) || 'function' !== typeof _callback){
-		r3logger.elog('callback parameter is wrong');
-		return;
-	}
-	if(!apiutil.isSafeEntity(_ipdata)){
-		_callback(new Error('IP data is wrong : ' + JSON.stringify(_ipdata)), _ipdata);
-		return;
-	}
-	if(!apiutil.isSafeString(_ipdata.ip)){
-		_callback(new Error('IP Address is wrong : ' + JSON.stringify(_ipdata.ip)), _ipdata);
-		return;
-	}
-	if(!apiutil.isSafeEntity(_chkipconfig)){				// already check this...
-		_callback(new Error('chkipconfig value is wrong : ' + JSON.stringify(_chkipconfig)), _ipdata);
-		return;
-	}
-	if(!apiutil.isSafeEntity(_chkipconfig.timeoutms) || isNaN(_chkipconfig.timeoutms)){
-		r3logger.wlog('timeoutms value is wrong : ' + JSON.stringify(_timeoutms));
-		_timeoutms = 5000;									// default
-	}
-
-	//
-	// Ping - Executing ping command with timeout
-	//
-	var	_timeoutsec	 = (_timeoutms / 1000) + 1;
-
-	if(-1 == _ipdata.ip.indexOf(':')){
-		_command = _chkipconfig.command4;
-	}else{
-		_command = _chkipconfig.command6;
-	}
-	_command += ' ' + apiutil.getSafeString(_chkipconfig.params);
-	_command += ' ' + apiutil.getSafeString(_chkipconfig.timeoutparam);
-	_command += ' ' + _timeoutsec.toString();
-	_command += ' ' + _ipdata.ip;
-
-	childProcess.exec(_command, function(error, stdout, stderr)			// eslint-disable-line no-unused-vars
-	{
-		if(error){
-			r3logger.dlog('Something error occurred pinging to ' + _ipdata.ip + ' by : ' + JSON.stringify(error));
-			_callback(error, _ipdata);
-		}else{
-			_callback(null, _ipdata);
-		}
-	});
-}
-
-//---------------------------------------------------------
-// Check DNS & Set result checking IP Address
-//---------------------------------------------------------
-// ipdata:		IP address information
-//				{
-//					ip:			ip,		-> ip address string
-//					cuk:		cuk,	-> cuk string					(not use)
-//					port:		port,	-> port number or *				(not use)
-//					extra:		string	-> 'openstack-auto-v1' or etc	(not use)
-//					tag:		string	-> null or string				(not use)
-//					inboundip:	ip,		-> inbound ip address			(not use)
-//					outboundip:	ip,		-> outbound ip address			(not use)
-//					key:		string	-> this ip address yrn full path(not use)
-//					alive: 		boolean	-> true or false
-//				}
-//
-function checkAddressAlive(ipdata, chkipconfig, callback)
-{
-	var	_callback	= callback;
-	var	_ipdata		= ipdata;								// reference
-	var	_chkipconfig= chkipconfig;
-	var	_is_and		= false;
-	var	_timeoutms	= _chkipconfig.timeoutms;
-
-	if(!apiutil.isSafeEntity(_callback) || 'function' !== typeof _callback){
-		r3logger.elog('callback parameter is wrong');
-		return;
-	}
-	if(!apiutil.isSafeEntity(_ipdata)){
-		_callback(new Error('IP data is wrong : ' + JSON.stringify(_ipdata)), _ipdata);
-		return;
-	}
-	if(!apiutil.isSafeString(_ipdata.ip)){
-		_callback(new Error('IP Address is wrong : ' + JSON.stringify(_ipdata.ip)), _ipdata);
-		return;
-	}
-	if(!apiutil.isSafeEntity(_chkipconfig)){				// already check this...
-		_callback(new Error('chkipconfig value is wrong : ' + JSON.stringify(_chkipconfig)), _ipdata);
-		return;
-	}
-	if(!apiutil.isSafeEntity(_chkipconfig.type) || ('BasicOr' !== _chkipconfig.type && 'BasicAnd' !== _chkipconfig.type)){
-		_callback(new Error('chkipconfig value is wrong : ' + JSON.stringify(_chkipconfig)), _ipdata);
-		return;
-	}
-	if(chkiptype.CHECKER_TYPE_BASIC_OR == _chkipconfig.type){
-		_is_and		= false;
-	}else{
-		_is_and		= true;
-	}
-	if(!apiutil.isSafeEntity(_chkipconfig.timeoutms) || isNaN(_chkipconfig.timeoutms)){
-		r3logger.wlog('timeoutms value is wrong : ' + JSON.stringify(_timeoutms));
-		_timeoutms = 5000;									// default
-	}
-
-	//
-	// checking DNS with timeout by set timer
-	//
-	try{
-		dns.reverse(_ipdata.ip, function(error, hostnames)
-		{
-			if(error){
-				r3logger.dlog('Something error occurred in dns lookup by error: ' + JSON.stringify(error));
-				if(_is_and){
-					// [Type = AND] DNS is error, then need to check Ping
-					checkAddressAliveByPing(_ipdata, _chkipconfig, _callback);
-				}else{
-					// [Type = OR] DNS is error, then this IP is not alive
-					_callback(error, _ipdata);
-				}
-				return;
-			}
-			r3logger.dlog('Success dns lookup for ip address(' + _ipdata.ip + ') to hostnames(' + JSON.stringify(hostnames) + ').');
-
-			if(_is_and){
-				// [Type = AND] DNS is success, then this IP is alive
-				_callback(null, _ipdata);
-			}else{
-				// [Type = OR] DNS is error, then need to check Ping
-				checkAddressAliveByPing(_ipdata, _chkipconfig, _callback);
-			}
-		});
-
-	}catch(errobj){
-		r3logger.dlog('Something error occurred in dns lookup by error: ' + JSON.stringify(errobj));
-		if(_is_and){
-			// [Type = AND] DNS is error, then need to check Ping
-			checkAddressAliveByPing(_ipdata, _chkipconfig, _callback);
-		}else{
-			// [Type = OR] DNS is error, then this IP is not alive
-			_callback(errobj, _ipdata);
-		}
-	}
-}
-
-//---------------------------------------------------------
-// Check & Set result checking IP Addresses by parallel
-//---------------------------------------------------------
-// ipdatas:		IP address information array
-//				[{
-//					ip:				<string>,			-> ip address string
-//					cuk:			<string>,			-> cuk string								(not use)
-//					port:			<number or *>,		-> port number or *							(not use)
-//					extra:			<string>,			-> 'openstack-auto-v1' or etc				(not use)
-//					inboundip:		<string>,			-> inbound ip address						(not use)
-//					outboundip:		<string>,			-> outbound ip address						(not use)
-//					tag:			<string>,			-> null or string							(not use)
-//					key:			<string>,			-> this ip address yrn full path			(not use)
-//					alive: 			<boolean>			-> true or false
-//				}, ...]
-// start:		start position of ipdatas array
-// chkipconfig:	Configuration for IP addresses checking
-//				{
-//					type:			<string>,			-> IP check type							(not use)
-//					funcmod:		<null or string>,	-> IP check special module					(not use)
-//					pendingsec:		<number>,			-> Limit for removing IP which is not alive	(not use)
-//					intervalms:		<number>,			-> Interval ms for checking IP address		(not use)
-//					parallelcnt:	<number>,			-> Parallel processing count
-//					command4:		<string>,			-> ping command for IPv4
-//					command6:		<string>,			-> ping command for IPv6
-//					params:			<string>,			-> Common ping command parameters
-//					timeoutparam:	<string>,			-> Timeout parameter name for ping command
-//					timeoutms:		<number>			-> Timeout millisecond for each checking
-//				}
-//
-// [NOTE]
-// This function is reentrant after finishing parallel count IP address checking.
-// If all of ip datas array are finished checking, call callback function. 
-//
-function checkAddressesAliveParallel(ipdatas, start, chkipconfig, callback)
-{
-	var	_ipdatas	= ipdatas;								// reference
-	var	_start		= start;
-	var	_chkipconfig= chkipconfig;
-	var	_callback	= callback;
-
-	if(!apiutil.isSafeEntity(_callback) || 'function' !== typeof _callback){
-		r3logger.elog('callback parameter is wrong');
-		return;
-	}
-	if(!apiutil.isSafeEntity(_start) || isNaN(_start)){
-		_callback(new Error('start value is wrong : ' + JSON.stringify(_start)));
-		return;
-	}
-	if(!apiutil.isSafeEntity(_chkipconfig)){				// already check this...
-		_callback(new Error('chkipconfig value is wrong : ' + JSON.stringify(_chkipconfig)));
-		return;
-	}
-	if(!apiutil.isArray(_ipdatas)){
-		_callback(new Error('IP Addresses array is wrong : ' + JSON.stringify(_ipdatas)));
-		return;
-	}
-	var	_totalcount = _chkipconfig.parallelcnt;
-	if((_ipdatas.length - _start) < _totalcount){
-		_totalcount = _ipdatas.length - _start;
-		if(_totalcount <= 0){
-			_callback(new Error('No rest array for checking'));
-			return;
-		}
-	}
-
-	for(var cnt = 0, setcnt = 0; cnt < _totalcount; ++cnt){
-		checkAddressAlive(_ipdatas[_start + cnt], _chkipconfig, function(error, ipdata)
-		{
-			if(error){
-				r3logger.dlog('IP Address(' + ipdata.ip + ') : CUK(' + ipdata.cuk + ') is not alive by ' + JSON.stringify(error));
-				ipdata.alive = false;
-			}else{
-				r3logger.dlog('IP Address(' + ipdata.ip + ') : CUK(' + ipdata.cuk + ') is alive');
-				ipdata.alive = true;
-			}
-			++setcnt;
-			if(_totalcount <= setcnt){
-				if(_ipdatas.length <= (_start + _totalcount)){
-					_callback(null);
-				}else{
-					checkAddressesAliveParallel(ipdatas, (_start + _totalcount), _chkipconfig, _callback);
-				}
-			}
-		});
-	}
-}
-
-//---------------------------------------------------------
-// Check & Set result checking IP Addresses
-//---------------------------------------------------------
-// ipdatas:		IP address information array
-//				[{
-//					ip:				<string>,			-> ip address string
-//					cuk:			<string>,			-> cuk string								(not use)
-//					port:			<number or *>,		-> port number or *							(not use)
-//					extra:			<string>,			-> 'openstack-auto-v1' or etc				(not use)
-//					tag:			<string>,			-> null or string							(not use)
-//					inboundip:		<string>,			-> inbound ip address						(not use)
-//					outboundip:		<string>,			-> outbound ip address						(not use)
-//					key:			<string>,			-> this ip address yrn full path			(not use)
-//					alive: 			<boolean>			-> true or false
-//				}, ...]
-// chkipconfig:	Configuration for IP addresses checking
-//				{
-//					type:			<string>,			-> IP check type							(not use)
-//					funcmod:		<null or string>,	-> IP check special module					(not use)
-//					pendingsec:		<number>,			-> Limit for removing IP which is not alive	(not use)
-//					intervalms:		<number>,			-> Interval ms for checking IP address		(not use)
-//					parallelcnt:	<number>,			-> Parallel processing count
-//					command4:		<string>,			-> ping command for IPv4
-//					command6:		<string>,			-> ping command for IPv6
-//					params:			<string>,			-> Common ping command parameters
-//					timeoutparam:	<string>,			-> Timeout parameter name for ping command
-//					timeoutms:		<number>			-> Timeout millisecond for each checking
-//				}
-//
-// [NOTE]
-// This function returns Promise object.
-// resolve:		{error: <Error object if error>, data: <reference to input ipdatas>}
-// reject:		<Error object>
-//
-function checkAddressesAlivePromise(ipdatas, chkipconfig)
-{
-	var	_chkipconfig= chkipconfig;
-	var	_ipdatas	= ipdatas;								// reference
-
-	return new Promise(function(resolve, reject)
-	{
-		var	_resolve= resolve;
-		var	_reject	= reject;
-
-		if(	!apiutil.isSafeEntity(_chkipconfig)					||
-			!apiutil.isSafeEntity(_chkipconfig.parallelcnt)		||
-			isNaN(_chkipconfig.parallelcnt)						||
-			!apiutil.isSafeString(_chkipconfig.command4)		||
-			!apiutil.isSafeString(_chkipconfig.command6)		||
-			//!apiutil.isSafeString(_chkipconfig.params)		||	// allow null
-			//!apiutil.isSafeString(_chkipconfig.timeoutparam)	||	// allow null
-			!apiutil.isSafeEntity(_chkipconfig.timeoutms)		||
-			isNaN(_chkipconfig.timeoutms)						)
-		{
-			_reject(new Error('chkipconfig object is wrong : ' + JSON.stringify(_chkipconfig)));
-			return;
-		}
-
-		if(!apiutil.isArray(_ipdatas)){
-			_reject(new Error('IP Addresses array is wrong : ' + JSON.stringify(_ipdatas)));
-			return;
-		}
-
-		checkAddressesAliveParallel(_ipdatas, 0, _chkipconfig, function(error)
-		{
-			if(error){
-				r3logger.elog('Something error is occurred : ' + JSON.stringify(error));
-				_resolve({error: error, data: _ipdatas});
-			}else{
-				r3logger.dlog('Succeed to checking all ip address');
-				_resolve({error: null, data: _ipdatas});
-			}
-		});
-	});
-}
-
-//---------------------------------------------------------
-// Exports
-//---------------------------------------------------------
-exports.checkAddressesAlive = function(ipdatas, chkipconfig)
-{
-	return checkAddressesAlivePromise(ipdatas, chkipconfig);
-};
-
-/*
- * Local variables:
- * tab-width: 4
- * c-basic-offset: 4
- * End:
- * vim600: noexpandtab sw=4 ts=4 fdm=marker
- * vim<600: noexpandtab sw=4 ts=4
- */

package/lib/cacerts.js

@@ -1,71 +0,0 @@
-/*
- * K2HR3 REST API
- *
- * Copyright 2017 Yahoo Japan Corporation.
- *
- * K2HR3 is K2hdkc based Resource and Roles and policy Rules, gathers 
- * common management information for the cloud.
- * K2HR3 can dynamically manage information as "who", "what", "operate".
- * These are stored as roles, resources, policies in K2hdkc, and the
- * client system can dynamically read and modify these information.
- *
- * For the full copyright and license information, please view
- * the license file that was distributed with this source code.
- *
- * AUTHOR:   Takeshi Nakatani
- * CREATE:   Wed Jun 8 2017
- * REVISION:
- *
- */
-
-'use strict';
-
-var	fs	= require('fs');
-
-var	apiutil	= require('./k2hr3apiutil');
-
-// Debug logging objects
-var r3logger	= require('./dbglogging');
-
-function loadCACert()
-{
-	// load CA Path environment
-	if(apiutil.isSafeString(process.env.CAPATH)){
-		try{
-			fs.statSync(process.env.CAPATH);
-			return fs.readFileSync(process.env.CAPATH);
-		}catch(err){
-			r3logger.elog('CAPATH environment' + process.env.CAPATH + ' file does not exist, then use default ca certs.', JSON.stringify(err));
-		}
-	}
-
-	// load one of CA certs
-	var	def_certs = [
-		'/etc/ssl/certs/ca-certificates.crt',
-		'/etc/pki/tls/certs/ca-bundle.crt',
-		'/etc/ssl/certs/ca-bundle.crt',
-		'/etc/ssl/certs/ca-bundle.trust.crt'
-	];
-
-	for(var cnt = 0; cnt < def_certs.length; ++cnt){
-		try{
-			fs.statSync(def_certs[cnt]);
-			return fs.readFileSync(def_certs[cnt]);
-		}catch(err){
-			r3logger.dlog(JSON.stringify(err));
-			continue;
-		}
-	}
-	return null;
-}
-
-exports.ca = loadCACert();
-
-/*
- * Local variables:
- * tab-width: 4
- * c-basic-offset: 4
- * End:
- * vim600: noexpandtab sw=4 ts=4 fdm=marker
- * vim<600: noexpandtab sw=4 ts=4
- */

package/lib/dbglogging.js

@@ -1,151 +0,0 @@
-/*
- * K2HR3 REST API
- *
- * Copyright 2017 Yahoo Japan Corporation.
- *
- * K2HR3 is K2hdkc based Resource and Roles and policy Rules, gathers 
- * common management information for the cloud.
- * K2HR3 can dynamically manage information as "who", "what", "operate".
- * These are stored as roles, resources, policies in K2hdkc, and the
- * client system can dynamically read and modify these information.
- *
- * For the full copyright and license information, please view
- * the license file that was distributed with this source code.
- *
- * AUTHOR:   Takeshi Nakatani
- * CREATE:   Wed Jun 8 2017
- * REVISION:
- *
- */
-
-'use strict';
-
-var util	= require('util');
-var	apiutil	= require('./k2hr3apiutil');
-
-//---------------------------------------------------------
-// NODE_DEBUG Environment Values
-//---------------------------------------------------------
-const dbgLevelMap = {
-	'LOGLEVEL_DEBUG':	4,
-	'LOGLEVEL_DBG':		4,
-	'LOGLEVEL_INFO':	3,
-	'LOGLEVEL_MESSAGE':	3,
-	'LOGLEVEL_MSG':		3,
-	'LOGLEVEL_WARNING':	2,
-	'LOGLEVEL_WARN':	2,
-	'LOGLEVEL_WAN':		2,
-	'LOGLEVEL_ERROR':	1,
-	'LOGLEVEL_ERR':		1,
-	'LOGLEVEL_SILENT':	0,
-	'LOGLEVEL_SLT':		0
-};
-
-const levelDbg		= 4;
-const levelInfo		= 3;
-const levelWarn		= 2;
-const levelErr		= 1;
-const levelSilent	= 0;
-
-//---------------------------------------------------------
-// Logging Level
-//---------------------------------------------------------
-var	currentLevel = levelErr;
-var	customLevels = [];
-
-(function()
-{
-	var	dbgEnvs = apiutil.getSafeString(process.env.NODE_DEBUG).split(',');
-
-	dbgEnvs.forEach(function(key)
-	{
-		var	upperKey = key.toUpperCase();
-		if(apiutil.isSafeEntity(dbgLevelMap[upperKey])){
-			if(levelSilent == dbgLevelMap[upperKey]){
-				// default level is error. if specify silent, we must set silent.
-				currentLevel = levelSilent;
-			}else if(currentLevel < dbgLevelMap[upperKey]){
-				currentLevel = dbgLevelMap[upperKey];
-			}
-		}else if(!apiutil.findStringInArray(customLevels, upperKey)){
-			customLevels.push(upperKey);
-		}
-	});
-}());
-
-function getCurrentInfo()
-{
-	try{
-		throw new Error('INTERNAL_EXCEPTION_FOR_DEBUG');
-	}catch(exception){
-		var basedir	= __dirname.replace(/lib$/g, '');
-		var curstr	= exception.stack.split(/[\r\n]+/).filter(function(val1)
-		{
-			return /^ *at .*:[0-9]+:[0-9]+/.test(val1);
-		})[2];
-		return curstr.replace(/^ *at /g, '').replace(new RegExp(basedir, 'g'), '').replace(/.*\(/g, '').replace(/\)$/g, '').replace(/:[0-9]+$/g, '').replace(/:/g, '(') + ')';
-	}
-}
-
-exports.dlog = function()
-{
-	if(levelDbg <= currentLevel){
-		// [NOTE]
-		// We want to use stack trace, thus using console.warn instead of console.debug method.
-		//
-		console.warn('[DEBUG] ' + getCurrentInfo(), util.format.apply(util, arguments));
-	}
-};
-
-exports.mlog = function()
-{
-	if(levelInfo <= currentLevel){
-		// [NOTE]
-		// We want to use stack trace, thus using console.warn instead of console.info method.
-		//
-		console.warn('[INFO] ' + getCurrentInfo(), util.format.apply(util, arguments));
-	}
-};
-
-exports.wlog = function()
-{
-	if(levelWarn <= currentLevel){
-		console.warn('[WARN] ' + getCurrentInfo(), util.format.apply(util, arguments));
-	}
-};
-
-exports.elog = function()
-{
-	if(levelErr <= currentLevel){
-		console.error('[ERROR] ' + getCurrentInfo(), util.format.apply(util, arguments));
-	}
-};
-
-exports.clog = function(section)
-{
-	if(apiutil.isSafeString(section) && apiutil.findStringInArray(customLevels, section.toUpperCase())){
-		// [NOTE]
-		// We want to use stack trace, thus using console.warn instead of console.info method.
-		//
-		console.warn('[' + section.toUpperCase() + '] ' + getCurrentInfo(), util.format.apply(util, arguments));
-	}
-};
-
-exports.dump = function(obj)
-{
-	if(levelDbg <= currentLevel){
-		if(typeof obj === 'object'){
-			return util.inspect(obj, {showHidden: true, depth: null, maxArrayLength: 1000});
-		}
-	}
-	return obj;
-};
-
-/*
- * Local variables:
- * tab-width: 4
- * c-basic-offset: 4
- * End:
- * vim600: noexpandtab sw=4 ts=4 fdm=marker
- * vim<600: noexpandtab sw=4 ts=4
- */