/**
Copyright: 2024 Contrast Security, Inc
  Contact: support@contrastsecurity.com
  License: Commercial

  NOTICE: This Software and the patented inventions embodied within may only be
  used as part of Contrast Security’s commercial offerings. Even though it is
  made available through public repositories, use of this Software is subject to
  the applicable End User Licensing Agreement found at
  https://www.contrastsecurity.com/enduser-terms-0317a or as otherwise agreed
  between Contrast Security and the End User. The Software may not be reverse
  engineered, modified, repackaged, sold, redistributed or otherwise used in a
  way not consistent with the End User License Agreement.
*/
'use strict';

const _ = require('lodash');

const { INPUT_TYPES, SINK_TYPES } = require('../common');
const Rule = require('../');

const searchers = [];

class PathTraversalRule extends Rule {
  constructor(policy) {
    super(_.merge({}, policy, { searchers }));

    // Common Rule configuration values
    this.id = 'path-traversal';
    this.name = 'Path Traversal';

    this.applicableInputs = [
      INPUT_TYPES.BODY,
      INPUT_TYPES.HEADER,
      INPUT_TYPES.JSON_VALUE,
      INPUT_TYPES.JSON_ARRAYED_VALUE,
      INPUT_TYPES.PARAMETER_NAME,
      INPUT_TYPES.PARAMETER_VALUE,
      INPUT_TYPES.QUERYSTRING,
      INPUT_TYPES.XML_VALUE,
      INPUT_TYPES.URI,
      INPUT_TYPES.URL_PARAMETER
    ];

    this.applicableSinks = [SINK_TYPES.FILE_PATH];

    this.usesLibInputAnalysis = true;
  }

  /**
   * Builds the details for the (attempted) attack.
   * @param   {Sample} sample   N/A in this rule's case.
   * @param   {String} findings The sink findings - the path.
   * @returns {Object}          The details
   */
  buildDetails(sample, findings) {
    return { path: findings };
  }
}

module.exports = PathTraversalRule;
