6668203687

Committed 27 Oct 2023 02:07PM UTC coverage: 56.105% (-0.3%) from 56.395%

Build # 6668203687

Build Type

Pull #13226

github

Committed by

web-flow

Commit Message

Merge 76a917be4 into 4e41c4285

Pull Request Pull Request #13226: Cleanup `ueberbackend.cc` a bit

Run Details

30199 of 84938 branches covered (0.0%)

Branch coverage included in aggregate %.

188 of 243 new or added lines in 1 file covered. (77.37%)

2274 existing lines in 49 files now uncovered.

103172 of 152780 relevant lines covered (67.53%)

2753896.65 hits per line

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

52.97

/pdns/dnsbackend.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
 * 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 <algorithm>
class DNSPacket;

#include "utility.hh"
#include <string>
#include <vector>
#include <map>
#include <sys/types.h>
#include "pdnsexception.hh"
#include <set>
#include <iostream>
#include <sys/socket.h>
#include <dirent.h>
#include "misc.hh"
#include "qtype.hh"
#include "dns.hh"
#include "namespaces.hh"
#include "comment.hh"
#include "dnsname.hh"
#include "dnsrecords.hh"
#include "iputils.hh"
#include "sha.hh"
#include "auth-catalogzone.hh"

class DNSBackend;
struct SOAData;

struct DomainInfo
{
  DomainInfo() : last_check(0), backend(nullptr), id(0), notified_serial(0), receivedNotify(false), serial(0), kind(DomainInfo::Native) {}

  DNSName zone;
  DNSName catalog;
  time_t last_check{};
  string options;
  string account;
  vector<ComboAddress> masters;
  DNSBackend *backend{};

  uint32_t id{};
  uint32_t notified_serial{};

  bool receivedNotify{};

  uint32_t serial{};

  bool operator<(const DomainInfo& rhs) const
  {
    return zone < rhs.zone;
  }

  // Do not reorder (lmdbbackend)!!! One exception 'All' is always last.
  enum DomainKind : uint8_t
  {
    Master,
    Slave,
    Native,
    Producer,
    Consumer,
    All
  } kind;

  [[nodiscard]] const char *getKindString() const
  {
    return DomainInfo::getKindString(kind);
  }

  static const char *getKindString(enum DomainKind kind)
  {
    const char* kinds[] = {"Master", "Slave", "Native", "Producer", "Consumer", "All"};
    return kinds[kind];
  }

  static DomainKind stringToKind(const string& kind)
  {
    if (pdns_iequals(kind, "SECONDARY") || pdns_iequals(kind, "SLAVE")) {
      return DomainInfo::Slave;
    }
    if (pdns_iequals(kind, "PRIMARY") || pdns_iequals(kind, "MASTER")) {
      return DomainInfo::Master;
    }
    if (pdns_iequals(kind, "PRODUCER")) {
      return DomainInfo::Producer;
    }
    if (pdns_iequals(kind, "CONSUMER")) {
      return DomainInfo::Consumer;
    }
    // No "ALL" here please. Yes, I really mean it...
    return DomainInfo::Native;
  }

  [[nodiscard]] bool isPrimaryType() const { return (kind == DomainInfo::Master || kind == DomainInfo::Producer); }
  [[nodiscard]] bool isSecondaryType() const { return (kind == DomainInfo::Slave || kind == DomainInfo::Consumer); }
  [[nodiscard]] bool isCatalogType() const { return (kind == DomainInfo::Producer || kind == DomainInfo::Consumer); }

  [[nodiscard]] bool isMaster(const ComboAddress& ipAddress) const
  {
    return std::any_of(masters.begin(), masters.end(), [ipAddress](auto master) { return ComboAddress::addressOnlyEqual()(ipAddress, master); });
  }
};

struct TSIGKey {
   DNSName name;
   DNSName algorithm;
   std::string key;
};

struct AutoPrimary {
   AutoPrimary(const string& new_ip, const string& new_nameserver, const string& new_account) :
     ip(new_ip), nameserver(new_nameserver), account(new_account){};
   std::string ip;
   std::string nameserver;
   std::string account;
};

class DNSPacket;

//! This virtual base class defines the interface for backends for PowerDNS.
/** To create a backend, inherit from this class and implement functions for all virtual methods.
    Methods should not throw an exception if they are sure they did not find the requested data. However,
    if an error occurred which prevented them temporarily from performing a lockup, they should throw a DBException,
    which will cause the nameserver to send out a ServFail or take other evasive action. Probably only locking
    issues should lead to DBExceptions.

    More serious errors, which may indicate that the database connection is hosed, or a configuration error occurred, should
    lead to the throwing of an PDNSException. This exception will fall straight through the UeberBackend and the PacketHandler
    and be caught by the Distributor, which will delete your DNSBackend instance and spawn a new one.
*/
class DNSBackend
{
public:
  //! lookup() initiates a lookup. A lookup without results should not throw!
  virtual void lookup(const QType &qtype, const DNSName &qdomain, int zoneId=-1, DNSPacket *pkt_p=nullptr)=0;
  virtual bool get(DNSResourceRecord &)=0; //!< retrieves one DNSResource record, returns false if no more were available
  virtual bool get(DNSZoneRecord &r);

