1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 | 2× 2× 2× 2× 10× 2× 6× 6× 10× 10× 10× 4× 4× 6× 2× 2× 2× 2× 21× 21× 21× 21× 21× 21× 9× 9× 21× 2× 6× 6× 6× 6× 2× 2× 2× 2× 2× 6× 6× 6× 6× 9× 9× 9× 9× 4× 4× 6× 2× 3× 3× 3× 2× 8× 8× 8× 2× 3× 2× 2× 47× 47× 47× 47× 2× 51× 51× 47× 21× 21× 51× 2× 3356× 3356× 3356× 3356× 1× 3355× 3355× 16× 3339× 3305× 34× 34× 2× 5445× 2068× 3377× 3377× 21× 21× 3356× 2× 3377× 2× 2068× 2068× 2032× 2032× 36× 36× 36× 6× 6× 6× 6× 30× 30× 30× 30× 30× 51× 51× 30× 30× 30× 30× 30× 30× 2× 464× 464× 464× 490× 32× 32× 20× 14× | 'use strict'; const _ = require('lodash'); const logger = require(__dirname + '/../loggers/logger'); //export namespace as `unsupportedAgentPolicyEvaluation` const unsupportedAgentPolicyEvaluation = exports; const relationFunctions = { 'equal' : (searchString, v) => (searchString === v), 'not_equal': (searchString, v) => (searchString !== v), 'contains': (searchString, v) => (searchString.indexOf(v) >= 0), 'starts_with': (searchString, v) => (searchString.startsWith(v)), 'ends_with': (searchString, v) => (searchString.endsWith(v)), 'regex': (searchString, v) => ((new RegExp(v)).test(searchString)) }; let evalRelationFunction = function(searchString, rule) { let result = false; _.forEach(rule, function(relationRule) { let relationFn = relationFunctions[relationRule.relation]; Iif (!relationFn) { logger.warn('msg=unsupportedAgentPolicy: Invalid unsupportedAgentPolicy rule" ' + JSON.stringify(relationRule)); return true; //continue iteration } if (relationFn(searchString, relationRule.value)) { result = true; return false; } }); return result; }; let ip2num = function (ip) { let d = ip.split('.'); return ((((((+d[0])*256)+(+d[1]))*256)+(+d[2]))*256)+(+d[3]); }; let getClientIp = function (analyticsData) { if (!analyticsData || !analyticsData['x-client-ip']) { logger.info('msg="unsupportedAgentPolicy_rule:No client ip"'); return null; } return analyticsData['x-client-ip']; }; let ipInRange = function (rangeStart, rangeEnd, ipToTest) { let ip = ip2num(ipToTest); return ((rangeStart <= ip) && (ip <= rangeEnd)); }; let unsupportedAgentBrowserRuleEvaluator = function( rule, url, analyticsData, uceData) { // jshint ignore:line let browser = analyticsData.browser; let version = analyticsData.browser_major_version; Iif (!browser || !version) { return false; } let result = false; _.forEach(rule, function(browserRule) { if (browser === browserRule.value && parseFloat(version) === parseFloat(browserRule.version)) { result = true; return false; //break iteration } }); return result; }; let unsupportedAgentCategoryRuleEvaluator = function ( rule, url, analyticsData, uceData) { // jshint ignore:line let categories = uceData.cats; Iif (!categories) { return false; } let catNames = _.pluck(categories, 'name'); return (!_.isEmpty(_.intersection(catNames, rule.values))); }; let unsupportedAgentSourceIpsRuleEvaluator = function ( rule, url, analyticsData, uceData) { // jshint ignore:line let clientIp = getClientIp(analyticsData); if (!clientIp) { return false; } return _.contains(rule.values, clientIp); }; let unsupportedAgentSourceIpRangeRuleEvaluator = function ( rule, url, analyticsData, uceData) { // jshint ignore:line let clientIp = getClientIp(analyticsData); if (!clientIp) { return false; } let isMatch = false; _.forEach(rule.values, function(range) { if (ipInRange(range.rangeStart, range.rangeEnd, clientIp)) { isMatch = true; return false; //stop iteration } }); return isMatch; }; let unsupportedAgentDestinationIpsRuleEvaluator = function ( rule, url, analyticsData, uceData) { let ips = uceData.ips; if (!ips) { return false; } return (!_.isEmpty(_.intersection(ips, rule.values))); }; let unsupportedAgentDestinationIpRangeRuleEvaluator = function ( rule, url, analyticsData, uceData) { let ips = uceData.ips; if (!ips) { return false; } let isMatch = false; _.forEach(rule.values, function(range) { _.forEach(ips, function (ip) { if (ipInRange(range.rangeStart, range.rangeEnd, ip)) { isMatch = true; return false; //Stop iteration } }); if (isMatch) { return false; //Stop iteration } }); return isMatch; }; let unsupportedAgentDomainRuleEvaluator = function ( rule, url, analyticsData, uceJsonResponse) { // jshint ignore:line let domain = analyticsData.domain; Iif (!domain) { return false; } let result = false; _.forEach(rule, function(domainRule) { let ruleParts = domainRule.value.split('.').reverse(); let domainParts = domain.split('.').reverse(); domainParts = _.first(domainParts, ruleParts.length); if (_.isEqual(ruleParts, domainParts)) { result = true; return false; //stop iteration } }); return result; }; let unsupportedAgentUARuleEvaluator = function ( rule, url, analyticsData, uceJsonResponse) { // jshint ignore:line let userAgent = analyticsData['user-agent']; Iif (!userAgent) { return false; } return evalRelationFunction(userAgent, rule); }; let unsupportedAgentThreatRuleEvaluator = function ( rule, url, analyticsData, uceJsonResponse) { // jshint ignore:line let threats = analyticsData.top_level_risks; Iif (!threats) { return false; } return (!_.isEmpty(_.intersection(threats, rule.values))); }; let unsupportedAgentURIRuleEvaluator = function ( rule, url, analyticsData, uceJsonResponse) { // jshint ignore:line return evalRelationFunction(url, rule); }; let unsupportedAgentRuleEvaluators = { 'categories' : unsupportedAgentCategoryRuleEvaluator, 'source_ips' : unsupportedAgentSourceIpsRuleEvaluator, 'source_ip_ranges' : unsupportedAgentSourceIpRangeRuleEvaluator, 'dest_ips' : unsupportedAgentDestinationIpsRuleEvaluator, 'dest_ip_ranges' : unsupportedAgentDestinationIpRangeRuleEvaluator, 'domain' : unsupportedAgentDomainRuleEvaluator, 'browser': unsupportedAgentBrowserRuleEvaluator, 'user_agent': unsupportedAgentUARuleEvaluator, 'threats': unsupportedAgentThreatRuleEvaluator, 'uri': unsupportedAgentURIRuleEvaluator }; let ruleMatch = function(rule, url, analyticsData, uceData, tid) { Iif (!rule || !rule.type || !rule.rule) { logger.warn('msg=unsupportedAgentPolicy: Invalid unsupportedAgentPolicy rule" ' + ' tid=' + tid + 'rule=' + JSON.stringify(rule)); return false; } let fn = unsupportedAgentRuleEvaluators[rule.type]; Iif (!fn) { logger.warn('msg=unsupportedAgentPolicy: Invalid unsupportedAgentPolicy type" ' + ' tid=' + tid + ' type=' + rule.type); return false; } return fn(rule.rule, url, analyticsData, uceData); }; let evalUnsupportedAgentRule = function(url, analyticsData, uceData, userInfo, rules) { let match = true; // For an exception, there is a set of rules that must be // met for the exception to take place (these rules are made up // of dest ip, dest domain, user-agent, etc). If any one of the // rules do not match, then the rule does not take effect. If there // are no rules (any, any), then the rule should take effect (which // logically follows from the above since no rules failed to match). _.forEach(rules, function(rule) { if (!ruleMatch(rule, url, analyticsData, uceData, userInfo.tenantId)) { match = false; return false; //if any rules do not match, stop iteration } }); return match; }; let getUAType = function(browser, policy, analyticsData) { Iif (!policy || _.isEmpty(policy)) { return 'supported_browser'; } let supportedBrowsers = policy.supported_browsers; Iif (_.isEmpty(supportedBrowsers)) { return 'supported_browser'; } if (!supportedBrowsers[browser]) { return 'unsupported_browser'; } let blockOlderBrowsers = supportedBrowsers[browser].block_older; if (!supportedBrowsers[browser].enabled) { return blockOlderBrowsers ? 'blocked_browser' : 'unsupported_browser'; } if (analyticsData.browser_major_version && (parseFloat(analyticsData.browser_major_version) >= parseFloat(supportedBrowsers[browser].min_version))) { return 'supported_browser'; } Iif (blockOlderBrowsers) { return 'blocked_browser'; } return 'unsupported_browser'; }; let populateBrowserInfo = function (policy, analyticsData) { if (!_.isUndefined(analyticsData.ua_type)) { // Event in which browser info has already been populated return; } let currBrowser = analyticsData.browser; if (!currBrowser) { analyticsData.ua_type = 'non_browser'; return; } analyticsData.ua_type = getUAType(currBrowser, policy, analyticsData); }; unsupportedAgentPolicyEvaluation.getBrowserInfo = function ( tenantPolicy, analyticsData, tid) { populateBrowserInfo(tenantPolicy, analyticsData, tid); }; /** * @function getPolicyAction * @desc Return policy based decision on whether an unsupported * user agent should be blocked or not. * @param {string} url * @param {object} analyticsData * @param {object} uceData * @param {object} userInfo * @param {object} tenantPolicy * @param {object} result */ unsupportedAgentPolicyEvaluation.getPolicyAction = function ( url, analyticsData, uceData, userInfo, tenantPolicy, result) { populateBrowserInfo(tenantPolicy, analyticsData, userInfo.tenantId); if (analyticsData.ua_type === 'supported_browser') { result.supportedBrowser = true; return result; } result.ua_type = analyticsData.ua_type; //needed for icap block page result.supportedBrowser = false; if (analyticsData.ua_type === 'blocked_browser') { result.action = 'block'; let uuid = tenantPolicy.supported_browsers[analyticsData.browser].uuid; result.reason = uuid || 'blocked_browser'; return result; } let ruleSets = tenantPolicy.unsupported_or_non_browsers; Iif (!ruleSets || _.isEmpty(ruleSets)) { logger.info('msg="unsupportedAgentPolicy:no policy found" tid=' + userInfo.tenantId); result.action = 'allow'; //legacy behavior if there is no policy return result; } let tid = userInfo.tenantId; Iif (!uceData) { uceData = {}; logger.warn('msg=unsupportedAgentPolicy_error:UCE data unavailable'); } _.forEach(ruleSets, function (ruleSet) { Iif (!ruleSet || !ruleSet.rules || !ruleSet.action || !ruleSet.uuid) { logger.warn('msg=unsupportedAgentPolicy_error:Invalid unsupportedAgentPolicy' + 'rule" ' + 'tid=' + tid); return true; //continue iteration } if (evalUnsupportedAgentRule(url, analyticsData, uceData, userInfo, ruleSet.rules)) { result.action = ruleSet.action; result.log = ruleSet.log; result.reason = ruleSet.uuid; return false; //Stop iteration } }); logger.info('pe_type=unsupportedAgentPolicy match=' + Boolean(result.reason) + ' tid=' + tid + ' client_ip=' + userInfo.clientIp + ' url=' + url + ' action=' + result.action + ' reason="' + result.reason + '"'); return result; }; /** * @function compilePolicy * @desc Optimizes policy for faster evaluation. * @param {object} policy */ unsupportedAgentPolicyEvaluation.compilePolicy = function (policy, policyDefaults) { Iif (!policy) { return; } Iif ((!_.has(policy, 'unsupported_or_non_browsers') || _.isEmpty(policy.unsupported_or_non_browsers)) && _.has(policyDefaults, 'unsupported_or_non_browsers')) { policy.unsupported_or_non_browsers = policyDefaults.unsupported_or_non_browsers; } _.forEach(policy.unsupported_or_non_browsers, function (ruleSet) { _.forEach(ruleSet.rules, function(rule) { Iif (_.contains(['source_ip_ranges', 'dest_ip_ranges'], rule.type)) { _.forEach(rule.rule.values, function(range) { range.rangeStart = ip2num(range.start); range.rangeEnd = ip2num(range.end); }); } if (_.contains(['domain', 'browser', 'user_agent', 'uri'], rule.type)) { if (!_.isArray(rule.rule)) { rule.rule = [rule.rule]; } } }); }); }; |