http_server.h

Go to the documentation of this file.

/****************************************************************************
 *
 * Copyright 2016 Samsung Electronics All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific
 * language governing permissions and limitations under the License.
 *
 ****************************************************************************/
#ifndef __http_server_h__
#define __http_server_h__

/****************************************************************************
 * Included Files
 ****************************************************************************/

#include <stdio.h>
#include <mqueue.h>
#include <sys/socket.h>
#include <sys/select.h>
#include <netinet/in.h>

#ifdef CONFIG_NETUTILS_WEBSOCKET
#include <apps/netutils/websocket.h>
#endif

#ifdef CONFIG_NET_SECURITY_TLS
#include "tls/config.h"
#include "tls/entropy.h"
#include "tls/ctr_drbg.h"
#include "tls/certs.h"
#include "tls/x509.h"
#include "tls/ssl.h"
#include "tls/net.h"
#include "tls/error.h"
#include "tls/debug.h"
#include "tls/ssl_cache.h"
#endif

/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/

#define HTTP_METHOD_UNKNOWN -1
#define HTTP_METHOD_GET     0
#define HTTP_METHOD_PUT     1
#define HTTP_METHOD_POST    2
#define HTTP_METHOD_DELETE  3

#define HTTP_HTTP_VERSION_UNKNOWN 0
#define HTTP_HTTP_VERSION_09      9
#define HTTP_HTTP_VERSION_10      10
#define HTTP_HTTP_VERSION_11      11

#define HTTP_CONTENT_LENGTH       0
#define HTTP_CHUNKED_ENCODING     1

#define HTTP_CONF_MAX_CLIENT                    16
#define HTTP_CONF_CLIENT_STACKSIZE              8192
#define HTTP_CONF_MIN_TLS_MEMORY                80000
#define HTTP_CONF_SOCKET_TIMEOUT_MSEC           5000
#define HTTP_CONF_MAX_CLIENT_HANDLE             2
#define HTTP_CONF_SERVER_MQ_MAX_MSG             10
#define HTTP_CONF_SERVER_MQ_PRIO                50
#define HTTP_CONF_SERVER_SIGWAKEUP              18

#define HTTP_CONF_MAX_REQUEST_LENGTH            2048
#define HTTP_CONF_MAX_REQUEST_LINE_LENGTH       256
#define HTTP_CONF_MAX_REQUEST_HEADER_URL_LENGTH 128
#define HTTP_CONF_MAX_URL_QUERY_LENGTH          64
#define HTTP_CONF_MAX_URL_PARAMS_LENGTH         256
#define HTTP_CONF_MAX_KEY_LENGTH                32
#define HTTP_CONF_MAX_VALUE_LENGTH              256
#define HTTP_CONF_MAX_DIVIDED_PATH_LENGTH       32
#define HTTP_CONF_MAX_SLASH_COUNT               32
#define HTTP_CONF_MAX_QUERY_HANDLER_COUNT       64
#define HTTP_CONF_MAX_ENTITY_LENGTH             2048

#define HTTP_ERROR_400            "Bad Request"
#define HTTP_ERROR_404            "Not Found"
#define HTTP_ERROR_500            "Internal Server Error"

/****************************************************************************
 * Public Types
 ****************************************************************************/

struct http_client_t;
struct http_keyvalue_list_t;

struct ssl_config_t {
#ifdef CONFIG_HW_RSA_SIGN
    unsigned int ca_key_index;
    unsigned int dev_key_index;
    unsigned int ca_cert_index;
    unsigned int dev_cert_index;
#else
    char *root_ca;
    char *dev_cert;
    char *private_key;
    unsigned int root_ca_len;
    unsigned int dev_cert_len;
    unsigned int private_key_len;
#endif                          /* CONFIG_HW_RSA_SIGN */
};

typedef enum {
    HTTP_SERVER_INIT,
    HTTP_SERVER_RUN,
    HTTP_SERVER_STOP_REQ,
    HTTP_SERVER_STOP,
} http_server_state_t;

struct http_req_message {
    char *req_msg;
    int method;
    uint32_t client_ip;
    char *url;
    struct http_keyvalue_list_t *headers;
    char *entity;
    char *query_string;
};

typedef void (*http_cb_t)(struct http_client_t * client, struct http_req_message * msg);

struct http_server_t {
    int port;
    int listen_fd;
    http_server_state_t state;
    sem_t sem_thread_sync;
    pthread_t tid;
    pthread_t c_tid[HTTP_CONF_MAX_CLIENT_HANDLE];
    mqd_t msg_q;

#ifdef CONFIG_NET_SECURITY_TLS
    int tls_init;
    mbedtls_ssl_config tls_conf;
    mbedtls_entropy_context tls_entropy;
    mbedtls_ctr_drbg_context tls_ctr_drbg;
    mbedtls_x509_crt tls_srvcert;
    mbedtls_pk_context tls_pkey;
    mbedtls_ssl_cache_context tls_cache;
    mbedtls_net_context tls_ctx;
#endif

    struct sockaddr_in servaddr;
    http_cb_t cb[4];
    struct http_query_handler_t
    *query_handlers[HTTP_CONF_MAX_QUERY_HANDLER_COUNT];
#ifdef CONFIG_NETUTILS_WEBSOCKET
    websocket_cb_t ws_cb;
#endif
};

/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/

struct http_server_t *http_server_init(int port);

int http_server_start(struct http_server_t *server);

int http_server_stop(struct http_server_t *server);

void http_server_release(struct http_server_t **server);

int http_server_register_cb(struct http_server_t *server, int method, const char *url_format, http_cb_t func);

int http_server_deregister_cb(struct http_server_t *server, int method, const char *url_format);

int http_send_response(struct http_client_t *client, int status, const char *body, struct http_keyvalue_list_t *headers);

#ifdef CONFIG_NET_SECURITY_TLS

int http_tls_init(struct http_server_t *server, struct ssl_config_t *ssl_config);
#endif

#endif