Direct backend command for Remote backend

docs/markdown/authoritative/backend-remote.md

@@ -1009,6 +1009,42 @@ Content-Type: text/javascript; charset=utf-8
 {"result":2013060501}
 ```
 
+### `directBackendCmd`
+Can be used to send arbitrary commands to your backend using (backend-cmd)(dnssec.md#pdnssec).
+
+* Mandatory: no
+* Parameters: query
+* Reply: anything but boolean false for success, false for failure
+
+#### Example JSON/RPC
+Query:
+```
+{"method":"directBackendCmd","parameters":{"query":"PING"}}
+```
+
+Response:
+```
+{"result":"PONG"}
+```
+
+#### Example HTTP/RPC
+Query:
+```
+POST /dnsapi/directBackendCmd
+Content-Type: application/x-www-form-urlencoded
+Content-Length: 10
+
+query=PING
+```
+
+Response:
+```
+HTTP/1.1 200 OK
+Content-Type: text/javascript; charset=utf-8
+
+{"result":"PONG"}
+```
+
 # Examples
 ## Scenario: SOA lookup via pipe or unix connector
 Query:

modules/remotebackend/httpconnector.cc

@@ -240,6 +240,11 @@ void HTTPConnector::restful_requestbuilder(const std::string &method, const rapi
         req.POST()["serial"] = sparam;
         req.preparePost();
         verb = "PATCH";
+    } else if (method == "directBackendCmd") {
+        json2string(parameters["query"],sparam);
+        req.POST()["query"] = sparam;
+        req.preparePost();
+        verb = "POST";
     } else {
         // perform normal get
         verb = "GET";

modules/remotebackend/regression-tests/backend.rb

@@ -205,4 +205,8 @@ def do_setdomainmetadata(args)
         end
 	return true
    end
+
+   def do_directbackendcmd(args)
+     return [args["query"]]
+   end
 end

modules/remotebackend/regression-tests/direct-command/command

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+../pdns/pdnssec --config-name=remote --config-dir=. backend-cmd remote HELLO

modules/remotebackend/regression-tests/direct-command/description

@@ -0,0 +1 @@
+Tests that direct backend command works

modules/remotebackend/regression-tests/direct-command/expected_result

@@ -0,0 +1,2 @@
+== HELLO
+HELLO

modules/remotebackend/remotebackend.cc

@@ -938,6 +938,22 @@ bool RemoteBackend::calculateSOASerial(const string& domain, const SOAData& sd,
    return true;
 }
 
+string RemoteBackend::directBackendCmd(const string& querystr) {
+   rapidjson::Document query,answer;
+   rapidjson::Value parameters;
+
+   query.SetObject();
+   JSON_ADD_MEMBER(query, "method", "directBackendCmd", query.GetAllocator());
+   parameters.SetObject();
+   JSON_ADD_MEMBER(parameters, "query", querystr.c_str(), query.GetAllocator());
+   query.AddMember("parameters", parameters, query.GetAllocator());
+
+   if (this->send(query) == false || this->recv(answer) == false)
+     return "backend command failed";
+
+   return getString(answer["result"]);
+}
+
 // some rapidjson helpers 
 bool RemoteBackend::getBool(rapidjson::Value &value) {
    if (value.IsNull()) return false;

modules/remotebackend/remotebackend.hh

@@ -162,6 +162,7 @@ class RemoteBackend : public DNSBackend
   virtual bool setTSIGKey(const string& name, const string& algorithm, const string& content);
   virtual bool deleteTSIGKey(const string& name);
   virtual bool getTSIGKeys(std::vector< struct TSIGKey > &keys);
+  virtual string directBackendCmd(const string& querystr);
 
   static DNSBackend *maker();
 

modules/remotebackend/test-remotebackend.cc

@@ -296,4 +296,9 @@ BOOST_AUTO_TEST_CASE(test_method_calculateSOASerial) {
    BOOST_CHECK_EQUAL(serial, 2013060300);
 }
 
+BOOST_AUTO_TEST_CASE(test_method_directBackendCmd) {
+   BOOST_TEST_MESSAGE("Testing directBackendCmd method");
+   BOOST_CHECK_EQUAL(be->directBackendCmd("PING 1234"), "PING 1234");
+}
+
 BOOST_AUTO_TEST_SUITE_END();

modules/remotebackend/unittest.rb

@@ -249,5 +249,9 @@ def do_calculatesoaserial(args)
      return [2013060300] if args["sd"]["qname"] == "unit.test"
      [false]
    end
+
+   def do_directbackendcmd(args)
+     [args["query"]]
+   end
 end