libddwaf 1.3.0.2.0 → 1.5.1.0.0

data/sig/datadog/appsec/waf.rbs

@@ -0,0 +1,230 @@
+module Datadog
+  module AppSec
+    module WAF
+      module LibDDWAF
+        class Error < StandardError
+          attr_reader ruleset_info: Hash[Symbol, untyped] | nil
+
+          def initialize: (::String msg, ?ruleset_info: Hash[Symbol, untyped]?) -> void
+        end
+
+        extend ::FFI::Library
+
+        def self.local_os: () -> ::String
+        def self.local_cpu: () -> ::String
+        def self.local_version: () -> (::String | nil)
+        def self.source_dir: () -> ::String
+        def self.vendor_dir: () -> ::String
+        def self.libddwaf_vendor_dir: () -> ::String
+        def self.shared_lib_triplet: (?version: ::String?) -> ::String
+        def self.libddwaf_dir: () -> ::String
+        def self.shared_lib_extname: () -> ::String
+        def self.shared_lib_path: () -> ::String
+
+        # version
+
+        def self.ddwaf_get_version: () -> ::String
+
+        # ddwaf::object data structure
+
+        DDWAF_OBJ_TYPE: ::FFI::Enum
+
+        class UInt32Ptr < ::FFI::Struct
+        end
+
+        class UInt64Ptr < ::FFI::Struct
+        end
+
+        class SizeTPtr < ::FFI::Struct
+        end
+
+        class ObjectValueUnion < ::FFI::Union
+        end
+
+        class Object < ::FFI::Struct
+        end
+
+        # setters
+
+        def self.ddwaf_object_invalid: (LibDDWAF::Object) -> ::FFI::Pointer
+        def self.ddwaf_object_string: (LibDDWAF::Object, ::String) -> ::FFI::Pointer
+        def self.ddwaf_object_stringl: (LibDDWAF::Object, ::String, ::Integer) -> ::FFI::Pointer
+        def self.ddwaf_object_stringl_nc: (LibDDWAF::Object, ::String, ::Integer) -> ::FFI::Pointer
+        def self.ddwaf_object_unsigned: (LibDDWAF::Object, ::Integer) -> ::FFI::Pointer
+        def self.ddwaf_object_signed: (LibDDWAF::Object, ::Integer) -> ::FFI::Pointer
+        def self.ddwaf_object_unsigned_force: (LibDDWAF::Object, ::Integer) -> ::FFI::Pointer
+        def self.ddwaf_object_signed_force: (LibDDWAF::Object, ::Integer) -> ::FFI::Pointer
+        def self.ddwaf_object_bool: (LibDDWAF::Object, bool) -> ::FFI::Pointer
+
+        def self.ddwaf_object_array: (LibDDWAF::Object) -> ::FFI::Pointer
+        def self.ddwaf_object_array_add: (LibDDWAF::Object, LibDDWAF::Object) -> bool
+
+        def self.ddwaf_object_map: (LibDDWAF::Object) -> ::FFI::Pointer
+        def self.ddwaf_object_map_add: (LibDDWAF::Object, ::String, LibDDWAF::Object) -> bool
+        def self.ddwaf_object_map_addl: (LibDDWAF::Object, ::String, ::Integer, LibDDWAF::Object) -> bool
+        def self.ddwaf_object_map_addl_nc: (LibDDWAF::Object, ::String, ::Integer, LibDDWAF::Object) -> bool
+
+        # getters
+
+        def self.ddwaf_object_type: (LibDDWAF::Object) -> ::FFI::Enum
+        def self.ddwaf_object_size: (LibDDWAF::Object) -> ::Integer
+        def self.ddwaf_object_length: (LibDDWAF::Object) -> ::Integer
+        def self.ddwaf_object_get_key: (LibDDWAF::Object, SizeTPtr) -> ::String
+        def self.ddwaf_object_get_string: (LibDDWAF::Object, SizeTPtr) -> ::String
+        def self.ddwaf_object_get_unsigned: (LibDDWAF::Object, SizeTPtr) -> ::Integer
+        def self.ddwaf_object_get_signed: (LibDDWAF::Object, SizeTPtr) -> ::Integer
+        def self.ddwaf_object_get_index: (LibDDWAF::Object, ::Integer) -> LibDDWAF::Object
+
+        # freeers
+
+        def self.ddwaf_object_free: (LibDDWAF::Object) -> void
+
+        ObjectFree: ::FFI::Function
+        ObjectNoFree: ::FFI::Pointer
+
+        # main handle
+
+        class Config < ::FFI::Struct
+          class Limits < ::FFI::Struct
+          end
+
+          class Obfuscator < ::FFI::Struct
+          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_destroy: (::FFI::Pointer) -> void
+
+        def self.ddwaf_required_addresses: (::FFI::Pointer, UInt32Ptr) -> ::FFI::Pointer
+        def self.ddwaf_rule_data_ids: (::FFI::Pointer, UInt32Ptr) -> ::FFI::Pointer
+
+        # updating
+
+        DDWAF_RET_CODE: ::FFI::Enum
+
+        def self.ddwaf_update_rule_data: (::FFI::Pointer, LibDDWAF::Object) -> ::Symbol
+        def self.ddwaf_toggle_rules: (::FFI::Pointer, LibDDWAF::Object) -> ::Symbol
+
+        # running
+
+        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
+
+        def self.ddwaf_run: (::FFI::Pointer, Object, Result, ::Integer) -> ::Symbol
+        def self.ddwaf_result_free: (Result) -> void
+
+        # logging
+
+        DDWAF_LOG_LEVEL: ::FFI::Enum
+
+        type ddwaf_log_level = ::Symbol
+
+        # TODO: signature is as below but steep 1.1 does not yet support method/proc/block mapping
+        # type ddwaf_log_cb = ^(ddwaf_log_level, ::String, ::String, ::Integer, ::FFI::Pointer, ::Integer) -> void
+        type ddwaf_log_cb = ::Method | ::Proc
+        def self.ddwaf_set_log_cb: (ddwaf_log_cb, ddwaf_log_level) -> bool
+
+        DEFAULT_MAX_CONTAINER_SIZE: ::Integer
+        DEFAULT_MAX_CONTAINER_DEPTH: ::Integer
+        DEFAULT_MAX_STRING_LENGTH: ::Integer
+
+        DDWAF_MAX_CONTAINER_SIZE: ::Integer
+        DDWAF_MAX_CONTAINER_DEPTH: ::Integer
+        DDWAF_MAX_STRING_LENGTH: ::Integer
+
+        DDWAF_RUN_TIMEOUT: ::Integer
+      end
+
+      def self.version: () -> ::String
+
+      type data = String | Symbol | Integer | Float | TrueClass | FalseClass | Array[data] | Hash[String | Symbol, data] | nil
+
+      def self.ruby_to_object: (data val, ?max_container_size: ::Integer?, ?max_container_depth: ::Integer?, ?max_string_length: ::Integer?, ?coerce: bool?) -> ::Datadog::AppSec::WAF::LibDDWAF::Object
+      def self.object_to_ruby: (::Datadog::AppSec::WAF::LibDDWAF::Object obj) -> data
+
+      self.@logger: ::Logger
+      self.@log_callback: LibDDWAF::ddwaf_log_cb
+
+      def self.log_callback: (LibDDWAF::ddwaf_log_level, ::String, ::String, ::Integer, ::FFI::Pointer, ::Integer) -> void
+      def self.logger: () -> ::Logger
+      def self.logger=: (::Logger logger) -> void
+
+      RESULT_CODE: ::Hash[::Symbol, ::Symbol]
+
+      class Handle
+        attr_reader handle_obj: ::FFI::Pointer
+        attr_reader ruleset_info: Hash[Symbol, untyped]
+
+        def initialize: (data rule, ?limits: ::Hash[::Symbol, ::Integer], ?obfuscator: ::Hash[::Symbol, ::String]) -> void
+        def finalize: () -> untyped
+        def required_addresses: () -> ::Array[::String]
+        def update_rule_data: (::Array[untyped]) -> ::Symbol
+        def toggle_rules: (::Hash[::String, bool]) -> ::Symbol
+
+        private
+
+        @valid: bool
+
+        def validate!: () -> void
+        def invalidate!: () -> void
+        def valid?: () -> (nil | bool)
+        def valid!: () -> void
+
+        @retained: Array[untyped]
+
+        def retained: () -> Array[untyped]
+        def retain: (top object) -> void
+        def release: (top object) -> void
+      end
+
+      type result_data = Array[untyped] | nil
+
+      class Result
+        attr_reader status: ::Symbol
+        attr_reader data: untyped
+        attr_reader total_runtime: ::Float
+        attr_reader timeout: bool
+        attr_reader actions: ::Array[::String]
+
+        def initialize: (::Symbol, result_data, ::Float, bool, ::Array[::String]) -> void
+      end
+
+      class Context
+        attr_reader context_obj: ::FFI::Pointer
+
+        def initialize: (Handle handle) -> void
+        def finalize: () -> void
+
+        def run: (data input, ?::Integer timeout) -> ::Array[top]
+
+        private
+
+        @valid: bool
+
+        def validate!: () -> void
+        def invalidate!: () -> void
+        def valid?: () -> (nil | bool)
+        def valid!: () -> void
+
+        @retained: Array[untyped]
+
+        def retained: () -> Array[untyped]
+        def retain: (top object) -> void
+        def release: (top object) -> void
+      end
+    end
+  end
+end

