11700203074

Committed 06 Nov 2024 08:52AM UTC coverage: 64.683% (+0.007%) from 64.676%

Build # 11700203074

Build Type

Pull #14825

github

Committed by

web-flow

Commit Message

Merge b4c420da7 into 33cdb2c5c

Pull Request Pull Request #14825: rec: rec_control top* cleanup

Run Details

37422 of 88708 branches covered (42.19%)

Branch coverage included in aggregate %.

0 of 41 new or added lines in 1 file covered. (0.0%)

40 existing lines in 10 files now uncovered.

125761 of 163573 relevant lines covered (76.88%)

4855407.35 hits per line

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

43.87

/pdns/recursordist/rec-system-resolve.cc

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

#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <netdb.h>
#include <arpa/nameser.h>
#include <resolv.h>

#include "dnsparser.hh"
#include "dnsrecords.hh"
#include "rec-system-resolve.hh"
#include "logging.hh"
#include "noinitvector.hh"
#include "threadname.hh"

namespace
{
ComboAddress resolve(const std::string& name)
{
  struct addrinfo hints = {};
  hints.ai_flags = AI_ADDRCONFIG;
  hints.ai_family = 0;

  struct addrinfo* res0 = nullptr;
  auto ret = getaddrinfo(name.c_str(), nullptr, &hints, &res0);
  // We pick the first address after sorting for now, no handling of multiple addresses or AF selection.
  vector<ComboAddress> vec;
  if (ret != 0) {
    return {};
  }
  auto* res = res0;
  while (res != nullptr) {
    try {
      auto address = ComboAddress{res->ai_addr, res->ai_addrlen};
      vec.emplace_back(address);
    }
    catch (...) {
    }
    res = res->ai_next;
  }
  freeaddrinfo(res0);
  if (!vec.empty()) {
    std::sort(vec.begin(), vec.end());
    return vec.at(0);
  }
  return {};
}

PacketBuffer resolve(const string& name, QClass cls, QType type)
{
  PacketBuffer answer(512);
  auto ret = res_query(name.c_str(), cls, type, answer.data(), static_cast<int>(answer.size()));
  if (ret == -1) {
    answer.resize(0);
  }
  else {
    answer.resize(ret);
  }
  return answer;
}

// do a id.server/CH/TXT query
std::string serverID()
{
  auto buffer = resolve("id.server", QClass::CHAOS, QType::TXT);
  if (buffer.empty()) {
    return {};
  }

  MOADNSParser parser(false, static_cast<const char*>(static_cast<void*>(buffer.data())), buffer.size());
  if (parser.d_header.rcode != RCode::NoError || parser.d_answers.size() != 1) {
    return {};
  }
  const auto& dnsrecord = parser.d_answers.at(0);
  if (dnsrecord.d_type == QType::TXT) {
    if (auto txt = getRR<TXTRecordContent>(dnsrecord); txt != nullptr) {
      const auto& text = txt->d_text;
      if (text.size() >= 2 && text.at(0) == '"' && text.at(text.size() - 1) == '"') {
        // remove quotes around text
        return txt->d_text.substr(1, txt->d_text.size() - 2);
      }
      return txt->d_text;
    }
  }
  return {};
}
} // anonymous namespace

// RecResolve class members.
std::string pdns::RecResolve::s_serverID;
time_t pdns::RecResolve::s_ttl{0};
time_t pdns::RecResolve::s_interval{0};
std::function<void()> pdns::RecResolve::s_callback;
bool pdns::RecResolve::s_selfResolveCheck{false};

void pdns::RecResolve::setInstanceParameters(std::string serverID, time_t ttl, time_t interval, bool selfResolveCheck, const std::function<void()>& callback)
{
  pdns::RecResolve::s_serverID = std::move(serverID);
  pdns::RecResolve::s_ttl = ttl;
  pdns::RecResolve::s_interval = interval;
  pdns::RecResolve::s_selfResolveCheck = selfResolveCheck;
  pdns::RecResolve::s_callback = callback;
}

pdns::RecResolve& pdns::RecResolve::getInstance()
{
  static unique_ptr<RecResolve> res = make_unique<pdns::RecResolve>(s_ttl, s_interval, s_selfResolveCheck, s_callback);
  return *res;
}

