• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

PowerDNS / pdns / 19361445889

14 Nov 2025 10:17AM UTC coverage: 67.801% (-5.3%) from 73.081%
19361445889

Pull #16487

github

web-flow
Merge ced46313c into b1521115a
Pull Request #16487: chore: Switch from boost::optional to std::optional

32132 of 56078 branches covered (57.3%)

Branch coverage included in aggregate %.

585 of 633 new or added lines in 43 files covered. (92.42%)

10720 existing lines in 101 files now uncovered.

104875 of 145994 relevant lines covered (71.84%)

6847905.67 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

87.33
/pdns/proxy-protocol.cc
1
/*
2
 * This file is part of PowerDNS or dnsdist.
3
 * Copyright -- PowerDNS.COM B.V. and its contributors
4
 *
5
 * This program is free software; you can redistribute it and/or modify
6
 * it under the terms of version 2 of the GNU General Public License as
7
 * published by the Free Software Foundation.
8
 *
9
 * In addition, for the avoidance of any doubt, permission is granted to
10
 * link this program with OpenSSL and to (re)distribute the binaries
11
 * produced as the result of such linking.
12
 *
13
 * This program is distributed in the hope that it will be useful,
14
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16
 * GNU General Public License for more details.
17
 *
18
 * You should have received a copy of the GNU General Public License
19
 * along with this program; if not, write to the Free Software
20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21
 */
22

23
#include "proxy-protocol.hh"
24

25
// TODO: maybe use structs instead of explicitly working byte by byte, like https://github.com/dovecot/core/blob/master/src/lib-master/master-service-haproxy.c
26

27
#define PROXYMAGIC "\x0D\x0A\x0D\x0A\x00\x0D\x0A\x51\x55\x49\x54\x0A"
28
#define PROXYMAGICLEN sizeof(PROXYMAGIC)-1
29

30
static const string proxymagic(PROXYMAGIC, PROXYMAGICLEN);
31

32
static void makeSimpleHeader(uint8_t command, uint8_t protocol, uint16_t contentLen, size_t additionalSize, std::string& out)
33
{
74✔
34
  const uint8_t versioncommand = (0x20 | command);
74✔
35
  const size_t totalSize = proxymagic.size() + sizeof(versioncommand) + sizeof(protocol) + sizeof(contentLen) + additionalSize;
74✔
36
  if (out.capacity() < totalSize) {
74!
37
    out.reserve(totalSize);
74✔
38
  }
74✔
39

40
  out.append(proxymagic);
74✔
41

42
  out.append(reinterpret_cast<const char*>(&versioncommand), sizeof(versioncommand));
74✔
43
  out.append(reinterpret_cast<const char*>(&protocol), sizeof(protocol));
74✔
44

45
  out.append(reinterpret_cast<const char*>(&contentLen), sizeof(contentLen));
74✔
46
}
74✔
47

48
std::string makeLocalProxyHeader()
49
{
4✔
50
  std::string out;
4✔
51
  makeSimpleHeader(0x00, 0, 0, 0, out);
4✔
52
  return out;
4✔
53
}
4✔
54

