sqreen 1.23.2 → 1.24.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e1881ab1def0e4a82ccfe791c150b0213517084619d71f5c942a0d14a0189e1
-  data.tar.gz: beeef4f164a84efbc00824a5c63926da6a4e3fcc5952577442061e1c509e8fda
+  metadata.gz: 63ea0b26ac35ae810d92bb1f7dee78283af5104c05ea064c20105178e915b109
+  data.tar.gz: ebba0fd2eaffc1c6af1a53949e40e9f06ac58129c5d40b2041db3be0463c8e19
 SHA512:
-  metadata.gz: b1d1ea43737baa0db830e556fc835f93104dc70465fc5695372c5a922e8108cb9e657e915cc7ffe06f655dc632b0d5e56daf659e0c6ef499b66484fcd6d33076
-  data.tar.gz: 98b0e405e39de271a9d8988692ea037b5f462b2af9314d384b7ca7dfec9dce43229b1aa317fbb8fccde84f1cd743d90637dabde392a2c7bfe88d6a6353e25235
+  metadata.gz: 0d4cd02caf498bb7c25b4882b4f095586bd177058a6f4251945914ea236152d0484f326a07bcf2404bd0524678a136ab240908c4039fd9ee5f6e81a2d0b2d277
+  data.tar.gz: 186e6a5585a8db09bd03cdf85f9a2b6fdaee67a83cf29f06ecc48552d9a10ce37a2f663126c076676ef8f9cbaa6848bb8d893c50a1650f1621eb9629c0742f85

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 1.24.3
+
+* Fix WAF exception reporting corner case
+
+## 1.24.2
+
+* Fix kwargs for rule callbacks on Ruby 3+
+* Fix properties propagation for custom events
+* Fix Devise key type mismatch for signup
+
+## 1.24.1
+
+* Add Datadog trace keeping through sampling
+* Improve Datadog correlation compatibility with Sinatra
+* Improve attack event correlation with Datadog spans
+
+## 1.24.0
+
+* Add Sqreen event correlation with Datadog traces
+
 ## 1.23.2
 
 * Fix compatibility with NewRelic for attack events

data/lib/sqreen/dependency/sinatra.rb

@@ -61,6 +61,26 @@ module Sqreen
             u.append(p)
           end
         end
+
+        insert_datadog_middleware(builder, *args, &block)
+      end
+
+      def insert_datadog_middleware(builder, *args, &block)
+        return unless defined?(Datadog) && Datadog.respond_to?(:configuration) && Datadog.configuration.instrumented_integrations.key?(:sinatra)
+
+        Datadog.configure do |c|
+          sinatra_config = Datadog.configuration[:sinatra]
+
+          c.use(
+            :rack,
+            service_name: sinatra_config[:service_name],
+            distributed_tracing: sinatra_config[:distributed_tracing],
+          ) unless Datadog.configuration.instrumented_integrations.key?(:rack)
+        end
+
+        insert_middleware(builder, Datadog::Contrib::Rack::TraceMiddleware, args, block) do |p, u|
+          u.insert(0, p)
+        end
       end
 
       def wrap_middleware(middleware, *args, &block)

data/lib/sqreen/events/attack.rb

@@ -63,6 +63,14 @@ module Sqreen
       payload['context']['backtrace']
     end
 
+    def datadog_trace_id
+      payload['context']['datadog_trace_id']
+    end
+
+    def datadog_span_id
+      payload['context']['datadog_span_id']
+    end
+
     def enqueue
       Sqreen.queue.push(self)
     end

data/lib/sqreen/frameworks/generic.rb

@@ -173,7 +173,18 @@ module Sqreen
           :remote_port => req.env['REMOTE_PORT'],
           :remote_ip => remote_addr,
           :client_ip => client_ip,
-        }
+        }.tap do |h|
+          h.merge!(
+            :datadog_trace_id => datadog_span.trace_id,
+            :datadog_span_id => datadog_span.span_id,
+          ) if datadog_span
+        end
+      end
+
+      def datadog_span
+        return unless defined?(Datadog) && (tracer = Datadog.tracer)
+
+        tracer.active_span
       end
 
       def response_infos

data/lib/sqreen/graft/hook.ruby_3.rb

@@ -112,7 +112,7 @@ module Sqreen
 
                   flow = catch(Ball.new) do |ball|
                     Timer.new(c.name, &timed_callbacks_proc).measure(ignore: chrono) do
-                      c.call(CallbackCall.new(c, remaining, hooked_call.instance, hooked_call.args_passed), ball)
+                      c.call(CallbackCall.new(c, remaining, hooked_call.instance, kwargs.empty? ? hooked_call.args_passed : hooked_call.args_passed + [kwargs]), ball)
                     end
                   end
 

data/lib/sqreen/rules/devise_signup_track_cb.rb

@@ -20,7 +20,7 @@ module Sqreen
         keys = args[1].class.authentication_keys
         ip = framework.client_ip
         category = 'auto-signup'
-        data = data.select { |k, _| keys.include?(k) }
+        data = data.select { |k, _| keys.map(&:to_s).include?(k.to_s) }
 
         if data.empty?
           Sqreen.log.debug { "#{category} from #{ip} but keys empty" }

data/lib/sqreen/rules/rule_cb.rb

@@ -70,6 +70,15 @@ module Sqreen
         if payload_tpl.include?('context')
           payload[:backtrace] = Sqreen::Context.new.bt
         end
+        if framework.respond_to?(:datadog_span) && (datadog_span = framework.datadog_span)
+          Sqreen::Weave.logger.debug { "attack datadog:true span_id:#{datadog_span.span_id} parent_id:#{datadog_span.parent_id} trace_id:#{datadog_span.trace_id}" }
+          payload.merge!(
+            :datadog_trace_id => datadog_span.trace_id,
+            :datadog_span_id => datadog_span.span_id,
+          )
+          datadog_span.set_tag(Datadog::Ext::ManualTracing::TAG_KEEP, true)
+          datadog_span.set_tag('sqreen.event', true)
+        end
         framework.observe(:attacks, payload, payload_tpl)
       end
 

data/lib/sqreen/rules/waf_cb.rb

@@ -146,7 +146,7 @@ module Sqreen
             error_code: ERROR_CODES[e.error],
           }.tap do |r|
             r[:error_data] = e.data if e.data
-            r[:args] = e.args if e.arg
+            r[:args] = e.args if e.args
           end,
         }
       end

data/lib/sqreen/signals/conversions.rb

@@ -44,11 +44,17 @@ module Sqreen
         # XXX: not used because we don't use Sqreen::Attack
         def convert_attack(attack)
           # no need to set actor/context as we only include them in request records/traces
