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

PowerDNS / pdns / 20618548088

31 Dec 2025 12:00PM UTC coverage: 72.648% (-0.7%) from 73.336%
20618548088

Pull #16693

github

web-flow
Merge 3f7d9a75b into 65de281db
Pull Request #16693: auth: plumbing for structured logging

39009 of 65430 branches covered (59.62%)

Branch coverage included in aggregate %.

807 of 2400 new or added lines in 58 files covered. (33.63%)

200 existing lines in 39 files now uncovered.

129187 of 166092 relevant lines covered (77.78%)

5266744.49 hits per line

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

80.13
/modules/gpgsqlbackend/gpgsqlbackend.cc
1
/*
2
 * This file is part of PowerDNS or dnsdist.
3
 * Copyright -- PowerDNS.COM B.V. and its contributors
4
 *
5
 * This program is free software; you can redistribute it and/or modify
6
 * it under the terms of version 2 of the GNU General Public License as
7
 * published by the Free Software Foundation.
8
 *
9
 * In addition, for the avoidance of any doubt, permission is granted to
10
 * link this program with OpenSSL and to (re)distribute the binaries
11
 * produced as the result of such linking.
12
 *
13
 * This program is distributed in the hope that it will be useful,
14
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16
 * GNU General Public License for more details.
17
 *
18
 * You should have received a copy of the GNU General Public License
19
 * along with this program; if not, write to the Free Software
20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21
 */
22
#ifdef HAVE_CONFIG_H
23
#include "config.h"
24
#endif
25
#include <string>
26
#include <map>
27
#include "pdns/namespaces.hh"
28
#include "pdns/dns.hh"
29
#include "pdns/dnsbackend.hh"
30
#include "pdns/dnspacket.hh"
31
#include "pdns/pdnsexception.hh"
32
#include "pdns/logger.hh"
33
#include "pdns/arguments.hh"
34
#include "gpgsqlbackend.hh"
35
#include "spgsql.hh"
36
#include <sys/time.h>
37
#include <sstream>
38

39
gPgSQLBackend::gPgSQLBackend(const string& mode, const string& suffix) :
40
  GSQLBackend(mode, suffix)
41
{
1,914✔
42
  if (g_slogStructured) {
1,914!
NEW
43
    d_slog = g_slog->withName("gpgsql" + suffix);
×
NEW
44
  }
×
45

46
  try {
1,914✔
47
    setDB(std::unique_ptr<SSql>(new SPgSQL(d_slog,
1,914✔
48
                                           getArg("dbname"),
1,914✔
49
                                           getArg("host"),
1,914✔
50
                                           getArg("port"),
1,914✔
51
                                           getArg("user"),
1,914✔
52
                                           getArg("password"),
1,914✔
53
                                           getArg("extra-connection-parameters"),
1,914✔
54
                                           mustDo("prepared-statements"))));
1,914✔
55
  }
1,914✔
56

57
  catch (SSqlException& e) {
1,914✔
NEW
58
    SLOG(g_log << Logger::Error << mode << " Connection failed: " << e.txtReason() << endl,
×
NEW
59
         d_slog->error(Logr::Error, e.txtReason(), "Database connection failed", "mode", Logging::Loggable(mode)));
×
60
    throw PDNSException("Unable to launch " + mode + " connection: " + e.txtReason());
×
61
  }
×
62
  allocateStatements();
1,914✔
63
  SLOG(g_log << Logger::Info << mode << " Connection successful. Connected to database '" << getArg("dbname") << "' on '" << getArg("host") << "'." << endl,
1,914!
64
       d_slog->info(Logr::Info, "Database connection successful", "database", Logging::Loggable(getArg("dbname")), "host", Logging::Loggable(getArg("host"))));
1,914✔
65
}
1,914✔
66

67
void gPgSQLBackend::reconnect()
68
{
×
69
  freeStatements();
×
70

71
  if (d_db) {
×
72
    d_db->reconnect();
×
73

74
    allocateStatements();
×
75
  }
×
76
}
×
77

78
bool gPgSQLBackend::inTransaction()
79
{
332,563✔
80
  const auto* db = dynamic_cast<SPgSQL*>(d_db.get());
332,563✔
81
  if (db) {
332,563✔
82
    return db->in_trx();
332,557✔
83
  }
332,557✔
84
  return false;
6✔
85
}
332,563✔
86

87
class gPgSQLFactory : public BackendFactory
88
{
89
public:
90
  gPgSQLFactory(const string& mode) :
91
    BackendFactory(mode), d_mode(mode) {}
5,904✔
92

93
  void declareArguments(const string& suffix = "") override
94
  {
411✔
95
    declare(suffix, "dbname", "Backend database name to connect to", "");
411✔
96
    declare(suffix, "user", "Database backend user to connect as", "");
411✔
97
    declare(suffix, "host", "Database backend host to connect to", "");
411✔
98
    declare(suffix, "port", "Database backend port to connect to", "");
411✔
99
    declare(suffix, "password", "Database backend password to connect with", "");
411✔
100
    declare(suffix, "extra-connection-parameters", "Extra parameters to add to connection string", "");
411✔
101
    declare(suffix, "prepared-statements", "Use prepared statements instead of parameterized queries", "yes");
411✔
102

103
    declare(suffix, "dnssec", "Enable DNSSEC processing", "no");
411✔
104

105
    string record_query = "SELECT content,ttl,prio,type,domain_id,disabled::int,name,auth::int FROM records WHERE";
411✔
106

107
    declare(suffix, "basic-query", "Basic query", record_query + " disabled=false and type=$1 and name=$2");
411✔
108
    declare(suffix, "id-query", "Basic with ID query", record_query + " disabled=false and type=$1 and name=$2 and domain_id=$3");
411✔
109
    declare(suffix, "any-query", "Any query", record_query + " disabled=false and name=$1");
411✔
110
    declare(suffix, "any-id-query", "Any with ID query", record_query + " disabled=false and name=$1 and domain_id=$2");
411✔
111

112
    declare(suffix, "api-id-query", "API basic with ID query", record_query + " (disabled=false or $1) and type=$2 and name=$3 and domain_id=$4");
411✔
113
    declare(suffix, "api-any-id-query", "API any with ID query", record_query + " (disabled=false or $1) and name=$2 and domain_id=$3");
411✔
114

115
    declare(suffix, "list-query", "AXFR query", "SELECT content,ttl,prio,type,domain_id,disabled::int,name,auth::int,ordername FROM records WHERE (disabled=false OR $1) and domain_id=$2 order by name, type");
411✔
116
    declare(suffix, "list-subzone-query", "Subzone listing", record_query + " disabled=false and (name=$1 OR name like $2) and domain_id=$3");
411✔
117

118
    declare(suffix, "remove-empty-non-terminals-from-zone-query", "remove all empty non-terminals from zone", "delete from records where domain_id=$1 and type is null");
411✔
119
    declare(suffix, "delete-empty-non-terminal-query", "delete empty non-terminal from zone", "delete from records where domain_id=$1 and name=$2 and type is null");
411✔
120

121
    declare(suffix, "info-zone-query", "", "select id,name,master,last_check,notified_serial,type,options,catalog,account from domains where name=$1");
411✔
122

123
    declare(suffix, "info-all-secondaries-query", "", "select domains.id, domains.name, domains.type, domains.master, domains.last_check, records.content from domains LEFT JOIN records ON records.domain_id=domains.id AND records.type='SOA' AND records.name=domains.name where domains.type in ('SLAVE', 'CONSUMER')");
411✔
124
    declare(suffix, "autoprimary-query", "", "select account from supermasters where ip=$1 and nameserver=$2");
411✔
125
    declare(suffix, "autoprimary-name-to-ips", "", "select ip,account from supermasters where nameserver=$1 and account=$2");
411✔
126
    declare(suffix, "autoprimary-add", "", "insert into supermasters (ip, nameserver, account) values ($1,$2,$3)");
411✔
127
    declare(suffix, "autoprimary-remove", "", "delete from supermasters where ip = $1 and nameserver = $2");
411✔
128
    declare(suffix, "list-autoprimaries", "", "select ip,nameserver,account from supermasters");
411✔
129

130
    declare(suffix, "insert-zone-query", "", "insert into domains (type,name,master,account,last_check, notified_serial) values($1,$2,$3,$4,null,null)");
411✔
131

132
    declare(suffix, "insert-record-query", "", "insert into records (content,ttl,prio,type,domain_id,disabled,name,ordername,auth) values ($1,$2,$3,$4,$5,$6,$7,$8,$9)");
411✔
133
    declare(suffix, "insert-empty-non-terminal-order-query", "insert empty non-terminal in zone", "insert into records (type,domain_id,disabled,name,ordername,auth,ttl,prio,content) values (null,$1,false,$2,$3,$4,null,null,null)");
411✔
134

135
    declare(suffix, "get-order-first-query", "DNSSEC Ordering Query, first", "select ordername from records where disabled=false and domain_id=$1 and ordername is not null order by 1 using ~<~ limit 1");
411✔
136
    declare(suffix, "get-order-before-query", "DNSSEC Ordering Query, before", "select ordername, name from records where disabled=false and ordername ~<=~ $1 and domain_id=$2 and ordername is not null order by 1 using ~>~ limit 1");
411✔
137
    declare(suffix, "get-order-after-query", "DNSSEC Ordering Query, after", "select ordername from records where disabled=false and ordername ~>~ $1 and domain_id=$2 and ordername is not null order by 1 using ~<~ limit 1");
411✔
138
    declare(suffix, "get-order-last-query", "DNSSEC Ordering Query, last", "select ordername, name from records where disabled=false and ordername != '' and domain_id=$1 and ordername is not null order by 1 using ~>~ limit 1");
411✔
139

140
    declare(suffix, "update-ordername-and-auth-query", "DNSSEC update ordername and auth for a qname query", "update records set ordername=$1,auth=$2 where domain_id=$3 and name=$4 and disabled=false");
411✔
141
    declare(suffix, "update-ordername-and-auth-type-query", "DNSSEC update ordername and auth for a rrset query", "update records set ordername=$1,auth=$2 where domain_id=$3 and name=$4 and type=$5 and disabled=false");
411✔
142
    declare(suffix, "nullify-ordername-and-update-auth-query", "DNSSEC nullify ordername and update auth for a qname query", "update records set ordername=NULL,auth=$1 where domain_id=$2 and name=$3 and disabled=false");
411✔
143
    declare(suffix, "nullify-ordername-and-update-auth-type-query", "DNSSEC nullify ordername and update auth for a rrset query", "update records set ordername=NULL,auth=$1 where domain_id=$2 and name=$3 and type=$4 and disabled=false");
411✔
144

145
    declare(suffix, "update-primary-query", "", "update domains set master=$1 where name=$2");
411✔
146
    declare(suffix, "update-kind-query", "", "update domains set type=$1 where name=$2");
411✔
147
    declare(suffix, "update-options-query", "", "update domains set options=$1 where name=$2");
411✔
148
    declare(suffix, "update-catalog-query", "", "update domains set catalog=$1 where name=$2");
411✔
149
    declare(suffix, "update-account-query", "", "update domains set account=$1 where name=$2");
411✔
150
    declare(suffix, "update-serial-query", "", "update domains set notified_serial=$1 where id=$2");
411✔
151
    declare(suffix, "update-lastcheck-query", "", "update domains set last_check=$1 where id=$2");
411✔
152
    declare(suffix, "info-all-primary-query", "", "select domains.id, domains.name, domains.type, domains.notified_serial, domains.options, domains.catalog, records.content from records join domains on records.domain_id=domains.id and records.name=domains.name where records.type='SOA' and records.disabled=false and domains.type in ('MASTER', 'PRODUCER') order by domains.id");
411✔
153
    declare(suffix, "info-producer-members-query", "", "select domains.id, domains.name, domains.options from records join domains on records.domain_id=domains.id and records.name=domains.name where domains.type='MASTER' and domains.catalog=$1 and records.type='SOA' and records.disabled=false");
411✔
154
    declare(suffix, "info-consumer-members-query", "", "select id, name, options, master from domains where type='SLAVE' and catalog=$1");
411✔
155
    declare(suffix, "delete-domain-query", "", "delete from domains where name=$1");
411✔
156
    declare(suffix, "delete-zone-query", "", "delete from records where domain_id=$1");
411✔
157
    declare(suffix, "delete-rrset-query", "", "delete from records where domain_id=$1 and name=$2 and type=$3");
411✔
158
    declare(suffix, "delete-names-query", "", "delete from records where domain_id=$1 and name=$2");
411✔
159

160
    declare(suffix, "add-domain-key-query", "", "insert into cryptokeys (domain_id, flags, active, published, content) select id, $1, $2, $3, $4 from domains where name=$5 returning id");
411✔
161
    declare(suffix, "get-last-inserted-key-id-query", "", "select pdns_bug_should_not_get_here('https://github.com/PowerDNS/pdns/pull/10392'), 1/0");
411✔
162
    declare(suffix, "list-domain-keys-query", "", "select cryptokeys.id, flags, case when active then 1 else 0 end as active, case when published then 1 else 0 end as published, content from domains, cryptokeys where cryptokeys.domain_id=domains.id and name=$1");
411✔
163
    declare(suffix, "get-all-domain-metadata-query", "", "select kind,content from domains, domainmetadata where domainmetadata.domain_id=domains.id and name=$1");
411✔
164
    declare(suffix, "get-domain-metadata-query", "", "select content from domains, domainmetadata where domainmetadata.domain_id=domains.id and name=$1 and domainmetadata.kind=$2");
411✔
165
    declare(suffix, "clear-domain-metadata-query", "", "delete from domainmetadata where domain_id=(select id from domains where name=$1) and domainmetadata.kind=$2");
411✔
166
    declare(suffix, "clear-domain-all-metadata-query", "", "delete from domainmetadata where domain_id=(select id from domains where name=$1)");
411✔
167
    declare(suffix, "set-domain-metadata-query", "", "insert into domainmetadata (domain_id, kind, content) select id, $1, $2 from domains where name=$3");
411✔
168
    declare(suffix, "activate-domain-key-query", "", "update cryptokeys set active=true where domain_id=(select id from domains where name=$1) and  cryptokeys.id=$2");
411✔
169
    declare(suffix, "deactivate-domain-key-query", "", "update cryptokeys set active=false where domain_id=(select id from domains where name=$1) and  cryptokeys.id=$2");
411✔
170
    declare(suffix, "publish-domain-key-query", "", "update cryptokeys set published=true where domain_id=(select id from domains where name=$1) and  cryptokeys.id=$2");
411✔
171
    declare(suffix, "unpublish-domain-key-query", "", "update cryptokeys set published=false where domain_id=(select id from domains where name=$1) and  cryptokeys.id=$2");
411✔
172
    declare(suffix, "remove-domain-key-query", "", "delete from cryptokeys where domain_id=(select id from domains where name=$1) and cryptokeys.id=$2");
411✔
173
    declare(suffix, "clear-domain-all-keys-query", "", "delete from cryptokeys where domain_id=(select id from domains where name=$1)");
411✔
174
    declare(suffix, "get-tsig-key-query", "", "select algorithm, secret from tsigkeys where name=$1");
411✔
175
    declare(suffix, "set-tsig-key-query", "", "insert into tsigkeys (name,algorithm,secret) values($1,$2,$3)");
411✔
176
    declare(suffix, "delete-tsig-key-query", "", "delete from tsigkeys where name=$1");
411✔
177
    declare(suffix, "get-tsig-keys-query", "", "select name,algorithm, secret from tsigkeys");
411✔
178

179
    declare(suffix, "get-all-domains-query", "Retrieve all domains", "select domains.id, domains.name, records.content, domains.type, domains.master, domains.notified_serial, domains.last_check, domains.account, domains.catalog from domains LEFT JOIN records ON records.domain_id=domains.id AND records.type='SOA' AND records.name=domains.name WHERE records.disabled=false OR $1");
411✔
180

181
    declare(suffix, "list-comments-query", "", "SELECT domain_id,name,type,modified_at,account,comment FROM comments WHERE domain_id=$1");
411✔
182
    declare(suffix, "insert-comment-query", "", "INSERT INTO comments (domain_id, name, type, modified_at, account, comment) VALUES ($1, $2, $3, $4, $5, $6)");
411✔
183
    declare(suffix, "delete-comment-rrset-query", "", "DELETE FROM comments WHERE domain_id=$1 AND name=$2 AND type=$3");
411✔
184
    declare(suffix, "delete-comments-query", "", "DELETE FROM comments WHERE domain_id=$1");
411✔
185
    declare(suffix, "search-records-query", "", record_query + " name ILIKE $1 OR content ILIKE $2 LIMIT $3");
411✔
186
    declare(suffix, "search-comments-query", "", "SELECT domain_id,name,type,modified_at,account,comment FROM comments WHERE name ILIKE $1 OR comment ILIKE $2 LIMIT $3");
411✔
187
  }
411✔
188

189
  DNSBackend* make(const string& suffix = "") override
190
  {
1,914✔
191
    return new gPgSQLBackend(d_mode, suffix);
1,914✔
192
  }
1,914✔
193

194
private:
195
  const string d_mode;
196
};
197