55
std::string makeProxyHeader(bool tcp, const ComboAddress& source, const ComboAddress& destination, const std::vector<ProxyProtocolValue>& values)
56
{
74✔
57
  if (source.sin4.sin_family != destination.sin4.sin_family) {
74!
UNCOV
58
    throw std::runtime_error("The PROXY destination and source addresses must be of the same family");
×
UNCOV
59
  }
×
60

61
  const uint8_t command = 0x01;
74✔
62
  const uint8_t protocol = (source.isIPv4() ? 0x10 : 0x20) | (tcp ? 0x01 : 0x02);
74✔
63
  const size_t addrSize = source.isIPv4() ? sizeof(source.sin4.sin_addr.s_addr) : sizeof(source.sin6.sin6_addr.s6_addr);
74✔
64
  const uint16_t sourcePort = source.sin4.sin_port;
74✔
65
  const uint16_t destinationPort = destination.sin4.sin_port;
74✔
66

67
  size_t valuesSize = 0;
74✔
68
  for (const auto& value : values) {
76✔
69
    if (value.content.size() > std::numeric_limits<uint16_t>::max()) {
42✔
70
      throw std::runtime_error("The size of proxy protocol values is limited to " + std::to_string(std::numeric_limits<uint16_t>::max()) + ", trying to add a value of size " + std::to_string(value.content.size()));
4✔
71
    }
4✔
72
    valuesSize += sizeof(uint8_t) + sizeof(uint8_t) * 2 + value.content.size();
38✔
73
    if (valuesSize > std::numeric_limits<uint16_t>::max()) {
38!
74
      throw std::runtime_error("The total size of proxy protocol values is limited to " + std::to_string(std::numeric_limits<uint16_t>::max()));
×
75
    }
×
76
  }
38✔
77

78
  /* size of the data that will come _after_ the minimal proxy protocol header */
79
  size_t additionalDataSize = (addrSize * 2) + sizeof(sourcePort) + sizeof(destinationPort) + valuesSize;
70✔
80
  if (additionalDataSize > std::numeric_limits<uint16_t>::max()) {
70!
81
    throw std::runtime_error("The size of a proxy protocol header is limited to " + std::to_string(std::numeric_limits<uint16_t>::max()) + ", trying to send one of size " + std::to_string(additionalDataSize));
×
82
  }
×
83

84
  const uint16_t contentlen = htons(static_cast<uint16_t>(additionalDataSize));
70✔
85
  std::string ret;
70✔
86
  makeSimpleHeader(command, protocol, contentlen, additionalDataSize, ret);
70✔
87

88
  // We already established source and destination sin_family equivalence
89
  if (source.isIPv4()) {
70✔
90
    assert(addrSize == sizeof(source.sin4.sin_addr.s_addr));
50!
91
    ret.append(reinterpret_cast<const char*>(&source.sin4.sin_addr.s_addr), addrSize);
49✔
92
    assert(addrSize == sizeof(destination.sin4.sin_addr.s_addr));
50!
93
    ret.append(reinterpret_cast<const char*>(&destination.sin4.sin_addr.s_addr), addrSize);
49✔
94
  }
50✔
95
  else {
20✔
96
    assert(addrSize == sizeof(source.sin6.sin6_addr.s6_addr));
20!
97
    ret.append(reinterpret_cast<const char*>(&source.sin6.sin6_addr.s6_addr), addrSize);
15✔
98
    assert(addrSize == sizeof(destination.sin6.sin6_addr.s6_addr));
20!
99
    ret.append(reinterpret_cast<const char*>(&destination.sin6.sin6_addr.s6_addr), addrSize);
15✔
100
  }
20✔
101

102
  ret.append(reinterpret_cast<const char*>(&sourcePort), sizeof(sourcePort));
64✔
103
  ret.append(reinterpret_cast<const char*>(&destinationPort), sizeof(destinationPort));
70✔
104

105
  for (const auto& value : values) {
72✔
106
    uint16_t contentSize = htons(static_cast<uint16_t>(value.content.size()));
38✔
107
    ret.append(reinterpret_cast<const char*>(&value.type), sizeof(value.type));
38✔
108
    ret.append(reinterpret_cast<const char*>(&contentSize), sizeof(contentSize));
38✔
109
    ret.append(reinterpret_cast<const char*>(value.content.data()), value.content.size());
38✔
110
  }
38✔
111

112
  return ret;
70✔
113
}
70✔
114

115
/* returns: number of bytes consumed (positive) after successful parse
116
         or number of bytes missing (negative)
117
         or unfixable parse error (0)*/
118
template<typename Container> ssize_t isProxyHeaderComplete(const Container& header, bool* proxy, bool* tcp, size_t* addrSizeOut, uint8_t* protocolOut)
119
{
260✔
120
  static const size_t addr4Size = sizeof(ComboAddress::sin4.sin_addr.s_addr);
260✔
121
  static const size_t addr6Size = sizeof(ComboAddress::sin6.sin6_addr.s6_addr);
260✔
122
  size_t addrSize = 0;
260✔
123
  uint8_t versioncommand;
260✔
124
  uint8_t protocol;
260✔
125

126
  if (header.size() < s_proxyProtocolMinimumHeaderSize) {
260✔
127
    // this is too short to be a complete proxy header
128
    return -(s_proxyProtocolMinimumHeaderSize - header.size());
38✔
129
  }
38✔
130

131
  if (std::memcmp(&header.at(0), &proxymagic.at(0), proxymagic.size()) != 0) {
222✔
132
    // wrong magic, can not be a proxy header
133
    return 0;
15✔
134
  }
15✔
135

136
  versioncommand = header.at(12);
207✔
137
  /* check version */
138
  if (!(versioncommand & 0x20)) {
207✔
139
    return 0;
4✔
140
  }
4✔
141

142
  /* remove the version to get the command */
143
  uint8_t command = versioncommand & ~0x20;
203✔
144

145
  if (command == 0x01) {
203!
146
    protocol = header.at(13);
189✔
147
    if ((protocol & 0xf) == 1) {
189✔
148
      if (tcp) {
92!
149
        *tcp = true;
19✔
150
      }
19✔
151
    } else if ((protocol & 0xf) == 2) {
100!
152
      if (tcp) {
93!
153
        *tcp = false;
57✔
154
      }
57✔
155
    } else {
93✔
156
      return 0;
4✔
157
    }
4✔
158

159
    protocol = protocol >> 4;
185✔
160

161
    if (protocol == 1) {
185✔
162
      if (protocolOut) {
119!
163
        *protocolOut = 4;
30✔
164
      }
30✔
165
      addrSize = addr4Size; // IPv4
119✔
166
    } else if (protocol == 2) {
127✔
167
      if (protocolOut) {
62!
168
        *protocolOut = 6;
42✔
169
      }
42✔
170
      addrSize = addr6Size; // IPv6
62✔
171
    } else {
62✔
172
      // invalid protocol
173
      return 0;
4✔
174
    }
4✔
175

176
    if (addrSizeOut) {
181✔
177
      *addrSizeOut = addrSize;
72✔
178
    }
72✔
179

180
    if (proxy) {
181!
181
      *proxy = true;
72✔
182
    }
72✔
183
  }
181✔
184
  else if (command == 0x00) {
14✔
185
    if (proxy) {
10!
186
      *proxy = false;
8✔
187
    }
8✔
188
  }
10✔
189
  else {
4✔
190
    /* unsupported command */
191
    return 0;
4✔
192
  }
4✔
193

194
  uint16_t contentlen = (static_cast<uint8_t>(header.at(14)) << 8) + static_cast<uint8_t>(header.at(15));
191✔
195
  uint16_t expectedlen = 0;
191✔
196
  if (command != 0x00) {
191!
197
    expectedlen = (addrSize * 2) + sizeof(ComboAddress::sin4.sin_port) + sizeof(ComboAddress::sin4.sin_port);
181✔
198
  }
181✔
199

200
  if (contentlen < expectedlen) {
191!
201
    return 0;
×
202
  }
×
203

204
  if (header.size() < s_proxyProtocolMinimumHeaderSize + contentlen) {
191✔
205
    return -((s_proxyProtocolMinimumHeaderSize + contentlen) - header.size());
89✔
206
  }
89✔
207

208
  return s_proxyProtocolMinimumHeaderSize + contentlen;
102✔
209
}
191✔
210

