libddwaf 1.5.1.0.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1054077e5a63048aa75da4146cb795e14c7195ec5da4287d91408b04016c23f2
+  data.tar.gz: f149053d529ce5b711431d78aec9692feba59efbf7ce96da341ca4a02a0b4a3c
+SHA512:
+  metadata.gz: 6c0cd009021993f6ed49586425e7619b906c8b1c2361174569a60b19bfd5ba01daf7e078eadbabaca8c8264c48b77689dda9cbef7cf38b5cd4c81d6c25912857
+  data.tar.gz: adef30898cc0e609f7847462aa768311ed626223ad603fa8e2dd8d94f01383b36fc8e19323f9df54c30a7cd51a0334f1e4319728d8963ee56d34ec6fbf730861

data/CHANGELOG.md

@@ -0,0 +1,74 @@
+# 2022-10-04 v1.5.1.0.0
+
+- Update to libddwaf 1.5.1
+- Add live rule data update API
+- Add live rule toggle API
+- Add libddwaf boolean type support
+- Add Ruby to libddwaf object conversion limits
+- Add Ruby to libddwaf object converter optional coercion of scalars to string
+- Add static type checking via RBS+Steep
+- Change version to return a string
+- Change free function to be passed as config instead of context init argument
+- Change result to include action list
+- Change return code from action to status
+- Change handle and context freeing model from GC-based to explicit
+- Fix double-free upon finalization of retained C objects
+- Fix context crash by retaining necessary C objects
+
+# 2022-05-20 v1.3.0.2.0
+
+- Fix multibyte string handling
+- Support JRuby
+
+# 2022-04-29 v1.3.0.1.0
+
+Promotion of v1.3.0.1.0.beta1 to stable
+
+# 2022-04-25 v1.3.0.1.0.beta1
+
+- Add obfuscator configuration
+- Add nested object limit configuration
+- Add report ruleset information
+
+# 2022-04-29 v1.3.0.0.0
+
+- Promote v1.3.0.0.0.beta1 to stable
+
+# 2022-04-20 v1.3.0.0.0.beta1
+
+- Update to libddwaf 1.3.0
+
+# 2022-03-18 v1.2.1.0.0.beta1
+
+- Update to libddwaf 1.2.1
+- Fix incorrect types for a few binding functions
+
+# 2022-03-04 v1.0.14.2.1.beta1
+
+- Fix incorrect return code
+- Fix passing nil in libddwaf object containers
+
+# 2022-02-07 v1.0.14.2.0.beta1
+
+- Change Datadog::Security to Datadog::AppSec
+
+# 2022-02-01 v1.0.14.1.0.beta2
+
+- Add support for Ruby 3.1
+
+# 2021-12-14 v1.0.14.1.0.beta1
+
+- Fix sequential runs on a single context by retaining C input data objects
+
+# 2021-11-24 v1.0.14.0.0.beta1
+
+- Update to libddwaf 1.0.14
+
+# 2021-11-24 v1.0.13.0.0.beta1
+
+- Add ruby platform fallback for unsupported platforms
+- Update to libddwaf 1.0.13
+
+# 2021-10-13 v1.0.12.0.0.beta1
+
+- Initial release

data/LICENSE

@@ -0,0 +1,6 @@
+## License
+
+This work is dual-licensed under Apache 2.0 or BSD3.
+You may select, at your option, one of the above-listed licenses.
+
+`SPDX-License-Identifier: Apache-2.0 OR BSD-3-Clause`

data/LICENSE-3rdparty.csv

@@ -0,0 +1,2 @@
+Component,Origin,License,Copyright
+core,https://github.com/ffi/ffi,BSD-3-Clause,"Copyright (c) 2008-2016, Ruby FFI project contributors"

data/LICENSE.Apache

@@ -0,0 +1,200 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2021 Datadog, Inc.
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/LICENSE.BSD3

@@ -0,0 +1,24 @@
+Copyright (c) 2021, Datadog <info@datadoghq.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of Datadog nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/NOTICE

@@ -0,0 +1,4 @@
+Datadog libddwaf-rb
+Copyright 2021-Present Datadog, Inc.
+
+This product includes software developed at Datadog, Inc. (https://www.datadoghq.com/).

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

@@ -0,0 +1,11 @@
+module Datadog
+  module AppSec
+    module WAF
+      module VERSION
+        BASE_STRING = '1.5.1'
+        STRING = "#{BASE_STRING}.0.0"
+        MINIMUM_RUBY_VERSION = '2.1'
+      end
+    end
+  end
+end

data/lib/datadog/appsec/waf.rb

@@ -0,0 +1,703 @@
+require 'ffi'
+require 'json'
+require 'datadog/appsec/waf/version'
+
+module Datadog
+  module AppSec
+    module WAF
+      module LibDDWAF
+        class Error < StandardError
+          attr_reader :ruleset_info
+
+          def initialize(msg, ruleset_info: nil)
+            @ruleset_info = ruleset_info
+          end
+        end
+
+        extend ::FFI::Library
+
+        def self.local_os
+          if RUBY_ENGINE == 'jruby'
+            os_name = java.lang.System.get_property('os.name')
+
+            os = case os_name
+                 when /linux/i then 'linux'
+                 when /mac/i   then 'darwin'
+                 else raise Error, "unsupported JRuby os.name: #{os_name.inspect}"
+                 end
+
+            return os
+          end
+
+          Gem::Platform.local.os
+        end
+
+        def self.local_version
+          return nil unless local_os == 'linux'
+
+          # Old rubygems don't handle non-gnu linux correctly
+          return $1 if RUBY_PLATFORM =~ /linux-(.+)$/
+
+          'gnu'
+        end
+
+        def self.local_cpu
+          if RUBY_ENGINE == 'jruby'
+            os_arch = java.lang.System.get_property('os.arch')
+
+            cpu = case os_arch
+                  when 'amd64' then 'x86_64'
+                  when 'aarch64' then 'aarch64'
+                  else raise Error, "unsupported JRuby os.arch: #{os_arch.inspect}"
+                  end
+
+            return cpu
+          end
+
+          Gem::Platform.local.cpu
+        end
+
+        def self.source_dir
+          __dir__ || raise('__dir__ is nil: eval?')
+        end
+
+        def self.vendor_dir
+          File.join(source_dir, '../../../vendor')
+        end
+
+        def self.libddwaf_vendor_dir
+          File.join(vendor_dir, 'libddwaf')
+        end
+
+        def self.shared_lib_triplet(version: local_version)
+          version ? "#{local_os}-#{version}-#{local_cpu}" : "#{local_os}-#{local_cpu}"
+        end
+
+        def self.libddwaf_dir
+          default = File.join(libddwaf_vendor_dir,
+                              "libddwaf-#{Datadog::AppSec::WAF::VERSION::BASE_STRING}-#{shared_lib_triplet}")
+          candidates = [
+            default
+          ]
+
+          if local_os == 'linux'
+            candidates << File.join(libddwaf_vendor_dir,
+                                    "libddwaf-#{Datadog::AppSec::WAF::VERSION::BASE_STRING}-#{shared_lib_triplet(version: nil)}")
+          end
+
+          candidates.find { |d| Dir.exist?(d) } || default
+        end
+
+        def self.shared_lib_extname
+          Gem::Platform.local.os == 'darwin' ? '.dylib' : '.so'
+        end
+
+        def self.shared_lib_path
+          File.join(libddwaf_dir, 'lib', "libddwaf#{shared_lib_extname}")
+        end
+
+        ffi_lib [shared_lib_path]
+
+        # version
+
+        attach_function :ddwaf_get_version, [], :string
+
+        # ddwaf::object data structure
+
+        DDWAF_OBJ_TYPE = enum :ddwaf_obj_invalid,  0,
+                              :ddwaf_obj_signed,   1 << 0,
+                              :ddwaf_obj_unsigned, 1 << 1,
+                              :ddwaf_obj_string,   1 << 2,
+                              :ddwaf_obj_array,    1 << 3,
+                              :ddwaf_obj_map,      1 << 4,
+                              :ddwaf_obj_bool,     1 << 5
+        typedef DDWAF_OBJ_TYPE, :ddwaf_obj_type
+
+        typedef :pointer, :charptr
+        typedef :pointer, :charptrptr
+
+        class UInt32Ptr < ::FFI::Struct
+          layout :value, :uint32
+        end
+
+        typedef UInt32Ptr.by_ref, :uint32ptr
+
+        class UInt64Ptr < ::FFI::Struct
+          layout :value, :uint64
+        end
+
+        typedef UInt64Ptr.by_ref, :uint64ptr
+
+        class SizeTPtr < ::FFI::Struct
+          layout :value, :size_t
+        end
+
+        typedef SizeTPtr.by_ref, :sizeptr
+
+        class ObjectValueUnion < ::FFI::Union
+          layout :stringValue, :charptr,
+                 :uintValue,   :uint64,
+                 :intValue,    :int64,
+                 :array,       :pointer,
+                 :boolean,     :bool
+        end
+
+        class Object < ::FFI::Struct
+          layout :parameterName,       :charptr,
+                 :parameterNameLength, :uint64,
+                 :valueUnion,          ObjectValueUnion,
+                 :nbEntries,           :uint64,
+                 :type,                :ddwaf_obj_type
+        end
+
+        typedef Object.by_ref, :ddwaf_object
+
+        ## setters
+
+        attach_function :ddwaf_object_invalid, [:ddwaf_object], :ddwaf_object
+        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_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_array, [:ddwaf_object], :ddwaf_object
+        attach_function :ddwaf_object_array_add, [:ddwaf_object, :ddwaf_object], :bool
+
+        attach_function :ddwaf_object_map, [:ddwaf_object], :ddwaf_object
+        attach_function :ddwaf_object_map_add, [:ddwaf_object, :string, :pointer], :bool
+        attach_function :ddwaf_object_map_addl, [:ddwaf_object, :charptr, :size_t, :pointer], :bool
+        attach_function :ddwaf_object_map_addl_nc, [:ddwaf_object, :charptr, :size_t, :pointer], :bool
+
+        ## getters
+
+        attach_function :ddwaf_object_type, [:ddwaf_object], DDWAF_OBJ_TYPE
+        attach_function :ddwaf_object_size, [:ddwaf_object], :uint64
+        attach_function :ddwaf_object_length, [:ddwaf_object], :size_t
+        attach_function :ddwaf_object_get_key, [:ddwaf_object, :sizeptr], :charptr
+        attach_function :ddwaf_object_get_string, [:ddwaf_object, :sizeptr], :charptr
+        attach_function :ddwaf_object_get_unsigned, [:ddwaf_object], :uint64
+        attach_function :ddwaf_object_get_signed, [:ddwaf_object], :int64
+        attach_function :ddwaf_object_get_index, [:ddwaf_object, :size_t], :ddwaf_object
+
+        ## freeers
+
+        ObjectFree = attach_function :ddwaf_object_free, [:ddwaf_object], :void
+        ObjectNoFree = ::FFI::Pointer::NULL
+
+        # main handle
+
+        typedef :pointer, :ddwaf_handle
+        typedef Object.by_ref, :ddwaf_rule
+
+        callback :ddwaf_object_free_fn, [:ddwaf_object], :void
+
+        class Config < ::FFI::Struct
+          class Limits < ::FFI::Struct
+            layout :max_container_size,  :uint32,
+                   :max_container_depth, :uint32,
+                   :max_string_length,   :uint32
+          end
+
+          class Obfuscator < ::FFI::Struct
+            layout :key_regex,   :pointer, # :charptr
+                   :value_regex, :pointer  # :charptr
+          end
+
+          layout :limits,     Limits,
+                 :obfuscator, Obfuscator,
+                 :free_fn,    :pointer #:ddwaf_object_free_fn
+        end
+
+        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_destroy, [:ddwaf_handle], :void
+
+        attach_function :ddwaf_required_addresses, [:ddwaf_handle, UInt32Ptr], :charptrptr
+        attach_function :ddwaf_required_rule_data_ids, [:ddwaf_handle, UInt32Ptr], :charptrptr
+
+        # updating
+
+        DDWAF_RET_CODE = enum :ddwaf_err_internal,         -3,
+                              :ddwaf_err_invalid_object,   -2,
+                              :ddwaf_err_invalid_argument, -1,
+                              :ddwaf_ok,                    0,
+                              :ddwaf_match,                 1
+        typedef DDWAF_RET_CODE, :ddwaf_ret_code
+
+        attach_function :ddwaf_update_rule_data, [:ddwaf_handle, :ddwaf_object], :ddwaf_ret_code
+        attach_function :ddwaf_toggle_rules, [:ddwaf_handle, :ddwaf_object], :ddwaf_ret_code
+
+        # running
+
+        typedef :pointer, :ddwaf_context
+
+        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,
+                 :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_result_free, [:ddwaf_result], :void
+
+        # logging
+
+        DDWAF_LOG_LEVEL = enum :ddwaf_log_trace,
+                               :ddwaf_log_debug,
+                               :ddwaf_log_info,
+                               :ddwaf_log_warn,
+                               :ddwaf_log_error,
+                               :ddwaf_log_off
+        typedef DDWAF_LOG_LEVEL, :ddwaf_log_level
+
+        callback :ddwaf_log_cb, [:ddwaf_log_level, :string, :string, :uint, :charptr, :uint64], :void
+
+        attach_function :ddwaf_set_log_cb, [:ddwaf_log_cb, :ddwaf_log_level], :bool
+
+        DEFAULT_MAX_CONTAINER_SIZE  = 0
+        DEFAULT_MAX_CONTAINER_DEPTH = 0
+        DEFAULT_MAX_STRING_LENGTH   = 0
+
+        DDWAF_MAX_CONTAINER_SIZE  = 256
+        DDWAF_MAX_CONTAINER_DEPTH = 20
+        DDWAF_MAX_STRING_LENGTH   = 4096
+
+        DDWAF_RUN_TIMEOUT = 5000
+      end
+
+      def self.version
+        LibDDWAF.ddwaf_get_version
+      end
+
+      def self.ruby_to_object(val, max_container_size: nil, max_container_depth: nil, max_string_length: nil, coerce: true)
+        case val
+        when Array
+          obj = LibDDWAF::Object.new
+          res = LibDDWAF.ddwaf_object_array(obj)
+          if res.null?
+            fail LibDDWAF::Error, "Could not convert into object: #{val}"
+          end
+
+          max_index = max_container_size - 1 if max_container_size
+          val.each.with_index do |e, i|
+            member = ruby_to_object(e,
+                                    max_container_size: max_container_size,
+                                    max_container_depth: (max_container_depth - 1 if max_container_depth),
+                                    max_string_length: max_string_length,
+                                    coerce: coerce)
+            e_res = LibDDWAF.ddwaf_object_array_add(obj, member)
+            unless e_res
+              fail LibDDWAF::Error, "Could not add to array object: #{e.inspect}"
+            end
+
+            break val if max_index && i >= max_index
+          end unless max_container_depth == 0
+
+          obj
+        when Hash
+          obj = LibDDWAF::Object.new
+          res = LibDDWAF.ddwaf_object_map(obj)
+          if res.null?
+            fail LibDDWAF::Error, "Could not convert into object: #{val}"
+          end
+
+          max_index = max_container_size - 1 if max_container_size
+          val.each.with_index do |e, i|
+            k, v = e[0], e[1] # for Steep, which doesn't handle |(k, v), i|
+
+            k = k.to_s[0, max_string_length] if max_string_length
+            member = ruby_to_object(v,
+                                    max_container_size: max_container_size,
+                                    max_container_depth: (max_container_depth - 1 if max_container_depth),
+                                    max_string_length: max_string_length,
+                                    coerce: coerce)
+            kv_res = LibDDWAF.ddwaf_object_map_addl(obj, k.to_s, k.to_s.bytesize, member)
+            unless kv_res
+              fail LibDDWAF::Error, "Could not add to map object: #{k.inspect} => #{v.inspect}"
+            end
+
+            break val if max_index && i >= max_index
+          end unless max_container_depth == 0
+
+          obj
+        when String
+          obj = LibDDWAF::Object.new
+          val = val.to_s[0, max_string_length] if max_string_length
+          str = val.to_s
+          res = LibDDWAF.ddwaf_object_stringl(obj, str, str.bytesize)
+          if res.null?
+            fail LibDDWAF::Error, "Could not convert into object: #{val.inspect}"
+          end
+
+          obj
+        when Symbol
+          obj = LibDDWAF::Object.new
+          val = val.to_s[0, max_string_length] if max_string_length
+          str = val.to_s
+          res = LibDDWAF.ddwaf_object_stringl(obj, str, str.bytesize)
+          if res.null?
+            fail LibDDWAF::Error, "Could not convert into object: #{val.inspect}"
+          end
+
+          obj
+        when Integer
+          obj = LibDDWAF::Object.new
+          res = if coerce
+                  LibDDWAF.ddwaf_object_string(obj, val.to_s)
+                elsif val < 0
+                  LibDDWAF.ddwaf_object_signed_force(obj, val)
+                else
+                  LibDDWAF.ddwaf_object_unsigned_force(obj, val)
+                end
+          if res.null?
+            fail LibDDWAF::Error, "Could not convert into object: #{val.inspect}"
+          end
+
+          obj
+        when Float
+          obj = LibDDWAF::Object.new
+          res = LibDDWAF.ddwaf_object_string(obj, val.to_s)
+          if res.null?
+            fail LibDDWAF::Error, "Could not convert into object: #{val.inspect}"
+          end
+
+          obj
+        when TrueClass, FalseClass
+          obj = LibDDWAF::Object.new
+          res = if coerce
+                  LibDDWAF.ddwaf_object_string(obj, val.to_s)
+                else
+                  LibDDWAF.ddwaf_object_bool(obj, val)
+                end
+          if res.null?
+            fail LibDDWAF::Error, "Could not convert into object: #{val.inspect}"
+          end
+
+          obj
+        else
+          ruby_to_object(''.freeze)
+        end
+      end
+
+      def self.object_to_ruby(obj)
+        case obj[:type]
+        when :ddwaf_obj_invalid
+          nil
+        when :ddwaf_obj_bool
+          obj[:valueUnion][:boolean]
+        when :ddwaf_obj_string
+          obj[:valueUnion][:stringValue].read_bytes(obj[:nbEntries])
+        when :ddwaf_obj_signed
+          obj[:valueUnion][:intValue]
+        when :ddwaf_obj_unsigned
+          obj[:valueUnion][:uintValue]
+        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
+          end
+        when :ddwaf_obj_map
+          (0...obj[:nbEntries]).each.with_object({}) do |i, h|
+            ptr = obj[:valueUnion][:array] + i * Datadog::AppSec::WAF::LibDDWAF::Object.size
+            o = Datadog::AppSec::WAF::LibDDWAF::Object.new(ptr)
+            l = o[:parameterNameLength]
+            k = o[:parameterName].read_bytes(l)
+            v = object_to_ruby(LibDDWAF::Object.new(ptr))
+            h[k] = v
+          end
+        end
+      end
+
+      def self.log_callback(level, func, file, line, message, len)
+        return if logger.nil?
+
+        logger.debug do
+          {
+            level: level,
+            func: func,
+            file: file,
+            line: line,
+            message: message.read_bytes(len)
+          }.inspect
+        end
+      end
+
+      def self.logger
+        @logger
+      end
+
+      def self.logger=(logger)
+        unless @log_callback
+          log_callback = method(:log_callback)
+          Datadog::AppSec::WAF::LibDDWAF.ddwaf_set_log_cb(log_callback, :ddwaf_log_trace)
+
+          # retain logging proc if set properly
+          @log_callback = log_callback
+        end
+
+        @logger = logger
+      end
+
+      RESULT_CODE = {
+        ddwaf_err_internal:         :err_internal,
+        ddwaf_err_invalid_object:   :err_invalid_object,
+        ddwaf_err_invalid_argument: :err_invalid_argument,
+        ddwaf_ok:                   :ok,
+        ddwaf_match:                :match,
+      }
+
+      class Handle
+        attr_reader :handle_obj
+
+        attr_reader :ruleset_info
+
+        def initialize(rule, limits: {}, obfuscator: {})
+          rule_obj = Datadog::AppSec::WAF.ruby_to_object(rule)
+          if rule_obj.null? || rule_obj[:type] == :ddwaf_object_invalid
+            fail LibDDWAF::Error, "Could not convert object #{rule.inspect}"
+          end
+
+          config_obj = Datadog::AppSec::WAF::LibDDWAF::Config.new
+          if config_obj.null?
+            fail LibDDWAF::Error, 'Could not create config struct'
+          end
+          retain(config_obj)
+
+          config_obj[:limits][:max_container_size]  = limits[:max_container_size]  || LibDDWAF::DEFAULT_MAX_CONTAINER_SIZE
+          config_obj[:limits][:max_container_depth] = limits[:max_container_depth] || LibDDWAF::DEFAULT_MAX_CONTAINER_DEPTH
+          config_obj[:limits][:max_string_length]   = limits[:max_string_length]   || LibDDWAF::DEFAULT_MAX_STRING_LENGTH
+          config_obj[:obfuscator][:key_regex]       = FFI::MemoryPointer.from_string(obfuscator[:key_regex])   if obfuscator[:key_regex]
+          config_obj[:obfuscator][:value_regex]     = FFI::MemoryPointer.from_string(obfuscator[:value_regex]) if obfuscator[:value_regex]
+          config_obj[:free_fn] = Datadog::AppSec::WAF::LibDDWAF::ObjectNoFree
+
+          ruleset_info = LibDDWAF::RuleSetInfo.new
+
+          @handle_obj = Datadog::AppSec::WAF::LibDDWAF.ddwaf_init(rule_obj, config_obj, ruleset_info)
+
+          @ruleset_info = {
+            loaded: ruleset_info[:loaded],
+            failed: ruleset_info[:failed],
+            errors: WAF.object_to_ruby(ruleset_info[:errors]),
+            version: ruleset_info[:version],
+          }
+
+          if @handle_obj.null?
+            fail LibDDWAF::Error.new('Could not create handle', ruleset_info: @ruleset_info)
+          end
+
+          validate!
+        ensure
+          Datadog::AppSec::WAF::LibDDWAF.ddwaf_ruleset_info_free(ruleset_info) if ruleset_info
+          Datadog::AppSec::WAF::LibDDWAF.ddwaf_object_free(rule_obj) if rule_obj
+        end
+
+        def finalize
+          invalidate!
+
+          Datadog::AppSec::WAF::LibDDWAF.ddwaf_destroy(handle_obj)
+        end
+
+        def required_addresses
+          valid!
+
+          count = Datadog::AppSec::WAF::LibDDWAF::UInt32Ptr.new
+          list = Datadog::AppSec::WAF::LibDDWAF.ddwaf_required_addresses(handle_obj, count)
+
+          return [] if count == 0 # list is null
+
+          list.get_array_of_string(0, count[:value])
+        end
+
+        def update_rule_data(data)
+          res = Datadog::AppSec::WAF::LibDDWAF.ddwaf_update_rule_data(@handle_obj, Datadog::AppSec::WAF.ruby_to_object(data, coerce: false))
+
+          RESULT_CODE[res]
+        end
+
+        def toggle_rules(map)
+          res = Datadog::AppSec::WAF::LibDDWAF.ddwaf_toggle_rules(@handle_obj, Datadog::AppSec::WAF.ruby_to_object(map, coerce: false))
+
+          RESULT_CODE[res]
+        end
+
+        private
+
+        def validate!
+          @valid = true
+        end
+
+        def invalidate!
+          @valid = false
+        end
+
+        def valid?
+          @valid
+        end
+
+        def valid!
+          return if valid?
+
+          fail LibDDWAF::Error, "Attempt to use an invalid instance: #{inspect}"
+        end
+
+        def retained
+          @retained ||= []
+        end
+
+        def retain(object)
+          retained << object
+        end
+
+        def release(object)
+          retained.delete(object)
+        end
+      end
+
+      class Result
+        attr_reader :status, :data, :total_runtime, :timeout, :actions
+
+        def initialize(status, data, total_runtime, timeout, actions)
+          @status = status
+          @data = data
+          @total_runtime = total_runtime
+          @timeout = timeout
+          @actions = actions
+        end
+      end
+
+      class Context
+        attr_reader :context_obj
+
+        def initialize(handle)
+          handle_obj = handle.handle_obj
+          retain(handle)
+
+          @context_obj = Datadog::AppSec::WAF::LibDDWAF.ddwaf_context_init(handle_obj)
+          if @context_obj.null?
+            fail LibDDWAF::Error, 'Could not create context'
+          end
+
+          validate!
+        end
+
+        def finalize
+          invalidate!
+
+          retained.each do |retained_obj|
+            next unless retained_obj.is_a?(Datadog::AppSec::WAF::LibDDWAF::Object)
+
+            Datadog::AppSec::WAF::LibDDWAF.ddwaf_object_free(retained_obj)
+          end
+
+          Datadog::AppSec::WAF::LibDDWAF.ddwaf_context_destroy(context_obj)
+        end
+
+        def run(input, 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_CONTAINER_SIZE
+
+          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}"
+          end
+
+          result_obj = Datadog::AppSec::WAF::LibDDWAF::Result.new
+          if result_obj.null?
+            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)
+
+          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),
+            result_obj[:total_runtime],
+            result_obj[:timeout],
+            actions,
+          )
+
+          [RESULT_CODE[code], result]
+        ensure
+          Datadog::AppSec::WAF::LibDDWAF.ddwaf_result_free(result_obj) if result_obj
+        end
+
+        private
+
+        def validate!
+          @valid = true
+        end
+
+        def invalidate!
+          @valid = false
+        end
+
+        def valid?
+          @valid
+        end
+
+        def valid!
+          return if valid?
+
+          fail LibDDWAF::Error, "Attempt to use an invalid instance: #{inspect}"
+        end
+
+        def retained
+          @retained ||= []
+        end
+
+        def retain(object)
+          retained << object
+        end
+
+        def release(object)
+          retained.delete(object)
+        end
+      end
+    end
+  end
+end

data/lib/libddwaf.rb

@@ -0,0 +1 @@
+require 'datadog/appsec/waf'

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: libddwaf
+version: !ruby/object:Gem::Version
+  version: 1.5.1.0.0
+platform: java
+authors:
+- Datadog, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 'libddwaf packages a WAF implementation in C++, exposed to Ruby
+
+  '
+email:
+- dev@datadoghq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- LICENSE-3rdparty.csv
+- LICENSE.Apache
+- LICENSE.BSD3
+- NOTICE
+- lib/datadog/appsec/waf.rb
+- lib/datadog/appsec/waf/version.rb
+- lib/libddwaf.rb
+- vendor/libddwaf/libddwaf-1.5.1-darwin-arm64/lib/libddwaf.dylib
+- vendor/libddwaf/libddwaf-1.5.1-darwin-x86_64/lib/libddwaf.dylib
+- vendor/libddwaf/libddwaf-1.5.1-linux-aarch64/lib/libddwaf.so
+- vendor/libddwaf/libddwaf-1.5.1-linux-x86_64/lib/libddwaf.so
+homepage: https://github.com/DataDog/libddwaf-rb
+licenses:
+- BSD-3-Clause
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Datadog WAF
+test_files: []