StackInfo.js

//IASTIGNORE

/*
 * ****************************************************
 * Licensed Materials - Property of HCL.
 * (c) Copyright HCL Technologies Ltd. 2017, 2024.
 * Note to U.S. Government Users *Restricted Rights.
 * ****************************************************
 */

'use strict'

const Utils = require('./Utils/Utils');
const {ConfigInfo} = require("./ConfigFile/ConfigInfo");
const TaintTracker = require("./TaintTracker");
const StackTraceUtils = require("./Utils/StackTraceUtils");
const maxParamLength = 300;

class StackInfo {
  constructor(type, parameters, vulnerability, rawStack) {
    this.type = type
    if (vulnerability != null) {
      this.from_vulnerability = vulnerability
    }
    this.parameters = parameters
    this['method-signature'] = parameters.methodSignature
    this.location = 0
    this.rawStack = rawStack.stack
    this.stack = null
  }

  updateHash(vulnerability) {
    const hash = Utils.createHashObject()
    hash.update(this.type)

    if (this['method-signature'] != null) {
      hash.update(this['method-signature'])
    }
    if (this.stack != null) {
      for (const item of this.stack) {
        hash.update(item)
      }
    }
    if (vulnerability != null) {
      hash.update(vulnerability)
    }
    return hash.produce()
  }

  static getSimpleParamsStringArray (that, methodDescriptor, args, ret) {
    return {
      that: this.asString(that),
      ret: this.asString(ret),
      methodSignature: this.asString(methodDescriptor),
      methodArguments: (args == null) ? [] : Array.from(args, item => this.asString(item))
    }
  }

  static getParamsStringArray (that, methodDescriptor, args, ret) {
    const res = this.getSimpleParamsStringArray(that, methodDescriptor, args, ret)
    res.objects = {
        that: that,
        ret : ret,
        args : args
      }
    return res
  }

  static getParamsStringArrayPostHook (that, methodDescriptor, args, ret) {
    let res = StackInfo.getParamsStringArray(that, methodDescriptor, args, ret)
    StackInfo.replacePasswordParams(res)
    return res
  }

  static replacePasswordParams(params){
    const objects = params.objects
    if (ConfigInfo.ConfigInfo.hidePasswords) {
      if (objects.that != null) {
        StackInfo.replacePasswordValue(params, "that", objects.that);
      }
      if (objects.ret != null) {
        StackInfo.replacePasswordValue(params, "ret", objects.ret);
      }
      if (objects.args != null) {
        for (let i = 0; i < objects.args.length; i++) {
          if (objects.args[i] != null){
            StackInfo.replacePasswordValue(params, "methodArguments", objects.args[i], i);
          }
        }
      }
    }
  }

  static replacePasswordValue(params, key, obj, index = undefined) {
    let taintData = TaintTracker.getTaintedData(obj)
    if (taintData != null) {
      for (const flow of taintData.flows) {
        if (flow.entity.isPassword) {
          if (index == null) {
            params[key] = Utils.PASSWORD_TEXT
          }
          else {
            params[key][index] = Utils.PASSWORD_TEXT
          }
          return
        }
      }
    }
  }

  static asString(obj) {
    let result = ''
    if (typeof obj === 'string' || obj instanceof String) {
      result = obj
    }
    else {
      try {
        result = JSON.origStringify(obj)
      } catch (err) {
        console.log(err)
        console.log(obj)
      }
    }
    if (result == null || result.length <= maxParamLength)
      return result
    return result.origSubstring(0, maxParamLength) + '...'
  }

  updateStack() {
    if (this.stack == null) {
      this.stack = StackTraceUtils.getStackTraceArray(this.rawStack);
    }
    if (this.parameters !== undefined){
      this.object = this.parameters.that
      this.arguments = this.parameters.methodArguments
      this.return = this.parameters.ret
      delete this.parameters
    }
  }

  getStackTraceString() {
    if (this.stack == null) {
      this.updateStack()
    }
    return this.stack.toString()
  }

  setStackArray(stackArray) {
    this.stack = stackArray;
  }

}
module.exports = StackInfo