ddtrace 1.4.2 → 1.23.3

data/lib/datadog/appsec/remote.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require_relative '../core/remote/dispatcher'
+require_relative 'processor/rule_merger'
+require_relative 'processor/rule_loader'
+
+module Datadog
+  module AppSec
+    # Remote
+    module Remote
+      class ReadError < StandardError; end
+      class NoRulesError < StandardError; end
+
+      class << self
+        CAP_ASM_RESERVED_1                = 1 << 0   # RESERVED
+        CAP_ASM_ACTIVATION                = 1 << 1   # Remote activation via ASM_FEATURES product
+        CAP_ASM_IP_BLOCKING               = 1 << 2   # accept IP blocking data from ASM_DATA product
+        CAP_ASM_DD_RULES                  = 1 << 3   # read ASM rules from ASM_DD product
+        CAP_ASM_EXCLUSIONS                = 1 << 4   # exclusion filters (passlist) via ASM product
+        CAP_ASM_REQUEST_BLOCKING          = 1 << 5   # can block on request info
+        CAP_ASM_RESPONSE_BLOCKING         = 1 << 6   # can block on response info
+        CAP_ASM_USER_BLOCKING             = 1 << 7   # accept user blocking data from ASM_DATA product
+        CAP_ASM_CUSTOM_RULES              = 1 << 8   # accept custom rules
+        CAP_ASM_CUSTOM_BLOCKING_RESPONSE  = 1 << 9   # supports custom http code or redirect sa blocking response
+        CAP_ASM_TRUSTED_IPS               = 1 << 10  # supports trusted ip
+
+        # TODO: we need to dynamically add CAP_ASM_ACTIVATION once we support it
+        ASM_CAPABILITIES = [
+          CAP_ASM_IP_BLOCKING,
+          CAP_ASM_USER_BLOCKING,
+          CAP_ASM_EXCLUSIONS,
+          CAP_ASM_REQUEST_BLOCKING,
+          CAP_ASM_RESPONSE_BLOCKING,
+          CAP_ASM_DD_RULES,
+          CAP_ASM_CUSTOM_RULES,
+          CAP_ASM_CUSTOM_BLOCKING_RESPONSE,
+          CAP_ASM_TRUSTED_IPS,
+        ].freeze
+
+        ASM_PRODUCTS = [
+          'ASM_DD',       # Datadog employee issued configuration
+          'ASM',          # customer issued configuration (rulesets, passlist...)
+          'ASM_FEATURES', # capabilities
+          'ASM_DATA',     # config files (IP addresses or users for blocking)
+        ].freeze
+
+        def capabilities
+          remote_features_enabled? ? ASM_CAPABILITIES : []
+        end
+
+        def products
+          remote_features_enabled? ? ASM_PRODUCTS : []
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def receivers
+          return [] unless remote_features_enabled?
+
+          matcher = Core::Remote::Dispatcher::Matcher::Product.new(ASM_PRODUCTS)
+          receiver = Core::Remote::Dispatcher::Receiver.new(matcher) do |repository, changes|
+            changes.each do |change|
+              Datadog.logger.debug { "remote config change: '#{change.path}'" }
+            end
+
+            rules = []
+            custom_rules = []
+            data = []
+            overrides = []
+            exclusions = []
+            actions = []
+
+            repository.contents.each do |content|
+              parsed_content = parse_content(content)
+
+              case content.path.product
+              when 'ASM_DD'
+                rules << parsed_content
+              when 'ASM_DATA'
+                data << parsed_content['rules_data'] if parsed_content['rules_data']
+              when 'ASM'
+                overrides << parsed_content['rules_override'] if parsed_content['rules_override']
+                exclusions << parsed_content['exclusions'] if parsed_content['exclusions']
+                custom_rules << parsed_content['custom_rules'] if parsed_content['custom_rules']
+                actions.concat(parsed_content['actions']) if parsed_content['actions']
+              end
+            end
+
+            if rules.empty?
+              settings_rules = AppSec::Processor::RuleLoader.load_rules(ruleset: Datadog.configuration.appsec.ruleset)
+
+              raise NoRulesError, 'no default rules available' unless settings_rules
+
+              rules = [settings_rules]
+            end
+
+            ruleset = AppSec::Processor::RuleMerger.merge(
+              rules: rules,
+              data: data,
+              overrides: overrides,
+              exclusions: exclusions,
+              custom_rules: custom_rules,
+            )
+
+            Datadog::AppSec.reconfigure(ruleset: ruleset, actions: actions)
+          end
+
+          [receiver]
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        private
+
+        def remote_features_enabled?
+          Datadog.configuration.appsec.using_default?(:ruleset)
+        end
+
+        def parse_content(content)
+          data = content.data.read
+
+          content.data.rewind
+
+          raise ReadError, 'EOF reached' if data.nil?
+
+          JSON.parse(data)
+        end
+      end
+    end
+  end
+end

data/lib/datadog/appsec/response.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require_relative 'assets'
+require_relative 'utils/http/media_range'
+
+module Datadog
+  module AppSec
+    # AppSec response
+    class Response
+      attr_reader :status, :headers, :body
+
+      def initialize(status:, headers: {}, body: [])
+        @status = status
+        @headers = headers
+        @body = body
+      end
+
+      def to_rack
+        [status, headers, body]
+      end
+
+      def to_sinatra_response
+        ::Sinatra::Response.new(body, status, headers)
+      end
+
+      def to_action_dispatch_response
+        ::ActionDispatch::Response.new(status, headers, body)
+      end
+
+      class << self
+        def negotiate(env, actions)
+          # @type var configured_response: Response?
+          configured_response = nil
+          actions.each do |action|
+            # Need to use next to make steep happy :(
+            # I rather use break to stop the execution
+            next if configured_response
+
+            action_configuration = AppSec::Processor::Actions.fecth_configuration(action)
+            next unless action_configuration
+
+            configured_response = case action_configuration['type']
+                                  when 'block_request'
+                                    block_response(env, action_configuration['parameters'])
+                                  when 'redirect_request'
+                                    redirect_response(env, action_configuration['parameters'])
+                                  end
+          end
+
+          configured_response || default_response(env)
+        end
+
+        private
+
+        def default_response(env)
+          content_type = content_type(env)
+
+          body = []
+          body << content(content_type)
+
+          Response.new(
+            status: 403,
+            headers: { 'Content-Type' => content_type },
+            body: body,
+          )
+        end
+
+        def block_response(env, options)
+          content_type = if options['type'] == 'auto'
+                           content_type(env)
+                         else
+                           FORMAT_TO_CONTENT_TYPE[options['type']]
+                         end
+
+          body = []
+          body << content(content_type)
+
+          Response.new(
+            status: options['status_code'] || 403,
+            headers: { 'Content-Type' => content_type },
+            body: body,
+          )
+        end
+
+        def redirect_response(env, options)
+          if options['location'] && !options['location'].empty?
+            content_type = content_type(env)
+
+            status = options['status_code'] >= 300 && options['status_code'] < 400 ? options['status_code'] : 303
+
+            headers = {
+              'Content-Type' => content_type,
+              'Location' => options['location']
+            }
+
+            Response.new(
+              status: status,
+              headers: headers,
+              body: [],
+            )
+          else
+            default_response(env)
+          end
+        end
+
+        CONTENT_TYPE_TO_FORMAT = {
+          'application/json' => :json,
+          'text/html' => :html,
+          'text/plain' => :text,
+        }.freeze
+
+        FORMAT_TO_CONTENT_TYPE = {
+          'json' => 'application/json',
+          'html' => 'text/html',
+        }.freeze
+
+        DEFAULT_CONTENT_TYPE = 'application/json'
+
+        def content_type(env)
+          return DEFAULT_CONTENT_TYPE unless env.key?('HTTP_ACCEPT')
+
+          accept_types = env['HTTP_ACCEPT'].split(',').map(&:strip)
+
+          accepted = accept_types.map { |m| Utils::HTTP::MediaRange.new(m) }.sort!.reverse!
+
+          accepted.each do |range|
+            type_match = CONTENT_TYPE_TO_FORMAT.keys.find { |type| range === type }
+
+            return type_match if type_match
+          end
+
+          DEFAULT_CONTENT_TYPE
+        rescue Datadog::AppSec::Utils::HTTP::MediaRange::ParseError
+          DEFAULT_CONTENT_TYPE
+        end
+
+        def content(content_type)
+          content_format = CONTENT_TYPE_TO_FORMAT[content_type]
+
+          using_default = Datadog.configuration.appsec.block.templates.using_default?(content_format)
+
+          if using_default
+            Datadog::AppSec::Assets.blocked(format: content_format)
+          else
+            Datadog.configuration.appsec.block.templates.send(content_format)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/appsec/sample_rate.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Datadog
+  module AppSec
+    # SampleRate basic sample rate
+    class SampleRate
+      attr_reader :rate
+
+      def initialize(rate)
+        @rate = rate
+      end
+
+      def sample?
+        return false if rate <= 0
+        return true if rate >= 1
+
+        Kernel.rand < rate
+      end
+    end
+  end
+end

data/lib/datadog/appsec/scope.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative 'processor'
+
+module Datadog
+  module AppSec
+    # Capture context essential to consistently call processor and report via traces
+    class Scope
+      attr_reader :trace, :service_entry_span, :processor_context
+
+      def initialize(trace, service_entry_span, processor_context)
+        @trace = trace
+        @service_entry_span = service_entry_span
+        @processor_context = processor_context
+      end
+
+      def finalize
+        @processor_context.finalize
+      end
+
+      class << self
+        def activate_scope(trace, service_entry_span, processor)
+          raise ActiveScopeError, 'another scope is active, nested scopes are not supported' if active_scope
+
+          context = Datadog::AppSec::Processor::Context.new(processor)
+
+          self.active_scope = new(trace, service_entry_span, context)
+        end
+
+        def deactivate_scope
+          raise InactiveScopeError, 'no scope is active, nested scopes are not supported' unless active_scope
+
+          scope = active_scope
+
+          reset_active_scope
+
+          scope.finalize
+        end
+
+        def active_scope
+          Thread.current[:datadog_appsec_active_scope]
+        end
+
+        private
+
+        def active_scope=(scope)
+          raise ArgumentError, 'not a Datadog::AppSec::Scope' unless scope.instance_of?(Scope)
+
+          Thread.current[:datadog_appsec_active_scope] = scope
+        end
+
+        def reset_active_scope
+          Thread.current[:datadog_appsec_active_scope] = nil
+        end
+      end
+
+      class InactiveScopeError < StandardError; end
+      class ActiveScopeError < StandardError; end
+    end
+  end
+end

data/lib/datadog/appsec/utils/http/media_range.rb

@@ -0,0 +1,199 @@
+require_relative 'media_type'
+
+module Datadog
+  module AppSec
+    module Utils
+      module HTTP
+        # Implementation of media range for content negotiation
+        class MediaRange
+          class ParseError < ::StandardError
+          end
+
+          WILDCARD = '*'.freeze
+          WILDCARD_RE = ::Regexp.escape(WILDCARD)
+
+          # See: https://www.rfc-editor.org/rfc/rfc7230#section-3.2.6
+          TOKEN_RE = /[-#$%&'*+.^_`|~A-Za-z0-9]+/.freeze
+
+          # See: https://www.rfc-editor.org/rfc/rfc7231#section-3.1.1.1
+          PARAMETER_RE = %r{ # rubocop:disable Style/RegexpLiteral
+            (?:
+              (?<parameter_name>#{TOKEN_RE})
+              =
+              (?:
+                (?<parameter_value>#{TOKEN_RE})
+                |
+                "(?<parameter_value>[^"]+)"
+              )
+            )
+          }ix.freeze
+
+          # See: https://www.rfc-editor.org/rfc/rfc7231#section-5.3.2
+          ACCEPT_EXT_RE = %r{ # rubocop:disable Style/RegexpLiteral
+            (?:
+              (?<ext_name>#{TOKEN_RE})
+              =
+              (?:
+                (?<ext_value>#{TOKEN_RE})
+                |
+                "(?<ext_value>[^"]+)"
+              )
+            )
+          }ix.freeze
+
+          # See: https://www.rfc-editor.org/rfc/rfc7231#section-5.3.1
+          QVALUE_RE = %r{ # rubocop:disable Style/RegexpLiteral
+            0(?:\.\d{1,3})?
+            |
+            1(?:\.0{1,3})?
+          }ix.freeze
+
+          # See: https://www.rfc-editor.org/rfc/rfc7231#section-5.3.2
+          MEDIA_RANGE_RE = %r{
+            \A
+            (?:
+              (?<type>#{WILDCARD_RE})/(?<subtype>#{WILDCARD_RE})
+              |
+              (?<type>#{TOKEN_RE})/(?<subtype>#{WILDCARD_RE})
+              |
+              (?<type>#{TOKEN_RE})/(?<subtype>#{TOKEN_RE})
+            )
+            (?<parameters>
+              (?:
+                \s*;\s*
+                (?!q=)
+                #{PARAMETER_RE}
+              )*
+            )
+            (?<accept_params>
+              (?<weight>
+                \s*;\s*
+                (?:q=
+                  (?<quality>
+                    #{QVALUE_RE}
+                  )
+                )
+              )
+              (?<accept_exts>
+                (?<accept_ext>
+                  (?:
+                    \s*;\s*
+                    (?!q=)
+                    #{ACCEPT_EXT_RE}
+                  )*
+                )
+              )
+            )?
+            \Z
+          }ix.freeze
+
+          attr_reader :type, :subtype, :quality, :parameters, :accept_ext
+
+          def initialize(media_range) # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+            media_range_match = MEDIA_RANGE_RE.match(media_range)
+
+            raise ParseError, media_range.inspect if media_range_match.nil?
+
+            @type = (media_range_match['type'] || WILDCARD).downcase
+            @subtype = (media_range_match['subtype'] || WILDCARD).downcase
+            @quality = (media_range_match['quality'] || 1.0).to_f
+            @parameters = {}
+            @accept_ext = {}
+
+            parameters = media_range_match['parameters']
+
+            return if parameters.nil?
+
+            parameters.split(';').map(&:strip).each do |parameter|
+              parameter_match = PARAMETER_RE.match(parameter)
+
+              next if parameter_match.nil?
+
+              parameter_name = parameter_match['parameter_name']
+              parameter_value = parameter_match['parameter_value']
+
+              next if parameter_name.nil? || parameter_value.nil?
+
+              @parameters[parameter_name.downcase] = parameter_value.downcase
+            end
+
+            accept_exts = media_range_match['accept_exts']
+
+            return if accept_exts.nil?
+
+            accept_exts.split(';').map(&:strip).each do |ext|
+              ext_match = ACCEPT_EXT_RE.match(ext)
+
+              next if ext_match.nil?
+
+              ext_name = ext_match['ext_name']
+              ext_value = ext_match['ext_value']
+
+              next if ext_name.nil? || ext_value.nil?
+
+              @accept_ext[ext_name.downcase] = ext_value.downcase
+            end
+          end
+
+          # Compare two MediaRange for ordering
+          def <=>(other)
+            unless (q = quality <=> other.quality) == 0 || q.nil?
+              return q
+            end
+
+            if (s = specificity <=> other.specificity) != 0
+              return s
+            end
+
+            unless wildcard?(:type)
+              if wildcard?(:subtype) && !other.wildcard?(:subtype)
+                return -1
+              elsif !wildcard?(:subtype) && other.wildcard?(:subtype)
+                return 1
+              end
+            end
+
+            if wildcard?(:type) && !other.wildcard?(:type)
+              return -1
+            elsif !wildcard?(:type) && other.wildcard?(:type)
+              return 1
+            end
+
+            0
+          end
+
+          # Compare with a MediaType for match
+          #
+          # returns true if the MediaType is accepted by this MediaRange
+          def ===(other)
+            return self === MediaType.new(other) if other.is_a?(::String)
+
+            type == other.type && subtype == other.subtype && other.parameters.all? { |k, v| parameters[k] == v } ||
+              type == other.type && wildcard?(:subtype) ||
+              wildcard?(:type) && wildcard?(:subtype)
+          end
+
+          def specificity
+            @parameters.count
+          end
+
+          def wildcard?(field = nil)
+            return wildcard?(:type) || wildcard?(:subtype) if field.nil?
+
+            instance_variable_get(:"@#{field}") == WILDCARD
+          end
+
+          def to_s
+            s = "#{@type}/#{@subtype}"
+
+            s << ';' << @parameters.map { |k, v| "#{k}=#{v}" }.join(';') if @parameters.count > 0
+            s << ";q=#{@quality}" if @quality < 1.0
+            s << ';' << @accept_ext.map { |k, v| "#{k}=#{v}" }.join(';') if @accept_ext.count > 0
+
+            s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/appsec/utils/http/media_type.rb

@@ -0,0 +1,85 @@
+module Datadog
+  module AppSec
+    module Utils
+      module HTTP
+        # Implementation of media type for content negotiation
+        #
+        # See:
+        # - https://www.rfc-editor.org/rfc/rfc7231#section-5.3.1
+        # - https://www.rfc-editor.org/rfc/rfc7231#section-5.3.2
+        class MediaType
+          class ParseError < ::StandardError
+          end
+
+          WILDCARD = '*'.freeze
+
+          # See: https://www.rfc-editor.org/rfc/rfc7230#section-3.2.6
+          TOKEN_RE = /[-#$%&'*+.^_`|~A-Za-z0-9]+/.freeze
+
+          # See: https://www.rfc-editor.org/rfc/rfc7231#section-3.1.1.1
+          PARAMETER_RE = %r{ # rubocop:disable Style/RegexpLiteral
+            (?:
+              (?<parameter_name>#{TOKEN_RE})
+              =
+              (?:
+                (?<parameter_value>#{TOKEN_RE})
+                |
+                "(?<parameter_value>[^"]+)"
+              )
+            )
+          }ix.freeze
+
+          # See: https://www.rfc-editor.org/rfc/rfc7231#section-3.1.1.1
+          MEDIA_TYPE_RE = %r{
+            \A
+            (?<type>#{TOKEN_RE})/(?<subtype>#{TOKEN_RE})
+            (?<parameters>
+              (?:
+                \s*;\s*
+                #{PARAMETER_RE}
+              )*
+            )
+            \Z
+          }ix.freeze
+
+          attr_reader :type, :subtype, :parameters
+
+          def initialize(media_type)
+            media_type_match = MEDIA_TYPE_RE.match(media_type)
+
+            raise ParseError, media_type.inspect if media_type_match.nil?
+
+            @type = (media_type_match['type'] || WILDCARD).downcase
+            @subtype = (media_type_match['subtype'] || WILDCARD).downcase
+            @parameters = {}
+
+            parameters = media_type_match['parameters']
+
+            return if parameters.nil?
+
+            parameters.split(';').map(&:strip).each do |parameter|
+              parameter_match = PARAMETER_RE.match(parameter)
+
+              next if parameter_match.nil?
+
+              parameter_name = parameter_match['parameter_name']
+              parameter_value = parameter_match['parameter_value']
+
+              next if parameter_name.nil? || parameter_value.nil?
+
+              @parameters[parameter_name.downcase] = parameter_value.downcase
+            end
+          end
+
+          def to_s
+            s = "#{@type}/#{@subtype}"
+
+            s << ';' << @parameters.map { |k, v| "#{k}=#{v}" }.join(';') if @parameters.count > 0
+
+            s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/appsec/utils/http.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Datadog
+  module AppSec
+    module Utils
+      # HTTP utilities
+      module HTTP
+      end
+    end
+  end
+end

data/lib/datadog/appsec/utils.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Datadog
+  module AppSec
+    # Utilities for AppSec
+    module Utils
+    end
+  end
+end