libddwaf-src 2.0.1

Source distribution and build integration for DataDog/libddwaf
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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
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
89
90
91
92
93

// 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.

#pragma once

#include <cstdint>
#include <optional>
#include <string>
#include <string_view>
#include <unordered_map>
#include <variant>
#include <vector>

#include "clock.hpp"
#include "context_allocator.hpp"
#include "dynamic_string.hpp"
#include "exclusion/common.hpp"
#include "matcher/base.hpp"
#include "object.hpp"
#include "object_store.hpp"
#include "target_address.hpp"
#include "transformer/base.hpp"

namespace ddwaf {

enum class data_source : uint8_t { values, keys, object };

struct condition_match {
    struct argument {
        std::string_view name;
        dynamic_string resolved;
        std::string_view address{};
        std::vector<std::variant<std::string_view, int64_t>> key_path{};
    };

    std::vector<argument> args;
    std::vector<dynamic_string> highlights;
    std::string_view operator_name;
    std::string_view operator_value;
};

struct condition_cache {
    // Stores the pointer to the object of the i-th target of the condition,
    // used in the previous evaluation. This ensures that the evaluation of
    // the condition can be skipped for the same object in the future.
    memory::vector<object_cache_key> targets;
    std::optional<condition_match> match;
};

// Provides the specification of a specific operator parameter. Note that the
// type of the parameter is inferred at compile type.
struct parameter_specification {
    std::string_view name;
    bool variadic{false};
    bool optional{false};
};

// Provides the definition of an individual address(target) to parameter mapping.
// Each target must satisfy the associated parameter specification.
struct condition_target {
    std::string name;
    target_index index{};
    std::vector<std::variant<std::string, int64_t>> key_path{};
    std::vector<transformer_id> transformers{};
    data_source source{data_source::values};
};

// Provides the list of targets mapped to the given condition parameter. If the
// parameter is non-variadic, only one mapping should be present.
struct condition_parameter {
    std::vector<condition_target> targets;
};

class base_condition {
public:
    base_condition() = default;
    virtual ~base_condition() = default;
    base_condition(const base_condition &) = default;
    base_condition &operator=(const base_condition &) = default;
    base_condition(base_condition &&) = default;
    base_condition &operator=(base_condition &&) = default;

    virtual bool eval(condition_cache &cache, const object_store &store,
        const object_set_ref &objects_excluded, const matcher_mapper &dynamic_matchers,
        ddwaf::timer &deadline) const = 0;

    virtual void get_addresses(std::unordered_map<target_index, std::string> &addresses) const = 0;
};

} // namespace ddwaf