198
//! Magic class that is activated when the dynamic library is loaded
199
class gPgSQLLoader
200
{
201
public:
202
  //! This reports us to the main UeberBackend class
203
  gPgSQLLoader()
204
  {
5,904✔
205
    BackendMakers().report(std::make_unique<gPgSQLFactory>("gpgsql"));
5,904✔
206
    // If this module is not loaded dynamically at runtime, this code runs
207
    // as part of a global constructor, before the structured logger has a
208
    // chance to be set up, so fallback to simple logging in this case.
209
    if (!g_slogStructured || !g_slog) {
5,904!
210
      g_log << Logger::Info << "[gpgsqlbackend] This is the gpgsql backend version " VERSION
5,904✔
211
#ifndef REPRODUCIBLE
5,904✔
212
            << " (" __DATE__ " " __TIME__ ")"
5,904✔
213
#endif
5,904✔
214
            << " reporting" << endl;
5,904✔
215
    }
5,904✔
NEW
216
    else {
×
NEW
217
      g_slog->withName("gpgsqlbackend")->info(Logr::Info, "gpgsqlbackend starting", "version", Logging::Loggable(VERSION)
×
UNCOV
218
#ifndef REPRODUCIBLE
×
NEW
219
                                                                                                 ,
×
NEW
220
                                              "build date", Logging::Loggable(__DATE__ " " __TIME__)
×
UNCOV
221
#endif
×
NEW
222
      );
×
NEW
223
    }
×
224
  }
5,904✔
225
};
226
static gPgSQLLoader gpgsqlloader;
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc