Class: Datadog::AppSec::WAF::Context

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog/appsec/waf/context.rb

Overview

Ruby representation of the ddwaf_context in libddwaf See github.com/DataDog/libddwaf/blob/10e3a1dfc7bc9bb8ab11a09a9f8b6b339eaf3271/BINDING_IMPL_NOTES.md?plain=1#L125-L158

Constant Summary collapse

RESULT_CODE = 
{
  ddwaf_ok: :ok,
  ddwaf_match: :match,
  ddwaf_err_internal: :err_internal,
  ddwaf_err_invalid_object: :err_invalid_object,
  ddwaf_err_invalid_argument: :err_invalid_argument
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(handle) ⇒ Context

Returns a new instance of Context.

Raises:


19
20
21
22
23
24
25
26
27
 
# File 'lib/datadog/appsec/waf/context.rb', line 19

def initialize(handle)
  handle_obj = handle.handle_obj
  retain(handle)

  @context_obj = LibDDWAF.ddwaf_context_init(handle_obj)
  raise LibDDWAF::Error, 'Could not create context' if @context_obj.null?

  validate!
end

Instance Attribute Details

#context_obj ⇒ Object (readonly)

Returns the value of attribute context_obj.


17
18
19
 
# File 'lib/datadog/appsec/waf/context.rb', line 17

def context_obj
  @context_obj
end

Instance Method Details

#finalize ⇒ Object 


29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/datadog/appsec/waf/context.rb', line 29

def finalize
  invalidate!

  retained.each do |retained_obj|
    next unless retained_obj.is_a?(LibDDWAF::Object)

    LibDDWAF.ddwaf_object_free(retained_obj)
  end

  retained.clear
  LibDDWAF.ddwaf_context_destroy(context_obj)
end

#run(persistent_data, ephemeral_data, timeout = LibDDWAF::DDWAF_RUN_TIMEOUT) ⇒ Object 


42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/datadog/appsec/waf/context.rb', line 42

def run(persistent_data, ephemeral_data, timeout = LibDDWAF::DDWAF_RUN_TIMEOUT)
  valid!

  persistent_data_obj = Converter.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?
    raise LibDDWAF::Error, "Could not convert persistent data: #{persistent_data.inspect}"
  end

  # retain C objects in memory for subsequent calls to run
  retain(persistent_data_obj)

  ephemeral_data_obj = Converter.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?
    raise LibDDWAF::Error, "Could not convert ephemeral data: #{ephemeral_data.inspect}"
  end

  result_obj = LibDDWAF::Result.new
  raise LibDDWAF::Error, 'Could not create result object' if result_obj.null?

  code = LibDDWAF.ddwaf_run(@context_obj, persistent_data_obj, ephemeral_data_obj, result_obj, timeout)

  result = Result.new(
    RESULT_CODE[code],
    Converter.object_to_ruby(result_obj[:events]),
    result_obj[:total_runtime],
    result_obj[:timeout],
    Converter.object_to_ruby(result_obj[:actions]),
    Converter.object_to_ruby(result_obj[:derivatives])
  )

  [RESULT_CODE[code], result]
ensure
  LibDDWAF.ddwaf_result_free(result_obj) if result_obj
  LibDDWAF.ddwaf_object_free(ephemeral_data_obj) if ephemeral_data_obj
end