Allow a built-in default page to be set and used when one is not

configured.
Do not require secure settings, unless configured.

Author: thecodefactory

include/bitcoin/protocol/web/manager.hpp

@@ -72,6 +72,10 @@ class BCP_API manager
         const origin_list origins);
     ~manager();
 
+    // If the endpoint is reached and no default page can be found,
+    // send a response that includes this data.
+    void set_default_page_data(const std::string& data);
+
     bool initialize();
     bool bind(const system::config::endpoint& address,
         const bind_options& options);
@@ -141,6 +145,7 @@ class BCP_API manager
     system::shared_mutex task_mutex_;
 
     const origin_list origins_;
+    std::string page_data_;
 };
 
 } // namespace http

include/bitcoin/protocol/web/socket.hpp

@@ -129,6 +129,10 @@ class BCP_API socket
     // Send a message to every connected websocket client.
     void broadcast(const std::string& json);
 
+    // Optionally set a fixed reply instead of returning a 404 not found if
+    // the web root cannot be found.
+    void set_default_page_data(const std::string& data);
+
     // The zmq socket operates on only this one thread.
     bc::protocol::zmq::context& context_;
     const bool secure_;

src/settings.cpp

@@ -37,11 +37,10 @@ settings::settings()
     send_milliseconds(0),
     web_priority(false),
     web_origins({}),
-    web_root("web"),
+    web_root(""),
     web_ca_certificate(""),
-    web_server_private_key("key.pem"),
-    web_server_certificate("server.pem"),
-    web_client_certificates("clients")
+    web_server_private_key(""),
+    web_server_certificate("")
 {
 }
 
@@ -56,11 +55,10 @@ settings::settings(uint32_t send_high_water, uint32_t receive_high_water)
     send_milliseconds(0),
     web_priority(false),
     web_origins({}),
-    web_root("web"),
+    web_root(""),
     web_ca_certificate(""),
-    web_server_private_key("key.pem"),
-    web_server_certificate("server.pem"),
-    web_client_certificates("clients")
+    web_server_private_key(""),
+    web_server_certificate("")
 {
 }
 

src/web/manager.cpp

@@ -61,7 +61,8 @@ manager::manager(bool ssl, event_handler handler, path document_root,
     ca_certificate_{},
     handler_(handler),
     document_root_(document_root),
-    origins_(origins)
+    origins_(origins),
+    page_data_{}
 {
 #ifndef WITH_MBEDTLS
     BITCOIN_ASSERT_MSG(!ssl, "Secure HTTP requires MBEDTLS library.");
@@ -76,6 +77,11 @@ manager::~manager()
 #endif
 }
 
+void manager::set_default_page_data(const std::string& data)
+{
+    page_data_ = data;
+}
+
 // Initialize is not thread safe.
 bool manager::initialize()
 {
@@ -1027,32 +1033,35 @@ bool manager::send_response(connection_ptr connection,
 {
     auto path = document_root_;
 
-    if (request.uri == "/")
+    if (!document_root_.empty())
     {
-        static const std::vector<boost::filesystem::path> index_files
+        if (request.uri == "/")
         {
-            { "index.html" },
-            { "index.htm" },
-            { "index.shtml" }
-        };
+            static const std::vector<boost::filesystem::path> index_files
+            {
+                { "index.html" },
+                { "index.htm" },
+                { "index.shtml" }
+            };
 
-        for (const auto& index: index_files)
-        {
-            const auto test_path = path / index;
-            if (boost::filesystem::exists(test_path))
+            for (const auto& index: index_files)
             {
-                path = test_path;
-                break;
+                const auto test_path = path / index;
+                if (boost::filesystem::exists(test_path))
+                {
+                    path = test_path;
+                    break;
+                }
             }
-        }
 
-        if (path == document_root_)
-            return false;
-    }
-    else
-    {
-        // BUGBUG: sanitize path to guard against information leak.
-        path /= request.uri;
+            if (path == document_root_)
+                return false;
+        }
+        else
+        {
+            // BUGBUG: sanitize path to guard against information leak.
+            path /= request.uri;
+        }
     }
 
     if (!boost::filesystem::exists(path))
@@ -1069,15 +1078,29 @@ bool manager::send_response(connection_ptr connection,
         std::strftime(time_buffer.data(), time_buffer.size(),
             "%a, %d %b %Y %H:%M:%S GMT", std::gmtime(&current_time));
 
-        const auto response = std::string(
-            "HTTP/1.1 404 Not Found\r\n"
-            "Date: ") + time_buffer.data() + std::string("\r\n"
-            "Content-Type: text/html\r\n"
-            "Content-Length: 90\r\n\r\n"
-            "<html><head><title>Page not found</title></head>"
-            "<body>The page was not found.</body></html>\r\n\r\n");
+        std::stringstream response;
+
+        if (page_data_.empty())
+        {
+            response
+                << "HTTP/1.1 404 Not Found\r\n"
+                << "Date: " << time_buffer.data() << "\r\n"
+                << "Content-Type: text/html\r\n"
+                << "Content-Length: 90\r\n\r\n"
+                << "<html><head><title>Page not found</title></head>"
+                << "<body>The page was not found.</body></html>\r\n\r\n";
+        }
+        else
+        {
+            response
+                << "HTTP/1.0 200 OK\r\n"
+                << "Date: " << time_buffer.data() << "\r\n"
+                << "Content-Type: text/html\r\n"
+                << "Content-Length: " << page_data_.size() << "\r\n\r\n"
+                << page_data_ << "\r\n\r\n";
+        }
 
-        connection->write(response);
+        connection->write(response.str());
         return true;
     }
 

src/web/socket.cpp

@@ -359,7 +359,7 @@ socket::socket(zmq::context& context, const protocol::settings& settings,
 
 bool socket::start()
 {
-    if (!exists(settings_.web_root))
+    if (!settings_.web_root.empty() && !exists(settings_.web_root))
     {
         LOG_ERROR(LOG_PROTOCOL)
             << "Configured HTTP root path '" << settings_.web_root
@@ -370,31 +370,30 @@ bool socket::start()
     if (secure_)
     {
 #ifdef WITH_MBEDTLS
-        if (!settings_.web_ca_certificate.generic_string().empty() &&
+        if (!settings_.web_ca_certificate.empty() &&
             !exists(settings_.web_server_certificate))
         {
             LOG_ERROR(LOG_PROTOCOL)
-                << "Requested CA certificate '"
-                << settings_.web_ca_certificate
+                << "Configured CA certificate '" << settings_.web_ca_certificate
                 << "' does not exist.";
             return false;
         }
 
-        if (!exists(settings_.web_server_certificate))
+        if (!settings_.web_server_certificate.empty() &&
+            !exists(settings_.web_server_certificate))
         {
             LOG_ERROR(LOG_PROTOCOL)
-                << "Required server certificate '"
-                << settings_.web_server_certificate
-                << "' does not exist.";
+                << "Configured server certificate '"
+                << settings_.web_server_certificate << "' does not exist.";
             return false;
         }
 
-        if (!exists(settings_.web_server_private_key))
+        if (!settings_.web_server_private_key.empty() &&
+            !exists(settings_.web_server_private_key))
         {
             LOG_ERROR(LOG_PROTOCOL)
-                << "Required server private key '"
-                << settings_.web_server_private_key
-                << "' does not exist.";
+                << "Configured server private key '"
+                << settings_.web_server_private_key << "' does not exist.";
             return false;
         }
 #else
@@ -686,6 +685,11 @@ void socket::broadcast(const std::string& json)
     std::for_each(work_.begin(), work_.end(), sender);
 }
 
+void socket::set_default_page_data(const std::string& data)
+{
+    manager_->set_default_page_data(data);
+}
+
 } // namespace http
 } // namespace protocol
 } // namespace libbitcoin