211
/* returns: number of bytes consumed (positive) after successful parse
212
         or number of bytes missing (negative)
213
         or unfixable parse error (0)*/
214
template<typename Container> ssize_t parseProxyHeader(const Container& header, bool& proxy, ComboAddress& source, ComboAddress& destination, bool& tcp, std::vector<ProxyProtocolValue>& values)
215
{
108✔
216
  size_t addrSize = 0;
108✔
217
  uint8_t protocol = 0;
108✔
218
  ssize_t got = isProxyHeaderComplete(header, &proxy, &tcp, &addrSize, &protocol);
108✔
219
  if (got <= 0) {
108!
220
    return got;
36✔
221
  }
36✔
222

223
  size_t pos = s_proxyProtocolMinimumHeaderSize;
72✔
224

225
  if (proxy) {
72!
226
    source = makeComboAddressFromRaw(protocol, reinterpret_cast<const char*>(&header.at(pos)), addrSize);
64✔
227
    pos = pos + addrSize;
64✔
228
    destination = makeComboAddressFromRaw(protocol, reinterpret_cast<const char*>(&header.at(pos)), addrSize);
64✔
229
    pos = pos + addrSize;
64✔
230
    source.setPort((static_cast<uint8_t>(header.at(pos)) << 8) + static_cast<uint8_t>(header.at(pos+1)));
64✔
231
    pos = pos + sizeof(uint16_t);
64✔
232
    destination.setPort((static_cast<uint8_t>(header.at(pos)) << 8) + static_cast<uint8_t>(header.at(pos+1)));
64✔
233
    pos = pos + sizeof(uint16_t);
64✔
234
  }
64✔
235

236
  size_t remaining = got - pos;
72✔
237
  while (remaining >= (sizeof(uint8_t) + sizeof(uint16_t))) {
148!
238
    /* we still have TLV values to parse */
239
    uint8_t type = static_cast<uint8_t>(header.at(pos));
80✔
240
    pos += sizeof(uint8_t);
80✔
241
    uint16_t len = (static_cast<uint8_t>(header.at(pos)) << 8) + static_cast<uint8_t>(header.at(pos + 1));
80✔
242
    pos += sizeof(uint16_t);
80✔
243

244
    if (len > 0) {
80!
245
      if (len > (got - pos)) {
80!
246
        return 0;
4✔
247
      }
4✔
248

249
      values.push_back({std::string(reinterpret_cast<const char*>(&header.at(pos)), len), type});
76✔
250
      pos += len;
76✔
251
    }
76✔
252
    else {
×
253
      values.push_back({"", type});
×
254
    }
×
255

256
    remaining = got - pos;
76✔
257
  }
76✔
258

259
  return pos;
68✔
260
}
72✔
261

262
#include "noinitvector.hh"
263
template ssize_t isProxyHeaderComplete<std::string>(const std::string& header, bool* proxy, bool* tcp, size_t* addrSizeOut, uint8_t* protocolOut);
264
template ssize_t isProxyHeaderComplete<PacketBuffer>(const PacketBuffer& header, bool* proxy, bool* tcp, size_t* addrSizeOut, uint8_t* protocolOut);
265
template ssize_t parseProxyHeader<std::string>(const std::string& header, bool& proxy, ComboAddress& source, ComboAddress& destination, bool& tcp, std::vector<ProxyProtocolValue>& values);
266
template ssize_t parseProxyHeader<PacketBuffer>(const PacketBuffer& header, bool& proxy, ComboAddress& source, ComboAddress& destination, bool& tcp, std::vector<ProxyProtocolValue>& values);
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc