Class: Datadog::AppSec::SecurityEngine::Runner

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog/appsec/security_engine/runner.rb

Overview

A class that check input via security engine (WAF) and respond with result.

Constant Summary collapse

SUCCESSFUL_EXECUTION_CODES = 
[:ok, :match].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(handle_ref, ruleset_version:) ⇒ Runner

Returns a new instance of Runner.



14
15
16
17
18
19
20
21
 
# File 'lib/datadog/appsec/security_engine/runner.rb', line 14

def initialize(handle_ref, ruleset_version:)
  @mutex = Mutex.new
  @handle_ref = handle_ref
  @waf_handle = handle_ref.acquire
  @ruleset_version = ruleset_version

  @debug_tag = "libddwaf:#{WAF::VERSION::STRING} method:ddwaf_run"
end

Instance Attribute Details

#ruleset_version ⇒ Object (readonly)

Returns the value of attribute ruleset_version.



12
13
14
 
# File 'lib/datadog/appsec/security_engine/runner.rb', line 12

def ruleset_version
  @ruleset_version
end

Instance Method Details

#finalize! ⇒ Object 



69
70
71
72
73
 
# File 'lib/datadog/appsec/security_engine/runner.rb', line 69

def finalize!
  @waf_context&.finalize!
ensure
  @handle_ref.release(@waf_handle)
end

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



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/datadog/appsec/security_engine/runner.rb', line 23

def run(persistent_data, ephemeral_data, timeout = WAF::LibDDWAF::DDWAF_RUN_TIMEOUT)
  @mutex.lock

  start_ns = Core::Utils::Time.get_time(:nanosecond)
  persistent_data.reject! do |_, v|
    next false if v.is_a?(TrueClass) || v.is_a?(FalseClass)

    v.nil? || v.empty?
  end

  ephemeral_data.reject! do |_, v|
    next false if v.is_a?(TrueClass) || v.is_a?(FalseClass)

    v.nil? || v.empty?
  end

  result = try_run(persistent_data, ephemeral_data, timeout)
  stop_ns = Core::Utils::Time.get_time(:nanosecond)

  report_execution(result)

  unless SUCCESSFUL_EXECUTION_CODES.include?(result.status)
    return Result::Error.new(duration_ext_ns: stop_ns - start_ns)
  end

  klass = (result.status == :match) ? Result::Match : Result::Ok
  klass.new(
    events: result.events,
    actions: result.actions,
    derivatives: result.derivatives,
    timeout: result.timeout,
    duration_ns: result.total_runtime,
    duration_ext_ns: (stop_ns - start_ns)
  )
ensure
  @mutex.unlock
end

#waf_addresses ⇒ Object 



65
66
67
 
# File 'lib/datadog/appsec/security_engine/runner.rb', line 65

def waf_addresses
  @waf_handle.known_addresses
end

#waf_context ⇒ Object 



61
62
63
 
# File 'lib/datadog/appsec/security_engine/runner.rb', line 61

def waf_context
  @waf_context ||= @waf_handle.build_context
end