|
| 1 | +/* |
| 2 | + * Copyright 2023 New Relic Corporation. All rights reserved. |
| 3 | + * SPDX-License-Identifier: New Relic Software License v1.0 |
| 4 | + */ |
| 5 | + |
| 6 | +module.exports = initialize |
| 7 | +const requestManager = require('../../core/request-manager'); |
| 8 | +const secUtils = require("../../core/sec-utils"); |
| 9 | +const API = require("../../../nr-security-api"); |
| 10 | +const securityMetaData = require('../../core/security-metadata'); |
| 11 | +const { EVENT_TYPE, EVENT_CATEGORY } = require('../../core/event-constants'); |
| 12 | +const { NR_CSEC_FUZZ_REQUEST_ID } = require('../../core/constants'); |
| 13 | +const logger = API.getLogger(); |
| 14 | +const NRLIB = 'newrelic/lib'; |
| 15 | +const SALIB = 'security-agent/lib' |
| 16 | + |
| 17 | +/** |
| 18 | + * Entry point of crypto module hook |
| 19 | + * @param {*} shim |
| 20 | + * @param {*} mod |
| 21 | + * @param {*} moduleName |
| 22 | + */ |
| 23 | +function initialize(shim, mod, moduleName) { |
| 24 | + if (API && API.getNRAgent() && API.getNRAgent().config.security.exclude_from_iast_scan.iast_detection_category.insecure_settings) { |
| 25 | + logger.warn('insecure_settings detection is disabled'); |
| 26 | + return; |
| 27 | + } |
| 28 | + logger.info('Instrumenting ' + moduleName) |
| 29 | + cryptoCipherHooks(shim, mod, 'createCipheriv', moduleName); |
| 30 | + cryptoHashHmacHooks(shim, mod, 'createHash', moduleName); |
| 31 | + cryptoHashHmacHooks(shim, mod, 'createHmac', moduleName); |
| 32 | + cryptoRandomHooks(shim, Math, 'random', "Math"); |
| 33 | +} |
| 34 | +/** |
| 35 | + * wrapper to hook crypto cipher methods |
| 36 | + * @param {*} shim |
| 37 | + * @param {*} mod |
| 38 | + * @param {*} methodName |
| 39 | + * @param {*} moduleName |
| 40 | + */ |
| 41 | +function cryptoCipherHooks(shim, mod, methodName, moduleName) { |
| 42 | + shim.wrap(mod, methodName, function makeWrapper(shim, fn) { |
| 43 | + logger.debug(`Instrumenting ${moduleName}.${methodName}`); |
| 44 | + return function wrapper() { |
| 45 | + const interceptedArgs = [arguments[0]]; |
| 46 | + shim.interceptedArgs = interceptedArgs; |
| 47 | + const request = requestManager.getRequest(shim); |
| 48 | + if (request && API.getSecAgent() && API.getSecAgent().status && API.getSecAgent().status.getStatus() === 'active') { |
| 49 | + const traceObject = secUtils.getTraceObject(shim); |
| 50 | + const secMetadata = securityMetaData.getSecurityMetaData(request, interceptedArgs, traceObject, secUtils.getExecutionId(), EVENT_TYPE.CRYPTO, EVENT_CATEGORY.CIPHER) |
| 51 | + if (secMetadata.traceObject && secMetadata.traceObject.stacktrace && (secMetadata.traceObject.stacktrace[0].includes(NRLIB) || secMetadata.traceObject.stacktrace[0].includes(SALIB))) { |
| 52 | + //do nothing |
| 53 | + } |
| 54 | + else { |
| 55 | + const secEvent = API.generateSecEvent(secMetadata); |
| 56 | + this.secEvent = secEvent; |
| 57 | + API.sendEvent(secEvent); |
| 58 | + } |
| 59 | + } |
| 60 | + const result = fn.apply(this, arguments); |
| 61 | + |
| 62 | + if (result && request && request.headers[NR_CSEC_FUZZ_REQUEST_ID]) { |
| 63 | + API.generateExitEvent(this.secEvent); |
| 64 | + delete this.secEvent |
| 65 | + } |
| 66 | + return result; |
| 67 | + } |
| 68 | + }) |
| 69 | +} |
| 70 | + |
| 71 | + |
| 72 | +/** |
| 73 | + * wrapper to hook crypto hash and mac methods |
| 74 | + * @param {*} shim |
| 75 | + * @param {*} mod |
| 76 | + * @param {*} methodName |
| 77 | + * @param {*} moduleName |
| 78 | + */ |
| 79 | +function cryptoHashHmacHooks(shim, mod, methodName, moduleName) { |
| 80 | + shim.wrap(mod, methodName, function makeWrapper(shim, fn) { |
| 81 | + logger.debug(`Instrumenting ${moduleName}.${methodName}`); |
| 82 | + return function wrapper() { |
| 83 | + const interceptedArgs = [arguments[0]]; |
| 84 | + shim.interceptedArgs = interceptedArgs; |
| 85 | + const request = requestManager.getRequest(shim); |
| 86 | + |
| 87 | + if (request && arguments[0] !== 'sha256' && API.getSecAgent() && API.getSecAgent().status && API.getSecAgent().status.getStatus() === 'active') { |
| 88 | + const traceObject = secUtils.getTraceObject(shim); |
| 89 | + const secMetadata = securityMetaData.getSecurityMetaData(request, interceptedArgs, traceObject, secUtils.getExecutionId(), EVENT_TYPE.HASH, EVENT_CATEGORY.HASH) |
| 90 | + if (secMetadata.traceObject && secMetadata.traceObject.stacktrace && (secMetadata.traceObject.stacktrace[0].includes(NRLIB) || secMetadata.traceObject.stacktrace[0].includes(SALIB))) { |
| 91 | + //do nothing |
| 92 | + } |
| 93 | + else { |
| 94 | + const secEvent = API.generateSecEvent(secMetadata); |
| 95 | + this.secEvent = secEvent; |
| 96 | + API.sendEvent(secEvent); |
| 97 | + } |
| 98 | + } |
| 99 | + const result = fn.apply(this, arguments); |
| 100 | + if (result && request && request.headers[NR_CSEC_FUZZ_REQUEST_ID] && arguments[0] !== 'sha256') { |
| 101 | + API.generateExitEvent(this.secEvent); |
| 102 | + delete this.secEvent |
| 103 | + } |
| 104 | + return result; |
| 105 | + } |
| 106 | + }) |
| 107 | +} |
| 108 | +/** |
| 109 | + * Wrapper for random hooks |
| 110 | + * @param {*} shim |
| 111 | + * @param {*} mod |
| 112 | + * @param {*} methodName |
| 113 | + * @param {*} moduleName |
| 114 | + */ |
| 115 | +function cryptoRandomHooks(shim, mod, methodName, moduleName) { |
| 116 | + shim.wrap(mod, methodName, function makeWrapper(shim, fn) { |
| 117 | + logger.debug(`Instrumenting ${moduleName}.${methodName}`); |
| 118 | + return function wrapper() { |
| 119 | + const interceptedArgs = ["Math.random"]; |
| 120 | + shim.interceptedArgs = interceptedArgs; |
| 121 | + const request = requestManager.getRequest(shim); |
| 122 | + if (request && API.getSecAgent() && API.getSecAgent().status && API.getSecAgent().status.getStatus() === 'active') { |
| 123 | + const traceObject = secUtils.getTraceObject(shim); |
| 124 | + const secMetadata = securityMetaData.getSecurityMetaData(request, interceptedArgs, traceObject, secUtils.getExecutionId(), EVENT_TYPE.RANDOM, EVENT_CATEGORY.WEAKRANDOM) |
| 125 | + if (secMetadata.traceObject && secMetadata.traceObject.stacktrace && secMetadata.traceObject.stacktrace[0] && (secMetadata.traceObject.stacktrace[0].includes(NRLIB) || secMetadata.traceObject.stacktrace[0].includes(SALIB))) { |
| 126 | + //do nothing |
| 127 | + } |
| 128 | + else { |
| 129 | + const secEvent = API.generateSecEvent(secMetadata); |
| 130 | + this.secEvent = secEvent; |
| 131 | + API.sendEvent(secEvent); |
| 132 | + } |
| 133 | + |
| 134 | + } |
| 135 | + const result = fn.apply(this, arguments); |
| 136 | + if (result && request && request.headers[NR_CSEC_FUZZ_REQUEST_ID]) { |
| 137 | + API.generateExitEvent(this.secEvent); |
| 138 | + delete this.secEvent |
| 139 | + } |
| 140 | + return result; |
| 141 | + } |
| 142 | + }) |
| 143 | +} |
| 144 | + |
| 145 | + |
0 commit comments