libddwaf 1.3.0.0.0-x86_64-linux → 1.3.0.2.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5096be391528d03345866d4fcb2e2048fd9fd43179a22d3cfb71dcdbb82de79d
-  data.tar.gz: '02369aa3071541cf780e1e980b9b95570b1800255ee9847a2f3109ffda728b7d'
+  metadata.gz: 3feabb5073c208b36d6fe82e1b35c3abe1bb452130018507004d49c763c12af4
+  data.tar.gz: 3b47d976c8fb5da977d16397702c27ea77398c8a71c1416d10da2737288dcba8
 SHA512:
-  metadata.gz: 6c96e0da16b9dff5b8da47a00786d39ebd9df86bffe4fdafc9e9d9c33a869c00a0c50d7a6b64aca0c2a5b574c259b3859b232b22ff804bde9b63f56b3f5f3422
-  data.tar.gz: 87abb55e7c100d806e1d5eec98c676522db0ec0f0003f2f87ac8ba2cb646da598966b275e4ccd22a7d9e34112a673d68f5f485c17fd45a3f99c9c9640cae2c9a
+  metadata.gz: 6ba106c7714857bfdf784b7b96a78580f67f80827dbfa7268fa52396142821490fe301066492f5ab88e590c37e6d3f1901f71637c75da9688b0dfa276d6173e1
+  data.tar.gz: b2c72bd3c8508f9ceff51d4bcfd733366c51a7f29a4df77d2a75901ac5739a2eaf7bb0f98f56e642ce317d1075522a55fa21070f13ca5d1a5088c64617a02294

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

@@ -3,7 +3,7 @@ module Datadog
     module WAF
       module VERSION
         BASE_STRING = '1.3.0'
-        STRING = "#{BASE_STRING}.0.0"
+        STRING = "#{BASE_STRING}.2.0"
         MINIMUM_RUBY_VERSION = '2.1'
       end
     end

data/lib/datadog/appsec/waf.rb

@@ -6,7 +6,13 @@ module Datadog
   module AppSec
     module WAF
       module LibDDWAF
-        class Error < StandardError; end
+        class Error < StandardError
+          attr_reader :ruleset_info
+
+          def initialize(msg, ruleset_info: nil)
+            @ruleset_info = ruleset_info
+          end
+        end
 
         extend ::FFI::Library
 
@@ -26,12 +32,22 @@ module Datadog
           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
 
@@ -41,12 +57,28 @@ module Datadog
           Gem::Platform.local.cpu
         end
 
+        def self.vendor_dir
+          File.join(__dir__, '../../../vendor')
+        end
+
+        def self.libddwaf_vendor_dir
+          File.join(vendor_dir, 'libddwaf')
+        end
+
+        def self.shared_lib_triplet
+          local_version ? "#{local_os}-#{local_version}-#{local_cpu}" : "#{local_os}-#{local_cpu}"
+        end
+
+        def self.libddwaf_dir
+          File.join(libddwaf_vendor_dir, "libddwaf-#{Datadog::AppSec::WAF::VERSION::BASE_STRING}-#{shared_lib_triplet}")
+        end
+
         def self.shared_lib_extname
           Gem::Platform.local.os == 'darwin' ? '.dylib' : '.so'
         end
 
         def self.shared_lib_path
-          File.join(__dir__, "../../../vendor/libddwaf/libddwaf-#{Datadog::AppSec::WAF::VERSION::BASE_STRING}-#{local_os}-#{local_cpu}/lib/libddwaf#{shared_lib_extname}")
+          File.join(libddwaf_dir, 'lib', "libddwaf#{shared_lib_extname}")
         end
 
         ffi_lib [shared_lib_path]
@@ -158,8 +190,8 @@ module Datadog
           end
 
           class Obfuscator < ::FFI::Struct
-            layout :key_regex,   :string,
-                   :value_regex, :string
+            layout :key_regex,   :pointer, # :charptr
+                   :value_regex, :pointer  # :charptr
           end
 
           layout :limits,     Limits,
@@ -183,7 +215,7 @@ module Datadog
         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_addresses, [:ddwaf_handle, UInt32Ptr], :charptrptr
 
         # running
 
@@ -259,7 +291,7 @@ module Datadog
           end
 
           val.each do |k, v|
-            res = LibDDWAF.ddwaf_object_map_addl(obj, k.to_s, k.to_s.size, ruby_to_object(v))
+            res = LibDDWAF.ddwaf_object_map_addl(obj, k.to_s, k.to_s.bytesize, ruby_to_object(v))
             unless res
               fail LibDDWAF::Error, "Could not add to map object: #{k.inspect} => #{v.inspect}"
             end
@@ -268,7 +300,7 @@ module Datadog
           obj
         when String
           obj = LibDDWAF::Object.new
-          res = LibDDWAF.ddwaf_object_stringl(obj, val, val.size)
+          res = LibDDWAF.ddwaf_object_stringl(obj, val, val.bytesize)
           if res.null?
             fail LibDDWAF::Error, "Could not convert into object: #{val}"
           end
@@ -276,7 +308,8 @@ module Datadog
           obj
         when Symbol
           obj = LibDDWAF::Object.new
-          res = LibDDWAF.ddwaf_object_stringl(obj, val.to_s, val.size)
+          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}"
           end
@@ -354,7 +387,9 @@ module Datadog
         DEFAULT_MAX_CONTAINER_DEPTH = 0
         DEFAULT_MAX_STRING_LENGTH   = 0
 
-        def initialize(rule, config = {})
+        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}"
@@ -365,15 +400,25 @@ module Datadog
             fail LibDDWAF::Error, 'Could not create config struct'
           end
 
-          config_obj[:limits][:max_container_size]  = config[:max_container_size]  || DEFAULT_MAX_CONTAINER_SIZE
-          config_obj[:limits][:max_container_depth] = config[:max_container_depth] || DEFAULT_MAX_CONTAINER_DEPTH
-          config_obj[:limits][:max_string_length]   = config[:max_string_length]   || DEFAULT_MAX_STRING_LENGTH
+          config_obj[:limits][:max_container_size]  = limits[:max_container_size]  || DEFAULT_MAX_CONTAINER_SIZE
+          config_obj[:limits][:max_container_depth] = limits[:max_container_depth] || DEFAULT_MAX_CONTAINER_DEPTH
+          config_obj[:limits][:max_string_length]   = limits[:max_string_length]   || 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]
 
-          ruleset_info = LibDDWAF::RuleSetInfoNone
+          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, 'Could not create handle'
+            fail LibDDWAF::Error.new('Could not create handle', ruleset_info: @ruleset_info)
           end
 
           ObjectSpace.define_finalizer(self, Handle.finalizer(handle_obj))
@@ -387,6 +432,15 @@ module Datadog
             Datadog::AppSec::WAF::LibDDWAF.ddwaf_destroy(handle_obj)
           end
         end
+
+        def required_addresses
+          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
       end
 
       Result = Struct.new(:action, :data, :total_runtime, :timeout)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libddwaf
 version: !ruby/object:Gem::Version
-  version: 1.3.0.0.0
+  version: 1.3.0.2.0
 platform: x86_64-linux
 authors:
 - Datadog, Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-29 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -41,14 +41,14 @@ files:
 - lib/datadog/appsec/waf.rb
 - lib/datadog/appsec/waf/version.rb
 - lib/libddwaf.rb
-- vendor/libddwaf/libddwaf-1.3.0-linux-x86_64/include/ddwaf.h
-- vendor/libddwaf/libddwaf-1.3.0-linux-x86_64/lib/libddwaf.so
+- vendor/libddwaf/libddwaf-1.3.0-linux-gnu-x86_64/lib/libddwaf.so
+- vendor/libddwaf/libddwaf-1.3.0-linux-musl-x86_64/lib/libddwaf.so
 homepage: https://github.com/DataDog/libddwaf
 licenses:
 - BSD-3-Clause
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -63,8 +63,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.26
+signing_key:
 specification_version: 4
 summary: Datadog WAF
 test_files: []

data/vendor/libddwaf/libddwaf-1.3.0-linux-x86_64/include/ddwaf.h

@@ -1,624 +0,0 @@
-// Unless explicitly stated otherwise all files in this repository are
-// dual-licensed under the Apache-2.0 License or BSD-3-Clause License.
-//
-// This product includes software developed at Datadog (https://www.datadoghq.com/).
-// Copyright 2021 Datadog, Inc.
-
-#ifndef pw_h
-#define pw_h
-
-#ifdef __cplusplus
-extern "C"
-{
-#endif
-
-#include <stdbool.h>
-#include <stdint.h>
-#include <stddef.h>
-
-#define DDWAF_MAX_STRING_LENGTH 4096
-#define DDWAF_MAX_CONTAINER_DEPTH 20
-#define DDWAF_MAX_CONTAINER_SIZE 256
-#define DDWAF_RUN_TIMEOUT 5000
-
-/**
- * @enum DDWAF_OBJ_TYPE
- *
- * Specifies the type of a ddwaf::object.
- **/
-typedef enum
-{
-    DDWAF_OBJ_INVALID     = 0,
-    /** Value shall be decoded as a int64_t (or int32_t on 32bits platforms). **/
-    DDWAF_OBJ_SIGNED   = 1 << 0,
-    /** Value shall be decoded as a uint64_t (or uint32_t on 32bits platforms). **/
-    DDWAF_OBJ_UNSIGNED = 1 << 1,
-    /** Value shall be decoded as a UTF-8 string of length nbEntries. **/
-    DDWAF_OBJ_STRING   = 1 << 2,
-    /** Value shall be decoded as an array of ddwaf_object of length nbEntries, each item having no parameterName. **/
-    DDWAF_OBJ_ARRAY    = 1 << 3,
-    /** Value shall be decoded as an array of ddwaf_object of length nbEntries, each item having a parameterName. **/
-    DDWAF_OBJ_MAP      = 1 << 4,
-} DDWAF_OBJ_TYPE;
-
-/**
- * @enum DDWAF_RET_CODE
- *
- * Codes returned by ddwaf_run.
- **/
-typedef enum
-{
-    DDWAF_ERR_INTERNAL     = -3,
-    DDWAF_ERR_INVALID_OBJECT = -2,
-    DDWAF_ERR_INVALID_ARGUMENT = -1,
-    DDWAF_GOOD             = 0,
-    DDWAF_MONITOR          = 1,
-    DDWAF_BLOCK            = 2
-} DDWAF_RET_CODE;
-
-/**
- * @enum DDWAF_LOG_LEVEL
- *
- * Internal WAF log levels, to be used when setting the minimum log level and cb.
- **/
-typedef enum
-{
-    DDWAF_LOG_TRACE,
-    DDWAF_LOG_DEBUG,
-    DDWAF_LOG_INFO,
-    DDWAF_LOG_WARN,
-    DDWAF_LOG_ERROR,
-    DDWAF_LOG_OFF,
-} DDWAF_LOG_LEVEL;
-
-#ifdef __cplusplus
-class PowerWAF;
-class PWAdditive;
-using ddwaf_handle = PowerWAF *;
-using ddwaf_context = PWAdditive *;
-#else
-typedef struct _ddwaf_handle* ddwaf_handle;
-typedef struct _ddwaf_context* ddwaf_context;
-#endif
-
-typedef struct _ddwaf_object ddwaf_object;
-typedef struct _ddwaf_config ddwaf_config;
-typedef struct _ddwaf_result ddwaf_result;
-typedef struct _ddwaf_version ddwaf_version;
-typedef struct _ddwaf_ruleset_info ddwaf_ruleset_info;
-/**
- * @struct ddwaf_object
- *
- * Generic object used to pass data and rules to the WAF.
- **/
-struct _ddwaf_object
-{
-    const char* parameterName;
-    uint64_t parameterNameLength;
-    // uintValue should be at least as wide as the widest type on the platform.
-    union
-    {
-        const char* stringValue;
-        uint64_t uintValue;
-        int64_t intValue;
-        ddwaf_object* array;
-    };
-    uint64_t nbEntries;
-    DDWAF_OBJ_TYPE type;
-};
-
-/**
- * @struct ddwaf_config
- *
- * Configuration to be provided to the WAF
- **/
-struct _ddwaf_config
-{
-    struct {
-        /** Maximum size of ddwaf::object containers. */
-        uint32_t max_container_size;
-        /** Maximum depth of ddwaf::object containers. */
-        uint32_t max_container_depth;
-        /** Maximum length of ddwaf::object strings. */
-        uint32_t max_string_length;
-    } limits;
-
-    /** Obfuscator regexes - the strings are owned by the caller */
-    struct {
-        /** Regular expression for key-based obfuscation */
-        const char *key_regex;
-        /** Regular expression for value-based obfuscation */
-        const char *value_regex;
-    } obfuscator;
-};
-
-/**
- * @struct ddwaf_result
- *
- * Structure containing the result of a WAF run.
- **/
-struct _ddwaf_result
-{
-    /** Whether there has been a timeout during the operation **/
-    bool timeout;
-    /** Run result in JSON format **/
-    const char* data;
-    /** Total WAF runtime in nanoseconds **/
-    uint64_t total_runtime;
-};
-
-/**
- * @ddwaf_version
- *
- * Structure containing the version of the WAF following semver.
- **/
-struct _ddwaf_version
-{
-    uint16_t major;
-    uint16_t minor;
-    uint16_t patch;
-};
-
-/**
- * @ddwaf_ruleset_info
- *
- * Structure containing diagnostics on the provided ruleset.
- * */
-struct _ddwaf_ruleset_info
-{
-    /** Number of rules successfully loaded **/
-    uint16_t loaded;
-    /** Number of rules which failed to parse **/
-    uint16_t failed;
-    /** Map from an error string to an array of all the rule ids for which
-     *  that error was raised. {error: [rule_ids]} **/
-    ddwaf_object errors;
-    /** Ruleset version **/
-    const char *version;
-};
-
-/**
- * @typedef ddwaf_object_free_fn
- *
- * Type of the function to free ddwaf::objects.
- **/
-typedef void (*ddwaf_object_free_fn)(ddwaf_object *object);
-
-/**
- * @typedef ddwaf_log_cb
- *
- * Callback that powerwaf will call to relay messages to the binding.
- *
- * @param level The logging level.
- * @param function The native function that emitted the message. (nonnull)
- * @param file The file of the native function that emmitted the message. (nonnull)
- * @param line The line where the message was emmitted.
- * @param message The size of the logging message. NUL-terminated
- * @param message_len The length of the logging message (excluding NUL terminator).
- */
-typedef void (*ddwaf_log_cb)(
-    DDWAF_LOG_LEVEL level, const char* function, const char* file, unsigned line,
-    const char* message, uint64_t message_len);
-
-/**
- * ddwaf_init
- *
- * Initialize a ddwaf instance
- *
- * @param rule ddwaf::object containing the patterns to be used by the WAF. (nonnull)
- * @param config Optional configuration of the WAF. (nullable)
- * @param info Optional ruleset parsing diagnostics. (nullable)
- *
- * @return Handle to the WAF instance.
- **/
-ddwaf_handle ddwaf_init(const ddwaf_object *rule,
-    const ddwaf_config* config, ddwaf_ruleset_info *info);
-
-/**
- * ddwaf_destroy
- *
- * Destroy a WAF instance.
- *
- * @param Handle to the WAF instance.
- */
-void ddwaf_destroy(ddwaf_handle handle);
-/**
- * ddwaf_ruleset_info_free
- *
- * Free the memory associated with the ruleset info structure.
- *
- * @param info Ruleset info to free.
- * */
-void ddwaf_ruleset_info_free(ddwaf_ruleset_info *info);
-/**
- * ddwaf_required_addresses
- *
- * Get a list of required (root) addresses. The memory is owned by the WAF and
- * should not be freed.
- *
- * @param Handle to the WAF instance.
- * @param size Output parameter in which the size will be returned. The value of
- *             size will be 0 if the return value is nullptr.
- * @return NULL if error, otherwise a pointer to an array with size elements.
- **/
-const char* const* ddwaf_required_addresses(const ddwaf_handle handle, uint32_t *size);
-/**
- * ddwaf_context_init
- *
- * Context object to perform matching using the provided WAF instance.
- *
- * @param handle Handle of the WAF instance containing the ruleset definition. (nonnull)
- * @param obj_free Function to free the ddwaf::object provided to the context
- *                 during calls to ddwaf_run. If the value of this function is
- *                 NULL, the objects will not be freed. By default the value of
- *                 this parameter should be ddwaf_object_free.
- *
- * @return Handle to the context instance.
- *
- * @note The WAF instance needs to be valid for the lifetime of the context.
- **/
-ddwaf_context ddwaf_context_init(const ddwaf_handle handle, ddwaf_object_free_fn obj_free);
-
-/**
- * ddwaf_run
- *
- * Perform a matching operation on the provided data
- *
- * @param context WAF context to be used in this run, this will determine the
- *                ruleset which will be used and it will also ensure that
- *                parameters are taken into account across runs (nonnull)
- * @param data Data on which to perform the pattern matching. This data will be
- *             stored by the context and used across multiple calls to this
- *             function. Once the context is destroyed, the used-defined free
- *             function will be used to free the data provided. Note that the
- *             data passed must be valid until the destruction of the context.
- *             (nonull)
- * @param result Structure containing the result of the operation. (nullable)
- * @param timeout Maximum time budget in microseconds.
- *
- * @return Return code of the operation, also contained in the result structure.
- * @error DDWAF_ERR_INVALID_ARGUMENT The context is invalid, the data will not
- *                                   be freed.
- * @error DDWAF_ERR_INVALID_OBJECT The data provided didn't match the desired
- *                                 structure or contained invalid objects, the
- *                                 data will be freed by this function.
- * @error DDWAF_ERR_TIMEOUT The operation timed out, the data will be owned by
- *                          the context and freed during destruction.
- * @error DDWAF_ERR_INTERNAL There was an unexpected error and the operation did
- *                           not succeed. The state of the WAF is undefined if
- *                           this error is produced and the ownership of the
- *                           data is unknown. The result structure will not be
- *                           filled if this error occurs.
- **/
-DDWAF_RET_CODE ddwaf_run(ddwaf_context context, ddwaf_object *data,
-                         ddwaf_result *result,  uint64_t timeout);
-
-/**
- * ddwaf_context_destroy
- *
- * Performs the destruction of the context, freeing the data passed to it through
- * ddwaf_run using the used-defined free function.
- *
- * @param context Context to destroy. (nonnull)
- **/
-void ddwaf_context_destroy(ddwaf_context context);
-
-/**
- * ddwaf_result_free
- *
- * Free a ddwaf_result structure.
- *
- * @param result Structure to free. (nonnull)
- **/
-void ddwaf_result_free(ddwaf_result *result);
-
-/**
- * ddwaf_object_invalid
- *
- * Creates an invalid object.
- *
- * @param object Object to perform the operation on. (nonnull)
- *
- * @return A pointer to the passed object or NULL if the operation failed.
- **/
-ddwaf_object* ddwaf_object_invalid(ddwaf_object *object);
-
-/**
- * ddwaf_object_string
- *
- * Creates an object from a string.
- *
- * @param object Object to perform the operation on. (nonnull)
- * @param string String to initialise the object with, this string will be copied
- *               and its length will be calculated using strlen(string). (nonnull)
- *
- * @return A pointer to the passed object or NULL if the operation failed.
- **/
-ddwaf_object* ddwaf_object_string(ddwaf_object *object, const char *string);
-
-/**
- * ddwaf_object_stringl
- *
- * Creates an object from a string and its length.
- *
- * @param object Object to perform the operation on. (nonnull)
- * @param string String to initialise the object with, this string will be
- *               copied. (nonnull)
- * @param length Length of the string.
- *
- * @return A pointer to the passed object or NULL if the operation failed.
- **/
-ddwaf_object* ddwaf_object_stringl(ddwaf_object *object, const char *string, size_t length);
-
-/**
- * ddwaf_object_stringl_nc
- *
- * Creates an object with the string pointer and length provided.
- *
- * @param object Object to perform the operation on. (nonnull)
- * @param string String pointer to initialise the object with.
- * @param length Length of the string.
- *
- * @return A pointer to the passed object or NULL if the operation failed.
- **/
-ddwaf_object* ddwaf_object_stringl_nc(ddwaf_object *object, const char *string, size_t length);
-
-/**
- * ddwaf_object_unsigned
- *
- * Creates an object using an unsigned integer (64-bit). The resulting object
- * will contain a string created using the integer provided. This is the
- * preferred method for passing an unsigned integer to the WAF.
- *
- * @param object Object to perform the operation on. (nonnull)
- * @param value Integer to initialise the object with.
- *
- * @return A pointer to the passed object or NULL if the operation failed.
- **/
-ddwaf_object* ddwaf_object_unsigned(ddwaf_object *object, uint64_t value);
-
-/**
- * ddwaf_object_signed
- *
- * Creates an object using a signed integer (64-bit). The resulting object
- * will contain a string created using the integer provided. This is the
- * preferred method for passing a signed integer to the WAF.
- *
- * @param object Object to perform the operation on. (nonnull)
- * @param value Integer to initialise the object with.
- *
- * @return A pointer to the passed object or NULL if the operation failed.
- **/
-ddwaf_object* ddwaf_object_signed(ddwaf_object *object, int64_t value);
-
-/**
- * ddwaf_object_unsigned_force
- *
- * Creates an object using an unsigned integer (64-bit). The resulting object
- * will contain an unsigned integer as opposed to a string.
- *
- * @param object Object to perform the operation on. (nonnull)
- * @param value Integer to initialise the object with.
- *
- * @return A pointer to the passed object or NULL if the operation failed.
- **/
-ddwaf_object* ddwaf_object_unsigned_force(ddwaf_object *object, uint64_t value);
-
-/**
- * ddwaf_object_signed_force
- *
- * Creates an object using a signed integer (64-bit). The resulting object
- * will contain a signed integer as opposed to a string.
- *
- * @param object Object to perform the operation on. (nonnull)
- * @param value Integer to initialise the object with.
- *
- * @return A pointer to the passed object or NULL if the operation failed.
- **/
-ddwaf_object* ddwaf_object_signed_force(ddwaf_object *object, int64_t value);
-
-/**
- * ddwaf_object_array
- *
- * Creates an array object, for sequential storage.
- *
- * @param object Object to perform the operation on. (nonnull)
- *
- * @return A pointer to the passed object or NULL if the operation failed.
- **/
-ddwaf_object* ddwaf_object_array(ddwaf_object *object);
-
-/**
- * ddwaf_object_map
- *
- * Creates a map object, for key-value storage.
- *
- * @param object Object to perform the operation on. (nonnull)
- *
- * @return A pointer to the passed object or NULL if the operation failed.
- **/
-ddwaf_object* ddwaf_object_map(ddwaf_object *object);
-
-/**
- * ddwaf_object_array_add
- *
- * Inserts an object into an array object.
- *
- * @param array Array in which to insert the object. (nonnull)
- * @param object Object to insert into the array. (nonnull)
- *
- * @return The success or failure of the operation.
- **/
-bool ddwaf_object_array_add(ddwaf_object *array, ddwaf_object *object);
-
-/**
- * ddwaf_object_map_add
- *
- * Inserts an object into an map object, using a key.
- *
- * @param map Map in which to insert the object. (nonnull)
- * @param key The key for indexing purposes, this string will be copied and its
- *            length will be calcualted using strlen(key). (nonnull)
- * @param object Object to insert into the array. (nonnull)
- *
- * @return The success or failure of the operation.
- **/
-bool ddwaf_object_map_add(ddwaf_object *map, const char *key, ddwaf_object *object);
-
-/**
- * ddwaf_object_map_addl
- *
- * Inserts an object into an map object, using a key and its length.
- *
- * @param map Map in which to insert the object. (nonnull)
- * @param key The key for indexing purposes, this string will be copied (nonnull)
- * @param length Length of the key.
- * @param object Object to insert into the array. (nonnull)
- *
- * @return The success or failure of the operation.
- **/
-bool ddwaf_object_map_addl(ddwaf_object *map, const char *key, size_t length, ddwaf_object *object);
-
-/**
- * ddwaf_object_map_addl_nc
- *
- * Inserts an object into an map object, using a key and its length, but without
- * creating a copy of the key.
- *
- * @param map Map in which to insert the object. (nonnull)
- * @param key The key for indexing purposes, this string will be copied (nonnull)
- * @param length Length of the key.
- * @param object Object to insert into the array. (nonnull)
- *
- * @return The success or failure of the operation.
- **/
-bool ddwaf_object_map_addl_nc(ddwaf_object *map, const char *key, size_t length, ddwaf_object *object);
-
-/**
- * ddwaf_object_type
- *
- * Returns the type of the object.
- *
- * @param object The object from which to get the type.
- *
- * @return The object type of DDWAF_OBJ_INVALID if NULL.
- **/
-DDWAF_OBJ_TYPE ddwaf_object_type(ddwaf_object *object);
-
-/**
- * ddwaf_object_size
- *
- * Returns the size of the container object.
- *
- * @param object The object from which to get the size.
- *
- * @return The object size or 0 if the object is not a container (array, map).
- **/
-size_t ddwaf_object_size(ddwaf_object *object);
-
-/**
- * ddwaf_object_length
- *
- * Returns the length of the string object.
- *
- * @param object The object from which to get the length.
- *
- * @return The string length or 0 if the object is not a string.
- **/
-size_t ddwaf_object_length(ddwaf_object *object);
-
-/**
- * ddwaf_object_get_key
- *
- * Returns the key contained within the object.
- *
- * @param object The object from which to get the key.
- * @param length Output parameter on which to return the length of the key,
- *               this parameter is optional / nullable.
- *
- * @return The key of the object or NULL if the object doesn't contain a key.
- **/
-const char* ddwaf_object_get_key(ddwaf_object *object, size_t *length);
-
-/**
- * ddwaf_object_get_string
- *
- * Returns the string contained within the object.
- *
- * @param object The object from which to get the string.
- * @param length Output parameter on which to return the length of the string,
- *               this parameter is optional / nullable.
- *
- * @return The string of the object or NULL if the object is not a string.
- **/
-const char* ddwaf_object_get_string(ddwaf_object *object, size_t *length);
-
-/**
- * ddwaf_object_get_unsigned
- *
- * Returns the uint64 contained within the object.
- *
- * @param object The object from which to get the integer.
- *
- * @return The integer or 0 if the object is not an unsigned.
- **/
-uint64_t ddwaf_object_get_unsigned(ddwaf_object *object);
-
-/**
- * ddwaf_object_get_signed
- *
- * Returns the int64 contained within the object.
- *
- * @param object The object from which to get the integer.
- *
- * @return The integer or 0 if the object is not a signed.
- **/
-int64_t ddwaf_object_get_signed(ddwaf_object *object);
-
-/**
- * ddwaf_object_get_index
- *
- * Returns the object contained in the container at the given index.
- *
- * @param object The container from which to extract the object.
- * @param index The position of the required object within the container.
- *
- * @return The requested object or NULL if the index is out of bounds or the
- *         object is not a container.
- **/
-ddwaf_object* ddwaf_object_get_index(ddwaf_object *object, size_t index);
-
-
-/**
- * ddwaf_object_free
- *
- * @param object Object to free. (nonnull)
- **/
-void ddwaf_object_free(ddwaf_object *object);
-
-/**
- * ddwaf_get_version
- *
- * Return the version of the library
- *
- * @param version Version structure following semver
- **/
-void ddwaf_get_version(ddwaf_version *version);
-
-/**
- * ddwaf_set_log_cb
- *
- * Sets the callback to relay logging messages to the binding
- *
- * @param cb The callback to call, or NULL to stop relaying messages
- * @param min_level The minimum logging level for which to relay messages
- *
- * @return whether the operation succeeded or not
- **/
-bool ddwaf_set_log_cb(ddwaf_log_cb cb, DDWAF_LOG_LEVEL min_level);
-
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
-
-#endif /* pw_h */