pdns::RecResolve::RecResolve(time_t ttl, time_t interval, bool selfResolveCheck, const std::function<void()>& callback) :
  d_ttl(ttl), d_refresher(interval, callback, selfResolveCheck, *this)
{
}

pdns::RecResolve::~RecResolve() = default;

void pdns::RecResolve::stopRefresher()
{
  d_refresher.finish();
}

void pdns::RecResolve::startRefresher()
{
  d_refresher.start();
}

ComboAddress pdns::RecResolve::lookupAndRegister(const std::string& name, time_t now)
{
  if (s_ttl == 0) {
    throw PDNSException("config tried to resolve `" + name + "' but system resolver feature not enabled");
  }
  auto data = d_data.lock();
  if (auto iter = data->d_map.find(name); iter != data->d_map.end()) {
    if (iter->second.d_ttd < now) {
      return iter->second.d_address;
    }
    // If it's stale, re-resolve below
  }
  // We keep the lock while resolving, even though this might take a while...
  auto address = resolve(name);

  time_t ttd = now + d_ttl;
  auto iter = data->d_map.emplace(name, AddressData{address, ttd}).first;
  return iter->second.d_address;
}

ComboAddress pdns::RecResolve::lookup(const std::string& name)
{
  auto data = d_data.lock();
  if (auto iter = data->d_map.find(name); iter != data->d_map.end()) {
    // always return it, even if it's stale
    return iter->second.d_address;
  }
  throw PDNSException("system resolve of unregistered name: " + name);
}

void pdns::RecResolve::wipe(const string& name)
{
  auto data = d_data.lock();
  if (name.empty()) {
    data->d_map.clear();
  }
  else {
    data->d_map.erase(name);
  }
}

bool pdns::RecResolve::refresh(time_t now)
{
  // The refresh task should not take the lock for a long time, so we're working on a copy
  ResolveData copy;
  {
    auto data = d_data.lock();
    copy = *data;
  }
  std::map<std::string, AddressData> newData;

  auto log = g_slog->withName("system-resolver");

  bool updated = false;
  for (const auto& entry : copy.d_map) {
    if (entry.second.d_ttd <= now) {
      auto newAddress = resolve(entry.first);
      time_t ttd = now;
      if (newAddress != ComboAddress()) {
        // positive resolve, good for ttl
        ttd += d_ttl;
      }
      else {
        log->error(Logr::Error, "Name did not resolve", "name", Logging::Loggable(entry.first));
      }
      if (newAddress != entry.second.d_address) {
        log->info(Logr::Debug, "Name resolved to new address",
                  "name", Logging::Loggable(entry.first),
                  "address", Logging::Loggable(newAddress.toString()));
        // An address changed
        updated = true;
      }
      newData.emplace(entry.first, AddressData{newAddress, ttd});
    }
  }

  if (!newData.empty()) {
    auto data = d_data.lock();
    for (const auto& entry : newData) {
      data->d_map.insert_or_assign(entry.first, entry.second);
    }
  }
  if (updated) {
    log->info(Logr::Info, "Changes in names detected");
  }
  return updated;
}

pdns::RecResolve::Refresher::Refresher(time_t interval, const std::function<void()>& callback, bool selfResolveCheck, pdns::RecResolve& res) :
  d_resolver(res), d_callback(callback), d_interval(std::max(static_cast<time_t>(1), interval)), d_selfResolveCheck(selfResolveCheck)
{
  start();
}

pdns::RecResolve::Refresher::~Refresher()
{
  finish();
}

void pdns::RecResolve::Refresher::refreshLoop()
{
  setThreadName("rec/sysres");
  time_t lastSelfCheck = 0;

  while (!stop) {
    const time_t startTime = time(nullptr);
    time_t wakeTime = startTime;
    // The expresion wakeTime - startTime is equal to the total amount of time slept
    while (wakeTime - startTime < d_interval) {
      std::unique_lock lock(mutex);
      time_t remaining = d_interval - (wakeTime - startTime);
      if (remaining <= 0) {
        break;
      }
      condVar.wait_for(lock, std::chrono::seconds(remaining),
                       [&doWakeup = wakeup] { return doWakeup.load(); });
      wakeup = false;
      if (stop) {
        break;
      }
      if (d_selfResolveCheck && lastSelfCheck < time(nullptr) - 3600) {
        lastSelfCheck = time(nullptr);
        auto resolvedServerID = serverID();
        if (resolvedServerID == s_serverID) {
          auto log = g_slog->withName("system-resolver");
          log->info(Logr::Error, "id.server/CH/TXT resolves to my own server identity", "id.server", Logging::Loggable(resolvedServerID));
        }
      }
      bool changes = d_resolver.refresh(time(nullptr));
      wakeTime = time(nullptr);
      if (changes) {
        d_callback();
      }
    }
  }
}

