16516817003

Committed 25 Jul 2025 07:50AM UTC coverage: 65.837% (+8.5%) from 57.372%

Build # 16516817003

Build Type

Pull #15922

github

Committed by

web-flow

Commit Message

Merge 8739789f8 into f566d2d35

Pull Request Pull Request #15922: miscellaneous boring cleanups

Run Details

42009 of 92374 branches covered (45.48%)

Branch coverage included in aggregate %.

51 of 68 new or added lines in 15 files covered. (75.0%)

12124 existing lines in 190 files now uncovered.

127803 of 165552 relevant lines covered (77.2%)

6106704.06 hits per line

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

59.46

/modules/lua2backend/lua2api2.hh

/*
 * 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
 * MERCHANTAPILITY 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 "boost/algorithm/string/join.hpp"
#include "pdns/arguments.hh"

#include "pdns/dnsbackend.hh"
#include "pdns/lua-auth4.hh"

class Lua2BackendAPIv2 : public DNSBackend, AuthLua4
{
private:
  typedef std::function<void()> init_call_t;
  typedef std::function<void()> deinit_call_t;

  typedef std::vector<std::pair<string, string>> lookup_context_t;

  typedef std::vector<std::pair<int, std::vector<std::pair<string, boost::variant<bool, int, DNSName, string, QType>>>>> lookup_result_t;
  typedef std::function<lookup_result_t(const QType& qtype, const DNSName& qname, domainid_t domain_id, const lookup_context_t& ctx)> lookup_call_t;

  typedef boost::variant<bool, lookup_result_t> list_result_t;
  typedef std::function<list_result_t(const DNSName& qname, domainid_t domain_id)> list_call_t;

  typedef vector<pair<string, boost::variant<bool, long, string, vector<string>>>> domaininfo_result_t;
  typedef boost::variant<bool, domaininfo_result_t> get_domaininfo_result_t;
  typedef vector<pair<DNSName, domaininfo_result_t>> get_all_domains_result_t;
  typedef std::function<get_domaininfo_result_t(const DNSName& domain)> get_domaininfo_call_t;
  typedef std::function<get_all_domains_result_t()> get_all_domains_call_t;

  typedef vector<pair<int, string>> domain_metadata_result_t;
  typedef boost::variant<bool, domain_metadata_result_t> get_domain_metadata_result_t;
  typedef boost::variant<bool, vector<pair<string, domain_metadata_result_t>>> get_all_domain_metadata_result_t;
  typedef std::function<get_domain_metadata_result_t(const DNSName& domain, const string& kind)> get_domain_metadata_call_t;
  typedef std::function<get_all_domain_metadata_result_t(const DNSName& domain)> get_all_domain_metadata_call_t;

  typedef vector<pair<string, boost::variant<bool, int, string>>> keydata_result_t;
  typedef boost::variant<bool, vector<pair<int, keydata_result_t>>> get_domain_keys_result_t;
  typedef std::function<get_domain_keys_result_t(const DNSName& domain)> get_domain_keys_call_t;

  typedef std::vector<std::pair<string, boost::variant<string, DNSName>>> before_and_after_names_result_t;
  typedef boost::variant<bool, before_and_after_names_result_t> get_before_and_after_names_absolute_result_t;
  typedef std::function<get_before_and_after_names_absolute_result_t(domainid_t id, const DNSName& qname)> get_before_and_after_names_absolute_call_t;

  typedef std::function<void(domainid_t, long)> set_notified_call_t;

  typedef std::function<string(const string& cmd)> direct_backend_cmd_call_t;

public:
  Lua2BackendAPIv2(const string& suffix)
  {
    d_include_path = ::arg()["lua-global-include-dir"];
    setArgPrefix("lua2" + suffix);
    d_debug_log = mustDo("query-logging");
    prepareContext();
    loadFile(getArg("filename"));
  }

  ~Lua2BackendAPIv2() override;

#define logCall(func, var)                                                                               \
  {                                                                                                      \
    if (d_debug_log) {                                                                                   \
      g_log << Logger::Debug << "[" << getPrefix() << "] Calling " << func << "(" << var << ")" << endl; \
    }                                                                                                    \
  }
#define logResult(var)                                                \
  {                                                                   \
    if (d_debug_log) {                                                \
      g_log << Logger::Debug << "[" << getPrefix() << "] Got result " \
            << "'" << var << "'" << endl;                             \
    }                                                                 \
  }

  void postPrepareContext() override
  {
    AuthLua4::postPrepareContext();
  }

  void postLoad() override
  {
    f_lookup = d_lw->readVariable<boost::optional<lookup_call_t>>("dns_lookup").get_value_or(0);
    f_list = d_lw->readVariable<boost::optional<list_call_t>>("dns_list").get_value_or(0);
    f_get_all_domains = d_lw->readVariable<boost::optional<get_all_domains_call_t>>("dns_get_all_domains").get_value_or(0);
    f_get_domaininfo = d_lw->readVariable<boost::optional<get_domaininfo_call_t>>("dns_get_domaininfo").get_value_or(0);
    f_get_domain_metadata = d_lw->readVariable<boost::optional<get_domain_metadata_call_t>>("dns_get_domain_metadata").get_value_or(0);
    f_get_all_domain_metadata = d_lw->readVariable<boost::optional<get_all_domain_metadata_call_t>>("dns_get_all_domain_metadata").get_value_or(0);
    f_get_domain_keys = d_lw->readVariable<boost::optional<get_domain_keys_call_t>>("dns_get_domain_keys").get_value_or(0);
    f_get_before_and_after_names_absolute = d_lw->readVariable<boost::optional<get_before_and_after_names_absolute_call_t>>("dns_get_before_and_after_names_absolute").get_value_or(0);
    f_set_notified = d_lw->readVariable<boost::optional<set_notified_call_t>>("dns_set_notified").get_value_or(0);

    auto init = d_lw->readVariable<boost::optional<init_call_t>>("dns_init").get_value_or(0);
    if (init)
      init();

    f_deinit = d_lw->readVariable<boost::optional<deinit_call_t>>("dns_deinit").get_value_or(0);

    if (f_lookup == nullptr)
      throw PDNSException("dns_lookup missing");

    /* see if dnssec support is wanted */
    d_dnssec = d_lw->readVariable<boost::optional<bool>>("dns_dnssec").get_value_or(false);
    if (d_dnssec) {
      if (f_get_domain_metadata == nullptr)
        throw PDNSException("dns_dnssec is true but dns_get_domain_metadata is missing");
      if (f_get_before_and_after_names_absolute == nullptr)
        throw PDNSException("dns_dnssec is true but dns_get_before_and_after_names_absolute is missing");
      /* domain keys is not strictly speaking necessary for dnssec backend */
      if (f_get_domain_keys == nullptr)
        g_log << Logger::Warning << "dns_get_domain_keys missing - cannot do live signing" << endl;
    }
  }

  unsigned int getCapabilities() override
  {
    unsigned int caps = CAP_DIRECT | CAP_LIST;
    if (d_dnssec) {
      caps |= CAP_DNSSEC;
    }
    return caps;
  }

  void parseLookup(const lookup_result_t& result)
  {
    for (const auto& row : result) {
      DNSResourceRecord rec;
      for (const auto& item : row.second) {
        if (item.first == "type") {
          if (item.second.which() == 1)
            rec.qtype = QType(boost::get<int>(item.second));
          else if (item.second.which() == 3)
            rec.qtype = boost::get<string>(item.second);
          else if (item.second.which() == 4)
            rec.qtype = boost::get<QType>(item.second);
          else
            throw PDNSException("Unsupported value for type");
        }
        else if (item.first == "name") {
          if (item.second.which() == 3)
            rec.qname = DNSName(boost::get<string>(item.second));
          else if (item.second.which() == 2)
            rec.qname = boost::get<DNSName>(item.second);
          else
            throw PDNSException("Unsupported value for name");
        }
        else if (item.first == "domain_id")
          rec.domain_id = boost::get<int>(item.second);
        else if (item.first == "auth")
          rec.auth = boost::get<bool>(item.second);
        else if (item.first == "last_modified")
          rec.last_modified = static_cast<time_t>(boost::get<int>(item.second));
        else if (item.first == "ttl")
          rec.ttl = boost::get<int>(item.second);
        else if (item.first == "content")
          rec.setContent(boost::get<string>(item.second));
        else if (item.first == "scopeMask")
          rec.scopeMask = boost::get<int>(item.second);
        else
          g_log << Logger::Warning << "Unsupported key '" << item.first << "' in lookup or list result" << endl;
      }
      logResult(rec.qname << " IN " << rec.qtype.toString() << " " << rec.ttl << " " << rec.getZoneRepresentation());
      d_result.push_back(rec);
    }
    if (d_result.empty() && d_debug_log)
      g_log << Logger::Debug << "[" << getPrefix() << "] Got empty result" << endl;
  }

  bool list(const ZoneName& target, domainid_t domain_id, bool /* include_disabled */ = false) override
  {
    if (f_list == nullptr) {
      g_log << Logger::Error << "[" << getPrefix() << "] dns_list missing - cannot do AXFR" << endl;
      return false;
    }

    if (d_result.size() != 0)
      throw PDNSException("list attempted while another was running");

    logCall("list", "target=" << target << ",domain_id=" << domain_id);
    list_result_t result = f_list(target.operator const DNSName&(), domain_id);

    if (result.which() == 0)
      return false;

    parseLookup(boost::get<lookup_result_t>(result));

    return true;
  }

  void lookup(const QType& qtype, const DNSName& qname, domainid_t domain_id, DNSPacket* p = nullptr) override
  {
    if (d_result.size() != 0)
      throw PDNSException("lookup attempted while another was running");

    lookup_context_t ctx;
    if (p != NULL) {
      ctx.emplace_back(lookup_context_t::value_type{"source_address", p->getInnerRemote().toString()});
      ctx.emplace_back(lookup_context_t::value_type{"real_source_address", p->getRealRemote().toString()});
    }

    logCall("lookup", "qtype=" << qtype.toString() << ",qname=" << qname << ",domain_id=" << domain_id);
    lookup_result_t result = f_lookup(qtype, qname, domain_id, ctx);
    parseLookup(result);
  }

  bool get(DNSResourceRecord& rr) override
  {
    if (d_result.size() == 0)
      return false;
    rr = std::move(d_result.front());
    d_result.pop_front();
    return true;
  }

  string directBackendCmd(const string& querystr) override
  {
    string::size_type pos = querystr.find_first_of(" \t");
    string cmd = querystr;
    string par = "";
    if (pos != string::npos) {
      cmd = querystr.substr(0, pos);
      par = querystr.substr(pos + 1);
    }
    direct_backend_cmd_call_t f = d_lw->readVariable<boost::optional<direct_backend_cmd_call_t>>(cmd).get_value_or(0);
    if (f == nullptr) {
      return cmd + "not found";
    }
    logCall(cmd, "parameter=" << par);
    return f(par);
  }

  void setNotified(domainid_t id, uint32_t serial) override
  {
    if (f_set_notified == NULL)
      return;
    logCall("dns_set_notified", "id=" << id << ",serial=" << serial);
    f_set_notified(id, serial);
  }

  void parseDomainInfo(const domaininfo_result_t& row, DomainInfo& di)
  {
    di.id = UnknownDomainID;
    for (const auto& item : row) {
      if (item.first == "account")
        di.account = boost::get<string>(item.second);
      else if (item.first == "last_check")
        di.last_check = static_cast<time_t>(boost::get<long>(item.second));
      else if (item.first == "masters")
        for (const auto& primary : boost::get<vector<string>>(item.second))
          di.primaries.push_back(ComboAddress(primary, 53));
      else if (item.first == "id")
        di.id = static_cast<domainid_t>(boost::get<long>(item.second));
      else if (item.first == "notified_serial")
        di.notified_serial = static_cast<unsigned int>(boost::get<long>(item.second));
      else if (item.first == "serial")
        di.serial = static_cast<unsigned int>(boost::get<long>(item.second));
      else if (item.first == "kind")
        di.kind = DomainInfo::stringToKind(boost::get<string>(item.second));
      else
        g_log << Logger::Warning << "Unsupported key '" << item.first << "' in domaininfo result" << endl;
    }
    di.backend = this;
    logResult("zone=" << di.zone << ",serial=" << di.serial << ",kind=" << di.getKindString());
  }

  bool getDomainInfo(const ZoneName& domain, DomainInfo& di, bool /* getSerial */ = true) override
  {
    if (f_get_domaininfo == nullptr) {
      // use getAuth instead... but getAuth wraps getSOA which will call
      // getDomainInfo if this is a domain variant, so protect against this
      // would-be infinite recursion.
      if (domain.hasVariant()) {
        g_log << Logger::Info << "Unable to return domain information for '" << domain.toLogString() << "' due to unimplemented dns_get_domaininfo" << endl;
        return false;
      }
      SOAData sd;
      if (!getAuth(domain, &sd))
        return false;

      di.id = sd.domain_id;
      di.zone = domain;
      di.backend = this;
      di.serial = sd.serial;
      return true;
    }

    logCall("get_domaininfo", "domain=" << domain);
    get_domaininfo_result_t result = f_get_domaininfo(domain.operator const DNSName&());

    if (result.which() == 0)
      return false;

    di.zone = domain;
    parseDomainInfo(boost::get<domaininfo_result_t>(result), di);

    return true;
  }

  void getAllDomains(vector<DomainInfo>* domains, bool /* getSerial */, bool /* include_disabled */) override
  {
    if (f_get_all_domains == nullptr)
      return;

    logCall("get_all_domains", "");
    for (const auto& row : f_get_all_domains()) {
      DomainInfo di;
      di.zone = ZoneName(row.first);
      logResult(di.zone);
      parseDomainInfo(row.second, di);
      domains->push_back(di);
    }
  }

  bool getAllDomainMetadata(const ZoneName& name, std::map<std::string, std::vector<std::string>>& meta) override
  {
    if (f_get_all_domain_metadata == nullptr)
      return false;

    logCall("get_all_domain_metadata", "name=" << name);
    get_all_domain_metadata_result_t result = f_get_all_domain_metadata(name.operator const DNSName&());
    if (result.which() == 0)
      return false;

    for (const auto& row : boost::get<vector<pair<string, domain_metadata_result_t>>>(result)) {
      meta[row.first].clear();
      for (const auto& item : row.second)
        meta[row.first].push_back(item.second);
      logResult("kind=" << row.first << ",value=" << boost::algorithm::join(meta[row.first], ", "));
    }

    return true;
  }

  bool getDomainMetadata(const ZoneName& name, const std::string& kind, std::vector<std::string>& meta) override
  {
    if (f_get_domain_metadata == nullptr)
      return false;

    logCall("get_domain_metadata", "name=" << name << ",kind=" << kind);
    get_domain_metadata_result_t result = f_get_domain_metadata(name.operator const DNSName&(), kind);
    if (result.which() == 0)
      return false;

    meta.clear();
    for (const auto& item : boost::get<domain_metadata_result_t>(result))
      meta.push_back(item.second);

    logResult("value=" << boost::algorithm::join(meta, ", "));
    return true;
  }

  bool getDomainKeys(const ZoneName& name, std::vector<DNSBackend::KeyData>& keys) override
  {
    if (f_get_domain_keys == nullptr)
      return false;

    logCall("get_domain_keys", "name=" << name);
    get_domain_keys_result_t result = f_get_domain_keys(name.operator const DNSName&());

    if (result.which() == 0)
      return false;

    for (const auto& row : boost::get<vector<pair<int, keydata_result_t>>>(result)) {
      DNSBackend::KeyData key;
      key.published = true;
      for (const auto& item : row.second) {
        if (item.first == "content")
          key.content = boost::get<string>(item.second);
        else if (item.first == "id")
          key.id = static_cast<unsigned int>(boost::get<int>(item.second));
        else if (item.first == "flags")
          key.flags = static_cast<unsigned int>(boost::get<int>(item.second));
        else if (item.first == "active")
          key.active = boost::get<bool>(item.second);
        else if (item.first == "published")
          key.published = boost::get<bool>(item.second);
        else
          g_log << Logger::Warning << "[" << getPrefix() << "] Unsupported key '" << item.first << "' in keydata result" << endl;
      }
      logResult("id=" << key.id << ",flags=" << key.flags << ",active=" << (key.active ? "true" : "false") << ",published=" << (key.published ? "true" : "false"));
      keys.emplace_back(std::move(key));
    }

    return true;
  }

  bool getBeforeAndAfterNamesAbsolute(domainid_t id, const DNSName& qname, DNSName& unhashed, DNSName& before, DNSName& after) override
  {
    if (f_get_before_and_after_names_absolute == nullptr)
      return false;

    logCall("get_before_and_after_names_absolute", "id=<<" << id << ",qname=" << qname);
    get_before_and_after_names_absolute_result_t result = f_get_before_and_after_names_absolute(id, qname);

    if (result.which() == 0)
      return false;

    before_and_after_names_result_t row = boost::get<before_and_after_names_result_t>(result);
    if (row.size() != 3) {
      g_log << Logger::Error << "Invalid result from dns_get_before_and_after_names_absolute, expected array with 3 items, got " << row.size() << "item(s)" << endl;
      return false;
    }
    for (const auto& item : row) {
      DNSName value;
      if (item.second.which() == 0)
        value = DNSName(boost::get<string>(item.second));
      else
        value = DNSName(boost::get<DNSName>(item.second));
      if (item.first == "unhashed")
        unhashed = value;
      else if (item.first == "before")
        before = value;
      else if (item.first == "after")
        after = value;
      else {
        g_log << Logger::Error << "Invalid result from dns_get_before_and_after_names_absolute, unexpected key " << item.first << endl;
        return false;
      }
    }

    logResult("unhashed=" << unhashed << ",before=" << before << ",after=" << after);
    return true;
  }

private:
  std::list<DNSResourceRecord> d_result;
  bool d_debug_log{false};
  bool d_dnssec{false};

  lookup_call_t f_lookup;
  list_call_t f_list;

  get_domaininfo_call_t f_get_domaininfo;
  get_all_domains_call_t f_get_all_domains;

  get_domain_metadata_call_t f_get_domain_metadata;
  get_all_domain_metadata_call_t f_get_all_domain_metadata;

  get_domain_keys_call_t f_get_domain_keys;

  get_before_and_after_names_absolute_call_t f_get_before_and_after_names_absolute;

  set_notified_call_t f_set_notified;

  deinit_call_t f_deinit;
};

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	* MERCHANTAPILITY 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	#pragma once
23	#include "boost/algorithm/string/join.hpp"
24	#include "pdns/arguments.hh"
25
26	#include "pdns/dnsbackend.hh"
27	#include "pdns/lua-auth4.hh"
28
29	class Lua2BackendAPIv2 : public DNSBackend, AuthLua4
30	{
31	private:
32	typedef std::function<void()> init_call_t;
33	typedef std::function<void()> deinit_call_t;
34
35	typedef std::vector<std::pair<string, string>> lookup_context_t;
36
37	typedef std::vector<std::pair<int, std::vector<std::pair<string, boost::variant<bool, int, DNSName, string, QType>>>>> lookup_result_t;
38	typedef std::function<lookup_result_t(const QType& qtype, const DNSName& qname, domainid_t domain_id, const lookup_context_t& ctx)> lookup_call_t;
39
40	typedef boost::variant<bool, lookup_result_t> list_result_t;
41	typedef std::function<list_result_t(const DNSName& qname, domainid_t domain_id)> list_call_t;
42
43	typedef vector<pair<string, boost::variant<bool, long, string, vector<string>>>> domaininfo_result_t;
44	typedef boost::variant<bool, domaininfo_result_t> get_domaininfo_result_t;
45	typedef vector<pair<DNSName, domaininfo_result_t>> get_all_domains_result_t;
46	typedef std::function<get_domaininfo_result_t(const DNSName& domain)> get_domaininfo_call_t;
47	typedef std::function<get_all_domains_result_t()> get_all_domains_call_t;
48
49	typedef vector<pair<int, string>> domain_metadata_result_t;
50	typedef boost::variant<bool, domain_metadata_result_t> get_domain_metadata_result_t;
51	typedef boost::variant<bool, vector<pair<string, domain_metadata_result_t>>> get_all_domain_metadata_result_t;
52	typedef std::function<get_domain_metadata_result_t(const DNSName& domain, const string& kind)> get_domain_metadata_call_t;
53	typedef std::function<get_all_domain_metadata_result_t(const DNSName& domain)> get_all_domain_metadata_call_t;
54
55	typedef vector<pair<string, boost::variant<bool, int, string>>> keydata_result_t;
56	typedef boost::variant<bool, vector<pair<int, keydata_result_t>>> get_domain_keys_result_t;
57	typedef std::function<get_domain_keys_result_t(const DNSName& domain)> get_domain_keys_call_t;
58
59	typedef std::vector<std::pair<string, boost::variant<string, DNSName>>> before_and_after_names_result_t;
60	typedef boost::variant<bool, before_and_after_names_result_t> get_before_and_after_names_absolute_result_t;
61	typedef std::function<get_before_and_after_names_absolute_result_t(domainid_t id, const DNSName& qname)> get_before_and_after_names_absolute_call_t;
62
63	typedef std::function<void(domainid_t, long)> set_notified_call_t;
64
65	typedef std::function<string(const string& cmd)> direct_backend_cmd_call_t;
66
67	public:
68	Lua2BackendAPIv2(const string& suffix)
69	{	21✔
70	d_include_path = ::arg()["lua-global-include-dir"];	21✔
71	setArgPrefix("lua2" + suffix);	21✔
72	d_debug_log = mustDo("query-logging");	21✔
73	prepareContext();	21✔
74	loadFile(getArg("filename"));	21✔
75	}	21✔
76
77	~Lua2BackendAPIv2() override;
78
79	#define logCall(func, var) \
80	{ \	48✔
81	if (d_debug_log) { \	48✔
UNCOV 82	g_log << Logger::Debug << "[" << getPrefix() << "] Calling " << func << "(" << var << ")" << endl; \	×
UNCOV 83	} \	×
84	}	48✔
85	#define logResult(var) \
86	{ \	128✔
87	if (d_debug_log) { \	128✔
UNCOV 88	g_log << Logger::Debug << "[" << getPrefix() << "] Got result " \	×
UNCOV 89	<< "'" << var << "'" << endl; \	×
UNCOV 90	} \	×
91	}	128✔
92
93	void postPrepareContext() override
94	{	21✔
95	AuthLua4::postPrepareContext();	21✔
96	}	21✔
97
98	void postLoad() override
99	{	21✔
100	f_lookup = d_lw->readVariable<boost::optional<lookup_call_t>>("dns_lookup").get_value_or(0);	21✔
101	f_list = d_lw->readVariable<boost::optional<list_call_t>>("dns_list").get_value_or(0);	21✔
102	f_get_all_domains = d_lw->readVariable<boost::optional<get_all_domains_call_t>>("dns_get_all_domains").get_value_or(0);	21✔
103	f_get_domaininfo = d_lw->readVariable<boost::optional<get_domaininfo_call_t>>("dns_get_domaininfo").get_value_or(0);	21✔
104	f_get_domain_metadata = d_lw->readVariable<boost::optional<get_domain_metadata_call_t>>("dns_get_domain_metadata").get_value_or(0);	21✔
105	f_get_all_domain_metadata = d_lw->readVariable<boost::optional<get_all_domain_metadata_call_t>>("dns_get_all_domain_metadata").get_value_or(0);	21✔
106	f_get_domain_keys = d_lw->readVariable<boost::optional<get_domain_keys_call_t>>("dns_get_domain_keys").get_value_or(0);	21✔
107	f_get_before_and_after_names_absolute = d_lw->readVariable<boost::optional<get_before_and_after_names_absolute_call_t>>("dns_get_before_and_after_names_absolute").get_value_or(0);	21✔
108	f_set_notified = d_lw->readVariable<boost::optional<set_notified_call_t>>("dns_set_notified").get_value_or(0);	21✔
109
110	auto init = d_lw->readVariable<boost::optional<init_call_t>>("dns_init").get_value_or(0);	21✔
111	if (init)	21!
UNCOV 112	init();	×
113
114	f_deinit = d_lw->readVariable<boost::optional<deinit_call_t>>("dns_deinit").get_value_or(0);	21✔
115
116	if (f_lookup == nullptr)	21!
UNCOV 117	throw PDNSException("dns_lookup missing");	×
118
119	/* see if dnssec support is wanted */
120	d_dnssec = d_lw->readVariable<boost::optional<bool>>("dns_dnssec").get_value_or(false);	21✔
121	if (d_dnssec) {	21✔
122	if (f_get_domain_metadata == nullptr)	15!
UNCOV 123	throw PDNSException("dns_dnssec is true but dns_get_domain_metadata is missing");	×
124	if (f_get_before_and_after_names_absolute == nullptr)	15!
125	throw PDNSException("dns_dnssec is true but dns_get_before_and_after_names_absolute is missing");	×
126	/* domain keys is not strictly speaking necessary for dnssec backend */
127	if (f_get_domain_keys == nullptr)	15!
UNCOV 128	g_log << Logger::Warning << "dns_get_domain_keys missing - cannot do live signing" << endl;	×
129	}	15✔
130	}	21✔
131
132	unsigned int getCapabilities() override
133	{	6✔
134	unsigned int caps = CAP_DIRECT \| CAP_LIST;	6✔
135	if (d_dnssec) {	6!
136	caps \|= CAP_DNSSEC;	6✔
137	}	6✔
138	return caps;	6✔
139	}	6✔
140
141	void parseLookup(const lookup_result_t& result)
142	{	29✔
143	for (const auto& row : result) {	103✔
144	DNSResourceRecord rec;	103✔
145	for (const auto& item : row.second) {	437✔
146	if (item.first == "type") {	437✔
147	if (item.second.which() == 1)	103!
UNCOV 148	rec.qtype = QType(boost::get<int>(item.second));	×
149	else if (item.second.which() == 3)	103!
UNCOV 150	rec.qtype = boost::get<string>(item.second);	×
151	else if (item.second.which() == 4)	103!
152	rec.qtype = boost::get<QType>(item.second);	103✔
UNCOV 153	else	×
154	throw PDNSException("Unsupported value for type");	×
155	}	103✔
156	else if (item.first == "name") {	334✔
157	if (item.second.which() == 3)	103!
UNCOV 158	rec.qname = DNSName(boost::get<string>(item.second));	×
159	else if (item.second.which() == 2)	103!
160	rec.qname = boost::get<DNSName>(item.second);	103✔
UNCOV 161	else	×
162	throw PDNSException("Unsupported value for name");	×
163	}	103✔
164	else if (item.first == "domain_id")	231✔
165	rec.domain_id = boost::get<int>(item.second);	25✔
166	else if (item.first == "auth")	206!
167	rec.auth = boost::get<bool>(item.second);	×
168	else if (item.first == "last_modified")	206!
169	rec.last_modified = static_cast<time_t>(boost::get<int>(item.second));	×
170	else if (item.first == "ttl")	206✔
171	rec.ttl = boost::get<int>(item.second);	103✔
172	else if (item.first == "content")	103!
173	rec.setContent(boost::get<string>(item.second));	103✔
UNCOV 174	else if (item.first == "scopeMask")	×
UNCOV 175	rec.scopeMask = boost::get<int>(item.second);	×
176	else	×
UNCOV 177	g_log << Logger::Warning << "Unsupported key '" << item.first << "' in lookup or list result" << endl;	×
178	}	437✔
179	logResult(rec.qname << " IN " << rec.qtype.toString() << " " << rec.ttl << " " << rec.getZoneRepresentation());	103!
180	d_result.push_back(rec);	103✔
181	}	103✔
182	if (d_result.empty() && d_debug_log)	29!
183	g_log << Logger::Debug << "[" << getPrefix() << "] Got empty result" << endl;	×
184	}	29✔
185
186	bool list(const ZoneName& target, domainid_t domain_id, bool /* include_disabled */ = false) override
187	{	6✔
188	if (f_list == nullptr) {	6!
UNCOV 189	g_log << Logger::Error << "[" << getPrefix() << "] dns_list missing - cannot do AXFR" << endl;	×
UNCOV 190	return false;	×
UNCOV 191	}	×
192
193	if (d_result.size() != 0)	6!
UNCOV 194	throw PDNSException("list attempted while another was running");	×
195
196	logCall("list", "target=" << target << ",domain_id=" << domain_id);	6!
197	list_result_t result = f_list(target.operator const DNSName&(), domain_id);	6✔
198
199	if (result.which() == 0)	6!
UNCOV 200	return false;	×
201
202	parseLookup(boost::get<lookup_result_t>(result));	6✔
203
204	return true;	6✔
205	}	6✔
206
207	void lookup(const QType& qtype, const DNSName& qname, domainid_t domain_id, DNSPacket* p = nullptr) override
208	{	23✔
209	if (d_result.size() != 0)	23!
UNCOV 210	throw PDNSException("lookup attempted while another was running");	×
211
212	lookup_context_t ctx;	23✔
213	if (p != NULL) {	23✔
214	ctx.emplace_back(lookup_context_t::value_type{"source_address", p->getInnerRemote().toString()});	5✔
215	ctx.emplace_back(lookup_context_t::value_type{"real_source_address", p->getRealRemote().toString()});	5✔
216	}	5✔
217
218	logCall("lookup", "qtype=" << qtype.toString() << ",qname=" << qname << ",domain_id=" << domain_id);	23!
219	lookup_result_t result = f_lookup(qtype, qname, domain_id, ctx);	23✔
220	parseLookup(result);	23✔
221	}	23✔
222
223	bool get(DNSResourceRecord& rr) override
224	{	132✔
225	if (d_result.size() == 0)	132✔
226	return false;	29✔
227	rr = std::move(d_result.front());	103✔
228	d_result.pop_front();	103✔
229	return true;	103✔
230	}	132✔
231
232	string directBackendCmd(const string& querystr) override
233	{	×
234	string::size_type pos = querystr.find_first_of(" \t");	×
235	string cmd = querystr;	×
236	string par = "";	×
237	if (pos != string::npos) {	×
238	cmd = querystr.substr(0, pos);	×
239	par = querystr.substr(pos + 1);	×
240	}	×
UNCOV 241	direct_backend_cmd_call_t f = d_lw->readVariable<boost::optional<direct_backend_cmd_call_t>>(cmd).get_value_or(0);	×
UNCOV 242	if (f == nullptr) {	×
243	return cmd + "not found";	×
244	}	×
245	logCall(cmd, "parameter=" << par);	×
246	return f(par);	×
247	}	×
248
249	void setNotified(domainid_t id, uint32_t serial) override
UNCOV 250	{	×
UNCOV 251	if (f_set_notified == NULL)	×
UNCOV 252	return;	×
UNCOV 253	logCall("dns_set_notified", "id=" << id << ",serial=" << serial);	×
254	f_set_notified(id, serial);	×
UNCOV 255	}	×
256
257	void parseDomainInfo(const domaininfo_result_t& row, DomainInfo& di)
258	{	5✔
259	di.id = UnknownDomainID;	5✔
260	for (const auto& item : row) {	10✔
261	if (item.first == "account")	10!
UNCOV 262	di.account = boost::get<string>(item.second);	×
263	else if (item.first == "last_check")	10!
UNCOV 264	di.last_check = static_cast<time_t>(boost::get<long>(item.second));	×
265	else if (item.first == "masters")	10!
266	for (const auto& primary : boost::get<vector<string>>(item.second))	×
267	di.primaries.push_back(ComboAddress(primary, 53));	×
268	else if (item.first == "id")	10✔
269	di.id = static_cast<domainid_t>(boost::get<long>(item.second));	5✔
270	else if (item.first == "notified_serial")	5!
UNCOV 271	di.notified_serial = static_cast<unsigned int>(boost::get<long>(item.second));	×
272	else if (item.first == "serial")	5!
273	di.serial = static_cast<unsigned int>(boost::get<long>(item.second));	5✔
UNCOV 274	else if (item.first == "kind")	×
UNCOV 275	di.kind = DomainInfo::stringToKind(boost::get<string>(item.second));	×
UNCOV 276	else	×
UNCOV 277	g_log << Logger::Warning << "Unsupported key '" << item.first << "' in domaininfo result" << endl;	×
278	}	10✔
279	di.backend = this;	5✔
280	logResult("zone=" << di.zone << ",serial=" << di.serial << ",kind=" << di.getKindString());	5!
281	}	5✔
282
283	bool getDomainInfo(const ZoneName& domain, DomainInfo& di, bool /* getSerial */ = true) override
284	{	6✔
285	if (f_get_domaininfo == nullptr) {	6✔
286	// use getAuth instead... but getAuth wraps getSOA which will call
287	// getDomainInfo if this is a domain variant, so protect against this
288	// would-be infinite recursion.
289	if (domain.hasVariant()) {	3!
UNCOV 290	g_log << Logger::Info << "Unable to return domain information for '" << domain.toLogString() << "' due to unimplemented dns_get_domaininfo" << endl;	×
UNCOV 291	return false;	×
UNCOV 292	}	×
293	SOAData sd;	3✔
294	if (!getAuth(domain, &sd))	3!
UNCOV 295	return false;	×
296
297	di.id = sd.domain_id;	3✔
298	di.zone = domain;	3✔
299	di.backend = this;	3✔
300	di.serial = sd.serial;	3✔
301	return true;	3✔
302	}	3✔
303
304	logCall("get_domaininfo", "domain=" << domain);	3!
305	get_domaininfo_result_t result = f_get_domaininfo(domain.operator const DNSName&());	3✔
306
307	if (result.which() == 0)	3!
UNCOV 308	return false;	×
309
310	di.zone = domain;	3✔
311	parseDomainInfo(boost::get<domaininfo_result_t>(result), di);	3✔
312
313	return true;	3✔
314	}	3✔
315
316	void getAllDomains(vector<DomainInfo>* domains, bool /* getSerial /, bool / include_disabled */) override
317	{	1✔
318	if (f_get_all_domains == nullptr)	1!
UNCOV 319	return;	×
320
321	logCall("get_all_domains", "");	1!
322	for (const auto& row : f_get_all_domains()) {	2✔
323	DomainInfo di;	2✔
324	di.zone = ZoneName(row.first);	2✔
325	logResult(di.zone);	2!
326	parseDomainInfo(row.second, di);	2✔
327	domains->push_back(di);	2✔
328	}	2✔
329	}	1✔
330
331	bool getAllDomainMetadata(const ZoneName& name, std::map<std::string, std::vector<std::string>>& meta) override
332	{	6✔
333	if (f_get_all_domain_metadata == nullptr)	6!
334	return false;	6✔
335
UNCOV 336	logCall("get_all_domain_metadata", "name=" << name);	×
337	get_all_domain_metadata_result_t result = f_get_all_domain_metadata(name.operator const DNSName&());	×
338	if (result.which() == 0)	×
339	return false;	×
340
341	for (const auto& row : boost::get<vector<pair<string, domain_metadata_result_t>>>(result)) {	×
342	meta[row.first].clear();	×
343	for (const auto& item : row.second)	×
344	meta[row.first].push_back(item.second);	×
UNCOV 345	logResult("kind=" << row.first << ",value=" << boost::algorithm::join(meta[row.first], ", "));	×
346	}	×
347
348	return true;	×
UNCOV 349	}	×
350
351	bool getDomainMetadata(const ZoneName& name, const std::string& kind, std::vector<std::string>& meta) override
352	{	×
UNCOV 353	if (f_get_domain_metadata == nullptr)	×
UNCOV 354	return false;	×
355
UNCOV 356	logCall("get_domain_metadata", "name=" << name << ",kind=" << kind);	×
UNCOV 357	get_domain_metadata_result_t result = f_get_domain_metadata(name.operator const DNSName&(), kind);	×
UNCOV 358	if (result.which() == 0)	×
UNCOV 359	return false;	×
360
UNCOV 361	meta.clear();	×
UNCOV 362	for (const auto& item : boost::get<domain_metadata_result_t>(result))	×
363	meta.push_back(item.second);	×
364
UNCOV 365	logResult("value=" << boost::algorithm::join(meta, ", "));	×
UNCOV 366	return true;	×
UNCOV 367	}	×
368
369	bool getDomainKeys(const ZoneName& name, std::vector<DNSBackend::KeyData>& keys) override
370	{	6✔
371	if (f_get_domain_keys == nullptr)	6✔
372	return false;	3✔
373
374	logCall("get_domain_keys", "name=" << name);	3!
375	get_domain_keys_result_t result = f_get_domain_keys(name.operator const DNSName&());	3✔
376
377	if (result.which() == 0)	3!
378	return false;	×
379
380	for (const auto& row : boost::get<vector<pair<int, keydata_result_t>>>(result)) {	6✔
381	DNSBackend::KeyData key;	6✔
382	key.published = true;	6✔
383	for (const auto& item : row.second) {	24✔
384	if (item.first == "content")	24✔
385	key.content = boost::get<string>(item.second);	6✔
386	else if (item.first == "id")	18✔
387	key.id = static_cast<unsigned int>(boost::get<int>(item.second));	6✔
388	else if (item.first == "flags")	12✔
389	key.flags = static_cast<unsigned int>(boost::get<int>(item.second));	6✔
390	else if (item.first == "active")	6!
391	key.active = boost::get<bool>(item.second);	6✔
392	else if (item.first == "published")	×
UNCOV 393	key.published = boost::get<bool>(item.second);	×
UNCOV 394	else	×
UNCOV 395	g_log << Logger::Warning << "[" << getPrefix() << "] Unsupported key '" << item.first << "' in keydata result" << endl;	×
396	}	24✔
397	logResult("id=" << key.id << ",flags=" << key.flags << ",active=" << (key.active ? "true" : "false") << ",published=" << (key.published ? "true" : "false"));	6!
398	keys.emplace_back(std::move(key));	6✔
399	}	6✔
400
401	return true;	3✔
402	}	3✔
403
404	bool getBeforeAndAfterNamesAbsolute(domainid_t id, const DNSName& qname, DNSName& unhashed, DNSName& before, DNSName& after) override
405	{	12✔
406	if (f_get_before_and_after_names_absolute == nullptr)	12!
UNCOV 407	return false;	×
408
409	logCall("get_before_and_after_names_absolute", "id=<<" << id << ",qname=" << qname);	12!
410	get_before_and_after_names_absolute_result_t result = f_get_before_and_after_names_absolute(id, qname);	12✔
411
412	if (result.which() == 0)	12!
UNCOV 413	return false;	×
414
415	before_and_after_names_result_t row = boost::get<before_and_after_names_result_t>(result);	12✔
416	if (row.size() != 3) {	12!
417	g_log << Logger::Error << "Invalid result from dns_get_before_and_after_names_absolute, expected array with 3 items, got " << row.size() << "item(s)" << endl;	×
418	return false;	×
419	}	×
420	for (const auto& item : row) {	36✔
421	DNSName value;	36✔
422	if (item.second.which() == 0)	36!
UNCOV 423	value = DNSName(boost::get<string>(item.second));	×
424	else	36✔
425	value = DNSName(boost::get<DNSName>(item.second));	36✔
426	if (item.first == "unhashed")	36✔
427	unhashed = value;	12✔
428	else if (item.first == "before")	24✔
429	before = value;	12✔
430	else if (item.first == "after")	12!
431	after = value;	12✔
UNCOV 432	else {	×
UNCOV 433	g_log << Logger::Error << "Invalid result from dns_get_before_and_after_names_absolute, unexpected key " << item.first << endl;	×
UNCOV 434	return false;	×
UNCOV 435	}	×
436	}	36✔
437
438	logResult("unhashed=" << unhashed << ",before=" << before << ",after=" << after);	12!
439	return true;	12✔
440	}	12✔
441
442	private:
443	std::list<DNSResourceRecord> d_result;
444	bool d_debug_log{false};
445	bool d_dnssec{false};
446
447	lookup_call_t f_lookup;
448	list_call_t f_list;
449
450	get_domaininfo_call_t f_get_domaininfo;
451	get_all_domains_call_t f_get_all_domains;
452
453	get_domain_metadata_call_t f_get_domain_metadata;
454	get_all_domain_metadata_call_t f_get_all_domain_metadata;
455
456	get_domain_keys_call_t f_get_domain_keys;
457
458	get_before_and_after_names_absolute_call_t f_get_before_and_after_names_absolute;
459
460	set_notified_call_t f_set_notified;
461
462	deinit_call_t f_deinit;
463	};

PowerDNS / pdns / 16516817003

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