data/vendor/rbs/ffi/0/ffi.rbs

@@ -0,0 +1,62 @@
+module FFI
+  module Type
+    class Builtin
+    end
+
+    class Mapped
+    end
+  end
+
+  class AbstractMemory
+    def get_array_of_string: (::Integer, ::Integer) -> Array[String]
+    def read_bytes: (::Integer) -> ::String
+  end
+
+  class Pointer < AbstractMemory
+    NULL: Pointer
+
+    def null?: () -> bool
+  end
+
+  class MemoryPointer < Pointer
+    def self.from_string: (::String) -> MemoryPointer
+  end
+
+  class Enum
+  end
+
+  class Union
+    def self.layout: (*(Symbol | Integer)) -> void
+  end
+
+  type union = top # TODO: handle user-defined unions
+
+  class Struct
+    # TODO: layout args are actually "Symbol | Union, Integer, *(Symbol | Union, Integer)"
+    def self.layout: (*(Symbol | Integer | union)) -> void
+    def self.by_ref: () -> Type::Mapped
+    def self.size: () -> Integer
+
+    def null?: () -> bool
+    def initialize: (?Pointer) -> void
+    def []: (Symbol) -> untyped
+    def []=: (Symbol, untyped) -> untyped
+    def pointer: () -> Pointer
+  end
+
+  class Function < Pointer
+  end
+
+  module Library
+    # these can be worked around by typedef'ing to a Symbol
+    type enum = top # TODO: handle user-defined enum constants
+    type ref = top # TODO: handle by_ref references
+    type typedef = top # TODO: handle non-builtin types
+
+    def ffi_lib: (Array[String]) -> void
+    def typedef: (ref | Symbol, Symbol) -> (Type::Builtin | Type::Mapped | typedef)
+    def attach_function: (Symbol, Array[Symbol | Struct | enum], Symbol | Enum, ?blocking: bool) -> Function
+    def callback: (Symbol, Array[Symbol | Enum | Struct], Symbol | Enum) -> Function
+    def enum: (*untyped) -> Enum
+  end
+end

data/vendor/rbs/gem/0/gem.rbs

@@ -0,0 +1,7 @@
+class Gem::Platform
+  def self.local: () -> Gem::Platform
+
+  def os: () -> String
+  def cpu: () -> String
+  def version: () -> String
+end

data/vendor/rbs/jruby/0/jruby.rbs

@@ -0,0 +1,3 @@
+module Kernel
+  def java: () -> untyped
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libddwaf
 version: !ruby/object:Gem::Version
-  version: 1.3.0.2.0
+  version: 1.5.1.0.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2022-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -33,9 +33,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/lint.yml"
 - ".github/workflows/package.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - LICENSE
 - LICENSE-3rdparty.csv
@@ -43,11 +45,18 @@ files:
 - LICENSE.BSD3
 - NOTICE
 - README.md
+- Steepfile
 - lib/datadog/appsec/waf.rb
 - lib/datadog/appsec/waf/version.rb
 - lib/libddwaf.rb
 - libddwaf.gemspec
-homepage: https://github.com/DataDog/libddwaf
+- sig/datadog/appsec/waf.rbs
+- sig/datadog/appsec/waf/version.rbs
+- sig/libddwaf.rbs
+- vendor/rbs/ffi/0/ffi.rbs
+- vendor/rbs/gem/0/gem.rbs
+- vendor/rbs/jruby/0/jruby.rbs
+homepage: https://github.com/DataDog/libddwaf-rb
 licenses:
 - BSD-3-Clause
 metadata: