websocket.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 __APPS_INCLUDE_NETUTILS_WEBSOCKET_H
#define __APPS_INCLUDE_NETUTILS_WEBSOCKET_H

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

#include <stdint.h>
#include <netinet/in.h>
#include <apps/netutils/wslay/wslay.h>
#include <tinyara/wqueue.h>

#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"

#define WEBSOCKET_DEBUG_PRINT

#if defined(WEBSOCKET_DEBUG_PRINT)
#define WEBSOCKET_DEBUG ndbg
#else
#define WEBSOCKET_DEBUG(...) do { } while (0)
#endif

/****************************************************************************
 * Pre-prcessor Definitions
 ****************************************************************************/

#define WS_GUID                                      "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"

#define WEBSOCKET_STACKSIZE                          (1024 * 10)

#define WEBSOCKET_PRI                                100

#define WEBSOCKET_SCHED_POLICY                       SCHED_RR

#define WEBSOCKET_WQ                                 LPWORK

#define WEBSOCKET_CLIENT_KEY_LEN                     (24)

#define WEBSOCKET_ACCEPT_KEY_LEN                     (29)

#define WEBSOCKET_HANDSHAKE_HEADER_SIZE              (2048)

#ifdef CONFIG_HW_RSA_SIGN
#define WEBSOCKET_SERVERNAME                         "ARTIK051_dev"
#else
#define WEBSOCKET_SERVERNAME                         "localhost"
#endif

#define WEBSOCKET_SOCK_RCV_TIMEOUT                   (5 * 1000) //mili second

#define WEBSOCKET_SERVER_CHECK_INTERVAL              (500)  //mili second

#define WEBSOCKET_SERVER_TIMEOUT                     (3 * 60 * 1000)    //mili second

#define WEBSOCKET_HANDLER_TIMEOUT                    (300)  //mili second

#define WEBSOCKET_MAX_PING_IGNORE                    (3)    //times

#define WEBSOCKET_PING_INTERVAL                      (20 * 100) //MSEC_PER_TICK

#define WEBSOCKET_MAX_LENGTH_QUEUE                      (100 * 1024)

#define WEBSOCKET_MAX_NUMBER_QUEUE                      (20)

#define WEBSOCKET_MAX_CLIENT                         (3)

/*
 *  Pre-definition variables from wslay below.
 *  just not to include wslay.h on application side.
 */

#define websocket_context_ptr                        wslay_event_context_ptr

#define websocket_cb_t                               struct wslay_event_callbacks

#define websocket_frame_t                            struct wslay_event_msg

#define websocket_fragmented_frame_t                 struct wslay_event_fragmented_msg

#define websocket_on_msg_arg                         struct wslay_event_on_msg_recv_arg

#define websocket_recv_start_arg                     struct wslay_event_on_frame_recv_start_arg

#define websocket_recv_chunk_arg                     struct wslay_event_on_frame_recv_chunk_arg

/****************************************************************************
 * Macros
 ****************************************************************************/

#define WEBSOCKET_CHECK_NOT_CTRL_FRAME(x)            (!(((x) >> 3) & 1))

#define WEBSOCKET_CHECK_TEXT_FRAME(x)                (((uint8_t)(x)) == ((uint8_t)(WEBSOCKET_TEXT_FRAME)))

#define WEBSOCKET_CHECK_BINARY_FRAME(x)              (((uint8_t)(x)) == ((uint8_t)(WEBSOCKET_BINARY_FRAME)))

#define WEBSOCKET_CHECK_CTRL_CLOSE(x)                (((uint8_t)(x)) == ((uint8_t)(WEBSOCKET_CONNECTION_CLOSE)))

#define WEBSOCKET_CHECK_CTRL_PING(x)                 (((uint8_t)(x)) == ((uint8_t)(WEBSOCKET_PING)))

#define WEBSOCKET_CHECK_CTRL_PONG(x)                 (((uint8_t)(x)) == ((uint8_t)(WEBSOCKET_PONG)))

/****************************************************************************
 * Public Types
 ****************************************************************************/
typedef enum {
    WEBSOCKET_SUCCESS,          
    WEBSOCKET_ALLOCATION_ERROR, 
    WEBSOCKET_INIT_ERROR,       
    WEBSOCKET_SOCKET_ERROR,     
    WEBSOCKET_CONNECT_ERROR,    
    WEBSOCKET_HANDSHAKE_ERROR,  
    WEBSOCKET_SEND_ERROR,       
    WEBSOCKET_RECEIVE_ERROR,    
    WEBSOCKET_TLS_INIT_ERROR,   
    WEBSOCKET_TLS_HANDSHAKE_ERROR   
} websocket_return_t;

enum websocket_state {
    WEBSOCKET_STOP,             
    WEBSOCKET_RUNNING,          
    WEBSOCKET_MAX_STATE         
};

enum websocket_io_flag {
    WEBSOCKET_MSG_MORE = 1
};

enum websocket_socket_error {
    WEBSOCKET_ERR_WANT_READ = -100,
    WEBSOCKET_ERR_WANT_WRITE = -101,
    WEBSOCKET_ERR_PROTO = -200,
    WEBSOCKET_ERR_INVALID_ARGUMENT = -300,
    WEBSOCKET_ERR_INVALID_CALLBACK = -301,
    WEBSOCKET_ERR_NO_MORE_MSG = -302,
    WEBSOCKET_ERR_CALLBACK_FAILURE = -400,
    WEBSOCKET_ERR_WOULDBLOCK = -401,
    WEBSOCKET_ERR_NOMEM = -500
};

enum websocket_opcode {
    WEBSOCKET_CONTINUATION_FRAME = 0x0, 
    WEBSOCKET_TEXT_FRAME = 0x1, 
    WEBSOCKET_BINARY_FRAME = 0x2,   
    WEBSOCKET_CONNECTION_CLOSE = 0x8,   
    WEBSOCKET_PING = 0x9,       
    WEBSOCKET_PONG = 0xa        
};

typedef struct {
    int state;
    int fd;
    int tls_enabled;
    int ping_cnt;
    websocket_context_ptr ctx;
    websocket_cb_t *cb;
    mbedtls_net_context tls_net;
    mbedtls_ssl_context *tls_ssl;
    mbedtls_ssl_config *tls_conf;
    struct work_s time_worker;
    pthread_t thread_id;
    pthread_attr_t thread_attr;
} websocket_t;

struct websocket_info_t {
    websocket_t *data;
};

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

#ifdef __cplusplus
#define EXTERN extern "C"
extern "C" {
#else
#define EXTERN extern
#endif

void websocket_create_accept_key(unsigned char *dst, size_t dlen, const unsigned char *src, size_t slen);

int websocket_count_table(void);

websocket_t *websocket_find_table(void);

websocket_return_t websocket_client_open(websocket_t *client, char *addr, char *port, char *path);

websocket_return_t websocket_server_open(websocket_t *server);

websocket_return_t websocket_server_init(websocket_t *server);

void websocket_register_cb(websocket_t *websocket, websocket_cb_t *cb);

/*
 * @brief websocket_queue_msg() queues a message into websocket context.
 *
 *        Websocket has a event handler thread and it keeps watching the queue to send or recv events.
 * @param[in] ctx message queue is in websocket context
 * @param[in] frame message frame to be sent
 * @return On success return WEBSOCKET_SUCCESS, On failure return values defined in websocket_return_t
 * @since Tizen RT v1.0
 */
websocket_return_t websocket_queue_msg(websocket_t *websocket, websocket_frame_t *tx_frame);

websocket_return_t websocket_queue_ping(websocket_t *websocket);

websocket_return_t websocket_queue_close(websocket_t *websocket, const char *close_message);

void websocket_update_state(websocket_t *websocket, int state);

void websocket_set_error(websocket_t *websocket, int val);

#undef EXTERN
#undef EXTERN
#ifdef __cplusplus
}
#endif
// end of Websocket group

#endif                          /* __APPS_INCLUDE_NETUTILS_WEBSOCKET_H */