libddwaf 1.11.0.0.0-x86_64-darwin → 1.15.0.0.0-x86_64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 460e66f7b47fca4c5a4a1ccd22635bc909e5cef0ce7a26f2c23d0b412b0dd8cf
-  data.tar.gz: 4d9d11f1070b7c88ae46e8c2829790c1a744eda31dcd75f966f74795a7afa996
+  metadata.gz: 26e9c30c64c17dadaf151952274176eba80afc229414c86f3238ad24afdda544
+  data.tar.gz: fc3a62ec48b051976e906be1601454c73ab1837d8d34da5e064918460d73d09c
 SHA512:
-  metadata.gz: 610cd7b48739f610f0a66e76c50c570e7e3dc897b5575230ba8408787d821abc2af3b8f97ff601532f87c5d7e6db9995e67ca3ca0994550668b75ca98c0c1905
-  data.tar.gz: ce46fcb2a4c54ae66cba44a2df01130e2a01613958d482f3b8d75680eeae217fd0a1d4349bfa07d9f716271681db066754a9324d36235776a89bb4a251e29fe1
+  metadata.gz: 7e6c8ca17a61d6fc510a51395d928c71de20c450b9f5e94d5527254a27694db88cf9f4b51e4a350b915eed4dc85568df3ee40c04ed42a901e096a8ae5a3213b7
+  data.tar.gz: a20214a14796aa625d453306784268ed27cfde51d17c2298361aede980d37ba3ad239d1afbb8b5e53fe4308e0867dca0156bc806498cc5b972d64a1cb26780c1

data/CHANGELOG.md

@@ -1,8 +1,19 @@
+# 2024-10-29 v.1.15.0.0.0
+- Update to libddwaf 1.15.0
+- Changed `Datadog::AppSec::WAF::Context#run` interface to accommodate ephemeral data ([Breaking change](https://github.com/DataDog/libddwaf/blob/master/CHANGELOG.md#v1150-unstable))
+
+# 2023-09-11 v.1.14.0.0.0
+- Update to libddwaf 1.14.0
+- Add support for `Float` and `Nil` scalar values when converting from ruby to WAF Object and vice versa.
+
+
 # 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)
+- Changed `Datadog::AppSec::WAF::Handle#ruleset_info` to `Datadog::AppSec::WAF::Handle#diagnostics`. (Breaking change)
+  The schema of the diagnostics variable can be found [here](https://github.com/DataDog/libddwaf/blob/master/schema/diagnostics.json)
+- Changed `Datadog::AppSec::WAF::Result#data` to `Datadog::AppSec::WAF::Result#events`. (Breaking change)
+  The schema of the events variable can be found [here](https://github.com/DataDog/libddwaf/blob/master/schema/events.json)
 
 
 # 2023-08-28 v.1.10.0.0.0

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

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

data/lib/datadog/appsec/waf.rb

@@ -111,7 +111,10 @@ module Datadog
                               :ddwaf_obj_string,   1 << 2,
                               :ddwaf_obj_array,    1 << 3,
                               :ddwaf_obj_map,      1 << 4,
-                              :ddwaf_obj_bool,     1 << 5
+                              :ddwaf_obj_bool,     1 << 5,
+                              :ddwaf_obj_float,    1 << 6,
+                              :ddwaf_obj_null,     1 << 7
+
         typedef DDWAF_OBJ_TYPE, :ddwaf_obj_type
 
         typedef :pointer, :charptr
@@ -140,7 +143,8 @@ module Datadog
                  :uintValue,   :uint64,
                  :intValue,    :int64,
                  :array,       :pointer,
-                 :boolean,     :bool
+                 :boolean,     :bool,
+                 :f64,         :double
         end
 
         class Object < ::FFI::Struct
@@ -159,11 +163,13 @@ module Datadog
         attach_function :ddwaf_object_string, [:ddwaf_object, :string], :ddwaf_object
         attach_function :ddwaf_object_stringl, [:ddwaf_object, :charptr, :size_t], :ddwaf_object
         attach_function :ddwaf_object_stringl_nc, [:ddwaf_object, :charptr, :size_t], :ddwaf_object
+        attach_function :ddwaf_object_string_from_unsigned, [:ddwaf_object, :uint64], :ddwaf_object
+        attach_function :ddwaf_object_string_from_signed, [:ddwaf_object, :int64], :ddwaf_object
         attach_function :ddwaf_object_unsigned, [:ddwaf_object, :uint64], :ddwaf_object
         attach_function :ddwaf_object_signed, [:ddwaf_object, :int64], :ddwaf_object
-        attach_function :ddwaf_object_unsigned_force, [:ddwaf_object, :uint64], :ddwaf_object
-        attach_function :ddwaf_object_signed_force, [:ddwaf_object, :int64], :ddwaf_object
         attach_function :ddwaf_object_bool, [:ddwaf_object, :bool], :ddwaf_object
+        attach_function :ddwaf_object_null, [:ddwaf_object], :ddwaf_object
+        attach_function :ddwaf_object_float, [:ddwaf_object, :double], :ddwaf_object
 
         attach_function :ddwaf_object_array, [:ddwaf_object], :ddwaf_object
         attach_function :ddwaf_object_array_add, [:ddwaf_object, :ddwaf_object], :bool
@@ -184,6 +190,7 @@ module Datadog
         attach_function :ddwaf_object_get_signed, [:ddwaf_object], :int64
         attach_function :ddwaf_object_get_index, [:ddwaf_object, :size_t], :ddwaf_object
         attach_function :ddwaf_object_get_bool, [:ddwaf_object], :bool
+        attach_function :ddwaf_object_get_float, [:ddwaf_object], :double
 
         ## freeers
 
@@ -220,7 +227,7 @@ module Datadog
         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
+        attach_function :ddwaf_known_addresses, [:ddwaf_handle, UInt32Ptr], :charptrptr
 
         # updating
 
@@ -239,16 +246,17 @@ module Datadog
         attach_function :ddwaf_context_destroy, [:ddwaf_context], :void
 
         class Result < ::FFI::Struct
-          layout :timeout, :bool,
-                 :events, Object,
-                 :actions,          Object,
-                 :total_runtime,    :uint64
+          layout :timeout,       :bool,
+                 :events,        Object,
+                 :actions,       Object,
+                 :derivatives,   Object,
+                 :total_runtime, :uint64
         end
 
         typedef Result.by_ref, :ddwaf_result
         typedef :uint64, :timeout_us
 
-        attach_function :ddwaf_run, [:ddwaf_context, :ddwaf_object, :ddwaf_result, :timeout_us], :ddwaf_ret_code, blocking: true
+        attach_function :ddwaf_run, [:ddwaf_context, :ddwaf_object, :ddwaf_object, :ddwaf_result, :timeout_us], :ddwaf_ret_code, blocking: true
         attach_function :ddwaf_result_free, [:ddwaf_result], :void
 
         # logging
@@ -280,7 +288,7 @@ module Datadog
         LibDDWAF.ddwaf_get_version
       end
 
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       def self.ruby_to_object(val, max_container_size: nil, max_container_depth: nil, max_string_length: nil, coerce: true)
         case val
         when Array
@@ -358,9 +366,9 @@ module Datadog
           res = if coerce
                   LibDDWAF.ddwaf_object_string(obj, val.to_s)
                 elsif val < 0
-                  LibDDWAF.ddwaf_object_signed_force(obj, val)
+                  LibDDWAF.ddwaf_object_signed(obj, val)
                 else
-                  LibDDWAF.ddwaf_object_unsigned_force(obj, val)
+                  LibDDWAF.ddwaf_object_unsigned(obj, val)
                 end
           if res.null?
             fail LibDDWAF::Error, "Could not convert into object: #{val.inspect}"
@@ -369,7 +377,11 @@ module Datadog
           obj
         when Float
           obj = LibDDWAF::Object.new
-          res = LibDDWAF.ddwaf_object_string(obj, val.to_s)
+          res = if coerce
+                  LibDDWAF.ddwaf_object_string(obj, val.to_s)
+                else
+                  LibDDWAF.ddwaf_object_float(obj, val)
+                end
           if res.null?
             fail LibDDWAF::Error, "Could not convert into object: #{val.inspect}"
           end
@@ -386,16 +398,28 @@ module Datadog
             fail LibDDWAF::Error, "Could not convert into object: #{val.inspect}"
           end
 
+          obj
+        when NilClass
+          obj = LibDDWAF::Object.new
+          res = if coerce
+                  LibDDWAF.ddwaf_object_string(obj, '')
+                else
+                  LibDDWAF.ddwaf_object_null(obj)
+                end
+          if res.null?
+            fail LibDDWAF::Error, "Could not convert into object: #{val.inspect}"
+          end
+
           obj
         else
           ruby_to_object(''.freeze)
         end
       end
-      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
 
       def self.object_to_ruby(obj)
         case obj[:type]
-        when :ddwaf_obj_invalid
+        when :ddwaf_obj_invalid, :ddwaf_obj_null
           nil
         when :ddwaf_obj_bool
           obj[:valueUnion][:boolean]
@@ -405,11 +429,13 @@ module Datadog
           obj[:valueUnion][:intValue]
         when :ddwaf_obj_unsigned
           obj[:valueUnion][:uintValue]
+        when :ddwaf_obj_float
+          obj[:valueUnion][:f64]
         when :ddwaf_obj_array
           (0...obj[:nbEntries]).each.with_object([]) do |i, a|
             ptr = obj[:valueUnion][:array] + i * LibDDWAF::Object.size
             e = object_to_ruby(LibDDWAF::Object.new(ptr))
-            a << e
+            a << e # steep:ignore
           end
         when :ddwaf_obj_map
           (0...obj[:nbEntries]).each.with_object({}) do |i, h|
@@ -418,7 +444,7 @@ module Datadog
             l = o[:parameterNameLength]
             k = o[:parameterName].read_bytes(l)
             v = object_to_ruby(LibDDWAF::Object.new(ptr))
-            h[k] = v
+            h[k] = v # steep:ignore
           end
         end
       end
@@ -510,7 +536,7 @@ module Datadog
           valid!
 
           count = Datadog::AppSec::WAF::LibDDWAF::UInt32Ptr.new
-          list = Datadog::AppSec::WAF::LibDDWAF.ddwaf_required_addresses(handle_obj, count)
+          list = Datadog::AppSec::WAF::LibDDWAF.ddwaf_known_addresses(handle_obj, count)
 
           return [] if count == 0 # list is null
 
@@ -561,14 +587,15 @@ module Datadog
       end
 
       class Result
-        attr_reader :status, :events, :total_runtime, :timeout, :actions
+        attr_reader :status, :events, :total_runtime, :timeout, :actions, :derivatives
 
-        def initialize(status, events, total_runtime, timeout, actions)
+        def initialize(status, events, total_runtime, timeout, actions, derivatives)
           @status = status
           @events = events
           @total_runtime = total_runtime
           @timeout = timeout
           @actions = actions
+          @derivatives = derivatives
         end
       end
 
@@ -599,19 +626,32 @@ module Datadog
           Datadog::AppSec::WAF::LibDDWAF.ddwaf_context_destroy(context_obj)
         end
 
-        def run(input, timeout = LibDDWAF::DDWAF_RUN_TIMEOUT)
+        def run(persistent_data, ephemeral_data, timeout = LibDDWAF::DDWAF_RUN_TIMEOUT)
           valid!
 
-          max_container_size  = LibDDWAF::DDWAF_MAX_CONTAINER_SIZE
-          max_container_depth = LibDDWAF::DDWAF_MAX_CONTAINER_DEPTH
-          max_string_length   = LibDDWAF::DDWAF_MAX_STRING_LENGTH
+          persistent_data_obj = Datadog::AppSec::WAF.ruby_to_object(
+            persistent_data,
+            max_container_size: LibDDWAF::DDWAF_MAX_CONTAINER_SIZE,
+            max_container_depth: LibDDWAF::DDWAF_MAX_CONTAINER_DEPTH,
+            max_string_length: LibDDWAF::DDWAF_MAX_STRING_LENGTH,
+            coerce: false
+          )
+          if persistent_data_obj.null?
+            fail LibDDWAF::Error, "Could not convert persistent data: #{persistent_data.inspect}"
+          end
 
-          input_obj = Datadog::AppSec::WAF.ruby_to_object(input,
-                                                          max_container_size: max_container_size,
-                                                          max_container_depth: max_container_depth,
-                                                          max_string_length: max_string_length)
-          if input_obj.null?
-            fail LibDDWAF::Error, "Could not convert input: #{input.inspect}"
+          # retain C objects in memory for subsequent calls to run
+          retain(persistent_data_obj)
+
+          ephemeral_data_obj = Datadog::AppSec::WAF.ruby_to_object(
+            ephemeral_data,
+            max_container_size: LibDDWAF::DDWAF_MAX_CONTAINER_SIZE,
+            max_container_depth: LibDDWAF::DDWAF_MAX_CONTAINER_DEPTH,
+            max_string_length: LibDDWAF::DDWAF_MAX_STRING_LENGTH,
+            coerce: false
+          )
+          if ephemeral_data_obj.null?
+            fail LibDDWAF::Error, "Could not convert ephemeral data: #{ephemeral_data.inspect}"
           end
 
           result_obj = Datadog::AppSec::WAF::LibDDWAF::Result.new
@@ -619,10 +659,7 @@ module Datadog
             fail LibDDWAF::Error, "Could not create result object"
           end
 
-          # retain C objects in memory for subsequent calls to run
-          retain(input_obj)
-
-          code = Datadog::AppSec::WAF::LibDDWAF.ddwaf_run(@context_obj, input_obj, result_obj, timeout)
+          code = Datadog::AppSec::WAF::LibDDWAF.ddwaf_run(@context_obj, persistent_data_obj, ephemeral_data_obj, result_obj, timeout)
 
           result = Result.new(
             RESULT_CODE[code],
@@ -630,6 +667,7 @@ module Datadog
             result_obj[:total_runtime],
             result_obj[:timeout],
             Datadog::AppSec::WAF.object_to_ruby(result_obj[:actions]),
+            Datadog::AppSec::WAF.object_to_ruby(result_obj[:derivatives]),
           )
 
           [RESULT_CODE[code], result]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libddwaf
 version: !ruby/object:Gem::Version
-  version: 1.11.0.0.0
+  version: 1.15.0.0.0
 platform: x86_64-darwin
 authors:
 - Datadog, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-29 00:00:00.000000000 Z
+date: 2024-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -42,7 +42,7 @@ files:
 - lib/datadog/appsec/waf.rb
 - lib/datadog/appsec/waf/version.rb
 - lib/libddwaf.rb
-- vendor/libddwaf/libddwaf-1.11.0-darwin-x86_64/lib/libddwaf.dylib
+- vendor/libddwaf/libddwaf-1.15.0-darwin-x86_64/lib/libddwaf.dylib
 homepage: https://github.com/DataDog/libddwaf-rb
 licenses:
 - BSD-3-Clause
@@ -56,14 +56,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: Datadog WAF