  //! Initiates a list of the specified domain
  /** Once initiated, DNSResourceRecord objects can be retrieved using get(). Should return false
      if the backend does not consider itself responsible for the id passed.
      \param domain_id ID of which a list is requested
  */
  virtual bool list(const DNSName &target, int domain_id, bool include_disabled=false)=0;

  virtual ~DNSBackend(){};

  //! fills the soadata struct with the SOA details. Returns false if there is no SOA.
  virtual bool getSOA(const DNSName &name, SOAData &soadata);

  virtual bool replaceRRSet(uint32_t /* domain_id */, const DNSName& /* qname */, const QType& /* qt */, const vector<DNSResourceRecord>& /* rrset */)
  {
    return false;
  }

  virtual bool listSubZone(const DNSName& /* zone */, int /* domain_id */)
  {
    return false;
  }

  // the DNSSEC related (getDomainMetadata has broader uses too)
  static bool isDnssecDomainMetadata(const string& name)
  {
    return (name == "PRESIGNED" || name == "NSEC3PARAM" || name == "NSEC3NARROW");
  }
  virtual bool getAllDomainMetadata(const DNSName& /* name */, std::map<std::string, std::vector<std::string>>& /* meta */) { return false; };
  virtual bool getDomainMetadata(const DNSName& /* name */, const std::string& /* kind */, std::vector<std::string>& /* meta */) { return false; }
  virtual bool getDomainMetadataOne(const DNSName& name, const std::string& kind, std::string& value)
  {
    std::vector<std::string> meta;
    if (getDomainMetadata(name, kind, meta)) {
      if (!meta.empty()) {
        value = *meta.begin();
        return true;
      }
    }
    return false;
  }

  virtual bool setDomainMetadata(const DNSName& /* name */, const std::string& /* kind */, const std::vector<std::string>& /* meta */) { return false; }
  virtual bool setDomainMetadataOne(const DNSName& name, const std::string& kind, const std::string& value)
  {
    const std::vector<std::string> meta(1, value);
    return setDomainMetadata(name, kind, meta);
  }

  virtual void getAllDomains(vector<DomainInfo>* domains, bool getSerial, bool include_disabled);

  /** Determines if we are authoritative for a zone, and at what level */
  virtual bool getAuth(const DNSName& target, SOAData* /* sd */);

  struct KeyData {
    std::string content;
    unsigned int id{0};
    unsigned int flags{0};
    bool active{false};
    bool published{false};
  };

  virtual bool getDomainKeys(const DNSName& /* name */, std::vector<KeyData>& /* keys */) { return false; }
  virtual bool removeDomainKey(const DNSName& /* name */, unsigned int /* id */) { return false; }
  virtual bool addDomainKey(const DNSName& /* name */, const KeyData& /* key */, int64_t& /* id */) { return false; }
  virtual bool activateDomainKey(const DNSName& /* name */, unsigned int /* id */) { return false; }
  virtual bool deactivateDomainKey(const DNSName& /* name */, unsigned int /* id */) { return false; }
  virtual bool publishDomainKey(const DNSName& /* name */, unsigned int /* id */) { return false; }
  virtual bool unpublishDomainKey(const DNSName& /* name */, unsigned int /* id */) { return false; }

  virtual bool setTSIGKey(const DNSName& /* name */, const DNSName& /* algorithm */, const string& /* content */) { return false; }
  virtual bool getTSIGKey(const DNSName& /* name */, DNSName& /* algorithm */, string& /* content */) { return false; }
  virtual bool getTSIGKeys(std::vector<struct TSIGKey>& /* keys */) { return false; }
  virtual bool deleteTSIGKey(const DNSName& /* name */) { return false; }

  virtual bool getBeforeAndAfterNamesAbsolute(uint32_t /* id */, const DNSName& /* qname */, DNSName& /* unhashed */, DNSName& /* before */, DNSName& /* after */)
  {
    std::cerr << "Default beforeAndAfterAbsolute called!" << std::endl;
    abort();
    return false;
  }

  virtual bool getBeforeAndAfterNames(uint32_t /* id */, const DNSName& zonename, const DNSName& qname, DNSName& before, DNSName& after);

  virtual bool updateDNSSECOrderNameAndAuth(uint32_t /* domain_id */, const DNSName& /* qname */, const DNSName& /* ordername */, bool /* auth */, const uint16_t /* qtype */ = QType::ANY)
  {
    return false;
  }

  virtual bool updateEmptyNonTerminals(uint32_t /* domain_id */, set<DNSName>& /* insert */, set<DNSName>& /* erase */, bool /* remove */)
  {
    return false;
  }

  virtual bool doesDNSSEC()
  {
    return false;
  }

  // end DNSSEC

  // comments support
  virtual bool listComments(uint32_t /* domain_id */)
  {
    return false; // unsupported by this backend
  }

  virtual bool getComment(Comment& /* comment */)
  {
    return false;
  }

  virtual bool feedComment(const Comment& /* comment */)
  {
    return false;
  }

  virtual bool replaceComments(const uint32_t /* domain_id */, const DNSName& /* qname */, const QType& /* qt */, const vector<Comment>& /* comments */)
  {
    return false;
  }

  //! returns true if master ip is master for domain name.
  //! starts the transaction for updating domain qname (FIXME: what is id?)
  virtual bool startTransaction(const DNSName& /* qname */, int /* id */ = -1)
  {
    return false;
  }

  //! commits the transaction started by startTransaction
  virtual bool commitTransaction()
  {
    return false;
  }

  //! aborts the transaction started by startTransaction, should leave state unaltered
  virtual bool abortTransaction()
  {
    return false;
  }

  virtual bool inTransaction()
  {
    return false;
  }

  virtual void reload()
  {
  }

  virtual void rediscover(string* /* status */ = nullptr)
  {
  }

  //! feeds a record to a zone, needs a call to startTransaction first
  virtual bool feedRecord(const DNSResourceRecord& /* rr */, const DNSName& /* ordername */, bool /* ordernameIsNSEC3 */ = false)
  {
    return false; // no problem!
  }
  virtual bool feedEnts(int /* domain_id */, map<DNSName, bool>& /* nonterm */)
  {
    return false;
  }
  virtual bool feedEnts3(int /* domain_id */, const DNSName& /* domain */, map<DNSName, bool>& /* nonterm */, const NSEC3PARAMRecordContent& /* ns3prc */, bool /* narrow */)
  {
    return false;
  }

  //! if this returns true, DomainInfo di contains information about the domain
  virtual bool getDomainInfo(const DNSName& /* domain */, DomainInfo& /* di */, bool /* getSerial */ = true)
  {
    return false;
  }
  //! slave capable backends should return a list of slaves that should be rechecked for staleness
  virtual void getUnfreshSlaveInfos(vector<DomainInfo>* /* domains */)
  {
  }

  //! get a list of IP addresses that should also be notified for a domain
  virtual void alsoNotifies(const DNSName& domain, set<string>* ips)
  {
    std::vector<std::string> meta;
    getDomainMetadata(domain, "ALSO-NOTIFY", meta);
    ips->insert(meta.begin(), meta.end());
  }

  //! get list of domains that have been changed since their last notification to slaves
  virtual void getUpdatedMasters(vector<DomainInfo>& /* domains */, std::unordered_set<DNSName>& /* catalogs */, CatalogHashMap& /* catalogHashes */)
  {
  }

  //! get list of all members in a catalog
  virtual bool getCatalogMembers(const DNSName& /* catalog */, vector<CatalogInfo>& /* members */, CatalogInfo::CatalogType /* type */)
  {
    return false;
  }

  //! Called by PowerDNS to inform a backend that a domain need to be checked for freshness
  virtual void setStale(uint32_t /* domain_id */)
  {
  }

  //! Called by PowerDNS to inform a backend that a domain has been checked for freshness
  virtual void setFresh(uint32_t /* domain_id */)
  {
  }

  //! Called by PowerDNS to inform a backend that the changes in the domain have been reported to slaves
  virtual void setNotified(uint32_t /* id */, uint32_t /* serial */)
  {
  }

  //! Called when the Master list of a domain should be changed
  virtual bool setMasters(const DNSName& /* domain */, const vector<ComboAddress>& /* masters */)
  {
    return false;
  }

  //! Called when the Kind of a domain should be changed (master -> native and similar)
  virtual bool setKind(const DNSName& /* domain */, const DomainInfo::DomainKind /* kind */)
  {
    return false;
  }

  //! Called when the options of a domain should be changed
  virtual bool setOptions(const DNSName& /* domain */, const string& /* options */)
  {
    return false;
  }

  //! Called when the catalog of a domain should be changed
  virtual bool setCatalog(const DNSName& /* domain */, const DNSName& /* catalog */)
  {
    return false;
  }

  //! Called when the Account of a domain should be changed
  virtual bool setAccount(const DNSName& /* domain */, const string& /* account */)
  {
    return false;
  }

  //! Can be called to seed the getArg() function with a prefix
  void setArgPrefix(const string &prefix);

  //! Add an entry for a super master
  virtual bool superMasterAdd(const struct AutoPrimary& /* primary */)
  {
    return false;
  }

  //! Remove an entry for a super master
  virtual bool autoPrimaryRemove(const struct AutoPrimary& /* primary */)
  {
    return false;
  }

  //! List all SuperMasters, returns false if feature not supported.
  virtual bool autoPrimariesList(std::vector<AutoPrimary>& /* primaries */)
  {
    return false;
  }

  //! determine if ip is a supermaster or a domain
  virtual bool superMasterBackend(const string& /* ip */, const DNSName& /* domain */, const vector<DNSResourceRecord>& /* nsset */, string* /* nameserver */, string* /* account */, DNSBackend** /* db */)
  {
    return false;
  }

  //! called by PowerDNS to create a new domain
  virtual bool createDomain(const DNSName& /* domain */, const DomainInfo::DomainKind /* kind */, const vector<ComboAddress>& /* masters */, const string& /* account */)
  {
    return false;
  }

  //! called by PowerDNS to create a slave record for a superMaster
  virtual bool createSlaveDomain(const string& /* ip */, const DNSName& /* domain */, const string& /* nameserver */, const string& /* account */)
  {
    return false;
  }

  //! called to delete a domain, incl. all metadata, zone contents, etc.
  virtual bool deleteDomain(const DNSName& /* domain */)
  {
    return false;
  }

  virtual string directBackendCmd(const string& /* query */)
  {
    return "directBackendCmd not supported for this backend\n";
  }

  //! Search for records, returns true if search was done successfully.
  virtual bool searchRecords(const string& /* pattern */, int /* maxResults */, vector<DNSResourceRecord>& /* result */)
  {
    return false;
  }

  //! Search for comments, returns true if search was done successfully.
  virtual bool searchComments(const string& /* pattern */, int /* maxResults */, vector<Comment>& /* result */)
  {
    return false;
  }

  const string& getPrefix() { return d_prefix; };
protected:
  bool mustDo(const string &key);
  const string &getArg(const string &key);
  int getArgAsNum(const string &key);

private:
  string d_prefix;
};

class BackendFactory
{
public:
  BackendFactory(const string &name) : d_name(name) {}
  virtual ~BackendFactory(){}
  virtual DNSBackend *make(const string &suffix)=0;
  virtual DNSBackend *makeMetadataOnly(const string &suffix)
  {
    return this->make(suffix);
  }
  virtual void declareArguments(const string& /* suffix */ = "") {}
  [[nodiscard]] const string& getName() const;

protected:
  void declare(const string &suffix, const string &param, const string &explanation, const string &value);

private:
  const string d_name;
};

class BackendMakerClass
{
public:
  void report(BackendFactory *bf);
  void launch(const string &instr);
  vector<DNSBackend *> all(bool skipBIND=false);
  void load(const string &module);
  [[nodiscard]] size_t numLauncheable() const;
  vector<string> getModules();
  void clear();

private:
  void load_all();
  using d_repository_t = map<string, BackendFactory *>;
  d_repository_t d_repository;
  vector<pair<string,string> >d_instances;
};

extern BackendMakerClass &BackendMakers();

//! Exception that can be thrown by a DNSBackend to indicate a failure
class DBException : public PDNSException
{
public:
  DBException(const string &reason_) : PDNSException(reason_){}
};


struct SOAData
{
  SOAData() : domain_id(-1) {};

  DNSName qname;
  DNSName nameserver;
  DNSName hostmaster;
  uint32_t ttl{};
  uint32_t serial{};
  uint32_t refresh{};
  uint32_t retry{};
  uint32_t expire{};
  uint32_t minimum{};
  DNSBackend *db{};
  int domain_id{};

  [[nodiscard]] uint32_t getNegativeTTL() const { return min(ttl, minimum); }
};

/** helper function for both DNSPacket and addSOARecord() - converts a line into a struct, for easier parsing */
void fillSOAData(const string &content, SOAData &data);
// same but more karmic
void fillSOAData(const DNSZoneRecord& in, SOAData& data);
// the reverse
std::shared_ptr<DNSRecordContent> makeSOAContent(const SOAData& sd);

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	#pragma once
23
24	#include <algorithm>
25	class DNSPacket;
26
27	#include "utility.hh"
28	#include <string>
29	#include <vector>
30	#include <map>
31	#include <sys/types.h>
32	#include "pdnsexception.hh"
33	#include <set>
34	#include <iostream>
35	#include <sys/socket.h>
36	#include <dirent.h>
37	#include "misc.hh"
38	#include "qtype.hh"
39	#include "dns.hh"
40	#include "namespaces.hh"
41	#include "comment.hh"
42	#include "dnsname.hh"
43	#include "dnsrecords.hh"
44	#include "iputils.hh"
45	#include "sha.hh"
46	#include "auth-catalogzone.hh"
47
48	class DNSBackend;
49	struct SOAData;
50
51	struct DomainInfo
52	{
53	DomainInfo() : last_check(0), backend(nullptr), id(0), notified_serial(0), receivedNotify(false), serial(0), kind(DomainInfo::Native) {}	250,665✔
54
55	DNSName zone;
56	DNSName catalog;
57	time_t last_check{};
58	string options;
59	string account;
60	vector<ComboAddress> masters;
61	DNSBackend *backend{};
62
63	uint32_t id{};
64	uint32_t notified_serial{};
65
66	bool receivedNotify{};
67
68	uint32_t serial{};
69
70	bool operator<(const DomainInfo& rhs) const
71	{	×
72	return zone < rhs.zone;	×
73	}	×
74
75	// Do not reorder (lmdbbackend)!!! One exception 'All' is always last.
76	enum DomainKind : uint8_t
77	{
78	Master,
79	Slave,
80	Native,
81	Producer,
82	Consumer,
83	All
84	} kind;
85
86	[[nodiscard]] const char *getKindString() const
87	{	2,087✔
88	return DomainInfo::getKindString(kind);	2,087✔
89	}	2,087✔
90
91	static const char *getKindString(enum DomainKind kind)
92	{	2,909✔
93	const char* kinds[] = {"Master", "Slave", "Native", "Producer", "Consumer", "All"};	2,909✔
94	return kinds[kind];	2,909✔
95	}	2,909✔
96
97	static DomainKind stringToKind(const string& kind)
98	{	2,910✔
99	if (pdns_iequals(kind, "SECONDARY") \|\| pdns_iequals(kind, "SLAVE")) {	2,910✔
100	return DomainInfo::Slave;	107✔
101	}	107✔
102	if (pdns_iequals(kind, "PRIMARY") \|\| pdns_iequals(kind, "MASTER")) {	2,803!
103	return DomainInfo::Master;	184✔
104	}	184✔
105	if (pdns_iequals(kind, "PRODUCER")) {	2,619✔
106	return DomainInfo::Producer;	5✔
107	}	5✔
108	if (pdns_iequals(kind, "CONSUMER")) {	2,614✔
109	return DomainInfo::Consumer;	90✔
110	}	90✔
111	// No "ALL" here please. Yes, I really mean it...
112	return DomainInfo::Native;	2,524✔
113	}	2,614✔
114
115	[[nodiscard]] bool isPrimaryType() const { return (kind == DomainInfo::Master \|\| kind == DomainInfo::Producer); }	40!
116	[[nodiscard]] bool isSecondaryType() const { return (kind == DomainInfo::Slave \|\| kind == DomainInfo::Consumer); }	275✔
117	[[nodiscard]] bool isCatalogType() const { return (kind == DomainInfo::Producer \|\| kind == DomainInfo::Consumer); }	466!
118
119	[[nodiscard]] bool isMaster(const ComboAddress& ipAddress) const
UNCOV 120	{	×
UNCOV 121	return std::any_of(masters.begin(), masters.end(), [ipAddress](auto master) { return ComboAddress::addressOnlyEqual()(ipAddress, master); });	×
UNCOV 122	}	×
123	};
124
125	struct TSIGKey {
126	DNSName name;
127	DNSName algorithm;
128	std::string key;
129	};
130
131	struct AutoPrimary {
132	AutoPrimary(const string& new_ip, const string& new_nameserver, const string& new_account) :
133	ip(new_ip), nameserver(new_nameserver), account(new_account){};	21✔
134	std::string ip;
135	std::string nameserver;
136	std::string account;
137	};
138
139	class DNSPacket;
140
141	//! This virtual base class defines the interface for backends for PowerDNS.
142	/** To create a backend, inherit from this class and implement functions for all virtual methods.
143	Methods should not throw an exception if they are sure they did not find the requested data. However,
144	if an error occurred which prevented them temporarily from performing a lockup, they should throw a DBException,
145	which will cause the nameserver to send out a ServFail or take other evasive action. Probably only locking
146	issues should lead to DBExceptions.
147
148	More serious errors, which may indicate that the database connection is hosed, or a configuration error occurred, should
149	lead to the throwing of an PDNSException. This exception will fall straight through the UeberBackend and the PacketHandler
150	and be caught by the Distributor, which will delete your DNSBackend instance and spawn a new one.
151	*/
152	class DNSBackend
153	{
154	public:
155	//! lookup() initiates a lookup. A lookup without results should not throw!
156	virtual void lookup(const QType &qtype, const DNSName &qdomain, int zoneId=-1, DNSPacket *pkt_p=nullptr)=0;
157	virtual bool get(DNSResourceRecord &)=0; //!< retrieves one DNSResource record, returns false if no more were available
158	virtual bool get(DNSZoneRecord &r);
159
160	//! Initiates a list of the specified domain
161	/** Once initiated, DNSResourceRecord objects can be retrieved using get(). Should return false
162	if the backend does not consider itself responsible for the id passed.
163	\param domain_id ID of which a list is requested
164	*/
165	virtual bool list(const DNSName &target, int domain_id, bool include_disabled=false)=0;
166
167	virtual ~DNSBackend(){};	6,956✔
168
169	//! fills the soadata struct with the SOA details. Returns false if there is no SOA.
170	virtual bool getSOA(const DNSName &name, SOAData &soadata);
171
172	virtual bool replaceRRSet(uint32_t /* domain_id /, const DNSName& / qname /, const QType& / qt /, const vector<DNSResourceRecord>& / rrset */)
173	{	×
174	return false;	×
175	}	×
176
177	virtual bool listSubZone(const DNSName& /* zone /, int / domain_id */)
178	{	×
179	return false;	×
180	}	×
181
182	// the DNSSEC related (getDomainMetadata has broader uses too)
183	static bool isDnssecDomainMetadata(const string& name)
184	{	7✔
185	return (name == "PRESIGNED" \|\| name == "NSEC3PARAM" \|\| name == "NSEC3NARROW");	7!
186	}	7✔
187	virtual bool getAllDomainMetadata(const DNSName& /* name /, std::map<std::string, std::vector<std::string>>& / meta */) { return false; };	64✔
188	virtual bool getDomainMetadata(const DNSName& /* name /, const std::string& / kind /, std::vector<std::string>& / meta */) { return false; }	×
189	virtual bool getDomainMetadataOne(const DNSName& name, const std::string& kind, std::string& value)
190	{	3,987✔
191	std::vector<std::string> meta;	3,987✔
192	if (getDomainMetadata(name, kind, meta)) {	3,987!
193	if (!meta.empty()) {	3,987✔
194	value = *meta.begin();	1,527✔
195	return true;	1,527✔
196	}	1,527✔
197	}	3,987✔
198	return false;	2,460✔
199	}	3,987✔
200
201	virtual bool setDomainMetadata(const DNSName& /* name /, const std::string& / kind /, const std::vector<std::string>& / meta */) { return false; }	×
202	virtual bool setDomainMetadataOne(const DNSName& name, const std::string& kind, const std::string& value)
203	{	658✔
204	const std::vector<std::string> meta(1, value);	658✔
205	return setDomainMetadata(name, kind, meta);	658✔
206	}	658✔
207
208	virtual void getAllDomains(vector<DomainInfo>* domains, bool getSerial, bool include_disabled);
209
210	/** Determines if we are authoritative for a zone, and at what level */
211	virtual bool getAuth(const DNSName& target, SOAData* /* sd */);
212
213	struct KeyData {
214	std::string content;
215	unsigned int id{0};
216	unsigned int flags{0};
217	bool active{false};
218	bool published{false};
219	};
220
221	virtual bool getDomainKeys(const DNSName& /* name /, std::vector<KeyData>& / keys */) { return false; }	64✔
222	virtual bool removeDomainKey(const DNSName& /* name /, unsigned int / id */) { return false; }	×
223	virtual bool addDomainKey(const DNSName& /* name /, const KeyData& / key /, int64_t& / id */) { return false; }	×
224	virtual bool activateDomainKey(const DNSName& /* name /, unsigned int / id */) { return false; }	×
225	virtual bool deactivateDomainKey(const DNSName& /* name /, unsigned int / id */) { return false; }	×
226	virtual bool publishDomainKey(const DNSName& /* name /, unsigned int / id */) { return false; }	×
227	virtual bool unpublishDomainKey(const DNSName& /* name /, unsigned int / id */) { return false; }	×
228
229	virtual bool setTSIGKey(const DNSName& /* name /, const DNSName& / algorithm /, const string& / content */) { return false; }	×
230	virtual bool getTSIGKey(const DNSName& /* name /, DNSName& / algorithm /, string& / content */) { return false; }	×
231	virtual bool getTSIGKeys(std::vector<struct TSIGKey>& /* keys */) { return false; }	×
232	virtual bool deleteTSIGKey(const DNSName& /* name */) { return false; }	×
233
234	virtual bool getBeforeAndAfterNamesAbsolute(uint32_t /* id /, const DNSName& / qname /, DNSName& / unhashed /, DNSName& / before /, DNSName& / after */)
235	{	×
236	std::cerr << "Default beforeAndAfterAbsolute called!" << std::endl;	×
237	abort();	×
238	return false;	×
239	}	×
240
241	virtual bool getBeforeAndAfterNames(uint32_t /* id */, const DNSName& zonename, const DNSName& qname, DNSName& before, DNSName& after);
242
243	virtual bool updateDNSSECOrderNameAndAuth(uint32_t /* domain_id /, const DNSName& / qname /, const DNSName& / ordername /, bool / auth /, const uint16_t / qtype */ = QType::ANY)
244	{	80,988✔
245	return false;	80,988✔
246	}	80,988✔
247
248	virtual bool updateEmptyNonTerminals(uint32_t /* domain_id /, set<DNSName>& / insert /, set<DNSName>& / erase /, bool / remove */)
249	{	×
250	return false;	×
251	}	×
252
253	virtual bool doesDNSSEC()
254	{	56✔
255	return false;	56✔
256	}	56✔
257
258	// end DNSSEC
259
260	// comments support
261	virtual bool listComments(uint32_t /* domain_id */)
262	{	148✔
263	return false; // unsupported by this backend	148✔
264	}	148✔
265
266	virtual bool getComment(Comment& /* comment */)
267	{	148✔
268	return false;	148✔
269	}	148✔
270
271	virtual bool feedComment(const Comment& /* comment */)
272	{	1✔
273	return false;	1✔
274	}	1✔
275
276	virtual bool replaceComments(const uint32_t /* domain_id /, const DNSName& / qname /, const QType& / qt /, const vector<Comment>& / comments */)
277	{	×
278	return false;	×
279	}	×
280
281	//! returns true if master ip is master for domain name.
282	//! starts the transaction for updating domain qname (FIXME: what is id?)
283	virtual bool startTransaction(const DNSName& /* qname /, int / id */ = -1)
284	{	2✔
285	return false;	2✔
286	}	2✔
287
288	//! commits the transaction started by startTransaction
289	virtual bool commitTransaction()
290	{	2✔
291	return false;	2✔
292	}	2✔
293
294	//! aborts the transaction started by startTransaction, should leave state unaltered
295	virtual bool abortTransaction()
296	{	×
297	return false;	×
298	}	×
299
300	virtual bool inTransaction()
301	{	330✔
302	return false;	330✔
303	}	330✔
304
305	virtual void reload()
306	{	×
307	}	×
308
309	virtual void rediscover(string* /* status */ = nullptr)
310	{	×
311	}	×
312
313	//! feeds a record to a zone, needs a call to startTransaction first
314	virtual bool feedRecord(const DNSResourceRecord& /* rr /, const DNSName& / ordername /, bool / ordernameIsNSEC3 */ = false)
315	{	×
316	return false; // no problem!	×
317	}	×
318	virtual bool feedEnts(int /* domain_id /, map<DNSName, bool>& / nonterm */)
319	{	12✔
320	return false;	12✔
321	}	12✔
322	virtual bool feedEnts3(int /* domain_id /, const DNSName& / domain /, map<DNSName, bool>& / nonterm /, const NSEC3PARAMRecordContent& / ns3prc /, bool / narrow */)
323	{	12✔
324	return false;	12✔
325	}	12✔
326
327	//! if this returns true, DomainInfo di contains information about the domain
328	virtual bool getDomainInfo(const DNSName& /* domain /, DomainInfo& / di /, bool / getSerial */ = true)
329	{	×
330	return false;	×
331	}	×
332	//! slave capable backends should return a list of slaves that should be rechecked for staleness
333	virtual void getUnfreshSlaveInfos(vector<DomainInfo>* /* domains */)
334	{	×
335	}	×
336
337	//! get a list of IP addresses that should also be notified for a domain
338	virtual void alsoNotifies(const DNSName& domain, set<string>* ips)
339	{	9✔
340	std::vector<std::string> meta;	9✔
341	getDomainMetadata(domain, "ALSO-NOTIFY", meta);	9✔
342	ips->insert(meta.begin(), meta.end());	9✔
343	}	9✔
344
345	//! get list of domains that have been changed since their last notification to slaves
346	virtual void getUpdatedMasters(vector<DomainInfo>& /* domains /, std::unordered_set<DNSName>& / catalogs /, CatalogHashMap& / catalogHashes */)
347	{	×
348	}	×
349
350	//! get list of all members in a catalog
351	virtual bool getCatalogMembers(const DNSName& /* catalog /, vector<CatalogInfo>& / members /, CatalogInfo::CatalogType / type */)
352	{	×
353	return false;	×
354	}	×
355
356	//! Called by PowerDNS to inform a backend that a domain need to be checked for freshness
357	virtual void setStale(uint32_t /* domain_id */)
358	{	×
359	}	×
360
361	//! Called by PowerDNS to inform a backend that a domain has been checked for freshness
362	virtual void setFresh(uint32_t /* domain_id */)
363	{	×
364	}	×
365
366	//! Called by PowerDNS to inform a backend that the changes in the domain have been reported to slaves
367	virtual void setNotified(uint32_t /* id /, uint32_t / serial */)
368	{	×
369	}	×
370
371	//! Called when the Master list of a domain should be changed
372	virtual bool setMasters(const DNSName& /* domain /, const vector<ComboAddress>& / masters */)
373	{	×
374	return false;	×
375	}	×
376
377	//! Called when the Kind of a domain should be changed (master -> native and similar)
378	virtual bool setKind(const DNSName& /* domain /, const DomainInfo::DomainKind / kind */)
379	{	×
380	return false;	×
381	}	×
382
383	//! Called when the options of a domain should be changed
384	virtual bool setOptions(const DNSName& /* domain /, const string& / options */)
385	{	×
386	return false;	×
387	}	×
388
389	//! Called when the catalog of a domain should be changed
390	virtual bool setCatalog(const DNSName& /* domain /, const DNSName& / catalog */)
391	{	×
392	return false;	×
393	}	×
394
395	//! Called when the Account of a domain should be changed
396	virtual bool setAccount(const DNSName& /* domain /, const string& / account */)
397	{	×
398	return false;	×
399	}	×
400
401	//! Can be called to seed the getArg() function with a prefix
402	void setArgPrefix(const string &prefix);
403
404	//! Add an entry for a super master
405	virtual bool superMasterAdd(const struct AutoPrimary& /* primary */)
406	{	×
407	return false;	×
408	}	×
409
410	//! Remove an entry for a super master
411	virtual bool autoPrimaryRemove(const struct AutoPrimary& /* primary */)
412	{	×
413	return false;	×
414	}	×
415
416	//! List all SuperMasters, returns false if feature not supported.
417	virtual bool autoPrimariesList(std::vector<AutoPrimary>& /* primaries */)
418	{	×
419	return false;	×
420	}	×
421
422	//! determine if ip is a supermaster or a domain
423	virtual bool superMasterBackend(const string& /* ip /, const DNSName& / domain /, const vector<DNSResourceRecord>& / nsset /, string /* nameserver /, string /* account /, DNSBackend* /* db */)
424	{	×
425	return false;	×
426	}	×
427
428	//! called by PowerDNS to create a new domain
429	virtual bool createDomain(const DNSName& /* domain /, const DomainInfo::DomainKind / kind /, const vector<ComboAddress>& / masters /, const string& / account */)
430	{	×
431	return false;	×
432	}	×
433
434	//! called by PowerDNS to create a slave record for a superMaster
435	virtual bool createSlaveDomain(const string& /* ip /, const DNSName& / domain /, const string& / nameserver /, const string& / account */)
436	{	×
437	return false;	×
438	}	×
439
440	//! called to delete a domain, incl. all metadata, zone contents, etc.
441	virtual bool deleteDomain(const DNSName& /* domain */)
442	{	×
443	return false;	×
444	}	×
445
446	virtual string directBackendCmd(const string& /* query */)
447	{	×
448	return "directBackendCmd not supported for this backend\n";	×
449	}	×
450
451	//! Search for records, returns true if search was done successfully.
452	virtual bool searchRecords(const string& /* pattern /, int / maxResults /, vector<DNSResourceRecord>& / result */)
453	{	×
454	return false;	×
455	}	×
456
457	//! Search for comments, returns true if search was done successfully.
458	virtual bool searchComments(const string& /* pattern /, int / maxResults /, vector<Comment>& / result */)
459	{	15✔
460	return false;	15✔
461	}	15✔
462
463	const string& getPrefix() { return d_prefix; };	8✔
464	protected:
465	bool mustDo(const string &key);
466	const string &getArg(const string &key);
467	int getArgAsNum(const string &key);
468
469	private:
470	string d_prefix;
471	};
472
473	class BackendFactory
474	{
475	public:
476	BackendFactory(const string &name) : d_name(name) {}	15,882✔
477	virtual ~BackendFactory(){}	7✔
478	virtual DNSBackend *make(const string &suffix)=0;
479	virtual DNSBackend *makeMetadataOnly(const string &suffix)
480	{	1,557✔
481	return this->make(suffix);	1,557✔
482	}	1,557✔
483	virtual void declareArguments(const string& /* suffix */ = "") {}	13✔
484	[[nodiscard]] const string& getName() const;
485
486	protected:
487	void declare(const string &suffix, const string &param, const string &explanation, const string &value);
488
489	private:
490	const string d_name;
491	};
492
493	class BackendMakerClass
494	{
495	public:
496	void report(BackendFactory *bf);
497	void launch(const string &instr);
498	vector<DNSBackend *> all(bool skipBIND=false);
499	void load(const string &module);
500	[[nodiscard]] size_t numLauncheable() const;
501	vector<string> getModules();
502	void clear();
503
504	private:
505	void load_all();
506	using d_repository_t = map<string, BackendFactory *>;
507	d_repository_t d_repository;
508	vector<pair<string,string> >d_instances;
509	};
510
511	extern BackendMakerClass &BackendMakers();
512
513	//! Exception that can be thrown by a DNSBackend to indicate a failure
514	class DBException : public PDNSException
515	{
516	public:
517	DBException(const string &reason_) : PDNSException(reason_){}	204✔
518	};
519
520
521	struct SOAData
522	{
523	SOAData() : domain_id(-1) {};	40,699✔
524
525	DNSName qname;
526	DNSName nameserver;
527	DNSName hostmaster;
528	uint32_t ttl{};
529	uint32_t serial{};
530	uint32_t refresh{};
531	uint32_t retry{};
532	uint32_t expire{};
533	uint32_t minimum{};
534	DNSBackend *db{};
535	int domain_id{};
536
537	[[nodiscard]] uint32_t getNegativeTTL() const { return min(ttl, minimum); }	280,893✔
538	};
539
540	/** helper function for both DNSPacket and addSOARecord() - converts a line into a struct, for easier parsing */
541	void fillSOAData(const string &content, SOAData &data);
542	// same but more karmic
543	void fillSOAData(const DNSZoneRecord& in, SOAData& data);
544	// the reverse
545	std::shared_ptr<DNSRecordContent> makeSOAContent(const SOAData& sd);

PowerDNS / pdns / 6668203687

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