libddwaf 1.10.0.0.0 → 1.11.0.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 856059b09f92992e36ec1bff0fa9587ec9a2fa242bb525a2ca2f8cc4b31da6ee
-  data.tar.gz: 59b33db57f599533d86db3149285986618400904ba4733a3d31aad64f22f40ef
+  metadata.gz: a81f6cc78531db0b34041a7d24f0cc782554124bbccd05340bcdc940686fc016
+  data.tar.gz: 7c92e8bc95465d9bf326648483d2d7a60ceec7629bd842deaf1f36cfc355f0aa
 SHA512:
-  metadata.gz: 5112da5879361ddc0b7a52d8d7d09fd1c8ea69c4aebd8385a524f563e5bb1750395eb5cab57cfacee428baf7691e7d8445a8328ae88238fe9e1b1cf3264e2a0f
-  data.tar.gz: 1a1cf2c96a16e34a3795fc67fb31de6f06c8babd9a912e6e208a85b638edbbf02ec435f1b7f389af207c3641355068d789146aaf03850a01af3709cae0d8c1cb
+  metadata.gz: 38691a5c6731218f61e9f384126d01210b7e5fcbb5de075c91efceb5da0403056720a5c3026baad76820c31ff1f4f30bfde949f022110ee2681427ed9c842b58
+  data.tar.gz: 1ccfcc3eedbd47a72add509225f9337c5ab930e33591bdee5423854e716ea97189e64b32ce2df5a163257a604500cce51d9c3ced226fdc7efcc5cf814548b491

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 2023-08-29 v.1.11.0.0.0
+
+- Update to libddwaf 1.11.0
+- Rename Handle#ruleset_info to Handle#diagnostics. (Breaking change)
+  The schema of the new diagnostics variable can be [here](https://github.com/DataDog/libddwaf/blob/master/schema/diagnostics.json)
+
+
+# 2023-08-28 v.1.10.0.0.0
+
+- Update to libddwaf 1.10.0
+
 # 2023-06-13 v.1.9.0.0.1
 
 - Handle invalid encoding

data/lib/datadog/appsec/waf/version.rb

@@ -2,7 +2,7 @@ module Datadog
   module AppSec
     module WAF
       module VERSION
-        BASE_STRING = '1.10.0'
+        BASE_STRING = '1.11.0'
         STRING = "#{BASE_STRING}.0.0"
         MINIMUM_RUBY_VERSION = '2.1'
       end

data/lib/datadog/appsec/waf.rb

@@ -8,10 +8,10 @@ module Datadog
     module WAF
       module LibDDWAF
         class Error < StandardError
-          attr_reader :ruleset_info
+          attr_reader :diagnostics
 
-          def initialize(msg, ruleset_info: nil)
-            @ruleset_info = ruleset_info
+          def initialize(msg, diagnostics: nil)
+            @diagnostics = diagnostics
           end
         end
 
@@ -216,20 +216,8 @@ module Datadog
 
         typedef Config.by_ref, :ddwaf_config
 
-        class RuleSetInfo < ::FFI::Struct
-          layout :loaded, :uint16,
-                 :failed, :uint16,
-                 :errors, Object,
-                 :version, :string
-        end
-
-        typedef RuleSetInfo.by_ref, :ddwaf_ruleset_info
-        RuleSetInfoNone = Datadog::AppSec::WAF::LibDDWAF::RuleSetInfo.new(::FFI::Pointer::NULL)
-
-        attach_function :ddwaf_ruleset_info_free, [:ddwaf_ruleset_info], :void
-
-        attach_function :ddwaf_init, [:ddwaf_rule, :ddwaf_config, :ddwaf_ruleset_info], :ddwaf_handle
-        attach_function :ddwaf_update, [:ddwaf_handle, :ddwaf_object, :ddwaf_ruleset_info], :ddwaf_handle
+        attach_function :ddwaf_init, [:ddwaf_rule, :ddwaf_config, :ddwaf_object], :ddwaf_handle
+        attach_function :ddwaf_update, [:ddwaf_handle, :ddwaf_object, :ddwaf_object], :ddwaf_handle
         attach_function :ddwaf_destroy, [:ddwaf_handle], :void
 
         attach_function :ddwaf_required_addresses, [:ddwaf_handle, UInt32Ptr], :charptrptr
@@ -250,15 +238,10 @@ module Datadog
         attach_function :ddwaf_context_init, [:ddwaf_handle], :ddwaf_context
         attach_function :ddwaf_context_destroy, [:ddwaf_context], :void
 
-        class ResultActions < ::FFI::Struct
-          layout :array, :charptrptr,
-                 :size,  :uint32
-        end
-
         class Result < ::FFI::Struct
-          layout :timeout,          :bool,
-                 :data,             :string,
-                 :actions,          ResultActions,
+          layout :timeout, :bool,
+                 :events, Object,
+                 :actions,          Object,
                  :total_runtime,    :uint64
         end
 
@@ -479,7 +462,7 @@ module Datadog
       }
 
       class Handle
-        attr_reader :handle_obj, :ruleset_info, :config
+        attr_reader :handle_obj, :diagnostics, :config
 
         def initialize(rule, limits: {}, obfuscator: {})
           rule_obj = Datadog::AppSec::WAF.ruby_to_object(rule)
@@ -501,24 +484,19 @@ module Datadog
 
           @config = config_obj
 
-          ruleset_info = LibDDWAF::RuleSetInfo.new
+          diagnostics_obj = Datadog::AppSec::WAF::LibDDWAF::Object.new
 
-          @handle_obj = Datadog::AppSec::WAF::LibDDWAF.ddwaf_init(rule_obj, config_obj, ruleset_info)
+          @handle_obj = Datadog::AppSec::WAF::LibDDWAF.ddwaf_init(rule_obj, config_obj, diagnostics_obj)
 
-          @ruleset_info = {
-            loaded: ruleset_info[:loaded],
-            failed: ruleset_info[:failed],
-            errors: WAF.object_to_ruby(ruleset_info[:errors]),
-            version: ruleset_info[:version],
-          }
+          @diagnostics = Datadog::AppSec::WAF.object_to_ruby(diagnostics_obj)
 
           if @handle_obj.null?
-            fail LibDDWAF::Error.new('Could not create handle', ruleset_info: @ruleset_info)
+            fail LibDDWAF::Error.new('Could not create handle', diagnostics: @diagnostics)
           end
 
           validate!
         ensure
-          Datadog::AppSec::WAF::LibDDWAF.ddwaf_ruleset_info_free(ruleset_info) if ruleset_info
+          Datadog::AppSec::WAF::LibDDWAF.ddwaf_object_free(diagnostics_obj) if diagnostics_obj
           Datadog::AppSec::WAF::LibDDWAF.ddwaf_object_free(rule_obj) if rule_obj
         end
 
@@ -541,29 +519,24 @@ module Datadog
 
         def merge(data)
           data_obj = Datadog::AppSec::WAF.ruby_to_object(data, coerce: false)
-          ruleset_info = LibDDWAF::RuleSetInfo.new
-          new_handle = Datadog::AppSec::WAF::LibDDWAF.ddwaf_update(handle_obj, data_obj, ruleset_info)
+          diagnostics_obj = LibDDWAF::Object.new
+          new_handle = Datadog::AppSec::WAF::LibDDWAF.ddwaf_update(handle_obj, data_obj, diagnostics_obj)
 
           return if new_handle.null?
 
-          info = {
-            loaded: ruleset_info[:loaded],
-            failed: ruleset_info[:failed],
-            errors: WAF.object_to_ruby(ruleset_info[:errors]),
-            version: ruleset_info[:version],
-          }
-          new_from_handle(new_handle, info, config)
+          diagnostics = Datadog::AppSec::WAF.object_to_ruby(diagnostics_obj)
+          new_from_handle(new_handle, diagnostics, config)
         ensure
           Datadog::AppSec::WAF::LibDDWAF.ddwaf_object_free(data_obj) if data_obj
-          Datadog::AppSec::WAF::LibDDWAF.ddwaf_ruleset_info_free(ruleset_info) if ruleset_info
+          Datadog::AppSec::WAF::LibDDWAF.ddwaf_object_free(diagnostics_obj) if diagnostics_obj
         end
 
         private
 
-        def new_from_handle(handle_object, info, config)
+        def new_from_handle(handle_object, diagnostics, config)
           obj = self.class.allocate
           obj.instance_variable_set(:@handle_obj, handle_object)
-          obj.instance_variable_set(:@ruleset_info, info)
+          obj.instance_variable_set(:@diagnostics, diagnostics)
           obj.instance_variable_set(:@config, config)
           obj
         end
@@ -588,11 +561,11 @@ module Datadog
       end
 
       class Result
-        attr_reader :status, :data, :total_runtime, :timeout, :actions
+        attr_reader :status, :events, :total_runtime, :timeout, :actions
 
-        def initialize(status, data, total_runtime, timeout, actions)
+        def initialize(status, events, total_runtime, timeout, actions)
           @status = status
-          @data = data
+          @events = events
           @total_runtime = total_runtime
           @timeout = timeout
           @actions = actions
@@ -651,18 +624,12 @@ module Datadog
 
           code = Datadog::AppSec::WAF::LibDDWAF.ddwaf_run(@context_obj, input_obj, result_obj, timeout)
 
-          actions = if result_obj[:actions][:size] > 0
-                      result_obj[:actions][:array].get_array_of_string(0, result_obj[:actions][:size])
-                    else
-                      []
-                    end
-
           result = Result.new(
             RESULT_CODE[code],
-            (JSON.parse(result_obj[:data]) if result_obj[:data] != nil),
+            Datadog::AppSec::WAF.object_to_ruby(result_obj[:events]),
             result_obj[:total_runtime],
             result_obj[:timeout],
-            actions,
+            Datadog::AppSec::WAF.object_to_ruby(result_obj[:actions]),
           )
 
           [RESULT_CODE[code], result]

data/sig/datadog/appsec/waf.rbs

@@ -3,9 +3,9 @@ module Datadog
     module WAF
       module LibDDWAF
         class Error < StandardError
-          attr_reader ruleset_info: Hash[Symbol, untyped] | nil
+          attr_reader diagnostics: ::Datadog::AppSec::WAF::data
 
-          def initialize: (::String msg, ?ruleset_info: Hash[Symbol, untyped]?) -> void
+          def initialize: (::String msg, ?diagnostics: ::Datadog::AppSec::WAF::data?) -> void
         end
 
         extend ::FFI::Library
@@ -93,15 +93,8 @@ module Datadog
           end
         end
 
-        class RuleSetInfo < ::FFI::Struct
-        end
-
-        RuleSetInfoNone: ::Datadog::AppSec::WAF::LibDDWAF::RuleSetInfo
-
-        def self.ddwaf_ruleset_info_free: (RuleSetInfo) -> void
-
-        def self.ddwaf_init: (top, Config, RuleSetInfo) -> ::FFI::Pointer
-        def self.ddwaf_update: (::FFI::Pointer, LibDDWAF::Object, RuleSetInfo) -> ::FFI::Pointer
+        def self.ddwaf_init: (top, Config, Object) -> ::FFI::Pointer
+        def self.ddwaf_update: (::FFI::Pointer, LibDDWAF::Object, LibDDWAF::Object) -> ::FFI::Pointer
         def self.ddwaf_destroy: (::FFI::Pointer) -> void
 
         def self.ddwaf_required_addresses: (::FFI::Pointer, UInt32Ptr) -> ::FFI::Pointer
@@ -116,9 +109,6 @@ module Datadog
         def self.ddwaf_context_init: (::FFI::Pointer) -> ::FFI::Pointer
         def self.ddwaf_context_destroy: (::FFI::Pointer) -> void
 
-        class ResultActions < ::FFI::Struct
-        end
-
         class Result < ::FFI::Struct
         end
 
@@ -165,35 +155,33 @@ module Datadog
 
       class Handle
         attr_reader handle_obj: ::FFI::Pointer
-        attr_reader ruleset_info: Hash[Symbol, untyped]
+        attr_reader diagnostics: data
         attr_reader config: WAF::LibDDWAF::Config
 
         def initialize: (data rule, ?limits: ::Hash[::Symbol, ::Integer], ?obfuscator: ::Hash[::Symbol, ::String]) -> void
         def finalize: () -> untyped
         def required_addresses: () -> ::Array[::String]
-        def update: (untyped data) -> Handle
+        def merge: (untyped data) -> Handle?
 
         private
 
         @valid: bool
 
-        def new_from_handle: (::FFI::Pointer handle_object, Hash[Symbol, untyped] info, WAF::LibDDWAF::Config config) -> untyped
+        def new_from_handle: (::FFI::Pointer handle_object, data diagnostics, WAF::LibDDWAF::Config config) -> untyped
         def validate!: () -> void
         def invalidate!: () -> void
         def valid?: () -> (nil | bool)
         def valid!: () -> void
       end
 
-      type result_data = Array[untyped] | nil
-
       class Result
         attr_reader status: ::Symbol
-        attr_reader data: untyped
+        attr_reader events: data
         attr_reader total_runtime: ::Float
         attr_reader timeout: bool
-        attr_reader actions: ::Array[::String]
+        attr_reader actions: data
 
-        def initialize: (::Symbol, result_data, ::Float, bool, ::Array[::String]) -> void
+        def initialize: (::Symbol, data, ::Float, bool, data) -> void
       end
 
       class Context

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libddwaf
 version: !ruby/object:Gem::Version
-  version: 1.10.0.0.0
+  version: 1.11.0.0.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-28 00:00:00.000000000 Z
+date: 2023-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi