http-server.h

#ifndef HTTP_SERVER_H_INCLUDED
#define HTTP_SERVER_H_INCLUDED

/**
 * \addtogroup http
 * \{
 */

/**
 * Default HTTP server configuration
 */
#define HTTP_SERVER_CONF_DEFAULTS \
    .ConnectionPoolSize = 5,      \
    .TlsConnPoolSize = 1,         \
    .ThreadPoolSize = 1,          \
    .HandshakePoolSize = 1,       \
    .ParserPoolSize = 1,          \
    .SocketBacklogSize = 8,       \
    .HandshakeTimeout = MS_TO_TICKS(10000), \
    .KeepaliveTimeout = MS_TO_TICKS(5000),  \
    .CloseTimeout = MS_TO_TICKS(2000),      \
    .TransportTimeout = MS_TO_TICKS(7000)

/**
 * Authentication operation type
 */
enum http_auth_op_type_t
{
  HTTP_AUTH_QUERY_AUTHENTICATION,     /*!< Query if authentication is required */
  HTTP_AUTH_GET_REALM,                /*!< Query a realm string from an application */
  HTTP_AUTH_GET_PASSWORD_HASH,        /*!< Query a password hash for the selected user */
  HTTP_AUTH_GET_PASSWORD,             /*!< Query a plaintext password for the user*/
};

/**
 * Authentication operation
 */
struct http_auth_op_t
{
  enum http_auth_op_type_t Type;      /*!< Type of operation */
  const char *In;                     /*!< Input data. Username for password queries */
  uint32_t InLen;                     /*!< Length of input data */
  uint8_t *Out;                       /*!< Output data buffer */
  uint32_t OutLen;                    /*!< At the function call it contains size of the output data buffer.
                                           Callback must update the field with real size of the output
                                           parameter, which can be greater than size of the buffer. */
};

/**
 * Authentication callback
 */
typedef bool (*http_auth_callback_t)(struct http_auth_op_t *Op);

/**
 * HTTP server general configuration
 *
 * TlsConnPoolSize <= ConnectionPoolSize;
 * ThreadPoolSize <= ConnectionPoolSize; 
 * ParserPoolSize <= ThreadPoolSize;
 * HandshakePoolSize <= ThreadPoolSize;
 * HandshakePoolSize <= TlsConnPoolSize;
 * SocketBacklogSize >= 2
 */
struct http_server_conf_t
{
  http_auth_callback_t AuthCb;        /*!< Authentication callback */
  uint8_t ConnectionPoolSize;         /*!< Max number of concurrent HTTP + HTTPS connections */
  uint8_t TlsConnPoolSize;            /*!< Max number of concurrent HTTPS connections */
  uint8_t ThreadPoolSize;             /*!< Number of parallel processing threads */
  uint8_t HandshakePoolSize;          /*!< HTTPS handshake pool size */
  uint8_t ParserPoolSize;             /*!< Number of concurrent HTTP request parsers */
  uint8_t SocketBacklogSize;          /*!< Total number of sockets in both HTTP and HTTPS listen backlog */
  bool UseHttps;                      /*!< Use HTTPS */
  bool ForceHttps;                    /*!< Redirect HTTP requests to HTTPS port */
  bool ForceIpAddr;                   /*!< Redirect HTTP(S) requests to an IP address */
  uint16_t HandshakeTimeout;          /*!< HTTPS handshake timeout */
  uint16_t KeepaliveTimeout;          /*!< HTTP / HTTPS keep-alive timeout */
  uint16_t CloseTimeout;              /*!< Socket close timeout */
  uint16_t TransportTimeout;          /*!< TCP send / recv timeout */
};

/**
 * HTTP server security configuration
 */
struct http_server_security_t
{
  const char *RsaCert;                /*!< RSA certificate */
  const char *RsaKey;                 /*!< RSA key */
  uint16_t RsaCertSize;               /*!< Length of RSA certificate, including terminal \0 */
  uint16_t RsaKeySize;                /*!< Length of RSA key, including terminal \0 */
};

/**
 * Start HTTP/HTTPS server
 *
 * \note Caller must ensure persistence of the server general configuration through the server livetime,
 * bit there is no such restrictions for the security configuration.
 *
 * @param Config    Server general configuration
 * @param Security  Server security configuration
 * @return          true if server was started, false otherwise
 */
bool HttpServerStart(const struct http_server_conf_t *Config, struct http_server_security_t *Security);

/**
 * Stop HTTP/HTTPS server
 */
void HttpServerStop(void);

/** \} */

#endif