void pdns::RecResolve::Refresher::finish()
{
  stop = true;
  wakeup = true;
  condVar.notify_one();
  d_thread.join();
}

void pdns::RecResolve::Refresher::start()
{
  stop = false;
  wakeup = false;
  d_thread = std::thread([this]() { refreshLoop(); });
}

void pdns::RecResolve::Refresher::trigger()
{
  stop = true;
  wakeup = true;
  condVar.notify_one();
}

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 <sys/types.h>
24	#include <sys/socket.h>
25	#include <netinet/in.h>
26	#include <netdb.h>
27	#include <arpa/nameser.h>
28	#include <resolv.h>
29
30	#include "dnsparser.hh"
31	#include "dnsrecords.hh"
32	#include "rec-system-resolve.hh"
33	#include "logging.hh"
34	#include "noinitvector.hh"
35	#include "threadname.hh"
36
37	namespace
38	{
39	ComboAddress resolve(const std::string& name)
40	{	5✔
41	struct addrinfo hints = {};	5✔
42	hints.ai_flags = AI_ADDRCONFIG;	5✔
43	hints.ai_family = 0;	5✔
44
45	struct addrinfo* res0 = nullptr;	5✔
46	auto ret = getaddrinfo(name.c_str(), nullptr, &hints, &res0);	5✔
47	// We pick the first address after sorting for now, no handling of multiple addresses or AF selection.
48	vector<ComboAddress> vec;	5✔
49	if (ret != 0) {	5!
50	return {};	×
51	}	×
52	auto* res = res0;	5✔
53	while (res != nullptr) {	53✔
54	try {	48✔
55	auto address = ComboAddress{res->ai_addr, res->ai_addrlen};	48✔
56	vec.emplace_back(address);	48✔
57	}	48✔
58	catch (...) {	48✔
59	}	×
60	res = res->ai_next;	48✔
61	}	48✔
62	freeaddrinfo(res0);	5✔
63	if (!vec.empty()) {	5!
64	std::sort(vec.begin(), vec.end());	5✔
65	return vec.at(0);	5✔
66	}	5✔
67	return {};	×
68	}	5✔
69
70	PacketBuffer resolve(const string& name, QClass cls, QType type)
71	{	×
72	PacketBuffer answer(512);	×
73	auto ret = res_query(name.c_str(), cls, type, answer.data(), static_cast<int>(answer.size()));	×
74	if (ret == -1) {	×
75	answer.resize(0);	×
76	}	×
77	else {	×
78	answer.resize(ret);	×
79	}	×
80	return answer;	×
81	}	×
82
83	// do a id.server/CH/TXT query
84	std::string serverID()
85	{	×
86	auto buffer = resolve("id.server", QClass::CHAOS, QType::TXT);	×
87	if (buffer.empty()) {	×
88	return {};	×
89	}	×
90
91	MOADNSParser parser(false, static_cast<const char>(static_cast<void>(buffer.data())), buffer.size());	×
92	if (parser.d_header.rcode != RCode::NoError \|\| parser.d_answers.size() != 1) {	×
93	return {};	×
94	}	×
95	const auto& dnsrecord = parser.d_answers.at(0);	×
96	if (dnsrecord.d_type == QType::TXT) {	×
97	if (auto txt = getRR<TXTRecordContent>(dnsrecord); txt != nullptr) {	×
98	const auto& text = txt->d_text;	×
99	if (text.size() >= 2 && text.at(0) == '"' && text.at(text.size() - 1) == '"') {	×
100	// remove quotes around text
101	return txt->d_text.substr(1, txt->d_text.size() - 2);	×
102	}	×
103	return txt->d_text;	×
104	}	×
105	}	×
106	return {};	×
107	}	×
108	} // anonymous namespace
109
110	// RecResolve class members.
111	std::string pdns::RecResolve::s_serverID;
112	time_t pdns::RecResolve::s_ttl{0};
113	time_t pdns::RecResolve::s_interval{0};
114	std::function<void()> pdns::RecResolve::s_callback;
115	bool pdns::RecResolve::s_selfResolveCheck{false};
116
117	void pdns::RecResolve::setInstanceParameters(std::string serverID, time_t ttl, time_t interval, bool selfResolveCheck, const std::function<void()>& callback)
118	{	3✔
119	pdns::RecResolve::s_serverID = std::move(serverID);	3✔
120	pdns::RecResolve::s_ttl = ttl;	3✔
121	pdns::RecResolve::s_interval = interval;	3✔
122	pdns::RecResolve::s_selfResolveCheck = selfResolveCheck;	3✔
123	pdns::RecResolve::s_callback = callback;	3✔
124	}	3✔
125
126	pdns::RecResolve& pdns::RecResolve::getInstance()
127	{	5✔
128	static unique_ptr<RecResolve> res = make_unique<pdns::RecResolve>(s_ttl, s_interval, s_selfResolveCheck, s_callback);	5✔
129	return *res;	5✔
130	}	5✔
131
132	pdns::RecResolve::RecResolve(time_t ttl, time_t interval, bool selfResolveCheck, const std::function<void()>& callback) :
133	d_ttl(ttl), d_refresher(interval, callback, selfResolveCheck, *this)
134	{	3✔
135	}	3✔
136
137	pdns::RecResolve::~RecResolve() = default;	2✔
138
139	void pdns::RecResolve::stopRefresher()
140	{	×
141	d_refresher.finish();	×
142	}	×
143
144	void pdns::RecResolve::startRefresher()
145	{	×
146	d_refresher.start();	×
147	}	×
148
149	ComboAddress pdns::RecResolve::lookupAndRegister(const std::string& name, time_t now)
150	{	5✔
151	if (s_ttl == 0) {	5!
152	throw PDNSException("config tried to resolve `" + name + "' but system resolver feature not enabled");	×
153	}	×
154	auto data = d_data.lock();	5✔
155	if (auto iter = data->d_map.find(name); iter != data->d_map.end()) {	5!
156	if (iter->second.d_ttd < now) {	×
157	return iter->second.d_address;	×
158	}	×
159	// If it's stale, re-resolve below
160	}	×
161	// We keep the lock while resolving, even though this might take a while...
162	auto address = resolve(name);	5✔
163
164	time_t ttd = now + d_ttl;	5✔
165	auto iter = data->d_map.emplace(name, AddressData{address, ttd}).first;	5✔
166	return iter->second.d_address;	5✔
167	}	5✔
168
169	ComboAddress pdns::RecResolve::lookup(const std::string& name)
170	{	4✔
171	auto data = d_data.lock();	4✔
172	if (auto iter = data->d_map.find(name); iter != data->d_map.end()) {	4✔
173	// always return it, even if it's stale
174	return iter->second.d_address;	2✔
175	}	2✔
176	throw PDNSException("system resolve of unregistered name: " + name);	2✔
177	}	4✔
178
179	void pdns::RecResolve::wipe(const string& name)
180	{	2✔
181	auto data = d_data.lock();	2✔
182	if (name.empty()) {	2!
183	data->d_map.clear();	×
184	}	×
185	else {	2✔
186	data->d_map.erase(name);	2✔
187	}	2✔
188	}	2✔
189
190	bool pdns::RecResolve::refresh(time_t now)
UNCOV 191	{	×
192	// The refresh task should not take the lock for a long time, so we're working on a copy
UNCOV 193	ResolveData copy;	×
UNCOV 194	{	×
UNCOV 195	auto data = d_data.lock();	×
UNCOV 196	copy = *data;	×
UNCOV 197	}	×
UNCOV 198	std::map<std::string, AddressData> newData;	×
199
UNCOV 200	auto log = g_slog->withName("system-resolver");	×
201
UNCOV 202	bool updated = false;	×
UNCOV 203	for (const auto& entry : copy.d_map) {	×
204	if (entry.second.d_ttd <= now) {	×
205	auto newAddress = resolve(entry.first);	×
206	time_t ttd = now;	×
207	if (newAddress != ComboAddress()) {	×
208	// positive resolve, good for ttl
209	ttd += d_ttl;	×
210	}	×
211	else {	×
212	log->error(Logr::Error, "Name did not resolve", "name", Logging::Loggable(entry.first));	×
213	}	×
214	if (newAddress != entry.second.d_address) {	×
215	log->info(Logr::Debug, "Name resolved to new address",	×
216	"name", Logging::Loggable(entry.first),	×
217	"address", Logging::Loggable(newAddress.toString()));	×
218	// An address changed
219	updated = true;	×
220	}	×
221	newData.emplace(entry.first, AddressData{newAddress, ttd});	×
222	}	×
223	}	×
224
UNCOV 225	if (!newData.empty()) {	×
226	auto data = d_data.lock();	×
227	for (const auto& entry : newData) {	×
228	data->d_map.insert_or_assign(entry.first, entry.second);	×
229	}	×
230	}	×
UNCOV 231	if (updated) {	×
232	log->info(Logr::Info, "Changes in names detected");	×
233	}	×
UNCOV 234	return updated;	×
UNCOV 235	}	×
236
237	pdns::RecResolve::Refresher::Refresher(time_t interval, const std::function<void()>& callback, bool selfResolveCheck, pdns::RecResolve& res) :
238	d_resolver(res), d_callback(callback), d_interval(std::max(static_cast<time_t>(1), interval)), d_selfResolveCheck(selfResolveCheck)
239	{	3✔
240	start();	3✔
241	}	3✔
242
243	pdns::RecResolve::Refresher::~Refresher()
244	{	2✔
245	finish();	2✔
246	}	2✔
247
248	void pdns::RecResolve::Refresher::refreshLoop()
249	{	3✔
250	setThreadName("rec/sysres");	3✔
251	time_t lastSelfCheck = 0;	3✔
252
253	while (!stop) {	6✔
254	const time_t startTime = time(nullptr);	3✔
255	time_t wakeTime = startTime;	3✔
256	// The expresion wakeTime - startTime is equal to the total amount of time slept
257	while (wakeTime - startTime < d_interval) {	4✔
258	std::unique_lock lock(mutex);	3✔
259	time_t remaining = d_interval - (wakeTime - startTime);	3✔
260	if (remaining <= 0) {	3!
261	break;	×
262	}	×
263	condVar.wait_for(lock, std::chrono::seconds(remaining),	3✔
264	[&doWakeup = wakeup] { return doWakeup.load(); });	5✔
265	wakeup = false;	3✔
266	if (stop) {	3✔
267	break;	2✔
268	}	2✔
269	if (d_selfResolveCheck && lastSelfCheck < time(nullptr) - 3600) {	1!
270	lastSelfCheck = time(nullptr);	×
271	auto resolvedServerID = serverID();	×
272	if (resolvedServerID == s_serverID) {	×
273	auto log = g_slog->withName("system-resolver");	×
274	log->info(Logr::Error, "id.server/CH/TXT resolves to my own server identity", "id.server", Logging::Loggable(resolvedServerID));	×
275	}	×
276	}	×
277	bool changes = d_resolver.refresh(time(nullptr));	1✔
278	wakeTime = time(nullptr);	1✔
279	if (changes) {	1!
280	d_callback();	×
281	}	×
282	}	1✔
283	}	3✔
284	}	3✔
285
286	void pdns::RecResolve::Refresher::finish()
287	{	2✔
288	stop = true;	2✔
289	wakeup = true;	2✔
290	condVar.notify_one();	2✔
291	d_thread.join();	2✔
292	}	2✔
293
294	void pdns::RecResolve::Refresher::start()
295	{	3✔
296	stop = false;	3✔
297	wakeup = false;	3✔
298	d_thread = std::thread([this]() { refreshLoop(); });	3✔
299	}	3✔
300
301	void pdns::RecResolve::Refresher::trigger()
302	{	×
303	stop = true;	×
304	wakeup = true;	×
305	condVar.notify_one();	×
306	}	×

PowerDNS / pdns / 11700203074

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

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