# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
# frozen_string_literal: true

# This class is responsible for the continuation of traces. A Propagator is any
# method that transforms an untrusted value. In general, these methods work on
# the String class or a holder of Strings
cs__scoped_require 'set'

cs__scoped_require 'contrast/utils/object_share'
cs__scoped_require 'contrast/utils/sha256_builder'

cs__scoped_require 'contrast/agent/assess/policy/propagator'

cs__scoped_require 'contrast/components/interface'

module Contrast
  module Agent
    module Assess
      module Policy
        # This module contains the logic for determining how to propagate tags
        # and events from a source to a target
        module PropagationMethod
          include Contrast::Components::Interface
          access_component :logging

          APPEND_ACTION = 'APPEND'
          CENTER_ACTION = 'CENTER'
          INSERT_ACTION = 'INSERT'
          KEEP_ACTION = 'KEEP'
          NEXT_ACTION = 'NEXT'
          NOOP_ACTION = 'NOOP'
          PREPEND_ACTION = 'PREPEND'
          REPLACE_ACTION = 'REPLACE'
          REMOVE_ACTION = 'REMOVE'
          REVERSE_ACTION = 'REVERSE'
          SPLAT_ACTION = 'SPLAT'
          SPLIT_ACTION = 'SPLIT'
          DB_WRITE_ACTION = 'DB_WRITE'
          CUSTOM_ACTION = 'CUSTOM'

          class << self
            def determine_target propagation_node, ret, object, args
              target_key = propagation_node.targets[0]
              return ret if target_key == Contrast::Utils::ObjectShare::RETURN_KEY
              return object if target_key == Contrast::Utils::ObjectShare::OBJECT_KEY

              return args[target_key] if target_key.is_a?(Integer)

              arg = nil
              args.each do |search|
                next unless search.is_a?(Hash)

                arg = search[target_key]
                break if arg
              end
              arg
            end

            # @param method_policy [Contrast::Agent::Patching::Policy::MethodPolicy]
            #   the policy that governs the patches to this method
            # @param preshift [Contrast::Agent::Assess::PreShift] The capture
            #   of the state of the code just prior to the invocation of the
            #   patched method.
            # @param object [Object] the Object on which the method was invoked
            # @param ret [Object] the Return of the invoked method
            # @param args [Array<Object>] the Arguments with which the method
            #   was invoked
            # @param block [Block] the Block passed to the original method
            # @return [Object, nil] the tracked Return or nil if no changes
            #   were made; will replace the return of the original function if
            #   not nil
            def apply_propagation method_policy, preshift, object, ret, args, block
              return unless method_policy.propagation_node
              return unless preshift

              propagation_node = method_policy.propagation_node

              target = determine_target(propagation_node, ret, object, args)
              PropagationMethod.apply_propagator(propagation_node, preshift, target, object, ret, args, block)
            end

            PROPAGATION_ACTIONS = {
                APPEND_ACTION => Contrast::Agent::Assess::Policy::Propagator::Append,
                CENTER_ACTION => Contrast::Agent::Assess::Policy::Propagator::Center,
                INSERT_ACTION => Contrast::Agent::Assess::Policy::Propagator::Insert,
                KEEP_ACTION => Contrast::Agent::Assess::Policy::Propagator::Keep,
                NEXT_ACTION => Contrast::Agent::Assess::Policy::Propagator::Next,
                NOOP_ACTION => nil,
                PREPEND_ACTION => Contrast::Agent::Assess::Policy::Propagator::Prepend,
                REPLACE_ACTION => Contrast::Agent::Assess::Policy::Propagator::Replace,
                REMOVE_ACTION => Contrast::Agent::Assess::Policy::Propagator::Remove,
                REVERSE_ACTION => Contrast::Agent::Assess::Policy::Propagator::Reverse,
                SPLAT_ACTION => Contrast::Agent::Assess::Policy::Propagator::Splat,
                SPLIT_ACTION => Contrast::Agent::Assess::Policy::Propagator::Split
            }.cs__freeze

            def context_available?
              !!Contrast::Agent::REQUEST_TRACKER.current
            end

            # I lied above. We had to figure out what the target of the
            # propagation was. Now that we know, we'll actually do things to
            # it. Note that the return of this method will replace the original
            # return of the patched function unless it is nil, so be sure
            # you're returning what you intend.
            #
            # @param propagation_node [Contrast::Agent::Assess::Policy::PropagationNode]
            #   the node that governs this propagation event.
            # @param preshift [Contrast::Agent::Assess::PreShift] The capture
            #   of the state of the code just prior to the invocation of the
            #   patched method.
            # @param target [Object] the Target to which to propagate.
            # @param object [Object] the Object on which the method was invoked
            # @param ret [Object] the Return of the invoked method
            # @param args [Array<Object>] the Arguments with which the method
            #   was invoked
            # @param block [Block] the Block passed to the original method
            # @return [Object, nil] the tracked Return or nil if no changes
            #   were made; will replace the return of the original function if
            #   not nil
            def apply_propagator propagation_node, preshift, target, object, ret, args, block
              return unless propagation_possible?(propagation_node, target)

              if propagation_node.action == DB_WRITE_ACTION
                Contrast::Agent::Assess::Policy::Propagator::DatabaseWrite.propagate(propagation_node, preshift, ret)
              elsif propagation_node.action == CUSTOM_ACTION
                Contrast::Agent::Assess::Policy::Propagator::Custom.propagate(propagation_node, preshift, ret, block)
              elsif propagation_node.action == SPLIT_ACTION
                Contrast::Agent::Assess::Policy::Propagator::Split.propagate(propagation_node, preshift, target)
              elsif Contrast::Utils::DuckUtils.quacks_to?(target, :cs__properties)
                handle_cs_properties_propagation(propagation_node, preshift, target, object, ret, args, block)
              elsif Contrast::Utils::DuckUtils.iterable_hash?(target)
                handle_hash_propagation(propagation_node, preshift, target, object, ret, args, block)
              elsif Contrast::Utils::DuckUtils.iterable_enumerable?(target)
                handle_enumerable_propagation(propagation_node, preshift, target, object, ret, args, block)
              end
            rescue StandardError => e
              logger.warn('Unable to apply propagation', e, node_id: propagation_node.id)
            end

            # Custom actions tend to be the more complex of our propagations.
            # Often, the method has to make decisions about the target based on
            # the context with which the method was called. As such, defer
            # determining if the target is valid to that method.
            #
            # In all other cases, a target is valid for propagation if it is not
            # nil
            def valid_target? target, propagation_node
              return true if propagation_node.action == CUSTOM_ACTION

              !!target
            end

            ZERO_LENGTH_ACTIONS = [
              DB_WRITE_ACTION,
              CUSTOM_ACTION,
              KEEP_ACTION,
              REPLACE_ACTION,
              SPLAT_ACTION
            ].cs__freeze
            # If the action required needs a length and the target does not have
            # one, the length is not valid
            def valid_length? target, action
              return true if ZERO_LENGTH_ACTIONS.include?(action)

              if Contrast::Utils::DuckUtils.quacks_to?(target, :length)
                target.length != 0 # rubocop:disable Style/ZeroLengthPredicate
              else
                !target.to_s.empty?
              end
            end

            # Before we do any work, we should check if we even need to.
            # If the source of this patcher is not tracked, there's no need to do
            # anything. A copy of nothing is still nothing.
            def can_propagate? propagation_node, preshift, target
              # We cannot propagate to things that do not have cs__properties.
              return false unless Contrast::Utils::DuckUtils.quacks_to?(target, :cs__properties)

              # We cannot propagate to frozen things that have not been
              # previously tracked. We probably shouldn't propagate to frozen
              # things at all, as they're supposed to be immutable, but third
              # parties do jenky things, so allow it as long as it is safe to do.
              return false if target.cs__properties == Contrast::Agent::Assess::Insulator.generate_frozen.properties &&
                  propagation_node.targets[0] != Contrast::Utils::ObjectShare::RETURN_KEY
              return true if Contrast::Utils::Assess::TrackingUtil.tracked?(target)
              return false unless preshift

              propagation_node.sources.each do |source|
                case source
                when Contrast::Utils::ObjectShare::OBJECT_KEY
                  return true if Contrast::Utils::Assess::TrackingUtil.tracked?(preshift.object)
                else # has to be P, there's no ret source type (yet? ever?)
                  return true if preshift.args && Contrast::Utils::Assess::TrackingUtil.tracked?(preshift.args[source])
                end
              end
              false
            end

            # If this patcher has tags, apply them to the entire target
            def apply_tags propagation_node, target
              return unless propagation_node.tags

              length = Contrast::Utils::StringUtils.ret_length(target)
              propagation_node.tags.each do |tag|
                target.cs__properties.add_tag(tag, 0...length)
              end
            end

            # If this patcher has tags, remove them from the entire target
            def apply_untags propagation_node, target
              return unless propagation_node.untags

              propagation_node.untags.each do |tag|
                target.cs__properties.delete_tags(tag)
              end
            end

            private

            # This is checked right before actual propagation
            def propagation_possible? propagation_node, target
              return false unless context_available? && propagation_node && valid_target?(target, propagation_node)
              return false unless valid_length?(target, propagation_node.action)

              true
            end

            def handle_hash_propagation propagation_node, preshift, target, object, ret, args, block
              target.each_pair do |key, value|
                apply_propagator(propagation_node, preshift, key, object, ret, args, block)
                apply_propagator(propagation_node, preshift, value, object, ret, args, block)
              end
            end

            def handle_enumerable_propagation propagation_node, preshift, target, object, ret, args, block
              target.each do |value|
                next if target == value # Some Enumerable#each are overriden to return self the first time which leads to infinite propagation

                apply_propagator(propagation_node, preshift, value, object, ret, args, block)
              end
            end

            def handle_cs_properties_propagation propagation_node, preshift, target, object, ret, args, _block
              return if propagation_node.action == NOOP_ACTION
              return unless can_propagate?(propagation_node, preshift, target)

              # propagate all the tags from the sources to the target
              propagation_class = PROPAGATION_ACTIONS.fetch(propagation_node.action, nil)
              unless propagation_class
                logger.warn(
                    'Unknown propgation action receieved. Unable to propagate.',
                    node_id: propagation_node.id,
                    action: propagation_node.action)
                return ret
              end

              restore_frozen_state = false
              if target.cs__frozen?
                return ret unless propagation_node.targets[0] == Contrast::Utils::ObjectShare::RETURN_KEY

                restore_frozen_state = true
                ret = Contrast::Utils::FreezeUtil.unfreeze_dup(target)
                target = ret
              end
              return if target.cs__properties == Contrast::Agent::Assess::Insulator.generate_frozen.properties

              propagation_class.propagate(propagation_node, preshift, target)

              # Once we've propagated, attempt to tag the target if there is a tag(s) to be applied
              apply_tags(propagation_node, target)

              # Even though we skipped propagating tags from the source if they
              # were included in untags, the target may have already had some on
              # it. Let's go ahead and remove them.
              # In this order, untags takes precedent over tags; but we control
              # both and there should never be a propagator that has a tag in
              # its untag.
              apply_untags(propagation_node, target)

              target.cs__properties.add_properties(propagation_node.properties)

              target.cs__properties.build_event(propagation_node, target, object, ret, args)

              logger.trace('Propagation detected',
                           node_id: propagation_node.id,
                           target_id: target.__id__)
              ret.cs__freeze if restore_frozen_state
              ret
            end
          end
        end
      end
    end
  end
end