summaryrefslogtreecommitdiffstats
path: root/dnsdist-protobuf.hh
blob: c2dee817daf37526ffc3358790adb204c49f4c7f (plain)
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
/*
 * This file is part of PowerDNS or dnsdist.
 * Copyright -- PowerDNS.COM B.V. and its contributors
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * In addition, for the avoidance of any doubt, permission is granted to
 * link this program with OpenSSL and to (re)distribute the binaries
 * produced as the result of such linking.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
#pragma once

#include "dnsdist.hh"
#include "dnsname.hh"

#ifndef DISABLE_PROTOBUF
#include "protozero.hh"

class DNSDistProtoBufMessage
{
public:
  DNSDistProtoBufMessage(const DNSQuestion& dnsquestion);
  DNSDistProtoBufMessage(const DNSResponse& dnsresponse, bool includeCNAME);
  DNSDistProtoBufMessage(const DNSQuestion&&) = delete;
  DNSDistProtoBufMessage(const DNSResponse&&, bool) = delete;

  void setServerIdentity(const std::string& serverId);
  void setRequestor(const ComboAddress& requestor);
  void setResponder(const ComboAddress& responder);
  void setRequestorPort(uint16_t port);
  void setResponderPort(uint16_t port);
  void setResponseCode(uint8_t rcode);
  void setType(pdns::ProtoZero::Message::MessageType type);
  void setHTTPVersion(pdns::ProtoZero::Message::HTTPVersion version);
  void setBytes(size_t bytes);
  void setTime(time_t sec, uint32_t usec);
  void setQueryTime(time_t sec, uint32_t usec);
  void setQuestion(const DNSName& name, uint16_t qtype, uint16_t qclass);
  void setEDNSSubnet(const Netmask& netmask);

  void addTag(const std::string& strValue);
  void addMeta(const std::string& key, std::vector<std::string>&& strValues, const std::vector<int64_t>& intValues);
  void addRR(DNSName&& qname, uint16_t uType, uint16_t uClass, uint32_t uTTL, const std::string& data);

  void serialize(std::string& data) const;

  [[nodiscard]] std::string toDebugString() const;

private:
  struct PBRecord
  {
    DNSName d_name;
    std::string d_data;
    uint32_t d_ttl;
    uint16_t d_type;
    uint16_t d_class;
  };
  struct PBQuestion
  {
    PBQuestion(DNSName name, uint16_t type, uint16_t class_) :
      d_name(std::move(name)), d_type(type), d_class(class_)
    {
    }

    DNSName d_name;
    uint16_t d_type;
    uint16_t d_class;
  };

  std::vector<PBRecord> d_additionalRRs;
  std::vector<std::string> d_additionalTags;
  struct MetaValue
  {
    std::unordered_set<std::string> d_strings;
    std::unordered_set<int64_t> d_integers;
  };
  std::unordered_map<std::string, MetaValue> d_metaTags;

  // NOLINTNEXTLINE(cppcoreguidelines-avoid-const-or-ref-data-members)
  const DNSQuestion& d_dq;
  const DNSResponse* d_dr{nullptr};
  const std::string* d_ServerIdentityRef{nullptr};

  boost::optional<PBQuestion> d_question{boost::none};
  boost::optional<std::string> d_serverIdentity{boost::none};
  boost::optional<ComboAddress> d_requestor{boost::none};
  boost::optional<ComboAddress> d_responder{boost::none};
  boost::optional<Netmask> d_ednsSubnet{boost::none};
  boost::optional<std::pair<time_t, uint32_t>> d_time{boost::none};
  boost::optional<std::pair<time_t, uint32_t>> d_queryTime{boost::none};
  boost::optional<size_t> d_bytes{boost::none};
  boost::optional<uint8_t> d_rcode{boost::none};

  pdns::ProtoZero::Message::MessageType d_type{pdns::ProtoZero::Message::MessageType::DNSQueryType};
  bool d_includeCNAME{false};
};

class ProtoBufMetaKey
{
  enum class Type : uint8_t
  {
    SNI,
    Pool,
    B64Content,
    DoHHeader,
    DoHHost,
    DoHPath,
    DoHQueryString,
    DoHScheme,
    ProxyProtocolValue,
    ProxyProtocolValues,
    Tag,
    Tags
  };

  struct KeyTypeDescription
  {
    // NOLINTNEXTLINE(cppcoreguidelines-avoid-const-or-ref-data-members)
    const std::string d_name;
    // NOLINTNEXTLINE(cppcoreguidelines-avoid-const-or-ref-data-members)
    const Type d_type;
    // NOLINTNEXTLINE(cppcoreguidelines-avoid-const-or-ref-data-members)
    const std::function<std::vector<std::string>(const DNSQuestion&, const std::string&, uint8_t)> d_func;
    bool d_prefix{false};
    bool d_caseSensitive{true};
    bool d_numeric{false};
  };

  struct NameTag
  {
  };
  struct TypeTag
  {
  };

  using TypeContainer = boost::multi_index_container<
    KeyTypeDescription,
    indexed_by<
      hashed_unique<tag<NameTag>, member<KeyTypeDescription, const std::string, &KeyTypeDescription::d_name>>,
      hashed_unique<tag<TypeTag>, member<KeyTypeDescription, const Type, &KeyTypeDescription::d_type>>>>;

  static const TypeContainer s_types;

public:
  ProtoBufMetaKey(const std::string& key);

  [[nodiscard]] const std::string& getName() const;
  [[nodiscard]] std::vector<std::string> getValues(const DNSQuestion& dnsquestion) const;

private:
  std::string d_subKey;
  uint8_t d_numericSubKey{0};
  Type d_type;
};

#endif /* DISABLE_PROTOBUF */