sqreen 1.18.5 → 1.19.2

data/lib/sqreen/weave/legacy.rb

@@ -0,0 +1,12 @@
+# typed: strong
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
+require 'sqreen/weave'
+
+module Sqreen
+  module Weave
+    module Legacy; end
+  end
+end

data/lib/sqreen/weave/legacy/instrumentation.rb

@@ -0,0 +1,406 @@
+# typed: false
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
+require 'sqreen/weave/legacy'
+require 'sqreen/graft/hook_point'
+require 'sqreen/call_countable'
+require 'sqreen/rules'
+require 'sqreen/rules/record_request_context'
+
+class Sqreen::Weave::Legacy::Instrumentation
+  attr_accessor :metrics_engine
+
+  def initialize(metrics_engine, opts = {})
+    Sqreen::Weave.logger.debug { "#{self.class.name}#initialize #{metrics_engine}" }
+    @hooks = []
+
+    self.metrics_engine = metrics_engine
+
+    ### bail out if no metric engine
+    return if metrics_engine.nil?
+
+    ### init metric to count calls to sqreen
+    metrics_engine.create_metric(
+      'name' => 'sqreen_call_counts',
+      'period' => 60,
+      'kind' => 'Sum',
+    )
+    ### init metric to count request whitelist matches (ip or path whitelist)
+    metrics_engine.create_metric(
+      'name' => 'whitelisted',
+      'period' => 60,
+      'kind' => 'Sum',
+    )
+    ### init metric to count over budget hits
+    metrics_engine.create_metric(
+      'name' => 'request_overtime',
+      'period' => 60,
+      'kind' => 'Sum',
+    )
+
+    # PerformanceNotifications::Binning
+    metrics_engine.create_metric(
+      'name' => 'req',
+      'period' => opts[:period] || 60,
+      'kind' => 'Binning',
+      'options' => opts[:perf_metric] || { 'base' => 2.0, 'factor' => 0.1 },
+    )
+    metrics_engine.create_metric(
+      'name' => 'sq',
+      'period' => opts[:period] || 60,
+      'kind' => 'Binning',
+      'options' => opts[:perf_metric] || { 'base' => 2.0, 'factor' => 0.1 },
+    )
+    metrics_engine.create_metric(
+      'name' => 'pct',
+      'period' => opts[:period] || 60,
+      'kind' => 'Binning',
+      'options' => opts[:perf_metric_percent] || { 'base' => 1.3, 'factor' => 1.0 },
+    )
+
+    Sqreen.thread_cpu_time? && metrics_engine.create_metric(
+      'name' => 'sq_thread_cpu_pct',
+      'period' => opts[:period] || 60,
+      'kind' => 'Binning',
+      'options' => opts[:perf_metric_percent] || { 'base' => 1.3, 'factor' => 1.0 },
+    )
+  end
+
+  # needed by Sqreen::Runner#initialize
+  def instrument!(rules, framework)
+    Sqreen::Weave.logger.debug { "#{rules.count} rules, #{framework}" }
+
+    strategy = Sqreen.config_get(:weave_strategy)
+    if strategy == :prepend && !Module.respond_to?(:prepend)
+      Sqreen::Weave.logger.warn { "strategy: #{strategy.inspect} unavailable, falling back to :chain" }
+      strategy = :chain
+    elsif strategy == :chain && Gem::Specification.select { |s| s.name == 'scout_apm' && Gem::Requirement.new('>= 2.5.2').satisfied_by?(Gem::Version.new(s.version)) }.any?
+      Sqreen::Weave.logger.warn { "strategy: #{strategy.inspect} unavailable with scout_apm >= 2.5.2, switching to :prepend" }
+      strategy = :prepend
+    end
+    Sqreen::Weave.logger.debug { "strategy: #{strategy.inspect}" }
+
+    ### set up rule signature verifier
+    verifier = nil
+    ### force clean instrumentation callback list
+    @hooks = []
+    ### for each rule description
+    rules.each do |rule|
+      Sqreen::Weave.logger.debug { "Processing rule: #{rule['name']}" }
+      ### transform into format for adding callback
+      rule_callback = Sqreen::Rules.cb_from_rule(rule, self, metrics_engine, verifier)
+      next unless rule_callback
+      ### attach framework to callback
+      rule_callback.framework = framework
+      ### install callback, observing priority
+      Sqreen::Weave.logger.debug { "Adding rule callback: #{rule_callback}" }
+      @hooks << add_callback("weave,rule=#{rule['name']}", rule_callback, strategy)
+    end
+
+    ### for each hardcoded callback
+    hardcoded_callbacks(framework).each do |hard_callback|
+      Sqreen::Weave.logger.debug { "Adding hardcoded callback: #{hard_callback}" }
+      ###   install hardcoded callbacks, observing priority
+      @hooks << add_callback('weave,hardcoded', hard_callback, strategy)
+    end
+
+    metrics_engine = self.metrics_engine
+    request_hook = Sqreen::Graft::Hook['Sqreen::ShrinkWrap#call', strategy]
+    @hooks << request_hook
+    request_hook.add do
+      before('wave,meta,request', rank: -100000, mandatory: true) do |_call|
+        next unless Sqreen.instrumentation_ready
+
+        uuid = SecureRandom.uuid
+        now = Sqreen::Graft::Timer.read
+        Thread.current[:sqreen_http_request] = {
+          uuid: uuid,
+          start_time: now,
+          time_budget: Sqreen.performance_budget,
+          time_budget_expended: false,
+          timer: Sqreen::Graft::Timer.new("request_#{uuid}"),
+          timed_callbacks: [],
+          timed_hooks: [],
+          timed_hooks_before: [],
+          timed_hooks_after: [],
+          timed_hooks_raised: [],
+          timed_hooks_ensured: [],
+          skipped_callbacks: [],
+        }
+
+        Sqreen::Weave.logger.debug { "request.uuid: #{uuid}" }
+      end
+
+      ensured('weave,meta,request', rank: 100000, mandatory: true) do |_call|
+        request = Thread.current[:sqreen_http_request]
+
+        next if request.nil?
+
+        Thread.current[:sqreen_http_request] = nil
+        now = Sqreen::Graft::Timer.read
+        utc_now = Time.now.utc
+
+        request[:timed_callbacks].each do |timer|
+          duration = timer.duration
+          # stop = now
+          # start = now - duration
+          timer.tag =~ /weave,rule=(.*)$/ && rule = $1
+          timer.tag =~ /@before/ && whence = 'pre'
+          timer.tag =~ /@after/  && whence = 'post'
+          timer.tag =~ /@raised/ && whence = 'failing'
+
+          next unless rule && whence
+
+          # Sqreen::PerformanceNotifications.notify(rule, whence, start, stop)
+          # => BinnedMetrics
+          metric_name = "sq.#{rule}.#{whence}"
+          unless metrics_engine.metric?(metric_name)
+            metrics_engine.create_metric(
+              'name' => metric_name,
+              'period' => 60,
+              'kind' => 'Binning',
+              'options' => { 'base' => 2.0, 'factor' => 0.1 },
+            )
+          end
+          metrics_engine.update(metric_name, now, nil, duration * 1000)
+        end
+
+        metric_name = 'sq.hooks_pre.pre'
+        duration = request[:timed_hooks_before].sum(&:duration)
+        unless metrics_engine.metric?(metric_name)
+          metrics_engine.create_metric(
+            'name' => metric_name,
+            'period' => 60,
+            'kind' => 'Binning',
+            'options' => { 'base' => 2.0, 'factor' => 0.1 },
+          )
+        end
+        metrics_engine.update(metric_name, now, nil, duration * 1000)
+
+        metric_name = 'sq.hooks_post.post'
+        duration = request[:timed_hooks_after].sum(&:duration)
+        unless metrics_engine.metric?(metric_name)
+          metrics_engine.create_metric(
+            'name' => metric_name,
+            'period' => 60,
+            'kind' => 'Binning',
+            'options' => { 'base' => 2.0, 'factor' => 0.1 },
+          )
+        end
+        metrics_engine.update(metric_name, now, nil, duration * 1000)
+
+        metric_name = 'sq.hooks_failing.failing'
+        duration = request[:timed_hooks_raised].sum(&:duration)
+        unless metrics_engine.metric?(metric_name)
+          metrics_engine.create_metric(
+            'name' => metric_name,
+            'period' => 60,
+            'kind' => 'Binning',
+            'options' => { 'base' => 2.0, 'factor' => 0.1 },
+          )
+        end
+        metrics_engine.update(metric_name, now, nil, duration * 1000)
+
+        skipped = request[:skipped_callbacks].map(&:name)
+        Sqreen::Weave.logger.debug { "request:#{request[:uuid]} callback.skipped.size: #{skipped.count} callback.skipped: [#{skipped.join(', ')}]" }
+        timer = request[:timer]
+        total = timer.duration
+        Sqreen::Weave.logger.debug { "request:#{request[:uuid]} timer.total: #{'%.03fus' % (total * 1_000_000)} timer.size: #{timer.size}" }
+        timings = request[:timed_callbacks].map(&:to_s)
+        total = request[:timed_callbacks].sum(&:duration)
+        Sqreen::Weave.logger.debug { "request:#{request[:uuid]} callback.total: #{'%.03fus' % (total * 1_000_000)} callback.timings: [#{timings.join(', ')}]" }
+        timings = request[:timed_hooks].map(&:to_s)
+        total = request[:timed_hooks].sum(&:duration)
+        Sqreen::Weave.logger.debug { "request:#{request[:uuid]} hook.total: #{'%.03fus' % (total * 1_000_000)} hook.timings: [#{timings.join(', ')}]" }
+
+        skipped = request[:skipped_callbacks].map(&:name)
+        skipped_rule_name = skipped.first && skipped.first =~ /weave,rule=(.*)$/ && $1
+        Sqreen.observations_queue.push(['request_overtime', skipped_rule_name, 1, utc_now]) if skipped_rule_name
+
+        sqreen_request_duration = total
+        Sqreen.observations_queue.push(['sq', nil, sqreen_request_duration * 1000, utc_now])
+
+        request_duration = now - request[:start_time]
+        Sqreen.observations_queue.push(['req', nil, request_duration * 1000, utc_now])
+
+        sqreen_request_ratio = (sqreen_request_duration * 100.0) / (request_duration - sqreen_request_duration)
+        Sqreen.observations_queue.push(['pct', nil, sqreen_request_ratio, utc_now])
+      end
+    end.install
+
+    ### globally declare instrumentation ready
+    Sqreen.instrumentation_ready = true
+  end
+
+  # needed by Sqreen::Runner
+  def remove_all_callbacks
+    Sqreen.instrumentation_ready = false
+
+    loop do
+      hook = @hooks.pop
+      break unless hook
+      Sqreen::Weave.logger.debug { "hook.deinstrument: #{hook}" }
+      hook.uninstall
+      hook.clear
+    end
+  end
+
+  # needed by #instrument!
+  def add_callback(rule, callback, strategy)
+    Sqreen::Weave.logger.debug { "Adding rule: #{rule} callback: #{callback}" }
+    klass = callback.klass
+    method = callback.method
+
+    if Sqreen::Graft::HookPoint.new("#{klass}.#{method}").exist?
+      hook_point = "#{klass}.#{method}"
+    elsif Sqreen::Graft::HookPoint.new("#{klass}##{method}").exist?
+      hook_point = "#{klass}##{method}"
+    end
+
+    return if hook_point.nil?
+
+    priority = callback.priority || 100
+    block = callback.respond_to?(:block) ? callback.block : true
+    ignore = -> { callback.whitelisted? } if callback.respond_to?(:whitelisted?)
+
+    hook = Sqreen::Graft::Hook[hook_point, strategy]
+    hook.add do
+      if callback.pre?
+        before(rule, rank: priority, mandatory: !callback.overtimeable, flow: block, ignore: ignore) do |call, b|
+          next unless Thread.current[:sqreen_http_request]
+
+          i = call.instance
+          a = call.args
+          r = call.remaining
+
+          Sqreen::Weave.logger.debug { "#{rule} klass=#{callback.klass} method=#{callback.method} when=#pre instance=#{i}" }
+          begin
+            ret = callback.pre(i, a, r)
+          rescue StandardError => e
+            Sqreen::Weave.logger.warn { "#{rule} klass=#{callback.klass} method=#{callback.method} when=#pre instance=#{i} => exception=#{e}" }
+            if callback.respond_to?(:record_exception)
+              callback.record_exception(e)
+            else
+              Sqreen::RemoteException.record(e)
+            end
+          end
+          Sqreen::Weave.logger.debug { "#{rule} klass=#{callback.klass} method=#{callback.method} when=#pre instance=#{i} => return=#{ret.inspect}" }
+
+          case ret[:status]
+          when :skip, 'skip'
+            throw(b, b.return(ret[:new_return_value]).break!) if ret.key?(:new_return_value)
+          when :modify_args, 'modify_args'
+            throw(b, b.args(ret[:args]))
+          when :raise, 'raise'
+            throw(b, b.raise(ret[:exception])) if ret.key?(:exception)
+            throw(b, b.raise(Sqreen::AttackBlocked.new("Sqreen blocked a security threat (type: #{callback.rule_name}). No action is required.")))
+          end unless ret.nil? || !ret.is_a?(Hash)
+        end
+      end
+
+      if callback.post?
+        after(rule, rank: -priority, mandatory: !callback.overtimeable, flow: block, ignore: ignore) do |call, b|
+          next unless Thread.current[:sqreen_http_request]
+
+          i = call.instance
+          v = call.returned
+          a = call.args
+          r = call.remaining
+
+          Sqreen::Weave.logger.debug { "#{rule} klass=#{callback.klass} method=#{callback.method} when=#post instance=#{i}" }
+          begin
+            ret = callback.post(v, i, a, r)
+          rescue StandardError => e
+            Sqreen::Weave.logger.warn { "#{rule} klass=#{callback.klass} method=#{callback.method} when=#post instance=#{i} => exception=#{e}" }
+            if callback.respond_to?(:record_exception)
+              callback.record_exception(e)
+            else
+              Sqreen::RemoteException.record(e)
+            end
+          end
+          Sqreen::Weave.logger.debug { "#{rule} klass=#{callback.klass} method=#{callback.method} when=#post instance=#{i} => return=#{ret.inspect}" }
+
+          case ret[:status]
+          when :override, 'override'
+            throw(b, b.return(ret[:new_return_value])) if ret.key?(:new_return_value)
+          when :raise, 'raise'
+            throw(b, b.raise(ret[:exception])) if ret.key?(:exception)
+            throw(b, b.raise(Sqreen::AttackBlocked.new("Sqreen blocked a security threat (type: #{callback.rule_name}). No action is required.")))
+          end unless ret.nil? || !ret.is_a?(Hash)
+        end
+      end
+
+      if callback.failing?
+        raised(rule, rank: priority, mandatory: !callback.overtimeable, flow: block, ignore: ignore) do |call, b|
+          next unless Thread.current[:sqreen_http_request]
+
+          i = call.instance
+          e = call.raised
+          a = call.args
+          r = call.remaining
+
+          Sqreen::Weave.logger.debug { "#{rule} klass=#{callback.klass} method=#{callback.method} when=#failing instance=#{i}" }
+          begin
+            ret = callback.failing(e, i, a, r)
+          rescue StandardError => e
+            Sqreen::Weave.logger.warn { "#{rule} klass=#{callback.klass} method=#{callback.method} when=#failing instance=#{i} => exception=#{e}" }
+            if callback.respond_to?(:record_exception)
+              callback.record_exception(e)
+            else
+              Sqreen::RemoteException.record(e)
+            end
+          end
+          Sqreen::Weave.logger.debug { "#{rule} klass=#{callback.klass} method=#{callback.method} when=#failing instance=#{i} => return=#{ret.inspect}" }
+
+          throw(b, b.raise(e)) if ret.nil? || !ret.is_a?(Hash)
+
+          case ret[:status]
+          when :override, 'override'
+            throw(b, b.return(ret[:new_return_value])) if ret.key?(:new_return_value)
+          when :retry, 'retry'
+            throw(b, b.retry)
+          when :raise, 'raise'
+            throw(b, b.raise(ret[:exception])) if ret.key?(:exception)
+            throw(b, b.raise(Sqreen::AttackBlocked.new("Sqreen blocked a security threat (type: #{callback.rule_name}). No action is required.")))
+          when :reraise, 'reraise'
+            throw(b, b.raise(e))
+          else
+            throw(b, b.raise(e))
+          end unless ret.nil? || !ret.is_a?(Hash)
+        end
+      end
+    end.install
+
+    hook
+  end
+
+  # needed by Sqreen::Rules.cb_from_rule
+  def valid_method?(klass, method)
+    if Sqreen::Graft::HookPoint.new("#{klass}.#{method}").exist?
+      Sqreen::Weave.logger.debug { "HookPoint found: #{klass}.#{method}" }
+      true
+    elsif Sqreen::Graft::HookPoint.new("#{klass}##{method}").exist?
+      Sqreen::Weave.logger.debug { "HookPoint found: #{klass}##{method}" }
+      true
+    else
+      Sqreen::Weave.logger.debug { "HookPoint not found: #{klass} #{method}" }
+      false
+    end
+  end
+
+  # needed by #instrument!
+  def hardcoded_callbacks(framework)
+    [
+      ### callback for performing sec responses based on ip
+      ### init redefined to implement smartass way to hook it upon the
+      ### framework's middleware #call
+      Sqreen::Rules::RunReqStartActions.new(framework),
+      ### callback for performing sec responses based on user
+      Sqreen::Rules::RunUserActions.new(Sqreen, :identify, 0),
+      ### callback for performing sec responses based on user
+      Sqreen::Rules::RunUserActions.new(Sqreen, :auth_track, 1),
+    ]
+  end
+end

data/lib/sqreen/web_server.rb

@@ -1,3 +1,5 @@
+# typed: ignore
+
 # Copyright (c) 2015 Sqreen. All Rights Reserved.
 # Please refer to our terms for more information: https://www.sqreen.com/terms.html
 

data/lib/sqreen/web_server/generic.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 # Copyright (c) 2015 Sqreen. All Rights Reserved.
 # Please refer to our terms for more information: https://www.sqreen.com/terms.html
 

data/lib/sqreen/web_server/passenger.rb

@@ -1,3 +1,5 @@
+# typed: ignore
+
 # Copyright (c) 2015 Sqreen. All Rights Reserved.
 # Please refer to our terms for more information: https://www.sqreen.com/terms.html
 

data/lib/sqreen/web_server/puma.rb

@@ -1,3 +1,5 @@
+# typed: ignore
+
 # Copyright (c) 2015 Sqreen. All Rights Reserved.
 # Please refer to our terms for more information: https://www.sqreen.com/terms.html
 

data/lib/sqreen/web_server/rainbows.rb

@@ -1,3 +1,5 @@
+# typed: ignore
+
 # Copyright (c) 2015 Sqreen. All Rights Reserved.
 # Please refer to our terms for more information: https://www.sqreen.com/terms.html