+          location_h = {}
+          location_h.merge!(stack_trace: attack.backtrace) if attack.backtrace
+          location_h.merge!(datadog_trace_id: datadog_trace_id) if attack.datadog_trace_id
+          location_h.merge!(datadog_span_id: datadog_span_id) if attack.datadog_span_id
+          location = Kit::Signals::Location.new(location_h) unless location_h.empty?
+
           Kit::Signals::Specialized::Attack.new(
             signal_name: "sq.agent.attack.#{attack.attack_type}",
             source: "sqreen:rule:#{attack.rulespack_id}:#{attack.rule_name}",
             time: attack.time,
-            location: Kit::Signals::Location.new(stack_trace: attack.backtrace),
+            location: location,
             payload: Kit::Signals::Specialized::Attack::Payload.new(
               test: attack.test?,
               block: attack.block?,
@@ -59,11 +65,17 @@ module Sqreen
 
         # see Sqreen::Rules::RuleCB.record_event
         def convert_unstructured_attack(payload)
+          location_h = {}
+          location_h.merge!(stack_trace: payload[:backtrace]) if payload[:backtrace]
+          location_h.merge!(datadog_trace_id: payload[:datadog_trace_id]) if payload[:datadog_span_id]
+          location_h.merge!(datadog_span_id: payload[:datadog_span_id]) if payload[:datadog_span_id]
+          location = Kit::Signals::Location.new(location_h) unless location_h.empty?
+
           Kit::Signals::Specialized::Attack.new(
             signal_name: "sq.agent.attack.#{payload[:attack_type]}",
             source: "sqreen:rule:#{payload[:rulespack_id]}:#{payload[:rule_name]}",
             time: payload[:time],
-            location: (Kit::Signals::Location.new(stack_trace: payload[:backtrace]) if payload[:backtrace]),
+            location: location,
             payload: Kit::Signals::Specialized::Attack::Payload.new(
               test: payload[:test],
               block: payload[:block],
@@ -185,12 +197,13 @@ module Sqreen
         # see Sqreen::RequestRecord.processed_sdk_calls
         def convert_track(call_info)
           options = call_info[:args][1] || {}
+          args = options[:args] || {}
           Kit::Signals::Specialized::SdkTrackCall.new(
             signal_name: "sq.sdk.#{call_info[:args][0]}",
             time: call_info[:time],
             payload: Kit::Signals::Specialized::SdkTrackCall::Payload.new(
-              properties: options[:properties],
-              user_identifiers: options[:user_identifiers]
+              properties: args[:properties],
+              user_identifiers: args[:user_identifiers]
             )
           )
         end
@@ -234,6 +247,9 @@ module Sqreen
               status: resp_payload[:status],
               content_length: resp_payload[:content_length],
               content_type: resp_payload[:content_type],
+              # datadog
+              datadog_trace_id: req_payload[:datadog_trace_id],
+              datadog_span_id: req_payload[:datadog_span_id],
             }
           )
         end

data/lib/sqreen/version.rb

@@ -4,5 +4,5 @@
 # Please refer to our terms for more information: https://www.sqreen.com/terms.html
 
 module Sqreen
-  VERSION = '1.23.2'.freeze
+  VERSION = '1.24.3'.freeze
 end

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

@@ -244,6 +244,9 @@ class Sqreen::Weave::Legacy::Instrumentation
 
         # shrinkwrap_timer = Sqreen::Graft::Timer.new('weave,shrinkwrap')
         # shrinkwrap_timer.start
+        if defined?(Datadog) && Datadog.tracer && (datadog_span = Datadog.tracer.active_root_span)
+          Sqreen::Weave.logger.debug { "request datadog:true span_id:#{datadog_span.span_id} parent_id:#{datadog_span.parent_id} trace_id:#{datadog_span.trace_id}" }
+        end
 
         request_timer = Sqreen::Graft::Timer.new("request")
         request_timer.start
@@ -269,6 +272,7 @@ class Sqreen::Weave::Legacy::Instrumentation
           timed_level: timed_level,
           skipped_callbacks: [],
           # timed_shrinkwrap: shrinkwrap_timer,
+          datadog_span: datadog_span,
         }
 
         # shrinkwrap_timer.stop

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sqreen
 version: !ruby/object:Gem::Version
-  version: 1.23.2
+  version: 1.24.3
 platform: ruby
 authors:
 - Sqreen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-29 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqreen-backport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: sq_mini_racer
   requirement: !ruby/object:Gem::Requirement
@@ -47,7 +47,7 @@ dependencies:
         version: '0.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.4.a
+        version: 0.5.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -57,7 +57,7 @@ dependencies:
         version: '0.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.4.a
+        version: 0.5.a
 - !ruby/object:Gem::Dependency
   name: libsqreen
   requirement: !ruby/object:Gem::Requirement
@@ -354,7 +354,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.26
 signing_key:
 specification_version: 4
 summary: Sqreen Ruby agent