Merge pull request #1241 from AndreasAakesson/dev

Made it easier to create WebSocket from HTTP Request/Response

Author: alfreb

CMakeLists.txt

@@ -138,6 +138,7 @@ if(tests)
   ExternalProject_Add(unittests
     PREFIX unittests
     SOURCE_DIR ${INCLUDEOS_ROOT}/test
+    BINARY_DIR unittests
     CMAKE_ARGS -DINCLUDEOS_ROOT=${INCLUDEOS_ROOT} -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}
     )
   #add_subdirectory(test)

api/net/http/client.hpp

@@ -28,6 +28,8 @@
 
 namespace http {
 
+  using Response_handler = Client_connection::Response_handler;
+
   class Client {
   public:
     using TCP                 = net::TCP;
@@ -164,6 +166,15 @@ namespace http {
     void on_send(Request_handler cb)
     { on_send_ = std::move(cb); }
 
+    /**
+     * @brief      Returns the Origin for the Client as a string.
+     *             Currently returns the IP address to the stack.
+     *
+     * @return     The origin as a string
+     */
+    std::string origin() const
+    { return tcp_.stack().ip_addr().to_string(); }
+
   private:
     friend class Client_connection;
 

api/net/http/header_fields.hpp

@@ -42,6 +42,7 @@ extern Field If_None_Match;
 extern Field If_Range;
 extern Field If_Unmodified_Since;
 extern Field Max_Forwards;
+extern Field Origin;
 extern Field Proxy_Authorization;
 extern Field Range;
 extern Field Referer;

api/net/http/secure_server.hpp

@@ -25,55 +25,117 @@
 
 namespace http {
 
+/**
+ * @brief      A secure HTTPS server.
+ */
 class Secure_server : public http::Server
 {
 public:
-  Secure_server(
+  /**
+   * @brief      Construct a HTTPS server with the necessary certificates and keys.
+   *
+   * @param[in]  name         The name
+   * @param      ca_key       The ca key
+   * @param      ca_cert      The ca cert
+   * @param      server_key   The server key
+   * @param      tcp          The tcp
+   * @param[in]  server_args  A list of args for constructing the underlying HTTP server
+   *
+   * @tparam     Server_args  Construct arguments to HTTP Server
+   */
+  template <typename... Server_args>
+  inline Secure_server(
       const std::string& name,
       fs::Dirent& ca_key,
       fs::Dirent& ca_cert,
       fs::Dirent& server_key,
-      TCP& tcp,
-      Request_handler cb);
+      net::TCP&   tcp,
+      Server_args&&... server_args);
 
-  Secure_server(
-      const std::string& name,
-      fs::Dirent& ca_key,
-      fs::Dirent& ca_cert,
-      fs::Dirent& server_key,
-      TCP& tcp);
-
-  Secure_server(
+  /**
+   * @brief      Construct a HTTPS server with a credential manager and rng.
+   *
+   * @param      in_credman   In credman
+   * @param      in_rng       In random number generator
+   * @param      tcp          The tcp
+   * @param[in]  server_args  A list of args for constructing the underlying HTTP server
+   *
+   * @tparam     Server_args  Server_args  Construct arguments to HTTP Server
+   */
+  template <typename... Server_args>
+  inline Secure_server(
       Botan::Credentials_Manager*   in_credman,
       Botan::RandomNumberGenerator& in_rng,
-      TCP& tcp,
-      Request_handler cb)
-    : http::Server(tcp, cb), rng(in_rng), credman(in_credman)
-  {
-    assert(credman != nullptr);
-    on_connect = {this, &Secure_server::secure_connect};
-  }
+      net::TCP& tcp,
+      Server_args&&... server_args);
 
-  void secure_connect(TCP_conn conn)
-  {
-    auto* ptr = new net::tls::Server(conn, rng, *credman);
-
-    ptr->on_connect(
-    [this, ptr] (net::Stream&)
-    {
-      // create and pass TLS socket
-      Server::connect(std::unique_ptr<net::tls::Server>(ptr));
-    });
-    ptr->on_close([ptr] {
-      delete ptr;
-    });
-  }
+  /**
+   * @brief      Loads credentials.
+   *
+   * @param[in]  name        The name
+   * @param      ca_key      The ca key
+   * @param      ca_cert     The ca cert
+   * @param      server_key  The server key
+   */
+  void load_credentials(
+      const std::string& name,
+      fs::Dirent& ca_key,
+      fs::Dirent& ca_cert,
+      fs::Dirent& server_key);
 
 private:
   Botan::RandomNumberGenerator& rng;
   std::unique_ptr<Botan::Credentials_Manager> credman;
-};
 
-} // http
+  /**
+   * @brief      Binds TCP to pass all new connections to this on_connect.
+   *
+   * @param[in]  port  The port
+   */
+  void bind(const uint16_t port) override;
+
+  /**
+   * @brief      Try to upgrade a newly established TCP connection to a TLS connection.
+   *
+   * @param[in]  conn  The TCP connection
+   */
+  void on_connect(TCP_conn conn) override;
+
+  /**
+   * @brief      Gets the random number generator.
+   *
+   * @return     The random number generator.
+   */
+  static Botan::RandomNumberGenerator& get_rng();
+
+}; // < class Secure_server
+
+template <typename... Server_args>
+inline Secure_server::Secure_server(
+    const std::string& name,
+    fs::Dirent& ca_key,
+    fs::Dirent& ca_cert,
+    fs::Dirent& server_key,
+    net::TCP&   tcp,
+    Server_args&&... server_args)
+  : Server{tcp, std::forward<Server>(server_args)...},
+    rng(get_rng())
+{
+  load_credentials(name, ca_key, ca_cert, server_key);
+}
+
+template <typename... Server_args>
+inline Secure_server::Secure_server(
+    Botan::Credentials_Manager*   in_credman,
+    Botan::RandomNumberGenerator& in_rng,
+    net::TCP& tcp,
+    Server_args&&... server_args)
+  : Server{tcp, std::forward(server_args)...},
+    rng(in_rng), credman(in_credman)
+{
+  assert(credman != nullptr);
+}
+
+} // < namespace http
 
 #endif

api/net/http/server.hpp

@@ -34,8 +34,12 @@ namespace http {
   // Used in HTTP server - invoked when a Request is received
   using Request_handler   = delegate<void(Request_ptr, Response_writer_ptr)>;
 
+  /**
+   * @brief      A simple HTTP server.
+   */
   class Server {
   public:
+    using Request_handler = http::Request_handler;
     using TCP             = net::TCP;
     using TCP_conn        = net::tcp::Connection_ptr;
 
@@ -63,7 +67,7 @@ namespace http {
      *
      * @param[in]  port  The port to listen on
      */
-    virtual void listen(uint16_t port);
+    void listen(const uint16_t port);
 
     /**
      * @brief      Setup handler for when a Request is received
@@ -93,13 +97,34 @@ namespace http {
     virtual ~Server();
 
   protected:
-    delegate<void(TCP_conn)> on_connect;
+    TCP&            tcp_;
+
+    /**
+     * @brief      Binds to a TCP port and sets up a connect event.
+     *             This is called from listen()
+     *
+     * @param[in]  port  The port
+     */
+    virtual void bind(const uint16_t port);
+
+    /**
+     * @brief      Handle a newly connected TCP client.
+     *
+     * @param[in]  conn  The TCP connection
+     */
+    virtual void on_connect(TCP_conn conn)
+    { connect(std::make_unique<Connection::Stream>(std::move(conn))); }
+
+    /**
+     * @brief      Connect the stream to the server.
+     *
+     * @param[in]  stream  The stream
+     */
     void connect(Connection::Stream_ptr stream);
 
   private:
     friend class Server_connection;
 
-    TCP&            tcp_;
     Request_handler on_request_;
     Connection_set  connections_;
     Index_set       free_idx_;
@@ -113,14 +138,27 @@ namespace http {
     Stat& stat_req_bad_;
     Stat& stat_timeouts_;
 
-    void connected(TCP_conn conn) {
-      connect(std::make_unique<Connection::Stream>(conn));
-    }
-
+    /**
+     * @brief      Close the given Server_connection
+     *
+     * @param      <unnamed>  The server connection to be closed
+     */
     void close(Server_connection&);
 
+    /**
+     * @brief      Timeout (close) all clients that been idle for more than limit.
+     *
+     * @param[in]  <unnamed>  A timer id (unused)
+     */
     void timeout_clients(int32_t);
 
+    /**
+     * @brief      Receive a incoming HTTP request
+     *
+     * @param[in]  <unnamed>  The HTTP reuqest
+     * @param[in]  code       The HTTP status code
+     * @param      <unnamed>  The server connection which the req arrived from
+     */
     void receive(Request_ptr, status_t code, Server_connection&);
 
   }; // < class Server